blob: dd243ce33a89c377bbe62c7147aa1b5938fc3332 [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 Jiangshan3c25a552013-03-25 16:57:17 -0700130 * WQ: wq->mutex protected.
131 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700132 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700133 *
134 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200135 */
136
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800137/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200138
Tejun Heobd7bdd42012-07-12 14:46:37 -0700139struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800140 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700141 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700142 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800143 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700144 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700145
146 struct list_head worklist; /* L: list of pending works */
147 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700148
149 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700150 int nr_idle; /* L: currently idle ones */
151
152 struct list_head idle_list; /* X: list of idle workers */
153 struct timer_list idle_timer; /* L: worker idle timeout */
154 struct timer_list mayday_timer; /* L: SOS timer for workers */
155
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700156 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800157 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
158 /* L: hash of busy workers */
159
Tejun Heobc3a1af2013-03-13 19:47:39 -0700160 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo34a06bd2013-03-12 11:30:00 -0700161 struct mutex manager_arb; /* manager arbitration */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400162 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800163 struct mutex attach_mutex; /* attach/detach exclusion */
164 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800165 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800166
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800167 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800168
Tejun Heo7a4e3442013-03-12 11:30:00 -0700169 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700170 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
171 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700172
Tejun Heoe19e3972013-01-24 11:39:44 -0800173 /*
174 * The current concurrency level. As it's likely to be accessed
175 * from other CPUs during try_to_wake_up(), put it in a separate
176 * cacheline.
177 */
178 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700179
180 /*
181 * Destruction of pool is sched-RCU protected to allow dereferences
182 * from get_work_pool().
183 */
184 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200185} ____cacheline_aligned_in_smp;
186
187/*
Tejun Heo112202d2013-02-13 19:29:12 -0800188 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
189 * of work_struct->data are used for flags and the remaining high bits
190 * point to the pwq; thus, pwqs need to be aligned at two's power of the
191 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 */
Tejun Heo112202d2013-02-13 19:29:12 -0800193struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700194 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200195 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200196 int work_color; /* L: current color */
197 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700198 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200199 int nr_in_flight[WORK_NR_COLORS];
200 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200201 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200202 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200203 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700204 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700205 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700206
207 /*
208 * Release of unbound pwq is punted to system_wq. See put_pwq()
209 * and pwq_unbound_release_workfn() for details. pool_workqueue
210 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700211 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700212 */
213 struct work_struct unbound_release_work;
214 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700215} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200218 * Structure used to wait for workqueue flush.
219 */
220struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700221 struct list_head list; /* WQ: list of flushers */
222 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200223 struct completion done; /* flush completion */
224};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Tejun Heo226223a2013-03-12 11:30:05 -0700226struct wq_device;
227
Tejun Heo73f53c42010-06-29 10:07:11 +0200228/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700229 * The externally visible workqueue. It relays the issued work items to
230 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 */
232struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700233 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400234 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200235
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700236 struct mutex mutex; /* protects this wq */
237 int work_color; /* WQ: current work color */
238 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800239 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700240 struct wq_flusher *first_flusher; /* WQ: first flusher */
241 struct list_head flusher_queue; /* WQ: flush waiters */
242 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200243
Tejun Heo2e109a22013-03-13 19:47:40 -0700244 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200245 struct worker *rescuer; /* I: rescue worker */
246
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700247 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700248 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700249
Tejun Heo6029a912013-04-01 11:23:34 -0700250 struct workqueue_attrs *unbound_attrs; /* WQ: only for unbound wqs */
Tejun Heo4c16bd32013-04-01 11:23:36 -0700251 struct pool_workqueue *dfl_pwq; /* WQ: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700252
Tejun Heo226223a2013-03-12 11:30:05 -0700253#ifdef CONFIG_SYSFS
254 struct wq_device *wq_dev; /* I: for sysfs interface */
255#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700256#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200257 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700258#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700259 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700260
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400261 /*
262 * Destruction of workqueue_struct is sched-RCU protected to allow
263 * walking the workqueues list without grabbing wq_pool_mutex.
264 * This is used to dump all workqueues from sysrq.
265 */
266 struct rcu_head rcu;
267
Tejun Heo2728fd22013-04-01 11:23:35 -0700268 /* hot fields used during command issue, aligned to cacheline */
269 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
270 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700271 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272};
273
Tejun Heoe904e6c2013-03-12 11:29:57 -0700274static struct kmem_cache *pwq_cache;
275
Tejun Heobce90382013-04-01 11:23:32 -0700276static cpumask_var_t *wq_numa_possible_cpumask;
277 /* possible CPUs of each node */
278
Tejun Heod55262c2013-04-01 11:23:38 -0700279static bool wq_disable_numa;
280module_param_named(disable_numa, wq_disable_numa, bool, 0444);
281
Viresh Kumarcee22a12013-04-08 16:45:40 +0530282/* see the comment above the definition of WQ_POWER_EFFICIENT */
283#ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT
284static bool wq_power_efficient = true;
285#else
286static bool wq_power_efficient;
287#endif
288
289module_param_named(power_efficient, wq_power_efficient, bool, 0444);
290
Tejun Heobce90382013-04-01 11:23:32 -0700291static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
292
Tejun Heo4c16bd32013-04-01 11:23:36 -0700293/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
294static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
295
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700296static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700297static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo5bcab332013-03-13 19:47:40 -0700298
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400299static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700300static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700301
Lai Jiangshan042f7df2015-04-30 17:16:12 +0800302static cpumask_var_t wq_unbound_cpumask; /* PL: low level cpumask for all unbound wqs */
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800303
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700304/* the per-cpu worker pools */
305static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
306 cpu_worker_pools);
307
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700308static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700309
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700310/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700311static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
312
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700313/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700314static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
315
Tejun Heo8a2b7532013-09-05 12:30:04 -0400316/* I: attributes used when instantiating ordered pools on demand */
317static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
318
Tejun Heod320c032010-06-29 10:07:14 +0200319struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400320EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300321struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900322EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300323struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200324EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300325struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200326EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300327struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100328EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530329struct workqueue_struct *system_power_efficient_wq __read_mostly;
330EXPORT_SYMBOL_GPL(system_power_efficient_wq);
331struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
332EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200333
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700334static int worker_thread(void *__worker);
335static void copy_workqueue_attrs(struct workqueue_attrs *to,
336 const struct workqueue_attrs *from);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800337static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700338
Tejun Heo97bd2342010-10-05 10:41:14 +0200339#define CREATE_TRACE_POINTS
340#include <trace/events/workqueue.h>
341
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700342#define assert_rcu_or_pool_mutex() \
Tejun Heo5bcab332013-03-13 19:47:40 -0700343 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700344 lockdep_is_held(&wq_pool_mutex), \
345 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700346
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700347#define assert_rcu_or_wq_mutex(wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700348 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshanb5927602013-03-25 16:57:19 -0700349 lockdep_is_held(&wq->mutex), \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700350 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700351
Tejun Heof02ae732013-03-12 11:30:03 -0700352#define for_each_cpu_worker_pool(pool, cpu) \
353 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
354 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700355 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700356
Tejun Heo49e3cf42013-03-12 11:29:58 -0700357/**
Tejun Heo17116962013-03-12 11:29:58 -0700358 * for_each_pool - iterate through all worker_pools in the system
359 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700360 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700361 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700362 * This must be called either with wq_pool_mutex held or sched RCU read
363 * locked. If the pool needs to be used beyond the locking in effect, the
364 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700365 *
366 * The if/else clause exists only for the lockdep assertion and can be
367 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700368 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700369#define for_each_pool(pool, pi) \
370 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700371 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700372 else
Tejun Heo17116962013-03-12 11:29:58 -0700373
374/**
Tejun Heo822d8402013-03-19 13:45:21 -0700375 * for_each_pool_worker - iterate through all workers of a worker_pool
376 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700377 * @pool: worker_pool to iterate workers of
378 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800379 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700380 *
381 * The if/else clause exists only for the lockdep assertion and can be
382 * ignored.
383 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800384#define for_each_pool_worker(worker, pool) \
385 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800386 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700387 else
388
389/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700390 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
391 * @pwq: iteration cursor
392 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700393 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700394 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700395 * If the pwq needs to be used beyond the locking in effect, the caller is
396 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700397 *
398 * The if/else clause exists only for the lockdep assertion and can be
399 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700400 */
401#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700402 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700403 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700404 else
Tejun Heof3421792010-07-02 10:03:51 +0200405
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900406#ifdef CONFIG_DEBUG_OBJECTS_WORK
407
408static struct debug_obj_descr work_debug_descr;
409
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100410static void *work_debug_hint(void *addr)
411{
412 return ((struct work_struct *) addr)->func;
413}
414
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900415/*
416 * fixup_init is called when:
417 * - an active object is initialized
418 */
419static int work_fixup_init(void *addr, enum debug_obj_state state)
420{
421 struct work_struct *work = addr;
422
423 switch (state) {
424 case ODEBUG_STATE_ACTIVE:
425 cancel_work_sync(work);
426 debug_object_init(work, &work_debug_descr);
427 return 1;
428 default:
429 return 0;
430 }
431}
432
433/*
434 * fixup_activate is called when:
435 * - an active object is activated
436 * - an unknown object is activated (might be a statically initialized object)
437 */
438static int work_fixup_activate(void *addr, enum debug_obj_state state)
439{
440 struct work_struct *work = addr;
441
442 switch (state) {
443
444 case ODEBUG_STATE_NOTAVAILABLE:
445 /*
446 * This is not really a fixup. The work struct was
447 * statically initialized. We just make sure that it
448 * is tracked in the object tracker.
449 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200450 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900451 debug_object_init(work, &work_debug_descr);
452 debug_object_activate(work, &work_debug_descr);
453 return 0;
454 }
455 WARN_ON_ONCE(1);
456 return 0;
457
458 case ODEBUG_STATE_ACTIVE:
459 WARN_ON(1);
460
461 default:
462 return 0;
463 }
464}
465
466/*
467 * fixup_free is called when:
468 * - an active object is freed
469 */
470static int work_fixup_free(void *addr, enum debug_obj_state state)
471{
472 struct work_struct *work = addr;
473
474 switch (state) {
475 case ODEBUG_STATE_ACTIVE:
476 cancel_work_sync(work);
477 debug_object_free(work, &work_debug_descr);
478 return 1;
479 default:
480 return 0;
481 }
482}
483
484static struct debug_obj_descr work_debug_descr = {
485 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100486 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900487 .fixup_init = work_fixup_init,
488 .fixup_activate = work_fixup_activate,
489 .fixup_free = work_fixup_free,
490};
491
492static inline void debug_work_activate(struct work_struct *work)
493{
494 debug_object_activate(work, &work_debug_descr);
495}
496
497static inline void debug_work_deactivate(struct work_struct *work)
498{
499 debug_object_deactivate(work, &work_debug_descr);
500}
501
502void __init_work(struct work_struct *work, int onstack)
503{
504 if (onstack)
505 debug_object_init_on_stack(work, &work_debug_descr);
506 else
507 debug_object_init(work, &work_debug_descr);
508}
509EXPORT_SYMBOL_GPL(__init_work);
510
511void destroy_work_on_stack(struct work_struct *work)
512{
513 debug_object_free(work, &work_debug_descr);
514}
515EXPORT_SYMBOL_GPL(destroy_work_on_stack);
516
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000517void destroy_delayed_work_on_stack(struct delayed_work *work)
518{
519 destroy_timer_on_stack(&work->timer);
520 debug_object_free(&work->work, &work_debug_descr);
521}
522EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
523
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900524#else
525static inline void debug_work_activate(struct work_struct *work) { }
526static inline void debug_work_deactivate(struct work_struct *work) { }
527#endif
528
Li Bin4e8b22b2013-09-10 09:52:35 +0800529/**
530 * worker_pool_assign_id - allocate ID and assing it to @pool
531 * @pool: the pool pointer of interest
532 *
533 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
534 * successfully, -errno on failure.
535 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800536static int worker_pool_assign_id(struct worker_pool *pool)
537{
538 int ret;
539
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700540 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700541
Li Bin4e8b22b2013-09-10 09:52:35 +0800542 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
543 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700544 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700545 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700546 return 0;
547 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800548 return ret;
549}
550
Tejun Heo76af4d92013-03-12 11:30:00 -0700551/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700552 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
553 * @wq: the target workqueue
554 * @node: the node ID
555 *
556 * This must be called either with pwq_lock held or sched RCU read locked.
557 * If the pwq needs to be used beyond the locking in effect, the caller is
558 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700559 *
560 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700561 */
562static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
563 int node)
564{
565 assert_rcu_or_wq_mutex(wq);
566 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
567}
568
Tejun Heo73f53c42010-06-29 10:07:11 +0200569static unsigned int work_color_to_flags(int color)
570{
571 return color << WORK_STRUCT_COLOR_SHIFT;
572}
573
574static int get_work_color(struct work_struct *work)
575{
576 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
577 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
578}
579
580static int work_next_color(int color)
581{
582 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700583}
584
David Howells4594bf12006-12-07 11:33:26 +0000585/*
Tejun Heo112202d2013-02-13 19:29:12 -0800586 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
587 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800588 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200589 *
Tejun Heo112202d2013-02-13 19:29:12 -0800590 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
591 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700592 * work->data. These functions should only be called while the work is
593 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200594 *
Tejun Heo112202d2013-02-13 19:29:12 -0800595 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800596 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800597 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800598 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700599 *
600 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
601 * canceled. While being canceled, a work item may have its PENDING set
602 * but stay off timer and worklist for arbitrarily long and nobody should
603 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000604 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200605static inline void set_work_data(struct work_struct *work, unsigned long data,
606 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000607{
Tejun Heo6183c002013-03-12 11:29:57 -0700608 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200609 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000610}
David Howells365970a2006-11-22 14:54:49 +0000611
Tejun Heo112202d2013-02-13 19:29:12 -0800612static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200613 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200614{
Tejun Heo112202d2013-02-13 19:29:12 -0800615 set_work_data(work, (unsigned long)pwq,
616 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200617}
618
Lai Jiangshan4468a002013-02-06 18:04:53 -0800619static void set_work_pool_and_keep_pending(struct work_struct *work,
620 int pool_id)
621{
622 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
623 WORK_STRUCT_PENDING);
624}
625
Tejun Heo7c3eed52013-01-24 11:01:33 -0800626static void set_work_pool_and_clear_pending(struct work_struct *work,
627 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000628{
Tejun Heo23657bb2012-08-13 17:08:19 -0700629 /*
630 * The following wmb is paired with the implied mb in
631 * test_and_set_bit(PENDING) and ensures all updates to @work made
632 * here are visible to and precede any updates by the next PENDING
633 * owner.
634 */
635 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800636 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200637}
638
639static void clear_work_data(struct work_struct *work)
640{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800641 smp_wmb(); /* see set_work_pool_and_clear_pending() */
642 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200643}
644
Tejun Heo112202d2013-02-13 19:29:12 -0800645static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200646{
Tejun Heoe1201532010-07-22 14:14:25 +0200647 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200648
Tejun Heo112202d2013-02-13 19:29:12 -0800649 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200650 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
651 else
652 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200653}
654
Tejun Heo7c3eed52013-01-24 11:01:33 -0800655/**
656 * get_work_pool - return the worker_pool a given work was associated with
657 * @work: the work item of interest
658 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700659 * Pools are created and destroyed under wq_pool_mutex, and allows read
660 * access under sched-RCU read lock. As such, this function should be
661 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700662 *
663 * All fields of the returned pool are accessible as long as the above
664 * mentioned locking is in effect. If the returned pool needs to be used
665 * beyond the critical section, the caller is responsible for ensuring the
666 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700667 *
668 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800669 */
670static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200671{
Tejun Heoe1201532010-07-22 14:14:25 +0200672 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800673 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200674
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700675 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700676
Tejun Heo112202d2013-02-13 19:29:12 -0800677 if (data & WORK_STRUCT_PWQ)
678 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800679 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200680
Tejun Heo7c3eed52013-01-24 11:01:33 -0800681 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
682 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200683 return NULL;
684
Tejun Heofa1b54e2013-03-12 11:30:00 -0700685 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800686}
687
688/**
689 * get_work_pool_id - return the worker pool ID a given work is associated with
690 * @work: the work item of interest
691 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700692 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800693 * %WORK_OFFQ_POOL_NONE if none.
694 */
695static int get_work_pool_id(struct work_struct *work)
696{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800697 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800698
Tejun Heo112202d2013-02-13 19:29:12 -0800699 if (data & WORK_STRUCT_PWQ)
700 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800701 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
702
703 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800704}
705
Tejun Heobbb68df2012-08-03 10:30:46 -0700706static void mark_work_canceling(struct work_struct *work)
707{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800708 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700709
Tejun Heo7c3eed52013-01-24 11:01:33 -0800710 pool_id <<= WORK_OFFQ_POOL_SHIFT;
711 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700712}
713
714static bool work_is_canceling(struct work_struct *work)
715{
716 unsigned long data = atomic_long_read(&work->data);
717
Tejun Heo112202d2013-02-13 19:29:12 -0800718 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700719}
720
David Howells365970a2006-11-22 14:54:49 +0000721/*
Tejun Heo32704762012-07-13 22:16:45 -0700722 * Policy functions. These define the policies on how the global worker
723 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800724 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000725 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200726
Tejun Heo63d95a92012-07-12 14:46:37 -0700727static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000728{
Tejun Heoe19e3972013-01-24 11:39:44 -0800729 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000730}
731
Tejun Heoe22bee72010-06-29 10:07:14 +0200732/*
733 * Need to wake up a worker? Called from anything but currently
734 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700735 *
736 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800737 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700738 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200739 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700740static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000741{
Tejun Heo63d95a92012-07-12 14:46:37 -0700742 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000743}
744
Tejun Heoe22bee72010-06-29 10:07:14 +0200745/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700746static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200747{
Tejun Heo63d95a92012-07-12 14:46:37 -0700748 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200749}
750
751/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700752static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200753{
Tejun Heoe19e3972013-01-24 11:39:44 -0800754 return !list_empty(&pool->worklist) &&
755 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200756}
757
758/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700759static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200760{
Tejun Heo63d95a92012-07-12 14:46:37 -0700761 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200762}
763
Tejun Heoe22bee72010-06-29 10:07:14 +0200764/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700765static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200766{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700767 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700768 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
769 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200770
771 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
772}
773
774/*
775 * Wake up functions.
776 */
777
Lai Jiangshan1037de32014-05-22 16:44:07 +0800778/* Return the first idle worker. Safe with preemption disabled */
779static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200780{
Tejun Heo63d95a92012-07-12 14:46:37 -0700781 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200782 return NULL;
783
Tejun Heo63d95a92012-07-12 14:46:37 -0700784 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200785}
786
787/**
788 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700789 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200790 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700791 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200792 *
793 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800794 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200795 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700796static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200797{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800798 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200799
800 if (likely(worker))
801 wake_up_process(worker->task);
802}
803
Tejun Heo4690c4a2010-06-29 10:07:10 +0200804/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200805 * wq_worker_waking_up - a worker is waking up
806 * @task: task waking up
807 * @cpu: CPU @task is waking up to
808 *
809 * This function is called during try_to_wake_up() when a worker is
810 * being awoken.
811 *
812 * CONTEXT:
813 * spin_lock_irq(rq->lock)
814 */
Tejun Heod84ff052013-03-12 11:29:59 -0700815void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200816{
817 struct worker *worker = kthread_data(task);
818
Joonsoo Kim36576002012-10-26 23:03:49 +0900819 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800820 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800821 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900822 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200823}
824
825/**
826 * wq_worker_sleeping - a worker is going to sleep
827 * @task: task going to sleep
828 * @cpu: CPU in question, must be the current CPU number
829 *
830 * This function is called during schedule() when a busy worker is
831 * going to sleep. Worker on the same cpu can be woken up by
832 * returning pointer to its task.
833 *
834 * CONTEXT:
835 * spin_lock_irq(rq->lock)
836 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700837 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200838 * Worker task on @cpu to wake up, %NULL if none.
839 */
Tejun Heod84ff052013-03-12 11:29:59 -0700840struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200841{
842 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800843 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200844
Tejun Heo111c2252013-01-17 17:16:24 -0800845 /*
846 * Rescuers, which may not have all the fields set up like normal
847 * workers, also reach here, let's not access anything before
848 * checking NOT_RUNNING.
849 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500850 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200851 return NULL;
852
Tejun Heo111c2252013-01-17 17:16:24 -0800853 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800854
Tejun Heoe22bee72010-06-29 10:07:14 +0200855 /* this can only happen on the local cpu */
Lai Jiangshan92b69f52014-06-03 15:33:08 +0800856 if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu))
Tejun Heo6183c002013-03-12 11:29:57 -0700857 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200858
859 /*
860 * The counterpart of the following dec_and_test, implied mb,
861 * worklist not empty test sequence is in insert_work().
862 * Please read comment there.
863 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700864 * NOT_RUNNING is clear. This means that we're bound to and
865 * running on the local cpu w/ rq lock held and preemption
866 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800867 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700868 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200869 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800870 if (atomic_dec_and_test(&pool->nr_running) &&
871 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800872 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200873 return to_wakeup ? to_wakeup->task : NULL;
874}
875
876/**
877 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200878 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200879 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200880 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800881 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200882 *
Tejun Heocb444762010-07-02 10:03:50 +0200883 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800884 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200885 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800886static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200887{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700888 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200889
Tejun Heocb444762010-07-02 10:03:50 +0200890 WARN_ON_ONCE(worker->task != current);
891
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800892 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200893 if ((flags & WORKER_NOT_RUNNING) &&
894 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800895 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200896 }
897
Tejun Heod302f012010-06-29 10:07:13 +0200898 worker->flags |= flags;
899}
900
901/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200902 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200903 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200904 * @flags: flags to clear
905 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200906 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200907 *
Tejun Heocb444762010-07-02 10:03:50 +0200908 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800909 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200910 */
911static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
912{
Tejun Heo63d95a92012-07-12 14:46:37 -0700913 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200914 unsigned int oflags = worker->flags;
915
Tejun Heocb444762010-07-02 10:03:50 +0200916 WARN_ON_ONCE(worker->task != current);
917
Tejun Heod302f012010-06-29 10:07:13 +0200918 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200919
Tejun Heo42c025f2011-01-11 15:58:49 +0100920 /*
921 * If transitioning out of NOT_RUNNING, increment nr_running. Note
922 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
923 * of multiple flags, not a single flag.
924 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200925 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
926 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800927 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200928}
929
930/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200931 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800932 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200933 * @work: work to find worker for
934 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800935 * Find a worker which is executing @work on @pool by searching
936 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800937 * to match, its current execution should match the address of @work and
938 * its work function. This is to avoid unwanted dependency between
939 * unrelated work executions through a work item being recycled while still
940 * being executed.
941 *
942 * This is a bit tricky. A work item may be freed once its execution
943 * starts and nothing prevents the freed area from being recycled for
944 * another work item. If the same work item address ends up being reused
945 * before the original execution finishes, workqueue will identify the
946 * recycled work item as currently executing and make it wait until the
947 * current execution finishes, introducing an unwanted dependency.
948 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700949 * This function checks the work item address and work function to avoid
950 * false positives. Note that this isn't complete as one may construct a
951 * work function which can introduce dependency onto itself through a
952 * recycled work item. Well, if somebody wants to shoot oneself in the
953 * foot that badly, there's only so much we can do, and if such deadlock
954 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200955 *
956 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800957 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200958 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700959 * Return:
960 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200961 * otherwise.
962 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800963static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200964 struct work_struct *work)
965{
Sasha Levin42f85702012-12-17 10:01:23 -0500966 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500967
Sasha Levinb67bfe02013-02-27 17:06:00 -0800968 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800969 (unsigned long)work)
970 if (worker->current_work == work &&
971 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500972 return worker;
973
974 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200975}
976
977/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700978 * move_linked_works - move linked works to a list
979 * @work: start of series of works to be scheduled
980 * @head: target list to append @work to
981 * @nextp: out paramter for nested worklist walking
982 *
983 * Schedule linked works starting from @work to @head. Work series to
984 * be scheduled starts at @work and includes any consecutive work with
985 * WORK_STRUCT_LINKED set in its predecessor.
986 *
987 * If @nextp is not NULL, it's updated to point to the next work of
988 * the last scheduled work. This allows move_linked_works() to be
989 * nested inside outer list_for_each_entry_safe().
990 *
991 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800992 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -0700993 */
994static void move_linked_works(struct work_struct *work, struct list_head *head,
995 struct work_struct **nextp)
996{
997 struct work_struct *n;
998
999 /*
1000 * Linked worklist will always end before the end of the list,
1001 * use NULL for list head.
1002 */
1003 list_for_each_entry_safe_from(work, n, NULL, entry) {
1004 list_move_tail(&work->entry, head);
1005 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1006 break;
1007 }
1008
1009 /*
1010 * If we're already inside safe list traversal and have moved
1011 * multiple works to the scheduled queue, the next position
1012 * needs to be updated.
1013 */
1014 if (nextp)
1015 *nextp = n;
1016}
1017
Tejun Heo8864b4e2013-03-12 11:30:04 -07001018/**
1019 * get_pwq - get an extra reference on the specified pool_workqueue
1020 * @pwq: pool_workqueue to get
1021 *
1022 * Obtain an extra reference on @pwq. The caller should guarantee that
1023 * @pwq has positive refcnt and be holding the matching pool->lock.
1024 */
1025static void get_pwq(struct pool_workqueue *pwq)
1026{
1027 lockdep_assert_held(&pwq->pool->lock);
1028 WARN_ON_ONCE(pwq->refcnt <= 0);
1029 pwq->refcnt++;
1030}
1031
1032/**
1033 * put_pwq - put a pool_workqueue reference
1034 * @pwq: pool_workqueue to put
1035 *
1036 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1037 * destruction. The caller should be holding the matching pool->lock.
1038 */
1039static void put_pwq(struct pool_workqueue *pwq)
1040{
1041 lockdep_assert_held(&pwq->pool->lock);
1042 if (likely(--pwq->refcnt))
1043 return;
1044 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1045 return;
1046 /*
1047 * @pwq can't be released under pool->lock, bounce to
1048 * pwq_unbound_release_workfn(). This never recurses on the same
1049 * pool->lock as this path is taken only for unbound workqueues and
1050 * the release work item is scheduled on a per-cpu workqueue. To
1051 * avoid lockdep warning, unbound pool->locks are given lockdep
1052 * subclass of 1 in get_unbound_pool().
1053 */
1054 schedule_work(&pwq->unbound_release_work);
1055}
1056
Tejun Heodce90d42013-04-01 11:23:35 -07001057/**
1058 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1059 * @pwq: pool_workqueue to put (can be %NULL)
1060 *
1061 * put_pwq() with locking. This function also allows %NULL @pwq.
1062 */
1063static void put_pwq_unlocked(struct pool_workqueue *pwq)
1064{
1065 if (pwq) {
1066 /*
1067 * As both pwqs and pools are sched-RCU protected, the
1068 * following lock operations are safe.
1069 */
1070 spin_lock_irq(&pwq->pool->lock);
1071 put_pwq(pwq);
1072 spin_unlock_irq(&pwq->pool->lock);
1073 }
1074}
1075
Tejun Heo112202d2013-02-13 19:29:12 -08001076static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001077{
Tejun Heo112202d2013-02-13 19:29:12 -08001078 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001079
1080 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001081 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001082 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001083 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001084}
1085
Tejun Heo112202d2013-02-13 19:29:12 -08001086static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001087{
Tejun Heo112202d2013-02-13 19:29:12 -08001088 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001089 struct work_struct, entry);
1090
Tejun Heo112202d2013-02-13 19:29:12 -08001091 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001092}
1093
Tejun Heobf4ede02012-08-03 10:30:46 -07001094/**
Tejun Heo112202d2013-02-13 19:29:12 -08001095 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1096 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001097 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001098 *
1099 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001100 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001101 *
1102 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001103 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001104 */
Tejun Heo112202d2013-02-13 19:29:12 -08001105static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001106{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001107 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001108 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001109 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001110
Tejun Heo112202d2013-02-13 19:29:12 -08001111 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001112
Tejun Heo112202d2013-02-13 19:29:12 -08001113 pwq->nr_active--;
1114 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001115 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001116 if (pwq->nr_active < pwq->max_active)
1117 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001118 }
1119
1120 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001121 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001122 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001123
1124 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001125 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001126 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001127
Tejun Heo112202d2013-02-13 19:29:12 -08001128 /* this pwq is done, clear flush_color */
1129 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001130
1131 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001132 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001133 * will handle the rest.
1134 */
Tejun Heo112202d2013-02-13 19:29:12 -08001135 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1136 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001137out_put:
1138 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001139}
1140
Tejun Heo36e227d2012-08-03 10:30:46 -07001141/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001142 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001143 * @work: work item to steal
1144 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001145 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001146 *
1147 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001148 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001149 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001150 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001151 * 1 if @work was pending and we successfully stole PENDING
1152 * 0 if @work was idle and we claimed PENDING
1153 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001154 * -ENOENT if someone else is canceling @work, this state may persist
1155 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001156 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001157 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001158 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001159 * interrupted while holding PENDING and @work off queue, irq must be
1160 * disabled on entry. This, combined with delayed_work->timer being
1161 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001162 *
1163 * On successful return, >= 0, irq is disabled and the caller is
1164 * responsible for releasing it using local_irq_restore(*@flags).
1165 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001166 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001167 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001168static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1169 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001170{
Tejun Heod565ed62013-01-24 11:01:33 -08001171 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001172 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001173
Tejun Heobbb68df2012-08-03 10:30:46 -07001174 local_irq_save(*flags);
1175
Tejun Heo36e227d2012-08-03 10:30:46 -07001176 /* try to steal the timer if it exists */
1177 if (is_dwork) {
1178 struct delayed_work *dwork = to_delayed_work(work);
1179
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001180 /*
1181 * dwork->timer is irqsafe. If del_timer() fails, it's
1182 * guaranteed that the timer is not queued anywhere and not
1183 * running on the local CPU.
1184 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001185 if (likely(del_timer(&dwork->timer)))
1186 return 1;
1187 }
1188
1189 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001190 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1191 return 0;
1192
1193 /*
1194 * The queueing is in progress, or it is already queued. Try to
1195 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1196 */
Tejun Heod565ed62013-01-24 11:01:33 -08001197 pool = get_work_pool(work);
1198 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001199 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001200
Tejun Heod565ed62013-01-24 11:01:33 -08001201 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001202 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001203 * work->data is guaranteed to point to pwq only while the work
1204 * item is queued on pwq->wq, and both updating work->data to point
1205 * to pwq on queueing and to pool on dequeueing are done under
1206 * pwq->pool->lock. This in turn guarantees that, if work->data
1207 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001208 * item is currently queued on that pool.
1209 */
Tejun Heo112202d2013-02-13 19:29:12 -08001210 pwq = get_work_pwq(work);
1211 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001212 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001213
Tejun Heo16062832013-02-06 18:04:53 -08001214 /*
1215 * A delayed work item cannot be grabbed directly because
1216 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001217 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001218 * management later on and cause stall. Make sure the work
1219 * item is activated before grabbing.
1220 */
1221 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001222 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001223
Tejun Heo16062832013-02-06 18:04:53 -08001224 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001225 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001226
Tejun Heo112202d2013-02-13 19:29:12 -08001227 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001228 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001229
Tejun Heo16062832013-02-06 18:04:53 -08001230 spin_unlock(&pool->lock);
1231 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001232 }
Tejun Heod565ed62013-01-24 11:01:33 -08001233 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001234fail:
1235 local_irq_restore(*flags);
1236 if (work_is_canceling(work))
1237 return -ENOENT;
1238 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001239 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001240}
1241
1242/**
Tejun Heo706026c2013-01-24 11:01:34 -08001243 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001244 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001245 * @work: work to insert
1246 * @head: insertion point
1247 * @extra_flags: extra WORK_STRUCT_* flags to set
1248 *
Tejun Heo112202d2013-02-13 19:29:12 -08001249 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001250 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001251 *
1252 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001253 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001254 */
Tejun Heo112202d2013-02-13 19:29:12 -08001255static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1256 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001257{
Tejun Heo112202d2013-02-13 19:29:12 -08001258 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001259
Tejun Heo4690c4a2010-06-29 10:07:10 +02001260 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001261 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001262 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001263 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001264
1265 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001266 * Ensure either wq_worker_sleeping() sees the above
1267 * list_add_tail() or we see zero nr_running to avoid workers lying
1268 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001269 */
1270 smp_mb();
1271
Tejun Heo63d95a92012-07-12 14:46:37 -07001272 if (__need_more_worker(pool))
1273 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001274}
1275
Tejun Heoc8efcc22010-12-20 19:32:04 +01001276/*
1277 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001278 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001279 */
1280static bool is_chained_work(struct workqueue_struct *wq)
1281{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001282 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001283
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001284 worker = current_wq_worker();
1285 /*
1286 * Return %true iff I'm a worker execuing a work item on @wq. If
1287 * I'm @worker, it's safe to dereference it without locking.
1288 */
Tejun Heo112202d2013-02-13 19:29:12 -08001289 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001290}
1291
Tejun Heod84ff052013-03-12 11:29:59 -07001292static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 struct work_struct *work)
1294{
Tejun Heo112202d2013-02-13 19:29:12 -08001295 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001296 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001297 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001298 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001299 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001300
1301 /*
1302 * While a work item is PENDING && off queue, a task trying to
1303 * steal the PENDING will busy-loop waiting for it to either get
1304 * queued or lose PENDING. Grabbing PENDING and queueing should
1305 * happen with IRQ disabled.
1306 */
1307 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001309 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001310
Li Bin9ef28a72013-09-09 13:13:58 +08001311 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001312 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001313 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001314 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001315retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001316 if (req_cpu == WORK_CPU_UNBOUND)
1317 cpu = raw_smp_processor_id();
1318
Tejun Heoc9178082013-03-12 11:30:04 -07001319 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001320 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001321 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001322 else
1323 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001324
Tejun Heoc9178082013-03-12 11:30:04 -07001325 /*
1326 * If @work was previously on a different pool, it might still be
1327 * running there, in which case the work needs to be queued on that
1328 * pool to guarantee non-reentrancy.
1329 */
1330 last_pool = get_work_pool(work);
1331 if (last_pool && last_pool != pwq->pool) {
1332 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001333
Tejun Heoc9178082013-03-12 11:30:04 -07001334 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001335
Tejun Heoc9178082013-03-12 11:30:04 -07001336 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001337
Tejun Heoc9178082013-03-12 11:30:04 -07001338 if (worker && worker->current_pwq->wq == wq) {
1339 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001340 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001341 /* meh... not running there, queue here */
1342 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001343 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001344 }
Tejun Heof3421792010-07-02 10:03:51 +02001345 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001346 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001347 }
1348
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001349 /*
1350 * pwq is determined and locked. For unbound pools, we could have
1351 * raced with pwq release and it could already be dead. If its
1352 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001353 * without another pwq replacing it in the numa_pwq_tbl or while
1354 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001355 * make forward-progress.
1356 */
1357 if (unlikely(!pwq->refcnt)) {
1358 if (wq->flags & WQ_UNBOUND) {
1359 spin_unlock(&pwq->pool->lock);
1360 cpu_relax();
1361 goto retry;
1362 }
1363 /* oops */
1364 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1365 wq->name, cpu);
1366 }
1367
Tejun Heo112202d2013-02-13 19:29:12 -08001368 /* pwq determined, queue */
1369 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001370
Dan Carpenterf5b25522012-04-13 22:06:58 +03001371 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001372 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001373 return;
1374 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001375
Tejun Heo112202d2013-02-13 19:29:12 -08001376 pwq->nr_in_flight[pwq->work_color]++;
1377 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001378
Tejun Heo112202d2013-02-13 19:29:12 -08001379 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001380 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001381 pwq->nr_active++;
1382 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001383 } else {
1384 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001385 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001386 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001387
Tejun Heo112202d2013-02-13 19:29:12 -08001388 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001389
Tejun Heo112202d2013-02-13 19:29:12 -08001390 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391}
1392
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001393/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001394 * queue_work_on - queue work on specific cpu
1395 * @cpu: CPU number to execute work on
1396 * @wq: workqueue to use
1397 * @work: work to queue
1398 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001399 * We queue the work to a specific CPU, the caller must ensure it
1400 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001401 *
1402 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001403 */
Tejun Heod4283e92012-08-03 10:30:44 -07001404bool queue_work_on(int cpu, struct workqueue_struct *wq,
1405 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001406{
Tejun Heod4283e92012-08-03 10:30:44 -07001407 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001408 unsigned long flags;
1409
1410 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001411
Tejun Heo22df02b2010-06-29 10:07:10 +02001412 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001413 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001414 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001415 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001416
1417 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001418 return ret;
1419}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001420EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001421
Tejun Heod8e794d2012-08-03 10:30:45 -07001422void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423{
David Howells52bad642006-11-22 14:54:01 +00001424 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001426 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001427 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001429EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001431static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1432 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001434 struct timer_list *timer = &dwork->timer;
1435 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001437 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1438 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001439 WARN_ON_ONCE(timer_pending(timer));
1440 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001441
Tejun Heo8852aac2012-12-01 16:23:42 -08001442 /*
1443 * If @delay is 0, queue @dwork->work immediately. This is for
1444 * both optimization and correctness. The earliest @timer can
1445 * expire is on the closest next tick and delayed_work users depend
1446 * on that there's no such delay when @delay is 0.
1447 */
1448 if (!delay) {
1449 __queue_work(cpu, wq, &dwork->work);
1450 return;
1451 }
1452
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001453 timer_stats_timer_set_start_info(&dwork->timer);
1454
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001455 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001456 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001457 timer->expires = jiffies + delay;
1458
1459 if (unlikely(cpu != WORK_CPU_UNBOUND))
1460 add_timer_on(timer, cpu);
1461 else
1462 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463}
1464
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001465/**
1466 * queue_delayed_work_on - queue work on specific CPU after delay
1467 * @cpu: CPU number to execute work on
1468 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001469 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001470 * @delay: number of jiffies to wait before queueing
1471 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001472 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001473 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1474 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001475 */
Tejun Heod4283e92012-08-03 10:30:44 -07001476bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1477 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001478{
David Howells52bad642006-11-22 14:54:01 +00001479 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001480 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001481 unsigned long flags;
1482
1483 /* read the comment in __queue_work() */
1484 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001485
Tejun Heo22df02b2010-06-29 10:07:10 +02001486 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001487 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001488 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001489 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001490
1491 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001492 return ret;
1493}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001494EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
Tejun Heoc8e55f32010-06-29 10:07:12 +02001496/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001497 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1498 * @cpu: CPU number to execute work on
1499 * @wq: workqueue to use
1500 * @dwork: work to queue
1501 * @delay: number of jiffies to wait before queueing
1502 *
1503 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1504 * modify @dwork's timer so that it expires after @delay. If @delay is
1505 * zero, @work is guaranteed to be scheduled immediately regardless of its
1506 * current state.
1507 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001508 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001509 * pending and its timer was modified.
1510 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001511 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001512 * See try_to_grab_pending() for details.
1513 */
1514bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1515 struct delayed_work *dwork, unsigned long delay)
1516{
1517 unsigned long flags;
1518 int ret;
1519
1520 do {
1521 ret = try_to_grab_pending(&dwork->work, true, &flags);
1522 } while (unlikely(ret == -EAGAIN));
1523
1524 if (likely(ret >= 0)) {
1525 __queue_delayed_work(cpu, wq, dwork, delay);
1526 local_irq_restore(flags);
1527 }
1528
1529 /* -ENOENT from try_to_grab_pending() becomes %true */
1530 return ret;
1531}
1532EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1533
1534/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001535 * worker_enter_idle - enter idle state
1536 * @worker: worker which is entering idle state
1537 *
1538 * @worker is entering idle state. Update stats and idle timer if
1539 * necessary.
1540 *
1541 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001542 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001543 */
1544static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001546 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547
Tejun Heo6183c002013-03-12 11:29:57 -07001548 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1549 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1550 (worker->hentry.next || worker->hentry.pprev)))
1551 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Lai Jiangshan051e1852014-07-22 13:03:02 +08001553 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001554 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001555 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001556 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001557
Tejun Heoc8e55f32010-06-29 10:07:12 +02001558 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001559 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001560
Tejun Heo628c78e2012-07-17 12:39:27 -07001561 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1562 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001563
Tejun Heo544ecf32012-05-14 15:04:50 -07001564 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001565 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001566 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001567 * nr_running, the warning may trigger spuriously. Check iff
1568 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001569 */
Tejun Heo24647572013-01-24 11:01:33 -08001570 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001571 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001572 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573}
1574
Tejun Heoc8e55f32010-06-29 10:07:12 +02001575/**
1576 * worker_leave_idle - leave idle state
1577 * @worker: worker which is leaving idle state
1578 *
1579 * @worker is leaving idle state. Update stats.
1580 *
1581 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001582 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001583 */
1584static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001586 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587
Tejun Heo6183c002013-03-12 11:29:57 -07001588 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1589 return;
Tejun Heod302f012010-06-29 10:07:13 +02001590 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001591 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001592 list_del_init(&worker->entry);
1593}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001595static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001596{
1597 struct worker *worker;
1598
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001599 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001600 if (worker) {
1601 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001602 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001603 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001604 /* on creation a worker is in !idle && prep state */
1605 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001606 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001607 return worker;
1608}
1609
1610/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001611 * worker_attach_to_pool() - attach a worker to a pool
1612 * @worker: worker to be attached
1613 * @pool: the target pool
1614 *
1615 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1616 * cpu-binding of @worker are kept coordinated with the pool across
1617 * cpu-[un]hotplugs.
1618 */
1619static void worker_attach_to_pool(struct worker *worker,
1620 struct worker_pool *pool)
1621{
1622 mutex_lock(&pool->attach_mutex);
1623
1624 /*
1625 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1626 * online CPUs. It'll be re-applied when any of the CPUs come up.
1627 */
1628 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1629
1630 /*
1631 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1632 * stable across this function. See the comments above the
1633 * flag definition for details.
1634 */
1635 if (pool->flags & POOL_DISASSOCIATED)
1636 worker->flags |= WORKER_UNBOUND;
1637
1638 list_add_tail(&worker->node, &pool->workers);
1639
1640 mutex_unlock(&pool->attach_mutex);
1641}
1642
1643/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001644 * worker_detach_from_pool() - detach a worker from its pool
1645 * @worker: worker which is attached to its pool
1646 * @pool: the pool @worker is attached to
1647 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001648 * Undo the attaching which had been done in worker_attach_to_pool(). The
1649 * caller worker shouldn't access to the pool after detached except it has
1650 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001651 */
1652static void worker_detach_from_pool(struct worker *worker,
1653 struct worker_pool *pool)
1654{
1655 struct completion *detach_completion = NULL;
1656
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001657 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001658 list_del(&worker->node);
1659 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001660 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001661 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001662
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001663 /* clear leftover flags without pool->lock after it is detached */
1664 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1665
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001666 if (detach_completion)
1667 complete(detach_completion);
1668}
1669
1670/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001671 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001672 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001673 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001674 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001675 *
1676 * CONTEXT:
1677 * Might sleep. Does GFP_KERNEL allocations.
1678 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001679 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001680 * Pointer to the newly created worker.
1681 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001682static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001683{
Tejun Heoc34056a2010-06-29 10:07:11 +02001684 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001685 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001686 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001687
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001688 /* ID is needed to determine kthread name */
1689 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001690 if (id < 0)
1691 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001692
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001693 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001694 if (!worker)
1695 goto fail;
1696
Tejun Heobd7bdd42012-07-12 14:46:37 -07001697 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001698 worker->id = id;
1699
Tejun Heo29c91e92013-03-12 11:30:03 -07001700 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001701 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1702 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001703 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001704 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1705
Tejun Heof3f90ad2013-04-01 11:23:34 -07001706 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001707 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001708 if (IS_ERR(worker->task))
1709 goto fail;
1710
Oleg Nesterov91151222013-11-14 12:56:18 +01001711 set_user_nice(worker->task, pool->attrs->nice);
1712
1713 /* prevent userland from meddling with cpumask of workqueue workers */
1714 worker->task->flags |= PF_NO_SETAFFINITY;
1715
Lai Jiangshanda028462014-05-20 17:46:31 +08001716 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001717 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001718
Lai Jiangshan051e1852014-07-22 13:03:02 +08001719 /* start the newly created worker */
1720 spin_lock_irq(&pool->lock);
1721 worker->pool->nr_workers++;
1722 worker_enter_idle(worker);
1723 wake_up_process(worker->task);
1724 spin_unlock_irq(&pool->lock);
1725
Tejun Heoc34056a2010-06-29 10:07:11 +02001726 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001727
Tejun Heoc34056a2010-06-29 10:07:11 +02001728fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001729 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001730 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001731 kfree(worker);
1732 return NULL;
1733}
1734
1735/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001736 * destroy_worker - destroy a workqueue worker
1737 * @worker: worker to be destroyed
1738 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001739 * Destroy @worker and adjust @pool stats accordingly. The worker should
1740 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001741 *
1742 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001743 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001744 */
1745static void destroy_worker(struct worker *worker)
1746{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001747 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001748
Tejun Heocd549682013-03-13 19:47:39 -07001749 lockdep_assert_held(&pool->lock);
1750
Tejun Heoc34056a2010-06-29 10:07:11 +02001751 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001752 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001753 WARN_ON(!list_empty(&worker->scheduled)) ||
1754 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001755 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001756
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001757 pool->nr_workers--;
1758 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001759
Tejun Heoc8e55f32010-06-29 10:07:12 +02001760 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001761 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001762 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001763}
1764
Tejun Heo63d95a92012-07-12 14:46:37 -07001765static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001766{
Tejun Heo63d95a92012-07-12 14:46:37 -07001767 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001768
Tejun Heod565ed62013-01-24 11:01:33 -08001769 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001770
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001771 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001772 struct worker *worker;
1773 unsigned long expires;
1774
1775 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001776 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001777 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1778
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001779 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001780 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001781 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001782 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001783
1784 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001785 }
1786
Tejun Heod565ed62013-01-24 11:01:33 -08001787 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001788}
1789
Tejun Heo493a1722013-03-12 11:29:59 -07001790static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001791{
Tejun Heo112202d2013-02-13 19:29:12 -08001792 struct pool_workqueue *pwq = get_work_pwq(work);
1793 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001794
Tejun Heo2e109a22013-03-13 19:47:40 -07001795 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001796
Tejun Heo493008a2013-03-12 11:30:03 -07001797 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001798 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001799
1800 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001801 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001802 /*
1803 * If @pwq is for an unbound wq, its base ref may be put at
1804 * any time due to an attribute change. Pin @pwq until the
1805 * rescuer is done with it.
1806 */
1807 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001808 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001809 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001810 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001811}
1812
Tejun Heo706026c2013-01-24 11:01:34 -08001813static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001814{
Tejun Heo63d95a92012-07-12 14:46:37 -07001815 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001816 struct work_struct *work;
1817
Tejun Heob2d82902014-12-08 12:39:16 -05001818 spin_lock_irq(&pool->lock);
1819 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001820
Tejun Heo63d95a92012-07-12 14:46:37 -07001821 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001822 /*
1823 * We've been trying to create a new worker but
1824 * haven't been successful. We might be hitting an
1825 * allocation deadlock. Send distress signals to
1826 * rescuers.
1827 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001828 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001829 send_mayday(work);
1830 }
1831
Tejun Heob2d82902014-12-08 12:39:16 -05001832 spin_unlock(&wq_mayday_lock);
1833 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001834
Tejun Heo63d95a92012-07-12 14:46:37 -07001835 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001836}
1837
1838/**
1839 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001840 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001841 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001842 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001843 * have at least one idle worker on return from this function. If
1844 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001845 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001846 * possible allocation deadlock.
1847 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001848 * On return, need_to_create_worker() is guaranteed to be %false and
1849 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001850 *
1851 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001852 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001853 * multiple times. Does GFP_KERNEL allocations. Called only from
1854 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001855 */
Tejun Heo29187a92015-01-16 14:21:16 -05001856static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001857__releases(&pool->lock)
1858__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001859{
Tejun Heoe22bee72010-06-29 10:07:14 +02001860restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001861 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001862
Tejun Heoe22bee72010-06-29 10:07:14 +02001863 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001864 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001865
1866 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001867 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001868 break;
1869
Lai Jiangshane212f362014-06-03 15:32:17 +08001870 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001871
Tejun Heo63d95a92012-07-12 14:46:37 -07001872 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001873 break;
1874 }
1875
Tejun Heo63d95a92012-07-12 14:46:37 -07001876 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001877 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001878 /*
1879 * This is necessary even after a new worker was just successfully
1880 * created as @pool->lock was dropped and the new worker might have
1881 * already become busy.
1882 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001883 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001884 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001885}
1886
1887/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001888 * manage_workers - manage worker pool
1889 * @worker: self
1890 *
Tejun Heo706026c2013-01-24 11:01:34 -08001891 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001892 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001893 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001894 *
1895 * The caller can safely start processing works on false return. On
1896 * true return, it's guaranteed that need_to_create_worker() is false
1897 * and may_start_working() is true.
1898 *
1899 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001900 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001901 * multiple times. Does GFP_KERNEL allocations.
1902 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001903 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001904 * %false if the pool doesn't need management and the caller can safely
1905 * start processing works, %true if management function was performed and
1906 * the conditions that the caller verified before calling the function may
1907 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001908 */
1909static bool manage_workers(struct worker *worker)
1910{
Tejun Heo63d95a92012-07-12 14:46:37 -07001911 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001912
Tejun Heobc3a1af2013-03-13 19:47:39 -07001913 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07001914 * Anyone who successfully grabs manager_arb wins the arbitration
1915 * and becomes the manager. mutex_trylock() on pool->manager_arb
1916 * failure while holding pool->lock reliably indicates that someone
1917 * else is managing the pool and the worker which failed trylock
1918 * can proceed to executing work items. This means that anyone
1919 * grabbing manager_arb is responsible for actually performing
1920 * manager duties. If manager_arb is grabbed and released without
1921 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07001922 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07001923 if (!mutex_trylock(&pool->manager_arb))
Tejun Heo29187a92015-01-16 14:21:16 -05001924 return false;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001925 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001926
Tejun Heo29187a92015-01-16 14:21:16 -05001927 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001928
Tejun Heo2607d7a2015-03-09 09:22:28 -04001929 pool->manager = NULL;
Tejun Heo34a06bd2013-03-12 11:30:00 -07001930 mutex_unlock(&pool->manager_arb);
Tejun Heo29187a92015-01-16 14:21:16 -05001931 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02001932}
1933
Tejun Heoa62428c2010-06-29 10:07:10 +02001934/**
1935 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001936 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001937 * @work: work to process
1938 *
1939 * Process @work. This function contains all the logics necessary to
1940 * process a single work including synchronization against and
1941 * interaction with other workers on the same cpu, queueing and
1942 * flushing. As long as context requirement is met, any worker can
1943 * call this function to process a work.
1944 *
1945 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001946 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001947 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001948static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08001949__releases(&pool->lock)
1950__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02001951{
Tejun Heo112202d2013-02-13 19:29:12 -08001952 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001953 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001954 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02001955 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001956 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001957#ifdef CONFIG_LOCKDEP
1958 /*
1959 * It is permissible to free the struct work_struct from
1960 * inside the function that is called from it, this we need to
1961 * take into account for lockdep too. To avoid bogus "held
1962 * lock freed" warnings as well as problems when looking into
1963 * work->lockdep_map, make a copy and use that here.
1964 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07001965 struct lockdep_map lockdep_map;
1966
1967 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02001968#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08001969 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08001970 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08001971 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07001972
Tejun Heo7e116292010-06-29 10:07:13 +02001973 /*
1974 * A single work shouldn't be executed concurrently by
1975 * multiple workers on a single cpu. Check whether anyone is
1976 * already processing the work. If so, defer the work to the
1977 * currently executing one.
1978 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001979 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02001980 if (unlikely(collision)) {
1981 move_linked_works(work, &collision->scheduled, NULL);
1982 return;
1983 }
1984
Tejun Heo8930cab2012-08-03 10:30:45 -07001985 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02001986 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001987 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02001988 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08001989 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08001990 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001991 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001992
Tejun Heoa62428c2010-06-29 10:07:10 +02001993 list_del_init(&work->entry);
1994
Tejun Heo649027d2010-06-29 10:07:14 +02001995 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08001996 * CPU intensive works don't participate in concurrency management.
1997 * They're the scheduler's responsibility. This takes @worker out
1998 * of concurrency management and the next code block will chain
1999 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002000 */
2001 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002002 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002003
Tejun Heo974271c2012-07-12 14:46:37 -07002004 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002005 * Wake up another worker if necessary. The condition is always
2006 * false for normal per-cpu workers since nr_running would always
2007 * be >= 1 at this point. This is used to chain execution of the
2008 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002009 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002010 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002011 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002012 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002013
Tejun Heo8930cab2012-08-03 10:30:45 -07002014 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002015 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002016 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002017 * PENDING and queued state changes happen together while IRQ is
2018 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002019 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002020 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002021
Tejun Heod565ed62013-01-24 11:01:33 -08002022 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002023
Tejun Heo112202d2013-02-13 19:29:12 -08002024 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002025 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002026 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002027 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002028 /*
2029 * While we must be careful to not use "work" after this, the trace
2030 * point will only record its address.
2031 */
2032 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002033 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002034 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002035
2036 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002037 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2038 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002039 current->comm, preempt_count(), task_pid_nr(current),
2040 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002041 debug_show_held_locks(current);
2042 dump_stack();
2043 }
2044
Tejun Heob22ce272013-08-28 17:33:37 -04002045 /*
2046 * The following prevents a kworker from hogging CPU on !PREEMPT
2047 * kernels, where a requeueing work item waiting for something to
2048 * happen could deadlock with stop_machine as such work item could
2049 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002050 * stop_machine. At the same time, report a quiescent RCU state so
2051 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002052 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002053 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002054
Tejun Heod565ed62013-01-24 11:01:33 -08002055 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002056
Tejun Heofb0e7be2010-06-29 10:07:15 +02002057 /* clear cpu intensive status */
2058 if (unlikely(cpu_intensive))
2059 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2060
Tejun Heoa62428c2010-06-29 10:07:10 +02002061 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002062 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002063 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002064 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002065 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002066 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002067 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002068}
2069
Tejun Heoaffee4b2010-06-29 10:07:12 +02002070/**
2071 * process_scheduled_works - process scheduled works
2072 * @worker: self
2073 *
2074 * Process all scheduled works. Please note that the scheduled list
2075 * may change while processing a work, so this function repeatedly
2076 * fetches a work from the top and executes it.
2077 *
2078 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002079 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002080 * multiple times.
2081 */
2082static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002084 while (!list_empty(&worker->scheduled)) {
2085 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002087 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089}
2090
Tejun Heo4690c4a2010-06-29 10:07:10 +02002091/**
2092 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002093 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002094 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002095 * The worker thread function. All workers belong to a worker_pool -
2096 * either a per-cpu one or dynamic unbound one. These workers process all
2097 * work items regardless of their specific target workqueue. The only
2098 * exception is work items which belong to workqueues with a rescuer which
2099 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002100 *
2101 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002102 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002103static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104{
Tejun Heoc34056a2010-06-29 10:07:11 +02002105 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002106 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107
Tejun Heoe22bee72010-06-29 10:07:14 +02002108 /* tell the scheduler that this is a workqueue worker */
2109 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002110woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002111 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002112
Tejun Heoa9ab7752013-03-19 13:45:21 -07002113 /* am I supposed to die? */
2114 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002115 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002116 WARN_ON_ONCE(!list_empty(&worker->entry));
2117 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002118
2119 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002120 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002121 worker_detach_from_pool(worker, pool);
2122 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002123 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002125
Tejun Heoc8e55f32010-06-29 10:07:12 +02002126 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002127recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002128 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002129 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002130 goto sleep;
2131
2132 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002133 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002134 goto recheck;
2135
Tejun Heoc8e55f32010-06-29 10:07:12 +02002136 /*
2137 * ->scheduled list can only be filled while a worker is
2138 * preparing to process a work or actually processing it.
2139 * Make sure nobody diddled with it while I was sleeping.
2140 */
Tejun Heo6183c002013-03-12 11:29:57 -07002141 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002142
Tejun Heoe22bee72010-06-29 10:07:14 +02002143 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002144 * Finish PREP stage. We're guaranteed to have at least one idle
2145 * worker or that someone else has already assumed the manager
2146 * role. This is where @worker starts participating in concurrency
2147 * management if applicable and concurrency management is restored
2148 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002149 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002150 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002151
2152 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002153 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002154 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002155 struct work_struct, entry);
2156
2157 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2158 /* optimization path, not strictly necessary */
2159 process_one_work(worker, work);
2160 if (unlikely(!list_empty(&worker->scheduled)))
2161 process_scheduled_works(worker);
2162 } else {
2163 move_linked_works(work, &worker->scheduled, NULL);
2164 process_scheduled_works(worker);
2165 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002166 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002167
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002168 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002169sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002170 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002171 * pool->lock is held and there's no work to process and no need to
2172 * manage, sleep. Workers are woken up only while holding
2173 * pool->lock or from local cpu, so setting the current state
2174 * before releasing pool->lock is enough to prevent losing any
2175 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002176 */
2177 worker_enter_idle(worker);
2178 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002179 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002180 schedule();
2181 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182}
2183
Tejun Heoe22bee72010-06-29 10:07:14 +02002184/**
2185 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002186 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002187 *
2188 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002189 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002190 *
Tejun Heo706026c2013-01-24 11:01:34 -08002191 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002192 * worker which uses GFP_KERNEL allocation which has slight chance of
2193 * developing into deadlock if some works currently on the same queue
2194 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2195 * the problem rescuer solves.
2196 *
Tejun Heo706026c2013-01-24 11:01:34 -08002197 * When such condition is possible, the pool summons rescuers of all
2198 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002199 * those works so that forward progress can be guaranteed.
2200 *
2201 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002202 *
2203 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002204 */
Tejun Heo111c2252013-01-17 17:16:24 -08002205static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002206{
Tejun Heo111c2252013-01-17 17:16:24 -08002207 struct worker *rescuer = __rescuer;
2208 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002209 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002210 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002211
2212 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002213
2214 /*
2215 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2216 * doesn't participate in concurrency management.
2217 */
2218 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002219repeat:
2220 set_current_state(TASK_INTERRUPTIBLE);
2221
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002222 /*
2223 * By the time the rescuer is requested to stop, the workqueue
2224 * shouldn't have any work pending, but @wq->maydays may still have
2225 * pwq(s) queued. This can happen by non-rescuer workers consuming
2226 * all the work items before the rescuer got to them. Go through
2227 * @wq->maydays processing before acting on should_stop so that the
2228 * list is always empty on exit.
2229 */
2230 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002231
Tejun Heo493a1722013-03-12 11:29:59 -07002232 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002233 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002234
2235 while (!list_empty(&wq->maydays)) {
2236 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2237 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002238 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002239 struct work_struct *work, *n;
2240
2241 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002242 list_del_init(&pwq->mayday_node);
2243
Tejun Heo2e109a22013-03-13 19:47:40 -07002244 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002245
Lai Jiangshan51697d392014-05-20 17:46:36 +08002246 worker_attach_to_pool(rescuer, pool);
2247
2248 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002249 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002250
2251 /*
2252 * Slurp in all works issued via this workqueue and
2253 * process'em.
2254 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002255 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002256 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002257 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002258 move_linked_works(work, scheduled, &n);
2259
NeilBrown008847f2014-12-08 12:39:16 -05002260 if (!list_empty(scheduled)) {
2261 process_scheduled_works(rescuer);
2262
2263 /*
2264 * The above execution of rescued work items could
2265 * have created more to rescue through
2266 * pwq_activate_first_delayed() or chained
2267 * queueing. Let's put @pwq back on mayday list so
2268 * that such back-to-back work items, which may be
2269 * being used to relieve memory pressure, don't
2270 * incur MAYDAY_INTERVAL delay inbetween.
2271 */
2272 if (need_to_create_worker(pool)) {
2273 spin_lock(&wq_mayday_lock);
2274 get_pwq(pwq);
2275 list_move_tail(&pwq->mayday_node, &wq->maydays);
2276 spin_unlock(&wq_mayday_lock);
2277 }
2278 }
Tejun Heo75769582011-02-14 14:04:46 +01002279
2280 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002281 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002282 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002283 */
2284 put_pwq(pwq);
2285
2286 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002287 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002288 * regular worker; otherwise, we end up with 0 concurrency
2289 * and stalling the execution.
2290 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002291 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002292 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002293
Lai Jiangshanb3104102013-02-19 12:17:02 -08002294 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002295 spin_unlock_irq(&pool->lock);
2296
2297 worker_detach_from_pool(rescuer, pool);
2298
2299 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002300 }
2301
Tejun Heo2e109a22013-03-13 19:47:40 -07002302 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002303
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002304 if (should_stop) {
2305 __set_current_state(TASK_RUNNING);
2306 rescuer->task->flags &= ~PF_WQ_WORKER;
2307 return 0;
2308 }
2309
Tejun Heo111c2252013-01-17 17:16:24 -08002310 /* rescuers should never participate in concurrency management */
2311 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002312 schedule();
2313 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314}
2315
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002316struct wq_barrier {
2317 struct work_struct work;
2318 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002319 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002320};
2321
2322static void wq_barrier_func(struct work_struct *work)
2323{
2324 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2325 complete(&barr->done);
2326}
2327
Tejun Heo4690c4a2010-06-29 10:07:10 +02002328/**
2329 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002330 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002331 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002332 * @target: target work to attach @barr to
2333 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002334 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002335 * @barr is linked to @target such that @barr is completed only after
2336 * @target finishes execution. Please note that the ordering
2337 * guarantee is observed only with respect to @target and on the local
2338 * cpu.
2339 *
2340 * Currently, a queued barrier can't be canceled. This is because
2341 * try_to_grab_pending() can't determine whether the work to be
2342 * grabbed is at the head of the queue and thus can't clear LINKED
2343 * flag of the previous work while there must be a valid next work
2344 * after a work with LINKED flag set.
2345 *
2346 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002347 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002348 *
2349 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002350 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002351 */
Tejun Heo112202d2013-02-13 19:29:12 -08002352static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002353 struct wq_barrier *barr,
2354 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002355{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002356 struct list_head *head;
2357 unsigned int linked = 0;
2358
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002359 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002360 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002361 * as we know for sure that this will not trigger any of the
2362 * checks and call back into the fixup functions where we
2363 * might deadlock.
2364 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002365 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002366 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002367 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002368 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002369
Tejun Heoaffee4b2010-06-29 10:07:12 +02002370 /*
2371 * If @target is currently being executed, schedule the
2372 * barrier to the worker; otherwise, put it after @target.
2373 */
2374 if (worker)
2375 head = worker->scheduled.next;
2376 else {
2377 unsigned long *bits = work_data_bits(target);
2378
2379 head = target->entry.next;
2380 /* there can already be other linked works, inherit and set */
2381 linked = *bits & WORK_STRUCT_LINKED;
2382 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2383 }
2384
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002385 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002386 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002387 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002388}
2389
Tejun Heo73f53c42010-06-29 10:07:11 +02002390/**
Tejun Heo112202d2013-02-13 19:29:12 -08002391 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002392 * @wq: workqueue being flushed
2393 * @flush_color: new flush color, < 0 for no-op
2394 * @work_color: new work color, < 0 for no-op
2395 *
Tejun Heo112202d2013-02-13 19:29:12 -08002396 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002397 *
Tejun Heo112202d2013-02-13 19:29:12 -08002398 * If @flush_color is non-negative, flush_color on all pwqs should be
2399 * -1. If no pwq has in-flight commands at the specified color, all
2400 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2401 * has in flight commands, its pwq->flush_color is set to
2402 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002403 * wakeup logic is armed and %true is returned.
2404 *
2405 * The caller should have initialized @wq->first_flusher prior to
2406 * calling this function with non-negative @flush_color. If
2407 * @flush_color is negative, no flush color update is done and %false
2408 * is returned.
2409 *
Tejun Heo112202d2013-02-13 19:29:12 -08002410 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002411 * work_color which is previous to @work_color and all will be
2412 * advanced to @work_color.
2413 *
2414 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002415 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002416 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002417 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002418 * %true if @flush_color >= 0 and there's something to flush. %false
2419 * otherwise.
2420 */
Tejun Heo112202d2013-02-13 19:29:12 -08002421static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002422 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423{
Tejun Heo73f53c42010-06-29 10:07:11 +02002424 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002425 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002426
Tejun Heo73f53c42010-06-29 10:07:11 +02002427 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002428 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002429 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002430 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002431
Tejun Heo49e3cf42013-03-12 11:29:58 -07002432 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002433 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002434
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002435 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002436
2437 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002438 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002439
Tejun Heo112202d2013-02-13 19:29:12 -08002440 if (pwq->nr_in_flight[flush_color]) {
2441 pwq->flush_color = flush_color;
2442 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002443 wait = true;
2444 }
2445 }
2446
2447 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002448 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002449 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002450 }
2451
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002452 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002453 }
2454
Tejun Heo112202d2013-02-13 19:29:12 -08002455 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002456 complete(&wq->first_flusher->done);
2457
2458 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459}
2460
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002461/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002463 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002465 * This function sleeps until all work items which were queued on entry
2466 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002468void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469{
Tejun Heo73f53c42010-06-29 10:07:11 +02002470 struct wq_flusher this_flusher = {
2471 .list = LIST_HEAD_INIT(this_flusher.list),
2472 .flush_color = -1,
2473 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2474 };
2475 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002476
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002477 lock_map_acquire(&wq->lockdep_map);
2478 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002479
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002480 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002481
2482 /*
2483 * Start-to-wait phase
2484 */
2485 next_color = work_next_color(wq->work_color);
2486
2487 if (next_color != wq->flush_color) {
2488 /*
2489 * Color space is not full. The current work_color
2490 * becomes our flush_color and work_color is advanced
2491 * by one.
2492 */
Tejun Heo6183c002013-03-12 11:29:57 -07002493 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002494 this_flusher.flush_color = wq->work_color;
2495 wq->work_color = next_color;
2496
2497 if (!wq->first_flusher) {
2498 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002499 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002500
2501 wq->first_flusher = &this_flusher;
2502
Tejun Heo112202d2013-02-13 19:29:12 -08002503 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002504 wq->work_color)) {
2505 /* nothing to flush, done */
2506 wq->flush_color = next_color;
2507 wq->first_flusher = NULL;
2508 goto out_unlock;
2509 }
2510 } else {
2511 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002512 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002513 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002514 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002515 }
2516 } else {
2517 /*
2518 * Oops, color space is full, wait on overflow queue.
2519 * The next flush completion will assign us
2520 * flush_color and transfer to flusher_queue.
2521 */
2522 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2523 }
2524
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002525 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002526
2527 wait_for_completion(&this_flusher.done);
2528
2529 /*
2530 * Wake-up-and-cascade phase
2531 *
2532 * First flushers are responsible for cascading flushes and
2533 * handling overflow. Non-first flushers can simply return.
2534 */
2535 if (wq->first_flusher != &this_flusher)
2536 return;
2537
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002538 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002539
Tejun Heo4ce48b32010-07-02 10:03:51 +02002540 /* we might have raced, check again with mutex held */
2541 if (wq->first_flusher != &this_flusher)
2542 goto out_unlock;
2543
Tejun Heo73f53c42010-06-29 10:07:11 +02002544 wq->first_flusher = NULL;
2545
Tejun Heo6183c002013-03-12 11:29:57 -07002546 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2547 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002548
2549 while (true) {
2550 struct wq_flusher *next, *tmp;
2551
2552 /* complete all the flushers sharing the current flush color */
2553 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2554 if (next->flush_color != wq->flush_color)
2555 break;
2556 list_del_init(&next->list);
2557 complete(&next->done);
2558 }
2559
Tejun Heo6183c002013-03-12 11:29:57 -07002560 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2561 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002562
2563 /* this flush_color is finished, advance by one */
2564 wq->flush_color = work_next_color(wq->flush_color);
2565
2566 /* one color has been freed, handle overflow queue */
2567 if (!list_empty(&wq->flusher_overflow)) {
2568 /*
2569 * Assign the same color to all overflowed
2570 * flushers, advance work_color and append to
2571 * flusher_queue. This is the start-to-wait
2572 * phase for these overflowed flushers.
2573 */
2574 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2575 tmp->flush_color = wq->work_color;
2576
2577 wq->work_color = work_next_color(wq->work_color);
2578
2579 list_splice_tail_init(&wq->flusher_overflow,
2580 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002581 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002582 }
2583
2584 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002585 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002586 break;
2587 }
2588
2589 /*
2590 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002591 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002592 */
Tejun Heo6183c002013-03-12 11:29:57 -07002593 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2594 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002595
2596 list_del_init(&next->list);
2597 wq->first_flusher = next;
2598
Tejun Heo112202d2013-02-13 19:29:12 -08002599 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002600 break;
2601
2602 /*
2603 * Meh... this color is already done, clear first
2604 * flusher and repeat cascading.
2605 */
2606 wq->first_flusher = NULL;
2607 }
2608
2609out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002610 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002611}
Dave Jonesae90dd52006-06-30 01:40:45 -04002612EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002614/**
2615 * drain_workqueue - drain a workqueue
2616 * @wq: workqueue to drain
2617 *
2618 * Wait until the workqueue becomes empty. While draining is in progress,
2619 * only chain queueing is allowed. IOW, only currently pending or running
2620 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002621 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002622 * by the depth of chaining and should be relatively short. Whine if it
2623 * takes too long.
2624 */
2625void drain_workqueue(struct workqueue_struct *wq)
2626{
2627 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002628 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002629
2630 /*
2631 * __queue_work() needs to test whether there are drainers, is much
2632 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002633 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002634 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002635 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002636 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002637 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002638 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002639reflush:
2640 flush_workqueue(wq);
2641
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002642 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002643
Tejun Heo49e3cf42013-03-12 11:29:58 -07002644 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002645 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002646
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002647 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002648 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002649 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002650
2651 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002652 continue;
2653
2654 if (++flush_cnt == 10 ||
2655 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002656 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002657 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002658
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002659 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002660 goto reflush;
2661 }
2662
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002663 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002664 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002665 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002666}
2667EXPORT_SYMBOL_GPL(drain_workqueue);
2668
Tejun Heo606a5022012-08-20 14:51:23 -07002669static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002670{
2671 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002672 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002673 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002674
2675 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002676
Tejun Heofa1b54e2013-03-12 11:30:00 -07002677 local_irq_disable();
2678 pool = get_work_pool(work);
2679 if (!pool) {
2680 local_irq_enable();
2681 return false;
2682 }
2683
2684 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002685 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002686 pwq = get_work_pwq(work);
2687 if (pwq) {
2688 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002689 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002690 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002691 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002692 if (!worker)
2693 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002694 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002695 }
Tejun Heobaf59022010-09-16 10:42:16 +02002696
Tejun Heo112202d2013-02-13 19:29:12 -08002697 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002698 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002699
Tejun Heoe1594892011-01-09 23:32:15 +01002700 /*
2701 * If @max_active is 1 or rescuer is in use, flushing another work
2702 * item on the same workqueue may lead to deadlock. Make sure the
2703 * flusher is not running on the same workqueue by verifying write
2704 * access.
2705 */
Tejun Heo493008a2013-03-12 11:30:03 -07002706 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002707 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002708 else
Tejun Heo112202d2013-02-13 19:29:12 -08002709 lock_map_acquire_read(&pwq->wq->lockdep_map);
2710 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002711
Tejun Heobaf59022010-09-16 10:42:16 +02002712 return true;
2713already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002714 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002715 return false;
2716}
2717
Oleg Nesterovdb700892008-07-25 01:47:49 -07002718/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002719 * flush_work - wait for a work to finish executing the last queueing instance
2720 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002721 *
Tejun Heo606a5022012-08-20 14:51:23 -07002722 * Wait until @work has finished execution. @work is guaranteed to be idle
2723 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002724 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002725 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002726 * %true if flush_work() waited for the work to finish execution,
2727 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002728 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002729bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002730{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002731 struct wq_barrier barr;
2732
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002733 lock_map_acquire(&work->lockdep_map);
2734 lock_map_release(&work->lockdep_map);
2735
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002736 if (start_flush_work(work, &barr)) {
2737 wait_for_completion(&barr.done);
2738 destroy_work_on_stack(&barr.work);
2739 return true;
2740 } else {
2741 return false;
2742 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002743}
2744EXPORT_SYMBOL_GPL(flush_work);
2745
Tejun Heo8603e1b32015-03-05 08:04:13 -05002746struct cwt_wait {
2747 wait_queue_t wait;
2748 struct work_struct *work;
2749};
2750
2751static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2752{
2753 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2754
2755 if (cwait->work != key)
2756 return 0;
2757 return autoremove_wake_function(wait, mode, sync, key);
2758}
2759
Tejun Heo36e227d2012-08-03 10:30:46 -07002760static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002761{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002762 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002763 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002764 int ret;
2765
2766 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002767 ret = try_to_grab_pending(work, is_dwork, &flags);
2768 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002769 * If someone else is already canceling, wait for it to
2770 * finish. flush_work() doesn't work for PREEMPT_NONE
2771 * because we may get scheduled between @work's completion
2772 * and the other canceling task resuming and clearing
2773 * CANCELING - flush_work() will return false immediately
2774 * as @work is no longer busy, try_to_grab_pending() will
2775 * return -ENOENT as @work is still being canceled and the
2776 * other canceling task won't be able to clear CANCELING as
2777 * we're hogging the CPU.
2778 *
2779 * Let's wait for completion using a waitqueue. As this
2780 * may lead to the thundering herd problem, use a custom
2781 * wake function which matches @work along with exclusive
2782 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002783 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002784 if (unlikely(ret == -ENOENT)) {
2785 struct cwt_wait cwait;
2786
2787 init_wait(&cwait.wait);
2788 cwait.wait.func = cwt_wakefn;
2789 cwait.work = work;
2790
2791 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2792 TASK_UNINTERRUPTIBLE);
2793 if (work_is_canceling(work))
2794 schedule();
2795 finish_wait(&cancel_waitq, &cwait.wait);
2796 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002797 } while (unlikely(ret < 0));
2798
Tejun Heobbb68df2012-08-03 10:30:46 -07002799 /* tell other tasks trying to grab @work to back off */
2800 mark_work_canceling(work);
2801 local_irq_restore(flags);
2802
Tejun Heo606a5022012-08-20 14:51:23 -07002803 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002804 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002805
2806 /*
2807 * Paired with prepare_to_wait() above so that either
2808 * waitqueue_active() is visible here or !work_is_canceling() is
2809 * visible there.
2810 */
2811 smp_mb();
2812 if (waitqueue_active(&cancel_waitq))
2813 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2814
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002815 return ret;
2816}
2817
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002818/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002819 * cancel_work_sync - cancel a work and wait for it to finish
2820 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002821 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002822 * Cancel @work and wait for its execution to finish. This function
2823 * can be used even if the work re-queues itself or migrates to
2824 * another workqueue. On return from this function, @work is
2825 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002826 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002827 * cancel_work_sync(&delayed_work->work) must not be used for
2828 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002829 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002830 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002831 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002832 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002833 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002834 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002835 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002836bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002837{
Tejun Heo36e227d2012-08-03 10:30:46 -07002838 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002839}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002840EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002841
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002842/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002843 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2844 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002845 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002846 * Delayed timer is cancelled and the pending work is queued for
2847 * immediate execution. Like flush_work(), this function only
2848 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002849 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002850 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002851 * %true if flush_work() waited for the work to finish execution,
2852 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002853 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002854bool flush_delayed_work(struct delayed_work *dwork)
2855{
Tejun Heo8930cab2012-08-03 10:30:45 -07002856 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002857 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002858 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002859 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002860 return flush_work(&dwork->work);
2861}
2862EXPORT_SYMBOL(flush_delayed_work);
2863
2864/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002865 * cancel_delayed_work - cancel a delayed work
2866 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002867 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002868 * Kill off a pending delayed_work.
2869 *
2870 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2871 * pending.
2872 *
2873 * Note:
2874 * The work callback function may still be running on return, unless
2875 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2876 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002877 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002878 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002879 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002880bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002881{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002882 unsigned long flags;
2883 int ret;
2884
2885 do {
2886 ret = try_to_grab_pending(&dwork->work, true, &flags);
2887 } while (unlikely(ret == -EAGAIN));
2888
2889 if (unlikely(ret < 0))
2890 return false;
2891
Tejun Heo7c3eed52013-01-24 11:01:33 -08002892 set_work_pool_and_clear_pending(&dwork->work,
2893 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002894 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002895 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002896}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002897EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002898
2899/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002900 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2901 * @dwork: the delayed work cancel
2902 *
2903 * This is cancel_work_sync() for delayed works.
2904 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002905 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002906 * %true if @dwork was pending, %false otherwise.
2907 */
2908bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002909{
Tejun Heo36e227d2012-08-03 10:30:46 -07002910 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002911}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002912EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002913
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002914/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002915 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002916 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002917 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002918 * schedule_on_each_cpu() executes @func on each online CPU using the
2919 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002920 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002921 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002922 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02002923 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002924 */
David Howells65f27f32006-11-22 14:55:48 +00002925int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002926{
2927 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002928 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002929
Andrew Mortonb6136772006-06-25 05:47:49 -07002930 works = alloc_percpu(struct work_struct);
2931 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002932 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002933
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002934 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002935
Christoph Lameter15316ba2006-01-08 01:00:43 -08002936 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002937 struct work_struct *work = per_cpu_ptr(works, cpu);
2938
2939 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002940 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002941 }
Tejun Heo93981802009-11-17 14:06:20 -08002942
2943 for_each_online_cpu(cpu)
2944 flush_work(per_cpu_ptr(works, cpu));
2945
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002946 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002947 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002948 return 0;
2949}
2950
Alan Sterneef6a7d2010-02-12 17:39:21 +09002951/**
2952 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2953 *
2954 * Forces execution of the kernel-global workqueue and blocks until its
2955 * completion.
2956 *
2957 * Think twice before calling this function! It's very easy to get into
2958 * trouble if you don't take great care. Either of the following situations
2959 * will lead to deadlock:
2960 *
2961 * One of the work items currently on the workqueue needs to acquire
2962 * a lock held by your code or its caller.
2963 *
2964 * Your code is running in the context of a work routine.
2965 *
2966 * They will be detected by lockdep when they occur, but the first might not
2967 * occur very often. It depends on what work items are on the workqueue and
2968 * what locks they need, which you have no control over.
2969 *
2970 * In most situations flushing the entire workqueue is overkill; you merely
2971 * need to know that a particular work item isn't queued and isn't running.
2972 * In such cases you should use cancel_delayed_work_sync() or
2973 * cancel_work_sync() instead.
2974 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002975void flush_scheduled_work(void)
2976{
Tejun Heod320c032010-06-29 10:07:14 +02002977 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978}
Dave Jonesae90dd52006-06-30 01:40:45 -04002979EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002980
2981/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002982 * execute_in_process_context - reliably execute the routine with user context
2983 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002984 * @ew: guaranteed storage for the execute work structure (must
2985 * be available when the work executes)
2986 *
2987 * Executes the function immediately if process context is available,
2988 * otherwise schedules the function for delayed execution.
2989 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002990 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06002991 * 1 - function was scheduled for execution
2992 */
David Howells65f27f32006-11-22 14:55:48 +00002993int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06002994{
2995 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00002996 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002997 return 0;
2998 }
2999
David Howells65f27f32006-11-22 14:55:48 +00003000 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003001 schedule_work(&ew->work);
3002
3003 return 1;
3004}
3005EXPORT_SYMBOL_GPL(execute_in_process_context);
3006
Tejun Heo7a4e3442013-03-12 11:30:00 -07003007/**
3008 * free_workqueue_attrs - free a workqueue_attrs
3009 * @attrs: workqueue_attrs to free
3010 *
3011 * Undo alloc_workqueue_attrs().
3012 */
3013void free_workqueue_attrs(struct workqueue_attrs *attrs)
3014{
3015 if (attrs) {
3016 free_cpumask_var(attrs->cpumask);
3017 kfree(attrs);
3018 }
3019}
3020
3021/**
3022 * alloc_workqueue_attrs - allocate a workqueue_attrs
3023 * @gfp_mask: allocation mask to use
3024 *
3025 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003026 * return it.
3027 *
3028 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003029 */
3030struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3031{
3032 struct workqueue_attrs *attrs;
3033
3034 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3035 if (!attrs)
3036 goto fail;
3037 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3038 goto fail;
3039
Tejun Heo13e2e552013-04-01 11:23:31 -07003040 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003041 return attrs;
3042fail:
3043 free_workqueue_attrs(attrs);
3044 return NULL;
3045}
3046
Tejun Heo29c91e92013-03-12 11:30:03 -07003047static void copy_workqueue_attrs(struct workqueue_attrs *to,
3048 const struct workqueue_attrs *from)
3049{
3050 to->nice = from->nice;
3051 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003052 /*
3053 * Unlike hash and equality test, this function doesn't ignore
3054 * ->no_numa as it is used for both pool and wq attrs. Instead,
3055 * get_unbound_pool() explicitly clears ->no_numa after copying.
3056 */
3057 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003058}
3059
Tejun Heo29c91e92013-03-12 11:30:03 -07003060/* hash value of the content of @attr */
3061static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3062{
3063 u32 hash = 0;
3064
3065 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003066 hash = jhash(cpumask_bits(attrs->cpumask),
3067 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003068 return hash;
3069}
3070
3071/* content equality test */
3072static bool wqattrs_equal(const struct workqueue_attrs *a,
3073 const struct workqueue_attrs *b)
3074{
3075 if (a->nice != b->nice)
3076 return false;
3077 if (!cpumask_equal(a->cpumask, b->cpumask))
3078 return false;
3079 return true;
3080}
3081
Tejun Heo7a4e3442013-03-12 11:30:00 -07003082/**
3083 * init_worker_pool - initialize a newly zalloc'd worker_pool
3084 * @pool: worker_pool to initialize
3085 *
3086 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003087 *
3088 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003089 * inside @pool proper are initialized and put_unbound_pool() can be called
3090 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003091 */
3092static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003093{
3094 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003095 pool->id = -1;
3096 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003097 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003098 pool->flags |= POOL_DISASSOCIATED;
3099 INIT_LIST_HEAD(&pool->worklist);
3100 INIT_LIST_HEAD(&pool->idle_list);
3101 hash_init(pool->busy_hash);
3102
3103 init_timer_deferrable(&pool->idle_timer);
3104 pool->idle_timer.function = idle_worker_timeout;
3105 pool->idle_timer.data = (unsigned long)pool;
3106
3107 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3108 (unsigned long)pool);
3109
3110 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003111 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003112 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003113
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003114 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003115 INIT_HLIST_NODE(&pool->hash_node);
3116 pool->refcnt = 1;
3117
3118 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003119 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3120 if (!pool->attrs)
3121 return -ENOMEM;
3122 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003123}
3124
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003125static void rcu_free_wq(struct rcu_head *rcu)
3126{
3127 struct workqueue_struct *wq =
3128 container_of(rcu, struct workqueue_struct, rcu);
3129
3130 if (!(wq->flags & WQ_UNBOUND))
3131 free_percpu(wq->cpu_pwqs);
3132 else
3133 free_workqueue_attrs(wq->unbound_attrs);
3134
3135 kfree(wq->rescuer);
3136 kfree(wq);
3137}
3138
Tejun Heo29c91e92013-03-12 11:30:03 -07003139static void rcu_free_pool(struct rcu_head *rcu)
3140{
3141 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3142
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003143 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003144 free_workqueue_attrs(pool->attrs);
3145 kfree(pool);
3146}
3147
3148/**
3149 * put_unbound_pool - put a worker_pool
3150 * @pool: worker_pool to put
3151 *
3152 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003153 * safe manner. get_unbound_pool() calls this function on its failure path
3154 * and this function should be able to release pools which went through,
3155 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003156 *
3157 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003158 */
3159static void put_unbound_pool(struct worker_pool *pool)
3160{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003161 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003162 struct worker *worker;
3163
Tejun Heoa892cac2013-04-01 11:23:32 -07003164 lockdep_assert_held(&wq_pool_mutex);
3165
3166 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003167 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003168
3169 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003170 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003171 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003172 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003173
3174 /* release id and unhash */
3175 if (pool->id >= 0)
3176 idr_remove(&worker_pool_idr, pool->id);
3177 hash_del(&pool->hash_node);
3178
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003179 /*
3180 * Become the manager and destroy all workers. Grabbing
3181 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003182 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003183 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003184 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003185
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003186 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003187 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003188 destroy_worker(worker);
3189 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003190 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003191
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003192 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003193 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003194 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003195 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003196
3197 if (pool->detach_completion)
3198 wait_for_completion(pool->detach_completion);
3199
Tejun Heo29c91e92013-03-12 11:30:03 -07003200 mutex_unlock(&pool->manager_arb);
3201
3202 /* shut down the timers */
3203 del_timer_sync(&pool->idle_timer);
3204 del_timer_sync(&pool->mayday_timer);
3205
3206 /* sched-RCU protected to allow dereferences from get_work_pool() */
3207 call_rcu_sched(&pool->rcu, rcu_free_pool);
3208}
3209
3210/**
3211 * get_unbound_pool - get a worker_pool with the specified attributes
3212 * @attrs: the attributes of the worker_pool to get
3213 *
3214 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3215 * reference count and return it. If there already is a matching
3216 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003217 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003218 *
3219 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003220 *
3221 * Return: On success, a worker_pool with the same attributes as @attrs.
3222 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003223 */
3224static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3225{
Tejun Heo29c91e92013-03-12 11:30:03 -07003226 u32 hash = wqattrs_hash(attrs);
3227 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003228 int node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003229
Tejun Heoa892cac2013-04-01 11:23:32 -07003230 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003231
3232 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003233 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3234 if (wqattrs_equal(pool->attrs, attrs)) {
3235 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003236 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003237 }
3238 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003239
3240 /* nope, create a new one */
3241 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3242 if (!pool || init_worker_pool(pool) < 0)
3243 goto fail;
3244
Tejun Heo8864b4e2013-03-12 11:30:04 -07003245 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003246 copy_workqueue_attrs(pool->attrs, attrs);
3247
Shaohua Li2865a8f2013-08-01 09:56:36 +08003248 /*
3249 * no_numa isn't a worker_pool attribute, always clear it. See
3250 * 'struct workqueue_attrs' comments for detail.
3251 */
3252 pool->attrs->no_numa = false;
3253
Tejun Heof3f90ad2013-04-01 11:23:34 -07003254 /* if cpumask is contained inside a NUMA node, we belong to that node */
3255 if (wq_numa_enabled) {
3256 for_each_node(node) {
3257 if (cpumask_subset(pool->attrs->cpumask,
3258 wq_numa_possible_cpumask[node])) {
3259 pool->node = node;
3260 break;
3261 }
3262 }
3263 }
3264
Tejun Heo29c91e92013-03-12 11:30:03 -07003265 if (worker_pool_assign_id(pool) < 0)
3266 goto fail;
3267
3268 /* create and start the initial worker */
Lai Jiangshan051e1852014-07-22 13:03:02 +08003269 if (!create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003270 goto fail;
3271
Tejun Heo29c91e92013-03-12 11:30:03 -07003272 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003273 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003274
Tejun Heo29c91e92013-03-12 11:30:03 -07003275 return pool;
3276fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003277 if (pool)
3278 put_unbound_pool(pool);
3279 return NULL;
3280}
3281
Tejun Heo8864b4e2013-03-12 11:30:04 -07003282static void rcu_free_pwq(struct rcu_head *rcu)
3283{
3284 kmem_cache_free(pwq_cache,
3285 container_of(rcu, struct pool_workqueue, rcu));
3286}
3287
3288/*
3289 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3290 * and needs to be destroyed.
3291 */
3292static void pwq_unbound_release_workfn(struct work_struct *work)
3293{
3294 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3295 unbound_release_work);
3296 struct workqueue_struct *wq = pwq->wq;
3297 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003298 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003299
3300 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3301 return;
3302
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003303 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003304 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003305 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003306 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003307
Tejun Heoa892cac2013-04-01 11:23:32 -07003308 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003309 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003310 mutex_unlock(&wq_pool_mutex);
3311
Tejun Heo8864b4e2013-03-12 11:30:04 -07003312 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3313
3314 /*
3315 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003316 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003317 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003318 if (is_last)
3319 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003320}
3321
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003322/**
Tejun Heo699ce092013-03-13 16:51:35 -07003323 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003324 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003325 *
Tejun Heo699ce092013-03-13 16:51:35 -07003326 * If @pwq isn't freezing, set @pwq->max_active to the associated
3327 * workqueue's saved_max_active and activate delayed work items
3328 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003329 */
Tejun Heo699ce092013-03-13 16:51:35 -07003330static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003331{
Tejun Heo699ce092013-03-13 16:51:35 -07003332 struct workqueue_struct *wq = pwq->wq;
3333 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003334
Tejun Heo699ce092013-03-13 16:51:35 -07003335 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003336 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003337
3338 /* fast exit for non-freezable wqs */
3339 if (!freezable && pwq->max_active == wq->saved_max_active)
3340 return;
3341
Lai Jiangshana357fc02013-03-25 16:57:19 -07003342 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003343
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003344 /*
3345 * During [un]freezing, the caller is responsible for ensuring that
3346 * this function is called at least once after @workqueue_freezing
3347 * is updated and visible.
3348 */
3349 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003350 pwq->max_active = wq->saved_max_active;
3351
3352 while (!list_empty(&pwq->delayed_works) &&
3353 pwq->nr_active < pwq->max_active)
3354 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003355
3356 /*
3357 * Need to kick a worker after thawed or an unbound wq's
3358 * max_active is bumped. It's a slow path. Do it always.
3359 */
3360 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003361 } else {
3362 pwq->max_active = 0;
3363 }
3364
Lai Jiangshana357fc02013-03-25 16:57:19 -07003365 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003366}
3367
Tejun Heoe50aba92013-04-01 11:23:35 -07003368/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003369static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3370 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003371{
3372 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3373
Tejun Heoe50aba92013-04-01 11:23:35 -07003374 memset(pwq, 0, sizeof(*pwq));
3375
Tejun Heod2c1d402013-03-12 11:30:04 -07003376 pwq->pool = pool;
3377 pwq->wq = wq;
3378 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003379 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003380 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003381 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003382 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003383 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003384}
Tejun Heod2c1d402013-03-12 11:30:04 -07003385
Tejun Heof147f292013-04-01 11:23:35 -07003386/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003387static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003388{
3389 struct workqueue_struct *wq = pwq->wq;
3390
3391 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003392
Tejun Heo1befcf32013-04-01 11:23:35 -07003393 /* may be called multiple times, ignore if already linked */
3394 if (!list_empty(&pwq->pwqs_node))
3395 return;
3396
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003397 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003398 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003399
3400 /* sync max_active to the current setting */
3401 pwq_adjust_max_active(pwq);
3402
3403 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003404 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003405}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003406
Tejun Heof147f292013-04-01 11:23:35 -07003407/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3408static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3409 const struct workqueue_attrs *attrs)
3410{
3411 struct worker_pool *pool;
3412 struct pool_workqueue *pwq;
3413
3414 lockdep_assert_held(&wq_pool_mutex);
3415
3416 pool = get_unbound_pool(attrs);
3417 if (!pool)
3418 return NULL;
3419
Tejun Heoe50aba92013-04-01 11:23:35 -07003420 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003421 if (!pwq) {
3422 put_unbound_pool(pool);
3423 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003424 }
Tejun Heo6029a912013-04-01 11:23:34 -07003425
Tejun Heof147f292013-04-01 11:23:35 -07003426 init_pwq(pwq, wq, pool);
3427 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003428}
3429
Tejun Heo4c16bd32013-04-01 11:23:36 -07003430/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003431 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003432 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003433 * @node: the target NUMA node
3434 * @cpu_going_down: if >= 0, the CPU to consider as offline
3435 * @cpumask: outarg, the resulting cpumask
3436 *
3437 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3438 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003439 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003440 *
3441 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3442 * enabled and @node has online CPUs requested by @attrs, the returned
3443 * cpumask is the intersection of the possible CPUs of @node and
3444 * @attrs->cpumask.
3445 *
3446 * The caller is responsible for ensuring that the cpumask of @node stays
3447 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003448 *
3449 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3450 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003451 */
3452static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3453 int cpu_going_down, cpumask_t *cpumask)
3454{
Tejun Heod55262c2013-04-01 11:23:38 -07003455 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003456 goto use_dfl;
3457
3458 /* does @node have any online CPUs @attrs wants? */
3459 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3460 if (cpu_going_down >= 0)
3461 cpumask_clear_cpu(cpu_going_down, cpumask);
3462
3463 if (cpumask_empty(cpumask))
3464 goto use_dfl;
3465
3466 /* yeap, return possible CPUs in @node that @attrs wants */
3467 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3468 return !cpumask_equal(cpumask, attrs->cpumask);
3469
3470use_dfl:
3471 cpumask_copy(cpumask, attrs->cpumask);
3472 return false;
3473}
3474
Tejun Heo1befcf32013-04-01 11:23:35 -07003475/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3476static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3477 int node,
3478 struct pool_workqueue *pwq)
3479{
3480 struct pool_workqueue *old_pwq;
3481
3482 lockdep_assert_held(&wq->mutex);
3483
3484 /* link_pwq() can handle duplicate calls */
3485 link_pwq(pwq);
3486
3487 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3488 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3489 return old_pwq;
3490}
3491
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003492/* context to store the prepared attrs & pwqs before applying */
3493struct apply_wqattrs_ctx {
3494 struct workqueue_struct *wq; /* target workqueue */
3495 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003496 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003497 struct pool_workqueue *dfl_pwq;
3498 struct pool_workqueue *pwq_tbl[];
3499};
3500
3501/* free the resources after success or abort */
3502static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3503{
3504 if (ctx) {
3505 int node;
3506
3507 for_each_node(node)
3508 put_pwq_unlocked(ctx->pwq_tbl[node]);
3509 put_pwq_unlocked(ctx->dfl_pwq);
3510
3511 free_workqueue_attrs(ctx->attrs);
3512
3513 kfree(ctx);
3514 }
3515}
3516
3517/* allocate the attrs and pwqs for later installation */
3518static struct apply_wqattrs_ctx *
3519apply_wqattrs_prepare(struct workqueue_struct *wq,
3520 const struct workqueue_attrs *attrs)
3521{
3522 struct apply_wqattrs_ctx *ctx;
3523 struct workqueue_attrs *new_attrs, *tmp_attrs;
3524 int node;
3525
3526 lockdep_assert_held(&wq_pool_mutex);
3527
3528 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3529 GFP_KERNEL);
3530
3531 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3532 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3533 if (!ctx || !new_attrs || !tmp_attrs)
3534 goto out_free;
3535
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003536 /*
3537 * Calculate the attrs of the default pwq.
3538 * If the user configured cpumask doesn't overlap with the
3539 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3540 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003541 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003542 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003543 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3544 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003545
3546 /*
3547 * We may create multiple pwqs with differing cpumasks. Make a
3548 * copy of @new_attrs which will be modified and used to obtain
3549 * pools.
3550 */
3551 copy_workqueue_attrs(tmp_attrs, new_attrs);
3552
3553 /*
3554 * If something goes wrong during CPU up/down, we'll fall back to
3555 * the default pwq covering whole @attrs->cpumask. Always create
3556 * it even if we don't use it immediately.
3557 */
3558 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3559 if (!ctx->dfl_pwq)
3560 goto out_free;
3561
3562 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003563 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003564 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3565 if (!ctx->pwq_tbl[node])
3566 goto out_free;
3567 } else {
3568 ctx->dfl_pwq->refcnt++;
3569 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3570 }
3571 }
3572
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003573 /* save the user configured attrs and sanitize it. */
3574 copy_workqueue_attrs(new_attrs, attrs);
3575 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003576 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003577
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003578 ctx->wq = wq;
3579 free_workqueue_attrs(tmp_attrs);
3580 return ctx;
3581
3582out_free:
3583 free_workqueue_attrs(tmp_attrs);
3584 free_workqueue_attrs(new_attrs);
3585 apply_wqattrs_cleanup(ctx);
3586 return NULL;
3587}
3588
3589/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3590static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3591{
3592 int node;
3593
3594 /* all pwqs have been created successfully, let's install'em */
3595 mutex_lock(&ctx->wq->mutex);
3596
3597 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3598
3599 /* save the previous pwq and install the new one */
3600 for_each_node(node)
3601 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3602 ctx->pwq_tbl[node]);
3603
3604 /* @dfl_pwq might not have been used, ensure it's linked */
3605 link_pwq(ctx->dfl_pwq);
3606 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3607
3608 mutex_unlock(&ctx->wq->mutex);
3609}
3610
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003611/**
3612 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3613 * @wq: the target workqueue
3614 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3615 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003616 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3617 * machines, this function maps a separate pwq to each NUMA node with
3618 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3619 * NUMA node it was issued on. Older pwqs are released as in-flight work
3620 * items finish. Note that a work item which repeatedly requeues itself
3621 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003622 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003623 * Performs GFP_KERNEL allocations.
3624 *
3625 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003626 */
3627int apply_workqueue_attrs(struct workqueue_struct *wq,
3628 const struct workqueue_attrs *attrs)
3629{
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003630 struct apply_wqattrs_ctx *ctx;
3631 int ret = -ENOMEM;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003632
Tejun Heo8719dce2013-03-12 11:30:04 -07003633 /* only unbound workqueues can change attributes */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003634 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3635 return -EINVAL;
3636
Tejun Heo8719dce2013-03-12 11:30:04 -07003637 /* creating multiple pwqs breaks ordering guarantee */
3638 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3639 return -EINVAL;
3640
Tejun Heo4c16bd32013-04-01 11:23:36 -07003641 /*
3642 * CPUs should stay stable across pwq creations and installations.
3643 * Pin CPUs, determine the target cpumask for each node and create
3644 * pwqs accordingly.
3645 */
3646 get_online_cpus();
3647
3648 mutex_lock(&wq_pool_mutex);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003649 ctx = apply_wqattrs_prepare(wq, attrs);
3650 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003651
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003652 /* the ctx has been prepared successfully, let's commit it */
3653 if (ctx) {
3654 apply_wqattrs_commit(ctx);
3655 ret = 0;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003656 }
3657
Tejun Heo4c16bd32013-04-01 11:23:36 -07003658 put_online_cpus();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003659
3660 apply_wqattrs_cleanup(ctx);
3661
Tejun Heo48621252013-04-01 11:23:31 -07003662 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003663}
3664
Tejun Heo4c16bd32013-04-01 11:23:36 -07003665/**
3666 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3667 * @wq: the target workqueue
3668 * @cpu: the CPU coming up or going down
3669 * @online: whether @cpu is coming up or going down
3670 *
3671 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3672 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3673 * @wq accordingly.
3674 *
3675 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3676 * falls back to @wq->dfl_pwq which may not be optimal but is always
3677 * correct.
3678 *
3679 * Note that when the last allowed CPU of a NUMA node goes offline for a
3680 * workqueue with a cpumask spanning multiple nodes, the workers which were
3681 * already executing the work items for the workqueue will lose their CPU
3682 * affinity and may execute on any CPU. This is similar to how per-cpu
3683 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3684 * affinity, it's the user's responsibility to flush the work item from
3685 * CPU_DOWN_PREPARE.
3686 */
3687static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3688 bool online)
3689{
3690 int node = cpu_to_node(cpu);
3691 int cpu_off = online ? -1 : cpu;
3692 struct pool_workqueue *old_pwq = NULL, *pwq;
3693 struct workqueue_attrs *target_attrs;
3694 cpumask_t *cpumask;
3695
3696 lockdep_assert_held(&wq_pool_mutex);
3697
3698 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
3699 return;
3700
3701 /*
3702 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3703 * Let's use a preallocated one. The following buf is protected by
3704 * CPU hotplug exclusion.
3705 */
3706 target_attrs = wq_update_unbound_numa_attrs_buf;
3707 cpumask = target_attrs->cpumask;
3708
3709 mutex_lock(&wq->mutex);
Tejun Heod55262c2013-04-01 11:23:38 -07003710 if (wq->unbound_attrs->no_numa)
3711 goto out_unlock;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003712
3713 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3714 pwq = unbound_pwq_by_node(wq, node);
3715
3716 /*
3717 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003718 * different from the default pwq's, we need to compare it to @pwq's
3719 * and create a new one if they don't match. If the target cpumask
3720 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003721 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003722 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003723 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
3724 goto out_unlock;
3725 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003726 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003727 }
3728
3729 mutex_unlock(&wq->mutex);
3730
3731 /* create a new pwq */
3732 pwq = alloc_unbound_pwq(wq, target_attrs);
3733 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003734 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3735 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003736 mutex_lock(&wq->mutex);
3737 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003738 }
3739
3740 /*
3741 * Install the new pwq. As this function is called only from CPU
3742 * hotplug callbacks and applying a new attrs is wrapped with
3743 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
3744 * inbetween.
3745 */
3746 mutex_lock(&wq->mutex);
3747 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3748 goto out_unlock;
3749
3750use_dfl_pwq:
3751 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3752 get_pwq(wq->dfl_pwq);
3753 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3754 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3755out_unlock:
3756 mutex_unlock(&wq->mutex);
3757 put_pwq_unlocked(old_pwq);
3758}
3759
Tejun Heo30cdf242013-03-12 11:29:57 -07003760static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003761{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003762 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003763 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003764
Tejun Heo30cdf242013-03-12 11:29:57 -07003765 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003766 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3767 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003768 return -ENOMEM;
3769
3770 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003771 struct pool_workqueue *pwq =
3772 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003773 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003774 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003775
Tejun Heof147f292013-04-01 11:23:35 -07003776 init_pwq(pwq, wq, &cpu_pools[highpri]);
3777
3778 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003779 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003780 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003781 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003782 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003783 } else if (wq->flags & __WQ_ORDERED) {
3784 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3785 /* there should only be single pwq for ordering guarantee */
3786 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3787 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3788 "ordering guarantee broken for workqueue %s\n", wq->name);
3789 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003790 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003791 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003792 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003793}
3794
Tejun Heof3421792010-07-02 10:03:51 +02003795static int wq_clamp_max_active(int max_active, unsigned int flags,
3796 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003797{
Tejun Heof3421792010-07-02 10:03:51 +02003798 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3799
3800 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003801 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3802 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003803
Tejun Heof3421792010-07-02 10:03:51 +02003804 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003805}
3806
Tejun Heob196be82012-01-10 15:11:35 -08003807struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003808 unsigned int flags,
3809 int max_active,
3810 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003811 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003812{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003813 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003814 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003815 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003816 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003817
Viresh Kumarcee22a12013-04-08 16:45:40 +05303818 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3819 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3820 flags |= WQ_UNBOUND;
3821
Tejun Heoecf68812013-04-01 11:23:34 -07003822 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003823 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003824 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003825
3826 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003827 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003828 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003829
Tejun Heo6029a912013-04-01 11:23:34 -07003830 if (flags & WQ_UNBOUND) {
3831 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3832 if (!wq->unbound_attrs)
3833 goto err_free_wq;
3834 }
3835
Tejun Heoecf68812013-04-01 11:23:34 -07003836 va_start(args, lock_name);
3837 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003838 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003839
Tejun Heod320c032010-06-29 10:07:14 +02003840 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003841 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003842
Tejun Heob196be82012-01-10 15:11:35 -08003843 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003844 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003845 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003846 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003847 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003848 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003849 INIT_LIST_HEAD(&wq->flusher_queue);
3850 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003851 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003852
Johannes Bergeb13ba82008-01-16 09:51:58 +01003853 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003854 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003855
Tejun Heo30cdf242013-03-12 11:29:57 -07003856 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07003857 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003858
Tejun Heo493008a2013-03-12 11:30:03 -07003859 /*
3860 * Workqueues which may be used during memory reclaim should
3861 * have a rescuer to guarantee forward progress.
3862 */
3863 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003864 struct worker *rescuer;
3865
Lai Jiangshanf7537df2014-07-15 17:24:15 +08003866 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003867 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07003868 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02003869
Tejun Heo111c2252013-01-17 17:16:24 -08003870 rescuer->rescue_wq = wq;
3871 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003872 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07003873 if (IS_ERR(rescuer->task)) {
3874 kfree(rescuer);
3875 goto err_destroy;
3876 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003877
Tejun Heod2c1d402013-03-12 11:30:04 -07003878 wq->rescuer = rescuer;
Tejun Heo14a40ff2013-03-19 13:45:20 -07003879 rescuer->task->flags |= PF_NO_SETAFFINITY;
Tejun Heoe22bee72010-06-29 10:07:14 +02003880 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003881 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003882
Tejun Heo226223a2013-03-12 11:30:05 -07003883 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3884 goto err_destroy;
3885
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003886 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003887 * wq_pool_mutex protects global freeze state and workqueues list.
3888 * Grab it, adjust max_active and add the new @wq to workqueues
3889 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003890 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003891 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003892
Lai Jiangshana357fc02013-03-25 16:57:19 -07003893 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003894 for_each_pwq(pwq, wq)
3895 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07003896 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003897
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003898 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003899
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003900 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02003901
Oleg Nesterov3af244332007-05-09 02:34:09 -07003902 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003903
3904err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07003905 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07003906 kfree(wq);
3907 return NULL;
3908err_destroy:
3909 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003910 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003911}
Tejun Heod320c032010-06-29 10:07:14 +02003912EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003913
3914/**
3915 * destroy_workqueue - safely terminate a workqueue
3916 * @wq: target workqueue
3917 *
3918 * Safely destroy a workqueue. All work currently pending will be done first.
3919 */
3920void destroy_workqueue(struct workqueue_struct *wq)
3921{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003922 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003923 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003924
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003925 /* drain it before proceeding with destruction */
3926 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003927
Tejun Heo6183c002013-03-12 11:29:57 -07003928 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003929 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07003930 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07003931 int i;
3932
Tejun Heo76af4d92013-03-12 11:30:00 -07003933 for (i = 0; i < WORK_NR_COLORS; i++) {
3934 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003935 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003936 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003937 }
3938 }
3939
Lai Jiangshan5c529592013-04-04 10:05:38 +08003940 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07003941 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07003942 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003943 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003944 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003945 }
Tejun Heo6183c002013-03-12 11:29:57 -07003946 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003947 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003948
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003949 /*
3950 * wq list is used to freeze wq, remove from list after
3951 * flushing is complete in case freeze races us.
3952 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003953 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003954 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003955 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003956
Tejun Heo226223a2013-03-12 11:30:05 -07003957 workqueue_sysfs_unregister(wq);
3958
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003959 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02003960 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02003961
Tejun Heo8864b4e2013-03-12 11:30:04 -07003962 if (!(wq->flags & WQ_UNBOUND)) {
3963 /*
3964 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003965 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003966 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003967 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003968 } else {
3969 /*
3970 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07003971 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
3972 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003973 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003974 for_each_node(node) {
3975 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3976 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
3977 put_pwq_unlocked(pwq);
3978 }
3979
3980 /*
3981 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
3982 * put. Don't access it afterwards.
3983 */
3984 pwq = wq->dfl_pwq;
3985 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07003986 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07003987 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003988}
3989EXPORT_SYMBOL_GPL(destroy_workqueue);
3990
Tejun Heodcd989c2010-06-29 10:07:14 +02003991/**
3992 * workqueue_set_max_active - adjust max_active of a workqueue
3993 * @wq: target workqueue
3994 * @max_active: new max_active value.
3995 *
3996 * Set max_active of @wq to @max_active.
3997 *
3998 * CONTEXT:
3999 * Don't call from IRQ context.
4000 */
4001void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4002{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004003 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004004
Tejun Heo8719dce2013-03-12 11:30:04 -07004005 /* disallow meddling with max_active for ordered workqueues */
4006 if (WARN_ON(wq->flags & __WQ_ORDERED))
4007 return;
4008
Tejun Heof3421792010-07-02 10:03:51 +02004009 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004010
Lai Jiangshana357fc02013-03-25 16:57:19 -07004011 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004012
4013 wq->saved_max_active = max_active;
4014
Tejun Heo699ce092013-03-13 16:51:35 -07004015 for_each_pwq(pwq, wq)
4016 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004017
Lai Jiangshana357fc02013-03-25 16:57:19 -07004018 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004019}
4020EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4021
4022/**
Tejun Heoe62676162013-03-12 17:41:37 -07004023 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4024 *
4025 * Determine whether %current is a workqueue rescuer. Can be used from
4026 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004027 *
4028 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004029 */
4030bool current_is_workqueue_rescuer(void)
4031{
4032 struct worker *worker = current_wq_worker();
4033
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004034 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004035}
4036
4037/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004038 * workqueue_congested - test whether a workqueue is congested
4039 * @cpu: CPU in question
4040 * @wq: target workqueue
4041 *
4042 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4043 * no synchronization around this function and the test result is
4044 * unreliable and only useful as advisory hints or for debugging.
4045 *
Tejun Heod3251852013-05-10 11:10:17 -07004046 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4047 * Note that both per-cpu and unbound workqueues may be associated with
4048 * multiple pool_workqueues which have separate congested states. A
4049 * workqueue being congested on one CPU doesn't mean the workqueue is also
4050 * contested on other CPUs / NUMA nodes.
4051 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004052 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004053 * %true if congested, %false otherwise.
4054 */
Tejun Heod84ff052013-03-12 11:29:59 -07004055bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004056{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004057 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004058 bool ret;
4059
Lai Jiangshan88109452013-03-20 03:28:10 +08004060 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004061
Tejun Heod3251852013-05-10 11:10:17 -07004062 if (cpu == WORK_CPU_UNBOUND)
4063 cpu = smp_processor_id();
4064
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004065 if (!(wq->flags & WQ_UNBOUND))
4066 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4067 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004068 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004069
Tejun Heo76af4d92013-03-12 11:30:00 -07004070 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004071 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004072
4073 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004074}
4075EXPORT_SYMBOL_GPL(workqueue_congested);
4076
4077/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004078 * work_busy - test whether a work is currently pending or running
4079 * @work: the work to be tested
4080 *
4081 * Test whether @work is currently pending or running. There is no
4082 * synchronization around this function and the test result is
4083 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004084 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004085 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004086 * OR'd bitmask of WORK_BUSY_* bits.
4087 */
4088unsigned int work_busy(struct work_struct *work)
4089{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004090 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004091 unsigned long flags;
4092 unsigned int ret = 0;
4093
Tejun Heodcd989c2010-06-29 10:07:14 +02004094 if (work_pending(work))
4095 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004096
Tejun Heofa1b54e2013-03-12 11:30:00 -07004097 local_irq_save(flags);
4098 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004099 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004100 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004101 if (find_worker_executing_work(pool, work))
4102 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004103 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004104 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004105 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004106
4107 return ret;
4108}
4109EXPORT_SYMBOL_GPL(work_busy);
4110
Tejun Heo3d1cb202013-04-30 15:27:22 -07004111/**
4112 * set_worker_desc - set description for the current work item
4113 * @fmt: printf-style format string
4114 * @...: arguments for the format string
4115 *
4116 * This function can be called by a running work function to describe what
4117 * the work item is about. If the worker task gets dumped, this
4118 * information will be printed out together to help debugging. The
4119 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4120 */
4121void set_worker_desc(const char *fmt, ...)
4122{
4123 struct worker *worker = current_wq_worker();
4124 va_list args;
4125
4126 if (worker) {
4127 va_start(args, fmt);
4128 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4129 va_end(args);
4130 worker->desc_valid = true;
4131 }
4132}
4133
4134/**
4135 * print_worker_info - print out worker information and description
4136 * @log_lvl: the log level to use when printing
4137 * @task: target task
4138 *
4139 * If @task is a worker and currently executing a work item, print out the
4140 * name of the workqueue being serviced and worker description set with
4141 * set_worker_desc() by the currently executing work item.
4142 *
4143 * This function can be safely called on any task as long as the
4144 * task_struct itself is accessible. While safe, this function isn't
4145 * synchronized and may print out mixups or garbages of limited length.
4146 */
4147void print_worker_info(const char *log_lvl, struct task_struct *task)
4148{
4149 work_func_t *fn = NULL;
4150 char name[WQ_NAME_LEN] = { };
4151 char desc[WORKER_DESC_LEN] = { };
4152 struct pool_workqueue *pwq = NULL;
4153 struct workqueue_struct *wq = NULL;
4154 bool desc_valid = false;
4155 struct worker *worker;
4156
4157 if (!(task->flags & PF_WQ_WORKER))
4158 return;
4159
4160 /*
4161 * This function is called without any synchronization and @task
4162 * could be in any state. Be careful with dereferences.
4163 */
4164 worker = probe_kthread_data(task);
4165
4166 /*
4167 * Carefully copy the associated workqueue's workfn and name. Keep
4168 * the original last '\0' in case the original contains garbage.
4169 */
4170 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4171 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4172 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4173 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4174
4175 /* copy worker description */
4176 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4177 if (desc_valid)
4178 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4179
4180 if (fn || name[0] || desc[0]) {
4181 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4182 if (desc[0])
4183 pr_cont(" (%s)", desc);
4184 pr_cont("\n");
4185 }
4186}
4187
Tejun Heo3494fc32015-03-09 09:22:28 -04004188static void pr_cont_pool_info(struct worker_pool *pool)
4189{
4190 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4191 if (pool->node != NUMA_NO_NODE)
4192 pr_cont(" node=%d", pool->node);
4193 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4194}
4195
4196static void pr_cont_work(bool comma, struct work_struct *work)
4197{
4198 if (work->func == wq_barrier_func) {
4199 struct wq_barrier *barr;
4200
4201 barr = container_of(work, struct wq_barrier, work);
4202
4203 pr_cont("%s BAR(%d)", comma ? "," : "",
4204 task_pid_nr(barr->task));
4205 } else {
4206 pr_cont("%s %pf", comma ? "," : "", work->func);
4207 }
4208}
4209
4210static void show_pwq(struct pool_workqueue *pwq)
4211{
4212 struct worker_pool *pool = pwq->pool;
4213 struct work_struct *work;
4214 struct worker *worker;
4215 bool has_in_flight = false, has_pending = false;
4216 int bkt;
4217
4218 pr_info(" pwq %d:", pool->id);
4219 pr_cont_pool_info(pool);
4220
4221 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4222 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4223
4224 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4225 if (worker->current_pwq == pwq) {
4226 has_in_flight = true;
4227 break;
4228 }
4229 }
4230 if (has_in_flight) {
4231 bool comma = false;
4232
4233 pr_info(" in-flight:");
4234 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4235 if (worker->current_pwq != pwq)
4236 continue;
4237
4238 pr_cont("%s %d%s:%pf", comma ? "," : "",
4239 task_pid_nr(worker->task),
4240 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4241 worker->current_func);
4242 list_for_each_entry(work, &worker->scheduled, entry)
4243 pr_cont_work(false, work);
4244 comma = true;
4245 }
4246 pr_cont("\n");
4247 }
4248
4249 list_for_each_entry(work, &pool->worklist, entry) {
4250 if (get_work_pwq(work) == pwq) {
4251 has_pending = true;
4252 break;
4253 }
4254 }
4255 if (has_pending) {
4256 bool comma = false;
4257
4258 pr_info(" pending:");
4259 list_for_each_entry(work, &pool->worklist, entry) {
4260 if (get_work_pwq(work) != pwq)
4261 continue;
4262
4263 pr_cont_work(comma, work);
4264 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4265 }
4266 pr_cont("\n");
4267 }
4268
4269 if (!list_empty(&pwq->delayed_works)) {
4270 bool comma = false;
4271
4272 pr_info(" delayed:");
4273 list_for_each_entry(work, &pwq->delayed_works, entry) {
4274 pr_cont_work(comma, work);
4275 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4276 }
4277 pr_cont("\n");
4278 }
4279}
4280
4281/**
4282 * show_workqueue_state - dump workqueue state
4283 *
4284 * Called from a sysrq handler and prints out all busy workqueues and
4285 * pools.
4286 */
4287void show_workqueue_state(void)
4288{
4289 struct workqueue_struct *wq;
4290 struct worker_pool *pool;
4291 unsigned long flags;
4292 int pi;
4293
4294 rcu_read_lock_sched();
4295
4296 pr_info("Showing busy workqueues and worker pools:\n");
4297
4298 list_for_each_entry_rcu(wq, &workqueues, list) {
4299 struct pool_workqueue *pwq;
4300 bool idle = true;
4301
4302 for_each_pwq(pwq, wq) {
4303 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4304 idle = false;
4305 break;
4306 }
4307 }
4308 if (idle)
4309 continue;
4310
4311 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4312
4313 for_each_pwq(pwq, wq) {
4314 spin_lock_irqsave(&pwq->pool->lock, flags);
4315 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4316 show_pwq(pwq);
4317 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4318 }
4319 }
4320
4321 for_each_pool(pool, pi) {
4322 struct worker *worker;
4323 bool first = true;
4324
4325 spin_lock_irqsave(&pool->lock, flags);
4326 if (pool->nr_workers == pool->nr_idle)
4327 goto next_pool;
4328
4329 pr_info("pool %d:", pool->id);
4330 pr_cont_pool_info(pool);
4331 pr_cont(" workers=%d", pool->nr_workers);
4332 if (pool->manager)
4333 pr_cont(" manager: %d",
4334 task_pid_nr(pool->manager->task));
4335 list_for_each_entry(worker, &pool->idle_list, entry) {
4336 pr_cont(" %s%d", first ? "idle: " : "",
4337 task_pid_nr(worker->task));
4338 first = false;
4339 }
4340 pr_cont("\n");
4341 next_pool:
4342 spin_unlock_irqrestore(&pool->lock, flags);
4343 }
4344
4345 rcu_read_unlock_sched();
4346}
4347
Tejun Heodb7bccf2010-06-29 10:07:12 +02004348/*
4349 * CPU hotplug.
4350 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004351 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004352 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004353 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004354 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004355 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004356 * blocked draining impractical.
4357 *
Tejun Heo24647572013-01-24 11:01:33 -08004358 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004359 * running as an unbound one and allowing it to be reattached later if the
4360 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004361 */
4362
Tejun Heo706026c2013-01-24 11:01:34 -08004363static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004364{
Tejun Heo38db41d2013-01-24 11:01:34 -08004365 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004366 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004367 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004368
Tejun Heof02ae732013-03-12 11:30:03 -07004369 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004370 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004371 spin_lock_irq(&pool->lock);
4372
4373 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004374 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004375 * unbound and set DISASSOCIATED. Before this, all workers
4376 * except for the ones which are still executing works from
4377 * before the last CPU down must be on the cpu. After
4378 * this, they may become diasporas.
4379 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004380 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004381 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004382
Tejun Heo24647572013-01-24 11:01:33 -08004383 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004384
Tejun Heo94cf58b2013-01-24 11:01:33 -08004385 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004386 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004387
Lai Jiangshaneb283422013-03-08 15:18:28 -08004388 /*
4389 * Call schedule() so that we cross rq->lock and thus can
4390 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4391 * This is necessary as scheduler callbacks may be invoked
4392 * from other cpus.
4393 */
4394 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004395
Lai Jiangshaneb283422013-03-08 15:18:28 -08004396 /*
4397 * Sched callbacks are disabled now. Zap nr_running.
4398 * After this, nr_running stays zero and need_more_worker()
4399 * and keep_working() are always true as long as the
4400 * worklist is not empty. This pool now behaves as an
4401 * unbound (in terms of concurrency management) pool which
4402 * are served by workers tied to the pool.
4403 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004404 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004405
4406 /*
4407 * With concurrency management just turned off, a busy
4408 * worker blocking could lead to lengthy stalls. Kick off
4409 * unbound chain execution of currently pending work items.
4410 */
4411 spin_lock_irq(&pool->lock);
4412 wake_up_worker(pool);
4413 spin_unlock_irq(&pool->lock);
4414 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004415}
4416
Tejun Heobd7c0892013-03-19 13:45:21 -07004417/**
4418 * rebind_workers - rebind all workers of a pool to the associated CPU
4419 * @pool: pool of interest
4420 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004421 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004422 */
4423static void rebind_workers(struct worker_pool *pool)
4424{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004425 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004426
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004427 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004428
Tejun Heoa9ab7752013-03-19 13:45:21 -07004429 /*
4430 * Restore CPU affinity of all workers. As all idle workers should
4431 * be on the run-queue of the associated CPU before any local
4432 * wake-ups for concurrency management happen, restore CPU affinty
4433 * of all workers first and then clear UNBOUND. As we're called
4434 * from CPU_ONLINE, the following shouldn't fail.
4435 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004436 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004437 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4438 pool->attrs->cpumask) < 0);
4439
4440 spin_lock_irq(&pool->lock);
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004441 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004442
Lai Jiangshanda028462014-05-20 17:46:31 +08004443 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004444 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004445
4446 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004447 * A bound idle worker should actually be on the runqueue
4448 * of the associated CPU for local wake-ups targeting it to
4449 * work. Kick all idle workers so that they migrate to the
4450 * associated CPU. Doing this in the same loop as
4451 * replacing UNBOUND with REBOUND is safe as no worker will
4452 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004453 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004454 if (worker_flags & WORKER_IDLE)
4455 wake_up_process(worker->task);
4456
4457 /*
4458 * We want to clear UNBOUND but can't directly call
4459 * worker_clr_flags() or adjust nr_running. Atomically
4460 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4461 * @worker will clear REBOUND using worker_clr_flags() when
4462 * it initiates the next execution cycle thus restoring
4463 * concurrency management. Note that when or whether
4464 * @worker clears REBOUND doesn't affect correctness.
4465 *
4466 * ACCESS_ONCE() is necessary because @worker->flags may be
4467 * tested without holding any lock in
4468 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4469 * fail incorrectly leading to premature concurrency
4470 * management operations.
4471 */
4472 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4473 worker_flags |= WORKER_REBOUND;
4474 worker_flags &= ~WORKER_UNBOUND;
4475 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004476 }
4477
Tejun Heoa9ab7752013-03-19 13:45:21 -07004478 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004479}
4480
Tejun Heo7dbc7252013-03-19 13:45:21 -07004481/**
4482 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4483 * @pool: unbound pool of interest
4484 * @cpu: the CPU which is coming up
4485 *
4486 * An unbound pool may end up with a cpumask which doesn't have any online
4487 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4488 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4489 * online CPU before, cpus_allowed of all its workers should be restored.
4490 */
4491static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4492{
4493 static cpumask_t cpumask;
4494 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004495
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004496 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004497
4498 /* is @cpu allowed for @pool? */
4499 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4500 return;
4501
4502 /* is @cpu the only online CPU? */
4503 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4504 if (cpumask_weight(&cpumask) != 1)
4505 return;
4506
4507 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004508 for_each_pool_worker(worker, pool)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004509 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4510 pool->attrs->cpumask) < 0);
4511}
4512
Tejun Heo8db25e72012-07-17 12:39:28 -07004513/*
4514 * Workqueues should be brought up before normal priority CPU notifiers.
4515 * This will be registered high priority CPU notifier.
4516 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004517static int workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004518 unsigned long action,
4519 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004520{
Tejun Heod84ff052013-03-12 11:29:59 -07004521 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004522 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004523 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004524 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004525
Tejun Heo8db25e72012-07-17 12:39:28 -07004526 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004527 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004528 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004529 if (pool->nr_workers)
4530 continue;
Lai Jiangshan051e1852014-07-22 13:03:02 +08004531 if (!create_worker(pool))
Tejun Heo3ce63372012-07-17 12:39:27 -07004532 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004533 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004534 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004535
Tejun Heo65758202012-07-17 12:39:26 -07004536 case CPU_DOWN_FAILED:
4537 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004538 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004539
4540 for_each_pool(pool, pi) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004541 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004542
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004543 if (pool->cpu == cpu)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004544 rebind_workers(pool);
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004545 else if (pool->cpu < 0)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004546 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004547
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004548 mutex_unlock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004549 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004550
Tejun Heo4c16bd32013-04-01 11:23:36 -07004551 /* update NUMA affinity of unbound workqueues */
4552 list_for_each_entry(wq, &workqueues, list)
4553 wq_update_unbound_numa(wq, cpu, true);
4554
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004555 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004556 break;
Tejun Heo65758202012-07-17 12:39:26 -07004557 }
4558 return NOTIFY_OK;
4559}
4560
4561/*
4562 * Workqueues should be brought down after normal priority CPU notifiers.
4563 * This will be registered as low priority CPU notifier.
4564 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004565static int workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004566 unsigned long action,
4567 void *hcpu)
4568{
Tejun Heod84ff052013-03-12 11:29:59 -07004569 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004570 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004571 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004572
Tejun Heo65758202012-07-17 12:39:26 -07004573 switch (action & ~CPU_TASKS_FROZEN) {
4574 case CPU_DOWN_PREPARE:
Tejun Heo4c16bd32013-04-01 11:23:36 -07004575 /* unbinding per-cpu workers should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004576 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004577 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004578
4579 /* update NUMA affinity of unbound workqueues */
4580 mutex_lock(&wq_pool_mutex);
4581 list_for_each_entry(wq, &workqueues, list)
4582 wq_update_unbound_numa(wq, cpu, false);
4583 mutex_unlock(&wq_pool_mutex);
4584
4585 /* wait for per-cpu unbinding to finish */
Tejun Heo8db25e72012-07-17 12:39:28 -07004586 flush_work(&unbind_work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004587 destroy_work_on_stack(&unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004588 break;
Tejun Heo65758202012-07-17 12:39:26 -07004589 }
4590 return NOTIFY_OK;
4591}
4592
Rusty Russell2d3854a2008-11-05 13:39:10 +11004593#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004594
Rusty Russell2d3854a2008-11-05 13:39:10 +11004595struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004596 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004597 long (*fn)(void *);
4598 void *arg;
4599 long ret;
4600};
4601
Tejun Heoed48ece2012-09-18 12:48:43 -07004602static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004603{
Tejun Heoed48ece2012-09-18 12:48:43 -07004604 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4605
Rusty Russell2d3854a2008-11-05 13:39:10 +11004606 wfc->ret = wfc->fn(wfc->arg);
4607}
4608
4609/**
4610 * work_on_cpu - run a function in user context on a particular cpu
4611 * @cpu: the cpu to run on
4612 * @fn: the function to run
4613 * @arg: the function arg
4614 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004615 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004616 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004617 *
4618 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004619 */
Tejun Heod84ff052013-03-12 11:29:59 -07004620long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004621{
Tejun Heoed48ece2012-09-18 12:48:43 -07004622 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004623
Tejun Heoed48ece2012-09-18 12:48:43 -07004624 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4625 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004626 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004627 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004628 return wfc.ret;
4629}
4630EXPORT_SYMBOL_GPL(work_on_cpu);
4631#endif /* CONFIG_SMP */
4632
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004633#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304634
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004635/**
4636 * freeze_workqueues_begin - begin freezing workqueues
4637 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004638 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004639 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004640 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004641 *
4642 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004643 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004644 */
4645void freeze_workqueues_begin(void)
4646{
Tejun Heo24b8a842013-03-12 11:29:58 -07004647 struct workqueue_struct *wq;
4648 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004649
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004650 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004651
Tejun Heo6183c002013-03-12 11:29:57 -07004652 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004653 workqueue_freezing = true;
4654
Tejun Heo24b8a842013-03-12 11:29:58 -07004655 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004656 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004657 for_each_pwq(pwq, wq)
4658 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004659 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004660 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004661
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004662 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004663}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004664
4665/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004666 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004667 *
4668 * Check whether freezing is complete. This function must be called
4669 * between freeze_workqueues_begin() and thaw_workqueues().
4670 *
4671 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004672 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004673 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004674 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004675 * %true if some freezable workqueues are still busy. %false if freezing
4676 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004677 */
4678bool freeze_workqueues_busy(void)
4679{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004680 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004681 struct workqueue_struct *wq;
4682 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004683
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004684 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004685
Tejun Heo6183c002013-03-12 11:29:57 -07004686 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004687
Tejun Heo24b8a842013-03-12 11:29:58 -07004688 list_for_each_entry(wq, &workqueues, list) {
4689 if (!(wq->flags & WQ_FREEZABLE))
4690 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004691 /*
4692 * nr_active is monotonically decreasing. It's safe
4693 * to peek without lock.
4694 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004695 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004696 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004697 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004698 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004699 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004700 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004701 goto out_unlock;
4702 }
4703 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004704 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004705 }
4706out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004707 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004708 return busy;
4709}
4710
4711/**
4712 * thaw_workqueues - thaw workqueues
4713 *
4714 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004715 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004716 *
4717 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004718 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004719 */
4720void thaw_workqueues(void)
4721{
Tejun Heo24b8a842013-03-12 11:29:58 -07004722 struct workqueue_struct *wq;
4723 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004724
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004725 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004726
4727 if (!workqueue_freezing)
4728 goto out_unlock;
4729
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004730 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004731
Tejun Heo24b8a842013-03-12 11:29:58 -07004732 /* restore max_active and repopulate worklist */
4733 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004734 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004735 for_each_pwq(pwq, wq)
4736 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004737 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004738 }
4739
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004740out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004741 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004742}
4743#endif /* CONFIG_FREEZER */
4744
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004745static int workqueue_apply_unbound_cpumask(void)
4746{
4747 LIST_HEAD(ctxs);
4748 int ret = 0;
4749 struct workqueue_struct *wq;
4750 struct apply_wqattrs_ctx *ctx, *n;
4751
4752 lockdep_assert_held(&wq_pool_mutex);
4753
4754 list_for_each_entry(wq, &workqueues, list) {
4755 if (!(wq->flags & WQ_UNBOUND))
4756 continue;
4757 /* creating multiple pwqs breaks ordering guarantee */
4758 if (wq->flags & __WQ_ORDERED)
4759 continue;
4760
4761 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4762 if (!ctx) {
4763 ret = -ENOMEM;
4764 break;
4765 }
4766
4767 list_add_tail(&ctx->list, &ctxs);
4768 }
4769
4770 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4771 if (!ret)
4772 apply_wqattrs_commit(ctx);
4773 apply_wqattrs_cleanup(ctx);
4774 }
4775
4776 return ret;
4777}
4778
4779/**
4780 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4781 * @cpumask: the cpumask to set
4782 *
4783 * The low-level workqueues cpumask is a global cpumask that limits
4784 * the affinity of all unbound workqueues. This function check the @cpumask
4785 * and apply it to all unbound workqueues and updates all pwqs of them.
4786 *
4787 * Retun: 0 - Success
4788 * -EINVAL - Invalid @cpumask
4789 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4790 */
4791int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4792{
4793 int ret = -EINVAL;
4794 cpumask_var_t saved_cpumask;
4795
4796 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4797 return -ENOMEM;
4798
4799 get_online_cpus();
4800 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4801 if (!cpumask_empty(cpumask)) {
4802 mutex_lock(&wq_pool_mutex);
4803
4804 /* save the old wq_unbound_cpumask. */
4805 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4806
4807 /* update wq_unbound_cpumask at first and apply it to wqs. */
4808 cpumask_copy(wq_unbound_cpumask, cpumask);
4809 ret = workqueue_apply_unbound_cpumask();
4810
4811 /* restore the wq_unbound_cpumask when failed. */
4812 if (ret < 0)
4813 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4814
4815 mutex_unlock(&wq_pool_mutex);
4816 }
4817 put_online_cpus();
4818
4819 free_cpumask_var(saved_cpumask);
4820 return ret;
4821}
4822
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004823#ifdef CONFIG_SYSFS
4824/*
4825 * Workqueues with WQ_SYSFS flag set is visible to userland via
4826 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4827 * following attributes.
4828 *
4829 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4830 * max_active RW int : maximum number of in-flight work items
4831 *
4832 * Unbound workqueues have the following extra attributes.
4833 *
4834 * id RO int : the associated pool ID
4835 * nice RW int : nice value of the workers
4836 * cpumask RW mask : bitmask of allowed CPUs for the workers
4837 */
4838struct wq_device {
4839 struct workqueue_struct *wq;
4840 struct device dev;
4841};
4842
4843static struct workqueue_struct *dev_to_wq(struct device *dev)
4844{
4845 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
4846
4847 return wq_dev->wq;
4848}
4849
4850static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
4851 char *buf)
4852{
4853 struct workqueue_struct *wq = dev_to_wq(dev);
4854
4855 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
4856}
4857static DEVICE_ATTR_RO(per_cpu);
4858
4859static ssize_t max_active_show(struct device *dev,
4860 struct device_attribute *attr, char *buf)
4861{
4862 struct workqueue_struct *wq = dev_to_wq(dev);
4863
4864 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
4865}
4866
4867static ssize_t max_active_store(struct device *dev,
4868 struct device_attribute *attr, const char *buf,
4869 size_t count)
4870{
4871 struct workqueue_struct *wq = dev_to_wq(dev);
4872 int val;
4873
4874 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
4875 return -EINVAL;
4876
4877 workqueue_set_max_active(wq, val);
4878 return count;
4879}
4880static DEVICE_ATTR_RW(max_active);
4881
4882static struct attribute *wq_sysfs_attrs[] = {
4883 &dev_attr_per_cpu.attr,
4884 &dev_attr_max_active.attr,
4885 NULL,
4886};
4887ATTRIBUTE_GROUPS(wq_sysfs);
4888
4889static ssize_t wq_pool_ids_show(struct device *dev,
4890 struct device_attribute *attr, char *buf)
4891{
4892 struct workqueue_struct *wq = dev_to_wq(dev);
4893 const char *delim = "";
4894 int node, written = 0;
4895
4896 rcu_read_lock_sched();
4897 for_each_node(node) {
4898 written += scnprintf(buf + written, PAGE_SIZE - written,
4899 "%s%d:%d", delim, node,
4900 unbound_pwq_by_node(wq, node)->pool->id);
4901 delim = " ";
4902 }
4903 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
4904 rcu_read_unlock_sched();
4905
4906 return written;
4907}
4908
4909static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
4910 char *buf)
4911{
4912 struct workqueue_struct *wq = dev_to_wq(dev);
4913 int written;
4914
4915 mutex_lock(&wq->mutex);
4916 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
4917 mutex_unlock(&wq->mutex);
4918
4919 return written;
4920}
4921
4922/* prepare workqueue_attrs for sysfs store operations */
4923static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
4924{
4925 struct workqueue_attrs *attrs;
4926
4927 attrs = alloc_workqueue_attrs(GFP_KERNEL);
4928 if (!attrs)
4929 return NULL;
4930
4931 mutex_lock(&wq->mutex);
4932 copy_workqueue_attrs(attrs, wq->unbound_attrs);
4933 mutex_unlock(&wq->mutex);
4934 return attrs;
4935}
4936
4937static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
4938 const char *buf, size_t count)
4939{
4940 struct workqueue_struct *wq = dev_to_wq(dev);
4941 struct workqueue_attrs *attrs;
4942 int ret;
4943
4944 attrs = wq_sysfs_prep_attrs(wq);
4945 if (!attrs)
4946 return -ENOMEM;
4947
4948 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
4949 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
4950 ret = apply_workqueue_attrs(wq, attrs);
4951 else
4952 ret = -EINVAL;
4953
4954 free_workqueue_attrs(attrs);
4955 return ret ?: count;
4956}
4957
4958static ssize_t wq_cpumask_show(struct device *dev,
4959 struct device_attribute *attr, char *buf)
4960{
4961 struct workqueue_struct *wq = dev_to_wq(dev);
4962 int written;
4963
4964 mutex_lock(&wq->mutex);
4965 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
4966 cpumask_pr_args(wq->unbound_attrs->cpumask));
4967 mutex_unlock(&wq->mutex);
4968 return written;
4969}
4970
4971static ssize_t wq_cpumask_store(struct device *dev,
4972 struct device_attribute *attr,
4973 const char *buf, size_t count)
4974{
4975 struct workqueue_struct *wq = dev_to_wq(dev);
4976 struct workqueue_attrs *attrs;
4977 int ret;
4978
4979 attrs = wq_sysfs_prep_attrs(wq);
4980 if (!attrs)
4981 return -ENOMEM;
4982
4983 ret = cpumask_parse(buf, attrs->cpumask);
4984 if (!ret)
4985 ret = apply_workqueue_attrs(wq, attrs);
4986
4987 free_workqueue_attrs(attrs);
4988 return ret ?: count;
4989}
4990
4991static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
4992 char *buf)
4993{
4994 struct workqueue_struct *wq = dev_to_wq(dev);
4995 int written;
4996
4997 mutex_lock(&wq->mutex);
4998 written = scnprintf(buf, PAGE_SIZE, "%d\n",
4999 !wq->unbound_attrs->no_numa);
5000 mutex_unlock(&wq->mutex);
5001
5002 return written;
5003}
5004
5005static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5006 const char *buf, size_t count)
5007{
5008 struct workqueue_struct *wq = dev_to_wq(dev);
5009 struct workqueue_attrs *attrs;
5010 int v, ret;
5011
5012 attrs = wq_sysfs_prep_attrs(wq);
5013 if (!attrs)
5014 return -ENOMEM;
5015
5016 ret = -EINVAL;
5017 if (sscanf(buf, "%d", &v) == 1) {
5018 attrs->no_numa = !v;
5019 ret = apply_workqueue_attrs(wq, attrs);
5020 }
5021
5022 free_workqueue_attrs(attrs);
5023 return ret ?: count;
5024}
5025
5026static struct device_attribute wq_sysfs_unbound_attrs[] = {
5027 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5028 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5029 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5030 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5031 __ATTR_NULL,
5032};
5033
5034static struct bus_type wq_subsys = {
5035 .name = "workqueue",
5036 .dev_groups = wq_sysfs_groups,
5037};
5038
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005039static ssize_t wq_unbound_cpumask_show(struct device *dev,
5040 struct device_attribute *attr, char *buf)
5041{
5042 int written;
5043
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005044 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005045 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5046 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005047 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005048
5049 return written;
5050}
5051
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005052static ssize_t wq_unbound_cpumask_store(struct device *dev,
5053 struct device_attribute *attr, const char *buf, size_t count)
5054{
5055 cpumask_var_t cpumask;
5056 int ret;
5057
5058 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5059 return -ENOMEM;
5060
5061 ret = cpumask_parse(buf, cpumask);
5062 if (!ret)
5063 ret = workqueue_set_unbound_cpumask(cpumask);
5064
5065 free_cpumask_var(cpumask);
5066 return ret ? ret : count;
5067}
5068
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005069static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005070 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5071 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005072
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005073static int __init wq_sysfs_init(void)
5074{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005075 int err;
5076
5077 err = subsys_virtual_register(&wq_subsys, NULL);
5078 if (err)
5079 return err;
5080
5081 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005082}
5083core_initcall(wq_sysfs_init);
5084
5085static void wq_device_release(struct device *dev)
5086{
5087 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5088
5089 kfree(wq_dev);
5090}
5091
5092/**
5093 * workqueue_sysfs_register - make a workqueue visible in sysfs
5094 * @wq: the workqueue to register
5095 *
5096 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5097 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5098 * which is the preferred method.
5099 *
5100 * Workqueue user should use this function directly iff it wants to apply
5101 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5102 * apply_workqueue_attrs() may race against userland updating the
5103 * attributes.
5104 *
5105 * Return: 0 on success, -errno on failure.
5106 */
5107int workqueue_sysfs_register(struct workqueue_struct *wq)
5108{
5109 struct wq_device *wq_dev;
5110 int ret;
5111
5112 /*
5113 * Adjusting max_active or creating new pwqs by applyting
5114 * attributes breaks ordering guarantee. Disallow exposing ordered
5115 * workqueues.
5116 */
5117 if (WARN_ON(wq->flags & __WQ_ORDERED))
5118 return -EINVAL;
5119
5120 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5121 if (!wq_dev)
5122 return -ENOMEM;
5123
5124 wq_dev->wq = wq;
5125 wq_dev->dev.bus = &wq_subsys;
5126 wq_dev->dev.init_name = wq->name;
5127 wq_dev->dev.release = wq_device_release;
5128
5129 /*
5130 * unbound_attrs are created separately. Suppress uevent until
5131 * everything is ready.
5132 */
5133 dev_set_uevent_suppress(&wq_dev->dev, true);
5134
5135 ret = device_register(&wq_dev->dev);
5136 if (ret) {
5137 kfree(wq_dev);
5138 wq->wq_dev = NULL;
5139 return ret;
5140 }
5141
5142 if (wq->flags & WQ_UNBOUND) {
5143 struct device_attribute *attr;
5144
5145 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5146 ret = device_create_file(&wq_dev->dev, attr);
5147 if (ret) {
5148 device_unregister(&wq_dev->dev);
5149 wq->wq_dev = NULL;
5150 return ret;
5151 }
5152 }
5153 }
5154
5155 dev_set_uevent_suppress(&wq_dev->dev, false);
5156 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5157 return 0;
5158}
5159
5160/**
5161 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5162 * @wq: the workqueue to unregister
5163 *
5164 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5165 */
5166static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5167{
5168 struct wq_device *wq_dev = wq->wq_dev;
5169
5170 if (!wq->wq_dev)
5171 return;
5172
5173 wq->wq_dev = NULL;
5174 device_unregister(&wq_dev->dev);
5175}
5176#else /* CONFIG_SYSFS */
5177static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5178#endif /* CONFIG_SYSFS */
5179
Tejun Heobce90382013-04-01 11:23:32 -07005180static void __init wq_numa_init(void)
5181{
5182 cpumask_var_t *tbl;
5183 int node, cpu;
5184
Tejun Heobce90382013-04-01 11:23:32 -07005185 if (num_possible_nodes() <= 1)
5186 return;
5187
Tejun Heod55262c2013-04-01 11:23:38 -07005188 if (wq_disable_numa) {
5189 pr_info("workqueue: NUMA affinity support disabled\n");
5190 return;
5191 }
5192
Tejun Heo4c16bd32013-04-01 11:23:36 -07005193 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5194 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5195
Tejun Heobce90382013-04-01 11:23:32 -07005196 /*
5197 * We want masks of possible CPUs of each node which isn't readily
5198 * available. Build one from cpu_to_node() which should have been
5199 * fully initialized by now.
5200 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005201 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005202 BUG_ON(!tbl);
5203
5204 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005205 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005206 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005207
5208 for_each_possible_cpu(cpu) {
5209 node = cpu_to_node(cpu);
5210 if (WARN_ON(node == NUMA_NO_NODE)) {
5211 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5212 /* happens iff arch is bonkers, let's just proceed */
5213 return;
5214 }
5215 cpumask_set_cpu(cpu, tbl[node]);
5216 }
5217
5218 wq_numa_possible_cpumask = tbl;
5219 wq_numa_enabled = true;
5220}
5221
Suresh Siddha6ee05782010-07-30 14:57:37 -07005222static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005223{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005224 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5225 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005226
Tejun Heoe904e6c2013-03-12 11:29:57 -07005227 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5228
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005229 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5230 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5231
Tejun Heoe904e6c2013-03-12 11:29:57 -07005232 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5233
Tejun Heo65758202012-07-17 12:39:26 -07005234 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07005235 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02005236
Tejun Heobce90382013-04-01 11:23:32 -07005237 wq_numa_init();
5238
Tejun Heo706026c2013-01-24 11:01:34 -08005239 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005240 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005241 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005242
Tejun Heo7a4e3442013-03-12 11:30:00 -07005243 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005244 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005245 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005246 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005247 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005248 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005249 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005250
Tejun Heo9daf9e62013-01-24 11:01:33 -08005251 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005252 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005253 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005254 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005255 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005256 }
5257
Tejun Heoe22bee72010-06-29 10:07:14 +02005258 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07005259 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005260 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02005261
Tejun Heof02ae732013-03-12 11:30:03 -07005262 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07005263 pool->flags &= ~POOL_DISASSOCIATED;
Lai Jiangshan051e1852014-07-22 13:03:02 +08005264 BUG_ON(!create_worker(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07005265 }
Tejun Heoe22bee72010-06-29 10:07:14 +02005266 }
5267
Tejun Heo8a2b7532013-09-05 12:30:04 -04005268 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005269 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5270 struct workqueue_attrs *attrs;
5271
5272 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005273 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005274 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005275
5276 /*
5277 * An ordered wq should have only one pwq as ordering is
5278 * guaranteed by max_active which is enforced by pwqs.
5279 * Turn off NUMA so that dfl_pwq is used for all nodes.
5280 */
5281 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5282 attrs->nice = std_nice[i];
5283 attrs->no_numa = true;
5284 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005285 }
5286
Tejun Heod320c032010-06-29 10:07:14 +02005287 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005288 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005289 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005290 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5291 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005292 system_freezable_wq = alloc_workqueue("events_freezable",
5293 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305294 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5295 WQ_POWER_EFFICIENT, 0);
5296 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5297 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5298 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005299 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305300 !system_unbound_wq || !system_freezable_wq ||
5301 !system_power_efficient_wq ||
5302 !system_freezable_power_efficient_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07005303 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005304}
Suresh Siddha6ee05782010-07-30 14:57:37 -07005305early_initcall(init_workqueues);