blob: b1c222270e0e360a83504edebc7b611b81823389 [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
151 struct list_head worklist; /* L: list of pending works */
152 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700153
154 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700155 int nr_idle; /* L: currently idle ones */
156
157 struct list_head idle_list; /* X: list of idle workers */
158 struct timer_list idle_timer; /* L: worker idle timeout */
159 struct timer_list mayday_timer; /* L: SOS timer for workers */
160
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700161 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800162 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
163 /* L: hash of busy workers */
164
Tejun Heobc3a1af2013-03-13 19:47:39 -0700165 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo34a06bd2013-03-12 11:30:00 -0700166 struct mutex manager_arb; /* manager arbitration */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400167 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800168 struct mutex attach_mutex; /* attach/detach exclusion */
169 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800170 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800171
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800172 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800173
Tejun Heo7a4e3442013-03-12 11:30:00 -0700174 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700175 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
176 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700177
Tejun Heoe19e3972013-01-24 11:39:44 -0800178 /*
179 * The current concurrency level. As it's likely to be accessed
180 * from other CPUs during try_to_wake_up(), put it in a separate
181 * cacheline.
182 */
183 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700184
185 /*
186 * Destruction of pool is sched-RCU protected to allow dereferences
187 * from get_work_pool().
188 */
189 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200190} ____cacheline_aligned_in_smp;
191
192/*
Tejun Heo112202d2013-02-13 19:29:12 -0800193 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
194 * of work_struct->data are used for flags and the remaining high bits
195 * point to the pwq; thus, pwqs need to be aligned at two's power of the
196 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 */
Tejun Heo112202d2013-02-13 19:29:12 -0800198struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700199 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200200 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200201 int work_color; /* L: current color */
202 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700203 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200204 int nr_in_flight[WORK_NR_COLORS];
205 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200206 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200207 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200208 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700209 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700210 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700211
212 /*
213 * Release of unbound pwq is punted to system_wq. See put_pwq()
214 * and pwq_unbound_release_workfn() for details. pool_workqueue
215 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700216 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700217 */
218 struct work_struct unbound_release_work;
219 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700220} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200223 * Structure used to wait for workqueue flush.
224 */
225struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700226 struct list_head list; /* WQ: list of flushers */
227 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200228 struct completion done; /* flush completion */
229};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Tejun Heo226223a2013-03-12 11:30:05 -0700231struct wq_device;
232
Tejun Heo73f53c42010-06-29 10:07:11 +0200233/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700234 * The externally visible workqueue. It relays the issued work items to
235 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 */
237struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700238 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400239 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200240
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700241 struct mutex mutex; /* protects this wq */
242 int work_color; /* WQ: current work color */
243 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800244 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700245 struct wq_flusher *first_flusher; /* WQ: first flusher */
246 struct list_head flusher_queue; /* WQ: flush waiters */
247 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200248
Tejun Heo2e109a22013-03-13 19:47:40 -0700249 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200250 struct worker *rescuer; /* I: rescue worker */
251
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700252 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700253 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700254
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800255 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
256 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700257
Tejun Heo226223a2013-03-12 11:30:05 -0700258#ifdef CONFIG_SYSFS
259 struct wq_device *wq_dev; /* I: for sysfs interface */
260#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700261#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200262 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700263#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700264 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700265
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400266 /*
267 * Destruction of workqueue_struct is sched-RCU protected to allow
268 * walking the workqueues list without grabbing wq_pool_mutex.
269 * This is used to dump all workqueues from sysrq.
270 */
271 struct rcu_head rcu;
272
Tejun Heo2728fd22013-04-01 11:23:35 -0700273 /* hot fields used during command issue, aligned to cacheline */
274 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
275 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800276 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277};
278
Tejun Heoe904e6c2013-03-12 11:29:57 -0700279static struct kmem_cache *pwq_cache;
280
Tejun Heobce90382013-04-01 11:23:32 -0700281static cpumask_var_t *wq_numa_possible_cpumask;
282 /* possible CPUs of each node */
283
Tejun Heod55262c2013-04-01 11:23:38 -0700284static bool wq_disable_numa;
285module_param_named(disable_numa, wq_disable_numa, bool, 0444);
286
Viresh Kumarcee22a12013-04-08 16:45:40 +0530287/* see the comment above the definition of WQ_POWER_EFFICIENT */
288#ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT
289static bool wq_power_efficient = true;
290#else
291static bool wq_power_efficient;
292#endif
293
294module_param_named(power_efficient, wq_power_efficient, bool, 0444);
295
Tejun Heobce90382013-04-01 11:23:32 -0700296static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
297
Tejun Heo4c16bd32013-04-01 11:23:36 -0700298/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
299static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
300
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700301static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700302static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo5bcab332013-03-13 19:47:40 -0700303
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400304static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700305static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700306
Lai Jiangshan042f7df2015-04-30 17:16:12 +0800307static cpumask_var_t wq_unbound_cpumask; /* PL: low level cpumask for all unbound wqs */
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800308
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700309/* the per-cpu worker pools */
310static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
311 cpu_worker_pools);
312
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700313static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700314
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700315/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700316static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
317
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700318/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700319static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
320
Tejun Heo8a2b7532013-09-05 12:30:04 -0400321/* I: attributes used when instantiating ordered pools on demand */
322static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
323
Tejun Heod320c032010-06-29 10:07:14 +0200324struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400325EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300326struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900327EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300328struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200329EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300330struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200331EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300332struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100333EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530334struct workqueue_struct *system_power_efficient_wq __read_mostly;
335EXPORT_SYMBOL_GPL(system_power_efficient_wq);
336struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
337EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200338
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700339static int worker_thread(void *__worker);
340static void copy_workqueue_attrs(struct workqueue_attrs *to,
341 const struct workqueue_attrs *from);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800342static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700343
Tejun Heo97bd2342010-10-05 10:41:14 +0200344#define CREATE_TRACE_POINTS
345#include <trace/events/workqueue.h>
346
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700347#define assert_rcu_or_pool_mutex() \
Tejun Heo5bcab332013-03-13 19:47:40 -0700348 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700349 lockdep_is_held(&wq_pool_mutex), \
350 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700351
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700352#define assert_rcu_or_wq_mutex(wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700353 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshanb5927602013-03-25 16:57:19 -0700354 lockdep_is_held(&wq->mutex), \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700355 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700356
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800357#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
358 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
359 lockdep_is_held(&wq->mutex) || \
360 lockdep_is_held(&wq_pool_mutex), \
361 "sched RCU, wq->mutex or wq_pool_mutex should be held")
362
Tejun Heof02ae732013-03-12 11:30:03 -0700363#define for_each_cpu_worker_pool(pool, cpu) \
364 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
365 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700366 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700367
Tejun Heo49e3cf42013-03-12 11:29:58 -0700368/**
Tejun Heo17116962013-03-12 11:29:58 -0700369 * for_each_pool - iterate through all worker_pools in the system
370 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700371 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700372 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700373 * This must be called either with wq_pool_mutex held or sched RCU read
374 * locked. If the pool needs to be used beyond the locking in effect, the
375 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700376 *
377 * The if/else clause exists only for the lockdep assertion and can be
378 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700379 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700380#define for_each_pool(pool, pi) \
381 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700382 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700383 else
Tejun Heo17116962013-03-12 11:29:58 -0700384
385/**
Tejun Heo822d8402013-03-19 13:45:21 -0700386 * for_each_pool_worker - iterate through all workers of a worker_pool
387 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700388 * @pool: worker_pool to iterate workers of
389 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800390 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700391 *
392 * The if/else clause exists only for the lockdep assertion and can be
393 * ignored.
394 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800395#define for_each_pool_worker(worker, pool) \
396 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800397 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700398 else
399
400/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700401 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
402 * @pwq: iteration cursor
403 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700404 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700405 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700406 * If the pwq needs to be used beyond the locking in effect, the caller is
407 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700408 *
409 * The if/else clause exists only for the lockdep assertion and can be
410 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700411 */
412#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700413 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700414 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700415 else
Tejun Heof3421792010-07-02 10:03:51 +0200416
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900417#ifdef CONFIG_DEBUG_OBJECTS_WORK
418
419static struct debug_obj_descr work_debug_descr;
420
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100421static void *work_debug_hint(void *addr)
422{
423 return ((struct work_struct *) addr)->func;
424}
425
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900426/*
427 * fixup_init is called when:
428 * - an active object is initialized
429 */
430static int work_fixup_init(void *addr, enum debug_obj_state state)
431{
432 struct work_struct *work = addr;
433
434 switch (state) {
435 case ODEBUG_STATE_ACTIVE:
436 cancel_work_sync(work);
437 debug_object_init(work, &work_debug_descr);
438 return 1;
439 default:
440 return 0;
441 }
442}
443
444/*
445 * fixup_activate is called when:
446 * - an active object is activated
447 * - an unknown object is activated (might be a statically initialized object)
448 */
449static int work_fixup_activate(void *addr, enum debug_obj_state state)
450{
451 struct work_struct *work = addr;
452
453 switch (state) {
454
455 case ODEBUG_STATE_NOTAVAILABLE:
456 /*
457 * This is not really a fixup. The work struct was
458 * statically initialized. We just make sure that it
459 * is tracked in the object tracker.
460 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200461 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900462 debug_object_init(work, &work_debug_descr);
463 debug_object_activate(work, &work_debug_descr);
464 return 0;
465 }
466 WARN_ON_ONCE(1);
467 return 0;
468
469 case ODEBUG_STATE_ACTIVE:
470 WARN_ON(1);
471
472 default:
473 return 0;
474 }
475}
476
477/*
478 * fixup_free is called when:
479 * - an active object is freed
480 */
481static int work_fixup_free(void *addr, enum debug_obj_state state)
482{
483 struct work_struct *work = addr;
484
485 switch (state) {
486 case ODEBUG_STATE_ACTIVE:
487 cancel_work_sync(work);
488 debug_object_free(work, &work_debug_descr);
489 return 1;
490 default:
491 return 0;
492 }
493}
494
495static struct debug_obj_descr work_debug_descr = {
496 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100497 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900498 .fixup_init = work_fixup_init,
499 .fixup_activate = work_fixup_activate,
500 .fixup_free = work_fixup_free,
501};
502
503static inline void debug_work_activate(struct work_struct *work)
504{
505 debug_object_activate(work, &work_debug_descr);
506}
507
508static inline void debug_work_deactivate(struct work_struct *work)
509{
510 debug_object_deactivate(work, &work_debug_descr);
511}
512
513void __init_work(struct work_struct *work, int onstack)
514{
515 if (onstack)
516 debug_object_init_on_stack(work, &work_debug_descr);
517 else
518 debug_object_init(work, &work_debug_descr);
519}
520EXPORT_SYMBOL_GPL(__init_work);
521
522void destroy_work_on_stack(struct work_struct *work)
523{
524 debug_object_free(work, &work_debug_descr);
525}
526EXPORT_SYMBOL_GPL(destroy_work_on_stack);
527
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000528void destroy_delayed_work_on_stack(struct delayed_work *work)
529{
530 destroy_timer_on_stack(&work->timer);
531 debug_object_free(&work->work, &work_debug_descr);
532}
533EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
534
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900535#else
536static inline void debug_work_activate(struct work_struct *work) { }
537static inline void debug_work_deactivate(struct work_struct *work) { }
538#endif
539
Li Bin4e8b22b2013-09-10 09:52:35 +0800540/**
541 * worker_pool_assign_id - allocate ID and assing it to @pool
542 * @pool: the pool pointer of interest
543 *
544 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
545 * successfully, -errno on failure.
546 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800547static int worker_pool_assign_id(struct worker_pool *pool)
548{
549 int ret;
550
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700551 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700552
Li Bin4e8b22b2013-09-10 09:52:35 +0800553 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
554 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700555 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700556 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700557 return 0;
558 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800559 return ret;
560}
561
Tejun Heo76af4d92013-03-12 11:30:00 -0700562/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700563 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
564 * @wq: the target workqueue
565 * @node: the node ID
566 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800567 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
568 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700569 * If the pwq needs to be used beyond the locking in effect, the caller is
570 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700571 *
572 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700573 */
574static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
575 int node)
576{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800577 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700578 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
579}
580
Tejun Heo73f53c42010-06-29 10:07:11 +0200581static unsigned int work_color_to_flags(int color)
582{
583 return color << WORK_STRUCT_COLOR_SHIFT;
584}
585
586static int get_work_color(struct work_struct *work)
587{
588 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
589 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
590}
591
592static int work_next_color(int color)
593{
594 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700595}
596
David Howells4594bf12006-12-07 11:33:26 +0000597/*
Tejun Heo112202d2013-02-13 19:29:12 -0800598 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
599 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800600 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200601 *
Tejun Heo112202d2013-02-13 19:29:12 -0800602 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
603 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700604 * work->data. These functions should only be called while the work is
605 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200606 *
Tejun Heo112202d2013-02-13 19:29:12 -0800607 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800608 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800609 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800610 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700611 *
612 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
613 * canceled. While being canceled, a work item may have its PENDING set
614 * but stay off timer and worklist for arbitrarily long and nobody should
615 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000616 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200617static inline void set_work_data(struct work_struct *work, unsigned long data,
618 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000619{
Tejun Heo6183c002013-03-12 11:29:57 -0700620 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200621 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000622}
David Howells365970a2006-11-22 14:54:49 +0000623
Tejun Heo112202d2013-02-13 19:29:12 -0800624static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200625 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200626{
Tejun Heo112202d2013-02-13 19:29:12 -0800627 set_work_data(work, (unsigned long)pwq,
628 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200629}
630
Lai Jiangshan4468a002013-02-06 18:04:53 -0800631static void set_work_pool_and_keep_pending(struct work_struct *work,
632 int pool_id)
633{
634 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
635 WORK_STRUCT_PENDING);
636}
637
Tejun Heo7c3eed52013-01-24 11:01:33 -0800638static void set_work_pool_and_clear_pending(struct work_struct *work,
639 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000640{
Tejun Heo23657bb2012-08-13 17:08:19 -0700641 /*
642 * The following wmb is paired with the implied mb in
643 * test_and_set_bit(PENDING) and ensures all updates to @work made
644 * here are visible to and precede any updates by the next PENDING
645 * owner.
646 */
647 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800648 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200649}
650
651static void clear_work_data(struct work_struct *work)
652{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800653 smp_wmb(); /* see set_work_pool_and_clear_pending() */
654 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200655}
656
Tejun Heo112202d2013-02-13 19:29:12 -0800657static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200658{
Tejun Heoe1201532010-07-22 14:14:25 +0200659 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200660
Tejun Heo112202d2013-02-13 19:29:12 -0800661 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200662 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
663 else
664 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200665}
666
Tejun Heo7c3eed52013-01-24 11:01:33 -0800667/**
668 * get_work_pool - return the worker_pool a given work was associated with
669 * @work: the work item of interest
670 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700671 * Pools are created and destroyed under wq_pool_mutex, and allows read
672 * access under sched-RCU read lock. As such, this function should be
673 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700674 *
675 * All fields of the returned pool are accessible as long as the above
676 * mentioned locking is in effect. If the returned pool needs to be used
677 * beyond the critical section, the caller is responsible for ensuring the
678 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700679 *
680 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800681 */
682static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200683{
Tejun Heoe1201532010-07-22 14:14:25 +0200684 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800685 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200686
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700687 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700688
Tejun Heo112202d2013-02-13 19:29:12 -0800689 if (data & WORK_STRUCT_PWQ)
690 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800691 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200692
Tejun Heo7c3eed52013-01-24 11:01:33 -0800693 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
694 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200695 return NULL;
696
Tejun Heofa1b54e2013-03-12 11:30:00 -0700697 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800698}
699
700/**
701 * get_work_pool_id - return the worker pool ID a given work is associated with
702 * @work: the work item of interest
703 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700704 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800705 * %WORK_OFFQ_POOL_NONE if none.
706 */
707static int get_work_pool_id(struct work_struct *work)
708{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800709 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800710
Tejun Heo112202d2013-02-13 19:29:12 -0800711 if (data & WORK_STRUCT_PWQ)
712 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800713 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
714
715 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800716}
717
Tejun Heobbb68df2012-08-03 10:30:46 -0700718static void mark_work_canceling(struct work_struct *work)
719{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800720 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700721
Tejun Heo7c3eed52013-01-24 11:01:33 -0800722 pool_id <<= WORK_OFFQ_POOL_SHIFT;
723 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700724}
725
726static bool work_is_canceling(struct work_struct *work)
727{
728 unsigned long data = atomic_long_read(&work->data);
729
Tejun Heo112202d2013-02-13 19:29:12 -0800730 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700731}
732
David Howells365970a2006-11-22 14:54:49 +0000733/*
Tejun Heo32704762012-07-13 22:16:45 -0700734 * Policy functions. These define the policies on how the global worker
735 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800736 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000737 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200738
Tejun Heo63d95a92012-07-12 14:46:37 -0700739static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000740{
Tejun Heoe19e3972013-01-24 11:39:44 -0800741 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000742}
743
Tejun Heoe22bee72010-06-29 10:07:14 +0200744/*
745 * Need to wake up a worker? Called from anything but currently
746 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700747 *
748 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800749 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700750 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200751 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700752static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000753{
Tejun Heo63d95a92012-07-12 14:46:37 -0700754 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000755}
756
Tejun Heoe22bee72010-06-29 10:07:14 +0200757/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700758static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200759{
Tejun Heo63d95a92012-07-12 14:46:37 -0700760 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200761}
762
763/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700764static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200765{
Tejun Heoe19e3972013-01-24 11:39:44 -0800766 return !list_empty(&pool->worklist) &&
767 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200768}
769
770/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700771static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200772{
Tejun Heo63d95a92012-07-12 14:46:37 -0700773 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200774}
775
Tejun Heoe22bee72010-06-29 10:07:14 +0200776/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700777static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200778{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700779 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700780 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
781 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200782
783 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
784}
785
786/*
787 * Wake up functions.
788 */
789
Lai Jiangshan1037de32014-05-22 16:44:07 +0800790/* Return the first idle worker. Safe with preemption disabled */
791static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200792{
Tejun Heo63d95a92012-07-12 14:46:37 -0700793 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200794 return NULL;
795
Tejun Heo63d95a92012-07-12 14:46:37 -0700796 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200797}
798
799/**
800 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700801 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200802 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700803 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200804 *
805 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800806 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200807 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700808static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200809{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800810 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200811
812 if (likely(worker))
813 wake_up_process(worker->task);
814}
815
Tejun Heo4690c4a2010-06-29 10:07:10 +0200816/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200817 * wq_worker_waking_up - a worker is waking up
818 * @task: task waking up
819 * @cpu: CPU @task is waking up to
820 *
821 * This function is called during try_to_wake_up() when a worker is
822 * being awoken.
823 *
824 * CONTEXT:
825 * spin_lock_irq(rq->lock)
826 */
Tejun Heod84ff052013-03-12 11:29:59 -0700827void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200828{
829 struct worker *worker = kthread_data(task);
830
Joonsoo Kim36576002012-10-26 23:03:49 +0900831 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800832 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800833 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900834 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200835}
836
837/**
838 * wq_worker_sleeping - a worker is going to sleep
839 * @task: task going to sleep
840 * @cpu: CPU in question, must be the current CPU number
841 *
842 * This function is called during schedule() when a busy worker is
843 * going to sleep. Worker on the same cpu can be woken up by
844 * returning pointer to its task.
845 *
846 * CONTEXT:
847 * spin_lock_irq(rq->lock)
848 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700849 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200850 * Worker task on @cpu to wake up, %NULL if none.
851 */
Tejun Heod84ff052013-03-12 11:29:59 -0700852struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200853{
854 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800855 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200856
Tejun Heo111c2252013-01-17 17:16:24 -0800857 /*
858 * Rescuers, which may not have all the fields set up like normal
859 * workers, also reach here, let's not access anything before
860 * checking NOT_RUNNING.
861 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500862 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200863 return NULL;
864
Tejun Heo111c2252013-01-17 17:16:24 -0800865 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800866
Tejun Heoe22bee72010-06-29 10:07:14 +0200867 /* this can only happen on the local cpu */
Lai Jiangshan92b69f52014-06-03 15:33:08 +0800868 if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu))
Tejun Heo6183c002013-03-12 11:29:57 -0700869 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200870
871 /*
872 * The counterpart of the following dec_and_test, implied mb,
873 * worklist not empty test sequence is in insert_work().
874 * Please read comment there.
875 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700876 * NOT_RUNNING is clear. This means that we're bound to and
877 * running on the local cpu w/ rq lock held and preemption
878 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800879 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700880 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200881 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800882 if (atomic_dec_and_test(&pool->nr_running) &&
883 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800884 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200885 return to_wakeup ? to_wakeup->task : NULL;
886}
887
888/**
889 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200890 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200891 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200892 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800893 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200894 *
Tejun Heocb444762010-07-02 10:03:50 +0200895 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800896 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200897 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800898static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200899{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700900 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200901
Tejun Heocb444762010-07-02 10:03:50 +0200902 WARN_ON_ONCE(worker->task != current);
903
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800904 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200905 if ((flags & WORKER_NOT_RUNNING) &&
906 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800907 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200908 }
909
Tejun Heod302f012010-06-29 10:07:13 +0200910 worker->flags |= flags;
911}
912
913/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200914 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200915 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200916 * @flags: flags to clear
917 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200918 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200919 *
Tejun Heocb444762010-07-02 10:03:50 +0200920 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800921 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200922 */
923static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
924{
Tejun Heo63d95a92012-07-12 14:46:37 -0700925 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200926 unsigned int oflags = worker->flags;
927
Tejun Heocb444762010-07-02 10:03:50 +0200928 WARN_ON_ONCE(worker->task != current);
929
Tejun Heod302f012010-06-29 10:07:13 +0200930 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200931
Tejun Heo42c025f2011-01-11 15:58:49 +0100932 /*
933 * If transitioning out of NOT_RUNNING, increment nr_running. Note
934 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
935 * of multiple flags, not a single flag.
936 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200937 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
938 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800939 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200940}
941
942/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200943 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800944 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200945 * @work: work to find worker for
946 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800947 * Find a worker which is executing @work on @pool by searching
948 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800949 * to match, its current execution should match the address of @work and
950 * its work function. This is to avoid unwanted dependency between
951 * unrelated work executions through a work item being recycled while still
952 * being executed.
953 *
954 * This is a bit tricky. A work item may be freed once its execution
955 * starts and nothing prevents the freed area from being recycled for
956 * another work item. If the same work item address ends up being reused
957 * before the original execution finishes, workqueue will identify the
958 * recycled work item as currently executing and make it wait until the
959 * current execution finishes, introducing an unwanted dependency.
960 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700961 * This function checks the work item address and work function to avoid
962 * false positives. Note that this isn't complete as one may construct a
963 * work function which can introduce dependency onto itself through a
964 * recycled work item. Well, if somebody wants to shoot oneself in the
965 * foot that badly, there's only so much we can do, and if such deadlock
966 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200967 *
968 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800969 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200970 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700971 * Return:
972 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200973 * otherwise.
974 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800975static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200976 struct work_struct *work)
977{
Sasha Levin42f85702012-12-17 10:01:23 -0500978 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500979
Sasha Levinb67bfe02013-02-27 17:06:00 -0800980 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800981 (unsigned long)work)
982 if (worker->current_work == work &&
983 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500984 return worker;
985
986 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200987}
988
989/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700990 * move_linked_works - move linked works to a list
991 * @work: start of series of works to be scheduled
992 * @head: target list to append @work to
993 * @nextp: out paramter for nested worklist walking
994 *
995 * Schedule linked works starting from @work to @head. Work series to
996 * be scheduled starts at @work and includes any consecutive work with
997 * WORK_STRUCT_LINKED set in its predecessor.
998 *
999 * If @nextp is not NULL, it's updated to point to the next work of
1000 * the last scheduled work. This allows move_linked_works() to be
1001 * nested inside outer list_for_each_entry_safe().
1002 *
1003 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001004 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001005 */
1006static void move_linked_works(struct work_struct *work, struct list_head *head,
1007 struct work_struct **nextp)
1008{
1009 struct work_struct *n;
1010
1011 /*
1012 * Linked worklist will always end before the end of the list,
1013 * use NULL for list head.
1014 */
1015 list_for_each_entry_safe_from(work, n, NULL, entry) {
1016 list_move_tail(&work->entry, head);
1017 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1018 break;
1019 }
1020
1021 /*
1022 * If we're already inside safe list traversal and have moved
1023 * multiple works to the scheduled queue, the next position
1024 * needs to be updated.
1025 */
1026 if (nextp)
1027 *nextp = n;
1028}
1029
Tejun Heo8864b4e2013-03-12 11:30:04 -07001030/**
1031 * get_pwq - get an extra reference on the specified pool_workqueue
1032 * @pwq: pool_workqueue to get
1033 *
1034 * Obtain an extra reference on @pwq. The caller should guarantee that
1035 * @pwq has positive refcnt and be holding the matching pool->lock.
1036 */
1037static void get_pwq(struct pool_workqueue *pwq)
1038{
1039 lockdep_assert_held(&pwq->pool->lock);
1040 WARN_ON_ONCE(pwq->refcnt <= 0);
1041 pwq->refcnt++;
1042}
1043
1044/**
1045 * put_pwq - put a pool_workqueue reference
1046 * @pwq: pool_workqueue to put
1047 *
1048 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1049 * destruction. The caller should be holding the matching pool->lock.
1050 */
1051static void put_pwq(struct pool_workqueue *pwq)
1052{
1053 lockdep_assert_held(&pwq->pool->lock);
1054 if (likely(--pwq->refcnt))
1055 return;
1056 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1057 return;
1058 /*
1059 * @pwq can't be released under pool->lock, bounce to
1060 * pwq_unbound_release_workfn(). This never recurses on the same
1061 * pool->lock as this path is taken only for unbound workqueues and
1062 * the release work item is scheduled on a per-cpu workqueue. To
1063 * avoid lockdep warning, unbound pool->locks are given lockdep
1064 * subclass of 1 in get_unbound_pool().
1065 */
1066 schedule_work(&pwq->unbound_release_work);
1067}
1068
Tejun Heodce90d42013-04-01 11:23:35 -07001069/**
1070 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1071 * @pwq: pool_workqueue to put (can be %NULL)
1072 *
1073 * put_pwq() with locking. This function also allows %NULL @pwq.
1074 */
1075static void put_pwq_unlocked(struct pool_workqueue *pwq)
1076{
1077 if (pwq) {
1078 /*
1079 * As both pwqs and pools are sched-RCU protected, the
1080 * following lock operations are safe.
1081 */
1082 spin_lock_irq(&pwq->pool->lock);
1083 put_pwq(pwq);
1084 spin_unlock_irq(&pwq->pool->lock);
1085 }
1086}
1087
Tejun Heo112202d2013-02-13 19:29:12 -08001088static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001089{
Tejun Heo112202d2013-02-13 19:29:12 -08001090 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001091
1092 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001093 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001094 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001095 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001096}
1097
Tejun Heo112202d2013-02-13 19:29:12 -08001098static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001099{
Tejun Heo112202d2013-02-13 19:29:12 -08001100 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001101 struct work_struct, entry);
1102
Tejun Heo112202d2013-02-13 19:29:12 -08001103 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001104}
1105
Tejun Heobf4ede02012-08-03 10:30:46 -07001106/**
Tejun Heo112202d2013-02-13 19:29:12 -08001107 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1108 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001109 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001110 *
1111 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001112 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001113 *
1114 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001115 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001116 */
Tejun Heo112202d2013-02-13 19:29:12 -08001117static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001118{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001119 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001120 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001121 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001122
Tejun Heo112202d2013-02-13 19:29:12 -08001123 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001124
Tejun Heo112202d2013-02-13 19:29:12 -08001125 pwq->nr_active--;
1126 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001127 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001128 if (pwq->nr_active < pwq->max_active)
1129 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001130 }
1131
1132 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001133 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001134 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001135
1136 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001137 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001138 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001139
Tejun Heo112202d2013-02-13 19:29:12 -08001140 /* this pwq is done, clear flush_color */
1141 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001142
1143 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001144 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001145 * will handle the rest.
1146 */
Tejun Heo112202d2013-02-13 19:29:12 -08001147 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1148 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001149out_put:
1150 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001151}
1152
Tejun Heo36e227d2012-08-03 10:30:46 -07001153/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001154 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001155 * @work: work item to steal
1156 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001157 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001158 *
1159 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001160 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001161 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001162 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001163 * 1 if @work was pending and we successfully stole PENDING
1164 * 0 if @work was idle and we claimed PENDING
1165 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001166 * -ENOENT if someone else is canceling @work, this state may persist
1167 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001168 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001169 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001170 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001171 * interrupted while holding PENDING and @work off queue, irq must be
1172 * disabled on entry. This, combined with delayed_work->timer being
1173 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001174 *
1175 * On successful return, >= 0, irq is disabled and the caller is
1176 * responsible for releasing it using local_irq_restore(*@flags).
1177 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001178 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001179 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001180static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1181 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001182{
Tejun Heod565ed62013-01-24 11:01:33 -08001183 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001184 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001185
Tejun Heobbb68df2012-08-03 10:30:46 -07001186 local_irq_save(*flags);
1187
Tejun Heo36e227d2012-08-03 10:30:46 -07001188 /* try to steal the timer if it exists */
1189 if (is_dwork) {
1190 struct delayed_work *dwork = to_delayed_work(work);
1191
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001192 /*
1193 * dwork->timer is irqsafe. If del_timer() fails, it's
1194 * guaranteed that the timer is not queued anywhere and not
1195 * running on the local CPU.
1196 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001197 if (likely(del_timer(&dwork->timer)))
1198 return 1;
1199 }
1200
1201 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001202 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1203 return 0;
1204
1205 /*
1206 * The queueing is in progress, or it is already queued. Try to
1207 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1208 */
Tejun Heod565ed62013-01-24 11:01:33 -08001209 pool = get_work_pool(work);
1210 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001211 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001212
Tejun Heod565ed62013-01-24 11:01:33 -08001213 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001214 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001215 * work->data is guaranteed to point to pwq only while the work
1216 * item is queued on pwq->wq, and both updating work->data to point
1217 * to pwq on queueing and to pool on dequeueing are done under
1218 * pwq->pool->lock. This in turn guarantees that, if work->data
1219 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001220 * item is currently queued on that pool.
1221 */
Tejun Heo112202d2013-02-13 19:29:12 -08001222 pwq = get_work_pwq(work);
1223 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001224 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001225
Tejun Heo16062832013-02-06 18:04:53 -08001226 /*
1227 * A delayed work item cannot be grabbed directly because
1228 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001229 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001230 * management later on and cause stall. Make sure the work
1231 * item is activated before grabbing.
1232 */
1233 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001234 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001235
Tejun Heo16062832013-02-06 18:04:53 -08001236 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001237 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001238
Tejun Heo112202d2013-02-13 19:29:12 -08001239 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001240 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001241
Tejun Heo16062832013-02-06 18:04:53 -08001242 spin_unlock(&pool->lock);
1243 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001244 }
Tejun Heod565ed62013-01-24 11:01:33 -08001245 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001246fail:
1247 local_irq_restore(*flags);
1248 if (work_is_canceling(work))
1249 return -ENOENT;
1250 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001251 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001252}
1253
1254/**
Tejun Heo706026c2013-01-24 11:01:34 -08001255 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001256 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001257 * @work: work to insert
1258 * @head: insertion point
1259 * @extra_flags: extra WORK_STRUCT_* flags to set
1260 *
Tejun Heo112202d2013-02-13 19:29:12 -08001261 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001262 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001263 *
1264 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001265 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001266 */
Tejun Heo112202d2013-02-13 19:29:12 -08001267static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1268 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001269{
Tejun Heo112202d2013-02-13 19:29:12 -08001270 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001271
Tejun Heo4690c4a2010-06-29 10:07:10 +02001272 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001273 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001274 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001275 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001276
1277 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001278 * Ensure either wq_worker_sleeping() sees the above
1279 * list_add_tail() or we see zero nr_running to avoid workers lying
1280 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001281 */
1282 smp_mb();
1283
Tejun Heo63d95a92012-07-12 14:46:37 -07001284 if (__need_more_worker(pool))
1285 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001286}
1287
Tejun Heoc8efcc22010-12-20 19:32:04 +01001288/*
1289 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001290 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001291 */
1292static bool is_chained_work(struct workqueue_struct *wq)
1293{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001294 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001295
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001296 worker = current_wq_worker();
1297 /*
1298 * Return %true iff I'm a worker execuing a work item on @wq. If
1299 * I'm @worker, it's safe to dereference it without locking.
1300 */
Tejun Heo112202d2013-02-13 19:29:12 -08001301 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001302}
1303
Tejun Heod84ff052013-03-12 11:29:59 -07001304static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 struct work_struct *work)
1306{
Tejun Heo112202d2013-02-13 19:29:12 -08001307 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001308 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001309 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001310 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001311 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001312
1313 /*
1314 * While a work item is PENDING && off queue, a task trying to
1315 * steal the PENDING will busy-loop waiting for it to either get
1316 * queued or lose PENDING. Grabbing PENDING and queueing should
1317 * happen with IRQ disabled.
1318 */
1319 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001321 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001322
Li Bin9ef28a72013-09-09 13:13:58 +08001323 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001324 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001325 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001326 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001327retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001328 if (req_cpu == WORK_CPU_UNBOUND)
1329 cpu = raw_smp_processor_id();
1330
Tejun Heoc9178082013-03-12 11:30:04 -07001331 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001332 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001333 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001334 else
1335 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001336
Tejun Heoc9178082013-03-12 11:30:04 -07001337 /*
1338 * If @work was previously on a different pool, it might still be
1339 * running there, in which case the work needs to be queued on that
1340 * pool to guarantee non-reentrancy.
1341 */
1342 last_pool = get_work_pool(work);
1343 if (last_pool && last_pool != pwq->pool) {
1344 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001345
Tejun Heoc9178082013-03-12 11:30:04 -07001346 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001347
Tejun Heoc9178082013-03-12 11:30:04 -07001348 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001349
Tejun Heoc9178082013-03-12 11:30:04 -07001350 if (worker && worker->current_pwq->wq == wq) {
1351 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001352 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001353 /* meh... not running there, queue here */
1354 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001355 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001356 }
Tejun Heof3421792010-07-02 10:03:51 +02001357 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001358 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001359 }
1360
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001361 /*
1362 * pwq is determined and locked. For unbound pools, we could have
1363 * raced with pwq release and it could already be dead. If its
1364 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001365 * without another pwq replacing it in the numa_pwq_tbl or while
1366 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001367 * make forward-progress.
1368 */
1369 if (unlikely(!pwq->refcnt)) {
1370 if (wq->flags & WQ_UNBOUND) {
1371 spin_unlock(&pwq->pool->lock);
1372 cpu_relax();
1373 goto retry;
1374 }
1375 /* oops */
1376 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1377 wq->name, cpu);
1378 }
1379
Tejun Heo112202d2013-02-13 19:29:12 -08001380 /* pwq determined, queue */
1381 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001382
Dan Carpenterf5b25522012-04-13 22:06:58 +03001383 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001384 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001385 return;
1386 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001387
Tejun Heo112202d2013-02-13 19:29:12 -08001388 pwq->nr_in_flight[pwq->work_color]++;
1389 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001390
Tejun Heo112202d2013-02-13 19:29:12 -08001391 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001392 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001393 pwq->nr_active++;
1394 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001395 } else {
1396 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001397 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001398 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001399
Tejun Heo112202d2013-02-13 19:29:12 -08001400 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001401
Tejun Heo112202d2013-02-13 19:29:12 -08001402 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403}
1404
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001405/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001406 * queue_work_on - queue work on specific cpu
1407 * @cpu: CPU number to execute work on
1408 * @wq: workqueue to use
1409 * @work: work to queue
1410 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001411 * We queue the work to a specific CPU, the caller must ensure it
1412 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001413 *
1414 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001415 */
Tejun Heod4283e92012-08-03 10:30:44 -07001416bool queue_work_on(int cpu, struct workqueue_struct *wq,
1417 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001418{
Tejun Heod4283e92012-08-03 10:30:44 -07001419 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001420 unsigned long flags;
1421
1422 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001423
Tejun Heo22df02b2010-06-29 10:07:10 +02001424 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001425 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001426 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001427 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001428
1429 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001430 return ret;
1431}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001432EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001433
Tejun Heod8e794d2012-08-03 10:30:45 -07001434void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435{
David Howells52bad642006-11-22 14:54:01 +00001436 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001438 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001439 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001441EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001443static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1444 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001446 struct timer_list *timer = &dwork->timer;
1447 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001449 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1450 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001451 WARN_ON_ONCE(timer_pending(timer));
1452 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001453
Tejun Heo8852aac2012-12-01 16:23:42 -08001454 /*
1455 * If @delay is 0, queue @dwork->work immediately. This is for
1456 * both optimization and correctness. The earliest @timer can
1457 * expire is on the closest next tick and delayed_work users depend
1458 * on that there's no such delay when @delay is 0.
1459 */
1460 if (!delay) {
1461 __queue_work(cpu, wq, &dwork->work);
1462 return;
1463 }
1464
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001465 timer_stats_timer_set_start_info(&dwork->timer);
1466
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001467 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001468 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001469 timer->expires = jiffies + delay;
1470
1471 if (unlikely(cpu != WORK_CPU_UNBOUND))
1472 add_timer_on(timer, cpu);
1473 else
1474 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475}
1476
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001477/**
1478 * queue_delayed_work_on - queue work on specific CPU after delay
1479 * @cpu: CPU number to execute work on
1480 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001481 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001482 * @delay: number of jiffies to wait before queueing
1483 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001484 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001485 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1486 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001487 */
Tejun Heod4283e92012-08-03 10:30:44 -07001488bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1489 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001490{
David Howells52bad642006-11-22 14:54:01 +00001491 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001492 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001493 unsigned long flags;
1494
1495 /* read the comment in __queue_work() */
1496 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001497
Tejun Heo22df02b2010-06-29 10:07:10 +02001498 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001499 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001500 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001501 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001502
1503 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001504 return ret;
1505}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001506EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507
Tejun Heoc8e55f32010-06-29 10:07:12 +02001508/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001509 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1510 * @cpu: CPU number to execute work on
1511 * @wq: workqueue to use
1512 * @dwork: work to queue
1513 * @delay: number of jiffies to wait before queueing
1514 *
1515 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1516 * modify @dwork's timer so that it expires after @delay. If @delay is
1517 * zero, @work is guaranteed to be scheduled immediately regardless of its
1518 * current state.
1519 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001520 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001521 * pending and its timer was modified.
1522 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001523 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001524 * See try_to_grab_pending() for details.
1525 */
1526bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1527 struct delayed_work *dwork, unsigned long delay)
1528{
1529 unsigned long flags;
1530 int ret;
1531
1532 do {
1533 ret = try_to_grab_pending(&dwork->work, true, &flags);
1534 } while (unlikely(ret == -EAGAIN));
1535
1536 if (likely(ret >= 0)) {
1537 __queue_delayed_work(cpu, wq, dwork, delay);
1538 local_irq_restore(flags);
1539 }
1540
1541 /* -ENOENT from try_to_grab_pending() becomes %true */
1542 return ret;
1543}
1544EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1545
1546/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001547 * worker_enter_idle - enter idle state
1548 * @worker: worker which is entering idle state
1549 *
1550 * @worker is entering idle state. Update stats and idle timer if
1551 * necessary.
1552 *
1553 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001554 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001555 */
1556static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001558 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Tejun Heo6183c002013-03-12 11:29:57 -07001560 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1561 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1562 (worker->hentry.next || worker->hentry.pprev)))
1563 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
Lai Jiangshan051e1852014-07-22 13:03:02 +08001565 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001566 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001567 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001568 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001569
Tejun Heoc8e55f32010-06-29 10:07:12 +02001570 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001571 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001572
Tejun Heo628c78e2012-07-17 12:39:27 -07001573 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1574 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001575
Tejun Heo544ecf32012-05-14 15:04:50 -07001576 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001577 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001578 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001579 * nr_running, the warning may trigger spuriously. Check iff
1580 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001581 */
Tejun Heo24647572013-01-24 11:01:33 -08001582 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001583 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001584 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585}
1586
Tejun Heoc8e55f32010-06-29 10:07:12 +02001587/**
1588 * worker_leave_idle - leave idle state
1589 * @worker: worker which is leaving idle state
1590 *
1591 * @worker is leaving idle state. Update stats.
1592 *
1593 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001594 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001595 */
1596static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001598 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
Tejun Heo6183c002013-03-12 11:29:57 -07001600 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1601 return;
Tejun Heod302f012010-06-29 10:07:13 +02001602 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001603 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001604 list_del_init(&worker->entry);
1605}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001607static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001608{
1609 struct worker *worker;
1610
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001611 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001612 if (worker) {
1613 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001614 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001615 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001616 /* on creation a worker is in !idle && prep state */
1617 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001618 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001619 return worker;
1620}
1621
1622/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001623 * worker_attach_to_pool() - attach a worker to a pool
1624 * @worker: worker to be attached
1625 * @pool: the target pool
1626 *
1627 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1628 * cpu-binding of @worker are kept coordinated with the pool across
1629 * cpu-[un]hotplugs.
1630 */
1631static void worker_attach_to_pool(struct worker *worker,
1632 struct worker_pool *pool)
1633{
1634 mutex_lock(&pool->attach_mutex);
1635
1636 /*
1637 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1638 * online CPUs. It'll be re-applied when any of the CPUs come up.
1639 */
1640 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1641
1642 /*
1643 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1644 * stable across this function. See the comments above the
1645 * flag definition for details.
1646 */
1647 if (pool->flags & POOL_DISASSOCIATED)
1648 worker->flags |= WORKER_UNBOUND;
1649
1650 list_add_tail(&worker->node, &pool->workers);
1651
1652 mutex_unlock(&pool->attach_mutex);
1653}
1654
1655/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001656 * worker_detach_from_pool() - detach a worker from its pool
1657 * @worker: worker which is attached to its pool
1658 * @pool: the pool @worker is attached to
1659 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001660 * Undo the attaching which had been done in worker_attach_to_pool(). The
1661 * caller worker shouldn't access to the pool after detached except it has
1662 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001663 */
1664static void worker_detach_from_pool(struct worker *worker,
1665 struct worker_pool *pool)
1666{
1667 struct completion *detach_completion = NULL;
1668
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001669 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001670 list_del(&worker->node);
1671 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001672 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001673 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001674
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001675 /* clear leftover flags without pool->lock after it is detached */
1676 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1677
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001678 if (detach_completion)
1679 complete(detach_completion);
1680}
1681
1682/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001683 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001684 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001685 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001686 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001687 *
1688 * CONTEXT:
1689 * Might sleep. Does GFP_KERNEL allocations.
1690 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001691 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001692 * Pointer to the newly created worker.
1693 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001694static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001695{
Tejun Heoc34056a2010-06-29 10:07:11 +02001696 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001697 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001698 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001699
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001700 /* ID is needed to determine kthread name */
1701 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001702 if (id < 0)
1703 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001704
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001705 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001706 if (!worker)
1707 goto fail;
1708
Tejun Heobd7bdd42012-07-12 14:46:37 -07001709 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001710 worker->id = id;
1711
Tejun Heo29c91e92013-03-12 11:30:03 -07001712 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001713 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1714 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001715 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001716 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1717
Tejun Heof3f90ad2013-04-01 11:23:34 -07001718 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001719 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001720 if (IS_ERR(worker->task))
1721 goto fail;
1722
Oleg Nesterov91151222013-11-14 12:56:18 +01001723 set_user_nice(worker->task, pool->attrs->nice);
1724
1725 /* prevent userland from meddling with cpumask of workqueue workers */
1726 worker->task->flags |= PF_NO_SETAFFINITY;
1727
Lai Jiangshanda028462014-05-20 17:46:31 +08001728 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001729 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001730
Lai Jiangshan051e1852014-07-22 13:03:02 +08001731 /* start the newly created worker */
1732 spin_lock_irq(&pool->lock);
1733 worker->pool->nr_workers++;
1734 worker_enter_idle(worker);
1735 wake_up_process(worker->task);
1736 spin_unlock_irq(&pool->lock);
1737
Tejun Heoc34056a2010-06-29 10:07:11 +02001738 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001739
Tejun Heoc34056a2010-06-29 10:07:11 +02001740fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001741 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001742 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001743 kfree(worker);
1744 return NULL;
1745}
1746
1747/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001748 * destroy_worker - destroy a workqueue worker
1749 * @worker: worker to be destroyed
1750 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001751 * Destroy @worker and adjust @pool stats accordingly. The worker should
1752 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001753 *
1754 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001755 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001756 */
1757static void destroy_worker(struct worker *worker)
1758{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001759 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001760
Tejun Heocd549682013-03-13 19:47:39 -07001761 lockdep_assert_held(&pool->lock);
1762
Tejun Heoc34056a2010-06-29 10:07:11 +02001763 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001764 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001765 WARN_ON(!list_empty(&worker->scheduled)) ||
1766 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001767 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001768
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001769 pool->nr_workers--;
1770 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001771
Tejun Heoc8e55f32010-06-29 10:07:12 +02001772 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001773 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001774 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001775}
1776
Tejun Heo63d95a92012-07-12 14:46:37 -07001777static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001778{
Tejun Heo63d95a92012-07-12 14:46:37 -07001779 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001780
Tejun Heod565ed62013-01-24 11:01:33 -08001781 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001782
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001783 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001784 struct worker *worker;
1785 unsigned long expires;
1786
1787 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001788 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001789 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1790
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001791 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001792 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001793 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001794 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001795
1796 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001797 }
1798
Tejun Heod565ed62013-01-24 11:01:33 -08001799 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001800}
1801
Tejun Heo493a1722013-03-12 11:29:59 -07001802static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001803{
Tejun Heo112202d2013-02-13 19:29:12 -08001804 struct pool_workqueue *pwq = get_work_pwq(work);
1805 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001806
Tejun Heo2e109a22013-03-13 19:47:40 -07001807 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001808
Tejun Heo493008a2013-03-12 11:30:03 -07001809 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001810 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001811
1812 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001813 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001814 /*
1815 * If @pwq is for an unbound wq, its base ref may be put at
1816 * any time due to an attribute change. Pin @pwq until the
1817 * rescuer is done with it.
1818 */
1819 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001820 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001821 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001822 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001823}
1824
Tejun Heo706026c2013-01-24 11:01:34 -08001825static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001826{
Tejun Heo63d95a92012-07-12 14:46:37 -07001827 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001828 struct work_struct *work;
1829
Tejun Heob2d82902014-12-08 12:39:16 -05001830 spin_lock_irq(&pool->lock);
1831 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001832
Tejun Heo63d95a92012-07-12 14:46:37 -07001833 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001834 /*
1835 * We've been trying to create a new worker but
1836 * haven't been successful. We might be hitting an
1837 * allocation deadlock. Send distress signals to
1838 * rescuers.
1839 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001840 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001841 send_mayday(work);
1842 }
1843
Tejun Heob2d82902014-12-08 12:39:16 -05001844 spin_unlock(&wq_mayday_lock);
1845 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001846
Tejun Heo63d95a92012-07-12 14:46:37 -07001847 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001848}
1849
1850/**
1851 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001852 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001853 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001854 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001855 * have at least one idle worker on return from this function. If
1856 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001857 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001858 * possible allocation deadlock.
1859 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001860 * On return, need_to_create_worker() is guaranteed to be %false and
1861 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001862 *
1863 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001864 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001865 * multiple times. Does GFP_KERNEL allocations. Called only from
1866 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001867 */
Tejun Heo29187a92015-01-16 14:21:16 -05001868static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001869__releases(&pool->lock)
1870__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001871{
Tejun Heoe22bee72010-06-29 10:07:14 +02001872restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001873 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001874
Tejun Heoe22bee72010-06-29 10:07:14 +02001875 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001876 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001877
1878 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001879 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001880 break;
1881
Lai Jiangshane212f362014-06-03 15:32:17 +08001882 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001883
Tejun Heo63d95a92012-07-12 14:46:37 -07001884 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001885 break;
1886 }
1887
Tejun Heo63d95a92012-07-12 14:46:37 -07001888 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001889 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001890 /*
1891 * This is necessary even after a new worker was just successfully
1892 * created as @pool->lock was dropped and the new worker might have
1893 * already become busy.
1894 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001895 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001896 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001897}
1898
1899/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001900 * manage_workers - manage worker pool
1901 * @worker: self
1902 *
Tejun Heo706026c2013-01-24 11:01:34 -08001903 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001904 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001905 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001906 *
1907 * The caller can safely start processing works on false return. On
1908 * true return, it's guaranteed that need_to_create_worker() is false
1909 * and may_start_working() is true.
1910 *
1911 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001912 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001913 * multiple times. Does GFP_KERNEL allocations.
1914 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001915 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001916 * %false if the pool doesn't need management and the caller can safely
1917 * start processing works, %true if management function was performed and
1918 * the conditions that the caller verified before calling the function may
1919 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001920 */
1921static bool manage_workers(struct worker *worker)
1922{
Tejun Heo63d95a92012-07-12 14:46:37 -07001923 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001924
Tejun Heobc3a1af2013-03-13 19:47:39 -07001925 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07001926 * Anyone who successfully grabs manager_arb wins the arbitration
1927 * and becomes the manager. mutex_trylock() on pool->manager_arb
1928 * failure while holding pool->lock reliably indicates that someone
1929 * else is managing the pool and the worker which failed trylock
1930 * can proceed to executing work items. This means that anyone
1931 * grabbing manager_arb is responsible for actually performing
1932 * manager duties. If manager_arb is grabbed and released without
1933 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07001934 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07001935 if (!mutex_trylock(&pool->manager_arb))
Tejun Heo29187a92015-01-16 14:21:16 -05001936 return false;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001937 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001938
Tejun Heo29187a92015-01-16 14:21:16 -05001939 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001940
Tejun Heo2607d7a2015-03-09 09:22:28 -04001941 pool->manager = NULL;
Tejun Heo34a06bd2013-03-12 11:30:00 -07001942 mutex_unlock(&pool->manager_arb);
Tejun Heo29187a92015-01-16 14:21:16 -05001943 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02001944}
1945
Tejun Heoa62428c2010-06-29 10:07:10 +02001946/**
1947 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001948 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001949 * @work: work to process
1950 *
1951 * Process @work. This function contains all the logics necessary to
1952 * process a single work including synchronization against and
1953 * interaction with other workers on the same cpu, queueing and
1954 * flushing. As long as context requirement is met, any worker can
1955 * call this function to process a work.
1956 *
1957 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001958 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001959 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001960static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08001961__releases(&pool->lock)
1962__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02001963{
Tejun Heo112202d2013-02-13 19:29:12 -08001964 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001965 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001966 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02001967 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001968 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001969#ifdef CONFIG_LOCKDEP
1970 /*
1971 * It is permissible to free the struct work_struct from
1972 * inside the function that is called from it, this we need to
1973 * take into account for lockdep too. To avoid bogus "held
1974 * lock freed" warnings as well as problems when looking into
1975 * work->lockdep_map, make a copy and use that here.
1976 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07001977 struct lockdep_map lockdep_map;
1978
1979 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02001980#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08001981 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08001982 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08001983 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07001984
Tejun Heo7e116292010-06-29 10:07:13 +02001985 /*
1986 * A single work shouldn't be executed concurrently by
1987 * multiple workers on a single cpu. Check whether anyone is
1988 * already processing the work. If so, defer the work to the
1989 * currently executing one.
1990 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001991 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02001992 if (unlikely(collision)) {
1993 move_linked_works(work, &collision->scheduled, NULL);
1994 return;
1995 }
1996
Tejun Heo8930cab2012-08-03 10:30:45 -07001997 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02001998 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001999 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002000 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002001 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002002 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002003 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002004
Tejun Heoa62428c2010-06-29 10:07:10 +02002005 list_del_init(&work->entry);
2006
Tejun Heo649027d2010-06-29 10:07:14 +02002007 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002008 * CPU intensive works don't participate in concurrency management.
2009 * They're the scheduler's responsibility. This takes @worker out
2010 * of concurrency management and the next code block will chain
2011 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002012 */
2013 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002014 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002015
Tejun Heo974271c2012-07-12 14:46:37 -07002016 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002017 * Wake up another worker if necessary. The condition is always
2018 * false for normal per-cpu workers since nr_running would always
2019 * be >= 1 at this point. This is used to chain execution of the
2020 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002021 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002022 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002023 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002024 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002025
Tejun Heo8930cab2012-08-03 10:30:45 -07002026 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002027 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002028 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002029 * PENDING and queued state changes happen together while IRQ is
2030 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002031 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002032 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002033
Tejun Heod565ed62013-01-24 11:01:33 -08002034 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002035
Tejun Heo112202d2013-02-13 19:29:12 -08002036 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002037 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002038 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002039 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002040 /*
2041 * While we must be careful to not use "work" after this, the trace
2042 * point will only record its address.
2043 */
2044 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002045 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002046 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002047
2048 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002049 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2050 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002051 current->comm, preempt_count(), task_pid_nr(current),
2052 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002053 debug_show_held_locks(current);
2054 dump_stack();
2055 }
2056
Tejun Heob22ce272013-08-28 17:33:37 -04002057 /*
2058 * The following prevents a kworker from hogging CPU on !PREEMPT
2059 * kernels, where a requeueing work item waiting for something to
2060 * happen could deadlock with stop_machine as such work item could
2061 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002062 * stop_machine. At the same time, report a quiescent RCU state so
2063 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002064 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002065 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002066
Tejun Heod565ed62013-01-24 11:01:33 -08002067 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002068
Tejun Heofb0e7be2010-06-29 10:07:15 +02002069 /* clear cpu intensive status */
2070 if (unlikely(cpu_intensive))
2071 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2072
Tejun Heoa62428c2010-06-29 10:07:10 +02002073 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002074 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002075 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002076 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002077 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002078 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002079 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002080}
2081
Tejun Heoaffee4b2010-06-29 10:07:12 +02002082/**
2083 * process_scheduled_works - process scheduled works
2084 * @worker: self
2085 *
2086 * Process all scheduled works. Please note that the scheduled list
2087 * may change while processing a work, so this function repeatedly
2088 * fetches a work from the top and executes it.
2089 *
2090 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002091 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002092 * multiple times.
2093 */
2094static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002096 while (!list_empty(&worker->scheduled)) {
2097 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002099 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101}
2102
Tejun Heo4690c4a2010-06-29 10:07:10 +02002103/**
2104 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002105 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002106 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002107 * The worker thread function. All workers belong to a worker_pool -
2108 * either a per-cpu one or dynamic unbound one. These workers process all
2109 * work items regardless of their specific target workqueue. The only
2110 * exception is work items which belong to workqueues with a rescuer which
2111 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002112 *
2113 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002114 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002115static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116{
Tejun Heoc34056a2010-06-29 10:07:11 +02002117 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002118 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119
Tejun Heoe22bee72010-06-29 10:07:14 +02002120 /* tell the scheduler that this is a workqueue worker */
2121 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002122woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002123 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002124
Tejun Heoa9ab7752013-03-19 13:45:21 -07002125 /* am I supposed to die? */
2126 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002127 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002128 WARN_ON_ONCE(!list_empty(&worker->entry));
2129 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002130
2131 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002132 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002133 worker_detach_from_pool(worker, pool);
2134 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002135 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002137
Tejun Heoc8e55f32010-06-29 10:07:12 +02002138 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002139recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002140 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002141 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002142 goto sleep;
2143
2144 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002145 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002146 goto recheck;
2147
Tejun Heoc8e55f32010-06-29 10:07:12 +02002148 /*
2149 * ->scheduled list can only be filled while a worker is
2150 * preparing to process a work or actually processing it.
2151 * Make sure nobody diddled with it while I was sleeping.
2152 */
Tejun Heo6183c002013-03-12 11:29:57 -07002153 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002154
Tejun Heoe22bee72010-06-29 10:07:14 +02002155 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002156 * Finish PREP stage. We're guaranteed to have at least one idle
2157 * worker or that someone else has already assumed the manager
2158 * role. This is where @worker starts participating in concurrency
2159 * management if applicable and concurrency management is restored
2160 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002161 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002162 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002163
2164 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002165 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002166 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002167 struct work_struct, entry);
2168
2169 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2170 /* optimization path, not strictly necessary */
2171 process_one_work(worker, work);
2172 if (unlikely(!list_empty(&worker->scheduled)))
2173 process_scheduled_works(worker);
2174 } else {
2175 move_linked_works(work, &worker->scheduled, NULL);
2176 process_scheduled_works(worker);
2177 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002178 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002179
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002180 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002181sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002182 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002183 * pool->lock is held and there's no work to process and no need to
2184 * manage, sleep. Workers are woken up only while holding
2185 * pool->lock or from local cpu, so setting the current state
2186 * before releasing pool->lock is enough to prevent losing any
2187 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002188 */
2189 worker_enter_idle(worker);
2190 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002191 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002192 schedule();
2193 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194}
2195
Tejun Heoe22bee72010-06-29 10:07:14 +02002196/**
2197 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002198 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002199 *
2200 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002201 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002202 *
Tejun Heo706026c2013-01-24 11:01:34 -08002203 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002204 * worker which uses GFP_KERNEL allocation which has slight chance of
2205 * developing into deadlock if some works currently on the same queue
2206 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2207 * the problem rescuer solves.
2208 *
Tejun Heo706026c2013-01-24 11:01:34 -08002209 * When such condition is possible, the pool summons rescuers of all
2210 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002211 * those works so that forward progress can be guaranteed.
2212 *
2213 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002214 *
2215 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002216 */
Tejun Heo111c2252013-01-17 17:16:24 -08002217static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002218{
Tejun Heo111c2252013-01-17 17:16:24 -08002219 struct worker *rescuer = __rescuer;
2220 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002221 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002222 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002223
2224 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002225
2226 /*
2227 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2228 * doesn't participate in concurrency management.
2229 */
2230 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002231repeat:
2232 set_current_state(TASK_INTERRUPTIBLE);
2233
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002234 /*
2235 * By the time the rescuer is requested to stop, the workqueue
2236 * shouldn't have any work pending, but @wq->maydays may still have
2237 * pwq(s) queued. This can happen by non-rescuer workers consuming
2238 * all the work items before the rescuer got to them. Go through
2239 * @wq->maydays processing before acting on should_stop so that the
2240 * list is always empty on exit.
2241 */
2242 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002243
Tejun Heo493a1722013-03-12 11:29:59 -07002244 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002245 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002246
2247 while (!list_empty(&wq->maydays)) {
2248 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2249 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002250 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002251 struct work_struct *work, *n;
2252
2253 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002254 list_del_init(&pwq->mayday_node);
2255
Tejun Heo2e109a22013-03-13 19:47:40 -07002256 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002257
Lai Jiangshan51697d392014-05-20 17:46:36 +08002258 worker_attach_to_pool(rescuer, pool);
2259
2260 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002261 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002262
2263 /*
2264 * Slurp in all works issued via this workqueue and
2265 * process'em.
2266 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002267 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002268 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002269 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002270 move_linked_works(work, scheduled, &n);
2271
NeilBrown008847f2014-12-08 12:39:16 -05002272 if (!list_empty(scheduled)) {
2273 process_scheduled_works(rescuer);
2274
2275 /*
2276 * The above execution of rescued work items could
2277 * have created more to rescue through
2278 * pwq_activate_first_delayed() or chained
2279 * queueing. Let's put @pwq back on mayday list so
2280 * that such back-to-back work items, which may be
2281 * being used to relieve memory pressure, don't
2282 * incur MAYDAY_INTERVAL delay inbetween.
2283 */
2284 if (need_to_create_worker(pool)) {
2285 spin_lock(&wq_mayday_lock);
2286 get_pwq(pwq);
2287 list_move_tail(&pwq->mayday_node, &wq->maydays);
2288 spin_unlock(&wq_mayday_lock);
2289 }
2290 }
Tejun Heo75769582011-02-14 14:04:46 +01002291
2292 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002293 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002294 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002295 */
2296 put_pwq(pwq);
2297
2298 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002299 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002300 * regular worker; otherwise, we end up with 0 concurrency
2301 * and stalling the execution.
2302 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002303 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002304 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002305
Lai Jiangshanb3104102013-02-19 12:17:02 -08002306 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002307 spin_unlock_irq(&pool->lock);
2308
2309 worker_detach_from_pool(rescuer, pool);
2310
2311 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002312 }
2313
Tejun Heo2e109a22013-03-13 19:47:40 -07002314 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002315
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002316 if (should_stop) {
2317 __set_current_state(TASK_RUNNING);
2318 rescuer->task->flags &= ~PF_WQ_WORKER;
2319 return 0;
2320 }
2321
Tejun Heo111c2252013-01-17 17:16:24 -08002322 /* rescuers should never participate in concurrency management */
2323 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002324 schedule();
2325 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326}
2327
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002328struct wq_barrier {
2329 struct work_struct work;
2330 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002331 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002332};
2333
2334static void wq_barrier_func(struct work_struct *work)
2335{
2336 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2337 complete(&barr->done);
2338}
2339
Tejun Heo4690c4a2010-06-29 10:07:10 +02002340/**
2341 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002342 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002343 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002344 * @target: target work to attach @barr to
2345 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002346 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002347 * @barr is linked to @target such that @barr is completed only after
2348 * @target finishes execution. Please note that the ordering
2349 * guarantee is observed only with respect to @target and on the local
2350 * cpu.
2351 *
2352 * Currently, a queued barrier can't be canceled. This is because
2353 * try_to_grab_pending() can't determine whether the work to be
2354 * grabbed is at the head of the queue and thus can't clear LINKED
2355 * flag of the previous work while there must be a valid next work
2356 * after a work with LINKED flag set.
2357 *
2358 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002359 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002360 *
2361 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002362 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002363 */
Tejun Heo112202d2013-02-13 19:29:12 -08002364static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002365 struct wq_barrier *barr,
2366 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002367{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002368 struct list_head *head;
2369 unsigned int linked = 0;
2370
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002371 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002372 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002373 * as we know for sure that this will not trigger any of the
2374 * checks and call back into the fixup functions where we
2375 * might deadlock.
2376 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002377 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002378 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002379 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002380 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002381
Tejun Heoaffee4b2010-06-29 10:07:12 +02002382 /*
2383 * If @target is currently being executed, schedule the
2384 * barrier to the worker; otherwise, put it after @target.
2385 */
2386 if (worker)
2387 head = worker->scheduled.next;
2388 else {
2389 unsigned long *bits = work_data_bits(target);
2390
2391 head = target->entry.next;
2392 /* there can already be other linked works, inherit and set */
2393 linked = *bits & WORK_STRUCT_LINKED;
2394 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2395 }
2396
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002397 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002398 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002399 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002400}
2401
Tejun Heo73f53c42010-06-29 10:07:11 +02002402/**
Tejun Heo112202d2013-02-13 19:29:12 -08002403 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002404 * @wq: workqueue being flushed
2405 * @flush_color: new flush color, < 0 for no-op
2406 * @work_color: new work color, < 0 for no-op
2407 *
Tejun Heo112202d2013-02-13 19:29:12 -08002408 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002409 *
Tejun Heo112202d2013-02-13 19:29:12 -08002410 * If @flush_color is non-negative, flush_color on all pwqs should be
2411 * -1. If no pwq has in-flight commands at the specified color, all
2412 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2413 * has in flight commands, its pwq->flush_color is set to
2414 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002415 * wakeup logic is armed and %true is returned.
2416 *
2417 * The caller should have initialized @wq->first_flusher prior to
2418 * calling this function with non-negative @flush_color. If
2419 * @flush_color is negative, no flush color update is done and %false
2420 * is returned.
2421 *
Tejun Heo112202d2013-02-13 19:29:12 -08002422 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002423 * work_color which is previous to @work_color and all will be
2424 * advanced to @work_color.
2425 *
2426 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002427 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002428 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002429 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002430 * %true if @flush_color >= 0 and there's something to flush. %false
2431 * otherwise.
2432 */
Tejun Heo112202d2013-02-13 19:29:12 -08002433static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002434 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435{
Tejun Heo73f53c42010-06-29 10:07:11 +02002436 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002437 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002438
Tejun Heo73f53c42010-06-29 10:07:11 +02002439 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002440 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002441 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002442 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002443
Tejun Heo49e3cf42013-03-12 11:29:58 -07002444 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002445 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002446
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002447 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002448
2449 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002450 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002451
Tejun Heo112202d2013-02-13 19:29:12 -08002452 if (pwq->nr_in_flight[flush_color]) {
2453 pwq->flush_color = flush_color;
2454 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002455 wait = true;
2456 }
2457 }
2458
2459 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002460 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002461 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002462 }
2463
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002464 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002465 }
2466
Tejun Heo112202d2013-02-13 19:29:12 -08002467 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002468 complete(&wq->first_flusher->done);
2469
2470 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471}
2472
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002473/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002475 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002477 * This function sleeps until all work items which were queued on entry
2478 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002480void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481{
Tejun Heo73f53c42010-06-29 10:07:11 +02002482 struct wq_flusher this_flusher = {
2483 .list = LIST_HEAD_INIT(this_flusher.list),
2484 .flush_color = -1,
2485 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2486 };
2487 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002488
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002489 lock_map_acquire(&wq->lockdep_map);
2490 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002491
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002492 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002493
2494 /*
2495 * Start-to-wait phase
2496 */
2497 next_color = work_next_color(wq->work_color);
2498
2499 if (next_color != wq->flush_color) {
2500 /*
2501 * Color space is not full. The current work_color
2502 * becomes our flush_color and work_color is advanced
2503 * by one.
2504 */
Tejun Heo6183c002013-03-12 11:29:57 -07002505 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002506 this_flusher.flush_color = wq->work_color;
2507 wq->work_color = next_color;
2508
2509 if (!wq->first_flusher) {
2510 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002511 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002512
2513 wq->first_flusher = &this_flusher;
2514
Tejun Heo112202d2013-02-13 19:29:12 -08002515 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002516 wq->work_color)) {
2517 /* nothing to flush, done */
2518 wq->flush_color = next_color;
2519 wq->first_flusher = NULL;
2520 goto out_unlock;
2521 }
2522 } else {
2523 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002524 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002525 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002526 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002527 }
2528 } else {
2529 /*
2530 * Oops, color space is full, wait on overflow queue.
2531 * The next flush completion will assign us
2532 * flush_color and transfer to flusher_queue.
2533 */
2534 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2535 }
2536
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002537 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002538
2539 wait_for_completion(&this_flusher.done);
2540
2541 /*
2542 * Wake-up-and-cascade phase
2543 *
2544 * First flushers are responsible for cascading flushes and
2545 * handling overflow. Non-first flushers can simply return.
2546 */
2547 if (wq->first_flusher != &this_flusher)
2548 return;
2549
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002550 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002551
Tejun Heo4ce48b32010-07-02 10:03:51 +02002552 /* we might have raced, check again with mutex held */
2553 if (wq->first_flusher != &this_flusher)
2554 goto out_unlock;
2555
Tejun Heo73f53c42010-06-29 10:07:11 +02002556 wq->first_flusher = NULL;
2557
Tejun Heo6183c002013-03-12 11:29:57 -07002558 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2559 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002560
2561 while (true) {
2562 struct wq_flusher *next, *tmp;
2563
2564 /* complete all the flushers sharing the current flush color */
2565 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2566 if (next->flush_color != wq->flush_color)
2567 break;
2568 list_del_init(&next->list);
2569 complete(&next->done);
2570 }
2571
Tejun Heo6183c002013-03-12 11:29:57 -07002572 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2573 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002574
2575 /* this flush_color is finished, advance by one */
2576 wq->flush_color = work_next_color(wq->flush_color);
2577
2578 /* one color has been freed, handle overflow queue */
2579 if (!list_empty(&wq->flusher_overflow)) {
2580 /*
2581 * Assign the same color to all overflowed
2582 * flushers, advance work_color and append to
2583 * flusher_queue. This is the start-to-wait
2584 * phase for these overflowed flushers.
2585 */
2586 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2587 tmp->flush_color = wq->work_color;
2588
2589 wq->work_color = work_next_color(wq->work_color);
2590
2591 list_splice_tail_init(&wq->flusher_overflow,
2592 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002593 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002594 }
2595
2596 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002597 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002598 break;
2599 }
2600
2601 /*
2602 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002603 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002604 */
Tejun Heo6183c002013-03-12 11:29:57 -07002605 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2606 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002607
2608 list_del_init(&next->list);
2609 wq->first_flusher = next;
2610
Tejun Heo112202d2013-02-13 19:29:12 -08002611 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002612 break;
2613
2614 /*
2615 * Meh... this color is already done, clear first
2616 * flusher and repeat cascading.
2617 */
2618 wq->first_flusher = NULL;
2619 }
2620
2621out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002622 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623}
Dave Jonesae90dd52006-06-30 01:40:45 -04002624EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002626/**
2627 * drain_workqueue - drain a workqueue
2628 * @wq: workqueue to drain
2629 *
2630 * Wait until the workqueue becomes empty. While draining is in progress,
2631 * only chain queueing is allowed. IOW, only currently pending or running
2632 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002633 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002634 * by the depth of chaining and should be relatively short. Whine if it
2635 * takes too long.
2636 */
2637void drain_workqueue(struct workqueue_struct *wq)
2638{
2639 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002640 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002641
2642 /*
2643 * __queue_work() needs to test whether there are drainers, is much
2644 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002645 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002646 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002647 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002648 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002649 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002650 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002651reflush:
2652 flush_workqueue(wq);
2653
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002654 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002655
Tejun Heo49e3cf42013-03-12 11:29:58 -07002656 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002657 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002658
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002659 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002660 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002661 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002662
2663 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002664 continue;
2665
2666 if (++flush_cnt == 10 ||
2667 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002668 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002669 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002670
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002671 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002672 goto reflush;
2673 }
2674
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002675 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002676 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002677 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002678}
2679EXPORT_SYMBOL_GPL(drain_workqueue);
2680
Tejun Heo606a5022012-08-20 14:51:23 -07002681static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002682{
2683 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002684 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002685 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002686
2687 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002688
Tejun Heofa1b54e2013-03-12 11:30:00 -07002689 local_irq_disable();
2690 pool = get_work_pool(work);
2691 if (!pool) {
2692 local_irq_enable();
2693 return false;
2694 }
2695
2696 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002697 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002698 pwq = get_work_pwq(work);
2699 if (pwq) {
2700 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002701 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002702 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002703 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002704 if (!worker)
2705 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002706 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002707 }
Tejun Heobaf59022010-09-16 10:42:16 +02002708
Tejun Heo112202d2013-02-13 19:29:12 -08002709 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002710 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002711
Tejun Heoe1594892011-01-09 23:32:15 +01002712 /*
2713 * If @max_active is 1 or rescuer is in use, flushing another work
2714 * item on the same workqueue may lead to deadlock. Make sure the
2715 * flusher is not running on the same workqueue by verifying write
2716 * access.
2717 */
Tejun Heo493008a2013-03-12 11:30:03 -07002718 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002719 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002720 else
Tejun Heo112202d2013-02-13 19:29:12 -08002721 lock_map_acquire_read(&pwq->wq->lockdep_map);
2722 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002723
Tejun Heobaf59022010-09-16 10:42:16 +02002724 return true;
2725already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002726 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002727 return false;
2728}
2729
Oleg Nesterovdb700892008-07-25 01:47:49 -07002730/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002731 * flush_work - wait for a work to finish executing the last queueing instance
2732 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002733 *
Tejun Heo606a5022012-08-20 14:51:23 -07002734 * Wait until @work has finished execution. @work is guaranteed to be idle
2735 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002736 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002737 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002738 * %true if flush_work() waited for the work to finish execution,
2739 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002740 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002741bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002742{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002743 struct wq_barrier barr;
2744
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002745 lock_map_acquire(&work->lockdep_map);
2746 lock_map_release(&work->lockdep_map);
2747
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002748 if (start_flush_work(work, &barr)) {
2749 wait_for_completion(&barr.done);
2750 destroy_work_on_stack(&barr.work);
2751 return true;
2752 } else {
2753 return false;
2754 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002755}
2756EXPORT_SYMBOL_GPL(flush_work);
2757
Tejun Heo8603e1b32015-03-05 08:04:13 -05002758struct cwt_wait {
2759 wait_queue_t wait;
2760 struct work_struct *work;
2761};
2762
2763static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2764{
2765 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2766
2767 if (cwait->work != key)
2768 return 0;
2769 return autoremove_wake_function(wait, mode, sync, key);
2770}
2771
Tejun Heo36e227d2012-08-03 10:30:46 -07002772static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002773{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002774 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002775 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002776 int ret;
2777
2778 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002779 ret = try_to_grab_pending(work, is_dwork, &flags);
2780 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002781 * If someone else is already canceling, wait for it to
2782 * finish. flush_work() doesn't work for PREEMPT_NONE
2783 * because we may get scheduled between @work's completion
2784 * and the other canceling task resuming and clearing
2785 * CANCELING - flush_work() will return false immediately
2786 * as @work is no longer busy, try_to_grab_pending() will
2787 * return -ENOENT as @work is still being canceled and the
2788 * other canceling task won't be able to clear CANCELING as
2789 * we're hogging the CPU.
2790 *
2791 * Let's wait for completion using a waitqueue. As this
2792 * may lead to the thundering herd problem, use a custom
2793 * wake function which matches @work along with exclusive
2794 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002795 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002796 if (unlikely(ret == -ENOENT)) {
2797 struct cwt_wait cwait;
2798
2799 init_wait(&cwait.wait);
2800 cwait.wait.func = cwt_wakefn;
2801 cwait.work = work;
2802
2803 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2804 TASK_UNINTERRUPTIBLE);
2805 if (work_is_canceling(work))
2806 schedule();
2807 finish_wait(&cancel_waitq, &cwait.wait);
2808 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002809 } while (unlikely(ret < 0));
2810
Tejun Heobbb68df2012-08-03 10:30:46 -07002811 /* tell other tasks trying to grab @work to back off */
2812 mark_work_canceling(work);
2813 local_irq_restore(flags);
2814
Tejun Heo606a5022012-08-20 14:51:23 -07002815 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002816 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002817
2818 /*
2819 * Paired with prepare_to_wait() above so that either
2820 * waitqueue_active() is visible here or !work_is_canceling() is
2821 * visible there.
2822 */
2823 smp_mb();
2824 if (waitqueue_active(&cancel_waitq))
2825 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2826
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002827 return ret;
2828}
2829
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002830/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002831 * cancel_work_sync - cancel a work and wait for it to finish
2832 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002833 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002834 * Cancel @work and wait for its execution to finish. This function
2835 * can be used even if the work re-queues itself or migrates to
2836 * another workqueue. On return from this function, @work is
2837 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002838 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002839 * cancel_work_sync(&delayed_work->work) must not be used for
2840 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002841 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002842 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002843 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002844 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002845 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002846 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002847 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002848bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002849{
Tejun Heo36e227d2012-08-03 10:30:46 -07002850 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002851}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002852EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002853
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002854/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002855 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2856 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002857 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002858 * Delayed timer is cancelled and the pending work is queued for
2859 * immediate execution. Like flush_work(), this function only
2860 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002861 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002862 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002863 * %true if flush_work() waited for the work to finish execution,
2864 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002865 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002866bool flush_delayed_work(struct delayed_work *dwork)
2867{
Tejun Heo8930cab2012-08-03 10:30:45 -07002868 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002869 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002870 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002871 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002872 return flush_work(&dwork->work);
2873}
2874EXPORT_SYMBOL(flush_delayed_work);
2875
2876/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002877 * cancel_delayed_work - cancel a delayed work
2878 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002879 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002880 * Kill off a pending delayed_work.
2881 *
2882 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2883 * pending.
2884 *
2885 * Note:
2886 * The work callback function may still be running on return, unless
2887 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2888 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002889 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002890 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002891 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002892bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002893{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002894 unsigned long flags;
2895 int ret;
2896
2897 do {
2898 ret = try_to_grab_pending(&dwork->work, true, &flags);
2899 } while (unlikely(ret == -EAGAIN));
2900
2901 if (unlikely(ret < 0))
2902 return false;
2903
Tejun Heo7c3eed52013-01-24 11:01:33 -08002904 set_work_pool_and_clear_pending(&dwork->work,
2905 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002906 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002907 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002908}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002909EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002910
2911/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002912 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2913 * @dwork: the delayed work cancel
2914 *
2915 * This is cancel_work_sync() for delayed works.
2916 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002917 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002918 * %true if @dwork was pending, %false otherwise.
2919 */
2920bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002921{
Tejun Heo36e227d2012-08-03 10:30:46 -07002922 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002923}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002924EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002926/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002927 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002928 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002929 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002930 * schedule_on_each_cpu() executes @func on each online CPU using the
2931 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002932 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002933 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002934 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02002935 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002936 */
David Howells65f27f32006-11-22 14:55:48 +00002937int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002938{
2939 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002940 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002941
Andrew Mortonb6136772006-06-25 05:47:49 -07002942 works = alloc_percpu(struct work_struct);
2943 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002944 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002945
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002946 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002947
Christoph Lameter15316ba2006-01-08 01:00:43 -08002948 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002949 struct work_struct *work = per_cpu_ptr(works, cpu);
2950
2951 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002952 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002953 }
Tejun Heo93981802009-11-17 14:06:20 -08002954
2955 for_each_online_cpu(cpu)
2956 flush_work(per_cpu_ptr(works, cpu));
2957
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002958 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002959 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002960 return 0;
2961}
2962
Alan Sterneef6a7d2010-02-12 17:39:21 +09002963/**
2964 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2965 *
2966 * Forces execution of the kernel-global workqueue and blocks until its
2967 * completion.
2968 *
2969 * Think twice before calling this function! It's very easy to get into
2970 * trouble if you don't take great care. Either of the following situations
2971 * will lead to deadlock:
2972 *
2973 * One of the work items currently on the workqueue needs to acquire
2974 * a lock held by your code or its caller.
2975 *
2976 * Your code is running in the context of a work routine.
2977 *
2978 * They will be detected by lockdep when they occur, but the first might not
2979 * occur very often. It depends on what work items are on the workqueue and
2980 * what locks they need, which you have no control over.
2981 *
2982 * In most situations flushing the entire workqueue is overkill; you merely
2983 * need to know that a particular work item isn't queued and isn't running.
2984 * In such cases you should use cancel_delayed_work_sync() or
2985 * cancel_work_sync() instead.
2986 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987void flush_scheduled_work(void)
2988{
Tejun Heod320c032010-06-29 10:07:14 +02002989 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002990}
Dave Jonesae90dd52006-06-30 01:40:45 -04002991EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002992
2993/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002994 * execute_in_process_context - reliably execute the routine with user context
2995 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002996 * @ew: guaranteed storage for the execute work structure (must
2997 * be available when the work executes)
2998 *
2999 * Executes the function immediately if process context is available,
3000 * otherwise schedules the function for delayed execution.
3001 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003002 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003003 * 1 - function was scheduled for execution
3004 */
David Howells65f27f32006-11-22 14:55:48 +00003005int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003006{
3007 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003008 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003009 return 0;
3010 }
3011
David Howells65f27f32006-11-22 14:55:48 +00003012 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003013 schedule_work(&ew->work);
3014
3015 return 1;
3016}
3017EXPORT_SYMBOL_GPL(execute_in_process_context);
3018
Tejun Heo7a4e3442013-03-12 11:30:00 -07003019/**
3020 * free_workqueue_attrs - free a workqueue_attrs
3021 * @attrs: workqueue_attrs to free
3022 *
3023 * Undo alloc_workqueue_attrs().
3024 */
3025void free_workqueue_attrs(struct workqueue_attrs *attrs)
3026{
3027 if (attrs) {
3028 free_cpumask_var(attrs->cpumask);
3029 kfree(attrs);
3030 }
3031}
3032
3033/**
3034 * alloc_workqueue_attrs - allocate a workqueue_attrs
3035 * @gfp_mask: allocation mask to use
3036 *
3037 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003038 * return it.
3039 *
3040 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003041 */
3042struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3043{
3044 struct workqueue_attrs *attrs;
3045
3046 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3047 if (!attrs)
3048 goto fail;
3049 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3050 goto fail;
3051
Tejun Heo13e2e552013-04-01 11:23:31 -07003052 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003053 return attrs;
3054fail:
3055 free_workqueue_attrs(attrs);
3056 return NULL;
3057}
3058
Tejun Heo29c91e92013-03-12 11:30:03 -07003059static void copy_workqueue_attrs(struct workqueue_attrs *to,
3060 const struct workqueue_attrs *from)
3061{
3062 to->nice = from->nice;
3063 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003064 /*
3065 * Unlike hash and equality test, this function doesn't ignore
3066 * ->no_numa as it is used for both pool and wq attrs. Instead,
3067 * get_unbound_pool() explicitly clears ->no_numa after copying.
3068 */
3069 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003070}
3071
Tejun Heo29c91e92013-03-12 11:30:03 -07003072/* hash value of the content of @attr */
3073static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3074{
3075 u32 hash = 0;
3076
3077 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003078 hash = jhash(cpumask_bits(attrs->cpumask),
3079 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003080 return hash;
3081}
3082
3083/* content equality test */
3084static bool wqattrs_equal(const struct workqueue_attrs *a,
3085 const struct workqueue_attrs *b)
3086{
3087 if (a->nice != b->nice)
3088 return false;
3089 if (!cpumask_equal(a->cpumask, b->cpumask))
3090 return false;
3091 return true;
3092}
3093
Tejun Heo7a4e3442013-03-12 11:30:00 -07003094/**
3095 * init_worker_pool - initialize a newly zalloc'd worker_pool
3096 * @pool: worker_pool to initialize
3097 *
3098 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003099 *
3100 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003101 * inside @pool proper are initialized and put_unbound_pool() can be called
3102 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003103 */
3104static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003105{
3106 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003107 pool->id = -1;
3108 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003109 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003110 pool->flags |= POOL_DISASSOCIATED;
3111 INIT_LIST_HEAD(&pool->worklist);
3112 INIT_LIST_HEAD(&pool->idle_list);
3113 hash_init(pool->busy_hash);
3114
3115 init_timer_deferrable(&pool->idle_timer);
3116 pool->idle_timer.function = idle_worker_timeout;
3117 pool->idle_timer.data = (unsigned long)pool;
3118
3119 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3120 (unsigned long)pool);
3121
3122 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003123 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003124 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003125
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003126 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003127 INIT_HLIST_NODE(&pool->hash_node);
3128 pool->refcnt = 1;
3129
3130 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003131 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3132 if (!pool->attrs)
3133 return -ENOMEM;
3134 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003135}
3136
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003137static void rcu_free_wq(struct rcu_head *rcu)
3138{
3139 struct workqueue_struct *wq =
3140 container_of(rcu, struct workqueue_struct, rcu);
3141
3142 if (!(wq->flags & WQ_UNBOUND))
3143 free_percpu(wq->cpu_pwqs);
3144 else
3145 free_workqueue_attrs(wq->unbound_attrs);
3146
3147 kfree(wq->rescuer);
3148 kfree(wq);
3149}
3150
Tejun Heo29c91e92013-03-12 11:30:03 -07003151static void rcu_free_pool(struct rcu_head *rcu)
3152{
3153 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3154
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003155 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003156 free_workqueue_attrs(pool->attrs);
3157 kfree(pool);
3158}
3159
3160/**
3161 * put_unbound_pool - put a worker_pool
3162 * @pool: worker_pool to put
3163 *
3164 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003165 * safe manner. get_unbound_pool() calls this function on its failure path
3166 * and this function should be able to release pools which went through,
3167 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003168 *
3169 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003170 */
3171static void put_unbound_pool(struct worker_pool *pool)
3172{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003173 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003174 struct worker *worker;
3175
Tejun Heoa892cac2013-04-01 11:23:32 -07003176 lockdep_assert_held(&wq_pool_mutex);
3177
3178 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003179 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003180
3181 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003182 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003183 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003184 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003185
3186 /* release id and unhash */
3187 if (pool->id >= 0)
3188 idr_remove(&worker_pool_idr, pool->id);
3189 hash_del(&pool->hash_node);
3190
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003191 /*
3192 * Become the manager and destroy all workers. Grabbing
3193 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003194 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003195 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003196 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003197
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003198 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003199 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003200 destroy_worker(worker);
3201 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003202 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003203
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003204 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003205 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003206 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003207 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003208
3209 if (pool->detach_completion)
3210 wait_for_completion(pool->detach_completion);
3211
Tejun Heo29c91e92013-03-12 11:30:03 -07003212 mutex_unlock(&pool->manager_arb);
3213
3214 /* shut down the timers */
3215 del_timer_sync(&pool->idle_timer);
3216 del_timer_sync(&pool->mayday_timer);
3217
3218 /* sched-RCU protected to allow dereferences from get_work_pool() */
3219 call_rcu_sched(&pool->rcu, rcu_free_pool);
3220}
3221
3222/**
3223 * get_unbound_pool - get a worker_pool with the specified attributes
3224 * @attrs: the attributes of the worker_pool to get
3225 *
3226 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3227 * reference count and return it. If there already is a matching
3228 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003229 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003230 *
3231 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003232 *
3233 * Return: On success, a worker_pool with the same attributes as @attrs.
3234 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003235 */
3236static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3237{
Tejun Heo29c91e92013-03-12 11:30:03 -07003238 u32 hash = wqattrs_hash(attrs);
3239 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003240 int node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003241
Tejun Heoa892cac2013-04-01 11:23:32 -07003242 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003243
3244 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003245 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3246 if (wqattrs_equal(pool->attrs, attrs)) {
3247 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003248 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003249 }
3250 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003251
3252 /* nope, create a new one */
3253 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3254 if (!pool || init_worker_pool(pool) < 0)
3255 goto fail;
3256
Tejun Heo8864b4e2013-03-12 11:30:04 -07003257 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003258 copy_workqueue_attrs(pool->attrs, attrs);
3259
Shaohua Li2865a8f2013-08-01 09:56:36 +08003260 /*
3261 * no_numa isn't a worker_pool attribute, always clear it. See
3262 * 'struct workqueue_attrs' comments for detail.
3263 */
3264 pool->attrs->no_numa = false;
3265
Tejun Heof3f90ad2013-04-01 11:23:34 -07003266 /* if cpumask is contained inside a NUMA node, we belong to that node */
3267 if (wq_numa_enabled) {
3268 for_each_node(node) {
3269 if (cpumask_subset(pool->attrs->cpumask,
3270 wq_numa_possible_cpumask[node])) {
3271 pool->node = node;
3272 break;
3273 }
3274 }
3275 }
3276
Tejun Heo29c91e92013-03-12 11:30:03 -07003277 if (worker_pool_assign_id(pool) < 0)
3278 goto fail;
3279
3280 /* create and start the initial worker */
Lai Jiangshan051e1852014-07-22 13:03:02 +08003281 if (!create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003282 goto fail;
3283
Tejun Heo29c91e92013-03-12 11:30:03 -07003284 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003285 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003286
Tejun Heo29c91e92013-03-12 11:30:03 -07003287 return pool;
3288fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003289 if (pool)
3290 put_unbound_pool(pool);
3291 return NULL;
3292}
3293
Tejun Heo8864b4e2013-03-12 11:30:04 -07003294static void rcu_free_pwq(struct rcu_head *rcu)
3295{
3296 kmem_cache_free(pwq_cache,
3297 container_of(rcu, struct pool_workqueue, rcu));
3298}
3299
3300/*
3301 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3302 * and needs to be destroyed.
3303 */
3304static void pwq_unbound_release_workfn(struct work_struct *work)
3305{
3306 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3307 unbound_release_work);
3308 struct workqueue_struct *wq = pwq->wq;
3309 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003310 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003311
3312 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3313 return;
3314
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003315 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003316 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003317 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003318 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003319
Tejun Heoa892cac2013-04-01 11:23:32 -07003320 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003321 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003322 mutex_unlock(&wq_pool_mutex);
3323
Tejun Heo8864b4e2013-03-12 11:30:04 -07003324 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3325
3326 /*
3327 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003328 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003329 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003330 if (is_last)
3331 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003332}
3333
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003334/**
Tejun Heo699ce092013-03-13 16:51:35 -07003335 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003336 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003337 *
Tejun Heo699ce092013-03-13 16:51:35 -07003338 * If @pwq isn't freezing, set @pwq->max_active to the associated
3339 * workqueue's saved_max_active and activate delayed work items
3340 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003341 */
Tejun Heo699ce092013-03-13 16:51:35 -07003342static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003343{
Tejun Heo699ce092013-03-13 16:51:35 -07003344 struct workqueue_struct *wq = pwq->wq;
3345 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003346
Tejun Heo699ce092013-03-13 16:51:35 -07003347 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003348 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003349
3350 /* fast exit for non-freezable wqs */
3351 if (!freezable && pwq->max_active == wq->saved_max_active)
3352 return;
3353
Lai Jiangshana357fc02013-03-25 16:57:19 -07003354 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003355
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003356 /*
3357 * During [un]freezing, the caller is responsible for ensuring that
3358 * this function is called at least once after @workqueue_freezing
3359 * is updated and visible.
3360 */
3361 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003362 pwq->max_active = wq->saved_max_active;
3363
3364 while (!list_empty(&pwq->delayed_works) &&
3365 pwq->nr_active < pwq->max_active)
3366 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003367
3368 /*
3369 * Need to kick a worker after thawed or an unbound wq's
3370 * max_active is bumped. It's a slow path. Do it always.
3371 */
3372 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003373 } else {
3374 pwq->max_active = 0;
3375 }
3376
Lai Jiangshana357fc02013-03-25 16:57:19 -07003377 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003378}
3379
Tejun Heoe50aba92013-04-01 11:23:35 -07003380/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003381static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3382 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003383{
3384 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3385
Tejun Heoe50aba92013-04-01 11:23:35 -07003386 memset(pwq, 0, sizeof(*pwq));
3387
Tejun Heod2c1d402013-03-12 11:30:04 -07003388 pwq->pool = pool;
3389 pwq->wq = wq;
3390 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003391 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003392 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003393 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003394 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003395 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003396}
Tejun Heod2c1d402013-03-12 11:30:04 -07003397
Tejun Heof147f292013-04-01 11:23:35 -07003398/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003399static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003400{
3401 struct workqueue_struct *wq = pwq->wq;
3402
3403 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003404
Tejun Heo1befcf32013-04-01 11:23:35 -07003405 /* may be called multiple times, ignore if already linked */
3406 if (!list_empty(&pwq->pwqs_node))
3407 return;
3408
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003409 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003410 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003411
3412 /* sync max_active to the current setting */
3413 pwq_adjust_max_active(pwq);
3414
3415 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003416 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003417}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003418
Tejun Heof147f292013-04-01 11:23:35 -07003419/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3420static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3421 const struct workqueue_attrs *attrs)
3422{
3423 struct worker_pool *pool;
3424 struct pool_workqueue *pwq;
3425
3426 lockdep_assert_held(&wq_pool_mutex);
3427
3428 pool = get_unbound_pool(attrs);
3429 if (!pool)
3430 return NULL;
3431
Tejun Heoe50aba92013-04-01 11:23:35 -07003432 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003433 if (!pwq) {
3434 put_unbound_pool(pool);
3435 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003436 }
Tejun Heo6029a912013-04-01 11:23:34 -07003437
Tejun Heof147f292013-04-01 11:23:35 -07003438 init_pwq(pwq, wq, pool);
3439 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003440}
3441
Tejun Heo4c16bd32013-04-01 11:23:36 -07003442/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003443 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003444 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003445 * @node: the target NUMA node
3446 * @cpu_going_down: if >= 0, the CPU to consider as offline
3447 * @cpumask: outarg, the resulting cpumask
3448 *
3449 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3450 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003451 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003452 *
3453 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3454 * enabled and @node has online CPUs requested by @attrs, the returned
3455 * cpumask is the intersection of the possible CPUs of @node and
3456 * @attrs->cpumask.
3457 *
3458 * The caller is responsible for ensuring that the cpumask of @node stays
3459 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003460 *
3461 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3462 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003463 */
3464static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3465 int cpu_going_down, cpumask_t *cpumask)
3466{
Tejun Heod55262c2013-04-01 11:23:38 -07003467 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003468 goto use_dfl;
3469
3470 /* does @node have any online CPUs @attrs wants? */
3471 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3472 if (cpu_going_down >= 0)
3473 cpumask_clear_cpu(cpu_going_down, cpumask);
3474
3475 if (cpumask_empty(cpumask))
3476 goto use_dfl;
3477
3478 /* yeap, return possible CPUs in @node that @attrs wants */
3479 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3480 return !cpumask_equal(cpumask, attrs->cpumask);
3481
3482use_dfl:
3483 cpumask_copy(cpumask, attrs->cpumask);
3484 return false;
3485}
3486
Tejun Heo1befcf32013-04-01 11:23:35 -07003487/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3488static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3489 int node,
3490 struct pool_workqueue *pwq)
3491{
3492 struct pool_workqueue *old_pwq;
3493
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003494 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003495 lockdep_assert_held(&wq->mutex);
3496
3497 /* link_pwq() can handle duplicate calls */
3498 link_pwq(pwq);
3499
3500 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3501 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3502 return old_pwq;
3503}
3504
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003505/* context to store the prepared attrs & pwqs before applying */
3506struct apply_wqattrs_ctx {
3507 struct workqueue_struct *wq; /* target workqueue */
3508 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003509 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003510 struct pool_workqueue *dfl_pwq;
3511 struct pool_workqueue *pwq_tbl[];
3512};
3513
3514/* free the resources after success or abort */
3515static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3516{
3517 if (ctx) {
3518 int node;
3519
3520 for_each_node(node)
3521 put_pwq_unlocked(ctx->pwq_tbl[node]);
3522 put_pwq_unlocked(ctx->dfl_pwq);
3523
3524 free_workqueue_attrs(ctx->attrs);
3525
3526 kfree(ctx);
3527 }
3528}
3529
3530/* allocate the attrs and pwqs for later installation */
3531static struct apply_wqattrs_ctx *
3532apply_wqattrs_prepare(struct workqueue_struct *wq,
3533 const struct workqueue_attrs *attrs)
3534{
3535 struct apply_wqattrs_ctx *ctx;
3536 struct workqueue_attrs *new_attrs, *tmp_attrs;
3537 int node;
3538
3539 lockdep_assert_held(&wq_pool_mutex);
3540
3541 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3542 GFP_KERNEL);
3543
3544 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3545 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3546 if (!ctx || !new_attrs || !tmp_attrs)
3547 goto out_free;
3548
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003549 /*
3550 * Calculate the attrs of the default pwq.
3551 * If the user configured cpumask doesn't overlap with the
3552 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3553 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003554 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003555 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003556 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3557 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003558
3559 /*
3560 * We may create multiple pwqs with differing cpumasks. Make a
3561 * copy of @new_attrs which will be modified and used to obtain
3562 * pools.
3563 */
3564 copy_workqueue_attrs(tmp_attrs, new_attrs);
3565
3566 /*
3567 * If something goes wrong during CPU up/down, we'll fall back to
3568 * the default pwq covering whole @attrs->cpumask. Always create
3569 * it even if we don't use it immediately.
3570 */
3571 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3572 if (!ctx->dfl_pwq)
3573 goto out_free;
3574
3575 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003576 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003577 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3578 if (!ctx->pwq_tbl[node])
3579 goto out_free;
3580 } else {
3581 ctx->dfl_pwq->refcnt++;
3582 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3583 }
3584 }
3585
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003586 /* save the user configured attrs and sanitize it. */
3587 copy_workqueue_attrs(new_attrs, attrs);
3588 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003589 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003590
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003591 ctx->wq = wq;
3592 free_workqueue_attrs(tmp_attrs);
3593 return ctx;
3594
3595out_free:
3596 free_workqueue_attrs(tmp_attrs);
3597 free_workqueue_attrs(new_attrs);
3598 apply_wqattrs_cleanup(ctx);
3599 return NULL;
3600}
3601
3602/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3603static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3604{
3605 int node;
3606
3607 /* all pwqs have been created successfully, let's install'em */
3608 mutex_lock(&ctx->wq->mutex);
3609
3610 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3611
3612 /* save the previous pwq and install the new one */
3613 for_each_node(node)
3614 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3615 ctx->pwq_tbl[node]);
3616
3617 /* @dfl_pwq might not have been used, ensure it's linked */
3618 link_pwq(ctx->dfl_pwq);
3619 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3620
3621 mutex_unlock(&ctx->wq->mutex);
3622}
3623
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003624/**
3625 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3626 * @wq: the target workqueue
3627 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3628 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003629 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3630 * machines, this function maps a separate pwq to each NUMA node with
3631 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3632 * NUMA node it was issued on. Older pwqs are released as in-flight work
3633 * items finish. Note that a work item which repeatedly requeues itself
3634 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003635 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003636 * Performs GFP_KERNEL allocations.
3637 *
3638 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003639 */
3640int apply_workqueue_attrs(struct workqueue_struct *wq,
3641 const struct workqueue_attrs *attrs)
3642{
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003643 struct apply_wqattrs_ctx *ctx;
3644 int ret = -ENOMEM;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003645
Tejun Heo8719dce2013-03-12 11:30:04 -07003646 /* only unbound workqueues can change attributes */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003647 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3648 return -EINVAL;
3649
Tejun Heo8719dce2013-03-12 11:30:04 -07003650 /* creating multiple pwqs breaks ordering guarantee */
3651 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3652 return -EINVAL;
3653
Tejun Heo4c16bd32013-04-01 11:23:36 -07003654 /*
3655 * CPUs should stay stable across pwq creations and installations.
3656 * Pin CPUs, determine the target cpumask for each node and create
3657 * pwqs accordingly.
3658 */
3659 get_online_cpus();
Tejun Heo4c16bd32013-04-01 11:23:36 -07003660 mutex_lock(&wq_pool_mutex);
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003661
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003662 ctx = apply_wqattrs_prepare(wq, attrs);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003663
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003664 /* the ctx has been prepared successfully, let's commit it */
3665 if (ctx) {
3666 apply_wqattrs_commit(ctx);
3667 ret = 0;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003668 }
3669
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003670 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003671 put_online_cpus();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003672
3673 apply_wqattrs_cleanup(ctx);
3674
Tejun Heo48621252013-04-01 11:23:31 -07003675 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003676}
3677
Tejun Heo4c16bd32013-04-01 11:23:36 -07003678/**
3679 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3680 * @wq: the target workqueue
3681 * @cpu: the CPU coming up or going down
3682 * @online: whether @cpu is coming up or going down
3683 *
3684 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3685 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3686 * @wq accordingly.
3687 *
3688 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3689 * falls back to @wq->dfl_pwq which may not be optimal but is always
3690 * correct.
3691 *
3692 * Note that when the last allowed CPU of a NUMA node goes offline for a
3693 * workqueue with a cpumask spanning multiple nodes, the workers which were
3694 * already executing the work items for the workqueue will lose their CPU
3695 * affinity and may execute on any CPU. This is similar to how per-cpu
3696 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3697 * affinity, it's the user's responsibility to flush the work item from
3698 * CPU_DOWN_PREPARE.
3699 */
3700static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3701 bool online)
3702{
3703 int node = cpu_to_node(cpu);
3704 int cpu_off = online ? -1 : cpu;
3705 struct pool_workqueue *old_pwq = NULL, *pwq;
3706 struct workqueue_attrs *target_attrs;
3707 cpumask_t *cpumask;
3708
3709 lockdep_assert_held(&wq_pool_mutex);
3710
3711 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
3712 return;
3713
3714 /*
3715 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3716 * Let's use a preallocated one. The following buf is protected by
3717 * CPU hotplug exclusion.
3718 */
3719 target_attrs = wq_update_unbound_numa_attrs_buf;
3720 cpumask = target_attrs->cpumask;
3721
3722 mutex_lock(&wq->mutex);
Tejun Heod55262c2013-04-01 11:23:38 -07003723 if (wq->unbound_attrs->no_numa)
3724 goto out_unlock;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003725
3726 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3727 pwq = unbound_pwq_by_node(wq, node);
3728
3729 /*
3730 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003731 * different from the default pwq's, we need to compare it to @pwq's
3732 * and create a new one if they don't match. If the target cpumask
3733 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003734 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003735 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003736 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
3737 goto out_unlock;
3738 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003739 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003740 }
3741
3742 mutex_unlock(&wq->mutex);
3743
3744 /* create a new pwq */
3745 pwq = alloc_unbound_pwq(wq, target_attrs);
3746 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003747 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3748 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003749 mutex_lock(&wq->mutex);
3750 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003751 }
3752
3753 /*
3754 * Install the new pwq. As this function is called only from CPU
3755 * hotplug callbacks and applying a new attrs is wrapped with
3756 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
3757 * inbetween.
3758 */
3759 mutex_lock(&wq->mutex);
3760 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3761 goto out_unlock;
3762
3763use_dfl_pwq:
3764 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3765 get_pwq(wq->dfl_pwq);
3766 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3767 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3768out_unlock:
3769 mutex_unlock(&wq->mutex);
3770 put_pwq_unlocked(old_pwq);
3771}
3772
Tejun Heo30cdf242013-03-12 11:29:57 -07003773static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003774{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003775 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003776 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003777
Tejun Heo30cdf242013-03-12 11:29:57 -07003778 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003779 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3780 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003781 return -ENOMEM;
3782
3783 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003784 struct pool_workqueue *pwq =
3785 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003786 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003787 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003788
Tejun Heof147f292013-04-01 11:23:35 -07003789 init_pwq(pwq, wq, &cpu_pools[highpri]);
3790
3791 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003792 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003793 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003794 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003795 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003796 } else if (wq->flags & __WQ_ORDERED) {
3797 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3798 /* there should only be single pwq for ordering guarantee */
3799 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3800 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3801 "ordering guarantee broken for workqueue %s\n", wq->name);
3802 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003803 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003804 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003805 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003806}
3807
Tejun Heof3421792010-07-02 10:03:51 +02003808static int wq_clamp_max_active(int max_active, unsigned int flags,
3809 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003810{
Tejun Heof3421792010-07-02 10:03:51 +02003811 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3812
3813 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003814 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3815 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003816
Tejun Heof3421792010-07-02 10:03:51 +02003817 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003818}
3819
Tejun Heob196be82012-01-10 15:11:35 -08003820struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003821 unsigned int flags,
3822 int max_active,
3823 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003824 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003825{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003826 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003827 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003828 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003829 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003830
Viresh Kumarcee22a12013-04-08 16:45:40 +05303831 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3832 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3833 flags |= WQ_UNBOUND;
3834
Tejun Heoecf68812013-04-01 11:23:34 -07003835 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003836 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003837 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003838
3839 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003840 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003841 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003842
Tejun Heo6029a912013-04-01 11:23:34 -07003843 if (flags & WQ_UNBOUND) {
3844 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3845 if (!wq->unbound_attrs)
3846 goto err_free_wq;
3847 }
3848
Tejun Heoecf68812013-04-01 11:23:34 -07003849 va_start(args, lock_name);
3850 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003851 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003852
Tejun Heod320c032010-06-29 10:07:14 +02003853 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003854 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003855
Tejun Heob196be82012-01-10 15:11:35 -08003856 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003857 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003858 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003859 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003860 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003861 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003862 INIT_LIST_HEAD(&wq->flusher_queue);
3863 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003864 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003865
Johannes Bergeb13ba82008-01-16 09:51:58 +01003866 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003867 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003868
Tejun Heo30cdf242013-03-12 11:29:57 -07003869 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07003870 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003871
Tejun Heo493008a2013-03-12 11:30:03 -07003872 /*
3873 * Workqueues which may be used during memory reclaim should
3874 * have a rescuer to guarantee forward progress.
3875 */
3876 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003877 struct worker *rescuer;
3878
Lai Jiangshanf7537df2014-07-15 17:24:15 +08003879 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003880 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07003881 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02003882
Tejun Heo111c2252013-01-17 17:16:24 -08003883 rescuer->rescue_wq = wq;
3884 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003885 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07003886 if (IS_ERR(rescuer->task)) {
3887 kfree(rescuer);
3888 goto err_destroy;
3889 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003890
Tejun Heod2c1d402013-03-12 11:30:04 -07003891 wq->rescuer = rescuer;
Tejun Heo14a40ff2013-03-19 13:45:20 -07003892 rescuer->task->flags |= PF_NO_SETAFFINITY;
Tejun Heoe22bee72010-06-29 10:07:14 +02003893 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003894 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003895
Tejun Heo226223a2013-03-12 11:30:05 -07003896 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3897 goto err_destroy;
3898
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003899 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003900 * wq_pool_mutex protects global freeze state and workqueues list.
3901 * Grab it, adjust max_active and add the new @wq to workqueues
3902 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003903 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003904 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003905
Lai Jiangshana357fc02013-03-25 16:57:19 -07003906 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003907 for_each_pwq(pwq, wq)
3908 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07003909 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003910
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003911 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003912
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003913 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02003914
Oleg Nesterov3af244332007-05-09 02:34:09 -07003915 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003916
3917err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07003918 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07003919 kfree(wq);
3920 return NULL;
3921err_destroy:
3922 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003923 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003924}
Tejun Heod320c032010-06-29 10:07:14 +02003925EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003926
3927/**
3928 * destroy_workqueue - safely terminate a workqueue
3929 * @wq: target workqueue
3930 *
3931 * Safely destroy a workqueue. All work currently pending will be done first.
3932 */
3933void destroy_workqueue(struct workqueue_struct *wq)
3934{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003935 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003936 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003937
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003938 /* drain it before proceeding with destruction */
3939 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003940
Tejun Heo6183c002013-03-12 11:29:57 -07003941 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003942 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07003943 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07003944 int i;
3945
Tejun Heo76af4d92013-03-12 11:30:00 -07003946 for (i = 0; i < WORK_NR_COLORS; i++) {
3947 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003948 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003949 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003950 }
3951 }
3952
Lai Jiangshan5c529592013-04-04 10:05:38 +08003953 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07003954 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07003955 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003956 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003957 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003958 }
Tejun Heo6183c002013-03-12 11:29:57 -07003959 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003960 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003961
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003962 /*
3963 * wq list is used to freeze wq, remove from list after
3964 * flushing is complete in case freeze races us.
3965 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003966 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003967 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003968 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003969
Tejun Heo226223a2013-03-12 11:30:05 -07003970 workqueue_sysfs_unregister(wq);
3971
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003972 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02003973 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02003974
Tejun Heo8864b4e2013-03-12 11:30:04 -07003975 if (!(wq->flags & WQ_UNBOUND)) {
3976 /*
3977 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003978 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003979 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003980 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003981 } else {
3982 /*
3983 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07003984 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
3985 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003986 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003987 for_each_node(node) {
3988 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3989 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
3990 put_pwq_unlocked(pwq);
3991 }
3992
3993 /*
3994 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
3995 * put. Don't access it afterwards.
3996 */
3997 pwq = wq->dfl_pwq;
3998 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07003999 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004000 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004001}
4002EXPORT_SYMBOL_GPL(destroy_workqueue);
4003
Tejun Heodcd989c2010-06-29 10:07:14 +02004004/**
4005 * workqueue_set_max_active - adjust max_active of a workqueue
4006 * @wq: target workqueue
4007 * @max_active: new max_active value.
4008 *
4009 * Set max_active of @wq to @max_active.
4010 *
4011 * CONTEXT:
4012 * Don't call from IRQ context.
4013 */
4014void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4015{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004016 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004017
Tejun Heo8719dce2013-03-12 11:30:04 -07004018 /* disallow meddling with max_active for ordered workqueues */
4019 if (WARN_ON(wq->flags & __WQ_ORDERED))
4020 return;
4021
Tejun Heof3421792010-07-02 10:03:51 +02004022 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004023
Lai Jiangshana357fc02013-03-25 16:57:19 -07004024 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004025
4026 wq->saved_max_active = max_active;
4027
Tejun Heo699ce092013-03-13 16:51:35 -07004028 for_each_pwq(pwq, wq)
4029 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004030
Lai Jiangshana357fc02013-03-25 16:57:19 -07004031 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004032}
4033EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4034
4035/**
Tejun Heoe6267612013-03-12 17:41:37 -07004036 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4037 *
4038 * Determine whether %current is a workqueue rescuer. Can be used from
4039 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004040 *
4041 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe6267612013-03-12 17:41:37 -07004042 */
4043bool current_is_workqueue_rescuer(void)
4044{
4045 struct worker *worker = current_wq_worker();
4046
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004047 return worker && worker->rescue_wq;
Tejun Heoe6267612013-03-12 17:41:37 -07004048}
4049
4050/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004051 * workqueue_congested - test whether a workqueue is congested
4052 * @cpu: CPU in question
4053 * @wq: target workqueue
4054 *
4055 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4056 * no synchronization around this function and the test result is
4057 * unreliable and only useful as advisory hints or for debugging.
4058 *
Tejun Heod3251852013-05-10 11:10:17 -07004059 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4060 * Note that both per-cpu and unbound workqueues may be associated with
4061 * multiple pool_workqueues which have separate congested states. A
4062 * workqueue being congested on one CPU doesn't mean the workqueue is also
4063 * contested on other CPUs / NUMA nodes.
4064 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004065 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004066 * %true if congested, %false otherwise.
4067 */
Tejun Heod84ff052013-03-12 11:29:59 -07004068bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004069{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004070 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004071 bool ret;
4072
Lai Jiangshan88109452013-03-20 03:28:10 +08004073 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004074
Tejun Heod3251852013-05-10 11:10:17 -07004075 if (cpu == WORK_CPU_UNBOUND)
4076 cpu = smp_processor_id();
4077
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004078 if (!(wq->flags & WQ_UNBOUND))
4079 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4080 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004081 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004082
Tejun Heo76af4d92013-03-12 11:30:00 -07004083 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004084 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004085
4086 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004087}
4088EXPORT_SYMBOL_GPL(workqueue_congested);
4089
4090/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004091 * work_busy - test whether a work is currently pending or running
4092 * @work: the work to be tested
4093 *
4094 * Test whether @work is currently pending or running. There is no
4095 * synchronization around this function and the test result is
4096 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004097 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004098 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004099 * OR'd bitmask of WORK_BUSY_* bits.
4100 */
4101unsigned int work_busy(struct work_struct *work)
4102{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004103 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004104 unsigned long flags;
4105 unsigned int ret = 0;
4106
Tejun Heodcd989c2010-06-29 10:07:14 +02004107 if (work_pending(work))
4108 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004109
Tejun Heofa1b54e2013-03-12 11:30:00 -07004110 local_irq_save(flags);
4111 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004112 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004113 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004114 if (find_worker_executing_work(pool, work))
4115 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004116 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004117 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004118 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004119
4120 return ret;
4121}
4122EXPORT_SYMBOL_GPL(work_busy);
4123
Tejun Heo3d1cb202013-04-30 15:27:22 -07004124/**
4125 * set_worker_desc - set description for the current work item
4126 * @fmt: printf-style format string
4127 * @...: arguments for the format string
4128 *
4129 * This function can be called by a running work function to describe what
4130 * the work item is about. If the worker task gets dumped, this
4131 * information will be printed out together to help debugging. The
4132 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4133 */
4134void set_worker_desc(const char *fmt, ...)
4135{
4136 struct worker *worker = current_wq_worker();
4137 va_list args;
4138
4139 if (worker) {
4140 va_start(args, fmt);
4141 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4142 va_end(args);
4143 worker->desc_valid = true;
4144 }
4145}
4146
4147/**
4148 * print_worker_info - print out worker information and description
4149 * @log_lvl: the log level to use when printing
4150 * @task: target task
4151 *
4152 * If @task is a worker and currently executing a work item, print out the
4153 * name of the workqueue being serviced and worker description set with
4154 * set_worker_desc() by the currently executing work item.
4155 *
4156 * This function can be safely called on any task as long as the
4157 * task_struct itself is accessible. While safe, this function isn't
4158 * synchronized and may print out mixups or garbages of limited length.
4159 */
4160void print_worker_info(const char *log_lvl, struct task_struct *task)
4161{
4162 work_func_t *fn = NULL;
4163 char name[WQ_NAME_LEN] = { };
4164 char desc[WORKER_DESC_LEN] = { };
4165 struct pool_workqueue *pwq = NULL;
4166 struct workqueue_struct *wq = NULL;
4167 bool desc_valid = false;
4168 struct worker *worker;
4169
4170 if (!(task->flags & PF_WQ_WORKER))
4171 return;
4172
4173 /*
4174 * This function is called without any synchronization and @task
4175 * could be in any state. Be careful with dereferences.
4176 */
4177 worker = probe_kthread_data(task);
4178
4179 /*
4180 * Carefully copy the associated workqueue's workfn and name. Keep
4181 * the original last '\0' in case the original contains garbage.
4182 */
4183 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4184 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4185 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4186 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4187
4188 /* copy worker description */
4189 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4190 if (desc_valid)
4191 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4192
4193 if (fn || name[0] || desc[0]) {
4194 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4195 if (desc[0])
4196 pr_cont(" (%s)", desc);
4197 pr_cont("\n");
4198 }
4199}
4200
Tejun Heo3494fc32015-03-09 09:22:28 -04004201static void pr_cont_pool_info(struct worker_pool *pool)
4202{
4203 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4204 if (pool->node != NUMA_NO_NODE)
4205 pr_cont(" node=%d", pool->node);
4206 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4207}
4208
4209static void pr_cont_work(bool comma, struct work_struct *work)
4210{
4211 if (work->func == wq_barrier_func) {
4212 struct wq_barrier *barr;
4213
4214 barr = container_of(work, struct wq_barrier, work);
4215
4216 pr_cont("%s BAR(%d)", comma ? "," : "",
4217 task_pid_nr(barr->task));
4218 } else {
4219 pr_cont("%s %pf", comma ? "," : "", work->func);
4220 }
4221}
4222
4223static void show_pwq(struct pool_workqueue *pwq)
4224{
4225 struct worker_pool *pool = pwq->pool;
4226 struct work_struct *work;
4227 struct worker *worker;
4228 bool has_in_flight = false, has_pending = false;
4229 int bkt;
4230
4231 pr_info(" pwq %d:", pool->id);
4232 pr_cont_pool_info(pool);
4233
4234 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4235 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4236
4237 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4238 if (worker->current_pwq == pwq) {
4239 has_in_flight = true;
4240 break;
4241 }
4242 }
4243 if (has_in_flight) {
4244 bool comma = false;
4245
4246 pr_info(" in-flight:");
4247 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4248 if (worker->current_pwq != pwq)
4249 continue;
4250
4251 pr_cont("%s %d%s:%pf", comma ? "," : "",
4252 task_pid_nr(worker->task),
4253 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4254 worker->current_func);
4255 list_for_each_entry(work, &worker->scheduled, entry)
4256 pr_cont_work(false, work);
4257 comma = true;
4258 }
4259 pr_cont("\n");
4260 }
4261
4262 list_for_each_entry(work, &pool->worklist, entry) {
4263 if (get_work_pwq(work) == pwq) {
4264 has_pending = true;
4265 break;
4266 }
4267 }
4268 if (has_pending) {
4269 bool comma = false;
4270
4271 pr_info(" pending:");
4272 list_for_each_entry(work, &pool->worklist, entry) {
4273 if (get_work_pwq(work) != pwq)
4274 continue;
4275
4276 pr_cont_work(comma, work);
4277 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4278 }
4279 pr_cont("\n");
4280 }
4281
4282 if (!list_empty(&pwq->delayed_works)) {
4283 bool comma = false;
4284
4285 pr_info(" delayed:");
4286 list_for_each_entry(work, &pwq->delayed_works, entry) {
4287 pr_cont_work(comma, work);
4288 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4289 }
4290 pr_cont("\n");
4291 }
4292}
4293
4294/**
4295 * show_workqueue_state - dump workqueue state
4296 *
4297 * Called from a sysrq handler and prints out all busy workqueues and
4298 * pools.
4299 */
4300void show_workqueue_state(void)
4301{
4302 struct workqueue_struct *wq;
4303 struct worker_pool *pool;
4304 unsigned long flags;
4305 int pi;
4306
4307 rcu_read_lock_sched();
4308
4309 pr_info("Showing busy workqueues and worker pools:\n");
4310
4311 list_for_each_entry_rcu(wq, &workqueues, list) {
4312 struct pool_workqueue *pwq;
4313 bool idle = true;
4314
4315 for_each_pwq(pwq, wq) {
4316 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4317 idle = false;
4318 break;
4319 }
4320 }
4321 if (idle)
4322 continue;
4323
4324 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4325
4326 for_each_pwq(pwq, wq) {
4327 spin_lock_irqsave(&pwq->pool->lock, flags);
4328 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4329 show_pwq(pwq);
4330 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4331 }
4332 }
4333
4334 for_each_pool(pool, pi) {
4335 struct worker *worker;
4336 bool first = true;
4337
4338 spin_lock_irqsave(&pool->lock, flags);
4339 if (pool->nr_workers == pool->nr_idle)
4340 goto next_pool;
4341
4342 pr_info("pool %d:", pool->id);
4343 pr_cont_pool_info(pool);
4344 pr_cont(" workers=%d", pool->nr_workers);
4345 if (pool->manager)
4346 pr_cont(" manager: %d",
4347 task_pid_nr(pool->manager->task));
4348 list_for_each_entry(worker, &pool->idle_list, entry) {
4349 pr_cont(" %s%d", first ? "idle: " : "",
4350 task_pid_nr(worker->task));
4351 first = false;
4352 }
4353 pr_cont("\n");
4354 next_pool:
4355 spin_unlock_irqrestore(&pool->lock, flags);
4356 }
4357
4358 rcu_read_unlock_sched();
4359}
4360
Tejun Heodb7bccf2010-06-29 10:07:12 +02004361/*
4362 * CPU hotplug.
4363 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004364 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004365 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004366 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004367 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004368 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004369 * blocked draining impractical.
4370 *
Tejun Heo24647572013-01-24 11:01:33 -08004371 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004372 * running as an unbound one and allowing it to be reattached later if the
4373 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004374 */
4375
Tejun Heo706026c2013-01-24 11:01:34 -08004376static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004377{
Tejun Heo38db41d2013-01-24 11:01:34 -08004378 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004379 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004380 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004381
Tejun Heof02ae732013-03-12 11:30:03 -07004382 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004383 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004384 spin_lock_irq(&pool->lock);
4385
4386 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004387 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004388 * unbound and set DISASSOCIATED. Before this, all workers
4389 * except for the ones which are still executing works from
4390 * before the last CPU down must be on the cpu. After
4391 * this, they may become diasporas.
4392 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004393 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004394 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004395
Tejun Heo24647572013-01-24 11:01:33 -08004396 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004397
Tejun Heo94cf58b2013-01-24 11:01:33 -08004398 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004399 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004400
Lai Jiangshaneb283422013-03-08 15:18:28 -08004401 /*
4402 * Call schedule() so that we cross rq->lock and thus can
4403 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4404 * This is necessary as scheduler callbacks may be invoked
4405 * from other cpus.
4406 */
4407 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004408
Lai Jiangshaneb283422013-03-08 15:18:28 -08004409 /*
4410 * Sched callbacks are disabled now. Zap nr_running.
4411 * After this, nr_running stays zero and need_more_worker()
4412 * and keep_working() are always true as long as the
4413 * worklist is not empty. This pool now behaves as an
4414 * unbound (in terms of concurrency management) pool which
4415 * are served by workers tied to the pool.
4416 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004417 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004418
4419 /*
4420 * With concurrency management just turned off, a busy
4421 * worker blocking could lead to lengthy stalls. Kick off
4422 * unbound chain execution of currently pending work items.
4423 */
4424 spin_lock_irq(&pool->lock);
4425 wake_up_worker(pool);
4426 spin_unlock_irq(&pool->lock);
4427 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004428}
4429
Tejun Heobd7c0892013-03-19 13:45:21 -07004430/**
4431 * rebind_workers - rebind all workers of a pool to the associated CPU
4432 * @pool: pool of interest
4433 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004434 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004435 */
4436static void rebind_workers(struct worker_pool *pool)
4437{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004438 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004439
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004440 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004441
Tejun Heoa9ab7752013-03-19 13:45:21 -07004442 /*
4443 * Restore CPU affinity of all workers. As all idle workers should
4444 * be on the run-queue of the associated CPU before any local
4445 * wake-ups for concurrency management happen, restore CPU affinty
4446 * of all workers first and then clear UNBOUND. As we're called
4447 * from CPU_ONLINE, the following shouldn't fail.
4448 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004449 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004450 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4451 pool->attrs->cpumask) < 0);
4452
4453 spin_lock_irq(&pool->lock);
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004454 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004455
Lai Jiangshanda028462014-05-20 17:46:31 +08004456 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004457 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004458
4459 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004460 * A bound idle worker should actually be on the runqueue
4461 * of the associated CPU for local wake-ups targeting it to
4462 * work. Kick all idle workers so that they migrate to the
4463 * associated CPU. Doing this in the same loop as
4464 * replacing UNBOUND with REBOUND is safe as no worker will
4465 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004466 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004467 if (worker_flags & WORKER_IDLE)
4468 wake_up_process(worker->task);
4469
4470 /*
4471 * We want to clear UNBOUND but can't directly call
4472 * worker_clr_flags() or adjust nr_running. Atomically
4473 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4474 * @worker will clear REBOUND using worker_clr_flags() when
4475 * it initiates the next execution cycle thus restoring
4476 * concurrency management. Note that when or whether
4477 * @worker clears REBOUND doesn't affect correctness.
4478 *
4479 * ACCESS_ONCE() is necessary because @worker->flags may be
4480 * tested without holding any lock in
4481 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4482 * fail incorrectly leading to premature concurrency
4483 * management operations.
4484 */
4485 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4486 worker_flags |= WORKER_REBOUND;
4487 worker_flags &= ~WORKER_UNBOUND;
4488 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004489 }
4490
Tejun Heoa9ab7752013-03-19 13:45:21 -07004491 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004492}
4493
Tejun Heo7dbc7252013-03-19 13:45:21 -07004494/**
4495 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4496 * @pool: unbound pool of interest
4497 * @cpu: the CPU which is coming up
4498 *
4499 * An unbound pool may end up with a cpumask which doesn't have any online
4500 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4501 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4502 * online CPU before, cpus_allowed of all its workers should be restored.
4503 */
4504static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4505{
4506 static cpumask_t cpumask;
4507 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004508
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004509 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004510
4511 /* is @cpu allowed for @pool? */
4512 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4513 return;
4514
4515 /* is @cpu the only online CPU? */
4516 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4517 if (cpumask_weight(&cpumask) != 1)
4518 return;
4519
4520 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004521 for_each_pool_worker(worker, pool)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004522 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4523 pool->attrs->cpumask) < 0);
4524}
4525
Tejun Heo8db25e72012-07-17 12:39:28 -07004526/*
4527 * Workqueues should be brought up before normal priority CPU notifiers.
4528 * This will be registered high priority CPU notifier.
4529 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004530static int workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004531 unsigned long action,
4532 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004533{
Tejun Heod84ff052013-03-12 11:29:59 -07004534 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004535 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004536 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004537 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004538
Tejun Heo8db25e72012-07-17 12:39:28 -07004539 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004540 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004541 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004542 if (pool->nr_workers)
4543 continue;
Lai Jiangshan051e1852014-07-22 13:03:02 +08004544 if (!create_worker(pool))
Tejun Heo3ce63372012-07-17 12:39:27 -07004545 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004546 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004547 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004548
Tejun Heo65758202012-07-17 12:39:26 -07004549 case CPU_DOWN_FAILED:
4550 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004551 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004552
4553 for_each_pool(pool, pi) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004554 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004555
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004556 if (pool->cpu == cpu)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004557 rebind_workers(pool);
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004558 else if (pool->cpu < 0)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004559 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004560
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004561 mutex_unlock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004562 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004563
Tejun Heo4c16bd32013-04-01 11:23:36 -07004564 /* update NUMA affinity of unbound workqueues */
4565 list_for_each_entry(wq, &workqueues, list)
4566 wq_update_unbound_numa(wq, cpu, true);
4567
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004568 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004569 break;
Tejun Heo65758202012-07-17 12:39:26 -07004570 }
4571 return NOTIFY_OK;
4572}
4573
4574/*
4575 * Workqueues should be brought down after normal priority CPU notifiers.
4576 * This will be registered as low priority CPU notifier.
4577 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004578static int workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004579 unsigned long action,
4580 void *hcpu)
4581{
Tejun Heod84ff052013-03-12 11:29:59 -07004582 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004583 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004584 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004585
Tejun Heo65758202012-07-17 12:39:26 -07004586 switch (action & ~CPU_TASKS_FROZEN) {
4587 case CPU_DOWN_PREPARE:
Tejun Heo4c16bd32013-04-01 11:23:36 -07004588 /* unbinding per-cpu workers should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004589 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004590 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004591
4592 /* update NUMA affinity of unbound workqueues */
4593 mutex_lock(&wq_pool_mutex);
4594 list_for_each_entry(wq, &workqueues, list)
4595 wq_update_unbound_numa(wq, cpu, false);
4596 mutex_unlock(&wq_pool_mutex);
4597
4598 /* wait for per-cpu unbinding to finish */
Tejun Heo8db25e72012-07-17 12:39:28 -07004599 flush_work(&unbind_work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004600 destroy_work_on_stack(&unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004601 break;
Tejun Heo65758202012-07-17 12:39:26 -07004602 }
4603 return NOTIFY_OK;
4604}
4605
Rusty Russell2d3854a2008-11-05 13:39:10 +11004606#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004607
Rusty Russell2d3854a2008-11-05 13:39:10 +11004608struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004609 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004610 long (*fn)(void *);
4611 void *arg;
4612 long ret;
4613};
4614
Tejun Heoed48ece2012-09-18 12:48:43 -07004615static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004616{
Tejun Heoed48ece2012-09-18 12:48:43 -07004617 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4618
Rusty Russell2d3854a2008-11-05 13:39:10 +11004619 wfc->ret = wfc->fn(wfc->arg);
4620}
4621
4622/**
4623 * work_on_cpu - run a function in user context on a particular cpu
4624 * @cpu: the cpu to run on
4625 * @fn: the function to run
4626 * @arg: the function arg
4627 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004628 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06004629 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004630 *
4631 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004632 */
Tejun Heod84ff052013-03-12 11:29:59 -07004633long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004634{
Tejun Heoed48ece2012-09-18 12:48:43 -07004635 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004636
Tejun Heoed48ece2012-09-18 12:48:43 -07004637 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4638 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004639 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004640 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004641 return wfc.ret;
4642}
4643EXPORT_SYMBOL_GPL(work_on_cpu);
4644#endif /* CONFIG_SMP */
4645
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004646#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304647
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004648/**
4649 * freeze_workqueues_begin - begin freezing workqueues
4650 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004651 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004652 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004653 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004654 *
4655 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004656 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004657 */
4658void freeze_workqueues_begin(void)
4659{
Tejun Heo24b8a842013-03-12 11:29:58 -07004660 struct workqueue_struct *wq;
4661 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004662
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004663 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004664
Tejun Heo6183c002013-03-12 11:29:57 -07004665 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004666 workqueue_freezing = true;
4667
Tejun Heo24b8a842013-03-12 11:29:58 -07004668 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004669 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004670 for_each_pwq(pwq, wq)
4671 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004672 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004673 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004674
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004675 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004676}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004677
4678/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004679 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004680 *
4681 * Check whether freezing is complete. This function must be called
4682 * between freeze_workqueues_begin() and thaw_workqueues().
4683 *
4684 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004685 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004686 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004687 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004688 * %true if some freezable workqueues are still busy. %false if freezing
4689 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004690 */
4691bool freeze_workqueues_busy(void)
4692{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004693 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004694 struct workqueue_struct *wq;
4695 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004696
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004697 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004698
Tejun Heo6183c002013-03-12 11:29:57 -07004699 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004700
Tejun Heo24b8a842013-03-12 11:29:58 -07004701 list_for_each_entry(wq, &workqueues, list) {
4702 if (!(wq->flags & WQ_FREEZABLE))
4703 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004704 /*
4705 * nr_active is monotonically decreasing. It's safe
4706 * to peek without lock.
4707 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004708 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004709 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004710 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004711 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004712 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004713 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004714 goto out_unlock;
4715 }
4716 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004717 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004718 }
4719out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004720 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004721 return busy;
4722}
4723
4724/**
4725 * thaw_workqueues - thaw workqueues
4726 *
4727 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004728 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004729 *
4730 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004731 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004732 */
4733void thaw_workqueues(void)
4734{
Tejun Heo24b8a842013-03-12 11:29:58 -07004735 struct workqueue_struct *wq;
4736 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004737
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004738 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004739
4740 if (!workqueue_freezing)
4741 goto out_unlock;
4742
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004743 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004744
Tejun Heo24b8a842013-03-12 11:29:58 -07004745 /* restore max_active and repopulate worklist */
4746 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004747 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004748 for_each_pwq(pwq, wq)
4749 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004750 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004751 }
4752
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004753out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004754 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004755}
4756#endif /* CONFIG_FREEZER */
4757
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004758static int workqueue_apply_unbound_cpumask(void)
4759{
4760 LIST_HEAD(ctxs);
4761 int ret = 0;
4762 struct workqueue_struct *wq;
4763 struct apply_wqattrs_ctx *ctx, *n;
4764
4765 lockdep_assert_held(&wq_pool_mutex);
4766
4767 list_for_each_entry(wq, &workqueues, list) {
4768 if (!(wq->flags & WQ_UNBOUND))
4769 continue;
4770 /* creating multiple pwqs breaks ordering guarantee */
4771 if (wq->flags & __WQ_ORDERED)
4772 continue;
4773
4774 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4775 if (!ctx) {
4776 ret = -ENOMEM;
4777 break;
4778 }
4779
4780 list_add_tail(&ctx->list, &ctxs);
4781 }
4782
4783 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4784 if (!ret)
4785 apply_wqattrs_commit(ctx);
4786 apply_wqattrs_cleanup(ctx);
4787 }
4788
4789 return ret;
4790}
4791
4792/**
4793 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4794 * @cpumask: the cpumask to set
4795 *
4796 * The low-level workqueues cpumask is a global cpumask that limits
4797 * the affinity of all unbound workqueues. This function check the @cpumask
4798 * and apply it to all unbound workqueues and updates all pwqs of them.
4799 *
4800 * Retun: 0 - Success
4801 * -EINVAL - Invalid @cpumask
4802 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4803 */
4804int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4805{
4806 int ret = -EINVAL;
4807 cpumask_var_t saved_cpumask;
4808
4809 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4810 return -ENOMEM;
4811
4812 get_online_cpus();
4813 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4814 if (!cpumask_empty(cpumask)) {
4815 mutex_lock(&wq_pool_mutex);
4816
4817 /* save the old wq_unbound_cpumask. */
4818 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4819
4820 /* update wq_unbound_cpumask at first and apply it to wqs. */
4821 cpumask_copy(wq_unbound_cpumask, cpumask);
4822 ret = workqueue_apply_unbound_cpumask();
4823
4824 /* restore the wq_unbound_cpumask when failed. */
4825 if (ret < 0)
4826 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4827
4828 mutex_unlock(&wq_pool_mutex);
4829 }
4830 put_online_cpus();
4831
4832 free_cpumask_var(saved_cpumask);
4833 return ret;
4834}
4835
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004836#ifdef CONFIG_SYSFS
4837/*
4838 * Workqueues with WQ_SYSFS flag set is visible to userland via
4839 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4840 * following attributes.
4841 *
4842 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4843 * max_active RW int : maximum number of in-flight work items
4844 *
4845 * Unbound workqueues have the following extra attributes.
4846 *
4847 * id RO int : the associated pool ID
4848 * nice RW int : nice value of the workers
4849 * cpumask RW mask : bitmask of allowed CPUs for the workers
4850 */
4851struct wq_device {
4852 struct workqueue_struct *wq;
4853 struct device dev;
4854};
4855
4856static struct workqueue_struct *dev_to_wq(struct device *dev)
4857{
4858 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
4859
4860 return wq_dev->wq;
4861}
4862
4863static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
4864 char *buf)
4865{
4866 struct workqueue_struct *wq = dev_to_wq(dev);
4867
4868 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
4869}
4870static DEVICE_ATTR_RO(per_cpu);
4871
4872static ssize_t max_active_show(struct device *dev,
4873 struct device_attribute *attr, char *buf)
4874{
4875 struct workqueue_struct *wq = dev_to_wq(dev);
4876
4877 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
4878}
4879
4880static ssize_t max_active_store(struct device *dev,
4881 struct device_attribute *attr, const char *buf,
4882 size_t count)
4883{
4884 struct workqueue_struct *wq = dev_to_wq(dev);
4885 int val;
4886
4887 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
4888 return -EINVAL;
4889
4890 workqueue_set_max_active(wq, val);
4891 return count;
4892}
4893static DEVICE_ATTR_RW(max_active);
4894
4895static struct attribute *wq_sysfs_attrs[] = {
4896 &dev_attr_per_cpu.attr,
4897 &dev_attr_max_active.attr,
4898 NULL,
4899};
4900ATTRIBUTE_GROUPS(wq_sysfs);
4901
4902static ssize_t wq_pool_ids_show(struct device *dev,
4903 struct device_attribute *attr, char *buf)
4904{
4905 struct workqueue_struct *wq = dev_to_wq(dev);
4906 const char *delim = "";
4907 int node, written = 0;
4908
4909 rcu_read_lock_sched();
4910 for_each_node(node) {
4911 written += scnprintf(buf + written, PAGE_SIZE - written,
4912 "%s%d:%d", delim, node,
4913 unbound_pwq_by_node(wq, node)->pool->id);
4914 delim = " ";
4915 }
4916 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
4917 rcu_read_unlock_sched();
4918
4919 return written;
4920}
4921
4922static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
4923 char *buf)
4924{
4925 struct workqueue_struct *wq = dev_to_wq(dev);
4926 int written;
4927
4928 mutex_lock(&wq->mutex);
4929 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
4930 mutex_unlock(&wq->mutex);
4931
4932 return written;
4933}
4934
4935/* prepare workqueue_attrs for sysfs store operations */
4936static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
4937{
4938 struct workqueue_attrs *attrs;
4939
4940 attrs = alloc_workqueue_attrs(GFP_KERNEL);
4941 if (!attrs)
4942 return NULL;
4943
4944 mutex_lock(&wq->mutex);
4945 copy_workqueue_attrs(attrs, wq->unbound_attrs);
4946 mutex_unlock(&wq->mutex);
4947 return attrs;
4948}
4949
4950static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
4951 const char *buf, size_t count)
4952{
4953 struct workqueue_struct *wq = dev_to_wq(dev);
4954 struct workqueue_attrs *attrs;
4955 int ret;
4956
4957 attrs = wq_sysfs_prep_attrs(wq);
4958 if (!attrs)
4959 return -ENOMEM;
4960
4961 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
4962 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
4963 ret = apply_workqueue_attrs(wq, attrs);
4964 else
4965 ret = -EINVAL;
4966
4967 free_workqueue_attrs(attrs);
4968 return ret ?: count;
4969}
4970
4971static ssize_t wq_cpumask_show(struct device *dev,
4972 struct device_attribute *attr, char *buf)
4973{
4974 struct workqueue_struct *wq = dev_to_wq(dev);
4975 int written;
4976
4977 mutex_lock(&wq->mutex);
4978 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
4979 cpumask_pr_args(wq->unbound_attrs->cpumask));
4980 mutex_unlock(&wq->mutex);
4981 return written;
4982}
4983
4984static ssize_t wq_cpumask_store(struct device *dev,
4985 struct device_attribute *attr,
4986 const char *buf, size_t count)
4987{
4988 struct workqueue_struct *wq = dev_to_wq(dev);
4989 struct workqueue_attrs *attrs;
4990 int ret;
4991
4992 attrs = wq_sysfs_prep_attrs(wq);
4993 if (!attrs)
4994 return -ENOMEM;
4995
4996 ret = cpumask_parse(buf, attrs->cpumask);
4997 if (!ret)
4998 ret = apply_workqueue_attrs(wq, attrs);
4999
5000 free_workqueue_attrs(attrs);
5001 return ret ?: count;
5002}
5003
5004static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5005 char *buf)
5006{
5007 struct workqueue_struct *wq = dev_to_wq(dev);
5008 int written;
5009
5010 mutex_lock(&wq->mutex);
5011 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5012 !wq->unbound_attrs->no_numa);
5013 mutex_unlock(&wq->mutex);
5014
5015 return written;
5016}
5017
5018static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5019 const char *buf, size_t count)
5020{
5021 struct workqueue_struct *wq = dev_to_wq(dev);
5022 struct workqueue_attrs *attrs;
5023 int v, ret;
5024
5025 attrs = wq_sysfs_prep_attrs(wq);
5026 if (!attrs)
5027 return -ENOMEM;
5028
5029 ret = -EINVAL;
5030 if (sscanf(buf, "%d", &v) == 1) {
5031 attrs->no_numa = !v;
5032 ret = apply_workqueue_attrs(wq, attrs);
5033 }
5034
5035 free_workqueue_attrs(attrs);
5036 return ret ?: count;
5037}
5038
5039static struct device_attribute wq_sysfs_unbound_attrs[] = {
5040 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5041 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5042 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5043 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5044 __ATTR_NULL,
5045};
5046
5047static struct bus_type wq_subsys = {
5048 .name = "workqueue",
5049 .dev_groups = wq_sysfs_groups,
5050};
5051
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005052static ssize_t wq_unbound_cpumask_show(struct device *dev,
5053 struct device_attribute *attr, char *buf)
5054{
5055 int written;
5056
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005057 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005058 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5059 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005060 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005061
5062 return written;
5063}
5064
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005065static ssize_t wq_unbound_cpumask_store(struct device *dev,
5066 struct device_attribute *attr, const char *buf, size_t count)
5067{
5068 cpumask_var_t cpumask;
5069 int ret;
5070
5071 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5072 return -ENOMEM;
5073
5074 ret = cpumask_parse(buf, cpumask);
5075 if (!ret)
5076 ret = workqueue_set_unbound_cpumask(cpumask);
5077
5078 free_cpumask_var(cpumask);
5079 return ret ? ret : count;
5080}
5081
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005082static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005083 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5084 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005085
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005086static int __init wq_sysfs_init(void)
5087{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005088 int err;
5089
5090 err = subsys_virtual_register(&wq_subsys, NULL);
5091 if (err)
5092 return err;
5093
5094 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005095}
5096core_initcall(wq_sysfs_init);
5097
5098static void wq_device_release(struct device *dev)
5099{
5100 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5101
5102 kfree(wq_dev);
5103}
5104
5105/**
5106 * workqueue_sysfs_register - make a workqueue visible in sysfs
5107 * @wq: the workqueue to register
5108 *
5109 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5110 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5111 * which is the preferred method.
5112 *
5113 * Workqueue user should use this function directly iff it wants to apply
5114 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5115 * apply_workqueue_attrs() may race against userland updating the
5116 * attributes.
5117 *
5118 * Return: 0 on success, -errno on failure.
5119 */
5120int workqueue_sysfs_register(struct workqueue_struct *wq)
5121{
5122 struct wq_device *wq_dev;
5123 int ret;
5124
5125 /*
5126 * Adjusting max_active or creating new pwqs by applyting
5127 * attributes breaks ordering guarantee. Disallow exposing ordered
5128 * workqueues.
5129 */
5130 if (WARN_ON(wq->flags & __WQ_ORDERED))
5131 return -EINVAL;
5132
5133 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5134 if (!wq_dev)
5135 return -ENOMEM;
5136
5137 wq_dev->wq = wq;
5138 wq_dev->dev.bus = &wq_subsys;
5139 wq_dev->dev.init_name = wq->name;
5140 wq_dev->dev.release = wq_device_release;
5141
5142 /*
5143 * unbound_attrs are created separately. Suppress uevent until
5144 * everything is ready.
5145 */
5146 dev_set_uevent_suppress(&wq_dev->dev, true);
5147
5148 ret = device_register(&wq_dev->dev);
5149 if (ret) {
5150 kfree(wq_dev);
5151 wq->wq_dev = NULL;
5152 return ret;
5153 }
5154
5155 if (wq->flags & WQ_UNBOUND) {
5156 struct device_attribute *attr;
5157
5158 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5159 ret = device_create_file(&wq_dev->dev, attr);
5160 if (ret) {
5161 device_unregister(&wq_dev->dev);
5162 wq->wq_dev = NULL;
5163 return ret;
5164 }
5165 }
5166 }
5167
5168 dev_set_uevent_suppress(&wq_dev->dev, false);
5169 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5170 return 0;
5171}
5172
5173/**
5174 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5175 * @wq: the workqueue to unregister
5176 *
5177 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5178 */
5179static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5180{
5181 struct wq_device *wq_dev = wq->wq_dev;
5182
5183 if (!wq->wq_dev)
5184 return;
5185
5186 wq->wq_dev = NULL;
5187 device_unregister(&wq_dev->dev);
5188}
5189#else /* CONFIG_SYSFS */
5190static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5191#endif /* CONFIG_SYSFS */
5192
Tejun Heobce90382013-04-01 11:23:32 -07005193static void __init wq_numa_init(void)
5194{
5195 cpumask_var_t *tbl;
5196 int node, cpu;
5197
Tejun Heobce90382013-04-01 11:23:32 -07005198 if (num_possible_nodes() <= 1)
5199 return;
5200
Tejun Heod55262c2013-04-01 11:23:38 -07005201 if (wq_disable_numa) {
5202 pr_info("workqueue: NUMA affinity support disabled\n");
5203 return;
5204 }
5205
Tejun Heo4c16bd32013-04-01 11:23:36 -07005206 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5207 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5208
Tejun Heobce90382013-04-01 11:23:32 -07005209 /*
5210 * We want masks of possible CPUs of each node which isn't readily
5211 * available. Build one from cpu_to_node() which should have been
5212 * fully initialized by now.
5213 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005214 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005215 BUG_ON(!tbl);
5216
5217 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005218 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005219 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005220
5221 for_each_possible_cpu(cpu) {
5222 node = cpu_to_node(cpu);
5223 if (WARN_ON(node == NUMA_NO_NODE)) {
5224 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5225 /* happens iff arch is bonkers, let's just proceed */
5226 return;
5227 }
5228 cpumask_set_cpu(cpu, tbl[node]);
5229 }
5230
5231 wq_numa_possible_cpumask = tbl;
5232 wq_numa_enabled = true;
5233}
5234
Suresh Siddha6ee05782010-07-30 14:57:37 -07005235static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005236{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005237 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5238 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005239
Tejun Heoe904e6c2013-03-12 11:29:57 -07005240 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5241
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005242 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5243 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5244
Tejun Heoe904e6c2013-03-12 11:29:57 -07005245 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5246
Tejun Heo65758202012-07-17 12:39:26 -07005247 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07005248 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02005249
Tejun Heobce90382013-04-01 11:23:32 -07005250 wq_numa_init();
5251
Tejun Heo706026c2013-01-24 11:01:34 -08005252 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005253 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005254 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005255
Tejun Heo7a4e3442013-03-12 11:30:00 -07005256 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005257 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005258 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005259 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005260 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005261 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005262 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005263
Tejun Heo9daf9e62013-01-24 11:01:33 -08005264 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005265 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005266 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005267 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005268 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005269 }
5270
Tejun Heoe22bee72010-06-29 10:07:14 +02005271 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07005272 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005273 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02005274
Tejun Heof02ae732013-03-12 11:30:03 -07005275 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07005276 pool->flags &= ~POOL_DISASSOCIATED;
Lai Jiangshan051e1852014-07-22 13:03:02 +08005277 BUG_ON(!create_worker(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07005278 }
Tejun Heoe22bee72010-06-29 10:07:14 +02005279 }
5280
Tejun Heo8a2b7532013-09-05 12:30:04 -04005281 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005282 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5283 struct workqueue_attrs *attrs;
5284
5285 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005286 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005287 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005288
5289 /*
5290 * An ordered wq should have only one pwq as ordering is
5291 * guaranteed by max_active which is enforced by pwqs.
5292 * Turn off NUMA so that dfl_pwq is used for all nodes.
5293 */
5294 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5295 attrs->nice = std_nice[i];
5296 attrs->no_numa = true;
5297 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005298 }
5299
Tejun Heod320c032010-06-29 10:07:14 +02005300 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005301 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005302 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005303 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5304 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005305 system_freezable_wq = alloc_workqueue("events_freezable",
5306 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305307 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5308 WQ_POWER_EFFICIENT, 0);
5309 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5310 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5311 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005312 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305313 !system_unbound_wq || !system_freezable_wq ||
5314 !system_power_efficient_wq ||
5315 !system_freezable_power_efficient_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07005316 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005317}
Suresh Siddha6ee05782010-07-30 14:57:37 -07005318early_initcall(init_workqueues);