blob: eeebfa65b0eff054495e732650005d260af8bd04 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080019 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020023 *
Benjamin Peterson9a261492017-08-06 19:33:22 -070024 * Please read Documentation/core-api/workqueue.rst for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
Paul Gortmaker9984de12011-05-23 14:51:41 -040027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060038#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070042#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020043#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070044#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050045#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070046#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070047#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070048#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070049#include <linux/uaccess.h>
Tal Shorerc98a9802017-11-03 17:27:50 +020050#include <linux/sched/isolation.h>
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +090051#include <linux/nmi.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020052
Tejun Heoea138442013-01-18 14:05:55 -080053#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Tejun Heoc8e55f32010-06-29 10:07:12 +020055enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070056 /*
Tejun Heo24647572013-01-24 11:01:33 -080057 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070058 *
Tejun Heo24647572013-01-24 11:01:33 -080059 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070060 * While associated (!DISASSOCIATED), all workers are bound to the
61 * CPU and none has %WORKER_UNBOUND set and concurrency management
62 * is in effect.
63 *
64 * While DISASSOCIATED, the cpu may be offline and all workers have
65 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080066 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070067 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070068 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080069 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080070 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070071 */
Tejun Heo692b4822017-10-09 08:04:13 -070072 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
Tejun Heo24647572013-01-24 11:01:33 -080073 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020074
Tejun Heoc8e55f32010-06-29 10:07:12 +020075 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020076 WORKER_DIE = 1 << 1, /* die die die */
77 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020078 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020079 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020080 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070081 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020082
Tejun Heoa9ab7752013-03-19 13:45:21 -070083 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
84 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020085
Tejun Heoe34cdddb2013-01-24 11:01:33 -080086 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070087
Tejun Heo29c91e92013-03-12 11:30:03 -070088 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020089 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020090
Tejun Heoe22bee72010-06-29 10:07:14 +020091 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
92 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
93
Tejun Heo3233cdb2011-02-16 18:10:19 +010094 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
95 /* call for help after 10ms
96 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020097 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
98 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020099
100 /*
101 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800102 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200103 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800104 RESCUER_NICE_LEVEL = MIN_NICE,
105 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700106
107 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200108};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200111 * Structure fields follow one of the following exclusion rules.
112 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200113 * I: Modifiable by initialization/destruction paths and read-only for
114 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200115 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200116 * P: Preemption protected. Disabling preemption is enough and should
117 * only be modified and accessed from the local cpu.
118 *
Tejun Heod565ed62013-01-24 11:01:33 -0800119 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200120 *
Tejun Heod565ed62013-01-24 11:01:33 -0800121 * X: During normal operation, modification requires pool->lock and should
122 * be done only from local cpu. Either disabling preemption on local
123 * cpu or grabbing pool->lock is enough for read access. If
124 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200125 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800126 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700127 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700128 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700129 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700130 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700131 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800132 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
133 *
134 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
135 * sched-RCU for reads.
136 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700137 * WQ: wq->mutex protected.
138 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700139 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700140 *
141 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200142 */
143
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800144/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200145
Tejun Heobd7bdd42012-07-12 14:46:37 -0700146struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800147 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700148 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700149 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800150 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700151 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700152
Tejun Heo82607adc2015-12-08 11:28:04 -0500153 unsigned long watchdog_ts; /* L: watchdog timestamp */
154
Tejun Heobd7bdd42012-07-12 14:46:37 -0700155 struct list_head worklist; /* L: list of pending works */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700156
Lai Jiangshan5826cc82018-03-20 17:24:05 +0800157 int nr_workers; /* L: total number of workers */
158 int nr_idle; /* L: currently idle workers */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700159
160 struct list_head idle_list; /* X: list of idle workers */
161 struct timer_list idle_timer; /* L: worker idle timeout */
162 struct timer_list mayday_timer; /* L: SOS timer for workers */
163
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700164 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800165 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
166 /* L: hash of busy workers */
167
Tejun Heobc3a1af2013-03-13 19:47:39 -0700168 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400169 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800170 struct mutex attach_mutex; /* attach/detach exclusion */
171 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800172 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800173
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800174 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800175
Tejun Heo7a4e3442013-03-12 11:30:00 -0700176 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700177 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
178 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700179
Tejun Heoe19e3972013-01-24 11:39:44 -0800180 /*
181 * The current concurrency level. As it's likely to be accessed
182 * from other CPUs during try_to_wake_up(), put it in a separate
183 * cacheline.
184 */
185 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700186
187 /*
188 * Destruction of pool is sched-RCU protected to allow dereferences
189 * from get_work_pool().
190 */
191 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200192} ____cacheline_aligned_in_smp;
193
194/*
Tejun Heo112202d2013-02-13 19:29:12 -0800195 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
196 * of work_struct->data are used for flags and the remaining high bits
197 * point to the pwq; thus, pwqs need to be aligned at two's power of the
198 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 */
Tejun Heo112202d2013-02-13 19:29:12 -0800200struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700201 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200202 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200203 int work_color; /* L: current color */
204 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700205 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200206 int nr_in_flight[WORK_NR_COLORS];
207 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200208 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200209 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200210 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700211 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700212 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700213
214 /*
215 * Release of unbound pwq is punted to system_wq. See put_pwq()
216 * and pwq_unbound_release_workfn() for details. pool_workqueue
217 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700218 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700219 */
220 struct work_struct unbound_release_work;
221 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700222} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200225 * Structure used to wait for workqueue flush.
226 */
227struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700228 struct list_head list; /* WQ: list of flushers */
229 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200230 struct completion done; /* flush completion */
231};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
Tejun Heo226223a2013-03-12 11:30:05 -0700233struct wq_device;
234
Tejun Heo73f53c42010-06-29 10:07:11 +0200235/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700236 * The externally visible workqueue. It relays the issued work items to
237 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 */
239struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700240 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400241 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200242
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700243 struct mutex mutex; /* protects this wq */
244 int work_color; /* WQ: current work color */
245 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800246 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700247 struct wq_flusher *first_flusher; /* WQ: first flusher */
248 struct list_head flusher_queue; /* WQ: flush waiters */
249 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200250
Tejun Heo2e109a22013-03-13 19:47:40 -0700251 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200252 struct worker *rescuer; /* I: rescue worker */
253
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700254 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700255 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700256
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800257 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
258 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700259
Tejun Heo226223a2013-03-12 11:30:05 -0700260#ifdef CONFIG_SYSFS
261 struct wq_device *wq_dev; /* I: for sysfs interface */
262#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700263#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200264 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700265#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700266 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700267
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400268 /*
269 * Destruction of workqueue_struct is sched-RCU protected to allow
270 * walking the workqueues list without grabbing wq_pool_mutex.
271 * This is used to dump all workqueues from sysrq.
272 */
273 struct rcu_head rcu;
274
Tejun Heo2728fd22013-04-01 11:23:35 -0700275 /* hot fields used during command issue, aligned to cacheline */
276 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
277 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800278 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279};
280
Tejun Heoe904e6c2013-03-12 11:29:57 -0700281static struct kmem_cache *pwq_cache;
282
Tejun Heobce90382013-04-01 11:23:32 -0700283static cpumask_var_t *wq_numa_possible_cpumask;
284 /* possible CPUs of each node */
285
Tejun Heod55262c2013-04-01 11:23:38 -0700286static bool wq_disable_numa;
287module_param_named(disable_numa, wq_disable_numa, bool, 0444);
288
Viresh Kumarcee22a12013-04-08 16:45:40 +0530289/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930290static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530291module_param_named(power_efficient, wq_power_efficient, bool, 0444);
292
Tejun Heo863b7102016-09-16 15:49:34 -0400293static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400294
Tejun Heobce90382013-04-01 11:23:32 -0700295static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
296
Tejun Heo4c16bd32013-04-01 11:23:36 -0700297/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
298static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
299
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700300static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700301static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo692b4822017-10-09 08:04:13 -0700302static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
Tejun Heo5bcab332013-03-13 19:47:40 -0700303
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400304static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700305static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700306
Mike Galbraithef5571802016-02-09 17:59:38 -0500307/* PL: allowable cpus for unbound wqs and work items */
308static cpumask_var_t wq_unbound_cpumask;
309
310/* CPU where unbound work was last round robin scheduled from this CPU */
311static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800312
Tejun Heof303fccb2016-02-09 17:59:38 -0500313/*
314 * Local execution of unbound work items is no longer guaranteed. The
315 * following always forces round-robin CPU selection on unbound work items
316 * to uncover usages which depend on it.
317 */
318#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
319static bool wq_debug_force_rr_cpu = true;
320#else
321static bool wq_debug_force_rr_cpu = false;
322#endif
323module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
324
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700325/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700326static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700327
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700328static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700329
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700330/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700331static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
332
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700333/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700334static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
335
Tejun Heo8a2b7532013-09-05 12:30:04 -0400336/* I: attributes used when instantiating ordered pools on demand */
337static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
338
Tejun Heod320c032010-06-29 10:07:14 +0200339struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400340EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300341struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900342EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300343struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200344EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300345struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200346EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300347struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100348EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530349struct workqueue_struct *system_power_efficient_wq __read_mostly;
350EXPORT_SYMBOL_GPL(system_power_efficient_wq);
351struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
352EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200353
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700354static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800355static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700356
Tejun Heo97bd2342010-10-05 10:41:14 +0200357#define CREATE_TRACE_POINTS
358#include <trace/events/workqueue.h>
359
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700360#define assert_rcu_or_pool_mutex() \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700361 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
362 !lockdep_is_held(&wq_pool_mutex), \
363 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700364
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700365#define assert_rcu_or_wq_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700366 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
367 !lockdep_is_held(&wq->mutex), \
368 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700369
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800370#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700371 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
372 !lockdep_is_held(&wq->mutex) && \
373 !lockdep_is_held(&wq_pool_mutex), \
374 "sched RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800375
Tejun Heof02ae732013-03-12 11:30:03 -0700376#define for_each_cpu_worker_pool(pool, cpu) \
377 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
378 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700379 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700380
Tejun Heo49e3cf42013-03-12 11:29:58 -0700381/**
Tejun Heo17116962013-03-12 11:29:58 -0700382 * for_each_pool - iterate through all worker_pools in the system
383 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700384 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700385 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700386 * This must be called either with wq_pool_mutex held or sched RCU read
387 * locked. If the pool needs to be used beyond the locking in effect, the
388 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700389 *
390 * The if/else clause exists only for the lockdep assertion and can be
391 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700392 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700393#define for_each_pool(pool, pi) \
394 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700395 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700396 else
Tejun Heo17116962013-03-12 11:29:58 -0700397
398/**
Tejun Heo822d8402013-03-19 13:45:21 -0700399 * for_each_pool_worker - iterate through all workers of a worker_pool
400 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700401 * @pool: worker_pool to iterate workers of
402 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800403 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700404 *
405 * The if/else clause exists only for the lockdep assertion and can be
406 * ignored.
407 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800408#define for_each_pool_worker(worker, pool) \
409 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800410 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700411 else
412
413/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700414 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
415 * @pwq: iteration cursor
416 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700417 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700418 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18bc2013-03-13 19:47:40 -0700419 * If the pwq needs to be used beyond the locking in effect, the caller is
420 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700421 *
422 * The if/else clause exists only for the lockdep assertion and can be
423 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700424 */
425#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700426 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700427 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700428 else
Tejun Heof3421792010-07-02 10:03:51 +0200429
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900430#ifdef CONFIG_DEBUG_OBJECTS_WORK
431
432static struct debug_obj_descr work_debug_descr;
433
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100434static void *work_debug_hint(void *addr)
435{
436 return ((struct work_struct *) addr)->func;
437}
438
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700439static bool work_is_static_object(void *addr)
440{
441 struct work_struct *work = addr;
442
443 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
444}
445
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900446/*
447 * fixup_init is called when:
448 * - an active object is initialized
449 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700450static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900451{
452 struct work_struct *work = addr;
453
454 switch (state) {
455 case ODEBUG_STATE_ACTIVE:
456 cancel_work_sync(work);
457 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700458 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900459 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700460 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900461 }
462}
463
464/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900465 * fixup_free is called when:
466 * - an active object is freed
467 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700468static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900469{
470 struct work_struct *work = addr;
471
472 switch (state) {
473 case ODEBUG_STATE_ACTIVE:
474 cancel_work_sync(work);
475 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700476 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900477 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700478 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900479 }
480}
481
482static struct debug_obj_descr work_debug_descr = {
483 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100484 .debug_hint = work_debug_hint,
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700485 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900486 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900487 .fixup_free = work_fixup_free,
488};
489
490static inline void debug_work_activate(struct work_struct *work)
491{
492 debug_object_activate(work, &work_debug_descr);
493}
494
495static inline void debug_work_deactivate(struct work_struct *work)
496{
497 debug_object_deactivate(work, &work_debug_descr);
498}
499
500void __init_work(struct work_struct *work, int onstack)
501{
502 if (onstack)
503 debug_object_init_on_stack(work, &work_debug_descr);
504 else
505 debug_object_init(work, &work_debug_descr);
506}
507EXPORT_SYMBOL_GPL(__init_work);
508
509void destroy_work_on_stack(struct work_struct *work)
510{
511 debug_object_free(work, &work_debug_descr);
512}
513EXPORT_SYMBOL_GPL(destroy_work_on_stack);
514
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000515void destroy_delayed_work_on_stack(struct delayed_work *work)
516{
517 destroy_timer_on_stack(&work->timer);
518 debug_object_free(&work->work, &work_debug_descr);
519}
520EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
521
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900522#else
523static inline void debug_work_activate(struct work_struct *work) { }
524static inline void debug_work_deactivate(struct work_struct *work) { }
525#endif
526
Li Bin4e8b22b2013-09-10 09:52:35 +0800527/**
528 * worker_pool_assign_id - allocate ID and assing it to @pool
529 * @pool: the pool pointer of interest
530 *
531 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
532 * successfully, -errno on failure.
533 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800534static int worker_pool_assign_id(struct worker_pool *pool)
535{
536 int ret;
537
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700538 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700539
Li Bin4e8b22b2013-09-10 09:52:35 +0800540 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
541 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700542 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700543 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700544 return 0;
545 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800546 return ret;
547}
548
Tejun Heo76af4d92013-03-12 11:30:00 -0700549/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700550 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
551 * @wq: the target workqueue
552 * @node: the node ID
553 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800554 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
555 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700556 * If the pwq needs to be used beyond the locking in effect, the caller is
557 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700558 *
559 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700560 */
561static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
562 int node)
563{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800564 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500565
566 /*
567 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
568 * delayed item is pending. The plan is to keep CPU -> NODE
569 * mapping valid and stable across CPU on/offlines. Once that
570 * happens, this workaround can be removed.
571 */
572 if (unlikely(node == NUMA_NO_NODE))
573 return wq->dfl_pwq;
574
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700575 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
576}
577
Tejun Heo73f53c42010-06-29 10:07:11 +0200578static unsigned int work_color_to_flags(int color)
579{
580 return color << WORK_STRUCT_COLOR_SHIFT;
581}
582
583static int get_work_color(struct work_struct *work)
584{
585 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
586 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
587}
588
589static int work_next_color(int color)
590{
591 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700592}
593
David Howells4594bf12006-12-07 11:33:26 +0000594/*
Tejun Heo112202d2013-02-13 19:29:12 -0800595 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
596 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800597 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200598 *
Tejun Heo112202d2013-02-13 19:29:12 -0800599 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
600 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700601 * work->data. These functions should only be called while the work is
602 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200603 *
Tejun Heo112202d2013-02-13 19:29:12 -0800604 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800605 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800606 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800607 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700608 *
609 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
610 * canceled. While being canceled, a work item may have its PENDING set
611 * but stay off timer and worklist for arbitrarily long and nobody should
612 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000613 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200614static inline void set_work_data(struct work_struct *work, unsigned long data,
615 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000616{
Tejun Heo6183c002013-03-12 11:29:57 -0700617 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200618 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000619}
David Howells365970a2006-11-22 14:54:49 +0000620
Tejun Heo112202d2013-02-13 19:29:12 -0800621static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200622 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200623{
Tejun Heo112202d2013-02-13 19:29:12 -0800624 set_work_data(work, (unsigned long)pwq,
625 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200626}
627
Lai Jiangshan4468a002013-02-06 18:04:53 -0800628static void set_work_pool_and_keep_pending(struct work_struct *work,
629 int pool_id)
630{
631 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
632 WORK_STRUCT_PENDING);
633}
634
Tejun Heo7c3eed52013-01-24 11:01:33 -0800635static void set_work_pool_and_clear_pending(struct work_struct *work,
636 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000637{
Tejun Heo23657bb2012-08-13 17:08:19 -0700638 /*
639 * The following wmb is paired with the implied mb in
640 * test_and_set_bit(PENDING) and ensures all updates to @work made
641 * here are visible to and precede any updates by the next PENDING
642 * owner.
643 */
644 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800645 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200646 /*
647 * The following mb guarantees that previous clear of a PENDING bit
648 * will not be reordered with any speculative LOADS or STORES from
649 * work->current_func, which is executed afterwards. This possible
650 * reordering can lead to a missed execution on attempt to qeueue
651 * the same @work. E.g. consider this case:
652 *
653 * CPU#0 CPU#1
654 * ---------------------------- --------------------------------
655 *
656 * 1 STORE event_indicated
657 * 2 queue_work_on() {
658 * 3 test_and_set_bit(PENDING)
659 * 4 } set_..._and_clear_pending() {
660 * 5 set_work_data() # clear bit
661 * 6 smp_mb()
662 * 7 work->current_func() {
663 * 8 LOAD event_indicated
664 * }
665 *
666 * Without an explicit full barrier speculative LOAD on line 8 can
667 * be executed before CPU#0 does STORE on line 1. If that happens,
668 * CPU#0 observes the PENDING bit is still set and new execution of
669 * a @work is not queued in a hope, that CPU#1 will eventually
670 * finish the queued @work. Meanwhile CPU#1 does not see
671 * event_indicated is set, because speculative LOAD was executed
672 * before actual STORE.
673 */
674 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200675}
676
677static void clear_work_data(struct work_struct *work)
678{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800679 smp_wmb(); /* see set_work_pool_and_clear_pending() */
680 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200681}
682
Tejun Heo112202d2013-02-13 19:29:12 -0800683static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200684{
Tejun Heoe1201532010-07-22 14:14:25 +0200685 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200686
Tejun Heo112202d2013-02-13 19:29:12 -0800687 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200688 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
689 else
690 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200691}
692
Tejun Heo7c3eed52013-01-24 11:01:33 -0800693/**
694 * get_work_pool - return the worker_pool a given work was associated with
695 * @work: the work item of interest
696 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700697 * Pools are created and destroyed under wq_pool_mutex, and allows read
698 * access under sched-RCU read lock. As such, this function should be
699 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700700 *
701 * All fields of the returned pool are accessible as long as the above
702 * mentioned locking is in effect. If the returned pool needs to be used
703 * beyond the critical section, the caller is responsible for ensuring the
704 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700705 *
706 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800707 */
708static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200709{
Tejun Heoe1201532010-07-22 14:14:25 +0200710 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800711 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200712
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700713 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700714
Tejun Heo112202d2013-02-13 19:29:12 -0800715 if (data & WORK_STRUCT_PWQ)
716 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800717 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200718
Tejun Heo7c3eed52013-01-24 11:01:33 -0800719 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
720 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200721 return NULL;
722
Tejun Heofa1b54e2013-03-12 11:30:00 -0700723 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800724}
725
726/**
727 * get_work_pool_id - return the worker pool ID a given work is associated with
728 * @work: the work item of interest
729 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700730 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800731 * %WORK_OFFQ_POOL_NONE if none.
732 */
733static int get_work_pool_id(struct work_struct *work)
734{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800735 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800736
Tejun Heo112202d2013-02-13 19:29:12 -0800737 if (data & WORK_STRUCT_PWQ)
738 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800739 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
740
741 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800742}
743
Tejun Heobbb68df2012-08-03 10:30:46 -0700744static void mark_work_canceling(struct work_struct *work)
745{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800746 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700747
Tejun Heo7c3eed52013-01-24 11:01:33 -0800748 pool_id <<= WORK_OFFQ_POOL_SHIFT;
749 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700750}
751
752static bool work_is_canceling(struct work_struct *work)
753{
754 unsigned long data = atomic_long_read(&work->data);
755
Tejun Heo112202d2013-02-13 19:29:12 -0800756 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700757}
758
David Howells365970a2006-11-22 14:54:49 +0000759/*
Tejun Heo32704762012-07-13 22:16:45 -0700760 * Policy functions. These define the policies on how the global worker
761 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800762 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000763 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200764
Tejun Heo63d95a92012-07-12 14:46:37 -0700765static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000766{
Tejun Heoe19e3972013-01-24 11:39:44 -0800767 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000768}
769
Tejun Heoe22bee72010-06-29 10:07:14 +0200770/*
771 * Need to wake up a worker? Called from anything but currently
772 * running workers.
Tejun Heo974271c42012-07-12 14:46:37 -0700773 *
774 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800775 * function will always return %true for unbound pools as long as the
Tejun Heo974271c42012-07-12 14:46:37 -0700776 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200777 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700778static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000779{
Tejun Heo63d95a92012-07-12 14:46:37 -0700780 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000781}
782
Tejun Heoe22bee72010-06-29 10:07:14 +0200783/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700784static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200785{
Tejun Heo63d95a92012-07-12 14:46:37 -0700786 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200787}
788
789/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700790static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200791{
Tejun Heoe19e3972013-01-24 11:39:44 -0800792 return !list_empty(&pool->worklist) &&
793 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200794}
795
796/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700797static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200798{
Tejun Heo63d95a92012-07-12 14:46:37 -0700799 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200800}
801
Tejun Heoe22bee72010-06-29 10:07:14 +0200802/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700803static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200804{
Tejun Heo692b4822017-10-09 08:04:13 -0700805 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700806 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
807 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200808
809 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
810}
811
812/*
813 * Wake up functions.
814 */
815
Lai Jiangshan1037de32014-05-22 16:44:07 +0800816/* Return the first idle worker. Safe with preemption disabled */
817static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200818{
Tejun Heo63d95a92012-07-12 14:46:37 -0700819 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200820 return NULL;
821
Tejun Heo63d95a92012-07-12 14:46:37 -0700822 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200823}
824
825/**
826 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700827 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200828 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700829 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200830 *
831 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800832 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200833 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700834static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200835{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800836 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200837
838 if (likely(worker))
839 wake_up_process(worker->task);
840}
841
Tejun Heo4690c4a2010-06-29 10:07:10 +0200842/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200843 * wq_worker_waking_up - a worker is waking up
844 * @task: task waking up
845 * @cpu: CPU @task is waking up to
846 *
847 * This function is called during try_to_wake_up() when a worker is
848 * being awoken.
849 *
850 * CONTEXT:
851 * spin_lock_irq(rq->lock)
852 */
Tejun Heod84ff052013-03-12 11:29:59 -0700853void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200854{
855 struct worker *worker = kthread_data(task);
856
Joonsoo Kim36576002012-10-26 23:03:49 +0900857 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800858 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800859 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900860 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200861}
862
863/**
864 * wq_worker_sleeping - a worker is going to sleep
865 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200866 *
867 * This function is called during schedule() when a busy worker is
868 * going to sleep. Worker on the same cpu can be woken up by
869 * returning pointer to its task.
870 *
871 * CONTEXT:
872 * spin_lock_irq(rq->lock)
873 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700874 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200875 * Worker task on @cpu to wake up, %NULL if none.
876 */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100877struct task_struct *wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200878{
879 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800880 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200881
Tejun Heo111c2252013-01-17 17:16:24 -0800882 /*
883 * Rescuers, which may not have all the fields set up like normal
884 * workers, also reach here, let's not access anything before
885 * checking NOT_RUNNING.
886 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500887 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200888 return NULL;
889
Tejun Heo111c2252013-01-17 17:16:24 -0800890 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800891
Tejun Heoe22bee72010-06-29 10:07:14 +0200892 /* this can only happen on the local cpu */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100893 if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
Tejun Heo6183c002013-03-12 11:29:57 -0700894 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200895
896 /*
897 * The counterpart of the following dec_and_test, implied mb,
898 * worklist not empty test sequence is in insert_work().
899 * Please read comment there.
900 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700901 * NOT_RUNNING is clear. This means that we're bound to and
902 * running on the local cpu w/ rq lock held and preemption
903 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800904 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700905 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200906 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800907 if (atomic_dec_and_test(&pool->nr_running) &&
908 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800909 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200910 return to_wakeup ? to_wakeup->task : NULL;
911}
912
913/**
914 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200915 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200916 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200917 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800918 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200919 *
Tejun Heocb444762010-07-02 10:03:50 +0200920 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800921 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200922 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800923static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200924{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700925 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200926
Tejun Heocb444762010-07-02 10:03:50 +0200927 WARN_ON_ONCE(worker->task != current);
928
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800929 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200930 if ((flags & WORKER_NOT_RUNNING) &&
931 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800932 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200933 }
934
Tejun Heod302f012010-06-29 10:07:13 +0200935 worker->flags |= flags;
936}
937
938/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200939 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200940 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200941 * @flags: flags to clear
942 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200943 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200944 *
Tejun Heocb444762010-07-02 10:03:50 +0200945 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800946 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200947 */
948static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
949{
Tejun Heo63d95a92012-07-12 14:46:37 -0700950 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200951 unsigned int oflags = worker->flags;
952
Tejun Heocb444762010-07-02 10:03:50 +0200953 WARN_ON_ONCE(worker->task != current);
954
Tejun Heod302f012010-06-29 10:07:13 +0200955 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200956
Tejun Heo42c025f2011-01-11 15:58:49 +0100957 /*
958 * If transitioning out of NOT_RUNNING, increment nr_running. Note
959 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
960 * of multiple flags, not a single flag.
961 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200962 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
963 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800964 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200965}
966
967/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200968 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800969 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200970 * @work: work to find worker for
971 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800972 * Find a worker which is executing @work on @pool by searching
973 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800974 * to match, its current execution should match the address of @work and
975 * its work function. This is to avoid unwanted dependency between
976 * unrelated work executions through a work item being recycled while still
977 * being executed.
978 *
979 * This is a bit tricky. A work item may be freed once its execution
980 * starts and nothing prevents the freed area from being recycled for
981 * another work item. If the same work item address ends up being reused
982 * before the original execution finishes, workqueue will identify the
983 * recycled work item as currently executing and make it wait until the
984 * current execution finishes, introducing an unwanted dependency.
985 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700986 * This function checks the work item address and work function to avoid
987 * false positives. Note that this isn't complete as one may construct a
988 * work function which can introduce dependency onto itself through a
989 * recycled work item. Well, if somebody wants to shoot oneself in the
990 * foot that badly, there's only so much we can do, and if such deadlock
991 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200992 *
993 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800994 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200995 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700996 * Return:
997 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200998 * otherwise.
999 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001000static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001001 struct work_struct *work)
1002{
Sasha Levin42f85702012-12-17 10:01:23 -05001003 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001004
Sasha Levinb67bfe02013-02-27 17:06:00 -08001005 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001006 (unsigned long)work)
1007 if (worker->current_work == work &&
1008 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001009 return worker;
1010
1011 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001012}
1013
1014/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001015 * move_linked_works - move linked works to a list
1016 * @work: start of series of works to be scheduled
1017 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301018 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001019 *
1020 * Schedule linked works starting from @work to @head. Work series to
1021 * be scheduled starts at @work and includes any consecutive work with
1022 * WORK_STRUCT_LINKED set in its predecessor.
1023 *
1024 * If @nextp is not NULL, it's updated to point to the next work of
1025 * the last scheduled work. This allows move_linked_works() to be
1026 * nested inside outer list_for_each_entry_safe().
1027 *
1028 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001029 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001030 */
1031static void move_linked_works(struct work_struct *work, struct list_head *head,
1032 struct work_struct **nextp)
1033{
1034 struct work_struct *n;
1035
1036 /*
1037 * Linked worklist will always end before the end of the list,
1038 * use NULL for list head.
1039 */
1040 list_for_each_entry_safe_from(work, n, NULL, entry) {
1041 list_move_tail(&work->entry, head);
1042 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1043 break;
1044 }
1045
1046 /*
1047 * If we're already inside safe list traversal and have moved
1048 * multiple works to the scheduled queue, the next position
1049 * needs to be updated.
1050 */
1051 if (nextp)
1052 *nextp = n;
1053}
1054
Tejun Heo8864b4e2013-03-12 11:30:04 -07001055/**
1056 * get_pwq - get an extra reference on the specified pool_workqueue
1057 * @pwq: pool_workqueue to get
1058 *
1059 * Obtain an extra reference on @pwq. The caller should guarantee that
1060 * @pwq has positive refcnt and be holding the matching pool->lock.
1061 */
1062static void get_pwq(struct pool_workqueue *pwq)
1063{
1064 lockdep_assert_held(&pwq->pool->lock);
1065 WARN_ON_ONCE(pwq->refcnt <= 0);
1066 pwq->refcnt++;
1067}
1068
1069/**
1070 * put_pwq - put a pool_workqueue reference
1071 * @pwq: pool_workqueue to put
1072 *
1073 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1074 * destruction. The caller should be holding the matching pool->lock.
1075 */
1076static void put_pwq(struct pool_workqueue *pwq)
1077{
1078 lockdep_assert_held(&pwq->pool->lock);
1079 if (likely(--pwq->refcnt))
1080 return;
1081 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1082 return;
1083 /*
1084 * @pwq can't be released under pool->lock, bounce to
1085 * pwq_unbound_release_workfn(). This never recurses on the same
1086 * pool->lock as this path is taken only for unbound workqueues and
1087 * the release work item is scheduled on a per-cpu workqueue. To
1088 * avoid lockdep warning, unbound pool->locks are given lockdep
1089 * subclass of 1 in get_unbound_pool().
1090 */
1091 schedule_work(&pwq->unbound_release_work);
1092}
1093
Tejun Heodce90d42013-04-01 11:23:35 -07001094/**
1095 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1096 * @pwq: pool_workqueue to put (can be %NULL)
1097 *
1098 * put_pwq() with locking. This function also allows %NULL @pwq.
1099 */
1100static void put_pwq_unlocked(struct pool_workqueue *pwq)
1101{
1102 if (pwq) {
1103 /*
1104 * As both pwqs and pools are sched-RCU protected, the
1105 * following lock operations are safe.
1106 */
1107 spin_lock_irq(&pwq->pool->lock);
1108 put_pwq(pwq);
1109 spin_unlock_irq(&pwq->pool->lock);
1110 }
1111}
1112
Tejun Heo112202d2013-02-13 19:29:12 -08001113static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001114{
Tejun Heo112202d2013-02-13 19:29:12 -08001115 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001116
1117 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001118 if (list_empty(&pwq->pool->worklist))
1119 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001120 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001121 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001122 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001123}
1124
Tejun Heo112202d2013-02-13 19:29:12 -08001125static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001126{
Tejun Heo112202d2013-02-13 19:29:12 -08001127 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001128 struct work_struct, entry);
1129
Tejun Heo112202d2013-02-13 19:29:12 -08001130 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001131}
1132
Tejun Heobf4ede02012-08-03 10:30:46 -07001133/**
Tejun Heo112202d2013-02-13 19:29:12 -08001134 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1135 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001136 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001137 *
1138 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001139 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001140 *
1141 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001142 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001143 */
Tejun Heo112202d2013-02-13 19:29:12 -08001144static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001145{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001146 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001147 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001148 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001149
Tejun Heo112202d2013-02-13 19:29:12 -08001150 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001151
Tejun Heo112202d2013-02-13 19:29:12 -08001152 pwq->nr_active--;
1153 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001154 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001155 if (pwq->nr_active < pwq->max_active)
1156 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001157 }
1158
1159 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001160 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001161 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001162
1163 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001164 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001165 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001166
Tejun Heo112202d2013-02-13 19:29:12 -08001167 /* this pwq is done, clear flush_color */
1168 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001169
1170 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001171 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001172 * will handle the rest.
1173 */
Tejun Heo112202d2013-02-13 19:29:12 -08001174 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1175 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001176out_put:
1177 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001178}
1179
Tejun Heo36e227d2012-08-03 10:30:46 -07001180/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001181 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001182 * @work: work item to steal
1183 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001184 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001185 *
1186 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001187 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001188 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001189 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001190 * 1 if @work was pending and we successfully stole PENDING
1191 * 0 if @work was idle and we claimed PENDING
1192 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001193 * -ENOENT if someone else is canceling @work, this state may persist
1194 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001195 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001196 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001197 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001198 * interrupted while holding PENDING and @work off queue, irq must be
1199 * disabled on entry. This, combined with delayed_work->timer being
1200 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001201 *
1202 * On successful return, >= 0, irq is disabled and the caller is
1203 * responsible for releasing it using local_irq_restore(*@flags).
1204 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001205 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001206 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001207static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1208 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001209{
Tejun Heod565ed62013-01-24 11:01:33 -08001210 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001211 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001212
Tejun Heobbb68df2012-08-03 10:30:46 -07001213 local_irq_save(*flags);
1214
Tejun Heo36e227d2012-08-03 10:30:46 -07001215 /* try to steal the timer if it exists */
1216 if (is_dwork) {
1217 struct delayed_work *dwork = to_delayed_work(work);
1218
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001219 /*
1220 * dwork->timer is irqsafe. If del_timer() fails, it's
1221 * guaranteed that the timer is not queued anywhere and not
1222 * running on the local CPU.
1223 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001224 if (likely(del_timer(&dwork->timer)))
1225 return 1;
1226 }
1227
1228 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001229 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1230 return 0;
1231
1232 /*
1233 * The queueing is in progress, or it is already queued. Try to
1234 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1235 */
Tejun Heod565ed62013-01-24 11:01:33 -08001236 pool = get_work_pool(work);
1237 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001238 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001239
Tejun Heod565ed62013-01-24 11:01:33 -08001240 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001241 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001242 * work->data is guaranteed to point to pwq only while the work
1243 * item is queued on pwq->wq, and both updating work->data to point
1244 * to pwq on queueing and to pool on dequeueing are done under
1245 * pwq->pool->lock. This in turn guarantees that, if work->data
1246 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001247 * item is currently queued on that pool.
1248 */
Tejun Heo112202d2013-02-13 19:29:12 -08001249 pwq = get_work_pwq(work);
1250 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001251 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001252
Tejun Heo16062832013-02-06 18:04:53 -08001253 /*
1254 * A delayed work item cannot be grabbed directly because
1255 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001256 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001257 * management later on and cause stall. Make sure the work
1258 * item is activated before grabbing.
1259 */
1260 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001261 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001262
Tejun Heo16062832013-02-06 18:04:53 -08001263 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001264 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001265
Tejun Heo112202d2013-02-13 19:29:12 -08001266 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001267 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001268
Tejun Heo16062832013-02-06 18:04:53 -08001269 spin_unlock(&pool->lock);
1270 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001271 }
Tejun Heod565ed62013-01-24 11:01:33 -08001272 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001273fail:
1274 local_irq_restore(*flags);
1275 if (work_is_canceling(work))
1276 return -ENOENT;
1277 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001278 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001279}
1280
1281/**
Tejun Heo706026c2013-01-24 11:01:34 -08001282 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001283 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001284 * @work: work to insert
1285 * @head: insertion point
1286 * @extra_flags: extra WORK_STRUCT_* flags to set
1287 *
Tejun Heo112202d2013-02-13 19:29:12 -08001288 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001289 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001290 *
1291 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001292 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001293 */
Tejun Heo112202d2013-02-13 19:29:12 -08001294static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1295 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001296{
Tejun Heo112202d2013-02-13 19:29:12 -08001297 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001298
Tejun Heo4690c4a2010-06-29 10:07:10 +02001299 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001300 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001301 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001302 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001303
1304 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001305 * Ensure either wq_worker_sleeping() sees the above
1306 * list_add_tail() or we see zero nr_running to avoid workers lying
1307 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001308 */
1309 smp_mb();
1310
Tejun Heo63d95a92012-07-12 14:46:37 -07001311 if (__need_more_worker(pool))
1312 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001313}
1314
Tejun Heoc8efcc22010-12-20 19:32:04 +01001315/*
1316 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001317 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001318 */
1319static bool is_chained_work(struct workqueue_struct *wq)
1320{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001321 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001322
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001323 worker = current_wq_worker();
1324 /*
1325 * Return %true iff I'm a worker execuing a work item on @wq. If
1326 * I'm @worker, it's safe to dereference it without locking.
1327 */
Tejun Heo112202d2013-02-13 19:29:12 -08001328 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001329}
1330
Mike Galbraithef5571802016-02-09 17:59:38 -05001331/*
1332 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1333 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1334 * avoid perturbing sensitive tasks.
1335 */
1336static int wq_select_unbound_cpu(int cpu)
1337{
Tejun Heof303fccb2016-02-09 17:59:38 -05001338 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001339 int new_cpu;
1340
Tejun Heof303fccb2016-02-09 17:59:38 -05001341 if (likely(!wq_debug_force_rr_cpu)) {
1342 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1343 return cpu;
1344 } else if (!printed_dbg_warning) {
1345 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1346 printed_dbg_warning = true;
1347 }
1348
Mike Galbraithef5571802016-02-09 17:59:38 -05001349 if (cpumask_empty(wq_unbound_cpumask))
1350 return cpu;
1351
1352 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1353 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1354 if (unlikely(new_cpu >= nr_cpu_ids)) {
1355 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1356 if (unlikely(new_cpu >= nr_cpu_ids))
1357 return cpu;
1358 }
1359 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1360
1361 return new_cpu;
1362}
1363
Tejun Heod84ff052013-03-12 11:29:59 -07001364static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 struct work_struct *work)
1366{
Tejun Heo112202d2013-02-13 19:29:12 -08001367 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001368 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001369 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001370 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001371 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001372
1373 /*
1374 * While a work item is PENDING && off queue, a task trying to
1375 * steal the PENDING will busy-loop waiting for it to either get
1376 * queued or lose PENDING. Grabbing PENDING and queueing should
1377 * happen with IRQ disabled.
1378 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001379 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001381 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001382
Li Bin9ef28a72013-09-09 13:13:58 +08001383 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001384 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001385 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001386 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001387retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001388 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001389 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001390
Tejun Heoc9178082013-03-12 11:30:04 -07001391 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001392 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001393 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001394 else
1395 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001396
Tejun Heoc9178082013-03-12 11:30:04 -07001397 /*
1398 * If @work was previously on a different pool, it might still be
1399 * running there, in which case the work needs to be queued on that
1400 * pool to guarantee non-reentrancy.
1401 */
1402 last_pool = get_work_pool(work);
1403 if (last_pool && last_pool != pwq->pool) {
1404 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001405
Tejun Heoc9178082013-03-12 11:30:04 -07001406 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001407
Tejun Heoc9178082013-03-12 11:30:04 -07001408 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001409
Tejun Heoc9178082013-03-12 11:30:04 -07001410 if (worker && worker->current_pwq->wq == wq) {
1411 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001412 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001413 /* meh... not running there, queue here */
1414 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001415 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001416 }
Tejun Heof3421792010-07-02 10:03:51 +02001417 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001418 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001419 }
1420
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001421 /*
1422 * pwq is determined and locked. For unbound pools, we could have
1423 * raced with pwq release and it could already be dead. If its
1424 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001425 * without another pwq replacing it in the numa_pwq_tbl or while
1426 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001427 * make forward-progress.
1428 */
1429 if (unlikely(!pwq->refcnt)) {
1430 if (wq->flags & WQ_UNBOUND) {
1431 spin_unlock(&pwq->pool->lock);
1432 cpu_relax();
1433 goto retry;
1434 }
1435 /* oops */
1436 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1437 wq->name, cpu);
1438 }
1439
Tejun Heo112202d2013-02-13 19:29:12 -08001440 /* pwq determined, queue */
1441 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001442
Dan Carpenterf5b25522012-04-13 22:06:58 +03001443 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001444 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001445 return;
1446 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001447
Tejun Heo112202d2013-02-13 19:29:12 -08001448 pwq->nr_in_flight[pwq->work_color]++;
1449 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001450
Tejun Heo112202d2013-02-13 19:29:12 -08001451 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001452 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001453 pwq->nr_active++;
1454 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001455 if (list_empty(worklist))
1456 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001457 } else {
1458 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001459 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001460 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001461
Tejun Heo112202d2013-02-13 19:29:12 -08001462 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001463
Tejun Heo112202d2013-02-13 19:29:12 -08001464 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465}
1466
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001467/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001468 * queue_work_on - queue work on specific cpu
1469 * @cpu: CPU number to execute work on
1470 * @wq: workqueue to use
1471 * @work: work to queue
1472 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001473 * We queue the work to a specific CPU, the caller must ensure it
1474 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001475 *
1476 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001477 */
Tejun Heod4283e92012-08-03 10:30:44 -07001478bool queue_work_on(int cpu, struct workqueue_struct *wq,
1479 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001480{
Tejun Heod4283e92012-08-03 10:30:44 -07001481 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001482 unsigned long flags;
1483
1484 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001485
Tejun Heo22df02b2010-06-29 10:07:10 +02001486 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001487 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001488 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001489 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001490
1491 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001492 return ret;
1493}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001494EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001495
Kees Cook8c20feb2017-10-04 16:27:07 -07001496void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497{
Kees Cook8c20feb2017-10-04 16:27:07 -07001498 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001500 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001501 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001503EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001505static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1506 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001508 struct timer_list *timer = &dwork->timer;
1509 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
Tejun Heo637fdba2017-03-06 15:33:42 -05001511 WARN_ON_ONCE(!wq);
Kees Cook841b86f2017-10-23 09:40:42 +02001512 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001513 WARN_ON_ONCE(timer_pending(timer));
1514 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001515
Tejun Heo8852aac2012-12-01 16:23:42 -08001516 /*
1517 * If @delay is 0, queue @dwork->work immediately. This is for
1518 * both optimization and correctness. The earliest @timer can
1519 * expire is on the closest next tick and delayed_work users depend
1520 * on that there's no such delay when @delay is 0.
1521 */
1522 if (!delay) {
1523 __queue_work(cpu, wq, &dwork->work);
1524 return;
1525 }
1526
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001527 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001528 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001529 timer->expires = jiffies + delay;
1530
Tejun Heo041bd122016-02-09 16:11:26 -05001531 if (unlikely(cpu != WORK_CPU_UNBOUND))
1532 add_timer_on(timer, cpu);
1533 else
1534 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535}
1536
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001537/**
1538 * queue_delayed_work_on - queue work on specific CPU after delay
1539 * @cpu: CPU number to execute work on
1540 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001541 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001542 * @delay: number of jiffies to wait before queueing
1543 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001544 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001545 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1546 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001547 */
Tejun Heod4283e92012-08-03 10:30:44 -07001548bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1549 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001550{
David Howells52bad642006-11-22 14:54:01 +00001551 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001552 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001553 unsigned long flags;
1554
1555 /* read the comment in __queue_work() */
1556 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001557
Tejun Heo22df02b2010-06-29 10:07:10 +02001558 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001559 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001560 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001561 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001562
1563 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001564 return ret;
1565}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001566EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
Tejun Heoc8e55f32010-06-29 10:07:12 +02001568/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001569 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1570 * @cpu: CPU number to execute work on
1571 * @wq: workqueue to use
1572 * @dwork: work to queue
1573 * @delay: number of jiffies to wait before queueing
1574 *
1575 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1576 * modify @dwork's timer so that it expires after @delay. If @delay is
1577 * zero, @work is guaranteed to be scheduled immediately regardless of its
1578 * current state.
1579 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001580 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001581 * pending and its timer was modified.
1582 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001583 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001584 * See try_to_grab_pending() for details.
1585 */
1586bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1587 struct delayed_work *dwork, unsigned long delay)
1588{
1589 unsigned long flags;
1590 int ret;
1591
1592 do {
1593 ret = try_to_grab_pending(&dwork->work, true, &flags);
1594 } while (unlikely(ret == -EAGAIN));
1595
1596 if (likely(ret >= 0)) {
1597 __queue_delayed_work(cpu, wq, dwork, delay);
1598 local_irq_restore(flags);
1599 }
1600
1601 /* -ENOENT from try_to_grab_pending() becomes %true */
1602 return ret;
1603}
1604EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1605
Tejun Heo05f0fe62018-03-14 12:45:13 -07001606static void rcu_work_rcufn(struct rcu_head *rcu)
1607{
1608 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1609
1610 /* read the comment in __queue_work() */
1611 local_irq_disable();
1612 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1613 local_irq_enable();
1614}
1615
1616/**
1617 * queue_rcu_work - queue work after a RCU grace period
1618 * @wq: workqueue to use
1619 * @rwork: work to queue
1620 *
1621 * Return: %false if @rwork was already pending, %true otherwise. Note
1622 * that a full RCU grace period is guaranteed only after a %true return.
1623 * While @rwork is guarnateed to be executed after a %false return, the
1624 * execution may happen before a full RCU grace period has passed.
1625 */
1626bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1627{
1628 struct work_struct *work = &rwork->work;
1629
1630 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1631 rwork->wq = wq;
1632 call_rcu(&rwork->rcu, rcu_work_rcufn);
1633 return true;
1634 }
1635
1636 return false;
1637}
1638EXPORT_SYMBOL(queue_rcu_work);
1639
Tejun Heo8376fe22012-08-03 10:30:47 -07001640/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001641 * worker_enter_idle - enter idle state
1642 * @worker: worker which is entering idle state
1643 *
1644 * @worker is entering idle state. Update stats and idle timer if
1645 * necessary.
1646 *
1647 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001648 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001649 */
1650static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001652 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653
Tejun Heo6183c002013-03-12 11:29:57 -07001654 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1655 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1656 (worker->hentry.next || worker->hentry.pprev)))
1657 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Lai Jiangshan051e1852014-07-22 13:03:02 +08001659 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001660 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001661 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001662 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001663
Tejun Heoc8e55f32010-06-29 10:07:12 +02001664 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001665 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001666
Tejun Heo628c78e2012-07-17 12:39:27 -07001667 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1668 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001669
Tejun Heo544ecf32012-05-14 15:04:50 -07001670 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001671 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001672 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001673 * nr_running, the warning may trigger spuriously. Check iff
1674 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001675 */
Tejun Heo24647572013-01-24 11:01:33 -08001676 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001677 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001678 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679}
1680
Tejun Heoc8e55f32010-06-29 10:07:12 +02001681/**
1682 * worker_leave_idle - leave idle state
1683 * @worker: worker which is leaving idle state
1684 *
1685 * @worker is leaving idle state. Update stats.
1686 *
1687 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001688 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001689 */
1690static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001692 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693
Tejun Heo6183c002013-03-12 11:29:57 -07001694 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1695 return;
Tejun Heod302f012010-06-29 10:07:13 +02001696 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001697 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001698 list_del_init(&worker->entry);
1699}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001701static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001702{
1703 struct worker *worker;
1704
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001705 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001706 if (worker) {
1707 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001708 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001709 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001710 /* on creation a worker is in !idle && prep state */
1711 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001712 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001713 return worker;
1714}
1715
1716/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001717 * worker_attach_to_pool() - attach a worker to a pool
1718 * @worker: worker to be attached
1719 * @pool: the target pool
1720 *
1721 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1722 * cpu-binding of @worker are kept coordinated with the pool across
1723 * cpu-[un]hotplugs.
1724 */
1725static void worker_attach_to_pool(struct worker *worker,
1726 struct worker_pool *pool)
1727{
1728 mutex_lock(&pool->attach_mutex);
1729
1730 /*
1731 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1732 * online CPUs. It'll be re-applied when any of the CPUs come up.
1733 */
1734 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1735
1736 /*
1737 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1738 * stable across this function. See the comments above the
1739 * flag definition for details.
1740 */
1741 if (pool->flags & POOL_DISASSOCIATED)
1742 worker->flags |= WORKER_UNBOUND;
1743
1744 list_add_tail(&worker->node, &pool->workers);
1745
1746 mutex_unlock(&pool->attach_mutex);
1747}
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
1752 * @pool: the pool @worker is attached to
1753 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001754 * Undo the attaching which had been done in worker_attach_to_pool(). The
1755 * caller worker shouldn't access to the pool after detached except it has
1756 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001757 */
1758static void worker_detach_from_pool(struct worker *worker,
1759 struct worker_pool *pool)
1760{
1761 struct completion *detach_completion = NULL;
1762
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001763 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001764 list_del(&worker->node);
1765 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001766 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001767 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001768
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001769 /* clear leftover flags without pool->lock after it is detached */
1770 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1771
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001772 if (detach_completion)
1773 complete(detach_completion);
1774}
1775
1776/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001777 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001778 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001779 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001780 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001781 *
1782 * CONTEXT:
1783 * Might sleep. Does GFP_KERNEL allocations.
1784 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001785 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001786 * Pointer to the newly created worker.
1787 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001788static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001789{
Tejun Heoc34056a2010-06-29 10:07:11 +02001790 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001791 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001792 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001793
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001794 /* ID is needed to determine kthread name */
1795 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001796 if (id < 0)
1797 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001798
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001799 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001800 if (!worker)
1801 goto fail;
1802
Tejun Heobd7bdd42012-07-12 14:46:37 -07001803 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001804 worker->id = id;
1805
Tejun Heo29c91e92013-03-12 11:30:03 -07001806 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001807 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1808 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001809 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001810 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1811
Tejun Heof3f90ad2013-04-01 11:23:34 -07001812 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001813 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001814 if (IS_ERR(worker->task))
1815 goto fail;
1816
Oleg Nesterov91151222013-11-14 12:56:18 +01001817 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001818 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001819
Lai Jiangshanda028462014-05-20 17:46:31 +08001820 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001821 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001822
Lai Jiangshan051e1852014-07-22 13:03:02 +08001823 /* start the newly created worker */
1824 spin_lock_irq(&pool->lock);
1825 worker->pool->nr_workers++;
1826 worker_enter_idle(worker);
1827 wake_up_process(worker->task);
1828 spin_unlock_irq(&pool->lock);
1829
Tejun Heoc34056a2010-06-29 10:07:11 +02001830 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001831
Tejun Heoc34056a2010-06-29 10:07:11 +02001832fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001833 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001834 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001835 kfree(worker);
1836 return NULL;
1837}
1838
1839/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001840 * destroy_worker - destroy a workqueue worker
1841 * @worker: worker to be destroyed
1842 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001843 * Destroy @worker and adjust @pool stats accordingly. The worker should
1844 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001845 *
1846 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001847 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001848 */
1849static void destroy_worker(struct worker *worker)
1850{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001851 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001852
Tejun Heocd549682013-03-13 19:47:39 -07001853 lockdep_assert_held(&pool->lock);
1854
Tejun Heoc34056a2010-06-29 10:07:11 +02001855 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001856 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001857 WARN_ON(!list_empty(&worker->scheduled)) ||
1858 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001859 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001860
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001861 pool->nr_workers--;
1862 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001863
Tejun Heoc8e55f32010-06-29 10:07:12 +02001864 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001865 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001866 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001867}
1868
Kees Cook32a6c722017-10-16 15:58:25 -07001869static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001870{
Kees Cook32a6c722017-10-16 15:58:25 -07001871 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001872
Tejun Heod565ed62013-01-24 11:01:33 -08001873 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001874
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001875 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001876 struct worker *worker;
1877 unsigned long expires;
1878
1879 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001880 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001881 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1882
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001883 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001884 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001885 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001886 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001887
1888 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001889 }
1890
Tejun Heod565ed62013-01-24 11:01:33 -08001891 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001892}
1893
Tejun Heo493a1722013-03-12 11:29:59 -07001894static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001895{
Tejun Heo112202d2013-02-13 19:29:12 -08001896 struct pool_workqueue *pwq = get_work_pwq(work);
1897 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001898
Tejun Heo2e109a22013-03-13 19:47:40 -07001899 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001900
Tejun Heo493008a2013-03-12 11:30:03 -07001901 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001902 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001903
1904 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001905 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001906 /*
1907 * If @pwq is for an unbound wq, its base ref may be put at
1908 * any time due to an attribute change. Pin @pwq until the
1909 * rescuer is done with it.
1910 */
1911 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001912 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001913 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001914 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001915}
1916
Kees Cook32a6c722017-10-16 15:58:25 -07001917static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001918{
Kees Cook32a6c722017-10-16 15:58:25 -07001919 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001920 struct work_struct *work;
1921
Tejun Heob2d82902014-12-08 12:39:16 -05001922 spin_lock_irq(&pool->lock);
1923 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001924
Tejun Heo63d95a92012-07-12 14:46:37 -07001925 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001926 /*
1927 * We've been trying to create a new worker but
1928 * haven't been successful. We might be hitting an
1929 * allocation deadlock. Send distress signals to
1930 * rescuers.
1931 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001932 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001933 send_mayday(work);
1934 }
1935
Tejun Heob2d82902014-12-08 12:39:16 -05001936 spin_unlock(&wq_mayday_lock);
1937 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001938
Tejun Heo63d95a92012-07-12 14:46:37 -07001939 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001940}
1941
1942/**
1943 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001944 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001945 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001946 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001947 * have at least one idle worker on return from this function. If
1948 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001949 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001950 * possible allocation deadlock.
1951 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001952 * On return, need_to_create_worker() is guaranteed to be %false and
1953 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001954 *
1955 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001956 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001957 * multiple times. Does GFP_KERNEL allocations. Called only from
1958 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001959 */
Tejun Heo29187a92015-01-16 14:21:16 -05001960static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001961__releases(&pool->lock)
1962__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001963{
Tejun Heoe22bee72010-06-29 10:07:14 +02001964restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001965 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001966
Tejun Heoe22bee72010-06-29 10:07:14 +02001967 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001968 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001969
1970 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001971 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001972 break;
1973
Lai Jiangshane212f362014-06-03 15:32:17 +08001974 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001975
Tejun Heo63d95a92012-07-12 14:46:37 -07001976 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001977 break;
1978 }
1979
Tejun Heo63d95a92012-07-12 14:46:37 -07001980 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001981 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001982 /*
1983 * This is necessary even after a new worker was just successfully
1984 * created as @pool->lock was dropped and the new worker might have
1985 * already become busy.
1986 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001987 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001988 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001989}
1990
1991/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001992 * manage_workers - manage worker pool
1993 * @worker: self
1994 *
Tejun Heo706026c2013-01-24 11:01:34 -08001995 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001996 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001997 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001998 *
1999 * The caller can safely start processing works on false return. On
2000 * true return, it's guaranteed that need_to_create_worker() is false
2001 * and may_start_working() is true.
2002 *
2003 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002004 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002005 * multiple times. Does GFP_KERNEL allocations.
2006 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002007 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002008 * %false if the pool doesn't need management and the caller can safely
2009 * start processing works, %true if management function was performed and
2010 * the conditions that the caller verified before calling the function may
2011 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002012 */
2013static bool manage_workers(struct worker *worker)
2014{
Tejun Heo63d95a92012-07-12 14:46:37 -07002015 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002016
Tejun Heo692b4822017-10-09 08:04:13 -07002017 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002018 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002019
2020 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002021 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002022
Tejun Heo29187a92015-01-16 14:21:16 -05002023 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002024
Tejun Heo2607d7a2015-03-09 09:22:28 -04002025 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002026 pool->flags &= ~POOL_MANAGER_ACTIVE;
2027 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002028 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002029}
2030
Tejun Heoa62428c2010-06-29 10:07:10 +02002031/**
2032 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002033 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002034 * @work: work to process
2035 *
2036 * Process @work. This function contains all the logics necessary to
2037 * process a single work including synchronization against and
2038 * interaction with other workers on the same cpu, queueing and
2039 * flushing. As long as context requirement is met, any worker can
2040 * call this function to process a work.
2041 *
2042 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002043 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002044 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002045static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002046__releases(&pool->lock)
2047__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002048{
Tejun Heo112202d2013-02-13 19:29:12 -08002049 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002050 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002051 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002052 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002053 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002054#ifdef CONFIG_LOCKDEP
2055 /*
2056 * It is permissible to free the struct work_struct from
2057 * inside the function that is called from it, this we need to
2058 * take into account for lockdep too. To avoid bogus "held
2059 * lock freed" warnings as well as problems when looking into
2060 * work->lockdep_map, make a copy and use that here.
2061 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002062 struct lockdep_map lockdep_map;
2063
2064 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002065#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002066 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002067 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002068 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002069
Tejun Heo7e116292010-06-29 10:07:13 +02002070 /*
2071 * A single work shouldn't be executed concurrently by
2072 * multiple workers on a single cpu. Check whether anyone is
2073 * already processing the work. If so, defer the work to the
2074 * currently executing one.
2075 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002076 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002077 if (unlikely(collision)) {
2078 move_linked_works(work, &collision->scheduled, NULL);
2079 return;
2080 }
2081
Tejun Heo8930cab2012-08-03 10:30:45 -07002082 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002083 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002084 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002085 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002086 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002087 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002088 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002089
Tejun Heoa62428c2010-06-29 10:07:10 +02002090 list_del_init(&work->entry);
2091
Tejun Heo649027d2010-06-29 10:07:14 +02002092 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002093 * CPU intensive works don't participate in concurrency management.
2094 * They're the scheduler's responsibility. This takes @worker out
2095 * of concurrency management and the next code block will chain
2096 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002097 */
2098 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002099 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002100
Tejun Heo974271c42012-07-12 14:46:37 -07002101 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002102 * Wake up another worker if necessary. The condition is always
2103 * false for normal per-cpu workers since nr_running would always
2104 * be >= 1 at this point. This is used to chain execution of the
2105 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002106 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c42012-07-12 14:46:37 -07002107 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002108 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002109 wake_up_worker(pool);
Tejun Heo974271c42012-07-12 14:46:37 -07002110
Tejun Heo8930cab2012-08-03 10:30:45 -07002111 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002112 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002113 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002114 * PENDING and queued state changes happen together while IRQ is
2115 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002116 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002117 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002118
Tejun Heod565ed62013-01-24 11:01:33 -08002119 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002120
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002121 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002122 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002123 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002124 * Strictly speaking we should mark the invariant state without holding
2125 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002126 *
2127 * However, that would result in:
2128 *
2129 * A(W1)
2130 * WFC(C)
2131 * A(W1)
2132 * C(C)
2133 *
2134 * Which would create W1->C->W1 dependencies, even though there is no
2135 * actual deadlock possible. There are two solutions, using a
2136 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002137 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002138 * these locks.
2139 *
2140 * AFAICT there is no possible deadlock scenario between the
2141 * flush_work() and complete() primitives (except for single-threaded
2142 * workqueues), so hiding them isn't a problem.
2143 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002144 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002145 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002146 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002147 /*
2148 * While we must be careful to not use "work" after this, the trace
2149 * point will only record its address.
2150 */
2151 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002152 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002153 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002154
2155 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002156 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2157 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002158 current->comm, preempt_count(), task_pid_nr(current),
2159 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002160 debug_show_held_locks(current);
2161 dump_stack();
2162 }
2163
Tejun Heob22ce272013-08-28 17:33:37 -04002164 /*
2165 * The following prevents a kworker from hogging CPU on !PREEMPT
2166 * kernels, where a requeueing work item waiting for something to
2167 * happen could deadlock with stop_machine as such work item could
2168 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002169 * stop_machine. At the same time, report a quiescent RCU state so
2170 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002171 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002172 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002173
Tejun Heod565ed62013-01-24 11:01:33 -08002174 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002175
Tejun Heofb0e7be2010-06-29 10:07:15 +02002176 /* clear cpu intensive status */
2177 if (unlikely(cpu_intensive))
2178 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2179
Tejun Heoa62428c2010-06-29 10:07:10 +02002180 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002181 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002182 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002183 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002184 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002185 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002186 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002187}
2188
Tejun Heoaffee4b2010-06-29 10:07:12 +02002189/**
2190 * process_scheduled_works - process scheduled works
2191 * @worker: self
2192 *
2193 * Process all scheduled works. Please note that the scheduled list
2194 * may change while processing a work, so this function repeatedly
2195 * fetches a work from the top and executes it.
2196 *
2197 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002198 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002199 * multiple times.
2200 */
2201static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002203 while (!list_empty(&worker->scheduled)) {
2204 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002206 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208}
2209
Tejun Heo4690c4a2010-06-29 10:07:10 +02002210/**
2211 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002212 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002213 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002214 * The worker thread function. All workers belong to a worker_pool -
2215 * either a per-cpu one or dynamic unbound one. These workers process all
2216 * work items regardless of their specific target workqueue. The only
2217 * exception is work items which belong to workqueues with a rescuer which
2218 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002219 *
2220 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002221 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002222static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223{
Tejun Heoc34056a2010-06-29 10:07:11 +02002224 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002225 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226
Tejun Heoe22bee72010-06-29 10:07:14 +02002227 /* tell the scheduler that this is a workqueue worker */
2228 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002229woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002230 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002231
Tejun Heoa9ab7752013-03-19 13:45:21 -07002232 /* am I supposed to die? */
2233 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002234 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002235 WARN_ON_ONCE(!list_empty(&worker->entry));
2236 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002237
2238 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002239 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002240 worker_detach_from_pool(worker, pool);
2241 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002242 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002244
Tejun Heoc8e55f32010-06-29 10:07:12 +02002245 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002246recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002247 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002248 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002249 goto sleep;
2250
2251 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002252 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002253 goto recheck;
2254
Tejun Heoc8e55f32010-06-29 10:07:12 +02002255 /*
2256 * ->scheduled list can only be filled while a worker is
2257 * preparing to process a work or actually processing it.
2258 * Make sure nobody diddled with it while I was sleeping.
2259 */
Tejun Heo6183c002013-03-12 11:29:57 -07002260 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002261
Tejun Heoe22bee72010-06-29 10:07:14 +02002262 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002263 * Finish PREP stage. We're guaranteed to have at least one idle
2264 * worker or that someone else has already assumed the manager
2265 * role. This is where @worker starts participating in concurrency
2266 * management if applicable and concurrency management is restored
2267 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002268 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002269 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002270
2271 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002272 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002273 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002274 struct work_struct, entry);
2275
Tejun Heo82607adc2015-12-08 11:28:04 -05002276 pool->watchdog_ts = jiffies;
2277
Tejun Heoc8e55f32010-06-29 10:07:12 +02002278 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2279 /* optimization path, not strictly necessary */
2280 process_one_work(worker, work);
2281 if (unlikely(!list_empty(&worker->scheduled)))
2282 process_scheduled_works(worker);
2283 } else {
2284 move_linked_works(work, &worker->scheduled, NULL);
2285 process_scheduled_works(worker);
2286 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002287 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002288
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002289 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002290sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002291 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002292 * pool->lock is held and there's no work to process and no need to
2293 * manage, sleep. Workers are woken up only while holding
2294 * pool->lock or from local cpu, so setting the current state
2295 * before releasing pool->lock is enough to prevent losing any
2296 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002297 */
2298 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002299 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002300 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002301 schedule();
2302 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303}
2304
Tejun Heoe22bee72010-06-29 10:07:14 +02002305/**
2306 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002307 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002308 *
2309 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002310 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002311 *
Tejun Heo706026c2013-01-24 11:01:34 -08002312 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002313 * worker which uses GFP_KERNEL allocation which has slight chance of
2314 * developing into deadlock if some works currently on the same queue
2315 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2316 * the problem rescuer solves.
2317 *
Tejun Heo706026c2013-01-24 11:01:34 -08002318 * When such condition is possible, the pool summons rescuers of all
2319 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002320 * those works so that forward progress can be guaranteed.
2321 *
2322 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002323 *
2324 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002325 */
Tejun Heo111c2252013-01-17 17:16:24 -08002326static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002327{
Tejun Heo111c2252013-01-17 17:16:24 -08002328 struct worker *rescuer = __rescuer;
2329 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002330 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002331 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002332
2333 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002334
2335 /*
2336 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2337 * doesn't participate in concurrency management.
2338 */
2339 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002340repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002341 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002342
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002343 /*
2344 * By the time the rescuer is requested to stop, the workqueue
2345 * shouldn't have any work pending, but @wq->maydays may still have
2346 * pwq(s) queued. This can happen by non-rescuer workers consuming
2347 * all the work items before the rescuer got to them. Go through
2348 * @wq->maydays processing before acting on should_stop so that the
2349 * list is always empty on exit.
2350 */
2351 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002352
Tejun Heo493a1722013-03-12 11:29:59 -07002353 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002354 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002355
2356 while (!list_empty(&wq->maydays)) {
2357 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2358 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002359 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002360 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002361 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002362
2363 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002364 list_del_init(&pwq->mayday_node);
2365
Tejun Heo2e109a22013-03-13 19:47:40 -07002366 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002367
Lai Jiangshan51697d392014-05-20 17:46:36 +08002368 worker_attach_to_pool(rescuer, pool);
2369
2370 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002371 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002372
2373 /*
2374 * Slurp in all works issued via this workqueue and
2375 * process'em.
2376 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002377 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002378 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2379 if (get_work_pwq(work) == pwq) {
2380 if (first)
2381 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002382 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002383 }
2384 first = false;
2385 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002386
NeilBrown008847f2014-12-08 12:39:16 -05002387 if (!list_empty(scheduled)) {
2388 process_scheduled_works(rescuer);
2389
2390 /*
2391 * The above execution of rescued work items could
2392 * have created more to rescue through
2393 * pwq_activate_first_delayed() or chained
2394 * queueing. Let's put @pwq back on mayday list so
2395 * that such back-to-back work items, which may be
2396 * being used to relieve memory pressure, don't
2397 * incur MAYDAY_INTERVAL delay inbetween.
2398 */
2399 if (need_to_create_worker(pool)) {
2400 spin_lock(&wq_mayday_lock);
2401 get_pwq(pwq);
2402 list_move_tail(&pwq->mayday_node, &wq->maydays);
2403 spin_unlock(&wq_mayday_lock);
2404 }
2405 }
Tejun Heo75769582011-02-14 14:04:46 +01002406
2407 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002408 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002409 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002410 */
2411 put_pwq(pwq);
2412
2413 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002414 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002415 * regular worker; otherwise, we end up with 0 concurrency
2416 * and stalling the execution.
2417 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002418 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002419 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002420
Lai Jiangshanb3104102013-02-19 12:17:02 -08002421 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002422 spin_unlock_irq(&pool->lock);
2423
2424 worker_detach_from_pool(rescuer, pool);
2425
2426 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002427 }
2428
Tejun Heo2e109a22013-03-13 19:47:40 -07002429 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002430
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002431 if (should_stop) {
2432 __set_current_state(TASK_RUNNING);
2433 rescuer->task->flags &= ~PF_WQ_WORKER;
2434 return 0;
2435 }
2436
Tejun Heo111c2252013-01-17 17:16:24 -08002437 /* rescuers should never participate in concurrency management */
2438 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002439 schedule();
2440 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441}
2442
Tejun Heofca839c2015-12-07 10:58:57 -05002443/**
2444 * check_flush_dependency - check for flush dependency sanity
2445 * @target_wq: workqueue being flushed
2446 * @target_work: work item being flushed (NULL for workqueue flushes)
2447 *
2448 * %current is trying to flush the whole @target_wq or @target_work on it.
2449 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2450 * reclaiming memory or running on a workqueue which doesn't have
2451 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2452 * a deadlock.
2453 */
2454static void check_flush_dependency(struct workqueue_struct *target_wq,
2455 struct work_struct *target_work)
2456{
2457 work_func_t target_func = target_work ? target_work->func : NULL;
2458 struct worker *worker;
2459
2460 if (target_wq->flags & WQ_MEM_RECLAIM)
2461 return;
2462
2463 worker = current_wq_worker();
2464
2465 WARN_ONCE(current->flags & PF_MEMALLOC,
2466 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2467 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002468 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2469 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002470 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2471 worker->current_pwq->wq->name, worker->current_func,
2472 target_wq->name, target_func);
2473}
2474
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002475struct wq_barrier {
2476 struct work_struct work;
2477 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002478 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002479};
2480
2481static void wq_barrier_func(struct work_struct *work)
2482{
2483 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2484 complete(&barr->done);
2485}
2486
Tejun Heo4690c4a2010-06-29 10:07:10 +02002487/**
2488 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002489 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002490 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002491 * @target: target work to attach @barr to
2492 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002493 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002494 * @barr is linked to @target such that @barr is completed only after
2495 * @target finishes execution. Please note that the ordering
2496 * guarantee is observed only with respect to @target and on the local
2497 * cpu.
2498 *
2499 * Currently, a queued barrier can't be canceled. This is because
2500 * try_to_grab_pending() can't determine whether the work to be
2501 * grabbed is at the head of the queue and thus can't clear LINKED
2502 * flag of the previous work while there must be a valid next work
2503 * after a work with LINKED flag set.
2504 *
2505 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002506 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002507 *
2508 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002509 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002510 */
Tejun Heo112202d2013-02-13 19:29:12 -08002511static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002512 struct wq_barrier *barr,
2513 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002514{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002515 struct list_head *head;
2516 unsigned int linked = 0;
2517
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002518 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002519 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002520 * as we know for sure that this will not trigger any of the
2521 * checks and call back into the fixup functions where we
2522 * might deadlock.
2523 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002524 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002525 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002526
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002527 init_completion_map(&barr->done, &target->lockdep_map);
2528
Tejun Heo2607d7a2015-03-09 09:22:28 -04002529 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002530
Tejun Heoaffee4b2010-06-29 10:07:12 +02002531 /*
2532 * If @target is currently being executed, schedule the
2533 * barrier to the worker; otherwise, put it after @target.
2534 */
2535 if (worker)
2536 head = worker->scheduled.next;
2537 else {
2538 unsigned long *bits = work_data_bits(target);
2539
2540 head = target->entry.next;
2541 /* there can already be other linked works, inherit and set */
2542 linked = *bits & WORK_STRUCT_LINKED;
2543 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2544 }
2545
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002546 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002547 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002548 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002549}
2550
Tejun Heo73f53c42010-06-29 10:07:11 +02002551/**
Tejun Heo112202d2013-02-13 19:29:12 -08002552 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002553 * @wq: workqueue being flushed
2554 * @flush_color: new flush color, < 0 for no-op
2555 * @work_color: new work color, < 0 for no-op
2556 *
Tejun Heo112202d2013-02-13 19:29:12 -08002557 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002558 *
Tejun Heo112202d2013-02-13 19:29:12 -08002559 * If @flush_color is non-negative, flush_color on all pwqs should be
2560 * -1. If no pwq has in-flight commands at the specified color, all
2561 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2562 * has in flight commands, its pwq->flush_color is set to
2563 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002564 * wakeup logic is armed and %true is returned.
2565 *
2566 * The caller should have initialized @wq->first_flusher prior to
2567 * calling this function with non-negative @flush_color. If
2568 * @flush_color is negative, no flush color update is done and %false
2569 * is returned.
2570 *
Tejun Heo112202d2013-02-13 19:29:12 -08002571 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002572 * work_color which is previous to @work_color and all will be
2573 * advanced to @work_color.
2574 *
2575 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002576 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002577 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002578 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002579 * %true if @flush_color >= 0 and there's something to flush. %false
2580 * otherwise.
2581 */
Tejun Heo112202d2013-02-13 19:29:12 -08002582static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002583 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584{
Tejun Heo73f53c42010-06-29 10:07:11 +02002585 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002586 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002587
Tejun Heo73f53c42010-06-29 10:07:11 +02002588 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002589 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002590 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002591 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002592
Tejun Heo49e3cf42013-03-12 11:29:58 -07002593 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002594 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002595
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002596 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002597
2598 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002599 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002600
Tejun Heo112202d2013-02-13 19:29:12 -08002601 if (pwq->nr_in_flight[flush_color]) {
2602 pwq->flush_color = flush_color;
2603 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002604 wait = true;
2605 }
2606 }
2607
2608 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002609 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002610 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002611 }
2612
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002613 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002614 }
2615
Tejun Heo112202d2013-02-13 19:29:12 -08002616 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002617 complete(&wq->first_flusher->done);
2618
2619 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620}
2621
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002622/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002624 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002626 * This function sleeps until all work items which were queued on entry
2627 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002628 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002629void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002630{
Tejun Heo73f53c42010-06-29 10:07:11 +02002631 struct wq_flusher this_flusher = {
2632 .list = LIST_HEAD_INIT(this_flusher.list),
2633 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002634 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002635 };
2636 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002637
Tejun Heo3347fa02016-09-16 15:49:32 -04002638 if (WARN_ON(!wq_online))
2639 return;
2640
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002641 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002642
2643 /*
2644 * Start-to-wait phase
2645 */
2646 next_color = work_next_color(wq->work_color);
2647
2648 if (next_color != wq->flush_color) {
2649 /*
2650 * Color space is not full. The current work_color
2651 * becomes our flush_color and work_color is advanced
2652 * by one.
2653 */
Tejun Heo6183c002013-03-12 11:29:57 -07002654 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002655 this_flusher.flush_color = wq->work_color;
2656 wq->work_color = next_color;
2657
2658 if (!wq->first_flusher) {
2659 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002660 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002661
2662 wq->first_flusher = &this_flusher;
2663
Tejun Heo112202d2013-02-13 19:29:12 -08002664 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002665 wq->work_color)) {
2666 /* nothing to flush, done */
2667 wq->flush_color = next_color;
2668 wq->first_flusher = NULL;
2669 goto out_unlock;
2670 }
2671 } else {
2672 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002673 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002674 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002675 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002676 }
2677 } else {
2678 /*
2679 * Oops, color space is full, wait on overflow queue.
2680 * The next flush completion will assign us
2681 * flush_color and transfer to flusher_queue.
2682 */
2683 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2684 }
2685
Tejun Heofca839c2015-12-07 10:58:57 -05002686 check_flush_dependency(wq, NULL);
2687
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002688 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002689
2690 wait_for_completion(&this_flusher.done);
2691
2692 /*
2693 * Wake-up-and-cascade phase
2694 *
2695 * First flushers are responsible for cascading flushes and
2696 * handling overflow. Non-first flushers can simply return.
2697 */
2698 if (wq->first_flusher != &this_flusher)
2699 return;
2700
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002701 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002702
Tejun Heo4ce48b32010-07-02 10:03:51 +02002703 /* we might have raced, check again with mutex held */
2704 if (wq->first_flusher != &this_flusher)
2705 goto out_unlock;
2706
Tejun Heo73f53c42010-06-29 10:07:11 +02002707 wq->first_flusher = NULL;
2708
Tejun Heo6183c002013-03-12 11:29:57 -07002709 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2710 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002711
2712 while (true) {
2713 struct wq_flusher *next, *tmp;
2714
2715 /* complete all the flushers sharing the current flush color */
2716 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2717 if (next->flush_color != wq->flush_color)
2718 break;
2719 list_del_init(&next->list);
2720 complete(&next->done);
2721 }
2722
Tejun Heo6183c002013-03-12 11:29:57 -07002723 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2724 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002725
2726 /* this flush_color is finished, advance by one */
2727 wq->flush_color = work_next_color(wq->flush_color);
2728
2729 /* one color has been freed, handle overflow queue */
2730 if (!list_empty(&wq->flusher_overflow)) {
2731 /*
2732 * Assign the same color to all overflowed
2733 * flushers, advance work_color and append to
2734 * flusher_queue. This is the start-to-wait
2735 * phase for these overflowed flushers.
2736 */
2737 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2738 tmp->flush_color = wq->work_color;
2739
2740 wq->work_color = work_next_color(wq->work_color);
2741
2742 list_splice_tail_init(&wq->flusher_overflow,
2743 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002744 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002745 }
2746
2747 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002748 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002749 break;
2750 }
2751
2752 /*
2753 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002754 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002755 */
Tejun Heo6183c002013-03-12 11:29:57 -07002756 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2757 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002758
2759 list_del_init(&next->list);
2760 wq->first_flusher = next;
2761
Tejun Heo112202d2013-02-13 19:29:12 -08002762 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002763 break;
2764
2765 /*
2766 * Meh... this color is already done, clear first
2767 * flusher and repeat cascading.
2768 */
2769 wq->first_flusher = NULL;
2770 }
2771
2772out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002773 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002774}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002775EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002776
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002777/**
2778 * drain_workqueue - drain a workqueue
2779 * @wq: workqueue to drain
2780 *
2781 * Wait until the workqueue becomes empty. While draining is in progress,
2782 * only chain queueing is allowed. IOW, only currently pending or running
2783 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002784 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002785 * by the depth of chaining and should be relatively short. Whine if it
2786 * takes too long.
2787 */
2788void drain_workqueue(struct workqueue_struct *wq)
2789{
2790 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002791 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002792
2793 /*
2794 * __queue_work() needs to test whether there are drainers, is much
2795 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002796 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002797 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002798 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002799 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002800 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002801 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002802reflush:
2803 flush_workqueue(wq);
2804
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002805 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002806
Tejun Heo49e3cf42013-03-12 11:29:58 -07002807 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002808 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002809
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002810 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002811 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002812 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002813
2814 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002815 continue;
2816
2817 if (++flush_cnt == 10 ||
2818 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002819 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002820 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002821
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002822 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002823 goto reflush;
2824 }
2825
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002826 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002827 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002828 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002829}
2830EXPORT_SYMBOL_GPL(drain_workqueue);
2831
Tejun Heo606a5022012-08-20 14:51:23 -07002832static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002833{
2834 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002835 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002836 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002837
2838 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002839
Tejun Heofa1b54e2013-03-12 11:30:00 -07002840 local_irq_disable();
2841 pool = get_work_pool(work);
2842 if (!pool) {
2843 local_irq_enable();
2844 return false;
2845 }
2846
2847 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002848 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002849 pwq = get_work_pwq(work);
2850 if (pwq) {
2851 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002852 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002853 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002854 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002855 if (!worker)
2856 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002857 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002858 }
Tejun Heobaf59022010-09-16 10:42:16 +02002859
Tejun Heofca839c2015-12-07 10:58:57 -05002860 check_flush_dependency(pwq->wq, work);
2861
Tejun Heo112202d2013-02-13 19:29:12 -08002862 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002863 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002864
Tejun Heoe159489b2011-01-09 23:32:15 +01002865 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002866 * Force a lock recursion deadlock when using flush_work() inside a
2867 * single-threaded or rescuer equipped workqueue.
2868 *
2869 * For single threaded workqueues the deadlock happens when the work
2870 * is after the work issuing the flush_work(). For rescuer equipped
2871 * workqueues the deadlock happens when the rescuer stalls, blocking
2872 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01002873 */
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002874 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) {
Tejun Heo112202d2013-02-13 19:29:12 -08002875 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002876 lock_map_release(&pwq->wq->lockdep_map);
2877 }
Tejun Heoe159489b2011-01-09 23:32:15 +01002878
Tejun Heobaf59022010-09-16 10:42:16 +02002879 return true;
2880already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002881 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002882 return false;
2883}
2884
Oleg Nesterovdb700892008-07-25 01:47:49 -07002885/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002886 * flush_work - wait for a work to finish executing the last queueing instance
2887 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002888 *
Tejun Heo606a5022012-08-20 14:51:23 -07002889 * Wait until @work has finished execution. @work is guaranteed to be idle
2890 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002891 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002892 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002893 * %true if flush_work() waited for the work to finish execution,
2894 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002895 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002896bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002897{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002898 struct wq_barrier barr;
2899
Tejun Heo3347fa02016-09-16 15:49:32 -04002900 if (WARN_ON(!wq_online))
2901 return false;
2902
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002903 if (start_flush_work(work, &barr)) {
2904 wait_for_completion(&barr.done);
2905 destroy_work_on_stack(&barr.work);
2906 return true;
2907 } else {
2908 return false;
2909 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002910}
2911EXPORT_SYMBOL_GPL(flush_work);
2912
Tejun Heo8603e1b32015-03-05 08:04:13 -05002913struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02002914 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05002915 struct work_struct *work;
2916};
2917
Ingo Molnarac6424b2017-06-20 12:06:13 +02002918static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05002919{
2920 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2921
2922 if (cwait->work != key)
2923 return 0;
2924 return autoremove_wake_function(wait, mode, sync, key);
2925}
2926
Tejun Heo36e227d2012-08-03 10:30:46 -07002927static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002928{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002929 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002930 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002931 int ret;
2932
2933 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002934 ret = try_to_grab_pending(work, is_dwork, &flags);
2935 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002936 * If someone else is already canceling, wait for it to
2937 * finish. flush_work() doesn't work for PREEMPT_NONE
2938 * because we may get scheduled between @work's completion
2939 * and the other canceling task resuming and clearing
2940 * CANCELING - flush_work() will return false immediately
2941 * as @work is no longer busy, try_to_grab_pending() will
2942 * return -ENOENT as @work is still being canceled and the
2943 * other canceling task won't be able to clear CANCELING as
2944 * we're hogging the CPU.
2945 *
2946 * Let's wait for completion using a waitqueue. As this
2947 * may lead to the thundering herd problem, use a custom
2948 * wake function which matches @work along with exclusive
2949 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002950 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002951 if (unlikely(ret == -ENOENT)) {
2952 struct cwt_wait cwait;
2953
2954 init_wait(&cwait.wait);
2955 cwait.wait.func = cwt_wakefn;
2956 cwait.work = work;
2957
2958 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2959 TASK_UNINTERRUPTIBLE);
2960 if (work_is_canceling(work))
2961 schedule();
2962 finish_wait(&cancel_waitq, &cwait.wait);
2963 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002964 } while (unlikely(ret < 0));
2965
Tejun Heobbb68df2012-08-03 10:30:46 -07002966 /* tell other tasks trying to grab @work to back off */
2967 mark_work_canceling(work);
2968 local_irq_restore(flags);
2969
Tejun Heo3347fa02016-09-16 15:49:32 -04002970 /*
2971 * This allows canceling during early boot. We know that @work
2972 * isn't executing.
2973 */
2974 if (wq_online)
2975 flush_work(work);
2976
Tejun Heo7a22ad72010-06-29 10:07:13 +02002977 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002978
2979 /*
2980 * Paired with prepare_to_wait() above so that either
2981 * waitqueue_active() is visible here or !work_is_canceling() is
2982 * visible there.
2983 */
2984 smp_mb();
2985 if (waitqueue_active(&cancel_waitq))
2986 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2987
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002988 return ret;
2989}
2990
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002991/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002992 * cancel_work_sync - cancel a work and wait for it to finish
2993 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002994 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002995 * Cancel @work and wait for its execution to finish. This function
2996 * can be used even if the work re-queues itself or migrates to
2997 * another workqueue. On return from this function, @work is
2998 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002999 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003000 * cancel_work_sync(&delayed_work->work) must not be used for
3001 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003002 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003003 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003004 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003005 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003006 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003007 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003008 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003009bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003010{
Tejun Heo36e227d2012-08-03 10:30:46 -07003011 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003012}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003013EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003014
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003015/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003016 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3017 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003018 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003019 * Delayed timer is cancelled and the pending work is queued for
3020 * immediate execution. Like flush_work(), this function only
3021 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003022 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003023 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003024 * %true if flush_work() waited for the work to finish execution,
3025 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003026 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003027bool flush_delayed_work(struct delayed_work *dwork)
3028{
Tejun Heo8930cab2012-08-03 10:30:45 -07003029 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003030 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003031 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003032 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003033 return flush_work(&dwork->work);
3034}
3035EXPORT_SYMBOL(flush_delayed_work);
3036
Tejun Heo05f0fe62018-03-14 12:45:13 -07003037/**
3038 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3039 * @rwork: the rcu work to flush
3040 *
3041 * Return:
3042 * %true if flush_rcu_work() waited for the work to finish execution,
3043 * %false if it was already idle.
3044 */
3045bool flush_rcu_work(struct rcu_work *rwork)
3046{
3047 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3048 rcu_barrier();
3049 flush_work(&rwork->work);
3050 return true;
3051 } else {
3052 return flush_work(&rwork->work);
3053 }
3054}
3055EXPORT_SYMBOL(flush_rcu_work);
3056
Jens Axboef72b8792016-08-24 15:51:50 -06003057static bool __cancel_work(struct work_struct *work, bool is_dwork)
3058{
3059 unsigned long flags;
3060 int ret;
3061
3062 do {
3063 ret = try_to_grab_pending(work, is_dwork, &flags);
3064 } while (unlikely(ret == -EAGAIN));
3065
3066 if (unlikely(ret < 0))
3067 return false;
3068
3069 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3070 local_irq_restore(flags);
3071 return ret;
3072}
3073
3074/*
3075 * See cancel_delayed_work()
3076 */
3077bool cancel_work(struct work_struct *work)
3078{
3079 return __cancel_work(work, false);
3080}
3081
Tejun Heo401a8d02010-09-16 10:36:00 +02003082/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003083 * cancel_delayed_work - cancel a delayed work
3084 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003085 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003086 * Kill off a pending delayed_work.
3087 *
3088 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3089 * pending.
3090 *
3091 * Note:
3092 * The work callback function may still be running on return, unless
3093 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3094 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003095 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003096 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003097 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003098bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003099{
Jens Axboef72b8792016-08-24 15:51:50 -06003100 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003101}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003102EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003103
3104/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003105 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3106 * @dwork: the delayed work cancel
3107 *
3108 * This is cancel_work_sync() for delayed works.
3109 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003110 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003111 * %true if @dwork was pending, %false otherwise.
3112 */
3113bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003114{
Tejun Heo36e227d2012-08-03 10:30:46 -07003115 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003116}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003117EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003118
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003119/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003120 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003121 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003122 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003123 * schedule_on_each_cpu() executes @func on each online CPU using the
3124 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003125 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003126 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003127 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003128 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003129 */
David Howells65f27f32006-11-22 14:55:48 +00003130int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003131{
3132 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003133 struct work_struct __percpu *works;
Christoph Lameter15316ba82006-01-08 01:00:43 -08003134
Andrew Mortonb6136772006-06-25 05:47:49 -07003135 works = alloc_percpu(struct work_struct);
3136 if (!works)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003137 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003138
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003139 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003140
Christoph Lameter15316ba82006-01-08 01:00:43 -08003141 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003142 struct work_struct *work = per_cpu_ptr(works, cpu);
3143
3144 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003145 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003146 }
Tejun Heo93981802009-11-17 14:06:20 -08003147
3148 for_each_online_cpu(cpu)
3149 flush_work(per_cpu_ptr(works, cpu));
3150
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003151 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003152 free_percpu(works);
Christoph Lameter15316ba82006-01-08 01:00:43 -08003153 return 0;
3154}
3155
Alan Sterneef6a7d2010-02-12 17:39:21 +09003156/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003157 * execute_in_process_context - reliably execute the routine with user context
3158 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003159 * @ew: guaranteed storage for the execute work structure (must
3160 * be available when the work executes)
3161 *
3162 * Executes the function immediately if process context is available,
3163 * otherwise schedules the function for delayed execution.
3164 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003165 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003166 * 1 - function was scheduled for execution
3167 */
David Howells65f27f32006-11-22 14:55:48 +00003168int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003169{
3170 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003171 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003172 return 0;
3173 }
3174
David Howells65f27f32006-11-22 14:55:48 +00003175 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003176 schedule_work(&ew->work);
3177
3178 return 1;
3179}
3180EXPORT_SYMBOL_GPL(execute_in_process_context);
3181
Tejun Heo7a4e3442013-03-12 11:30:00 -07003182/**
3183 * free_workqueue_attrs - free a workqueue_attrs
3184 * @attrs: workqueue_attrs to free
3185 *
3186 * Undo alloc_workqueue_attrs().
3187 */
3188void free_workqueue_attrs(struct workqueue_attrs *attrs)
3189{
3190 if (attrs) {
3191 free_cpumask_var(attrs->cpumask);
3192 kfree(attrs);
3193 }
3194}
3195
3196/**
3197 * alloc_workqueue_attrs - allocate a workqueue_attrs
3198 * @gfp_mask: allocation mask to use
3199 *
3200 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003201 * return it.
3202 *
3203 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003204 */
3205struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3206{
3207 struct workqueue_attrs *attrs;
3208
3209 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3210 if (!attrs)
3211 goto fail;
3212 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3213 goto fail;
3214
Tejun Heo13e2e552013-04-01 11:23:31 -07003215 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003216 return attrs;
3217fail:
3218 free_workqueue_attrs(attrs);
3219 return NULL;
3220}
3221
Tejun Heo29c91e92013-03-12 11:30:03 -07003222static void copy_workqueue_attrs(struct workqueue_attrs *to,
3223 const struct workqueue_attrs *from)
3224{
3225 to->nice = from->nice;
3226 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003227 /*
3228 * Unlike hash and equality test, this function doesn't ignore
3229 * ->no_numa as it is used for both pool and wq attrs. Instead,
3230 * get_unbound_pool() explicitly clears ->no_numa after copying.
3231 */
3232 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003233}
3234
Tejun Heo29c91e92013-03-12 11:30:03 -07003235/* hash value of the content of @attr */
3236static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3237{
3238 u32 hash = 0;
3239
3240 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003241 hash = jhash(cpumask_bits(attrs->cpumask),
3242 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003243 return hash;
3244}
3245
3246/* content equality test */
3247static bool wqattrs_equal(const struct workqueue_attrs *a,
3248 const struct workqueue_attrs *b)
3249{
3250 if (a->nice != b->nice)
3251 return false;
3252 if (!cpumask_equal(a->cpumask, b->cpumask))
3253 return false;
3254 return true;
3255}
3256
Tejun Heo7a4e3442013-03-12 11:30:00 -07003257/**
3258 * init_worker_pool - initialize a newly zalloc'd worker_pool
3259 * @pool: worker_pool to initialize
3260 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303261 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003262 *
3263 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003264 * inside @pool proper are initialized and put_unbound_pool() can be called
3265 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003266 */
3267static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003268{
3269 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003270 pool->id = -1;
3271 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003272 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003273 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003274 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003275 INIT_LIST_HEAD(&pool->worklist);
3276 INIT_LIST_HEAD(&pool->idle_list);
3277 hash_init(pool->busy_hash);
3278
Kees Cook32a6c722017-10-16 15:58:25 -07003279 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003280
Kees Cook32a6c722017-10-16 15:58:25 -07003281 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003282
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003283 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003284 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003285
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003286 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003287 INIT_HLIST_NODE(&pool->hash_node);
3288 pool->refcnt = 1;
3289
3290 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003291 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3292 if (!pool->attrs)
3293 return -ENOMEM;
3294 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003295}
3296
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003297static void rcu_free_wq(struct rcu_head *rcu)
3298{
3299 struct workqueue_struct *wq =
3300 container_of(rcu, struct workqueue_struct, rcu);
3301
3302 if (!(wq->flags & WQ_UNBOUND))
3303 free_percpu(wq->cpu_pwqs);
3304 else
3305 free_workqueue_attrs(wq->unbound_attrs);
3306
3307 kfree(wq->rescuer);
3308 kfree(wq);
3309}
3310
Tejun Heo29c91e92013-03-12 11:30:03 -07003311static void rcu_free_pool(struct rcu_head *rcu)
3312{
3313 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3314
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003315 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003316 free_workqueue_attrs(pool->attrs);
3317 kfree(pool);
3318}
3319
3320/**
3321 * put_unbound_pool - put a worker_pool
3322 * @pool: worker_pool to put
3323 *
3324 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003325 * safe manner. get_unbound_pool() calls this function on its failure path
3326 * and this function should be able to release pools which went through,
3327 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003328 *
3329 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003330 */
3331static void put_unbound_pool(struct worker_pool *pool)
3332{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003333 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003334 struct worker *worker;
3335
Tejun Heoa892cac2013-04-01 11:23:32 -07003336 lockdep_assert_held(&wq_pool_mutex);
3337
3338 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003339 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003340
3341 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003342 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003343 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003344 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003345
3346 /* release id and unhash */
3347 if (pool->id >= 0)
3348 idr_remove(&worker_pool_idr, pool->id);
3349 hash_del(&pool->hash_node);
3350
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003351 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003352 * Become the manager and destroy all workers. This prevents
3353 * @pool's workers from blocking on attach_mutex. We're the last
3354 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003355 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003356 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003357 wait_event_lock_irq(wq_manager_wait,
3358 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3359 pool->flags |= POOL_MANAGER_ACTIVE;
3360
Lai Jiangshan1037de32014-05-22 16:44:07 +08003361 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003362 destroy_worker(worker);
3363 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003364 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003365
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003366 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003367 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003368 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003369 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003370
3371 if (pool->detach_completion)
3372 wait_for_completion(pool->detach_completion);
3373
Tejun Heo29c91e92013-03-12 11:30:03 -07003374 /* shut down the timers */
3375 del_timer_sync(&pool->idle_timer);
3376 del_timer_sync(&pool->mayday_timer);
3377
3378 /* sched-RCU protected to allow dereferences from get_work_pool() */
3379 call_rcu_sched(&pool->rcu, rcu_free_pool);
3380}
3381
3382/**
3383 * get_unbound_pool - get a worker_pool with the specified attributes
3384 * @attrs: the attributes of the worker_pool to get
3385 *
3386 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3387 * reference count and return it. If there already is a matching
3388 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003389 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003390 *
3391 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003392 *
3393 * Return: On success, a worker_pool with the same attributes as @attrs.
3394 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003395 */
3396static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3397{
Tejun Heo29c91e92013-03-12 11:30:03 -07003398 u32 hash = wqattrs_hash(attrs);
3399 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003400 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003401 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003402
Tejun Heoa892cac2013-04-01 11:23:32 -07003403 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003404
3405 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003406 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3407 if (wqattrs_equal(pool->attrs, attrs)) {
3408 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003409 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003410 }
3411 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003412
Xunlei Pange22735842015-10-09 11:53:12 +08003413 /* if cpumask is contained inside a NUMA node, we belong to that node */
3414 if (wq_numa_enabled) {
3415 for_each_node(node) {
3416 if (cpumask_subset(attrs->cpumask,
3417 wq_numa_possible_cpumask[node])) {
3418 target_node = node;
3419 break;
3420 }
3421 }
3422 }
3423
Tejun Heo29c91e92013-03-12 11:30:03 -07003424 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003425 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003426 if (!pool || init_worker_pool(pool) < 0)
3427 goto fail;
3428
Tejun Heo8864b4e2013-03-12 11:30:04 -07003429 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003430 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003431 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003432
Shaohua Li2865a8f2013-08-01 09:56:36 +08003433 /*
3434 * no_numa isn't a worker_pool attribute, always clear it. See
3435 * 'struct workqueue_attrs' comments for detail.
3436 */
3437 pool->attrs->no_numa = false;
3438
Tejun Heo29c91e92013-03-12 11:30:03 -07003439 if (worker_pool_assign_id(pool) < 0)
3440 goto fail;
3441
3442 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003443 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003444 goto fail;
3445
Tejun Heo29c91e92013-03-12 11:30:03 -07003446 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003447 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003448
Tejun Heo29c91e92013-03-12 11:30:03 -07003449 return pool;
3450fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003451 if (pool)
3452 put_unbound_pool(pool);
3453 return NULL;
3454}
3455
Tejun Heo8864b4e2013-03-12 11:30:04 -07003456static void rcu_free_pwq(struct rcu_head *rcu)
3457{
3458 kmem_cache_free(pwq_cache,
3459 container_of(rcu, struct pool_workqueue, rcu));
3460}
3461
3462/*
3463 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3464 * and needs to be destroyed.
3465 */
3466static void pwq_unbound_release_workfn(struct work_struct *work)
3467{
3468 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3469 unbound_release_work);
3470 struct workqueue_struct *wq = pwq->wq;
3471 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003472 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003473
3474 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3475 return;
3476
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003477 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003478 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003479 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003480 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003481
Tejun Heoa892cac2013-04-01 11:23:32 -07003482 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003483 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003484 mutex_unlock(&wq_pool_mutex);
3485
Tejun Heo8864b4e2013-03-12 11:30:04 -07003486 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3487
3488 /*
3489 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003490 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003491 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003492 if (is_last)
3493 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003494}
3495
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003496/**
Tejun Heo699ce092013-03-13 16:51:35 -07003497 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003498 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003499 *
Tejun Heo699ce092013-03-13 16:51:35 -07003500 * If @pwq isn't freezing, set @pwq->max_active to the associated
3501 * workqueue's saved_max_active and activate delayed work items
3502 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003503 */
Tejun Heo699ce092013-03-13 16:51:35 -07003504static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003505{
Tejun Heo699ce092013-03-13 16:51:35 -07003506 struct workqueue_struct *wq = pwq->wq;
3507 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003508 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003509
Tejun Heo699ce092013-03-13 16:51:35 -07003510 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003511 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003512
3513 /* fast exit for non-freezable wqs */
3514 if (!freezable && pwq->max_active == wq->saved_max_active)
3515 return;
3516
Tejun Heo3347fa02016-09-16 15:49:32 -04003517 /* this function can be called during early boot w/ irq disabled */
3518 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003519
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003520 /*
3521 * During [un]freezing, the caller is responsible for ensuring that
3522 * this function is called at least once after @workqueue_freezing
3523 * is updated and visible.
3524 */
3525 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003526 pwq->max_active = wq->saved_max_active;
3527
3528 while (!list_empty(&pwq->delayed_works) &&
3529 pwq->nr_active < pwq->max_active)
3530 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003531
3532 /*
3533 * Need to kick a worker after thawed or an unbound wq's
3534 * max_active is bumped. It's a slow path. Do it always.
3535 */
3536 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003537 } else {
3538 pwq->max_active = 0;
3539 }
3540
Tejun Heo3347fa02016-09-16 15:49:32 -04003541 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003542}
3543
Tejun Heoe50aba92013-04-01 11:23:35 -07003544/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003545static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3546 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003547{
3548 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3549
Tejun Heoe50aba92013-04-01 11:23:35 -07003550 memset(pwq, 0, sizeof(*pwq));
3551
Tejun Heod2c1d402013-03-12 11:30:04 -07003552 pwq->pool = pool;
3553 pwq->wq = wq;
3554 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003555 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003556 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003557 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003558 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003559 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003560}
Tejun Heod2c1d402013-03-12 11:30:04 -07003561
Tejun Heof147f292013-04-01 11:23:35 -07003562/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003563static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003564{
3565 struct workqueue_struct *wq = pwq->wq;
3566
3567 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003568
Tejun Heo1befcf32013-04-01 11:23:35 -07003569 /* may be called multiple times, ignore if already linked */
3570 if (!list_empty(&pwq->pwqs_node))
3571 return;
3572
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003573 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003574 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003575
3576 /* sync max_active to the current setting */
3577 pwq_adjust_max_active(pwq);
3578
3579 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003580 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003581}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003582
Tejun Heof147f292013-04-01 11:23:35 -07003583/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3584static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3585 const struct workqueue_attrs *attrs)
3586{
3587 struct worker_pool *pool;
3588 struct pool_workqueue *pwq;
3589
3590 lockdep_assert_held(&wq_pool_mutex);
3591
3592 pool = get_unbound_pool(attrs);
3593 if (!pool)
3594 return NULL;
3595
Tejun Heoe50aba92013-04-01 11:23:35 -07003596 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003597 if (!pwq) {
3598 put_unbound_pool(pool);
3599 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003600 }
Tejun Heo6029a912013-04-01 11:23:34 -07003601
Tejun Heof147f292013-04-01 11:23:35 -07003602 init_pwq(pwq, wq, pool);
3603 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003604}
3605
Tejun Heo4c16bd32013-04-01 11:23:36 -07003606/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003607 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003608 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003609 * @node: the target NUMA node
3610 * @cpu_going_down: if >= 0, the CPU to consider as offline
3611 * @cpumask: outarg, the resulting cpumask
3612 *
3613 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3614 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003615 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003616 *
3617 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3618 * enabled and @node has online CPUs requested by @attrs, the returned
3619 * cpumask is the intersection of the possible CPUs of @node and
3620 * @attrs->cpumask.
3621 *
3622 * The caller is responsible for ensuring that the cpumask of @node stays
3623 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003624 *
3625 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3626 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003627 */
3628static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3629 int cpu_going_down, cpumask_t *cpumask)
3630{
Tejun Heod55262c2013-04-01 11:23:38 -07003631 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003632 goto use_dfl;
3633
3634 /* does @node have any online CPUs @attrs wants? */
3635 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3636 if (cpu_going_down >= 0)
3637 cpumask_clear_cpu(cpu_going_down, cpumask);
3638
3639 if (cpumask_empty(cpumask))
3640 goto use_dfl;
3641
3642 /* yeap, return possible CPUs in @node that @attrs wants */
3643 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003644
3645 if (cpumask_empty(cpumask)) {
3646 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3647 "possible intersect\n");
3648 return false;
3649 }
3650
Tejun Heo4c16bd32013-04-01 11:23:36 -07003651 return !cpumask_equal(cpumask, attrs->cpumask);
3652
3653use_dfl:
3654 cpumask_copy(cpumask, attrs->cpumask);
3655 return false;
3656}
3657
Tejun Heo1befcf32013-04-01 11:23:35 -07003658/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3659static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3660 int node,
3661 struct pool_workqueue *pwq)
3662{
3663 struct pool_workqueue *old_pwq;
3664
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003665 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003666 lockdep_assert_held(&wq->mutex);
3667
3668 /* link_pwq() can handle duplicate calls */
3669 link_pwq(pwq);
3670
3671 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3672 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3673 return old_pwq;
3674}
3675
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003676/* context to store the prepared attrs & pwqs before applying */
3677struct apply_wqattrs_ctx {
3678 struct workqueue_struct *wq; /* target workqueue */
3679 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003680 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003681 struct pool_workqueue *dfl_pwq;
3682 struct pool_workqueue *pwq_tbl[];
3683};
3684
3685/* free the resources after success or abort */
3686static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3687{
3688 if (ctx) {
3689 int node;
3690
3691 for_each_node(node)
3692 put_pwq_unlocked(ctx->pwq_tbl[node]);
3693 put_pwq_unlocked(ctx->dfl_pwq);
3694
3695 free_workqueue_attrs(ctx->attrs);
3696
3697 kfree(ctx);
3698 }
3699}
3700
3701/* allocate the attrs and pwqs for later installation */
3702static struct apply_wqattrs_ctx *
3703apply_wqattrs_prepare(struct workqueue_struct *wq,
3704 const struct workqueue_attrs *attrs)
3705{
3706 struct apply_wqattrs_ctx *ctx;
3707 struct workqueue_attrs *new_attrs, *tmp_attrs;
3708 int node;
3709
3710 lockdep_assert_held(&wq_pool_mutex);
3711
3712 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3713 GFP_KERNEL);
3714
3715 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3716 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3717 if (!ctx || !new_attrs || !tmp_attrs)
3718 goto out_free;
3719
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003720 /*
3721 * Calculate the attrs of the default pwq.
3722 * If the user configured cpumask doesn't overlap with the
3723 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3724 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003725 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003726 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003727 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3728 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003729
3730 /*
3731 * We may create multiple pwqs with differing cpumasks. Make a
3732 * copy of @new_attrs which will be modified and used to obtain
3733 * pools.
3734 */
3735 copy_workqueue_attrs(tmp_attrs, new_attrs);
3736
3737 /*
3738 * If something goes wrong during CPU up/down, we'll fall back to
3739 * the default pwq covering whole @attrs->cpumask. Always create
3740 * it even if we don't use it immediately.
3741 */
3742 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3743 if (!ctx->dfl_pwq)
3744 goto out_free;
3745
3746 for_each_node(node) {
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003747 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003748 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3749 if (!ctx->pwq_tbl[node])
3750 goto out_free;
3751 } else {
3752 ctx->dfl_pwq->refcnt++;
3753 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3754 }
3755 }
3756
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003757 /* save the user configured attrs and sanitize it. */
3758 copy_workqueue_attrs(new_attrs, attrs);
3759 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003760 ctx->attrs = new_attrs;
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003761
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003762 ctx->wq = wq;
3763 free_workqueue_attrs(tmp_attrs);
3764 return ctx;
3765
3766out_free:
3767 free_workqueue_attrs(tmp_attrs);
3768 free_workqueue_attrs(new_attrs);
3769 apply_wqattrs_cleanup(ctx);
3770 return NULL;
3771}
3772
3773/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3774static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3775{
3776 int node;
3777
3778 /* all pwqs have been created successfully, let's install'em */
3779 mutex_lock(&ctx->wq->mutex);
3780
3781 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3782
3783 /* save the previous pwq and install the new one */
3784 for_each_node(node)
3785 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3786 ctx->pwq_tbl[node]);
3787
3788 /* @dfl_pwq might not have been used, ensure it's linked */
3789 link_pwq(ctx->dfl_pwq);
3790 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3791
3792 mutex_unlock(&ctx->wq->mutex);
3793}
3794
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003795static void apply_wqattrs_lock(void)
3796{
3797 /* CPUs should stay stable across pwq creations and installations */
3798 get_online_cpus();
3799 mutex_lock(&wq_pool_mutex);
3800}
3801
3802static void apply_wqattrs_unlock(void)
3803{
3804 mutex_unlock(&wq_pool_mutex);
3805 put_online_cpus();
3806}
3807
3808static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3809 const struct workqueue_attrs *attrs)
3810{
3811 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003812
3813 /* only unbound workqueues can change attributes */
3814 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3815 return -EINVAL;
3816
3817 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04003818 if (!list_empty(&wq->pwqs)) {
3819 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3820 return -EINVAL;
3821
3822 wq->flags &= ~__WQ_ORDERED;
3823 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003824
3825 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003826 if (!ctx)
3827 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003828
3829 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003830 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003831 apply_wqattrs_cleanup(ctx);
3832
wanghaibin62011712016-01-07 20:38:59 +08003833 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003834}
3835
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003836/**
3837 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3838 * @wq: the target workqueue
3839 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3840 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003841 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3842 * machines, this function maps a separate pwq to each NUMA node with
3843 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3844 * NUMA node it was issued on. Older pwqs are released as in-flight work
3845 * items finish. Note that a work item which repeatedly requeues itself
3846 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003847 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003848 * Performs GFP_KERNEL allocations.
3849 *
3850 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003851 */
3852int apply_workqueue_attrs(struct workqueue_struct *wq,
3853 const struct workqueue_attrs *attrs)
3854{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003855 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003856
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003857 apply_wqattrs_lock();
3858 ret = apply_workqueue_attrs_locked(wq, attrs);
3859 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003860
Tejun Heo48621252013-04-01 11:23:31 -07003861 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003862}
NeilBrown6106c0f2018-01-11 15:06:40 +11003863EXPORT_SYMBOL_GPL(apply_workqueue_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003864
Tejun Heo4c16bd32013-04-01 11:23:36 -07003865/**
3866 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3867 * @wq: the target workqueue
3868 * @cpu: the CPU coming up or going down
3869 * @online: whether @cpu is coming up or going down
3870 *
3871 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3872 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3873 * @wq accordingly.
3874 *
3875 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3876 * falls back to @wq->dfl_pwq which may not be optimal but is always
3877 * correct.
3878 *
3879 * Note that when the last allowed CPU of a NUMA node goes offline for a
3880 * workqueue with a cpumask spanning multiple nodes, the workers which were
3881 * already executing the work items for the workqueue will lose their CPU
3882 * affinity and may execute on any CPU. This is similar to how per-cpu
3883 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3884 * affinity, it's the user's responsibility to flush the work item from
3885 * CPU_DOWN_PREPARE.
3886 */
3887static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3888 bool online)
3889{
3890 int node = cpu_to_node(cpu);
3891 int cpu_off = online ? -1 : cpu;
3892 struct pool_workqueue *old_pwq = NULL, *pwq;
3893 struct workqueue_attrs *target_attrs;
3894 cpumask_t *cpumask;
3895
3896 lockdep_assert_held(&wq_pool_mutex);
3897
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003898 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3899 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003900 return;
3901
3902 /*
3903 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3904 * Let's use a preallocated one. The following buf is protected by
3905 * CPU hotplug exclusion.
3906 */
3907 target_attrs = wq_update_unbound_numa_attrs_buf;
3908 cpumask = target_attrs->cpumask;
3909
Tejun Heo4c16bd32013-04-01 11:23:36 -07003910 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3911 pwq = unbound_pwq_by_node(wq, node);
3912
3913 /*
3914 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003915 * different from the default pwq's, we need to compare it to @pwq's
3916 * and create a new one if they don't match. If the target cpumask
3917 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003918 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003919 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003920 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003921 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003922 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003923 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003924 }
3925
Tejun Heo4c16bd32013-04-01 11:23:36 -07003926 /* create a new pwq */
3927 pwq = alloc_unbound_pwq(wq, target_attrs);
3928 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003929 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3930 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003931 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003932 }
3933
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003934 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003935 mutex_lock(&wq->mutex);
3936 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3937 goto out_unlock;
3938
3939use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003940 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003941 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3942 get_pwq(wq->dfl_pwq);
3943 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3944 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3945out_unlock:
3946 mutex_unlock(&wq->mutex);
3947 put_pwq_unlocked(old_pwq);
3948}
3949
Tejun Heo30cdf2492013-03-12 11:29:57 -07003950static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003951{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003952 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003953 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003954
Tejun Heo30cdf2492013-03-12 11:29:57 -07003955 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003956 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3957 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07003958 return -ENOMEM;
3959
3960 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003961 struct pool_workqueue *pwq =
3962 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003963 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003964 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003965
Tejun Heof147f292013-04-01 11:23:35 -07003966 init_pwq(pwq, wq, &cpu_pools[highpri]);
3967
3968 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003969 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003970 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003971 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003972 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003973 } else if (wq->flags & __WQ_ORDERED) {
3974 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3975 /* there should only be single pwq for ordering guarantee */
3976 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3977 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3978 "ordering guarantee broken for workqueue %s\n", wq->name);
3979 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07003980 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003981 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003982 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003983}
3984
Tejun Heof3421792010-07-02 10:03:51 +02003985static int wq_clamp_max_active(int max_active, unsigned int flags,
3986 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003987{
Tejun Heof3421792010-07-02 10:03:51 +02003988 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3989
3990 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003991 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3992 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003993
Tejun Heof3421792010-07-02 10:03:51 +02003994 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003995}
3996
Tejun Heo983c7512018-01-08 05:38:32 -08003997/*
3998 * Workqueues which may be used during memory reclaim should have a rescuer
3999 * to guarantee forward progress.
4000 */
4001static int init_rescuer(struct workqueue_struct *wq)
4002{
4003 struct worker *rescuer;
4004 int ret;
4005
4006 if (!(wq->flags & WQ_MEM_RECLAIM))
4007 return 0;
4008
4009 rescuer = alloc_worker(NUMA_NO_NODE);
4010 if (!rescuer)
4011 return -ENOMEM;
4012
4013 rescuer->rescue_wq = wq;
4014 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4015 ret = PTR_ERR_OR_ZERO(rescuer->task);
4016 if (ret) {
4017 kfree(rescuer);
4018 return ret;
4019 }
4020
4021 wq->rescuer = rescuer;
4022 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4023 wake_up_process(rescuer->task);
4024
4025 return 0;
4026}
4027
Tejun Heob196be82012-01-10 15:11:35 -08004028struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02004029 unsigned int flags,
4030 int max_active,
4031 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08004032 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004033{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004034 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004035 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004036 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004037 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004038
Tejun Heo5c0338c2017-07-18 18:41:52 -04004039 /*
4040 * Unbound && max_active == 1 used to imply ordered, which is no
4041 * longer the case on NUMA machines due to per-node pools. While
4042 * alloc_ordered_workqueue() is the right way to create an ordered
4043 * workqueue, keep the previous behavior to avoid subtle breakages
4044 * on NUMA.
4045 */
4046 if ((flags & WQ_UNBOUND) && max_active == 1)
4047 flags |= __WQ_ORDERED;
4048
Viresh Kumarcee22a12013-04-08 16:45:40 +05304049 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4050 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4051 flags |= WQ_UNBOUND;
4052
Tejun Heoecf68812013-04-01 11:23:34 -07004053 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004054 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004055 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004056
4057 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004058 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004059 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004060
Tejun Heo6029a912013-04-01 11:23:34 -07004061 if (flags & WQ_UNBOUND) {
4062 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4063 if (!wq->unbound_attrs)
4064 goto err_free_wq;
4065 }
4066
Tejun Heoecf68812013-04-01 11:23:34 -07004067 va_start(args, lock_name);
4068 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004069 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004070
Tejun Heod320c032010-06-29 10:07:14 +02004071 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004072 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004073
Tejun Heob196be82012-01-10 15:11:35 -08004074 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004075 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004076 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004077 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004078 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004079 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004080 INIT_LIST_HEAD(&wq->flusher_queue);
4081 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004082 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004083
Johannes Bergeb13ba82008-01-16 09:51:58 +01004084 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004085 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004086
Tejun Heo30cdf2492013-03-12 11:29:57 -07004087 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004088 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004089
Tejun Heo40c17f72018-01-08 05:38:37 -08004090 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004091 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004092
Tejun Heo226223a2013-03-12 11:30:05 -07004093 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4094 goto err_destroy;
4095
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004096 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004097 * wq_pool_mutex protects global freeze state and workqueues list.
4098 * Grab it, adjust max_active and add the new @wq to workqueues
4099 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004100 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004101 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004102
Lai Jiangshana357fc02013-03-25 16:57:19 -07004103 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004104 for_each_pwq(pwq, wq)
4105 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004106 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004107
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004108 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004109
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004110 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004111
Oleg Nesterov3af244332007-05-09 02:34:09 -07004112 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004113
4114err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004115 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004116 kfree(wq);
4117 return NULL;
4118err_destroy:
4119 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004120 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004121}
Tejun Heod320c032010-06-29 10:07:14 +02004122EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004123
4124/**
4125 * destroy_workqueue - safely terminate a workqueue
4126 * @wq: target workqueue
4127 *
4128 * Safely destroy a workqueue. All work currently pending will be done first.
4129 */
4130void destroy_workqueue(struct workqueue_struct *wq)
4131{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004132 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004133 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004134
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004135 /* drain it before proceeding with destruction */
4136 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004137
Tejun Heo6183c002013-03-12 11:29:57 -07004138 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004139 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004140 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004141 int i;
4142
Tejun Heo76af4d92013-03-12 11:30:00 -07004143 for (i = 0; i < WORK_NR_COLORS; i++) {
4144 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004145 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004146 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004147 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004148 }
4149 }
4150
Lai Jiangshan5c529592013-04-04 10:05:38 +08004151 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004152 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004153 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004154 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004155 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004156 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004157 }
Tejun Heo6183c002013-03-12 11:29:57 -07004158 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004159 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004160
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004161 /*
4162 * wq list is used to freeze wq, remove from list after
4163 * flushing is complete in case freeze races us.
4164 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004165 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004166 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004167 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004168
Tejun Heo226223a2013-03-12 11:30:05 -07004169 workqueue_sysfs_unregister(wq);
4170
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004171 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004172 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004173
Tejun Heo8864b4e2013-03-12 11:30:04 -07004174 if (!(wq->flags & WQ_UNBOUND)) {
4175 /*
4176 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004177 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004178 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004179 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004180 } else {
4181 /*
4182 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004183 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4184 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004185 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004186 for_each_node(node) {
4187 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4188 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4189 put_pwq_unlocked(pwq);
4190 }
4191
4192 /*
4193 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4194 * put. Don't access it afterwards.
4195 */
4196 pwq = wq->dfl_pwq;
4197 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004198 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004199 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004200}
4201EXPORT_SYMBOL_GPL(destroy_workqueue);
4202
Tejun Heodcd989c2010-06-29 10:07:14 +02004203/**
4204 * workqueue_set_max_active - adjust max_active of a workqueue
4205 * @wq: target workqueue
4206 * @max_active: new max_active value.
4207 *
4208 * Set max_active of @wq to @max_active.
4209 *
4210 * CONTEXT:
4211 * Don't call from IRQ context.
4212 */
4213void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4214{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004215 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004216
Tejun Heo8719dce2013-03-12 11:30:04 -07004217 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004218 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004219 return;
4220
Tejun Heof3421792010-07-02 10:03:51 +02004221 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004222
Lai Jiangshana357fc02013-03-25 16:57:19 -07004223 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004224
Tejun Heo0a94efb2017-07-23 08:36:15 -04004225 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004226 wq->saved_max_active = max_active;
4227
Tejun Heo699ce092013-03-13 16:51:35 -07004228 for_each_pwq(pwq, wq)
4229 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004230
Lai Jiangshana357fc02013-03-25 16:57:19 -07004231 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004232}
4233EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4234
4235/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004236 * current_work - retrieve %current task's work struct
4237 *
4238 * Determine if %current task is a workqueue worker and what it's working on.
4239 * Useful to find out the context that the %current task is running in.
4240 *
4241 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4242 */
4243struct work_struct *current_work(void)
4244{
4245 struct worker *worker = current_wq_worker();
4246
4247 return worker ? worker->current_work : NULL;
4248}
4249EXPORT_SYMBOL(current_work);
4250
4251/**
Tejun Heoe62676162013-03-12 17:41:37 -07004252 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4253 *
4254 * Determine whether %current is a workqueue rescuer. Can be used from
4255 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004256 *
4257 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004258 */
4259bool current_is_workqueue_rescuer(void)
4260{
4261 struct worker *worker = current_wq_worker();
4262
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004263 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004264}
4265
4266/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004267 * workqueue_congested - test whether a workqueue is congested
4268 * @cpu: CPU in question
4269 * @wq: target workqueue
4270 *
4271 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4272 * no synchronization around this function and the test result is
4273 * unreliable and only useful as advisory hints or for debugging.
4274 *
Tejun Heod3251852013-05-10 11:10:17 -07004275 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4276 * Note that both per-cpu and unbound workqueues may be associated with
4277 * multiple pool_workqueues which have separate congested states. A
4278 * workqueue being congested on one CPU doesn't mean the workqueue is also
4279 * contested on other CPUs / NUMA nodes.
4280 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004281 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004282 * %true if congested, %false otherwise.
4283 */
Tejun Heod84ff052013-03-12 11:29:59 -07004284bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004285{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004286 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004287 bool ret;
4288
Lai Jiangshan88109452013-03-20 03:28:10 +08004289 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004290
Tejun Heod3251852013-05-10 11:10:17 -07004291 if (cpu == WORK_CPU_UNBOUND)
4292 cpu = smp_processor_id();
4293
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004294 if (!(wq->flags & WQ_UNBOUND))
4295 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4296 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004297 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004298
Tejun Heo76af4d92013-03-12 11:30:00 -07004299 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004300 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004301
4302 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004303}
4304EXPORT_SYMBOL_GPL(workqueue_congested);
4305
4306/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004307 * work_busy - test whether a work is currently pending or running
4308 * @work: the work to be tested
4309 *
4310 * Test whether @work is currently pending or running. There is no
4311 * synchronization around this function and the test result is
4312 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004313 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004314 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004315 * OR'd bitmask of WORK_BUSY_* bits.
4316 */
4317unsigned int work_busy(struct work_struct *work)
4318{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004319 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004320 unsigned long flags;
4321 unsigned int ret = 0;
4322
Tejun Heodcd989c2010-06-29 10:07:14 +02004323 if (work_pending(work))
4324 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004325
Tejun Heofa1b54e2013-03-12 11:30:00 -07004326 local_irq_save(flags);
4327 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004328 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004329 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004330 if (find_worker_executing_work(pool, work))
4331 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004332 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004333 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004334 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004335
4336 return ret;
4337}
4338EXPORT_SYMBOL_GPL(work_busy);
4339
Tejun Heo3d1cb202013-04-30 15:27:22 -07004340/**
4341 * set_worker_desc - set description for the current work item
4342 * @fmt: printf-style format string
4343 * @...: arguments for the format string
4344 *
4345 * This function can be called by a running work function to describe what
4346 * the work item is about. If the worker task gets dumped, this
4347 * information will be printed out together to help debugging. The
4348 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4349 */
4350void set_worker_desc(const char *fmt, ...)
4351{
4352 struct worker *worker = current_wq_worker();
4353 va_list args;
4354
4355 if (worker) {
4356 va_start(args, fmt);
4357 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4358 va_end(args);
4359 worker->desc_valid = true;
4360 }
4361}
4362
4363/**
4364 * print_worker_info - print out worker information and description
4365 * @log_lvl: the log level to use when printing
4366 * @task: target task
4367 *
4368 * If @task is a worker and currently executing a work item, print out the
4369 * name of the workqueue being serviced and worker description set with
4370 * set_worker_desc() by the currently executing work item.
4371 *
4372 * This function can be safely called on any task as long as the
4373 * task_struct itself is accessible. While safe, this function isn't
4374 * synchronized and may print out mixups or garbages of limited length.
4375 */
4376void print_worker_info(const char *log_lvl, struct task_struct *task)
4377{
4378 work_func_t *fn = NULL;
4379 char name[WQ_NAME_LEN] = { };
4380 char desc[WORKER_DESC_LEN] = { };
4381 struct pool_workqueue *pwq = NULL;
4382 struct workqueue_struct *wq = NULL;
4383 bool desc_valid = false;
4384 struct worker *worker;
4385
4386 if (!(task->flags & PF_WQ_WORKER))
4387 return;
4388
4389 /*
4390 * This function is called without any synchronization and @task
4391 * could be in any state. Be careful with dereferences.
4392 */
Petr Mladeke7005912016-10-11 13:55:17 -07004393 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004394
4395 /*
4396 * Carefully copy the associated workqueue's workfn and name. Keep
4397 * the original last '\0' in case the original contains garbage.
4398 */
4399 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4400 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4401 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4402 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4403
4404 /* copy worker description */
4405 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4406 if (desc_valid)
4407 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4408
4409 if (fn || name[0] || desc[0]) {
4410 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4411 if (desc[0])
4412 pr_cont(" (%s)", desc);
4413 pr_cont("\n");
4414 }
4415}
4416
Tejun Heo3494fc32015-03-09 09:22:28 -04004417static void pr_cont_pool_info(struct worker_pool *pool)
4418{
4419 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4420 if (pool->node != NUMA_NO_NODE)
4421 pr_cont(" node=%d", pool->node);
4422 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4423}
4424
4425static void pr_cont_work(bool comma, struct work_struct *work)
4426{
4427 if (work->func == wq_barrier_func) {
4428 struct wq_barrier *barr;
4429
4430 barr = container_of(work, struct wq_barrier, work);
4431
4432 pr_cont("%s BAR(%d)", comma ? "," : "",
4433 task_pid_nr(barr->task));
4434 } else {
4435 pr_cont("%s %pf", comma ? "," : "", work->func);
4436 }
4437}
4438
4439static void show_pwq(struct pool_workqueue *pwq)
4440{
4441 struct worker_pool *pool = pwq->pool;
4442 struct work_struct *work;
4443 struct worker *worker;
4444 bool has_in_flight = false, has_pending = false;
4445 int bkt;
4446
4447 pr_info(" pwq %d:", pool->id);
4448 pr_cont_pool_info(pool);
4449
4450 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4451 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4452
4453 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4454 if (worker->current_pwq == pwq) {
4455 has_in_flight = true;
4456 break;
4457 }
4458 }
4459 if (has_in_flight) {
4460 bool comma = false;
4461
4462 pr_info(" in-flight:");
4463 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4464 if (worker->current_pwq != pwq)
4465 continue;
4466
4467 pr_cont("%s %d%s:%pf", comma ? "," : "",
4468 task_pid_nr(worker->task),
4469 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4470 worker->current_func);
4471 list_for_each_entry(work, &worker->scheduled, entry)
4472 pr_cont_work(false, work);
4473 comma = true;
4474 }
4475 pr_cont("\n");
4476 }
4477
4478 list_for_each_entry(work, &pool->worklist, entry) {
4479 if (get_work_pwq(work) == pwq) {
4480 has_pending = true;
4481 break;
4482 }
4483 }
4484 if (has_pending) {
4485 bool comma = false;
4486
4487 pr_info(" pending:");
4488 list_for_each_entry(work, &pool->worklist, entry) {
4489 if (get_work_pwq(work) != pwq)
4490 continue;
4491
4492 pr_cont_work(comma, work);
4493 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4494 }
4495 pr_cont("\n");
4496 }
4497
4498 if (!list_empty(&pwq->delayed_works)) {
4499 bool comma = false;
4500
4501 pr_info(" delayed:");
4502 list_for_each_entry(work, &pwq->delayed_works, entry) {
4503 pr_cont_work(comma, work);
4504 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4505 }
4506 pr_cont("\n");
4507 }
4508}
4509
4510/**
4511 * show_workqueue_state - dump workqueue state
4512 *
Roger Lu7b776af2016-07-01 11:05:02 +08004513 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4514 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004515 */
4516void show_workqueue_state(void)
4517{
4518 struct workqueue_struct *wq;
4519 struct worker_pool *pool;
4520 unsigned long flags;
4521 int pi;
4522
4523 rcu_read_lock_sched();
4524
4525 pr_info("Showing busy workqueues and worker pools:\n");
4526
4527 list_for_each_entry_rcu(wq, &workqueues, list) {
4528 struct pool_workqueue *pwq;
4529 bool idle = true;
4530
4531 for_each_pwq(pwq, wq) {
4532 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4533 idle = false;
4534 break;
4535 }
4536 }
4537 if (idle)
4538 continue;
4539
4540 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4541
4542 for_each_pwq(pwq, wq) {
4543 spin_lock_irqsave(&pwq->pool->lock, flags);
4544 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4545 show_pwq(pwq);
4546 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004547 /*
4548 * We could be printing a lot from atomic context, e.g.
4549 * sysrq-t -> show_workqueue_state(). Avoid triggering
4550 * hard lockup.
4551 */
4552 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004553 }
4554 }
4555
4556 for_each_pool(pool, pi) {
4557 struct worker *worker;
4558 bool first = true;
4559
4560 spin_lock_irqsave(&pool->lock, flags);
4561 if (pool->nr_workers == pool->nr_idle)
4562 goto next_pool;
4563
4564 pr_info("pool %d:", pool->id);
4565 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004566 pr_cont(" hung=%us workers=%d",
4567 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4568 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004569 if (pool->manager)
4570 pr_cont(" manager: %d",
4571 task_pid_nr(pool->manager->task));
4572 list_for_each_entry(worker, &pool->idle_list, entry) {
4573 pr_cont(" %s%d", first ? "idle: " : "",
4574 task_pid_nr(worker->task));
4575 first = false;
4576 }
4577 pr_cont("\n");
4578 next_pool:
4579 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004580 /*
4581 * We could be printing a lot from atomic context, e.g.
4582 * sysrq-t -> show_workqueue_state(). Avoid triggering
4583 * hard lockup.
4584 */
4585 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004586 }
4587
4588 rcu_read_unlock_sched();
4589}
4590
Tejun Heodb7bccf2010-06-29 10:07:12 +02004591/*
4592 * CPU hotplug.
4593 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004594 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004595 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004596 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004597 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004598 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004599 * blocked draining impractical.
4600 *
Tejun Heo24647572013-01-24 11:01:33 -08004601 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004602 * running as an unbound one and allowing it to be reattached later if the
4603 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004604 */
4605
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004606static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004607{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004608 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004609 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004610
Tejun Heof02ae732013-03-12 11:30:03 -07004611 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004612 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004613 spin_lock_irq(&pool->lock);
4614
4615 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004616 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004617 * unbound and set DISASSOCIATED. Before this, all workers
4618 * except for the ones which are still executing works from
4619 * before the last CPU down must be on the cpu. After
4620 * this, they may become diasporas.
4621 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004622 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004623 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004624
Tejun Heo24647572013-01-24 11:01:33 -08004625 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004626
Tejun Heo94cf58b2013-01-24 11:01:33 -08004627 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004628 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004629
Lai Jiangshaneb283422013-03-08 15:18:28 -08004630 /*
4631 * Call schedule() so that we cross rq->lock and thus can
4632 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4633 * This is necessary as scheduler callbacks may be invoked
4634 * from other cpus.
4635 */
4636 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004637
Lai Jiangshaneb283422013-03-08 15:18:28 -08004638 /*
4639 * Sched callbacks are disabled now. Zap nr_running.
4640 * After this, nr_running stays zero and need_more_worker()
4641 * and keep_working() are always true as long as the
4642 * worklist is not empty. This pool now behaves as an
4643 * unbound (in terms of concurrency management) pool which
4644 * are served by workers tied to the pool.
4645 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004646 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004647
4648 /*
4649 * With concurrency management just turned off, a busy
4650 * worker blocking could lead to lengthy stalls. Kick off
4651 * unbound chain execution of currently pending work items.
4652 */
4653 spin_lock_irq(&pool->lock);
4654 wake_up_worker(pool);
4655 spin_unlock_irq(&pool->lock);
4656 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004657}
4658
Tejun Heobd7c0892013-03-19 13:45:21 -07004659/**
4660 * rebind_workers - rebind all workers of a pool to the associated CPU
4661 * @pool: pool of interest
4662 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004663 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004664 */
4665static void rebind_workers(struct worker_pool *pool)
4666{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004667 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004668
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004669 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004670
Tejun Heoa9ab7752013-03-19 13:45:21 -07004671 /*
4672 * Restore CPU affinity of all workers. As all idle workers should
4673 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304674 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004675 * of all workers first and then clear UNBOUND. As we're called
4676 * from CPU_ONLINE, the following shouldn't fail.
4677 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004678 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004679 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4680 pool->attrs->cpumask) < 0);
4681
4682 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004683
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004684 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004685
Lai Jiangshanda028462014-05-20 17:46:31 +08004686 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004687 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004688
4689 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004690 * A bound idle worker should actually be on the runqueue
4691 * of the associated CPU for local wake-ups targeting it to
4692 * work. Kick all idle workers so that they migrate to the
4693 * associated CPU. Doing this in the same loop as
4694 * replacing UNBOUND with REBOUND is safe as no worker will
4695 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004696 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004697 if (worker_flags & WORKER_IDLE)
4698 wake_up_process(worker->task);
4699
4700 /*
4701 * We want to clear UNBOUND but can't directly call
4702 * worker_clr_flags() or adjust nr_running. Atomically
4703 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4704 * @worker will clear REBOUND using worker_clr_flags() when
4705 * it initiates the next execution cycle thus restoring
4706 * concurrency management. Note that when or whether
4707 * @worker clears REBOUND doesn't affect correctness.
4708 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004709 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004710 * tested without holding any lock in
4711 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4712 * fail incorrectly leading to premature concurrency
4713 * management operations.
4714 */
4715 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4716 worker_flags |= WORKER_REBOUND;
4717 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004718 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004719 }
4720
Tejun Heoa9ab7752013-03-19 13:45:21 -07004721 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004722}
4723
Tejun Heo7dbc7252013-03-19 13:45:21 -07004724/**
4725 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4726 * @pool: unbound pool of interest
4727 * @cpu: the CPU which is coming up
4728 *
4729 * An unbound pool may end up with a cpumask which doesn't have any online
4730 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4731 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4732 * online CPU before, cpus_allowed of all its workers should be restored.
4733 */
4734static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4735{
4736 static cpumask_t cpumask;
4737 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004738
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004739 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004740
4741 /* is @cpu allowed for @pool? */
4742 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4743 return;
4744
Tejun Heo7dbc7252013-03-19 13:45:21 -07004745 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004746
4747 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004748 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004749 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004750}
4751
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004752int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004753{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004754 struct worker_pool *pool;
4755
4756 for_each_cpu_worker_pool(pool, cpu) {
4757 if (pool->nr_workers)
4758 continue;
4759 if (!create_worker(pool))
4760 return -ENOMEM;
4761 }
4762 return 0;
4763}
4764
4765int workqueue_online_cpu(unsigned int cpu)
4766{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004767 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004768 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004769 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004770
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004771 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004772
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004773 for_each_pool(pool, pi) {
4774 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004775
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004776 if (pool->cpu == cpu)
4777 rebind_workers(pool);
4778 else if (pool->cpu < 0)
4779 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004780
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004781 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004782 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004783
4784 /* update NUMA affinity of unbound workqueues */
4785 list_for_each_entry(wq, &workqueues, list)
4786 wq_update_unbound_numa(wq, cpu, true);
4787
4788 mutex_unlock(&wq_pool_mutex);
4789 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004790}
4791
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004792int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004793{
Tejun Heo4c16bd32013-04-01 11:23:36 -07004794 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004795
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004796 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004797 if (WARN_ON(cpu != smp_processor_id()))
4798 return -1;
4799
4800 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004801
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004802 /* update NUMA affinity of unbound workqueues */
4803 mutex_lock(&wq_pool_mutex);
4804 list_for_each_entry(wq, &workqueues, list)
4805 wq_update_unbound_numa(wq, cpu, false);
4806 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004807
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004808 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004809}
4810
Rusty Russell2d3854a2008-11-05 13:39:10 +11004811#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004812
Rusty Russell2d3854a2008-11-05 13:39:10 +11004813struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004814 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004815 long (*fn)(void *);
4816 void *arg;
4817 long ret;
4818};
4819
Tejun Heoed48ece2012-09-18 12:48:43 -07004820static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004821{
Tejun Heoed48ece2012-09-18 12:48:43 -07004822 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4823
Rusty Russell2d3854a2008-11-05 13:39:10 +11004824 wfc->ret = wfc->fn(wfc->arg);
4825}
4826
4827/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004828 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004829 * @cpu: the cpu to run on
4830 * @fn: the function to run
4831 * @arg: the function arg
4832 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004833 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004834 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004835 *
4836 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004837 */
Tejun Heod84ff052013-03-12 11:29:59 -07004838long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004839{
Tejun Heoed48ece2012-09-18 12:48:43 -07004840 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004841
Tejun Heoed48ece2012-09-18 12:48:43 -07004842 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4843 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004844 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004845 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004846 return wfc.ret;
4847}
4848EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02004849
4850/**
4851 * work_on_cpu_safe - run a function in thread context on a particular cpu
4852 * @cpu: the cpu to run on
4853 * @fn: the function to run
4854 * @arg: the function argument
4855 *
4856 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4857 * any locks which would prevent @fn from completing.
4858 *
4859 * Return: The value @fn returns.
4860 */
4861long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
4862{
4863 long ret = -ENODEV;
4864
4865 get_online_cpus();
4866 if (cpu_online(cpu))
4867 ret = work_on_cpu(cpu, fn, arg);
4868 put_online_cpus();
4869 return ret;
4870}
4871EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004872#endif /* CONFIG_SMP */
4873
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004874#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304875
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004876/**
4877 * freeze_workqueues_begin - begin freezing workqueues
4878 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004879 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004880 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004881 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004882 *
4883 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004884 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004885 */
4886void freeze_workqueues_begin(void)
4887{
Tejun Heo24b8a842013-03-12 11:29:58 -07004888 struct workqueue_struct *wq;
4889 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004890
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004891 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004892
Tejun Heo6183c002013-03-12 11:29:57 -07004893 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004894 workqueue_freezing = true;
4895
Tejun Heo24b8a842013-03-12 11:29:58 -07004896 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004897 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004898 for_each_pwq(pwq, wq)
4899 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004900 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004901 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004902
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004903 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004904}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004905
4906/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004907 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004908 *
4909 * Check whether freezing is complete. This function must be called
4910 * between freeze_workqueues_begin() and thaw_workqueues().
4911 *
4912 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004913 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004914 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004915 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004916 * %true if some freezable workqueues are still busy. %false if freezing
4917 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004918 */
4919bool freeze_workqueues_busy(void)
4920{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004921 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004922 struct workqueue_struct *wq;
4923 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004924
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004925 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004926
Tejun Heo6183c002013-03-12 11:29:57 -07004927 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004928
Tejun Heo24b8a842013-03-12 11:29:58 -07004929 list_for_each_entry(wq, &workqueues, list) {
4930 if (!(wq->flags & WQ_FREEZABLE))
4931 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004932 /*
4933 * nr_active is monotonically decreasing. It's safe
4934 * to peek without lock.
4935 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004936 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004937 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004938 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004939 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004940 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004941 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004942 goto out_unlock;
4943 }
4944 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004945 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004946 }
4947out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004948 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004949 return busy;
4950}
4951
4952/**
4953 * thaw_workqueues - thaw workqueues
4954 *
4955 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004956 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004957 *
4958 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004959 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004960 */
4961void thaw_workqueues(void)
4962{
Tejun Heo24b8a842013-03-12 11:29:58 -07004963 struct workqueue_struct *wq;
4964 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004965
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004966 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004967
4968 if (!workqueue_freezing)
4969 goto out_unlock;
4970
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004971 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004972
Tejun Heo24b8a842013-03-12 11:29:58 -07004973 /* restore max_active and repopulate worklist */
4974 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004975 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004976 for_each_pwq(pwq, wq)
4977 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004978 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004979 }
4980
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004981out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004982 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004983}
4984#endif /* CONFIG_FREEZER */
4985
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004986static int workqueue_apply_unbound_cpumask(void)
4987{
4988 LIST_HEAD(ctxs);
4989 int ret = 0;
4990 struct workqueue_struct *wq;
4991 struct apply_wqattrs_ctx *ctx, *n;
4992
4993 lockdep_assert_held(&wq_pool_mutex);
4994
4995 list_for_each_entry(wq, &workqueues, list) {
4996 if (!(wq->flags & WQ_UNBOUND))
4997 continue;
4998 /* creating multiple pwqs breaks ordering guarantee */
4999 if (wq->flags & __WQ_ORDERED)
5000 continue;
5001
5002 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5003 if (!ctx) {
5004 ret = -ENOMEM;
5005 break;
5006 }
5007
5008 list_add_tail(&ctx->list, &ctxs);
5009 }
5010
5011 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5012 if (!ret)
5013 apply_wqattrs_commit(ctx);
5014 apply_wqattrs_cleanup(ctx);
5015 }
5016
5017 return ret;
5018}
5019
5020/**
5021 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5022 * @cpumask: the cpumask to set
5023 *
5024 * The low-level workqueues cpumask is a global cpumask that limits
5025 * the affinity of all unbound workqueues. This function check the @cpumask
5026 * and apply it to all unbound workqueues and updates all pwqs of them.
5027 *
5028 * Retun: 0 - Success
5029 * -EINVAL - Invalid @cpumask
5030 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5031 */
5032int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5033{
5034 int ret = -EINVAL;
5035 cpumask_var_t saved_cpumask;
5036
5037 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5038 return -ENOMEM;
5039
Tal Shorerc98a9802017-11-03 17:27:50 +02005040 /*
5041 * Not excluding isolated cpus on purpose.
5042 * If the user wishes to include them, we allow that.
5043 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005044 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5045 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005046 apply_wqattrs_lock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005047
5048 /* save the old wq_unbound_cpumask. */
5049 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5050
5051 /* update wq_unbound_cpumask at first and apply it to wqs. */
5052 cpumask_copy(wq_unbound_cpumask, cpumask);
5053 ret = workqueue_apply_unbound_cpumask();
5054
5055 /* restore the wq_unbound_cpumask when failed. */
5056 if (ret < 0)
5057 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5058
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005059 apply_wqattrs_unlock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005060 }
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005061
5062 free_cpumask_var(saved_cpumask);
5063 return ret;
5064}
5065
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005066#ifdef CONFIG_SYSFS
5067/*
5068 * Workqueues with WQ_SYSFS flag set is visible to userland via
5069 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5070 * following attributes.
5071 *
5072 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5073 * max_active RW int : maximum number of in-flight work items
5074 *
5075 * Unbound workqueues have the following extra attributes.
5076 *
Wang Long9a19b462017-11-02 23:05:12 -04005077 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005078 * nice RW int : nice value of the workers
5079 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005080 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005081 */
5082struct wq_device {
5083 struct workqueue_struct *wq;
5084 struct device dev;
5085};
5086
5087static struct workqueue_struct *dev_to_wq(struct device *dev)
5088{
5089 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5090
5091 return wq_dev->wq;
5092}
5093
5094static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5095 char *buf)
5096{
5097 struct workqueue_struct *wq = dev_to_wq(dev);
5098
5099 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5100}
5101static DEVICE_ATTR_RO(per_cpu);
5102
5103static ssize_t max_active_show(struct device *dev,
5104 struct device_attribute *attr, char *buf)
5105{
5106 struct workqueue_struct *wq = dev_to_wq(dev);
5107
5108 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5109}
5110
5111static ssize_t max_active_store(struct device *dev,
5112 struct device_attribute *attr, const char *buf,
5113 size_t count)
5114{
5115 struct workqueue_struct *wq = dev_to_wq(dev);
5116 int val;
5117
5118 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5119 return -EINVAL;
5120
5121 workqueue_set_max_active(wq, val);
5122 return count;
5123}
5124static DEVICE_ATTR_RW(max_active);
5125
5126static struct attribute *wq_sysfs_attrs[] = {
5127 &dev_attr_per_cpu.attr,
5128 &dev_attr_max_active.attr,
5129 NULL,
5130};
5131ATTRIBUTE_GROUPS(wq_sysfs);
5132
5133static ssize_t wq_pool_ids_show(struct device *dev,
5134 struct device_attribute *attr, char *buf)
5135{
5136 struct workqueue_struct *wq = dev_to_wq(dev);
5137 const char *delim = "";
5138 int node, written = 0;
5139
5140 rcu_read_lock_sched();
5141 for_each_node(node) {
5142 written += scnprintf(buf + written, PAGE_SIZE - written,
5143 "%s%d:%d", delim, node,
5144 unbound_pwq_by_node(wq, node)->pool->id);
5145 delim = " ";
5146 }
5147 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5148 rcu_read_unlock_sched();
5149
5150 return written;
5151}
5152
5153static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5154 char *buf)
5155{
5156 struct workqueue_struct *wq = dev_to_wq(dev);
5157 int written;
5158
5159 mutex_lock(&wq->mutex);
5160 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5161 mutex_unlock(&wq->mutex);
5162
5163 return written;
5164}
5165
5166/* prepare workqueue_attrs for sysfs store operations */
5167static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5168{
5169 struct workqueue_attrs *attrs;
5170
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005171 lockdep_assert_held(&wq_pool_mutex);
5172
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005173 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5174 if (!attrs)
5175 return NULL;
5176
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005177 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005178 return attrs;
5179}
5180
5181static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5182 const char *buf, size_t count)
5183{
5184 struct workqueue_struct *wq = dev_to_wq(dev);
5185 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005186 int ret = -ENOMEM;
5187
5188 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005189
5190 attrs = wq_sysfs_prep_attrs(wq);
5191 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005192 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005193
5194 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5195 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005196 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005197 else
5198 ret = -EINVAL;
5199
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005200out_unlock:
5201 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005202 free_workqueue_attrs(attrs);
5203 return ret ?: count;
5204}
5205
5206static ssize_t wq_cpumask_show(struct device *dev,
5207 struct device_attribute *attr, char *buf)
5208{
5209 struct workqueue_struct *wq = dev_to_wq(dev);
5210 int written;
5211
5212 mutex_lock(&wq->mutex);
5213 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5214 cpumask_pr_args(wq->unbound_attrs->cpumask));
5215 mutex_unlock(&wq->mutex);
5216 return written;
5217}
5218
5219static ssize_t wq_cpumask_store(struct device *dev,
5220 struct device_attribute *attr,
5221 const char *buf, size_t count)
5222{
5223 struct workqueue_struct *wq = dev_to_wq(dev);
5224 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005225 int ret = -ENOMEM;
5226
5227 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005228
5229 attrs = wq_sysfs_prep_attrs(wq);
5230 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005231 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005232
5233 ret = cpumask_parse(buf, attrs->cpumask);
5234 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005235 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005236
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005237out_unlock:
5238 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005239 free_workqueue_attrs(attrs);
5240 return ret ?: count;
5241}
5242
5243static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5244 char *buf)
5245{
5246 struct workqueue_struct *wq = dev_to_wq(dev);
5247 int written;
5248
5249 mutex_lock(&wq->mutex);
5250 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5251 !wq->unbound_attrs->no_numa);
5252 mutex_unlock(&wq->mutex);
5253
5254 return written;
5255}
5256
5257static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5258 const char *buf, size_t count)
5259{
5260 struct workqueue_struct *wq = dev_to_wq(dev);
5261 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005262 int v, ret = -ENOMEM;
5263
5264 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005265
5266 attrs = wq_sysfs_prep_attrs(wq);
5267 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005268 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005269
5270 ret = -EINVAL;
5271 if (sscanf(buf, "%d", &v) == 1) {
5272 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005273 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005274 }
5275
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005276out_unlock:
5277 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005278 free_workqueue_attrs(attrs);
5279 return ret ?: count;
5280}
5281
5282static struct device_attribute wq_sysfs_unbound_attrs[] = {
5283 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5284 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5285 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5286 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5287 __ATTR_NULL,
5288};
5289
5290static struct bus_type wq_subsys = {
5291 .name = "workqueue",
5292 .dev_groups = wq_sysfs_groups,
5293};
5294
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005295static ssize_t wq_unbound_cpumask_show(struct device *dev,
5296 struct device_attribute *attr, char *buf)
5297{
5298 int written;
5299
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005300 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005301 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5302 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005303 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005304
5305 return written;
5306}
5307
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005308static ssize_t wq_unbound_cpumask_store(struct device *dev,
5309 struct device_attribute *attr, const char *buf, size_t count)
5310{
5311 cpumask_var_t cpumask;
5312 int ret;
5313
5314 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5315 return -ENOMEM;
5316
5317 ret = cpumask_parse(buf, cpumask);
5318 if (!ret)
5319 ret = workqueue_set_unbound_cpumask(cpumask);
5320
5321 free_cpumask_var(cpumask);
5322 return ret ? ret : count;
5323}
5324
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005325static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005326 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5327 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005328
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005329static int __init wq_sysfs_init(void)
5330{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005331 int err;
5332
5333 err = subsys_virtual_register(&wq_subsys, NULL);
5334 if (err)
5335 return err;
5336
5337 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005338}
5339core_initcall(wq_sysfs_init);
5340
5341static void wq_device_release(struct device *dev)
5342{
5343 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5344
5345 kfree(wq_dev);
5346}
5347
5348/**
5349 * workqueue_sysfs_register - make a workqueue visible in sysfs
5350 * @wq: the workqueue to register
5351 *
5352 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5353 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5354 * which is the preferred method.
5355 *
5356 * Workqueue user should use this function directly iff it wants to apply
5357 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5358 * apply_workqueue_attrs() may race against userland updating the
5359 * attributes.
5360 *
5361 * Return: 0 on success, -errno on failure.
5362 */
5363int workqueue_sysfs_register(struct workqueue_struct *wq)
5364{
5365 struct wq_device *wq_dev;
5366 int ret;
5367
5368 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305369 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005370 * attributes breaks ordering guarantee. Disallow exposing ordered
5371 * workqueues.
5372 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005373 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005374 return -EINVAL;
5375
5376 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5377 if (!wq_dev)
5378 return -ENOMEM;
5379
5380 wq_dev->wq = wq;
5381 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005382 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005383 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005384
5385 /*
5386 * unbound_attrs are created separately. Suppress uevent until
5387 * everything is ready.
5388 */
5389 dev_set_uevent_suppress(&wq_dev->dev, true);
5390
5391 ret = device_register(&wq_dev->dev);
5392 if (ret) {
5393 kfree(wq_dev);
5394 wq->wq_dev = NULL;
5395 return ret;
5396 }
5397
5398 if (wq->flags & WQ_UNBOUND) {
5399 struct device_attribute *attr;
5400
5401 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5402 ret = device_create_file(&wq_dev->dev, attr);
5403 if (ret) {
5404 device_unregister(&wq_dev->dev);
5405 wq->wq_dev = NULL;
5406 return ret;
5407 }
5408 }
5409 }
5410
5411 dev_set_uevent_suppress(&wq_dev->dev, false);
5412 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5413 return 0;
5414}
5415
5416/**
5417 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5418 * @wq: the workqueue to unregister
5419 *
5420 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5421 */
5422static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5423{
5424 struct wq_device *wq_dev = wq->wq_dev;
5425
5426 if (!wq->wq_dev)
5427 return;
5428
5429 wq->wq_dev = NULL;
5430 device_unregister(&wq_dev->dev);
5431}
5432#else /* CONFIG_SYSFS */
5433static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5434#endif /* CONFIG_SYSFS */
5435
Tejun Heo82607adc2015-12-08 11:28:04 -05005436/*
5437 * Workqueue watchdog.
5438 *
5439 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5440 * flush dependency, a concurrency managed work item which stays RUNNING
5441 * indefinitely. Workqueue stalls can be very difficult to debug as the
5442 * usual warning mechanisms don't trigger and internal workqueue state is
5443 * largely opaque.
5444 *
5445 * Workqueue watchdog monitors all worker pools periodically and dumps
5446 * state if some pools failed to make forward progress for a while where
5447 * forward progress is defined as the first item on ->worklist changing.
5448 *
5449 * This mechanism is controlled through the kernel parameter
5450 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5451 * corresponding sysfs parameter file.
5452 */
5453#ifdef CONFIG_WQ_WATCHDOG
5454
Tejun Heo82607adc2015-12-08 11:28:04 -05005455static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005456static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005457
5458static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5459static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5460
5461static void wq_watchdog_reset_touched(void)
5462{
5463 int cpu;
5464
5465 wq_watchdog_touched = jiffies;
5466 for_each_possible_cpu(cpu)
5467 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5468}
5469
Kees Cook5cd79d62017-10-04 16:27:00 -07005470static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005471{
5472 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5473 bool lockup_detected = false;
5474 struct worker_pool *pool;
5475 int pi;
5476
5477 if (!thresh)
5478 return;
5479
5480 rcu_read_lock();
5481
5482 for_each_pool(pool, pi) {
5483 unsigned long pool_ts, touched, ts;
5484
5485 if (list_empty(&pool->worklist))
5486 continue;
5487
5488 /* get the latest of pool and touched timestamps */
5489 pool_ts = READ_ONCE(pool->watchdog_ts);
5490 touched = READ_ONCE(wq_watchdog_touched);
5491
5492 if (time_after(pool_ts, touched))
5493 ts = pool_ts;
5494 else
5495 ts = touched;
5496
5497 if (pool->cpu >= 0) {
5498 unsigned long cpu_touched =
5499 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5500 pool->cpu));
5501 if (time_after(cpu_touched, ts))
5502 ts = cpu_touched;
5503 }
5504
5505 /* did we stall? */
5506 if (time_after(jiffies, ts + thresh)) {
5507 lockup_detected = true;
5508 pr_emerg("BUG: workqueue lockup - pool");
5509 pr_cont_pool_info(pool);
5510 pr_cont(" stuck for %us!\n",
5511 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5512 }
5513 }
5514
5515 rcu_read_unlock();
5516
5517 if (lockup_detected)
5518 show_workqueue_state();
5519
5520 wq_watchdog_reset_touched();
5521 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5522}
5523
5524void wq_watchdog_touch(int cpu)
5525{
5526 if (cpu >= 0)
5527 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5528 else
5529 wq_watchdog_touched = jiffies;
5530}
5531
5532static void wq_watchdog_set_thresh(unsigned long thresh)
5533{
5534 wq_watchdog_thresh = 0;
5535 del_timer_sync(&wq_watchdog_timer);
5536
5537 if (thresh) {
5538 wq_watchdog_thresh = thresh;
5539 wq_watchdog_reset_touched();
5540 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5541 }
5542}
5543
5544static int wq_watchdog_param_set_thresh(const char *val,
5545 const struct kernel_param *kp)
5546{
5547 unsigned long thresh;
5548 int ret;
5549
5550 ret = kstrtoul(val, 0, &thresh);
5551 if (ret)
5552 return ret;
5553
5554 if (system_wq)
5555 wq_watchdog_set_thresh(thresh);
5556 else
5557 wq_watchdog_thresh = thresh;
5558
5559 return 0;
5560}
5561
5562static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5563 .set = wq_watchdog_param_set_thresh,
5564 .get = param_get_ulong,
5565};
5566
5567module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5568 0644);
5569
5570static void wq_watchdog_init(void)
5571{
Kees Cook5cd79d62017-10-04 16:27:00 -07005572 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005573 wq_watchdog_set_thresh(wq_watchdog_thresh);
5574}
5575
5576#else /* CONFIG_WQ_WATCHDOG */
5577
5578static inline void wq_watchdog_init(void) { }
5579
5580#endif /* CONFIG_WQ_WATCHDOG */
5581
Tejun Heobce90382013-04-01 11:23:32 -07005582static void __init wq_numa_init(void)
5583{
5584 cpumask_var_t *tbl;
5585 int node, cpu;
5586
Tejun Heobce90382013-04-01 11:23:32 -07005587 if (num_possible_nodes() <= 1)
5588 return;
5589
Tejun Heod55262c2013-04-01 11:23:38 -07005590 if (wq_disable_numa) {
5591 pr_info("workqueue: NUMA affinity support disabled\n");
5592 return;
5593 }
5594
Tejun Heo4c16bd32013-04-01 11:23:36 -07005595 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5596 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5597
Tejun Heobce90382013-04-01 11:23:32 -07005598 /*
5599 * We want masks of possible CPUs of each node which isn't readily
5600 * available. Build one from cpu_to_node() which should have been
5601 * fully initialized by now.
5602 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005603 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005604 BUG_ON(!tbl);
5605
5606 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005607 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005608 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005609
5610 for_each_possible_cpu(cpu) {
5611 node = cpu_to_node(cpu);
5612 if (WARN_ON(node == NUMA_NO_NODE)) {
5613 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5614 /* happens iff arch is bonkers, let's just proceed */
5615 return;
5616 }
5617 cpumask_set_cpu(cpu, tbl[node]);
5618 }
5619
5620 wq_numa_possible_cpumask = tbl;
5621 wq_numa_enabled = true;
5622}
5623
Tejun Heo3347fa02016-09-16 15:49:32 -04005624/**
5625 * workqueue_init_early - early init for workqueue subsystem
5626 *
5627 * This is the first half of two-staged workqueue subsystem initialization
5628 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5629 * idr are up. It sets up all the data structures and system workqueues
5630 * and allows early boot code to create workqueues and queue/cancel work
5631 * items. Actual work item execution starts only after kthreads can be
5632 * created and scheduled right before early initcalls.
5633 */
5634int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005635{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005636 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5637 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005638
Tejun Heoe904e6c2013-03-12 11:29:57 -07005639 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5640
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005641 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Tal Shorerc98a9802017-11-03 17:27:50 +02005642 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(HK_FLAG_DOMAIN));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005643
Tejun Heoe904e6c2013-03-12 11:29:57 -07005644 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5645
Tejun Heo706026c2013-01-24 11:01:34 -08005646 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005647 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005648 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005649
Tejun Heo7a4e3442013-03-12 11:30:00 -07005650 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005651 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005652 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005653 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005654 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005655 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005656 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005657
Tejun Heo9daf9e62013-01-24 11:01:33 -08005658 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005659 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005660 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005661 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005662 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005663 }
5664
Tejun Heo8a2b7532013-09-05 12:30:04 -04005665 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005666 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5667 struct workqueue_attrs *attrs;
5668
5669 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005670 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005671 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005672
5673 /*
5674 * An ordered wq should have only one pwq as ordering is
5675 * guaranteed by max_active which is enforced by pwqs.
5676 * Turn off NUMA so that dfl_pwq is used for all nodes.
5677 */
5678 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5679 attrs->nice = std_nice[i];
5680 attrs->no_numa = true;
5681 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005682 }
5683
Tejun Heod320c032010-06-29 10:07:14 +02005684 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005685 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005686 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005687 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5688 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005689 system_freezable_wq = alloc_workqueue("events_freezable",
5690 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305691 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5692 WQ_POWER_EFFICIENT, 0);
5693 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5694 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5695 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005696 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305697 !system_unbound_wq || !system_freezable_wq ||
5698 !system_power_efficient_wq ||
5699 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005700
Tejun Heo3347fa02016-09-16 15:49:32 -04005701 return 0;
5702}
5703
5704/**
5705 * workqueue_init - bring workqueue subsystem fully online
5706 *
5707 * This is the latter half of two-staged workqueue subsystem initialization
5708 * and invoked as soon as kthreads can be created and scheduled.
5709 * Workqueues have been created and work items queued on them, but there
5710 * are no kworkers executing the work items yet. Populate the worker pools
5711 * with the initial workers and enable future kworker creations.
5712 */
5713int __init workqueue_init(void)
5714{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005715 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005716 struct worker_pool *pool;
5717 int cpu, bkt;
5718
Tejun Heo2186d9f2016-10-19 12:01:27 -04005719 /*
5720 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5721 * CPU to node mapping may not be available that early on some
5722 * archs such as power and arm64. As per-cpu pools created
5723 * previously could be missing node hint and unbound pools NUMA
5724 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08005725 *
5726 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04005727 */
5728 wq_numa_init();
5729
5730 mutex_lock(&wq_pool_mutex);
5731
5732 for_each_possible_cpu(cpu) {
5733 for_each_cpu_worker_pool(pool, cpu) {
5734 pool->node = cpu_to_node(cpu);
5735 }
5736 }
5737
Tejun Heo40c17f72018-01-08 05:38:37 -08005738 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04005739 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08005740 WARN(init_rescuer(wq),
5741 "workqueue: failed to create early rescuer for %s",
5742 wq->name);
5743 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04005744
5745 mutex_unlock(&wq_pool_mutex);
5746
Tejun Heo3347fa02016-09-16 15:49:32 -04005747 /* create the initial workers */
5748 for_each_online_cpu(cpu) {
5749 for_each_cpu_worker_pool(pool, cpu) {
5750 pool->flags &= ~POOL_DISASSOCIATED;
5751 BUG_ON(!create_worker(pool));
5752 }
5753 }
5754
5755 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5756 BUG_ON(!create_worker(pool));
5757
5758 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005759 wq_watchdog_init();
5760
Suresh Siddha6ee05782010-07-30 14:57:37 -07005761 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005762}