blob: b5fe4c00eb3c9de169557404444dbb4b222615f6 [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
26#include <linux/module.h>
27#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 Heodb7bccf2010-06-29 10:07:12 +020048 /* global_cwq flags */
Tejun Heoe22bee72010-06-29 10:07:14 +020049 GCWQ_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
50 GCWQ_MANAGING_WORKERS = 1 << 1, /* managing workers */
51 GCWQ_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020052 GCWQ_FREEZING = 1 << 3, /* freeze in progress */
Tejun Heo649027d2010-06-29 10:07:14 +020053 GCWQ_HIGHPRI_PENDING = 1 << 4, /* highpri works on queue */
Tejun Heodb7bccf2010-06-29 10:07:12 +020054
Tejun Heoc8e55f32010-06-29 10:07:12 +020055 /* worker flags */
56 WORKER_STARTED = 1 << 0, /* started */
57 WORKER_DIE = 1 << 1, /* die die die */
58 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020059 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heodb7bccf2010-06-29 10:07:12 +020060 WORKER_ROGUE = 1 << 4, /* not bound to any cpu */
Tejun Heoe22bee72010-06-29 10:07:14 +020061 WORKER_REBIND = 1 << 5, /* mom is home, come back */
Tejun Heofb0e7be2010-06-29 10:07:15 +020062 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020063 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020064
Tejun Heofb0e7be2010-06-29 10:07:15 +020065 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_ROGUE | WORKER_REBIND |
Tejun Heof3421792010-07-02 10:03:51 +020066 WORKER_CPU_INTENSIVE | WORKER_UNBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020067
68 /* gcwq->trustee_state */
69 TRUSTEE_START = 0, /* start */
70 TRUSTEE_IN_CHARGE = 1, /* trustee in charge of gcwq */
71 TRUSTEE_BUTCHER = 2, /* butcher workers */
72 TRUSTEE_RELEASE = 3, /* release workers */
73 TRUSTEE_DONE = 4, /* trustee is done */
Tejun Heoc8e55f32010-06-29 10:07:12 +020074
75 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
76 BUSY_WORKER_HASH_SIZE = 1 << BUSY_WORKER_HASH_ORDER,
77 BUSY_WORKER_HASH_MASK = BUSY_WORKER_HASH_SIZE - 1,
Tejun Heodb7bccf2010-06-29 10:07:12 +020078
Tejun Heoe22bee72010-06-29 10:07:14 +020079 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
80 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
81
Tejun Heo3233cdb2011-02-16 18:10:19 +010082 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
83 /* call for help after 10ms
84 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020085 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
86 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heodb7bccf2010-06-29 10:07:12 +020087 TRUSTEE_COOLDOWN = HZ / 10, /* for trustee draining */
Tejun Heoe22bee72010-06-29 10:07:14 +020088
89 /*
90 * Rescue workers are used only on emergencies and shared by
91 * all cpus. Give -20.
92 */
93 RESCUER_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +020094};
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
96/*
Tejun Heo4690c4a2010-06-29 10:07:10 +020097 * Structure fields follow one of the following exclusion rules.
98 *
Tejun Heoe41e7042010-08-24 14:22:47 +020099 * I: Modifiable by initialization/destruction paths and read-only for
100 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200101 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200102 * P: Preemption protected. Disabling preemption is enough and should
103 * only be modified and accessed from the local cpu.
104 *
Tejun Heo8b03ae32010-06-29 10:07:12 +0200105 * L: gcwq->lock protected. Access with gcwq->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200106 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200107 * X: During normal operation, modification requires gcwq->lock and
108 * should be done only from local cpu. Either disabling preemption
109 * on local cpu or grabbing gcwq->lock is enough for read access.
Tejun Heof3421792010-07-02 10:03:51 +0200110 * If GCWQ_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200111 *
Tejun Heo73f53c42010-06-29 10:07:11 +0200112 * F: wq->flush_mutex protected.
113 *
Tejun Heo4690c4a2010-06-29 10:07:10 +0200114 * W: workqueue_lock protected.
115 */
116
Tejun Heo8b03ae32010-06-29 10:07:12 +0200117struct global_cwq;
Tejun Heoc34056a2010-06-29 10:07:11 +0200118
Tejun Heoe22bee72010-06-29 10:07:14 +0200119/*
120 * The poor guys doing the actual heavy lifting. All on-duty workers
121 * are either serving the manager role, on idle list or on busy hash.
122 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200123struct worker {
Tejun Heoc8e55f32010-06-29 10:07:12 +0200124 /* on idle list while idle, on busy hash table while busy */
125 union {
126 struct list_head entry; /* L: while idle */
127 struct hlist_node hentry; /* L: while busy */
128 };
129
Tejun Heoc34056a2010-06-29 10:07:11 +0200130 struct work_struct *current_work; /* L: work being processed */
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200131 struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
Tejun Heoaffee4b2010-06-29 10:07:12 +0200132 struct list_head scheduled; /* L: scheduled works */
Tejun Heoc34056a2010-06-29 10:07:11 +0200133 struct task_struct *task; /* I: worker task */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200134 struct global_cwq *gcwq; /* I: the associated gcwq */
Tejun Heoe22bee72010-06-29 10:07:14 +0200135 /* 64 bytes boundary on 64bit, 32 on 32bit */
136 unsigned long last_active; /* L: last active timestamp */
137 unsigned int flags; /* X: flags */
Tejun Heoc34056a2010-06-29 10:07:11 +0200138 int id; /* I: worker id */
Tejun Heoe22bee72010-06-29 10:07:14 +0200139 struct work_struct rebind_work; /* L: rebind worker to cpu */
Tejun Heoc34056a2010-06-29 10:07:11 +0200140};
141
Tejun Heo4690c4a2010-06-29 10:07:10 +0200142/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200143 * Global per-cpu workqueue. There's one and only one for each cpu
144 * and all works are queued and processed here regardless of their
145 * target workqueues.
Tejun Heo8b03ae32010-06-29 10:07:12 +0200146 */
147struct global_cwq {
148 spinlock_t lock; /* the gcwq lock */
Tejun Heo7e116292010-06-29 10:07:13 +0200149 struct list_head worklist; /* L: list of pending works */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200150 unsigned int cpu; /* I: the associated cpu */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200151 unsigned int flags; /* L: GCWQ_* flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200152
153 int nr_workers; /* L: total number of workers */
154 int nr_idle; /* L: currently idle ones */
155
156 /* workers are chained either in the idle_list or busy_hash */
Tejun Heoe22bee72010-06-29 10:07:14 +0200157 struct list_head idle_list; /* X: list of idle workers */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200158 struct hlist_head busy_hash[BUSY_WORKER_HASH_SIZE];
159 /* L: hash of busy workers */
160
Tejun Heoe22bee72010-06-29 10:07:14 +0200161 struct timer_list idle_timer; /* L: worker idle timeout */
162 struct timer_list mayday_timer; /* L: SOS timer for dworkers */
163
Tejun Heo8b03ae32010-06-29 10:07:12 +0200164 struct ida worker_ida; /* L: for worker IDs */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200165
166 struct task_struct *trustee; /* L: for gcwq shutdown */
167 unsigned int trustee_state; /* L: trustee state */
168 wait_queue_head_t trustee_wait; /* trustee wait */
Tejun Heoe22bee72010-06-29 10:07:14 +0200169 struct worker *first_idle; /* L: first idle worker */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200170} ____cacheline_aligned_in_smp;
171
172/*
Tejun Heo502ca9d2010-06-29 10:07:13 +0200173 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
Tejun Heo0f900042010-06-29 10:07:11 +0200174 * work_struct->data are used for flags and thus cwqs need to be
175 * aligned at two's power of the number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 */
177struct cpu_workqueue_struct {
Tejun Heo8b03ae32010-06-29 10:07:12 +0200178 struct global_cwq *gcwq; /* I: the associated gcwq */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200179 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200180 int work_color; /* L: current color */
181 int flush_color; /* L: flushing color */
182 int nr_in_flight[WORK_NR_COLORS];
183 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200184 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200185 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200186 struct list_head delayed_works; /* L: delayed works */
Tejun Heo0f900042010-06-29 10:07:11 +0200187};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200190 * Structure used to wait for workqueue flush.
191 */
192struct wq_flusher {
193 struct list_head list; /* F: list of flushers */
194 int flush_color; /* F: flush color waiting for */
195 struct completion done; /* flush completion */
196};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
Tejun Heo73f53c42010-06-29 10:07:11 +0200198/*
Tejun Heof2e005a2010-07-20 15:59:09 +0200199 * All cpumasks are assumed to be always set on UP and thus can't be
200 * used to determine whether there's something to be done.
201 */
202#ifdef CONFIG_SMP
203typedef cpumask_var_t mayday_mask_t;
204#define mayday_test_and_set_cpu(cpu, mask) \
205 cpumask_test_and_set_cpu((cpu), (mask))
206#define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
207#define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
Tejun Heo9c375472010-08-31 11:18:34 +0200208#define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
Tejun Heof2e005a2010-07-20 15:59:09 +0200209#define free_mayday_mask(mask) free_cpumask_var((mask))
210#else
211typedef unsigned long mayday_mask_t;
212#define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
213#define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
214#define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
215#define alloc_mayday_mask(maskp, gfp) true
216#define free_mayday_mask(mask) do { } while (0)
217#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219/*
220 * The externally visible workqueue abstraction is an array of
221 * per-CPU workqueues:
222 */
223struct workqueue_struct {
Tejun Heo97e37d72010-06-29 10:07:10 +0200224 unsigned int flags; /* I: WQ_* flags */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200225 union {
226 struct cpu_workqueue_struct __percpu *pcpu;
227 struct cpu_workqueue_struct *single;
228 unsigned long v;
229 } cpu_wq; /* I: cwq's */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200230 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200231
232 struct mutex flush_mutex; /* protects wq flushing */
233 int work_color; /* F: current work color */
234 int flush_color; /* F: current flush color */
235 atomic_t nr_cwqs_to_flush; /* flush in progress */
236 struct wq_flusher *first_flusher; /* F: first flusher */
237 struct list_head flusher_queue; /* F: flush waiters */
238 struct list_head flusher_overflow; /* F: flush overflow list */
239
Tejun Heof2e005a2010-07-20 15:59:09 +0200240 mayday_mask_t mayday_mask; /* cpus requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200241 struct worker *rescuer; /* I: rescue worker */
242
Tejun Heodcd989c2010-06-29 10:07:14 +0200243 int saved_max_active; /* W: saved cwq max_active */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200244 const char *name; /* I: workqueue name */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700245#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200246 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700247#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248};
249
Tejun Heod320c032010-06-29 10:07:14 +0200250struct workqueue_struct *system_wq __read_mostly;
251struct workqueue_struct *system_long_wq __read_mostly;
252struct workqueue_struct *system_nrt_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200253struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200254EXPORT_SYMBOL_GPL(system_wq);
255EXPORT_SYMBOL_GPL(system_long_wq);
256EXPORT_SYMBOL_GPL(system_nrt_wq);
Tejun Heof3421792010-07-02 10:03:51 +0200257EXPORT_SYMBOL_GPL(system_unbound_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200258
Tejun Heo97bd2342010-10-05 10:41:14 +0200259#define CREATE_TRACE_POINTS
260#include <trace/events/workqueue.h>
261
Tejun Heodb7bccf2010-06-29 10:07:12 +0200262#define for_each_busy_worker(worker, i, pos, gcwq) \
263 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
264 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
265
Tejun Heof3421792010-07-02 10:03:51 +0200266static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
267 unsigned int sw)
268{
269 if (cpu < nr_cpu_ids) {
270 if (sw & 1) {
271 cpu = cpumask_next(cpu, mask);
272 if (cpu < nr_cpu_ids)
273 return cpu;
274 }
275 if (sw & 2)
276 return WORK_CPU_UNBOUND;
277 }
278 return WORK_CPU_NONE;
279}
280
281static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
282 struct workqueue_struct *wq)
283{
284 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
285}
286
Tejun Heo09884952010-08-01 11:50:12 +0200287/*
288 * CPU iterators
289 *
290 * An extra gcwq is defined for an invalid cpu number
291 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
292 * specific CPU. The following iterators are similar to
293 * for_each_*_cpu() iterators but also considers the unbound gcwq.
294 *
295 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
296 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
297 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
298 * WORK_CPU_UNBOUND for unbound workqueues
299 */
Tejun Heof3421792010-07-02 10:03:51 +0200300#define for_each_gcwq_cpu(cpu) \
301 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
302 (cpu) < WORK_CPU_NONE; \
303 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
304
305#define for_each_online_gcwq_cpu(cpu) \
306 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
307 (cpu) < WORK_CPU_NONE; \
308 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
309
310#define for_each_cwq_cpu(cpu, wq) \
311 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
312 (cpu) < WORK_CPU_NONE; \
313 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
314
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900315#ifdef CONFIG_DEBUG_OBJECTS_WORK
316
317static struct debug_obj_descr work_debug_descr;
318
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100319static void *work_debug_hint(void *addr)
320{
321 return ((struct work_struct *) addr)->func;
322}
323
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900324/*
325 * fixup_init is called when:
326 * - an active object is initialized
327 */
328static int work_fixup_init(void *addr, enum debug_obj_state state)
329{
330 struct work_struct *work = addr;
331
332 switch (state) {
333 case ODEBUG_STATE_ACTIVE:
334 cancel_work_sync(work);
335 debug_object_init(work, &work_debug_descr);
336 return 1;
337 default:
338 return 0;
339 }
340}
341
342/*
343 * fixup_activate is called when:
344 * - an active object is activated
345 * - an unknown object is activated (might be a statically initialized object)
346 */
347static int work_fixup_activate(void *addr, enum debug_obj_state state)
348{
349 struct work_struct *work = addr;
350
351 switch (state) {
352
353 case ODEBUG_STATE_NOTAVAILABLE:
354 /*
355 * This is not really a fixup. The work struct was
356 * statically initialized. We just make sure that it
357 * is tracked in the object tracker.
358 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200359 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900360 debug_object_init(work, &work_debug_descr);
361 debug_object_activate(work, &work_debug_descr);
362 return 0;
363 }
364 WARN_ON_ONCE(1);
365 return 0;
366
367 case ODEBUG_STATE_ACTIVE:
368 WARN_ON(1);
369
370 default:
371 return 0;
372 }
373}
374
375/*
376 * fixup_free is called when:
377 * - an active object is freed
378 */
379static int work_fixup_free(void *addr, enum debug_obj_state state)
380{
381 struct work_struct *work = addr;
382
383 switch (state) {
384 case ODEBUG_STATE_ACTIVE:
385 cancel_work_sync(work);
386 debug_object_free(work, &work_debug_descr);
387 return 1;
388 default:
389 return 0;
390 }
391}
392
393static struct debug_obj_descr work_debug_descr = {
394 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100395 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900396 .fixup_init = work_fixup_init,
397 .fixup_activate = work_fixup_activate,
398 .fixup_free = work_fixup_free,
399};
400
401static inline void debug_work_activate(struct work_struct *work)
402{
403 debug_object_activate(work, &work_debug_descr);
404}
405
406static inline void debug_work_deactivate(struct work_struct *work)
407{
408 debug_object_deactivate(work, &work_debug_descr);
409}
410
411void __init_work(struct work_struct *work, int onstack)
412{
413 if (onstack)
414 debug_object_init_on_stack(work, &work_debug_descr);
415 else
416 debug_object_init(work, &work_debug_descr);
417}
418EXPORT_SYMBOL_GPL(__init_work);
419
420void destroy_work_on_stack(struct work_struct *work)
421{
422 debug_object_free(work, &work_debug_descr);
423}
424EXPORT_SYMBOL_GPL(destroy_work_on_stack);
425
426#else
427static inline void debug_work_activate(struct work_struct *work) { }
428static inline void debug_work_deactivate(struct work_struct *work) { }
429#endif
430
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100431/* Serializes the accesses to the list of workqueues. */
432static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200434static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
Oleg Nesterov14441962007-05-23 13:57:57 -0700436/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200437 * The almighty global cpu workqueues. nr_running is the only field
438 * which is expected to be used frequently by other cpus via
439 * try_to_wake_up(). Put it in a separate cacheline.
Oleg Nesterov14441962007-05-23 13:57:57 -0700440 */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200441static DEFINE_PER_CPU(struct global_cwq, global_cwq);
Tejun Heoe22bee72010-06-29 10:07:14 +0200442static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running);
Nathan Lynchf756d5e2006-01-08 01:05:12 -0800443
Tejun Heof3421792010-07-02 10:03:51 +0200444/*
445 * Global cpu workqueue and nr_running counter for unbound gcwq. The
446 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
447 * workers have WORKER_UNBOUND set.
448 */
449static struct global_cwq unbound_global_cwq;
450static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0); /* always 0 */
451
Tejun Heoc34056a2010-06-29 10:07:11 +0200452static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
Tejun Heo8b03ae32010-06-29 10:07:12 +0200454static struct global_cwq *get_gcwq(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
Tejun Heof3421792010-07-02 10:03:51 +0200456 if (cpu != WORK_CPU_UNBOUND)
457 return &per_cpu(global_cwq, cpu);
458 else
459 return &unbound_global_cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460}
461
Tejun Heoe22bee72010-06-29 10:07:14 +0200462static atomic_t *get_gcwq_nr_running(unsigned int cpu)
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700463{
Tejun Heof3421792010-07-02 10:03:51 +0200464 if (cpu != WORK_CPU_UNBOUND)
465 return &per_cpu(gcwq_nr_running, cpu);
466 else
467 return &unbound_gcwq_nr_running;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700468}
469
Tejun Heo4690c4a2010-06-29 10:07:10 +0200470static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
471 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700472{
Tejun Heof3421792010-07-02 10:03:51 +0200473 if (!(wq->flags & WQ_UNBOUND)) {
474 if (likely(cpu < nr_cpu_ids)) {
475#ifdef CONFIG_SMP
476 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200477#else
Tejun Heof3421792010-07-02 10:03:51 +0200478 return wq->cpu_wq.single;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200479#endif
Tejun Heof3421792010-07-02 10:03:51 +0200480 }
481 } else if (likely(cpu == WORK_CPU_UNBOUND))
482 return wq->cpu_wq.single;
483 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700484}
485
Tejun Heo73f53c42010-06-29 10:07:11 +0200486static unsigned int work_color_to_flags(int color)
487{
488 return color << WORK_STRUCT_COLOR_SHIFT;
489}
490
491static int get_work_color(struct work_struct *work)
492{
493 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
494 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
495}
496
497static int work_next_color(int color)
498{
499 return (color + 1) % WORK_NR_COLORS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500}
501
David Howells4594bf12006-12-07 11:33:26 +0000502/*
Tejun Heoe1201532010-07-22 14:14:25 +0200503 * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
504 * work is on queue. Once execution starts, WORK_STRUCT_CWQ is
505 * cleared and the work data contains the cpu number it was last on.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200506 *
507 * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
508 * cwq, cpu or clear work->data. These functions should only be
509 * called while the work is owned - ie. while the PENDING bit is set.
510 *
511 * get_work_[g]cwq() can be used to obtain the gcwq or cwq
512 * corresponding to a work. gcwq is available once the work has been
513 * queued anywhere after initialization. cwq is available only from
514 * queueing until execution starts.
David Howells4594bf12006-12-07 11:33:26 +0000515 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200516static inline void set_work_data(struct work_struct *work, unsigned long data,
517 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000518{
David Howells4594bf12006-12-07 11:33:26 +0000519 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200520 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000521}
David Howells365970a2006-11-22 14:54:49 +0000522
Tejun Heo7a22ad72010-06-29 10:07:13 +0200523static void set_work_cwq(struct work_struct *work,
524 struct cpu_workqueue_struct *cwq,
525 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200526{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200527 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200528 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200529}
530
Tejun Heo7a22ad72010-06-29 10:07:13 +0200531static void set_work_cpu(struct work_struct *work, unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000532{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200533 set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
534}
535
536static void clear_work_data(struct work_struct *work)
537{
538 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
539}
540
Tejun Heo7a22ad72010-06-29 10:07:13 +0200541static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
542{
Tejun Heoe1201532010-07-22 14:14:25 +0200543 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200544
Tejun Heoe1201532010-07-22 14:14:25 +0200545 if (data & WORK_STRUCT_CWQ)
546 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
547 else
548 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200549}
550
551static struct global_cwq *get_work_gcwq(struct work_struct *work)
552{
Tejun Heoe1201532010-07-22 14:14:25 +0200553 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200554 unsigned int cpu;
555
Tejun Heoe1201532010-07-22 14:14:25 +0200556 if (data & WORK_STRUCT_CWQ)
557 return ((struct cpu_workqueue_struct *)
558 (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200559
560 cpu = data >> WORK_STRUCT_FLAG_BITS;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200561 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200562 return NULL;
563
Tejun Heof3421792010-07-02 10:03:51 +0200564 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200565 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000566}
567
568/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200569 * Policy functions. These define the policies on how the global
570 * worker pool is managed. Unless noted otherwise, these functions
571 * assume that they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000572 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200573
Tejun Heo649027d2010-06-29 10:07:14 +0200574static bool __need_more_worker(struct global_cwq *gcwq)
David Howells365970a2006-11-22 14:54:49 +0000575{
Tejun Heo649027d2010-06-29 10:07:14 +0200576 return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
577 gcwq->flags & GCWQ_HIGHPRI_PENDING;
David Howells365970a2006-11-22 14:54:49 +0000578}
579
Tejun Heoe22bee72010-06-29 10:07:14 +0200580/*
581 * Need to wake up a worker? Called from anything but currently
582 * running workers.
583 */
584static bool need_more_worker(struct global_cwq *gcwq)
David Howells365970a2006-11-22 14:54:49 +0000585{
Tejun Heo649027d2010-06-29 10:07:14 +0200586 return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
David Howells365970a2006-11-22 14:54:49 +0000587}
588
Tejun Heoe22bee72010-06-29 10:07:14 +0200589/* Can I start working? Called from busy but !running workers. */
590static bool may_start_working(struct global_cwq *gcwq)
591{
592 return gcwq->nr_idle;
593}
594
595/* Do I need to keep working? Called from currently running workers. */
596static bool keep_working(struct global_cwq *gcwq)
597{
598 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
599
Tejun Heo30310042010-10-11 11:51:57 +0200600 return !list_empty(&gcwq->worklist) &&
601 (atomic_read(nr_running) <= 1 ||
602 gcwq->flags & GCWQ_HIGHPRI_PENDING);
Tejun Heoe22bee72010-06-29 10:07:14 +0200603}
604
605/* Do we need a new worker? Called from manager. */
606static bool need_to_create_worker(struct global_cwq *gcwq)
607{
608 return need_more_worker(gcwq) && !may_start_working(gcwq);
609}
610
611/* Do I need to be the manager? */
612static bool need_to_manage_workers(struct global_cwq *gcwq)
613{
614 return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
615}
616
617/* Do we have too many workers and should some go away? */
618static bool too_many_workers(struct global_cwq *gcwq)
619{
620 bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
621 int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
622 int nr_busy = gcwq->nr_workers - nr_idle;
623
624 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
625}
626
627/*
628 * Wake up functions.
629 */
630
Tejun Heo7e116292010-06-29 10:07:13 +0200631/* Return the first worker. Safe with preemption disabled */
632static struct worker *first_worker(struct global_cwq *gcwq)
633{
634 if (unlikely(list_empty(&gcwq->idle_list)))
635 return NULL;
636
637 return list_first_entry(&gcwq->idle_list, struct worker, entry);
638}
639
640/**
641 * wake_up_worker - wake up an idle worker
642 * @gcwq: gcwq to wake worker for
643 *
644 * Wake up the first idle worker of @gcwq.
645 *
646 * CONTEXT:
647 * spin_lock_irq(gcwq->lock).
648 */
649static void wake_up_worker(struct global_cwq *gcwq)
650{
651 struct worker *worker = first_worker(gcwq);
652
653 if (likely(worker))
654 wake_up_process(worker->task);
655}
656
Tejun Heo4690c4a2010-06-29 10:07:10 +0200657/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200658 * wq_worker_waking_up - a worker is waking up
659 * @task: task waking up
660 * @cpu: CPU @task is waking up to
661 *
662 * This function is called during try_to_wake_up() when a worker is
663 * being awoken.
664 *
665 * CONTEXT:
666 * spin_lock_irq(rq->lock)
667 */
668void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
669{
670 struct worker *worker = kthread_data(task);
671
Steven Rostedt2d646722010-12-03 23:12:33 -0500672 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe22bee72010-06-29 10:07:14 +0200673 atomic_inc(get_gcwq_nr_running(cpu));
674}
675
676/**
677 * wq_worker_sleeping - a worker is going to sleep
678 * @task: task going to sleep
679 * @cpu: CPU in question, must be the current CPU number
680 *
681 * This function is called during schedule() when a busy worker is
682 * going to sleep. Worker on the same cpu can be woken up by
683 * returning pointer to its task.
684 *
685 * CONTEXT:
686 * spin_lock_irq(rq->lock)
687 *
688 * RETURNS:
689 * Worker task on @cpu to wake up, %NULL if none.
690 */
691struct task_struct *wq_worker_sleeping(struct task_struct *task,
692 unsigned int cpu)
693{
694 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
695 struct global_cwq *gcwq = get_gcwq(cpu);
696 atomic_t *nr_running = get_gcwq_nr_running(cpu);
697
Steven Rostedt2d646722010-12-03 23:12:33 -0500698 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200699 return NULL;
700
701 /* this can only happen on the local cpu */
702 BUG_ON(cpu != raw_smp_processor_id());
703
704 /*
705 * The counterpart of the following dec_and_test, implied mb,
706 * worklist not empty test sequence is in insert_work().
707 * Please read comment there.
708 *
709 * NOT_RUNNING is clear. This means that trustee is not in
710 * charge and we're running on the local cpu w/ rq lock held
711 * and preemption disabled, which in turn means that none else
712 * could be manipulating idle_list, so dereferencing idle_list
713 * without gcwq lock is safe.
714 */
715 if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
716 to_wakeup = first_worker(gcwq);
717 return to_wakeup ? to_wakeup->task : NULL;
718}
719
720/**
721 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200722 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200723 * @flags: flags to set
724 * @wakeup: wakeup an idle worker if necessary
725 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200726 * Set @flags in @worker->flags and adjust nr_running accordingly. If
727 * nr_running becomes zero and @wakeup is %true, an idle worker is
728 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200729 *
Tejun Heocb444762010-07-02 10:03:50 +0200730 * CONTEXT:
731 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200732 */
733static inline void worker_set_flags(struct worker *worker, unsigned int flags,
734 bool wakeup)
735{
Tejun Heoe22bee72010-06-29 10:07:14 +0200736 struct global_cwq *gcwq = worker->gcwq;
737
Tejun Heocb444762010-07-02 10:03:50 +0200738 WARN_ON_ONCE(worker->task != current);
739
Tejun Heoe22bee72010-06-29 10:07:14 +0200740 /*
741 * If transitioning into NOT_RUNNING, adjust nr_running and
742 * wake up an idle worker as necessary if requested by
743 * @wakeup.
744 */
745 if ((flags & WORKER_NOT_RUNNING) &&
746 !(worker->flags & WORKER_NOT_RUNNING)) {
747 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
748
749 if (wakeup) {
750 if (atomic_dec_and_test(nr_running) &&
751 !list_empty(&gcwq->worklist))
752 wake_up_worker(gcwq);
753 } else
754 atomic_dec(nr_running);
755 }
756
Tejun Heod302f012010-06-29 10:07:13 +0200757 worker->flags |= flags;
758}
759
760/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200761 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200762 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200763 * @flags: flags to clear
764 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200765 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200766 *
Tejun Heocb444762010-07-02 10:03:50 +0200767 * CONTEXT:
768 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200769 */
770static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
771{
Tejun Heoe22bee72010-06-29 10:07:14 +0200772 struct global_cwq *gcwq = worker->gcwq;
773 unsigned int oflags = worker->flags;
774
Tejun Heocb444762010-07-02 10:03:50 +0200775 WARN_ON_ONCE(worker->task != current);
776
Tejun Heod302f012010-06-29 10:07:13 +0200777 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200778
Tejun Heo42c025f2011-01-11 15:58:49 +0100779 /*
780 * If transitioning out of NOT_RUNNING, increment nr_running. Note
781 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
782 * of multiple flags, not a single flag.
783 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200784 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
785 if (!(worker->flags & WORKER_NOT_RUNNING))
786 atomic_inc(get_gcwq_nr_running(gcwq->cpu));
Tejun Heod302f012010-06-29 10:07:13 +0200787}
788
789/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200790 * busy_worker_head - return the busy hash head for a work
791 * @gcwq: gcwq of interest
792 * @work: work to be hashed
793 *
794 * Return hash head of @gcwq for @work.
795 *
796 * CONTEXT:
797 * spin_lock_irq(gcwq->lock).
798 *
799 * RETURNS:
800 * Pointer to the hash head.
801 */
802static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
803 struct work_struct *work)
804{
805 const int base_shift = ilog2(sizeof(struct work_struct));
806 unsigned long v = (unsigned long)work;
807
808 /* simple shift and fold hash, do we need something better? */
809 v >>= base_shift;
810 v += v >> BUSY_WORKER_HASH_ORDER;
811 v &= BUSY_WORKER_HASH_MASK;
812
813 return &gcwq->busy_hash[v];
814}
815
816/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200817 * __find_worker_executing_work - find worker which is executing a work
818 * @gcwq: gcwq of interest
819 * @bwh: hash head as returned by busy_worker_head()
820 * @work: work to find worker for
821 *
822 * Find a worker which is executing @work on @gcwq. @bwh should be
823 * the hash head obtained by calling busy_worker_head() with the same
824 * work.
825 *
826 * CONTEXT:
827 * spin_lock_irq(gcwq->lock).
828 *
829 * RETURNS:
830 * Pointer to worker which is executing @work if found, NULL
831 * otherwise.
832 */
833static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
834 struct hlist_head *bwh,
835 struct work_struct *work)
836{
837 struct worker *worker;
838 struct hlist_node *tmp;
839
840 hlist_for_each_entry(worker, tmp, bwh, hentry)
841 if (worker->current_work == work)
842 return worker;
843 return NULL;
844}
845
846/**
847 * find_worker_executing_work - find worker which is executing a work
848 * @gcwq: gcwq of interest
849 * @work: work to find worker for
850 *
851 * Find a worker which is executing @work on @gcwq. This function is
852 * identical to __find_worker_executing_work() except that this
853 * function calculates @bwh itself.
854 *
855 * CONTEXT:
856 * spin_lock_irq(gcwq->lock).
857 *
858 * RETURNS:
859 * Pointer to worker which is executing @work if found, NULL
860 * otherwise.
861 */
862static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
863 struct work_struct *work)
864{
865 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
866 work);
867}
868
869/**
Tejun Heo649027d2010-06-29 10:07:14 +0200870 * gcwq_determine_ins_pos - find insertion position
871 * @gcwq: gcwq of interest
872 * @cwq: cwq a work is being queued for
873 *
874 * A work for @cwq is about to be queued on @gcwq, determine insertion
875 * position for the work. If @cwq is for HIGHPRI wq, the work is
876 * queued at the head of the queue but in FIFO order with respect to
877 * other HIGHPRI works; otherwise, at the end of the queue. This
878 * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
879 * there are HIGHPRI works pending.
880 *
881 * CONTEXT:
882 * spin_lock_irq(gcwq->lock).
883 *
884 * RETURNS:
885 * Pointer to inserstion position.
886 */
887static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
888 struct cpu_workqueue_struct *cwq)
889{
890 struct work_struct *twork;
891
892 if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
893 return &gcwq->worklist;
894
895 list_for_each_entry(twork, &gcwq->worklist, entry) {
896 struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
897
898 if (!(tcwq->wq->flags & WQ_HIGHPRI))
899 break;
900 }
901
902 gcwq->flags |= GCWQ_HIGHPRI_PENDING;
903 return &twork->entry;
904}
905
906/**
Tejun Heo7e116292010-06-29 10:07:13 +0200907 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +0200908 * @cwq: cwq @work belongs to
909 * @work: work to insert
910 * @head: insertion point
911 * @extra_flags: extra WORK_STRUCT_* flags to set
912 *
Tejun Heo7e116292010-06-29 10:07:13 +0200913 * Insert @work which belongs to @cwq into @gcwq after @head.
914 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200915 *
916 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200917 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +0200918 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700919static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +0200920 struct work_struct *work, struct list_head *head,
921 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700922{
Tejun Heoe22bee72010-06-29 10:07:14 +0200923 struct global_cwq *gcwq = cwq->gcwq;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100924
Tejun Heo4690c4a2010-06-29 10:07:10 +0200925 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200926 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +0200927
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700928 /*
929 * Ensure that we get the right work->data if we see the
930 * result of list_add() below, see try_to_grab_pending().
931 */
932 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +0200933
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700934 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +0200935
936 /*
937 * Ensure either worker_sched_deactivated() sees the above
938 * list_add_tail() or we see zero nr_running to avoid workers
939 * lying around lazily while there are works to be processed.
940 */
941 smp_mb();
942
Tejun Heo649027d2010-06-29 10:07:14 +0200943 if (__need_more_worker(gcwq))
Tejun Heoe22bee72010-06-29 10:07:14 +0200944 wake_up_worker(gcwq);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700945}
946
Tejun Heoc8efcc22010-12-20 19:32:04 +0100947/*
948 * Test whether @work is being queued from another work executing on the
949 * same workqueue. This is rather expensive and should only be used from
950 * cold paths.
951 */
952static bool is_chained_work(struct workqueue_struct *wq)
953{
954 unsigned long flags;
955 unsigned int cpu;
956
957 for_each_gcwq_cpu(cpu) {
958 struct global_cwq *gcwq = get_gcwq(cpu);
959 struct worker *worker;
960 struct hlist_node *pos;
961 int i;
962
963 spin_lock_irqsave(&gcwq->lock, flags);
964 for_each_busy_worker(worker, i, pos, gcwq) {
965 if (worker->task != current)
966 continue;
967 spin_unlock_irqrestore(&gcwq->lock, flags);
968 /*
969 * I'm @worker, no locking necessary. See if @work
970 * is headed to the same workqueue.
971 */
972 return worker->current_cwq->wq == wq;
973 }
974 spin_unlock_irqrestore(&gcwq->lock, flags);
975 }
976 return false;
977}
978
Tejun Heo4690c4a2010-06-29 10:07:10 +0200979static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 struct work_struct *work)
981{
Tejun Heo502ca9d2010-06-29 10:07:13 +0200982 struct global_cwq *gcwq;
983 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200984 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +0200985 unsigned int work_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 unsigned long flags;
987
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900988 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200989
Tejun Heoc8efcc22010-12-20 19:32:04 +0100990 /* if dying, only works from the same workqueue are allowed */
991 if (unlikely(wq->flags & WQ_DYING) &&
992 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +0200993 return;
994
Tejun Heoc7fc77f2010-07-02 10:03:51 +0200995 /* determine gcwq to use */
996 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +0200997 struct global_cwq *last_gcwq;
998
Tejun Heoc7fc77f2010-07-02 10:03:51 +0200999 if (unlikely(cpu == WORK_CPU_UNBOUND))
1000 cpu = raw_smp_processor_id();
1001
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001002 /*
1003 * It's multi cpu. If @wq is non-reentrant and @work
1004 * was previously on a different cpu, it might still
1005 * be running there, in which case the work needs to
1006 * be queued on that cpu to guarantee non-reentrance.
1007 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001008 gcwq = get_gcwq(cpu);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001009 if (wq->flags & WQ_NON_REENTRANT &&
1010 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1011 struct worker *worker;
1012
1013 spin_lock_irqsave(&last_gcwq->lock, flags);
1014
1015 worker = find_worker_executing_work(last_gcwq, work);
1016
1017 if (worker && worker->current_cwq->wq == wq)
1018 gcwq = last_gcwq;
1019 else {
1020 /* meh... not running there, queue here */
1021 spin_unlock_irqrestore(&last_gcwq->lock, flags);
1022 spin_lock_irqsave(&gcwq->lock, flags);
1023 }
1024 } else
1025 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heof3421792010-07-02 10:03:51 +02001026 } else {
1027 gcwq = get_gcwq(WORK_CPU_UNBOUND);
1028 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001029 }
1030
1031 /* gcwq determined, get cwq and queue */
1032 cwq = get_cwq(gcwq->cpu, wq);
Tejun Heocdadf002010-10-05 10:49:55 +02001033 trace_workqueue_queue_work(cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001034
Tejun Heo4690c4a2010-06-29 10:07:10 +02001035 BUG_ON(!list_empty(&work->entry));
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001036
Tejun Heo73f53c42010-06-29 10:07:11 +02001037 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001038 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001039
1040 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001041 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001042 cwq->nr_active++;
Tejun Heo649027d2010-06-29 10:07:14 +02001043 worklist = gcwq_determine_ins_pos(gcwq, cwq);
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001044 } else {
1045 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001046 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001047 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001048
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001049 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001050
Tejun Heo8b03ae32010-06-29 10:07:12 +02001051 spin_unlock_irqrestore(&gcwq->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052}
1053
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001054/**
1055 * queue_work - queue work on a workqueue
1056 * @wq: workqueue to use
1057 * @work: work to queue
1058 *
Alan Stern057647f2006-10-28 10:38:58 -07001059 * Returns 0 if @work was already on a queue, non-zero otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 *
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07001061 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1062 * it can be processed by another CPU.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001064int queue_work(struct workqueue_struct *wq, struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065{
Oleg Nesterovef1ca232008-07-25 01:47:53 -07001066 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067
Oleg Nesterovef1ca232008-07-25 01:47:53 -07001068 ret = queue_work_on(get_cpu(), wq, work);
1069 put_cpu();
1070
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 return ret;
1072}
Dave Jonesae90dd52006-06-30 01:40:45 -04001073EXPORT_SYMBOL_GPL(queue_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
Zhang Ruic1a220e2008-07-23 21:28:39 -07001075/**
1076 * queue_work_on - queue work on specific cpu
1077 * @cpu: CPU number to execute work on
1078 * @wq: workqueue to use
1079 * @work: work to queue
1080 *
1081 * Returns 0 if @work was already on a queue, non-zero otherwise.
1082 *
1083 * We queue the work to a specific CPU, the caller must ensure it
1084 * can't go away.
1085 */
1086int
1087queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1088{
1089 int ret = 0;
1090
Tejun Heo22df02b2010-06-29 10:07:10 +02001091 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001092 __queue_work(cpu, wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001093 ret = 1;
1094 }
1095 return ret;
1096}
1097EXPORT_SYMBOL_GPL(queue_work_on);
1098
Li Zefan6d141c32008-02-08 04:21:09 -08001099static void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100{
David Howells52bad642006-11-22 14:54:01 +00001101 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001102 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103
Tejun Heo4690c4a2010-06-29 10:07:10 +02001104 __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105}
1106
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001107/**
1108 * queue_delayed_work - queue work on a workqueue after delay
1109 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001110 * @dwork: delayable work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001111 * @delay: number of jiffies to wait before queueing
1112 *
Alan Stern057647f2006-10-28 10:38:58 -07001113 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001114 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001115int queue_delayed_work(struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +00001116 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117{
David Howells52bad642006-11-22 14:54:01 +00001118 if (delay == 0)
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001119 return queue_work(wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001121 return queue_delayed_work_on(-1, wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122}
Dave Jonesae90dd52006-06-30 01:40:45 -04001123EXPORT_SYMBOL_GPL(queue_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001125/**
1126 * queue_delayed_work_on - queue work on specific CPU after delay
1127 * @cpu: CPU number to execute work on
1128 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001129 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001130 * @delay: number of jiffies to wait before queueing
1131 *
Alan Stern057647f2006-10-28 10:38:58 -07001132 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001133 */
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001134int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +00001135 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001136{
1137 int ret = 0;
David Howells52bad642006-11-22 14:54:01 +00001138 struct timer_list *timer = &dwork->timer;
1139 struct work_struct *work = &dwork->work;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001140
Tejun Heo22df02b2010-06-29 10:07:10 +02001141 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001142 unsigned int lcpu;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001143
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001144 BUG_ON(timer_pending(timer));
1145 BUG_ON(!list_empty(&work->entry));
1146
Andrew Liu8a3e77c2008-05-01 04:35:14 -07001147 timer_stats_timer_set_start_info(&dwork->timer);
1148
Tejun Heo7a22ad72010-06-29 10:07:13 +02001149 /*
1150 * This stores cwq for the moment, for the timer_fn.
1151 * Note that the work's gcwq is preserved to allow
1152 * reentrance detection for delayed works.
1153 */
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001154 if (!(wq->flags & WQ_UNBOUND)) {
1155 struct global_cwq *gcwq = get_work_gcwq(work);
1156
1157 if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1158 lcpu = gcwq->cpu;
1159 else
1160 lcpu = raw_smp_processor_id();
1161 } else
1162 lcpu = WORK_CPU_UNBOUND;
1163
Tejun Heo7a22ad72010-06-29 10:07:13 +02001164 set_work_cwq(work, get_cwq(lcpu, wq), 0);
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001165
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001166 timer->expires = jiffies + delay;
David Howells52bad642006-11-22 14:54:01 +00001167 timer->data = (unsigned long)dwork;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001168 timer->function = delayed_work_timer_fn;
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001169
1170 if (unlikely(cpu >= 0))
1171 add_timer_on(timer, cpu);
1172 else
1173 add_timer(timer);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001174 ret = 1;
1175 }
1176 return ret;
1177}
Dave Jonesae90dd52006-06-30 01:40:45 -04001178EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179
Tejun Heoc8e55f32010-06-29 10:07:12 +02001180/**
1181 * worker_enter_idle - enter idle state
1182 * @worker: worker which is entering idle state
1183 *
1184 * @worker is entering idle state. Update stats and idle timer if
1185 * necessary.
1186 *
1187 * LOCKING:
1188 * spin_lock_irq(gcwq->lock).
1189 */
1190static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191{
Tejun Heoc8e55f32010-06-29 10:07:12 +02001192 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193
Tejun Heoc8e55f32010-06-29 10:07:12 +02001194 BUG_ON(worker->flags & WORKER_IDLE);
1195 BUG_ON(!list_empty(&worker->entry) &&
1196 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197
Tejun Heocb444762010-07-02 10:03:50 +02001198 /* can't use worker_set_flags(), also called from start_worker() */
1199 worker->flags |= WORKER_IDLE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001200 gcwq->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001201 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001202
Tejun Heoc8e55f32010-06-29 10:07:12 +02001203 /* idle_list is LIFO */
1204 list_add(&worker->entry, &gcwq->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001205
Tejun Heoe22bee72010-06-29 10:07:14 +02001206 if (likely(!(worker->flags & WORKER_ROGUE))) {
1207 if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
1208 mod_timer(&gcwq->idle_timer,
1209 jiffies + IDLE_WORKER_TIMEOUT);
1210 } else
Tejun Heodb7bccf2010-06-29 10:07:12 +02001211 wake_up_all(&gcwq->trustee_wait);
Tejun Heocb444762010-07-02 10:03:50 +02001212
1213 /* sanity check nr_running */
1214 WARN_ON_ONCE(gcwq->nr_workers == gcwq->nr_idle &&
1215 atomic_read(get_gcwq_nr_running(gcwq->cpu)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216}
1217
Tejun Heoc8e55f32010-06-29 10:07:12 +02001218/**
1219 * worker_leave_idle - leave idle state
1220 * @worker: worker which is leaving idle state
1221 *
1222 * @worker is leaving idle state. Update stats.
1223 *
1224 * LOCKING:
1225 * spin_lock_irq(gcwq->lock).
1226 */
1227static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228{
Tejun Heoc8e55f32010-06-29 10:07:12 +02001229 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230
Tejun Heoc8e55f32010-06-29 10:07:12 +02001231 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001232 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001233 gcwq->nr_idle--;
1234 list_del_init(&worker->entry);
1235}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236
Tejun Heoe22bee72010-06-29 10:07:14 +02001237/**
1238 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1239 * @worker: self
1240 *
1241 * Works which are scheduled while the cpu is online must at least be
1242 * scheduled to a worker which is bound to the cpu so that if they are
1243 * flushed from cpu callbacks while cpu is going down, they are
1244 * guaranteed to execute on the cpu.
1245 *
1246 * This function is to be used by rogue workers and rescuers to bind
1247 * themselves to the target cpu and may race with cpu going down or
1248 * coming online. kthread_bind() can't be used because it may put the
1249 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1250 * verbatim as it's best effort and blocking and gcwq may be
1251 * [dis]associated in the meantime.
1252 *
1253 * This function tries set_cpus_allowed() and locks gcwq and verifies
1254 * the binding against GCWQ_DISASSOCIATED which is set during
1255 * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1256 * idle state or fetches works without dropping lock, it can guarantee
1257 * the scheduling requirement described in the first paragraph.
1258 *
1259 * CONTEXT:
1260 * Might sleep. Called without any lock but returns with gcwq->lock
1261 * held.
1262 *
1263 * RETURNS:
1264 * %true if the associated gcwq is online (@worker is successfully
1265 * bound), %false if offline.
1266 */
1267static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001268__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001269{
1270 struct global_cwq *gcwq = worker->gcwq;
1271 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
Tejun Heoe22bee72010-06-29 10:07:14 +02001273 while (true) {
1274 /*
1275 * The following call may fail, succeed or succeed
1276 * without actually migrating the task to the cpu if
1277 * it races with cpu hotunplug operation. Verify
1278 * against GCWQ_DISASSOCIATED.
1279 */
Tejun Heof3421792010-07-02 10:03:51 +02001280 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1281 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001282
Tejun Heoe22bee72010-06-29 10:07:14 +02001283 spin_lock_irq(&gcwq->lock);
1284 if (gcwq->flags & GCWQ_DISASSOCIATED)
1285 return false;
1286 if (task_cpu(task) == gcwq->cpu &&
1287 cpumask_equal(&current->cpus_allowed,
1288 get_cpu_mask(gcwq->cpu)))
1289 return true;
1290 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001291
Tejun Heoe22bee72010-06-29 10:07:14 +02001292 /* CPU has come up inbetween, retry migration */
1293 cpu_relax();
1294 }
1295}
1296
1297/*
1298 * Function for worker->rebind_work used to rebind rogue busy workers
1299 * to the associated cpu which is coming back online. This is
1300 * scheduled by cpu up but can race with other cpu hotplug operations
1301 * and may be executed twice without intervening cpu down.
1302 */
1303static void worker_rebind_fn(struct work_struct *work)
1304{
1305 struct worker *worker = container_of(work, struct worker, rebind_work);
1306 struct global_cwq *gcwq = worker->gcwq;
1307
1308 if (worker_maybe_bind_and_lock(worker))
1309 worker_clr_flags(worker, WORKER_REBIND);
1310
1311 spin_unlock_irq(&gcwq->lock);
1312}
1313
Tejun Heoc34056a2010-06-29 10:07:11 +02001314static struct worker *alloc_worker(void)
1315{
1316 struct worker *worker;
1317
1318 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001319 if (worker) {
1320 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001321 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heoe22bee72010-06-29 10:07:14 +02001322 INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1323 /* on creation a worker is in !idle && prep state */
1324 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001325 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001326 return worker;
1327}
1328
1329/**
1330 * create_worker - create a new workqueue worker
Tejun Heo7e116292010-06-29 10:07:13 +02001331 * @gcwq: gcwq the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001332 * @bind: whether to set affinity to @cpu or not
1333 *
Tejun Heo7e116292010-06-29 10:07:13 +02001334 * Create a new worker which is bound to @gcwq. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001335 * can be started by calling start_worker() or destroyed using
1336 * destroy_worker().
1337 *
1338 * CONTEXT:
1339 * Might sleep. Does GFP_KERNEL allocations.
1340 *
1341 * RETURNS:
1342 * Pointer to the newly created worker.
1343 */
Tejun Heo7e116292010-06-29 10:07:13 +02001344static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
Tejun Heoc34056a2010-06-29 10:07:11 +02001345{
Tejun Heof3421792010-07-02 10:03:51 +02001346 bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
Tejun Heoc34056a2010-06-29 10:07:11 +02001347 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001348 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001349
Tejun Heo8b03ae32010-06-29 10:07:12 +02001350 spin_lock_irq(&gcwq->lock);
1351 while (ida_get_new(&gcwq->worker_ida, &id)) {
1352 spin_unlock_irq(&gcwq->lock);
1353 if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001354 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001355 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001356 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001357 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001358
1359 worker = alloc_worker();
1360 if (!worker)
1361 goto fail;
1362
Tejun Heo8b03ae32010-06-29 10:07:12 +02001363 worker->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001364 worker->id = id;
1365
Tejun Heof3421792010-07-02 10:03:51 +02001366 if (!on_unbound_cpu)
1367 worker->task = kthread_create(worker_thread, worker,
1368 "kworker/%u:%d", gcwq->cpu, id);
1369 else
1370 worker->task = kthread_create(worker_thread, worker,
1371 "kworker/u:%d", id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001372 if (IS_ERR(worker->task))
1373 goto fail;
1374
Tejun Heodb7bccf2010-06-29 10:07:12 +02001375 /*
1376 * A rogue worker will become a regular one if CPU comes
1377 * online later on. Make sure every worker has
1378 * PF_THREAD_BOUND set.
1379 */
Tejun Heof3421792010-07-02 10:03:51 +02001380 if (bind && !on_unbound_cpu)
Tejun Heo8b03ae32010-06-29 10:07:12 +02001381 kthread_bind(worker->task, gcwq->cpu);
Tejun Heof3421792010-07-02 10:03:51 +02001382 else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001383 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heof3421792010-07-02 10:03:51 +02001384 if (on_unbound_cpu)
1385 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001387
Tejun Heoc34056a2010-06-29 10:07:11 +02001388 return worker;
1389fail:
1390 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001391 spin_lock_irq(&gcwq->lock);
1392 ida_remove(&gcwq->worker_ida, id);
1393 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001394 }
1395 kfree(worker);
1396 return NULL;
1397}
1398
1399/**
1400 * start_worker - start a newly created worker
1401 * @worker: worker to start
1402 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001403 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001404 *
1405 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001406 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001407 */
1408static void start_worker(struct worker *worker)
1409{
Tejun Heocb444762010-07-02 10:03:50 +02001410 worker->flags |= WORKER_STARTED;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001411 worker->gcwq->nr_workers++;
1412 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001413 wake_up_process(worker->task);
1414}
1415
1416/**
1417 * destroy_worker - destroy a workqueue worker
1418 * @worker: worker to be destroyed
1419 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001420 * Destroy @worker and adjust @gcwq stats accordingly.
1421 *
1422 * CONTEXT:
1423 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001424 */
1425static void destroy_worker(struct worker *worker)
1426{
Tejun Heo8b03ae32010-06-29 10:07:12 +02001427 struct global_cwq *gcwq = worker->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001428 int id = worker->id;
1429
1430 /* sanity check frenzy */
1431 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001432 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001433
Tejun Heoc8e55f32010-06-29 10:07:12 +02001434 if (worker->flags & WORKER_STARTED)
1435 gcwq->nr_workers--;
1436 if (worker->flags & WORKER_IDLE)
1437 gcwq->nr_idle--;
1438
1439 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001440 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001441
1442 spin_unlock_irq(&gcwq->lock);
1443
Tejun Heoc34056a2010-06-29 10:07:11 +02001444 kthread_stop(worker->task);
1445 kfree(worker);
1446
Tejun Heo8b03ae32010-06-29 10:07:12 +02001447 spin_lock_irq(&gcwq->lock);
1448 ida_remove(&gcwq->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001449}
1450
Tejun Heoe22bee72010-06-29 10:07:14 +02001451static void idle_worker_timeout(unsigned long __gcwq)
1452{
1453 struct global_cwq *gcwq = (void *)__gcwq;
1454
1455 spin_lock_irq(&gcwq->lock);
1456
1457 if (too_many_workers(gcwq)) {
1458 struct worker *worker;
1459 unsigned long expires;
1460
1461 /* idle_list is kept in LIFO order, check the last one */
1462 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1463 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1464
1465 if (time_before(jiffies, expires))
1466 mod_timer(&gcwq->idle_timer, expires);
1467 else {
1468 /* it's been idle for too long, wake up manager */
1469 gcwq->flags |= GCWQ_MANAGE_WORKERS;
1470 wake_up_worker(gcwq);
1471 }
1472 }
1473
1474 spin_unlock_irq(&gcwq->lock);
1475}
1476
1477static bool send_mayday(struct work_struct *work)
1478{
1479 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1480 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001481 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001482
1483 if (!(wq->flags & WQ_RESCUER))
1484 return false;
1485
1486 /* mayday mayday mayday */
Tejun Heof3421792010-07-02 10:03:51 +02001487 cpu = cwq->gcwq->cpu;
1488 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1489 if (cpu == WORK_CPU_UNBOUND)
1490 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001491 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001492 wake_up_process(wq->rescuer->task);
1493 return true;
1494}
1495
1496static void gcwq_mayday_timeout(unsigned long __gcwq)
1497{
1498 struct global_cwq *gcwq = (void *)__gcwq;
1499 struct work_struct *work;
1500
1501 spin_lock_irq(&gcwq->lock);
1502
1503 if (need_to_create_worker(gcwq)) {
1504 /*
1505 * We've been trying to create a new worker but
1506 * haven't been successful. We might be hitting an
1507 * allocation deadlock. Send distress signals to
1508 * rescuers.
1509 */
1510 list_for_each_entry(work, &gcwq->worklist, entry)
1511 send_mayday(work);
1512 }
1513
1514 spin_unlock_irq(&gcwq->lock);
1515
1516 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
1517}
1518
1519/**
1520 * maybe_create_worker - create a new worker if necessary
1521 * @gcwq: gcwq to create a new worker for
1522 *
1523 * Create a new worker for @gcwq if necessary. @gcwq is guaranteed to
1524 * have at least one idle worker on return from this function. If
1525 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1526 * sent to all rescuers with works scheduled on @gcwq to resolve
1527 * possible allocation deadlock.
1528 *
1529 * On return, need_to_create_worker() is guaranteed to be false and
1530 * may_start_working() true.
1531 *
1532 * LOCKING:
1533 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1534 * multiple times. Does GFP_KERNEL allocations. Called only from
1535 * manager.
1536 *
1537 * RETURNS:
1538 * false if no action was taken and gcwq->lock stayed locked, true
1539 * otherwise.
1540 */
1541static bool maybe_create_worker(struct global_cwq *gcwq)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001542__releases(&gcwq->lock)
1543__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001544{
1545 if (!need_to_create_worker(gcwq))
1546 return false;
1547restart:
Tejun Heo9f9c2362010-07-14 11:31:20 +02001548 spin_unlock_irq(&gcwq->lock);
1549
Tejun Heoe22bee72010-06-29 10:07:14 +02001550 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1551 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1552
1553 while (true) {
1554 struct worker *worker;
1555
Tejun Heoe22bee72010-06-29 10:07:14 +02001556 worker = create_worker(gcwq, true);
1557 if (worker) {
1558 del_timer_sync(&gcwq->mayday_timer);
1559 spin_lock_irq(&gcwq->lock);
1560 start_worker(worker);
1561 BUG_ON(need_to_create_worker(gcwq));
1562 return true;
1563 }
1564
1565 if (!need_to_create_worker(gcwq))
1566 break;
1567
Tejun Heoe22bee72010-06-29 10:07:14 +02001568 __set_current_state(TASK_INTERRUPTIBLE);
1569 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001570
Tejun Heoe22bee72010-06-29 10:07:14 +02001571 if (!need_to_create_worker(gcwq))
1572 break;
1573 }
1574
Tejun Heoe22bee72010-06-29 10:07:14 +02001575 del_timer_sync(&gcwq->mayday_timer);
1576 spin_lock_irq(&gcwq->lock);
1577 if (need_to_create_worker(gcwq))
1578 goto restart;
1579 return true;
1580}
1581
1582/**
1583 * maybe_destroy_worker - destroy workers which have been idle for a while
1584 * @gcwq: gcwq to destroy workers for
1585 *
1586 * Destroy @gcwq workers which have been idle for longer than
1587 * IDLE_WORKER_TIMEOUT.
1588 *
1589 * LOCKING:
1590 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1591 * multiple times. Called only from manager.
1592 *
1593 * RETURNS:
1594 * false if no action was taken and gcwq->lock stayed locked, true
1595 * otherwise.
1596 */
1597static bool maybe_destroy_workers(struct global_cwq *gcwq)
1598{
1599 bool ret = false;
1600
1601 while (too_many_workers(gcwq)) {
1602 struct worker *worker;
1603 unsigned long expires;
1604
1605 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1606 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1607
1608 if (time_before(jiffies, expires)) {
1609 mod_timer(&gcwq->idle_timer, expires);
1610 break;
1611 }
1612
1613 destroy_worker(worker);
1614 ret = true;
1615 }
1616
1617 return ret;
1618}
1619
1620/**
1621 * manage_workers - manage worker pool
1622 * @worker: self
1623 *
1624 * Assume the manager role and manage gcwq worker pool @worker belongs
1625 * to. At any given time, there can be only zero or one manager per
1626 * gcwq. The exclusion is handled automatically by this function.
1627 *
1628 * The caller can safely start processing works on false return. On
1629 * true return, it's guaranteed that need_to_create_worker() is false
1630 * and may_start_working() is true.
1631 *
1632 * CONTEXT:
1633 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1634 * multiple times. Does GFP_KERNEL allocations.
1635 *
1636 * RETURNS:
1637 * false if no action was taken and gcwq->lock stayed locked, true if
1638 * some action was taken.
1639 */
1640static bool manage_workers(struct worker *worker)
1641{
1642 struct global_cwq *gcwq = worker->gcwq;
1643 bool ret = false;
1644
1645 if (gcwq->flags & GCWQ_MANAGING_WORKERS)
1646 return ret;
1647
1648 gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
1649 gcwq->flags |= GCWQ_MANAGING_WORKERS;
1650
1651 /*
1652 * Destroy and then create so that may_start_working() is true
1653 * on return.
1654 */
1655 ret |= maybe_destroy_workers(gcwq);
1656 ret |= maybe_create_worker(gcwq);
1657
1658 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
1659
1660 /*
1661 * The trustee might be waiting to take over the manager
1662 * position, tell it we're done.
1663 */
1664 if (unlikely(gcwq->trustee))
1665 wake_up_all(&gcwq->trustee_wait);
1666
1667 return ret;
1668}
1669
Tejun Heoa62428c2010-06-29 10:07:10 +02001670/**
Tejun Heoaffee4b2010-06-29 10:07:12 +02001671 * move_linked_works - move linked works to a list
1672 * @work: start of series of works to be scheduled
1673 * @head: target list to append @work to
1674 * @nextp: out paramter for nested worklist walking
1675 *
1676 * Schedule linked works starting from @work to @head. Work series to
1677 * be scheduled starts at @work and includes any consecutive work with
1678 * WORK_STRUCT_LINKED set in its predecessor.
1679 *
1680 * If @nextp is not NULL, it's updated to point to the next work of
1681 * the last scheduled work. This allows move_linked_works() to be
1682 * nested inside outer list_for_each_entry_safe().
1683 *
1684 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001685 * spin_lock_irq(gcwq->lock).
Tejun Heoaffee4b2010-06-29 10:07:12 +02001686 */
1687static void move_linked_works(struct work_struct *work, struct list_head *head,
1688 struct work_struct **nextp)
1689{
1690 struct work_struct *n;
1691
1692 /*
1693 * Linked worklist will always end before the end of the list,
1694 * use NULL for list head.
1695 */
1696 list_for_each_entry_safe_from(work, n, NULL, entry) {
1697 list_move_tail(&work->entry, head);
1698 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1699 break;
1700 }
1701
1702 /*
1703 * If we're already inside safe list traversal and have moved
1704 * multiple works to the scheduled queue, the next position
1705 * needs to be updated.
1706 */
1707 if (nextp)
1708 *nextp = n;
1709}
1710
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001711static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
1712{
1713 struct work_struct *work = list_first_entry(&cwq->delayed_works,
1714 struct work_struct, entry);
Tejun Heo649027d2010-06-29 10:07:14 +02001715 struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001716
Tejun Heocdadf002010-10-05 10:49:55 +02001717 trace_workqueue_activate_work(work);
Tejun Heo649027d2010-06-29 10:07:14 +02001718 move_linked_works(work, pos, NULL);
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001719 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001720 cwq->nr_active++;
1721}
1722
Tejun Heoaffee4b2010-06-29 10:07:12 +02001723/**
Tejun Heo73f53c42010-06-29 10:07:11 +02001724 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1725 * @cwq: cwq of interest
1726 * @color: color of work which left the queue
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001727 * @delayed: for a delayed work
Tejun Heo73f53c42010-06-29 10:07:11 +02001728 *
1729 * A work either has completed or is removed from pending queue,
1730 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1731 *
1732 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001733 * spin_lock_irq(gcwq->lock).
Tejun Heo73f53c42010-06-29 10:07:11 +02001734 */
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001735static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
1736 bool delayed)
Tejun Heo73f53c42010-06-29 10:07:11 +02001737{
1738 /* ignore uncolored works */
1739 if (color == WORK_NO_COLOR)
1740 return;
1741
1742 cwq->nr_in_flight[color]--;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001743
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001744 if (!delayed) {
1745 cwq->nr_active--;
1746 if (!list_empty(&cwq->delayed_works)) {
1747 /* one down, submit a delayed one */
1748 if (cwq->nr_active < cwq->max_active)
1749 cwq_activate_first_delayed(cwq);
1750 }
Tejun Heo502ca9d2010-06-29 10:07:13 +02001751 }
Tejun Heo73f53c42010-06-29 10:07:11 +02001752
1753 /* is flush in progress and are we at the flushing tip? */
1754 if (likely(cwq->flush_color != color))
1755 return;
1756
1757 /* are there still in-flight works? */
1758 if (cwq->nr_in_flight[color])
1759 return;
1760
1761 /* this cwq is done, clear flush_color */
1762 cwq->flush_color = -1;
1763
1764 /*
1765 * If this was the last cwq, wake up the first flusher. It
1766 * will handle the rest.
1767 */
1768 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1769 complete(&cwq->wq->first_flusher->done);
1770}
1771
1772/**
Tejun Heoa62428c2010-06-29 10:07:10 +02001773 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001774 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001775 * @work: work to process
1776 *
1777 * Process @work. This function contains all the logics necessary to
1778 * process a single work including synchronization against and
1779 * interaction with other workers on the same cpu, queueing and
1780 * flushing. As long as context requirement is met, any worker can
1781 * call this function to process a work.
1782 *
1783 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001784 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001785 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001786static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001787__releases(&gcwq->lock)
1788__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02001789{
Tejun Heo7e116292010-06-29 10:07:13 +02001790 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001791 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001792 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02001793 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02001794 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02001795 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001796 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001797#ifdef CONFIG_LOCKDEP
1798 /*
1799 * It is permissible to free the struct work_struct from
1800 * inside the function that is called from it, this we need to
1801 * take into account for lockdep too. To avoid bogus "held
1802 * lock freed" warnings as well as problems when looking into
1803 * work->lockdep_map, make a copy and use that here.
1804 */
1805 struct lockdep_map lockdep_map = work->lockdep_map;
1806#endif
Tejun Heo7e116292010-06-29 10:07:13 +02001807 /*
1808 * A single work shouldn't be executed concurrently by
1809 * multiple workers on a single cpu. Check whether anyone is
1810 * already processing the work. If so, defer the work to the
1811 * currently executing one.
1812 */
1813 collision = __find_worker_executing_work(gcwq, bwh, work);
1814 if (unlikely(collision)) {
1815 move_linked_works(work, &collision->scheduled, NULL);
1816 return;
1817 }
1818
Tejun Heoa62428c2010-06-29 10:07:10 +02001819 /* claim and process */
Tejun Heoa62428c2010-06-29 10:07:10 +02001820 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001821 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02001822 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001823 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001824 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001825
Tejun Heo7a22ad72010-06-29 10:07:13 +02001826 /* record the current cpu number in the work data and dequeue */
1827 set_work_cpu(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02001828 list_del_init(&work->entry);
1829
Tejun Heo649027d2010-06-29 10:07:14 +02001830 /*
1831 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1832 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1833 */
1834 if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
1835 struct work_struct *nwork = list_first_entry(&gcwq->worklist,
1836 struct work_struct, entry);
1837
1838 if (!list_empty(&gcwq->worklist) &&
1839 get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
1840 wake_up_worker(gcwq);
1841 else
1842 gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
1843 }
1844
Tejun Heofb0e7be2010-06-29 10:07:15 +02001845 /*
1846 * CPU intensive works don't participate in concurrency
1847 * management. They're the scheduler's responsibility.
1848 */
1849 if (unlikely(cpu_intensive))
1850 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1851
Tejun Heo8b03ae32010-06-29 10:07:12 +02001852 spin_unlock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001853
Tejun Heoa62428c2010-06-29 10:07:10 +02001854 work_clear_pending(work);
Tejun Heoe1594892011-01-09 23:32:15 +01001855 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02001856 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07001857 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02001858 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07001859 /*
1860 * While we must be careful to not use "work" after this, the trace
1861 * point will only record its address.
1862 */
1863 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02001864 lock_map_release(&lockdep_map);
1865 lock_map_release(&cwq->wq->lockdep_map);
1866
1867 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1868 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1869 "%s/0x%08x/%d\n",
1870 current->comm, preempt_count(), task_pid_nr(current));
1871 printk(KERN_ERR " last function: ");
1872 print_symbol("%s\n", (unsigned long)f);
1873 debug_show_held_locks(current);
1874 dump_stack();
1875 }
1876
Tejun Heo8b03ae32010-06-29 10:07:12 +02001877 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001878
Tejun Heofb0e7be2010-06-29 10:07:15 +02001879 /* clear cpu intensive status */
1880 if (unlikely(cpu_intensive))
1881 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1882
Tejun Heoa62428c2010-06-29 10:07:10 +02001883 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02001884 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001885 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001886 worker->current_cwq = NULL;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001887 cwq_dec_nr_in_flight(cwq, work_color, false);
Tejun Heoa62428c2010-06-29 10:07:10 +02001888}
1889
Tejun Heoaffee4b2010-06-29 10:07:12 +02001890/**
1891 * process_scheduled_works - process scheduled works
1892 * @worker: self
1893 *
1894 * Process all scheduled works. Please note that the scheduled list
1895 * may change while processing a work, so this function repeatedly
1896 * fetches a work from the top and executes it.
1897 *
1898 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001899 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02001900 * multiple times.
1901 */
1902static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903{
Tejun Heoaffee4b2010-06-29 10:07:12 +02001904 while (!list_empty(&worker->scheduled)) {
1905 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001907 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909}
1910
Tejun Heo4690c4a2010-06-29 10:07:10 +02001911/**
1912 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02001913 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02001914 *
Tejun Heoe22bee72010-06-29 10:07:14 +02001915 * The gcwq worker thread function. There's a single dynamic pool of
1916 * these per each cpu. These workers process all works regardless of
1917 * their specific target workqueue. The only exception is works which
1918 * belong to workqueues with a rescuer which will be explained in
1919 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02001920 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001921static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922{
Tejun Heoc34056a2010-06-29 10:07:11 +02001923 struct worker *worker = __worker;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001924 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925
Tejun Heoe22bee72010-06-29 10:07:14 +02001926 /* tell the scheduler that this is a workqueue worker */
1927 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001928woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02001929 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930
Tejun Heoc8e55f32010-06-29 10:07:12 +02001931 /* DIE can be set only while we're idle, checking here is enough */
1932 if (worker->flags & WORKER_DIE) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001933 spin_unlock_irq(&gcwq->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001934 worker->task->flags &= ~PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001935 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 }
1937
Tejun Heoc8e55f32010-06-29 10:07:12 +02001938 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001939recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02001940 /* no more worker necessary? */
1941 if (!need_more_worker(gcwq))
1942 goto sleep;
1943
1944 /* do we need to manage? */
1945 if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
1946 goto recheck;
1947
Tejun Heoc8e55f32010-06-29 10:07:12 +02001948 /*
1949 * ->scheduled list can only be filled while a worker is
1950 * preparing to process a work or actually processing it.
1951 * Make sure nobody diddled with it while I was sleeping.
1952 */
1953 BUG_ON(!list_empty(&worker->scheduled));
1954
Tejun Heoe22bee72010-06-29 10:07:14 +02001955 /*
1956 * When control reaches this point, we're guaranteed to have
1957 * at least one idle worker or that someone else has already
1958 * assumed the manager role.
1959 */
1960 worker_clr_flags(worker, WORKER_PREP);
1961
1962 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02001963 struct work_struct *work =
Tejun Heo7e116292010-06-29 10:07:13 +02001964 list_first_entry(&gcwq->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02001965 struct work_struct, entry);
1966
1967 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1968 /* optimization path, not strictly necessary */
1969 process_one_work(worker, work);
1970 if (unlikely(!list_empty(&worker->scheduled)))
1971 process_scheduled_works(worker);
1972 } else {
1973 move_linked_works(work, &worker->scheduled, NULL);
1974 process_scheduled_works(worker);
1975 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001976 } while (keep_working(gcwq));
Tejun Heoc8e55f32010-06-29 10:07:12 +02001977
Tejun Heoe22bee72010-06-29 10:07:14 +02001978 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02001979sleep:
Tejun Heoe22bee72010-06-29 10:07:14 +02001980 if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
1981 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02001982
Tejun Heoc8e55f32010-06-29 10:07:12 +02001983 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02001984 * gcwq->lock is held and there's no work to process and no
1985 * need to manage, sleep. Workers are woken up only while
1986 * holding gcwq->lock or from local cpu, so setting the
1987 * current state before releasing gcwq->lock is enough to
1988 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001989 */
1990 worker_enter_idle(worker);
1991 __set_current_state(TASK_INTERRUPTIBLE);
1992 spin_unlock_irq(&gcwq->lock);
1993 schedule();
1994 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995}
1996
Tejun Heoe22bee72010-06-29 10:07:14 +02001997/**
1998 * rescuer_thread - the rescuer thread function
1999 * @__wq: the associated workqueue
2000 *
2001 * Workqueue rescuer thread function. There's one rescuer for each
2002 * workqueue which has WQ_RESCUER set.
2003 *
2004 * Regular work processing on a gcwq may block trying to create a new
2005 * worker which uses GFP_KERNEL allocation which has slight chance of
2006 * developing into deadlock if some works currently on the same queue
2007 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2008 * the problem rescuer solves.
2009 *
2010 * When such condition is possible, the gcwq summons rescuers of all
2011 * workqueues which have works queued on the gcwq and let them process
2012 * those works so that forward progress can be guaranteed.
2013 *
2014 * This should happen rarely.
2015 */
2016static int rescuer_thread(void *__wq)
2017{
2018 struct workqueue_struct *wq = __wq;
2019 struct worker *rescuer = wq->rescuer;
2020 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002021 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002022 unsigned int cpu;
2023
2024 set_user_nice(current, RESCUER_NICE_LEVEL);
2025repeat:
2026 set_current_state(TASK_INTERRUPTIBLE);
2027
2028 if (kthread_should_stop())
2029 return 0;
2030
Tejun Heof3421792010-07-02 10:03:51 +02002031 /*
2032 * See whether any cpu is asking for help. Unbounded
2033 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2034 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002035 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002036 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2037 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heoe22bee72010-06-29 10:07:14 +02002038 struct global_cwq *gcwq = cwq->gcwq;
2039 struct work_struct *work, *n;
2040
2041 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002042 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002043
2044 /* migrate to the target cpu if possible */
2045 rescuer->gcwq = gcwq;
2046 worker_maybe_bind_and_lock(rescuer);
2047
2048 /*
2049 * Slurp in all works issued via this workqueue and
2050 * process'em.
2051 */
2052 BUG_ON(!list_empty(&rescuer->scheduled));
2053 list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
2054 if (get_work_cwq(work) == cwq)
2055 move_linked_works(work, scheduled, &n);
2056
2057 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002058
2059 /*
2060 * Leave this gcwq. If keep_working() is %true, notify a
2061 * regular worker; otherwise, we end up with 0 concurrency
2062 * and stalling the execution.
2063 */
2064 if (keep_working(gcwq))
2065 wake_up_worker(gcwq);
2066
Tejun Heoe22bee72010-06-29 10:07:14 +02002067 spin_unlock_irq(&gcwq->lock);
2068 }
2069
2070 schedule();
2071 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072}
2073
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002074struct wq_barrier {
2075 struct work_struct work;
2076 struct completion done;
2077};
2078
2079static void wq_barrier_func(struct work_struct *work)
2080{
2081 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2082 complete(&barr->done);
2083}
2084
Tejun Heo4690c4a2010-06-29 10:07:10 +02002085/**
2086 * insert_wq_barrier - insert a barrier work
2087 * @cwq: cwq to insert barrier into
2088 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002089 * @target: target work to attach @barr to
2090 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002091 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002092 * @barr is linked to @target such that @barr is completed only after
2093 * @target finishes execution. Please note that the ordering
2094 * guarantee is observed only with respect to @target and on the local
2095 * cpu.
2096 *
2097 * Currently, a queued barrier can't be canceled. This is because
2098 * try_to_grab_pending() can't determine whether the work to be
2099 * grabbed is at the head of the queue and thus can't clear LINKED
2100 * flag of the previous work while there must be a valid next work
2101 * after a work with LINKED flag set.
2102 *
2103 * Note that when @worker is non-NULL, @target may be modified
2104 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002105 *
2106 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002107 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002108 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002109static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002110 struct wq_barrier *barr,
2111 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002112{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002113 struct list_head *head;
2114 unsigned int linked = 0;
2115
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002116 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002117 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002118 * as we know for sure that this will not trigger any of the
2119 * checks and call back into the fixup functions where we
2120 * might deadlock.
2121 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002122 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002123 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002124 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002125
Tejun Heoaffee4b2010-06-29 10:07:12 +02002126 /*
2127 * If @target is currently being executed, schedule the
2128 * barrier to the worker; otherwise, put it after @target.
2129 */
2130 if (worker)
2131 head = worker->scheduled.next;
2132 else {
2133 unsigned long *bits = work_data_bits(target);
2134
2135 head = target->entry.next;
2136 /* there can already be other linked works, inherit and set */
2137 linked = *bits & WORK_STRUCT_LINKED;
2138 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2139 }
2140
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002141 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002142 insert_work(cwq, &barr->work, head,
2143 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002144}
2145
Tejun Heo73f53c42010-06-29 10:07:11 +02002146/**
2147 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2148 * @wq: workqueue being flushed
2149 * @flush_color: new flush color, < 0 for no-op
2150 * @work_color: new work color, < 0 for no-op
2151 *
2152 * Prepare cwqs for workqueue flushing.
2153 *
2154 * If @flush_color is non-negative, flush_color on all cwqs should be
2155 * -1. If no cwq has in-flight commands at the specified color, all
2156 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2157 * has in flight commands, its cwq->flush_color is set to
2158 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2159 * wakeup logic is armed and %true is returned.
2160 *
2161 * The caller should have initialized @wq->first_flusher prior to
2162 * calling this function with non-negative @flush_color. If
2163 * @flush_color is negative, no flush color update is done and %false
2164 * is returned.
2165 *
2166 * If @work_color is non-negative, all cwqs should have the same
2167 * work_color which is previous to @work_color and all will be
2168 * advanced to @work_color.
2169 *
2170 * CONTEXT:
2171 * mutex_lock(wq->flush_mutex).
2172 *
2173 * RETURNS:
2174 * %true if @flush_color >= 0 and there's something to flush. %false
2175 * otherwise.
2176 */
2177static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2178 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179{
Tejun Heo73f53c42010-06-29 10:07:11 +02002180 bool wait = false;
2181 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002182
Tejun Heo73f53c42010-06-29 10:07:11 +02002183 if (flush_color >= 0) {
2184 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2185 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002186 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002187
Tejun Heof3421792010-07-02 10:03:51 +02002188 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002189 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002190 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002191
Tejun Heo8b03ae32010-06-29 10:07:12 +02002192 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002193
2194 if (flush_color >= 0) {
2195 BUG_ON(cwq->flush_color != -1);
2196
2197 if (cwq->nr_in_flight[flush_color]) {
2198 cwq->flush_color = flush_color;
2199 atomic_inc(&wq->nr_cwqs_to_flush);
2200 wait = true;
2201 }
2202 }
2203
2204 if (work_color >= 0) {
2205 BUG_ON(work_color != work_next_color(cwq->work_color));
2206 cwq->work_color = work_color;
2207 }
2208
Tejun Heo8b03ae32010-06-29 10:07:12 +02002209 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002210 }
2211
2212 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2213 complete(&wq->first_flusher->done);
2214
2215 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216}
2217
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002218/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002220 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 *
2222 * Forces execution of the workqueue and blocks until its completion.
2223 * This is typically used in driver shutdown handlers.
2224 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002225 * We sleep until all works which were queued on entry have been handled,
2226 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002228void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229{
Tejun Heo73f53c42010-06-29 10:07:11 +02002230 struct wq_flusher this_flusher = {
2231 .list = LIST_HEAD_INIT(this_flusher.list),
2232 .flush_color = -1,
2233 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2234 };
2235 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002236
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002237 lock_map_acquire(&wq->lockdep_map);
2238 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002239
2240 mutex_lock(&wq->flush_mutex);
2241
2242 /*
2243 * Start-to-wait phase
2244 */
2245 next_color = work_next_color(wq->work_color);
2246
2247 if (next_color != wq->flush_color) {
2248 /*
2249 * Color space is not full. The current work_color
2250 * becomes our flush_color and work_color is advanced
2251 * by one.
2252 */
2253 BUG_ON(!list_empty(&wq->flusher_overflow));
2254 this_flusher.flush_color = wq->work_color;
2255 wq->work_color = next_color;
2256
2257 if (!wq->first_flusher) {
2258 /* no flush in progress, become the first flusher */
2259 BUG_ON(wq->flush_color != this_flusher.flush_color);
2260
2261 wq->first_flusher = &this_flusher;
2262
2263 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2264 wq->work_color)) {
2265 /* nothing to flush, done */
2266 wq->flush_color = next_color;
2267 wq->first_flusher = NULL;
2268 goto out_unlock;
2269 }
2270 } else {
2271 /* wait in queue */
2272 BUG_ON(wq->flush_color == this_flusher.flush_color);
2273 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2274 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2275 }
2276 } else {
2277 /*
2278 * Oops, color space is full, wait on overflow queue.
2279 * The next flush completion will assign us
2280 * flush_color and transfer to flusher_queue.
2281 */
2282 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2283 }
2284
2285 mutex_unlock(&wq->flush_mutex);
2286
2287 wait_for_completion(&this_flusher.done);
2288
2289 /*
2290 * Wake-up-and-cascade phase
2291 *
2292 * First flushers are responsible for cascading flushes and
2293 * handling overflow. Non-first flushers can simply return.
2294 */
2295 if (wq->first_flusher != &this_flusher)
2296 return;
2297
2298 mutex_lock(&wq->flush_mutex);
2299
Tejun Heo4ce48b32010-07-02 10:03:51 +02002300 /* we might have raced, check again with mutex held */
2301 if (wq->first_flusher != &this_flusher)
2302 goto out_unlock;
2303
Tejun Heo73f53c42010-06-29 10:07:11 +02002304 wq->first_flusher = NULL;
2305
2306 BUG_ON(!list_empty(&this_flusher.list));
2307 BUG_ON(wq->flush_color != this_flusher.flush_color);
2308
2309 while (true) {
2310 struct wq_flusher *next, *tmp;
2311
2312 /* complete all the flushers sharing the current flush color */
2313 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2314 if (next->flush_color != wq->flush_color)
2315 break;
2316 list_del_init(&next->list);
2317 complete(&next->done);
2318 }
2319
2320 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2321 wq->flush_color != work_next_color(wq->work_color));
2322
2323 /* this flush_color is finished, advance by one */
2324 wq->flush_color = work_next_color(wq->flush_color);
2325
2326 /* one color has been freed, handle overflow queue */
2327 if (!list_empty(&wq->flusher_overflow)) {
2328 /*
2329 * Assign the same color to all overflowed
2330 * flushers, advance work_color and append to
2331 * flusher_queue. This is the start-to-wait
2332 * phase for these overflowed flushers.
2333 */
2334 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2335 tmp->flush_color = wq->work_color;
2336
2337 wq->work_color = work_next_color(wq->work_color);
2338
2339 list_splice_tail_init(&wq->flusher_overflow,
2340 &wq->flusher_queue);
2341 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2342 }
2343
2344 if (list_empty(&wq->flusher_queue)) {
2345 BUG_ON(wq->flush_color != wq->work_color);
2346 break;
2347 }
2348
2349 /*
2350 * Need to flush more colors. Make the next flusher
2351 * the new first flusher and arm cwqs.
2352 */
2353 BUG_ON(wq->flush_color == wq->work_color);
2354 BUG_ON(wq->flush_color != next->flush_color);
2355
2356 list_del_init(&next->list);
2357 wq->first_flusher = next;
2358
2359 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2360 break;
2361
2362 /*
2363 * Meh... this color is already done, clear first
2364 * flusher and repeat cascading.
2365 */
2366 wq->first_flusher = NULL;
2367 }
2368
2369out_unlock:
2370 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371}
Dave Jonesae90dd52006-06-30 01:40:45 -04002372EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373
Tejun Heobaf59022010-09-16 10:42:16 +02002374static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2375 bool wait_executing)
2376{
2377 struct worker *worker = NULL;
2378 struct global_cwq *gcwq;
2379 struct cpu_workqueue_struct *cwq;
2380
2381 might_sleep();
2382 gcwq = get_work_gcwq(work);
2383 if (!gcwq)
2384 return false;
2385
2386 spin_lock_irq(&gcwq->lock);
2387 if (!list_empty(&work->entry)) {
2388 /*
2389 * See the comment near try_to_grab_pending()->smp_rmb().
2390 * If it was re-queued to a different gcwq under us, we
2391 * are not going to wait.
2392 */
2393 smp_rmb();
2394 cwq = get_work_cwq(work);
2395 if (unlikely(!cwq || gcwq != cwq->gcwq))
2396 goto already_gone;
2397 } else if (wait_executing) {
2398 worker = find_worker_executing_work(gcwq, work);
2399 if (!worker)
2400 goto already_gone;
2401 cwq = worker->current_cwq;
2402 } else
2403 goto already_gone;
2404
2405 insert_wq_barrier(cwq, barr, work, worker);
2406 spin_unlock_irq(&gcwq->lock);
2407
Tejun Heoe1594892011-01-09 23:32:15 +01002408 /*
2409 * If @max_active is 1 or rescuer is in use, flushing another work
2410 * item on the same workqueue may lead to deadlock. Make sure the
2411 * flusher is not running on the same workqueue by verifying write
2412 * access.
2413 */
2414 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2415 lock_map_acquire(&cwq->wq->lockdep_map);
2416 else
2417 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002418 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002419
Tejun Heobaf59022010-09-16 10:42:16 +02002420 return true;
2421already_gone:
2422 spin_unlock_irq(&gcwq->lock);
2423 return false;
2424}
2425
Oleg Nesterovdb700892008-07-25 01:47:49 -07002426/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002427 * flush_work - wait for a work to finish executing the last queueing instance
2428 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002429 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002430 * Wait until @work has finished execution. This function considers
2431 * only the last queueing instance of @work. If @work has been
2432 * enqueued across different CPUs on a non-reentrant workqueue or on
2433 * multiple workqueues, @work might still be executing on return on
2434 * some of the CPUs from earlier queueing.
Oleg Nesterova67da702008-07-25 01:47:52 -07002435 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002436 * If @work was queued only on a non-reentrant, ordered or unbound
2437 * workqueue, @work is guaranteed to be idle on return if it hasn't
2438 * been requeued since flush started.
2439 *
2440 * RETURNS:
2441 * %true if flush_work() waited for the work to finish execution,
2442 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002443 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002444bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002445{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002446 struct wq_barrier barr;
2447
Tejun Heobaf59022010-09-16 10:42:16 +02002448 if (start_flush_work(work, &barr, true)) {
2449 wait_for_completion(&barr.done);
2450 destroy_work_on_stack(&barr.work);
2451 return true;
2452 } else
2453 return false;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002454}
2455EXPORT_SYMBOL_GPL(flush_work);
2456
Tejun Heo401a8d02010-09-16 10:36:00 +02002457static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2458{
2459 struct wq_barrier barr;
2460 struct worker *worker;
2461
2462 spin_lock_irq(&gcwq->lock);
2463
2464 worker = find_worker_executing_work(gcwq, work);
2465 if (unlikely(worker))
2466 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2467
2468 spin_unlock_irq(&gcwq->lock);
2469
2470 if (unlikely(worker)) {
2471 wait_for_completion(&barr.done);
2472 destroy_work_on_stack(&barr.work);
2473 return true;
2474 } else
2475 return false;
2476}
2477
2478static bool wait_on_work(struct work_struct *work)
2479{
2480 bool ret = false;
2481 int cpu;
2482
2483 might_sleep();
2484
2485 lock_map_acquire(&work->lockdep_map);
2486 lock_map_release(&work->lockdep_map);
2487
2488 for_each_gcwq_cpu(cpu)
2489 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2490 return ret;
2491}
2492
Tejun Heo09383492010-09-16 10:48:29 +02002493/**
2494 * flush_work_sync - wait until a work has finished execution
2495 * @work: the work to flush
2496 *
2497 * Wait until @work has finished execution. On return, it's
2498 * guaranteed that all queueing instances of @work which happened
2499 * before this function is called are finished. In other words, if
2500 * @work hasn't been requeued since this function was called, @work is
2501 * guaranteed to be idle on return.
2502 *
2503 * RETURNS:
2504 * %true if flush_work_sync() waited for the work to finish execution,
2505 * %false if it was already idle.
2506 */
2507bool flush_work_sync(struct work_struct *work)
2508{
2509 struct wq_barrier barr;
2510 bool pending, waited;
2511
2512 /* we'll wait for executions separately, queue barr only if pending */
2513 pending = start_flush_work(work, &barr, false);
2514
2515 /* wait for executions to finish */
2516 waited = wait_on_work(work);
2517
2518 /* wait for the pending one */
2519 if (pending) {
2520 wait_for_completion(&barr.done);
2521 destroy_work_on_stack(&barr.work);
2522 }
2523
2524 return pending || waited;
2525}
2526EXPORT_SYMBOL_GPL(flush_work_sync);
2527
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002528/*
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002529 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002530 * so this work can't be re-armed in any way.
2531 */
2532static int try_to_grab_pending(struct work_struct *work)
2533{
Tejun Heo8b03ae32010-06-29 10:07:12 +02002534 struct global_cwq *gcwq;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002535 int ret = -1;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002536
Tejun Heo22df02b2010-06-29 10:07:10 +02002537 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002538 return 0;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002539
2540 /*
2541 * The queueing is in progress, or it is already queued. Try to
2542 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2543 */
Tejun Heo7a22ad72010-06-29 10:07:13 +02002544 gcwq = get_work_gcwq(work);
2545 if (!gcwq)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002546 return ret;
2547
Tejun Heo8b03ae32010-06-29 10:07:12 +02002548 spin_lock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002549 if (!list_empty(&work->entry)) {
2550 /*
Tejun Heo7a22ad72010-06-29 10:07:13 +02002551 * This work is queued, but perhaps we locked the wrong gcwq.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002552 * In that case we must see the new value after rmb(), see
2553 * insert_work()->wmb().
2554 */
2555 smp_rmb();
Tejun Heo7a22ad72010-06-29 10:07:13 +02002556 if (gcwq == get_work_gcwq(work)) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002557 debug_work_deactivate(work);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002558 list_del_init(&work->entry);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002559 cwq_dec_nr_in_flight(get_work_cwq(work),
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02002560 get_work_color(work),
2561 *work_data_bits(work) & WORK_STRUCT_DELAYED);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002562 ret = 1;
2563 }
2564 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02002565 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002566
2567 return ret;
2568}
2569
Tejun Heo401a8d02010-09-16 10:36:00 +02002570static bool __cancel_work_timer(struct work_struct *work,
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002571 struct timer_list* timer)
2572{
2573 int ret;
2574
2575 do {
2576 ret = (timer && likely(del_timer(timer)));
2577 if (!ret)
2578 ret = try_to_grab_pending(work);
2579 wait_on_work(work);
2580 } while (unlikely(ret < 0));
2581
Tejun Heo7a22ad72010-06-29 10:07:13 +02002582 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002583 return ret;
2584}
2585
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002586/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002587 * cancel_work_sync - cancel a work and wait for it to finish
2588 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002589 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002590 * Cancel @work and wait for its execution to finish. This function
2591 * can be used even if the work re-queues itself or migrates to
2592 * another workqueue. On return from this function, @work is
2593 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002594 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002595 * cancel_work_sync(&delayed_work->work) must not be used for
2596 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002597 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002598 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002599 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002600 *
2601 * RETURNS:
2602 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002603 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002604bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002605{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002606 return __cancel_work_timer(work, NULL);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002607}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002608EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002609
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002610/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002611 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2612 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002613 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002614 * Delayed timer is cancelled and the pending work is queued for
2615 * immediate execution. Like flush_work(), this function only
2616 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002617 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002618 * RETURNS:
2619 * %true if flush_work() waited for the work to finish execution,
2620 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002621 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002622bool flush_delayed_work(struct delayed_work *dwork)
2623{
2624 if (del_timer_sync(&dwork->timer))
2625 __queue_work(raw_smp_processor_id(),
2626 get_work_cwq(&dwork->work)->wq, &dwork->work);
2627 return flush_work(&dwork->work);
2628}
2629EXPORT_SYMBOL(flush_delayed_work);
2630
2631/**
Tejun Heo09383492010-09-16 10:48:29 +02002632 * flush_delayed_work_sync - wait for a dwork to finish
2633 * @dwork: the delayed work to flush
2634 *
2635 * Delayed timer is cancelled and the pending work is queued for
2636 * execution immediately. Other than timer handling, its behavior
2637 * is identical to flush_work_sync().
2638 *
2639 * RETURNS:
2640 * %true if flush_work_sync() waited for the work to finish execution,
2641 * %false if it was already idle.
2642 */
2643bool flush_delayed_work_sync(struct delayed_work *dwork)
2644{
2645 if (del_timer_sync(&dwork->timer))
2646 __queue_work(raw_smp_processor_id(),
2647 get_work_cwq(&dwork->work)->wq, &dwork->work);
2648 return flush_work_sync(&dwork->work);
2649}
2650EXPORT_SYMBOL(flush_delayed_work_sync);
2651
2652/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002653 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2654 * @dwork: the delayed work cancel
2655 *
2656 * This is cancel_work_sync() for delayed works.
2657 *
2658 * RETURNS:
2659 * %true if @dwork was pending, %false otherwise.
2660 */
2661bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002662{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002663 return __cancel_work_timer(&dwork->work, &dwork->timer);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002664}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002665EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002667/**
2668 * schedule_work - put work task in global workqueue
2669 * @work: job to be done
2670 *
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02002671 * Returns zero if @work was already on the kernel-global workqueue and
2672 * non-zero otherwise.
2673 *
2674 * This puts a job in the kernel-global workqueue if it was not already
2675 * queued and leaves it in the same position on the kernel-global
2676 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002677 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002678int schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679{
Tejun Heod320c032010-06-29 10:07:14 +02002680 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681}
Dave Jonesae90dd52006-06-30 01:40:45 -04002682EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683
Zhang Ruic1a220e2008-07-23 21:28:39 -07002684/*
2685 * schedule_work_on - put work task on a specific cpu
2686 * @cpu: cpu to put the work task on
2687 * @work: job to be done
2688 *
2689 * This puts a job on a specific cpu
2690 */
2691int schedule_work_on(int cpu, struct work_struct *work)
2692{
Tejun Heod320c032010-06-29 10:07:14 +02002693 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07002694}
2695EXPORT_SYMBOL(schedule_work_on);
2696
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002697/**
2698 * schedule_delayed_work - put work task in global workqueue after delay
David Howells52bad642006-11-22 14:54:01 +00002699 * @dwork: job to be done
2700 * @delay: number of jiffies to wait or 0 for immediate execution
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002701 *
2702 * After waiting for a given time this puts a job in the kernel-global
2703 * workqueue.
2704 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002705int schedule_delayed_work(struct delayed_work *dwork,
Ingo Molnar82f67cd2007-02-16 01:28:13 -08002706 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002707{
Tejun Heod320c032010-06-29 10:07:14 +02002708 return queue_delayed_work(system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709}
Dave Jonesae90dd52006-06-30 01:40:45 -04002710EXPORT_SYMBOL(schedule_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002712/**
2713 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2714 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00002715 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002716 * @delay: number of jiffies to wait
2717 *
2718 * After waiting for a given time this puts a job in the kernel-global
2719 * workqueue on the specified CPU.
2720 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002721int schedule_delayed_work_on(int cpu,
David Howells52bad642006-11-22 14:54:01 +00002722 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723{
Tejun Heod320c032010-06-29 10:07:14 +02002724 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725}
Dave Jonesae90dd52006-06-30 01:40:45 -04002726EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727
Andrew Mortonb6136772006-06-25 05:47:49 -07002728/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002729 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002730 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002731 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002732 * schedule_on_each_cpu() executes @func on each online CPU using the
2733 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002734 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002735 *
2736 * RETURNS:
2737 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002738 */
David Howells65f27f32006-11-22 14:55:48 +00002739int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002740{
2741 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002742 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002743
Andrew Mortonb6136772006-06-25 05:47:49 -07002744 works = alloc_percpu(struct work_struct);
2745 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002746 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002747
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002748 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002749
Christoph Lameter15316ba2006-01-08 01:00:43 -08002750 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002751 struct work_struct *work = per_cpu_ptr(works, cpu);
2752
2753 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002754 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002755 }
Tejun Heo93981802009-11-17 14:06:20 -08002756
2757 for_each_online_cpu(cpu)
2758 flush_work(per_cpu_ptr(works, cpu));
2759
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002760 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002761 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002762 return 0;
2763}
2764
Alan Sterneef6a7d2010-02-12 17:39:21 +09002765/**
2766 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2767 *
2768 * Forces execution of the kernel-global workqueue and blocks until its
2769 * completion.
2770 *
2771 * Think twice before calling this function! It's very easy to get into
2772 * trouble if you don't take great care. Either of the following situations
2773 * will lead to deadlock:
2774 *
2775 * One of the work items currently on the workqueue needs to acquire
2776 * a lock held by your code or its caller.
2777 *
2778 * Your code is running in the context of a work routine.
2779 *
2780 * They will be detected by lockdep when they occur, but the first might not
2781 * occur very often. It depends on what work items are on the workqueue and
2782 * what locks they need, which you have no control over.
2783 *
2784 * In most situations flushing the entire workqueue is overkill; you merely
2785 * need to know that a particular work item isn't queued and isn't running.
2786 * In such cases you should use cancel_delayed_work_sync() or
2787 * cancel_work_sync() instead.
2788 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789void flush_scheduled_work(void)
2790{
Tejun Heod320c032010-06-29 10:07:14 +02002791 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792}
Dave Jonesae90dd52006-06-30 01:40:45 -04002793EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794
2795/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002796 * execute_in_process_context - reliably execute the routine with user context
2797 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002798 * @ew: guaranteed storage for the execute work structure (must
2799 * be available when the work executes)
2800 *
2801 * Executes the function immediately if process context is available,
2802 * otherwise schedules the function for delayed execution.
2803 *
2804 * Returns: 0 - function was executed
2805 * 1 - function was scheduled for execution
2806 */
David Howells65f27f32006-11-22 14:55:48 +00002807int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06002808{
2809 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00002810 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002811 return 0;
2812 }
2813
David Howells65f27f32006-11-22 14:55:48 +00002814 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002815 schedule_work(&ew->work);
2816
2817 return 1;
2818}
2819EXPORT_SYMBOL_GPL(execute_in_process_context);
2820
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821int keventd_up(void)
2822{
Tejun Heod320c032010-06-29 10:07:14 +02002823 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824}
2825
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002826static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827{
Oleg Nesterov3af244332007-05-09 02:34:09 -07002828 /*
Tejun Heo0f900042010-06-29 10:07:11 +02002829 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
2830 * Make sure that the alignment isn't lower than that of
2831 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07002832 */
Tejun Heo0f900042010-06-29 10:07:11 +02002833 const size_t size = sizeof(struct cpu_workqueue_struct);
2834 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
2835 __alignof__(unsigned long long));
Tejun Heo931ac772010-07-20 11:07:48 +02002836#ifdef CONFIG_SMP
2837 bool percpu = !(wq->flags & WQ_UNBOUND);
2838#else
2839 bool percpu = false;
2840#endif
Oleg Nesterov3af244332007-05-09 02:34:09 -07002841
Tejun Heo931ac772010-07-20 11:07:48 +02002842 if (percpu)
Tejun Heof3421792010-07-02 10:03:51 +02002843 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02002844 else {
Tejun Heof3421792010-07-02 10:03:51 +02002845 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01002846
Tejun Heof3421792010-07-02 10:03:51 +02002847 /*
2848 * Allocate enough room to align cwq and put an extra
2849 * pointer at the end pointing back to the originally
2850 * allocated pointer which will be used for free.
2851 */
2852 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2853 if (ptr) {
2854 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2855 *(void **)(wq->cpu_wq.single + 1) = ptr;
2856 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002857 }
Tejun Heof3421792010-07-02 10:03:51 +02002858
David Howells52605622010-10-25 23:41:11 +01002859 /* just in case, make sure it's actually aligned
2860 * - this is affected by PERCPU() alignment in vmlinux.lds.S
2861 */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002862 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2863 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002864}
2865
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002866static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07002867{
Tejun Heo931ac772010-07-20 11:07:48 +02002868#ifdef CONFIG_SMP
2869 bool percpu = !(wq->flags & WQ_UNBOUND);
2870#else
2871 bool percpu = false;
2872#endif
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07002873
Tejun Heo931ac772010-07-20 11:07:48 +02002874 if (percpu)
Tejun Heof3421792010-07-02 10:03:51 +02002875 free_percpu(wq->cpu_wq.pcpu);
2876 else if (wq->cpu_wq.single) {
2877 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002878 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07002879 }
2880}
2881
Tejun Heof3421792010-07-02 10:03:51 +02002882static int wq_clamp_max_active(int max_active, unsigned int flags,
2883 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02002884{
Tejun Heof3421792010-07-02 10:03:51 +02002885 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2886
2887 if (max_active < 1 || max_active > lim)
Tejun Heob71ab8c2010-06-29 10:07:14 +02002888 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2889 "is out of range, clamping between %d and %d\n",
Tejun Heof3421792010-07-02 10:03:51 +02002890 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002891
Tejun Heof3421792010-07-02 10:03:51 +02002892 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002893}
2894
Tejun Heod320c032010-06-29 10:07:14 +02002895struct workqueue_struct *__alloc_workqueue_key(const char *name,
2896 unsigned int flags,
2897 int max_active,
2898 struct lock_class_key *key,
2899 const char *lock_name)
Oleg Nesterov3af244332007-05-09 02:34:09 -07002900{
2901 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02002902 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002903
Tejun Heof3421792010-07-02 10:03:51 +02002904 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02002905 * Workqueues which may be used during memory reclaim should
2906 * have a rescuer to guarantee forward progress.
2907 */
2908 if (flags & WQ_MEM_RECLAIM)
2909 flags |= WQ_RESCUER;
2910
2911 /*
Tejun Heof3421792010-07-02 10:03:51 +02002912 * Unbound workqueues aren't concurrency managed and should be
2913 * dispatched to workers immediately.
2914 */
2915 if (flags & WQ_UNBOUND)
2916 flags |= WQ_HIGHPRI;
2917
Tejun Heod320c032010-06-29 10:07:14 +02002918 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heof3421792010-07-02 10:03:51 +02002919 max_active = wq_clamp_max_active(max_active, flags, name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002920
2921 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
2922 if (!wq)
Tejun Heo4690c4a2010-06-29 10:07:10 +02002923 goto err;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002924
Tejun Heo97e37d72010-06-29 10:07:10 +02002925 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002926 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02002927 mutex_init(&wq->flush_mutex);
2928 atomic_set(&wq->nr_cwqs_to_flush, 0);
2929 INIT_LIST_HEAD(&wq->flusher_queue);
2930 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002931
2932 wq->name = name;
Johannes Bergeb13ba82008-01-16 09:51:58 +01002933 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07002934 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002935
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002936 if (alloc_cwqs(wq) < 0)
2937 goto err;
2938
Tejun Heof3421792010-07-02 10:03:51 +02002939 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02002940 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002941 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo15376632010-06-29 10:07:11 +02002942
Tejun Heo0f900042010-06-29 10:07:11 +02002943 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002944 cwq->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02002945 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002946 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02002947 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02002948 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002949 }
2950
Tejun Heoe22bee72010-06-29 10:07:14 +02002951 if (flags & WQ_RESCUER) {
2952 struct worker *rescuer;
2953
Tejun Heof2e005a2010-07-20 15:59:09 +02002954 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02002955 goto err;
2956
2957 wq->rescuer = rescuer = alloc_worker();
2958 if (!rescuer)
2959 goto err;
2960
2961 rescuer->task = kthread_create(rescuer_thread, wq, "%s", name);
2962 if (IS_ERR(rescuer->task))
2963 goto err;
2964
Tejun Heoe22bee72010-06-29 10:07:14 +02002965 rescuer->task->flags |= PF_THREAD_BOUND;
2966 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002967 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002968
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002969 /*
2970 * workqueue_lock protects global freeze state and workqueues
2971 * list. Grab it, set max_active accordingly and add the new
2972 * workqueue to workqueues list.
2973 */
Tejun Heo15376632010-06-29 10:07:11 +02002974 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002975
Tejun Heo58a69cb2011-02-16 09:25:31 +01002976 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02002977 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002978 get_cwq(cpu, wq)->max_active = 0;
2979
Tejun Heo15376632010-06-29 10:07:11 +02002980 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002981
Tejun Heo15376632010-06-29 10:07:11 +02002982 spin_unlock(&workqueue_lock);
2983
Oleg Nesterov3af244332007-05-09 02:34:09 -07002984 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02002985err:
2986 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002987 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02002988 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002989 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02002990 kfree(wq);
2991 }
2992 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002993}
Tejun Heod320c032010-06-29 10:07:14 +02002994EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002995
2996/**
2997 * destroy_workqueue - safely terminate a workqueue
2998 * @wq: target workqueue
2999 *
3000 * Safely destroy a workqueue. All work currently pending will be done first.
3001 */
3002void destroy_workqueue(struct workqueue_struct *wq)
3003{
Tejun Heoc8efcc22010-12-20 19:32:04 +01003004 unsigned int flush_cnt = 0;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003005 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003006
Tejun Heoc8efcc22010-12-20 19:32:04 +01003007 /*
3008 * Mark @wq dying and drain all pending works. Once WQ_DYING is
3009 * set, only chain queueing is allowed. IOW, only currently
3010 * pending or running work items on @wq can queue further work
3011 * items on it. @wq is flushed repeatedly until it becomes empty.
3012 * The number of flushing is detemined by the depth of chaining and
3013 * should be relatively short. Whine if it takes too long.
3014 */
Tejun Heoe41e7042010-08-24 14:22:47 +02003015 wq->flags |= WQ_DYING;
Tejun Heoc8efcc22010-12-20 19:32:04 +01003016reflush:
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003017 flush_workqueue(wq);
3018
Tejun Heoc8efcc22010-12-20 19:32:04 +01003019 for_each_cwq_cpu(cpu, wq) {
3020 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3021
3022 if (!cwq->nr_active && list_empty(&cwq->delayed_works))
3023 continue;
3024
3025 if (++flush_cnt == 10 ||
3026 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
3027 printk(KERN_WARNING "workqueue %s: flush on "
3028 "destruction isn't complete after %u tries\n",
3029 wq->name, flush_cnt);
3030 goto reflush;
3031 }
3032
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003033 /*
3034 * wq list is used to freeze wq, remove from list after
3035 * flushing is complete in case freeze races us.
3036 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003037 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003038 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003039 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003040
Tejun Heoe22bee72010-06-29 10:07:14 +02003041 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003042 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003043 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3044 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003045
Tejun Heo73f53c42010-06-29 10:07:11 +02003046 for (i = 0; i < WORK_NR_COLORS; i++)
3047 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003048 BUG_ON(cwq->nr_active);
3049 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003050 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003051
Tejun Heoe22bee72010-06-29 10:07:14 +02003052 if (wq->flags & WQ_RESCUER) {
3053 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003054 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003055 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003056 }
3057
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003058 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003059 kfree(wq);
3060}
3061EXPORT_SYMBOL_GPL(destroy_workqueue);
3062
Tejun Heodcd989c2010-06-29 10:07:14 +02003063/**
3064 * workqueue_set_max_active - adjust max_active of a workqueue
3065 * @wq: target workqueue
3066 * @max_active: new max_active value.
3067 *
3068 * Set max_active of @wq to @max_active.
3069 *
3070 * CONTEXT:
3071 * Don't call from IRQ context.
3072 */
3073void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3074{
3075 unsigned int cpu;
3076
Tejun Heof3421792010-07-02 10:03:51 +02003077 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003078
3079 spin_lock(&workqueue_lock);
3080
3081 wq->saved_max_active = max_active;
3082
Tejun Heof3421792010-07-02 10:03:51 +02003083 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003084 struct global_cwq *gcwq = get_gcwq(cpu);
3085
3086 spin_lock_irq(&gcwq->lock);
3087
Tejun Heo58a69cb2011-02-16 09:25:31 +01003088 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003089 !(gcwq->flags & GCWQ_FREEZING))
3090 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3091
3092 spin_unlock_irq(&gcwq->lock);
3093 }
3094
3095 spin_unlock(&workqueue_lock);
3096}
3097EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3098
3099/**
3100 * workqueue_congested - test whether a workqueue is congested
3101 * @cpu: CPU in question
3102 * @wq: target workqueue
3103 *
3104 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3105 * no synchronization around this function and the test result is
3106 * unreliable and only useful as advisory hints or for debugging.
3107 *
3108 * RETURNS:
3109 * %true if congested, %false otherwise.
3110 */
3111bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3112{
3113 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3114
3115 return !list_empty(&cwq->delayed_works);
3116}
3117EXPORT_SYMBOL_GPL(workqueue_congested);
3118
3119/**
3120 * work_cpu - return the last known associated cpu for @work
3121 * @work: the work of interest
3122 *
3123 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003124 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003125 */
3126unsigned int work_cpu(struct work_struct *work)
3127{
3128 struct global_cwq *gcwq = get_work_gcwq(work);
3129
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003130 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003131}
3132EXPORT_SYMBOL_GPL(work_cpu);
3133
3134/**
3135 * work_busy - test whether a work is currently pending or running
3136 * @work: the work to be tested
3137 *
3138 * Test whether @work is currently pending or running. There is no
3139 * synchronization around this function and the test result is
3140 * unreliable and only useful as advisory hints or for debugging.
3141 * Especially for reentrant wqs, the pending state might hide the
3142 * running state.
3143 *
3144 * RETURNS:
3145 * OR'd bitmask of WORK_BUSY_* bits.
3146 */
3147unsigned int work_busy(struct work_struct *work)
3148{
3149 struct global_cwq *gcwq = get_work_gcwq(work);
3150 unsigned long flags;
3151 unsigned int ret = 0;
3152
3153 if (!gcwq)
3154 return false;
3155
3156 spin_lock_irqsave(&gcwq->lock, flags);
3157
3158 if (work_pending(work))
3159 ret |= WORK_BUSY_PENDING;
3160 if (find_worker_executing_work(gcwq, work))
3161 ret |= WORK_BUSY_RUNNING;
3162
3163 spin_unlock_irqrestore(&gcwq->lock, flags);
3164
3165 return ret;
3166}
3167EXPORT_SYMBOL_GPL(work_busy);
3168
Tejun Heodb7bccf2010-06-29 10:07:12 +02003169/*
3170 * CPU hotplug.
3171 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003172 * There are two challenges in supporting CPU hotplug. Firstly, there
3173 * are a lot of assumptions on strong associations among work, cwq and
3174 * gcwq which make migrating pending and scheduled works very
3175 * difficult to implement without impacting hot paths. Secondly,
3176 * gcwqs serve mix of short, long and very long running works making
3177 * blocked draining impractical.
3178 *
3179 * This is solved by allowing a gcwq to be detached from CPU, running
3180 * it with unbound (rogue) workers and allowing it to be reattached
3181 * later if the cpu comes back online. A separate thread is created
3182 * to govern a gcwq in such state and is called the trustee of the
3183 * gcwq.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003184 *
3185 * Trustee states and their descriptions.
3186 *
3187 * START Command state used on startup. On CPU_DOWN_PREPARE, a
3188 * new trustee is started with this state.
3189 *
3190 * IN_CHARGE Once started, trustee will enter this state after
Tejun Heoe22bee72010-06-29 10:07:14 +02003191 * assuming the manager role and making all existing
3192 * workers rogue. DOWN_PREPARE waits for trustee to
3193 * enter this state. After reaching IN_CHARGE, trustee
3194 * tries to execute the pending worklist until it's empty
3195 * and the state is set to BUTCHER, or the state is set
3196 * to RELEASE.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003197 *
3198 * BUTCHER Command state which is set by the cpu callback after
3199 * the cpu has went down. Once this state is set trustee
3200 * knows that there will be no new works on the worklist
3201 * and once the worklist is empty it can proceed to
3202 * killing idle workers.
3203 *
3204 * RELEASE Command state which is set by the cpu callback if the
3205 * cpu down has been canceled or it has come online
3206 * again. After recognizing this state, trustee stops
Tejun Heoe22bee72010-06-29 10:07:14 +02003207 * trying to drain or butcher and clears ROGUE, rebinds
3208 * all remaining workers back to the cpu and releases
3209 * manager role.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003210 *
3211 * DONE Trustee will enter this state after BUTCHER or RELEASE
3212 * is complete.
3213 *
3214 * trustee CPU draining
3215 * took over down complete
3216 * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3217 * | | ^
3218 * | CPU is back online v return workers |
3219 * ----------------> RELEASE --------------
3220 */
3221
3222/**
3223 * trustee_wait_event_timeout - timed event wait for trustee
3224 * @cond: condition to wait for
3225 * @timeout: timeout in jiffies
3226 *
3227 * wait_event_timeout() for trustee to use. Handles locking and
3228 * checks for RELEASE request.
3229 *
3230 * CONTEXT:
3231 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3232 * multiple times. To be used by trustee.
3233 *
3234 * RETURNS:
3235 * Positive indicating left time if @cond is satisfied, 0 if timed
3236 * out, -1 if canceled.
3237 */
3238#define trustee_wait_event_timeout(cond, timeout) ({ \
3239 long __ret = (timeout); \
3240 while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
3241 __ret) { \
3242 spin_unlock_irq(&gcwq->lock); \
3243 __wait_event_timeout(gcwq->trustee_wait, (cond) || \
3244 (gcwq->trustee_state == TRUSTEE_RELEASE), \
3245 __ret); \
3246 spin_lock_irq(&gcwq->lock); \
3247 } \
3248 gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \
3249})
3250
3251/**
3252 * trustee_wait_event - event wait for trustee
3253 * @cond: condition to wait for
3254 *
3255 * wait_event() for trustee to use. Automatically handles locking and
3256 * checks for CANCEL request.
3257 *
3258 * CONTEXT:
3259 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3260 * multiple times. To be used by trustee.
3261 *
3262 * RETURNS:
3263 * 0 if @cond is satisfied, -1 if canceled.
3264 */
3265#define trustee_wait_event(cond) ({ \
3266 long __ret1; \
3267 __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3268 __ret1 < 0 ? -1 : 0; \
3269})
3270
3271static int __cpuinit trustee_thread(void *__gcwq)
3272{
3273 struct global_cwq *gcwq = __gcwq;
3274 struct worker *worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02003275 struct work_struct *work;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003276 struct hlist_node *pos;
Tejun Heoe22bee72010-06-29 10:07:14 +02003277 long rc;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003278 int i;
3279
3280 BUG_ON(gcwq->cpu != smp_processor_id());
3281
3282 spin_lock_irq(&gcwq->lock);
3283 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02003284 * Claim the manager position and make all workers rogue.
3285 * Trustee must be bound to the target cpu and can't be
3286 * cancelled.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003287 */
3288 BUG_ON(gcwq->cpu != smp_processor_id());
Tejun Heoe22bee72010-06-29 10:07:14 +02003289 rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
3290 BUG_ON(rc < 0);
3291
3292 gcwq->flags |= GCWQ_MANAGING_WORKERS;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003293
3294 list_for_each_entry(worker, &gcwq->idle_list, entry)
Tejun Heocb444762010-07-02 10:03:50 +02003295 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003296
3297 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heocb444762010-07-02 10:03:50 +02003298 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003299
3300 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02003301 * Call schedule() so that we cross rq->lock and thus can
3302 * guarantee sched callbacks see the rogue flag. This is
3303 * necessary as scheduler callbacks may be invoked from other
3304 * cpus.
3305 */
3306 spin_unlock_irq(&gcwq->lock);
3307 schedule();
3308 spin_lock_irq(&gcwq->lock);
3309
3310 /*
Tejun Heocb444762010-07-02 10:03:50 +02003311 * Sched callbacks are disabled now. Zap nr_running. After
3312 * this, nr_running stays zero and need_more_worker() and
3313 * keep_working() are always true as long as the worklist is
3314 * not empty.
Tejun Heoe22bee72010-06-29 10:07:14 +02003315 */
Tejun Heocb444762010-07-02 10:03:50 +02003316 atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
Tejun Heoe22bee72010-06-29 10:07:14 +02003317
3318 spin_unlock_irq(&gcwq->lock);
3319 del_timer_sync(&gcwq->idle_timer);
3320 spin_lock_irq(&gcwq->lock);
3321
3322 /*
Tejun Heodb7bccf2010-06-29 10:07:12 +02003323 * We're now in charge. Notify and proceed to drain. We need
3324 * to keep the gcwq running during the whole CPU down
3325 * procedure as other cpu hotunplug callbacks may need to
3326 * flush currently running tasks.
3327 */
3328 gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3329 wake_up_all(&gcwq->trustee_wait);
3330
3331 /*
3332 * The original cpu is in the process of dying and may go away
3333 * anytime now. When that happens, we and all workers would
Tejun Heoe22bee72010-06-29 10:07:14 +02003334 * be migrated to other cpus. Try draining any left work. We
3335 * want to get it over with ASAP - spam rescuers, wake up as
3336 * many idlers as necessary and create new ones till the
3337 * worklist is empty. Note that if the gcwq is frozen, there
Tejun Heo58a69cb2011-02-16 09:25:31 +01003338 * may be frozen works in freezable cwqs. Don't declare
Tejun Heoe22bee72010-06-29 10:07:14 +02003339 * completion while frozen.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003340 */
3341 while (gcwq->nr_workers != gcwq->nr_idle ||
3342 gcwq->flags & GCWQ_FREEZING ||
3343 gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003344 int nr_works = 0;
3345
3346 list_for_each_entry(work, &gcwq->worklist, entry) {
3347 send_mayday(work);
3348 nr_works++;
3349 }
3350
3351 list_for_each_entry(worker, &gcwq->idle_list, entry) {
3352 if (!nr_works--)
3353 break;
3354 wake_up_process(worker->task);
3355 }
3356
3357 if (need_to_create_worker(gcwq)) {
3358 spin_unlock_irq(&gcwq->lock);
3359 worker = create_worker(gcwq, false);
3360 spin_lock_irq(&gcwq->lock);
3361 if (worker) {
Tejun Heocb444762010-07-02 10:03:50 +02003362 worker->flags |= WORKER_ROGUE;
Tejun Heoe22bee72010-06-29 10:07:14 +02003363 start_worker(worker);
3364 }
3365 }
3366
Tejun Heodb7bccf2010-06-29 10:07:12 +02003367 /* give a breather */
3368 if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3369 break;
3370 }
3371
Tejun Heoe22bee72010-06-29 10:07:14 +02003372 /*
3373 * Either all works have been scheduled and cpu is down, or
3374 * cpu down has already been canceled. Wait for and butcher
3375 * all workers till we're canceled.
3376 */
3377 do {
3378 rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
3379 while (!list_empty(&gcwq->idle_list))
3380 destroy_worker(list_first_entry(&gcwq->idle_list,
3381 struct worker, entry));
3382 } while (gcwq->nr_workers && rc >= 0);
3383
3384 /*
3385 * At this point, either draining has completed and no worker
3386 * is left, or cpu down has been canceled or the cpu is being
3387 * brought back up. There shouldn't be any idle one left.
3388 * Tell the remaining busy ones to rebind once it finishes the
3389 * currently scheduled works by scheduling the rebind_work.
3390 */
3391 WARN_ON(!list_empty(&gcwq->idle_list));
3392
3393 for_each_busy_worker(worker, i, pos, gcwq) {
3394 struct work_struct *rebind_work = &worker->rebind_work;
3395
3396 /*
3397 * Rebind_work may race with future cpu hotplug
3398 * operations. Use a separate flag to mark that
3399 * rebinding is scheduled.
3400 */
Tejun Heocb444762010-07-02 10:03:50 +02003401 worker->flags |= WORKER_REBIND;
3402 worker->flags &= ~WORKER_ROGUE;
Tejun Heoe22bee72010-06-29 10:07:14 +02003403
3404 /* queue rebind_work, wq doesn't matter, use the default one */
3405 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3406 work_data_bits(rebind_work)))
3407 continue;
3408
3409 debug_work_activate(rebind_work);
Tejun Heod320c032010-06-29 10:07:14 +02003410 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
Tejun Heoe22bee72010-06-29 10:07:14 +02003411 worker->scheduled.next,
3412 work_color_to_flags(WORK_NO_COLOR));
3413 }
3414
3415 /* relinquish manager role */
3416 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
3417
Tejun Heodb7bccf2010-06-29 10:07:12 +02003418 /* notify completion */
3419 gcwq->trustee = NULL;
3420 gcwq->trustee_state = TRUSTEE_DONE;
3421 wake_up_all(&gcwq->trustee_wait);
3422 spin_unlock_irq(&gcwq->lock);
3423 return 0;
3424}
3425
3426/**
3427 * wait_trustee_state - wait for trustee to enter the specified state
3428 * @gcwq: gcwq the trustee of interest belongs to
3429 * @state: target state to wait for
3430 *
3431 * Wait for the trustee to reach @state. DONE is already matched.
3432 *
3433 * CONTEXT:
3434 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3435 * multiple times. To be used by cpu_callback.
3436 */
3437static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09003438__releases(&gcwq->lock)
3439__acquires(&gcwq->lock)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003440{
3441 if (!(gcwq->trustee_state == state ||
3442 gcwq->trustee_state == TRUSTEE_DONE)) {
3443 spin_unlock_irq(&gcwq->lock);
3444 __wait_event(gcwq->trustee_wait,
3445 gcwq->trustee_state == state ||
3446 gcwq->trustee_state == TRUSTEE_DONE);
3447 spin_lock_irq(&gcwq->lock);
3448 }
3449}
3450
Oleg Nesterov3af244332007-05-09 02:34:09 -07003451static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
3452 unsigned long action,
3453 void *hcpu)
3454{
3455 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003456 struct global_cwq *gcwq = get_gcwq(cpu);
3457 struct task_struct *new_trustee = NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +02003458 struct worker *uninitialized_var(new_worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003459 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003460
Rafael J. Wysocki8bb78442007-05-09 02:35:10 -07003461 action &= ~CPU_TASKS_FROZEN;
3462
Linus Torvalds1da177e2005-04-16 15:20:36 -07003463 switch (action) {
Tejun Heodb7bccf2010-06-29 10:07:12 +02003464 case CPU_DOWN_PREPARE:
3465 new_trustee = kthread_create(trustee_thread, gcwq,
3466 "workqueue_trustee/%d\n", cpu);
3467 if (IS_ERR(new_trustee))
3468 return notifier_from_errno(PTR_ERR(new_trustee));
3469 kthread_bind(new_trustee, cpu);
Tejun Heoe22bee72010-06-29 10:07:14 +02003470 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003471 case CPU_UP_PREPARE:
Tejun Heoe22bee72010-06-29 10:07:14 +02003472 BUG_ON(gcwq->first_idle);
3473 new_worker = create_worker(gcwq, false);
3474 if (!new_worker) {
3475 if (new_trustee)
3476 kthread_stop(new_trustee);
3477 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003478 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003479 }
3480
Tejun Heodb7bccf2010-06-29 10:07:12 +02003481 /* some are called w/ irq disabled, don't disturb irq status */
3482 spin_lock_irqsave(&gcwq->lock, flags);
3483
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003484 switch (action) {
Tejun Heodb7bccf2010-06-29 10:07:12 +02003485 case CPU_DOWN_PREPARE:
3486 /* initialize trustee and tell it to acquire the gcwq */
3487 BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3488 gcwq->trustee = new_trustee;
3489 gcwq->trustee_state = TRUSTEE_START;
3490 wake_up_process(gcwq->trustee);
3491 wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003492 /* fall through */
3493 case CPU_UP_PREPARE:
3494 BUG_ON(gcwq->first_idle);
3495 gcwq->first_idle = new_worker;
3496 break;
3497
3498 case CPU_DYING:
3499 /*
3500 * Before this, the trustee and all workers except for
3501 * the ones which are still executing works from
3502 * before the last CPU down must be on the cpu. After
3503 * this, they'll all be diasporas.
3504 */
3505 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003506 break;
3507
Oleg Nesterov3da1c842008-07-25 01:47:50 -07003508 case CPU_POST_DEAD:
Tejun Heodb7bccf2010-06-29 10:07:12 +02003509 gcwq->trustee_state = TRUSTEE_BUTCHER;
Tejun Heoe22bee72010-06-29 10:07:14 +02003510 /* fall through */
3511 case CPU_UP_CANCELED:
3512 destroy_worker(gcwq->first_idle);
3513 gcwq->first_idle = NULL;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003514 break;
3515
3516 case CPU_DOWN_FAILED:
3517 case CPU_ONLINE:
Tejun Heoe22bee72010-06-29 10:07:14 +02003518 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003519 if (gcwq->trustee_state != TRUSTEE_DONE) {
3520 gcwq->trustee_state = TRUSTEE_RELEASE;
3521 wake_up_process(gcwq->trustee);
3522 wait_trustee_state(gcwq, TRUSTEE_DONE);
3523 }
3524
Tejun Heoe22bee72010-06-29 10:07:14 +02003525 /*
3526 * Trustee is done and there might be no worker left.
3527 * Put the first_idle in and request a real manager to
3528 * take a look.
3529 */
3530 spin_unlock_irq(&gcwq->lock);
3531 kthread_bind(gcwq->first_idle->task, cpu);
3532 spin_lock_irq(&gcwq->lock);
3533 gcwq->flags |= GCWQ_MANAGE_WORKERS;
3534 start_worker(gcwq->first_idle);
3535 gcwq->first_idle = NULL;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003536 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003537 }
3538
Tejun Heodb7bccf2010-06-29 10:07:12 +02003539 spin_unlock_irqrestore(&gcwq->lock, flags);
3540
Tejun Heo15376632010-06-29 10:07:11 +02003541 return notifier_from_errno(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003542}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003543
Rusty Russell2d3854a2008-11-05 13:39:10 +11003544#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003545
Rusty Russell2d3854a2008-11-05 13:39:10 +11003546struct work_for_cpu {
Andrew Morton6b44003e2009-04-09 09:50:37 -06003547 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003548 long (*fn)(void *);
3549 void *arg;
3550 long ret;
3551};
3552
Andrew Morton6b44003e2009-04-09 09:50:37 -06003553static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003554{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003555 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003556 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b44003e2009-04-09 09:50:37 -06003557 complete(&wfc->completion);
3558 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003559}
3560
3561/**
3562 * work_on_cpu - run a function in user context on a particular cpu
3563 * @cpu: the cpu to run on
3564 * @fn: the function to run
3565 * @arg: the function arg
3566 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003567 * This will return the value @fn returns.
3568 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06003569 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003570 */
3571long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3572{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003573 struct task_struct *sub_thread;
3574 struct work_for_cpu wfc = {
3575 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3576 .fn = fn,
3577 .arg = arg,
3578 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003579
Andrew Morton6b44003e2009-04-09 09:50:37 -06003580 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3581 if (IS_ERR(sub_thread))
3582 return PTR_ERR(sub_thread);
3583 kthread_bind(sub_thread, cpu);
3584 wake_up_process(sub_thread);
3585 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003586 return wfc.ret;
3587}
3588EXPORT_SYMBOL_GPL(work_on_cpu);
3589#endif /* CONFIG_SMP */
3590
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003591#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303592
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003593/**
3594 * freeze_workqueues_begin - begin freezing workqueues
3595 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003596 * Start freezing workqueues. After this function returns, all freezable
3597 * workqueues will queue new works to their frozen_works list instead of
3598 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003599 *
3600 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003601 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003602 */
3603void freeze_workqueues_begin(void)
3604{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003605 unsigned int cpu;
3606
3607 spin_lock(&workqueue_lock);
3608
3609 BUG_ON(workqueue_freezing);
3610 workqueue_freezing = true;
3611
Tejun Heof3421792010-07-02 10:03:51 +02003612 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003613 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003614 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003615
3616 spin_lock_irq(&gcwq->lock);
3617
Tejun Heodb7bccf2010-06-29 10:07:12 +02003618 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3619 gcwq->flags |= GCWQ_FREEZING;
3620
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003621 list_for_each_entry(wq, &workqueues, list) {
3622 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3623
Tejun Heo58a69cb2011-02-16 09:25:31 +01003624 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003625 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003626 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003627
3628 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003629 }
3630
3631 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003632}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003633
3634/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003635 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003636 *
3637 * Check whether freezing is complete. This function must be called
3638 * between freeze_workqueues_begin() and thaw_workqueues().
3639 *
3640 * CONTEXT:
3641 * Grabs and releases workqueue_lock.
3642 *
3643 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003644 * %true if some freezable workqueues are still busy. %false if freezing
3645 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003646 */
3647bool freeze_workqueues_busy(void)
3648{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003649 unsigned int cpu;
3650 bool busy = false;
3651
3652 spin_lock(&workqueue_lock);
3653
3654 BUG_ON(!workqueue_freezing);
3655
Tejun Heof3421792010-07-02 10:03:51 +02003656 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003657 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003658 /*
3659 * nr_active is monotonically decreasing. It's safe
3660 * to peek without lock.
3661 */
3662 list_for_each_entry(wq, &workqueues, list) {
3663 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3664
Tejun Heo58a69cb2011-02-16 09:25:31 +01003665 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003666 continue;
3667
3668 BUG_ON(cwq->nr_active < 0);
3669 if (cwq->nr_active) {
3670 busy = true;
3671 goto out_unlock;
3672 }
3673 }
3674 }
3675out_unlock:
3676 spin_unlock(&workqueue_lock);
3677 return busy;
3678}
3679
3680/**
3681 * thaw_workqueues - thaw workqueues
3682 *
3683 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003684 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003685 *
3686 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003687 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003688 */
3689void thaw_workqueues(void)
3690{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003691 unsigned int cpu;
3692
3693 spin_lock(&workqueue_lock);
3694
3695 if (!workqueue_freezing)
3696 goto out_unlock;
3697
Tejun Heof3421792010-07-02 10:03:51 +02003698 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003699 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003700 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003701
3702 spin_lock_irq(&gcwq->lock);
3703
Tejun Heodb7bccf2010-06-29 10:07:12 +02003704 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3705 gcwq->flags &= ~GCWQ_FREEZING;
3706
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003707 list_for_each_entry(wq, &workqueues, list) {
3708 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3709
Tejun Heo58a69cb2011-02-16 09:25:31 +01003710 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003711 continue;
3712
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003713 /* restore max_active and repopulate worklist */
3714 cwq->max_active = wq->saved_max_active;
3715
3716 while (!list_empty(&cwq->delayed_works) &&
3717 cwq->nr_active < cwq->max_active)
3718 cwq_activate_first_delayed(cwq);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003719 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003720
Tejun Heoe22bee72010-06-29 10:07:14 +02003721 wake_up_worker(gcwq);
3722
Tejun Heo8b03ae32010-06-29 10:07:12 +02003723 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003724 }
3725
3726 workqueue_freezing = false;
3727out_unlock:
3728 spin_unlock(&workqueue_lock);
3729}
3730#endif /* CONFIG_FREEZER */
3731
Suresh Siddha6ee05782010-07-30 14:57:37 -07003732static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003733{
Tejun Heoc34056a2010-06-29 10:07:11 +02003734 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003735 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003736
Tejun Heof6500942010-08-09 11:50:34 +02003737 cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003738
3739 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003740 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003741 struct global_cwq *gcwq = get_gcwq(cpu);
3742
3743 spin_lock_init(&gcwq->lock);
Tejun Heo7e116292010-06-29 10:07:13 +02003744 INIT_LIST_HEAD(&gcwq->worklist);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003745 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003746 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003747
Tejun Heoc8e55f32010-06-29 10:07:12 +02003748 INIT_LIST_HEAD(&gcwq->idle_list);
3749 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3750 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3751
Tejun Heoe22bee72010-06-29 10:07:14 +02003752 init_timer_deferrable(&gcwq->idle_timer);
3753 gcwq->idle_timer.function = idle_worker_timeout;
3754 gcwq->idle_timer.data = (unsigned long)gcwq;
3755
3756 setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
3757 (unsigned long)gcwq);
3758
Tejun Heo8b03ae32010-06-29 10:07:12 +02003759 ida_init(&gcwq->worker_ida);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003760
3761 gcwq->trustee_state = TRUSTEE_DONE;
3762 init_waitqueue_head(&gcwq->trustee_wait);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003763 }
3764
Tejun Heoe22bee72010-06-29 10:07:14 +02003765 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003766 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003767 struct global_cwq *gcwq = get_gcwq(cpu);
3768 struct worker *worker;
3769
Tejun Heo477a3c32010-08-31 10:54:35 +02003770 if (cpu != WORK_CPU_UNBOUND)
3771 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heoe22bee72010-06-29 10:07:14 +02003772 worker = create_worker(gcwq, true);
3773 BUG_ON(!worker);
3774 spin_lock_irq(&gcwq->lock);
3775 start_worker(worker);
3776 spin_unlock_irq(&gcwq->lock);
3777 }
3778
Tejun Heod320c032010-06-29 10:07:14 +02003779 system_wq = alloc_workqueue("events", 0, 0);
3780 system_long_wq = alloc_workqueue("events_long", 0, 0);
3781 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003782 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3783 WQ_UNBOUND_MAX_ACTIVE);
Hitoshi Mitakee5cba242010-11-26 12:06:44 +01003784 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
3785 !system_unbound_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003786 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003787}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003788early_initcall(init_workqueues);