blob: 38b9ea7c204ce3214ea659790710b0ea60eb9e03 [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
Tejun Heo24647572013-01-24 11:01:33 -080069 * create_worker() 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 Heo35b6bb62013-01-24 11:01:33 -080072 POOL_FREEZING = 1 << 3, /* freeze in progress */
Tejun Heodb7bccf2010-06-29 10:07:12 +020073
Tejun Heoc8e55f32010-06-29 10:07:12 +020074 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020075 WORKER_DIE = 1 << 1, /* die die die */
76 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020077 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020078 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020079 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070080 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020081
Tejun Heoa9ab7752013-03-19 13:45:21 -070082 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
83 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020084
Tejun Heoe34cdddb2013-01-24 11:01:33 -080085 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070086
Tejun Heo29c91e92013-03-12 11:30:03 -070087 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020088 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020089
Tejun Heoe22bee72010-06-29 10:07:14 +020090 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
91 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
92
Tejun Heo3233cdb2011-02-16 18:10:19 +010093 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
94 /* call for help after 10ms
95 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020096 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
97 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020098
99 /*
100 * Rescue workers are used only on emergencies and shared by
101 * all cpus. Give -20.
102 */
103 RESCUER_NICE_LEVEL = -20,
Tejun Heo32704762012-07-13 22:16:45 -0700104 HIGHPRI_NICE_LEVEL = -20,
Tejun Heoecf68812013-04-01 11:23:34 -0700105
106 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200107};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200110 * Structure fields follow one of the following exclusion rules.
111 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200112 * I: Modifiable by initialization/destruction paths and read-only for
113 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200114 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200115 * P: Preemption protected. Disabling preemption is enough and should
116 * only be modified and accessed from the local cpu.
117 *
Tejun Heod565ed62013-01-24 11:01:33 -0800118 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200119 *
Tejun Heod565ed62013-01-24 11:01:33 -0800120 * X: During normal operation, modification requires pool->lock and should
121 * be done only from local cpu. Either disabling preemption on local
122 * cpu or grabbing pool->lock is enough for read access. If
123 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200124 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800125 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700126 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700127 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700128 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700129 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700130 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700131 * WQ: wq->mutex protected.
132 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700133 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700134 *
135 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200136 */
137
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800138/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200139
Tejun Heobd7bdd42012-07-12 14:46:37 -0700140struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800141 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700142 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700143 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800144 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700145 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700146
147 struct list_head worklist; /* L: list of pending works */
148 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700149
150 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700151 int nr_idle; /* L: currently idle ones */
152
153 struct list_head idle_list; /* X: list of idle workers */
154 struct timer_list idle_timer; /* L: worker idle timeout */
155 struct timer_list mayday_timer; /* L: SOS timer for workers */
156
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700157 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800158 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
159 /* L: hash of busy workers */
160
Tejun Heobc3a1af2013-03-13 19:47:39 -0700161 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo34a06bd2013-03-12 11:30:00 -0700162 struct mutex manager_arb; /* manager arbitration */
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 */
168
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 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700234 struct list_head list; /* PL: 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
261 /* hot fields used during command issue, aligned to cacheline */
262 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
263 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700264 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265};
266
Tejun Heoe904e6c2013-03-12 11:29:57 -0700267static struct kmem_cache *pwq_cache;
268
Tejun Heobce90382013-04-01 11:23:32 -0700269static int wq_numa_tbl_len; /* highest possible NUMA node id + 1 */
270static cpumask_var_t *wq_numa_possible_cpumask;
271 /* possible CPUs of each node */
272
Tejun Heod55262c2013-04-01 11:23:38 -0700273static bool wq_disable_numa;
274module_param_named(disable_numa, wq_disable_numa, bool, 0444);
275
Viresh Kumarcee22a12013-04-08 16:45:40 +0530276/* see the comment above the definition of WQ_POWER_EFFICIENT */
277#ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT
278static bool wq_power_efficient = true;
279#else
280static bool wq_power_efficient;
281#endif
282
283module_param_named(power_efficient, wq_power_efficient, bool, 0444);
284
Tejun Heobce90382013-04-01 11:23:32 -0700285static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
286
Tejun Heo4c16bd32013-04-01 11:23:36 -0700287/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
288static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
289
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700290static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700291static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo5bcab332013-03-13 19:47:40 -0700292
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700293static LIST_HEAD(workqueues); /* PL: list of all workqueues */
294static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700295
296/* the per-cpu worker pools */
297static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
298 cpu_worker_pools);
299
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700300static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700301
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700302/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700303static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
304
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700305/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700306static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
307
Tejun Heo8a2b7532013-09-05 12:30:04 -0400308/* I: attributes used when instantiating ordered pools on demand */
309static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
310
Tejun Heod320c032010-06-29 10:07:14 +0200311struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400312EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300313struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900314EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300315struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200316EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300317struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200318EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300319struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100320EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530321struct workqueue_struct *system_power_efficient_wq __read_mostly;
322EXPORT_SYMBOL_GPL(system_power_efficient_wq);
323struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
324EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200325
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700326static int worker_thread(void *__worker);
327static void copy_workqueue_attrs(struct workqueue_attrs *to,
328 const struct workqueue_attrs *from);
329
Tejun Heo97bd2342010-10-05 10:41:14 +0200330#define CREATE_TRACE_POINTS
331#include <trace/events/workqueue.h>
332
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700333#define assert_rcu_or_pool_mutex() \
Tejun Heo5bcab332013-03-13 19:47:40 -0700334 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700335 lockdep_is_held(&wq_pool_mutex), \
336 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700337
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700338#define assert_rcu_or_wq_mutex(wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700339 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshanb5927602013-03-25 16:57:19 -0700340 lockdep_is_held(&wq->mutex), \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700341 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700342
Tejun Heof02ae732013-03-12 11:30:03 -0700343#define for_each_cpu_worker_pool(pool, cpu) \
344 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
345 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700346 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700347
Tejun Heo49e3cf42013-03-12 11:29:58 -0700348/**
Tejun Heo17116962013-03-12 11:29:58 -0700349 * for_each_pool - iterate through all worker_pools in the system
350 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700351 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700352 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700353 * This must be called either with wq_pool_mutex held or sched RCU read
354 * locked. If the pool needs to be used beyond the locking in effect, the
355 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700356 *
357 * The if/else clause exists only for the lockdep assertion and can be
358 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700359 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700360#define for_each_pool(pool, pi) \
361 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700362 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700363 else
Tejun Heo17116962013-03-12 11:29:58 -0700364
365/**
Tejun Heo822d8402013-03-19 13:45:21 -0700366 * for_each_pool_worker - iterate through all workers of a worker_pool
367 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700368 * @pool: worker_pool to iterate workers of
369 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800370 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700371 *
372 * The if/else clause exists only for the lockdep assertion and can be
373 * ignored.
374 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800375#define for_each_pool_worker(worker, pool) \
376 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800377 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700378 else
379
380/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700381 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
382 * @pwq: iteration cursor
383 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700384 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700385 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700386 * If the pwq needs to be used beyond the locking in effect, the caller is
387 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700388 *
389 * The if/else clause exists only for the lockdep assertion and can be
390 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700391 */
392#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700393 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700394 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700395 else
Tejun Heof3421792010-07-02 10:03:51 +0200396
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900397#ifdef CONFIG_DEBUG_OBJECTS_WORK
398
399static struct debug_obj_descr work_debug_descr;
400
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100401static void *work_debug_hint(void *addr)
402{
403 return ((struct work_struct *) addr)->func;
404}
405
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900406/*
407 * fixup_init is called when:
408 * - an active object is initialized
409 */
410static int work_fixup_init(void *addr, enum debug_obj_state state)
411{
412 struct work_struct *work = addr;
413
414 switch (state) {
415 case ODEBUG_STATE_ACTIVE:
416 cancel_work_sync(work);
417 debug_object_init(work, &work_debug_descr);
418 return 1;
419 default:
420 return 0;
421 }
422}
423
424/*
425 * fixup_activate is called when:
426 * - an active object is activated
427 * - an unknown object is activated (might be a statically initialized object)
428 */
429static int work_fixup_activate(void *addr, enum debug_obj_state state)
430{
431 struct work_struct *work = addr;
432
433 switch (state) {
434
435 case ODEBUG_STATE_NOTAVAILABLE:
436 /*
437 * This is not really a fixup. The work struct was
438 * statically initialized. We just make sure that it
439 * is tracked in the object tracker.
440 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200441 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900442 debug_object_init(work, &work_debug_descr);
443 debug_object_activate(work, &work_debug_descr);
444 return 0;
445 }
446 WARN_ON_ONCE(1);
447 return 0;
448
449 case ODEBUG_STATE_ACTIVE:
450 WARN_ON(1);
451
452 default:
453 return 0;
454 }
455}
456
457/*
458 * fixup_free is called when:
459 * - an active object is freed
460 */
461static int work_fixup_free(void *addr, enum debug_obj_state state)
462{
463 struct work_struct *work = addr;
464
465 switch (state) {
466 case ODEBUG_STATE_ACTIVE:
467 cancel_work_sync(work);
468 debug_object_free(work, &work_debug_descr);
469 return 1;
470 default:
471 return 0;
472 }
473}
474
475static struct debug_obj_descr work_debug_descr = {
476 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100477 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900478 .fixup_init = work_fixup_init,
479 .fixup_activate = work_fixup_activate,
480 .fixup_free = work_fixup_free,
481};
482
483static inline void debug_work_activate(struct work_struct *work)
484{
485 debug_object_activate(work, &work_debug_descr);
486}
487
488static inline void debug_work_deactivate(struct work_struct *work)
489{
490 debug_object_deactivate(work, &work_debug_descr);
491}
492
493void __init_work(struct work_struct *work, int onstack)
494{
495 if (onstack)
496 debug_object_init_on_stack(work, &work_debug_descr);
497 else
498 debug_object_init(work, &work_debug_descr);
499}
500EXPORT_SYMBOL_GPL(__init_work);
501
502void destroy_work_on_stack(struct work_struct *work)
503{
504 debug_object_free(work, &work_debug_descr);
505}
506EXPORT_SYMBOL_GPL(destroy_work_on_stack);
507
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000508void destroy_delayed_work_on_stack(struct delayed_work *work)
509{
510 destroy_timer_on_stack(&work->timer);
511 debug_object_free(&work->work, &work_debug_descr);
512}
513EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
514
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900515#else
516static inline void debug_work_activate(struct work_struct *work) { }
517static inline void debug_work_deactivate(struct work_struct *work) { }
518#endif
519
Li Bin4e8b22b2013-09-10 09:52:35 +0800520/**
521 * worker_pool_assign_id - allocate ID and assing it to @pool
522 * @pool: the pool pointer of interest
523 *
524 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
525 * successfully, -errno on failure.
526 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800527static int worker_pool_assign_id(struct worker_pool *pool)
528{
529 int ret;
530
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700531 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700532
Li Bin4e8b22b2013-09-10 09:52:35 +0800533 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
534 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700535 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700536 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700537 return 0;
538 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800539 return ret;
540}
541
Tejun Heo76af4d92013-03-12 11:30:00 -0700542/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700543 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
544 * @wq: the target workqueue
545 * @node: the node ID
546 *
547 * This must be called either with pwq_lock held or sched RCU read locked.
548 * If the pwq needs to be used beyond the locking in effect, the caller is
549 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700550 *
551 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700552 */
553static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
554 int node)
555{
556 assert_rcu_or_wq_mutex(wq);
557 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
558}
559
Tejun Heo73f53c42010-06-29 10:07:11 +0200560static unsigned int work_color_to_flags(int color)
561{
562 return color << WORK_STRUCT_COLOR_SHIFT;
563}
564
565static int get_work_color(struct work_struct *work)
566{
567 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
568 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
569}
570
571static int work_next_color(int color)
572{
573 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700574}
575
David Howells4594bf12006-12-07 11:33:26 +0000576/*
Tejun Heo112202d2013-02-13 19:29:12 -0800577 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
578 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800579 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200580 *
Tejun Heo112202d2013-02-13 19:29:12 -0800581 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
582 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700583 * work->data. These functions should only be called while the work is
584 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200585 *
Tejun Heo112202d2013-02-13 19:29:12 -0800586 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800587 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800588 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800589 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700590 *
591 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
592 * canceled. While being canceled, a work item may have its PENDING set
593 * but stay off timer and worklist for arbitrarily long and nobody should
594 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000595 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200596static inline void set_work_data(struct work_struct *work, unsigned long data,
597 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000598{
Tejun Heo6183c002013-03-12 11:29:57 -0700599 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200600 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000601}
David Howells365970a2006-11-22 14:54:49 +0000602
Tejun Heo112202d2013-02-13 19:29:12 -0800603static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200604 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200605{
Tejun Heo112202d2013-02-13 19:29:12 -0800606 set_work_data(work, (unsigned long)pwq,
607 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200608}
609
Lai Jiangshan4468a002013-02-06 18:04:53 -0800610static void set_work_pool_and_keep_pending(struct work_struct *work,
611 int pool_id)
612{
613 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
614 WORK_STRUCT_PENDING);
615}
616
Tejun Heo7c3eed52013-01-24 11:01:33 -0800617static void set_work_pool_and_clear_pending(struct work_struct *work,
618 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000619{
Tejun Heo23657bb2012-08-13 17:08:19 -0700620 /*
621 * The following wmb is paired with the implied mb in
622 * test_and_set_bit(PENDING) and ensures all updates to @work made
623 * here are visible to and precede any updates by the next PENDING
624 * owner.
625 */
626 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800627 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200628}
629
630static void clear_work_data(struct work_struct *work)
631{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800632 smp_wmb(); /* see set_work_pool_and_clear_pending() */
633 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200634}
635
Tejun Heo112202d2013-02-13 19:29:12 -0800636static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200637{
Tejun Heoe1201532010-07-22 14:14:25 +0200638 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200639
Tejun Heo112202d2013-02-13 19:29:12 -0800640 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200641 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
642 else
643 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200644}
645
Tejun Heo7c3eed52013-01-24 11:01:33 -0800646/**
647 * get_work_pool - return the worker_pool a given work was associated with
648 * @work: the work item of interest
649 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700650 * Pools are created and destroyed under wq_pool_mutex, and allows read
651 * access under sched-RCU read lock. As such, this function should be
652 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700653 *
654 * All fields of the returned pool are accessible as long as the above
655 * mentioned locking is in effect. If the returned pool needs to be used
656 * beyond the critical section, the caller is responsible for ensuring the
657 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700658 *
659 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800660 */
661static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200662{
Tejun Heoe1201532010-07-22 14:14:25 +0200663 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800664 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200665
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700666 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700667
Tejun Heo112202d2013-02-13 19:29:12 -0800668 if (data & WORK_STRUCT_PWQ)
669 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800670 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200671
Tejun Heo7c3eed52013-01-24 11:01:33 -0800672 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
673 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200674 return NULL;
675
Tejun Heofa1b54e2013-03-12 11:30:00 -0700676 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800677}
678
679/**
680 * get_work_pool_id - return the worker pool ID a given work is associated with
681 * @work: the work item of interest
682 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700683 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800684 * %WORK_OFFQ_POOL_NONE if none.
685 */
686static int get_work_pool_id(struct work_struct *work)
687{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800688 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800689
Tejun Heo112202d2013-02-13 19:29:12 -0800690 if (data & WORK_STRUCT_PWQ)
691 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800692 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
693
694 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800695}
696
Tejun Heobbb68df2012-08-03 10:30:46 -0700697static void mark_work_canceling(struct work_struct *work)
698{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800699 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700700
Tejun Heo7c3eed52013-01-24 11:01:33 -0800701 pool_id <<= WORK_OFFQ_POOL_SHIFT;
702 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700703}
704
705static bool work_is_canceling(struct work_struct *work)
706{
707 unsigned long data = atomic_long_read(&work->data);
708
Tejun Heo112202d2013-02-13 19:29:12 -0800709 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700710}
711
David Howells365970a2006-11-22 14:54:49 +0000712/*
Tejun Heo32704762012-07-13 22:16:45 -0700713 * Policy functions. These define the policies on how the global worker
714 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800715 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000716 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200717
Tejun Heo63d95a92012-07-12 14:46:37 -0700718static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000719{
Tejun Heoe19e3972013-01-24 11:39:44 -0800720 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000721}
722
Tejun Heoe22bee72010-06-29 10:07:14 +0200723/*
724 * Need to wake up a worker? Called from anything but currently
725 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700726 *
727 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800728 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700729 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200730 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700731static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000732{
Tejun Heo63d95a92012-07-12 14:46:37 -0700733 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000734}
735
Tejun Heoe22bee72010-06-29 10:07:14 +0200736/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700737static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200738{
Tejun Heo63d95a92012-07-12 14:46:37 -0700739 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200740}
741
742/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700743static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200744{
Tejun Heoe19e3972013-01-24 11:39:44 -0800745 return !list_empty(&pool->worklist) &&
746 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200747}
748
749/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700750static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200751{
Tejun Heo63d95a92012-07-12 14:46:37 -0700752 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200753}
754
Tejun Heoe22bee72010-06-29 10:07:14 +0200755/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700756static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200757{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700758 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700759 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
760 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200761
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700762 /*
763 * nr_idle and idle_list may disagree if idle rebinding is in
764 * progress. Never return %true if idle_list is empty.
765 */
766 if (list_empty(&pool->idle_list))
767 return false;
768
Tejun Heoe22bee72010-06-29 10:07:14 +0200769 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
770}
771
772/*
773 * Wake up functions.
774 */
775
Tejun Heo7e116292010-06-29 10:07:13 +0200776/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700777static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200778{
Tejun Heo63d95a92012-07-12 14:46:37 -0700779 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200780 return NULL;
781
Tejun Heo63d95a92012-07-12 14:46:37 -0700782 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200783}
784
785/**
786 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700787 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200788 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700789 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200790 *
791 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800792 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200793 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700794static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200795{
Tejun Heo63d95a92012-07-12 14:46:37 -0700796 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200797
798 if (likely(worker))
799 wake_up_process(worker->task);
800}
801
Tejun Heo4690c4a2010-06-29 10:07:10 +0200802/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200803 * wq_worker_waking_up - a worker is waking up
804 * @task: task waking up
805 * @cpu: CPU @task is waking up to
806 *
807 * This function is called during try_to_wake_up() when a worker is
808 * being awoken.
809 *
810 * CONTEXT:
811 * spin_lock_irq(rq->lock)
812 */
Tejun Heod84ff052013-03-12 11:29:59 -0700813void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200814{
815 struct worker *worker = kthread_data(task);
816
Joonsoo Kim36576002012-10-26 23:03:49 +0900817 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800818 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800819 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900820 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200821}
822
823/**
824 * wq_worker_sleeping - a worker is going to sleep
825 * @task: task going to sleep
826 * @cpu: CPU in question, must be the current CPU number
827 *
828 * This function is called during schedule() when a busy worker is
829 * going to sleep. Worker on the same cpu can be woken up by
830 * returning pointer to its task.
831 *
832 * CONTEXT:
833 * spin_lock_irq(rq->lock)
834 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700835 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200836 * Worker task on @cpu to wake up, %NULL if none.
837 */
Tejun Heod84ff052013-03-12 11:29:59 -0700838struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200839{
840 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800841 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200842
Tejun Heo111c2252013-01-17 17:16:24 -0800843 /*
844 * Rescuers, which may not have all the fields set up like normal
845 * workers, also reach here, let's not access anything before
846 * checking NOT_RUNNING.
847 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500848 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200849 return NULL;
850
Tejun Heo111c2252013-01-17 17:16:24 -0800851 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800852
Tejun Heoe22bee72010-06-29 10:07:14 +0200853 /* this can only happen on the local cpu */
Tejun Heo6183c002013-03-12 11:29:57 -0700854 if (WARN_ON_ONCE(cpu != raw_smp_processor_id()))
855 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200856
857 /*
858 * The counterpart of the following dec_and_test, implied mb,
859 * worklist not empty test sequence is in insert_work().
860 * Please read comment there.
861 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700862 * NOT_RUNNING is clear. This means that we're bound to and
863 * running on the local cpu w/ rq lock held and preemption
864 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800865 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700866 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200867 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800868 if (atomic_dec_and_test(&pool->nr_running) &&
869 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700870 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200871 return to_wakeup ? to_wakeup->task : NULL;
872}
873
874/**
875 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200876 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200877 * @flags: flags to set
878 * @wakeup: wakeup an idle worker if necessary
879 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200880 * Set @flags in @worker->flags and adjust nr_running accordingly. If
881 * nr_running becomes zero and @wakeup is %true, an idle worker is
882 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200883 *
Tejun Heocb444762010-07-02 10:03:50 +0200884 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800885 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200886 */
887static inline void worker_set_flags(struct worker *worker, unsigned int flags,
888 bool wakeup)
889{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700890 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200891
Tejun Heocb444762010-07-02 10:03:50 +0200892 WARN_ON_ONCE(worker->task != current);
893
Tejun Heoe22bee72010-06-29 10:07:14 +0200894 /*
895 * If transitioning into NOT_RUNNING, adjust nr_running and
896 * wake up an idle worker as necessary if requested by
897 * @wakeup.
898 */
899 if ((flags & WORKER_NOT_RUNNING) &&
900 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoe22bee72010-06-29 10:07:14 +0200901 if (wakeup) {
Tejun Heoe19e3972013-01-24 11:39:44 -0800902 if (atomic_dec_and_test(&pool->nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700903 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700904 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200905 } else
Tejun Heoe19e3972013-01-24 11:39:44 -0800906 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200907 }
908
Tejun Heod302f012010-06-29 10:07:13 +0200909 worker->flags |= flags;
910}
911
912/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200913 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200914 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200915 * @flags: flags to clear
916 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200917 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200918 *
Tejun Heocb444762010-07-02 10:03:50 +0200919 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800920 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200921 */
922static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
923{
Tejun Heo63d95a92012-07-12 14:46:37 -0700924 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200925 unsigned int oflags = worker->flags;
926
Tejun Heocb444762010-07-02 10:03:50 +0200927 WARN_ON_ONCE(worker->task != current);
928
Tejun Heod302f012010-06-29 10:07:13 +0200929 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200930
Tejun Heo42c025f2011-01-11 15:58:49 +0100931 /*
932 * If transitioning out of NOT_RUNNING, increment nr_running. Note
933 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
934 * of multiple flags, not a single flag.
935 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200936 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
937 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800938 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200939}
940
941/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200942 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800943 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200944 * @work: work to find worker for
945 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800946 * Find a worker which is executing @work on @pool by searching
947 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800948 * to match, its current execution should match the address of @work and
949 * its work function. This is to avoid unwanted dependency between
950 * unrelated work executions through a work item being recycled while still
951 * being executed.
952 *
953 * This is a bit tricky. A work item may be freed once its execution
954 * starts and nothing prevents the freed area from being recycled for
955 * another work item. If the same work item address ends up being reused
956 * before the original execution finishes, workqueue will identify the
957 * recycled work item as currently executing and make it wait until the
958 * current execution finishes, introducing an unwanted dependency.
959 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700960 * This function checks the work item address and work function to avoid
961 * false positives. Note that this isn't complete as one may construct a
962 * work function which can introduce dependency onto itself through a
963 * recycled work item. Well, if somebody wants to shoot oneself in the
964 * foot that badly, there's only so much we can do, and if such deadlock
965 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200966 *
967 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800968 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200969 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700970 * Return:
971 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200972 * otherwise.
973 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800974static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200975 struct work_struct *work)
976{
Sasha Levin42f85702012-12-17 10:01:23 -0500977 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500978
Sasha Levinb67bfe02013-02-27 17:06:00 -0800979 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800980 (unsigned long)work)
981 if (worker->current_work == work &&
982 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500983 return worker;
984
985 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200986}
987
988/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700989 * move_linked_works - move linked works to a list
990 * @work: start of series of works to be scheduled
991 * @head: target list to append @work to
992 * @nextp: out paramter for nested worklist walking
993 *
994 * Schedule linked works starting from @work to @head. Work series to
995 * be scheduled starts at @work and includes any consecutive work with
996 * WORK_STRUCT_LINKED set in its predecessor.
997 *
998 * If @nextp is not NULL, it's updated to point to the next work of
999 * the last scheduled work. This allows move_linked_works() to be
1000 * nested inside outer list_for_each_entry_safe().
1001 *
1002 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001003 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001004 */
1005static void move_linked_works(struct work_struct *work, struct list_head *head,
1006 struct work_struct **nextp)
1007{
1008 struct work_struct *n;
1009
1010 /*
1011 * Linked worklist will always end before the end of the list,
1012 * use NULL for list head.
1013 */
1014 list_for_each_entry_safe_from(work, n, NULL, entry) {
1015 list_move_tail(&work->entry, head);
1016 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1017 break;
1018 }
1019
1020 /*
1021 * If we're already inside safe list traversal and have moved
1022 * multiple works to the scheduled queue, the next position
1023 * needs to be updated.
1024 */
1025 if (nextp)
1026 *nextp = n;
1027}
1028
Tejun Heo8864b4e2013-03-12 11:30:04 -07001029/**
1030 * get_pwq - get an extra reference on the specified pool_workqueue
1031 * @pwq: pool_workqueue to get
1032 *
1033 * Obtain an extra reference on @pwq. The caller should guarantee that
1034 * @pwq has positive refcnt and be holding the matching pool->lock.
1035 */
1036static void get_pwq(struct pool_workqueue *pwq)
1037{
1038 lockdep_assert_held(&pwq->pool->lock);
1039 WARN_ON_ONCE(pwq->refcnt <= 0);
1040 pwq->refcnt++;
1041}
1042
1043/**
1044 * put_pwq - put a pool_workqueue reference
1045 * @pwq: pool_workqueue to put
1046 *
1047 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1048 * destruction. The caller should be holding the matching pool->lock.
1049 */
1050static void put_pwq(struct pool_workqueue *pwq)
1051{
1052 lockdep_assert_held(&pwq->pool->lock);
1053 if (likely(--pwq->refcnt))
1054 return;
1055 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1056 return;
1057 /*
1058 * @pwq can't be released under pool->lock, bounce to
1059 * pwq_unbound_release_workfn(). This never recurses on the same
1060 * pool->lock as this path is taken only for unbound workqueues and
1061 * the release work item is scheduled on a per-cpu workqueue. To
1062 * avoid lockdep warning, unbound pool->locks are given lockdep
1063 * subclass of 1 in get_unbound_pool().
1064 */
1065 schedule_work(&pwq->unbound_release_work);
1066}
1067
Tejun Heodce90d42013-04-01 11:23:35 -07001068/**
1069 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1070 * @pwq: pool_workqueue to put (can be %NULL)
1071 *
1072 * put_pwq() with locking. This function also allows %NULL @pwq.
1073 */
1074static void put_pwq_unlocked(struct pool_workqueue *pwq)
1075{
1076 if (pwq) {
1077 /*
1078 * As both pwqs and pools are sched-RCU protected, the
1079 * following lock operations are safe.
1080 */
1081 spin_lock_irq(&pwq->pool->lock);
1082 put_pwq(pwq);
1083 spin_unlock_irq(&pwq->pool->lock);
1084 }
1085}
1086
Tejun Heo112202d2013-02-13 19:29:12 -08001087static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001088{
Tejun Heo112202d2013-02-13 19:29:12 -08001089 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001090
1091 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001092 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001093 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001094 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001095}
1096
Tejun Heo112202d2013-02-13 19:29:12 -08001097static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001098{
Tejun Heo112202d2013-02-13 19:29:12 -08001099 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001100 struct work_struct, entry);
1101
Tejun Heo112202d2013-02-13 19:29:12 -08001102 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001103}
1104
Tejun Heobf4ede02012-08-03 10:30:46 -07001105/**
Tejun Heo112202d2013-02-13 19:29:12 -08001106 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1107 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001108 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001109 *
1110 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001111 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001112 *
1113 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001114 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001115 */
Tejun Heo112202d2013-02-13 19:29:12 -08001116static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001117{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001118 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001119 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001120 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001121
Tejun Heo112202d2013-02-13 19:29:12 -08001122 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001123
Tejun Heo112202d2013-02-13 19:29:12 -08001124 pwq->nr_active--;
1125 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001126 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001127 if (pwq->nr_active < pwq->max_active)
1128 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001129 }
1130
1131 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001132 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001133 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001134
1135 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001136 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001137 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001138
Tejun Heo112202d2013-02-13 19:29:12 -08001139 /* this pwq is done, clear flush_color */
1140 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001141
1142 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001143 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001144 * will handle the rest.
1145 */
Tejun Heo112202d2013-02-13 19:29:12 -08001146 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1147 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001148out_put:
1149 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001150}
1151
Tejun Heo36e227d2012-08-03 10:30:46 -07001152/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001153 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001154 * @work: work item to steal
1155 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001156 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001157 *
1158 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001159 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001160 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001161 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001162 * 1 if @work was pending and we successfully stole PENDING
1163 * 0 if @work was idle and we claimed PENDING
1164 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001165 * -ENOENT if someone else is canceling @work, this state may persist
1166 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001167 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001168 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001169 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001170 * interrupted while holding PENDING and @work off queue, irq must be
1171 * disabled on entry. This, combined with delayed_work->timer being
1172 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001173 *
1174 * On successful return, >= 0, irq is disabled and the caller is
1175 * responsible for releasing it using local_irq_restore(*@flags).
1176 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001177 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001178 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001179static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1180 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001181{
Tejun Heod565ed62013-01-24 11:01:33 -08001182 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001183 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001184
Tejun Heobbb68df2012-08-03 10:30:46 -07001185 local_irq_save(*flags);
1186
Tejun Heo36e227d2012-08-03 10:30:46 -07001187 /* try to steal the timer if it exists */
1188 if (is_dwork) {
1189 struct delayed_work *dwork = to_delayed_work(work);
1190
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001191 /*
1192 * dwork->timer is irqsafe. If del_timer() fails, it's
1193 * guaranteed that the timer is not queued anywhere and not
1194 * running on the local CPU.
1195 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001196 if (likely(del_timer(&dwork->timer)))
1197 return 1;
1198 }
1199
1200 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001201 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1202 return 0;
1203
1204 /*
1205 * The queueing is in progress, or it is already queued. Try to
1206 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1207 */
Tejun Heod565ed62013-01-24 11:01:33 -08001208 pool = get_work_pool(work);
1209 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001210 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001211
Tejun Heod565ed62013-01-24 11:01:33 -08001212 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001213 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001214 * work->data is guaranteed to point to pwq only while the work
1215 * item is queued on pwq->wq, and both updating work->data to point
1216 * to pwq on queueing and to pool on dequeueing are done under
1217 * pwq->pool->lock. This in turn guarantees that, if work->data
1218 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001219 * item is currently queued on that pool.
1220 */
Tejun Heo112202d2013-02-13 19:29:12 -08001221 pwq = get_work_pwq(work);
1222 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001223 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001224
Tejun Heo16062832013-02-06 18:04:53 -08001225 /*
1226 * A delayed work item cannot be grabbed directly because
1227 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001228 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001229 * management later on and cause stall. Make sure the work
1230 * item is activated before grabbing.
1231 */
1232 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001233 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001234
Tejun Heo16062832013-02-06 18:04:53 -08001235 list_del_init(&work->entry);
Tejun Heo112202d2013-02-13 19:29:12 -08001236 pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001237
Tejun Heo112202d2013-02-13 19:29:12 -08001238 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001239 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001240
Tejun Heo16062832013-02-06 18:04:53 -08001241 spin_unlock(&pool->lock);
1242 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001243 }
Tejun Heod565ed62013-01-24 11:01:33 -08001244 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001245fail:
1246 local_irq_restore(*flags);
1247 if (work_is_canceling(work))
1248 return -ENOENT;
1249 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001250 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001251}
1252
1253/**
Tejun Heo706026c2013-01-24 11:01:34 -08001254 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001255 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001256 * @work: work to insert
1257 * @head: insertion point
1258 * @extra_flags: extra WORK_STRUCT_* flags to set
1259 *
Tejun Heo112202d2013-02-13 19:29:12 -08001260 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001261 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001262 *
1263 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001264 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001265 */
Tejun Heo112202d2013-02-13 19:29:12 -08001266static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1267 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001268{
Tejun Heo112202d2013-02-13 19:29:12 -08001269 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001270
Tejun Heo4690c4a2010-06-29 10:07:10 +02001271 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001272 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001273 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001274 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001275
1276 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001277 * Ensure either wq_worker_sleeping() sees the above
1278 * list_add_tail() or we see zero nr_running to avoid workers lying
1279 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001280 */
1281 smp_mb();
1282
Tejun Heo63d95a92012-07-12 14:46:37 -07001283 if (__need_more_worker(pool))
1284 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001285}
1286
Tejun Heoc8efcc22010-12-20 19:32:04 +01001287/*
1288 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001289 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001290 */
1291static bool is_chained_work(struct workqueue_struct *wq)
1292{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001293 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001294
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001295 worker = current_wq_worker();
1296 /*
1297 * Return %true iff I'm a worker execuing a work item on @wq. If
1298 * I'm @worker, it's safe to dereference it without locking.
1299 */
Tejun Heo112202d2013-02-13 19:29:12 -08001300 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001301}
1302
Tejun Heod84ff052013-03-12 11:29:59 -07001303static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 struct work_struct *work)
1305{
Tejun Heo112202d2013-02-13 19:29:12 -08001306 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001307 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001308 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001309 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001310 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001311
1312 /*
1313 * While a work item is PENDING && off queue, a task trying to
1314 * steal the PENDING will busy-loop waiting for it to either get
1315 * queued or lose PENDING. Grabbing PENDING and queueing should
1316 * happen with IRQ disabled.
1317 */
1318 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001320 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001321
Li Bin9ef28a72013-09-09 13:13:58 +08001322 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001323 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001324 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001325 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001326retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001327 if (req_cpu == WORK_CPU_UNBOUND)
1328 cpu = raw_smp_processor_id();
1329
Tejun Heoc9178082013-03-12 11:30:04 -07001330 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001331 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001332 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001333 else
1334 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001335
Tejun Heoc9178082013-03-12 11:30:04 -07001336 /*
1337 * If @work was previously on a different pool, it might still be
1338 * running there, in which case the work needs to be queued on that
1339 * pool to guarantee non-reentrancy.
1340 */
1341 last_pool = get_work_pool(work);
1342 if (last_pool && last_pool != pwq->pool) {
1343 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001344
Tejun Heoc9178082013-03-12 11:30:04 -07001345 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001346
Tejun Heoc9178082013-03-12 11:30:04 -07001347 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001348
Tejun Heoc9178082013-03-12 11:30:04 -07001349 if (worker && worker->current_pwq->wq == wq) {
1350 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001351 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001352 /* meh... not running there, queue here */
1353 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001354 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001355 }
Tejun Heof3421792010-07-02 10:03:51 +02001356 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001357 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001358 }
1359
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001360 /*
1361 * pwq is determined and locked. For unbound pools, we could have
1362 * raced with pwq release and it could already be dead. If its
1363 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001364 * without another pwq replacing it in the numa_pwq_tbl or while
1365 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001366 * make forward-progress.
1367 */
1368 if (unlikely(!pwq->refcnt)) {
1369 if (wq->flags & WQ_UNBOUND) {
1370 spin_unlock(&pwq->pool->lock);
1371 cpu_relax();
1372 goto retry;
1373 }
1374 /* oops */
1375 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1376 wq->name, cpu);
1377 }
1378
Tejun Heo112202d2013-02-13 19:29:12 -08001379 /* pwq determined, queue */
1380 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001381
Dan Carpenterf5b25522012-04-13 22:06:58 +03001382 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001383 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001384 return;
1385 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001386
Tejun Heo112202d2013-02-13 19:29:12 -08001387 pwq->nr_in_flight[pwq->work_color]++;
1388 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001389
Tejun Heo112202d2013-02-13 19:29:12 -08001390 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001391 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001392 pwq->nr_active++;
1393 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001394 } else {
1395 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001396 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001397 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001398
Tejun Heo112202d2013-02-13 19:29:12 -08001399 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001400
Tejun Heo112202d2013-02-13 19:29:12 -08001401 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402}
1403
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001404/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001405 * queue_work_on - queue work on specific cpu
1406 * @cpu: CPU number to execute work on
1407 * @wq: workqueue to use
1408 * @work: work to queue
1409 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001410 * We queue the work to a specific CPU, the caller must ensure it
1411 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001412 *
1413 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001414 */
Tejun Heod4283e92012-08-03 10:30:44 -07001415bool queue_work_on(int cpu, struct workqueue_struct *wq,
1416 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001417{
Tejun Heod4283e92012-08-03 10:30:44 -07001418 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001419 unsigned long flags;
1420
1421 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001422
Tejun Heo22df02b2010-06-29 10:07:10 +02001423 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001424 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001425 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001426 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001427
1428 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001429 return ret;
1430}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001431EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001432
Tejun Heod8e794d2012-08-03 10:30:45 -07001433void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434{
David Howells52bad642006-11-22 14:54:01 +00001435 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001437 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001438 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001440EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001442static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1443 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001445 struct timer_list *timer = &dwork->timer;
1446 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001448 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1449 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001450 WARN_ON_ONCE(timer_pending(timer));
1451 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001452
Tejun Heo8852aac2012-12-01 16:23:42 -08001453 /*
1454 * If @delay is 0, queue @dwork->work immediately. This is for
1455 * both optimization and correctness. The earliest @timer can
1456 * expire is on the closest next tick and delayed_work users depend
1457 * on that there's no such delay when @delay is 0.
1458 */
1459 if (!delay) {
1460 __queue_work(cpu, wq, &dwork->work);
1461 return;
1462 }
1463
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001464 timer_stats_timer_set_start_info(&dwork->timer);
1465
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001466 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001467 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001468 timer->expires = jiffies + delay;
1469
1470 if (unlikely(cpu != WORK_CPU_UNBOUND))
1471 add_timer_on(timer, cpu);
1472 else
1473 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474}
1475
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001476/**
1477 * queue_delayed_work_on - queue work on specific CPU after delay
1478 * @cpu: CPU number to execute work on
1479 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001480 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001481 * @delay: number of jiffies to wait before queueing
1482 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001483 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001484 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1485 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001486 */
Tejun Heod4283e92012-08-03 10:30:44 -07001487bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1488 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001489{
David Howells52bad642006-11-22 14:54:01 +00001490 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001491 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001492 unsigned long flags;
1493
1494 /* read the comment in __queue_work() */
1495 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001496
Tejun Heo22df02b2010-06-29 10:07:10 +02001497 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001498 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001499 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001500 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001501
1502 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001503 return ret;
1504}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001505EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506
Tejun Heoc8e55f32010-06-29 10:07:12 +02001507/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001508 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1509 * @cpu: CPU number to execute work on
1510 * @wq: workqueue to use
1511 * @dwork: work to queue
1512 * @delay: number of jiffies to wait before queueing
1513 *
1514 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1515 * modify @dwork's timer so that it expires after @delay. If @delay is
1516 * zero, @work is guaranteed to be scheduled immediately regardless of its
1517 * current state.
1518 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001519 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001520 * pending and its timer was modified.
1521 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001522 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001523 * See try_to_grab_pending() for details.
1524 */
1525bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1526 struct delayed_work *dwork, unsigned long delay)
1527{
1528 unsigned long flags;
1529 int ret;
1530
1531 do {
1532 ret = try_to_grab_pending(&dwork->work, true, &flags);
1533 } while (unlikely(ret == -EAGAIN));
1534
1535 if (likely(ret >= 0)) {
1536 __queue_delayed_work(cpu, wq, dwork, delay);
1537 local_irq_restore(flags);
1538 }
1539
1540 /* -ENOENT from try_to_grab_pending() becomes %true */
1541 return ret;
1542}
1543EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1544
1545/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001546 * worker_enter_idle - enter idle state
1547 * @worker: worker which is entering idle state
1548 *
1549 * @worker is entering idle state. Update stats and idle timer if
1550 * necessary.
1551 *
1552 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001553 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001554 */
1555static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001557 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
Tejun Heo6183c002013-03-12 11:29:57 -07001559 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1560 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1561 (worker->hentry.next || worker->hentry.pprev)))
1562 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563
Tejun Heocb444762010-07-02 10:03:50 +02001564 /* can't use worker_set_flags(), also called from start_worker() */
1565 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001566 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001567 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001568
Tejun Heoc8e55f32010-06-29 10:07:12 +02001569 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001570 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001571
Tejun Heo628c78e2012-07-17 12:39:27 -07001572 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1573 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001574
Tejun Heo544ecf32012-05-14 15:04:50 -07001575 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001576 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001577 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001578 * nr_running, the warning may trigger spuriously. Check iff
1579 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001580 */
Tejun Heo24647572013-01-24 11:01:33 -08001581 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001582 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001583 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584}
1585
Tejun Heoc8e55f32010-06-29 10:07:12 +02001586/**
1587 * worker_leave_idle - leave idle state
1588 * @worker: worker which is leaving idle state
1589 *
1590 * @worker is leaving idle state. Update stats.
1591 *
1592 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001593 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001594 */
1595static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001597 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
Tejun Heo6183c002013-03-12 11:29:57 -07001599 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1600 return;
Tejun Heod302f012010-06-29 10:07:13 +02001601 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001602 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001603 list_del_init(&worker->entry);
1604}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605
Tejun Heoe22bee72010-06-29 10:07:14 +02001606/**
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001607 * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it
1608 * @pool: target worker_pool
1609 *
1610 * Bind %current to the cpu of @pool if it is associated and lock @pool.
Tejun Heoe22bee72010-06-29 10:07:14 +02001611 *
1612 * Works which are scheduled while the cpu is online must at least be
1613 * scheduled to a worker which is bound to the cpu so that if they are
1614 * flushed from cpu callbacks while cpu is going down, they are
1615 * guaranteed to execute on the cpu.
1616 *
Lai Jiangshanf5faa072013-02-19 12:17:02 -08001617 * This function is to be used by unbound workers and rescuers to bind
Tejun Heoe22bee72010-06-29 10:07:14 +02001618 * themselves to the target cpu and may race with cpu going down or
1619 * coming online. kthread_bind() can't be used because it may put the
1620 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
Tejun Heo706026c2013-01-24 11:01:34 -08001621 * verbatim as it's best effort and blocking and pool may be
Tejun Heoe22bee72010-06-29 10:07:14 +02001622 * [dis]associated in the meantime.
1623 *
Tejun Heo706026c2013-01-24 11:01:34 -08001624 * This function tries set_cpus_allowed() and locks pool and verifies the
Tejun Heo24647572013-01-24 11:01:33 -08001625 * binding against %POOL_DISASSOCIATED which is set during
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001626 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1627 * enters idle state or fetches works without dropping lock, it can
1628 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001629 *
1630 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001631 * Might sleep. Called without any lock but returns with pool->lock
Tejun Heoe22bee72010-06-29 10:07:14 +02001632 * held.
1633 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001634 * Return:
Tejun Heo706026c2013-01-24 11:01:34 -08001635 * %true if the associated pool is online (@worker is successfully
Tejun Heoe22bee72010-06-29 10:07:14 +02001636 * bound), %false if offline.
1637 */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001638static bool worker_maybe_bind_and_lock(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001639__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001640{
Tejun Heoe22bee72010-06-29 10:07:14 +02001641 while (true) {
1642 /*
1643 * The following call may fail, succeed or succeed
1644 * without actually migrating the task to the cpu if
1645 * it races with cpu hotunplug operation. Verify
Tejun Heo24647572013-01-24 11:01:33 -08001646 * against POOL_DISASSOCIATED.
Tejun Heoe22bee72010-06-29 10:07:14 +02001647 */
Tejun Heo24647572013-01-24 11:01:33 -08001648 if (!(pool->flags & POOL_DISASSOCIATED))
Tejun Heo7a4e3442013-03-12 11:30:00 -07001649 set_cpus_allowed_ptr(current, pool->attrs->cpumask);
Oleg Nesterov85f41862007-05-09 02:34:20 -07001650
Tejun Heod565ed62013-01-24 11:01:33 -08001651 spin_lock_irq(&pool->lock);
Tejun Heo24647572013-01-24 11:01:33 -08001652 if (pool->flags & POOL_DISASSOCIATED)
Tejun Heoe22bee72010-06-29 10:07:14 +02001653 return false;
Lai Jiangshanf5faa072013-02-19 12:17:02 -08001654 if (task_cpu(current) == pool->cpu &&
Tejun Heo7a4e3442013-03-12 11:30:00 -07001655 cpumask_equal(&current->cpus_allowed, pool->attrs->cpumask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001656 return true;
Tejun Heod565ed62013-01-24 11:01:33 -08001657 spin_unlock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001658
Tejun Heo5035b202011-04-29 18:08:37 +02001659 /*
1660 * We've raced with CPU hot[un]plug. Give it a breather
1661 * and retry migration. cond_resched() is required here;
1662 * otherwise, we might deadlock against cpu_stop trying to
1663 * bring down the CPU on non-preemptive kernel.
1664 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001665 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001666 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001667 }
1668}
1669
Tejun Heoc34056a2010-06-29 10:07:11 +02001670static struct worker *alloc_worker(void)
1671{
1672 struct worker *worker;
1673
1674 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001675 if (worker) {
1676 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001677 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001678 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001679 /* on creation a worker is in !idle && prep state */
1680 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001681 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001682 return worker;
1683}
1684
1685/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001686 * worker_detach_from_pool() - detach a worker from its pool
1687 * @worker: worker which is attached to its pool
1688 * @pool: the pool @worker is attached to
1689 *
1690 * Undo the attaching which had been done in create_worker(). The caller
1691 * worker shouldn't access to the pool after detached except it has other
1692 * reference to the pool.
1693 */
1694static void worker_detach_from_pool(struct worker *worker,
1695 struct worker_pool *pool)
1696{
1697 struct completion *detach_completion = NULL;
1698
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001699 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001700 list_del(&worker->node);
1701 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001702 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001703 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001704
1705 if (detach_completion)
1706 complete(detach_completion);
1707}
1708
1709/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001710 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001711 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001712 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001713 * Create a new worker which is attached to @pool. The new worker must be
1714 * started by start_worker().
Tejun Heoc34056a2010-06-29 10:07:11 +02001715 *
1716 * CONTEXT:
1717 * Might sleep. Does GFP_KERNEL allocations.
1718 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001719 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001720 * Pointer to the newly created worker.
1721 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001722static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001723{
Tejun Heoc34056a2010-06-29 10:07:11 +02001724 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001725 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001726 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001727
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001728 /* ID is needed to determine kthread name */
1729 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001730 if (id < 0)
1731 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001732
1733 worker = alloc_worker();
1734 if (!worker)
1735 goto fail;
1736
Tejun Heobd7bdd42012-07-12 14:46:37 -07001737 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001738 worker->id = id;
1739
Tejun Heo29c91e92013-03-12 11:30:03 -07001740 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001741 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1742 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001743 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001744 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1745
Tejun Heof3f90ad2013-04-01 11:23:34 -07001746 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001747 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001748 if (IS_ERR(worker->task))
1749 goto fail;
1750
Oleg Nesterov91151222013-11-14 12:56:18 +01001751 set_user_nice(worker->task, pool->attrs->nice);
1752
1753 /* prevent userland from meddling with cpumask of workqueue workers */
1754 worker->task->flags |= PF_NO_SETAFFINITY;
1755
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001756 mutex_lock(&pool->attach_mutex);
Lai Jiangshan4d757c52014-05-20 17:46:33 +08001757
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001758 /*
1759 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1760 * online CPUs. It'll be re-applied when any of the CPUs come up.
1761 */
Tejun Heo7a4e3442013-03-12 11:30:00 -07001762 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
Tejun Heo32704762012-07-13 22:16:45 -07001763
Tejun Heo7a4e3442013-03-12 11:30:00 -07001764 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001765 * The pool->attach_mutex ensures %POOL_DISASSOCIATED
Tejun Heo7a4e3442013-03-12 11:30:00 -07001766 * remains stable across this function. See the comments above the
1767 * flag definition for details.
1768 */
1769 if (pool->flags & POOL_DISASSOCIATED)
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001770 worker->flags |= WORKER_UNBOUND;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001771
Lai Jiangshanda028462014-05-20 17:46:31 +08001772 /* successful, attach the worker to the pool */
1773 list_add_tail(&worker->node, &pool->workers);
Tejun Heo822d8402013-03-19 13:45:21 -07001774
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001775 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan4d757c52014-05-20 17:46:33 +08001776
Tejun Heoc34056a2010-06-29 10:07:11 +02001777 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001778
Tejun Heoc34056a2010-06-29 10:07:11 +02001779fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001780 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001781 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001782 kfree(worker);
1783 return NULL;
1784}
1785
1786/**
1787 * start_worker - start a newly created worker
1788 * @worker: worker to start
1789 *
Tejun Heo706026c2013-01-24 11:01:34 -08001790 * Make the pool aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001791 *
1792 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001793 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001794 */
1795static void start_worker(struct worker *worker)
1796{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001797 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001798 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001799 wake_up_process(worker->task);
1800}
1801
1802/**
Tejun Heoebf44d12013-03-13 19:47:39 -07001803 * create_and_start_worker - create and start a worker for a pool
1804 * @pool: the target pool
1805 *
Tejun Heocd549682013-03-13 19:47:39 -07001806 * Grab the managership of @pool and create and start a new worker for it.
Yacine Belkadid185af32013-07-31 14:59:24 -07001807 *
1808 * Return: 0 on success. A negative error code otherwise.
Tejun Heoebf44d12013-03-13 19:47:39 -07001809 */
1810static int create_and_start_worker(struct worker_pool *pool)
1811{
1812 struct worker *worker;
1813
1814 worker = create_worker(pool);
1815 if (worker) {
1816 spin_lock_irq(&pool->lock);
1817 start_worker(worker);
1818 spin_unlock_irq(&pool->lock);
1819 }
1820
1821 return worker ? 0 : -ENOMEM;
1822}
1823
1824/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001825 * destroy_worker - destroy a workqueue worker
1826 * @worker: worker to be destroyed
1827 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001828 * Destroy @worker and adjust @pool stats accordingly. The worker should
1829 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001830 *
1831 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001832 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001833 */
1834static void destroy_worker(struct worker *worker)
1835{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001836 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001837
Tejun Heocd549682013-03-13 19:47:39 -07001838 lockdep_assert_held(&pool->lock);
1839
Tejun Heoc34056a2010-06-29 10:07:11 +02001840 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001841 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001842 WARN_ON(!list_empty(&worker->scheduled)) ||
1843 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001844 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001845
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001846 pool->nr_workers--;
1847 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001848
1849 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001850 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001851 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001852}
1853
Tejun Heo63d95a92012-07-12 14:46:37 -07001854static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001855{
Tejun Heo63d95a92012-07-12 14:46:37 -07001856 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001857
Tejun Heod565ed62013-01-24 11:01:33 -08001858 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001859
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001860 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001861 struct worker *worker;
1862 unsigned long expires;
1863
1864 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001865 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001866 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1867
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001868 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001869 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001870 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001871 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001872
1873 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001874 }
1875
Tejun Heod565ed62013-01-24 11:01:33 -08001876 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001877}
1878
Tejun Heo493a1722013-03-12 11:29:59 -07001879static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001880{
Tejun Heo112202d2013-02-13 19:29:12 -08001881 struct pool_workqueue *pwq = get_work_pwq(work);
1882 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001883
Tejun Heo2e109a22013-03-13 19:47:40 -07001884 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001885
Tejun Heo493008a2013-03-12 11:30:03 -07001886 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001887 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001888
1889 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001890 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001891 /*
1892 * If @pwq is for an unbound wq, its base ref may be put at
1893 * any time due to an attribute change. Pin @pwq until the
1894 * rescuer is done with it.
1895 */
1896 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001897 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001898 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001899 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001900}
1901
Tejun Heo706026c2013-01-24 11:01:34 -08001902static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001903{
Tejun Heo63d95a92012-07-12 14:46:37 -07001904 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001905 struct work_struct *work;
1906
Tejun Heo2e109a22013-03-13 19:47:40 -07001907 spin_lock_irq(&wq_mayday_lock); /* for wq->maydays */
Tejun Heo493a1722013-03-12 11:29:59 -07001908 spin_lock(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001909
Tejun Heo63d95a92012-07-12 14:46:37 -07001910 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001911 /*
1912 * We've been trying to create a new worker but
1913 * haven't been successful. We might be hitting an
1914 * allocation deadlock. Send distress signals to
1915 * rescuers.
1916 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001917 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001918 send_mayday(work);
1919 }
1920
Tejun Heo493a1722013-03-12 11:29:59 -07001921 spin_unlock(&pool->lock);
Tejun Heo2e109a22013-03-13 19:47:40 -07001922 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001923
Tejun Heo63d95a92012-07-12 14:46:37 -07001924 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001925}
1926
1927/**
1928 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001929 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001930 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001931 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001932 * have at least one idle worker on return from this function. If
1933 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001934 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001935 * possible allocation deadlock.
1936 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001937 * On return, need_to_create_worker() is guaranteed to be %false and
1938 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001939 *
1940 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001941 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001942 * multiple times. Does GFP_KERNEL allocations. Called only from
1943 * manager.
1944 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001945 * Return:
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001946 * %false if no action was taken and pool->lock stayed locked, %true
Tejun Heoe22bee72010-06-29 10:07:14 +02001947 * otherwise.
1948 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001949static bool maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001950__releases(&pool->lock)
1951__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001952{
Tejun Heo63d95a92012-07-12 14:46:37 -07001953 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001954 return false;
1955restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001956 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001957
Tejun Heoe22bee72010-06-29 10:07:14 +02001958 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001959 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001960
1961 while (true) {
1962 struct worker *worker;
1963
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001964 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001965 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001966 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001967 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001968 start_worker(worker);
Tejun Heo6183c002013-03-12 11:29:57 -07001969 if (WARN_ON_ONCE(need_to_create_worker(pool)))
1970 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001971 return true;
1972 }
1973
Tejun Heo63d95a92012-07-12 14:46:37 -07001974 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001975 break;
1976
Tejun Heoe22bee72010-06-29 10:07:14 +02001977 __set_current_state(TASK_INTERRUPTIBLE);
1978 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001979
Tejun Heo63d95a92012-07-12 14:46:37 -07001980 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001981 break;
1982 }
1983
Tejun Heo63d95a92012-07-12 14:46:37 -07001984 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001985 spin_lock_irq(&pool->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07001986 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001987 goto restart;
1988 return true;
1989}
1990
1991/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001992 * manage_workers - manage worker pool
1993 * @worker: self
1994 *
Tejun Heo706026c2013-01-24 11:01:34 -08001995 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001996 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001997 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001998 *
1999 * The caller can safely start processing works on false return. On
2000 * true return, it's guaranteed that need_to_create_worker() is false
2001 * and may_start_working() is true.
2002 *
2003 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002004 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002005 * multiple times. Does GFP_KERNEL allocations.
2006 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002007 * Return:
Libin2d498db2013-08-21 08:50:40 +08002008 * %false if the pool don't need management and the caller can safely start
2009 * processing works, %true indicates that the function released pool->lock
2010 * and reacquired it to perform some management function and that the
2011 * conditions that the caller verified while holding the lock before
2012 * calling the function might no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002013 */
2014static bool manage_workers(struct worker *worker)
2015{
Tejun Heo63d95a92012-07-12 14:46:37 -07002016 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002017 bool ret = false;
2018
Tejun Heobc3a1af2013-03-13 19:47:39 -07002019 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07002020 * Anyone who successfully grabs manager_arb wins the arbitration
2021 * and becomes the manager. mutex_trylock() on pool->manager_arb
2022 * failure while holding pool->lock reliably indicates that someone
2023 * else is managing the pool and the worker which failed trylock
2024 * can proceed to executing work items. This means that anyone
2025 * grabbing manager_arb is responsible for actually performing
2026 * manager duties. If manager_arb is grabbed and released without
2027 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07002028 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07002029 if (!mutex_trylock(&pool->manager_arb))
Tejun Heoe22bee72010-06-29 10:07:14 +02002030 return ret;
2031
Tejun Heo63d95a92012-07-12 14:46:37 -07002032 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002033
Tejun Heo34a06bd2013-03-12 11:30:00 -07002034 mutex_unlock(&pool->manager_arb);
Tejun Heoe22bee72010-06-29 10:07:14 +02002035 return ret;
2036}
2037
Tejun Heoa62428c2010-06-29 10:07:10 +02002038/**
2039 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002040 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002041 * @work: work to process
2042 *
2043 * Process @work. This function contains all the logics necessary to
2044 * process a single work including synchronization against and
2045 * interaction with other workers on the same cpu, queueing and
2046 * flushing. As long as context requirement is met, any worker can
2047 * call this function to process a work.
2048 *
2049 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002050 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002051 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002052static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002053__releases(&pool->lock)
2054__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002055{
Tejun Heo112202d2013-02-13 19:29:12 -08002056 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002057 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002058 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002059 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002060 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002061#ifdef CONFIG_LOCKDEP
2062 /*
2063 * It is permissible to free the struct work_struct from
2064 * inside the function that is called from it, this we need to
2065 * take into account for lockdep too. To avoid bogus "held
2066 * lock freed" warnings as well as problems when looking into
2067 * work->lockdep_map, make a copy and use that here.
2068 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002069 struct lockdep_map lockdep_map;
2070
2071 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002072#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002073 /*
2074 * Ensure we're on the correct CPU. DISASSOCIATED test is
2075 * necessary to avoid spurious warnings from rescuers servicing the
Tejun Heo24647572013-01-24 11:01:33 -08002076 * unbound or a disassociated pool.
Tejun Heo6fec10a2012-07-22 10:16:34 -07002077 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002078 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo24647572013-01-24 11:01:33 -08002079 !(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002080 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002081
Tejun Heo7e116292010-06-29 10:07:13 +02002082 /*
2083 * A single work shouldn't be executed concurrently by
2084 * multiple workers on a single cpu. Check whether anyone is
2085 * already processing the work. If so, defer the work to the
2086 * currently executing one.
2087 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002088 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002089 if (unlikely(collision)) {
2090 move_linked_works(work, &collision->scheduled, NULL);
2091 return;
2092 }
2093
Tejun Heo8930cab2012-08-03 10:30:45 -07002094 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002095 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002096 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002097 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002098 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002099 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002100 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002101
Tejun Heoa62428c2010-06-29 10:07:10 +02002102 list_del_init(&work->entry);
2103
Tejun Heo649027d2010-06-29 10:07:14 +02002104 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002105 * CPU intensive works don't participate in concurrency
2106 * management. They're the scheduler's responsibility.
2107 */
2108 if (unlikely(cpu_intensive))
2109 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2110
Tejun Heo974271c2012-07-12 14:46:37 -07002111 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002112 * Unbound pool isn't concurrency managed and work items should be
Tejun Heo974271c2012-07-12 14:46:37 -07002113 * executed ASAP. Wake up another worker if necessary.
2114 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002115 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2116 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002117
Tejun Heo8930cab2012-08-03 10:30:45 -07002118 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002119 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002120 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002121 * PENDING and queued state changes happen together while IRQ is
2122 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002123 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002124 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002125
Tejun Heod565ed62013-01-24 11:01:33 -08002126 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002127
Tejun Heo112202d2013-02-13 19:29:12 -08002128 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002129 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002130 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002131 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002132 /*
2133 * While we must be careful to not use "work" after this, the trace
2134 * point will only record its address.
2135 */
2136 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002137 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002138 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002139
2140 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002141 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2142 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002143 current->comm, preempt_count(), task_pid_nr(current),
2144 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002145 debug_show_held_locks(current);
2146 dump_stack();
2147 }
2148
Tejun Heob22ce272013-08-28 17:33:37 -04002149 /*
2150 * The following prevents a kworker from hogging CPU on !PREEMPT
2151 * kernels, where a requeueing work item waiting for something to
2152 * happen could deadlock with stop_machine as such work item could
2153 * indefinitely requeue itself while all other CPUs are trapped in
2154 * stop_machine.
2155 */
2156 cond_resched();
2157
Tejun Heod565ed62013-01-24 11:01:33 -08002158 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002159
Tejun Heofb0e7be2010-06-29 10:07:15 +02002160 /* clear cpu intensive status */
2161 if (unlikely(cpu_intensive))
2162 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2163
Tejun Heoa62428c2010-06-29 10:07:10 +02002164 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002165 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002166 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002167 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002168 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002169 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002170 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002171}
2172
Tejun Heoaffee4b2010-06-29 10:07:12 +02002173/**
2174 * process_scheduled_works - process scheduled works
2175 * @worker: self
2176 *
2177 * Process all scheduled works. Please note that the scheduled list
2178 * may change while processing a work, so this function repeatedly
2179 * fetches a work from the top and executes it.
2180 *
2181 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002182 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002183 * multiple times.
2184 */
2185static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002187 while (!list_empty(&worker->scheduled)) {
2188 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002190 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192}
2193
Tejun Heo4690c4a2010-06-29 10:07:10 +02002194/**
2195 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002196 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002197 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002198 * The worker thread function. All workers belong to a worker_pool -
2199 * either a per-cpu one or dynamic unbound one. These workers process all
2200 * work items regardless of their specific target workqueue. The only
2201 * exception is work items which belong to workqueues with a rescuer which
2202 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002203 *
2204 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002205 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002206static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207{
Tejun Heoc34056a2010-06-29 10:07:11 +02002208 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002209 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210
Tejun Heoe22bee72010-06-29 10:07:14 +02002211 /* tell the scheduler that this is a workqueue worker */
2212 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002213woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002214 spin_lock_irq(&pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215
Tejun Heoa9ab7752013-03-19 13:45:21 -07002216 /* am I supposed to die? */
2217 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002218 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002219 WARN_ON_ONCE(!list_empty(&worker->entry));
2220 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002221
2222 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002223 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002224 worker_detach_from_pool(worker, pool);
2225 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002226 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 }
2228
Tejun Heoc8e55f32010-06-29 10:07:12 +02002229 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002230recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002231 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002232 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002233 goto sleep;
2234
2235 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002236 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002237 goto recheck;
2238
Tejun Heoc8e55f32010-06-29 10:07:12 +02002239 /*
2240 * ->scheduled list can only be filled while a worker is
2241 * preparing to process a work or actually processing it.
2242 * Make sure nobody diddled with it while I was sleeping.
2243 */
Tejun Heo6183c002013-03-12 11:29:57 -07002244 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002245
Tejun Heoe22bee72010-06-29 10:07:14 +02002246 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002247 * Finish PREP stage. We're guaranteed to have at least one idle
2248 * worker or that someone else has already assumed the manager
2249 * role. This is where @worker starts participating in concurrency
2250 * management if applicable and concurrency management is restored
2251 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002252 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002253 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002254
2255 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002256 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002257 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002258 struct work_struct, entry);
2259
2260 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2261 /* optimization path, not strictly necessary */
2262 process_one_work(worker, work);
2263 if (unlikely(!list_empty(&worker->scheduled)))
2264 process_scheduled_works(worker);
2265 } else {
2266 move_linked_works(work, &worker->scheduled, NULL);
2267 process_scheduled_works(worker);
2268 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002269 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002270
Tejun Heoe22bee72010-06-29 10:07:14 +02002271 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002272sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002273 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002274 * pool->lock is held and there's no work to process and no need to
2275 * manage, sleep. Workers are woken up only while holding
2276 * pool->lock or from local cpu, so setting the current state
2277 * before releasing pool->lock is enough to prevent losing any
2278 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002279 */
2280 worker_enter_idle(worker);
2281 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002282 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002283 schedule();
2284 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285}
2286
Tejun Heoe22bee72010-06-29 10:07:14 +02002287/**
2288 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002289 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002290 *
2291 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002292 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002293 *
Tejun Heo706026c2013-01-24 11:01:34 -08002294 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002295 * worker which uses GFP_KERNEL allocation which has slight chance of
2296 * developing into deadlock if some works currently on the same queue
2297 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2298 * the problem rescuer solves.
2299 *
Tejun Heo706026c2013-01-24 11:01:34 -08002300 * When such condition is possible, the pool summons rescuers of all
2301 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002302 * those works so that forward progress can be guaranteed.
2303 *
2304 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002305 *
2306 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002307 */
Tejun Heo111c2252013-01-17 17:16:24 -08002308static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002309{
Tejun Heo111c2252013-01-17 17:16:24 -08002310 struct worker *rescuer = __rescuer;
2311 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002312 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002313 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002314
2315 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002316
2317 /*
2318 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2319 * doesn't participate in concurrency management.
2320 */
2321 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002322repeat:
2323 set_current_state(TASK_INTERRUPTIBLE);
2324
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002325 /*
2326 * By the time the rescuer is requested to stop, the workqueue
2327 * shouldn't have any work pending, but @wq->maydays may still have
2328 * pwq(s) queued. This can happen by non-rescuer workers consuming
2329 * all the work items before the rescuer got to them. Go through
2330 * @wq->maydays processing before acting on should_stop so that the
2331 * list is always empty on exit.
2332 */
2333 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002334
Tejun Heo493a1722013-03-12 11:29:59 -07002335 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002336 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002337
2338 while (!list_empty(&wq->maydays)) {
2339 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2340 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002341 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002342 struct work_struct *work, *n;
2343
2344 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002345 list_del_init(&pwq->mayday_node);
2346
Tejun Heo2e109a22013-03-13 19:47:40 -07002347 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002348
2349 /* migrate to the target cpu if possible */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08002350 worker_maybe_bind_and_lock(pool);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002351 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002352
2353 /*
2354 * Slurp in all works issued via this workqueue and
2355 * process'em.
2356 */
Tejun Heo6183c002013-03-12 11:29:57 -07002357 WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002358 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002359 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002360 move_linked_works(work, scheduled, &n);
2361
2362 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002363
2364 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002365 * Put the reference grabbed by send_mayday(). @pool won't
2366 * go away while we're holding its lock.
2367 */
2368 put_pwq(pwq);
2369
2370 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002371 * Leave this pool. If keep_working() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002372 * regular worker; otherwise, we end up with 0 concurrency
2373 * and stalling the execution.
2374 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002375 if (keep_working(pool))
2376 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002377
Lai Jiangshanb3104102013-02-19 12:17:02 -08002378 rescuer->pool = NULL;
Tejun Heo493a1722013-03-12 11:29:59 -07002379 spin_unlock(&pool->lock);
Tejun Heo2e109a22013-03-13 19:47:40 -07002380 spin_lock(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002381 }
2382
Tejun Heo2e109a22013-03-13 19:47:40 -07002383 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002384
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002385 if (should_stop) {
2386 __set_current_state(TASK_RUNNING);
2387 rescuer->task->flags &= ~PF_WQ_WORKER;
2388 return 0;
2389 }
2390
Tejun Heo111c2252013-01-17 17:16:24 -08002391 /* rescuers should never participate in concurrency management */
2392 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002393 schedule();
2394 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395}
2396
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002397struct wq_barrier {
2398 struct work_struct work;
2399 struct completion done;
2400};
2401
2402static void wq_barrier_func(struct work_struct *work)
2403{
2404 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2405 complete(&barr->done);
2406}
2407
Tejun Heo4690c4a2010-06-29 10:07:10 +02002408/**
2409 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002410 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002411 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002412 * @target: target work to attach @barr to
2413 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002414 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002415 * @barr is linked to @target such that @barr is completed only after
2416 * @target finishes execution. Please note that the ordering
2417 * guarantee is observed only with respect to @target and on the local
2418 * cpu.
2419 *
2420 * Currently, a queued barrier can't be canceled. This is because
2421 * try_to_grab_pending() can't determine whether the work to be
2422 * grabbed is at the head of the queue and thus can't clear LINKED
2423 * flag of the previous work while there must be a valid next work
2424 * after a work with LINKED flag set.
2425 *
2426 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002427 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002428 *
2429 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002430 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002431 */
Tejun Heo112202d2013-02-13 19:29:12 -08002432static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002433 struct wq_barrier *barr,
2434 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002435{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002436 struct list_head *head;
2437 unsigned int linked = 0;
2438
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002439 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002440 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002441 * as we know for sure that this will not trigger any of the
2442 * checks and call back into the fixup functions where we
2443 * might deadlock.
2444 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002445 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002446 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002447 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002448
Tejun Heoaffee4b2010-06-29 10:07:12 +02002449 /*
2450 * If @target is currently being executed, schedule the
2451 * barrier to the worker; otherwise, put it after @target.
2452 */
2453 if (worker)
2454 head = worker->scheduled.next;
2455 else {
2456 unsigned long *bits = work_data_bits(target);
2457
2458 head = target->entry.next;
2459 /* there can already be other linked works, inherit and set */
2460 linked = *bits & WORK_STRUCT_LINKED;
2461 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2462 }
2463
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002464 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002465 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002466 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002467}
2468
Tejun Heo73f53c42010-06-29 10:07:11 +02002469/**
Tejun Heo112202d2013-02-13 19:29:12 -08002470 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002471 * @wq: workqueue being flushed
2472 * @flush_color: new flush color, < 0 for no-op
2473 * @work_color: new work color, < 0 for no-op
2474 *
Tejun Heo112202d2013-02-13 19:29:12 -08002475 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002476 *
Tejun Heo112202d2013-02-13 19:29:12 -08002477 * If @flush_color is non-negative, flush_color on all pwqs should be
2478 * -1. If no pwq has in-flight commands at the specified color, all
2479 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2480 * has in flight commands, its pwq->flush_color is set to
2481 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002482 * wakeup logic is armed and %true is returned.
2483 *
2484 * The caller should have initialized @wq->first_flusher prior to
2485 * calling this function with non-negative @flush_color. If
2486 * @flush_color is negative, no flush color update is done and %false
2487 * is returned.
2488 *
Tejun Heo112202d2013-02-13 19:29:12 -08002489 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002490 * work_color which is previous to @work_color and all will be
2491 * advanced to @work_color.
2492 *
2493 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002494 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002495 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002496 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002497 * %true if @flush_color >= 0 and there's something to flush. %false
2498 * otherwise.
2499 */
Tejun Heo112202d2013-02-13 19:29:12 -08002500static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002501 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502{
Tejun Heo73f53c42010-06-29 10:07:11 +02002503 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002504 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002505
Tejun Heo73f53c42010-06-29 10:07:11 +02002506 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002507 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002508 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002509 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002510
Tejun Heo49e3cf42013-03-12 11:29:58 -07002511 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002512 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002513
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002514 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002515
2516 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002517 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002518
Tejun Heo112202d2013-02-13 19:29:12 -08002519 if (pwq->nr_in_flight[flush_color]) {
2520 pwq->flush_color = flush_color;
2521 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002522 wait = true;
2523 }
2524 }
2525
2526 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002527 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002528 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002529 }
2530
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002531 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002532 }
2533
Tejun Heo112202d2013-02-13 19:29:12 -08002534 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002535 complete(&wq->first_flusher->done);
2536
2537 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538}
2539
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002540/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002542 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002544 * This function sleeps until all work items which were queued on entry
2545 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002546 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002547void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548{
Tejun Heo73f53c42010-06-29 10:07:11 +02002549 struct wq_flusher this_flusher = {
2550 .list = LIST_HEAD_INIT(this_flusher.list),
2551 .flush_color = -1,
2552 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2553 };
2554 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002555
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002556 lock_map_acquire(&wq->lockdep_map);
2557 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002558
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002559 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002560
2561 /*
2562 * Start-to-wait phase
2563 */
2564 next_color = work_next_color(wq->work_color);
2565
2566 if (next_color != wq->flush_color) {
2567 /*
2568 * Color space is not full. The current work_color
2569 * becomes our flush_color and work_color is advanced
2570 * by one.
2571 */
Tejun Heo6183c002013-03-12 11:29:57 -07002572 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002573 this_flusher.flush_color = wq->work_color;
2574 wq->work_color = next_color;
2575
2576 if (!wq->first_flusher) {
2577 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002578 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002579
2580 wq->first_flusher = &this_flusher;
2581
Tejun Heo112202d2013-02-13 19:29:12 -08002582 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002583 wq->work_color)) {
2584 /* nothing to flush, done */
2585 wq->flush_color = next_color;
2586 wq->first_flusher = NULL;
2587 goto out_unlock;
2588 }
2589 } else {
2590 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002591 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002592 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002593 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002594 }
2595 } else {
2596 /*
2597 * Oops, color space is full, wait on overflow queue.
2598 * The next flush completion will assign us
2599 * flush_color and transfer to flusher_queue.
2600 */
2601 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2602 }
2603
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002604 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002605
2606 wait_for_completion(&this_flusher.done);
2607
2608 /*
2609 * Wake-up-and-cascade phase
2610 *
2611 * First flushers are responsible for cascading flushes and
2612 * handling overflow. Non-first flushers can simply return.
2613 */
2614 if (wq->first_flusher != &this_flusher)
2615 return;
2616
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002617 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002618
Tejun Heo4ce48b32010-07-02 10:03:51 +02002619 /* we might have raced, check again with mutex held */
2620 if (wq->first_flusher != &this_flusher)
2621 goto out_unlock;
2622
Tejun Heo73f53c42010-06-29 10:07:11 +02002623 wq->first_flusher = NULL;
2624
Tejun Heo6183c002013-03-12 11:29:57 -07002625 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2626 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002627
2628 while (true) {
2629 struct wq_flusher *next, *tmp;
2630
2631 /* complete all the flushers sharing the current flush color */
2632 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2633 if (next->flush_color != wq->flush_color)
2634 break;
2635 list_del_init(&next->list);
2636 complete(&next->done);
2637 }
2638
Tejun Heo6183c002013-03-12 11:29:57 -07002639 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2640 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002641
2642 /* this flush_color is finished, advance by one */
2643 wq->flush_color = work_next_color(wq->flush_color);
2644
2645 /* one color has been freed, handle overflow queue */
2646 if (!list_empty(&wq->flusher_overflow)) {
2647 /*
2648 * Assign the same color to all overflowed
2649 * flushers, advance work_color and append to
2650 * flusher_queue. This is the start-to-wait
2651 * phase for these overflowed flushers.
2652 */
2653 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2654 tmp->flush_color = wq->work_color;
2655
2656 wq->work_color = work_next_color(wq->work_color);
2657
2658 list_splice_tail_init(&wq->flusher_overflow,
2659 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002660 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002661 }
2662
2663 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002664 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002665 break;
2666 }
2667
2668 /*
2669 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002670 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002671 */
Tejun Heo6183c002013-03-12 11:29:57 -07002672 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2673 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002674
2675 list_del_init(&next->list);
2676 wq->first_flusher = next;
2677
Tejun Heo112202d2013-02-13 19:29:12 -08002678 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002679 break;
2680
2681 /*
2682 * Meh... this color is already done, clear first
2683 * flusher and repeat cascading.
2684 */
2685 wq->first_flusher = NULL;
2686 }
2687
2688out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002689 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690}
Dave Jonesae90dd52006-06-30 01:40:45 -04002691EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002692
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002693/**
2694 * drain_workqueue - drain a workqueue
2695 * @wq: workqueue to drain
2696 *
2697 * Wait until the workqueue becomes empty. While draining is in progress,
2698 * only chain queueing is allowed. IOW, only currently pending or running
2699 * work items on @wq can queue further work items on it. @wq is flushed
2700 * repeatedly until it becomes empty. The number of flushing is detemined
2701 * by the depth of chaining and should be relatively short. Whine if it
2702 * takes too long.
2703 */
2704void drain_workqueue(struct workqueue_struct *wq)
2705{
2706 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002707 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002708
2709 /*
2710 * __queue_work() needs to test whether there are drainers, is much
2711 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002712 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002713 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002714 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002715 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002716 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002717 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002718reflush:
2719 flush_workqueue(wq);
2720
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002721 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002722
Tejun Heo49e3cf42013-03-12 11:29:58 -07002723 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002724 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002725
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002726 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002727 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002728 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002729
2730 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002731 continue;
2732
2733 if (++flush_cnt == 10 ||
2734 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002735 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002736 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002737
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002738 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002739 goto reflush;
2740 }
2741
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002742 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002743 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002744 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002745}
2746EXPORT_SYMBOL_GPL(drain_workqueue);
2747
Tejun Heo606a5022012-08-20 14:51:23 -07002748static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002749{
2750 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002751 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002752 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002753
2754 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002755
Tejun Heofa1b54e2013-03-12 11:30:00 -07002756 local_irq_disable();
2757 pool = get_work_pool(work);
2758 if (!pool) {
2759 local_irq_enable();
2760 return false;
2761 }
2762
2763 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002764 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002765 pwq = get_work_pwq(work);
2766 if (pwq) {
2767 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002768 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002769 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002770 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002771 if (!worker)
2772 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002773 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002774 }
Tejun Heobaf59022010-09-16 10:42:16 +02002775
Tejun Heo112202d2013-02-13 19:29:12 -08002776 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002777 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002778
Tejun Heoe1594892011-01-09 23:32:15 +01002779 /*
2780 * If @max_active is 1 or rescuer is in use, flushing another work
2781 * item on the same workqueue may lead to deadlock. Make sure the
2782 * flusher is not running on the same workqueue by verifying write
2783 * access.
2784 */
Tejun Heo493008a2013-03-12 11:30:03 -07002785 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002786 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002787 else
Tejun Heo112202d2013-02-13 19:29:12 -08002788 lock_map_acquire_read(&pwq->wq->lockdep_map);
2789 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002790
Tejun Heobaf59022010-09-16 10:42:16 +02002791 return true;
2792already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002793 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002794 return false;
2795}
2796
Oleg Nesterovdb700892008-07-25 01:47:49 -07002797/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002798 * flush_work - wait for a work to finish executing the last queueing instance
2799 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002800 *
Tejun Heo606a5022012-08-20 14:51:23 -07002801 * Wait until @work has finished execution. @work is guaranteed to be idle
2802 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002803 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002804 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002805 * %true if flush_work() waited for the work to finish execution,
2806 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002807 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002808bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002809{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002810 struct wq_barrier barr;
2811
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002812 lock_map_acquire(&work->lockdep_map);
2813 lock_map_release(&work->lockdep_map);
2814
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002815 if (start_flush_work(work, &barr)) {
2816 wait_for_completion(&barr.done);
2817 destroy_work_on_stack(&barr.work);
2818 return true;
2819 } else {
2820 return false;
2821 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002822}
2823EXPORT_SYMBOL_GPL(flush_work);
2824
Tejun Heo36e227d2012-08-03 10:30:46 -07002825static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002826{
Tejun Heobbb68df2012-08-03 10:30:46 -07002827 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002828 int ret;
2829
2830 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002831 ret = try_to_grab_pending(work, is_dwork, &flags);
2832 /*
2833 * If someone else is canceling, wait for the same event it
2834 * would be waiting for before retrying.
2835 */
2836 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002837 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002838 } while (unlikely(ret < 0));
2839
Tejun Heobbb68df2012-08-03 10:30:46 -07002840 /* tell other tasks trying to grab @work to back off */
2841 mark_work_canceling(work);
2842 local_irq_restore(flags);
2843
Tejun Heo606a5022012-08-20 14:51:23 -07002844 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002845 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002846 return ret;
2847}
2848
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002849/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002850 * cancel_work_sync - cancel a work and wait for it to finish
2851 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002852 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002853 * Cancel @work and wait for its execution to finish. This function
2854 * can be used even if the work re-queues itself or migrates to
2855 * another workqueue. On return from this function, @work is
2856 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002857 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002858 * cancel_work_sync(&delayed_work->work) must not be used for
2859 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002860 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002861 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002862 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002863 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002864 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002865 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002866 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002867bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002868{
Tejun Heo36e227d2012-08-03 10:30:46 -07002869 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002870}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002871EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002872
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002873/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002874 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2875 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002876 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002877 * Delayed timer is cancelled and the pending work is queued for
2878 * immediate execution. Like flush_work(), this function only
2879 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002880 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002881 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002882 * %true if flush_work() waited for the work to finish execution,
2883 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002884 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002885bool flush_delayed_work(struct delayed_work *dwork)
2886{
Tejun Heo8930cab2012-08-03 10:30:45 -07002887 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002888 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002889 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002890 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002891 return flush_work(&dwork->work);
2892}
2893EXPORT_SYMBOL(flush_delayed_work);
2894
2895/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002896 * cancel_delayed_work - cancel a delayed work
2897 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002898 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002899 * Kill off a pending delayed_work.
2900 *
2901 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2902 * pending.
2903 *
2904 * Note:
2905 * The work callback function may still be running on return, unless
2906 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2907 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002908 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002909 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002910 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002911bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002912{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002913 unsigned long flags;
2914 int ret;
2915
2916 do {
2917 ret = try_to_grab_pending(&dwork->work, true, &flags);
2918 } while (unlikely(ret == -EAGAIN));
2919
2920 if (unlikely(ret < 0))
2921 return false;
2922
Tejun Heo7c3eed52013-01-24 11:01:33 -08002923 set_work_pool_and_clear_pending(&dwork->work,
2924 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002925 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002926 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002927}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002928EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002929
2930/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002931 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2932 * @dwork: the delayed work cancel
2933 *
2934 * This is cancel_work_sync() for delayed works.
2935 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002936 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002937 * %true if @dwork was pending, %false otherwise.
2938 */
2939bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002940{
Tejun Heo36e227d2012-08-03 10:30:46 -07002941 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002942}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002943EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002945/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002946 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002947 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002948 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002949 * schedule_on_each_cpu() executes @func on each online CPU using the
2950 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002951 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002952 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002953 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02002954 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002955 */
David Howells65f27f32006-11-22 14:55:48 +00002956int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002957{
2958 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002959 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002960
Andrew Mortonb6136772006-06-25 05:47:49 -07002961 works = alloc_percpu(struct work_struct);
2962 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002963 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002964
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002965 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002966
Christoph Lameter15316ba2006-01-08 01:00:43 -08002967 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002968 struct work_struct *work = per_cpu_ptr(works, cpu);
2969
2970 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002971 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002972 }
Tejun Heo93981802009-11-17 14:06:20 -08002973
2974 for_each_online_cpu(cpu)
2975 flush_work(per_cpu_ptr(works, cpu));
2976
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002977 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002978 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002979 return 0;
2980}
2981
Alan Sterneef6a7d2010-02-12 17:39:21 +09002982/**
2983 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2984 *
2985 * Forces execution of the kernel-global workqueue and blocks until its
2986 * completion.
2987 *
2988 * Think twice before calling this function! It's very easy to get into
2989 * trouble if you don't take great care. Either of the following situations
2990 * will lead to deadlock:
2991 *
2992 * One of the work items currently on the workqueue needs to acquire
2993 * a lock held by your code or its caller.
2994 *
2995 * Your code is running in the context of a work routine.
2996 *
2997 * They will be detected by lockdep when they occur, but the first might not
2998 * occur very often. It depends on what work items are on the workqueue and
2999 * what locks they need, which you have no control over.
3000 *
3001 * In most situations flushing the entire workqueue is overkill; you merely
3002 * need to know that a particular work item isn't queued and isn't running.
3003 * In such cases you should use cancel_delayed_work_sync() or
3004 * cancel_work_sync() instead.
3005 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003006void flush_scheduled_work(void)
3007{
Tejun Heod320c032010-06-29 10:07:14 +02003008 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003009}
Dave Jonesae90dd52006-06-30 01:40:45 -04003010EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011
3012/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003013 * execute_in_process_context - reliably execute the routine with user context
3014 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003015 * @ew: guaranteed storage for the execute work structure (must
3016 * be available when the work executes)
3017 *
3018 * Executes the function immediately if process context is available,
3019 * otherwise schedules the function for delayed execution.
3020 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003021 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003022 * 1 - function was scheduled for execution
3023 */
David Howells65f27f32006-11-22 14:55:48 +00003024int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003025{
3026 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003027 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003028 return 0;
3029 }
3030
David Howells65f27f32006-11-22 14:55:48 +00003031 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003032 schedule_work(&ew->work);
3033
3034 return 1;
3035}
3036EXPORT_SYMBOL_GPL(execute_in_process_context);
3037
Tejun Heo226223a2013-03-12 11:30:05 -07003038#ifdef CONFIG_SYSFS
3039/*
3040 * Workqueues with WQ_SYSFS flag set is visible to userland via
3041 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
3042 * following attributes.
3043 *
3044 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
3045 * max_active RW int : maximum number of in-flight work items
3046 *
3047 * Unbound workqueues have the following extra attributes.
3048 *
3049 * id RO int : the associated pool ID
3050 * nice RW int : nice value of the workers
3051 * cpumask RW mask : bitmask of allowed CPUs for the workers
3052 */
3053struct wq_device {
3054 struct workqueue_struct *wq;
3055 struct device dev;
3056};
3057
3058static struct workqueue_struct *dev_to_wq(struct device *dev)
3059{
3060 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3061
3062 return wq_dev->wq;
3063}
3064
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003065static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
3066 char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07003067{
3068 struct workqueue_struct *wq = dev_to_wq(dev);
3069
3070 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
3071}
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003072static DEVICE_ATTR_RO(per_cpu);
Tejun Heo226223a2013-03-12 11:30:05 -07003073
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003074static ssize_t max_active_show(struct device *dev,
3075 struct device_attribute *attr, char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07003076{
3077 struct workqueue_struct *wq = dev_to_wq(dev);
3078
3079 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
3080}
3081
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003082static ssize_t max_active_store(struct device *dev,
3083 struct device_attribute *attr, const char *buf,
3084 size_t count)
Tejun Heo226223a2013-03-12 11:30:05 -07003085{
3086 struct workqueue_struct *wq = dev_to_wq(dev);
3087 int val;
3088
3089 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
3090 return -EINVAL;
3091
3092 workqueue_set_max_active(wq, val);
3093 return count;
3094}
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003095static DEVICE_ATTR_RW(max_active);
Tejun Heo226223a2013-03-12 11:30:05 -07003096
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003097static struct attribute *wq_sysfs_attrs[] = {
3098 &dev_attr_per_cpu.attr,
3099 &dev_attr_max_active.attr,
3100 NULL,
Tejun Heo226223a2013-03-12 11:30:05 -07003101};
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003102ATTRIBUTE_GROUPS(wq_sysfs);
Tejun Heo226223a2013-03-12 11:30:05 -07003103
Tejun Heod55262c2013-04-01 11:23:38 -07003104static ssize_t wq_pool_ids_show(struct device *dev,
3105 struct device_attribute *attr, char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07003106{
3107 struct workqueue_struct *wq = dev_to_wq(dev);
Tejun Heod55262c2013-04-01 11:23:38 -07003108 const char *delim = "";
3109 int node, written = 0;
Tejun Heo226223a2013-03-12 11:30:05 -07003110
3111 rcu_read_lock_sched();
Tejun Heod55262c2013-04-01 11:23:38 -07003112 for_each_node(node) {
3113 written += scnprintf(buf + written, PAGE_SIZE - written,
3114 "%s%d:%d", delim, node,
3115 unbound_pwq_by_node(wq, node)->pool->id);
3116 delim = " ";
3117 }
3118 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
Tejun Heo226223a2013-03-12 11:30:05 -07003119 rcu_read_unlock_sched();
3120
3121 return written;
3122}
3123
3124static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
3125 char *buf)
3126{
3127 struct workqueue_struct *wq = dev_to_wq(dev);
3128 int written;
3129
Tejun Heo6029a912013-04-01 11:23:34 -07003130 mutex_lock(&wq->mutex);
3131 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
3132 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003133
3134 return written;
3135}
3136
3137/* prepare workqueue_attrs for sysfs store operations */
3138static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
3139{
3140 struct workqueue_attrs *attrs;
3141
3142 attrs = alloc_workqueue_attrs(GFP_KERNEL);
3143 if (!attrs)
3144 return NULL;
3145
Tejun Heo6029a912013-04-01 11:23:34 -07003146 mutex_lock(&wq->mutex);
3147 copy_workqueue_attrs(attrs, wq->unbound_attrs);
3148 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003149 return attrs;
3150}
3151
3152static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
3153 const char *buf, size_t count)
3154{
3155 struct workqueue_struct *wq = dev_to_wq(dev);
3156 struct workqueue_attrs *attrs;
3157 int ret;
3158
3159 attrs = wq_sysfs_prep_attrs(wq);
3160 if (!attrs)
3161 return -ENOMEM;
3162
3163 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
Dongsheng Yang14481842014-02-11 15:34:52 +08003164 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Tejun Heo226223a2013-03-12 11:30:05 -07003165 ret = apply_workqueue_attrs(wq, attrs);
3166 else
3167 ret = -EINVAL;
3168
3169 free_workqueue_attrs(attrs);
3170 return ret ?: count;
3171}
3172
3173static ssize_t wq_cpumask_show(struct device *dev,
3174 struct device_attribute *attr, char *buf)
3175{
3176 struct workqueue_struct *wq = dev_to_wq(dev);
3177 int written;
3178
Tejun Heo6029a912013-04-01 11:23:34 -07003179 mutex_lock(&wq->mutex);
3180 written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask);
3181 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003182
3183 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3184 return written;
3185}
3186
3187static ssize_t wq_cpumask_store(struct device *dev,
3188 struct device_attribute *attr,
3189 const char *buf, size_t count)
3190{
3191 struct workqueue_struct *wq = dev_to_wq(dev);
3192 struct workqueue_attrs *attrs;
3193 int ret;
3194
3195 attrs = wq_sysfs_prep_attrs(wq);
3196 if (!attrs)
3197 return -ENOMEM;
3198
3199 ret = cpumask_parse(buf, attrs->cpumask);
3200 if (!ret)
3201 ret = apply_workqueue_attrs(wq, attrs);
3202
3203 free_workqueue_attrs(attrs);
3204 return ret ?: count;
3205}
3206
Tejun Heod55262c2013-04-01 11:23:38 -07003207static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
3208 char *buf)
3209{
3210 struct workqueue_struct *wq = dev_to_wq(dev);
3211 int written;
3212
3213 mutex_lock(&wq->mutex);
3214 written = scnprintf(buf, PAGE_SIZE, "%d\n",
3215 !wq->unbound_attrs->no_numa);
3216 mutex_unlock(&wq->mutex);
3217
3218 return written;
3219}
3220
3221static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
3222 const char *buf, size_t count)
3223{
3224 struct workqueue_struct *wq = dev_to_wq(dev);
3225 struct workqueue_attrs *attrs;
3226 int v, ret;
3227
3228 attrs = wq_sysfs_prep_attrs(wq);
3229 if (!attrs)
3230 return -ENOMEM;
3231
3232 ret = -EINVAL;
3233 if (sscanf(buf, "%d", &v) == 1) {
3234 attrs->no_numa = !v;
3235 ret = apply_workqueue_attrs(wq, attrs);
3236 }
3237
3238 free_workqueue_attrs(attrs);
3239 return ret ?: count;
3240}
3241
Tejun Heo226223a2013-03-12 11:30:05 -07003242static struct device_attribute wq_sysfs_unbound_attrs[] = {
Tejun Heod55262c2013-04-01 11:23:38 -07003243 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
Tejun Heo226223a2013-03-12 11:30:05 -07003244 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
3245 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
Tejun Heod55262c2013-04-01 11:23:38 -07003246 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
Tejun Heo226223a2013-03-12 11:30:05 -07003247 __ATTR_NULL,
3248};
3249
3250static struct bus_type wq_subsys = {
3251 .name = "workqueue",
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003252 .dev_groups = wq_sysfs_groups,
Tejun Heo226223a2013-03-12 11:30:05 -07003253};
3254
3255static int __init wq_sysfs_init(void)
3256{
3257 return subsys_virtual_register(&wq_subsys, NULL);
3258}
3259core_initcall(wq_sysfs_init);
3260
3261static void wq_device_release(struct device *dev)
3262{
3263 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3264
3265 kfree(wq_dev);
3266}
3267
3268/**
3269 * workqueue_sysfs_register - make a workqueue visible in sysfs
3270 * @wq: the workqueue to register
3271 *
3272 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
3273 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
3274 * which is the preferred method.
3275 *
3276 * Workqueue user should use this function directly iff it wants to apply
3277 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
3278 * apply_workqueue_attrs() may race against userland updating the
3279 * attributes.
3280 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003281 * Return: 0 on success, -errno on failure.
Tejun Heo226223a2013-03-12 11:30:05 -07003282 */
3283int workqueue_sysfs_register(struct workqueue_struct *wq)
3284{
3285 struct wq_device *wq_dev;
3286 int ret;
3287
3288 /*
3289 * Adjusting max_active or creating new pwqs by applyting
3290 * attributes breaks ordering guarantee. Disallow exposing ordered
3291 * workqueues.
3292 */
3293 if (WARN_ON(wq->flags & __WQ_ORDERED))
3294 return -EINVAL;
3295
3296 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
3297 if (!wq_dev)
3298 return -ENOMEM;
3299
3300 wq_dev->wq = wq;
3301 wq_dev->dev.bus = &wq_subsys;
3302 wq_dev->dev.init_name = wq->name;
3303 wq_dev->dev.release = wq_device_release;
3304
3305 /*
3306 * unbound_attrs are created separately. Suppress uevent until
3307 * everything is ready.
3308 */
3309 dev_set_uevent_suppress(&wq_dev->dev, true);
3310
3311 ret = device_register(&wq_dev->dev);
3312 if (ret) {
3313 kfree(wq_dev);
3314 wq->wq_dev = NULL;
3315 return ret;
3316 }
3317
3318 if (wq->flags & WQ_UNBOUND) {
3319 struct device_attribute *attr;
3320
3321 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
3322 ret = device_create_file(&wq_dev->dev, attr);
3323 if (ret) {
3324 device_unregister(&wq_dev->dev);
3325 wq->wq_dev = NULL;
3326 return ret;
3327 }
3328 }
3329 }
3330
3331 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
3332 return 0;
3333}
3334
3335/**
3336 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
3337 * @wq: the workqueue to unregister
3338 *
3339 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
3340 */
3341static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
3342{
3343 struct wq_device *wq_dev = wq->wq_dev;
3344
3345 if (!wq->wq_dev)
3346 return;
3347
3348 wq->wq_dev = NULL;
3349 device_unregister(&wq_dev->dev);
3350}
3351#else /* CONFIG_SYSFS */
3352static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
3353#endif /* CONFIG_SYSFS */
3354
Tejun Heo7a4e3442013-03-12 11:30:00 -07003355/**
3356 * free_workqueue_attrs - free a workqueue_attrs
3357 * @attrs: workqueue_attrs to free
3358 *
3359 * Undo alloc_workqueue_attrs().
3360 */
3361void free_workqueue_attrs(struct workqueue_attrs *attrs)
3362{
3363 if (attrs) {
3364 free_cpumask_var(attrs->cpumask);
3365 kfree(attrs);
3366 }
3367}
3368
3369/**
3370 * alloc_workqueue_attrs - allocate a workqueue_attrs
3371 * @gfp_mask: allocation mask to use
3372 *
3373 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003374 * return it.
3375 *
3376 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003377 */
3378struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3379{
3380 struct workqueue_attrs *attrs;
3381
3382 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3383 if (!attrs)
3384 goto fail;
3385 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3386 goto fail;
3387
Tejun Heo13e2e552013-04-01 11:23:31 -07003388 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003389 return attrs;
3390fail:
3391 free_workqueue_attrs(attrs);
3392 return NULL;
3393}
3394
Tejun Heo29c91e92013-03-12 11:30:03 -07003395static void copy_workqueue_attrs(struct workqueue_attrs *to,
3396 const struct workqueue_attrs *from)
3397{
3398 to->nice = from->nice;
3399 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003400 /*
3401 * Unlike hash and equality test, this function doesn't ignore
3402 * ->no_numa as it is used for both pool and wq attrs. Instead,
3403 * get_unbound_pool() explicitly clears ->no_numa after copying.
3404 */
3405 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003406}
3407
Tejun Heo29c91e92013-03-12 11:30:03 -07003408/* hash value of the content of @attr */
3409static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3410{
3411 u32 hash = 0;
3412
3413 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003414 hash = jhash(cpumask_bits(attrs->cpumask),
3415 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003416 return hash;
3417}
3418
3419/* content equality test */
3420static bool wqattrs_equal(const struct workqueue_attrs *a,
3421 const struct workqueue_attrs *b)
3422{
3423 if (a->nice != b->nice)
3424 return false;
3425 if (!cpumask_equal(a->cpumask, b->cpumask))
3426 return false;
3427 return true;
3428}
3429
Tejun Heo7a4e3442013-03-12 11:30:00 -07003430/**
3431 * init_worker_pool - initialize a newly zalloc'd worker_pool
3432 * @pool: worker_pool to initialize
3433 *
3434 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003435 *
3436 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003437 * inside @pool proper are initialized and put_unbound_pool() can be called
3438 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003439 */
3440static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003441{
3442 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003443 pool->id = -1;
3444 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003445 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003446 pool->flags |= POOL_DISASSOCIATED;
3447 INIT_LIST_HEAD(&pool->worklist);
3448 INIT_LIST_HEAD(&pool->idle_list);
3449 hash_init(pool->busy_hash);
3450
3451 init_timer_deferrable(&pool->idle_timer);
3452 pool->idle_timer.function = idle_worker_timeout;
3453 pool->idle_timer.data = (unsigned long)pool;
3454
3455 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3456 (unsigned long)pool);
3457
3458 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003459 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003460 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003461
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003462 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003463 INIT_HLIST_NODE(&pool->hash_node);
3464 pool->refcnt = 1;
3465
3466 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003467 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3468 if (!pool->attrs)
3469 return -ENOMEM;
3470 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003471}
3472
Tejun Heo29c91e92013-03-12 11:30:03 -07003473static void rcu_free_pool(struct rcu_head *rcu)
3474{
3475 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3476
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003477 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003478 free_workqueue_attrs(pool->attrs);
3479 kfree(pool);
3480}
3481
3482/**
3483 * put_unbound_pool - put a worker_pool
3484 * @pool: worker_pool to put
3485 *
3486 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003487 * safe manner. get_unbound_pool() calls this function on its failure path
3488 * and this function should be able to release pools which went through,
3489 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003490 *
3491 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003492 */
3493static void put_unbound_pool(struct worker_pool *pool)
3494{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003495 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003496 struct worker *worker;
3497
Tejun Heoa892cac2013-04-01 11:23:32 -07003498 lockdep_assert_held(&wq_pool_mutex);
3499
3500 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003501 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003502
3503 /* sanity checks */
3504 if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003505 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003506 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003507
3508 /* release id and unhash */
3509 if (pool->id >= 0)
3510 idr_remove(&worker_pool_idr, pool->id);
3511 hash_del(&pool->hash_node);
3512
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003513 /*
3514 * Become the manager and destroy all workers. Grabbing
3515 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003516 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003517 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003518 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003519
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003520 spin_lock_irq(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003521 while ((worker = first_worker(pool)))
3522 destroy_worker(worker);
3523 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003524 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003525
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003526 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003527 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003528 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003529 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003530
3531 if (pool->detach_completion)
3532 wait_for_completion(pool->detach_completion);
3533
Tejun Heo29c91e92013-03-12 11:30:03 -07003534 mutex_unlock(&pool->manager_arb);
3535
3536 /* shut down the timers */
3537 del_timer_sync(&pool->idle_timer);
3538 del_timer_sync(&pool->mayday_timer);
3539
3540 /* sched-RCU protected to allow dereferences from get_work_pool() */
3541 call_rcu_sched(&pool->rcu, rcu_free_pool);
3542}
3543
3544/**
3545 * get_unbound_pool - get a worker_pool with the specified attributes
3546 * @attrs: the attributes of the worker_pool to get
3547 *
3548 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3549 * reference count and return it. If there already is a matching
3550 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003551 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003552 *
3553 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003554 *
3555 * Return: On success, a worker_pool with the same attributes as @attrs.
3556 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003557 */
3558static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3559{
Tejun Heo29c91e92013-03-12 11:30:03 -07003560 u32 hash = wqattrs_hash(attrs);
3561 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003562 int node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003563
Tejun Heoa892cac2013-04-01 11:23:32 -07003564 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003565
3566 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003567 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3568 if (wqattrs_equal(pool->attrs, attrs)) {
3569 pool->refcnt++;
3570 goto out_unlock;
3571 }
3572 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003573
3574 /* nope, create a new one */
3575 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3576 if (!pool || init_worker_pool(pool) < 0)
3577 goto fail;
3578
Lai Jiangshan12ee4fc2013-03-20 03:28:01 +08003579 if (workqueue_freezing)
3580 pool->flags |= POOL_FREEZING;
3581
Tejun Heo8864b4e2013-03-12 11:30:04 -07003582 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003583 copy_workqueue_attrs(pool->attrs, attrs);
3584
Shaohua Li2865a8f2013-08-01 09:56:36 +08003585 /*
3586 * no_numa isn't a worker_pool attribute, always clear it. See
3587 * 'struct workqueue_attrs' comments for detail.
3588 */
3589 pool->attrs->no_numa = false;
3590
Tejun Heof3f90ad2013-04-01 11:23:34 -07003591 /* if cpumask is contained inside a NUMA node, we belong to that node */
3592 if (wq_numa_enabled) {
3593 for_each_node(node) {
3594 if (cpumask_subset(pool->attrs->cpumask,
3595 wq_numa_possible_cpumask[node])) {
3596 pool->node = node;
3597 break;
3598 }
3599 }
3600 }
3601
Tejun Heo29c91e92013-03-12 11:30:03 -07003602 if (worker_pool_assign_id(pool) < 0)
3603 goto fail;
3604
3605 /* create and start the initial worker */
Tejun Heoebf44d12013-03-13 19:47:39 -07003606 if (create_and_start_worker(pool) < 0)
Tejun Heo29c91e92013-03-12 11:30:03 -07003607 goto fail;
3608
Tejun Heo29c91e92013-03-12 11:30:03 -07003609 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003610 hash_add(unbound_pool_hash, &pool->hash_node, hash);
3611out_unlock:
Tejun Heo29c91e92013-03-12 11:30:03 -07003612 return pool;
3613fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003614 if (pool)
3615 put_unbound_pool(pool);
3616 return NULL;
3617}
3618
Tejun Heo8864b4e2013-03-12 11:30:04 -07003619static void rcu_free_pwq(struct rcu_head *rcu)
3620{
3621 kmem_cache_free(pwq_cache,
3622 container_of(rcu, struct pool_workqueue, rcu));
3623}
3624
3625/*
3626 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3627 * and needs to be destroyed.
3628 */
3629static void pwq_unbound_release_workfn(struct work_struct *work)
3630{
3631 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3632 unbound_release_work);
3633 struct workqueue_struct *wq = pwq->wq;
3634 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003635 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003636
3637 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3638 return;
3639
Tejun Heo75ccf592013-03-12 11:30:04 -07003640 /*
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003641 * Unlink @pwq. Synchronization against wq->mutex isn't strictly
Tejun Heo75ccf592013-03-12 11:30:04 -07003642 * necessary on release but do it anyway. It's easier to verify
3643 * and consistent with the linking path.
3644 */
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003645 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003646 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003647 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003648 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003649
Tejun Heoa892cac2013-04-01 11:23:32 -07003650 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003651 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003652 mutex_unlock(&wq_pool_mutex);
3653
Tejun Heo8864b4e2013-03-12 11:30:04 -07003654 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3655
3656 /*
3657 * If we're the last pwq going away, @wq is already dead and no one
3658 * is gonna access it anymore. Free it.
3659 */
Tejun Heo6029a912013-04-01 11:23:34 -07003660 if (is_last) {
3661 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003662 kfree(wq);
Tejun Heo6029a912013-04-01 11:23:34 -07003663 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003664}
3665
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003666/**
Tejun Heo699ce092013-03-13 16:51:35 -07003667 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003668 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003669 *
Tejun Heo699ce092013-03-13 16:51:35 -07003670 * If @pwq isn't freezing, set @pwq->max_active to the associated
3671 * workqueue's saved_max_active and activate delayed work items
3672 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003673 */
Tejun Heo699ce092013-03-13 16:51:35 -07003674static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003675{
Tejun Heo699ce092013-03-13 16:51:35 -07003676 struct workqueue_struct *wq = pwq->wq;
3677 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003678
Tejun Heo699ce092013-03-13 16:51:35 -07003679 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003680 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003681
3682 /* fast exit for non-freezable wqs */
3683 if (!freezable && pwq->max_active == wq->saved_max_active)
3684 return;
3685
Lai Jiangshana357fc02013-03-25 16:57:19 -07003686 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003687
3688 if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) {
3689 pwq->max_active = wq->saved_max_active;
3690
3691 while (!list_empty(&pwq->delayed_works) &&
3692 pwq->nr_active < pwq->max_active)
3693 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003694
3695 /*
3696 * Need to kick a worker after thawed or an unbound wq's
3697 * max_active is bumped. It's a slow path. Do it always.
3698 */
3699 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003700 } else {
3701 pwq->max_active = 0;
3702 }
3703
Lai Jiangshana357fc02013-03-25 16:57:19 -07003704 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003705}
3706
Tejun Heoe50aba92013-04-01 11:23:35 -07003707/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003708static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3709 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003710{
3711 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3712
Tejun Heoe50aba92013-04-01 11:23:35 -07003713 memset(pwq, 0, sizeof(*pwq));
3714
Tejun Heod2c1d402013-03-12 11:30:04 -07003715 pwq->pool = pool;
3716 pwq->wq = wq;
3717 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003718 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003719 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003720 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003721 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003722 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003723}
Tejun Heod2c1d402013-03-12 11:30:04 -07003724
Tejun Heof147f292013-04-01 11:23:35 -07003725/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003726static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003727{
3728 struct workqueue_struct *wq = pwq->wq;
3729
3730 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003731
Tejun Heo1befcf32013-04-01 11:23:35 -07003732 /* may be called multiple times, ignore if already linked */
3733 if (!list_empty(&pwq->pwqs_node))
3734 return;
3735
Tejun Heo983ca252013-03-13 16:51:35 -07003736 /*
3737 * Set the matching work_color. This is synchronized with
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003738 * wq->mutex to avoid confusing flush_workqueue().
Tejun Heo983ca252013-03-13 16:51:35 -07003739 */
Tejun Heo75ccf592013-03-12 11:30:04 -07003740 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003741
3742 /* sync max_active to the current setting */
3743 pwq_adjust_max_active(pwq);
3744
3745 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003746 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003747}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003748
Tejun Heof147f292013-04-01 11:23:35 -07003749/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3750static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3751 const struct workqueue_attrs *attrs)
3752{
3753 struct worker_pool *pool;
3754 struct pool_workqueue *pwq;
3755
3756 lockdep_assert_held(&wq_pool_mutex);
3757
3758 pool = get_unbound_pool(attrs);
3759 if (!pool)
3760 return NULL;
3761
Tejun Heoe50aba92013-04-01 11:23:35 -07003762 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003763 if (!pwq) {
3764 put_unbound_pool(pool);
3765 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003766 }
Tejun Heo6029a912013-04-01 11:23:34 -07003767
Tejun Heof147f292013-04-01 11:23:35 -07003768 init_pwq(pwq, wq, pool);
3769 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003770}
3771
Tejun Heo4c16bd32013-04-01 11:23:36 -07003772/* undo alloc_unbound_pwq(), used only in the error path */
3773static void free_unbound_pwq(struct pool_workqueue *pwq)
3774{
3775 lockdep_assert_held(&wq_pool_mutex);
3776
3777 if (pwq) {
3778 put_unbound_pool(pwq->pool);
Wei Yongjuncece95d2013-04-09 14:29:11 +08003779 kmem_cache_free(pwq_cache, pwq);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003780 }
3781}
3782
3783/**
3784 * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node
3785 * @attrs: the wq_attrs of interest
3786 * @node: the target NUMA node
3787 * @cpu_going_down: if >= 0, the CPU to consider as offline
3788 * @cpumask: outarg, the resulting cpumask
3789 *
3790 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3791 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003792 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003793 *
3794 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3795 * enabled and @node has online CPUs requested by @attrs, the returned
3796 * cpumask is the intersection of the possible CPUs of @node and
3797 * @attrs->cpumask.
3798 *
3799 * The caller is responsible for ensuring that the cpumask of @node stays
3800 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003801 *
3802 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3803 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003804 */
3805static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3806 int cpu_going_down, cpumask_t *cpumask)
3807{
Tejun Heod55262c2013-04-01 11:23:38 -07003808 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003809 goto use_dfl;
3810
3811 /* does @node have any online CPUs @attrs wants? */
3812 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3813 if (cpu_going_down >= 0)
3814 cpumask_clear_cpu(cpu_going_down, cpumask);
3815
3816 if (cpumask_empty(cpumask))
3817 goto use_dfl;
3818
3819 /* yeap, return possible CPUs in @node that @attrs wants */
3820 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3821 return !cpumask_equal(cpumask, attrs->cpumask);
3822
3823use_dfl:
3824 cpumask_copy(cpumask, attrs->cpumask);
3825 return false;
3826}
3827
Tejun Heo1befcf32013-04-01 11:23:35 -07003828/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3829static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3830 int node,
3831 struct pool_workqueue *pwq)
3832{
3833 struct pool_workqueue *old_pwq;
3834
3835 lockdep_assert_held(&wq->mutex);
3836
3837 /* link_pwq() can handle duplicate calls */
3838 link_pwq(pwq);
3839
3840 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3841 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3842 return old_pwq;
3843}
3844
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003845/**
3846 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3847 * @wq: the target workqueue
3848 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3849 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003850 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3851 * machines, this function maps a separate pwq to each NUMA node with
3852 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3853 * NUMA node it was issued on. Older pwqs are released as in-flight work
3854 * items finish. Note that a work item which repeatedly requeues itself
3855 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003856 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003857 * Performs GFP_KERNEL allocations.
3858 *
3859 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003860 */
3861int apply_workqueue_attrs(struct workqueue_struct *wq,
3862 const struct workqueue_attrs *attrs)
3863{
Tejun Heo4c16bd32013-04-01 11:23:36 -07003864 struct workqueue_attrs *new_attrs, *tmp_attrs;
3865 struct pool_workqueue **pwq_tbl, *dfl_pwq;
Tejun Heof147f292013-04-01 11:23:35 -07003866 int node, ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003867
Tejun Heo8719dce2013-03-12 11:30:04 -07003868 /* only unbound workqueues can change attributes */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003869 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3870 return -EINVAL;
3871
Tejun Heo8719dce2013-03-12 11:30:04 -07003872 /* creating multiple pwqs breaks ordering guarantee */
3873 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3874 return -EINVAL;
3875
Tejun Heo4c16bd32013-04-01 11:23:36 -07003876 pwq_tbl = kzalloc(wq_numa_tbl_len * sizeof(pwq_tbl[0]), GFP_KERNEL);
Tejun Heo13e2e552013-04-01 11:23:31 -07003877 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003878 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3879 if (!pwq_tbl || !new_attrs || !tmp_attrs)
Tejun Heo13e2e552013-04-01 11:23:31 -07003880 goto enomem;
3881
Tejun Heo4c16bd32013-04-01 11:23:36 -07003882 /* make a copy of @attrs and sanitize it */
Tejun Heo13e2e552013-04-01 11:23:31 -07003883 copy_workqueue_attrs(new_attrs, attrs);
3884 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
3885
Tejun Heo4c16bd32013-04-01 11:23:36 -07003886 /*
3887 * We may create multiple pwqs with differing cpumasks. Make a
3888 * copy of @new_attrs which will be modified and used to obtain
3889 * pools.
3890 */
3891 copy_workqueue_attrs(tmp_attrs, new_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003892
Tejun Heo4c16bd32013-04-01 11:23:36 -07003893 /*
3894 * CPUs should stay stable across pwq creations and installations.
3895 * Pin CPUs, determine the target cpumask for each node and create
3896 * pwqs accordingly.
3897 */
3898 get_online_cpus();
3899
3900 mutex_lock(&wq_pool_mutex);
3901
3902 /*
3903 * If something goes wrong during CPU up/down, we'll fall back to
3904 * the default pwq covering whole @attrs->cpumask. Always create
3905 * it even if we don't use it immediately.
3906 */
3907 dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3908 if (!dfl_pwq)
3909 goto enomem_pwq;
3910
3911 for_each_node(node) {
3912 if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) {
3913 pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3914 if (!pwq_tbl[node])
3915 goto enomem_pwq;
3916 } else {
3917 dfl_pwq->refcnt++;
3918 pwq_tbl[node] = dfl_pwq;
3919 }
3920 }
3921
3922 mutex_unlock(&wq_pool_mutex);
3923
3924 /* all pwqs have been created successfully, let's install'em */
Tejun Heof147f292013-04-01 11:23:35 -07003925 mutex_lock(&wq->mutex);
3926
Tejun Heof147f292013-04-01 11:23:35 -07003927 copy_workqueue_attrs(wq->unbound_attrs, new_attrs);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003928
3929 /* save the previous pwq and install the new one */
Tejun Heof147f292013-04-01 11:23:35 -07003930 for_each_node(node)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003931 pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]);
3932
3933 /* @dfl_pwq might not have been used, ensure it's linked */
3934 link_pwq(dfl_pwq);
3935 swap(wq->dfl_pwq, dfl_pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003936
3937 mutex_unlock(&wq->mutex);
3938
Tejun Heo4c16bd32013-04-01 11:23:36 -07003939 /* put the old pwqs */
3940 for_each_node(node)
3941 put_pwq_unlocked(pwq_tbl[node]);
3942 put_pwq_unlocked(dfl_pwq);
3943
3944 put_online_cpus();
Tejun Heo48621252013-04-01 11:23:31 -07003945 ret = 0;
3946 /* fall through */
3947out_free:
Tejun Heo4c16bd32013-04-01 11:23:36 -07003948 free_workqueue_attrs(tmp_attrs);
Tejun Heo48621252013-04-01 11:23:31 -07003949 free_workqueue_attrs(new_attrs);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003950 kfree(pwq_tbl);
Tejun Heo48621252013-04-01 11:23:31 -07003951 return ret;
Tejun Heo13e2e552013-04-01 11:23:31 -07003952
Tejun Heo4c16bd32013-04-01 11:23:36 -07003953enomem_pwq:
3954 free_unbound_pwq(dfl_pwq);
3955 for_each_node(node)
3956 if (pwq_tbl && pwq_tbl[node] != dfl_pwq)
3957 free_unbound_pwq(pwq_tbl[node]);
3958 mutex_unlock(&wq_pool_mutex);
3959 put_online_cpus();
Tejun Heo13e2e552013-04-01 11:23:31 -07003960enomem:
Tejun Heo48621252013-04-01 11:23:31 -07003961 ret = -ENOMEM;
3962 goto out_free;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003963}
3964
Tejun Heo4c16bd32013-04-01 11:23:36 -07003965/**
3966 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3967 * @wq: the target workqueue
3968 * @cpu: the CPU coming up or going down
3969 * @online: whether @cpu is coming up or going down
3970 *
3971 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3972 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3973 * @wq accordingly.
3974 *
3975 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3976 * falls back to @wq->dfl_pwq which may not be optimal but is always
3977 * correct.
3978 *
3979 * Note that when the last allowed CPU of a NUMA node goes offline for a
3980 * workqueue with a cpumask spanning multiple nodes, the workers which were
3981 * already executing the work items for the workqueue will lose their CPU
3982 * affinity and may execute on any CPU. This is similar to how per-cpu
3983 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3984 * affinity, it's the user's responsibility to flush the work item from
3985 * CPU_DOWN_PREPARE.
3986 */
3987static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3988 bool online)
3989{
3990 int node = cpu_to_node(cpu);
3991 int cpu_off = online ? -1 : cpu;
3992 struct pool_workqueue *old_pwq = NULL, *pwq;
3993 struct workqueue_attrs *target_attrs;
3994 cpumask_t *cpumask;
3995
3996 lockdep_assert_held(&wq_pool_mutex);
3997
3998 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
3999 return;
4000
4001 /*
4002 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4003 * Let's use a preallocated one. The following buf is protected by
4004 * CPU hotplug exclusion.
4005 */
4006 target_attrs = wq_update_unbound_numa_attrs_buf;
4007 cpumask = target_attrs->cpumask;
4008
4009 mutex_lock(&wq->mutex);
Tejun Heod55262c2013-04-01 11:23:38 -07004010 if (wq->unbound_attrs->no_numa)
4011 goto out_unlock;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004012
4013 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4014 pwq = unbound_pwq_by_node(wq, node);
4015
4016 /*
4017 * Let's determine what needs to be done. If the target cpumask is
4018 * different from wq's, we need to compare it to @pwq's and create
4019 * a new one if they don't match. If the target cpumask equals
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004020 * wq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004021 */
4022 if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) {
4023 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
4024 goto out_unlock;
4025 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004026 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004027 }
4028
4029 mutex_unlock(&wq->mutex);
4030
4031 /* create a new pwq */
4032 pwq = alloc_unbound_pwq(wq, target_attrs);
4033 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004034 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4035 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004036 mutex_lock(&wq->mutex);
4037 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004038 }
4039
4040 /*
4041 * Install the new pwq. As this function is called only from CPU
4042 * hotplug callbacks and applying a new attrs is wrapped with
4043 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
4044 * inbetween.
4045 */
4046 mutex_lock(&wq->mutex);
4047 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4048 goto out_unlock;
4049
4050use_dfl_pwq:
4051 spin_lock_irq(&wq->dfl_pwq->pool->lock);
4052 get_pwq(wq->dfl_pwq);
4053 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4054 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4055out_unlock:
4056 mutex_unlock(&wq->mutex);
4057 put_pwq_unlocked(old_pwq);
4058}
4059
Tejun Heo30cdf242013-03-12 11:29:57 -07004060static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004061{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004062 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004063 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004064
Tejun Heo30cdf242013-03-12 11:29:57 -07004065 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004066 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4067 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07004068 return -ENOMEM;
4069
4070 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004071 struct pool_workqueue *pwq =
4072 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004073 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004074 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07004075
Tejun Heof147f292013-04-01 11:23:35 -07004076 init_pwq(pwq, wq, &cpu_pools[highpri]);
4077
4078 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004079 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004080 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07004081 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004082 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004083 } else if (wq->flags & __WQ_ORDERED) {
4084 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4085 /* there should only be single pwq for ordering guarantee */
4086 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4087 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4088 "ordering guarantee broken for workqueue %s\n", wq->name);
4089 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07004090 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004091 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07004092 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004093}
4094
Tejun Heof3421792010-07-02 10:03:51 +02004095static int wq_clamp_max_active(int max_active, unsigned int flags,
4096 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004097{
Tejun Heof3421792010-07-02 10:03:51 +02004098 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4099
4100 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004101 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4102 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004103
Tejun Heof3421792010-07-02 10:03:51 +02004104 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004105}
4106
Tejun Heob196be82012-01-10 15:11:35 -08004107struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02004108 unsigned int flags,
4109 int max_active,
4110 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08004111 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004112{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004113 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004114 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004115 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004116 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004117
Viresh Kumarcee22a12013-04-08 16:45:40 +05304118 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4119 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4120 flags |= WQ_UNBOUND;
4121
Tejun Heoecf68812013-04-01 11:23:34 -07004122 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004123 if (flags & WQ_UNBOUND)
4124 tbl_size = wq_numa_tbl_len * sizeof(wq->numa_pwq_tbl[0]);
4125
4126 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004127 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004128 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004129
Tejun Heo6029a912013-04-01 11:23:34 -07004130 if (flags & WQ_UNBOUND) {
4131 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4132 if (!wq->unbound_attrs)
4133 goto err_free_wq;
4134 }
4135
Tejun Heoecf68812013-04-01 11:23:34 -07004136 va_start(args, lock_name);
4137 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004138 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004139
Tejun Heod320c032010-06-29 10:07:14 +02004140 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004141 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004142
Tejun Heob196be82012-01-10 15:11:35 -08004143 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004144 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004145 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004146 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004147 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07004148 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004149 INIT_LIST_HEAD(&wq->flusher_queue);
4150 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004151 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004152
Johannes Bergeb13ba82008-01-16 09:51:58 +01004153 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004154 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004155
Tejun Heo30cdf242013-03-12 11:29:57 -07004156 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004157 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004158
Tejun Heo493008a2013-03-12 11:30:03 -07004159 /*
4160 * Workqueues which may be used during memory reclaim should
4161 * have a rescuer to guarantee forward progress.
4162 */
4163 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004164 struct worker *rescuer;
4165
Tejun Heod2c1d402013-03-12 11:30:04 -07004166 rescuer = alloc_worker();
Tejun Heoe22bee72010-06-29 10:07:14 +02004167 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004168 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004169
Tejun Heo111c2252013-01-17 17:16:24 -08004170 rescuer->rescue_wq = wq;
4171 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004172 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004173 if (IS_ERR(rescuer->task)) {
4174 kfree(rescuer);
4175 goto err_destroy;
4176 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004177
Tejun Heod2c1d402013-03-12 11:30:04 -07004178 wq->rescuer = rescuer;
Tejun Heo14a40ff2013-03-19 13:45:20 -07004179 rescuer->task->flags |= PF_NO_SETAFFINITY;
Tejun Heoe22bee72010-06-29 10:07:14 +02004180 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004181 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004182
Tejun Heo226223a2013-03-12 11:30:05 -07004183 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4184 goto err_destroy;
4185
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004186 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004187 * wq_pool_mutex protects global freeze state and workqueues list.
4188 * Grab it, adjust max_active and add the new @wq to workqueues
4189 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004190 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004191 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004192
Lai Jiangshana357fc02013-03-25 16:57:19 -07004193 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004194 for_each_pwq(pwq, wq)
4195 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004196 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004197
Tejun Heo15376632010-06-29 10:07:11 +02004198 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004199
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004200 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004201
Oleg Nesterov3af244332007-05-09 02:34:09 -07004202 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004203
4204err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004205 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004206 kfree(wq);
4207 return NULL;
4208err_destroy:
4209 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004210 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004211}
Tejun Heod320c032010-06-29 10:07:14 +02004212EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004213
4214/**
4215 * destroy_workqueue - safely terminate a workqueue
4216 * @wq: target workqueue
4217 *
4218 * Safely destroy a workqueue. All work currently pending will be done first.
4219 */
4220void destroy_workqueue(struct workqueue_struct *wq)
4221{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004222 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004223 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004224
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004225 /* drain it before proceeding with destruction */
4226 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004227
Tejun Heo6183c002013-03-12 11:29:57 -07004228 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004229 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004230 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004231 int i;
4232
Tejun Heo76af4d92013-03-12 11:30:00 -07004233 for (i = 0; i < WORK_NR_COLORS; i++) {
4234 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004235 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004236 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004237 }
4238 }
4239
Lai Jiangshan5c529592013-04-04 10:05:38 +08004240 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004241 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004242 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004243 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004244 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004245 }
Tejun Heo6183c002013-03-12 11:29:57 -07004246 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004247 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004248
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004249 /*
4250 * wq list is used to freeze wq, remove from list after
4251 * flushing is complete in case freeze races us.
4252 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004253 mutex_lock(&wq_pool_mutex);
Tejun Heod2c1d402013-03-12 11:30:04 -07004254 list_del_init(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004255 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004256
Tejun Heo226223a2013-03-12 11:30:05 -07004257 workqueue_sysfs_unregister(wq);
4258
Tejun Heo493008a2013-03-12 11:30:03 -07004259 if (wq->rescuer) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004260 kthread_stop(wq->rescuer->task);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02004261 kfree(wq->rescuer);
Tejun Heo493008a2013-03-12 11:30:03 -07004262 wq->rescuer = NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +02004263 }
4264
Tejun Heo8864b4e2013-03-12 11:30:04 -07004265 if (!(wq->flags & WQ_UNBOUND)) {
4266 /*
4267 * The base ref is never dropped on per-cpu pwqs. Directly
4268 * free the pwqs and wq.
4269 */
4270 free_percpu(wq->cpu_pwqs);
4271 kfree(wq);
4272 } else {
4273 /*
4274 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004275 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4276 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004277 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004278 for_each_node(node) {
4279 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4280 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4281 put_pwq_unlocked(pwq);
4282 }
4283
4284 /*
4285 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4286 * put. Don't access it afterwards.
4287 */
4288 pwq = wq->dfl_pwq;
4289 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004290 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004291 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004292}
4293EXPORT_SYMBOL_GPL(destroy_workqueue);
4294
Tejun Heodcd989c2010-06-29 10:07:14 +02004295/**
4296 * workqueue_set_max_active - adjust max_active of a workqueue
4297 * @wq: target workqueue
4298 * @max_active: new max_active value.
4299 *
4300 * Set max_active of @wq to @max_active.
4301 *
4302 * CONTEXT:
4303 * Don't call from IRQ context.
4304 */
4305void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4306{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004307 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004308
Tejun Heo8719dce2013-03-12 11:30:04 -07004309 /* disallow meddling with max_active for ordered workqueues */
4310 if (WARN_ON(wq->flags & __WQ_ORDERED))
4311 return;
4312
Tejun Heof3421792010-07-02 10:03:51 +02004313 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004314
Lai Jiangshana357fc02013-03-25 16:57:19 -07004315 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004316
4317 wq->saved_max_active = max_active;
4318
Tejun Heo699ce092013-03-13 16:51:35 -07004319 for_each_pwq(pwq, wq)
4320 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004321
Lai Jiangshana357fc02013-03-25 16:57:19 -07004322 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004323}
4324EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4325
4326/**
Tejun Heoe6267612013-03-12 17:41:37 -07004327 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4328 *
4329 * Determine whether %current is a workqueue rescuer. Can be used from
4330 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004331 *
4332 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe6267612013-03-12 17:41:37 -07004333 */
4334bool current_is_workqueue_rescuer(void)
4335{
4336 struct worker *worker = current_wq_worker();
4337
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004338 return worker && worker->rescue_wq;
Tejun Heoe6267612013-03-12 17:41:37 -07004339}
4340
4341/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004342 * workqueue_congested - test whether a workqueue is congested
4343 * @cpu: CPU in question
4344 * @wq: target workqueue
4345 *
4346 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4347 * no synchronization around this function and the test result is
4348 * unreliable and only useful as advisory hints or for debugging.
4349 *
Tejun Heod3251852013-05-10 11:10:17 -07004350 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4351 * Note that both per-cpu and unbound workqueues may be associated with
4352 * multiple pool_workqueues which have separate congested states. A
4353 * workqueue being congested on one CPU doesn't mean the workqueue is also
4354 * contested on other CPUs / NUMA nodes.
4355 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004356 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004357 * %true if congested, %false otherwise.
4358 */
Tejun Heod84ff052013-03-12 11:29:59 -07004359bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004360{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004361 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004362 bool ret;
4363
Lai Jiangshan88109452013-03-20 03:28:10 +08004364 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004365
Tejun Heod3251852013-05-10 11:10:17 -07004366 if (cpu == WORK_CPU_UNBOUND)
4367 cpu = smp_processor_id();
4368
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004369 if (!(wq->flags & WQ_UNBOUND))
4370 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4371 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004372 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004373
Tejun Heo76af4d92013-03-12 11:30:00 -07004374 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004375 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004376
4377 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004378}
4379EXPORT_SYMBOL_GPL(workqueue_congested);
4380
4381/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004382 * work_busy - test whether a work is currently pending or running
4383 * @work: the work to be tested
4384 *
4385 * Test whether @work is currently pending or running. There is no
4386 * synchronization around this function and the test result is
4387 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004388 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004389 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004390 * OR'd bitmask of WORK_BUSY_* bits.
4391 */
4392unsigned int work_busy(struct work_struct *work)
4393{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004394 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004395 unsigned long flags;
4396 unsigned int ret = 0;
4397
Tejun Heodcd989c2010-06-29 10:07:14 +02004398 if (work_pending(work))
4399 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004400
Tejun Heofa1b54e2013-03-12 11:30:00 -07004401 local_irq_save(flags);
4402 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004403 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004404 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004405 if (find_worker_executing_work(pool, work))
4406 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004407 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004408 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004409 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004410
4411 return ret;
4412}
4413EXPORT_SYMBOL_GPL(work_busy);
4414
Tejun Heo3d1cb202013-04-30 15:27:22 -07004415/**
4416 * set_worker_desc - set description for the current work item
4417 * @fmt: printf-style format string
4418 * @...: arguments for the format string
4419 *
4420 * This function can be called by a running work function to describe what
4421 * the work item is about. If the worker task gets dumped, this
4422 * information will be printed out together to help debugging. The
4423 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4424 */
4425void set_worker_desc(const char *fmt, ...)
4426{
4427 struct worker *worker = current_wq_worker();
4428 va_list args;
4429
4430 if (worker) {
4431 va_start(args, fmt);
4432 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4433 va_end(args);
4434 worker->desc_valid = true;
4435 }
4436}
4437
4438/**
4439 * print_worker_info - print out worker information and description
4440 * @log_lvl: the log level to use when printing
4441 * @task: target task
4442 *
4443 * If @task is a worker and currently executing a work item, print out the
4444 * name of the workqueue being serviced and worker description set with
4445 * set_worker_desc() by the currently executing work item.
4446 *
4447 * This function can be safely called on any task as long as the
4448 * task_struct itself is accessible. While safe, this function isn't
4449 * synchronized and may print out mixups or garbages of limited length.
4450 */
4451void print_worker_info(const char *log_lvl, struct task_struct *task)
4452{
4453 work_func_t *fn = NULL;
4454 char name[WQ_NAME_LEN] = { };
4455 char desc[WORKER_DESC_LEN] = { };
4456 struct pool_workqueue *pwq = NULL;
4457 struct workqueue_struct *wq = NULL;
4458 bool desc_valid = false;
4459 struct worker *worker;
4460
4461 if (!(task->flags & PF_WQ_WORKER))
4462 return;
4463
4464 /*
4465 * This function is called without any synchronization and @task
4466 * could be in any state. Be careful with dereferences.
4467 */
4468 worker = probe_kthread_data(task);
4469
4470 /*
4471 * Carefully copy the associated workqueue's workfn and name. Keep
4472 * the original last '\0' in case the original contains garbage.
4473 */
4474 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4475 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4476 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4477 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4478
4479 /* copy worker description */
4480 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4481 if (desc_valid)
4482 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4483
4484 if (fn || name[0] || desc[0]) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004485 pr_info("%sWorkqueue: %s %pf", log_lvl, name, fn);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004486 if (desc[0])
4487 pr_cont(" (%s)", desc);
4488 pr_cont("\n");
4489 }
4490}
4491
Tejun Heodb7bccf2010-06-29 10:07:12 +02004492/*
4493 * CPU hotplug.
4494 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004495 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004496 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004497 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004498 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004499 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004500 * blocked draining impractical.
4501 *
Tejun Heo24647572013-01-24 11:01:33 -08004502 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004503 * running as an unbound one and allowing it to be reattached later if the
4504 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004505 */
4506
Tejun Heo706026c2013-01-24 11:01:34 -08004507static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004508{
Tejun Heo38db41d2013-01-24 11:01:34 -08004509 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004510 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004511 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004512
Tejun Heof02ae732013-03-12 11:30:03 -07004513 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo6183c002013-03-12 11:29:57 -07004514 WARN_ON_ONCE(cpu != smp_processor_id());
Tejun Heo94cf58b2013-01-24 11:01:33 -08004515
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004516 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004517 spin_lock_irq(&pool->lock);
4518
4519 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004520 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004521 * unbound and set DISASSOCIATED. Before this, all workers
4522 * except for the ones which are still executing works from
4523 * before the last CPU down must be on the cpu. After
4524 * this, they may become diasporas.
4525 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004526 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004527 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004528
Tejun Heo24647572013-01-24 11:01:33 -08004529 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004530
Tejun Heo94cf58b2013-01-24 11:01:33 -08004531 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004532 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004533
Lai Jiangshaneb283422013-03-08 15:18:28 -08004534 /*
4535 * Call schedule() so that we cross rq->lock and thus can
4536 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4537 * This is necessary as scheduler callbacks may be invoked
4538 * from other cpus.
4539 */
4540 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004541
Lai Jiangshaneb283422013-03-08 15:18:28 -08004542 /*
4543 * Sched callbacks are disabled now. Zap nr_running.
4544 * After this, nr_running stays zero and need_more_worker()
4545 * and keep_working() are always true as long as the
4546 * worklist is not empty. This pool now behaves as an
4547 * unbound (in terms of concurrency management) pool which
4548 * are served by workers tied to the pool.
4549 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004550 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004551
4552 /*
4553 * With concurrency management just turned off, a busy
4554 * worker blocking could lead to lengthy stalls. Kick off
4555 * unbound chain execution of currently pending work items.
4556 */
4557 spin_lock_irq(&pool->lock);
4558 wake_up_worker(pool);
4559 spin_unlock_irq(&pool->lock);
4560 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004561}
4562
Tejun Heobd7c0892013-03-19 13:45:21 -07004563/**
4564 * rebind_workers - rebind all workers of a pool to the associated CPU
4565 * @pool: pool of interest
4566 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004567 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004568 */
4569static void rebind_workers(struct worker_pool *pool)
4570{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004571 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004572
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004573 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004574
Tejun Heoa9ab7752013-03-19 13:45:21 -07004575 /*
4576 * Restore CPU affinity of all workers. As all idle workers should
4577 * be on the run-queue of the associated CPU before any local
4578 * wake-ups for concurrency management happen, restore CPU affinty
4579 * of all workers first and then clear UNBOUND. As we're called
4580 * from CPU_ONLINE, the following shouldn't fail.
4581 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004582 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004583 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4584 pool->attrs->cpumask) < 0);
4585
4586 spin_lock_irq(&pool->lock);
4587
Lai Jiangshanda028462014-05-20 17:46:31 +08004588 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004589 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004590
4591 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004592 * A bound idle worker should actually be on the runqueue
4593 * of the associated CPU for local wake-ups targeting it to
4594 * work. Kick all idle workers so that they migrate to the
4595 * associated CPU. Doing this in the same loop as
4596 * replacing UNBOUND with REBOUND is safe as no worker will
4597 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004598 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004599 if (worker_flags & WORKER_IDLE)
4600 wake_up_process(worker->task);
4601
4602 /*
4603 * We want to clear UNBOUND but can't directly call
4604 * worker_clr_flags() or adjust nr_running. Atomically
4605 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4606 * @worker will clear REBOUND using worker_clr_flags() when
4607 * it initiates the next execution cycle thus restoring
4608 * concurrency management. Note that when or whether
4609 * @worker clears REBOUND doesn't affect correctness.
4610 *
4611 * ACCESS_ONCE() is necessary because @worker->flags may be
4612 * tested without holding any lock in
4613 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4614 * fail incorrectly leading to premature concurrency
4615 * management operations.
4616 */
4617 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4618 worker_flags |= WORKER_REBOUND;
4619 worker_flags &= ~WORKER_UNBOUND;
4620 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004621 }
4622
Tejun Heoa9ab7752013-03-19 13:45:21 -07004623 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004624}
4625
Tejun Heo7dbc7252013-03-19 13:45:21 -07004626/**
4627 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4628 * @pool: unbound pool of interest
4629 * @cpu: the CPU which is coming up
4630 *
4631 * An unbound pool may end up with a cpumask which doesn't have any online
4632 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4633 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4634 * online CPU before, cpus_allowed of all its workers should be restored.
4635 */
4636static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4637{
4638 static cpumask_t cpumask;
4639 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004640
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004641 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004642
4643 /* is @cpu allowed for @pool? */
4644 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4645 return;
4646
4647 /* is @cpu the only online CPU? */
4648 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4649 if (cpumask_weight(&cpumask) != 1)
4650 return;
4651
4652 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004653 for_each_pool_worker(worker, pool)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004654 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4655 pool->attrs->cpumask) < 0);
4656}
4657
Tejun Heo8db25e72012-07-17 12:39:28 -07004658/*
4659 * Workqueues should be brought up before normal priority CPU notifiers.
4660 * This will be registered high priority CPU notifier.
4661 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004662static int workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004663 unsigned long action,
4664 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004665{
Tejun Heod84ff052013-03-12 11:29:59 -07004666 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004667 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004668 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004669 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004670
Tejun Heo8db25e72012-07-17 12:39:28 -07004671 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004672 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004673 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004674 if (pool->nr_workers)
4675 continue;
Tejun Heoebf44d12013-03-13 19:47:39 -07004676 if (create_and_start_worker(pool) < 0)
Tejun Heo3ce63372012-07-17 12:39:27 -07004677 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004678 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004679 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004680
Tejun Heo65758202012-07-17 12:39:26 -07004681 case CPU_DOWN_FAILED:
4682 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004683 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004684
4685 for_each_pool(pool, pi) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004686 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004687
Tejun Heo7dbc7252013-03-19 13:45:21 -07004688 if (pool->cpu == cpu) {
4689 spin_lock_irq(&pool->lock);
4690 pool->flags &= ~POOL_DISASSOCIATED;
4691 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07004692
Tejun Heo7dbc7252013-03-19 13:45:21 -07004693 rebind_workers(pool);
4694 } else if (pool->cpu < 0) {
4695 restore_unbound_workers_cpumask(pool, cpu);
4696 }
Tejun Heo94cf58b2013-01-24 11:01:33 -08004697
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004698 mutex_unlock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004699 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004700
Tejun Heo4c16bd32013-04-01 11:23:36 -07004701 /* update NUMA affinity of unbound workqueues */
4702 list_for_each_entry(wq, &workqueues, list)
4703 wq_update_unbound_numa(wq, cpu, true);
4704
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004705 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004706 break;
Tejun Heo65758202012-07-17 12:39:26 -07004707 }
4708 return NOTIFY_OK;
4709}
4710
4711/*
4712 * Workqueues should be brought down after normal priority CPU notifiers.
4713 * This will be registered as low priority CPU notifier.
4714 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004715static int workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004716 unsigned long action,
4717 void *hcpu)
4718{
Tejun Heod84ff052013-03-12 11:29:59 -07004719 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004720 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004721 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004722
Tejun Heo65758202012-07-17 12:39:26 -07004723 switch (action & ~CPU_TASKS_FROZEN) {
4724 case CPU_DOWN_PREPARE:
Tejun Heo4c16bd32013-04-01 11:23:36 -07004725 /* unbinding per-cpu workers should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004726 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004727 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004728
4729 /* update NUMA affinity of unbound workqueues */
4730 mutex_lock(&wq_pool_mutex);
4731 list_for_each_entry(wq, &workqueues, list)
4732 wq_update_unbound_numa(wq, cpu, false);
4733 mutex_unlock(&wq_pool_mutex);
4734
4735 /* wait for per-cpu unbinding to finish */
Tejun Heo8db25e72012-07-17 12:39:28 -07004736 flush_work(&unbind_work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004737 destroy_work_on_stack(&unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004738 break;
Tejun Heo65758202012-07-17 12:39:26 -07004739 }
4740 return NOTIFY_OK;
4741}
4742
Rusty Russell2d3854a2008-11-05 13:39:10 +11004743#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004744
Rusty Russell2d3854a2008-11-05 13:39:10 +11004745struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004746 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004747 long (*fn)(void *);
4748 void *arg;
4749 long ret;
4750};
4751
Tejun Heoed48ece2012-09-18 12:48:43 -07004752static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004753{
Tejun Heoed48ece2012-09-18 12:48:43 -07004754 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4755
Rusty Russell2d3854a2008-11-05 13:39:10 +11004756 wfc->ret = wfc->fn(wfc->arg);
4757}
4758
4759/**
4760 * work_on_cpu - run a function in user context on a particular cpu
4761 * @cpu: the cpu to run on
4762 * @fn: the function to run
4763 * @arg: the function arg
4764 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004765 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06004766 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004767 *
4768 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004769 */
Tejun Heod84ff052013-03-12 11:29:59 -07004770long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004771{
Tejun Heoed48ece2012-09-18 12:48:43 -07004772 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004773
Tejun Heoed48ece2012-09-18 12:48:43 -07004774 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4775 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004776 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004777 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004778 return wfc.ret;
4779}
4780EXPORT_SYMBOL_GPL(work_on_cpu);
4781#endif /* CONFIG_SMP */
4782
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004783#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304784
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004785/**
4786 * freeze_workqueues_begin - begin freezing workqueues
4787 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004788 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004789 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004790 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004791 *
4792 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004793 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004794 */
4795void freeze_workqueues_begin(void)
4796{
Tejun Heo17116962013-03-12 11:29:58 -07004797 struct worker_pool *pool;
Tejun Heo24b8a842013-03-12 11:29:58 -07004798 struct workqueue_struct *wq;
4799 struct pool_workqueue *pwq;
Tejun Heo611c92a2013-03-13 16:51:36 -07004800 int pi;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004801
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004802 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004803
Tejun Heo6183c002013-03-12 11:29:57 -07004804 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004805 workqueue_freezing = true;
4806
Tejun Heo24b8a842013-03-12 11:29:58 -07004807 /* set FREEZING */
Tejun Heo611c92a2013-03-13 16:51:36 -07004808 for_each_pool(pool, pi) {
Tejun Heo5bcab332013-03-13 19:47:40 -07004809 spin_lock_irq(&pool->lock);
Tejun Heo17116962013-03-12 11:29:58 -07004810 WARN_ON_ONCE(pool->flags & POOL_FREEZING);
4811 pool->flags |= POOL_FREEZING;
Tejun Heo5bcab332013-03-13 19:47:40 -07004812 spin_unlock_irq(&pool->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004813 }
4814
Tejun Heo24b8a842013-03-12 11:29:58 -07004815 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004816 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004817 for_each_pwq(pwq, wq)
4818 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004819 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004820 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004821
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004822 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004823}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004824
4825/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004826 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004827 *
4828 * Check whether freezing is complete. This function must be called
4829 * between freeze_workqueues_begin() and thaw_workqueues().
4830 *
4831 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004832 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004833 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004834 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004835 * %true if some freezable workqueues are still busy. %false if freezing
4836 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004837 */
4838bool freeze_workqueues_busy(void)
4839{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004840 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004841 struct workqueue_struct *wq;
4842 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004843
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004844 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004845
Tejun Heo6183c002013-03-12 11:29:57 -07004846 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004847
Tejun Heo24b8a842013-03-12 11:29:58 -07004848 list_for_each_entry(wq, &workqueues, list) {
4849 if (!(wq->flags & WQ_FREEZABLE))
4850 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004851 /*
4852 * nr_active is monotonically decreasing. It's safe
4853 * to peek without lock.
4854 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004855 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004856 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004857 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004858 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004859 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004860 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004861 goto out_unlock;
4862 }
4863 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004864 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004865 }
4866out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004867 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004868 return busy;
4869}
4870
4871/**
4872 * thaw_workqueues - thaw workqueues
4873 *
4874 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004875 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004876 *
4877 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004878 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004879 */
4880void thaw_workqueues(void)
4881{
Tejun Heo24b8a842013-03-12 11:29:58 -07004882 struct workqueue_struct *wq;
4883 struct pool_workqueue *pwq;
4884 struct worker_pool *pool;
Tejun Heo611c92a2013-03-13 16:51:36 -07004885 int pi;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004886
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004887 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004888
4889 if (!workqueue_freezing)
4890 goto out_unlock;
4891
Tejun Heo24b8a842013-03-12 11:29:58 -07004892 /* clear FREEZING */
Tejun Heo611c92a2013-03-13 16:51:36 -07004893 for_each_pool(pool, pi) {
Tejun Heo5bcab332013-03-13 19:47:40 -07004894 spin_lock_irq(&pool->lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004895 WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
4896 pool->flags &= ~POOL_FREEZING;
Tejun Heo5bcab332013-03-13 19:47:40 -07004897 spin_unlock_irq(&pool->lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004898 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02004899
Tejun Heo24b8a842013-03-12 11:29:58 -07004900 /* restore max_active and repopulate worklist */
4901 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004902 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004903 for_each_pwq(pwq, wq)
4904 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004905 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004906 }
4907
4908 workqueue_freezing = false;
4909out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004910 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004911}
4912#endif /* CONFIG_FREEZER */
4913
Tejun Heobce90382013-04-01 11:23:32 -07004914static void __init wq_numa_init(void)
4915{
4916 cpumask_var_t *tbl;
4917 int node, cpu;
4918
4919 /* determine NUMA pwq table len - highest node id + 1 */
4920 for_each_node(node)
4921 wq_numa_tbl_len = max(wq_numa_tbl_len, node + 1);
4922
4923 if (num_possible_nodes() <= 1)
4924 return;
4925
Tejun Heod55262c2013-04-01 11:23:38 -07004926 if (wq_disable_numa) {
4927 pr_info("workqueue: NUMA affinity support disabled\n");
4928 return;
4929 }
4930
Tejun Heo4c16bd32013-04-01 11:23:36 -07004931 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
4932 BUG_ON(!wq_update_unbound_numa_attrs_buf);
4933
Tejun Heobce90382013-04-01 11:23:32 -07004934 /*
4935 * We want masks of possible CPUs of each node which isn't readily
4936 * available. Build one from cpu_to_node() which should have been
4937 * fully initialized by now.
4938 */
4939 tbl = kzalloc(wq_numa_tbl_len * sizeof(tbl[0]), GFP_KERNEL);
4940 BUG_ON(!tbl);
4941
4942 for_each_node(node)
Tejun Heo1be0c252013-05-15 14:24:24 -07004943 BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
4944 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07004945
4946 for_each_possible_cpu(cpu) {
4947 node = cpu_to_node(cpu);
4948 if (WARN_ON(node == NUMA_NO_NODE)) {
4949 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
4950 /* happens iff arch is bonkers, let's just proceed */
4951 return;
4952 }
4953 cpumask_set_cpu(cpu, tbl[node]);
4954 }
4955
4956 wq_numa_possible_cpumask = tbl;
4957 wq_numa_enabled = true;
4958}
4959
Suresh Siddha6ee05782010-07-30 14:57:37 -07004960static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004961{
Tejun Heo7a4e3442013-03-12 11:30:00 -07004962 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
4963 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02004964
Tejun Heoe904e6c2013-03-12 11:29:57 -07004965 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
4966
4967 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
4968
Tejun Heo65758202012-07-17 12:39:26 -07004969 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07004970 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02004971
Tejun Heobce90382013-04-01 11:23:32 -07004972 wq_numa_init();
4973
Tejun Heo706026c2013-01-24 11:01:34 -08004974 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07004975 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07004976 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004977
Tejun Heo7a4e3442013-03-12 11:30:00 -07004978 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07004979 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07004980 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08004981 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07004982 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07004983 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07004984 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07004985
Tejun Heo9daf9e62013-01-24 11:01:33 -08004986 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004987 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08004988 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004989 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07004990 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02004991 }
4992
Tejun Heoe22bee72010-06-29 10:07:14 +02004993 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07004994 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07004995 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02004996
Tejun Heof02ae732013-03-12 11:30:03 -07004997 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07004998 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoebf44d12013-03-13 19:47:39 -07004999 BUG_ON(create_and_start_worker(pool) < 0);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005000 }
Tejun Heoe22bee72010-06-29 10:07:14 +02005001 }
5002
Tejun Heo8a2b7532013-09-05 12:30:04 -04005003 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005004 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5005 struct workqueue_attrs *attrs;
5006
5007 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005008 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005009 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005010
5011 /*
5012 * An ordered wq should have only one pwq as ordering is
5013 * guaranteed by max_active which is enforced by pwqs.
5014 * Turn off NUMA so that dfl_pwq is used for all nodes.
5015 */
5016 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5017 attrs->nice = std_nice[i];
5018 attrs->no_numa = true;
5019 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005020 }
5021
Tejun Heod320c032010-06-29 10:07:14 +02005022 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005023 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005024 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005025 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5026 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005027 system_freezable_wq = alloc_workqueue("events_freezable",
5028 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305029 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5030 WQ_POWER_EFFICIENT, 0);
5031 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5032 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5033 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005034 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305035 !system_unbound_wq || !system_freezable_wq ||
5036 !system_power_efficient_wq ||
5037 !system_freezable_power_efficient_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07005038 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005039}
Suresh Siddha6ee05782010-07-30 14:57:37 -07005040early_initcall(init_workqueues);