blob: c7769c507bf510ad691c0e904e8246fce9bae1c5 [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 Lameter469340232006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/kallsyms.h>
42#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020051
Tejun Heoea138442013-01-18 14:05:55 -080052#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Tejun Heoc8e55f32010-06-29 10:07:12 +020054enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070055 /*
Tejun Heo24647572013-01-24 11:01:33 -080056 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 *
Tejun Heo24647572013-01-24 11:01:33 -080058 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 * While associated (!DISASSOCIATED), all workers are bound to the
60 * CPU and none has %WORKER_UNBOUND set and concurrency management
61 * is in effect.
62 *
63 * While DISASSOCIATED, the cpu may be offline and all workers have
64 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080065 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070066 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070067 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080068 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080069 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070070 */
Tejun Heo24647572013-01-24 11:01:33 -080071 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020072
Tejun Heoc8e55f32010-06-29 10:07:12 +020073 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020074 WORKER_DIE = 1 << 1, /* die die die */
75 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020076 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020077 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020078 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070079 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020080
Tejun Heoa9ab7752013-03-19 13:45:21 -070081 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
82 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020083
Tejun Heoe34cdddb2013-01-24 11:01:33 -080084 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070085
Tejun Heo29c91e92013-03-12 11:30:03 -070086 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020087 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020088
Tejun Heoe22bee72010-06-29 10:07:14 +020089 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
90 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
91
Tejun Heo3233cdb2011-02-16 18:10:19 +010092 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
93 /* call for help after 10ms
94 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020095 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
96 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020097
98 /*
99 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800100 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200101 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800102 RESCUER_NICE_LEVEL = MIN_NICE,
103 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700104
105 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200106};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200109 * Structure fields follow one of the following exclusion rules.
110 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200111 * I: Modifiable by initialization/destruction paths and read-only for
112 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200113 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200114 * P: Preemption protected. Disabling preemption is enough and should
115 * only be modified and accessed from the local cpu.
116 *
Tejun Heod565ed62013-01-24 11:01:33 -0800117 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200118 *
Tejun Heod565ed62013-01-24 11:01:33 -0800119 * X: During normal operation, modification requires pool->lock and should
120 * be done only from local cpu. Either disabling preemption on local
121 * cpu or grabbing pool->lock is enough for read access. If
122 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200123 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800124 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700125 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700126 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700127 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700128 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700129 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800130 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
131 *
132 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
133 * sched-RCU for reads.
134 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700135 * WQ: wq->mutex protected.
136 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700137 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700138 *
139 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200140 */
141
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800142/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200143
Tejun Heobd7bdd42012-07-12 14:46:37 -0700144struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800145 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700146 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700147 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800148 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700149 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700150
151 struct list_head worklist; /* L: list of pending works */
152 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700153
154 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700155 int nr_idle; /* L: currently idle ones */
156
157 struct list_head idle_list; /* X: list of idle workers */
158 struct timer_list idle_timer; /* L: worker idle timeout */
159 struct timer_list mayday_timer; /* L: SOS timer for workers */
160
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700161 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800162 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
163 /* L: hash of busy workers */
164
Tejun Heobc3a1af2013-03-13 19:47:39 -0700165 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo34a06bd2013-03-12 11:30:00 -0700166 struct mutex manager_arb; /* manager arbitration */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400167 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800168 struct mutex attach_mutex; /* attach/detach exclusion */
169 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800170 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800171
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800172 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800173
Tejun Heo7a4e3442013-03-12 11:30:00 -0700174 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700175 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
176 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700177
Tejun Heoe19e3972013-01-24 11:39:44 -0800178 /*
179 * The current concurrency level. As it's likely to be accessed
180 * from other CPUs during try_to_wake_up(), put it in a separate
181 * cacheline.
182 */
183 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700184
185 /*
186 * Destruction of pool is sched-RCU protected to allow dereferences
187 * from get_work_pool().
188 */
189 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200190} ____cacheline_aligned_in_smp;
191
192/*
Tejun Heo112202d2013-02-13 19:29:12 -0800193 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
194 * of work_struct->data are used for flags and the remaining high bits
195 * point to the pwq; thus, pwqs need to be aligned at two's power of the
196 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 */
Tejun Heo112202d2013-02-13 19:29:12 -0800198struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700199 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200200 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200201 int work_color; /* L: current color */
202 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700203 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200204 int nr_in_flight[WORK_NR_COLORS];
205 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200206 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200207 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200208 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700209 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700210 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700211
212 /*
213 * Release of unbound pwq is punted to system_wq. See put_pwq()
214 * and pwq_unbound_release_workfn() for details. pool_workqueue
215 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700216 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700217 */
218 struct work_struct unbound_release_work;
219 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700220} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200223 * Structure used to wait for workqueue flush.
224 */
225struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700226 struct list_head list; /* WQ: list of flushers */
227 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200228 struct completion done; /* flush completion */
229};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Tejun Heo226223a2013-03-12 11:30:05 -0700231struct wq_device;
232
Tejun Heo73f53c42010-06-29 10:07:11 +0200233/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700234 * The externally visible workqueue. It relays the issued work items to
235 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 */
237struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700238 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400239 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200240
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700241 struct mutex mutex; /* protects this wq */
242 int work_color; /* WQ: current work color */
243 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800244 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700245 struct wq_flusher *first_flusher; /* WQ: first flusher */
246 struct list_head flusher_queue; /* WQ: flush waiters */
247 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200248
Tejun Heo2e109a22013-03-13 19:47:40 -0700249 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200250 struct worker *rescuer; /* I: rescue worker */
251
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700252 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700253 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700254
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800255 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
256 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700257
Tejun Heo226223a2013-03-12 11:30:05 -0700258#ifdef CONFIG_SYSFS
259 struct wq_device *wq_dev; /* I: for sysfs interface */
260#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700261#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200262 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700263#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700264 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700265
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400266 /*
267 * Destruction of workqueue_struct is sched-RCU protected to allow
268 * walking the workqueues list without grabbing wq_pool_mutex.
269 * This is used to dump all workqueues from sysrq.
270 */
271 struct rcu_head rcu;
272
Tejun Heo2728fd22013-04-01 11:23:35 -0700273 /* hot fields used during command issue, aligned to cacheline */
274 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
275 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800276 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277};
278
Tejun Heoe904e6c2013-03-12 11:29:57 -0700279static struct kmem_cache *pwq_cache;
280
Tejun Heobce90382013-04-01 11:23:32 -0700281static cpumask_var_t *wq_numa_possible_cpumask;
282 /* possible CPUs of each node */
283
Tejun Heod55262c2013-04-01 11:23:38 -0700284static bool wq_disable_numa;
285module_param_named(disable_numa, wq_disable_numa, bool, 0444);
286
Viresh Kumarcee22a12013-04-08 16:45:40 +0530287/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930288static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530289module_param_named(power_efficient, wq_power_efficient, bool, 0444);
290
Tejun Heobce90382013-04-01 11:23:32 -0700291static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
292
Tejun Heo4c16bd32013-04-01 11:23:36 -0700293/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
294static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
295
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700296static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700297static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo5bcab332013-03-13 19:47:40 -0700298
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400299static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700300static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700301
Lai Jiangshan042f7df12015-04-30 17:16:12 +0800302static cpumask_var_t wq_unbound_cpumask; /* PL: low level cpumask for all unbound wqs */
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800303
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700304/* the per-cpu worker pools */
305static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
306 cpu_worker_pools);
307
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700308static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700309
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700310/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700311static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
312
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700313/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700314static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
315
Tejun Heo8a2b7532013-09-05 12:30:04 -0400316/* I: attributes used when instantiating ordered pools on demand */
317static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
318
Tejun Heod320c032010-06-29 10:07:14 +0200319struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400320EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300321struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900322EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300323struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200324EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300325struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200326EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300327struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100328EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530329struct workqueue_struct *system_power_efficient_wq __read_mostly;
330EXPORT_SYMBOL_GPL(system_power_efficient_wq);
331struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
332EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200333
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700334static int worker_thread(void *__worker);
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() \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700341 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
342 !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) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700346 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
347 !lockdep_is_held(&wq->mutex), \
348 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700349
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800350#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700351 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
352 !lockdep_is_held(&wq->mutex) && \
353 !lockdep_is_held(&wq_pool_mutex), \
354 "sched RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800355
Tejun Heof02ae732013-03-12 11:30:03 -0700356#define for_each_cpu_worker_pool(pool, cpu) \
357 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
358 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700359 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700360
Tejun Heo49e3cf42013-03-12 11:29:58 -0700361/**
Tejun Heo17116962013-03-12 11:29:58 -0700362 * for_each_pool - iterate through all worker_pools in the system
363 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700364 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700365 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700366 * This must be called either with wq_pool_mutex held or sched RCU read
367 * locked. If the pool needs to be used beyond the locking in effect, the
368 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700369 *
370 * The if/else clause exists only for the lockdep assertion and can be
371 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700372 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700373#define for_each_pool(pool, pi) \
374 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700375 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700376 else
Tejun Heo17116962013-03-12 11:29:58 -0700377
378/**
Tejun Heo822d8402013-03-19 13:45:21 -0700379 * for_each_pool_worker - iterate through all workers of a worker_pool
380 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700381 * @pool: worker_pool to iterate workers of
382 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800383 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700384 *
385 * The if/else clause exists only for the lockdep assertion and can be
386 * ignored.
387 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800388#define for_each_pool_worker(worker, pool) \
389 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800390 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700391 else
392
393/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700394 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
395 * @pwq: iteration cursor
396 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700397 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700398 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18bc2013-03-13 19:47:40 -0700399 * If the pwq needs to be used beyond the locking in effect, the caller is
400 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700401 *
402 * The if/else clause exists only for the lockdep assertion and can be
403 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700404 */
405#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700406 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700407 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700408 else
Tejun Heof3421792010-07-02 10:03:51 +0200409
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900410#ifdef CONFIG_DEBUG_OBJECTS_WORK
411
412static struct debug_obj_descr work_debug_descr;
413
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100414static void *work_debug_hint(void *addr)
415{
416 return ((struct work_struct *) addr)->func;
417}
418
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900419/*
420 * fixup_init is called when:
421 * - an active object is initialized
422 */
423static int work_fixup_init(void *addr, enum debug_obj_state state)
424{
425 struct work_struct *work = addr;
426
427 switch (state) {
428 case ODEBUG_STATE_ACTIVE:
429 cancel_work_sync(work);
430 debug_object_init(work, &work_debug_descr);
431 return 1;
432 default:
433 return 0;
434 }
435}
436
437/*
438 * fixup_activate is called when:
439 * - an active object is activated
440 * - an unknown object is activated (might be a statically initialized object)
441 */
442static int work_fixup_activate(void *addr, enum debug_obj_state state)
443{
444 struct work_struct *work = addr;
445
446 switch (state) {
447
448 case ODEBUG_STATE_NOTAVAILABLE:
449 /*
450 * This is not really a fixup. The work struct was
451 * statically initialized. We just make sure that it
452 * is tracked in the object tracker.
453 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200454 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900455 debug_object_init(work, &work_debug_descr);
456 debug_object_activate(work, &work_debug_descr);
457 return 0;
458 }
459 WARN_ON_ONCE(1);
460 return 0;
461
462 case ODEBUG_STATE_ACTIVE:
463 WARN_ON(1);
464
465 default:
466 return 0;
467 }
468}
469
470/*
471 * fixup_free is called when:
472 * - an active object is freed
473 */
474static int work_fixup_free(void *addr, enum debug_obj_state state)
475{
476 struct work_struct *work = addr;
477
478 switch (state) {
479 case ODEBUG_STATE_ACTIVE:
480 cancel_work_sync(work);
481 debug_object_free(work, &work_debug_descr);
482 return 1;
483 default:
484 return 0;
485 }
486}
487
488static struct debug_obj_descr work_debug_descr = {
489 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100490 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900491 .fixup_init = work_fixup_init,
492 .fixup_activate = work_fixup_activate,
493 .fixup_free = work_fixup_free,
494};
495
496static inline void debug_work_activate(struct work_struct *work)
497{
498 debug_object_activate(work, &work_debug_descr);
499}
500
501static inline void debug_work_deactivate(struct work_struct *work)
502{
503 debug_object_deactivate(work, &work_debug_descr);
504}
505
506void __init_work(struct work_struct *work, int onstack)
507{
508 if (onstack)
509 debug_object_init_on_stack(work, &work_debug_descr);
510 else
511 debug_object_init(work, &work_debug_descr);
512}
513EXPORT_SYMBOL_GPL(__init_work);
514
515void destroy_work_on_stack(struct work_struct *work)
516{
517 debug_object_free(work, &work_debug_descr);
518}
519EXPORT_SYMBOL_GPL(destroy_work_on_stack);
520
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000521void destroy_delayed_work_on_stack(struct delayed_work *work)
522{
523 destroy_timer_on_stack(&work->timer);
524 debug_object_free(&work->work, &work_debug_descr);
525}
526EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
527
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900528#else
529static inline void debug_work_activate(struct work_struct *work) { }
530static inline void debug_work_deactivate(struct work_struct *work) { }
531#endif
532
Li Bin4e8b22b2013-09-10 09:52:35 +0800533/**
534 * worker_pool_assign_id - allocate ID and assing it to @pool
535 * @pool: the pool pointer of interest
536 *
537 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
538 * successfully, -errno on failure.
539 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800540static int worker_pool_assign_id(struct worker_pool *pool)
541{
542 int ret;
543
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700544 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700545
Li Bin4e8b22b2013-09-10 09:52:35 +0800546 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
547 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700548 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700549 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700550 return 0;
551 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800552 return ret;
553}
554
Tejun Heo76af4d92013-03-12 11:30:00 -0700555/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700556 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
557 * @wq: the target workqueue
558 * @node: the node ID
559 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800560 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
561 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700562 * If the pwq needs to be used beyond the locking in effect, the caller is
563 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700564 *
565 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700566 */
567static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
568 int node)
569{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800570 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700571 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
572}
573
Tejun Heo73f53c42010-06-29 10:07:11 +0200574static unsigned int work_color_to_flags(int color)
575{
576 return color << WORK_STRUCT_COLOR_SHIFT;
577}
578
579static int get_work_color(struct work_struct *work)
580{
581 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
582 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
583}
584
585static int work_next_color(int color)
586{
587 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700588}
589
David Howells4594bf12006-12-07 11:33:26 +0000590/*
Tejun Heo112202d2013-02-13 19:29:12 -0800591 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
592 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800593 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200594 *
Tejun Heo112202d2013-02-13 19:29:12 -0800595 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
596 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700597 * work->data. These functions should only be called while the work is
598 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200599 *
Tejun Heo112202d2013-02-13 19:29:12 -0800600 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800601 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800602 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800603 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700604 *
605 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
606 * canceled. While being canceled, a work item may have its PENDING set
607 * but stay off timer and worklist for arbitrarily long and nobody should
608 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000609 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200610static inline void set_work_data(struct work_struct *work, unsigned long data,
611 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000612{
Tejun Heo6183c002013-03-12 11:29:57 -0700613 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200614 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000615}
David Howells365970a2006-11-22 14:54:49 +0000616
Tejun Heo112202d2013-02-13 19:29:12 -0800617static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200618 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200619{
Tejun Heo112202d2013-02-13 19:29:12 -0800620 set_work_data(work, (unsigned long)pwq,
621 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200622}
623
Lai Jiangshan4468a002013-02-06 18:04:53 -0800624static void set_work_pool_and_keep_pending(struct work_struct *work,
625 int pool_id)
626{
627 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
628 WORK_STRUCT_PENDING);
629}
630
Tejun Heo7c3eed52013-01-24 11:01:33 -0800631static void set_work_pool_and_clear_pending(struct work_struct *work,
632 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000633{
Tejun Heo23657bb2012-08-13 17:08:19 -0700634 /*
635 * The following wmb is paired with the implied mb in
636 * test_and_set_bit(PENDING) and ensures all updates to @work made
637 * here are visible to and precede any updates by the next PENDING
638 * owner.
639 */
640 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800641 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200642}
643
644static void clear_work_data(struct work_struct *work)
645{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800646 smp_wmb(); /* see set_work_pool_and_clear_pending() */
647 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200648}
649
Tejun Heo112202d2013-02-13 19:29:12 -0800650static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200651{
Tejun Heoe1201532010-07-22 14:14:25 +0200652 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200653
Tejun Heo112202d2013-02-13 19:29:12 -0800654 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200655 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
656 else
657 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200658}
659
Tejun Heo7c3eed52013-01-24 11:01:33 -0800660/**
661 * get_work_pool - return the worker_pool a given work was associated with
662 * @work: the work item of interest
663 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700664 * Pools are created and destroyed under wq_pool_mutex, and allows read
665 * access under sched-RCU read lock. As such, this function should be
666 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700667 *
668 * All fields of the returned pool are accessible as long as the above
669 * mentioned locking is in effect. If the returned pool needs to be used
670 * beyond the critical section, the caller is responsible for ensuring the
671 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700672 *
673 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800674 */
675static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200676{
Tejun Heoe1201532010-07-22 14:14:25 +0200677 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800678 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200679
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700680 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700681
Tejun Heo112202d2013-02-13 19:29:12 -0800682 if (data & WORK_STRUCT_PWQ)
683 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800684 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200685
Tejun Heo7c3eed52013-01-24 11:01:33 -0800686 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
687 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200688 return NULL;
689
Tejun Heofa1b54e2013-03-12 11:30:00 -0700690 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800691}
692
693/**
694 * get_work_pool_id - return the worker pool ID a given work is associated with
695 * @work: the work item of interest
696 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700697 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800698 * %WORK_OFFQ_POOL_NONE if none.
699 */
700static int get_work_pool_id(struct work_struct *work)
701{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800702 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800703
Tejun Heo112202d2013-02-13 19:29:12 -0800704 if (data & WORK_STRUCT_PWQ)
705 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800706 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
707
708 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800709}
710
Tejun Heobbb68df2012-08-03 10:30:46 -0700711static void mark_work_canceling(struct work_struct *work)
712{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800713 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700714
Tejun Heo7c3eed52013-01-24 11:01:33 -0800715 pool_id <<= WORK_OFFQ_POOL_SHIFT;
716 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700717}
718
719static bool work_is_canceling(struct work_struct *work)
720{
721 unsigned long data = atomic_long_read(&work->data);
722
Tejun Heo112202d2013-02-13 19:29:12 -0800723 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700724}
725
David Howells365970a2006-11-22 14:54:49 +0000726/*
Tejun Heo32704762012-07-13 22:16:45 -0700727 * Policy functions. These define the policies on how the global worker
728 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800729 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000730 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200731
Tejun Heo63d95a92012-07-12 14:46:37 -0700732static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000733{
Tejun Heoe19e3972013-01-24 11:39:44 -0800734 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000735}
736
Tejun Heoe22bee72010-06-29 10:07:14 +0200737/*
738 * Need to wake up a worker? Called from anything but currently
739 * running workers.
Tejun Heo974271c42012-07-12 14:46:37 -0700740 *
741 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800742 * function will always return %true for unbound pools as long as the
Tejun Heo974271c42012-07-12 14:46:37 -0700743 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200744 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700745static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000746{
Tejun Heo63d95a92012-07-12 14:46:37 -0700747 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000748}
749
Tejun Heoe22bee72010-06-29 10:07:14 +0200750/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700751static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200752{
Tejun Heo63d95a92012-07-12 14:46:37 -0700753 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200754}
755
756/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700757static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200758{
Tejun Heoe19e3972013-01-24 11:39:44 -0800759 return !list_empty(&pool->worklist) &&
760 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200761}
762
763/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700764static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200765{
Tejun Heo63d95a92012-07-12 14:46:37 -0700766 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200767}
768
Tejun Heoe22bee72010-06-29 10:07:14 +0200769/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700770static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200771{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700772 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700773 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
774 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200775
776 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
777}
778
779/*
780 * Wake up functions.
781 */
782
Lai Jiangshan1037de32014-05-22 16:44:07 +0800783/* Return the first idle worker. Safe with preemption disabled */
784static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200785{
Tejun Heo63d95a92012-07-12 14:46:37 -0700786 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200787 return NULL;
788
Tejun Heo63d95a92012-07-12 14:46:37 -0700789 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200790}
791
792/**
793 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700794 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200795 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700796 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200797 *
798 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800799 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200800 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700801static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200802{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800803 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200804
805 if (likely(worker))
806 wake_up_process(worker->task);
807}
808
Tejun Heo4690c4a2010-06-29 10:07:10 +0200809/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200810 * wq_worker_waking_up - a worker is waking up
811 * @task: task waking up
812 * @cpu: CPU @task is waking up to
813 *
814 * This function is called during try_to_wake_up() when a worker is
815 * being awoken.
816 *
817 * CONTEXT:
818 * spin_lock_irq(rq->lock)
819 */
Tejun Heod84ff052013-03-12 11:29:59 -0700820void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200821{
822 struct worker *worker = kthread_data(task);
823
Joonsoo Kim36576002012-10-26 23:03:49 +0900824 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800825 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800826 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900827 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200828}
829
830/**
831 * wq_worker_sleeping - a worker is going to sleep
832 * @task: task going to sleep
833 * @cpu: CPU in question, must be the current CPU number
834 *
835 * This function is called during schedule() when a busy worker is
836 * going to sleep. Worker on the same cpu can be woken up by
837 * returning pointer to its task.
838 *
839 * CONTEXT:
840 * spin_lock_irq(rq->lock)
841 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700842 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200843 * Worker task on @cpu to wake up, %NULL if none.
844 */
Tejun Heod84ff052013-03-12 11:29:59 -0700845struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200846{
847 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800848 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200849
Tejun Heo111c2252013-01-17 17:16:24 -0800850 /*
851 * Rescuers, which may not have all the fields set up like normal
852 * workers, also reach here, let's not access anything before
853 * checking NOT_RUNNING.
854 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500855 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200856 return NULL;
857
Tejun Heo111c2252013-01-17 17:16:24 -0800858 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800859
Tejun Heoe22bee72010-06-29 10:07:14 +0200860 /* this can only happen on the local cpu */
Lai Jiangshan92b69f52014-06-03 15:33:08 +0800861 if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu))
Tejun Heo6183c002013-03-12 11:29:57 -0700862 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200863
864 /*
865 * The counterpart of the following dec_and_test, implied mb,
866 * worklist not empty test sequence is in insert_work().
867 * Please read comment there.
868 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700869 * NOT_RUNNING is clear. This means that we're bound to and
870 * running on the local cpu w/ rq lock held and preemption
871 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800872 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700873 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200874 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800875 if (atomic_dec_and_test(&pool->nr_running) &&
876 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800877 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200878 return to_wakeup ? to_wakeup->task : NULL;
879}
880
881/**
882 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200883 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200884 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200885 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800886 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200887 *
Tejun Heocb444762010-07-02 10:03:50 +0200888 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800889 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200890 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800891static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200892{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700893 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200894
Tejun Heocb444762010-07-02 10:03:50 +0200895 WARN_ON_ONCE(worker->task != current);
896
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800897 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200898 if ((flags & WORKER_NOT_RUNNING) &&
899 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800900 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200901 }
902
Tejun Heod302f012010-06-29 10:07:13 +0200903 worker->flags |= flags;
904}
905
906/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200907 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200908 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200909 * @flags: flags to clear
910 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200911 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200912 *
Tejun Heocb444762010-07-02 10:03:50 +0200913 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800914 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200915 */
916static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
917{
Tejun Heo63d95a92012-07-12 14:46:37 -0700918 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200919 unsigned int oflags = worker->flags;
920
Tejun Heocb444762010-07-02 10:03:50 +0200921 WARN_ON_ONCE(worker->task != current);
922
Tejun Heod302f012010-06-29 10:07:13 +0200923 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200924
Tejun Heo42c025f2011-01-11 15:58:49 +0100925 /*
926 * If transitioning out of NOT_RUNNING, increment nr_running. Note
927 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
928 * of multiple flags, not a single flag.
929 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200930 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
931 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800932 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200933}
934
935/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200936 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800937 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200938 * @work: work to find worker for
939 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800940 * Find a worker which is executing @work on @pool by searching
941 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800942 * to match, its current execution should match the address of @work and
943 * its work function. This is to avoid unwanted dependency between
944 * unrelated work executions through a work item being recycled while still
945 * being executed.
946 *
947 * This is a bit tricky. A work item may be freed once its execution
948 * starts and nothing prevents the freed area from being recycled for
949 * another work item. If the same work item address ends up being reused
950 * before the original execution finishes, workqueue will identify the
951 * recycled work item as currently executing and make it wait until the
952 * current execution finishes, introducing an unwanted dependency.
953 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700954 * This function checks the work item address and work function to avoid
955 * false positives. Note that this isn't complete as one may construct a
956 * work function which can introduce dependency onto itself through a
957 * recycled work item. Well, if somebody wants to shoot oneself in the
958 * foot that badly, there's only so much we can do, and if such deadlock
959 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200960 *
961 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800962 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200963 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700964 * Return:
965 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200966 * otherwise.
967 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800968static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200969 struct work_struct *work)
970{
Sasha Levin42f85702012-12-17 10:01:23 -0500971 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500972
Sasha Levinb67bfe02013-02-27 17:06:00 -0800973 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800974 (unsigned long)work)
975 if (worker->current_work == work &&
976 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500977 return worker;
978
979 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200980}
981
982/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700983 * move_linked_works - move linked works to a list
984 * @work: start of series of works to be scheduled
985 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +0530986 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -0700987 *
988 * Schedule linked works starting from @work to @head. Work series to
989 * be scheduled starts at @work and includes any consecutive work with
990 * WORK_STRUCT_LINKED set in its predecessor.
991 *
992 * If @nextp is not NULL, it's updated to point to the next work of
993 * the last scheduled work. This allows move_linked_works() to be
994 * nested inside outer list_for_each_entry_safe().
995 *
996 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800997 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -0700998 */
999static void move_linked_works(struct work_struct *work, struct list_head *head,
1000 struct work_struct **nextp)
1001{
1002 struct work_struct *n;
1003
1004 /*
1005 * Linked worklist will always end before the end of the list,
1006 * use NULL for list head.
1007 */
1008 list_for_each_entry_safe_from(work, n, NULL, entry) {
1009 list_move_tail(&work->entry, head);
1010 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1011 break;
1012 }
1013
1014 /*
1015 * If we're already inside safe list traversal and have moved
1016 * multiple works to the scheduled queue, the next position
1017 * needs to be updated.
1018 */
1019 if (nextp)
1020 *nextp = n;
1021}
1022
Tejun Heo8864b4e2013-03-12 11:30:04 -07001023/**
1024 * get_pwq - get an extra reference on the specified pool_workqueue
1025 * @pwq: pool_workqueue to get
1026 *
1027 * Obtain an extra reference on @pwq. The caller should guarantee that
1028 * @pwq has positive refcnt and be holding the matching pool->lock.
1029 */
1030static void get_pwq(struct pool_workqueue *pwq)
1031{
1032 lockdep_assert_held(&pwq->pool->lock);
1033 WARN_ON_ONCE(pwq->refcnt <= 0);
1034 pwq->refcnt++;
1035}
1036
1037/**
1038 * put_pwq - put a pool_workqueue reference
1039 * @pwq: pool_workqueue to put
1040 *
1041 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1042 * destruction. The caller should be holding the matching pool->lock.
1043 */
1044static void put_pwq(struct pool_workqueue *pwq)
1045{
1046 lockdep_assert_held(&pwq->pool->lock);
1047 if (likely(--pwq->refcnt))
1048 return;
1049 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1050 return;
1051 /*
1052 * @pwq can't be released under pool->lock, bounce to
1053 * pwq_unbound_release_workfn(). This never recurses on the same
1054 * pool->lock as this path is taken only for unbound workqueues and
1055 * the release work item is scheduled on a per-cpu workqueue. To
1056 * avoid lockdep warning, unbound pool->locks are given lockdep
1057 * subclass of 1 in get_unbound_pool().
1058 */
1059 schedule_work(&pwq->unbound_release_work);
1060}
1061
Tejun Heodce90d42013-04-01 11:23:35 -07001062/**
1063 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1064 * @pwq: pool_workqueue to put (can be %NULL)
1065 *
1066 * put_pwq() with locking. This function also allows %NULL @pwq.
1067 */
1068static void put_pwq_unlocked(struct pool_workqueue *pwq)
1069{
1070 if (pwq) {
1071 /*
1072 * As both pwqs and pools are sched-RCU protected, the
1073 * following lock operations are safe.
1074 */
1075 spin_lock_irq(&pwq->pool->lock);
1076 put_pwq(pwq);
1077 spin_unlock_irq(&pwq->pool->lock);
1078 }
1079}
1080
Tejun Heo112202d2013-02-13 19:29:12 -08001081static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001082{
Tejun Heo112202d2013-02-13 19:29:12 -08001083 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001084
1085 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001086 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001087 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001088 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001089}
1090
Tejun Heo112202d2013-02-13 19:29:12 -08001091static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001092{
Tejun Heo112202d2013-02-13 19:29:12 -08001093 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001094 struct work_struct, entry);
1095
Tejun Heo112202d2013-02-13 19:29:12 -08001096 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001097}
1098
Tejun Heobf4ede02012-08-03 10:30:46 -07001099/**
Tejun Heo112202d2013-02-13 19:29:12 -08001100 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1101 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001102 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001103 *
1104 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001105 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001106 *
1107 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001108 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001109 */
Tejun Heo112202d2013-02-13 19:29:12 -08001110static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001111{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001112 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001113 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001114 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001115
Tejun Heo112202d2013-02-13 19:29:12 -08001116 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001117
Tejun Heo112202d2013-02-13 19:29:12 -08001118 pwq->nr_active--;
1119 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001120 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001121 if (pwq->nr_active < pwq->max_active)
1122 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001123 }
1124
1125 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001126 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001127 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001128
1129 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001130 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001131 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001132
Tejun Heo112202d2013-02-13 19:29:12 -08001133 /* this pwq is done, clear flush_color */
1134 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001135
1136 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001137 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001138 * will handle the rest.
1139 */
Tejun Heo112202d2013-02-13 19:29:12 -08001140 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1141 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001142out_put:
1143 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001144}
1145
Tejun Heo36e227d2012-08-03 10:30:46 -07001146/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001147 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001148 * @work: work item to steal
1149 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001150 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001151 *
1152 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001153 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001154 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001155 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001156 * 1 if @work was pending and we successfully stole PENDING
1157 * 0 if @work was idle and we claimed PENDING
1158 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001159 * -ENOENT if someone else is canceling @work, this state may persist
1160 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001161 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001162 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001163 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001164 * interrupted while holding PENDING and @work off queue, irq must be
1165 * disabled on entry. This, combined with delayed_work->timer being
1166 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001167 *
1168 * On successful return, >= 0, irq is disabled and the caller is
1169 * responsible for releasing it using local_irq_restore(*@flags).
1170 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001171 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001172 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001173static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1174 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001175{
Tejun Heod565ed62013-01-24 11:01:33 -08001176 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001177 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001178
Tejun Heobbb68df2012-08-03 10:30:46 -07001179 local_irq_save(*flags);
1180
Tejun Heo36e227d2012-08-03 10:30:46 -07001181 /* try to steal the timer if it exists */
1182 if (is_dwork) {
1183 struct delayed_work *dwork = to_delayed_work(work);
1184
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001185 /*
1186 * dwork->timer is irqsafe. If del_timer() fails, it's
1187 * guaranteed that the timer is not queued anywhere and not
1188 * running on the local CPU.
1189 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001190 if (likely(del_timer(&dwork->timer)))
1191 return 1;
1192 }
1193
1194 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001195 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1196 return 0;
1197
1198 /*
1199 * The queueing is in progress, or it is already queued. Try to
1200 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1201 */
Tejun Heod565ed62013-01-24 11:01:33 -08001202 pool = get_work_pool(work);
1203 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001204 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001205
Tejun Heod565ed62013-01-24 11:01:33 -08001206 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001207 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001208 * work->data is guaranteed to point to pwq only while the work
1209 * item is queued on pwq->wq, and both updating work->data to point
1210 * to pwq on queueing and to pool on dequeueing are done under
1211 * pwq->pool->lock. This in turn guarantees that, if work->data
1212 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001213 * item is currently queued on that pool.
1214 */
Tejun Heo112202d2013-02-13 19:29:12 -08001215 pwq = get_work_pwq(work);
1216 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001217 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001218
Tejun Heo16062832013-02-06 18:04:53 -08001219 /*
1220 * A delayed work item cannot be grabbed directly because
1221 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001222 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001223 * management later on and cause stall. Make sure the work
1224 * item is activated before grabbing.
1225 */
1226 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001227 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001228
Tejun Heo16062832013-02-06 18:04:53 -08001229 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001230 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001231
Tejun Heo112202d2013-02-13 19:29:12 -08001232 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001233 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001234
Tejun Heo16062832013-02-06 18:04:53 -08001235 spin_unlock(&pool->lock);
1236 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001237 }
Tejun Heod565ed62013-01-24 11:01:33 -08001238 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001239fail:
1240 local_irq_restore(*flags);
1241 if (work_is_canceling(work))
1242 return -ENOENT;
1243 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001244 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001245}
1246
1247/**
Tejun Heo706026c2013-01-24 11:01:34 -08001248 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001249 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001250 * @work: work to insert
1251 * @head: insertion point
1252 * @extra_flags: extra WORK_STRUCT_* flags to set
1253 *
Tejun Heo112202d2013-02-13 19:29:12 -08001254 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001255 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001256 *
1257 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001258 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001259 */
Tejun Heo112202d2013-02-13 19:29:12 -08001260static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1261 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001262{
Tejun Heo112202d2013-02-13 19:29:12 -08001263 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001264
Tejun Heo4690c4a2010-06-29 10:07:10 +02001265 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001266 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001267 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001268 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001269
1270 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001271 * Ensure either wq_worker_sleeping() sees the above
1272 * list_add_tail() or we see zero nr_running to avoid workers lying
1273 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001274 */
1275 smp_mb();
1276
Tejun Heo63d95a92012-07-12 14:46:37 -07001277 if (__need_more_worker(pool))
1278 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001279}
1280
Tejun Heoc8efcc22010-12-20 19:32:04 +01001281/*
1282 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001283 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001284 */
1285static bool is_chained_work(struct workqueue_struct *wq)
1286{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001287 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001288
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001289 worker = current_wq_worker();
1290 /*
1291 * Return %true iff I'm a worker execuing a work item on @wq. If
1292 * I'm @worker, it's safe to dereference it without locking.
1293 */
Tejun Heo112202d2013-02-13 19:29:12 -08001294 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001295}
1296
Tejun Heod84ff052013-03-12 11:29:59 -07001297static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 struct work_struct *work)
1299{
Tejun Heo112202d2013-02-13 19:29:12 -08001300 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001301 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001302 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001303 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001304 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001305
1306 /*
1307 * While a work item is PENDING && off queue, a task trying to
1308 * steal the PENDING will busy-loop waiting for it to either get
1309 * queued or lose PENDING. Grabbing PENDING and queueing should
1310 * happen with IRQ disabled.
1311 */
1312 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001314 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001315
Li Bin9ef28a72013-09-09 13:13:58 +08001316 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001317 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001318 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001319 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001320retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001321 if (req_cpu == WORK_CPU_UNBOUND)
1322 cpu = raw_smp_processor_id();
1323
Tejun Heoc9178082013-03-12 11:30:04 -07001324 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001325 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001326 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001327 else
1328 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001329
Tejun Heoc9178082013-03-12 11:30:04 -07001330 /*
1331 * If @work was previously on a different pool, it might still be
1332 * running there, in which case the work needs to be queued on that
1333 * pool to guarantee non-reentrancy.
1334 */
1335 last_pool = get_work_pool(work);
1336 if (last_pool && last_pool != pwq->pool) {
1337 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001338
Tejun Heoc9178082013-03-12 11:30:04 -07001339 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001340
Tejun Heoc9178082013-03-12 11:30:04 -07001341 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001342
Tejun Heoc9178082013-03-12 11:30:04 -07001343 if (worker && worker->current_pwq->wq == wq) {
1344 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001345 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001346 /* meh... not running there, queue here */
1347 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001348 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001349 }
Tejun Heof3421792010-07-02 10:03:51 +02001350 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001351 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001352 }
1353
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001354 /*
1355 * pwq is determined and locked. For unbound pools, we could have
1356 * raced with pwq release and it could already be dead. If its
1357 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001358 * without another pwq replacing it in the numa_pwq_tbl or while
1359 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001360 * make forward-progress.
1361 */
1362 if (unlikely(!pwq->refcnt)) {
1363 if (wq->flags & WQ_UNBOUND) {
1364 spin_unlock(&pwq->pool->lock);
1365 cpu_relax();
1366 goto retry;
1367 }
1368 /* oops */
1369 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1370 wq->name, cpu);
1371 }
1372
Tejun Heo112202d2013-02-13 19:29:12 -08001373 /* pwq determined, queue */
1374 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001375
Dan Carpenterf5b25522012-04-13 22:06:58 +03001376 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001377 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001378 return;
1379 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001380
Tejun Heo112202d2013-02-13 19:29:12 -08001381 pwq->nr_in_flight[pwq->work_color]++;
1382 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001383
Tejun Heo112202d2013-02-13 19:29:12 -08001384 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001385 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001386 pwq->nr_active++;
1387 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001388 } else {
1389 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001390 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001391 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001392
Tejun Heo112202d2013-02-13 19:29:12 -08001393 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001394
Tejun Heo112202d2013-02-13 19:29:12 -08001395 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396}
1397
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001398/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001399 * queue_work_on - queue work on specific cpu
1400 * @cpu: CPU number to execute work on
1401 * @wq: workqueue to use
1402 * @work: work to queue
1403 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001404 * We queue the work to a specific CPU, the caller must ensure it
1405 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001406 *
1407 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001408 */
Tejun Heod4283e92012-08-03 10:30:44 -07001409bool queue_work_on(int cpu, struct workqueue_struct *wq,
1410 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001411{
Tejun Heod4283e92012-08-03 10:30:44 -07001412 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001413 unsigned long flags;
1414
1415 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001416
Tejun Heo22df02b2010-06-29 10:07:10 +02001417 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001418 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001419 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001420 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001421
1422 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001423 return ret;
1424}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001425EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001426
Tejun Heod8e794d2012-08-03 10:30:45 -07001427void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428{
David Howells52bad642006-11-22 14:54:01 +00001429 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001431 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001432 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001434EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001436static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1437 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001439 struct timer_list *timer = &dwork->timer;
1440 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001442 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1443 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001444 WARN_ON_ONCE(timer_pending(timer));
1445 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001446
Tejun Heo8852aac2012-12-01 16:23:42 -08001447 /*
1448 * If @delay is 0, queue @dwork->work immediately. This is for
1449 * both optimization and correctness. The earliest @timer can
1450 * expire is on the closest next tick and delayed_work users depend
1451 * on that there's no such delay when @delay is 0.
1452 */
1453 if (!delay) {
1454 __queue_work(cpu, wq, &dwork->work);
1455 return;
1456 }
1457
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001458 timer_stats_timer_set_start_info(&dwork->timer);
1459
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001460 dwork->wq = wq;
Shaohua Li874bbfe2015-09-30 09:05:30 -07001461 /* timer isn't guaranteed to run in this cpu, record earlier */
1462 if (cpu == WORK_CPU_UNBOUND)
1463 cpu = raw_smp_processor_id();
Tejun Heo12650572012-08-08 09:38:42 -07001464 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001465 timer->expires = jiffies + delay;
1466
Shaohua Li874bbfe2015-09-30 09:05:30 -07001467 add_timer_on(timer, cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468}
1469
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001470/**
1471 * queue_delayed_work_on - queue work on specific CPU after delay
1472 * @cpu: CPU number to execute work on
1473 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001474 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001475 * @delay: number of jiffies to wait before queueing
1476 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001477 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001478 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1479 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001480 */
Tejun Heod4283e92012-08-03 10:30:44 -07001481bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1482 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001483{
David Howells52bad642006-11-22 14:54:01 +00001484 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001485 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001486 unsigned long flags;
1487
1488 /* read the comment in __queue_work() */
1489 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001490
Tejun Heo22df02b2010-06-29 10:07:10 +02001491 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001492 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001493 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001494 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001495
1496 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001497 return ret;
1498}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001499EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500
Tejun Heoc8e55f32010-06-29 10:07:12 +02001501/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001502 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1503 * @cpu: CPU number to execute work on
1504 * @wq: workqueue to use
1505 * @dwork: work to queue
1506 * @delay: number of jiffies to wait before queueing
1507 *
1508 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1509 * modify @dwork's timer so that it expires after @delay. If @delay is
1510 * zero, @work is guaranteed to be scheduled immediately regardless of its
1511 * current state.
1512 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001513 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001514 * pending and its timer was modified.
1515 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001516 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001517 * See try_to_grab_pending() for details.
1518 */
1519bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1520 struct delayed_work *dwork, unsigned long delay)
1521{
1522 unsigned long flags;
1523 int ret;
1524
1525 do {
1526 ret = try_to_grab_pending(&dwork->work, true, &flags);
1527 } while (unlikely(ret == -EAGAIN));
1528
1529 if (likely(ret >= 0)) {
1530 __queue_delayed_work(cpu, wq, dwork, delay);
1531 local_irq_restore(flags);
1532 }
1533
1534 /* -ENOENT from try_to_grab_pending() becomes %true */
1535 return ret;
1536}
1537EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1538
1539/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001540 * worker_enter_idle - enter idle state
1541 * @worker: worker which is entering idle state
1542 *
1543 * @worker is entering idle state. Update stats and idle timer if
1544 * necessary.
1545 *
1546 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001547 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001548 */
1549static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001551 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Tejun Heo6183c002013-03-12 11:29:57 -07001553 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1554 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1555 (worker->hentry.next || worker->hentry.pprev)))
1556 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557
Lai Jiangshan051e1852014-07-22 13:03:02 +08001558 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001559 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001560 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001561 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001562
Tejun Heoc8e55f32010-06-29 10:07:12 +02001563 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001564 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001565
Tejun Heo628c78e2012-07-17 12:39:27 -07001566 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1567 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001568
Tejun Heo544ecf32012-05-14 15:04:50 -07001569 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001570 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001571 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001572 * nr_running, the warning may trigger spuriously. Check iff
1573 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001574 */
Tejun Heo24647572013-01-24 11:01:33 -08001575 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001576 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001577 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578}
1579
Tejun Heoc8e55f32010-06-29 10:07:12 +02001580/**
1581 * worker_leave_idle - leave idle state
1582 * @worker: worker which is leaving idle state
1583 *
1584 * @worker is leaving idle state. Update stats.
1585 *
1586 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001587 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001588 */
1589static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001591 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592
Tejun Heo6183c002013-03-12 11:29:57 -07001593 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1594 return;
Tejun Heod302f012010-06-29 10:07:13 +02001595 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001596 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001597 list_del_init(&worker->entry);
1598}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001600static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001601{
1602 struct worker *worker;
1603
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001604 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001605 if (worker) {
1606 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001607 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001608 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001609 /* on creation a worker is in !idle && prep state */
1610 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001611 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001612 return worker;
1613}
1614
1615/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001616 * worker_attach_to_pool() - attach a worker to a pool
1617 * @worker: worker to be attached
1618 * @pool: the target pool
1619 *
1620 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1621 * cpu-binding of @worker are kept coordinated with the pool across
1622 * cpu-[un]hotplugs.
1623 */
1624static void worker_attach_to_pool(struct worker *worker,
1625 struct worker_pool *pool)
1626{
1627 mutex_lock(&pool->attach_mutex);
1628
1629 /*
1630 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1631 * online CPUs. It'll be re-applied when any of the CPUs come up.
1632 */
1633 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1634
1635 /*
1636 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1637 * stable across this function. See the comments above the
1638 * flag definition for details.
1639 */
1640 if (pool->flags & POOL_DISASSOCIATED)
1641 worker->flags |= WORKER_UNBOUND;
1642
1643 list_add_tail(&worker->node, &pool->workers);
1644
1645 mutex_unlock(&pool->attach_mutex);
1646}
1647
1648/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001649 * worker_detach_from_pool() - detach a worker from its pool
1650 * @worker: worker which is attached to its pool
1651 * @pool: the pool @worker is attached to
1652 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001653 * Undo the attaching which had been done in worker_attach_to_pool(). The
1654 * caller worker shouldn't access to the pool after detached except it has
1655 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001656 */
1657static void worker_detach_from_pool(struct worker *worker,
1658 struct worker_pool *pool)
1659{
1660 struct completion *detach_completion = NULL;
1661
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001662 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001663 list_del(&worker->node);
1664 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001665 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001666 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001667
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001668 /* clear leftover flags without pool->lock after it is detached */
1669 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1670
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001671 if (detach_completion)
1672 complete(detach_completion);
1673}
1674
1675/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001676 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001677 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001678 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001679 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001680 *
1681 * CONTEXT:
1682 * Might sleep. Does GFP_KERNEL allocations.
1683 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001684 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001685 * Pointer to the newly created worker.
1686 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001687static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001688{
Tejun Heoc34056a2010-06-29 10:07:11 +02001689 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001690 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001691 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001692
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001693 /* ID is needed to determine kthread name */
1694 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001695 if (id < 0)
1696 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001697
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001698 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001699 if (!worker)
1700 goto fail;
1701
Tejun Heobd7bdd42012-07-12 14:46:37 -07001702 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001703 worker->id = id;
1704
Tejun Heo29c91e92013-03-12 11:30:03 -07001705 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001706 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1707 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001708 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001709 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1710
Tejun Heof3f90ad2013-04-01 11:23:34 -07001711 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001712 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001713 if (IS_ERR(worker->task))
1714 goto fail;
1715
Oleg Nesterov91151222013-11-14 12:56:18 +01001716 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001717 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001718
Lai Jiangshanda028462014-05-20 17:46:31 +08001719 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001720 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001721
Lai Jiangshan051e1852014-07-22 13:03:02 +08001722 /* start the newly created worker */
1723 spin_lock_irq(&pool->lock);
1724 worker->pool->nr_workers++;
1725 worker_enter_idle(worker);
1726 wake_up_process(worker->task);
1727 spin_unlock_irq(&pool->lock);
1728
Tejun Heoc34056a2010-06-29 10:07:11 +02001729 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001730
Tejun Heoc34056a2010-06-29 10:07:11 +02001731fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001732 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001733 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001734 kfree(worker);
1735 return NULL;
1736}
1737
1738/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001739 * destroy_worker - destroy a workqueue worker
1740 * @worker: worker to be destroyed
1741 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001742 * Destroy @worker and adjust @pool stats accordingly. The worker should
1743 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001744 *
1745 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001746 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001747 */
1748static void destroy_worker(struct worker *worker)
1749{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001750 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001751
Tejun Heocd549682013-03-13 19:47:39 -07001752 lockdep_assert_held(&pool->lock);
1753
Tejun Heoc34056a2010-06-29 10:07:11 +02001754 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001755 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001756 WARN_ON(!list_empty(&worker->scheduled)) ||
1757 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001758 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001759
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001760 pool->nr_workers--;
1761 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001762
Tejun Heoc8e55f32010-06-29 10:07:12 +02001763 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001764 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001765 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001766}
1767
Tejun Heo63d95a92012-07-12 14:46:37 -07001768static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001769{
Tejun Heo63d95a92012-07-12 14:46:37 -07001770 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001771
Tejun Heod565ed62013-01-24 11:01:33 -08001772 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001773
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001774 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001775 struct worker *worker;
1776 unsigned long expires;
1777
1778 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001779 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001780 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1781
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001782 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001783 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001784 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001785 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001786
1787 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001788 }
1789
Tejun Heod565ed62013-01-24 11:01:33 -08001790 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001791}
1792
Tejun Heo493a1722013-03-12 11:29:59 -07001793static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001794{
Tejun Heo112202d2013-02-13 19:29:12 -08001795 struct pool_workqueue *pwq = get_work_pwq(work);
1796 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001797
Tejun Heo2e109a22013-03-13 19:47:40 -07001798 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001799
Tejun Heo493008a2013-03-12 11:30:03 -07001800 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001801 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001802
1803 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001804 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001805 /*
1806 * If @pwq is for an unbound wq, its base ref may be put at
1807 * any time due to an attribute change. Pin @pwq until the
1808 * rescuer is done with it.
1809 */
1810 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001811 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001812 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001813 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001814}
1815
Tejun Heo706026c2013-01-24 11:01:34 -08001816static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001817{
Tejun Heo63d95a92012-07-12 14:46:37 -07001818 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001819 struct work_struct *work;
1820
Tejun Heob2d82902014-12-08 12:39:16 -05001821 spin_lock_irq(&pool->lock);
1822 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001823
Tejun Heo63d95a92012-07-12 14:46:37 -07001824 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001825 /*
1826 * We've been trying to create a new worker but
1827 * haven't been successful. We might be hitting an
1828 * allocation deadlock. Send distress signals to
1829 * rescuers.
1830 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001831 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001832 send_mayday(work);
1833 }
1834
Tejun Heob2d82902014-12-08 12:39:16 -05001835 spin_unlock(&wq_mayday_lock);
1836 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001837
Tejun Heo63d95a92012-07-12 14:46:37 -07001838 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001839}
1840
1841/**
1842 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001843 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001844 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001845 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001846 * have at least one idle worker on return from this function. If
1847 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001848 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001849 * possible allocation deadlock.
1850 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001851 * On return, need_to_create_worker() is guaranteed to be %false and
1852 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001853 *
1854 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001855 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001856 * multiple times. Does GFP_KERNEL allocations. Called only from
1857 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001858 */
Tejun Heo29187a92015-01-16 14:21:16 -05001859static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001860__releases(&pool->lock)
1861__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001862{
Tejun Heoe22bee72010-06-29 10:07:14 +02001863restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001864 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001865
Tejun Heoe22bee72010-06-29 10:07:14 +02001866 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001867 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001868
1869 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001870 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001871 break;
1872
Lai Jiangshane212f362014-06-03 15:32:17 +08001873 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001874
Tejun Heo63d95a92012-07-12 14:46:37 -07001875 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001876 break;
1877 }
1878
Tejun Heo63d95a92012-07-12 14:46:37 -07001879 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001880 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001881 /*
1882 * This is necessary even after a new worker was just successfully
1883 * created as @pool->lock was dropped and the new worker might have
1884 * already become busy.
1885 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001886 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001887 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001888}
1889
1890/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001891 * manage_workers - manage worker pool
1892 * @worker: self
1893 *
Tejun Heo706026c2013-01-24 11:01:34 -08001894 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001895 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001896 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001897 *
1898 * The caller can safely start processing works on false return. On
1899 * true return, it's guaranteed that need_to_create_worker() is false
1900 * and may_start_working() is true.
1901 *
1902 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001903 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001904 * multiple times. Does GFP_KERNEL allocations.
1905 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001906 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001907 * %false if the pool doesn't need management and the caller can safely
1908 * start processing works, %true if management function was performed and
1909 * the conditions that the caller verified before calling the function may
1910 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001911 */
1912static bool manage_workers(struct worker *worker)
1913{
Tejun Heo63d95a92012-07-12 14:46:37 -07001914 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001915
Tejun Heobc3a1af2013-03-13 19:47:39 -07001916 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07001917 * Anyone who successfully grabs manager_arb wins the arbitration
1918 * and becomes the manager. mutex_trylock() on pool->manager_arb
1919 * failure while holding pool->lock reliably indicates that someone
1920 * else is managing the pool and the worker which failed trylock
1921 * can proceed to executing work items. This means that anyone
1922 * grabbing manager_arb is responsible for actually performing
1923 * manager duties. If manager_arb is grabbed and released without
1924 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07001925 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07001926 if (!mutex_trylock(&pool->manager_arb))
Tejun Heo29187a92015-01-16 14:21:16 -05001927 return false;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001928 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001929
Tejun Heo29187a92015-01-16 14:21:16 -05001930 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001931
Tejun Heo2607d7a2015-03-09 09:22:28 -04001932 pool->manager = NULL;
Tejun Heo34a06bd2013-03-12 11:30:00 -07001933 mutex_unlock(&pool->manager_arb);
Tejun Heo29187a92015-01-16 14:21:16 -05001934 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02001935}
1936
Tejun Heoa62428c2010-06-29 10:07:10 +02001937/**
1938 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001939 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001940 * @work: work to process
1941 *
1942 * Process @work. This function contains all the logics necessary to
1943 * process a single work including synchronization against and
1944 * interaction with other workers on the same cpu, queueing and
1945 * flushing. As long as context requirement is met, any worker can
1946 * call this function to process a work.
1947 *
1948 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001949 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001950 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001951static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08001952__releases(&pool->lock)
1953__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02001954{
Tejun Heo112202d2013-02-13 19:29:12 -08001955 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001956 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001957 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02001958 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001959 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001960#ifdef CONFIG_LOCKDEP
1961 /*
1962 * It is permissible to free the struct work_struct from
1963 * inside the function that is called from it, this we need to
1964 * take into account for lockdep too. To avoid bogus "held
1965 * lock freed" warnings as well as problems when looking into
1966 * work->lockdep_map, make a copy and use that here.
1967 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07001968 struct lockdep_map lockdep_map;
1969
1970 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02001971#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08001972 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08001973 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08001974 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07001975
Tejun Heo7e116292010-06-29 10:07:13 +02001976 /*
1977 * A single work shouldn't be executed concurrently by
1978 * multiple workers on a single cpu. Check whether anyone is
1979 * already processing the work. If so, defer the work to the
1980 * currently executing one.
1981 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001982 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02001983 if (unlikely(collision)) {
1984 move_linked_works(work, &collision->scheduled, NULL);
1985 return;
1986 }
1987
Tejun Heo8930cab2012-08-03 10:30:45 -07001988 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02001989 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001990 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02001991 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08001992 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08001993 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001994 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001995
Tejun Heoa62428c2010-06-29 10:07:10 +02001996 list_del_init(&work->entry);
1997
Tejun Heo649027d2010-06-29 10:07:14 +02001998 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08001999 * CPU intensive works don't participate in concurrency management.
2000 * They're the scheduler's responsibility. This takes @worker out
2001 * of concurrency management and the next code block will chain
2002 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002003 */
2004 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002005 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002006
Tejun Heo974271c42012-07-12 14:46:37 -07002007 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002008 * Wake up another worker if necessary. The condition is always
2009 * false for normal per-cpu workers since nr_running would always
2010 * be >= 1 at this point. This is used to chain execution of the
2011 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002012 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c42012-07-12 14:46:37 -07002013 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002014 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002015 wake_up_worker(pool);
Tejun Heo974271c42012-07-12 14:46:37 -07002016
Tejun Heo8930cab2012-08-03 10:30:45 -07002017 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002018 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002019 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002020 * PENDING and queued state changes happen together while IRQ is
2021 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002022 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002023 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002024
Tejun Heod565ed62013-01-24 11:01:33 -08002025 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002026
Tejun Heo112202d2013-02-13 19:29:12 -08002027 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002028 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002029 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002030 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002031 /*
2032 * While we must be careful to not use "work" after this, the trace
2033 * point will only record its address.
2034 */
2035 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002036 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002037 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002038
2039 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002040 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2041 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002042 current->comm, preempt_count(), task_pid_nr(current),
2043 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002044 debug_show_held_locks(current);
2045 dump_stack();
2046 }
2047
Tejun Heob22ce272013-08-28 17:33:37 -04002048 /*
2049 * The following prevents a kworker from hogging CPU on !PREEMPT
2050 * kernels, where a requeueing work item waiting for something to
2051 * happen could deadlock with stop_machine as such work item could
2052 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002053 * stop_machine. At the same time, report a quiescent RCU state so
2054 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002055 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002056 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002057
Tejun Heod565ed62013-01-24 11:01:33 -08002058 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002059
Tejun Heofb0e7be2010-06-29 10:07:15 +02002060 /* clear cpu intensive status */
2061 if (unlikely(cpu_intensive))
2062 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2063
Tejun Heoa62428c2010-06-29 10:07:10 +02002064 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002065 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002066 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002067 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002068 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002069 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002070 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002071}
2072
Tejun Heoaffee4b2010-06-29 10:07:12 +02002073/**
2074 * process_scheduled_works - process scheduled works
2075 * @worker: self
2076 *
2077 * Process all scheduled works. Please note that the scheduled list
2078 * may change while processing a work, so this function repeatedly
2079 * fetches a work from the top and executes it.
2080 *
2081 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002082 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002083 * multiple times.
2084 */
2085static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002087 while (!list_empty(&worker->scheduled)) {
2088 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002090 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092}
2093
Tejun Heo4690c4a2010-06-29 10:07:10 +02002094/**
2095 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002096 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002097 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002098 * The worker thread function. All workers belong to a worker_pool -
2099 * either a per-cpu one or dynamic unbound one. These workers process all
2100 * work items regardless of their specific target workqueue. The only
2101 * exception is work items which belong to workqueues with a rescuer which
2102 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002103 *
2104 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002105 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002106static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107{
Tejun Heoc34056a2010-06-29 10:07:11 +02002108 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002109 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110
Tejun Heoe22bee72010-06-29 10:07:14 +02002111 /* tell the scheduler that this is a workqueue worker */
2112 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002113woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002114 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002115
Tejun Heoa9ab7752013-03-19 13:45:21 -07002116 /* am I supposed to die? */
2117 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002118 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002119 WARN_ON_ONCE(!list_empty(&worker->entry));
2120 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002121
2122 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002123 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002124 worker_detach_from_pool(worker, pool);
2125 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002126 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002128
Tejun Heoc8e55f32010-06-29 10:07:12 +02002129 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002130recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002131 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002132 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002133 goto sleep;
2134
2135 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002136 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002137 goto recheck;
2138
Tejun Heoc8e55f32010-06-29 10:07:12 +02002139 /*
2140 * ->scheduled list can only be filled while a worker is
2141 * preparing to process a work or actually processing it.
2142 * Make sure nobody diddled with it while I was sleeping.
2143 */
Tejun Heo6183c002013-03-12 11:29:57 -07002144 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002145
Tejun Heoe22bee72010-06-29 10:07:14 +02002146 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002147 * Finish PREP stage. We're guaranteed to have at least one idle
2148 * worker or that someone else has already assumed the manager
2149 * role. This is where @worker starts participating in concurrency
2150 * management if applicable and concurrency management is restored
2151 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002152 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002153 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002154
2155 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002156 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002157 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002158 struct work_struct, entry);
2159
2160 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2161 /* optimization path, not strictly necessary */
2162 process_one_work(worker, work);
2163 if (unlikely(!list_empty(&worker->scheduled)))
2164 process_scheduled_works(worker);
2165 } else {
2166 move_linked_works(work, &worker->scheduled, NULL);
2167 process_scheduled_works(worker);
2168 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002169 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002170
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002171 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002172sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002173 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002174 * pool->lock is held and there's no work to process and no need to
2175 * manage, sleep. Workers are woken up only while holding
2176 * pool->lock or from local cpu, so setting the current state
2177 * before releasing pool->lock is enough to prevent losing any
2178 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002179 */
2180 worker_enter_idle(worker);
2181 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002182 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002183 schedule();
2184 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185}
2186
Tejun Heoe22bee72010-06-29 10:07:14 +02002187/**
2188 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002189 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002190 *
2191 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002192 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002193 *
Tejun Heo706026c2013-01-24 11:01:34 -08002194 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002195 * worker which uses GFP_KERNEL allocation which has slight chance of
2196 * developing into deadlock if some works currently on the same queue
2197 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2198 * the problem rescuer solves.
2199 *
Tejun Heo706026c2013-01-24 11:01:34 -08002200 * When such condition is possible, the pool summons rescuers of all
2201 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002202 * those works so that forward progress can be guaranteed.
2203 *
2204 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002205 *
2206 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002207 */
Tejun Heo111c2252013-01-17 17:16:24 -08002208static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002209{
Tejun Heo111c2252013-01-17 17:16:24 -08002210 struct worker *rescuer = __rescuer;
2211 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002212 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002213 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002214
2215 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002216
2217 /*
2218 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2219 * doesn't participate in concurrency management.
2220 */
2221 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002222repeat:
2223 set_current_state(TASK_INTERRUPTIBLE);
2224
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002225 /*
2226 * By the time the rescuer is requested to stop, the workqueue
2227 * shouldn't have any work pending, but @wq->maydays may still have
2228 * pwq(s) queued. This can happen by non-rescuer workers consuming
2229 * all the work items before the rescuer got to them. Go through
2230 * @wq->maydays processing before acting on should_stop so that the
2231 * list is always empty on exit.
2232 */
2233 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002234
Tejun Heo493a1722013-03-12 11:29:59 -07002235 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002236 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002237
2238 while (!list_empty(&wq->maydays)) {
2239 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2240 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002241 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002242 struct work_struct *work, *n;
2243
2244 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002245 list_del_init(&pwq->mayday_node);
2246
Tejun Heo2e109a22013-03-13 19:47:40 -07002247 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002248
Lai Jiangshan51697d392014-05-20 17:46:36 +08002249 worker_attach_to_pool(rescuer, pool);
2250
2251 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002252 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002253
2254 /*
2255 * Slurp in all works issued via this workqueue and
2256 * process'em.
2257 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002258 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002259 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002260 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002261 move_linked_works(work, scheduled, &n);
2262
NeilBrown008847f2014-12-08 12:39:16 -05002263 if (!list_empty(scheduled)) {
2264 process_scheduled_works(rescuer);
2265
2266 /*
2267 * The above execution of rescued work items could
2268 * have created more to rescue through
2269 * pwq_activate_first_delayed() or chained
2270 * queueing. Let's put @pwq back on mayday list so
2271 * that such back-to-back work items, which may be
2272 * being used to relieve memory pressure, don't
2273 * incur MAYDAY_INTERVAL delay inbetween.
2274 */
2275 if (need_to_create_worker(pool)) {
2276 spin_lock(&wq_mayday_lock);
2277 get_pwq(pwq);
2278 list_move_tail(&pwq->mayday_node, &wq->maydays);
2279 spin_unlock(&wq_mayday_lock);
2280 }
2281 }
Tejun Heo75769582011-02-14 14:04:46 +01002282
2283 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002284 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002285 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002286 */
2287 put_pwq(pwq);
2288
2289 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002290 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002291 * regular worker; otherwise, we end up with 0 concurrency
2292 * and stalling the execution.
2293 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002294 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002295 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002296
Lai Jiangshanb3104102013-02-19 12:17:02 -08002297 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002298 spin_unlock_irq(&pool->lock);
2299
2300 worker_detach_from_pool(rescuer, pool);
2301
2302 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002303 }
2304
Tejun Heo2e109a22013-03-13 19:47:40 -07002305 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002306
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002307 if (should_stop) {
2308 __set_current_state(TASK_RUNNING);
2309 rescuer->task->flags &= ~PF_WQ_WORKER;
2310 return 0;
2311 }
2312
Tejun Heo111c2252013-01-17 17:16:24 -08002313 /* rescuers should never participate in concurrency management */
2314 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002315 schedule();
2316 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317}
2318
Tejun Heofca839c2015-12-07 10:58:57 -05002319/**
2320 * check_flush_dependency - check for flush dependency sanity
2321 * @target_wq: workqueue being flushed
2322 * @target_work: work item being flushed (NULL for workqueue flushes)
2323 *
2324 * %current is trying to flush the whole @target_wq or @target_work on it.
2325 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2326 * reclaiming memory or running on a workqueue which doesn't have
2327 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2328 * a deadlock.
2329 */
2330static void check_flush_dependency(struct workqueue_struct *target_wq,
2331 struct work_struct *target_work)
2332{
2333 work_func_t target_func = target_work ? target_work->func : NULL;
2334 struct worker *worker;
2335
2336 if (target_wq->flags & WQ_MEM_RECLAIM)
2337 return;
2338
2339 worker = current_wq_worker();
2340
2341 WARN_ONCE(current->flags & PF_MEMALLOC,
2342 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2343 current->pid, current->comm, target_wq->name, target_func);
2344 WARN_ONCE(worker && (worker->current_pwq->wq->flags & WQ_MEM_RECLAIM),
2345 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2346 worker->current_pwq->wq->name, worker->current_func,
2347 target_wq->name, target_func);
2348}
2349
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002350struct wq_barrier {
2351 struct work_struct work;
2352 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002353 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002354};
2355
2356static void wq_barrier_func(struct work_struct *work)
2357{
2358 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2359 complete(&barr->done);
2360}
2361
Tejun Heo4690c4a2010-06-29 10:07:10 +02002362/**
2363 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002364 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002365 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002366 * @target: target work to attach @barr to
2367 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002368 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002369 * @barr is linked to @target such that @barr is completed only after
2370 * @target finishes execution. Please note that the ordering
2371 * guarantee is observed only with respect to @target and on the local
2372 * cpu.
2373 *
2374 * Currently, a queued barrier can't be canceled. This is because
2375 * try_to_grab_pending() can't determine whether the work to be
2376 * grabbed is at the head of the queue and thus can't clear LINKED
2377 * flag of the previous work while there must be a valid next work
2378 * after a work with LINKED flag set.
2379 *
2380 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002381 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002382 *
2383 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002384 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002385 */
Tejun Heo112202d2013-02-13 19:29:12 -08002386static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002387 struct wq_barrier *barr,
2388 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002389{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002390 struct list_head *head;
2391 unsigned int linked = 0;
2392
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002393 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002394 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002395 * as we know for sure that this will not trigger any of the
2396 * checks and call back into the fixup functions where we
2397 * might deadlock.
2398 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002399 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002400 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002401 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002402 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002403
Tejun Heoaffee4b2010-06-29 10:07:12 +02002404 /*
2405 * If @target is currently being executed, schedule the
2406 * barrier to the worker; otherwise, put it after @target.
2407 */
2408 if (worker)
2409 head = worker->scheduled.next;
2410 else {
2411 unsigned long *bits = work_data_bits(target);
2412
2413 head = target->entry.next;
2414 /* there can already be other linked works, inherit and set */
2415 linked = *bits & WORK_STRUCT_LINKED;
2416 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2417 }
2418
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002419 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002420 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002421 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002422}
2423
Tejun Heo73f53c42010-06-29 10:07:11 +02002424/**
Tejun Heo112202d2013-02-13 19:29:12 -08002425 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002426 * @wq: workqueue being flushed
2427 * @flush_color: new flush color, < 0 for no-op
2428 * @work_color: new work color, < 0 for no-op
2429 *
Tejun Heo112202d2013-02-13 19:29:12 -08002430 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002431 *
Tejun Heo112202d2013-02-13 19:29:12 -08002432 * If @flush_color is non-negative, flush_color on all pwqs should be
2433 * -1. If no pwq has in-flight commands at the specified color, all
2434 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2435 * has in flight commands, its pwq->flush_color is set to
2436 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002437 * wakeup logic is armed and %true is returned.
2438 *
2439 * The caller should have initialized @wq->first_flusher prior to
2440 * calling this function with non-negative @flush_color. If
2441 * @flush_color is negative, no flush color update is done and %false
2442 * is returned.
2443 *
Tejun Heo112202d2013-02-13 19:29:12 -08002444 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002445 * work_color which is previous to @work_color and all will be
2446 * advanced to @work_color.
2447 *
2448 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002449 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002450 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002451 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002452 * %true if @flush_color >= 0 and there's something to flush. %false
2453 * otherwise.
2454 */
Tejun Heo112202d2013-02-13 19:29:12 -08002455static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002456 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457{
Tejun Heo73f53c42010-06-29 10:07:11 +02002458 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002459 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002460
Tejun Heo73f53c42010-06-29 10:07:11 +02002461 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002462 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002463 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002464 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002465
Tejun Heo49e3cf42013-03-12 11:29:58 -07002466 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002467 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002468
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002469 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002470
2471 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002472 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002473
Tejun Heo112202d2013-02-13 19:29:12 -08002474 if (pwq->nr_in_flight[flush_color]) {
2475 pwq->flush_color = flush_color;
2476 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002477 wait = true;
2478 }
2479 }
2480
2481 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002482 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002483 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002484 }
2485
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002486 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002487 }
2488
Tejun Heo112202d2013-02-13 19:29:12 -08002489 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002490 complete(&wq->first_flusher->done);
2491
2492 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493}
2494
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002495/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002497 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002499 * This function sleeps until all work items which were queued on entry
2500 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002502void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503{
Tejun Heo73f53c42010-06-29 10:07:11 +02002504 struct wq_flusher this_flusher = {
2505 .list = LIST_HEAD_INIT(this_flusher.list),
2506 .flush_color = -1,
2507 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2508 };
2509 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002510
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002511 lock_map_acquire(&wq->lockdep_map);
2512 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002513
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002514 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002515
2516 /*
2517 * Start-to-wait phase
2518 */
2519 next_color = work_next_color(wq->work_color);
2520
2521 if (next_color != wq->flush_color) {
2522 /*
2523 * Color space is not full. The current work_color
2524 * becomes our flush_color and work_color is advanced
2525 * by one.
2526 */
Tejun Heo6183c002013-03-12 11:29:57 -07002527 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002528 this_flusher.flush_color = wq->work_color;
2529 wq->work_color = next_color;
2530
2531 if (!wq->first_flusher) {
2532 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002533 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002534
2535 wq->first_flusher = &this_flusher;
2536
Tejun Heo112202d2013-02-13 19:29:12 -08002537 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002538 wq->work_color)) {
2539 /* nothing to flush, done */
2540 wq->flush_color = next_color;
2541 wq->first_flusher = NULL;
2542 goto out_unlock;
2543 }
2544 } else {
2545 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002546 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002547 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002548 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002549 }
2550 } else {
2551 /*
2552 * Oops, color space is full, wait on overflow queue.
2553 * The next flush completion will assign us
2554 * flush_color and transfer to flusher_queue.
2555 */
2556 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2557 }
2558
Tejun Heofca839c2015-12-07 10:58:57 -05002559 check_flush_dependency(wq, NULL);
2560
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002561 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002562
2563 wait_for_completion(&this_flusher.done);
2564
2565 /*
2566 * Wake-up-and-cascade phase
2567 *
2568 * First flushers are responsible for cascading flushes and
2569 * handling overflow. Non-first flushers can simply return.
2570 */
2571 if (wq->first_flusher != &this_flusher)
2572 return;
2573
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002574 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002575
Tejun Heo4ce48b32010-07-02 10:03:51 +02002576 /* we might have raced, check again with mutex held */
2577 if (wq->first_flusher != &this_flusher)
2578 goto out_unlock;
2579
Tejun Heo73f53c42010-06-29 10:07:11 +02002580 wq->first_flusher = NULL;
2581
Tejun Heo6183c002013-03-12 11:29:57 -07002582 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2583 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002584
2585 while (true) {
2586 struct wq_flusher *next, *tmp;
2587
2588 /* complete all the flushers sharing the current flush color */
2589 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2590 if (next->flush_color != wq->flush_color)
2591 break;
2592 list_del_init(&next->list);
2593 complete(&next->done);
2594 }
2595
Tejun Heo6183c002013-03-12 11:29:57 -07002596 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2597 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002598
2599 /* this flush_color is finished, advance by one */
2600 wq->flush_color = work_next_color(wq->flush_color);
2601
2602 /* one color has been freed, handle overflow queue */
2603 if (!list_empty(&wq->flusher_overflow)) {
2604 /*
2605 * Assign the same color to all overflowed
2606 * flushers, advance work_color and append to
2607 * flusher_queue. This is the start-to-wait
2608 * phase for these overflowed flushers.
2609 */
2610 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2611 tmp->flush_color = wq->work_color;
2612
2613 wq->work_color = work_next_color(wq->work_color);
2614
2615 list_splice_tail_init(&wq->flusher_overflow,
2616 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002617 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002618 }
2619
2620 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002621 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002622 break;
2623 }
2624
2625 /*
2626 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002627 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002628 */
Tejun Heo6183c002013-03-12 11:29:57 -07002629 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2630 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002631
2632 list_del_init(&next->list);
2633 wq->first_flusher = next;
2634
Tejun Heo112202d2013-02-13 19:29:12 -08002635 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002636 break;
2637
2638 /*
2639 * Meh... this color is already done, clear first
2640 * flusher and repeat cascading.
2641 */
2642 wq->first_flusher = NULL;
2643 }
2644
2645out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002646 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002648EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002650/**
2651 * drain_workqueue - drain a workqueue
2652 * @wq: workqueue to drain
2653 *
2654 * Wait until the workqueue becomes empty. While draining is in progress,
2655 * only chain queueing is allowed. IOW, only currently pending or running
2656 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002657 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002658 * by the depth of chaining and should be relatively short. Whine if it
2659 * takes too long.
2660 */
2661void drain_workqueue(struct workqueue_struct *wq)
2662{
2663 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002664 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002665
2666 /*
2667 * __queue_work() needs to test whether there are drainers, is much
2668 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002669 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002670 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002671 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002672 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002673 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002674 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002675reflush:
2676 flush_workqueue(wq);
2677
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002678 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002679
Tejun Heo49e3cf42013-03-12 11:29:58 -07002680 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002681 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002682
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002683 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002684 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002685 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002686
2687 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002688 continue;
2689
2690 if (++flush_cnt == 10 ||
2691 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002692 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002693 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002694
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002695 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002696 goto reflush;
2697 }
2698
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002699 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002700 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002701 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002702}
2703EXPORT_SYMBOL_GPL(drain_workqueue);
2704
Tejun Heo606a5022012-08-20 14:51:23 -07002705static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002706{
2707 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002708 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002709 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002710
2711 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002712
Tejun Heofa1b54e2013-03-12 11:30:00 -07002713 local_irq_disable();
2714 pool = get_work_pool(work);
2715 if (!pool) {
2716 local_irq_enable();
2717 return false;
2718 }
2719
2720 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002721 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002722 pwq = get_work_pwq(work);
2723 if (pwq) {
2724 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002725 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002726 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002727 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002728 if (!worker)
2729 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002730 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002731 }
Tejun Heobaf59022010-09-16 10:42:16 +02002732
Tejun Heofca839c2015-12-07 10:58:57 -05002733 check_flush_dependency(pwq->wq, work);
2734
Tejun Heo112202d2013-02-13 19:29:12 -08002735 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002736 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002737
Tejun Heoe159489b2011-01-09 23:32:15 +01002738 /*
2739 * If @max_active is 1 or rescuer is in use, flushing another work
2740 * item on the same workqueue may lead to deadlock. Make sure the
2741 * flusher is not running on the same workqueue by verifying write
2742 * access.
2743 */
Tejun Heo493008a2013-03-12 11:30:03 -07002744 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002745 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe159489b2011-01-09 23:32:15 +01002746 else
Tejun Heo112202d2013-02-13 19:29:12 -08002747 lock_map_acquire_read(&pwq->wq->lockdep_map);
2748 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe159489b2011-01-09 23:32:15 +01002749
Tejun Heobaf59022010-09-16 10:42:16 +02002750 return true;
2751already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002752 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002753 return false;
2754}
2755
Oleg Nesterovdb700892008-07-25 01:47:49 -07002756/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002757 * flush_work - wait for a work to finish executing the last queueing instance
2758 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002759 *
Tejun Heo606a5022012-08-20 14:51:23 -07002760 * Wait until @work has finished execution. @work is guaranteed to be idle
2761 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002762 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002763 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002764 * %true if flush_work() waited for the work to finish execution,
2765 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002766 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002767bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002768{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002769 struct wq_barrier barr;
2770
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002771 lock_map_acquire(&work->lockdep_map);
2772 lock_map_release(&work->lockdep_map);
2773
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002774 if (start_flush_work(work, &barr)) {
2775 wait_for_completion(&barr.done);
2776 destroy_work_on_stack(&barr.work);
2777 return true;
2778 } else {
2779 return false;
2780 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002781}
2782EXPORT_SYMBOL_GPL(flush_work);
2783
Tejun Heo8603e1b32015-03-05 08:04:13 -05002784struct cwt_wait {
2785 wait_queue_t wait;
2786 struct work_struct *work;
2787};
2788
2789static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2790{
2791 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2792
2793 if (cwait->work != key)
2794 return 0;
2795 return autoremove_wake_function(wait, mode, sync, key);
2796}
2797
Tejun Heo36e227d2012-08-03 10:30:46 -07002798static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002799{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002800 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002801 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002802 int ret;
2803
2804 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002805 ret = try_to_grab_pending(work, is_dwork, &flags);
2806 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002807 * If someone else is already canceling, wait for it to
2808 * finish. flush_work() doesn't work for PREEMPT_NONE
2809 * because we may get scheduled between @work's completion
2810 * and the other canceling task resuming and clearing
2811 * CANCELING - flush_work() will return false immediately
2812 * as @work is no longer busy, try_to_grab_pending() will
2813 * return -ENOENT as @work is still being canceled and the
2814 * other canceling task won't be able to clear CANCELING as
2815 * we're hogging the CPU.
2816 *
2817 * Let's wait for completion using a waitqueue. As this
2818 * may lead to the thundering herd problem, use a custom
2819 * wake function which matches @work along with exclusive
2820 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002821 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002822 if (unlikely(ret == -ENOENT)) {
2823 struct cwt_wait cwait;
2824
2825 init_wait(&cwait.wait);
2826 cwait.wait.func = cwt_wakefn;
2827 cwait.work = work;
2828
2829 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2830 TASK_UNINTERRUPTIBLE);
2831 if (work_is_canceling(work))
2832 schedule();
2833 finish_wait(&cancel_waitq, &cwait.wait);
2834 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002835 } while (unlikely(ret < 0));
2836
Tejun Heobbb68df2012-08-03 10:30:46 -07002837 /* tell other tasks trying to grab @work to back off */
2838 mark_work_canceling(work);
2839 local_irq_restore(flags);
2840
Tejun Heo606a5022012-08-20 14:51:23 -07002841 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002842 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002843
2844 /*
2845 * Paired with prepare_to_wait() above so that either
2846 * waitqueue_active() is visible here or !work_is_canceling() is
2847 * visible there.
2848 */
2849 smp_mb();
2850 if (waitqueue_active(&cancel_waitq))
2851 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2852
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002853 return ret;
2854}
2855
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002856/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002857 * cancel_work_sync - cancel a work and wait for it to finish
2858 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002859 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002860 * Cancel @work and wait for its execution to finish. This function
2861 * can be used even if the work re-queues itself or migrates to
2862 * another workqueue. On return from this function, @work is
2863 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002864 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002865 * cancel_work_sync(&delayed_work->work) must not be used for
2866 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002867 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002868 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002869 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002870 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002871 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002872 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002873 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002874bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002875{
Tejun Heo36e227d2012-08-03 10:30:46 -07002876 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002877}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002878EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002879
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002880/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002881 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2882 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002883 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002884 * Delayed timer is cancelled and the pending work is queued for
2885 * immediate execution. Like flush_work(), this function only
2886 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002887 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002888 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002889 * %true if flush_work() waited for the work to finish execution,
2890 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002891 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002892bool flush_delayed_work(struct delayed_work *dwork)
2893{
Tejun Heo8930cab2012-08-03 10:30:45 -07002894 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002895 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002896 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002897 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002898 return flush_work(&dwork->work);
2899}
2900EXPORT_SYMBOL(flush_delayed_work);
2901
2902/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002903 * cancel_delayed_work - cancel a delayed work
2904 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002905 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002906 * Kill off a pending delayed_work.
2907 *
2908 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2909 * pending.
2910 *
2911 * Note:
2912 * The work callback function may still be running on return, unless
2913 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2914 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002915 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002916 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002917 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002918bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002919{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002920 unsigned long flags;
2921 int ret;
2922
2923 do {
2924 ret = try_to_grab_pending(&dwork->work, true, &flags);
2925 } while (unlikely(ret == -EAGAIN));
2926
2927 if (unlikely(ret < 0))
2928 return false;
2929
Tejun Heo7c3eed52013-01-24 11:01:33 -08002930 set_work_pool_and_clear_pending(&dwork->work,
2931 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002932 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002933 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002934}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002935EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002936
2937/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002938 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2939 * @dwork: the delayed work cancel
2940 *
2941 * This is cancel_work_sync() for delayed works.
2942 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002943 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002944 * %true if @dwork was pending, %false otherwise.
2945 */
2946bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002947{
Tejun Heo36e227d2012-08-03 10:30:46 -07002948 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002949}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002950EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002951
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002952/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002953 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002954 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002955 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002956 * schedule_on_each_cpu() executes @func on each online CPU using the
2957 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002958 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002959 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002960 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02002961 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002962 */
David Howells65f27f32006-11-22 14:55:48 +00002963int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba82006-01-08 01:00:43 -08002964{
2965 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002966 struct work_struct __percpu *works;
Christoph Lameter15316ba82006-01-08 01:00:43 -08002967
Andrew Mortonb6136772006-06-25 05:47:49 -07002968 works = alloc_percpu(struct work_struct);
2969 if (!works)
Christoph Lameter15316ba82006-01-08 01:00:43 -08002970 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002971
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002972 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002973
Christoph Lameter15316ba82006-01-08 01:00:43 -08002974 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002975 struct work_struct *work = per_cpu_ptr(works, cpu);
2976
2977 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002978 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002979 }
Tejun Heo93981802009-11-17 14:06:20 -08002980
2981 for_each_online_cpu(cpu)
2982 flush_work(per_cpu_ptr(works, cpu));
2983
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002984 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002985 free_percpu(works);
Christoph Lameter15316ba82006-01-08 01:00:43 -08002986 return 0;
2987}
2988
Alan Sterneef6a7d2010-02-12 17:39:21 +09002989/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002990 * execute_in_process_context - reliably execute the routine with user context
2991 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002992 * @ew: guaranteed storage for the execute work structure (must
2993 * be available when the work executes)
2994 *
2995 * Executes the function immediately if process context is available,
2996 * otherwise schedules the function for delayed execution.
2997 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002998 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06002999 * 1 - function was scheduled for execution
3000 */
David Howells65f27f32006-11-22 14:55:48 +00003001int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003002{
3003 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003004 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003005 return 0;
3006 }
3007
David Howells65f27f32006-11-22 14:55:48 +00003008 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003009 schedule_work(&ew->work);
3010
3011 return 1;
3012}
3013EXPORT_SYMBOL_GPL(execute_in_process_context);
3014
Tejun Heo7a4e3442013-03-12 11:30:00 -07003015/**
3016 * free_workqueue_attrs - free a workqueue_attrs
3017 * @attrs: workqueue_attrs to free
3018 *
3019 * Undo alloc_workqueue_attrs().
3020 */
3021void free_workqueue_attrs(struct workqueue_attrs *attrs)
3022{
3023 if (attrs) {
3024 free_cpumask_var(attrs->cpumask);
3025 kfree(attrs);
3026 }
3027}
3028
3029/**
3030 * alloc_workqueue_attrs - allocate a workqueue_attrs
3031 * @gfp_mask: allocation mask to use
3032 *
3033 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003034 * return it.
3035 *
3036 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003037 */
3038struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3039{
3040 struct workqueue_attrs *attrs;
3041
3042 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3043 if (!attrs)
3044 goto fail;
3045 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3046 goto fail;
3047
Tejun Heo13e2e552013-04-01 11:23:31 -07003048 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003049 return attrs;
3050fail:
3051 free_workqueue_attrs(attrs);
3052 return NULL;
3053}
3054
Tejun Heo29c91e92013-03-12 11:30:03 -07003055static void copy_workqueue_attrs(struct workqueue_attrs *to,
3056 const struct workqueue_attrs *from)
3057{
3058 to->nice = from->nice;
3059 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003060 /*
3061 * Unlike hash and equality test, this function doesn't ignore
3062 * ->no_numa as it is used for both pool and wq attrs. Instead,
3063 * get_unbound_pool() explicitly clears ->no_numa after copying.
3064 */
3065 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003066}
3067
Tejun Heo29c91e92013-03-12 11:30:03 -07003068/* hash value of the content of @attr */
3069static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3070{
3071 u32 hash = 0;
3072
3073 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003074 hash = jhash(cpumask_bits(attrs->cpumask),
3075 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003076 return hash;
3077}
3078
3079/* content equality test */
3080static bool wqattrs_equal(const struct workqueue_attrs *a,
3081 const struct workqueue_attrs *b)
3082{
3083 if (a->nice != b->nice)
3084 return false;
3085 if (!cpumask_equal(a->cpumask, b->cpumask))
3086 return false;
3087 return true;
3088}
3089
Tejun Heo7a4e3442013-03-12 11:30:00 -07003090/**
3091 * init_worker_pool - initialize a newly zalloc'd worker_pool
3092 * @pool: worker_pool to initialize
3093 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303094 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003095 *
3096 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003097 * inside @pool proper are initialized and put_unbound_pool() can be called
3098 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003099 */
3100static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003101{
3102 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003103 pool->id = -1;
3104 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003105 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003106 pool->flags |= POOL_DISASSOCIATED;
3107 INIT_LIST_HEAD(&pool->worklist);
3108 INIT_LIST_HEAD(&pool->idle_list);
3109 hash_init(pool->busy_hash);
3110
3111 init_timer_deferrable(&pool->idle_timer);
3112 pool->idle_timer.function = idle_worker_timeout;
3113 pool->idle_timer.data = (unsigned long)pool;
3114
3115 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3116 (unsigned long)pool);
3117
3118 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003119 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003120 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003121
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003122 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003123 INIT_HLIST_NODE(&pool->hash_node);
3124 pool->refcnt = 1;
3125
3126 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003127 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3128 if (!pool->attrs)
3129 return -ENOMEM;
3130 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003131}
3132
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003133static void rcu_free_wq(struct rcu_head *rcu)
3134{
3135 struct workqueue_struct *wq =
3136 container_of(rcu, struct workqueue_struct, rcu);
3137
3138 if (!(wq->flags & WQ_UNBOUND))
3139 free_percpu(wq->cpu_pwqs);
3140 else
3141 free_workqueue_attrs(wq->unbound_attrs);
3142
3143 kfree(wq->rescuer);
3144 kfree(wq);
3145}
3146
Tejun Heo29c91e92013-03-12 11:30:03 -07003147static void rcu_free_pool(struct rcu_head *rcu)
3148{
3149 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3150
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003151 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003152 free_workqueue_attrs(pool->attrs);
3153 kfree(pool);
3154}
3155
3156/**
3157 * put_unbound_pool - put a worker_pool
3158 * @pool: worker_pool to put
3159 *
3160 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003161 * safe manner. get_unbound_pool() calls this function on its failure path
3162 * and this function should be able to release pools which went through,
3163 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003164 *
3165 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003166 */
3167static void put_unbound_pool(struct worker_pool *pool)
3168{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003169 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003170 struct worker *worker;
3171
Tejun Heoa892cac2013-04-01 11:23:32 -07003172 lockdep_assert_held(&wq_pool_mutex);
3173
3174 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003175 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003176
3177 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003178 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003179 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003180 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003181
3182 /* release id and unhash */
3183 if (pool->id >= 0)
3184 idr_remove(&worker_pool_idr, pool->id);
3185 hash_del(&pool->hash_node);
3186
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003187 /*
3188 * Become the manager and destroy all workers. Grabbing
3189 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003190 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003191 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003192 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003193
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003194 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003195 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003196 destroy_worker(worker);
3197 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003198 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003199
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003200 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003201 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003202 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003203 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003204
3205 if (pool->detach_completion)
3206 wait_for_completion(pool->detach_completion);
3207
Tejun Heo29c91e92013-03-12 11:30:03 -07003208 mutex_unlock(&pool->manager_arb);
3209
3210 /* shut down the timers */
3211 del_timer_sync(&pool->idle_timer);
3212 del_timer_sync(&pool->mayday_timer);
3213
3214 /* sched-RCU protected to allow dereferences from get_work_pool() */
3215 call_rcu_sched(&pool->rcu, rcu_free_pool);
3216}
3217
3218/**
3219 * get_unbound_pool - get a worker_pool with the specified attributes
3220 * @attrs: the attributes of the worker_pool to get
3221 *
3222 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3223 * reference count and return it. If there already is a matching
3224 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003225 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003226 *
3227 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003228 *
3229 * Return: On success, a worker_pool with the same attributes as @attrs.
3230 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003231 */
3232static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3233{
Tejun Heo29c91e92013-03-12 11:30:03 -07003234 u32 hash = wqattrs_hash(attrs);
3235 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003236 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003237 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003238
Tejun Heoa892cac2013-04-01 11:23:32 -07003239 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003240
3241 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003242 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3243 if (wqattrs_equal(pool->attrs, attrs)) {
3244 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003245 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003246 }
3247 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003248
Xunlei Pange22735842015-10-09 11:53:12 +08003249 /* if cpumask is contained inside a NUMA node, we belong to that node */
3250 if (wq_numa_enabled) {
3251 for_each_node(node) {
3252 if (cpumask_subset(attrs->cpumask,
3253 wq_numa_possible_cpumask[node])) {
3254 target_node = node;
3255 break;
3256 }
3257 }
3258 }
3259
Tejun Heo29c91e92013-03-12 11:30:03 -07003260 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003261 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003262 if (!pool || init_worker_pool(pool) < 0)
3263 goto fail;
3264
Tejun Heo8864b4e2013-03-12 11:30:04 -07003265 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003266 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003267 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003268
Shaohua Li2865a8f2013-08-01 09:56:36 +08003269 /*
3270 * no_numa isn't a worker_pool attribute, always clear it. See
3271 * 'struct workqueue_attrs' comments for detail.
3272 */
3273 pool->attrs->no_numa = false;
3274
Tejun Heo29c91e92013-03-12 11:30:03 -07003275 if (worker_pool_assign_id(pool) < 0)
3276 goto fail;
3277
3278 /* create and start the initial worker */
Lai Jiangshan051e1852014-07-22 13:03:02 +08003279 if (!create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003280 goto fail;
3281
Tejun Heo29c91e92013-03-12 11:30:03 -07003282 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003283 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003284
Tejun Heo29c91e92013-03-12 11:30:03 -07003285 return pool;
3286fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003287 if (pool)
3288 put_unbound_pool(pool);
3289 return NULL;
3290}
3291
Tejun Heo8864b4e2013-03-12 11:30:04 -07003292static void rcu_free_pwq(struct rcu_head *rcu)
3293{
3294 kmem_cache_free(pwq_cache,
3295 container_of(rcu, struct pool_workqueue, rcu));
3296}
3297
3298/*
3299 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3300 * and needs to be destroyed.
3301 */
3302static void pwq_unbound_release_workfn(struct work_struct *work)
3303{
3304 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3305 unbound_release_work);
3306 struct workqueue_struct *wq = pwq->wq;
3307 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003308 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003309
3310 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3311 return;
3312
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003313 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003314 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003315 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003316 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003317
Tejun Heoa892cac2013-04-01 11:23:32 -07003318 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003319 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003320 mutex_unlock(&wq_pool_mutex);
3321
Tejun Heo8864b4e2013-03-12 11:30:04 -07003322 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3323
3324 /*
3325 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003326 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003327 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003328 if (is_last)
3329 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003330}
3331
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003332/**
Tejun Heo699ce092013-03-13 16:51:35 -07003333 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003334 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003335 *
Tejun Heo699ce092013-03-13 16:51:35 -07003336 * If @pwq isn't freezing, set @pwq->max_active to the associated
3337 * workqueue's saved_max_active and activate delayed work items
3338 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003339 */
Tejun Heo699ce092013-03-13 16:51:35 -07003340static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003341{
Tejun Heo699ce092013-03-13 16:51:35 -07003342 struct workqueue_struct *wq = pwq->wq;
3343 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003344
Tejun Heo699ce092013-03-13 16:51:35 -07003345 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003346 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003347
3348 /* fast exit for non-freezable wqs */
3349 if (!freezable && pwq->max_active == wq->saved_max_active)
3350 return;
3351
Lai Jiangshana357fc02013-03-25 16:57:19 -07003352 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003353
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003354 /*
3355 * During [un]freezing, the caller is responsible for ensuring that
3356 * this function is called at least once after @workqueue_freezing
3357 * is updated and visible.
3358 */
3359 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003360 pwq->max_active = wq->saved_max_active;
3361
3362 while (!list_empty(&pwq->delayed_works) &&
3363 pwq->nr_active < pwq->max_active)
3364 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003365
3366 /*
3367 * Need to kick a worker after thawed or an unbound wq's
3368 * max_active is bumped. It's a slow path. Do it always.
3369 */
3370 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003371 } else {
3372 pwq->max_active = 0;
3373 }
3374
Lai Jiangshana357fc02013-03-25 16:57:19 -07003375 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003376}
3377
Tejun Heoe50aba92013-04-01 11:23:35 -07003378/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003379static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3380 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003381{
3382 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3383
Tejun Heoe50aba92013-04-01 11:23:35 -07003384 memset(pwq, 0, sizeof(*pwq));
3385
Tejun Heod2c1d402013-03-12 11:30:04 -07003386 pwq->pool = pool;
3387 pwq->wq = wq;
3388 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003389 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003390 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003391 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003392 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003393 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003394}
Tejun Heod2c1d402013-03-12 11:30:04 -07003395
Tejun Heof147f292013-04-01 11:23:35 -07003396/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003397static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003398{
3399 struct workqueue_struct *wq = pwq->wq;
3400
3401 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003402
Tejun Heo1befcf32013-04-01 11:23:35 -07003403 /* may be called multiple times, ignore if already linked */
3404 if (!list_empty(&pwq->pwqs_node))
3405 return;
3406
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003407 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003408 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003409
3410 /* sync max_active to the current setting */
3411 pwq_adjust_max_active(pwq);
3412
3413 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003414 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003415}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003416
Tejun Heof147f292013-04-01 11:23:35 -07003417/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3418static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3419 const struct workqueue_attrs *attrs)
3420{
3421 struct worker_pool *pool;
3422 struct pool_workqueue *pwq;
3423
3424 lockdep_assert_held(&wq_pool_mutex);
3425
3426 pool = get_unbound_pool(attrs);
3427 if (!pool)
3428 return NULL;
3429
Tejun Heoe50aba92013-04-01 11:23:35 -07003430 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003431 if (!pwq) {
3432 put_unbound_pool(pool);
3433 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003434 }
Tejun Heo6029a912013-04-01 11:23:34 -07003435
Tejun Heof147f292013-04-01 11:23:35 -07003436 init_pwq(pwq, wq, pool);
3437 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003438}
3439
Tejun Heo4c16bd32013-04-01 11:23:36 -07003440/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003441 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003442 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003443 * @node: the target NUMA node
3444 * @cpu_going_down: if >= 0, the CPU to consider as offline
3445 * @cpumask: outarg, the resulting cpumask
3446 *
3447 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3448 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003449 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003450 *
3451 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3452 * enabled and @node has online CPUs requested by @attrs, the returned
3453 * cpumask is the intersection of the possible CPUs of @node and
3454 * @attrs->cpumask.
3455 *
3456 * The caller is responsible for ensuring that the cpumask of @node stays
3457 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003458 *
3459 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3460 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003461 */
3462static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3463 int cpu_going_down, cpumask_t *cpumask)
3464{
Tejun Heod55262c2013-04-01 11:23:38 -07003465 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003466 goto use_dfl;
3467
3468 /* does @node have any online CPUs @attrs wants? */
3469 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3470 if (cpu_going_down >= 0)
3471 cpumask_clear_cpu(cpu_going_down, cpumask);
3472
3473 if (cpumask_empty(cpumask))
3474 goto use_dfl;
3475
3476 /* yeap, return possible CPUs in @node that @attrs wants */
3477 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3478 return !cpumask_equal(cpumask, attrs->cpumask);
3479
3480use_dfl:
3481 cpumask_copy(cpumask, attrs->cpumask);
3482 return false;
3483}
3484
Tejun Heo1befcf32013-04-01 11:23:35 -07003485/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3486static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3487 int node,
3488 struct pool_workqueue *pwq)
3489{
3490 struct pool_workqueue *old_pwq;
3491
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003492 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003493 lockdep_assert_held(&wq->mutex);
3494
3495 /* link_pwq() can handle duplicate calls */
3496 link_pwq(pwq);
3497
3498 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3499 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3500 return old_pwq;
3501}
3502
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003503/* context to store the prepared attrs & pwqs before applying */
3504struct apply_wqattrs_ctx {
3505 struct workqueue_struct *wq; /* target workqueue */
3506 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003507 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003508 struct pool_workqueue *dfl_pwq;
3509 struct pool_workqueue *pwq_tbl[];
3510};
3511
3512/* free the resources after success or abort */
3513static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3514{
3515 if (ctx) {
3516 int node;
3517
3518 for_each_node(node)
3519 put_pwq_unlocked(ctx->pwq_tbl[node]);
3520 put_pwq_unlocked(ctx->dfl_pwq);
3521
3522 free_workqueue_attrs(ctx->attrs);
3523
3524 kfree(ctx);
3525 }
3526}
3527
3528/* allocate the attrs and pwqs for later installation */
3529static struct apply_wqattrs_ctx *
3530apply_wqattrs_prepare(struct workqueue_struct *wq,
3531 const struct workqueue_attrs *attrs)
3532{
3533 struct apply_wqattrs_ctx *ctx;
3534 struct workqueue_attrs *new_attrs, *tmp_attrs;
3535 int node;
3536
3537 lockdep_assert_held(&wq_pool_mutex);
3538
3539 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3540 GFP_KERNEL);
3541
3542 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3543 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3544 if (!ctx || !new_attrs || !tmp_attrs)
3545 goto out_free;
3546
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003547 /*
3548 * Calculate the attrs of the default pwq.
3549 * If the user configured cpumask doesn't overlap with the
3550 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3551 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003552 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003553 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003554 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3555 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003556
3557 /*
3558 * We may create multiple pwqs with differing cpumasks. Make a
3559 * copy of @new_attrs which will be modified and used to obtain
3560 * pools.
3561 */
3562 copy_workqueue_attrs(tmp_attrs, new_attrs);
3563
3564 /*
3565 * If something goes wrong during CPU up/down, we'll fall back to
3566 * the default pwq covering whole @attrs->cpumask. Always create
3567 * it even if we don't use it immediately.
3568 */
3569 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3570 if (!ctx->dfl_pwq)
3571 goto out_free;
3572
3573 for_each_node(node) {
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003574 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003575 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3576 if (!ctx->pwq_tbl[node])
3577 goto out_free;
3578 } else {
3579 ctx->dfl_pwq->refcnt++;
3580 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3581 }
3582 }
3583
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003584 /* save the user configured attrs and sanitize it. */
3585 copy_workqueue_attrs(new_attrs, attrs);
3586 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003587 ctx->attrs = new_attrs;
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003588
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003589 ctx->wq = wq;
3590 free_workqueue_attrs(tmp_attrs);
3591 return ctx;
3592
3593out_free:
3594 free_workqueue_attrs(tmp_attrs);
3595 free_workqueue_attrs(new_attrs);
3596 apply_wqattrs_cleanup(ctx);
3597 return NULL;
3598}
3599
3600/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3601static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3602{
3603 int node;
3604
3605 /* all pwqs have been created successfully, let's install'em */
3606 mutex_lock(&ctx->wq->mutex);
3607
3608 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3609
3610 /* save the previous pwq and install the new one */
3611 for_each_node(node)
3612 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3613 ctx->pwq_tbl[node]);
3614
3615 /* @dfl_pwq might not have been used, ensure it's linked */
3616 link_pwq(ctx->dfl_pwq);
3617 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3618
3619 mutex_unlock(&ctx->wq->mutex);
3620}
3621
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003622static void apply_wqattrs_lock(void)
3623{
3624 /* CPUs should stay stable across pwq creations and installations */
3625 get_online_cpus();
3626 mutex_lock(&wq_pool_mutex);
3627}
3628
3629static void apply_wqattrs_unlock(void)
3630{
3631 mutex_unlock(&wq_pool_mutex);
3632 put_online_cpus();
3633}
3634
3635static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3636 const struct workqueue_attrs *attrs)
3637{
3638 struct apply_wqattrs_ctx *ctx;
3639 int ret = -ENOMEM;
3640
3641 /* only unbound workqueues can change attributes */
3642 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3643 return -EINVAL;
3644
3645 /* creating multiple pwqs breaks ordering guarantee */
3646 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3647 return -EINVAL;
3648
3649 ctx = apply_wqattrs_prepare(wq, attrs);
3650
3651 /* the ctx has been prepared successfully, let's commit it */
3652 if (ctx) {
3653 apply_wqattrs_commit(ctx);
3654 ret = 0;
3655 }
3656
3657 apply_wqattrs_cleanup(ctx);
3658
3659 return ret;
3660}
3661
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003662/**
3663 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3664 * @wq: the target workqueue
3665 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3666 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003667 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3668 * machines, this function maps a separate pwq to each NUMA node with
3669 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3670 * NUMA node it was issued on. Older pwqs are released as in-flight work
3671 * items finish. Note that a work item which repeatedly requeues itself
3672 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003673 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003674 * Performs GFP_KERNEL allocations.
3675 *
3676 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003677 */
3678int apply_workqueue_attrs(struct workqueue_struct *wq,
3679 const struct workqueue_attrs *attrs)
3680{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003681 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003682
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003683 apply_wqattrs_lock();
3684 ret = apply_workqueue_attrs_locked(wq, attrs);
3685 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003686
Tejun Heo48621252013-04-01 11:23:31 -07003687 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003688}
3689
Tejun Heo4c16bd32013-04-01 11:23:36 -07003690/**
3691 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3692 * @wq: the target workqueue
3693 * @cpu: the CPU coming up or going down
3694 * @online: whether @cpu is coming up or going down
3695 *
3696 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3697 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3698 * @wq accordingly.
3699 *
3700 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3701 * falls back to @wq->dfl_pwq which may not be optimal but is always
3702 * correct.
3703 *
3704 * Note that when the last allowed CPU of a NUMA node goes offline for a
3705 * workqueue with a cpumask spanning multiple nodes, the workers which were
3706 * already executing the work items for the workqueue will lose their CPU
3707 * affinity and may execute on any CPU. This is similar to how per-cpu
3708 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3709 * affinity, it's the user's responsibility to flush the work item from
3710 * CPU_DOWN_PREPARE.
3711 */
3712static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3713 bool online)
3714{
3715 int node = cpu_to_node(cpu);
3716 int cpu_off = online ? -1 : cpu;
3717 struct pool_workqueue *old_pwq = NULL, *pwq;
3718 struct workqueue_attrs *target_attrs;
3719 cpumask_t *cpumask;
3720
3721 lockdep_assert_held(&wq_pool_mutex);
3722
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003723 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3724 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003725 return;
3726
3727 /*
3728 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3729 * Let's use a preallocated one. The following buf is protected by
3730 * CPU hotplug exclusion.
3731 */
3732 target_attrs = wq_update_unbound_numa_attrs_buf;
3733 cpumask = target_attrs->cpumask;
3734
Tejun Heo4c16bd32013-04-01 11:23:36 -07003735 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3736 pwq = unbound_pwq_by_node(wq, node);
3737
3738 /*
3739 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003740 * different from the default pwq's, we need to compare it to @pwq's
3741 * and create a new one if they don't match. If the target cpumask
3742 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003743 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003744 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003745 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003746 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003747 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003748 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003749 }
3750
Tejun Heo4c16bd32013-04-01 11:23:36 -07003751 /* create a new pwq */
3752 pwq = alloc_unbound_pwq(wq, target_attrs);
3753 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003754 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3755 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003756 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003757 }
3758
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003759 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003760 mutex_lock(&wq->mutex);
3761 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3762 goto out_unlock;
3763
3764use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003765 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003766 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3767 get_pwq(wq->dfl_pwq);
3768 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3769 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3770out_unlock:
3771 mutex_unlock(&wq->mutex);
3772 put_pwq_unlocked(old_pwq);
3773}
3774
Tejun Heo30cdf2492013-03-12 11:29:57 -07003775static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003776{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003777 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003778 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003779
Tejun Heo30cdf2492013-03-12 11:29:57 -07003780 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003781 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3782 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07003783 return -ENOMEM;
3784
3785 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003786 struct pool_workqueue *pwq =
3787 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003788 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003789 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003790
Tejun Heof147f292013-04-01 11:23:35 -07003791 init_pwq(pwq, wq, &cpu_pools[highpri]);
3792
3793 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003794 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003795 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003796 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003797 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003798 } else if (wq->flags & __WQ_ORDERED) {
3799 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3800 /* there should only be single pwq for ordering guarantee */
3801 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3802 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3803 "ordering guarantee broken for workqueue %s\n", wq->name);
3804 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07003805 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003806 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003807 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003808}
3809
Tejun Heof3421792010-07-02 10:03:51 +02003810static int wq_clamp_max_active(int max_active, unsigned int flags,
3811 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003812{
Tejun Heof3421792010-07-02 10:03:51 +02003813 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3814
3815 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003816 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3817 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003818
Tejun Heof3421792010-07-02 10:03:51 +02003819 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003820}
3821
Tejun Heob196be82012-01-10 15:11:35 -08003822struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003823 unsigned int flags,
3824 int max_active,
3825 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003826 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003827{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003828 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003829 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003830 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003831 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003832
Viresh Kumarcee22a12013-04-08 16:45:40 +05303833 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3834 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3835 flags |= WQ_UNBOUND;
3836
Tejun Heoecf68812013-04-01 11:23:34 -07003837 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003838 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003839 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003840
3841 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003842 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003843 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003844
Tejun Heo6029a912013-04-01 11:23:34 -07003845 if (flags & WQ_UNBOUND) {
3846 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3847 if (!wq->unbound_attrs)
3848 goto err_free_wq;
3849 }
3850
Tejun Heoecf68812013-04-01 11:23:34 -07003851 va_start(args, lock_name);
3852 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003853 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003854
Tejun Heod320c032010-06-29 10:07:14 +02003855 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003856 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003857
Tejun Heob196be82012-01-10 15:11:35 -08003858 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003859 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003860 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003861 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003862 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003863 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003864 INIT_LIST_HEAD(&wq->flusher_queue);
3865 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003866 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003867
Johannes Bergeb13ba82008-01-16 09:51:58 +01003868 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003869 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003870
Tejun Heo30cdf2492013-03-12 11:29:57 -07003871 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07003872 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003873
Tejun Heo493008a2013-03-12 11:30:03 -07003874 /*
3875 * Workqueues which may be used during memory reclaim should
3876 * have a rescuer to guarantee forward progress.
3877 */
3878 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003879 struct worker *rescuer;
3880
Lai Jiangshanf7537df2014-07-15 17:24:15 +08003881 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003882 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07003883 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02003884
Tejun Heo111c2252013-01-17 17:16:24 -08003885 rescuer->rescue_wq = wq;
3886 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003887 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07003888 if (IS_ERR(rescuer->task)) {
3889 kfree(rescuer);
3890 goto err_destroy;
3891 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003892
Tejun Heod2c1d402013-03-12 11:30:04 -07003893 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02003894 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003895 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003896 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003897
Tejun Heo226223a2013-03-12 11:30:05 -07003898 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3899 goto err_destroy;
3900
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003901 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003902 * wq_pool_mutex protects global freeze state and workqueues list.
3903 * Grab it, adjust max_active and add the new @wq to workqueues
3904 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003905 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003906 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003907
Lai Jiangshana357fc02013-03-25 16:57:19 -07003908 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003909 for_each_pwq(pwq, wq)
3910 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07003911 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003912
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003913 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003914
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003915 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02003916
Oleg Nesterov3af244332007-05-09 02:34:09 -07003917 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003918
3919err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07003920 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07003921 kfree(wq);
3922 return NULL;
3923err_destroy:
3924 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003925 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003926}
Tejun Heod320c032010-06-29 10:07:14 +02003927EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003928
3929/**
3930 * destroy_workqueue - safely terminate a workqueue
3931 * @wq: target workqueue
3932 *
3933 * Safely destroy a workqueue. All work currently pending will be done first.
3934 */
3935void destroy_workqueue(struct workqueue_struct *wq)
3936{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003937 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003938 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003939
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003940 /* drain it before proceeding with destruction */
3941 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003942
Tejun Heo6183c002013-03-12 11:29:57 -07003943 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003944 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07003945 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07003946 int i;
3947
Tejun Heo76af4d92013-03-12 11:30:00 -07003948 for (i = 0; i < WORK_NR_COLORS; i++) {
3949 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003950 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003951 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003952 }
3953 }
3954
Lai Jiangshan5c529592013-04-04 10:05:38 +08003955 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07003956 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07003957 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003958 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003959 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003960 }
Tejun Heo6183c002013-03-12 11:29:57 -07003961 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003962 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003963
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003964 /*
3965 * wq list is used to freeze wq, remove from list after
3966 * flushing is complete in case freeze races us.
3967 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003968 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003969 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003970 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003971
Tejun Heo226223a2013-03-12 11:30:05 -07003972 workqueue_sysfs_unregister(wq);
3973
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003974 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02003975 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02003976
Tejun Heo8864b4e2013-03-12 11:30:04 -07003977 if (!(wq->flags & WQ_UNBOUND)) {
3978 /*
3979 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003980 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003981 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003982 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003983 } else {
3984 /*
3985 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07003986 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
3987 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003988 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003989 for_each_node(node) {
3990 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3991 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
3992 put_pwq_unlocked(pwq);
3993 }
3994
3995 /*
3996 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
3997 * put. Don't access it afterwards.
3998 */
3999 pwq = wq->dfl_pwq;
4000 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004001 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004002 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004003}
4004EXPORT_SYMBOL_GPL(destroy_workqueue);
4005
Tejun Heodcd989c2010-06-29 10:07:14 +02004006/**
4007 * workqueue_set_max_active - adjust max_active of a workqueue
4008 * @wq: target workqueue
4009 * @max_active: new max_active value.
4010 *
4011 * Set max_active of @wq to @max_active.
4012 *
4013 * CONTEXT:
4014 * Don't call from IRQ context.
4015 */
4016void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4017{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004018 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004019
Tejun Heo8719dce2013-03-12 11:30:04 -07004020 /* disallow meddling with max_active for ordered workqueues */
4021 if (WARN_ON(wq->flags & __WQ_ORDERED))
4022 return;
4023
Tejun Heof3421792010-07-02 10:03:51 +02004024 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004025
Lai Jiangshana357fc02013-03-25 16:57:19 -07004026 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004027
4028 wq->saved_max_active = max_active;
4029
Tejun Heo699ce092013-03-13 16:51:35 -07004030 for_each_pwq(pwq, wq)
4031 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004032
Lai Jiangshana357fc02013-03-25 16:57:19 -07004033 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004034}
4035EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4036
4037/**
Tejun Heoe62676162013-03-12 17:41:37 -07004038 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4039 *
4040 * Determine whether %current is a workqueue rescuer. Can be used from
4041 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004042 *
4043 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004044 */
4045bool current_is_workqueue_rescuer(void)
4046{
4047 struct worker *worker = current_wq_worker();
4048
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004049 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004050}
4051
4052/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004053 * workqueue_congested - test whether a workqueue is congested
4054 * @cpu: CPU in question
4055 * @wq: target workqueue
4056 *
4057 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4058 * no synchronization around this function and the test result is
4059 * unreliable and only useful as advisory hints or for debugging.
4060 *
Tejun Heod3251852013-05-10 11:10:17 -07004061 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4062 * Note that both per-cpu and unbound workqueues may be associated with
4063 * multiple pool_workqueues which have separate congested states. A
4064 * workqueue being congested on one CPU doesn't mean the workqueue is also
4065 * contested on other CPUs / NUMA nodes.
4066 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004067 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004068 * %true if congested, %false otherwise.
4069 */
Tejun Heod84ff052013-03-12 11:29:59 -07004070bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004071{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004072 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004073 bool ret;
4074
Lai Jiangshan88109452013-03-20 03:28:10 +08004075 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004076
Tejun Heod3251852013-05-10 11:10:17 -07004077 if (cpu == WORK_CPU_UNBOUND)
4078 cpu = smp_processor_id();
4079
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004080 if (!(wq->flags & WQ_UNBOUND))
4081 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4082 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004083 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004084
Tejun Heo76af4d92013-03-12 11:30:00 -07004085 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004086 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004087
4088 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004089}
4090EXPORT_SYMBOL_GPL(workqueue_congested);
4091
4092/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004093 * work_busy - test whether a work is currently pending or running
4094 * @work: the work to be tested
4095 *
4096 * Test whether @work is currently pending or running. There is no
4097 * synchronization around this function and the test result is
4098 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004099 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004100 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004101 * OR'd bitmask of WORK_BUSY_* bits.
4102 */
4103unsigned int work_busy(struct work_struct *work)
4104{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004105 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004106 unsigned long flags;
4107 unsigned int ret = 0;
4108
Tejun Heodcd989c2010-06-29 10:07:14 +02004109 if (work_pending(work))
4110 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004111
Tejun Heofa1b54e2013-03-12 11:30:00 -07004112 local_irq_save(flags);
4113 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004114 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004115 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004116 if (find_worker_executing_work(pool, work))
4117 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004118 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004119 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004120 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004121
4122 return ret;
4123}
4124EXPORT_SYMBOL_GPL(work_busy);
4125
Tejun Heo3d1cb202013-04-30 15:27:22 -07004126/**
4127 * set_worker_desc - set description for the current work item
4128 * @fmt: printf-style format string
4129 * @...: arguments for the format string
4130 *
4131 * This function can be called by a running work function to describe what
4132 * the work item is about. If the worker task gets dumped, this
4133 * information will be printed out together to help debugging. The
4134 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4135 */
4136void set_worker_desc(const char *fmt, ...)
4137{
4138 struct worker *worker = current_wq_worker();
4139 va_list args;
4140
4141 if (worker) {
4142 va_start(args, fmt);
4143 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4144 va_end(args);
4145 worker->desc_valid = true;
4146 }
4147}
4148
4149/**
4150 * print_worker_info - print out worker information and description
4151 * @log_lvl: the log level to use when printing
4152 * @task: target task
4153 *
4154 * If @task is a worker and currently executing a work item, print out the
4155 * name of the workqueue being serviced and worker description set with
4156 * set_worker_desc() by the currently executing work item.
4157 *
4158 * This function can be safely called on any task as long as the
4159 * task_struct itself is accessible. While safe, this function isn't
4160 * synchronized and may print out mixups or garbages of limited length.
4161 */
4162void print_worker_info(const char *log_lvl, struct task_struct *task)
4163{
4164 work_func_t *fn = NULL;
4165 char name[WQ_NAME_LEN] = { };
4166 char desc[WORKER_DESC_LEN] = { };
4167 struct pool_workqueue *pwq = NULL;
4168 struct workqueue_struct *wq = NULL;
4169 bool desc_valid = false;
4170 struct worker *worker;
4171
4172 if (!(task->flags & PF_WQ_WORKER))
4173 return;
4174
4175 /*
4176 * This function is called without any synchronization and @task
4177 * could be in any state. Be careful with dereferences.
4178 */
4179 worker = probe_kthread_data(task);
4180
4181 /*
4182 * Carefully copy the associated workqueue's workfn and name. Keep
4183 * the original last '\0' in case the original contains garbage.
4184 */
4185 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4186 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4187 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4188 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4189
4190 /* copy worker description */
4191 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4192 if (desc_valid)
4193 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4194
4195 if (fn || name[0] || desc[0]) {
4196 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4197 if (desc[0])
4198 pr_cont(" (%s)", desc);
4199 pr_cont("\n");
4200 }
4201}
4202
Tejun Heo3494fc32015-03-09 09:22:28 -04004203static void pr_cont_pool_info(struct worker_pool *pool)
4204{
4205 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4206 if (pool->node != NUMA_NO_NODE)
4207 pr_cont(" node=%d", pool->node);
4208 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4209}
4210
4211static void pr_cont_work(bool comma, struct work_struct *work)
4212{
4213 if (work->func == wq_barrier_func) {
4214 struct wq_barrier *barr;
4215
4216 barr = container_of(work, struct wq_barrier, work);
4217
4218 pr_cont("%s BAR(%d)", comma ? "," : "",
4219 task_pid_nr(barr->task));
4220 } else {
4221 pr_cont("%s %pf", comma ? "," : "", work->func);
4222 }
4223}
4224
4225static void show_pwq(struct pool_workqueue *pwq)
4226{
4227 struct worker_pool *pool = pwq->pool;
4228 struct work_struct *work;
4229 struct worker *worker;
4230 bool has_in_flight = false, has_pending = false;
4231 int bkt;
4232
4233 pr_info(" pwq %d:", pool->id);
4234 pr_cont_pool_info(pool);
4235
4236 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4237 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4238
4239 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4240 if (worker->current_pwq == pwq) {
4241 has_in_flight = true;
4242 break;
4243 }
4244 }
4245 if (has_in_flight) {
4246 bool comma = false;
4247
4248 pr_info(" in-flight:");
4249 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4250 if (worker->current_pwq != pwq)
4251 continue;
4252
4253 pr_cont("%s %d%s:%pf", comma ? "," : "",
4254 task_pid_nr(worker->task),
4255 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4256 worker->current_func);
4257 list_for_each_entry(work, &worker->scheduled, entry)
4258 pr_cont_work(false, work);
4259 comma = true;
4260 }
4261 pr_cont("\n");
4262 }
4263
4264 list_for_each_entry(work, &pool->worklist, entry) {
4265 if (get_work_pwq(work) == pwq) {
4266 has_pending = true;
4267 break;
4268 }
4269 }
4270 if (has_pending) {
4271 bool comma = false;
4272
4273 pr_info(" pending:");
4274 list_for_each_entry(work, &pool->worklist, entry) {
4275 if (get_work_pwq(work) != pwq)
4276 continue;
4277
4278 pr_cont_work(comma, work);
4279 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4280 }
4281 pr_cont("\n");
4282 }
4283
4284 if (!list_empty(&pwq->delayed_works)) {
4285 bool comma = false;
4286
4287 pr_info(" delayed:");
4288 list_for_each_entry(work, &pwq->delayed_works, entry) {
4289 pr_cont_work(comma, work);
4290 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4291 }
4292 pr_cont("\n");
4293 }
4294}
4295
4296/**
4297 * show_workqueue_state - dump workqueue state
4298 *
4299 * Called from a sysrq handler and prints out all busy workqueues and
4300 * pools.
4301 */
4302void show_workqueue_state(void)
4303{
4304 struct workqueue_struct *wq;
4305 struct worker_pool *pool;
4306 unsigned long flags;
4307 int pi;
4308
4309 rcu_read_lock_sched();
4310
4311 pr_info("Showing busy workqueues and worker pools:\n");
4312
4313 list_for_each_entry_rcu(wq, &workqueues, list) {
4314 struct pool_workqueue *pwq;
4315 bool idle = true;
4316
4317 for_each_pwq(pwq, wq) {
4318 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4319 idle = false;
4320 break;
4321 }
4322 }
4323 if (idle)
4324 continue;
4325
4326 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4327
4328 for_each_pwq(pwq, wq) {
4329 spin_lock_irqsave(&pwq->pool->lock, flags);
4330 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4331 show_pwq(pwq);
4332 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4333 }
4334 }
4335
4336 for_each_pool(pool, pi) {
4337 struct worker *worker;
4338 bool first = true;
4339
4340 spin_lock_irqsave(&pool->lock, flags);
4341 if (pool->nr_workers == pool->nr_idle)
4342 goto next_pool;
4343
4344 pr_info("pool %d:", pool->id);
4345 pr_cont_pool_info(pool);
4346 pr_cont(" workers=%d", pool->nr_workers);
4347 if (pool->manager)
4348 pr_cont(" manager: %d",
4349 task_pid_nr(pool->manager->task));
4350 list_for_each_entry(worker, &pool->idle_list, entry) {
4351 pr_cont(" %s%d", first ? "idle: " : "",
4352 task_pid_nr(worker->task));
4353 first = false;
4354 }
4355 pr_cont("\n");
4356 next_pool:
4357 spin_unlock_irqrestore(&pool->lock, flags);
4358 }
4359
4360 rcu_read_unlock_sched();
4361}
4362
Tejun Heodb7bccf2010-06-29 10:07:12 +02004363/*
4364 * CPU hotplug.
4365 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004366 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004367 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004368 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004369 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004370 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004371 * blocked draining impractical.
4372 *
Tejun Heo24647572013-01-24 11:01:33 -08004373 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004374 * running as an unbound one and allowing it to be reattached later if the
4375 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004376 */
4377
Tejun Heo706026c2013-01-24 11:01:34 -08004378static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004379{
Tejun Heo38db41d2013-01-24 11:01:34 -08004380 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004381 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004382 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004383
Tejun Heof02ae732013-03-12 11:30:03 -07004384 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004385 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004386 spin_lock_irq(&pool->lock);
4387
4388 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004389 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004390 * unbound and set DISASSOCIATED. Before this, all workers
4391 * except for the ones which are still executing works from
4392 * before the last CPU down must be on the cpu. After
4393 * this, they may become diasporas.
4394 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004395 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004396 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004397
Tejun Heo24647572013-01-24 11:01:33 -08004398 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004399
Tejun Heo94cf58b2013-01-24 11:01:33 -08004400 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004401 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004402
Lai Jiangshaneb283422013-03-08 15:18:28 -08004403 /*
4404 * Call schedule() so that we cross rq->lock and thus can
4405 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4406 * This is necessary as scheduler callbacks may be invoked
4407 * from other cpus.
4408 */
4409 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004410
Lai Jiangshaneb283422013-03-08 15:18:28 -08004411 /*
4412 * Sched callbacks are disabled now. Zap nr_running.
4413 * After this, nr_running stays zero and need_more_worker()
4414 * and keep_working() are always true as long as the
4415 * worklist is not empty. This pool now behaves as an
4416 * unbound (in terms of concurrency management) pool which
4417 * are served by workers tied to the pool.
4418 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004419 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004420
4421 /*
4422 * With concurrency management just turned off, a busy
4423 * worker blocking could lead to lengthy stalls. Kick off
4424 * unbound chain execution of currently pending work items.
4425 */
4426 spin_lock_irq(&pool->lock);
4427 wake_up_worker(pool);
4428 spin_unlock_irq(&pool->lock);
4429 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004430}
4431
Tejun Heobd7c0892013-03-19 13:45:21 -07004432/**
4433 * rebind_workers - rebind all workers of a pool to the associated CPU
4434 * @pool: pool of interest
4435 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004436 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004437 */
4438static void rebind_workers(struct worker_pool *pool)
4439{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004440 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004441
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004442 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004443
Tejun Heoa9ab7752013-03-19 13:45:21 -07004444 /*
4445 * Restore CPU affinity of all workers. As all idle workers should
4446 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304447 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004448 * of all workers first and then clear UNBOUND. As we're called
4449 * from CPU_ONLINE, the following shouldn't fail.
4450 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004451 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004452 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4453 pool->attrs->cpumask) < 0);
4454
4455 spin_lock_irq(&pool->lock);
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004456 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004457
Lai Jiangshanda028462014-05-20 17:46:31 +08004458 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004459 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004460
4461 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004462 * A bound idle worker should actually be on the runqueue
4463 * of the associated CPU for local wake-ups targeting it to
4464 * work. Kick all idle workers so that they migrate to the
4465 * associated CPU. Doing this in the same loop as
4466 * replacing UNBOUND with REBOUND is safe as no worker will
4467 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004468 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004469 if (worker_flags & WORKER_IDLE)
4470 wake_up_process(worker->task);
4471
4472 /*
4473 * We want to clear UNBOUND but can't directly call
4474 * worker_clr_flags() or adjust nr_running. Atomically
4475 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4476 * @worker will clear REBOUND using worker_clr_flags() when
4477 * it initiates the next execution cycle thus restoring
4478 * concurrency management. Note that when or whether
4479 * @worker clears REBOUND doesn't affect correctness.
4480 *
4481 * ACCESS_ONCE() is necessary because @worker->flags may be
4482 * tested without holding any lock in
4483 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4484 * fail incorrectly leading to premature concurrency
4485 * management operations.
4486 */
4487 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4488 worker_flags |= WORKER_REBOUND;
4489 worker_flags &= ~WORKER_UNBOUND;
4490 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004491 }
4492
Tejun Heoa9ab7752013-03-19 13:45:21 -07004493 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004494}
4495
Tejun Heo7dbc7252013-03-19 13:45:21 -07004496/**
4497 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4498 * @pool: unbound pool of interest
4499 * @cpu: the CPU which is coming up
4500 *
4501 * An unbound pool may end up with a cpumask which doesn't have any online
4502 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4503 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4504 * online CPU before, cpus_allowed of all its workers should be restored.
4505 */
4506static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4507{
4508 static cpumask_t cpumask;
4509 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004510
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004511 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004512
4513 /* is @cpu allowed for @pool? */
4514 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4515 return;
4516
4517 /* is @cpu the only online CPU? */
4518 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4519 if (cpumask_weight(&cpumask) != 1)
4520 return;
4521
4522 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004523 for_each_pool_worker(worker, pool)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004524 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4525 pool->attrs->cpumask) < 0);
4526}
4527
Tejun Heo8db25e72012-07-17 12:39:28 -07004528/*
4529 * Workqueues should be brought up before normal priority CPU notifiers.
4530 * This will be registered high priority CPU notifier.
4531 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004532static int workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004533 unsigned long action,
4534 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004535{
Tejun Heod84ff052013-03-12 11:29:59 -07004536 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004537 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004538 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004539 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004540
Tejun Heo8db25e72012-07-17 12:39:28 -07004541 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004542 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004543 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004544 if (pool->nr_workers)
4545 continue;
Lai Jiangshan051e1852014-07-22 13:03:02 +08004546 if (!create_worker(pool))
Tejun Heo3ce63372012-07-17 12:39:27 -07004547 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004548 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004549 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004550
Tejun Heo65758202012-07-17 12:39:26 -07004551 case CPU_DOWN_FAILED:
4552 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004553 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004554
4555 for_each_pool(pool, pi) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004556 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004557
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004558 if (pool->cpu == cpu)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004559 rebind_workers(pool);
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004560 else if (pool->cpu < 0)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004561 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004562
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004563 mutex_unlock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004564 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004565
Tejun Heo4c16bd32013-04-01 11:23:36 -07004566 /* update NUMA affinity of unbound workqueues */
4567 list_for_each_entry(wq, &workqueues, list)
4568 wq_update_unbound_numa(wq, cpu, true);
4569
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004570 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004571 break;
Tejun Heo65758202012-07-17 12:39:26 -07004572 }
4573 return NOTIFY_OK;
4574}
4575
4576/*
4577 * Workqueues should be brought down after normal priority CPU notifiers.
4578 * This will be registered as low priority CPU notifier.
4579 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004580static int workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004581 unsigned long action,
4582 void *hcpu)
4583{
Tejun Heod84ff052013-03-12 11:29:59 -07004584 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004585 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004586 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004587
Tejun Heo65758202012-07-17 12:39:26 -07004588 switch (action & ~CPU_TASKS_FROZEN) {
4589 case CPU_DOWN_PREPARE:
Tejun Heo4c16bd32013-04-01 11:23:36 -07004590 /* unbinding per-cpu workers should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004591 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004592 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004593
4594 /* update NUMA affinity of unbound workqueues */
4595 mutex_lock(&wq_pool_mutex);
4596 list_for_each_entry(wq, &workqueues, list)
4597 wq_update_unbound_numa(wq, cpu, false);
4598 mutex_unlock(&wq_pool_mutex);
4599
4600 /* wait for per-cpu unbinding to finish */
Tejun Heo8db25e72012-07-17 12:39:28 -07004601 flush_work(&unbind_work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004602 destroy_work_on_stack(&unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004603 break;
Tejun Heo65758202012-07-17 12:39:26 -07004604 }
4605 return NOTIFY_OK;
4606}
4607
Rusty Russell2d3854a2008-11-05 13:39:10 +11004608#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004609
Rusty Russell2d3854a2008-11-05 13:39:10 +11004610struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004611 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004612 long (*fn)(void *);
4613 void *arg;
4614 long ret;
4615};
4616
Tejun Heoed48ece2012-09-18 12:48:43 -07004617static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004618{
Tejun Heoed48ece2012-09-18 12:48:43 -07004619 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4620
Rusty Russell2d3854a2008-11-05 13:39:10 +11004621 wfc->ret = wfc->fn(wfc->arg);
4622}
4623
4624/**
4625 * work_on_cpu - run a function in user context on a particular cpu
4626 * @cpu: the cpu to run on
4627 * @fn: the function to run
4628 * @arg: the function arg
4629 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004630 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004631 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004632 *
4633 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004634 */
Tejun Heod84ff052013-03-12 11:29:59 -07004635long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004636{
Tejun Heoed48ece2012-09-18 12:48:43 -07004637 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004638
Tejun Heoed48ece2012-09-18 12:48:43 -07004639 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4640 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004641 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004642 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004643 return wfc.ret;
4644}
4645EXPORT_SYMBOL_GPL(work_on_cpu);
4646#endif /* CONFIG_SMP */
4647
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004648#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304649
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004650/**
4651 * freeze_workqueues_begin - begin freezing workqueues
4652 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004653 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004654 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004655 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004656 *
4657 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004658 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004659 */
4660void freeze_workqueues_begin(void)
4661{
Tejun Heo24b8a842013-03-12 11:29:58 -07004662 struct workqueue_struct *wq;
4663 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004664
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004665 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004666
Tejun Heo6183c002013-03-12 11:29:57 -07004667 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004668 workqueue_freezing = true;
4669
Tejun Heo24b8a842013-03-12 11:29:58 -07004670 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004671 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004672 for_each_pwq(pwq, wq)
4673 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004674 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004675 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004676
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004677 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004678}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004679
4680/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004681 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004682 *
4683 * Check whether freezing is complete. This function must be called
4684 * between freeze_workqueues_begin() and thaw_workqueues().
4685 *
4686 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004687 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004688 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004689 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004690 * %true if some freezable workqueues are still busy. %false if freezing
4691 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004692 */
4693bool freeze_workqueues_busy(void)
4694{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004695 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004696 struct workqueue_struct *wq;
4697 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004698
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004699 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004700
Tejun Heo6183c002013-03-12 11:29:57 -07004701 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004702
Tejun Heo24b8a842013-03-12 11:29:58 -07004703 list_for_each_entry(wq, &workqueues, list) {
4704 if (!(wq->flags & WQ_FREEZABLE))
4705 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004706 /*
4707 * nr_active is monotonically decreasing. It's safe
4708 * to peek without lock.
4709 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004710 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004711 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004712 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004713 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004714 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004715 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004716 goto out_unlock;
4717 }
4718 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004719 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004720 }
4721out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004722 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004723 return busy;
4724}
4725
4726/**
4727 * thaw_workqueues - thaw workqueues
4728 *
4729 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004730 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004731 *
4732 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004733 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004734 */
4735void thaw_workqueues(void)
4736{
Tejun Heo24b8a842013-03-12 11:29:58 -07004737 struct workqueue_struct *wq;
4738 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004739
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004740 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004741
4742 if (!workqueue_freezing)
4743 goto out_unlock;
4744
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004745 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004746
Tejun Heo24b8a842013-03-12 11:29:58 -07004747 /* restore max_active and repopulate worklist */
4748 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004749 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004750 for_each_pwq(pwq, wq)
4751 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004752 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004753 }
4754
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004755out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004756 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004757}
4758#endif /* CONFIG_FREEZER */
4759
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004760static int workqueue_apply_unbound_cpumask(void)
4761{
4762 LIST_HEAD(ctxs);
4763 int ret = 0;
4764 struct workqueue_struct *wq;
4765 struct apply_wqattrs_ctx *ctx, *n;
4766
4767 lockdep_assert_held(&wq_pool_mutex);
4768
4769 list_for_each_entry(wq, &workqueues, list) {
4770 if (!(wq->flags & WQ_UNBOUND))
4771 continue;
4772 /* creating multiple pwqs breaks ordering guarantee */
4773 if (wq->flags & __WQ_ORDERED)
4774 continue;
4775
4776 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4777 if (!ctx) {
4778 ret = -ENOMEM;
4779 break;
4780 }
4781
4782 list_add_tail(&ctx->list, &ctxs);
4783 }
4784
4785 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4786 if (!ret)
4787 apply_wqattrs_commit(ctx);
4788 apply_wqattrs_cleanup(ctx);
4789 }
4790
4791 return ret;
4792}
4793
4794/**
4795 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4796 * @cpumask: the cpumask to set
4797 *
4798 * The low-level workqueues cpumask is a global cpumask that limits
4799 * the affinity of all unbound workqueues. This function check the @cpumask
4800 * and apply it to all unbound workqueues and updates all pwqs of them.
4801 *
4802 * Retun: 0 - Success
4803 * -EINVAL - Invalid @cpumask
4804 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4805 */
4806int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4807{
4808 int ret = -EINVAL;
4809 cpumask_var_t saved_cpumask;
4810
4811 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4812 return -ENOMEM;
4813
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004814 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4815 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004816 apply_wqattrs_lock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004817
4818 /* save the old wq_unbound_cpumask. */
4819 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4820
4821 /* update wq_unbound_cpumask at first and apply it to wqs. */
4822 cpumask_copy(wq_unbound_cpumask, cpumask);
4823 ret = workqueue_apply_unbound_cpumask();
4824
4825 /* restore the wq_unbound_cpumask when failed. */
4826 if (ret < 0)
4827 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4828
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004829 apply_wqattrs_unlock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004830 }
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004831
4832 free_cpumask_var(saved_cpumask);
4833 return ret;
4834}
4835
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004836#ifdef CONFIG_SYSFS
4837/*
4838 * Workqueues with WQ_SYSFS flag set is visible to userland via
4839 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4840 * following attributes.
4841 *
4842 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4843 * max_active RW int : maximum number of in-flight work items
4844 *
4845 * Unbound workqueues have the following extra attributes.
4846 *
4847 * id RO int : the associated pool ID
4848 * nice RW int : nice value of the workers
4849 * cpumask RW mask : bitmask of allowed CPUs for the workers
4850 */
4851struct wq_device {
4852 struct workqueue_struct *wq;
4853 struct device dev;
4854};
4855
4856static struct workqueue_struct *dev_to_wq(struct device *dev)
4857{
4858 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
4859
4860 return wq_dev->wq;
4861}
4862
4863static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
4864 char *buf)
4865{
4866 struct workqueue_struct *wq = dev_to_wq(dev);
4867
4868 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
4869}
4870static DEVICE_ATTR_RO(per_cpu);
4871
4872static ssize_t max_active_show(struct device *dev,
4873 struct device_attribute *attr, char *buf)
4874{
4875 struct workqueue_struct *wq = dev_to_wq(dev);
4876
4877 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
4878}
4879
4880static ssize_t max_active_store(struct device *dev,
4881 struct device_attribute *attr, const char *buf,
4882 size_t count)
4883{
4884 struct workqueue_struct *wq = dev_to_wq(dev);
4885 int val;
4886
4887 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
4888 return -EINVAL;
4889
4890 workqueue_set_max_active(wq, val);
4891 return count;
4892}
4893static DEVICE_ATTR_RW(max_active);
4894
4895static struct attribute *wq_sysfs_attrs[] = {
4896 &dev_attr_per_cpu.attr,
4897 &dev_attr_max_active.attr,
4898 NULL,
4899};
4900ATTRIBUTE_GROUPS(wq_sysfs);
4901
4902static ssize_t wq_pool_ids_show(struct device *dev,
4903 struct device_attribute *attr, char *buf)
4904{
4905 struct workqueue_struct *wq = dev_to_wq(dev);
4906 const char *delim = "";
4907 int node, written = 0;
4908
4909 rcu_read_lock_sched();
4910 for_each_node(node) {
4911 written += scnprintf(buf + written, PAGE_SIZE - written,
4912 "%s%d:%d", delim, node,
4913 unbound_pwq_by_node(wq, node)->pool->id);
4914 delim = " ";
4915 }
4916 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
4917 rcu_read_unlock_sched();
4918
4919 return written;
4920}
4921
4922static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
4923 char *buf)
4924{
4925 struct workqueue_struct *wq = dev_to_wq(dev);
4926 int written;
4927
4928 mutex_lock(&wq->mutex);
4929 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
4930 mutex_unlock(&wq->mutex);
4931
4932 return written;
4933}
4934
4935/* prepare workqueue_attrs for sysfs store operations */
4936static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
4937{
4938 struct workqueue_attrs *attrs;
4939
Lai Jiangshan899a94f2015-05-20 14:41:18 +08004940 lockdep_assert_held(&wq_pool_mutex);
4941
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004942 attrs = alloc_workqueue_attrs(GFP_KERNEL);
4943 if (!attrs)
4944 return NULL;
4945
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004946 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004947 return attrs;
4948}
4949
4950static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
4951 const char *buf, size_t count)
4952{
4953 struct workqueue_struct *wq = dev_to_wq(dev);
4954 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004955 int ret = -ENOMEM;
4956
4957 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004958
4959 attrs = wq_sysfs_prep_attrs(wq);
4960 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004961 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004962
4963 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
4964 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004965 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004966 else
4967 ret = -EINVAL;
4968
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004969out_unlock:
4970 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004971 free_workqueue_attrs(attrs);
4972 return ret ?: count;
4973}
4974
4975static ssize_t wq_cpumask_show(struct device *dev,
4976 struct device_attribute *attr, char *buf)
4977{
4978 struct workqueue_struct *wq = dev_to_wq(dev);
4979 int written;
4980
4981 mutex_lock(&wq->mutex);
4982 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
4983 cpumask_pr_args(wq->unbound_attrs->cpumask));
4984 mutex_unlock(&wq->mutex);
4985 return written;
4986}
4987
4988static ssize_t wq_cpumask_store(struct device *dev,
4989 struct device_attribute *attr,
4990 const char *buf, size_t count)
4991{
4992 struct workqueue_struct *wq = dev_to_wq(dev);
4993 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004994 int ret = -ENOMEM;
4995
4996 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004997
4998 attrs = wq_sysfs_prep_attrs(wq);
4999 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005000 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005001
5002 ret = cpumask_parse(buf, attrs->cpumask);
5003 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005004 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005005
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005006out_unlock:
5007 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005008 free_workqueue_attrs(attrs);
5009 return ret ?: count;
5010}
5011
5012static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5013 char *buf)
5014{
5015 struct workqueue_struct *wq = dev_to_wq(dev);
5016 int written;
5017
5018 mutex_lock(&wq->mutex);
5019 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5020 !wq->unbound_attrs->no_numa);
5021 mutex_unlock(&wq->mutex);
5022
5023 return written;
5024}
5025
5026static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5027 const char *buf, size_t count)
5028{
5029 struct workqueue_struct *wq = dev_to_wq(dev);
5030 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005031 int v, ret = -ENOMEM;
5032
5033 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005034
5035 attrs = wq_sysfs_prep_attrs(wq);
5036 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005037 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005038
5039 ret = -EINVAL;
5040 if (sscanf(buf, "%d", &v) == 1) {
5041 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005042 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005043 }
5044
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005045out_unlock:
5046 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005047 free_workqueue_attrs(attrs);
5048 return ret ?: count;
5049}
5050
5051static struct device_attribute wq_sysfs_unbound_attrs[] = {
5052 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5053 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5054 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5055 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5056 __ATTR_NULL,
5057};
5058
5059static struct bus_type wq_subsys = {
5060 .name = "workqueue",
5061 .dev_groups = wq_sysfs_groups,
5062};
5063
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005064static ssize_t wq_unbound_cpumask_show(struct device *dev,
5065 struct device_attribute *attr, char *buf)
5066{
5067 int written;
5068
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005069 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005070 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5071 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005072 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005073
5074 return written;
5075}
5076
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005077static ssize_t wq_unbound_cpumask_store(struct device *dev,
5078 struct device_attribute *attr, const char *buf, size_t count)
5079{
5080 cpumask_var_t cpumask;
5081 int ret;
5082
5083 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5084 return -ENOMEM;
5085
5086 ret = cpumask_parse(buf, cpumask);
5087 if (!ret)
5088 ret = workqueue_set_unbound_cpumask(cpumask);
5089
5090 free_cpumask_var(cpumask);
5091 return ret ? ret : count;
5092}
5093
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005094static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005095 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5096 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005097
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005098static int __init wq_sysfs_init(void)
5099{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005100 int err;
5101
5102 err = subsys_virtual_register(&wq_subsys, NULL);
5103 if (err)
5104 return err;
5105
5106 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005107}
5108core_initcall(wq_sysfs_init);
5109
5110static void wq_device_release(struct device *dev)
5111{
5112 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5113
5114 kfree(wq_dev);
5115}
5116
5117/**
5118 * workqueue_sysfs_register - make a workqueue visible in sysfs
5119 * @wq: the workqueue to register
5120 *
5121 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5122 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5123 * which is the preferred method.
5124 *
5125 * Workqueue user should use this function directly iff it wants to apply
5126 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5127 * apply_workqueue_attrs() may race against userland updating the
5128 * attributes.
5129 *
5130 * Return: 0 on success, -errno on failure.
5131 */
5132int workqueue_sysfs_register(struct workqueue_struct *wq)
5133{
5134 struct wq_device *wq_dev;
5135 int ret;
5136
5137 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305138 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005139 * attributes breaks ordering guarantee. Disallow exposing ordered
5140 * workqueues.
5141 */
5142 if (WARN_ON(wq->flags & __WQ_ORDERED))
5143 return -EINVAL;
5144
5145 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5146 if (!wq_dev)
5147 return -ENOMEM;
5148
5149 wq_dev->wq = wq;
5150 wq_dev->dev.bus = &wq_subsys;
5151 wq_dev->dev.init_name = wq->name;
5152 wq_dev->dev.release = wq_device_release;
5153
5154 /*
5155 * unbound_attrs are created separately. Suppress uevent until
5156 * everything is ready.
5157 */
5158 dev_set_uevent_suppress(&wq_dev->dev, true);
5159
5160 ret = device_register(&wq_dev->dev);
5161 if (ret) {
5162 kfree(wq_dev);
5163 wq->wq_dev = NULL;
5164 return ret;
5165 }
5166
5167 if (wq->flags & WQ_UNBOUND) {
5168 struct device_attribute *attr;
5169
5170 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5171 ret = device_create_file(&wq_dev->dev, attr);
5172 if (ret) {
5173 device_unregister(&wq_dev->dev);
5174 wq->wq_dev = NULL;
5175 return ret;
5176 }
5177 }
5178 }
5179
5180 dev_set_uevent_suppress(&wq_dev->dev, false);
5181 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5182 return 0;
5183}
5184
5185/**
5186 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5187 * @wq: the workqueue to unregister
5188 *
5189 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5190 */
5191static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5192{
5193 struct wq_device *wq_dev = wq->wq_dev;
5194
5195 if (!wq->wq_dev)
5196 return;
5197
5198 wq->wq_dev = NULL;
5199 device_unregister(&wq_dev->dev);
5200}
5201#else /* CONFIG_SYSFS */
5202static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5203#endif /* CONFIG_SYSFS */
5204
Tejun Heobce90382013-04-01 11:23:32 -07005205static void __init wq_numa_init(void)
5206{
5207 cpumask_var_t *tbl;
5208 int node, cpu;
5209
Tejun Heobce90382013-04-01 11:23:32 -07005210 if (num_possible_nodes() <= 1)
5211 return;
5212
Tejun Heod55262c2013-04-01 11:23:38 -07005213 if (wq_disable_numa) {
5214 pr_info("workqueue: NUMA affinity support disabled\n");
5215 return;
5216 }
5217
Tejun Heo4c16bd32013-04-01 11:23:36 -07005218 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5219 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5220
Tejun Heobce90382013-04-01 11:23:32 -07005221 /*
5222 * We want masks of possible CPUs of each node which isn't readily
5223 * available. Build one from cpu_to_node() which should have been
5224 * fully initialized by now.
5225 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005226 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005227 BUG_ON(!tbl);
5228
5229 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005230 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005231 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005232
5233 for_each_possible_cpu(cpu) {
5234 node = cpu_to_node(cpu);
5235 if (WARN_ON(node == NUMA_NO_NODE)) {
5236 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5237 /* happens iff arch is bonkers, let's just proceed */
5238 return;
5239 }
5240 cpumask_set_cpu(cpu, tbl[node]);
5241 }
5242
5243 wq_numa_possible_cpumask = tbl;
5244 wq_numa_enabled = true;
5245}
5246
Suresh Siddha6ee05782010-07-30 14:57:37 -07005247static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005248{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005249 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5250 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005251
Tejun Heoe904e6c2013-03-12 11:29:57 -07005252 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5253
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005254 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5255 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5256
Tejun Heoe904e6c2013-03-12 11:29:57 -07005257 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5258
Tejun Heo65758202012-07-17 12:39:26 -07005259 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07005260 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02005261
Tejun Heobce90382013-04-01 11:23:32 -07005262 wq_numa_init();
5263
Tejun Heo706026c2013-01-24 11:01:34 -08005264 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005265 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005266 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005267
Tejun Heo7a4e3442013-03-12 11:30:00 -07005268 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005269 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005270 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005271 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005272 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005273 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005274 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005275
Tejun Heo9daf9e62013-01-24 11:01:33 -08005276 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005277 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005278 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005279 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005280 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005281 }
5282
Tejun Heoe22bee72010-06-29 10:07:14 +02005283 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07005284 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005285 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02005286
Tejun Heof02ae732013-03-12 11:30:03 -07005287 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07005288 pool->flags &= ~POOL_DISASSOCIATED;
Lai Jiangshan051e1852014-07-22 13:03:02 +08005289 BUG_ON(!create_worker(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07005290 }
Tejun Heoe22bee72010-06-29 10:07:14 +02005291 }
5292
Tejun Heo8a2b7532013-09-05 12:30:04 -04005293 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005294 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5295 struct workqueue_attrs *attrs;
5296
5297 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005298 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005299 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005300
5301 /*
5302 * An ordered wq should have only one pwq as ordering is
5303 * guaranteed by max_active which is enforced by pwqs.
5304 * Turn off NUMA so that dfl_pwq is used for all nodes.
5305 */
5306 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5307 attrs->nice = std_nice[i];
5308 attrs->no_numa = true;
5309 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005310 }
5311
Tejun Heod320c032010-06-29 10:07:14 +02005312 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005313 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005314 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005315 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5316 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005317 system_freezable_wq = alloc_workqueue("events_freezable",
5318 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305319 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5320 WQ_POWER_EFFICIENT, 0);
5321 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5322 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5323 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005324 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305325 !system_unbound_wq || !system_freezable_wq ||
5326 !system_power_efficient_wq ||
5327 !system_freezable_power_efficient_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07005328 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005329}
Suresh Siddha6ee05782010-07-30 14:57:37 -07005330early_initcall(init_workqueues);