blob: 1dae900df798d1c4e1be722567fd2906041f08f5 [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
Steven Rostedt2d646722010-12-03 23:12:33 -0500742 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700743 atomic_inc(get_pool_nr_running(worker->pool));
Tejun Heoe22bee72010-06-29 10:07:14 +0200744}
745
746/**
747 * wq_worker_sleeping - a worker is going to sleep
748 * @task: task going to sleep
749 * @cpu: CPU in question, must be the current CPU number
750 *
751 * This function is called during schedule() when a busy worker is
752 * going to sleep. Worker on the same cpu can be woken up by
753 * returning pointer to its task.
754 *
755 * CONTEXT:
756 * spin_lock_irq(rq->lock)
757 *
758 * RETURNS:
759 * Worker task on @cpu to wake up, %NULL if none.
760 */
761struct task_struct *wq_worker_sleeping(struct task_struct *task,
762 unsigned int cpu)
763{
764 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700765 struct worker_pool *pool = worker->pool;
Tejun Heo63d95a92012-07-12 14:46:37 -0700766 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200767
Steven Rostedt2d646722010-12-03 23:12:33 -0500768 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200769 return NULL;
770
771 /* this can only happen on the local cpu */
772 BUG_ON(cpu != raw_smp_processor_id());
773
774 /*
775 * The counterpart of the following dec_and_test, implied mb,
776 * worklist not empty test sequence is in insert_work().
777 * Please read comment there.
778 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700779 * NOT_RUNNING is clear. This means that we're bound to and
780 * running on the local cpu w/ rq lock held and preemption
781 * disabled, which in turn means that none else could be
782 * manipulating idle_list, so dereferencing idle_list without gcwq
783 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200784 */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700785 if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700786 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200787 return to_wakeup ? to_wakeup->task : NULL;
788}
789
790/**
791 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200792 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200793 * @flags: flags to set
794 * @wakeup: wakeup an idle worker if necessary
795 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200796 * Set @flags in @worker->flags and adjust nr_running accordingly. If
797 * nr_running becomes zero and @wakeup is %true, an idle worker is
798 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200799 *
Tejun Heocb444762010-07-02 10:03:50 +0200800 * CONTEXT:
801 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200802 */
803static inline void worker_set_flags(struct worker *worker, unsigned int flags,
804 bool wakeup)
805{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700806 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200807
Tejun Heocb444762010-07-02 10:03:50 +0200808 WARN_ON_ONCE(worker->task != current);
809
Tejun Heoe22bee72010-06-29 10:07:14 +0200810 /*
811 * If transitioning into NOT_RUNNING, adjust nr_running and
812 * wake up an idle worker as necessary if requested by
813 * @wakeup.
814 */
815 if ((flags & WORKER_NOT_RUNNING) &&
816 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heo63d95a92012-07-12 14:46:37 -0700817 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200818
819 if (wakeup) {
820 if (atomic_dec_and_test(nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700821 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700822 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200823 } else
824 atomic_dec(nr_running);
825 }
826
Tejun Heod302f012010-06-29 10:07:13 +0200827 worker->flags |= flags;
828}
829
830/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200831 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200832 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200833 * @flags: flags to clear
834 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200835 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200836 *
Tejun Heocb444762010-07-02 10:03:50 +0200837 * CONTEXT:
838 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200839 */
840static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
841{
Tejun Heo63d95a92012-07-12 14:46:37 -0700842 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200843 unsigned int oflags = worker->flags;
844
Tejun Heocb444762010-07-02 10:03:50 +0200845 WARN_ON_ONCE(worker->task != current);
846
Tejun Heod302f012010-06-29 10:07:13 +0200847 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200848
Tejun Heo42c025f2011-01-11 15:58:49 +0100849 /*
850 * If transitioning out of NOT_RUNNING, increment nr_running. Note
851 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
852 * of multiple flags, not a single flag.
853 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200854 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
855 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700856 atomic_inc(get_pool_nr_running(pool));
Tejun Heod302f012010-06-29 10:07:13 +0200857}
858
859/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200860 * busy_worker_head - return the busy hash head for a work
861 * @gcwq: gcwq of interest
862 * @work: work to be hashed
863 *
864 * Return hash head of @gcwq for @work.
865 *
866 * CONTEXT:
867 * spin_lock_irq(gcwq->lock).
868 *
869 * RETURNS:
870 * Pointer to the hash head.
871 */
872static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
873 struct work_struct *work)
874{
875 const int base_shift = ilog2(sizeof(struct work_struct));
876 unsigned long v = (unsigned long)work;
877
878 /* simple shift and fold hash, do we need something better? */
879 v >>= base_shift;
880 v += v >> BUSY_WORKER_HASH_ORDER;
881 v &= BUSY_WORKER_HASH_MASK;
882
883 return &gcwq->busy_hash[v];
884}
885
886/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200887 * __find_worker_executing_work - find worker which is executing a work
888 * @gcwq: gcwq of interest
889 * @bwh: hash head as returned by busy_worker_head()
890 * @work: work to find worker for
891 *
892 * Find a worker which is executing @work on @gcwq. @bwh should be
893 * the hash head obtained by calling busy_worker_head() with the same
894 * work.
895 *
896 * CONTEXT:
897 * spin_lock_irq(gcwq->lock).
898 *
899 * RETURNS:
900 * Pointer to worker which is executing @work if found, NULL
901 * otherwise.
902 */
903static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
904 struct hlist_head *bwh,
905 struct work_struct *work)
906{
907 struct worker *worker;
908 struct hlist_node *tmp;
909
910 hlist_for_each_entry(worker, tmp, bwh, hentry)
911 if (worker->current_work == work)
912 return worker;
913 return NULL;
914}
915
916/**
917 * find_worker_executing_work - find worker which is executing a work
918 * @gcwq: gcwq of interest
919 * @work: work to find worker for
920 *
921 * Find a worker which is executing @work on @gcwq. This function is
922 * identical to __find_worker_executing_work() except that this
923 * function calculates @bwh itself.
924 *
925 * CONTEXT:
926 * spin_lock_irq(gcwq->lock).
927 *
928 * RETURNS:
929 * Pointer to worker which is executing @work if found, NULL
930 * otherwise.
931 */
932static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
933 struct work_struct *work)
934{
935 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
936 work);
937}
938
939/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700940 * move_linked_works - move linked works to a list
941 * @work: start of series of works to be scheduled
942 * @head: target list to append @work to
943 * @nextp: out paramter for nested worklist walking
944 *
945 * Schedule linked works starting from @work to @head. Work series to
946 * be scheduled starts at @work and includes any consecutive work with
947 * WORK_STRUCT_LINKED set in its predecessor.
948 *
949 * If @nextp is not NULL, it's updated to point to the next work of
950 * the last scheduled work. This allows move_linked_works() to be
951 * nested inside outer list_for_each_entry_safe().
952 *
953 * CONTEXT:
954 * spin_lock_irq(gcwq->lock).
955 */
956static void move_linked_works(struct work_struct *work, struct list_head *head,
957 struct work_struct **nextp)
958{
959 struct work_struct *n;
960
961 /*
962 * Linked worklist will always end before the end of the list,
963 * use NULL for list head.
964 */
965 list_for_each_entry_safe_from(work, n, NULL, entry) {
966 list_move_tail(&work->entry, head);
967 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
968 break;
969 }
970
971 /*
972 * If we're already inside safe list traversal and have moved
973 * multiple works to the scheduled queue, the next position
974 * needs to be updated.
975 */
976 if (nextp)
977 *nextp = n;
978}
979
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700980static void cwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -0700981{
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700982 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -0700983
984 trace_workqueue_activate_work(work);
985 move_linked_works(work, &cwq->pool->worklist, NULL);
986 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
987 cwq->nr_active++;
988}
989
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700990static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
991{
992 struct work_struct *work = list_first_entry(&cwq->delayed_works,
993 struct work_struct, entry);
994
995 cwq_activate_delayed_work(work);
996}
997
Tejun Heobf4ede02012-08-03 10:30:46 -0700998/**
999 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1000 * @cwq: cwq of interest
1001 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001002 *
1003 * A work either has completed or is removed from pending queue,
1004 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1005 *
1006 * CONTEXT:
1007 * spin_lock_irq(gcwq->lock).
1008 */
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001009static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001010{
1011 /* ignore uncolored works */
1012 if (color == WORK_NO_COLOR)
1013 return;
1014
1015 cwq->nr_in_flight[color]--;
1016
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001017 cwq->nr_active--;
1018 if (!list_empty(&cwq->delayed_works)) {
1019 /* one down, submit a delayed one */
1020 if (cwq->nr_active < cwq->max_active)
1021 cwq_activate_first_delayed(cwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001022 }
1023
1024 /* is flush in progress and are we at the flushing tip? */
1025 if (likely(cwq->flush_color != color))
1026 return;
1027
1028 /* are there still in-flight works? */
1029 if (cwq->nr_in_flight[color])
1030 return;
1031
1032 /* this cwq is done, clear flush_color */
1033 cwq->flush_color = -1;
1034
1035 /*
1036 * If this was the last cwq, wake up the first flusher. It
1037 * will handle the rest.
1038 */
1039 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1040 complete(&cwq->wq->first_flusher->done);
1041}
1042
Tejun Heo36e227d2012-08-03 10:30:46 -07001043/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001044 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001045 * @work: work item to steal
1046 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001047 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001048 *
1049 * Try to grab PENDING bit of @work. This function can handle @work in any
1050 * stable state - idle, on timer or on worklist. Return values are
1051 *
1052 * 1 if @work was pending and we successfully stole PENDING
1053 * 0 if @work was idle and we claimed PENDING
1054 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001055 * -ENOENT if someone else is canceling @work, this state may persist
1056 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001057 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001058 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001059 * interrupted while holding PENDING and @work off queue, irq must be
1060 * disabled on entry. This, combined with delayed_work->timer being
1061 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001062 *
1063 * On successful return, >= 0, irq is disabled and the caller is
1064 * responsible for releasing it using local_irq_restore(*@flags).
1065 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001066 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001067 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001068static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1069 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001070{
1071 struct global_cwq *gcwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001072
Tejun Heobbb68df2012-08-03 10:30:46 -07001073 local_irq_save(*flags);
1074
Tejun Heo36e227d2012-08-03 10:30:46 -07001075 /* try to steal the timer if it exists */
1076 if (is_dwork) {
1077 struct delayed_work *dwork = to_delayed_work(work);
1078
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001079 /*
1080 * dwork->timer is irqsafe. If del_timer() fails, it's
1081 * guaranteed that the timer is not queued anywhere and not
1082 * running on the local CPU.
1083 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001084 if (likely(del_timer(&dwork->timer)))
1085 return 1;
1086 }
1087
1088 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001089 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1090 return 0;
1091
1092 /*
1093 * The queueing is in progress, or it is already queued. Try to
1094 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1095 */
1096 gcwq = get_work_gcwq(work);
1097 if (!gcwq)
Tejun Heobbb68df2012-08-03 10:30:46 -07001098 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001099
Tejun Heobbb68df2012-08-03 10:30:46 -07001100 spin_lock(&gcwq->lock);
Tejun Heobf4ede02012-08-03 10:30:46 -07001101 if (!list_empty(&work->entry)) {
1102 /*
1103 * This work is queued, but perhaps we locked the wrong gcwq.
1104 * In that case we must see the new value after rmb(), see
1105 * insert_work()->wmb().
1106 */
1107 smp_rmb();
1108 if (gcwq == get_work_gcwq(work)) {
1109 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001110
1111 /*
1112 * A delayed work item cannot be grabbed directly
1113 * because it might have linked NO_COLOR work items
1114 * which, if left on the delayed_list, will confuse
1115 * cwq->nr_active management later on and cause
1116 * stall. Make sure the work item is activated
1117 * before grabbing.
1118 */
1119 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1120 cwq_activate_delayed_work(work);
1121
Tejun Heobf4ede02012-08-03 10:30:46 -07001122 list_del_init(&work->entry);
1123 cwq_dec_nr_in_flight(get_work_cwq(work),
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001124 get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001125
Tejun Heobbb68df2012-08-03 10:30:46 -07001126 spin_unlock(&gcwq->lock);
Tejun Heo36e227d2012-08-03 10:30:46 -07001127 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001128 }
1129 }
Tejun Heobbb68df2012-08-03 10:30:46 -07001130 spin_unlock(&gcwq->lock);
1131fail:
1132 local_irq_restore(*flags);
1133 if (work_is_canceling(work))
1134 return -ENOENT;
1135 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001136 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001137}
1138
1139/**
Tejun Heo7e116292010-06-29 10:07:13 +02001140 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +02001141 * @cwq: cwq @work belongs to
1142 * @work: work to insert
1143 * @head: insertion point
1144 * @extra_flags: extra WORK_STRUCT_* flags to set
1145 *
Tejun Heo7e116292010-06-29 10:07:13 +02001146 * Insert @work which belongs to @cwq into @gcwq after @head.
1147 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001148 *
1149 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001150 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001151 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001152static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001153 struct work_struct *work, struct list_head *head,
1154 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001155{
Tejun Heo63d95a92012-07-12 14:46:37 -07001156 struct worker_pool *pool = cwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001157
Tejun Heo4690c4a2010-06-29 10:07:10 +02001158 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001159 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001160
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001161 /*
1162 * Ensure that we get the right work->data if we see the
1163 * result of list_add() below, see try_to_grab_pending().
1164 */
1165 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001166
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001167 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001168
1169 /*
1170 * Ensure either worker_sched_deactivated() sees the above
1171 * list_add_tail() or we see zero nr_running to avoid workers
1172 * lying around lazily while there are works to be processed.
1173 */
1174 smp_mb();
1175
Tejun Heo63d95a92012-07-12 14:46:37 -07001176 if (__need_more_worker(pool))
1177 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001178}
1179
Tejun Heoc8efcc22010-12-20 19:32:04 +01001180/*
1181 * Test whether @work is being queued from another work executing on the
1182 * same workqueue. This is rather expensive and should only be used from
1183 * cold paths.
1184 */
1185static bool is_chained_work(struct workqueue_struct *wq)
1186{
1187 unsigned long flags;
1188 unsigned int cpu;
1189
1190 for_each_gcwq_cpu(cpu) {
1191 struct global_cwq *gcwq = get_gcwq(cpu);
1192 struct worker *worker;
1193 struct hlist_node *pos;
1194 int i;
1195
1196 spin_lock_irqsave(&gcwq->lock, flags);
1197 for_each_busy_worker(worker, i, pos, gcwq) {
1198 if (worker->task != current)
1199 continue;
1200 spin_unlock_irqrestore(&gcwq->lock, flags);
1201 /*
1202 * I'm @worker, no locking necessary. See if @work
1203 * is headed to the same workqueue.
1204 */
1205 return worker->current_cwq->wq == wq;
1206 }
1207 spin_unlock_irqrestore(&gcwq->lock, flags);
1208 }
1209 return false;
1210}
1211
Tejun Heo4690c4a2010-06-29 10:07:10 +02001212static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 struct work_struct *work)
1214{
Tejun Heo502ca9d2010-06-29 10:07:13 +02001215 struct global_cwq *gcwq;
1216 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001217 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001218 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001219 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001220
1221 /*
1222 * While a work item is PENDING && off queue, a task trying to
1223 * steal the PENDING will busy-loop waiting for it to either get
1224 * queued or lose PENDING. Grabbing PENDING and queueing should
1225 * happen with IRQ disabled.
1226 */
1227 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001229 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001230
Tejun Heoc8efcc22010-12-20 19:32:04 +01001231 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001232 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001233 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001234 return;
1235
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001236 /* determine gcwq to use */
1237 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001238 struct global_cwq *last_gcwq;
1239
Tejun Heo57469822012-08-03 10:30:45 -07001240 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001241 cpu = raw_smp_processor_id();
1242
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001243 /*
Tejun Heodbf25762012-08-20 14:51:23 -07001244 * It's multi cpu. If @work was previously on a different
1245 * cpu, it might still be running there, in which case the
1246 * work needs to be queued on that cpu to guarantee
1247 * non-reentrancy.
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001248 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001249 gcwq = get_gcwq(cpu);
Tejun Heodbf25762012-08-20 14:51:23 -07001250 last_gcwq = get_work_gcwq(work);
1251
1252 if (last_gcwq && last_gcwq != gcwq) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001253 struct worker *worker;
1254
Tejun Heo8930cab2012-08-03 10:30:45 -07001255 spin_lock(&last_gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001256
1257 worker = find_worker_executing_work(last_gcwq, work);
1258
1259 if (worker && worker->current_cwq->wq == wq)
1260 gcwq = last_gcwq;
1261 else {
1262 /* meh... not running there, queue here */
Tejun Heo8930cab2012-08-03 10:30:45 -07001263 spin_unlock(&last_gcwq->lock);
1264 spin_lock(&gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001265 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001266 } else {
1267 spin_lock(&gcwq->lock);
1268 }
Tejun Heof3421792010-07-02 10:03:51 +02001269 } else {
1270 gcwq = get_gcwq(WORK_CPU_UNBOUND);
Tejun Heo8930cab2012-08-03 10:30:45 -07001271 spin_lock(&gcwq->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001272 }
1273
1274 /* gcwq determined, get cwq and queue */
1275 cwq = get_cwq(gcwq->cpu, wq);
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001276 trace_workqueue_queue_work(req_cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001277
Dan Carpenterf5b25522012-04-13 22:06:58 +03001278 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo8930cab2012-08-03 10:30:45 -07001279 spin_unlock(&gcwq->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001280 return;
1281 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001282
Tejun Heo73f53c42010-06-29 10:07:11 +02001283 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001284 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001285
1286 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001287 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001288 cwq->nr_active++;
Tejun Heo32704762012-07-13 22:16:45 -07001289 worklist = &cwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001290 } else {
1291 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001292 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001293 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001294
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001295 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001296
Tejun Heo8930cab2012-08-03 10:30:45 -07001297 spin_unlock(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298}
1299
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001300/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001301 * queue_work_on - queue work on specific cpu
1302 * @cpu: CPU number to execute work on
1303 * @wq: workqueue to use
1304 * @work: work to queue
1305 *
Tejun Heod4283e92012-08-03 10:30:44 -07001306 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001307 *
1308 * We queue the work to a specific CPU, the caller must ensure it
1309 * can't go away.
1310 */
Tejun Heod4283e92012-08-03 10:30:44 -07001311bool queue_work_on(int cpu, struct workqueue_struct *wq,
1312 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001313{
Tejun Heod4283e92012-08-03 10:30:44 -07001314 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001315 unsigned long flags;
1316
1317 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001318
Tejun Heo22df02b2010-06-29 10:07:10 +02001319 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001320 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001321 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001322 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001323
1324 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001325 return ret;
1326}
1327EXPORT_SYMBOL_GPL(queue_work_on);
1328
Tejun Heo0a13c002012-08-03 10:30:44 -07001329/**
1330 * queue_work - queue work on a workqueue
1331 * @wq: workqueue to use
1332 * @work: work to queue
1333 *
Tejun Heod4283e92012-08-03 10:30:44 -07001334 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001335 *
1336 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1337 * it can be processed by another CPU.
1338 */
Tejun Heod4283e92012-08-03 10:30:44 -07001339bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001340{
Tejun Heo57469822012-08-03 10:30:45 -07001341 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001342}
1343EXPORT_SYMBOL_GPL(queue_work);
1344
Tejun Heod8e794d2012-08-03 10:30:45 -07001345void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346{
David Howells52bad642006-11-22 14:54:01 +00001347 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001348 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001350 /* should have been called from irqsafe timer with irq already off */
Tejun Heo12650572012-08-08 09:38:42 -07001351 __queue_work(dwork->cpu, cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352}
Tejun Heod8e794d2012-08-03 10:30:45 -07001353EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001355static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1356 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001358 struct timer_list *timer = &dwork->timer;
1359 struct work_struct *work = &dwork->work;
1360 unsigned int lcpu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001362 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1363 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001364 WARN_ON_ONCE(timer_pending(timer));
1365 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001366
Tejun Heo8852aac2012-12-01 16:23:42 -08001367 /*
1368 * If @delay is 0, queue @dwork->work immediately. This is for
1369 * both optimization and correctness. The earliest @timer can
1370 * expire is on the closest next tick and delayed_work users depend
1371 * on that there's no such delay when @delay is 0.
1372 */
1373 if (!delay) {
1374 __queue_work(cpu, wq, &dwork->work);
1375 return;
1376 }
1377
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001378 timer_stats_timer_set_start_info(&dwork->timer);
1379
1380 /*
1381 * This stores cwq for the moment, for the timer_fn. Note that the
1382 * work's gcwq is preserved to allow reentrance detection for
1383 * delayed works.
1384 */
1385 if (!(wq->flags & WQ_UNBOUND)) {
1386 struct global_cwq *gcwq = get_work_gcwq(work);
1387
Joonsoo Kime42986d2012-08-15 23:25:38 +09001388 /*
1389 * If we cannot get the last gcwq from @work directly,
1390 * select the last CPU such that it avoids unnecessarily
1391 * triggering non-reentrancy check in __queue_work().
1392 */
1393 lcpu = cpu;
1394 if (gcwq)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001395 lcpu = gcwq->cpu;
Joonsoo Kime42986d2012-08-15 23:25:38 +09001396 if (lcpu == WORK_CPU_UNBOUND)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001397 lcpu = raw_smp_processor_id();
1398 } else {
1399 lcpu = WORK_CPU_UNBOUND;
1400 }
1401
1402 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1403
Tejun Heo12650572012-08-08 09:38:42 -07001404 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001405 timer->expires = jiffies + delay;
1406
1407 if (unlikely(cpu != WORK_CPU_UNBOUND))
1408 add_timer_on(timer, cpu);
1409 else
1410 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411}
1412
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001413/**
1414 * queue_delayed_work_on - queue work on specific CPU after delay
1415 * @cpu: CPU number to execute work on
1416 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001417 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001418 * @delay: number of jiffies to wait before queueing
1419 *
Tejun Heo715f1302012-08-03 10:30:46 -07001420 * Returns %false if @work was already on a queue, %true otherwise. If
1421 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1422 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001423 */
Tejun Heod4283e92012-08-03 10:30:44 -07001424bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1425 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001426{
David Howells52bad642006-11-22 14:54:01 +00001427 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001428 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001429 unsigned long flags;
1430
1431 /* read the comment in __queue_work() */
1432 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001433
Tejun Heo22df02b2010-06-29 10:07:10 +02001434 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001435 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001436 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001437 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001438
1439 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001440 return ret;
1441}
Dave Jonesae90dd52006-06-30 01:40:45 -04001442EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
Tejun Heoc8e55f32010-06-29 10:07:12 +02001444/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001445 * queue_delayed_work - queue work on a workqueue after delay
1446 * @wq: workqueue to use
1447 * @dwork: delayable work to queue
1448 * @delay: number of jiffies to wait before queueing
1449 *
Tejun Heo715f1302012-08-03 10:30:46 -07001450 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001451 */
Tejun Heod4283e92012-08-03 10:30:44 -07001452bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001453 struct delayed_work *dwork, unsigned long delay)
1454{
Tejun Heo57469822012-08-03 10:30:45 -07001455 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001456}
1457EXPORT_SYMBOL_GPL(queue_delayed_work);
1458
1459/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001460 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1461 * @cpu: CPU number to execute work on
1462 * @wq: workqueue to use
1463 * @dwork: work to queue
1464 * @delay: number of jiffies to wait before queueing
1465 *
1466 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1467 * modify @dwork's timer so that it expires after @delay. If @delay is
1468 * zero, @work is guaranteed to be scheduled immediately regardless of its
1469 * current state.
1470 *
1471 * Returns %false if @dwork was idle and queued, %true if @dwork was
1472 * pending and its timer was modified.
1473 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001474 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001475 * See try_to_grab_pending() for details.
1476 */
1477bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1478 struct delayed_work *dwork, unsigned long delay)
1479{
1480 unsigned long flags;
1481 int ret;
1482
1483 do {
1484 ret = try_to_grab_pending(&dwork->work, true, &flags);
1485 } while (unlikely(ret == -EAGAIN));
1486
1487 if (likely(ret >= 0)) {
1488 __queue_delayed_work(cpu, wq, dwork, delay);
1489 local_irq_restore(flags);
1490 }
1491
1492 /* -ENOENT from try_to_grab_pending() becomes %true */
1493 return ret;
1494}
1495EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1496
1497/**
1498 * mod_delayed_work - modify delay of or queue a delayed work
1499 * @wq: workqueue to use
1500 * @dwork: work to queue
1501 * @delay: number of jiffies to wait before queueing
1502 *
1503 * mod_delayed_work_on() on local CPU.
1504 */
1505bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1506 unsigned long delay)
1507{
1508 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1509}
1510EXPORT_SYMBOL_GPL(mod_delayed_work);
1511
1512/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001513 * worker_enter_idle - enter idle state
1514 * @worker: worker which is entering idle state
1515 *
1516 * @worker is entering idle state. Update stats and idle timer if
1517 * necessary.
1518 *
1519 * LOCKING:
1520 * spin_lock_irq(gcwq->lock).
1521 */
1522static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001524 struct worker_pool *pool = worker->pool;
1525 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
Tejun Heoc8e55f32010-06-29 10:07:12 +02001527 BUG_ON(worker->flags & WORKER_IDLE);
1528 BUG_ON(!list_empty(&worker->entry) &&
1529 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
Tejun Heocb444762010-07-02 10:03:50 +02001531 /* can't use worker_set_flags(), also called from start_worker() */
1532 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001533 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001534 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001535
Tejun Heoc8e55f32010-06-29 10:07:12 +02001536 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001537 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001538
Tejun Heo628c78e2012-07-17 12:39:27 -07001539 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1540 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001541
Tejun Heo544ecf32012-05-14 15:04:50 -07001542 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07001543 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1544 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1545 * nr_running, the warning may trigger spuriously. Check iff
1546 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001547 */
Tejun Heo628c78e2012-07-17 12:39:27 -07001548 WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001549 pool->nr_workers == pool->nr_idle &&
Tejun Heo63d95a92012-07-12 14:46:37 -07001550 atomic_read(get_pool_nr_running(pool)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551}
1552
Tejun Heoc8e55f32010-06-29 10:07:12 +02001553/**
1554 * worker_leave_idle - leave idle state
1555 * @worker: worker which is leaving idle state
1556 *
1557 * @worker is leaving idle state. Update stats.
1558 *
1559 * LOCKING:
1560 * spin_lock_irq(gcwq->lock).
1561 */
1562static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001564 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
Tejun Heoc8e55f32010-06-29 10:07:12 +02001566 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001567 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001568 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001569 list_del_init(&worker->entry);
1570}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Tejun Heoe22bee72010-06-29 10:07:14 +02001572/**
1573 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1574 * @worker: self
1575 *
1576 * Works which are scheduled while the cpu is online must at least be
1577 * scheduled to a worker which is bound to the cpu so that if they are
1578 * flushed from cpu callbacks while cpu is going down, they are
1579 * guaranteed to execute on the cpu.
1580 *
1581 * This function is to be used by rogue workers and rescuers to bind
1582 * themselves to the target cpu and may race with cpu going down or
1583 * coming online. kthread_bind() can't be used because it may put the
1584 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1585 * verbatim as it's best effort and blocking and gcwq may be
1586 * [dis]associated in the meantime.
1587 *
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001588 * This function tries set_cpus_allowed() and locks gcwq and verifies the
1589 * binding against %GCWQ_DISASSOCIATED which is set during
1590 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1591 * enters idle state or fetches works without dropping lock, it can
1592 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001593 *
1594 * CONTEXT:
1595 * Might sleep. Called without any lock but returns with gcwq->lock
1596 * held.
1597 *
1598 * RETURNS:
1599 * %true if the associated gcwq is online (@worker is successfully
1600 * bound), %false if offline.
1601 */
1602static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001603__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001604{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001605 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001606 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
Tejun Heoe22bee72010-06-29 10:07:14 +02001608 while (true) {
1609 /*
1610 * The following call may fail, succeed or succeed
1611 * without actually migrating the task to the cpu if
1612 * it races with cpu hotunplug operation. Verify
1613 * against GCWQ_DISASSOCIATED.
1614 */
Tejun Heof3421792010-07-02 10:03:51 +02001615 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1616 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001617
Tejun Heoe22bee72010-06-29 10:07:14 +02001618 spin_lock_irq(&gcwq->lock);
1619 if (gcwq->flags & GCWQ_DISASSOCIATED)
1620 return false;
1621 if (task_cpu(task) == gcwq->cpu &&
1622 cpumask_equal(&current->cpus_allowed,
1623 get_cpu_mask(gcwq->cpu)))
1624 return true;
1625 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001626
Tejun Heo5035b202011-04-29 18:08:37 +02001627 /*
1628 * We've raced with CPU hot[un]plug. Give it a breather
1629 * and retry migration. cond_resched() is required here;
1630 * otherwise, we might deadlock against cpu_stop trying to
1631 * bring down the CPU on non-preemptive kernel.
1632 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001633 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001634 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001635 }
1636}
1637
1638/*
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001639 * Rebind an idle @worker to its CPU. worker_thread() will test
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001640 * list_empty(@worker->entry) before leaving idle and call this function.
Tejun Heo25511a42012-07-17 12:39:27 -07001641 */
1642static void idle_worker_rebind(struct worker *worker)
1643{
1644 struct global_cwq *gcwq = worker->pool->gcwq;
1645
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001646 /* CPU may go down again inbetween, clear UNBOUND only on success */
1647 if (worker_maybe_bind_and_lock(worker))
1648 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heo25511a42012-07-17 12:39:27 -07001649
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001650 /* rebind complete, become available again */
1651 list_add(&worker->entry, &worker->pool->idle_list);
1652 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001653}
1654
1655/*
1656 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001657 * the associated cpu which is coming back online. This is scheduled by
1658 * cpu up but can race with other cpu hotplug operations and may be
1659 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001660 */
Tejun Heo25511a42012-07-17 12:39:27 -07001661static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001662{
1663 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001664 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001665
Lai Jiangshaneab6d822012-09-18 09:59:22 -07001666 if (worker_maybe_bind_and_lock(worker))
1667 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02001668
1669 spin_unlock_irq(&gcwq->lock);
1670}
1671
Tejun Heo25511a42012-07-17 12:39:27 -07001672/**
1673 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1674 * @gcwq: gcwq of interest
1675 *
1676 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1677 * is different for idle and busy ones.
1678 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001679 * Idle ones will be removed from the idle_list and woken up. They will
1680 * add themselves back after completing rebind. This ensures that the
1681 * idle_list doesn't contain any unbound workers when re-bound busy workers
1682 * try to perform local wake-ups for concurrency management.
Tejun Heo25511a42012-07-17 12:39:27 -07001683 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001684 * Busy workers can rebind after they finish their current work items.
1685 * Queueing the rebind work item at the head of the scheduled list is
1686 * enough. Note that nr_running will be properly bumped as busy workers
1687 * rebind.
Tejun Heo25511a42012-07-17 12:39:27 -07001688 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001689 * On return, all non-manager workers are scheduled for rebind - see
1690 * manage_workers() for the manager special case. Any idle worker
1691 * including the manager will not appear on @idle_list until rebind is
1692 * complete, making local wake-ups safe.
Tejun Heo25511a42012-07-17 12:39:27 -07001693 */
1694static void rebind_workers(struct global_cwq *gcwq)
Tejun Heo25511a42012-07-17 12:39:27 -07001695{
Tejun Heo25511a42012-07-17 12:39:27 -07001696 struct worker_pool *pool;
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001697 struct worker *worker, *n;
Tejun Heo25511a42012-07-17 12:39:27 -07001698 struct hlist_node *pos;
1699 int i;
1700
1701 lockdep_assert_held(&gcwq->lock);
1702
1703 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07001704 lockdep_assert_held(&pool->assoc_mutex);
Tejun Heo25511a42012-07-17 12:39:27 -07001705
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001706 /* dequeue and kick idle ones */
Tejun Heo25511a42012-07-17 12:39:27 -07001707 for_each_worker_pool(pool, gcwq) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001708 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001709 /*
1710 * idle workers should be off @pool->idle_list
1711 * until rebind is complete to avoid receiving
1712 * premature local wake-ups.
1713 */
1714 list_del_init(&worker->entry);
Lai Jiangshan96e65302012-09-02 00:28:19 +08001715
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001716 /*
1717 * worker_thread() will see the above dequeuing
1718 * and call idle_worker_rebind().
1719 */
Tejun Heo25511a42012-07-17 12:39:27 -07001720 wake_up_process(worker->task);
1721 }
1722 }
1723
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001724 /* rebind busy workers */
Tejun Heo25511a42012-07-17 12:39:27 -07001725 for_each_busy_worker(worker, i, pos, gcwq) {
1726 struct work_struct *rebind_work = &worker->rebind_work;
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001727 struct workqueue_struct *wq;
Tejun Heo25511a42012-07-17 12:39:27 -07001728
1729 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1730 work_data_bits(rebind_work)))
1731 continue;
1732
Tejun Heo25511a42012-07-17 12:39:27 -07001733 debug_work_activate(rebind_work);
Tejun Heo90beca52012-09-04 23:12:33 -07001734
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001735 /*
1736 * wq doesn't really matter but let's keep @worker->pool
1737 * and @cwq->pool consistent for sanity.
1738 */
1739 if (worker_pool_pri(worker->pool))
1740 wq = system_highpri_wq;
1741 else
1742 wq = system_wq;
Tejun Heoec588152012-09-04 23:16:32 -07001743
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001744 insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
1745 worker->scheduled.next,
1746 work_color_to_flags(WORK_NO_COLOR));
Tejun Heoec588152012-09-04 23:16:32 -07001747 }
Tejun Heo25511a42012-07-17 12:39:27 -07001748}
1749
Tejun Heoc34056a2010-06-29 10:07:11 +02001750static struct worker *alloc_worker(void)
1751{
1752 struct worker *worker;
1753
1754 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001755 if (worker) {
1756 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001757 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001758 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001759 /* on creation a worker is in !idle && prep state */
1760 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001761 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001762 return worker;
1763}
1764
1765/**
1766 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001767 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001768 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001769 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001770 * can be started by calling start_worker() or destroyed using
1771 * destroy_worker().
1772 *
1773 * CONTEXT:
1774 * Might sleep. Does GFP_KERNEL allocations.
1775 *
1776 * RETURNS:
1777 * Pointer to the newly created worker.
1778 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001779static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001780{
Tejun Heo63d95a92012-07-12 14:46:37 -07001781 struct global_cwq *gcwq = pool->gcwq;
Tejun Heo32704762012-07-13 22:16:45 -07001782 const char *pri = worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001783 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001784 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001785
Tejun Heo8b03ae32010-06-29 10:07:12 +02001786 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001787 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001788 spin_unlock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001789 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001790 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001791 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001792 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001793 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001794
1795 worker = alloc_worker();
1796 if (!worker)
1797 goto fail;
1798
Tejun Heobd7bdd42012-07-12 14:46:37 -07001799 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001800 worker->id = id;
1801
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001802 if (gcwq->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001803 worker->task = kthread_create_on_node(worker_thread,
Tejun Heo32704762012-07-13 22:16:45 -07001804 worker, cpu_to_node(gcwq->cpu),
1805 "kworker/%u:%d%s", gcwq->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001806 else
1807 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001808 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001809 if (IS_ERR(worker->task))
1810 goto fail;
1811
Tejun Heo32704762012-07-13 22:16:45 -07001812 if (worker_pool_pri(pool))
1813 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1814
Tejun Heodb7bccf2010-06-29 10:07:12 +02001815 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001816 * Determine CPU binding of the new worker depending on
1817 * %GCWQ_DISASSOCIATED. The caller is responsible for ensuring the
1818 * flag remains stable across this function. See the comments
1819 * above the flag definition for details.
1820 *
1821 * As an unbound worker may later become a regular one if CPU comes
1822 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001823 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001824 if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001825 kthread_bind(worker->task, gcwq->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001826 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001827 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001828 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001830
Tejun Heoc34056a2010-06-29 10:07:11 +02001831 return worker;
1832fail:
1833 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001834 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001835 ida_remove(&pool->worker_ida, id);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001836 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001837 }
1838 kfree(worker);
1839 return NULL;
1840}
1841
1842/**
1843 * start_worker - start a newly created worker
1844 * @worker: worker to start
1845 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001846 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001847 *
1848 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001849 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001850 */
1851static void start_worker(struct worker *worker)
1852{
Tejun Heocb444762010-07-02 10:03:50 +02001853 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001854 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001855 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001856 wake_up_process(worker->task);
1857}
1858
1859/**
1860 * destroy_worker - destroy a workqueue worker
1861 * @worker: worker to be destroyed
1862 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001863 * Destroy @worker and adjust @gcwq stats accordingly.
1864 *
1865 * CONTEXT:
1866 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001867 */
1868static void destroy_worker(struct worker *worker)
1869{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001870 struct worker_pool *pool = worker->pool;
1871 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001872 int id = worker->id;
1873
1874 /* sanity check frenzy */
1875 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001876 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001877
Tejun Heoc8e55f32010-06-29 10:07:12 +02001878 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001879 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001880 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001881 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001882
1883 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001884 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001885
1886 spin_unlock_irq(&gcwq->lock);
1887
Tejun Heoc34056a2010-06-29 10:07:11 +02001888 kthread_stop(worker->task);
1889 kfree(worker);
1890
Tejun Heo8b03ae32010-06-29 10:07:12 +02001891 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001892 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001893}
1894
Tejun Heo63d95a92012-07-12 14:46:37 -07001895static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001896{
Tejun Heo63d95a92012-07-12 14:46:37 -07001897 struct worker_pool *pool = (void *)__pool;
1898 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001899
1900 spin_lock_irq(&gcwq->lock);
1901
Tejun Heo63d95a92012-07-12 14:46:37 -07001902 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001903 struct worker *worker;
1904 unsigned long expires;
1905
1906 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001907 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001908 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1909
1910 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001911 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001912 else {
1913 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001914 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001915 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001916 }
1917 }
1918
1919 spin_unlock_irq(&gcwq->lock);
1920}
1921
1922static bool send_mayday(struct work_struct *work)
1923{
1924 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1925 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001926 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001927
1928 if (!(wq->flags & WQ_RESCUER))
1929 return false;
1930
1931 /* mayday mayday mayday */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001932 cpu = cwq->pool->gcwq->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001933 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1934 if (cpu == WORK_CPU_UNBOUND)
1935 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001936 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001937 wake_up_process(wq->rescuer->task);
1938 return true;
1939}
1940
Tejun Heo63d95a92012-07-12 14:46:37 -07001941static void gcwq_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001942{
Tejun Heo63d95a92012-07-12 14:46:37 -07001943 struct worker_pool *pool = (void *)__pool;
1944 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001945 struct work_struct *work;
1946
1947 spin_lock_irq(&gcwq->lock);
1948
Tejun Heo63d95a92012-07-12 14:46:37 -07001949 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001950 /*
1951 * We've been trying to create a new worker but
1952 * haven't been successful. We might be hitting an
1953 * allocation deadlock. Send distress signals to
1954 * rescuers.
1955 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001956 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001957 send_mayday(work);
1958 }
1959
1960 spin_unlock_irq(&gcwq->lock);
1961
Tejun Heo63d95a92012-07-12 14:46:37 -07001962 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001963}
1964
1965/**
1966 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001967 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001968 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001969 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001970 * have at least one idle worker on return from this function. If
1971 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001972 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001973 * possible allocation deadlock.
1974 *
1975 * On return, need_to_create_worker() is guaranteed to be false and
1976 * may_start_working() true.
1977 *
1978 * LOCKING:
1979 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1980 * multiple times. Does GFP_KERNEL allocations. Called only from
1981 * manager.
1982 *
1983 * RETURNS:
1984 * false if no action was taken and gcwq->lock stayed locked, true
1985 * otherwise.
1986 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001987static bool maybe_create_worker(struct worker_pool *pool)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001988__releases(&gcwq->lock)
1989__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001990{
Tejun Heo63d95a92012-07-12 14:46:37 -07001991 struct global_cwq *gcwq = pool->gcwq;
1992
1993 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001994 return false;
1995restart:
Tejun Heo9f9c236442010-07-14 11:31:20 +02001996 spin_unlock_irq(&gcwq->lock);
1997
Tejun Heoe22bee72010-06-29 10:07:14 +02001998 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001999 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002000
2001 while (true) {
2002 struct worker *worker;
2003
Tejun Heobc2ae0f2012-07-17 12:39:27 -07002004 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002005 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002006 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002007 spin_lock_irq(&gcwq->lock);
2008 start_worker(worker);
Tejun Heo63d95a92012-07-12 14:46:37 -07002009 BUG_ON(need_to_create_worker(pool));
Tejun Heoe22bee72010-06-29 10:07:14 +02002010 return true;
2011 }
2012
Tejun Heo63d95a92012-07-12 14:46:37 -07002013 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002014 break;
2015
Tejun Heoe22bee72010-06-29 10:07:14 +02002016 __set_current_state(TASK_INTERRUPTIBLE);
2017 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002018
Tejun Heo63d95a92012-07-12 14:46:37 -07002019 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002020 break;
2021 }
2022
Tejun Heo63d95a92012-07-12 14:46:37 -07002023 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002024 spin_lock_irq(&gcwq->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07002025 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002026 goto restart;
2027 return true;
2028}
2029
2030/**
2031 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07002032 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02002033 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002034 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02002035 * IDLE_WORKER_TIMEOUT.
2036 *
2037 * LOCKING:
2038 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2039 * multiple times. Called only from manager.
2040 *
2041 * RETURNS:
2042 * false if no action was taken and gcwq->lock stayed locked, true
2043 * otherwise.
2044 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002045static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02002046{
2047 bool ret = false;
2048
Tejun Heo63d95a92012-07-12 14:46:37 -07002049 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002050 struct worker *worker;
2051 unsigned long expires;
2052
Tejun Heo63d95a92012-07-12 14:46:37 -07002053 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002054 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2055
2056 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002057 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002058 break;
2059 }
2060
2061 destroy_worker(worker);
2062 ret = true;
2063 }
2064
2065 return ret;
2066}
2067
2068/**
2069 * manage_workers - manage worker pool
2070 * @worker: self
2071 *
2072 * Assume the manager role and manage gcwq worker pool @worker belongs
2073 * to. At any given time, there can be only zero or one manager per
2074 * gcwq. The exclusion is handled automatically by this function.
2075 *
2076 * The caller can safely start processing works on false return. On
2077 * true return, it's guaranteed that need_to_create_worker() is false
2078 * and may_start_working() is true.
2079 *
2080 * CONTEXT:
2081 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2082 * multiple times. Does GFP_KERNEL allocations.
2083 *
2084 * RETURNS:
2085 * false if no action was taken and gcwq->lock stayed locked, true if
2086 * some action was taken.
2087 */
2088static bool manage_workers(struct worker *worker)
2089{
Tejun Heo63d95a92012-07-12 14:46:37 -07002090 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002091 bool ret = false;
2092
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002093 if (pool->flags & POOL_MANAGING_WORKERS)
Tejun Heoe22bee72010-06-29 10:07:14 +02002094 return ret;
2095
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002096 pool->flags |= POOL_MANAGING_WORKERS;
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002097
2098 /*
2099 * To simplify both worker management and CPU hotplug, hold off
2100 * management while hotplug is in progress. CPU hotplug path can't
2101 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2102 * lead to idle worker depletion (all become busy thinking someone
2103 * else is managing) which in turn can result in deadlock under
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002104 * extreme circumstances. Use @pool->assoc_mutex to synchronize
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002105 * manager against CPU hotplug.
2106 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002107 * assoc_mutex would always be free unless CPU hotplug is in
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002108 * progress. trylock first without dropping @gcwq->lock.
2109 */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002110 if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002111 spin_unlock_irq(&pool->gcwq->lock);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002112 mutex_lock(&pool->assoc_mutex);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002113 /*
2114 * CPU hotplug could have happened while we were waiting
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002115 * for assoc_mutex. Hotplug itself can't handle us
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002116 * because manager isn't either on idle or busy list, and
2117 * @gcwq's state and ours could have deviated.
2118 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002119 * As hotplug is now excluded via assoc_mutex, we can
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002120 * simply try to bind. It will succeed or fail depending
2121 * on @gcwq's current state. Try it and adjust
2122 * %WORKER_UNBOUND accordingly.
2123 */
2124 if (worker_maybe_bind_and_lock(worker))
2125 worker->flags &= ~WORKER_UNBOUND;
2126 else
2127 worker->flags |= WORKER_UNBOUND;
2128
2129 ret = true;
2130 }
2131
Tejun Heo11ebea52012-07-12 14:46:37 -07002132 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002133
2134 /*
2135 * Destroy and then create so that may_start_working() is true
2136 * on return.
2137 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002138 ret |= maybe_destroy_workers(pool);
2139 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002140
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002141 pool->flags &= ~POOL_MANAGING_WORKERS;
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002142 mutex_unlock(&pool->assoc_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002143 return ret;
2144}
2145
Tejun Heoa62428c2010-06-29 10:07:10 +02002146/**
2147 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002148 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002149 * @work: work to process
2150 *
2151 * Process @work. This function contains all the logics necessary to
2152 * process a single work including synchronization against and
2153 * interaction with other workers on the same cpu, queueing and
2154 * flushing. As long as context requirement is met, any worker can
2155 * call this function to process a work.
2156 *
2157 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002158 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002159 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002160static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09002161__releases(&gcwq->lock)
2162__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002163{
Tejun Heo7e116292010-06-29 10:07:13 +02002164 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002165 struct worker_pool *pool = worker->pool;
2166 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002167 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002168 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02002169 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02002170 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002171 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002172#ifdef CONFIG_LOCKDEP
2173 /*
2174 * It is permissible to free the struct work_struct from
2175 * inside the function that is called from it, this we need to
2176 * take into account for lockdep too. To avoid bogus "held
2177 * lock freed" warnings as well as problems when looking into
2178 * work->lockdep_map, make a copy and use that here.
2179 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002180 struct lockdep_map lockdep_map;
2181
2182 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002183#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002184 /*
2185 * Ensure we're on the correct CPU. DISASSOCIATED test is
2186 * necessary to avoid spurious warnings from rescuers servicing the
2187 * unbound or a disassociated gcwq.
2188 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002189 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo6fec10a2012-07-22 10:16:34 -07002190 !(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heo25511a42012-07-17 12:39:27 -07002191 raw_smp_processor_id() != gcwq->cpu);
2192
Tejun Heo7e116292010-06-29 10:07:13 +02002193 /*
2194 * A single work shouldn't be executed concurrently by
2195 * multiple workers on a single cpu. Check whether anyone is
2196 * already processing the work. If so, defer the work to the
2197 * currently executing one.
2198 */
2199 collision = __find_worker_executing_work(gcwq, bwh, work);
2200 if (unlikely(collision)) {
2201 move_linked_works(work, &collision->scheduled, NULL);
2202 return;
2203 }
2204
Tejun Heo8930cab2012-08-03 10:30:45 -07002205 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002206 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002207 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02002208 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002209 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002210 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002211
Tejun Heoa62428c2010-06-29 10:07:10 +02002212 list_del_init(&work->entry);
2213
Tejun Heo649027d2010-06-29 10:07:14 +02002214 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002215 * CPU intensive works don't participate in concurrency
2216 * management. They're the scheduler's responsibility.
2217 */
2218 if (unlikely(cpu_intensive))
2219 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2220
Tejun Heo974271c2012-07-12 14:46:37 -07002221 /*
2222 * Unbound gcwq isn't concurrency managed and work items should be
2223 * executed ASAP. Wake up another worker if necessary.
2224 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002225 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2226 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002227
Tejun Heo8930cab2012-08-03 10:30:45 -07002228 /*
Tejun Heo23657bb2012-08-13 17:08:19 -07002229 * Record the last CPU and clear PENDING which should be the last
2230 * update to @work. Also, do this inside @gcwq->lock so that
2231 * PENDING and queued state changes happen together while IRQ is
2232 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002233 */
Tejun Heo8930cab2012-08-03 10:30:45 -07002234 set_work_cpu_and_clear_pending(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02002235
Tejun Heoa62428c2010-06-29 10:07:10 +02002236 spin_unlock_irq(&gcwq->lock);
2237
Tejun Heoe159489b2011-01-09 23:32:15 +01002238 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002239 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002240 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002241 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002242 /*
2243 * While we must be careful to not use "work" after this, the trace
2244 * point will only record its address.
2245 */
2246 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002247 lock_map_release(&lockdep_map);
2248 lock_map_release(&cwq->wq->lockdep_map);
2249
2250 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002251 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2252 " last function: %pf\n",
2253 current->comm, preempt_count(), task_pid_nr(current), f);
Tejun Heoa62428c2010-06-29 10:07:10 +02002254 debug_show_held_locks(current);
2255 dump_stack();
2256 }
2257
Tejun Heo8b03ae32010-06-29 10:07:12 +02002258 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002259
Tejun Heofb0e7be2010-06-29 10:07:15 +02002260 /* clear cpu intensive status */
2261 if (unlikely(cpu_intensive))
2262 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2263
Tejun Heoa62428c2010-06-29 10:07:10 +02002264 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02002265 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002266 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002267 worker->current_cwq = NULL;
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07002268 cwq_dec_nr_in_flight(cwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002269}
2270
Tejun Heoaffee4b2010-06-29 10:07:12 +02002271/**
2272 * process_scheduled_works - process scheduled works
2273 * @worker: self
2274 *
2275 * Process all scheduled works. Please note that the scheduled list
2276 * may change while processing a work, so this function repeatedly
2277 * fetches a work from the top and executes it.
2278 *
2279 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002280 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002281 * multiple times.
2282 */
2283static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002285 while (!list_empty(&worker->scheduled)) {
2286 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002288 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290}
2291
Tejun Heo4690c4a2010-06-29 10:07:10 +02002292/**
2293 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002294 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002295 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002296 * The gcwq worker thread function. There's a single dynamic pool of
2297 * these per each cpu. These workers process all works regardless of
2298 * their specific target workqueue. The only exception is works which
2299 * belong to workqueues with a rescuer which will be explained in
2300 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002301 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002302static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303{
Tejun Heoc34056a2010-06-29 10:07:11 +02002304 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002305 struct worker_pool *pool = worker->pool;
2306 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307
Tejun Heoe22bee72010-06-29 10:07:14 +02002308 /* tell the scheduler that this is a workqueue worker */
2309 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002310woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002311 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002313 /* we are off idle list if destruction or rebind is requested */
2314 if (unlikely(list_empty(&worker->entry))) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002315 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002316
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002317 /* if DIE is set, destruction is requested */
Tejun Heo25511a42012-07-17 12:39:27 -07002318 if (worker->flags & WORKER_DIE) {
2319 worker->task->flags &= ~PF_WQ_WORKER;
2320 return 0;
2321 }
2322
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002323 /* otherwise, rebind */
Tejun Heo25511a42012-07-17 12:39:27 -07002324 idle_worker_rebind(worker);
2325 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 }
2327
Tejun Heoc8e55f32010-06-29 10:07:12 +02002328 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002329recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002330 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002331 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002332 goto sleep;
2333
2334 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002335 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002336 goto recheck;
2337
Tejun Heoc8e55f32010-06-29 10:07:12 +02002338 /*
2339 * ->scheduled list can only be filled while a worker is
2340 * preparing to process a work or actually processing it.
2341 * Make sure nobody diddled with it while I was sleeping.
2342 */
2343 BUG_ON(!list_empty(&worker->scheduled));
2344
Tejun Heoe22bee72010-06-29 10:07:14 +02002345 /*
2346 * When control reaches this point, we're guaranteed to have
2347 * at least one idle worker or that someone else has already
2348 * assumed the manager role.
2349 */
2350 worker_clr_flags(worker, WORKER_PREP);
2351
2352 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002353 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002354 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002355 struct work_struct, entry);
2356
2357 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2358 /* optimization path, not strictly necessary */
2359 process_one_work(worker, work);
2360 if (unlikely(!list_empty(&worker->scheduled)))
2361 process_scheduled_works(worker);
2362 } else {
2363 move_linked_works(work, &worker->scheduled, NULL);
2364 process_scheduled_works(worker);
2365 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002366 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002367
Tejun Heoe22bee72010-06-29 10:07:14 +02002368 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002369sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002370 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002371 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002372
Tejun Heoc8e55f32010-06-29 10:07:12 +02002373 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002374 * gcwq->lock is held and there's no work to process and no
2375 * need to manage, sleep. Workers are woken up only while
2376 * holding gcwq->lock or from local cpu, so setting the
2377 * current state before releasing gcwq->lock is enough to
2378 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002379 */
2380 worker_enter_idle(worker);
2381 __set_current_state(TASK_INTERRUPTIBLE);
2382 spin_unlock_irq(&gcwq->lock);
2383 schedule();
2384 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385}
2386
Tejun Heoe22bee72010-06-29 10:07:14 +02002387/**
2388 * rescuer_thread - the rescuer thread function
2389 * @__wq: the associated workqueue
2390 *
2391 * Workqueue rescuer thread function. There's one rescuer for each
2392 * workqueue which has WQ_RESCUER set.
2393 *
2394 * Regular work processing on a gcwq may block trying to create a new
2395 * worker which uses GFP_KERNEL allocation which has slight chance of
2396 * developing into deadlock if some works currently on the same queue
2397 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2398 * the problem rescuer solves.
2399 *
2400 * When such condition is possible, the gcwq summons rescuers of all
2401 * workqueues which have works queued on the gcwq and let them process
2402 * those works so that forward progress can be guaranteed.
2403 *
2404 * This should happen rarely.
2405 */
2406static int rescuer_thread(void *__wq)
2407{
2408 struct workqueue_struct *wq = __wq;
2409 struct worker *rescuer = wq->rescuer;
2410 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002411 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002412 unsigned int cpu;
2413
2414 set_user_nice(current, RESCUER_NICE_LEVEL);
2415repeat:
2416 set_current_state(TASK_INTERRUPTIBLE);
2417
Mike Galbraith412d32e2012-11-28 07:17:18 +01002418 if (kthread_should_stop()) {
2419 __set_current_state(TASK_RUNNING);
Tejun Heoe22bee72010-06-29 10:07:14 +02002420 return 0;
Mike Galbraith412d32e2012-11-28 07:17:18 +01002421 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002422
Tejun Heof3421792010-07-02 10:03:51 +02002423 /*
2424 * See whether any cpu is asking for help. Unbounded
2425 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2426 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002427 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002428 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2429 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002430 struct worker_pool *pool = cwq->pool;
2431 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002432 struct work_struct *work, *n;
2433
2434 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002435 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002436
2437 /* migrate to the target cpu if possible */
Tejun Heobd7bdd42012-07-12 14:46:37 -07002438 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002439 worker_maybe_bind_and_lock(rescuer);
2440
2441 /*
2442 * Slurp in all works issued via this workqueue and
2443 * process'em.
2444 */
2445 BUG_ON(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002446 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002447 if (get_work_cwq(work) == cwq)
2448 move_linked_works(work, scheduled, &n);
2449
2450 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002451
2452 /*
2453 * Leave this gcwq. If keep_working() is %true, notify a
2454 * regular worker; otherwise, we end up with 0 concurrency
2455 * and stalling the execution.
2456 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002457 if (keep_working(pool))
2458 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002459
Tejun Heoe22bee72010-06-29 10:07:14 +02002460 spin_unlock_irq(&gcwq->lock);
2461 }
2462
2463 schedule();
2464 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465}
2466
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002467struct wq_barrier {
2468 struct work_struct work;
2469 struct completion done;
2470};
2471
2472static void wq_barrier_func(struct work_struct *work)
2473{
2474 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2475 complete(&barr->done);
2476}
2477
Tejun Heo4690c4a2010-06-29 10:07:10 +02002478/**
2479 * insert_wq_barrier - insert a barrier work
2480 * @cwq: cwq to insert barrier into
2481 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002482 * @target: target work to attach @barr to
2483 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002484 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002485 * @barr is linked to @target such that @barr is completed only after
2486 * @target finishes execution. Please note that the ordering
2487 * guarantee is observed only with respect to @target and on the local
2488 * cpu.
2489 *
2490 * Currently, a queued barrier can't be canceled. This is because
2491 * try_to_grab_pending() can't determine whether the work to be
2492 * grabbed is at the head of the queue and thus can't clear LINKED
2493 * flag of the previous work while there must be a valid next work
2494 * after a work with LINKED flag set.
2495 *
2496 * Note that when @worker is non-NULL, @target may be modified
2497 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002498 *
2499 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002500 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002501 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002502static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002503 struct wq_barrier *barr,
2504 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002505{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002506 struct list_head *head;
2507 unsigned int linked = 0;
2508
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002509 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002510 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002511 * as we know for sure that this will not trigger any of the
2512 * checks and call back into the fixup functions where we
2513 * might deadlock.
2514 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002515 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002516 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002517 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002518
Tejun Heoaffee4b2010-06-29 10:07:12 +02002519 /*
2520 * If @target is currently being executed, schedule the
2521 * barrier to the worker; otherwise, put it after @target.
2522 */
2523 if (worker)
2524 head = worker->scheduled.next;
2525 else {
2526 unsigned long *bits = work_data_bits(target);
2527
2528 head = target->entry.next;
2529 /* there can already be other linked works, inherit and set */
2530 linked = *bits & WORK_STRUCT_LINKED;
2531 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2532 }
2533
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002534 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002535 insert_work(cwq, &barr->work, head,
2536 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002537}
2538
Tejun Heo73f53c42010-06-29 10:07:11 +02002539/**
2540 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2541 * @wq: workqueue being flushed
2542 * @flush_color: new flush color, < 0 for no-op
2543 * @work_color: new work color, < 0 for no-op
2544 *
2545 * Prepare cwqs for workqueue flushing.
2546 *
2547 * If @flush_color is non-negative, flush_color on all cwqs should be
2548 * -1. If no cwq has in-flight commands at the specified color, all
2549 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2550 * has in flight commands, its cwq->flush_color is set to
2551 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2552 * wakeup logic is armed and %true is returned.
2553 *
2554 * The caller should have initialized @wq->first_flusher prior to
2555 * calling this function with non-negative @flush_color. If
2556 * @flush_color is negative, no flush color update is done and %false
2557 * is returned.
2558 *
2559 * If @work_color is non-negative, all cwqs should have the same
2560 * work_color which is previous to @work_color and all will be
2561 * advanced to @work_color.
2562 *
2563 * CONTEXT:
2564 * mutex_lock(wq->flush_mutex).
2565 *
2566 * RETURNS:
2567 * %true if @flush_color >= 0 and there's something to flush. %false
2568 * otherwise.
2569 */
2570static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2571 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572{
Tejun Heo73f53c42010-06-29 10:07:11 +02002573 bool wait = false;
2574 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002575
Tejun Heo73f53c42010-06-29 10:07:11 +02002576 if (flush_color >= 0) {
2577 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2578 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002579 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002580
Tejun Heof3421792010-07-02 10:03:51 +02002581 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002582 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002583 struct global_cwq *gcwq = cwq->pool->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002584
Tejun Heo8b03ae32010-06-29 10:07:12 +02002585 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002586
2587 if (flush_color >= 0) {
2588 BUG_ON(cwq->flush_color != -1);
2589
2590 if (cwq->nr_in_flight[flush_color]) {
2591 cwq->flush_color = flush_color;
2592 atomic_inc(&wq->nr_cwqs_to_flush);
2593 wait = true;
2594 }
2595 }
2596
2597 if (work_color >= 0) {
2598 BUG_ON(work_color != work_next_color(cwq->work_color));
2599 cwq->work_color = work_color;
2600 }
2601
Tejun Heo8b03ae32010-06-29 10:07:12 +02002602 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002603 }
2604
2605 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2606 complete(&wq->first_flusher->done);
2607
2608 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609}
2610
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002611/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002613 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614 *
2615 * Forces execution of the workqueue and blocks until its completion.
2616 * This is typically used in driver shutdown handlers.
2617 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002618 * We sleep until all works which were queued on entry have been handled,
2619 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002621void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622{
Tejun Heo73f53c42010-06-29 10:07:11 +02002623 struct wq_flusher this_flusher = {
2624 .list = LIST_HEAD_INIT(this_flusher.list),
2625 .flush_color = -1,
2626 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2627 };
2628 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002629
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002630 lock_map_acquire(&wq->lockdep_map);
2631 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002632
2633 mutex_lock(&wq->flush_mutex);
2634
2635 /*
2636 * Start-to-wait phase
2637 */
2638 next_color = work_next_color(wq->work_color);
2639
2640 if (next_color != wq->flush_color) {
2641 /*
2642 * Color space is not full. The current work_color
2643 * becomes our flush_color and work_color is advanced
2644 * by one.
2645 */
2646 BUG_ON(!list_empty(&wq->flusher_overflow));
2647 this_flusher.flush_color = wq->work_color;
2648 wq->work_color = next_color;
2649
2650 if (!wq->first_flusher) {
2651 /* no flush in progress, become the first flusher */
2652 BUG_ON(wq->flush_color != this_flusher.flush_color);
2653
2654 wq->first_flusher = &this_flusher;
2655
2656 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2657 wq->work_color)) {
2658 /* nothing to flush, done */
2659 wq->flush_color = next_color;
2660 wq->first_flusher = NULL;
2661 goto out_unlock;
2662 }
2663 } else {
2664 /* wait in queue */
2665 BUG_ON(wq->flush_color == this_flusher.flush_color);
2666 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2667 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2668 }
2669 } else {
2670 /*
2671 * Oops, color space is full, wait on overflow queue.
2672 * The next flush completion will assign us
2673 * flush_color and transfer to flusher_queue.
2674 */
2675 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2676 }
2677
2678 mutex_unlock(&wq->flush_mutex);
2679
2680 wait_for_completion(&this_flusher.done);
2681
2682 /*
2683 * Wake-up-and-cascade phase
2684 *
2685 * First flushers are responsible for cascading flushes and
2686 * handling overflow. Non-first flushers can simply return.
2687 */
2688 if (wq->first_flusher != &this_flusher)
2689 return;
2690
2691 mutex_lock(&wq->flush_mutex);
2692
Tejun Heo4ce48b32010-07-02 10:03:51 +02002693 /* we might have raced, check again with mutex held */
2694 if (wq->first_flusher != &this_flusher)
2695 goto out_unlock;
2696
Tejun Heo73f53c42010-06-29 10:07:11 +02002697 wq->first_flusher = NULL;
2698
2699 BUG_ON(!list_empty(&this_flusher.list));
2700 BUG_ON(wq->flush_color != this_flusher.flush_color);
2701
2702 while (true) {
2703 struct wq_flusher *next, *tmp;
2704
2705 /* complete all the flushers sharing the current flush color */
2706 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2707 if (next->flush_color != wq->flush_color)
2708 break;
2709 list_del_init(&next->list);
2710 complete(&next->done);
2711 }
2712
2713 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2714 wq->flush_color != work_next_color(wq->work_color));
2715
2716 /* this flush_color is finished, advance by one */
2717 wq->flush_color = work_next_color(wq->flush_color);
2718
2719 /* one color has been freed, handle overflow queue */
2720 if (!list_empty(&wq->flusher_overflow)) {
2721 /*
2722 * Assign the same color to all overflowed
2723 * flushers, advance work_color and append to
2724 * flusher_queue. This is the start-to-wait
2725 * phase for these overflowed flushers.
2726 */
2727 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2728 tmp->flush_color = wq->work_color;
2729
2730 wq->work_color = work_next_color(wq->work_color);
2731
2732 list_splice_tail_init(&wq->flusher_overflow,
2733 &wq->flusher_queue);
2734 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2735 }
2736
2737 if (list_empty(&wq->flusher_queue)) {
2738 BUG_ON(wq->flush_color != wq->work_color);
2739 break;
2740 }
2741
2742 /*
2743 * Need to flush more colors. Make the next flusher
2744 * the new first flusher and arm cwqs.
2745 */
2746 BUG_ON(wq->flush_color == wq->work_color);
2747 BUG_ON(wq->flush_color != next->flush_color);
2748
2749 list_del_init(&next->list);
2750 wq->first_flusher = next;
2751
2752 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2753 break;
2754
2755 /*
2756 * Meh... this color is already done, clear first
2757 * flusher and repeat cascading.
2758 */
2759 wq->first_flusher = NULL;
2760 }
2761
2762out_unlock:
2763 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764}
Dave Jonesae90dd52006-06-30 01:40:45 -04002765EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002767/**
2768 * drain_workqueue - drain a workqueue
2769 * @wq: workqueue to drain
2770 *
2771 * Wait until the workqueue becomes empty. While draining is in progress,
2772 * only chain queueing is allowed. IOW, only currently pending or running
2773 * work items on @wq can queue further work items on it. @wq is flushed
2774 * repeatedly until it becomes empty. The number of flushing is detemined
2775 * by the depth of chaining and should be relatively short. Whine if it
2776 * takes too long.
2777 */
2778void drain_workqueue(struct workqueue_struct *wq)
2779{
2780 unsigned int flush_cnt = 0;
2781 unsigned int cpu;
2782
2783 /*
2784 * __queue_work() needs to test whether there are drainers, is much
2785 * hotter than drain_workqueue() and already looks at @wq->flags.
2786 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2787 */
2788 spin_lock(&workqueue_lock);
2789 if (!wq->nr_drainers++)
2790 wq->flags |= WQ_DRAINING;
2791 spin_unlock(&workqueue_lock);
2792reflush:
2793 flush_workqueue(wq);
2794
2795 for_each_cwq_cpu(cpu, wq) {
2796 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002797 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002798
Tejun Heobd7bdd42012-07-12 14:46:37 -07002799 spin_lock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002800 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002801 spin_unlock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002802
2803 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002804 continue;
2805
2806 if (++flush_cnt == 10 ||
2807 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Valentin Ilie044c7822012-08-19 00:52:42 +03002808 pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
2809 wq->name, flush_cnt);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002810 goto reflush;
2811 }
2812
2813 spin_lock(&workqueue_lock);
2814 if (!--wq->nr_drainers)
2815 wq->flags &= ~WQ_DRAINING;
2816 spin_unlock(&workqueue_lock);
2817}
2818EXPORT_SYMBOL_GPL(drain_workqueue);
2819
Tejun Heo606a5022012-08-20 14:51:23 -07002820static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002821{
2822 struct worker *worker = NULL;
2823 struct global_cwq *gcwq;
2824 struct cpu_workqueue_struct *cwq;
2825
2826 might_sleep();
2827 gcwq = get_work_gcwq(work);
2828 if (!gcwq)
2829 return false;
2830
2831 spin_lock_irq(&gcwq->lock);
2832 if (!list_empty(&work->entry)) {
2833 /*
2834 * See the comment near try_to_grab_pending()->smp_rmb().
2835 * If it was re-queued to a different gcwq under us, we
2836 * are not going to wait.
2837 */
2838 smp_rmb();
2839 cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002840 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
Tejun Heobaf59022010-09-16 10:42:16 +02002841 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002842 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002843 worker = find_worker_executing_work(gcwq, work);
2844 if (!worker)
2845 goto already_gone;
2846 cwq = worker->current_cwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002847 }
Tejun Heobaf59022010-09-16 10:42:16 +02002848
2849 insert_wq_barrier(cwq, barr, work, worker);
2850 spin_unlock_irq(&gcwq->lock);
2851
Tejun Heoe159489b2011-01-09 23:32:15 +01002852 /*
2853 * If @max_active is 1 or rescuer is in use, flushing another work
2854 * item on the same workqueue may lead to deadlock. Make sure the
2855 * flusher is not running on the same workqueue by verifying write
2856 * access.
2857 */
2858 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2859 lock_map_acquire(&cwq->wq->lockdep_map);
2860 else
2861 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002862 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe159489b2011-01-09 23:32:15 +01002863
Tejun Heobaf59022010-09-16 10:42:16 +02002864 return true;
2865already_gone:
2866 spin_unlock_irq(&gcwq->lock);
2867 return false;
2868}
2869
Oleg Nesterovdb700892008-07-25 01:47:49 -07002870/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002871 * flush_work - wait for a work to finish executing the last queueing instance
2872 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002873 *
Tejun Heo606a5022012-08-20 14:51:23 -07002874 * Wait until @work has finished execution. @work is guaranteed to be idle
2875 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002876 *
2877 * RETURNS:
2878 * %true if flush_work() waited for the work to finish execution,
2879 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002880 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002881bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002882{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002883 struct wq_barrier barr;
2884
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002885 lock_map_acquire(&work->lockdep_map);
2886 lock_map_release(&work->lockdep_map);
2887
Tejun Heo606a5022012-08-20 14:51:23 -07002888 if (start_flush_work(work, &barr)) {
Tejun Heobaf59022010-09-16 10:42:16 +02002889 wait_for_completion(&barr.done);
2890 destroy_work_on_stack(&barr.work);
2891 return true;
Tejun Heo606a5022012-08-20 14:51:23 -07002892 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002893 return false;
Tejun Heo606a5022012-08-20 14:51:23 -07002894 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002895}
2896EXPORT_SYMBOL_GPL(flush_work);
2897
Tejun Heo36e227d2012-08-03 10:30:46 -07002898static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002899{
Tejun Heobbb68df2012-08-03 10:30:46 -07002900 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002901 int ret;
2902
2903 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002904 ret = try_to_grab_pending(work, is_dwork, &flags);
2905 /*
2906 * If someone else is canceling, wait for the same event it
2907 * would be waiting for before retrying.
2908 */
2909 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002910 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002911 } while (unlikely(ret < 0));
2912
Tejun Heobbb68df2012-08-03 10:30:46 -07002913 /* tell other tasks trying to grab @work to back off */
2914 mark_work_canceling(work);
2915 local_irq_restore(flags);
2916
Tejun Heo606a5022012-08-20 14:51:23 -07002917 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002918 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002919 return ret;
2920}
2921
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002922/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002923 * cancel_work_sync - cancel a work and wait for it to finish
2924 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002925 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002926 * Cancel @work and wait for its execution to finish. This function
2927 * can be used even if the work re-queues itself or migrates to
2928 * another workqueue. On return from this function, @work is
2929 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002930 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002931 * cancel_work_sync(&delayed_work->work) must not be used for
2932 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002933 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002934 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002935 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002936 *
2937 * RETURNS:
2938 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002939 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002940bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002941{
Tejun Heo36e227d2012-08-03 10:30:46 -07002942 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002943}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002944EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002945
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002946/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002947 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2948 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002949 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002950 * Delayed timer is cancelled and the pending work is queued for
2951 * immediate execution. Like flush_work(), this function only
2952 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002953 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002954 * RETURNS:
2955 * %true if flush_work() waited for the work to finish execution,
2956 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002957 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002958bool flush_delayed_work(struct delayed_work *dwork)
2959{
Tejun Heo8930cab2012-08-03 10:30:45 -07002960 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002961 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07002962 __queue_work(dwork->cpu,
Tejun Heo401a8d02010-09-16 10:36:00 +02002963 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002964 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002965 return flush_work(&dwork->work);
2966}
2967EXPORT_SYMBOL(flush_delayed_work);
2968
2969/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002970 * cancel_delayed_work - cancel a delayed work
2971 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002972 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002973 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2974 * and canceled; %false if wasn't pending. Note that the work callback
2975 * function may still be running on return, unless it returns %true and the
2976 * work doesn't re-arm itself. Explicitly flush or use
2977 * cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002978 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002979 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002980 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002981bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002982{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002983 unsigned long flags;
2984 int ret;
2985
2986 do {
2987 ret = try_to_grab_pending(&dwork->work, true, &flags);
2988 } while (unlikely(ret == -EAGAIN));
2989
2990 if (unlikely(ret < 0))
2991 return false;
2992
2993 set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
2994 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002995 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002996}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002997EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002998
2999/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003000 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3001 * @dwork: the delayed work cancel
3002 *
3003 * This is cancel_work_sync() for delayed works.
3004 *
3005 * RETURNS:
3006 * %true if @dwork was pending, %false otherwise.
3007 */
3008bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003009{
Tejun Heo36e227d2012-08-03 10:30:46 -07003010 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003011}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003012EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003014/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07003015 * schedule_work_on - put work task on a specific cpu
3016 * @cpu: cpu to put the work task on
3017 * @work: job to be done
3018 *
3019 * This puts a job on a specific cpu
3020 */
Tejun Heod4283e92012-08-03 10:30:44 -07003021bool schedule_work_on(int cpu, struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07003022{
Tejun Heod320c032010-06-29 10:07:14 +02003023 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07003024}
3025EXPORT_SYMBOL(schedule_work_on);
3026
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003027/**
Dave Jonesae90dd52006-06-30 01:40:45 -04003028 * schedule_work - put work task in global workqueue
Linus Torvalds1da177e2005-04-16 15:20:36 -07003029 * @work: job to be done
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030 *
Tejun Heod4283e92012-08-03 10:30:44 -07003031 * Returns %false if @work was already on the kernel-global workqueue and
3032 * %true otherwise.
David Howells52bad642006-11-22 14:54:01 +00003033 *
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003034 * This puts a job in the kernel-global workqueue if it was not already
3035 * queued and leaves it in the same position on the kernel-global
3036 * workqueue otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003037 */
Tejun Heod4283e92012-08-03 10:30:44 -07003038bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003039{
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003040 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003041}
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003042EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003043
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003044/**
3045 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3046 * @cpu: cpu to use
3047 * @dwork: job to be done
3048 * @delay: number of jiffies to wait
3049 *
3050 * After waiting for a given time this puts a job in the kernel-global
3051 * workqueue on the specified CPU.
3052 */
Tejun Heod4283e92012-08-03 10:30:44 -07003053bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3054 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003055{
Tejun Heod320c032010-06-29 10:07:14 +02003056 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003057}
Dave Jonesae90dd52006-06-30 01:40:45 -04003058EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059
Andrew Mortonb6136772006-06-25 05:47:49 -07003060/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003061 * schedule_delayed_work - put work task in global workqueue after delay
3062 * @dwork: job to be done
3063 * @delay: number of jiffies to wait or 0 for immediate execution
3064 *
3065 * After waiting for a given time this puts a job in the kernel-global
3066 * workqueue.
3067 */
Tejun Heod4283e92012-08-03 10:30:44 -07003068bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003069{
3070 return queue_delayed_work(system_wq, dwork, delay);
3071}
3072EXPORT_SYMBOL(schedule_delayed_work);
3073
3074/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003075 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003076 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003077 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003078 * schedule_on_each_cpu() executes @func on each online CPU using the
3079 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003080 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003081 *
3082 * RETURNS:
3083 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003084 */
David Howells65f27f32006-11-22 14:55:48 +00003085int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003086{
3087 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003088 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003089
Andrew Mortonb6136772006-06-25 05:47:49 -07003090 works = alloc_percpu(struct work_struct);
3091 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003092 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003093
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003094 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003095
Christoph Lameter15316ba2006-01-08 01:00:43 -08003096 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003097 struct work_struct *work = per_cpu_ptr(works, cpu);
3098
3099 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003100 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003101 }
Tejun Heo93981802009-11-17 14:06:20 -08003102
3103 for_each_online_cpu(cpu)
3104 flush_work(per_cpu_ptr(works, cpu));
3105
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003106 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003107 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003108 return 0;
3109}
3110
Alan Sterneef6a7d2010-02-12 17:39:21 +09003111/**
3112 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3113 *
3114 * Forces execution of the kernel-global workqueue and blocks until its
3115 * completion.
3116 *
3117 * Think twice before calling this function! It's very easy to get into
3118 * trouble if you don't take great care. Either of the following situations
3119 * will lead to deadlock:
3120 *
3121 * One of the work items currently on the workqueue needs to acquire
3122 * a lock held by your code or its caller.
3123 *
3124 * Your code is running in the context of a work routine.
3125 *
3126 * They will be detected by lockdep when they occur, but the first might not
3127 * occur very often. It depends on what work items are on the workqueue and
3128 * what locks they need, which you have no control over.
3129 *
3130 * In most situations flushing the entire workqueue is overkill; you merely
3131 * need to know that a particular work item isn't queued and isn't running.
3132 * In such cases you should use cancel_delayed_work_sync() or
3133 * cancel_work_sync() instead.
3134 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003135void flush_scheduled_work(void)
3136{
Tejun Heod320c032010-06-29 10:07:14 +02003137 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138}
Dave Jonesae90dd52006-06-30 01:40:45 -04003139EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003140
3141/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003142 * execute_in_process_context - reliably execute the routine with user context
3143 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003144 * @ew: guaranteed storage for the execute work structure (must
3145 * be available when the work executes)
3146 *
3147 * Executes the function immediately if process context is available,
3148 * otherwise schedules the function for delayed execution.
3149 *
3150 * Returns: 0 - function was executed
3151 * 1 - function was scheduled for execution
3152 */
David Howells65f27f32006-11-22 14:55:48 +00003153int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003154{
3155 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003156 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003157 return 0;
3158 }
3159
David Howells65f27f32006-11-22 14:55:48 +00003160 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003161 schedule_work(&ew->work);
3162
3163 return 1;
3164}
3165EXPORT_SYMBOL_GPL(execute_in_process_context);
3166
Linus Torvalds1da177e2005-04-16 15:20:36 -07003167int keventd_up(void)
3168{
Tejun Heod320c032010-06-29 10:07:14 +02003169 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170}
3171
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003172static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003173{
Oleg Nesterov3af244332007-05-09 02:34:09 -07003174 /*
Tejun Heo0f900042010-06-29 10:07:11 +02003175 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3176 * Make sure that the alignment isn't lower than that of
3177 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07003178 */
Tejun Heo0f900042010-06-29 10:07:11 +02003179 const size_t size = sizeof(struct cpu_workqueue_struct);
3180 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3181 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07003182
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003183 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003184 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02003185 else {
Tejun Heof3421792010-07-02 10:03:51 +02003186 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003187
Tejun Heof3421792010-07-02 10:03:51 +02003188 /*
3189 * Allocate enough room to align cwq and put an extra
3190 * pointer at the end pointing back to the originally
3191 * allocated pointer which will be used for free.
3192 */
3193 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3194 if (ptr) {
3195 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3196 *(void **)(wq->cpu_wq.single + 1) = ptr;
3197 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003198 }
Tejun Heof3421792010-07-02 10:03:51 +02003199
Tejun Heo0415b00d12011-03-24 18:50:09 +01003200 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003201 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3202 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003203}
3204
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003205static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003206{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003207 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003208 free_percpu(wq->cpu_wq.pcpu);
3209 else if (wq->cpu_wq.single) {
3210 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003211 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003212 }
3213}
3214
Tejun Heof3421792010-07-02 10:03:51 +02003215static int wq_clamp_max_active(int max_active, unsigned int flags,
3216 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003217{
Tejun Heof3421792010-07-02 10:03:51 +02003218 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3219
3220 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003221 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3222 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003223
Tejun Heof3421792010-07-02 10:03:51 +02003224 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003225}
3226
Tejun Heob196be82012-01-10 15:11:35 -08003227struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003228 unsigned int flags,
3229 int max_active,
3230 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003231 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003232{
Tejun Heob196be82012-01-10 15:11:35 -08003233 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003234 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003235 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08003236 size_t namelen;
3237
3238 /* determine namelen, allocate wq and format name */
3239 va_start(args, lock_name);
3240 va_copy(args1, args);
3241 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3242
3243 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3244 if (!wq)
3245 goto err;
3246
3247 vsnprintf(wq->name, namelen, fmt, args1);
3248 va_end(args);
3249 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003250
Tejun Heof3421792010-07-02 10:03:51 +02003251 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003252 * Workqueues which may be used during memory reclaim should
3253 * have a rescuer to guarantee forward progress.
3254 */
3255 if (flags & WQ_MEM_RECLAIM)
3256 flags |= WQ_RESCUER;
3257
Tejun Heod320c032010-06-29 10:07:14 +02003258 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003259 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003260
Tejun Heob196be82012-01-10 15:11:35 -08003261 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003262 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003263 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003264 mutex_init(&wq->flush_mutex);
3265 atomic_set(&wq->nr_cwqs_to_flush, 0);
3266 INIT_LIST_HEAD(&wq->flusher_queue);
3267 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003268
Johannes Bergeb13ba82008-01-16 09:51:58 +01003269 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003270 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003271
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003272 if (alloc_cwqs(wq) < 0)
3273 goto err;
3274
Tejun Heof3421792010-07-02 10:03:51 +02003275 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003276 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003277 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo32704762012-07-13 22:16:45 -07003278 int pool_idx = (bool)(flags & WQ_HIGHPRI);
Tejun Heo15376632010-06-29 10:07:11 +02003279
Tejun Heo0f900042010-06-29 10:07:11 +02003280 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo32704762012-07-13 22:16:45 -07003281 cwq->pool = &gcwq->pools[pool_idx];
Tejun Heoc34056a2010-06-29 10:07:11 +02003282 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003283 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003284 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003285 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003286 }
3287
Tejun Heoe22bee72010-06-29 10:07:14 +02003288 if (flags & WQ_RESCUER) {
3289 struct worker *rescuer;
3290
Tejun Heof2e005a2010-07-20 15:59:09 +02003291 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003292 goto err;
3293
3294 wq->rescuer = rescuer = alloc_worker();
3295 if (!rescuer)
3296 goto err;
3297
Tejun Heob196be82012-01-10 15:11:35 -08003298 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3299 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003300 if (IS_ERR(rescuer->task))
3301 goto err;
3302
Tejun Heoe22bee72010-06-29 10:07:14 +02003303 rescuer->task->flags |= PF_THREAD_BOUND;
3304 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003305 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003306
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003307 /*
3308 * workqueue_lock protects global freeze state and workqueues
3309 * list. Grab it, set max_active accordingly and add the new
3310 * workqueue to workqueues list.
3311 */
Tejun Heo15376632010-06-29 10:07:11 +02003312 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003313
Tejun Heo58a69cb2011-02-16 09:25:31 +01003314 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003315 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003316 get_cwq(cpu, wq)->max_active = 0;
3317
Tejun Heo15376632010-06-29 10:07:11 +02003318 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003319
Tejun Heo15376632010-06-29 10:07:11 +02003320 spin_unlock(&workqueue_lock);
3321
Oleg Nesterov3af244332007-05-09 02:34:09 -07003322 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003323err:
3324 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003325 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003326 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003327 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003328 kfree(wq);
3329 }
3330 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003331}
Tejun Heod320c032010-06-29 10:07:14 +02003332EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003333
3334/**
3335 * destroy_workqueue - safely terminate a workqueue
3336 * @wq: target workqueue
3337 *
3338 * Safely destroy a workqueue. All work currently pending will be done first.
3339 */
3340void destroy_workqueue(struct workqueue_struct *wq)
3341{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003342 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003343
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003344 /* drain it before proceeding with destruction */
3345 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003346
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003347 /*
3348 * wq list is used to freeze wq, remove from list after
3349 * flushing is complete in case freeze races us.
3350 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003351 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07003352 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003353 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003354
Tejun Heoe22bee72010-06-29 10:07:14 +02003355 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003356 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003357 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3358 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003359
Tejun Heo73f53c42010-06-29 10:07:11 +02003360 for (i = 0; i < WORK_NR_COLORS; i++)
3361 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003362 BUG_ON(cwq->nr_active);
3363 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003364 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003365
Tejun Heoe22bee72010-06-29 10:07:14 +02003366 if (wq->flags & WQ_RESCUER) {
3367 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003368 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003369 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003370 }
3371
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003372 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003373 kfree(wq);
3374}
3375EXPORT_SYMBOL_GPL(destroy_workqueue);
3376
Tejun Heodcd989c2010-06-29 10:07:14 +02003377/**
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003378 * cwq_set_max_active - adjust max_active of a cwq
3379 * @cwq: target cpu_workqueue_struct
3380 * @max_active: new max_active value.
3381 *
3382 * Set @cwq->max_active to @max_active and activate delayed works if
3383 * increased.
3384 *
3385 * CONTEXT:
3386 * spin_lock_irq(gcwq->lock).
3387 */
3388static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
3389{
3390 cwq->max_active = max_active;
3391
3392 while (!list_empty(&cwq->delayed_works) &&
3393 cwq->nr_active < cwq->max_active)
3394 cwq_activate_first_delayed(cwq);
3395}
3396
3397/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003398 * workqueue_set_max_active - adjust max_active of a workqueue
3399 * @wq: target workqueue
3400 * @max_active: new max_active value.
3401 *
3402 * Set max_active of @wq to @max_active.
3403 *
3404 * CONTEXT:
3405 * Don't call from IRQ context.
3406 */
3407void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3408{
3409 unsigned int cpu;
3410
Tejun Heof3421792010-07-02 10:03:51 +02003411 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003412
3413 spin_lock(&workqueue_lock);
3414
3415 wq->saved_max_active = max_active;
3416
Tejun Heof3421792010-07-02 10:03:51 +02003417 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003418 struct global_cwq *gcwq = get_gcwq(cpu);
3419
3420 spin_lock_irq(&gcwq->lock);
3421
Tejun Heo58a69cb2011-02-16 09:25:31 +01003422 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003423 !(gcwq->flags & GCWQ_FREEZING))
Lai Jiangshan70369b12012-09-19 10:40:48 -07003424 cwq_set_max_active(get_cwq(gcwq->cpu, wq), max_active);
Tejun Heodcd989c2010-06-29 10:07:14 +02003425
3426 spin_unlock_irq(&gcwq->lock);
3427 }
3428
3429 spin_unlock(&workqueue_lock);
3430}
3431EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3432
3433/**
3434 * workqueue_congested - test whether a workqueue is congested
3435 * @cpu: CPU in question
3436 * @wq: target workqueue
3437 *
3438 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3439 * no synchronization around this function and the test result is
3440 * unreliable and only useful as advisory hints or for debugging.
3441 *
3442 * RETURNS:
3443 * %true if congested, %false otherwise.
3444 */
3445bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3446{
3447 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3448
3449 return !list_empty(&cwq->delayed_works);
3450}
3451EXPORT_SYMBOL_GPL(workqueue_congested);
3452
3453/**
3454 * work_cpu - return the last known associated cpu for @work
3455 * @work: the work of interest
3456 *
3457 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003458 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003459 */
3460unsigned int work_cpu(struct work_struct *work)
3461{
3462 struct global_cwq *gcwq = get_work_gcwq(work);
3463
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003464 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003465}
3466EXPORT_SYMBOL_GPL(work_cpu);
3467
3468/**
3469 * work_busy - test whether a work is currently pending or running
3470 * @work: the work to be tested
3471 *
3472 * Test whether @work is currently pending or running. There is no
3473 * synchronization around this function and the test result is
3474 * unreliable and only useful as advisory hints or for debugging.
3475 * Especially for reentrant wqs, the pending state might hide the
3476 * running state.
3477 *
3478 * RETURNS:
3479 * OR'd bitmask of WORK_BUSY_* bits.
3480 */
3481unsigned int work_busy(struct work_struct *work)
3482{
3483 struct global_cwq *gcwq = get_work_gcwq(work);
3484 unsigned long flags;
3485 unsigned int ret = 0;
3486
3487 if (!gcwq)
3488 return false;
3489
3490 spin_lock_irqsave(&gcwq->lock, flags);
3491
3492 if (work_pending(work))
3493 ret |= WORK_BUSY_PENDING;
3494 if (find_worker_executing_work(gcwq, work))
3495 ret |= WORK_BUSY_RUNNING;
3496
3497 spin_unlock_irqrestore(&gcwq->lock, flags);
3498
3499 return ret;
3500}
3501EXPORT_SYMBOL_GPL(work_busy);
3502
Tejun Heodb7bccf2010-06-29 10:07:12 +02003503/*
3504 * CPU hotplug.
3505 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003506 * There are two challenges in supporting CPU hotplug. Firstly, there
3507 * are a lot of assumptions on strong associations among work, cwq and
3508 * gcwq which make migrating pending and scheduled works very
3509 * difficult to implement without impacting hot paths. Secondly,
3510 * gcwqs serve mix of short, long and very long running works making
3511 * blocked draining impractical.
3512 *
Tejun Heo628c78e2012-07-17 12:39:27 -07003513 * This is solved by allowing a gcwq to be disassociated from the CPU
3514 * running as an unbound one and allowing it to be reattached later if the
3515 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003516 */
3517
Tejun Heo60373152012-07-17 12:39:27 -07003518/* claim manager positions of all pools */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003519static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003520{
3521 struct worker_pool *pool;
3522
3523 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003524 mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
Tejun Heo8db25e72012-07-17 12:39:28 -07003525 spin_lock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003526}
3527
3528/* release manager positions */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003529static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003530{
3531 struct worker_pool *pool;
3532
Tejun Heo8db25e72012-07-17 12:39:28 -07003533 spin_unlock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003534 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003535 mutex_unlock(&pool->assoc_mutex);
Tejun Heo60373152012-07-17 12:39:27 -07003536}
3537
Tejun Heo628c78e2012-07-17 12:39:27 -07003538static void gcwq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003539{
Tejun Heo628c78e2012-07-17 12:39:27 -07003540 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
Tejun Heo4ce62e92012-07-13 22:16:44 -07003541 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003542 struct worker *worker;
3543 struct hlist_node *pos;
3544 int i;
3545
3546 BUG_ON(gcwq->cpu != smp_processor_id());
3547
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003548 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003549
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003550 /*
3551 * We've claimed all manager positions. Make all workers unbound
3552 * and set DISASSOCIATED. Before this, all workers except for the
3553 * ones which are still executing works from before the last CPU
3554 * down must be on the cpu. After this, they may become diasporas.
3555 */
Tejun Heo60373152012-07-17 12:39:27 -07003556 for_each_worker_pool(pool, gcwq)
Tejun Heo4ce62e92012-07-13 22:16:44 -07003557 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003558 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003559
3560 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo403c8212012-07-17 12:39:27 -07003561 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003562
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003563 gcwq->flags |= GCWQ_DISASSOCIATED;
3564
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003565 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003566
3567 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003568 * Call schedule() so that we cross rq->lock and thus can guarantee
3569 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3570 * as scheduler callbacks may be invoked from other cpus.
3571 */
3572 schedule();
3573
3574 /*
3575 * Sched callbacks are disabled now. Zap nr_running. After this,
3576 * nr_running stays zero and need_more_worker() and keep_working()
3577 * are always true as long as the worklist is not empty. @gcwq now
3578 * behaves as unbound (in terms of concurrency management) gcwq
3579 * which is served by workers tied to the CPU.
3580 *
3581 * On return from this function, the current worker would trigger
3582 * unbound chain execution of pending work items if other workers
3583 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003584 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003585 for_each_worker_pool(pool, gcwq)
3586 atomic_set(get_pool_nr_running(pool), 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003587}
3588
Tejun Heo8db25e72012-07-17 12:39:28 -07003589/*
3590 * Workqueues should be brought up before normal priority CPU notifiers.
3591 * This will be registered high priority CPU notifier.
3592 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003593static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07003594 unsigned long action,
3595 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003596{
3597 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003598 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003599 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003600
Tejun Heo8db25e72012-07-17 12:39:28 -07003601 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003602 case CPU_UP_PREPARE:
Tejun Heo4ce62e92012-07-13 22:16:44 -07003603 for_each_worker_pool(pool, gcwq) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003604 struct worker *worker;
3605
3606 if (pool->nr_workers)
3607 continue;
3608
3609 worker = create_worker(pool);
3610 if (!worker)
3611 return NOTIFY_BAD;
3612
3613 spin_lock_irq(&gcwq->lock);
3614 start_worker(worker);
3615 spin_unlock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003616 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003617 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003618
Tejun Heo65758202012-07-17 12:39:26 -07003619 case CPU_DOWN_FAILED:
3620 case CPU_ONLINE:
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003621 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003622 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3623 rebind_workers(gcwq);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003624 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003625 break;
Tejun Heo65758202012-07-17 12:39:26 -07003626 }
3627 return NOTIFY_OK;
3628}
3629
3630/*
3631 * Workqueues should be brought down after normal priority CPU notifiers.
3632 * This will be registered as low priority CPU notifier.
3633 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003634static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07003635 unsigned long action,
3636 void *hcpu)
3637{
Tejun Heo8db25e72012-07-17 12:39:28 -07003638 unsigned int cpu = (unsigned long)hcpu;
3639 struct work_struct unbind_work;
3640
Tejun Heo65758202012-07-17 12:39:26 -07003641 switch (action & ~CPU_TASKS_FROZEN) {
3642 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003643 /* unbinding should happen on the local CPU */
3644 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09003645 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07003646 flush_work(&unbind_work);
3647 break;
Tejun Heo65758202012-07-17 12:39:26 -07003648 }
3649 return NOTIFY_OK;
3650}
3651
Rusty Russell2d3854a2008-11-05 13:39:10 +11003652#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003653
Rusty Russell2d3854a2008-11-05 13:39:10 +11003654struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07003655 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003656 long (*fn)(void *);
3657 void *arg;
3658 long ret;
3659};
3660
Tejun Heoed48ece2012-09-18 12:48:43 -07003661static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003662{
Tejun Heoed48ece2012-09-18 12:48:43 -07003663 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3664
Rusty Russell2d3854a2008-11-05 13:39:10 +11003665 wfc->ret = wfc->fn(wfc->arg);
3666}
3667
3668/**
3669 * work_on_cpu - run a function in user context on a particular cpu
3670 * @cpu: the cpu to run on
3671 * @fn: the function to run
3672 * @arg: the function arg
3673 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003674 * This will return the value @fn returns.
3675 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06003676 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003677 */
3678long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3679{
Tejun Heoed48ece2012-09-18 12:48:43 -07003680 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003681
Tejun Heoed48ece2012-09-18 12:48:43 -07003682 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3683 schedule_work_on(cpu, &wfc.work);
3684 flush_work(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003685 return wfc.ret;
3686}
3687EXPORT_SYMBOL_GPL(work_on_cpu);
3688#endif /* CONFIG_SMP */
3689
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003690#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303691
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003692/**
3693 * freeze_workqueues_begin - begin freezing workqueues
3694 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003695 * Start freezing workqueues. After this function returns, all freezable
3696 * workqueues will queue new works to their frozen_works list instead of
3697 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003698 *
3699 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003700 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003701 */
3702void freeze_workqueues_begin(void)
3703{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003704 unsigned int cpu;
3705
3706 spin_lock(&workqueue_lock);
3707
3708 BUG_ON(workqueue_freezing);
3709 workqueue_freezing = true;
3710
Tejun Heof3421792010-07-02 10:03:51 +02003711 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003712 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003713 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003714
3715 spin_lock_irq(&gcwq->lock);
3716
Tejun Heodb7bccf2010-06-29 10:07:12 +02003717 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3718 gcwq->flags |= GCWQ_FREEZING;
3719
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003720 list_for_each_entry(wq, &workqueues, list) {
3721 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3722
Tejun Heo58a69cb2011-02-16 09:25:31 +01003723 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003724 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003725 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003726
3727 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003728 }
3729
3730 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003731}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003732
3733/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003734 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003735 *
3736 * Check whether freezing is complete. This function must be called
3737 * between freeze_workqueues_begin() and thaw_workqueues().
3738 *
3739 * CONTEXT:
3740 * Grabs and releases workqueue_lock.
3741 *
3742 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003743 * %true if some freezable workqueues are still busy. %false if freezing
3744 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003745 */
3746bool freeze_workqueues_busy(void)
3747{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003748 unsigned int cpu;
3749 bool busy = false;
3750
3751 spin_lock(&workqueue_lock);
3752
3753 BUG_ON(!workqueue_freezing);
3754
Tejun Heof3421792010-07-02 10:03:51 +02003755 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003756 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003757 /*
3758 * nr_active is monotonically decreasing. It's safe
3759 * to peek without lock.
3760 */
3761 list_for_each_entry(wq, &workqueues, list) {
3762 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3763
Tejun Heo58a69cb2011-02-16 09:25:31 +01003764 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003765 continue;
3766
3767 BUG_ON(cwq->nr_active < 0);
3768 if (cwq->nr_active) {
3769 busy = true;
3770 goto out_unlock;
3771 }
3772 }
3773 }
3774out_unlock:
3775 spin_unlock(&workqueue_lock);
3776 return busy;
3777}
3778
3779/**
3780 * thaw_workqueues - thaw workqueues
3781 *
3782 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003783 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003784 *
3785 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003786 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003787 */
3788void thaw_workqueues(void)
3789{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003790 unsigned int cpu;
3791
3792 spin_lock(&workqueue_lock);
3793
3794 if (!workqueue_freezing)
3795 goto out_unlock;
3796
Tejun Heof3421792010-07-02 10:03:51 +02003797 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003798 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003799 struct worker_pool *pool;
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003800 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003801
3802 spin_lock_irq(&gcwq->lock);
3803
Tejun Heodb7bccf2010-06-29 10:07:12 +02003804 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3805 gcwq->flags &= ~GCWQ_FREEZING;
3806
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003807 list_for_each_entry(wq, &workqueues, list) {
3808 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3809
Tejun Heo58a69cb2011-02-16 09:25:31 +01003810 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003811 continue;
3812
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003813 /* restore max_active and repopulate worklist */
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003814 cwq_set_max_active(cwq, wq->saved_max_active);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003815 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003816
Tejun Heo4ce62e92012-07-13 22:16:44 -07003817 for_each_worker_pool(pool, gcwq)
3818 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02003819
Tejun Heo8b03ae32010-06-29 10:07:12 +02003820 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003821 }
3822
3823 workqueue_freezing = false;
3824out_unlock:
3825 spin_unlock(&workqueue_lock);
3826}
3827#endif /* CONFIG_FREEZER */
3828
Suresh Siddha6ee05782010-07-30 14:57:37 -07003829static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003830{
Tejun Heoc34056a2010-06-29 10:07:11 +02003831 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003832 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003833
Tejun Heob5490072012-08-03 10:30:46 -07003834 /* make sure we have enough bits for OFFQ CPU number */
3835 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3836 WORK_CPU_LAST);
3837
Tejun Heo65758202012-07-17 12:39:26 -07003838 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07003839 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003840
3841 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003842 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003843 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003844 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003845
3846 spin_lock_init(&gcwq->lock);
3847 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003848 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003849
Tejun Heoc8e55f32010-06-29 10:07:12 +02003850 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3851 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3852
Tejun Heo4ce62e92012-07-13 22:16:44 -07003853 for_each_worker_pool(pool, gcwq) {
3854 pool->gcwq = gcwq;
3855 INIT_LIST_HEAD(&pool->worklist);
3856 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoe22bee72010-06-29 10:07:14 +02003857
Tejun Heo4ce62e92012-07-13 22:16:44 -07003858 init_timer_deferrable(&pool->idle_timer);
3859 pool->idle_timer.function = idle_worker_timeout;
3860 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003861
Tejun Heo4ce62e92012-07-13 22:16:44 -07003862 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3863 (unsigned long)pool);
3864
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003865 mutex_init(&pool->assoc_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003866 ida_init(&pool->worker_ida);
3867 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003868 }
3869
Tejun Heoe22bee72010-06-29 10:07:14 +02003870 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003871 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003872 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003873 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003874
Tejun Heo477a3c32010-08-31 10:54:35 +02003875 if (cpu != WORK_CPU_UNBOUND)
3876 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003877
3878 for_each_worker_pool(pool, gcwq) {
3879 struct worker *worker;
3880
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003881 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003882 BUG_ON(!worker);
3883 spin_lock_irq(&gcwq->lock);
3884 start_worker(worker);
3885 spin_unlock_irq(&gcwq->lock);
3886 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003887 }
3888
Tejun Heod320c032010-06-29 10:07:14 +02003889 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003890 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02003891 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003892 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3893 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003894 system_freezable_wq = alloc_workqueue("events_freezable",
3895 WQ_FREEZABLE, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003896 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Tejun Heoae930e02012-08-20 14:51:23 -07003897 !system_unbound_wq || !system_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003898 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003899}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003900early_initcall(init_workqueues);