blob: 43d18cb46308385865d14ce40906c4646d378063 [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>
Tejun Heoe22bee72010-06-29 10:07:14 +020051
Tejun Heoea138442013-01-18 14:05:55 -080052#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Tejun Heoc8e55f32010-06-29 10:07:12 +020054enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070055 /*
Tejun Heo24647572013-01-24 11:01:33 -080056 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 *
Tejun Heo24647572013-01-24 11:01:33 -080058 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 * While associated (!DISASSOCIATED), all workers are bound to the
60 * CPU and none has %WORKER_UNBOUND set and concurrency management
61 * is in effect.
62 *
63 * While DISASSOCIATED, the cpu may be offline and all workers have
64 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080065 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070066 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070067 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080068 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080069 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070070 */
Tejun Heo692b4822017-10-09 08:04:13 -070071 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
Tejun Heo24647572013-01-24 11:01:33 -080072 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020073
Tejun Heoc8e55f32010-06-29 10:07:12 +020074 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020075 WORKER_DIE = 1 << 1, /* die die die */
76 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020077 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020078 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020079 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070080 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020081
Tejun Heoa9ab7752013-03-19 13:45:21 -070082 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
83 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020084
Tejun Heoe34cdddb2013-01-24 11:01:33 -080085 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070086
Tejun Heo29c91e92013-03-12 11:30:03 -070087 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020088 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020089
Tejun Heoe22bee72010-06-29 10:07:14 +020090 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
91 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
92
Tejun Heo3233cdb2011-02-16 18:10:19 +010093 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
94 /* call for help after 10ms
95 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020096 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
97 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020098
99 /*
100 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800101 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200102 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800103 RESCUER_NICE_LEVEL = MIN_NICE,
104 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700105
106 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200107};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200110 * Structure fields follow one of the following exclusion rules.
111 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200112 * I: Modifiable by initialization/destruction paths and read-only for
113 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200114 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200115 * P: Preemption protected. Disabling preemption is enough and should
116 * only be modified and accessed from the local cpu.
117 *
Tejun Heod565ed62013-01-24 11:01:33 -0800118 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200119 *
Tejun Heod565ed62013-01-24 11:01:33 -0800120 * X: During normal operation, modification requires pool->lock and should
121 * be done only from local cpu. Either disabling preemption on local
122 * cpu or grabbing pool->lock is enough for read access. If
123 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200124 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800125 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700126 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700127 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700128 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700129 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700130 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800131 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
132 *
133 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
134 * sched-RCU for reads.
135 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700136 * WQ: wq->mutex protected.
137 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700138 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700139 *
140 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200141 */
142
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800143/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200144
Tejun Heobd7bdd42012-07-12 14:46:37 -0700145struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800146 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700147 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700148 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800149 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700150 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700151
Tejun Heo82607adc2015-12-08 11:28:04 -0500152 unsigned long watchdog_ts; /* L: watchdog timestamp */
153
Tejun Heobd7bdd42012-07-12 14:46:37 -0700154 struct list_head worklist; /* L: list of pending works */
155 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700156
157 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700158 int nr_idle; /* L: currently idle ones */
159
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 Heo794b18b2013-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 Heo974271c2012-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 Heo974271c2012-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
1606/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001607 * worker_enter_idle - enter idle state
1608 * @worker: worker which is entering idle state
1609 *
1610 * @worker is entering idle state. Update stats and idle timer if
1611 * necessary.
1612 *
1613 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001614 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001615 */
1616static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001618 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619
Tejun Heo6183c002013-03-12 11:29:57 -07001620 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1621 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1622 (worker->hentry.next || worker->hentry.pprev)))
1623 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624
Lai Jiangshan051e1852014-07-22 13:03:02 +08001625 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001626 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001627 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001628 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001629
Tejun Heoc8e55f32010-06-29 10:07:12 +02001630 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001631 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001632
Tejun Heo628c78e2012-07-17 12:39:27 -07001633 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1634 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001635
Tejun Heo544ecf32012-05-14 15:04:50 -07001636 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001637 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001638 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001639 * nr_running, the warning may trigger spuriously. Check iff
1640 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001641 */
Tejun Heo24647572013-01-24 11:01:33 -08001642 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001643 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001644 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645}
1646
Tejun Heoc8e55f32010-06-29 10:07:12 +02001647/**
1648 * worker_leave_idle - leave idle state
1649 * @worker: worker which is leaving idle state
1650 *
1651 * @worker is leaving idle state. Update stats.
1652 *
1653 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001654 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001655 */
1656static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001658 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
Tejun Heo6183c002013-03-12 11:29:57 -07001660 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1661 return;
Tejun Heod302f012010-06-29 10:07:13 +02001662 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001663 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001664 list_del_init(&worker->entry);
1665}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001667static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001668{
1669 struct worker *worker;
1670
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001671 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001672 if (worker) {
1673 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001674 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001675 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001676 /* on creation a worker is in !idle && prep state */
1677 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001678 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001679 return worker;
1680}
1681
1682/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001683 * worker_attach_to_pool() - attach a worker to a pool
1684 * @worker: worker to be attached
1685 * @pool: the target pool
1686 *
1687 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1688 * cpu-binding of @worker are kept coordinated with the pool across
1689 * cpu-[un]hotplugs.
1690 */
1691static void worker_attach_to_pool(struct worker *worker,
1692 struct worker_pool *pool)
1693{
1694 mutex_lock(&pool->attach_mutex);
1695
1696 /*
1697 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1698 * online CPUs. It'll be re-applied when any of the CPUs come up.
1699 */
1700 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1701
1702 /*
1703 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1704 * stable across this function. See the comments above the
1705 * flag definition for details.
1706 */
1707 if (pool->flags & POOL_DISASSOCIATED)
1708 worker->flags |= WORKER_UNBOUND;
1709
1710 list_add_tail(&worker->node, &pool->workers);
1711
1712 mutex_unlock(&pool->attach_mutex);
1713}
1714
1715/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001716 * worker_detach_from_pool() - detach a worker from its pool
1717 * @worker: worker which is attached to its pool
1718 * @pool: the pool @worker is attached to
1719 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001720 * Undo the attaching which had been done in worker_attach_to_pool(). The
1721 * caller worker shouldn't access to the pool after detached except it has
1722 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001723 */
1724static void worker_detach_from_pool(struct worker *worker,
1725 struct worker_pool *pool)
1726{
1727 struct completion *detach_completion = NULL;
1728
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001729 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001730 list_del(&worker->node);
1731 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001732 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001733 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001734
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001735 /* clear leftover flags without pool->lock after it is detached */
1736 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1737
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001738 if (detach_completion)
1739 complete(detach_completion);
1740}
1741
1742/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001743 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001744 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001745 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001746 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001747 *
1748 * CONTEXT:
1749 * Might sleep. Does GFP_KERNEL allocations.
1750 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001751 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001752 * Pointer to the newly created worker.
1753 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001754static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001755{
Tejun Heoc34056a2010-06-29 10:07:11 +02001756 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001757 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001758 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001759
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001760 /* ID is needed to determine kthread name */
1761 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001762 if (id < 0)
1763 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001764
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001765 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001766 if (!worker)
1767 goto fail;
1768
Tejun Heobd7bdd42012-07-12 14:46:37 -07001769 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001770 worker->id = id;
1771
Tejun Heo29c91e92013-03-12 11:30:03 -07001772 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001773 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1774 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001775 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001776 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1777
Tejun Heof3f90ad2013-04-01 11:23:34 -07001778 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001779 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001780 if (IS_ERR(worker->task))
1781 goto fail;
1782
Oleg Nesterov91151222013-11-14 12:56:18 +01001783 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001784 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001785
Lai Jiangshanda028462014-05-20 17:46:31 +08001786 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001787 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001788
Lai Jiangshan051e1852014-07-22 13:03:02 +08001789 /* start the newly created worker */
1790 spin_lock_irq(&pool->lock);
1791 worker->pool->nr_workers++;
1792 worker_enter_idle(worker);
1793 wake_up_process(worker->task);
1794 spin_unlock_irq(&pool->lock);
1795
Tejun Heoc34056a2010-06-29 10:07:11 +02001796 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001797
Tejun Heoc34056a2010-06-29 10:07:11 +02001798fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001799 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001800 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001801 kfree(worker);
1802 return NULL;
1803}
1804
1805/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001806 * destroy_worker - destroy a workqueue worker
1807 * @worker: worker to be destroyed
1808 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001809 * Destroy @worker and adjust @pool stats accordingly. The worker should
1810 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001811 *
1812 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001813 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001814 */
1815static void destroy_worker(struct worker *worker)
1816{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001817 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001818
Tejun Heocd549682013-03-13 19:47:39 -07001819 lockdep_assert_held(&pool->lock);
1820
Tejun Heoc34056a2010-06-29 10:07:11 +02001821 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001822 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001823 WARN_ON(!list_empty(&worker->scheduled)) ||
1824 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001825 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001826
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001827 pool->nr_workers--;
1828 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001829
Tejun Heoc8e55f32010-06-29 10:07:12 +02001830 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001831 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001832 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001833}
1834
Kees Cook32a6c722017-10-16 15:58:25 -07001835static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001836{
Kees Cook32a6c722017-10-16 15:58:25 -07001837 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001838
Tejun Heod565ed62013-01-24 11:01:33 -08001839 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001840
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001841 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001842 struct worker *worker;
1843 unsigned long expires;
1844
1845 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001846 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001847 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1848
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001849 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001850 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001851 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001852 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001853
1854 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001855 }
1856
Tejun Heod565ed62013-01-24 11:01:33 -08001857 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001858}
1859
Tejun Heo493a1722013-03-12 11:29:59 -07001860static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001861{
Tejun Heo112202d2013-02-13 19:29:12 -08001862 struct pool_workqueue *pwq = get_work_pwq(work);
1863 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001864
Tejun Heo2e109a22013-03-13 19:47:40 -07001865 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001866
Tejun Heo493008a2013-03-12 11:30:03 -07001867 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001868 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001869
1870 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001871 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001872 /*
1873 * If @pwq is for an unbound wq, its base ref may be put at
1874 * any time due to an attribute change. Pin @pwq until the
1875 * rescuer is done with it.
1876 */
1877 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001878 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001879 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001880 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001881}
1882
Kees Cook32a6c722017-10-16 15:58:25 -07001883static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001884{
Kees Cook32a6c722017-10-16 15:58:25 -07001885 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001886 struct work_struct *work;
1887
Tejun Heob2d82902014-12-08 12:39:16 -05001888 spin_lock_irq(&pool->lock);
1889 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001890
Tejun Heo63d95a92012-07-12 14:46:37 -07001891 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001892 /*
1893 * We've been trying to create a new worker but
1894 * haven't been successful. We might be hitting an
1895 * allocation deadlock. Send distress signals to
1896 * rescuers.
1897 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001898 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001899 send_mayday(work);
1900 }
1901
Tejun Heob2d82902014-12-08 12:39:16 -05001902 spin_unlock(&wq_mayday_lock);
1903 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001904
Tejun Heo63d95a92012-07-12 14:46:37 -07001905 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001906}
1907
1908/**
1909 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001910 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001911 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001912 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001913 * have at least one idle worker on return from this function. If
1914 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001915 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001916 * possible allocation deadlock.
1917 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001918 * On return, need_to_create_worker() is guaranteed to be %false and
1919 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001920 *
1921 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001922 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001923 * multiple times. Does GFP_KERNEL allocations. Called only from
1924 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001925 */
Tejun Heo29187a92015-01-16 14:21:16 -05001926static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001927__releases(&pool->lock)
1928__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001929{
Tejun Heoe22bee72010-06-29 10:07:14 +02001930restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001931 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001932
Tejun Heoe22bee72010-06-29 10:07:14 +02001933 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001934 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001935
1936 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001937 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001938 break;
1939
Lai Jiangshane212f362014-06-03 15:32:17 +08001940 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001941
Tejun Heo63d95a92012-07-12 14:46:37 -07001942 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001943 break;
1944 }
1945
Tejun Heo63d95a92012-07-12 14:46:37 -07001946 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001947 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001948 /*
1949 * This is necessary even after a new worker was just successfully
1950 * created as @pool->lock was dropped and the new worker might have
1951 * already become busy.
1952 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001953 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001954 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001955}
1956
1957/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001958 * manage_workers - manage worker pool
1959 * @worker: self
1960 *
Tejun Heo706026c2013-01-24 11:01:34 -08001961 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001962 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001963 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001964 *
1965 * The caller can safely start processing works on false return. On
1966 * true return, it's guaranteed that need_to_create_worker() is false
1967 * and may_start_working() is true.
1968 *
1969 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001970 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001971 * multiple times. Does GFP_KERNEL allocations.
1972 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001973 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001974 * %false if the pool doesn't need management and the caller can safely
1975 * start processing works, %true if management function was performed and
1976 * the conditions that the caller verified before calling the function may
1977 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001978 */
1979static bool manage_workers(struct worker *worker)
1980{
Tejun Heo63d95a92012-07-12 14:46:37 -07001981 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001982
Tejun Heo692b4822017-10-09 08:04:13 -07001983 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05001984 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07001985
1986 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001987 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001988
Tejun Heo29187a92015-01-16 14:21:16 -05001989 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001990
Tejun Heo2607d7a2015-03-09 09:22:28 -04001991 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07001992 pool->flags &= ~POOL_MANAGER_ACTIVE;
1993 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05001994 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02001995}
1996
Tejun Heoa62428c2010-06-29 10:07:10 +02001997/**
1998 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001999 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002000 * @work: work to process
2001 *
2002 * Process @work. This function contains all the logics necessary to
2003 * process a single work including synchronization against and
2004 * interaction with other workers on the same cpu, queueing and
2005 * flushing. As long as context requirement is met, any worker can
2006 * call this function to process a work.
2007 *
2008 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002009 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002010 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002011static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002012__releases(&pool->lock)
2013__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002014{
Tejun Heo112202d2013-02-13 19:29:12 -08002015 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002016 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002017 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002018 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002019 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002020#ifdef CONFIG_LOCKDEP
2021 /*
2022 * It is permissible to free the struct work_struct from
2023 * inside the function that is called from it, this we need to
2024 * take into account for lockdep too. To avoid bogus "held
2025 * lock freed" warnings as well as problems when looking into
2026 * work->lockdep_map, make a copy and use that here.
2027 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002028 struct lockdep_map lockdep_map;
2029
2030 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002031#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002032 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002033 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002034 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002035
Tejun Heo7e116292010-06-29 10:07:13 +02002036 /*
2037 * A single work shouldn't be executed concurrently by
2038 * multiple workers on a single cpu. Check whether anyone is
2039 * already processing the work. If so, defer the work to the
2040 * currently executing one.
2041 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002042 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002043 if (unlikely(collision)) {
2044 move_linked_works(work, &collision->scheduled, NULL);
2045 return;
2046 }
2047
Tejun Heo8930cab2012-08-03 10:30:45 -07002048 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002049 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002050 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002051 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002052 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002053 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002054 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002055
Tejun Heoa62428c2010-06-29 10:07:10 +02002056 list_del_init(&work->entry);
2057
Tejun Heo649027d2010-06-29 10:07:14 +02002058 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002059 * CPU intensive works don't participate in concurrency management.
2060 * They're the scheduler's responsibility. This takes @worker out
2061 * of concurrency management and the next code block will chain
2062 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002063 */
2064 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002065 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002066
Tejun Heo974271c2012-07-12 14:46:37 -07002067 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002068 * Wake up another worker if necessary. The condition is always
2069 * false for normal per-cpu workers since nr_running would always
2070 * be >= 1 at this point. This is used to chain execution of the
2071 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002072 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002073 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002074 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002075 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002076
Tejun Heo8930cab2012-08-03 10:30:45 -07002077 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002078 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002079 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002080 * PENDING and queued state changes happen together while IRQ is
2081 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002082 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002083 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002084
Tejun Heod565ed62013-01-24 11:01:33 -08002085 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002086
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002087 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002088 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002089 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002090 * Strictly speaking we should mark the invariant state without holding
2091 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002092 *
2093 * However, that would result in:
2094 *
2095 * A(W1)
2096 * WFC(C)
2097 * A(W1)
2098 * C(C)
2099 *
2100 * Which would create W1->C->W1 dependencies, even though there is no
2101 * actual deadlock possible. There are two solutions, using a
2102 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002103 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002104 * these locks.
2105 *
2106 * AFAICT there is no possible deadlock scenario between the
2107 * flush_work() and complete() primitives (except for single-threaded
2108 * workqueues), so hiding them isn't a problem.
2109 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002110 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002111 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002112 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002113 /*
2114 * While we must be careful to not use "work" after this, the trace
2115 * point will only record its address.
2116 */
2117 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002118 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002119 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002120
2121 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002122 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2123 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002124 current->comm, preempt_count(), task_pid_nr(current),
2125 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002126 debug_show_held_locks(current);
2127 dump_stack();
2128 }
2129
Tejun Heob22ce272013-08-28 17:33:37 -04002130 /*
2131 * The following prevents a kworker from hogging CPU on !PREEMPT
2132 * kernels, where a requeueing work item waiting for something to
2133 * happen could deadlock with stop_machine as such work item could
2134 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002135 * stop_machine. At the same time, report a quiescent RCU state so
2136 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002137 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002138 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002139
Tejun Heod565ed62013-01-24 11:01:33 -08002140 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002141
Tejun Heofb0e7be2010-06-29 10:07:15 +02002142 /* clear cpu intensive status */
2143 if (unlikely(cpu_intensive))
2144 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2145
Tejun Heoa62428c2010-06-29 10:07:10 +02002146 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002147 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002148 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002149 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002150 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002151 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002152 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002153}
2154
Tejun Heoaffee4b2010-06-29 10:07:12 +02002155/**
2156 * process_scheduled_works - process scheduled works
2157 * @worker: self
2158 *
2159 * Process all scheduled works. Please note that the scheduled list
2160 * may change while processing a work, so this function repeatedly
2161 * fetches a work from the top and executes it.
2162 *
2163 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002164 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002165 * multiple times.
2166 */
2167static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002169 while (!list_empty(&worker->scheduled)) {
2170 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002172 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174}
2175
Tejun Heo4690c4a2010-06-29 10:07:10 +02002176/**
2177 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002178 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002179 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002180 * The worker thread function. All workers belong to a worker_pool -
2181 * either a per-cpu one or dynamic unbound one. These workers process all
2182 * work items regardless of their specific target workqueue. The only
2183 * exception is work items which belong to workqueues with a rescuer which
2184 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002185 *
2186 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002187 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002188static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189{
Tejun Heoc34056a2010-06-29 10:07:11 +02002190 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002191 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192
Tejun Heoe22bee72010-06-29 10:07:14 +02002193 /* tell the scheduler that this is a workqueue worker */
2194 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002195woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002196 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002197
Tejun Heoa9ab7752013-03-19 13:45:21 -07002198 /* am I supposed to die? */
2199 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002200 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002201 WARN_ON_ONCE(!list_empty(&worker->entry));
2202 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002203
2204 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002205 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002206 worker_detach_from_pool(worker, pool);
2207 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002208 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002210
Tejun Heoc8e55f32010-06-29 10:07:12 +02002211 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002212recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002213 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002214 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002215 goto sleep;
2216
2217 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002218 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002219 goto recheck;
2220
Tejun Heoc8e55f32010-06-29 10:07:12 +02002221 /*
2222 * ->scheduled list can only be filled while a worker is
2223 * preparing to process a work or actually processing it.
2224 * Make sure nobody diddled with it while I was sleeping.
2225 */
Tejun Heo6183c002013-03-12 11:29:57 -07002226 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002227
Tejun Heoe22bee72010-06-29 10:07:14 +02002228 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002229 * Finish PREP stage. We're guaranteed to have at least one idle
2230 * worker or that someone else has already assumed the manager
2231 * role. This is where @worker starts participating in concurrency
2232 * management if applicable and concurrency management is restored
2233 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002234 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002235 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002236
2237 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002238 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002239 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002240 struct work_struct, entry);
2241
Tejun Heo82607adc2015-12-08 11:28:04 -05002242 pool->watchdog_ts = jiffies;
2243
Tejun Heoc8e55f32010-06-29 10:07:12 +02002244 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2245 /* optimization path, not strictly necessary */
2246 process_one_work(worker, work);
2247 if (unlikely(!list_empty(&worker->scheduled)))
2248 process_scheduled_works(worker);
2249 } else {
2250 move_linked_works(work, &worker->scheduled, NULL);
2251 process_scheduled_works(worker);
2252 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002253 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002254
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002255 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002256sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002257 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002258 * pool->lock is held and there's no work to process and no need to
2259 * manage, sleep. Workers are woken up only while holding
2260 * pool->lock or from local cpu, so setting the current state
2261 * before releasing pool->lock is enough to prevent losing any
2262 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002263 */
2264 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002265 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002266 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002267 schedule();
2268 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269}
2270
Tejun Heoe22bee72010-06-29 10:07:14 +02002271/**
2272 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002273 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002274 *
2275 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002276 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002277 *
Tejun Heo706026c2013-01-24 11:01:34 -08002278 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002279 * worker which uses GFP_KERNEL allocation which has slight chance of
2280 * developing into deadlock if some works currently on the same queue
2281 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2282 * the problem rescuer solves.
2283 *
Tejun Heo706026c2013-01-24 11:01:34 -08002284 * When such condition is possible, the pool summons rescuers of all
2285 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002286 * those works so that forward progress can be guaranteed.
2287 *
2288 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002289 *
2290 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002291 */
Tejun Heo111c2252013-01-17 17:16:24 -08002292static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002293{
Tejun Heo111c2252013-01-17 17:16:24 -08002294 struct worker *rescuer = __rescuer;
2295 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002296 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002297 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002298
2299 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002300
2301 /*
2302 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2303 * doesn't participate in concurrency management.
2304 */
2305 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002306repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002307 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002308
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002309 /*
2310 * By the time the rescuer is requested to stop, the workqueue
2311 * shouldn't have any work pending, but @wq->maydays may still have
2312 * pwq(s) queued. This can happen by non-rescuer workers consuming
2313 * all the work items before the rescuer got to them. Go through
2314 * @wq->maydays processing before acting on should_stop so that the
2315 * list is always empty on exit.
2316 */
2317 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002318
Tejun Heo493a1722013-03-12 11:29:59 -07002319 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002320 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002321
2322 while (!list_empty(&wq->maydays)) {
2323 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2324 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002325 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002326 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002327 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002328
2329 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002330 list_del_init(&pwq->mayday_node);
2331
Tejun Heo2e109a22013-03-13 19:47:40 -07002332 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002333
Lai Jiangshan51697d392014-05-20 17:46:36 +08002334 worker_attach_to_pool(rescuer, pool);
2335
2336 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002337 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002338
2339 /*
2340 * Slurp in all works issued via this workqueue and
2341 * process'em.
2342 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002343 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002344 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2345 if (get_work_pwq(work) == pwq) {
2346 if (first)
2347 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002348 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002349 }
2350 first = false;
2351 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002352
NeilBrown008847f2014-12-08 12:39:16 -05002353 if (!list_empty(scheduled)) {
2354 process_scheduled_works(rescuer);
2355
2356 /*
2357 * The above execution of rescued work items could
2358 * have created more to rescue through
2359 * pwq_activate_first_delayed() or chained
2360 * queueing. Let's put @pwq back on mayday list so
2361 * that such back-to-back work items, which may be
2362 * being used to relieve memory pressure, don't
2363 * incur MAYDAY_INTERVAL delay inbetween.
2364 */
2365 if (need_to_create_worker(pool)) {
2366 spin_lock(&wq_mayday_lock);
2367 get_pwq(pwq);
2368 list_move_tail(&pwq->mayday_node, &wq->maydays);
2369 spin_unlock(&wq_mayday_lock);
2370 }
2371 }
Tejun Heo75769582011-02-14 14:04:46 +01002372
2373 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002374 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002375 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002376 */
2377 put_pwq(pwq);
2378
2379 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002380 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002381 * regular worker; otherwise, we end up with 0 concurrency
2382 * and stalling the execution.
2383 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002384 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002385 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002386
Lai Jiangshanb3104102013-02-19 12:17:02 -08002387 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002388 spin_unlock_irq(&pool->lock);
2389
2390 worker_detach_from_pool(rescuer, pool);
2391
2392 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002393 }
2394
Tejun Heo2e109a22013-03-13 19:47:40 -07002395 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002396
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002397 if (should_stop) {
2398 __set_current_state(TASK_RUNNING);
2399 rescuer->task->flags &= ~PF_WQ_WORKER;
2400 return 0;
2401 }
2402
Tejun Heo111c2252013-01-17 17:16:24 -08002403 /* rescuers should never participate in concurrency management */
2404 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002405 schedule();
2406 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407}
2408
Tejun Heofca839c2015-12-07 10:58:57 -05002409/**
2410 * check_flush_dependency - check for flush dependency sanity
2411 * @target_wq: workqueue being flushed
2412 * @target_work: work item being flushed (NULL for workqueue flushes)
2413 *
2414 * %current is trying to flush the whole @target_wq or @target_work on it.
2415 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2416 * reclaiming memory or running on a workqueue which doesn't have
2417 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2418 * a deadlock.
2419 */
2420static void check_flush_dependency(struct workqueue_struct *target_wq,
2421 struct work_struct *target_work)
2422{
2423 work_func_t target_func = target_work ? target_work->func : NULL;
2424 struct worker *worker;
2425
2426 if (target_wq->flags & WQ_MEM_RECLAIM)
2427 return;
2428
2429 worker = current_wq_worker();
2430
2431 WARN_ONCE(current->flags & PF_MEMALLOC,
2432 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2433 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002434 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2435 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002436 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2437 worker->current_pwq->wq->name, worker->current_func,
2438 target_wq->name, target_func);
2439}
2440
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002441struct wq_barrier {
2442 struct work_struct work;
2443 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002444 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002445};
2446
2447static void wq_barrier_func(struct work_struct *work)
2448{
2449 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2450 complete(&barr->done);
2451}
2452
Tejun Heo4690c4a2010-06-29 10:07:10 +02002453/**
2454 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002455 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002456 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002457 * @target: target work to attach @barr to
2458 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002459 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002460 * @barr is linked to @target such that @barr is completed only after
2461 * @target finishes execution. Please note that the ordering
2462 * guarantee is observed only with respect to @target and on the local
2463 * cpu.
2464 *
2465 * Currently, a queued barrier can't be canceled. This is because
2466 * try_to_grab_pending() can't determine whether the work to be
2467 * grabbed is at the head of the queue and thus can't clear LINKED
2468 * flag of the previous work while there must be a valid next work
2469 * after a work with LINKED flag set.
2470 *
2471 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002472 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002473 *
2474 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002475 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002476 */
Tejun Heo112202d2013-02-13 19:29:12 -08002477static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002478 struct wq_barrier *barr,
2479 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002480{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002481 struct list_head *head;
2482 unsigned int linked = 0;
2483
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002484 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002485 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002486 * as we know for sure that this will not trigger any of the
2487 * checks and call back into the fixup functions where we
2488 * might deadlock.
2489 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002490 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002491 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002492
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002493 init_completion_map(&barr->done, &target->lockdep_map);
2494
Tejun Heo2607d7a2015-03-09 09:22:28 -04002495 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002496
Tejun Heoaffee4b2010-06-29 10:07:12 +02002497 /*
2498 * If @target is currently being executed, schedule the
2499 * barrier to the worker; otherwise, put it after @target.
2500 */
2501 if (worker)
2502 head = worker->scheduled.next;
2503 else {
2504 unsigned long *bits = work_data_bits(target);
2505
2506 head = target->entry.next;
2507 /* there can already be other linked works, inherit and set */
2508 linked = *bits & WORK_STRUCT_LINKED;
2509 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2510 }
2511
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002512 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002513 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002514 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002515}
2516
Tejun Heo73f53c42010-06-29 10:07:11 +02002517/**
Tejun Heo112202d2013-02-13 19:29:12 -08002518 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002519 * @wq: workqueue being flushed
2520 * @flush_color: new flush color, < 0 for no-op
2521 * @work_color: new work color, < 0 for no-op
2522 *
Tejun Heo112202d2013-02-13 19:29:12 -08002523 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002524 *
Tejun Heo112202d2013-02-13 19:29:12 -08002525 * If @flush_color is non-negative, flush_color on all pwqs should be
2526 * -1. If no pwq has in-flight commands at the specified color, all
2527 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2528 * has in flight commands, its pwq->flush_color is set to
2529 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002530 * wakeup logic is armed and %true is returned.
2531 *
2532 * The caller should have initialized @wq->first_flusher prior to
2533 * calling this function with non-negative @flush_color. If
2534 * @flush_color is negative, no flush color update is done and %false
2535 * is returned.
2536 *
Tejun Heo112202d2013-02-13 19:29:12 -08002537 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002538 * work_color which is previous to @work_color and all will be
2539 * advanced to @work_color.
2540 *
2541 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002542 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002543 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002544 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002545 * %true if @flush_color >= 0 and there's something to flush. %false
2546 * otherwise.
2547 */
Tejun Heo112202d2013-02-13 19:29:12 -08002548static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002549 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550{
Tejun Heo73f53c42010-06-29 10:07:11 +02002551 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002552 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002553
Tejun Heo73f53c42010-06-29 10:07:11 +02002554 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002555 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002556 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002557 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002558
Tejun Heo49e3cf42013-03-12 11:29:58 -07002559 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002560 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002561
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002562 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002563
2564 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002565 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002566
Tejun Heo112202d2013-02-13 19:29:12 -08002567 if (pwq->nr_in_flight[flush_color]) {
2568 pwq->flush_color = flush_color;
2569 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002570 wait = true;
2571 }
2572 }
2573
2574 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002575 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002576 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002577 }
2578
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002579 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002580 }
2581
Tejun Heo112202d2013-02-13 19:29:12 -08002582 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002583 complete(&wq->first_flusher->done);
2584
2585 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586}
2587
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002588/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002589 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002590 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002592 * This function sleeps until all work items which were queued on entry
2593 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002595void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002596{
Tejun Heo73f53c42010-06-29 10:07:11 +02002597 struct wq_flusher this_flusher = {
2598 .list = LIST_HEAD_INIT(this_flusher.list),
2599 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002600 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002601 };
2602 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002603
Tejun Heo3347fa02016-09-16 15:49:32 -04002604 if (WARN_ON(!wq_online))
2605 return;
2606
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002607 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002608
2609 /*
2610 * Start-to-wait phase
2611 */
2612 next_color = work_next_color(wq->work_color);
2613
2614 if (next_color != wq->flush_color) {
2615 /*
2616 * Color space is not full. The current work_color
2617 * becomes our flush_color and work_color is advanced
2618 * by one.
2619 */
Tejun Heo6183c002013-03-12 11:29:57 -07002620 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002621 this_flusher.flush_color = wq->work_color;
2622 wq->work_color = next_color;
2623
2624 if (!wq->first_flusher) {
2625 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002626 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002627
2628 wq->first_flusher = &this_flusher;
2629
Tejun Heo112202d2013-02-13 19:29:12 -08002630 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002631 wq->work_color)) {
2632 /* nothing to flush, done */
2633 wq->flush_color = next_color;
2634 wq->first_flusher = NULL;
2635 goto out_unlock;
2636 }
2637 } else {
2638 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002639 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002640 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002641 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002642 }
2643 } else {
2644 /*
2645 * Oops, color space is full, wait on overflow queue.
2646 * The next flush completion will assign us
2647 * flush_color and transfer to flusher_queue.
2648 */
2649 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2650 }
2651
Tejun Heofca839c2015-12-07 10:58:57 -05002652 check_flush_dependency(wq, NULL);
2653
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002654 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002655
2656 wait_for_completion(&this_flusher.done);
2657
2658 /*
2659 * Wake-up-and-cascade phase
2660 *
2661 * First flushers are responsible for cascading flushes and
2662 * handling overflow. Non-first flushers can simply return.
2663 */
2664 if (wq->first_flusher != &this_flusher)
2665 return;
2666
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002667 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002668
Tejun Heo4ce48b32010-07-02 10:03:51 +02002669 /* we might have raced, check again with mutex held */
2670 if (wq->first_flusher != &this_flusher)
2671 goto out_unlock;
2672
Tejun Heo73f53c42010-06-29 10:07:11 +02002673 wq->first_flusher = NULL;
2674
Tejun Heo6183c002013-03-12 11:29:57 -07002675 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2676 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002677
2678 while (true) {
2679 struct wq_flusher *next, *tmp;
2680
2681 /* complete all the flushers sharing the current flush color */
2682 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2683 if (next->flush_color != wq->flush_color)
2684 break;
2685 list_del_init(&next->list);
2686 complete(&next->done);
2687 }
2688
Tejun Heo6183c002013-03-12 11:29:57 -07002689 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2690 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002691
2692 /* this flush_color is finished, advance by one */
2693 wq->flush_color = work_next_color(wq->flush_color);
2694
2695 /* one color has been freed, handle overflow queue */
2696 if (!list_empty(&wq->flusher_overflow)) {
2697 /*
2698 * Assign the same color to all overflowed
2699 * flushers, advance work_color and append to
2700 * flusher_queue. This is the start-to-wait
2701 * phase for these overflowed flushers.
2702 */
2703 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2704 tmp->flush_color = wq->work_color;
2705
2706 wq->work_color = work_next_color(wq->work_color);
2707
2708 list_splice_tail_init(&wq->flusher_overflow,
2709 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002710 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002711 }
2712
2713 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002714 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002715 break;
2716 }
2717
2718 /*
2719 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002720 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002721 */
Tejun Heo6183c002013-03-12 11:29:57 -07002722 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2723 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002724
2725 list_del_init(&next->list);
2726 wq->first_flusher = next;
2727
Tejun Heo112202d2013-02-13 19:29:12 -08002728 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002729 break;
2730
2731 /*
2732 * Meh... this color is already done, clear first
2733 * flusher and repeat cascading.
2734 */
2735 wq->first_flusher = NULL;
2736 }
2737
2738out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002739 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002740}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002741EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002743/**
2744 * drain_workqueue - drain a workqueue
2745 * @wq: workqueue to drain
2746 *
2747 * Wait until the workqueue becomes empty. While draining is in progress,
2748 * only chain queueing is allowed. IOW, only currently pending or running
2749 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002750 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002751 * by the depth of chaining and should be relatively short. Whine if it
2752 * takes too long.
2753 */
2754void drain_workqueue(struct workqueue_struct *wq)
2755{
2756 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002757 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002758
2759 /*
2760 * __queue_work() needs to test whether there are drainers, is much
2761 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002762 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002763 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002764 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002765 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002766 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002767 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002768reflush:
2769 flush_workqueue(wq);
2770
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002771 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002772
Tejun Heo49e3cf42013-03-12 11:29:58 -07002773 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002774 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002775
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002776 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002777 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002778 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002779
2780 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002781 continue;
2782
2783 if (++flush_cnt == 10 ||
2784 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002785 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002786 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002787
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002788 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002789 goto reflush;
2790 }
2791
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002792 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002793 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002794 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002795}
2796EXPORT_SYMBOL_GPL(drain_workqueue);
2797
Tejun Heo606a5022012-08-20 14:51:23 -07002798static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002799{
2800 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002801 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002802 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002803
2804 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002805
Tejun Heofa1b54e2013-03-12 11:30:00 -07002806 local_irq_disable();
2807 pool = get_work_pool(work);
2808 if (!pool) {
2809 local_irq_enable();
2810 return false;
2811 }
2812
2813 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002814 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002815 pwq = get_work_pwq(work);
2816 if (pwq) {
2817 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002818 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002819 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002820 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002821 if (!worker)
2822 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002823 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002824 }
Tejun Heobaf59022010-09-16 10:42:16 +02002825
Tejun Heofca839c2015-12-07 10:58:57 -05002826 check_flush_dependency(pwq->wq, work);
2827
Tejun Heo112202d2013-02-13 19:29:12 -08002828 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002829 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002830
Tejun Heoe159489b2011-01-09 23:32:15 +01002831 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002832 * Force a lock recursion deadlock when using flush_work() inside a
2833 * single-threaded or rescuer equipped workqueue.
2834 *
2835 * For single threaded workqueues the deadlock happens when the work
2836 * is after the work issuing the flush_work(). For rescuer equipped
2837 * workqueues the deadlock happens when the rescuer stalls, blocking
2838 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01002839 */
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002840 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) {
Tejun Heo112202d2013-02-13 19:29:12 -08002841 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002842 lock_map_release(&pwq->wq->lockdep_map);
2843 }
Tejun Heoe159489b2011-01-09 23:32:15 +01002844
Tejun Heobaf59022010-09-16 10:42:16 +02002845 return true;
2846already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002847 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002848 return false;
2849}
2850
Oleg Nesterovdb700892008-07-25 01:47:49 -07002851/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002852 * flush_work - wait for a work to finish executing the last queueing instance
2853 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002854 *
Tejun Heo606a5022012-08-20 14:51:23 -07002855 * Wait until @work has finished execution. @work is guaranteed to be idle
2856 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002857 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002858 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002859 * %true if flush_work() waited for the work to finish execution,
2860 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002861 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002862bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002863{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002864 struct wq_barrier barr;
2865
Tejun Heo3347fa02016-09-16 15:49:32 -04002866 if (WARN_ON(!wq_online))
2867 return false;
2868
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002869 if (start_flush_work(work, &barr)) {
2870 wait_for_completion(&barr.done);
2871 destroy_work_on_stack(&barr.work);
2872 return true;
2873 } else {
2874 return false;
2875 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002876}
2877EXPORT_SYMBOL_GPL(flush_work);
2878
Tejun Heo8603e1b32015-03-05 08:04:13 -05002879struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02002880 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05002881 struct work_struct *work;
2882};
2883
Ingo Molnarac6424b2017-06-20 12:06:13 +02002884static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05002885{
2886 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2887
2888 if (cwait->work != key)
2889 return 0;
2890 return autoremove_wake_function(wait, mode, sync, key);
2891}
2892
Tejun Heo36e227d2012-08-03 10:30:46 -07002893static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002894{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002895 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002896 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002897 int ret;
2898
2899 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002900 ret = try_to_grab_pending(work, is_dwork, &flags);
2901 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002902 * If someone else is already canceling, wait for it to
2903 * finish. flush_work() doesn't work for PREEMPT_NONE
2904 * because we may get scheduled between @work's completion
2905 * and the other canceling task resuming and clearing
2906 * CANCELING - flush_work() will return false immediately
2907 * as @work is no longer busy, try_to_grab_pending() will
2908 * return -ENOENT as @work is still being canceled and the
2909 * other canceling task won't be able to clear CANCELING as
2910 * we're hogging the CPU.
2911 *
2912 * Let's wait for completion using a waitqueue. As this
2913 * may lead to the thundering herd problem, use a custom
2914 * wake function which matches @work along with exclusive
2915 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002916 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002917 if (unlikely(ret == -ENOENT)) {
2918 struct cwt_wait cwait;
2919
2920 init_wait(&cwait.wait);
2921 cwait.wait.func = cwt_wakefn;
2922 cwait.work = work;
2923
2924 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2925 TASK_UNINTERRUPTIBLE);
2926 if (work_is_canceling(work))
2927 schedule();
2928 finish_wait(&cancel_waitq, &cwait.wait);
2929 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002930 } while (unlikely(ret < 0));
2931
Tejun Heobbb68df2012-08-03 10:30:46 -07002932 /* tell other tasks trying to grab @work to back off */
2933 mark_work_canceling(work);
2934 local_irq_restore(flags);
2935
Tejun Heo3347fa02016-09-16 15:49:32 -04002936 /*
2937 * This allows canceling during early boot. We know that @work
2938 * isn't executing.
2939 */
2940 if (wq_online)
2941 flush_work(work);
2942
Tejun Heo7a22ad72010-06-29 10:07:13 +02002943 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002944
2945 /*
2946 * Paired with prepare_to_wait() above so that either
2947 * waitqueue_active() is visible here or !work_is_canceling() is
2948 * visible there.
2949 */
2950 smp_mb();
2951 if (waitqueue_active(&cancel_waitq))
2952 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2953
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002954 return ret;
2955}
2956
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002957/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002958 * cancel_work_sync - cancel a work and wait for it to finish
2959 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002960 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002961 * Cancel @work and wait for its execution to finish. This function
2962 * can be used even if the work re-queues itself or migrates to
2963 * another workqueue. On return from this function, @work is
2964 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002965 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002966 * cancel_work_sync(&delayed_work->work) must not be used for
2967 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002968 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002969 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002970 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002971 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002972 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002973 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002974 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002975bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002976{
Tejun Heo36e227d2012-08-03 10:30:46 -07002977 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002978}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002979EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002980
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002981/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002982 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2983 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002984 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002985 * Delayed timer is cancelled and the pending work is queued for
2986 * immediate execution. Like flush_work(), this function only
2987 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002988 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002989 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002990 * %true if flush_work() waited for the work to finish execution,
2991 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002992 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002993bool flush_delayed_work(struct delayed_work *dwork)
2994{
Tejun Heo8930cab2012-08-03 10:30:45 -07002995 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002996 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002997 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002998 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002999 return flush_work(&dwork->work);
3000}
3001EXPORT_SYMBOL(flush_delayed_work);
3002
Jens Axboef72b8792016-08-24 15:51:50 -06003003static bool __cancel_work(struct work_struct *work, bool is_dwork)
3004{
3005 unsigned long flags;
3006 int ret;
3007
3008 do {
3009 ret = try_to_grab_pending(work, is_dwork, &flags);
3010 } while (unlikely(ret == -EAGAIN));
3011
3012 if (unlikely(ret < 0))
3013 return false;
3014
3015 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3016 local_irq_restore(flags);
3017 return ret;
3018}
3019
3020/*
3021 * See cancel_delayed_work()
3022 */
3023bool cancel_work(struct work_struct *work)
3024{
3025 return __cancel_work(work, false);
3026}
3027
Tejun Heo401a8d02010-09-16 10:36:00 +02003028/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003029 * cancel_delayed_work - cancel a delayed work
3030 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003031 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003032 * Kill off a pending delayed_work.
3033 *
3034 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3035 * pending.
3036 *
3037 * Note:
3038 * The work callback function may still be running on return, unless
3039 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3040 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003041 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003042 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003043 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003044bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003045{
Jens Axboef72b8792016-08-24 15:51:50 -06003046 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003047}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003048EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003049
3050/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003051 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3052 * @dwork: the delayed work cancel
3053 *
3054 * This is cancel_work_sync() for delayed works.
3055 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003056 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003057 * %true if @dwork was pending, %false otherwise.
3058 */
3059bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003060{
Tejun Heo36e227d2012-08-03 10:30:46 -07003061 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003062}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003063EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003065/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003066 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003067 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003068 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003069 * schedule_on_each_cpu() executes @func on each online CPU using the
3070 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003071 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003072 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003073 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003074 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003075 */
David Howells65f27f32006-11-22 14:55:48 +00003076int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003077{
3078 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003079 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003080
Andrew Mortonb6136772006-06-25 05:47:49 -07003081 works = alloc_percpu(struct work_struct);
3082 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003083 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003084
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003085 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003086
Christoph Lameter15316ba2006-01-08 01:00:43 -08003087 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003088 struct work_struct *work = per_cpu_ptr(works, cpu);
3089
3090 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003091 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003092 }
Tejun Heo93981802009-11-17 14:06:20 -08003093
3094 for_each_online_cpu(cpu)
3095 flush_work(per_cpu_ptr(works, cpu));
3096
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003097 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003098 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003099 return 0;
3100}
3101
Alan Sterneef6a7d2010-02-12 17:39:21 +09003102/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003103 * execute_in_process_context - reliably execute the routine with user context
3104 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003105 * @ew: guaranteed storage for the execute work structure (must
3106 * be available when the work executes)
3107 *
3108 * Executes the function immediately if process context is available,
3109 * otherwise schedules the function for delayed execution.
3110 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003111 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003112 * 1 - function was scheduled for execution
3113 */
David Howells65f27f32006-11-22 14:55:48 +00003114int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003115{
3116 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003117 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003118 return 0;
3119 }
3120
David Howells65f27f32006-11-22 14:55:48 +00003121 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003122 schedule_work(&ew->work);
3123
3124 return 1;
3125}
3126EXPORT_SYMBOL_GPL(execute_in_process_context);
3127
Tejun Heo7a4e3442013-03-12 11:30:00 -07003128/**
3129 * free_workqueue_attrs - free a workqueue_attrs
3130 * @attrs: workqueue_attrs to free
3131 *
3132 * Undo alloc_workqueue_attrs().
3133 */
3134void free_workqueue_attrs(struct workqueue_attrs *attrs)
3135{
3136 if (attrs) {
3137 free_cpumask_var(attrs->cpumask);
3138 kfree(attrs);
3139 }
3140}
3141
3142/**
3143 * alloc_workqueue_attrs - allocate a workqueue_attrs
3144 * @gfp_mask: allocation mask to use
3145 *
3146 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003147 * return it.
3148 *
3149 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003150 */
3151struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3152{
3153 struct workqueue_attrs *attrs;
3154
3155 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3156 if (!attrs)
3157 goto fail;
3158 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3159 goto fail;
3160
Tejun Heo13e2e552013-04-01 11:23:31 -07003161 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003162 return attrs;
3163fail:
3164 free_workqueue_attrs(attrs);
3165 return NULL;
3166}
3167
Tejun Heo29c91e92013-03-12 11:30:03 -07003168static void copy_workqueue_attrs(struct workqueue_attrs *to,
3169 const struct workqueue_attrs *from)
3170{
3171 to->nice = from->nice;
3172 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003173 /*
3174 * Unlike hash and equality test, this function doesn't ignore
3175 * ->no_numa as it is used for both pool and wq attrs. Instead,
3176 * get_unbound_pool() explicitly clears ->no_numa after copying.
3177 */
3178 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003179}
3180
Tejun Heo29c91e92013-03-12 11:30:03 -07003181/* hash value of the content of @attr */
3182static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3183{
3184 u32 hash = 0;
3185
3186 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003187 hash = jhash(cpumask_bits(attrs->cpumask),
3188 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003189 return hash;
3190}
3191
3192/* content equality test */
3193static bool wqattrs_equal(const struct workqueue_attrs *a,
3194 const struct workqueue_attrs *b)
3195{
3196 if (a->nice != b->nice)
3197 return false;
3198 if (!cpumask_equal(a->cpumask, b->cpumask))
3199 return false;
3200 return true;
3201}
3202
Tejun Heo7a4e3442013-03-12 11:30:00 -07003203/**
3204 * init_worker_pool - initialize a newly zalloc'd worker_pool
3205 * @pool: worker_pool to initialize
3206 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303207 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003208 *
3209 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003210 * inside @pool proper are initialized and put_unbound_pool() can be called
3211 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003212 */
3213static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003214{
3215 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003216 pool->id = -1;
3217 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003218 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003219 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003220 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003221 INIT_LIST_HEAD(&pool->worklist);
3222 INIT_LIST_HEAD(&pool->idle_list);
3223 hash_init(pool->busy_hash);
3224
Kees Cook32a6c722017-10-16 15:58:25 -07003225 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003226
Kees Cook32a6c722017-10-16 15:58:25 -07003227 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003228
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003229 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003230 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003231
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003232 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003233 INIT_HLIST_NODE(&pool->hash_node);
3234 pool->refcnt = 1;
3235
3236 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003237 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3238 if (!pool->attrs)
3239 return -ENOMEM;
3240 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003241}
3242
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003243static void rcu_free_wq(struct rcu_head *rcu)
3244{
3245 struct workqueue_struct *wq =
3246 container_of(rcu, struct workqueue_struct, rcu);
3247
3248 if (!(wq->flags & WQ_UNBOUND))
3249 free_percpu(wq->cpu_pwqs);
3250 else
3251 free_workqueue_attrs(wq->unbound_attrs);
3252
3253 kfree(wq->rescuer);
3254 kfree(wq);
3255}
3256
Tejun Heo29c91e92013-03-12 11:30:03 -07003257static void rcu_free_pool(struct rcu_head *rcu)
3258{
3259 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3260
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003261 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003262 free_workqueue_attrs(pool->attrs);
3263 kfree(pool);
3264}
3265
3266/**
3267 * put_unbound_pool - put a worker_pool
3268 * @pool: worker_pool to put
3269 *
3270 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003271 * safe manner. get_unbound_pool() calls this function on its failure path
3272 * and this function should be able to release pools which went through,
3273 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003274 *
3275 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003276 */
3277static void put_unbound_pool(struct worker_pool *pool)
3278{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003279 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003280 struct worker *worker;
3281
Tejun Heoa892cac2013-04-01 11:23:32 -07003282 lockdep_assert_held(&wq_pool_mutex);
3283
3284 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003285 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003286
3287 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003288 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003289 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003290 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003291
3292 /* release id and unhash */
3293 if (pool->id >= 0)
3294 idr_remove(&worker_pool_idr, pool->id);
3295 hash_del(&pool->hash_node);
3296
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003297 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003298 * Become the manager and destroy all workers. This prevents
3299 * @pool's workers from blocking on attach_mutex. We're the last
3300 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003301 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003302 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003303 wait_event_lock_irq(wq_manager_wait,
3304 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3305 pool->flags |= POOL_MANAGER_ACTIVE;
3306
Lai Jiangshan1037de32014-05-22 16:44:07 +08003307 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003308 destroy_worker(worker);
3309 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003310 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003311
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003312 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003313 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003314 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003315 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003316
3317 if (pool->detach_completion)
3318 wait_for_completion(pool->detach_completion);
3319
Tejun Heo29c91e92013-03-12 11:30:03 -07003320 /* shut down the timers */
3321 del_timer_sync(&pool->idle_timer);
3322 del_timer_sync(&pool->mayday_timer);
3323
3324 /* sched-RCU protected to allow dereferences from get_work_pool() */
3325 call_rcu_sched(&pool->rcu, rcu_free_pool);
3326}
3327
3328/**
3329 * get_unbound_pool - get a worker_pool with the specified attributes
3330 * @attrs: the attributes of the worker_pool to get
3331 *
3332 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3333 * reference count and return it. If there already is a matching
3334 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003335 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003336 *
3337 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003338 *
3339 * Return: On success, a worker_pool with the same attributes as @attrs.
3340 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003341 */
3342static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3343{
Tejun Heo29c91e92013-03-12 11:30:03 -07003344 u32 hash = wqattrs_hash(attrs);
3345 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003346 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003347 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003348
Tejun Heoa892cac2013-04-01 11:23:32 -07003349 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003350
3351 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003352 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3353 if (wqattrs_equal(pool->attrs, attrs)) {
3354 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003355 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003356 }
3357 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003358
Xunlei Pange22735842015-10-09 11:53:12 +08003359 /* if cpumask is contained inside a NUMA node, we belong to that node */
3360 if (wq_numa_enabled) {
3361 for_each_node(node) {
3362 if (cpumask_subset(attrs->cpumask,
3363 wq_numa_possible_cpumask[node])) {
3364 target_node = node;
3365 break;
3366 }
3367 }
3368 }
3369
Tejun Heo29c91e92013-03-12 11:30:03 -07003370 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003371 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003372 if (!pool || init_worker_pool(pool) < 0)
3373 goto fail;
3374
Tejun Heo8864b4e2013-03-12 11:30:04 -07003375 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003376 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003377 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003378
Shaohua Li2865a8f2013-08-01 09:56:36 +08003379 /*
3380 * no_numa isn't a worker_pool attribute, always clear it. See
3381 * 'struct workqueue_attrs' comments for detail.
3382 */
3383 pool->attrs->no_numa = false;
3384
Tejun Heo29c91e92013-03-12 11:30:03 -07003385 if (worker_pool_assign_id(pool) < 0)
3386 goto fail;
3387
3388 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003389 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003390 goto fail;
3391
Tejun Heo29c91e92013-03-12 11:30:03 -07003392 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003393 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003394
Tejun Heo29c91e92013-03-12 11:30:03 -07003395 return pool;
3396fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003397 if (pool)
3398 put_unbound_pool(pool);
3399 return NULL;
3400}
3401
Tejun Heo8864b4e2013-03-12 11:30:04 -07003402static void rcu_free_pwq(struct rcu_head *rcu)
3403{
3404 kmem_cache_free(pwq_cache,
3405 container_of(rcu, struct pool_workqueue, rcu));
3406}
3407
3408/*
3409 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3410 * and needs to be destroyed.
3411 */
3412static void pwq_unbound_release_workfn(struct work_struct *work)
3413{
3414 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3415 unbound_release_work);
3416 struct workqueue_struct *wq = pwq->wq;
3417 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003418 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003419
3420 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3421 return;
3422
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003423 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003424 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003425 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003426 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003427
Tejun Heoa892cac2013-04-01 11:23:32 -07003428 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003429 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003430 mutex_unlock(&wq_pool_mutex);
3431
Tejun Heo8864b4e2013-03-12 11:30:04 -07003432 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3433
3434 /*
3435 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003436 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003437 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003438 if (is_last)
3439 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003440}
3441
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003442/**
Tejun Heo699ce092013-03-13 16:51:35 -07003443 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003444 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003445 *
Tejun Heo699ce092013-03-13 16:51:35 -07003446 * If @pwq isn't freezing, set @pwq->max_active to the associated
3447 * workqueue's saved_max_active and activate delayed work items
3448 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003449 */
Tejun Heo699ce092013-03-13 16:51:35 -07003450static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003451{
Tejun Heo699ce092013-03-13 16:51:35 -07003452 struct workqueue_struct *wq = pwq->wq;
3453 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003454 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003455
Tejun Heo699ce092013-03-13 16:51:35 -07003456 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003457 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003458
3459 /* fast exit for non-freezable wqs */
3460 if (!freezable && pwq->max_active == wq->saved_max_active)
3461 return;
3462
Tejun Heo3347fa02016-09-16 15:49:32 -04003463 /* this function can be called during early boot w/ irq disabled */
3464 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003465
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003466 /*
3467 * During [un]freezing, the caller is responsible for ensuring that
3468 * this function is called at least once after @workqueue_freezing
3469 * is updated and visible.
3470 */
3471 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003472 pwq->max_active = wq->saved_max_active;
3473
3474 while (!list_empty(&pwq->delayed_works) &&
3475 pwq->nr_active < pwq->max_active)
3476 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003477
3478 /*
3479 * Need to kick a worker after thawed or an unbound wq's
3480 * max_active is bumped. It's a slow path. Do it always.
3481 */
3482 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003483 } else {
3484 pwq->max_active = 0;
3485 }
3486
Tejun Heo3347fa02016-09-16 15:49:32 -04003487 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003488}
3489
Tejun Heoe50aba92013-04-01 11:23:35 -07003490/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003491static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3492 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003493{
3494 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3495
Tejun Heoe50aba92013-04-01 11:23:35 -07003496 memset(pwq, 0, sizeof(*pwq));
3497
Tejun Heod2c1d402013-03-12 11:30:04 -07003498 pwq->pool = pool;
3499 pwq->wq = wq;
3500 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003501 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003502 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003503 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003504 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003505 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003506}
Tejun Heod2c1d402013-03-12 11:30:04 -07003507
Tejun Heof147f292013-04-01 11:23:35 -07003508/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003509static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003510{
3511 struct workqueue_struct *wq = pwq->wq;
3512
3513 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003514
Tejun Heo1befcf32013-04-01 11:23:35 -07003515 /* may be called multiple times, ignore if already linked */
3516 if (!list_empty(&pwq->pwqs_node))
3517 return;
3518
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003519 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003520 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003521
3522 /* sync max_active to the current setting */
3523 pwq_adjust_max_active(pwq);
3524
3525 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003526 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003527}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003528
Tejun Heof147f292013-04-01 11:23:35 -07003529/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3530static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3531 const struct workqueue_attrs *attrs)
3532{
3533 struct worker_pool *pool;
3534 struct pool_workqueue *pwq;
3535
3536 lockdep_assert_held(&wq_pool_mutex);
3537
3538 pool = get_unbound_pool(attrs);
3539 if (!pool)
3540 return NULL;
3541
Tejun Heoe50aba92013-04-01 11:23:35 -07003542 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003543 if (!pwq) {
3544 put_unbound_pool(pool);
3545 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003546 }
Tejun Heo6029a912013-04-01 11:23:34 -07003547
Tejun Heof147f292013-04-01 11:23:35 -07003548 init_pwq(pwq, wq, pool);
3549 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003550}
3551
Tejun Heo4c16bd32013-04-01 11:23:36 -07003552/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003553 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003554 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003555 * @node: the target NUMA node
3556 * @cpu_going_down: if >= 0, the CPU to consider as offline
3557 * @cpumask: outarg, the resulting cpumask
3558 *
3559 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3560 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003561 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003562 *
3563 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3564 * enabled and @node has online CPUs requested by @attrs, the returned
3565 * cpumask is the intersection of the possible CPUs of @node and
3566 * @attrs->cpumask.
3567 *
3568 * The caller is responsible for ensuring that the cpumask of @node stays
3569 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003570 *
3571 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3572 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003573 */
3574static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3575 int cpu_going_down, cpumask_t *cpumask)
3576{
Tejun Heod55262c2013-04-01 11:23:38 -07003577 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003578 goto use_dfl;
3579
3580 /* does @node have any online CPUs @attrs wants? */
3581 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3582 if (cpu_going_down >= 0)
3583 cpumask_clear_cpu(cpu_going_down, cpumask);
3584
3585 if (cpumask_empty(cpumask))
3586 goto use_dfl;
3587
3588 /* yeap, return possible CPUs in @node that @attrs wants */
3589 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003590
3591 if (cpumask_empty(cpumask)) {
3592 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3593 "possible intersect\n");
3594 return false;
3595 }
3596
Tejun Heo4c16bd32013-04-01 11:23:36 -07003597 return !cpumask_equal(cpumask, attrs->cpumask);
3598
3599use_dfl:
3600 cpumask_copy(cpumask, attrs->cpumask);
3601 return false;
3602}
3603
Tejun Heo1befcf32013-04-01 11:23:35 -07003604/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3605static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3606 int node,
3607 struct pool_workqueue *pwq)
3608{
3609 struct pool_workqueue *old_pwq;
3610
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003611 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003612 lockdep_assert_held(&wq->mutex);
3613
3614 /* link_pwq() can handle duplicate calls */
3615 link_pwq(pwq);
3616
3617 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3618 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3619 return old_pwq;
3620}
3621
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003622/* context to store the prepared attrs & pwqs before applying */
3623struct apply_wqattrs_ctx {
3624 struct workqueue_struct *wq; /* target workqueue */
3625 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003626 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003627 struct pool_workqueue *dfl_pwq;
3628 struct pool_workqueue *pwq_tbl[];
3629};
3630
3631/* free the resources after success or abort */
3632static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3633{
3634 if (ctx) {
3635 int node;
3636
3637 for_each_node(node)
3638 put_pwq_unlocked(ctx->pwq_tbl[node]);
3639 put_pwq_unlocked(ctx->dfl_pwq);
3640
3641 free_workqueue_attrs(ctx->attrs);
3642
3643 kfree(ctx);
3644 }
3645}
3646
3647/* allocate the attrs and pwqs for later installation */
3648static struct apply_wqattrs_ctx *
3649apply_wqattrs_prepare(struct workqueue_struct *wq,
3650 const struct workqueue_attrs *attrs)
3651{
3652 struct apply_wqattrs_ctx *ctx;
3653 struct workqueue_attrs *new_attrs, *tmp_attrs;
3654 int node;
3655
3656 lockdep_assert_held(&wq_pool_mutex);
3657
3658 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3659 GFP_KERNEL);
3660
3661 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3662 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3663 if (!ctx || !new_attrs || !tmp_attrs)
3664 goto out_free;
3665
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003666 /*
3667 * Calculate the attrs of the default pwq.
3668 * If the user configured cpumask doesn't overlap with the
3669 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3670 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003671 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003672 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003673 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3674 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003675
3676 /*
3677 * We may create multiple pwqs with differing cpumasks. Make a
3678 * copy of @new_attrs which will be modified and used to obtain
3679 * pools.
3680 */
3681 copy_workqueue_attrs(tmp_attrs, new_attrs);
3682
3683 /*
3684 * If something goes wrong during CPU up/down, we'll fall back to
3685 * the default pwq covering whole @attrs->cpumask. Always create
3686 * it even if we don't use it immediately.
3687 */
3688 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3689 if (!ctx->dfl_pwq)
3690 goto out_free;
3691
3692 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003693 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003694 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3695 if (!ctx->pwq_tbl[node])
3696 goto out_free;
3697 } else {
3698 ctx->dfl_pwq->refcnt++;
3699 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3700 }
3701 }
3702
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003703 /* save the user configured attrs and sanitize it. */
3704 copy_workqueue_attrs(new_attrs, attrs);
3705 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003706 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003707
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003708 ctx->wq = wq;
3709 free_workqueue_attrs(tmp_attrs);
3710 return ctx;
3711
3712out_free:
3713 free_workqueue_attrs(tmp_attrs);
3714 free_workqueue_attrs(new_attrs);
3715 apply_wqattrs_cleanup(ctx);
3716 return NULL;
3717}
3718
3719/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3720static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3721{
3722 int node;
3723
3724 /* all pwqs have been created successfully, let's install'em */
3725 mutex_lock(&ctx->wq->mutex);
3726
3727 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3728
3729 /* save the previous pwq and install the new one */
3730 for_each_node(node)
3731 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3732 ctx->pwq_tbl[node]);
3733
3734 /* @dfl_pwq might not have been used, ensure it's linked */
3735 link_pwq(ctx->dfl_pwq);
3736 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3737
3738 mutex_unlock(&ctx->wq->mutex);
3739}
3740
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003741static void apply_wqattrs_lock(void)
3742{
3743 /* CPUs should stay stable across pwq creations and installations */
3744 get_online_cpus();
3745 mutex_lock(&wq_pool_mutex);
3746}
3747
3748static void apply_wqattrs_unlock(void)
3749{
3750 mutex_unlock(&wq_pool_mutex);
3751 put_online_cpus();
3752}
3753
3754static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3755 const struct workqueue_attrs *attrs)
3756{
3757 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003758
3759 /* only unbound workqueues can change attributes */
3760 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3761 return -EINVAL;
3762
3763 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04003764 if (!list_empty(&wq->pwqs)) {
3765 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3766 return -EINVAL;
3767
3768 wq->flags &= ~__WQ_ORDERED;
3769 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003770
3771 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003772 if (!ctx)
3773 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003774
3775 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003776 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003777 apply_wqattrs_cleanup(ctx);
3778
wanghaibin62011712016-01-07 20:38:59 +08003779 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003780}
3781
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003782/**
3783 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3784 * @wq: the target workqueue
3785 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3786 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003787 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3788 * machines, this function maps a separate pwq to each NUMA node with
3789 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3790 * NUMA node it was issued on. Older pwqs are released as in-flight work
3791 * items finish. Note that a work item which repeatedly requeues itself
3792 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003793 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003794 * Performs GFP_KERNEL allocations.
3795 *
3796 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003797 */
3798int apply_workqueue_attrs(struct workqueue_struct *wq,
3799 const struct workqueue_attrs *attrs)
3800{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003801 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003802
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003803 apply_wqattrs_lock();
3804 ret = apply_workqueue_attrs_locked(wq, attrs);
3805 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003806
Tejun Heo48621252013-04-01 11:23:31 -07003807 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003808}
3809
Tejun Heo4c16bd32013-04-01 11:23:36 -07003810/**
3811 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3812 * @wq: the target workqueue
3813 * @cpu: the CPU coming up or going down
3814 * @online: whether @cpu is coming up or going down
3815 *
3816 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3817 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3818 * @wq accordingly.
3819 *
3820 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3821 * falls back to @wq->dfl_pwq which may not be optimal but is always
3822 * correct.
3823 *
3824 * Note that when the last allowed CPU of a NUMA node goes offline for a
3825 * workqueue with a cpumask spanning multiple nodes, the workers which were
3826 * already executing the work items for the workqueue will lose their CPU
3827 * affinity and may execute on any CPU. This is similar to how per-cpu
3828 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3829 * affinity, it's the user's responsibility to flush the work item from
3830 * CPU_DOWN_PREPARE.
3831 */
3832static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3833 bool online)
3834{
3835 int node = cpu_to_node(cpu);
3836 int cpu_off = online ? -1 : cpu;
3837 struct pool_workqueue *old_pwq = NULL, *pwq;
3838 struct workqueue_attrs *target_attrs;
3839 cpumask_t *cpumask;
3840
3841 lockdep_assert_held(&wq_pool_mutex);
3842
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003843 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3844 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003845 return;
3846
3847 /*
3848 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3849 * Let's use a preallocated one. The following buf is protected by
3850 * CPU hotplug exclusion.
3851 */
3852 target_attrs = wq_update_unbound_numa_attrs_buf;
3853 cpumask = target_attrs->cpumask;
3854
Tejun Heo4c16bd32013-04-01 11:23:36 -07003855 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3856 pwq = unbound_pwq_by_node(wq, node);
3857
3858 /*
3859 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003860 * different from the default pwq's, we need to compare it to @pwq's
3861 * and create a new one if they don't match. If the target cpumask
3862 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003863 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003864 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003865 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003866 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003867 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003868 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003869 }
3870
Tejun Heo4c16bd32013-04-01 11:23:36 -07003871 /* create a new pwq */
3872 pwq = alloc_unbound_pwq(wq, target_attrs);
3873 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003874 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3875 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003876 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003877 }
3878
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003879 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003880 mutex_lock(&wq->mutex);
3881 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3882 goto out_unlock;
3883
3884use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003885 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003886 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3887 get_pwq(wq->dfl_pwq);
3888 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3889 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3890out_unlock:
3891 mutex_unlock(&wq->mutex);
3892 put_pwq_unlocked(old_pwq);
3893}
3894
Tejun Heo30cdf2492013-03-12 11:29:57 -07003895static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003896{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003897 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003898 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003899
Tejun Heo30cdf2492013-03-12 11:29:57 -07003900 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003901 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3902 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07003903 return -ENOMEM;
3904
3905 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003906 struct pool_workqueue *pwq =
3907 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003908 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003909 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003910
Tejun Heof147f292013-04-01 11:23:35 -07003911 init_pwq(pwq, wq, &cpu_pools[highpri]);
3912
3913 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003914 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003915 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003916 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003917 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003918 } else if (wq->flags & __WQ_ORDERED) {
3919 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3920 /* there should only be single pwq for ordering guarantee */
3921 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3922 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3923 "ordering guarantee broken for workqueue %s\n", wq->name);
3924 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07003925 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003926 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003927 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003928}
3929
Tejun Heof3421792010-07-02 10:03:51 +02003930static int wq_clamp_max_active(int max_active, unsigned int flags,
3931 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003932{
Tejun Heof3421792010-07-02 10:03:51 +02003933 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3934
3935 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003936 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3937 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003938
Tejun Heof3421792010-07-02 10:03:51 +02003939 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003940}
3941
Tejun Heob196be82012-01-10 15:11:35 -08003942struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003943 unsigned int flags,
3944 int max_active,
3945 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003946 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003947{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003948 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003949 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003950 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003951 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003952
Tejun Heo5c0338c2017-07-18 18:41:52 -04003953 /*
3954 * Unbound && max_active == 1 used to imply ordered, which is no
3955 * longer the case on NUMA machines due to per-node pools. While
3956 * alloc_ordered_workqueue() is the right way to create an ordered
3957 * workqueue, keep the previous behavior to avoid subtle breakages
3958 * on NUMA.
3959 */
3960 if ((flags & WQ_UNBOUND) && max_active == 1)
3961 flags |= __WQ_ORDERED;
3962
Viresh Kumarcee22a12013-04-08 16:45:40 +05303963 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3964 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3965 flags |= WQ_UNBOUND;
3966
Tejun Heoecf68812013-04-01 11:23:34 -07003967 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003968 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003969 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003970
3971 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003972 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003973 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003974
Tejun Heo6029a912013-04-01 11:23:34 -07003975 if (flags & WQ_UNBOUND) {
3976 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3977 if (!wq->unbound_attrs)
3978 goto err_free_wq;
3979 }
3980
Tejun Heoecf68812013-04-01 11:23:34 -07003981 va_start(args, lock_name);
3982 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003983 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003984
Tejun Heod320c032010-06-29 10:07:14 +02003985 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003986 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003987
Tejun Heob196be82012-01-10 15:11:35 -08003988 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003989 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003990 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003991 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003992 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003993 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003994 INIT_LIST_HEAD(&wq->flusher_queue);
3995 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003996 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003997
Johannes Bergeb13ba82008-01-16 09:51:58 +01003998 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003999 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004000
Tejun Heo30cdf2492013-03-12 11:29:57 -07004001 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004002 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004003
Tejun Heo493008a2013-03-12 11:30:03 -07004004 /*
4005 * Workqueues which may be used during memory reclaim should
4006 * have a rescuer to guarantee forward progress.
4007 */
4008 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004009 struct worker *rescuer;
4010
Lai Jiangshanf7537df2014-07-15 17:24:15 +08004011 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02004012 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004013 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004014
Tejun Heo111c2252013-01-17 17:16:24 -08004015 rescuer->rescue_wq = wq;
4016 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004017 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004018 if (IS_ERR(rescuer->task)) {
4019 kfree(rescuer);
4020 goto err_destroy;
4021 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004022
Tejun Heod2c1d402013-03-12 11:30:04 -07004023 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02004024 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02004025 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004026 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004027
Tejun Heo226223a2013-03-12 11:30:05 -07004028 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4029 goto err_destroy;
4030
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004031 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004032 * wq_pool_mutex protects global freeze state and workqueues list.
4033 * Grab it, adjust max_active and add the new @wq to workqueues
4034 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004035 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004036 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004037
Lai Jiangshana357fc02013-03-25 16:57:19 -07004038 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004039 for_each_pwq(pwq, wq)
4040 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004041 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004042
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004043 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004044
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004045 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004046
Oleg Nesterov3af244332007-05-09 02:34:09 -07004047 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004048
4049err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004050 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004051 kfree(wq);
4052 return NULL;
4053err_destroy:
4054 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004055 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004056}
Tejun Heod320c032010-06-29 10:07:14 +02004057EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004058
4059/**
4060 * destroy_workqueue - safely terminate a workqueue
4061 * @wq: target workqueue
4062 *
4063 * Safely destroy a workqueue. All work currently pending will be done first.
4064 */
4065void destroy_workqueue(struct workqueue_struct *wq)
4066{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004067 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004068 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004069
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004070 /* drain it before proceeding with destruction */
4071 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004072
Tejun Heo6183c002013-03-12 11:29:57 -07004073 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004074 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004075 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004076 int i;
4077
Tejun Heo76af4d92013-03-12 11:30:00 -07004078 for (i = 0; i < WORK_NR_COLORS; i++) {
4079 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004080 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004081 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004082 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004083 }
4084 }
4085
Lai Jiangshan5c529592013-04-04 10:05:38 +08004086 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004087 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004088 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004089 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004090 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004091 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004092 }
Tejun Heo6183c002013-03-12 11:29:57 -07004093 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004094 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004095
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004096 /*
4097 * wq list is used to freeze wq, remove from list after
4098 * flushing is complete in case freeze races us.
4099 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004100 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004101 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004102 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004103
Tejun Heo226223a2013-03-12 11:30:05 -07004104 workqueue_sysfs_unregister(wq);
4105
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004106 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004107 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004108
Tejun Heo8864b4e2013-03-12 11:30:04 -07004109 if (!(wq->flags & WQ_UNBOUND)) {
4110 /*
4111 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004112 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004113 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004114 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004115 } else {
4116 /*
4117 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004118 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4119 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004120 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004121 for_each_node(node) {
4122 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4123 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4124 put_pwq_unlocked(pwq);
4125 }
4126
4127 /*
4128 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4129 * put. Don't access it afterwards.
4130 */
4131 pwq = wq->dfl_pwq;
4132 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004133 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004134 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004135}
4136EXPORT_SYMBOL_GPL(destroy_workqueue);
4137
Tejun Heodcd989c2010-06-29 10:07:14 +02004138/**
4139 * workqueue_set_max_active - adjust max_active of a workqueue
4140 * @wq: target workqueue
4141 * @max_active: new max_active value.
4142 *
4143 * Set max_active of @wq to @max_active.
4144 *
4145 * CONTEXT:
4146 * Don't call from IRQ context.
4147 */
4148void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4149{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004150 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004151
Tejun Heo8719dce2013-03-12 11:30:04 -07004152 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004153 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004154 return;
4155
Tejun Heof3421792010-07-02 10:03:51 +02004156 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004157
Lai Jiangshana357fc02013-03-25 16:57:19 -07004158 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004159
Tejun Heo0a94efb2017-07-23 08:36:15 -04004160 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004161 wq->saved_max_active = max_active;
4162
Tejun Heo699ce092013-03-13 16:51:35 -07004163 for_each_pwq(pwq, wq)
4164 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004165
Lai Jiangshana357fc02013-03-25 16:57:19 -07004166 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004167}
4168EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4169
4170/**
Tejun Heoe62676162013-03-12 17:41:37 -07004171 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4172 *
4173 * Determine whether %current is a workqueue rescuer. Can be used from
4174 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004175 *
4176 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004177 */
4178bool current_is_workqueue_rescuer(void)
4179{
4180 struct worker *worker = current_wq_worker();
4181
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004182 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004183}
4184
4185/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004186 * workqueue_congested - test whether a workqueue is congested
4187 * @cpu: CPU in question
4188 * @wq: target workqueue
4189 *
4190 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4191 * no synchronization around this function and the test result is
4192 * unreliable and only useful as advisory hints or for debugging.
4193 *
Tejun Heod3251852013-05-10 11:10:17 -07004194 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4195 * Note that both per-cpu and unbound workqueues may be associated with
4196 * multiple pool_workqueues which have separate congested states. A
4197 * workqueue being congested on one CPU doesn't mean the workqueue is also
4198 * contested on other CPUs / NUMA nodes.
4199 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004200 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004201 * %true if congested, %false otherwise.
4202 */
Tejun Heod84ff052013-03-12 11:29:59 -07004203bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004204{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004205 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004206 bool ret;
4207
Lai Jiangshan88109452013-03-20 03:28:10 +08004208 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004209
Tejun Heod3251852013-05-10 11:10:17 -07004210 if (cpu == WORK_CPU_UNBOUND)
4211 cpu = smp_processor_id();
4212
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004213 if (!(wq->flags & WQ_UNBOUND))
4214 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4215 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004216 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004217
Tejun Heo76af4d92013-03-12 11:30:00 -07004218 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004219 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004220
4221 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004222}
4223EXPORT_SYMBOL_GPL(workqueue_congested);
4224
4225/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004226 * work_busy - test whether a work is currently pending or running
4227 * @work: the work to be tested
4228 *
4229 * Test whether @work is currently pending or running. There is no
4230 * synchronization around this function and the test result is
4231 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004232 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004233 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004234 * OR'd bitmask of WORK_BUSY_* bits.
4235 */
4236unsigned int work_busy(struct work_struct *work)
4237{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004238 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004239 unsigned long flags;
4240 unsigned int ret = 0;
4241
Tejun Heodcd989c2010-06-29 10:07:14 +02004242 if (work_pending(work))
4243 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004244
Tejun Heofa1b54e2013-03-12 11:30:00 -07004245 local_irq_save(flags);
4246 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004247 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004248 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004249 if (find_worker_executing_work(pool, work))
4250 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004251 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004252 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004253 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004254
4255 return ret;
4256}
4257EXPORT_SYMBOL_GPL(work_busy);
4258
Tejun Heo3d1cb202013-04-30 15:27:22 -07004259/**
4260 * set_worker_desc - set description for the current work item
4261 * @fmt: printf-style format string
4262 * @...: arguments for the format string
4263 *
4264 * This function can be called by a running work function to describe what
4265 * the work item is about. If the worker task gets dumped, this
4266 * information will be printed out together to help debugging. The
4267 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4268 */
4269void set_worker_desc(const char *fmt, ...)
4270{
4271 struct worker *worker = current_wq_worker();
4272 va_list args;
4273
4274 if (worker) {
4275 va_start(args, fmt);
4276 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4277 va_end(args);
4278 worker->desc_valid = true;
4279 }
4280}
4281
4282/**
4283 * print_worker_info - print out worker information and description
4284 * @log_lvl: the log level to use when printing
4285 * @task: target task
4286 *
4287 * If @task is a worker and currently executing a work item, print out the
4288 * name of the workqueue being serviced and worker description set with
4289 * set_worker_desc() by the currently executing work item.
4290 *
4291 * This function can be safely called on any task as long as the
4292 * task_struct itself is accessible. While safe, this function isn't
4293 * synchronized and may print out mixups or garbages of limited length.
4294 */
4295void print_worker_info(const char *log_lvl, struct task_struct *task)
4296{
4297 work_func_t *fn = NULL;
4298 char name[WQ_NAME_LEN] = { };
4299 char desc[WORKER_DESC_LEN] = { };
4300 struct pool_workqueue *pwq = NULL;
4301 struct workqueue_struct *wq = NULL;
4302 bool desc_valid = false;
4303 struct worker *worker;
4304
4305 if (!(task->flags & PF_WQ_WORKER))
4306 return;
4307
4308 /*
4309 * This function is called without any synchronization and @task
4310 * could be in any state. Be careful with dereferences.
4311 */
Petr Mladeke7005912016-10-11 13:55:17 -07004312 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004313
4314 /*
4315 * Carefully copy the associated workqueue's workfn and name. Keep
4316 * the original last '\0' in case the original contains garbage.
4317 */
4318 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4319 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4320 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4321 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4322
4323 /* copy worker description */
4324 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4325 if (desc_valid)
4326 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4327
4328 if (fn || name[0] || desc[0]) {
4329 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4330 if (desc[0])
4331 pr_cont(" (%s)", desc);
4332 pr_cont("\n");
4333 }
4334}
4335
Tejun Heo3494fc32015-03-09 09:22:28 -04004336static void pr_cont_pool_info(struct worker_pool *pool)
4337{
4338 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4339 if (pool->node != NUMA_NO_NODE)
4340 pr_cont(" node=%d", pool->node);
4341 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4342}
4343
4344static void pr_cont_work(bool comma, struct work_struct *work)
4345{
4346 if (work->func == wq_barrier_func) {
4347 struct wq_barrier *barr;
4348
4349 barr = container_of(work, struct wq_barrier, work);
4350
4351 pr_cont("%s BAR(%d)", comma ? "," : "",
4352 task_pid_nr(barr->task));
4353 } else {
4354 pr_cont("%s %pf", comma ? "," : "", work->func);
4355 }
4356}
4357
4358static void show_pwq(struct pool_workqueue *pwq)
4359{
4360 struct worker_pool *pool = pwq->pool;
4361 struct work_struct *work;
4362 struct worker *worker;
4363 bool has_in_flight = false, has_pending = false;
4364 int bkt;
4365
4366 pr_info(" pwq %d:", pool->id);
4367 pr_cont_pool_info(pool);
4368
4369 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4370 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4371
4372 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4373 if (worker->current_pwq == pwq) {
4374 has_in_flight = true;
4375 break;
4376 }
4377 }
4378 if (has_in_flight) {
4379 bool comma = false;
4380
4381 pr_info(" in-flight:");
4382 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4383 if (worker->current_pwq != pwq)
4384 continue;
4385
4386 pr_cont("%s %d%s:%pf", comma ? "," : "",
4387 task_pid_nr(worker->task),
4388 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4389 worker->current_func);
4390 list_for_each_entry(work, &worker->scheduled, entry)
4391 pr_cont_work(false, work);
4392 comma = true;
4393 }
4394 pr_cont("\n");
4395 }
4396
4397 list_for_each_entry(work, &pool->worklist, entry) {
4398 if (get_work_pwq(work) == pwq) {
4399 has_pending = true;
4400 break;
4401 }
4402 }
4403 if (has_pending) {
4404 bool comma = false;
4405
4406 pr_info(" pending:");
4407 list_for_each_entry(work, &pool->worklist, entry) {
4408 if (get_work_pwq(work) != pwq)
4409 continue;
4410
4411 pr_cont_work(comma, work);
4412 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4413 }
4414 pr_cont("\n");
4415 }
4416
4417 if (!list_empty(&pwq->delayed_works)) {
4418 bool comma = false;
4419
4420 pr_info(" delayed:");
4421 list_for_each_entry(work, &pwq->delayed_works, entry) {
4422 pr_cont_work(comma, work);
4423 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4424 }
4425 pr_cont("\n");
4426 }
4427}
4428
4429/**
4430 * show_workqueue_state - dump workqueue state
4431 *
Roger Lu7b776af2016-07-01 11:05:02 +08004432 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4433 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004434 */
4435void show_workqueue_state(void)
4436{
4437 struct workqueue_struct *wq;
4438 struct worker_pool *pool;
4439 unsigned long flags;
4440 int pi;
4441
4442 rcu_read_lock_sched();
4443
4444 pr_info("Showing busy workqueues and worker pools:\n");
4445
4446 list_for_each_entry_rcu(wq, &workqueues, list) {
4447 struct pool_workqueue *pwq;
4448 bool idle = true;
4449
4450 for_each_pwq(pwq, wq) {
4451 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4452 idle = false;
4453 break;
4454 }
4455 }
4456 if (idle)
4457 continue;
4458
4459 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4460
4461 for_each_pwq(pwq, wq) {
4462 spin_lock_irqsave(&pwq->pool->lock, flags);
4463 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4464 show_pwq(pwq);
4465 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4466 }
4467 }
4468
4469 for_each_pool(pool, pi) {
4470 struct worker *worker;
4471 bool first = true;
4472
4473 spin_lock_irqsave(&pool->lock, flags);
4474 if (pool->nr_workers == pool->nr_idle)
4475 goto next_pool;
4476
4477 pr_info("pool %d:", pool->id);
4478 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004479 pr_cont(" hung=%us workers=%d",
4480 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4481 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004482 if (pool->manager)
4483 pr_cont(" manager: %d",
4484 task_pid_nr(pool->manager->task));
4485 list_for_each_entry(worker, &pool->idle_list, entry) {
4486 pr_cont(" %s%d", first ? "idle: " : "",
4487 task_pid_nr(worker->task));
4488 first = false;
4489 }
4490 pr_cont("\n");
4491 next_pool:
4492 spin_unlock_irqrestore(&pool->lock, flags);
4493 }
4494
4495 rcu_read_unlock_sched();
4496}
4497
Tejun Heodb7bccf2010-06-29 10:07:12 +02004498/*
4499 * CPU hotplug.
4500 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004501 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004502 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004503 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004504 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004505 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004506 * blocked draining impractical.
4507 *
Tejun Heo24647572013-01-24 11:01:33 -08004508 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004509 * running as an unbound one and allowing it to be reattached later if the
4510 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004511 */
4512
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004513static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004514{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004515 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004516 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004517
Tejun Heof02ae732013-03-12 11:30:03 -07004518 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004519 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004520 spin_lock_irq(&pool->lock);
4521
4522 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004523 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004524 * unbound and set DISASSOCIATED. Before this, all workers
4525 * except for the ones which are still executing works from
4526 * before the last CPU down must be on the cpu. After
4527 * this, they may become diasporas.
4528 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004529 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004530 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004531
Tejun Heo24647572013-01-24 11:01:33 -08004532 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004533
Tejun Heo94cf58b2013-01-24 11:01:33 -08004534 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004535 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004536
Lai Jiangshaneb283422013-03-08 15:18:28 -08004537 /*
4538 * Call schedule() so that we cross rq->lock and thus can
4539 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4540 * This is necessary as scheduler callbacks may be invoked
4541 * from other cpus.
4542 */
4543 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004544
Lai Jiangshaneb283422013-03-08 15:18:28 -08004545 /*
4546 * Sched callbacks are disabled now. Zap nr_running.
4547 * After this, nr_running stays zero and need_more_worker()
4548 * and keep_working() are always true as long as the
4549 * worklist is not empty. This pool now behaves as an
4550 * unbound (in terms of concurrency management) pool which
4551 * are served by workers tied to the pool.
4552 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004553 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004554
4555 /*
4556 * With concurrency management just turned off, a busy
4557 * worker blocking could lead to lengthy stalls. Kick off
4558 * unbound chain execution of currently pending work items.
4559 */
4560 spin_lock_irq(&pool->lock);
4561 wake_up_worker(pool);
4562 spin_unlock_irq(&pool->lock);
4563 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004564}
4565
Tejun Heobd7c0892013-03-19 13:45:21 -07004566/**
4567 * rebind_workers - rebind all workers of a pool to the associated CPU
4568 * @pool: pool of interest
4569 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004570 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004571 */
4572static void rebind_workers(struct worker_pool *pool)
4573{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004574 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004575
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004576 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004577
Tejun Heoa9ab7752013-03-19 13:45:21 -07004578 /*
4579 * Restore CPU affinity of all workers. As all idle workers should
4580 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304581 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004582 * of all workers first and then clear UNBOUND. As we're called
4583 * from CPU_ONLINE, the following shouldn't fail.
4584 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004585 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004586 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4587 pool->attrs->cpumask) < 0);
4588
4589 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004590
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004591 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004592
Lai Jiangshanda028462014-05-20 17:46:31 +08004593 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004594 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004595
4596 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004597 * A bound idle worker should actually be on the runqueue
4598 * of the associated CPU for local wake-ups targeting it to
4599 * work. Kick all idle workers so that they migrate to the
4600 * associated CPU. Doing this in the same loop as
4601 * replacing UNBOUND with REBOUND is safe as no worker will
4602 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004603 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004604 if (worker_flags & WORKER_IDLE)
4605 wake_up_process(worker->task);
4606
4607 /*
4608 * We want to clear UNBOUND but can't directly call
4609 * worker_clr_flags() or adjust nr_running. Atomically
4610 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4611 * @worker will clear REBOUND using worker_clr_flags() when
4612 * it initiates the next execution cycle thus restoring
4613 * concurrency management. Note that when or whether
4614 * @worker clears REBOUND doesn't affect correctness.
4615 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004616 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004617 * tested without holding any lock in
4618 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4619 * fail incorrectly leading to premature concurrency
4620 * management operations.
4621 */
4622 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4623 worker_flags |= WORKER_REBOUND;
4624 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004625 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004626 }
4627
Tejun Heoa9ab7752013-03-19 13:45:21 -07004628 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004629}
4630
Tejun Heo7dbc7252013-03-19 13:45:21 -07004631/**
4632 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4633 * @pool: unbound pool of interest
4634 * @cpu: the CPU which is coming up
4635 *
4636 * An unbound pool may end up with a cpumask which doesn't have any online
4637 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4638 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4639 * online CPU before, cpus_allowed of all its workers should be restored.
4640 */
4641static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4642{
4643 static cpumask_t cpumask;
4644 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004645
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004646 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004647
4648 /* is @cpu allowed for @pool? */
4649 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4650 return;
4651
Tejun Heo7dbc7252013-03-19 13:45:21 -07004652 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004653
4654 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004655 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004656 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004657}
4658
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004659int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004660{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004661 struct worker_pool *pool;
4662
4663 for_each_cpu_worker_pool(pool, cpu) {
4664 if (pool->nr_workers)
4665 continue;
4666 if (!create_worker(pool))
4667 return -ENOMEM;
4668 }
4669 return 0;
4670}
4671
4672int workqueue_online_cpu(unsigned int cpu)
4673{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004674 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004675 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004676 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004677
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004678 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004679
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004680 for_each_pool(pool, pi) {
4681 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004682
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004683 if (pool->cpu == cpu)
4684 rebind_workers(pool);
4685 else if (pool->cpu < 0)
4686 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004687
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004688 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004689 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004690
4691 /* update NUMA affinity of unbound workqueues */
4692 list_for_each_entry(wq, &workqueues, list)
4693 wq_update_unbound_numa(wq, cpu, true);
4694
4695 mutex_unlock(&wq_pool_mutex);
4696 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004697}
4698
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004699int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004700{
Tejun Heo4c16bd32013-04-01 11:23:36 -07004701 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004702
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004703 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004704 if (WARN_ON(cpu != smp_processor_id()))
4705 return -1;
4706
4707 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004708
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004709 /* update NUMA affinity of unbound workqueues */
4710 mutex_lock(&wq_pool_mutex);
4711 list_for_each_entry(wq, &workqueues, list)
4712 wq_update_unbound_numa(wq, cpu, false);
4713 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004714
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004715 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004716}
4717
Rusty Russell2d3854a2008-11-05 13:39:10 +11004718#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004719
Rusty Russell2d3854a2008-11-05 13:39:10 +11004720struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004721 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004722 long (*fn)(void *);
4723 void *arg;
4724 long ret;
4725};
4726
Tejun Heoed48ece2012-09-18 12:48:43 -07004727static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004728{
Tejun Heoed48ece2012-09-18 12:48:43 -07004729 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4730
Rusty Russell2d3854a2008-11-05 13:39:10 +11004731 wfc->ret = wfc->fn(wfc->arg);
4732}
4733
4734/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004735 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004736 * @cpu: the cpu to run on
4737 * @fn: the function to run
4738 * @arg: the function arg
4739 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004740 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004741 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004742 *
4743 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004744 */
Tejun Heod84ff052013-03-12 11:29:59 -07004745long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004746{
Tejun Heoed48ece2012-09-18 12:48:43 -07004747 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004748
Tejun Heoed48ece2012-09-18 12:48:43 -07004749 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4750 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004751 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004752 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004753 return wfc.ret;
4754}
4755EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02004756
4757/**
4758 * work_on_cpu_safe - run a function in thread context on a particular cpu
4759 * @cpu: the cpu to run on
4760 * @fn: the function to run
4761 * @arg: the function argument
4762 *
4763 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4764 * any locks which would prevent @fn from completing.
4765 *
4766 * Return: The value @fn returns.
4767 */
4768long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
4769{
4770 long ret = -ENODEV;
4771
4772 get_online_cpus();
4773 if (cpu_online(cpu))
4774 ret = work_on_cpu(cpu, fn, arg);
4775 put_online_cpus();
4776 return ret;
4777}
4778EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004779#endif /* CONFIG_SMP */
4780
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004781#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304782
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004783/**
4784 * freeze_workqueues_begin - begin freezing workqueues
4785 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004786 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004787 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004788 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004789 *
4790 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004791 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004792 */
4793void freeze_workqueues_begin(void)
4794{
Tejun Heo24b8a842013-03-12 11:29:58 -07004795 struct workqueue_struct *wq;
4796 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004797
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004798 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004799
Tejun Heo6183c002013-03-12 11:29:57 -07004800 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004801 workqueue_freezing = true;
4802
Tejun Heo24b8a842013-03-12 11:29:58 -07004803 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004804 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004805 for_each_pwq(pwq, wq)
4806 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004807 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004808 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004809
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004810 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004811}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004812
4813/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004814 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004815 *
4816 * Check whether freezing is complete. This function must be called
4817 * between freeze_workqueues_begin() and thaw_workqueues().
4818 *
4819 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004820 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004821 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004822 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004823 * %true if some freezable workqueues are still busy. %false if freezing
4824 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004825 */
4826bool freeze_workqueues_busy(void)
4827{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004828 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004829 struct workqueue_struct *wq;
4830 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004831
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004832 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004833
Tejun Heo6183c002013-03-12 11:29:57 -07004834 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004835
Tejun Heo24b8a842013-03-12 11:29:58 -07004836 list_for_each_entry(wq, &workqueues, list) {
4837 if (!(wq->flags & WQ_FREEZABLE))
4838 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004839 /*
4840 * nr_active is monotonically decreasing. It's safe
4841 * to peek without lock.
4842 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004843 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004844 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004845 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004846 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004847 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004848 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004849 goto out_unlock;
4850 }
4851 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004852 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004853 }
4854out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004855 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004856 return busy;
4857}
4858
4859/**
4860 * thaw_workqueues - thaw workqueues
4861 *
4862 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004863 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004864 *
4865 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004866 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004867 */
4868void thaw_workqueues(void)
4869{
Tejun Heo24b8a842013-03-12 11:29:58 -07004870 struct workqueue_struct *wq;
4871 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004872
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004873 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004874
4875 if (!workqueue_freezing)
4876 goto out_unlock;
4877
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004878 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004879
Tejun Heo24b8a842013-03-12 11:29:58 -07004880 /* restore max_active and repopulate worklist */
4881 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004882 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004883 for_each_pwq(pwq, wq)
4884 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004885 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004886 }
4887
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004888out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004889 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004890}
4891#endif /* CONFIG_FREEZER */
4892
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004893static int workqueue_apply_unbound_cpumask(void)
4894{
4895 LIST_HEAD(ctxs);
4896 int ret = 0;
4897 struct workqueue_struct *wq;
4898 struct apply_wqattrs_ctx *ctx, *n;
4899
4900 lockdep_assert_held(&wq_pool_mutex);
4901
4902 list_for_each_entry(wq, &workqueues, list) {
4903 if (!(wq->flags & WQ_UNBOUND))
4904 continue;
4905 /* creating multiple pwqs breaks ordering guarantee */
4906 if (wq->flags & __WQ_ORDERED)
4907 continue;
4908
4909 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4910 if (!ctx) {
4911 ret = -ENOMEM;
4912 break;
4913 }
4914
4915 list_add_tail(&ctx->list, &ctxs);
4916 }
4917
4918 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4919 if (!ret)
4920 apply_wqattrs_commit(ctx);
4921 apply_wqattrs_cleanup(ctx);
4922 }
4923
4924 return ret;
4925}
4926
4927/**
4928 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4929 * @cpumask: the cpumask to set
4930 *
4931 * The low-level workqueues cpumask is a global cpumask that limits
4932 * the affinity of all unbound workqueues. This function check the @cpumask
4933 * and apply it to all unbound workqueues and updates all pwqs of them.
4934 *
4935 * Retun: 0 - Success
4936 * -EINVAL - Invalid @cpumask
4937 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4938 */
4939int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4940{
4941 int ret = -EINVAL;
4942 cpumask_var_t saved_cpumask;
4943
4944 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4945 return -ENOMEM;
4946
Tal Shorerc98a9802017-11-03 17:27:50 +02004947 /*
4948 * Not excluding isolated cpus on purpose.
4949 * If the user wishes to include them, we allow that.
4950 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004951 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4952 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004953 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004954
4955 /* save the old wq_unbound_cpumask. */
4956 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4957
4958 /* update wq_unbound_cpumask at first and apply it to wqs. */
4959 cpumask_copy(wq_unbound_cpumask, cpumask);
4960 ret = workqueue_apply_unbound_cpumask();
4961
4962 /* restore the wq_unbound_cpumask when failed. */
4963 if (ret < 0)
4964 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4965
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004966 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004967 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004968
4969 free_cpumask_var(saved_cpumask);
4970 return ret;
4971}
4972
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004973#ifdef CONFIG_SYSFS
4974/*
4975 * Workqueues with WQ_SYSFS flag set is visible to userland via
4976 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4977 * following attributes.
4978 *
4979 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4980 * max_active RW int : maximum number of in-flight work items
4981 *
4982 * Unbound workqueues have the following extra attributes.
4983 *
Wang Long9a19b462017-11-02 23:05:12 -04004984 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004985 * nice RW int : nice value of the workers
4986 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04004987 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004988 */
4989struct wq_device {
4990 struct workqueue_struct *wq;
4991 struct device dev;
4992};
4993
4994static struct workqueue_struct *dev_to_wq(struct device *dev)
4995{
4996 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
4997
4998 return wq_dev->wq;
4999}
5000
5001static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5002 char *buf)
5003{
5004 struct workqueue_struct *wq = dev_to_wq(dev);
5005
5006 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5007}
5008static DEVICE_ATTR_RO(per_cpu);
5009
5010static ssize_t max_active_show(struct device *dev,
5011 struct device_attribute *attr, char *buf)
5012{
5013 struct workqueue_struct *wq = dev_to_wq(dev);
5014
5015 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5016}
5017
5018static ssize_t max_active_store(struct device *dev,
5019 struct device_attribute *attr, const char *buf,
5020 size_t count)
5021{
5022 struct workqueue_struct *wq = dev_to_wq(dev);
5023 int val;
5024
5025 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5026 return -EINVAL;
5027
5028 workqueue_set_max_active(wq, val);
5029 return count;
5030}
5031static DEVICE_ATTR_RW(max_active);
5032
5033static struct attribute *wq_sysfs_attrs[] = {
5034 &dev_attr_per_cpu.attr,
5035 &dev_attr_max_active.attr,
5036 NULL,
5037};
5038ATTRIBUTE_GROUPS(wq_sysfs);
5039
5040static ssize_t wq_pool_ids_show(struct device *dev,
5041 struct device_attribute *attr, char *buf)
5042{
5043 struct workqueue_struct *wq = dev_to_wq(dev);
5044 const char *delim = "";
5045 int node, written = 0;
5046
5047 rcu_read_lock_sched();
5048 for_each_node(node) {
5049 written += scnprintf(buf + written, PAGE_SIZE - written,
5050 "%s%d:%d", delim, node,
5051 unbound_pwq_by_node(wq, node)->pool->id);
5052 delim = " ";
5053 }
5054 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5055 rcu_read_unlock_sched();
5056
5057 return written;
5058}
5059
5060static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5061 char *buf)
5062{
5063 struct workqueue_struct *wq = dev_to_wq(dev);
5064 int written;
5065
5066 mutex_lock(&wq->mutex);
5067 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5068 mutex_unlock(&wq->mutex);
5069
5070 return written;
5071}
5072
5073/* prepare workqueue_attrs for sysfs store operations */
5074static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5075{
5076 struct workqueue_attrs *attrs;
5077
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005078 lockdep_assert_held(&wq_pool_mutex);
5079
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005080 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5081 if (!attrs)
5082 return NULL;
5083
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005084 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005085 return attrs;
5086}
5087
5088static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5089 const char *buf, size_t count)
5090{
5091 struct workqueue_struct *wq = dev_to_wq(dev);
5092 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005093 int ret = -ENOMEM;
5094
5095 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005096
5097 attrs = wq_sysfs_prep_attrs(wq);
5098 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005099 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005100
5101 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5102 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005103 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005104 else
5105 ret = -EINVAL;
5106
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005107out_unlock:
5108 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005109 free_workqueue_attrs(attrs);
5110 return ret ?: count;
5111}
5112
5113static ssize_t wq_cpumask_show(struct device *dev,
5114 struct device_attribute *attr, char *buf)
5115{
5116 struct workqueue_struct *wq = dev_to_wq(dev);
5117 int written;
5118
5119 mutex_lock(&wq->mutex);
5120 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5121 cpumask_pr_args(wq->unbound_attrs->cpumask));
5122 mutex_unlock(&wq->mutex);
5123 return written;
5124}
5125
5126static ssize_t wq_cpumask_store(struct device *dev,
5127 struct device_attribute *attr,
5128 const char *buf, size_t count)
5129{
5130 struct workqueue_struct *wq = dev_to_wq(dev);
5131 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005132 int ret = -ENOMEM;
5133
5134 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005135
5136 attrs = wq_sysfs_prep_attrs(wq);
5137 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005138 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005139
5140 ret = cpumask_parse(buf, attrs->cpumask);
5141 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005142 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005143
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005144out_unlock:
5145 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005146 free_workqueue_attrs(attrs);
5147 return ret ?: count;
5148}
5149
5150static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5151 char *buf)
5152{
5153 struct workqueue_struct *wq = dev_to_wq(dev);
5154 int written;
5155
5156 mutex_lock(&wq->mutex);
5157 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5158 !wq->unbound_attrs->no_numa);
5159 mutex_unlock(&wq->mutex);
5160
5161 return written;
5162}
5163
5164static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5165 const char *buf, size_t count)
5166{
5167 struct workqueue_struct *wq = dev_to_wq(dev);
5168 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005169 int v, ret = -ENOMEM;
5170
5171 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005172
5173 attrs = wq_sysfs_prep_attrs(wq);
5174 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005175 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005176
5177 ret = -EINVAL;
5178 if (sscanf(buf, "%d", &v) == 1) {
5179 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005180 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005181 }
5182
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005183out_unlock:
5184 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005185 free_workqueue_attrs(attrs);
5186 return ret ?: count;
5187}
5188
5189static struct device_attribute wq_sysfs_unbound_attrs[] = {
5190 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5191 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5192 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5193 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5194 __ATTR_NULL,
5195};
5196
5197static struct bus_type wq_subsys = {
5198 .name = "workqueue",
5199 .dev_groups = wq_sysfs_groups,
5200};
5201
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005202static ssize_t wq_unbound_cpumask_show(struct device *dev,
5203 struct device_attribute *attr, char *buf)
5204{
5205 int written;
5206
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005207 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005208 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5209 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005210 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005211
5212 return written;
5213}
5214
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005215static ssize_t wq_unbound_cpumask_store(struct device *dev,
5216 struct device_attribute *attr, const char *buf, size_t count)
5217{
5218 cpumask_var_t cpumask;
5219 int ret;
5220
5221 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5222 return -ENOMEM;
5223
5224 ret = cpumask_parse(buf, cpumask);
5225 if (!ret)
5226 ret = workqueue_set_unbound_cpumask(cpumask);
5227
5228 free_cpumask_var(cpumask);
5229 return ret ? ret : count;
5230}
5231
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005232static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005233 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5234 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005235
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005236static int __init wq_sysfs_init(void)
5237{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005238 int err;
5239
5240 err = subsys_virtual_register(&wq_subsys, NULL);
5241 if (err)
5242 return err;
5243
5244 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005245}
5246core_initcall(wq_sysfs_init);
5247
5248static void wq_device_release(struct device *dev)
5249{
5250 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5251
5252 kfree(wq_dev);
5253}
5254
5255/**
5256 * workqueue_sysfs_register - make a workqueue visible in sysfs
5257 * @wq: the workqueue to register
5258 *
5259 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5260 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5261 * which is the preferred method.
5262 *
5263 * Workqueue user should use this function directly iff it wants to apply
5264 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5265 * apply_workqueue_attrs() may race against userland updating the
5266 * attributes.
5267 *
5268 * Return: 0 on success, -errno on failure.
5269 */
5270int workqueue_sysfs_register(struct workqueue_struct *wq)
5271{
5272 struct wq_device *wq_dev;
5273 int ret;
5274
5275 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305276 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005277 * attributes breaks ordering guarantee. Disallow exposing ordered
5278 * workqueues.
5279 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005280 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005281 return -EINVAL;
5282
5283 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5284 if (!wq_dev)
5285 return -ENOMEM;
5286
5287 wq_dev->wq = wq;
5288 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005289 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005290 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005291
5292 /*
5293 * unbound_attrs are created separately. Suppress uevent until
5294 * everything is ready.
5295 */
5296 dev_set_uevent_suppress(&wq_dev->dev, true);
5297
5298 ret = device_register(&wq_dev->dev);
5299 if (ret) {
5300 kfree(wq_dev);
5301 wq->wq_dev = NULL;
5302 return ret;
5303 }
5304
5305 if (wq->flags & WQ_UNBOUND) {
5306 struct device_attribute *attr;
5307
5308 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5309 ret = device_create_file(&wq_dev->dev, attr);
5310 if (ret) {
5311 device_unregister(&wq_dev->dev);
5312 wq->wq_dev = NULL;
5313 return ret;
5314 }
5315 }
5316 }
5317
5318 dev_set_uevent_suppress(&wq_dev->dev, false);
5319 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5320 return 0;
5321}
5322
5323/**
5324 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5325 * @wq: the workqueue to unregister
5326 *
5327 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5328 */
5329static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5330{
5331 struct wq_device *wq_dev = wq->wq_dev;
5332
5333 if (!wq->wq_dev)
5334 return;
5335
5336 wq->wq_dev = NULL;
5337 device_unregister(&wq_dev->dev);
5338}
5339#else /* CONFIG_SYSFS */
5340static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5341#endif /* CONFIG_SYSFS */
5342
Tejun Heo82607adc2015-12-08 11:28:04 -05005343/*
5344 * Workqueue watchdog.
5345 *
5346 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5347 * flush dependency, a concurrency managed work item which stays RUNNING
5348 * indefinitely. Workqueue stalls can be very difficult to debug as the
5349 * usual warning mechanisms don't trigger and internal workqueue state is
5350 * largely opaque.
5351 *
5352 * Workqueue watchdog monitors all worker pools periodically and dumps
5353 * state if some pools failed to make forward progress for a while where
5354 * forward progress is defined as the first item on ->worklist changing.
5355 *
5356 * This mechanism is controlled through the kernel parameter
5357 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5358 * corresponding sysfs parameter file.
5359 */
5360#ifdef CONFIG_WQ_WATCHDOG
5361
Tejun Heo82607adc2015-12-08 11:28:04 -05005362static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005363static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005364
5365static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5366static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5367
5368static void wq_watchdog_reset_touched(void)
5369{
5370 int cpu;
5371
5372 wq_watchdog_touched = jiffies;
5373 for_each_possible_cpu(cpu)
5374 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5375}
5376
Kees Cook5cd79d62017-10-04 16:27:00 -07005377static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005378{
5379 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5380 bool lockup_detected = false;
5381 struct worker_pool *pool;
5382 int pi;
5383
5384 if (!thresh)
5385 return;
5386
5387 rcu_read_lock();
5388
5389 for_each_pool(pool, pi) {
5390 unsigned long pool_ts, touched, ts;
5391
5392 if (list_empty(&pool->worklist))
5393 continue;
5394
5395 /* get the latest of pool and touched timestamps */
5396 pool_ts = READ_ONCE(pool->watchdog_ts);
5397 touched = READ_ONCE(wq_watchdog_touched);
5398
5399 if (time_after(pool_ts, touched))
5400 ts = pool_ts;
5401 else
5402 ts = touched;
5403
5404 if (pool->cpu >= 0) {
5405 unsigned long cpu_touched =
5406 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5407 pool->cpu));
5408 if (time_after(cpu_touched, ts))
5409 ts = cpu_touched;
5410 }
5411
5412 /* did we stall? */
5413 if (time_after(jiffies, ts + thresh)) {
5414 lockup_detected = true;
5415 pr_emerg("BUG: workqueue lockup - pool");
5416 pr_cont_pool_info(pool);
5417 pr_cont(" stuck for %us!\n",
5418 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5419 }
5420 }
5421
5422 rcu_read_unlock();
5423
5424 if (lockup_detected)
5425 show_workqueue_state();
5426
5427 wq_watchdog_reset_touched();
5428 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5429}
5430
5431void wq_watchdog_touch(int cpu)
5432{
5433 if (cpu >= 0)
5434 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5435 else
5436 wq_watchdog_touched = jiffies;
5437}
5438
5439static void wq_watchdog_set_thresh(unsigned long thresh)
5440{
5441 wq_watchdog_thresh = 0;
5442 del_timer_sync(&wq_watchdog_timer);
5443
5444 if (thresh) {
5445 wq_watchdog_thresh = thresh;
5446 wq_watchdog_reset_touched();
5447 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5448 }
5449}
5450
5451static int wq_watchdog_param_set_thresh(const char *val,
5452 const struct kernel_param *kp)
5453{
5454 unsigned long thresh;
5455 int ret;
5456
5457 ret = kstrtoul(val, 0, &thresh);
5458 if (ret)
5459 return ret;
5460
5461 if (system_wq)
5462 wq_watchdog_set_thresh(thresh);
5463 else
5464 wq_watchdog_thresh = thresh;
5465
5466 return 0;
5467}
5468
5469static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5470 .set = wq_watchdog_param_set_thresh,
5471 .get = param_get_ulong,
5472};
5473
5474module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5475 0644);
5476
5477static void wq_watchdog_init(void)
5478{
Kees Cook5cd79d62017-10-04 16:27:00 -07005479 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005480 wq_watchdog_set_thresh(wq_watchdog_thresh);
5481}
5482
5483#else /* CONFIG_WQ_WATCHDOG */
5484
5485static inline void wq_watchdog_init(void) { }
5486
5487#endif /* CONFIG_WQ_WATCHDOG */
5488
Tejun Heobce90382013-04-01 11:23:32 -07005489static void __init wq_numa_init(void)
5490{
5491 cpumask_var_t *tbl;
5492 int node, cpu;
5493
Tejun Heobce90382013-04-01 11:23:32 -07005494 if (num_possible_nodes() <= 1)
5495 return;
5496
Tejun Heod55262c2013-04-01 11:23:38 -07005497 if (wq_disable_numa) {
5498 pr_info("workqueue: NUMA affinity support disabled\n");
5499 return;
5500 }
5501
Tejun Heo4c16bd32013-04-01 11:23:36 -07005502 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5503 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5504
Tejun Heobce90382013-04-01 11:23:32 -07005505 /*
5506 * We want masks of possible CPUs of each node which isn't readily
5507 * available. Build one from cpu_to_node() which should have been
5508 * fully initialized by now.
5509 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005510 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005511 BUG_ON(!tbl);
5512
5513 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005514 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005515 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005516
5517 for_each_possible_cpu(cpu) {
5518 node = cpu_to_node(cpu);
5519 if (WARN_ON(node == NUMA_NO_NODE)) {
5520 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5521 /* happens iff arch is bonkers, let's just proceed */
5522 return;
5523 }
5524 cpumask_set_cpu(cpu, tbl[node]);
5525 }
5526
5527 wq_numa_possible_cpumask = tbl;
5528 wq_numa_enabled = true;
5529}
5530
Tejun Heo3347fa02016-09-16 15:49:32 -04005531/**
5532 * workqueue_init_early - early init for workqueue subsystem
5533 *
5534 * This is the first half of two-staged workqueue subsystem initialization
5535 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5536 * idr are up. It sets up all the data structures and system workqueues
5537 * and allows early boot code to create workqueues and queue/cancel work
5538 * items. Actual work item execution starts only after kthreads can be
5539 * created and scheduled right before early initcalls.
5540 */
5541int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005542{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005543 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5544 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005545
Tejun Heoe904e6c2013-03-12 11:29:57 -07005546 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5547
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005548 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Tal Shorerc98a9802017-11-03 17:27:50 +02005549 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(HK_FLAG_DOMAIN));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005550
Tejun Heoe904e6c2013-03-12 11:29:57 -07005551 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5552
Tejun Heo706026c2013-01-24 11:01:34 -08005553 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005554 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005555 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005556
Tejun Heo7a4e3442013-03-12 11:30:00 -07005557 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005558 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005559 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005560 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005561 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005562 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005563 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005564
Tejun Heo9daf9e62013-01-24 11:01:33 -08005565 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005566 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005567 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005568 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005569 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005570 }
5571
Tejun Heo8a2b7532013-09-05 12:30:04 -04005572 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005573 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5574 struct workqueue_attrs *attrs;
5575
5576 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005577 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005578 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005579
5580 /*
5581 * An ordered wq should have only one pwq as ordering is
5582 * guaranteed by max_active which is enforced by pwqs.
5583 * Turn off NUMA so that dfl_pwq is used for all nodes.
5584 */
5585 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5586 attrs->nice = std_nice[i];
5587 attrs->no_numa = true;
5588 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005589 }
5590
Tejun Heod320c032010-06-29 10:07:14 +02005591 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005592 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005593 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005594 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5595 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005596 system_freezable_wq = alloc_workqueue("events_freezable",
5597 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305598 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5599 WQ_POWER_EFFICIENT, 0);
5600 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5601 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5602 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005603 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305604 !system_unbound_wq || !system_freezable_wq ||
5605 !system_power_efficient_wq ||
5606 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005607
Tejun Heo3347fa02016-09-16 15:49:32 -04005608 return 0;
5609}
5610
5611/**
5612 * workqueue_init - bring workqueue subsystem fully online
5613 *
5614 * This is the latter half of two-staged workqueue subsystem initialization
5615 * and invoked as soon as kthreads can be created and scheduled.
5616 * Workqueues have been created and work items queued on them, but there
5617 * are no kworkers executing the work items yet. Populate the worker pools
5618 * with the initial workers and enable future kworker creations.
5619 */
5620int __init workqueue_init(void)
5621{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005622 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005623 struct worker_pool *pool;
5624 int cpu, bkt;
5625
Tejun Heo2186d9f2016-10-19 12:01:27 -04005626 /*
5627 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5628 * CPU to node mapping may not be available that early on some
5629 * archs such as power and arm64. As per-cpu pools created
5630 * previously could be missing node hint and unbound pools NUMA
5631 * affinity, fix them up.
5632 */
5633 wq_numa_init();
5634
5635 mutex_lock(&wq_pool_mutex);
5636
5637 for_each_possible_cpu(cpu) {
5638 for_each_cpu_worker_pool(pool, cpu) {
5639 pool->node = cpu_to_node(cpu);
5640 }
5641 }
5642
5643 list_for_each_entry(wq, &workqueues, list)
5644 wq_update_unbound_numa(wq, smp_processor_id(), true);
5645
5646 mutex_unlock(&wq_pool_mutex);
5647
Tejun Heo3347fa02016-09-16 15:49:32 -04005648 /* create the initial workers */
5649 for_each_online_cpu(cpu) {
5650 for_each_cpu_worker_pool(pool, cpu) {
5651 pool->flags &= ~POOL_DISASSOCIATED;
5652 BUG_ON(!create_worker(pool));
5653 }
5654 }
5655
5656 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5657 BUG_ON(!create_worker(pool));
5658
5659 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005660 wq_watchdog_init();
5661
Suresh Siddha6ee05782010-07-30 14:57:37 -07005662 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005663}