blob: 51d77e7c0989fcc55b617cf6140afe62e39013a9 [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 */
323static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
324 cpu_worker_pools);
325
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700326static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700327
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700328/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700329static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
330
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700331/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700332static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
333
Tejun Heo8a2b7532013-09-05 12:30:04 -0400334/* I: attributes used when instantiating ordered pools on demand */
335static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
336
Tejun Heod320c032010-06-29 10:07:14 +0200337struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400338EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300339struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900340EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300341struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200342EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300343struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200344EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300345struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100346EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530347struct workqueue_struct *system_power_efficient_wq __read_mostly;
348EXPORT_SYMBOL_GPL(system_power_efficient_wq);
349struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
350EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200351
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700352static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800353static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700354
Tejun Heo97bd2342010-10-05 10:41:14 +0200355#define CREATE_TRACE_POINTS
356#include <trace/events/workqueue.h>
357
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700358#define assert_rcu_or_pool_mutex() \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700359 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
360 !lockdep_is_held(&wq_pool_mutex), \
361 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700362
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700363#define assert_rcu_or_wq_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700364 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
365 !lockdep_is_held(&wq->mutex), \
366 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700367
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800368#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700369 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
370 !lockdep_is_held(&wq->mutex) && \
371 !lockdep_is_held(&wq_pool_mutex), \
372 "sched RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800373
Tejun Heof02ae732013-03-12 11:30:03 -0700374#define for_each_cpu_worker_pool(pool, cpu) \
375 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
376 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700377 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700378
Tejun Heo49e3cf42013-03-12 11:29:58 -0700379/**
Tejun Heo17116962013-03-12 11:29:58 -0700380 * for_each_pool - iterate through all worker_pools in the system
381 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700382 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700383 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700384 * This must be called either with wq_pool_mutex held or sched RCU read
385 * locked. If the pool needs to be used beyond the locking in effect, the
386 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700387 *
388 * The if/else clause exists only for the lockdep assertion and can be
389 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700390 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700391#define for_each_pool(pool, pi) \
392 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700393 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700394 else
Tejun Heo17116962013-03-12 11:29:58 -0700395
396/**
Tejun Heo822d8402013-03-19 13:45:21 -0700397 * for_each_pool_worker - iterate through all workers of a worker_pool
398 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700399 * @pool: worker_pool to iterate workers of
400 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800401 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700402 *
403 * The if/else clause exists only for the lockdep assertion and can be
404 * ignored.
405 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800406#define for_each_pool_worker(worker, pool) \
407 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800408 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700409 else
410
411/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700412 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
413 * @pwq: iteration cursor
414 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700415 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700416 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700417 * If the pwq needs to be used beyond the locking in effect, the caller is
418 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700419 *
420 * The if/else clause exists only for the lockdep assertion and can be
421 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700422 */
423#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700424 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700425 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700426 else
Tejun Heof3421792010-07-02 10:03:51 +0200427
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900428#ifdef CONFIG_DEBUG_OBJECTS_WORK
429
430static struct debug_obj_descr work_debug_descr;
431
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100432static void *work_debug_hint(void *addr)
433{
434 return ((struct work_struct *) addr)->func;
435}
436
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900437/*
438 * fixup_init is called when:
439 * - an active object is initialized
440 */
441static int work_fixup_init(void *addr, enum debug_obj_state state)
442{
443 struct work_struct *work = addr;
444
445 switch (state) {
446 case ODEBUG_STATE_ACTIVE:
447 cancel_work_sync(work);
448 debug_object_init(work, &work_debug_descr);
449 return 1;
450 default:
451 return 0;
452 }
453}
454
455/*
456 * fixup_activate is called when:
457 * - an active object is activated
458 * - an unknown object is activated (might be a statically initialized object)
459 */
460static int work_fixup_activate(void *addr, enum debug_obj_state state)
461{
462 struct work_struct *work = addr;
463
464 switch (state) {
465
466 case ODEBUG_STATE_NOTAVAILABLE:
467 /*
468 * This is not really a fixup. The work struct was
469 * statically initialized. We just make sure that it
470 * is tracked in the object tracker.
471 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200472 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900473 debug_object_init(work, &work_debug_descr);
474 debug_object_activate(work, &work_debug_descr);
475 return 0;
476 }
477 WARN_ON_ONCE(1);
478 return 0;
479
480 case ODEBUG_STATE_ACTIVE:
481 WARN_ON(1);
482
483 default:
484 return 0;
485 }
486}
487
488/*
489 * fixup_free is called when:
490 * - an active object is freed
491 */
492static int work_fixup_free(void *addr, enum debug_obj_state state)
493{
494 struct work_struct *work = addr;
495
496 switch (state) {
497 case ODEBUG_STATE_ACTIVE:
498 cancel_work_sync(work);
499 debug_object_free(work, &work_debug_descr);
500 return 1;
501 default:
502 return 0;
503 }
504}
505
506static struct debug_obj_descr work_debug_descr = {
507 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100508 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900509 .fixup_init = work_fixup_init,
510 .fixup_activate = work_fixup_activate,
511 .fixup_free = work_fixup_free,
512};
513
514static inline void debug_work_activate(struct work_struct *work)
515{
516 debug_object_activate(work, &work_debug_descr);
517}
518
519static inline void debug_work_deactivate(struct work_struct *work)
520{
521 debug_object_deactivate(work, &work_debug_descr);
522}
523
524void __init_work(struct work_struct *work, int onstack)
525{
526 if (onstack)
527 debug_object_init_on_stack(work, &work_debug_descr);
528 else
529 debug_object_init(work, &work_debug_descr);
530}
531EXPORT_SYMBOL_GPL(__init_work);
532
533void destroy_work_on_stack(struct work_struct *work)
534{
535 debug_object_free(work, &work_debug_descr);
536}
537EXPORT_SYMBOL_GPL(destroy_work_on_stack);
538
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000539void destroy_delayed_work_on_stack(struct delayed_work *work)
540{
541 destroy_timer_on_stack(&work->timer);
542 debug_object_free(&work->work, &work_debug_descr);
543}
544EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
545
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900546#else
547static inline void debug_work_activate(struct work_struct *work) { }
548static inline void debug_work_deactivate(struct work_struct *work) { }
549#endif
550
Li Bin4e8b22b2013-09-10 09:52:35 +0800551/**
552 * worker_pool_assign_id - allocate ID and assing it to @pool
553 * @pool: the pool pointer of interest
554 *
555 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
556 * successfully, -errno on failure.
557 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800558static int worker_pool_assign_id(struct worker_pool *pool)
559{
560 int ret;
561
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700562 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700563
Li Bin4e8b22b2013-09-10 09:52:35 +0800564 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
565 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700566 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700567 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700568 return 0;
569 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800570 return ret;
571}
572
Tejun Heo76af4d92013-03-12 11:30:00 -0700573/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700574 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
575 * @wq: the target workqueue
576 * @node: the node ID
577 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800578 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
579 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700580 * If the pwq needs to be used beyond the locking in effect, the caller is
581 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700582 *
583 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700584 */
585static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
586 int node)
587{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800588 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700589 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
590}
591
Tejun Heo73f53c42010-06-29 10:07:11 +0200592static unsigned int work_color_to_flags(int color)
593{
594 return color << WORK_STRUCT_COLOR_SHIFT;
595}
596
597static int get_work_color(struct work_struct *work)
598{
599 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
600 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
601}
602
603static int work_next_color(int color)
604{
605 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700606}
607
David Howells4594bf12006-12-07 11:33:26 +0000608/*
Tejun Heo112202d2013-02-13 19:29:12 -0800609 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
610 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800611 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200612 *
Tejun Heo112202d2013-02-13 19:29:12 -0800613 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
614 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700615 * work->data. These functions should only be called while the work is
616 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200617 *
Tejun Heo112202d2013-02-13 19:29:12 -0800618 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800619 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800620 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800621 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700622 *
623 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
624 * canceled. While being canceled, a work item may have its PENDING set
625 * but stay off timer and worklist for arbitrarily long and nobody should
626 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000627 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200628static inline void set_work_data(struct work_struct *work, unsigned long data,
629 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000630{
Tejun Heo6183c002013-03-12 11:29:57 -0700631 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200632 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000633}
David Howells365970a2006-11-22 14:54:49 +0000634
Tejun Heo112202d2013-02-13 19:29:12 -0800635static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200636 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200637{
Tejun Heo112202d2013-02-13 19:29:12 -0800638 set_work_data(work, (unsigned long)pwq,
639 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200640}
641
Lai Jiangshan4468a002013-02-06 18:04:53 -0800642static void set_work_pool_and_keep_pending(struct work_struct *work,
643 int pool_id)
644{
645 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
646 WORK_STRUCT_PENDING);
647}
648
Tejun Heo7c3eed52013-01-24 11:01:33 -0800649static void set_work_pool_and_clear_pending(struct work_struct *work,
650 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000651{
Tejun Heo23657bb2012-08-13 17:08:19 -0700652 /*
653 * The following wmb is paired with the implied mb in
654 * test_and_set_bit(PENDING) and ensures all updates to @work made
655 * here are visible to and precede any updates by the next PENDING
656 * owner.
657 */
658 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800659 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200660}
661
662static void clear_work_data(struct work_struct *work)
663{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800664 smp_wmb(); /* see set_work_pool_and_clear_pending() */
665 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200666}
667
Tejun Heo112202d2013-02-13 19:29:12 -0800668static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200669{
Tejun Heoe1201532010-07-22 14:14:25 +0200670 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200671
Tejun Heo112202d2013-02-13 19:29:12 -0800672 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200673 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
674 else
675 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200676}
677
Tejun Heo7c3eed52013-01-24 11:01:33 -0800678/**
679 * get_work_pool - return the worker_pool a given work was associated with
680 * @work: the work item of interest
681 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700682 * Pools are created and destroyed under wq_pool_mutex, and allows read
683 * access under sched-RCU read lock. As such, this function should be
684 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700685 *
686 * All fields of the returned pool are accessible as long as the above
687 * mentioned locking is in effect. If the returned pool needs to be used
688 * beyond the critical section, the caller is responsible for ensuring the
689 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700690 *
691 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800692 */
693static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200694{
Tejun Heoe1201532010-07-22 14:14:25 +0200695 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800696 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200697
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700698 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700699
Tejun Heo112202d2013-02-13 19:29:12 -0800700 if (data & WORK_STRUCT_PWQ)
701 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800702 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200703
Tejun Heo7c3eed52013-01-24 11:01:33 -0800704 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
705 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200706 return NULL;
707
Tejun Heofa1b54e2013-03-12 11:30:00 -0700708 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800709}
710
711/**
712 * get_work_pool_id - return the worker pool ID a given work is associated with
713 * @work: the work item of interest
714 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700715 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800716 * %WORK_OFFQ_POOL_NONE if none.
717 */
718static int get_work_pool_id(struct work_struct *work)
719{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800720 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800721
Tejun Heo112202d2013-02-13 19:29:12 -0800722 if (data & WORK_STRUCT_PWQ)
723 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800724 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
725
726 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800727}
728
Tejun Heobbb68df2012-08-03 10:30:46 -0700729static void mark_work_canceling(struct work_struct *work)
730{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800731 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700732
Tejun Heo7c3eed52013-01-24 11:01:33 -0800733 pool_id <<= WORK_OFFQ_POOL_SHIFT;
734 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700735}
736
737static bool work_is_canceling(struct work_struct *work)
738{
739 unsigned long data = atomic_long_read(&work->data);
740
Tejun Heo112202d2013-02-13 19:29:12 -0800741 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700742}
743
David Howells365970a2006-11-22 14:54:49 +0000744/*
Tejun Heo32704762012-07-13 22:16:45 -0700745 * Policy functions. These define the policies on how the global worker
746 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800747 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000748 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200749
Tejun Heo63d95a92012-07-12 14:46:37 -0700750static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000751{
Tejun Heoe19e3972013-01-24 11:39:44 -0800752 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000753}
754
Tejun Heoe22bee72010-06-29 10:07:14 +0200755/*
756 * Need to wake up a worker? Called from anything but currently
757 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700758 *
759 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800760 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700761 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200762 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700763static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000764{
Tejun Heo63d95a92012-07-12 14:46:37 -0700765 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000766}
767
Tejun Heoe22bee72010-06-29 10:07:14 +0200768/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700769static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200770{
Tejun Heo63d95a92012-07-12 14:46:37 -0700771 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200772}
773
774/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700775static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200776{
Tejun Heoe19e3972013-01-24 11:39:44 -0800777 return !list_empty(&pool->worklist) &&
778 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200779}
780
781/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700782static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200783{
Tejun Heo63d95a92012-07-12 14:46:37 -0700784 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200785}
786
Tejun Heoe22bee72010-06-29 10:07:14 +0200787/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700788static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200789{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700790 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700791 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
792 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200793
794 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
795}
796
797/*
798 * Wake up functions.
799 */
800
Lai Jiangshan1037de32014-05-22 16:44:07 +0800801/* Return the first idle worker. Safe with preemption disabled */
802static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200803{
Tejun Heo63d95a92012-07-12 14:46:37 -0700804 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200805 return NULL;
806
Tejun Heo63d95a92012-07-12 14:46:37 -0700807 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200808}
809
810/**
811 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700812 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200813 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700814 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200815 *
816 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800817 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200818 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700819static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200820{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800821 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200822
823 if (likely(worker))
824 wake_up_process(worker->task);
825}
826
Tejun Heo4690c4a2010-06-29 10:07:10 +0200827/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200828 * wq_worker_waking_up - a worker is waking up
829 * @task: task waking up
830 * @cpu: CPU @task is waking up to
831 *
832 * This function is called during try_to_wake_up() when a worker is
833 * being awoken.
834 *
835 * CONTEXT:
836 * spin_lock_irq(rq->lock)
837 */
Tejun Heod84ff052013-03-12 11:29:59 -0700838void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200839{
840 struct worker *worker = kthread_data(task);
841
Joonsoo Kim36576002012-10-26 23:03:49 +0900842 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800843 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800844 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900845 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200846}
847
848/**
849 * wq_worker_sleeping - a worker is going to sleep
850 * @task: task going to sleep
851 * @cpu: CPU in question, must be the current CPU number
852 *
853 * This function is called during schedule() when a busy worker is
854 * going to sleep. Worker on the same cpu can be woken up by
855 * returning pointer to its task.
856 *
857 * CONTEXT:
858 * spin_lock_irq(rq->lock)
859 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700860 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200861 * Worker task on @cpu to wake up, %NULL if none.
862 */
Tejun Heod84ff052013-03-12 11:29:59 -0700863struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200864{
865 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800866 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200867
Tejun Heo111c2252013-01-17 17:16:24 -0800868 /*
869 * Rescuers, which may not have all the fields set up like normal
870 * workers, also reach here, let's not access anything before
871 * checking NOT_RUNNING.
872 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500873 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200874 return NULL;
875
Tejun Heo111c2252013-01-17 17:16:24 -0800876 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800877
Tejun Heoe22bee72010-06-29 10:07:14 +0200878 /* this can only happen on the local cpu */
Lai Jiangshan92b69f52014-06-03 15:33:08 +0800879 if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu))
Tejun Heo6183c002013-03-12 11:29:57 -0700880 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200881
882 /*
883 * The counterpart of the following dec_and_test, implied mb,
884 * worklist not empty test sequence is in insert_work().
885 * Please read comment there.
886 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700887 * NOT_RUNNING is clear. This means that we're bound to and
888 * running on the local cpu w/ rq lock held and preemption
889 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800890 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700891 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200892 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800893 if (atomic_dec_and_test(&pool->nr_running) &&
894 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800895 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200896 return to_wakeup ? to_wakeup->task : NULL;
897}
898
899/**
900 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200901 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200902 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200903 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800904 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200905 *
Tejun Heocb444762010-07-02 10:03:50 +0200906 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800907 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200908 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800909static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200910{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700911 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200912
Tejun Heocb444762010-07-02 10:03:50 +0200913 WARN_ON_ONCE(worker->task != current);
914
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800915 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200916 if ((flags & WORKER_NOT_RUNNING) &&
917 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800918 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200919 }
920
Tejun Heod302f012010-06-29 10:07:13 +0200921 worker->flags |= flags;
922}
923
924/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200925 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200926 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200927 * @flags: flags to clear
928 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200929 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200930 *
Tejun Heocb444762010-07-02 10:03:50 +0200931 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800932 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200933 */
934static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
935{
Tejun Heo63d95a92012-07-12 14:46:37 -0700936 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200937 unsigned int oflags = worker->flags;
938
Tejun Heocb444762010-07-02 10:03:50 +0200939 WARN_ON_ONCE(worker->task != current);
940
Tejun Heod302f012010-06-29 10:07:13 +0200941 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200942
Tejun Heo42c025f2011-01-11 15:58:49 +0100943 /*
944 * If transitioning out of NOT_RUNNING, increment nr_running. Note
945 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
946 * of multiple flags, not a single flag.
947 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200948 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
949 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800950 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200951}
952
953/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200954 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800955 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200956 * @work: work to find worker for
957 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800958 * Find a worker which is executing @work on @pool by searching
959 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800960 * to match, its current execution should match the address of @work and
961 * its work function. This is to avoid unwanted dependency between
962 * unrelated work executions through a work item being recycled while still
963 * being executed.
964 *
965 * This is a bit tricky. A work item may be freed once its execution
966 * starts and nothing prevents the freed area from being recycled for
967 * another work item. If the same work item address ends up being reused
968 * before the original execution finishes, workqueue will identify the
969 * recycled work item as currently executing and make it wait until the
970 * current execution finishes, introducing an unwanted dependency.
971 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700972 * This function checks the work item address and work function to avoid
973 * false positives. Note that this isn't complete as one may construct a
974 * work function which can introduce dependency onto itself through a
975 * recycled work item. Well, if somebody wants to shoot oneself in the
976 * foot that badly, there's only so much we can do, and if such deadlock
977 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200978 *
979 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800980 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200981 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700982 * Return:
983 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200984 * otherwise.
985 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800986static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200987 struct work_struct *work)
988{
Sasha Levin42f85702012-12-17 10:01:23 -0500989 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500990
Sasha Levinb67bfe02013-02-27 17:06:00 -0800991 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800992 (unsigned long)work)
993 if (worker->current_work == work &&
994 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500995 return worker;
996
997 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200998}
999
1000/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001001 * move_linked_works - move linked works to a list
1002 * @work: start of series of works to be scheduled
1003 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301004 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001005 *
1006 * Schedule linked works starting from @work to @head. Work series to
1007 * be scheduled starts at @work and includes any consecutive work with
1008 * WORK_STRUCT_LINKED set in its predecessor.
1009 *
1010 * If @nextp is not NULL, it's updated to point to the next work of
1011 * the last scheduled work. This allows move_linked_works() to be
1012 * nested inside outer list_for_each_entry_safe().
1013 *
1014 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001015 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001016 */
1017static void move_linked_works(struct work_struct *work, struct list_head *head,
1018 struct work_struct **nextp)
1019{
1020 struct work_struct *n;
1021
1022 /*
1023 * Linked worklist will always end before the end of the list,
1024 * use NULL for list head.
1025 */
1026 list_for_each_entry_safe_from(work, n, NULL, entry) {
1027 list_move_tail(&work->entry, head);
1028 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1029 break;
1030 }
1031
1032 /*
1033 * If we're already inside safe list traversal and have moved
1034 * multiple works to the scheduled queue, the next position
1035 * needs to be updated.
1036 */
1037 if (nextp)
1038 *nextp = n;
1039}
1040
Tejun Heo8864b4e2013-03-12 11:30:04 -07001041/**
1042 * get_pwq - get an extra reference on the specified pool_workqueue
1043 * @pwq: pool_workqueue to get
1044 *
1045 * Obtain an extra reference on @pwq. The caller should guarantee that
1046 * @pwq has positive refcnt and be holding the matching pool->lock.
1047 */
1048static void get_pwq(struct pool_workqueue *pwq)
1049{
1050 lockdep_assert_held(&pwq->pool->lock);
1051 WARN_ON_ONCE(pwq->refcnt <= 0);
1052 pwq->refcnt++;
1053}
1054
1055/**
1056 * put_pwq - put a pool_workqueue reference
1057 * @pwq: pool_workqueue to put
1058 *
1059 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1060 * destruction. The caller should be holding the matching pool->lock.
1061 */
1062static void put_pwq(struct pool_workqueue *pwq)
1063{
1064 lockdep_assert_held(&pwq->pool->lock);
1065 if (likely(--pwq->refcnt))
1066 return;
1067 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1068 return;
1069 /*
1070 * @pwq can't be released under pool->lock, bounce to
1071 * pwq_unbound_release_workfn(). This never recurses on the same
1072 * pool->lock as this path is taken only for unbound workqueues and
1073 * the release work item is scheduled on a per-cpu workqueue. To
1074 * avoid lockdep warning, unbound pool->locks are given lockdep
1075 * subclass of 1 in get_unbound_pool().
1076 */
1077 schedule_work(&pwq->unbound_release_work);
1078}
1079
Tejun Heodce90d42013-04-01 11:23:35 -07001080/**
1081 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1082 * @pwq: pool_workqueue to put (can be %NULL)
1083 *
1084 * put_pwq() with locking. This function also allows %NULL @pwq.
1085 */
1086static void put_pwq_unlocked(struct pool_workqueue *pwq)
1087{
1088 if (pwq) {
1089 /*
1090 * As both pwqs and pools are sched-RCU protected, the
1091 * following lock operations are safe.
1092 */
1093 spin_lock_irq(&pwq->pool->lock);
1094 put_pwq(pwq);
1095 spin_unlock_irq(&pwq->pool->lock);
1096 }
1097}
1098
Tejun Heo112202d2013-02-13 19:29:12 -08001099static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001100{
Tejun Heo112202d2013-02-13 19:29:12 -08001101 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001102
1103 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001104 if (list_empty(&pwq->pool->worklist))
1105 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001106 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001107 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001108 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001109}
1110
Tejun Heo112202d2013-02-13 19:29:12 -08001111static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001112{
Tejun Heo112202d2013-02-13 19:29:12 -08001113 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001114 struct work_struct, entry);
1115
Tejun Heo112202d2013-02-13 19:29:12 -08001116 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001117}
1118
Tejun Heobf4ede02012-08-03 10:30:46 -07001119/**
Tejun Heo112202d2013-02-13 19:29:12 -08001120 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1121 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001122 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001123 *
1124 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001125 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001126 *
1127 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001128 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001129 */
Tejun Heo112202d2013-02-13 19:29:12 -08001130static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001131{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001132 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001133 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001134 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001135
Tejun Heo112202d2013-02-13 19:29:12 -08001136 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001137
Tejun Heo112202d2013-02-13 19:29:12 -08001138 pwq->nr_active--;
1139 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001140 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001141 if (pwq->nr_active < pwq->max_active)
1142 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001143 }
1144
1145 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001146 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001147 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001148
1149 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001150 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001151 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001152
Tejun Heo112202d2013-02-13 19:29:12 -08001153 /* this pwq is done, clear flush_color */
1154 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001155
1156 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001157 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001158 * will handle the rest.
1159 */
Tejun Heo112202d2013-02-13 19:29:12 -08001160 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1161 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001162out_put:
1163 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001164}
1165
Tejun Heo36e227d2012-08-03 10:30:46 -07001166/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001167 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001168 * @work: work item to steal
1169 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001170 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001171 *
1172 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001173 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001174 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001175 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001176 * 1 if @work was pending and we successfully stole PENDING
1177 * 0 if @work was idle and we claimed PENDING
1178 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001179 * -ENOENT if someone else is canceling @work, this state may persist
1180 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001181 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001182 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001183 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001184 * interrupted while holding PENDING and @work off queue, irq must be
1185 * disabled on entry. This, combined with delayed_work->timer being
1186 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001187 *
1188 * On successful return, >= 0, irq is disabled and the caller is
1189 * responsible for releasing it using local_irq_restore(*@flags).
1190 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001191 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001192 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001193static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1194 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001195{
Tejun Heod565ed62013-01-24 11:01:33 -08001196 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001197 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001198
Tejun Heobbb68df2012-08-03 10:30:46 -07001199 local_irq_save(*flags);
1200
Tejun Heo36e227d2012-08-03 10:30:46 -07001201 /* try to steal the timer if it exists */
1202 if (is_dwork) {
1203 struct delayed_work *dwork = to_delayed_work(work);
1204
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001205 /*
1206 * dwork->timer is irqsafe. If del_timer() fails, it's
1207 * guaranteed that the timer is not queued anywhere and not
1208 * running on the local CPU.
1209 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001210 if (likely(del_timer(&dwork->timer)))
1211 return 1;
1212 }
1213
1214 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001215 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1216 return 0;
1217
1218 /*
1219 * The queueing is in progress, or it is already queued. Try to
1220 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1221 */
Tejun Heod565ed62013-01-24 11:01:33 -08001222 pool = get_work_pool(work);
1223 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001224 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001225
Tejun Heod565ed62013-01-24 11:01:33 -08001226 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001227 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001228 * work->data is guaranteed to point to pwq only while the work
1229 * item is queued on pwq->wq, and both updating work->data to point
1230 * to pwq on queueing and to pool on dequeueing are done under
1231 * pwq->pool->lock. This in turn guarantees that, if work->data
1232 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001233 * item is currently queued on that pool.
1234 */
Tejun Heo112202d2013-02-13 19:29:12 -08001235 pwq = get_work_pwq(work);
1236 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001237 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001238
Tejun Heo16062832013-02-06 18:04:53 -08001239 /*
1240 * A delayed work item cannot be grabbed directly because
1241 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001242 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001243 * management later on and cause stall. Make sure the work
1244 * item is activated before grabbing.
1245 */
1246 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001247 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001248
Tejun Heo16062832013-02-06 18:04:53 -08001249 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001250 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001251
Tejun Heo112202d2013-02-13 19:29:12 -08001252 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001253 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001254
Tejun Heo16062832013-02-06 18:04:53 -08001255 spin_unlock(&pool->lock);
1256 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001257 }
Tejun Heod565ed62013-01-24 11:01:33 -08001258 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001259fail:
1260 local_irq_restore(*flags);
1261 if (work_is_canceling(work))
1262 return -ENOENT;
1263 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001264 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001265}
1266
1267/**
Tejun Heo706026c2013-01-24 11:01:34 -08001268 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001269 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001270 * @work: work to insert
1271 * @head: insertion point
1272 * @extra_flags: extra WORK_STRUCT_* flags to set
1273 *
Tejun Heo112202d2013-02-13 19:29:12 -08001274 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001275 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001276 *
1277 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001278 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001279 */
Tejun Heo112202d2013-02-13 19:29:12 -08001280static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1281 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001282{
Tejun Heo112202d2013-02-13 19:29:12 -08001283 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001284
Tejun Heo4690c4a2010-06-29 10:07:10 +02001285 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001286 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001287 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001288 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001289
1290 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001291 * Ensure either wq_worker_sleeping() sees the above
1292 * list_add_tail() or we see zero nr_running to avoid workers lying
1293 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001294 */
1295 smp_mb();
1296
Tejun Heo63d95a92012-07-12 14:46:37 -07001297 if (__need_more_worker(pool))
1298 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001299}
1300
Tejun Heoc8efcc22010-12-20 19:32:04 +01001301/*
1302 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001303 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001304 */
1305static bool is_chained_work(struct workqueue_struct *wq)
1306{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001307 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001308
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001309 worker = current_wq_worker();
1310 /*
1311 * Return %true iff I'm a worker execuing a work item on @wq. If
1312 * I'm @worker, it's safe to dereference it without locking.
1313 */
Tejun Heo112202d2013-02-13 19:29:12 -08001314 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001315}
1316
Mike Galbraithef5571802016-02-09 17:59:38 -05001317/*
1318 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1319 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1320 * avoid perturbing sensitive tasks.
1321 */
1322static int wq_select_unbound_cpu(int cpu)
1323{
Tejun Heof303fcc2016-02-09 17:59:38 -05001324 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001325 int new_cpu;
1326
Tejun Heof303fcc2016-02-09 17:59:38 -05001327 if (likely(!wq_debug_force_rr_cpu)) {
1328 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1329 return cpu;
1330 } else if (!printed_dbg_warning) {
1331 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1332 printed_dbg_warning = true;
1333 }
1334
Mike Galbraithef5571802016-02-09 17:59:38 -05001335 if (cpumask_empty(wq_unbound_cpumask))
1336 return cpu;
1337
1338 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1339 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1340 if (unlikely(new_cpu >= nr_cpu_ids)) {
1341 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1342 if (unlikely(new_cpu >= nr_cpu_ids))
1343 return cpu;
1344 }
1345 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1346
1347 return new_cpu;
1348}
1349
Tejun Heod84ff052013-03-12 11:29:59 -07001350static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 struct work_struct *work)
1352{
Tejun Heo112202d2013-02-13 19:29:12 -08001353 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001354 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001355 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001356 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001357 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001358
1359 /*
1360 * While a work item is PENDING && off queue, a task trying to
1361 * steal the PENDING will busy-loop waiting for it to either get
1362 * queued or lose PENDING. Grabbing PENDING and queueing should
1363 * happen with IRQ disabled.
1364 */
1365 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001367 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001368
Li Bin9ef28a72013-09-09 13:13:58 +08001369 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001370 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001371 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001372 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001373retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001374 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001375 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001376
Tejun Heoc9178082013-03-12 11:30:04 -07001377 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001378 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001379 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001380 else
1381 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001382
Tejun Heoc9178082013-03-12 11:30:04 -07001383 /*
1384 * If @work was previously on a different pool, it might still be
1385 * running there, in which case the work needs to be queued on that
1386 * pool to guarantee non-reentrancy.
1387 */
1388 last_pool = get_work_pool(work);
1389 if (last_pool && last_pool != pwq->pool) {
1390 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001391
Tejun Heoc9178082013-03-12 11:30:04 -07001392 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001393
Tejun Heoc9178082013-03-12 11:30:04 -07001394 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001395
Tejun Heoc9178082013-03-12 11:30:04 -07001396 if (worker && worker->current_pwq->wq == wq) {
1397 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001398 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001399 /* meh... not running there, queue here */
1400 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001401 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001402 }
Tejun Heof3421792010-07-02 10:03:51 +02001403 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001404 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001405 }
1406
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001407 /*
1408 * pwq is determined and locked. For unbound pools, we could have
1409 * raced with pwq release and it could already be dead. If its
1410 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001411 * without another pwq replacing it in the numa_pwq_tbl or while
1412 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001413 * make forward-progress.
1414 */
1415 if (unlikely(!pwq->refcnt)) {
1416 if (wq->flags & WQ_UNBOUND) {
1417 spin_unlock(&pwq->pool->lock);
1418 cpu_relax();
1419 goto retry;
1420 }
1421 /* oops */
1422 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1423 wq->name, cpu);
1424 }
1425
Tejun Heo112202d2013-02-13 19:29:12 -08001426 /* pwq determined, queue */
1427 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001428
Dan Carpenterf5b25522012-04-13 22:06:58 +03001429 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001430 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001431 return;
1432 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001433
Tejun Heo112202d2013-02-13 19:29:12 -08001434 pwq->nr_in_flight[pwq->work_color]++;
1435 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001436
Tejun Heo112202d2013-02-13 19:29:12 -08001437 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001438 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001439 pwq->nr_active++;
1440 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001441 if (list_empty(worklist))
1442 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001443 } else {
1444 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001445 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001446 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001447
Tejun Heo112202d2013-02-13 19:29:12 -08001448 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001449
Tejun Heo112202d2013-02-13 19:29:12 -08001450 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451}
1452
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001453/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001454 * queue_work_on - queue work on specific cpu
1455 * @cpu: CPU number to execute work on
1456 * @wq: workqueue to use
1457 * @work: work to queue
1458 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001459 * We queue the work to a specific CPU, the caller must ensure it
1460 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001461 *
1462 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001463 */
Tejun Heod4283e92012-08-03 10:30:44 -07001464bool queue_work_on(int cpu, struct workqueue_struct *wq,
1465 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001466{
Tejun Heod4283e92012-08-03 10:30:44 -07001467 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001468 unsigned long flags;
1469
1470 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001471
Tejun Heo22df02b2010-06-29 10:07:10 +02001472 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001473 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001474 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001475 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001476
1477 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001478 return ret;
1479}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001480EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001481
Tejun Heod8e794d2012-08-03 10:30:45 -07001482void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483{
David Howells52bad642006-11-22 14:54:01 +00001484 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001486 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001487 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001489EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001491static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1492 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001494 struct timer_list *timer = &dwork->timer;
1495 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001497 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1498 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001499 WARN_ON_ONCE(timer_pending(timer));
1500 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001501
Tejun Heo8852aac2012-12-01 16:23:42 -08001502 /*
1503 * If @delay is 0, queue @dwork->work immediately. This is for
1504 * both optimization and correctness. The earliest @timer can
1505 * expire is on the closest next tick and delayed_work users depend
1506 * on that there's no such delay when @delay is 0.
1507 */
1508 if (!delay) {
1509 __queue_work(cpu, wq, &dwork->work);
1510 return;
1511 }
1512
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001513 timer_stats_timer_set_start_info(&dwork->timer);
1514
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001515 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001516 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001517 timer->expires = jiffies + delay;
1518
Tejun Heo041bd122016-02-09 16:11:26 -05001519 if (unlikely(cpu != WORK_CPU_UNBOUND))
1520 add_timer_on(timer, cpu);
1521 else
1522 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523}
1524
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001525/**
1526 * queue_delayed_work_on - queue work on specific CPU after delay
1527 * @cpu: CPU number to execute work on
1528 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001529 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001530 * @delay: number of jiffies to wait before queueing
1531 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001532 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001533 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1534 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001535 */
Tejun Heod4283e92012-08-03 10:30:44 -07001536bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1537 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001538{
David Howells52bad642006-11-22 14:54:01 +00001539 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001540 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001541 unsigned long flags;
1542
1543 /* read the comment in __queue_work() */
1544 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001545
Tejun Heo22df02b2010-06-29 10:07:10 +02001546 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001547 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001548 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001549 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001550
1551 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001552 return ret;
1553}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001554EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555
Tejun Heoc8e55f32010-06-29 10:07:12 +02001556/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001557 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1558 * @cpu: CPU number to execute work on
1559 * @wq: workqueue to use
1560 * @dwork: work to queue
1561 * @delay: number of jiffies to wait before queueing
1562 *
1563 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1564 * modify @dwork's timer so that it expires after @delay. If @delay is
1565 * zero, @work is guaranteed to be scheduled immediately regardless of its
1566 * current state.
1567 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001568 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001569 * pending and its timer was modified.
1570 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001571 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001572 * See try_to_grab_pending() for details.
1573 */
1574bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1575 struct delayed_work *dwork, unsigned long delay)
1576{
1577 unsigned long flags;
1578 int ret;
1579
1580 do {
1581 ret = try_to_grab_pending(&dwork->work, true, &flags);
1582 } while (unlikely(ret == -EAGAIN));
1583
1584 if (likely(ret >= 0)) {
1585 __queue_delayed_work(cpu, wq, dwork, delay);
1586 local_irq_restore(flags);
1587 }
1588
1589 /* -ENOENT from try_to_grab_pending() becomes %true */
1590 return ret;
1591}
1592EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1593
1594/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001595 * worker_enter_idle - enter idle state
1596 * @worker: worker which is entering idle state
1597 *
1598 * @worker is entering idle state. Update stats and idle timer if
1599 * necessary.
1600 *
1601 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001602 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001603 */
1604static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001606 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
Tejun Heo6183c002013-03-12 11:29:57 -07001608 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1609 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1610 (worker->hentry.next || worker->hentry.pprev)))
1611 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612
Lai Jiangshan051e1852014-07-22 13:03:02 +08001613 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001614 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001615 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001616 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001617
Tejun Heoc8e55f32010-06-29 10:07:12 +02001618 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001619 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001620
Tejun Heo628c78e2012-07-17 12:39:27 -07001621 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1622 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001623
Tejun Heo544ecf32012-05-14 15:04:50 -07001624 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001625 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001626 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001627 * nr_running, the warning may trigger spuriously. Check iff
1628 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001629 */
Tejun Heo24647572013-01-24 11:01:33 -08001630 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001631 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001632 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633}
1634
Tejun Heoc8e55f32010-06-29 10:07:12 +02001635/**
1636 * worker_leave_idle - leave idle state
1637 * @worker: worker which is leaving idle state
1638 *
1639 * @worker is leaving idle state. Update stats.
1640 *
1641 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001642 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001643 */
1644static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001646 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647
Tejun Heo6183c002013-03-12 11:29:57 -07001648 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1649 return;
Tejun Heod302f012010-06-29 10:07:13 +02001650 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001651 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001652 list_del_init(&worker->entry);
1653}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001655static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001656{
1657 struct worker *worker;
1658
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001659 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001660 if (worker) {
1661 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001662 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001663 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001664 /* on creation a worker is in !idle && prep state */
1665 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001666 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001667 return worker;
1668}
1669
1670/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001671 * worker_attach_to_pool() - attach a worker to a pool
1672 * @worker: worker to be attached
1673 * @pool: the target pool
1674 *
1675 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1676 * cpu-binding of @worker are kept coordinated with the pool across
1677 * cpu-[un]hotplugs.
1678 */
1679static void worker_attach_to_pool(struct worker *worker,
1680 struct worker_pool *pool)
1681{
1682 mutex_lock(&pool->attach_mutex);
1683
1684 /*
1685 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1686 * online CPUs. It'll be re-applied when any of the CPUs come up.
1687 */
1688 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1689
1690 /*
1691 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1692 * stable across this function. See the comments above the
1693 * flag definition for details.
1694 */
1695 if (pool->flags & POOL_DISASSOCIATED)
1696 worker->flags |= WORKER_UNBOUND;
1697
1698 list_add_tail(&worker->node, &pool->workers);
1699
1700 mutex_unlock(&pool->attach_mutex);
1701}
1702
1703/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001704 * worker_detach_from_pool() - detach a worker from its pool
1705 * @worker: worker which is attached to its pool
1706 * @pool: the pool @worker is attached to
1707 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001708 * Undo the attaching which had been done in worker_attach_to_pool(). The
1709 * caller worker shouldn't access to the pool after detached except it has
1710 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001711 */
1712static void worker_detach_from_pool(struct worker *worker,
1713 struct worker_pool *pool)
1714{
1715 struct completion *detach_completion = NULL;
1716
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001717 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001718 list_del(&worker->node);
1719 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001720 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001721 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001722
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001723 /* clear leftover flags without pool->lock after it is detached */
1724 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1725
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001726 if (detach_completion)
1727 complete(detach_completion);
1728}
1729
1730/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001731 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001732 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001733 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001734 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001735 *
1736 * CONTEXT:
1737 * Might sleep. Does GFP_KERNEL allocations.
1738 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001739 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001740 * Pointer to the newly created worker.
1741 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001742static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001743{
Tejun Heoc34056a2010-06-29 10:07:11 +02001744 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001745 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001746 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001747
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001748 /* ID is needed to determine kthread name */
1749 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001750 if (id < 0)
1751 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001752
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001753 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001754 if (!worker)
1755 goto fail;
1756
Tejun Heobd7bdd42012-07-12 14:46:37 -07001757 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001758 worker->id = id;
1759
Tejun Heo29c91e92013-03-12 11:30:03 -07001760 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001761 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1762 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001763 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001764 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1765
Tejun Heof3f90ad2013-04-01 11:23:34 -07001766 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001767 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001768 if (IS_ERR(worker->task))
1769 goto fail;
1770
Oleg Nesterov91151222013-11-14 12:56:18 +01001771 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001772 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001773
Lai Jiangshanda028462014-05-20 17:46:31 +08001774 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001775 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001776
Lai Jiangshan051e1852014-07-22 13:03:02 +08001777 /* start the newly created worker */
1778 spin_lock_irq(&pool->lock);
1779 worker->pool->nr_workers++;
1780 worker_enter_idle(worker);
1781 wake_up_process(worker->task);
1782 spin_unlock_irq(&pool->lock);
1783
Tejun Heoc34056a2010-06-29 10:07:11 +02001784 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001785
Tejun Heoc34056a2010-06-29 10:07:11 +02001786fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001787 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001788 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001789 kfree(worker);
1790 return NULL;
1791}
1792
1793/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001794 * destroy_worker - destroy a workqueue worker
1795 * @worker: worker to be destroyed
1796 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001797 * Destroy @worker and adjust @pool stats accordingly. The worker should
1798 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001799 *
1800 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001801 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001802 */
1803static void destroy_worker(struct worker *worker)
1804{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001805 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001806
Tejun Heocd549682013-03-13 19:47:39 -07001807 lockdep_assert_held(&pool->lock);
1808
Tejun Heoc34056a2010-06-29 10:07:11 +02001809 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001810 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001811 WARN_ON(!list_empty(&worker->scheduled)) ||
1812 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001813 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001814
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001815 pool->nr_workers--;
1816 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001817
Tejun Heoc8e55f32010-06-29 10:07:12 +02001818 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001819 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001820 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001821}
1822
Tejun Heo63d95a92012-07-12 14:46:37 -07001823static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001824{
Tejun Heo63d95a92012-07-12 14:46:37 -07001825 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001826
Tejun Heod565ed62013-01-24 11:01:33 -08001827 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001828
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001829 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001830 struct worker *worker;
1831 unsigned long expires;
1832
1833 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001834 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001835 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1836
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001837 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001838 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001839 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001840 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001841
1842 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001843 }
1844
Tejun Heod565ed62013-01-24 11:01:33 -08001845 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001846}
1847
Tejun Heo493a1722013-03-12 11:29:59 -07001848static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001849{
Tejun Heo112202d2013-02-13 19:29:12 -08001850 struct pool_workqueue *pwq = get_work_pwq(work);
1851 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001852
Tejun Heo2e109a22013-03-13 19:47:40 -07001853 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001854
Tejun Heo493008a2013-03-12 11:30:03 -07001855 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001856 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001857
1858 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001859 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001860 /*
1861 * If @pwq is for an unbound wq, its base ref may be put at
1862 * any time due to an attribute change. Pin @pwq until the
1863 * rescuer is done with it.
1864 */
1865 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001866 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001867 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001868 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001869}
1870
Tejun Heo706026c2013-01-24 11:01:34 -08001871static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001872{
Tejun Heo63d95a92012-07-12 14:46:37 -07001873 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001874 struct work_struct *work;
1875
Tejun Heob2d82902014-12-08 12:39:16 -05001876 spin_lock_irq(&pool->lock);
1877 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001878
Tejun Heo63d95a92012-07-12 14:46:37 -07001879 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001880 /*
1881 * We've been trying to create a new worker but
1882 * haven't been successful. We might be hitting an
1883 * allocation deadlock. Send distress signals to
1884 * rescuers.
1885 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001886 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001887 send_mayday(work);
1888 }
1889
Tejun Heob2d82902014-12-08 12:39:16 -05001890 spin_unlock(&wq_mayday_lock);
1891 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001892
Tejun Heo63d95a92012-07-12 14:46:37 -07001893 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001894}
1895
1896/**
1897 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001898 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001899 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001900 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001901 * have at least one idle worker on return from this function. If
1902 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001903 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001904 * possible allocation deadlock.
1905 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001906 * On return, need_to_create_worker() is guaranteed to be %false and
1907 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001908 *
1909 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001910 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001911 * multiple times. Does GFP_KERNEL allocations. Called only from
1912 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001913 */
Tejun Heo29187a92015-01-16 14:21:16 -05001914static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001915__releases(&pool->lock)
1916__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001917{
Tejun Heoe22bee72010-06-29 10:07:14 +02001918restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001919 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001920
Tejun Heoe22bee72010-06-29 10:07:14 +02001921 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001922 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001923
1924 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001925 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001926 break;
1927
Lai Jiangshane212f362014-06-03 15:32:17 +08001928 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001929
Tejun Heo63d95a92012-07-12 14:46:37 -07001930 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001931 break;
1932 }
1933
Tejun Heo63d95a92012-07-12 14:46:37 -07001934 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001935 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001936 /*
1937 * This is necessary even after a new worker was just successfully
1938 * created as @pool->lock was dropped and the new worker might have
1939 * already become busy.
1940 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001941 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001942 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001943}
1944
1945/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001946 * manage_workers - manage worker pool
1947 * @worker: self
1948 *
Tejun Heo706026c2013-01-24 11:01:34 -08001949 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001950 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001951 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001952 *
1953 * The caller can safely start processing works on false return. On
1954 * true return, it's guaranteed that need_to_create_worker() is false
1955 * and may_start_working() is true.
1956 *
1957 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001958 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001959 * multiple times. Does GFP_KERNEL allocations.
1960 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001961 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001962 * %false if the pool doesn't need management and the caller can safely
1963 * start processing works, %true if management function was performed and
1964 * the conditions that the caller verified before calling the function may
1965 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001966 */
1967static bool manage_workers(struct worker *worker)
1968{
Tejun Heo63d95a92012-07-12 14:46:37 -07001969 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001970
Tejun Heobc3a1af2013-03-13 19:47:39 -07001971 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07001972 * Anyone who successfully grabs manager_arb wins the arbitration
1973 * and becomes the manager. mutex_trylock() on pool->manager_arb
1974 * failure while holding pool->lock reliably indicates that someone
1975 * else is managing the pool and the worker which failed trylock
1976 * can proceed to executing work items. This means that anyone
1977 * grabbing manager_arb is responsible for actually performing
1978 * manager duties. If manager_arb is grabbed and released without
1979 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07001980 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07001981 if (!mutex_trylock(&pool->manager_arb))
Tejun Heo29187a92015-01-16 14:21:16 -05001982 return false;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001983 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001984
Tejun Heo29187a92015-01-16 14:21:16 -05001985 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001986
Tejun Heo2607d7a2015-03-09 09:22:28 -04001987 pool->manager = NULL;
Tejun Heo34a06bd2013-03-12 11:30:00 -07001988 mutex_unlock(&pool->manager_arb);
Tejun Heo29187a92015-01-16 14:21:16 -05001989 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02001990}
1991
Tejun Heoa62428c2010-06-29 10:07:10 +02001992/**
1993 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001994 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001995 * @work: work to process
1996 *
1997 * Process @work. This function contains all the logics necessary to
1998 * process a single work including synchronization against and
1999 * interaction with other workers on the same cpu, queueing and
2000 * flushing. As long as context requirement is met, any worker can
2001 * call this function to process a work.
2002 *
2003 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002004 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002005 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002006static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002007__releases(&pool->lock)
2008__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002009{
Tejun Heo112202d2013-02-13 19:29:12 -08002010 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002011 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002012 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002013 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002014 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002015#ifdef CONFIG_LOCKDEP
2016 /*
2017 * It is permissible to free the struct work_struct from
2018 * inside the function that is called from it, this we need to
2019 * take into account for lockdep too. To avoid bogus "held
2020 * lock freed" warnings as well as problems when looking into
2021 * work->lockdep_map, make a copy and use that here.
2022 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002023 struct lockdep_map lockdep_map;
2024
2025 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002026#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002027 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002028 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002029 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002030
Tejun Heo7e116292010-06-29 10:07:13 +02002031 /*
2032 * A single work shouldn't be executed concurrently by
2033 * multiple workers on a single cpu. Check whether anyone is
2034 * already processing the work. If so, defer the work to the
2035 * currently executing one.
2036 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002037 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002038 if (unlikely(collision)) {
2039 move_linked_works(work, &collision->scheduled, NULL);
2040 return;
2041 }
2042
Tejun Heo8930cab2012-08-03 10:30:45 -07002043 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002044 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002045 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002046 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002047 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002048 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002049 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002050
Tejun Heoa62428c2010-06-29 10:07:10 +02002051 list_del_init(&work->entry);
2052
Tejun Heo649027d2010-06-29 10:07:14 +02002053 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002054 * CPU intensive works don't participate in concurrency management.
2055 * They're the scheduler's responsibility. This takes @worker out
2056 * of concurrency management and the next code block will chain
2057 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002058 */
2059 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002060 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002061
Tejun Heo974271c2012-07-12 14:46:37 -07002062 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002063 * Wake up another worker if necessary. The condition is always
2064 * false for normal per-cpu workers since nr_running would always
2065 * be >= 1 at this point. This is used to chain execution of the
2066 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002067 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002068 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002069 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002070 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002071
Tejun Heo8930cab2012-08-03 10:30:45 -07002072 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002073 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002074 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002075 * PENDING and queued state changes happen together while IRQ is
2076 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002077 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002078 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002079
Tejun Heod565ed62013-01-24 11:01:33 -08002080 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002081
Tejun Heo112202d2013-02-13 19:29:12 -08002082 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002083 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002084 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002085 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002086 /*
2087 * While we must be careful to not use "work" after this, the trace
2088 * point will only record its address.
2089 */
2090 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002091 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002092 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002093
2094 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002095 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2096 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002097 current->comm, preempt_count(), task_pid_nr(current),
2098 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002099 debug_show_held_locks(current);
2100 dump_stack();
2101 }
2102
Tejun Heob22ce272013-08-28 17:33:37 -04002103 /*
2104 * The following prevents a kworker from hogging CPU on !PREEMPT
2105 * kernels, where a requeueing work item waiting for something to
2106 * happen could deadlock with stop_machine as such work item could
2107 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002108 * stop_machine. At the same time, report a quiescent RCU state so
2109 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002110 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002111 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002112
Tejun Heod565ed62013-01-24 11:01:33 -08002113 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002114
Tejun Heofb0e7be2010-06-29 10:07:15 +02002115 /* clear cpu intensive status */
2116 if (unlikely(cpu_intensive))
2117 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2118
Tejun Heoa62428c2010-06-29 10:07:10 +02002119 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002120 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002121 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002122 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002123 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002124 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002125 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002126}
2127
Tejun Heoaffee4b2010-06-29 10:07:12 +02002128/**
2129 * process_scheduled_works - process scheduled works
2130 * @worker: self
2131 *
2132 * Process all scheduled works. Please note that the scheduled list
2133 * may change while processing a work, so this function repeatedly
2134 * fetches a work from the top and executes it.
2135 *
2136 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002137 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002138 * multiple times.
2139 */
2140static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002142 while (!list_empty(&worker->scheduled)) {
2143 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002145 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147}
2148
Tejun Heo4690c4a2010-06-29 10:07:10 +02002149/**
2150 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002151 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002152 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002153 * The worker thread function. All workers belong to a worker_pool -
2154 * either a per-cpu one or dynamic unbound one. These workers process all
2155 * work items regardless of their specific target workqueue. The only
2156 * exception is work items which belong to workqueues with a rescuer which
2157 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002158 *
2159 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002160 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002161static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162{
Tejun Heoc34056a2010-06-29 10:07:11 +02002163 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002164 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165
Tejun Heoe22bee72010-06-29 10:07:14 +02002166 /* tell the scheduler that this is a workqueue worker */
2167 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002168woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002169 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002170
Tejun Heoa9ab7752013-03-19 13:45:21 -07002171 /* am I supposed to die? */
2172 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002173 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002174 WARN_ON_ONCE(!list_empty(&worker->entry));
2175 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002176
2177 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002178 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002179 worker_detach_from_pool(worker, pool);
2180 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002181 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002183
Tejun Heoc8e55f32010-06-29 10:07:12 +02002184 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002185recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002186 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002187 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002188 goto sleep;
2189
2190 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002191 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002192 goto recheck;
2193
Tejun Heoc8e55f32010-06-29 10:07:12 +02002194 /*
2195 * ->scheduled list can only be filled while a worker is
2196 * preparing to process a work or actually processing it.
2197 * Make sure nobody diddled with it while I was sleeping.
2198 */
Tejun Heo6183c002013-03-12 11:29:57 -07002199 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002200
Tejun Heoe22bee72010-06-29 10:07:14 +02002201 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002202 * Finish PREP stage. We're guaranteed to have at least one idle
2203 * worker or that someone else has already assumed the manager
2204 * role. This is where @worker starts participating in concurrency
2205 * management if applicable and concurrency management is restored
2206 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002207 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002208 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002209
2210 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002211 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002212 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002213 struct work_struct, entry);
2214
Tejun Heo82607adc2015-12-08 11:28:04 -05002215 pool->watchdog_ts = jiffies;
2216
Tejun Heoc8e55f32010-06-29 10:07:12 +02002217 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2218 /* optimization path, not strictly necessary */
2219 process_one_work(worker, work);
2220 if (unlikely(!list_empty(&worker->scheduled)))
2221 process_scheduled_works(worker);
2222 } else {
2223 move_linked_works(work, &worker->scheduled, NULL);
2224 process_scheduled_works(worker);
2225 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002226 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002227
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002228 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002229sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002230 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002231 * pool->lock is held and there's no work to process and no need to
2232 * manage, sleep. Workers are woken up only while holding
2233 * pool->lock or from local cpu, so setting the current state
2234 * before releasing pool->lock is enough to prevent losing any
2235 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002236 */
2237 worker_enter_idle(worker);
2238 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002239 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002240 schedule();
2241 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242}
2243
Tejun Heoe22bee72010-06-29 10:07:14 +02002244/**
2245 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002246 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002247 *
2248 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002249 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002250 *
Tejun Heo706026c2013-01-24 11:01:34 -08002251 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002252 * worker which uses GFP_KERNEL allocation which has slight chance of
2253 * developing into deadlock if some works currently on the same queue
2254 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2255 * the problem rescuer solves.
2256 *
Tejun Heo706026c2013-01-24 11:01:34 -08002257 * When such condition is possible, the pool summons rescuers of all
2258 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002259 * those works so that forward progress can be guaranteed.
2260 *
2261 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002262 *
2263 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002264 */
Tejun Heo111c2252013-01-17 17:16:24 -08002265static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002266{
Tejun Heo111c2252013-01-17 17:16:24 -08002267 struct worker *rescuer = __rescuer;
2268 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002269 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002270 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002271
2272 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002273
2274 /*
2275 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2276 * doesn't participate in concurrency management.
2277 */
2278 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002279repeat:
2280 set_current_state(TASK_INTERRUPTIBLE);
2281
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002282 /*
2283 * By the time the rescuer is requested to stop, the workqueue
2284 * shouldn't have any work pending, but @wq->maydays may still have
2285 * pwq(s) queued. This can happen by non-rescuer workers consuming
2286 * all the work items before the rescuer got to them. Go through
2287 * @wq->maydays processing before acting on should_stop so that the
2288 * list is always empty on exit.
2289 */
2290 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002291
Tejun Heo493a1722013-03-12 11:29:59 -07002292 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002293 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002294
2295 while (!list_empty(&wq->maydays)) {
2296 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2297 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002298 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002299 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002300 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002301
2302 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002303 list_del_init(&pwq->mayday_node);
2304
Tejun Heo2e109a22013-03-13 19:47:40 -07002305 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002306
Lai Jiangshan51697d392014-05-20 17:46:36 +08002307 worker_attach_to_pool(rescuer, pool);
2308
2309 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002310 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002311
2312 /*
2313 * Slurp in all works issued via this workqueue and
2314 * process'em.
2315 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002316 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002317 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2318 if (get_work_pwq(work) == pwq) {
2319 if (first)
2320 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002321 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002322 }
2323 first = false;
2324 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002325
NeilBrown008847f2014-12-08 12:39:16 -05002326 if (!list_empty(scheduled)) {
2327 process_scheduled_works(rescuer);
2328
2329 /*
2330 * The above execution of rescued work items could
2331 * have created more to rescue through
2332 * pwq_activate_first_delayed() or chained
2333 * queueing. Let's put @pwq back on mayday list so
2334 * that such back-to-back work items, which may be
2335 * being used to relieve memory pressure, don't
2336 * incur MAYDAY_INTERVAL delay inbetween.
2337 */
2338 if (need_to_create_worker(pool)) {
2339 spin_lock(&wq_mayday_lock);
2340 get_pwq(pwq);
2341 list_move_tail(&pwq->mayday_node, &wq->maydays);
2342 spin_unlock(&wq_mayday_lock);
2343 }
2344 }
Tejun Heo75769582011-02-14 14:04:46 +01002345
2346 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002347 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002348 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002349 */
2350 put_pwq(pwq);
2351
2352 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002353 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002354 * regular worker; otherwise, we end up with 0 concurrency
2355 * and stalling the execution.
2356 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002357 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002358 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002359
Lai Jiangshanb3104102013-02-19 12:17:02 -08002360 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002361 spin_unlock_irq(&pool->lock);
2362
2363 worker_detach_from_pool(rescuer, pool);
2364
2365 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002366 }
2367
Tejun Heo2e109a22013-03-13 19:47:40 -07002368 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002369
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002370 if (should_stop) {
2371 __set_current_state(TASK_RUNNING);
2372 rescuer->task->flags &= ~PF_WQ_WORKER;
2373 return 0;
2374 }
2375
Tejun Heo111c2252013-01-17 17:16:24 -08002376 /* rescuers should never participate in concurrency management */
2377 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002378 schedule();
2379 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380}
2381
Tejun Heofca839c2015-12-07 10:58:57 -05002382/**
2383 * check_flush_dependency - check for flush dependency sanity
2384 * @target_wq: workqueue being flushed
2385 * @target_work: work item being flushed (NULL for workqueue flushes)
2386 *
2387 * %current is trying to flush the whole @target_wq or @target_work on it.
2388 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2389 * reclaiming memory or running on a workqueue which doesn't have
2390 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2391 * a deadlock.
2392 */
2393static void check_flush_dependency(struct workqueue_struct *target_wq,
2394 struct work_struct *target_work)
2395{
2396 work_func_t target_func = target_work ? target_work->func : NULL;
2397 struct worker *worker;
2398
2399 if (target_wq->flags & WQ_MEM_RECLAIM)
2400 return;
2401
2402 worker = current_wq_worker();
2403
2404 WARN_ONCE(current->flags & PF_MEMALLOC,
2405 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2406 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002407 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2408 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002409 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2410 worker->current_pwq->wq->name, worker->current_func,
2411 target_wq->name, target_func);
2412}
2413
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002414struct wq_barrier {
2415 struct work_struct work;
2416 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002417 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002418};
2419
2420static void wq_barrier_func(struct work_struct *work)
2421{
2422 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2423 complete(&barr->done);
2424}
2425
Tejun Heo4690c4a2010-06-29 10:07:10 +02002426/**
2427 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002428 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002429 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002430 * @target: target work to attach @barr to
2431 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002432 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002433 * @barr is linked to @target such that @barr is completed only after
2434 * @target finishes execution. Please note that the ordering
2435 * guarantee is observed only with respect to @target and on the local
2436 * cpu.
2437 *
2438 * Currently, a queued barrier can't be canceled. This is because
2439 * try_to_grab_pending() can't determine whether the work to be
2440 * grabbed is at the head of the queue and thus can't clear LINKED
2441 * flag of the previous work while there must be a valid next work
2442 * after a work with LINKED flag set.
2443 *
2444 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002445 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002446 *
2447 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002448 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002449 */
Tejun Heo112202d2013-02-13 19:29:12 -08002450static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002451 struct wq_barrier *barr,
2452 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002453{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002454 struct list_head *head;
2455 unsigned int linked = 0;
2456
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002457 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002458 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002459 * as we know for sure that this will not trigger any of the
2460 * checks and call back into the fixup functions where we
2461 * might deadlock.
2462 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002463 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002464 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002465 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002466 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002467
Tejun Heoaffee4b2010-06-29 10:07:12 +02002468 /*
2469 * If @target is currently being executed, schedule the
2470 * barrier to the worker; otherwise, put it after @target.
2471 */
2472 if (worker)
2473 head = worker->scheduled.next;
2474 else {
2475 unsigned long *bits = work_data_bits(target);
2476
2477 head = target->entry.next;
2478 /* there can already be other linked works, inherit and set */
2479 linked = *bits & WORK_STRUCT_LINKED;
2480 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2481 }
2482
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002483 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002484 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002485 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002486}
2487
Tejun Heo73f53c42010-06-29 10:07:11 +02002488/**
Tejun Heo112202d2013-02-13 19:29:12 -08002489 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002490 * @wq: workqueue being flushed
2491 * @flush_color: new flush color, < 0 for no-op
2492 * @work_color: new work color, < 0 for no-op
2493 *
Tejun Heo112202d2013-02-13 19:29:12 -08002494 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002495 *
Tejun Heo112202d2013-02-13 19:29:12 -08002496 * If @flush_color is non-negative, flush_color on all pwqs should be
2497 * -1. If no pwq has in-flight commands at the specified color, all
2498 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2499 * has in flight commands, its pwq->flush_color is set to
2500 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002501 * wakeup logic is armed and %true is returned.
2502 *
2503 * The caller should have initialized @wq->first_flusher prior to
2504 * calling this function with non-negative @flush_color. If
2505 * @flush_color is negative, no flush color update is done and %false
2506 * is returned.
2507 *
Tejun Heo112202d2013-02-13 19:29:12 -08002508 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002509 * work_color which is previous to @work_color and all will be
2510 * advanced to @work_color.
2511 *
2512 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002513 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002514 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002515 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002516 * %true if @flush_color >= 0 and there's something to flush. %false
2517 * otherwise.
2518 */
Tejun Heo112202d2013-02-13 19:29:12 -08002519static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002520 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521{
Tejun Heo73f53c42010-06-29 10:07:11 +02002522 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002523 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002524
Tejun Heo73f53c42010-06-29 10:07:11 +02002525 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002526 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002527 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002528 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002529
Tejun Heo49e3cf42013-03-12 11:29:58 -07002530 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002531 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002532
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002533 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002534
2535 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002536 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002537
Tejun Heo112202d2013-02-13 19:29:12 -08002538 if (pwq->nr_in_flight[flush_color]) {
2539 pwq->flush_color = flush_color;
2540 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002541 wait = true;
2542 }
2543 }
2544
2545 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002546 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002547 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002548 }
2549
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002550 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002551 }
2552
Tejun Heo112202d2013-02-13 19:29:12 -08002553 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002554 complete(&wq->first_flusher->done);
2555
2556 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557}
2558
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002559/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002561 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002563 * This function sleeps until all work items which were queued on entry
2564 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002566void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567{
Tejun Heo73f53c42010-06-29 10:07:11 +02002568 struct wq_flusher this_flusher = {
2569 .list = LIST_HEAD_INIT(this_flusher.list),
2570 .flush_color = -1,
2571 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2572 };
2573 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002574
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002575 lock_map_acquire(&wq->lockdep_map);
2576 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002577
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002578 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002579
2580 /*
2581 * Start-to-wait phase
2582 */
2583 next_color = work_next_color(wq->work_color);
2584
2585 if (next_color != wq->flush_color) {
2586 /*
2587 * Color space is not full. The current work_color
2588 * becomes our flush_color and work_color is advanced
2589 * by one.
2590 */
Tejun Heo6183c002013-03-12 11:29:57 -07002591 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002592 this_flusher.flush_color = wq->work_color;
2593 wq->work_color = next_color;
2594
2595 if (!wq->first_flusher) {
2596 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002597 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002598
2599 wq->first_flusher = &this_flusher;
2600
Tejun Heo112202d2013-02-13 19:29:12 -08002601 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002602 wq->work_color)) {
2603 /* nothing to flush, done */
2604 wq->flush_color = next_color;
2605 wq->first_flusher = NULL;
2606 goto out_unlock;
2607 }
2608 } else {
2609 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002610 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002611 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002612 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002613 }
2614 } else {
2615 /*
2616 * Oops, color space is full, wait on overflow queue.
2617 * The next flush completion will assign us
2618 * flush_color and transfer to flusher_queue.
2619 */
2620 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2621 }
2622
Tejun Heofca839c2015-12-07 10:58:57 -05002623 check_flush_dependency(wq, NULL);
2624
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002625 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002626
2627 wait_for_completion(&this_flusher.done);
2628
2629 /*
2630 * Wake-up-and-cascade phase
2631 *
2632 * First flushers are responsible for cascading flushes and
2633 * handling overflow. Non-first flushers can simply return.
2634 */
2635 if (wq->first_flusher != &this_flusher)
2636 return;
2637
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002638 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002639
Tejun Heo4ce48b32010-07-02 10:03:51 +02002640 /* we might have raced, check again with mutex held */
2641 if (wq->first_flusher != &this_flusher)
2642 goto out_unlock;
2643
Tejun Heo73f53c42010-06-29 10:07:11 +02002644 wq->first_flusher = NULL;
2645
Tejun Heo6183c002013-03-12 11:29:57 -07002646 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2647 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002648
2649 while (true) {
2650 struct wq_flusher *next, *tmp;
2651
2652 /* complete all the flushers sharing the current flush color */
2653 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2654 if (next->flush_color != wq->flush_color)
2655 break;
2656 list_del_init(&next->list);
2657 complete(&next->done);
2658 }
2659
Tejun Heo6183c002013-03-12 11:29:57 -07002660 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2661 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002662
2663 /* this flush_color is finished, advance by one */
2664 wq->flush_color = work_next_color(wq->flush_color);
2665
2666 /* one color has been freed, handle overflow queue */
2667 if (!list_empty(&wq->flusher_overflow)) {
2668 /*
2669 * Assign the same color to all overflowed
2670 * flushers, advance work_color and append to
2671 * flusher_queue. This is the start-to-wait
2672 * phase for these overflowed flushers.
2673 */
2674 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2675 tmp->flush_color = wq->work_color;
2676
2677 wq->work_color = work_next_color(wq->work_color);
2678
2679 list_splice_tail_init(&wq->flusher_overflow,
2680 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002681 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002682 }
2683
2684 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002685 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002686 break;
2687 }
2688
2689 /*
2690 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002691 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002692 */
Tejun Heo6183c002013-03-12 11:29:57 -07002693 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2694 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002695
2696 list_del_init(&next->list);
2697 wq->first_flusher = next;
2698
Tejun Heo112202d2013-02-13 19:29:12 -08002699 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002700 break;
2701
2702 /*
2703 * Meh... this color is already done, clear first
2704 * flusher and repeat cascading.
2705 */
2706 wq->first_flusher = NULL;
2707 }
2708
2709out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002710 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002712EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002714/**
2715 * drain_workqueue - drain a workqueue
2716 * @wq: workqueue to drain
2717 *
2718 * Wait until the workqueue becomes empty. While draining is in progress,
2719 * only chain queueing is allowed. IOW, only currently pending or running
2720 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002721 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002722 * by the depth of chaining and should be relatively short. Whine if it
2723 * takes too long.
2724 */
2725void drain_workqueue(struct workqueue_struct *wq)
2726{
2727 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002728 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002729
2730 /*
2731 * __queue_work() needs to test whether there are drainers, is much
2732 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002733 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002734 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002735 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002736 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002737 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002738 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002739reflush:
2740 flush_workqueue(wq);
2741
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002742 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002743
Tejun Heo49e3cf42013-03-12 11:29:58 -07002744 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002745 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002746
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002747 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002748 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002749 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002750
2751 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002752 continue;
2753
2754 if (++flush_cnt == 10 ||
2755 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002756 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002757 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002758
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002759 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002760 goto reflush;
2761 }
2762
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002763 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002764 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002765 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002766}
2767EXPORT_SYMBOL_GPL(drain_workqueue);
2768
Tejun Heo606a5022012-08-20 14:51:23 -07002769static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002770{
2771 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002772 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002773 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002774
2775 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002776
Tejun Heofa1b54e2013-03-12 11:30:00 -07002777 local_irq_disable();
2778 pool = get_work_pool(work);
2779 if (!pool) {
2780 local_irq_enable();
2781 return false;
2782 }
2783
2784 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002785 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002786 pwq = get_work_pwq(work);
2787 if (pwq) {
2788 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002789 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002790 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002791 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002792 if (!worker)
2793 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002794 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002795 }
Tejun Heobaf59022010-09-16 10:42:16 +02002796
Tejun Heofca839c2015-12-07 10:58:57 -05002797 check_flush_dependency(pwq->wq, work);
2798
Tejun Heo112202d2013-02-13 19:29:12 -08002799 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002800 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002801
Tejun Heoe1594892011-01-09 23:32:15 +01002802 /*
2803 * If @max_active is 1 or rescuer is in use, flushing another work
2804 * item on the same workqueue may lead to deadlock. Make sure the
2805 * flusher is not running on the same workqueue by verifying write
2806 * access.
2807 */
Tejun Heo493008a2013-03-12 11:30:03 -07002808 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002809 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002810 else
Tejun Heo112202d2013-02-13 19:29:12 -08002811 lock_map_acquire_read(&pwq->wq->lockdep_map);
2812 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002813
Tejun Heobaf59022010-09-16 10:42:16 +02002814 return true;
2815already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002816 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002817 return false;
2818}
2819
Oleg Nesterovdb700892008-07-25 01:47:49 -07002820/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002821 * flush_work - wait for a work to finish executing the last queueing instance
2822 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002823 *
Tejun Heo606a5022012-08-20 14:51:23 -07002824 * Wait until @work has finished execution. @work is guaranteed to be idle
2825 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002826 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002827 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002828 * %true if flush_work() waited for the work to finish execution,
2829 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002830 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002831bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002832{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002833 struct wq_barrier barr;
2834
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002835 lock_map_acquire(&work->lockdep_map);
2836 lock_map_release(&work->lockdep_map);
2837
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002838 if (start_flush_work(work, &barr)) {
2839 wait_for_completion(&barr.done);
2840 destroy_work_on_stack(&barr.work);
2841 return true;
2842 } else {
2843 return false;
2844 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002845}
2846EXPORT_SYMBOL_GPL(flush_work);
2847
Tejun Heo8603e1b32015-03-05 08:04:13 -05002848struct cwt_wait {
2849 wait_queue_t wait;
2850 struct work_struct *work;
2851};
2852
2853static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2854{
2855 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2856
2857 if (cwait->work != key)
2858 return 0;
2859 return autoremove_wake_function(wait, mode, sync, key);
2860}
2861
Tejun Heo36e227d2012-08-03 10:30:46 -07002862static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002863{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002864 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002865 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002866 int ret;
2867
2868 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002869 ret = try_to_grab_pending(work, is_dwork, &flags);
2870 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002871 * If someone else is already canceling, wait for it to
2872 * finish. flush_work() doesn't work for PREEMPT_NONE
2873 * because we may get scheduled between @work's completion
2874 * and the other canceling task resuming and clearing
2875 * CANCELING - flush_work() will return false immediately
2876 * as @work is no longer busy, try_to_grab_pending() will
2877 * return -ENOENT as @work is still being canceled and the
2878 * other canceling task won't be able to clear CANCELING as
2879 * we're hogging the CPU.
2880 *
2881 * Let's wait for completion using a waitqueue. As this
2882 * may lead to the thundering herd problem, use a custom
2883 * wake function which matches @work along with exclusive
2884 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002885 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002886 if (unlikely(ret == -ENOENT)) {
2887 struct cwt_wait cwait;
2888
2889 init_wait(&cwait.wait);
2890 cwait.wait.func = cwt_wakefn;
2891 cwait.work = work;
2892
2893 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2894 TASK_UNINTERRUPTIBLE);
2895 if (work_is_canceling(work))
2896 schedule();
2897 finish_wait(&cancel_waitq, &cwait.wait);
2898 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002899 } while (unlikely(ret < 0));
2900
Tejun Heobbb68df2012-08-03 10:30:46 -07002901 /* tell other tasks trying to grab @work to back off */
2902 mark_work_canceling(work);
2903 local_irq_restore(flags);
2904
Tejun Heo606a5022012-08-20 14:51:23 -07002905 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002906 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002907
2908 /*
2909 * Paired with prepare_to_wait() above so that either
2910 * waitqueue_active() is visible here or !work_is_canceling() is
2911 * visible there.
2912 */
2913 smp_mb();
2914 if (waitqueue_active(&cancel_waitq))
2915 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2916
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002917 return ret;
2918}
2919
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002920/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002921 * cancel_work_sync - cancel a work and wait for it to finish
2922 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002923 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002924 * Cancel @work and wait for its execution to finish. This function
2925 * can be used even if the work re-queues itself or migrates to
2926 * another workqueue. On return from this function, @work is
2927 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002928 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002929 * cancel_work_sync(&delayed_work->work) must not be used for
2930 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002931 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002932 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002933 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002934 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002935 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002936 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002937 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002938bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002939{
Tejun Heo36e227d2012-08-03 10:30:46 -07002940 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002941}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002942EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002943
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002944/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002945 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2946 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002947 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002948 * Delayed timer is cancelled and the pending work is queued for
2949 * immediate execution. Like flush_work(), this function only
2950 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002951 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002952 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002953 * %true if flush_work() waited for the work to finish execution,
2954 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002955 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002956bool flush_delayed_work(struct delayed_work *dwork)
2957{
Tejun Heo8930cab2012-08-03 10:30:45 -07002958 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002959 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002960 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002961 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002962 return flush_work(&dwork->work);
2963}
2964EXPORT_SYMBOL(flush_delayed_work);
2965
2966/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002967 * cancel_delayed_work - cancel a delayed work
2968 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002969 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002970 * Kill off a pending delayed_work.
2971 *
2972 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2973 * pending.
2974 *
2975 * Note:
2976 * The work callback function may still be running on return, unless
2977 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2978 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002979 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002980 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002981 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002982bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002983{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002984 unsigned long flags;
2985 int ret;
2986
2987 do {
2988 ret = try_to_grab_pending(&dwork->work, true, &flags);
2989 } while (unlikely(ret == -EAGAIN));
2990
2991 if (unlikely(ret < 0))
2992 return false;
2993
Tejun Heo7c3eed52013-01-24 11:01:33 -08002994 set_work_pool_and_clear_pending(&dwork->work,
2995 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002996 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002997 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002998}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002999EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003000
3001/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003002 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3003 * @dwork: the delayed work cancel
3004 *
3005 * This is cancel_work_sync() for delayed works.
3006 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003007 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003008 * %true if @dwork was pending, %false otherwise.
3009 */
3010bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003011{
Tejun Heo36e227d2012-08-03 10:30:46 -07003012 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003013}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003014EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003015
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003016/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003017 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003018 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003019 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003020 * schedule_on_each_cpu() executes @func on each online CPU using the
3021 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003022 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003023 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003024 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003025 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003026 */
David Howells65f27f32006-11-22 14:55:48 +00003027int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003028{
3029 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003030 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003031
Andrew Mortonb6136772006-06-25 05:47:49 -07003032 works = alloc_percpu(struct work_struct);
3033 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003034 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003035
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003036 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003037
Christoph Lameter15316ba2006-01-08 01:00:43 -08003038 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003039 struct work_struct *work = per_cpu_ptr(works, cpu);
3040
3041 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003042 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003043 }
Tejun Heo93981802009-11-17 14:06:20 -08003044
3045 for_each_online_cpu(cpu)
3046 flush_work(per_cpu_ptr(works, cpu));
3047
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003048 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003049 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003050 return 0;
3051}
3052
Alan Sterneef6a7d2010-02-12 17:39:21 +09003053/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003054 * execute_in_process_context - reliably execute the routine with user context
3055 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003056 * @ew: guaranteed storage for the execute work structure (must
3057 * be available when the work executes)
3058 *
3059 * Executes the function immediately if process context is available,
3060 * otherwise schedules the function for delayed execution.
3061 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003062 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003063 * 1 - function was scheduled for execution
3064 */
David Howells65f27f32006-11-22 14:55:48 +00003065int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003066{
3067 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003068 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003069 return 0;
3070 }
3071
David Howells65f27f32006-11-22 14:55:48 +00003072 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003073 schedule_work(&ew->work);
3074
3075 return 1;
3076}
3077EXPORT_SYMBOL_GPL(execute_in_process_context);
3078
Tejun Heo7a4e3442013-03-12 11:30:00 -07003079/**
3080 * free_workqueue_attrs - free a workqueue_attrs
3081 * @attrs: workqueue_attrs to free
3082 *
3083 * Undo alloc_workqueue_attrs().
3084 */
3085void free_workqueue_attrs(struct workqueue_attrs *attrs)
3086{
3087 if (attrs) {
3088 free_cpumask_var(attrs->cpumask);
3089 kfree(attrs);
3090 }
3091}
3092
3093/**
3094 * alloc_workqueue_attrs - allocate a workqueue_attrs
3095 * @gfp_mask: allocation mask to use
3096 *
3097 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003098 * return it.
3099 *
3100 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003101 */
3102struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3103{
3104 struct workqueue_attrs *attrs;
3105
3106 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3107 if (!attrs)
3108 goto fail;
3109 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3110 goto fail;
3111
Tejun Heo13e2e552013-04-01 11:23:31 -07003112 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003113 return attrs;
3114fail:
3115 free_workqueue_attrs(attrs);
3116 return NULL;
3117}
3118
Tejun Heo29c91e92013-03-12 11:30:03 -07003119static void copy_workqueue_attrs(struct workqueue_attrs *to,
3120 const struct workqueue_attrs *from)
3121{
3122 to->nice = from->nice;
3123 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003124 /*
3125 * Unlike hash and equality test, this function doesn't ignore
3126 * ->no_numa as it is used for both pool and wq attrs. Instead,
3127 * get_unbound_pool() explicitly clears ->no_numa after copying.
3128 */
3129 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003130}
3131
Tejun Heo29c91e92013-03-12 11:30:03 -07003132/* hash value of the content of @attr */
3133static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3134{
3135 u32 hash = 0;
3136
3137 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003138 hash = jhash(cpumask_bits(attrs->cpumask),
3139 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003140 return hash;
3141}
3142
3143/* content equality test */
3144static bool wqattrs_equal(const struct workqueue_attrs *a,
3145 const struct workqueue_attrs *b)
3146{
3147 if (a->nice != b->nice)
3148 return false;
3149 if (!cpumask_equal(a->cpumask, b->cpumask))
3150 return false;
3151 return true;
3152}
3153
Tejun Heo7a4e3442013-03-12 11:30:00 -07003154/**
3155 * init_worker_pool - initialize a newly zalloc'd worker_pool
3156 * @pool: worker_pool to initialize
3157 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303158 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003159 *
3160 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003161 * inside @pool proper are initialized and put_unbound_pool() can be called
3162 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003163 */
3164static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003165{
3166 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003167 pool->id = -1;
3168 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003169 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003170 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003171 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003172 INIT_LIST_HEAD(&pool->worklist);
3173 INIT_LIST_HEAD(&pool->idle_list);
3174 hash_init(pool->busy_hash);
3175
3176 init_timer_deferrable(&pool->idle_timer);
3177 pool->idle_timer.function = idle_worker_timeout;
3178 pool->idle_timer.data = (unsigned long)pool;
3179
3180 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3181 (unsigned long)pool);
3182
3183 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003184 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003185 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003186
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003187 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003188 INIT_HLIST_NODE(&pool->hash_node);
3189 pool->refcnt = 1;
3190
3191 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003192 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3193 if (!pool->attrs)
3194 return -ENOMEM;
3195 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003196}
3197
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003198static void rcu_free_wq(struct rcu_head *rcu)
3199{
3200 struct workqueue_struct *wq =
3201 container_of(rcu, struct workqueue_struct, rcu);
3202
3203 if (!(wq->flags & WQ_UNBOUND))
3204 free_percpu(wq->cpu_pwqs);
3205 else
3206 free_workqueue_attrs(wq->unbound_attrs);
3207
3208 kfree(wq->rescuer);
3209 kfree(wq);
3210}
3211
Tejun Heo29c91e92013-03-12 11:30:03 -07003212static void rcu_free_pool(struct rcu_head *rcu)
3213{
3214 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3215
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003216 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003217 free_workqueue_attrs(pool->attrs);
3218 kfree(pool);
3219}
3220
3221/**
3222 * put_unbound_pool - put a worker_pool
3223 * @pool: worker_pool to put
3224 *
3225 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003226 * safe manner. get_unbound_pool() calls this function on its failure path
3227 * and this function should be able to release pools which went through,
3228 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003229 *
3230 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003231 */
3232static void put_unbound_pool(struct worker_pool *pool)
3233{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003234 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003235 struct worker *worker;
3236
Tejun Heoa892cac2013-04-01 11:23:32 -07003237 lockdep_assert_held(&wq_pool_mutex);
3238
3239 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003240 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003241
3242 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003243 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003244 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003245 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003246
3247 /* release id and unhash */
3248 if (pool->id >= 0)
3249 idr_remove(&worker_pool_idr, pool->id);
3250 hash_del(&pool->hash_node);
3251
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003252 /*
3253 * Become the manager and destroy all workers. Grabbing
3254 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003255 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003256 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003257 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003258
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003259 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003260 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003261 destroy_worker(worker);
3262 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003263 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003264
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003265 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003266 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003267 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003268 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003269
3270 if (pool->detach_completion)
3271 wait_for_completion(pool->detach_completion);
3272
Tejun Heo29c91e92013-03-12 11:30:03 -07003273 mutex_unlock(&pool->manager_arb);
3274
3275 /* shut down the timers */
3276 del_timer_sync(&pool->idle_timer);
3277 del_timer_sync(&pool->mayday_timer);
3278
3279 /* sched-RCU protected to allow dereferences from get_work_pool() */
3280 call_rcu_sched(&pool->rcu, rcu_free_pool);
3281}
3282
3283/**
3284 * get_unbound_pool - get a worker_pool with the specified attributes
3285 * @attrs: the attributes of the worker_pool to get
3286 *
3287 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3288 * reference count and return it. If there already is a matching
3289 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003290 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003291 *
3292 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003293 *
3294 * Return: On success, a worker_pool with the same attributes as @attrs.
3295 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003296 */
3297static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3298{
Tejun Heo29c91e92013-03-12 11:30:03 -07003299 u32 hash = wqattrs_hash(attrs);
3300 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003301 int node;
Xunlei Pange2273582015-10-09 11:53:12 +08003302 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003303
Tejun Heoa892cac2013-04-01 11:23:32 -07003304 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003305
3306 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003307 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3308 if (wqattrs_equal(pool->attrs, attrs)) {
3309 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003310 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003311 }
3312 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003313
Xunlei Pange2273582015-10-09 11:53:12 +08003314 /* if cpumask is contained inside a NUMA node, we belong to that node */
3315 if (wq_numa_enabled) {
3316 for_each_node(node) {
3317 if (cpumask_subset(attrs->cpumask,
3318 wq_numa_possible_cpumask[node])) {
3319 target_node = node;
3320 break;
3321 }
3322 }
3323 }
3324
Tejun Heo29c91e92013-03-12 11:30:03 -07003325 /* nope, create a new one */
Xunlei Pange2273582015-10-09 11:53:12 +08003326 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003327 if (!pool || init_worker_pool(pool) < 0)
3328 goto fail;
3329
Tejun Heo8864b4e2013-03-12 11:30:04 -07003330 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003331 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange2273582015-10-09 11:53:12 +08003332 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003333
Shaohua Li2865a8f2013-08-01 09:56:36 +08003334 /*
3335 * no_numa isn't a worker_pool attribute, always clear it. See
3336 * 'struct workqueue_attrs' comments for detail.
3337 */
3338 pool->attrs->no_numa = false;
3339
Tejun Heo29c91e92013-03-12 11:30:03 -07003340 if (worker_pool_assign_id(pool) < 0)
3341 goto fail;
3342
3343 /* create and start the initial worker */
Lai Jiangshan051e1852014-07-22 13:03:02 +08003344 if (!create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003345 goto fail;
3346
Tejun Heo29c91e92013-03-12 11:30:03 -07003347 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003348 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003349
Tejun Heo29c91e92013-03-12 11:30:03 -07003350 return pool;
3351fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003352 if (pool)
3353 put_unbound_pool(pool);
3354 return NULL;
3355}
3356
Tejun Heo8864b4e2013-03-12 11:30:04 -07003357static void rcu_free_pwq(struct rcu_head *rcu)
3358{
3359 kmem_cache_free(pwq_cache,
3360 container_of(rcu, struct pool_workqueue, rcu));
3361}
3362
3363/*
3364 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3365 * and needs to be destroyed.
3366 */
3367static void pwq_unbound_release_workfn(struct work_struct *work)
3368{
3369 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3370 unbound_release_work);
3371 struct workqueue_struct *wq = pwq->wq;
3372 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003373 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003374
3375 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3376 return;
3377
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003378 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003379 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003380 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003381 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003382
Tejun Heoa892cac2013-04-01 11:23:32 -07003383 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003384 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003385 mutex_unlock(&wq_pool_mutex);
3386
Tejun Heo8864b4e2013-03-12 11:30:04 -07003387 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3388
3389 /*
3390 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003391 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003392 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003393 if (is_last)
3394 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003395}
3396
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003397/**
Tejun Heo699ce092013-03-13 16:51:35 -07003398 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003399 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003400 *
Tejun Heo699ce092013-03-13 16:51:35 -07003401 * If @pwq isn't freezing, set @pwq->max_active to the associated
3402 * workqueue's saved_max_active and activate delayed work items
3403 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003404 */
Tejun Heo699ce092013-03-13 16:51:35 -07003405static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003406{
Tejun Heo699ce092013-03-13 16:51:35 -07003407 struct workqueue_struct *wq = pwq->wq;
3408 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003409
Tejun Heo699ce092013-03-13 16:51:35 -07003410 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003411 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003412
3413 /* fast exit for non-freezable wqs */
3414 if (!freezable && pwq->max_active == wq->saved_max_active)
3415 return;
3416
Lai Jiangshana357fc02013-03-25 16:57:19 -07003417 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003418
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003419 /*
3420 * During [un]freezing, the caller is responsible for ensuring that
3421 * this function is called at least once after @workqueue_freezing
3422 * is updated and visible.
3423 */
3424 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003425 pwq->max_active = wq->saved_max_active;
3426
3427 while (!list_empty(&pwq->delayed_works) &&
3428 pwq->nr_active < pwq->max_active)
3429 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003430
3431 /*
3432 * Need to kick a worker after thawed or an unbound wq's
3433 * max_active is bumped. It's a slow path. Do it always.
3434 */
3435 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003436 } else {
3437 pwq->max_active = 0;
3438 }
3439
Lai Jiangshana357fc02013-03-25 16:57:19 -07003440 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003441}
3442
Tejun Heoe50aba92013-04-01 11:23:35 -07003443/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003444static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3445 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003446{
3447 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3448
Tejun Heoe50aba92013-04-01 11:23:35 -07003449 memset(pwq, 0, sizeof(*pwq));
3450
Tejun Heod2c1d402013-03-12 11:30:04 -07003451 pwq->pool = pool;
3452 pwq->wq = wq;
3453 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003454 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003455 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003456 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003457 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003458 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003459}
Tejun Heod2c1d402013-03-12 11:30:04 -07003460
Tejun Heof147f292013-04-01 11:23:35 -07003461/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003462static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003463{
3464 struct workqueue_struct *wq = pwq->wq;
3465
3466 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003467
Tejun Heo1befcf32013-04-01 11:23:35 -07003468 /* may be called multiple times, ignore if already linked */
3469 if (!list_empty(&pwq->pwqs_node))
3470 return;
3471
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003472 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003473 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003474
3475 /* sync max_active to the current setting */
3476 pwq_adjust_max_active(pwq);
3477
3478 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003479 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003480}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003481
Tejun Heof147f292013-04-01 11:23:35 -07003482/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3483static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3484 const struct workqueue_attrs *attrs)
3485{
3486 struct worker_pool *pool;
3487 struct pool_workqueue *pwq;
3488
3489 lockdep_assert_held(&wq_pool_mutex);
3490
3491 pool = get_unbound_pool(attrs);
3492 if (!pool)
3493 return NULL;
3494
Tejun Heoe50aba92013-04-01 11:23:35 -07003495 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003496 if (!pwq) {
3497 put_unbound_pool(pool);
3498 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003499 }
Tejun Heo6029a912013-04-01 11:23:34 -07003500
Tejun Heof147f292013-04-01 11:23:35 -07003501 init_pwq(pwq, wq, pool);
3502 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003503}
3504
Tejun Heo4c16bd32013-04-01 11:23:36 -07003505/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003506 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003507 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003508 * @node: the target NUMA node
3509 * @cpu_going_down: if >= 0, the CPU to consider as offline
3510 * @cpumask: outarg, the resulting cpumask
3511 *
3512 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3513 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003514 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003515 *
3516 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3517 * enabled and @node has online CPUs requested by @attrs, the returned
3518 * cpumask is the intersection of the possible CPUs of @node and
3519 * @attrs->cpumask.
3520 *
3521 * The caller is responsible for ensuring that the cpumask of @node stays
3522 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003523 *
3524 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3525 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003526 */
3527static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3528 int cpu_going_down, cpumask_t *cpumask)
3529{
Tejun Heod55262c2013-04-01 11:23:38 -07003530 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003531 goto use_dfl;
3532
3533 /* does @node have any online CPUs @attrs wants? */
3534 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3535 if (cpu_going_down >= 0)
3536 cpumask_clear_cpu(cpu_going_down, cpumask);
3537
3538 if (cpumask_empty(cpumask))
3539 goto use_dfl;
3540
3541 /* yeap, return possible CPUs in @node that @attrs wants */
3542 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3543 return !cpumask_equal(cpumask, attrs->cpumask);
3544
3545use_dfl:
3546 cpumask_copy(cpumask, attrs->cpumask);
3547 return false;
3548}
3549
Tejun Heo1befcf32013-04-01 11:23:35 -07003550/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3551static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3552 int node,
3553 struct pool_workqueue *pwq)
3554{
3555 struct pool_workqueue *old_pwq;
3556
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003557 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003558 lockdep_assert_held(&wq->mutex);
3559
3560 /* link_pwq() can handle duplicate calls */
3561 link_pwq(pwq);
3562
3563 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3564 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3565 return old_pwq;
3566}
3567
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003568/* context to store the prepared attrs & pwqs before applying */
3569struct apply_wqattrs_ctx {
3570 struct workqueue_struct *wq; /* target workqueue */
3571 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003572 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003573 struct pool_workqueue *dfl_pwq;
3574 struct pool_workqueue *pwq_tbl[];
3575};
3576
3577/* free the resources after success or abort */
3578static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3579{
3580 if (ctx) {
3581 int node;
3582
3583 for_each_node(node)
3584 put_pwq_unlocked(ctx->pwq_tbl[node]);
3585 put_pwq_unlocked(ctx->dfl_pwq);
3586
3587 free_workqueue_attrs(ctx->attrs);
3588
3589 kfree(ctx);
3590 }
3591}
3592
3593/* allocate the attrs and pwqs for later installation */
3594static struct apply_wqattrs_ctx *
3595apply_wqattrs_prepare(struct workqueue_struct *wq,
3596 const struct workqueue_attrs *attrs)
3597{
3598 struct apply_wqattrs_ctx *ctx;
3599 struct workqueue_attrs *new_attrs, *tmp_attrs;
3600 int node;
3601
3602 lockdep_assert_held(&wq_pool_mutex);
3603
3604 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3605 GFP_KERNEL);
3606
3607 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3608 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3609 if (!ctx || !new_attrs || !tmp_attrs)
3610 goto out_free;
3611
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003612 /*
3613 * Calculate the attrs of the default pwq.
3614 * If the user configured cpumask doesn't overlap with the
3615 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3616 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003617 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003618 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003619 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3620 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003621
3622 /*
3623 * We may create multiple pwqs with differing cpumasks. Make a
3624 * copy of @new_attrs which will be modified and used to obtain
3625 * pools.
3626 */
3627 copy_workqueue_attrs(tmp_attrs, new_attrs);
3628
3629 /*
3630 * If something goes wrong during CPU up/down, we'll fall back to
3631 * the default pwq covering whole @attrs->cpumask. Always create
3632 * it even if we don't use it immediately.
3633 */
3634 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3635 if (!ctx->dfl_pwq)
3636 goto out_free;
3637
3638 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003639 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003640 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3641 if (!ctx->pwq_tbl[node])
3642 goto out_free;
3643 } else {
3644 ctx->dfl_pwq->refcnt++;
3645 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3646 }
3647 }
3648
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003649 /* save the user configured attrs and sanitize it. */
3650 copy_workqueue_attrs(new_attrs, attrs);
3651 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003652 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003653
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003654 ctx->wq = wq;
3655 free_workqueue_attrs(tmp_attrs);
3656 return ctx;
3657
3658out_free:
3659 free_workqueue_attrs(tmp_attrs);
3660 free_workqueue_attrs(new_attrs);
3661 apply_wqattrs_cleanup(ctx);
3662 return NULL;
3663}
3664
3665/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3666static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3667{
3668 int node;
3669
3670 /* all pwqs have been created successfully, let's install'em */
3671 mutex_lock(&ctx->wq->mutex);
3672
3673 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3674
3675 /* save the previous pwq and install the new one */
3676 for_each_node(node)
3677 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3678 ctx->pwq_tbl[node]);
3679
3680 /* @dfl_pwq might not have been used, ensure it's linked */
3681 link_pwq(ctx->dfl_pwq);
3682 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3683
3684 mutex_unlock(&ctx->wq->mutex);
3685}
3686
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003687static void apply_wqattrs_lock(void)
3688{
3689 /* CPUs should stay stable across pwq creations and installations */
3690 get_online_cpus();
3691 mutex_lock(&wq_pool_mutex);
3692}
3693
3694static void apply_wqattrs_unlock(void)
3695{
3696 mutex_unlock(&wq_pool_mutex);
3697 put_online_cpus();
3698}
3699
3700static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3701 const struct workqueue_attrs *attrs)
3702{
3703 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003704
3705 /* only unbound workqueues can change attributes */
3706 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3707 return -EINVAL;
3708
3709 /* creating multiple pwqs breaks ordering guarantee */
3710 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3711 return -EINVAL;
3712
3713 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003714 if (!ctx)
3715 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003716
3717 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003718 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003719 apply_wqattrs_cleanup(ctx);
3720
wanghaibin62011712016-01-07 20:38:59 +08003721 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003722}
3723
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003724/**
3725 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3726 * @wq: the target workqueue
3727 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3728 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003729 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3730 * machines, this function maps a separate pwq to each NUMA node with
3731 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3732 * NUMA node it was issued on. Older pwqs are released as in-flight work
3733 * items finish. Note that a work item which repeatedly requeues itself
3734 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003735 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003736 * Performs GFP_KERNEL allocations.
3737 *
3738 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003739 */
3740int apply_workqueue_attrs(struct workqueue_struct *wq,
3741 const struct workqueue_attrs *attrs)
3742{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003743 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003744
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003745 apply_wqattrs_lock();
3746 ret = apply_workqueue_attrs_locked(wq, attrs);
3747 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003748
Tejun Heo48621252013-04-01 11:23:31 -07003749 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003750}
3751
Tejun Heo4c16bd32013-04-01 11:23:36 -07003752/**
3753 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3754 * @wq: the target workqueue
3755 * @cpu: the CPU coming up or going down
3756 * @online: whether @cpu is coming up or going down
3757 *
3758 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3759 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3760 * @wq accordingly.
3761 *
3762 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3763 * falls back to @wq->dfl_pwq which may not be optimal but is always
3764 * correct.
3765 *
3766 * Note that when the last allowed CPU of a NUMA node goes offline for a
3767 * workqueue with a cpumask spanning multiple nodes, the workers which were
3768 * already executing the work items for the workqueue will lose their CPU
3769 * affinity and may execute on any CPU. This is similar to how per-cpu
3770 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3771 * affinity, it's the user's responsibility to flush the work item from
3772 * CPU_DOWN_PREPARE.
3773 */
3774static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3775 bool online)
3776{
3777 int node = cpu_to_node(cpu);
3778 int cpu_off = online ? -1 : cpu;
3779 struct pool_workqueue *old_pwq = NULL, *pwq;
3780 struct workqueue_attrs *target_attrs;
3781 cpumask_t *cpumask;
3782
3783 lockdep_assert_held(&wq_pool_mutex);
3784
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003785 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3786 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003787 return;
3788
3789 /*
3790 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3791 * Let's use a preallocated one. The following buf is protected by
3792 * CPU hotplug exclusion.
3793 */
3794 target_attrs = wq_update_unbound_numa_attrs_buf;
3795 cpumask = target_attrs->cpumask;
3796
Tejun Heo4c16bd32013-04-01 11:23:36 -07003797 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3798 pwq = unbound_pwq_by_node(wq, node);
3799
3800 /*
3801 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003802 * different from the default pwq's, we need to compare it to @pwq's
3803 * and create a new one if they don't match. If the target cpumask
3804 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003805 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003806 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003807 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003808 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003809 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003810 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003811 }
3812
Tejun Heo4c16bd32013-04-01 11:23:36 -07003813 /* create a new pwq */
3814 pwq = alloc_unbound_pwq(wq, target_attrs);
3815 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003816 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3817 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003818 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003819 }
3820
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003821 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003822 mutex_lock(&wq->mutex);
3823 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3824 goto out_unlock;
3825
3826use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003827 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003828 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3829 get_pwq(wq->dfl_pwq);
3830 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3831 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3832out_unlock:
3833 mutex_unlock(&wq->mutex);
3834 put_pwq_unlocked(old_pwq);
3835}
3836
Tejun Heo30cdf242013-03-12 11:29:57 -07003837static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003838{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003839 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003840 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003841
Tejun Heo30cdf242013-03-12 11:29:57 -07003842 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003843 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3844 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003845 return -ENOMEM;
3846
3847 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003848 struct pool_workqueue *pwq =
3849 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003850 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003851 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003852
Tejun Heof147f292013-04-01 11:23:35 -07003853 init_pwq(pwq, wq, &cpu_pools[highpri]);
3854
3855 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003856 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003857 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003858 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003859 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003860 } else if (wq->flags & __WQ_ORDERED) {
3861 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3862 /* there should only be single pwq for ordering guarantee */
3863 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3864 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3865 "ordering guarantee broken for workqueue %s\n", wq->name);
3866 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003867 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003868 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003869 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003870}
3871
Tejun Heof3421792010-07-02 10:03:51 +02003872static int wq_clamp_max_active(int max_active, unsigned int flags,
3873 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003874{
Tejun Heof3421792010-07-02 10:03:51 +02003875 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3876
3877 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003878 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3879 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003880
Tejun Heof3421792010-07-02 10:03:51 +02003881 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003882}
3883
Tejun Heob196be82012-01-10 15:11:35 -08003884struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003885 unsigned int flags,
3886 int max_active,
3887 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003888 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003889{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003890 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003891 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003892 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003893 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003894
Viresh Kumarcee22a12013-04-08 16:45:40 +05303895 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3896 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3897 flags |= WQ_UNBOUND;
3898
Tejun Heoecf68812013-04-01 11:23:34 -07003899 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003900 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003901 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003902
3903 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003904 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003905 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003906
Tejun Heo6029a912013-04-01 11:23:34 -07003907 if (flags & WQ_UNBOUND) {
3908 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3909 if (!wq->unbound_attrs)
3910 goto err_free_wq;
3911 }
3912
Tejun Heoecf68812013-04-01 11:23:34 -07003913 va_start(args, lock_name);
3914 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003915 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003916
Tejun Heod320c032010-06-29 10:07:14 +02003917 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003918 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003919
Tejun Heob196be82012-01-10 15:11:35 -08003920 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003921 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003922 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003923 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003924 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003925 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003926 INIT_LIST_HEAD(&wq->flusher_queue);
3927 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003928 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003929
Johannes Bergeb13ba82008-01-16 09:51:58 +01003930 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003931 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003932
Tejun Heo30cdf242013-03-12 11:29:57 -07003933 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07003934 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003935
Tejun Heo493008a2013-03-12 11:30:03 -07003936 /*
3937 * Workqueues which may be used during memory reclaim should
3938 * have a rescuer to guarantee forward progress.
3939 */
3940 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003941 struct worker *rescuer;
3942
Lai Jiangshanf7537df2014-07-15 17:24:15 +08003943 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003944 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07003945 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02003946
Tejun Heo111c2252013-01-17 17:16:24 -08003947 rescuer->rescue_wq = wq;
3948 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003949 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07003950 if (IS_ERR(rescuer->task)) {
3951 kfree(rescuer);
3952 goto err_destroy;
3953 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003954
Tejun Heod2c1d402013-03-12 11:30:04 -07003955 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02003956 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003957 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003958 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003959
Tejun Heo226223a2013-03-12 11:30:05 -07003960 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3961 goto err_destroy;
3962
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003963 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003964 * wq_pool_mutex protects global freeze state and workqueues list.
3965 * Grab it, adjust max_active and add the new @wq to workqueues
3966 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003967 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003968 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003969
Lai Jiangshana357fc02013-03-25 16:57:19 -07003970 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003971 for_each_pwq(pwq, wq)
3972 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07003973 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003974
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003975 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003976
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003977 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02003978
Oleg Nesterov3af244332007-05-09 02:34:09 -07003979 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003980
3981err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07003982 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07003983 kfree(wq);
3984 return NULL;
3985err_destroy:
3986 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003987 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003988}
Tejun Heod320c032010-06-29 10:07:14 +02003989EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003990
3991/**
3992 * destroy_workqueue - safely terminate a workqueue
3993 * @wq: target workqueue
3994 *
3995 * Safely destroy a workqueue. All work currently pending will be done first.
3996 */
3997void destroy_workqueue(struct workqueue_struct *wq)
3998{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003999 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004000 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004001
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004002 /* drain it before proceeding with destruction */
4003 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004004
Tejun Heo6183c002013-03-12 11:29:57 -07004005 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004006 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004007 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004008 int i;
4009
Tejun Heo76af4d92013-03-12 11:30:00 -07004010 for (i = 0; i < WORK_NR_COLORS; i++) {
4011 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004012 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004013 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004014 }
4015 }
4016
Lai Jiangshan5c529592013-04-04 10:05:38 +08004017 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004018 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004019 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004020 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004021 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004022 }
Tejun Heo6183c002013-03-12 11:29:57 -07004023 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004024 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004025
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004026 /*
4027 * wq list is used to freeze wq, remove from list after
4028 * flushing is complete in case freeze races us.
4029 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004030 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004031 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004032 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004033
Tejun Heo226223a2013-03-12 11:30:05 -07004034 workqueue_sysfs_unregister(wq);
4035
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004036 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004037 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004038
Tejun Heo8864b4e2013-03-12 11:30:04 -07004039 if (!(wq->flags & WQ_UNBOUND)) {
4040 /*
4041 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004042 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004043 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004044 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004045 } else {
4046 /*
4047 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004048 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4049 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004050 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004051 for_each_node(node) {
4052 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4053 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4054 put_pwq_unlocked(pwq);
4055 }
4056
4057 /*
4058 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4059 * put. Don't access it afterwards.
4060 */
4061 pwq = wq->dfl_pwq;
4062 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004063 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004064 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004065}
4066EXPORT_SYMBOL_GPL(destroy_workqueue);
4067
Tejun Heodcd989c2010-06-29 10:07:14 +02004068/**
4069 * workqueue_set_max_active - adjust max_active of a workqueue
4070 * @wq: target workqueue
4071 * @max_active: new max_active value.
4072 *
4073 * Set max_active of @wq to @max_active.
4074 *
4075 * CONTEXT:
4076 * Don't call from IRQ context.
4077 */
4078void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4079{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004080 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004081
Tejun Heo8719dce2013-03-12 11:30:04 -07004082 /* disallow meddling with max_active for ordered workqueues */
4083 if (WARN_ON(wq->flags & __WQ_ORDERED))
4084 return;
4085
Tejun Heof3421792010-07-02 10:03:51 +02004086 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004087
Lai Jiangshana357fc02013-03-25 16:57:19 -07004088 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004089
4090 wq->saved_max_active = max_active;
4091
Tejun Heo699ce092013-03-13 16:51:35 -07004092 for_each_pwq(pwq, wq)
4093 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004094
Lai Jiangshana357fc02013-03-25 16:57:19 -07004095 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004096}
4097EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4098
4099/**
Tejun Heoe62676162013-03-12 17:41:37 -07004100 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4101 *
4102 * Determine whether %current is a workqueue rescuer. Can be used from
4103 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004104 *
4105 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004106 */
4107bool current_is_workqueue_rescuer(void)
4108{
4109 struct worker *worker = current_wq_worker();
4110
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004111 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004112}
4113
4114/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004115 * workqueue_congested - test whether a workqueue is congested
4116 * @cpu: CPU in question
4117 * @wq: target workqueue
4118 *
4119 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4120 * no synchronization around this function and the test result is
4121 * unreliable and only useful as advisory hints or for debugging.
4122 *
Tejun Heod3251852013-05-10 11:10:17 -07004123 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4124 * Note that both per-cpu and unbound workqueues may be associated with
4125 * multiple pool_workqueues which have separate congested states. A
4126 * workqueue being congested on one CPU doesn't mean the workqueue is also
4127 * contested on other CPUs / NUMA nodes.
4128 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004129 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004130 * %true if congested, %false otherwise.
4131 */
Tejun Heod84ff052013-03-12 11:29:59 -07004132bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004133{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004134 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004135 bool ret;
4136
Lai Jiangshan88109452013-03-20 03:28:10 +08004137 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004138
Tejun Heod3251852013-05-10 11:10:17 -07004139 if (cpu == WORK_CPU_UNBOUND)
4140 cpu = smp_processor_id();
4141
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004142 if (!(wq->flags & WQ_UNBOUND))
4143 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4144 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004145 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004146
Tejun Heo76af4d92013-03-12 11:30:00 -07004147 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004148 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004149
4150 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004151}
4152EXPORT_SYMBOL_GPL(workqueue_congested);
4153
4154/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004155 * work_busy - test whether a work is currently pending or running
4156 * @work: the work to be tested
4157 *
4158 * Test whether @work is currently pending or running. There is no
4159 * synchronization around this function and the test result is
4160 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004161 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004162 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004163 * OR'd bitmask of WORK_BUSY_* bits.
4164 */
4165unsigned int work_busy(struct work_struct *work)
4166{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004167 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004168 unsigned long flags;
4169 unsigned int ret = 0;
4170
Tejun Heodcd989c2010-06-29 10:07:14 +02004171 if (work_pending(work))
4172 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004173
Tejun Heofa1b54e2013-03-12 11:30:00 -07004174 local_irq_save(flags);
4175 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004176 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004177 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004178 if (find_worker_executing_work(pool, work))
4179 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004180 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004181 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004182 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004183
4184 return ret;
4185}
4186EXPORT_SYMBOL_GPL(work_busy);
4187
Tejun Heo3d1cb202013-04-30 15:27:22 -07004188/**
4189 * set_worker_desc - set description for the current work item
4190 * @fmt: printf-style format string
4191 * @...: arguments for the format string
4192 *
4193 * This function can be called by a running work function to describe what
4194 * the work item is about. If the worker task gets dumped, this
4195 * information will be printed out together to help debugging. The
4196 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4197 */
4198void set_worker_desc(const char *fmt, ...)
4199{
4200 struct worker *worker = current_wq_worker();
4201 va_list args;
4202
4203 if (worker) {
4204 va_start(args, fmt);
4205 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4206 va_end(args);
4207 worker->desc_valid = true;
4208 }
4209}
4210
4211/**
4212 * print_worker_info - print out worker information and description
4213 * @log_lvl: the log level to use when printing
4214 * @task: target task
4215 *
4216 * If @task is a worker and currently executing a work item, print out the
4217 * name of the workqueue being serviced and worker description set with
4218 * set_worker_desc() by the currently executing work item.
4219 *
4220 * This function can be safely called on any task as long as the
4221 * task_struct itself is accessible. While safe, this function isn't
4222 * synchronized and may print out mixups or garbages of limited length.
4223 */
4224void print_worker_info(const char *log_lvl, struct task_struct *task)
4225{
4226 work_func_t *fn = NULL;
4227 char name[WQ_NAME_LEN] = { };
4228 char desc[WORKER_DESC_LEN] = { };
4229 struct pool_workqueue *pwq = NULL;
4230 struct workqueue_struct *wq = NULL;
4231 bool desc_valid = false;
4232 struct worker *worker;
4233
4234 if (!(task->flags & PF_WQ_WORKER))
4235 return;
4236
4237 /*
4238 * This function is called without any synchronization and @task
4239 * could be in any state. Be careful with dereferences.
4240 */
4241 worker = probe_kthread_data(task);
4242
4243 /*
4244 * Carefully copy the associated workqueue's workfn and name. Keep
4245 * the original last '\0' in case the original contains garbage.
4246 */
4247 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4248 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4249 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4250 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4251
4252 /* copy worker description */
4253 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4254 if (desc_valid)
4255 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4256
4257 if (fn || name[0] || desc[0]) {
4258 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4259 if (desc[0])
4260 pr_cont(" (%s)", desc);
4261 pr_cont("\n");
4262 }
4263}
4264
Tejun Heo3494fc32015-03-09 09:22:28 -04004265static void pr_cont_pool_info(struct worker_pool *pool)
4266{
4267 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4268 if (pool->node != NUMA_NO_NODE)
4269 pr_cont(" node=%d", pool->node);
4270 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4271}
4272
4273static void pr_cont_work(bool comma, struct work_struct *work)
4274{
4275 if (work->func == wq_barrier_func) {
4276 struct wq_barrier *barr;
4277
4278 barr = container_of(work, struct wq_barrier, work);
4279
4280 pr_cont("%s BAR(%d)", comma ? "," : "",
4281 task_pid_nr(barr->task));
4282 } else {
4283 pr_cont("%s %pf", comma ? "," : "", work->func);
4284 }
4285}
4286
4287static void show_pwq(struct pool_workqueue *pwq)
4288{
4289 struct worker_pool *pool = pwq->pool;
4290 struct work_struct *work;
4291 struct worker *worker;
4292 bool has_in_flight = false, has_pending = false;
4293 int bkt;
4294
4295 pr_info(" pwq %d:", pool->id);
4296 pr_cont_pool_info(pool);
4297
4298 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4299 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4300
4301 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4302 if (worker->current_pwq == pwq) {
4303 has_in_flight = true;
4304 break;
4305 }
4306 }
4307 if (has_in_flight) {
4308 bool comma = false;
4309
4310 pr_info(" in-flight:");
4311 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4312 if (worker->current_pwq != pwq)
4313 continue;
4314
4315 pr_cont("%s %d%s:%pf", comma ? "," : "",
4316 task_pid_nr(worker->task),
4317 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4318 worker->current_func);
4319 list_for_each_entry(work, &worker->scheduled, entry)
4320 pr_cont_work(false, work);
4321 comma = true;
4322 }
4323 pr_cont("\n");
4324 }
4325
4326 list_for_each_entry(work, &pool->worklist, entry) {
4327 if (get_work_pwq(work) == pwq) {
4328 has_pending = true;
4329 break;
4330 }
4331 }
4332 if (has_pending) {
4333 bool comma = false;
4334
4335 pr_info(" pending:");
4336 list_for_each_entry(work, &pool->worklist, entry) {
4337 if (get_work_pwq(work) != pwq)
4338 continue;
4339
4340 pr_cont_work(comma, work);
4341 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4342 }
4343 pr_cont("\n");
4344 }
4345
4346 if (!list_empty(&pwq->delayed_works)) {
4347 bool comma = false;
4348
4349 pr_info(" delayed:");
4350 list_for_each_entry(work, &pwq->delayed_works, entry) {
4351 pr_cont_work(comma, work);
4352 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4353 }
4354 pr_cont("\n");
4355 }
4356}
4357
4358/**
4359 * show_workqueue_state - dump workqueue state
4360 *
4361 * Called from a sysrq handler and prints out all busy workqueues and
4362 * pools.
4363 */
4364void show_workqueue_state(void)
4365{
4366 struct workqueue_struct *wq;
4367 struct worker_pool *pool;
4368 unsigned long flags;
4369 int pi;
4370
4371 rcu_read_lock_sched();
4372
4373 pr_info("Showing busy workqueues and worker pools:\n");
4374
4375 list_for_each_entry_rcu(wq, &workqueues, list) {
4376 struct pool_workqueue *pwq;
4377 bool idle = true;
4378
4379 for_each_pwq(pwq, wq) {
4380 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4381 idle = false;
4382 break;
4383 }
4384 }
4385 if (idle)
4386 continue;
4387
4388 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4389
4390 for_each_pwq(pwq, wq) {
4391 spin_lock_irqsave(&pwq->pool->lock, flags);
4392 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4393 show_pwq(pwq);
4394 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4395 }
4396 }
4397
4398 for_each_pool(pool, pi) {
4399 struct worker *worker;
4400 bool first = true;
4401
4402 spin_lock_irqsave(&pool->lock, flags);
4403 if (pool->nr_workers == pool->nr_idle)
4404 goto next_pool;
4405
4406 pr_info("pool %d:", pool->id);
4407 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004408 pr_cont(" hung=%us workers=%d",
4409 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4410 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004411 if (pool->manager)
4412 pr_cont(" manager: %d",
4413 task_pid_nr(pool->manager->task));
4414 list_for_each_entry(worker, &pool->idle_list, entry) {
4415 pr_cont(" %s%d", first ? "idle: " : "",
4416 task_pid_nr(worker->task));
4417 first = false;
4418 }
4419 pr_cont("\n");
4420 next_pool:
4421 spin_unlock_irqrestore(&pool->lock, flags);
4422 }
4423
4424 rcu_read_unlock_sched();
4425}
4426
Tejun Heodb7bccf2010-06-29 10:07:12 +02004427/*
4428 * CPU hotplug.
4429 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004430 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004431 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004432 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004433 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004434 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004435 * blocked draining impractical.
4436 *
Tejun Heo24647572013-01-24 11:01:33 -08004437 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004438 * running as an unbound one and allowing it to be reattached later if the
4439 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004440 */
4441
Tejun Heo706026c2013-01-24 11:01:34 -08004442static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004443{
Tejun Heo38db41d2013-01-24 11:01:34 -08004444 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004445 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004446 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004447
Tejun Heof02ae732013-03-12 11:30:03 -07004448 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004449 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004450 spin_lock_irq(&pool->lock);
4451
4452 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004453 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004454 * unbound and set DISASSOCIATED. Before this, all workers
4455 * except for the ones which are still executing works from
4456 * before the last CPU down must be on the cpu. After
4457 * this, they may become diasporas.
4458 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004459 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004460 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004461
Tejun Heo24647572013-01-24 11:01:33 -08004462 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004463
Tejun Heo94cf58b2013-01-24 11:01:33 -08004464 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004465 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004466
Lai Jiangshaneb283422013-03-08 15:18:28 -08004467 /*
4468 * Call schedule() so that we cross rq->lock and thus can
4469 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4470 * This is necessary as scheduler callbacks may be invoked
4471 * from other cpus.
4472 */
4473 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004474
Lai Jiangshaneb283422013-03-08 15:18:28 -08004475 /*
4476 * Sched callbacks are disabled now. Zap nr_running.
4477 * After this, nr_running stays zero and need_more_worker()
4478 * and keep_working() are always true as long as the
4479 * worklist is not empty. This pool now behaves as an
4480 * unbound (in terms of concurrency management) pool which
4481 * are served by workers tied to the pool.
4482 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004483 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004484
4485 /*
4486 * With concurrency management just turned off, a busy
4487 * worker blocking could lead to lengthy stalls. Kick off
4488 * unbound chain execution of currently pending work items.
4489 */
4490 spin_lock_irq(&pool->lock);
4491 wake_up_worker(pool);
4492 spin_unlock_irq(&pool->lock);
4493 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004494}
4495
Tejun Heobd7c0892013-03-19 13:45:21 -07004496/**
4497 * rebind_workers - rebind all workers of a pool to the associated CPU
4498 * @pool: pool of interest
4499 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004500 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004501 */
4502static void rebind_workers(struct worker_pool *pool)
4503{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004504 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004505
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004506 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004507
Tejun Heoa9ab7752013-03-19 13:45:21 -07004508 /*
4509 * Restore CPU affinity of all workers. As all idle workers should
4510 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304511 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004512 * of all workers first and then clear UNBOUND. As we're called
4513 * from CPU_ONLINE, the following shouldn't fail.
4514 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004515 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004516 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4517 pool->attrs->cpumask) < 0);
4518
4519 spin_lock_irq(&pool->lock);
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004520 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004521
Lai Jiangshanda028462014-05-20 17:46:31 +08004522 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004523 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004524
4525 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004526 * A bound idle worker should actually be on the runqueue
4527 * of the associated CPU for local wake-ups targeting it to
4528 * work. Kick all idle workers so that they migrate to the
4529 * associated CPU. Doing this in the same loop as
4530 * replacing UNBOUND with REBOUND is safe as no worker will
4531 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004532 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004533 if (worker_flags & WORKER_IDLE)
4534 wake_up_process(worker->task);
4535
4536 /*
4537 * We want to clear UNBOUND but can't directly call
4538 * worker_clr_flags() or adjust nr_running. Atomically
4539 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4540 * @worker will clear REBOUND using worker_clr_flags() when
4541 * it initiates the next execution cycle thus restoring
4542 * concurrency management. Note that when or whether
4543 * @worker clears REBOUND doesn't affect correctness.
4544 *
4545 * ACCESS_ONCE() is necessary because @worker->flags may be
4546 * tested without holding any lock in
4547 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4548 * fail incorrectly leading to premature concurrency
4549 * management operations.
4550 */
4551 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4552 worker_flags |= WORKER_REBOUND;
4553 worker_flags &= ~WORKER_UNBOUND;
4554 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004555 }
4556
Tejun Heoa9ab7752013-03-19 13:45:21 -07004557 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004558}
4559
Tejun Heo7dbc7252013-03-19 13:45:21 -07004560/**
4561 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4562 * @pool: unbound pool of interest
4563 * @cpu: the CPU which is coming up
4564 *
4565 * An unbound pool may end up with a cpumask which doesn't have any online
4566 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4567 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4568 * online CPU before, cpus_allowed of all its workers should be restored.
4569 */
4570static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4571{
4572 static cpumask_t cpumask;
4573 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004574
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004575 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004576
4577 /* is @cpu allowed for @pool? */
4578 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4579 return;
4580
4581 /* is @cpu the only online CPU? */
4582 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4583 if (cpumask_weight(&cpumask) != 1)
4584 return;
4585
4586 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004587 for_each_pool_worker(worker, pool)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004588 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4589 pool->attrs->cpumask) < 0);
4590}
4591
Tejun Heo8db25e72012-07-17 12:39:28 -07004592/*
4593 * Workqueues should be brought up before normal priority CPU notifiers.
4594 * This will be registered high priority CPU notifier.
4595 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004596static int workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004597 unsigned long action,
4598 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004599{
Tejun Heod84ff052013-03-12 11:29:59 -07004600 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004601 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004602 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004603 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004604
Tejun Heo8db25e72012-07-17 12:39:28 -07004605 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004606 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004607 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004608 if (pool->nr_workers)
4609 continue;
Lai Jiangshan051e1852014-07-22 13:03:02 +08004610 if (!create_worker(pool))
Tejun Heo3ce63372012-07-17 12:39:27 -07004611 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004612 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004613 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004614
Tejun Heo65758202012-07-17 12:39:26 -07004615 case CPU_DOWN_FAILED:
4616 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004617 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004618
4619 for_each_pool(pool, pi) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004620 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004621
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004622 if (pool->cpu == cpu)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004623 rebind_workers(pool);
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004624 else if (pool->cpu < 0)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004625 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004626
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004627 mutex_unlock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004628 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004629
Tejun Heo4c16bd32013-04-01 11:23:36 -07004630 /* update NUMA affinity of unbound workqueues */
4631 list_for_each_entry(wq, &workqueues, list)
4632 wq_update_unbound_numa(wq, cpu, true);
4633
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004634 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004635 break;
Tejun Heo65758202012-07-17 12:39:26 -07004636 }
4637 return NOTIFY_OK;
4638}
4639
4640/*
4641 * Workqueues should be brought down after normal priority CPU notifiers.
4642 * This will be registered as low priority CPU notifier.
4643 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004644static int workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004645 unsigned long action,
4646 void *hcpu)
4647{
Tejun Heod84ff052013-03-12 11:29:59 -07004648 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004649 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004650 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004651
Tejun Heo65758202012-07-17 12:39:26 -07004652 switch (action & ~CPU_TASKS_FROZEN) {
4653 case CPU_DOWN_PREPARE:
Tejun Heo4c16bd32013-04-01 11:23:36 -07004654 /* unbinding per-cpu workers should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004655 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004656 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004657
4658 /* update NUMA affinity of unbound workqueues */
4659 mutex_lock(&wq_pool_mutex);
4660 list_for_each_entry(wq, &workqueues, list)
4661 wq_update_unbound_numa(wq, cpu, false);
4662 mutex_unlock(&wq_pool_mutex);
4663
4664 /* wait for per-cpu unbinding to finish */
Tejun Heo8db25e72012-07-17 12:39:28 -07004665 flush_work(&unbind_work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004666 destroy_work_on_stack(&unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004667 break;
Tejun Heo65758202012-07-17 12:39:26 -07004668 }
4669 return NOTIFY_OK;
4670}
4671
Rusty Russell2d3854a2008-11-05 13:39:10 +11004672#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004673
Rusty Russell2d3854a2008-11-05 13:39:10 +11004674struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004675 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004676 long (*fn)(void *);
4677 void *arg;
4678 long ret;
4679};
4680
Tejun Heoed48ece2012-09-18 12:48:43 -07004681static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004682{
Tejun Heoed48ece2012-09-18 12:48:43 -07004683 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4684
Rusty Russell2d3854a2008-11-05 13:39:10 +11004685 wfc->ret = wfc->fn(wfc->arg);
4686}
4687
4688/**
4689 * work_on_cpu - run a function in user context on a particular cpu
4690 * @cpu: the cpu to run on
4691 * @fn: the function to run
4692 * @arg: the function arg
4693 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004694 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004695 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004696 *
4697 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004698 */
Tejun Heod84ff052013-03-12 11:29:59 -07004699long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004700{
Tejun Heoed48ece2012-09-18 12:48:43 -07004701 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004702
Tejun Heoed48ece2012-09-18 12:48:43 -07004703 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4704 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004705 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004706 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004707 return wfc.ret;
4708}
4709EXPORT_SYMBOL_GPL(work_on_cpu);
4710#endif /* CONFIG_SMP */
4711
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004712#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304713
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004714/**
4715 * freeze_workqueues_begin - begin freezing workqueues
4716 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004717 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004718 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004719 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004720 *
4721 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004722 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004723 */
4724void freeze_workqueues_begin(void)
4725{
Tejun Heo24b8a842013-03-12 11:29:58 -07004726 struct workqueue_struct *wq;
4727 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004728
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004729 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004730
Tejun Heo6183c002013-03-12 11:29:57 -07004731 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004732 workqueue_freezing = true;
4733
Tejun Heo24b8a842013-03-12 11:29:58 -07004734 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004735 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004736 for_each_pwq(pwq, wq)
4737 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004738 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004739 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004740
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004741 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004742}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004743
4744/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004745 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004746 *
4747 * Check whether freezing is complete. This function must be called
4748 * between freeze_workqueues_begin() and thaw_workqueues().
4749 *
4750 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004751 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004752 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004753 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004754 * %true if some freezable workqueues are still busy. %false if freezing
4755 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004756 */
4757bool freeze_workqueues_busy(void)
4758{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004759 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004760 struct workqueue_struct *wq;
4761 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004762
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004763 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004764
Tejun Heo6183c002013-03-12 11:29:57 -07004765 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004766
Tejun Heo24b8a842013-03-12 11:29:58 -07004767 list_for_each_entry(wq, &workqueues, list) {
4768 if (!(wq->flags & WQ_FREEZABLE))
4769 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004770 /*
4771 * nr_active is monotonically decreasing. It's safe
4772 * to peek without lock.
4773 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004774 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004775 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004776 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004777 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004778 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004779 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004780 goto out_unlock;
4781 }
4782 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004783 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004784 }
4785out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004786 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004787 return busy;
4788}
4789
4790/**
4791 * thaw_workqueues - thaw workqueues
4792 *
4793 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004794 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004795 *
4796 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004797 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004798 */
4799void thaw_workqueues(void)
4800{
Tejun Heo24b8a842013-03-12 11:29:58 -07004801 struct workqueue_struct *wq;
4802 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004803
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004804 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004805
4806 if (!workqueue_freezing)
4807 goto out_unlock;
4808
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004809 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004810
Tejun Heo24b8a842013-03-12 11:29:58 -07004811 /* restore max_active and repopulate worklist */
4812 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004813 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004814 for_each_pwq(pwq, wq)
4815 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004816 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004817 }
4818
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004819out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004820 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004821}
4822#endif /* CONFIG_FREEZER */
4823
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004824static int workqueue_apply_unbound_cpumask(void)
4825{
4826 LIST_HEAD(ctxs);
4827 int ret = 0;
4828 struct workqueue_struct *wq;
4829 struct apply_wqattrs_ctx *ctx, *n;
4830
4831 lockdep_assert_held(&wq_pool_mutex);
4832
4833 list_for_each_entry(wq, &workqueues, list) {
4834 if (!(wq->flags & WQ_UNBOUND))
4835 continue;
4836 /* creating multiple pwqs breaks ordering guarantee */
4837 if (wq->flags & __WQ_ORDERED)
4838 continue;
4839
4840 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4841 if (!ctx) {
4842 ret = -ENOMEM;
4843 break;
4844 }
4845
4846 list_add_tail(&ctx->list, &ctxs);
4847 }
4848
4849 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4850 if (!ret)
4851 apply_wqattrs_commit(ctx);
4852 apply_wqattrs_cleanup(ctx);
4853 }
4854
4855 return ret;
4856}
4857
4858/**
4859 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4860 * @cpumask: the cpumask to set
4861 *
4862 * The low-level workqueues cpumask is a global cpumask that limits
4863 * the affinity of all unbound workqueues. This function check the @cpumask
4864 * and apply it to all unbound workqueues and updates all pwqs of them.
4865 *
4866 * Retun: 0 - Success
4867 * -EINVAL - Invalid @cpumask
4868 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4869 */
4870int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4871{
4872 int ret = -EINVAL;
4873 cpumask_var_t saved_cpumask;
4874
4875 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4876 return -ENOMEM;
4877
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004878 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4879 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004880 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004881
4882 /* save the old wq_unbound_cpumask. */
4883 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4884
4885 /* update wq_unbound_cpumask at first and apply it to wqs. */
4886 cpumask_copy(wq_unbound_cpumask, cpumask);
4887 ret = workqueue_apply_unbound_cpumask();
4888
4889 /* restore the wq_unbound_cpumask when failed. */
4890 if (ret < 0)
4891 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4892
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004893 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004894 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004895
4896 free_cpumask_var(saved_cpumask);
4897 return ret;
4898}
4899
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004900#ifdef CONFIG_SYSFS
4901/*
4902 * Workqueues with WQ_SYSFS flag set is visible to userland via
4903 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4904 * following attributes.
4905 *
4906 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4907 * max_active RW int : maximum number of in-flight work items
4908 *
4909 * Unbound workqueues have the following extra attributes.
4910 *
4911 * id RO int : the associated pool ID
4912 * nice RW int : nice value of the workers
4913 * cpumask RW mask : bitmask of allowed CPUs for the workers
4914 */
4915struct wq_device {
4916 struct workqueue_struct *wq;
4917 struct device dev;
4918};
4919
4920static struct workqueue_struct *dev_to_wq(struct device *dev)
4921{
4922 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
4923
4924 return wq_dev->wq;
4925}
4926
4927static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
4928 char *buf)
4929{
4930 struct workqueue_struct *wq = dev_to_wq(dev);
4931
4932 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
4933}
4934static DEVICE_ATTR_RO(per_cpu);
4935
4936static ssize_t max_active_show(struct device *dev,
4937 struct device_attribute *attr, char *buf)
4938{
4939 struct workqueue_struct *wq = dev_to_wq(dev);
4940
4941 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
4942}
4943
4944static ssize_t max_active_store(struct device *dev,
4945 struct device_attribute *attr, const char *buf,
4946 size_t count)
4947{
4948 struct workqueue_struct *wq = dev_to_wq(dev);
4949 int val;
4950
4951 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
4952 return -EINVAL;
4953
4954 workqueue_set_max_active(wq, val);
4955 return count;
4956}
4957static DEVICE_ATTR_RW(max_active);
4958
4959static struct attribute *wq_sysfs_attrs[] = {
4960 &dev_attr_per_cpu.attr,
4961 &dev_attr_max_active.attr,
4962 NULL,
4963};
4964ATTRIBUTE_GROUPS(wq_sysfs);
4965
4966static ssize_t wq_pool_ids_show(struct device *dev,
4967 struct device_attribute *attr, char *buf)
4968{
4969 struct workqueue_struct *wq = dev_to_wq(dev);
4970 const char *delim = "";
4971 int node, written = 0;
4972
4973 rcu_read_lock_sched();
4974 for_each_node(node) {
4975 written += scnprintf(buf + written, PAGE_SIZE - written,
4976 "%s%d:%d", delim, node,
4977 unbound_pwq_by_node(wq, node)->pool->id);
4978 delim = " ";
4979 }
4980 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
4981 rcu_read_unlock_sched();
4982
4983 return written;
4984}
4985
4986static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
4987 char *buf)
4988{
4989 struct workqueue_struct *wq = dev_to_wq(dev);
4990 int written;
4991
4992 mutex_lock(&wq->mutex);
4993 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
4994 mutex_unlock(&wq->mutex);
4995
4996 return written;
4997}
4998
4999/* prepare workqueue_attrs for sysfs store operations */
5000static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5001{
5002 struct workqueue_attrs *attrs;
5003
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005004 lockdep_assert_held(&wq_pool_mutex);
5005
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005006 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5007 if (!attrs)
5008 return NULL;
5009
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005010 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005011 return attrs;
5012}
5013
5014static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5015 const char *buf, size_t count)
5016{
5017 struct workqueue_struct *wq = dev_to_wq(dev);
5018 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005019 int ret = -ENOMEM;
5020
5021 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005022
5023 attrs = wq_sysfs_prep_attrs(wq);
5024 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005025 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005026
5027 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5028 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005029 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005030 else
5031 ret = -EINVAL;
5032
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005033out_unlock:
5034 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005035 free_workqueue_attrs(attrs);
5036 return ret ?: count;
5037}
5038
5039static ssize_t wq_cpumask_show(struct device *dev,
5040 struct device_attribute *attr, char *buf)
5041{
5042 struct workqueue_struct *wq = dev_to_wq(dev);
5043 int written;
5044
5045 mutex_lock(&wq->mutex);
5046 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5047 cpumask_pr_args(wq->unbound_attrs->cpumask));
5048 mutex_unlock(&wq->mutex);
5049 return written;
5050}
5051
5052static ssize_t wq_cpumask_store(struct device *dev,
5053 struct device_attribute *attr,
5054 const char *buf, size_t count)
5055{
5056 struct workqueue_struct *wq = dev_to_wq(dev);
5057 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005058 int ret = -ENOMEM;
5059
5060 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005061
5062 attrs = wq_sysfs_prep_attrs(wq);
5063 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005064 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005065
5066 ret = cpumask_parse(buf, attrs->cpumask);
5067 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005068 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005069
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005070out_unlock:
5071 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005072 free_workqueue_attrs(attrs);
5073 return ret ?: count;
5074}
5075
5076static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5077 char *buf)
5078{
5079 struct workqueue_struct *wq = dev_to_wq(dev);
5080 int written;
5081
5082 mutex_lock(&wq->mutex);
5083 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5084 !wq->unbound_attrs->no_numa);
5085 mutex_unlock(&wq->mutex);
5086
5087 return written;
5088}
5089
5090static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5091 const char *buf, size_t count)
5092{
5093 struct workqueue_struct *wq = dev_to_wq(dev);
5094 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005095 int v, ret = -ENOMEM;
5096
5097 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005098
5099 attrs = wq_sysfs_prep_attrs(wq);
5100 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005101 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005102
5103 ret = -EINVAL;
5104 if (sscanf(buf, "%d", &v) == 1) {
5105 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005106 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005107 }
5108
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005109out_unlock:
5110 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005111 free_workqueue_attrs(attrs);
5112 return ret ?: count;
5113}
5114
5115static struct device_attribute wq_sysfs_unbound_attrs[] = {
5116 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5117 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5118 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5119 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5120 __ATTR_NULL,
5121};
5122
5123static struct bus_type wq_subsys = {
5124 .name = "workqueue",
5125 .dev_groups = wq_sysfs_groups,
5126};
5127
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005128static ssize_t wq_unbound_cpumask_show(struct device *dev,
5129 struct device_attribute *attr, char *buf)
5130{
5131 int written;
5132
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005133 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005134 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5135 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005136 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005137
5138 return written;
5139}
5140
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005141static ssize_t wq_unbound_cpumask_store(struct device *dev,
5142 struct device_attribute *attr, const char *buf, size_t count)
5143{
5144 cpumask_var_t cpumask;
5145 int ret;
5146
5147 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5148 return -ENOMEM;
5149
5150 ret = cpumask_parse(buf, cpumask);
5151 if (!ret)
5152 ret = workqueue_set_unbound_cpumask(cpumask);
5153
5154 free_cpumask_var(cpumask);
5155 return ret ? ret : count;
5156}
5157
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005158static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005159 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5160 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005161
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005162static int __init wq_sysfs_init(void)
5163{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005164 int err;
5165
5166 err = subsys_virtual_register(&wq_subsys, NULL);
5167 if (err)
5168 return err;
5169
5170 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005171}
5172core_initcall(wq_sysfs_init);
5173
5174static void wq_device_release(struct device *dev)
5175{
5176 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5177
5178 kfree(wq_dev);
5179}
5180
5181/**
5182 * workqueue_sysfs_register - make a workqueue visible in sysfs
5183 * @wq: the workqueue to register
5184 *
5185 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5186 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5187 * which is the preferred method.
5188 *
5189 * Workqueue user should use this function directly iff it wants to apply
5190 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5191 * apply_workqueue_attrs() may race against userland updating the
5192 * attributes.
5193 *
5194 * Return: 0 on success, -errno on failure.
5195 */
5196int workqueue_sysfs_register(struct workqueue_struct *wq)
5197{
5198 struct wq_device *wq_dev;
5199 int ret;
5200
5201 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305202 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005203 * attributes breaks ordering guarantee. Disallow exposing ordered
5204 * workqueues.
5205 */
5206 if (WARN_ON(wq->flags & __WQ_ORDERED))
5207 return -EINVAL;
5208
5209 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5210 if (!wq_dev)
5211 return -ENOMEM;
5212
5213 wq_dev->wq = wq;
5214 wq_dev->dev.bus = &wq_subsys;
5215 wq_dev->dev.init_name = wq->name;
5216 wq_dev->dev.release = wq_device_release;
5217
5218 /*
5219 * unbound_attrs are created separately. Suppress uevent until
5220 * everything is ready.
5221 */
5222 dev_set_uevent_suppress(&wq_dev->dev, true);
5223
5224 ret = device_register(&wq_dev->dev);
5225 if (ret) {
5226 kfree(wq_dev);
5227 wq->wq_dev = NULL;
5228 return ret;
5229 }
5230
5231 if (wq->flags & WQ_UNBOUND) {
5232 struct device_attribute *attr;
5233
5234 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5235 ret = device_create_file(&wq_dev->dev, attr);
5236 if (ret) {
5237 device_unregister(&wq_dev->dev);
5238 wq->wq_dev = NULL;
5239 return ret;
5240 }
5241 }
5242 }
5243
5244 dev_set_uevent_suppress(&wq_dev->dev, false);
5245 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5246 return 0;
5247}
5248
5249/**
5250 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5251 * @wq: the workqueue to unregister
5252 *
5253 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5254 */
5255static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5256{
5257 struct wq_device *wq_dev = wq->wq_dev;
5258
5259 if (!wq->wq_dev)
5260 return;
5261
5262 wq->wq_dev = NULL;
5263 device_unregister(&wq_dev->dev);
5264}
5265#else /* CONFIG_SYSFS */
5266static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5267#endif /* CONFIG_SYSFS */
5268
Tejun Heo82607adc2015-12-08 11:28:04 -05005269/*
5270 * Workqueue watchdog.
5271 *
5272 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5273 * flush dependency, a concurrency managed work item which stays RUNNING
5274 * indefinitely. Workqueue stalls can be very difficult to debug as the
5275 * usual warning mechanisms don't trigger and internal workqueue state is
5276 * largely opaque.
5277 *
5278 * Workqueue watchdog monitors all worker pools periodically and dumps
5279 * state if some pools failed to make forward progress for a while where
5280 * forward progress is defined as the first item on ->worklist changing.
5281 *
5282 * This mechanism is controlled through the kernel parameter
5283 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5284 * corresponding sysfs parameter file.
5285 */
5286#ifdef CONFIG_WQ_WATCHDOG
5287
5288static void wq_watchdog_timer_fn(unsigned long data);
5289
5290static unsigned long wq_watchdog_thresh = 30;
5291static struct timer_list wq_watchdog_timer =
5292 TIMER_DEFERRED_INITIALIZER(wq_watchdog_timer_fn, 0, 0);
5293
5294static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5295static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5296
5297static void wq_watchdog_reset_touched(void)
5298{
5299 int cpu;
5300
5301 wq_watchdog_touched = jiffies;
5302 for_each_possible_cpu(cpu)
5303 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5304}
5305
5306static void wq_watchdog_timer_fn(unsigned long data)
5307{
5308 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5309 bool lockup_detected = false;
5310 struct worker_pool *pool;
5311 int pi;
5312
5313 if (!thresh)
5314 return;
5315
5316 rcu_read_lock();
5317
5318 for_each_pool(pool, pi) {
5319 unsigned long pool_ts, touched, ts;
5320
5321 if (list_empty(&pool->worklist))
5322 continue;
5323
5324 /* get the latest of pool and touched timestamps */
5325 pool_ts = READ_ONCE(pool->watchdog_ts);
5326 touched = READ_ONCE(wq_watchdog_touched);
5327
5328 if (time_after(pool_ts, touched))
5329 ts = pool_ts;
5330 else
5331 ts = touched;
5332
5333 if (pool->cpu >= 0) {
5334 unsigned long cpu_touched =
5335 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5336 pool->cpu));
5337 if (time_after(cpu_touched, ts))
5338 ts = cpu_touched;
5339 }
5340
5341 /* did we stall? */
5342 if (time_after(jiffies, ts + thresh)) {
5343 lockup_detected = true;
5344 pr_emerg("BUG: workqueue lockup - pool");
5345 pr_cont_pool_info(pool);
5346 pr_cont(" stuck for %us!\n",
5347 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5348 }
5349 }
5350
5351 rcu_read_unlock();
5352
5353 if (lockup_detected)
5354 show_workqueue_state();
5355
5356 wq_watchdog_reset_touched();
5357 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5358}
5359
5360void wq_watchdog_touch(int cpu)
5361{
5362 if (cpu >= 0)
5363 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5364 else
5365 wq_watchdog_touched = jiffies;
5366}
5367
5368static void wq_watchdog_set_thresh(unsigned long thresh)
5369{
5370 wq_watchdog_thresh = 0;
5371 del_timer_sync(&wq_watchdog_timer);
5372
5373 if (thresh) {
5374 wq_watchdog_thresh = thresh;
5375 wq_watchdog_reset_touched();
5376 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5377 }
5378}
5379
5380static int wq_watchdog_param_set_thresh(const char *val,
5381 const struct kernel_param *kp)
5382{
5383 unsigned long thresh;
5384 int ret;
5385
5386 ret = kstrtoul(val, 0, &thresh);
5387 if (ret)
5388 return ret;
5389
5390 if (system_wq)
5391 wq_watchdog_set_thresh(thresh);
5392 else
5393 wq_watchdog_thresh = thresh;
5394
5395 return 0;
5396}
5397
5398static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5399 .set = wq_watchdog_param_set_thresh,
5400 .get = param_get_ulong,
5401};
5402
5403module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5404 0644);
5405
5406static void wq_watchdog_init(void)
5407{
5408 wq_watchdog_set_thresh(wq_watchdog_thresh);
5409}
5410
5411#else /* CONFIG_WQ_WATCHDOG */
5412
5413static inline void wq_watchdog_init(void) { }
5414
5415#endif /* CONFIG_WQ_WATCHDOG */
5416
Tejun Heobce90382013-04-01 11:23:32 -07005417static void __init wq_numa_init(void)
5418{
5419 cpumask_var_t *tbl;
5420 int node, cpu;
5421
Tejun Heobce90382013-04-01 11:23:32 -07005422 if (num_possible_nodes() <= 1)
5423 return;
5424
Tejun Heod55262c2013-04-01 11:23:38 -07005425 if (wq_disable_numa) {
5426 pr_info("workqueue: NUMA affinity support disabled\n");
5427 return;
5428 }
5429
Tejun Heo4c16bd32013-04-01 11:23:36 -07005430 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5431 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5432
Tejun Heobce90382013-04-01 11:23:32 -07005433 /*
5434 * We want masks of possible CPUs of each node which isn't readily
5435 * available. Build one from cpu_to_node() which should have been
5436 * fully initialized by now.
5437 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005438 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005439 BUG_ON(!tbl);
5440
5441 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005442 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005443 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005444
5445 for_each_possible_cpu(cpu) {
5446 node = cpu_to_node(cpu);
5447 if (WARN_ON(node == NUMA_NO_NODE)) {
5448 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5449 /* happens iff arch is bonkers, let's just proceed */
5450 return;
5451 }
5452 cpumask_set_cpu(cpu, tbl[node]);
5453 }
5454
5455 wq_numa_possible_cpumask = tbl;
5456 wq_numa_enabled = true;
5457}
5458
Suresh Siddha6ee05782010-07-30 14:57:37 -07005459static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005460{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005461 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5462 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005463
Tejun Heoe904e6c2013-03-12 11:29:57 -07005464 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5465
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005466 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5467 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5468
Tejun Heoe904e6c2013-03-12 11:29:57 -07005469 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5470
Tejun Heo65758202012-07-17 12:39:26 -07005471 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07005472 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02005473
Tejun Heobce90382013-04-01 11:23:32 -07005474 wq_numa_init();
5475
Tejun Heo706026c2013-01-24 11:01:34 -08005476 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005477 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005478 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005479
Tejun Heo7a4e3442013-03-12 11:30:00 -07005480 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005481 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005482 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005483 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005484 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005485 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005486 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005487
Tejun Heo9daf9e62013-01-24 11:01:33 -08005488 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005489 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005490 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005491 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005492 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005493 }
5494
Tejun Heoe22bee72010-06-29 10:07:14 +02005495 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07005496 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005497 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02005498
Tejun Heof02ae732013-03-12 11:30:03 -07005499 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07005500 pool->flags &= ~POOL_DISASSOCIATED;
Lai Jiangshan051e1852014-07-22 13:03:02 +08005501 BUG_ON(!create_worker(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07005502 }
Tejun Heoe22bee72010-06-29 10:07:14 +02005503 }
5504
Tejun Heo8a2b7532013-09-05 12:30:04 -04005505 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005506 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5507 struct workqueue_attrs *attrs;
5508
5509 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005510 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005511 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005512
5513 /*
5514 * An ordered wq should have only one pwq as ordering is
5515 * guaranteed by max_active which is enforced by pwqs.
5516 * Turn off NUMA so that dfl_pwq is used for all nodes.
5517 */
5518 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5519 attrs->nice = std_nice[i];
5520 attrs->no_numa = true;
5521 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005522 }
5523
Tejun Heod320c032010-06-29 10:07:14 +02005524 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005525 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005526 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005527 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5528 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005529 system_freezable_wq = alloc_workqueue("events_freezable",
5530 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305531 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5532 WQ_POWER_EFFICIENT, 0);
5533 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5534 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5535 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005536 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305537 !system_unbound_wq || !system_freezable_wq ||
5538 !system_power_efficient_wq ||
5539 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005540
5541 wq_watchdog_init();
5542
Suresh Siddha6ee05782010-07-30 14:57:37 -07005543 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005544}
Suresh Siddha6ee05782010-07-30 14:57:37 -07005545early_initcall(init_workqueues);