blob: 1b2e36b2f31f8da56457c679f9bd61fdacaa5875 [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>
Tejun Heoe22bee72010-06-29 10:07:14 +020051
Tejun Heoea138442013-01-18 14:05:55 -080052#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Tejun Heoc8e55f32010-06-29 10:07:12 +020054enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070055 /*
Tejun Heo24647572013-01-24 11:01:33 -080056 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 *
Tejun Heo24647572013-01-24 11:01:33 -080058 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 * While associated (!DISASSOCIATED), all workers are bound to the
60 * CPU and none has %WORKER_UNBOUND set and concurrency management
61 * is in effect.
62 *
63 * While DISASSOCIATED, the cpu may be offline and all workers have
64 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080065 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070066 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070067 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080068 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080069 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070070 */
Tejun Heo24647572013-01-24 11:01:33 -080071 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020072
Tejun Heoc8e55f32010-06-29 10:07:12 +020073 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020074 WORKER_DIE = 1 << 1, /* die die die */
75 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020076 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020077 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020078 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070079 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020080
Tejun Heoa9ab7752013-03-19 13:45:21 -070081 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
82 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020083
Tejun Heoe34cdddb2013-01-24 11:01:33 -080084 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070085
Tejun Heo29c91e92013-03-12 11:30:03 -070086 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020087 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020088
Tejun Heoe22bee72010-06-29 10:07:14 +020089 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
90 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
91
Tejun Heo3233cdb2011-02-16 18:10:19 +010092 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
93 /* call for help after 10ms
94 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020095 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
96 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020097
98 /*
99 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800100 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200101 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800102 RESCUER_NICE_LEVEL = MIN_NICE,
103 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700104
105 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200106};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200109 * Structure fields follow one of the following exclusion rules.
110 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200111 * I: Modifiable by initialization/destruction paths and read-only for
112 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200113 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200114 * P: Preemption protected. Disabling preemption is enough and should
115 * only be modified and accessed from the local cpu.
116 *
Tejun Heod565ed62013-01-24 11:01:33 -0800117 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200118 *
Tejun Heod565ed62013-01-24 11:01:33 -0800119 * X: During normal operation, modification requires pool->lock and should
120 * be done only from local cpu. Either disabling preemption on local
121 * cpu or grabbing pool->lock is enough for read access. If
122 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200123 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800124 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700125 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700126 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700127 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700128 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700129 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800130 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
131 *
132 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
133 * sched-RCU for reads.
134 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700135 * WQ: wq->mutex protected.
136 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700137 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700138 *
139 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200140 */
141
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800142/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200143
Tejun Heobd7bdd42012-07-12 14:46:37 -0700144struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800145 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700146 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700147 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800148 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700149 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700150
Tejun Heo82607adc2015-12-08 11:28:04 -0500151 unsigned long watchdog_ts; /* L: watchdog timestamp */
152
Tejun Heobd7bdd42012-07-12 14:46:37 -0700153 struct list_head worklist; /* L: list of pending works */
154 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700155
156 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700157 int nr_idle; /* L: currently idle ones */
158
159 struct list_head idle_list; /* X: list of idle workers */
160 struct timer_list idle_timer; /* L: worker idle timeout */
161 struct timer_list mayday_timer; /* L: SOS timer for workers */
162
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700163 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800164 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
165 /* L: hash of busy workers */
166
Tejun Heobc3a1af2013-03-13 19:47:39 -0700167 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo34a06bd2013-03-12 11:30:00 -0700168 struct mutex manager_arb; /* manager arbitration */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400169 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800170 struct mutex attach_mutex; /* attach/detach exclusion */
171 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800172 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800173
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800174 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800175
Tejun Heo7a4e3442013-03-12 11:30:00 -0700176 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700177 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
178 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700179
Tejun Heoe19e3972013-01-24 11:39:44 -0800180 /*
181 * The current concurrency level. As it's likely to be accessed
182 * from other CPUs during try_to_wake_up(), put it in a separate
183 * cacheline.
184 */
185 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700186
187 /*
188 * Destruction of pool is sched-RCU protected to allow dereferences
189 * from get_work_pool().
190 */
191 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200192} ____cacheline_aligned_in_smp;
193
194/*
Tejun Heo112202d2013-02-13 19:29:12 -0800195 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
196 * of work_struct->data are used for flags and the remaining high bits
197 * point to the pwq; thus, pwqs need to be aligned at two's power of the
198 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 */
Tejun Heo112202d2013-02-13 19:29:12 -0800200struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700201 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200202 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200203 int work_color; /* L: current color */
204 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700205 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200206 int nr_in_flight[WORK_NR_COLORS];
207 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200208 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200209 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200210 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700211 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700212 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700213
214 /*
215 * Release of unbound pwq is punted to system_wq. See put_pwq()
216 * and pwq_unbound_release_workfn() for details. pool_workqueue
217 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700218 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700219 */
220 struct work_struct unbound_release_work;
221 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700222} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200225 * Structure used to wait for workqueue flush.
226 */
227struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700228 struct list_head list; /* WQ: list of flushers */
229 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200230 struct completion done; /* flush completion */
231};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
Tejun Heo226223a2013-03-12 11:30:05 -0700233struct wq_device;
234
Tejun Heo73f53c42010-06-29 10:07:11 +0200235/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700236 * The externally visible workqueue. It relays the issued work items to
237 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 */
239struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700240 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400241 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200242
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700243 struct mutex mutex; /* protects this wq */
244 int work_color; /* WQ: current work color */
245 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800246 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700247 struct wq_flusher *first_flusher; /* WQ: first flusher */
248 struct list_head flusher_queue; /* WQ: flush waiters */
249 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200250
Tejun Heo2e109a22013-03-13 19:47:40 -0700251 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200252 struct worker *rescuer; /* I: rescue worker */
253
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700254 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700255 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700256
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800257 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
258 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700259
Tejun Heo226223a2013-03-12 11:30:05 -0700260#ifdef CONFIG_SYSFS
261 struct wq_device *wq_dev; /* I: for sysfs interface */
262#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700263#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200264 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700265#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700266 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700267
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400268 /*
269 * Destruction of workqueue_struct is sched-RCU protected to allow
270 * walking the workqueues list without grabbing wq_pool_mutex.
271 * This is used to dump all workqueues from sysrq.
272 */
273 struct rcu_head rcu;
274
Tejun Heo2728fd22013-04-01 11:23:35 -0700275 /* hot fields used during command issue, aligned to cacheline */
276 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
277 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800278 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279};
280
Tejun Heoe904e6c2013-03-12 11:29:57 -0700281static struct kmem_cache *pwq_cache;
282
Tejun Heobce90382013-04-01 11:23:32 -0700283static cpumask_var_t *wq_numa_possible_cpumask;
284 /* possible CPUs of each node */
285
Tejun Heod55262c2013-04-01 11:23:38 -0700286static bool wq_disable_numa;
287module_param_named(disable_numa, wq_disable_numa, bool, 0444);
288
Viresh Kumarcee22a12013-04-08 16:45:40 +0530289/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930290static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530291module_param_named(power_efficient, wq_power_efficient, bool, 0444);
292
Tejun Heobce90382013-04-01 11:23:32 -0700293static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
294
Tejun Heo4c16bd32013-04-01 11:23:36 -0700295/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
296static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
297
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700298static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700299static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo5bcab332013-03-13 19:47:40 -0700300
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400301static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700302static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700303
Mike Galbraithef5571802016-02-09 17:59:38 -0500304/* PL: allowable cpus for unbound wqs and work items */
305static cpumask_var_t wq_unbound_cpumask;
306
307/* CPU where unbound work was last round robin scheduled from this CPU */
308static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800309
Tejun Heof303fcc2016-02-09 17:59:38 -0500310/*
311 * Local execution of unbound work items is no longer guaranteed. The
312 * following always forces round-robin CPU selection on unbound work items
313 * to uncover usages which depend on it.
314 */
315#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
316static bool wq_debug_force_rr_cpu = true;
317#else
318static bool wq_debug_force_rr_cpu = false;
319#endif
320module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
321
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700322/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700323static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700324
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700325static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700326
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700327/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700328static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
329
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700330/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700331static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
332
Tejun Heo8a2b7532013-09-05 12:30:04 -0400333/* I: attributes used when instantiating ordered pools on demand */
334static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
335
Tejun Heod320c032010-06-29 10:07:14 +0200336struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400337EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300338struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900339EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300340struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200341EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300342struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200343EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300344struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100345EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530346struct workqueue_struct *system_power_efficient_wq __read_mostly;
347EXPORT_SYMBOL_GPL(system_power_efficient_wq);
348struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
349EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200350
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700351static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800352static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700353
Tejun Heo97bd2342010-10-05 10:41:14 +0200354#define CREATE_TRACE_POINTS
355#include <trace/events/workqueue.h>
356
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700357#define assert_rcu_or_pool_mutex() \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700358 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
359 !lockdep_is_held(&wq_pool_mutex), \
360 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700361
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700362#define assert_rcu_or_wq_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700363 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
364 !lockdep_is_held(&wq->mutex), \
365 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700366
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800367#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700368 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
369 !lockdep_is_held(&wq->mutex) && \
370 !lockdep_is_held(&wq_pool_mutex), \
371 "sched RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800372
Tejun Heof02ae732013-03-12 11:30:03 -0700373#define for_each_cpu_worker_pool(pool, cpu) \
374 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
375 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700376 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700377
Tejun Heo49e3cf42013-03-12 11:29:58 -0700378/**
Tejun Heo17116962013-03-12 11:29:58 -0700379 * for_each_pool - iterate through all worker_pools in the system
380 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700381 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700382 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700383 * This must be called either with wq_pool_mutex held or sched RCU read
384 * locked. If the pool needs to be used beyond the locking in effect, the
385 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700386 *
387 * The if/else clause exists only for the lockdep assertion and can be
388 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700389 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700390#define for_each_pool(pool, pi) \
391 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700392 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700393 else
Tejun Heo17116962013-03-12 11:29:58 -0700394
395/**
Tejun Heo822d8402013-03-19 13:45:21 -0700396 * for_each_pool_worker - iterate through all workers of a worker_pool
397 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700398 * @pool: worker_pool to iterate workers of
399 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800400 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700401 *
402 * The if/else clause exists only for the lockdep assertion and can be
403 * ignored.
404 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800405#define for_each_pool_worker(worker, pool) \
406 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800407 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700408 else
409
410/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700411 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
412 * @pwq: iteration cursor
413 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700414 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700415 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700416 * If the pwq needs to be used beyond the locking in effect, the caller is
417 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700418 *
419 * The if/else clause exists only for the lockdep assertion and can be
420 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700421 */
422#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700423 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700424 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700425 else
Tejun Heof3421792010-07-02 10:03:51 +0200426
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900427#ifdef CONFIG_DEBUG_OBJECTS_WORK
428
429static struct debug_obj_descr work_debug_descr;
430
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100431static void *work_debug_hint(void *addr)
432{
433 return ((struct work_struct *) addr)->func;
434}
435
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900436/*
437 * fixup_init is called when:
438 * - an active object is initialized
439 */
440static int work_fixup_init(void *addr, enum debug_obj_state state)
441{
442 struct work_struct *work = addr;
443
444 switch (state) {
445 case ODEBUG_STATE_ACTIVE:
446 cancel_work_sync(work);
447 debug_object_init(work, &work_debug_descr);
448 return 1;
449 default:
450 return 0;
451 }
452}
453
454/*
455 * fixup_activate is called when:
456 * - an active object is activated
457 * - an unknown object is activated (might be a statically initialized object)
458 */
459static int work_fixup_activate(void *addr, enum debug_obj_state state)
460{
461 struct work_struct *work = addr;
462
463 switch (state) {
464
465 case ODEBUG_STATE_NOTAVAILABLE:
466 /*
467 * This is not really a fixup. The work struct was
468 * statically initialized. We just make sure that it
469 * is tracked in the object tracker.
470 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200471 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900472 debug_object_init(work, &work_debug_descr);
473 debug_object_activate(work, &work_debug_descr);
474 return 0;
475 }
476 WARN_ON_ONCE(1);
477 return 0;
478
479 case ODEBUG_STATE_ACTIVE:
480 WARN_ON(1);
481
482 default:
483 return 0;
484 }
485}
486
487/*
488 * fixup_free is called when:
489 * - an active object is freed
490 */
491static int work_fixup_free(void *addr, enum debug_obj_state state)
492{
493 struct work_struct *work = addr;
494
495 switch (state) {
496 case ODEBUG_STATE_ACTIVE:
497 cancel_work_sync(work);
498 debug_object_free(work, &work_debug_descr);
499 return 1;
500 default:
501 return 0;
502 }
503}
504
505static struct debug_obj_descr work_debug_descr = {
506 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100507 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900508 .fixup_init = work_fixup_init,
509 .fixup_activate = work_fixup_activate,
510 .fixup_free = work_fixup_free,
511};
512
513static inline void debug_work_activate(struct work_struct *work)
514{
515 debug_object_activate(work, &work_debug_descr);
516}
517
518static inline void debug_work_deactivate(struct work_struct *work)
519{
520 debug_object_deactivate(work, &work_debug_descr);
521}
522
523void __init_work(struct work_struct *work, int onstack)
524{
525 if (onstack)
526 debug_object_init_on_stack(work, &work_debug_descr);
527 else
528 debug_object_init(work, &work_debug_descr);
529}
530EXPORT_SYMBOL_GPL(__init_work);
531
532void destroy_work_on_stack(struct work_struct *work)
533{
534 debug_object_free(work, &work_debug_descr);
535}
536EXPORT_SYMBOL_GPL(destroy_work_on_stack);
537
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000538void destroy_delayed_work_on_stack(struct delayed_work *work)
539{
540 destroy_timer_on_stack(&work->timer);
541 debug_object_free(&work->work, &work_debug_descr);
542}
543EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
544
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900545#else
546static inline void debug_work_activate(struct work_struct *work) { }
547static inline void debug_work_deactivate(struct work_struct *work) { }
548#endif
549
Li Bin4e8b22b2013-09-10 09:52:35 +0800550/**
551 * worker_pool_assign_id - allocate ID and assing it to @pool
552 * @pool: the pool pointer of interest
553 *
554 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
555 * successfully, -errno on failure.
556 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800557static int worker_pool_assign_id(struct worker_pool *pool)
558{
559 int ret;
560
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700561 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700562
Li Bin4e8b22b2013-09-10 09:52:35 +0800563 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
564 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700565 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700566 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700567 return 0;
568 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800569 return ret;
570}
571
Tejun Heo76af4d92013-03-12 11:30:00 -0700572/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700573 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
574 * @wq: the target workqueue
575 * @node: the node ID
576 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800577 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
578 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700579 * If the pwq needs to be used beyond the locking in effect, the caller is
580 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700581 *
582 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700583 */
584static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
585 int node)
586{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800587 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500588
589 /*
590 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
591 * delayed item is pending. The plan is to keep CPU -> NODE
592 * mapping valid and stable across CPU on/offlines. Once that
593 * happens, this workaround can be removed.
594 */
595 if (unlikely(node == NUMA_NO_NODE))
596 return wq->dfl_pwq;
597
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700598 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
599}
600
Tejun Heo73f53c42010-06-29 10:07:11 +0200601static unsigned int work_color_to_flags(int color)
602{
603 return color << WORK_STRUCT_COLOR_SHIFT;
604}
605
606static int get_work_color(struct work_struct *work)
607{
608 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
609 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
610}
611
612static int work_next_color(int color)
613{
614 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700615}
616
David Howells4594bf12006-12-07 11:33:26 +0000617/*
Tejun Heo112202d2013-02-13 19:29:12 -0800618 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
619 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800620 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200621 *
Tejun Heo112202d2013-02-13 19:29:12 -0800622 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
623 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700624 * work->data. These functions should only be called while the work is
625 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200626 *
Tejun Heo112202d2013-02-13 19:29:12 -0800627 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800628 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800629 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800630 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700631 *
632 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
633 * canceled. While being canceled, a work item may have its PENDING set
634 * but stay off timer and worklist for arbitrarily long and nobody should
635 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000636 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200637static inline void set_work_data(struct work_struct *work, unsigned long data,
638 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000639{
Tejun Heo6183c002013-03-12 11:29:57 -0700640 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200641 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000642}
David Howells365970a2006-11-22 14:54:49 +0000643
Tejun Heo112202d2013-02-13 19:29:12 -0800644static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200645 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200646{
Tejun Heo112202d2013-02-13 19:29:12 -0800647 set_work_data(work, (unsigned long)pwq,
648 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200649}
650
Lai Jiangshan4468a002013-02-06 18:04:53 -0800651static void set_work_pool_and_keep_pending(struct work_struct *work,
652 int pool_id)
653{
654 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
655 WORK_STRUCT_PENDING);
656}
657
Tejun Heo7c3eed52013-01-24 11:01:33 -0800658static void set_work_pool_and_clear_pending(struct work_struct *work,
659 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000660{
Tejun Heo23657bb2012-08-13 17:08:19 -0700661 /*
662 * The following wmb is paired with the implied mb in
663 * test_and_set_bit(PENDING) and ensures all updates to @work made
664 * here are visible to and precede any updates by the next PENDING
665 * owner.
666 */
667 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800668 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200669 /*
670 * The following mb guarantees that previous clear of a PENDING bit
671 * will not be reordered with any speculative LOADS or STORES from
672 * work->current_func, which is executed afterwards. This possible
673 * reordering can lead to a missed execution on attempt to qeueue
674 * the same @work. E.g. consider this case:
675 *
676 * CPU#0 CPU#1
677 * ---------------------------- --------------------------------
678 *
679 * 1 STORE event_indicated
680 * 2 queue_work_on() {
681 * 3 test_and_set_bit(PENDING)
682 * 4 } set_..._and_clear_pending() {
683 * 5 set_work_data() # clear bit
684 * 6 smp_mb()
685 * 7 work->current_func() {
686 * 8 LOAD event_indicated
687 * }
688 *
689 * Without an explicit full barrier speculative LOAD on line 8 can
690 * be executed before CPU#0 does STORE on line 1. If that happens,
691 * CPU#0 observes the PENDING bit is still set and new execution of
692 * a @work is not queued in a hope, that CPU#1 will eventually
693 * finish the queued @work. Meanwhile CPU#1 does not see
694 * event_indicated is set, because speculative LOAD was executed
695 * before actual STORE.
696 */
697 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200698}
699
700static void clear_work_data(struct work_struct *work)
701{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800702 smp_wmb(); /* see set_work_pool_and_clear_pending() */
703 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200704}
705
Tejun Heo112202d2013-02-13 19:29:12 -0800706static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200707{
Tejun Heoe1201532010-07-22 14:14:25 +0200708 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200709
Tejun Heo112202d2013-02-13 19:29:12 -0800710 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200711 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
712 else
713 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200714}
715
Tejun Heo7c3eed52013-01-24 11:01:33 -0800716/**
717 * get_work_pool - return the worker_pool a given work was associated with
718 * @work: the work item of interest
719 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700720 * Pools are created and destroyed under wq_pool_mutex, and allows read
721 * access under sched-RCU read lock. As such, this function should be
722 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700723 *
724 * All fields of the returned pool are accessible as long as the above
725 * mentioned locking is in effect. If the returned pool needs to be used
726 * beyond the critical section, the caller is responsible for ensuring the
727 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700728 *
729 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800730 */
731static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200732{
Tejun Heoe1201532010-07-22 14:14:25 +0200733 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800734 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200735
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700736 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700737
Tejun Heo112202d2013-02-13 19:29:12 -0800738 if (data & WORK_STRUCT_PWQ)
739 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800740 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200741
Tejun Heo7c3eed52013-01-24 11:01:33 -0800742 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
743 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200744 return NULL;
745
Tejun Heofa1b54e2013-03-12 11:30:00 -0700746 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800747}
748
749/**
750 * get_work_pool_id - return the worker pool ID a given work is associated with
751 * @work: the work item of interest
752 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700753 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800754 * %WORK_OFFQ_POOL_NONE if none.
755 */
756static int get_work_pool_id(struct work_struct *work)
757{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800758 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800759
Tejun Heo112202d2013-02-13 19:29:12 -0800760 if (data & WORK_STRUCT_PWQ)
761 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800762 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
763
764 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800765}
766
Tejun Heobbb68df2012-08-03 10:30:46 -0700767static void mark_work_canceling(struct work_struct *work)
768{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800769 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700770
Tejun Heo7c3eed52013-01-24 11:01:33 -0800771 pool_id <<= WORK_OFFQ_POOL_SHIFT;
772 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700773}
774
775static bool work_is_canceling(struct work_struct *work)
776{
777 unsigned long data = atomic_long_read(&work->data);
778
Tejun Heo112202d2013-02-13 19:29:12 -0800779 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700780}
781
David Howells365970a2006-11-22 14:54:49 +0000782/*
Tejun Heo32704762012-07-13 22:16:45 -0700783 * Policy functions. These define the policies on how the global worker
784 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800785 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000786 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200787
Tejun Heo63d95a92012-07-12 14:46:37 -0700788static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000789{
Tejun Heoe19e3972013-01-24 11:39:44 -0800790 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000791}
792
Tejun Heoe22bee72010-06-29 10:07:14 +0200793/*
794 * Need to wake up a worker? Called from anything but currently
795 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700796 *
797 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800798 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700799 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200800 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700801static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000802{
Tejun Heo63d95a92012-07-12 14:46:37 -0700803 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000804}
805
Tejun Heoe22bee72010-06-29 10:07:14 +0200806/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700807static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200808{
Tejun Heo63d95a92012-07-12 14:46:37 -0700809 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200810}
811
812/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700813static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200814{
Tejun Heoe19e3972013-01-24 11:39:44 -0800815 return !list_empty(&pool->worklist) &&
816 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200817}
818
819/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700820static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200821{
Tejun Heo63d95a92012-07-12 14:46:37 -0700822 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200823}
824
Tejun Heoe22bee72010-06-29 10:07:14 +0200825/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700826static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200827{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700828 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700829 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
830 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200831
832 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
833}
834
835/*
836 * Wake up functions.
837 */
838
Lai Jiangshan1037de32014-05-22 16:44:07 +0800839/* Return the first idle worker. Safe with preemption disabled */
840static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200841{
Tejun Heo63d95a92012-07-12 14:46:37 -0700842 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200843 return NULL;
844
Tejun Heo63d95a92012-07-12 14:46:37 -0700845 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200846}
847
848/**
849 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700850 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200851 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700852 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200853 *
854 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800855 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200856 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700857static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200858{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800859 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200860
861 if (likely(worker))
862 wake_up_process(worker->task);
863}
864
Tejun Heo4690c4a2010-06-29 10:07:10 +0200865/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200866 * wq_worker_waking_up - a worker is waking up
867 * @task: task waking up
868 * @cpu: CPU @task is waking up to
869 *
870 * This function is called during try_to_wake_up() when a worker is
871 * being awoken.
872 *
873 * CONTEXT:
874 * spin_lock_irq(rq->lock)
875 */
Tejun Heod84ff052013-03-12 11:29:59 -0700876void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200877{
878 struct worker *worker = kthread_data(task);
879
Joonsoo Kim36576002012-10-26 23:03:49 +0900880 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800881 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800882 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900883 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200884}
885
886/**
887 * wq_worker_sleeping - a worker is going to sleep
888 * @task: task going to sleep
889 * @cpu: CPU in question, must be the current CPU number
890 *
891 * This function is called during schedule() when a busy worker is
892 * going to sleep. Worker on the same cpu can be woken up by
893 * returning pointer to its task.
894 *
895 * CONTEXT:
896 * spin_lock_irq(rq->lock)
897 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700898 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200899 * Worker task on @cpu to wake up, %NULL if none.
900 */
Tejun Heod84ff052013-03-12 11:29:59 -0700901struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200902{
903 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800904 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200905
Tejun Heo111c2252013-01-17 17:16:24 -0800906 /*
907 * Rescuers, which may not have all the fields set up like normal
908 * workers, also reach here, let's not access anything before
909 * checking NOT_RUNNING.
910 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500911 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200912 return NULL;
913
Tejun Heo111c2252013-01-17 17:16:24 -0800914 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800915
Tejun Heoe22bee72010-06-29 10:07:14 +0200916 /* this can only happen on the local cpu */
Lai Jiangshan92b69f52014-06-03 15:33:08 +0800917 if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu))
Tejun Heo6183c002013-03-12 11:29:57 -0700918 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200919
920 /*
921 * The counterpart of the following dec_and_test, implied mb,
922 * worklist not empty test sequence is in insert_work().
923 * Please read comment there.
924 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700925 * NOT_RUNNING is clear. This means that we're bound to and
926 * running on the local cpu w/ rq lock held and preemption
927 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800928 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700929 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200930 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800931 if (atomic_dec_and_test(&pool->nr_running) &&
932 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800933 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200934 return to_wakeup ? to_wakeup->task : NULL;
935}
936
937/**
938 * 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();
Tejun Heo36e227d2012-08-03 10:30:46 -07001302 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001303}
1304
1305/**
Tejun Heo706026c2013-01-24 11:01:34 -08001306 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001307 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001308 * @work: work to insert
1309 * @head: insertion point
1310 * @extra_flags: extra WORK_STRUCT_* flags to set
1311 *
Tejun Heo112202d2013-02-13 19:29:12 -08001312 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001313 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001314 *
1315 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001316 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001317 */
Tejun Heo112202d2013-02-13 19:29:12 -08001318static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1319 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001320{
Tejun Heo112202d2013-02-13 19:29:12 -08001321 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001322
Tejun Heo4690c4a2010-06-29 10:07:10 +02001323 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001324 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001325 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001326 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001327
1328 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001329 * Ensure either wq_worker_sleeping() sees the above
1330 * list_add_tail() or we see zero nr_running to avoid workers lying
1331 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001332 */
1333 smp_mb();
1334
Tejun Heo63d95a92012-07-12 14:46:37 -07001335 if (__need_more_worker(pool))
1336 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001337}
1338
Tejun Heoc8efcc22010-12-20 19:32:04 +01001339/*
1340 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001341 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001342 */
1343static bool is_chained_work(struct workqueue_struct *wq)
1344{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001345 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001346
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001347 worker = current_wq_worker();
1348 /*
1349 * Return %true iff I'm a worker execuing a work item on @wq. If
1350 * I'm @worker, it's safe to dereference it without locking.
1351 */
Tejun Heo112202d2013-02-13 19:29:12 -08001352 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001353}
1354
Mike Galbraithef5571802016-02-09 17:59:38 -05001355/*
1356 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1357 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1358 * avoid perturbing sensitive tasks.
1359 */
1360static int wq_select_unbound_cpu(int cpu)
1361{
Tejun Heof303fcc2016-02-09 17:59:38 -05001362 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001363 int new_cpu;
1364
Tejun Heof303fcc2016-02-09 17:59:38 -05001365 if (likely(!wq_debug_force_rr_cpu)) {
1366 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1367 return cpu;
1368 } else if (!printed_dbg_warning) {
1369 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1370 printed_dbg_warning = true;
1371 }
1372
Mike Galbraithef5571802016-02-09 17:59:38 -05001373 if (cpumask_empty(wq_unbound_cpumask))
1374 return cpu;
1375
1376 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1377 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1378 if (unlikely(new_cpu >= nr_cpu_ids)) {
1379 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1380 if (unlikely(new_cpu >= nr_cpu_ids))
1381 return cpu;
1382 }
1383 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1384
1385 return new_cpu;
1386}
1387
Tejun Heod84ff052013-03-12 11:29:59 -07001388static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 struct work_struct *work)
1390{
Tejun Heo112202d2013-02-13 19:29:12 -08001391 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001392 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001393 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001394 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001395 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001396
1397 /*
1398 * While a work item is PENDING && off queue, a task trying to
1399 * steal the PENDING will busy-loop waiting for it to either get
1400 * queued or lose PENDING. Grabbing PENDING and queueing should
1401 * happen with IRQ disabled.
1402 */
1403 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001405 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001406
Li Bin9ef28a72013-09-09 13:13:58 +08001407 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001408 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001409 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001410 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001411retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001412 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001413 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001414
Tejun Heoc9178082013-03-12 11:30:04 -07001415 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001416 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001417 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001418 else
1419 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001420
Tejun Heoc9178082013-03-12 11:30:04 -07001421 /*
1422 * If @work was previously on a different pool, it might still be
1423 * running there, in which case the work needs to be queued on that
1424 * pool to guarantee non-reentrancy.
1425 */
1426 last_pool = get_work_pool(work);
1427 if (last_pool && last_pool != pwq->pool) {
1428 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001429
Tejun Heoc9178082013-03-12 11:30:04 -07001430 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001431
Tejun Heoc9178082013-03-12 11:30:04 -07001432 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001433
Tejun Heoc9178082013-03-12 11:30:04 -07001434 if (worker && worker->current_pwq->wq == wq) {
1435 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001436 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001437 /* meh... not running there, queue here */
1438 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001439 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001440 }
Tejun Heof3421792010-07-02 10:03:51 +02001441 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001442 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001443 }
1444
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001445 /*
1446 * pwq is determined and locked. For unbound pools, we could have
1447 * raced with pwq release and it could already be dead. If its
1448 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001449 * without another pwq replacing it in the numa_pwq_tbl or while
1450 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001451 * make forward-progress.
1452 */
1453 if (unlikely(!pwq->refcnt)) {
1454 if (wq->flags & WQ_UNBOUND) {
1455 spin_unlock(&pwq->pool->lock);
1456 cpu_relax();
1457 goto retry;
1458 }
1459 /* oops */
1460 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1461 wq->name, cpu);
1462 }
1463
Tejun Heo112202d2013-02-13 19:29:12 -08001464 /* pwq determined, queue */
1465 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001466
Dan Carpenterf5b25522012-04-13 22:06:58 +03001467 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001468 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001469 return;
1470 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001471
Tejun Heo112202d2013-02-13 19:29:12 -08001472 pwq->nr_in_flight[pwq->work_color]++;
1473 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001474
Tejun Heo112202d2013-02-13 19:29:12 -08001475 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001476 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001477 pwq->nr_active++;
1478 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001479 if (list_empty(worklist))
1480 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001481 } else {
1482 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001483 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001484 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001485
Tejun Heo112202d2013-02-13 19:29:12 -08001486 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001487
Tejun Heo112202d2013-02-13 19:29:12 -08001488 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489}
1490
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001491/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001492 * queue_work_on - queue work on specific cpu
1493 * @cpu: CPU number to execute work on
1494 * @wq: workqueue to use
1495 * @work: work to queue
1496 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001497 * We queue the work to a specific CPU, the caller must ensure it
1498 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001499 *
1500 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001501 */
Tejun Heod4283e92012-08-03 10:30:44 -07001502bool queue_work_on(int cpu, struct workqueue_struct *wq,
1503 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001504{
Tejun Heod4283e92012-08-03 10:30:44 -07001505 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001506 unsigned long flags;
1507
1508 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001509
Tejun Heo22df02b2010-06-29 10:07:10 +02001510 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001511 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001512 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001513 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001514
1515 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001516 return ret;
1517}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001518EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001519
Tejun Heod8e794d2012-08-03 10:30:45 -07001520void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521{
David Howells52bad642006-11-22 14:54:01 +00001522 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001524 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001525 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001527EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001529static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1530 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001532 struct timer_list *timer = &dwork->timer;
1533 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001535 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1536 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001537 WARN_ON_ONCE(timer_pending(timer));
1538 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001539
Tejun Heo8852aac2012-12-01 16:23:42 -08001540 /*
1541 * If @delay is 0, queue @dwork->work immediately. This is for
1542 * both optimization and correctness. The earliest @timer can
1543 * expire is on the closest next tick and delayed_work users depend
1544 * on that there's no such delay when @delay is 0.
1545 */
1546 if (!delay) {
1547 __queue_work(cpu, wq, &dwork->work);
1548 return;
1549 }
1550
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001551 timer_stats_timer_set_start_info(&dwork->timer);
1552
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001553 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001554 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001555 timer->expires = jiffies + delay;
1556
Tejun Heo041bd122016-02-09 16:11:26 -05001557 if (unlikely(cpu != WORK_CPU_UNBOUND))
1558 add_timer_on(timer, cpu);
1559 else
1560 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561}
1562
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001563/**
1564 * queue_delayed_work_on - queue work on specific CPU after delay
1565 * @cpu: CPU number to execute work on
1566 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001567 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001568 * @delay: number of jiffies to wait before queueing
1569 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001570 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001571 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1572 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001573 */
Tejun Heod4283e92012-08-03 10:30:44 -07001574bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1575 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001576{
David Howells52bad642006-11-22 14:54:01 +00001577 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001578 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001579 unsigned long flags;
1580
1581 /* read the comment in __queue_work() */
1582 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001583
Tejun Heo22df02b2010-06-29 10:07:10 +02001584 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001585 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001586 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001587 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001588
1589 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001590 return ret;
1591}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001592EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593
Tejun Heoc8e55f32010-06-29 10:07:12 +02001594/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001595 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1596 * @cpu: CPU number to execute work on
1597 * @wq: workqueue to use
1598 * @dwork: work to queue
1599 * @delay: number of jiffies to wait before queueing
1600 *
1601 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1602 * modify @dwork's timer so that it expires after @delay. If @delay is
1603 * zero, @work is guaranteed to be scheduled immediately regardless of its
1604 * current state.
1605 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001606 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001607 * pending and its timer was modified.
1608 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001609 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001610 * See try_to_grab_pending() for details.
1611 */
1612bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1613 struct delayed_work *dwork, unsigned long delay)
1614{
1615 unsigned long flags;
1616 int ret;
1617
1618 do {
1619 ret = try_to_grab_pending(&dwork->work, true, &flags);
1620 } while (unlikely(ret == -EAGAIN));
1621
1622 if (likely(ret >= 0)) {
1623 __queue_delayed_work(cpu, wq, dwork, delay);
1624 local_irq_restore(flags);
1625 }
1626
1627 /* -ENOENT from try_to_grab_pending() becomes %true */
1628 return ret;
1629}
1630EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1631
1632/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001633 * worker_enter_idle - enter idle state
1634 * @worker: worker which is entering idle state
1635 *
1636 * @worker is entering idle state. Update stats and idle timer if
1637 * necessary.
1638 *
1639 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001640 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001641 */
1642static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001644 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645
Tejun Heo6183c002013-03-12 11:29:57 -07001646 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1647 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1648 (worker->hentry.next || worker->hentry.pprev)))
1649 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Lai Jiangshan051e1852014-07-22 13:03:02 +08001651 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001652 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001653 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001654 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001655
Tejun Heoc8e55f32010-06-29 10:07:12 +02001656 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001657 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001658
Tejun Heo628c78e2012-07-17 12:39:27 -07001659 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1660 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001661
Tejun Heo544ecf32012-05-14 15:04:50 -07001662 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001663 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001664 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001665 * nr_running, the warning may trigger spuriously. Check iff
1666 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001667 */
Tejun Heo24647572013-01-24 11:01:33 -08001668 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001669 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001670 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671}
1672
Tejun Heoc8e55f32010-06-29 10:07:12 +02001673/**
1674 * worker_leave_idle - leave idle state
1675 * @worker: worker which is leaving idle state
1676 *
1677 * @worker is leaving idle state. Update stats.
1678 *
1679 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001680 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001681 */
1682static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001684 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685
Tejun Heo6183c002013-03-12 11:29:57 -07001686 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1687 return;
Tejun Heod302f012010-06-29 10:07:13 +02001688 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001689 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001690 list_del_init(&worker->entry);
1691}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001693static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001694{
1695 struct worker *worker;
1696
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001697 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001698 if (worker) {
1699 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001700 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001701 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001702 /* on creation a worker is in !idle && prep state */
1703 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001704 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001705 return worker;
1706}
1707
1708/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001709 * worker_attach_to_pool() - attach a worker to a pool
1710 * @worker: worker to be attached
1711 * @pool: the target pool
1712 *
1713 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1714 * cpu-binding of @worker are kept coordinated with the pool across
1715 * cpu-[un]hotplugs.
1716 */
1717static void worker_attach_to_pool(struct worker *worker,
1718 struct worker_pool *pool)
1719{
1720 mutex_lock(&pool->attach_mutex);
1721
1722 /*
1723 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1724 * online CPUs. It'll be re-applied when any of the CPUs come up.
1725 */
1726 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1727
1728 /*
1729 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1730 * stable across this function. See the comments above the
1731 * flag definition for details.
1732 */
1733 if (pool->flags & POOL_DISASSOCIATED)
1734 worker->flags |= WORKER_UNBOUND;
1735
1736 list_add_tail(&worker->node, &pool->workers);
1737
1738 mutex_unlock(&pool->attach_mutex);
1739}
1740
1741/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001742 * worker_detach_from_pool() - detach a worker from its pool
1743 * @worker: worker which is attached to its pool
1744 * @pool: the pool @worker is attached to
1745 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001746 * Undo the attaching which had been done in worker_attach_to_pool(). The
1747 * caller worker shouldn't access to the pool after detached except it has
1748 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001749 */
1750static void worker_detach_from_pool(struct worker *worker,
1751 struct worker_pool *pool)
1752{
1753 struct completion *detach_completion = NULL;
1754
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001755 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001756 list_del(&worker->node);
1757 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001758 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001759 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001760
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001761 /* clear leftover flags without pool->lock after it is detached */
1762 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1763
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001764 if (detach_completion)
1765 complete(detach_completion);
1766}
1767
1768/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001769 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001770 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001771 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001772 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001773 *
1774 * CONTEXT:
1775 * Might sleep. Does GFP_KERNEL allocations.
1776 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001777 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001778 * Pointer to the newly created worker.
1779 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001780static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001781{
Tejun Heoc34056a2010-06-29 10:07:11 +02001782 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001783 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001784 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001785
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001786 /* ID is needed to determine kthread name */
1787 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001788 if (id < 0)
1789 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001790
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001791 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001792 if (!worker)
1793 goto fail;
1794
Tejun Heobd7bdd42012-07-12 14:46:37 -07001795 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001796 worker->id = id;
1797
Tejun Heo29c91e92013-03-12 11:30:03 -07001798 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001799 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1800 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001801 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001802 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1803
Tejun Heof3f90ad2013-04-01 11:23:34 -07001804 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001805 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001806 if (IS_ERR(worker->task))
1807 goto fail;
1808
Oleg Nesterov91151222013-11-14 12:56:18 +01001809 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001810 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001811
Lai Jiangshanda028462014-05-20 17:46:31 +08001812 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001813 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001814
Lai Jiangshan051e1852014-07-22 13:03:02 +08001815 /* start the newly created worker */
1816 spin_lock_irq(&pool->lock);
1817 worker->pool->nr_workers++;
1818 worker_enter_idle(worker);
1819 wake_up_process(worker->task);
1820 spin_unlock_irq(&pool->lock);
1821
Tejun Heoc34056a2010-06-29 10:07:11 +02001822 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001823
Tejun Heoc34056a2010-06-29 10:07:11 +02001824fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001825 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001826 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001827 kfree(worker);
1828 return NULL;
1829}
1830
1831/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001832 * destroy_worker - destroy a workqueue worker
1833 * @worker: worker to be destroyed
1834 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001835 * Destroy @worker and adjust @pool stats accordingly. The worker should
1836 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001837 *
1838 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001839 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001840 */
1841static void destroy_worker(struct worker *worker)
1842{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001843 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001844
Tejun Heocd549682013-03-13 19:47:39 -07001845 lockdep_assert_held(&pool->lock);
1846
Tejun Heoc34056a2010-06-29 10:07:11 +02001847 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001848 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001849 WARN_ON(!list_empty(&worker->scheduled)) ||
1850 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001851 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001852
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001853 pool->nr_workers--;
1854 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001855
Tejun Heoc8e55f32010-06-29 10:07:12 +02001856 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001857 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001858 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001859}
1860
Tejun Heo63d95a92012-07-12 14:46:37 -07001861static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001862{
Tejun Heo63d95a92012-07-12 14:46:37 -07001863 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001864
Tejun Heod565ed62013-01-24 11:01:33 -08001865 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001866
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001867 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001868 struct worker *worker;
1869 unsigned long expires;
1870
1871 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001872 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001873 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1874
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001875 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001876 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001877 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001878 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001879
1880 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001881 }
1882
Tejun Heod565ed62013-01-24 11:01:33 -08001883 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001884}
1885
Tejun Heo493a1722013-03-12 11:29:59 -07001886static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001887{
Tejun Heo112202d2013-02-13 19:29:12 -08001888 struct pool_workqueue *pwq = get_work_pwq(work);
1889 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001890
Tejun Heo2e109a22013-03-13 19:47:40 -07001891 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001892
Tejun Heo493008a2013-03-12 11:30:03 -07001893 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001894 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001895
1896 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001897 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001898 /*
1899 * If @pwq is for an unbound wq, its base ref may be put at
1900 * any time due to an attribute change. Pin @pwq until the
1901 * rescuer is done with it.
1902 */
1903 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001904 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001905 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001906 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001907}
1908
Tejun Heo706026c2013-01-24 11:01:34 -08001909static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001910{
Tejun Heo63d95a92012-07-12 14:46:37 -07001911 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001912 struct work_struct *work;
1913
Tejun Heob2d82902014-12-08 12:39:16 -05001914 spin_lock_irq(&pool->lock);
1915 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001916
Tejun Heo63d95a92012-07-12 14:46:37 -07001917 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001918 /*
1919 * We've been trying to create a new worker but
1920 * haven't been successful. We might be hitting an
1921 * allocation deadlock. Send distress signals to
1922 * rescuers.
1923 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001924 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001925 send_mayday(work);
1926 }
1927
Tejun Heob2d82902014-12-08 12:39:16 -05001928 spin_unlock(&wq_mayday_lock);
1929 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001930
Tejun Heo63d95a92012-07-12 14:46:37 -07001931 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001932}
1933
1934/**
1935 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001936 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001937 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001938 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001939 * have at least one idle worker on return from this function. If
1940 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001941 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001942 * possible allocation deadlock.
1943 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001944 * On return, need_to_create_worker() is guaranteed to be %false and
1945 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001946 *
1947 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001948 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001949 * multiple times. Does GFP_KERNEL allocations. Called only from
1950 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001951 */
Tejun Heo29187a92015-01-16 14:21:16 -05001952static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001953__releases(&pool->lock)
1954__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001955{
Tejun Heoe22bee72010-06-29 10:07:14 +02001956restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001957 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001958
Tejun Heoe22bee72010-06-29 10:07:14 +02001959 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001960 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001961
1962 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001963 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001964 break;
1965
Lai Jiangshane212f362014-06-03 15:32:17 +08001966 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001967
Tejun Heo63d95a92012-07-12 14:46:37 -07001968 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001969 break;
1970 }
1971
Tejun Heo63d95a92012-07-12 14:46:37 -07001972 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001973 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001974 /*
1975 * This is necessary even after a new worker was just successfully
1976 * created as @pool->lock was dropped and the new worker might have
1977 * already become busy.
1978 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001979 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001980 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001981}
1982
1983/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001984 * manage_workers - manage worker pool
1985 * @worker: self
1986 *
Tejun Heo706026c2013-01-24 11:01:34 -08001987 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001988 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001989 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001990 *
1991 * The caller can safely start processing works on false return. On
1992 * true return, it's guaranteed that need_to_create_worker() is false
1993 * and may_start_working() is true.
1994 *
1995 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001996 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 * multiple times. Does GFP_KERNEL allocations.
1998 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001999 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002000 * %false if the pool doesn't need management and the caller can safely
2001 * start processing works, %true if management function was performed and
2002 * the conditions that the caller verified before calling the function may
2003 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002004 */
2005static bool manage_workers(struct worker *worker)
2006{
Tejun Heo63d95a92012-07-12 14:46:37 -07002007 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002008
Tejun Heobc3a1af2013-03-13 19:47:39 -07002009 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07002010 * Anyone who successfully grabs manager_arb wins the arbitration
2011 * and becomes the manager. mutex_trylock() on pool->manager_arb
2012 * failure while holding pool->lock reliably indicates that someone
2013 * else is managing the pool and the worker which failed trylock
2014 * can proceed to executing work items. This means that anyone
2015 * grabbing manager_arb is responsible for actually performing
2016 * manager duties. If manager_arb is grabbed and released without
2017 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07002018 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07002019 if (!mutex_trylock(&pool->manager_arb))
Tejun Heo29187a92015-01-16 14:21:16 -05002020 return false;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002021 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002022
Tejun Heo29187a92015-01-16 14:21:16 -05002023 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002024
Tejun Heo2607d7a2015-03-09 09:22:28 -04002025 pool->manager = NULL;
Tejun Heo34a06bd2013-03-12 11:30:00 -07002026 mutex_unlock(&pool->manager_arb);
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);
2138 dump_stack();
2139 }
2140
Tejun Heob22ce272013-08-28 17:33:37 -04002141 /*
2142 * The following prevents a kworker from hogging CPU on !PREEMPT
2143 * kernels, where a requeueing work item waiting for something to
2144 * happen could deadlock with stop_machine as such work item could
2145 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002146 * stop_machine. At the same time, report a quiescent RCU state so
2147 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002148 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002149 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002150
Tejun Heod565ed62013-01-24 11:01:33 -08002151 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002152
Tejun Heofb0e7be2010-06-29 10:07:15 +02002153 /* clear cpu intensive status */
2154 if (unlikely(cpu_intensive))
2155 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2156
Tejun Heoa62428c2010-06-29 10:07:10 +02002157 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002158 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002159 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002160 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002161 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002162 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002163 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002164}
2165
Tejun Heoaffee4b2010-06-29 10:07:12 +02002166/**
2167 * process_scheduled_works - process scheduled works
2168 * @worker: self
2169 *
2170 * Process all scheduled works. Please note that the scheduled list
2171 * may change while processing a work, so this function repeatedly
2172 * fetches a work from the top and executes it.
2173 *
2174 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002175 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002176 * multiple times.
2177 */
2178static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002180 while (!list_empty(&worker->scheduled)) {
2181 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002183 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185}
2186
Tejun Heo4690c4a2010-06-29 10:07:10 +02002187/**
2188 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002189 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002190 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002191 * The worker thread function. All workers belong to a worker_pool -
2192 * either a per-cpu one or dynamic unbound one. These workers process all
2193 * work items regardless of their specific target workqueue. The only
2194 * exception is work items which belong to workqueues with a rescuer which
2195 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002196 *
2197 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002198 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002199static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200{
Tejun Heoc34056a2010-06-29 10:07:11 +02002201 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002202 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203
Tejun Heoe22bee72010-06-29 10:07:14 +02002204 /* tell the scheduler that this is a workqueue worker */
2205 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002206woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002207 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002208
Tejun Heoa9ab7752013-03-19 13:45:21 -07002209 /* am I supposed to die? */
2210 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002211 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002212 WARN_ON_ONCE(!list_empty(&worker->entry));
2213 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002214
2215 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002216 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002217 worker_detach_from_pool(worker, pool);
2218 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002219 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002221
Tejun Heoc8e55f32010-06-29 10:07:12 +02002222 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002223recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002224 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002225 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002226 goto sleep;
2227
2228 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002229 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002230 goto recheck;
2231
Tejun Heoc8e55f32010-06-29 10:07:12 +02002232 /*
2233 * ->scheduled list can only be filled while a worker is
2234 * preparing to process a work or actually processing it.
2235 * Make sure nobody diddled with it while I was sleeping.
2236 */
Tejun Heo6183c002013-03-12 11:29:57 -07002237 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002238
Tejun Heoe22bee72010-06-29 10:07:14 +02002239 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002240 * Finish PREP stage. We're guaranteed to have at least one idle
2241 * worker or that someone else has already assumed the manager
2242 * role. This is where @worker starts participating in concurrency
2243 * management if applicable and concurrency management is restored
2244 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002245 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002246 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002247
2248 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002249 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002250 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002251 struct work_struct, entry);
2252
Tejun Heo82607adc2015-12-08 11:28:04 -05002253 pool->watchdog_ts = jiffies;
2254
Tejun Heoc8e55f32010-06-29 10:07:12 +02002255 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2256 /* optimization path, not strictly necessary */
2257 process_one_work(worker, work);
2258 if (unlikely(!list_empty(&worker->scheduled)))
2259 process_scheduled_works(worker);
2260 } else {
2261 move_linked_works(work, &worker->scheduled, NULL);
2262 process_scheduled_works(worker);
2263 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002264 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002265
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002266 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002267sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002268 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002269 * pool->lock is held and there's no work to process and no need to
2270 * manage, sleep. Workers are woken up only while holding
2271 * pool->lock or from local cpu, so setting the current state
2272 * before releasing pool->lock is enough to prevent losing any
2273 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002274 */
2275 worker_enter_idle(worker);
2276 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002277 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002278 schedule();
2279 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280}
2281
Tejun Heoe22bee72010-06-29 10:07:14 +02002282/**
2283 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002284 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002285 *
2286 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002287 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002288 *
Tejun Heo706026c2013-01-24 11:01:34 -08002289 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002290 * worker which uses GFP_KERNEL allocation which has slight chance of
2291 * developing into deadlock if some works currently on the same queue
2292 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2293 * the problem rescuer solves.
2294 *
Tejun Heo706026c2013-01-24 11:01:34 -08002295 * When such condition is possible, the pool summons rescuers of all
2296 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002297 * those works so that forward progress can be guaranteed.
2298 *
2299 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002300 *
2301 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002302 */
Tejun Heo111c2252013-01-17 17:16:24 -08002303static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002304{
Tejun Heo111c2252013-01-17 17:16:24 -08002305 struct worker *rescuer = __rescuer;
2306 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002307 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002308 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002309
2310 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002311
2312 /*
2313 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2314 * doesn't participate in concurrency management.
2315 */
2316 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002317repeat:
2318 set_current_state(TASK_INTERRUPTIBLE);
2319
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002320 /*
2321 * By the time the rescuer is requested to stop, the workqueue
2322 * shouldn't have any work pending, but @wq->maydays may still have
2323 * pwq(s) queued. This can happen by non-rescuer workers consuming
2324 * all the work items before the rescuer got to them. Go through
2325 * @wq->maydays processing before acting on should_stop so that the
2326 * list is always empty on exit.
2327 */
2328 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002329
Tejun Heo493a1722013-03-12 11:29:59 -07002330 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002331 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002332
2333 while (!list_empty(&wq->maydays)) {
2334 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2335 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002336 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002337 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002338 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002339
2340 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002341 list_del_init(&pwq->mayday_node);
2342
Tejun Heo2e109a22013-03-13 19:47:40 -07002343 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002344
Lai Jiangshan51697d392014-05-20 17:46:36 +08002345 worker_attach_to_pool(rescuer, pool);
2346
2347 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002348 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002349
2350 /*
2351 * Slurp in all works issued via this workqueue and
2352 * process'em.
2353 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002354 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002355 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2356 if (get_work_pwq(work) == pwq) {
2357 if (first)
2358 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002359 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002360 }
2361 first = false;
2362 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002363
NeilBrown008847f2014-12-08 12:39:16 -05002364 if (!list_empty(scheduled)) {
2365 process_scheduled_works(rescuer);
2366
2367 /*
2368 * The above execution of rescued work items could
2369 * have created more to rescue through
2370 * pwq_activate_first_delayed() or chained
2371 * queueing. Let's put @pwq back on mayday list so
2372 * that such back-to-back work items, which may be
2373 * being used to relieve memory pressure, don't
2374 * incur MAYDAY_INTERVAL delay inbetween.
2375 */
2376 if (need_to_create_worker(pool)) {
2377 spin_lock(&wq_mayday_lock);
2378 get_pwq(pwq);
2379 list_move_tail(&pwq->mayday_node, &wq->maydays);
2380 spin_unlock(&wq_mayday_lock);
2381 }
2382 }
Tejun Heo75769582011-02-14 14:04:46 +01002383
2384 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002385 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002386 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002387 */
2388 put_pwq(pwq);
2389
2390 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002391 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002392 * regular worker; otherwise, we end up with 0 concurrency
2393 * and stalling the execution.
2394 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002395 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002396 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002397
Lai Jiangshanb3104102013-02-19 12:17:02 -08002398 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002399 spin_unlock_irq(&pool->lock);
2400
2401 worker_detach_from_pool(rescuer, pool);
2402
2403 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002404 }
2405
Tejun Heo2e109a22013-03-13 19:47:40 -07002406 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002407
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002408 if (should_stop) {
2409 __set_current_state(TASK_RUNNING);
2410 rescuer->task->flags &= ~PF_WQ_WORKER;
2411 return 0;
2412 }
2413
Tejun Heo111c2252013-01-17 17:16:24 -08002414 /* rescuers should never participate in concurrency management */
2415 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002416 schedule();
2417 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418}
2419
Tejun Heofca839c2015-12-07 10:58:57 -05002420/**
2421 * check_flush_dependency - check for flush dependency sanity
2422 * @target_wq: workqueue being flushed
2423 * @target_work: work item being flushed (NULL for workqueue flushes)
2424 *
2425 * %current is trying to flush the whole @target_wq or @target_work on it.
2426 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2427 * reclaiming memory or running on a workqueue which doesn't have
2428 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2429 * a deadlock.
2430 */
2431static void check_flush_dependency(struct workqueue_struct *target_wq,
2432 struct work_struct *target_work)
2433{
2434 work_func_t target_func = target_work ? target_work->func : NULL;
2435 struct worker *worker;
2436
2437 if (target_wq->flags & WQ_MEM_RECLAIM)
2438 return;
2439
2440 worker = current_wq_worker();
2441
2442 WARN_ONCE(current->flags & PF_MEMALLOC,
2443 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2444 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002445 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2446 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002447 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2448 worker->current_pwq->wq->name, worker->current_func,
2449 target_wq->name, target_func);
2450}
2451
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002452struct wq_barrier {
2453 struct work_struct work;
2454 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002455 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002456};
2457
2458static void wq_barrier_func(struct work_struct *work)
2459{
2460 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2461 complete(&barr->done);
2462}
2463
Tejun Heo4690c4a2010-06-29 10:07:10 +02002464/**
2465 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002466 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002467 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002468 * @target: target work to attach @barr to
2469 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002470 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002471 * @barr is linked to @target such that @barr is completed only after
2472 * @target finishes execution. Please note that the ordering
2473 * guarantee is observed only with respect to @target and on the local
2474 * cpu.
2475 *
2476 * Currently, a queued barrier can't be canceled. This is because
2477 * try_to_grab_pending() can't determine whether the work to be
2478 * grabbed is at the head of the queue and thus can't clear LINKED
2479 * flag of the previous work while there must be a valid next work
2480 * after a work with LINKED flag set.
2481 *
2482 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002483 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002484 *
2485 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002486 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002487 */
Tejun Heo112202d2013-02-13 19:29:12 -08002488static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002489 struct wq_barrier *barr,
2490 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002491{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002492 struct list_head *head;
2493 unsigned int linked = 0;
2494
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002495 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002496 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002497 * as we know for sure that this will not trigger any of the
2498 * checks and call back into the fixup functions where we
2499 * might deadlock.
2500 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002501 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002502 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002503 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002504 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002505
Tejun Heoaffee4b2010-06-29 10:07:12 +02002506 /*
2507 * If @target is currently being executed, schedule the
2508 * barrier to the worker; otherwise, put it after @target.
2509 */
2510 if (worker)
2511 head = worker->scheduled.next;
2512 else {
2513 unsigned long *bits = work_data_bits(target);
2514
2515 head = target->entry.next;
2516 /* there can already be other linked works, inherit and set */
2517 linked = *bits & WORK_STRUCT_LINKED;
2518 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2519 }
2520
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002521 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002522 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002523 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002524}
2525
Tejun Heo73f53c42010-06-29 10:07:11 +02002526/**
Tejun Heo112202d2013-02-13 19:29:12 -08002527 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002528 * @wq: workqueue being flushed
2529 * @flush_color: new flush color, < 0 for no-op
2530 * @work_color: new work color, < 0 for no-op
2531 *
Tejun Heo112202d2013-02-13 19:29:12 -08002532 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002533 *
Tejun Heo112202d2013-02-13 19:29:12 -08002534 * If @flush_color is non-negative, flush_color on all pwqs should be
2535 * -1. If no pwq has in-flight commands at the specified color, all
2536 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2537 * has in flight commands, its pwq->flush_color is set to
2538 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002539 * wakeup logic is armed and %true is returned.
2540 *
2541 * The caller should have initialized @wq->first_flusher prior to
2542 * calling this function with non-negative @flush_color. If
2543 * @flush_color is negative, no flush color update is done and %false
2544 * is returned.
2545 *
Tejun Heo112202d2013-02-13 19:29:12 -08002546 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002547 * work_color which is previous to @work_color and all will be
2548 * advanced to @work_color.
2549 *
2550 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002551 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002552 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002553 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002554 * %true if @flush_color >= 0 and there's something to flush. %false
2555 * otherwise.
2556 */
Tejun Heo112202d2013-02-13 19:29:12 -08002557static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002558 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559{
Tejun Heo73f53c42010-06-29 10:07:11 +02002560 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002561 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002562
Tejun Heo73f53c42010-06-29 10:07:11 +02002563 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002564 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002565 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002566 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002567
Tejun Heo49e3cf42013-03-12 11:29:58 -07002568 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002569 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002570
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002571 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002572
2573 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002574 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002575
Tejun Heo112202d2013-02-13 19:29:12 -08002576 if (pwq->nr_in_flight[flush_color]) {
2577 pwq->flush_color = flush_color;
2578 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002579 wait = true;
2580 }
2581 }
2582
2583 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002584 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002585 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002586 }
2587
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002588 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002589 }
2590
Tejun Heo112202d2013-02-13 19:29:12 -08002591 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002592 complete(&wq->first_flusher->done);
2593
2594 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595}
2596
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002597/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002599 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002601 * This function sleeps until all work items which were queued on entry
2602 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002604void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605{
Tejun Heo73f53c42010-06-29 10:07:11 +02002606 struct wq_flusher this_flusher = {
2607 .list = LIST_HEAD_INIT(this_flusher.list),
2608 .flush_color = -1,
2609 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2610 };
2611 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002612
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002613 lock_map_acquire(&wq->lockdep_map);
2614 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002615
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002616 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002617
2618 /*
2619 * Start-to-wait phase
2620 */
2621 next_color = work_next_color(wq->work_color);
2622
2623 if (next_color != wq->flush_color) {
2624 /*
2625 * Color space is not full. The current work_color
2626 * becomes our flush_color and work_color is advanced
2627 * by one.
2628 */
Tejun Heo6183c002013-03-12 11:29:57 -07002629 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002630 this_flusher.flush_color = wq->work_color;
2631 wq->work_color = next_color;
2632
2633 if (!wq->first_flusher) {
2634 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002635 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002636
2637 wq->first_flusher = &this_flusher;
2638
Tejun Heo112202d2013-02-13 19:29:12 -08002639 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002640 wq->work_color)) {
2641 /* nothing to flush, done */
2642 wq->flush_color = next_color;
2643 wq->first_flusher = NULL;
2644 goto out_unlock;
2645 }
2646 } else {
2647 /* wait in queue */
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 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002650 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002651 }
2652 } else {
2653 /*
2654 * Oops, color space is full, wait on overflow queue.
2655 * The next flush completion will assign us
2656 * flush_color and transfer to flusher_queue.
2657 */
2658 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2659 }
2660
Tejun Heofca839c2015-12-07 10:58:57 -05002661 check_flush_dependency(wq, NULL);
2662
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002663 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002664
2665 wait_for_completion(&this_flusher.done);
2666
2667 /*
2668 * Wake-up-and-cascade phase
2669 *
2670 * First flushers are responsible for cascading flushes and
2671 * handling overflow. Non-first flushers can simply return.
2672 */
2673 if (wq->first_flusher != &this_flusher)
2674 return;
2675
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002676 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002677
Tejun Heo4ce48b32010-07-02 10:03:51 +02002678 /* we might have raced, check again with mutex held */
2679 if (wq->first_flusher != &this_flusher)
2680 goto out_unlock;
2681
Tejun Heo73f53c42010-06-29 10:07:11 +02002682 wq->first_flusher = NULL;
2683
Tejun Heo6183c002013-03-12 11:29:57 -07002684 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2685 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002686
2687 while (true) {
2688 struct wq_flusher *next, *tmp;
2689
2690 /* complete all the flushers sharing the current flush color */
2691 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2692 if (next->flush_color != wq->flush_color)
2693 break;
2694 list_del_init(&next->list);
2695 complete(&next->done);
2696 }
2697
Tejun Heo6183c002013-03-12 11:29:57 -07002698 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2699 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002700
2701 /* this flush_color is finished, advance by one */
2702 wq->flush_color = work_next_color(wq->flush_color);
2703
2704 /* one color has been freed, handle overflow queue */
2705 if (!list_empty(&wq->flusher_overflow)) {
2706 /*
2707 * Assign the same color to all overflowed
2708 * flushers, advance work_color and append to
2709 * flusher_queue. This is the start-to-wait
2710 * phase for these overflowed flushers.
2711 */
2712 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2713 tmp->flush_color = wq->work_color;
2714
2715 wq->work_color = work_next_color(wq->work_color);
2716
2717 list_splice_tail_init(&wq->flusher_overflow,
2718 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002719 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002720 }
2721
2722 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002723 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002724 break;
2725 }
2726
2727 /*
2728 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002729 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002730 */
Tejun Heo6183c002013-03-12 11:29:57 -07002731 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2732 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002733
2734 list_del_init(&next->list);
2735 wq->first_flusher = next;
2736
Tejun Heo112202d2013-02-13 19:29:12 -08002737 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002738 break;
2739
2740 /*
2741 * Meh... this color is already done, clear first
2742 * flusher and repeat cascading.
2743 */
2744 wq->first_flusher = NULL;
2745 }
2746
2747out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002748 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002750EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002751
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002752/**
2753 * drain_workqueue - drain a workqueue
2754 * @wq: workqueue to drain
2755 *
2756 * Wait until the workqueue becomes empty. While draining is in progress,
2757 * only chain queueing is allowed. IOW, only currently pending or running
2758 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002759 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002760 * by the depth of chaining and should be relatively short. Whine if it
2761 * takes too long.
2762 */
2763void drain_workqueue(struct workqueue_struct *wq)
2764{
2765 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002766 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002767
2768 /*
2769 * __queue_work() needs to test whether there are drainers, is much
2770 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002771 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002772 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002773 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002774 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002775 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002776 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002777reflush:
2778 flush_workqueue(wq);
2779
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002780 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002781
Tejun Heo49e3cf42013-03-12 11:29:58 -07002782 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002783 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002784
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002785 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002786 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002787 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002788
2789 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002790 continue;
2791
2792 if (++flush_cnt == 10 ||
2793 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002794 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002795 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002796
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002797 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002798 goto reflush;
2799 }
2800
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002801 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002802 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002803 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002804}
2805EXPORT_SYMBOL_GPL(drain_workqueue);
2806
Tejun Heo606a5022012-08-20 14:51:23 -07002807static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002808{
2809 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002810 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002811 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002812
2813 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002814
Tejun Heofa1b54e2013-03-12 11:30:00 -07002815 local_irq_disable();
2816 pool = get_work_pool(work);
2817 if (!pool) {
2818 local_irq_enable();
2819 return false;
2820 }
2821
2822 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002823 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002824 pwq = get_work_pwq(work);
2825 if (pwq) {
2826 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002827 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002828 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002829 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002830 if (!worker)
2831 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002832 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002833 }
Tejun Heobaf59022010-09-16 10:42:16 +02002834
Tejun Heofca839c2015-12-07 10:58:57 -05002835 check_flush_dependency(pwq->wq, work);
2836
Tejun Heo112202d2013-02-13 19:29:12 -08002837 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002838 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002839
Tejun Heoe1594892011-01-09 23:32:15 +01002840 /*
2841 * If @max_active is 1 or rescuer is in use, flushing another work
2842 * item on the same workqueue may lead to deadlock. Make sure the
2843 * flusher is not running on the same workqueue by verifying write
2844 * access.
2845 */
Tejun Heo493008a2013-03-12 11:30:03 -07002846 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002847 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002848 else
Tejun Heo112202d2013-02-13 19:29:12 -08002849 lock_map_acquire_read(&pwq->wq->lockdep_map);
2850 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002851
Tejun Heobaf59022010-09-16 10:42:16 +02002852 return true;
2853already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002854 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002855 return false;
2856}
2857
Oleg Nesterovdb700892008-07-25 01:47:49 -07002858/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002859 * flush_work - wait for a work to finish executing the last queueing instance
2860 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002861 *
Tejun Heo606a5022012-08-20 14:51:23 -07002862 * Wait until @work has finished execution. @work is guaranteed to be idle
2863 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002864 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002865 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002866 * %true if flush_work() waited for the work to finish execution,
2867 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002868 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002869bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002870{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002871 struct wq_barrier barr;
2872
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002873 lock_map_acquire(&work->lockdep_map);
2874 lock_map_release(&work->lockdep_map);
2875
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002876 if (start_flush_work(work, &barr)) {
2877 wait_for_completion(&barr.done);
2878 destroy_work_on_stack(&barr.work);
2879 return true;
2880 } else {
2881 return false;
2882 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002883}
2884EXPORT_SYMBOL_GPL(flush_work);
2885
Tejun Heo8603e1b32015-03-05 08:04:13 -05002886struct cwt_wait {
2887 wait_queue_t wait;
2888 struct work_struct *work;
2889};
2890
2891static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2892{
2893 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2894
2895 if (cwait->work != key)
2896 return 0;
2897 return autoremove_wake_function(wait, mode, sync, key);
2898}
2899
Tejun Heo36e227d2012-08-03 10:30:46 -07002900static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002901{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002902 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002903 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002904 int ret;
2905
2906 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002907 ret = try_to_grab_pending(work, is_dwork, &flags);
2908 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002909 * If someone else is already canceling, wait for it to
2910 * finish. flush_work() doesn't work for PREEMPT_NONE
2911 * because we may get scheduled between @work's completion
2912 * and the other canceling task resuming and clearing
2913 * CANCELING - flush_work() will return false immediately
2914 * as @work is no longer busy, try_to_grab_pending() will
2915 * return -ENOENT as @work is still being canceled and the
2916 * other canceling task won't be able to clear CANCELING as
2917 * we're hogging the CPU.
2918 *
2919 * Let's wait for completion using a waitqueue. As this
2920 * may lead to the thundering herd problem, use a custom
2921 * wake function which matches @work along with exclusive
2922 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002923 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002924 if (unlikely(ret == -ENOENT)) {
2925 struct cwt_wait cwait;
2926
2927 init_wait(&cwait.wait);
2928 cwait.wait.func = cwt_wakefn;
2929 cwait.work = work;
2930
2931 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2932 TASK_UNINTERRUPTIBLE);
2933 if (work_is_canceling(work))
2934 schedule();
2935 finish_wait(&cancel_waitq, &cwait.wait);
2936 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002937 } while (unlikely(ret < 0));
2938
Tejun Heobbb68df2012-08-03 10:30:46 -07002939 /* tell other tasks trying to grab @work to back off */
2940 mark_work_canceling(work);
2941 local_irq_restore(flags);
2942
Tejun Heo606a5022012-08-20 14:51:23 -07002943 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002944 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002945
2946 /*
2947 * Paired with prepare_to_wait() above so that either
2948 * waitqueue_active() is visible here or !work_is_canceling() is
2949 * visible there.
2950 */
2951 smp_mb();
2952 if (waitqueue_active(&cancel_waitq))
2953 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2954
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002955 return ret;
2956}
2957
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002958/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002959 * cancel_work_sync - cancel a work and wait for it to finish
2960 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002961 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002962 * Cancel @work and wait for its execution to finish. This function
2963 * can be used even if the work re-queues itself or migrates to
2964 * another workqueue. On return from this function, @work is
2965 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002966 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002967 * cancel_work_sync(&delayed_work->work) must not be used for
2968 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002969 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002970 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002971 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002972 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002973 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002974 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002975 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002976bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002977{
Tejun Heo36e227d2012-08-03 10:30:46 -07002978 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002979}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002980EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002981
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002982/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002983 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2984 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002985 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002986 * Delayed timer is cancelled and the pending work is queued for
2987 * immediate execution. Like flush_work(), this function only
2988 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002989 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002990 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002991 * %true if flush_work() waited for the work to finish execution,
2992 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002993 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002994bool flush_delayed_work(struct delayed_work *dwork)
2995{
Tejun Heo8930cab2012-08-03 10:30:45 -07002996 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002997 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002998 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002999 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003000 return flush_work(&dwork->work);
3001}
3002EXPORT_SYMBOL(flush_delayed_work);
3003
3004/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003005 * cancel_delayed_work - cancel a delayed work
3006 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003007 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003008 * Kill off a pending delayed_work.
3009 *
3010 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3011 * pending.
3012 *
3013 * Note:
3014 * The work callback function may still be running on return, unless
3015 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3016 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003017 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003018 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003019 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003020bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003021{
Tejun Heo57b30ae2012-08-21 13:18:24 -07003022 unsigned long flags;
3023 int ret;
3024
3025 do {
3026 ret = try_to_grab_pending(&dwork->work, true, &flags);
3027 } while (unlikely(ret == -EAGAIN));
3028
3029 if (unlikely(ret < 0))
3030 return false;
3031
Tejun Heo7c3eed52013-01-24 11:01:33 -08003032 set_work_pool_and_clear_pending(&dwork->work,
3033 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07003034 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07003035 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02003036}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003037EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003038
3039/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003040 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3041 * @dwork: the delayed work cancel
3042 *
3043 * This is cancel_work_sync() for delayed works.
3044 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003045 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003046 * %true if @dwork was pending, %false otherwise.
3047 */
3048bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003049{
Tejun Heo36e227d2012-08-03 10:30:46 -07003050 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003051}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003052EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003053
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003054/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003055 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003056 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003057 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003058 * schedule_on_each_cpu() executes @func on each online CPU using the
3059 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003060 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003061 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003062 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003063 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003064 */
David Howells65f27f32006-11-22 14:55:48 +00003065int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003066{
3067 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003068 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003069
Andrew Mortonb6136772006-06-25 05:47:49 -07003070 works = alloc_percpu(struct work_struct);
3071 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003072 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003073
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003074 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003075
Christoph Lameter15316ba2006-01-08 01:00:43 -08003076 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003077 struct work_struct *work = per_cpu_ptr(works, cpu);
3078
3079 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003080 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003081 }
Tejun Heo93981802009-11-17 14:06:20 -08003082
3083 for_each_online_cpu(cpu)
3084 flush_work(per_cpu_ptr(works, cpu));
3085
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003086 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003087 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003088 return 0;
3089}
3090
Alan Sterneef6a7d2010-02-12 17:39:21 +09003091/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003092 * execute_in_process_context - reliably execute the routine with user context
3093 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003094 * @ew: guaranteed storage for the execute work structure (must
3095 * be available when the work executes)
3096 *
3097 * Executes the function immediately if process context is available,
3098 * otherwise schedules the function for delayed execution.
3099 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003100 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003101 * 1 - function was scheduled for execution
3102 */
David Howells65f27f32006-11-22 14:55:48 +00003103int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003104{
3105 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003106 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003107 return 0;
3108 }
3109
David Howells65f27f32006-11-22 14:55:48 +00003110 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003111 schedule_work(&ew->work);
3112
3113 return 1;
3114}
3115EXPORT_SYMBOL_GPL(execute_in_process_context);
3116
Tejun Heo7a4e3442013-03-12 11:30:00 -07003117/**
3118 * free_workqueue_attrs - free a workqueue_attrs
3119 * @attrs: workqueue_attrs to free
3120 *
3121 * Undo alloc_workqueue_attrs().
3122 */
3123void free_workqueue_attrs(struct workqueue_attrs *attrs)
3124{
3125 if (attrs) {
3126 free_cpumask_var(attrs->cpumask);
3127 kfree(attrs);
3128 }
3129}
3130
3131/**
3132 * alloc_workqueue_attrs - allocate a workqueue_attrs
3133 * @gfp_mask: allocation mask to use
3134 *
3135 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003136 * return it.
3137 *
3138 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003139 */
3140struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3141{
3142 struct workqueue_attrs *attrs;
3143
3144 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3145 if (!attrs)
3146 goto fail;
3147 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3148 goto fail;
3149
Tejun Heo13e2e552013-04-01 11:23:31 -07003150 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003151 return attrs;
3152fail:
3153 free_workqueue_attrs(attrs);
3154 return NULL;
3155}
3156
Tejun Heo29c91e92013-03-12 11:30:03 -07003157static void copy_workqueue_attrs(struct workqueue_attrs *to,
3158 const struct workqueue_attrs *from)
3159{
3160 to->nice = from->nice;
3161 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003162 /*
3163 * Unlike hash and equality test, this function doesn't ignore
3164 * ->no_numa as it is used for both pool and wq attrs. Instead,
3165 * get_unbound_pool() explicitly clears ->no_numa after copying.
3166 */
3167 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003168}
3169
Tejun Heo29c91e92013-03-12 11:30:03 -07003170/* hash value of the content of @attr */
3171static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3172{
3173 u32 hash = 0;
3174
3175 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003176 hash = jhash(cpumask_bits(attrs->cpumask),
3177 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003178 return hash;
3179}
3180
3181/* content equality test */
3182static bool wqattrs_equal(const struct workqueue_attrs *a,
3183 const struct workqueue_attrs *b)
3184{
3185 if (a->nice != b->nice)
3186 return false;
3187 if (!cpumask_equal(a->cpumask, b->cpumask))
3188 return false;
3189 return true;
3190}
3191
Tejun Heo7a4e3442013-03-12 11:30:00 -07003192/**
3193 * init_worker_pool - initialize a newly zalloc'd worker_pool
3194 * @pool: worker_pool to initialize
3195 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303196 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003197 *
3198 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003199 * inside @pool proper are initialized and put_unbound_pool() can be called
3200 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003201 */
3202static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003203{
3204 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003205 pool->id = -1;
3206 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003207 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003208 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003209 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003210 INIT_LIST_HEAD(&pool->worklist);
3211 INIT_LIST_HEAD(&pool->idle_list);
3212 hash_init(pool->busy_hash);
3213
3214 init_timer_deferrable(&pool->idle_timer);
3215 pool->idle_timer.function = idle_worker_timeout;
3216 pool->idle_timer.data = (unsigned long)pool;
3217
3218 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3219 (unsigned long)pool);
3220
3221 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003222 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003223 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003224
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003225 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003226 INIT_HLIST_NODE(&pool->hash_node);
3227 pool->refcnt = 1;
3228
3229 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003230 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3231 if (!pool->attrs)
3232 return -ENOMEM;
3233 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003234}
3235
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003236static void rcu_free_wq(struct rcu_head *rcu)
3237{
3238 struct workqueue_struct *wq =
3239 container_of(rcu, struct workqueue_struct, rcu);
3240
3241 if (!(wq->flags & WQ_UNBOUND))
3242 free_percpu(wq->cpu_pwqs);
3243 else
3244 free_workqueue_attrs(wq->unbound_attrs);
3245
3246 kfree(wq->rescuer);
3247 kfree(wq);
3248}
3249
Tejun Heo29c91e92013-03-12 11:30:03 -07003250static void rcu_free_pool(struct rcu_head *rcu)
3251{
3252 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3253
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003254 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003255 free_workqueue_attrs(pool->attrs);
3256 kfree(pool);
3257}
3258
3259/**
3260 * put_unbound_pool - put a worker_pool
3261 * @pool: worker_pool to put
3262 *
3263 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003264 * safe manner. get_unbound_pool() calls this function on its failure path
3265 * and this function should be able to release pools which went through,
3266 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003267 *
3268 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003269 */
3270static void put_unbound_pool(struct worker_pool *pool)
3271{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003272 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003273 struct worker *worker;
3274
Tejun Heoa892cac2013-04-01 11:23:32 -07003275 lockdep_assert_held(&wq_pool_mutex);
3276
3277 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003278 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003279
3280 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003281 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003282 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003283 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003284
3285 /* release id and unhash */
3286 if (pool->id >= 0)
3287 idr_remove(&worker_pool_idr, pool->id);
3288 hash_del(&pool->hash_node);
3289
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003290 /*
3291 * Become the manager and destroy all workers. Grabbing
3292 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003293 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003294 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003295 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003296
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003297 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003298 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003299 destroy_worker(worker);
3300 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003301 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003302
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003303 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003304 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003305 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003306 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003307
3308 if (pool->detach_completion)
3309 wait_for_completion(pool->detach_completion);
3310
Tejun Heo29c91e92013-03-12 11:30:03 -07003311 mutex_unlock(&pool->manager_arb);
3312
3313 /* shut down the timers */
3314 del_timer_sync(&pool->idle_timer);
3315 del_timer_sync(&pool->mayday_timer);
3316
3317 /* sched-RCU protected to allow dereferences from get_work_pool() */
3318 call_rcu_sched(&pool->rcu, rcu_free_pool);
3319}
3320
3321/**
3322 * get_unbound_pool - get a worker_pool with the specified attributes
3323 * @attrs: the attributes of the worker_pool to get
3324 *
3325 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3326 * reference count and return it. If there already is a matching
3327 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003328 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003329 *
3330 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003331 *
3332 * Return: On success, a worker_pool with the same attributes as @attrs.
3333 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003334 */
3335static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3336{
Tejun Heo29c91e92013-03-12 11:30:03 -07003337 u32 hash = wqattrs_hash(attrs);
3338 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003339 int node;
Xunlei Pange2273582015-10-09 11:53:12 +08003340 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003341
Tejun Heoa892cac2013-04-01 11:23:32 -07003342 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003343
3344 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003345 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3346 if (wqattrs_equal(pool->attrs, attrs)) {
3347 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003348 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003349 }
3350 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003351
Xunlei Pange2273582015-10-09 11:53:12 +08003352 /* if cpumask is contained inside a NUMA node, we belong to that node */
3353 if (wq_numa_enabled) {
3354 for_each_node(node) {
3355 if (cpumask_subset(attrs->cpumask,
3356 wq_numa_possible_cpumask[node])) {
3357 target_node = node;
3358 break;
3359 }
3360 }
3361 }
3362
Tejun Heo29c91e92013-03-12 11:30:03 -07003363 /* nope, create a new one */
Xunlei Pange2273582015-10-09 11:53:12 +08003364 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003365 if (!pool || init_worker_pool(pool) < 0)
3366 goto fail;
3367
Tejun Heo8864b4e2013-03-12 11:30:04 -07003368 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003369 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange2273582015-10-09 11:53:12 +08003370 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003371
Shaohua Li2865a8f2013-08-01 09:56:36 +08003372 /*
3373 * no_numa isn't a worker_pool attribute, always clear it. See
3374 * 'struct workqueue_attrs' comments for detail.
3375 */
3376 pool->attrs->no_numa = false;
3377
Tejun Heo29c91e92013-03-12 11:30:03 -07003378 if (worker_pool_assign_id(pool) < 0)
3379 goto fail;
3380
3381 /* create and start the initial worker */
Lai Jiangshan051e1852014-07-22 13:03:02 +08003382 if (!create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003383 goto fail;
3384
Tejun Heo29c91e92013-03-12 11:30:03 -07003385 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003386 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003387
Tejun Heo29c91e92013-03-12 11:30:03 -07003388 return pool;
3389fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003390 if (pool)
3391 put_unbound_pool(pool);
3392 return NULL;
3393}
3394
Tejun Heo8864b4e2013-03-12 11:30:04 -07003395static void rcu_free_pwq(struct rcu_head *rcu)
3396{
3397 kmem_cache_free(pwq_cache,
3398 container_of(rcu, struct pool_workqueue, rcu));
3399}
3400
3401/*
3402 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3403 * and needs to be destroyed.
3404 */
3405static void pwq_unbound_release_workfn(struct work_struct *work)
3406{
3407 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3408 unbound_release_work);
3409 struct workqueue_struct *wq = pwq->wq;
3410 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003411 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003412
3413 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3414 return;
3415
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003416 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003417 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003418 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003419 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003420
Tejun Heoa892cac2013-04-01 11:23:32 -07003421 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003422 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003423 mutex_unlock(&wq_pool_mutex);
3424
Tejun Heo8864b4e2013-03-12 11:30:04 -07003425 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3426
3427 /*
3428 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003429 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003430 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003431 if (is_last)
3432 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003433}
3434
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003435/**
Tejun Heo699ce092013-03-13 16:51:35 -07003436 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003437 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003438 *
Tejun Heo699ce092013-03-13 16:51:35 -07003439 * If @pwq isn't freezing, set @pwq->max_active to the associated
3440 * workqueue's saved_max_active and activate delayed work items
3441 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003442 */
Tejun Heo699ce092013-03-13 16:51:35 -07003443static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003444{
Tejun Heo699ce092013-03-13 16:51:35 -07003445 struct workqueue_struct *wq = pwq->wq;
3446 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003447
Tejun Heo699ce092013-03-13 16:51:35 -07003448 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003449 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003450
3451 /* fast exit for non-freezable wqs */
3452 if (!freezable && pwq->max_active == wq->saved_max_active)
3453 return;
3454
Lai Jiangshana357fc02013-03-25 16:57:19 -07003455 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003456
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003457 /*
3458 * During [un]freezing, the caller is responsible for ensuring that
3459 * this function is called at least once after @workqueue_freezing
3460 * is updated and visible.
3461 */
3462 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003463 pwq->max_active = wq->saved_max_active;
3464
3465 while (!list_empty(&pwq->delayed_works) &&
3466 pwq->nr_active < pwq->max_active)
3467 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003468
3469 /*
3470 * Need to kick a worker after thawed or an unbound wq's
3471 * max_active is bumped. It's a slow path. Do it always.
3472 */
3473 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003474 } else {
3475 pwq->max_active = 0;
3476 }
3477
Lai Jiangshana357fc02013-03-25 16:57:19 -07003478 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003479}
3480
Tejun Heoe50aba92013-04-01 11:23:35 -07003481/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003482static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3483 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003484{
3485 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3486
Tejun Heoe50aba92013-04-01 11:23:35 -07003487 memset(pwq, 0, sizeof(*pwq));
3488
Tejun Heod2c1d402013-03-12 11:30:04 -07003489 pwq->pool = pool;
3490 pwq->wq = wq;
3491 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003492 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003493 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003494 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003495 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003496 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003497}
Tejun Heod2c1d402013-03-12 11:30:04 -07003498
Tejun Heof147f292013-04-01 11:23:35 -07003499/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003500static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003501{
3502 struct workqueue_struct *wq = pwq->wq;
3503
3504 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003505
Tejun Heo1befcf32013-04-01 11:23:35 -07003506 /* may be called multiple times, ignore if already linked */
3507 if (!list_empty(&pwq->pwqs_node))
3508 return;
3509
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003510 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003511 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003512
3513 /* sync max_active to the current setting */
3514 pwq_adjust_max_active(pwq);
3515
3516 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003517 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003518}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003519
Tejun Heof147f292013-04-01 11:23:35 -07003520/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3521static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3522 const struct workqueue_attrs *attrs)
3523{
3524 struct worker_pool *pool;
3525 struct pool_workqueue *pwq;
3526
3527 lockdep_assert_held(&wq_pool_mutex);
3528
3529 pool = get_unbound_pool(attrs);
3530 if (!pool)
3531 return NULL;
3532
Tejun Heoe50aba92013-04-01 11:23:35 -07003533 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003534 if (!pwq) {
3535 put_unbound_pool(pool);
3536 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003537 }
Tejun Heo6029a912013-04-01 11:23:34 -07003538
Tejun Heof147f292013-04-01 11:23:35 -07003539 init_pwq(pwq, wq, pool);
3540 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003541}
3542
Tejun Heo4c16bd32013-04-01 11:23:36 -07003543/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003544 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003545 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003546 * @node: the target NUMA node
3547 * @cpu_going_down: if >= 0, the CPU to consider as offline
3548 * @cpumask: outarg, the resulting cpumask
3549 *
3550 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3551 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003552 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003553 *
3554 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3555 * enabled and @node has online CPUs requested by @attrs, the returned
3556 * cpumask is the intersection of the possible CPUs of @node and
3557 * @attrs->cpumask.
3558 *
3559 * The caller is responsible for ensuring that the cpumask of @node stays
3560 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003561 *
3562 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3563 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003564 */
3565static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3566 int cpu_going_down, cpumask_t *cpumask)
3567{
Tejun Heod55262c2013-04-01 11:23:38 -07003568 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003569 goto use_dfl;
3570
3571 /* does @node have any online CPUs @attrs wants? */
3572 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3573 if (cpu_going_down >= 0)
3574 cpumask_clear_cpu(cpu_going_down, cpumask);
3575
3576 if (cpumask_empty(cpumask))
3577 goto use_dfl;
3578
3579 /* yeap, return possible CPUs in @node that @attrs wants */
3580 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3581 return !cpumask_equal(cpumask, attrs->cpumask);
3582
3583use_dfl:
3584 cpumask_copy(cpumask, attrs->cpumask);
3585 return false;
3586}
3587
Tejun Heo1befcf32013-04-01 11:23:35 -07003588/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3589static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3590 int node,
3591 struct pool_workqueue *pwq)
3592{
3593 struct pool_workqueue *old_pwq;
3594
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003595 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003596 lockdep_assert_held(&wq->mutex);
3597
3598 /* link_pwq() can handle duplicate calls */
3599 link_pwq(pwq);
3600
3601 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3602 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3603 return old_pwq;
3604}
3605
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003606/* context to store the prepared attrs & pwqs before applying */
3607struct apply_wqattrs_ctx {
3608 struct workqueue_struct *wq; /* target workqueue */
3609 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003610 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003611 struct pool_workqueue *dfl_pwq;
3612 struct pool_workqueue *pwq_tbl[];
3613};
3614
3615/* free the resources after success or abort */
3616static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3617{
3618 if (ctx) {
3619 int node;
3620
3621 for_each_node(node)
3622 put_pwq_unlocked(ctx->pwq_tbl[node]);
3623 put_pwq_unlocked(ctx->dfl_pwq);
3624
3625 free_workqueue_attrs(ctx->attrs);
3626
3627 kfree(ctx);
3628 }
3629}
3630
3631/* allocate the attrs and pwqs for later installation */
3632static struct apply_wqattrs_ctx *
3633apply_wqattrs_prepare(struct workqueue_struct *wq,
3634 const struct workqueue_attrs *attrs)
3635{
3636 struct apply_wqattrs_ctx *ctx;
3637 struct workqueue_attrs *new_attrs, *tmp_attrs;
3638 int node;
3639
3640 lockdep_assert_held(&wq_pool_mutex);
3641
3642 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3643 GFP_KERNEL);
3644
3645 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3646 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3647 if (!ctx || !new_attrs || !tmp_attrs)
3648 goto out_free;
3649
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003650 /*
3651 * Calculate the attrs of the default pwq.
3652 * If the user configured cpumask doesn't overlap with the
3653 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3654 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003655 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003656 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003657 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3658 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003659
3660 /*
3661 * We may create multiple pwqs with differing cpumasks. Make a
3662 * copy of @new_attrs which will be modified and used to obtain
3663 * pools.
3664 */
3665 copy_workqueue_attrs(tmp_attrs, new_attrs);
3666
3667 /*
3668 * If something goes wrong during CPU up/down, we'll fall back to
3669 * the default pwq covering whole @attrs->cpumask. Always create
3670 * it even if we don't use it immediately.
3671 */
3672 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3673 if (!ctx->dfl_pwq)
3674 goto out_free;
3675
3676 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003677 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003678 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3679 if (!ctx->pwq_tbl[node])
3680 goto out_free;
3681 } else {
3682 ctx->dfl_pwq->refcnt++;
3683 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3684 }
3685 }
3686
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003687 /* save the user configured attrs and sanitize it. */
3688 copy_workqueue_attrs(new_attrs, attrs);
3689 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003690 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003691
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003692 ctx->wq = wq;
3693 free_workqueue_attrs(tmp_attrs);
3694 return ctx;
3695
3696out_free:
3697 free_workqueue_attrs(tmp_attrs);
3698 free_workqueue_attrs(new_attrs);
3699 apply_wqattrs_cleanup(ctx);
3700 return NULL;
3701}
3702
3703/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3704static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3705{
3706 int node;
3707
3708 /* all pwqs have been created successfully, let's install'em */
3709 mutex_lock(&ctx->wq->mutex);
3710
3711 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3712
3713 /* save the previous pwq and install the new one */
3714 for_each_node(node)
3715 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3716 ctx->pwq_tbl[node]);
3717
3718 /* @dfl_pwq might not have been used, ensure it's linked */
3719 link_pwq(ctx->dfl_pwq);
3720 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3721
3722 mutex_unlock(&ctx->wq->mutex);
3723}
3724
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003725static void apply_wqattrs_lock(void)
3726{
3727 /* CPUs should stay stable across pwq creations and installations */
3728 get_online_cpus();
3729 mutex_lock(&wq_pool_mutex);
3730}
3731
3732static void apply_wqattrs_unlock(void)
3733{
3734 mutex_unlock(&wq_pool_mutex);
3735 put_online_cpus();
3736}
3737
3738static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3739 const struct workqueue_attrs *attrs)
3740{
3741 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003742
3743 /* only unbound workqueues can change attributes */
3744 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3745 return -EINVAL;
3746
3747 /* creating multiple pwqs breaks ordering guarantee */
3748 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3749 return -EINVAL;
3750
3751 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003752 if (!ctx)
3753 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003754
3755 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003756 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003757 apply_wqattrs_cleanup(ctx);
3758
wanghaibin62011712016-01-07 20:38:59 +08003759 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003760}
3761
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003762/**
3763 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3764 * @wq: the target workqueue
3765 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3766 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003767 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3768 * machines, this function maps a separate pwq to each NUMA node with
3769 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3770 * NUMA node it was issued on. Older pwqs are released as in-flight work
3771 * items finish. Note that a work item which repeatedly requeues itself
3772 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003773 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003774 * Performs GFP_KERNEL allocations.
3775 *
3776 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003777 */
3778int apply_workqueue_attrs(struct workqueue_struct *wq,
3779 const struct workqueue_attrs *attrs)
3780{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003781 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003782
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003783 apply_wqattrs_lock();
3784 ret = apply_workqueue_attrs_locked(wq, attrs);
3785 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003786
Tejun Heo48621252013-04-01 11:23:31 -07003787 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003788}
3789
Tejun Heo4c16bd32013-04-01 11:23:36 -07003790/**
3791 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3792 * @wq: the target workqueue
3793 * @cpu: the CPU coming up or going down
3794 * @online: whether @cpu is coming up or going down
3795 *
3796 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3797 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3798 * @wq accordingly.
3799 *
3800 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3801 * falls back to @wq->dfl_pwq which may not be optimal but is always
3802 * correct.
3803 *
3804 * Note that when the last allowed CPU of a NUMA node goes offline for a
3805 * workqueue with a cpumask spanning multiple nodes, the workers which were
3806 * already executing the work items for the workqueue will lose their CPU
3807 * affinity and may execute on any CPU. This is similar to how per-cpu
3808 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3809 * affinity, it's the user's responsibility to flush the work item from
3810 * CPU_DOWN_PREPARE.
3811 */
3812static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3813 bool online)
3814{
3815 int node = cpu_to_node(cpu);
3816 int cpu_off = online ? -1 : cpu;
3817 struct pool_workqueue *old_pwq = NULL, *pwq;
3818 struct workqueue_attrs *target_attrs;
3819 cpumask_t *cpumask;
3820
3821 lockdep_assert_held(&wq_pool_mutex);
3822
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003823 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3824 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003825 return;
3826
3827 /*
3828 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3829 * Let's use a preallocated one. The following buf is protected by
3830 * CPU hotplug exclusion.
3831 */
3832 target_attrs = wq_update_unbound_numa_attrs_buf;
3833 cpumask = target_attrs->cpumask;
3834
Tejun Heo4c16bd32013-04-01 11:23:36 -07003835 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3836 pwq = unbound_pwq_by_node(wq, node);
3837
3838 /*
3839 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003840 * different from the default pwq's, we need to compare it to @pwq's
3841 * and create a new one if they don't match. If the target cpumask
3842 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003843 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003844 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003845 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003846 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003847 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003848 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003849 }
3850
Tejun Heo4c16bd32013-04-01 11:23:36 -07003851 /* create a new pwq */
3852 pwq = alloc_unbound_pwq(wq, target_attrs);
3853 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003854 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3855 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003856 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003857 }
3858
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003859 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003860 mutex_lock(&wq->mutex);
3861 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3862 goto out_unlock;
3863
3864use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003865 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003866 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3867 get_pwq(wq->dfl_pwq);
3868 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3869 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3870out_unlock:
3871 mutex_unlock(&wq->mutex);
3872 put_pwq_unlocked(old_pwq);
3873}
3874
Tejun Heo30cdf242013-03-12 11:29:57 -07003875static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003876{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003877 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003878 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003879
Tejun Heo30cdf242013-03-12 11:29:57 -07003880 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003881 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3882 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003883 return -ENOMEM;
3884
3885 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003886 struct pool_workqueue *pwq =
3887 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003888 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003889 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003890
Tejun Heof147f292013-04-01 11:23:35 -07003891 init_pwq(pwq, wq, &cpu_pools[highpri]);
3892
3893 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003894 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003895 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003896 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003897 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003898 } else if (wq->flags & __WQ_ORDERED) {
3899 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3900 /* there should only be single pwq for ordering guarantee */
3901 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3902 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3903 "ordering guarantee broken for workqueue %s\n", wq->name);
3904 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003905 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003906 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003907 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003908}
3909
Tejun Heof3421792010-07-02 10:03:51 +02003910static int wq_clamp_max_active(int max_active, unsigned int flags,
3911 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003912{
Tejun Heof3421792010-07-02 10:03:51 +02003913 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3914
3915 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003916 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3917 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003918
Tejun Heof3421792010-07-02 10:03:51 +02003919 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003920}
3921
Tejun Heob196be82012-01-10 15:11:35 -08003922struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003923 unsigned int flags,
3924 int max_active,
3925 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003926 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003927{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003928 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003929 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003930 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003931 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003932
Viresh Kumarcee22a12013-04-08 16:45:40 +05303933 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3934 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3935 flags |= WQ_UNBOUND;
3936
Tejun Heoecf68812013-04-01 11:23:34 -07003937 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003938 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003939 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003940
3941 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003942 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003943 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003944
Tejun Heo6029a912013-04-01 11:23:34 -07003945 if (flags & WQ_UNBOUND) {
3946 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3947 if (!wq->unbound_attrs)
3948 goto err_free_wq;
3949 }
3950
Tejun Heoecf68812013-04-01 11:23:34 -07003951 va_start(args, lock_name);
3952 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003953 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003954
Tejun Heod320c032010-06-29 10:07:14 +02003955 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003956 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003957
Tejun Heob196be82012-01-10 15:11:35 -08003958 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003959 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003960 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003961 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003962 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003963 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003964 INIT_LIST_HEAD(&wq->flusher_queue);
3965 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003966 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003967
Johannes Bergeb13ba82008-01-16 09:51:58 +01003968 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003969 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003970
Tejun Heo30cdf242013-03-12 11:29:57 -07003971 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07003972 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003973
Tejun Heo493008a2013-03-12 11:30:03 -07003974 /*
3975 * Workqueues which may be used during memory reclaim should
3976 * have a rescuer to guarantee forward progress.
3977 */
3978 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003979 struct worker *rescuer;
3980
Lai Jiangshanf7537df2014-07-15 17:24:15 +08003981 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003982 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07003983 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02003984
Tejun Heo111c2252013-01-17 17:16:24 -08003985 rescuer->rescue_wq = wq;
3986 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003987 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07003988 if (IS_ERR(rescuer->task)) {
3989 kfree(rescuer);
3990 goto err_destroy;
3991 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003992
Tejun Heod2c1d402013-03-12 11:30:04 -07003993 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02003994 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003995 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003996 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003997
Tejun Heo226223a2013-03-12 11:30:05 -07003998 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3999 goto err_destroy;
4000
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004001 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004002 * wq_pool_mutex protects global freeze state and workqueues list.
4003 * Grab it, adjust max_active and add the new @wq to workqueues
4004 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004005 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004006 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004007
Lai Jiangshana357fc02013-03-25 16:57:19 -07004008 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004009 for_each_pwq(pwq, wq)
4010 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004011 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004012
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004013 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004014
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004015 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004016
Oleg Nesterov3af244332007-05-09 02:34:09 -07004017 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004018
4019err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004020 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004021 kfree(wq);
4022 return NULL;
4023err_destroy:
4024 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004025 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004026}
Tejun Heod320c032010-06-29 10:07:14 +02004027EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004028
4029/**
4030 * destroy_workqueue - safely terminate a workqueue
4031 * @wq: target workqueue
4032 *
4033 * Safely destroy a workqueue. All work currently pending will be done first.
4034 */
4035void destroy_workqueue(struct workqueue_struct *wq)
4036{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004037 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004038 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004039
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004040 /* drain it before proceeding with destruction */
4041 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004042
Tejun Heo6183c002013-03-12 11:29:57 -07004043 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004044 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004045 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004046 int i;
4047
Tejun Heo76af4d92013-03-12 11:30:00 -07004048 for (i = 0; i < WORK_NR_COLORS; i++) {
4049 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004050 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004051 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004052 }
4053 }
4054
Lai Jiangshan5c529592013-04-04 10:05:38 +08004055 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004056 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004057 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004058 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004059 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004060 }
Tejun Heo6183c002013-03-12 11:29:57 -07004061 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004062 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004063
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004064 /*
4065 * wq list is used to freeze wq, remove from list after
4066 * flushing is complete in case freeze races us.
4067 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004068 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004069 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004070 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004071
Tejun Heo226223a2013-03-12 11:30:05 -07004072 workqueue_sysfs_unregister(wq);
4073
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004074 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004075 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004076
Tejun Heo8864b4e2013-03-12 11:30:04 -07004077 if (!(wq->flags & WQ_UNBOUND)) {
4078 /*
4079 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004080 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004081 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004082 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004083 } else {
4084 /*
4085 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004086 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4087 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004088 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004089 for_each_node(node) {
4090 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4091 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4092 put_pwq_unlocked(pwq);
4093 }
4094
4095 /*
4096 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4097 * put. Don't access it afterwards.
4098 */
4099 pwq = wq->dfl_pwq;
4100 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004101 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004102 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004103}
4104EXPORT_SYMBOL_GPL(destroy_workqueue);
4105
Tejun Heodcd989c2010-06-29 10:07:14 +02004106/**
4107 * workqueue_set_max_active - adjust max_active of a workqueue
4108 * @wq: target workqueue
4109 * @max_active: new max_active value.
4110 *
4111 * Set max_active of @wq to @max_active.
4112 *
4113 * CONTEXT:
4114 * Don't call from IRQ context.
4115 */
4116void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4117{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004118 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004119
Tejun Heo8719dce2013-03-12 11:30:04 -07004120 /* disallow meddling with max_active for ordered workqueues */
4121 if (WARN_ON(wq->flags & __WQ_ORDERED))
4122 return;
4123
Tejun Heof3421792010-07-02 10:03:51 +02004124 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004125
Lai Jiangshana357fc02013-03-25 16:57:19 -07004126 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004127
4128 wq->saved_max_active = max_active;
4129
Tejun Heo699ce092013-03-13 16:51:35 -07004130 for_each_pwq(pwq, wq)
4131 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004132
Lai Jiangshana357fc02013-03-25 16:57:19 -07004133 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004134}
4135EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4136
4137/**
Tejun Heoe62676162013-03-12 17:41:37 -07004138 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4139 *
4140 * Determine whether %current is a workqueue rescuer. Can be used from
4141 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004142 *
4143 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004144 */
4145bool current_is_workqueue_rescuer(void)
4146{
4147 struct worker *worker = current_wq_worker();
4148
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004149 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004150}
4151
4152/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004153 * workqueue_congested - test whether a workqueue is congested
4154 * @cpu: CPU in question
4155 * @wq: target workqueue
4156 *
4157 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4158 * no synchronization around this function and the test result is
4159 * unreliable and only useful as advisory hints or for debugging.
4160 *
Tejun Heod3251852013-05-10 11:10:17 -07004161 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4162 * Note that both per-cpu and unbound workqueues may be associated with
4163 * multiple pool_workqueues which have separate congested states. A
4164 * workqueue being congested on one CPU doesn't mean the workqueue is also
4165 * contested on other CPUs / NUMA nodes.
4166 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004167 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004168 * %true if congested, %false otherwise.
4169 */
Tejun Heod84ff052013-03-12 11:29:59 -07004170bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004171{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004172 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004173 bool ret;
4174
Lai Jiangshan88109452013-03-20 03:28:10 +08004175 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004176
Tejun Heod3251852013-05-10 11:10:17 -07004177 if (cpu == WORK_CPU_UNBOUND)
4178 cpu = smp_processor_id();
4179
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004180 if (!(wq->flags & WQ_UNBOUND))
4181 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4182 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004183 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004184
Tejun Heo76af4d92013-03-12 11:30:00 -07004185 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004186 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004187
4188 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004189}
4190EXPORT_SYMBOL_GPL(workqueue_congested);
4191
4192/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004193 * work_busy - test whether a work is currently pending or running
4194 * @work: the work to be tested
4195 *
4196 * Test whether @work is currently pending or running. There is no
4197 * synchronization around this function and the test result is
4198 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004199 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004200 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004201 * OR'd bitmask of WORK_BUSY_* bits.
4202 */
4203unsigned int work_busy(struct work_struct *work)
4204{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004205 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004206 unsigned long flags;
4207 unsigned int ret = 0;
4208
Tejun Heodcd989c2010-06-29 10:07:14 +02004209 if (work_pending(work))
4210 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004211
Tejun Heofa1b54e2013-03-12 11:30:00 -07004212 local_irq_save(flags);
4213 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004214 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004215 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004216 if (find_worker_executing_work(pool, work))
4217 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004218 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004219 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004220 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004221
4222 return ret;
4223}
4224EXPORT_SYMBOL_GPL(work_busy);
4225
Tejun Heo3d1cb202013-04-30 15:27:22 -07004226/**
4227 * set_worker_desc - set description for the current work item
4228 * @fmt: printf-style format string
4229 * @...: arguments for the format string
4230 *
4231 * This function can be called by a running work function to describe what
4232 * the work item is about. If the worker task gets dumped, this
4233 * information will be printed out together to help debugging. The
4234 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4235 */
4236void set_worker_desc(const char *fmt, ...)
4237{
4238 struct worker *worker = current_wq_worker();
4239 va_list args;
4240
4241 if (worker) {
4242 va_start(args, fmt);
4243 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4244 va_end(args);
4245 worker->desc_valid = true;
4246 }
4247}
4248
4249/**
4250 * print_worker_info - print out worker information and description
4251 * @log_lvl: the log level to use when printing
4252 * @task: target task
4253 *
4254 * If @task is a worker and currently executing a work item, print out the
4255 * name of the workqueue being serviced and worker description set with
4256 * set_worker_desc() by the currently executing work item.
4257 *
4258 * This function can be safely called on any task as long as the
4259 * task_struct itself is accessible. While safe, this function isn't
4260 * synchronized and may print out mixups or garbages of limited length.
4261 */
4262void print_worker_info(const char *log_lvl, struct task_struct *task)
4263{
4264 work_func_t *fn = NULL;
4265 char name[WQ_NAME_LEN] = { };
4266 char desc[WORKER_DESC_LEN] = { };
4267 struct pool_workqueue *pwq = NULL;
4268 struct workqueue_struct *wq = NULL;
4269 bool desc_valid = false;
4270 struct worker *worker;
4271
4272 if (!(task->flags & PF_WQ_WORKER))
4273 return;
4274
4275 /*
4276 * This function is called without any synchronization and @task
4277 * could be in any state. Be careful with dereferences.
4278 */
4279 worker = probe_kthread_data(task);
4280
4281 /*
4282 * Carefully copy the associated workqueue's workfn and name. Keep
4283 * the original last '\0' in case the original contains garbage.
4284 */
4285 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4286 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4287 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4288 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4289
4290 /* copy worker description */
4291 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4292 if (desc_valid)
4293 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4294
4295 if (fn || name[0] || desc[0]) {
4296 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4297 if (desc[0])
4298 pr_cont(" (%s)", desc);
4299 pr_cont("\n");
4300 }
4301}
4302
Tejun Heo3494fc32015-03-09 09:22:28 -04004303static void pr_cont_pool_info(struct worker_pool *pool)
4304{
4305 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4306 if (pool->node != NUMA_NO_NODE)
4307 pr_cont(" node=%d", pool->node);
4308 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4309}
4310
4311static void pr_cont_work(bool comma, struct work_struct *work)
4312{
4313 if (work->func == wq_barrier_func) {
4314 struct wq_barrier *barr;
4315
4316 barr = container_of(work, struct wq_barrier, work);
4317
4318 pr_cont("%s BAR(%d)", comma ? "," : "",
4319 task_pid_nr(barr->task));
4320 } else {
4321 pr_cont("%s %pf", comma ? "," : "", work->func);
4322 }
4323}
4324
4325static void show_pwq(struct pool_workqueue *pwq)
4326{
4327 struct worker_pool *pool = pwq->pool;
4328 struct work_struct *work;
4329 struct worker *worker;
4330 bool has_in_flight = false, has_pending = false;
4331 int bkt;
4332
4333 pr_info(" pwq %d:", pool->id);
4334 pr_cont_pool_info(pool);
4335
4336 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4337 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4338
4339 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4340 if (worker->current_pwq == pwq) {
4341 has_in_flight = true;
4342 break;
4343 }
4344 }
4345 if (has_in_flight) {
4346 bool comma = false;
4347
4348 pr_info(" in-flight:");
4349 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4350 if (worker->current_pwq != pwq)
4351 continue;
4352
4353 pr_cont("%s %d%s:%pf", comma ? "," : "",
4354 task_pid_nr(worker->task),
4355 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4356 worker->current_func);
4357 list_for_each_entry(work, &worker->scheduled, entry)
4358 pr_cont_work(false, work);
4359 comma = true;
4360 }
4361 pr_cont("\n");
4362 }
4363
4364 list_for_each_entry(work, &pool->worklist, entry) {
4365 if (get_work_pwq(work) == pwq) {
4366 has_pending = true;
4367 break;
4368 }
4369 }
4370 if (has_pending) {
4371 bool comma = false;
4372
4373 pr_info(" pending:");
4374 list_for_each_entry(work, &pool->worklist, entry) {
4375 if (get_work_pwq(work) != pwq)
4376 continue;
4377
4378 pr_cont_work(comma, work);
4379 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4380 }
4381 pr_cont("\n");
4382 }
4383
4384 if (!list_empty(&pwq->delayed_works)) {
4385 bool comma = false;
4386
4387 pr_info(" delayed:");
4388 list_for_each_entry(work, &pwq->delayed_works, entry) {
4389 pr_cont_work(comma, work);
4390 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4391 }
4392 pr_cont("\n");
4393 }
4394}
4395
4396/**
4397 * show_workqueue_state - dump workqueue state
4398 *
4399 * Called from a sysrq handler and prints out all busy workqueues and
4400 * pools.
4401 */
4402void show_workqueue_state(void)
4403{
4404 struct workqueue_struct *wq;
4405 struct worker_pool *pool;
4406 unsigned long flags;
4407 int pi;
4408
4409 rcu_read_lock_sched();
4410
4411 pr_info("Showing busy workqueues and worker pools:\n");
4412
4413 list_for_each_entry_rcu(wq, &workqueues, list) {
4414 struct pool_workqueue *pwq;
4415 bool idle = true;
4416
4417 for_each_pwq(pwq, wq) {
4418 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4419 idle = false;
4420 break;
4421 }
4422 }
4423 if (idle)
4424 continue;
4425
4426 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4427
4428 for_each_pwq(pwq, wq) {
4429 spin_lock_irqsave(&pwq->pool->lock, flags);
4430 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4431 show_pwq(pwq);
4432 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4433 }
4434 }
4435
4436 for_each_pool(pool, pi) {
4437 struct worker *worker;
4438 bool first = true;
4439
4440 spin_lock_irqsave(&pool->lock, flags);
4441 if (pool->nr_workers == pool->nr_idle)
4442 goto next_pool;
4443
4444 pr_info("pool %d:", pool->id);
4445 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004446 pr_cont(" hung=%us workers=%d",
4447 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4448 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004449 if (pool->manager)
4450 pr_cont(" manager: %d",
4451 task_pid_nr(pool->manager->task));
4452 list_for_each_entry(worker, &pool->idle_list, entry) {
4453 pr_cont(" %s%d", first ? "idle: " : "",
4454 task_pid_nr(worker->task));
4455 first = false;
4456 }
4457 pr_cont("\n");
4458 next_pool:
4459 spin_unlock_irqrestore(&pool->lock, flags);
4460 }
4461
4462 rcu_read_unlock_sched();
4463}
4464
Tejun Heodb7bccf2010-06-29 10:07:12 +02004465/*
4466 * CPU hotplug.
4467 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004468 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004469 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004470 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004471 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004472 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004473 * blocked draining impractical.
4474 *
Tejun Heo24647572013-01-24 11:01:33 -08004475 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004476 * running as an unbound one and allowing it to be reattached later if the
4477 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004478 */
4479
Tejun Heo706026c2013-01-24 11:01:34 -08004480static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004481{
Tejun Heo38db41d2013-01-24 11:01:34 -08004482 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004483 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004484 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004485
Tejun Heof02ae732013-03-12 11:30:03 -07004486 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004487 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004488 spin_lock_irq(&pool->lock);
4489
4490 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004491 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004492 * unbound and set DISASSOCIATED. Before this, all workers
4493 * except for the ones which are still executing works from
4494 * before the last CPU down must be on the cpu. After
4495 * this, they may become diasporas.
4496 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004497 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004498 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004499
Tejun Heo24647572013-01-24 11:01:33 -08004500 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004501
Tejun Heo94cf58b2013-01-24 11:01:33 -08004502 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004503 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004504
Lai Jiangshaneb283422013-03-08 15:18:28 -08004505 /*
4506 * Call schedule() so that we cross rq->lock and thus can
4507 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4508 * This is necessary as scheduler callbacks may be invoked
4509 * from other cpus.
4510 */
4511 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004512
Lai Jiangshaneb283422013-03-08 15:18:28 -08004513 /*
4514 * Sched callbacks are disabled now. Zap nr_running.
4515 * After this, nr_running stays zero and need_more_worker()
4516 * and keep_working() are always true as long as the
4517 * worklist is not empty. This pool now behaves as an
4518 * unbound (in terms of concurrency management) pool which
4519 * are served by workers tied to the pool.
4520 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004521 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004522
4523 /*
4524 * With concurrency management just turned off, a busy
4525 * worker blocking could lead to lengthy stalls. Kick off
4526 * unbound chain execution of currently pending work items.
4527 */
4528 spin_lock_irq(&pool->lock);
4529 wake_up_worker(pool);
4530 spin_unlock_irq(&pool->lock);
4531 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004532}
4533
Tejun Heobd7c0892013-03-19 13:45:21 -07004534/**
4535 * rebind_workers - rebind all workers of a pool to the associated CPU
4536 * @pool: pool of interest
4537 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004538 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004539 */
4540static void rebind_workers(struct worker_pool *pool)
4541{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004542 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004543
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004544 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004545
Tejun Heoa9ab7752013-03-19 13:45:21 -07004546 /*
4547 * Restore CPU affinity of all workers. As all idle workers should
4548 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304549 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004550 * of all workers first and then clear UNBOUND. As we're called
4551 * from CPU_ONLINE, the following shouldn't fail.
4552 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004553 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004554 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4555 pool->attrs->cpumask) < 0);
4556
4557 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004558
4559 /*
4560 * XXX: CPU hotplug notifiers are weird and can call DOWN_FAILED
4561 * w/o preceding DOWN_PREPARE. Work around it. CPU hotplug is
4562 * being reworked and this can go away in time.
4563 */
4564 if (!(pool->flags & POOL_DISASSOCIATED)) {
4565 spin_unlock_irq(&pool->lock);
4566 return;
4567 }
4568
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004569 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004570
Lai Jiangshanda028462014-05-20 17:46:31 +08004571 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004572 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004573
4574 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004575 * A bound idle worker should actually be on the runqueue
4576 * of the associated CPU for local wake-ups targeting it to
4577 * work. Kick all idle workers so that they migrate to the
4578 * associated CPU. Doing this in the same loop as
4579 * replacing UNBOUND with REBOUND is safe as no worker will
4580 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004581 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004582 if (worker_flags & WORKER_IDLE)
4583 wake_up_process(worker->task);
4584
4585 /*
4586 * We want to clear UNBOUND but can't directly call
4587 * worker_clr_flags() or adjust nr_running. Atomically
4588 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4589 * @worker will clear REBOUND using worker_clr_flags() when
4590 * it initiates the next execution cycle thus restoring
4591 * concurrency management. Note that when or whether
4592 * @worker clears REBOUND doesn't affect correctness.
4593 *
4594 * ACCESS_ONCE() is necessary because @worker->flags may be
4595 * tested without holding any lock in
4596 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4597 * fail incorrectly leading to premature concurrency
4598 * management operations.
4599 */
4600 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4601 worker_flags |= WORKER_REBOUND;
4602 worker_flags &= ~WORKER_UNBOUND;
4603 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004604 }
4605
Tejun Heoa9ab7752013-03-19 13:45:21 -07004606 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004607}
4608
Tejun Heo7dbc7252013-03-19 13:45:21 -07004609/**
4610 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4611 * @pool: unbound pool of interest
4612 * @cpu: the CPU which is coming up
4613 *
4614 * An unbound pool may end up with a cpumask which doesn't have any online
4615 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4616 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4617 * online CPU before, cpus_allowed of all its workers should be restored.
4618 */
4619static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4620{
4621 static cpumask_t cpumask;
4622 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004623
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004624 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004625
4626 /* is @cpu allowed for @pool? */
4627 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4628 return;
4629
4630 /* is @cpu the only online CPU? */
4631 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4632 if (cpumask_weight(&cpumask) != 1)
4633 return;
4634
4635 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004636 for_each_pool_worker(worker, pool)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004637 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4638 pool->attrs->cpumask) < 0);
4639}
4640
Tejun Heo8db25e72012-07-17 12:39:28 -07004641/*
4642 * Workqueues should be brought up before normal priority CPU notifiers.
4643 * This will be registered high priority CPU notifier.
4644 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004645static int workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004646 unsigned long action,
4647 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004648{
Tejun Heod84ff052013-03-12 11:29:59 -07004649 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004650 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004651 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004652 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004653
Tejun Heo8db25e72012-07-17 12:39:28 -07004654 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004655 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004656 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004657 if (pool->nr_workers)
4658 continue;
Lai Jiangshan051e1852014-07-22 13:03:02 +08004659 if (!create_worker(pool))
Tejun Heo3ce63372012-07-17 12:39:27 -07004660 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004661 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004662 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004663
Tejun Heo65758202012-07-17 12:39:26 -07004664 case CPU_DOWN_FAILED:
4665 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004666 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004667
4668 for_each_pool(pool, pi) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004669 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004670
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004671 if (pool->cpu == cpu)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004672 rebind_workers(pool);
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004673 else if (pool->cpu < 0)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004674 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004675
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004676 mutex_unlock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004677 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004678
Tejun Heo4c16bd32013-04-01 11:23:36 -07004679 /* update NUMA affinity of unbound workqueues */
4680 list_for_each_entry(wq, &workqueues, list)
4681 wq_update_unbound_numa(wq, cpu, true);
4682
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004683 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004684 break;
Tejun Heo65758202012-07-17 12:39:26 -07004685 }
4686 return NOTIFY_OK;
4687}
4688
4689/*
4690 * Workqueues should be brought down after normal priority CPU notifiers.
4691 * This will be registered as low priority CPU notifier.
4692 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004693static int workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004694 unsigned long action,
4695 void *hcpu)
4696{
Tejun Heod84ff052013-03-12 11:29:59 -07004697 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004698 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004699 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004700
Tejun Heo65758202012-07-17 12:39:26 -07004701 switch (action & ~CPU_TASKS_FROZEN) {
4702 case CPU_DOWN_PREPARE:
Tejun Heo4c16bd32013-04-01 11:23:36 -07004703 /* unbinding per-cpu workers should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004704 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004705 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004706
4707 /* update NUMA affinity of unbound workqueues */
4708 mutex_lock(&wq_pool_mutex);
4709 list_for_each_entry(wq, &workqueues, list)
4710 wq_update_unbound_numa(wq, cpu, false);
4711 mutex_unlock(&wq_pool_mutex);
4712
4713 /* wait for per-cpu unbinding to finish */
Tejun Heo8db25e72012-07-17 12:39:28 -07004714 flush_work(&unbind_work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004715 destroy_work_on_stack(&unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004716 break;
Tejun Heo65758202012-07-17 12:39:26 -07004717 }
4718 return NOTIFY_OK;
4719}
4720
Rusty Russell2d3854a2008-11-05 13:39:10 +11004721#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004722
Rusty Russell2d3854a2008-11-05 13:39:10 +11004723struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004724 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004725 long (*fn)(void *);
4726 void *arg;
4727 long ret;
4728};
4729
Tejun Heoed48ece2012-09-18 12:48:43 -07004730static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004731{
Tejun Heoed48ece2012-09-18 12:48:43 -07004732 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4733
Rusty Russell2d3854a2008-11-05 13:39:10 +11004734 wfc->ret = wfc->fn(wfc->arg);
4735}
4736
4737/**
4738 * work_on_cpu - run a function in user context on a particular cpu
4739 * @cpu: the cpu to run on
4740 * @fn: the function to run
4741 * @arg: the function arg
4742 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004743 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004744 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004745 *
4746 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004747 */
Tejun Heod84ff052013-03-12 11:29:59 -07004748long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004749{
Tejun Heoed48ece2012-09-18 12:48:43 -07004750 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004751
Tejun Heoed48ece2012-09-18 12:48:43 -07004752 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4753 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004754 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004755 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004756 return wfc.ret;
4757}
4758EXPORT_SYMBOL_GPL(work_on_cpu);
4759#endif /* CONFIG_SMP */
4760
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004761#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304762
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004763/**
4764 * freeze_workqueues_begin - begin freezing workqueues
4765 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004766 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004767 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004768 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004769 *
4770 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004771 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004772 */
4773void freeze_workqueues_begin(void)
4774{
Tejun Heo24b8a842013-03-12 11:29:58 -07004775 struct workqueue_struct *wq;
4776 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004777
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004778 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004779
Tejun Heo6183c002013-03-12 11:29:57 -07004780 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004781 workqueue_freezing = true;
4782
Tejun Heo24b8a842013-03-12 11:29:58 -07004783 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004784 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004785 for_each_pwq(pwq, wq)
4786 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004787 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004788 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004789
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004790 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004791}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004792
4793/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004794 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004795 *
4796 * Check whether freezing is complete. This function must be called
4797 * between freeze_workqueues_begin() and thaw_workqueues().
4798 *
4799 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004800 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004801 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004802 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004803 * %true if some freezable workqueues are still busy. %false if freezing
4804 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004805 */
4806bool freeze_workqueues_busy(void)
4807{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004808 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004809 struct workqueue_struct *wq;
4810 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004811
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004812 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004813
Tejun Heo6183c002013-03-12 11:29:57 -07004814 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004815
Tejun Heo24b8a842013-03-12 11:29:58 -07004816 list_for_each_entry(wq, &workqueues, list) {
4817 if (!(wq->flags & WQ_FREEZABLE))
4818 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004819 /*
4820 * nr_active is monotonically decreasing. It's safe
4821 * to peek without lock.
4822 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004823 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004824 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004825 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004826 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004827 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004828 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004829 goto out_unlock;
4830 }
4831 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004832 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004833 }
4834out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004835 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004836 return busy;
4837}
4838
4839/**
4840 * thaw_workqueues - thaw workqueues
4841 *
4842 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004843 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004844 *
4845 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004846 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004847 */
4848void thaw_workqueues(void)
4849{
Tejun Heo24b8a842013-03-12 11:29:58 -07004850 struct workqueue_struct *wq;
4851 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004852
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004853 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004854
4855 if (!workqueue_freezing)
4856 goto out_unlock;
4857
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004858 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004859
Tejun Heo24b8a842013-03-12 11:29:58 -07004860 /* restore max_active and repopulate worklist */
4861 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004862 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004863 for_each_pwq(pwq, wq)
4864 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004865 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004866 }
4867
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004868out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004869 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004870}
4871#endif /* CONFIG_FREEZER */
4872
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004873static int workqueue_apply_unbound_cpumask(void)
4874{
4875 LIST_HEAD(ctxs);
4876 int ret = 0;
4877 struct workqueue_struct *wq;
4878 struct apply_wqattrs_ctx *ctx, *n;
4879
4880 lockdep_assert_held(&wq_pool_mutex);
4881
4882 list_for_each_entry(wq, &workqueues, list) {
4883 if (!(wq->flags & WQ_UNBOUND))
4884 continue;
4885 /* creating multiple pwqs breaks ordering guarantee */
4886 if (wq->flags & __WQ_ORDERED)
4887 continue;
4888
4889 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4890 if (!ctx) {
4891 ret = -ENOMEM;
4892 break;
4893 }
4894
4895 list_add_tail(&ctx->list, &ctxs);
4896 }
4897
4898 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4899 if (!ret)
4900 apply_wqattrs_commit(ctx);
4901 apply_wqattrs_cleanup(ctx);
4902 }
4903
4904 return ret;
4905}
4906
4907/**
4908 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4909 * @cpumask: the cpumask to set
4910 *
4911 * The low-level workqueues cpumask is a global cpumask that limits
4912 * the affinity of all unbound workqueues. This function check the @cpumask
4913 * and apply it to all unbound workqueues and updates all pwqs of them.
4914 *
4915 * Retun: 0 - Success
4916 * -EINVAL - Invalid @cpumask
4917 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4918 */
4919int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4920{
4921 int ret = -EINVAL;
4922 cpumask_var_t saved_cpumask;
4923
4924 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4925 return -ENOMEM;
4926
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004927 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4928 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004929 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004930
4931 /* save the old wq_unbound_cpumask. */
4932 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4933
4934 /* update wq_unbound_cpumask at first and apply it to wqs. */
4935 cpumask_copy(wq_unbound_cpumask, cpumask);
4936 ret = workqueue_apply_unbound_cpumask();
4937
4938 /* restore the wq_unbound_cpumask when failed. */
4939 if (ret < 0)
4940 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4941
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004942 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004943 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004944
4945 free_cpumask_var(saved_cpumask);
4946 return ret;
4947}
4948
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004949#ifdef CONFIG_SYSFS
4950/*
4951 * Workqueues with WQ_SYSFS flag set is visible to userland via
4952 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4953 * following attributes.
4954 *
4955 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4956 * max_active RW int : maximum number of in-flight work items
4957 *
4958 * Unbound workqueues have the following extra attributes.
4959 *
4960 * id RO int : the associated pool ID
4961 * nice RW int : nice value of the workers
4962 * cpumask RW mask : bitmask of allowed CPUs for the workers
4963 */
4964struct wq_device {
4965 struct workqueue_struct *wq;
4966 struct device dev;
4967};
4968
4969static struct workqueue_struct *dev_to_wq(struct device *dev)
4970{
4971 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
4972
4973 return wq_dev->wq;
4974}
4975
4976static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
4977 char *buf)
4978{
4979 struct workqueue_struct *wq = dev_to_wq(dev);
4980
4981 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
4982}
4983static DEVICE_ATTR_RO(per_cpu);
4984
4985static ssize_t max_active_show(struct device *dev,
4986 struct device_attribute *attr, char *buf)
4987{
4988 struct workqueue_struct *wq = dev_to_wq(dev);
4989
4990 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
4991}
4992
4993static ssize_t max_active_store(struct device *dev,
4994 struct device_attribute *attr, const char *buf,
4995 size_t count)
4996{
4997 struct workqueue_struct *wq = dev_to_wq(dev);
4998 int val;
4999
5000 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5001 return -EINVAL;
5002
5003 workqueue_set_max_active(wq, val);
5004 return count;
5005}
5006static DEVICE_ATTR_RW(max_active);
5007
5008static struct attribute *wq_sysfs_attrs[] = {
5009 &dev_attr_per_cpu.attr,
5010 &dev_attr_max_active.attr,
5011 NULL,
5012};
5013ATTRIBUTE_GROUPS(wq_sysfs);
5014
5015static ssize_t wq_pool_ids_show(struct device *dev,
5016 struct device_attribute *attr, char *buf)
5017{
5018 struct workqueue_struct *wq = dev_to_wq(dev);
5019 const char *delim = "";
5020 int node, written = 0;
5021
5022 rcu_read_lock_sched();
5023 for_each_node(node) {
5024 written += scnprintf(buf + written, PAGE_SIZE - written,
5025 "%s%d:%d", delim, node,
5026 unbound_pwq_by_node(wq, node)->pool->id);
5027 delim = " ";
5028 }
5029 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5030 rcu_read_unlock_sched();
5031
5032 return written;
5033}
5034
5035static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5036 char *buf)
5037{
5038 struct workqueue_struct *wq = dev_to_wq(dev);
5039 int written;
5040
5041 mutex_lock(&wq->mutex);
5042 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5043 mutex_unlock(&wq->mutex);
5044
5045 return written;
5046}
5047
5048/* prepare workqueue_attrs for sysfs store operations */
5049static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5050{
5051 struct workqueue_attrs *attrs;
5052
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005053 lockdep_assert_held(&wq_pool_mutex);
5054
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005055 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5056 if (!attrs)
5057 return NULL;
5058
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005059 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005060 return attrs;
5061}
5062
5063static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5064 const char *buf, size_t count)
5065{
5066 struct workqueue_struct *wq = dev_to_wq(dev);
5067 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005068 int ret = -ENOMEM;
5069
5070 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005071
5072 attrs = wq_sysfs_prep_attrs(wq);
5073 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005074 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005075
5076 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5077 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005078 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005079 else
5080 ret = -EINVAL;
5081
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005082out_unlock:
5083 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005084 free_workqueue_attrs(attrs);
5085 return ret ?: count;
5086}
5087
5088static ssize_t wq_cpumask_show(struct device *dev,
5089 struct device_attribute *attr, char *buf)
5090{
5091 struct workqueue_struct *wq = dev_to_wq(dev);
5092 int written;
5093
5094 mutex_lock(&wq->mutex);
5095 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5096 cpumask_pr_args(wq->unbound_attrs->cpumask));
5097 mutex_unlock(&wq->mutex);
5098 return written;
5099}
5100
5101static ssize_t wq_cpumask_store(struct device *dev,
5102 struct device_attribute *attr,
5103 const char *buf, size_t count)
5104{
5105 struct workqueue_struct *wq = dev_to_wq(dev);
5106 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005107 int ret = -ENOMEM;
5108
5109 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005110
5111 attrs = wq_sysfs_prep_attrs(wq);
5112 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005113 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005114
5115 ret = cpumask_parse(buf, attrs->cpumask);
5116 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005117 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005118
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005119out_unlock:
5120 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005121 free_workqueue_attrs(attrs);
5122 return ret ?: count;
5123}
5124
5125static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5126 char *buf)
5127{
5128 struct workqueue_struct *wq = dev_to_wq(dev);
5129 int written;
5130
5131 mutex_lock(&wq->mutex);
5132 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5133 !wq->unbound_attrs->no_numa);
5134 mutex_unlock(&wq->mutex);
5135
5136 return written;
5137}
5138
5139static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5140 const char *buf, size_t count)
5141{
5142 struct workqueue_struct *wq = dev_to_wq(dev);
5143 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005144 int v, ret = -ENOMEM;
5145
5146 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005147
5148 attrs = wq_sysfs_prep_attrs(wq);
5149 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005150 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005151
5152 ret = -EINVAL;
5153 if (sscanf(buf, "%d", &v) == 1) {
5154 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005155 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005156 }
5157
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005158out_unlock:
5159 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005160 free_workqueue_attrs(attrs);
5161 return ret ?: count;
5162}
5163
5164static struct device_attribute wq_sysfs_unbound_attrs[] = {
5165 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5166 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5167 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5168 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5169 __ATTR_NULL,
5170};
5171
5172static struct bus_type wq_subsys = {
5173 .name = "workqueue",
5174 .dev_groups = wq_sysfs_groups,
5175};
5176
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005177static ssize_t wq_unbound_cpumask_show(struct device *dev,
5178 struct device_attribute *attr, char *buf)
5179{
5180 int written;
5181
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005182 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005183 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5184 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005185 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005186
5187 return written;
5188}
5189
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005190static ssize_t wq_unbound_cpumask_store(struct device *dev,
5191 struct device_attribute *attr, const char *buf, size_t count)
5192{
5193 cpumask_var_t cpumask;
5194 int ret;
5195
5196 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5197 return -ENOMEM;
5198
5199 ret = cpumask_parse(buf, cpumask);
5200 if (!ret)
5201 ret = workqueue_set_unbound_cpumask(cpumask);
5202
5203 free_cpumask_var(cpumask);
5204 return ret ? ret : count;
5205}
5206
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005207static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005208 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5209 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005210
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005211static int __init wq_sysfs_init(void)
5212{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005213 int err;
5214
5215 err = subsys_virtual_register(&wq_subsys, NULL);
5216 if (err)
5217 return err;
5218
5219 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005220}
5221core_initcall(wq_sysfs_init);
5222
5223static void wq_device_release(struct device *dev)
5224{
5225 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5226
5227 kfree(wq_dev);
5228}
5229
5230/**
5231 * workqueue_sysfs_register - make a workqueue visible in sysfs
5232 * @wq: the workqueue to register
5233 *
5234 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5235 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5236 * which is the preferred method.
5237 *
5238 * Workqueue user should use this function directly iff it wants to apply
5239 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5240 * apply_workqueue_attrs() may race against userland updating the
5241 * attributes.
5242 *
5243 * Return: 0 on success, -errno on failure.
5244 */
5245int workqueue_sysfs_register(struct workqueue_struct *wq)
5246{
5247 struct wq_device *wq_dev;
5248 int ret;
5249
5250 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305251 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005252 * attributes breaks ordering guarantee. Disallow exposing ordered
5253 * workqueues.
5254 */
5255 if (WARN_ON(wq->flags & __WQ_ORDERED))
5256 return -EINVAL;
5257
5258 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5259 if (!wq_dev)
5260 return -ENOMEM;
5261
5262 wq_dev->wq = wq;
5263 wq_dev->dev.bus = &wq_subsys;
5264 wq_dev->dev.init_name = wq->name;
5265 wq_dev->dev.release = wq_device_release;
5266
5267 /*
5268 * unbound_attrs are created separately. Suppress uevent until
5269 * everything is ready.
5270 */
5271 dev_set_uevent_suppress(&wq_dev->dev, true);
5272
5273 ret = device_register(&wq_dev->dev);
5274 if (ret) {
5275 kfree(wq_dev);
5276 wq->wq_dev = NULL;
5277 return ret;
5278 }
5279
5280 if (wq->flags & WQ_UNBOUND) {
5281 struct device_attribute *attr;
5282
5283 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5284 ret = device_create_file(&wq_dev->dev, attr);
5285 if (ret) {
5286 device_unregister(&wq_dev->dev);
5287 wq->wq_dev = NULL;
5288 return ret;
5289 }
5290 }
5291 }
5292
5293 dev_set_uevent_suppress(&wq_dev->dev, false);
5294 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5295 return 0;
5296}
5297
5298/**
5299 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5300 * @wq: the workqueue to unregister
5301 *
5302 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5303 */
5304static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5305{
5306 struct wq_device *wq_dev = wq->wq_dev;
5307
5308 if (!wq->wq_dev)
5309 return;
5310
5311 wq->wq_dev = NULL;
5312 device_unregister(&wq_dev->dev);
5313}
5314#else /* CONFIG_SYSFS */
5315static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5316#endif /* CONFIG_SYSFS */
5317
Tejun Heo82607adc2015-12-08 11:28:04 -05005318/*
5319 * Workqueue watchdog.
5320 *
5321 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5322 * flush dependency, a concurrency managed work item which stays RUNNING
5323 * indefinitely. Workqueue stalls can be very difficult to debug as the
5324 * usual warning mechanisms don't trigger and internal workqueue state is
5325 * largely opaque.
5326 *
5327 * Workqueue watchdog monitors all worker pools periodically and dumps
5328 * state if some pools failed to make forward progress for a while where
5329 * forward progress is defined as the first item on ->worklist changing.
5330 *
5331 * This mechanism is controlled through the kernel parameter
5332 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5333 * corresponding sysfs parameter file.
5334 */
5335#ifdef CONFIG_WQ_WATCHDOG
5336
5337static void wq_watchdog_timer_fn(unsigned long data);
5338
5339static unsigned long wq_watchdog_thresh = 30;
5340static struct timer_list wq_watchdog_timer =
5341 TIMER_DEFERRED_INITIALIZER(wq_watchdog_timer_fn, 0, 0);
5342
5343static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5344static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5345
5346static void wq_watchdog_reset_touched(void)
5347{
5348 int cpu;
5349
5350 wq_watchdog_touched = jiffies;
5351 for_each_possible_cpu(cpu)
5352 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5353}
5354
5355static void wq_watchdog_timer_fn(unsigned long data)
5356{
5357 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5358 bool lockup_detected = false;
5359 struct worker_pool *pool;
5360 int pi;
5361
5362 if (!thresh)
5363 return;
5364
5365 rcu_read_lock();
5366
5367 for_each_pool(pool, pi) {
5368 unsigned long pool_ts, touched, ts;
5369
5370 if (list_empty(&pool->worklist))
5371 continue;
5372
5373 /* get the latest of pool and touched timestamps */
5374 pool_ts = READ_ONCE(pool->watchdog_ts);
5375 touched = READ_ONCE(wq_watchdog_touched);
5376
5377 if (time_after(pool_ts, touched))
5378 ts = pool_ts;
5379 else
5380 ts = touched;
5381
5382 if (pool->cpu >= 0) {
5383 unsigned long cpu_touched =
5384 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5385 pool->cpu));
5386 if (time_after(cpu_touched, ts))
5387 ts = cpu_touched;
5388 }
5389
5390 /* did we stall? */
5391 if (time_after(jiffies, ts + thresh)) {
5392 lockup_detected = true;
5393 pr_emerg("BUG: workqueue lockup - pool");
5394 pr_cont_pool_info(pool);
5395 pr_cont(" stuck for %us!\n",
5396 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5397 }
5398 }
5399
5400 rcu_read_unlock();
5401
5402 if (lockup_detected)
5403 show_workqueue_state();
5404
5405 wq_watchdog_reset_touched();
5406 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5407}
5408
5409void wq_watchdog_touch(int cpu)
5410{
5411 if (cpu >= 0)
5412 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5413 else
5414 wq_watchdog_touched = jiffies;
5415}
5416
5417static void wq_watchdog_set_thresh(unsigned long thresh)
5418{
5419 wq_watchdog_thresh = 0;
5420 del_timer_sync(&wq_watchdog_timer);
5421
5422 if (thresh) {
5423 wq_watchdog_thresh = thresh;
5424 wq_watchdog_reset_touched();
5425 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5426 }
5427}
5428
5429static int wq_watchdog_param_set_thresh(const char *val,
5430 const struct kernel_param *kp)
5431{
5432 unsigned long thresh;
5433 int ret;
5434
5435 ret = kstrtoul(val, 0, &thresh);
5436 if (ret)
5437 return ret;
5438
5439 if (system_wq)
5440 wq_watchdog_set_thresh(thresh);
5441 else
5442 wq_watchdog_thresh = thresh;
5443
5444 return 0;
5445}
5446
5447static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5448 .set = wq_watchdog_param_set_thresh,
5449 .get = param_get_ulong,
5450};
5451
5452module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5453 0644);
5454
5455static void wq_watchdog_init(void)
5456{
5457 wq_watchdog_set_thresh(wq_watchdog_thresh);
5458}
5459
5460#else /* CONFIG_WQ_WATCHDOG */
5461
5462static inline void wq_watchdog_init(void) { }
5463
5464#endif /* CONFIG_WQ_WATCHDOG */
5465
Tejun Heobce90382013-04-01 11:23:32 -07005466static void __init wq_numa_init(void)
5467{
5468 cpumask_var_t *tbl;
5469 int node, cpu;
5470
Tejun Heobce90382013-04-01 11:23:32 -07005471 if (num_possible_nodes() <= 1)
5472 return;
5473
Tejun Heod55262c2013-04-01 11:23:38 -07005474 if (wq_disable_numa) {
5475 pr_info("workqueue: NUMA affinity support disabled\n");
5476 return;
5477 }
5478
Tejun Heo4c16bd32013-04-01 11:23:36 -07005479 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5480 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5481
Tejun Heobce90382013-04-01 11:23:32 -07005482 /*
5483 * We want masks of possible CPUs of each node which isn't readily
5484 * available. Build one from cpu_to_node() which should have been
5485 * fully initialized by now.
5486 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005487 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005488 BUG_ON(!tbl);
5489
5490 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005491 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005492 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005493
5494 for_each_possible_cpu(cpu) {
5495 node = cpu_to_node(cpu);
5496 if (WARN_ON(node == NUMA_NO_NODE)) {
5497 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5498 /* happens iff arch is bonkers, let's just proceed */
5499 return;
5500 }
5501 cpumask_set_cpu(cpu, tbl[node]);
5502 }
5503
5504 wq_numa_possible_cpumask = tbl;
5505 wq_numa_enabled = true;
5506}
5507
Suresh Siddha6ee05782010-07-30 14:57:37 -07005508static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005509{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005510 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5511 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005512
Tejun Heoe904e6c2013-03-12 11:29:57 -07005513 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5514
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005515 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5516 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5517
Tejun Heoe904e6c2013-03-12 11:29:57 -07005518 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5519
Tejun Heo65758202012-07-17 12:39:26 -07005520 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07005521 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02005522
Tejun Heobce90382013-04-01 11:23:32 -07005523 wq_numa_init();
5524
Tejun Heo706026c2013-01-24 11:01:34 -08005525 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005526 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005527 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005528
Tejun Heo7a4e3442013-03-12 11:30:00 -07005529 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005530 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005531 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005532 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005533 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005534 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005535 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005536
Tejun Heo9daf9e62013-01-24 11:01:33 -08005537 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005538 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005539 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005540 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005541 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005542 }
5543
Tejun Heoe22bee72010-06-29 10:07:14 +02005544 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07005545 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005546 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02005547
Tejun Heof02ae732013-03-12 11:30:03 -07005548 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07005549 pool->flags &= ~POOL_DISASSOCIATED;
Lai Jiangshan051e1852014-07-22 13:03:02 +08005550 BUG_ON(!create_worker(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07005551 }
Tejun Heoe22bee72010-06-29 10:07:14 +02005552 }
5553
Tejun Heo8a2b7532013-09-05 12:30:04 -04005554 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005555 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5556 struct workqueue_attrs *attrs;
5557
5558 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005559 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005560 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005561
5562 /*
5563 * An ordered wq should have only one pwq as ordering is
5564 * guaranteed by max_active which is enforced by pwqs.
5565 * Turn off NUMA so that dfl_pwq is used for all nodes.
5566 */
5567 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5568 attrs->nice = std_nice[i];
5569 attrs->no_numa = true;
5570 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005571 }
5572
Tejun Heod320c032010-06-29 10:07:14 +02005573 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005574 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005575 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005576 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5577 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005578 system_freezable_wq = alloc_workqueue("events_freezable",
5579 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305580 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5581 WQ_POWER_EFFICIENT, 0);
5582 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5583 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5584 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005585 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305586 !system_unbound_wq || !system_freezable_wq ||
5587 !system_power_efficient_wq ||
5588 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005589
5590 wq_watchdog_init();
5591
Suresh Siddha6ee05782010-07-30 14:57:37 -07005592 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005593}
Suresh Siddha6ee05782010-07-30 14:57:37 -07005594early_initcall(init_workqueues);