blob: ac381bff69df7d2ef9c537ee936cae0a6cb375af [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 *
24 * Please read Documentation/workqueue.txt 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 Lameter46934022006-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/kallsyms.h>
42#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Pavankumar Kondeti0c0b7642017-01-04 10:41:15 +053051#include <linux/bug.h>
52#include <linux/delay.h>
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +090053#include <linux/nmi.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020054
Tejun Heoea138442013-01-18 14:05:55 -080055#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Tejun Heoc8e55f32010-06-29 10:07:12 +020057enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070058 /*
Tejun Heo24647572013-01-24 11:01:33 -080059 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070060 *
Tejun Heo24647572013-01-24 11:01:33 -080061 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070062 * While associated (!DISASSOCIATED), all workers are bound to the
63 * CPU and none has %WORKER_UNBOUND set and concurrency management
64 * is in effect.
65 *
66 * While DISASSOCIATED, the cpu may be offline and all workers have
67 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080068 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070069 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070070 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080071 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080072 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070073 */
Tejun Heo43a980a2017-10-09 08:04:13 -070074 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
Tejun Heo24647572013-01-24 11:01:33 -080075 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020076
Tejun Heoc8e55f32010-06-29 10:07:12 +020077 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020078 WORKER_DIE = 1 << 1, /* die die die */
79 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020080 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020081 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020082 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070083 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020084
Tejun Heoa9ab7752013-03-19 13:45:21 -070085 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
86 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020087
Tejun Heoe34cdddb2013-01-24 11:01:33 -080088 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070089
Tejun Heo29c91e92013-03-12 11:30:03 -070090 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020091 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020092
Tejun Heoe22bee72010-06-29 10:07:14 +020093 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
94 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
95
Tejun Heo3233cdb2011-02-16 18:10:19 +010096 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
97 /* call for help after 10ms
98 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020099 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
100 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +0200101
102 /*
103 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800104 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200105 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800106 RESCUER_NICE_LEVEL = MIN_NICE,
107 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700108
109 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200110};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200113 * Structure fields follow one of the following exclusion rules.
114 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200115 * I: Modifiable by initialization/destruction paths and read-only for
116 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200117 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200118 * P: Preemption protected. Disabling preemption is enough and should
119 * only be modified and accessed from the local cpu.
120 *
Tejun Heod565ed62013-01-24 11:01:33 -0800121 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200122 *
Tejun Heod565ed62013-01-24 11:01:33 -0800123 * X: During normal operation, modification requires pool->lock and should
124 * be done only from local cpu. Either disabling preemption on local
125 * cpu or grabbing pool->lock is enough for read access. If
126 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200127 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800128 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700129 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700130 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700131 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700132 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700133 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800134 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
135 *
136 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
137 * sched-RCU for reads.
138 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700139 * WQ: wq->mutex protected.
140 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700141 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700142 *
143 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200144 */
145
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800146/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200147
Tejun Heobd7bdd42012-07-12 14:46:37 -0700148struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800149 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700150 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700151 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800152 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700153 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700154
Tejun Heo82607adc2015-12-08 11:28:04 -0500155 unsigned long watchdog_ts; /* L: watchdog timestamp */
156
Tejun Heobd7bdd42012-07-12 14:46:37 -0700157 struct list_head worklist; /* L: list of pending works */
158 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700159
160 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700161 int nr_idle; /* L: currently idle ones */
162
163 struct list_head idle_list; /* X: list of idle workers */
164 struct timer_list idle_timer; /* L: worker idle timeout */
165 struct timer_list mayday_timer; /* L: SOS timer for workers */
166
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700167 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800168 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
169 /* L: hash of busy workers */
170
Tejun Heobc3a1af2013-03-13 19:47:39 -0700171 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400172 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800173 struct mutex attach_mutex; /* attach/detach exclusion */
174 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800175 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800176
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800177 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800178
Tejun Heo7a4e3442013-03-12 11:30:00 -0700179 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700180 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
181 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700182
Tejun Heoe19e3972013-01-24 11:39:44 -0800183 /*
184 * The current concurrency level. As it's likely to be accessed
185 * from other CPUs during try_to_wake_up(), put it in a separate
186 * cacheline.
187 */
188 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700189
190 /*
191 * Destruction of pool is sched-RCU protected to allow dereferences
192 * from get_work_pool().
193 */
194 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200195} ____cacheline_aligned_in_smp;
196
197/*
Tejun Heo112202d2013-02-13 19:29:12 -0800198 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
199 * of work_struct->data are used for flags and the remaining high bits
200 * point to the pwq; thus, pwqs need to be aligned at two's power of the
201 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 */
Tejun Heo112202d2013-02-13 19:29:12 -0800203struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700204 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200205 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200206 int work_color; /* L: current color */
207 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700208 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200209 int nr_in_flight[WORK_NR_COLORS];
210 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200211 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200212 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200213 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700214 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700215 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700216
217 /*
218 * Release of unbound pwq is punted to system_wq. See put_pwq()
219 * and pwq_unbound_release_workfn() for details. pool_workqueue
220 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700221 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700222 */
223 struct work_struct unbound_release_work;
224 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700225} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200228 * Structure used to wait for workqueue flush.
229 */
230struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700231 struct list_head list; /* WQ: list of flushers */
232 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200233 struct completion done; /* flush completion */
234};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Tejun Heo226223a2013-03-12 11:30:05 -0700236struct wq_device;
237
Tejun Heo73f53c42010-06-29 10:07:11 +0200238/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700239 * The externally visible workqueue. It relays the issued work items to
240 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 */
242struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700243 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400244 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200245
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700246 struct mutex mutex; /* protects this wq */
247 int work_color; /* WQ: current work color */
248 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800249 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700250 struct wq_flusher *first_flusher; /* WQ: first flusher */
251 struct list_head flusher_queue; /* WQ: flush waiters */
252 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200253
Tejun Heo2e109a22013-03-13 19:47:40 -0700254 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200255 struct worker *rescuer; /* I: rescue worker */
256
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700257 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700258 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700259
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800260 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
261 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700262
Tejun Heo226223a2013-03-12 11:30:05 -0700263#ifdef CONFIG_SYSFS
264 struct wq_device *wq_dev; /* I: for sysfs interface */
265#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700266#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200267 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700268#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700269 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700270
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400271 /*
272 * Destruction of workqueue_struct is sched-RCU protected to allow
273 * walking the workqueues list without grabbing wq_pool_mutex.
274 * This is used to dump all workqueues from sysrq.
275 */
276 struct rcu_head rcu;
277
Tejun Heo2728fd22013-04-01 11:23:35 -0700278 /* hot fields used during command issue, aligned to cacheline */
279 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
280 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800281 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282};
283
Tejun Heoe904e6c2013-03-12 11:29:57 -0700284static struct kmem_cache *pwq_cache;
285
Tejun Heobce90382013-04-01 11:23:32 -0700286static cpumask_var_t *wq_numa_possible_cpumask;
287 /* possible CPUs of each node */
288
Tejun Heod55262c2013-04-01 11:23:38 -0700289static bool wq_disable_numa;
290module_param_named(disable_numa, wq_disable_numa, bool, 0444);
291
Viresh Kumarcee22a12013-04-08 16:45:40 +0530292/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930293static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530294module_param_named(power_efficient, wq_power_efficient, bool, 0444);
295
Tejun Heo4b5facd2016-09-16 15:49:32 -0400296bool wq_online; /* can kworkers be created yet? */
297
Tejun Heobce90382013-04-01 11:23:32 -0700298static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
299
Tejun Heo4c16bd32013-04-01 11:23:36 -0700300/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
301static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
302
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700303static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700304static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo43a980a2017-10-09 08:04:13 -0700305static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
Tejun Heo5bcab332013-03-13 19:47:40 -0700306
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400307static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700308static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700309
Mike Galbraithef5571802016-02-09 17:59:38 -0500310/* PL: allowable cpus for unbound wqs and work items */
311static cpumask_var_t wq_unbound_cpumask;
312
313/* CPU where unbound work was last round robin scheduled from this CPU */
314static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800315
Tejun Heof303fcc2016-02-09 17:59:38 -0500316/*
317 * Local execution of unbound work items is no longer guaranteed. The
318 * following always forces round-robin CPU selection on unbound work items
319 * to uncover usages which depend on it.
320 */
321#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
322static bool wq_debug_force_rr_cpu = true;
323#else
324static bool wq_debug_force_rr_cpu = false;
325#endif
326module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
327
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700328/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700329static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700330
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700331static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700332
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700333/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700334static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
335
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700336/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700337static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
338
Tejun Heo8a2b7532013-09-05 12:30:04 -0400339/* I: attributes used when instantiating ordered pools on demand */
340static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
341
Tejun Heod320c032010-06-29 10:07:14 +0200342struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400343EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300344struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900345EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300346struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200347EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300348struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200349EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300350struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100351EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530352struct workqueue_struct *system_power_efficient_wq __read_mostly;
353EXPORT_SYMBOL_GPL(system_power_efficient_wq);
354struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
355EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200356
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700357static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800358static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700359
Tejun Heo97bd2342010-10-05 10:41:14 +0200360#define CREATE_TRACE_POINTS
361#include <trace/events/workqueue.h>
362
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700363#define assert_rcu_or_pool_mutex() \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700364 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
365 !lockdep_is_held(&wq_pool_mutex), \
366 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700367
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700368#define assert_rcu_or_wq_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700369 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
370 !lockdep_is_held(&wq->mutex), \
371 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700372
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800373#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700374 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
375 !lockdep_is_held(&wq->mutex) && \
376 !lockdep_is_held(&wq_pool_mutex), \
377 "sched RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800378
Tejun Heof02ae732013-03-12 11:30:03 -0700379#define for_each_cpu_worker_pool(pool, cpu) \
380 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
381 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700382 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700383
Tejun Heo49e3cf42013-03-12 11:29:58 -0700384/**
Tejun Heo17116962013-03-12 11:29:58 -0700385 * for_each_pool - iterate through all worker_pools in the system
386 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700387 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700388 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700389 * This must be called either with wq_pool_mutex held or sched RCU read
390 * locked. If the pool needs to be used beyond the locking in effect, the
391 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700392 *
393 * The if/else clause exists only for the lockdep assertion and can be
394 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700395 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700396#define for_each_pool(pool, pi) \
397 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700398 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700399 else
Tejun Heo17116962013-03-12 11:29:58 -0700400
401/**
Tejun Heo822d8402013-03-19 13:45:21 -0700402 * for_each_pool_worker - iterate through all workers of a worker_pool
403 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700404 * @pool: worker_pool to iterate workers of
405 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800406 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700407 *
408 * The if/else clause exists only for the lockdep assertion and can be
409 * ignored.
410 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800411#define for_each_pool_worker(worker, pool) \
412 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800413 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700414 else
415
416/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700417 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
418 * @pwq: iteration cursor
419 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700420 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700421 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700422 * If the pwq needs to be used beyond the locking in effect, the caller is
423 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700424 *
425 * The if/else clause exists only for the lockdep assertion and can be
426 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700427 */
428#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700429 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700430 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700431 else
Tejun Heof3421792010-07-02 10:03:51 +0200432
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900433#ifdef CONFIG_DEBUG_OBJECTS_WORK
434
435static struct debug_obj_descr work_debug_descr;
436
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100437static void *work_debug_hint(void *addr)
438{
439 return ((struct work_struct *) addr)->func;
440}
441
Du, Changbinb9fdac72016-05-19 17:09:41 -0700442static bool work_is_static_object(void *addr)
443{
444 struct work_struct *work = addr;
445
446 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
447}
448
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900449/*
450 * fixup_init is called when:
451 * - an active object is initialized
452 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700453static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900454{
455 struct work_struct *work = addr;
456
457 switch (state) {
458 case ODEBUG_STATE_ACTIVE:
459 cancel_work_sync(work);
460 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700461 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900462 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700463 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900464 }
465}
466
467/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900468 * fixup_free is called when:
469 * - an active object is freed
470 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700471static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900472{
473 struct work_struct *work = addr;
474
475 switch (state) {
476 case ODEBUG_STATE_ACTIVE:
477 cancel_work_sync(work);
478 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700479 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900480 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700481 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900482 }
483}
484
485static struct debug_obj_descr work_debug_descr = {
486 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100487 .debug_hint = work_debug_hint,
Du, Changbinb9fdac72016-05-19 17:09:41 -0700488 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900489 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900490 .fixup_free = work_fixup_free,
491};
492
493static inline void debug_work_activate(struct work_struct *work)
494{
495 debug_object_activate(work, &work_debug_descr);
496}
497
498static inline void debug_work_deactivate(struct work_struct *work)
499{
500 debug_object_deactivate(work, &work_debug_descr);
501}
502
503void __init_work(struct work_struct *work, int onstack)
504{
505 if (onstack)
506 debug_object_init_on_stack(work, &work_debug_descr);
507 else
508 debug_object_init(work, &work_debug_descr);
509}
510EXPORT_SYMBOL_GPL(__init_work);
511
512void destroy_work_on_stack(struct work_struct *work)
513{
514 debug_object_free(work, &work_debug_descr);
515}
516EXPORT_SYMBOL_GPL(destroy_work_on_stack);
517
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000518void destroy_delayed_work_on_stack(struct delayed_work *work)
519{
520 destroy_timer_on_stack(&work->timer);
521 debug_object_free(&work->work, &work_debug_descr);
522}
523EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
524
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900525#else
526static inline void debug_work_activate(struct work_struct *work) { }
527static inline void debug_work_deactivate(struct work_struct *work) { }
528#endif
529
Li Bin4e8b22b2013-09-10 09:52:35 +0800530/**
531 * worker_pool_assign_id - allocate ID and assing it to @pool
532 * @pool: the pool pointer of interest
533 *
534 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
535 * successfully, -errno on failure.
536 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800537static int worker_pool_assign_id(struct worker_pool *pool)
538{
539 int ret;
540
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700541 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700542
Li Bin4e8b22b2013-09-10 09:52:35 +0800543 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
544 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700545 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700546 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700547 return 0;
548 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800549 return ret;
550}
551
Tejun Heo76af4d92013-03-12 11:30:00 -0700552/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700553 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
554 * @wq: the target workqueue
555 * @node: the node ID
556 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800557 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
558 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700559 * If the pwq needs to be used beyond the locking in effect, the caller is
560 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700561 *
562 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700563 */
564static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
565 int node)
566{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800567 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500568
569 /*
570 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
571 * delayed item is pending. The plan is to keep CPU -> NODE
572 * mapping valid and stable across CPU on/offlines. Once that
573 * happens, this workaround can be removed.
574 */
575 if (unlikely(node == NUMA_NO_NODE))
576 return wq->dfl_pwq;
577
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700578 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
579}
580
Tejun Heo73f53c42010-06-29 10:07:11 +0200581static unsigned int work_color_to_flags(int color)
582{
583 return color << WORK_STRUCT_COLOR_SHIFT;
584}
585
586static int get_work_color(struct work_struct *work)
587{
588 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
589 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
590}
591
592static int work_next_color(int color)
593{
594 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700595}
596
David Howells4594bf12006-12-07 11:33:26 +0000597/*
Tejun Heo112202d2013-02-13 19:29:12 -0800598 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
599 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800600 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200601 *
Tejun Heo112202d2013-02-13 19:29:12 -0800602 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
603 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700604 * work->data. These functions should only be called while the work is
605 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200606 *
Tejun Heo112202d2013-02-13 19:29:12 -0800607 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800608 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800609 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800610 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700611 *
612 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
613 * canceled. While being canceled, a work item may have its PENDING set
614 * but stay off timer and worklist for arbitrarily long and nobody should
615 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000616 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200617static inline void set_work_data(struct work_struct *work, unsigned long data,
618 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000619{
Tejun Heo6183c002013-03-12 11:29:57 -0700620 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200621 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000622}
David Howells365970a2006-11-22 14:54:49 +0000623
Tejun Heo112202d2013-02-13 19:29:12 -0800624static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200625 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200626{
Tejun Heo112202d2013-02-13 19:29:12 -0800627 set_work_data(work, (unsigned long)pwq,
628 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200629}
630
Lai Jiangshan4468a002013-02-06 18:04:53 -0800631static void set_work_pool_and_keep_pending(struct work_struct *work,
632 int pool_id)
633{
634 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
635 WORK_STRUCT_PENDING);
636}
637
Tejun Heo7c3eed52013-01-24 11:01:33 -0800638static void set_work_pool_and_clear_pending(struct work_struct *work,
639 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000640{
Tejun Heo23657bb2012-08-13 17:08:19 -0700641 /*
642 * The following wmb is paired with the implied mb in
643 * test_and_set_bit(PENDING) and ensures all updates to @work made
644 * here are visible to and precede any updates by the next PENDING
645 * owner.
646 */
647 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800648 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200649 /*
650 * The following mb guarantees that previous clear of a PENDING bit
651 * will not be reordered with any speculative LOADS or STORES from
652 * work->current_func, which is executed afterwards. This possible
653 * reordering can lead to a missed execution on attempt to qeueue
654 * the same @work. E.g. consider this case:
655 *
656 * CPU#0 CPU#1
657 * ---------------------------- --------------------------------
658 *
659 * 1 STORE event_indicated
660 * 2 queue_work_on() {
661 * 3 test_and_set_bit(PENDING)
662 * 4 } set_..._and_clear_pending() {
663 * 5 set_work_data() # clear bit
664 * 6 smp_mb()
665 * 7 work->current_func() {
666 * 8 LOAD event_indicated
667 * }
668 *
669 * Without an explicit full barrier speculative LOAD on line 8 can
670 * be executed before CPU#0 does STORE on line 1. If that happens,
671 * CPU#0 observes the PENDING bit is still set and new execution of
672 * a @work is not queued in a hope, that CPU#1 will eventually
673 * finish the queued @work. Meanwhile CPU#1 does not see
674 * event_indicated is set, because speculative LOAD was executed
675 * before actual STORE.
676 */
677 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200678}
679
680static void clear_work_data(struct work_struct *work)
681{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800682 smp_wmb(); /* see set_work_pool_and_clear_pending() */
683 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200684}
685
Tejun Heo112202d2013-02-13 19:29:12 -0800686static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200687{
Tejun Heoe1201532010-07-22 14:14:25 +0200688 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200689
Tejun Heo112202d2013-02-13 19:29:12 -0800690 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200691 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
692 else
693 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200694}
695
Tejun Heo7c3eed52013-01-24 11:01:33 -0800696/**
697 * get_work_pool - return the worker_pool a given work was associated with
698 * @work: the work item of interest
699 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700700 * Pools are created and destroyed under wq_pool_mutex, and allows read
701 * access under sched-RCU read lock. As such, this function should be
702 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700703 *
704 * All fields of the returned pool are accessible as long as the above
705 * mentioned locking is in effect. If the returned pool needs to be used
706 * beyond the critical section, the caller is responsible for ensuring the
707 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700708 *
709 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800710 */
711static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200712{
Tejun Heoe1201532010-07-22 14:14:25 +0200713 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800714 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200715
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700716 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700717
Tejun Heo112202d2013-02-13 19:29:12 -0800718 if (data & WORK_STRUCT_PWQ)
719 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800720 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200721
Tejun Heo7c3eed52013-01-24 11:01:33 -0800722 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
723 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200724 return NULL;
725
Tejun Heofa1b54e2013-03-12 11:30:00 -0700726 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800727}
728
729/**
730 * get_work_pool_id - return the worker pool ID a given work is associated with
731 * @work: the work item of interest
732 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700733 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800734 * %WORK_OFFQ_POOL_NONE if none.
735 */
736static int get_work_pool_id(struct work_struct *work)
737{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800738 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800739
Tejun Heo112202d2013-02-13 19:29:12 -0800740 if (data & WORK_STRUCT_PWQ)
741 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800742 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
743
744 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800745}
746
Tejun Heobbb68df2012-08-03 10:30:46 -0700747static void mark_work_canceling(struct work_struct *work)
748{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800749 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700750
Tejun Heo7c3eed52013-01-24 11:01:33 -0800751 pool_id <<= WORK_OFFQ_POOL_SHIFT;
752 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700753}
754
755static bool work_is_canceling(struct work_struct *work)
756{
757 unsigned long data = atomic_long_read(&work->data);
758
Tejun Heo112202d2013-02-13 19:29:12 -0800759 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700760}
761
David Howells365970a2006-11-22 14:54:49 +0000762/*
Tejun Heo32704762012-07-13 22:16:45 -0700763 * Policy functions. These define the policies on how the global worker
764 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800765 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000766 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200767
Tejun Heo63d95a92012-07-12 14:46:37 -0700768static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000769{
Tejun Heoe19e3972013-01-24 11:39:44 -0800770 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000771}
772
Tejun Heoe22bee72010-06-29 10:07:14 +0200773/*
774 * Need to wake up a worker? Called from anything but currently
775 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700776 *
777 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800778 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700779 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200780 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700781static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000782{
Tejun Heo63d95a92012-07-12 14:46:37 -0700783 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000784}
785
Tejun Heoe22bee72010-06-29 10:07:14 +0200786/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700787static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200788{
Tejun Heo63d95a92012-07-12 14:46:37 -0700789 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200790}
791
792/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700793static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200794{
Tejun Heoe19e3972013-01-24 11:39:44 -0800795 return !list_empty(&pool->worklist) &&
796 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200797}
798
799/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700800static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200801{
Tejun Heo63d95a92012-07-12 14:46:37 -0700802 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200803}
804
Tejun Heoe22bee72010-06-29 10:07:14 +0200805/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700806static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200807{
Tejun Heo43a980a2017-10-09 08:04:13 -0700808 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700809 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
810 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200811
812 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
813}
814
815/*
816 * Wake up functions.
817 */
818
Lai Jiangshan1037de32014-05-22 16:44:07 +0800819/* Return the first idle worker. Safe with preemption disabled */
820static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200821{
Tejun Heo63d95a92012-07-12 14:46:37 -0700822 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200823 return NULL;
824
Tejun Heo63d95a92012-07-12 14:46:37 -0700825 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200826}
827
828/**
829 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700830 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200831 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700832 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200833 *
834 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800835 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200836 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700837static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200838{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800839 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200840
841 if (likely(worker))
842 wake_up_process(worker->task);
843}
844
Tejun Heo4690c4a2010-06-29 10:07:10 +0200845/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200846 * wq_worker_waking_up - a worker is waking up
847 * @task: task waking up
848 * @cpu: CPU @task is waking up to
849 *
850 * This function is called during try_to_wake_up() when a worker is
851 * being awoken.
852 *
853 * CONTEXT:
854 * spin_lock_irq(rq->lock)
855 */
Tejun Heod84ff052013-03-12 11:29:59 -0700856void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200857{
858 struct worker *worker = kthread_data(task);
859
Joonsoo Kim36576002012-10-26 23:03:49 +0900860 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800861 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800862 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900863 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200864}
865
866/**
867 * wq_worker_sleeping - a worker is going to sleep
868 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200869 *
870 * This function is called during schedule() when a busy worker is
871 * going to sleep. Worker on the same cpu can be woken up by
872 * returning pointer to its task.
873 *
874 * CONTEXT:
875 * spin_lock_irq(rq->lock)
876 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700877 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200878 * Worker task on @cpu to wake up, %NULL if none.
879 */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100880struct task_struct *wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200881{
882 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800883 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200884
Tejun Heo111c2252013-01-17 17:16:24 -0800885 /*
886 * Rescuers, which may not have all the fields set up like normal
887 * workers, also reach here, let's not access anything before
888 * checking NOT_RUNNING.
889 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500890 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200891 return NULL;
892
Tejun Heo111c2252013-01-17 17:16:24 -0800893 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800894
Tejun Heoe22bee72010-06-29 10:07:14 +0200895 /* this can only happen on the local cpu */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100896 if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
Tejun Heo6183c002013-03-12 11:29:57 -0700897 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200898
899 /*
900 * The counterpart of the following dec_and_test, implied mb,
901 * worklist not empty test sequence is in insert_work().
902 * Please read comment there.
903 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700904 * NOT_RUNNING is clear. This means that we're bound to and
905 * running on the local cpu w/ rq lock held and preemption
906 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800907 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700908 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200909 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800910 if (atomic_dec_and_test(&pool->nr_running) &&
911 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800912 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200913 return to_wakeup ? to_wakeup->task : NULL;
914}
915
916/**
Johannes Weinerb7f0f222019-02-01 14:20:42 -0800917 * wq_worker_last_func - retrieve worker's last work function
918 *
919 * Determine the last function a worker executed. This is called from
920 * the scheduler to get a worker's last known identity.
921 *
922 * CONTEXT:
923 * spin_lock_irq(rq->lock)
924 *
925 * Return:
926 * The last work function %current executed as a worker, NULL if it
927 * hasn't executed any work yet.
928 */
929work_func_t wq_worker_last_func(struct task_struct *task)
930{
931 struct worker *worker = kthread_data(task);
932
933 return worker->last_func;
934}
935
936/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200937 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200938 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200939 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200940 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800941 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200942 *
Tejun Heocb444762010-07-02 10:03:50 +0200943 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800944 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200945 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800946static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200947{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700948 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200949
Tejun Heocb444762010-07-02 10:03:50 +0200950 WARN_ON_ONCE(worker->task != current);
951
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800952 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200953 if ((flags & WORKER_NOT_RUNNING) &&
954 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800955 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200956 }
957
Tejun Heod302f012010-06-29 10:07:13 +0200958 worker->flags |= flags;
959}
960
961/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200962 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200963 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200964 * @flags: flags to clear
965 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200966 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200967 *
Tejun Heocb444762010-07-02 10:03:50 +0200968 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800969 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200970 */
971static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
972{
Tejun Heo63d95a92012-07-12 14:46:37 -0700973 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200974 unsigned int oflags = worker->flags;
975
Tejun Heocb444762010-07-02 10:03:50 +0200976 WARN_ON_ONCE(worker->task != current);
977
Tejun Heod302f012010-06-29 10:07:13 +0200978 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200979
Tejun Heo42c025f2011-01-11 15:58:49 +0100980 /*
981 * If transitioning out of NOT_RUNNING, increment nr_running. Note
982 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
983 * of multiple flags, not a single flag.
984 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200985 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
986 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800987 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200988}
989
990/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200991 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800992 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200993 * @work: work to find worker for
994 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800995 * Find a worker which is executing @work on @pool by searching
996 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800997 * to match, its current execution should match the address of @work and
998 * its work function. This is to avoid unwanted dependency between
999 * unrelated work executions through a work item being recycled while still
1000 * being executed.
1001 *
1002 * This is a bit tricky. A work item may be freed once its execution
1003 * starts and nothing prevents the freed area from being recycled for
1004 * another work item. If the same work item address ends up being reused
1005 * before the original execution finishes, workqueue will identify the
1006 * recycled work item as currently executing and make it wait until the
1007 * current execution finishes, introducing an unwanted dependency.
1008 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001009 * This function checks the work item address and work function to avoid
1010 * false positives. Note that this isn't complete as one may construct a
1011 * work function which can introduce dependency onto itself through a
1012 * recycled work item. Well, if somebody wants to shoot oneself in the
1013 * foot that badly, there's only so much we can do, and if such deadlock
1014 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001015 *
1016 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001017 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001018 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001019 * Return:
1020 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001021 * otherwise.
1022 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001023static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001024 struct work_struct *work)
1025{
Sasha Levin42f85702012-12-17 10:01:23 -05001026 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001027
Sasha Levinb67bfe02013-02-27 17:06:00 -08001028 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001029 (unsigned long)work)
1030 if (worker->current_work == work &&
1031 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001032 return worker;
1033
1034 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001035}
1036
1037/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001038 * move_linked_works - move linked works to a list
1039 * @work: start of series of works to be scheduled
1040 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301041 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001042 *
1043 * Schedule linked works starting from @work to @head. Work series to
1044 * be scheduled starts at @work and includes any consecutive work with
1045 * WORK_STRUCT_LINKED set in its predecessor.
1046 *
1047 * If @nextp is not NULL, it's updated to point to the next work of
1048 * the last scheduled work. This allows move_linked_works() to be
1049 * nested inside outer list_for_each_entry_safe().
1050 *
1051 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001052 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001053 */
1054static void move_linked_works(struct work_struct *work, struct list_head *head,
1055 struct work_struct **nextp)
1056{
1057 struct work_struct *n;
1058
1059 /*
1060 * Linked worklist will always end before the end of the list,
1061 * use NULL for list head.
1062 */
1063 list_for_each_entry_safe_from(work, n, NULL, entry) {
1064 list_move_tail(&work->entry, head);
1065 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1066 break;
1067 }
1068
1069 /*
1070 * If we're already inside safe list traversal and have moved
1071 * multiple works to the scheduled queue, the next position
1072 * needs to be updated.
1073 */
1074 if (nextp)
1075 *nextp = n;
1076}
1077
Tejun Heo8864b4e2013-03-12 11:30:04 -07001078/**
1079 * get_pwq - get an extra reference on the specified pool_workqueue
1080 * @pwq: pool_workqueue to get
1081 *
1082 * Obtain an extra reference on @pwq. The caller should guarantee that
1083 * @pwq has positive refcnt and be holding the matching pool->lock.
1084 */
1085static void get_pwq(struct pool_workqueue *pwq)
1086{
1087 lockdep_assert_held(&pwq->pool->lock);
1088 WARN_ON_ONCE(pwq->refcnt <= 0);
1089 pwq->refcnt++;
1090}
1091
1092/**
1093 * put_pwq - put a pool_workqueue reference
1094 * @pwq: pool_workqueue to put
1095 *
1096 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1097 * destruction. The caller should be holding the matching pool->lock.
1098 */
1099static void put_pwq(struct pool_workqueue *pwq)
1100{
1101 lockdep_assert_held(&pwq->pool->lock);
1102 if (likely(--pwq->refcnt))
1103 return;
1104 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1105 return;
1106 /*
1107 * @pwq can't be released under pool->lock, bounce to
1108 * pwq_unbound_release_workfn(). This never recurses on the same
1109 * pool->lock as this path is taken only for unbound workqueues and
1110 * the release work item is scheduled on a per-cpu workqueue. To
1111 * avoid lockdep warning, unbound pool->locks are given lockdep
1112 * subclass of 1 in get_unbound_pool().
1113 */
1114 schedule_work(&pwq->unbound_release_work);
1115}
1116
Tejun Heodce90d42013-04-01 11:23:35 -07001117/**
1118 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1119 * @pwq: pool_workqueue to put (can be %NULL)
1120 *
1121 * put_pwq() with locking. This function also allows %NULL @pwq.
1122 */
1123static void put_pwq_unlocked(struct pool_workqueue *pwq)
1124{
1125 if (pwq) {
1126 /*
1127 * As both pwqs and pools are sched-RCU protected, the
1128 * following lock operations are safe.
1129 */
1130 spin_lock_irq(&pwq->pool->lock);
1131 put_pwq(pwq);
1132 spin_unlock_irq(&pwq->pool->lock);
1133 }
1134}
1135
Tejun Heo112202d2013-02-13 19:29:12 -08001136static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001137{
Tejun Heo112202d2013-02-13 19:29:12 -08001138 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001139
1140 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001141 if (list_empty(&pwq->pool->worklist))
1142 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001143 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001144 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001145 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001146}
1147
Tejun Heo112202d2013-02-13 19:29:12 -08001148static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001149{
Tejun Heo112202d2013-02-13 19:29:12 -08001150 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001151 struct work_struct, entry);
1152
Tejun Heo112202d2013-02-13 19:29:12 -08001153 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001154}
1155
Tejun Heobf4ede02012-08-03 10:30:46 -07001156/**
Tejun Heo112202d2013-02-13 19:29:12 -08001157 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1158 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001159 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001160 *
1161 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001162 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001163 *
1164 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001165 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001166 */
Tejun Heo112202d2013-02-13 19:29:12 -08001167static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001168{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001169 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001170 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001171 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001172
Tejun Heo112202d2013-02-13 19:29:12 -08001173 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001174
Tejun Heo112202d2013-02-13 19:29:12 -08001175 pwq->nr_active--;
1176 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001177 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001178 if (pwq->nr_active < pwq->max_active)
1179 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001180 }
1181
1182 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001183 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001184 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001185
1186 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001187 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001188 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001189
Tejun Heo112202d2013-02-13 19:29:12 -08001190 /* this pwq is done, clear flush_color */
1191 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001192
1193 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001194 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001195 * will handle the rest.
1196 */
Tejun Heo112202d2013-02-13 19:29:12 -08001197 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1198 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001199out_put:
1200 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001201}
1202
Tejun Heo36e227d2012-08-03 10:30:46 -07001203/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001204 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001205 * @work: work item to steal
1206 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001207 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001208 *
1209 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001210 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001211 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001212 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001213 * 1 if @work was pending and we successfully stole PENDING
1214 * 0 if @work was idle and we claimed PENDING
1215 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001216 * -ENOENT if someone else is canceling @work, this state may persist
1217 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001218 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001219 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001220 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001221 * interrupted while holding PENDING and @work off queue, irq must be
1222 * disabled on entry. This, combined with delayed_work->timer being
1223 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001224 *
1225 * On successful return, >= 0, irq is disabled and the caller is
1226 * responsible for releasing it using local_irq_restore(*@flags).
1227 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001228 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001229 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001230static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1231 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001232{
Tejun Heod565ed62013-01-24 11:01:33 -08001233 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001234 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001235
Tejun Heobbb68df2012-08-03 10:30:46 -07001236 local_irq_save(*flags);
1237
Tejun Heo36e227d2012-08-03 10:30:46 -07001238 /* try to steal the timer if it exists */
1239 if (is_dwork) {
1240 struct delayed_work *dwork = to_delayed_work(work);
1241
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001242 /*
1243 * dwork->timer is irqsafe. If del_timer() fails, it's
1244 * guaranteed that the timer is not queued anywhere and not
1245 * running on the local CPU.
1246 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001247 if (likely(del_timer(&dwork->timer)))
1248 return 1;
1249 }
1250
1251 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001252 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1253 return 0;
1254
1255 /*
1256 * The queueing is in progress, or it is already queued. Try to
1257 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1258 */
Tejun Heod565ed62013-01-24 11:01:33 -08001259 pool = get_work_pool(work);
1260 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001261 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001262
Tejun Heod565ed62013-01-24 11:01:33 -08001263 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001264 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001265 * work->data is guaranteed to point to pwq only while the work
1266 * item is queued on pwq->wq, and both updating work->data to point
1267 * to pwq on queueing and to pool on dequeueing are done under
1268 * pwq->pool->lock. This in turn guarantees that, if work->data
1269 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001270 * item is currently queued on that pool.
1271 */
Tejun Heo112202d2013-02-13 19:29:12 -08001272 pwq = get_work_pwq(work);
1273 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001274 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001275
Tejun Heo16062832013-02-06 18:04:53 -08001276 /*
1277 * A delayed work item cannot be grabbed directly because
1278 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001279 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001280 * management later on and cause stall. Make sure the work
1281 * item is activated before grabbing.
1282 */
1283 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001284 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001285
Tejun Heo16062832013-02-06 18:04:53 -08001286 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001287 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001288
Tejun Heo112202d2013-02-13 19:29:12 -08001289 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001290 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001291
Tejun Heo16062832013-02-06 18:04:53 -08001292 spin_unlock(&pool->lock);
1293 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001294 }
Tejun Heod565ed62013-01-24 11:01:33 -08001295 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001296fail:
1297 local_irq_restore(*flags);
1298 if (work_is_canceling(work))
1299 return -ENOENT;
1300 cpu_relax();
Pavankumar Kondeti0c0b7642017-01-04 10:41:15 +05301301 /*
1302 * The queueing is in progress in another context. If we keep
1303 * taking the pool->lock in a busy loop, the other context may
1304 * never get the lock. Give 1 usec delay to avoid this contention.
1305 */
1306 udelay(1);
Tejun Heo36e227d2012-08-03 10:30:46 -07001307 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001308}
1309
1310/**
Tejun Heo706026c2013-01-24 11:01:34 -08001311 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001312 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001313 * @work: work to insert
1314 * @head: insertion point
1315 * @extra_flags: extra WORK_STRUCT_* flags to set
1316 *
Tejun Heo112202d2013-02-13 19:29:12 -08001317 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001318 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001319 *
1320 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001321 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001322 */
Tejun Heo112202d2013-02-13 19:29:12 -08001323static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1324 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001325{
Tejun Heo112202d2013-02-13 19:29:12 -08001326 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001327
Tejun Heo4690c4a2010-06-29 10:07:10 +02001328 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001329 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001330 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001331 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001332
1333 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001334 * Ensure either wq_worker_sleeping() sees the above
1335 * list_add_tail() or we see zero nr_running to avoid workers lying
1336 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001337 */
1338 smp_mb();
1339
Tejun Heo63d95a92012-07-12 14:46:37 -07001340 if (__need_more_worker(pool))
1341 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001342}
1343
Tejun Heoc8efcc22010-12-20 19:32:04 +01001344/*
1345 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001346 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001347 */
1348static bool is_chained_work(struct workqueue_struct *wq)
1349{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001350 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001351
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001352 worker = current_wq_worker();
1353 /*
1354 * Return %true iff I'm a worker execuing a work item on @wq. If
1355 * I'm @worker, it's safe to dereference it without locking.
1356 */
Tejun Heo112202d2013-02-13 19:29:12 -08001357 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001358}
1359
Mike Galbraithef5571802016-02-09 17:59:38 -05001360/*
1361 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1362 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1363 * avoid perturbing sensitive tasks.
1364 */
1365static int wq_select_unbound_cpu(int cpu)
1366{
Tejun Heof303fcc2016-02-09 17:59:38 -05001367 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001368 int new_cpu;
1369
Tejun Heof303fcc2016-02-09 17:59:38 -05001370 if (likely(!wq_debug_force_rr_cpu)) {
1371 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1372 return cpu;
1373 } else if (!printed_dbg_warning) {
1374 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1375 printed_dbg_warning = true;
1376 }
1377
Mike Galbraithef5571802016-02-09 17:59:38 -05001378 if (cpumask_empty(wq_unbound_cpumask))
1379 return cpu;
1380
1381 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1382 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1383 if (unlikely(new_cpu >= nr_cpu_ids)) {
1384 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1385 if (unlikely(new_cpu >= nr_cpu_ids))
1386 return cpu;
1387 }
1388 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1389
1390 return new_cpu;
1391}
1392
Tejun Heod84ff052013-03-12 11:29:59 -07001393static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 struct work_struct *work)
1395{
Tejun Heo112202d2013-02-13 19:29:12 -08001396 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001397 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001398 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001399 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001400 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001401
1402 /*
1403 * While a work item is PENDING && off queue, a task trying to
1404 * steal the PENDING will busy-loop waiting for it to either get
1405 * queued or lose PENDING. Grabbing PENDING and queueing should
1406 * happen with IRQ disabled.
1407 */
1408 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001410 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001411
Li Bin9ef28a72013-09-09 13:13:58 +08001412 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001413 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001414 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001415 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001416retry:
Tejun Heoc9178082013-03-12 11:30:04 -07001417 /* pwq which will be used unless @work is executing elsewhere */
Hillf Danton3772b932020-01-24 20:14:45 -05001418 if (wq->flags & WQ_UNBOUND) {
1419 if (req_cpu == WORK_CPU_UNBOUND)
1420 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001421 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Hillf Danton3772b932020-01-24 20:14:45 -05001422 } else {
1423 if (req_cpu == WORK_CPU_UNBOUND)
1424 cpu = raw_smp_processor_id();
1425 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1426 }
Tejun Heodbf25762012-08-20 14:51:23 -07001427
Tejun Heoc9178082013-03-12 11:30:04 -07001428 /*
1429 * If @work was previously on a different pool, it might still be
1430 * running there, in which case the work needs to be queued on that
1431 * pool to guarantee non-reentrancy.
1432 */
1433 last_pool = get_work_pool(work);
1434 if (last_pool && last_pool != pwq->pool) {
1435 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001436
Tejun Heoc9178082013-03-12 11:30:04 -07001437 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001438
Tejun Heoc9178082013-03-12 11:30:04 -07001439 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001440
Tejun Heoc9178082013-03-12 11:30:04 -07001441 if (worker && worker->current_pwq->wq == wq) {
1442 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001443 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001444 /* meh... not running there, queue here */
1445 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001446 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001447 }
Tejun Heof3421792010-07-02 10:03:51 +02001448 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001449 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001450 }
1451
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001452 /*
1453 * pwq is determined and locked. For unbound pools, we could have
1454 * raced with pwq release and it could already be dead. If its
1455 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001456 * without another pwq replacing it in the numa_pwq_tbl or while
1457 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001458 * make forward-progress.
1459 */
1460 if (unlikely(!pwq->refcnt)) {
1461 if (wq->flags & WQ_UNBOUND) {
1462 spin_unlock(&pwq->pool->lock);
1463 cpu_relax();
1464 goto retry;
1465 }
1466 /* oops */
1467 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1468 wq->name, cpu);
1469 }
1470
Tejun Heo112202d2013-02-13 19:29:12 -08001471 /* pwq determined, queue */
1472 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001473
Dan Carpenterf5b25522012-04-13 22:06:58 +03001474 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001475 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001476 return;
1477 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001478
Tejun Heo112202d2013-02-13 19:29:12 -08001479 pwq->nr_in_flight[pwq->work_color]++;
1480 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001481
Tejun Heo112202d2013-02-13 19:29:12 -08001482 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001483 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001484 pwq->nr_active++;
1485 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001486 if (list_empty(worklist))
1487 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001488 } else {
1489 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001490 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001491 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001492
Tejun Heo112202d2013-02-13 19:29:12 -08001493 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001494
Tejun Heo112202d2013-02-13 19:29:12 -08001495 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496}
1497
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001498/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001499 * queue_work_on - queue work on specific cpu
1500 * @cpu: CPU number to execute work on
1501 * @wq: workqueue to use
1502 * @work: work to queue
1503 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001504 * We queue the work to a specific CPU, the caller must ensure it
1505 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001506 *
1507 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001508 */
Tejun Heod4283e92012-08-03 10:30:44 -07001509bool queue_work_on(int cpu, struct workqueue_struct *wq,
1510 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001511{
Tejun Heod4283e92012-08-03 10:30:44 -07001512 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001513 unsigned long flags;
1514
1515 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001516
Tejun Heo22df02b2010-06-29 10:07:10 +02001517 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001518 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001519 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001520 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001521
1522 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001523 return ret;
1524}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001525EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001526
Tejun Heod8e794d2012-08-03 10:30:45 -07001527void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528{
David Howells52bad642006-11-22 14:54:01 +00001529 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001531 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001532 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001534EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001536static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1537 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001539 struct timer_list *timer = &dwork->timer;
1540 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
Tejun Heo757e1842017-03-06 15:33:42 -05001542 WARN_ON_ONCE(!wq);
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001543 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1544 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001545 WARN_ON_ONCE(timer_pending(timer));
1546 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001547
Tejun Heo8852aac2012-12-01 16:23:42 -08001548 /*
1549 * If @delay is 0, queue @dwork->work immediately. This is for
1550 * both optimization and correctness. The earliest @timer can
1551 * expire is on the closest next tick and delayed_work users depend
1552 * on that there's no such delay when @delay is 0.
1553 */
1554 if (!delay) {
1555 __queue_work(cpu, wq, &dwork->work);
1556 return;
1557 }
1558
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001559 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001560 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001561 timer->expires = jiffies + delay;
1562
Tejun Heo041bd122016-02-09 16:11:26 -05001563 if (unlikely(cpu != WORK_CPU_UNBOUND))
1564 add_timer_on(timer, cpu);
1565 else
1566 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567}
1568
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001569/**
1570 * queue_delayed_work_on - queue work on specific CPU after delay
1571 * @cpu: CPU number to execute work on
1572 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001573 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001574 * @delay: number of jiffies to wait before queueing
1575 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001576 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001577 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1578 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001579 */
Tejun Heod4283e92012-08-03 10:30:44 -07001580bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1581 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001582{
David Howells52bad642006-11-22 14:54:01 +00001583 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001584 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001585 unsigned long flags;
1586
1587 /* read the comment in __queue_work() */
1588 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001589
Tejun Heo22df02b2010-06-29 10:07:10 +02001590 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001591 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001592 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001593 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001594
1595 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001596 return ret;
1597}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001598EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
Tejun Heoc8e55f32010-06-29 10:07:12 +02001600/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001601 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1602 * @cpu: CPU number to execute work on
1603 * @wq: workqueue to use
1604 * @dwork: work to queue
1605 * @delay: number of jiffies to wait before queueing
1606 *
1607 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1608 * modify @dwork's timer so that it expires after @delay. If @delay is
1609 * zero, @work is guaranteed to be scheduled immediately regardless of its
1610 * current state.
1611 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001612 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001613 * pending and its timer was modified.
1614 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001615 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001616 * See try_to_grab_pending() for details.
1617 */
1618bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1619 struct delayed_work *dwork, unsigned long delay)
1620{
1621 unsigned long flags;
1622 int ret;
1623
1624 do {
1625 ret = try_to_grab_pending(&dwork->work, true, &flags);
1626 } while (unlikely(ret == -EAGAIN));
1627
1628 if (likely(ret >= 0)) {
1629 __queue_delayed_work(cpu, wq, dwork, delay);
1630 local_irq_restore(flags);
1631 }
1632
1633 /* -ENOENT from try_to_grab_pending() becomes %true */
1634 return ret;
1635}
1636EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1637
1638/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001639 * worker_enter_idle - enter idle state
1640 * @worker: worker which is entering idle state
1641 *
1642 * @worker is entering idle state. Update stats and idle timer if
1643 * necessary.
1644 *
1645 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001646 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001647 */
1648static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001650 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
Tejun Heo6183c002013-03-12 11:29:57 -07001652 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1653 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1654 (worker->hentry.next || worker->hentry.pprev)))
1655 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656
Lai Jiangshan051e1852014-07-22 13:03:02 +08001657 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001658 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001659 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001660 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001661
Tejun Heoc8e55f32010-06-29 10:07:12 +02001662 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001663 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001664
Tejun Heo628c78e2012-07-17 12:39:27 -07001665 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1666 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001667
Tejun Heo544ecf32012-05-14 15:04:50 -07001668 /*
Lai Jiangshan6128fcb2017-12-01 22:20:36 +08001669 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001670 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001671 * nr_running, the warning may trigger spuriously. Check iff
1672 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001673 */
Tejun Heo24647572013-01-24 11:01:33 -08001674 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001675 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001676 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677}
1678
Tejun Heoc8e55f32010-06-29 10:07:12 +02001679/**
1680 * worker_leave_idle - leave idle state
1681 * @worker: worker which is leaving idle state
1682 *
1683 * @worker is leaving idle state. Update stats.
1684 *
1685 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001686 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001687 */
1688static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001690 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
Tejun Heo6183c002013-03-12 11:29:57 -07001692 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1693 return;
Tejun Heod302f012010-06-29 10:07:13 +02001694 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001695 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001696 list_del_init(&worker->entry);
1697}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001699static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001700{
1701 struct worker *worker;
1702
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001703 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001704 if (worker) {
1705 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001706 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001707 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001708 /* on creation a worker is in !idle && prep state */
1709 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001710 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001711 return worker;
1712}
1713
1714/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001715 * worker_attach_to_pool() - attach a worker to a pool
1716 * @worker: worker to be attached
1717 * @pool: the target pool
1718 *
1719 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1720 * cpu-binding of @worker are kept coordinated with the pool across
1721 * cpu-[un]hotplugs.
1722 */
1723static void worker_attach_to_pool(struct worker *worker,
1724 struct worker_pool *pool)
1725{
1726 mutex_lock(&pool->attach_mutex);
1727
1728 /*
1729 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1730 * online CPUs. It'll be re-applied when any of the CPUs come up.
1731 */
1732 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1733
1734 /*
1735 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1736 * stable across this function. See the comments above the
1737 * flag definition for details.
1738 */
1739 if (pool->flags & POOL_DISASSOCIATED)
1740 worker->flags |= WORKER_UNBOUND;
1741
1742 list_add_tail(&worker->node, &pool->workers);
1743
1744 mutex_unlock(&pool->attach_mutex);
1745}
1746
1747/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001748 * worker_detach_from_pool() - detach a worker from its pool
1749 * @worker: worker which is attached to its pool
1750 * @pool: the pool @worker is attached to
1751 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001752 * Undo the attaching which had been done in worker_attach_to_pool(). The
1753 * caller worker shouldn't access to the pool after detached except it has
1754 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001755 */
1756static void worker_detach_from_pool(struct worker *worker,
1757 struct worker_pool *pool)
1758{
1759 struct completion *detach_completion = NULL;
1760
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001761 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001762 list_del(&worker->node);
1763 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001764 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001765 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001766
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001767 /* clear leftover flags without pool->lock after it is detached */
1768 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1769
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001770 if (detach_completion)
1771 complete(detach_completion);
1772}
1773
1774/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001775 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001776 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001777 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001778 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001779 *
1780 * CONTEXT:
1781 * Might sleep. Does GFP_KERNEL allocations.
1782 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001783 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001784 * Pointer to the newly created worker.
1785 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001786static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001787{
Tejun Heoc34056a2010-06-29 10:07:11 +02001788 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001789 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001790 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001791
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001792 /* ID is needed to determine kthread name */
1793 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001794 if (id < 0)
1795 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001796
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001797 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001798 if (!worker)
1799 goto fail;
1800
Tejun Heobd7bdd42012-07-12 14:46:37 -07001801 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001802 worker->id = id;
1803
Tejun Heo29c91e92013-03-12 11:30:03 -07001804 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001805 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1806 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001807 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001808 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1809
Tejun Heof3f90ad2013-04-01 11:23:34 -07001810 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001811 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001812 if (IS_ERR(worker->task))
1813 goto fail;
1814
Oleg Nesterov91151222013-11-14 12:56:18 +01001815 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001816 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001817
Lai Jiangshanda028462014-05-20 17:46:31 +08001818 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001819 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001820
Lai Jiangshan051e1852014-07-22 13:03:02 +08001821 /* start the newly created worker */
1822 spin_lock_irq(&pool->lock);
1823 worker->pool->nr_workers++;
1824 worker_enter_idle(worker);
1825 wake_up_process(worker->task);
1826 spin_unlock_irq(&pool->lock);
1827
Tejun Heoc34056a2010-06-29 10:07:11 +02001828 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001829
Tejun Heoc34056a2010-06-29 10:07:11 +02001830fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001831 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001832 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001833 kfree(worker);
1834 return NULL;
1835}
1836
1837/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001838 * destroy_worker - destroy a workqueue worker
1839 * @worker: worker to be destroyed
1840 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001841 * Destroy @worker and adjust @pool stats accordingly. The worker should
1842 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001843 *
1844 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001845 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001846 */
1847static void destroy_worker(struct worker *worker)
1848{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001849 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001850
Tejun Heocd549682013-03-13 19:47:39 -07001851 lockdep_assert_held(&pool->lock);
1852
Tejun Heoc34056a2010-06-29 10:07:11 +02001853 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001854 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001855 WARN_ON(!list_empty(&worker->scheduled)) ||
1856 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001857 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001858
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001859 pool->nr_workers--;
1860 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001861
Tejun Heoc8e55f32010-06-29 10:07:12 +02001862 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001863 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001864 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001865}
1866
Tejun Heo63d95a92012-07-12 14:46:37 -07001867static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001868{
Tejun Heo63d95a92012-07-12 14:46:37 -07001869 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001870
Tejun Heod565ed62013-01-24 11:01:33 -08001871 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001872
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001873 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001874 struct worker *worker;
1875 unsigned long expires;
1876
1877 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001878 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001879 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1880
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001881 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001882 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001883 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001884 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001885
1886 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001887 }
1888
Tejun Heod565ed62013-01-24 11:01:33 -08001889 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001890}
1891
Tejun Heo493a1722013-03-12 11:29:59 -07001892static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001893{
Tejun Heo112202d2013-02-13 19:29:12 -08001894 struct pool_workqueue *pwq = get_work_pwq(work);
1895 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001896
Tejun Heo2e109a22013-03-13 19:47:40 -07001897 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001898
Tejun Heo493008a2013-03-12 11:30:03 -07001899 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001900 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001901
1902 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001903 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001904 /*
1905 * If @pwq is for an unbound wq, its base ref may be put at
1906 * any time due to an attribute change. Pin @pwq until the
1907 * rescuer is done with it.
1908 */
1909 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001910 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001911 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001912 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001913}
1914
Tejun Heo706026c2013-01-24 11:01:34 -08001915static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001916{
Tejun Heo63d95a92012-07-12 14:46:37 -07001917 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001918 struct work_struct *work;
1919
Tejun Heob2d82902014-12-08 12:39:16 -05001920 spin_lock_irq(&pool->lock);
1921 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001922
Tejun Heo63d95a92012-07-12 14:46:37 -07001923 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001924 /*
1925 * We've been trying to create a new worker but
1926 * haven't been successful. We might be hitting an
1927 * allocation deadlock. Send distress signals to
1928 * rescuers.
1929 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001930 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001931 send_mayday(work);
1932 }
1933
Tejun Heob2d82902014-12-08 12:39:16 -05001934 spin_unlock(&wq_mayday_lock);
1935 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001936
Tejun Heo63d95a92012-07-12 14:46:37 -07001937 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001938}
1939
1940/**
1941 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001942 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001943 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001944 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001945 * have at least one idle worker on return from this function. If
1946 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001947 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001948 * possible allocation deadlock.
1949 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001950 * On return, need_to_create_worker() is guaranteed to be %false and
1951 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001952 *
1953 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001954 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001955 * multiple times. Does GFP_KERNEL allocations. Called only from
1956 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001957 */
Tejun Heo29187a92015-01-16 14:21:16 -05001958static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001959__releases(&pool->lock)
1960__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001961{
Tejun Heoe22bee72010-06-29 10:07:14 +02001962restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001963 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001964
Tejun Heoe22bee72010-06-29 10:07:14 +02001965 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001966 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001967
1968 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001969 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001970 break;
1971
Lai Jiangshane212f362014-06-03 15:32:17 +08001972 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001973
Tejun Heo63d95a92012-07-12 14:46:37 -07001974 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001975 break;
1976 }
1977
Tejun Heo63d95a92012-07-12 14:46:37 -07001978 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001979 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001980 /*
1981 * This is necessary even after a new worker was just successfully
1982 * created as @pool->lock was dropped and the new worker might have
1983 * already become busy.
1984 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001985 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001986 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001987}
1988
1989/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001990 * manage_workers - manage worker pool
1991 * @worker: self
1992 *
Tejun Heo706026c2013-01-24 11:01:34 -08001993 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001994 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001995 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001996 *
1997 * The caller can safely start processing works on false return. On
1998 * true return, it's guaranteed that need_to_create_worker() is false
1999 * and may_start_working() is true.
2000 *
2001 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002002 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002003 * multiple times. Does GFP_KERNEL allocations.
2004 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002005 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002006 * %false if the pool doesn't need management and the caller can safely
2007 * start processing works, %true if management function was performed and
2008 * the conditions that the caller verified before calling the function may
2009 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002010 */
2011static bool manage_workers(struct worker *worker)
2012{
Tejun Heo63d95a92012-07-12 14:46:37 -07002013 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002014
Tejun Heo43a980a2017-10-09 08:04:13 -07002015 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002016 return false;
Tejun Heo43a980a2017-10-09 08:04:13 -07002017
2018 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002019 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002020
Tejun Heo29187a92015-01-16 14:21:16 -05002021 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002022
Tejun Heo2607d7a2015-03-09 09:22:28 -04002023 pool->manager = NULL;
Tejun Heo43a980a2017-10-09 08:04:13 -07002024 pool->flags &= ~POOL_MANAGER_ACTIVE;
2025 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002026 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002027}
2028
Tejun Heoa62428c2010-06-29 10:07:10 +02002029/**
2030 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002031 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002032 * @work: work to process
2033 *
2034 * Process @work. This function contains all the logics necessary to
2035 * process a single work including synchronization against and
2036 * interaction with other workers on the same cpu, queueing and
2037 * flushing. As long as context requirement is met, any worker can
2038 * call this function to process a work.
2039 *
2040 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002041 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002042 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002043static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002044__releases(&pool->lock)
2045__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002046{
Tejun Heo112202d2013-02-13 19:29:12 -08002047 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002048 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002049 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002050 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002051 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002052#ifdef CONFIG_LOCKDEP
2053 /*
2054 * It is permissible to free the struct work_struct from
2055 * inside the function that is called from it, this we need to
2056 * take into account for lockdep too. To avoid bogus "held
2057 * lock freed" warnings as well as problems when looking into
2058 * work->lockdep_map, make a copy and use that here.
2059 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002060 struct lockdep_map lockdep_map;
2061
2062 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002063#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002064 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002065 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002066 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002067
Tejun Heo7e116292010-06-29 10:07:13 +02002068 /*
2069 * A single work shouldn't be executed concurrently by
2070 * multiple workers on a single cpu. Check whether anyone is
2071 * already processing the work. If so, defer the work to the
2072 * currently executing one.
2073 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002074 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002075 if (unlikely(collision)) {
2076 move_linked_works(work, &collision->scheduled, NULL);
2077 return;
2078 }
2079
Tejun Heo8930cab2012-08-03 10:30:45 -07002080 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002081 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002082 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002083 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002084 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002085 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002086 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002087
Tejun Heoa62428c2010-06-29 10:07:10 +02002088 list_del_init(&work->entry);
2089
Tejun Heo649027d2010-06-29 10:07:14 +02002090 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002091 * CPU intensive works don't participate in concurrency management.
2092 * They're the scheduler's responsibility. This takes @worker out
2093 * of concurrency management and the next code block will chain
2094 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002095 */
2096 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002097 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002098
Tejun Heo974271c2012-07-12 14:46:37 -07002099 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002100 * Wake up another worker if necessary. The condition is always
2101 * false for normal per-cpu workers since nr_running would always
2102 * be >= 1 at this point. This is used to chain execution of the
2103 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002104 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002105 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002106 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002107 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002108
Tejun Heo8930cab2012-08-03 10:30:45 -07002109 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002110 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002111 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002112 * PENDING and queued state changes happen together while IRQ is
2113 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002114 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002115 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002116
Tejun Heod565ed62013-01-24 11:01:33 -08002117 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002118
Tejun Heo112202d2013-02-13 19:29:12 -08002119 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002120 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002121 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002122 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002123 /*
2124 * While we must be careful to not use "work" after this, the trace
2125 * point will only record its address.
2126 */
2127 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002128 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002129 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002130
2131 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002132 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2133 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002134 current->comm, preempt_count(), task_pid_nr(current),
2135 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002136 debug_show_held_locks(current);
Syed Rameez Mustafacf9c1e42013-07-15 11:52:09 -07002137 BUG_ON(PANIC_CORRUPTION);
Tejun Heoa62428c2010-06-29 10:07:10 +02002138 dump_stack();
2139 }
2140
Tejun Heob22ce272013-08-28 17:33:37 -04002141 /*
2142 * The following prevents a kworker from hogging CPU on !PREEMPT
2143 * kernels, where a requeueing work item waiting for something to
2144 * happen could deadlock with stop_machine as such work item could
2145 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002146 * stop_machine. At the same time, report a quiescent RCU state so
2147 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002148 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002149 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002150
Tejun Heod565ed62013-01-24 11:01:33 -08002151 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002152
Tejun Heofb0e7be2010-06-29 10:07:15 +02002153 /* clear cpu intensive status */
2154 if (unlikely(cpu_intensive))
2155 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2156
Johannes Weinerb7f0f222019-02-01 14:20:42 -08002157 /* tag the worker for identification in schedule() */
2158 worker->last_func = worker->current_func;
2159
Tejun Heoa62428c2010-06-29 10:07:10 +02002160 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002161 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002162 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002163 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002164 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002165 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002166 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002167}
2168
Tejun Heoaffee4b2010-06-29 10:07:12 +02002169/**
2170 * process_scheduled_works - process scheduled works
2171 * @worker: self
2172 *
2173 * Process all scheduled works. Please note that the scheduled list
2174 * may change while processing a work, so this function repeatedly
2175 * fetches a work from the top and executes it.
2176 *
2177 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002178 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002179 * multiple times.
2180 */
2181static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002183 while (!list_empty(&worker->scheduled)) {
2184 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002186 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188}
2189
Tejun Heo4690c4a2010-06-29 10:07:10 +02002190/**
2191 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002192 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002193 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002194 * The worker thread function. All workers belong to a worker_pool -
2195 * either a per-cpu one or dynamic unbound one. These workers process all
2196 * work items regardless of their specific target workqueue. The only
2197 * exception is work items which belong to workqueues with a rescuer which
2198 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002199 *
2200 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002201 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002202static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203{
Tejun Heoc34056a2010-06-29 10:07:11 +02002204 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002205 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206
Tejun Heoe22bee72010-06-29 10:07:14 +02002207 /* tell the scheduler that this is a workqueue worker */
2208 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002209woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002210 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002211
Tejun Heoa9ab7752013-03-19 13:45:21 -07002212 /* am I supposed to die? */
2213 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002214 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002215 WARN_ON_ONCE(!list_empty(&worker->entry));
2216 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002217
2218 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002219 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002220 worker_detach_from_pool(worker, pool);
2221 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002222 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002224
Tejun Heoc8e55f32010-06-29 10:07:12 +02002225 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002226recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002227 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002228 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002229 goto sleep;
2230
2231 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002232 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002233 goto recheck;
2234
Tejun Heoc8e55f32010-06-29 10:07:12 +02002235 /*
2236 * ->scheduled list can only be filled while a worker is
2237 * preparing to process a work or actually processing it.
2238 * Make sure nobody diddled with it while I was sleeping.
2239 */
Tejun Heo6183c002013-03-12 11:29:57 -07002240 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002241
Tejun Heoe22bee72010-06-29 10:07:14 +02002242 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002243 * Finish PREP stage. We're guaranteed to have at least one idle
2244 * worker or that someone else has already assumed the manager
2245 * role. This is where @worker starts participating in concurrency
2246 * management if applicable and concurrency management is restored
2247 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002248 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002249 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002250
2251 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002252 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002253 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002254 struct work_struct, entry);
2255
Tejun Heo82607adc2015-12-08 11:28:04 -05002256 pool->watchdog_ts = jiffies;
2257
Tejun Heoc8e55f32010-06-29 10:07:12 +02002258 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2259 /* optimization path, not strictly necessary */
2260 process_one_work(worker, work);
2261 if (unlikely(!list_empty(&worker->scheduled)))
2262 process_scheduled_works(worker);
2263 } else {
2264 move_linked_works(work, &worker->scheduled, NULL);
2265 process_scheduled_works(worker);
2266 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002267 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002268
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002269 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002270sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002271 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002272 * pool->lock is held and there's no work to process and no need to
2273 * manage, sleep. Workers are woken up only while holding
2274 * pool->lock or from local cpu, so setting the current state
2275 * before releasing pool->lock is enough to prevent losing any
2276 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002277 */
2278 worker_enter_idle(worker);
2279 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002280 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002281 schedule();
2282 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283}
2284
Tejun Heoe22bee72010-06-29 10:07:14 +02002285/**
2286 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002287 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002288 *
2289 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002290 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002291 *
Tejun Heo706026c2013-01-24 11:01:34 -08002292 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002293 * worker which uses GFP_KERNEL allocation which has slight chance of
2294 * developing into deadlock if some works currently on the same queue
2295 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2296 * the problem rescuer solves.
2297 *
Tejun Heo706026c2013-01-24 11:01:34 -08002298 * When such condition is possible, the pool summons rescuers of all
2299 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002300 * those works so that forward progress can be guaranteed.
2301 *
2302 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002303 *
2304 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002305 */
Tejun Heo111c2252013-01-17 17:16:24 -08002306static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002307{
Tejun Heo111c2252013-01-17 17:16:24 -08002308 struct worker *rescuer = __rescuer;
2309 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002310 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002311 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002312
2313 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002314
2315 /*
2316 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2317 * doesn't participate in concurrency management.
2318 */
2319 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002320repeat:
2321 set_current_state(TASK_INTERRUPTIBLE);
2322
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002323 /*
2324 * By the time the rescuer is requested to stop, the workqueue
2325 * shouldn't have any work pending, but @wq->maydays may still have
2326 * pwq(s) queued. This can happen by non-rescuer workers consuming
2327 * all the work items before the rescuer got to them. Go through
2328 * @wq->maydays processing before acting on should_stop so that the
2329 * list is always empty on exit.
2330 */
2331 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002332
Tejun Heo493a1722013-03-12 11:29:59 -07002333 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002334 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002335
2336 while (!list_empty(&wq->maydays)) {
2337 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2338 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002339 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002340 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002341 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002342
2343 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002344 list_del_init(&pwq->mayday_node);
2345
Tejun Heo2e109a22013-03-13 19:47:40 -07002346 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002347
Lai Jiangshan51697d392014-05-20 17:46:36 +08002348 worker_attach_to_pool(rescuer, pool);
2349
2350 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002351 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002352
2353 /*
2354 * Slurp in all works issued via this workqueue and
2355 * process'em.
2356 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002357 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002358 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2359 if (get_work_pwq(work) == pwq) {
2360 if (first)
2361 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002362 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002363 }
2364 first = false;
2365 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002366
NeilBrown008847f2014-12-08 12:39:16 -05002367 if (!list_empty(scheduled)) {
2368 process_scheduled_works(rescuer);
2369
2370 /*
2371 * The above execution of rescued work items could
2372 * have created more to rescue through
2373 * pwq_activate_first_delayed() or chained
2374 * queueing. Let's put @pwq back on mayday list so
2375 * that such back-to-back work items, which may be
2376 * being used to relieve memory pressure, don't
2377 * incur MAYDAY_INTERVAL delay inbetween.
2378 */
2379 if (need_to_create_worker(pool)) {
2380 spin_lock(&wq_mayday_lock);
Tejun Heo4f5b0c72019-09-25 06:59:15 -07002381 /*
2382 * Queue iff we aren't racing destruction
2383 * and somebody else hasn't queued it already.
2384 */
2385 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2386 get_pwq(pwq);
2387 list_add_tail(&pwq->mayday_node, &wq->maydays);
2388 }
NeilBrown008847f2014-12-08 12:39:16 -05002389 spin_unlock(&wq_mayday_lock);
2390 }
2391 }
Tejun Heo75769582011-02-14 14:04:46 +01002392
2393 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002394 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002395 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002396 */
2397 put_pwq(pwq);
2398
2399 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002400 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002401 * regular worker; otherwise, we end up with 0 concurrency
2402 * and stalling the execution.
2403 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002404 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002405 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002406
Lai Jiangshanb3104102013-02-19 12:17:02 -08002407 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002408 spin_unlock_irq(&pool->lock);
2409
2410 worker_detach_from_pool(rescuer, pool);
2411
2412 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002413 }
2414
Tejun Heo2e109a22013-03-13 19:47:40 -07002415 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002416
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002417 if (should_stop) {
2418 __set_current_state(TASK_RUNNING);
2419 rescuer->task->flags &= ~PF_WQ_WORKER;
2420 return 0;
2421 }
2422
Tejun Heo111c2252013-01-17 17:16:24 -08002423 /* rescuers should never participate in concurrency management */
2424 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002425 schedule();
2426 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427}
2428
Tejun Heofca839c2015-12-07 10:58:57 -05002429/**
2430 * check_flush_dependency - check for flush dependency sanity
2431 * @target_wq: workqueue being flushed
2432 * @target_work: work item being flushed (NULL for workqueue flushes)
2433 *
2434 * %current is trying to flush the whole @target_wq or @target_work on it.
2435 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2436 * reclaiming memory or running on a workqueue which doesn't have
2437 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2438 * a deadlock.
2439 */
2440static void check_flush_dependency(struct workqueue_struct *target_wq,
2441 struct work_struct *target_work)
2442{
2443 work_func_t target_func = target_work ? target_work->func : NULL;
2444 struct worker *worker;
2445
2446 if (target_wq->flags & WQ_MEM_RECLAIM)
2447 return;
2448
2449 worker = current_wq_worker();
2450
2451 WARN_ONCE(current->flags & PF_MEMALLOC,
2452 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2453 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002454 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2455 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002456 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2457 worker->current_pwq->wq->name, worker->current_func,
2458 target_wq->name, target_func);
2459}
2460
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002461struct wq_barrier {
2462 struct work_struct work;
2463 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002464 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002465};
2466
2467static void wq_barrier_func(struct work_struct *work)
2468{
2469 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2470 complete(&barr->done);
2471}
2472
Tejun Heo4690c4a2010-06-29 10:07:10 +02002473/**
2474 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002475 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002476 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002477 * @target: target work to attach @barr to
2478 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002479 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002480 * @barr is linked to @target such that @barr is completed only after
2481 * @target finishes execution. Please note that the ordering
2482 * guarantee is observed only with respect to @target and on the local
2483 * cpu.
2484 *
2485 * Currently, a queued barrier can't be canceled. This is because
2486 * try_to_grab_pending() can't determine whether the work to be
2487 * grabbed is at the head of the queue and thus can't clear LINKED
2488 * flag of the previous work while there must be a valid next work
2489 * after a work with LINKED flag set.
2490 *
2491 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002492 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002493 *
2494 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002495 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002496 */
Tejun Heo112202d2013-02-13 19:29:12 -08002497static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002498 struct wq_barrier *barr,
2499 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002500{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002501 struct list_head *head;
2502 unsigned int linked = 0;
2503
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002504 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002505 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002506 * as we know for sure that this will not trigger any of the
2507 * checks and call back into the fixup functions where we
2508 * might deadlock.
2509 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002510 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002511 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002512 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002513 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002514
Tejun Heoaffee4b2010-06-29 10:07:12 +02002515 /*
2516 * If @target is currently being executed, schedule the
2517 * barrier to the worker; otherwise, put it after @target.
2518 */
2519 if (worker)
2520 head = worker->scheduled.next;
2521 else {
2522 unsigned long *bits = work_data_bits(target);
2523
2524 head = target->entry.next;
2525 /* there can already be other linked works, inherit and set */
2526 linked = *bits & WORK_STRUCT_LINKED;
2527 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2528 }
2529
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002530 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002531 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002532 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002533}
2534
Tejun Heo73f53c42010-06-29 10:07:11 +02002535/**
Tejun Heo112202d2013-02-13 19:29:12 -08002536 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002537 * @wq: workqueue being flushed
2538 * @flush_color: new flush color, < 0 for no-op
2539 * @work_color: new work color, < 0 for no-op
2540 *
Tejun Heo112202d2013-02-13 19:29:12 -08002541 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002542 *
Tejun Heo112202d2013-02-13 19:29:12 -08002543 * If @flush_color is non-negative, flush_color on all pwqs should be
2544 * -1. If no pwq has in-flight commands at the specified color, all
2545 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2546 * has in flight commands, its pwq->flush_color is set to
2547 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002548 * wakeup logic is armed and %true is returned.
2549 *
2550 * The caller should have initialized @wq->first_flusher prior to
2551 * calling this function with non-negative @flush_color. If
2552 * @flush_color is negative, no flush color update is done and %false
2553 * is returned.
2554 *
Tejun Heo112202d2013-02-13 19:29:12 -08002555 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002556 * work_color which is previous to @work_color and all will be
2557 * advanced to @work_color.
2558 *
2559 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002560 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002561 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002562 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002563 * %true if @flush_color >= 0 and there's something to flush. %false
2564 * otherwise.
2565 */
Tejun Heo112202d2013-02-13 19:29:12 -08002566static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002567 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568{
Tejun Heo73f53c42010-06-29 10:07:11 +02002569 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002570 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002571
Tejun Heo73f53c42010-06-29 10:07:11 +02002572 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002573 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002574 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002575 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002576
Tejun Heo49e3cf42013-03-12 11:29:58 -07002577 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002578 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002579
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002580 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002581
2582 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002583 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002584
Tejun Heo112202d2013-02-13 19:29:12 -08002585 if (pwq->nr_in_flight[flush_color]) {
2586 pwq->flush_color = flush_color;
2587 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002588 wait = true;
2589 }
2590 }
2591
2592 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002593 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002594 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002595 }
2596
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002597 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002598 }
2599
Tejun Heo112202d2013-02-13 19:29:12 -08002600 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002601 complete(&wq->first_flusher->done);
2602
2603 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604}
2605
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002606/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002608 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002610 * This function sleeps until all work items which were queued on entry
2611 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002613void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614{
Tejun Heo73f53c42010-06-29 10:07:11 +02002615 struct wq_flusher this_flusher = {
2616 .list = LIST_HEAD_INIT(this_flusher.list),
2617 .flush_color = -1,
2618 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2619 };
2620 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002621
Tejun Heo4b5facd2016-09-16 15:49:32 -04002622 if (WARN_ON(!wq_online))
2623 return;
2624
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002625 lock_map_acquire(&wq->lockdep_map);
2626 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002627
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002628 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002629
2630 /*
2631 * Start-to-wait phase
2632 */
2633 next_color = work_next_color(wq->work_color);
2634
2635 if (next_color != wq->flush_color) {
2636 /*
2637 * Color space is not full. The current work_color
2638 * becomes our flush_color and work_color is advanced
2639 * by one.
2640 */
Tejun Heo6183c002013-03-12 11:29:57 -07002641 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002642 this_flusher.flush_color = wq->work_color;
2643 wq->work_color = next_color;
2644
2645 if (!wq->first_flusher) {
2646 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002647 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002648
2649 wq->first_flusher = &this_flusher;
2650
Tejun Heo112202d2013-02-13 19:29:12 -08002651 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002652 wq->work_color)) {
2653 /* nothing to flush, done */
2654 wq->flush_color = next_color;
2655 wq->first_flusher = NULL;
2656 goto out_unlock;
2657 }
2658 } else {
2659 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002660 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002661 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002662 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002663 }
2664 } else {
2665 /*
2666 * Oops, color space is full, wait on overflow queue.
2667 * The next flush completion will assign us
2668 * flush_color and transfer to flusher_queue.
2669 */
2670 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2671 }
2672
Tejun Heofca839c2015-12-07 10:58:57 -05002673 check_flush_dependency(wq, NULL);
2674
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002675 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002676
2677 wait_for_completion(&this_flusher.done);
2678
2679 /*
2680 * Wake-up-and-cascade phase
2681 *
2682 * First flushers are responsible for cascading flushes and
2683 * handling overflow. Non-first flushers can simply return.
2684 */
2685 if (wq->first_flusher != &this_flusher)
2686 return;
2687
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002688 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002689
Tejun Heo4ce48b32010-07-02 10:03:51 +02002690 /* we might have raced, check again with mutex held */
2691 if (wq->first_flusher != &this_flusher)
2692 goto out_unlock;
2693
Tejun Heo73f53c42010-06-29 10:07:11 +02002694 wq->first_flusher = NULL;
2695
Tejun Heo6183c002013-03-12 11:29:57 -07002696 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2697 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002698
2699 while (true) {
2700 struct wq_flusher *next, *tmp;
2701
2702 /* complete all the flushers sharing the current flush color */
2703 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2704 if (next->flush_color != wq->flush_color)
2705 break;
2706 list_del_init(&next->list);
2707 complete(&next->done);
2708 }
2709
Tejun Heo6183c002013-03-12 11:29:57 -07002710 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2711 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002712
2713 /* this flush_color is finished, advance by one */
2714 wq->flush_color = work_next_color(wq->flush_color);
2715
2716 /* one color has been freed, handle overflow queue */
2717 if (!list_empty(&wq->flusher_overflow)) {
2718 /*
2719 * Assign the same color to all overflowed
2720 * flushers, advance work_color and append to
2721 * flusher_queue. This is the start-to-wait
2722 * phase for these overflowed flushers.
2723 */
2724 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2725 tmp->flush_color = wq->work_color;
2726
2727 wq->work_color = work_next_color(wq->work_color);
2728
2729 list_splice_tail_init(&wq->flusher_overflow,
2730 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002731 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002732 }
2733
2734 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002735 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002736 break;
2737 }
2738
2739 /*
2740 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002741 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002742 */
Tejun Heo6183c002013-03-12 11:29:57 -07002743 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2744 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002745
2746 list_del_init(&next->list);
2747 wq->first_flusher = next;
2748
Tejun Heo112202d2013-02-13 19:29:12 -08002749 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002750 break;
2751
2752 /*
2753 * Meh... this color is already done, clear first
2754 * flusher and repeat cascading.
2755 */
2756 wq->first_flusher = NULL;
2757 }
2758
2759out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002760 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002762EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002764/**
2765 * drain_workqueue - drain a workqueue
2766 * @wq: workqueue to drain
2767 *
2768 * Wait until the workqueue becomes empty. While draining is in progress,
2769 * only chain queueing is allowed. IOW, only currently pending or running
2770 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002771 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002772 * by the depth of chaining and should be relatively short. Whine if it
2773 * takes too long.
2774 */
2775void drain_workqueue(struct workqueue_struct *wq)
2776{
2777 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002778 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002779
2780 /*
2781 * __queue_work() needs to test whether there are drainers, is much
2782 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002783 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002784 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002785 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002786 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002787 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002788 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002789reflush:
2790 flush_workqueue(wq);
2791
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002792 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002793
Tejun Heo49e3cf42013-03-12 11:29:58 -07002794 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002795 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002796
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002797 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002798 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002799 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002800
2801 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002802 continue;
2803
2804 if (++flush_cnt == 10 ||
2805 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002806 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002807 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002808
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002809 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002810 goto reflush;
2811 }
2812
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002813 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002814 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002815 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002816}
2817EXPORT_SYMBOL_GPL(drain_workqueue);
2818
Tejun Heo606a5022012-08-20 14:51:23 -07002819static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002820{
2821 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002822 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002823 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002824
2825 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002826
Tejun Heofa1b54e2013-03-12 11:30:00 -07002827 local_irq_disable();
2828 pool = get_work_pool(work);
2829 if (!pool) {
2830 local_irq_enable();
2831 return false;
2832 }
2833
2834 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002835 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002836 pwq = get_work_pwq(work);
2837 if (pwq) {
2838 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002839 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002840 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002841 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002842 if (!worker)
2843 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002844 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002845 }
Tejun Heobaf59022010-09-16 10:42:16 +02002846
Tejun Heofca839c2015-12-07 10:58:57 -05002847 check_flush_dependency(pwq->wq, work);
2848
Tejun Heo112202d2013-02-13 19:29:12 -08002849 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002850 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002851
Tejun Heoe1594892011-01-09 23:32:15 +01002852 /*
2853 * If @max_active is 1 or rescuer is in use, flushing another work
2854 * item on the same workqueue may lead to deadlock. Make sure the
2855 * flusher is not running on the same workqueue by verifying write
2856 * access.
2857 */
Tejun Heo493008a2013-03-12 11:30:03 -07002858 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002859 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002860 else
Tejun Heo112202d2013-02-13 19:29:12 -08002861 lock_map_acquire_read(&pwq->wq->lockdep_map);
2862 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002863
Tejun Heobaf59022010-09-16 10:42:16 +02002864 return true;
2865already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002866 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002867 return false;
2868}
2869
Oleg Nesterovdb700892008-07-25 01:47:49 -07002870/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002871 * flush_work - wait for a work to finish executing the last queueing instance
2872 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002873 *
Tejun Heo606a5022012-08-20 14:51:23 -07002874 * Wait until @work has finished execution. @work is guaranteed to be idle
2875 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002876 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002877 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002878 * %true if flush_work() waited for the work to finish execution,
2879 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002880 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002881bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002882{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002883 struct wq_barrier barr;
2884
Tejun Heo4b5facd2016-09-16 15:49:32 -04002885 if (WARN_ON(!wq_online))
2886 return false;
2887
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002888 lock_map_acquire(&work->lockdep_map);
2889 lock_map_release(&work->lockdep_map);
2890
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002891 if (start_flush_work(work, &barr)) {
2892 wait_for_completion(&barr.done);
2893 destroy_work_on_stack(&barr.work);
2894 return true;
2895 } else {
2896 return false;
2897 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002898}
2899EXPORT_SYMBOL_GPL(flush_work);
2900
Tejun Heo8603e1b32015-03-05 08:04:13 -05002901struct cwt_wait {
2902 wait_queue_t wait;
2903 struct work_struct *work;
2904};
2905
2906static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2907{
2908 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2909
2910 if (cwait->work != key)
2911 return 0;
2912 return autoremove_wake_function(wait, mode, sync, key);
2913}
2914
Tejun Heo36e227d2012-08-03 10:30:46 -07002915static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002916{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002917 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002918 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002919 int ret;
2920
2921 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002922 ret = try_to_grab_pending(work, is_dwork, &flags);
2923 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002924 * If someone else is already canceling, wait for it to
2925 * finish. flush_work() doesn't work for PREEMPT_NONE
2926 * because we may get scheduled between @work's completion
2927 * and the other canceling task resuming and clearing
2928 * CANCELING - flush_work() will return false immediately
2929 * as @work is no longer busy, try_to_grab_pending() will
2930 * return -ENOENT as @work is still being canceled and the
2931 * other canceling task won't be able to clear CANCELING as
2932 * we're hogging the CPU.
2933 *
2934 * Let's wait for completion using a waitqueue. As this
2935 * may lead to the thundering herd problem, use a custom
2936 * wake function which matches @work along with exclusive
2937 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002938 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002939 if (unlikely(ret == -ENOENT)) {
2940 struct cwt_wait cwait;
2941
2942 init_wait(&cwait.wait);
2943 cwait.wait.func = cwt_wakefn;
2944 cwait.work = work;
2945
2946 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2947 TASK_UNINTERRUPTIBLE);
2948 if (work_is_canceling(work))
2949 schedule();
2950 finish_wait(&cancel_waitq, &cwait.wait);
2951 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002952 } while (unlikely(ret < 0));
2953
Tejun Heobbb68df2012-08-03 10:30:46 -07002954 /* tell other tasks trying to grab @work to back off */
2955 mark_work_canceling(work);
2956 local_irq_restore(flags);
2957
Tejun Heo4b5facd2016-09-16 15:49:32 -04002958 /*
2959 * This allows canceling during early boot. We know that @work
2960 * isn't executing.
2961 */
2962 if (wq_online)
2963 flush_work(work);
2964
Tejun Heo7a22ad72010-06-29 10:07:13 +02002965 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002966
2967 /*
2968 * Paired with prepare_to_wait() above so that either
2969 * waitqueue_active() is visible here or !work_is_canceling() is
2970 * visible there.
2971 */
2972 smp_mb();
2973 if (waitqueue_active(&cancel_waitq))
2974 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2975
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002976 return ret;
2977}
2978
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002979/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002980 * cancel_work_sync - cancel a work and wait for it to finish
2981 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002982 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002983 * Cancel @work and wait for its execution to finish. This function
2984 * can be used even if the work re-queues itself or migrates to
2985 * another workqueue. On return from this function, @work is
2986 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002987 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002988 * cancel_work_sync(&delayed_work->work) must not be used for
2989 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002990 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002991 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002992 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002993 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002994 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002995 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002996 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002997bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002998{
Tejun Heo36e227d2012-08-03 10:30:46 -07002999 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003000}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003001EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003002
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003003/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003004 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3005 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003006 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003007 * Delayed timer is cancelled and the pending work is queued for
3008 * immediate execution. Like flush_work(), this function only
3009 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003010 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003011 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003012 * %true if flush_work() waited for the work to finish execution,
3013 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003014 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003015bool flush_delayed_work(struct delayed_work *dwork)
3016{
Tejun Heo8930cab2012-08-03 10:30:45 -07003017 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003018 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003019 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003020 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003021 return flush_work(&dwork->work);
3022}
3023EXPORT_SYMBOL(flush_delayed_work);
3024
Jens Axboef72b8792016-08-24 15:51:50 -06003025static bool __cancel_work(struct work_struct *work, bool is_dwork)
3026{
3027 unsigned long flags;
3028 int ret;
3029
3030 do {
3031 ret = try_to_grab_pending(work, is_dwork, &flags);
3032 } while (unlikely(ret == -EAGAIN));
3033
3034 if (unlikely(ret < 0))
3035 return false;
3036
3037 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3038 local_irq_restore(flags);
3039 return ret;
3040}
3041
3042/*
3043 * See cancel_delayed_work()
3044 */
3045bool cancel_work(struct work_struct *work)
3046{
3047 return __cancel_work(work, false);
3048}
3049
Tejun Heo401a8d02010-09-16 10:36:00 +02003050/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003051 * cancel_delayed_work - cancel a delayed work
3052 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003053 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003054 * Kill off a pending delayed_work.
3055 *
3056 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3057 * pending.
3058 *
3059 * Note:
3060 * The work callback function may still be running on return, unless
3061 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3062 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003063 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003064 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003065 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003066bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003067{
Jens Axboef72b8792016-08-24 15:51:50 -06003068 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003069}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003070EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003071
3072/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003073 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3074 * @dwork: the delayed work cancel
3075 *
3076 * This is cancel_work_sync() for delayed works.
3077 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003078 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003079 * %true if @dwork was pending, %false otherwise.
3080 */
3081bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003082{
Tejun Heo36e227d2012-08-03 10:30:46 -07003083 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003084}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003085EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003086
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003087/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003088 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003089 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003090 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003091 * schedule_on_each_cpu() executes @func on each online CPU using the
3092 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003093 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003094 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003095 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003096 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003097 */
David Howells65f27f32006-11-22 14:55:48 +00003098int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003099{
3100 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003101 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003102
Andrew Mortonb6136772006-06-25 05:47:49 -07003103 works = alloc_percpu(struct work_struct);
3104 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003105 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003106
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003107 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003108
Christoph Lameter15316ba2006-01-08 01:00:43 -08003109 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003110 struct work_struct *work = per_cpu_ptr(works, cpu);
3111
3112 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003113 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003114 }
Tejun Heo93981802009-11-17 14:06:20 -08003115
3116 for_each_online_cpu(cpu)
3117 flush_work(per_cpu_ptr(works, cpu));
3118
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003119 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003120 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003121 return 0;
3122}
3123
Alan Sterneef6a7d2010-02-12 17:39:21 +09003124/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003125 * execute_in_process_context - reliably execute the routine with user context
3126 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003127 * @ew: guaranteed storage for the execute work structure (must
3128 * be available when the work executes)
3129 *
3130 * Executes the function immediately if process context is available,
3131 * otherwise schedules the function for delayed execution.
3132 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003133 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003134 * 1 - function was scheduled for execution
3135 */
David Howells65f27f32006-11-22 14:55:48 +00003136int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003137{
3138 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003139 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003140 return 0;
3141 }
3142
David Howells65f27f32006-11-22 14:55:48 +00003143 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003144 schedule_work(&ew->work);
3145
3146 return 1;
3147}
3148EXPORT_SYMBOL_GPL(execute_in_process_context);
3149
Tejun Heo7a4e3442013-03-12 11:30:00 -07003150/**
3151 * free_workqueue_attrs - free a workqueue_attrs
3152 * @attrs: workqueue_attrs to free
3153 *
3154 * Undo alloc_workqueue_attrs().
3155 */
3156void free_workqueue_attrs(struct workqueue_attrs *attrs)
3157{
3158 if (attrs) {
3159 free_cpumask_var(attrs->cpumask);
3160 kfree(attrs);
3161 }
3162}
3163
3164/**
3165 * alloc_workqueue_attrs - allocate a workqueue_attrs
3166 * @gfp_mask: allocation mask to use
3167 *
3168 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003169 * return it.
3170 *
3171 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003172 */
3173struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3174{
3175 struct workqueue_attrs *attrs;
3176
3177 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3178 if (!attrs)
3179 goto fail;
3180 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3181 goto fail;
3182
Tejun Heo13e2e552013-04-01 11:23:31 -07003183 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003184 return attrs;
3185fail:
3186 free_workqueue_attrs(attrs);
3187 return NULL;
3188}
3189
Tejun Heo29c91e92013-03-12 11:30:03 -07003190static void copy_workqueue_attrs(struct workqueue_attrs *to,
3191 const struct workqueue_attrs *from)
3192{
3193 to->nice = from->nice;
3194 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003195 /*
3196 * Unlike hash and equality test, this function doesn't ignore
3197 * ->no_numa as it is used for both pool and wq attrs. Instead,
3198 * get_unbound_pool() explicitly clears ->no_numa after copying.
3199 */
3200 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003201}
3202
Tejun Heo29c91e92013-03-12 11:30:03 -07003203/* hash value of the content of @attr */
3204static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3205{
3206 u32 hash = 0;
3207
3208 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003209 hash = jhash(cpumask_bits(attrs->cpumask),
3210 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003211 return hash;
3212}
3213
3214/* content equality test */
3215static bool wqattrs_equal(const struct workqueue_attrs *a,
3216 const struct workqueue_attrs *b)
3217{
3218 if (a->nice != b->nice)
3219 return false;
3220 if (!cpumask_equal(a->cpumask, b->cpumask))
3221 return false;
3222 return true;
3223}
3224
Tejun Heo7a4e3442013-03-12 11:30:00 -07003225/**
3226 * init_worker_pool - initialize a newly zalloc'd worker_pool
3227 * @pool: worker_pool to initialize
3228 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303229 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003230 *
3231 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003232 * inside @pool proper are initialized and put_unbound_pool() can be called
3233 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003234 */
3235static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003236{
3237 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003238 pool->id = -1;
3239 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003240 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003241 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003242 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003243 INIT_LIST_HEAD(&pool->worklist);
3244 INIT_LIST_HEAD(&pool->idle_list);
3245 hash_init(pool->busy_hash);
3246
3247 init_timer_deferrable(&pool->idle_timer);
3248 pool->idle_timer.function = idle_worker_timeout;
3249 pool->idle_timer.data = (unsigned long)pool;
3250
3251 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3252 (unsigned long)pool);
3253
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003254 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003255 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003256
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003257 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003258 INIT_HLIST_NODE(&pool->hash_node);
3259 pool->refcnt = 1;
3260
3261 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003262 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3263 if (!pool->attrs)
3264 return -ENOMEM;
3265 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003266}
3267
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003268static void rcu_free_wq(struct rcu_head *rcu)
3269{
3270 struct workqueue_struct *wq =
3271 container_of(rcu, struct workqueue_struct, rcu);
3272
3273 if (!(wq->flags & WQ_UNBOUND))
3274 free_percpu(wq->cpu_pwqs);
3275 else
3276 free_workqueue_attrs(wq->unbound_attrs);
3277
3278 kfree(wq->rescuer);
3279 kfree(wq);
3280}
3281
Tejun Heo29c91e92013-03-12 11:30:03 -07003282static void rcu_free_pool(struct rcu_head *rcu)
3283{
3284 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3285
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003286 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003287 free_workqueue_attrs(pool->attrs);
3288 kfree(pool);
3289}
3290
3291/**
3292 * put_unbound_pool - put a worker_pool
3293 * @pool: worker_pool to put
3294 *
3295 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003296 * safe manner. get_unbound_pool() calls this function on its failure path
3297 * and this function should be able to release pools which went through,
3298 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003299 *
3300 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003301 */
3302static void put_unbound_pool(struct worker_pool *pool)
3303{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003304 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003305 struct worker *worker;
3306
Tejun Heoa892cac2013-04-01 11:23:32 -07003307 lockdep_assert_held(&wq_pool_mutex);
3308
3309 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003310 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003311
3312 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003313 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003314 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003315 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003316
3317 /* release id and unhash */
3318 if (pool->id >= 0)
3319 idr_remove(&worker_pool_idr, pool->id);
3320 hash_del(&pool->hash_node);
3321
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003322 /*
Tejun Heo43a980a2017-10-09 08:04:13 -07003323 * Become the manager and destroy all workers. This prevents
3324 * @pool's workers from blocking on attach_mutex. We're the last
3325 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003326 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003327 spin_lock_irq(&pool->lock);
Tejun Heo43a980a2017-10-09 08:04:13 -07003328 wait_event_lock_irq(wq_manager_wait,
3329 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3330 pool->flags |= POOL_MANAGER_ACTIVE;
3331
Lai Jiangshan1037de32014-05-22 16:44:07 +08003332 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003333 destroy_worker(worker);
3334 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003335 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003336
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003337 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003338 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003339 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003340 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003341
3342 if (pool->detach_completion)
3343 wait_for_completion(pool->detach_completion);
3344
Tejun Heo29c91e92013-03-12 11:30:03 -07003345 /* shut down the timers */
3346 del_timer_sync(&pool->idle_timer);
3347 del_timer_sync(&pool->mayday_timer);
3348
3349 /* sched-RCU protected to allow dereferences from get_work_pool() */
3350 call_rcu_sched(&pool->rcu, rcu_free_pool);
3351}
3352
3353/**
3354 * get_unbound_pool - get a worker_pool with the specified attributes
3355 * @attrs: the attributes of the worker_pool to get
3356 *
3357 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3358 * reference count and return it. If there already is a matching
3359 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003360 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003361 *
3362 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003363 *
3364 * Return: On success, a worker_pool with the same attributes as @attrs.
3365 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003366 */
3367static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3368{
Tejun Heo29c91e92013-03-12 11:30:03 -07003369 u32 hash = wqattrs_hash(attrs);
3370 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003371 int node;
Xunlei Pange2273582015-10-09 11:53:12 +08003372 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003373
Tejun Heoa892cac2013-04-01 11:23:32 -07003374 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003375
3376 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003377 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3378 if (wqattrs_equal(pool->attrs, attrs)) {
3379 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003380 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003381 }
3382 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003383
Xunlei Pange2273582015-10-09 11:53:12 +08003384 /* if cpumask is contained inside a NUMA node, we belong to that node */
3385 if (wq_numa_enabled) {
3386 for_each_node(node) {
3387 if (cpumask_subset(attrs->cpumask,
3388 wq_numa_possible_cpumask[node])) {
3389 target_node = node;
3390 break;
3391 }
3392 }
3393 }
3394
Tejun Heo29c91e92013-03-12 11:30:03 -07003395 /* nope, create a new one */
Xunlei Pange2273582015-10-09 11:53:12 +08003396 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003397 if (!pool || init_worker_pool(pool) < 0)
3398 goto fail;
3399
Tejun Heo8864b4e2013-03-12 11:30:04 -07003400 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003401 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange2273582015-10-09 11:53:12 +08003402 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003403
Shaohua Li2865a8f2013-08-01 09:56:36 +08003404 /*
3405 * no_numa isn't a worker_pool attribute, always clear it. See
3406 * 'struct workqueue_attrs' comments for detail.
3407 */
3408 pool->attrs->no_numa = false;
3409
Tejun Heo29c91e92013-03-12 11:30:03 -07003410 if (worker_pool_assign_id(pool) < 0)
3411 goto fail;
3412
3413 /* create and start the initial worker */
Tejun Heo4b5facd2016-09-16 15:49:32 -04003414 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003415 goto fail;
3416
Tejun Heo29c91e92013-03-12 11:30:03 -07003417 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003418 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003419
Tejun Heo29c91e92013-03-12 11:30:03 -07003420 return pool;
3421fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003422 if (pool)
3423 put_unbound_pool(pool);
3424 return NULL;
3425}
3426
Tejun Heo8864b4e2013-03-12 11:30:04 -07003427static void rcu_free_pwq(struct rcu_head *rcu)
3428{
3429 kmem_cache_free(pwq_cache,
3430 container_of(rcu, struct pool_workqueue, rcu));
3431}
3432
3433/*
3434 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3435 * and needs to be destroyed.
3436 */
3437static void pwq_unbound_release_workfn(struct work_struct *work)
3438{
3439 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3440 unbound_release_work);
3441 struct workqueue_struct *wq = pwq->wq;
3442 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003443 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003444
3445 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3446 return;
3447
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003448 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003449 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003450 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003451 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003452
Tejun Heoa892cac2013-04-01 11:23:32 -07003453 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003454 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003455 mutex_unlock(&wq_pool_mutex);
3456
Tejun Heo8864b4e2013-03-12 11:30:04 -07003457 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3458
3459 /*
3460 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003461 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003462 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003463 if (is_last)
3464 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003465}
3466
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003467/**
Tejun Heo699ce092013-03-13 16:51:35 -07003468 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003469 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003470 *
Tejun Heo699ce092013-03-13 16:51:35 -07003471 * If @pwq isn't freezing, set @pwq->max_active to the associated
3472 * workqueue's saved_max_active and activate delayed work items
3473 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003474 */
Tejun Heo699ce092013-03-13 16:51:35 -07003475static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003476{
Tejun Heo699ce092013-03-13 16:51:35 -07003477 struct workqueue_struct *wq = pwq->wq;
3478 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo4b5facd2016-09-16 15:49:32 -04003479 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003480
Tejun Heo699ce092013-03-13 16:51:35 -07003481 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003482 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003483
3484 /* fast exit for non-freezable wqs */
3485 if (!freezable && pwq->max_active == wq->saved_max_active)
3486 return;
3487
Tejun Heo4b5facd2016-09-16 15:49:32 -04003488 /* this function can be called during early boot w/ irq disabled */
3489 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003490
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003491 /*
3492 * During [un]freezing, the caller is responsible for ensuring that
3493 * this function is called at least once after @workqueue_freezing
3494 * is updated and visible.
3495 */
3496 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003497 pwq->max_active = wq->saved_max_active;
3498
3499 while (!list_empty(&pwq->delayed_works) &&
3500 pwq->nr_active < pwq->max_active)
3501 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003502
3503 /*
3504 * Need to kick a worker after thawed or an unbound wq's
3505 * max_active is bumped. It's a slow path. Do it always.
3506 */
3507 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003508 } else {
3509 pwq->max_active = 0;
3510 }
3511
Tejun Heo4b5facd2016-09-16 15:49:32 -04003512 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003513}
3514
Tejun Heoe50aba92013-04-01 11:23:35 -07003515/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003516static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3517 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003518{
3519 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3520
Tejun Heoe50aba92013-04-01 11:23:35 -07003521 memset(pwq, 0, sizeof(*pwq));
3522
Tejun Heod2c1d402013-03-12 11:30:04 -07003523 pwq->pool = pool;
3524 pwq->wq = wq;
3525 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003526 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003527 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003528 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003529 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003530 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003531}
Tejun Heod2c1d402013-03-12 11:30:04 -07003532
Tejun Heof147f292013-04-01 11:23:35 -07003533/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003534static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003535{
3536 struct workqueue_struct *wq = pwq->wq;
3537
3538 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003539
Tejun Heo1befcf32013-04-01 11:23:35 -07003540 /* may be called multiple times, ignore if already linked */
3541 if (!list_empty(&pwq->pwqs_node))
3542 return;
3543
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003544 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003545 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003546
3547 /* sync max_active to the current setting */
3548 pwq_adjust_max_active(pwq);
3549
3550 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003551 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003552}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003553
Tejun Heof147f292013-04-01 11:23:35 -07003554/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3555static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3556 const struct workqueue_attrs *attrs)
3557{
3558 struct worker_pool *pool;
3559 struct pool_workqueue *pwq;
3560
3561 lockdep_assert_held(&wq_pool_mutex);
3562
3563 pool = get_unbound_pool(attrs);
3564 if (!pool)
3565 return NULL;
3566
Tejun Heoe50aba92013-04-01 11:23:35 -07003567 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003568 if (!pwq) {
3569 put_unbound_pool(pool);
3570 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003571 }
Tejun Heo6029a912013-04-01 11:23:34 -07003572
Tejun Heof147f292013-04-01 11:23:35 -07003573 init_pwq(pwq, wq, pool);
3574 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003575}
3576
Tejun Heo4c16bd32013-04-01 11:23:36 -07003577/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003578 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003579 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003580 * @node: the target NUMA node
3581 * @cpu_going_down: if >= 0, the CPU to consider as offline
3582 * @cpumask: outarg, the resulting cpumask
3583 *
3584 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3585 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003586 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003587 *
3588 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3589 * enabled and @node has online CPUs requested by @attrs, the returned
3590 * cpumask is the intersection of the possible CPUs of @node and
3591 * @attrs->cpumask.
3592 *
3593 * The caller is responsible for ensuring that the cpumask of @node stays
3594 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003595 *
3596 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3597 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003598 */
3599static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3600 int cpu_going_down, cpumask_t *cpumask)
3601{
Tejun Heod55262c2013-04-01 11:23:38 -07003602 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003603 goto use_dfl;
3604
3605 /* does @node have any online CPUs @attrs wants? */
3606 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3607 if (cpu_going_down >= 0)
3608 cpumask_clear_cpu(cpu_going_down, cpumask);
3609
3610 if (cpumask_empty(cpumask))
3611 goto use_dfl;
3612
3613 /* yeap, return possible CPUs in @node that @attrs wants */
3614 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3615 return !cpumask_equal(cpumask, attrs->cpumask);
3616
3617use_dfl:
3618 cpumask_copy(cpumask, attrs->cpumask);
3619 return false;
3620}
3621
Tejun Heo1befcf32013-04-01 11:23:35 -07003622/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3623static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3624 int node,
3625 struct pool_workqueue *pwq)
3626{
3627 struct pool_workqueue *old_pwq;
3628
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003629 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003630 lockdep_assert_held(&wq->mutex);
3631
3632 /* link_pwq() can handle duplicate calls */
3633 link_pwq(pwq);
3634
3635 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3636 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3637 return old_pwq;
3638}
3639
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003640/* context to store the prepared attrs & pwqs before applying */
3641struct apply_wqattrs_ctx {
3642 struct workqueue_struct *wq; /* target workqueue */
3643 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003644 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003645 struct pool_workqueue *dfl_pwq;
3646 struct pool_workqueue *pwq_tbl[];
3647};
3648
3649/* free the resources after success or abort */
3650static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3651{
3652 if (ctx) {
3653 int node;
3654
3655 for_each_node(node)
3656 put_pwq_unlocked(ctx->pwq_tbl[node]);
3657 put_pwq_unlocked(ctx->dfl_pwq);
3658
3659 free_workqueue_attrs(ctx->attrs);
3660
3661 kfree(ctx);
3662 }
3663}
3664
3665/* allocate the attrs and pwqs for later installation */
3666static struct apply_wqattrs_ctx *
3667apply_wqattrs_prepare(struct workqueue_struct *wq,
3668 const struct workqueue_attrs *attrs)
3669{
3670 struct apply_wqattrs_ctx *ctx;
3671 struct workqueue_attrs *new_attrs, *tmp_attrs;
3672 int node;
3673
3674 lockdep_assert_held(&wq_pool_mutex);
3675
3676 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3677 GFP_KERNEL);
3678
3679 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3680 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3681 if (!ctx || !new_attrs || !tmp_attrs)
3682 goto out_free;
3683
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003684 /*
3685 * Calculate the attrs of the default pwq.
3686 * If the user configured cpumask doesn't overlap with the
3687 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3688 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003689 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003690 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003691 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3692 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003693
3694 /*
3695 * We may create multiple pwqs with differing cpumasks. Make a
3696 * copy of @new_attrs which will be modified and used to obtain
3697 * pools.
3698 */
3699 copy_workqueue_attrs(tmp_attrs, new_attrs);
3700
3701 /*
3702 * If something goes wrong during CPU up/down, we'll fall back to
3703 * the default pwq covering whole @attrs->cpumask. Always create
3704 * it even if we don't use it immediately.
3705 */
3706 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3707 if (!ctx->dfl_pwq)
3708 goto out_free;
3709
3710 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003711 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003712 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3713 if (!ctx->pwq_tbl[node])
3714 goto out_free;
3715 } else {
3716 ctx->dfl_pwq->refcnt++;
3717 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3718 }
3719 }
3720
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003721 /* save the user configured attrs and sanitize it. */
3722 copy_workqueue_attrs(new_attrs, attrs);
3723 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003724 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003725
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003726 ctx->wq = wq;
3727 free_workqueue_attrs(tmp_attrs);
3728 return ctx;
3729
3730out_free:
3731 free_workqueue_attrs(tmp_attrs);
3732 free_workqueue_attrs(new_attrs);
3733 apply_wqattrs_cleanup(ctx);
3734 return NULL;
3735}
3736
3737/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3738static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3739{
3740 int node;
3741
3742 /* all pwqs have been created successfully, let's install'em */
3743 mutex_lock(&ctx->wq->mutex);
3744
3745 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3746
3747 /* save the previous pwq and install the new one */
3748 for_each_node(node)
3749 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3750 ctx->pwq_tbl[node]);
3751
3752 /* @dfl_pwq might not have been used, ensure it's linked */
3753 link_pwq(ctx->dfl_pwq);
3754 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3755
3756 mutex_unlock(&ctx->wq->mutex);
3757}
3758
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003759static void apply_wqattrs_lock(void)
3760{
3761 /* CPUs should stay stable across pwq creations and installations */
3762 get_online_cpus();
3763 mutex_lock(&wq_pool_mutex);
3764}
3765
3766static void apply_wqattrs_unlock(void)
3767{
3768 mutex_unlock(&wq_pool_mutex);
3769 put_online_cpus();
3770}
3771
3772static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3773 const struct workqueue_attrs *attrs)
3774{
3775 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003776
3777 /* only unbound workqueues can change attributes */
3778 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3779 return -EINVAL;
3780
3781 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heof9636c92017-07-23 08:36:15 -04003782 if (!list_empty(&wq->pwqs)) {
3783 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3784 return -EINVAL;
3785
3786 wq->flags &= ~__WQ_ORDERED;
3787 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003788
3789 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003790 if (!ctx)
3791 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003792
3793 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003794 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003795 apply_wqattrs_cleanup(ctx);
3796
wanghaibin62011712016-01-07 20:38:59 +08003797 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003798}
3799
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003800/**
3801 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3802 * @wq: the target workqueue
3803 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3804 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003805 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3806 * machines, this function maps a separate pwq to each NUMA node with
3807 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3808 * NUMA node it was issued on. Older pwqs are released as in-flight work
3809 * items finish. Note that a work item which repeatedly requeues itself
3810 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003811 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003812 * Performs GFP_KERNEL allocations.
3813 *
3814 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003815 */
3816int apply_workqueue_attrs(struct workqueue_struct *wq,
3817 const struct workqueue_attrs *attrs)
3818{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003819 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003820
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003821 apply_wqattrs_lock();
3822 ret = apply_workqueue_attrs_locked(wq, attrs);
3823 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003824
Tejun Heo48621252013-04-01 11:23:31 -07003825 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003826}
3827
Tejun Heo4c16bd32013-04-01 11:23:36 -07003828/**
3829 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3830 * @wq: the target workqueue
3831 * @cpu: the CPU coming up or going down
3832 * @online: whether @cpu is coming up or going down
3833 *
3834 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3835 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3836 * @wq accordingly.
3837 *
3838 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3839 * falls back to @wq->dfl_pwq which may not be optimal but is always
3840 * correct.
3841 *
3842 * Note that when the last allowed CPU of a NUMA node goes offline for a
3843 * workqueue with a cpumask spanning multiple nodes, the workers which were
3844 * already executing the work items for the workqueue will lose their CPU
3845 * affinity and may execute on any CPU. This is similar to how per-cpu
3846 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3847 * affinity, it's the user's responsibility to flush the work item from
3848 * CPU_DOWN_PREPARE.
3849 */
3850static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3851 bool online)
3852{
3853 int node = cpu_to_node(cpu);
3854 int cpu_off = online ? -1 : cpu;
3855 struct pool_workqueue *old_pwq = NULL, *pwq;
3856 struct workqueue_attrs *target_attrs;
3857 cpumask_t *cpumask;
3858
3859 lockdep_assert_held(&wq_pool_mutex);
3860
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003861 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3862 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003863 return;
3864
3865 /*
3866 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3867 * Let's use a preallocated one. The following buf is protected by
3868 * CPU hotplug exclusion.
3869 */
3870 target_attrs = wq_update_unbound_numa_attrs_buf;
3871 cpumask = target_attrs->cpumask;
3872
Tejun Heo4c16bd32013-04-01 11:23:36 -07003873 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3874 pwq = unbound_pwq_by_node(wq, node);
3875
3876 /*
3877 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003878 * different from the default pwq's, we need to compare it to @pwq's
3879 * and create a new one if they don't match. If the target cpumask
3880 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003881 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003882 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003883 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003884 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003885 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003886 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003887 }
3888
Tejun Heo4c16bd32013-04-01 11:23:36 -07003889 /* create a new pwq */
3890 pwq = alloc_unbound_pwq(wq, target_attrs);
3891 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003892 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3893 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003894 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003895 }
3896
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003897 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003898 mutex_lock(&wq->mutex);
3899 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3900 goto out_unlock;
3901
3902use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003903 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003904 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3905 get_pwq(wq->dfl_pwq);
3906 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3907 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3908out_unlock:
3909 mutex_unlock(&wq->mutex);
3910 put_pwq_unlocked(old_pwq);
3911}
3912
Tejun Heo30cdf242013-03-12 11:29:57 -07003913static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003914{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003915 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003916 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003917
Tejun Heo30cdf242013-03-12 11:29:57 -07003918 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003919 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3920 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003921 return -ENOMEM;
3922
3923 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003924 struct pool_workqueue *pwq =
3925 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003926 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003927 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003928
Tejun Heof147f292013-04-01 11:23:35 -07003929 init_pwq(pwq, wq, &cpu_pools[highpri]);
3930
3931 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003932 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003933 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003934 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003935 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003936 } else if (wq->flags & __WQ_ORDERED) {
3937 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3938 /* there should only be single pwq for ordering guarantee */
3939 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3940 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3941 "ordering guarantee broken for workqueue %s\n", wq->name);
3942 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003943 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003944 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003945 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003946}
3947
Tejun Heof3421792010-07-02 10:03:51 +02003948static int wq_clamp_max_active(int max_active, unsigned int flags,
3949 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003950{
Tejun Heof3421792010-07-02 10:03:51 +02003951 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3952
3953 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003954 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3955 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003956
Tejun Heof3421792010-07-02 10:03:51 +02003957 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003958}
3959
Tejun Heob196be82012-01-10 15:11:35 -08003960struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003961 unsigned int flags,
3962 int max_active,
3963 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003964 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003965{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003966 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003967 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003968 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003969 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003970
Tejun Heo61a0adb2017-07-18 18:41:52 -04003971 /*
3972 * Unbound && max_active == 1 used to imply ordered, which is no
3973 * longer the case on NUMA machines due to per-node pools. While
3974 * alloc_ordered_workqueue() is the right way to create an ordered
3975 * workqueue, keep the previous behavior to avoid subtle breakages
3976 * on NUMA.
3977 */
3978 if ((flags & WQ_UNBOUND) && max_active == 1)
3979 flags |= __WQ_ORDERED;
3980
Viresh Kumarcee22a12013-04-08 16:45:40 +05303981 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3982 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3983 flags |= WQ_UNBOUND;
3984
Tejun Heoecf68812013-04-01 11:23:34 -07003985 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003986 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003987 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003988
3989 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003990 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003991 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003992
Tejun Heo6029a912013-04-01 11:23:34 -07003993 if (flags & WQ_UNBOUND) {
3994 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3995 if (!wq->unbound_attrs)
3996 goto err_free_wq;
3997 }
3998
Tejun Heoecf68812013-04-01 11:23:34 -07003999 va_start(args, lock_name);
4000 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004001 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004002
Tejun Heod320c032010-06-29 10:07:14 +02004003 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004004 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004005
Tejun Heob196be82012-01-10 15:11:35 -08004006 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004007 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004008 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004009 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004010 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07004011 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004012 INIT_LIST_HEAD(&wq->flusher_queue);
4013 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004014 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004015
Johannes Bergeb13ba82008-01-16 09:51:58 +01004016 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004017 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004018
Tejun Heo30cdf242013-03-12 11:29:57 -07004019 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004020 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004021
Tejun Heo493008a2013-03-12 11:30:03 -07004022 /*
4023 * Workqueues which may be used during memory reclaim should
4024 * have a rescuer to guarantee forward progress.
4025 */
4026 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004027 struct worker *rescuer;
4028
Lai Jiangshanf7537df2014-07-15 17:24:15 +08004029 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02004030 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004031 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004032
Tejun Heo111c2252013-01-17 17:16:24 -08004033 rescuer->rescue_wq = wq;
4034 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004035 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004036 if (IS_ERR(rescuer->task)) {
4037 kfree(rescuer);
4038 goto err_destroy;
4039 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004040
Tejun Heod2c1d402013-03-12 11:30:04 -07004041 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02004042 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02004043 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004044 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004045
Tejun Heo226223a2013-03-12 11:30:05 -07004046 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4047 goto err_destroy;
4048
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004049 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004050 * wq_pool_mutex protects global freeze state and workqueues list.
4051 * Grab it, adjust max_active and add the new @wq to workqueues
4052 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004053 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004054 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004055
Lai Jiangshana357fc02013-03-25 16:57:19 -07004056 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004057 for_each_pwq(pwq, wq)
4058 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004059 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004060
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004061 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004062
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004063 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004064
Oleg Nesterov3af244332007-05-09 02:34:09 -07004065 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004066
4067err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004068 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004069 kfree(wq);
4070 return NULL;
4071err_destroy:
4072 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004073 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004074}
Tejun Heod320c032010-06-29 10:07:14 +02004075EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004076
4077/**
4078 * destroy_workqueue - safely terminate a workqueue
4079 * @wq: target workqueue
4080 *
4081 * Safely destroy a workqueue. All work currently pending will be done first.
4082 */
4083void destroy_workqueue(struct workqueue_struct *wq)
4084{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004085 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004086 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004087
Tejun Heo54f859a2019-09-18 18:43:40 -07004088 /*
4089 * Remove it from sysfs first so that sanity check failure doesn't
4090 * lead to sysfs name conflicts.
4091 */
4092 workqueue_sysfs_unregister(wq);
4093
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004094 /* drain it before proceeding with destruction */
4095 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004096
Tejun Heo54f859a2019-09-18 18:43:40 -07004097 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4098 if (wq->rescuer) {
4099 struct worker *rescuer = wq->rescuer;
4100
4101 /* this prevents new queueing */
4102 spin_lock_irq(&wq_mayday_lock);
4103 wq->rescuer = NULL;
4104 spin_unlock_irq(&wq_mayday_lock);
4105
4106 /* rescuer will empty maydays list before exiting */
4107 kthread_stop(rescuer->task);
Tejun Heo1a1e9ff2019-09-20 13:39:57 -07004108 kfree(rescuer);
Tejun Heo54f859a2019-09-18 18:43:40 -07004109 }
4110
Tejun Heo6183c002013-03-12 11:29:57 -07004111 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004112 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004113 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004114 int i;
4115
Tejun Heo76af4d92013-03-12 11:30:00 -07004116 for (i = 0; i < WORK_NR_COLORS; i++) {
4117 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004118 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004119 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004120 }
4121 }
4122
Lai Jiangshan5c529592013-04-04 10:05:38 +08004123 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004124 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004125 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004126 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004127 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004128 }
Tejun Heo6183c002013-03-12 11:29:57 -07004129 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004130 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004131
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004132 /*
4133 * wq list is used to freeze wq, remove from list after
4134 * flushing is complete in case freeze races us.
4135 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004136 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004137 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004138 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004139
Tejun Heo8864b4e2013-03-12 11:30:04 -07004140 if (!(wq->flags & WQ_UNBOUND)) {
4141 /*
4142 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004143 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004144 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004145 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004146 } else {
4147 /*
4148 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004149 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4150 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004151 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004152 for_each_node(node) {
4153 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4154 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4155 put_pwq_unlocked(pwq);
4156 }
4157
4158 /*
4159 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4160 * put. Don't access it afterwards.
4161 */
4162 pwq = wq->dfl_pwq;
4163 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004164 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004165 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004166}
4167EXPORT_SYMBOL_GPL(destroy_workqueue);
4168
Tejun Heodcd989c2010-06-29 10:07:14 +02004169/**
4170 * workqueue_set_max_active - adjust max_active of a workqueue
4171 * @wq: target workqueue
4172 * @max_active: new max_active value.
4173 *
4174 * Set max_active of @wq to @max_active.
4175 *
4176 * CONTEXT:
4177 * Don't call from IRQ context.
4178 */
4179void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4180{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004181 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004182
Tejun Heo8719dce2013-03-12 11:30:04 -07004183 /* disallow meddling with max_active for ordered workqueues */
Tejun Heof9636c92017-07-23 08:36:15 -04004184 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004185 return;
4186
Tejun Heof3421792010-07-02 10:03:51 +02004187 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004188
Lai Jiangshana357fc02013-03-25 16:57:19 -07004189 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004190
Tejun Heof9636c92017-07-23 08:36:15 -04004191 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004192 wq->saved_max_active = max_active;
4193
Tejun Heo699ce092013-03-13 16:51:35 -07004194 for_each_pwq(pwq, wq)
4195 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004196
Lai Jiangshana357fc02013-03-25 16:57:19 -07004197 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004198}
4199EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4200
4201/**
Lukas Wunner225ce6d2018-02-11 10:38:28 +01004202 * current_work - retrieve %current task's work struct
4203 *
4204 * Determine if %current task is a workqueue worker and what it's working on.
4205 * Useful to find out the context that the %current task is running in.
4206 *
4207 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4208 */
4209struct work_struct *current_work(void)
4210{
4211 struct worker *worker = current_wq_worker();
4212
4213 return worker ? worker->current_work : NULL;
4214}
4215EXPORT_SYMBOL(current_work);
4216
4217/**
Tejun Heoe62676162013-03-12 17:41:37 -07004218 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4219 *
4220 * Determine whether %current is a workqueue rescuer. Can be used from
4221 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004222 *
4223 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004224 */
4225bool current_is_workqueue_rescuer(void)
4226{
4227 struct worker *worker = current_wq_worker();
4228
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004229 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004230}
4231
4232/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004233 * workqueue_congested - test whether a workqueue is congested
4234 * @cpu: CPU in question
4235 * @wq: target workqueue
4236 *
4237 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4238 * no synchronization around this function and the test result is
4239 * unreliable and only useful as advisory hints or for debugging.
4240 *
Tejun Heod3251852013-05-10 11:10:17 -07004241 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4242 * Note that both per-cpu and unbound workqueues may be associated with
4243 * multiple pool_workqueues which have separate congested states. A
4244 * workqueue being congested on one CPU doesn't mean the workqueue is also
4245 * contested on other CPUs / NUMA nodes.
4246 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004247 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004248 * %true if congested, %false otherwise.
4249 */
Tejun Heod84ff052013-03-12 11:29:59 -07004250bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004251{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004252 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004253 bool ret;
4254
Lai Jiangshan88109452013-03-20 03:28:10 +08004255 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004256
Tejun Heod3251852013-05-10 11:10:17 -07004257 if (cpu == WORK_CPU_UNBOUND)
4258 cpu = smp_processor_id();
4259
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004260 if (!(wq->flags & WQ_UNBOUND))
4261 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4262 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004263 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004264
Tejun Heo76af4d92013-03-12 11:30:00 -07004265 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004266 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004267
4268 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004269}
4270EXPORT_SYMBOL_GPL(workqueue_congested);
4271
4272/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004273 * work_busy - test whether a work is currently pending or running
4274 * @work: the work to be tested
4275 *
4276 * Test whether @work is currently pending or running. There is no
4277 * synchronization around this function and the test result is
4278 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004279 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004280 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004281 * OR'd bitmask of WORK_BUSY_* bits.
4282 */
4283unsigned int work_busy(struct work_struct *work)
4284{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004285 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004286 unsigned long flags;
4287 unsigned int ret = 0;
4288
Tejun Heodcd989c2010-06-29 10:07:14 +02004289 if (work_pending(work))
4290 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004291
Tejun Heofa1b54e2013-03-12 11:30:00 -07004292 local_irq_save(flags);
4293 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004294 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004295 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004296 if (find_worker_executing_work(pool, work))
4297 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004298 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004299 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004300 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004301
4302 return ret;
4303}
4304EXPORT_SYMBOL_GPL(work_busy);
4305
Tejun Heo3d1cb202013-04-30 15:27:22 -07004306/**
4307 * set_worker_desc - set description for the current work item
4308 * @fmt: printf-style format string
4309 * @...: arguments for the format string
4310 *
4311 * This function can be called by a running work function to describe what
4312 * the work item is about. If the worker task gets dumped, this
4313 * information will be printed out together to help debugging. The
4314 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4315 */
4316void set_worker_desc(const char *fmt, ...)
4317{
4318 struct worker *worker = current_wq_worker();
4319 va_list args;
4320
4321 if (worker) {
4322 va_start(args, fmt);
4323 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4324 va_end(args);
4325 worker->desc_valid = true;
4326 }
4327}
4328
4329/**
4330 * print_worker_info - print out worker information and description
4331 * @log_lvl: the log level to use when printing
4332 * @task: target task
4333 *
4334 * If @task is a worker and currently executing a work item, print out the
4335 * name of the workqueue being serviced and worker description set with
4336 * set_worker_desc() by the currently executing work item.
4337 *
4338 * This function can be safely called on any task as long as the
4339 * task_struct itself is accessible. While safe, this function isn't
4340 * synchronized and may print out mixups or garbages of limited length.
4341 */
4342void print_worker_info(const char *log_lvl, struct task_struct *task)
4343{
4344 work_func_t *fn = NULL;
4345 char name[WQ_NAME_LEN] = { };
4346 char desc[WORKER_DESC_LEN] = { };
4347 struct pool_workqueue *pwq = NULL;
4348 struct workqueue_struct *wq = NULL;
4349 bool desc_valid = false;
4350 struct worker *worker;
4351
4352 if (!(task->flags & PF_WQ_WORKER))
4353 return;
4354
4355 /*
4356 * This function is called without any synchronization and @task
4357 * could be in any state. Be careful with dereferences.
4358 */
Petr Mladeke7005912016-10-11 13:55:17 -07004359 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004360
4361 /*
4362 * Carefully copy the associated workqueue's workfn and name. Keep
4363 * the original last '\0' in case the original contains garbage.
4364 */
4365 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4366 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4367 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4368 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4369
4370 /* copy worker description */
4371 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4372 if (desc_valid)
4373 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4374
4375 if (fn || name[0] || desc[0]) {
4376 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4377 if (desc[0])
4378 pr_cont(" (%s)", desc);
4379 pr_cont("\n");
4380 }
4381}
4382
Tejun Heo3494fc32015-03-09 09:22:28 -04004383static void pr_cont_pool_info(struct worker_pool *pool)
4384{
4385 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4386 if (pool->node != NUMA_NO_NODE)
4387 pr_cont(" node=%d", pool->node);
4388 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4389}
4390
4391static void pr_cont_work(bool comma, struct work_struct *work)
4392{
4393 if (work->func == wq_barrier_func) {
4394 struct wq_barrier *barr;
4395
4396 barr = container_of(work, struct wq_barrier, work);
4397
4398 pr_cont("%s BAR(%d)", comma ? "," : "",
4399 task_pid_nr(barr->task));
4400 } else {
4401 pr_cont("%s %pf", comma ? "," : "", work->func);
4402 }
4403}
4404
4405static void show_pwq(struct pool_workqueue *pwq)
4406{
4407 struct worker_pool *pool = pwq->pool;
4408 struct work_struct *work;
4409 struct worker *worker;
4410 bool has_in_flight = false, has_pending = false;
4411 int bkt;
4412
4413 pr_info(" pwq %d:", pool->id);
4414 pr_cont_pool_info(pool);
4415
Tejun Heo4f5b0c72019-09-25 06:59:15 -07004416 pr_cont(" active=%d/%d refcnt=%d%s\n",
4417 pwq->nr_active, pwq->max_active, pwq->refcnt,
Tejun Heo3494fc32015-03-09 09:22:28 -04004418 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4419
4420 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4421 if (worker->current_pwq == pwq) {
4422 has_in_flight = true;
4423 break;
4424 }
4425 }
4426 if (has_in_flight) {
4427 bool comma = false;
4428
4429 pr_info(" in-flight:");
4430 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4431 if (worker->current_pwq != pwq)
4432 continue;
4433
4434 pr_cont("%s %d%s:%pf", comma ? "," : "",
4435 task_pid_nr(worker->task),
4436 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4437 worker->current_func);
4438 list_for_each_entry(work, &worker->scheduled, entry)
4439 pr_cont_work(false, work);
4440 comma = true;
4441 }
4442 pr_cont("\n");
4443 }
4444
4445 list_for_each_entry(work, &pool->worklist, entry) {
4446 if (get_work_pwq(work) == pwq) {
4447 has_pending = true;
4448 break;
4449 }
4450 }
4451 if (has_pending) {
4452 bool comma = false;
4453
4454 pr_info(" pending:");
4455 list_for_each_entry(work, &pool->worklist, entry) {
4456 if (get_work_pwq(work) != pwq)
4457 continue;
4458
4459 pr_cont_work(comma, work);
4460 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4461 }
4462 pr_cont("\n");
4463 }
4464
4465 if (!list_empty(&pwq->delayed_works)) {
4466 bool comma = false;
4467
4468 pr_info(" delayed:");
4469 list_for_each_entry(work, &pwq->delayed_works, entry) {
4470 pr_cont_work(comma, work);
4471 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4472 }
4473 pr_cont("\n");
4474 }
4475}
4476
4477/**
4478 * show_workqueue_state - dump workqueue state
4479 *
Roger Lu7b776af2016-07-01 11:05:02 +08004480 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4481 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004482 */
4483void show_workqueue_state(void)
4484{
4485 struct workqueue_struct *wq;
4486 struct worker_pool *pool;
4487 unsigned long flags;
4488 int pi;
4489
4490 rcu_read_lock_sched();
4491
4492 pr_info("Showing busy workqueues and worker pools:\n");
4493
4494 list_for_each_entry_rcu(wq, &workqueues, list) {
4495 struct pool_workqueue *pwq;
4496 bool idle = true;
4497
4498 for_each_pwq(pwq, wq) {
4499 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4500 idle = false;
4501 break;
4502 }
4503 }
4504 if (idle)
4505 continue;
4506
4507 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4508
4509 for_each_pwq(pwq, wq) {
4510 spin_lock_irqsave(&pwq->pool->lock, flags);
4511 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4512 show_pwq(pwq);
4513 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +09004514 /*
4515 * We could be printing a lot from atomic context, e.g.
4516 * sysrq-t -> show_workqueue_state(). Avoid triggering
4517 * hard lockup.
4518 */
4519 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004520 }
4521 }
4522
4523 for_each_pool(pool, pi) {
4524 struct worker *worker;
4525 bool first = true;
4526
4527 spin_lock_irqsave(&pool->lock, flags);
4528 if (pool->nr_workers == pool->nr_idle)
4529 goto next_pool;
4530
4531 pr_info("pool %d:", pool->id);
4532 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004533 pr_cont(" hung=%us workers=%d",
4534 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4535 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004536 if (pool->manager)
4537 pr_cont(" manager: %d",
4538 task_pid_nr(pool->manager->task));
4539 list_for_each_entry(worker, &pool->idle_list, entry) {
4540 pr_cont(" %s%d", first ? "idle: " : "",
4541 task_pid_nr(worker->task));
4542 first = false;
4543 }
4544 pr_cont("\n");
4545 next_pool:
4546 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +09004547 /*
4548 * We could be printing a lot from atomic context, e.g.
4549 * sysrq-t -> show_workqueue_state(). Avoid triggering
4550 * hard lockup.
4551 */
4552 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004553 }
4554
4555 rcu_read_unlock_sched();
4556}
4557
Tejun Heodb7bccf2010-06-29 10:07:12 +02004558/*
4559 * CPU hotplug.
4560 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004561 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004562 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004563 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004564 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004565 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004566 * blocked draining impractical.
4567 *
Tejun Heo24647572013-01-24 11:01:33 -08004568 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004569 * running as an unbound one and allowing it to be reattached later if the
4570 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004571 */
4572
Lai Jiangshan6128fcb2017-12-01 22:20:36 +08004573static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004574{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004575 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004576 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004577
Tejun Heof02ae732013-03-12 11:30:03 -07004578 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004579 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004580 spin_lock_irq(&pool->lock);
4581
4582 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004583 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004584 * unbound and set DISASSOCIATED. Before this, all workers
4585 * except for the ones which are still executing works from
4586 * before the last CPU down must be on the cpu. After
4587 * this, they may become diasporas.
4588 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004589 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004590 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004591
Tejun Heo24647572013-01-24 11:01:33 -08004592 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004593
Tejun Heo94cf58b2013-01-24 11:01:33 -08004594 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004595 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004596
Lai Jiangshaneb283422013-03-08 15:18:28 -08004597 /*
4598 * Call schedule() so that we cross rq->lock and thus can
4599 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4600 * This is necessary as scheduler callbacks may be invoked
4601 * from other cpus.
4602 */
4603 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004604
Lai Jiangshaneb283422013-03-08 15:18:28 -08004605 /*
4606 * Sched callbacks are disabled now. Zap nr_running.
4607 * After this, nr_running stays zero and need_more_worker()
4608 * and keep_working() are always true as long as the
4609 * worklist is not empty. This pool now behaves as an
4610 * unbound (in terms of concurrency management) pool which
4611 * are served by workers tied to the pool.
4612 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004613 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004614
4615 /*
4616 * With concurrency management just turned off, a busy
4617 * worker blocking could lead to lengthy stalls. Kick off
4618 * unbound chain execution of currently pending work items.
4619 */
4620 spin_lock_irq(&pool->lock);
4621 wake_up_worker(pool);
4622 spin_unlock_irq(&pool->lock);
4623 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004624}
4625
Tejun Heobd7c0892013-03-19 13:45:21 -07004626/**
4627 * rebind_workers - rebind all workers of a pool to the associated CPU
4628 * @pool: pool of interest
4629 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004630 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004631 */
4632static void rebind_workers(struct worker_pool *pool)
4633{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004634 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004635
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004636 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004637
Tejun Heoa9ab7752013-03-19 13:45:21 -07004638 /*
4639 * Restore CPU affinity of all workers. As all idle workers should
4640 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304641 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004642 * of all workers first and then clear UNBOUND. As we're called
4643 * from CPU_ONLINE, the following shouldn't fail.
4644 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004645 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004646 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4647 pool->attrs->cpumask) < 0);
4648
4649 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004650
4651 /*
4652 * XXX: CPU hotplug notifiers are weird and can call DOWN_FAILED
4653 * w/o preceding DOWN_PREPARE. Work around it. CPU hotplug is
4654 * being reworked and this can go away in time.
4655 */
4656 if (!(pool->flags & POOL_DISASSOCIATED)) {
4657 spin_unlock_irq(&pool->lock);
4658 return;
4659 }
4660
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004661 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004662
Lai Jiangshanda028462014-05-20 17:46:31 +08004663 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004664 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004665
4666 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004667 * A bound idle worker should actually be on the runqueue
4668 * of the associated CPU for local wake-ups targeting it to
4669 * work. Kick all idle workers so that they migrate to the
4670 * associated CPU. Doing this in the same loop as
4671 * replacing UNBOUND with REBOUND is safe as no worker will
4672 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004673 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004674 if (worker_flags & WORKER_IDLE)
4675 wake_up_process(worker->task);
4676
4677 /*
4678 * We want to clear UNBOUND but can't directly call
4679 * worker_clr_flags() or adjust nr_running. Atomically
4680 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4681 * @worker will clear REBOUND using worker_clr_flags() when
4682 * it initiates the next execution cycle thus restoring
4683 * concurrency management. Note that when or whether
4684 * @worker clears REBOUND doesn't affect correctness.
4685 *
4686 * ACCESS_ONCE() is necessary because @worker->flags may be
4687 * tested without holding any lock in
4688 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4689 * fail incorrectly leading to premature concurrency
4690 * management operations.
4691 */
4692 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4693 worker_flags |= WORKER_REBOUND;
4694 worker_flags &= ~WORKER_UNBOUND;
4695 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004696 }
4697
Tejun Heoa9ab7752013-03-19 13:45:21 -07004698 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004699}
4700
Tejun Heo7dbc7252013-03-19 13:45:21 -07004701/**
4702 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4703 * @pool: unbound pool of interest
4704 * @cpu: the CPU which is coming up
4705 *
4706 * An unbound pool may end up with a cpumask which doesn't have any online
4707 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4708 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4709 * online CPU before, cpus_allowed of all its workers should be restored.
4710 */
4711static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4712{
4713 static cpumask_t cpumask;
4714 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004715
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004716 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004717
4718 /* is @cpu allowed for @pool? */
4719 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4720 return;
4721
Tejun Heo7dbc7252013-03-19 13:45:21 -07004722 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004723
4724 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004725 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004726 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004727}
4728
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004729int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004730{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004731 struct worker_pool *pool;
4732
4733 for_each_cpu_worker_pool(pool, cpu) {
4734 if (pool->nr_workers)
4735 continue;
4736 if (!create_worker(pool))
4737 return -ENOMEM;
4738 }
4739 return 0;
4740}
4741
4742int workqueue_online_cpu(unsigned int cpu)
4743{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004744 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004745 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004746 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004747
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004748 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004749
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004750 for_each_pool(pool, pi) {
4751 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004752
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004753 if (pool->cpu == cpu)
4754 rebind_workers(pool);
4755 else if (pool->cpu < 0)
4756 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004757
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004758 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004759 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004760
4761 /* update NUMA affinity of unbound workqueues */
4762 list_for_each_entry(wq, &workqueues, list)
4763 wq_update_unbound_numa(wq, cpu, true);
4764
4765 mutex_unlock(&wq_pool_mutex);
4766 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004767}
4768
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004769int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004770{
Tejun Heo4c16bd32013-04-01 11:23:36 -07004771 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004772
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004773 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshan6128fcb2017-12-01 22:20:36 +08004774 if (WARN_ON(cpu != smp_processor_id()))
4775 return -1;
4776
4777 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004778
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004779 /* update NUMA affinity of unbound workqueues */
4780 mutex_lock(&wq_pool_mutex);
4781 list_for_each_entry(wq, &workqueues, list)
4782 wq_update_unbound_numa(wq, cpu, false);
4783 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004784
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004785 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004786}
4787
Rusty Russell2d3854a2008-11-05 13:39:10 +11004788#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004789
Rusty Russell2d3854a2008-11-05 13:39:10 +11004790struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004791 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004792 long (*fn)(void *);
4793 void *arg;
4794 long ret;
4795};
4796
Tejun Heoed48ece2012-09-18 12:48:43 -07004797static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004798{
Tejun Heoed48ece2012-09-18 12:48:43 -07004799 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4800
Rusty Russell2d3854a2008-11-05 13:39:10 +11004801 wfc->ret = wfc->fn(wfc->arg);
4802}
4803
4804/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004805 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004806 * @cpu: the cpu to run on
4807 * @fn: the function to run
4808 * @arg: the function arg
4809 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004810 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004811 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004812 *
4813 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004814 */
Tejun Heod84ff052013-03-12 11:29:59 -07004815long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004816{
Tejun Heoed48ece2012-09-18 12:48:43 -07004817 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004818
Tejun Heoed48ece2012-09-18 12:48:43 -07004819 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4820 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004821 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004822 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004823 return wfc.ret;
4824}
4825EXPORT_SYMBOL_GPL(work_on_cpu);
4826#endif /* CONFIG_SMP */
4827
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004828#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304829
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004830/**
4831 * freeze_workqueues_begin - begin freezing workqueues
4832 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004833 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004834 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004835 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004836 *
4837 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004838 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004839 */
4840void freeze_workqueues_begin(void)
4841{
Tejun Heo24b8a842013-03-12 11:29:58 -07004842 struct workqueue_struct *wq;
4843 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004844
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004845 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004846
Tejun Heo6183c002013-03-12 11:29:57 -07004847 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004848 workqueue_freezing = true;
4849
Tejun Heo24b8a842013-03-12 11:29:58 -07004850 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004851 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004852 for_each_pwq(pwq, wq)
4853 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004854 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004855 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004856
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004857 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004858}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004859
4860/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004861 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004862 *
4863 * Check whether freezing is complete. This function must be called
4864 * between freeze_workqueues_begin() and thaw_workqueues().
4865 *
4866 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004867 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004868 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004869 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004870 * %true if some freezable workqueues are still busy. %false if freezing
4871 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004872 */
4873bool freeze_workqueues_busy(void)
4874{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004875 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004876 struct workqueue_struct *wq;
4877 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004878
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004879 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004880
Tejun Heo6183c002013-03-12 11:29:57 -07004881 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004882
Tejun Heo24b8a842013-03-12 11:29:58 -07004883 list_for_each_entry(wq, &workqueues, list) {
4884 if (!(wq->flags & WQ_FREEZABLE))
4885 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004886 /*
4887 * nr_active is monotonically decreasing. It's safe
4888 * to peek without lock.
4889 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004890 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004891 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004892 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004893 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004894 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004895 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004896 goto out_unlock;
4897 }
4898 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004899 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004900 }
4901out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004902 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004903 return busy;
4904}
4905
4906/**
4907 * thaw_workqueues - thaw workqueues
4908 *
4909 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004910 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004911 *
4912 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004913 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004914 */
4915void thaw_workqueues(void)
4916{
Tejun Heo24b8a842013-03-12 11:29:58 -07004917 struct workqueue_struct *wq;
4918 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004919
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004920 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004921
4922 if (!workqueue_freezing)
4923 goto out_unlock;
4924
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004925 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004926
Tejun Heo24b8a842013-03-12 11:29:58 -07004927 /* restore max_active and repopulate worklist */
4928 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004929 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004930 for_each_pwq(pwq, wq)
4931 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004932 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004933 }
4934
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004935out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004936 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004937}
4938#endif /* CONFIG_FREEZER */
4939
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004940static int workqueue_apply_unbound_cpumask(void)
4941{
4942 LIST_HEAD(ctxs);
4943 int ret = 0;
4944 struct workqueue_struct *wq;
4945 struct apply_wqattrs_ctx *ctx, *n;
4946
4947 lockdep_assert_held(&wq_pool_mutex);
4948
4949 list_for_each_entry(wq, &workqueues, list) {
4950 if (!(wq->flags & WQ_UNBOUND))
4951 continue;
4952 /* creating multiple pwqs breaks ordering guarantee */
4953 if (wq->flags & __WQ_ORDERED)
4954 continue;
4955
4956 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4957 if (!ctx) {
4958 ret = -ENOMEM;
4959 break;
4960 }
4961
4962 list_add_tail(&ctx->list, &ctxs);
4963 }
4964
4965 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4966 if (!ret)
4967 apply_wqattrs_commit(ctx);
4968 apply_wqattrs_cleanup(ctx);
4969 }
4970
4971 return ret;
4972}
4973
4974/**
4975 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4976 * @cpumask: the cpumask to set
4977 *
4978 * The low-level workqueues cpumask is a global cpumask that limits
4979 * the affinity of all unbound workqueues. This function check the @cpumask
4980 * and apply it to all unbound workqueues and updates all pwqs of them.
4981 *
4982 * Retun: 0 - Success
4983 * -EINVAL - Invalid @cpumask
4984 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4985 */
4986int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4987{
4988 int ret = -EINVAL;
4989 cpumask_var_t saved_cpumask;
4990
4991 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4992 return -ENOMEM;
4993
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004994 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4995 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004996 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004997
4998 /* save the old wq_unbound_cpumask. */
4999 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5000
5001 /* update wq_unbound_cpumask at first and apply it to wqs. */
5002 cpumask_copy(wq_unbound_cpumask, cpumask);
5003 ret = workqueue_apply_unbound_cpumask();
5004
5005 /* restore the wq_unbound_cpumask when failed. */
5006 if (ret < 0)
5007 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5008
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005009 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005010 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005011
5012 free_cpumask_var(saved_cpumask);
5013 return ret;
5014}
5015
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005016#ifdef CONFIG_SYSFS
5017/*
5018 * Workqueues with WQ_SYSFS flag set is visible to userland via
5019 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5020 * following attributes.
5021 *
5022 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5023 * max_active RW int : maximum number of in-flight work items
5024 *
5025 * Unbound workqueues have the following extra attributes.
5026 *
5027 * id RO int : the associated pool ID
5028 * nice RW int : nice value of the workers
5029 * cpumask RW mask : bitmask of allowed CPUs for the workers
5030 */
5031struct wq_device {
5032 struct workqueue_struct *wq;
5033 struct device dev;
5034};
5035
5036static struct workqueue_struct *dev_to_wq(struct device *dev)
5037{
5038 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5039
5040 return wq_dev->wq;
5041}
5042
5043static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5044 char *buf)
5045{
5046 struct workqueue_struct *wq = dev_to_wq(dev);
5047
5048 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5049}
5050static DEVICE_ATTR_RO(per_cpu);
5051
5052static ssize_t max_active_show(struct device *dev,
5053 struct device_attribute *attr, char *buf)
5054{
5055 struct workqueue_struct *wq = dev_to_wq(dev);
5056
5057 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5058}
5059
5060static ssize_t max_active_store(struct device *dev,
5061 struct device_attribute *attr, const char *buf,
5062 size_t count)
5063{
5064 struct workqueue_struct *wq = dev_to_wq(dev);
5065 int val;
5066
5067 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5068 return -EINVAL;
5069
5070 workqueue_set_max_active(wq, val);
5071 return count;
5072}
5073static DEVICE_ATTR_RW(max_active);
5074
5075static struct attribute *wq_sysfs_attrs[] = {
5076 &dev_attr_per_cpu.attr,
5077 &dev_attr_max_active.attr,
5078 NULL,
5079};
5080ATTRIBUTE_GROUPS(wq_sysfs);
5081
5082static ssize_t wq_pool_ids_show(struct device *dev,
5083 struct device_attribute *attr, char *buf)
5084{
5085 struct workqueue_struct *wq = dev_to_wq(dev);
5086 const char *delim = "";
5087 int node, written = 0;
5088
5089 rcu_read_lock_sched();
5090 for_each_node(node) {
5091 written += scnprintf(buf + written, PAGE_SIZE - written,
5092 "%s%d:%d", delim, node,
5093 unbound_pwq_by_node(wq, node)->pool->id);
5094 delim = " ";
5095 }
5096 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5097 rcu_read_unlock_sched();
5098
5099 return written;
5100}
5101
5102static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5103 char *buf)
5104{
5105 struct workqueue_struct *wq = dev_to_wq(dev);
5106 int written;
5107
5108 mutex_lock(&wq->mutex);
5109 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5110 mutex_unlock(&wq->mutex);
5111
5112 return written;
5113}
5114
5115/* prepare workqueue_attrs for sysfs store operations */
5116static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5117{
5118 struct workqueue_attrs *attrs;
5119
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005120 lockdep_assert_held(&wq_pool_mutex);
5121
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005122 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5123 if (!attrs)
5124 return NULL;
5125
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005126 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005127 return attrs;
5128}
5129
5130static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5131 const char *buf, size_t count)
5132{
5133 struct workqueue_struct *wq = dev_to_wq(dev);
5134 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005135 int ret = -ENOMEM;
5136
5137 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005138
5139 attrs = wq_sysfs_prep_attrs(wq);
5140 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005141 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005142
5143 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5144 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005145 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005146 else
5147 ret = -EINVAL;
5148
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005149out_unlock:
5150 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005151 free_workqueue_attrs(attrs);
5152 return ret ?: count;
5153}
5154
5155static ssize_t wq_cpumask_show(struct device *dev,
5156 struct device_attribute *attr, char *buf)
5157{
5158 struct workqueue_struct *wq = dev_to_wq(dev);
5159 int written;
5160
5161 mutex_lock(&wq->mutex);
5162 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5163 cpumask_pr_args(wq->unbound_attrs->cpumask));
5164 mutex_unlock(&wq->mutex);
5165 return written;
5166}
5167
5168static ssize_t wq_cpumask_store(struct device *dev,
5169 struct device_attribute *attr,
5170 const char *buf, size_t count)
5171{
5172 struct workqueue_struct *wq = dev_to_wq(dev);
5173 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005174 int ret = -ENOMEM;
5175
5176 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005177
5178 attrs = wq_sysfs_prep_attrs(wq);
5179 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005180 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005181
5182 ret = cpumask_parse(buf, attrs->cpumask);
5183 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005184 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005185
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005186out_unlock:
5187 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005188 free_workqueue_attrs(attrs);
5189 return ret ?: count;
5190}
5191
5192static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5193 char *buf)
5194{
5195 struct workqueue_struct *wq = dev_to_wq(dev);
5196 int written;
5197
5198 mutex_lock(&wq->mutex);
5199 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5200 !wq->unbound_attrs->no_numa);
5201 mutex_unlock(&wq->mutex);
5202
5203 return written;
5204}
5205
5206static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5207 const char *buf, size_t count)
5208{
5209 struct workqueue_struct *wq = dev_to_wq(dev);
5210 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005211 int v, ret = -ENOMEM;
5212
5213 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005214
5215 attrs = wq_sysfs_prep_attrs(wq);
5216 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005217 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005218
5219 ret = -EINVAL;
5220 if (sscanf(buf, "%d", &v) == 1) {
5221 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005222 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005223 }
5224
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005225out_unlock:
5226 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005227 free_workqueue_attrs(attrs);
5228 return ret ?: count;
5229}
5230
5231static struct device_attribute wq_sysfs_unbound_attrs[] = {
5232 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5233 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5234 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5235 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5236 __ATTR_NULL,
5237};
5238
5239static struct bus_type wq_subsys = {
5240 .name = "workqueue",
5241 .dev_groups = wq_sysfs_groups,
5242};
5243
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005244static ssize_t wq_unbound_cpumask_show(struct device *dev,
5245 struct device_attribute *attr, char *buf)
5246{
5247 int written;
5248
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005249 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005250 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5251 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005252 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005253
5254 return written;
5255}
5256
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005257static ssize_t wq_unbound_cpumask_store(struct device *dev,
5258 struct device_attribute *attr, const char *buf, size_t count)
5259{
5260 cpumask_var_t cpumask;
5261 int ret;
5262
5263 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5264 return -ENOMEM;
5265
5266 ret = cpumask_parse(buf, cpumask);
5267 if (!ret)
5268 ret = workqueue_set_unbound_cpumask(cpumask);
5269
5270 free_cpumask_var(cpumask);
5271 return ret ? ret : count;
5272}
5273
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005274static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005275 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5276 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005277
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005278static int __init wq_sysfs_init(void)
5279{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005280 int err;
5281
5282 err = subsys_virtual_register(&wq_subsys, NULL);
5283 if (err)
5284 return err;
5285
5286 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005287}
5288core_initcall(wq_sysfs_init);
5289
5290static void wq_device_release(struct device *dev)
5291{
5292 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5293
5294 kfree(wq_dev);
5295}
5296
5297/**
5298 * workqueue_sysfs_register - make a workqueue visible in sysfs
5299 * @wq: the workqueue to register
5300 *
5301 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5302 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5303 * which is the preferred method.
5304 *
5305 * Workqueue user should use this function directly iff it wants to apply
5306 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5307 * apply_workqueue_attrs() may race against userland updating the
5308 * attributes.
5309 *
5310 * Return: 0 on success, -errno on failure.
5311 */
5312int workqueue_sysfs_register(struct workqueue_struct *wq)
5313{
5314 struct wq_device *wq_dev;
5315 int ret;
5316
5317 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305318 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005319 * attributes breaks ordering guarantee. Disallow exposing ordered
5320 * workqueues.
5321 */
Tejun Heof9636c92017-07-23 08:36:15 -04005322 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005323 return -EINVAL;
5324
5325 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5326 if (!wq_dev)
5327 return -ENOMEM;
5328
5329 wq_dev->wq = wq;
5330 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005331 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005332 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005333
5334 /*
5335 * unbound_attrs are created separately. Suppress uevent until
5336 * everything is ready.
5337 */
5338 dev_set_uevent_suppress(&wq_dev->dev, true);
5339
5340 ret = device_register(&wq_dev->dev);
5341 if (ret) {
Arvind Yadav30393942018-03-06 15:35:43 +05305342 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005343 wq->wq_dev = NULL;
5344 return ret;
5345 }
5346
5347 if (wq->flags & WQ_UNBOUND) {
5348 struct device_attribute *attr;
5349
5350 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5351 ret = device_create_file(&wq_dev->dev, attr);
5352 if (ret) {
5353 device_unregister(&wq_dev->dev);
5354 wq->wq_dev = NULL;
5355 return ret;
5356 }
5357 }
5358 }
5359
5360 dev_set_uevent_suppress(&wq_dev->dev, false);
5361 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5362 return 0;
5363}
5364
5365/**
5366 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5367 * @wq: the workqueue to unregister
5368 *
5369 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5370 */
5371static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5372{
5373 struct wq_device *wq_dev = wq->wq_dev;
5374
5375 if (!wq->wq_dev)
5376 return;
5377
5378 wq->wq_dev = NULL;
5379 device_unregister(&wq_dev->dev);
5380}
5381#else /* CONFIG_SYSFS */
5382static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5383#endif /* CONFIG_SYSFS */
5384
Tejun Heo82607adc2015-12-08 11:28:04 -05005385/*
5386 * Workqueue watchdog.
5387 *
5388 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5389 * flush dependency, a concurrency managed work item which stays RUNNING
5390 * indefinitely. Workqueue stalls can be very difficult to debug as the
5391 * usual warning mechanisms don't trigger and internal workqueue state is
5392 * largely opaque.
5393 *
5394 * Workqueue watchdog monitors all worker pools periodically and dumps
5395 * state if some pools failed to make forward progress for a while where
5396 * forward progress is defined as the first item on ->worklist changing.
5397 *
5398 * This mechanism is controlled through the kernel parameter
5399 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5400 * corresponding sysfs parameter file.
5401 */
5402#ifdef CONFIG_WQ_WATCHDOG
5403
5404static void wq_watchdog_timer_fn(unsigned long data);
5405
5406static unsigned long wq_watchdog_thresh = 30;
5407static struct timer_list wq_watchdog_timer =
5408 TIMER_DEFERRED_INITIALIZER(wq_watchdog_timer_fn, 0, 0);
5409
5410static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5411static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5412
5413static void wq_watchdog_reset_touched(void)
5414{
5415 int cpu;
5416
5417 wq_watchdog_touched = jiffies;
5418 for_each_possible_cpu(cpu)
5419 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5420}
5421
5422static void wq_watchdog_timer_fn(unsigned long data)
5423{
5424 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5425 bool lockup_detected = false;
5426 struct worker_pool *pool;
5427 int pi;
5428
5429 if (!thresh)
5430 return;
5431
5432 rcu_read_lock();
5433
5434 for_each_pool(pool, pi) {
5435 unsigned long pool_ts, touched, ts;
5436
5437 if (list_empty(&pool->worklist))
5438 continue;
5439
5440 /* get the latest of pool and touched timestamps */
5441 pool_ts = READ_ONCE(pool->watchdog_ts);
5442 touched = READ_ONCE(wq_watchdog_touched);
5443
5444 if (time_after(pool_ts, touched))
5445 ts = pool_ts;
5446 else
5447 ts = touched;
5448
5449 if (pool->cpu >= 0) {
5450 unsigned long cpu_touched =
5451 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5452 pool->cpu));
5453 if (time_after(cpu_touched, ts))
5454 ts = cpu_touched;
5455 }
5456
5457 /* did we stall? */
5458 if (time_after(jiffies, ts + thresh)) {
5459 lockup_detected = true;
5460 pr_emerg("BUG: workqueue lockup - pool");
5461 pr_cont_pool_info(pool);
5462 pr_cont(" stuck for %us!\n",
5463 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5464 }
5465 }
5466
5467 rcu_read_unlock();
5468
5469 if (lockup_detected)
5470 show_workqueue_state();
5471
5472 wq_watchdog_reset_touched();
5473 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5474}
5475
5476void wq_watchdog_touch(int cpu)
5477{
5478 if (cpu >= 0)
5479 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5480 else
5481 wq_watchdog_touched = jiffies;
5482}
5483
5484static void wq_watchdog_set_thresh(unsigned long thresh)
5485{
5486 wq_watchdog_thresh = 0;
5487 del_timer_sync(&wq_watchdog_timer);
5488
5489 if (thresh) {
5490 wq_watchdog_thresh = thresh;
5491 wq_watchdog_reset_touched();
5492 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5493 }
5494}
5495
5496static int wq_watchdog_param_set_thresh(const char *val,
5497 const struct kernel_param *kp)
5498{
5499 unsigned long thresh;
5500 int ret;
5501
5502 ret = kstrtoul(val, 0, &thresh);
5503 if (ret)
5504 return ret;
5505
5506 if (system_wq)
5507 wq_watchdog_set_thresh(thresh);
5508 else
5509 wq_watchdog_thresh = thresh;
5510
5511 return 0;
5512}
5513
5514static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5515 .set = wq_watchdog_param_set_thresh,
5516 .get = param_get_ulong,
5517};
5518
5519module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5520 0644);
5521
5522static void wq_watchdog_init(void)
5523{
5524 wq_watchdog_set_thresh(wq_watchdog_thresh);
5525}
5526
5527#else /* CONFIG_WQ_WATCHDOG */
5528
5529static inline void wq_watchdog_init(void) { }
5530
5531#endif /* CONFIG_WQ_WATCHDOG */
5532
Tejun Heobce90382013-04-01 11:23:32 -07005533static void __init wq_numa_init(void)
5534{
5535 cpumask_var_t *tbl;
5536 int node, cpu;
5537
Tejun Heobce90382013-04-01 11:23:32 -07005538 if (num_possible_nodes() <= 1)
5539 return;
5540
Tejun Heod55262c2013-04-01 11:23:38 -07005541 if (wq_disable_numa) {
5542 pr_info("workqueue: NUMA affinity support disabled\n");
5543 return;
5544 }
5545
Tejun Heo4c16bd32013-04-01 11:23:36 -07005546 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5547 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5548
Tejun Heobce90382013-04-01 11:23:32 -07005549 /*
5550 * We want masks of possible CPUs of each node which isn't readily
5551 * available. Build one from cpu_to_node() which should have been
5552 * fully initialized by now.
5553 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005554 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005555 BUG_ON(!tbl);
5556
5557 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005558 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005559 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005560
5561 for_each_possible_cpu(cpu) {
5562 node = cpu_to_node(cpu);
5563 if (WARN_ON(node == NUMA_NO_NODE)) {
5564 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5565 /* happens iff arch is bonkers, let's just proceed */
5566 return;
5567 }
5568 cpumask_set_cpu(cpu, tbl[node]);
5569 }
5570
5571 wq_numa_possible_cpumask = tbl;
5572 wq_numa_enabled = true;
5573}
5574
Tejun Heo4b5facd2016-09-16 15:49:32 -04005575/**
5576 * workqueue_init_early - early init for workqueue subsystem
5577 *
5578 * This is the first half of two-staged workqueue subsystem initialization
5579 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5580 * idr are up. It sets up all the data structures and system workqueues
5581 * and allows early boot code to create workqueues and queue/cancel work
5582 * items. Actual work item execution starts only after kthreads can be
5583 * created and scheduled right before early initcalls.
5584 */
5585int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005586{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005587 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5588 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005589
Tejun Heoe904e6c2013-03-12 11:29:57 -07005590 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5591
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005592 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5593 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5594
Tejun Heoe904e6c2013-03-12 11:29:57 -07005595 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5596
Tejun Heobce90382013-04-01 11:23:32 -07005597 wq_numa_init();
5598
Tejun Heo706026c2013-01-24 11:01:34 -08005599 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005600 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005601 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005602
Tejun Heo7a4e3442013-03-12 11:30:00 -07005603 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005604 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005605 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005606 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005607 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005608 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005609 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005610
Tejun Heo9daf9e62013-01-24 11:01:33 -08005611 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005612 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005613 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005614 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005615 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005616 }
5617
Tejun Heo8a2b7532013-09-05 12:30:04 -04005618 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005619 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5620 struct workqueue_attrs *attrs;
5621
5622 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005623 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005624 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005625
5626 /*
5627 * An ordered wq should have only one pwq as ordering is
5628 * guaranteed by max_active which is enforced by pwqs.
5629 * Turn off NUMA so that dfl_pwq is used for all nodes.
5630 */
5631 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5632 attrs->nice = std_nice[i];
5633 attrs->no_numa = true;
5634 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005635 }
5636
Tejun Heod320c032010-06-29 10:07:14 +02005637 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005638 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005639 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005640 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5641 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005642 system_freezable_wq = alloc_workqueue("events_freezable",
5643 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305644 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5645 WQ_POWER_EFFICIENT, 0);
5646 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5647 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5648 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005649 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305650 !system_unbound_wq || !system_freezable_wq ||
5651 !system_power_efficient_wq ||
5652 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005653
Tejun Heo4b5facd2016-09-16 15:49:32 -04005654 return 0;
5655}
5656
5657/**
5658 * workqueue_init - bring workqueue subsystem fully online
5659 *
5660 * This is the latter half of two-staged workqueue subsystem initialization
5661 * and invoked as soon as kthreads can be created and scheduled.
5662 * Workqueues have been created and work items queued on them, but there
5663 * are no kworkers executing the work items yet. Populate the worker pools
5664 * with the initial workers and enable future kworker creations.
5665 */
5666int __init workqueue_init(void)
5667{
5668 struct worker_pool *pool;
5669 int cpu, bkt;
5670
5671 /* create the initial workers */
5672 for_each_online_cpu(cpu) {
5673 for_each_cpu_worker_pool(pool, cpu) {
5674 pool->flags &= ~POOL_DISASSOCIATED;
5675 BUG_ON(!create_worker(pool));
5676 }
5677 }
5678
5679 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5680 BUG_ON(!create_worker(pool));
5681
5682 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005683 wq_watchdog_init();
5684
Suresh Siddha6ee05782010-07-30 14:57:37 -07005685 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005686}