blob: 450c21fd0e6e4289bcf1d2d3b6ba78d68d992df5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080019 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020023 *
24 * Please read Documentation/workqueue.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
Paul Gortmaker9984de12011-05-23 14:51:41 -040027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060038#include <linux/hardirq.h>
Christoph Lameter46934022006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/kallsyms.h>
42#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020051
Tejun Heoea138442013-01-18 14:05:55 -080052#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Tejun Heoc8e55f32010-06-29 10:07:12 +020054enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070055 /*
Tejun Heo24647572013-01-24 11:01:33 -080056 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 *
Tejun Heo24647572013-01-24 11:01:33 -080058 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 * While associated (!DISASSOCIATED), all workers are bound to the
60 * CPU and none has %WORKER_UNBOUND set and concurrency management
61 * is in effect.
62 *
63 * While DISASSOCIATED, the cpu may be offline and all workers have
64 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080065 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070066 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070067 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080068 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080069 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070070 */
Tejun Heo24647572013-01-24 11:01:33 -080071 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020072
Tejun Heoc8e55f32010-06-29 10:07:12 +020073 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020074 WORKER_DIE = 1 << 1, /* die die die */
75 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020076 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020077 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020078 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070079 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020080
Tejun Heoa9ab7752013-03-19 13:45:21 -070081 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
82 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020083
Tejun Heoe34cdddb2013-01-24 11:01:33 -080084 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070085
Tejun Heo29c91e92013-03-12 11:30:03 -070086 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020087 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020088
Tejun Heoe22bee72010-06-29 10:07:14 +020089 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
90 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
91
Tejun Heo3233cdb2011-02-16 18:10:19 +010092 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
93 /* call for help after 10ms
94 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020095 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
96 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020097
98 /*
99 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800100 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200101 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800102 RESCUER_NICE_LEVEL = MIN_NICE,
103 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700104
105 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200106};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200109 * Structure fields follow one of the following exclusion rules.
110 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200111 * I: Modifiable by initialization/destruction paths and read-only for
112 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200113 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200114 * P: Preemption protected. Disabling preemption is enough and should
115 * only be modified and accessed from the local cpu.
116 *
Tejun Heod565ed62013-01-24 11:01:33 -0800117 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200118 *
Tejun Heod565ed62013-01-24 11:01:33 -0800119 * X: During normal operation, modification requires pool->lock and should
120 * be done only from local cpu. Either disabling preemption on local
121 * cpu or grabbing pool->lock is enough for read access. If
122 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200123 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800124 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700125 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700126 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700127 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700128 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700129 *
Lai 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 Jiangshan042f7df2015-04-30 17:16:12 +0800302static cpumask_var_t wq_unbound_cpumask; /* PL: low level cpumask for all unbound wqs */
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800303
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700304/* the per-cpu worker pools */
305static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
306 cpu_worker_pools);
307
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700308static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700309
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700310/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700311static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
312
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700313/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700314static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
315
Tejun Heo8a2b7532013-09-05 12:30:04 -0400316/* I: attributes used when instantiating ordered pools on demand */
317static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
318
Tejun Heod320c032010-06-29 10:07:14 +0200319struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400320EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300321struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900322EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300323struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200324EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300325struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200326EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300327struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100328EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530329struct workqueue_struct *system_power_efficient_wq __read_mostly;
330EXPORT_SYMBOL_GPL(system_power_efficient_wq);
331struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
332EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200333
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700334static int worker_thread(void *__worker);
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 Heo794b18b2013-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 Heo21b34b42016-02-03 13:54:25 -0500571
572 /*
573 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
574 * delayed item is pending. The plan is to keep CPU -> NODE
575 * mapping valid and stable across CPU on/offlines. Once that
576 * happens, this workaround can be removed.
577 */
578 if (unlikely(node == NUMA_NO_NODE))
579 return wq->dfl_pwq;
580
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700581 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
582}
583
Tejun Heo73f53c42010-06-29 10:07:11 +0200584static unsigned int work_color_to_flags(int color)
585{
586 return color << WORK_STRUCT_COLOR_SHIFT;
587}
588
589static int get_work_color(struct work_struct *work)
590{
591 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
592 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
593}
594
595static int work_next_color(int color)
596{
597 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700598}
599
David Howells4594bf12006-12-07 11:33:26 +0000600/*
Tejun Heo112202d2013-02-13 19:29:12 -0800601 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
602 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800603 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200604 *
Tejun Heo112202d2013-02-13 19:29:12 -0800605 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
606 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700607 * work->data. These functions should only be called while the work is
608 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200609 *
Tejun Heo112202d2013-02-13 19:29:12 -0800610 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800611 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800612 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800613 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700614 *
615 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
616 * canceled. While being canceled, a work item may have its PENDING set
617 * but stay off timer and worklist for arbitrarily long and nobody should
618 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000619 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200620static inline void set_work_data(struct work_struct *work, unsigned long data,
621 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000622{
Tejun Heo6183c002013-03-12 11:29:57 -0700623 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200624 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000625}
David Howells365970a2006-11-22 14:54:49 +0000626
Tejun Heo112202d2013-02-13 19:29:12 -0800627static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200628 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200629{
Tejun Heo112202d2013-02-13 19:29:12 -0800630 set_work_data(work, (unsigned long)pwq,
631 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200632}
633
Lai Jiangshan4468a002013-02-06 18:04:53 -0800634static void set_work_pool_and_keep_pending(struct work_struct *work,
635 int pool_id)
636{
637 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
638 WORK_STRUCT_PENDING);
639}
640
Tejun Heo7c3eed52013-01-24 11:01:33 -0800641static void set_work_pool_and_clear_pending(struct work_struct *work,
642 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000643{
Tejun Heo23657bb2012-08-13 17:08:19 -0700644 /*
645 * The following wmb is paired with the implied mb in
646 * test_and_set_bit(PENDING) and ensures all updates to @work made
647 * here are visible to and precede any updates by the next PENDING
648 * owner.
649 */
650 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800651 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200652}
653
654static void clear_work_data(struct work_struct *work)
655{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800656 smp_wmb(); /* see set_work_pool_and_clear_pending() */
657 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200658}
659
Tejun Heo112202d2013-02-13 19:29:12 -0800660static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200661{
Tejun Heoe1201532010-07-22 14:14:25 +0200662 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200663
Tejun Heo112202d2013-02-13 19:29:12 -0800664 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200665 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
666 else
667 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200668}
669
Tejun Heo7c3eed52013-01-24 11:01:33 -0800670/**
671 * get_work_pool - return the worker_pool a given work was associated with
672 * @work: the work item of interest
673 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700674 * Pools are created and destroyed under wq_pool_mutex, and allows read
675 * access under sched-RCU read lock. As such, this function should be
676 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700677 *
678 * All fields of the returned pool are accessible as long as the above
679 * mentioned locking is in effect. If the returned pool needs to be used
680 * beyond the critical section, the caller is responsible for ensuring the
681 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700682 *
683 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800684 */
685static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200686{
Tejun Heoe1201532010-07-22 14:14:25 +0200687 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800688 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200689
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700690 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700691
Tejun Heo112202d2013-02-13 19:29:12 -0800692 if (data & WORK_STRUCT_PWQ)
693 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800694 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200695
Tejun Heo7c3eed52013-01-24 11:01:33 -0800696 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
697 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200698 return NULL;
699
Tejun Heofa1b54e2013-03-12 11:30:00 -0700700 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800701}
702
703/**
704 * get_work_pool_id - return the worker pool ID a given work is associated with
705 * @work: the work item of interest
706 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700707 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800708 * %WORK_OFFQ_POOL_NONE if none.
709 */
710static int get_work_pool_id(struct work_struct *work)
711{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800712 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800713
Tejun Heo112202d2013-02-13 19:29:12 -0800714 if (data & WORK_STRUCT_PWQ)
715 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800716 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
717
718 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800719}
720
Tejun Heobbb68df2012-08-03 10:30:46 -0700721static void mark_work_canceling(struct work_struct *work)
722{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800723 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700724
Tejun Heo7c3eed52013-01-24 11:01:33 -0800725 pool_id <<= WORK_OFFQ_POOL_SHIFT;
726 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700727}
728
729static bool work_is_canceling(struct work_struct *work)
730{
731 unsigned long data = atomic_long_read(&work->data);
732
Tejun Heo112202d2013-02-13 19:29:12 -0800733 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700734}
735
David Howells365970a2006-11-22 14:54:49 +0000736/*
Tejun Heo32704762012-07-13 22:16:45 -0700737 * Policy functions. These define the policies on how the global worker
738 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800739 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000740 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200741
Tejun Heo63d95a92012-07-12 14:46:37 -0700742static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000743{
Tejun Heoe19e3972013-01-24 11:39:44 -0800744 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000745}
746
Tejun Heoe22bee72010-06-29 10:07:14 +0200747/*
748 * Need to wake up a worker? Called from anything but currently
749 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700750 *
751 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800752 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700753 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200754 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700755static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000756{
Tejun Heo63d95a92012-07-12 14:46:37 -0700757 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000758}
759
Tejun Heoe22bee72010-06-29 10:07:14 +0200760/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700761static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200762{
Tejun Heo63d95a92012-07-12 14:46:37 -0700763 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200764}
765
766/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700767static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200768{
Tejun Heoe19e3972013-01-24 11:39:44 -0800769 return !list_empty(&pool->worklist) &&
770 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200771}
772
773/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700774static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200775{
Tejun Heo63d95a92012-07-12 14:46:37 -0700776 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200777}
778
Tejun Heoe22bee72010-06-29 10:07:14 +0200779/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700780static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200781{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700782 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700783 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
784 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200785
786 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
787}
788
789/*
790 * Wake up functions.
791 */
792
Lai Jiangshan1037de32014-05-22 16:44:07 +0800793/* Return the first idle worker. Safe with preemption disabled */
794static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200795{
Tejun Heo63d95a92012-07-12 14:46:37 -0700796 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200797 return NULL;
798
Tejun Heo63d95a92012-07-12 14:46:37 -0700799 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200800}
801
802/**
803 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700804 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200805 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700806 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200807 *
808 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800809 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200810 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700811static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200812{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800813 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200814
815 if (likely(worker))
816 wake_up_process(worker->task);
817}
818
Tejun Heo4690c4a2010-06-29 10:07:10 +0200819/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200820 * wq_worker_waking_up - a worker is waking up
821 * @task: task waking up
822 * @cpu: CPU @task is waking up to
823 *
824 * This function is called during try_to_wake_up() when a worker is
825 * being awoken.
826 *
827 * CONTEXT:
828 * spin_lock_irq(rq->lock)
829 */
Tejun Heod84ff052013-03-12 11:29:59 -0700830void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200831{
832 struct worker *worker = kthread_data(task);
833
Joonsoo Kim36576002012-10-26 23:03:49 +0900834 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800835 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800836 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900837 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200838}
839
840/**
841 * wq_worker_sleeping - a worker is going to sleep
842 * @task: task going to sleep
843 * @cpu: CPU in question, must be the current CPU number
844 *
845 * This function is called during schedule() when a busy worker is
846 * going to sleep. Worker on the same cpu can be woken up by
847 * returning pointer to its task.
848 *
849 * CONTEXT:
850 * spin_lock_irq(rq->lock)
851 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700852 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200853 * Worker task on @cpu to wake up, %NULL if none.
854 */
Tejun Heod84ff052013-03-12 11:29:59 -0700855struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200856{
857 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800858 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200859
Tejun Heo111c2252013-01-17 17:16:24 -0800860 /*
861 * Rescuers, which may not have all the fields set up like normal
862 * workers, also reach here, let's not access anything before
863 * checking NOT_RUNNING.
864 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500865 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200866 return NULL;
867
Tejun Heo111c2252013-01-17 17:16:24 -0800868 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800869
Tejun Heoe22bee72010-06-29 10:07:14 +0200870 /* this can only happen on the local cpu */
Lai Jiangshan92b69f52014-06-03 15:33:08 +0800871 if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu))
Tejun Heo6183c002013-03-12 11:29:57 -0700872 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200873
874 /*
875 * The counterpart of the following dec_and_test, implied mb,
876 * worklist not empty test sequence is in insert_work().
877 * Please read comment there.
878 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700879 * NOT_RUNNING is clear. This means that we're bound to and
880 * running on the local cpu w/ rq lock held and preemption
881 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800882 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700883 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200884 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800885 if (atomic_dec_and_test(&pool->nr_running) &&
886 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800887 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200888 return to_wakeup ? to_wakeup->task : NULL;
889}
890
891/**
892 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200893 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200894 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200895 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800896 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200897 *
Tejun Heocb444762010-07-02 10:03:50 +0200898 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800899 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200900 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800901static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200902{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700903 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200904
Tejun Heocb444762010-07-02 10:03:50 +0200905 WARN_ON_ONCE(worker->task != current);
906
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800907 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200908 if ((flags & WORKER_NOT_RUNNING) &&
909 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800910 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200911 }
912
Tejun Heod302f012010-06-29 10:07:13 +0200913 worker->flags |= flags;
914}
915
916/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200917 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200918 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200919 * @flags: flags to clear
920 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200921 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200922 *
Tejun Heocb444762010-07-02 10:03:50 +0200923 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800924 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200925 */
926static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
927{
Tejun Heo63d95a92012-07-12 14:46:37 -0700928 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200929 unsigned int oflags = worker->flags;
930
Tejun Heocb444762010-07-02 10:03:50 +0200931 WARN_ON_ONCE(worker->task != current);
932
Tejun Heod302f012010-06-29 10:07:13 +0200933 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200934
Tejun Heo42c025f2011-01-11 15:58:49 +0100935 /*
936 * If transitioning out of NOT_RUNNING, increment nr_running. Note
937 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
938 * of multiple flags, not a single flag.
939 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200940 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
941 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800942 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200943}
944
945/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200946 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800947 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200948 * @work: work to find worker for
949 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800950 * Find a worker which is executing @work on @pool by searching
951 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800952 * to match, its current execution should match the address of @work and
953 * its work function. This is to avoid unwanted dependency between
954 * unrelated work executions through a work item being recycled while still
955 * being executed.
956 *
957 * This is a bit tricky. A work item may be freed once its execution
958 * starts and nothing prevents the freed area from being recycled for
959 * another work item. If the same work item address ends up being reused
960 * before the original execution finishes, workqueue will identify the
961 * recycled work item as currently executing and make it wait until the
962 * current execution finishes, introducing an unwanted dependency.
963 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700964 * This function checks the work item address and work function to avoid
965 * false positives. Note that this isn't complete as one may construct a
966 * work function which can introduce dependency onto itself through a
967 * recycled work item. Well, if somebody wants to shoot oneself in the
968 * foot that badly, there's only so much we can do, and if such deadlock
969 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200970 *
971 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800972 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200973 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700974 * Return:
975 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200976 * otherwise.
977 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800978static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200979 struct work_struct *work)
980{
Sasha Levin42f85702012-12-17 10:01:23 -0500981 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500982
Sasha Levinb67bfe02013-02-27 17:06:00 -0800983 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800984 (unsigned long)work)
985 if (worker->current_work == work &&
986 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500987 return worker;
988
989 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200990}
991
992/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700993 * move_linked_works - move linked works to a list
994 * @work: start of series of works to be scheduled
995 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +0530996 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -0700997 *
998 * Schedule linked works starting from @work to @head. Work series to
999 * be scheduled starts at @work and includes any consecutive work with
1000 * WORK_STRUCT_LINKED set in its predecessor.
1001 *
1002 * If @nextp is not NULL, it's updated to point to the next work of
1003 * the last scheduled work. This allows move_linked_works() to be
1004 * nested inside outer list_for_each_entry_safe().
1005 *
1006 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001007 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001008 */
1009static void move_linked_works(struct work_struct *work, struct list_head *head,
1010 struct work_struct **nextp)
1011{
1012 struct work_struct *n;
1013
1014 /*
1015 * Linked worklist will always end before the end of the list,
1016 * use NULL for list head.
1017 */
1018 list_for_each_entry_safe_from(work, n, NULL, entry) {
1019 list_move_tail(&work->entry, head);
1020 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1021 break;
1022 }
1023
1024 /*
1025 * If we're already inside safe list traversal and have moved
1026 * multiple works to the scheduled queue, the next position
1027 * needs to be updated.
1028 */
1029 if (nextp)
1030 *nextp = n;
1031}
1032
Tejun Heo8864b4e2013-03-12 11:30:04 -07001033/**
1034 * get_pwq - get an extra reference on the specified pool_workqueue
1035 * @pwq: pool_workqueue to get
1036 *
1037 * Obtain an extra reference on @pwq. The caller should guarantee that
1038 * @pwq has positive refcnt and be holding the matching pool->lock.
1039 */
1040static void get_pwq(struct pool_workqueue *pwq)
1041{
1042 lockdep_assert_held(&pwq->pool->lock);
1043 WARN_ON_ONCE(pwq->refcnt <= 0);
1044 pwq->refcnt++;
1045}
1046
1047/**
1048 * put_pwq - put a pool_workqueue reference
1049 * @pwq: pool_workqueue to put
1050 *
1051 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1052 * destruction. The caller should be holding the matching pool->lock.
1053 */
1054static void put_pwq(struct pool_workqueue *pwq)
1055{
1056 lockdep_assert_held(&pwq->pool->lock);
1057 if (likely(--pwq->refcnt))
1058 return;
1059 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1060 return;
1061 /*
1062 * @pwq can't be released under pool->lock, bounce to
1063 * pwq_unbound_release_workfn(). This never recurses on the same
1064 * pool->lock as this path is taken only for unbound workqueues and
1065 * the release work item is scheduled on a per-cpu workqueue. To
1066 * avoid lockdep warning, unbound pool->locks are given lockdep
1067 * subclass of 1 in get_unbound_pool().
1068 */
1069 schedule_work(&pwq->unbound_release_work);
1070}
1071
Tejun Heodce90d42013-04-01 11:23:35 -07001072/**
1073 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1074 * @pwq: pool_workqueue to put (can be %NULL)
1075 *
1076 * put_pwq() with locking. This function also allows %NULL @pwq.
1077 */
1078static void put_pwq_unlocked(struct pool_workqueue *pwq)
1079{
1080 if (pwq) {
1081 /*
1082 * As both pwqs and pools are sched-RCU protected, the
1083 * following lock operations are safe.
1084 */
1085 spin_lock_irq(&pwq->pool->lock);
1086 put_pwq(pwq);
1087 spin_unlock_irq(&pwq->pool->lock);
1088 }
1089}
1090
Tejun Heo112202d2013-02-13 19:29:12 -08001091static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001092{
Tejun Heo112202d2013-02-13 19:29:12 -08001093 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001094
1095 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001096 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001097 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001098 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001099}
1100
Tejun Heo112202d2013-02-13 19:29:12 -08001101static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001102{
Tejun Heo112202d2013-02-13 19:29:12 -08001103 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001104 struct work_struct, entry);
1105
Tejun Heo112202d2013-02-13 19:29:12 -08001106 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001107}
1108
Tejun Heobf4ede02012-08-03 10:30:46 -07001109/**
Tejun Heo112202d2013-02-13 19:29:12 -08001110 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1111 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001112 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001113 *
1114 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001115 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001116 *
1117 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001118 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001119 */
Tejun Heo112202d2013-02-13 19:29:12 -08001120static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001121{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001122 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001123 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001124 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001125
Tejun Heo112202d2013-02-13 19:29:12 -08001126 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001127
Tejun Heo112202d2013-02-13 19:29:12 -08001128 pwq->nr_active--;
1129 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001130 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001131 if (pwq->nr_active < pwq->max_active)
1132 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001133 }
1134
1135 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001136 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001137 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001138
1139 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001140 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001141 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001142
Tejun Heo112202d2013-02-13 19:29:12 -08001143 /* this pwq is done, clear flush_color */
1144 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001145
1146 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001147 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001148 * will handle the rest.
1149 */
Tejun Heo112202d2013-02-13 19:29:12 -08001150 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1151 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001152out_put:
1153 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001154}
1155
Tejun Heo36e227d2012-08-03 10:30:46 -07001156/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001157 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001158 * @work: work item to steal
1159 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001160 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001161 *
1162 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001163 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001164 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001165 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001166 * 1 if @work was pending and we successfully stole PENDING
1167 * 0 if @work was idle and we claimed PENDING
1168 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001169 * -ENOENT if someone else is canceling @work, this state may persist
1170 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001171 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001172 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001173 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001174 * interrupted while holding PENDING and @work off queue, irq must be
1175 * disabled on entry. This, combined with delayed_work->timer being
1176 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001177 *
1178 * On successful return, >= 0, irq is disabled and the caller is
1179 * responsible for releasing it using local_irq_restore(*@flags).
1180 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001181 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001182 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001183static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1184 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001185{
Tejun Heod565ed62013-01-24 11:01:33 -08001186 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001187 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001188
Tejun Heobbb68df2012-08-03 10:30:46 -07001189 local_irq_save(*flags);
1190
Tejun Heo36e227d2012-08-03 10:30:46 -07001191 /* try to steal the timer if it exists */
1192 if (is_dwork) {
1193 struct delayed_work *dwork = to_delayed_work(work);
1194
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001195 /*
1196 * dwork->timer is irqsafe. If del_timer() fails, it's
1197 * guaranteed that the timer is not queued anywhere and not
1198 * running on the local CPU.
1199 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001200 if (likely(del_timer(&dwork->timer)))
1201 return 1;
1202 }
1203
1204 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001205 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1206 return 0;
1207
1208 /*
1209 * The queueing is in progress, or it is already queued. Try to
1210 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1211 */
Tejun Heod565ed62013-01-24 11:01:33 -08001212 pool = get_work_pool(work);
1213 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001214 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001215
Tejun Heod565ed62013-01-24 11:01:33 -08001216 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001217 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001218 * work->data is guaranteed to point to pwq only while the work
1219 * item is queued on pwq->wq, and both updating work->data to point
1220 * to pwq on queueing and to pool on dequeueing are done under
1221 * pwq->pool->lock. This in turn guarantees that, if work->data
1222 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001223 * item is currently queued on that pool.
1224 */
Tejun Heo112202d2013-02-13 19:29:12 -08001225 pwq = get_work_pwq(work);
1226 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001227 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001228
Tejun Heo16062832013-02-06 18:04:53 -08001229 /*
1230 * A delayed work item cannot be grabbed directly because
1231 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001232 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001233 * management later on and cause stall. Make sure the work
1234 * item is activated before grabbing.
1235 */
1236 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001237 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001238
Tejun Heo16062832013-02-06 18:04:53 -08001239 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001240 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001241
Tejun Heo112202d2013-02-13 19:29:12 -08001242 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001243 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001244
Tejun Heo16062832013-02-06 18:04:53 -08001245 spin_unlock(&pool->lock);
1246 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001247 }
Tejun Heod565ed62013-01-24 11:01:33 -08001248 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001249fail:
1250 local_irq_restore(*flags);
1251 if (work_is_canceling(work))
1252 return -ENOENT;
1253 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001254 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001255}
1256
1257/**
Tejun Heo706026c2013-01-24 11:01:34 -08001258 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001259 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001260 * @work: work to insert
1261 * @head: insertion point
1262 * @extra_flags: extra WORK_STRUCT_* flags to set
1263 *
Tejun Heo112202d2013-02-13 19:29:12 -08001264 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001265 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001266 *
1267 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001268 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001269 */
Tejun Heo112202d2013-02-13 19:29:12 -08001270static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1271 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001272{
Tejun Heo112202d2013-02-13 19:29:12 -08001273 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001274
Tejun Heo4690c4a2010-06-29 10:07:10 +02001275 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001276 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001277 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001278 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001279
1280 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001281 * Ensure either wq_worker_sleeping() sees the above
1282 * list_add_tail() or we see zero nr_running to avoid workers lying
1283 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001284 */
1285 smp_mb();
1286
Tejun Heo63d95a92012-07-12 14:46:37 -07001287 if (__need_more_worker(pool))
1288 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001289}
1290
Tejun Heoc8efcc22010-12-20 19:32:04 +01001291/*
1292 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001293 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001294 */
1295static bool is_chained_work(struct workqueue_struct *wq)
1296{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001297 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001298
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001299 worker = current_wq_worker();
1300 /*
1301 * Return %true iff I'm a worker execuing a work item on @wq. If
1302 * I'm @worker, it's safe to dereference it without locking.
1303 */
Tejun Heo112202d2013-02-13 19:29:12 -08001304 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001305}
1306
Tejun Heod84ff052013-03-12 11:29:59 -07001307static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 struct work_struct *work)
1309{
Tejun Heo112202d2013-02-13 19:29:12 -08001310 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001311 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001312 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001313 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001314 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001315
1316 /*
1317 * While a work item is PENDING && off queue, a task trying to
1318 * steal the PENDING will busy-loop waiting for it to either get
1319 * queued or lose PENDING. Grabbing PENDING and queueing should
1320 * happen with IRQ disabled.
1321 */
1322 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001324 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001325
Li Bin9ef28a72013-09-09 13:13:58 +08001326 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001327 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001328 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001329 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001330retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001331 if (req_cpu == WORK_CPU_UNBOUND)
1332 cpu = raw_smp_processor_id();
1333
Tejun Heoc9178082013-03-12 11:30:04 -07001334 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001335 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001336 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001337 else
1338 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001339
Tejun Heoc9178082013-03-12 11:30:04 -07001340 /*
1341 * If @work was previously on a different pool, it might still be
1342 * running there, in which case the work needs to be queued on that
1343 * pool to guarantee non-reentrancy.
1344 */
1345 last_pool = get_work_pool(work);
1346 if (last_pool && last_pool != pwq->pool) {
1347 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001348
Tejun Heoc9178082013-03-12 11:30:04 -07001349 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001350
Tejun Heoc9178082013-03-12 11:30:04 -07001351 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001352
Tejun Heoc9178082013-03-12 11:30:04 -07001353 if (worker && worker->current_pwq->wq == wq) {
1354 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001355 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001356 /* meh... not running there, queue here */
1357 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001358 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001359 }
Tejun Heof3421792010-07-02 10:03:51 +02001360 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001361 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001362 }
1363
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001364 /*
1365 * pwq is determined and locked. For unbound pools, we could have
1366 * raced with pwq release and it could already be dead. If its
1367 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001368 * without another pwq replacing it in the numa_pwq_tbl or while
1369 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001370 * make forward-progress.
1371 */
1372 if (unlikely(!pwq->refcnt)) {
1373 if (wq->flags & WQ_UNBOUND) {
1374 spin_unlock(&pwq->pool->lock);
1375 cpu_relax();
1376 goto retry;
1377 }
1378 /* oops */
1379 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1380 wq->name, cpu);
1381 }
1382
Tejun Heo112202d2013-02-13 19:29:12 -08001383 /* pwq determined, queue */
1384 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001385
Dan Carpenterf5b25522012-04-13 22:06:58 +03001386 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001387 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001388 return;
1389 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001390
Tejun Heo112202d2013-02-13 19:29:12 -08001391 pwq->nr_in_flight[pwq->work_color]++;
1392 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001393
Tejun Heo112202d2013-02-13 19:29:12 -08001394 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001395 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001396 pwq->nr_active++;
1397 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001398 } else {
1399 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001400 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001401 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001402
Tejun Heo112202d2013-02-13 19:29:12 -08001403 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001404
Tejun Heo112202d2013-02-13 19:29:12 -08001405 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406}
1407
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001408/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001409 * queue_work_on - queue work on specific cpu
1410 * @cpu: CPU number to execute work on
1411 * @wq: workqueue to use
1412 * @work: work to queue
1413 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001414 * We queue the work to a specific CPU, the caller must ensure it
1415 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001416 *
1417 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001418 */
Tejun Heod4283e92012-08-03 10:30:44 -07001419bool queue_work_on(int cpu, struct workqueue_struct *wq,
1420 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001421{
Tejun Heod4283e92012-08-03 10:30:44 -07001422 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001423 unsigned long flags;
1424
1425 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001426
Tejun Heo22df02b2010-06-29 10:07:10 +02001427 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001428 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001429 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001430 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001431
1432 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001433 return ret;
1434}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001435EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001436
Tejun Heod8e794d2012-08-03 10:30:45 -07001437void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438{
David Howells52bad642006-11-22 14:54:01 +00001439 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001441 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001442 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001444EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001446static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1447 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001449 struct timer_list *timer = &dwork->timer;
1450 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001452 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1453 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001454 WARN_ON_ONCE(timer_pending(timer));
1455 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001456
Tejun Heo8852aac2012-12-01 16:23:42 -08001457 /*
1458 * If @delay is 0, queue @dwork->work immediately. This is for
1459 * both optimization and correctness. The earliest @timer can
1460 * expire is on the closest next tick and delayed_work users depend
1461 * on that there's no such delay when @delay is 0.
1462 */
1463 if (!delay) {
1464 __queue_work(cpu, wq, &dwork->work);
1465 return;
1466 }
1467
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001468 timer_stats_timer_set_start_info(&dwork->timer);
1469
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001470 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001471 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001472 timer->expires = jiffies + delay;
1473
Tejun Heo66847102016-02-09 16:11:26 -05001474 if (unlikely(cpu != WORK_CPU_UNBOUND))
1475 add_timer_on(timer, cpu);
1476 else
1477 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478}
1479
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001480/**
1481 * queue_delayed_work_on - queue work on specific CPU after delay
1482 * @cpu: CPU number to execute work on
1483 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001484 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001485 * @delay: number of jiffies to wait before queueing
1486 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001487 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001488 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1489 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001490 */
Tejun Heod4283e92012-08-03 10:30:44 -07001491bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1492 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001493{
David Howells52bad642006-11-22 14:54:01 +00001494 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001495 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001496 unsigned long flags;
1497
1498 /* read the comment in __queue_work() */
1499 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001500
Tejun Heo22df02b2010-06-29 10:07:10 +02001501 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001502 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001503 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001504 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001505
1506 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001507 return ret;
1508}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001509EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
Tejun Heoc8e55f32010-06-29 10:07:12 +02001511/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001512 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1513 * @cpu: CPU number to execute work on
1514 * @wq: workqueue to use
1515 * @dwork: work to queue
1516 * @delay: number of jiffies to wait before queueing
1517 *
1518 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1519 * modify @dwork's timer so that it expires after @delay. If @delay is
1520 * zero, @work is guaranteed to be scheduled immediately regardless of its
1521 * current state.
1522 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001523 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001524 * pending and its timer was modified.
1525 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001526 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001527 * See try_to_grab_pending() for details.
1528 */
1529bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1530 struct delayed_work *dwork, unsigned long delay)
1531{
1532 unsigned long flags;
1533 int ret;
1534
1535 do {
1536 ret = try_to_grab_pending(&dwork->work, true, &flags);
1537 } while (unlikely(ret == -EAGAIN));
1538
1539 if (likely(ret >= 0)) {
1540 __queue_delayed_work(cpu, wq, dwork, delay);
1541 local_irq_restore(flags);
1542 }
1543
1544 /* -ENOENT from try_to_grab_pending() becomes %true */
1545 return ret;
1546}
1547EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1548
1549/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001550 * worker_enter_idle - enter idle state
1551 * @worker: worker which is entering idle state
1552 *
1553 * @worker is entering idle state. Update stats and idle timer if
1554 * necessary.
1555 *
1556 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001557 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001558 */
1559static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001561 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
Tejun Heo6183c002013-03-12 11:29:57 -07001563 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1564 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1565 (worker->hentry.next || worker->hentry.pprev)))
1566 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
Lai Jiangshan051e1852014-07-22 13:03:02 +08001568 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001569 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001570 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001571 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001572
Tejun Heoc8e55f32010-06-29 10:07:12 +02001573 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001574 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001575
Tejun Heo628c78e2012-07-17 12:39:27 -07001576 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1577 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001578
Tejun Heo544ecf32012-05-14 15:04:50 -07001579 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001580 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001581 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001582 * nr_running, the warning may trigger spuriously. Check iff
1583 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001584 */
Tejun Heo24647572013-01-24 11:01:33 -08001585 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001586 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001587 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588}
1589
Tejun Heoc8e55f32010-06-29 10:07:12 +02001590/**
1591 * worker_leave_idle - leave idle state
1592 * @worker: worker which is leaving idle state
1593 *
1594 * @worker is leaving idle state. Update stats.
1595 *
1596 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001597 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001598 */
1599static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001601 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602
Tejun Heo6183c002013-03-12 11:29:57 -07001603 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1604 return;
Tejun Heod302f012010-06-29 10:07:13 +02001605 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001606 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001607 list_del_init(&worker->entry);
1608}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001610static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001611{
1612 struct worker *worker;
1613
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001614 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001615 if (worker) {
1616 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001617 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001618 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001619 /* on creation a worker is in !idle && prep state */
1620 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001621 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001622 return worker;
1623}
1624
1625/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001626 * worker_attach_to_pool() - attach a worker to a pool
1627 * @worker: worker to be attached
1628 * @pool: the target pool
1629 *
1630 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1631 * cpu-binding of @worker are kept coordinated with the pool across
1632 * cpu-[un]hotplugs.
1633 */
1634static void worker_attach_to_pool(struct worker *worker,
1635 struct worker_pool *pool)
1636{
1637 mutex_lock(&pool->attach_mutex);
1638
1639 /*
1640 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1641 * online CPUs. It'll be re-applied when any of the CPUs come up.
1642 */
1643 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1644
1645 /*
1646 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1647 * stable across this function. See the comments above the
1648 * flag definition for details.
1649 */
1650 if (pool->flags & POOL_DISASSOCIATED)
1651 worker->flags |= WORKER_UNBOUND;
1652
1653 list_add_tail(&worker->node, &pool->workers);
1654
1655 mutex_unlock(&pool->attach_mutex);
1656}
1657
1658/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001659 * worker_detach_from_pool() - detach a worker from its pool
1660 * @worker: worker which is attached to its pool
1661 * @pool: the pool @worker is attached to
1662 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001663 * Undo the attaching which had been done in worker_attach_to_pool(). The
1664 * caller worker shouldn't access to the pool after detached except it has
1665 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001666 */
1667static void worker_detach_from_pool(struct worker *worker,
1668 struct worker_pool *pool)
1669{
1670 struct completion *detach_completion = NULL;
1671
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001672 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001673 list_del(&worker->node);
1674 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001675 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001676 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001677
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001678 /* clear leftover flags without pool->lock after it is detached */
1679 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1680
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001681 if (detach_completion)
1682 complete(detach_completion);
1683}
1684
1685/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001686 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001687 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001688 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001689 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001690 *
1691 * CONTEXT:
1692 * Might sleep. Does GFP_KERNEL allocations.
1693 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001694 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001695 * Pointer to the newly created worker.
1696 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001697static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001698{
Tejun Heoc34056a2010-06-29 10:07:11 +02001699 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001700 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001701 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001702
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001703 /* ID is needed to determine kthread name */
1704 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001705 if (id < 0)
1706 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001707
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001708 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001709 if (!worker)
1710 goto fail;
1711
Tejun Heobd7bdd42012-07-12 14:46:37 -07001712 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001713 worker->id = id;
1714
Tejun Heo29c91e92013-03-12 11:30:03 -07001715 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001716 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1717 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001718 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001719 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1720
Tejun Heof3f90ad2013-04-01 11:23:34 -07001721 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001722 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001723 if (IS_ERR(worker->task))
1724 goto fail;
1725
Oleg Nesterov91151222013-11-14 12:56:18 +01001726 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001727 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001728
Lai Jiangshanda028462014-05-20 17:46:31 +08001729 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001730 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001731
Lai Jiangshan051e1852014-07-22 13:03:02 +08001732 /* start the newly created worker */
1733 spin_lock_irq(&pool->lock);
1734 worker->pool->nr_workers++;
1735 worker_enter_idle(worker);
1736 wake_up_process(worker->task);
1737 spin_unlock_irq(&pool->lock);
1738
Tejun Heoc34056a2010-06-29 10:07:11 +02001739 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001740
Tejun Heoc34056a2010-06-29 10:07:11 +02001741fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001742 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001743 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001744 kfree(worker);
1745 return NULL;
1746}
1747
1748/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001749 * destroy_worker - destroy a workqueue worker
1750 * @worker: worker to be destroyed
1751 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001752 * Destroy @worker and adjust @pool stats accordingly. The worker should
1753 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001754 *
1755 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001756 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001757 */
1758static void destroy_worker(struct worker *worker)
1759{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001760 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001761
Tejun Heocd549682013-03-13 19:47:39 -07001762 lockdep_assert_held(&pool->lock);
1763
Tejun Heoc34056a2010-06-29 10:07:11 +02001764 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001765 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001766 WARN_ON(!list_empty(&worker->scheduled)) ||
1767 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001768 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001769
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001770 pool->nr_workers--;
1771 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001772
Tejun Heoc8e55f32010-06-29 10:07:12 +02001773 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001774 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001775 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001776}
1777
Tejun Heo63d95a92012-07-12 14:46:37 -07001778static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001779{
Tejun Heo63d95a92012-07-12 14:46:37 -07001780 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001781
Tejun Heod565ed62013-01-24 11:01:33 -08001782 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001783
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001784 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001785 struct worker *worker;
1786 unsigned long expires;
1787
1788 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001789 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001790 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1791
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001792 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001793 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001794 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001795 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001796
1797 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001798 }
1799
Tejun Heod565ed62013-01-24 11:01:33 -08001800 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001801}
1802
Tejun Heo493a1722013-03-12 11:29:59 -07001803static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001804{
Tejun Heo112202d2013-02-13 19:29:12 -08001805 struct pool_workqueue *pwq = get_work_pwq(work);
1806 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001807
Tejun Heo2e109a22013-03-13 19:47:40 -07001808 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001809
Tejun Heo493008a2013-03-12 11:30:03 -07001810 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001811 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001812
1813 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001814 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001815 /*
1816 * If @pwq is for an unbound wq, its base ref may be put at
1817 * any time due to an attribute change. Pin @pwq until the
1818 * rescuer is done with it.
1819 */
1820 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001821 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001822 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001823 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001824}
1825
Tejun Heo706026c2013-01-24 11:01:34 -08001826static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001827{
Tejun Heo63d95a92012-07-12 14:46:37 -07001828 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001829 struct work_struct *work;
1830
Tejun Heob2d82902014-12-08 12:39:16 -05001831 spin_lock_irq(&pool->lock);
1832 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001833
Tejun Heo63d95a92012-07-12 14:46:37 -07001834 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001835 /*
1836 * We've been trying to create a new worker but
1837 * haven't been successful. We might be hitting an
1838 * allocation deadlock. Send distress signals to
1839 * rescuers.
1840 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001841 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001842 send_mayday(work);
1843 }
1844
Tejun Heob2d82902014-12-08 12:39:16 -05001845 spin_unlock(&wq_mayday_lock);
1846 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001847
Tejun Heo63d95a92012-07-12 14:46:37 -07001848 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001849}
1850
1851/**
1852 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001853 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001854 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001855 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001856 * have at least one idle worker on return from this function. If
1857 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001858 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001859 * possible allocation deadlock.
1860 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001861 * On return, need_to_create_worker() is guaranteed to be %false and
1862 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001863 *
1864 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001865 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001866 * multiple times. Does GFP_KERNEL allocations. Called only from
1867 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001868 */
Tejun Heo29187a92015-01-16 14:21:16 -05001869static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001870__releases(&pool->lock)
1871__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001872{
Tejun Heoe22bee72010-06-29 10:07:14 +02001873restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001874 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001875
Tejun Heoe22bee72010-06-29 10:07:14 +02001876 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001877 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001878
1879 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001880 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001881 break;
1882
Lai Jiangshane212f362014-06-03 15:32:17 +08001883 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001884
Tejun Heo63d95a92012-07-12 14:46:37 -07001885 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001886 break;
1887 }
1888
Tejun Heo63d95a92012-07-12 14:46:37 -07001889 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001890 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001891 /*
1892 * This is necessary even after a new worker was just successfully
1893 * created as @pool->lock was dropped and the new worker might have
1894 * already become busy.
1895 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001896 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001897 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001898}
1899
1900/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001901 * manage_workers - manage worker pool
1902 * @worker: self
1903 *
Tejun Heo706026c2013-01-24 11:01:34 -08001904 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001905 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001906 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001907 *
1908 * The caller can safely start processing works on false return. On
1909 * true return, it's guaranteed that need_to_create_worker() is false
1910 * and may_start_working() is true.
1911 *
1912 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001913 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001914 * multiple times. Does GFP_KERNEL allocations.
1915 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001916 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001917 * %false if the pool doesn't need management and the caller can safely
1918 * start processing works, %true if management function was performed and
1919 * the conditions that the caller verified before calling the function may
1920 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001921 */
1922static bool manage_workers(struct worker *worker)
1923{
Tejun Heo63d95a92012-07-12 14:46:37 -07001924 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001925
Tejun Heobc3a1af2013-03-13 19:47:39 -07001926 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07001927 * Anyone who successfully grabs manager_arb wins the arbitration
1928 * and becomes the manager. mutex_trylock() on pool->manager_arb
1929 * failure while holding pool->lock reliably indicates that someone
1930 * else is managing the pool and the worker which failed trylock
1931 * can proceed to executing work items. This means that anyone
1932 * grabbing manager_arb is responsible for actually performing
1933 * manager duties. If manager_arb is grabbed and released without
1934 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07001935 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07001936 if (!mutex_trylock(&pool->manager_arb))
Tejun Heo29187a92015-01-16 14:21:16 -05001937 return false;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001938 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001939
Tejun Heo29187a92015-01-16 14:21:16 -05001940 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001941
Tejun Heo2607d7a2015-03-09 09:22:28 -04001942 pool->manager = NULL;
Tejun Heo34a06bd2013-03-12 11:30:00 -07001943 mutex_unlock(&pool->manager_arb);
Tejun Heo29187a92015-01-16 14:21:16 -05001944 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02001945}
1946
Tejun Heoa62428c2010-06-29 10:07:10 +02001947/**
1948 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001949 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001950 * @work: work to process
1951 *
1952 * Process @work. This function contains all the logics necessary to
1953 * process a single work including synchronization against and
1954 * interaction with other workers on the same cpu, queueing and
1955 * flushing. As long as context requirement is met, any worker can
1956 * call this function to process a work.
1957 *
1958 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001959 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001960 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001961static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08001962__releases(&pool->lock)
1963__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02001964{
Tejun Heo112202d2013-02-13 19:29:12 -08001965 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001966 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001967 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02001968 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001969 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001970#ifdef CONFIG_LOCKDEP
1971 /*
1972 * It is permissible to free the struct work_struct from
1973 * inside the function that is called from it, this we need to
1974 * take into account for lockdep too. To avoid bogus "held
1975 * lock freed" warnings as well as problems when looking into
1976 * work->lockdep_map, make a copy and use that here.
1977 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07001978 struct lockdep_map lockdep_map;
1979
1980 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02001981#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08001982 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08001983 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08001984 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07001985
Tejun Heo7e116292010-06-29 10:07:13 +02001986 /*
1987 * A single work shouldn't be executed concurrently by
1988 * multiple workers on a single cpu. Check whether anyone is
1989 * already processing the work. If so, defer the work to the
1990 * currently executing one.
1991 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001992 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02001993 if (unlikely(collision)) {
1994 move_linked_works(work, &collision->scheduled, NULL);
1995 return;
1996 }
1997
Tejun Heo8930cab2012-08-03 10:30:45 -07001998 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02001999 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002000 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002001 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002002 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002003 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002004 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002005
Tejun Heoa62428c2010-06-29 10:07:10 +02002006 list_del_init(&work->entry);
2007
Tejun Heo649027d2010-06-29 10:07:14 +02002008 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002009 * CPU intensive works don't participate in concurrency management.
2010 * They're the scheduler's responsibility. This takes @worker out
2011 * of concurrency management and the next code block will chain
2012 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002013 */
2014 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002015 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002016
Tejun Heo974271c2012-07-12 14:46:37 -07002017 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002018 * Wake up another worker if necessary. The condition is always
2019 * false for normal per-cpu workers since nr_running would always
2020 * be >= 1 at this point. This is used to chain execution of the
2021 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002022 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002023 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002024 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002025 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002026
Tejun Heo8930cab2012-08-03 10:30:45 -07002027 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002028 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002029 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002030 * PENDING and queued state changes happen together while IRQ is
2031 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002032 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002033 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002034
Tejun Heod565ed62013-01-24 11:01:33 -08002035 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002036
Tejun Heo112202d2013-02-13 19:29:12 -08002037 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002038 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002039 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002040 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002041 /*
2042 * While we must be careful to not use "work" after this, the trace
2043 * point will only record its address.
2044 */
2045 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002046 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002047 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002048
2049 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002050 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2051 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002052 current->comm, preempt_count(), task_pid_nr(current),
2053 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002054 debug_show_held_locks(current);
2055 dump_stack();
2056 }
2057
Tejun Heob22ce272013-08-28 17:33:37 -04002058 /*
2059 * The following prevents a kworker from hogging CPU on !PREEMPT
2060 * kernels, where a requeueing work item waiting for something to
2061 * happen could deadlock with stop_machine as such work item could
2062 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002063 * stop_machine. At the same time, report a quiescent RCU state so
2064 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002065 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002066 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002067
Tejun Heod565ed62013-01-24 11:01:33 -08002068 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002069
Tejun Heofb0e7be2010-06-29 10:07:15 +02002070 /* clear cpu intensive status */
2071 if (unlikely(cpu_intensive))
2072 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2073
Tejun Heoa62428c2010-06-29 10:07:10 +02002074 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002075 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002076 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002077 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002078 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002079 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002080 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002081}
2082
Tejun Heoaffee4b2010-06-29 10:07:12 +02002083/**
2084 * process_scheduled_works - process scheduled works
2085 * @worker: self
2086 *
2087 * Process all scheduled works. Please note that the scheduled list
2088 * may change while processing a work, so this function repeatedly
2089 * fetches a work from the top and executes it.
2090 *
2091 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002092 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002093 * multiple times.
2094 */
2095static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002097 while (!list_empty(&worker->scheduled)) {
2098 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002100 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102}
2103
Tejun Heo4690c4a2010-06-29 10:07:10 +02002104/**
2105 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002106 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002107 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002108 * The worker thread function. All workers belong to a worker_pool -
2109 * either a per-cpu one or dynamic unbound one. These workers process all
2110 * work items regardless of their specific target workqueue. The only
2111 * exception is work items which belong to workqueues with a rescuer which
2112 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002113 *
2114 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002115 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002116static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117{
Tejun Heoc34056a2010-06-29 10:07:11 +02002118 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002119 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120
Tejun Heoe22bee72010-06-29 10:07:14 +02002121 /* tell the scheduler that this is a workqueue worker */
2122 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002123woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002124 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002125
Tejun Heoa9ab7752013-03-19 13:45:21 -07002126 /* am I supposed to die? */
2127 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002128 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002129 WARN_ON_ONCE(!list_empty(&worker->entry));
2130 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002131
2132 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002133 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002134 worker_detach_from_pool(worker, pool);
2135 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002136 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002138
Tejun Heoc8e55f32010-06-29 10:07:12 +02002139 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002140recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002141 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002142 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002143 goto sleep;
2144
2145 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002146 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002147 goto recheck;
2148
Tejun Heoc8e55f32010-06-29 10:07:12 +02002149 /*
2150 * ->scheduled list can only be filled while a worker is
2151 * preparing to process a work or actually processing it.
2152 * Make sure nobody diddled with it while I was sleeping.
2153 */
Tejun Heo6183c002013-03-12 11:29:57 -07002154 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002155
Tejun Heoe22bee72010-06-29 10:07:14 +02002156 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002157 * Finish PREP stage. We're guaranteed to have at least one idle
2158 * worker or that someone else has already assumed the manager
2159 * role. This is where @worker starts participating in concurrency
2160 * management if applicable and concurrency management is restored
2161 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002162 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002163 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002164
2165 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002166 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002167 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002168 struct work_struct, entry);
2169
2170 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2171 /* optimization path, not strictly necessary */
2172 process_one_work(worker, work);
2173 if (unlikely(!list_empty(&worker->scheduled)))
2174 process_scheduled_works(worker);
2175 } else {
2176 move_linked_works(work, &worker->scheduled, NULL);
2177 process_scheduled_works(worker);
2178 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002179 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002180
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002181 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002182sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002183 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002184 * pool->lock is held and there's no work to process and no need to
2185 * manage, sleep. Workers are woken up only while holding
2186 * pool->lock or from local cpu, so setting the current state
2187 * before releasing pool->lock is enough to prevent losing any
2188 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002189 */
2190 worker_enter_idle(worker);
2191 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002192 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002193 schedule();
2194 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195}
2196
Tejun Heoe22bee72010-06-29 10:07:14 +02002197/**
2198 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002199 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002200 *
2201 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002202 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002203 *
Tejun Heo706026c2013-01-24 11:01:34 -08002204 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002205 * worker which uses GFP_KERNEL allocation which has slight chance of
2206 * developing into deadlock if some works currently on the same queue
2207 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2208 * the problem rescuer solves.
2209 *
Tejun Heo706026c2013-01-24 11:01:34 -08002210 * When such condition is possible, the pool summons rescuers of all
2211 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002212 * those works so that forward progress can be guaranteed.
2213 *
2214 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002215 *
2216 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002217 */
Tejun Heo111c2252013-01-17 17:16:24 -08002218static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002219{
Tejun Heo111c2252013-01-17 17:16:24 -08002220 struct worker *rescuer = __rescuer;
2221 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002222 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002223 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002224
2225 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002226
2227 /*
2228 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2229 * doesn't participate in concurrency management.
2230 */
2231 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002232repeat:
2233 set_current_state(TASK_INTERRUPTIBLE);
2234
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002235 /*
2236 * By the time the rescuer is requested to stop, the workqueue
2237 * shouldn't have any work pending, but @wq->maydays may still have
2238 * pwq(s) queued. This can happen by non-rescuer workers consuming
2239 * all the work items before the rescuer got to them. Go through
2240 * @wq->maydays processing before acting on should_stop so that the
2241 * list is always empty on exit.
2242 */
2243 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002244
Tejun Heo493a1722013-03-12 11:29:59 -07002245 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002246 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002247
2248 while (!list_empty(&wq->maydays)) {
2249 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2250 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002251 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002252 struct work_struct *work, *n;
2253
2254 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002255 list_del_init(&pwq->mayday_node);
2256
Tejun Heo2e109a22013-03-13 19:47:40 -07002257 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002258
Lai Jiangshan51697d392014-05-20 17:46:36 +08002259 worker_attach_to_pool(rescuer, pool);
2260
2261 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002262 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002263
2264 /*
2265 * Slurp in all works issued via this workqueue and
2266 * process'em.
2267 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002268 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002269 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002270 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002271 move_linked_works(work, scheduled, &n);
2272
NeilBrown008847f2014-12-08 12:39:16 -05002273 if (!list_empty(scheduled)) {
2274 process_scheduled_works(rescuer);
2275
2276 /*
2277 * The above execution of rescued work items could
2278 * have created more to rescue through
2279 * pwq_activate_first_delayed() or chained
2280 * queueing. Let's put @pwq back on mayday list so
2281 * that such back-to-back work items, which may be
2282 * being used to relieve memory pressure, don't
2283 * incur MAYDAY_INTERVAL delay inbetween.
2284 */
2285 if (need_to_create_worker(pool)) {
2286 spin_lock(&wq_mayday_lock);
2287 get_pwq(pwq);
2288 list_move_tail(&pwq->mayday_node, &wq->maydays);
2289 spin_unlock(&wq_mayday_lock);
2290 }
2291 }
Tejun Heo75769582011-02-14 14:04:46 +01002292
2293 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002294 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002295 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002296 */
2297 put_pwq(pwq);
2298
2299 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002300 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002301 * regular worker; otherwise, we end up with 0 concurrency
2302 * and stalling the execution.
2303 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002304 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002305 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002306
Lai Jiangshanb3104102013-02-19 12:17:02 -08002307 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002308 spin_unlock_irq(&pool->lock);
2309
2310 worker_detach_from_pool(rescuer, pool);
2311
2312 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002313 }
2314
Tejun Heo2e109a22013-03-13 19:47:40 -07002315 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002316
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002317 if (should_stop) {
2318 __set_current_state(TASK_RUNNING);
2319 rescuer->task->flags &= ~PF_WQ_WORKER;
2320 return 0;
2321 }
2322
Tejun Heo111c2252013-01-17 17:16:24 -08002323 /* rescuers should never participate in concurrency management */
2324 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002325 schedule();
2326 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327}
2328
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002329struct wq_barrier {
2330 struct work_struct work;
2331 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002332 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002333};
2334
2335static void wq_barrier_func(struct work_struct *work)
2336{
2337 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2338 complete(&barr->done);
2339}
2340
Tejun Heo4690c4a2010-06-29 10:07:10 +02002341/**
2342 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002343 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002344 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002345 * @target: target work to attach @barr to
2346 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002347 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002348 * @barr is linked to @target such that @barr is completed only after
2349 * @target finishes execution. Please note that the ordering
2350 * guarantee is observed only with respect to @target and on the local
2351 * cpu.
2352 *
2353 * Currently, a queued barrier can't be canceled. This is because
2354 * try_to_grab_pending() can't determine whether the work to be
2355 * grabbed is at the head of the queue and thus can't clear LINKED
2356 * flag of the previous work while there must be a valid next work
2357 * after a work with LINKED flag set.
2358 *
2359 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002360 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002361 *
2362 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002363 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002364 */
Tejun Heo112202d2013-02-13 19:29:12 -08002365static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002366 struct wq_barrier *barr,
2367 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002368{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002369 struct list_head *head;
2370 unsigned int linked = 0;
2371
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002372 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002373 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002374 * as we know for sure that this will not trigger any of the
2375 * checks and call back into the fixup functions where we
2376 * might deadlock.
2377 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002378 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002379 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002380 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002381 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002382
Tejun Heoaffee4b2010-06-29 10:07:12 +02002383 /*
2384 * If @target is currently being executed, schedule the
2385 * barrier to the worker; otherwise, put it after @target.
2386 */
2387 if (worker)
2388 head = worker->scheduled.next;
2389 else {
2390 unsigned long *bits = work_data_bits(target);
2391
2392 head = target->entry.next;
2393 /* there can already be other linked works, inherit and set */
2394 linked = *bits & WORK_STRUCT_LINKED;
2395 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2396 }
2397
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002398 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002399 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002400 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002401}
2402
Tejun Heo73f53c42010-06-29 10:07:11 +02002403/**
Tejun Heo112202d2013-02-13 19:29:12 -08002404 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002405 * @wq: workqueue being flushed
2406 * @flush_color: new flush color, < 0 for no-op
2407 * @work_color: new work color, < 0 for no-op
2408 *
Tejun Heo112202d2013-02-13 19:29:12 -08002409 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002410 *
Tejun Heo112202d2013-02-13 19:29:12 -08002411 * If @flush_color is non-negative, flush_color on all pwqs should be
2412 * -1. If no pwq has in-flight commands at the specified color, all
2413 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2414 * has in flight commands, its pwq->flush_color is set to
2415 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002416 * wakeup logic is armed and %true is returned.
2417 *
2418 * The caller should have initialized @wq->first_flusher prior to
2419 * calling this function with non-negative @flush_color. If
2420 * @flush_color is negative, no flush color update is done and %false
2421 * is returned.
2422 *
Tejun Heo112202d2013-02-13 19:29:12 -08002423 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002424 * work_color which is previous to @work_color and all will be
2425 * advanced to @work_color.
2426 *
2427 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002428 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002429 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002430 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002431 * %true if @flush_color >= 0 and there's something to flush. %false
2432 * otherwise.
2433 */
Tejun Heo112202d2013-02-13 19:29:12 -08002434static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002435 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436{
Tejun Heo73f53c42010-06-29 10:07:11 +02002437 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002438 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002439
Tejun Heo73f53c42010-06-29 10:07:11 +02002440 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002441 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002442 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002443 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002444
Tejun Heo49e3cf42013-03-12 11:29:58 -07002445 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002446 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002447
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002448 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002449
2450 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002451 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002452
Tejun Heo112202d2013-02-13 19:29:12 -08002453 if (pwq->nr_in_flight[flush_color]) {
2454 pwq->flush_color = flush_color;
2455 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002456 wait = true;
2457 }
2458 }
2459
2460 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002461 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002462 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002463 }
2464
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002465 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002466 }
2467
Tejun Heo112202d2013-02-13 19:29:12 -08002468 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002469 complete(&wq->first_flusher->done);
2470
2471 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472}
2473
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002474/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002476 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002478 * This function sleeps until all work items which were queued on entry
2479 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002481void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482{
Tejun Heo73f53c42010-06-29 10:07:11 +02002483 struct wq_flusher this_flusher = {
2484 .list = LIST_HEAD_INIT(this_flusher.list),
2485 .flush_color = -1,
2486 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2487 };
2488 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002489
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002490 lock_map_acquire(&wq->lockdep_map);
2491 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002492
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002493 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002494
2495 /*
2496 * Start-to-wait phase
2497 */
2498 next_color = work_next_color(wq->work_color);
2499
2500 if (next_color != wq->flush_color) {
2501 /*
2502 * Color space is not full. The current work_color
2503 * becomes our flush_color and work_color is advanced
2504 * by one.
2505 */
Tejun Heo6183c002013-03-12 11:29:57 -07002506 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002507 this_flusher.flush_color = wq->work_color;
2508 wq->work_color = next_color;
2509
2510 if (!wq->first_flusher) {
2511 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002512 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002513
2514 wq->first_flusher = &this_flusher;
2515
Tejun Heo112202d2013-02-13 19:29:12 -08002516 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002517 wq->work_color)) {
2518 /* nothing to flush, done */
2519 wq->flush_color = next_color;
2520 wq->first_flusher = NULL;
2521 goto out_unlock;
2522 }
2523 } else {
2524 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002525 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002526 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002527 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002528 }
2529 } else {
2530 /*
2531 * Oops, color space is full, wait on overflow queue.
2532 * The next flush completion will assign us
2533 * flush_color and transfer to flusher_queue.
2534 */
2535 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2536 }
2537
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002538 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002539
2540 wait_for_completion(&this_flusher.done);
2541
2542 /*
2543 * Wake-up-and-cascade phase
2544 *
2545 * First flushers are responsible for cascading flushes and
2546 * handling overflow. Non-first flushers can simply return.
2547 */
2548 if (wq->first_flusher != &this_flusher)
2549 return;
2550
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002551 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002552
Tejun Heo4ce48b32010-07-02 10:03:51 +02002553 /* we might have raced, check again with mutex held */
2554 if (wq->first_flusher != &this_flusher)
2555 goto out_unlock;
2556
Tejun Heo73f53c42010-06-29 10:07:11 +02002557 wq->first_flusher = NULL;
2558
Tejun Heo6183c002013-03-12 11:29:57 -07002559 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2560 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002561
2562 while (true) {
2563 struct wq_flusher *next, *tmp;
2564
2565 /* complete all the flushers sharing the current flush color */
2566 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2567 if (next->flush_color != wq->flush_color)
2568 break;
2569 list_del_init(&next->list);
2570 complete(&next->done);
2571 }
2572
Tejun Heo6183c002013-03-12 11:29:57 -07002573 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2574 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002575
2576 /* this flush_color is finished, advance by one */
2577 wq->flush_color = work_next_color(wq->flush_color);
2578
2579 /* one color has been freed, handle overflow queue */
2580 if (!list_empty(&wq->flusher_overflow)) {
2581 /*
2582 * Assign the same color to all overflowed
2583 * flushers, advance work_color and append to
2584 * flusher_queue. This is the start-to-wait
2585 * phase for these overflowed flushers.
2586 */
2587 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2588 tmp->flush_color = wq->work_color;
2589
2590 wq->work_color = work_next_color(wq->work_color);
2591
2592 list_splice_tail_init(&wq->flusher_overflow,
2593 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002594 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002595 }
2596
2597 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002598 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002599 break;
2600 }
2601
2602 /*
2603 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002604 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002605 */
Tejun Heo6183c002013-03-12 11:29:57 -07002606 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2607 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002608
2609 list_del_init(&next->list);
2610 wq->first_flusher = next;
2611
Tejun Heo112202d2013-02-13 19:29:12 -08002612 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002613 break;
2614
2615 /*
2616 * Meh... this color is already done, clear first
2617 * flusher and repeat cascading.
2618 */
2619 wq->first_flusher = NULL;
2620 }
2621
2622out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002623 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002625EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002627/**
2628 * drain_workqueue - drain a workqueue
2629 * @wq: workqueue to drain
2630 *
2631 * Wait until the workqueue becomes empty. While draining is in progress,
2632 * only chain queueing is allowed. IOW, only currently pending or running
2633 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002634 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002635 * by the depth of chaining and should be relatively short. Whine if it
2636 * takes too long.
2637 */
2638void drain_workqueue(struct workqueue_struct *wq)
2639{
2640 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002641 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002642
2643 /*
2644 * __queue_work() needs to test whether there are drainers, is much
2645 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002646 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002647 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002648 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002649 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002650 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002651 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002652reflush:
2653 flush_workqueue(wq);
2654
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002655 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002656
Tejun Heo49e3cf42013-03-12 11:29:58 -07002657 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002658 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002659
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002660 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002661 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002662 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002663
2664 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002665 continue;
2666
2667 if (++flush_cnt == 10 ||
2668 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002669 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002670 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002671
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002672 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002673 goto reflush;
2674 }
2675
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002676 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002677 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002678 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002679}
2680EXPORT_SYMBOL_GPL(drain_workqueue);
2681
Tejun Heo606a5022012-08-20 14:51:23 -07002682static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002683{
2684 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002685 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002686 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002687
2688 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002689
Tejun Heofa1b54e2013-03-12 11:30:00 -07002690 local_irq_disable();
2691 pool = get_work_pool(work);
2692 if (!pool) {
2693 local_irq_enable();
2694 return false;
2695 }
2696
2697 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002698 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002699 pwq = get_work_pwq(work);
2700 if (pwq) {
2701 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002702 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002703 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002704 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002705 if (!worker)
2706 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002707 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002708 }
Tejun Heobaf59022010-09-16 10:42:16 +02002709
Tejun Heo112202d2013-02-13 19:29:12 -08002710 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002711 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002712
Tejun Heoe1594892011-01-09 23:32:15 +01002713 /*
2714 * If @max_active is 1 or rescuer is in use, flushing another work
2715 * item on the same workqueue may lead to deadlock. Make sure the
2716 * flusher is not running on the same workqueue by verifying write
2717 * access.
2718 */
Tejun Heo493008a2013-03-12 11:30:03 -07002719 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002720 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002721 else
Tejun Heo112202d2013-02-13 19:29:12 -08002722 lock_map_acquire_read(&pwq->wq->lockdep_map);
2723 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002724
Tejun Heobaf59022010-09-16 10:42:16 +02002725 return true;
2726already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002727 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002728 return false;
2729}
2730
Oleg Nesterovdb700892008-07-25 01:47:49 -07002731/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002732 * flush_work - wait for a work to finish executing the last queueing instance
2733 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002734 *
Tejun Heo606a5022012-08-20 14:51:23 -07002735 * Wait until @work has finished execution. @work is guaranteed to be idle
2736 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002737 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002738 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002739 * %true if flush_work() waited for the work to finish execution,
2740 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002741 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002742bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002743{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002744 struct wq_barrier barr;
2745
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002746 lock_map_acquire(&work->lockdep_map);
2747 lock_map_release(&work->lockdep_map);
2748
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002749 if (start_flush_work(work, &barr)) {
2750 wait_for_completion(&barr.done);
2751 destroy_work_on_stack(&barr.work);
2752 return true;
2753 } else {
2754 return false;
2755 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002756}
2757EXPORT_SYMBOL_GPL(flush_work);
2758
Tejun Heo8603e1b32015-03-05 08:04:13 -05002759struct cwt_wait {
2760 wait_queue_t wait;
2761 struct work_struct *work;
2762};
2763
2764static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2765{
2766 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2767
2768 if (cwait->work != key)
2769 return 0;
2770 return autoremove_wake_function(wait, mode, sync, key);
2771}
2772
Tejun Heo36e227d2012-08-03 10:30:46 -07002773static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002774{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002775 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002776 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002777 int ret;
2778
2779 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002780 ret = try_to_grab_pending(work, is_dwork, &flags);
2781 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002782 * If someone else is already canceling, wait for it to
2783 * finish. flush_work() doesn't work for PREEMPT_NONE
2784 * because we may get scheduled between @work's completion
2785 * and the other canceling task resuming and clearing
2786 * CANCELING - flush_work() will return false immediately
2787 * as @work is no longer busy, try_to_grab_pending() will
2788 * return -ENOENT as @work is still being canceled and the
2789 * other canceling task won't be able to clear CANCELING as
2790 * we're hogging the CPU.
2791 *
2792 * Let's wait for completion using a waitqueue. As this
2793 * may lead to the thundering herd problem, use a custom
2794 * wake function which matches @work along with exclusive
2795 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002796 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002797 if (unlikely(ret == -ENOENT)) {
2798 struct cwt_wait cwait;
2799
2800 init_wait(&cwait.wait);
2801 cwait.wait.func = cwt_wakefn;
2802 cwait.work = work;
2803
2804 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2805 TASK_UNINTERRUPTIBLE);
2806 if (work_is_canceling(work))
2807 schedule();
2808 finish_wait(&cancel_waitq, &cwait.wait);
2809 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002810 } while (unlikely(ret < 0));
2811
Tejun Heobbb68df2012-08-03 10:30:46 -07002812 /* tell other tasks trying to grab @work to back off */
2813 mark_work_canceling(work);
2814 local_irq_restore(flags);
2815
Tejun Heo606a5022012-08-20 14:51:23 -07002816 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002817 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002818
2819 /*
2820 * Paired with prepare_to_wait() above so that either
2821 * waitqueue_active() is visible here or !work_is_canceling() is
2822 * visible there.
2823 */
2824 smp_mb();
2825 if (waitqueue_active(&cancel_waitq))
2826 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2827
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002828 return ret;
2829}
2830
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002831/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002832 * cancel_work_sync - cancel a work and wait for it to finish
2833 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002834 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002835 * Cancel @work and wait for its execution to finish. This function
2836 * can be used even if the work re-queues itself or migrates to
2837 * another workqueue. On return from this function, @work is
2838 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002839 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002840 * cancel_work_sync(&delayed_work->work) must not be used for
2841 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002842 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002843 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002844 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002845 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002846 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002847 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002848 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002849bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002850{
Tejun Heo36e227d2012-08-03 10:30:46 -07002851 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002852}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002853EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002854
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002855/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002856 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2857 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002858 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002859 * Delayed timer is cancelled and the pending work is queued for
2860 * immediate execution. Like flush_work(), this function only
2861 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002862 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002863 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002864 * %true if flush_work() waited for the work to finish execution,
2865 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002866 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002867bool flush_delayed_work(struct delayed_work *dwork)
2868{
Tejun Heo8930cab2012-08-03 10:30:45 -07002869 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002870 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002871 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002872 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002873 return flush_work(&dwork->work);
2874}
2875EXPORT_SYMBOL(flush_delayed_work);
2876
2877/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002878 * cancel_delayed_work - cancel a delayed work
2879 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002880 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002881 * Kill off a pending delayed_work.
2882 *
2883 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2884 * pending.
2885 *
2886 * Note:
2887 * The work callback function may still be running on return, unless
2888 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2889 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002890 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002891 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002892 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002893bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002894{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002895 unsigned long flags;
2896 int ret;
2897
2898 do {
2899 ret = try_to_grab_pending(&dwork->work, true, &flags);
2900 } while (unlikely(ret == -EAGAIN));
2901
2902 if (unlikely(ret < 0))
2903 return false;
2904
Tejun Heo7c3eed52013-01-24 11:01:33 -08002905 set_work_pool_and_clear_pending(&dwork->work,
2906 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002907 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002908 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002909}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002910EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002911
2912/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002913 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2914 * @dwork: the delayed work cancel
2915 *
2916 * This is cancel_work_sync() for delayed works.
2917 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002918 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002919 * %true if @dwork was pending, %false otherwise.
2920 */
2921bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002922{
Tejun Heo36e227d2012-08-03 10:30:46 -07002923 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002924}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002925EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002926
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002927/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002928 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002929 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002930 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002931 * schedule_on_each_cpu() executes @func on each online CPU using the
2932 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002933 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002934 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002935 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02002936 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002937 */
David Howells65f27f32006-11-22 14:55:48 +00002938int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002939{
2940 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002941 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002942
Andrew Mortonb6136772006-06-25 05:47:49 -07002943 works = alloc_percpu(struct work_struct);
2944 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002945 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002946
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002947 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002948
Christoph Lameter15316ba2006-01-08 01:00:43 -08002949 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002950 struct work_struct *work = per_cpu_ptr(works, cpu);
2951
2952 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002953 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002954 }
Tejun Heo93981802009-11-17 14:06:20 -08002955
2956 for_each_online_cpu(cpu)
2957 flush_work(per_cpu_ptr(works, cpu));
2958
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002959 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002960 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002961 return 0;
2962}
2963
Alan Sterneef6a7d2010-02-12 17:39:21 +09002964/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002965 * execute_in_process_context - reliably execute the routine with user context
2966 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002967 * @ew: guaranteed storage for the execute work structure (must
2968 * be available when the work executes)
2969 *
2970 * Executes the function immediately if process context is available,
2971 * otherwise schedules the function for delayed execution.
2972 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002973 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06002974 * 1 - function was scheduled for execution
2975 */
David Howells65f27f32006-11-22 14:55:48 +00002976int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06002977{
2978 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00002979 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002980 return 0;
2981 }
2982
David Howells65f27f32006-11-22 14:55:48 +00002983 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002984 schedule_work(&ew->work);
2985
2986 return 1;
2987}
2988EXPORT_SYMBOL_GPL(execute_in_process_context);
2989
Tejun Heo7a4e3442013-03-12 11:30:00 -07002990/**
2991 * free_workqueue_attrs - free a workqueue_attrs
2992 * @attrs: workqueue_attrs to free
2993 *
2994 * Undo alloc_workqueue_attrs().
2995 */
2996void free_workqueue_attrs(struct workqueue_attrs *attrs)
2997{
2998 if (attrs) {
2999 free_cpumask_var(attrs->cpumask);
3000 kfree(attrs);
3001 }
3002}
3003
3004/**
3005 * alloc_workqueue_attrs - allocate a workqueue_attrs
3006 * @gfp_mask: allocation mask to use
3007 *
3008 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003009 * return it.
3010 *
3011 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003012 */
3013struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3014{
3015 struct workqueue_attrs *attrs;
3016
3017 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3018 if (!attrs)
3019 goto fail;
3020 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3021 goto fail;
3022
Tejun Heo13e2e552013-04-01 11:23:31 -07003023 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003024 return attrs;
3025fail:
3026 free_workqueue_attrs(attrs);
3027 return NULL;
3028}
3029
Tejun Heo29c91e92013-03-12 11:30:03 -07003030static void copy_workqueue_attrs(struct workqueue_attrs *to,
3031 const struct workqueue_attrs *from)
3032{
3033 to->nice = from->nice;
3034 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003035 /*
3036 * Unlike hash and equality test, this function doesn't ignore
3037 * ->no_numa as it is used for both pool and wq attrs. Instead,
3038 * get_unbound_pool() explicitly clears ->no_numa after copying.
3039 */
3040 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003041}
3042
Tejun Heo29c91e92013-03-12 11:30:03 -07003043/* hash value of the content of @attr */
3044static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3045{
3046 u32 hash = 0;
3047
3048 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003049 hash = jhash(cpumask_bits(attrs->cpumask),
3050 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003051 return hash;
3052}
3053
3054/* content equality test */
3055static bool wqattrs_equal(const struct workqueue_attrs *a,
3056 const struct workqueue_attrs *b)
3057{
3058 if (a->nice != b->nice)
3059 return false;
3060 if (!cpumask_equal(a->cpumask, b->cpumask))
3061 return false;
3062 return true;
3063}
3064
Tejun Heo7a4e3442013-03-12 11:30:00 -07003065/**
3066 * init_worker_pool - initialize a newly zalloc'd worker_pool
3067 * @pool: worker_pool to initialize
3068 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303069 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003070 *
3071 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003072 * inside @pool proper are initialized and put_unbound_pool() can be called
3073 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003074 */
3075static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003076{
3077 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003078 pool->id = -1;
3079 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003080 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003081 pool->flags |= POOL_DISASSOCIATED;
3082 INIT_LIST_HEAD(&pool->worklist);
3083 INIT_LIST_HEAD(&pool->idle_list);
3084 hash_init(pool->busy_hash);
3085
3086 init_timer_deferrable(&pool->idle_timer);
3087 pool->idle_timer.function = idle_worker_timeout;
3088 pool->idle_timer.data = (unsigned long)pool;
3089
3090 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3091 (unsigned long)pool);
3092
3093 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003094 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003095 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003096
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003097 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003098 INIT_HLIST_NODE(&pool->hash_node);
3099 pool->refcnt = 1;
3100
3101 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003102 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3103 if (!pool->attrs)
3104 return -ENOMEM;
3105 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003106}
3107
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003108static void rcu_free_wq(struct rcu_head *rcu)
3109{
3110 struct workqueue_struct *wq =
3111 container_of(rcu, struct workqueue_struct, rcu);
3112
3113 if (!(wq->flags & WQ_UNBOUND))
3114 free_percpu(wq->cpu_pwqs);
3115 else
3116 free_workqueue_attrs(wq->unbound_attrs);
3117
3118 kfree(wq->rescuer);
3119 kfree(wq);
3120}
3121
Tejun Heo29c91e92013-03-12 11:30:03 -07003122static void rcu_free_pool(struct rcu_head *rcu)
3123{
3124 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3125
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003126 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003127 free_workqueue_attrs(pool->attrs);
3128 kfree(pool);
3129}
3130
3131/**
3132 * put_unbound_pool - put a worker_pool
3133 * @pool: worker_pool to put
3134 *
3135 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003136 * safe manner. get_unbound_pool() calls this function on its failure path
3137 * and this function should be able to release pools which went through,
3138 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003139 *
3140 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003141 */
3142static void put_unbound_pool(struct worker_pool *pool)
3143{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003144 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003145 struct worker *worker;
3146
Tejun Heoa892cac2013-04-01 11:23:32 -07003147 lockdep_assert_held(&wq_pool_mutex);
3148
3149 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003150 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003151
3152 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003153 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003154 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003155 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003156
3157 /* release id and unhash */
3158 if (pool->id >= 0)
3159 idr_remove(&worker_pool_idr, pool->id);
3160 hash_del(&pool->hash_node);
3161
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003162 /*
3163 * Become the manager and destroy all workers. Grabbing
3164 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003165 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003166 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003167 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003168
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003169 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003170 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003171 destroy_worker(worker);
3172 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003173 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003174
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003175 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003176 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003177 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003178 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003179
3180 if (pool->detach_completion)
3181 wait_for_completion(pool->detach_completion);
3182
Tejun Heo29c91e92013-03-12 11:30:03 -07003183 mutex_unlock(&pool->manager_arb);
3184
3185 /* shut down the timers */
3186 del_timer_sync(&pool->idle_timer);
3187 del_timer_sync(&pool->mayday_timer);
3188
3189 /* sched-RCU protected to allow dereferences from get_work_pool() */
3190 call_rcu_sched(&pool->rcu, rcu_free_pool);
3191}
3192
3193/**
3194 * get_unbound_pool - get a worker_pool with the specified attributes
3195 * @attrs: the attributes of the worker_pool to get
3196 *
3197 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3198 * reference count and return it. If there already is a matching
3199 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003200 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003201 *
3202 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003203 *
3204 * Return: On success, a worker_pool with the same attributes as @attrs.
3205 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003206 */
3207static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3208{
Tejun Heo29c91e92013-03-12 11:30:03 -07003209 u32 hash = wqattrs_hash(attrs);
3210 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003211 int node;
Xunlei Pange2273582015-10-09 11:53:12 +08003212 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003213
Tejun Heoa892cac2013-04-01 11:23:32 -07003214 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003215
3216 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003217 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3218 if (wqattrs_equal(pool->attrs, attrs)) {
3219 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003220 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003221 }
3222 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003223
Xunlei Pange2273582015-10-09 11:53:12 +08003224 /* if cpumask is contained inside a NUMA node, we belong to that node */
3225 if (wq_numa_enabled) {
3226 for_each_node(node) {
3227 if (cpumask_subset(attrs->cpumask,
3228 wq_numa_possible_cpumask[node])) {
3229 target_node = node;
3230 break;
3231 }
3232 }
3233 }
3234
Tejun Heo29c91e92013-03-12 11:30:03 -07003235 /* nope, create a new one */
Xunlei Pange2273582015-10-09 11:53:12 +08003236 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003237 if (!pool || init_worker_pool(pool) < 0)
3238 goto fail;
3239
Tejun Heo8864b4e2013-03-12 11:30:04 -07003240 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003241 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange2273582015-10-09 11:53:12 +08003242 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003243
Shaohua Li2865a8f2013-08-01 09:56:36 +08003244 /*
3245 * no_numa isn't a worker_pool attribute, always clear it. See
3246 * 'struct workqueue_attrs' comments for detail.
3247 */
3248 pool->attrs->no_numa = false;
3249
Tejun Heo29c91e92013-03-12 11:30:03 -07003250 if (worker_pool_assign_id(pool) < 0)
3251 goto fail;
3252
3253 /* create and start the initial worker */
Lai Jiangshan051e1852014-07-22 13:03:02 +08003254 if (!create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003255 goto fail;
3256
Tejun Heo29c91e92013-03-12 11:30:03 -07003257 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003258 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003259
Tejun Heo29c91e92013-03-12 11:30:03 -07003260 return pool;
3261fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003262 if (pool)
3263 put_unbound_pool(pool);
3264 return NULL;
3265}
3266
Tejun Heo8864b4e2013-03-12 11:30:04 -07003267static void rcu_free_pwq(struct rcu_head *rcu)
3268{
3269 kmem_cache_free(pwq_cache,
3270 container_of(rcu, struct pool_workqueue, rcu));
3271}
3272
3273/*
3274 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3275 * and needs to be destroyed.
3276 */
3277static void pwq_unbound_release_workfn(struct work_struct *work)
3278{
3279 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3280 unbound_release_work);
3281 struct workqueue_struct *wq = pwq->wq;
3282 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003283 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003284
3285 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3286 return;
3287
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003288 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003289 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003290 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003291 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003292
Tejun Heoa892cac2013-04-01 11:23:32 -07003293 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003294 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003295 mutex_unlock(&wq_pool_mutex);
3296
Tejun Heo8864b4e2013-03-12 11:30:04 -07003297 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3298
3299 /*
3300 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003301 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003302 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003303 if (is_last)
3304 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003305}
3306
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003307/**
Tejun Heo699ce092013-03-13 16:51:35 -07003308 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003309 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003310 *
Tejun Heo699ce092013-03-13 16:51:35 -07003311 * If @pwq isn't freezing, set @pwq->max_active to the associated
3312 * workqueue's saved_max_active and activate delayed work items
3313 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003314 */
Tejun Heo699ce092013-03-13 16:51:35 -07003315static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003316{
Tejun Heo699ce092013-03-13 16:51:35 -07003317 struct workqueue_struct *wq = pwq->wq;
3318 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003319
Tejun Heo699ce092013-03-13 16:51:35 -07003320 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003321 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003322
3323 /* fast exit for non-freezable wqs */
3324 if (!freezable && pwq->max_active == wq->saved_max_active)
3325 return;
3326
Lai Jiangshana357fc02013-03-25 16:57:19 -07003327 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003328
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003329 /*
3330 * During [un]freezing, the caller is responsible for ensuring that
3331 * this function is called at least once after @workqueue_freezing
3332 * is updated and visible.
3333 */
3334 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003335 pwq->max_active = wq->saved_max_active;
3336
3337 while (!list_empty(&pwq->delayed_works) &&
3338 pwq->nr_active < pwq->max_active)
3339 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003340
3341 /*
3342 * Need to kick a worker after thawed or an unbound wq's
3343 * max_active is bumped. It's a slow path. Do it always.
3344 */
3345 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003346 } else {
3347 pwq->max_active = 0;
3348 }
3349
Lai Jiangshana357fc02013-03-25 16:57:19 -07003350 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003351}
3352
Tejun Heoe50aba92013-04-01 11:23:35 -07003353/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003354static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3355 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003356{
3357 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3358
Tejun Heoe50aba92013-04-01 11:23:35 -07003359 memset(pwq, 0, sizeof(*pwq));
3360
Tejun Heod2c1d402013-03-12 11:30:04 -07003361 pwq->pool = pool;
3362 pwq->wq = wq;
3363 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003364 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003365 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003366 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003367 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003368 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003369}
Tejun Heod2c1d402013-03-12 11:30:04 -07003370
Tejun Heof147f292013-04-01 11:23:35 -07003371/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003372static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003373{
3374 struct workqueue_struct *wq = pwq->wq;
3375
3376 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003377
Tejun Heo1befcf32013-04-01 11:23:35 -07003378 /* may be called multiple times, ignore if already linked */
3379 if (!list_empty(&pwq->pwqs_node))
3380 return;
3381
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003382 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003383 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003384
3385 /* sync max_active to the current setting */
3386 pwq_adjust_max_active(pwq);
3387
3388 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003389 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003390}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003391
Tejun Heof147f292013-04-01 11:23:35 -07003392/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3393static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3394 const struct workqueue_attrs *attrs)
3395{
3396 struct worker_pool *pool;
3397 struct pool_workqueue *pwq;
3398
3399 lockdep_assert_held(&wq_pool_mutex);
3400
3401 pool = get_unbound_pool(attrs);
3402 if (!pool)
3403 return NULL;
3404
Tejun Heoe50aba92013-04-01 11:23:35 -07003405 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003406 if (!pwq) {
3407 put_unbound_pool(pool);
3408 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003409 }
Tejun Heo6029a912013-04-01 11:23:34 -07003410
Tejun Heof147f292013-04-01 11:23:35 -07003411 init_pwq(pwq, wq, pool);
3412 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003413}
3414
Tejun Heo4c16bd32013-04-01 11:23:36 -07003415/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003416 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003417 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003418 * @node: the target NUMA node
3419 * @cpu_going_down: if >= 0, the CPU to consider as offline
3420 * @cpumask: outarg, the resulting cpumask
3421 *
3422 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3423 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003424 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003425 *
3426 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3427 * enabled and @node has online CPUs requested by @attrs, the returned
3428 * cpumask is the intersection of the possible CPUs of @node and
3429 * @attrs->cpumask.
3430 *
3431 * The caller is responsible for ensuring that the cpumask of @node stays
3432 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003433 *
3434 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3435 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003436 */
3437static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3438 int cpu_going_down, cpumask_t *cpumask)
3439{
Tejun Heod55262c2013-04-01 11:23:38 -07003440 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003441 goto use_dfl;
3442
3443 /* does @node have any online CPUs @attrs wants? */
3444 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3445 if (cpu_going_down >= 0)
3446 cpumask_clear_cpu(cpu_going_down, cpumask);
3447
3448 if (cpumask_empty(cpumask))
3449 goto use_dfl;
3450
3451 /* yeap, return possible CPUs in @node that @attrs wants */
3452 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3453 return !cpumask_equal(cpumask, attrs->cpumask);
3454
3455use_dfl:
3456 cpumask_copy(cpumask, attrs->cpumask);
3457 return false;
3458}
3459
Tejun Heo1befcf32013-04-01 11:23:35 -07003460/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3461static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3462 int node,
3463 struct pool_workqueue *pwq)
3464{
3465 struct pool_workqueue *old_pwq;
3466
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003467 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003468 lockdep_assert_held(&wq->mutex);
3469
3470 /* link_pwq() can handle duplicate calls */
3471 link_pwq(pwq);
3472
3473 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3474 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3475 return old_pwq;
3476}
3477
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003478/* context to store the prepared attrs & pwqs before applying */
3479struct apply_wqattrs_ctx {
3480 struct workqueue_struct *wq; /* target workqueue */
3481 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003482 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003483 struct pool_workqueue *dfl_pwq;
3484 struct pool_workqueue *pwq_tbl[];
3485};
3486
3487/* free the resources after success or abort */
3488static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3489{
3490 if (ctx) {
3491 int node;
3492
3493 for_each_node(node)
3494 put_pwq_unlocked(ctx->pwq_tbl[node]);
3495 put_pwq_unlocked(ctx->dfl_pwq);
3496
3497 free_workqueue_attrs(ctx->attrs);
3498
3499 kfree(ctx);
3500 }
3501}
3502
3503/* allocate the attrs and pwqs for later installation */
3504static struct apply_wqattrs_ctx *
3505apply_wqattrs_prepare(struct workqueue_struct *wq,
3506 const struct workqueue_attrs *attrs)
3507{
3508 struct apply_wqattrs_ctx *ctx;
3509 struct workqueue_attrs *new_attrs, *tmp_attrs;
3510 int node;
3511
3512 lockdep_assert_held(&wq_pool_mutex);
3513
3514 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3515 GFP_KERNEL);
3516
3517 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3518 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3519 if (!ctx || !new_attrs || !tmp_attrs)
3520 goto out_free;
3521
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003522 /*
3523 * Calculate the attrs of the default pwq.
3524 * If the user configured cpumask doesn't overlap with the
3525 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3526 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003527 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003528 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003529 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3530 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003531
3532 /*
3533 * We may create multiple pwqs with differing cpumasks. Make a
3534 * copy of @new_attrs which will be modified and used to obtain
3535 * pools.
3536 */
3537 copy_workqueue_attrs(tmp_attrs, new_attrs);
3538
3539 /*
3540 * If something goes wrong during CPU up/down, we'll fall back to
3541 * the default pwq covering whole @attrs->cpumask. Always create
3542 * it even if we don't use it immediately.
3543 */
3544 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3545 if (!ctx->dfl_pwq)
3546 goto out_free;
3547
3548 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003549 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003550 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3551 if (!ctx->pwq_tbl[node])
3552 goto out_free;
3553 } else {
3554 ctx->dfl_pwq->refcnt++;
3555 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3556 }
3557 }
3558
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003559 /* save the user configured attrs and sanitize it. */
3560 copy_workqueue_attrs(new_attrs, attrs);
3561 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003562 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003563
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003564 ctx->wq = wq;
3565 free_workqueue_attrs(tmp_attrs);
3566 return ctx;
3567
3568out_free:
3569 free_workqueue_attrs(tmp_attrs);
3570 free_workqueue_attrs(new_attrs);
3571 apply_wqattrs_cleanup(ctx);
3572 return NULL;
3573}
3574
3575/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3576static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3577{
3578 int node;
3579
3580 /* all pwqs have been created successfully, let's install'em */
3581 mutex_lock(&ctx->wq->mutex);
3582
3583 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3584
3585 /* save the previous pwq and install the new one */
3586 for_each_node(node)
3587 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3588 ctx->pwq_tbl[node]);
3589
3590 /* @dfl_pwq might not have been used, ensure it's linked */
3591 link_pwq(ctx->dfl_pwq);
3592 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3593
3594 mutex_unlock(&ctx->wq->mutex);
3595}
3596
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003597static void apply_wqattrs_lock(void)
3598{
3599 /* CPUs should stay stable across pwq creations and installations */
3600 get_online_cpus();
3601 mutex_lock(&wq_pool_mutex);
3602}
3603
3604static void apply_wqattrs_unlock(void)
3605{
3606 mutex_unlock(&wq_pool_mutex);
3607 put_online_cpus();
3608}
3609
3610static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3611 const struct workqueue_attrs *attrs)
3612{
3613 struct apply_wqattrs_ctx *ctx;
3614 int ret = -ENOMEM;
3615
3616 /* only unbound workqueues can change attributes */
3617 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3618 return -EINVAL;
3619
3620 /* creating multiple pwqs breaks ordering guarantee */
3621 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3622 return -EINVAL;
3623
3624 ctx = apply_wqattrs_prepare(wq, attrs);
3625
3626 /* the ctx has been prepared successfully, let's commit it */
3627 if (ctx) {
3628 apply_wqattrs_commit(ctx);
3629 ret = 0;
3630 }
3631
3632 apply_wqattrs_cleanup(ctx);
3633
3634 return ret;
3635}
3636
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003637/**
3638 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3639 * @wq: the target workqueue
3640 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3641 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003642 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3643 * machines, this function maps a separate pwq to each NUMA node with
3644 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3645 * NUMA node it was issued on. Older pwqs are released as in-flight work
3646 * items finish. Note that a work item which repeatedly requeues itself
3647 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003648 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003649 * Performs GFP_KERNEL allocations.
3650 *
3651 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003652 */
3653int apply_workqueue_attrs(struct workqueue_struct *wq,
3654 const struct workqueue_attrs *attrs)
3655{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003656 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003657
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003658 apply_wqattrs_lock();
3659 ret = apply_workqueue_attrs_locked(wq, attrs);
3660 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003661
Tejun Heo48621252013-04-01 11:23:31 -07003662 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003663}
3664
Tejun Heo4c16bd32013-04-01 11:23:36 -07003665/**
3666 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3667 * @wq: the target workqueue
3668 * @cpu: the CPU coming up or going down
3669 * @online: whether @cpu is coming up or going down
3670 *
3671 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3672 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3673 * @wq accordingly.
3674 *
3675 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3676 * falls back to @wq->dfl_pwq which may not be optimal but is always
3677 * correct.
3678 *
3679 * Note that when the last allowed CPU of a NUMA node goes offline for a
3680 * workqueue with a cpumask spanning multiple nodes, the workers which were
3681 * already executing the work items for the workqueue will lose their CPU
3682 * affinity and may execute on any CPU. This is similar to how per-cpu
3683 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3684 * affinity, it's the user's responsibility to flush the work item from
3685 * CPU_DOWN_PREPARE.
3686 */
3687static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3688 bool online)
3689{
3690 int node = cpu_to_node(cpu);
3691 int cpu_off = online ? -1 : cpu;
3692 struct pool_workqueue *old_pwq = NULL, *pwq;
3693 struct workqueue_attrs *target_attrs;
3694 cpumask_t *cpumask;
3695
3696 lockdep_assert_held(&wq_pool_mutex);
3697
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003698 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3699 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003700 return;
3701
3702 /*
3703 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3704 * Let's use a preallocated one. The following buf is protected by
3705 * CPU hotplug exclusion.
3706 */
3707 target_attrs = wq_update_unbound_numa_attrs_buf;
3708 cpumask = target_attrs->cpumask;
3709
Tejun Heo4c16bd32013-04-01 11:23:36 -07003710 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3711 pwq = unbound_pwq_by_node(wq, node);
3712
3713 /*
3714 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003715 * different from the default pwq's, we need to compare it to @pwq's
3716 * and create a new one if they don't match. If the target cpumask
3717 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003718 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003719 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003720 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003721 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003722 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003723 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003724 }
3725
Tejun Heo4c16bd32013-04-01 11:23:36 -07003726 /* create a new pwq */
3727 pwq = alloc_unbound_pwq(wq, target_attrs);
3728 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003729 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3730 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003731 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003732 }
3733
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003734 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003735 mutex_lock(&wq->mutex);
3736 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3737 goto out_unlock;
3738
3739use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003740 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003741 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3742 get_pwq(wq->dfl_pwq);
3743 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3744 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3745out_unlock:
3746 mutex_unlock(&wq->mutex);
3747 put_pwq_unlocked(old_pwq);
3748}
3749
Tejun Heo30cdf242013-03-12 11:29:57 -07003750static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003751{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003752 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003753 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003754
Tejun Heo30cdf242013-03-12 11:29:57 -07003755 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003756 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3757 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003758 return -ENOMEM;
3759
3760 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003761 struct pool_workqueue *pwq =
3762 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003763 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003764 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003765
Tejun Heof147f292013-04-01 11:23:35 -07003766 init_pwq(pwq, wq, &cpu_pools[highpri]);
3767
3768 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003769 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003770 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003771 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003772 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003773 } else if (wq->flags & __WQ_ORDERED) {
3774 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3775 /* there should only be single pwq for ordering guarantee */
3776 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3777 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3778 "ordering guarantee broken for workqueue %s\n", wq->name);
3779 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003780 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003781 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003782 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003783}
3784
Tejun Heof3421792010-07-02 10:03:51 +02003785static int wq_clamp_max_active(int max_active, unsigned int flags,
3786 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003787{
Tejun Heof3421792010-07-02 10:03:51 +02003788 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3789
3790 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003791 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3792 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003793
Tejun Heof3421792010-07-02 10:03:51 +02003794 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003795}
3796
Tejun Heob196be82012-01-10 15:11:35 -08003797struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003798 unsigned int flags,
3799 int max_active,
3800 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003801 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003802{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003803 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003804 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003805 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003806 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003807
Viresh Kumarcee22a12013-04-08 16:45:40 +05303808 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3809 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3810 flags |= WQ_UNBOUND;
3811
Tejun Heoecf68812013-04-01 11:23:34 -07003812 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003813 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003814 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003815
3816 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003817 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003818 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003819
Tejun Heo6029a912013-04-01 11:23:34 -07003820 if (flags & WQ_UNBOUND) {
3821 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3822 if (!wq->unbound_attrs)
3823 goto err_free_wq;
3824 }
3825
Tejun Heoecf68812013-04-01 11:23:34 -07003826 va_start(args, lock_name);
3827 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003828 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003829
Tejun Heod320c032010-06-29 10:07:14 +02003830 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003831 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003832
Tejun Heob196be82012-01-10 15:11:35 -08003833 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003834 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003835 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003836 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003837 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003838 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003839 INIT_LIST_HEAD(&wq->flusher_queue);
3840 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003841 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003842
Johannes Bergeb13ba82008-01-16 09:51:58 +01003843 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003844 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003845
Tejun Heo30cdf242013-03-12 11:29:57 -07003846 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07003847 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003848
Tejun Heo493008a2013-03-12 11:30:03 -07003849 /*
3850 * Workqueues which may be used during memory reclaim should
3851 * have a rescuer to guarantee forward progress.
3852 */
3853 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003854 struct worker *rescuer;
3855
Lai Jiangshanf7537df2014-07-15 17:24:15 +08003856 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003857 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07003858 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02003859
Tejun Heo111c2252013-01-17 17:16:24 -08003860 rescuer->rescue_wq = wq;
3861 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003862 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07003863 if (IS_ERR(rescuer->task)) {
3864 kfree(rescuer);
3865 goto err_destroy;
3866 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003867
Tejun Heod2c1d402013-03-12 11:30:04 -07003868 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02003869 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003870 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003871 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003872
Tejun Heo226223a2013-03-12 11:30:05 -07003873 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3874 goto err_destroy;
3875
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003876 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003877 * wq_pool_mutex protects global freeze state and workqueues list.
3878 * Grab it, adjust max_active and add the new @wq to workqueues
3879 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003880 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003881 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003882
Lai Jiangshana357fc02013-03-25 16:57:19 -07003883 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003884 for_each_pwq(pwq, wq)
3885 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07003886 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003887
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003888 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003889
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003890 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02003891
Oleg Nesterov3af244332007-05-09 02:34:09 -07003892 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003893
3894err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07003895 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07003896 kfree(wq);
3897 return NULL;
3898err_destroy:
3899 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003900 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003901}
Tejun Heod320c032010-06-29 10:07:14 +02003902EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003903
3904/**
3905 * destroy_workqueue - safely terminate a workqueue
3906 * @wq: target workqueue
3907 *
3908 * Safely destroy a workqueue. All work currently pending will be done first.
3909 */
3910void destroy_workqueue(struct workqueue_struct *wq)
3911{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003912 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003913 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003914
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003915 /* drain it before proceeding with destruction */
3916 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003917
Tejun Heo6183c002013-03-12 11:29:57 -07003918 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003919 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07003920 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07003921 int i;
3922
Tejun Heo76af4d92013-03-12 11:30:00 -07003923 for (i = 0; i < WORK_NR_COLORS; i++) {
3924 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003925 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003926 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003927 }
3928 }
3929
Lai Jiangshan5c529592013-04-04 10:05:38 +08003930 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07003931 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07003932 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003933 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003934 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003935 }
Tejun Heo6183c002013-03-12 11:29:57 -07003936 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003937 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003938
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003939 /*
3940 * wq list is used to freeze wq, remove from list after
3941 * flushing is complete in case freeze races us.
3942 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003943 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003944 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003945 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003946
Tejun Heo226223a2013-03-12 11:30:05 -07003947 workqueue_sysfs_unregister(wq);
3948
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003949 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02003950 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02003951
Tejun Heo8864b4e2013-03-12 11:30:04 -07003952 if (!(wq->flags & WQ_UNBOUND)) {
3953 /*
3954 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003955 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003956 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003957 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003958 } else {
3959 /*
3960 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07003961 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
3962 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003963 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003964 for_each_node(node) {
3965 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3966 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
3967 put_pwq_unlocked(pwq);
3968 }
3969
3970 /*
3971 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
3972 * put. Don't access it afterwards.
3973 */
3974 pwq = wq->dfl_pwq;
3975 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07003976 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07003977 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003978}
3979EXPORT_SYMBOL_GPL(destroy_workqueue);
3980
Tejun Heodcd989c2010-06-29 10:07:14 +02003981/**
3982 * workqueue_set_max_active - adjust max_active of a workqueue
3983 * @wq: target workqueue
3984 * @max_active: new max_active value.
3985 *
3986 * Set max_active of @wq to @max_active.
3987 *
3988 * CONTEXT:
3989 * Don't call from IRQ context.
3990 */
3991void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3992{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003993 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02003994
Tejun Heo8719dce2013-03-12 11:30:04 -07003995 /* disallow meddling with max_active for ordered workqueues */
3996 if (WARN_ON(wq->flags & __WQ_ORDERED))
3997 return;
3998
Tejun Heof3421792010-07-02 10:03:51 +02003999 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004000
Lai Jiangshana357fc02013-03-25 16:57:19 -07004001 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004002
4003 wq->saved_max_active = max_active;
4004
Tejun Heo699ce092013-03-13 16:51:35 -07004005 for_each_pwq(pwq, wq)
4006 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004007
Lai Jiangshana357fc02013-03-25 16:57:19 -07004008 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004009}
4010EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4011
4012/**
Tejun Heoe6267612013-03-12 17:41:37 -07004013 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4014 *
4015 * Determine whether %current is a workqueue rescuer. Can be used from
4016 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004017 *
4018 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe6267612013-03-12 17:41:37 -07004019 */
4020bool current_is_workqueue_rescuer(void)
4021{
4022 struct worker *worker = current_wq_worker();
4023
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004024 return worker && worker->rescue_wq;
Tejun Heoe6267612013-03-12 17:41:37 -07004025}
4026
4027/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004028 * workqueue_congested - test whether a workqueue is congested
4029 * @cpu: CPU in question
4030 * @wq: target workqueue
4031 *
4032 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4033 * no synchronization around this function and the test result is
4034 * unreliable and only useful as advisory hints or for debugging.
4035 *
Tejun Heod3251852013-05-10 11:10:17 -07004036 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4037 * Note that both per-cpu and unbound workqueues may be associated with
4038 * multiple pool_workqueues which have separate congested states. A
4039 * workqueue being congested on one CPU doesn't mean the workqueue is also
4040 * contested on other CPUs / NUMA nodes.
4041 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004042 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004043 * %true if congested, %false otherwise.
4044 */
Tejun Heod84ff052013-03-12 11:29:59 -07004045bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004046{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004047 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004048 bool ret;
4049
Lai Jiangshan88109452013-03-20 03:28:10 +08004050 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004051
Tejun Heod3251852013-05-10 11:10:17 -07004052 if (cpu == WORK_CPU_UNBOUND)
4053 cpu = smp_processor_id();
4054
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004055 if (!(wq->flags & WQ_UNBOUND))
4056 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4057 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004058 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004059
Tejun Heo76af4d92013-03-12 11:30:00 -07004060 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004061 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004062
4063 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004064}
4065EXPORT_SYMBOL_GPL(workqueue_congested);
4066
4067/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004068 * work_busy - test whether a work is currently pending or running
4069 * @work: the work to be tested
4070 *
4071 * Test whether @work is currently pending or running. There is no
4072 * synchronization around this function and the test result is
4073 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004074 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004075 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004076 * OR'd bitmask of WORK_BUSY_* bits.
4077 */
4078unsigned int work_busy(struct work_struct *work)
4079{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004080 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004081 unsigned long flags;
4082 unsigned int ret = 0;
4083
Tejun Heodcd989c2010-06-29 10:07:14 +02004084 if (work_pending(work))
4085 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004086
Tejun Heofa1b54e2013-03-12 11:30:00 -07004087 local_irq_save(flags);
4088 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004089 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004090 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004091 if (find_worker_executing_work(pool, work))
4092 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004093 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004094 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004095 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004096
4097 return ret;
4098}
4099EXPORT_SYMBOL_GPL(work_busy);
4100
Tejun Heo3d1cb202013-04-30 15:27:22 -07004101/**
4102 * set_worker_desc - set description for the current work item
4103 * @fmt: printf-style format string
4104 * @...: arguments for the format string
4105 *
4106 * This function can be called by a running work function to describe what
4107 * the work item is about. If the worker task gets dumped, this
4108 * information will be printed out together to help debugging. The
4109 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4110 */
4111void set_worker_desc(const char *fmt, ...)
4112{
4113 struct worker *worker = current_wq_worker();
4114 va_list args;
4115
4116 if (worker) {
4117 va_start(args, fmt);
4118 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4119 va_end(args);
4120 worker->desc_valid = true;
4121 }
4122}
4123
4124/**
4125 * print_worker_info - print out worker information and description
4126 * @log_lvl: the log level to use when printing
4127 * @task: target task
4128 *
4129 * If @task is a worker and currently executing a work item, print out the
4130 * name of the workqueue being serviced and worker description set with
4131 * set_worker_desc() by the currently executing work item.
4132 *
4133 * This function can be safely called on any task as long as the
4134 * task_struct itself is accessible. While safe, this function isn't
4135 * synchronized and may print out mixups or garbages of limited length.
4136 */
4137void print_worker_info(const char *log_lvl, struct task_struct *task)
4138{
4139 work_func_t *fn = NULL;
4140 char name[WQ_NAME_LEN] = { };
4141 char desc[WORKER_DESC_LEN] = { };
4142 struct pool_workqueue *pwq = NULL;
4143 struct workqueue_struct *wq = NULL;
4144 bool desc_valid = false;
4145 struct worker *worker;
4146
4147 if (!(task->flags & PF_WQ_WORKER))
4148 return;
4149
4150 /*
4151 * This function is called without any synchronization and @task
4152 * could be in any state. Be careful with dereferences.
4153 */
4154 worker = probe_kthread_data(task);
4155
4156 /*
4157 * Carefully copy the associated workqueue's workfn and name. Keep
4158 * the original last '\0' in case the original contains garbage.
4159 */
4160 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4161 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4162 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4163 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4164
4165 /* copy worker description */
4166 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4167 if (desc_valid)
4168 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4169
4170 if (fn || name[0] || desc[0]) {
4171 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4172 if (desc[0])
4173 pr_cont(" (%s)", desc);
4174 pr_cont("\n");
4175 }
4176}
4177
Tejun Heo3494fc32015-03-09 09:22:28 -04004178static void pr_cont_pool_info(struct worker_pool *pool)
4179{
4180 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4181 if (pool->node != NUMA_NO_NODE)
4182 pr_cont(" node=%d", pool->node);
4183 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4184}
4185
4186static void pr_cont_work(bool comma, struct work_struct *work)
4187{
4188 if (work->func == wq_barrier_func) {
4189 struct wq_barrier *barr;
4190
4191 barr = container_of(work, struct wq_barrier, work);
4192
4193 pr_cont("%s BAR(%d)", comma ? "," : "",
4194 task_pid_nr(barr->task));
4195 } else {
4196 pr_cont("%s %pf", comma ? "," : "", work->func);
4197 }
4198}
4199
4200static void show_pwq(struct pool_workqueue *pwq)
4201{
4202 struct worker_pool *pool = pwq->pool;
4203 struct work_struct *work;
4204 struct worker *worker;
4205 bool has_in_flight = false, has_pending = false;
4206 int bkt;
4207
4208 pr_info(" pwq %d:", pool->id);
4209 pr_cont_pool_info(pool);
4210
4211 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4212 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4213
4214 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4215 if (worker->current_pwq == pwq) {
4216 has_in_flight = true;
4217 break;
4218 }
4219 }
4220 if (has_in_flight) {
4221 bool comma = false;
4222
4223 pr_info(" in-flight:");
4224 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4225 if (worker->current_pwq != pwq)
4226 continue;
4227
4228 pr_cont("%s %d%s:%pf", comma ? "," : "",
4229 task_pid_nr(worker->task),
4230 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4231 worker->current_func);
4232 list_for_each_entry(work, &worker->scheduled, entry)
4233 pr_cont_work(false, work);
4234 comma = true;
4235 }
4236 pr_cont("\n");
4237 }
4238
4239 list_for_each_entry(work, &pool->worklist, entry) {
4240 if (get_work_pwq(work) == pwq) {
4241 has_pending = true;
4242 break;
4243 }
4244 }
4245 if (has_pending) {
4246 bool comma = false;
4247
4248 pr_info(" pending:");
4249 list_for_each_entry(work, &pool->worklist, entry) {
4250 if (get_work_pwq(work) != pwq)
4251 continue;
4252
4253 pr_cont_work(comma, work);
4254 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4255 }
4256 pr_cont("\n");
4257 }
4258
4259 if (!list_empty(&pwq->delayed_works)) {
4260 bool comma = false;
4261
4262 pr_info(" delayed:");
4263 list_for_each_entry(work, &pwq->delayed_works, entry) {
4264 pr_cont_work(comma, work);
4265 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4266 }
4267 pr_cont("\n");
4268 }
4269}
4270
4271/**
4272 * show_workqueue_state - dump workqueue state
4273 *
4274 * Called from a sysrq handler and prints out all busy workqueues and
4275 * pools.
4276 */
4277void show_workqueue_state(void)
4278{
4279 struct workqueue_struct *wq;
4280 struct worker_pool *pool;
4281 unsigned long flags;
4282 int pi;
4283
4284 rcu_read_lock_sched();
4285
4286 pr_info("Showing busy workqueues and worker pools:\n");
4287
4288 list_for_each_entry_rcu(wq, &workqueues, list) {
4289 struct pool_workqueue *pwq;
4290 bool idle = true;
4291
4292 for_each_pwq(pwq, wq) {
4293 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4294 idle = false;
4295 break;
4296 }
4297 }
4298 if (idle)
4299 continue;
4300
4301 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4302
4303 for_each_pwq(pwq, wq) {
4304 spin_lock_irqsave(&pwq->pool->lock, flags);
4305 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4306 show_pwq(pwq);
4307 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4308 }
4309 }
4310
4311 for_each_pool(pool, pi) {
4312 struct worker *worker;
4313 bool first = true;
4314
4315 spin_lock_irqsave(&pool->lock, flags);
4316 if (pool->nr_workers == pool->nr_idle)
4317 goto next_pool;
4318
4319 pr_info("pool %d:", pool->id);
4320 pr_cont_pool_info(pool);
4321 pr_cont(" workers=%d", pool->nr_workers);
4322 if (pool->manager)
4323 pr_cont(" manager: %d",
4324 task_pid_nr(pool->manager->task));
4325 list_for_each_entry(worker, &pool->idle_list, entry) {
4326 pr_cont(" %s%d", first ? "idle: " : "",
4327 task_pid_nr(worker->task));
4328 first = false;
4329 }
4330 pr_cont("\n");
4331 next_pool:
4332 spin_unlock_irqrestore(&pool->lock, flags);
4333 }
4334
4335 rcu_read_unlock_sched();
4336}
4337
Tejun Heodb7bccf2010-06-29 10:07:12 +02004338/*
4339 * CPU hotplug.
4340 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004341 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004342 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004343 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004344 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004345 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004346 * blocked draining impractical.
4347 *
Tejun Heo24647572013-01-24 11:01:33 -08004348 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004349 * running as an unbound one and allowing it to be reattached later if the
4350 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004351 */
4352
Tejun Heo706026c2013-01-24 11:01:34 -08004353static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004354{
Tejun Heo38db41d2013-01-24 11:01:34 -08004355 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004356 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004357 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004358
Tejun Heof02ae732013-03-12 11:30:03 -07004359 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004360 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004361 spin_lock_irq(&pool->lock);
4362
4363 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004364 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004365 * unbound and set DISASSOCIATED. Before this, all workers
4366 * except for the ones which are still executing works from
4367 * before the last CPU down must be on the cpu. After
4368 * this, they may become diasporas.
4369 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004370 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004371 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004372
Tejun Heo24647572013-01-24 11:01:33 -08004373 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004374
Tejun Heo94cf58b2013-01-24 11:01:33 -08004375 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004376 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004377
Lai Jiangshaneb283422013-03-08 15:18:28 -08004378 /*
4379 * Call schedule() so that we cross rq->lock and thus can
4380 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4381 * This is necessary as scheduler callbacks may be invoked
4382 * from other cpus.
4383 */
4384 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004385
Lai Jiangshaneb283422013-03-08 15:18:28 -08004386 /*
4387 * Sched callbacks are disabled now. Zap nr_running.
4388 * After this, nr_running stays zero and need_more_worker()
4389 * and keep_working() are always true as long as the
4390 * worklist is not empty. This pool now behaves as an
4391 * unbound (in terms of concurrency management) pool which
4392 * are served by workers tied to the pool.
4393 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004394 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004395
4396 /*
4397 * With concurrency management just turned off, a busy
4398 * worker blocking could lead to lengthy stalls. Kick off
4399 * unbound chain execution of currently pending work items.
4400 */
4401 spin_lock_irq(&pool->lock);
4402 wake_up_worker(pool);
4403 spin_unlock_irq(&pool->lock);
4404 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004405}
4406
Tejun Heobd7c0892013-03-19 13:45:21 -07004407/**
4408 * rebind_workers - rebind all workers of a pool to the associated CPU
4409 * @pool: pool of interest
4410 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004411 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004412 */
4413static void rebind_workers(struct worker_pool *pool)
4414{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004415 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004416
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004417 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004418
Tejun Heoa9ab7752013-03-19 13:45:21 -07004419 /*
4420 * Restore CPU affinity of all workers. As all idle workers should
4421 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304422 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004423 * of all workers first and then clear UNBOUND. As we're called
4424 * from CPU_ONLINE, the following shouldn't fail.
4425 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004426 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004427 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4428 pool->attrs->cpumask) < 0);
4429
4430 spin_lock_irq(&pool->lock);
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004431 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004432
Lai Jiangshanda028462014-05-20 17:46:31 +08004433 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004434 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004435
4436 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004437 * A bound idle worker should actually be on the runqueue
4438 * of the associated CPU for local wake-ups targeting it to
4439 * work. Kick all idle workers so that they migrate to the
4440 * associated CPU. Doing this in the same loop as
4441 * replacing UNBOUND with REBOUND is safe as no worker will
4442 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004443 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004444 if (worker_flags & WORKER_IDLE)
4445 wake_up_process(worker->task);
4446
4447 /*
4448 * We want to clear UNBOUND but can't directly call
4449 * worker_clr_flags() or adjust nr_running. Atomically
4450 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4451 * @worker will clear REBOUND using worker_clr_flags() when
4452 * it initiates the next execution cycle thus restoring
4453 * concurrency management. Note that when or whether
4454 * @worker clears REBOUND doesn't affect correctness.
4455 *
4456 * ACCESS_ONCE() is necessary because @worker->flags may be
4457 * tested without holding any lock in
4458 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4459 * fail incorrectly leading to premature concurrency
4460 * management operations.
4461 */
4462 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4463 worker_flags |= WORKER_REBOUND;
4464 worker_flags &= ~WORKER_UNBOUND;
4465 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004466 }
4467
Tejun Heoa9ab7752013-03-19 13:45:21 -07004468 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004469}
4470
Tejun Heo7dbc7252013-03-19 13:45:21 -07004471/**
4472 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4473 * @pool: unbound pool of interest
4474 * @cpu: the CPU which is coming up
4475 *
4476 * An unbound pool may end up with a cpumask which doesn't have any online
4477 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4478 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4479 * online CPU before, cpus_allowed of all its workers should be restored.
4480 */
4481static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4482{
4483 static cpumask_t cpumask;
4484 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004485
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004486 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004487
4488 /* is @cpu allowed for @pool? */
4489 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4490 return;
4491
4492 /* is @cpu the only online CPU? */
4493 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4494 if (cpumask_weight(&cpumask) != 1)
4495 return;
4496
4497 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004498 for_each_pool_worker(worker, pool)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004499 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4500 pool->attrs->cpumask) < 0);
4501}
4502
Tejun Heo8db25e72012-07-17 12:39:28 -07004503/*
4504 * Workqueues should be brought up before normal priority CPU notifiers.
4505 * This will be registered high priority CPU notifier.
4506 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004507static int workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004508 unsigned long action,
4509 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004510{
Tejun Heod84ff052013-03-12 11:29:59 -07004511 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004512 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004513 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004514 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004515
Tejun Heo8db25e72012-07-17 12:39:28 -07004516 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004517 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004518 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004519 if (pool->nr_workers)
4520 continue;
Lai Jiangshan051e1852014-07-22 13:03:02 +08004521 if (!create_worker(pool))
Tejun Heo3ce63372012-07-17 12:39:27 -07004522 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004523 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004524 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004525
Tejun Heo65758202012-07-17 12:39:26 -07004526 case CPU_DOWN_FAILED:
4527 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004528 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004529
4530 for_each_pool(pool, pi) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004531 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004532
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004533 if (pool->cpu == cpu)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004534 rebind_workers(pool);
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004535 else if (pool->cpu < 0)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004536 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004537
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004538 mutex_unlock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004539 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004540
Tejun Heo4c16bd32013-04-01 11:23:36 -07004541 /* update NUMA affinity of unbound workqueues */
4542 list_for_each_entry(wq, &workqueues, list)
4543 wq_update_unbound_numa(wq, cpu, true);
4544
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004545 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004546 break;
Tejun Heo65758202012-07-17 12:39:26 -07004547 }
4548 return NOTIFY_OK;
4549}
4550
4551/*
4552 * Workqueues should be brought down after normal priority CPU notifiers.
4553 * This will be registered as low priority CPU notifier.
4554 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004555static int workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004556 unsigned long action,
4557 void *hcpu)
4558{
Tejun Heod84ff052013-03-12 11:29:59 -07004559 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004560 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004561 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004562
Tejun Heo65758202012-07-17 12:39:26 -07004563 switch (action & ~CPU_TASKS_FROZEN) {
4564 case CPU_DOWN_PREPARE:
Tejun Heo4c16bd32013-04-01 11:23:36 -07004565 /* unbinding per-cpu workers should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004566 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004567 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004568
4569 /* update NUMA affinity of unbound workqueues */
4570 mutex_lock(&wq_pool_mutex);
4571 list_for_each_entry(wq, &workqueues, list)
4572 wq_update_unbound_numa(wq, cpu, false);
4573 mutex_unlock(&wq_pool_mutex);
4574
4575 /* wait for per-cpu unbinding to finish */
Tejun Heo8db25e72012-07-17 12:39:28 -07004576 flush_work(&unbind_work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004577 destroy_work_on_stack(&unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004578 break;
Tejun Heo65758202012-07-17 12:39:26 -07004579 }
4580 return NOTIFY_OK;
4581}
4582
Rusty Russell2d3854a2008-11-05 13:39:10 +11004583#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004584
Rusty Russell2d3854a2008-11-05 13:39:10 +11004585struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004586 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004587 long (*fn)(void *);
4588 void *arg;
4589 long ret;
4590};
4591
Tejun Heoed48ece2012-09-18 12:48:43 -07004592static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004593{
Tejun Heoed48ece2012-09-18 12:48:43 -07004594 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4595
Rusty Russell2d3854a2008-11-05 13:39:10 +11004596 wfc->ret = wfc->fn(wfc->arg);
4597}
4598
4599/**
4600 * work_on_cpu - run a function in user context on a particular cpu
4601 * @cpu: the cpu to run on
4602 * @fn: the function to run
4603 * @arg: the function arg
4604 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004605 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06004606 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004607 *
4608 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004609 */
Tejun Heod84ff052013-03-12 11:29:59 -07004610long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004611{
Tejun Heoed48ece2012-09-18 12:48:43 -07004612 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004613
Tejun Heoed48ece2012-09-18 12:48:43 -07004614 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4615 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004616 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004617 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004618 return wfc.ret;
4619}
4620EXPORT_SYMBOL_GPL(work_on_cpu);
4621#endif /* CONFIG_SMP */
4622
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004623#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304624
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004625/**
4626 * freeze_workqueues_begin - begin freezing workqueues
4627 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004628 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004629 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004630 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004631 *
4632 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004633 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004634 */
4635void freeze_workqueues_begin(void)
4636{
Tejun Heo24b8a842013-03-12 11:29:58 -07004637 struct workqueue_struct *wq;
4638 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004639
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004640 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004641
Tejun Heo6183c002013-03-12 11:29:57 -07004642 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004643 workqueue_freezing = true;
4644
Tejun Heo24b8a842013-03-12 11:29:58 -07004645 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004646 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004647 for_each_pwq(pwq, wq)
4648 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004649 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004650 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004651
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004652 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004653}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004654
4655/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004656 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004657 *
4658 * Check whether freezing is complete. This function must be called
4659 * between freeze_workqueues_begin() and thaw_workqueues().
4660 *
4661 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004662 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004663 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004664 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004665 * %true if some freezable workqueues are still busy. %false if freezing
4666 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004667 */
4668bool freeze_workqueues_busy(void)
4669{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004670 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004671 struct workqueue_struct *wq;
4672 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004673
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004674 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004675
Tejun Heo6183c002013-03-12 11:29:57 -07004676 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004677
Tejun Heo24b8a842013-03-12 11:29:58 -07004678 list_for_each_entry(wq, &workqueues, list) {
4679 if (!(wq->flags & WQ_FREEZABLE))
4680 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004681 /*
4682 * nr_active is monotonically decreasing. It's safe
4683 * to peek without lock.
4684 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004685 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004686 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004687 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004688 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004689 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004690 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004691 goto out_unlock;
4692 }
4693 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004694 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004695 }
4696out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004697 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004698 return busy;
4699}
4700
4701/**
4702 * thaw_workqueues - thaw workqueues
4703 *
4704 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004705 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004706 *
4707 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004708 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004709 */
4710void thaw_workqueues(void)
4711{
Tejun Heo24b8a842013-03-12 11:29:58 -07004712 struct workqueue_struct *wq;
4713 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004714
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004715 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004716
4717 if (!workqueue_freezing)
4718 goto out_unlock;
4719
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004720 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004721
Tejun Heo24b8a842013-03-12 11:29:58 -07004722 /* restore max_active and repopulate worklist */
4723 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004724 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004725 for_each_pwq(pwq, wq)
4726 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004727 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004728 }
4729
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004730out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004731 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004732}
4733#endif /* CONFIG_FREEZER */
4734
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004735static int workqueue_apply_unbound_cpumask(void)
4736{
4737 LIST_HEAD(ctxs);
4738 int ret = 0;
4739 struct workqueue_struct *wq;
4740 struct apply_wqattrs_ctx *ctx, *n;
4741
4742 lockdep_assert_held(&wq_pool_mutex);
4743
4744 list_for_each_entry(wq, &workqueues, list) {
4745 if (!(wq->flags & WQ_UNBOUND))
4746 continue;
4747 /* creating multiple pwqs breaks ordering guarantee */
4748 if (wq->flags & __WQ_ORDERED)
4749 continue;
4750
4751 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4752 if (!ctx) {
4753 ret = -ENOMEM;
4754 break;
4755 }
4756
4757 list_add_tail(&ctx->list, &ctxs);
4758 }
4759
4760 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4761 if (!ret)
4762 apply_wqattrs_commit(ctx);
4763 apply_wqattrs_cleanup(ctx);
4764 }
4765
4766 return ret;
4767}
4768
4769/**
4770 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4771 * @cpumask: the cpumask to set
4772 *
4773 * The low-level workqueues cpumask is a global cpumask that limits
4774 * the affinity of all unbound workqueues. This function check the @cpumask
4775 * and apply it to all unbound workqueues and updates all pwqs of them.
4776 *
4777 * Retun: 0 - Success
4778 * -EINVAL - Invalid @cpumask
4779 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4780 */
4781int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4782{
4783 int ret = -EINVAL;
4784 cpumask_var_t saved_cpumask;
4785
4786 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4787 return -ENOMEM;
4788
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004789 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4790 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004791 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004792
4793 /* save the old wq_unbound_cpumask. */
4794 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4795
4796 /* update wq_unbound_cpumask at first and apply it to wqs. */
4797 cpumask_copy(wq_unbound_cpumask, cpumask);
4798 ret = workqueue_apply_unbound_cpumask();
4799
4800 /* restore the wq_unbound_cpumask when failed. */
4801 if (ret < 0)
4802 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4803
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004804 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004805 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004806
4807 free_cpumask_var(saved_cpumask);
4808 return ret;
4809}
4810
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004811#ifdef CONFIG_SYSFS
4812/*
4813 * Workqueues with WQ_SYSFS flag set is visible to userland via
4814 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4815 * following attributes.
4816 *
4817 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4818 * max_active RW int : maximum number of in-flight work items
4819 *
4820 * Unbound workqueues have the following extra attributes.
4821 *
4822 * id RO int : the associated pool ID
4823 * nice RW int : nice value of the workers
4824 * cpumask RW mask : bitmask of allowed CPUs for the workers
4825 */
4826struct wq_device {
4827 struct workqueue_struct *wq;
4828 struct device dev;
4829};
4830
4831static struct workqueue_struct *dev_to_wq(struct device *dev)
4832{
4833 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
4834
4835 return wq_dev->wq;
4836}
4837
4838static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
4839 char *buf)
4840{
4841 struct workqueue_struct *wq = dev_to_wq(dev);
4842
4843 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
4844}
4845static DEVICE_ATTR_RO(per_cpu);
4846
4847static ssize_t max_active_show(struct device *dev,
4848 struct device_attribute *attr, char *buf)
4849{
4850 struct workqueue_struct *wq = dev_to_wq(dev);
4851
4852 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
4853}
4854
4855static ssize_t max_active_store(struct device *dev,
4856 struct device_attribute *attr, const char *buf,
4857 size_t count)
4858{
4859 struct workqueue_struct *wq = dev_to_wq(dev);
4860 int val;
4861
4862 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
4863 return -EINVAL;
4864
4865 workqueue_set_max_active(wq, val);
4866 return count;
4867}
4868static DEVICE_ATTR_RW(max_active);
4869
4870static struct attribute *wq_sysfs_attrs[] = {
4871 &dev_attr_per_cpu.attr,
4872 &dev_attr_max_active.attr,
4873 NULL,
4874};
4875ATTRIBUTE_GROUPS(wq_sysfs);
4876
4877static ssize_t wq_pool_ids_show(struct device *dev,
4878 struct device_attribute *attr, char *buf)
4879{
4880 struct workqueue_struct *wq = dev_to_wq(dev);
4881 const char *delim = "";
4882 int node, written = 0;
4883
4884 rcu_read_lock_sched();
4885 for_each_node(node) {
4886 written += scnprintf(buf + written, PAGE_SIZE - written,
4887 "%s%d:%d", delim, node,
4888 unbound_pwq_by_node(wq, node)->pool->id);
4889 delim = " ";
4890 }
4891 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
4892 rcu_read_unlock_sched();
4893
4894 return written;
4895}
4896
4897static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
4898 char *buf)
4899{
4900 struct workqueue_struct *wq = dev_to_wq(dev);
4901 int written;
4902
4903 mutex_lock(&wq->mutex);
4904 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
4905 mutex_unlock(&wq->mutex);
4906
4907 return written;
4908}
4909
4910/* prepare workqueue_attrs for sysfs store operations */
4911static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
4912{
4913 struct workqueue_attrs *attrs;
4914
Lai Jiangshan899a94f2015-05-20 14:41:18 +08004915 lockdep_assert_held(&wq_pool_mutex);
4916
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004917 attrs = alloc_workqueue_attrs(GFP_KERNEL);
4918 if (!attrs)
4919 return NULL;
4920
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004921 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004922 return attrs;
4923}
4924
4925static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
4926 const char *buf, size_t count)
4927{
4928 struct workqueue_struct *wq = dev_to_wq(dev);
4929 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004930 int ret = -ENOMEM;
4931
4932 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004933
4934 attrs = wq_sysfs_prep_attrs(wq);
4935 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004936 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004937
4938 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
4939 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004940 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004941 else
4942 ret = -EINVAL;
4943
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004944out_unlock:
4945 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004946 free_workqueue_attrs(attrs);
4947 return ret ?: count;
4948}
4949
4950static ssize_t wq_cpumask_show(struct device *dev,
4951 struct device_attribute *attr, char *buf)
4952{
4953 struct workqueue_struct *wq = dev_to_wq(dev);
4954 int written;
4955
4956 mutex_lock(&wq->mutex);
4957 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
4958 cpumask_pr_args(wq->unbound_attrs->cpumask));
4959 mutex_unlock(&wq->mutex);
4960 return written;
4961}
4962
4963static ssize_t wq_cpumask_store(struct device *dev,
4964 struct device_attribute *attr,
4965 const char *buf, size_t count)
4966{
4967 struct workqueue_struct *wq = dev_to_wq(dev);
4968 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004969 int ret = -ENOMEM;
4970
4971 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004972
4973 attrs = wq_sysfs_prep_attrs(wq);
4974 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004975 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004976
4977 ret = cpumask_parse(buf, attrs->cpumask);
4978 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004979 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004980
Lai Jiangshand4d3e252015-05-19 18:03:48 +08004981out_unlock:
4982 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004983 free_workqueue_attrs(attrs);
4984 return ret ?: count;
4985}
4986
4987static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
4988 char *buf)
4989{
4990 struct workqueue_struct *wq = dev_to_wq(dev);
4991 int written;
4992
4993 mutex_lock(&wq->mutex);
4994 written = scnprintf(buf, PAGE_SIZE, "%d\n",
4995 !wq->unbound_attrs->no_numa);
4996 mutex_unlock(&wq->mutex);
4997
4998 return written;
4999}
5000
5001static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5002 const char *buf, size_t count)
5003{
5004 struct workqueue_struct *wq = dev_to_wq(dev);
5005 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005006 int v, ret = -ENOMEM;
5007
5008 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005009
5010 attrs = wq_sysfs_prep_attrs(wq);
5011 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005012 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005013
5014 ret = -EINVAL;
5015 if (sscanf(buf, "%d", &v) == 1) {
5016 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005017 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005018 }
5019
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005020out_unlock:
5021 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005022 free_workqueue_attrs(attrs);
5023 return ret ?: count;
5024}
5025
5026static struct device_attribute wq_sysfs_unbound_attrs[] = {
5027 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5028 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5029 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5030 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5031 __ATTR_NULL,
5032};
5033
5034static struct bus_type wq_subsys = {
5035 .name = "workqueue",
5036 .dev_groups = wq_sysfs_groups,
5037};
5038
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005039static ssize_t wq_unbound_cpumask_show(struct device *dev,
5040 struct device_attribute *attr, char *buf)
5041{
5042 int written;
5043
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005044 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005045 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5046 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005047 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005048
5049 return written;
5050}
5051
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005052static ssize_t wq_unbound_cpumask_store(struct device *dev,
5053 struct device_attribute *attr, const char *buf, size_t count)
5054{
5055 cpumask_var_t cpumask;
5056 int ret;
5057
5058 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5059 return -ENOMEM;
5060
5061 ret = cpumask_parse(buf, cpumask);
5062 if (!ret)
5063 ret = workqueue_set_unbound_cpumask(cpumask);
5064
5065 free_cpumask_var(cpumask);
5066 return ret ? ret : count;
5067}
5068
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005069static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005070 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5071 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005072
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005073static int __init wq_sysfs_init(void)
5074{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005075 int err;
5076
5077 err = subsys_virtual_register(&wq_subsys, NULL);
5078 if (err)
5079 return err;
5080
5081 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005082}
5083core_initcall(wq_sysfs_init);
5084
5085static void wq_device_release(struct device *dev)
5086{
5087 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5088
5089 kfree(wq_dev);
5090}
5091
5092/**
5093 * workqueue_sysfs_register - make a workqueue visible in sysfs
5094 * @wq: the workqueue to register
5095 *
5096 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5097 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5098 * which is the preferred method.
5099 *
5100 * Workqueue user should use this function directly iff it wants to apply
5101 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5102 * apply_workqueue_attrs() may race against userland updating the
5103 * attributes.
5104 *
5105 * Return: 0 on success, -errno on failure.
5106 */
5107int workqueue_sysfs_register(struct workqueue_struct *wq)
5108{
5109 struct wq_device *wq_dev;
5110 int ret;
5111
5112 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305113 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005114 * attributes breaks ordering guarantee. Disallow exposing ordered
5115 * workqueues.
5116 */
5117 if (WARN_ON(wq->flags & __WQ_ORDERED))
5118 return -EINVAL;
5119
5120 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5121 if (!wq_dev)
5122 return -ENOMEM;
5123
5124 wq_dev->wq = wq;
5125 wq_dev->dev.bus = &wq_subsys;
5126 wq_dev->dev.init_name = wq->name;
5127 wq_dev->dev.release = wq_device_release;
5128
5129 /*
5130 * unbound_attrs are created separately. Suppress uevent until
5131 * everything is ready.
5132 */
5133 dev_set_uevent_suppress(&wq_dev->dev, true);
5134
5135 ret = device_register(&wq_dev->dev);
5136 if (ret) {
5137 kfree(wq_dev);
5138 wq->wq_dev = NULL;
5139 return ret;
5140 }
5141
5142 if (wq->flags & WQ_UNBOUND) {
5143 struct device_attribute *attr;
5144
5145 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5146 ret = device_create_file(&wq_dev->dev, attr);
5147 if (ret) {
5148 device_unregister(&wq_dev->dev);
5149 wq->wq_dev = NULL;
5150 return ret;
5151 }
5152 }
5153 }
5154
5155 dev_set_uevent_suppress(&wq_dev->dev, false);
5156 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5157 return 0;
5158}
5159
5160/**
5161 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5162 * @wq: the workqueue to unregister
5163 *
5164 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5165 */
5166static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5167{
5168 struct wq_device *wq_dev = wq->wq_dev;
5169
5170 if (!wq->wq_dev)
5171 return;
5172
5173 wq->wq_dev = NULL;
5174 device_unregister(&wq_dev->dev);
5175}
5176#else /* CONFIG_SYSFS */
5177static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5178#endif /* CONFIG_SYSFS */
5179
Tejun Heobce90382013-04-01 11:23:32 -07005180static void __init wq_numa_init(void)
5181{
5182 cpumask_var_t *tbl;
5183 int node, cpu;
5184
Tejun Heobce90382013-04-01 11:23:32 -07005185 if (num_possible_nodes() <= 1)
5186 return;
5187
Tejun Heod55262c2013-04-01 11:23:38 -07005188 if (wq_disable_numa) {
5189 pr_info("workqueue: NUMA affinity support disabled\n");
5190 return;
5191 }
5192
Tejun Heo4c16bd32013-04-01 11:23:36 -07005193 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5194 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5195
Tejun Heobce90382013-04-01 11:23:32 -07005196 /*
5197 * We want masks of possible CPUs of each node which isn't readily
5198 * available. Build one from cpu_to_node() which should have been
5199 * fully initialized by now.
5200 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005201 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005202 BUG_ON(!tbl);
5203
5204 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005205 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005206 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005207
5208 for_each_possible_cpu(cpu) {
5209 node = cpu_to_node(cpu);
5210 if (WARN_ON(node == NUMA_NO_NODE)) {
5211 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5212 /* happens iff arch is bonkers, let's just proceed */
5213 return;
5214 }
5215 cpumask_set_cpu(cpu, tbl[node]);
5216 }
5217
5218 wq_numa_possible_cpumask = tbl;
5219 wq_numa_enabled = true;
5220}
5221
Suresh Siddha6ee05782010-07-30 14:57:37 -07005222static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005223{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005224 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5225 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005226
Tejun Heoe904e6c2013-03-12 11:29:57 -07005227 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5228
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005229 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5230 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5231
Tejun Heoe904e6c2013-03-12 11:29:57 -07005232 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5233
Tejun Heo65758202012-07-17 12:39:26 -07005234 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07005235 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02005236
Tejun Heobce90382013-04-01 11:23:32 -07005237 wq_numa_init();
5238
Tejun Heo706026c2013-01-24 11:01:34 -08005239 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005240 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005241 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005242
Tejun Heo7a4e3442013-03-12 11:30:00 -07005243 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005244 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005245 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005246 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005247 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005248 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005249 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005250
Tejun Heo9daf9e62013-01-24 11:01:33 -08005251 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005252 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005253 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005254 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005255 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005256 }
5257
Tejun Heoe22bee72010-06-29 10:07:14 +02005258 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07005259 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005260 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02005261
Tejun Heof02ae732013-03-12 11:30:03 -07005262 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07005263 pool->flags &= ~POOL_DISASSOCIATED;
Lai Jiangshan051e1852014-07-22 13:03:02 +08005264 BUG_ON(!create_worker(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07005265 }
Tejun Heoe22bee72010-06-29 10:07:14 +02005266 }
5267
Tejun Heo8a2b7532013-09-05 12:30:04 -04005268 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005269 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5270 struct workqueue_attrs *attrs;
5271
5272 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005273 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005274 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005275
5276 /*
5277 * An ordered wq should have only one pwq as ordering is
5278 * guaranteed by max_active which is enforced by pwqs.
5279 * Turn off NUMA so that dfl_pwq is used for all nodes.
5280 */
5281 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5282 attrs->nice = std_nice[i];
5283 attrs->no_numa = true;
5284 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005285 }
5286
Tejun Heod320c032010-06-29 10:07:14 +02005287 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005288 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005289 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005290 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5291 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005292 system_freezable_wq = alloc_workqueue("events_freezable",
5293 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305294 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5295 WQ_POWER_EFFICIENT, 0);
5296 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5297 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5298 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005299 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305300 !system_unbound_wq || !system_freezable_wq ||
5301 !system_power_efficient_wq ||
5302 !system_freezable_power_efficient_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07005303 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005304}
Suresh Siddha6ee05782010-07-30 14:57:37 -07005305early_initcall(init_workqueues);