blob: 092f2098746dcb1967b7075b4d6ca11c994c0fd1 [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
68 * manager_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 Jiangshan9625ab12014-05-20 17:46:27 +0800125 * M: pool->manager_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 */
Tejun Heobc3a1af2013-03-13 19:47:39 -0700163 struct mutex manager_mutex; /* manager exclusion */
Lai Jiangshanda028462014-05-20 17:46:31 +0800164 struct list_head workers; /* M: 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 Jiangshan9625ab12014-05-20 17:46:27 +0800370 * This must be called with @pool->manager_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 Jiangshan9625ab12014-05-20 17:46:27 +0800377 if (({ lockdep_assert_held(&pool->manager_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
1699 mutex_lock(&pool->manager_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;
1703 mutex_unlock(&pool->manager_mutex);
1704
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
Tejun Heocd549682013-03-13 19:47:39 -07001728 lockdep_assert_held(&pool->manager_mutex);
1729
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001730 /* ID is needed to determine kthread name */
1731 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001732 if (id < 0)
1733 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001734
1735 worker = alloc_worker();
1736 if (!worker)
1737 goto fail;
1738
Tejun Heobd7bdd42012-07-12 14:46:37 -07001739 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001740 worker->id = id;
1741
Tejun Heo29c91e92013-03-12 11:30:03 -07001742 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001743 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1744 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001745 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001746 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1747
Tejun Heof3f90ad2013-04-01 11:23:34 -07001748 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001749 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001750 if (IS_ERR(worker->task))
1751 goto fail;
1752
Oleg Nesterov91151222013-11-14 12:56:18 +01001753 set_user_nice(worker->task, pool->attrs->nice);
1754
1755 /* prevent userland from meddling with cpumask of workqueue workers */
1756 worker->task->flags |= PF_NO_SETAFFINITY;
1757
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 /*
1765 * The caller is responsible for ensuring %POOL_DISASSOCIATED
1766 * 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
Tejun Heoc34056a2010-06-29 10:07:11 +02001775 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001776
Tejun Heoc34056a2010-06-29 10:07:11 +02001777fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001778 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001779 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001780 kfree(worker);
1781 return NULL;
1782}
1783
1784/**
1785 * start_worker - start a newly created worker
1786 * @worker: worker to start
1787 *
Tejun Heo706026c2013-01-24 11:01:34 -08001788 * Make the pool aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001789 *
1790 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001791 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001792 */
1793static void start_worker(struct worker *worker)
1794{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001795 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001796 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001797 wake_up_process(worker->task);
1798}
1799
1800/**
Tejun Heoebf44d12013-03-13 19:47:39 -07001801 * create_and_start_worker - create and start a worker for a pool
1802 * @pool: the target pool
1803 *
Tejun Heocd549682013-03-13 19:47:39 -07001804 * Grab the managership of @pool and create and start a new worker for it.
Yacine Belkadid185af32013-07-31 14:59:24 -07001805 *
1806 * Return: 0 on success. A negative error code otherwise.
Tejun Heoebf44d12013-03-13 19:47:39 -07001807 */
1808static int create_and_start_worker(struct worker_pool *pool)
1809{
1810 struct worker *worker;
1811
Tejun Heocd549682013-03-13 19:47:39 -07001812 mutex_lock(&pool->manager_mutex);
1813
Tejun Heoebf44d12013-03-13 19:47:39 -07001814 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
Tejun Heocd549682013-03-13 19:47:39 -07001821 mutex_unlock(&pool->manager_mutex);
1822
Tejun Heoebf44d12013-03-13 19:47:39 -07001823 return worker ? 0 : -ENOMEM;
1824}
1825
1826/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001827 * destroy_worker - destroy a workqueue worker
1828 * @worker: worker to be destroyed
1829 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001830 * Destroy @worker and adjust @pool stats accordingly. The worker should
1831 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001832 *
1833 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001834 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001835 */
1836static void destroy_worker(struct worker *worker)
1837{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001838 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001839
Tejun Heocd549682013-03-13 19:47:39 -07001840 lockdep_assert_held(&pool->lock);
1841
Tejun Heoc34056a2010-06-29 10:07:11 +02001842 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001843 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001844 WARN_ON(!list_empty(&worker->scheduled)) ||
1845 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001846 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001847
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001848 pool->nr_workers--;
1849 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001850
1851 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001852 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001853 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001854}
1855
Tejun Heo63d95a92012-07-12 14:46:37 -07001856static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001857{
Tejun Heo63d95a92012-07-12 14:46:37 -07001858 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001859
Tejun Heod565ed62013-01-24 11:01:33 -08001860 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001861
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001862 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001863 struct worker *worker;
1864 unsigned long expires;
1865
1866 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001867 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001868 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1869
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001870 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001871 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001872 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001873 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001874
1875 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001876 }
1877
Tejun Heod565ed62013-01-24 11:01:33 -08001878 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001879}
1880
Tejun Heo493a1722013-03-12 11:29:59 -07001881static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001882{
Tejun Heo112202d2013-02-13 19:29:12 -08001883 struct pool_workqueue *pwq = get_work_pwq(work);
1884 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001885
Tejun Heo2e109a22013-03-13 19:47:40 -07001886 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001887
Tejun Heo493008a2013-03-12 11:30:03 -07001888 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001889 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001890
1891 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001892 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001893 /*
1894 * If @pwq is for an unbound wq, its base ref may be put at
1895 * any time due to an attribute change. Pin @pwq until the
1896 * rescuer is done with it.
1897 */
1898 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001899 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001900 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001901 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001902}
1903
Tejun Heo706026c2013-01-24 11:01:34 -08001904static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001905{
Tejun Heo63d95a92012-07-12 14:46:37 -07001906 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001907 struct work_struct *work;
1908
Tejun Heo2e109a22013-03-13 19:47:40 -07001909 spin_lock_irq(&wq_mayday_lock); /* for wq->maydays */
Tejun Heo493a1722013-03-12 11:29:59 -07001910 spin_lock(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001911
Tejun Heo63d95a92012-07-12 14:46:37 -07001912 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001913 /*
1914 * We've been trying to create a new worker but
1915 * haven't been successful. We might be hitting an
1916 * allocation deadlock. Send distress signals to
1917 * rescuers.
1918 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001919 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001920 send_mayday(work);
1921 }
1922
Tejun Heo493a1722013-03-12 11:29:59 -07001923 spin_unlock(&pool->lock);
Tejun Heo2e109a22013-03-13 19:47:40 -07001924 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001925
Tejun Heo63d95a92012-07-12 14:46:37 -07001926 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001927}
1928
1929/**
1930 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001931 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001932 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001933 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001934 * have at least one idle worker on return from this function. If
1935 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001936 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001937 * possible allocation deadlock.
1938 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001939 * On return, need_to_create_worker() is guaranteed to be %false and
1940 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001941 *
1942 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001943 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001944 * multiple times. Does GFP_KERNEL allocations. Called only from
1945 * manager.
1946 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001947 * Return:
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001948 * %false if no action was taken and pool->lock stayed locked, %true
Tejun Heoe22bee72010-06-29 10:07:14 +02001949 * otherwise.
1950 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001951static bool maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001952__releases(&pool->lock)
1953__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001954{
Tejun Heo63d95a92012-07-12 14:46:37 -07001955 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001956 return false;
1957restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001958 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001959
Tejun Heoe22bee72010-06-29 10:07:14 +02001960 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001961 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001962
1963 while (true) {
1964 struct worker *worker;
1965
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001966 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001967 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001968 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001969 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001970 start_worker(worker);
Tejun Heo6183c002013-03-12 11:29:57 -07001971 if (WARN_ON_ONCE(need_to_create_worker(pool)))
1972 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001973 return true;
1974 }
1975
Tejun Heo63d95a92012-07-12 14:46:37 -07001976 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001977 break;
1978
Tejun Heoe22bee72010-06-29 10:07:14 +02001979 __set_current_state(TASK_INTERRUPTIBLE);
1980 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001981
Tejun Heo63d95a92012-07-12 14:46:37 -07001982 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001983 break;
1984 }
1985
Tejun Heo63d95a92012-07-12 14:46:37 -07001986 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001987 spin_lock_irq(&pool->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07001988 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001989 goto restart;
1990 return true;
1991}
1992
1993/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001994 * manage_workers - manage worker pool
1995 * @worker: self
1996 *
Tejun Heo706026c2013-01-24 11:01:34 -08001997 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001998 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001999 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002000 *
2001 * The caller can safely start processing works on false return. On
2002 * true return, it's guaranteed that need_to_create_worker() is false
2003 * and may_start_working() is true.
2004 *
2005 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002006 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002007 * multiple times. Does GFP_KERNEL allocations.
2008 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002009 * Return:
Libin2d498db2013-08-21 08:50:40 +08002010 * %false if the pool don't need management and the caller can safely start
2011 * processing works, %true indicates that the function released pool->lock
2012 * and reacquired it to perform some management function and that the
2013 * conditions that the caller verified while holding the lock before
2014 * calling the function might no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002015 */
2016static bool manage_workers(struct worker *worker)
2017{
Tejun Heo63d95a92012-07-12 14:46:37 -07002018 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002019 bool ret = false;
2020
Tejun Heobc3a1af2013-03-13 19:47:39 -07002021 /*
2022 * Managership is governed by two mutexes - manager_arb and
2023 * manager_mutex. manager_arb handles arbitration of manager role.
2024 * Anyone who successfully grabs manager_arb wins the arbitration
2025 * and becomes the manager. mutex_trylock() on pool->manager_arb
2026 * failure while holding pool->lock reliably indicates that someone
2027 * else is managing the pool and the worker which failed trylock
2028 * can proceed to executing work items. This means that anyone
2029 * grabbing manager_arb is responsible for actually performing
2030 * manager duties. If manager_arb is grabbed and released without
2031 * actual management, the pool may stall indefinitely.
2032 *
2033 * manager_mutex is used for exclusion of actual management
2034 * operations. The holder of manager_mutex can be sure that none
2035 * of management operations, including creation and destruction of
2036 * workers, won't take place until the mutex is released. Because
2037 * manager_mutex doesn't interfere with manager role arbitration,
2038 * it is guaranteed that the pool's management, while may be
2039 * delayed, won't be disturbed by someone else grabbing
2040 * manager_mutex.
2041 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07002042 if (!mutex_trylock(&pool->manager_arb))
Tejun Heoe22bee72010-06-29 10:07:14 +02002043 return ret;
2044
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002045 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07002046 * With manager arbitration won, manager_mutex would be free in
2047 * most cases. trylock first without dropping @pool->lock.
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002048 */
Tejun Heobc3a1af2013-03-13 19:47:39 -07002049 if (unlikely(!mutex_trylock(&pool->manager_mutex))) {
Tejun Heod565ed62013-01-24 11:01:33 -08002050 spin_unlock_irq(&pool->lock);
Tejun Heobc3a1af2013-03-13 19:47:39 -07002051 mutex_lock(&pool->manager_mutex);
Joonsoo Kim8f174b12013-05-01 00:07:00 +09002052 spin_lock_irq(&pool->lock);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002053 ret = true;
2054 }
2055
Tejun Heo63d95a92012-07-12 14:46:37 -07002056 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002057
Tejun Heobc3a1af2013-03-13 19:47:39 -07002058 mutex_unlock(&pool->manager_mutex);
Tejun Heo34a06bd2013-03-12 11:30:00 -07002059 mutex_unlock(&pool->manager_arb);
Tejun Heoe22bee72010-06-29 10:07:14 +02002060 return ret;
2061}
2062
Tejun Heoa62428c2010-06-29 10:07:10 +02002063/**
2064 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002065 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002066 * @work: work to process
2067 *
2068 * Process @work. This function contains all the logics necessary to
2069 * process a single work including synchronization against and
2070 * interaction with other workers on the same cpu, queueing and
2071 * flushing. As long as context requirement is met, any worker can
2072 * call this function to process a work.
2073 *
2074 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002075 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002076 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002077static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002078__releases(&pool->lock)
2079__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002080{
Tejun Heo112202d2013-02-13 19:29:12 -08002081 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002082 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002083 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002084 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002085 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002086#ifdef CONFIG_LOCKDEP
2087 /*
2088 * It is permissible to free the struct work_struct from
2089 * inside the function that is called from it, this we need to
2090 * take into account for lockdep too. To avoid bogus "held
2091 * lock freed" warnings as well as problems when looking into
2092 * work->lockdep_map, make a copy and use that here.
2093 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002094 struct lockdep_map lockdep_map;
2095
2096 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002097#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002098 /*
2099 * Ensure we're on the correct CPU. DISASSOCIATED test is
2100 * necessary to avoid spurious warnings from rescuers servicing the
Tejun Heo24647572013-01-24 11:01:33 -08002101 * unbound or a disassociated pool.
Tejun Heo6fec10a2012-07-22 10:16:34 -07002102 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002103 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo24647572013-01-24 11:01:33 -08002104 !(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002105 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002106
Tejun Heo7e116292010-06-29 10:07:13 +02002107 /*
2108 * A single work shouldn't be executed concurrently by
2109 * multiple workers on a single cpu. Check whether anyone is
2110 * already processing the work. If so, defer the work to the
2111 * currently executing one.
2112 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002113 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002114 if (unlikely(collision)) {
2115 move_linked_works(work, &collision->scheduled, NULL);
2116 return;
2117 }
2118
Tejun Heo8930cab2012-08-03 10:30:45 -07002119 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002120 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002121 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002122 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002123 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002124 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002125 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002126
Tejun Heoa62428c2010-06-29 10:07:10 +02002127 list_del_init(&work->entry);
2128
Tejun Heo649027d2010-06-29 10:07:14 +02002129 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002130 * CPU intensive works don't participate in concurrency
2131 * management. They're the scheduler's responsibility.
2132 */
2133 if (unlikely(cpu_intensive))
2134 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2135
Tejun Heo974271c2012-07-12 14:46:37 -07002136 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002137 * Unbound pool isn't concurrency managed and work items should be
Tejun Heo974271c2012-07-12 14:46:37 -07002138 * executed ASAP. Wake up another worker if necessary.
2139 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002140 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2141 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002142
Tejun Heo8930cab2012-08-03 10:30:45 -07002143 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002144 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002145 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002146 * PENDING and queued state changes happen together while IRQ is
2147 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002148 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002149 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002150
Tejun Heod565ed62013-01-24 11:01:33 -08002151 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002152
Tejun Heo112202d2013-02-13 19:29:12 -08002153 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002154 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002155 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002156 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002157 /*
2158 * While we must be careful to not use "work" after this, the trace
2159 * point will only record its address.
2160 */
2161 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002162 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002163 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002164
2165 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002166 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2167 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002168 current->comm, preempt_count(), task_pid_nr(current),
2169 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002170 debug_show_held_locks(current);
2171 dump_stack();
2172 }
2173
Tejun Heob22ce272013-08-28 17:33:37 -04002174 /*
2175 * The following prevents a kworker from hogging CPU on !PREEMPT
2176 * kernels, where a requeueing work item waiting for something to
2177 * happen could deadlock with stop_machine as such work item could
2178 * indefinitely requeue itself while all other CPUs are trapped in
2179 * stop_machine.
2180 */
2181 cond_resched();
2182
Tejun Heod565ed62013-01-24 11:01:33 -08002183 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002184
Tejun Heofb0e7be2010-06-29 10:07:15 +02002185 /* clear cpu intensive status */
2186 if (unlikely(cpu_intensive))
2187 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2188
Tejun Heoa62428c2010-06-29 10:07:10 +02002189 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002190 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002191 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002192 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002193 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002194 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002195 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002196}
2197
Tejun Heoaffee4b2010-06-29 10:07:12 +02002198/**
2199 * process_scheduled_works - process scheduled works
2200 * @worker: self
2201 *
2202 * Process all scheduled works. Please note that the scheduled list
2203 * may change while processing a work, so this function repeatedly
2204 * fetches a work from the top and executes it.
2205 *
2206 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002207 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002208 * multiple times.
2209 */
2210static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002212 while (!list_empty(&worker->scheduled)) {
2213 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002215 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217}
2218
Tejun Heo4690c4a2010-06-29 10:07:10 +02002219/**
2220 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002221 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002222 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002223 * The worker thread function. All workers belong to a worker_pool -
2224 * either a per-cpu one or dynamic unbound one. These workers process all
2225 * work items regardless of their specific target workqueue. The only
2226 * exception is work items which belong to workqueues with a rescuer which
2227 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002228 *
2229 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002230 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002231static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232{
Tejun Heoc34056a2010-06-29 10:07:11 +02002233 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002234 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235
Tejun Heoe22bee72010-06-29 10:07:14 +02002236 /* tell the scheduler that this is a workqueue worker */
2237 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002238woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002239 spin_lock_irq(&pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240
Tejun Heoa9ab7752013-03-19 13:45:21 -07002241 /* am I supposed to die? */
2242 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002243 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002244 WARN_ON_ONCE(!list_empty(&worker->entry));
2245 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002246
2247 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002248 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002249 worker_detach_from_pool(worker, pool);
2250 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002251 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252 }
2253
Tejun Heoc8e55f32010-06-29 10:07:12 +02002254 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002255recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002256 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002257 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002258 goto sleep;
2259
2260 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002261 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002262 goto recheck;
2263
Tejun Heoc8e55f32010-06-29 10:07:12 +02002264 /*
2265 * ->scheduled list can only be filled while a worker is
2266 * preparing to process a work or actually processing it.
2267 * Make sure nobody diddled with it while I was sleeping.
2268 */
Tejun Heo6183c002013-03-12 11:29:57 -07002269 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002270
Tejun Heoe22bee72010-06-29 10:07:14 +02002271 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002272 * Finish PREP stage. We're guaranteed to have at least one idle
2273 * worker or that someone else has already assumed the manager
2274 * role. This is where @worker starts participating in concurrency
2275 * management if applicable and concurrency management is restored
2276 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002277 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002278 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002279
2280 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002281 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002282 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002283 struct work_struct, entry);
2284
2285 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2286 /* optimization path, not strictly necessary */
2287 process_one_work(worker, work);
2288 if (unlikely(!list_empty(&worker->scheduled)))
2289 process_scheduled_works(worker);
2290 } else {
2291 move_linked_works(work, &worker->scheduled, NULL);
2292 process_scheduled_works(worker);
2293 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002294 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002295
Tejun Heoe22bee72010-06-29 10:07:14 +02002296 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002297sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002298 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002299 * pool->lock is held and there's no work to process and no need to
2300 * manage, sleep. Workers are woken up only while holding
2301 * pool->lock or from local cpu, so setting the current state
2302 * before releasing pool->lock is enough to prevent losing any
2303 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002304 */
2305 worker_enter_idle(worker);
2306 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002307 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002308 schedule();
2309 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310}
2311
Tejun Heoe22bee72010-06-29 10:07:14 +02002312/**
2313 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002314 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002315 *
2316 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002317 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002318 *
Tejun Heo706026c2013-01-24 11:01:34 -08002319 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002320 * worker which uses GFP_KERNEL allocation which has slight chance of
2321 * developing into deadlock if some works currently on the same queue
2322 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2323 * the problem rescuer solves.
2324 *
Tejun Heo706026c2013-01-24 11:01:34 -08002325 * When such condition is possible, the pool summons rescuers of all
2326 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002327 * those works so that forward progress can be guaranteed.
2328 *
2329 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002330 *
2331 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002332 */
Tejun Heo111c2252013-01-17 17:16:24 -08002333static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002334{
Tejun Heo111c2252013-01-17 17:16:24 -08002335 struct worker *rescuer = __rescuer;
2336 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002337 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002338 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002339
2340 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002341
2342 /*
2343 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2344 * doesn't participate in concurrency management.
2345 */
2346 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002347repeat:
2348 set_current_state(TASK_INTERRUPTIBLE);
2349
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002350 /*
2351 * By the time the rescuer is requested to stop, the workqueue
2352 * shouldn't have any work pending, but @wq->maydays may still have
2353 * pwq(s) queued. This can happen by non-rescuer workers consuming
2354 * all the work items before the rescuer got to them. Go through
2355 * @wq->maydays processing before acting on should_stop so that the
2356 * list is always empty on exit.
2357 */
2358 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002359
Tejun Heo493a1722013-03-12 11:29:59 -07002360 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002361 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002362
2363 while (!list_empty(&wq->maydays)) {
2364 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2365 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002366 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002367 struct work_struct *work, *n;
2368
2369 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002370 list_del_init(&pwq->mayday_node);
2371
Tejun Heo2e109a22013-03-13 19:47:40 -07002372 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002373
2374 /* migrate to the target cpu if possible */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08002375 worker_maybe_bind_and_lock(pool);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002376 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002377
2378 /*
2379 * Slurp in all works issued via this workqueue and
2380 * process'em.
2381 */
Tejun Heo6183c002013-03-12 11:29:57 -07002382 WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002383 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002384 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002385 move_linked_works(work, scheduled, &n);
2386
2387 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002388
2389 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002390 * Put the reference grabbed by send_mayday(). @pool won't
2391 * go away while we're holding its lock.
2392 */
2393 put_pwq(pwq);
2394
2395 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002396 * Leave this pool. If keep_working() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002397 * regular worker; otherwise, we end up with 0 concurrency
2398 * and stalling the execution.
2399 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002400 if (keep_working(pool))
2401 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002402
Lai Jiangshanb3104102013-02-19 12:17:02 -08002403 rescuer->pool = NULL;
Tejun Heo493a1722013-03-12 11:29:59 -07002404 spin_unlock(&pool->lock);
Tejun Heo2e109a22013-03-13 19:47:40 -07002405 spin_lock(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002406 }
2407
Tejun Heo2e109a22013-03-13 19:47:40 -07002408 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002409
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002410 if (should_stop) {
2411 __set_current_state(TASK_RUNNING);
2412 rescuer->task->flags &= ~PF_WQ_WORKER;
2413 return 0;
2414 }
2415
Tejun Heo111c2252013-01-17 17:16:24 -08002416 /* rescuers should never participate in concurrency management */
2417 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002418 schedule();
2419 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420}
2421
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002422struct wq_barrier {
2423 struct work_struct work;
2424 struct completion done;
2425};
2426
2427static void wq_barrier_func(struct work_struct *work)
2428{
2429 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2430 complete(&barr->done);
2431}
2432
Tejun Heo4690c4a2010-06-29 10:07:10 +02002433/**
2434 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002435 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002436 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002437 * @target: target work to attach @barr to
2438 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002439 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002440 * @barr is linked to @target such that @barr is completed only after
2441 * @target finishes execution. Please note that the ordering
2442 * guarantee is observed only with respect to @target and on the local
2443 * cpu.
2444 *
2445 * Currently, a queued barrier can't be canceled. This is because
2446 * try_to_grab_pending() can't determine whether the work to be
2447 * grabbed is at the head of the queue and thus can't clear LINKED
2448 * flag of the previous work while there must be a valid next work
2449 * after a work with LINKED flag set.
2450 *
2451 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002452 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002453 *
2454 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002455 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002456 */
Tejun Heo112202d2013-02-13 19:29:12 -08002457static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002458 struct wq_barrier *barr,
2459 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002460{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002461 struct list_head *head;
2462 unsigned int linked = 0;
2463
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002464 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002465 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002466 * as we know for sure that this will not trigger any of the
2467 * checks and call back into the fixup functions where we
2468 * might deadlock.
2469 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002470 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002471 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002472 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002473
Tejun Heoaffee4b2010-06-29 10:07:12 +02002474 /*
2475 * If @target is currently being executed, schedule the
2476 * barrier to the worker; otherwise, put it after @target.
2477 */
2478 if (worker)
2479 head = worker->scheduled.next;
2480 else {
2481 unsigned long *bits = work_data_bits(target);
2482
2483 head = target->entry.next;
2484 /* there can already be other linked works, inherit and set */
2485 linked = *bits & WORK_STRUCT_LINKED;
2486 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2487 }
2488
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002489 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002490 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002491 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002492}
2493
Tejun Heo73f53c42010-06-29 10:07:11 +02002494/**
Tejun Heo112202d2013-02-13 19:29:12 -08002495 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002496 * @wq: workqueue being flushed
2497 * @flush_color: new flush color, < 0 for no-op
2498 * @work_color: new work color, < 0 for no-op
2499 *
Tejun Heo112202d2013-02-13 19:29:12 -08002500 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002501 *
Tejun Heo112202d2013-02-13 19:29:12 -08002502 * If @flush_color is non-negative, flush_color on all pwqs should be
2503 * -1. If no pwq has in-flight commands at the specified color, all
2504 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2505 * has in flight commands, its pwq->flush_color is set to
2506 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002507 * wakeup logic is armed and %true is returned.
2508 *
2509 * The caller should have initialized @wq->first_flusher prior to
2510 * calling this function with non-negative @flush_color. If
2511 * @flush_color is negative, no flush color update is done and %false
2512 * is returned.
2513 *
Tejun Heo112202d2013-02-13 19:29:12 -08002514 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002515 * work_color which is previous to @work_color and all will be
2516 * advanced to @work_color.
2517 *
2518 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002519 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002520 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002521 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002522 * %true if @flush_color >= 0 and there's something to flush. %false
2523 * otherwise.
2524 */
Tejun Heo112202d2013-02-13 19:29:12 -08002525static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002526 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527{
Tejun Heo73f53c42010-06-29 10:07:11 +02002528 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002529 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002530
Tejun Heo73f53c42010-06-29 10:07:11 +02002531 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002532 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002533 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002534 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002535
Tejun Heo49e3cf42013-03-12 11:29:58 -07002536 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002537 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002538
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002539 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002540
2541 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002542 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002543
Tejun Heo112202d2013-02-13 19:29:12 -08002544 if (pwq->nr_in_flight[flush_color]) {
2545 pwq->flush_color = flush_color;
2546 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002547 wait = true;
2548 }
2549 }
2550
2551 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002552 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002553 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002554 }
2555
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002556 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002557 }
2558
Tejun Heo112202d2013-02-13 19:29:12 -08002559 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002560 complete(&wq->first_flusher->done);
2561
2562 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563}
2564
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002565/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002567 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002569 * This function sleeps until all work items which were queued on entry
2570 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002572void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573{
Tejun Heo73f53c42010-06-29 10:07:11 +02002574 struct wq_flusher this_flusher = {
2575 .list = LIST_HEAD_INIT(this_flusher.list),
2576 .flush_color = -1,
2577 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2578 };
2579 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002580
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002581 lock_map_acquire(&wq->lockdep_map);
2582 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002583
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002584 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002585
2586 /*
2587 * Start-to-wait phase
2588 */
2589 next_color = work_next_color(wq->work_color);
2590
2591 if (next_color != wq->flush_color) {
2592 /*
2593 * Color space is not full. The current work_color
2594 * becomes our flush_color and work_color is advanced
2595 * by one.
2596 */
Tejun Heo6183c002013-03-12 11:29:57 -07002597 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002598 this_flusher.flush_color = wq->work_color;
2599 wq->work_color = next_color;
2600
2601 if (!wq->first_flusher) {
2602 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002603 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002604
2605 wq->first_flusher = &this_flusher;
2606
Tejun Heo112202d2013-02-13 19:29:12 -08002607 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002608 wq->work_color)) {
2609 /* nothing to flush, done */
2610 wq->flush_color = next_color;
2611 wq->first_flusher = NULL;
2612 goto out_unlock;
2613 }
2614 } else {
2615 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002616 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002617 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002618 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002619 }
2620 } else {
2621 /*
2622 * Oops, color space is full, wait on overflow queue.
2623 * The next flush completion will assign us
2624 * flush_color and transfer to flusher_queue.
2625 */
2626 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2627 }
2628
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002629 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002630
2631 wait_for_completion(&this_flusher.done);
2632
2633 /*
2634 * Wake-up-and-cascade phase
2635 *
2636 * First flushers are responsible for cascading flushes and
2637 * handling overflow. Non-first flushers can simply return.
2638 */
2639 if (wq->first_flusher != &this_flusher)
2640 return;
2641
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002642 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002643
Tejun Heo4ce48b32010-07-02 10:03:51 +02002644 /* we might have raced, check again with mutex held */
2645 if (wq->first_flusher != &this_flusher)
2646 goto out_unlock;
2647
Tejun Heo73f53c42010-06-29 10:07:11 +02002648 wq->first_flusher = NULL;
2649
Tejun Heo6183c002013-03-12 11:29:57 -07002650 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2651 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002652
2653 while (true) {
2654 struct wq_flusher *next, *tmp;
2655
2656 /* complete all the flushers sharing the current flush color */
2657 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2658 if (next->flush_color != wq->flush_color)
2659 break;
2660 list_del_init(&next->list);
2661 complete(&next->done);
2662 }
2663
Tejun Heo6183c002013-03-12 11:29:57 -07002664 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2665 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002666
2667 /* this flush_color is finished, advance by one */
2668 wq->flush_color = work_next_color(wq->flush_color);
2669
2670 /* one color has been freed, handle overflow queue */
2671 if (!list_empty(&wq->flusher_overflow)) {
2672 /*
2673 * Assign the same color to all overflowed
2674 * flushers, advance work_color and append to
2675 * flusher_queue. This is the start-to-wait
2676 * phase for these overflowed flushers.
2677 */
2678 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2679 tmp->flush_color = wq->work_color;
2680
2681 wq->work_color = work_next_color(wq->work_color);
2682
2683 list_splice_tail_init(&wq->flusher_overflow,
2684 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002685 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002686 }
2687
2688 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002689 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002690 break;
2691 }
2692
2693 /*
2694 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002695 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002696 */
Tejun Heo6183c002013-03-12 11:29:57 -07002697 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2698 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002699
2700 list_del_init(&next->list);
2701 wq->first_flusher = next;
2702
Tejun Heo112202d2013-02-13 19:29:12 -08002703 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002704 break;
2705
2706 /*
2707 * Meh... this color is already done, clear first
2708 * flusher and repeat cascading.
2709 */
2710 wq->first_flusher = NULL;
2711 }
2712
2713out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002714 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715}
Dave Jonesae90dd52006-06-30 01:40:45 -04002716EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002718/**
2719 * drain_workqueue - drain a workqueue
2720 * @wq: workqueue to drain
2721 *
2722 * Wait until the workqueue becomes empty. While draining is in progress,
2723 * only chain queueing is allowed. IOW, only currently pending or running
2724 * work items on @wq can queue further work items on it. @wq is flushed
2725 * repeatedly until it becomes empty. The number of flushing is detemined
2726 * by the depth of chaining and should be relatively short. Whine if it
2727 * takes too long.
2728 */
2729void drain_workqueue(struct workqueue_struct *wq)
2730{
2731 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002732 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002733
2734 /*
2735 * __queue_work() needs to test whether there are drainers, is much
2736 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002737 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002738 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002739 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002740 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002741 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002742 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002743reflush:
2744 flush_workqueue(wq);
2745
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002746 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002747
Tejun Heo49e3cf42013-03-12 11:29:58 -07002748 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002749 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002750
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002751 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002752 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002753 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002754
2755 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002756 continue;
2757
2758 if (++flush_cnt == 10 ||
2759 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002760 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002761 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002762
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002763 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002764 goto reflush;
2765 }
2766
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002767 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002768 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002769 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002770}
2771EXPORT_SYMBOL_GPL(drain_workqueue);
2772
Tejun Heo606a5022012-08-20 14:51:23 -07002773static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002774{
2775 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002776 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002777 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002778
2779 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002780
Tejun Heofa1b54e2013-03-12 11:30:00 -07002781 local_irq_disable();
2782 pool = get_work_pool(work);
2783 if (!pool) {
2784 local_irq_enable();
2785 return false;
2786 }
2787
2788 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002789 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002790 pwq = get_work_pwq(work);
2791 if (pwq) {
2792 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002793 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002794 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002795 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002796 if (!worker)
2797 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002798 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002799 }
Tejun Heobaf59022010-09-16 10:42:16 +02002800
Tejun Heo112202d2013-02-13 19:29:12 -08002801 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002802 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002803
Tejun Heoe1594892011-01-09 23:32:15 +01002804 /*
2805 * If @max_active is 1 or rescuer is in use, flushing another work
2806 * item on the same workqueue may lead to deadlock. Make sure the
2807 * flusher is not running on the same workqueue by verifying write
2808 * access.
2809 */
Tejun Heo493008a2013-03-12 11:30:03 -07002810 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002811 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002812 else
Tejun Heo112202d2013-02-13 19:29:12 -08002813 lock_map_acquire_read(&pwq->wq->lockdep_map);
2814 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002815
Tejun Heobaf59022010-09-16 10:42:16 +02002816 return true;
2817already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002818 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002819 return false;
2820}
2821
Oleg Nesterovdb700892008-07-25 01:47:49 -07002822/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002823 * flush_work - wait for a work to finish executing the last queueing instance
2824 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002825 *
Tejun Heo606a5022012-08-20 14:51:23 -07002826 * Wait until @work has finished execution. @work is guaranteed to be idle
2827 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002828 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002829 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002830 * %true if flush_work() waited for the work to finish execution,
2831 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002832 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002833bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002834{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002835 struct wq_barrier barr;
2836
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002837 lock_map_acquire(&work->lockdep_map);
2838 lock_map_release(&work->lockdep_map);
2839
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002840 if (start_flush_work(work, &barr)) {
2841 wait_for_completion(&barr.done);
2842 destroy_work_on_stack(&barr.work);
2843 return true;
2844 } else {
2845 return false;
2846 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002847}
2848EXPORT_SYMBOL_GPL(flush_work);
2849
Tejun Heo36e227d2012-08-03 10:30:46 -07002850static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002851{
Tejun Heobbb68df2012-08-03 10:30:46 -07002852 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002853 int ret;
2854
2855 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002856 ret = try_to_grab_pending(work, is_dwork, &flags);
2857 /*
2858 * If someone else is canceling, wait for the same event it
2859 * would be waiting for before retrying.
2860 */
2861 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002862 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002863 } while (unlikely(ret < 0));
2864
Tejun Heobbb68df2012-08-03 10:30:46 -07002865 /* tell other tasks trying to grab @work to back off */
2866 mark_work_canceling(work);
2867 local_irq_restore(flags);
2868
Tejun Heo606a5022012-08-20 14:51:23 -07002869 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002870 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002871 return ret;
2872}
2873
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002874/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002875 * cancel_work_sync - cancel a work and wait for it to finish
2876 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002877 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002878 * Cancel @work and wait for its execution to finish. This function
2879 * can be used even if the work re-queues itself or migrates to
2880 * another workqueue. On return from this function, @work is
2881 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002882 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002883 * cancel_work_sync(&delayed_work->work) must not be used for
2884 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002885 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002886 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002887 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002888 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002889 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002890 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002891 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002892bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002893{
Tejun Heo36e227d2012-08-03 10:30:46 -07002894 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002895}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002896EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002897
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002898/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002899 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2900 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002901 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002902 * Delayed timer is cancelled and the pending work is queued for
2903 * immediate execution. Like flush_work(), this function only
2904 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002905 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002906 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002907 * %true if flush_work() waited for the work to finish execution,
2908 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002909 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002910bool flush_delayed_work(struct delayed_work *dwork)
2911{
Tejun Heo8930cab2012-08-03 10:30:45 -07002912 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002913 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002914 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002915 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002916 return flush_work(&dwork->work);
2917}
2918EXPORT_SYMBOL(flush_delayed_work);
2919
2920/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002921 * cancel_delayed_work - cancel a delayed work
2922 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002923 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002924 * Kill off a pending delayed_work.
2925 *
2926 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2927 * pending.
2928 *
2929 * Note:
2930 * The work callback function may still be running on return, unless
2931 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2932 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002933 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002934 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002935 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002936bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002937{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002938 unsigned long flags;
2939 int ret;
2940
2941 do {
2942 ret = try_to_grab_pending(&dwork->work, true, &flags);
2943 } while (unlikely(ret == -EAGAIN));
2944
2945 if (unlikely(ret < 0))
2946 return false;
2947
Tejun Heo7c3eed52013-01-24 11:01:33 -08002948 set_work_pool_and_clear_pending(&dwork->work,
2949 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002950 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002951 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002952}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002953EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002954
2955/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002956 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2957 * @dwork: the delayed work cancel
2958 *
2959 * This is cancel_work_sync() for delayed works.
2960 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002961 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002962 * %true if @dwork was pending, %false otherwise.
2963 */
2964bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002965{
Tejun Heo36e227d2012-08-03 10:30:46 -07002966 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002967}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002968EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002969
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002970/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002971 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002972 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002973 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002974 * schedule_on_each_cpu() executes @func on each online CPU using the
2975 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002976 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002977 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002978 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02002979 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002980 */
David Howells65f27f32006-11-22 14:55:48 +00002981int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002982{
2983 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002984 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002985
Andrew Mortonb6136772006-06-25 05:47:49 -07002986 works = alloc_percpu(struct work_struct);
2987 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002988 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002989
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002990 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002991
Christoph Lameter15316ba2006-01-08 01:00:43 -08002992 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002993 struct work_struct *work = per_cpu_ptr(works, cpu);
2994
2995 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002996 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002997 }
Tejun Heo93981802009-11-17 14:06:20 -08002998
2999 for_each_online_cpu(cpu)
3000 flush_work(per_cpu_ptr(works, cpu));
3001
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003002 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003003 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003004 return 0;
3005}
3006
Alan Sterneef6a7d2010-02-12 17:39:21 +09003007/**
3008 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3009 *
3010 * Forces execution of the kernel-global workqueue and blocks until its
3011 * completion.
3012 *
3013 * Think twice before calling this function! It's very easy to get into
3014 * trouble if you don't take great care. Either of the following situations
3015 * will lead to deadlock:
3016 *
3017 * One of the work items currently on the workqueue needs to acquire
3018 * a lock held by your code or its caller.
3019 *
3020 * Your code is running in the context of a work routine.
3021 *
3022 * They will be detected by lockdep when they occur, but the first might not
3023 * occur very often. It depends on what work items are on the workqueue and
3024 * what locks they need, which you have no control over.
3025 *
3026 * In most situations flushing the entire workqueue is overkill; you merely
3027 * need to know that a particular work item isn't queued and isn't running.
3028 * In such cases you should use cancel_delayed_work_sync() or
3029 * cancel_work_sync() instead.
3030 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031void flush_scheduled_work(void)
3032{
Tejun Heod320c032010-06-29 10:07:14 +02003033 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003034}
Dave Jonesae90dd52006-06-30 01:40:45 -04003035EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036
3037/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003038 * execute_in_process_context - reliably execute the routine with user context
3039 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003040 * @ew: guaranteed storage for the execute work structure (must
3041 * be available when the work executes)
3042 *
3043 * Executes the function immediately if process context is available,
3044 * otherwise schedules the function for delayed execution.
3045 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003046 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003047 * 1 - function was scheduled for execution
3048 */
David Howells65f27f32006-11-22 14:55:48 +00003049int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003050{
3051 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003052 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003053 return 0;
3054 }
3055
David Howells65f27f32006-11-22 14:55:48 +00003056 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003057 schedule_work(&ew->work);
3058
3059 return 1;
3060}
3061EXPORT_SYMBOL_GPL(execute_in_process_context);
3062
Tejun Heo226223a2013-03-12 11:30:05 -07003063#ifdef CONFIG_SYSFS
3064/*
3065 * Workqueues with WQ_SYSFS flag set is visible to userland via
3066 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
3067 * following attributes.
3068 *
3069 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
3070 * max_active RW int : maximum number of in-flight work items
3071 *
3072 * Unbound workqueues have the following extra attributes.
3073 *
3074 * id RO int : the associated pool ID
3075 * nice RW int : nice value of the workers
3076 * cpumask RW mask : bitmask of allowed CPUs for the workers
3077 */
3078struct wq_device {
3079 struct workqueue_struct *wq;
3080 struct device dev;
3081};
3082
3083static struct workqueue_struct *dev_to_wq(struct device *dev)
3084{
3085 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3086
3087 return wq_dev->wq;
3088}
3089
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003090static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
3091 char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07003092{
3093 struct workqueue_struct *wq = dev_to_wq(dev);
3094
3095 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
3096}
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003097static DEVICE_ATTR_RO(per_cpu);
Tejun Heo226223a2013-03-12 11:30:05 -07003098
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003099static ssize_t max_active_show(struct device *dev,
3100 struct device_attribute *attr, char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07003101{
3102 struct workqueue_struct *wq = dev_to_wq(dev);
3103
3104 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
3105}
3106
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003107static ssize_t max_active_store(struct device *dev,
3108 struct device_attribute *attr, const char *buf,
3109 size_t count)
Tejun Heo226223a2013-03-12 11:30:05 -07003110{
3111 struct workqueue_struct *wq = dev_to_wq(dev);
3112 int val;
3113
3114 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
3115 return -EINVAL;
3116
3117 workqueue_set_max_active(wq, val);
3118 return count;
3119}
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003120static DEVICE_ATTR_RW(max_active);
Tejun Heo226223a2013-03-12 11:30:05 -07003121
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003122static struct attribute *wq_sysfs_attrs[] = {
3123 &dev_attr_per_cpu.attr,
3124 &dev_attr_max_active.attr,
3125 NULL,
Tejun Heo226223a2013-03-12 11:30:05 -07003126};
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003127ATTRIBUTE_GROUPS(wq_sysfs);
Tejun Heo226223a2013-03-12 11:30:05 -07003128
Tejun Heod55262c2013-04-01 11:23:38 -07003129static ssize_t wq_pool_ids_show(struct device *dev,
3130 struct device_attribute *attr, char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07003131{
3132 struct workqueue_struct *wq = dev_to_wq(dev);
Tejun Heod55262c2013-04-01 11:23:38 -07003133 const char *delim = "";
3134 int node, written = 0;
Tejun Heo226223a2013-03-12 11:30:05 -07003135
3136 rcu_read_lock_sched();
Tejun Heod55262c2013-04-01 11:23:38 -07003137 for_each_node(node) {
3138 written += scnprintf(buf + written, PAGE_SIZE - written,
3139 "%s%d:%d", delim, node,
3140 unbound_pwq_by_node(wq, node)->pool->id);
3141 delim = " ";
3142 }
3143 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
Tejun Heo226223a2013-03-12 11:30:05 -07003144 rcu_read_unlock_sched();
3145
3146 return written;
3147}
3148
3149static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
3150 char *buf)
3151{
3152 struct workqueue_struct *wq = dev_to_wq(dev);
3153 int written;
3154
Tejun Heo6029a912013-04-01 11:23:34 -07003155 mutex_lock(&wq->mutex);
3156 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
3157 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003158
3159 return written;
3160}
3161
3162/* prepare workqueue_attrs for sysfs store operations */
3163static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
3164{
3165 struct workqueue_attrs *attrs;
3166
3167 attrs = alloc_workqueue_attrs(GFP_KERNEL);
3168 if (!attrs)
3169 return NULL;
3170
Tejun Heo6029a912013-04-01 11:23:34 -07003171 mutex_lock(&wq->mutex);
3172 copy_workqueue_attrs(attrs, wq->unbound_attrs);
3173 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003174 return attrs;
3175}
3176
3177static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
3178 const char *buf, size_t count)
3179{
3180 struct workqueue_struct *wq = dev_to_wq(dev);
3181 struct workqueue_attrs *attrs;
3182 int ret;
3183
3184 attrs = wq_sysfs_prep_attrs(wq);
3185 if (!attrs)
3186 return -ENOMEM;
3187
3188 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
Dongsheng Yang14481842014-02-11 15:34:52 +08003189 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Tejun Heo226223a2013-03-12 11:30:05 -07003190 ret = apply_workqueue_attrs(wq, attrs);
3191 else
3192 ret = -EINVAL;
3193
3194 free_workqueue_attrs(attrs);
3195 return ret ?: count;
3196}
3197
3198static ssize_t wq_cpumask_show(struct device *dev,
3199 struct device_attribute *attr, char *buf)
3200{
3201 struct workqueue_struct *wq = dev_to_wq(dev);
3202 int written;
3203
Tejun Heo6029a912013-04-01 11:23:34 -07003204 mutex_lock(&wq->mutex);
3205 written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask);
3206 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003207
3208 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3209 return written;
3210}
3211
3212static ssize_t wq_cpumask_store(struct device *dev,
3213 struct device_attribute *attr,
3214 const char *buf, size_t count)
3215{
3216 struct workqueue_struct *wq = dev_to_wq(dev);
3217 struct workqueue_attrs *attrs;
3218 int ret;
3219
3220 attrs = wq_sysfs_prep_attrs(wq);
3221 if (!attrs)
3222 return -ENOMEM;
3223
3224 ret = cpumask_parse(buf, attrs->cpumask);
3225 if (!ret)
3226 ret = apply_workqueue_attrs(wq, attrs);
3227
3228 free_workqueue_attrs(attrs);
3229 return ret ?: count;
3230}
3231
Tejun Heod55262c2013-04-01 11:23:38 -07003232static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
3233 char *buf)
3234{
3235 struct workqueue_struct *wq = dev_to_wq(dev);
3236 int written;
3237
3238 mutex_lock(&wq->mutex);
3239 written = scnprintf(buf, PAGE_SIZE, "%d\n",
3240 !wq->unbound_attrs->no_numa);
3241 mutex_unlock(&wq->mutex);
3242
3243 return written;
3244}
3245
3246static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
3247 const char *buf, size_t count)
3248{
3249 struct workqueue_struct *wq = dev_to_wq(dev);
3250 struct workqueue_attrs *attrs;
3251 int v, ret;
3252
3253 attrs = wq_sysfs_prep_attrs(wq);
3254 if (!attrs)
3255 return -ENOMEM;
3256
3257 ret = -EINVAL;
3258 if (sscanf(buf, "%d", &v) == 1) {
3259 attrs->no_numa = !v;
3260 ret = apply_workqueue_attrs(wq, attrs);
3261 }
3262
3263 free_workqueue_attrs(attrs);
3264 return ret ?: count;
3265}
3266
Tejun Heo226223a2013-03-12 11:30:05 -07003267static struct device_attribute wq_sysfs_unbound_attrs[] = {
Tejun Heod55262c2013-04-01 11:23:38 -07003268 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
Tejun Heo226223a2013-03-12 11:30:05 -07003269 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
3270 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
Tejun Heod55262c2013-04-01 11:23:38 -07003271 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
Tejun Heo226223a2013-03-12 11:30:05 -07003272 __ATTR_NULL,
3273};
3274
3275static struct bus_type wq_subsys = {
3276 .name = "workqueue",
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003277 .dev_groups = wq_sysfs_groups,
Tejun Heo226223a2013-03-12 11:30:05 -07003278};
3279
3280static int __init wq_sysfs_init(void)
3281{
3282 return subsys_virtual_register(&wq_subsys, NULL);
3283}
3284core_initcall(wq_sysfs_init);
3285
3286static void wq_device_release(struct device *dev)
3287{
3288 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3289
3290 kfree(wq_dev);
3291}
3292
3293/**
3294 * workqueue_sysfs_register - make a workqueue visible in sysfs
3295 * @wq: the workqueue to register
3296 *
3297 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
3298 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
3299 * which is the preferred method.
3300 *
3301 * Workqueue user should use this function directly iff it wants to apply
3302 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
3303 * apply_workqueue_attrs() may race against userland updating the
3304 * attributes.
3305 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003306 * Return: 0 on success, -errno on failure.
Tejun Heo226223a2013-03-12 11:30:05 -07003307 */
3308int workqueue_sysfs_register(struct workqueue_struct *wq)
3309{
3310 struct wq_device *wq_dev;
3311 int ret;
3312
3313 /*
3314 * Adjusting max_active or creating new pwqs by applyting
3315 * attributes breaks ordering guarantee. Disallow exposing ordered
3316 * workqueues.
3317 */
3318 if (WARN_ON(wq->flags & __WQ_ORDERED))
3319 return -EINVAL;
3320
3321 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
3322 if (!wq_dev)
3323 return -ENOMEM;
3324
3325 wq_dev->wq = wq;
3326 wq_dev->dev.bus = &wq_subsys;
3327 wq_dev->dev.init_name = wq->name;
3328 wq_dev->dev.release = wq_device_release;
3329
3330 /*
3331 * unbound_attrs are created separately. Suppress uevent until
3332 * everything is ready.
3333 */
3334 dev_set_uevent_suppress(&wq_dev->dev, true);
3335
3336 ret = device_register(&wq_dev->dev);
3337 if (ret) {
3338 kfree(wq_dev);
3339 wq->wq_dev = NULL;
3340 return ret;
3341 }
3342
3343 if (wq->flags & WQ_UNBOUND) {
3344 struct device_attribute *attr;
3345
3346 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
3347 ret = device_create_file(&wq_dev->dev, attr);
3348 if (ret) {
3349 device_unregister(&wq_dev->dev);
3350 wq->wq_dev = NULL;
3351 return ret;
3352 }
3353 }
3354 }
3355
3356 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
3357 return 0;
3358}
3359
3360/**
3361 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
3362 * @wq: the workqueue to unregister
3363 *
3364 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
3365 */
3366static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
3367{
3368 struct wq_device *wq_dev = wq->wq_dev;
3369
3370 if (!wq->wq_dev)
3371 return;
3372
3373 wq->wq_dev = NULL;
3374 device_unregister(&wq_dev->dev);
3375}
3376#else /* CONFIG_SYSFS */
3377static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
3378#endif /* CONFIG_SYSFS */
3379
Tejun Heo7a4e3442013-03-12 11:30:00 -07003380/**
3381 * free_workqueue_attrs - free a workqueue_attrs
3382 * @attrs: workqueue_attrs to free
3383 *
3384 * Undo alloc_workqueue_attrs().
3385 */
3386void free_workqueue_attrs(struct workqueue_attrs *attrs)
3387{
3388 if (attrs) {
3389 free_cpumask_var(attrs->cpumask);
3390 kfree(attrs);
3391 }
3392}
3393
3394/**
3395 * alloc_workqueue_attrs - allocate a workqueue_attrs
3396 * @gfp_mask: allocation mask to use
3397 *
3398 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003399 * return it.
3400 *
3401 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003402 */
3403struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3404{
3405 struct workqueue_attrs *attrs;
3406
3407 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3408 if (!attrs)
3409 goto fail;
3410 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3411 goto fail;
3412
Tejun Heo13e2e552013-04-01 11:23:31 -07003413 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003414 return attrs;
3415fail:
3416 free_workqueue_attrs(attrs);
3417 return NULL;
3418}
3419
Tejun Heo29c91e92013-03-12 11:30:03 -07003420static void copy_workqueue_attrs(struct workqueue_attrs *to,
3421 const struct workqueue_attrs *from)
3422{
3423 to->nice = from->nice;
3424 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003425 /*
3426 * Unlike hash and equality test, this function doesn't ignore
3427 * ->no_numa as it is used for both pool and wq attrs. Instead,
3428 * get_unbound_pool() explicitly clears ->no_numa after copying.
3429 */
3430 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003431}
3432
Tejun Heo29c91e92013-03-12 11:30:03 -07003433/* hash value of the content of @attr */
3434static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3435{
3436 u32 hash = 0;
3437
3438 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003439 hash = jhash(cpumask_bits(attrs->cpumask),
3440 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003441 return hash;
3442}
3443
3444/* content equality test */
3445static bool wqattrs_equal(const struct workqueue_attrs *a,
3446 const struct workqueue_attrs *b)
3447{
3448 if (a->nice != b->nice)
3449 return false;
3450 if (!cpumask_equal(a->cpumask, b->cpumask))
3451 return false;
3452 return true;
3453}
3454
Tejun Heo7a4e3442013-03-12 11:30:00 -07003455/**
3456 * init_worker_pool - initialize a newly zalloc'd worker_pool
3457 * @pool: worker_pool to initialize
3458 *
3459 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003460 *
3461 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003462 * inside @pool proper are initialized and put_unbound_pool() can be called
3463 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003464 */
3465static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003466{
3467 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003468 pool->id = -1;
3469 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003470 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003471 pool->flags |= POOL_DISASSOCIATED;
3472 INIT_LIST_HEAD(&pool->worklist);
3473 INIT_LIST_HEAD(&pool->idle_list);
3474 hash_init(pool->busy_hash);
3475
3476 init_timer_deferrable(&pool->idle_timer);
3477 pool->idle_timer.function = idle_worker_timeout;
3478 pool->idle_timer.data = (unsigned long)pool;
3479
3480 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3481 (unsigned long)pool);
3482
3483 mutex_init(&pool->manager_arb);
Tejun Heobc3a1af2013-03-13 19:47:39 -07003484 mutex_init(&pool->manager_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003485 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003486
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003487 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003488 INIT_HLIST_NODE(&pool->hash_node);
3489 pool->refcnt = 1;
3490
3491 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003492 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3493 if (!pool->attrs)
3494 return -ENOMEM;
3495 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003496}
3497
Tejun Heo29c91e92013-03-12 11:30:03 -07003498static void rcu_free_pool(struct rcu_head *rcu)
3499{
3500 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3501
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003502 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003503 free_workqueue_attrs(pool->attrs);
3504 kfree(pool);
3505}
3506
3507/**
3508 * put_unbound_pool - put a worker_pool
3509 * @pool: worker_pool to put
3510 *
3511 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003512 * safe manner. get_unbound_pool() calls this function on its failure path
3513 * and this function should be able to release pools which went through,
3514 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003515 *
3516 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003517 */
3518static void put_unbound_pool(struct worker_pool *pool)
3519{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003520 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003521 struct worker *worker;
3522
Tejun Heoa892cac2013-04-01 11:23:32 -07003523 lockdep_assert_held(&wq_pool_mutex);
3524
3525 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003526 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003527
3528 /* sanity checks */
3529 if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003530 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003531 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003532
3533 /* release id and unhash */
3534 if (pool->id >= 0)
3535 idr_remove(&worker_pool_idr, pool->id);
3536 hash_del(&pool->hash_node);
3537
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003538 /*
3539 * Become the manager and destroy all workers. Grabbing
3540 * manager_arb prevents @pool's workers from blocking on
3541 * manager_mutex.
3542 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003543 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003544
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003545 spin_lock_irq(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003546 while ((worker = first_worker(pool)))
3547 destroy_worker(worker);
3548 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003549 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003550
3551 mutex_lock(&pool->manager_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003552 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003553 pool->detach_completion = &detach_completion;
Tejun Heocd549682013-03-13 19:47:39 -07003554 mutex_unlock(&pool->manager_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003555
3556 if (pool->detach_completion)
3557 wait_for_completion(pool->detach_completion);
3558
Tejun Heo29c91e92013-03-12 11:30:03 -07003559 mutex_unlock(&pool->manager_arb);
3560
3561 /* shut down the timers */
3562 del_timer_sync(&pool->idle_timer);
3563 del_timer_sync(&pool->mayday_timer);
3564
3565 /* sched-RCU protected to allow dereferences from get_work_pool() */
3566 call_rcu_sched(&pool->rcu, rcu_free_pool);
3567}
3568
3569/**
3570 * get_unbound_pool - get a worker_pool with the specified attributes
3571 * @attrs: the attributes of the worker_pool to get
3572 *
3573 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3574 * reference count and return it. If there already is a matching
3575 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003576 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003577 *
3578 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003579 *
3580 * Return: On success, a worker_pool with the same attributes as @attrs.
3581 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003582 */
3583static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3584{
Tejun Heo29c91e92013-03-12 11:30:03 -07003585 u32 hash = wqattrs_hash(attrs);
3586 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003587 int node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003588
Tejun Heoa892cac2013-04-01 11:23:32 -07003589 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003590
3591 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003592 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3593 if (wqattrs_equal(pool->attrs, attrs)) {
3594 pool->refcnt++;
3595 goto out_unlock;
3596 }
3597 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003598
3599 /* nope, create a new one */
3600 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3601 if (!pool || init_worker_pool(pool) < 0)
3602 goto fail;
3603
Lai Jiangshan12ee4fc2013-03-20 03:28:01 +08003604 if (workqueue_freezing)
3605 pool->flags |= POOL_FREEZING;
3606
Tejun Heo8864b4e2013-03-12 11:30:04 -07003607 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003608 copy_workqueue_attrs(pool->attrs, attrs);
3609
Shaohua Li2865a8f2013-08-01 09:56:36 +08003610 /*
3611 * no_numa isn't a worker_pool attribute, always clear it. See
3612 * 'struct workqueue_attrs' comments for detail.
3613 */
3614 pool->attrs->no_numa = false;
3615
Tejun Heof3f90ad2013-04-01 11:23:34 -07003616 /* if cpumask is contained inside a NUMA node, we belong to that node */
3617 if (wq_numa_enabled) {
3618 for_each_node(node) {
3619 if (cpumask_subset(pool->attrs->cpumask,
3620 wq_numa_possible_cpumask[node])) {
3621 pool->node = node;
3622 break;
3623 }
3624 }
3625 }
3626
Tejun Heo29c91e92013-03-12 11:30:03 -07003627 if (worker_pool_assign_id(pool) < 0)
3628 goto fail;
3629
3630 /* create and start the initial worker */
Tejun Heoebf44d12013-03-13 19:47:39 -07003631 if (create_and_start_worker(pool) < 0)
Tejun Heo29c91e92013-03-12 11:30:03 -07003632 goto fail;
3633
Tejun Heo29c91e92013-03-12 11:30:03 -07003634 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003635 hash_add(unbound_pool_hash, &pool->hash_node, hash);
3636out_unlock:
Tejun Heo29c91e92013-03-12 11:30:03 -07003637 return pool;
3638fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003639 if (pool)
3640 put_unbound_pool(pool);
3641 return NULL;
3642}
3643
Tejun Heo8864b4e2013-03-12 11:30:04 -07003644static void rcu_free_pwq(struct rcu_head *rcu)
3645{
3646 kmem_cache_free(pwq_cache,
3647 container_of(rcu, struct pool_workqueue, rcu));
3648}
3649
3650/*
3651 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3652 * and needs to be destroyed.
3653 */
3654static void pwq_unbound_release_workfn(struct work_struct *work)
3655{
3656 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3657 unbound_release_work);
3658 struct workqueue_struct *wq = pwq->wq;
3659 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003660 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003661
3662 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3663 return;
3664
Tejun Heo75ccf592013-03-12 11:30:04 -07003665 /*
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003666 * Unlink @pwq. Synchronization against wq->mutex isn't strictly
Tejun Heo75ccf592013-03-12 11:30:04 -07003667 * necessary on release but do it anyway. It's easier to verify
3668 * and consistent with the linking path.
3669 */
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003670 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003671 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003672 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003673 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003674
Tejun Heoa892cac2013-04-01 11:23:32 -07003675 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003676 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003677 mutex_unlock(&wq_pool_mutex);
3678
Tejun Heo8864b4e2013-03-12 11:30:04 -07003679 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3680
3681 /*
3682 * If we're the last pwq going away, @wq is already dead and no one
3683 * is gonna access it anymore. Free it.
3684 */
Tejun Heo6029a912013-04-01 11:23:34 -07003685 if (is_last) {
3686 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003687 kfree(wq);
Tejun Heo6029a912013-04-01 11:23:34 -07003688 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003689}
3690
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003691/**
Tejun Heo699ce092013-03-13 16:51:35 -07003692 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003693 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003694 *
Tejun Heo699ce092013-03-13 16:51:35 -07003695 * If @pwq isn't freezing, set @pwq->max_active to the associated
3696 * workqueue's saved_max_active and activate delayed work items
3697 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003698 */
Tejun Heo699ce092013-03-13 16:51:35 -07003699static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003700{
Tejun Heo699ce092013-03-13 16:51:35 -07003701 struct workqueue_struct *wq = pwq->wq;
3702 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003703
Tejun Heo699ce092013-03-13 16:51:35 -07003704 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003705 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003706
3707 /* fast exit for non-freezable wqs */
3708 if (!freezable && pwq->max_active == wq->saved_max_active)
3709 return;
3710
Lai Jiangshana357fc02013-03-25 16:57:19 -07003711 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003712
3713 if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) {
3714 pwq->max_active = wq->saved_max_active;
3715
3716 while (!list_empty(&pwq->delayed_works) &&
3717 pwq->nr_active < pwq->max_active)
3718 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003719
3720 /*
3721 * Need to kick a worker after thawed or an unbound wq's
3722 * max_active is bumped. It's a slow path. Do it always.
3723 */
3724 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003725 } else {
3726 pwq->max_active = 0;
3727 }
3728
Lai Jiangshana357fc02013-03-25 16:57:19 -07003729 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003730}
3731
Tejun Heoe50aba92013-04-01 11:23:35 -07003732/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003733static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3734 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003735{
3736 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3737
Tejun Heoe50aba92013-04-01 11:23:35 -07003738 memset(pwq, 0, sizeof(*pwq));
3739
Tejun Heod2c1d402013-03-12 11:30:04 -07003740 pwq->pool = pool;
3741 pwq->wq = wq;
3742 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003743 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003744 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003745 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003746 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003747 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003748}
Tejun Heod2c1d402013-03-12 11:30:04 -07003749
Tejun Heof147f292013-04-01 11:23:35 -07003750/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003751static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003752{
3753 struct workqueue_struct *wq = pwq->wq;
3754
3755 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003756
Tejun Heo1befcf32013-04-01 11:23:35 -07003757 /* may be called multiple times, ignore if already linked */
3758 if (!list_empty(&pwq->pwqs_node))
3759 return;
3760
Tejun Heo983ca252013-03-13 16:51:35 -07003761 /*
3762 * Set the matching work_color. This is synchronized with
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003763 * wq->mutex to avoid confusing flush_workqueue().
Tejun Heo983ca252013-03-13 16:51:35 -07003764 */
Tejun Heo75ccf592013-03-12 11:30:04 -07003765 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003766
3767 /* sync max_active to the current setting */
3768 pwq_adjust_max_active(pwq);
3769
3770 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003771 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003772}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003773
Tejun Heof147f292013-04-01 11:23:35 -07003774/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3775static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3776 const struct workqueue_attrs *attrs)
3777{
3778 struct worker_pool *pool;
3779 struct pool_workqueue *pwq;
3780
3781 lockdep_assert_held(&wq_pool_mutex);
3782
3783 pool = get_unbound_pool(attrs);
3784 if (!pool)
3785 return NULL;
3786
Tejun Heoe50aba92013-04-01 11:23:35 -07003787 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003788 if (!pwq) {
3789 put_unbound_pool(pool);
3790 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003791 }
Tejun Heo6029a912013-04-01 11:23:34 -07003792
Tejun Heof147f292013-04-01 11:23:35 -07003793 init_pwq(pwq, wq, pool);
3794 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003795}
3796
Tejun Heo4c16bd32013-04-01 11:23:36 -07003797/* undo alloc_unbound_pwq(), used only in the error path */
3798static void free_unbound_pwq(struct pool_workqueue *pwq)
3799{
3800 lockdep_assert_held(&wq_pool_mutex);
3801
3802 if (pwq) {
3803 put_unbound_pool(pwq->pool);
Wei Yongjuncece95d2013-04-09 14:29:11 +08003804 kmem_cache_free(pwq_cache, pwq);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003805 }
3806}
3807
3808/**
3809 * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node
3810 * @attrs: the wq_attrs of interest
3811 * @node: the target NUMA node
3812 * @cpu_going_down: if >= 0, the CPU to consider as offline
3813 * @cpumask: outarg, the resulting cpumask
3814 *
3815 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3816 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003817 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003818 *
3819 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3820 * enabled and @node has online CPUs requested by @attrs, the returned
3821 * cpumask is the intersection of the possible CPUs of @node and
3822 * @attrs->cpumask.
3823 *
3824 * The caller is responsible for ensuring that the cpumask of @node stays
3825 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003826 *
3827 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3828 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003829 */
3830static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3831 int cpu_going_down, cpumask_t *cpumask)
3832{
Tejun Heod55262c2013-04-01 11:23:38 -07003833 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003834 goto use_dfl;
3835
3836 /* does @node have any online CPUs @attrs wants? */
3837 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3838 if (cpu_going_down >= 0)
3839 cpumask_clear_cpu(cpu_going_down, cpumask);
3840
3841 if (cpumask_empty(cpumask))
3842 goto use_dfl;
3843
3844 /* yeap, return possible CPUs in @node that @attrs wants */
3845 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3846 return !cpumask_equal(cpumask, attrs->cpumask);
3847
3848use_dfl:
3849 cpumask_copy(cpumask, attrs->cpumask);
3850 return false;
3851}
3852
Tejun Heo1befcf32013-04-01 11:23:35 -07003853/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3854static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3855 int node,
3856 struct pool_workqueue *pwq)
3857{
3858 struct pool_workqueue *old_pwq;
3859
3860 lockdep_assert_held(&wq->mutex);
3861
3862 /* link_pwq() can handle duplicate calls */
3863 link_pwq(pwq);
3864
3865 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3866 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3867 return old_pwq;
3868}
3869
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003870/**
3871 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3872 * @wq: the target workqueue
3873 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3874 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003875 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3876 * machines, this function maps a separate pwq to each NUMA node with
3877 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3878 * NUMA node it was issued on. Older pwqs are released as in-flight work
3879 * items finish. Note that a work item which repeatedly requeues itself
3880 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003881 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003882 * Performs GFP_KERNEL allocations.
3883 *
3884 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003885 */
3886int apply_workqueue_attrs(struct workqueue_struct *wq,
3887 const struct workqueue_attrs *attrs)
3888{
Tejun Heo4c16bd32013-04-01 11:23:36 -07003889 struct workqueue_attrs *new_attrs, *tmp_attrs;
3890 struct pool_workqueue **pwq_tbl, *dfl_pwq;
Tejun Heof147f292013-04-01 11:23:35 -07003891 int node, ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003892
Tejun Heo8719dce2013-03-12 11:30:04 -07003893 /* only unbound workqueues can change attributes */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003894 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3895 return -EINVAL;
3896
Tejun Heo8719dce2013-03-12 11:30:04 -07003897 /* creating multiple pwqs breaks ordering guarantee */
3898 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3899 return -EINVAL;
3900
Tejun Heo4c16bd32013-04-01 11:23:36 -07003901 pwq_tbl = kzalloc(wq_numa_tbl_len * sizeof(pwq_tbl[0]), GFP_KERNEL);
Tejun Heo13e2e552013-04-01 11:23:31 -07003902 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003903 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3904 if (!pwq_tbl || !new_attrs || !tmp_attrs)
Tejun Heo13e2e552013-04-01 11:23:31 -07003905 goto enomem;
3906
Tejun Heo4c16bd32013-04-01 11:23:36 -07003907 /* make a copy of @attrs and sanitize it */
Tejun Heo13e2e552013-04-01 11:23:31 -07003908 copy_workqueue_attrs(new_attrs, attrs);
3909 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
3910
Tejun Heo4c16bd32013-04-01 11:23:36 -07003911 /*
3912 * We may create multiple pwqs with differing cpumasks. Make a
3913 * copy of @new_attrs which will be modified and used to obtain
3914 * pools.
3915 */
3916 copy_workqueue_attrs(tmp_attrs, new_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003917
Tejun Heo4c16bd32013-04-01 11:23:36 -07003918 /*
3919 * CPUs should stay stable across pwq creations and installations.
3920 * Pin CPUs, determine the target cpumask for each node and create
3921 * pwqs accordingly.
3922 */
3923 get_online_cpus();
3924
3925 mutex_lock(&wq_pool_mutex);
3926
3927 /*
3928 * If something goes wrong during CPU up/down, we'll fall back to
3929 * the default pwq covering whole @attrs->cpumask. Always create
3930 * it even if we don't use it immediately.
3931 */
3932 dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3933 if (!dfl_pwq)
3934 goto enomem_pwq;
3935
3936 for_each_node(node) {
3937 if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) {
3938 pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3939 if (!pwq_tbl[node])
3940 goto enomem_pwq;
3941 } else {
3942 dfl_pwq->refcnt++;
3943 pwq_tbl[node] = dfl_pwq;
3944 }
3945 }
3946
3947 mutex_unlock(&wq_pool_mutex);
3948
3949 /* all pwqs have been created successfully, let's install'em */
Tejun Heof147f292013-04-01 11:23:35 -07003950 mutex_lock(&wq->mutex);
3951
Tejun Heof147f292013-04-01 11:23:35 -07003952 copy_workqueue_attrs(wq->unbound_attrs, new_attrs);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003953
3954 /* save the previous pwq and install the new one */
Tejun Heof147f292013-04-01 11:23:35 -07003955 for_each_node(node)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003956 pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]);
3957
3958 /* @dfl_pwq might not have been used, ensure it's linked */
3959 link_pwq(dfl_pwq);
3960 swap(wq->dfl_pwq, dfl_pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003961
3962 mutex_unlock(&wq->mutex);
3963
Tejun Heo4c16bd32013-04-01 11:23:36 -07003964 /* put the old pwqs */
3965 for_each_node(node)
3966 put_pwq_unlocked(pwq_tbl[node]);
3967 put_pwq_unlocked(dfl_pwq);
3968
3969 put_online_cpus();
Tejun Heo48621252013-04-01 11:23:31 -07003970 ret = 0;
3971 /* fall through */
3972out_free:
Tejun Heo4c16bd32013-04-01 11:23:36 -07003973 free_workqueue_attrs(tmp_attrs);
Tejun Heo48621252013-04-01 11:23:31 -07003974 free_workqueue_attrs(new_attrs);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003975 kfree(pwq_tbl);
Tejun Heo48621252013-04-01 11:23:31 -07003976 return ret;
Tejun Heo13e2e552013-04-01 11:23:31 -07003977
Tejun Heo4c16bd32013-04-01 11:23:36 -07003978enomem_pwq:
3979 free_unbound_pwq(dfl_pwq);
3980 for_each_node(node)
3981 if (pwq_tbl && pwq_tbl[node] != dfl_pwq)
3982 free_unbound_pwq(pwq_tbl[node]);
3983 mutex_unlock(&wq_pool_mutex);
3984 put_online_cpus();
Tejun Heo13e2e552013-04-01 11:23:31 -07003985enomem:
Tejun Heo48621252013-04-01 11:23:31 -07003986 ret = -ENOMEM;
3987 goto out_free;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003988}
3989
Tejun Heo4c16bd32013-04-01 11:23:36 -07003990/**
3991 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3992 * @wq: the target workqueue
3993 * @cpu: the CPU coming up or going down
3994 * @online: whether @cpu is coming up or going down
3995 *
3996 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3997 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3998 * @wq accordingly.
3999 *
4000 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4001 * falls back to @wq->dfl_pwq which may not be optimal but is always
4002 * correct.
4003 *
4004 * Note that when the last allowed CPU of a NUMA node goes offline for a
4005 * workqueue with a cpumask spanning multiple nodes, the workers which were
4006 * already executing the work items for the workqueue will lose their CPU
4007 * affinity and may execute on any CPU. This is similar to how per-cpu
4008 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4009 * affinity, it's the user's responsibility to flush the work item from
4010 * CPU_DOWN_PREPARE.
4011 */
4012static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4013 bool online)
4014{
4015 int node = cpu_to_node(cpu);
4016 int cpu_off = online ? -1 : cpu;
4017 struct pool_workqueue *old_pwq = NULL, *pwq;
4018 struct workqueue_attrs *target_attrs;
4019 cpumask_t *cpumask;
4020
4021 lockdep_assert_held(&wq_pool_mutex);
4022
4023 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
4024 return;
4025
4026 /*
4027 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4028 * Let's use a preallocated one. The following buf is protected by
4029 * CPU hotplug exclusion.
4030 */
4031 target_attrs = wq_update_unbound_numa_attrs_buf;
4032 cpumask = target_attrs->cpumask;
4033
4034 mutex_lock(&wq->mutex);
Tejun Heod55262c2013-04-01 11:23:38 -07004035 if (wq->unbound_attrs->no_numa)
4036 goto out_unlock;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004037
4038 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4039 pwq = unbound_pwq_by_node(wq, node);
4040
4041 /*
4042 * Let's determine what needs to be done. If the target cpumask is
4043 * different from wq's, we need to compare it to @pwq's and create
4044 * a new one if they don't match. If the target cpumask equals
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004045 * wq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004046 */
4047 if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) {
4048 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
4049 goto out_unlock;
4050 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004051 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004052 }
4053
4054 mutex_unlock(&wq->mutex);
4055
4056 /* create a new pwq */
4057 pwq = alloc_unbound_pwq(wq, target_attrs);
4058 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004059 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4060 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004061 mutex_lock(&wq->mutex);
4062 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004063 }
4064
4065 /*
4066 * Install the new pwq. As this function is called only from CPU
4067 * hotplug callbacks and applying a new attrs is wrapped with
4068 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
4069 * inbetween.
4070 */
4071 mutex_lock(&wq->mutex);
4072 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4073 goto out_unlock;
4074
4075use_dfl_pwq:
4076 spin_lock_irq(&wq->dfl_pwq->pool->lock);
4077 get_pwq(wq->dfl_pwq);
4078 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4079 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4080out_unlock:
4081 mutex_unlock(&wq->mutex);
4082 put_pwq_unlocked(old_pwq);
4083}
4084
Tejun Heo30cdf242013-03-12 11:29:57 -07004085static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004086{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004087 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004088 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004089
Tejun Heo30cdf242013-03-12 11:29:57 -07004090 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004091 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4092 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07004093 return -ENOMEM;
4094
4095 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004096 struct pool_workqueue *pwq =
4097 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004098 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004099 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07004100
Tejun Heof147f292013-04-01 11:23:35 -07004101 init_pwq(pwq, wq, &cpu_pools[highpri]);
4102
4103 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004104 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004105 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07004106 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004107 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004108 } else if (wq->flags & __WQ_ORDERED) {
4109 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4110 /* there should only be single pwq for ordering guarantee */
4111 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4112 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4113 "ordering guarantee broken for workqueue %s\n", wq->name);
4114 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07004115 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004116 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07004117 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004118}
4119
Tejun Heof3421792010-07-02 10:03:51 +02004120static int wq_clamp_max_active(int max_active, unsigned int flags,
4121 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004122{
Tejun Heof3421792010-07-02 10:03:51 +02004123 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4124
4125 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004126 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4127 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004128
Tejun Heof3421792010-07-02 10:03:51 +02004129 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004130}
4131
Tejun Heob196be82012-01-10 15:11:35 -08004132struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02004133 unsigned int flags,
4134 int max_active,
4135 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08004136 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004137{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004138 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004139 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004140 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004141 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004142
Viresh Kumarcee22a12013-04-08 16:45:40 +05304143 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4144 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4145 flags |= WQ_UNBOUND;
4146
Tejun Heoecf68812013-04-01 11:23:34 -07004147 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004148 if (flags & WQ_UNBOUND)
4149 tbl_size = wq_numa_tbl_len * sizeof(wq->numa_pwq_tbl[0]);
4150
4151 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004152 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004153 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004154
Tejun Heo6029a912013-04-01 11:23:34 -07004155 if (flags & WQ_UNBOUND) {
4156 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4157 if (!wq->unbound_attrs)
4158 goto err_free_wq;
4159 }
4160
Tejun Heoecf68812013-04-01 11:23:34 -07004161 va_start(args, lock_name);
4162 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004163 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004164
Tejun Heod320c032010-06-29 10:07:14 +02004165 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004166 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004167
Tejun Heob196be82012-01-10 15:11:35 -08004168 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004169 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004170 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004171 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004172 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07004173 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004174 INIT_LIST_HEAD(&wq->flusher_queue);
4175 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004176 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004177
Johannes Bergeb13ba82008-01-16 09:51:58 +01004178 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004179 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004180
Tejun Heo30cdf242013-03-12 11:29:57 -07004181 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004182 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004183
Tejun Heo493008a2013-03-12 11:30:03 -07004184 /*
4185 * Workqueues which may be used during memory reclaim should
4186 * have a rescuer to guarantee forward progress.
4187 */
4188 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004189 struct worker *rescuer;
4190
Tejun Heod2c1d402013-03-12 11:30:04 -07004191 rescuer = alloc_worker();
Tejun Heoe22bee72010-06-29 10:07:14 +02004192 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004193 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004194
Tejun Heo111c2252013-01-17 17:16:24 -08004195 rescuer->rescue_wq = wq;
4196 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004197 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004198 if (IS_ERR(rescuer->task)) {
4199 kfree(rescuer);
4200 goto err_destroy;
4201 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004202
Tejun Heod2c1d402013-03-12 11:30:04 -07004203 wq->rescuer = rescuer;
Tejun Heo14a40ff2013-03-19 13:45:20 -07004204 rescuer->task->flags |= PF_NO_SETAFFINITY;
Tejun Heoe22bee72010-06-29 10:07:14 +02004205 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004206 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004207
Tejun Heo226223a2013-03-12 11:30:05 -07004208 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4209 goto err_destroy;
4210
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004211 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004212 * wq_pool_mutex protects global freeze state and workqueues list.
4213 * Grab it, adjust max_active and add the new @wq to workqueues
4214 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004215 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004216 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004217
Lai Jiangshana357fc02013-03-25 16:57:19 -07004218 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004219 for_each_pwq(pwq, wq)
4220 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004221 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004222
Tejun Heo15376632010-06-29 10:07:11 +02004223 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004224
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004225 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004226
Oleg Nesterov3af244332007-05-09 02:34:09 -07004227 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004228
4229err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004230 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004231 kfree(wq);
4232 return NULL;
4233err_destroy:
4234 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004235 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004236}
Tejun Heod320c032010-06-29 10:07:14 +02004237EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004238
4239/**
4240 * destroy_workqueue - safely terminate a workqueue
4241 * @wq: target workqueue
4242 *
4243 * Safely destroy a workqueue. All work currently pending will be done first.
4244 */
4245void destroy_workqueue(struct workqueue_struct *wq)
4246{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004247 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004248 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004249
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004250 /* drain it before proceeding with destruction */
4251 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004252
Tejun Heo6183c002013-03-12 11:29:57 -07004253 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004254 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004255 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004256 int i;
4257
Tejun Heo76af4d92013-03-12 11:30:00 -07004258 for (i = 0; i < WORK_NR_COLORS; i++) {
4259 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004260 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004261 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004262 }
4263 }
4264
Lai Jiangshan5c529592013-04-04 10:05:38 +08004265 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004266 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004267 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004268 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004269 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004270 }
Tejun Heo6183c002013-03-12 11:29:57 -07004271 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004272 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004273
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004274 /*
4275 * wq list is used to freeze wq, remove from list after
4276 * flushing is complete in case freeze races us.
4277 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004278 mutex_lock(&wq_pool_mutex);
Tejun Heod2c1d402013-03-12 11:30:04 -07004279 list_del_init(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004280 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004281
Tejun Heo226223a2013-03-12 11:30:05 -07004282 workqueue_sysfs_unregister(wq);
4283
Tejun Heo493008a2013-03-12 11:30:03 -07004284 if (wq->rescuer) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004285 kthread_stop(wq->rescuer->task);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02004286 kfree(wq->rescuer);
Tejun Heo493008a2013-03-12 11:30:03 -07004287 wq->rescuer = NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +02004288 }
4289
Tejun Heo8864b4e2013-03-12 11:30:04 -07004290 if (!(wq->flags & WQ_UNBOUND)) {
4291 /*
4292 * The base ref is never dropped on per-cpu pwqs. Directly
4293 * free the pwqs and wq.
4294 */
4295 free_percpu(wq->cpu_pwqs);
4296 kfree(wq);
4297 } else {
4298 /*
4299 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004300 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4301 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004302 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004303 for_each_node(node) {
4304 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4305 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4306 put_pwq_unlocked(pwq);
4307 }
4308
4309 /*
4310 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4311 * put. Don't access it afterwards.
4312 */
4313 pwq = wq->dfl_pwq;
4314 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004315 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004316 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004317}
4318EXPORT_SYMBOL_GPL(destroy_workqueue);
4319
Tejun Heodcd989c2010-06-29 10:07:14 +02004320/**
4321 * workqueue_set_max_active - adjust max_active of a workqueue
4322 * @wq: target workqueue
4323 * @max_active: new max_active value.
4324 *
4325 * Set max_active of @wq to @max_active.
4326 *
4327 * CONTEXT:
4328 * Don't call from IRQ context.
4329 */
4330void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4331{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004332 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004333
Tejun Heo8719dce2013-03-12 11:30:04 -07004334 /* disallow meddling with max_active for ordered workqueues */
4335 if (WARN_ON(wq->flags & __WQ_ORDERED))
4336 return;
4337
Tejun Heof3421792010-07-02 10:03:51 +02004338 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004339
Lai Jiangshana357fc02013-03-25 16:57:19 -07004340 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004341
4342 wq->saved_max_active = max_active;
4343
Tejun Heo699ce092013-03-13 16:51:35 -07004344 for_each_pwq(pwq, wq)
4345 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004346
Lai Jiangshana357fc02013-03-25 16:57:19 -07004347 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004348}
4349EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4350
4351/**
Tejun Heoe62676162013-03-12 17:41:37 -07004352 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4353 *
4354 * Determine whether %current is a workqueue rescuer. Can be used from
4355 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004356 *
4357 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004358 */
4359bool current_is_workqueue_rescuer(void)
4360{
4361 struct worker *worker = current_wq_worker();
4362
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004363 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004364}
4365
4366/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004367 * workqueue_congested - test whether a workqueue is congested
4368 * @cpu: CPU in question
4369 * @wq: target workqueue
4370 *
4371 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4372 * no synchronization around this function and the test result is
4373 * unreliable and only useful as advisory hints or for debugging.
4374 *
Tejun Heod3251852013-05-10 11:10:17 -07004375 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4376 * Note that both per-cpu and unbound workqueues may be associated with
4377 * multiple pool_workqueues which have separate congested states. A
4378 * workqueue being congested on one CPU doesn't mean the workqueue is also
4379 * contested on other CPUs / NUMA nodes.
4380 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004381 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004382 * %true if congested, %false otherwise.
4383 */
Tejun Heod84ff052013-03-12 11:29:59 -07004384bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004385{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004386 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004387 bool ret;
4388
Lai Jiangshan88109452013-03-20 03:28:10 +08004389 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004390
Tejun Heod3251852013-05-10 11:10:17 -07004391 if (cpu == WORK_CPU_UNBOUND)
4392 cpu = smp_processor_id();
4393
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004394 if (!(wq->flags & WQ_UNBOUND))
4395 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4396 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004397 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004398
Tejun Heo76af4d92013-03-12 11:30:00 -07004399 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004400 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004401
4402 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004403}
4404EXPORT_SYMBOL_GPL(workqueue_congested);
4405
4406/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004407 * work_busy - test whether a work is currently pending or running
4408 * @work: the work to be tested
4409 *
4410 * Test whether @work is currently pending or running. There is no
4411 * synchronization around this function and the test result is
4412 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004413 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004414 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004415 * OR'd bitmask of WORK_BUSY_* bits.
4416 */
4417unsigned int work_busy(struct work_struct *work)
4418{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004419 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004420 unsigned long flags;
4421 unsigned int ret = 0;
4422
Tejun Heodcd989c2010-06-29 10:07:14 +02004423 if (work_pending(work))
4424 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004425
Tejun Heofa1b54e2013-03-12 11:30:00 -07004426 local_irq_save(flags);
4427 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004428 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004429 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004430 if (find_worker_executing_work(pool, work))
4431 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004432 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004433 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004434 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004435
4436 return ret;
4437}
4438EXPORT_SYMBOL_GPL(work_busy);
4439
Tejun Heo3d1cb202013-04-30 15:27:22 -07004440/**
4441 * set_worker_desc - set description for the current work item
4442 * @fmt: printf-style format string
4443 * @...: arguments for the format string
4444 *
4445 * This function can be called by a running work function to describe what
4446 * the work item is about. If the worker task gets dumped, this
4447 * information will be printed out together to help debugging. The
4448 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4449 */
4450void set_worker_desc(const char *fmt, ...)
4451{
4452 struct worker *worker = current_wq_worker();
4453 va_list args;
4454
4455 if (worker) {
4456 va_start(args, fmt);
4457 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4458 va_end(args);
4459 worker->desc_valid = true;
4460 }
4461}
4462
4463/**
4464 * print_worker_info - print out worker information and description
4465 * @log_lvl: the log level to use when printing
4466 * @task: target task
4467 *
4468 * If @task is a worker and currently executing a work item, print out the
4469 * name of the workqueue being serviced and worker description set with
4470 * set_worker_desc() by the currently executing work item.
4471 *
4472 * This function can be safely called on any task as long as the
4473 * task_struct itself is accessible. While safe, this function isn't
4474 * synchronized and may print out mixups or garbages of limited length.
4475 */
4476void print_worker_info(const char *log_lvl, struct task_struct *task)
4477{
4478 work_func_t *fn = NULL;
4479 char name[WQ_NAME_LEN] = { };
4480 char desc[WORKER_DESC_LEN] = { };
4481 struct pool_workqueue *pwq = NULL;
4482 struct workqueue_struct *wq = NULL;
4483 bool desc_valid = false;
4484 struct worker *worker;
4485
4486 if (!(task->flags & PF_WQ_WORKER))
4487 return;
4488
4489 /*
4490 * This function is called without any synchronization and @task
4491 * could be in any state. Be careful with dereferences.
4492 */
4493 worker = probe_kthread_data(task);
4494
4495 /*
4496 * Carefully copy the associated workqueue's workfn and name. Keep
4497 * the original last '\0' in case the original contains garbage.
4498 */
4499 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4500 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4501 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4502 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4503
4504 /* copy worker description */
4505 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4506 if (desc_valid)
4507 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4508
4509 if (fn || name[0] || desc[0]) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004510 pr_info("%sWorkqueue: %s %pf", log_lvl, name, fn);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004511 if (desc[0])
4512 pr_cont(" (%s)", desc);
4513 pr_cont("\n");
4514 }
4515}
4516
Tejun Heodb7bccf2010-06-29 10:07:12 +02004517/*
4518 * CPU hotplug.
4519 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004520 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004521 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004522 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004523 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004524 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004525 * blocked draining impractical.
4526 *
Tejun Heo24647572013-01-24 11:01:33 -08004527 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004528 * running as an unbound one and allowing it to be reattached later if the
4529 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004530 */
4531
Tejun Heo706026c2013-01-24 11:01:34 -08004532static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004533{
Tejun Heo38db41d2013-01-24 11:01:34 -08004534 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004535 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004536 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004537
Tejun Heof02ae732013-03-12 11:30:03 -07004538 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo6183c002013-03-12 11:29:57 -07004539 WARN_ON_ONCE(cpu != smp_processor_id());
Tejun Heo94cf58b2013-01-24 11:01:33 -08004540
Tejun Heobc3a1af2013-03-13 19:47:39 -07004541 mutex_lock(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004542 spin_lock_irq(&pool->lock);
4543
4544 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07004545 * We've blocked all manager operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004546 * unbound and set DISASSOCIATED. Before this, all workers
4547 * except for the ones which are still executing works from
4548 * before the last CPU down must be on the cpu. After
4549 * this, they may become diasporas.
4550 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004551 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004552 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004553
Tejun Heo24647572013-01-24 11:01:33 -08004554 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004555
Tejun Heo94cf58b2013-01-24 11:01:33 -08004556 spin_unlock_irq(&pool->lock);
Tejun Heobc3a1af2013-03-13 19:47:39 -07004557 mutex_unlock(&pool->manager_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004558
Lai Jiangshaneb283422013-03-08 15:18:28 -08004559 /*
4560 * Call schedule() so that we cross rq->lock and thus can
4561 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4562 * This is necessary as scheduler callbacks may be invoked
4563 * from other cpus.
4564 */
4565 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004566
Lai Jiangshaneb283422013-03-08 15:18:28 -08004567 /*
4568 * Sched callbacks are disabled now. Zap nr_running.
4569 * After this, nr_running stays zero and need_more_worker()
4570 * and keep_working() are always true as long as the
4571 * worklist is not empty. This pool now behaves as an
4572 * unbound (in terms of concurrency management) pool which
4573 * are served by workers tied to the pool.
4574 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004575 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004576
4577 /*
4578 * With concurrency management just turned off, a busy
4579 * worker blocking could lead to lengthy stalls. Kick off
4580 * unbound chain execution of currently pending work items.
4581 */
4582 spin_lock_irq(&pool->lock);
4583 wake_up_worker(pool);
4584 spin_unlock_irq(&pool->lock);
4585 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004586}
4587
Tejun Heobd7c0892013-03-19 13:45:21 -07004588/**
4589 * rebind_workers - rebind all workers of a pool to the associated CPU
4590 * @pool: pool of interest
4591 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004592 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004593 */
4594static void rebind_workers(struct worker_pool *pool)
4595{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004596 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004597
4598 lockdep_assert_held(&pool->manager_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004599
Tejun Heoa9ab7752013-03-19 13:45:21 -07004600 /*
4601 * Restore CPU affinity of all workers. As all idle workers should
4602 * be on the run-queue of the associated CPU before any local
4603 * wake-ups for concurrency management happen, restore CPU affinty
4604 * of all workers first and then clear UNBOUND. As we're called
4605 * from CPU_ONLINE, the following shouldn't fail.
4606 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004607 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004608 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4609 pool->attrs->cpumask) < 0);
4610
4611 spin_lock_irq(&pool->lock);
4612
Lai Jiangshanda028462014-05-20 17:46:31 +08004613 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004614 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004615
4616 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004617 * A bound idle worker should actually be on the runqueue
4618 * of the associated CPU for local wake-ups targeting it to
4619 * work. Kick all idle workers so that they migrate to the
4620 * associated CPU. Doing this in the same loop as
4621 * replacing UNBOUND with REBOUND is safe as no worker will
4622 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004623 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004624 if (worker_flags & WORKER_IDLE)
4625 wake_up_process(worker->task);
4626
4627 /*
4628 * We want to clear UNBOUND but can't directly call
4629 * worker_clr_flags() or adjust nr_running. Atomically
4630 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4631 * @worker will clear REBOUND using worker_clr_flags() when
4632 * it initiates the next execution cycle thus restoring
4633 * concurrency management. Note that when or whether
4634 * @worker clears REBOUND doesn't affect correctness.
4635 *
4636 * ACCESS_ONCE() is necessary because @worker->flags may be
4637 * tested without holding any lock in
4638 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4639 * fail incorrectly leading to premature concurrency
4640 * management operations.
4641 */
4642 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4643 worker_flags |= WORKER_REBOUND;
4644 worker_flags &= ~WORKER_UNBOUND;
4645 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004646 }
4647
Tejun Heoa9ab7752013-03-19 13:45:21 -07004648 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004649}
4650
Tejun Heo7dbc7252013-03-19 13:45:21 -07004651/**
4652 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4653 * @pool: unbound pool of interest
4654 * @cpu: the CPU which is coming up
4655 *
4656 * An unbound pool may end up with a cpumask which doesn't have any online
4657 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4658 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4659 * online CPU before, cpus_allowed of all its workers should be restored.
4660 */
4661static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4662{
4663 static cpumask_t cpumask;
4664 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004665
4666 lockdep_assert_held(&pool->manager_mutex);
4667
4668 /* is @cpu allowed for @pool? */
4669 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4670 return;
4671
4672 /* is @cpu the only online CPU? */
4673 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4674 if (cpumask_weight(&cpumask) != 1)
4675 return;
4676
4677 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004678 for_each_pool_worker(worker, pool)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004679 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4680 pool->attrs->cpumask) < 0);
4681}
4682
Tejun Heo8db25e72012-07-17 12:39:28 -07004683/*
4684 * Workqueues should be brought up before normal priority CPU notifiers.
4685 * This will be registered high priority CPU notifier.
4686 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004687static int workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004688 unsigned long action,
4689 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004690{
Tejun Heod84ff052013-03-12 11:29:59 -07004691 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004692 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004693 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004694 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004695
Tejun Heo8db25e72012-07-17 12:39:28 -07004696 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004697 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004698 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004699 if (pool->nr_workers)
4700 continue;
Tejun Heoebf44d12013-03-13 19:47:39 -07004701 if (create_and_start_worker(pool) < 0)
Tejun Heo3ce63372012-07-17 12:39:27 -07004702 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004703 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004704 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004705
Tejun Heo65758202012-07-17 12:39:26 -07004706 case CPU_DOWN_FAILED:
4707 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004708 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004709
4710 for_each_pool(pool, pi) {
Tejun Heobc3a1af2013-03-13 19:47:39 -07004711 mutex_lock(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004712
Tejun Heo7dbc7252013-03-19 13:45:21 -07004713 if (pool->cpu == cpu) {
4714 spin_lock_irq(&pool->lock);
4715 pool->flags &= ~POOL_DISASSOCIATED;
4716 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07004717
Tejun Heo7dbc7252013-03-19 13:45:21 -07004718 rebind_workers(pool);
4719 } else if (pool->cpu < 0) {
4720 restore_unbound_workers_cpumask(pool, cpu);
4721 }
Tejun Heo94cf58b2013-01-24 11:01:33 -08004722
Tejun Heobc3a1af2013-03-13 19:47:39 -07004723 mutex_unlock(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004724 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004725
Tejun Heo4c16bd32013-04-01 11:23:36 -07004726 /* update NUMA affinity of unbound workqueues */
4727 list_for_each_entry(wq, &workqueues, list)
4728 wq_update_unbound_numa(wq, cpu, true);
4729
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004730 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004731 break;
Tejun Heo65758202012-07-17 12:39:26 -07004732 }
4733 return NOTIFY_OK;
4734}
4735
4736/*
4737 * Workqueues should be brought down after normal priority CPU notifiers.
4738 * This will be registered as low priority CPU notifier.
4739 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004740static int workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004741 unsigned long action,
4742 void *hcpu)
4743{
Tejun Heod84ff052013-03-12 11:29:59 -07004744 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004745 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004746 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004747
Tejun Heo65758202012-07-17 12:39:26 -07004748 switch (action & ~CPU_TASKS_FROZEN) {
4749 case CPU_DOWN_PREPARE:
Tejun Heo4c16bd32013-04-01 11:23:36 -07004750 /* unbinding per-cpu workers should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004751 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004752 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004753
4754 /* update NUMA affinity of unbound workqueues */
4755 mutex_lock(&wq_pool_mutex);
4756 list_for_each_entry(wq, &workqueues, list)
4757 wq_update_unbound_numa(wq, cpu, false);
4758 mutex_unlock(&wq_pool_mutex);
4759
4760 /* wait for per-cpu unbinding to finish */
Tejun Heo8db25e72012-07-17 12:39:28 -07004761 flush_work(&unbind_work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004762 destroy_work_on_stack(&unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004763 break;
Tejun Heo65758202012-07-17 12:39:26 -07004764 }
4765 return NOTIFY_OK;
4766}
4767
Rusty Russell2d3854a2008-11-05 13:39:10 +11004768#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004769
Rusty Russell2d3854a2008-11-05 13:39:10 +11004770struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004771 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004772 long (*fn)(void *);
4773 void *arg;
4774 long ret;
4775};
4776
Tejun Heoed48ece2012-09-18 12:48:43 -07004777static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004778{
Tejun Heoed48ece2012-09-18 12:48:43 -07004779 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4780
Rusty Russell2d3854a2008-11-05 13:39:10 +11004781 wfc->ret = wfc->fn(wfc->arg);
4782}
4783
4784/**
4785 * work_on_cpu - run a function in user context on a particular cpu
4786 * @cpu: the cpu to run on
4787 * @fn: the function to run
4788 * @arg: the function arg
4789 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004790 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004791 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004792 *
4793 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004794 */
Tejun Heod84ff052013-03-12 11:29:59 -07004795long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004796{
Tejun Heoed48ece2012-09-18 12:48:43 -07004797 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004798
Tejun Heoed48ece2012-09-18 12:48:43 -07004799 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4800 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004801 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004802 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004803 return wfc.ret;
4804}
4805EXPORT_SYMBOL_GPL(work_on_cpu);
4806#endif /* CONFIG_SMP */
4807
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004808#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304809
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004810/**
4811 * freeze_workqueues_begin - begin freezing workqueues
4812 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004813 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004814 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004815 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004816 *
4817 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004818 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004819 */
4820void freeze_workqueues_begin(void)
4821{
Tejun Heo17116962013-03-12 11:29:58 -07004822 struct worker_pool *pool;
Tejun Heo24b8a842013-03-12 11:29:58 -07004823 struct workqueue_struct *wq;
4824 struct pool_workqueue *pwq;
Tejun Heo611c92a2013-03-13 16:51:36 -07004825 int pi;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004826
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004827 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004828
Tejun Heo6183c002013-03-12 11:29:57 -07004829 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004830 workqueue_freezing = true;
4831
Tejun Heo24b8a842013-03-12 11:29:58 -07004832 /* set FREEZING */
Tejun Heo611c92a2013-03-13 16:51:36 -07004833 for_each_pool(pool, pi) {
Tejun Heo5bcab332013-03-13 19:47:40 -07004834 spin_lock_irq(&pool->lock);
Tejun Heo17116962013-03-12 11:29:58 -07004835 WARN_ON_ONCE(pool->flags & POOL_FREEZING);
4836 pool->flags |= POOL_FREEZING;
Tejun Heo5bcab332013-03-13 19:47:40 -07004837 spin_unlock_irq(&pool->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004838 }
4839
Tejun Heo24b8a842013-03-12 11:29:58 -07004840 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004841 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004842 for_each_pwq(pwq, wq)
4843 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004844 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004845 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004846
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004847 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004848}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004849
4850/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004851 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004852 *
4853 * Check whether freezing is complete. This function must be called
4854 * between freeze_workqueues_begin() and thaw_workqueues().
4855 *
4856 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004857 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004858 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004859 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004860 * %true if some freezable workqueues are still busy. %false if freezing
4861 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004862 */
4863bool freeze_workqueues_busy(void)
4864{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004865 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004866 struct workqueue_struct *wq;
4867 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004868
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004869 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004870
Tejun Heo6183c002013-03-12 11:29:57 -07004871 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004872
Tejun Heo24b8a842013-03-12 11:29:58 -07004873 list_for_each_entry(wq, &workqueues, list) {
4874 if (!(wq->flags & WQ_FREEZABLE))
4875 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004876 /*
4877 * nr_active is monotonically decreasing. It's safe
4878 * to peek without lock.
4879 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004880 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004881 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004882 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004883 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004884 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004885 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004886 goto out_unlock;
4887 }
4888 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004889 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004890 }
4891out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004892 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004893 return busy;
4894}
4895
4896/**
4897 * thaw_workqueues - thaw workqueues
4898 *
4899 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004900 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004901 *
4902 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004903 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004904 */
4905void thaw_workqueues(void)
4906{
Tejun Heo24b8a842013-03-12 11:29:58 -07004907 struct workqueue_struct *wq;
4908 struct pool_workqueue *pwq;
4909 struct worker_pool *pool;
Tejun Heo611c92a2013-03-13 16:51:36 -07004910 int pi;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004911
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004912 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004913
4914 if (!workqueue_freezing)
4915 goto out_unlock;
4916
Tejun Heo24b8a842013-03-12 11:29:58 -07004917 /* clear FREEZING */
Tejun Heo611c92a2013-03-13 16:51:36 -07004918 for_each_pool(pool, pi) {
Tejun Heo5bcab332013-03-13 19:47:40 -07004919 spin_lock_irq(&pool->lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004920 WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
4921 pool->flags &= ~POOL_FREEZING;
Tejun Heo5bcab332013-03-13 19:47:40 -07004922 spin_unlock_irq(&pool->lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004923 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02004924
Tejun Heo24b8a842013-03-12 11:29:58 -07004925 /* restore max_active and repopulate worklist */
4926 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004927 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004928 for_each_pwq(pwq, wq)
4929 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004930 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004931 }
4932
4933 workqueue_freezing = false;
4934out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004935 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004936}
4937#endif /* CONFIG_FREEZER */
4938
Tejun Heobce90382013-04-01 11:23:32 -07004939static void __init wq_numa_init(void)
4940{
4941 cpumask_var_t *tbl;
4942 int node, cpu;
4943
4944 /* determine NUMA pwq table len - highest node id + 1 */
4945 for_each_node(node)
4946 wq_numa_tbl_len = max(wq_numa_tbl_len, node + 1);
4947
4948 if (num_possible_nodes() <= 1)
4949 return;
4950
Tejun Heod55262c2013-04-01 11:23:38 -07004951 if (wq_disable_numa) {
4952 pr_info("workqueue: NUMA affinity support disabled\n");
4953 return;
4954 }
4955
Tejun Heo4c16bd32013-04-01 11:23:36 -07004956 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
4957 BUG_ON(!wq_update_unbound_numa_attrs_buf);
4958
Tejun Heobce90382013-04-01 11:23:32 -07004959 /*
4960 * We want masks of possible CPUs of each node which isn't readily
4961 * available. Build one from cpu_to_node() which should have been
4962 * fully initialized by now.
4963 */
4964 tbl = kzalloc(wq_numa_tbl_len * sizeof(tbl[0]), GFP_KERNEL);
4965 BUG_ON(!tbl);
4966
4967 for_each_node(node)
Tejun Heo1be0c252013-05-15 14:24:24 -07004968 BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
4969 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07004970
4971 for_each_possible_cpu(cpu) {
4972 node = cpu_to_node(cpu);
4973 if (WARN_ON(node == NUMA_NO_NODE)) {
4974 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
4975 /* happens iff arch is bonkers, let's just proceed */
4976 return;
4977 }
4978 cpumask_set_cpu(cpu, tbl[node]);
4979 }
4980
4981 wq_numa_possible_cpumask = tbl;
4982 wq_numa_enabled = true;
4983}
4984
Suresh Siddha6ee05782010-07-30 14:57:37 -07004985static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004986{
Tejun Heo7a4e3442013-03-12 11:30:00 -07004987 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
4988 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02004989
Tejun Heoe904e6c2013-03-12 11:29:57 -07004990 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
4991
4992 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
4993
Tejun Heo65758202012-07-17 12:39:26 -07004994 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07004995 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02004996
Tejun Heobce90382013-04-01 11:23:32 -07004997 wq_numa_init();
4998
Tejun Heo706026c2013-01-24 11:01:34 -08004999 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005000 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005001 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005002
Tejun Heo7a4e3442013-03-12 11:30:00 -07005003 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005004 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005005 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005006 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005007 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005008 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005009 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005010
Tejun Heo9daf9e62013-01-24 11:01:33 -08005011 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005012 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005013 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005014 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005015 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005016 }
5017
Tejun Heoe22bee72010-06-29 10:07:14 +02005018 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07005019 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005020 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02005021
Tejun Heof02ae732013-03-12 11:30:03 -07005022 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07005023 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoebf44d12013-03-13 19:47:39 -07005024 BUG_ON(create_and_start_worker(pool) < 0);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005025 }
Tejun Heoe22bee72010-06-29 10:07:14 +02005026 }
5027
Tejun Heo8a2b7532013-09-05 12:30:04 -04005028 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005029 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5030 struct workqueue_attrs *attrs;
5031
5032 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005033 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005034 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005035
5036 /*
5037 * An ordered wq should have only one pwq as ordering is
5038 * guaranteed by max_active which is enforced by pwqs.
5039 * Turn off NUMA so that dfl_pwq is used for all nodes.
5040 */
5041 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5042 attrs->nice = std_nice[i];
5043 attrs->no_numa = true;
5044 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005045 }
5046
Tejun Heod320c032010-06-29 10:07:14 +02005047 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005048 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005049 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005050 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5051 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005052 system_freezable_wq = alloc_workqueue("events_freezable",
5053 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305054 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5055 WQ_POWER_EFFICIENT, 0);
5056 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5057 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5058 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005059 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305060 !system_unbound_wq || !system_freezable_wq ||
5061 !system_power_efficient_wq ||
5062 !system_freezable_power_efficient_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07005063 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005064}
Suresh Siddha6ee05782010-07-30 14:57:37 -07005065early_initcall(init_workqueues);