blob: 586ad91300b0f3924b41bd417cda9cbb076f1a9d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080019 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020023 *
24 * Please read Documentation/workqueue.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
Paul Gortmaker9984de12011-05-23 14:51:41 -040027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060038#include <linux/hardirq.h>
Christoph Lameter46934022006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/kallsyms.h>
42#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020051
Tejun Heoea138442013-01-18 14:05:55 -080052#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Tejun Heoc8e55f32010-06-29 10:07:12 +020054enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070055 /*
Tejun Heo24647572013-01-24 11:01:33 -080056 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 *
Tejun Heo24647572013-01-24 11:01:33 -080058 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 * While associated (!DISASSOCIATED), all workers are bound to the
60 * CPU and none has %WORKER_UNBOUND set and concurrency management
61 * is in effect.
62 *
63 * While DISASSOCIATED, the cpu may be offline and all workers have
64 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080065 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070066 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070067 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080068 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080069 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070070 */
Tejun Heo24647572013-01-24 11:01:33 -080071 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020072
Tejun Heoc8e55f32010-06-29 10:07:12 +020073 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020074 WORKER_DIE = 1 << 1, /* die die die */
75 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020076 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020077 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020078 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070079 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020080
Tejun Heoa9ab7752013-03-19 13:45:21 -070081 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
82 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020083
Tejun Heoe34cdddb2013-01-24 11:01:33 -080084 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070085
Tejun Heo29c91e92013-03-12 11:30:03 -070086 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020087 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020088
Tejun Heoe22bee72010-06-29 10:07:14 +020089 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
90 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
91
Tejun Heo3233cdb2011-02-16 18:10:19 +010092 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
93 /* call for help after 10ms
94 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020095 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
96 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020097
98 /*
99 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800100 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200101 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800102 RESCUER_NICE_LEVEL = MIN_NICE,
103 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700104
105 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200106};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200109 * Structure fields follow one of the following exclusion rules.
110 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200111 * I: Modifiable by initialization/destruction paths and read-only for
112 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200113 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200114 * P: Preemption protected. Disabling preemption is enough and should
115 * only be modified and accessed from the local cpu.
116 *
Tejun Heod565ed62013-01-24 11:01:33 -0800117 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200118 *
Tejun Heod565ed62013-01-24 11:01:33 -0800119 * X: During normal operation, modification requires pool->lock and should
120 * be done only from local cpu. Either disabling preemption on local
121 * cpu or grabbing pool->lock is enough for read access. If
122 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200123 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800124 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700125 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700126 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700127 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700128 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700129 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700130 * WQ: wq->mutex protected.
131 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700132 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700133 *
134 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200135 */
136
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800137/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200138
Tejun Heobd7bdd42012-07-12 14:46:37 -0700139struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800140 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700141 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700142 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800143 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700144 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700145
146 struct list_head worklist; /* L: list of pending works */
147 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700148
149 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700150 int nr_idle; /* L: currently idle ones */
151
152 struct list_head idle_list; /* X: list of idle workers */
153 struct timer_list idle_timer; /* L: worker idle timeout */
154 struct timer_list mayday_timer; /* L: SOS timer for workers */
155
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700156 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800157 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
158 /* L: hash of busy workers */
159
Tejun Heobc3a1af2013-03-13 19:47:39 -0700160 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo34a06bd2013-03-12 11:30:00 -0700161 struct mutex manager_arb; /* manager arbitration */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400162 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800163 struct mutex attach_mutex; /* attach/detach exclusion */
164 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800165 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800166
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800167 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800168
Tejun Heo7a4e3442013-03-12 11:30:00 -0700169 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700170 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
171 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700172
Tejun Heoe19e3972013-01-24 11:39:44 -0800173 /*
174 * The current concurrency level. As it's likely to be accessed
175 * from other CPUs during try_to_wake_up(), put it in a separate
176 * cacheline.
177 */
178 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700179
180 /*
181 * Destruction of pool is sched-RCU protected to allow dereferences
182 * from get_work_pool().
183 */
184 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200185} ____cacheline_aligned_in_smp;
186
187/*
Tejun Heo112202d2013-02-13 19:29:12 -0800188 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
189 * of work_struct->data are used for flags and the remaining high bits
190 * point to the pwq; thus, pwqs need to be aligned at two's power of the
191 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 */
Tejun Heo112202d2013-02-13 19:29:12 -0800193struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700194 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200195 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200196 int work_color; /* L: current color */
197 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700198 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200199 int nr_in_flight[WORK_NR_COLORS];
200 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200201 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200202 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200203 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700204 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700205 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700206
207 /*
208 * Release of unbound pwq is punted to system_wq. See put_pwq()
209 * and pwq_unbound_release_workfn() for details. pool_workqueue
210 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700211 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700212 */
213 struct work_struct unbound_release_work;
214 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700215} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200218 * Structure used to wait for workqueue flush.
219 */
220struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700221 struct list_head list; /* WQ: list of flushers */
222 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200223 struct completion done; /* flush completion */
224};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Tejun Heo226223a2013-03-12 11:30:05 -0700226struct wq_device;
227
Tejun Heo73f53c42010-06-29 10:07:11 +0200228/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700229 * The externally visible workqueue. It relays the issued work items to
230 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 */
232struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700233 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400234 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200235
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700236 struct mutex mutex; /* protects this wq */
237 int work_color; /* WQ: current work color */
238 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800239 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700240 struct wq_flusher *first_flusher; /* WQ: first flusher */
241 struct list_head flusher_queue; /* WQ: flush waiters */
242 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200243
Tejun Heo2e109a22013-03-13 19:47:40 -0700244 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200245 struct worker *rescuer; /* I: rescue worker */
246
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700247 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700248 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700249
Tejun Heo6029a912013-04-01 11:23:34 -0700250 struct workqueue_attrs *unbound_attrs; /* WQ: only for unbound wqs */
Tejun Heo4c16bd32013-04-01 11:23:36 -0700251 struct pool_workqueue *dfl_pwq; /* WQ: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700252
Tejun Heo226223a2013-03-12 11:30:05 -0700253#ifdef CONFIG_SYSFS
254 struct wq_device *wq_dev; /* I: for sysfs interface */
255#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700256#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200257 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700258#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700259 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700260
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400261 /*
262 * Destruction of workqueue_struct is sched-RCU protected to allow
263 * walking the workqueues list without grabbing wq_pool_mutex.
264 * This is used to dump all workqueues from sysrq.
265 */
266 struct rcu_head rcu;
267
Tejun Heo2728fd22013-04-01 11:23:35 -0700268 /* hot fields used during command issue, aligned to cacheline */
269 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
270 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700271 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272};
273
Tejun Heoe904e6c2013-03-12 11:29:57 -0700274static struct kmem_cache *pwq_cache;
275
Tejun Heobce90382013-04-01 11:23:32 -0700276static cpumask_var_t *wq_numa_possible_cpumask;
277 /* possible CPUs of each node */
278
Tejun Heod55262c2013-04-01 11:23:38 -0700279static bool wq_disable_numa;
280module_param_named(disable_numa, wq_disable_numa, bool, 0444);
281
Viresh Kumarcee22a12013-04-08 16:45:40 +0530282/* see the comment above the definition of WQ_POWER_EFFICIENT */
283#ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT
284static bool wq_power_efficient = true;
285#else
286static bool wq_power_efficient;
287#endif
288
289module_param_named(power_efficient, wq_power_efficient, bool, 0444);
290
Tejun Heobce90382013-04-01 11:23:32 -0700291static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
292
Tejun Heo4c16bd32013-04-01 11:23:36 -0700293/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
294static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
295
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700296static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700297static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo5bcab332013-03-13 19:47:40 -0700298
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400299static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700300static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700301
302/* the per-cpu worker pools */
303static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
304 cpu_worker_pools);
305
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700306static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700307
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700308/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700309static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
310
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700311/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700312static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
313
Tejun Heo8a2b7532013-09-05 12:30:04 -0400314/* I: attributes used when instantiating ordered pools on demand */
315static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
316
Tejun Heod320c032010-06-29 10:07:14 +0200317struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400318EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300319struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900320EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300321struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200322EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300323struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200324EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300325struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100326EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530327struct workqueue_struct *system_power_efficient_wq __read_mostly;
328EXPORT_SYMBOL_GPL(system_power_efficient_wq);
329struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
330EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200331
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700332static int worker_thread(void *__worker);
333static void copy_workqueue_attrs(struct workqueue_attrs *to,
334 const struct workqueue_attrs *from);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800335static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700336
Tejun Heo97bd2342010-10-05 10:41:14 +0200337#define CREATE_TRACE_POINTS
338#include <trace/events/workqueue.h>
339
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700340#define assert_rcu_or_pool_mutex() \
Tejun Heo5bcab332013-03-13 19:47:40 -0700341 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700342 lockdep_is_held(&wq_pool_mutex), \
343 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700344
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700345#define assert_rcu_or_wq_mutex(wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700346 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshanb5927602013-03-25 16:57:19 -0700347 lockdep_is_held(&wq->mutex), \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700348 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700349
Tejun Heof02ae732013-03-12 11:30:03 -0700350#define for_each_cpu_worker_pool(pool, cpu) \
351 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
352 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700353 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700354
Tejun Heo49e3cf42013-03-12 11:29:58 -0700355/**
Tejun Heo17116962013-03-12 11:29:58 -0700356 * for_each_pool - iterate through all worker_pools in the system
357 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700358 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700359 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700360 * This must be called either with wq_pool_mutex held or sched RCU read
361 * locked. If the pool needs to be used beyond the locking in effect, the
362 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700363 *
364 * The if/else clause exists only for the lockdep assertion and can be
365 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700366 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700367#define for_each_pool(pool, pi) \
368 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700369 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700370 else
Tejun Heo17116962013-03-12 11:29:58 -0700371
372/**
Tejun Heo822d8402013-03-19 13:45:21 -0700373 * for_each_pool_worker - iterate through all workers of a worker_pool
374 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700375 * @pool: worker_pool to iterate workers of
376 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800377 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700378 *
379 * The if/else clause exists only for the lockdep assertion and can be
380 * ignored.
381 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800382#define for_each_pool_worker(worker, pool) \
383 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800384 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700385 else
386
387/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700388 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
389 * @pwq: iteration cursor
390 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700391 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700392 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700393 * If the pwq needs to be used beyond the locking in effect, the caller is
394 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700395 *
396 * The if/else clause exists only for the lockdep assertion and can be
397 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700398 */
399#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700400 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700401 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700402 else
Tejun Heof3421792010-07-02 10:03:51 +0200403
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900404#ifdef CONFIG_DEBUG_OBJECTS_WORK
405
406static struct debug_obj_descr work_debug_descr;
407
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100408static void *work_debug_hint(void *addr)
409{
410 return ((struct work_struct *) addr)->func;
411}
412
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900413/*
414 * fixup_init is called when:
415 * - an active object is initialized
416 */
417static int work_fixup_init(void *addr, enum debug_obj_state state)
418{
419 struct work_struct *work = addr;
420
421 switch (state) {
422 case ODEBUG_STATE_ACTIVE:
423 cancel_work_sync(work);
424 debug_object_init(work, &work_debug_descr);
425 return 1;
426 default:
427 return 0;
428 }
429}
430
431/*
432 * fixup_activate is called when:
433 * - an active object is activated
434 * - an unknown object is activated (might be a statically initialized object)
435 */
436static int work_fixup_activate(void *addr, enum debug_obj_state state)
437{
438 struct work_struct *work = addr;
439
440 switch (state) {
441
442 case ODEBUG_STATE_NOTAVAILABLE:
443 /*
444 * This is not really a fixup. The work struct was
445 * statically initialized. We just make sure that it
446 * is tracked in the object tracker.
447 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200448 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900449 debug_object_init(work, &work_debug_descr);
450 debug_object_activate(work, &work_debug_descr);
451 return 0;
452 }
453 WARN_ON_ONCE(1);
454 return 0;
455
456 case ODEBUG_STATE_ACTIVE:
457 WARN_ON(1);
458
459 default:
460 return 0;
461 }
462}
463
464/*
465 * fixup_free is called when:
466 * - an active object is freed
467 */
468static int work_fixup_free(void *addr, enum debug_obj_state state)
469{
470 struct work_struct *work = addr;
471
472 switch (state) {
473 case ODEBUG_STATE_ACTIVE:
474 cancel_work_sync(work);
475 debug_object_free(work, &work_debug_descr);
476 return 1;
477 default:
478 return 0;
479 }
480}
481
482static struct debug_obj_descr work_debug_descr = {
483 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100484 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900485 .fixup_init = work_fixup_init,
486 .fixup_activate = work_fixup_activate,
487 .fixup_free = work_fixup_free,
488};
489
490static inline void debug_work_activate(struct work_struct *work)
491{
492 debug_object_activate(work, &work_debug_descr);
493}
494
495static inline void debug_work_deactivate(struct work_struct *work)
496{
497 debug_object_deactivate(work, &work_debug_descr);
498}
499
500void __init_work(struct work_struct *work, int onstack)
501{
502 if (onstack)
503 debug_object_init_on_stack(work, &work_debug_descr);
504 else
505 debug_object_init(work, &work_debug_descr);
506}
507EXPORT_SYMBOL_GPL(__init_work);
508
509void destroy_work_on_stack(struct work_struct *work)
510{
511 debug_object_free(work, &work_debug_descr);
512}
513EXPORT_SYMBOL_GPL(destroy_work_on_stack);
514
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000515void destroy_delayed_work_on_stack(struct delayed_work *work)
516{
517 destroy_timer_on_stack(&work->timer);
518 debug_object_free(&work->work, &work_debug_descr);
519}
520EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
521
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900522#else
523static inline void debug_work_activate(struct work_struct *work) { }
524static inline void debug_work_deactivate(struct work_struct *work) { }
525#endif
526
Li Bin4e8b22b2013-09-10 09:52:35 +0800527/**
528 * worker_pool_assign_id - allocate ID and assing it to @pool
529 * @pool: the pool pointer of interest
530 *
531 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
532 * successfully, -errno on failure.
533 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800534static int worker_pool_assign_id(struct worker_pool *pool)
535{
536 int ret;
537
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700538 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700539
Li Bin4e8b22b2013-09-10 09:52:35 +0800540 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
541 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700542 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700543 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700544 return 0;
545 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800546 return ret;
547}
548
Tejun Heo76af4d92013-03-12 11:30:00 -0700549/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700550 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
551 * @wq: the target workqueue
552 * @node: the node ID
553 *
554 * This must be called either with pwq_lock held or sched RCU read locked.
555 * If the pwq needs to be used beyond the locking in effect, the caller is
556 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700557 *
558 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700559 */
560static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
561 int node)
562{
563 assert_rcu_or_wq_mutex(wq);
564 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
565}
566
Tejun Heo73f53c42010-06-29 10:07:11 +0200567static unsigned int work_color_to_flags(int color)
568{
569 return color << WORK_STRUCT_COLOR_SHIFT;
570}
571
572static int get_work_color(struct work_struct *work)
573{
574 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
575 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
576}
577
578static int work_next_color(int color)
579{
580 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700581}
582
David Howells4594bf12006-12-07 11:33:26 +0000583/*
Tejun Heo112202d2013-02-13 19:29:12 -0800584 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
585 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800586 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200587 *
Tejun Heo112202d2013-02-13 19:29:12 -0800588 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
589 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700590 * work->data. These functions should only be called while the work is
591 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200592 *
Tejun Heo112202d2013-02-13 19:29:12 -0800593 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800594 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800595 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800596 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700597 *
598 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
599 * canceled. While being canceled, a work item may have its PENDING set
600 * but stay off timer and worklist for arbitrarily long and nobody should
601 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000602 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200603static inline void set_work_data(struct work_struct *work, unsigned long data,
604 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000605{
Tejun Heo6183c002013-03-12 11:29:57 -0700606 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200607 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000608}
David Howells365970a2006-11-22 14:54:49 +0000609
Tejun Heo112202d2013-02-13 19:29:12 -0800610static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200611 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200612{
Tejun Heo112202d2013-02-13 19:29:12 -0800613 set_work_data(work, (unsigned long)pwq,
614 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200615}
616
Lai Jiangshan4468a002013-02-06 18:04:53 -0800617static void set_work_pool_and_keep_pending(struct work_struct *work,
618 int pool_id)
619{
620 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
621 WORK_STRUCT_PENDING);
622}
623
Tejun Heo7c3eed52013-01-24 11:01:33 -0800624static void set_work_pool_and_clear_pending(struct work_struct *work,
625 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000626{
Tejun Heo23657bb2012-08-13 17:08:19 -0700627 /*
628 * The following wmb is paired with the implied mb in
629 * test_and_set_bit(PENDING) and ensures all updates to @work made
630 * here are visible to and precede any updates by the next PENDING
631 * owner.
632 */
633 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800634 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200635}
636
637static void clear_work_data(struct work_struct *work)
638{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800639 smp_wmb(); /* see set_work_pool_and_clear_pending() */
640 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200641}
642
Tejun Heo112202d2013-02-13 19:29:12 -0800643static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200644{
Tejun Heoe1201532010-07-22 14:14:25 +0200645 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200646
Tejun Heo112202d2013-02-13 19:29:12 -0800647 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200648 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
649 else
650 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200651}
652
Tejun Heo7c3eed52013-01-24 11:01:33 -0800653/**
654 * get_work_pool - return the worker_pool a given work was associated with
655 * @work: the work item of interest
656 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700657 * Pools are created and destroyed under wq_pool_mutex, and allows read
658 * access under sched-RCU read lock. As such, this function should be
659 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700660 *
661 * All fields of the returned pool are accessible as long as the above
662 * mentioned locking is in effect. If the returned pool needs to be used
663 * beyond the critical section, the caller is responsible for ensuring the
664 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700665 *
666 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800667 */
668static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200669{
Tejun Heoe1201532010-07-22 14:14:25 +0200670 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800671 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200672
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700673 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700674
Tejun Heo112202d2013-02-13 19:29:12 -0800675 if (data & WORK_STRUCT_PWQ)
676 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800677 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200678
Tejun Heo7c3eed52013-01-24 11:01:33 -0800679 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
680 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200681 return NULL;
682
Tejun Heofa1b54e2013-03-12 11:30:00 -0700683 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800684}
685
686/**
687 * get_work_pool_id - return the worker pool ID a given work is associated with
688 * @work: the work item of interest
689 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700690 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800691 * %WORK_OFFQ_POOL_NONE if none.
692 */
693static int get_work_pool_id(struct work_struct *work)
694{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800695 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800696
Tejun Heo112202d2013-02-13 19:29:12 -0800697 if (data & WORK_STRUCT_PWQ)
698 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800699 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
700
701 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800702}
703
Tejun Heobbb68df2012-08-03 10:30:46 -0700704static void mark_work_canceling(struct work_struct *work)
705{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800706 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700707
Tejun Heo7c3eed52013-01-24 11:01:33 -0800708 pool_id <<= WORK_OFFQ_POOL_SHIFT;
709 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700710}
711
712static bool work_is_canceling(struct work_struct *work)
713{
714 unsigned long data = atomic_long_read(&work->data);
715
Tejun Heo112202d2013-02-13 19:29:12 -0800716 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700717}
718
David Howells365970a2006-11-22 14:54:49 +0000719/*
Tejun Heo32704762012-07-13 22:16:45 -0700720 * Policy functions. These define the policies on how the global worker
721 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800722 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000723 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200724
Tejun Heo63d95a92012-07-12 14:46:37 -0700725static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000726{
Tejun Heoe19e3972013-01-24 11:39:44 -0800727 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000728}
729
Tejun Heoe22bee72010-06-29 10:07:14 +0200730/*
731 * Need to wake up a worker? Called from anything but currently
732 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700733 *
734 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800735 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700736 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200737 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700738static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000739{
Tejun Heo63d95a92012-07-12 14:46:37 -0700740 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000741}
742
Tejun Heoe22bee72010-06-29 10:07:14 +0200743/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700744static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200745{
Tejun Heo63d95a92012-07-12 14:46:37 -0700746 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200747}
748
749/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700750static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200751{
Tejun Heoe19e3972013-01-24 11:39:44 -0800752 return !list_empty(&pool->worklist) &&
753 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200754}
755
756/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700757static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200758{
Tejun Heo63d95a92012-07-12 14:46:37 -0700759 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200760}
761
Tejun Heoe22bee72010-06-29 10:07:14 +0200762/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700763static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200764{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700765 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700766 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
767 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200768
769 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
770}
771
772/*
773 * Wake up functions.
774 */
775
Lai Jiangshan1037de32014-05-22 16:44:07 +0800776/* Return the first idle worker. Safe with preemption disabled */
777static struct worker *first_idle_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{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800796 struct worker *worker = first_idle_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 */
Lai Jiangshan92b69f52014-06-03 15:33:08 +0800854 if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu))
Tejun Heo6183c002013-03-12 11:29:57 -0700855 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))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800870 to_wakeup = first_idle_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
Tejun Heod302f012010-06-29 10:07:13 +0200878 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800879 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200880 *
Tejun Heocb444762010-07-02 10:03:50 +0200881 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800882 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200883 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800884static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200885{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700886 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200887
Tejun Heocb444762010-07-02 10:03:50 +0200888 WARN_ON_ONCE(worker->task != current);
889
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800890 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200891 if ((flags & WORKER_NOT_RUNNING) &&
892 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800893 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200894 }
895
Tejun Heod302f012010-06-29 10:07:13 +0200896 worker->flags |= flags;
897}
898
899/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200900 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200901 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200902 * @flags: flags to clear
903 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200904 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200905 *
Tejun Heocb444762010-07-02 10:03:50 +0200906 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800907 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200908 */
909static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
910{
Tejun Heo63d95a92012-07-12 14:46:37 -0700911 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200912 unsigned int oflags = worker->flags;
913
Tejun Heocb444762010-07-02 10:03:50 +0200914 WARN_ON_ONCE(worker->task != current);
915
Tejun Heod302f012010-06-29 10:07:13 +0200916 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200917
Tejun Heo42c025f2011-01-11 15:58:49 +0100918 /*
919 * If transitioning out of NOT_RUNNING, increment nr_running. Note
920 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
921 * of multiple flags, not a single flag.
922 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200923 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
924 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800925 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200926}
927
928/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200929 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800930 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200931 * @work: work to find worker for
932 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800933 * Find a worker which is executing @work on @pool by searching
934 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800935 * to match, its current execution should match the address of @work and
936 * its work function. This is to avoid unwanted dependency between
937 * unrelated work executions through a work item being recycled while still
938 * being executed.
939 *
940 * This is a bit tricky. A work item may be freed once its execution
941 * starts and nothing prevents the freed area from being recycled for
942 * another work item. If the same work item address ends up being reused
943 * before the original execution finishes, workqueue will identify the
944 * recycled work item as currently executing and make it wait until the
945 * current execution finishes, introducing an unwanted dependency.
946 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700947 * This function checks the work item address and work function to avoid
948 * false positives. Note that this isn't complete as one may construct a
949 * work function which can introduce dependency onto itself through a
950 * recycled work item. Well, if somebody wants to shoot oneself in the
951 * foot that badly, there's only so much we can do, and if such deadlock
952 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200953 *
954 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800955 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200956 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700957 * Return:
958 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200959 * otherwise.
960 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800961static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200962 struct work_struct *work)
963{
Sasha Levin42f85702012-12-17 10:01:23 -0500964 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500965
Sasha Levinb67bfe02013-02-27 17:06:00 -0800966 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800967 (unsigned long)work)
968 if (worker->current_work == work &&
969 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500970 return worker;
971
972 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200973}
974
975/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700976 * move_linked_works - move linked works to a list
977 * @work: start of series of works to be scheduled
978 * @head: target list to append @work to
979 * @nextp: out paramter for nested worklist walking
980 *
981 * Schedule linked works starting from @work to @head. Work series to
982 * be scheduled starts at @work and includes any consecutive work with
983 * WORK_STRUCT_LINKED set in its predecessor.
984 *
985 * If @nextp is not NULL, it's updated to point to the next work of
986 * the last scheduled work. This allows move_linked_works() to be
987 * nested inside outer list_for_each_entry_safe().
988 *
989 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800990 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -0700991 */
992static void move_linked_works(struct work_struct *work, struct list_head *head,
993 struct work_struct **nextp)
994{
995 struct work_struct *n;
996
997 /*
998 * Linked worklist will always end before the end of the list,
999 * use NULL for list head.
1000 */
1001 list_for_each_entry_safe_from(work, n, NULL, entry) {
1002 list_move_tail(&work->entry, head);
1003 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1004 break;
1005 }
1006
1007 /*
1008 * If we're already inside safe list traversal and have moved
1009 * multiple works to the scheduled queue, the next position
1010 * needs to be updated.
1011 */
1012 if (nextp)
1013 *nextp = n;
1014}
1015
Tejun Heo8864b4e2013-03-12 11:30:04 -07001016/**
1017 * get_pwq - get an extra reference on the specified pool_workqueue
1018 * @pwq: pool_workqueue to get
1019 *
1020 * Obtain an extra reference on @pwq. The caller should guarantee that
1021 * @pwq has positive refcnt and be holding the matching pool->lock.
1022 */
1023static void get_pwq(struct pool_workqueue *pwq)
1024{
1025 lockdep_assert_held(&pwq->pool->lock);
1026 WARN_ON_ONCE(pwq->refcnt <= 0);
1027 pwq->refcnt++;
1028}
1029
1030/**
1031 * put_pwq - put a pool_workqueue reference
1032 * @pwq: pool_workqueue to put
1033 *
1034 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1035 * destruction. The caller should be holding the matching pool->lock.
1036 */
1037static void put_pwq(struct pool_workqueue *pwq)
1038{
1039 lockdep_assert_held(&pwq->pool->lock);
1040 if (likely(--pwq->refcnt))
1041 return;
1042 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1043 return;
1044 /*
1045 * @pwq can't be released under pool->lock, bounce to
1046 * pwq_unbound_release_workfn(). This never recurses on the same
1047 * pool->lock as this path is taken only for unbound workqueues and
1048 * the release work item is scheduled on a per-cpu workqueue. To
1049 * avoid lockdep warning, unbound pool->locks are given lockdep
1050 * subclass of 1 in get_unbound_pool().
1051 */
1052 schedule_work(&pwq->unbound_release_work);
1053}
1054
Tejun Heodce90d42013-04-01 11:23:35 -07001055/**
1056 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1057 * @pwq: pool_workqueue to put (can be %NULL)
1058 *
1059 * put_pwq() with locking. This function also allows %NULL @pwq.
1060 */
1061static void put_pwq_unlocked(struct pool_workqueue *pwq)
1062{
1063 if (pwq) {
1064 /*
1065 * As both pwqs and pools are sched-RCU protected, the
1066 * following lock operations are safe.
1067 */
1068 spin_lock_irq(&pwq->pool->lock);
1069 put_pwq(pwq);
1070 spin_unlock_irq(&pwq->pool->lock);
1071 }
1072}
1073
Tejun Heo112202d2013-02-13 19:29:12 -08001074static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001075{
Tejun Heo112202d2013-02-13 19:29:12 -08001076 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001077
1078 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001079 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001080 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001081 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001082}
1083
Tejun Heo112202d2013-02-13 19:29:12 -08001084static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001085{
Tejun Heo112202d2013-02-13 19:29:12 -08001086 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001087 struct work_struct, entry);
1088
Tejun Heo112202d2013-02-13 19:29:12 -08001089 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001090}
1091
Tejun Heobf4ede02012-08-03 10:30:46 -07001092/**
Tejun Heo112202d2013-02-13 19:29:12 -08001093 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1094 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001095 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001096 *
1097 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001098 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001099 *
1100 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001101 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001102 */
Tejun Heo112202d2013-02-13 19:29:12 -08001103static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001104{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001105 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001106 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001107 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001108
Tejun Heo112202d2013-02-13 19:29:12 -08001109 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001110
Tejun Heo112202d2013-02-13 19:29:12 -08001111 pwq->nr_active--;
1112 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001113 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001114 if (pwq->nr_active < pwq->max_active)
1115 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001116 }
1117
1118 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001119 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001120 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001121
1122 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001123 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001124 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001125
Tejun Heo112202d2013-02-13 19:29:12 -08001126 /* this pwq is done, clear flush_color */
1127 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001128
1129 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001130 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001131 * will handle the rest.
1132 */
Tejun Heo112202d2013-02-13 19:29:12 -08001133 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1134 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001135out_put:
1136 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001137}
1138
Tejun Heo36e227d2012-08-03 10:30:46 -07001139/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001140 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001141 * @work: work item to steal
1142 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001143 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001144 *
1145 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001146 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001147 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001148 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001149 * 1 if @work was pending and we successfully stole PENDING
1150 * 0 if @work was idle and we claimed PENDING
1151 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001152 * -ENOENT if someone else is canceling @work, this state may persist
1153 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001154 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001155 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001156 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001157 * interrupted while holding PENDING and @work off queue, irq must be
1158 * disabled on entry. This, combined with delayed_work->timer being
1159 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001160 *
1161 * On successful return, >= 0, irq is disabled and the caller is
1162 * responsible for releasing it using local_irq_restore(*@flags).
1163 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001164 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001165 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001166static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1167 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001168{
Tejun Heod565ed62013-01-24 11:01:33 -08001169 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001170 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001171
Tejun Heobbb68df2012-08-03 10:30:46 -07001172 local_irq_save(*flags);
1173
Tejun Heo36e227d2012-08-03 10:30:46 -07001174 /* try to steal the timer if it exists */
1175 if (is_dwork) {
1176 struct delayed_work *dwork = to_delayed_work(work);
1177
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001178 /*
1179 * dwork->timer is irqsafe. If del_timer() fails, it's
1180 * guaranteed that the timer is not queued anywhere and not
1181 * running on the local CPU.
1182 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001183 if (likely(del_timer(&dwork->timer)))
1184 return 1;
1185 }
1186
1187 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001188 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1189 return 0;
1190
1191 /*
1192 * The queueing is in progress, or it is already queued. Try to
1193 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1194 */
Tejun Heod565ed62013-01-24 11:01:33 -08001195 pool = get_work_pool(work);
1196 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001197 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001198
Tejun Heod565ed62013-01-24 11:01:33 -08001199 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001200 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001201 * work->data is guaranteed to point to pwq only while the work
1202 * item is queued on pwq->wq, and both updating work->data to point
1203 * to pwq on queueing and to pool on dequeueing are done under
1204 * pwq->pool->lock. This in turn guarantees that, if work->data
1205 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001206 * item is currently queued on that pool.
1207 */
Tejun Heo112202d2013-02-13 19:29:12 -08001208 pwq = get_work_pwq(work);
1209 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001210 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001211
Tejun Heo16062832013-02-06 18:04:53 -08001212 /*
1213 * A delayed work item cannot be grabbed directly because
1214 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001215 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001216 * management later on and cause stall. Make sure the work
1217 * item is activated before grabbing.
1218 */
1219 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001220 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001221
Tejun Heo16062832013-02-06 18:04:53 -08001222 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001223 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001224
Tejun Heo112202d2013-02-13 19:29:12 -08001225 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001226 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001227
Tejun Heo16062832013-02-06 18:04:53 -08001228 spin_unlock(&pool->lock);
1229 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001230 }
Tejun Heod565ed62013-01-24 11:01:33 -08001231 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001232fail:
1233 local_irq_restore(*flags);
1234 if (work_is_canceling(work))
1235 return -ENOENT;
1236 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001237 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001238}
1239
1240/**
Tejun Heo706026c2013-01-24 11:01:34 -08001241 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001242 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001243 * @work: work to insert
1244 * @head: insertion point
1245 * @extra_flags: extra WORK_STRUCT_* flags to set
1246 *
Tejun Heo112202d2013-02-13 19:29:12 -08001247 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001248 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001249 *
1250 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001251 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001252 */
Tejun Heo112202d2013-02-13 19:29:12 -08001253static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1254 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001255{
Tejun Heo112202d2013-02-13 19:29:12 -08001256 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001257
Tejun Heo4690c4a2010-06-29 10:07:10 +02001258 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001259 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001260 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001261 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001262
1263 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001264 * Ensure either wq_worker_sleeping() sees the above
1265 * list_add_tail() or we see zero nr_running to avoid workers lying
1266 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001267 */
1268 smp_mb();
1269
Tejun Heo63d95a92012-07-12 14:46:37 -07001270 if (__need_more_worker(pool))
1271 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001272}
1273
Tejun Heoc8efcc22010-12-20 19:32:04 +01001274/*
1275 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001276 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001277 */
1278static bool is_chained_work(struct workqueue_struct *wq)
1279{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001280 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001281
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001282 worker = current_wq_worker();
1283 /*
1284 * Return %true iff I'm a worker execuing a work item on @wq. If
1285 * I'm @worker, it's safe to dereference it without locking.
1286 */
Tejun Heo112202d2013-02-13 19:29:12 -08001287 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001288}
1289
Tejun Heod84ff052013-03-12 11:29:59 -07001290static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 struct work_struct *work)
1292{
Tejun Heo112202d2013-02-13 19:29:12 -08001293 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001294 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001295 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001296 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001297 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001298
1299 /*
1300 * While a work item is PENDING && off queue, a task trying to
1301 * steal the PENDING will busy-loop waiting for it to either get
1302 * queued or lose PENDING. Grabbing PENDING and queueing should
1303 * happen with IRQ disabled.
1304 */
1305 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001307 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001308
Li Bin9ef28a72013-09-09 13:13:58 +08001309 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001310 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001311 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001312 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001313retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001314 if (req_cpu == WORK_CPU_UNBOUND)
1315 cpu = raw_smp_processor_id();
1316
Tejun Heoc9178082013-03-12 11:30:04 -07001317 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001318 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001319 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001320 else
1321 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001322
Tejun Heoc9178082013-03-12 11:30:04 -07001323 /*
1324 * If @work was previously on a different pool, it might still be
1325 * running there, in which case the work needs to be queued on that
1326 * pool to guarantee non-reentrancy.
1327 */
1328 last_pool = get_work_pool(work);
1329 if (last_pool && last_pool != pwq->pool) {
1330 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001331
Tejun Heoc9178082013-03-12 11:30:04 -07001332 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001333
Tejun Heoc9178082013-03-12 11:30:04 -07001334 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001335
Tejun Heoc9178082013-03-12 11:30:04 -07001336 if (worker && worker->current_pwq->wq == wq) {
1337 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001338 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001339 /* meh... not running there, queue here */
1340 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001341 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001342 }
Tejun Heof3421792010-07-02 10:03:51 +02001343 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001344 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001345 }
1346
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001347 /*
1348 * pwq is determined and locked. For unbound pools, we could have
1349 * raced with pwq release and it could already be dead. If its
1350 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001351 * without another pwq replacing it in the numa_pwq_tbl or while
1352 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001353 * make forward-progress.
1354 */
1355 if (unlikely(!pwq->refcnt)) {
1356 if (wq->flags & WQ_UNBOUND) {
1357 spin_unlock(&pwq->pool->lock);
1358 cpu_relax();
1359 goto retry;
1360 }
1361 /* oops */
1362 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1363 wq->name, cpu);
1364 }
1365
Tejun Heo112202d2013-02-13 19:29:12 -08001366 /* pwq determined, queue */
1367 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001368
Dan Carpenterf5b25522012-04-13 22:06:58 +03001369 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001370 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001371 return;
1372 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001373
Tejun Heo112202d2013-02-13 19:29:12 -08001374 pwq->nr_in_flight[pwq->work_color]++;
1375 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001376
Tejun Heo112202d2013-02-13 19:29:12 -08001377 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001378 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001379 pwq->nr_active++;
1380 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001381 } else {
1382 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001383 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001384 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001385
Tejun Heo112202d2013-02-13 19:29:12 -08001386 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001387
Tejun Heo112202d2013-02-13 19:29:12 -08001388 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389}
1390
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001391/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001392 * queue_work_on - queue work on specific cpu
1393 * @cpu: CPU number to execute work on
1394 * @wq: workqueue to use
1395 * @work: work to queue
1396 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001397 * We queue the work to a specific CPU, the caller must ensure it
1398 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001399 *
1400 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001401 */
Tejun Heod4283e92012-08-03 10:30:44 -07001402bool queue_work_on(int cpu, struct workqueue_struct *wq,
1403 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001404{
Tejun Heod4283e92012-08-03 10:30:44 -07001405 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001406 unsigned long flags;
1407
1408 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001409
Tejun Heo22df02b2010-06-29 10:07:10 +02001410 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001411 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001412 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001413 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001414
1415 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001416 return ret;
1417}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001418EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001419
Tejun Heod8e794d2012-08-03 10:30:45 -07001420void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421{
David Howells52bad642006-11-22 14:54:01 +00001422 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001424 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001425 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001427EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001429static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1430 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001432 struct timer_list *timer = &dwork->timer;
1433 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001435 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1436 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001437 WARN_ON_ONCE(timer_pending(timer));
1438 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001439
Tejun Heo8852aac2012-12-01 16:23:42 -08001440 /*
1441 * If @delay is 0, queue @dwork->work immediately. This is for
1442 * both optimization and correctness. The earliest @timer can
1443 * expire is on the closest next tick and delayed_work users depend
1444 * on that there's no such delay when @delay is 0.
1445 */
1446 if (!delay) {
1447 __queue_work(cpu, wq, &dwork->work);
1448 return;
1449 }
1450
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001451 timer_stats_timer_set_start_info(&dwork->timer);
1452
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001453 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001454 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001455 timer->expires = jiffies + delay;
1456
1457 if (unlikely(cpu != WORK_CPU_UNBOUND))
1458 add_timer_on(timer, cpu);
1459 else
1460 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461}
1462
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001463/**
1464 * queue_delayed_work_on - queue work on specific CPU after delay
1465 * @cpu: CPU number to execute work on
1466 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001467 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001468 * @delay: number of jiffies to wait before queueing
1469 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001470 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001471 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1472 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001473 */
Tejun Heod4283e92012-08-03 10:30:44 -07001474bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1475 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001476{
David Howells52bad642006-11-22 14:54:01 +00001477 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001478 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001479 unsigned long flags;
1480
1481 /* read the comment in __queue_work() */
1482 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001483
Tejun Heo22df02b2010-06-29 10:07:10 +02001484 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001485 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001486 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001487 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001488
1489 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001490 return ret;
1491}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001492EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
Tejun Heoc8e55f32010-06-29 10:07:12 +02001494/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001495 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1496 * @cpu: CPU number to execute work on
1497 * @wq: workqueue to use
1498 * @dwork: work to queue
1499 * @delay: number of jiffies to wait before queueing
1500 *
1501 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1502 * modify @dwork's timer so that it expires after @delay. If @delay is
1503 * zero, @work is guaranteed to be scheduled immediately regardless of its
1504 * current state.
1505 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001506 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001507 * pending and its timer was modified.
1508 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001509 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001510 * See try_to_grab_pending() for details.
1511 */
1512bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1513 struct delayed_work *dwork, unsigned long delay)
1514{
1515 unsigned long flags;
1516 int ret;
1517
1518 do {
1519 ret = try_to_grab_pending(&dwork->work, true, &flags);
1520 } while (unlikely(ret == -EAGAIN));
1521
1522 if (likely(ret >= 0)) {
1523 __queue_delayed_work(cpu, wq, dwork, delay);
1524 local_irq_restore(flags);
1525 }
1526
1527 /* -ENOENT from try_to_grab_pending() becomes %true */
1528 return ret;
1529}
1530EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1531
1532/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001533 * worker_enter_idle - enter idle state
1534 * @worker: worker which is entering idle state
1535 *
1536 * @worker is entering idle state. Update stats and idle timer if
1537 * necessary.
1538 *
1539 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001540 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001541 */
1542static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001544 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545
Tejun Heo6183c002013-03-12 11:29:57 -07001546 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1547 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1548 (worker->hentry.next || worker->hentry.pprev)))
1549 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550
Lai Jiangshan051e1852014-07-22 13:03:02 +08001551 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001552 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001553 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001554 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001555
Tejun Heoc8e55f32010-06-29 10:07:12 +02001556 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001557 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001558
Tejun Heo628c78e2012-07-17 12:39:27 -07001559 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1560 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001561
Tejun Heo544ecf32012-05-14 15:04:50 -07001562 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001563 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001564 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001565 * nr_running, the warning may trigger spuriously. Check iff
1566 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001567 */
Tejun Heo24647572013-01-24 11:01:33 -08001568 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001569 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001570 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571}
1572
Tejun Heoc8e55f32010-06-29 10:07:12 +02001573/**
1574 * worker_leave_idle - leave idle state
1575 * @worker: worker which is leaving idle state
1576 *
1577 * @worker is leaving idle state. Update stats.
1578 *
1579 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001580 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001581 */
1582static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001584 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585
Tejun Heo6183c002013-03-12 11:29:57 -07001586 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1587 return;
Tejun Heod302f012010-06-29 10:07:13 +02001588 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001589 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001590 list_del_init(&worker->entry);
1591}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001593static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001594{
1595 struct worker *worker;
1596
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001597 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001598 if (worker) {
1599 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001600 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001601 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001602 /* on creation a worker is in !idle && prep state */
1603 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001604 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001605 return worker;
1606}
1607
1608/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001609 * worker_attach_to_pool() - attach a worker to a pool
1610 * @worker: worker to be attached
1611 * @pool: the target pool
1612 *
1613 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1614 * cpu-binding of @worker are kept coordinated with the pool across
1615 * cpu-[un]hotplugs.
1616 */
1617static void worker_attach_to_pool(struct worker *worker,
1618 struct worker_pool *pool)
1619{
1620 mutex_lock(&pool->attach_mutex);
1621
1622 /*
1623 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1624 * online CPUs. It'll be re-applied when any of the CPUs come up.
1625 */
1626 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1627
1628 /*
1629 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1630 * stable across this function. See the comments above the
1631 * flag definition for details.
1632 */
1633 if (pool->flags & POOL_DISASSOCIATED)
1634 worker->flags |= WORKER_UNBOUND;
1635
1636 list_add_tail(&worker->node, &pool->workers);
1637
1638 mutex_unlock(&pool->attach_mutex);
1639}
1640
1641/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001642 * worker_detach_from_pool() - detach a worker from its pool
1643 * @worker: worker which is attached to its pool
1644 * @pool: the pool @worker is attached to
1645 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001646 * Undo the attaching which had been done in worker_attach_to_pool(). The
1647 * caller worker shouldn't access to the pool after detached except it has
1648 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001649 */
1650static void worker_detach_from_pool(struct worker *worker,
1651 struct worker_pool *pool)
1652{
1653 struct completion *detach_completion = NULL;
1654
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001655 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001656 list_del(&worker->node);
1657 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001658 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001659 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001660
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001661 /* clear leftover flags without pool->lock after it is detached */
1662 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1663
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001664 if (detach_completion)
1665 complete(detach_completion);
1666}
1667
1668/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001669 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001670 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001671 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001672 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001673 *
1674 * CONTEXT:
1675 * Might sleep. Does GFP_KERNEL allocations.
1676 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001677 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001678 * Pointer to the newly created worker.
1679 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001680static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001681{
Tejun Heoc34056a2010-06-29 10:07:11 +02001682 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001683 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001684 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001685
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001686 /* ID is needed to determine kthread name */
1687 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001688 if (id < 0)
1689 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001690
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001691 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001692 if (!worker)
1693 goto fail;
1694
Tejun Heobd7bdd42012-07-12 14:46:37 -07001695 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001696 worker->id = id;
1697
Tejun Heo29c91e92013-03-12 11:30:03 -07001698 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001699 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1700 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001701 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001702 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1703
Tejun Heof3f90ad2013-04-01 11:23:34 -07001704 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001705 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001706 if (IS_ERR(worker->task))
1707 goto fail;
1708
Oleg Nesterov91151222013-11-14 12:56:18 +01001709 set_user_nice(worker->task, pool->attrs->nice);
1710
1711 /* prevent userland from meddling with cpumask of workqueue workers */
1712 worker->task->flags |= PF_NO_SETAFFINITY;
1713
Lai Jiangshanda028462014-05-20 17:46:31 +08001714 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001715 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001716
Lai Jiangshan051e1852014-07-22 13:03:02 +08001717 /* start the newly created worker */
1718 spin_lock_irq(&pool->lock);
1719 worker->pool->nr_workers++;
1720 worker_enter_idle(worker);
1721 wake_up_process(worker->task);
1722 spin_unlock_irq(&pool->lock);
1723
Tejun Heoc34056a2010-06-29 10:07:11 +02001724 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001725
Tejun Heoc34056a2010-06-29 10:07:11 +02001726fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001727 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001728 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001729 kfree(worker);
1730 return NULL;
1731}
1732
1733/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001734 * destroy_worker - destroy a workqueue worker
1735 * @worker: worker to be destroyed
1736 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001737 * Destroy @worker and adjust @pool stats accordingly. The worker should
1738 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001739 *
1740 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001741 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001742 */
1743static void destroy_worker(struct worker *worker)
1744{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001745 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001746
Tejun Heocd549682013-03-13 19:47:39 -07001747 lockdep_assert_held(&pool->lock);
1748
Tejun Heoc34056a2010-06-29 10:07:11 +02001749 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001750 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001751 WARN_ON(!list_empty(&worker->scheduled)) ||
1752 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001753 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001754
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001755 pool->nr_workers--;
1756 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001757
Tejun Heoc8e55f32010-06-29 10:07:12 +02001758 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001759 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001760 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001761}
1762
Tejun Heo63d95a92012-07-12 14:46:37 -07001763static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001764{
Tejun Heo63d95a92012-07-12 14:46:37 -07001765 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001766
Tejun Heod565ed62013-01-24 11:01:33 -08001767 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001768
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001769 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001770 struct worker *worker;
1771 unsigned long expires;
1772
1773 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001774 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001775 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1776
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001777 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001778 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001779 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001780 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001781
1782 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001783 }
1784
Tejun Heod565ed62013-01-24 11:01:33 -08001785 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001786}
1787
Tejun Heo493a1722013-03-12 11:29:59 -07001788static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001789{
Tejun Heo112202d2013-02-13 19:29:12 -08001790 struct pool_workqueue *pwq = get_work_pwq(work);
1791 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001792
Tejun Heo2e109a22013-03-13 19:47:40 -07001793 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001794
Tejun Heo493008a2013-03-12 11:30:03 -07001795 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001796 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001797
1798 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001799 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001800 /*
1801 * If @pwq is for an unbound wq, its base ref may be put at
1802 * any time due to an attribute change. Pin @pwq until the
1803 * rescuer is done with it.
1804 */
1805 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001806 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001807 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001808 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001809}
1810
Tejun Heo706026c2013-01-24 11:01:34 -08001811static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001812{
Tejun Heo63d95a92012-07-12 14:46:37 -07001813 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001814 struct work_struct *work;
1815
Tejun Heob2d82902014-12-08 12:39:16 -05001816 spin_lock_irq(&pool->lock);
1817 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001818
Tejun Heo63d95a92012-07-12 14:46:37 -07001819 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001820 /*
1821 * We've been trying to create a new worker but
1822 * haven't been successful. We might be hitting an
1823 * allocation deadlock. Send distress signals to
1824 * rescuers.
1825 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001826 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001827 send_mayday(work);
1828 }
1829
Tejun Heob2d82902014-12-08 12:39:16 -05001830 spin_unlock(&wq_mayday_lock);
1831 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001832
Tejun Heo63d95a92012-07-12 14:46:37 -07001833 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001834}
1835
1836/**
1837 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001838 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001839 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001840 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001841 * have at least one idle worker on return from this function. If
1842 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001843 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001844 * possible allocation deadlock.
1845 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001846 * On return, need_to_create_worker() is guaranteed to be %false and
1847 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001848 *
1849 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001850 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001851 * multiple times. Does GFP_KERNEL allocations. Called only from
1852 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001853 */
Tejun Heo29187a92015-01-16 14:21:16 -05001854static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001855__releases(&pool->lock)
1856__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001857{
Tejun Heoe22bee72010-06-29 10:07:14 +02001858restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001859 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001860
Tejun Heoe22bee72010-06-29 10:07:14 +02001861 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001862 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001863
1864 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001865 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001866 break;
1867
Lai Jiangshane212f362014-06-03 15:32:17 +08001868 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001869
Tejun Heo63d95a92012-07-12 14:46:37 -07001870 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001871 break;
1872 }
1873
Tejun Heo63d95a92012-07-12 14:46:37 -07001874 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001875 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001876 /*
1877 * This is necessary even after a new worker was just successfully
1878 * created as @pool->lock was dropped and the new worker might have
1879 * already become busy.
1880 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001881 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001882 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001883}
1884
1885/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001886 * manage_workers - manage worker pool
1887 * @worker: self
1888 *
Tejun Heo706026c2013-01-24 11:01:34 -08001889 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001890 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001891 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001892 *
1893 * The caller can safely start processing works on false return. On
1894 * true return, it's guaranteed that need_to_create_worker() is false
1895 * and may_start_working() is true.
1896 *
1897 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001898 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001899 * multiple times. Does GFP_KERNEL allocations.
1900 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001901 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001902 * %false if the pool doesn't need management and the caller can safely
1903 * start processing works, %true if management function was performed and
1904 * the conditions that the caller verified before calling the function may
1905 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001906 */
1907static bool manage_workers(struct worker *worker)
1908{
Tejun Heo63d95a92012-07-12 14:46:37 -07001909 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001910
Tejun Heobc3a1af2013-03-13 19:47:39 -07001911 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07001912 * Anyone who successfully grabs manager_arb wins the arbitration
1913 * and becomes the manager. mutex_trylock() on pool->manager_arb
1914 * failure while holding pool->lock reliably indicates that someone
1915 * else is managing the pool and the worker which failed trylock
1916 * can proceed to executing work items. This means that anyone
1917 * grabbing manager_arb is responsible for actually performing
1918 * manager duties. If manager_arb is grabbed and released without
1919 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07001920 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07001921 if (!mutex_trylock(&pool->manager_arb))
Tejun Heo29187a92015-01-16 14:21:16 -05001922 return false;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001923 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001924
Tejun Heo29187a92015-01-16 14:21:16 -05001925 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001926
Tejun Heo2607d7a2015-03-09 09:22:28 -04001927 pool->manager = NULL;
Tejun Heo34a06bd2013-03-12 11:30:00 -07001928 mutex_unlock(&pool->manager_arb);
Tejun Heo29187a92015-01-16 14:21:16 -05001929 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02001930}
1931
Tejun Heoa62428c2010-06-29 10:07:10 +02001932/**
1933 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001934 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001935 * @work: work to process
1936 *
1937 * Process @work. This function contains all the logics necessary to
1938 * process a single work including synchronization against and
1939 * interaction with other workers on the same cpu, queueing and
1940 * flushing. As long as context requirement is met, any worker can
1941 * call this function to process a work.
1942 *
1943 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001944 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001945 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001946static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08001947__releases(&pool->lock)
1948__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02001949{
Tejun Heo112202d2013-02-13 19:29:12 -08001950 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001951 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001952 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02001953 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001954 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001955#ifdef CONFIG_LOCKDEP
1956 /*
1957 * It is permissible to free the struct work_struct from
1958 * inside the function that is called from it, this we need to
1959 * take into account for lockdep too. To avoid bogus "held
1960 * lock freed" warnings as well as problems when looking into
1961 * work->lockdep_map, make a copy and use that here.
1962 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07001963 struct lockdep_map lockdep_map;
1964
1965 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02001966#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08001967 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08001968 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08001969 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07001970
Tejun Heo7e116292010-06-29 10:07:13 +02001971 /*
1972 * A single work shouldn't be executed concurrently by
1973 * multiple workers on a single cpu. Check whether anyone is
1974 * already processing the work. If so, defer the work to the
1975 * currently executing one.
1976 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001977 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02001978 if (unlikely(collision)) {
1979 move_linked_works(work, &collision->scheduled, NULL);
1980 return;
1981 }
1982
Tejun Heo8930cab2012-08-03 10:30:45 -07001983 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02001984 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001985 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02001986 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08001987 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08001988 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001989 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001990
Tejun Heoa62428c2010-06-29 10:07:10 +02001991 list_del_init(&work->entry);
1992
Tejun Heo649027d2010-06-29 10:07:14 +02001993 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08001994 * CPU intensive works don't participate in concurrency management.
1995 * They're the scheduler's responsibility. This takes @worker out
1996 * of concurrency management and the next code block will chain
1997 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02001998 */
1999 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002000 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002001
Tejun Heo974271c2012-07-12 14:46:37 -07002002 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002003 * Wake up another worker if necessary. The condition is always
2004 * false for normal per-cpu workers since nr_running would always
2005 * be >= 1 at this point. This is used to chain execution of the
2006 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002007 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002008 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002009 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002010 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002011
Tejun Heo8930cab2012-08-03 10:30:45 -07002012 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002013 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002014 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002015 * PENDING and queued state changes happen together while IRQ is
2016 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002017 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002018 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002019
Tejun Heod565ed62013-01-24 11:01:33 -08002020 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002021
Tejun Heo112202d2013-02-13 19:29:12 -08002022 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002023 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002024 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002025 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002026 /*
2027 * While we must be careful to not use "work" after this, the trace
2028 * point will only record its address.
2029 */
2030 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002031 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002032 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002033
2034 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002035 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2036 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002037 current->comm, preempt_count(), task_pid_nr(current),
2038 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002039 debug_show_held_locks(current);
2040 dump_stack();
2041 }
2042
Tejun Heob22ce272013-08-28 17:33:37 -04002043 /*
2044 * The following prevents a kworker from hogging CPU on !PREEMPT
2045 * kernels, where a requeueing work item waiting for something to
2046 * happen could deadlock with stop_machine as such work item could
2047 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002048 * stop_machine. At the same time, report a quiescent RCU state so
2049 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002050 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002051 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002052
Tejun Heod565ed62013-01-24 11:01:33 -08002053 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002054
Tejun Heofb0e7be2010-06-29 10:07:15 +02002055 /* clear cpu intensive status */
2056 if (unlikely(cpu_intensive))
2057 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2058
Tejun Heoa62428c2010-06-29 10:07:10 +02002059 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002060 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002061 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002062 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002063 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002064 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002065 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002066}
2067
Tejun Heoaffee4b2010-06-29 10:07:12 +02002068/**
2069 * process_scheduled_works - process scheduled works
2070 * @worker: self
2071 *
2072 * Process all scheduled works. Please note that the scheduled list
2073 * may change while processing a work, so this function repeatedly
2074 * fetches a work from the top and executes it.
2075 *
2076 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002077 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002078 * multiple times.
2079 */
2080static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002082 while (!list_empty(&worker->scheduled)) {
2083 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002085 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087}
2088
Tejun Heo4690c4a2010-06-29 10:07:10 +02002089/**
2090 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002091 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002092 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002093 * The worker thread function. All workers belong to a worker_pool -
2094 * either a per-cpu one or dynamic unbound one. These workers process all
2095 * work items regardless of their specific target workqueue. The only
2096 * exception is work items which belong to workqueues with a rescuer which
2097 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002098 *
2099 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002100 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002101static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102{
Tejun Heoc34056a2010-06-29 10:07:11 +02002103 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002104 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105
Tejun Heoe22bee72010-06-29 10:07:14 +02002106 /* tell the scheduler that this is a workqueue worker */
2107 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002108woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002109 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002110
Tejun Heoa9ab7752013-03-19 13:45:21 -07002111 /* am I supposed to die? */
2112 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002113 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002114 WARN_ON_ONCE(!list_empty(&worker->entry));
2115 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002116
2117 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002118 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002119 worker_detach_from_pool(worker, pool);
2120 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002121 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002123
Tejun Heoc8e55f32010-06-29 10:07:12 +02002124 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002125recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002126 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002127 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002128 goto sleep;
2129
2130 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002131 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002132 goto recheck;
2133
Tejun Heoc8e55f32010-06-29 10:07:12 +02002134 /*
2135 * ->scheduled list can only be filled while a worker is
2136 * preparing to process a work or actually processing it.
2137 * Make sure nobody diddled with it while I was sleeping.
2138 */
Tejun Heo6183c002013-03-12 11:29:57 -07002139 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002140
Tejun Heoe22bee72010-06-29 10:07:14 +02002141 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002142 * Finish PREP stage. We're guaranteed to have at least one idle
2143 * worker or that someone else has already assumed the manager
2144 * role. This is where @worker starts participating in concurrency
2145 * management if applicable and concurrency management is restored
2146 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002147 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002148 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002149
2150 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002151 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002152 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002153 struct work_struct, entry);
2154
2155 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2156 /* optimization path, not strictly necessary */
2157 process_one_work(worker, work);
2158 if (unlikely(!list_empty(&worker->scheduled)))
2159 process_scheduled_works(worker);
2160 } else {
2161 move_linked_works(work, &worker->scheduled, NULL);
2162 process_scheduled_works(worker);
2163 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002164 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002165
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002166 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002167sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002168 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002169 * pool->lock is held and there's no work to process and no need to
2170 * manage, sleep. Workers are woken up only while holding
2171 * pool->lock or from local cpu, so setting the current state
2172 * before releasing pool->lock is enough to prevent losing any
2173 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002174 */
2175 worker_enter_idle(worker);
2176 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002177 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002178 schedule();
2179 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180}
2181
Tejun Heoe22bee72010-06-29 10:07:14 +02002182/**
2183 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002184 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002185 *
2186 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002187 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002188 *
Tejun Heo706026c2013-01-24 11:01:34 -08002189 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002190 * worker which uses GFP_KERNEL allocation which has slight chance of
2191 * developing into deadlock if some works currently on the same queue
2192 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2193 * the problem rescuer solves.
2194 *
Tejun Heo706026c2013-01-24 11:01:34 -08002195 * When such condition is possible, the pool summons rescuers of all
2196 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002197 * those works so that forward progress can be guaranteed.
2198 *
2199 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002200 *
2201 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002202 */
Tejun Heo111c2252013-01-17 17:16:24 -08002203static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002204{
Tejun Heo111c2252013-01-17 17:16:24 -08002205 struct worker *rescuer = __rescuer;
2206 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002207 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002208 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002209
2210 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002211
2212 /*
2213 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2214 * doesn't participate in concurrency management.
2215 */
2216 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002217repeat:
2218 set_current_state(TASK_INTERRUPTIBLE);
2219
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002220 /*
2221 * By the time the rescuer is requested to stop, the workqueue
2222 * shouldn't have any work pending, but @wq->maydays may still have
2223 * pwq(s) queued. This can happen by non-rescuer workers consuming
2224 * all the work items before the rescuer got to them. Go through
2225 * @wq->maydays processing before acting on should_stop so that the
2226 * list is always empty on exit.
2227 */
2228 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002229
Tejun Heo493a1722013-03-12 11:29:59 -07002230 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002231 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002232
2233 while (!list_empty(&wq->maydays)) {
2234 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2235 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002236 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002237 struct work_struct *work, *n;
2238
2239 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002240 list_del_init(&pwq->mayday_node);
2241
Tejun Heo2e109a22013-03-13 19:47:40 -07002242 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002243
Lai Jiangshan51697d392014-05-20 17:46:36 +08002244 worker_attach_to_pool(rescuer, pool);
2245
2246 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002247 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002248
2249 /*
2250 * Slurp in all works issued via this workqueue and
2251 * process'em.
2252 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002253 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002254 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002255 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002256 move_linked_works(work, scheduled, &n);
2257
NeilBrown008847f2014-12-08 12:39:16 -05002258 if (!list_empty(scheduled)) {
2259 process_scheduled_works(rescuer);
2260
2261 /*
2262 * The above execution of rescued work items could
2263 * have created more to rescue through
2264 * pwq_activate_first_delayed() or chained
2265 * queueing. Let's put @pwq back on mayday list so
2266 * that such back-to-back work items, which may be
2267 * being used to relieve memory pressure, don't
2268 * incur MAYDAY_INTERVAL delay inbetween.
2269 */
2270 if (need_to_create_worker(pool)) {
2271 spin_lock(&wq_mayday_lock);
2272 get_pwq(pwq);
2273 list_move_tail(&pwq->mayday_node, &wq->maydays);
2274 spin_unlock(&wq_mayday_lock);
2275 }
2276 }
Tejun Heo75769582011-02-14 14:04:46 +01002277
2278 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002279 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002280 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002281 */
2282 put_pwq(pwq);
2283
2284 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002285 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002286 * regular worker; otherwise, we end up with 0 concurrency
2287 * and stalling the execution.
2288 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002289 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002290 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002291
Lai Jiangshanb3104102013-02-19 12:17:02 -08002292 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002293 spin_unlock_irq(&pool->lock);
2294
2295 worker_detach_from_pool(rescuer, pool);
2296
2297 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002298 }
2299
Tejun Heo2e109a22013-03-13 19:47:40 -07002300 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002301
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002302 if (should_stop) {
2303 __set_current_state(TASK_RUNNING);
2304 rescuer->task->flags &= ~PF_WQ_WORKER;
2305 return 0;
2306 }
2307
Tejun Heo111c2252013-01-17 17:16:24 -08002308 /* rescuers should never participate in concurrency management */
2309 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002310 schedule();
2311 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312}
2313
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002314struct wq_barrier {
2315 struct work_struct work;
2316 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002317 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002318};
2319
2320static void wq_barrier_func(struct work_struct *work)
2321{
2322 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2323 complete(&barr->done);
2324}
2325
Tejun Heo4690c4a2010-06-29 10:07:10 +02002326/**
2327 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002328 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002329 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002330 * @target: target work to attach @barr to
2331 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002332 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002333 * @barr is linked to @target such that @barr is completed only after
2334 * @target finishes execution. Please note that the ordering
2335 * guarantee is observed only with respect to @target and on the local
2336 * cpu.
2337 *
2338 * Currently, a queued barrier can't be canceled. This is because
2339 * try_to_grab_pending() can't determine whether the work to be
2340 * grabbed is at the head of the queue and thus can't clear LINKED
2341 * flag of the previous work while there must be a valid next work
2342 * after a work with LINKED flag set.
2343 *
2344 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002345 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002346 *
2347 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002348 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002349 */
Tejun Heo112202d2013-02-13 19:29:12 -08002350static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002351 struct wq_barrier *barr,
2352 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002353{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002354 struct list_head *head;
2355 unsigned int linked = 0;
2356
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002357 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002358 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002359 * as we know for sure that this will not trigger any of the
2360 * checks and call back into the fixup functions where we
2361 * might deadlock.
2362 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002363 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002364 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002365 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002366 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002367
Tejun Heoaffee4b2010-06-29 10:07:12 +02002368 /*
2369 * If @target is currently being executed, schedule the
2370 * barrier to the worker; otherwise, put it after @target.
2371 */
2372 if (worker)
2373 head = worker->scheduled.next;
2374 else {
2375 unsigned long *bits = work_data_bits(target);
2376
2377 head = target->entry.next;
2378 /* there can already be other linked works, inherit and set */
2379 linked = *bits & WORK_STRUCT_LINKED;
2380 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2381 }
2382
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002383 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002384 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002385 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002386}
2387
Tejun Heo73f53c42010-06-29 10:07:11 +02002388/**
Tejun Heo112202d2013-02-13 19:29:12 -08002389 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002390 * @wq: workqueue being flushed
2391 * @flush_color: new flush color, < 0 for no-op
2392 * @work_color: new work color, < 0 for no-op
2393 *
Tejun Heo112202d2013-02-13 19:29:12 -08002394 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002395 *
Tejun Heo112202d2013-02-13 19:29:12 -08002396 * If @flush_color is non-negative, flush_color on all pwqs should be
2397 * -1. If no pwq has in-flight commands at the specified color, all
2398 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2399 * has in flight commands, its pwq->flush_color is set to
2400 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002401 * wakeup logic is armed and %true is returned.
2402 *
2403 * The caller should have initialized @wq->first_flusher prior to
2404 * calling this function with non-negative @flush_color. If
2405 * @flush_color is negative, no flush color update is done and %false
2406 * is returned.
2407 *
Tejun Heo112202d2013-02-13 19:29:12 -08002408 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002409 * work_color which is previous to @work_color and all will be
2410 * advanced to @work_color.
2411 *
2412 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002413 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002414 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002415 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002416 * %true if @flush_color >= 0 and there's something to flush. %false
2417 * otherwise.
2418 */
Tejun Heo112202d2013-02-13 19:29:12 -08002419static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002420 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421{
Tejun Heo73f53c42010-06-29 10:07:11 +02002422 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002423 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002424
Tejun Heo73f53c42010-06-29 10:07:11 +02002425 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002426 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002427 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002428 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002429
Tejun Heo49e3cf42013-03-12 11:29:58 -07002430 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002431 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002432
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002433 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002434
2435 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002436 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002437
Tejun Heo112202d2013-02-13 19:29:12 -08002438 if (pwq->nr_in_flight[flush_color]) {
2439 pwq->flush_color = flush_color;
2440 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002441 wait = true;
2442 }
2443 }
2444
2445 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002446 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002447 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002448 }
2449
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002450 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002451 }
2452
Tejun Heo112202d2013-02-13 19:29:12 -08002453 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002454 complete(&wq->first_flusher->done);
2455
2456 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457}
2458
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002459/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002461 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002463 * This function sleeps until all work items which were queued on entry
2464 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002466void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467{
Tejun Heo73f53c42010-06-29 10:07:11 +02002468 struct wq_flusher this_flusher = {
2469 .list = LIST_HEAD_INIT(this_flusher.list),
2470 .flush_color = -1,
2471 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2472 };
2473 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002474
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002475 lock_map_acquire(&wq->lockdep_map);
2476 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002477
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002478 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002479
2480 /*
2481 * Start-to-wait phase
2482 */
2483 next_color = work_next_color(wq->work_color);
2484
2485 if (next_color != wq->flush_color) {
2486 /*
2487 * Color space is not full. The current work_color
2488 * becomes our flush_color and work_color is advanced
2489 * by one.
2490 */
Tejun Heo6183c002013-03-12 11:29:57 -07002491 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002492 this_flusher.flush_color = wq->work_color;
2493 wq->work_color = next_color;
2494
2495 if (!wq->first_flusher) {
2496 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002497 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002498
2499 wq->first_flusher = &this_flusher;
2500
Tejun Heo112202d2013-02-13 19:29:12 -08002501 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002502 wq->work_color)) {
2503 /* nothing to flush, done */
2504 wq->flush_color = next_color;
2505 wq->first_flusher = NULL;
2506 goto out_unlock;
2507 }
2508 } else {
2509 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002510 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002511 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002512 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002513 }
2514 } else {
2515 /*
2516 * Oops, color space is full, wait on overflow queue.
2517 * The next flush completion will assign us
2518 * flush_color and transfer to flusher_queue.
2519 */
2520 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2521 }
2522
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002523 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002524
2525 wait_for_completion(&this_flusher.done);
2526
2527 /*
2528 * Wake-up-and-cascade phase
2529 *
2530 * First flushers are responsible for cascading flushes and
2531 * handling overflow. Non-first flushers can simply return.
2532 */
2533 if (wq->first_flusher != &this_flusher)
2534 return;
2535
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002536 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002537
Tejun Heo4ce48b32010-07-02 10:03:51 +02002538 /* we might have raced, check again with mutex held */
2539 if (wq->first_flusher != &this_flusher)
2540 goto out_unlock;
2541
Tejun Heo73f53c42010-06-29 10:07:11 +02002542 wq->first_flusher = NULL;
2543
Tejun Heo6183c002013-03-12 11:29:57 -07002544 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2545 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002546
2547 while (true) {
2548 struct wq_flusher *next, *tmp;
2549
2550 /* complete all the flushers sharing the current flush color */
2551 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2552 if (next->flush_color != wq->flush_color)
2553 break;
2554 list_del_init(&next->list);
2555 complete(&next->done);
2556 }
2557
Tejun Heo6183c002013-03-12 11:29:57 -07002558 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2559 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002560
2561 /* this flush_color is finished, advance by one */
2562 wq->flush_color = work_next_color(wq->flush_color);
2563
2564 /* one color has been freed, handle overflow queue */
2565 if (!list_empty(&wq->flusher_overflow)) {
2566 /*
2567 * Assign the same color to all overflowed
2568 * flushers, advance work_color and append to
2569 * flusher_queue. This is the start-to-wait
2570 * phase for these overflowed flushers.
2571 */
2572 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2573 tmp->flush_color = wq->work_color;
2574
2575 wq->work_color = work_next_color(wq->work_color);
2576
2577 list_splice_tail_init(&wq->flusher_overflow,
2578 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002579 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002580 }
2581
2582 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002583 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002584 break;
2585 }
2586
2587 /*
2588 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002589 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002590 */
Tejun Heo6183c002013-03-12 11:29:57 -07002591 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2592 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002593
2594 list_del_init(&next->list);
2595 wq->first_flusher = next;
2596
Tejun Heo112202d2013-02-13 19:29:12 -08002597 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002598 break;
2599
2600 /*
2601 * Meh... this color is already done, clear first
2602 * flusher and repeat cascading.
2603 */
2604 wq->first_flusher = NULL;
2605 }
2606
2607out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002608 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609}
Dave Jonesae90dd52006-06-30 01:40:45 -04002610EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002611
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002612/**
2613 * drain_workqueue - drain a workqueue
2614 * @wq: workqueue to drain
2615 *
2616 * Wait until the workqueue becomes empty. While draining is in progress,
2617 * only chain queueing is allowed. IOW, only currently pending or running
2618 * work items on @wq can queue further work items on it. @wq is flushed
2619 * repeatedly until it becomes empty. The number of flushing is detemined
2620 * by the depth of chaining and should be relatively short. Whine if it
2621 * takes too long.
2622 */
2623void drain_workqueue(struct workqueue_struct *wq)
2624{
2625 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002626 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002627
2628 /*
2629 * __queue_work() needs to test whether there are drainers, is much
2630 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002631 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002632 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002633 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002634 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002635 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002636 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002637reflush:
2638 flush_workqueue(wq);
2639
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002640 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002641
Tejun Heo49e3cf42013-03-12 11:29:58 -07002642 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002643 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002644
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002645 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002646 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002647 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002648
2649 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002650 continue;
2651
2652 if (++flush_cnt == 10 ||
2653 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002654 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002655 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002656
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002657 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002658 goto reflush;
2659 }
2660
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002661 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002662 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002663 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002664}
2665EXPORT_SYMBOL_GPL(drain_workqueue);
2666
Tejun Heo606a5022012-08-20 14:51:23 -07002667static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002668{
2669 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002670 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002671 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002672
2673 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002674
Tejun Heofa1b54e2013-03-12 11:30:00 -07002675 local_irq_disable();
2676 pool = get_work_pool(work);
2677 if (!pool) {
2678 local_irq_enable();
2679 return false;
2680 }
2681
2682 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002683 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002684 pwq = get_work_pwq(work);
2685 if (pwq) {
2686 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002687 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002688 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002689 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002690 if (!worker)
2691 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002692 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002693 }
Tejun Heobaf59022010-09-16 10:42:16 +02002694
Tejun Heo112202d2013-02-13 19:29:12 -08002695 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002696 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002697
Tejun Heoe1594892011-01-09 23:32:15 +01002698 /*
2699 * If @max_active is 1 or rescuer is in use, flushing another work
2700 * item on the same workqueue may lead to deadlock. Make sure the
2701 * flusher is not running on the same workqueue by verifying write
2702 * access.
2703 */
Tejun Heo493008a2013-03-12 11:30:03 -07002704 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002705 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002706 else
Tejun Heo112202d2013-02-13 19:29:12 -08002707 lock_map_acquire_read(&pwq->wq->lockdep_map);
2708 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002709
Tejun Heobaf59022010-09-16 10:42:16 +02002710 return true;
2711already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002712 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002713 return false;
2714}
2715
Oleg Nesterovdb700892008-07-25 01:47:49 -07002716/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002717 * flush_work - wait for a work to finish executing the last queueing instance
2718 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002719 *
Tejun Heo606a5022012-08-20 14:51:23 -07002720 * Wait until @work has finished execution. @work is guaranteed to be idle
2721 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002722 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002723 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002724 * %true if flush_work() waited for the work to finish execution,
2725 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002726 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002727bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002728{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002729 struct wq_barrier barr;
2730
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002731 lock_map_acquire(&work->lockdep_map);
2732 lock_map_release(&work->lockdep_map);
2733
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002734 if (start_flush_work(work, &barr)) {
2735 wait_for_completion(&barr.done);
2736 destroy_work_on_stack(&barr.work);
2737 return true;
2738 } else {
2739 return false;
2740 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002741}
2742EXPORT_SYMBOL_GPL(flush_work);
2743
Tejun Heo8603e1b32015-03-05 08:04:13 -05002744struct cwt_wait {
2745 wait_queue_t wait;
2746 struct work_struct *work;
2747};
2748
2749static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2750{
2751 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2752
2753 if (cwait->work != key)
2754 return 0;
2755 return autoremove_wake_function(wait, mode, sync, key);
2756}
2757
Tejun Heo36e227d2012-08-03 10:30:46 -07002758static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002759{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002760 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002761 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002762 int ret;
2763
2764 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002765 ret = try_to_grab_pending(work, is_dwork, &flags);
2766 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002767 * If someone else is already canceling, wait for it to
2768 * finish. flush_work() doesn't work for PREEMPT_NONE
2769 * because we may get scheduled between @work's completion
2770 * and the other canceling task resuming and clearing
2771 * CANCELING - flush_work() will return false immediately
2772 * as @work is no longer busy, try_to_grab_pending() will
2773 * return -ENOENT as @work is still being canceled and the
2774 * other canceling task won't be able to clear CANCELING as
2775 * we're hogging the CPU.
2776 *
2777 * Let's wait for completion using a waitqueue. As this
2778 * may lead to the thundering herd problem, use a custom
2779 * wake function which matches @work along with exclusive
2780 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002781 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002782 if (unlikely(ret == -ENOENT)) {
2783 struct cwt_wait cwait;
2784
2785 init_wait(&cwait.wait);
2786 cwait.wait.func = cwt_wakefn;
2787 cwait.work = work;
2788
2789 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2790 TASK_UNINTERRUPTIBLE);
2791 if (work_is_canceling(work))
2792 schedule();
2793 finish_wait(&cancel_waitq, &cwait.wait);
2794 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002795 } while (unlikely(ret < 0));
2796
Tejun Heobbb68df2012-08-03 10:30:46 -07002797 /* tell other tasks trying to grab @work to back off */
2798 mark_work_canceling(work);
2799 local_irq_restore(flags);
2800
Tejun Heo606a5022012-08-20 14:51:23 -07002801 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002802 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002803
2804 /*
2805 * Paired with prepare_to_wait() above so that either
2806 * waitqueue_active() is visible here or !work_is_canceling() is
2807 * visible there.
2808 */
2809 smp_mb();
2810 if (waitqueue_active(&cancel_waitq))
2811 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2812
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002813 return ret;
2814}
2815
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002816/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002817 * cancel_work_sync - cancel a work and wait for it to finish
2818 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002819 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002820 * Cancel @work and wait for its execution to finish. This function
2821 * can be used even if the work re-queues itself or migrates to
2822 * another workqueue. On return from this function, @work is
2823 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002824 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002825 * cancel_work_sync(&delayed_work->work) must not be used for
2826 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002827 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002828 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002829 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002830 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002831 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002832 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002833 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002834bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002835{
Tejun Heo36e227d2012-08-03 10:30:46 -07002836 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002837}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002838EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002839
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002840/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002841 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2842 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002843 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002844 * Delayed timer is cancelled and the pending work is queued for
2845 * immediate execution. Like flush_work(), this function only
2846 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002847 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002848 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002849 * %true if flush_work() waited for the work to finish execution,
2850 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002851 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002852bool flush_delayed_work(struct delayed_work *dwork)
2853{
Tejun Heo8930cab2012-08-03 10:30:45 -07002854 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002855 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002856 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002857 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002858 return flush_work(&dwork->work);
2859}
2860EXPORT_SYMBOL(flush_delayed_work);
2861
2862/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002863 * cancel_delayed_work - cancel a delayed work
2864 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002865 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002866 * Kill off a pending delayed_work.
2867 *
2868 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2869 * pending.
2870 *
2871 * Note:
2872 * The work callback function may still be running on return, unless
2873 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2874 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002875 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002876 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002877 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002878bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002879{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002880 unsigned long flags;
2881 int ret;
2882
2883 do {
2884 ret = try_to_grab_pending(&dwork->work, true, &flags);
2885 } while (unlikely(ret == -EAGAIN));
2886
2887 if (unlikely(ret < 0))
2888 return false;
2889
Tejun Heo7c3eed52013-01-24 11:01:33 -08002890 set_work_pool_and_clear_pending(&dwork->work,
2891 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002892 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002893 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002894}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002895EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002896
2897/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002898 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2899 * @dwork: the delayed work cancel
2900 *
2901 * This is cancel_work_sync() for delayed works.
2902 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002903 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002904 * %true if @dwork was pending, %false otherwise.
2905 */
2906bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002907{
Tejun Heo36e227d2012-08-03 10:30:46 -07002908 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002909}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002910EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002912/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002913 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002914 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002915 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002916 * schedule_on_each_cpu() executes @func on each online CPU using the
2917 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002918 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002919 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002920 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02002921 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002922 */
David Howells65f27f32006-11-22 14:55:48 +00002923int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002924{
2925 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002926 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002927
Andrew Mortonb6136772006-06-25 05:47:49 -07002928 works = alloc_percpu(struct work_struct);
2929 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002930 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002931
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002932 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002933
Christoph Lameter15316ba2006-01-08 01:00:43 -08002934 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002935 struct work_struct *work = per_cpu_ptr(works, cpu);
2936
2937 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002938 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002939 }
Tejun Heo93981802009-11-17 14:06:20 -08002940
2941 for_each_online_cpu(cpu)
2942 flush_work(per_cpu_ptr(works, cpu));
2943
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002944 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002945 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002946 return 0;
2947}
2948
Alan Sterneef6a7d2010-02-12 17:39:21 +09002949/**
2950 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2951 *
2952 * Forces execution of the kernel-global workqueue and blocks until its
2953 * completion.
2954 *
2955 * Think twice before calling this function! It's very easy to get into
2956 * trouble if you don't take great care. Either of the following situations
2957 * will lead to deadlock:
2958 *
2959 * One of the work items currently on the workqueue needs to acquire
2960 * a lock held by your code or its caller.
2961 *
2962 * Your code is running in the context of a work routine.
2963 *
2964 * They will be detected by lockdep when they occur, but the first might not
2965 * occur very often. It depends on what work items are on the workqueue and
2966 * what locks they need, which you have no control over.
2967 *
2968 * In most situations flushing the entire workqueue is overkill; you merely
2969 * need to know that a particular work item isn't queued and isn't running.
2970 * In such cases you should use cancel_delayed_work_sync() or
2971 * cancel_work_sync() instead.
2972 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002973void flush_scheduled_work(void)
2974{
Tejun Heod320c032010-06-29 10:07:14 +02002975 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976}
Dave Jonesae90dd52006-06-30 01:40:45 -04002977EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978
2979/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002980 * execute_in_process_context - reliably execute the routine with user context
2981 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002982 * @ew: guaranteed storage for the execute work structure (must
2983 * be available when the work executes)
2984 *
2985 * Executes the function immediately if process context is available,
2986 * otherwise schedules the function for delayed execution.
2987 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002988 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06002989 * 1 - function was scheduled for execution
2990 */
David Howells65f27f32006-11-22 14:55:48 +00002991int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06002992{
2993 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00002994 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002995 return 0;
2996 }
2997
David Howells65f27f32006-11-22 14:55:48 +00002998 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002999 schedule_work(&ew->work);
3000
3001 return 1;
3002}
3003EXPORT_SYMBOL_GPL(execute_in_process_context);
3004
Tejun Heo7a4e3442013-03-12 11:30:00 -07003005/**
3006 * free_workqueue_attrs - free a workqueue_attrs
3007 * @attrs: workqueue_attrs to free
3008 *
3009 * Undo alloc_workqueue_attrs().
3010 */
3011void free_workqueue_attrs(struct workqueue_attrs *attrs)
3012{
3013 if (attrs) {
3014 free_cpumask_var(attrs->cpumask);
3015 kfree(attrs);
3016 }
3017}
3018
3019/**
3020 * alloc_workqueue_attrs - allocate a workqueue_attrs
3021 * @gfp_mask: allocation mask to use
3022 *
3023 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003024 * return it.
3025 *
3026 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003027 */
3028struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3029{
3030 struct workqueue_attrs *attrs;
3031
3032 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3033 if (!attrs)
3034 goto fail;
3035 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3036 goto fail;
3037
Tejun Heo13e2e552013-04-01 11:23:31 -07003038 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003039 return attrs;
3040fail:
3041 free_workqueue_attrs(attrs);
3042 return NULL;
3043}
3044
Tejun Heo29c91e92013-03-12 11:30:03 -07003045static void copy_workqueue_attrs(struct workqueue_attrs *to,
3046 const struct workqueue_attrs *from)
3047{
3048 to->nice = from->nice;
3049 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003050 /*
3051 * Unlike hash and equality test, this function doesn't ignore
3052 * ->no_numa as it is used for both pool and wq attrs. Instead,
3053 * get_unbound_pool() explicitly clears ->no_numa after copying.
3054 */
3055 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003056}
3057
Tejun Heo29c91e92013-03-12 11:30:03 -07003058/* hash value of the content of @attr */
3059static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3060{
3061 u32 hash = 0;
3062
3063 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003064 hash = jhash(cpumask_bits(attrs->cpumask),
3065 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003066 return hash;
3067}
3068
3069/* content equality test */
3070static bool wqattrs_equal(const struct workqueue_attrs *a,
3071 const struct workqueue_attrs *b)
3072{
3073 if (a->nice != b->nice)
3074 return false;
3075 if (!cpumask_equal(a->cpumask, b->cpumask))
3076 return false;
3077 return true;
3078}
3079
Tejun Heo7a4e3442013-03-12 11:30:00 -07003080/**
3081 * init_worker_pool - initialize a newly zalloc'd worker_pool
3082 * @pool: worker_pool to initialize
3083 *
3084 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003085 *
3086 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003087 * inside @pool proper are initialized and put_unbound_pool() can be called
3088 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003089 */
3090static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003091{
3092 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003093 pool->id = -1;
3094 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003095 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003096 pool->flags |= POOL_DISASSOCIATED;
3097 INIT_LIST_HEAD(&pool->worklist);
3098 INIT_LIST_HEAD(&pool->idle_list);
3099 hash_init(pool->busy_hash);
3100
3101 init_timer_deferrable(&pool->idle_timer);
3102 pool->idle_timer.function = idle_worker_timeout;
3103 pool->idle_timer.data = (unsigned long)pool;
3104
3105 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3106 (unsigned long)pool);
3107
3108 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003109 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003110 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003111
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003112 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003113 INIT_HLIST_NODE(&pool->hash_node);
3114 pool->refcnt = 1;
3115
3116 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003117 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3118 if (!pool->attrs)
3119 return -ENOMEM;
3120 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003121}
3122
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003123static void rcu_free_wq(struct rcu_head *rcu)
3124{
3125 struct workqueue_struct *wq =
3126 container_of(rcu, struct workqueue_struct, rcu);
3127
3128 if (!(wq->flags & WQ_UNBOUND))
3129 free_percpu(wq->cpu_pwqs);
3130 else
3131 free_workqueue_attrs(wq->unbound_attrs);
3132
3133 kfree(wq->rescuer);
3134 kfree(wq);
3135}
3136
Tejun Heo29c91e92013-03-12 11:30:03 -07003137static void rcu_free_pool(struct rcu_head *rcu)
3138{
3139 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3140
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003141 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003142 free_workqueue_attrs(pool->attrs);
3143 kfree(pool);
3144}
3145
3146/**
3147 * put_unbound_pool - put a worker_pool
3148 * @pool: worker_pool to put
3149 *
3150 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003151 * safe manner. get_unbound_pool() calls this function on its failure path
3152 * and this function should be able to release pools which went through,
3153 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003154 *
3155 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003156 */
3157static void put_unbound_pool(struct worker_pool *pool)
3158{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003159 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003160 struct worker *worker;
3161
Tejun Heoa892cac2013-04-01 11:23:32 -07003162 lockdep_assert_held(&wq_pool_mutex);
3163
3164 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003165 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003166
3167 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003168 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003169 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003170 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003171
3172 /* release id and unhash */
3173 if (pool->id >= 0)
3174 idr_remove(&worker_pool_idr, pool->id);
3175 hash_del(&pool->hash_node);
3176
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003177 /*
3178 * Become the manager and destroy all workers. Grabbing
3179 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003180 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003181 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003182 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003183
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003184 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003185 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003186 destroy_worker(worker);
3187 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003188 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003189
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003190 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003191 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003192 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003193 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003194
3195 if (pool->detach_completion)
3196 wait_for_completion(pool->detach_completion);
3197
Tejun Heo29c91e92013-03-12 11:30:03 -07003198 mutex_unlock(&pool->manager_arb);
3199
3200 /* shut down the timers */
3201 del_timer_sync(&pool->idle_timer);
3202 del_timer_sync(&pool->mayday_timer);
3203
3204 /* sched-RCU protected to allow dereferences from get_work_pool() */
3205 call_rcu_sched(&pool->rcu, rcu_free_pool);
3206}
3207
3208/**
3209 * get_unbound_pool - get a worker_pool with the specified attributes
3210 * @attrs: the attributes of the worker_pool to get
3211 *
3212 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3213 * reference count and return it. If there already is a matching
3214 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003215 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003216 *
3217 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003218 *
3219 * Return: On success, a worker_pool with the same attributes as @attrs.
3220 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003221 */
3222static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3223{
Tejun Heo29c91e92013-03-12 11:30:03 -07003224 u32 hash = wqattrs_hash(attrs);
3225 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003226 int node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003227
Tejun Heoa892cac2013-04-01 11:23:32 -07003228 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003229
3230 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003231 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3232 if (wqattrs_equal(pool->attrs, attrs)) {
3233 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003234 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003235 }
3236 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003237
3238 /* nope, create a new one */
3239 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3240 if (!pool || init_worker_pool(pool) < 0)
3241 goto fail;
3242
Tejun Heo8864b4e2013-03-12 11:30:04 -07003243 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003244 copy_workqueue_attrs(pool->attrs, attrs);
3245
Shaohua Li2865a8f2013-08-01 09:56:36 +08003246 /*
3247 * no_numa isn't a worker_pool attribute, always clear it. See
3248 * 'struct workqueue_attrs' comments for detail.
3249 */
3250 pool->attrs->no_numa = false;
3251
Tejun Heof3f90ad2013-04-01 11:23:34 -07003252 /* if cpumask is contained inside a NUMA node, we belong to that node */
3253 if (wq_numa_enabled) {
3254 for_each_node(node) {
3255 if (cpumask_subset(pool->attrs->cpumask,
3256 wq_numa_possible_cpumask[node])) {
3257 pool->node = node;
3258 break;
3259 }
3260 }
3261 }
3262
Tejun Heo29c91e92013-03-12 11:30:03 -07003263 if (worker_pool_assign_id(pool) < 0)
3264 goto fail;
3265
3266 /* create and start the initial worker */
Lai Jiangshan051e1852014-07-22 13:03:02 +08003267 if (!create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003268 goto fail;
3269
Tejun Heo29c91e92013-03-12 11:30:03 -07003270 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003271 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003272
Tejun Heo29c91e92013-03-12 11:30:03 -07003273 return pool;
3274fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003275 if (pool)
3276 put_unbound_pool(pool);
3277 return NULL;
3278}
3279
Tejun Heo8864b4e2013-03-12 11:30:04 -07003280static void rcu_free_pwq(struct rcu_head *rcu)
3281{
3282 kmem_cache_free(pwq_cache,
3283 container_of(rcu, struct pool_workqueue, rcu));
3284}
3285
3286/*
3287 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3288 * and needs to be destroyed.
3289 */
3290static void pwq_unbound_release_workfn(struct work_struct *work)
3291{
3292 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3293 unbound_release_work);
3294 struct workqueue_struct *wq = pwq->wq;
3295 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003296 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003297
3298 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3299 return;
3300
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003301 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003302 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003303 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003304 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003305
Tejun Heoa892cac2013-04-01 11:23:32 -07003306 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003307 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003308 mutex_unlock(&wq_pool_mutex);
3309
Tejun Heo8864b4e2013-03-12 11:30:04 -07003310 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3311
3312 /*
3313 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003314 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003315 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003316 if (is_last)
3317 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003318}
3319
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003320/**
Tejun Heo699ce092013-03-13 16:51:35 -07003321 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003322 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003323 *
Tejun Heo699ce092013-03-13 16:51:35 -07003324 * If @pwq isn't freezing, set @pwq->max_active to the associated
3325 * workqueue's saved_max_active and activate delayed work items
3326 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003327 */
Tejun Heo699ce092013-03-13 16:51:35 -07003328static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003329{
Tejun Heo699ce092013-03-13 16:51:35 -07003330 struct workqueue_struct *wq = pwq->wq;
3331 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003332
Tejun Heo699ce092013-03-13 16:51:35 -07003333 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003334 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003335
3336 /* fast exit for non-freezable wqs */
3337 if (!freezable && pwq->max_active == wq->saved_max_active)
3338 return;
3339
Lai Jiangshana357fc02013-03-25 16:57:19 -07003340 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003341
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003342 /*
3343 * During [un]freezing, the caller is responsible for ensuring that
3344 * this function is called at least once after @workqueue_freezing
3345 * is updated and visible.
3346 */
3347 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003348 pwq->max_active = wq->saved_max_active;
3349
3350 while (!list_empty(&pwq->delayed_works) &&
3351 pwq->nr_active < pwq->max_active)
3352 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003353
3354 /*
3355 * Need to kick a worker after thawed or an unbound wq's
3356 * max_active is bumped. It's a slow path. Do it always.
3357 */
3358 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003359 } else {
3360 pwq->max_active = 0;
3361 }
3362
Lai Jiangshana357fc02013-03-25 16:57:19 -07003363 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003364}
3365
Tejun Heoe50aba92013-04-01 11:23:35 -07003366/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003367static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3368 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003369{
3370 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3371
Tejun Heoe50aba92013-04-01 11:23:35 -07003372 memset(pwq, 0, sizeof(*pwq));
3373
Tejun Heod2c1d402013-03-12 11:30:04 -07003374 pwq->pool = pool;
3375 pwq->wq = wq;
3376 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003377 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003378 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003379 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003380 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003381 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003382}
Tejun Heod2c1d402013-03-12 11:30:04 -07003383
Tejun Heof147f292013-04-01 11:23:35 -07003384/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003385static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003386{
3387 struct workqueue_struct *wq = pwq->wq;
3388
3389 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003390
Tejun Heo1befcf32013-04-01 11:23:35 -07003391 /* may be called multiple times, ignore if already linked */
3392 if (!list_empty(&pwq->pwqs_node))
3393 return;
3394
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003395 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003396 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003397
3398 /* sync max_active to the current setting */
3399 pwq_adjust_max_active(pwq);
3400
3401 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003402 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003403}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003404
Tejun Heof147f292013-04-01 11:23:35 -07003405/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3406static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3407 const struct workqueue_attrs *attrs)
3408{
3409 struct worker_pool *pool;
3410 struct pool_workqueue *pwq;
3411
3412 lockdep_assert_held(&wq_pool_mutex);
3413
3414 pool = get_unbound_pool(attrs);
3415 if (!pool)
3416 return NULL;
3417
Tejun Heoe50aba92013-04-01 11:23:35 -07003418 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003419 if (!pwq) {
3420 put_unbound_pool(pool);
3421 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003422 }
Tejun Heo6029a912013-04-01 11:23:34 -07003423
Tejun Heof147f292013-04-01 11:23:35 -07003424 init_pwq(pwq, wq, pool);
3425 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003426}
3427
Tejun Heo4c16bd32013-04-01 11:23:36 -07003428/* undo alloc_unbound_pwq(), used only in the error path */
3429static void free_unbound_pwq(struct pool_workqueue *pwq)
3430{
3431 lockdep_assert_held(&wq_pool_mutex);
3432
3433 if (pwq) {
3434 put_unbound_pool(pwq->pool);
Wei Yongjuncece95d2013-04-09 14:29:11 +08003435 kmem_cache_free(pwq_cache, pwq);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003436 }
3437}
3438
3439/**
3440 * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node
3441 * @attrs: the wq_attrs of interest
3442 * @node: the target NUMA node
3443 * @cpu_going_down: if >= 0, the CPU to consider as offline
3444 * @cpumask: outarg, the resulting cpumask
3445 *
3446 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3447 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003448 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003449 *
3450 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3451 * enabled and @node has online CPUs requested by @attrs, the returned
3452 * cpumask is the intersection of the possible CPUs of @node and
3453 * @attrs->cpumask.
3454 *
3455 * The caller is responsible for ensuring that the cpumask of @node stays
3456 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003457 *
3458 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3459 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003460 */
3461static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3462 int cpu_going_down, cpumask_t *cpumask)
3463{
Tejun Heod55262c2013-04-01 11:23:38 -07003464 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003465 goto use_dfl;
3466
3467 /* does @node have any online CPUs @attrs wants? */
3468 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3469 if (cpu_going_down >= 0)
3470 cpumask_clear_cpu(cpu_going_down, cpumask);
3471
3472 if (cpumask_empty(cpumask))
3473 goto use_dfl;
3474
3475 /* yeap, return possible CPUs in @node that @attrs wants */
3476 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3477 return !cpumask_equal(cpumask, attrs->cpumask);
3478
3479use_dfl:
3480 cpumask_copy(cpumask, attrs->cpumask);
3481 return false;
3482}
3483
Tejun Heo1befcf32013-04-01 11:23:35 -07003484/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3485static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3486 int node,
3487 struct pool_workqueue *pwq)
3488{
3489 struct pool_workqueue *old_pwq;
3490
3491 lockdep_assert_held(&wq->mutex);
3492
3493 /* link_pwq() can handle duplicate calls */
3494 link_pwq(pwq);
3495
3496 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3497 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3498 return old_pwq;
3499}
3500
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003501/**
3502 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3503 * @wq: the target workqueue
3504 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3505 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003506 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3507 * machines, this function maps a separate pwq to each NUMA node with
3508 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3509 * NUMA node it was issued on. Older pwqs are released as in-flight work
3510 * items finish. Note that a work item which repeatedly requeues itself
3511 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003512 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003513 * Performs GFP_KERNEL allocations.
3514 *
3515 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003516 */
3517int apply_workqueue_attrs(struct workqueue_struct *wq,
3518 const struct workqueue_attrs *attrs)
3519{
Tejun Heo4c16bd32013-04-01 11:23:36 -07003520 struct workqueue_attrs *new_attrs, *tmp_attrs;
3521 struct pool_workqueue **pwq_tbl, *dfl_pwq;
Tejun Heof147f292013-04-01 11:23:35 -07003522 int node, ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003523
Tejun Heo8719dce2013-03-12 11:30:04 -07003524 /* only unbound workqueues can change attributes */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003525 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3526 return -EINVAL;
3527
Tejun Heo8719dce2013-03-12 11:30:04 -07003528 /* creating multiple pwqs breaks ordering guarantee */
3529 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3530 return -EINVAL;
3531
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003532 pwq_tbl = kzalloc(nr_node_ids * sizeof(pwq_tbl[0]), GFP_KERNEL);
Tejun Heo13e2e552013-04-01 11:23:31 -07003533 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003534 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3535 if (!pwq_tbl || !new_attrs || !tmp_attrs)
Tejun Heo13e2e552013-04-01 11:23:31 -07003536 goto enomem;
3537
Tejun Heo4c16bd32013-04-01 11:23:36 -07003538 /* make a copy of @attrs and sanitize it */
Tejun Heo13e2e552013-04-01 11:23:31 -07003539 copy_workqueue_attrs(new_attrs, attrs);
3540 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
3541
Tejun Heo4c16bd32013-04-01 11:23:36 -07003542 /*
3543 * We may create multiple pwqs with differing cpumasks. Make a
3544 * copy of @new_attrs which will be modified and used to obtain
3545 * pools.
3546 */
3547 copy_workqueue_attrs(tmp_attrs, new_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003548
Tejun Heo4c16bd32013-04-01 11:23:36 -07003549 /*
3550 * CPUs should stay stable across pwq creations and installations.
3551 * Pin CPUs, determine the target cpumask for each node and create
3552 * pwqs accordingly.
3553 */
3554 get_online_cpus();
3555
3556 mutex_lock(&wq_pool_mutex);
3557
3558 /*
3559 * If something goes wrong during CPU up/down, we'll fall back to
3560 * the default pwq covering whole @attrs->cpumask. Always create
3561 * it even if we don't use it immediately.
3562 */
3563 dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3564 if (!dfl_pwq)
3565 goto enomem_pwq;
3566
3567 for_each_node(node) {
3568 if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) {
3569 pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3570 if (!pwq_tbl[node])
3571 goto enomem_pwq;
3572 } else {
3573 dfl_pwq->refcnt++;
3574 pwq_tbl[node] = dfl_pwq;
3575 }
3576 }
3577
3578 mutex_unlock(&wq_pool_mutex);
3579
3580 /* all pwqs have been created successfully, let's install'em */
Tejun Heof147f292013-04-01 11:23:35 -07003581 mutex_lock(&wq->mutex);
3582
Tejun Heof147f292013-04-01 11:23:35 -07003583 copy_workqueue_attrs(wq->unbound_attrs, new_attrs);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003584
3585 /* save the previous pwq and install the new one */
Tejun Heof147f292013-04-01 11:23:35 -07003586 for_each_node(node)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003587 pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]);
3588
3589 /* @dfl_pwq might not have been used, ensure it's linked */
3590 link_pwq(dfl_pwq);
3591 swap(wq->dfl_pwq, dfl_pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003592
3593 mutex_unlock(&wq->mutex);
3594
Tejun Heo4c16bd32013-04-01 11:23:36 -07003595 /* put the old pwqs */
3596 for_each_node(node)
3597 put_pwq_unlocked(pwq_tbl[node]);
3598 put_pwq_unlocked(dfl_pwq);
3599
3600 put_online_cpus();
Tejun Heo48621252013-04-01 11:23:31 -07003601 ret = 0;
3602 /* fall through */
3603out_free:
Tejun Heo4c16bd32013-04-01 11:23:36 -07003604 free_workqueue_attrs(tmp_attrs);
Tejun Heo48621252013-04-01 11:23:31 -07003605 free_workqueue_attrs(new_attrs);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003606 kfree(pwq_tbl);
Tejun Heo48621252013-04-01 11:23:31 -07003607 return ret;
Tejun Heo13e2e552013-04-01 11:23:31 -07003608
Tejun Heo4c16bd32013-04-01 11:23:36 -07003609enomem_pwq:
3610 free_unbound_pwq(dfl_pwq);
3611 for_each_node(node)
3612 if (pwq_tbl && pwq_tbl[node] != dfl_pwq)
3613 free_unbound_pwq(pwq_tbl[node]);
3614 mutex_unlock(&wq_pool_mutex);
3615 put_online_cpus();
Tejun Heo13e2e552013-04-01 11:23:31 -07003616enomem:
Tejun Heo48621252013-04-01 11:23:31 -07003617 ret = -ENOMEM;
3618 goto out_free;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003619}
3620
Tejun Heo4c16bd32013-04-01 11:23:36 -07003621/**
3622 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3623 * @wq: the target workqueue
3624 * @cpu: the CPU coming up or going down
3625 * @online: whether @cpu is coming up or going down
3626 *
3627 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3628 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3629 * @wq accordingly.
3630 *
3631 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3632 * falls back to @wq->dfl_pwq which may not be optimal but is always
3633 * correct.
3634 *
3635 * Note that when the last allowed CPU of a NUMA node goes offline for a
3636 * workqueue with a cpumask spanning multiple nodes, the workers which were
3637 * already executing the work items for the workqueue will lose their CPU
3638 * affinity and may execute on any CPU. This is similar to how per-cpu
3639 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3640 * affinity, it's the user's responsibility to flush the work item from
3641 * CPU_DOWN_PREPARE.
3642 */
3643static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3644 bool online)
3645{
3646 int node = cpu_to_node(cpu);
3647 int cpu_off = online ? -1 : cpu;
3648 struct pool_workqueue *old_pwq = NULL, *pwq;
3649 struct workqueue_attrs *target_attrs;
3650 cpumask_t *cpumask;
3651
3652 lockdep_assert_held(&wq_pool_mutex);
3653
3654 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
3655 return;
3656
3657 /*
3658 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3659 * Let's use a preallocated one. The following buf is protected by
3660 * CPU hotplug exclusion.
3661 */
3662 target_attrs = wq_update_unbound_numa_attrs_buf;
3663 cpumask = target_attrs->cpumask;
3664
3665 mutex_lock(&wq->mutex);
Tejun Heod55262c2013-04-01 11:23:38 -07003666 if (wq->unbound_attrs->no_numa)
3667 goto out_unlock;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003668
3669 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3670 pwq = unbound_pwq_by_node(wq, node);
3671
3672 /*
3673 * Let's determine what needs to be done. If the target cpumask is
3674 * different from wq's, we need to compare it to @pwq's and create
3675 * a new one if they don't match. If the target cpumask equals
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003676 * wq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003677 */
3678 if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) {
3679 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
3680 goto out_unlock;
3681 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003682 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003683 }
3684
3685 mutex_unlock(&wq->mutex);
3686
3687 /* create a new pwq */
3688 pwq = alloc_unbound_pwq(wq, target_attrs);
3689 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003690 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3691 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003692 mutex_lock(&wq->mutex);
3693 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003694 }
3695
3696 /*
3697 * Install the new pwq. As this function is called only from CPU
3698 * hotplug callbacks and applying a new attrs is wrapped with
3699 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
3700 * inbetween.
3701 */
3702 mutex_lock(&wq->mutex);
3703 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3704 goto out_unlock;
3705
3706use_dfl_pwq:
3707 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3708 get_pwq(wq->dfl_pwq);
3709 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3710 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3711out_unlock:
3712 mutex_unlock(&wq->mutex);
3713 put_pwq_unlocked(old_pwq);
3714}
3715
Tejun Heo30cdf242013-03-12 11:29:57 -07003716static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003717{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003718 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003719 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003720
Tejun Heo30cdf242013-03-12 11:29:57 -07003721 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003722 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3723 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003724 return -ENOMEM;
3725
3726 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003727 struct pool_workqueue *pwq =
3728 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003729 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003730 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003731
Tejun Heof147f292013-04-01 11:23:35 -07003732 init_pwq(pwq, wq, &cpu_pools[highpri]);
3733
3734 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003735 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003736 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003737 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003738 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003739 } else if (wq->flags & __WQ_ORDERED) {
3740 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3741 /* there should only be single pwq for ordering guarantee */
3742 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3743 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3744 "ordering guarantee broken for workqueue %s\n", wq->name);
3745 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003746 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003747 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003748 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003749}
3750
Tejun Heof3421792010-07-02 10:03:51 +02003751static int wq_clamp_max_active(int max_active, unsigned int flags,
3752 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003753{
Tejun Heof3421792010-07-02 10:03:51 +02003754 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3755
3756 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003757 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3758 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003759
Tejun Heof3421792010-07-02 10:03:51 +02003760 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003761}
3762
Tejun Heob196be82012-01-10 15:11:35 -08003763struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003764 unsigned int flags,
3765 int max_active,
3766 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003767 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003768{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003769 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003770 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003771 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003772 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003773
Viresh Kumarcee22a12013-04-08 16:45:40 +05303774 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3775 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3776 flags |= WQ_UNBOUND;
3777
Tejun Heoecf68812013-04-01 11:23:34 -07003778 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003779 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003780 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003781
3782 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003783 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003784 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003785
Tejun Heo6029a912013-04-01 11:23:34 -07003786 if (flags & WQ_UNBOUND) {
3787 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3788 if (!wq->unbound_attrs)
3789 goto err_free_wq;
3790 }
3791
Tejun Heoecf68812013-04-01 11:23:34 -07003792 va_start(args, lock_name);
3793 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003794 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003795
Tejun Heod320c032010-06-29 10:07:14 +02003796 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003797 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003798
Tejun Heob196be82012-01-10 15:11:35 -08003799 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003800 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003801 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003802 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003803 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003804 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003805 INIT_LIST_HEAD(&wq->flusher_queue);
3806 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003807 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003808
Johannes Bergeb13ba82008-01-16 09:51:58 +01003809 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003810 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003811
Tejun Heo30cdf242013-03-12 11:29:57 -07003812 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07003813 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003814
Tejun Heo493008a2013-03-12 11:30:03 -07003815 /*
3816 * Workqueues which may be used during memory reclaim should
3817 * have a rescuer to guarantee forward progress.
3818 */
3819 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003820 struct worker *rescuer;
3821
Lai Jiangshanf7537df2014-07-15 17:24:15 +08003822 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003823 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07003824 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02003825
Tejun Heo111c2252013-01-17 17:16:24 -08003826 rescuer->rescue_wq = wq;
3827 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003828 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07003829 if (IS_ERR(rescuer->task)) {
3830 kfree(rescuer);
3831 goto err_destroy;
3832 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003833
Tejun Heod2c1d402013-03-12 11:30:04 -07003834 wq->rescuer = rescuer;
Tejun Heo14a40ff2013-03-19 13:45:20 -07003835 rescuer->task->flags |= PF_NO_SETAFFINITY;
Tejun Heoe22bee72010-06-29 10:07:14 +02003836 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003837 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003838
Tejun Heo226223a2013-03-12 11:30:05 -07003839 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3840 goto err_destroy;
3841
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003842 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003843 * wq_pool_mutex protects global freeze state and workqueues list.
3844 * Grab it, adjust max_active and add the new @wq to workqueues
3845 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003846 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003847 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003848
Lai Jiangshana357fc02013-03-25 16:57:19 -07003849 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003850 for_each_pwq(pwq, wq)
3851 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07003852 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003853
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003854 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003855
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003856 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02003857
Oleg Nesterov3af244332007-05-09 02:34:09 -07003858 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003859
3860err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07003861 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07003862 kfree(wq);
3863 return NULL;
3864err_destroy:
3865 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003866 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003867}
Tejun Heod320c032010-06-29 10:07:14 +02003868EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003869
3870/**
3871 * destroy_workqueue - safely terminate a workqueue
3872 * @wq: target workqueue
3873 *
3874 * Safely destroy a workqueue. All work currently pending will be done first.
3875 */
3876void destroy_workqueue(struct workqueue_struct *wq)
3877{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003878 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003879 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003880
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003881 /* drain it before proceeding with destruction */
3882 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003883
Tejun Heo6183c002013-03-12 11:29:57 -07003884 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003885 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07003886 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07003887 int i;
3888
Tejun Heo76af4d92013-03-12 11:30:00 -07003889 for (i = 0; i < WORK_NR_COLORS; i++) {
3890 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003891 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003892 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003893 }
3894 }
3895
Lai Jiangshan5c529592013-04-04 10:05:38 +08003896 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07003897 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07003898 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003899 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003900 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003901 }
Tejun Heo6183c002013-03-12 11:29:57 -07003902 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003903 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003904
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003905 /*
3906 * wq list is used to freeze wq, remove from list after
3907 * flushing is complete in case freeze races us.
3908 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003909 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003910 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003911 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003912
Tejun Heo226223a2013-03-12 11:30:05 -07003913 workqueue_sysfs_unregister(wq);
3914
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003915 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02003916 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02003917
Tejun Heo8864b4e2013-03-12 11:30:04 -07003918 if (!(wq->flags & WQ_UNBOUND)) {
3919 /*
3920 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003921 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003922 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003923 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003924 } else {
3925 /*
3926 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07003927 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
3928 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003929 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003930 for_each_node(node) {
3931 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3932 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
3933 put_pwq_unlocked(pwq);
3934 }
3935
3936 /*
3937 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
3938 * put. Don't access it afterwards.
3939 */
3940 pwq = wq->dfl_pwq;
3941 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07003942 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07003943 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003944}
3945EXPORT_SYMBOL_GPL(destroy_workqueue);
3946
Tejun Heodcd989c2010-06-29 10:07:14 +02003947/**
3948 * workqueue_set_max_active - adjust max_active of a workqueue
3949 * @wq: target workqueue
3950 * @max_active: new max_active value.
3951 *
3952 * Set max_active of @wq to @max_active.
3953 *
3954 * CONTEXT:
3955 * Don't call from IRQ context.
3956 */
3957void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3958{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003959 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02003960
Tejun Heo8719dce2013-03-12 11:30:04 -07003961 /* disallow meddling with max_active for ordered workqueues */
3962 if (WARN_ON(wq->flags & __WQ_ORDERED))
3963 return;
3964
Tejun Heof3421792010-07-02 10:03:51 +02003965 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003966
Lai Jiangshana357fc02013-03-25 16:57:19 -07003967 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02003968
3969 wq->saved_max_active = max_active;
3970
Tejun Heo699ce092013-03-13 16:51:35 -07003971 for_each_pwq(pwq, wq)
3972 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02003973
Lai Jiangshana357fc02013-03-25 16:57:19 -07003974 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02003975}
3976EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3977
3978/**
Tejun Heoe62676162013-03-12 17:41:37 -07003979 * current_is_workqueue_rescuer - is %current workqueue rescuer?
3980 *
3981 * Determine whether %current is a workqueue rescuer. Can be used from
3982 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07003983 *
3984 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07003985 */
3986bool current_is_workqueue_rescuer(void)
3987{
3988 struct worker *worker = current_wq_worker();
3989
Lai Jiangshan6a092df2013-03-20 03:28:03 +08003990 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07003991}
3992
3993/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003994 * workqueue_congested - test whether a workqueue is congested
3995 * @cpu: CPU in question
3996 * @wq: target workqueue
3997 *
3998 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3999 * no synchronization around this function and the test result is
4000 * unreliable and only useful as advisory hints or for debugging.
4001 *
Tejun Heod3251852013-05-10 11:10:17 -07004002 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4003 * Note that both per-cpu and unbound workqueues may be associated with
4004 * multiple pool_workqueues which have separate congested states. A
4005 * workqueue being congested on one CPU doesn't mean the workqueue is also
4006 * contested on other CPUs / NUMA nodes.
4007 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004008 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004009 * %true if congested, %false otherwise.
4010 */
Tejun Heod84ff052013-03-12 11:29:59 -07004011bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004012{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004013 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004014 bool ret;
4015
Lai Jiangshan88109452013-03-20 03:28:10 +08004016 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004017
Tejun Heod3251852013-05-10 11:10:17 -07004018 if (cpu == WORK_CPU_UNBOUND)
4019 cpu = smp_processor_id();
4020
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004021 if (!(wq->flags & WQ_UNBOUND))
4022 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4023 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004024 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004025
Tejun Heo76af4d92013-03-12 11:30:00 -07004026 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004027 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004028
4029 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004030}
4031EXPORT_SYMBOL_GPL(workqueue_congested);
4032
4033/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004034 * work_busy - test whether a work is currently pending or running
4035 * @work: the work to be tested
4036 *
4037 * Test whether @work is currently pending or running. There is no
4038 * synchronization around this function and the test result is
4039 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004040 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004041 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004042 * OR'd bitmask of WORK_BUSY_* bits.
4043 */
4044unsigned int work_busy(struct work_struct *work)
4045{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004046 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004047 unsigned long flags;
4048 unsigned int ret = 0;
4049
Tejun Heodcd989c2010-06-29 10:07:14 +02004050 if (work_pending(work))
4051 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004052
Tejun Heofa1b54e2013-03-12 11:30:00 -07004053 local_irq_save(flags);
4054 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004055 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004056 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004057 if (find_worker_executing_work(pool, work))
4058 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004059 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004060 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004061 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004062
4063 return ret;
4064}
4065EXPORT_SYMBOL_GPL(work_busy);
4066
Tejun Heo3d1cb202013-04-30 15:27:22 -07004067/**
4068 * set_worker_desc - set description for the current work item
4069 * @fmt: printf-style format string
4070 * @...: arguments for the format string
4071 *
4072 * This function can be called by a running work function to describe what
4073 * the work item is about. If the worker task gets dumped, this
4074 * information will be printed out together to help debugging. The
4075 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4076 */
4077void set_worker_desc(const char *fmt, ...)
4078{
4079 struct worker *worker = current_wq_worker();
4080 va_list args;
4081
4082 if (worker) {
4083 va_start(args, fmt);
4084 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4085 va_end(args);
4086 worker->desc_valid = true;
4087 }
4088}
4089
4090/**
4091 * print_worker_info - print out worker information and description
4092 * @log_lvl: the log level to use when printing
4093 * @task: target task
4094 *
4095 * If @task is a worker and currently executing a work item, print out the
4096 * name of the workqueue being serviced and worker description set with
4097 * set_worker_desc() by the currently executing work item.
4098 *
4099 * This function can be safely called on any task as long as the
4100 * task_struct itself is accessible. While safe, this function isn't
4101 * synchronized and may print out mixups or garbages of limited length.
4102 */
4103void print_worker_info(const char *log_lvl, struct task_struct *task)
4104{
4105 work_func_t *fn = NULL;
4106 char name[WQ_NAME_LEN] = { };
4107 char desc[WORKER_DESC_LEN] = { };
4108 struct pool_workqueue *pwq = NULL;
4109 struct workqueue_struct *wq = NULL;
4110 bool desc_valid = false;
4111 struct worker *worker;
4112
4113 if (!(task->flags & PF_WQ_WORKER))
4114 return;
4115
4116 /*
4117 * This function is called without any synchronization and @task
4118 * could be in any state. Be careful with dereferences.
4119 */
4120 worker = probe_kthread_data(task);
4121
4122 /*
4123 * Carefully copy the associated workqueue's workfn and name. Keep
4124 * the original last '\0' in case the original contains garbage.
4125 */
4126 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4127 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4128 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4129 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4130
4131 /* copy worker description */
4132 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4133 if (desc_valid)
4134 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4135
4136 if (fn || name[0] || desc[0]) {
4137 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4138 if (desc[0])
4139 pr_cont(" (%s)", desc);
4140 pr_cont("\n");
4141 }
4142}
4143
Tejun Heo3494fc32015-03-09 09:22:28 -04004144static void pr_cont_pool_info(struct worker_pool *pool)
4145{
4146 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4147 if (pool->node != NUMA_NO_NODE)
4148 pr_cont(" node=%d", pool->node);
4149 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4150}
4151
4152static void pr_cont_work(bool comma, struct work_struct *work)
4153{
4154 if (work->func == wq_barrier_func) {
4155 struct wq_barrier *barr;
4156
4157 barr = container_of(work, struct wq_barrier, work);
4158
4159 pr_cont("%s BAR(%d)", comma ? "," : "",
4160 task_pid_nr(barr->task));
4161 } else {
4162 pr_cont("%s %pf", comma ? "," : "", work->func);
4163 }
4164}
4165
4166static void show_pwq(struct pool_workqueue *pwq)
4167{
4168 struct worker_pool *pool = pwq->pool;
4169 struct work_struct *work;
4170 struct worker *worker;
4171 bool has_in_flight = false, has_pending = false;
4172 int bkt;
4173
4174 pr_info(" pwq %d:", pool->id);
4175 pr_cont_pool_info(pool);
4176
4177 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4178 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4179
4180 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4181 if (worker->current_pwq == pwq) {
4182 has_in_flight = true;
4183 break;
4184 }
4185 }
4186 if (has_in_flight) {
4187 bool comma = false;
4188
4189 pr_info(" in-flight:");
4190 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4191 if (worker->current_pwq != pwq)
4192 continue;
4193
4194 pr_cont("%s %d%s:%pf", comma ? "," : "",
4195 task_pid_nr(worker->task),
4196 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4197 worker->current_func);
4198 list_for_each_entry(work, &worker->scheduled, entry)
4199 pr_cont_work(false, work);
4200 comma = true;
4201 }
4202 pr_cont("\n");
4203 }
4204
4205 list_for_each_entry(work, &pool->worklist, entry) {
4206 if (get_work_pwq(work) == pwq) {
4207 has_pending = true;
4208 break;
4209 }
4210 }
4211 if (has_pending) {
4212 bool comma = false;
4213
4214 pr_info(" pending:");
4215 list_for_each_entry(work, &pool->worklist, entry) {
4216 if (get_work_pwq(work) != pwq)
4217 continue;
4218
4219 pr_cont_work(comma, work);
4220 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4221 }
4222 pr_cont("\n");
4223 }
4224
4225 if (!list_empty(&pwq->delayed_works)) {
4226 bool comma = false;
4227
4228 pr_info(" delayed:");
4229 list_for_each_entry(work, &pwq->delayed_works, entry) {
4230 pr_cont_work(comma, work);
4231 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4232 }
4233 pr_cont("\n");
4234 }
4235}
4236
4237/**
4238 * show_workqueue_state - dump workqueue state
4239 *
4240 * Called from a sysrq handler and prints out all busy workqueues and
4241 * pools.
4242 */
4243void show_workqueue_state(void)
4244{
4245 struct workqueue_struct *wq;
4246 struct worker_pool *pool;
4247 unsigned long flags;
4248 int pi;
4249
4250 rcu_read_lock_sched();
4251
4252 pr_info("Showing busy workqueues and worker pools:\n");
4253
4254 list_for_each_entry_rcu(wq, &workqueues, list) {
4255 struct pool_workqueue *pwq;
4256 bool idle = true;
4257
4258 for_each_pwq(pwq, wq) {
4259 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4260 idle = false;
4261 break;
4262 }
4263 }
4264 if (idle)
4265 continue;
4266
4267 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4268
4269 for_each_pwq(pwq, wq) {
4270 spin_lock_irqsave(&pwq->pool->lock, flags);
4271 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4272 show_pwq(pwq);
4273 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4274 }
4275 }
4276
4277 for_each_pool(pool, pi) {
4278 struct worker *worker;
4279 bool first = true;
4280
4281 spin_lock_irqsave(&pool->lock, flags);
4282 if (pool->nr_workers == pool->nr_idle)
4283 goto next_pool;
4284
4285 pr_info("pool %d:", pool->id);
4286 pr_cont_pool_info(pool);
4287 pr_cont(" workers=%d", pool->nr_workers);
4288 if (pool->manager)
4289 pr_cont(" manager: %d",
4290 task_pid_nr(pool->manager->task));
4291 list_for_each_entry(worker, &pool->idle_list, entry) {
4292 pr_cont(" %s%d", first ? "idle: " : "",
4293 task_pid_nr(worker->task));
4294 first = false;
4295 }
4296 pr_cont("\n");
4297 next_pool:
4298 spin_unlock_irqrestore(&pool->lock, flags);
4299 }
4300
4301 rcu_read_unlock_sched();
4302}
4303
Tejun Heodb7bccf2010-06-29 10:07:12 +02004304/*
4305 * CPU hotplug.
4306 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004307 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004308 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004309 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004310 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004311 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004312 * blocked draining impractical.
4313 *
Tejun Heo24647572013-01-24 11:01:33 -08004314 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004315 * running as an unbound one and allowing it to be reattached later if the
4316 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004317 */
4318
Tejun Heo706026c2013-01-24 11:01:34 -08004319static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004320{
Tejun Heo38db41d2013-01-24 11:01:34 -08004321 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004322 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004323 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004324
Tejun Heof02ae732013-03-12 11:30:03 -07004325 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004326 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004327 spin_lock_irq(&pool->lock);
4328
4329 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004330 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004331 * unbound and set DISASSOCIATED. Before this, all workers
4332 * except for the ones which are still executing works from
4333 * before the last CPU down must be on the cpu. After
4334 * this, they may become diasporas.
4335 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004336 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004337 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004338
Tejun Heo24647572013-01-24 11:01:33 -08004339 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004340
Tejun Heo94cf58b2013-01-24 11:01:33 -08004341 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004342 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004343
Lai Jiangshaneb283422013-03-08 15:18:28 -08004344 /*
4345 * Call schedule() so that we cross rq->lock and thus can
4346 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4347 * This is necessary as scheduler callbacks may be invoked
4348 * from other cpus.
4349 */
4350 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004351
Lai Jiangshaneb283422013-03-08 15:18:28 -08004352 /*
4353 * Sched callbacks are disabled now. Zap nr_running.
4354 * After this, nr_running stays zero and need_more_worker()
4355 * and keep_working() are always true as long as the
4356 * worklist is not empty. This pool now behaves as an
4357 * unbound (in terms of concurrency management) pool which
4358 * are served by workers tied to the pool.
4359 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004360 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004361
4362 /*
4363 * With concurrency management just turned off, a busy
4364 * worker blocking could lead to lengthy stalls. Kick off
4365 * unbound chain execution of currently pending work items.
4366 */
4367 spin_lock_irq(&pool->lock);
4368 wake_up_worker(pool);
4369 spin_unlock_irq(&pool->lock);
4370 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004371}
4372
Tejun Heobd7c0892013-03-19 13:45:21 -07004373/**
4374 * rebind_workers - rebind all workers of a pool to the associated CPU
4375 * @pool: pool of interest
4376 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004377 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004378 */
4379static void rebind_workers(struct worker_pool *pool)
4380{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004381 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004382
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004383 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004384
Tejun Heoa9ab7752013-03-19 13:45:21 -07004385 /*
4386 * Restore CPU affinity of all workers. As all idle workers should
4387 * be on the run-queue of the associated CPU before any local
4388 * wake-ups for concurrency management happen, restore CPU affinty
4389 * of all workers first and then clear UNBOUND. As we're called
4390 * from CPU_ONLINE, the following shouldn't fail.
4391 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004392 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004393 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4394 pool->attrs->cpumask) < 0);
4395
4396 spin_lock_irq(&pool->lock);
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004397 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004398
Lai Jiangshanda028462014-05-20 17:46:31 +08004399 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004400 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004401
4402 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004403 * A bound idle worker should actually be on the runqueue
4404 * of the associated CPU for local wake-ups targeting it to
4405 * work. Kick all idle workers so that they migrate to the
4406 * associated CPU. Doing this in the same loop as
4407 * replacing UNBOUND with REBOUND is safe as no worker will
4408 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004409 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004410 if (worker_flags & WORKER_IDLE)
4411 wake_up_process(worker->task);
4412
4413 /*
4414 * We want to clear UNBOUND but can't directly call
4415 * worker_clr_flags() or adjust nr_running. Atomically
4416 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4417 * @worker will clear REBOUND using worker_clr_flags() when
4418 * it initiates the next execution cycle thus restoring
4419 * concurrency management. Note that when or whether
4420 * @worker clears REBOUND doesn't affect correctness.
4421 *
4422 * ACCESS_ONCE() is necessary because @worker->flags may be
4423 * tested without holding any lock in
4424 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4425 * fail incorrectly leading to premature concurrency
4426 * management operations.
4427 */
4428 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4429 worker_flags |= WORKER_REBOUND;
4430 worker_flags &= ~WORKER_UNBOUND;
4431 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004432 }
4433
Tejun Heoa9ab7752013-03-19 13:45:21 -07004434 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004435}
4436
Tejun Heo7dbc7252013-03-19 13:45:21 -07004437/**
4438 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4439 * @pool: unbound pool of interest
4440 * @cpu: the CPU which is coming up
4441 *
4442 * An unbound pool may end up with a cpumask which doesn't have any online
4443 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4444 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4445 * online CPU before, cpus_allowed of all its workers should be restored.
4446 */
4447static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4448{
4449 static cpumask_t cpumask;
4450 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004451
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004452 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004453
4454 /* is @cpu allowed for @pool? */
4455 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4456 return;
4457
4458 /* is @cpu the only online CPU? */
4459 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4460 if (cpumask_weight(&cpumask) != 1)
4461 return;
4462
4463 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004464 for_each_pool_worker(worker, pool)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004465 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4466 pool->attrs->cpumask) < 0);
4467}
4468
Tejun Heo8db25e72012-07-17 12:39:28 -07004469/*
4470 * Workqueues should be brought up before normal priority CPU notifiers.
4471 * This will be registered high priority CPU notifier.
4472 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004473static int workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004474 unsigned long action,
4475 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004476{
Tejun Heod84ff052013-03-12 11:29:59 -07004477 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004478 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004479 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004480 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004481
Tejun Heo8db25e72012-07-17 12:39:28 -07004482 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004483 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004484 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004485 if (pool->nr_workers)
4486 continue;
Lai Jiangshan051e1852014-07-22 13:03:02 +08004487 if (!create_worker(pool))
Tejun Heo3ce63372012-07-17 12:39:27 -07004488 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004489 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004490 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004491
Tejun Heo65758202012-07-17 12:39:26 -07004492 case CPU_DOWN_FAILED:
4493 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004494 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004495
4496 for_each_pool(pool, pi) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004497 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004498
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004499 if (pool->cpu == cpu)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004500 rebind_workers(pool);
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004501 else if (pool->cpu < 0)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004502 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004503
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004504 mutex_unlock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004505 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004506
Tejun Heo4c16bd32013-04-01 11:23:36 -07004507 /* update NUMA affinity of unbound workqueues */
4508 list_for_each_entry(wq, &workqueues, list)
4509 wq_update_unbound_numa(wq, cpu, true);
4510
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004511 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004512 break;
Tejun Heo65758202012-07-17 12:39:26 -07004513 }
4514 return NOTIFY_OK;
4515}
4516
4517/*
4518 * Workqueues should be brought down after normal priority CPU notifiers.
4519 * This will be registered as low priority CPU notifier.
4520 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004521static int workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004522 unsigned long action,
4523 void *hcpu)
4524{
Tejun Heod84ff052013-03-12 11:29:59 -07004525 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004526 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004527 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004528
Tejun Heo65758202012-07-17 12:39:26 -07004529 switch (action & ~CPU_TASKS_FROZEN) {
4530 case CPU_DOWN_PREPARE:
Tejun Heo4c16bd32013-04-01 11:23:36 -07004531 /* unbinding per-cpu workers should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004532 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004533 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004534
4535 /* update NUMA affinity of unbound workqueues */
4536 mutex_lock(&wq_pool_mutex);
4537 list_for_each_entry(wq, &workqueues, list)
4538 wq_update_unbound_numa(wq, cpu, false);
4539 mutex_unlock(&wq_pool_mutex);
4540
4541 /* wait for per-cpu unbinding to finish */
Tejun Heo8db25e72012-07-17 12:39:28 -07004542 flush_work(&unbind_work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004543 destroy_work_on_stack(&unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004544 break;
Tejun Heo65758202012-07-17 12:39:26 -07004545 }
4546 return NOTIFY_OK;
4547}
4548
Rusty Russell2d3854a2008-11-05 13:39:10 +11004549#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004550
Rusty Russell2d3854a2008-11-05 13:39:10 +11004551struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004552 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004553 long (*fn)(void *);
4554 void *arg;
4555 long ret;
4556};
4557
Tejun Heoed48ece2012-09-18 12:48:43 -07004558static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004559{
Tejun Heoed48ece2012-09-18 12:48:43 -07004560 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4561
Rusty Russell2d3854a2008-11-05 13:39:10 +11004562 wfc->ret = wfc->fn(wfc->arg);
4563}
4564
4565/**
4566 * work_on_cpu - run a function in user context on a particular cpu
4567 * @cpu: the cpu to run on
4568 * @fn: the function to run
4569 * @arg: the function arg
4570 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004571 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06004572 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004573 *
4574 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004575 */
Tejun Heod84ff052013-03-12 11:29:59 -07004576long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004577{
Tejun Heoed48ece2012-09-18 12:48:43 -07004578 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004579
Tejun Heoed48ece2012-09-18 12:48:43 -07004580 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4581 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004582 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004583 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004584 return wfc.ret;
4585}
4586EXPORT_SYMBOL_GPL(work_on_cpu);
4587#endif /* CONFIG_SMP */
4588
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004589#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304590
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004591/**
4592 * freeze_workqueues_begin - begin freezing workqueues
4593 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004594 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004595 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004596 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004597 *
4598 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004599 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004600 */
4601void freeze_workqueues_begin(void)
4602{
Tejun Heo24b8a842013-03-12 11:29:58 -07004603 struct workqueue_struct *wq;
4604 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004605
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004606 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004607
Tejun Heo6183c002013-03-12 11:29:57 -07004608 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004609 workqueue_freezing = true;
4610
Tejun Heo24b8a842013-03-12 11:29:58 -07004611 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004612 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004613 for_each_pwq(pwq, wq)
4614 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004615 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004616 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004617
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004618 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004619}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004620
4621/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004622 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004623 *
4624 * Check whether freezing is complete. This function must be called
4625 * between freeze_workqueues_begin() and thaw_workqueues().
4626 *
4627 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004628 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004629 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004630 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004631 * %true if some freezable workqueues are still busy. %false if freezing
4632 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004633 */
4634bool freeze_workqueues_busy(void)
4635{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004636 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004637 struct workqueue_struct *wq;
4638 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004639
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004640 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004641
Tejun Heo6183c002013-03-12 11:29:57 -07004642 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004643
Tejun Heo24b8a842013-03-12 11:29:58 -07004644 list_for_each_entry(wq, &workqueues, list) {
4645 if (!(wq->flags & WQ_FREEZABLE))
4646 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004647 /*
4648 * nr_active is monotonically decreasing. It's safe
4649 * to peek without lock.
4650 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004651 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004652 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004653 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004654 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004655 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004656 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004657 goto out_unlock;
4658 }
4659 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004660 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004661 }
4662out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004663 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004664 return busy;
4665}
4666
4667/**
4668 * thaw_workqueues - thaw workqueues
4669 *
4670 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004671 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004672 *
4673 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004674 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004675 */
4676void thaw_workqueues(void)
4677{
Tejun Heo24b8a842013-03-12 11:29:58 -07004678 struct workqueue_struct *wq;
4679 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004680
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004681 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004682
4683 if (!workqueue_freezing)
4684 goto out_unlock;
4685
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004686 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004687
Tejun Heo24b8a842013-03-12 11:29:58 -07004688 /* restore max_active and repopulate worklist */
4689 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004690 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004691 for_each_pwq(pwq, wq)
4692 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004693 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004694 }
4695
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004696out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004697 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004698}
4699#endif /* CONFIG_FREEZER */
4700
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004701#ifdef CONFIG_SYSFS
4702/*
4703 * Workqueues with WQ_SYSFS flag set is visible to userland via
4704 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4705 * following attributes.
4706 *
4707 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4708 * max_active RW int : maximum number of in-flight work items
4709 *
4710 * Unbound workqueues have the following extra attributes.
4711 *
4712 * id RO int : the associated pool ID
4713 * nice RW int : nice value of the workers
4714 * cpumask RW mask : bitmask of allowed CPUs for the workers
4715 */
4716struct wq_device {
4717 struct workqueue_struct *wq;
4718 struct device dev;
4719};
4720
4721static struct workqueue_struct *dev_to_wq(struct device *dev)
4722{
4723 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
4724
4725 return wq_dev->wq;
4726}
4727
4728static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
4729 char *buf)
4730{
4731 struct workqueue_struct *wq = dev_to_wq(dev);
4732
4733 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
4734}
4735static DEVICE_ATTR_RO(per_cpu);
4736
4737static ssize_t max_active_show(struct device *dev,
4738 struct device_attribute *attr, char *buf)
4739{
4740 struct workqueue_struct *wq = dev_to_wq(dev);
4741
4742 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
4743}
4744
4745static ssize_t max_active_store(struct device *dev,
4746 struct device_attribute *attr, const char *buf,
4747 size_t count)
4748{
4749 struct workqueue_struct *wq = dev_to_wq(dev);
4750 int val;
4751
4752 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
4753 return -EINVAL;
4754
4755 workqueue_set_max_active(wq, val);
4756 return count;
4757}
4758static DEVICE_ATTR_RW(max_active);
4759
4760static struct attribute *wq_sysfs_attrs[] = {
4761 &dev_attr_per_cpu.attr,
4762 &dev_attr_max_active.attr,
4763 NULL,
4764};
4765ATTRIBUTE_GROUPS(wq_sysfs);
4766
4767static ssize_t wq_pool_ids_show(struct device *dev,
4768 struct device_attribute *attr, char *buf)
4769{
4770 struct workqueue_struct *wq = dev_to_wq(dev);
4771 const char *delim = "";
4772 int node, written = 0;
4773
4774 rcu_read_lock_sched();
4775 for_each_node(node) {
4776 written += scnprintf(buf + written, PAGE_SIZE - written,
4777 "%s%d:%d", delim, node,
4778 unbound_pwq_by_node(wq, node)->pool->id);
4779 delim = " ";
4780 }
4781 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
4782 rcu_read_unlock_sched();
4783
4784 return written;
4785}
4786
4787static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
4788 char *buf)
4789{
4790 struct workqueue_struct *wq = dev_to_wq(dev);
4791 int written;
4792
4793 mutex_lock(&wq->mutex);
4794 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
4795 mutex_unlock(&wq->mutex);
4796
4797 return written;
4798}
4799
4800/* prepare workqueue_attrs for sysfs store operations */
4801static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
4802{
4803 struct workqueue_attrs *attrs;
4804
4805 attrs = alloc_workqueue_attrs(GFP_KERNEL);
4806 if (!attrs)
4807 return NULL;
4808
4809 mutex_lock(&wq->mutex);
4810 copy_workqueue_attrs(attrs, wq->unbound_attrs);
4811 mutex_unlock(&wq->mutex);
4812 return attrs;
4813}
4814
4815static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
4816 const char *buf, size_t count)
4817{
4818 struct workqueue_struct *wq = dev_to_wq(dev);
4819 struct workqueue_attrs *attrs;
4820 int ret;
4821
4822 attrs = wq_sysfs_prep_attrs(wq);
4823 if (!attrs)
4824 return -ENOMEM;
4825
4826 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
4827 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
4828 ret = apply_workqueue_attrs(wq, attrs);
4829 else
4830 ret = -EINVAL;
4831
4832 free_workqueue_attrs(attrs);
4833 return ret ?: count;
4834}
4835
4836static ssize_t wq_cpumask_show(struct device *dev,
4837 struct device_attribute *attr, char *buf)
4838{
4839 struct workqueue_struct *wq = dev_to_wq(dev);
4840 int written;
4841
4842 mutex_lock(&wq->mutex);
4843 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
4844 cpumask_pr_args(wq->unbound_attrs->cpumask));
4845 mutex_unlock(&wq->mutex);
4846 return written;
4847}
4848
4849static ssize_t wq_cpumask_store(struct device *dev,
4850 struct device_attribute *attr,
4851 const char *buf, size_t count)
4852{
4853 struct workqueue_struct *wq = dev_to_wq(dev);
4854 struct workqueue_attrs *attrs;
4855 int ret;
4856
4857 attrs = wq_sysfs_prep_attrs(wq);
4858 if (!attrs)
4859 return -ENOMEM;
4860
4861 ret = cpumask_parse(buf, attrs->cpumask);
4862 if (!ret)
4863 ret = apply_workqueue_attrs(wq, attrs);
4864
4865 free_workqueue_attrs(attrs);
4866 return ret ?: count;
4867}
4868
4869static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
4870 char *buf)
4871{
4872 struct workqueue_struct *wq = dev_to_wq(dev);
4873 int written;
4874
4875 mutex_lock(&wq->mutex);
4876 written = scnprintf(buf, PAGE_SIZE, "%d\n",
4877 !wq->unbound_attrs->no_numa);
4878 mutex_unlock(&wq->mutex);
4879
4880 return written;
4881}
4882
4883static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
4884 const char *buf, size_t count)
4885{
4886 struct workqueue_struct *wq = dev_to_wq(dev);
4887 struct workqueue_attrs *attrs;
4888 int v, ret;
4889
4890 attrs = wq_sysfs_prep_attrs(wq);
4891 if (!attrs)
4892 return -ENOMEM;
4893
4894 ret = -EINVAL;
4895 if (sscanf(buf, "%d", &v) == 1) {
4896 attrs->no_numa = !v;
4897 ret = apply_workqueue_attrs(wq, attrs);
4898 }
4899
4900 free_workqueue_attrs(attrs);
4901 return ret ?: count;
4902}
4903
4904static struct device_attribute wq_sysfs_unbound_attrs[] = {
4905 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
4906 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
4907 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
4908 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
4909 __ATTR_NULL,
4910};
4911
4912static struct bus_type wq_subsys = {
4913 .name = "workqueue",
4914 .dev_groups = wq_sysfs_groups,
4915};
4916
4917static int __init wq_sysfs_init(void)
4918{
4919 return subsys_virtual_register(&wq_subsys, NULL);
4920}
4921core_initcall(wq_sysfs_init);
4922
4923static void wq_device_release(struct device *dev)
4924{
4925 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
4926
4927 kfree(wq_dev);
4928}
4929
4930/**
4931 * workqueue_sysfs_register - make a workqueue visible in sysfs
4932 * @wq: the workqueue to register
4933 *
4934 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
4935 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
4936 * which is the preferred method.
4937 *
4938 * Workqueue user should use this function directly iff it wants to apply
4939 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
4940 * apply_workqueue_attrs() may race against userland updating the
4941 * attributes.
4942 *
4943 * Return: 0 on success, -errno on failure.
4944 */
4945int workqueue_sysfs_register(struct workqueue_struct *wq)
4946{
4947 struct wq_device *wq_dev;
4948 int ret;
4949
4950 /*
4951 * Adjusting max_active or creating new pwqs by applyting
4952 * attributes breaks ordering guarantee. Disallow exposing ordered
4953 * workqueues.
4954 */
4955 if (WARN_ON(wq->flags & __WQ_ORDERED))
4956 return -EINVAL;
4957
4958 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
4959 if (!wq_dev)
4960 return -ENOMEM;
4961
4962 wq_dev->wq = wq;
4963 wq_dev->dev.bus = &wq_subsys;
4964 wq_dev->dev.init_name = wq->name;
4965 wq_dev->dev.release = wq_device_release;
4966
4967 /*
4968 * unbound_attrs are created separately. Suppress uevent until
4969 * everything is ready.
4970 */
4971 dev_set_uevent_suppress(&wq_dev->dev, true);
4972
4973 ret = device_register(&wq_dev->dev);
4974 if (ret) {
4975 kfree(wq_dev);
4976 wq->wq_dev = NULL;
4977 return ret;
4978 }
4979
4980 if (wq->flags & WQ_UNBOUND) {
4981 struct device_attribute *attr;
4982
4983 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
4984 ret = device_create_file(&wq_dev->dev, attr);
4985 if (ret) {
4986 device_unregister(&wq_dev->dev);
4987 wq->wq_dev = NULL;
4988 return ret;
4989 }
4990 }
4991 }
4992
4993 dev_set_uevent_suppress(&wq_dev->dev, false);
4994 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
4995 return 0;
4996}
4997
4998/**
4999 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5000 * @wq: the workqueue to unregister
5001 *
5002 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5003 */
5004static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5005{
5006 struct wq_device *wq_dev = wq->wq_dev;
5007
5008 if (!wq->wq_dev)
5009 return;
5010
5011 wq->wq_dev = NULL;
5012 device_unregister(&wq_dev->dev);
5013}
5014#else /* CONFIG_SYSFS */
5015static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5016#endif /* CONFIG_SYSFS */
5017
Tejun Heobce90382013-04-01 11:23:32 -07005018static void __init wq_numa_init(void)
5019{
5020 cpumask_var_t *tbl;
5021 int node, cpu;
5022
Tejun Heobce90382013-04-01 11:23:32 -07005023 if (num_possible_nodes() <= 1)
5024 return;
5025
Tejun Heod55262c2013-04-01 11:23:38 -07005026 if (wq_disable_numa) {
5027 pr_info("workqueue: NUMA affinity support disabled\n");
5028 return;
5029 }
5030
Tejun Heo4c16bd32013-04-01 11:23:36 -07005031 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5032 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5033
Tejun Heobce90382013-04-01 11:23:32 -07005034 /*
5035 * We want masks of possible CPUs of each node which isn't readily
5036 * available. Build one from cpu_to_node() which should have been
5037 * fully initialized by now.
5038 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005039 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005040 BUG_ON(!tbl);
5041
5042 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005043 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005044 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005045
5046 for_each_possible_cpu(cpu) {
5047 node = cpu_to_node(cpu);
5048 if (WARN_ON(node == NUMA_NO_NODE)) {
5049 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5050 /* happens iff arch is bonkers, let's just proceed */
5051 return;
5052 }
5053 cpumask_set_cpu(cpu, tbl[node]);
5054 }
5055
5056 wq_numa_possible_cpumask = tbl;
5057 wq_numa_enabled = true;
5058}
5059
Suresh Siddha6ee05782010-07-30 14:57:37 -07005060static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005061{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005062 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5063 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005064
Tejun Heoe904e6c2013-03-12 11:29:57 -07005065 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5066
5067 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5068
Tejun Heo65758202012-07-17 12:39:26 -07005069 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07005070 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02005071
Tejun Heobce90382013-04-01 11:23:32 -07005072 wq_numa_init();
5073
Tejun Heo706026c2013-01-24 11:01:34 -08005074 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005075 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005076 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005077
Tejun Heo7a4e3442013-03-12 11:30:00 -07005078 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005079 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005080 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005081 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005082 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005083 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005084 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005085
Tejun Heo9daf9e62013-01-24 11:01:33 -08005086 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005087 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005088 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005089 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005090 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005091 }
5092
Tejun Heoe22bee72010-06-29 10:07:14 +02005093 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07005094 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005095 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02005096
Tejun Heof02ae732013-03-12 11:30:03 -07005097 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07005098 pool->flags &= ~POOL_DISASSOCIATED;
Lai Jiangshan051e1852014-07-22 13:03:02 +08005099 BUG_ON(!create_worker(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07005100 }
Tejun Heoe22bee72010-06-29 10:07:14 +02005101 }
5102
Tejun Heo8a2b7532013-09-05 12:30:04 -04005103 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005104 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5105 struct workqueue_attrs *attrs;
5106
5107 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005108 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005109 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005110
5111 /*
5112 * An ordered wq should have only one pwq as ordering is
5113 * guaranteed by max_active which is enforced by pwqs.
5114 * Turn off NUMA so that dfl_pwq is used for all nodes.
5115 */
5116 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5117 attrs->nice = std_nice[i];
5118 attrs->no_numa = true;
5119 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005120 }
5121
Tejun Heod320c032010-06-29 10:07:14 +02005122 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005123 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005124 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005125 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5126 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005127 system_freezable_wq = alloc_workqueue("events_freezable",
5128 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305129 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5130 WQ_POWER_EFFICIENT, 0);
5131 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5132 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5133 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005134 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305135 !system_unbound_wq || !system_freezable_wq ||
5136 !system_power_efficient_wq ||
5137 !system_freezable_power_efficient_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07005138 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005139}
Suresh Siddha6ee05782010-07-30 14:57:37 -07005140early_initcall(init_workqueues);