blob: 41ae2c0979fef0c132a592e120d7d32e8efe763f [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 Lameter46934022006-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
61 * managership of all pools on the gcwq to avoid changing binding
62 * 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 */
Tejun Heodb7bccf2010-06-29 10:07:12 +020069
Tejun Heoc8e55f32010-06-29 10:07:12 +020070 /* worker flags */
71 WORKER_STARTED = 1 << 0, /* started */
72 WORKER_DIE = 1 << 1, /* die die die */
73 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020074 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heoe22bee72010-06-29 10:07:14 +020075 WORKER_REBIND = 1 << 5, /* mom is home, come back */
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
Tejun Heo403c8212012-07-17 12:39:27 -070079 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_REBIND | WORKER_UNBOUND |
80 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 Heo25511a42012-07-17 12:39:27 -0700128struct idle_rebind;
Tejun Heoc34056a2010-06-29 10:07:11 +0200129
Tejun Heoe22bee72010-06-29 10:07:14 +0200130/*
131 * The poor guys doing the actual heavy lifting. All on-duty workers
132 * are either serving the manager role, on idle list or on busy hash.
133 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200134struct worker {
Tejun Heoc8e55f32010-06-29 10:07:12 +0200135 /* on idle list while idle, on busy hash table while busy */
136 union {
137 struct list_head entry; /* L: while idle */
138 struct hlist_node hentry; /* L: while busy */
139 };
140
Tejun Heoc34056a2010-06-29 10:07:11 +0200141 struct work_struct *current_work; /* L: work being processed */
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200142 struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
Tejun Heoaffee4b2010-06-29 10:07:12 +0200143 struct list_head scheduled; /* L: scheduled works */
Tejun Heoc34056a2010-06-29 10:07:11 +0200144 struct task_struct *task; /* I: worker task */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700145 struct worker_pool *pool; /* I: the associated pool */
Tejun Heoe22bee72010-06-29 10:07:14 +0200146 /* 64 bytes boundary on 64bit, 32 on 32bit */
147 unsigned long last_active; /* L: last active timestamp */
148 unsigned int flags; /* X: flags */
Tejun Heoc34056a2010-06-29 10:07:11 +0200149 int id; /* I: worker id */
Tejun Heo25511a42012-07-17 12:39:27 -0700150
151 /* for rebinding worker to CPU */
152 struct idle_rebind *idle_rebind; /* L: for idle worker */
153 struct work_struct rebind_work; /* L: for busy worker */
Tejun Heoc34056a2010-06-29 10:07:11 +0200154};
155
Tejun Heobd7bdd42012-07-12 14:46:37 -0700156struct worker_pool {
157 struct global_cwq *gcwq; /* I: the owning gcwq */
Tejun Heo11ebea52012-07-12 14:46:37 -0700158 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700159
160 struct list_head worklist; /* L: list of pending works */
161 int nr_workers; /* L: total number of workers */
162 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
Tejun Heo60373152012-07-17 12:39:27 -0700168 struct mutex manager_mutex; /* mutex manager should hold */
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
Tejun Heo32704762012-07-13 22:16:45 -0700186 struct worker_pool pools[2]; /* normal and highpri pools */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200187
Tejun Heo25511a42012-07-17 12:39:27 -0700188 wait_queue_head_t rebind_hold; /* rebind hold wait */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200189} ____cacheline_aligned_in_smp;
190
191/*
Tejun Heo502ca9d2010-06-29 10:07:13 +0200192 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
Tejun Heo0f900042010-06-29 10:07:11 +0200193 * work_struct->data are used for flags and thus cwqs need to be
194 * aligned at two's power of the number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 */
196struct cpu_workqueue_struct {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700197 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200198 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200199 int work_color; /* L: current color */
200 int flush_color; /* L: flushing color */
201 int nr_in_flight[WORK_NR_COLORS];
202 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200203 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200204 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200205 struct list_head delayed_works; /* L: delayed works */
Tejun Heo0f900042010-06-29 10:07:11 +0200206};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200209 * Structure used to wait for workqueue flush.
210 */
211struct wq_flusher {
212 struct list_head list; /* F: list of flushers */
213 int flush_color; /* F: flush color waiting for */
214 struct completion done; /* flush completion */
215};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Tejun Heo73f53c42010-06-29 10:07:11 +0200217/*
Tejun Heof2e005a2010-07-20 15:59:09 +0200218 * All cpumasks are assumed to be always set on UP and thus can't be
219 * used to determine whether there's something to be done.
220 */
221#ifdef CONFIG_SMP
222typedef cpumask_var_t mayday_mask_t;
223#define mayday_test_and_set_cpu(cpu, mask) \
224 cpumask_test_and_set_cpu((cpu), (mask))
225#define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
226#define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
Tejun Heo9c375472010-08-31 11:18:34 +0200227#define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
Tejun Heof2e005a2010-07-20 15:59:09 +0200228#define free_mayday_mask(mask) free_cpumask_var((mask))
229#else
230typedef unsigned long mayday_mask_t;
231#define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
232#define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
233#define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
234#define alloc_mayday_mask(maskp, gfp) true
235#define free_mayday_mask(mask) do { } while (0)
236#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
238/*
239 * The externally visible workqueue abstraction is an array of
240 * per-CPU workqueues:
241 */
242struct workqueue_struct {
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200243 unsigned int flags; /* W: WQ_* flags */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200244 union {
245 struct cpu_workqueue_struct __percpu *pcpu;
246 struct cpu_workqueue_struct *single;
247 unsigned long v;
248 } cpu_wq; /* I: cwq's */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200249 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200250
251 struct mutex flush_mutex; /* protects wq flushing */
252 int work_color; /* F: current work color */
253 int flush_color; /* F: current flush color */
254 atomic_t nr_cwqs_to_flush; /* flush in progress */
255 struct wq_flusher *first_flusher; /* F: first flusher */
256 struct list_head flusher_queue; /* F: flush waiters */
257 struct list_head flusher_overflow; /* F: flush overflow list */
258
Tejun Heof2e005a2010-07-20 15:59:09 +0200259 mayday_mask_t mayday_mask; /* cpus requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200260 struct worker *rescuer; /* I: rescue worker */
261
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200262 int nr_drainers; /* W: drain in progress */
Tejun Heodcd989c2010-06-29 10:07:14 +0200263 int saved_max_active; /* W: saved cwq max_active */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700264#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200265 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700266#endif
Tejun Heob196be82012-01-10 15:11:35 -0800267 char name[]; /* I: workqueue name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268};
269
Tejun Heod320c032010-06-29 10:07:14 +0200270struct workqueue_struct *system_wq __read_mostly;
271struct workqueue_struct *system_long_wq __read_mostly;
272struct workqueue_struct *system_nrt_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200273struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100274struct workqueue_struct *system_freezable_wq __read_mostly;
Alan Stern62d3c542012-03-02 10:51:00 +0100275struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200276EXPORT_SYMBOL_GPL(system_wq);
277EXPORT_SYMBOL_GPL(system_long_wq);
278EXPORT_SYMBOL_GPL(system_nrt_wq);
Tejun Heof3421792010-07-02 10:03:51 +0200279EXPORT_SYMBOL_GPL(system_unbound_wq);
Tejun Heo24d51ad2011-02-21 09:52:50 +0100280EXPORT_SYMBOL_GPL(system_freezable_wq);
Alan Stern62d3c542012-03-02 10:51:00 +0100281EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200282
Tejun Heo97bd2342010-10-05 10:41:14 +0200283#define CREATE_TRACE_POINTS
284#include <trace/events/workqueue.h>
285
Tejun Heo4ce62e92012-07-13 22:16:44 -0700286#define for_each_worker_pool(pool, gcwq) \
Tejun Heo32704762012-07-13 22:16:45 -0700287 for ((pool) = &(gcwq)->pools[0]; \
288 (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700289
Tejun Heodb7bccf2010-06-29 10:07:12 +0200290#define for_each_busy_worker(worker, i, pos, gcwq) \
291 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
292 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
293
Tejun Heof3421792010-07-02 10:03:51 +0200294static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
295 unsigned int sw)
296{
297 if (cpu < nr_cpu_ids) {
298 if (sw & 1) {
299 cpu = cpumask_next(cpu, mask);
300 if (cpu < nr_cpu_ids)
301 return cpu;
302 }
303 if (sw & 2)
304 return WORK_CPU_UNBOUND;
305 }
306 return WORK_CPU_NONE;
307}
308
309static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
310 struct workqueue_struct *wq)
311{
312 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
313}
314
Tejun Heo09884952010-08-01 11:50:12 +0200315/*
316 * CPU iterators
317 *
318 * An extra gcwq is defined for an invalid cpu number
319 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
320 * specific CPU. The following iterators are similar to
321 * for_each_*_cpu() iterators but also considers the unbound gcwq.
322 *
323 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
324 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
325 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
326 * WORK_CPU_UNBOUND for unbound workqueues
327 */
Tejun Heof3421792010-07-02 10:03:51 +0200328#define for_each_gcwq_cpu(cpu) \
329 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
330 (cpu) < WORK_CPU_NONE; \
331 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
332
333#define for_each_online_gcwq_cpu(cpu) \
334 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
335 (cpu) < WORK_CPU_NONE; \
336 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
337
338#define for_each_cwq_cpu(cpu, wq) \
339 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
340 (cpu) < WORK_CPU_NONE; \
341 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
342
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900343#ifdef CONFIG_DEBUG_OBJECTS_WORK
344
345static struct debug_obj_descr work_debug_descr;
346
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100347static void *work_debug_hint(void *addr)
348{
349 return ((struct work_struct *) addr)->func;
350}
351
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900352/*
353 * fixup_init is called when:
354 * - an active object is initialized
355 */
356static int work_fixup_init(void *addr, enum debug_obj_state state)
357{
358 struct work_struct *work = addr;
359
360 switch (state) {
361 case ODEBUG_STATE_ACTIVE:
362 cancel_work_sync(work);
363 debug_object_init(work, &work_debug_descr);
364 return 1;
365 default:
366 return 0;
367 }
368}
369
370/*
371 * fixup_activate is called when:
372 * - an active object is activated
373 * - an unknown object is activated (might be a statically initialized object)
374 */
375static int work_fixup_activate(void *addr, enum debug_obj_state state)
376{
377 struct work_struct *work = addr;
378
379 switch (state) {
380
381 case ODEBUG_STATE_NOTAVAILABLE:
382 /*
383 * This is not really a fixup. The work struct was
384 * statically initialized. We just make sure that it
385 * is tracked in the object tracker.
386 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200387 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900388 debug_object_init(work, &work_debug_descr);
389 debug_object_activate(work, &work_debug_descr);
390 return 0;
391 }
392 WARN_ON_ONCE(1);
393 return 0;
394
395 case ODEBUG_STATE_ACTIVE:
396 WARN_ON(1);
397
398 default:
399 return 0;
400 }
401}
402
403/*
404 * fixup_free is called when:
405 * - an active object is freed
406 */
407static int work_fixup_free(void *addr, enum debug_obj_state state)
408{
409 struct work_struct *work = addr;
410
411 switch (state) {
412 case ODEBUG_STATE_ACTIVE:
413 cancel_work_sync(work);
414 debug_object_free(work, &work_debug_descr);
415 return 1;
416 default:
417 return 0;
418 }
419}
420
421static struct debug_obj_descr work_debug_descr = {
422 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100423 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900424 .fixup_init = work_fixup_init,
425 .fixup_activate = work_fixup_activate,
426 .fixup_free = work_fixup_free,
427};
428
429static inline void debug_work_activate(struct work_struct *work)
430{
431 debug_object_activate(work, &work_debug_descr);
432}
433
434static inline void debug_work_deactivate(struct work_struct *work)
435{
436 debug_object_deactivate(work, &work_debug_descr);
437}
438
439void __init_work(struct work_struct *work, int onstack)
440{
441 if (onstack)
442 debug_object_init_on_stack(work, &work_debug_descr);
443 else
444 debug_object_init(work, &work_debug_descr);
445}
446EXPORT_SYMBOL_GPL(__init_work);
447
448void destroy_work_on_stack(struct work_struct *work)
449{
450 debug_object_free(work, &work_debug_descr);
451}
452EXPORT_SYMBOL_GPL(destroy_work_on_stack);
453
454#else
455static inline void debug_work_activate(struct work_struct *work) { }
456static inline void debug_work_deactivate(struct work_struct *work) { }
457#endif
458
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100459/* Serializes the accesses to the list of workqueues. */
460static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200462static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Oleg Nesterov14441962007-05-23 13:57:57 -0700464/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200465 * The almighty global cpu workqueues. nr_running is the only field
466 * which is expected to be used frequently by other cpus via
467 * try_to_wake_up(). Put it in a separate cacheline.
Oleg Nesterov14441962007-05-23 13:57:57 -0700468 */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200469static DEFINE_PER_CPU(struct global_cwq, global_cwq);
Tejun Heo4ce62e92012-07-13 22:16:44 -0700470static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
Nathan Lynchf756d5e2006-01-08 01:05:12 -0800471
Tejun Heof3421792010-07-02 10:03:51 +0200472/*
473 * Global cpu workqueue and nr_running counter for unbound gcwq. The
474 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
475 * workers have WORKER_UNBOUND set.
476 */
477static struct global_cwq unbound_global_cwq;
Tejun Heo4ce62e92012-07-13 22:16:44 -0700478static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
479 [0 ... NR_WORKER_POOLS - 1] = ATOMIC_INIT(0), /* always 0 */
480};
Tejun Heof3421792010-07-02 10:03:51 +0200481
Tejun Heoc34056a2010-06-29 10:07:11 +0200482static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Tejun Heo32704762012-07-13 22:16:45 -0700484static int worker_pool_pri(struct worker_pool *pool)
485{
486 return pool - pool->gcwq->pools;
487}
488
Tejun Heo8b03ae32010-06-29 10:07:12 +0200489static struct global_cwq *get_gcwq(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490{
Tejun Heof3421792010-07-02 10:03:51 +0200491 if (cpu != WORK_CPU_UNBOUND)
492 return &per_cpu(global_cwq, cpu);
493 else
494 return &unbound_global_cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495}
496
Tejun Heo63d95a92012-07-12 14:46:37 -0700497static atomic_t *get_pool_nr_running(struct worker_pool *pool)
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700498{
Tejun Heo63d95a92012-07-12 14:46:37 -0700499 int cpu = pool->gcwq->cpu;
Tejun Heo32704762012-07-13 22:16:45 -0700500 int idx = worker_pool_pri(pool);
Tejun Heo63d95a92012-07-12 14:46:37 -0700501
Tejun Heof3421792010-07-02 10:03:51 +0200502 if (cpu != WORK_CPU_UNBOUND)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700503 return &per_cpu(pool_nr_running, cpu)[idx];
Tejun Heof3421792010-07-02 10:03:51 +0200504 else
Tejun Heo4ce62e92012-07-13 22:16:44 -0700505 return &unbound_pool_nr_running[idx];
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700506}
507
Tejun Heo4690c4a2010-06-29 10:07:10 +0200508static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
509 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700510{
Tejun Heof3421792010-07-02 10:03:51 +0200511 if (!(wq->flags & WQ_UNBOUND)) {
Lai Jiangshane06ffa12012-03-09 18:03:20 +0800512 if (likely(cpu < nr_cpu_ids))
Tejun Heof3421792010-07-02 10:03:51 +0200513 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200514 } else if (likely(cpu == WORK_CPU_UNBOUND))
515 return wq->cpu_wq.single;
516 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700517}
518
Tejun Heo73f53c42010-06-29 10:07:11 +0200519static unsigned int work_color_to_flags(int color)
520{
521 return color << WORK_STRUCT_COLOR_SHIFT;
522}
523
524static int get_work_color(struct work_struct *work)
525{
526 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
527 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
528}
529
530static int work_next_color(int color)
531{
532 return (color + 1) % WORK_NR_COLORS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533}
534
David Howells4594bf12006-12-07 11:33:26 +0000535/*
Tejun Heob5490072012-08-03 10:30:46 -0700536 * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
537 * contain the pointer to the queued cwq. Once execution starts, the flag
538 * is cleared and the high bits contain OFFQ flags and CPU number.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200539 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700540 * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
541 * and clear_work_data() can be used to set the cwq, cpu or clear
542 * work->data. These functions should only be called while the work is
543 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200544 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700545 * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
546 * a work. gcwq is available once the work has been queued anywhere after
547 * initialization until it is sync canceled. cwq is available only while
548 * the work item is queued.
549 *
550 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
551 * canceled. While being canceled, a work item may have its PENDING set
552 * but stay off timer and worklist for arbitrarily long and nobody should
553 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000554 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200555static inline void set_work_data(struct work_struct *work, unsigned long data,
556 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000557{
David Howells4594bf12006-12-07 11:33:26 +0000558 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200559 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000560}
David Howells365970a2006-11-22 14:54:49 +0000561
Tejun Heo7a22ad72010-06-29 10:07:13 +0200562static void set_work_cwq(struct work_struct *work,
563 struct cpu_workqueue_struct *cwq,
564 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200565{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200566 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200567 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200568}
569
Tejun Heo8930cab2012-08-03 10:30:45 -0700570static void set_work_cpu_and_clear_pending(struct work_struct *work,
571 unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000572{
Tejun Heob5490072012-08-03 10:30:46 -0700573 set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200574}
575
576static void clear_work_data(struct work_struct *work)
577{
578 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
579}
580
Tejun Heo7a22ad72010-06-29 10:07:13 +0200581static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
582{
Tejun Heoe1201532010-07-22 14:14:25 +0200583 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200584
Tejun Heoe1201532010-07-22 14:14:25 +0200585 if (data & WORK_STRUCT_CWQ)
586 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
587 else
588 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200589}
590
591static struct global_cwq *get_work_gcwq(struct work_struct *work)
592{
Tejun Heoe1201532010-07-22 14:14:25 +0200593 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200594 unsigned int cpu;
595
Tejun Heoe1201532010-07-22 14:14:25 +0200596 if (data & WORK_STRUCT_CWQ)
597 return ((struct cpu_workqueue_struct *)
Tejun Heobd7bdd42012-07-12 14:46:37 -0700598 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200599
Tejun Heob5490072012-08-03 10:30:46 -0700600 cpu = data >> WORK_OFFQ_CPU_SHIFT;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200601 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200602 return NULL;
603
Tejun Heof3421792010-07-02 10:03:51 +0200604 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200605 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000606}
607
Tejun Heobbb68df2012-08-03 10:30:46 -0700608static void mark_work_canceling(struct work_struct *work)
609{
610 struct global_cwq *gcwq = get_work_gcwq(work);
611 unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
612
613 set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
614 WORK_STRUCT_PENDING);
615}
616
617static bool work_is_canceling(struct work_struct *work)
618{
619 unsigned long data = atomic_long_read(&work->data);
620
621 return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
622}
623
David Howells365970a2006-11-22 14:54:49 +0000624/*
Tejun Heo32704762012-07-13 22:16:45 -0700625 * Policy functions. These define the policies on how the global worker
626 * pools are managed. Unless noted otherwise, these functions assume that
627 * they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000628 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200629
Tejun Heo63d95a92012-07-12 14:46:37 -0700630static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000631{
Tejun Heo32704762012-07-13 22:16:45 -0700632 return !atomic_read(get_pool_nr_running(pool));
David Howells365970a2006-11-22 14:54:49 +0000633}
634
Tejun Heoe22bee72010-06-29 10:07:14 +0200635/*
636 * Need to wake up a worker? Called from anything but currently
637 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700638 *
639 * Note that, because unbound workers never contribute to nr_running, this
640 * function will always return %true for unbound gcwq as long as the
641 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200642 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700643static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000644{
Tejun Heo63d95a92012-07-12 14:46:37 -0700645 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000646}
647
Tejun Heoe22bee72010-06-29 10:07:14 +0200648/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700649static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200650{
Tejun Heo63d95a92012-07-12 14:46:37 -0700651 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200652}
653
654/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700655static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200656{
Tejun Heo63d95a92012-07-12 14:46:37 -0700657 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200658
Tejun Heo32704762012-07-13 22:16:45 -0700659 return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200660}
661
662/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700663static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200664{
Tejun Heo63d95a92012-07-12 14:46:37 -0700665 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200666}
667
668/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700669static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200670{
Tejun Heo63d95a92012-07-12 14:46:37 -0700671 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700672 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200673}
674
675/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700676static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200677{
Tejun Heo60373152012-07-17 12:39:27 -0700678 bool managing = mutex_is_locked(&pool->manager_mutex);
Tejun Heo63d95a92012-07-12 14:46:37 -0700679 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
680 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200681
682 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
683}
684
685/*
686 * Wake up functions.
687 */
688
Tejun Heo7e116292010-06-29 10:07:13 +0200689/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700690static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200691{
Tejun Heo63d95a92012-07-12 14:46:37 -0700692 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200693 return NULL;
694
Tejun Heo63d95a92012-07-12 14:46:37 -0700695 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200696}
697
698/**
699 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700700 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200701 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700702 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200703 *
704 * CONTEXT:
705 * spin_lock_irq(gcwq->lock).
706 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700707static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200708{
Tejun Heo63d95a92012-07-12 14:46:37 -0700709 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200710
711 if (likely(worker))
712 wake_up_process(worker->task);
713}
714
Tejun Heo4690c4a2010-06-29 10:07:10 +0200715/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200716 * wq_worker_waking_up - a worker is waking up
717 * @task: task waking up
718 * @cpu: CPU @task is waking up to
719 *
720 * This function is called during try_to_wake_up() when a worker is
721 * being awoken.
722 *
723 * CONTEXT:
724 * spin_lock_irq(rq->lock)
725 */
726void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
727{
728 struct worker *worker = kthread_data(task);
729
Steven Rostedt2d646722010-12-03 23:12:33 -0500730 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700731 atomic_inc(get_pool_nr_running(worker->pool));
Tejun Heoe22bee72010-06-29 10:07:14 +0200732}
733
734/**
735 * wq_worker_sleeping - a worker is going to sleep
736 * @task: task going to sleep
737 * @cpu: CPU in question, must be the current CPU number
738 *
739 * This function is called during schedule() when a busy worker is
740 * going to sleep. Worker on the same cpu can be woken up by
741 * returning pointer to its task.
742 *
743 * CONTEXT:
744 * spin_lock_irq(rq->lock)
745 *
746 * RETURNS:
747 * Worker task on @cpu to wake up, %NULL if none.
748 */
749struct task_struct *wq_worker_sleeping(struct task_struct *task,
750 unsigned int cpu)
751{
752 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700753 struct worker_pool *pool = worker->pool;
Tejun Heo63d95a92012-07-12 14:46:37 -0700754 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200755
Steven Rostedt2d646722010-12-03 23:12:33 -0500756 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200757 return NULL;
758
759 /* this can only happen on the local cpu */
760 BUG_ON(cpu != raw_smp_processor_id());
761
762 /*
763 * The counterpart of the following dec_and_test, implied mb,
764 * worklist not empty test sequence is in insert_work().
765 * Please read comment there.
766 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700767 * NOT_RUNNING is clear. This means that we're bound to and
768 * running on the local cpu w/ rq lock held and preemption
769 * disabled, which in turn means that none else could be
770 * manipulating idle_list, so dereferencing idle_list without gcwq
771 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200772 */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700773 if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700774 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200775 return to_wakeup ? to_wakeup->task : NULL;
776}
777
778/**
779 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200780 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200781 * @flags: flags to set
782 * @wakeup: wakeup an idle worker if necessary
783 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200784 * Set @flags in @worker->flags and adjust nr_running accordingly. If
785 * nr_running becomes zero and @wakeup is %true, an idle worker is
786 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200787 *
Tejun Heocb444762010-07-02 10:03:50 +0200788 * CONTEXT:
789 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200790 */
791static inline void worker_set_flags(struct worker *worker, unsigned int flags,
792 bool wakeup)
793{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700794 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200795
Tejun Heocb444762010-07-02 10:03:50 +0200796 WARN_ON_ONCE(worker->task != current);
797
Tejun Heoe22bee72010-06-29 10:07:14 +0200798 /*
799 * If transitioning into NOT_RUNNING, adjust nr_running and
800 * wake up an idle worker as necessary if requested by
801 * @wakeup.
802 */
803 if ((flags & WORKER_NOT_RUNNING) &&
804 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heo63d95a92012-07-12 14:46:37 -0700805 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200806
807 if (wakeup) {
808 if (atomic_dec_and_test(nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700809 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700810 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200811 } else
812 atomic_dec(nr_running);
813 }
814
Tejun Heod302f012010-06-29 10:07:13 +0200815 worker->flags |= flags;
816}
817
818/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200819 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200820 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200821 * @flags: flags to clear
822 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200823 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200824 *
Tejun Heocb444762010-07-02 10:03:50 +0200825 * CONTEXT:
826 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200827 */
828static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
829{
Tejun Heo63d95a92012-07-12 14:46:37 -0700830 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200831 unsigned int oflags = worker->flags;
832
Tejun Heocb444762010-07-02 10:03:50 +0200833 WARN_ON_ONCE(worker->task != current);
834
Tejun Heod302f012010-06-29 10:07:13 +0200835 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200836
Tejun Heo42c025f2011-01-11 15:58:49 +0100837 /*
838 * If transitioning out of NOT_RUNNING, increment nr_running. Note
839 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
840 * of multiple flags, not a single flag.
841 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200842 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
843 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700844 atomic_inc(get_pool_nr_running(pool));
Tejun Heod302f012010-06-29 10:07:13 +0200845}
846
847/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200848 * busy_worker_head - return the busy hash head for a work
849 * @gcwq: gcwq of interest
850 * @work: work to be hashed
851 *
852 * Return hash head of @gcwq for @work.
853 *
854 * CONTEXT:
855 * spin_lock_irq(gcwq->lock).
856 *
857 * RETURNS:
858 * Pointer to the hash head.
859 */
860static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
861 struct work_struct *work)
862{
863 const int base_shift = ilog2(sizeof(struct work_struct));
864 unsigned long v = (unsigned long)work;
865
866 /* simple shift and fold hash, do we need something better? */
867 v >>= base_shift;
868 v += v >> BUSY_WORKER_HASH_ORDER;
869 v &= BUSY_WORKER_HASH_MASK;
870
871 return &gcwq->busy_hash[v];
872}
873
874/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200875 * __find_worker_executing_work - find worker which is executing a work
876 * @gcwq: gcwq of interest
877 * @bwh: hash head as returned by busy_worker_head()
878 * @work: work to find worker for
879 *
880 * Find a worker which is executing @work on @gcwq. @bwh should be
881 * the hash head obtained by calling busy_worker_head() with the same
882 * work.
883 *
884 * CONTEXT:
885 * spin_lock_irq(gcwq->lock).
886 *
887 * RETURNS:
888 * Pointer to worker which is executing @work if found, NULL
889 * otherwise.
890 */
891static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
892 struct hlist_head *bwh,
893 struct work_struct *work)
894{
895 struct worker *worker;
896 struct hlist_node *tmp;
897
898 hlist_for_each_entry(worker, tmp, bwh, hentry)
899 if (worker->current_work == work)
900 return worker;
901 return NULL;
902}
903
904/**
905 * find_worker_executing_work - find worker which is executing a work
906 * @gcwq: gcwq of interest
907 * @work: work to find worker for
908 *
909 * Find a worker which is executing @work on @gcwq. This function is
910 * identical to __find_worker_executing_work() except that this
911 * function calculates @bwh itself.
912 *
913 * CONTEXT:
914 * spin_lock_irq(gcwq->lock).
915 *
916 * RETURNS:
917 * Pointer to worker which is executing @work if found, NULL
918 * otherwise.
919 */
920static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
921 struct work_struct *work)
922{
923 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
924 work);
925}
926
927/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700928 * move_linked_works - move linked works to a list
929 * @work: start of series of works to be scheduled
930 * @head: target list to append @work to
931 * @nextp: out paramter for nested worklist walking
932 *
933 * Schedule linked works starting from @work to @head. Work series to
934 * be scheduled starts at @work and includes any consecutive work with
935 * WORK_STRUCT_LINKED set in its predecessor.
936 *
937 * If @nextp is not NULL, it's updated to point to the next work of
938 * the last scheduled work. This allows move_linked_works() to be
939 * nested inside outer list_for_each_entry_safe().
940 *
941 * CONTEXT:
942 * spin_lock_irq(gcwq->lock).
943 */
944static void move_linked_works(struct work_struct *work, struct list_head *head,
945 struct work_struct **nextp)
946{
947 struct work_struct *n;
948
949 /*
950 * Linked worklist will always end before the end of the list,
951 * use NULL for list head.
952 */
953 list_for_each_entry_safe_from(work, n, NULL, entry) {
954 list_move_tail(&work->entry, head);
955 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
956 break;
957 }
958
959 /*
960 * If we're already inside safe list traversal and have moved
961 * multiple works to the scheduled queue, the next position
962 * needs to be updated.
963 */
964 if (nextp)
965 *nextp = n;
966}
967
968static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
969{
970 struct work_struct *work = list_first_entry(&cwq->delayed_works,
971 struct work_struct, entry);
972
973 trace_workqueue_activate_work(work);
974 move_linked_works(work, &cwq->pool->worklist, NULL);
975 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
976 cwq->nr_active++;
977}
978
979/**
980 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
981 * @cwq: cwq of interest
982 * @color: color of work which left the queue
983 * @delayed: for a delayed work
984 *
985 * A work either has completed or is removed from pending queue,
986 * decrement nr_in_flight of its cwq and handle workqueue flushing.
987 *
988 * CONTEXT:
989 * spin_lock_irq(gcwq->lock).
990 */
991static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
992 bool delayed)
993{
994 /* ignore uncolored works */
995 if (color == WORK_NO_COLOR)
996 return;
997
998 cwq->nr_in_flight[color]--;
999
1000 if (!delayed) {
1001 cwq->nr_active--;
1002 if (!list_empty(&cwq->delayed_works)) {
1003 /* one down, submit a delayed one */
1004 if (cwq->nr_active < cwq->max_active)
1005 cwq_activate_first_delayed(cwq);
1006 }
1007 }
1008
1009 /* is flush in progress and are we at the flushing tip? */
1010 if (likely(cwq->flush_color != color))
1011 return;
1012
1013 /* are there still in-flight works? */
1014 if (cwq->nr_in_flight[color])
1015 return;
1016
1017 /* this cwq is done, clear flush_color */
1018 cwq->flush_color = -1;
1019
1020 /*
1021 * If this was the last cwq, wake up the first flusher. It
1022 * will handle the rest.
1023 */
1024 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1025 complete(&cwq->wq->first_flusher->done);
1026}
1027
Tejun Heo36e227d2012-08-03 10:30:46 -07001028/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001029 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001030 * @work: work item to steal
1031 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001032 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001033 *
1034 * Try to grab PENDING bit of @work. This function can handle @work in any
1035 * stable state - idle, on timer or on worklist. Return values are
1036 *
1037 * 1 if @work was pending and we successfully stole PENDING
1038 * 0 if @work was idle and we claimed PENDING
1039 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001040 * -ENOENT if someone else is canceling @work, this state may persist
1041 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001042 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001043 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
1044 * preempted while holding PENDING and @work off queue, preemption must be
1045 * disabled on entry. This ensures that we don't return -EAGAIN while
1046 * another task is preempted in this function.
1047 *
1048 * On successful return, >= 0, irq is disabled and the caller is
1049 * responsible for releasing it using local_irq_restore(*@flags).
1050 *
1051 * This function is safe to call from any context other than IRQ handler.
1052 * An IRQ handler may run on top of delayed_work_timer_fn() which can make
1053 * this function return -EAGAIN perpetually.
Tejun Heobf4ede02012-08-03 10:30:46 -07001054 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001055static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1056 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001057{
1058 struct global_cwq *gcwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001059
Tejun Heobbb68df2012-08-03 10:30:46 -07001060 WARN_ON_ONCE(in_irq());
1061
1062 local_irq_save(*flags);
1063
Tejun Heo36e227d2012-08-03 10:30:46 -07001064 /* try to steal the timer if it exists */
1065 if (is_dwork) {
1066 struct delayed_work *dwork = to_delayed_work(work);
1067
1068 if (likely(del_timer(&dwork->timer)))
1069 return 1;
1070 }
1071
1072 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001073 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1074 return 0;
1075
1076 /*
1077 * The queueing is in progress, or it is already queued. Try to
1078 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1079 */
1080 gcwq = get_work_gcwq(work);
1081 if (!gcwq)
Tejun Heobbb68df2012-08-03 10:30:46 -07001082 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001083
Tejun Heobbb68df2012-08-03 10:30:46 -07001084 spin_lock(&gcwq->lock);
Tejun Heobf4ede02012-08-03 10:30:46 -07001085 if (!list_empty(&work->entry)) {
1086 /*
1087 * This work is queued, but perhaps we locked the wrong gcwq.
1088 * In that case we must see the new value after rmb(), see
1089 * insert_work()->wmb().
1090 */
1091 smp_rmb();
1092 if (gcwq == get_work_gcwq(work)) {
1093 debug_work_deactivate(work);
1094 list_del_init(&work->entry);
1095 cwq_dec_nr_in_flight(get_work_cwq(work),
1096 get_work_color(work),
1097 *work_data_bits(work) & WORK_STRUCT_DELAYED);
Tejun Heo36e227d2012-08-03 10:30:46 -07001098
Tejun Heobbb68df2012-08-03 10:30:46 -07001099 spin_unlock(&gcwq->lock);
Tejun Heo36e227d2012-08-03 10:30:46 -07001100 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001101 }
1102 }
Tejun Heobbb68df2012-08-03 10:30:46 -07001103 spin_unlock(&gcwq->lock);
1104fail:
1105 local_irq_restore(*flags);
1106 if (work_is_canceling(work))
1107 return -ENOENT;
1108 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001109 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001110}
1111
1112/**
Tejun Heo7e116292010-06-29 10:07:13 +02001113 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +02001114 * @cwq: cwq @work belongs to
1115 * @work: work to insert
1116 * @head: insertion point
1117 * @extra_flags: extra WORK_STRUCT_* flags to set
1118 *
Tejun Heo7e116292010-06-29 10:07:13 +02001119 * Insert @work which belongs to @cwq into @gcwq after @head.
1120 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001121 *
1122 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001123 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001124 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001125static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001126 struct work_struct *work, struct list_head *head,
1127 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001128{
Tejun Heo63d95a92012-07-12 14:46:37 -07001129 struct worker_pool *pool = cwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001130
Tejun Heo4690c4a2010-06-29 10:07:10 +02001131 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001132 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001133
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001134 /*
1135 * Ensure that we get the right work->data if we see the
1136 * result of list_add() below, see try_to_grab_pending().
1137 */
1138 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001139
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001140 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001141
1142 /*
1143 * Ensure either worker_sched_deactivated() sees the above
1144 * list_add_tail() or we see zero nr_running to avoid workers
1145 * lying around lazily while there are works to be processed.
1146 */
1147 smp_mb();
1148
Tejun Heo63d95a92012-07-12 14:46:37 -07001149 if (__need_more_worker(pool))
1150 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001151}
1152
Tejun Heoc8efcc22010-12-20 19:32:04 +01001153/*
1154 * Test whether @work is being queued from another work executing on the
1155 * same workqueue. This is rather expensive and should only be used from
1156 * cold paths.
1157 */
1158static bool is_chained_work(struct workqueue_struct *wq)
1159{
1160 unsigned long flags;
1161 unsigned int cpu;
1162
1163 for_each_gcwq_cpu(cpu) {
1164 struct global_cwq *gcwq = get_gcwq(cpu);
1165 struct worker *worker;
1166 struct hlist_node *pos;
1167 int i;
1168
1169 spin_lock_irqsave(&gcwq->lock, flags);
1170 for_each_busy_worker(worker, i, pos, gcwq) {
1171 if (worker->task != current)
1172 continue;
1173 spin_unlock_irqrestore(&gcwq->lock, flags);
1174 /*
1175 * I'm @worker, no locking necessary. See if @work
1176 * is headed to the same workqueue.
1177 */
1178 return worker->current_cwq->wq == wq;
1179 }
1180 spin_unlock_irqrestore(&gcwq->lock, flags);
1181 }
1182 return false;
1183}
1184
Tejun Heo4690c4a2010-06-29 10:07:10 +02001185static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 struct work_struct *work)
1187{
Tejun Heo502ca9d2010-06-29 10:07:13 +02001188 struct global_cwq *gcwq;
1189 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001190 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001191 unsigned int work_flags;
Tejun Heo8930cab2012-08-03 10:30:45 -07001192
1193 /*
1194 * While a work item is PENDING && off queue, a task trying to
1195 * steal the PENDING will busy-loop waiting for it to either get
1196 * queued or lose PENDING. Grabbing PENDING and queueing should
1197 * happen with IRQ disabled.
1198 */
1199 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001201 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001202
Tejun Heoc8efcc22010-12-20 19:32:04 +01001203 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001204 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001205 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001206 return;
1207
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001208 /* determine gcwq to use */
1209 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001210 struct global_cwq *last_gcwq;
1211
Tejun Heo57469822012-08-03 10:30:45 -07001212 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001213 cpu = raw_smp_processor_id();
1214
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001215 /*
1216 * It's multi cpu. If @wq is non-reentrant and @work
1217 * was previously on a different cpu, it might still
1218 * be running there, in which case the work needs to
1219 * be queued on that cpu to guarantee non-reentrance.
1220 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001221 gcwq = get_gcwq(cpu);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001222 if (wq->flags & WQ_NON_REENTRANT &&
1223 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1224 struct worker *worker;
1225
Tejun Heo8930cab2012-08-03 10:30:45 -07001226 spin_lock(&last_gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001227
1228 worker = find_worker_executing_work(last_gcwq, work);
1229
1230 if (worker && worker->current_cwq->wq == wq)
1231 gcwq = last_gcwq;
1232 else {
1233 /* meh... not running there, queue here */
Tejun Heo8930cab2012-08-03 10:30:45 -07001234 spin_unlock(&last_gcwq->lock);
1235 spin_lock(&gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001236 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001237 } else {
1238 spin_lock(&gcwq->lock);
1239 }
Tejun Heof3421792010-07-02 10:03:51 +02001240 } else {
1241 gcwq = get_gcwq(WORK_CPU_UNBOUND);
Tejun Heo8930cab2012-08-03 10:30:45 -07001242 spin_lock(&gcwq->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001243 }
1244
1245 /* gcwq determined, get cwq and queue */
1246 cwq = get_cwq(gcwq->cpu, wq);
Tejun Heocdadf002010-10-05 10:49:55 +02001247 trace_workqueue_queue_work(cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001248
Dan Carpenterf5b25522012-04-13 22:06:58 +03001249 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo8930cab2012-08-03 10:30:45 -07001250 spin_unlock(&gcwq->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001251 return;
1252 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001253
Tejun Heo73f53c42010-06-29 10:07:11 +02001254 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001255 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001256
1257 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001258 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001259 cwq->nr_active++;
Tejun Heo32704762012-07-13 22:16:45 -07001260 worklist = &cwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001261 } else {
1262 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001263 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001264 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001265
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001266 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001267
Tejun Heo8930cab2012-08-03 10:30:45 -07001268 spin_unlock(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269}
1270
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001271/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001272 * queue_work_on - queue work on specific cpu
1273 * @cpu: CPU number to execute work on
1274 * @wq: workqueue to use
1275 * @work: work to queue
1276 *
Tejun Heod4283e92012-08-03 10:30:44 -07001277 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001278 *
1279 * We queue the work to a specific CPU, the caller must ensure it
1280 * can't go away.
1281 */
Tejun Heod4283e92012-08-03 10:30:44 -07001282bool queue_work_on(int cpu, struct workqueue_struct *wq,
1283 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001284{
Tejun Heod4283e92012-08-03 10:30:44 -07001285 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001286 unsigned long flags;
1287
1288 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001289
Tejun Heo22df02b2010-06-29 10:07:10 +02001290 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001291 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001292 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001293 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001294
1295 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001296 return ret;
1297}
1298EXPORT_SYMBOL_GPL(queue_work_on);
1299
Tejun Heo0a13c002012-08-03 10:30:44 -07001300/**
1301 * queue_work - queue work on a workqueue
1302 * @wq: workqueue to use
1303 * @work: work to queue
1304 *
Tejun Heod4283e92012-08-03 10:30:44 -07001305 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001306 *
1307 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1308 * it can be processed by another CPU.
1309 */
Tejun Heod4283e92012-08-03 10:30:44 -07001310bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001311{
Tejun Heo57469822012-08-03 10:30:45 -07001312 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001313}
1314EXPORT_SYMBOL_GPL(queue_work);
1315
Tejun Heod8e794d2012-08-03 10:30:45 -07001316void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317{
David Howells52bad642006-11-22 14:54:01 +00001318 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001319 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
Tejun Heo8930cab2012-08-03 10:30:45 -07001321 local_irq_disable();
Tejun Heo57469822012-08-03 10:30:45 -07001322 __queue_work(WORK_CPU_UNBOUND, cwq->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07001323 local_irq_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324}
Tejun Heod8e794d2012-08-03 10:30:45 -07001325EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001327static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1328 struct delayed_work *dwork, unsigned long delay)
1329{
1330 struct timer_list *timer = &dwork->timer;
1331 struct work_struct *work = &dwork->work;
1332 unsigned int lcpu;
1333
1334 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1335 timer->data != (unsigned long)dwork);
1336 BUG_ON(timer_pending(timer));
1337 BUG_ON(!list_empty(&work->entry));
1338
1339 timer_stats_timer_set_start_info(&dwork->timer);
1340
1341 /*
1342 * This stores cwq for the moment, for the timer_fn. Note that the
1343 * work's gcwq is preserved to allow reentrance detection for
1344 * delayed works.
1345 */
1346 if (!(wq->flags & WQ_UNBOUND)) {
1347 struct global_cwq *gcwq = get_work_gcwq(work);
1348
1349 if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1350 lcpu = gcwq->cpu;
1351 else
1352 lcpu = raw_smp_processor_id();
1353 } else {
1354 lcpu = WORK_CPU_UNBOUND;
1355 }
1356
1357 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1358
1359 timer->expires = jiffies + delay;
1360
1361 if (unlikely(cpu != WORK_CPU_UNBOUND))
1362 add_timer_on(timer, cpu);
1363 else
1364 add_timer(timer);
1365}
1366
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001367/**
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001368 * queue_delayed_work_on - queue work on specific CPU after delay
1369 * @cpu: CPU number to execute work on
1370 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001371 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001372 * @delay: number of jiffies to wait before queueing
1373 *
Tejun Heo715f1302012-08-03 10:30:46 -07001374 * Returns %false if @work was already on a queue, %true otherwise. If
1375 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1376 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001377 */
Tejun Heod4283e92012-08-03 10:30:44 -07001378bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1379 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001380{
David Howells52bad642006-11-22 14:54:01 +00001381 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001382 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001383 unsigned long flags;
1384
Tejun Heo715f1302012-08-03 10:30:46 -07001385 if (!delay)
1386 return queue_work_on(cpu, wq, &dwork->work);
1387
Tejun Heo8930cab2012-08-03 10:30:45 -07001388 /* read the comment in __queue_work() */
1389 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001390
Tejun Heo22df02b2010-06-29 10:07:10 +02001391 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001392 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001393 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001394 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001395
1396 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001397 return ret;
1398}
Dave Jonesae90dd52006-06-30 01:40:45 -04001399EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
Tejun Heoc8e55f32010-06-29 10:07:12 +02001401/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001402 * queue_delayed_work - queue work on a workqueue after delay
1403 * @wq: workqueue to use
1404 * @dwork: delayable work to queue
1405 * @delay: number of jiffies to wait before queueing
1406 *
Tejun Heo715f1302012-08-03 10:30:46 -07001407 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001408 */
Tejun Heod4283e92012-08-03 10:30:44 -07001409bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001410 struct delayed_work *dwork, unsigned long delay)
1411{
Tejun Heo57469822012-08-03 10:30:45 -07001412 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001413}
1414EXPORT_SYMBOL_GPL(queue_delayed_work);
1415
1416/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001417 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1418 * @cpu: CPU number to execute work on
1419 * @wq: workqueue to use
1420 * @dwork: work to queue
1421 * @delay: number of jiffies to wait before queueing
1422 *
1423 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1424 * modify @dwork's timer so that it expires after @delay. If @delay is
1425 * zero, @work is guaranteed to be scheduled immediately regardless of its
1426 * current state.
1427 *
1428 * Returns %false if @dwork was idle and queued, %true if @dwork was
1429 * pending and its timer was modified.
1430 *
1431 * This function is safe to call from any context other than IRQ handler.
1432 * See try_to_grab_pending() for details.
1433 */
1434bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1435 struct delayed_work *dwork, unsigned long delay)
1436{
1437 unsigned long flags;
1438 int ret;
1439
1440 do {
1441 ret = try_to_grab_pending(&dwork->work, true, &flags);
1442 } while (unlikely(ret == -EAGAIN));
1443
1444 if (likely(ret >= 0)) {
1445 __queue_delayed_work(cpu, wq, dwork, delay);
1446 local_irq_restore(flags);
1447 }
1448
1449 /* -ENOENT from try_to_grab_pending() becomes %true */
1450 return ret;
1451}
1452EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1453
1454/**
1455 * mod_delayed_work - modify delay of or queue a delayed work
1456 * @wq: workqueue to use
1457 * @dwork: work to queue
1458 * @delay: number of jiffies to wait before queueing
1459 *
1460 * mod_delayed_work_on() on local CPU.
1461 */
1462bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1463 unsigned long delay)
1464{
1465 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1466}
1467EXPORT_SYMBOL_GPL(mod_delayed_work);
1468
1469/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001470 * worker_enter_idle - enter idle state
1471 * @worker: worker which is entering idle state
1472 *
1473 * @worker is entering idle state. Update stats and idle timer if
1474 * necessary.
1475 *
1476 * LOCKING:
1477 * spin_lock_irq(gcwq->lock).
1478 */
1479static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001481 struct worker_pool *pool = worker->pool;
1482 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483
Tejun Heoc8e55f32010-06-29 10:07:12 +02001484 BUG_ON(worker->flags & WORKER_IDLE);
1485 BUG_ON(!list_empty(&worker->entry) &&
1486 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487
Tejun Heocb444762010-07-02 10:03:50 +02001488 /* can't use worker_set_flags(), also called from start_worker() */
1489 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001490 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001491 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001492
Tejun Heoc8e55f32010-06-29 10:07:12 +02001493 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001494 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001495
Tejun Heo628c78e2012-07-17 12:39:27 -07001496 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1497 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001498
Tejun Heo544ecf32012-05-14 15:04:50 -07001499 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07001500 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1501 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1502 * nr_running, the warning may trigger spuriously. Check iff
1503 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001504 */
Tejun Heo628c78e2012-07-17 12:39:27 -07001505 WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001506 pool->nr_workers == pool->nr_idle &&
Tejun Heo63d95a92012-07-12 14:46:37 -07001507 atomic_read(get_pool_nr_running(pool)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508}
1509
Tejun Heoc8e55f32010-06-29 10:07:12 +02001510/**
1511 * worker_leave_idle - leave idle state
1512 * @worker: worker which is leaving idle state
1513 *
1514 * @worker is leaving idle state. Update stats.
1515 *
1516 * LOCKING:
1517 * spin_lock_irq(gcwq->lock).
1518 */
1519static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001521 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522
Tejun Heoc8e55f32010-06-29 10:07:12 +02001523 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001524 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001525 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001526 list_del_init(&worker->entry);
1527}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
Tejun Heoe22bee72010-06-29 10:07:14 +02001529/**
1530 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1531 * @worker: self
1532 *
1533 * Works which are scheduled while the cpu is online must at least be
1534 * scheduled to a worker which is bound to the cpu so that if they are
1535 * flushed from cpu callbacks while cpu is going down, they are
1536 * guaranteed to execute on the cpu.
1537 *
1538 * This function is to be used by rogue workers and rescuers to bind
1539 * themselves to the target cpu and may race with cpu going down or
1540 * coming online. kthread_bind() can't be used because it may put the
1541 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1542 * verbatim as it's best effort and blocking and gcwq may be
1543 * [dis]associated in the meantime.
1544 *
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001545 * This function tries set_cpus_allowed() and locks gcwq and verifies the
1546 * binding against %GCWQ_DISASSOCIATED which is set during
1547 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1548 * enters idle state or fetches works without dropping lock, it can
1549 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001550 *
1551 * CONTEXT:
1552 * Might sleep. Called without any lock but returns with gcwq->lock
1553 * held.
1554 *
1555 * RETURNS:
1556 * %true if the associated gcwq is online (@worker is successfully
1557 * bound), %false if offline.
1558 */
1559static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001560__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001561{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001562 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001563 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
Tejun Heoe22bee72010-06-29 10:07:14 +02001565 while (true) {
1566 /*
1567 * The following call may fail, succeed or succeed
1568 * without actually migrating the task to the cpu if
1569 * it races with cpu hotunplug operation. Verify
1570 * against GCWQ_DISASSOCIATED.
1571 */
Tejun Heof3421792010-07-02 10:03:51 +02001572 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1573 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001574
Tejun Heoe22bee72010-06-29 10:07:14 +02001575 spin_lock_irq(&gcwq->lock);
1576 if (gcwq->flags & GCWQ_DISASSOCIATED)
1577 return false;
1578 if (task_cpu(task) == gcwq->cpu &&
1579 cpumask_equal(&current->cpus_allowed,
1580 get_cpu_mask(gcwq->cpu)))
1581 return true;
1582 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001583
Tejun Heo5035b202011-04-29 18:08:37 +02001584 /*
1585 * We've raced with CPU hot[un]plug. Give it a breather
1586 * and retry migration. cond_resched() is required here;
1587 * otherwise, we might deadlock against cpu_stop trying to
1588 * bring down the CPU on non-preemptive kernel.
1589 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001590 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001591 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001592 }
1593}
1594
Tejun Heo25511a42012-07-17 12:39:27 -07001595struct idle_rebind {
1596 int cnt; /* # workers to be rebound */
1597 struct completion done; /* all workers rebound */
1598};
1599
Tejun Heoe22bee72010-06-29 10:07:14 +02001600/*
Tejun Heo25511a42012-07-17 12:39:27 -07001601 * Rebind an idle @worker to its CPU. During CPU onlining, this has to
1602 * happen synchronously for idle workers. worker_thread() will test
1603 * %WORKER_REBIND before leaving idle and call this function.
1604 */
1605static void idle_worker_rebind(struct worker *worker)
1606{
1607 struct global_cwq *gcwq = worker->pool->gcwq;
1608
1609 /* CPU must be online at this point */
1610 WARN_ON(!worker_maybe_bind_and_lock(worker));
1611 if (!--worker->idle_rebind->cnt)
1612 complete(&worker->idle_rebind->done);
1613 spin_unlock_irq(&worker->pool->gcwq->lock);
1614
1615 /* we did our part, wait for rebind_workers() to finish up */
1616 wait_event(gcwq->rebind_hold, !(worker->flags & WORKER_REBIND));
1617}
1618
1619/*
1620 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001621 * the associated cpu which is coming back online. This is scheduled by
1622 * cpu up but can race with other cpu hotplug operations and may be
1623 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001624 */
Tejun Heo25511a42012-07-17 12:39:27 -07001625static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001626{
1627 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001628 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001629
1630 if (worker_maybe_bind_and_lock(worker))
1631 worker_clr_flags(worker, WORKER_REBIND);
1632
1633 spin_unlock_irq(&gcwq->lock);
1634}
1635
Tejun Heo25511a42012-07-17 12:39:27 -07001636/**
1637 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1638 * @gcwq: gcwq of interest
1639 *
1640 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1641 * is different for idle and busy ones.
1642 *
1643 * The idle ones should be rebound synchronously and idle rebinding should
1644 * be complete before any worker starts executing work items with
1645 * concurrency management enabled; otherwise, scheduler may oops trying to
1646 * wake up non-local idle worker from wq_worker_sleeping().
1647 *
1648 * This is achieved by repeatedly requesting rebinding until all idle
1649 * workers are known to have been rebound under @gcwq->lock and holding all
1650 * idle workers from becoming busy until idle rebinding is complete.
1651 *
1652 * Once idle workers are rebound, busy workers can be rebound as they
1653 * finish executing their current work items. Queueing the rebind work at
1654 * the head of their scheduled lists is enough. Note that nr_running will
1655 * be properbly bumped as busy workers rebind.
1656 *
1657 * On return, all workers are guaranteed to either be bound or have rebind
1658 * work item scheduled.
1659 */
1660static void rebind_workers(struct global_cwq *gcwq)
1661 __releases(&gcwq->lock) __acquires(&gcwq->lock)
1662{
1663 struct idle_rebind idle_rebind;
1664 struct worker_pool *pool;
1665 struct worker *worker;
1666 struct hlist_node *pos;
1667 int i;
1668
1669 lockdep_assert_held(&gcwq->lock);
1670
1671 for_each_worker_pool(pool, gcwq)
1672 lockdep_assert_held(&pool->manager_mutex);
1673
1674 /*
1675 * Rebind idle workers. Interlocked both ways. We wait for
1676 * workers to rebind via @idle_rebind.done. Workers will wait for
1677 * us to finish up by watching %WORKER_REBIND.
1678 */
1679 init_completion(&idle_rebind.done);
1680retry:
1681 idle_rebind.cnt = 1;
1682 INIT_COMPLETION(idle_rebind.done);
1683
1684 /* set REBIND and kick idle ones, we'll wait for these later */
1685 for_each_worker_pool(pool, gcwq) {
1686 list_for_each_entry(worker, &pool->idle_list, entry) {
1687 if (worker->flags & WORKER_REBIND)
1688 continue;
1689
1690 /* morph UNBOUND to REBIND */
1691 worker->flags &= ~WORKER_UNBOUND;
1692 worker->flags |= WORKER_REBIND;
1693
1694 idle_rebind.cnt++;
1695 worker->idle_rebind = &idle_rebind;
1696
1697 /* worker_thread() will call idle_worker_rebind() */
1698 wake_up_process(worker->task);
1699 }
1700 }
1701
1702 if (--idle_rebind.cnt) {
1703 spin_unlock_irq(&gcwq->lock);
1704 wait_for_completion(&idle_rebind.done);
1705 spin_lock_irq(&gcwq->lock);
1706 /* busy ones might have become idle while waiting, retry */
1707 goto retry;
1708 }
1709
1710 /*
1711 * All idle workers are rebound and waiting for %WORKER_REBIND to
1712 * be cleared inside idle_worker_rebind(). Clear and release.
1713 * Clearing %WORKER_REBIND from this foreign context is safe
1714 * because these workers are still guaranteed to be idle.
1715 */
1716 for_each_worker_pool(pool, gcwq)
1717 list_for_each_entry(worker, &pool->idle_list, entry)
1718 worker->flags &= ~WORKER_REBIND;
1719
1720 wake_up_all(&gcwq->rebind_hold);
1721
1722 /* rebind busy workers */
1723 for_each_busy_worker(worker, i, pos, gcwq) {
1724 struct work_struct *rebind_work = &worker->rebind_work;
1725
1726 /* morph UNBOUND to REBIND */
1727 worker->flags &= ~WORKER_UNBOUND;
1728 worker->flags |= WORKER_REBIND;
1729
1730 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1731 work_data_bits(rebind_work)))
1732 continue;
1733
1734 /* wq doesn't matter, use the default one */
1735 debug_work_activate(rebind_work);
1736 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
1737 worker->scheduled.next,
1738 work_color_to_flags(WORK_NO_COLOR));
1739 }
1740}
1741
Tejun Heoc34056a2010-06-29 10:07:11 +02001742static struct worker *alloc_worker(void)
1743{
1744 struct worker *worker;
1745
1746 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001747 if (worker) {
1748 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001749 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001750 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001751 /* on creation a worker is in !idle && prep state */
1752 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001753 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001754 return worker;
1755}
1756
1757/**
1758 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001759 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001760 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001761 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001762 * can be started by calling start_worker() or destroyed using
1763 * destroy_worker().
1764 *
1765 * CONTEXT:
1766 * Might sleep. Does GFP_KERNEL allocations.
1767 *
1768 * RETURNS:
1769 * Pointer to the newly created worker.
1770 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001771static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001772{
Tejun Heo63d95a92012-07-12 14:46:37 -07001773 struct global_cwq *gcwq = pool->gcwq;
Tejun Heo32704762012-07-13 22:16:45 -07001774 const char *pri = worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001775 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001776 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001777
Tejun Heo8b03ae32010-06-29 10:07:12 +02001778 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001779 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001780 spin_unlock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001781 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001782 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001783 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001784 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001785 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001786
1787 worker = alloc_worker();
1788 if (!worker)
1789 goto fail;
1790
Tejun Heobd7bdd42012-07-12 14:46:37 -07001791 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001792 worker->id = id;
1793
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001794 if (gcwq->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001795 worker->task = kthread_create_on_node(worker_thread,
Tejun Heo32704762012-07-13 22:16:45 -07001796 worker, cpu_to_node(gcwq->cpu),
1797 "kworker/%u:%d%s", gcwq->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001798 else
1799 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001800 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001801 if (IS_ERR(worker->task))
1802 goto fail;
1803
Tejun Heo32704762012-07-13 22:16:45 -07001804 if (worker_pool_pri(pool))
1805 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1806
Tejun Heodb7bccf2010-06-29 10:07:12 +02001807 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001808 * Determine CPU binding of the new worker depending on
1809 * %GCWQ_DISASSOCIATED. The caller is responsible for ensuring the
1810 * flag remains stable across this function. See the comments
1811 * above the flag definition for details.
1812 *
1813 * As an unbound worker may later become a regular one if CPU comes
1814 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001815 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001816 if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001817 kthread_bind(worker->task, gcwq->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001818 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001819 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001820 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001822
Tejun Heoc34056a2010-06-29 10:07:11 +02001823 return worker;
1824fail:
1825 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001826 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001827 ida_remove(&pool->worker_ida, id);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001828 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001829 }
1830 kfree(worker);
1831 return NULL;
1832}
1833
1834/**
1835 * start_worker - start a newly created worker
1836 * @worker: worker to start
1837 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001838 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001839 *
1840 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001841 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001842 */
1843static void start_worker(struct worker *worker)
1844{
Tejun Heocb444762010-07-02 10:03:50 +02001845 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001846 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001847 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001848 wake_up_process(worker->task);
1849}
1850
1851/**
1852 * destroy_worker - destroy a workqueue worker
1853 * @worker: worker to be destroyed
1854 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001855 * Destroy @worker and adjust @gcwq stats accordingly.
1856 *
1857 * CONTEXT:
1858 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001859 */
1860static void destroy_worker(struct worker *worker)
1861{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001862 struct worker_pool *pool = worker->pool;
1863 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001864 int id = worker->id;
1865
1866 /* sanity check frenzy */
1867 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001868 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001869
Tejun Heoc8e55f32010-06-29 10:07:12 +02001870 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001871 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001872 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001873 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001874
1875 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001876 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001877
1878 spin_unlock_irq(&gcwq->lock);
1879
Tejun Heoc34056a2010-06-29 10:07:11 +02001880 kthread_stop(worker->task);
1881 kfree(worker);
1882
Tejun Heo8b03ae32010-06-29 10:07:12 +02001883 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001884 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001885}
1886
Tejun Heo63d95a92012-07-12 14:46:37 -07001887static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001888{
Tejun Heo63d95a92012-07-12 14:46:37 -07001889 struct worker_pool *pool = (void *)__pool;
1890 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001891
1892 spin_lock_irq(&gcwq->lock);
1893
Tejun Heo63d95a92012-07-12 14:46:37 -07001894 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001895 struct worker *worker;
1896 unsigned long expires;
1897
1898 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001899 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001900 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1901
1902 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001903 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001904 else {
1905 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001906 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001907 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001908 }
1909 }
1910
1911 spin_unlock_irq(&gcwq->lock);
1912}
1913
1914static bool send_mayday(struct work_struct *work)
1915{
1916 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1917 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001918 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001919
1920 if (!(wq->flags & WQ_RESCUER))
1921 return false;
1922
1923 /* mayday mayday mayday */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001924 cpu = cwq->pool->gcwq->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001925 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1926 if (cpu == WORK_CPU_UNBOUND)
1927 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001928 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001929 wake_up_process(wq->rescuer->task);
1930 return true;
1931}
1932
Tejun Heo63d95a92012-07-12 14:46:37 -07001933static void gcwq_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001934{
Tejun Heo63d95a92012-07-12 14:46:37 -07001935 struct worker_pool *pool = (void *)__pool;
1936 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001937 struct work_struct *work;
1938
1939 spin_lock_irq(&gcwq->lock);
1940
Tejun Heo63d95a92012-07-12 14:46:37 -07001941 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001942 /*
1943 * We've been trying to create a new worker but
1944 * haven't been successful. We might be hitting an
1945 * allocation deadlock. Send distress signals to
1946 * rescuers.
1947 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001948 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001949 send_mayday(work);
1950 }
1951
1952 spin_unlock_irq(&gcwq->lock);
1953
Tejun Heo63d95a92012-07-12 14:46:37 -07001954 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001955}
1956
1957/**
1958 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001959 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001960 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001961 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001962 * have at least one idle worker on return from this function. If
1963 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001964 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001965 * possible allocation deadlock.
1966 *
1967 * On return, need_to_create_worker() is guaranteed to be false and
1968 * may_start_working() true.
1969 *
1970 * LOCKING:
1971 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1972 * multiple times. Does GFP_KERNEL allocations. Called only from
1973 * manager.
1974 *
1975 * RETURNS:
1976 * false if no action was taken and gcwq->lock stayed locked, true
1977 * otherwise.
1978 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001979static bool maybe_create_worker(struct worker_pool *pool)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001980__releases(&gcwq->lock)
1981__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001982{
Tejun Heo63d95a92012-07-12 14:46:37 -07001983 struct global_cwq *gcwq = pool->gcwq;
1984
1985 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001986 return false;
1987restart:
Tejun Heo9f9c2362010-07-14 11:31:20 +02001988 spin_unlock_irq(&gcwq->lock);
1989
Tejun Heoe22bee72010-06-29 10:07:14 +02001990 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001991 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001992
1993 while (true) {
1994 struct worker *worker;
1995
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001996 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001998 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001999 spin_lock_irq(&gcwq->lock);
2000 start_worker(worker);
Tejun Heo63d95a92012-07-12 14:46:37 -07002001 BUG_ON(need_to_create_worker(pool));
Tejun Heoe22bee72010-06-29 10:07:14 +02002002 return true;
2003 }
2004
Tejun Heo63d95a92012-07-12 14:46:37 -07002005 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002006 break;
2007
Tejun Heoe22bee72010-06-29 10:07:14 +02002008 __set_current_state(TASK_INTERRUPTIBLE);
2009 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02002010
Tejun Heo63d95a92012-07-12 14:46:37 -07002011 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002012 break;
2013 }
2014
Tejun Heo63d95a92012-07-12 14:46:37 -07002015 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002016 spin_lock_irq(&gcwq->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07002017 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002018 goto restart;
2019 return true;
2020}
2021
2022/**
2023 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07002024 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02002025 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002026 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02002027 * IDLE_WORKER_TIMEOUT.
2028 *
2029 * LOCKING:
2030 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2031 * multiple times. Called only from manager.
2032 *
2033 * RETURNS:
2034 * false if no action was taken and gcwq->lock stayed locked, true
2035 * otherwise.
2036 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002037static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02002038{
2039 bool ret = false;
2040
Tejun Heo63d95a92012-07-12 14:46:37 -07002041 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002042 struct worker *worker;
2043 unsigned long expires;
2044
Tejun Heo63d95a92012-07-12 14:46:37 -07002045 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002046 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2047
2048 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002049 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002050 break;
2051 }
2052
2053 destroy_worker(worker);
2054 ret = true;
2055 }
2056
2057 return ret;
2058}
2059
2060/**
2061 * manage_workers - manage worker pool
2062 * @worker: self
2063 *
2064 * Assume the manager role and manage gcwq worker pool @worker belongs
2065 * to. At any given time, there can be only zero or one manager per
2066 * gcwq. The exclusion is handled automatically by this function.
2067 *
2068 * The caller can safely start processing works on false return. On
2069 * true return, it's guaranteed that need_to_create_worker() is false
2070 * and may_start_working() is true.
2071 *
2072 * CONTEXT:
2073 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2074 * multiple times. Does GFP_KERNEL allocations.
2075 *
2076 * RETURNS:
2077 * false if no action was taken and gcwq->lock stayed locked, true if
2078 * some action was taken.
2079 */
2080static bool manage_workers(struct worker *worker)
2081{
Tejun Heo63d95a92012-07-12 14:46:37 -07002082 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002083 bool ret = false;
2084
Tejun Heo60373152012-07-17 12:39:27 -07002085 if (!mutex_trylock(&pool->manager_mutex))
Tejun Heoe22bee72010-06-29 10:07:14 +02002086 return ret;
2087
Tejun Heo11ebea52012-07-12 14:46:37 -07002088 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002089
2090 /*
2091 * Destroy and then create so that may_start_working() is true
2092 * on return.
2093 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002094 ret |= maybe_destroy_workers(pool);
2095 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002096
Tejun Heo60373152012-07-17 12:39:27 -07002097 mutex_unlock(&pool->manager_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002098 return ret;
2099}
2100
Tejun Heoa62428c2010-06-29 10:07:10 +02002101/**
2102 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002103 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002104 * @work: work to process
2105 *
2106 * Process @work. This function contains all the logics necessary to
2107 * process a single work including synchronization against and
2108 * interaction with other workers on the same cpu, queueing and
2109 * flushing. As long as context requirement is met, any worker can
2110 * call this function to process a work.
2111 *
2112 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002113 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002114 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002115static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09002116__releases(&gcwq->lock)
2117__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002118{
Tejun Heo7e116292010-06-29 10:07:13 +02002119 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002120 struct worker_pool *pool = worker->pool;
2121 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002122 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002123 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02002124 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02002125 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002126 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002127#ifdef CONFIG_LOCKDEP
2128 /*
2129 * It is permissible to free the struct work_struct from
2130 * inside the function that is called from it, this we need to
2131 * take into account for lockdep too. To avoid bogus "held
2132 * lock freed" warnings as well as problems when looking into
2133 * work->lockdep_map, make a copy and use that here.
2134 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002135 struct lockdep_map lockdep_map;
2136
2137 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002138#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002139 /*
2140 * Ensure we're on the correct CPU. DISASSOCIATED test is
2141 * necessary to avoid spurious warnings from rescuers servicing the
2142 * unbound or a disassociated gcwq.
2143 */
Tejun Heo25511a42012-07-17 12:39:27 -07002144 WARN_ON_ONCE(!(worker->flags & (WORKER_UNBOUND | WORKER_REBIND)) &&
Tejun Heo6fec10a2012-07-22 10:16:34 -07002145 !(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heo25511a42012-07-17 12:39:27 -07002146 raw_smp_processor_id() != gcwq->cpu);
2147
Tejun Heo7e116292010-06-29 10:07:13 +02002148 /*
2149 * A single work shouldn't be executed concurrently by
2150 * multiple workers on a single cpu. Check whether anyone is
2151 * already processing the work. If so, defer the work to the
2152 * currently executing one.
2153 */
2154 collision = __find_worker_executing_work(gcwq, bwh, work);
2155 if (unlikely(collision)) {
2156 move_linked_works(work, &collision->scheduled, NULL);
2157 return;
2158 }
2159
Tejun Heo8930cab2012-08-03 10:30:45 -07002160 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002161 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002162 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02002163 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002164 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002165 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002166
Tejun Heoa62428c2010-06-29 10:07:10 +02002167 list_del_init(&work->entry);
2168
Tejun Heo649027d2010-06-29 10:07:14 +02002169 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002170 * CPU intensive works don't participate in concurrency
2171 * management. They're the scheduler's responsibility.
2172 */
2173 if (unlikely(cpu_intensive))
2174 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2175
Tejun Heo974271c2012-07-12 14:46:37 -07002176 /*
2177 * Unbound gcwq isn't concurrency managed and work items should be
2178 * executed ASAP. Wake up another worker if necessary.
2179 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002180 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2181 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002182
Tejun Heo8930cab2012-08-03 10:30:45 -07002183 /*
2184 * Record the last CPU and clear PENDING. The following wmb is
2185 * paired with the implied mb in test_and_set_bit(PENDING) and
2186 * ensures all updates to @work made here are visible to and
2187 * precede any updates by the next PENDING owner. Also, clear
2188 * PENDING inside @gcwq->lock so that PENDING and queued state
2189 * changes happen together while IRQ is disabled.
2190 */
2191 smp_wmb();
2192 set_work_cpu_and_clear_pending(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02002193
Tejun Heo8930cab2012-08-03 10:30:45 -07002194 spin_unlock_irq(&gcwq->lock);
Tejun Heo959d1af2012-08-03 10:30:45 -07002195
Tejun Heoe1594892011-01-09 23:32:15 +01002196 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002197 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002198 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002199 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002200 /*
2201 * While we must be careful to not use "work" after this, the trace
2202 * point will only record its address.
2203 */
2204 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002205 lock_map_release(&lockdep_map);
2206 lock_map_release(&cwq->wq->lockdep_map);
2207
2208 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2209 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
2210 "%s/0x%08x/%d\n",
2211 current->comm, preempt_count(), task_pid_nr(current));
2212 printk(KERN_ERR " last function: ");
2213 print_symbol("%s\n", (unsigned long)f);
2214 debug_show_held_locks(current);
2215 dump_stack();
2216 }
2217
Tejun Heo8b03ae32010-06-29 10:07:12 +02002218 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002219
Tejun Heofb0e7be2010-06-29 10:07:15 +02002220 /* clear cpu intensive status */
2221 if (unlikely(cpu_intensive))
2222 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2223
Tejun Heoa62428c2010-06-29 10:07:10 +02002224 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02002225 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002226 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002227 worker->current_cwq = NULL;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02002228 cwq_dec_nr_in_flight(cwq, work_color, false);
Tejun Heoa62428c2010-06-29 10:07:10 +02002229}
2230
Tejun Heoaffee4b2010-06-29 10:07:12 +02002231/**
2232 * process_scheduled_works - process scheduled works
2233 * @worker: self
2234 *
2235 * Process all scheduled works. Please note that the scheduled list
2236 * may change while processing a work, so this function repeatedly
2237 * fetches a work from the top and executes it.
2238 *
2239 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002240 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002241 * multiple times.
2242 */
2243static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002245 while (!list_empty(&worker->scheduled)) {
2246 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002248 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250}
2251
Tejun Heo4690c4a2010-06-29 10:07:10 +02002252/**
2253 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002254 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002255 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002256 * The gcwq worker thread function. There's a single dynamic pool of
2257 * these per each cpu. These workers process all works regardless of
2258 * their specific target workqueue. The only exception is works which
2259 * belong to workqueues with a rescuer which will be explained in
2260 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002261 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002262static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263{
Tejun Heoc34056a2010-06-29 10:07:11 +02002264 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002265 struct worker_pool *pool = worker->pool;
2266 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267
Tejun Heoe22bee72010-06-29 10:07:14 +02002268 /* tell the scheduler that this is a workqueue worker */
2269 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002270woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002271 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272
Tejun Heo25511a42012-07-17 12:39:27 -07002273 /*
2274 * DIE can be set only while idle and REBIND set while busy has
2275 * @worker->rebind_work scheduled. Checking here is enough.
2276 */
2277 if (unlikely(worker->flags & (WORKER_REBIND | WORKER_DIE))) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002278 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002279
2280 if (worker->flags & WORKER_DIE) {
2281 worker->task->flags &= ~PF_WQ_WORKER;
2282 return 0;
2283 }
2284
2285 idle_worker_rebind(worker);
2286 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 }
2288
Tejun Heoc8e55f32010-06-29 10:07:12 +02002289 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002290recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002291 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002292 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002293 goto sleep;
2294
2295 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002296 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002297 goto recheck;
2298
Tejun Heoc8e55f32010-06-29 10:07:12 +02002299 /*
2300 * ->scheduled list can only be filled while a worker is
2301 * preparing to process a work or actually processing it.
2302 * Make sure nobody diddled with it while I was sleeping.
2303 */
2304 BUG_ON(!list_empty(&worker->scheduled));
2305
Tejun Heoe22bee72010-06-29 10:07:14 +02002306 /*
2307 * When control reaches this point, we're guaranteed to have
2308 * at least one idle worker or that someone else has already
2309 * assumed the manager role.
2310 */
2311 worker_clr_flags(worker, WORKER_PREP);
2312
2313 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002314 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002315 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002316 struct work_struct, entry);
2317
2318 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2319 /* optimization path, not strictly necessary */
2320 process_one_work(worker, work);
2321 if (unlikely(!list_empty(&worker->scheduled)))
2322 process_scheduled_works(worker);
2323 } else {
2324 move_linked_works(work, &worker->scheduled, NULL);
2325 process_scheduled_works(worker);
2326 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002327 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002328
Tejun Heoe22bee72010-06-29 10:07:14 +02002329 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002330sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002331 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002332 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002333
Tejun Heoc8e55f32010-06-29 10:07:12 +02002334 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002335 * gcwq->lock is held and there's no work to process and no
2336 * need to manage, sleep. Workers are woken up only while
2337 * holding gcwq->lock or from local cpu, so setting the
2338 * current state before releasing gcwq->lock is enough to
2339 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002340 */
2341 worker_enter_idle(worker);
2342 __set_current_state(TASK_INTERRUPTIBLE);
2343 spin_unlock_irq(&gcwq->lock);
2344 schedule();
2345 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346}
2347
Tejun Heoe22bee72010-06-29 10:07:14 +02002348/**
2349 * rescuer_thread - the rescuer thread function
2350 * @__wq: the associated workqueue
2351 *
2352 * Workqueue rescuer thread function. There's one rescuer for each
2353 * workqueue which has WQ_RESCUER set.
2354 *
2355 * Regular work processing on a gcwq may block trying to create a new
2356 * worker which uses GFP_KERNEL allocation which has slight chance of
2357 * developing into deadlock if some works currently on the same queue
2358 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2359 * the problem rescuer solves.
2360 *
2361 * When such condition is possible, the gcwq summons rescuers of all
2362 * workqueues which have works queued on the gcwq and let them process
2363 * those works so that forward progress can be guaranteed.
2364 *
2365 * This should happen rarely.
2366 */
2367static int rescuer_thread(void *__wq)
2368{
2369 struct workqueue_struct *wq = __wq;
2370 struct worker *rescuer = wq->rescuer;
2371 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002372 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002373 unsigned int cpu;
2374
2375 set_user_nice(current, RESCUER_NICE_LEVEL);
2376repeat:
2377 set_current_state(TASK_INTERRUPTIBLE);
2378
2379 if (kthread_should_stop())
2380 return 0;
2381
Tejun Heof3421792010-07-02 10:03:51 +02002382 /*
2383 * See whether any cpu is asking for help. Unbounded
2384 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2385 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002386 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002387 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2388 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002389 struct worker_pool *pool = cwq->pool;
2390 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002391 struct work_struct *work, *n;
2392
2393 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002394 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002395
2396 /* migrate to the target cpu if possible */
Tejun Heobd7bdd42012-07-12 14:46:37 -07002397 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002398 worker_maybe_bind_and_lock(rescuer);
2399
2400 /*
2401 * Slurp in all works issued via this workqueue and
2402 * process'em.
2403 */
2404 BUG_ON(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002405 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002406 if (get_work_cwq(work) == cwq)
2407 move_linked_works(work, scheduled, &n);
2408
2409 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002410
2411 /*
2412 * Leave this gcwq. If keep_working() is %true, notify a
2413 * regular worker; otherwise, we end up with 0 concurrency
2414 * and stalling the execution.
2415 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002416 if (keep_working(pool))
2417 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002418
Tejun Heoe22bee72010-06-29 10:07:14 +02002419 spin_unlock_irq(&gcwq->lock);
2420 }
2421
2422 schedule();
2423 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424}
2425
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002426struct wq_barrier {
2427 struct work_struct work;
2428 struct completion done;
2429};
2430
2431static void wq_barrier_func(struct work_struct *work)
2432{
2433 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2434 complete(&barr->done);
2435}
2436
Tejun Heo4690c4a2010-06-29 10:07:10 +02002437/**
2438 * insert_wq_barrier - insert a barrier work
2439 * @cwq: cwq to insert barrier into
2440 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002441 * @target: target work to attach @barr to
2442 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002443 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002444 * @barr is linked to @target such that @barr is completed only after
2445 * @target finishes execution. Please note that the ordering
2446 * guarantee is observed only with respect to @target and on the local
2447 * cpu.
2448 *
2449 * Currently, a queued barrier can't be canceled. This is because
2450 * try_to_grab_pending() can't determine whether the work to be
2451 * grabbed is at the head of the queue and thus can't clear LINKED
2452 * flag of the previous work while there must be a valid next work
2453 * after a work with LINKED flag set.
2454 *
2455 * Note that when @worker is non-NULL, @target may be modified
2456 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002457 *
2458 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002459 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002460 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002461static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002462 struct wq_barrier *barr,
2463 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002464{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002465 struct list_head *head;
2466 unsigned int linked = 0;
2467
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002468 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002469 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002470 * as we know for sure that this will not trigger any of the
2471 * checks and call back into the fixup functions where we
2472 * might deadlock.
2473 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002474 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002475 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002476 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002477
Tejun Heoaffee4b2010-06-29 10:07:12 +02002478 /*
2479 * If @target is currently being executed, schedule the
2480 * barrier to the worker; otherwise, put it after @target.
2481 */
2482 if (worker)
2483 head = worker->scheduled.next;
2484 else {
2485 unsigned long *bits = work_data_bits(target);
2486
2487 head = target->entry.next;
2488 /* there can already be other linked works, inherit and set */
2489 linked = *bits & WORK_STRUCT_LINKED;
2490 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2491 }
2492
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002493 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002494 insert_work(cwq, &barr->work, head,
2495 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002496}
2497
Tejun Heo73f53c42010-06-29 10:07:11 +02002498/**
2499 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2500 * @wq: workqueue being flushed
2501 * @flush_color: new flush color, < 0 for no-op
2502 * @work_color: new work color, < 0 for no-op
2503 *
2504 * Prepare cwqs for workqueue flushing.
2505 *
2506 * If @flush_color is non-negative, flush_color on all cwqs should be
2507 * -1. If no cwq has in-flight commands at the specified color, all
2508 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2509 * has in flight commands, its cwq->flush_color is set to
2510 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2511 * wakeup logic is armed and %true is returned.
2512 *
2513 * The caller should have initialized @wq->first_flusher prior to
2514 * calling this function with non-negative @flush_color. If
2515 * @flush_color is negative, no flush color update is done and %false
2516 * is returned.
2517 *
2518 * If @work_color is non-negative, all cwqs should have the same
2519 * work_color which is previous to @work_color and all will be
2520 * advanced to @work_color.
2521 *
2522 * CONTEXT:
2523 * mutex_lock(wq->flush_mutex).
2524 *
2525 * RETURNS:
2526 * %true if @flush_color >= 0 and there's something to flush. %false
2527 * otherwise.
2528 */
2529static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2530 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531{
Tejun Heo73f53c42010-06-29 10:07:11 +02002532 bool wait = false;
2533 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002534
Tejun Heo73f53c42010-06-29 10:07:11 +02002535 if (flush_color >= 0) {
2536 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2537 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002538 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002539
Tejun Heof3421792010-07-02 10:03:51 +02002540 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002541 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002542 struct global_cwq *gcwq = cwq->pool->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002543
Tejun Heo8b03ae32010-06-29 10:07:12 +02002544 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002545
2546 if (flush_color >= 0) {
2547 BUG_ON(cwq->flush_color != -1);
2548
2549 if (cwq->nr_in_flight[flush_color]) {
2550 cwq->flush_color = flush_color;
2551 atomic_inc(&wq->nr_cwqs_to_flush);
2552 wait = true;
2553 }
2554 }
2555
2556 if (work_color >= 0) {
2557 BUG_ON(work_color != work_next_color(cwq->work_color));
2558 cwq->work_color = work_color;
2559 }
2560
Tejun Heo8b03ae32010-06-29 10:07:12 +02002561 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002562 }
2563
2564 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2565 complete(&wq->first_flusher->done);
2566
2567 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568}
2569
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002570/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002572 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573 *
2574 * Forces execution of the workqueue and blocks until its completion.
2575 * This is typically used in driver shutdown handlers.
2576 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002577 * We sleep until all works which were queued on entry have been handled,
2578 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002580void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581{
Tejun Heo73f53c42010-06-29 10:07:11 +02002582 struct wq_flusher this_flusher = {
2583 .list = LIST_HEAD_INIT(this_flusher.list),
2584 .flush_color = -1,
2585 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2586 };
2587 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002588
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002589 lock_map_acquire(&wq->lockdep_map);
2590 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002591
2592 mutex_lock(&wq->flush_mutex);
2593
2594 /*
2595 * Start-to-wait phase
2596 */
2597 next_color = work_next_color(wq->work_color);
2598
2599 if (next_color != wq->flush_color) {
2600 /*
2601 * Color space is not full. The current work_color
2602 * becomes our flush_color and work_color is advanced
2603 * by one.
2604 */
2605 BUG_ON(!list_empty(&wq->flusher_overflow));
2606 this_flusher.flush_color = wq->work_color;
2607 wq->work_color = next_color;
2608
2609 if (!wq->first_flusher) {
2610 /* no flush in progress, become the first flusher */
2611 BUG_ON(wq->flush_color != this_flusher.flush_color);
2612
2613 wq->first_flusher = &this_flusher;
2614
2615 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2616 wq->work_color)) {
2617 /* nothing to flush, done */
2618 wq->flush_color = next_color;
2619 wq->first_flusher = NULL;
2620 goto out_unlock;
2621 }
2622 } else {
2623 /* wait in queue */
2624 BUG_ON(wq->flush_color == this_flusher.flush_color);
2625 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2626 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2627 }
2628 } else {
2629 /*
2630 * Oops, color space is full, wait on overflow queue.
2631 * The next flush completion will assign us
2632 * flush_color and transfer to flusher_queue.
2633 */
2634 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2635 }
2636
2637 mutex_unlock(&wq->flush_mutex);
2638
2639 wait_for_completion(&this_flusher.done);
2640
2641 /*
2642 * Wake-up-and-cascade phase
2643 *
2644 * First flushers are responsible for cascading flushes and
2645 * handling overflow. Non-first flushers can simply return.
2646 */
2647 if (wq->first_flusher != &this_flusher)
2648 return;
2649
2650 mutex_lock(&wq->flush_mutex);
2651
Tejun Heo4ce48b32010-07-02 10:03:51 +02002652 /* we might have raced, check again with mutex held */
2653 if (wq->first_flusher != &this_flusher)
2654 goto out_unlock;
2655
Tejun Heo73f53c42010-06-29 10:07:11 +02002656 wq->first_flusher = NULL;
2657
2658 BUG_ON(!list_empty(&this_flusher.list));
2659 BUG_ON(wq->flush_color != this_flusher.flush_color);
2660
2661 while (true) {
2662 struct wq_flusher *next, *tmp;
2663
2664 /* complete all the flushers sharing the current flush color */
2665 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2666 if (next->flush_color != wq->flush_color)
2667 break;
2668 list_del_init(&next->list);
2669 complete(&next->done);
2670 }
2671
2672 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2673 wq->flush_color != work_next_color(wq->work_color));
2674
2675 /* this flush_color is finished, advance by one */
2676 wq->flush_color = work_next_color(wq->flush_color);
2677
2678 /* one color has been freed, handle overflow queue */
2679 if (!list_empty(&wq->flusher_overflow)) {
2680 /*
2681 * Assign the same color to all overflowed
2682 * flushers, advance work_color and append to
2683 * flusher_queue. This is the start-to-wait
2684 * phase for these overflowed flushers.
2685 */
2686 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2687 tmp->flush_color = wq->work_color;
2688
2689 wq->work_color = work_next_color(wq->work_color);
2690
2691 list_splice_tail_init(&wq->flusher_overflow,
2692 &wq->flusher_queue);
2693 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2694 }
2695
2696 if (list_empty(&wq->flusher_queue)) {
2697 BUG_ON(wq->flush_color != wq->work_color);
2698 break;
2699 }
2700
2701 /*
2702 * Need to flush more colors. Make the next flusher
2703 * the new first flusher and arm cwqs.
2704 */
2705 BUG_ON(wq->flush_color == wq->work_color);
2706 BUG_ON(wq->flush_color != next->flush_color);
2707
2708 list_del_init(&next->list);
2709 wq->first_flusher = next;
2710
2711 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2712 break;
2713
2714 /*
2715 * Meh... this color is already done, clear first
2716 * flusher and repeat cascading.
2717 */
2718 wq->first_flusher = NULL;
2719 }
2720
2721out_unlock:
2722 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723}
Dave Jonesae90dd52006-06-30 01:40:45 -04002724EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002726/**
2727 * drain_workqueue - drain a workqueue
2728 * @wq: workqueue to drain
2729 *
2730 * Wait until the workqueue becomes empty. While draining is in progress,
2731 * only chain queueing is allowed. IOW, only currently pending or running
2732 * work items on @wq can queue further work items on it. @wq is flushed
2733 * repeatedly until it becomes empty. The number of flushing is detemined
2734 * by the depth of chaining and should be relatively short. Whine if it
2735 * takes too long.
2736 */
2737void drain_workqueue(struct workqueue_struct *wq)
2738{
2739 unsigned int flush_cnt = 0;
2740 unsigned int cpu;
2741
2742 /*
2743 * __queue_work() needs to test whether there are drainers, is much
2744 * hotter than drain_workqueue() and already looks at @wq->flags.
2745 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2746 */
2747 spin_lock(&workqueue_lock);
2748 if (!wq->nr_drainers++)
2749 wq->flags |= WQ_DRAINING;
2750 spin_unlock(&workqueue_lock);
2751reflush:
2752 flush_workqueue(wq);
2753
2754 for_each_cwq_cpu(cpu, wq) {
2755 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002756 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002757
Tejun Heobd7bdd42012-07-12 14:46:37 -07002758 spin_lock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002759 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002760 spin_unlock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002761
2762 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002763 continue;
2764
2765 if (++flush_cnt == 10 ||
2766 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2767 pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
2768 wq->name, flush_cnt);
2769 goto reflush;
2770 }
2771
2772 spin_lock(&workqueue_lock);
2773 if (!--wq->nr_drainers)
2774 wq->flags &= ~WQ_DRAINING;
2775 spin_unlock(&workqueue_lock);
2776}
2777EXPORT_SYMBOL_GPL(drain_workqueue);
2778
Tejun Heobaf59022010-09-16 10:42:16 +02002779static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2780 bool wait_executing)
2781{
2782 struct worker *worker = NULL;
2783 struct global_cwq *gcwq;
2784 struct cpu_workqueue_struct *cwq;
2785
2786 might_sleep();
2787 gcwq = get_work_gcwq(work);
2788 if (!gcwq)
2789 return false;
2790
2791 spin_lock_irq(&gcwq->lock);
2792 if (!list_empty(&work->entry)) {
2793 /*
2794 * See the comment near try_to_grab_pending()->smp_rmb().
2795 * If it was re-queued to a different gcwq under us, we
2796 * are not going to wait.
2797 */
2798 smp_rmb();
2799 cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002800 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
Tejun Heobaf59022010-09-16 10:42:16 +02002801 goto already_gone;
2802 } else if (wait_executing) {
2803 worker = find_worker_executing_work(gcwq, work);
2804 if (!worker)
2805 goto already_gone;
2806 cwq = worker->current_cwq;
2807 } else
2808 goto already_gone;
2809
2810 insert_wq_barrier(cwq, barr, work, worker);
2811 spin_unlock_irq(&gcwq->lock);
2812
Tejun Heoe1594892011-01-09 23:32:15 +01002813 /*
2814 * If @max_active is 1 or rescuer is in use, flushing another work
2815 * item on the same workqueue may lead to deadlock. Make sure the
2816 * flusher is not running on the same workqueue by verifying write
2817 * access.
2818 */
2819 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2820 lock_map_acquire(&cwq->wq->lockdep_map);
2821 else
2822 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002823 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002824
Tejun Heobaf59022010-09-16 10:42:16 +02002825 return true;
2826already_gone:
2827 spin_unlock_irq(&gcwq->lock);
2828 return false;
2829}
2830
Oleg Nesterovdb700892008-07-25 01:47:49 -07002831/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002832 * flush_work - wait for a work to finish executing the last queueing instance
2833 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002834 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002835 * Wait until @work has finished execution. This function considers
2836 * only the last queueing instance of @work. If @work has been
2837 * enqueued across different CPUs on a non-reentrant workqueue or on
2838 * multiple workqueues, @work might still be executing on return on
2839 * some of the CPUs from earlier queueing.
Oleg Nesterova67da702008-07-25 01:47:52 -07002840 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002841 * If @work was queued only on a non-reentrant, ordered or unbound
2842 * workqueue, @work is guaranteed to be idle on return if it hasn't
2843 * been requeued since flush started.
2844 *
2845 * RETURNS:
2846 * %true if flush_work() waited for the work to finish execution,
2847 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002848 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002849bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002850{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002851 struct wq_barrier barr;
2852
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002853 lock_map_acquire(&work->lockdep_map);
2854 lock_map_release(&work->lockdep_map);
2855
Tejun Heobaf59022010-09-16 10:42:16 +02002856 if (start_flush_work(work, &barr, true)) {
2857 wait_for_completion(&barr.done);
2858 destroy_work_on_stack(&barr.work);
2859 return true;
2860 } else
2861 return false;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002862}
2863EXPORT_SYMBOL_GPL(flush_work);
2864
Tejun Heo401a8d02010-09-16 10:36:00 +02002865static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2866{
2867 struct wq_barrier barr;
2868 struct worker *worker;
2869
2870 spin_lock_irq(&gcwq->lock);
2871
2872 worker = find_worker_executing_work(gcwq, work);
2873 if (unlikely(worker))
2874 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2875
2876 spin_unlock_irq(&gcwq->lock);
2877
2878 if (unlikely(worker)) {
2879 wait_for_completion(&barr.done);
2880 destroy_work_on_stack(&barr.work);
2881 return true;
2882 } else
2883 return false;
2884}
2885
2886static bool wait_on_work(struct work_struct *work)
2887{
2888 bool ret = false;
2889 int cpu;
2890
2891 might_sleep();
2892
2893 lock_map_acquire(&work->lockdep_map);
2894 lock_map_release(&work->lockdep_map);
2895
2896 for_each_gcwq_cpu(cpu)
2897 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2898 return ret;
2899}
2900
Tejun Heo09383492010-09-16 10:48:29 +02002901/**
2902 * flush_work_sync - wait until a work has finished execution
2903 * @work: the work to flush
2904 *
2905 * Wait until @work has finished execution. On return, it's
2906 * guaranteed that all queueing instances of @work which happened
2907 * before this function is called are finished. In other words, if
2908 * @work hasn't been requeued since this function was called, @work is
2909 * guaranteed to be idle on return.
2910 *
2911 * RETURNS:
2912 * %true if flush_work_sync() waited for the work to finish execution,
2913 * %false if it was already idle.
2914 */
2915bool flush_work_sync(struct work_struct *work)
2916{
2917 struct wq_barrier barr;
2918 bool pending, waited;
2919
2920 /* we'll wait for executions separately, queue barr only if pending */
2921 pending = start_flush_work(work, &barr, false);
2922
2923 /* wait for executions to finish */
2924 waited = wait_on_work(work);
2925
2926 /* wait for the pending one */
2927 if (pending) {
2928 wait_for_completion(&barr.done);
2929 destroy_work_on_stack(&barr.work);
2930 }
2931
2932 return pending || waited;
2933}
2934EXPORT_SYMBOL_GPL(flush_work_sync);
2935
Tejun Heo36e227d2012-08-03 10:30:46 -07002936static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002937{
Tejun Heobbb68df2012-08-03 10:30:46 -07002938 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002939 int ret;
2940
2941 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002942 ret = try_to_grab_pending(work, is_dwork, &flags);
2943 /*
2944 * If someone else is canceling, wait for the same event it
2945 * would be waiting for before retrying.
2946 */
2947 if (unlikely(ret == -ENOENT))
2948 wait_on_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002949 } while (unlikely(ret < 0));
2950
Tejun Heobbb68df2012-08-03 10:30:46 -07002951 /* tell other tasks trying to grab @work to back off */
2952 mark_work_canceling(work);
2953 local_irq_restore(flags);
2954
2955 wait_on_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002956 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002957 return ret;
2958}
2959
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002960/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002961 * cancel_work_sync - cancel a work and wait for it to finish
2962 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002963 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002964 * Cancel @work and wait for its execution to finish. This function
2965 * can be used even if the work re-queues itself or migrates to
2966 * another workqueue. On return from this function, @work is
2967 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002968 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002969 * cancel_work_sync(&delayed_work->work) must not be used for
2970 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002971 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002972 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002973 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002974 *
2975 * RETURNS:
2976 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002977 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002978bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002979{
Tejun Heo36e227d2012-08-03 10:30:46 -07002980 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002981}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002982EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002983
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002984/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002985 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2986 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002987 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002988 * Delayed timer is cancelled and the pending work is queued for
2989 * immediate execution. Like flush_work(), this function only
2990 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002991 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002992 * RETURNS:
2993 * %true if flush_work() waited for the work to finish execution,
2994 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002995 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002996bool flush_delayed_work(struct delayed_work *dwork)
2997{
Tejun Heo8930cab2012-08-03 10:30:45 -07002998 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002999 if (del_timer_sync(&dwork->timer))
Tejun Heo57469822012-08-03 10:30:45 -07003000 __queue_work(WORK_CPU_UNBOUND,
Tejun Heo401a8d02010-09-16 10:36:00 +02003001 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003002 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003003 return flush_work(&dwork->work);
3004}
3005EXPORT_SYMBOL(flush_delayed_work);
3006
3007/**
Tejun Heo09383492010-09-16 10:48:29 +02003008 * flush_delayed_work_sync - wait for a dwork to finish
3009 * @dwork: the delayed work to flush
3010 *
3011 * Delayed timer is cancelled and the pending work is queued for
3012 * execution immediately. Other than timer handling, its behavior
3013 * is identical to flush_work_sync().
3014 *
3015 * RETURNS:
3016 * %true if flush_work_sync() waited for the work to finish execution,
3017 * %false if it was already idle.
3018 */
3019bool flush_delayed_work_sync(struct delayed_work *dwork)
3020{
Tejun Heo8930cab2012-08-03 10:30:45 -07003021 local_irq_disable();
Tejun Heo09383492010-09-16 10:48:29 +02003022 if (del_timer_sync(&dwork->timer))
Tejun Heo57469822012-08-03 10:30:45 -07003023 __queue_work(WORK_CPU_UNBOUND,
Tejun Heo09383492010-09-16 10:48:29 +02003024 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003025 local_irq_enable();
Tejun Heo09383492010-09-16 10:48:29 +02003026 return flush_work_sync(&dwork->work);
3027}
3028EXPORT_SYMBOL(flush_delayed_work_sync);
3029
3030/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003031 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3032 * @dwork: the delayed work cancel
3033 *
3034 * This is cancel_work_sync() for delayed works.
3035 *
3036 * RETURNS:
3037 * %true if @dwork was pending, %false otherwise.
3038 */
3039bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003040{
Tejun Heo36e227d2012-08-03 10:30:46 -07003041 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003042}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003043EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044
Tejun Heod4283e92012-08-03 10:30:44 -07003045/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003046 * schedule_work_on - put work task on a specific cpu
3047 * @cpu: cpu to put the work task on
3048 * @work: job to be done
3049 *
3050 * This puts a job on a specific cpu
3051 */
Tejun Heod4283e92012-08-03 10:30:44 -07003052bool schedule_work_on(int cpu, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07003053{
3054 return queue_work_on(cpu, system_wq, work);
3055}
3056EXPORT_SYMBOL(schedule_work_on);
3057
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003058/**
3059 * schedule_work - put work task in global workqueue
3060 * @work: job to be done
3061 *
Tejun Heod4283e92012-08-03 10:30:44 -07003062 * Returns %false if @work was already on the kernel-global workqueue and
3063 * %true otherwise.
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02003064 *
3065 * This puts a job in the kernel-global workqueue if it was not already
3066 * queued and leaves it in the same position on the kernel-global
3067 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003068 */
Tejun Heod4283e92012-08-03 10:30:44 -07003069bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003070{
Tejun Heod320c032010-06-29 10:07:14 +02003071 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003072}
Dave Jonesae90dd52006-06-30 01:40:45 -04003073EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003074
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003075/**
3076 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3077 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00003078 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003079 * @delay: number of jiffies to wait
3080 *
3081 * After waiting for a given time this puts a job in the kernel-global
3082 * workqueue on the specified CPU.
3083 */
Tejun Heod4283e92012-08-03 10:30:44 -07003084bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3085 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003086{
Tejun Heod320c032010-06-29 10:07:14 +02003087 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003088}
Dave Jonesae90dd52006-06-30 01:40:45 -04003089EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003090
Andrew Mortonb6136772006-06-25 05:47:49 -07003091/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003092 * schedule_delayed_work - put work task in global workqueue after delay
3093 * @dwork: job to be done
3094 * @delay: number of jiffies to wait or 0 for immediate execution
3095 *
3096 * After waiting for a given time this puts a job in the kernel-global
3097 * workqueue.
3098 */
Tejun Heod4283e92012-08-03 10:30:44 -07003099bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003100{
3101 return queue_delayed_work(system_wq, dwork, delay);
3102}
3103EXPORT_SYMBOL(schedule_delayed_work);
3104
3105/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003106 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003107 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003108 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003109 * schedule_on_each_cpu() executes @func on each online CPU using the
3110 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003111 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003112 *
3113 * RETURNS:
3114 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003115 */
David Howells65f27f32006-11-22 14:55:48 +00003116int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003117{
3118 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003119 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003120
Andrew Mortonb6136772006-06-25 05:47:49 -07003121 works = alloc_percpu(struct work_struct);
3122 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003123 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003124
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003125 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003126
Christoph Lameter15316ba2006-01-08 01:00:43 -08003127 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003128 struct work_struct *work = per_cpu_ptr(works, cpu);
3129
3130 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003131 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003132 }
Tejun Heo93981802009-11-17 14:06:20 -08003133
3134 for_each_online_cpu(cpu)
3135 flush_work(per_cpu_ptr(works, cpu));
3136
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003137 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003138 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003139 return 0;
3140}
3141
Alan Sterneef6a7d2010-02-12 17:39:21 +09003142/**
3143 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3144 *
3145 * Forces execution of the kernel-global workqueue and blocks until its
3146 * completion.
3147 *
3148 * Think twice before calling this function! It's very easy to get into
3149 * trouble if you don't take great care. Either of the following situations
3150 * will lead to deadlock:
3151 *
3152 * One of the work items currently on the workqueue needs to acquire
3153 * a lock held by your code or its caller.
3154 *
3155 * Your code is running in the context of a work routine.
3156 *
3157 * They will be detected by lockdep when they occur, but the first might not
3158 * occur very often. It depends on what work items are on the workqueue and
3159 * what locks they need, which you have no control over.
3160 *
3161 * In most situations flushing the entire workqueue is overkill; you merely
3162 * need to know that a particular work item isn't queued and isn't running.
3163 * In such cases you should use cancel_delayed_work_sync() or
3164 * cancel_work_sync() instead.
3165 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166void flush_scheduled_work(void)
3167{
Tejun Heod320c032010-06-29 10:07:14 +02003168 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003169}
Dave Jonesae90dd52006-06-30 01:40:45 -04003170EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003171
3172/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003173 * execute_in_process_context - reliably execute the routine with user context
3174 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003175 * @ew: guaranteed storage for the execute work structure (must
3176 * be available when the work executes)
3177 *
3178 * Executes the function immediately if process context is available,
3179 * otherwise schedules the function for delayed execution.
3180 *
3181 * Returns: 0 - function was executed
3182 * 1 - function was scheduled for execution
3183 */
David Howells65f27f32006-11-22 14:55:48 +00003184int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003185{
3186 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003187 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003188 return 0;
3189 }
3190
David Howells65f27f32006-11-22 14:55:48 +00003191 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003192 schedule_work(&ew->work);
3193
3194 return 1;
3195}
3196EXPORT_SYMBOL_GPL(execute_in_process_context);
3197
Linus Torvalds1da177e2005-04-16 15:20:36 -07003198int keventd_up(void)
3199{
Tejun Heod320c032010-06-29 10:07:14 +02003200 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003201}
3202
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003203static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003204{
Oleg Nesterov3af244332007-05-09 02:34:09 -07003205 /*
Tejun Heo0f900042010-06-29 10:07:11 +02003206 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3207 * Make sure that the alignment isn't lower than that of
3208 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07003209 */
Tejun Heo0f900042010-06-29 10:07:11 +02003210 const size_t size = sizeof(struct cpu_workqueue_struct);
3211 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3212 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07003213
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003214 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003215 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02003216 else {
Tejun Heof3421792010-07-02 10:03:51 +02003217 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003218
Tejun Heof3421792010-07-02 10:03:51 +02003219 /*
3220 * Allocate enough room to align cwq and put an extra
3221 * pointer at the end pointing back to the originally
3222 * allocated pointer which will be used for free.
3223 */
3224 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3225 if (ptr) {
3226 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3227 *(void **)(wq->cpu_wq.single + 1) = ptr;
3228 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003229 }
Tejun Heof3421792010-07-02 10:03:51 +02003230
Tejun Heo0415b00d12011-03-24 18:50:09 +01003231 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003232 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3233 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003234}
3235
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003236static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003237{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003238 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003239 free_percpu(wq->cpu_wq.pcpu);
3240 else if (wq->cpu_wq.single) {
3241 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003242 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003243 }
3244}
3245
Tejun Heof3421792010-07-02 10:03:51 +02003246static int wq_clamp_max_active(int max_active, unsigned int flags,
3247 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003248{
Tejun Heof3421792010-07-02 10:03:51 +02003249 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3250
3251 if (max_active < 1 || max_active > lim)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003252 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
3253 "is out of range, clamping between %d and %d\n",
Tejun Heof3421792010-07-02 10:03:51 +02003254 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003255
Tejun Heof3421792010-07-02 10:03:51 +02003256 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003257}
3258
Tejun Heob196be82012-01-10 15:11:35 -08003259struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003260 unsigned int flags,
3261 int max_active,
3262 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003263 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003264{
Tejun Heob196be82012-01-10 15:11:35 -08003265 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003266 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003267 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08003268 size_t namelen;
3269
3270 /* determine namelen, allocate wq and format name */
3271 va_start(args, lock_name);
3272 va_copy(args1, args);
3273 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3274
3275 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3276 if (!wq)
3277 goto err;
3278
3279 vsnprintf(wq->name, namelen, fmt, args1);
3280 va_end(args);
3281 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003282
Tejun Heof3421792010-07-02 10:03:51 +02003283 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003284 * Workqueues which may be used during memory reclaim should
3285 * have a rescuer to guarantee forward progress.
3286 */
3287 if (flags & WQ_MEM_RECLAIM)
3288 flags |= WQ_RESCUER;
3289
Tejun Heod320c032010-06-29 10:07:14 +02003290 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003291 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003292
Tejun Heob196be82012-01-10 15:11:35 -08003293 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003294 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003295 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003296 mutex_init(&wq->flush_mutex);
3297 atomic_set(&wq->nr_cwqs_to_flush, 0);
3298 INIT_LIST_HEAD(&wq->flusher_queue);
3299 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003300
Johannes Bergeb13ba82008-01-16 09:51:58 +01003301 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003302 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003303
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003304 if (alloc_cwqs(wq) < 0)
3305 goto err;
3306
Tejun Heof3421792010-07-02 10:03:51 +02003307 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003308 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003309 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo32704762012-07-13 22:16:45 -07003310 int pool_idx = (bool)(flags & WQ_HIGHPRI);
Tejun Heo15376632010-06-29 10:07:11 +02003311
Tejun Heo0f900042010-06-29 10:07:11 +02003312 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo32704762012-07-13 22:16:45 -07003313 cwq->pool = &gcwq->pools[pool_idx];
Tejun Heoc34056a2010-06-29 10:07:11 +02003314 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003315 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003316 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003317 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003318 }
3319
Tejun Heoe22bee72010-06-29 10:07:14 +02003320 if (flags & WQ_RESCUER) {
3321 struct worker *rescuer;
3322
Tejun Heof2e005a2010-07-20 15:59:09 +02003323 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003324 goto err;
3325
3326 wq->rescuer = rescuer = alloc_worker();
3327 if (!rescuer)
3328 goto err;
3329
Tejun Heob196be82012-01-10 15:11:35 -08003330 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3331 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003332 if (IS_ERR(rescuer->task))
3333 goto err;
3334
Tejun Heoe22bee72010-06-29 10:07:14 +02003335 rescuer->task->flags |= PF_THREAD_BOUND;
3336 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003337 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003338
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003339 /*
3340 * workqueue_lock protects global freeze state and workqueues
3341 * list. Grab it, set max_active accordingly and add the new
3342 * workqueue to workqueues list.
3343 */
Tejun Heo15376632010-06-29 10:07:11 +02003344 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003345
Tejun Heo58a69cb2011-02-16 09:25:31 +01003346 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003347 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003348 get_cwq(cpu, wq)->max_active = 0;
3349
Tejun Heo15376632010-06-29 10:07:11 +02003350 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003351
Tejun Heo15376632010-06-29 10:07:11 +02003352 spin_unlock(&workqueue_lock);
3353
Oleg Nesterov3af244332007-05-09 02:34:09 -07003354 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003355err:
3356 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003357 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003358 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003359 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003360 kfree(wq);
3361 }
3362 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003363}
Tejun Heod320c032010-06-29 10:07:14 +02003364EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003365
3366/**
3367 * destroy_workqueue - safely terminate a workqueue
3368 * @wq: target workqueue
3369 *
3370 * Safely destroy a workqueue. All work currently pending will be done first.
3371 */
3372void destroy_workqueue(struct workqueue_struct *wq)
3373{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003374 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003375
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003376 /* drain it before proceeding with destruction */
3377 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003378
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003379 /*
3380 * wq list is used to freeze wq, remove from list after
3381 * flushing is complete in case freeze races us.
3382 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003383 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003384 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003385 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003386
Tejun Heoe22bee72010-06-29 10:07:14 +02003387 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003388 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003389 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3390 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003391
Tejun Heo73f53c42010-06-29 10:07:11 +02003392 for (i = 0; i < WORK_NR_COLORS; i++)
3393 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003394 BUG_ON(cwq->nr_active);
3395 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003396 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003397
Tejun Heoe22bee72010-06-29 10:07:14 +02003398 if (wq->flags & WQ_RESCUER) {
3399 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003400 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003401 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003402 }
3403
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003404 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003405 kfree(wq);
3406}
3407EXPORT_SYMBOL_GPL(destroy_workqueue);
3408
Tejun Heodcd989c2010-06-29 10:07:14 +02003409/**
3410 * workqueue_set_max_active - adjust max_active of a workqueue
3411 * @wq: target workqueue
3412 * @max_active: new max_active value.
3413 *
3414 * Set max_active of @wq to @max_active.
3415 *
3416 * CONTEXT:
3417 * Don't call from IRQ context.
3418 */
3419void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3420{
3421 unsigned int cpu;
3422
Tejun Heof3421792010-07-02 10:03:51 +02003423 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003424
3425 spin_lock(&workqueue_lock);
3426
3427 wq->saved_max_active = max_active;
3428
Tejun Heof3421792010-07-02 10:03:51 +02003429 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003430 struct global_cwq *gcwq = get_gcwq(cpu);
3431
3432 spin_lock_irq(&gcwq->lock);
3433
Tejun Heo58a69cb2011-02-16 09:25:31 +01003434 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003435 !(gcwq->flags & GCWQ_FREEZING))
3436 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3437
3438 spin_unlock_irq(&gcwq->lock);
3439 }
3440
3441 spin_unlock(&workqueue_lock);
3442}
3443EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3444
3445/**
3446 * workqueue_congested - test whether a workqueue is congested
3447 * @cpu: CPU in question
3448 * @wq: target workqueue
3449 *
3450 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3451 * no synchronization around this function and the test result is
3452 * unreliable and only useful as advisory hints or for debugging.
3453 *
3454 * RETURNS:
3455 * %true if congested, %false otherwise.
3456 */
3457bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3458{
3459 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3460
3461 return !list_empty(&cwq->delayed_works);
3462}
3463EXPORT_SYMBOL_GPL(workqueue_congested);
3464
3465/**
3466 * work_cpu - return the last known associated cpu for @work
3467 * @work: the work of interest
3468 *
3469 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003470 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003471 */
3472unsigned int work_cpu(struct work_struct *work)
3473{
3474 struct global_cwq *gcwq = get_work_gcwq(work);
3475
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003476 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003477}
3478EXPORT_SYMBOL_GPL(work_cpu);
3479
3480/**
3481 * work_busy - test whether a work is currently pending or running
3482 * @work: the work to be tested
3483 *
3484 * Test whether @work is currently pending or running. There is no
3485 * synchronization around this function and the test result is
3486 * unreliable and only useful as advisory hints or for debugging.
3487 * Especially for reentrant wqs, the pending state might hide the
3488 * running state.
3489 *
3490 * RETURNS:
3491 * OR'd bitmask of WORK_BUSY_* bits.
3492 */
3493unsigned int work_busy(struct work_struct *work)
3494{
3495 struct global_cwq *gcwq = get_work_gcwq(work);
3496 unsigned long flags;
3497 unsigned int ret = 0;
3498
3499 if (!gcwq)
3500 return false;
3501
3502 spin_lock_irqsave(&gcwq->lock, flags);
3503
3504 if (work_pending(work))
3505 ret |= WORK_BUSY_PENDING;
3506 if (find_worker_executing_work(gcwq, work))
3507 ret |= WORK_BUSY_RUNNING;
3508
3509 spin_unlock_irqrestore(&gcwq->lock, flags);
3510
3511 return ret;
3512}
3513EXPORT_SYMBOL_GPL(work_busy);
3514
Tejun Heodb7bccf2010-06-29 10:07:12 +02003515/*
3516 * CPU hotplug.
3517 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003518 * There are two challenges in supporting CPU hotplug. Firstly, there
3519 * are a lot of assumptions on strong associations among work, cwq and
3520 * gcwq which make migrating pending and scheduled works very
3521 * difficult to implement without impacting hot paths. Secondly,
3522 * gcwqs serve mix of short, long and very long running works making
3523 * blocked draining impractical.
3524 *
Tejun Heo628c78e2012-07-17 12:39:27 -07003525 * This is solved by allowing a gcwq to be disassociated from the CPU
3526 * running as an unbound one and allowing it to be reattached later if the
3527 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003528 */
3529
Tejun Heo60373152012-07-17 12:39:27 -07003530/* claim manager positions of all pools */
Tejun Heo8db25e72012-07-17 12:39:28 -07003531static void gcwq_claim_management_and_lock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003532{
3533 struct worker_pool *pool;
3534
3535 for_each_worker_pool(pool, gcwq)
3536 mutex_lock_nested(&pool->manager_mutex, pool - gcwq->pools);
Tejun Heo8db25e72012-07-17 12:39:28 -07003537 spin_lock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003538}
3539
3540/* release manager positions */
Tejun Heo8db25e72012-07-17 12:39:28 -07003541static void gcwq_release_management_and_unlock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003542{
3543 struct worker_pool *pool;
3544
Tejun Heo8db25e72012-07-17 12:39:28 -07003545 spin_unlock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003546 for_each_worker_pool(pool, gcwq)
3547 mutex_unlock(&pool->manager_mutex);
3548}
3549
Tejun Heo628c78e2012-07-17 12:39:27 -07003550static void gcwq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003551{
Tejun Heo628c78e2012-07-17 12:39:27 -07003552 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
Tejun Heo4ce62e92012-07-13 22:16:44 -07003553 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003554 struct worker *worker;
3555 struct hlist_node *pos;
3556 int i;
3557
3558 BUG_ON(gcwq->cpu != smp_processor_id());
3559
Tejun Heo8db25e72012-07-17 12:39:28 -07003560 gcwq_claim_management_and_lock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003561
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003562 /*
3563 * We've claimed all manager positions. Make all workers unbound
3564 * and set DISASSOCIATED. Before this, all workers except for the
3565 * ones which are still executing works from before the last CPU
3566 * down must be on the cpu. After this, they may become diasporas.
3567 */
Tejun Heo60373152012-07-17 12:39:27 -07003568 for_each_worker_pool(pool, gcwq)
Tejun Heo4ce62e92012-07-13 22:16:44 -07003569 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003570 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003571
3572 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo403c8212012-07-17 12:39:27 -07003573 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003574
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003575 gcwq->flags |= GCWQ_DISASSOCIATED;
3576
Tejun Heo8db25e72012-07-17 12:39:28 -07003577 gcwq_release_management_and_unlock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003578
3579 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003580 * Call schedule() so that we cross rq->lock and thus can guarantee
3581 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3582 * as scheduler callbacks may be invoked from other cpus.
3583 */
3584 schedule();
3585
3586 /*
3587 * Sched callbacks are disabled now. Zap nr_running. After this,
3588 * nr_running stays zero and need_more_worker() and keep_working()
3589 * are always true as long as the worklist is not empty. @gcwq now
3590 * behaves as unbound (in terms of concurrency management) gcwq
3591 * which is served by workers tied to the CPU.
3592 *
3593 * On return from this function, the current worker would trigger
3594 * unbound chain execution of pending work items if other workers
3595 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003596 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003597 for_each_worker_pool(pool, gcwq)
3598 atomic_set(get_pool_nr_running(pool), 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003599}
3600
Tejun Heo8db25e72012-07-17 12:39:28 -07003601/*
3602 * Workqueues should be brought up before normal priority CPU notifiers.
3603 * This will be registered high priority CPU notifier.
3604 */
3605static int __devinit workqueue_cpu_up_callback(struct notifier_block *nfb,
3606 unsigned long action,
3607 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003608{
3609 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003610 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003611 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003612
Tejun Heo8db25e72012-07-17 12:39:28 -07003613 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003614 case CPU_UP_PREPARE:
Tejun Heo4ce62e92012-07-13 22:16:44 -07003615 for_each_worker_pool(pool, gcwq) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003616 struct worker *worker;
3617
3618 if (pool->nr_workers)
3619 continue;
3620
3621 worker = create_worker(pool);
3622 if (!worker)
3623 return NOTIFY_BAD;
3624
3625 spin_lock_irq(&gcwq->lock);
3626 start_worker(worker);
3627 spin_unlock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003628 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003629 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003630
Tejun Heo65758202012-07-17 12:39:26 -07003631 case CPU_DOWN_FAILED:
3632 case CPU_ONLINE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003633 gcwq_claim_management_and_lock(gcwq);
3634 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3635 rebind_workers(gcwq);
3636 gcwq_release_management_and_unlock(gcwq);
3637 break;
Tejun Heo65758202012-07-17 12:39:26 -07003638 }
3639 return NOTIFY_OK;
3640}
3641
3642/*
3643 * Workqueues should be brought down after normal priority CPU notifiers.
3644 * This will be registered as low priority CPU notifier.
3645 */
3646static int __devinit workqueue_cpu_down_callback(struct notifier_block *nfb,
3647 unsigned long action,
3648 void *hcpu)
3649{
Tejun Heo8db25e72012-07-17 12:39:28 -07003650 unsigned int cpu = (unsigned long)hcpu;
3651 struct work_struct unbind_work;
3652
Tejun Heo65758202012-07-17 12:39:26 -07003653 switch (action & ~CPU_TASKS_FROZEN) {
3654 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003655 /* unbinding should happen on the local CPU */
3656 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
3657 schedule_work_on(cpu, &unbind_work);
3658 flush_work(&unbind_work);
3659 break;
Tejun Heo65758202012-07-17 12:39:26 -07003660 }
3661 return NOTIFY_OK;
3662}
3663
Rusty Russell2d3854a2008-11-05 13:39:10 +11003664#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003665
Rusty Russell2d3854a2008-11-05 13:39:10 +11003666struct work_for_cpu {
Andrew Morton6b44003e2009-04-09 09:50:37 -06003667 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003668 long (*fn)(void *);
3669 void *arg;
3670 long ret;
3671};
3672
Andrew Morton6b44003e2009-04-09 09:50:37 -06003673static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003674{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003675 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003676 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b44003e2009-04-09 09:50:37 -06003677 complete(&wfc->completion);
3678 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003679}
3680
3681/**
3682 * work_on_cpu - run a function in user context on a particular cpu
3683 * @cpu: the cpu to run on
3684 * @fn: the function to run
3685 * @arg: the function arg
3686 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003687 * This will return the value @fn returns.
3688 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06003689 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003690 */
3691long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3692{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003693 struct task_struct *sub_thread;
3694 struct work_for_cpu wfc = {
3695 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3696 .fn = fn,
3697 .arg = arg,
3698 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003699
Andrew Morton6b44003e2009-04-09 09:50:37 -06003700 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3701 if (IS_ERR(sub_thread))
3702 return PTR_ERR(sub_thread);
3703 kthread_bind(sub_thread, cpu);
3704 wake_up_process(sub_thread);
3705 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003706 return wfc.ret;
3707}
3708EXPORT_SYMBOL_GPL(work_on_cpu);
3709#endif /* CONFIG_SMP */
3710
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003711#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303712
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003713/**
3714 * freeze_workqueues_begin - begin freezing workqueues
3715 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003716 * Start freezing workqueues. After this function returns, all freezable
3717 * workqueues will queue new works to their frozen_works list instead of
3718 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003719 *
3720 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003721 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003722 */
3723void freeze_workqueues_begin(void)
3724{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003725 unsigned int cpu;
3726
3727 spin_lock(&workqueue_lock);
3728
3729 BUG_ON(workqueue_freezing);
3730 workqueue_freezing = true;
3731
Tejun Heof3421792010-07-02 10:03:51 +02003732 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003733 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003734 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003735
3736 spin_lock_irq(&gcwq->lock);
3737
Tejun Heodb7bccf2010-06-29 10:07:12 +02003738 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3739 gcwq->flags |= GCWQ_FREEZING;
3740
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003741 list_for_each_entry(wq, &workqueues, list) {
3742 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3743
Tejun Heo58a69cb2011-02-16 09:25:31 +01003744 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003745 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003746 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003747
3748 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003749 }
3750
3751 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003752}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003753
3754/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003755 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003756 *
3757 * Check whether freezing is complete. This function must be called
3758 * between freeze_workqueues_begin() and thaw_workqueues().
3759 *
3760 * CONTEXT:
3761 * Grabs and releases workqueue_lock.
3762 *
3763 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003764 * %true if some freezable workqueues are still busy. %false if freezing
3765 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003766 */
3767bool freeze_workqueues_busy(void)
3768{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003769 unsigned int cpu;
3770 bool busy = false;
3771
3772 spin_lock(&workqueue_lock);
3773
3774 BUG_ON(!workqueue_freezing);
3775
Tejun Heof3421792010-07-02 10:03:51 +02003776 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003777 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003778 /*
3779 * nr_active is monotonically decreasing. It's safe
3780 * to peek without lock.
3781 */
3782 list_for_each_entry(wq, &workqueues, list) {
3783 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3784
Tejun Heo58a69cb2011-02-16 09:25:31 +01003785 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003786 continue;
3787
3788 BUG_ON(cwq->nr_active < 0);
3789 if (cwq->nr_active) {
3790 busy = true;
3791 goto out_unlock;
3792 }
3793 }
3794 }
3795out_unlock:
3796 spin_unlock(&workqueue_lock);
3797 return busy;
3798}
3799
3800/**
3801 * thaw_workqueues - thaw workqueues
3802 *
3803 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003804 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003805 *
3806 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003807 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003808 */
3809void thaw_workqueues(void)
3810{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003811 unsigned int cpu;
3812
3813 spin_lock(&workqueue_lock);
3814
3815 if (!workqueue_freezing)
3816 goto out_unlock;
3817
Tejun Heof3421792010-07-02 10:03:51 +02003818 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003819 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003820 struct worker_pool *pool;
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003821 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003822
3823 spin_lock_irq(&gcwq->lock);
3824
Tejun Heodb7bccf2010-06-29 10:07:12 +02003825 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3826 gcwq->flags &= ~GCWQ_FREEZING;
3827
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003828 list_for_each_entry(wq, &workqueues, list) {
3829 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3830
Tejun Heo58a69cb2011-02-16 09:25:31 +01003831 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003832 continue;
3833
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003834 /* restore max_active and repopulate worklist */
3835 cwq->max_active = wq->saved_max_active;
3836
3837 while (!list_empty(&cwq->delayed_works) &&
3838 cwq->nr_active < cwq->max_active)
3839 cwq_activate_first_delayed(cwq);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003840 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003841
Tejun Heo4ce62e92012-07-13 22:16:44 -07003842 for_each_worker_pool(pool, gcwq)
3843 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02003844
Tejun Heo8b03ae32010-06-29 10:07:12 +02003845 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003846 }
3847
3848 workqueue_freezing = false;
3849out_unlock:
3850 spin_unlock(&workqueue_lock);
3851}
3852#endif /* CONFIG_FREEZER */
3853
Suresh Siddha6ee05782010-07-30 14:57:37 -07003854static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003855{
Tejun Heoc34056a2010-06-29 10:07:11 +02003856 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003857 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003858
Tejun Heob5490072012-08-03 10:30:46 -07003859 /* make sure we have enough bits for OFFQ CPU number */
3860 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3861 WORK_CPU_LAST);
3862
Tejun Heo65758202012-07-17 12:39:26 -07003863 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3864 cpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003865
3866 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003867 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003868 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003869 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003870
3871 spin_lock_init(&gcwq->lock);
3872 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003873 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003874
Tejun Heoc8e55f32010-06-29 10:07:12 +02003875 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3876 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3877
Tejun Heo4ce62e92012-07-13 22:16:44 -07003878 for_each_worker_pool(pool, gcwq) {
3879 pool->gcwq = gcwq;
3880 INIT_LIST_HEAD(&pool->worklist);
3881 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoe22bee72010-06-29 10:07:14 +02003882
Tejun Heo4ce62e92012-07-13 22:16:44 -07003883 init_timer_deferrable(&pool->idle_timer);
3884 pool->idle_timer.function = idle_worker_timeout;
3885 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003886
Tejun Heo4ce62e92012-07-13 22:16:44 -07003887 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3888 (unsigned long)pool);
3889
Tejun Heo60373152012-07-17 12:39:27 -07003890 mutex_init(&pool->manager_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003891 ida_init(&pool->worker_ida);
3892 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003893
Tejun Heo25511a42012-07-17 12:39:27 -07003894 init_waitqueue_head(&gcwq->rebind_hold);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003895 }
3896
Tejun Heoe22bee72010-06-29 10:07:14 +02003897 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003898 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003899 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003900 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003901
Tejun Heo477a3c32010-08-31 10:54:35 +02003902 if (cpu != WORK_CPU_UNBOUND)
3903 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003904
3905 for_each_worker_pool(pool, gcwq) {
3906 struct worker *worker;
3907
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003908 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003909 BUG_ON(!worker);
3910 spin_lock_irq(&gcwq->lock);
3911 start_worker(worker);
3912 spin_unlock_irq(&gcwq->lock);
3913 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003914 }
3915
Tejun Heod320c032010-06-29 10:07:14 +02003916 system_wq = alloc_workqueue("events", 0, 0);
3917 system_long_wq = alloc_workqueue("events_long", 0, 0);
3918 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003919 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3920 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003921 system_freezable_wq = alloc_workqueue("events_freezable",
3922 WQ_FREEZABLE, 0);
Alan Stern62d3c542012-03-02 10:51:00 +01003923 system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
3924 WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
Hitoshi Mitakee5cba242010-11-26 12:06:44 +01003925 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
Alan Stern62d3c542012-03-02 10:51:00 +01003926 !system_unbound_wq || !system_freezable_wq ||
3927 !system_nrt_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003928 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003929}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003930early_initcall(init_workqueues);