blob: ae9a05603e01ba5eb6cd004e70e796802c8cd1eb [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
19 * automatically managed. There is one worker pool for each CPU and
20 * one extra for works which are better served by workers which are
21 * not bound to any specific CPU.
22 *
23 * Please read Documentation/workqueue.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 */
25
Paul Gortmaker9984de12011-05-23 14:51:41 -040026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/kernel.h>
28#include <linux/sched.h>
29#include <linux/init.h>
30#include <linux/signal.h>
31#include <linux/completion.h>
32#include <linux/workqueue.h>
33#include <linux/slab.h>
34#include <linux/cpu.h>
35#include <linux/notifier.h>
36#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060037#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070038#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080039#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080040#include <linux/kallsyms.h>
41#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070042#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020043#include <linux/idr.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020044
45#include "workqueue_sched.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Tejun Heoc8e55f32010-06-29 10:07:12 +020047enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070048 /*
49 * global_cwq flags
50 *
51 * A bound gcwq is either associated or disassociated with its CPU.
52 * While associated (!DISASSOCIATED), all workers are bound to the
53 * CPU and none has %WORKER_UNBOUND set and concurrency management
54 * is in effect.
55 *
56 * While DISASSOCIATED, the cpu may be offline and all workers have
57 * %WORKER_UNBOUND set and concurrency management disabled, and may
58 * be executing on any CPU. The gcwq behaves as an unbound one.
59 *
60 * Note that DISASSOCIATED can be flipped only while holding
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -070061 * assoc_mutex of all pools on the gcwq to avoid changing binding
Tejun Heobc2ae0f2012-07-17 12:39:27 -070062 * state while create_worker() is in progress.
63 */
Tejun Heo11ebea52012-07-12 14:46:37 -070064 GCWQ_DISASSOCIATED = 1 << 0, /* cpu can't serve workers */
65 GCWQ_FREEZING = 1 << 1, /* freeze in progress */
66
67 /* pool flags */
68 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
Lai Jiangshan552a37e2012-09-10 10:03:33 -070069 POOL_MANAGING_WORKERS = 1 << 1, /* managing workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020070
Tejun Heoc8e55f32010-06-29 10:07:12 +020071 /* worker flags */
72 WORKER_STARTED = 1 << 0, /* started */
73 WORKER_DIE = 1 << 1, /* die die die */
74 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020075 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020076 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020077 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020078
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -070079 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND |
Tejun Heo403c8212012-07-17 12:39:27 -070080 WORKER_CPU_INTENSIVE,
Tejun Heodb7bccf2010-06-29 10:07:12 +020081
Tejun Heo32704762012-07-13 22:16:45 -070082 NR_WORKER_POOLS = 2, /* # worker pools per gcwq */
Tejun Heo4ce62e92012-07-13 22:16:44 -070083
Tejun Heoc8e55f32010-06-29 10:07:12 +020084 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
85 BUSY_WORKER_HASH_SIZE = 1 << BUSY_WORKER_HASH_ORDER,
86 BUSY_WORKER_HASH_MASK = BUSY_WORKER_HASH_SIZE - 1,
Tejun Heodb7bccf2010-06-29 10:07:12 +020087
Tejun Heoe22bee72010-06-29 10:07:14 +020088 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
89 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
90
Tejun Heo3233cdb2011-02-16 18:10:19 +010091 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
92 /* call for help after 10ms
93 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020094 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
95 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020096
97 /*
98 * Rescue workers are used only on emergencies and shared by
99 * all cpus. Give -20.
100 */
101 RESCUER_NICE_LEVEL = -20,
Tejun Heo32704762012-07-13 22:16:45 -0700102 HIGHPRI_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200103};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200106 * Structure fields follow one of the following exclusion rules.
107 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200108 * I: Modifiable by initialization/destruction paths and read-only for
109 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200110 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200111 * P: Preemption protected. Disabling preemption is enough and should
112 * only be modified and accessed from the local cpu.
113 *
Tejun Heo8b03ae32010-06-29 10:07:12 +0200114 * L: gcwq->lock protected. Access with gcwq->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200115 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200116 * X: During normal operation, modification requires gcwq->lock and
117 * should be done only from local cpu. Either disabling preemption
118 * on local cpu or grabbing gcwq->lock is enough for read access.
Tejun Heof3421792010-07-02 10:03:51 +0200119 * If GCWQ_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200120 *
Tejun Heo73f53c42010-06-29 10:07:11 +0200121 * F: wq->flush_mutex protected.
122 *
Tejun Heo4690c4a2010-06-29 10:07:10 +0200123 * W: workqueue_lock protected.
124 */
125
Tejun Heo8b03ae32010-06-29 10:07:12 +0200126struct global_cwq;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700127struct worker_pool;
Tejun Heoc34056a2010-06-29 10:07:11 +0200128
Tejun Heoe22bee72010-06-29 10:07:14 +0200129/*
130 * The poor guys doing the actual heavy lifting. All on-duty workers
131 * are either serving the manager role, on idle list or on busy hash.
132 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200133struct worker {
Tejun Heoc8e55f32010-06-29 10:07:12 +0200134 /* on idle list while idle, on busy hash table while busy */
135 union {
136 struct list_head entry; /* L: while idle */
137 struct hlist_node hentry; /* L: while busy */
138 };
139
Tejun Heoc34056a2010-06-29 10:07:11 +0200140 struct work_struct *current_work; /* L: work being processed */
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200141 struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
Tejun Heoaffee4b2010-06-29 10:07:12 +0200142 struct list_head scheduled; /* L: scheduled works */
Tejun Heoc34056a2010-06-29 10:07:11 +0200143 struct task_struct *task; /* I: worker task */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700144 struct worker_pool *pool; /* I: the associated pool */
Tejun Heoe22bee72010-06-29 10:07:14 +0200145 /* 64 bytes boundary on 64bit, 32 on 32bit */
146 unsigned long last_active; /* L: last active timestamp */
147 unsigned int flags; /* X: flags */
Tejun Heoc34056a2010-06-29 10:07:11 +0200148 int id; /* I: worker id */
Tejun Heo25511a42012-07-17 12:39:27 -0700149
150 /* for rebinding worker to CPU */
Tejun Heo25511a42012-07-17 12:39:27 -0700151 struct work_struct rebind_work; /* L: for busy worker */
Tejun Heoc34056a2010-06-29 10:07:11 +0200152};
153
Tejun Heobd7bdd42012-07-12 14:46:37 -0700154struct worker_pool {
155 struct global_cwq *gcwq; /* I: the owning gcwq */
Tejun Heo11ebea52012-07-12 14:46:37 -0700156 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700157
158 struct list_head worklist; /* L: list of pending works */
159 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700160
161 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700162 int nr_idle; /* L: currently idle ones */
163
164 struct list_head idle_list; /* X: list of idle workers */
165 struct timer_list idle_timer; /* L: worker idle timeout */
166 struct timer_list mayday_timer; /* L: SOS timer for workers */
167
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -0700168 struct mutex assoc_mutex; /* protect GCWQ_DISASSOCIATED */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700169 struct ida worker_ida; /* L: for worker IDs */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700170};
171
Tejun Heo4690c4a2010-06-29 10:07:10 +0200172/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200173 * Global per-cpu workqueue. There's one and only one for each cpu
174 * and all works are queued and processed here regardless of their
175 * target workqueues.
Tejun Heo8b03ae32010-06-29 10:07:12 +0200176 */
177struct global_cwq {
178 spinlock_t lock; /* the gcwq lock */
179 unsigned int cpu; /* I: the associated cpu */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200180 unsigned int flags; /* L: GCWQ_* flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200181
Tejun Heobd7bdd42012-07-12 14:46:37 -0700182 /* workers are chained either in busy_hash or pool idle_list */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200183 struct hlist_head busy_hash[BUSY_WORKER_HASH_SIZE];
184 /* L: hash of busy workers */
185
Joonsoo Kim330dad52012-08-15 23:25:36 +0900186 struct worker_pool pools[NR_WORKER_POOLS];
187 /* normal and highpri pools */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200188} ____cacheline_aligned_in_smp;
189
190/*
Tejun Heo502ca9d2010-06-29 10:07:13 +0200191 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
Tejun Heo0f900042010-06-29 10:07:11 +0200192 * work_struct->data are used for flags and thus cwqs need to be
193 * aligned at two's power of the number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 */
195struct cpu_workqueue_struct {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700196 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200197 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200198 int work_color; /* L: current color */
199 int flush_color; /* L: flushing color */
200 int nr_in_flight[WORK_NR_COLORS];
201 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200202 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200203 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200204 struct list_head delayed_works; /* L: delayed works */
Tejun Heo0f900042010-06-29 10:07:11 +0200205};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200208 * Structure used to wait for workqueue flush.
209 */
210struct wq_flusher {
211 struct list_head list; /* F: list of flushers */
212 int flush_color; /* F: flush color waiting for */
213 struct completion done; /* flush completion */
214};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Tejun Heo73f53c42010-06-29 10:07:11 +0200216/*
Tejun Heof2e005a2010-07-20 15:59:09 +0200217 * All cpumasks are assumed to be always set on UP and thus can't be
218 * used to determine whether there's something to be done.
219 */
220#ifdef CONFIG_SMP
221typedef cpumask_var_t mayday_mask_t;
222#define mayday_test_and_set_cpu(cpu, mask) \
223 cpumask_test_and_set_cpu((cpu), (mask))
224#define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
225#define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
Tejun Heo9c375472010-08-31 11:18:34 +0200226#define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
Tejun Heof2e005a2010-07-20 15:59:09 +0200227#define free_mayday_mask(mask) free_cpumask_var((mask))
228#else
229typedef unsigned long mayday_mask_t;
230#define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
231#define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
232#define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
233#define alloc_mayday_mask(maskp, gfp) true
234#define free_mayday_mask(mask) do { } while (0)
235#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
237/*
238 * The externally visible workqueue abstraction is an array of
239 * per-CPU workqueues:
240 */
241struct workqueue_struct {
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200242 unsigned int flags; /* W: WQ_* flags */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200243 union {
244 struct cpu_workqueue_struct __percpu *pcpu;
245 struct cpu_workqueue_struct *single;
246 unsigned long v;
247 } cpu_wq; /* I: cwq's */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200248 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200249
250 struct mutex flush_mutex; /* protects wq flushing */
251 int work_color; /* F: current work color */
252 int flush_color; /* F: current flush color */
253 atomic_t nr_cwqs_to_flush; /* flush in progress */
254 struct wq_flusher *first_flusher; /* F: first flusher */
255 struct list_head flusher_queue; /* F: flush waiters */
256 struct list_head flusher_overflow; /* F: flush overflow list */
257
Tejun Heof2e005a2010-07-20 15:59:09 +0200258 mayday_mask_t mayday_mask; /* cpus requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200259 struct worker *rescuer; /* I: rescue worker */
260
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200261 int nr_drainers; /* W: drain in progress */
Tejun Heodcd989c2010-06-29 10:07:14 +0200262 int saved_max_active; /* W: saved cwq max_active */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700263#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200264 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700265#endif
Tejun Heob196be82012-01-10 15:11:35 -0800266 char name[]; /* I: workqueue name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267};
268
Tejun Heod320c032010-06-29 10:07:14 +0200269struct workqueue_struct *system_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200270EXPORT_SYMBOL_GPL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300271struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900272EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300273struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200274EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300275struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200276EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300277struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100278EXPORT_SYMBOL_GPL(system_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200279
Tejun Heo97bd2342010-10-05 10:41:14 +0200280#define CREATE_TRACE_POINTS
281#include <trace/events/workqueue.h>
282
Tejun Heo4ce62e92012-07-13 22:16:44 -0700283#define for_each_worker_pool(pool, gcwq) \
Tejun Heo32704762012-07-13 22:16:45 -0700284 for ((pool) = &(gcwq)->pools[0]; \
285 (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700286
Tejun Heodb7bccf2010-06-29 10:07:12 +0200287#define for_each_busy_worker(worker, i, pos, gcwq) \
288 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
289 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
290
Tejun Heof3421792010-07-02 10:03:51 +0200291static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
292 unsigned int sw)
293{
294 if (cpu < nr_cpu_ids) {
295 if (sw & 1) {
296 cpu = cpumask_next(cpu, mask);
297 if (cpu < nr_cpu_ids)
298 return cpu;
299 }
300 if (sw & 2)
301 return WORK_CPU_UNBOUND;
302 }
303 return WORK_CPU_NONE;
304}
305
306static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
307 struct workqueue_struct *wq)
308{
309 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
310}
311
Tejun Heo09884952010-08-01 11:50:12 +0200312/*
313 * CPU iterators
314 *
315 * An extra gcwq is defined for an invalid cpu number
316 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
317 * specific CPU. The following iterators are similar to
318 * for_each_*_cpu() iterators but also considers the unbound gcwq.
319 *
320 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
321 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
322 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
323 * WORK_CPU_UNBOUND for unbound workqueues
324 */
Tejun Heof3421792010-07-02 10:03:51 +0200325#define for_each_gcwq_cpu(cpu) \
326 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
327 (cpu) < WORK_CPU_NONE; \
328 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
329
330#define for_each_online_gcwq_cpu(cpu) \
331 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
332 (cpu) < WORK_CPU_NONE; \
333 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
334
335#define for_each_cwq_cpu(cpu, wq) \
336 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
337 (cpu) < WORK_CPU_NONE; \
338 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
339
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900340#ifdef CONFIG_DEBUG_OBJECTS_WORK
341
342static struct debug_obj_descr work_debug_descr;
343
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100344static void *work_debug_hint(void *addr)
345{
346 return ((struct work_struct *) addr)->func;
347}
348
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900349/*
350 * fixup_init is called when:
351 * - an active object is initialized
352 */
353static int work_fixup_init(void *addr, enum debug_obj_state state)
354{
355 struct work_struct *work = addr;
356
357 switch (state) {
358 case ODEBUG_STATE_ACTIVE:
359 cancel_work_sync(work);
360 debug_object_init(work, &work_debug_descr);
361 return 1;
362 default:
363 return 0;
364 }
365}
366
367/*
368 * fixup_activate is called when:
369 * - an active object is activated
370 * - an unknown object is activated (might be a statically initialized object)
371 */
372static int work_fixup_activate(void *addr, enum debug_obj_state state)
373{
374 struct work_struct *work = addr;
375
376 switch (state) {
377
378 case ODEBUG_STATE_NOTAVAILABLE:
379 /*
380 * This is not really a fixup. The work struct was
381 * statically initialized. We just make sure that it
382 * is tracked in the object tracker.
383 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200384 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900385 debug_object_init(work, &work_debug_descr);
386 debug_object_activate(work, &work_debug_descr);
387 return 0;
388 }
389 WARN_ON_ONCE(1);
390 return 0;
391
392 case ODEBUG_STATE_ACTIVE:
393 WARN_ON(1);
394
395 default:
396 return 0;
397 }
398}
399
400/*
401 * fixup_free is called when:
402 * - an active object is freed
403 */
404static int work_fixup_free(void *addr, enum debug_obj_state state)
405{
406 struct work_struct *work = addr;
407
408 switch (state) {
409 case ODEBUG_STATE_ACTIVE:
410 cancel_work_sync(work);
411 debug_object_free(work, &work_debug_descr);
412 return 1;
413 default:
414 return 0;
415 }
416}
417
418static struct debug_obj_descr work_debug_descr = {
419 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100420 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900421 .fixup_init = work_fixup_init,
422 .fixup_activate = work_fixup_activate,
423 .fixup_free = work_fixup_free,
424};
425
426static inline void debug_work_activate(struct work_struct *work)
427{
428 debug_object_activate(work, &work_debug_descr);
429}
430
431static inline void debug_work_deactivate(struct work_struct *work)
432{
433 debug_object_deactivate(work, &work_debug_descr);
434}
435
436void __init_work(struct work_struct *work, int onstack)
437{
438 if (onstack)
439 debug_object_init_on_stack(work, &work_debug_descr);
440 else
441 debug_object_init(work, &work_debug_descr);
442}
443EXPORT_SYMBOL_GPL(__init_work);
444
445void destroy_work_on_stack(struct work_struct *work)
446{
447 debug_object_free(work, &work_debug_descr);
448}
449EXPORT_SYMBOL_GPL(destroy_work_on_stack);
450
451#else
452static inline void debug_work_activate(struct work_struct *work) { }
453static inline void debug_work_deactivate(struct work_struct *work) { }
454#endif
455
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100456/* Serializes the accesses to the list of workqueues. */
457static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200459static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
Oleg Nesterov14441962007-05-23 13:57:57 -0700461/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200462 * The almighty global cpu workqueues. nr_running is the only field
463 * which is expected to be used frequently by other cpus via
464 * try_to_wake_up(). Put it in a separate cacheline.
Oleg Nesterov14441962007-05-23 13:57:57 -0700465 */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200466static DEFINE_PER_CPU(struct global_cwq, global_cwq);
Tejun Heo4ce62e92012-07-13 22:16:44 -0700467static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
Nathan Lynchf756d5e2006-01-08 01:05:12 -0800468
Tejun Heof3421792010-07-02 10:03:51 +0200469/*
470 * Global cpu workqueue and nr_running counter for unbound gcwq. The
471 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
472 * workers have WORKER_UNBOUND set.
473 */
474static struct global_cwq unbound_global_cwq;
Tejun Heo4ce62e92012-07-13 22:16:44 -0700475static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
476 [0 ... NR_WORKER_POOLS - 1] = ATOMIC_INIT(0), /* always 0 */
477};
Tejun Heof3421792010-07-02 10:03:51 +0200478
Tejun Heoc34056a2010-06-29 10:07:11 +0200479static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
Tejun Heo32704762012-07-13 22:16:45 -0700481static int worker_pool_pri(struct worker_pool *pool)
482{
483 return pool - pool->gcwq->pools;
484}
485
Tejun Heo8b03ae32010-06-29 10:07:12 +0200486static struct global_cwq *get_gcwq(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487{
Tejun Heof3421792010-07-02 10:03:51 +0200488 if (cpu != WORK_CPU_UNBOUND)
489 return &per_cpu(global_cwq, cpu);
490 else
491 return &unbound_global_cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492}
493
Tejun Heo63d95a92012-07-12 14:46:37 -0700494static atomic_t *get_pool_nr_running(struct worker_pool *pool)
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -0700495{
Tejun Heo63d95a92012-07-12 14:46:37 -0700496 int cpu = pool->gcwq->cpu;
Tejun Heo32704762012-07-13 22:16:45 -0700497 int idx = worker_pool_pri(pool);
Tejun Heo63d95a92012-07-12 14:46:37 -0700498
Tejun Heof3421792010-07-02 10:03:51 +0200499 if (cpu != WORK_CPU_UNBOUND)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700500 return &per_cpu(pool_nr_running, cpu)[idx];
Tejun Heof3421792010-07-02 10:03:51 +0200501 else
Tejun Heo4ce62e92012-07-13 22:16:44 -0700502 return &unbound_pool_nr_running[idx];
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -0700503}
504
Tejun Heo4690c4a2010-06-29 10:07:10 +0200505static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
506 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700507{
Tejun Heof3421792010-07-02 10:03:51 +0200508 if (!(wq->flags & WQ_UNBOUND)) {
Lai Jiangshane06ffa12012-03-09 18:03:20 +0800509 if (likely(cpu < nr_cpu_ids))
Tejun Heof3421792010-07-02 10:03:51 +0200510 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200511 } else if (likely(cpu == WORK_CPU_UNBOUND))
512 return wq->cpu_wq.single;
513 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700514}
515
Tejun Heo73f53c42010-06-29 10:07:11 +0200516static unsigned int work_color_to_flags(int color)
517{
518 return color << WORK_STRUCT_COLOR_SHIFT;
519}
520
521static int get_work_color(struct work_struct *work)
522{
523 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
524 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
525}
526
527static int work_next_color(int color)
528{
529 return (color + 1) % WORK_NR_COLORS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530}
531
David Howells4594bf12006-12-07 11:33:26 +0000532/*
Tejun Heob5490072012-08-03 10:30:46 -0700533 * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
534 * contain the pointer to the queued cwq. Once execution starts, the flag
535 * is cleared and the high bits contain OFFQ flags and CPU number.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200536 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700537 * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
538 * and clear_work_data() can be used to set the cwq, cpu or clear
539 * work->data. These functions should only be called while the work is
540 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200541 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700542 * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
543 * a work. gcwq is available once the work has been queued anywhere after
544 * initialization until it is sync canceled. cwq is available only while
545 * the work item is queued.
546 *
547 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
548 * canceled. While being canceled, a work item may have its PENDING set
549 * but stay off timer and worklist for arbitrarily long and nobody should
550 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000551 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200552static inline void set_work_data(struct work_struct *work, unsigned long data,
553 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000554{
David Howells4594bf12006-12-07 11:33:26 +0000555 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200556 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000557}
David Howells365970a2006-11-22 14:54:49 +0000558
Tejun Heo7a22ad72010-06-29 10:07:13 +0200559static void set_work_cwq(struct work_struct *work,
560 struct cpu_workqueue_struct *cwq,
561 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200562{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200563 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200564 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200565}
566
Tejun Heo8930cab2012-08-03 10:30:45 -0700567static void set_work_cpu_and_clear_pending(struct work_struct *work,
568 unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000569{
Tejun Heo23657bb2012-08-13 17:08:19 -0700570 /*
571 * The following wmb is paired with the implied mb in
572 * test_and_set_bit(PENDING) and ensures all updates to @work made
573 * here are visible to and precede any updates by the next PENDING
574 * owner.
575 */
576 smp_wmb();
Tejun Heob5490072012-08-03 10:30:46 -0700577 set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200578}
579
580static void clear_work_data(struct work_struct *work)
581{
Tejun Heo23657bb2012-08-13 17:08:19 -0700582 smp_wmb(); /* see set_work_cpu_and_clear_pending() */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200583 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
584}
585
Tejun Heo7a22ad72010-06-29 10:07:13 +0200586static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
587{
Tejun Heoe1201532010-07-22 14:14:25 +0200588 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200589
Tejun Heoe1201532010-07-22 14:14:25 +0200590 if (data & WORK_STRUCT_CWQ)
591 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
592 else
593 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200594}
595
596static struct global_cwq *get_work_gcwq(struct work_struct *work)
597{
Tejun Heoe1201532010-07-22 14:14:25 +0200598 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200599 unsigned int cpu;
600
Tejun Heoe1201532010-07-22 14:14:25 +0200601 if (data & WORK_STRUCT_CWQ)
602 return ((struct cpu_workqueue_struct *)
Tejun Heobd7bdd42012-07-12 14:46:37 -0700603 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200604
Tejun Heob5490072012-08-03 10:30:46 -0700605 cpu = data >> WORK_OFFQ_CPU_SHIFT;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200606 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200607 return NULL;
608
Tejun Heof3421792010-07-02 10:03:51 +0200609 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200610 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000611}
612
Tejun Heobbb68df2012-08-03 10:30:46 -0700613static void mark_work_canceling(struct work_struct *work)
614{
615 struct global_cwq *gcwq = get_work_gcwq(work);
616 unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
617
618 set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
619 WORK_STRUCT_PENDING);
620}
621
622static bool work_is_canceling(struct work_struct *work)
623{
624 unsigned long data = atomic_long_read(&work->data);
625
626 return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
627}
628
David Howells365970a2006-11-22 14:54:49 +0000629/*
Tejun Heo32704762012-07-13 22:16:45 -0700630 * Policy functions. These define the policies on how the global worker
631 * pools are managed. Unless noted otherwise, these functions assume that
632 * they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000633 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200634
Tejun Heo63d95a92012-07-12 14:46:37 -0700635static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000636{
Tejun Heo32704762012-07-13 22:16:45 -0700637 return !atomic_read(get_pool_nr_running(pool));
David Howells365970a2006-11-22 14:54:49 +0000638}
639
Tejun Heoe22bee72010-06-29 10:07:14 +0200640/*
641 * Need to wake up a worker? Called from anything but currently
642 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700643 *
644 * Note that, because unbound workers never contribute to nr_running, this
645 * function will always return %true for unbound gcwq as long as the
646 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200647 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700648static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000649{
Tejun Heo63d95a92012-07-12 14:46:37 -0700650 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000651}
652
Tejun Heoe22bee72010-06-29 10:07:14 +0200653/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700654static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200655{
Tejun Heo63d95a92012-07-12 14:46:37 -0700656 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200657}
658
659/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700660static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200661{
Tejun Heo63d95a92012-07-12 14:46:37 -0700662 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200663
Tejun Heo32704762012-07-13 22:16:45 -0700664 return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200665}
666
667/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700668static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200669{
Tejun Heo63d95a92012-07-12 14:46:37 -0700670 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200671}
672
673/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700674static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200675{
Tejun Heo63d95a92012-07-12 14:46:37 -0700676 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700677 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200678}
679
680/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700681static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200682{
Lai Jiangshan552a37e2012-09-10 10:03:33 -0700683 bool managing = pool->flags & POOL_MANAGING_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -0700684 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
685 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200686
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700687 /*
688 * nr_idle and idle_list may disagree if idle rebinding is in
689 * progress. Never return %true if idle_list is empty.
690 */
691 if (list_empty(&pool->idle_list))
692 return false;
693
Tejun Heoe22bee72010-06-29 10:07:14 +0200694 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
695}
696
697/*
698 * Wake up functions.
699 */
700
Tejun Heo7e116292010-06-29 10:07:13 +0200701/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700702static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200703{
Tejun Heo63d95a92012-07-12 14:46:37 -0700704 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200705 return NULL;
706
Tejun Heo63d95a92012-07-12 14:46:37 -0700707 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200708}
709
710/**
711 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700712 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200713 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700714 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200715 *
716 * CONTEXT:
717 * spin_lock_irq(gcwq->lock).
718 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700719static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200720{
Tejun Heo63d95a92012-07-12 14:46:37 -0700721 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200722
723 if (likely(worker))
724 wake_up_process(worker->task);
725}
726
Tejun Heo4690c4a2010-06-29 10:07:10 +0200727/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200728 * wq_worker_waking_up - a worker is waking up
729 * @task: task waking up
730 * @cpu: CPU @task is waking up to
731 *
732 * This function is called during try_to_wake_up() when a worker is
733 * being awoken.
734 *
735 * CONTEXT:
736 * spin_lock_irq(rq->lock)
737 */
738void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
739{
740 struct worker *worker = kthread_data(task);
741
Joonsoo Kim36576002012-10-26 23:03:49 +0900742 if (!(worker->flags & WORKER_NOT_RUNNING)) {
743 WARN_ON_ONCE(worker->pool->gcwq->cpu != cpu);
Tejun Heo63d95a92012-07-12 14:46:37 -0700744 atomic_inc(get_pool_nr_running(worker->pool));
Joonsoo Kim36576002012-10-26 23:03:49 +0900745 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200746}
747
748/**
749 * wq_worker_sleeping - a worker is going to sleep
750 * @task: task going to sleep
751 * @cpu: CPU in question, must be the current CPU number
752 *
753 * This function is called during schedule() when a busy worker is
754 * going to sleep. Worker on the same cpu can be woken up by
755 * returning pointer to its task.
756 *
757 * CONTEXT:
758 * spin_lock_irq(rq->lock)
759 *
760 * RETURNS:
761 * Worker task on @cpu to wake up, %NULL if none.
762 */
763struct task_struct *wq_worker_sleeping(struct task_struct *task,
764 unsigned int cpu)
765{
766 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700767 struct worker_pool *pool = worker->pool;
Tejun Heo63d95a92012-07-12 14:46:37 -0700768 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200769
Steven Rostedt2d646722010-12-03 23:12:33 -0500770 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200771 return NULL;
772
773 /* this can only happen on the local cpu */
774 BUG_ON(cpu != raw_smp_processor_id());
775
776 /*
777 * The counterpart of the following dec_and_test, implied mb,
778 * worklist not empty test sequence is in insert_work().
779 * Please read comment there.
780 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700781 * NOT_RUNNING is clear. This means that we're bound to and
782 * running on the local cpu w/ rq lock held and preemption
783 * disabled, which in turn means that none else could be
784 * manipulating idle_list, so dereferencing idle_list without gcwq
785 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200786 */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700787 if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700788 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200789 return to_wakeup ? to_wakeup->task : NULL;
790}
791
792/**
793 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200794 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200795 * @flags: flags to set
796 * @wakeup: wakeup an idle worker if necessary
797 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200798 * Set @flags in @worker->flags and adjust nr_running accordingly. If
799 * nr_running becomes zero and @wakeup is %true, an idle worker is
800 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200801 *
Tejun Heocb444762010-07-02 10:03:50 +0200802 * CONTEXT:
803 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200804 */
805static inline void worker_set_flags(struct worker *worker, unsigned int flags,
806 bool wakeup)
807{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700808 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200809
Tejun Heocb444762010-07-02 10:03:50 +0200810 WARN_ON_ONCE(worker->task != current);
811
Tejun Heoe22bee72010-06-29 10:07:14 +0200812 /*
813 * If transitioning into NOT_RUNNING, adjust nr_running and
814 * wake up an idle worker as necessary if requested by
815 * @wakeup.
816 */
817 if ((flags & WORKER_NOT_RUNNING) &&
818 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heo63d95a92012-07-12 14:46:37 -0700819 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200820
821 if (wakeup) {
822 if (atomic_dec_and_test(nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700823 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700824 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200825 } else
826 atomic_dec(nr_running);
827 }
828
Tejun Heod302f012010-06-29 10:07:13 +0200829 worker->flags |= flags;
830}
831
832/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200833 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200834 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200835 * @flags: flags to clear
836 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200837 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200838 *
Tejun Heocb444762010-07-02 10:03:50 +0200839 * CONTEXT:
840 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200841 */
842static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
843{
Tejun Heo63d95a92012-07-12 14:46:37 -0700844 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200845 unsigned int oflags = worker->flags;
846
Tejun Heocb444762010-07-02 10:03:50 +0200847 WARN_ON_ONCE(worker->task != current);
848
Tejun Heod302f012010-06-29 10:07:13 +0200849 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200850
Tejun Heo42c025f2011-01-11 15:58:49 +0100851 /*
852 * If transitioning out of NOT_RUNNING, increment nr_running. Note
853 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
854 * of multiple flags, not a single flag.
855 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200856 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
857 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700858 atomic_inc(get_pool_nr_running(pool));
Tejun Heod302f012010-06-29 10:07:13 +0200859}
860
861/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200862 * busy_worker_head - return the busy hash head for a work
863 * @gcwq: gcwq of interest
864 * @work: work to be hashed
865 *
866 * Return hash head of @gcwq for @work.
867 *
868 * CONTEXT:
869 * spin_lock_irq(gcwq->lock).
870 *
871 * RETURNS:
872 * Pointer to the hash head.
873 */
874static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
875 struct work_struct *work)
876{
877 const int base_shift = ilog2(sizeof(struct work_struct));
878 unsigned long v = (unsigned long)work;
879
880 /* simple shift and fold hash, do we need something better? */
881 v >>= base_shift;
882 v += v >> BUSY_WORKER_HASH_ORDER;
883 v &= BUSY_WORKER_HASH_MASK;
884
885 return &gcwq->busy_hash[v];
886}
887
888/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200889 * __find_worker_executing_work - find worker which is executing a work
890 * @gcwq: gcwq of interest
891 * @bwh: hash head as returned by busy_worker_head()
892 * @work: work to find worker for
893 *
894 * Find a worker which is executing @work on @gcwq. @bwh should be
895 * the hash head obtained by calling busy_worker_head() with the same
896 * work.
897 *
898 * CONTEXT:
899 * spin_lock_irq(gcwq->lock).
900 *
901 * RETURNS:
902 * Pointer to worker which is executing @work if found, NULL
903 * otherwise.
904 */
905static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
906 struct hlist_head *bwh,
907 struct work_struct *work)
908{
909 struct worker *worker;
910 struct hlist_node *tmp;
911
912 hlist_for_each_entry(worker, tmp, bwh, hentry)
913 if (worker->current_work == work)
914 return worker;
915 return NULL;
916}
917
918/**
919 * find_worker_executing_work - find worker which is executing a work
920 * @gcwq: gcwq of interest
921 * @work: work to find worker for
922 *
923 * Find a worker which is executing @work on @gcwq. This function is
924 * identical to __find_worker_executing_work() except that this
925 * function calculates @bwh itself.
926 *
927 * CONTEXT:
928 * spin_lock_irq(gcwq->lock).
929 *
930 * RETURNS:
931 * Pointer to worker which is executing @work if found, NULL
932 * otherwise.
933 */
934static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
935 struct work_struct *work)
936{
937 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
938 work);
939}
940
941/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700942 * move_linked_works - move linked works to a list
943 * @work: start of series of works to be scheduled
944 * @head: target list to append @work to
945 * @nextp: out paramter for nested worklist walking
946 *
947 * Schedule linked works starting from @work to @head. Work series to
948 * be scheduled starts at @work and includes any consecutive work with
949 * WORK_STRUCT_LINKED set in its predecessor.
950 *
951 * If @nextp is not NULL, it's updated to point to the next work of
952 * the last scheduled work. This allows move_linked_works() to be
953 * nested inside outer list_for_each_entry_safe().
954 *
955 * CONTEXT:
956 * spin_lock_irq(gcwq->lock).
957 */
958static void move_linked_works(struct work_struct *work, struct list_head *head,
959 struct work_struct **nextp)
960{
961 struct work_struct *n;
962
963 /*
964 * Linked worklist will always end before the end of the list,
965 * use NULL for list head.
966 */
967 list_for_each_entry_safe_from(work, n, NULL, entry) {
968 list_move_tail(&work->entry, head);
969 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
970 break;
971 }
972
973 /*
974 * If we're already inside safe list traversal and have moved
975 * multiple works to the scheduled queue, the next position
976 * needs to be updated.
977 */
978 if (nextp)
979 *nextp = n;
980}
981
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700982static void cwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -0700983{
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700984 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -0700985
986 trace_workqueue_activate_work(work);
987 move_linked_works(work, &cwq->pool->worklist, NULL);
988 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
989 cwq->nr_active++;
990}
991
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700992static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
993{
994 struct work_struct *work = list_first_entry(&cwq->delayed_works,
995 struct work_struct, entry);
996
997 cwq_activate_delayed_work(work);
998}
999
Tejun Heobf4ede02012-08-03 10:30:46 -07001000/**
1001 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1002 * @cwq: cwq of interest
1003 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001004 *
1005 * A work either has completed or is removed from pending queue,
1006 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1007 *
1008 * CONTEXT:
1009 * spin_lock_irq(gcwq->lock).
1010 */
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001011static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001012{
1013 /* ignore uncolored works */
1014 if (color == WORK_NO_COLOR)
1015 return;
1016
1017 cwq->nr_in_flight[color]--;
1018
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001019 cwq->nr_active--;
1020 if (!list_empty(&cwq->delayed_works)) {
1021 /* one down, submit a delayed one */
1022 if (cwq->nr_active < cwq->max_active)
1023 cwq_activate_first_delayed(cwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001024 }
1025
1026 /* is flush in progress and are we at the flushing tip? */
1027 if (likely(cwq->flush_color != color))
1028 return;
1029
1030 /* are there still in-flight works? */
1031 if (cwq->nr_in_flight[color])
1032 return;
1033
1034 /* this cwq is done, clear flush_color */
1035 cwq->flush_color = -1;
1036
1037 /*
1038 * If this was the last cwq, wake up the first flusher. It
1039 * will handle the rest.
1040 */
1041 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1042 complete(&cwq->wq->first_flusher->done);
1043}
1044
Tejun Heo36e227d2012-08-03 10:30:46 -07001045/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001046 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001047 * @work: work item to steal
1048 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001049 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001050 *
1051 * Try to grab PENDING bit of @work. This function can handle @work in any
1052 * stable state - idle, on timer or on worklist. Return values are
1053 *
1054 * 1 if @work was pending and we successfully stole PENDING
1055 * 0 if @work was idle and we claimed PENDING
1056 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001057 * -ENOENT if someone else is canceling @work, this state may persist
1058 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001059 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001060 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001061 * interrupted while holding PENDING and @work off queue, irq must be
1062 * disabled on entry. This, combined with delayed_work->timer being
1063 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001064 *
1065 * On successful return, >= 0, irq is disabled and the caller is
1066 * responsible for releasing it using local_irq_restore(*@flags).
1067 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001068 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001069 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001070static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1071 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001072{
1073 struct global_cwq *gcwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001074
Tejun Heobbb68df2012-08-03 10:30:46 -07001075 local_irq_save(*flags);
1076
Tejun Heo36e227d2012-08-03 10:30:46 -07001077 /* try to steal the timer if it exists */
1078 if (is_dwork) {
1079 struct delayed_work *dwork = to_delayed_work(work);
1080
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001081 /*
1082 * dwork->timer is irqsafe. If del_timer() fails, it's
1083 * guaranteed that the timer is not queued anywhere and not
1084 * running on the local CPU.
1085 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001086 if (likely(del_timer(&dwork->timer)))
1087 return 1;
1088 }
1089
1090 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001091 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1092 return 0;
1093
1094 /*
1095 * The queueing is in progress, or it is already queued. Try to
1096 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1097 */
1098 gcwq = get_work_gcwq(work);
1099 if (!gcwq)
Tejun Heobbb68df2012-08-03 10:30:46 -07001100 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001101
Tejun Heobbb68df2012-08-03 10:30:46 -07001102 spin_lock(&gcwq->lock);
Tejun Heobf4ede02012-08-03 10:30:46 -07001103 if (!list_empty(&work->entry)) {
1104 /*
1105 * This work is queued, but perhaps we locked the wrong gcwq.
1106 * In that case we must see the new value after rmb(), see
1107 * insert_work()->wmb().
1108 */
1109 smp_rmb();
1110 if (gcwq == get_work_gcwq(work)) {
1111 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001112
1113 /*
1114 * A delayed work item cannot be grabbed directly
1115 * because it might have linked NO_COLOR work items
1116 * which, if left on the delayed_list, will confuse
1117 * cwq->nr_active management later on and cause
1118 * stall. Make sure the work item is activated
1119 * before grabbing.
1120 */
1121 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1122 cwq_activate_delayed_work(work);
1123
Tejun Heobf4ede02012-08-03 10:30:46 -07001124 list_del_init(&work->entry);
1125 cwq_dec_nr_in_flight(get_work_cwq(work),
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001126 get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001127
Tejun Heobbb68df2012-08-03 10:30:46 -07001128 spin_unlock(&gcwq->lock);
Tejun Heo36e227d2012-08-03 10:30:46 -07001129 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001130 }
1131 }
Tejun Heobbb68df2012-08-03 10:30:46 -07001132 spin_unlock(&gcwq->lock);
1133fail:
1134 local_irq_restore(*flags);
1135 if (work_is_canceling(work))
1136 return -ENOENT;
1137 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001138 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001139}
1140
1141/**
Tejun Heo7e116292010-06-29 10:07:13 +02001142 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +02001143 * @cwq: cwq @work belongs to
1144 * @work: work to insert
1145 * @head: insertion point
1146 * @extra_flags: extra WORK_STRUCT_* flags to set
1147 *
Tejun Heo7e116292010-06-29 10:07:13 +02001148 * Insert @work which belongs to @cwq into @gcwq after @head.
1149 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001150 *
1151 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001152 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001153 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001154static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001155 struct work_struct *work, struct list_head *head,
1156 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001157{
Tejun Heo63d95a92012-07-12 14:46:37 -07001158 struct worker_pool *pool = cwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001159
Tejun Heo4690c4a2010-06-29 10:07:10 +02001160 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001161 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001162
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001163 /*
1164 * Ensure that we get the right work->data if we see the
1165 * result of list_add() below, see try_to_grab_pending().
1166 */
1167 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001168
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001169 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001170
1171 /*
1172 * Ensure either worker_sched_deactivated() sees the above
1173 * list_add_tail() or we see zero nr_running to avoid workers
1174 * lying around lazily while there are works to be processed.
1175 */
1176 smp_mb();
1177
Tejun Heo63d95a92012-07-12 14:46:37 -07001178 if (__need_more_worker(pool))
1179 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001180}
1181
Tejun Heoc8efcc22010-12-20 19:32:04 +01001182/*
1183 * Test whether @work is being queued from another work executing on the
1184 * same workqueue. This is rather expensive and should only be used from
1185 * cold paths.
1186 */
1187static bool is_chained_work(struct workqueue_struct *wq)
1188{
1189 unsigned long flags;
1190 unsigned int cpu;
1191
1192 for_each_gcwq_cpu(cpu) {
1193 struct global_cwq *gcwq = get_gcwq(cpu);
1194 struct worker *worker;
1195 struct hlist_node *pos;
1196 int i;
1197
1198 spin_lock_irqsave(&gcwq->lock, flags);
1199 for_each_busy_worker(worker, i, pos, gcwq) {
1200 if (worker->task != current)
1201 continue;
1202 spin_unlock_irqrestore(&gcwq->lock, flags);
1203 /*
1204 * I'm @worker, no locking necessary. See if @work
1205 * is headed to the same workqueue.
1206 */
1207 return worker->current_cwq->wq == wq;
1208 }
1209 spin_unlock_irqrestore(&gcwq->lock, flags);
1210 }
1211 return false;
1212}
1213
Tejun Heo4690c4a2010-06-29 10:07:10 +02001214static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 struct work_struct *work)
1216{
Tejun Heo502ca9d2010-06-29 10:07:13 +02001217 struct global_cwq *gcwq;
1218 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001219 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001220 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001221 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001222
1223 /*
1224 * While a work item is PENDING && off queue, a task trying to
1225 * steal the PENDING will busy-loop waiting for it to either get
1226 * queued or lose PENDING. Grabbing PENDING and queueing should
1227 * happen with IRQ disabled.
1228 */
1229 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001231 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001232
Tejun Heoc8efcc22010-12-20 19:32:04 +01001233 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001234 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001235 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001236 return;
1237
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001238 /* determine gcwq to use */
1239 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001240 struct global_cwq *last_gcwq;
1241
Tejun Heo57469822012-08-03 10:30:45 -07001242 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001243 cpu = raw_smp_processor_id();
1244
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001245 /*
Tejun Heodbf25762012-08-20 14:51:23 -07001246 * It's multi cpu. If @work was previously on a different
1247 * cpu, it might still be running there, in which case the
1248 * work needs to be queued on that cpu to guarantee
1249 * non-reentrancy.
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001250 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001251 gcwq = get_gcwq(cpu);
Tejun Heodbf25762012-08-20 14:51:23 -07001252 last_gcwq = get_work_gcwq(work);
1253
1254 if (last_gcwq && last_gcwq != gcwq) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001255 struct worker *worker;
1256
Tejun Heo8930cab2012-08-03 10:30:45 -07001257 spin_lock(&last_gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001258
1259 worker = find_worker_executing_work(last_gcwq, work);
1260
1261 if (worker && worker->current_cwq->wq == wq)
1262 gcwq = last_gcwq;
1263 else {
1264 /* meh... not running there, queue here */
Tejun Heo8930cab2012-08-03 10:30:45 -07001265 spin_unlock(&last_gcwq->lock);
1266 spin_lock(&gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001267 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001268 } else {
1269 spin_lock(&gcwq->lock);
1270 }
Tejun Heof3421792010-07-02 10:03:51 +02001271 } else {
1272 gcwq = get_gcwq(WORK_CPU_UNBOUND);
Tejun Heo8930cab2012-08-03 10:30:45 -07001273 spin_lock(&gcwq->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001274 }
1275
1276 /* gcwq determined, get cwq and queue */
1277 cwq = get_cwq(gcwq->cpu, wq);
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001278 trace_workqueue_queue_work(req_cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001279
Dan Carpenterf5b25522012-04-13 22:06:58 +03001280 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo8930cab2012-08-03 10:30:45 -07001281 spin_unlock(&gcwq->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001282 return;
1283 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001284
Tejun Heo73f53c42010-06-29 10:07:11 +02001285 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001286 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001287
1288 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001289 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001290 cwq->nr_active++;
Tejun Heo32704762012-07-13 22:16:45 -07001291 worklist = &cwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001292 } else {
1293 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001294 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001295 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001296
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001297 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001298
Tejun Heo8930cab2012-08-03 10:30:45 -07001299 spin_unlock(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300}
1301
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001302/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001303 * queue_work_on - queue work on specific cpu
1304 * @cpu: CPU number to execute work on
1305 * @wq: workqueue to use
1306 * @work: work to queue
1307 *
Tejun Heod4283e92012-08-03 10:30:44 -07001308 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001309 *
1310 * We queue the work to a specific CPU, the caller must ensure it
1311 * can't go away.
1312 */
Tejun Heod4283e92012-08-03 10:30:44 -07001313bool queue_work_on(int cpu, struct workqueue_struct *wq,
1314 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001315{
Tejun Heod4283e92012-08-03 10:30:44 -07001316 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001317 unsigned long flags;
1318
1319 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001320
Tejun Heo22df02b2010-06-29 10:07:10 +02001321 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001322 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001323 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001324 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001325
1326 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001327 return ret;
1328}
1329EXPORT_SYMBOL_GPL(queue_work_on);
1330
Tejun Heo0a13c002012-08-03 10:30:44 -07001331/**
1332 * queue_work - queue work on a workqueue
1333 * @wq: workqueue to use
1334 * @work: work to queue
1335 *
Tejun Heod4283e92012-08-03 10:30:44 -07001336 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001337 *
1338 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1339 * it can be processed by another CPU.
1340 */
Tejun Heod4283e92012-08-03 10:30:44 -07001341bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001342{
Tejun Heo57469822012-08-03 10:30:45 -07001343 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001344}
1345EXPORT_SYMBOL_GPL(queue_work);
1346
Tejun Heod8e794d2012-08-03 10:30:45 -07001347void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348{
David Howells52bad642006-11-22 14:54:01 +00001349 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001350 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001352 /* should have been called from irqsafe timer with irq already off */
Tejun Heo12650572012-08-08 09:38:42 -07001353 __queue_work(dwork->cpu, cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354}
Tejun Heod8e794d2012-08-03 10:30:45 -07001355EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001357static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1358 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001360 struct timer_list *timer = &dwork->timer;
1361 struct work_struct *work = &dwork->work;
1362 unsigned int lcpu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001364 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1365 timer->data != (unsigned long)dwork);
1366 BUG_ON(timer_pending(timer));
1367 BUG_ON(!list_empty(&work->entry));
1368
Tejun Heo8852aac2012-12-01 16:23:42 -08001369 /*
1370 * If @delay is 0, queue @dwork->work immediately. This is for
1371 * both optimization and correctness. The earliest @timer can
1372 * expire is on the closest next tick and delayed_work users depend
1373 * on that there's no such delay when @delay is 0.
1374 */
1375 if (!delay) {
1376 __queue_work(cpu, wq, &dwork->work);
1377 return;
1378 }
1379
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001380 timer_stats_timer_set_start_info(&dwork->timer);
1381
1382 /*
1383 * This stores cwq for the moment, for the timer_fn. Note that the
1384 * work's gcwq is preserved to allow reentrance detection for
1385 * delayed works.
1386 */
1387 if (!(wq->flags & WQ_UNBOUND)) {
1388 struct global_cwq *gcwq = get_work_gcwq(work);
1389
Joonsoo Kime42986d2012-08-15 23:25:38 +09001390 /*
1391 * If we cannot get the last gcwq from @work directly,
1392 * select the last CPU such that it avoids unnecessarily
1393 * triggering non-reentrancy check in __queue_work().
1394 */
1395 lcpu = cpu;
1396 if (gcwq)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001397 lcpu = gcwq->cpu;
Joonsoo Kime42986d2012-08-15 23:25:38 +09001398 if (lcpu == WORK_CPU_UNBOUND)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001399 lcpu = raw_smp_processor_id();
1400 } else {
1401 lcpu = WORK_CPU_UNBOUND;
1402 }
1403
1404 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1405
Tejun Heo12650572012-08-08 09:38:42 -07001406 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001407 timer->expires = jiffies + delay;
1408
1409 if (unlikely(cpu != WORK_CPU_UNBOUND))
1410 add_timer_on(timer, cpu);
1411 else
1412 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413}
1414
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001415/**
1416 * queue_delayed_work_on - queue work on specific CPU after delay
1417 * @cpu: CPU number to execute work on
1418 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001419 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001420 * @delay: number of jiffies to wait before queueing
1421 *
Tejun Heo715f1302012-08-03 10:30:46 -07001422 * Returns %false if @work was already on a queue, %true otherwise. If
1423 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1424 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001425 */
Tejun Heod4283e92012-08-03 10:30:44 -07001426bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1427 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001428{
David Howells52bad642006-11-22 14:54:01 +00001429 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001430 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001431 unsigned long flags;
1432
1433 /* read the comment in __queue_work() */
1434 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001435
Tejun Heo22df02b2010-06-29 10:07:10 +02001436 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001437 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001438 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001439 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001440
1441 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001442 return ret;
1443}
Dave Jonesae90dd52006-06-30 01:40:45 -04001444EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445
Tejun Heoc8e55f32010-06-29 10:07:12 +02001446/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001447 * queue_delayed_work - queue work on a workqueue after delay
1448 * @wq: workqueue to use
1449 * @dwork: delayable work to queue
1450 * @delay: number of jiffies to wait before queueing
1451 *
Tejun Heo715f1302012-08-03 10:30:46 -07001452 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001453 */
Tejun Heod4283e92012-08-03 10:30:44 -07001454bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001455 struct delayed_work *dwork, unsigned long delay)
1456{
Tejun Heo57469822012-08-03 10:30:45 -07001457 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001458}
1459EXPORT_SYMBOL_GPL(queue_delayed_work);
1460
1461/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001462 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1463 * @cpu: CPU number to execute work on
1464 * @wq: workqueue to use
1465 * @dwork: work to queue
1466 * @delay: number of jiffies to wait before queueing
1467 *
1468 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1469 * modify @dwork's timer so that it expires after @delay. If @delay is
1470 * zero, @work is guaranteed to be scheduled immediately regardless of its
1471 * current state.
1472 *
1473 * Returns %false if @dwork was idle and queued, %true if @dwork was
1474 * pending and its timer was modified.
1475 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001476 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001477 * See try_to_grab_pending() for details.
1478 */
1479bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1480 struct delayed_work *dwork, unsigned long delay)
1481{
1482 unsigned long flags;
1483 int ret;
1484
1485 do {
1486 ret = try_to_grab_pending(&dwork->work, true, &flags);
1487 } while (unlikely(ret == -EAGAIN));
1488
1489 if (likely(ret >= 0)) {
1490 __queue_delayed_work(cpu, wq, dwork, delay);
1491 local_irq_restore(flags);
1492 }
1493
1494 /* -ENOENT from try_to_grab_pending() becomes %true */
1495 return ret;
1496}
1497EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1498
1499/**
1500 * mod_delayed_work - modify delay of or queue a delayed work
1501 * @wq: workqueue to use
1502 * @dwork: work to queue
1503 * @delay: number of jiffies to wait before queueing
1504 *
1505 * mod_delayed_work_on() on local CPU.
1506 */
1507bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1508 unsigned long delay)
1509{
1510 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1511}
1512EXPORT_SYMBOL_GPL(mod_delayed_work);
1513
1514/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001515 * worker_enter_idle - enter idle state
1516 * @worker: worker which is entering idle state
1517 *
1518 * @worker is entering idle state. Update stats and idle timer if
1519 * necessary.
1520 *
1521 * LOCKING:
1522 * spin_lock_irq(gcwq->lock).
1523 */
1524static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001526 struct worker_pool *pool = worker->pool;
1527 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
Tejun Heoc8e55f32010-06-29 10:07:12 +02001529 BUG_ON(worker->flags & WORKER_IDLE);
1530 BUG_ON(!list_empty(&worker->entry) &&
1531 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Tejun Heocb444762010-07-02 10:03:50 +02001533 /* can't use worker_set_flags(), also called from start_worker() */
1534 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001535 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001536 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001537
Tejun Heoc8e55f32010-06-29 10:07:12 +02001538 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001539 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001540
Tejun Heo628c78e2012-07-17 12:39:27 -07001541 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1542 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001543
Tejun Heo544ecf32012-05-14 15:04:50 -07001544 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07001545 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1546 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1547 * nr_running, the warning may trigger spuriously. Check iff
1548 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001549 */
Tejun Heo628c78e2012-07-17 12:39:27 -07001550 WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001551 pool->nr_workers == pool->nr_idle &&
Tejun Heo63d95a92012-07-12 14:46:37 -07001552 atomic_read(get_pool_nr_running(pool)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553}
1554
Tejun Heoc8e55f32010-06-29 10:07:12 +02001555/**
1556 * worker_leave_idle - leave idle state
1557 * @worker: worker which is leaving idle state
1558 *
1559 * @worker is leaving idle state. Update stats.
1560 *
1561 * LOCKING:
1562 * spin_lock_irq(gcwq->lock).
1563 */
1564static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001566 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
Tejun Heoc8e55f32010-06-29 10:07:12 +02001568 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001569 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001570 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001571 list_del_init(&worker->entry);
1572}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
Tejun Heoe22bee72010-06-29 10:07:14 +02001574/**
1575 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1576 * @worker: self
1577 *
1578 * Works which are scheduled while the cpu is online must at least be
1579 * scheduled to a worker which is bound to the cpu so that if they are
1580 * flushed from cpu callbacks while cpu is going down, they are
1581 * guaranteed to execute on the cpu.
1582 *
1583 * This function is to be used by rogue workers and rescuers to bind
1584 * themselves to the target cpu and may race with cpu going down or
1585 * coming online. kthread_bind() can't be used because it may put the
1586 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1587 * verbatim as it's best effort and blocking and gcwq may be
1588 * [dis]associated in the meantime.
1589 *
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001590 * This function tries set_cpus_allowed() and locks gcwq and verifies the
1591 * binding against %GCWQ_DISASSOCIATED which is set during
1592 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1593 * enters idle state or fetches works without dropping lock, it can
1594 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001595 *
1596 * CONTEXT:
1597 * Might sleep. Called without any lock but returns with gcwq->lock
1598 * held.
1599 *
1600 * RETURNS:
1601 * %true if the associated gcwq is online (@worker is successfully
1602 * bound), %false if offline.
1603 */
1604static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001605__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001606{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001607 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001608 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609
Tejun Heoe22bee72010-06-29 10:07:14 +02001610 while (true) {
1611 /*
1612 * The following call may fail, succeed or succeed
1613 * without actually migrating the task to the cpu if
1614 * it races with cpu hotunplug operation. Verify
1615 * against GCWQ_DISASSOCIATED.
1616 */
Tejun Heof3421792010-07-02 10:03:51 +02001617 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1618 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001619
Tejun Heoe22bee72010-06-29 10:07:14 +02001620 spin_lock_irq(&gcwq->lock);
1621 if (gcwq->flags & GCWQ_DISASSOCIATED)
1622 return false;
1623 if (task_cpu(task) == gcwq->cpu &&
1624 cpumask_equal(&current->cpus_allowed,
1625 get_cpu_mask(gcwq->cpu)))
1626 return true;
1627 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001628
Tejun Heo5035b202011-04-29 18:08:37 +02001629 /*
1630 * We've raced with CPU hot[un]plug. Give it a breather
1631 * and retry migration. cond_resched() is required here;
1632 * otherwise, we might deadlock against cpu_stop trying to
1633 * bring down the CPU on non-preemptive kernel.
1634 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001635 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001636 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001637 }
1638}
1639
1640/*
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001641 * Rebind an idle @worker to its CPU. worker_thread() will test
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001642 * list_empty(@worker->entry) before leaving idle and call this function.
Tejun Heo25511a42012-07-17 12:39:27 -07001643 */
1644static void idle_worker_rebind(struct worker *worker)
1645{
1646 struct global_cwq *gcwq = worker->pool->gcwq;
1647
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001648 /* CPU may go down again inbetween, clear UNBOUND only on success */
1649 if (worker_maybe_bind_and_lock(worker))
1650 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heo25511a42012-07-17 12:39:27 -07001651
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001652 /* rebind complete, become available again */
1653 list_add(&worker->entry, &worker->pool->idle_list);
1654 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001655}
1656
1657/*
1658 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001659 * the associated cpu which is coming back online. This is scheduled by
1660 * cpu up but can race with other cpu hotplug operations and may be
1661 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001662 */
Tejun Heo25511a42012-07-17 12:39:27 -07001663static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001664{
1665 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001666 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001667
Lai Jiangshaneab6d822012-09-18 09:59:22 -07001668 if (worker_maybe_bind_and_lock(worker))
1669 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02001670
1671 spin_unlock_irq(&gcwq->lock);
1672}
1673
Tejun Heo25511a42012-07-17 12:39:27 -07001674/**
1675 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1676 * @gcwq: gcwq of interest
1677 *
1678 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1679 * is different for idle and busy ones.
1680 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001681 * Idle ones will be removed from the idle_list and woken up. They will
1682 * add themselves back after completing rebind. This ensures that the
1683 * idle_list doesn't contain any unbound workers when re-bound busy workers
1684 * try to perform local wake-ups for concurrency management.
Tejun Heo25511a42012-07-17 12:39:27 -07001685 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001686 * Busy workers can rebind after they finish their current work items.
1687 * Queueing the rebind work item at the head of the scheduled list is
1688 * enough. Note that nr_running will be properly bumped as busy workers
1689 * rebind.
Tejun Heo25511a42012-07-17 12:39:27 -07001690 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001691 * On return, all non-manager workers are scheduled for rebind - see
1692 * manage_workers() for the manager special case. Any idle worker
1693 * including the manager will not appear on @idle_list until rebind is
1694 * complete, making local wake-ups safe.
Tejun Heo25511a42012-07-17 12:39:27 -07001695 */
1696static void rebind_workers(struct global_cwq *gcwq)
Tejun Heo25511a42012-07-17 12:39:27 -07001697{
Tejun Heo25511a42012-07-17 12:39:27 -07001698 struct worker_pool *pool;
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001699 struct worker *worker, *n;
Tejun Heo25511a42012-07-17 12:39:27 -07001700 struct hlist_node *pos;
1701 int i;
1702
1703 lockdep_assert_held(&gcwq->lock);
1704
1705 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07001706 lockdep_assert_held(&pool->assoc_mutex);
Tejun Heo25511a42012-07-17 12:39:27 -07001707
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001708 /* dequeue and kick idle ones */
Tejun Heo25511a42012-07-17 12:39:27 -07001709 for_each_worker_pool(pool, gcwq) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001710 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001711 /*
1712 * idle workers should be off @pool->idle_list
1713 * until rebind is complete to avoid receiving
1714 * premature local wake-ups.
1715 */
1716 list_del_init(&worker->entry);
Lai Jiangshan96e65302012-09-02 00:28:19 +08001717
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001718 /*
1719 * worker_thread() will see the above dequeuing
1720 * and call idle_worker_rebind().
1721 */
Tejun Heo25511a42012-07-17 12:39:27 -07001722 wake_up_process(worker->task);
1723 }
1724 }
1725
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001726 /* rebind busy workers */
Tejun Heo25511a42012-07-17 12:39:27 -07001727 for_each_busy_worker(worker, i, pos, gcwq) {
1728 struct work_struct *rebind_work = &worker->rebind_work;
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001729 struct workqueue_struct *wq;
Tejun Heo25511a42012-07-17 12:39:27 -07001730
1731 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1732 work_data_bits(rebind_work)))
1733 continue;
1734
Tejun Heo25511a42012-07-17 12:39:27 -07001735 debug_work_activate(rebind_work);
Tejun Heo90beca52012-09-04 23:12:33 -07001736
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001737 /*
1738 * wq doesn't really matter but let's keep @worker->pool
1739 * and @cwq->pool consistent for sanity.
1740 */
1741 if (worker_pool_pri(worker->pool))
1742 wq = system_highpri_wq;
1743 else
1744 wq = system_wq;
Tejun Heoec588152012-09-04 23:16:32 -07001745
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001746 insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
1747 worker->scheduled.next,
1748 work_color_to_flags(WORK_NO_COLOR));
Tejun Heoec588152012-09-04 23:16:32 -07001749 }
Tejun Heo25511a42012-07-17 12:39:27 -07001750}
1751
Tejun Heoc34056a2010-06-29 10:07:11 +02001752static struct worker *alloc_worker(void)
1753{
1754 struct worker *worker;
1755
1756 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001757 if (worker) {
1758 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001759 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001760 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001761 /* on creation a worker is in !idle && prep state */
1762 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001763 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001764 return worker;
1765}
1766
1767/**
1768 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001769 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001770 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001771 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001772 * can be started by calling start_worker() or destroyed using
1773 * destroy_worker().
1774 *
1775 * CONTEXT:
1776 * Might sleep. Does GFP_KERNEL allocations.
1777 *
1778 * RETURNS:
1779 * Pointer to the newly created worker.
1780 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001781static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001782{
Tejun Heo63d95a92012-07-12 14:46:37 -07001783 struct global_cwq *gcwq = pool->gcwq;
Tejun Heo32704762012-07-13 22:16:45 -07001784 const char *pri = worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001785 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001786 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001787
Tejun Heo8b03ae32010-06-29 10:07:12 +02001788 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001789 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001790 spin_unlock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001791 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001792 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001793 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001794 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001795 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001796
1797 worker = alloc_worker();
1798 if (!worker)
1799 goto fail;
1800
Tejun Heobd7bdd42012-07-12 14:46:37 -07001801 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001802 worker->id = id;
1803
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001804 if (gcwq->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001805 worker->task = kthread_create_on_node(worker_thread,
Tejun Heo32704762012-07-13 22:16:45 -07001806 worker, cpu_to_node(gcwq->cpu),
1807 "kworker/%u:%d%s", gcwq->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001808 else
1809 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001810 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001811 if (IS_ERR(worker->task))
1812 goto fail;
1813
Tejun Heo32704762012-07-13 22:16:45 -07001814 if (worker_pool_pri(pool))
1815 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1816
Tejun Heodb7bccf2010-06-29 10:07:12 +02001817 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001818 * Determine CPU binding of the new worker depending on
1819 * %GCWQ_DISASSOCIATED. The caller is responsible for ensuring the
1820 * flag remains stable across this function. See the comments
1821 * above the flag definition for details.
1822 *
1823 * As an unbound worker may later become a regular one if CPU comes
1824 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001825 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001826 if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001827 kthread_bind(worker->task, gcwq->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001828 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001829 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001830 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001832
Tejun Heoc34056a2010-06-29 10:07:11 +02001833 return worker;
1834fail:
1835 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001836 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001837 ida_remove(&pool->worker_ida, id);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001838 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001839 }
1840 kfree(worker);
1841 return NULL;
1842}
1843
1844/**
1845 * start_worker - start a newly created worker
1846 * @worker: worker to start
1847 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001848 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001849 *
1850 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001851 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001852 */
1853static void start_worker(struct worker *worker)
1854{
Tejun Heocb444762010-07-02 10:03:50 +02001855 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001856 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001857 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001858 wake_up_process(worker->task);
1859}
1860
1861/**
1862 * destroy_worker - destroy a workqueue worker
1863 * @worker: worker to be destroyed
1864 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001865 * Destroy @worker and adjust @gcwq stats accordingly.
1866 *
1867 * CONTEXT:
1868 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001869 */
1870static void destroy_worker(struct worker *worker)
1871{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001872 struct worker_pool *pool = worker->pool;
1873 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001874 int id = worker->id;
1875
1876 /* sanity check frenzy */
1877 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001878 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001879
Tejun Heoc8e55f32010-06-29 10:07:12 +02001880 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001881 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001882 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001883 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001884
1885 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001886 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001887
1888 spin_unlock_irq(&gcwq->lock);
1889
Tejun Heoc34056a2010-06-29 10:07:11 +02001890 kthread_stop(worker->task);
1891 kfree(worker);
1892
Tejun Heo8b03ae32010-06-29 10:07:12 +02001893 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001894 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001895}
1896
Tejun Heo63d95a92012-07-12 14:46:37 -07001897static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001898{
Tejun Heo63d95a92012-07-12 14:46:37 -07001899 struct worker_pool *pool = (void *)__pool;
1900 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001901
1902 spin_lock_irq(&gcwq->lock);
1903
Tejun Heo63d95a92012-07-12 14:46:37 -07001904 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001905 struct worker *worker;
1906 unsigned long expires;
1907
1908 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001909 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001910 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1911
1912 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001913 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001914 else {
1915 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001916 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001917 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001918 }
1919 }
1920
1921 spin_unlock_irq(&gcwq->lock);
1922}
1923
1924static bool send_mayday(struct work_struct *work)
1925{
1926 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1927 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001928 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001929
1930 if (!(wq->flags & WQ_RESCUER))
1931 return false;
1932
1933 /* mayday mayday mayday */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001934 cpu = cwq->pool->gcwq->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001935 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1936 if (cpu == WORK_CPU_UNBOUND)
1937 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001938 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001939 wake_up_process(wq->rescuer->task);
1940 return true;
1941}
1942
Tejun Heo63d95a92012-07-12 14:46:37 -07001943static void gcwq_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001944{
Tejun Heo63d95a92012-07-12 14:46:37 -07001945 struct worker_pool *pool = (void *)__pool;
1946 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001947 struct work_struct *work;
1948
1949 spin_lock_irq(&gcwq->lock);
1950
Tejun Heo63d95a92012-07-12 14:46:37 -07001951 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001952 /*
1953 * We've been trying to create a new worker but
1954 * haven't been successful. We might be hitting an
1955 * allocation deadlock. Send distress signals to
1956 * rescuers.
1957 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001958 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001959 send_mayday(work);
1960 }
1961
1962 spin_unlock_irq(&gcwq->lock);
1963
Tejun Heo63d95a92012-07-12 14:46:37 -07001964 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001965}
1966
1967/**
1968 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001969 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001970 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001971 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001972 * have at least one idle worker on return from this function. If
1973 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001974 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001975 * possible allocation deadlock.
1976 *
1977 * On return, need_to_create_worker() is guaranteed to be false and
1978 * may_start_working() true.
1979 *
1980 * LOCKING:
1981 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1982 * multiple times. Does GFP_KERNEL allocations. Called only from
1983 * manager.
1984 *
1985 * RETURNS:
1986 * false if no action was taken and gcwq->lock stayed locked, true
1987 * otherwise.
1988 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001989static bool maybe_create_worker(struct worker_pool *pool)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001990__releases(&gcwq->lock)
1991__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001992{
Tejun Heo63d95a92012-07-12 14:46:37 -07001993 struct global_cwq *gcwq = pool->gcwq;
1994
1995 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001996 return false;
1997restart:
Tejun Heo9f9c236442010-07-14 11:31:20 +02001998 spin_unlock_irq(&gcwq->lock);
1999
Tejun Heoe22bee72010-06-29 10:07:14 +02002000 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002001 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002002
2003 while (true) {
2004 struct worker *worker;
2005
Tejun Heobc2ae0f2012-07-17 12:39:27 -07002006 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002007 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002008 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002009 spin_lock_irq(&gcwq->lock);
2010 start_worker(worker);
Tejun Heo63d95a92012-07-12 14:46:37 -07002011 BUG_ON(need_to_create_worker(pool));
Tejun Heoe22bee72010-06-29 10:07:14 +02002012 return true;
2013 }
2014
Tejun Heo63d95a92012-07-12 14:46:37 -07002015 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002016 break;
2017
Tejun Heoe22bee72010-06-29 10:07:14 +02002018 __set_current_state(TASK_INTERRUPTIBLE);
2019 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002020
Tejun Heo63d95a92012-07-12 14:46:37 -07002021 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002022 break;
2023 }
2024
Tejun Heo63d95a92012-07-12 14:46:37 -07002025 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002026 spin_lock_irq(&gcwq->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07002027 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002028 goto restart;
2029 return true;
2030}
2031
2032/**
2033 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07002034 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02002035 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002036 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02002037 * IDLE_WORKER_TIMEOUT.
2038 *
2039 * LOCKING:
2040 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2041 * multiple times. Called only from manager.
2042 *
2043 * RETURNS:
2044 * false if no action was taken and gcwq->lock stayed locked, true
2045 * otherwise.
2046 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002047static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02002048{
2049 bool ret = false;
2050
Tejun Heo63d95a92012-07-12 14:46:37 -07002051 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002052 struct worker *worker;
2053 unsigned long expires;
2054
Tejun Heo63d95a92012-07-12 14:46:37 -07002055 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002056 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2057
2058 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002059 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002060 break;
2061 }
2062
2063 destroy_worker(worker);
2064 ret = true;
2065 }
2066
2067 return ret;
2068}
2069
2070/**
2071 * manage_workers - manage worker pool
2072 * @worker: self
2073 *
2074 * Assume the manager role and manage gcwq worker pool @worker belongs
2075 * to. At any given time, there can be only zero or one manager per
2076 * gcwq. The exclusion is handled automatically by this function.
2077 *
2078 * The caller can safely start processing works on false return. On
2079 * true return, it's guaranteed that need_to_create_worker() is false
2080 * and may_start_working() is true.
2081 *
2082 * CONTEXT:
2083 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2084 * multiple times. Does GFP_KERNEL allocations.
2085 *
2086 * RETURNS:
2087 * false if no action was taken and gcwq->lock stayed locked, true if
2088 * some action was taken.
2089 */
2090static bool manage_workers(struct worker *worker)
2091{
Tejun Heo63d95a92012-07-12 14:46:37 -07002092 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002093 bool ret = false;
2094
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002095 if (pool->flags & POOL_MANAGING_WORKERS)
Tejun Heoe22bee72010-06-29 10:07:14 +02002096 return ret;
2097
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002098 pool->flags |= POOL_MANAGING_WORKERS;
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002099
2100 /*
2101 * To simplify both worker management and CPU hotplug, hold off
2102 * management while hotplug is in progress. CPU hotplug path can't
2103 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2104 * lead to idle worker depletion (all become busy thinking someone
2105 * else is managing) which in turn can result in deadlock under
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002106 * extreme circumstances. Use @pool->assoc_mutex to synchronize
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002107 * manager against CPU hotplug.
2108 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002109 * assoc_mutex would always be free unless CPU hotplug is in
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002110 * progress. trylock first without dropping @gcwq->lock.
2111 */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002112 if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002113 spin_unlock_irq(&pool->gcwq->lock);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002114 mutex_lock(&pool->assoc_mutex);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002115 /*
2116 * CPU hotplug could have happened while we were waiting
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002117 * for assoc_mutex. Hotplug itself can't handle us
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002118 * because manager isn't either on idle or busy list, and
2119 * @gcwq's state and ours could have deviated.
2120 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002121 * As hotplug is now excluded via assoc_mutex, we can
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002122 * simply try to bind. It will succeed or fail depending
2123 * on @gcwq's current state. Try it and adjust
2124 * %WORKER_UNBOUND accordingly.
2125 */
2126 if (worker_maybe_bind_and_lock(worker))
2127 worker->flags &= ~WORKER_UNBOUND;
2128 else
2129 worker->flags |= WORKER_UNBOUND;
2130
2131 ret = true;
2132 }
2133
Tejun Heo11ebea52012-07-12 14:46:37 -07002134 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002135
2136 /*
2137 * Destroy and then create so that may_start_working() is true
2138 * on return.
2139 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002140 ret |= maybe_destroy_workers(pool);
2141 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002142
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002143 pool->flags &= ~POOL_MANAGING_WORKERS;
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002144 mutex_unlock(&pool->assoc_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002145 return ret;
2146}
2147
Tejun Heoa62428c2010-06-29 10:07:10 +02002148/**
2149 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002150 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002151 * @work: work to process
2152 *
2153 * Process @work. This function contains all the logics necessary to
2154 * process a single work including synchronization against and
2155 * interaction with other workers on the same cpu, queueing and
2156 * flushing. As long as context requirement is met, any worker can
2157 * call this function to process a work.
2158 *
2159 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002160 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002161 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002162static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09002163__releases(&gcwq->lock)
2164__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002165{
Tejun Heo7e116292010-06-29 10:07:13 +02002166 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002167 struct worker_pool *pool = worker->pool;
2168 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002169 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002170 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02002171 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02002172 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002173 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002174#ifdef CONFIG_LOCKDEP
2175 /*
2176 * It is permissible to free the struct work_struct from
2177 * inside the function that is called from it, this we need to
2178 * take into account for lockdep too. To avoid bogus "held
2179 * lock freed" warnings as well as problems when looking into
2180 * work->lockdep_map, make a copy and use that here.
2181 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002182 struct lockdep_map lockdep_map;
2183
2184 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002185#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002186 /*
2187 * Ensure we're on the correct CPU. DISASSOCIATED test is
2188 * necessary to avoid spurious warnings from rescuers servicing the
2189 * unbound or a disassociated gcwq.
2190 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002191 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo6fec10a2012-07-22 10:16:34 -07002192 !(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heo25511a42012-07-17 12:39:27 -07002193 raw_smp_processor_id() != gcwq->cpu);
2194
Tejun Heo7e116292010-06-29 10:07:13 +02002195 /*
2196 * A single work shouldn't be executed concurrently by
2197 * multiple workers on a single cpu. Check whether anyone is
2198 * already processing the work. If so, defer the work to the
2199 * currently executing one.
2200 */
2201 collision = __find_worker_executing_work(gcwq, bwh, work);
2202 if (unlikely(collision)) {
2203 move_linked_works(work, &collision->scheduled, NULL);
2204 return;
2205 }
2206
Tejun Heo8930cab2012-08-03 10:30:45 -07002207 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002208 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002209 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02002210 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002211 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002212 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002213
Tejun Heoa62428c2010-06-29 10:07:10 +02002214 list_del_init(&work->entry);
2215
Tejun Heo649027d2010-06-29 10:07:14 +02002216 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002217 * CPU intensive works don't participate in concurrency
2218 * management. They're the scheduler's responsibility.
2219 */
2220 if (unlikely(cpu_intensive))
2221 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2222
Tejun Heo974271c2012-07-12 14:46:37 -07002223 /*
2224 * Unbound gcwq isn't concurrency managed and work items should be
2225 * executed ASAP. Wake up another worker if necessary.
2226 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002227 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2228 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002229
Tejun Heo8930cab2012-08-03 10:30:45 -07002230 /*
Tejun Heo23657bb2012-08-13 17:08:19 -07002231 * Record the last CPU and clear PENDING which should be the last
2232 * update to @work. Also, do this inside @gcwq->lock so that
2233 * PENDING and queued state changes happen together while IRQ is
2234 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002235 */
Tejun Heo8930cab2012-08-03 10:30:45 -07002236 set_work_cpu_and_clear_pending(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02002237
Tejun Heoa62428c2010-06-29 10:07:10 +02002238 spin_unlock_irq(&gcwq->lock);
2239
Tejun Heoe159489b2011-01-09 23:32:15 +01002240 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002241 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002242 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002243 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002244 /*
2245 * While we must be careful to not use "work" after this, the trace
2246 * point will only record its address.
2247 */
2248 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002249 lock_map_release(&lockdep_map);
2250 lock_map_release(&cwq->wq->lockdep_map);
2251
2252 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002253 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2254 " last function: %pf\n",
2255 current->comm, preempt_count(), task_pid_nr(current), f);
Tejun Heoa62428c2010-06-29 10:07:10 +02002256 debug_show_held_locks(current);
2257 dump_stack();
2258 }
2259
Tejun Heo8b03ae32010-06-29 10:07:12 +02002260 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002261
Tejun Heofb0e7be2010-06-29 10:07:15 +02002262 /* clear cpu intensive status */
2263 if (unlikely(cpu_intensive))
2264 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2265
Tejun Heoa62428c2010-06-29 10:07:10 +02002266 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02002267 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002268 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002269 worker->current_cwq = NULL;
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07002270 cwq_dec_nr_in_flight(cwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002271}
2272
Tejun Heoaffee4b2010-06-29 10:07:12 +02002273/**
2274 * process_scheduled_works - process scheduled works
2275 * @worker: self
2276 *
2277 * Process all scheduled works. Please note that the scheduled list
2278 * may change while processing a work, so this function repeatedly
2279 * fetches a work from the top and executes it.
2280 *
2281 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002282 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002283 * multiple times.
2284 */
2285static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002287 while (!list_empty(&worker->scheduled)) {
2288 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002290 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292}
2293
Tejun Heo4690c4a2010-06-29 10:07:10 +02002294/**
2295 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002296 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002297 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002298 * The gcwq worker thread function. There's a single dynamic pool of
2299 * these per each cpu. These workers process all works regardless of
2300 * their specific target workqueue. The only exception is works which
2301 * belong to workqueues with a rescuer which will be explained in
2302 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002303 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002304static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305{
Tejun Heoc34056a2010-06-29 10:07:11 +02002306 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002307 struct worker_pool *pool = worker->pool;
2308 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309
Tejun Heoe22bee72010-06-29 10:07:14 +02002310 /* tell the scheduler that this is a workqueue worker */
2311 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002312woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002313 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002315 /* we are off idle list if destruction or rebind is requested */
2316 if (unlikely(list_empty(&worker->entry))) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002317 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002318
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002319 /* if DIE is set, destruction is requested */
Tejun Heo25511a42012-07-17 12:39:27 -07002320 if (worker->flags & WORKER_DIE) {
2321 worker->task->flags &= ~PF_WQ_WORKER;
2322 return 0;
2323 }
2324
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002325 /* otherwise, rebind */
Tejun Heo25511a42012-07-17 12:39:27 -07002326 idle_worker_rebind(worker);
2327 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328 }
2329
Tejun Heoc8e55f32010-06-29 10:07:12 +02002330 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002331recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002332 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002333 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002334 goto sleep;
2335
2336 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002337 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002338 goto recheck;
2339
Tejun Heoc8e55f32010-06-29 10:07:12 +02002340 /*
2341 * ->scheduled list can only be filled while a worker is
2342 * preparing to process a work or actually processing it.
2343 * Make sure nobody diddled with it while I was sleeping.
2344 */
2345 BUG_ON(!list_empty(&worker->scheduled));
2346
Tejun Heoe22bee72010-06-29 10:07:14 +02002347 /*
2348 * When control reaches this point, we're guaranteed to have
2349 * at least one idle worker or that someone else has already
2350 * assumed the manager role.
2351 */
2352 worker_clr_flags(worker, WORKER_PREP);
2353
2354 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002355 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002356 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002357 struct work_struct, entry);
2358
2359 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2360 /* optimization path, not strictly necessary */
2361 process_one_work(worker, work);
2362 if (unlikely(!list_empty(&worker->scheduled)))
2363 process_scheduled_works(worker);
2364 } else {
2365 move_linked_works(work, &worker->scheduled, NULL);
2366 process_scheduled_works(worker);
2367 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002368 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002369
Tejun Heoe22bee72010-06-29 10:07:14 +02002370 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002371sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002372 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002373 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002374
Tejun Heoc8e55f32010-06-29 10:07:12 +02002375 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002376 * gcwq->lock is held and there's no work to process and no
2377 * need to manage, sleep. Workers are woken up only while
2378 * holding gcwq->lock or from local cpu, so setting the
2379 * current state before releasing gcwq->lock is enough to
2380 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002381 */
2382 worker_enter_idle(worker);
2383 __set_current_state(TASK_INTERRUPTIBLE);
2384 spin_unlock_irq(&gcwq->lock);
2385 schedule();
2386 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387}
2388
Tejun Heoe22bee72010-06-29 10:07:14 +02002389/**
2390 * rescuer_thread - the rescuer thread function
2391 * @__wq: the associated workqueue
2392 *
2393 * Workqueue rescuer thread function. There's one rescuer for each
2394 * workqueue which has WQ_RESCUER set.
2395 *
2396 * Regular work processing on a gcwq may block trying to create a new
2397 * worker which uses GFP_KERNEL allocation which has slight chance of
2398 * developing into deadlock if some works currently on the same queue
2399 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2400 * the problem rescuer solves.
2401 *
2402 * When such condition is possible, the gcwq summons rescuers of all
2403 * workqueues which have works queued on the gcwq and let them process
2404 * those works so that forward progress can be guaranteed.
2405 *
2406 * This should happen rarely.
2407 */
2408static int rescuer_thread(void *__wq)
2409{
2410 struct workqueue_struct *wq = __wq;
2411 struct worker *rescuer = wq->rescuer;
2412 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002413 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002414 unsigned int cpu;
2415
2416 set_user_nice(current, RESCUER_NICE_LEVEL);
2417repeat:
2418 set_current_state(TASK_INTERRUPTIBLE);
2419
Mike Galbraith412d32e2012-11-28 07:17:18 +01002420 if (kthread_should_stop()) {
2421 __set_current_state(TASK_RUNNING);
Tejun Heoe22bee72010-06-29 10:07:14 +02002422 return 0;
Mike Galbraith412d32e2012-11-28 07:17:18 +01002423 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002424
Tejun Heof3421792010-07-02 10:03:51 +02002425 /*
2426 * See whether any cpu is asking for help. Unbounded
2427 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2428 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002429 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002430 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2431 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002432 struct worker_pool *pool = cwq->pool;
2433 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002434 struct work_struct *work, *n;
2435
2436 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002437 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002438
2439 /* migrate to the target cpu if possible */
Tejun Heobd7bdd42012-07-12 14:46:37 -07002440 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002441 worker_maybe_bind_and_lock(rescuer);
2442
2443 /*
2444 * Slurp in all works issued via this workqueue and
2445 * process'em.
2446 */
2447 BUG_ON(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002448 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002449 if (get_work_cwq(work) == cwq)
2450 move_linked_works(work, scheduled, &n);
2451
2452 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002453
2454 /*
2455 * Leave this gcwq. If keep_working() is %true, notify a
2456 * regular worker; otherwise, we end up with 0 concurrency
2457 * and stalling the execution.
2458 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002459 if (keep_working(pool))
2460 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002461
Tejun Heoe22bee72010-06-29 10:07:14 +02002462 spin_unlock_irq(&gcwq->lock);
2463 }
2464
2465 schedule();
2466 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467}
2468
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002469struct wq_barrier {
2470 struct work_struct work;
2471 struct completion done;
2472};
2473
2474static void wq_barrier_func(struct work_struct *work)
2475{
2476 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2477 complete(&barr->done);
2478}
2479
Tejun Heo4690c4a2010-06-29 10:07:10 +02002480/**
2481 * insert_wq_barrier - insert a barrier work
2482 * @cwq: cwq to insert barrier into
2483 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002484 * @target: target work to attach @barr to
2485 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002486 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002487 * @barr is linked to @target such that @barr is completed only after
2488 * @target finishes execution. Please note that the ordering
2489 * guarantee is observed only with respect to @target and on the local
2490 * cpu.
2491 *
2492 * Currently, a queued barrier can't be canceled. This is because
2493 * try_to_grab_pending() can't determine whether the work to be
2494 * grabbed is at the head of the queue and thus can't clear LINKED
2495 * flag of the previous work while there must be a valid next work
2496 * after a work with LINKED flag set.
2497 *
2498 * Note that when @worker is non-NULL, @target may be modified
2499 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002500 *
2501 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002502 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002503 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002504static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002505 struct wq_barrier *barr,
2506 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002507{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002508 struct list_head *head;
2509 unsigned int linked = 0;
2510
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002511 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002512 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002513 * as we know for sure that this will not trigger any of the
2514 * checks and call back into the fixup functions where we
2515 * might deadlock.
2516 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002517 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002518 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002519 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002520
Tejun Heoaffee4b2010-06-29 10:07:12 +02002521 /*
2522 * If @target is currently being executed, schedule the
2523 * barrier to the worker; otherwise, put it after @target.
2524 */
2525 if (worker)
2526 head = worker->scheduled.next;
2527 else {
2528 unsigned long *bits = work_data_bits(target);
2529
2530 head = target->entry.next;
2531 /* there can already be other linked works, inherit and set */
2532 linked = *bits & WORK_STRUCT_LINKED;
2533 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2534 }
2535
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002536 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002537 insert_work(cwq, &barr->work, head,
2538 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002539}
2540
Tejun Heo73f53c42010-06-29 10:07:11 +02002541/**
2542 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2543 * @wq: workqueue being flushed
2544 * @flush_color: new flush color, < 0 for no-op
2545 * @work_color: new work color, < 0 for no-op
2546 *
2547 * Prepare cwqs for workqueue flushing.
2548 *
2549 * If @flush_color is non-negative, flush_color on all cwqs should be
2550 * -1. If no cwq has in-flight commands at the specified color, all
2551 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2552 * has in flight commands, its cwq->flush_color is set to
2553 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2554 * wakeup logic is armed and %true is returned.
2555 *
2556 * The caller should have initialized @wq->first_flusher prior to
2557 * calling this function with non-negative @flush_color. If
2558 * @flush_color is negative, no flush color update is done and %false
2559 * is returned.
2560 *
2561 * If @work_color is non-negative, all cwqs should have the same
2562 * work_color which is previous to @work_color and all will be
2563 * advanced to @work_color.
2564 *
2565 * CONTEXT:
2566 * mutex_lock(wq->flush_mutex).
2567 *
2568 * RETURNS:
2569 * %true if @flush_color >= 0 and there's something to flush. %false
2570 * otherwise.
2571 */
2572static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2573 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574{
Tejun Heo73f53c42010-06-29 10:07:11 +02002575 bool wait = false;
2576 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002577
Tejun Heo73f53c42010-06-29 10:07:11 +02002578 if (flush_color >= 0) {
2579 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2580 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002581 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002582
Tejun Heof3421792010-07-02 10:03:51 +02002583 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002584 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002585 struct global_cwq *gcwq = cwq->pool->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002586
Tejun Heo8b03ae32010-06-29 10:07:12 +02002587 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002588
2589 if (flush_color >= 0) {
2590 BUG_ON(cwq->flush_color != -1);
2591
2592 if (cwq->nr_in_flight[flush_color]) {
2593 cwq->flush_color = flush_color;
2594 atomic_inc(&wq->nr_cwqs_to_flush);
2595 wait = true;
2596 }
2597 }
2598
2599 if (work_color >= 0) {
2600 BUG_ON(work_color != work_next_color(cwq->work_color));
2601 cwq->work_color = work_color;
2602 }
2603
Tejun Heo8b03ae32010-06-29 10:07:12 +02002604 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002605 }
2606
2607 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2608 complete(&wq->first_flusher->done);
2609
2610 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002611}
2612
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002613/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002615 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616 *
2617 * Forces execution of the workqueue and blocks until its completion.
2618 * This is typically used in driver shutdown handlers.
2619 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002620 * We sleep until all works which were queued on entry have been handled,
2621 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002623void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624{
Tejun Heo73f53c42010-06-29 10:07:11 +02002625 struct wq_flusher this_flusher = {
2626 .list = LIST_HEAD_INIT(this_flusher.list),
2627 .flush_color = -1,
2628 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2629 };
2630 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002631
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002632 lock_map_acquire(&wq->lockdep_map);
2633 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002634
2635 mutex_lock(&wq->flush_mutex);
2636
2637 /*
2638 * Start-to-wait phase
2639 */
2640 next_color = work_next_color(wq->work_color);
2641
2642 if (next_color != wq->flush_color) {
2643 /*
2644 * Color space is not full. The current work_color
2645 * becomes our flush_color and work_color is advanced
2646 * by one.
2647 */
2648 BUG_ON(!list_empty(&wq->flusher_overflow));
2649 this_flusher.flush_color = wq->work_color;
2650 wq->work_color = next_color;
2651
2652 if (!wq->first_flusher) {
2653 /* no flush in progress, become the first flusher */
2654 BUG_ON(wq->flush_color != this_flusher.flush_color);
2655
2656 wq->first_flusher = &this_flusher;
2657
2658 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2659 wq->work_color)) {
2660 /* nothing to flush, done */
2661 wq->flush_color = next_color;
2662 wq->first_flusher = NULL;
2663 goto out_unlock;
2664 }
2665 } else {
2666 /* wait in queue */
2667 BUG_ON(wq->flush_color == this_flusher.flush_color);
2668 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2669 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2670 }
2671 } else {
2672 /*
2673 * Oops, color space is full, wait on overflow queue.
2674 * The next flush completion will assign us
2675 * flush_color and transfer to flusher_queue.
2676 */
2677 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2678 }
2679
2680 mutex_unlock(&wq->flush_mutex);
2681
2682 wait_for_completion(&this_flusher.done);
2683
2684 /*
2685 * Wake-up-and-cascade phase
2686 *
2687 * First flushers are responsible for cascading flushes and
2688 * handling overflow. Non-first flushers can simply return.
2689 */
2690 if (wq->first_flusher != &this_flusher)
2691 return;
2692
2693 mutex_lock(&wq->flush_mutex);
2694
Tejun Heo4ce48b32010-07-02 10:03:51 +02002695 /* we might have raced, check again with mutex held */
2696 if (wq->first_flusher != &this_flusher)
2697 goto out_unlock;
2698
Tejun Heo73f53c42010-06-29 10:07:11 +02002699 wq->first_flusher = NULL;
2700
2701 BUG_ON(!list_empty(&this_flusher.list));
2702 BUG_ON(wq->flush_color != this_flusher.flush_color);
2703
2704 while (true) {
2705 struct wq_flusher *next, *tmp;
2706
2707 /* complete all the flushers sharing the current flush color */
2708 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2709 if (next->flush_color != wq->flush_color)
2710 break;
2711 list_del_init(&next->list);
2712 complete(&next->done);
2713 }
2714
2715 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2716 wq->flush_color != work_next_color(wq->work_color));
2717
2718 /* this flush_color is finished, advance by one */
2719 wq->flush_color = work_next_color(wq->flush_color);
2720
2721 /* one color has been freed, handle overflow queue */
2722 if (!list_empty(&wq->flusher_overflow)) {
2723 /*
2724 * Assign the same color to all overflowed
2725 * flushers, advance work_color and append to
2726 * flusher_queue. This is the start-to-wait
2727 * phase for these overflowed flushers.
2728 */
2729 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2730 tmp->flush_color = wq->work_color;
2731
2732 wq->work_color = work_next_color(wq->work_color);
2733
2734 list_splice_tail_init(&wq->flusher_overflow,
2735 &wq->flusher_queue);
2736 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2737 }
2738
2739 if (list_empty(&wq->flusher_queue)) {
2740 BUG_ON(wq->flush_color != wq->work_color);
2741 break;
2742 }
2743
2744 /*
2745 * Need to flush more colors. Make the next flusher
2746 * the new first flusher and arm cwqs.
2747 */
2748 BUG_ON(wq->flush_color == wq->work_color);
2749 BUG_ON(wq->flush_color != next->flush_color);
2750
2751 list_del_init(&next->list);
2752 wq->first_flusher = next;
2753
2754 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2755 break;
2756
2757 /*
2758 * Meh... this color is already done, clear first
2759 * flusher and repeat cascading.
2760 */
2761 wq->first_flusher = NULL;
2762 }
2763
2764out_unlock:
2765 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766}
Dave Jonesae90dd52006-06-30 01:40:45 -04002767EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002769/**
2770 * drain_workqueue - drain a workqueue
2771 * @wq: workqueue to drain
2772 *
2773 * Wait until the workqueue becomes empty. While draining is in progress,
2774 * only chain queueing is allowed. IOW, only currently pending or running
2775 * work items on @wq can queue further work items on it. @wq is flushed
2776 * repeatedly until it becomes empty. The number of flushing is detemined
2777 * by the depth of chaining and should be relatively short. Whine if it
2778 * takes too long.
2779 */
2780void drain_workqueue(struct workqueue_struct *wq)
2781{
2782 unsigned int flush_cnt = 0;
2783 unsigned int cpu;
2784
2785 /*
2786 * __queue_work() needs to test whether there are drainers, is much
2787 * hotter than drain_workqueue() and already looks at @wq->flags.
2788 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2789 */
2790 spin_lock(&workqueue_lock);
2791 if (!wq->nr_drainers++)
2792 wq->flags |= WQ_DRAINING;
2793 spin_unlock(&workqueue_lock);
2794reflush:
2795 flush_workqueue(wq);
2796
2797 for_each_cwq_cpu(cpu, wq) {
2798 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002799 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002800
Tejun Heobd7bdd42012-07-12 14:46:37 -07002801 spin_lock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002802 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002803 spin_unlock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002804
2805 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002806 continue;
2807
2808 if (++flush_cnt == 10 ||
2809 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Valentin Ilie044c7822012-08-19 00:52:42 +03002810 pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
2811 wq->name, flush_cnt);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002812 goto reflush;
2813 }
2814
2815 spin_lock(&workqueue_lock);
2816 if (!--wq->nr_drainers)
2817 wq->flags &= ~WQ_DRAINING;
2818 spin_unlock(&workqueue_lock);
2819}
2820EXPORT_SYMBOL_GPL(drain_workqueue);
2821
Tejun Heo606a5022012-08-20 14:51:23 -07002822static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002823{
2824 struct worker *worker = NULL;
2825 struct global_cwq *gcwq;
2826 struct cpu_workqueue_struct *cwq;
2827
2828 might_sleep();
2829 gcwq = get_work_gcwq(work);
2830 if (!gcwq)
2831 return false;
2832
2833 spin_lock_irq(&gcwq->lock);
2834 if (!list_empty(&work->entry)) {
2835 /*
2836 * See the comment near try_to_grab_pending()->smp_rmb().
2837 * If it was re-queued to a different gcwq under us, we
2838 * are not going to wait.
2839 */
2840 smp_rmb();
2841 cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002842 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
Tejun Heobaf59022010-09-16 10:42:16 +02002843 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002844 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002845 worker = find_worker_executing_work(gcwq, work);
2846 if (!worker)
2847 goto already_gone;
2848 cwq = worker->current_cwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002849 }
Tejun Heobaf59022010-09-16 10:42:16 +02002850
2851 insert_wq_barrier(cwq, barr, work, worker);
2852 spin_unlock_irq(&gcwq->lock);
2853
Tejun Heoe159489b2011-01-09 23:32:15 +01002854 /*
2855 * If @max_active is 1 or rescuer is in use, flushing another work
2856 * item on the same workqueue may lead to deadlock. Make sure the
2857 * flusher is not running on the same workqueue by verifying write
2858 * access.
2859 */
2860 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2861 lock_map_acquire(&cwq->wq->lockdep_map);
2862 else
2863 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002864 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe159489b2011-01-09 23:32:15 +01002865
Tejun Heobaf59022010-09-16 10:42:16 +02002866 return true;
2867already_gone:
2868 spin_unlock_irq(&gcwq->lock);
2869 return false;
2870}
2871
Oleg Nesterovdb700892008-07-25 01:47:49 -07002872/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002873 * flush_work - wait for a work to finish executing the last queueing instance
2874 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002875 *
Tejun Heo606a5022012-08-20 14:51:23 -07002876 * Wait until @work has finished execution. @work is guaranteed to be idle
2877 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002878 *
2879 * RETURNS:
2880 * %true if flush_work() waited for the work to finish execution,
2881 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002882 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002883bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002884{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002885 struct wq_barrier barr;
2886
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002887 lock_map_acquire(&work->lockdep_map);
2888 lock_map_release(&work->lockdep_map);
2889
Tejun Heo606a5022012-08-20 14:51:23 -07002890 if (start_flush_work(work, &barr)) {
Tejun Heobaf59022010-09-16 10:42:16 +02002891 wait_for_completion(&barr.done);
2892 destroy_work_on_stack(&barr.work);
2893 return true;
Tejun Heo606a5022012-08-20 14:51:23 -07002894 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002895 return false;
Tejun Heo606a5022012-08-20 14:51:23 -07002896 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002897}
2898EXPORT_SYMBOL_GPL(flush_work);
2899
Tejun Heo36e227d2012-08-03 10:30:46 -07002900static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002901{
Tejun Heobbb68df2012-08-03 10:30:46 -07002902 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002903 int ret;
2904
2905 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002906 ret = try_to_grab_pending(work, is_dwork, &flags);
2907 /*
2908 * If someone else is canceling, wait for the same event it
2909 * would be waiting for before retrying.
2910 */
2911 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002912 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002913 } while (unlikely(ret < 0));
2914
Tejun Heobbb68df2012-08-03 10:30:46 -07002915 /* tell other tasks trying to grab @work to back off */
2916 mark_work_canceling(work);
2917 local_irq_restore(flags);
2918
Tejun Heo606a5022012-08-20 14:51:23 -07002919 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002920 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002921 return ret;
2922}
2923
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002924/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002925 * cancel_work_sync - cancel a work and wait for it to finish
2926 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002927 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002928 * Cancel @work and wait for its execution to finish. This function
2929 * can be used even if the work re-queues itself or migrates to
2930 * another workqueue. On return from this function, @work is
2931 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002932 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002933 * cancel_work_sync(&delayed_work->work) must not be used for
2934 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002935 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002936 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002937 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002938 *
2939 * RETURNS:
2940 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002941 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002942bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002943{
Tejun Heo36e227d2012-08-03 10:30:46 -07002944 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002945}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002946EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002947
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002948/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002949 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2950 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002951 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002952 * Delayed timer is cancelled and the pending work is queued for
2953 * immediate execution. Like flush_work(), this function only
2954 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002955 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002956 * RETURNS:
2957 * %true if flush_work() waited for the work to finish execution,
2958 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002959 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002960bool flush_delayed_work(struct delayed_work *dwork)
2961{
Tejun Heo8930cab2012-08-03 10:30:45 -07002962 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002963 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07002964 __queue_work(dwork->cpu,
Tejun Heo401a8d02010-09-16 10:36:00 +02002965 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002966 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002967 return flush_work(&dwork->work);
2968}
2969EXPORT_SYMBOL(flush_delayed_work);
2970
2971/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002972 * cancel_delayed_work - cancel a delayed work
2973 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002974 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002975 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2976 * and canceled; %false if wasn't pending. Note that the work callback
2977 * function may still be running on return, unless it returns %true and the
2978 * work doesn't re-arm itself. Explicitly flush or use
2979 * cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002980 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002981 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002982 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002983bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002984{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002985 unsigned long flags;
2986 int ret;
2987
2988 do {
2989 ret = try_to_grab_pending(&dwork->work, true, &flags);
2990 } while (unlikely(ret == -EAGAIN));
2991
2992 if (unlikely(ret < 0))
2993 return false;
2994
2995 set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
2996 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002997 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002998}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002999EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003000
3001/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003002 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3003 * @dwork: the delayed work cancel
3004 *
3005 * This is cancel_work_sync() for delayed works.
3006 *
3007 * RETURNS:
3008 * %true if @dwork was pending, %false otherwise.
3009 */
3010bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003011{
Tejun Heo36e227d2012-08-03 10:30:46 -07003012 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003013}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003014EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003015
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003016/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07003017 * schedule_work_on - put work task on a specific cpu
3018 * @cpu: cpu to put the work task on
3019 * @work: job to be done
3020 *
3021 * This puts a job on a specific cpu
3022 */
Tejun Heod4283e92012-08-03 10:30:44 -07003023bool schedule_work_on(int cpu, struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07003024{
Tejun Heod320c032010-06-29 10:07:14 +02003025 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07003026}
3027EXPORT_SYMBOL(schedule_work_on);
3028
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003029/**
Dave Jonesae90dd52006-06-30 01:40:45 -04003030 * schedule_work - put work task in global workqueue
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031 * @work: job to be done
Linus Torvalds1da177e2005-04-16 15:20:36 -07003032 *
Tejun Heod4283e92012-08-03 10:30:44 -07003033 * Returns %false if @work was already on the kernel-global workqueue and
3034 * %true otherwise.
David Howells52bad642006-11-22 14:54:01 +00003035 *
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003036 * This puts a job in the kernel-global workqueue if it was not already
3037 * queued and leaves it in the same position on the kernel-global
3038 * workqueue otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003039 */
Tejun Heod4283e92012-08-03 10:30:44 -07003040bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003041{
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003042 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003043}
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003044EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003046/**
3047 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3048 * @cpu: cpu to use
3049 * @dwork: job to be done
3050 * @delay: number of jiffies to wait
3051 *
3052 * After waiting for a given time this puts a job in the kernel-global
3053 * workqueue on the specified CPU.
3054 */
Tejun Heod4283e92012-08-03 10:30:44 -07003055bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3056 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003057{
Tejun Heod320c032010-06-29 10:07:14 +02003058 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059}
Dave Jonesae90dd52006-06-30 01:40:45 -04003060EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003061
Andrew Mortonb6136772006-06-25 05:47:49 -07003062/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003063 * schedule_delayed_work - put work task in global workqueue after delay
3064 * @dwork: job to be done
3065 * @delay: number of jiffies to wait or 0 for immediate execution
3066 *
3067 * After waiting for a given time this puts a job in the kernel-global
3068 * workqueue.
3069 */
Tejun Heod4283e92012-08-03 10:30:44 -07003070bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003071{
3072 return queue_delayed_work(system_wq, dwork, delay);
3073}
3074EXPORT_SYMBOL(schedule_delayed_work);
3075
3076/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003077 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003078 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003079 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003080 * schedule_on_each_cpu() executes @func on each online CPU using the
3081 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003082 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003083 *
3084 * RETURNS:
3085 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003086 */
David Howells65f27f32006-11-22 14:55:48 +00003087int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003088{
3089 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003090 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003091
Andrew Mortonb6136772006-06-25 05:47:49 -07003092 works = alloc_percpu(struct work_struct);
3093 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003094 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003095
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003096 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003097
Christoph Lameter15316ba2006-01-08 01:00:43 -08003098 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003099 struct work_struct *work = per_cpu_ptr(works, cpu);
3100
3101 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003102 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003103 }
Tejun Heo93981802009-11-17 14:06:20 -08003104
3105 for_each_online_cpu(cpu)
3106 flush_work(per_cpu_ptr(works, cpu));
3107
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003108 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003109 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003110 return 0;
3111}
3112
Alan Sterneef6a7d2010-02-12 17:39:21 +09003113/**
3114 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3115 *
3116 * Forces execution of the kernel-global workqueue and blocks until its
3117 * completion.
3118 *
3119 * Think twice before calling this function! It's very easy to get into
3120 * trouble if you don't take great care. Either of the following situations
3121 * will lead to deadlock:
3122 *
3123 * One of the work items currently on the workqueue needs to acquire
3124 * a lock held by your code or its caller.
3125 *
3126 * Your code is running in the context of a work routine.
3127 *
3128 * They will be detected by lockdep when they occur, but the first might not
3129 * occur very often. It depends on what work items are on the workqueue and
3130 * what locks they need, which you have no control over.
3131 *
3132 * In most situations flushing the entire workqueue is overkill; you merely
3133 * need to know that a particular work item isn't queued and isn't running.
3134 * In such cases you should use cancel_delayed_work_sync() or
3135 * cancel_work_sync() instead.
3136 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003137void flush_scheduled_work(void)
3138{
Tejun Heod320c032010-06-29 10:07:14 +02003139 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003140}
Dave Jonesae90dd52006-06-30 01:40:45 -04003141EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003142
3143/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003144 * execute_in_process_context - reliably execute the routine with user context
3145 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003146 * @ew: guaranteed storage for the execute work structure (must
3147 * be available when the work executes)
3148 *
3149 * Executes the function immediately if process context is available,
3150 * otherwise schedules the function for delayed execution.
3151 *
3152 * Returns: 0 - function was executed
3153 * 1 - function was scheduled for execution
3154 */
David Howells65f27f32006-11-22 14:55:48 +00003155int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003156{
3157 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003158 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003159 return 0;
3160 }
3161
David Howells65f27f32006-11-22 14:55:48 +00003162 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003163 schedule_work(&ew->work);
3164
3165 return 1;
3166}
3167EXPORT_SYMBOL_GPL(execute_in_process_context);
3168
Linus Torvalds1da177e2005-04-16 15:20:36 -07003169int keventd_up(void)
3170{
Tejun Heod320c032010-06-29 10:07:14 +02003171 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003172}
3173
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003174static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003175{
Oleg Nesterov3af244332007-05-09 02:34:09 -07003176 /*
Tejun Heo0f900042010-06-29 10:07:11 +02003177 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3178 * Make sure that the alignment isn't lower than that of
3179 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07003180 */
Tejun Heo0f900042010-06-29 10:07:11 +02003181 const size_t size = sizeof(struct cpu_workqueue_struct);
3182 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3183 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07003184
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003185 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003186 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02003187 else {
Tejun Heof3421792010-07-02 10:03:51 +02003188 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003189
Tejun Heof3421792010-07-02 10:03:51 +02003190 /*
3191 * Allocate enough room to align cwq and put an extra
3192 * pointer at the end pointing back to the originally
3193 * allocated pointer which will be used for free.
3194 */
3195 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3196 if (ptr) {
3197 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3198 *(void **)(wq->cpu_wq.single + 1) = ptr;
3199 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003200 }
Tejun Heof3421792010-07-02 10:03:51 +02003201
Tejun Heo0415b00d12011-03-24 18:50:09 +01003202 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003203 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3204 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003205}
3206
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003207static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003208{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003209 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003210 free_percpu(wq->cpu_wq.pcpu);
3211 else if (wq->cpu_wq.single) {
3212 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003213 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003214 }
3215}
3216
Tejun Heof3421792010-07-02 10:03:51 +02003217static int wq_clamp_max_active(int max_active, unsigned int flags,
3218 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003219{
Tejun Heof3421792010-07-02 10:03:51 +02003220 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3221
3222 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003223 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3224 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003225
Tejun Heof3421792010-07-02 10:03:51 +02003226 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003227}
3228
Tejun Heob196be82012-01-10 15:11:35 -08003229struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003230 unsigned int flags,
3231 int max_active,
3232 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003233 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003234{
Tejun Heob196be82012-01-10 15:11:35 -08003235 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003236 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003237 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08003238 size_t namelen;
3239
3240 /* determine namelen, allocate wq and format name */
3241 va_start(args, lock_name);
3242 va_copy(args1, args);
3243 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3244
3245 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3246 if (!wq)
3247 goto err;
3248
3249 vsnprintf(wq->name, namelen, fmt, args1);
3250 va_end(args);
3251 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003252
Tejun Heof3421792010-07-02 10:03:51 +02003253 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003254 * Workqueues which may be used during memory reclaim should
3255 * have a rescuer to guarantee forward progress.
3256 */
3257 if (flags & WQ_MEM_RECLAIM)
3258 flags |= WQ_RESCUER;
3259
Tejun Heod320c032010-06-29 10:07:14 +02003260 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003261 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003262
Tejun Heob196be82012-01-10 15:11:35 -08003263 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003264 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003265 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003266 mutex_init(&wq->flush_mutex);
3267 atomic_set(&wq->nr_cwqs_to_flush, 0);
3268 INIT_LIST_HEAD(&wq->flusher_queue);
3269 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003270
Johannes Bergeb13ba82008-01-16 09:51:58 +01003271 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003272 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003273
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003274 if (alloc_cwqs(wq) < 0)
3275 goto err;
3276
Tejun Heof3421792010-07-02 10:03:51 +02003277 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003278 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003279 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo32704762012-07-13 22:16:45 -07003280 int pool_idx = (bool)(flags & WQ_HIGHPRI);
Tejun Heo15376632010-06-29 10:07:11 +02003281
Tejun Heo0f900042010-06-29 10:07:11 +02003282 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo32704762012-07-13 22:16:45 -07003283 cwq->pool = &gcwq->pools[pool_idx];
Tejun Heoc34056a2010-06-29 10:07:11 +02003284 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003285 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003286 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003287 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003288 }
3289
Tejun Heoe22bee72010-06-29 10:07:14 +02003290 if (flags & WQ_RESCUER) {
3291 struct worker *rescuer;
3292
Tejun Heof2e005a2010-07-20 15:59:09 +02003293 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003294 goto err;
3295
3296 wq->rescuer = rescuer = alloc_worker();
3297 if (!rescuer)
3298 goto err;
3299
Tejun Heob196be82012-01-10 15:11:35 -08003300 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3301 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003302 if (IS_ERR(rescuer->task))
3303 goto err;
3304
Tejun Heoe22bee72010-06-29 10:07:14 +02003305 rescuer->task->flags |= PF_THREAD_BOUND;
3306 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003307 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003308
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003309 /*
3310 * workqueue_lock protects global freeze state and workqueues
3311 * list. Grab it, set max_active accordingly and add the new
3312 * workqueue to workqueues list.
3313 */
Tejun Heo15376632010-06-29 10:07:11 +02003314 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003315
Tejun Heo58a69cb2011-02-16 09:25:31 +01003316 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003317 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003318 get_cwq(cpu, wq)->max_active = 0;
3319
Tejun Heo15376632010-06-29 10:07:11 +02003320 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003321
Tejun Heo15376632010-06-29 10:07:11 +02003322 spin_unlock(&workqueue_lock);
3323
Oleg Nesterov3af244332007-05-09 02:34:09 -07003324 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003325err:
3326 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003327 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003328 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003329 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003330 kfree(wq);
3331 }
3332 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003333}
Tejun Heod320c032010-06-29 10:07:14 +02003334EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003335
3336/**
3337 * destroy_workqueue - safely terminate a workqueue
3338 * @wq: target workqueue
3339 *
3340 * Safely destroy a workqueue. All work currently pending will be done first.
3341 */
3342void destroy_workqueue(struct workqueue_struct *wq)
3343{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003344 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003345
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003346 /* drain it before proceeding with destruction */
3347 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003348
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003349 /*
3350 * wq list is used to freeze wq, remove from list after
3351 * flushing is complete in case freeze races us.
3352 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003353 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07003354 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003355 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003356
Tejun Heoe22bee72010-06-29 10:07:14 +02003357 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003358 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003359 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3360 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003361
Tejun Heo73f53c42010-06-29 10:07:11 +02003362 for (i = 0; i < WORK_NR_COLORS; i++)
3363 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003364 BUG_ON(cwq->nr_active);
3365 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003366 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003367
Tejun Heoe22bee72010-06-29 10:07:14 +02003368 if (wq->flags & WQ_RESCUER) {
3369 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003370 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003371 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003372 }
3373
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003374 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003375 kfree(wq);
3376}
3377EXPORT_SYMBOL_GPL(destroy_workqueue);
3378
Tejun Heodcd989c2010-06-29 10:07:14 +02003379/**
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003380 * cwq_set_max_active - adjust max_active of a cwq
3381 * @cwq: target cpu_workqueue_struct
3382 * @max_active: new max_active value.
3383 *
3384 * Set @cwq->max_active to @max_active and activate delayed works if
3385 * increased.
3386 *
3387 * CONTEXT:
3388 * spin_lock_irq(gcwq->lock).
3389 */
3390static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
3391{
3392 cwq->max_active = max_active;
3393
3394 while (!list_empty(&cwq->delayed_works) &&
3395 cwq->nr_active < cwq->max_active)
3396 cwq_activate_first_delayed(cwq);
3397}
3398
3399/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003400 * workqueue_set_max_active - adjust max_active of a workqueue
3401 * @wq: target workqueue
3402 * @max_active: new max_active value.
3403 *
3404 * Set max_active of @wq to @max_active.
3405 *
3406 * CONTEXT:
3407 * Don't call from IRQ context.
3408 */
3409void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3410{
3411 unsigned int cpu;
3412
Tejun Heof3421792010-07-02 10:03:51 +02003413 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003414
3415 spin_lock(&workqueue_lock);
3416
3417 wq->saved_max_active = max_active;
3418
Tejun Heof3421792010-07-02 10:03:51 +02003419 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003420 struct global_cwq *gcwq = get_gcwq(cpu);
3421
3422 spin_lock_irq(&gcwq->lock);
3423
Tejun Heo58a69cb2011-02-16 09:25:31 +01003424 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003425 !(gcwq->flags & GCWQ_FREEZING))
Lai Jiangshan70369b12012-09-19 10:40:48 -07003426 cwq_set_max_active(get_cwq(gcwq->cpu, wq), max_active);
Tejun Heodcd989c2010-06-29 10:07:14 +02003427
3428 spin_unlock_irq(&gcwq->lock);
3429 }
3430
3431 spin_unlock(&workqueue_lock);
3432}
3433EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3434
3435/**
3436 * workqueue_congested - test whether a workqueue is congested
3437 * @cpu: CPU in question
3438 * @wq: target workqueue
3439 *
3440 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3441 * no synchronization around this function and the test result is
3442 * unreliable and only useful as advisory hints or for debugging.
3443 *
3444 * RETURNS:
3445 * %true if congested, %false otherwise.
3446 */
3447bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3448{
3449 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3450
3451 return !list_empty(&cwq->delayed_works);
3452}
3453EXPORT_SYMBOL_GPL(workqueue_congested);
3454
3455/**
3456 * work_cpu - return the last known associated cpu for @work
3457 * @work: the work of interest
3458 *
3459 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003460 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003461 */
3462unsigned int work_cpu(struct work_struct *work)
3463{
3464 struct global_cwq *gcwq = get_work_gcwq(work);
3465
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003466 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003467}
3468EXPORT_SYMBOL_GPL(work_cpu);
3469
3470/**
3471 * work_busy - test whether a work is currently pending or running
3472 * @work: the work to be tested
3473 *
3474 * Test whether @work is currently pending or running. There is no
3475 * synchronization around this function and the test result is
3476 * unreliable and only useful as advisory hints or for debugging.
3477 * Especially for reentrant wqs, the pending state might hide the
3478 * running state.
3479 *
3480 * RETURNS:
3481 * OR'd bitmask of WORK_BUSY_* bits.
3482 */
3483unsigned int work_busy(struct work_struct *work)
3484{
3485 struct global_cwq *gcwq = get_work_gcwq(work);
3486 unsigned long flags;
3487 unsigned int ret = 0;
3488
3489 if (!gcwq)
Joonsoo Kim999767b2012-10-21 01:30:06 +09003490 return 0;
Tejun Heodcd989c2010-06-29 10:07:14 +02003491
3492 spin_lock_irqsave(&gcwq->lock, flags);
3493
3494 if (work_pending(work))
3495 ret |= WORK_BUSY_PENDING;
3496 if (find_worker_executing_work(gcwq, work))
3497 ret |= WORK_BUSY_RUNNING;
3498
3499 spin_unlock_irqrestore(&gcwq->lock, flags);
3500
3501 return ret;
3502}
3503EXPORT_SYMBOL_GPL(work_busy);
3504
Tejun Heodb7bccf2010-06-29 10:07:12 +02003505/*
3506 * CPU hotplug.
3507 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003508 * There are two challenges in supporting CPU hotplug. Firstly, there
3509 * are a lot of assumptions on strong associations among work, cwq and
3510 * gcwq which make migrating pending and scheduled works very
3511 * difficult to implement without impacting hot paths. Secondly,
3512 * gcwqs serve mix of short, long and very long running works making
3513 * blocked draining impractical.
3514 *
Tejun Heo628c78e2012-07-17 12:39:27 -07003515 * This is solved by allowing a gcwq to be disassociated from the CPU
3516 * running as an unbound one and allowing it to be reattached later if the
3517 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003518 */
3519
Tejun Heo60373152012-07-17 12:39:27 -07003520/* claim manager positions of all pools */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003521static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003522{
3523 struct worker_pool *pool;
3524
3525 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003526 mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
Tejun Heo8db25e72012-07-17 12:39:28 -07003527 spin_lock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003528}
3529
3530/* release manager positions */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003531static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003532{
3533 struct worker_pool *pool;
3534
Tejun Heo8db25e72012-07-17 12:39:28 -07003535 spin_unlock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003536 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003537 mutex_unlock(&pool->assoc_mutex);
Tejun Heo60373152012-07-17 12:39:27 -07003538}
3539
Tejun Heo628c78e2012-07-17 12:39:27 -07003540static void gcwq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003541{
Tejun Heo628c78e2012-07-17 12:39:27 -07003542 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
Tejun Heo4ce62e92012-07-13 22:16:44 -07003543 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003544 struct worker *worker;
3545 struct hlist_node *pos;
3546 int i;
3547
3548 BUG_ON(gcwq->cpu != smp_processor_id());
3549
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003550 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003551
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003552 /*
3553 * We've claimed all manager positions. Make all workers unbound
3554 * and set DISASSOCIATED. Before this, all workers except for the
3555 * ones which are still executing works from before the last CPU
3556 * down must be on the cpu. After this, they may become diasporas.
3557 */
Tejun Heo60373152012-07-17 12:39:27 -07003558 for_each_worker_pool(pool, gcwq)
Tejun Heo4ce62e92012-07-13 22:16:44 -07003559 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003560 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003561
3562 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo403c8212012-07-17 12:39:27 -07003563 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003564
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003565 gcwq->flags |= GCWQ_DISASSOCIATED;
3566
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003567 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003568
3569 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003570 * Call schedule() so that we cross rq->lock and thus can guarantee
3571 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3572 * as scheduler callbacks may be invoked from other cpus.
3573 */
3574 schedule();
3575
3576 /*
3577 * Sched callbacks are disabled now. Zap nr_running. After this,
3578 * nr_running stays zero and need_more_worker() and keep_working()
3579 * are always true as long as the worklist is not empty. @gcwq now
3580 * behaves as unbound (in terms of concurrency management) gcwq
3581 * which is served by workers tied to the CPU.
3582 *
3583 * On return from this function, the current worker would trigger
3584 * unbound chain execution of pending work items if other workers
3585 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003586 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003587 for_each_worker_pool(pool, gcwq)
3588 atomic_set(get_pool_nr_running(pool), 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003589}
3590
Tejun Heo8db25e72012-07-17 12:39:28 -07003591/*
3592 * Workqueues should be brought up before normal priority CPU notifiers.
3593 * This will be registered high priority CPU notifier.
3594 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003595static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07003596 unsigned long action,
3597 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003598{
3599 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003600 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003601 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003602
Tejun Heo8db25e72012-07-17 12:39:28 -07003603 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604 case CPU_UP_PREPARE:
Tejun Heo4ce62e92012-07-13 22:16:44 -07003605 for_each_worker_pool(pool, gcwq) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003606 struct worker *worker;
3607
3608 if (pool->nr_workers)
3609 continue;
3610
3611 worker = create_worker(pool);
3612 if (!worker)
3613 return NOTIFY_BAD;
3614
3615 spin_lock_irq(&gcwq->lock);
3616 start_worker(worker);
3617 spin_unlock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003618 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003619 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003620
Tejun Heo65758202012-07-17 12:39:26 -07003621 case CPU_DOWN_FAILED:
3622 case CPU_ONLINE:
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003623 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003624 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3625 rebind_workers(gcwq);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003626 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003627 break;
Tejun Heo65758202012-07-17 12:39:26 -07003628 }
3629 return NOTIFY_OK;
3630}
3631
3632/*
3633 * Workqueues should be brought down after normal priority CPU notifiers.
3634 * This will be registered as low priority CPU notifier.
3635 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003636static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07003637 unsigned long action,
3638 void *hcpu)
3639{
Tejun Heo8db25e72012-07-17 12:39:28 -07003640 unsigned int cpu = (unsigned long)hcpu;
3641 struct work_struct unbind_work;
3642
Tejun Heo65758202012-07-17 12:39:26 -07003643 switch (action & ~CPU_TASKS_FROZEN) {
3644 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003645 /* unbinding should happen on the local CPU */
3646 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09003647 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07003648 flush_work(&unbind_work);
3649 break;
Tejun Heo65758202012-07-17 12:39:26 -07003650 }
3651 return NOTIFY_OK;
3652}
3653
Rusty Russell2d3854a2008-11-05 13:39:10 +11003654#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003655
Rusty Russell2d3854a2008-11-05 13:39:10 +11003656struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07003657 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003658 long (*fn)(void *);
3659 void *arg;
3660 long ret;
3661};
3662
Tejun Heoed48ece2012-09-18 12:48:43 -07003663static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003664{
Tejun Heoed48ece2012-09-18 12:48:43 -07003665 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3666
Rusty Russell2d3854a2008-11-05 13:39:10 +11003667 wfc->ret = wfc->fn(wfc->arg);
3668}
3669
3670/**
3671 * work_on_cpu - run a function in user context on a particular cpu
3672 * @cpu: the cpu to run on
3673 * @fn: the function to run
3674 * @arg: the function arg
3675 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003676 * This will return the value @fn returns.
3677 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06003678 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003679 */
3680long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3681{
Tejun Heoed48ece2012-09-18 12:48:43 -07003682 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003683
Tejun Heoed48ece2012-09-18 12:48:43 -07003684 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3685 schedule_work_on(cpu, &wfc.work);
3686 flush_work(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003687 return wfc.ret;
3688}
3689EXPORT_SYMBOL_GPL(work_on_cpu);
3690#endif /* CONFIG_SMP */
3691
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003692#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303693
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003694/**
3695 * freeze_workqueues_begin - begin freezing workqueues
3696 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003697 * Start freezing workqueues. After this function returns, all freezable
3698 * workqueues will queue new works to their frozen_works list instead of
3699 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003700 *
3701 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003702 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003703 */
3704void freeze_workqueues_begin(void)
3705{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003706 unsigned int cpu;
3707
3708 spin_lock(&workqueue_lock);
3709
3710 BUG_ON(workqueue_freezing);
3711 workqueue_freezing = true;
3712
Tejun Heof3421792010-07-02 10:03:51 +02003713 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003714 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003715 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003716
3717 spin_lock_irq(&gcwq->lock);
3718
Tejun Heodb7bccf2010-06-29 10:07:12 +02003719 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3720 gcwq->flags |= GCWQ_FREEZING;
3721
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003722 list_for_each_entry(wq, &workqueues, list) {
3723 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3724
Tejun Heo58a69cb2011-02-16 09:25:31 +01003725 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003726 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003727 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003728
3729 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003730 }
3731
3732 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003733}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003734
3735/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003736 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003737 *
3738 * Check whether freezing is complete. This function must be called
3739 * between freeze_workqueues_begin() and thaw_workqueues().
3740 *
3741 * CONTEXT:
3742 * Grabs and releases workqueue_lock.
3743 *
3744 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003745 * %true if some freezable workqueues are still busy. %false if freezing
3746 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003747 */
3748bool freeze_workqueues_busy(void)
3749{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003750 unsigned int cpu;
3751 bool busy = false;
3752
3753 spin_lock(&workqueue_lock);
3754
3755 BUG_ON(!workqueue_freezing);
3756
Tejun Heof3421792010-07-02 10:03:51 +02003757 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003758 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003759 /*
3760 * nr_active is monotonically decreasing. It's safe
3761 * to peek without lock.
3762 */
3763 list_for_each_entry(wq, &workqueues, list) {
3764 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3765
Tejun Heo58a69cb2011-02-16 09:25:31 +01003766 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003767 continue;
3768
3769 BUG_ON(cwq->nr_active < 0);
3770 if (cwq->nr_active) {
3771 busy = true;
3772 goto out_unlock;
3773 }
3774 }
3775 }
3776out_unlock:
3777 spin_unlock(&workqueue_lock);
3778 return busy;
3779}
3780
3781/**
3782 * thaw_workqueues - thaw workqueues
3783 *
3784 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003785 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003786 *
3787 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003788 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003789 */
3790void thaw_workqueues(void)
3791{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003792 unsigned int cpu;
3793
3794 spin_lock(&workqueue_lock);
3795
3796 if (!workqueue_freezing)
3797 goto out_unlock;
3798
Tejun Heof3421792010-07-02 10:03:51 +02003799 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003800 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003801 struct worker_pool *pool;
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003802 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003803
3804 spin_lock_irq(&gcwq->lock);
3805
Tejun Heodb7bccf2010-06-29 10:07:12 +02003806 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3807 gcwq->flags &= ~GCWQ_FREEZING;
3808
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003809 list_for_each_entry(wq, &workqueues, list) {
3810 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3811
Tejun Heo58a69cb2011-02-16 09:25:31 +01003812 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003813 continue;
3814
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003815 /* restore max_active and repopulate worklist */
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003816 cwq_set_max_active(cwq, wq->saved_max_active);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003817 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003818
Tejun Heo4ce62e92012-07-13 22:16:44 -07003819 for_each_worker_pool(pool, gcwq)
3820 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02003821
Tejun Heo8b03ae32010-06-29 10:07:12 +02003822 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003823 }
3824
3825 workqueue_freezing = false;
3826out_unlock:
3827 spin_unlock(&workqueue_lock);
3828}
3829#endif /* CONFIG_FREEZER */
3830
Suresh Siddha6ee05782010-07-30 14:57:37 -07003831static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003832{
Tejun Heoc34056a2010-06-29 10:07:11 +02003833 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003834 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003835
Tejun Heob5490072012-08-03 10:30:46 -07003836 /* make sure we have enough bits for OFFQ CPU number */
3837 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3838 WORK_CPU_LAST);
3839
Tejun Heo65758202012-07-17 12:39:26 -07003840 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07003841 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003842
3843 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003844 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003845 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003846 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003847
3848 spin_lock_init(&gcwq->lock);
3849 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003850 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003851
Tejun Heoc8e55f32010-06-29 10:07:12 +02003852 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3853 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3854
Tejun Heo4ce62e92012-07-13 22:16:44 -07003855 for_each_worker_pool(pool, gcwq) {
3856 pool->gcwq = gcwq;
3857 INIT_LIST_HEAD(&pool->worklist);
3858 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoe22bee72010-06-29 10:07:14 +02003859
Tejun Heo4ce62e92012-07-13 22:16:44 -07003860 init_timer_deferrable(&pool->idle_timer);
3861 pool->idle_timer.function = idle_worker_timeout;
3862 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003863
Tejun Heo4ce62e92012-07-13 22:16:44 -07003864 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3865 (unsigned long)pool);
3866
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003867 mutex_init(&pool->assoc_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003868 ida_init(&pool->worker_ida);
3869 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003870 }
3871
Tejun Heoe22bee72010-06-29 10:07:14 +02003872 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003873 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003874 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003875 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003876
Tejun Heo477a3c32010-08-31 10:54:35 +02003877 if (cpu != WORK_CPU_UNBOUND)
3878 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003879
3880 for_each_worker_pool(pool, gcwq) {
3881 struct worker *worker;
3882
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003883 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003884 BUG_ON(!worker);
3885 spin_lock_irq(&gcwq->lock);
3886 start_worker(worker);
3887 spin_unlock_irq(&gcwq->lock);
3888 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003889 }
3890
Tejun Heod320c032010-06-29 10:07:14 +02003891 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003892 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02003893 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003894 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3895 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003896 system_freezable_wq = alloc_workqueue("events_freezable",
3897 WQ_FREEZABLE, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003898 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Tejun Heoae930e02012-08-20 14:51:23 -07003899 !system_unbound_wq || !system_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003900 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003901}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003902early_initcall(init_workqueues);