blob: 134200a1219631b301f46577e6468b778a0a1e9d [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>
Sergey Senozhatskya8f2c7b2021-05-20 19:14:22 +090054#include <linux/kvm_para.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020055
Tejun Heoea138442013-01-18 14:05:55 -080056#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Tejun Heoc8e55f32010-06-29 10:07:12 +020058enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 /*
Tejun Heo24647572013-01-24 11:01:33 -080060 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070061 *
Tejun Heo24647572013-01-24 11:01:33 -080062 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070063 * While associated (!DISASSOCIATED), all workers are bound to the
64 * CPU and none has %WORKER_UNBOUND set and concurrency management
65 * is in effect.
66 *
67 * While DISASSOCIATED, the cpu may be offline and all workers have
68 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080069 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070070 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070071 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080072 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080073 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070074 */
Tejun Heo43a980a2017-10-09 08:04:13 -070075 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
Tejun Heo24647572013-01-24 11:01:33 -080076 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020077
Tejun Heoc8e55f32010-06-29 10:07:12 +020078 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020079 WORKER_DIE = 1 << 1, /* die die die */
80 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020081 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020082 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020083 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070084 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020085
Tejun Heoa9ab7752013-03-19 13:45:21 -070086 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
87 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020088
Tejun Heoe34cdddb2013-01-24 11:01:33 -080089 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070090
Tejun Heo29c91e92013-03-12 11:30:03 -070091 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020092 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020093
Tejun Heoe22bee72010-06-29 10:07:14 +020094 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
95 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
96
Tejun Heo3233cdb2011-02-16 18:10:19 +010097 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
98 /* call for help after 10ms
99 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +0200100 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
101 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +0200102
103 /*
104 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800105 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200106 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800107 RESCUER_NICE_LEVEL = MIN_NICE,
108 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700109
110 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200111};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200114 * Structure fields follow one of the following exclusion rules.
115 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200116 * I: Modifiable by initialization/destruction paths and read-only for
117 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200118 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200119 * P: Preemption protected. Disabling preemption is enough and should
120 * only be modified and accessed from the local cpu.
121 *
Tejun Heod565ed62013-01-24 11:01:33 -0800122 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200123 *
Tejun Heod565ed62013-01-24 11:01:33 -0800124 * X: During normal operation, modification requires pool->lock and should
125 * be done only from local cpu. Either disabling preemption on local
126 * cpu or grabbing pool->lock is enough for read access. If
127 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200128 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800129 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700130 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700131 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700132 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700133 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700134 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800135 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
136 *
137 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
138 * sched-RCU for reads.
139 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700140 * WQ: wq->mutex protected.
141 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700142 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700143 *
144 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200145 */
146
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800147/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200148
Tejun Heobd7bdd42012-07-12 14:46:37 -0700149struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800150 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700151 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700152 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800153 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700154 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700155
Tejun Heo82607adc2015-12-08 11:28:04 -0500156 unsigned long watchdog_ts; /* L: watchdog timestamp */
157
Tejun Heobd7bdd42012-07-12 14:46:37 -0700158 struct list_head worklist; /* L: list of pending works */
159 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700160
161 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700162 int nr_idle; /* L: currently idle ones */
163
164 struct list_head idle_list; /* X: list of idle workers */
165 struct timer_list idle_timer; /* L: worker idle timeout */
166 struct timer_list mayday_timer; /* L: SOS timer for workers */
167
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700168 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800169 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
170 /* L: hash of busy workers */
171
Tejun Heobc3a1af2013-03-13 19:47:39 -0700172 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400173 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800174 struct mutex attach_mutex; /* attach/detach exclusion */
175 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800176 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800177
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800178 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800179
Tejun Heo7a4e3442013-03-12 11:30:00 -0700180 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700181 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
182 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700183
Tejun Heoe19e3972013-01-24 11:39:44 -0800184 /*
185 * The current concurrency level. As it's likely to be accessed
186 * from other CPUs during try_to_wake_up(), put it in a separate
187 * cacheline.
188 */
189 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700190
191 /*
192 * Destruction of pool is sched-RCU protected to allow dereferences
193 * from get_work_pool().
194 */
195 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200196} ____cacheline_aligned_in_smp;
197
198/*
Tejun Heo112202d2013-02-13 19:29:12 -0800199 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
200 * of work_struct->data are used for flags and the remaining high bits
201 * point to the pwq; thus, pwqs need to be aligned at two's power of the
202 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 */
Tejun Heo112202d2013-02-13 19:29:12 -0800204struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700205 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200206 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200207 int work_color; /* L: current color */
208 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700209 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200210 int nr_in_flight[WORK_NR_COLORS];
211 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200212 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200213 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200214 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700215 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700216 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700217
218 /*
219 * Release of unbound pwq is punted to system_wq. See put_pwq()
220 * and pwq_unbound_release_workfn() for details. pool_workqueue
221 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700222 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700223 */
224 struct work_struct unbound_release_work;
225 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700226} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200229 * Structure used to wait for workqueue flush.
230 */
231struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700232 struct list_head list; /* WQ: list of flushers */
233 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200234 struct completion done; /* flush completion */
235};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Tejun Heo226223a2013-03-12 11:30:05 -0700237struct wq_device;
238
Tejun Heo73f53c42010-06-29 10:07:11 +0200239/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700240 * The externally visible workqueue. It relays the issued work items to
241 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 */
243struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700244 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400245 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200246
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700247 struct mutex mutex; /* protects this wq */
248 int work_color; /* WQ: current work color */
249 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800250 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700251 struct wq_flusher *first_flusher; /* WQ: first flusher */
252 struct list_head flusher_queue; /* WQ: flush waiters */
253 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200254
Tejun Heo2e109a22013-03-13 19:47:40 -0700255 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200256 struct worker *rescuer; /* I: rescue worker */
257
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700258 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700259 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700260
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800261 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
262 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700263
Tejun Heo226223a2013-03-12 11:30:05 -0700264#ifdef CONFIG_SYSFS
265 struct wq_device *wq_dev; /* I: for sysfs interface */
266#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700267#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200268 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700269#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700270 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700271
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400272 /*
273 * Destruction of workqueue_struct is sched-RCU protected to allow
274 * walking the workqueues list without grabbing wq_pool_mutex.
275 * This is used to dump all workqueues from sysrq.
276 */
277 struct rcu_head rcu;
278
Tejun Heo2728fd22013-04-01 11:23:35 -0700279 /* hot fields used during command issue, aligned to cacheline */
280 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
281 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800282 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283};
284
Tejun Heoe904e6c2013-03-12 11:29:57 -0700285static struct kmem_cache *pwq_cache;
286
Tejun Heobce90382013-04-01 11:23:32 -0700287static cpumask_var_t *wq_numa_possible_cpumask;
288 /* possible CPUs of each node */
289
Tejun Heod55262c2013-04-01 11:23:38 -0700290static bool wq_disable_numa;
291module_param_named(disable_numa, wq_disable_numa, bool, 0444);
292
Viresh Kumarcee22a12013-04-08 16:45:40 +0530293/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930294static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530295module_param_named(power_efficient, wq_power_efficient, bool, 0444);
296
Tejun Heo4b5facd2016-09-16 15:49:32 -0400297bool wq_online; /* can kworkers be created yet? */
298
Tejun Heobce90382013-04-01 11:23:32 -0700299static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
300
Tejun Heo4c16bd32013-04-01 11:23:36 -0700301/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
302static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
303
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700304static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700305static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo43a980a2017-10-09 08:04:13 -0700306static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
Tejun Heo5bcab332013-03-13 19:47:40 -0700307
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400308static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700309static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700310
Mike Galbraithef5571802016-02-09 17:59:38 -0500311/* PL: allowable cpus for unbound wqs and work items */
312static cpumask_var_t wq_unbound_cpumask;
313
314/* CPU where unbound work was last round robin scheduled from this CPU */
315static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800316
Tejun Heof303fcc2016-02-09 17:59:38 -0500317/*
318 * Local execution of unbound work items is no longer guaranteed. The
319 * following always forces round-robin CPU selection on unbound work items
320 * to uncover usages which depend on it.
321 */
322#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
323static bool wq_debug_force_rr_cpu = true;
324#else
325static bool wq_debug_force_rr_cpu = false;
326#endif
327module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
328
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700329/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700330static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700331
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700332static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700333
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700334/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700335static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
336
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700337/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700338static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
339
Tejun Heo8a2b7532013-09-05 12:30:04 -0400340/* I: attributes used when instantiating ordered pools on demand */
341static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
342
Tejun Heod320c032010-06-29 10:07:14 +0200343struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400344EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300345struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900346EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300347struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200348EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300349struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200350EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300351struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100352EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530353struct workqueue_struct *system_power_efficient_wq __read_mostly;
354EXPORT_SYMBOL_GPL(system_power_efficient_wq);
355struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
356EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200357
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700358static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800359static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700360
Tejun Heo97bd2342010-10-05 10:41:14 +0200361#define CREATE_TRACE_POINTS
362#include <trace/events/workqueue.h>
363
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700364#define assert_rcu_or_pool_mutex() \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700365 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
366 !lockdep_is_held(&wq_pool_mutex), \
367 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700368
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700369#define assert_rcu_or_wq_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700370 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
371 !lockdep_is_held(&wq->mutex), \
372 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700373
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800374#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700375 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
376 !lockdep_is_held(&wq->mutex) && \
377 !lockdep_is_held(&wq_pool_mutex), \
378 "sched RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800379
Tejun Heof02ae732013-03-12 11:30:03 -0700380#define for_each_cpu_worker_pool(pool, cpu) \
381 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
382 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700383 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700384
Tejun Heo49e3cf42013-03-12 11:29:58 -0700385/**
Tejun Heo17116962013-03-12 11:29:58 -0700386 * for_each_pool - iterate through all worker_pools in the system
387 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700388 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700389 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700390 * This must be called either with wq_pool_mutex held or sched RCU read
391 * locked. If the pool needs to be used beyond the locking in effect, the
392 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700393 *
394 * The if/else clause exists only for the lockdep assertion and can be
395 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700396 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700397#define for_each_pool(pool, pi) \
398 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700399 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700400 else
Tejun Heo17116962013-03-12 11:29:58 -0700401
402/**
Tejun Heo822d8402013-03-19 13:45:21 -0700403 * for_each_pool_worker - iterate through all workers of a worker_pool
404 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700405 * @pool: worker_pool to iterate workers of
406 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800407 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700408 *
409 * The if/else clause exists only for the lockdep assertion and can be
410 * ignored.
411 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800412#define for_each_pool_worker(worker, pool) \
413 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800414 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700415 else
416
417/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700418 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
419 * @pwq: iteration cursor
420 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700421 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700422 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700423 * If the pwq needs to be used beyond the locking in effect, the caller is
424 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700425 *
426 * The if/else clause exists only for the lockdep assertion and can be
427 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700428 */
429#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700430 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700431 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700432 else
Tejun Heof3421792010-07-02 10:03:51 +0200433
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900434#ifdef CONFIG_DEBUG_OBJECTS_WORK
435
436static struct debug_obj_descr work_debug_descr;
437
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100438static void *work_debug_hint(void *addr)
439{
440 return ((struct work_struct *) addr)->func;
441}
442
Du, Changbinb9fdac72016-05-19 17:09:41 -0700443static bool work_is_static_object(void *addr)
444{
445 struct work_struct *work = addr;
446
447 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
448}
449
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900450/*
451 * fixup_init is called when:
452 * - an active object is initialized
453 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700454static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900455{
456 struct work_struct *work = addr;
457
458 switch (state) {
459 case ODEBUG_STATE_ACTIVE:
460 cancel_work_sync(work);
461 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700462 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900463 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700464 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900465 }
466}
467
468/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900469 * fixup_free is called when:
470 * - an active object is freed
471 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700472static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900473{
474 struct work_struct *work = addr;
475
476 switch (state) {
477 case ODEBUG_STATE_ACTIVE:
478 cancel_work_sync(work);
479 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700480 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900481 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700482 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900483 }
484}
485
486static struct debug_obj_descr work_debug_descr = {
487 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100488 .debug_hint = work_debug_hint,
Du, Changbinb9fdac72016-05-19 17:09:41 -0700489 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900490 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900491 .fixup_free = work_fixup_free,
492};
493
494static inline void debug_work_activate(struct work_struct *work)
495{
496 debug_object_activate(work, &work_debug_descr);
497}
498
499static inline void debug_work_deactivate(struct work_struct *work)
500{
501 debug_object_deactivate(work, &work_debug_descr);
502}
503
504void __init_work(struct work_struct *work, int onstack)
505{
506 if (onstack)
507 debug_object_init_on_stack(work, &work_debug_descr);
508 else
509 debug_object_init(work, &work_debug_descr);
510}
511EXPORT_SYMBOL_GPL(__init_work);
512
513void destroy_work_on_stack(struct work_struct *work)
514{
515 debug_object_free(work, &work_debug_descr);
516}
517EXPORT_SYMBOL_GPL(destroy_work_on_stack);
518
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000519void destroy_delayed_work_on_stack(struct delayed_work *work)
520{
521 destroy_timer_on_stack(&work->timer);
522 debug_object_free(&work->work, &work_debug_descr);
523}
524EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
525
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900526#else
527static inline void debug_work_activate(struct work_struct *work) { }
528static inline void debug_work_deactivate(struct work_struct *work) { }
529#endif
530
Li Bin4e8b22b2013-09-10 09:52:35 +0800531/**
532 * worker_pool_assign_id - allocate ID and assing it to @pool
533 * @pool: the pool pointer of interest
534 *
535 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
536 * successfully, -errno on failure.
537 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800538static int worker_pool_assign_id(struct worker_pool *pool)
539{
540 int ret;
541
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700542 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700543
Li Bin4e8b22b2013-09-10 09:52:35 +0800544 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
545 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700546 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700547 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700548 return 0;
549 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800550 return ret;
551}
552
Tejun Heo76af4d92013-03-12 11:30:00 -0700553/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700554 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
555 * @wq: the target workqueue
556 * @node: the node ID
557 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800558 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
559 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700560 * If the pwq needs to be used beyond the locking in effect, the caller is
561 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700562 *
563 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700564 */
565static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
566 int node)
567{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800568 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500569
570 /*
571 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
572 * delayed item is pending. The plan is to keep CPU -> NODE
573 * mapping valid and stable across CPU on/offlines. Once that
574 * happens, this workaround can be removed.
575 */
576 if (unlikely(node == NUMA_NO_NODE))
577 return wq->dfl_pwq;
578
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700579 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
580}
581
Tejun Heo73f53c42010-06-29 10:07:11 +0200582static unsigned int work_color_to_flags(int color)
583{
584 return color << WORK_STRUCT_COLOR_SHIFT;
585}
586
587static int get_work_color(struct work_struct *work)
588{
589 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
590 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
591}
592
593static int work_next_color(int color)
594{
595 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700596}
597
David Howells4594bf12006-12-07 11:33:26 +0000598/*
Tejun Heo112202d2013-02-13 19:29:12 -0800599 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
600 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800601 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200602 *
Tejun Heo112202d2013-02-13 19:29:12 -0800603 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
604 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700605 * work->data. These functions should only be called while the work is
606 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200607 *
Tejun Heo112202d2013-02-13 19:29:12 -0800608 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800609 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800610 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800611 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700612 *
613 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
614 * canceled. While being canceled, a work item may have its PENDING set
615 * but stay off timer and worklist for arbitrarily long and nobody should
616 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000617 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200618static inline void set_work_data(struct work_struct *work, unsigned long data,
619 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000620{
Tejun Heo6183c002013-03-12 11:29:57 -0700621 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200622 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000623}
David Howells365970a2006-11-22 14:54:49 +0000624
Tejun Heo112202d2013-02-13 19:29:12 -0800625static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200626 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200627{
Tejun Heo112202d2013-02-13 19:29:12 -0800628 set_work_data(work, (unsigned long)pwq,
629 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200630}
631
Lai Jiangshan4468a002013-02-06 18:04:53 -0800632static void set_work_pool_and_keep_pending(struct work_struct *work,
633 int pool_id)
634{
635 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
636 WORK_STRUCT_PENDING);
637}
638
Tejun Heo7c3eed52013-01-24 11:01:33 -0800639static void set_work_pool_and_clear_pending(struct work_struct *work,
640 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000641{
Tejun Heo23657bb2012-08-13 17:08:19 -0700642 /*
643 * The following wmb is paired with the implied mb in
644 * test_and_set_bit(PENDING) and ensures all updates to @work made
645 * here are visible to and precede any updates by the next PENDING
646 * owner.
647 */
648 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800649 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200650 /*
651 * The following mb guarantees that previous clear of a PENDING bit
652 * will not be reordered with any speculative LOADS or STORES from
653 * work->current_func, which is executed afterwards. This possible
654 * reordering can lead to a missed execution on attempt to qeueue
655 * the same @work. E.g. consider this case:
656 *
657 * CPU#0 CPU#1
658 * ---------------------------- --------------------------------
659 *
660 * 1 STORE event_indicated
661 * 2 queue_work_on() {
662 * 3 test_and_set_bit(PENDING)
663 * 4 } set_..._and_clear_pending() {
664 * 5 set_work_data() # clear bit
665 * 6 smp_mb()
666 * 7 work->current_func() {
667 * 8 LOAD event_indicated
668 * }
669 *
670 * Without an explicit full barrier speculative LOAD on line 8 can
671 * be executed before CPU#0 does STORE on line 1. If that happens,
672 * CPU#0 observes the PENDING bit is still set and new execution of
673 * a @work is not queued in a hope, that CPU#1 will eventually
674 * finish the queued @work. Meanwhile CPU#1 does not see
675 * event_indicated is set, because speculative LOAD was executed
676 * before actual STORE.
677 */
678 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200679}
680
681static void clear_work_data(struct work_struct *work)
682{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800683 smp_wmb(); /* see set_work_pool_and_clear_pending() */
684 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200685}
686
Tejun Heo112202d2013-02-13 19:29:12 -0800687static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200688{
Tejun Heoe1201532010-07-22 14:14:25 +0200689 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200690
Tejun Heo112202d2013-02-13 19:29:12 -0800691 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200692 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
693 else
694 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200695}
696
Tejun Heo7c3eed52013-01-24 11:01:33 -0800697/**
698 * get_work_pool - return the worker_pool a given work was associated with
699 * @work: the work item of interest
700 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700701 * Pools are created and destroyed under wq_pool_mutex, and allows read
702 * access under sched-RCU read lock. As such, this function should be
703 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700704 *
705 * All fields of the returned pool are accessible as long as the above
706 * mentioned locking is in effect. If the returned pool needs to be used
707 * beyond the critical section, the caller is responsible for ensuring the
708 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700709 *
710 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800711 */
712static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200713{
Tejun Heoe1201532010-07-22 14:14:25 +0200714 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800715 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200716
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700717 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700718
Tejun Heo112202d2013-02-13 19:29:12 -0800719 if (data & WORK_STRUCT_PWQ)
720 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800721 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200722
Tejun Heo7c3eed52013-01-24 11:01:33 -0800723 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
724 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200725 return NULL;
726
Tejun Heofa1b54e2013-03-12 11:30:00 -0700727 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800728}
729
730/**
731 * get_work_pool_id - return the worker pool ID a given work is associated with
732 * @work: the work item of interest
733 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700734 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800735 * %WORK_OFFQ_POOL_NONE if none.
736 */
737static int get_work_pool_id(struct work_struct *work)
738{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800739 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800740
Tejun Heo112202d2013-02-13 19:29:12 -0800741 if (data & WORK_STRUCT_PWQ)
742 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800743 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
744
745 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800746}
747
Tejun Heobbb68df2012-08-03 10:30:46 -0700748static void mark_work_canceling(struct work_struct *work)
749{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800750 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700751
Tejun Heo7c3eed52013-01-24 11:01:33 -0800752 pool_id <<= WORK_OFFQ_POOL_SHIFT;
753 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700754}
755
756static bool work_is_canceling(struct work_struct *work)
757{
758 unsigned long data = atomic_long_read(&work->data);
759
Tejun Heo112202d2013-02-13 19:29:12 -0800760 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700761}
762
David Howells365970a2006-11-22 14:54:49 +0000763/*
Tejun Heo32704762012-07-13 22:16:45 -0700764 * Policy functions. These define the policies on how the global worker
765 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800766 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000767 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200768
Tejun Heo63d95a92012-07-12 14:46:37 -0700769static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000770{
Tejun Heoe19e3972013-01-24 11:39:44 -0800771 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000772}
773
Tejun Heoe22bee72010-06-29 10:07:14 +0200774/*
775 * Need to wake up a worker? Called from anything but currently
776 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700777 *
778 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800779 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700780 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200781 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700782static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000783{
Tejun Heo63d95a92012-07-12 14:46:37 -0700784 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000785}
786
Tejun Heoe22bee72010-06-29 10:07:14 +0200787/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700788static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200789{
Tejun Heo63d95a92012-07-12 14:46:37 -0700790 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200791}
792
793/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700794static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200795{
Tejun Heoe19e3972013-01-24 11:39:44 -0800796 return !list_empty(&pool->worklist) &&
797 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200798}
799
800/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700801static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200802{
Tejun Heo63d95a92012-07-12 14:46:37 -0700803 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200804}
805
Tejun Heoe22bee72010-06-29 10:07:14 +0200806/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700807static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200808{
Tejun Heo43a980a2017-10-09 08:04:13 -0700809 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700810 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
811 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200812
813 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
814}
815
816/*
817 * Wake up functions.
818 */
819
Lai Jiangshan1037de32014-05-22 16:44:07 +0800820/* Return the first idle worker. Safe with preemption disabled */
821static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200822{
Tejun Heo63d95a92012-07-12 14:46:37 -0700823 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200824 return NULL;
825
Tejun Heo63d95a92012-07-12 14:46:37 -0700826 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200827}
828
829/**
830 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700831 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200832 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700833 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200834 *
835 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800836 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200837 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700838static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200839{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800840 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200841
842 if (likely(worker))
843 wake_up_process(worker->task);
844}
845
Tejun Heo4690c4a2010-06-29 10:07:10 +0200846/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200847 * wq_worker_waking_up - a worker is waking up
848 * @task: task waking up
849 * @cpu: CPU @task is waking up to
850 *
851 * This function is called during try_to_wake_up() when a worker is
852 * being awoken.
853 *
854 * CONTEXT:
855 * spin_lock_irq(rq->lock)
856 */
Tejun Heod84ff052013-03-12 11:29:59 -0700857void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200858{
859 struct worker *worker = kthread_data(task);
860
Joonsoo Kim36576002012-10-26 23:03:49 +0900861 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800862 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800863 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900864 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200865}
866
867/**
868 * wq_worker_sleeping - a worker is going to sleep
869 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200870 *
871 * This function is called during schedule() when a busy worker is
872 * going to sleep. Worker on the same cpu can be woken up by
873 * returning pointer to its task.
874 *
875 * CONTEXT:
876 * spin_lock_irq(rq->lock)
877 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700878 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200879 * Worker task on @cpu to wake up, %NULL if none.
880 */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100881struct task_struct *wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200882{
883 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800884 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200885
Tejun Heo111c2252013-01-17 17:16:24 -0800886 /*
887 * Rescuers, which may not have all the fields set up like normal
888 * workers, also reach here, let's not access anything before
889 * checking NOT_RUNNING.
890 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500891 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200892 return NULL;
893
Tejun Heo111c2252013-01-17 17:16:24 -0800894 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800895
Tejun Heoe22bee72010-06-29 10:07:14 +0200896 /* this can only happen on the local cpu */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100897 if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
Tejun Heo6183c002013-03-12 11:29:57 -0700898 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200899
900 /*
901 * The counterpart of the following dec_and_test, implied mb,
902 * worklist not empty test sequence is in insert_work().
903 * Please read comment there.
904 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700905 * NOT_RUNNING is clear. This means that we're bound to and
906 * running on the local cpu w/ rq lock held and preemption
907 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800908 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700909 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200910 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800911 if (atomic_dec_and_test(&pool->nr_running) &&
912 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800913 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200914 return to_wakeup ? to_wakeup->task : NULL;
915}
916
917/**
Johannes Weinerb7f0f222019-02-01 14:20:42 -0800918 * wq_worker_last_func - retrieve worker's last work function
919 *
920 * Determine the last function a worker executed. This is called from
921 * the scheduler to get a worker's last known identity.
922 *
923 * CONTEXT:
924 * spin_lock_irq(rq->lock)
925 *
926 * Return:
927 * The last work function %current executed as a worker, NULL if it
928 * hasn't executed any work yet.
929 */
930work_func_t wq_worker_last_func(struct task_struct *task)
931{
932 struct worker *worker = kthread_data(task);
933
934 return worker->last_func;
935}
936
937/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200938 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200939 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200940 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200941 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800942 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200943 *
Tejun Heocb444762010-07-02 10:03:50 +0200944 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800945 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200946 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800947static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200948{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700949 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200950
Tejun Heocb444762010-07-02 10:03:50 +0200951 WARN_ON_ONCE(worker->task != current);
952
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800953 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200954 if ((flags & WORKER_NOT_RUNNING) &&
955 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800956 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200957 }
958
Tejun Heod302f012010-06-29 10:07:13 +0200959 worker->flags |= flags;
960}
961
962/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200963 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200964 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200965 * @flags: flags to clear
966 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200967 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200968 *
Tejun Heocb444762010-07-02 10:03:50 +0200969 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800970 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200971 */
972static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
973{
Tejun Heo63d95a92012-07-12 14:46:37 -0700974 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200975 unsigned int oflags = worker->flags;
976
Tejun Heocb444762010-07-02 10:03:50 +0200977 WARN_ON_ONCE(worker->task != current);
978
Tejun Heod302f012010-06-29 10:07:13 +0200979 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200980
Tejun Heo42c025f2011-01-11 15:58:49 +0100981 /*
982 * If transitioning out of NOT_RUNNING, increment nr_running. Note
983 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
984 * of multiple flags, not a single flag.
985 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200986 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
987 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800988 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200989}
990
991/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200992 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800993 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200994 * @work: work to find worker for
995 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800996 * Find a worker which is executing @work on @pool by searching
997 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800998 * to match, its current execution should match the address of @work and
999 * its work function. This is to avoid unwanted dependency between
1000 * unrelated work executions through a work item being recycled while still
1001 * being executed.
1002 *
1003 * This is a bit tricky. A work item may be freed once its execution
1004 * starts and nothing prevents the freed area from being recycled for
1005 * another work item. If the same work item address ends up being reused
1006 * before the original execution finishes, workqueue will identify the
1007 * recycled work item as currently executing and make it wait until the
1008 * current execution finishes, introducing an unwanted dependency.
1009 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001010 * This function checks the work item address and work function to avoid
1011 * false positives. Note that this isn't complete as one may construct a
1012 * work function which can introduce dependency onto itself through a
1013 * recycled work item. Well, if somebody wants to shoot oneself in the
1014 * foot that badly, there's only so much we can do, and if such deadlock
1015 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001016 *
1017 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001018 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001019 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001020 * Return:
1021 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001022 * otherwise.
1023 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001024static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001025 struct work_struct *work)
1026{
Sasha Levin42f85702012-12-17 10:01:23 -05001027 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001028
Sasha Levinb67bfe02013-02-27 17:06:00 -08001029 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001030 (unsigned long)work)
1031 if (worker->current_work == work &&
1032 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001033 return worker;
1034
1035 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001036}
1037
1038/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001039 * move_linked_works - move linked works to a list
1040 * @work: start of series of works to be scheduled
1041 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301042 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001043 *
1044 * Schedule linked works starting from @work to @head. Work series to
1045 * be scheduled starts at @work and includes any consecutive work with
1046 * WORK_STRUCT_LINKED set in its predecessor.
1047 *
1048 * If @nextp is not NULL, it's updated to point to the next work of
1049 * the last scheduled work. This allows move_linked_works() to be
1050 * nested inside outer list_for_each_entry_safe().
1051 *
1052 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001053 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001054 */
1055static void move_linked_works(struct work_struct *work, struct list_head *head,
1056 struct work_struct **nextp)
1057{
1058 struct work_struct *n;
1059
1060 /*
1061 * Linked worklist will always end before the end of the list,
1062 * use NULL for list head.
1063 */
1064 list_for_each_entry_safe_from(work, n, NULL, entry) {
1065 list_move_tail(&work->entry, head);
1066 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1067 break;
1068 }
1069
1070 /*
1071 * If we're already inside safe list traversal and have moved
1072 * multiple works to the scheduled queue, the next position
1073 * needs to be updated.
1074 */
1075 if (nextp)
1076 *nextp = n;
1077}
1078
Tejun Heo8864b4e2013-03-12 11:30:04 -07001079/**
1080 * get_pwq - get an extra reference on the specified pool_workqueue
1081 * @pwq: pool_workqueue to get
1082 *
1083 * Obtain an extra reference on @pwq. The caller should guarantee that
1084 * @pwq has positive refcnt and be holding the matching pool->lock.
1085 */
1086static void get_pwq(struct pool_workqueue *pwq)
1087{
1088 lockdep_assert_held(&pwq->pool->lock);
1089 WARN_ON_ONCE(pwq->refcnt <= 0);
1090 pwq->refcnt++;
1091}
1092
1093/**
1094 * put_pwq - put a pool_workqueue reference
1095 * @pwq: pool_workqueue to put
1096 *
1097 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1098 * destruction. The caller should be holding the matching pool->lock.
1099 */
1100static void put_pwq(struct pool_workqueue *pwq)
1101{
1102 lockdep_assert_held(&pwq->pool->lock);
1103 if (likely(--pwq->refcnt))
1104 return;
1105 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1106 return;
1107 /*
1108 * @pwq can't be released under pool->lock, bounce to
1109 * pwq_unbound_release_workfn(). This never recurses on the same
1110 * pool->lock as this path is taken only for unbound workqueues and
1111 * the release work item is scheduled on a per-cpu workqueue. To
1112 * avoid lockdep warning, unbound pool->locks are given lockdep
1113 * subclass of 1 in get_unbound_pool().
1114 */
1115 schedule_work(&pwq->unbound_release_work);
1116}
1117
Tejun Heodce90d42013-04-01 11:23:35 -07001118/**
1119 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1120 * @pwq: pool_workqueue to put (can be %NULL)
1121 *
1122 * put_pwq() with locking. This function also allows %NULL @pwq.
1123 */
1124static void put_pwq_unlocked(struct pool_workqueue *pwq)
1125{
1126 if (pwq) {
1127 /*
1128 * As both pwqs and pools are sched-RCU protected, the
1129 * following lock operations are safe.
1130 */
1131 spin_lock_irq(&pwq->pool->lock);
1132 put_pwq(pwq);
1133 spin_unlock_irq(&pwq->pool->lock);
1134 }
1135}
1136
Tejun Heo112202d2013-02-13 19:29:12 -08001137static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001138{
Tejun Heo112202d2013-02-13 19:29:12 -08001139 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001140
1141 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001142 if (list_empty(&pwq->pool->worklist))
1143 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001144 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001145 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001146 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001147}
1148
Tejun Heo112202d2013-02-13 19:29:12 -08001149static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001150{
Tejun Heo112202d2013-02-13 19:29:12 -08001151 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001152 struct work_struct, entry);
1153
Tejun Heo112202d2013-02-13 19:29:12 -08001154 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001155}
1156
Tejun Heobf4ede02012-08-03 10:30:46 -07001157/**
Tejun Heo112202d2013-02-13 19:29:12 -08001158 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1159 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001160 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001161 *
1162 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001163 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001164 *
1165 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001166 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001167 */
Tejun Heo112202d2013-02-13 19:29:12 -08001168static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001169{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001170 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001171 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001172 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001173
Tejun Heo112202d2013-02-13 19:29:12 -08001174 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001175
Tejun Heo112202d2013-02-13 19:29:12 -08001176 pwq->nr_active--;
1177 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001178 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001179 if (pwq->nr_active < pwq->max_active)
1180 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001181 }
1182
1183 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001184 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001185 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001186
1187 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001188 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001189 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001190
Tejun Heo112202d2013-02-13 19:29:12 -08001191 /* this pwq is done, clear flush_color */
1192 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001193
1194 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001195 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001196 * will handle the rest.
1197 */
Tejun Heo112202d2013-02-13 19:29:12 -08001198 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1199 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001200out_put:
1201 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001202}
1203
Tejun Heo36e227d2012-08-03 10:30:46 -07001204/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001205 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001206 * @work: work item to steal
1207 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001208 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001209 *
1210 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001211 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001212 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001213 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001214 * 1 if @work was pending and we successfully stole PENDING
1215 * 0 if @work was idle and we claimed PENDING
1216 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001217 * -ENOENT if someone else is canceling @work, this state may persist
1218 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001219 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001220 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001221 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001222 * interrupted while holding PENDING and @work off queue, irq must be
1223 * disabled on entry. This, combined with delayed_work->timer being
1224 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001225 *
1226 * On successful return, >= 0, irq is disabled and the caller is
1227 * responsible for releasing it using local_irq_restore(*@flags).
1228 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001229 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001230 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001231static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1232 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001233{
Tejun Heod565ed62013-01-24 11:01:33 -08001234 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001235 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001236
Tejun Heobbb68df2012-08-03 10:30:46 -07001237 local_irq_save(*flags);
1238
Tejun Heo36e227d2012-08-03 10:30:46 -07001239 /* try to steal the timer if it exists */
1240 if (is_dwork) {
1241 struct delayed_work *dwork = to_delayed_work(work);
1242
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001243 /*
1244 * dwork->timer is irqsafe. If del_timer() fails, it's
1245 * guaranteed that the timer is not queued anywhere and not
1246 * running on the local CPU.
1247 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001248 if (likely(del_timer(&dwork->timer)))
1249 return 1;
1250 }
1251
1252 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001253 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1254 return 0;
1255
1256 /*
1257 * The queueing is in progress, or it is already queued. Try to
1258 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1259 */
Tejun Heod565ed62013-01-24 11:01:33 -08001260 pool = get_work_pool(work);
1261 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001262 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001263
Tejun Heod565ed62013-01-24 11:01:33 -08001264 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001265 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001266 * work->data is guaranteed to point to pwq only while the work
1267 * item is queued on pwq->wq, and both updating work->data to point
1268 * to pwq on queueing and to pool on dequeueing are done under
1269 * pwq->pool->lock. This in turn guarantees that, if work->data
1270 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001271 * item is currently queued on that pool.
1272 */
Tejun Heo112202d2013-02-13 19:29:12 -08001273 pwq = get_work_pwq(work);
1274 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001275 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001276
Tejun Heo16062832013-02-06 18:04:53 -08001277 /*
1278 * A delayed work item cannot be grabbed directly because
1279 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001280 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001281 * management later on and cause stall. Make sure the work
1282 * item is activated before grabbing.
1283 */
1284 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001285 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001286
Tejun Heo16062832013-02-06 18:04:53 -08001287 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001288 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001289
Tejun Heo112202d2013-02-13 19:29:12 -08001290 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001291 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001292
Tejun Heo16062832013-02-06 18:04:53 -08001293 spin_unlock(&pool->lock);
1294 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001295 }
Tejun Heod565ed62013-01-24 11:01:33 -08001296 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001297fail:
1298 local_irq_restore(*flags);
1299 if (work_is_canceling(work))
1300 return -ENOENT;
1301 cpu_relax();
Pavankumar Kondeti0c0b7642017-01-04 10:41:15 +05301302 /*
1303 * The queueing is in progress in another context. If we keep
1304 * taking the pool->lock in a busy loop, the other context may
1305 * never get the lock. Give 1 usec delay to avoid this contention.
1306 */
1307 udelay(1);
Tejun Heo36e227d2012-08-03 10:30:46 -07001308 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001309}
1310
1311/**
Tejun Heo706026c2013-01-24 11:01:34 -08001312 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001313 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001314 * @work: work to insert
1315 * @head: insertion point
1316 * @extra_flags: extra WORK_STRUCT_* flags to set
1317 *
Tejun Heo112202d2013-02-13 19:29:12 -08001318 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001319 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001320 *
1321 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001322 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001323 */
Tejun Heo112202d2013-02-13 19:29:12 -08001324static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1325 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001326{
Tejun Heo112202d2013-02-13 19:29:12 -08001327 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001328
Tejun Heo4690c4a2010-06-29 10:07:10 +02001329 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001330 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001331 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001332 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001333
1334 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001335 * Ensure either wq_worker_sleeping() sees the above
1336 * list_add_tail() or we see zero nr_running to avoid workers lying
1337 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001338 */
1339 smp_mb();
1340
Tejun Heo63d95a92012-07-12 14:46:37 -07001341 if (__need_more_worker(pool))
1342 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001343}
1344
Tejun Heoc8efcc22010-12-20 19:32:04 +01001345/*
1346 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001347 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001348 */
1349static bool is_chained_work(struct workqueue_struct *wq)
1350{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001351 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001352
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001353 worker = current_wq_worker();
1354 /*
1355 * Return %true iff I'm a worker execuing a work item on @wq. If
1356 * I'm @worker, it's safe to dereference it without locking.
1357 */
Tejun Heo112202d2013-02-13 19:29:12 -08001358 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001359}
1360
Mike Galbraithef5571802016-02-09 17:59:38 -05001361/*
1362 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1363 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1364 * avoid perturbing sensitive tasks.
1365 */
1366static int wq_select_unbound_cpu(int cpu)
1367{
Tejun Heof303fcc2016-02-09 17:59:38 -05001368 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001369 int new_cpu;
1370
Tejun Heof303fcc2016-02-09 17:59:38 -05001371 if (likely(!wq_debug_force_rr_cpu)) {
1372 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1373 return cpu;
1374 } else if (!printed_dbg_warning) {
1375 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1376 printed_dbg_warning = true;
1377 }
1378
Mike Galbraithef5571802016-02-09 17:59:38 -05001379 if (cpumask_empty(wq_unbound_cpumask))
1380 return cpu;
1381
1382 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1383 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1384 if (unlikely(new_cpu >= nr_cpu_ids)) {
1385 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1386 if (unlikely(new_cpu >= nr_cpu_ids))
1387 return cpu;
1388 }
1389 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1390
1391 return new_cpu;
1392}
1393
Tejun Heod84ff052013-03-12 11:29:59 -07001394static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 struct work_struct *work)
1396{
Tejun Heo112202d2013-02-13 19:29:12 -08001397 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001398 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001399 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001400 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001401 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001402
1403 /*
1404 * While a work item is PENDING && off queue, a task trying to
1405 * steal the PENDING will busy-loop waiting for it to either get
1406 * queued or lose PENDING. Grabbing PENDING and queueing should
1407 * happen with IRQ disabled.
1408 */
1409 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410
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
Zqiangb7372542021-02-18 11:16:49 +08001493 debug_work_activate(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001494 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001495
Tejun Heo112202d2013-02-13 19:29:12 -08001496 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497}
1498
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001499/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001500 * queue_work_on - queue work on specific cpu
1501 * @cpu: CPU number to execute work on
1502 * @wq: workqueue to use
1503 * @work: work to queue
1504 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001505 * We queue the work to a specific CPU, the caller must ensure it
1506 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001507 *
1508 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001509 */
Tejun Heod4283e92012-08-03 10:30:44 -07001510bool queue_work_on(int cpu, struct workqueue_struct *wq,
1511 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001512{
Tejun Heod4283e92012-08-03 10:30:44 -07001513 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001514 unsigned long flags;
1515
1516 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001517
Tejun Heo22df02b2010-06-29 10:07:10 +02001518 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001519 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001520 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001521 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001522
1523 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001524 return ret;
1525}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001526EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001527
Tejun Heod8e794d2012-08-03 10:30:45 -07001528void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529{
David Howells52bad642006-11-22 14:54:01 +00001530 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001532 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001533 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001535EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001537static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1538 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001540 struct timer_list *timer = &dwork->timer;
1541 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Tejun Heo757e1842017-03-06 15:33:42 -05001543 WARN_ON_ONCE(!wq);
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001544 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1545 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001546 WARN_ON_ONCE(timer_pending(timer));
1547 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001548
Tejun Heo8852aac2012-12-01 16:23:42 -08001549 /*
1550 * If @delay is 0, queue @dwork->work immediately. This is for
1551 * both optimization and correctness. The earliest @timer can
1552 * expire is on the closest next tick and delayed_work users depend
1553 * on that there's no such delay when @delay is 0.
1554 */
1555 if (!delay) {
1556 __queue_work(cpu, wq, &dwork->work);
1557 return;
1558 }
1559
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001560 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001561 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001562 timer->expires = jiffies + delay;
1563
Tejun Heo041bd122016-02-09 16:11:26 -05001564 if (unlikely(cpu != WORK_CPU_UNBOUND))
1565 add_timer_on(timer, cpu);
1566 else
1567 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568}
1569
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001570/**
1571 * queue_delayed_work_on - queue work on specific CPU after delay
1572 * @cpu: CPU number to execute work on
1573 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001574 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001575 * @delay: number of jiffies to wait before queueing
1576 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001577 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001578 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1579 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001580 */
Tejun Heod4283e92012-08-03 10:30:44 -07001581bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1582 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001583{
David Howells52bad642006-11-22 14:54:01 +00001584 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001585 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001586 unsigned long flags;
1587
1588 /* read the comment in __queue_work() */
1589 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001590
Tejun Heo22df02b2010-06-29 10:07:10 +02001591 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001592 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001593 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001594 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001595
1596 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001597 return ret;
1598}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001599EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600
Tejun Heoc8e55f32010-06-29 10:07:12 +02001601/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001602 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1603 * @cpu: CPU number to execute work on
1604 * @wq: workqueue to use
1605 * @dwork: work to queue
1606 * @delay: number of jiffies to wait before queueing
1607 *
1608 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1609 * modify @dwork's timer so that it expires after @delay. If @delay is
1610 * zero, @work is guaranteed to be scheduled immediately regardless of its
1611 * current state.
1612 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001613 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001614 * pending and its timer was modified.
1615 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001616 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001617 * See try_to_grab_pending() for details.
1618 */
1619bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1620 struct delayed_work *dwork, unsigned long delay)
1621{
1622 unsigned long flags;
1623 int ret;
1624
1625 do {
1626 ret = try_to_grab_pending(&dwork->work, true, &flags);
1627 } while (unlikely(ret == -EAGAIN));
1628
1629 if (likely(ret >= 0)) {
1630 __queue_delayed_work(cpu, wq, dwork, delay);
1631 local_irq_restore(flags);
1632 }
1633
1634 /* -ENOENT from try_to_grab_pending() becomes %true */
1635 return ret;
1636}
1637EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1638
1639/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001640 * worker_enter_idle - enter idle state
1641 * @worker: worker which is entering idle state
1642 *
1643 * @worker is entering idle state. Update stats and idle timer if
1644 * necessary.
1645 *
1646 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001647 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001648 */
1649static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001651 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
Tejun Heo6183c002013-03-12 11:29:57 -07001653 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1654 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1655 (worker->hentry.next || worker->hentry.pprev)))
1656 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Lai Jiangshan051e1852014-07-22 13:03:02 +08001658 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001659 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001660 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001661 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001662
Tejun Heoc8e55f32010-06-29 10:07:12 +02001663 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001664 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001665
Tejun Heo628c78e2012-07-17 12:39:27 -07001666 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1667 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001668
Tejun Heo544ecf32012-05-14 15:04:50 -07001669 /*
Lai Jiangshan6128fcb2017-12-01 22:20:36 +08001670 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001671 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001672 * nr_running, the warning may trigger spuriously. Check iff
1673 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001674 */
Tejun Heo24647572013-01-24 11:01:33 -08001675 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001676 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001677 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678}
1679
Tejun Heoc8e55f32010-06-29 10:07:12 +02001680/**
1681 * worker_leave_idle - leave idle state
1682 * @worker: worker which is leaving idle state
1683 *
1684 * @worker is leaving idle state. Update stats.
1685 *
1686 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001687 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001688 */
1689static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001691 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
Tejun Heo6183c002013-03-12 11:29:57 -07001693 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1694 return;
Tejun Heod302f012010-06-29 10:07:13 +02001695 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001696 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001697 list_del_init(&worker->entry);
1698}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001700static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001701{
1702 struct worker *worker;
1703
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001704 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001705 if (worker) {
1706 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001707 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001708 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001709 /* on creation a worker is in !idle && prep state */
1710 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001711 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001712 return worker;
1713}
1714
1715/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001716 * worker_attach_to_pool() - attach a worker to a pool
1717 * @worker: worker to be attached
1718 * @pool: the target pool
1719 *
1720 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1721 * cpu-binding of @worker are kept coordinated with the pool across
1722 * cpu-[un]hotplugs.
1723 */
1724static void worker_attach_to_pool(struct worker *worker,
1725 struct worker_pool *pool)
1726{
1727 mutex_lock(&pool->attach_mutex);
1728
1729 /*
1730 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1731 * online CPUs. It'll be re-applied when any of the CPUs come up.
1732 */
1733 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1734
1735 /*
1736 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1737 * stable across this function. See the comments above the
1738 * flag definition for details.
1739 */
1740 if (pool->flags & POOL_DISASSOCIATED)
1741 worker->flags |= WORKER_UNBOUND;
1742
1743 list_add_tail(&worker->node, &pool->workers);
1744
1745 mutex_unlock(&pool->attach_mutex);
1746}
1747
1748/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001749 * worker_detach_from_pool() - detach a worker from its pool
1750 * @worker: worker which is attached to its pool
1751 * @pool: the pool @worker is attached to
1752 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001753 * Undo the attaching which had been done in worker_attach_to_pool(). The
1754 * caller worker shouldn't access to the pool after detached except it has
1755 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001756 */
1757static void worker_detach_from_pool(struct worker *worker,
1758 struct worker_pool *pool)
1759{
1760 struct completion *detach_completion = NULL;
1761
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001762 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001763 list_del(&worker->node);
1764 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001765 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001766 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001767
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001768 /* clear leftover flags without pool->lock after it is detached */
1769 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1770
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001771 if (detach_completion)
1772 complete(detach_completion);
1773}
1774
1775/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001776 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001777 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001778 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001779 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001780 *
1781 * CONTEXT:
1782 * Might sleep. Does GFP_KERNEL allocations.
1783 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001784 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001785 * Pointer to the newly created worker.
1786 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001787static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001788{
Tejun Heoc34056a2010-06-29 10:07:11 +02001789 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001790 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001791 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001792
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001793 /* ID is needed to determine kthread name */
1794 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001795 if (id < 0)
1796 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001797
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001798 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001799 if (!worker)
1800 goto fail;
1801
Tejun Heobd7bdd42012-07-12 14:46:37 -07001802 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001803 worker->id = id;
1804
Tejun Heo29c91e92013-03-12 11:30:03 -07001805 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001806 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1807 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001808 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001809 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1810
Tejun Heof3f90ad2013-04-01 11:23:34 -07001811 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001812 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001813 if (IS_ERR(worker->task))
1814 goto fail;
1815
Oleg Nesterov91151222013-11-14 12:56:18 +01001816 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001817 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001818
Lai Jiangshanda028462014-05-20 17:46:31 +08001819 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001820 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001821
Lai Jiangshan051e1852014-07-22 13:03:02 +08001822 /* start the newly created worker */
1823 spin_lock_irq(&pool->lock);
1824 worker->pool->nr_workers++;
1825 worker_enter_idle(worker);
1826 wake_up_process(worker->task);
1827 spin_unlock_irq(&pool->lock);
1828
Tejun Heoc34056a2010-06-29 10:07:11 +02001829 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001830
Tejun Heoc34056a2010-06-29 10:07:11 +02001831fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001832 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001833 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001834 kfree(worker);
1835 return NULL;
1836}
1837
1838/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001839 * destroy_worker - destroy a workqueue worker
1840 * @worker: worker to be destroyed
1841 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001842 * Destroy @worker and adjust @pool stats accordingly. The worker should
1843 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001844 *
1845 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001846 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001847 */
1848static void destroy_worker(struct worker *worker)
1849{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001850 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001851
Tejun Heocd549682013-03-13 19:47:39 -07001852 lockdep_assert_held(&pool->lock);
1853
Tejun Heoc34056a2010-06-29 10:07:11 +02001854 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001855 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001856 WARN_ON(!list_empty(&worker->scheduled)) ||
1857 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001858 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001859
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001860 pool->nr_workers--;
1861 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001862
Tejun Heoc8e55f32010-06-29 10:07:12 +02001863 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001864 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001865 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001866}
1867
Tejun Heo63d95a92012-07-12 14:46:37 -07001868static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001869{
Tejun Heo63d95a92012-07-12 14:46:37 -07001870 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001871
Tejun Heod565ed62013-01-24 11:01:33 -08001872 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001873
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001874 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001875 struct worker *worker;
1876 unsigned long expires;
1877
1878 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001879 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001880 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1881
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001882 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001883 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001884 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001885 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001886
1887 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001888 }
1889
Tejun Heod565ed62013-01-24 11:01:33 -08001890 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001891}
1892
Tejun Heo493a1722013-03-12 11:29:59 -07001893static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001894{
Tejun Heo112202d2013-02-13 19:29:12 -08001895 struct pool_workqueue *pwq = get_work_pwq(work);
1896 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001897
Tejun Heo2e109a22013-03-13 19:47:40 -07001898 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001899
Tejun Heo493008a2013-03-12 11:30:03 -07001900 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001901 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001902
1903 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001904 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001905 /*
1906 * If @pwq is for an unbound wq, its base ref may be put at
1907 * any time due to an attribute change. Pin @pwq until the
1908 * rescuer is done with it.
1909 */
1910 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001911 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001912 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001913 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001914}
1915
Tejun Heo706026c2013-01-24 11:01:34 -08001916static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001917{
Tejun Heo63d95a92012-07-12 14:46:37 -07001918 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001919 struct work_struct *work;
1920
Tejun Heob2d82902014-12-08 12:39:16 -05001921 spin_lock_irq(&pool->lock);
1922 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001923
Tejun Heo63d95a92012-07-12 14:46:37 -07001924 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001925 /*
1926 * We've been trying to create a new worker but
1927 * haven't been successful. We might be hitting an
1928 * allocation deadlock. Send distress signals to
1929 * rescuers.
1930 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001931 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001932 send_mayday(work);
1933 }
1934
Tejun Heob2d82902014-12-08 12:39:16 -05001935 spin_unlock(&wq_mayday_lock);
1936 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001937
Tejun Heo63d95a92012-07-12 14:46:37 -07001938 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001939}
1940
1941/**
1942 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001943 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001944 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001945 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001946 * have at least one idle worker on return from this function. If
1947 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001948 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001949 * possible allocation deadlock.
1950 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001951 * On return, need_to_create_worker() is guaranteed to be %false and
1952 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001953 *
1954 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001955 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001956 * multiple times. Does GFP_KERNEL allocations. Called only from
1957 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001958 */
Tejun Heo29187a92015-01-16 14:21:16 -05001959static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001960__releases(&pool->lock)
1961__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001962{
Tejun Heoe22bee72010-06-29 10:07:14 +02001963restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001964 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001965
Tejun Heoe22bee72010-06-29 10:07:14 +02001966 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001967 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001968
1969 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001970 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001971 break;
1972
Lai Jiangshane212f362014-06-03 15:32:17 +08001973 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001974
Tejun Heo63d95a92012-07-12 14:46:37 -07001975 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001976 break;
1977 }
1978
Tejun Heo63d95a92012-07-12 14:46:37 -07001979 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001980 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001981 /*
1982 * This is necessary even after a new worker was just successfully
1983 * created as @pool->lock was dropped and the new worker might have
1984 * already become busy.
1985 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001986 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001987 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001988}
1989
1990/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001991 * manage_workers - manage worker pool
1992 * @worker: self
1993 *
Tejun Heo706026c2013-01-24 11:01:34 -08001994 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001995 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001996 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 *
1998 * The caller can safely start processing works on false return. On
1999 * true return, it's guaranteed that need_to_create_worker() is false
2000 * and may_start_working() is true.
2001 *
2002 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002003 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002004 * multiple times. Does GFP_KERNEL allocations.
2005 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002006 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002007 * %false if the pool doesn't need management and the caller can safely
2008 * start processing works, %true if management function was performed and
2009 * the conditions that the caller verified before calling the function may
2010 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002011 */
2012static bool manage_workers(struct worker *worker)
2013{
Tejun Heo63d95a92012-07-12 14:46:37 -07002014 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002015
Tejun Heo43a980a2017-10-09 08:04:13 -07002016 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002017 return false;
Tejun Heo43a980a2017-10-09 08:04:13 -07002018
2019 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002020 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002021
Tejun Heo29187a92015-01-16 14:21:16 -05002022 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002023
Tejun Heo2607d7a2015-03-09 09:22:28 -04002024 pool->manager = NULL;
Tejun Heo43a980a2017-10-09 08:04:13 -07002025 pool->flags &= ~POOL_MANAGER_ACTIVE;
2026 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002027 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002028}
2029
Tejun Heoa62428c2010-06-29 10:07:10 +02002030/**
2031 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002032 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002033 * @work: work to process
2034 *
2035 * Process @work. This function contains all the logics necessary to
2036 * process a single work including synchronization against and
2037 * interaction with other workers on the same cpu, queueing and
2038 * flushing. As long as context requirement is met, any worker can
2039 * call this function to process a work.
2040 *
2041 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002042 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002043 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002044static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002045__releases(&pool->lock)
2046__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002047{
Tejun Heo112202d2013-02-13 19:29:12 -08002048 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002049 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002050 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002051 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002052 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002053#ifdef CONFIG_LOCKDEP
2054 /*
2055 * It is permissible to free the struct work_struct from
2056 * inside the function that is called from it, this we need to
2057 * take into account for lockdep too. To avoid bogus "held
2058 * lock freed" warnings as well as problems when looking into
2059 * work->lockdep_map, make a copy and use that here.
2060 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002061 struct lockdep_map lockdep_map;
2062
2063 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002064#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002065 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002066 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002067 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002068
Tejun Heo7e116292010-06-29 10:07:13 +02002069 /*
2070 * A single work shouldn't be executed concurrently by
2071 * multiple workers on a single cpu. Check whether anyone is
2072 * already processing the work. If so, defer the work to the
2073 * currently executing one.
2074 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002075 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002076 if (unlikely(collision)) {
2077 move_linked_works(work, &collision->scheduled, NULL);
2078 return;
2079 }
2080
Tejun Heo8930cab2012-08-03 10:30:45 -07002081 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002082 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002083 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002084 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002085 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002086 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002087 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002088
Tejun Heoa62428c2010-06-29 10:07:10 +02002089 list_del_init(&work->entry);
2090
Tejun Heo649027d2010-06-29 10:07:14 +02002091 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002092 * CPU intensive works don't participate in concurrency management.
2093 * They're the scheduler's responsibility. This takes @worker out
2094 * of concurrency management and the next code block will chain
2095 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002096 */
2097 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002098 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002099
Tejun Heo974271c2012-07-12 14:46:37 -07002100 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002101 * Wake up another worker if necessary. The condition is always
2102 * false for normal per-cpu workers since nr_running would always
2103 * be >= 1 at this point. This is used to chain execution of the
2104 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002105 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002106 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002107 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002108 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002109
Tejun Heo8930cab2012-08-03 10:30:45 -07002110 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002111 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002112 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002113 * PENDING and queued state changes happen together while IRQ is
2114 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002115 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002116 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002117
Tejun Heod565ed62013-01-24 11:01:33 -08002118 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002119
Tejun Heo112202d2013-02-13 19:29:12 -08002120 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002121 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002122 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002123 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002124 /*
2125 * While we must be careful to not use "work" after this, the trace
2126 * point will only record its address.
2127 */
2128 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002129 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002130 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002131
2132 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002133 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2134 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002135 current->comm, preempt_count(), task_pid_nr(current),
2136 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002137 debug_show_held_locks(current);
Syed Rameez Mustafacf9c1e42013-07-15 11:52:09 -07002138 BUG_ON(PANIC_CORRUPTION);
Tejun Heoa62428c2010-06-29 10:07:10 +02002139 dump_stack();
2140 }
2141
Tejun Heob22ce272013-08-28 17:33:37 -04002142 /*
2143 * The following prevents a kworker from hogging CPU on !PREEMPT
2144 * kernels, where a requeueing work item waiting for something to
2145 * happen could deadlock with stop_machine as such work item could
2146 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002147 * stop_machine. At the same time, report a quiescent RCU state so
2148 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002149 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002150 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002151
Tejun Heod565ed62013-01-24 11:01:33 -08002152 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002153
Tejun Heofb0e7be2010-06-29 10:07:15 +02002154 /* clear cpu intensive status */
2155 if (unlikely(cpu_intensive))
2156 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2157
Johannes Weinerb7f0f222019-02-01 14:20:42 -08002158 /* tag the worker for identification in schedule() */
2159 worker->last_func = worker->current_func;
2160
Tejun Heoa62428c2010-06-29 10:07:10 +02002161 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002162 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002163 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002164 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002165 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002166 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002167 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002168}
2169
Tejun Heoaffee4b2010-06-29 10:07:12 +02002170/**
2171 * process_scheduled_works - process scheduled works
2172 * @worker: self
2173 *
2174 * Process all scheduled works. Please note that the scheduled list
2175 * may change while processing a work, so this function repeatedly
2176 * fetches a work from the top and executes it.
2177 *
2178 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002179 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002180 * multiple times.
2181 */
2182static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002184 while (!list_empty(&worker->scheduled)) {
2185 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002187 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189}
2190
Tejun Heo4690c4a2010-06-29 10:07:10 +02002191/**
2192 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002193 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002194 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002195 * The worker thread function. All workers belong to a worker_pool -
2196 * either a per-cpu one or dynamic unbound one. These workers process all
2197 * work items regardless of their specific target workqueue. The only
2198 * exception is work items which belong to workqueues with a rescuer which
2199 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002200 *
2201 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002202 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002203static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204{
Tejun Heoc34056a2010-06-29 10:07:11 +02002205 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002206 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207
Tejun Heoe22bee72010-06-29 10:07:14 +02002208 /* tell the scheduler that this is a workqueue worker */
2209 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002210woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002211 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002212
Tejun Heoa9ab7752013-03-19 13:45:21 -07002213 /* am I supposed to die? */
2214 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002215 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002216 WARN_ON_ONCE(!list_empty(&worker->entry));
2217 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002218
2219 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002220 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002221 worker_detach_from_pool(worker, pool);
2222 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002223 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002225
Tejun Heoc8e55f32010-06-29 10:07:12 +02002226 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002227recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002228 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002229 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002230 goto sleep;
2231
2232 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002233 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002234 goto recheck;
2235
Tejun Heoc8e55f32010-06-29 10:07:12 +02002236 /*
2237 * ->scheduled list can only be filled while a worker is
2238 * preparing to process a work or actually processing it.
2239 * Make sure nobody diddled with it while I was sleeping.
2240 */
Tejun Heo6183c002013-03-12 11:29:57 -07002241 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002242
Tejun Heoe22bee72010-06-29 10:07:14 +02002243 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002244 * Finish PREP stage. We're guaranteed to have at least one idle
2245 * worker or that someone else has already assumed the manager
2246 * role. This is where @worker starts participating in concurrency
2247 * management if applicable and concurrency management is restored
2248 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002249 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002250 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002251
2252 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002253 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002254 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002255 struct work_struct, entry);
2256
Tejun Heo82607adc2015-12-08 11:28:04 -05002257 pool->watchdog_ts = jiffies;
2258
Tejun Heoc8e55f32010-06-29 10:07:12 +02002259 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2260 /* optimization path, not strictly necessary */
2261 process_one_work(worker, work);
2262 if (unlikely(!list_empty(&worker->scheduled)))
2263 process_scheduled_works(worker);
2264 } else {
2265 move_linked_works(work, &worker->scheduled, NULL);
2266 process_scheduled_works(worker);
2267 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002268 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002269
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002270 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002271sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002272 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002273 * pool->lock is held and there's no work to process and no need to
2274 * manage, sleep. Workers are woken up only while holding
2275 * pool->lock or from local cpu, so setting the current state
2276 * before releasing pool->lock is enough to prevent losing any
2277 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002278 */
2279 worker_enter_idle(worker);
2280 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002281 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002282 schedule();
2283 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284}
2285
Tejun Heoe22bee72010-06-29 10:07:14 +02002286/**
2287 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002288 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002289 *
2290 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002291 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002292 *
Tejun Heo706026c2013-01-24 11:01:34 -08002293 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002294 * worker which uses GFP_KERNEL allocation which has slight chance of
2295 * developing into deadlock if some works currently on the same queue
2296 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2297 * the problem rescuer solves.
2298 *
Tejun Heo706026c2013-01-24 11:01:34 -08002299 * When such condition is possible, the pool summons rescuers of all
2300 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002301 * those works so that forward progress can be guaranteed.
2302 *
2303 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002304 *
2305 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002306 */
Tejun Heo111c2252013-01-17 17:16:24 -08002307static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002308{
Tejun Heo111c2252013-01-17 17:16:24 -08002309 struct worker *rescuer = __rescuer;
2310 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002311 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002312 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002313
2314 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002315
2316 /*
2317 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2318 * doesn't participate in concurrency management.
2319 */
2320 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002321repeat:
2322 set_current_state(TASK_INTERRUPTIBLE);
2323
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002324 /*
2325 * By the time the rescuer is requested to stop, the workqueue
2326 * shouldn't have any work pending, but @wq->maydays may still have
2327 * pwq(s) queued. This can happen by non-rescuer workers consuming
2328 * all the work items before the rescuer got to them. Go through
2329 * @wq->maydays processing before acting on should_stop so that the
2330 * list is always empty on exit.
2331 */
2332 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002333
Tejun Heo493a1722013-03-12 11:29:59 -07002334 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002335 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002336
2337 while (!list_empty(&wq->maydays)) {
2338 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2339 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002340 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002341 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002342 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002343
2344 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002345 list_del_init(&pwq->mayday_node);
2346
Tejun Heo2e109a22013-03-13 19:47:40 -07002347 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002348
Lai Jiangshan51697d392014-05-20 17:46:36 +08002349 worker_attach_to_pool(rescuer, pool);
2350
2351 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002352 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002353
2354 /*
2355 * Slurp in all works issued via this workqueue and
2356 * process'em.
2357 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002358 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002359 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2360 if (get_work_pwq(work) == pwq) {
2361 if (first)
2362 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002363 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002364 }
2365 first = false;
2366 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002367
NeilBrown008847f2014-12-08 12:39:16 -05002368 if (!list_empty(scheduled)) {
2369 process_scheduled_works(rescuer);
2370
2371 /*
2372 * The above execution of rescued work items could
2373 * have created more to rescue through
2374 * pwq_activate_first_delayed() or chained
2375 * queueing. Let's put @pwq back on mayday list so
2376 * that such back-to-back work items, which may be
2377 * being used to relieve memory pressure, don't
2378 * incur MAYDAY_INTERVAL delay inbetween.
2379 */
2380 if (need_to_create_worker(pool)) {
2381 spin_lock(&wq_mayday_lock);
Tejun Heo4f5b0c72019-09-25 06:59:15 -07002382 /*
2383 * Queue iff we aren't racing destruction
2384 * and somebody else hasn't queued it already.
2385 */
2386 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2387 get_pwq(pwq);
2388 list_add_tail(&pwq->mayday_node, &wq->maydays);
2389 }
NeilBrown008847f2014-12-08 12:39:16 -05002390 spin_unlock(&wq_mayday_lock);
2391 }
2392 }
Tejun Heo75769582011-02-14 14:04:46 +01002393
2394 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002395 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002396 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002397 */
2398 put_pwq(pwq);
2399
2400 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002401 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002402 * regular worker; otherwise, we end up with 0 concurrency
2403 * and stalling the execution.
2404 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002405 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002406 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002407
Lai Jiangshanb3104102013-02-19 12:17:02 -08002408 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002409 spin_unlock_irq(&pool->lock);
2410
2411 worker_detach_from_pool(rescuer, pool);
2412
2413 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002414 }
2415
Tejun Heo2e109a22013-03-13 19:47:40 -07002416 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002417
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002418 if (should_stop) {
2419 __set_current_state(TASK_RUNNING);
2420 rescuer->task->flags &= ~PF_WQ_WORKER;
2421 return 0;
2422 }
2423
Tejun Heo111c2252013-01-17 17:16:24 -08002424 /* rescuers should never participate in concurrency management */
2425 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002426 schedule();
2427 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428}
2429
Tejun Heofca839c2015-12-07 10:58:57 -05002430/**
2431 * check_flush_dependency - check for flush dependency sanity
2432 * @target_wq: workqueue being flushed
2433 * @target_work: work item being flushed (NULL for workqueue flushes)
2434 *
2435 * %current is trying to flush the whole @target_wq or @target_work on it.
2436 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2437 * reclaiming memory or running on a workqueue which doesn't have
2438 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2439 * a deadlock.
2440 */
2441static void check_flush_dependency(struct workqueue_struct *target_wq,
2442 struct work_struct *target_work)
2443{
2444 work_func_t target_func = target_work ? target_work->func : NULL;
2445 struct worker *worker;
2446
2447 if (target_wq->flags & WQ_MEM_RECLAIM)
2448 return;
2449
2450 worker = current_wq_worker();
2451
2452 WARN_ONCE(current->flags & PF_MEMALLOC,
2453 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2454 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002455 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2456 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002457 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2458 worker->current_pwq->wq->name, worker->current_func,
2459 target_wq->name, target_func);
2460}
2461
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002462struct wq_barrier {
2463 struct work_struct work;
2464 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002465 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002466};
2467
2468static void wq_barrier_func(struct work_struct *work)
2469{
2470 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2471 complete(&barr->done);
2472}
2473
Tejun Heo4690c4a2010-06-29 10:07:10 +02002474/**
2475 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002476 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002477 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002478 * @target: target work to attach @barr to
2479 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002480 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002481 * @barr is linked to @target such that @barr is completed only after
2482 * @target finishes execution. Please note that the ordering
2483 * guarantee is observed only with respect to @target and on the local
2484 * cpu.
2485 *
2486 * Currently, a queued barrier can't be canceled. This is because
2487 * try_to_grab_pending() can't determine whether the work to be
2488 * grabbed is at the head of the queue and thus can't clear LINKED
2489 * flag of the previous work while there must be a valid next work
2490 * after a work with LINKED flag set.
2491 *
2492 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002493 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002494 *
2495 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002496 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002497 */
Tejun Heo112202d2013-02-13 19:29:12 -08002498static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002499 struct wq_barrier *barr,
2500 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002501{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002502 struct list_head *head;
2503 unsigned int linked = 0;
2504
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002505 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002506 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002507 * as we know for sure that this will not trigger any of the
2508 * checks and call back into the fixup functions where we
2509 * might deadlock.
2510 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002511 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002512 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002513 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002514 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002515
Tejun Heoaffee4b2010-06-29 10:07:12 +02002516 /*
2517 * If @target is currently being executed, schedule the
2518 * barrier to the worker; otherwise, put it after @target.
2519 */
2520 if (worker)
2521 head = worker->scheduled.next;
2522 else {
2523 unsigned long *bits = work_data_bits(target);
2524
2525 head = target->entry.next;
2526 /* there can already be other linked works, inherit and set */
2527 linked = *bits & WORK_STRUCT_LINKED;
2528 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2529 }
2530
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002531 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002532 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002533 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002534}
2535
Tejun Heo73f53c42010-06-29 10:07:11 +02002536/**
Tejun Heo112202d2013-02-13 19:29:12 -08002537 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002538 * @wq: workqueue being flushed
2539 * @flush_color: new flush color, < 0 for no-op
2540 * @work_color: new work color, < 0 for no-op
2541 *
Tejun Heo112202d2013-02-13 19:29:12 -08002542 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002543 *
Tejun Heo112202d2013-02-13 19:29:12 -08002544 * If @flush_color is non-negative, flush_color on all pwqs should be
2545 * -1. If no pwq has in-flight commands at the specified color, all
2546 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2547 * has in flight commands, its pwq->flush_color is set to
2548 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002549 * wakeup logic is armed and %true is returned.
2550 *
2551 * The caller should have initialized @wq->first_flusher prior to
2552 * calling this function with non-negative @flush_color. If
2553 * @flush_color is negative, no flush color update is done and %false
2554 * is returned.
2555 *
Tejun Heo112202d2013-02-13 19:29:12 -08002556 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002557 * work_color which is previous to @work_color and all will be
2558 * advanced to @work_color.
2559 *
2560 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002561 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002562 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002563 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002564 * %true if @flush_color >= 0 and there's something to flush. %false
2565 * otherwise.
2566 */
Tejun Heo112202d2013-02-13 19:29:12 -08002567static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002568 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569{
Tejun Heo73f53c42010-06-29 10:07:11 +02002570 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002571 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002572
Tejun Heo73f53c42010-06-29 10:07:11 +02002573 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002574 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002575 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002576 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002577
Tejun Heo49e3cf42013-03-12 11:29:58 -07002578 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002579 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002580
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002581 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002582
2583 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002584 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002585
Tejun Heo112202d2013-02-13 19:29:12 -08002586 if (pwq->nr_in_flight[flush_color]) {
2587 pwq->flush_color = flush_color;
2588 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002589 wait = true;
2590 }
2591 }
2592
2593 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002594 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002595 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002596 }
2597
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002598 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002599 }
2600
Tejun Heo112202d2013-02-13 19:29:12 -08002601 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002602 complete(&wq->first_flusher->done);
2603
2604 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605}
2606
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002607/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002609 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002611 * This function sleeps until all work items which were queued on entry
2612 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002614void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002615{
Tejun Heo73f53c42010-06-29 10:07:11 +02002616 struct wq_flusher this_flusher = {
2617 .list = LIST_HEAD_INIT(this_flusher.list),
2618 .flush_color = -1,
2619 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2620 };
2621 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002622
Tejun Heo4b5facd2016-09-16 15:49:32 -04002623 if (WARN_ON(!wq_online))
2624 return;
2625
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002626 lock_map_acquire(&wq->lockdep_map);
2627 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002628
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002629 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002630
2631 /*
2632 * Start-to-wait phase
2633 */
2634 next_color = work_next_color(wq->work_color);
2635
2636 if (next_color != wq->flush_color) {
2637 /*
2638 * Color space is not full. The current work_color
2639 * becomes our flush_color and work_color is advanced
2640 * by one.
2641 */
Tejun Heo6183c002013-03-12 11:29:57 -07002642 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002643 this_flusher.flush_color = wq->work_color;
2644 wq->work_color = next_color;
2645
2646 if (!wq->first_flusher) {
2647 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002648 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002649
2650 wq->first_flusher = &this_flusher;
2651
Tejun Heo112202d2013-02-13 19:29:12 -08002652 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002653 wq->work_color)) {
2654 /* nothing to flush, done */
2655 wq->flush_color = next_color;
2656 wq->first_flusher = NULL;
2657 goto out_unlock;
2658 }
2659 } else {
2660 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002661 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002662 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002663 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002664 }
2665 } else {
2666 /*
2667 * Oops, color space is full, wait on overflow queue.
2668 * The next flush completion will assign us
2669 * flush_color and transfer to flusher_queue.
2670 */
2671 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2672 }
2673
Tejun Heofca839c2015-12-07 10:58:57 -05002674 check_flush_dependency(wq, NULL);
2675
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002676 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002677
2678 wait_for_completion(&this_flusher.done);
2679
2680 /*
2681 * Wake-up-and-cascade phase
2682 *
2683 * First flushers are responsible for cascading flushes and
2684 * handling overflow. Non-first flushers can simply return.
2685 */
2686 if (wq->first_flusher != &this_flusher)
2687 return;
2688
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002689 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002690
Tejun Heo4ce48b32010-07-02 10:03:51 +02002691 /* we might have raced, check again with mutex held */
2692 if (wq->first_flusher != &this_flusher)
2693 goto out_unlock;
2694
Tejun Heo73f53c42010-06-29 10:07:11 +02002695 wq->first_flusher = NULL;
2696
Tejun Heo6183c002013-03-12 11:29:57 -07002697 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2698 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002699
2700 while (true) {
2701 struct wq_flusher *next, *tmp;
2702
2703 /* complete all the flushers sharing the current flush color */
2704 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2705 if (next->flush_color != wq->flush_color)
2706 break;
2707 list_del_init(&next->list);
2708 complete(&next->done);
2709 }
2710
Tejun Heo6183c002013-03-12 11:29:57 -07002711 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2712 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002713
2714 /* this flush_color is finished, advance by one */
2715 wq->flush_color = work_next_color(wq->flush_color);
2716
2717 /* one color has been freed, handle overflow queue */
2718 if (!list_empty(&wq->flusher_overflow)) {
2719 /*
2720 * Assign the same color to all overflowed
2721 * flushers, advance work_color and append to
2722 * flusher_queue. This is the start-to-wait
2723 * phase for these overflowed flushers.
2724 */
2725 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2726 tmp->flush_color = wq->work_color;
2727
2728 wq->work_color = work_next_color(wq->work_color);
2729
2730 list_splice_tail_init(&wq->flusher_overflow,
2731 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002732 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002733 }
2734
2735 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002736 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002737 break;
2738 }
2739
2740 /*
2741 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002742 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002743 */
Tejun Heo6183c002013-03-12 11:29:57 -07002744 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2745 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002746
2747 list_del_init(&next->list);
2748 wq->first_flusher = next;
2749
Tejun Heo112202d2013-02-13 19:29:12 -08002750 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002751 break;
2752
2753 /*
2754 * Meh... this color is already done, clear first
2755 * flusher and repeat cascading.
2756 */
2757 wq->first_flusher = NULL;
2758 }
2759
2760out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002761 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002763EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002765/**
2766 * drain_workqueue - drain a workqueue
2767 * @wq: workqueue to drain
2768 *
2769 * Wait until the workqueue becomes empty. While draining is in progress,
2770 * only chain queueing is allowed. IOW, only currently pending or running
2771 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002772 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002773 * by the depth of chaining and should be relatively short. Whine if it
2774 * takes too long.
2775 */
2776void drain_workqueue(struct workqueue_struct *wq)
2777{
2778 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002779 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002780
2781 /*
2782 * __queue_work() needs to test whether there are drainers, is much
2783 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002784 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002785 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002786 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002787 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002788 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002789 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002790reflush:
2791 flush_workqueue(wq);
2792
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002793 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002794
Tejun Heo49e3cf42013-03-12 11:29:58 -07002795 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002796 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002797
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002798 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002799 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002800 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002801
2802 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002803 continue;
2804
2805 if (++flush_cnt == 10 ||
2806 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002807 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002808 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002809
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002810 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002811 goto reflush;
2812 }
2813
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002814 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002815 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002816 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002817}
2818EXPORT_SYMBOL_GPL(drain_workqueue);
2819
Tejun Heo606a5022012-08-20 14:51:23 -07002820static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002821{
2822 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002823 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002824 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002825
2826 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002827
Tejun Heofa1b54e2013-03-12 11:30:00 -07002828 local_irq_disable();
2829 pool = get_work_pool(work);
2830 if (!pool) {
2831 local_irq_enable();
2832 return false;
2833 }
2834
2835 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002836 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002837 pwq = get_work_pwq(work);
2838 if (pwq) {
2839 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002840 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002841 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002842 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002843 if (!worker)
2844 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002845 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002846 }
Tejun Heobaf59022010-09-16 10:42:16 +02002847
Tejun Heofca839c2015-12-07 10:58:57 -05002848 check_flush_dependency(pwq->wq, work);
2849
Tejun Heo112202d2013-02-13 19:29:12 -08002850 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002851 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002852
Tejun Heoe1594892011-01-09 23:32:15 +01002853 /*
2854 * If @max_active is 1 or rescuer is in use, flushing another work
2855 * item on the same workqueue may lead to deadlock. Make sure the
2856 * flusher is not running on the same workqueue by verifying write
2857 * access.
2858 */
Tejun Heo493008a2013-03-12 11:30:03 -07002859 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002860 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002861 else
Tejun Heo112202d2013-02-13 19:29:12 -08002862 lock_map_acquire_read(&pwq->wq->lockdep_map);
2863 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002864
Tejun Heobaf59022010-09-16 10:42:16 +02002865 return true;
2866already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002867 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002868 return false;
2869}
2870
Oleg Nesterovdb700892008-07-25 01:47:49 -07002871/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002872 * flush_work - wait for a work to finish executing the last queueing instance
2873 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002874 *
Tejun Heo606a5022012-08-20 14:51:23 -07002875 * Wait until @work has finished execution. @work is guaranteed to be idle
2876 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002877 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002878 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002879 * %true if flush_work() waited for the work to finish execution,
2880 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002881 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002882bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002883{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002884 struct wq_barrier barr;
2885
Tejun Heo4b5facd2016-09-16 15:49:32 -04002886 if (WARN_ON(!wq_online))
2887 return false;
2888
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002889 lock_map_acquire(&work->lockdep_map);
2890 lock_map_release(&work->lockdep_map);
2891
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002892 if (start_flush_work(work, &barr)) {
2893 wait_for_completion(&barr.done);
2894 destroy_work_on_stack(&barr.work);
2895 return true;
2896 } else {
2897 return false;
2898 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002899}
2900EXPORT_SYMBOL_GPL(flush_work);
2901
Tejun Heo8603e1b32015-03-05 08:04:13 -05002902struct cwt_wait {
2903 wait_queue_t wait;
2904 struct work_struct *work;
2905};
2906
2907static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2908{
2909 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2910
2911 if (cwait->work != key)
2912 return 0;
2913 return autoremove_wake_function(wait, mode, sync, key);
2914}
2915
Tejun Heo36e227d2012-08-03 10:30:46 -07002916static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002917{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002918 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002919 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002920 int ret;
2921
2922 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002923 ret = try_to_grab_pending(work, is_dwork, &flags);
2924 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002925 * If someone else is already canceling, wait for it to
2926 * finish. flush_work() doesn't work for PREEMPT_NONE
2927 * because we may get scheduled between @work's completion
2928 * and the other canceling task resuming and clearing
2929 * CANCELING - flush_work() will return false immediately
2930 * as @work is no longer busy, try_to_grab_pending() will
2931 * return -ENOENT as @work is still being canceled and the
2932 * other canceling task won't be able to clear CANCELING as
2933 * we're hogging the CPU.
2934 *
2935 * Let's wait for completion using a waitqueue. As this
2936 * may lead to the thundering herd problem, use a custom
2937 * wake function which matches @work along with exclusive
2938 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002939 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002940 if (unlikely(ret == -ENOENT)) {
2941 struct cwt_wait cwait;
2942
2943 init_wait(&cwait.wait);
2944 cwait.wait.func = cwt_wakefn;
2945 cwait.work = work;
2946
2947 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2948 TASK_UNINTERRUPTIBLE);
2949 if (work_is_canceling(work))
2950 schedule();
2951 finish_wait(&cancel_waitq, &cwait.wait);
2952 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002953 } while (unlikely(ret < 0));
2954
Tejun Heobbb68df2012-08-03 10:30:46 -07002955 /* tell other tasks trying to grab @work to back off */
2956 mark_work_canceling(work);
2957 local_irq_restore(flags);
2958
Tejun Heo4b5facd2016-09-16 15:49:32 -04002959 /*
2960 * This allows canceling during early boot. We know that @work
2961 * isn't executing.
2962 */
2963 if (wq_online)
2964 flush_work(work);
2965
Tejun Heo7a22ad72010-06-29 10:07:13 +02002966 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002967
2968 /*
2969 * Paired with prepare_to_wait() above so that either
2970 * waitqueue_active() is visible here or !work_is_canceling() is
2971 * visible there.
2972 */
2973 smp_mb();
2974 if (waitqueue_active(&cancel_waitq))
2975 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2976
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002977 return ret;
2978}
2979
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002980/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002981 * cancel_work_sync - cancel a work and wait for it to finish
2982 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002983 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002984 * Cancel @work and wait for its execution to finish. This function
2985 * can be used even if the work re-queues itself or migrates to
2986 * another workqueue. On return from this function, @work is
2987 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002988 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002989 * cancel_work_sync(&delayed_work->work) must not be used for
2990 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002991 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002992 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002993 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002994 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002995 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002996 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002997 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002998bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002999{
Tejun Heo36e227d2012-08-03 10:30:46 -07003000 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003001}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003002EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003003
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003004/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003005 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3006 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003007 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003008 * Delayed timer is cancelled and the pending work is queued for
3009 * immediate execution. Like flush_work(), this function only
3010 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003011 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003012 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003013 * %true if flush_work() waited for the work to finish execution,
3014 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003015 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003016bool flush_delayed_work(struct delayed_work *dwork)
3017{
Tejun Heo8930cab2012-08-03 10:30:45 -07003018 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003019 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003020 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003021 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003022 return flush_work(&dwork->work);
3023}
3024EXPORT_SYMBOL(flush_delayed_work);
3025
Jens Axboef72b8792016-08-24 15:51:50 -06003026static bool __cancel_work(struct work_struct *work, bool is_dwork)
3027{
3028 unsigned long flags;
3029 int ret;
3030
3031 do {
3032 ret = try_to_grab_pending(work, is_dwork, &flags);
3033 } while (unlikely(ret == -EAGAIN));
3034
3035 if (unlikely(ret < 0))
3036 return false;
3037
3038 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3039 local_irq_restore(flags);
3040 return ret;
3041}
3042
3043/*
3044 * See cancel_delayed_work()
3045 */
3046bool cancel_work(struct work_struct *work)
3047{
3048 return __cancel_work(work, false);
3049}
3050
Tejun Heo401a8d02010-09-16 10:36:00 +02003051/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003052 * cancel_delayed_work - cancel a delayed work
3053 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003054 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003055 * Kill off a pending delayed_work.
3056 *
3057 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3058 * pending.
3059 *
3060 * Note:
3061 * The work callback function may still be running on return, unless
3062 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3063 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003064 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003065 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003066 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003067bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003068{
Jens Axboef72b8792016-08-24 15:51:50 -06003069 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003070}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003071EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003072
3073/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003074 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3075 * @dwork: the delayed work cancel
3076 *
3077 * This is cancel_work_sync() for delayed works.
3078 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003079 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003080 * %true if @dwork was pending, %false otherwise.
3081 */
3082bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003083{
Tejun Heo36e227d2012-08-03 10:30:46 -07003084 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003085}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003086EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003087
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003088/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003089 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003090 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003091 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003092 * schedule_on_each_cpu() executes @func on each online CPU using the
3093 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003094 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003095 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003096 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003097 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003098 */
David Howells65f27f32006-11-22 14:55:48 +00003099int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003100{
3101 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003102 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003103
Andrew Mortonb6136772006-06-25 05:47:49 -07003104 works = alloc_percpu(struct work_struct);
3105 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003106 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003107
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003108 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003109
Christoph Lameter15316ba2006-01-08 01:00:43 -08003110 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003111 struct work_struct *work = per_cpu_ptr(works, cpu);
3112
3113 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003114 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003115 }
Tejun Heo93981802009-11-17 14:06:20 -08003116
3117 for_each_online_cpu(cpu)
3118 flush_work(per_cpu_ptr(works, cpu));
3119
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003120 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003121 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003122 return 0;
3123}
3124
Alan Sterneef6a7d2010-02-12 17:39:21 +09003125/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003126 * execute_in_process_context - reliably execute the routine with user context
3127 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003128 * @ew: guaranteed storage for the execute work structure (must
3129 * be available when the work executes)
3130 *
3131 * Executes the function immediately if process context is available,
3132 * otherwise schedules the function for delayed execution.
3133 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003134 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003135 * 1 - function was scheduled for execution
3136 */
David Howells65f27f32006-11-22 14:55:48 +00003137int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003138{
3139 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003140 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003141 return 0;
3142 }
3143
David Howells65f27f32006-11-22 14:55:48 +00003144 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003145 schedule_work(&ew->work);
3146
3147 return 1;
3148}
3149EXPORT_SYMBOL_GPL(execute_in_process_context);
3150
Tejun Heo7a4e3442013-03-12 11:30:00 -07003151/**
3152 * free_workqueue_attrs - free a workqueue_attrs
3153 * @attrs: workqueue_attrs to free
3154 *
3155 * Undo alloc_workqueue_attrs().
3156 */
3157void free_workqueue_attrs(struct workqueue_attrs *attrs)
3158{
3159 if (attrs) {
3160 free_cpumask_var(attrs->cpumask);
3161 kfree(attrs);
3162 }
3163}
3164
3165/**
3166 * alloc_workqueue_attrs - allocate a workqueue_attrs
3167 * @gfp_mask: allocation mask to use
3168 *
3169 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003170 * return it.
3171 *
3172 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003173 */
3174struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3175{
3176 struct workqueue_attrs *attrs;
3177
3178 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3179 if (!attrs)
3180 goto fail;
3181 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3182 goto fail;
3183
Tejun Heo13e2e552013-04-01 11:23:31 -07003184 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003185 return attrs;
3186fail:
3187 free_workqueue_attrs(attrs);
3188 return NULL;
3189}
3190
Tejun Heo29c91e92013-03-12 11:30:03 -07003191static void copy_workqueue_attrs(struct workqueue_attrs *to,
3192 const struct workqueue_attrs *from)
3193{
3194 to->nice = from->nice;
3195 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003196 /*
3197 * Unlike hash and equality test, this function doesn't ignore
3198 * ->no_numa as it is used for both pool and wq attrs. Instead,
3199 * get_unbound_pool() explicitly clears ->no_numa after copying.
3200 */
3201 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003202}
3203
Tejun Heo29c91e92013-03-12 11:30:03 -07003204/* hash value of the content of @attr */
3205static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3206{
3207 u32 hash = 0;
3208
3209 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003210 hash = jhash(cpumask_bits(attrs->cpumask),
3211 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003212 return hash;
3213}
3214
3215/* content equality test */
3216static bool wqattrs_equal(const struct workqueue_attrs *a,
3217 const struct workqueue_attrs *b)
3218{
3219 if (a->nice != b->nice)
3220 return false;
3221 if (!cpumask_equal(a->cpumask, b->cpumask))
3222 return false;
3223 return true;
3224}
3225
Tejun Heo7a4e3442013-03-12 11:30:00 -07003226/**
3227 * init_worker_pool - initialize a newly zalloc'd worker_pool
3228 * @pool: worker_pool to initialize
3229 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303230 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003231 *
3232 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003233 * inside @pool proper are initialized and put_unbound_pool() can be called
3234 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003235 */
3236static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003237{
3238 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003239 pool->id = -1;
3240 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003241 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003242 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003243 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003244 INIT_LIST_HEAD(&pool->worklist);
3245 INIT_LIST_HEAD(&pool->idle_list);
3246 hash_init(pool->busy_hash);
3247
3248 init_timer_deferrable(&pool->idle_timer);
3249 pool->idle_timer.function = idle_worker_timeout;
3250 pool->idle_timer.data = (unsigned long)pool;
3251
3252 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3253 (unsigned long)pool);
3254
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003255 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003256 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003257
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003258 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003259 INIT_HLIST_NODE(&pool->hash_node);
3260 pool->refcnt = 1;
3261
3262 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003263 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3264 if (!pool->attrs)
3265 return -ENOMEM;
3266 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003267}
3268
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003269static void rcu_free_wq(struct rcu_head *rcu)
3270{
3271 struct workqueue_struct *wq =
3272 container_of(rcu, struct workqueue_struct, rcu);
3273
3274 if (!(wq->flags & WQ_UNBOUND))
3275 free_percpu(wq->cpu_pwqs);
3276 else
3277 free_workqueue_attrs(wq->unbound_attrs);
3278
3279 kfree(wq->rescuer);
3280 kfree(wq);
3281}
3282
Tejun Heo29c91e92013-03-12 11:30:03 -07003283static void rcu_free_pool(struct rcu_head *rcu)
3284{
3285 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3286
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003287 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003288 free_workqueue_attrs(pool->attrs);
3289 kfree(pool);
3290}
3291
3292/**
3293 * put_unbound_pool - put a worker_pool
3294 * @pool: worker_pool to put
3295 *
3296 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003297 * safe manner. get_unbound_pool() calls this function on its failure path
3298 * and this function should be able to release pools which went through,
3299 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003300 *
3301 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003302 */
3303static void put_unbound_pool(struct worker_pool *pool)
3304{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003305 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003306 struct worker *worker;
3307
Tejun Heoa892cac2013-04-01 11:23:32 -07003308 lockdep_assert_held(&wq_pool_mutex);
3309
3310 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003311 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003312
3313 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003314 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003315 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003316 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003317
3318 /* release id and unhash */
3319 if (pool->id >= 0)
3320 idr_remove(&worker_pool_idr, pool->id);
3321 hash_del(&pool->hash_node);
3322
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003323 /*
Tejun Heo43a980a2017-10-09 08:04:13 -07003324 * Become the manager and destroy all workers. This prevents
3325 * @pool's workers from blocking on attach_mutex. We're the last
3326 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003327 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003328 spin_lock_irq(&pool->lock);
Tejun Heo43a980a2017-10-09 08:04:13 -07003329 wait_event_lock_irq(wq_manager_wait,
3330 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3331 pool->flags |= POOL_MANAGER_ACTIVE;
3332
Lai Jiangshan1037de32014-05-22 16:44:07 +08003333 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003334 destroy_worker(worker);
3335 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003336 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003337
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003338 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003339 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003340 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003341 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003342
3343 if (pool->detach_completion)
3344 wait_for_completion(pool->detach_completion);
3345
Tejun Heo29c91e92013-03-12 11:30:03 -07003346 /* shut down the timers */
3347 del_timer_sync(&pool->idle_timer);
3348 del_timer_sync(&pool->mayday_timer);
3349
3350 /* sched-RCU protected to allow dereferences from get_work_pool() */
3351 call_rcu_sched(&pool->rcu, rcu_free_pool);
3352}
3353
3354/**
3355 * get_unbound_pool - get a worker_pool with the specified attributes
3356 * @attrs: the attributes of the worker_pool to get
3357 *
3358 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3359 * reference count and return it. If there already is a matching
3360 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003361 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003362 *
3363 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003364 *
3365 * Return: On success, a worker_pool with the same attributes as @attrs.
3366 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003367 */
3368static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3369{
Tejun Heo29c91e92013-03-12 11:30:03 -07003370 u32 hash = wqattrs_hash(attrs);
3371 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003372 int node;
Xunlei Pange2273582015-10-09 11:53:12 +08003373 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003374
Tejun Heoa892cac2013-04-01 11:23:32 -07003375 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003376
3377 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003378 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3379 if (wqattrs_equal(pool->attrs, attrs)) {
3380 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003381 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003382 }
3383 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003384
Xunlei Pange2273582015-10-09 11:53:12 +08003385 /* if cpumask is contained inside a NUMA node, we belong to that node */
3386 if (wq_numa_enabled) {
3387 for_each_node(node) {
3388 if (cpumask_subset(attrs->cpumask,
3389 wq_numa_possible_cpumask[node])) {
3390 target_node = node;
3391 break;
3392 }
3393 }
3394 }
3395
Tejun Heo29c91e92013-03-12 11:30:03 -07003396 /* nope, create a new one */
Xunlei Pange2273582015-10-09 11:53:12 +08003397 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003398 if (!pool || init_worker_pool(pool) < 0)
3399 goto fail;
3400
Tejun Heo8864b4e2013-03-12 11:30:04 -07003401 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003402 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange2273582015-10-09 11:53:12 +08003403 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003404
Shaohua Li2865a8f2013-08-01 09:56:36 +08003405 /*
3406 * no_numa isn't a worker_pool attribute, always clear it. See
3407 * 'struct workqueue_attrs' comments for detail.
3408 */
3409 pool->attrs->no_numa = false;
3410
Tejun Heo29c91e92013-03-12 11:30:03 -07003411 if (worker_pool_assign_id(pool) < 0)
3412 goto fail;
3413
3414 /* create and start the initial worker */
Tejun Heo4b5facd2016-09-16 15:49:32 -04003415 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003416 goto fail;
3417
Tejun Heo29c91e92013-03-12 11:30:03 -07003418 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003419 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003420
Tejun Heo29c91e92013-03-12 11:30:03 -07003421 return pool;
3422fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003423 if (pool)
3424 put_unbound_pool(pool);
3425 return NULL;
3426}
3427
Tejun Heo8864b4e2013-03-12 11:30:04 -07003428static void rcu_free_pwq(struct rcu_head *rcu)
3429{
3430 kmem_cache_free(pwq_cache,
3431 container_of(rcu, struct pool_workqueue, rcu));
3432}
3433
3434/*
3435 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3436 * and needs to be destroyed.
3437 */
3438static void pwq_unbound_release_workfn(struct work_struct *work)
3439{
3440 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3441 unbound_release_work);
3442 struct workqueue_struct *wq = pwq->wq;
3443 struct worker_pool *pool = pwq->pool;
Yang Yingliang1f63eec2021-07-14 17:19:33 +08003444 bool is_last = false;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003445
Yang Yingliang1f63eec2021-07-14 17:19:33 +08003446 /*
3447 * when @pwq is not linked, it doesn't hold any reference to the
3448 * @wq, and @wq is invalid to access.
3449 */
3450 if (!list_empty(&pwq->pwqs_node)) {
3451 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3452 return;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003453
Yang Yingliang1f63eec2021-07-14 17:19:33 +08003454 mutex_lock(&wq->mutex);
3455 list_del_rcu(&pwq->pwqs_node);
3456 is_last = list_empty(&wq->pwqs);
3457 mutex_unlock(&wq->mutex);
3458 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003459
Tejun Heoa892cac2013-04-01 11:23:32 -07003460 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003461 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003462 mutex_unlock(&wq_pool_mutex);
3463
Tejun Heo8864b4e2013-03-12 11:30:04 -07003464 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3465
3466 /*
3467 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003468 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003469 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003470 if (is_last)
3471 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003472}
3473
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003474/**
Tejun Heo699ce092013-03-13 16:51:35 -07003475 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003476 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003477 *
Tejun Heo699ce092013-03-13 16:51:35 -07003478 * If @pwq isn't freezing, set @pwq->max_active to the associated
3479 * workqueue's saved_max_active and activate delayed work items
3480 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003481 */
Tejun Heo699ce092013-03-13 16:51:35 -07003482static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003483{
Tejun Heo699ce092013-03-13 16:51:35 -07003484 struct workqueue_struct *wq = pwq->wq;
3485 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo4b5facd2016-09-16 15:49:32 -04003486 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003487
Tejun Heo699ce092013-03-13 16:51:35 -07003488 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003489 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003490
3491 /* fast exit for non-freezable wqs */
3492 if (!freezable && pwq->max_active == wq->saved_max_active)
3493 return;
3494
Tejun Heo4b5facd2016-09-16 15:49:32 -04003495 /* this function can be called during early boot w/ irq disabled */
3496 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003497
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003498 /*
3499 * During [un]freezing, the caller is responsible for ensuring that
3500 * this function is called at least once after @workqueue_freezing
3501 * is updated and visible.
3502 */
3503 if (!freezable || !workqueue_freezing) {
Yunfeng Yefe458772020-11-19 14:21:25 +08003504 bool kick = false;
3505
Tejun Heo699ce092013-03-13 16:51:35 -07003506 pwq->max_active = wq->saved_max_active;
3507
3508 while (!list_empty(&pwq->delayed_works) &&
Yunfeng Yefe458772020-11-19 14:21:25 +08003509 pwq->nr_active < pwq->max_active) {
Tejun Heo699ce092013-03-13 16:51:35 -07003510 pwq_activate_first_delayed(pwq);
Yunfeng Yefe458772020-11-19 14:21:25 +08003511 kick = true;
3512 }
Lai Jiangshan951a0782013-03-20 10:52:30 -07003513
3514 /*
3515 * Need to kick a worker after thawed or an unbound wq's
Yunfeng Yefe458772020-11-19 14:21:25 +08003516 * max_active is bumped. In realtime scenarios, always kicking a
3517 * worker will cause interference on the isolated cpu cores, so
3518 * let's kick iff work items were activated.
Lai Jiangshan951a0782013-03-20 10:52:30 -07003519 */
Yunfeng Yefe458772020-11-19 14:21:25 +08003520 if (kick)
3521 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003522 } else {
3523 pwq->max_active = 0;
3524 }
3525
Tejun Heo4b5facd2016-09-16 15:49:32 -04003526 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003527}
3528
Tejun Heoe50aba92013-04-01 11:23:35 -07003529/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003530static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3531 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003532{
3533 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3534
Tejun Heoe50aba92013-04-01 11:23:35 -07003535 memset(pwq, 0, sizeof(*pwq));
3536
Tejun Heod2c1d402013-03-12 11:30:04 -07003537 pwq->pool = pool;
3538 pwq->wq = wq;
3539 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003540 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003541 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003542 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003543 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003544 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003545}
Tejun Heod2c1d402013-03-12 11:30:04 -07003546
Tejun Heof147f292013-04-01 11:23:35 -07003547/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003548static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003549{
3550 struct workqueue_struct *wq = pwq->wq;
3551
3552 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003553
Tejun Heo1befcf32013-04-01 11:23:35 -07003554 /* may be called multiple times, ignore if already linked */
3555 if (!list_empty(&pwq->pwqs_node))
3556 return;
3557
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003558 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003559 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003560
3561 /* sync max_active to the current setting */
3562 pwq_adjust_max_active(pwq);
3563
3564 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003565 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003566}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003567
Tejun Heof147f292013-04-01 11:23:35 -07003568/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3569static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3570 const struct workqueue_attrs *attrs)
3571{
3572 struct worker_pool *pool;
3573 struct pool_workqueue *pwq;
3574
3575 lockdep_assert_held(&wq_pool_mutex);
3576
3577 pool = get_unbound_pool(attrs);
3578 if (!pool)
3579 return NULL;
3580
Tejun Heoe50aba92013-04-01 11:23:35 -07003581 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003582 if (!pwq) {
3583 put_unbound_pool(pool);
3584 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003585 }
Tejun Heo6029a912013-04-01 11:23:34 -07003586
Tejun Heof147f292013-04-01 11:23:35 -07003587 init_pwq(pwq, wq, pool);
3588 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003589}
3590
Tejun Heo4c16bd32013-04-01 11:23:36 -07003591/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003592 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003593 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003594 * @node: the target NUMA node
3595 * @cpu_going_down: if >= 0, the CPU to consider as offline
3596 * @cpumask: outarg, the resulting cpumask
3597 *
3598 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3599 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003600 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003601 *
3602 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3603 * enabled and @node has online CPUs requested by @attrs, the returned
3604 * cpumask is the intersection of the possible CPUs of @node and
3605 * @attrs->cpumask.
3606 *
3607 * The caller is responsible for ensuring that the cpumask of @node stays
3608 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003609 *
3610 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3611 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003612 */
3613static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3614 int cpu_going_down, cpumask_t *cpumask)
3615{
Tejun Heod55262c2013-04-01 11:23:38 -07003616 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003617 goto use_dfl;
3618
3619 /* does @node have any online CPUs @attrs wants? */
3620 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3621 if (cpu_going_down >= 0)
3622 cpumask_clear_cpu(cpu_going_down, cpumask);
3623
3624 if (cpumask_empty(cpumask))
3625 goto use_dfl;
3626
3627 /* yeap, return possible CPUs in @node that @attrs wants */
3628 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3629 return !cpumask_equal(cpumask, attrs->cpumask);
3630
3631use_dfl:
3632 cpumask_copy(cpumask, attrs->cpumask);
3633 return false;
3634}
3635
Tejun Heo1befcf32013-04-01 11:23:35 -07003636/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3637static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3638 int node,
3639 struct pool_workqueue *pwq)
3640{
3641 struct pool_workqueue *old_pwq;
3642
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003643 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003644 lockdep_assert_held(&wq->mutex);
3645
3646 /* link_pwq() can handle duplicate calls */
3647 link_pwq(pwq);
3648
3649 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3650 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3651 return old_pwq;
3652}
3653
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003654/* context to store the prepared attrs & pwqs before applying */
3655struct apply_wqattrs_ctx {
3656 struct workqueue_struct *wq; /* target workqueue */
3657 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003658 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003659 struct pool_workqueue *dfl_pwq;
3660 struct pool_workqueue *pwq_tbl[];
3661};
3662
3663/* free the resources after success or abort */
3664static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3665{
3666 if (ctx) {
3667 int node;
3668
3669 for_each_node(node)
3670 put_pwq_unlocked(ctx->pwq_tbl[node]);
3671 put_pwq_unlocked(ctx->dfl_pwq);
3672
3673 free_workqueue_attrs(ctx->attrs);
3674
3675 kfree(ctx);
3676 }
3677}
3678
3679/* allocate the attrs and pwqs for later installation */
3680static struct apply_wqattrs_ctx *
3681apply_wqattrs_prepare(struct workqueue_struct *wq,
3682 const struct workqueue_attrs *attrs)
3683{
3684 struct apply_wqattrs_ctx *ctx;
3685 struct workqueue_attrs *new_attrs, *tmp_attrs;
3686 int node;
3687
3688 lockdep_assert_held(&wq_pool_mutex);
3689
3690 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3691 GFP_KERNEL);
3692
3693 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3694 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3695 if (!ctx || !new_attrs || !tmp_attrs)
3696 goto out_free;
3697
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003698 /*
3699 * Calculate the attrs of the default pwq.
3700 * If the user configured cpumask doesn't overlap with the
3701 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3702 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003703 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003704 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003705 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3706 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003707
3708 /*
3709 * We may create multiple pwqs with differing cpumasks. Make a
3710 * copy of @new_attrs which will be modified and used to obtain
3711 * pools.
3712 */
3713 copy_workqueue_attrs(tmp_attrs, new_attrs);
3714
3715 /*
3716 * If something goes wrong during CPU up/down, we'll fall back to
3717 * the default pwq covering whole @attrs->cpumask. Always create
3718 * it even if we don't use it immediately.
3719 */
3720 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3721 if (!ctx->dfl_pwq)
3722 goto out_free;
3723
3724 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003725 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003726 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3727 if (!ctx->pwq_tbl[node])
3728 goto out_free;
3729 } else {
3730 ctx->dfl_pwq->refcnt++;
3731 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3732 }
3733 }
3734
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003735 /* save the user configured attrs and sanitize it. */
3736 copy_workqueue_attrs(new_attrs, attrs);
3737 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003738 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003739
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003740 ctx->wq = wq;
3741 free_workqueue_attrs(tmp_attrs);
3742 return ctx;
3743
3744out_free:
3745 free_workqueue_attrs(tmp_attrs);
3746 free_workqueue_attrs(new_attrs);
3747 apply_wqattrs_cleanup(ctx);
3748 return NULL;
3749}
3750
3751/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3752static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3753{
3754 int node;
3755
3756 /* all pwqs have been created successfully, let's install'em */
3757 mutex_lock(&ctx->wq->mutex);
3758
3759 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3760
3761 /* save the previous pwq and install the new one */
3762 for_each_node(node)
3763 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3764 ctx->pwq_tbl[node]);
3765
3766 /* @dfl_pwq might not have been used, ensure it's linked */
3767 link_pwq(ctx->dfl_pwq);
3768 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3769
3770 mutex_unlock(&ctx->wq->mutex);
3771}
3772
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003773static void apply_wqattrs_lock(void)
3774{
3775 /* CPUs should stay stable across pwq creations and installations */
3776 get_online_cpus();
3777 mutex_lock(&wq_pool_mutex);
3778}
3779
3780static void apply_wqattrs_unlock(void)
3781{
3782 mutex_unlock(&wq_pool_mutex);
3783 put_online_cpus();
3784}
3785
3786static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3787 const struct workqueue_attrs *attrs)
3788{
3789 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003790
3791 /* only unbound workqueues can change attributes */
3792 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3793 return -EINVAL;
3794
3795 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heof9636c92017-07-23 08:36:15 -04003796 if (!list_empty(&wq->pwqs)) {
3797 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3798 return -EINVAL;
3799
3800 wq->flags &= ~__WQ_ORDERED;
3801 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003802
3803 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003804 if (!ctx)
3805 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003806
3807 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003808 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003809 apply_wqattrs_cleanup(ctx);
3810
wanghaibin62011712016-01-07 20:38:59 +08003811 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003812}
3813
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003814/**
3815 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3816 * @wq: the target workqueue
3817 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3818 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003819 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3820 * machines, this function maps a separate pwq to each NUMA node with
3821 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3822 * NUMA node it was issued on. Older pwqs are released as in-flight work
3823 * items finish. Note that a work item which repeatedly requeues itself
3824 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003825 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003826 * Performs GFP_KERNEL allocations.
3827 *
3828 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003829 */
3830int apply_workqueue_attrs(struct workqueue_struct *wq,
3831 const struct workqueue_attrs *attrs)
3832{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003833 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003834
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003835 apply_wqattrs_lock();
3836 ret = apply_workqueue_attrs_locked(wq, attrs);
3837 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003838
Tejun Heo48621252013-04-01 11:23:31 -07003839 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003840}
3841
Tejun Heo4c16bd32013-04-01 11:23:36 -07003842/**
3843 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3844 * @wq: the target workqueue
3845 * @cpu: the CPU coming up or going down
3846 * @online: whether @cpu is coming up or going down
3847 *
3848 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3849 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3850 * @wq accordingly.
3851 *
3852 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3853 * falls back to @wq->dfl_pwq which may not be optimal but is always
3854 * correct.
3855 *
3856 * Note that when the last allowed CPU of a NUMA node goes offline for a
3857 * workqueue with a cpumask spanning multiple nodes, the workers which were
3858 * already executing the work items for the workqueue will lose their CPU
3859 * affinity and may execute on any CPU. This is similar to how per-cpu
3860 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3861 * affinity, it's the user's responsibility to flush the work item from
3862 * CPU_DOWN_PREPARE.
3863 */
3864static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3865 bool online)
3866{
3867 int node = cpu_to_node(cpu);
3868 int cpu_off = online ? -1 : cpu;
3869 struct pool_workqueue *old_pwq = NULL, *pwq;
3870 struct workqueue_attrs *target_attrs;
3871 cpumask_t *cpumask;
3872
3873 lockdep_assert_held(&wq_pool_mutex);
3874
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003875 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3876 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003877 return;
3878
3879 /*
3880 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3881 * Let's use a preallocated one. The following buf is protected by
3882 * CPU hotplug exclusion.
3883 */
3884 target_attrs = wq_update_unbound_numa_attrs_buf;
3885 cpumask = target_attrs->cpumask;
3886
Tejun Heo4c16bd32013-04-01 11:23:36 -07003887 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3888 pwq = unbound_pwq_by_node(wq, node);
3889
3890 /*
3891 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003892 * different from the default pwq's, we need to compare it to @pwq's
3893 * and create a new one if they don't match. If the target cpumask
3894 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003895 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003896 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003897 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003898 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003899 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003900 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003901 }
3902
Tejun Heo4c16bd32013-04-01 11:23:36 -07003903 /* create a new pwq */
3904 pwq = alloc_unbound_pwq(wq, target_attrs);
3905 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003906 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3907 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003908 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003909 }
3910
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003911 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003912 mutex_lock(&wq->mutex);
3913 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3914 goto out_unlock;
3915
3916use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003917 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003918 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3919 get_pwq(wq->dfl_pwq);
3920 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3921 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3922out_unlock:
3923 mutex_unlock(&wq->mutex);
3924 put_pwq_unlocked(old_pwq);
3925}
3926
Tejun Heo30cdf242013-03-12 11:29:57 -07003927static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003928{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003929 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003930 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003931
Tejun Heo30cdf242013-03-12 11:29:57 -07003932 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003933 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3934 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003935 return -ENOMEM;
3936
3937 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003938 struct pool_workqueue *pwq =
3939 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003940 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003941 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003942
Tejun Heof147f292013-04-01 11:23:35 -07003943 init_pwq(pwq, wq, &cpu_pools[highpri]);
3944
3945 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003946 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003947 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003948 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003949 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003950 } else if (wq->flags & __WQ_ORDERED) {
3951 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3952 /* there should only be single pwq for ordering guarantee */
3953 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3954 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3955 "ordering guarantee broken for workqueue %s\n", wq->name);
3956 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003957 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003958 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003959 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003960}
3961
Tejun Heof3421792010-07-02 10:03:51 +02003962static int wq_clamp_max_active(int max_active, unsigned int flags,
3963 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003964{
Tejun Heof3421792010-07-02 10:03:51 +02003965 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3966
3967 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003968 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3969 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003970
Tejun Heof3421792010-07-02 10:03:51 +02003971 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003972}
3973
Tejun Heob196be82012-01-10 15:11:35 -08003974struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003975 unsigned int flags,
3976 int max_active,
3977 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003978 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003979{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003980 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003981 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003982 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003983 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003984
Tejun Heo61a0adb2017-07-18 18:41:52 -04003985 /*
3986 * Unbound && max_active == 1 used to imply ordered, which is no
3987 * longer the case on NUMA machines due to per-node pools. While
3988 * alloc_ordered_workqueue() is the right way to create an ordered
3989 * workqueue, keep the previous behavior to avoid subtle breakages
3990 * on NUMA.
3991 */
3992 if ((flags & WQ_UNBOUND) && max_active == 1)
3993 flags |= __WQ_ORDERED;
3994
Viresh Kumarcee22a12013-04-08 16:45:40 +05303995 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3996 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3997 flags |= WQ_UNBOUND;
3998
Tejun Heoecf68812013-04-01 11:23:34 -07003999 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004000 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004001 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004002
4003 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004004 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004005 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004006
Tejun Heo6029a912013-04-01 11:23:34 -07004007 if (flags & WQ_UNBOUND) {
4008 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4009 if (!wq->unbound_attrs)
4010 goto err_free_wq;
4011 }
4012
Tejun Heoecf68812013-04-01 11:23:34 -07004013 va_start(args, lock_name);
4014 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004015 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004016
Tejun Heod320c032010-06-29 10:07:14 +02004017 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004018 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004019
Tejun Heob196be82012-01-10 15:11:35 -08004020 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004021 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004022 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004023 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004024 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07004025 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004026 INIT_LIST_HEAD(&wq->flusher_queue);
4027 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004028 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004029
Johannes Bergeb13ba82008-01-16 09:51:58 +01004030 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004031 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004032
Tejun Heo30cdf242013-03-12 11:29:57 -07004033 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004034 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004035
Tejun Heo493008a2013-03-12 11:30:03 -07004036 /*
4037 * Workqueues which may be used during memory reclaim should
4038 * have a rescuer to guarantee forward progress.
4039 */
4040 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004041 struct worker *rescuer;
4042
Lai Jiangshanf7537df2014-07-15 17:24:15 +08004043 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02004044 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004045 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004046
Tejun Heo111c2252013-01-17 17:16:24 -08004047 rescuer->rescue_wq = wq;
4048 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004049 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004050 if (IS_ERR(rescuer->task)) {
4051 kfree(rescuer);
4052 goto err_destroy;
4053 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004054
Tejun Heod2c1d402013-03-12 11:30:04 -07004055 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02004056 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02004057 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004058 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004059
Tejun Heo226223a2013-03-12 11:30:05 -07004060 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4061 goto err_destroy;
4062
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004063 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004064 * wq_pool_mutex protects global freeze state and workqueues list.
4065 * Grab it, adjust max_active and add the new @wq to workqueues
4066 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004067 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004068 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004069
Lai Jiangshana357fc02013-03-25 16:57:19 -07004070 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004071 for_each_pwq(pwq, wq)
4072 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004073 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004074
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004075 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004076
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004077 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004078
Oleg Nesterov3af244332007-05-09 02:34:09 -07004079 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004080
4081err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004082 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004083 kfree(wq);
4084 return NULL;
4085err_destroy:
4086 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004087 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004088}
Tejun Heod320c032010-06-29 10:07:14 +02004089EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004090
4091/**
4092 * destroy_workqueue - safely terminate a workqueue
4093 * @wq: target workqueue
4094 *
4095 * Safely destroy a workqueue. All work currently pending will be done first.
4096 */
4097void destroy_workqueue(struct workqueue_struct *wq)
4098{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004099 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004100 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004101
Tejun Heo54f859a2019-09-18 18:43:40 -07004102 /*
4103 * Remove it from sysfs first so that sanity check failure doesn't
4104 * lead to sysfs name conflicts.
4105 */
4106 workqueue_sysfs_unregister(wq);
4107
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004108 /* drain it before proceeding with destruction */
4109 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004110
Tejun Heo54f859a2019-09-18 18:43:40 -07004111 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4112 if (wq->rescuer) {
4113 struct worker *rescuer = wq->rescuer;
4114
4115 /* this prevents new queueing */
4116 spin_lock_irq(&wq_mayday_lock);
4117 wq->rescuer = NULL;
4118 spin_unlock_irq(&wq_mayday_lock);
4119
4120 /* rescuer will empty maydays list before exiting */
4121 kthread_stop(rescuer->task);
Tejun Heo1a1e9ff2019-09-20 13:39:57 -07004122 kfree(rescuer);
Tejun Heo54f859a2019-09-18 18:43:40 -07004123 }
4124
Tejun Heo6183c002013-03-12 11:29:57 -07004125 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004126 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004127 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004128 int i;
4129
Tejun Heo76af4d92013-03-12 11:30:00 -07004130 for (i = 0; i < WORK_NR_COLORS; i++) {
4131 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004132 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004133 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004134 }
4135 }
4136
Lai Jiangshan5c529592013-04-04 10:05:38 +08004137 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004138 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004139 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004140 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004141 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004142 }
Tejun Heo6183c002013-03-12 11:29:57 -07004143 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004144 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004145
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004146 /*
4147 * wq list is used to freeze wq, remove from list after
4148 * flushing is complete in case freeze races us.
4149 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004150 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004151 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004152 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004153
Tejun Heo8864b4e2013-03-12 11:30:04 -07004154 if (!(wq->flags & WQ_UNBOUND)) {
4155 /*
4156 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004157 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004158 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004159 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004160 } else {
4161 /*
4162 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004163 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4164 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004165 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004166 for_each_node(node) {
4167 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4168 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4169 put_pwq_unlocked(pwq);
4170 }
4171
4172 /*
4173 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4174 * put. Don't access it afterwards.
4175 */
4176 pwq = wq->dfl_pwq;
4177 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004178 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004179 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004180}
4181EXPORT_SYMBOL_GPL(destroy_workqueue);
4182
Tejun Heodcd989c2010-06-29 10:07:14 +02004183/**
4184 * workqueue_set_max_active - adjust max_active of a workqueue
4185 * @wq: target workqueue
4186 * @max_active: new max_active value.
4187 *
4188 * Set max_active of @wq to @max_active.
4189 *
4190 * CONTEXT:
4191 * Don't call from IRQ context.
4192 */
4193void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4194{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004195 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004196
Tejun Heo8719dce2013-03-12 11:30:04 -07004197 /* disallow meddling with max_active for ordered workqueues */
Tejun Heof9636c92017-07-23 08:36:15 -04004198 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004199 return;
4200
Tejun Heof3421792010-07-02 10:03:51 +02004201 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004202
Lai Jiangshana357fc02013-03-25 16:57:19 -07004203 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004204
Tejun Heof9636c92017-07-23 08:36:15 -04004205 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004206 wq->saved_max_active = max_active;
4207
Tejun Heo699ce092013-03-13 16:51:35 -07004208 for_each_pwq(pwq, wq)
4209 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004210
Lai Jiangshana357fc02013-03-25 16:57:19 -07004211 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004212}
4213EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4214
4215/**
Lukas Wunner225ce6d2018-02-11 10:38:28 +01004216 * current_work - retrieve %current task's work struct
4217 *
4218 * Determine if %current task is a workqueue worker and what it's working on.
4219 * Useful to find out the context that the %current task is running in.
4220 *
4221 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4222 */
4223struct work_struct *current_work(void)
4224{
4225 struct worker *worker = current_wq_worker();
4226
4227 return worker ? worker->current_work : NULL;
4228}
4229EXPORT_SYMBOL(current_work);
4230
4231/**
Tejun Heoe62676162013-03-12 17:41:37 -07004232 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4233 *
4234 * Determine whether %current is a workqueue rescuer. Can be used from
4235 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004236 *
4237 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004238 */
4239bool current_is_workqueue_rescuer(void)
4240{
4241 struct worker *worker = current_wq_worker();
4242
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004243 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004244}
4245
4246/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004247 * workqueue_congested - test whether a workqueue is congested
4248 * @cpu: CPU in question
4249 * @wq: target workqueue
4250 *
4251 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4252 * no synchronization around this function and the test result is
4253 * unreliable and only useful as advisory hints or for debugging.
4254 *
Tejun Heod3251852013-05-10 11:10:17 -07004255 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4256 * Note that both per-cpu and unbound workqueues may be associated with
4257 * multiple pool_workqueues which have separate congested states. A
4258 * workqueue being congested on one CPU doesn't mean the workqueue is also
4259 * contested on other CPUs / NUMA nodes.
4260 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004261 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004262 * %true if congested, %false otherwise.
4263 */
Tejun Heod84ff052013-03-12 11:29:59 -07004264bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004265{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004266 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004267 bool ret;
4268
Lai Jiangshan88109452013-03-20 03:28:10 +08004269 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004270
Tejun Heod3251852013-05-10 11:10:17 -07004271 if (cpu == WORK_CPU_UNBOUND)
4272 cpu = smp_processor_id();
4273
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004274 if (!(wq->flags & WQ_UNBOUND))
4275 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4276 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004277 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004278
Tejun Heo76af4d92013-03-12 11:30:00 -07004279 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004280 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004281
4282 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004283}
4284EXPORT_SYMBOL_GPL(workqueue_congested);
4285
4286/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004287 * work_busy - test whether a work is currently pending or running
4288 * @work: the work to be tested
4289 *
4290 * Test whether @work is currently pending or running. There is no
4291 * synchronization around this function and the test result is
4292 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004293 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004294 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004295 * OR'd bitmask of WORK_BUSY_* bits.
4296 */
4297unsigned int work_busy(struct work_struct *work)
4298{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004299 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004300 unsigned long flags;
4301 unsigned int ret = 0;
4302
Tejun Heodcd989c2010-06-29 10:07:14 +02004303 if (work_pending(work))
4304 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004305
Tejun Heofa1b54e2013-03-12 11:30:00 -07004306 local_irq_save(flags);
4307 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004308 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004309 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004310 if (find_worker_executing_work(pool, work))
4311 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004312 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004313 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004314 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004315
4316 return ret;
4317}
4318EXPORT_SYMBOL_GPL(work_busy);
4319
Tejun Heo3d1cb202013-04-30 15:27:22 -07004320/**
4321 * set_worker_desc - set description for the current work item
4322 * @fmt: printf-style format string
4323 * @...: arguments for the format string
4324 *
4325 * This function can be called by a running work function to describe what
4326 * the work item is about. If the worker task gets dumped, this
4327 * information will be printed out together to help debugging. The
4328 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4329 */
4330void set_worker_desc(const char *fmt, ...)
4331{
4332 struct worker *worker = current_wq_worker();
4333 va_list args;
4334
4335 if (worker) {
4336 va_start(args, fmt);
4337 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4338 va_end(args);
4339 worker->desc_valid = true;
4340 }
4341}
4342
4343/**
4344 * print_worker_info - print out worker information and description
4345 * @log_lvl: the log level to use when printing
4346 * @task: target task
4347 *
4348 * If @task is a worker and currently executing a work item, print out the
4349 * name of the workqueue being serviced and worker description set with
4350 * set_worker_desc() by the currently executing work item.
4351 *
4352 * This function can be safely called on any task as long as the
4353 * task_struct itself is accessible. While safe, this function isn't
4354 * synchronized and may print out mixups or garbages of limited length.
4355 */
4356void print_worker_info(const char *log_lvl, struct task_struct *task)
4357{
4358 work_func_t *fn = NULL;
4359 char name[WQ_NAME_LEN] = { };
4360 char desc[WORKER_DESC_LEN] = { };
4361 struct pool_workqueue *pwq = NULL;
4362 struct workqueue_struct *wq = NULL;
4363 bool desc_valid = false;
4364 struct worker *worker;
4365
4366 if (!(task->flags & PF_WQ_WORKER))
4367 return;
4368
4369 /*
4370 * This function is called without any synchronization and @task
4371 * could be in any state. Be careful with dereferences.
4372 */
Petr Mladeke7005912016-10-11 13:55:17 -07004373 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004374
4375 /*
4376 * Carefully copy the associated workqueue's workfn and name. Keep
4377 * the original last '\0' in case the original contains garbage.
4378 */
4379 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4380 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4381 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4382 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4383
4384 /* copy worker description */
4385 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4386 if (desc_valid)
4387 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4388
4389 if (fn || name[0] || desc[0]) {
4390 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4391 if (desc[0])
4392 pr_cont(" (%s)", desc);
4393 pr_cont("\n");
4394 }
4395}
4396
Tejun Heo3494fc32015-03-09 09:22:28 -04004397static void pr_cont_pool_info(struct worker_pool *pool)
4398{
4399 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4400 if (pool->node != NUMA_NO_NODE)
4401 pr_cont(" node=%d", pool->node);
4402 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4403}
4404
4405static void pr_cont_work(bool comma, struct work_struct *work)
4406{
4407 if (work->func == wq_barrier_func) {
4408 struct wq_barrier *barr;
4409
4410 barr = container_of(work, struct wq_barrier, work);
4411
4412 pr_cont("%s BAR(%d)", comma ? "," : "",
4413 task_pid_nr(barr->task));
4414 } else {
4415 pr_cont("%s %pf", comma ? "," : "", work->func);
4416 }
4417}
4418
4419static void show_pwq(struct pool_workqueue *pwq)
4420{
4421 struct worker_pool *pool = pwq->pool;
4422 struct work_struct *work;
4423 struct worker *worker;
4424 bool has_in_flight = false, has_pending = false;
4425 int bkt;
4426
4427 pr_info(" pwq %d:", pool->id);
4428 pr_cont_pool_info(pool);
4429
Tejun Heo4f5b0c72019-09-25 06:59:15 -07004430 pr_cont(" active=%d/%d refcnt=%d%s\n",
4431 pwq->nr_active, pwq->max_active, pwq->refcnt,
Tejun Heo3494fc32015-03-09 09:22:28 -04004432 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4433
4434 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4435 if (worker->current_pwq == pwq) {
4436 has_in_flight = true;
4437 break;
4438 }
4439 }
4440 if (has_in_flight) {
4441 bool comma = false;
4442
4443 pr_info(" in-flight:");
4444 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4445 if (worker->current_pwq != pwq)
4446 continue;
4447
4448 pr_cont("%s %d%s:%pf", comma ? "," : "",
4449 task_pid_nr(worker->task),
4450 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4451 worker->current_func);
4452 list_for_each_entry(work, &worker->scheduled, entry)
4453 pr_cont_work(false, work);
4454 comma = true;
4455 }
4456 pr_cont("\n");
4457 }
4458
4459 list_for_each_entry(work, &pool->worklist, entry) {
4460 if (get_work_pwq(work) == pwq) {
4461 has_pending = true;
4462 break;
4463 }
4464 }
4465 if (has_pending) {
4466 bool comma = false;
4467
4468 pr_info(" pending:");
4469 list_for_each_entry(work, &pool->worklist, entry) {
4470 if (get_work_pwq(work) != pwq)
4471 continue;
4472
4473 pr_cont_work(comma, work);
4474 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4475 }
4476 pr_cont("\n");
4477 }
4478
4479 if (!list_empty(&pwq->delayed_works)) {
4480 bool comma = false;
4481
4482 pr_info(" delayed:");
4483 list_for_each_entry(work, &pwq->delayed_works, entry) {
4484 pr_cont_work(comma, work);
4485 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4486 }
4487 pr_cont("\n");
4488 }
4489}
4490
4491/**
4492 * show_workqueue_state - dump workqueue state
4493 *
Roger Lu7b776af2016-07-01 11:05:02 +08004494 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4495 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004496 */
4497void show_workqueue_state(void)
4498{
4499 struct workqueue_struct *wq;
4500 struct worker_pool *pool;
4501 unsigned long flags;
4502 int pi;
4503
4504 rcu_read_lock_sched();
4505
4506 pr_info("Showing busy workqueues and worker pools:\n");
4507
4508 list_for_each_entry_rcu(wq, &workqueues, list) {
4509 struct pool_workqueue *pwq;
4510 bool idle = true;
4511
4512 for_each_pwq(pwq, wq) {
4513 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4514 idle = false;
4515 break;
4516 }
4517 }
4518 if (idle)
4519 continue;
4520
4521 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4522
4523 for_each_pwq(pwq, wq) {
4524 spin_lock_irqsave(&pwq->pool->lock, flags);
4525 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4526 show_pwq(pwq);
4527 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +09004528 /*
4529 * We could be printing a lot from atomic context, e.g.
4530 * sysrq-t -> show_workqueue_state(). Avoid triggering
4531 * hard lockup.
4532 */
4533 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004534 }
4535 }
4536
4537 for_each_pool(pool, pi) {
4538 struct worker *worker;
4539 bool first = true;
4540
4541 spin_lock_irqsave(&pool->lock, flags);
4542 if (pool->nr_workers == pool->nr_idle)
4543 goto next_pool;
4544
4545 pr_info("pool %d:", pool->id);
4546 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004547 pr_cont(" hung=%us workers=%d",
4548 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4549 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004550 if (pool->manager)
4551 pr_cont(" manager: %d",
4552 task_pid_nr(pool->manager->task));
4553 list_for_each_entry(worker, &pool->idle_list, entry) {
4554 pr_cont(" %s%d", first ? "idle: " : "",
4555 task_pid_nr(worker->task));
4556 first = false;
4557 }
4558 pr_cont("\n");
4559 next_pool:
4560 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +09004561 /*
4562 * We could be printing a lot from atomic context, e.g.
4563 * sysrq-t -> show_workqueue_state(). Avoid triggering
4564 * hard lockup.
4565 */
4566 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004567 }
4568
4569 rcu_read_unlock_sched();
4570}
4571
Tejun Heodb7bccf2010-06-29 10:07:12 +02004572/*
4573 * CPU hotplug.
4574 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004575 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004576 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004577 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004578 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004579 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004580 * blocked draining impractical.
4581 *
Tejun Heo24647572013-01-24 11:01:33 -08004582 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004583 * running as an unbound one and allowing it to be reattached later if the
4584 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004585 */
4586
Lai Jiangshan6128fcb2017-12-01 22:20:36 +08004587static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004588{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004589 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004590 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004591
Tejun Heof02ae732013-03-12 11:30:03 -07004592 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004593 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004594 spin_lock_irq(&pool->lock);
4595
4596 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004597 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004598 * unbound and set DISASSOCIATED. Before this, all workers
4599 * except for the ones which are still executing works from
4600 * before the last CPU down must be on the cpu. After
4601 * this, they may become diasporas.
4602 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004603 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004604 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004605
Tejun Heo24647572013-01-24 11:01:33 -08004606 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004607
Tejun Heo94cf58b2013-01-24 11:01:33 -08004608 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004609 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004610
Lai Jiangshaneb283422013-03-08 15:18:28 -08004611 /*
4612 * Call schedule() so that we cross rq->lock and thus can
4613 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4614 * This is necessary as scheduler callbacks may be invoked
4615 * from other cpus.
4616 */
4617 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004618
Lai Jiangshaneb283422013-03-08 15:18:28 -08004619 /*
4620 * Sched callbacks are disabled now. Zap nr_running.
4621 * After this, nr_running stays zero and need_more_worker()
4622 * and keep_working() are always true as long as the
4623 * worklist is not empty. This pool now behaves as an
4624 * unbound (in terms of concurrency management) pool which
4625 * are served by workers tied to the pool.
4626 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004627 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004628
4629 /*
4630 * With concurrency management just turned off, a busy
4631 * worker blocking could lead to lengthy stalls. Kick off
4632 * unbound chain execution of currently pending work items.
4633 */
4634 spin_lock_irq(&pool->lock);
4635 wake_up_worker(pool);
4636 spin_unlock_irq(&pool->lock);
4637 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004638}
4639
Tejun Heobd7c0892013-03-19 13:45:21 -07004640/**
4641 * rebind_workers - rebind all workers of a pool to the associated CPU
4642 * @pool: pool of interest
4643 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004644 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004645 */
4646static void rebind_workers(struct worker_pool *pool)
4647{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004648 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004649
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004650 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004651
Tejun Heoa9ab7752013-03-19 13:45:21 -07004652 /*
4653 * Restore CPU affinity of all workers. As all idle workers should
4654 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304655 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004656 * of all workers first and then clear UNBOUND. As we're called
4657 * from CPU_ONLINE, the following shouldn't fail.
4658 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004659 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004660 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4661 pool->attrs->cpumask) < 0);
4662
4663 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004664
4665 /*
4666 * XXX: CPU hotplug notifiers are weird and can call DOWN_FAILED
4667 * w/o preceding DOWN_PREPARE. Work around it. CPU hotplug is
4668 * being reworked and this can go away in time.
4669 */
4670 if (!(pool->flags & POOL_DISASSOCIATED)) {
4671 spin_unlock_irq(&pool->lock);
4672 return;
4673 }
4674
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004675 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004676
Lai Jiangshanda028462014-05-20 17:46:31 +08004677 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004678 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004679
4680 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004681 * A bound idle worker should actually be on the runqueue
4682 * of the associated CPU for local wake-ups targeting it to
4683 * work. Kick all idle workers so that they migrate to the
4684 * associated CPU. Doing this in the same loop as
4685 * replacing UNBOUND with REBOUND is safe as no worker will
4686 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004687 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004688 if (worker_flags & WORKER_IDLE)
4689 wake_up_process(worker->task);
4690
4691 /*
4692 * We want to clear UNBOUND but can't directly call
4693 * worker_clr_flags() or adjust nr_running. Atomically
4694 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4695 * @worker will clear REBOUND using worker_clr_flags() when
4696 * it initiates the next execution cycle thus restoring
4697 * concurrency management. Note that when or whether
4698 * @worker clears REBOUND doesn't affect correctness.
4699 *
4700 * ACCESS_ONCE() is necessary because @worker->flags may be
4701 * tested without holding any lock in
4702 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4703 * fail incorrectly leading to premature concurrency
4704 * management operations.
4705 */
4706 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4707 worker_flags |= WORKER_REBOUND;
4708 worker_flags &= ~WORKER_UNBOUND;
4709 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004710 }
4711
Tejun Heoa9ab7752013-03-19 13:45:21 -07004712 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004713}
4714
Tejun Heo7dbc7252013-03-19 13:45:21 -07004715/**
4716 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4717 * @pool: unbound pool of interest
4718 * @cpu: the CPU which is coming up
4719 *
4720 * An unbound pool may end up with a cpumask which doesn't have any online
4721 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4722 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4723 * online CPU before, cpus_allowed of all its workers should be restored.
4724 */
4725static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4726{
4727 static cpumask_t cpumask;
4728 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004729
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004730 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004731
4732 /* is @cpu allowed for @pool? */
4733 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4734 return;
4735
Tejun Heo7dbc7252013-03-19 13:45:21 -07004736 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004737
4738 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004739 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004740 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004741}
4742
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004743int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004744{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004745 struct worker_pool *pool;
4746
4747 for_each_cpu_worker_pool(pool, cpu) {
4748 if (pool->nr_workers)
4749 continue;
4750 if (!create_worker(pool))
4751 return -ENOMEM;
4752 }
4753 return 0;
4754}
4755
4756int workqueue_online_cpu(unsigned int cpu)
4757{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004758 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004759 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004760 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004761
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004762 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004763
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004764 for_each_pool(pool, pi) {
4765 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004766
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004767 if (pool->cpu == cpu)
4768 rebind_workers(pool);
4769 else if (pool->cpu < 0)
4770 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004771
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004772 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004773 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004774
4775 /* update NUMA affinity of unbound workqueues */
4776 list_for_each_entry(wq, &workqueues, list)
4777 wq_update_unbound_numa(wq, cpu, true);
4778
4779 mutex_unlock(&wq_pool_mutex);
4780 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004781}
4782
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004783int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004784{
Tejun Heo4c16bd32013-04-01 11:23:36 -07004785 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004786
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004787 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshan6128fcb2017-12-01 22:20:36 +08004788 if (WARN_ON(cpu != smp_processor_id()))
4789 return -1;
4790
4791 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004792
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004793 /* update NUMA affinity of unbound workqueues */
4794 mutex_lock(&wq_pool_mutex);
4795 list_for_each_entry(wq, &workqueues, list)
4796 wq_update_unbound_numa(wq, cpu, false);
4797 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004798
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004799 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004800}
4801
Rusty Russell2d3854a2008-11-05 13:39:10 +11004802#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004803
Rusty Russell2d3854a2008-11-05 13:39:10 +11004804struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004805 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004806 long (*fn)(void *);
4807 void *arg;
4808 long ret;
4809};
4810
Tejun Heoed48ece2012-09-18 12:48:43 -07004811static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004812{
Tejun Heoed48ece2012-09-18 12:48:43 -07004813 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4814
Rusty Russell2d3854a2008-11-05 13:39:10 +11004815 wfc->ret = wfc->fn(wfc->arg);
4816}
4817
4818/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004819 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004820 * @cpu: the cpu to run on
4821 * @fn: the function to run
4822 * @arg: the function arg
4823 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004824 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06004825 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004826 *
4827 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004828 */
Tejun Heod84ff052013-03-12 11:29:59 -07004829long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004830{
Tejun Heoed48ece2012-09-18 12:48:43 -07004831 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004832
Tejun Heoed48ece2012-09-18 12:48:43 -07004833 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4834 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004835 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004836 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004837 return wfc.ret;
4838}
4839EXPORT_SYMBOL_GPL(work_on_cpu);
4840#endif /* CONFIG_SMP */
4841
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004842#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304843
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004844/**
4845 * freeze_workqueues_begin - begin freezing workqueues
4846 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004847 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004848 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004849 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004850 *
4851 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004852 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004853 */
4854void freeze_workqueues_begin(void)
4855{
Tejun Heo24b8a842013-03-12 11:29:58 -07004856 struct workqueue_struct *wq;
4857 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004858
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004859 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004860
Tejun Heo6183c002013-03-12 11:29:57 -07004861 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004862 workqueue_freezing = true;
4863
Tejun Heo24b8a842013-03-12 11:29:58 -07004864 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004865 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004866 for_each_pwq(pwq, wq)
4867 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004868 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004869 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004870
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004871 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004872}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004873
4874/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004875 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004876 *
4877 * Check whether freezing is complete. This function must be called
4878 * between freeze_workqueues_begin() and thaw_workqueues().
4879 *
4880 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004881 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004882 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004883 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004884 * %true if some freezable workqueues are still busy. %false if freezing
4885 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004886 */
4887bool freeze_workqueues_busy(void)
4888{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004889 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004890 struct workqueue_struct *wq;
4891 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004892
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004893 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004894
Tejun Heo6183c002013-03-12 11:29:57 -07004895 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004896
Tejun Heo24b8a842013-03-12 11:29:58 -07004897 list_for_each_entry(wq, &workqueues, list) {
4898 if (!(wq->flags & WQ_FREEZABLE))
4899 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004900 /*
4901 * nr_active is monotonically decreasing. It's safe
4902 * to peek without lock.
4903 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004904 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004905 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004906 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004907 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004908 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004909 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004910 goto out_unlock;
4911 }
4912 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004913 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004914 }
4915out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004916 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004917 return busy;
4918}
4919
4920/**
4921 * thaw_workqueues - thaw workqueues
4922 *
4923 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004924 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004925 *
4926 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004927 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004928 */
4929void thaw_workqueues(void)
4930{
Tejun Heo24b8a842013-03-12 11:29:58 -07004931 struct workqueue_struct *wq;
4932 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004933
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004934 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004935
4936 if (!workqueue_freezing)
4937 goto out_unlock;
4938
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004939 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004940
Tejun Heo24b8a842013-03-12 11:29:58 -07004941 /* restore max_active and repopulate worklist */
4942 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004943 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004944 for_each_pwq(pwq, wq)
4945 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004946 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004947 }
4948
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004949out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004950 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004951}
4952#endif /* CONFIG_FREEZER */
4953
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004954static int workqueue_apply_unbound_cpumask(void)
4955{
4956 LIST_HEAD(ctxs);
4957 int ret = 0;
4958 struct workqueue_struct *wq;
4959 struct apply_wqattrs_ctx *ctx, *n;
4960
4961 lockdep_assert_held(&wq_pool_mutex);
4962
4963 list_for_each_entry(wq, &workqueues, list) {
4964 if (!(wq->flags & WQ_UNBOUND))
4965 continue;
4966 /* creating multiple pwqs breaks ordering guarantee */
4967 if (wq->flags & __WQ_ORDERED)
4968 continue;
4969
4970 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4971 if (!ctx) {
4972 ret = -ENOMEM;
4973 break;
4974 }
4975
4976 list_add_tail(&ctx->list, &ctxs);
4977 }
4978
4979 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4980 if (!ret)
4981 apply_wqattrs_commit(ctx);
4982 apply_wqattrs_cleanup(ctx);
4983 }
4984
4985 return ret;
4986}
4987
4988/**
4989 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4990 * @cpumask: the cpumask to set
4991 *
4992 * The low-level workqueues cpumask is a global cpumask that limits
4993 * the affinity of all unbound workqueues. This function check the @cpumask
4994 * and apply it to all unbound workqueues and updates all pwqs of them.
4995 *
4996 * Retun: 0 - Success
4997 * -EINVAL - Invalid @cpumask
4998 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4999 */
5000int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5001{
5002 int ret = -EINVAL;
5003 cpumask_var_t saved_cpumask;
5004
5005 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5006 return -ENOMEM;
5007
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005008 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5009 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005010 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005011
5012 /* save the old wq_unbound_cpumask. */
5013 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5014
5015 /* update wq_unbound_cpumask at first and apply it to wqs. */
5016 cpumask_copy(wq_unbound_cpumask, cpumask);
5017 ret = workqueue_apply_unbound_cpumask();
5018
5019 /* restore the wq_unbound_cpumask when failed. */
5020 if (ret < 0)
5021 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5022
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005023 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005024 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005025
5026 free_cpumask_var(saved_cpumask);
5027 return ret;
5028}
5029
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005030#ifdef CONFIG_SYSFS
5031/*
5032 * Workqueues with WQ_SYSFS flag set is visible to userland via
5033 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5034 * following attributes.
5035 *
5036 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5037 * max_active RW int : maximum number of in-flight work items
5038 *
5039 * Unbound workqueues have the following extra attributes.
5040 *
5041 * id RO int : the associated pool ID
5042 * nice RW int : nice value of the workers
5043 * cpumask RW mask : bitmask of allowed CPUs for the workers
5044 */
5045struct wq_device {
5046 struct workqueue_struct *wq;
5047 struct device dev;
5048};
5049
5050static struct workqueue_struct *dev_to_wq(struct device *dev)
5051{
5052 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5053
5054 return wq_dev->wq;
5055}
5056
5057static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5058 char *buf)
5059{
5060 struct workqueue_struct *wq = dev_to_wq(dev);
5061
5062 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5063}
5064static DEVICE_ATTR_RO(per_cpu);
5065
5066static ssize_t max_active_show(struct device *dev,
5067 struct device_attribute *attr, char *buf)
5068{
5069 struct workqueue_struct *wq = dev_to_wq(dev);
5070
5071 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5072}
5073
5074static ssize_t max_active_store(struct device *dev,
5075 struct device_attribute *attr, const char *buf,
5076 size_t count)
5077{
5078 struct workqueue_struct *wq = dev_to_wq(dev);
5079 int val;
5080
5081 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5082 return -EINVAL;
5083
5084 workqueue_set_max_active(wq, val);
5085 return count;
5086}
5087static DEVICE_ATTR_RW(max_active);
5088
5089static struct attribute *wq_sysfs_attrs[] = {
5090 &dev_attr_per_cpu.attr,
5091 &dev_attr_max_active.attr,
5092 NULL,
5093};
5094ATTRIBUTE_GROUPS(wq_sysfs);
5095
5096static ssize_t wq_pool_ids_show(struct device *dev,
5097 struct device_attribute *attr, char *buf)
5098{
5099 struct workqueue_struct *wq = dev_to_wq(dev);
5100 const char *delim = "";
5101 int node, written = 0;
5102
5103 rcu_read_lock_sched();
5104 for_each_node(node) {
5105 written += scnprintf(buf + written, PAGE_SIZE - written,
5106 "%s%d:%d", delim, node,
5107 unbound_pwq_by_node(wq, node)->pool->id);
5108 delim = " ";
5109 }
5110 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5111 rcu_read_unlock_sched();
5112
5113 return written;
5114}
5115
5116static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5117 char *buf)
5118{
5119 struct workqueue_struct *wq = dev_to_wq(dev);
5120 int written;
5121
5122 mutex_lock(&wq->mutex);
5123 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5124 mutex_unlock(&wq->mutex);
5125
5126 return written;
5127}
5128
5129/* prepare workqueue_attrs for sysfs store operations */
5130static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5131{
5132 struct workqueue_attrs *attrs;
5133
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005134 lockdep_assert_held(&wq_pool_mutex);
5135
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005136 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5137 if (!attrs)
5138 return NULL;
5139
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005140 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005141 return attrs;
5142}
5143
5144static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5145 const char *buf, size_t count)
5146{
5147 struct workqueue_struct *wq = dev_to_wq(dev);
5148 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005149 int ret = -ENOMEM;
5150
5151 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005152
5153 attrs = wq_sysfs_prep_attrs(wq);
5154 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005155 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005156
5157 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5158 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005159 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005160 else
5161 ret = -EINVAL;
5162
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005163out_unlock:
5164 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005165 free_workqueue_attrs(attrs);
5166 return ret ?: count;
5167}
5168
5169static ssize_t wq_cpumask_show(struct device *dev,
5170 struct device_attribute *attr, char *buf)
5171{
5172 struct workqueue_struct *wq = dev_to_wq(dev);
5173 int written;
5174
5175 mutex_lock(&wq->mutex);
5176 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5177 cpumask_pr_args(wq->unbound_attrs->cpumask));
5178 mutex_unlock(&wq->mutex);
5179 return written;
5180}
5181
5182static ssize_t wq_cpumask_store(struct device *dev,
5183 struct device_attribute *attr,
5184 const char *buf, size_t count)
5185{
5186 struct workqueue_struct *wq = dev_to_wq(dev);
5187 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005188 int ret = -ENOMEM;
5189
5190 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005191
5192 attrs = wq_sysfs_prep_attrs(wq);
5193 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005194 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005195
5196 ret = cpumask_parse(buf, attrs->cpumask);
5197 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005198 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005199
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005200out_unlock:
5201 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005202 free_workqueue_attrs(attrs);
5203 return ret ?: count;
5204}
5205
5206static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5207 char *buf)
5208{
5209 struct workqueue_struct *wq = dev_to_wq(dev);
5210 int written;
5211
5212 mutex_lock(&wq->mutex);
5213 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5214 !wq->unbound_attrs->no_numa);
5215 mutex_unlock(&wq->mutex);
5216
5217 return written;
5218}
5219
5220static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5221 const char *buf, size_t count)
5222{
5223 struct workqueue_struct *wq = dev_to_wq(dev);
5224 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005225 int v, ret = -ENOMEM;
5226
5227 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005228
5229 attrs = wq_sysfs_prep_attrs(wq);
5230 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005231 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005232
5233 ret = -EINVAL;
5234 if (sscanf(buf, "%d", &v) == 1) {
5235 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005236 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005237 }
5238
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005239out_unlock:
5240 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005241 free_workqueue_attrs(attrs);
5242 return ret ?: count;
5243}
5244
5245static struct device_attribute wq_sysfs_unbound_attrs[] = {
5246 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5247 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5248 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5249 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5250 __ATTR_NULL,
5251};
5252
5253static struct bus_type wq_subsys = {
5254 .name = "workqueue",
5255 .dev_groups = wq_sysfs_groups,
5256};
5257
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005258static ssize_t wq_unbound_cpumask_show(struct device *dev,
5259 struct device_attribute *attr, char *buf)
5260{
5261 int written;
5262
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005263 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005264 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5265 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005266 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005267
5268 return written;
5269}
5270
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005271static ssize_t wq_unbound_cpumask_store(struct device *dev,
5272 struct device_attribute *attr, const char *buf, size_t count)
5273{
5274 cpumask_var_t cpumask;
5275 int ret;
5276
5277 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5278 return -ENOMEM;
5279
5280 ret = cpumask_parse(buf, cpumask);
5281 if (!ret)
5282 ret = workqueue_set_unbound_cpumask(cpumask);
5283
5284 free_cpumask_var(cpumask);
5285 return ret ? ret : count;
5286}
5287
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005288static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005289 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5290 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005291
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005292static int __init wq_sysfs_init(void)
5293{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005294 int err;
5295
5296 err = subsys_virtual_register(&wq_subsys, NULL);
5297 if (err)
5298 return err;
5299
5300 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005301}
5302core_initcall(wq_sysfs_init);
5303
5304static void wq_device_release(struct device *dev)
5305{
5306 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5307
5308 kfree(wq_dev);
5309}
5310
5311/**
5312 * workqueue_sysfs_register - make a workqueue visible in sysfs
5313 * @wq: the workqueue to register
5314 *
5315 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5316 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5317 * which is the preferred method.
5318 *
5319 * Workqueue user should use this function directly iff it wants to apply
5320 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5321 * apply_workqueue_attrs() may race against userland updating the
5322 * attributes.
5323 *
5324 * Return: 0 on success, -errno on failure.
5325 */
5326int workqueue_sysfs_register(struct workqueue_struct *wq)
5327{
5328 struct wq_device *wq_dev;
5329 int ret;
5330
5331 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305332 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005333 * attributes breaks ordering guarantee. Disallow exposing ordered
5334 * workqueues.
5335 */
Tejun Heof9636c92017-07-23 08:36:15 -04005336 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005337 return -EINVAL;
5338
5339 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5340 if (!wq_dev)
5341 return -ENOMEM;
5342
5343 wq_dev->wq = wq;
5344 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005345 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005346 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005347
5348 /*
5349 * unbound_attrs are created separately. Suppress uevent until
5350 * everything is ready.
5351 */
5352 dev_set_uevent_suppress(&wq_dev->dev, true);
5353
5354 ret = device_register(&wq_dev->dev);
5355 if (ret) {
Arvind Yadav30393942018-03-06 15:35:43 +05305356 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005357 wq->wq_dev = NULL;
5358 return ret;
5359 }
5360
5361 if (wq->flags & WQ_UNBOUND) {
5362 struct device_attribute *attr;
5363
5364 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5365 ret = device_create_file(&wq_dev->dev, attr);
5366 if (ret) {
5367 device_unregister(&wq_dev->dev);
5368 wq->wq_dev = NULL;
5369 return ret;
5370 }
5371 }
5372 }
5373
5374 dev_set_uevent_suppress(&wq_dev->dev, false);
5375 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5376 return 0;
5377}
5378
5379/**
5380 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5381 * @wq: the workqueue to unregister
5382 *
5383 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5384 */
5385static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5386{
5387 struct wq_device *wq_dev = wq->wq_dev;
5388
5389 if (!wq->wq_dev)
5390 return;
5391
5392 wq->wq_dev = NULL;
5393 device_unregister(&wq_dev->dev);
5394}
5395#else /* CONFIG_SYSFS */
5396static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5397#endif /* CONFIG_SYSFS */
5398
Tejun Heo82607adc2015-12-08 11:28:04 -05005399/*
5400 * Workqueue watchdog.
5401 *
5402 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5403 * flush dependency, a concurrency managed work item which stays RUNNING
5404 * indefinitely. Workqueue stalls can be very difficult to debug as the
5405 * usual warning mechanisms don't trigger and internal workqueue state is
5406 * largely opaque.
5407 *
5408 * Workqueue watchdog monitors all worker pools periodically and dumps
5409 * state if some pools failed to make forward progress for a while where
5410 * forward progress is defined as the first item on ->worklist changing.
5411 *
5412 * This mechanism is controlled through the kernel parameter
5413 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5414 * corresponding sysfs parameter file.
5415 */
5416#ifdef CONFIG_WQ_WATCHDOG
5417
5418static void wq_watchdog_timer_fn(unsigned long data);
5419
5420static unsigned long wq_watchdog_thresh = 30;
5421static struct timer_list wq_watchdog_timer =
5422 TIMER_DEFERRED_INITIALIZER(wq_watchdog_timer_fn, 0, 0);
5423
5424static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5425static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5426
5427static void wq_watchdog_reset_touched(void)
5428{
5429 int cpu;
5430
5431 wq_watchdog_touched = jiffies;
5432 for_each_possible_cpu(cpu)
5433 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5434}
5435
5436static void wq_watchdog_timer_fn(unsigned long data)
5437{
5438 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5439 bool lockup_detected = false;
Sergey Senozhatskya8f2c7b2021-05-20 19:14:22 +09005440 unsigned long now = jiffies;
Tejun Heo82607adc2015-12-08 11:28:04 -05005441 struct worker_pool *pool;
5442 int pi;
5443
5444 if (!thresh)
5445 return;
5446
5447 rcu_read_lock();
5448
5449 for_each_pool(pool, pi) {
5450 unsigned long pool_ts, touched, ts;
5451
5452 if (list_empty(&pool->worklist))
5453 continue;
5454
Sergey Senozhatskya8f2c7b2021-05-20 19:14:22 +09005455 /*
5456 * If a virtual machine is stopped by the host it can look to
5457 * the watchdog like a stall.
5458 */
5459 kvm_check_and_clear_guest_paused();
5460
Tejun Heo82607adc2015-12-08 11:28:04 -05005461 /* get the latest of pool and touched timestamps */
5462 pool_ts = READ_ONCE(pool->watchdog_ts);
5463 touched = READ_ONCE(wq_watchdog_touched);
5464
5465 if (time_after(pool_ts, touched))
5466 ts = pool_ts;
5467 else
5468 ts = touched;
5469
5470 if (pool->cpu >= 0) {
5471 unsigned long cpu_touched =
5472 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5473 pool->cpu));
5474 if (time_after(cpu_touched, ts))
5475 ts = cpu_touched;
5476 }
5477
5478 /* did we stall? */
Sergey Senozhatskya8f2c7b2021-05-20 19:14:22 +09005479 if (time_after(now, ts + thresh)) {
Tejun Heo82607adc2015-12-08 11:28:04 -05005480 lockup_detected = true;
5481 pr_emerg("BUG: workqueue lockup - pool");
5482 pr_cont_pool_info(pool);
5483 pr_cont(" stuck for %us!\n",
Sergey Senozhatskya8f2c7b2021-05-20 19:14:22 +09005484 jiffies_to_msecs(now - pool_ts) / 1000);
Tejun Heo82607adc2015-12-08 11:28:04 -05005485 }
5486 }
5487
5488 rcu_read_unlock();
5489
5490 if (lockup_detected)
5491 show_workqueue_state();
5492
5493 wq_watchdog_reset_touched();
5494 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5495}
5496
5497void wq_watchdog_touch(int cpu)
5498{
5499 if (cpu >= 0)
5500 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5501 else
5502 wq_watchdog_touched = jiffies;
5503}
5504
5505static void wq_watchdog_set_thresh(unsigned long thresh)
5506{
5507 wq_watchdog_thresh = 0;
5508 del_timer_sync(&wq_watchdog_timer);
5509
5510 if (thresh) {
5511 wq_watchdog_thresh = thresh;
5512 wq_watchdog_reset_touched();
5513 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5514 }
5515}
5516
5517static int wq_watchdog_param_set_thresh(const char *val,
5518 const struct kernel_param *kp)
5519{
5520 unsigned long thresh;
5521 int ret;
5522
5523 ret = kstrtoul(val, 0, &thresh);
5524 if (ret)
5525 return ret;
5526
5527 if (system_wq)
5528 wq_watchdog_set_thresh(thresh);
5529 else
5530 wq_watchdog_thresh = thresh;
5531
5532 return 0;
5533}
5534
5535static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5536 .set = wq_watchdog_param_set_thresh,
5537 .get = param_get_ulong,
5538};
5539
5540module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5541 0644);
5542
5543static void wq_watchdog_init(void)
5544{
5545 wq_watchdog_set_thresh(wq_watchdog_thresh);
5546}
5547
5548#else /* CONFIG_WQ_WATCHDOG */
5549
5550static inline void wq_watchdog_init(void) { }
5551
5552#endif /* CONFIG_WQ_WATCHDOG */
5553
Tejun Heobce90382013-04-01 11:23:32 -07005554static void __init wq_numa_init(void)
5555{
5556 cpumask_var_t *tbl;
5557 int node, cpu;
5558
Tejun Heobce90382013-04-01 11:23:32 -07005559 if (num_possible_nodes() <= 1)
5560 return;
5561
Tejun Heod55262c2013-04-01 11:23:38 -07005562 if (wq_disable_numa) {
5563 pr_info("workqueue: NUMA affinity support disabled\n");
5564 return;
5565 }
5566
Tejun Heo4c16bd32013-04-01 11:23:36 -07005567 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5568 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5569
Tejun Heobce90382013-04-01 11:23:32 -07005570 /*
5571 * We want masks of possible CPUs of each node which isn't readily
5572 * available. Build one from cpu_to_node() which should have been
5573 * fully initialized by now.
5574 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005575 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005576 BUG_ON(!tbl);
5577
5578 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005579 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005580 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005581
5582 for_each_possible_cpu(cpu) {
5583 node = cpu_to_node(cpu);
5584 if (WARN_ON(node == NUMA_NO_NODE)) {
5585 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5586 /* happens iff arch is bonkers, let's just proceed */
5587 return;
5588 }
5589 cpumask_set_cpu(cpu, tbl[node]);
5590 }
5591
5592 wq_numa_possible_cpumask = tbl;
5593 wq_numa_enabled = true;
5594}
5595
Tejun Heo4b5facd2016-09-16 15:49:32 -04005596/**
5597 * workqueue_init_early - early init for workqueue subsystem
5598 *
5599 * This is the first half of two-staged workqueue subsystem initialization
5600 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5601 * idr are up. It sets up all the data structures and system workqueues
5602 * and allows early boot code to create workqueues and queue/cancel work
5603 * items. Actual work item execution starts only after kthreads can be
5604 * created and scheduled right before early initcalls.
5605 */
5606int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005607{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005608 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5609 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005610
Tejun Heoe904e6c2013-03-12 11:29:57 -07005611 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5612
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005613 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5614 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5615
Tejun Heoe904e6c2013-03-12 11:29:57 -07005616 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5617
Tejun Heobce90382013-04-01 11:23:32 -07005618 wq_numa_init();
5619
Tejun Heo706026c2013-01-24 11:01:34 -08005620 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005621 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005622 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005623
Tejun Heo7a4e3442013-03-12 11:30:00 -07005624 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005625 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005626 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005627 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005628 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005629 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005630 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005631
Tejun Heo9daf9e62013-01-24 11:01:33 -08005632 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005633 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005634 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005635 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005636 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005637 }
5638
Tejun Heo8a2b7532013-09-05 12:30:04 -04005639 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005640 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5641 struct workqueue_attrs *attrs;
5642
5643 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005644 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005645 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005646
5647 /*
5648 * An ordered wq should have only one pwq as ordering is
5649 * guaranteed by max_active which is enforced by pwqs.
5650 * Turn off NUMA so that dfl_pwq is used for all nodes.
5651 */
5652 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5653 attrs->nice = std_nice[i];
5654 attrs->no_numa = true;
5655 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005656 }
5657
Tejun Heod320c032010-06-29 10:07:14 +02005658 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005659 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005660 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005661 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5662 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005663 system_freezable_wq = alloc_workqueue("events_freezable",
5664 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305665 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5666 WQ_POWER_EFFICIENT, 0);
5667 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5668 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5669 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005670 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305671 !system_unbound_wq || !system_freezable_wq ||
5672 !system_power_efficient_wq ||
5673 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005674
Tejun Heo4b5facd2016-09-16 15:49:32 -04005675 return 0;
5676}
5677
5678/**
5679 * workqueue_init - bring workqueue subsystem fully online
5680 *
5681 * This is the latter half of two-staged workqueue subsystem initialization
5682 * and invoked as soon as kthreads can be created and scheduled.
5683 * Workqueues have been created and work items queued on them, but there
5684 * are no kworkers executing the work items yet. Populate the worker pools
5685 * with the initial workers and enable future kworker creations.
5686 */
5687int __init workqueue_init(void)
5688{
5689 struct worker_pool *pool;
5690 int cpu, bkt;
5691
5692 /* create the initial workers */
5693 for_each_online_cpu(cpu) {
5694 for_each_cpu_worker_pool(pool, cpu) {
5695 pool->flags &= ~POOL_DISASSOCIATED;
5696 BUG_ON(!create_worker(pool));
5697 }
5698 }
5699
5700 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5701 BUG_ON(!create_worker(pool));
5702
5703 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005704 wq_watchdog_init();
5705
Suresh Siddha6ee05782010-07-30 14:57:37 -07005706 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005707}