blob: beeeac9e0e3e6829faa3fe16304cb3e7adbe8850 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080019 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020023 *
24 * Please read Documentation/workqueue.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
Paul Gortmaker9984de12011-05-23 14:51:41 -040027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060038#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/kallsyms.h>
42#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020051
Tejun Heoea138442013-01-18 14:05:55 -080052#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Tejun Heoc8e55f32010-06-29 10:07:12 +020054enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070055 /*
Tejun Heo24647572013-01-24 11:01:33 -080056 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 *
Tejun Heo24647572013-01-24 11:01:33 -080058 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 * While associated (!DISASSOCIATED), all workers are bound to the
60 * CPU and none has %WORKER_UNBOUND set and concurrency management
61 * is in effect.
62 *
63 * While DISASSOCIATED, the cpu may be offline and all workers have
64 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080065 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070066 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070067 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080068 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080069 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070070 */
Tejun Heo24647572013-01-24 11:01:33 -080071 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020072
Tejun Heoc8e55f32010-06-29 10:07:12 +020073 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020074 WORKER_DIE = 1 << 1, /* die die die */
75 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020076 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020077 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020078 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070079 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020080
Tejun Heoa9ab7752013-03-19 13:45:21 -070081 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
82 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020083
Tejun Heoe34cdddb2013-01-24 11:01:33 -080084 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070085
Tejun Heo29c91e92013-03-12 11:30:03 -070086 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020087 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020088
Tejun Heoe22bee72010-06-29 10:07:14 +020089 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
90 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
91
Tejun Heo3233cdb2011-02-16 18:10:19 +010092 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
93 /* call for help after 10ms
94 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020095 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
96 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020097
98 /*
99 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800100 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200101 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800102 RESCUER_NICE_LEVEL = MIN_NICE,
103 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700104
105 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200106};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200109 * Structure fields follow one of the following exclusion rules.
110 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200111 * I: Modifiable by initialization/destruction paths and read-only for
112 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200113 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200114 * P: Preemption protected. Disabling preemption is enough and should
115 * only be modified and accessed from the local cpu.
116 *
Tejun Heod565ed62013-01-24 11:01:33 -0800117 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200118 *
Tejun Heod565ed62013-01-24 11:01:33 -0800119 * X: During normal operation, modification requires pool->lock and should
120 * be done only from local cpu. Either disabling preemption on local
121 * cpu or grabbing pool->lock is enough for read access. If
122 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200123 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800124 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700125 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700126 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700127 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700128 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700129 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700130 * WQ: wq->mutex protected.
131 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700132 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700133 *
134 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200135 */
136
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800137/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200138
Tejun Heobd7bdd42012-07-12 14:46:37 -0700139struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800140 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700141 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700142 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800143 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700144 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700145
146 struct list_head worklist; /* L: list of pending works */
147 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700148
149 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700150 int nr_idle; /* L: currently idle ones */
151
152 struct list_head idle_list; /* X: list of idle workers */
153 struct timer_list idle_timer; /* L: worker idle timeout */
154 struct timer_list mayday_timer; /* L: SOS timer for workers */
155
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700156 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800157 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
158 /* L: hash of busy workers */
159
Tejun Heobc3a1af2013-03-13 19:47:39 -0700160 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo34a06bd2013-03-12 11:30:00 -0700161 struct mutex manager_arb; /* manager arbitration */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800162 struct mutex attach_mutex; /* attach/detach exclusion */
163 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800164 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800165
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800166 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800167
Tejun Heo7a4e3442013-03-12 11:30:00 -0700168 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700169 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
170 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700171
Tejun Heoe19e3972013-01-24 11:39:44 -0800172 /*
173 * The current concurrency level. As it's likely to be accessed
174 * from other CPUs during try_to_wake_up(), put it in a separate
175 * cacheline.
176 */
177 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700178
179 /*
180 * Destruction of pool is sched-RCU protected to allow dereferences
181 * from get_work_pool().
182 */
183 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200184} ____cacheline_aligned_in_smp;
185
186/*
Tejun Heo112202d2013-02-13 19:29:12 -0800187 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
188 * of work_struct->data are used for flags and the remaining high bits
189 * point to the pwq; thus, pwqs need to be aligned at two's power of the
190 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 */
Tejun Heo112202d2013-02-13 19:29:12 -0800192struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700193 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200194 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200195 int work_color; /* L: current color */
196 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700197 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200198 int nr_in_flight[WORK_NR_COLORS];
199 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200200 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200201 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200202 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700203 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700204 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700205
206 /*
207 * Release of unbound pwq is punted to system_wq. See put_pwq()
208 * and pwq_unbound_release_workfn() for details. pool_workqueue
209 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700210 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700211 */
212 struct work_struct unbound_release_work;
213 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700214} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200217 * Structure used to wait for workqueue flush.
218 */
219struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700220 struct list_head list; /* WQ: list of flushers */
221 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200222 struct completion done; /* flush completion */
223};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Tejun Heo226223a2013-03-12 11:30:05 -0700225struct wq_device;
226
Tejun Heo73f53c42010-06-29 10:07:11 +0200227/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700228 * The externally visible workqueue. It relays the issued work items to
229 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 */
231struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700232 struct list_head pwqs; /* WR: all pwqs of this wq */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700233 struct list_head list; /* PL: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200234
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700235 struct mutex mutex; /* protects this wq */
236 int work_color; /* WQ: current work color */
237 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800238 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700239 struct wq_flusher *first_flusher; /* WQ: first flusher */
240 struct list_head flusher_queue; /* WQ: flush waiters */
241 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200242
Tejun Heo2e109a22013-03-13 19:47:40 -0700243 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200244 struct worker *rescuer; /* I: rescue worker */
245
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700246 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700247 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700248
Tejun Heo6029a912013-04-01 11:23:34 -0700249 struct workqueue_attrs *unbound_attrs; /* WQ: only for unbound wqs */
Tejun Heo4c16bd32013-04-01 11:23:36 -0700250 struct pool_workqueue *dfl_pwq; /* WQ: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700251
Tejun Heo226223a2013-03-12 11:30:05 -0700252#ifdef CONFIG_SYSFS
253 struct wq_device *wq_dev; /* I: for sysfs interface */
254#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700255#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200256 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700257#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700258 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700259
260 /* hot fields used during command issue, aligned to cacheline */
261 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
262 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700263 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264};
265
Tejun Heoe904e6c2013-03-12 11:29:57 -0700266static struct kmem_cache *pwq_cache;
267
Tejun Heobce90382013-04-01 11:23:32 -0700268static cpumask_var_t *wq_numa_possible_cpumask;
269 /* possible CPUs of each node */
270
Tejun Heod55262c2013-04-01 11:23:38 -0700271static bool wq_disable_numa;
272module_param_named(disable_numa, wq_disable_numa, bool, 0444);
273
Viresh Kumarcee22a12013-04-08 16:45:40 +0530274/* see the comment above the definition of WQ_POWER_EFFICIENT */
275#ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT
276static bool wq_power_efficient = true;
277#else
278static bool wq_power_efficient;
279#endif
280
281module_param_named(power_efficient, wq_power_efficient, bool, 0444);
282
Tejun Heobce90382013-04-01 11:23:32 -0700283static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
284
Tejun Heo4c16bd32013-04-01 11:23:36 -0700285/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
286static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
287
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700288static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700289static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo5bcab332013-03-13 19:47:40 -0700290
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700291static LIST_HEAD(workqueues); /* PL: list of all workqueues */
292static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700293
294/* the per-cpu worker pools */
295static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
296 cpu_worker_pools);
297
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700298static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700299
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700300/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700301static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
302
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700303/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700304static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
305
Tejun Heo8a2b7532013-09-05 12:30:04 -0400306/* I: attributes used when instantiating ordered pools on demand */
307static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
308
Tejun Heod320c032010-06-29 10:07:14 +0200309struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400310EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300311struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900312EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300313struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200314EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300315struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200316EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300317struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100318EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530319struct workqueue_struct *system_power_efficient_wq __read_mostly;
320EXPORT_SYMBOL_GPL(system_power_efficient_wq);
321struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
322EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200323
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700324static int worker_thread(void *__worker);
325static void copy_workqueue_attrs(struct workqueue_attrs *to,
326 const struct workqueue_attrs *from);
327
Tejun Heo97bd2342010-10-05 10:41:14 +0200328#define CREATE_TRACE_POINTS
329#include <trace/events/workqueue.h>
330
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700331#define assert_rcu_or_pool_mutex() \
Tejun Heo5bcab332013-03-13 19:47:40 -0700332 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700333 lockdep_is_held(&wq_pool_mutex), \
334 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700335
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700336#define assert_rcu_or_wq_mutex(wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700337 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshanb5927602013-03-25 16:57:19 -0700338 lockdep_is_held(&wq->mutex), \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700339 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700340
Tejun Heof02ae732013-03-12 11:30:03 -0700341#define for_each_cpu_worker_pool(pool, cpu) \
342 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
343 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700344 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700345
Tejun Heo49e3cf42013-03-12 11:29:58 -0700346/**
Tejun Heo17116962013-03-12 11:29:58 -0700347 * for_each_pool - iterate through all worker_pools in the system
348 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700349 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700350 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700351 * This must be called either with wq_pool_mutex held or sched RCU read
352 * locked. If the pool needs to be used beyond the locking in effect, the
353 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700354 *
355 * The if/else clause exists only for the lockdep assertion and can be
356 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700357 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700358#define for_each_pool(pool, pi) \
359 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700360 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700361 else
Tejun Heo17116962013-03-12 11:29:58 -0700362
363/**
Tejun Heo822d8402013-03-19 13:45:21 -0700364 * for_each_pool_worker - iterate through all workers of a worker_pool
365 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700366 * @pool: worker_pool to iterate workers of
367 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800368 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700369 *
370 * The if/else clause exists only for the lockdep assertion and can be
371 * ignored.
372 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800373#define for_each_pool_worker(worker, pool) \
374 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800375 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700376 else
377
378/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700379 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
380 * @pwq: iteration cursor
381 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700382 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700383 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700384 * If the pwq needs to be used beyond the locking in effect, the caller is
385 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700386 *
387 * The if/else clause exists only for the lockdep assertion and can be
388 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700389 */
390#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700391 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700392 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700393 else
Tejun Heof3421792010-07-02 10:03:51 +0200394
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900395#ifdef CONFIG_DEBUG_OBJECTS_WORK
396
397static struct debug_obj_descr work_debug_descr;
398
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100399static void *work_debug_hint(void *addr)
400{
401 return ((struct work_struct *) addr)->func;
402}
403
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900404/*
405 * fixup_init is called when:
406 * - an active object is initialized
407 */
408static int work_fixup_init(void *addr, enum debug_obj_state state)
409{
410 struct work_struct *work = addr;
411
412 switch (state) {
413 case ODEBUG_STATE_ACTIVE:
414 cancel_work_sync(work);
415 debug_object_init(work, &work_debug_descr);
416 return 1;
417 default:
418 return 0;
419 }
420}
421
422/*
423 * fixup_activate is called when:
424 * - an active object is activated
425 * - an unknown object is activated (might be a statically initialized object)
426 */
427static int work_fixup_activate(void *addr, enum debug_obj_state state)
428{
429 struct work_struct *work = addr;
430
431 switch (state) {
432
433 case ODEBUG_STATE_NOTAVAILABLE:
434 /*
435 * This is not really a fixup. The work struct was
436 * statically initialized. We just make sure that it
437 * is tracked in the object tracker.
438 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200439 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900440 debug_object_init(work, &work_debug_descr);
441 debug_object_activate(work, &work_debug_descr);
442 return 0;
443 }
444 WARN_ON_ONCE(1);
445 return 0;
446
447 case ODEBUG_STATE_ACTIVE:
448 WARN_ON(1);
449
450 default:
451 return 0;
452 }
453}
454
455/*
456 * fixup_free is called when:
457 * - an active object is freed
458 */
459static int work_fixup_free(void *addr, enum debug_obj_state state)
460{
461 struct work_struct *work = addr;
462
463 switch (state) {
464 case ODEBUG_STATE_ACTIVE:
465 cancel_work_sync(work);
466 debug_object_free(work, &work_debug_descr);
467 return 1;
468 default:
469 return 0;
470 }
471}
472
473static struct debug_obj_descr work_debug_descr = {
474 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100475 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900476 .fixup_init = work_fixup_init,
477 .fixup_activate = work_fixup_activate,
478 .fixup_free = work_fixup_free,
479};
480
481static inline void debug_work_activate(struct work_struct *work)
482{
483 debug_object_activate(work, &work_debug_descr);
484}
485
486static inline void debug_work_deactivate(struct work_struct *work)
487{
488 debug_object_deactivate(work, &work_debug_descr);
489}
490
491void __init_work(struct work_struct *work, int onstack)
492{
493 if (onstack)
494 debug_object_init_on_stack(work, &work_debug_descr);
495 else
496 debug_object_init(work, &work_debug_descr);
497}
498EXPORT_SYMBOL_GPL(__init_work);
499
500void destroy_work_on_stack(struct work_struct *work)
501{
502 debug_object_free(work, &work_debug_descr);
503}
504EXPORT_SYMBOL_GPL(destroy_work_on_stack);
505
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000506void destroy_delayed_work_on_stack(struct delayed_work *work)
507{
508 destroy_timer_on_stack(&work->timer);
509 debug_object_free(&work->work, &work_debug_descr);
510}
511EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
512
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900513#else
514static inline void debug_work_activate(struct work_struct *work) { }
515static inline void debug_work_deactivate(struct work_struct *work) { }
516#endif
517
Li Bin4e8b22b2013-09-10 09:52:35 +0800518/**
519 * worker_pool_assign_id - allocate ID and assing it to @pool
520 * @pool: the pool pointer of interest
521 *
522 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
523 * successfully, -errno on failure.
524 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800525static int worker_pool_assign_id(struct worker_pool *pool)
526{
527 int ret;
528
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700529 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700530
Li Bin4e8b22b2013-09-10 09:52:35 +0800531 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
532 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700533 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700534 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700535 return 0;
536 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800537 return ret;
538}
539
Tejun Heo76af4d92013-03-12 11:30:00 -0700540/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700541 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
542 * @wq: the target workqueue
543 * @node: the node ID
544 *
545 * This must be called either with pwq_lock held or sched RCU read locked.
546 * If the pwq needs to be used beyond the locking in effect, the caller is
547 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700548 *
549 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700550 */
551static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
552 int node)
553{
554 assert_rcu_or_wq_mutex(wq);
555 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
556}
557
Tejun Heo73f53c42010-06-29 10:07:11 +0200558static unsigned int work_color_to_flags(int color)
559{
560 return color << WORK_STRUCT_COLOR_SHIFT;
561}
562
563static int get_work_color(struct work_struct *work)
564{
565 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
566 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
567}
568
569static int work_next_color(int color)
570{
571 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700572}
573
David Howells4594bf12006-12-07 11:33:26 +0000574/*
Tejun Heo112202d2013-02-13 19:29:12 -0800575 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
576 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800577 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200578 *
Tejun Heo112202d2013-02-13 19:29:12 -0800579 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
580 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700581 * work->data. These functions should only be called while the work is
582 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200583 *
Tejun Heo112202d2013-02-13 19:29:12 -0800584 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800585 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800586 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800587 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700588 *
589 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
590 * canceled. While being canceled, a work item may have its PENDING set
591 * but stay off timer and worklist for arbitrarily long and nobody should
592 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000593 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200594static inline void set_work_data(struct work_struct *work, unsigned long data,
595 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000596{
Tejun Heo6183c002013-03-12 11:29:57 -0700597 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200598 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000599}
David Howells365970a2006-11-22 14:54:49 +0000600
Tejun Heo112202d2013-02-13 19:29:12 -0800601static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200602 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200603{
Tejun Heo112202d2013-02-13 19:29:12 -0800604 set_work_data(work, (unsigned long)pwq,
605 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200606}
607
Lai Jiangshan4468a002013-02-06 18:04:53 -0800608static void set_work_pool_and_keep_pending(struct work_struct *work,
609 int pool_id)
610{
611 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
612 WORK_STRUCT_PENDING);
613}
614
Tejun Heo7c3eed52013-01-24 11:01:33 -0800615static void set_work_pool_and_clear_pending(struct work_struct *work,
616 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000617{
Tejun Heo23657bb2012-08-13 17:08:19 -0700618 /*
619 * The following wmb is paired with the implied mb in
620 * test_and_set_bit(PENDING) and ensures all updates to @work made
621 * here are visible to and precede any updates by the next PENDING
622 * owner.
623 */
624 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800625 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200626}
627
628static void clear_work_data(struct work_struct *work)
629{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800630 smp_wmb(); /* see set_work_pool_and_clear_pending() */
631 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200632}
633
Tejun Heo112202d2013-02-13 19:29:12 -0800634static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200635{
Tejun Heoe1201532010-07-22 14:14:25 +0200636 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200637
Tejun Heo112202d2013-02-13 19:29:12 -0800638 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200639 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
640 else
641 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200642}
643
Tejun Heo7c3eed52013-01-24 11:01:33 -0800644/**
645 * get_work_pool - return the worker_pool a given work was associated with
646 * @work: the work item of interest
647 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700648 * Pools are created and destroyed under wq_pool_mutex, and allows read
649 * access under sched-RCU read lock. As such, this function should be
650 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700651 *
652 * All fields of the returned pool are accessible as long as the above
653 * mentioned locking is in effect. If the returned pool needs to be used
654 * beyond the critical section, the caller is responsible for ensuring the
655 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700656 *
657 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800658 */
659static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200660{
Tejun Heoe1201532010-07-22 14:14:25 +0200661 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800662 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200663
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700664 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700665
Tejun Heo112202d2013-02-13 19:29:12 -0800666 if (data & WORK_STRUCT_PWQ)
667 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800668 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200669
Tejun Heo7c3eed52013-01-24 11:01:33 -0800670 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
671 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200672 return NULL;
673
Tejun Heofa1b54e2013-03-12 11:30:00 -0700674 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800675}
676
677/**
678 * get_work_pool_id - return the worker pool ID a given work is associated with
679 * @work: the work item of interest
680 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700681 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800682 * %WORK_OFFQ_POOL_NONE if none.
683 */
684static int get_work_pool_id(struct work_struct *work)
685{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800686 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800687
Tejun Heo112202d2013-02-13 19:29:12 -0800688 if (data & WORK_STRUCT_PWQ)
689 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800690 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
691
692 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800693}
694
Tejun Heobbb68df2012-08-03 10:30:46 -0700695static void mark_work_canceling(struct work_struct *work)
696{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800697 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700698
Tejun Heo7c3eed52013-01-24 11:01:33 -0800699 pool_id <<= WORK_OFFQ_POOL_SHIFT;
700 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700701}
702
703static bool work_is_canceling(struct work_struct *work)
704{
705 unsigned long data = atomic_long_read(&work->data);
706
Tejun Heo112202d2013-02-13 19:29:12 -0800707 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700708}
709
David Howells365970a2006-11-22 14:54:49 +0000710/*
Tejun Heo32704762012-07-13 22:16:45 -0700711 * Policy functions. These define the policies on how the global worker
712 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800713 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000714 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200715
Tejun Heo63d95a92012-07-12 14:46:37 -0700716static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000717{
Tejun Heoe19e3972013-01-24 11:39:44 -0800718 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000719}
720
Tejun Heoe22bee72010-06-29 10:07:14 +0200721/*
722 * Need to wake up a worker? Called from anything but currently
723 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700724 *
725 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800726 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700727 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200728 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700729static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000730{
Tejun Heo63d95a92012-07-12 14:46:37 -0700731 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000732}
733
Tejun Heoe22bee72010-06-29 10:07:14 +0200734/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700735static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200736{
Tejun Heo63d95a92012-07-12 14:46:37 -0700737 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200738}
739
740/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700741static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200742{
Tejun Heoe19e3972013-01-24 11:39:44 -0800743 return !list_empty(&pool->worklist) &&
744 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200745}
746
747/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700748static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200749{
Tejun Heo63d95a92012-07-12 14:46:37 -0700750 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200751}
752
Tejun Heoe22bee72010-06-29 10:07:14 +0200753/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700754static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200755{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700756 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700757 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
758 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200759
760 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
761}
762
763/*
764 * Wake up functions.
765 */
766
Lai Jiangshan1037de32014-05-22 16:44:07 +0800767/* Return the first idle worker. Safe with preemption disabled */
768static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200769{
Tejun Heo63d95a92012-07-12 14:46:37 -0700770 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200771 return NULL;
772
Tejun Heo63d95a92012-07-12 14:46:37 -0700773 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200774}
775
776/**
777 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700778 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200779 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700780 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200781 *
782 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800783 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200784 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700785static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200786{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800787 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200788
789 if (likely(worker))
790 wake_up_process(worker->task);
791}
792
Tejun Heo4690c4a2010-06-29 10:07:10 +0200793/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200794 * wq_worker_waking_up - a worker is waking up
795 * @task: task waking up
796 * @cpu: CPU @task is waking up to
797 *
798 * This function is called during try_to_wake_up() when a worker is
799 * being awoken.
800 *
801 * CONTEXT:
802 * spin_lock_irq(rq->lock)
803 */
Tejun Heod84ff052013-03-12 11:29:59 -0700804void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200805{
806 struct worker *worker = kthread_data(task);
807
Joonsoo Kim36576002012-10-26 23:03:49 +0900808 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800809 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800810 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900811 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200812}
813
814/**
815 * wq_worker_sleeping - a worker is going to sleep
816 * @task: task going to sleep
817 * @cpu: CPU in question, must be the current CPU number
818 *
819 * This function is called during schedule() when a busy worker is
820 * going to sleep. Worker on the same cpu can be woken up by
821 * returning pointer to its task.
822 *
823 * CONTEXT:
824 * spin_lock_irq(rq->lock)
825 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700826 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200827 * Worker task on @cpu to wake up, %NULL if none.
828 */
Tejun Heod84ff052013-03-12 11:29:59 -0700829struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200830{
831 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800832 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200833
Tejun Heo111c2252013-01-17 17:16:24 -0800834 /*
835 * Rescuers, which may not have all the fields set up like normal
836 * workers, also reach here, let's not access anything before
837 * checking NOT_RUNNING.
838 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500839 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200840 return NULL;
841
Tejun Heo111c2252013-01-17 17:16:24 -0800842 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800843
Tejun Heoe22bee72010-06-29 10:07:14 +0200844 /* this can only happen on the local cpu */
Lai Jiangshan92b69f52014-06-03 15:33:08 +0800845 if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu))
Tejun Heo6183c002013-03-12 11:29:57 -0700846 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200847
848 /*
849 * The counterpart of the following dec_and_test, implied mb,
850 * worklist not empty test sequence is in insert_work().
851 * Please read comment there.
852 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700853 * NOT_RUNNING is clear. This means that we're bound to and
854 * running on the local cpu w/ rq lock held and preemption
855 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800856 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700857 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200858 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800859 if (atomic_dec_and_test(&pool->nr_running) &&
860 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800861 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200862 return to_wakeup ? to_wakeup->task : NULL;
863}
864
865/**
866 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200867 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200868 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200869 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800870 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200871 *
Tejun Heocb444762010-07-02 10:03:50 +0200872 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800873 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200874 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800875static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200876{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700877 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200878
Tejun Heocb444762010-07-02 10:03:50 +0200879 WARN_ON_ONCE(worker->task != current);
880
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800881 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200882 if ((flags & WORKER_NOT_RUNNING) &&
883 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800884 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200885 }
886
Tejun Heod302f012010-06-29 10:07:13 +0200887 worker->flags |= flags;
888}
889
890/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200891 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200892 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200893 * @flags: flags to clear
894 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200895 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200896 *
Tejun Heocb444762010-07-02 10:03:50 +0200897 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800898 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200899 */
900static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
901{
Tejun Heo63d95a92012-07-12 14:46:37 -0700902 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200903 unsigned int oflags = worker->flags;
904
Tejun Heocb444762010-07-02 10:03:50 +0200905 WARN_ON_ONCE(worker->task != current);
906
Tejun Heod302f012010-06-29 10:07:13 +0200907 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200908
Tejun Heo42c025f2011-01-11 15:58:49 +0100909 /*
910 * If transitioning out of NOT_RUNNING, increment nr_running. Note
911 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
912 * of multiple flags, not a single flag.
913 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200914 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
915 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800916 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200917}
918
919/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200920 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800921 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200922 * @work: work to find worker for
923 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800924 * Find a worker which is executing @work on @pool by searching
925 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800926 * to match, its current execution should match the address of @work and
927 * its work function. This is to avoid unwanted dependency between
928 * unrelated work executions through a work item being recycled while still
929 * being executed.
930 *
931 * This is a bit tricky. A work item may be freed once its execution
932 * starts and nothing prevents the freed area from being recycled for
933 * another work item. If the same work item address ends up being reused
934 * before the original execution finishes, workqueue will identify the
935 * recycled work item as currently executing and make it wait until the
936 * current execution finishes, introducing an unwanted dependency.
937 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700938 * This function checks the work item address and work function to avoid
939 * false positives. Note that this isn't complete as one may construct a
940 * work function which can introduce dependency onto itself through a
941 * recycled work item. Well, if somebody wants to shoot oneself in the
942 * foot that badly, there's only so much we can do, and if such deadlock
943 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200944 *
945 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800946 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200947 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700948 * Return:
949 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200950 * otherwise.
951 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800952static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200953 struct work_struct *work)
954{
Sasha Levin42f85702012-12-17 10:01:23 -0500955 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500956
Sasha Levinb67bfe02013-02-27 17:06:00 -0800957 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800958 (unsigned long)work)
959 if (worker->current_work == work &&
960 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500961 return worker;
962
963 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200964}
965
966/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700967 * move_linked_works - move linked works to a list
968 * @work: start of series of works to be scheduled
969 * @head: target list to append @work to
970 * @nextp: out paramter for nested worklist walking
971 *
972 * Schedule linked works starting from @work to @head. Work series to
973 * be scheduled starts at @work and includes any consecutive work with
974 * WORK_STRUCT_LINKED set in its predecessor.
975 *
976 * If @nextp is not NULL, it's updated to point to the next work of
977 * the last scheduled work. This allows move_linked_works() to be
978 * nested inside outer list_for_each_entry_safe().
979 *
980 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800981 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -0700982 */
983static void move_linked_works(struct work_struct *work, struct list_head *head,
984 struct work_struct **nextp)
985{
986 struct work_struct *n;
987
988 /*
989 * Linked worklist will always end before the end of the list,
990 * use NULL for list head.
991 */
992 list_for_each_entry_safe_from(work, n, NULL, entry) {
993 list_move_tail(&work->entry, head);
994 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
995 break;
996 }
997
998 /*
999 * If we're already inside safe list traversal and have moved
1000 * multiple works to the scheduled queue, the next position
1001 * needs to be updated.
1002 */
1003 if (nextp)
1004 *nextp = n;
1005}
1006
Tejun Heo8864b4e2013-03-12 11:30:04 -07001007/**
1008 * get_pwq - get an extra reference on the specified pool_workqueue
1009 * @pwq: pool_workqueue to get
1010 *
1011 * Obtain an extra reference on @pwq. The caller should guarantee that
1012 * @pwq has positive refcnt and be holding the matching pool->lock.
1013 */
1014static void get_pwq(struct pool_workqueue *pwq)
1015{
1016 lockdep_assert_held(&pwq->pool->lock);
1017 WARN_ON_ONCE(pwq->refcnt <= 0);
1018 pwq->refcnt++;
1019}
1020
1021/**
1022 * put_pwq - put a pool_workqueue reference
1023 * @pwq: pool_workqueue to put
1024 *
1025 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1026 * destruction. The caller should be holding the matching pool->lock.
1027 */
1028static void put_pwq(struct pool_workqueue *pwq)
1029{
1030 lockdep_assert_held(&pwq->pool->lock);
1031 if (likely(--pwq->refcnt))
1032 return;
1033 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1034 return;
1035 /*
1036 * @pwq can't be released under pool->lock, bounce to
1037 * pwq_unbound_release_workfn(). This never recurses on the same
1038 * pool->lock as this path is taken only for unbound workqueues and
1039 * the release work item is scheduled on a per-cpu workqueue. To
1040 * avoid lockdep warning, unbound pool->locks are given lockdep
1041 * subclass of 1 in get_unbound_pool().
1042 */
1043 schedule_work(&pwq->unbound_release_work);
1044}
1045
Tejun Heodce90d42013-04-01 11:23:35 -07001046/**
1047 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1048 * @pwq: pool_workqueue to put (can be %NULL)
1049 *
1050 * put_pwq() with locking. This function also allows %NULL @pwq.
1051 */
1052static void put_pwq_unlocked(struct pool_workqueue *pwq)
1053{
1054 if (pwq) {
1055 /*
1056 * As both pwqs and pools are sched-RCU protected, the
1057 * following lock operations are safe.
1058 */
1059 spin_lock_irq(&pwq->pool->lock);
1060 put_pwq(pwq);
1061 spin_unlock_irq(&pwq->pool->lock);
1062 }
1063}
1064
Tejun Heo112202d2013-02-13 19:29:12 -08001065static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001066{
Tejun Heo112202d2013-02-13 19:29:12 -08001067 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001068
1069 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001070 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001071 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001072 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001073}
1074
Tejun Heo112202d2013-02-13 19:29:12 -08001075static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001076{
Tejun Heo112202d2013-02-13 19:29:12 -08001077 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001078 struct work_struct, entry);
1079
Tejun Heo112202d2013-02-13 19:29:12 -08001080 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001081}
1082
Tejun Heobf4ede02012-08-03 10:30:46 -07001083/**
Tejun Heo112202d2013-02-13 19:29:12 -08001084 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1085 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001086 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001087 *
1088 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001089 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001090 *
1091 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001092 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001093 */
Tejun Heo112202d2013-02-13 19:29:12 -08001094static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001095{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001096 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001097 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001098 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001099
Tejun Heo112202d2013-02-13 19:29:12 -08001100 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001101
Tejun Heo112202d2013-02-13 19:29:12 -08001102 pwq->nr_active--;
1103 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001104 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001105 if (pwq->nr_active < pwq->max_active)
1106 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001107 }
1108
1109 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001110 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001111 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001112
1113 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001114 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001115 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001116
Tejun Heo112202d2013-02-13 19:29:12 -08001117 /* this pwq is done, clear flush_color */
1118 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001119
1120 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001121 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001122 * will handle the rest.
1123 */
Tejun Heo112202d2013-02-13 19:29:12 -08001124 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1125 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001126out_put:
1127 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001128}
1129
Tejun Heo36e227d2012-08-03 10:30:46 -07001130/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001131 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001132 * @work: work item to steal
1133 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001134 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001135 *
1136 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001137 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001138 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001139 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001140 * 1 if @work was pending and we successfully stole PENDING
1141 * 0 if @work was idle and we claimed PENDING
1142 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001143 * -ENOENT if someone else is canceling @work, this state may persist
1144 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001145 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001146 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001147 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001148 * interrupted while holding PENDING and @work off queue, irq must be
1149 * disabled on entry. This, combined with delayed_work->timer being
1150 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001151 *
1152 * On successful return, >= 0, irq is disabled and the caller is
1153 * responsible for releasing it using local_irq_restore(*@flags).
1154 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001155 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001156 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001157static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1158 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001159{
Tejun Heod565ed62013-01-24 11:01:33 -08001160 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001161 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001162
Tejun Heobbb68df2012-08-03 10:30:46 -07001163 local_irq_save(*flags);
1164
Tejun Heo36e227d2012-08-03 10:30:46 -07001165 /* try to steal the timer if it exists */
1166 if (is_dwork) {
1167 struct delayed_work *dwork = to_delayed_work(work);
1168
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001169 /*
1170 * dwork->timer is irqsafe. If del_timer() fails, it's
1171 * guaranteed that the timer is not queued anywhere and not
1172 * running on the local CPU.
1173 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001174 if (likely(del_timer(&dwork->timer)))
1175 return 1;
1176 }
1177
1178 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001179 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1180 return 0;
1181
1182 /*
1183 * The queueing is in progress, or it is already queued. Try to
1184 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1185 */
Tejun Heod565ed62013-01-24 11:01:33 -08001186 pool = get_work_pool(work);
1187 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001188 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001189
Tejun Heod565ed62013-01-24 11:01:33 -08001190 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001191 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001192 * work->data is guaranteed to point to pwq only while the work
1193 * item is queued on pwq->wq, and both updating work->data to point
1194 * to pwq on queueing and to pool on dequeueing are done under
1195 * pwq->pool->lock. This in turn guarantees that, if work->data
1196 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001197 * item is currently queued on that pool.
1198 */
Tejun Heo112202d2013-02-13 19:29:12 -08001199 pwq = get_work_pwq(work);
1200 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001201 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001202
Tejun Heo16062832013-02-06 18:04:53 -08001203 /*
1204 * A delayed work item cannot be grabbed directly because
1205 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001206 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001207 * management later on and cause stall. Make sure the work
1208 * item is activated before grabbing.
1209 */
1210 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001211 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001212
Tejun Heo16062832013-02-06 18:04:53 -08001213 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001214 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001215
Tejun Heo112202d2013-02-13 19:29:12 -08001216 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001217 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001218
Tejun Heo16062832013-02-06 18:04:53 -08001219 spin_unlock(&pool->lock);
1220 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001221 }
Tejun Heod565ed62013-01-24 11:01:33 -08001222 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001223fail:
1224 local_irq_restore(*flags);
1225 if (work_is_canceling(work))
1226 return -ENOENT;
1227 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001228 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001229}
1230
1231/**
Tejun Heo706026c2013-01-24 11:01:34 -08001232 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001233 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001234 * @work: work to insert
1235 * @head: insertion point
1236 * @extra_flags: extra WORK_STRUCT_* flags to set
1237 *
Tejun Heo112202d2013-02-13 19:29:12 -08001238 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001239 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001240 *
1241 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001242 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001243 */
Tejun Heo112202d2013-02-13 19:29:12 -08001244static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1245 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001246{
Tejun Heo112202d2013-02-13 19:29:12 -08001247 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001248
Tejun Heo4690c4a2010-06-29 10:07:10 +02001249 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001250 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001251 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001252 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001253
1254 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001255 * Ensure either wq_worker_sleeping() sees the above
1256 * list_add_tail() or we see zero nr_running to avoid workers lying
1257 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001258 */
1259 smp_mb();
1260
Tejun Heo63d95a92012-07-12 14:46:37 -07001261 if (__need_more_worker(pool))
1262 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001263}
1264
Tejun Heoc8efcc22010-12-20 19:32:04 +01001265/*
1266 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001267 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001268 */
1269static bool is_chained_work(struct workqueue_struct *wq)
1270{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001271 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001272
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001273 worker = current_wq_worker();
1274 /*
1275 * Return %true iff I'm a worker execuing a work item on @wq. If
1276 * I'm @worker, it's safe to dereference it without locking.
1277 */
Tejun Heo112202d2013-02-13 19:29:12 -08001278 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001279}
1280
Tejun Heod84ff052013-03-12 11:29:59 -07001281static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 struct work_struct *work)
1283{
Tejun Heo112202d2013-02-13 19:29:12 -08001284 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001285 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001286 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001287 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001288 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001289
1290 /*
1291 * While a work item is PENDING && off queue, a task trying to
1292 * steal the PENDING will busy-loop waiting for it to either get
1293 * queued or lose PENDING. Grabbing PENDING and queueing should
1294 * happen with IRQ disabled.
1295 */
1296 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001298 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001299
Li Bin9ef28a72013-09-09 13:13:58 +08001300 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001301 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001302 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001303 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001304retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001305 if (req_cpu == WORK_CPU_UNBOUND)
1306 cpu = raw_smp_processor_id();
1307
Tejun Heoc9178082013-03-12 11:30:04 -07001308 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001309 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001310 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001311 else
1312 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001313
Tejun Heoc9178082013-03-12 11:30:04 -07001314 /*
1315 * If @work was previously on a different pool, it might still be
1316 * running there, in which case the work needs to be queued on that
1317 * pool to guarantee non-reentrancy.
1318 */
1319 last_pool = get_work_pool(work);
1320 if (last_pool && last_pool != pwq->pool) {
1321 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001322
Tejun Heoc9178082013-03-12 11:30:04 -07001323 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001324
Tejun Heoc9178082013-03-12 11:30:04 -07001325 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001326
Tejun Heoc9178082013-03-12 11:30:04 -07001327 if (worker && worker->current_pwq->wq == wq) {
1328 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001329 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001330 /* meh... not running there, queue here */
1331 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001332 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001333 }
Tejun Heof3421792010-07-02 10:03:51 +02001334 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001335 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001336 }
1337
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001338 /*
1339 * pwq is determined and locked. For unbound pools, we could have
1340 * raced with pwq release and it could already be dead. If its
1341 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001342 * without another pwq replacing it in the numa_pwq_tbl or while
1343 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001344 * make forward-progress.
1345 */
1346 if (unlikely(!pwq->refcnt)) {
1347 if (wq->flags & WQ_UNBOUND) {
1348 spin_unlock(&pwq->pool->lock);
1349 cpu_relax();
1350 goto retry;
1351 }
1352 /* oops */
1353 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1354 wq->name, cpu);
1355 }
1356
Tejun Heo112202d2013-02-13 19:29:12 -08001357 /* pwq determined, queue */
1358 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001359
Dan Carpenterf5b25522012-04-13 22:06:58 +03001360 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001361 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001362 return;
1363 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001364
Tejun Heo112202d2013-02-13 19:29:12 -08001365 pwq->nr_in_flight[pwq->work_color]++;
1366 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001367
Tejun Heo112202d2013-02-13 19:29:12 -08001368 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001369 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001370 pwq->nr_active++;
1371 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001372 } else {
1373 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001374 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001375 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001376
Tejun Heo112202d2013-02-13 19:29:12 -08001377 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001378
Tejun Heo112202d2013-02-13 19:29:12 -08001379 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380}
1381
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001382/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001383 * queue_work_on - queue work on specific cpu
1384 * @cpu: CPU number to execute work on
1385 * @wq: workqueue to use
1386 * @work: work to queue
1387 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001388 * We queue the work to a specific CPU, the caller must ensure it
1389 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001390 *
1391 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001392 */
Tejun Heod4283e92012-08-03 10:30:44 -07001393bool queue_work_on(int cpu, struct workqueue_struct *wq,
1394 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001395{
Tejun Heod4283e92012-08-03 10:30:44 -07001396 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001397 unsigned long flags;
1398
1399 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001400
Tejun Heo22df02b2010-06-29 10:07:10 +02001401 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001402 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001403 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001404 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001405
1406 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001407 return ret;
1408}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001409EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001410
Tejun Heod8e794d2012-08-03 10:30:45 -07001411void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412{
David Howells52bad642006-11-22 14:54:01 +00001413 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001415 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001416 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001418EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001420static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1421 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001423 struct timer_list *timer = &dwork->timer;
1424 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001426 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1427 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001428 WARN_ON_ONCE(timer_pending(timer));
1429 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001430
Tejun Heo8852aac2012-12-01 16:23:42 -08001431 /*
1432 * If @delay is 0, queue @dwork->work immediately. This is for
1433 * both optimization and correctness. The earliest @timer can
1434 * expire is on the closest next tick and delayed_work users depend
1435 * on that there's no such delay when @delay is 0.
1436 */
1437 if (!delay) {
1438 __queue_work(cpu, wq, &dwork->work);
1439 return;
1440 }
1441
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001442 timer_stats_timer_set_start_info(&dwork->timer);
1443
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001444 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001445 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001446 timer->expires = jiffies + delay;
1447
1448 if (unlikely(cpu != WORK_CPU_UNBOUND))
1449 add_timer_on(timer, cpu);
1450 else
1451 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452}
1453
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001454/**
1455 * queue_delayed_work_on - queue work on specific CPU after delay
1456 * @cpu: CPU number to execute work on
1457 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001458 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001459 * @delay: number of jiffies to wait before queueing
1460 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001461 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001462 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1463 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001464 */
Tejun Heod4283e92012-08-03 10:30:44 -07001465bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1466 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001467{
David Howells52bad642006-11-22 14:54:01 +00001468 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001469 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001470 unsigned long flags;
1471
1472 /* read the comment in __queue_work() */
1473 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001474
Tejun Heo22df02b2010-06-29 10:07:10 +02001475 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001476 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001477 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001478 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001479
1480 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001481 return ret;
1482}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001483EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484
Tejun Heoc8e55f32010-06-29 10:07:12 +02001485/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001486 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1487 * @cpu: CPU number to execute work on
1488 * @wq: workqueue to use
1489 * @dwork: work to queue
1490 * @delay: number of jiffies to wait before queueing
1491 *
1492 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1493 * modify @dwork's timer so that it expires after @delay. If @delay is
1494 * zero, @work is guaranteed to be scheduled immediately regardless of its
1495 * current state.
1496 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001497 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001498 * pending and its timer was modified.
1499 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001500 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001501 * See try_to_grab_pending() for details.
1502 */
1503bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1504 struct delayed_work *dwork, unsigned long delay)
1505{
1506 unsigned long flags;
1507 int ret;
1508
1509 do {
1510 ret = try_to_grab_pending(&dwork->work, true, &flags);
1511 } while (unlikely(ret == -EAGAIN));
1512
1513 if (likely(ret >= 0)) {
1514 __queue_delayed_work(cpu, wq, dwork, delay);
1515 local_irq_restore(flags);
1516 }
1517
1518 /* -ENOENT from try_to_grab_pending() becomes %true */
1519 return ret;
1520}
1521EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1522
1523/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001524 * worker_enter_idle - enter idle state
1525 * @worker: worker which is entering idle state
1526 *
1527 * @worker is entering idle state. Update stats and idle timer if
1528 * necessary.
1529 *
1530 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001531 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001532 */
1533static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001535 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
Tejun Heo6183c002013-03-12 11:29:57 -07001537 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1538 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1539 (worker->hentry.next || worker->hentry.pprev)))
1540 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
Lai Jiangshan051e1852014-07-22 13:03:02 +08001542 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001543 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001544 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001545 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001546
Tejun Heoc8e55f32010-06-29 10:07:12 +02001547 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001548 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001549
Tejun Heo628c78e2012-07-17 12:39:27 -07001550 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1551 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001552
Tejun Heo544ecf32012-05-14 15:04:50 -07001553 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001554 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001555 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001556 * nr_running, the warning may trigger spuriously. Check iff
1557 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001558 */
Tejun Heo24647572013-01-24 11:01:33 -08001559 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001560 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001561 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562}
1563
Tejun Heoc8e55f32010-06-29 10:07:12 +02001564/**
1565 * worker_leave_idle - leave idle state
1566 * @worker: worker which is leaving idle state
1567 *
1568 * @worker is leaving idle state. Update stats.
1569 *
1570 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001571 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001572 */
1573static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001575 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
Tejun Heo6183c002013-03-12 11:29:57 -07001577 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1578 return;
Tejun Heod302f012010-06-29 10:07:13 +02001579 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001580 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001581 list_del_init(&worker->entry);
1582}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001584static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001585{
1586 struct worker *worker;
1587
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001588 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001589 if (worker) {
1590 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001591 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001592 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001593 /* on creation a worker is in !idle && prep state */
1594 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001595 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001596 return worker;
1597}
1598
1599/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001600 * worker_attach_to_pool() - attach a worker to a pool
1601 * @worker: worker to be attached
1602 * @pool: the target pool
1603 *
1604 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1605 * cpu-binding of @worker are kept coordinated with the pool across
1606 * cpu-[un]hotplugs.
1607 */
1608static void worker_attach_to_pool(struct worker *worker,
1609 struct worker_pool *pool)
1610{
1611 mutex_lock(&pool->attach_mutex);
1612
1613 /*
1614 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1615 * online CPUs. It'll be re-applied when any of the CPUs come up.
1616 */
1617 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1618
1619 /*
1620 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1621 * stable across this function. See the comments above the
1622 * flag definition for details.
1623 */
1624 if (pool->flags & POOL_DISASSOCIATED)
1625 worker->flags |= WORKER_UNBOUND;
1626
1627 list_add_tail(&worker->node, &pool->workers);
1628
1629 mutex_unlock(&pool->attach_mutex);
1630}
1631
1632/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001633 * worker_detach_from_pool() - detach a worker from its pool
1634 * @worker: worker which is attached to its pool
1635 * @pool: the pool @worker is attached to
1636 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001637 * Undo the attaching which had been done in worker_attach_to_pool(). The
1638 * caller worker shouldn't access to the pool after detached except it has
1639 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001640 */
1641static void worker_detach_from_pool(struct worker *worker,
1642 struct worker_pool *pool)
1643{
1644 struct completion *detach_completion = NULL;
1645
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001646 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001647 list_del(&worker->node);
1648 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001649 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001650 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001651
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001652 /* clear leftover flags without pool->lock after it is detached */
1653 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1654
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001655 if (detach_completion)
1656 complete(detach_completion);
1657}
1658
1659/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001660 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001661 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001662 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001663 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001664 *
1665 * CONTEXT:
1666 * Might sleep. Does GFP_KERNEL allocations.
1667 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001668 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001669 * Pointer to the newly created worker.
1670 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001671static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001672{
Tejun Heoc34056a2010-06-29 10:07:11 +02001673 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001674 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001675 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001676
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001677 /* ID is needed to determine kthread name */
1678 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001679 if (id < 0)
1680 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001681
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001682 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001683 if (!worker)
1684 goto fail;
1685
Tejun Heobd7bdd42012-07-12 14:46:37 -07001686 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001687 worker->id = id;
1688
Tejun Heo29c91e92013-03-12 11:30:03 -07001689 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001690 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1691 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001692 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001693 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1694
Tejun Heof3f90ad2013-04-01 11:23:34 -07001695 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001696 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001697 if (IS_ERR(worker->task))
1698 goto fail;
1699
Oleg Nesterov91151222013-11-14 12:56:18 +01001700 set_user_nice(worker->task, pool->attrs->nice);
1701
1702 /* prevent userland from meddling with cpumask of workqueue workers */
1703 worker->task->flags |= PF_NO_SETAFFINITY;
1704
Lai Jiangshanda028462014-05-20 17:46:31 +08001705 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001706 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001707
Lai Jiangshan051e1852014-07-22 13:03:02 +08001708 /* start the newly created worker */
1709 spin_lock_irq(&pool->lock);
1710 worker->pool->nr_workers++;
1711 worker_enter_idle(worker);
1712 wake_up_process(worker->task);
1713 spin_unlock_irq(&pool->lock);
1714
Tejun Heoc34056a2010-06-29 10:07:11 +02001715 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001716
Tejun Heoc34056a2010-06-29 10:07:11 +02001717fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001718 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001719 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001720 kfree(worker);
1721 return NULL;
1722}
1723
1724/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001725 * destroy_worker - destroy a workqueue worker
1726 * @worker: worker to be destroyed
1727 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001728 * Destroy @worker and adjust @pool stats accordingly. The worker should
1729 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001730 *
1731 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001732 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001733 */
1734static void destroy_worker(struct worker *worker)
1735{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001736 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001737
Tejun Heocd549682013-03-13 19:47:39 -07001738 lockdep_assert_held(&pool->lock);
1739
Tejun Heoc34056a2010-06-29 10:07:11 +02001740 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001741 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001742 WARN_ON(!list_empty(&worker->scheduled)) ||
1743 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001744 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001745
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001746 pool->nr_workers--;
1747 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001748
Tejun Heoc8e55f32010-06-29 10:07:12 +02001749 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001750 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001751 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001752}
1753
Tejun Heo63d95a92012-07-12 14:46:37 -07001754static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001755{
Tejun Heo63d95a92012-07-12 14:46:37 -07001756 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001757
Tejun Heod565ed62013-01-24 11:01:33 -08001758 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001759
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001760 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001761 struct worker *worker;
1762 unsigned long expires;
1763
1764 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001765 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001766 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1767
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001768 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001769 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001770 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001771 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001772
1773 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001774 }
1775
Tejun Heod565ed62013-01-24 11:01:33 -08001776 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001777}
1778
Tejun Heo493a1722013-03-12 11:29:59 -07001779static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001780{
Tejun Heo112202d2013-02-13 19:29:12 -08001781 struct pool_workqueue *pwq = get_work_pwq(work);
1782 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001783
Tejun Heo2e109a22013-03-13 19:47:40 -07001784 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001785
Tejun Heo493008a2013-03-12 11:30:03 -07001786 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001787 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001788
1789 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001790 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001791 /*
1792 * If @pwq is for an unbound wq, its base ref may be put at
1793 * any time due to an attribute change. Pin @pwq until the
1794 * rescuer is done with it.
1795 */
1796 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001797 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001798 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001799 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001800}
1801
Tejun Heo706026c2013-01-24 11:01:34 -08001802static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001803{
Tejun Heo63d95a92012-07-12 14:46:37 -07001804 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001805 struct work_struct *work;
1806
Tejun Heob2d82902014-12-08 12:39:16 -05001807 spin_lock_irq(&pool->lock);
1808 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001809
Tejun Heo63d95a92012-07-12 14:46:37 -07001810 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001811 /*
1812 * We've been trying to create a new worker but
1813 * haven't been successful. We might be hitting an
1814 * allocation deadlock. Send distress signals to
1815 * rescuers.
1816 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001817 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001818 send_mayday(work);
1819 }
1820
Tejun Heob2d82902014-12-08 12:39:16 -05001821 spin_unlock(&wq_mayday_lock);
1822 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001823
Tejun Heo63d95a92012-07-12 14:46:37 -07001824 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001825}
1826
1827/**
1828 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001829 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001830 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001831 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001832 * have at least one idle worker on return from this function. If
1833 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001834 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001835 * possible allocation deadlock.
1836 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001837 * On return, need_to_create_worker() is guaranteed to be %false and
1838 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001839 *
1840 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001841 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001842 * multiple times. Does GFP_KERNEL allocations. Called only from
1843 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001844 */
Tejun Heo29187a92015-01-16 14:21:16 -05001845static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001846__releases(&pool->lock)
1847__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001848{
Tejun Heoe22bee72010-06-29 10:07:14 +02001849restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001850 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001851
Tejun Heoe22bee72010-06-29 10:07:14 +02001852 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001853 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001854
1855 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001856 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001857 break;
1858
Lai Jiangshane212f362014-06-03 15:32:17 +08001859 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001860
Tejun Heo63d95a92012-07-12 14:46:37 -07001861 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001862 break;
1863 }
1864
Tejun Heo63d95a92012-07-12 14:46:37 -07001865 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001866 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001867 /*
1868 * This is necessary even after a new worker was just successfully
1869 * created as @pool->lock was dropped and the new worker might have
1870 * already become busy.
1871 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001872 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001873 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001874}
1875
1876/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001877 * manage_workers - manage worker pool
1878 * @worker: self
1879 *
Tejun Heo706026c2013-01-24 11:01:34 -08001880 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001881 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001882 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001883 *
1884 * The caller can safely start processing works on false return. On
1885 * true return, it's guaranteed that need_to_create_worker() is false
1886 * and may_start_working() is true.
1887 *
1888 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001889 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001890 * multiple times. Does GFP_KERNEL allocations.
1891 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001892 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001893 * %false if the pool doesn't need management and the caller can safely
1894 * start processing works, %true if management function was performed and
1895 * the conditions that the caller verified before calling the function may
1896 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001897 */
1898static bool manage_workers(struct worker *worker)
1899{
Tejun Heo63d95a92012-07-12 14:46:37 -07001900 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001901
Tejun Heobc3a1af2013-03-13 19:47:39 -07001902 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07001903 * Anyone who successfully grabs manager_arb wins the arbitration
1904 * and becomes the manager. mutex_trylock() on pool->manager_arb
1905 * failure while holding pool->lock reliably indicates that someone
1906 * else is managing the pool and the worker which failed trylock
1907 * can proceed to executing work items. This means that anyone
1908 * grabbing manager_arb is responsible for actually performing
1909 * manager duties. If manager_arb is grabbed and released without
1910 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07001911 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07001912 if (!mutex_trylock(&pool->manager_arb))
Tejun Heo29187a92015-01-16 14:21:16 -05001913 return false;
Tejun Heoe22bee72010-06-29 10:07:14 +02001914
Tejun Heo29187a92015-01-16 14:21:16 -05001915 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001916
Tejun Heo34a06bd2013-03-12 11:30:00 -07001917 mutex_unlock(&pool->manager_arb);
Tejun Heo29187a92015-01-16 14:21:16 -05001918 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02001919}
1920
Tejun Heoa62428c2010-06-29 10:07:10 +02001921/**
1922 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001923 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001924 * @work: work to process
1925 *
1926 * Process @work. This function contains all the logics necessary to
1927 * process a single work including synchronization against and
1928 * interaction with other workers on the same cpu, queueing and
1929 * flushing. As long as context requirement is met, any worker can
1930 * call this function to process a work.
1931 *
1932 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001933 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001934 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001935static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08001936__releases(&pool->lock)
1937__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02001938{
Tejun Heo112202d2013-02-13 19:29:12 -08001939 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001940 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001941 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02001942 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001943 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001944#ifdef CONFIG_LOCKDEP
1945 /*
1946 * It is permissible to free the struct work_struct from
1947 * inside the function that is called from it, this we need to
1948 * take into account for lockdep too. To avoid bogus "held
1949 * lock freed" warnings as well as problems when looking into
1950 * work->lockdep_map, make a copy and use that here.
1951 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07001952 struct lockdep_map lockdep_map;
1953
1954 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02001955#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08001956 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08001957 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08001958 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07001959
Tejun Heo7e116292010-06-29 10:07:13 +02001960 /*
1961 * A single work shouldn't be executed concurrently by
1962 * multiple workers on a single cpu. Check whether anyone is
1963 * already processing the work. If so, defer the work to the
1964 * currently executing one.
1965 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001966 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02001967 if (unlikely(collision)) {
1968 move_linked_works(work, &collision->scheduled, NULL);
1969 return;
1970 }
1971
Tejun Heo8930cab2012-08-03 10:30:45 -07001972 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02001973 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001974 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02001975 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08001976 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08001977 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001978 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001979
Tejun Heoa62428c2010-06-29 10:07:10 +02001980 list_del_init(&work->entry);
1981
Tejun Heo649027d2010-06-29 10:07:14 +02001982 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08001983 * CPU intensive works don't participate in concurrency management.
1984 * They're the scheduler's responsibility. This takes @worker out
1985 * of concurrency management and the next code block will chain
1986 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02001987 */
1988 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08001989 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02001990
Tejun Heo974271c2012-07-12 14:46:37 -07001991 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08001992 * Wake up another worker if necessary. The condition is always
1993 * false for normal per-cpu workers since nr_running would always
1994 * be >= 1 at this point. This is used to chain execution of the
1995 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08001996 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07001997 */
Lai Jiangshana489a032014-07-22 13:01:59 +08001998 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07001999 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002000
Tejun Heo8930cab2012-08-03 10:30:45 -07002001 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002002 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002003 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002004 * PENDING and queued state changes happen together while IRQ is
2005 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002006 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002007 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002008
Tejun Heod565ed62013-01-24 11:01:33 -08002009 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002010
Tejun Heo112202d2013-02-13 19:29:12 -08002011 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002012 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002013 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002014 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002015 /*
2016 * While we must be careful to not use "work" after this, the trace
2017 * point will only record its address.
2018 */
2019 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002020 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002021 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002022
2023 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002024 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2025 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002026 current->comm, preempt_count(), task_pid_nr(current),
2027 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002028 debug_show_held_locks(current);
2029 dump_stack();
2030 }
2031
Tejun Heob22ce272013-08-28 17:33:37 -04002032 /*
2033 * The following prevents a kworker from hogging CPU on !PREEMPT
2034 * kernels, where a requeueing work item waiting for something to
2035 * happen could deadlock with stop_machine as such work item could
2036 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002037 * stop_machine. At the same time, report a quiescent RCU state so
2038 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002039 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002040 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002041
Tejun Heod565ed62013-01-24 11:01:33 -08002042 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002043
Tejun Heofb0e7be2010-06-29 10:07:15 +02002044 /* clear cpu intensive status */
2045 if (unlikely(cpu_intensive))
2046 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2047
Tejun Heoa62428c2010-06-29 10:07:10 +02002048 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002049 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002050 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002051 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002052 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002053 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002054 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002055}
2056
Tejun Heoaffee4b2010-06-29 10:07:12 +02002057/**
2058 * process_scheduled_works - process scheduled works
2059 * @worker: self
2060 *
2061 * Process all scheduled works. Please note that the scheduled list
2062 * may change while processing a work, so this function repeatedly
2063 * fetches a work from the top and executes it.
2064 *
2065 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002066 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002067 * multiple times.
2068 */
2069static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002071 while (!list_empty(&worker->scheduled)) {
2072 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002074 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076}
2077
Tejun Heo4690c4a2010-06-29 10:07:10 +02002078/**
2079 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002080 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002081 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002082 * The worker thread function. All workers belong to a worker_pool -
2083 * either a per-cpu one or dynamic unbound one. These workers process all
2084 * work items regardless of their specific target workqueue. The only
2085 * exception is work items which belong to workqueues with a rescuer which
2086 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002087 *
2088 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002089 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002090static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091{
Tejun Heoc34056a2010-06-29 10:07:11 +02002092 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002093 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094
Tejun Heoe22bee72010-06-29 10:07:14 +02002095 /* tell the scheduler that this is a workqueue worker */
2096 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002097woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002098 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002099
Tejun Heoa9ab7752013-03-19 13:45:21 -07002100 /* am I supposed to die? */
2101 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002102 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002103 WARN_ON_ONCE(!list_empty(&worker->entry));
2104 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002105
2106 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002107 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002108 worker_detach_from_pool(worker, pool);
2109 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002110 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002112
Tejun Heoc8e55f32010-06-29 10:07:12 +02002113 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002114recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002115 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002116 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002117 goto sleep;
2118
2119 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002120 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002121 goto recheck;
2122
Tejun Heoc8e55f32010-06-29 10:07:12 +02002123 /*
2124 * ->scheduled list can only be filled while a worker is
2125 * preparing to process a work or actually processing it.
2126 * Make sure nobody diddled with it while I was sleeping.
2127 */
Tejun Heo6183c002013-03-12 11:29:57 -07002128 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002129
Tejun Heoe22bee72010-06-29 10:07:14 +02002130 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002131 * Finish PREP stage. We're guaranteed to have at least one idle
2132 * worker or that someone else has already assumed the manager
2133 * role. This is where @worker starts participating in concurrency
2134 * management if applicable and concurrency management is restored
2135 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002136 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002137 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002138
2139 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002140 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002141 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002142 struct work_struct, entry);
2143
2144 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2145 /* optimization path, not strictly necessary */
2146 process_one_work(worker, work);
2147 if (unlikely(!list_empty(&worker->scheduled)))
2148 process_scheduled_works(worker);
2149 } else {
2150 move_linked_works(work, &worker->scheduled, NULL);
2151 process_scheduled_works(worker);
2152 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002153 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002154
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002155 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002156sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002157 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002158 * pool->lock is held and there's no work to process and no need to
2159 * manage, sleep. Workers are woken up only while holding
2160 * pool->lock or from local cpu, so setting the current state
2161 * before releasing pool->lock is enough to prevent losing any
2162 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002163 */
2164 worker_enter_idle(worker);
2165 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002166 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002167 schedule();
2168 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169}
2170
Tejun Heoe22bee72010-06-29 10:07:14 +02002171/**
2172 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002173 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002174 *
2175 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002176 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002177 *
Tejun Heo706026c2013-01-24 11:01:34 -08002178 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002179 * worker which uses GFP_KERNEL allocation which has slight chance of
2180 * developing into deadlock if some works currently on the same queue
2181 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2182 * the problem rescuer solves.
2183 *
Tejun Heo706026c2013-01-24 11:01:34 -08002184 * When such condition is possible, the pool summons rescuers of all
2185 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002186 * those works so that forward progress can be guaranteed.
2187 *
2188 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002189 *
2190 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002191 */
Tejun Heo111c2252013-01-17 17:16:24 -08002192static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002193{
Tejun Heo111c2252013-01-17 17:16:24 -08002194 struct worker *rescuer = __rescuer;
2195 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002196 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002197 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002198
2199 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002200
2201 /*
2202 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2203 * doesn't participate in concurrency management.
2204 */
2205 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002206repeat:
2207 set_current_state(TASK_INTERRUPTIBLE);
2208
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002209 /*
2210 * By the time the rescuer is requested to stop, the workqueue
2211 * shouldn't have any work pending, but @wq->maydays may still have
2212 * pwq(s) queued. This can happen by non-rescuer workers consuming
2213 * all the work items before the rescuer got to them. Go through
2214 * @wq->maydays processing before acting on should_stop so that the
2215 * list is always empty on exit.
2216 */
2217 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002218
Tejun Heo493a1722013-03-12 11:29:59 -07002219 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002220 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002221
2222 while (!list_empty(&wq->maydays)) {
2223 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2224 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002225 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002226 struct work_struct *work, *n;
2227
2228 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002229 list_del_init(&pwq->mayday_node);
2230
Tejun Heo2e109a22013-03-13 19:47:40 -07002231 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002232
Lai Jiangshan51697d392014-05-20 17:46:36 +08002233 worker_attach_to_pool(rescuer, pool);
2234
2235 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002236 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002237
2238 /*
2239 * Slurp in all works issued via this workqueue and
2240 * process'em.
2241 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002242 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002243 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002244 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002245 move_linked_works(work, scheduled, &n);
2246
NeilBrown008847f2014-12-08 12:39:16 -05002247 if (!list_empty(scheduled)) {
2248 process_scheduled_works(rescuer);
2249
2250 /*
2251 * The above execution of rescued work items could
2252 * have created more to rescue through
2253 * pwq_activate_first_delayed() or chained
2254 * queueing. Let's put @pwq back on mayday list so
2255 * that such back-to-back work items, which may be
2256 * being used to relieve memory pressure, don't
2257 * incur MAYDAY_INTERVAL delay inbetween.
2258 */
2259 if (need_to_create_worker(pool)) {
2260 spin_lock(&wq_mayday_lock);
2261 get_pwq(pwq);
2262 list_move_tail(&pwq->mayday_node, &wq->maydays);
2263 spin_unlock(&wq_mayday_lock);
2264 }
2265 }
Tejun Heo75769582011-02-14 14:04:46 +01002266
2267 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002268 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002269 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002270 */
2271 put_pwq(pwq);
2272
2273 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002274 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002275 * regular worker; otherwise, we end up with 0 concurrency
2276 * and stalling the execution.
2277 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002278 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002279 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002280
Lai Jiangshanb3104102013-02-19 12:17:02 -08002281 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002282 spin_unlock_irq(&pool->lock);
2283
2284 worker_detach_from_pool(rescuer, pool);
2285
2286 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002287 }
2288
Tejun Heo2e109a22013-03-13 19:47:40 -07002289 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002290
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002291 if (should_stop) {
2292 __set_current_state(TASK_RUNNING);
2293 rescuer->task->flags &= ~PF_WQ_WORKER;
2294 return 0;
2295 }
2296
Tejun Heo111c2252013-01-17 17:16:24 -08002297 /* rescuers should never participate in concurrency management */
2298 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002299 schedule();
2300 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301}
2302
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002303struct wq_barrier {
2304 struct work_struct work;
2305 struct completion done;
2306};
2307
2308static void wq_barrier_func(struct work_struct *work)
2309{
2310 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2311 complete(&barr->done);
2312}
2313
Tejun Heo4690c4a2010-06-29 10:07:10 +02002314/**
2315 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002316 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002317 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002318 * @target: target work to attach @barr to
2319 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002320 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002321 * @barr is linked to @target such that @barr is completed only after
2322 * @target finishes execution. Please note that the ordering
2323 * guarantee is observed only with respect to @target and on the local
2324 * cpu.
2325 *
2326 * Currently, a queued barrier can't be canceled. This is because
2327 * try_to_grab_pending() can't determine whether the work to be
2328 * grabbed is at the head of the queue and thus can't clear LINKED
2329 * flag of the previous work while there must be a valid next work
2330 * after a work with LINKED flag set.
2331 *
2332 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002333 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002334 *
2335 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002336 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002337 */
Tejun Heo112202d2013-02-13 19:29:12 -08002338static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002339 struct wq_barrier *barr,
2340 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002341{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002342 struct list_head *head;
2343 unsigned int linked = 0;
2344
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002345 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002346 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002347 * as we know for sure that this will not trigger any of the
2348 * checks and call back into the fixup functions where we
2349 * might deadlock.
2350 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002351 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002352 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002353 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002354
Tejun Heoaffee4b2010-06-29 10:07:12 +02002355 /*
2356 * If @target is currently being executed, schedule the
2357 * barrier to the worker; otherwise, put it after @target.
2358 */
2359 if (worker)
2360 head = worker->scheduled.next;
2361 else {
2362 unsigned long *bits = work_data_bits(target);
2363
2364 head = target->entry.next;
2365 /* there can already be other linked works, inherit and set */
2366 linked = *bits & WORK_STRUCT_LINKED;
2367 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2368 }
2369
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002370 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002371 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002372 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002373}
2374
Tejun Heo73f53c42010-06-29 10:07:11 +02002375/**
Tejun Heo112202d2013-02-13 19:29:12 -08002376 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002377 * @wq: workqueue being flushed
2378 * @flush_color: new flush color, < 0 for no-op
2379 * @work_color: new work color, < 0 for no-op
2380 *
Tejun Heo112202d2013-02-13 19:29:12 -08002381 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002382 *
Tejun Heo112202d2013-02-13 19:29:12 -08002383 * If @flush_color is non-negative, flush_color on all pwqs should be
2384 * -1. If no pwq has in-flight commands at the specified color, all
2385 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2386 * has in flight commands, its pwq->flush_color is set to
2387 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002388 * wakeup logic is armed and %true is returned.
2389 *
2390 * The caller should have initialized @wq->first_flusher prior to
2391 * calling this function with non-negative @flush_color. If
2392 * @flush_color is negative, no flush color update is done and %false
2393 * is returned.
2394 *
Tejun Heo112202d2013-02-13 19:29:12 -08002395 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002396 * work_color which is previous to @work_color and all will be
2397 * advanced to @work_color.
2398 *
2399 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002400 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002401 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002402 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002403 * %true if @flush_color >= 0 and there's something to flush. %false
2404 * otherwise.
2405 */
Tejun Heo112202d2013-02-13 19:29:12 -08002406static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002407 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408{
Tejun Heo73f53c42010-06-29 10:07:11 +02002409 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002410 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002411
Tejun Heo73f53c42010-06-29 10:07:11 +02002412 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002413 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002414 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002415 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002416
Tejun Heo49e3cf42013-03-12 11:29:58 -07002417 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002418 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002419
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002420 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002421
2422 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002423 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002424
Tejun Heo112202d2013-02-13 19:29:12 -08002425 if (pwq->nr_in_flight[flush_color]) {
2426 pwq->flush_color = flush_color;
2427 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002428 wait = true;
2429 }
2430 }
2431
2432 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002433 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002434 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002435 }
2436
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002437 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002438 }
2439
Tejun Heo112202d2013-02-13 19:29:12 -08002440 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002441 complete(&wq->first_flusher->done);
2442
2443 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444}
2445
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002446/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002448 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002450 * This function sleeps until all work items which were queued on entry
2451 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002453void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454{
Tejun Heo73f53c42010-06-29 10:07:11 +02002455 struct wq_flusher this_flusher = {
2456 .list = LIST_HEAD_INIT(this_flusher.list),
2457 .flush_color = -1,
2458 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2459 };
2460 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002461
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002462 lock_map_acquire(&wq->lockdep_map);
2463 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002464
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002465 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002466
2467 /*
2468 * Start-to-wait phase
2469 */
2470 next_color = work_next_color(wq->work_color);
2471
2472 if (next_color != wq->flush_color) {
2473 /*
2474 * Color space is not full. The current work_color
2475 * becomes our flush_color and work_color is advanced
2476 * by one.
2477 */
Tejun Heo6183c002013-03-12 11:29:57 -07002478 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002479 this_flusher.flush_color = wq->work_color;
2480 wq->work_color = next_color;
2481
2482 if (!wq->first_flusher) {
2483 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002484 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002485
2486 wq->first_flusher = &this_flusher;
2487
Tejun Heo112202d2013-02-13 19:29:12 -08002488 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002489 wq->work_color)) {
2490 /* nothing to flush, done */
2491 wq->flush_color = next_color;
2492 wq->first_flusher = NULL;
2493 goto out_unlock;
2494 }
2495 } else {
2496 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002497 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002498 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002499 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002500 }
2501 } else {
2502 /*
2503 * Oops, color space is full, wait on overflow queue.
2504 * The next flush completion will assign us
2505 * flush_color and transfer to flusher_queue.
2506 */
2507 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2508 }
2509
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002510 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002511
2512 wait_for_completion(&this_flusher.done);
2513
2514 /*
2515 * Wake-up-and-cascade phase
2516 *
2517 * First flushers are responsible for cascading flushes and
2518 * handling overflow. Non-first flushers can simply return.
2519 */
2520 if (wq->first_flusher != &this_flusher)
2521 return;
2522
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002523 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002524
Tejun Heo4ce48b32010-07-02 10:03:51 +02002525 /* we might have raced, check again with mutex held */
2526 if (wq->first_flusher != &this_flusher)
2527 goto out_unlock;
2528
Tejun Heo73f53c42010-06-29 10:07:11 +02002529 wq->first_flusher = NULL;
2530
Tejun Heo6183c002013-03-12 11:29:57 -07002531 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2532 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002533
2534 while (true) {
2535 struct wq_flusher *next, *tmp;
2536
2537 /* complete all the flushers sharing the current flush color */
2538 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2539 if (next->flush_color != wq->flush_color)
2540 break;
2541 list_del_init(&next->list);
2542 complete(&next->done);
2543 }
2544
Tejun Heo6183c002013-03-12 11:29:57 -07002545 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2546 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002547
2548 /* this flush_color is finished, advance by one */
2549 wq->flush_color = work_next_color(wq->flush_color);
2550
2551 /* one color has been freed, handle overflow queue */
2552 if (!list_empty(&wq->flusher_overflow)) {
2553 /*
2554 * Assign the same color to all overflowed
2555 * flushers, advance work_color and append to
2556 * flusher_queue. This is the start-to-wait
2557 * phase for these overflowed flushers.
2558 */
2559 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2560 tmp->flush_color = wq->work_color;
2561
2562 wq->work_color = work_next_color(wq->work_color);
2563
2564 list_splice_tail_init(&wq->flusher_overflow,
2565 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002566 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002567 }
2568
2569 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002570 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002571 break;
2572 }
2573
2574 /*
2575 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002576 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002577 */
Tejun Heo6183c002013-03-12 11:29:57 -07002578 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2579 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002580
2581 list_del_init(&next->list);
2582 wq->first_flusher = next;
2583
Tejun Heo112202d2013-02-13 19:29:12 -08002584 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002585 break;
2586
2587 /*
2588 * Meh... this color is already done, clear first
2589 * flusher and repeat cascading.
2590 */
2591 wq->first_flusher = NULL;
2592 }
2593
2594out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002595 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002596}
Dave Jonesae90dd52006-06-30 01:40:45 -04002597EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002599/**
2600 * drain_workqueue - drain a workqueue
2601 * @wq: workqueue to drain
2602 *
2603 * Wait until the workqueue becomes empty. While draining is in progress,
2604 * only chain queueing is allowed. IOW, only currently pending or running
2605 * work items on @wq can queue further work items on it. @wq is flushed
2606 * repeatedly until it becomes empty. The number of flushing is detemined
2607 * by the depth of chaining and should be relatively short. Whine if it
2608 * takes too long.
2609 */
2610void drain_workqueue(struct workqueue_struct *wq)
2611{
2612 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002613 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002614
2615 /*
2616 * __queue_work() needs to test whether there are drainers, is much
2617 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002618 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002619 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002620 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002621 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002622 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002623 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002624reflush:
2625 flush_workqueue(wq);
2626
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002627 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002628
Tejun Heo49e3cf42013-03-12 11:29:58 -07002629 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002630 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002631
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002632 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002633 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002634 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002635
2636 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002637 continue;
2638
2639 if (++flush_cnt == 10 ||
2640 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002641 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002642 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002643
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002644 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002645 goto reflush;
2646 }
2647
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002648 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002649 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002650 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002651}
2652EXPORT_SYMBOL_GPL(drain_workqueue);
2653
Tejun Heo606a5022012-08-20 14:51:23 -07002654static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002655{
2656 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002657 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002658 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002659
2660 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002661
Tejun Heofa1b54e2013-03-12 11:30:00 -07002662 local_irq_disable();
2663 pool = get_work_pool(work);
2664 if (!pool) {
2665 local_irq_enable();
2666 return false;
2667 }
2668
2669 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002670 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002671 pwq = get_work_pwq(work);
2672 if (pwq) {
2673 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002674 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002675 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002676 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002677 if (!worker)
2678 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002679 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002680 }
Tejun Heobaf59022010-09-16 10:42:16 +02002681
Tejun Heo112202d2013-02-13 19:29:12 -08002682 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002683 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002684
Tejun Heoe159489b2011-01-09 23:32:15 +01002685 /*
2686 * If @max_active is 1 or rescuer is in use, flushing another work
2687 * item on the same workqueue may lead to deadlock. Make sure the
2688 * flusher is not running on the same workqueue by verifying write
2689 * access.
2690 */
Tejun Heo493008a2013-03-12 11:30:03 -07002691 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002692 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe159489b2011-01-09 23:32:15 +01002693 else
Tejun Heo112202d2013-02-13 19:29:12 -08002694 lock_map_acquire_read(&pwq->wq->lockdep_map);
2695 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe159489b2011-01-09 23:32:15 +01002696
Tejun Heobaf59022010-09-16 10:42:16 +02002697 return true;
2698already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002699 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002700 return false;
2701}
2702
Oleg Nesterovdb700892008-07-25 01:47:49 -07002703/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002704 * flush_work - wait for a work to finish executing the last queueing instance
2705 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002706 *
Tejun Heo606a5022012-08-20 14:51:23 -07002707 * Wait until @work has finished execution. @work is guaranteed to be idle
2708 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002709 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002710 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002711 * %true if flush_work() waited for the work to finish execution,
2712 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002713 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002714bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002715{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002716 struct wq_barrier barr;
2717
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002718 lock_map_acquire(&work->lockdep_map);
2719 lock_map_release(&work->lockdep_map);
2720
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002721 if (start_flush_work(work, &barr)) {
2722 wait_for_completion(&barr.done);
2723 destroy_work_on_stack(&barr.work);
2724 return true;
2725 } else {
2726 return false;
2727 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002728}
2729EXPORT_SYMBOL_GPL(flush_work);
2730
Tejun Heo36e227d2012-08-03 10:30:46 -07002731static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002732{
Tejun Heobbb68df2012-08-03 10:30:46 -07002733 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002734 int ret;
2735
2736 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002737 ret = try_to_grab_pending(work, is_dwork, &flags);
2738 /*
2739 * If someone else is canceling, wait for the same event it
2740 * would be waiting for before retrying.
2741 */
2742 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002743 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002744 } while (unlikely(ret < 0));
2745
Tejun Heobbb68df2012-08-03 10:30:46 -07002746 /* tell other tasks trying to grab @work to back off */
2747 mark_work_canceling(work);
2748 local_irq_restore(flags);
2749
Tejun Heo606a5022012-08-20 14:51:23 -07002750 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002751 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002752 return ret;
2753}
2754
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002755/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002756 * cancel_work_sync - cancel a work and wait for it to finish
2757 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002758 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002759 * Cancel @work and wait for its execution to finish. This function
2760 * can be used even if the work re-queues itself or migrates to
2761 * another workqueue. On return from this function, @work is
2762 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002763 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002764 * cancel_work_sync(&delayed_work->work) must not be used for
2765 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002766 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002767 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002768 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002769 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002770 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002771 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002772 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002773bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002774{
Tejun Heo36e227d2012-08-03 10:30:46 -07002775 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002776}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002777EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002778
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002779/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002780 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2781 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002782 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002783 * Delayed timer is cancelled and the pending work is queued for
2784 * immediate execution. Like flush_work(), this function only
2785 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002786 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002787 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002788 * %true if flush_work() waited for the work to finish execution,
2789 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002790 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002791bool flush_delayed_work(struct delayed_work *dwork)
2792{
Tejun Heo8930cab2012-08-03 10:30:45 -07002793 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002794 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002795 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002796 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002797 return flush_work(&dwork->work);
2798}
2799EXPORT_SYMBOL(flush_delayed_work);
2800
2801/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002802 * cancel_delayed_work - cancel a delayed work
2803 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002804 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002805 * Kill off a pending delayed_work.
2806 *
2807 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2808 * pending.
2809 *
2810 * Note:
2811 * The work callback function may still be running on return, unless
2812 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2813 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002814 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002815 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002816 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002817bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002818{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002819 unsigned long flags;
2820 int ret;
2821
2822 do {
2823 ret = try_to_grab_pending(&dwork->work, true, &flags);
2824 } while (unlikely(ret == -EAGAIN));
2825
2826 if (unlikely(ret < 0))
2827 return false;
2828
Tejun Heo7c3eed52013-01-24 11:01:33 -08002829 set_work_pool_and_clear_pending(&dwork->work,
2830 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002831 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002832 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002833}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002834EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002835
2836/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002837 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2838 * @dwork: the delayed work cancel
2839 *
2840 * This is cancel_work_sync() for delayed works.
2841 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002842 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002843 * %true if @dwork was pending, %false otherwise.
2844 */
2845bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002846{
Tejun Heo36e227d2012-08-03 10:30:46 -07002847 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002848}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002849EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002850
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002851/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002852 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002853 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002854 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002855 * schedule_on_each_cpu() executes @func on each online CPU using the
2856 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002857 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002858 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002859 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02002860 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002861 */
David Howells65f27f32006-11-22 14:55:48 +00002862int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002863{
2864 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002865 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002866
Andrew Mortonb6136772006-06-25 05:47:49 -07002867 works = alloc_percpu(struct work_struct);
2868 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002869 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002870
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002871 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002872
Christoph Lameter15316ba2006-01-08 01:00:43 -08002873 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002874 struct work_struct *work = per_cpu_ptr(works, cpu);
2875
2876 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002877 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002878 }
Tejun Heo93981802009-11-17 14:06:20 -08002879
2880 for_each_online_cpu(cpu)
2881 flush_work(per_cpu_ptr(works, cpu));
2882
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002883 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002884 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002885 return 0;
2886}
2887
Alan Sterneef6a7d2010-02-12 17:39:21 +09002888/**
2889 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2890 *
2891 * Forces execution of the kernel-global workqueue and blocks until its
2892 * completion.
2893 *
2894 * Think twice before calling this function! It's very easy to get into
2895 * trouble if you don't take great care. Either of the following situations
2896 * will lead to deadlock:
2897 *
2898 * One of the work items currently on the workqueue needs to acquire
2899 * a lock held by your code or its caller.
2900 *
2901 * Your code is running in the context of a work routine.
2902 *
2903 * They will be detected by lockdep when they occur, but the first might not
2904 * occur very often. It depends on what work items are on the workqueue and
2905 * what locks they need, which you have no control over.
2906 *
2907 * In most situations flushing the entire workqueue is overkill; you merely
2908 * need to know that a particular work item isn't queued and isn't running.
2909 * In such cases you should use cancel_delayed_work_sync() or
2910 * cancel_work_sync() instead.
2911 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912void flush_scheduled_work(void)
2913{
Tejun Heod320c032010-06-29 10:07:14 +02002914 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002915}
Dave Jonesae90dd52006-06-30 01:40:45 -04002916EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002917
2918/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002919 * execute_in_process_context - reliably execute the routine with user context
2920 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002921 * @ew: guaranteed storage for the execute work structure (must
2922 * be available when the work executes)
2923 *
2924 * Executes the function immediately if process context is available,
2925 * otherwise schedules the function for delayed execution.
2926 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002927 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06002928 * 1 - function was scheduled for execution
2929 */
David Howells65f27f32006-11-22 14:55:48 +00002930int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06002931{
2932 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00002933 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002934 return 0;
2935 }
2936
David Howells65f27f32006-11-22 14:55:48 +00002937 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002938 schedule_work(&ew->work);
2939
2940 return 1;
2941}
2942EXPORT_SYMBOL_GPL(execute_in_process_context);
2943
Tejun Heo226223a2013-03-12 11:30:05 -07002944#ifdef CONFIG_SYSFS
2945/*
2946 * Workqueues with WQ_SYSFS flag set is visible to userland via
2947 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
2948 * following attributes.
2949 *
2950 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
2951 * max_active RW int : maximum number of in-flight work items
2952 *
2953 * Unbound workqueues have the following extra attributes.
2954 *
2955 * id RO int : the associated pool ID
2956 * nice RW int : nice value of the workers
2957 * cpumask RW mask : bitmask of allowed CPUs for the workers
2958 */
2959struct wq_device {
2960 struct workqueue_struct *wq;
2961 struct device dev;
2962};
2963
2964static struct workqueue_struct *dev_to_wq(struct device *dev)
2965{
2966 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
2967
2968 return wq_dev->wq;
2969}
2970
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07002971static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
2972 char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07002973{
2974 struct workqueue_struct *wq = dev_to_wq(dev);
2975
2976 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
2977}
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07002978static DEVICE_ATTR_RO(per_cpu);
Tejun Heo226223a2013-03-12 11:30:05 -07002979
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07002980static ssize_t max_active_show(struct device *dev,
2981 struct device_attribute *attr, char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07002982{
2983 struct workqueue_struct *wq = dev_to_wq(dev);
2984
2985 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
2986}
2987
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07002988static ssize_t max_active_store(struct device *dev,
2989 struct device_attribute *attr, const char *buf,
2990 size_t count)
Tejun Heo226223a2013-03-12 11:30:05 -07002991{
2992 struct workqueue_struct *wq = dev_to_wq(dev);
2993 int val;
2994
2995 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
2996 return -EINVAL;
2997
2998 workqueue_set_max_active(wq, val);
2999 return count;
3000}
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003001static DEVICE_ATTR_RW(max_active);
Tejun Heo226223a2013-03-12 11:30:05 -07003002
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003003static struct attribute *wq_sysfs_attrs[] = {
3004 &dev_attr_per_cpu.attr,
3005 &dev_attr_max_active.attr,
3006 NULL,
Tejun Heo226223a2013-03-12 11:30:05 -07003007};
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003008ATTRIBUTE_GROUPS(wq_sysfs);
Tejun Heo226223a2013-03-12 11:30:05 -07003009
Tejun Heod55262c2013-04-01 11:23:38 -07003010static ssize_t wq_pool_ids_show(struct device *dev,
3011 struct device_attribute *attr, char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07003012{
3013 struct workqueue_struct *wq = dev_to_wq(dev);
Tejun Heod55262c2013-04-01 11:23:38 -07003014 const char *delim = "";
3015 int node, written = 0;
Tejun Heo226223a2013-03-12 11:30:05 -07003016
3017 rcu_read_lock_sched();
Tejun Heod55262c2013-04-01 11:23:38 -07003018 for_each_node(node) {
3019 written += scnprintf(buf + written, PAGE_SIZE - written,
3020 "%s%d:%d", delim, node,
3021 unbound_pwq_by_node(wq, node)->pool->id);
3022 delim = " ";
3023 }
3024 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
Tejun Heo226223a2013-03-12 11:30:05 -07003025 rcu_read_unlock_sched();
3026
3027 return written;
3028}
3029
3030static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
3031 char *buf)
3032{
3033 struct workqueue_struct *wq = dev_to_wq(dev);
3034 int written;
3035
Tejun Heo6029a912013-04-01 11:23:34 -07003036 mutex_lock(&wq->mutex);
3037 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
3038 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003039
3040 return written;
3041}
3042
3043/* prepare workqueue_attrs for sysfs store operations */
3044static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
3045{
3046 struct workqueue_attrs *attrs;
3047
3048 attrs = alloc_workqueue_attrs(GFP_KERNEL);
3049 if (!attrs)
3050 return NULL;
3051
Tejun Heo6029a912013-04-01 11:23:34 -07003052 mutex_lock(&wq->mutex);
3053 copy_workqueue_attrs(attrs, wq->unbound_attrs);
3054 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003055 return attrs;
3056}
3057
3058static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
3059 const char *buf, size_t count)
3060{
3061 struct workqueue_struct *wq = dev_to_wq(dev);
3062 struct workqueue_attrs *attrs;
3063 int ret;
3064
3065 attrs = wq_sysfs_prep_attrs(wq);
3066 if (!attrs)
3067 return -ENOMEM;
3068
3069 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
Dongsheng Yang14481842014-02-11 15:34:52 +08003070 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Tejun Heo226223a2013-03-12 11:30:05 -07003071 ret = apply_workqueue_attrs(wq, attrs);
3072 else
3073 ret = -EINVAL;
3074
3075 free_workqueue_attrs(attrs);
3076 return ret ?: count;
3077}
3078
3079static ssize_t wq_cpumask_show(struct device *dev,
3080 struct device_attribute *attr, char *buf)
3081{
3082 struct workqueue_struct *wq = dev_to_wq(dev);
3083 int written;
3084
Tejun Heo6029a912013-04-01 11:23:34 -07003085 mutex_lock(&wq->mutex);
3086 written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask);
3087 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003088
3089 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3090 return written;
3091}
3092
3093static ssize_t wq_cpumask_store(struct device *dev,
3094 struct device_attribute *attr,
3095 const char *buf, size_t count)
3096{
3097 struct workqueue_struct *wq = dev_to_wq(dev);
3098 struct workqueue_attrs *attrs;
3099 int ret;
3100
3101 attrs = wq_sysfs_prep_attrs(wq);
3102 if (!attrs)
3103 return -ENOMEM;
3104
3105 ret = cpumask_parse(buf, attrs->cpumask);
3106 if (!ret)
3107 ret = apply_workqueue_attrs(wq, attrs);
3108
3109 free_workqueue_attrs(attrs);
3110 return ret ?: count;
3111}
3112
Tejun Heod55262c2013-04-01 11:23:38 -07003113static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
3114 char *buf)
3115{
3116 struct workqueue_struct *wq = dev_to_wq(dev);
3117 int written;
3118
3119 mutex_lock(&wq->mutex);
3120 written = scnprintf(buf, PAGE_SIZE, "%d\n",
3121 !wq->unbound_attrs->no_numa);
3122 mutex_unlock(&wq->mutex);
3123
3124 return written;
3125}
3126
3127static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
3128 const char *buf, size_t count)
3129{
3130 struct workqueue_struct *wq = dev_to_wq(dev);
3131 struct workqueue_attrs *attrs;
3132 int v, ret;
3133
3134 attrs = wq_sysfs_prep_attrs(wq);
3135 if (!attrs)
3136 return -ENOMEM;
3137
3138 ret = -EINVAL;
3139 if (sscanf(buf, "%d", &v) == 1) {
3140 attrs->no_numa = !v;
3141 ret = apply_workqueue_attrs(wq, attrs);
3142 }
3143
3144 free_workqueue_attrs(attrs);
3145 return ret ?: count;
3146}
3147
Tejun Heo226223a2013-03-12 11:30:05 -07003148static struct device_attribute wq_sysfs_unbound_attrs[] = {
Tejun Heod55262c2013-04-01 11:23:38 -07003149 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
Tejun Heo226223a2013-03-12 11:30:05 -07003150 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
3151 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
Tejun Heod55262c2013-04-01 11:23:38 -07003152 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
Tejun Heo226223a2013-03-12 11:30:05 -07003153 __ATTR_NULL,
3154};
3155
3156static struct bus_type wq_subsys = {
3157 .name = "workqueue",
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003158 .dev_groups = wq_sysfs_groups,
Tejun Heo226223a2013-03-12 11:30:05 -07003159};
3160
3161static int __init wq_sysfs_init(void)
3162{
3163 return subsys_virtual_register(&wq_subsys, NULL);
3164}
3165core_initcall(wq_sysfs_init);
3166
3167static void wq_device_release(struct device *dev)
3168{
3169 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3170
3171 kfree(wq_dev);
3172}
3173
3174/**
3175 * workqueue_sysfs_register - make a workqueue visible in sysfs
3176 * @wq: the workqueue to register
3177 *
3178 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
3179 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
3180 * which is the preferred method.
3181 *
3182 * Workqueue user should use this function directly iff it wants to apply
3183 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
3184 * apply_workqueue_attrs() may race against userland updating the
3185 * attributes.
3186 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003187 * Return: 0 on success, -errno on failure.
Tejun Heo226223a2013-03-12 11:30:05 -07003188 */
3189int workqueue_sysfs_register(struct workqueue_struct *wq)
3190{
3191 struct wq_device *wq_dev;
3192 int ret;
3193
3194 /*
3195 * Adjusting max_active or creating new pwqs by applyting
3196 * attributes breaks ordering guarantee. Disallow exposing ordered
3197 * workqueues.
3198 */
3199 if (WARN_ON(wq->flags & __WQ_ORDERED))
3200 return -EINVAL;
3201
3202 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
3203 if (!wq_dev)
3204 return -ENOMEM;
3205
3206 wq_dev->wq = wq;
3207 wq_dev->dev.bus = &wq_subsys;
3208 wq_dev->dev.init_name = wq->name;
3209 wq_dev->dev.release = wq_device_release;
3210
3211 /*
3212 * unbound_attrs are created separately. Suppress uevent until
3213 * everything is ready.
3214 */
3215 dev_set_uevent_suppress(&wq_dev->dev, true);
3216
3217 ret = device_register(&wq_dev->dev);
3218 if (ret) {
3219 kfree(wq_dev);
3220 wq->wq_dev = NULL;
3221 return ret;
3222 }
3223
3224 if (wq->flags & WQ_UNBOUND) {
3225 struct device_attribute *attr;
3226
3227 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
3228 ret = device_create_file(&wq_dev->dev, attr);
3229 if (ret) {
3230 device_unregister(&wq_dev->dev);
3231 wq->wq_dev = NULL;
3232 return ret;
3233 }
3234 }
3235 }
3236
Maxime Bizonbddbceb2014-06-23 16:35:35 +02003237 dev_set_uevent_suppress(&wq_dev->dev, false);
Tejun Heo226223a2013-03-12 11:30:05 -07003238 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
3239 return 0;
3240}
3241
3242/**
3243 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
3244 * @wq: the workqueue to unregister
3245 *
3246 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
3247 */
3248static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
3249{
3250 struct wq_device *wq_dev = wq->wq_dev;
3251
3252 if (!wq->wq_dev)
3253 return;
3254
3255 wq->wq_dev = NULL;
3256 device_unregister(&wq_dev->dev);
3257}
3258#else /* CONFIG_SYSFS */
3259static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
3260#endif /* CONFIG_SYSFS */
3261
Tejun Heo7a4e3442013-03-12 11:30:00 -07003262/**
3263 * free_workqueue_attrs - free a workqueue_attrs
3264 * @attrs: workqueue_attrs to free
3265 *
3266 * Undo alloc_workqueue_attrs().
3267 */
3268void free_workqueue_attrs(struct workqueue_attrs *attrs)
3269{
3270 if (attrs) {
3271 free_cpumask_var(attrs->cpumask);
3272 kfree(attrs);
3273 }
3274}
3275
3276/**
3277 * alloc_workqueue_attrs - allocate a workqueue_attrs
3278 * @gfp_mask: allocation mask to use
3279 *
3280 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003281 * return it.
3282 *
3283 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003284 */
3285struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3286{
3287 struct workqueue_attrs *attrs;
3288
3289 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3290 if (!attrs)
3291 goto fail;
3292 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3293 goto fail;
3294
Tejun Heo13e2e552013-04-01 11:23:31 -07003295 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003296 return attrs;
3297fail:
3298 free_workqueue_attrs(attrs);
3299 return NULL;
3300}
3301
Tejun Heo29c91e92013-03-12 11:30:03 -07003302static void copy_workqueue_attrs(struct workqueue_attrs *to,
3303 const struct workqueue_attrs *from)
3304{
3305 to->nice = from->nice;
3306 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003307 /*
3308 * Unlike hash and equality test, this function doesn't ignore
3309 * ->no_numa as it is used for both pool and wq attrs. Instead,
3310 * get_unbound_pool() explicitly clears ->no_numa after copying.
3311 */
3312 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003313}
3314
Tejun Heo29c91e92013-03-12 11:30:03 -07003315/* hash value of the content of @attr */
3316static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3317{
3318 u32 hash = 0;
3319
3320 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003321 hash = jhash(cpumask_bits(attrs->cpumask),
3322 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003323 return hash;
3324}
3325
3326/* content equality test */
3327static bool wqattrs_equal(const struct workqueue_attrs *a,
3328 const struct workqueue_attrs *b)
3329{
3330 if (a->nice != b->nice)
3331 return false;
3332 if (!cpumask_equal(a->cpumask, b->cpumask))
3333 return false;
3334 return true;
3335}
3336
Tejun Heo7a4e3442013-03-12 11:30:00 -07003337/**
3338 * init_worker_pool - initialize a newly zalloc'd worker_pool
3339 * @pool: worker_pool to initialize
3340 *
3341 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003342 *
3343 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003344 * inside @pool proper are initialized and put_unbound_pool() can be called
3345 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003346 */
3347static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003348{
3349 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003350 pool->id = -1;
3351 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003352 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003353 pool->flags |= POOL_DISASSOCIATED;
3354 INIT_LIST_HEAD(&pool->worklist);
3355 INIT_LIST_HEAD(&pool->idle_list);
3356 hash_init(pool->busy_hash);
3357
3358 init_timer_deferrable(&pool->idle_timer);
3359 pool->idle_timer.function = idle_worker_timeout;
3360 pool->idle_timer.data = (unsigned long)pool;
3361
3362 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3363 (unsigned long)pool);
3364
3365 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003366 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003367 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003368
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003369 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003370 INIT_HLIST_NODE(&pool->hash_node);
3371 pool->refcnt = 1;
3372
3373 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003374 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3375 if (!pool->attrs)
3376 return -ENOMEM;
3377 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003378}
3379
Tejun Heo29c91e92013-03-12 11:30:03 -07003380static void rcu_free_pool(struct rcu_head *rcu)
3381{
3382 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3383
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003384 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003385 free_workqueue_attrs(pool->attrs);
3386 kfree(pool);
3387}
3388
3389/**
3390 * put_unbound_pool - put a worker_pool
3391 * @pool: worker_pool to put
3392 *
3393 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003394 * safe manner. get_unbound_pool() calls this function on its failure path
3395 * and this function should be able to release pools which went through,
3396 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003397 *
3398 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003399 */
3400static void put_unbound_pool(struct worker_pool *pool)
3401{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003402 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003403 struct worker *worker;
3404
Tejun Heoa892cac2013-04-01 11:23:32 -07003405 lockdep_assert_held(&wq_pool_mutex);
3406
3407 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003408 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003409
3410 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003411 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003412 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003413 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003414
3415 /* release id and unhash */
3416 if (pool->id >= 0)
3417 idr_remove(&worker_pool_idr, pool->id);
3418 hash_del(&pool->hash_node);
3419
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003420 /*
3421 * Become the manager and destroy all workers. Grabbing
3422 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003423 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003424 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003425 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003426
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003427 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003428 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003429 destroy_worker(worker);
3430 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003431 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003432
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003433 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003434 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003435 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003436 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003437
3438 if (pool->detach_completion)
3439 wait_for_completion(pool->detach_completion);
3440
Tejun Heo29c91e92013-03-12 11:30:03 -07003441 mutex_unlock(&pool->manager_arb);
3442
3443 /* shut down the timers */
3444 del_timer_sync(&pool->idle_timer);
3445 del_timer_sync(&pool->mayday_timer);
3446
3447 /* sched-RCU protected to allow dereferences from get_work_pool() */
3448 call_rcu_sched(&pool->rcu, rcu_free_pool);
3449}
3450
3451/**
3452 * get_unbound_pool - get a worker_pool with the specified attributes
3453 * @attrs: the attributes of the worker_pool to get
3454 *
3455 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3456 * reference count and return it. If there already is a matching
3457 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003458 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003459 *
3460 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003461 *
3462 * Return: On success, a worker_pool with the same attributes as @attrs.
3463 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003464 */
3465static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3466{
Tejun Heo29c91e92013-03-12 11:30:03 -07003467 u32 hash = wqattrs_hash(attrs);
3468 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003469 int node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003470
Tejun Heoa892cac2013-04-01 11:23:32 -07003471 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003472
3473 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003474 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3475 if (wqattrs_equal(pool->attrs, attrs)) {
3476 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003477 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003478 }
3479 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003480
3481 /* nope, create a new one */
3482 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3483 if (!pool || init_worker_pool(pool) < 0)
3484 goto fail;
3485
Tejun Heo8864b4e2013-03-12 11:30:04 -07003486 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003487 copy_workqueue_attrs(pool->attrs, attrs);
3488
Shaohua Li2865a8f2013-08-01 09:56:36 +08003489 /*
3490 * no_numa isn't a worker_pool attribute, always clear it. See
3491 * 'struct workqueue_attrs' comments for detail.
3492 */
3493 pool->attrs->no_numa = false;
3494
Tejun Heof3f90ad2013-04-01 11:23:34 -07003495 /* if cpumask is contained inside a NUMA node, we belong to that node */
3496 if (wq_numa_enabled) {
3497 for_each_node(node) {
3498 if (cpumask_subset(pool->attrs->cpumask,
3499 wq_numa_possible_cpumask[node])) {
3500 pool->node = node;
3501 break;
3502 }
3503 }
3504 }
3505
Tejun Heo29c91e92013-03-12 11:30:03 -07003506 if (worker_pool_assign_id(pool) < 0)
3507 goto fail;
3508
3509 /* create and start the initial worker */
Lai Jiangshan051e1852014-07-22 13:03:02 +08003510 if (!create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003511 goto fail;
3512
Tejun Heo29c91e92013-03-12 11:30:03 -07003513 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003514 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003515
Tejun Heo29c91e92013-03-12 11:30:03 -07003516 return pool;
3517fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003518 if (pool)
3519 put_unbound_pool(pool);
3520 return NULL;
3521}
3522
Tejun Heo8864b4e2013-03-12 11:30:04 -07003523static void rcu_free_pwq(struct rcu_head *rcu)
3524{
3525 kmem_cache_free(pwq_cache,
3526 container_of(rcu, struct pool_workqueue, rcu));
3527}
3528
3529/*
3530 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3531 * and needs to be destroyed.
3532 */
3533static void pwq_unbound_release_workfn(struct work_struct *work)
3534{
3535 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3536 unbound_release_work);
3537 struct workqueue_struct *wq = pwq->wq;
3538 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003539 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003540
3541 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3542 return;
3543
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003544 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003545 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003546 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003547 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003548
Tejun Heoa892cac2013-04-01 11:23:32 -07003549 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003550 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003551 mutex_unlock(&wq_pool_mutex);
3552
Tejun Heo8864b4e2013-03-12 11:30:04 -07003553 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3554
3555 /*
3556 * If we're the last pwq going away, @wq is already dead and no one
3557 * is gonna access it anymore. Free it.
3558 */
Tejun Heo6029a912013-04-01 11:23:34 -07003559 if (is_last) {
3560 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003561 kfree(wq);
Tejun Heo6029a912013-04-01 11:23:34 -07003562 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003563}
3564
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003565/**
Tejun Heo699ce092013-03-13 16:51:35 -07003566 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003567 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003568 *
Tejun Heo699ce092013-03-13 16:51:35 -07003569 * If @pwq isn't freezing, set @pwq->max_active to the associated
3570 * workqueue's saved_max_active and activate delayed work items
3571 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003572 */
Tejun Heo699ce092013-03-13 16:51:35 -07003573static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003574{
Tejun Heo699ce092013-03-13 16:51:35 -07003575 struct workqueue_struct *wq = pwq->wq;
3576 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003577
Tejun Heo699ce092013-03-13 16:51:35 -07003578 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003579 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003580
3581 /* fast exit for non-freezable wqs */
3582 if (!freezable && pwq->max_active == wq->saved_max_active)
3583 return;
3584
Lai Jiangshana357fc02013-03-25 16:57:19 -07003585 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003586
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003587 /*
3588 * During [un]freezing, the caller is responsible for ensuring that
3589 * this function is called at least once after @workqueue_freezing
3590 * is updated and visible.
3591 */
3592 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003593 pwq->max_active = wq->saved_max_active;
3594
3595 while (!list_empty(&pwq->delayed_works) &&
3596 pwq->nr_active < pwq->max_active)
3597 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003598
3599 /*
3600 * Need to kick a worker after thawed or an unbound wq's
3601 * max_active is bumped. It's a slow path. Do it always.
3602 */
3603 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003604 } else {
3605 pwq->max_active = 0;
3606 }
3607
Lai Jiangshana357fc02013-03-25 16:57:19 -07003608 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003609}
3610
Tejun Heoe50aba92013-04-01 11:23:35 -07003611/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003612static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3613 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003614{
3615 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3616
Tejun Heoe50aba92013-04-01 11:23:35 -07003617 memset(pwq, 0, sizeof(*pwq));
3618
Tejun Heod2c1d402013-03-12 11:30:04 -07003619 pwq->pool = pool;
3620 pwq->wq = wq;
3621 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003622 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003623 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003624 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003625 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003626 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003627}
Tejun Heod2c1d402013-03-12 11:30:04 -07003628
Tejun Heof147f292013-04-01 11:23:35 -07003629/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003630static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003631{
3632 struct workqueue_struct *wq = pwq->wq;
3633
3634 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003635
Tejun Heo1befcf32013-04-01 11:23:35 -07003636 /* may be called multiple times, ignore if already linked */
3637 if (!list_empty(&pwq->pwqs_node))
3638 return;
3639
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003640 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003641 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003642
3643 /* sync max_active to the current setting */
3644 pwq_adjust_max_active(pwq);
3645
3646 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003647 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003648}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003649
Tejun Heof147f292013-04-01 11:23:35 -07003650/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3651static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3652 const struct workqueue_attrs *attrs)
3653{
3654 struct worker_pool *pool;
3655 struct pool_workqueue *pwq;
3656
3657 lockdep_assert_held(&wq_pool_mutex);
3658
3659 pool = get_unbound_pool(attrs);
3660 if (!pool)
3661 return NULL;
3662
Tejun Heoe50aba92013-04-01 11:23:35 -07003663 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003664 if (!pwq) {
3665 put_unbound_pool(pool);
3666 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003667 }
Tejun Heo6029a912013-04-01 11:23:34 -07003668
Tejun Heof147f292013-04-01 11:23:35 -07003669 init_pwq(pwq, wq, pool);
3670 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003671}
3672
Tejun Heo4c16bd32013-04-01 11:23:36 -07003673/* undo alloc_unbound_pwq(), used only in the error path */
3674static void free_unbound_pwq(struct pool_workqueue *pwq)
3675{
3676 lockdep_assert_held(&wq_pool_mutex);
3677
3678 if (pwq) {
3679 put_unbound_pool(pwq->pool);
Wei Yongjuncece95d2013-04-09 14:29:11 +08003680 kmem_cache_free(pwq_cache, pwq);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003681 }
3682}
3683
3684/**
3685 * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node
3686 * @attrs: the wq_attrs of interest
3687 * @node: the target NUMA node
3688 * @cpu_going_down: if >= 0, the CPU to consider as offline
3689 * @cpumask: outarg, the resulting cpumask
3690 *
3691 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3692 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003693 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003694 *
3695 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3696 * enabled and @node has online CPUs requested by @attrs, the returned
3697 * cpumask is the intersection of the possible CPUs of @node and
3698 * @attrs->cpumask.
3699 *
3700 * The caller is responsible for ensuring that the cpumask of @node stays
3701 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003702 *
3703 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3704 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003705 */
3706static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3707 int cpu_going_down, cpumask_t *cpumask)
3708{
Tejun Heod55262c2013-04-01 11:23:38 -07003709 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003710 goto use_dfl;
3711
3712 /* does @node have any online CPUs @attrs wants? */
3713 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3714 if (cpu_going_down >= 0)
3715 cpumask_clear_cpu(cpu_going_down, cpumask);
3716
3717 if (cpumask_empty(cpumask))
3718 goto use_dfl;
3719
3720 /* yeap, return possible CPUs in @node that @attrs wants */
3721 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3722 return !cpumask_equal(cpumask, attrs->cpumask);
3723
3724use_dfl:
3725 cpumask_copy(cpumask, attrs->cpumask);
3726 return false;
3727}
3728
Tejun Heo1befcf32013-04-01 11:23:35 -07003729/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3730static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3731 int node,
3732 struct pool_workqueue *pwq)
3733{
3734 struct pool_workqueue *old_pwq;
3735
3736 lockdep_assert_held(&wq->mutex);
3737
3738 /* link_pwq() can handle duplicate calls */
3739 link_pwq(pwq);
3740
3741 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3742 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3743 return old_pwq;
3744}
3745
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003746/**
3747 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3748 * @wq: the target workqueue
3749 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3750 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003751 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3752 * machines, this function maps a separate pwq to each NUMA node with
3753 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3754 * NUMA node it was issued on. Older pwqs are released as in-flight work
3755 * items finish. Note that a work item which repeatedly requeues itself
3756 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003757 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003758 * Performs GFP_KERNEL allocations.
3759 *
3760 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003761 */
3762int apply_workqueue_attrs(struct workqueue_struct *wq,
3763 const struct workqueue_attrs *attrs)
3764{
Tejun Heo4c16bd32013-04-01 11:23:36 -07003765 struct workqueue_attrs *new_attrs, *tmp_attrs;
3766 struct pool_workqueue **pwq_tbl, *dfl_pwq;
Tejun Heof147f292013-04-01 11:23:35 -07003767 int node, ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003768
Tejun Heo8719dce2013-03-12 11:30:04 -07003769 /* only unbound workqueues can change attributes */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003770 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3771 return -EINVAL;
3772
Tejun Heo8719dce2013-03-12 11:30:04 -07003773 /* creating multiple pwqs breaks ordering guarantee */
3774 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3775 return -EINVAL;
3776
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003777 pwq_tbl = kzalloc(nr_node_ids * sizeof(pwq_tbl[0]), GFP_KERNEL);
Tejun Heo13e2e552013-04-01 11:23:31 -07003778 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003779 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3780 if (!pwq_tbl || !new_attrs || !tmp_attrs)
Tejun Heo13e2e552013-04-01 11:23:31 -07003781 goto enomem;
3782
Tejun Heo4c16bd32013-04-01 11:23:36 -07003783 /* make a copy of @attrs and sanitize it */
Tejun Heo13e2e552013-04-01 11:23:31 -07003784 copy_workqueue_attrs(new_attrs, attrs);
3785 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
3786
Tejun Heo4c16bd32013-04-01 11:23:36 -07003787 /*
3788 * We may create multiple pwqs with differing cpumasks. Make a
3789 * copy of @new_attrs which will be modified and used to obtain
3790 * pools.
3791 */
3792 copy_workqueue_attrs(tmp_attrs, new_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003793
Tejun Heo4c16bd32013-04-01 11:23:36 -07003794 /*
3795 * CPUs should stay stable across pwq creations and installations.
3796 * Pin CPUs, determine the target cpumask for each node and create
3797 * pwqs accordingly.
3798 */
3799 get_online_cpus();
3800
3801 mutex_lock(&wq_pool_mutex);
3802
3803 /*
3804 * If something goes wrong during CPU up/down, we'll fall back to
3805 * the default pwq covering whole @attrs->cpumask. Always create
3806 * it even if we don't use it immediately.
3807 */
3808 dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3809 if (!dfl_pwq)
3810 goto enomem_pwq;
3811
3812 for_each_node(node) {
3813 if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) {
3814 pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3815 if (!pwq_tbl[node])
3816 goto enomem_pwq;
3817 } else {
3818 dfl_pwq->refcnt++;
3819 pwq_tbl[node] = dfl_pwq;
3820 }
3821 }
3822
3823 mutex_unlock(&wq_pool_mutex);
3824
3825 /* all pwqs have been created successfully, let's install'em */
Tejun Heof147f292013-04-01 11:23:35 -07003826 mutex_lock(&wq->mutex);
3827
Tejun Heof147f292013-04-01 11:23:35 -07003828 copy_workqueue_attrs(wq->unbound_attrs, new_attrs);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003829
3830 /* save the previous pwq and install the new one */
Tejun Heof147f292013-04-01 11:23:35 -07003831 for_each_node(node)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003832 pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]);
3833
3834 /* @dfl_pwq might not have been used, ensure it's linked */
3835 link_pwq(dfl_pwq);
3836 swap(wq->dfl_pwq, dfl_pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003837
3838 mutex_unlock(&wq->mutex);
3839
Tejun Heo4c16bd32013-04-01 11:23:36 -07003840 /* put the old pwqs */
3841 for_each_node(node)
3842 put_pwq_unlocked(pwq_tbl[node]);
3843 put_pwq_unlocked(dfl_pwq);
3844
3845 put_online_cpus();
Tejun Heo48621252013-04-01 11:23:31 -07003846 ret = 0;
3847 /* fall through */
3848out_free:
Tejun Heo4c16bd32013-04-01 11:23:36 -07003849 free_workqueue_attrs(tmp_attrs);
Tejun Heo48621252013-04-01 11:23:31 -07003850 free_workqueue_attrs(new_attrs);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003851 kfree(pwq_tbl);
Tejun Heo48621252013-04-01 11:23:31 -07003852 return ret;
Tejun Heo13e2e552013-04-01 11:23:31 -07003853
Tejun Heo4c16bd32013-04-01 11:23:36 -07003854enomem_pwq:
3855 free_unbound_pwq(dfl_pwq);
3856 for_each_node(node)
3857 if (pwq_tbl && pwq_tbl[node] != dfl_pwq)
3858 free_unbound_pwq(pwq_tbl[node]);
3859 mutex_unlock(&wq_pool_mutex);
3860 put_online_cpus();
Tejun Heo13e2e552013-04-01 11:23:31 -07003861enomem:
Tejun Heo48621252013-04-01 11:23:31 -07003862 ret = -ENOMEM;
3863 goto out_free;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003864}
3865
Tejun Heo4c16bd32013-04-01 11:23:36 -07003866/**
3867 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3868 * @wq: the target workqueue
3869 * @cpu: the CPU coming up or going down
3870 * @online: whether @cpu is coming up or going down
3871 *
3872 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3873 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3874 * @wq accordingly.
3875 *
3876 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3877 * falls back to @wq->dfl_pwq which may not be optimal but is always
3878 * correct.
3879 *
3880 * Note that when the last allowed CPU of a NUMA node goes offline for a
3881 * workqueue with a cpumask spanning multiple nodes, the workers which were
3882 * already executing the work items for the workqueue will lose their CPU
3883 * affinity and may execute on any CPU. This is similar to how per-cpu
3884 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3885 * affinity, it's the user's responsibility to flush the work item from
3886 * CPU_DOWN_PREPARE.
3887 */
3888static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3889 bool online)
3890{
3891 int node = cpu_to_node(cpu);
3892 int cpu_off = online ? -1 : cpu;
3893 struct pool_workqueue *old_pwq = NULL, *pwq;
3894 struct workqueue_attrs *target_attrs;
3895 cpumask_t *cpumask;
3896
3897 lockdep_assert_held(&wq_pool_mutex);
3898
3899 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
3900 return;
3901
3902 /*
3903 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3904 * Let's use a preallocated one. The following buf is protected by
3905 * CPU hotplug exclusion.
3906 */
3907 target_attrs = wq_update_unbound_numa_attrs_buf;
3908 cpumask = target_attrs->cpumask;
3909
3910 mutex_lock(&wq->mutex);
Tejun Heod55262c2013-04-01 11:23:38 -07003911 if (wq->unbound_attrs->no_numa)
3912 goto out_unlock;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003913
3914 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3915 pwq = unbound_pwq_by_node(wq, node);
3916
3917 /*
3918 * Let's determine what needs to be done. If the target cpumask is
3919 * different from wq's, we need to compare it to @pwq's and create
3920 * a new one if they don't match. If the target cpumask equals
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003921 * wq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003922 */
3923 if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) {
3924 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
3925 goto out_unlock;
3926 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003927 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003928 }
3929
3930 mutex_unlock(&wq->mutex);
3931
3932 /* create a new pwq */
3933 pwq = alloc_unbound_pwq(wq, target_attrs);
3934 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003935 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3936 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003937 mutex_lock(&wq->mutex);
3938 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003939 }
3940
3941 /*
3942 * Install the new pwq. As this function is called only from CPU
3943 * hotplug callbacks and applying a new attrs is wrapped with
3944 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
3945 * inbetween.
3946 */
3947 mutex_lock(&wq->mutex);
3948 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3949 goto out_unlock;
3950
3951use_dfl_pwq:
3952 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3953 get_pwq(wq->dfl_pwq);
3954 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3955 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3956out_unlock:
3957 mutex_unlock(&wq->mutex);
3958 put_pwq_unlocked(old_pwq);
3959}
3960
Tejun Heo30cdf2492013-03-12 11:29:57 -07003961static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003962{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003963 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003964 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003965
Tejun Heo30cdf2492013-03-12 11:29:57 -07003966 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003967 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3968 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07003969 return -ENOMEM;
3970
3971 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003972 struct pool_workqueue *pwq =
3973 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003974 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003975 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003976
Tejun Heof147f292013-04-01 11:23:35 -07003977 init_pwq(pwq, wq, &cpu_pools[highpri]);
3978
3979 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003980 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003981 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003982 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003983 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003984 } else if (wq->flags & __WQ_ORDERED) {
3985 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3986 /* there should only be single pwq for ordering guarantee */
3987 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3988 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3989 "ordering guarantee broken for workqueue %s\n", wq->name);
3990 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07003991 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003992 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003993 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003994}
3995
Tejun Heof3421792010-07-02 10:03:51 +02003996static int wq_clamp_max_active(int max_active, unsigned int flags,
3997 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003998{
Tejun Heof3421792010-07-02 10:03:51 +02003999 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4000
4001 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004002 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4003 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004004
Tejun Heof3421792010-07-02 10:03:51 +02004005 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004006}
4007
Tejun Heob196be82012-01-10 15:11:35 -08004008struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02004009 unsigned int flags,
4010 int max_active,
4011 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08004012 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004013{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004014 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004015 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004016 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004017 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004018
Viresh Kumarcee22a12013-04-08 16:45:40 +05304019 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4020 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4021 flags |= WQ_UNBOUND;
4022
Tejun Heoecf68812013-04-01 11:23:34 -07004023 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004024 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004025 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004026
4027 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004028 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004029 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004030
Tejun Heo6029a912013-04-01 11:23:34 -07004031 if (flags & WQ_UNBOUND) {
4032 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4033 if (!wq->unbound_attrs)
4034 goto err_free_wq;
4035 }
4036
Tejun Heoecf68812013-04-01 11:23:34 -07004037 va_start(args, lock_name);
4038 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004039 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004040
Tejun Heod320c032010-06-29 10:07:14 +02004041 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004042 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004043
Tejun Heob196be82012-01-10 15:11:35 -08004044 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004045 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004046 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004047 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004048 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004049 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004050 INIT_LIST_HEAD(&wq->flusher_queue);
4051 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004052 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004053
Johannes Bergeb13ba82008-01-16 09:51:58 +01004054 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004055 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004056
Tejun Heo30cdf2492013-03-12 11:29:57 -07004057 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004058 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004059
Tejun Heo493008a2013-03-12 11:30:03 -07004060 /*
4061 * Workqueues which may be used during memory reclaim should
4062 * have a rescuer to guarantee forward progress.
4063 */
4064 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004065 struct worker *rescuer;
4066
Lai Jiangshanf7537df2014-07-15 17:24:15 +08004067 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02004068 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004069 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004070
Tejun Heo111c2252013-01-17 17:16:24 -08004071 rescuer->rescue_wq = wq;
4072 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004073 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004074 if (IS_ERR(rescuer->task)) {
4075 kfree(rescuer);
4076 goto err_destroy;
4077 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004078
Tejun Heod2c1d402013-03-12 11:30:04 -07004079 wq->rescuer = rescuer;
Tejun Heo14a40ff2013-03-19 13:45:20 -07004080 rescuer->task->flags |= PF_NO_SETAFFINITY;
Tejun Heoe22bee72010-06-29 10:07:14 +02004081 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004082 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004083
Tejun Heo226223a2013-03-12 11:30:05 -07004084 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4085 goto err_destroy;
4086
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004087 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004088 * wq_pool_mutex protects global freeze state and workqueues list.
4089 * Grab it, adjust max_active and add the new @wq to workqueues
4090 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004091 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004092 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004093
Lai Jiangshana357fc02013-03-25 16:57:19 -07004094 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004095 for_each_pwq(pwq, wq)
4096 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004097 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004098
Tejun Heo15376632010-06-29 10:07:11 +02004099 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004100
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004101 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004102
Oleg Nesterov3af244332007-05-09 02:34:09 -07004103 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004104
4105err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004106 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004107 kfree(wq);
4108 return NULL;
4109err_destroy:
4110 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004111 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004112}
Tejun Heod320c032010-06-29 10:07:14 +02004113EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004114
4115/**
4116 * destroy_workqueue - safely terminate a workqueue
4117 * @wq: target workqueue
4118 *
4119 * Safely destroy a workqueue. All work currently pending will be done first.
4120 */
4121void destroy_workqueue(struct workqueue_struct *wq)
4122{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004123 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004124 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004125
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004126 /* drain it before proceeding with destruction */
4127 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004128
Tejun Heo6183c002013-03-12 11:29:57 -07004129 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004130 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004131 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004132 int i;
4133
Tejun Heo76af4d92013-03-12 11:30:00 -07004134 for (i = 0; i < WORK_NR_COLORS; i++) {
4135 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004136 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004137 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004138 }
4139 }
4140
Lai Jiangshan5c529592013-04-04 10:05:38 +08004141 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004142 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004143 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004144 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004145 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004146 }
Tejun Heo6183c002013-03-12 11:29:57 -07004147 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004148 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004149
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004150 /*
4151 * wq list is used to freeze wq, remove from list after
4152 * flushing is complete in case freeze races us.
4153 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004154 mutex_lock(&wq_pool_mutex);
Tejun Heod2c1d402013-03-12 11:30:04 -07004155 list_del_init(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004156 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004157
Tejun Heo226223a2013-03-12 11:30:05 -07004158 workqueue_sysfs_unregister(wq);
4159
Tejun Heo493008a2013-03-12 11:30:03 -07004160 if (wq->rescuer) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004161 kthread_stop(wq->rescuer->task);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02004162 kfree(wq->rescuer);
Tejun Heo493008a2013-03-12 11:30:03 -07004163 wq->rescuer = NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +02004164 }
4165
Tejun Heo8864b4e2013-03-12 11:30:04 -07004166 if (!(wq->flags & WQ_UNBOUND)) {
4167 /*
4168 * The base ref is never dropped on per-cpu pwqs. Directly
4169 * free the pwqs and wq.
4170 */
4171 free_percpu(wq->cpu_pwqs);
4172 kfree(wq);
4173 } else {
4174 /*
4175 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004176 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4177 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004178 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004179 for_each_node(node) {
4180 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4181 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4182 put_pwq_unlocked(pwq);
4183 }
4184
4185 /*
4186 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4187 * put. Don't access it afterwards.
4188 */
4189 pwq = wq->dfl_pwq;
4190 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004191 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004192 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004193}
4194EXPORT_SYMBOL_GPL(destroy_workqueue);
4195
Tejun Heodcd989c2010-06-29 10:07:14 +02004196/**
4197 * workqueue_set_max_active - adjust max_active of a workqueue
4198 * @wq: target workqueue
4199 * @max_active: new max_active value.
4200 *
4201 * Set max_active of @wq to @max_active.
4202 *
4203 * CONTEXT:
4204 * Don't call from IRQ context.
4205 */
4206void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4207{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004208 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004209
Tejun Heo8719dce2013-03-12 11:30:04 -07004210 /* disallow meddling with max_active for ordered workqueues */
4211 if (WARN_ON(wq->flags & __WQ_ORDERED))
4212 return;
4213
Tejun Heof3421792010-07-02 10:03:51 +02004214 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004215
Lai Jiangshana357fc02013-03-25 16:57:19 -07004216 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004217
4218 wq->saved_max_active = max_active;
4219
Tejun Heo699ce092013-03-13 16:51:35 -07004220 for_each_pwq(pwq, wq)
4221 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004222
Lai Jiangshana357fc02013-03-25 16:57:19 -07004223 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004224}
4225EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4226
4227/**
Tejun Heoe62676162013-03-12 17:41:37 -07004228 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4229 *
4230 * Determine whether %current is a workqueue rescuer. Can be used from
4231 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004232 *
4233 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004234 */
4235bool current_is_workqueue_rescuer(void)
4236{
4237 struct worker *worker = current_wq_worker();
4238
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004239 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004240}
4241
4242/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004243 * workqueue_congested - test whether a workqueue is congested
4244 * @cpu: CPU in question
4245 * @wq: target workqueue
4246 *
4247 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4248 * no synchronization around this function and the test result is
4249 * unreliable and only useful as advisory hints or for debugging.
4250 *
Tejun Heod3251852013-05-10 11:10:17 -07004251 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4252 * Note that both per-cpu and unbound workqueues may be associated with
4253 * multiple pool_workqueues which have separate congested states. A
4254 * workqueue being congested on one CPU doesn't mean the workqueue is also
4255 * contested on other CPUs / NUMA nodes.
4256 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004257 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004258 * %true if congested, %false otherwise.
4259 */
Tejun Heod84ff052013-03-12 11:29:59 -07004260bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004261{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004262 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004263 bool ret;
4264
Lai Jiangshan88109452013-03-20 03:28:10 +08004265 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004266
Tejun Heod3251852013-05-10 11:10:17 -07004267 if (cpu == WORK_CPU_UNBOUND)
4268 cpu = smp_processor_id();
4269
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004270 if (!(wq->flags & WQ_UNBOUND))
4271 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4272 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004273 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004274
Tejun Heo76af4d92013-03-12 11:30:00 -07004275 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004276 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004277
4278 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004279}
4280EXPORT_SYMBOL_GPL(workqueue_congested);
4281
4282/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004283 * work_busy - test whether a work is currently pending or running
4284 * @work: the work to be tested
4285 *
4286 * Test whether @work is currently pending or running. There is no
4287 * synchronization around this function and the test result is
4288 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004289 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004290 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004291 * OR'd bitmask of WORK_BUSY_* bits.
4292 */
4293unsigned int work_busy(struct work_struct *work)
4294{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004295 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004296 unsigned long flags;
4297 unsigned int ret = 0;
4298
Tejun Heodcd989c2010-06-29 10:07:14 +02004299 if (work_pending(work))
4300 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004301
Tejun Heofa1b54e2013-03-12 11:30:00 -07004302 local_irq_save(flags);
4303 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004304 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004305 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004306 if (find_worker_executing_work(pool, work))
4307 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004308 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004309 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004310 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004311
4312 return ret;
4313}
4314EXPORT_SYMBOL_GPL(work_busy);
4315
Tejun Heo3d1cb202013-04-30 15:27:22 -07004316/**
4317 * set_worker_desc - set description for the current work item
4318 * @fmt: printf-style format string
4319 * @...: arguments for the format string
4320 *
4321 * This function can be called by a running work function to describe what
4322 * the work item is about. If the worker task gets dumped, this
4323 * information will be printed out together to help debugging. The
4324 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4325 */
4326void set_worker_desc(const char *fmt, ...)
4327{
4328 struct worker *worker = current_wq_worker();
4329 va_list args;
4330
4331 if (worker) {
4332 va_start(args, fmt);
4333 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4334 va_end(args);
4335 worker->desc_valid = true;
4336 }
4337}
4338
4339/**
4340 * print_worker_info - print out worker information and description
4341 * @log_lvl: the log level to use when printing
4342 * @task: target task
4343 *
4344 * If @task is a worker and currently executing a work item, print out the
4345 * name of the workqueue being serviced and worker description set with
4346 * set_worker_desc() by the currently executing work item.
4347 *
4348 * This function can be safely called on any task as long as the
4349 * task_struct itself is accessible. While safe, this function isn't
4350 * synchronized and may print out mixups or garbages of limited length.
4351 */
4352void print_worker_info(const char *log_lvl, struct task_struct *task)
4353{
4354 work_func_t *fn = NULL;
4355 char name[WQ_NAME_LEN] = { };
4356 char desc[WORKER_DESC_LEN] = { };
4357 struct pool_workqueue *pwq = NULL;
4358 struct workqueue_struct *wq = NULL;
4359 bool desc_valid = false;
4360 struct worker *worker;
4361
4362 if (!(task->flags & PF_WQ_WORKER))
4363 return;
4364
4365 /*
4366 * This function is called without any synchronization and @task
4367 * could be in any state. Be careful with dereferences.
4368 */
4369 worker = probe_kthread_data(task);
4370
4371 /*
4372 * Carefully copy the associated workqueue's workfn and name. Keep
4373 * the original last '\0' in case the original contains garbage.
4374 */
4375 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4376 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4377 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4378 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4379
4380 /* copy worker description */
4381 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4382 if (desc_valid)
4383 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4384
4385 if (fn || name[0] || desc[0]) {
4386 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4387 if (desc[0])
4388 pr_cont(" (%s)", desc);
4389 pr_cont("\n");
4390 }
4391}
4392
Tejun Heodb7bccf2010-06-29 10:07:12 +02004393/*
4394 * CPU hotplug.
4395 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004396 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004397 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004398 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004399 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004400 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004401 * blocked draining impractical.
4402 *
Tejun Heo24647572013-01-24 11:01:33 -08004403 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004404 * running as an unbound one and allowing it to be reattached later if the
4405 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004406 */
4407
Tejun Heo706026c2013-01-24 11:01:34 -08004408static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004409{
Tejun Heo38db41d2013-01-24 11:01:34 -08004410 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004411 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004412 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004413
Tejun Heof02ae732013-03-12 11:30:03 -07004414 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004415 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004416 spin_lock_irq(&pool->lock);
4417
4418 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004419 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004420 * unbound and set DISASSOCIATED. Before this, all workers
4421 * except for the ones which are still executing works from
4422 * before the last CPU down must be on the cpu. After
4423 * this, they may become diasporas.
4424 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004425 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004426 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004427
Tejun Heo24647572013-01-24 11:01:33 -08004428 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004429
Tejun Heo94cf58b2013-01-24 11:01:33 -08004430 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004431 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004432
Lai Jiangshaneb283422013-03-08 15:18:28 -08004433 /*
4434 * Call schedule() so that we cross rq->lock and thus can
4435 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4436 * This is necessary as scheduler callbacks may be invoked
4437 * from other cpus.
4438 */
4439 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004440
Lai Jiangshaneb283422013-03-08 15:18:28 -08004441 /*
4442 * Sched callbacks are disabled now. Zap nr_running.
4443 * After this, nr_running stays zero and need_more_worker()
4444 * and keep_working() are always true as long as the
4445 * worklist is not empty. This pool now behaves as an
4446 * unbound (in terms of concurrency management) pool which
4447 * are served by workers tied to the pool.
4448 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004449 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004450
4451 /*
4452 * With concurrency management just turned off, a busy
4453 * worker blocking could lead to lengthy stalls. Kick off
4454 * unbound chain execution of currently pending work items.
4455 */
4456 spin_lock_irq(&pool->lock);
4457 wake_up_worker(pool);
4458 spin_unlock_irq(&pool->lock);
4459 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004460}
4461
Tejun Heobd7c0892013-03-19 13:45:21 -07004462/**
4463 * rebind_workers - rebind all workers of a pool to the associated CPU
4464 * @pool: pool of interest
4465 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004466 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004467 */
4468static void rebind_workers(struct worker_pool *pool)
4469{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004470 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004471
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004472 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004473
Tejun Heoa9ab7752013-03-19 13:45:21 -07004474 /*
4475 * Restore CPU affinity of all workers. As all idle workers should
4476 * be on the run-queue of the associated CPU before any local
4477 * wake-ups for concurrency management happen, restore CPU affinty
4478 * of all workers first and then clear UNBOUND. As we're called
4479 * from CPU_ONLINE, the following shouldn't fail.
4480 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004481 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004482 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4483 pool->attrs->cpumask) < 0);
4484
4485 spin_lock_irq(&pool->lock);
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004486 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004487
Lai Jiangshanda028462014-05-20 17:46:31 +08004488 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004489 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004490
4491 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004492 * A bound idle worker should actually be on the runqueue
4493 * of the associated CPU for local wake-ups targeting it to
4494 * work. Kick all idle workers so that they migrate to the
4495 * associated CPU. Doing this in the same loop as
4496 * replacing UNBOUND with REBOUND is safe as no worker will
4497 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004498 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004499 if (worker_flags & WORKER_IDLE)
4500 wake_up_process(worker->task);
4501
4502 /*
4503 * We want to clear UNBOUND but can't directly call
4504 * worker_clr_flags() or adjust nr_running. Atomically
4505 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4506 * @worker will clear REBOUND using worker_clr_flags() when
4507 * it initiates the next execution cycle thus restoring
4508 * concurrency management. Note that when or whether
4509 * @worker clears REBOUND doesn't affect correctness.
4510 *
4511 * ACCESS_ONCE() is necessary because @worker->flags may be
4512 * tested without holding any lock in
4513 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4514 * fail incorrectly leading to premature concurrency
4515 * management operations.
4516 */
4517 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4518 worker_flags |= WORKER_REBOUND;
4519 worker_flags &= ~WORKER_UNBOUND;
4520 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004521 }
4522
Tejun Heoa9ab7752013-03-19 13:45:21 -07004523 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004524}
4525
Tejun Heo7dbc7252013-03-19 13:45:21 -07004526/**
4527 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4528 * @pool: unbound pool of interest
4529 * @cpu: the CPU which is coming up
4530 *
4531 * An unbound pool may end up with a cpumask which doesn't have any online
4532 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4533 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4534 * online CPU before, cpus_allowed of all its workers should be restored.
4535 */
4536static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4537{
4538 static cpumask_t cpumask;
4539 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004540
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004541 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004542
4543 /* is @cpu allowed for @pool? */
4544 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4545 return;
4546
4547 /* is @cpu the only online CPU? */
4548 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4549 if (cpumask_weight(&cpumask) != 1)
4550 return;
4551
4552 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004553 for_each_pool_worker(worker, pool)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004554 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4555 pool->attrs->cpumask) < 0);
4556}
4557
Tejun Heo8db25e72012-07-17 12:39:28 -07004558/*
4559 * Workqueues should be brought up before normal priority CPU notifiers.
4560 * This will be registered high priority CPU notifier.
4561 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004562static int workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004563 unsigned long action,
4564 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004565{
Tejun Heod84ff052013-03-12 11:29:59 -07004566 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004567 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004568 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004569 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004570
Tejun Heo8db25e72012-07-17 12:39:28 -07004571 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004572 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004573 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004574 if (pool->nr_workers)
4575 continue;
Lai Jiangshan051e1852014-07-22 13:03:02 +08004576 if (!create_worker(pool))
Tejun Heo3ce63372012-07-17 12:39:27 -07004577 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004578 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004579 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004580
Tejun Heo65758202012-07-17 12:39:26 -07004581 case CPU_DOWN_FAILED:
4582 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004583 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004584
4585 for_each_pool(pool, pi) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004586 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004587
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004588 if (pool->cpu == cpu)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004589 rebind_workers(pool);
Lai Jiangshanf05b5582014-06-03 15:33:27 +08004590 else if (pool->cpu < 0)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004591 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004592
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004593 mutex_unlock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004594 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004595
Tejun Heo4c16bd32013-04-01 11:23:36 -07004596 /* update NUMA affinity of unbound workqueues */
4597 list_for_each_entry(wq, &workqueues, list)
4598 wq_update_unbound_numa(wq, cpu, true);
4599
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004600 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004601 break;
Tejun Heo65758202012-07-17 12:39:26 -07004602 }
4603 return NOTIFY_OK;
4604}
4605
4606/*
4607 * Workqueues should be brought down after normal priority CPU notifiers.
4608 * This will be registered as low priority CPU notifier.
4609 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004610static int workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004611 unsigned long action,
4612 void *hcpu)
4613{
Tejun Heod84ff052013-03-12 11:29:59 -07004614 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004615 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004616 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004617
Tejun Heo65758202012-07-17 12:39:26 -07004618 switch (action & ~CPU_TASKS_FROZEN) {
4619 case CPU_DOWN_PREPARE:
Tejun Heo4c16bd32013-04-01 11:23:36 -07004620 /* unbinding per-cpu workers should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004621 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004622 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004623
4624 /* update NUMA affinity of unbound workqueues */
4625 mutex_lock(&wq_pool_mutex);
4626 list_for_each_entry(wq, &workqueues, list)
4627 wq_update_unbound_numa(wq, cpu, false);
4628 mutex_unlock(&wq_pool_mutex);
4629
4630 /* wait for per-cpu unbinding to finish */
Tejun Heo8db25e72012-07-17 12:39:28 -07004631 flush_work(&unbind_work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004632 destroy_work_on_stack(&unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004633 break;
Tejun Heo65758202012-07-17 12:39:26 -07004634 }
4635 return NOTIFY_OK;
4636}
4637
Rusty Russell2d3854a2008-11-05 13:39:10 +11004638#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004639
Rusty Russell2d3854a2008-11-05 13:39:10 +11004640struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004641 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004642 long (*fn)(void *);
4643 void *arg;
4644 long ret;
4645};
4646
Tejun Heoed48ece2012-09-18 12:48:43 -07004647static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004648{
Tejun Heoed48ece2012-09-18 12:48:43 -07004649 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4650
Rusty Russell2d3854a2008-11-05 13:39:10 +11004651 wfc->ret = wfc->fn(wfc->arg);
4652}
4653
4654/**
4655 * work_on_cpu - run a function in user context on a particular cpu
4656 * @cpu: the cpu to run on
4657 * @fn: the function to run
4658 * @arg: the function arg
4659 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004660 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004661 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004662 *
4663 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004664 */
Tejun Heod84ff052013-03-12 11:29:59 -07004665long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004666{
Tejun Heoed48ece2012-09-18 12:48:43 -07004667 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004668
Tejun Heoed48ece2012-09-18 12:48:43 -07004669 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4670 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004671 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004672 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004673 return wfc.ret;
4674}
4675EXPORT_SYMBOL_GPL(work_on_cpu);
4676#endif /* CONFIG_SMP */
4677
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004678#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304679
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004680/**
4681 * freeze_workqueues_begin - begin freezing workqueues
4682 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004683 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004684 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004685 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004686 *
4687 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004688 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004689 */
4690void freeze_workqueues_begin(void)
4691{
Tejun Heo24b8a842013-03-12 11:29:58 -07004692 struct workqueue_struct *wq;
4693 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004694
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004695 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004696
Tejun Heo6183c002013-03-12 11:29:57 -07004697 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004698 workqueue_freezing = true;
4699
Tejun Heo24b8a842013-03-12 11:29:58 -07004700 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004701 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004702 for_each_pwq(pwq, wq)
4703 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004704 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004705 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004706
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004707 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004708}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004709
4710/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004711 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004712 *
4713 * Check whether freezing is complete. This function must be called
4714 * between freeze_workqueues_begin() and thaw_workqueues().
4715 *
4716 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004717 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004718 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004719 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004720 * %true if some freezable workqueues are still busy. %false if freezing
4721 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004722 */
4723bool freeze_workqueues_busy(void)
4724{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004725 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004726 struct workqueue_struct *wq;
4727 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004728
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004729 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004730
Tejun Heo6183c002013-03-12 11:29:57 -07004731 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004732
Tejun Heo24b8a842013-03-12 11:29:58 -07004733 list_for_each_entry(wq, &workqueues, list) {
4734 if (!(wq->flags & WQ_FREEZABLE))
4735 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004736 /*
4737 * nr_active is monotonically decreasing. It's safe
4738 * to peek without lock.
4739 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004740 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004741 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004742 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004743 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004744 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004745 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004746 goto out_unlock;
4747 }
4748 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004749 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004750 }
4751out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004752 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004753 return busy;
4754}
4755
4756/**
4757 * thaw_workqueues - thaw workqueues
4758 *
4759 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004760 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004761 *
4762 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004763 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004764 */
4765void thaw_workqueues(void)
4766{
Tejun Heo24b8a842013-03-12 11:29:58 -07004767 struct workqueue_struct *wq;
4768 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004769
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004770 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004771
4772 if (!workqueue_freezing)
4773 goto out_unlock;
4774
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004775 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004776
Tejun Heo24b8a842013-03-12 11:29:58 -07004777 /* restore max_active and repopulate worklist */
4778 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004779 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004780 for_each_pwq(pwq, wq)
4781 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004782 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004783 }
4784
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004785out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004786 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004787}
4788#endif /* CONFIG_FREEZER */
4789
Tejun Heobce90382013-04-01 11:23:32 -07004790static void __init wq_numa_init(void)
4791{
4792 cpumask_var_t *tbl;
4793 int node, cpu;
4794
Tejun Heobce90382013-04-01 11:23:32 -07004795 if (num_possible_nodes() <= 1)
4796 return;
4797
Tejun Heod55262c2013-04-01 11:23:38 -07004798 if (wq_disable_numa) {
4799 pr_info("workqueue: NUMA affinity support disabled\n");
4800 return;
4801 }
4802
Tejun Heo4c16bd32013-04-01 11:23:36 -07004803 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
4804 BUG_ON(!wq_update_unbound_numa_attrs_buf);
4805
Tejun Heobce90382013-04-01 11:23:32 -07004806 /*
4807 * We want masks of possible CPUs of each node which isn't readily
4808 * available. Build one from cpu_to_node() which should have been
4809 * fully initialized by now.
4810 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004811 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07004812 BUG_ON(!tbl);
4813
4814 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04004815 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07004816 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07004817
4818 for_each_possible_cpu(cpu) {
4819 node = cpu_to_node(cpu);
4820 if (WARN_ON(node == NUMA_NO_NODE)) {
4821 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
4822 /* happens iff arch is bonkers, let's just proceed */
4823 return;
4824 }
4825 cpumask_set_cpu(cpu, tbl[node]);
4826 }
4827
4828 wq_numa_possible_cpumask = tbl;
4829 wq_numa_enabled = true;
4830}
4831
Suresh Siddha6ee05782010-07-30 14:57:37 -07004832static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004833{
Tejun Heo7a4e3442013-03-12 11:30:00 -07004834 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
4835 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02004836
Tejun Heoe904e6c2013-03-12 11:29:57 -07004837 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
4838
4839 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
4840
Tejun Heo65758202012-07-17 12:39:26 -07004841 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07004842 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02004843
Tejun Heobce90382013-04-01 11:23:32 -07004844 wq_numa_init();
4845
Tejun Heo706026c2013-01-24 11:01:34 -08004846 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07004847 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07004848 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004849
Tejun Heo7a4e3442013-03-12 11:30:00 -07004850 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07004851 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07004852 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08004853 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07004854 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07004855 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07004856 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07004857
Tejun Heo9daf9e62013-01-24 11:01:33 -08004858 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004859 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08004860 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004861 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07004862 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02004863 }
4864
Tejun Heoe22bee72010-06-29 10:07:14 +02004865 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07004866 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07004867 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02004868
Tejun Heof02ae732013-03-12 11:30:03 -07004869 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07004870 pool->flags &= ~POOL_DISASSOCIATED;
Lai Jiangshan051e1852014-07-22 13:03:02 +08004871 BUG_ON(!create_worker(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07004872 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004873 }
4874
Tejun Heo8a2b7532013-09-05 12:30:04 -04004875 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07004876 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
4877 struct workqueue_attrs *attrs;
4878
4879 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07004880 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07004881 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004882
4883 /*
4884 * An ordered wq should have only one pwq as ordering is
4885 * guaranteed by max_active which is enforced by pwqs.
4886 * Turn off NUMA so that dfl_pwq is used for all nodes.
4887 */
4888 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
4889 attrs->nice = std_nice[i];
4890 attrs->no_numa = true;
4891 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07004892 }
4893
Tejun Heod320c032010-06-29 10:07:14 +02004894 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09004895 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02004896 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02004897 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
4898 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01004899 system_freezable_wq = alloc_workqueue("events_freezable",
4900 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05304901 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
4902 WQ_POWER_EFFICIENT, 0);
4903 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
4904 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
4905 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09004906 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05304907 !system_unbound_wq || !system_freezable_wq ||
4908 !system_power_efficient_wq ||
4909 !system_freezable_power_efficient_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07004910 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004911}
Suresh Siddha6ee05782010-07-30 14:57:37 -07004912early_initcall(init_workqueues);