blob: bce1074bdec1e826071a38662e43c4d8d74c10bc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/kernel/workqueue.c
3 *
4 * Generic mechanism for defining kernel helper threads for running
5 * arbitrary tasks in process context.
6 *
7 * Started by Ingo Molnar, Copyright (C) 2002
8 *
9 * Derived from the taskqueue/keventd code by:
10 *
11 * David Woodhouse <dwmw2@infradead.org>
Francois Camie1f8e872008-10-15 22:01:59 -070012 * Andrew Morton
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
14 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080015 *
Christoph Lametercde53532008-07-04 09:59:22 -070016 * Made to use alloc_percpu by Christoph Lameter.
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18
19#include <linux/module.h>
20#include <linux/kernel.h>
21#include <linux/sched.h>
22#include <linux/init.h>
23#include <linux/signal.h>
24#include <linux/completion.h>
25#include <linux/workqueue.h>
26#include <linux/slab.h>
27#include <linux/cpu.h>
28#include <linux/notifier.h>
29#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060030#include <linux/hardirq.h>
Christoph Lameter46934022006-10-11 01:21:26 -070031#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080032#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080033#include <linux/kallsyms.h>
34#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070035#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020036#include <linux/idr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Tejun Heoc8e55f32010-06-29 10:07:12 +020038enum {
Tejun Heodb7bccf2010-06-29 10:07:12 +020039 /* global_cwq flags */
40 GCWQ_FREEZING = 1 << 3, /* freeze in progress */
41
Tejun Heoc8e55f32010-06-29 10:07:12 +020042 /* worker flags */
43 WORKER_STARTED = 1 << 0, /* started */
44 WORKER_DIE = 1 << 1, /* die die die */
45 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heodb7bccf2010-06-29 10:07:12 +020046 WORKER_ROGUE = 1 << 4, /* not bound to any cpu */
47
48 /* gcwq->trustee_state */
49 TRUSTEE_START = 0, /* start */
50 TRUSTEE_IN_CHARGE = 1, /* trustee in charge of gcwq */
51 TRUSTEE_BUTCHER = 2, /* butcher workers */
52 TRUSTEE_RELEASE = 3, /* release workers */
53 TRUSTEE_DONE = 4, /* trustee is done */
Tejun Heoc8e55f32010-06-29 10:07:12 +020054
55 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
56 BUSY_WORKER_HASH_SIZE = 1 << BUSY_WORKER_HASH_ORDER,
57 BUSY_WORKER_HASH_MASK = BUSY_WORKER_HASH_SIZE - 1,
Tejun Heodb7bccf2010-06-29 10:07:12 +020058
59 TRUSTEE_COOLDOWN = HZ / 10, /* for trustee draining */
Tejun Heoc8e55f32010-06-29 10:07:12 +020060};
61
Linus Torvalds1da177e2005-04-16 15:20:36 -070062/*
Tejun Heo4690c4a2010-06-29 10:07:10 +020063 * Structure fields follow one of the following exclusion rules.
64 *
65 * I: Set during initialization and read-only afterwards.
66 *
Tejun Heo8b03ae32010-06-29 10:07:12 +020067 * L: gcwq->lock protected. Access with gcwq->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +020068 *
Tejun Heo73f53c42010-06-29 10:07:11 +020069 * F: wq->flush_mutex protected.
70 *
Tejun Heo4690c4a2010-06-29 10:07:10 +020071 * W: workqueue_lock protected.
72 */
73
Tejun Heo8b03ae32010-06-29 10:07:12 +020074struct global_cwq;
Tejun Heoc34056a2010-06-29 10:07:11 +020075struct cpu_workqueue_struct;
76
77struct worker {
Tejun Heoc8e55f32010-06-29 10:07:12 +020078 /* on idle list while idle, on busy hash table while busy */
79 union {
80 struct list_head entry; /* L: while idle */
81 struct hlist_node hentry; /* L: while busy */
82 };
83
Tejun Heoc34056a2010-06-29 10:07:11 +020084 struct work_struct *current_work; /* L: work being processed */
Tejun Heo8cca0ee2010-06-29 10:07:13 +020085 struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
Tejun Heoaffee4b2010-06-29 10:07:12 +020086 struct list_head scheduled; /* L: scheduled works */
Tejun Heoc34056a2010-06-29 10:07:11 +020087 struct task_struct *task; /* I: worker task */
Tejun Heo8b03ae32010-06-29 10:07:12 +020088 struct global_cwq *gcwq; /* I: the associated gcwq */
Tejun Heoc34056a2010-06-29 10:07:11 +020089 struct cpu_workqueue_struct *cwq; /* I: the associated cwq */
Tejun Heoc8e55f32010-06-29 10:07:12 +020090 unsigned int flags; /* L: flags */
Tejun Heoc34056a2010-06-29 10:07:11 +020091 int id; /* I: worker id */
92};
93
Tejun Heo4690c4a2010-06-29 10:07:10 +020094/*
Tejun Heo8b03ae32010-06-29 10:07:12 +020095 * Global per-cpu workqueue.
96 */
97struct global_cwq {
98 spinlock_t lock; /* the gcwq lock */
99 unsigned int cpu; /* I: the associated cpu */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200100 unsigned int flags; /* L: GCWQ_* flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200101
102 int nr_workers; /* L: total number of workers */
103 int nr_idle; /* L: currently idle ones */
104
105 /* workers are chained either in the idle_list or busy_hash */
106 struct list_head idle_list; /* L: list of idle workers */
107 struct hlist_head busy_hash[BUSY_WORKER_HASH_SIZE];
108 /* L: hash of busy workers */
109
Tejun Heo8b03ae32010-06-29 10:07:12 +0200110 struct ida worker_ida; /* L: for worker IDs */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200111
112 struct task_struct *trustee; /* L: for gcwq shutdown */
113 unsigned int trustee_state; /* L: trustee state */
114 wait_queue_head_t trustee_wait; /* trustee wait */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200115} ____cacheline_aligned_in_smp;
116
117/*
Tejun Heo502ca9d2010-06-29 10:07:13 +0200118 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
Tejun Heo0f900042010-06-29 10:07:11 +0200119 * work_struct->data are used for flags and thus cwqs need to be
120 * aligned at two's power of the number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 */
122struct cpu_workqueue_struct {
Tejun Heo8b03ae32010-06-29 10:07:12 +0200123 struct global_cwq *gcwq; /* I: the associated gcwq */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 struct list_head worklist;
Tejun Heoc34056a2010-06-29 10:07:11 +0200125 struct worker *worker;
Tejun Heo4690c4a2010-06-29 10:07:10 +0200126 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200127 int work_color; /* L: current color */
128 int flush_color; /* L: flushing color */
129 int nr_in_flight[WORK_NR_COLORS];
130 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200131 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200132 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200133 struct list_head delayed_works; /* L: delayed works */
Tejun Heo0f900042010-06-29 10:07:11 +0200134};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200137 * Structure used to wait for workqueue flush.
138 */
139struct wq_flusher {
140 struct list_head list; /* F: list of flushers */
141 int flush_color; /* F: flush color waiting for */
142 struct completion done; /* flush completion */
143};
144
145/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 * The externally visible workqueue abstraction is an array of
147 * per-CPU workqueues:
148 */
149struct workqueue_struct {
Tejun Heo97e37d72010-06-29 10:07:10 +0200150 unsigned int flags; /* I: WQ_* flags */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200151 struct cpu_workqueue_struct *cpu_wq; /* I: cwq's */
152 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200153
154 struct mutex flush_mutex; /* protects wq flushing */
155 int work_color; /* F: current work color */
156 int flush_color; /* F: current flush color */
157 atomic_t nr_cwqs_to_flush; /* flush in progress */
158 struct wq_flusher *first_flusher; /* F: first flusher */
159 struct list_head flusher_queue; /* F: flush waiters */
160 struct list_head flusher_overflow; /* F: flush overflow list */
161
Tejun Heo502ca9d2010-06-29 10:07:13 +0200162 unsigned long single_cpu; /* cpu for single cpu wq */
163
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200164 int saved_max_active; /* I: saved cwq max_active */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200165 const char *name; /* I: workqueue name */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700166#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200167 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700168#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169};
170
Tejun Heodb7bccf2010-06-29 10:07:12 +0200171#define for_each_busy_worker(worker, i, pos, gcwq) \
172 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
173 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
174
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900175#ifdef CONFIG_DEBUG_OBJECTS_WORK
176
177static struct debug_obj_descr work_debug_descr;
178
179/*
180 * fixup_init is called when:
181 * - an active object is initialized
182 */
183static int work_fixup_init(void *addr, enum debug_obj_state state)
184{
185 struct work_struct *work = addr;
186
187 switch (state) {
188 case ODEBUG_STATE_ACTIVE:
189 cancel_work_sync(work);
190 debug_object_init(work, &work_debug_descr);
191 return 1;
192 default:
193 return 0;
194 }
195}
196
197/*
198 * fixup_activate is called when:
199 * - an active object is activated
200 * - an unknown object is activated (might be a statically initialized object)
201 */
202static int work_fixup_activate(void *addr, enum debug_obj_state state)
203{
204 struct work_struct *work = addr;
205
206 switch (state) {
207
208 case ODEBUG_STATE_NOTAVAILABLE:
209 /*
210 * This is not really a fixup. The work struct was
211 * statically initialized. We just make sure that it
212 * is tracked in the object tracker.
213 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200214 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900215 debug_object_init(work, &work_debug_descr);
216 debug_object_activate(work, &work_debug_descr);
217 return 0;
218 }
219 WARN_ON_ONCE(1);
220 return 0;
221
222 case ODEBUG_STATE_ACTIVE:
223 WARN_ON(1);
224
225 default:
226 return 0;
227 }
228}
229
230/*
231 * fixup_free is called when:
232 * - an active object is freed
233 */
234static int work_fixup_free(void *addr, enum debug_obj_state state)
235{
236 struct work_struct *work = addr;
237
238 switch (state) {
239 case ODEBUG_STATE_ACTIVE:
240 cancel_work_sync(work);
241 debug_object_free(work, &work_debug_descr);
242 return 1;
243 default:
244 return 0;
245 }
246}
247
248static struct debug_obj_descr work_debug_descr = {
249 .name = "work_struct",
250 .fixup_init = work_fixup_init,
251 .fixup_activate = work_fixup_activate,
252 .fixup_free = work_fixup_free,
253};
254
255static inline void debug_work_activate(struct work_struct *work)
256{
257 debug_object_activate(work, &work_debug_descr);
258}
259
260static inline void debug_work_deactivate(struct work_struct *work)
261{
262 debug_object_deactivate(work, &work_debug_descr);
263}
264
265void __init_work(struct work_struct *work, int onstack)
266{
267 if (onstack)
268 debug_object_init_on_stack(work, &work_debug_descr);
269 else
270 debug_object_init(work, &work_debug_descr);
271}
272EXPORT_SYMBOL_GPL(__init_work);
273
274void destroy_work_on_stack(struct work_struct *work)
275{
276 debug_object_free(work, &work_debug_descr);
277}
278EXPORT_SYMBOL_GPL(destroy_work_on_stack);
279
280#else
281static inline void debug_work_activate(struct work_struct *work) { }
282static inline void debug_work_deactivate(struct work_struct *work) { }
283#endif
284
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100285/* Serializes the accesses to the list of workqueues. */
286static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200288static bool workqueue_freezing; /* W: have wqs started freezing? */
Tejun Heoc34056a2010-06-29 10:07:11 +0200289
Tejun Heo8b03ae32010-06-29 10:07:12 +0200290static DEFINE_PER_CPU(struct global_cwq, global_cwq);
291
Tejun Heoc34056a2010-06-29 10:07:11 +0200292static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Tejun Heo8b03ae32010-06-29 10:07:12 +0200294static struct global_cwq *get_gcwq(unsigned int cpu)
295{
296 return &per_cpu(global_cwq, cpu);
297}
298
Tejun Heo4690c4a2010-06-29 10:07:10 +0200299static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
300 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700301{
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700302 return per_cpu_ptr(wq->cpu_wq, cpu);
303}
304
Tejun Heo73f53c42010-06-29 10:07:11 +0200305static unsigned int work_color_to_flags(int color)
306{
307 return color << WORK_STRUCT_COLOR_SHIFT;
308}
309
310static int get_work_color(struct work_struct *work)
311{
312 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
313 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
314}
315
316static int work_next_color(int color)
317{
318 return (color + 1) % WORK_NR_COLORS;
319}
320
David Howells4594bf12006-12-07 11:33:26 +0000321/*
Tejun Heo7a22ad72010-06-29 10:07:13 +0200322 * Work data points to the cwq while a work is on queue. Once
323 * execution starts, it points to the cpu the work was last on. This
324 * can be distinguished by comparing the data value against
325 * PAGE_OFFSET.
326 *
327 * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
328 * cwq, cpu or clear work->data. These functions should only be
329 * called while the work is owned - ie. while the PENDING bit is set.
330 *
331 * get_work_[g]cwq() can be used to obtain the gcwq or cwq
332 * corresponding to a work. gcwq is available once the work has been
333 * queued anywhere after initialization. cwq is available only from
334 * queueing until execution starts.
David Howells4594bf12006-12-07 11:33:26 +0000335 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200336static inline void set_work_data(struct work_struct *work, unsigned long data,
337 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000338{
David Howells4594bf12006-12-07 11:33:26 +0000339 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200340 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000341}
342
Tejun Heo7a22ad72010-06-29 10:07:13 +0200343static void set_work_cwq(struct work_struct *work,
344 struct cpu_workqueue_struct *cwq,
345 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200346{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200347 set_work_data(work, (unsigned long)cwq,
348 WORK_STRUCT_PENDING | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200349}
350
Tejun Heo7a22ad72010-06-29 10:07:13 +0200351static void set_work_cpu(struct work_struct *work, unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000352{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200353 set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
354}
355
356static void clear_work_data(struct work_struct *work)
357{
358 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
359}
360
361static inline unsigned long get_work_data(struct work_struct *work)
362{
363 return atomic_long_read(&work->data) & WORK_STRUCT_WQ_DATA_MASK;
364}
365
366static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
367{
368 unsigned long data = get_work_data(work);
369
370 return data >= PAGE_OFFSET ? (void *)data : NULL;
371}
372
373static struct global_cwq *get_work_gcwq(struct work_struct *work)
374{
375 unsigned long data = get_work_data(work);
376 unsigned int cpu;
377
378 if (data >= PAGE_OFFSET)
379 return ((struct cpu_workqueue_struct *)data)->gcwq;
380
381 cpu = data >> WORK_STRUCT_FLAG_BITS;
382 if (cpu == NR_CPUS)
383 return NULL;
384
385 BUG_ON(cpu >= num_possible_cpus());
386 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000387}
388
Tejun Heo4690c4a2010-06-29 10:07:10 +0200389/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200390 * busy_worker_head - return the busy hash head for a work
391 * @gcwq: gcwq of interest
392 * @work: work to be hashed
393 *
394 * Return hash head of @gcwq for @work.
395 *
396 * CONTEXT:
397 * spin_lock_irq(gcwq->lock).
398 *
399 * RETURNS:
400 * Pointer to the hash head.
401 */
402static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
403 struct work_struct *work)
404{
405 const int base_shift = ilog2(sizeof(struct work_struct));
406 unsigned long v = (unsigned long)work;
407
408 /* simple shift and fold hash, do we need something better? */
409 v >>= base_shift;
410 v += v >> BUSY_WORKER_HASH_ORDER;
411 v &= BUSY_WORKER_HASH_MASK;
412
413 return &gcwq->busy_hash[v];
414}
415
416/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200417 * __find_worker_executing_work - find worker which is executing a work
418 * @gcwq: gcwq of interest
419 * @bwh: hash head as returned by busy_worker_head()
420 * @work: work to find worker for
421 *
422 * Find a worker which is executing @work on @gcwq. @bwh should be
423 * the hash head obtained by calling busy_worker_head() with the same
424 * work.
425 *
426 * CONTEXT:
427 * spin_lock_irq(gcwq->lock).
428 *
429 * RETURNS:
430 * Pointer to worker which is executing @work if found, NULL
431 * otherwise.
432 */
433static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
434 struct hlist_head *bwh,
435 struct work_struct *work)
436{
437 struct worker *worker;
438 struct hlist_node *tmp;
439
440 hlist_for_each_entry(worker, tmp, bwh, hentry)
441 if (worker->current_work == work)
442 return worker;
443 return NULL;
444}
445
446/**
447 * find_worker_executing_work - find worker which is executing a work
448 * @gcwq: gcwq of interest
449 * @work: work to find worker for
450 *
451 * Find a worker which is executing @work on @gcwq. This function is
452 * identical to __find_worker_executing_work() except that this
453 * function calculates @bwh itself.
454 *
455 * CONTEXT:
456 * spin_lock_irq(gcwq->lock).
457 *
458 * RETURNS:
459 * Pointer to worker which is executing @work if found, NULL
460 * otherwise.
461 */
462static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
463 struct work_struct *work)
464{
465 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
466 work);
467}
468
469/**
Tejun Heo4690c4a2010-06-29 10:07:10 +0200470 * insert_work - insert a work into cwq
471 * @cwq: cwq @work belongs to
472 * @work: work to insert
473 * @head: insertion point
474 * @extra_flags: extra WORK_STRUCT_* flags to set
475 *
476 * Insert @work into @cwq after @head.
477 *
478 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200479 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +0200480 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700481static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +0200482 struct work_struct *work, struct list_head *head,
483 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700484{
Tejun Heo4690c4a2010-06-29 10:07:10 +0200485 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200486 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +0200487
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700488 /*
489 * Ensure that we get the right work->data if we see the
490 * result of list_add() below, see try_to_grab_pending().
491 */
492 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +0200493
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700494 list_add_tail(&work->entry, head);
Tejun Heoc8e55f32010-06-29 10:07:12 +0200495 wake_up_process(cwq->worker->task);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700496}
497
Tejun Heo502ca9d2010-06-29 10:07:13 +0200498/**
499 * cwq_unbind_single_cpu - unbind cwq from single cpu workqueue processing
500 * @cwq: cwq to unbind
501 *
502 * Try to unbind @cwq from single cpu workqueue processing. If
503 * @cwq->wq is frozen, unbind is delayed till the workqueue is thawed.
504 *
505 * CONTEXT:
506 * spin_lock_irq(gcwq->lock).
507 */
508static void cwq_unbind_single_cpu(struct cpu_workqueue_struct *cwq)
509{
510 struct workqueue_struct *wq = cwq->wq;
511 struct global_cwq *gcwq = cwq->gcwq;
512
513 BUG_ON(wq->single_cpu != gcwq->cpu);
514 /*
515 * Unbind from workqueue if @cwq is not frozen. If frozen,
516 * thaw_workqueues() will either restart processing on this
517 * cpu or unbind if empty. This keeps works queued while
518 * frozen fully ordered and flushable.
519 */
520 if (likely(!(gcwq->flags & GCWQ_FREEZING))) {
521 smp_wmb(); /* paired with cmpxchg() in __queue_work() */
522 wq->single_cpu = NR_CPUS;
523 }
524}
525
Tejun Heo4690c4a2010-06-29 10:07:10 +0200526static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 struct work_struct *work)
528{
Tejun Heo502ca9d2010-06-29 10:07:13 +0200529 struct global_cwq *gcwq;
530 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200531 struct list_head *worklist;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 unsigned long flags;
Tejun Heo502ca9d2010-06-29 10:07:13 +0200533 bool arbitrate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900535 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200536
Tejun Heo18aa9ef2010-06-29 10:07:13 +0200537 /*
538 * Determine gcwq to use. SINGLE_CPU is inherently
539 * NON_REENTRANT, so test it first.
540 */
Tejun Heo502ca9d2010-06-29 10:07:13 +0200541 if (!(wq->flags & WQ_SINGLE_CPU)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +0200542 struct global_cwq *last_gcwq;
543
544 /*
545 * It's multi cpu. If @wq is non-reentrant and @work
546 * was previously on a different cpu, it might still
547 * be running there, in which case the work needs to
548 * be queued on that cpu to guarantee non-reentrance.
549 */
Tejun Heo502ca9d2010-06-29 10:07:13 +0200550 gcwq = get_gcwq(cpu);
Tejun Heo18aa9ef2010-06-29 10:07:13 +0200551 if (wq->flags & WQ_NON_REENTRANT &&
552 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
553 struct worker *worker;
554
555 spin_lock_irqsave(&last_gcwq->lock, flags);
556
557 worker = find_worker_executing_work(last_gcwq, work);
558
559 if (worker && worker->current_cwq->wq == wq)
560 gcwq = last_gcwq;
561 else {
562 /* meh... not running there, queue here */
563 spin_unlock_irqrestore(&last_gcwq->lock, flags);
564 spin_lock_irqsave(&gcwq->lock, flags);
565 }
566 } else
567 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heo502ca9d2010-06-29 10:07:13 +0200568 } else {
569 unsigned int req_cpu = cpu;
570
571 /*
572 * It's a bit more complex for single cpu workqueues.
573 * We first need to determine which cpu is going to be
574 * used. If no cpu is currently serving this
575 * workqueue, arbitrate using atomic accesses to
576 * wq->single_cpu; otherwise, use the current one.
577 */
578 retry:
579 cpu = wq->single_cpu;
580 arbitrate = cpu == NR_CPUS;
581 if (arbitrate)
582 cpu = req_cpu;
583
584 gcwq = get_gcwq(cpu);
585 spin_lock_irqsave(&gcwq->lock, flags);
586
587 /*
588 * The following cmpxchg() is a full barrier paired
589 * with smp_wmb() in cwq_unbind_single_cpu() and
590 * guarantees that all changes to wq->st_* fields are
591 * visible on the new cpu after this point.
592 */
593 if (arbitrate)
594 cmpxchg(&wq->single_cpu, NR_CPUS, cpu);
595
596 if (unlikely(wq->single_cpu != cpu)) {
597 spin_unlock_irqrestore(&gcwq->lock, flags);
598 goto retry;
599 }
600 }
601
602 /* gcwq determined, get cwq and queue */
603 cwq = get_cwq(gcwq->cpu, wq);
604
Tejun Heo4690c4a2010-06-29 10:07:10 +0200605 BUG_ON(!list_empty(&work->entry));
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200606
Tejun Heo73f53c42010-06-29 10:07:11 +0200607 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200608
609 if (likely(cwq->nr_active < cwq->max_active)) {
610 cwq->nr_active++;
611 worklist = &cwq->worklist;
612 } else
613 worklist = &cwq->delayed_works;
614
615 insert_work(cwq, work, worklist, work_color_to_flags(cwq->work_color));
616
Tejun Heo8b03ae32010-06-29 10:07:12 +0200617 spin_unlock_irqrestore(&gcwq->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618}
619
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700620/**
621 * queue_work - queue work on a workqueue
622 * @wq: workqueue to use
623 * @work: work to queue
624 *
Alan Stern057647f2006-10-28 10:38:58 -0700625 * Returns 0 if @work was already on a queue, non-zero otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 *
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -0700627 * We queue the work to the CPU on which it was submitted, but if the CPU dies
628 * it can be processed by another CPU.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -0800630int queue_work(struct workqueue_struct *wq, struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631{
Oleg Nesterovef1ca232008-07-25 01:47:53 -0700632 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
Oleg Nesterovef1ca232008-07-25 01:47:53 -0700634 ret = queue_work_on(get_cpu(), wq, work);
635 put_cpu();
636
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 return ret;
638}
Dave Jonesae90dd52006-06-30 01:40:45 -0400639EXPORT_SYMBOL_GPL(queue_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
Zhang Ruic1a220e2008-07-23 21:28:39 -0700641/**
642 * queue_work_on - queue work on specific cpu
643 * @cpu: CPU number to execute work on
644 * @wq: workqueue to use
645 * @work: work to queue
646 *
647 * Returns 0 if @work was already on a queue, non-zero otherwise.
648 *
649 * We queue the work to a specific CPU, the caller must ensure it
650 * can't go away.
651 */
652int
653queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
654{
655 int ret = 0;
656
Tejun Heo22df02b2010-06-29 10:07:10 +0200657 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +0200658 __queue_work(cpu, wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -0700659 ret = 1;
660 }
661 return ret;
662}
663EXPORT_SYMBOL_GPL(queue_work_on);
664
Li Zefan6d141c32008-02-08 04:21:09 -0800665static void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666{
David Howells52bad642006-11-22 14:54:01 +0000667 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200668 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
Tejun Heo4690c4a2010-06-29 10:07:10 +0200670 __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671}
672
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700673/**
674 * queue_delayed_work - queue work on a workqueue after delay
675 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800676 * @dwork: delayable work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700677 * @delay: number of jiffies to wait before queueing
678 *
Alan Stern057647f2006-10-28 10:38:58 -0700679 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700680 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -0800681int queue_delayed_work(struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +0000682 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683{
David Howells52bad642006-11-22 14:54:01 +0000684 if (delay == 0)
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700685 return queue_work(wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700687 return queue_delayed_work_on(-1, wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688}
Dave Jonesae90dd52006-06-30 01:40:45 -0400689EXPORT_SYMBOL_GPL(queue_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700691/**
692 * queue_delayed_work_on - queue work on specific CPU after delay
693 * @cpu: CPU number to execute work on
694 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800695 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700696 * @delay: number of jiffies to wait before queueing
697 *
Alan Stern057647f2006-10-28 10:38:58 -0700698 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700699 */
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700700int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +0000701 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700702{
703 int ret = 0;
David Howells52bad642006-11-22 14:54:01 +0000704 struct timer_list *timer = &dwork->timer;
705 struct work_struct *work = &dwork->work;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700706
Tejun Heo22df02b2010-06-29 10:07:10 +0200707 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7a22ad72010-06-29 10:07:13 +0200708 struct global_cwq *gcwq = get_work_gcwq(work);
709 unsigned int lcpu = gcwq ? gcwq->cpu : raw_smp_processor_id();
710
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700711 BUG_ON(timer_pending(timer));
712 BUG_ON(!list_empty(&work->entry));
713
Andrew Liu8a3e77c2008-05-01 04:35:14 -0700714 timer_stats_timer_set_start_info(&dwork->timer);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200715 /*
716 * This stores cwq for the moment, for the timer_fn.
717 * Note that the work's gcwq is preserved to allow
718 * reentrance detection for delayed works.
719 */
720 set_work_cwq(work, get_cwq(lcpu, wq), 0);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700721 timer->expires = jiffies + delay;
David Howells52bad642006-11-22 14:54:01 +0000722 timer->data = (unsigned long)dwork;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700723 timer->function = delayed_work_timer_fn;
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700724
725 if (unlikely(cpu >= 0))
726 add_timer_on(timer, cpu);
727 else
728 add_timer(timer);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700729 ret = 1;
730 }
731 return ret;
732}
Dave Jonesae90dd52006-06-30 01:40:45 -0400733EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734
Tejun Heoc8e55f32010-06-29 10:07:12 +0200735/**
736 * worker_enter_idle - enter idle state
737 * @worker: worker which is entering idle state
738 *
739 * @worker is entering idle state. Update stats and idle timer if
740 * necessary.
741 *
742 * LOCKING:
743 * spin_lock_irq(gcwq->lock).
744 */
745static void worker_enter_idle(struct worker *worker)
746{
747 struct global_cwq *gcwq = worker->gcwq;
748
749 BUG_ON(worker->flags & WORKER_IDLE);
750 BUG_ON(!list_empty(&worker->entry) &&
751 (worker->hentry.next || worker->hentry.pprev));
752
753 worker->flags |= WORKER_IDLE;
754 gcwq->nr_idle++;
755
756 /* idle_list is LIFO */
757 list_add(&worker->entry, &gcwq->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +0200758
759 if (unlikely(worker->flags & WORKER_ROGUE))
760 wake_up_all(&gcwq->trustee_wait);
Tejun Heoc8e55f32010-06-29 10:07:12 +0200761}
762
763/**
764 * worker_leave_idle - leave idle state
765 * @worker: worker which is leaving idle state
766 *
767 * @worker is leaving idle state. Update stats.
768 *
769 * LOCKING:
770 * spin_lock_irq(gcwq->lock).
771 */
772static void worker_leave_idle(struct worker *worker)
773{
774 struct global_cwq *gcwq = worker->gcwq;
775
776 BUG_ON(!(worker->flags & WORKER_IDLE));
777 worker->flags &= ~WORKER_IDLE;
778 gcwq->nr_idle--;
779 list_del_init(&worker->entry);
780}
781
Tejun Heoc34056a2010-06-29 10:07:11 +0200782static struct worker *alloc_worker(void)
783{
784 struct worker *worker;
785
786 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +0200787 if (worker) {
788 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +0200789 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heoc8e55f32010-06-29 10:07:12 +0200790 }
Tejun Heoc34056a2010-06-29 10:07:11 +0200791 return worker;
792}
793
794/**
795 * create_worker - create a new workqueue worker
796 * @cwq: cwq the new worker will belong to
797 * @bind: whether to set affinity to @cpu or not
798 *
799 * Create a new worker which is bound to @cwq. The returned worker
800 * can be started by calling start_worker() or destroyed using
801 * destroy_worker().
802 *
803 * CONTEXT:
804 * Might sleep. Does GFP_KERNEL allocations.
805 *
806 * RETURNS:
807 * Pointer to the newly created worker.
808 */
809static struct worker *create_worker(struct cpu_workqueue_struct *cwq, bool bind)
810{
Tejun Heo8b03ae32010-06-29 10:07:12 +0200811 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +0200812 int id = -1;
813 struct worker *worker = NULL;
814
Tejun Heo8b03ae32010-06-29 10:07:12 +0200815 spin_lock_irq(&gcwq->lock);
816 while (ida_get_new(&gcwq->worker_ida, &id)) {
817 spin_unlock_irq(&gcwq->lock);
818 if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +0200819 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200820 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +0200821 }
Tejun Heo8b03ae32010-06-29 10:07:12 +0200822 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +0200823
824 worker = alloc_worker();
825 if (!worker)
826 goto fail;
827
Tejun Heo8b03ae32010-06-29 10:07:12 +0200828 worker->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +0200829 worker->cwq = cwq;
830 worker->id = id;
831
832 worker->task = kthread_create(worker_thread, worker, "kworker/%u:%d",
Tejun Heo8b03ae32010-06-29 10:07:12 +0200833 gcwq->cpu, id);
Tejun Heoc34056a2010-06-29 10:07:11 +0200834 if (IS_ERR(worker->task))
835 goto fail;
836
Tejun Heodb7bccf2010-06-29 10:07:12 +0200837 /*
838 * A rogue worker will become a regular one if CPU comes
839 * online later on. Make sure every worker has
840 * PF_THREAD_BOUND set.
841 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200842 if (bind)
Tejun Heo8b03ae32010-06-29 10:07:12 +0200843 kthread_bind(worker->task, gcwq->cpu);
Tejun Heodb7bccf2010-06-29 10:07:12 +0200844 else
845 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heoc34056a2010-06-29 10:07:11 +0200846
847 return worker;
848fail:
849 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +0200850 spin_lock_irq(&gcwq->lock);
851 ida_remove(&gcwq->worker_ida, id);
852 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +0200853 }
854 kfree(worker);
855 return NULL;
856}
857
858/**
859 * start_worker - start a newly created worker
860 * @worker: worker to start
861 *
Tejun Heoc8e55f32010-06-29 10:07:12 +0200862 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +0200863 *
864 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200865 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +0200866 */
867static void start_worker(struct worker *worker)
868{
Tejun Heoc8e55f32010-06-29 10:07:12 +0200869 worker->flags |= WORKER_STARTED;
870 worker->gcwq->nr_workers++;
871 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +0200872 wake_up_process(worker->task);
873}
874
875/**
876 * destroy_worker - destroy a workqueue worker
877 * @worker: worker to be destroyed
878 *
Tejun Heoc8e55f32010-06-29 10:07:12 +0200879 * Destroy @worker and adjust @gcwq stats accordingly.
880 *
881 * CONTEXT:
882 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +0200883 */
884static void destroy_worker(struct worker *worker)
885{
Tejun Heo8b03ae32010-06-29 10:07:12 +0200886 struct global_cwq *gcwq = worker->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +0200887 int id = worker->id;
888
889 /* sanity check frenzy */
890 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +0200891 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +0200892
Tejun Heoc8e55f32010-06-29 10:07:12 +0200893 if (worker->flags & WORKER_STARTED)
894 gcwq->nr_workers--;
895 if (worker->flags & WORKER_IDLE)
896 gcwq->nr_idle--;
897
898 list_del_init(&worker->entry);
899 worker->flags |= WORKER_DIE;
900
901 spin_unlock_irq(&gcwq->lock);
902
Tejun Heoc34056a2010-06-29 10:07:11 +0200903 kthread_stop(worker->task);
904 kfree(worker);
905
Tejun Heo8b03ae32010-06-29 10:07:12 +0200906 spin_lock_irq(&gcwq->lock);
907 ida_remove(&gcwq->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +0200908}
909
Tejun Heoa62428c2010-06-29 10:07:10 +0200910/**
Tejun Heoaffee4b2010-06-29 10:07:12 +0200911 * move_linked_works - move linked works to a list
912 * @work: start of series of works to be scheduled
913 * @head: target list to append @work to
914 * @nextp: out paramter for nested worklist walking
915 *
916 * Schedule linked works starting from @work to @head. Work series to
917 * be scheduled starts at @work and includes any consecutive work with
918 * WORK_STRUCT_LINKED set in its predecessor.
919 *
920 * If @nextp is not NULL, it's updated to point to the next work of
921 * the last scheduled work. This allows move_linked_works() to be
922 * nested inside outer list_for_each_entry_safe().
923 *
924 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200925 * spin_lock_irq(gcwq->lock).
Tejun Heoaffee4b2010-06-29 10:07:12 +0200926 */
927static void move_linked_works(struct work_struct *work, struct list_head *head,
928 struct work_struct **nextp)
929{
930 struct work_struct *n;
931
932 /*
933 * Linked worklist will always end before the end of the list,
934 * use NULL for list head.
935 */
936 list_for_each_entry_safe_from(work, n, NULL, entry) {
937 list_move_tail(&work->entry, head);
938 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
939 break;
940 }
941
942 /*
943 * If we're already inside safe list traversal and have moved
944 * multiple works to the scheduled queue, the next position
945 * needs to be updated.
946 */
947 if (nextp)
948 *nextp = n;
949}
950
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200951static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
952{
953 struct work_struct *work = list_first_entry(&cwq->delayed_works,
954 struct work_struct, entry);
955
956 move_linked_works(work, &cwq->worklist, NULL);
957 cwq->nr_active++;
958}
959
Tejun Heoaffee4b2010-06-29 10:07:12 +0200960/**
Tejun Heo73f53c42010-06-29 10:07:11 +0200961 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
962 * @cwq: cwq of interest
963 * @color: color of work which left the queue
964 *
965 * A work either has completed or is removed from pending queue,
966 * decrement nr_in_flight of its cwq and handle workqueue flushing.
967 *
968 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200969 * spin_lock_irq(gcwq->lock).
Tejun Heo73f53c42010-06-29 10:07:11 +0200970 */
971static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
972{
973 /* ignore uncolored works */
974 if (color == WORK_NO_COLOR)
975 return;
976
977 cwq->nr_in_flight[color]--;
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200978 cwq->nr_active--;
979
Tejun Heo502ca9d2010-06-29 10:07:13 +0200980 if (!list_empty(&cwq->delayed_works)) {
981 /* one down, submit a delayed one */
982 if (cwq->nr_active < cwq->max_active)
983 cwq_activate_first_delayed(cwq);
984 } else if (!cwq->nr_active && cwq->wq->flags & WQ_SINGLE_CPU) {
985 /* this was the last work, unbind from single cpu */
986 cwq_unbind_single_cpu(cwq);
987 }
Tejun Heo73f53c42010-06-29 10:07:11 +0200988
989 /* is flush in progress and are we at the flushing tip? */
990 if (likely(cwq->flush_color != color))
991 return;
992
993 /* are there still in-flight works? */
994 if (cwq->nr_in_flight[color])
995 return;
996
997 /* this cwq is done, clear flush_color */
998 cwq->flush_color = -1;
999
1000 /*
1001 * If this was the last cwq, wake up the first flusher. It
1002 * will handle the rest.
1003 */
1004 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1005 complete(&cwq->wq->first_flusher->done);
1006}
1007
1008/**
Tejun Heoa62428c2010-06-29 10:07:10 +02001009 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001010 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001011 * @work: work to process
1012 *
1013 * Process @work. This function contains all the logics necessary to
1014 * process a single work including synchronization against and
1015 * interaction with other workers on the same cpu, queueing and
1016 * flushing. As long as context requirement is met, any worker can
1017 * call this function to process a work.
1018 *
1019 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001020 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001021 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001022static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heoa62428c2010-06-29 10:07:10 +02001023{
Tejun Heoc34056a2010-06-29 10:07:11 +02001024 struct cpu_workqueue_struct *cwq = worker->cwq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001025 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001026 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heoa62428c2010-06-29 10:07:10 +02001027 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02001028 int work_color;
Tejun Heoa62428c2010-06-29 10:07:10 +02001029#ifdef CONFIG_LOCKDEP
1030 /*
1031 * It is permissible to free the struct work_struct from
1032 * inside the function that is called from it, this we need to
1033 * take into account for lockdep too. To avoid bogus "held
1034 * lock freed" warnings as well as problems when looking into
1035 * work->lockdep_map, make a copy and use that here.
1036 */
1037 struct lockdep_map lockdep_map = work->lockdep_map;
1038#endif
1039 /* claim and process */
Tejun Heoa62428c2010-06-29 10:07:10 +02001040 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001041 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02001042 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001043 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001044 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001045
1046 BUG_ON(get_work_cwq(work) != cwq);
1047 /* record the current cpu number in the work data and dequeue */
1048 set_work_cpu(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02001049 list_del_init(&work->entry);
1050
Tejun Heo8b03ae32010-06-29 10:07:12 +02001051 spin_unlock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001052
Tejun Heoa62428c2010-06-29 10:07:10 +02001053 work_clear_pending(work);
1054 lock_map_acquire(&cwq->wq->lockdep_map);
1055 lock_map_acquire(&lockdep_map);
1056 f(work);
1057 lock_map_release(&lockdep_map);
1058 lock_map_release(&cwq->wq->lockdep_map);
1059
1060 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1061 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1062 "%s/0x%08x/%d\n",
1063 current->comm, preempt_count(), task_pid_nr(current));
1064 printk(KERN_ERR " last function: ");
1065 print_symbol("%s\n", (unsigned long)f);
1066 debug_show_held_locks(current);
1067 dump_stack();
1068 }
1069
Tejun Heo8b03ae32010-06-29 10:07:12 +02001070 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001071
1072 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02001073 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001074 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001075 worker->current_cwq = NULL;
Tejun Heo73f53c42010-06-29 10:07:11 +02001076 cwq_dec_nr_in_flight(cwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02001077}
1078
Tejun Heoaffee4b2010-06-29 10:07:12 +02001079/**
1080 * process_scheduled_works - process scheduled works
1081 * @worker: self
1082 *
1083 * Process all scheduled works. Please note that the scheduled list
1084 * may change while processing a work, so this function repeatedly
1085 * fetches a work from the top and executes it.
1086 *
1087 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001088 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02001089 * multiple times.
1090 */
1091static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092{
Tejun Heoaffee4b2010-06-29 10:07:12 +02001093 while (!list_empty(&worker->scheduled)) {
1094 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001096 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098}
1099
Tejun Heo4690c4a2010-06-29 10:07:10 +02001100/**
1101 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02001102 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02001103 *
1104 * The cwq worker thread function.
1105 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001106static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107{
Tejun Heoc34056a2010-06-29 10:07:11 +02001108 struct worker *worker = __worker;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001109 struct global_cwq *gcwq = worker->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001110 struct cpu_workqueue_struct *cwq = worker->cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111
Tejun Heoc8e55f32010-06-29 10:07:12 +02001112woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02001113 spin_lock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001114
Tejun Heoc8e55f32010-06-29 10:07:12 +02001115 /* DIE can be set only while we're idle, checking here is enough */
1116 if (worker->flags & WORKER_DIE) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001117 spin_unlock_irq(&gcwq->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001118 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001120
Tejun Heoc8e55f32010-06-29 10:07:12 +02001121 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001122recheck:
Tejun Heoc8e55f32010-06-29 10:07:12 +02001123 /*
1124 * ->scheduled list can only be filled while a worker is
1125 * preparing to process a work or actually processing it.
1126 * Make sure nobody diddled with it while I was sleeping.
1127 */
1128 BUG_ON(!list_empty(&worker->scheduled));
1129
1130 while (!list_empty(&cwq->worklist)) {
1131 struct work_struct *work =
1132 list_first_entry(&cwq->worklist,
1133 struct work_struct, entry);
1134
Tejun Heodb7bccf2010-06-29 10:07:12 +02001135 /*
1136 * The following is a rather inefficient way to close
1137 * race window against cpu hotplug operations. Will
1138 * be replaced soon.
1139 */
1140 if (unlikely(!(worker->flags & WORKER_ROGUE) &&
1141 !cpumask_equal(&worker->task->cpus_allowed,
1142 get_cpu_mask(gcwq->cpu)))) {
1143 spin_unlock_irq(&gcwq->lock);
1144 set_cpus_allowed_ptr(worker->task,
1145 get_cpu_mask(gcwq->cpu));
1146 cpu_relax();
1147 spin_lock_irq(&gcwq->lock);
1148 goto recheck;
1149 }
1150
Tejun Heoc8e55f32010-06-29 10:07:12 +02001151 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1152 /* optimization path, not strictly necessary */
1153 process_one_work(worker, work);
1154 if (unlikely(!list_empty(&worker->scheduled)))
1155 process_scheduled_works(worker);
1156 } else {
1157 move_linked_works(work, &worker->scheduled, NULL);
1158 process_scheduled_works(worker);
1159 }
1160 }
1161
1162 /*
1163 * gcwq->lock is held and there's no work to process, sleep.
1164 * Workers are woken up only while holding gcwq->lock, so
1165 * setting the current state before releasing gcwq->lock is
1166 * enough to prevent losing any event.
1167 */
1168 worker_enter_idle(worker);
1169 __set_current_state(TASK_INTERRUPTIBLE);
1170 spin_unlock_irq(&gcwq->lock);
1171 schedule();
1172 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173}
1174
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07001175struct wq_barrier {
1176 struct work_struct work;
1177 struct completion done;
1178};
1179
1180static void wq_barrier_func(struct work_struct *work)
1181{
1182 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
1183 complete(&barr->done);
1184}
1185
Tejun Heo4690c4a2010-06-29 10:07:10 +02001186/**
1187 * insert_wq_barrier - insert a barrier work
1188 * @cwq: cwq to insert barrier into
1189 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02001190 * @target: target work to attach @barr to
1191 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02001192 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02001193 * @barr is linked to @target such that @barr is completed only after
1194 * @target finishes execution. Please note that the ordering
1195 * guarantee is observed only with respect to @target and on the local
1196 * cpu.
1197 *
1198 * Currently, a queued barrier can't be canceled. This is because
1199 * try_to_grab_pending() can't determine whether the work to be
1200 * grabbed is at the head of the queue and thus can't clear LINKED
1201 * flag of the previous work while there must be a valid next work
1202 * after a work with LINKED flag set.
1203 *
1204 * Note that when @worker is non-NULL, @target may be modified
1205 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001206 *
1207 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001208 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001209 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07001210static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02001211 struct wq_barrier *barr,
1212 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07001213{
Tejun Heoaffee4b2010-06-29 10:07:12 +02001214 struct list_head *head;
1215 unsigned int linked = 0;
1216
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001217 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02001218 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001219 * as we know for sure that this will not trigger any of the
1220 * checks and call back into the fixup functions where we
1221 * might deadlock.
1222 */
1223 INIT_WORK_ON_STACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02001224 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07001225 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07001226
Tejun Heoaffee4b2010-06-29 10:07:12 +02001227 /*
1228 * If @target is currently being executed, schedule the
1229 * barrier to the worker; otherwise, put it after @target.
1230 */
1231 if (worker)
1232 head = worker->scheduled.next;
1233 else {
1234 unsigned long *bits = work_data_bits(target);
1235
1236 head = target->entry.next;
1237 /* there can already be other linked works, inherit and set */
1238 linked = *bits & WORK_STRUCT_LINKED;
1239 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
1240 }
1241
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001242 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001243 insert_work(cwq, &barr->work, head,
1244 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07001245}
1246
Tejun Heo73f53c42010-06-29 10:07:11 +02001247/**
1248 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
1249 * @wq: workqueue being flushed
1250 * @flush_color: new flush color, < 0 for no-op
1251 * @work_color: new work color, < 0 for no-op
1252 *
1253 * Prepare cwqs for workqueue flushing.
1254 *
1255 * If @flush_color is non-negative, flush_color on all cwqs should be
1256 * -1. If no cwq has in-flight commands at the specified color, all
1257 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
1258 * has in flight commands, its cwq->flush_color is set to
1259 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
1260 * wakeup logic is armed and %true is returned.
1261 *
1262 * The caller should have initialized @wq->first_flusher prior to
1263 * calling this function with non-negative @flush_color. If
1264 * @flush_color is negative, no flush color update is done and %false
1265 * is returned.
1266 *
1267 * If @work_color is non-negative, all cwqs should have the same
1268 * work_color which is previous to @work_color and all will be
1269 * advanced to @work_color.
1270 *
1271 * CONTEXT:
1272 * mutex_lock(wq->flush_mutex).
1273 *
1274 * RETURNS:
1275 * %true if @flush_color >= 0 and there's something to flush. %false
1276 * otherwise.
1277 */
1278static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
1279 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280{
Tejun Heo73f53c42010-06-29 10:07:11 +02001281 bool wait = false;
1282 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07001283
Tejun Heo73f53c42010-06-29 10:07:11 +02001284 if (flush_color >= 0) {
1285 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
1286 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001287 }
Oleg Nesterov14441962007-05-23 13:57:57 -07001288
Tejun Heo73f53c42010-06-29 10:07:11 +02001289 for_each_possible_cpu(cpu) {
1290 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001291 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001292
Tejun Heo8b03ae32010-06-29 10:07:12 +02001293 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02001294
1295 if (flush_color >= 0) {
1296 BUG_ON(cwq->flush_color != -1);
1297
1298 if (cwq->nr_in_flight[flush_color]) {
1299 cwq->flush_color = flush_color;
1300 atomic_inc(&wq->nr_cwqs_to_flush);
1301 wait = true;
1302 }
1303 }
1304
1305 if (work_color >= 0) {
1306 BUG_ON(work_color != work_next_color(cwq->work_color));
1307 cwq->work_color = work_color;
1308 }
1309
Tejun Heo8b03ae32010-06-29 10:07:12 +02001310 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02001311 }
1312
1313 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
1314 complete(&wq->first_flusher->done);
1315
1316 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317}
1318
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001319/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001321 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 *
1323 * Forces execution of the workqueue and blocks until its completion.
1324 * This is typically used in driver shutdown handlers.
1325 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07001326 * We sleep until all works which were queued on entry have been handled,
1327 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001329void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330{
Tejun Heo73f53c42010-06-29 10:07:11 +02001331 struct wq_flusher this_flusher = {
1332 .list = LIST_HEAD_INIT(this_flusher.list),
1333 .flush_color = -1,
1334 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
1335 };
1336 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07001337
Ingo Molnar3295f0e2008-08-11 10:30:30 +02001338 lock_map_acquire(&wq->lockdep_map);
1339 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02001340
1341 mutex_lock(&wq->flush_mutex);
1342
1343 /*
1344 * Start-to-wait phase
1345 */
1346 next_color = work_next_color(wq->work_color);
1347
1348 if (next_color != wq->flush_color) {
1349 /*
1350 * Color space is not full. The current work_color
1351 * becomes our flush_color and work_color is advanced
1352 * by one.
1353 */
1354 BUG_ON(!list_empty(&wq->flusher_overflow));
1355 this_flusher.flush_color = wq->work_color;
1356 wq->work_color = next_color;
1357
1358 if (!wq->first_flusher) {
1359 /* no flush in progress, become the first flusher */
1360 BUG_ON(wq->flush_color != this_flusher.flush_color);
1361
1362 wq->first_flusher = &this_flusher;
1363
1364 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
1365 wq->work_color)) {
1366 /* nothing to flush, done */
1367 wq->flush_color = next_color;
1368 wq->first_flusher = NULL;
1369 goto out_unlock;
1370 }
1371 } else {
1372 /* wait in queue */
1373 BUG_ON(wq->flush_color == this_flusher.flush_color);
1374 list_add_tail(&this_flusher.list, &wq->flusher_queue);
1375 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
1376 }
1377 } else {
1378 /*
1379 * Oops, color space is full, wait on overflow queue.
1380 * The next flush completion will assign us
1381 * flush_color and transfer to flusher_queue.
1382 */
1383 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
1384 }
1385
1386 mutex_unlock(&wq->flush_mutex);
1387
1388 wait_for_completion(&this_flusher.done);
1389
1390 /*
1391 * Wake-up-and-cascade phase
1392 *
1393 * First flushers are responsible for cascading flushes and
1394 * handling overflow. Non-first flushers can simply return.
1395 */
1396 if (wq->first_flusher != &this_flusher)
1397 return;
1398
1399 mutex_lock(&wq->flush_mutex);
1400
1401 wq->first_flusher = NULL;
1402
1403 BUG_ON(!list_empty(&this_flusher.list));
1404 BUG_ON(wq->flush_color != this_flusher.flush_color);
1405
1406 while (true) {
1407 struct wq_flusher *next, *tmp;
1408
1409 /* complete all the flushers sharing the current flush color */
1410 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
1411 if (next->flush_color != wq->flush_color)
1412 break;
1413 list_del_init(&next->list);
1414 complete(&next->done);
1415 }
1416
1417 BUG_ON(!list_empty(&wq->flusher_overflow) &&
1418 wq->flush_color != work_next_color(wq->work_color));
1419
1420 /* this flush_color is finished, advance by one */
1421 wq->flush_color = work_next_color(wq->flush_color);
1422
1423 /* one color has been freed, handle overflow queue */
1424 if (!list_empty(&wq->flusher_overflow)) {
1425 /*
1426 * Assign the same color to all overflowed
1427 * flushers, advance work_color and append to
1428 * flusher_queue. This is the start-to-wait
1429 * phase for these overflowed flushers.
1430 */
1431 list_for_each_entry(tmp, &wq->flusher_overflow, list)
1432 tmp->flush_color = wq->work_color;
1433
1434 wq->work_color = work_next_color(wq->work_color);
1435
1436 list_splice_tail_init(&wq->flusher_overflow,
1437 &wq->flusher_queue);
1438 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
1439 }
1440
1441 if (list_empty(&wq->flusher_queue)) {
1442 BUG_ON(wq->flush_color != wq->work_color);
1443 break;
1444 }
1445
1446 /*
1447 * Need to flush more colors. Make the next flusher
1448 * the new first flusher and arm cwqs.
1449 */
1450 BUG_ON(wq->flush_color == wq->work_color);
1451 BUG_ON(wq->flush_color != next->flush_color);
1452
1453 list_del_init(&next->list);
1454 wq->first_flusher = next;
1455
1456 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
1457 break;
1458
1459 /*
1460 * Meh... this color is already done, clear first
1461 * flusher and repeat cascading.
1462 */
1463 wq->first_flusher = NULL;
1464 }
1465
1466out_unlock:
1467 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468}
Dave Jonesae90dd52006-06-30 01:40:45 -04001469EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470
Oleg Nesterovdb700892008-07-25 01:47:49 -07001471/**
1472 * flush_work - block until a work_struct's callback has terminated
1473 * @work: the work which is to be flushed
1474 *
Oleg Nesterova67da702008-07-25 01:47:52 -07001475 * Returns false if @work has already terminated.
1476 *
Oleg Nesterovdb700892008-07-25 01:47:49 -07001477 * It is expected that, prior to calling flush_work(), the caller has
1478 * arranged for the work to not be requeued, otherwise it doesn't make
1479 * sense to use this function.
1480 */
1481int flush_work(struct work_struct *work)
1482{
Tejun Heoaffee4b2010-06-29 10:07:12 +02001483 struct worker *worker = NULL;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001484 struct global_cwq *gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001485 struct cpu_workqueue_struct *cwq;
Oleg Nesterovdb700892008-07-25 01:47:49 -07001486 struct wq_barrier barr;
1487
1488 might_sleep();
Tejun Heo7a22ad72010-06-29 10:07:13 +02001489 gcwq = get_work_gcwq(work);
1490 if (!gcwq)
Oleg Nesterovdb700892008-07-25 01:47:49 -07001491 return 0;
Oleg Nesterova67da702008-07-25 01:47:52 -07001492
Tejun Heo8b03ae32010-06-29 10:07:12 +02001493 spin_lock_irq(&gcwq->lock);
Oleg Nesterovdb700892008-07-25 01:47:49 -07001494 if (!list_empty(&work->entry)) {
1495 /*
1496 * See the comment near try_to_grab_pending()->smp_rmb().
Tejun Heo7a22ad72010-06-29 10:07:13 +02001497 * If it was re-queued to a different gcwq under us, we
1498 * are not going to wait.
Oleg Nesterovdb700892008-07-25 01:47:49 -07001499 */
1500 smp_rmb();
Tejun Heo7a22ad72010-06-29 10:07:13 +02001501 cwq = get_work_cwq(work);
1502 if (unlikely(!cwq || gcwq != cwq->gcwq))
Tejun Heo4690c4a2010-06-29 10:07:10 +02001503 goto already_gone;
Oleg Nesterovdb700892008-07-25 01:47:49 -07001504 } else {
Tejun Heo7a22ad72010-06-29 10:07:13 +02001505 worker = find_worker_executing_work(gcwq, work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001506 if (!worker)
Tejun Heo4690c4a2010-06-29 10:07:10 +02001507 goto already_gone;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001508 cwq = worker->current_cwq;
Oleg Nesterovdb700892008-07-25 01:47:49 -07001509 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07001510
Tejun Heoaffee4b2010-06-29 10:07:12 +02001511 insert_wq_barrier(cwq, &barr, work, worker);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001512 spin_unlock_irq(&gcwq->lock);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001513
1514 lock_map_acquire(&cwq->wq->lockdep_map);
1515 lock_map_release(&cwq->wq->lockdep_map);
1516
Oleg Nesterovdb700892008-07-25 01:47:49 -07001517 wait_for_completion(&barr.done);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001518 destroy_work_on_stack(&barr.work);
Oleg Nesterovdb700892008-07-25 01:47:49 -07001519 return 1;
Tejun Heo4690c4a2010-06-29 10:07:10 +02001520already_gone:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001521 spin_unlock_irq(&gcwq->lock);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001522 return 0;
Oleg Nesterovdb700892008-07-25 01:47:49 -07001523}
1524EXPORT_SYMBOL_GPL(flush_work);
1525
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001526/*
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001527 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001528 * so this work can't be re-armed in any way.
1529 */
1530static int try_to_grab_pending(struct work_struct *work)
1531{
Tejun Heo8b03ae32010-06-29 10:07:12 +02001532 struct global_cwq *gcwq;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001533 int ret = -1;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001534
Tejun Heo22df02b2010-06-29 10:07:10 +02001535 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001536 return 0;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001537
1538 /*
1539 * The queueing is in progress, or it is already queued. Try to
1540 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1541 */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001542 gcwq = get_work_gcwq(work);
1543 if (!gcwq)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001544 return ret;
1545
Tejun Heo8b03ae32010-06-29 10:07:12 +02001546 spin_lock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001547 if (!list_empty(&work->entry)) {
1548 /*
Tejun Heo7a22ad72010-06-29 10:07:13 +02001549 * This work is queued, but perhaps we locked the wrong gcwq.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001550 * In that case we must see the new value after rmb(), see
1551 * insert_work()->wmb().
1552 */
1553 smp_rmb();
Tejun Heo7a22ad72010-06-29 10:07:13 +02001554 if (gcwq == get_work_gcwq(work)) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001555 debug_work_deactivate(work);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001556 list_del_init(&work->entry);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001557 cwq_dec_nr_in_flight(get_work_cwq(work),
1558 get_work_color(work));
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001559 ret = 1;
1560 }
1561 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001562 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001563
1564 return ret;
1565}
1566
Tejun Heo7a22ad72010-06-29 10:07:13 +02001567static void wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001568{
1569 struct wq_barrier barr;
Tejun Heoaffee4b2010-06-29 10:07:12 +02001570 struct worker *worker;
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001571
Tejun Heo8b03ae32010-06-29 10:07:12 +02001572 spin_lock_irq(&gcwq->lock);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001573
Tejun Heo7a22ad72010-06-29 10:07:13 +02001574 worker = find_worker_executing_work(gcwq, work);
1575 if (unlikely(worker))
1576 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001577
Tejun Heo8b03ae32010-06-29 10:07:12 +02001578 spin_unlock_irq(&gcwq->lock);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001579
Tejun Heoaffee4b2010-06-29 10:07:12 +02001580 if (unlikely(worker)) {
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001581 wait_for_completion(&barr.done);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001582 destroy_work_on_stack(&barr.work);
1583 }
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001584}
1585
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001586static void wait_on_work(struct work_struct *work)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001587{
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07001588 int cpu;
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001589
Oleg Nesterovf293ea92007-05-09 02:34:10 -07001590 might_sleep();
1591
Ingo Molnar3295f0e2008-08-11 10:30:30 +02001592 lock_map_acquire(&work->lockdep_map);
1593 lock_map_release(&work->lockdep_map);
Johannes Berg4e6045f2007-10-18 23:39:55 -07001594
Tejun Heo15376632010-06-29 10:07:11 +02001595 for_each_possible_cpu(cpu)
Tejun Heo7a22ad72010-06-29 10:07:13 +02001596 wait_on_cpu_work(get_gcwq(cpu), work);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001597}
1598
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001599static int __cancel_work_timer(struct work_struct *work,
1600 struct timer_list* timer)
1601{
1602 int ret;
1603
1604 do {
1605 ret = (timer && likely(del_timer(timer)));
1606 if (!ret)
1607 ret = try_to_grab_pending(work);
1608 wait_on_work(work);
1609 } while (unlikely(ret < 0));
1610
Tejun Heo7a22ad72010-06-29 10:07:13 +02001611 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001612 return ret;
1613}
1614
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001615/**
1616 * cancel_work_sync - block until a work_struct's callback has terminated
1617 * @work: the work which is to be flushed
1618 *
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001619 * Returns true if @work was pending.
1620 *
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001621 * cancel_work_sync() will cancel the work if it is queued. If the work's
1622 * callback appears to be running, cancel_work_sync() will block until it
1623 * has completed.
1624 *
1625 * It is possible to use this function if the work re-queues itself. It can
1626 * cancel the work even if it migrates to another workqueue, however in that
1627 * case it only guarantees that work->func() has completed on the last queued
1628 * workqueue.
1629 *
1630 * cancel_work_sync(&delayed_work->work) should be used only if ->timer is not
1631 * pending, otherwise it goes into a busy-wait loop until the timer expires.
1632 *
1633 * The caller must ensure that workqueue_struct on which this work was last
1634 * queued can't be destroyed before this function returns.
1635 */
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001636int cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001637{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001638 return __cancel_work_timer(work, NULL);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001639}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07001640EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001641
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001642/**
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07001643 * cancel_delayed_work_sync - reliably kill off a delayed work.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001644 * @dwork: the delayed work struct
1645 *
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001646 * Returns true if @dwork was pending.
1647 *
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001648 * It is possible to use this function if @dwork rearms itself via queue_work()
1649 * or queue_delayed_work(). See also the comment for cancel_work_sync().
1650 */
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001651int cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001652{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001653 return __cancel_work_timer(&dwork->work, &dwork->timer);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001654}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07001655EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001657static struct workqueue_struct *keventd_wq __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001659/**
1660 * schedule_work - put work task in global workqueue
1661 * @work: job to be done
1662 *
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02001663 * Returns zero if @work was already on the kernel-global workqueue and
1664 * non-zero otherwise.
1665 *
1666 * This puts a job in the kernel-global workqueue if it was not already
1667 * queued and leaves it in the same position on the kernel-global
1668 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001669 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001670int schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671{
1672 return queue_work(keventd_wq, work);
1673}
Dave Jonesae90dd52006-06-30 01:40:45 -04001674EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
Zhang Ruic1a220e2008-07-23 21:28:39 -07001676/*
1677 * schedule_work_on - put work task on a specific cpu
1678 * @cpu: cpu to put the work task on
1679 * @work: job to be done
1680 *
1681 * This puts a job on a specific cpu
1682 */
1683int schedule_work_on(int cpu, struct work_struct *work)
1684{
1685 return queue_work_on(cpu, keventd_wq, work);
1686}
1687EXPORT_SYMBOL(schedule_work_on);
1688
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001689/**
1690 * schedule_delayed_work - put work task in global workqueue after delay
David Howells52bad642006-11-22 14:54:01 +00001691 * @dwork: job to be done
1692 * @delay: number of jiffies to wait or 0 for immediate execution
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001693 *
1694 * After waiting for a given time this puts a job in the kernel-global
1695 * workqueue.
1696 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001697int schedule_delayed_work(struct delayed_work *dwork,
Ingo Molnar82f67cd2007-02-16 01:28:13 -08001698 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699{
David Howells52bad642006-11-22 14:54:01 +00001700 return queue_delayed_work(keventd_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701}
Dave Jonesae90dd52006-06-30 01:40:45 -04001702EXPORT_SYMBOL(schedule_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001704/**
Linus Torvalds8c53e462009-10-14 09:16:42 -07001705 * flush_delayed_work - block until a dwork_struct's callback has terminated
1706 * @dwork: the delayed work which is to be flushed
1707 *
1708 * Any timeout is cancelled, and any pending work is run immediately.
1709 */
1710void flush_delayed_work(struct delayed_work *dwork)
1711{
1712 if (del_timer_sync(&dwork->timer)) {
Tejun Heo7a22ad72010-06-29 10:07:13 +02001713 __queue_work(get_cpu(), get_work_cwq(&dwork->work)->wq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001714 &dwork->work);
Linus Torvalds8c53e462009-10-14 09:16:42 -07001715 put_cpu();
1716 }
1717 flush_work(&dwork->work);
1718}
1719EXPORT_SYMBOL(flush_delayed_work);
1720
1721/**
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001722 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
1723 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00001724 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001725 * @delay: number of jiffies to wait
1726 *
1727 * After waiting for a given time this puts a job in the kernel-global
1728 * workqueue on the specified CPU.
1729 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730int schedule_delayed_work_on(int cpu,
David Howells52bad642006-11-22 14:54:01 +00001731 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732{
David Howells52bad642006-11-22 14:54:01 +00001733 return queue_delayed_work_on(cpu, keventd_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734}
Dave Jonesae90dd52006-06-30 01:40:45 -04001735EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736
Andrew Mortonb6136772006-06-25 05:47:49 -07001737/**
1738 * schedule_on_each_cpu - call a function on each online CPU from keventd
1739 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07001740 *
1741 * Returns zero on success.
1742 * Returns -ve errno on failure.
1743 *
Andrew Mortonb6136772006-06-25 05:47:49 -07001744 * schedule_on_each_cpu() is very slow.
1745 */
David Howells65f27f32006-11-22 14:55:48 +00001746int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08001747{
1748 int cpu;
Andi Kleen65a64462009-10-14 06:22:47 +02001749 int orig = -1;
Andrew Mortonb6136772006-06-25 05:47:49 -07001750 struct work_struct *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08001751
Andrew Mortonb6136772006-06-25 05:47:49 -07001752 works = alloc_percpu(struct work_struct);
1753 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08001754 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07001755
Gautham R Shenoy95402b32008-01-25 21:08:02 +01001756 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08001757
1758 /*
1759 * When running in keventd don't schedule a work item on
1760 * itself. Can just call directly because the work queue is
1761 * already bound. This also is faster.
1762 */
1763 if (current_is_keventd())
1764 orig = raw_smp_processor_id();
1765
Christoph Lameter15316ba2006-01-08 01:00:43 -08001766 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01001767 struct work_struct *work = per_cpu_ptr(works, cpu);
1768
1769 INIT_WORK(work, func);
Andi Kleen65a64462009-10-14 06:22:47 +02001770 if (cpu != orig)
Tejun Heo93981802009-11-17 14:06:20 -08001771 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02001772 }
Tejun Heo93981802009-11-17 14:06:20 -08001773 if (orig >= 0)
1774 func(per_cpu_ptr(works, orig));
1775
1776 for_each_online_cpu(cpu)
1777 flush_work(per_cpu_ptr(works, cpu));
1778
Gautham R Shenoy95402b32008-01-25 21:08:02 +01001779 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07001780 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08001781 return 0;
1782}
1783
Alan Sterneef6a7d2010-02-12 17:39:21 +09001784/**
1785 * flush_scheduled_work - ensure that any scheduled work has run to completion.
1786 *
1787 * Forces execution of the kernel-global workqueue and blocks until its
1788 * completion.
1789 *
1790 * Think twice before calling this function! It's very easy to get into
1791 * trouble if you don't take great care. Either of the following situations
1792 * will lead to deadlock:
1793 *
1794 * One of the work items currently on the workqueue needs to acquire
1795 * a lock held by your code or its caller.
1796 *
1797 * Your code is running in the context of a work routine.
1798 *
1799 * They will be detected by lockdep when they occur, but the first might not
1800 * occur very often. It depends on what work items are on the workqueue and
1801 * what locks they need, which you have no control over.
1802 *
1803 * In most situations flushing the entire workqueue is overkill; you merely
1804 * need to know that a particular work item isn't queued and isn't running.
1805 * In such cases you should use cancel_delayed_work_sync() or
1806 * cancel_work_sync() instead.
1807 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808void flush_scheduled_work(void)
1809{
1810 flush_workqueue(keventd_wq);
1811}
Dave Jonesae90dd52006-06-30 01:40:45 -04001812EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813
1814/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06001815 * execute_in_process_context - reliably execute the routine with user context
1816 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06001817 * @ew: guaranteed storage for the execute work structure (must
1818 * be available when the work executes)
1819 *
1820 * Executes the function immediately if process context is available,
1821 * otherwise schedules the function for delayed execution.
1822 *
1823 * Returns: 0 - function was executed
1824 * 1 - function was scheduled for execution
1825 */
David Howells65f27f32006-11-22 14:55:48 +00001826int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06001827{
1828 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00001829 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06001830 return 0;
1831 }
1832
David Howells65f27f32006-11-22 14:55:48 +00001833 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06001834 schedule_work(&ew->work);
1835
1836 return 1;
1837}
1838EXPORT_SYMBOL_GPL(execute_in_process_context);
1839
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840int keventd_up(void)
1841{
1842 return keventd_wq != NULL;
1843}
1844
1845int current_is_keventd(void)
1846{
1847 struct cpu_workqueue_struct *cwq;
Hugh Dickinsd2437692007-08-27 16:06:19 +01001848 int cpu = raw_smp_processor_id(); /* preempt-safe: keventd is per-cpu */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 int ret = 0;
1850
1851 BUG_ON(!keventd_wq);
1852
Tejun Heo15376632010-06-29 10:07:11 +02001853 cwq = get_cwq(cpu, keventd_wq);
Tejun Heoc34056a2010-06-29 10:07:11 +02001854 if (current == cwq->worker->task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 ret = 1;
1856
1857 return ret;
1858
1859}
1860
Tejun Heo0f900042010-06-29 10:07:11 +02001861static struct cpu_workqueue_struct *alloc_cwqs(void)
1862{
1863 /*
1864 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
1865 * Make sure that the alignment isn't lower than that of
1866 * unsigned long long.
1867 */
1868 const size_t size = sizeof(struct cpu_workqueue_struct);
1869 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
1870 __alignof__(unsigned long long));
1871 struct cpu_workqueue_struct *cwqs;
1872#ifndef CONFIG_SMP
1873 void *ptr;
1874
1875 /*
1876 * On UP, percpu allocator doesn't honor alignment parameter
1877 * and simply uses arch-dependent default. Allocate enough
1878 * room to align cwq and put an extra pointer at the end
1879 * pointing back to the originally allocated pointer which
1880 * will be used for free.
1881 *
1882 * FIXME: This really belongs to UP percpu code. Update UP
1883 * percpu code to honor alignment and remove this ugliness.
1884 */
1885 ptr = __alloc_percpu(size + align + sizeof(void *), 1);
1886 cwqs = PTR_ALIGN(ptr, align);
1887 *(void **)per_cpu_ptr(cwqs + 1, 0) = ptr;
1888#else
1889 /* On SMP, percpu allocator can do it itself */
1890 cwqs = __alloc_percpu(size, align);
1891#endif
1892 /* just in case, make sure it's actually aligned */
1893 BUG_ON(!IS_ALIGNED((unsigned long)cwqs, align));
1894 return cwqs;
1895}
1896
1897static void free_cwqs(struct cpu_workqueue_struct *cwqs)
1898{
1899#ifndef CONFIG_SMP
1900 /* on UP, the pointer to free is stored right after the cwq */
1901 if (cwqs)
1902 free_percpu(*(void **)per_cpu_ptr(cwqs + 1, 0));
1903#else
1904 free_percpu(cwqs);
1905#endif
1906}
1907
Johannes Berg4e6045f2007-10-18 23:39:55 -07001908struct workqueue_struct *__create_workqueue_key(const char *name,
Tejun Heo97e37d72010-06-29 10:07:10 +02001909 unsigned int flags,
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001910 int max_active,
Johannes Bergeb13ba82008-01-16 09:51:58 +01001911 struct lock_class_key *key,
1912 const char *lock_name)
Oleg Nesterov3af244332007-05-09 02:34:09 -07001913{
1914 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001915 bool failed = false;
1916 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001917
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001918 max_active = clamp_val(max_active, 1, INT_MAX);
1919
Oleg Nesterov3af244332007-05-09 02:34:09 -07001920 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
1921 if (!wq)
Tejun Heo4690c4a2010-06-29 10:07:10 +02001922 goto err;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001923
Tejun Heo0f900042010-06-29 10:07:11 +02001924 wq->cpu_wq = alloc_cwqs();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001925 if (!wq->cpu_wq)
1926 goto err;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001927
Tejun Heo97e37d72010-06-29 10:07:10 +02001928 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02001929 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02001930 mutex_init(&wq->flush_mutex);
1931 atomic_set(&wq->nr_cwqs_to_flush, 0);
1932 INIT_LIST_HEAD(&wq->flusher_queue);
1933 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001934 wq->single_cpu = NR_CPUS;
1935
Oleg Nesterov3af244332007-05-09 02:34:09 -07001936 wq->name = name;
Johannes Bergeb13ba82008-01-16 09:51:58 +01001937 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07001938 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001939
Tejun Heo15376632010-06-29 10:07:11 +02001940 cpu_maps_update_begin();
1941 /*
1942 * We must initialize cwqs for each possible cpu even if we
1943 * are going to call destroy_workqueue() finally. Otherwise
1944 * cpu_up() can hit the uninitialized cwq once we drop the
1945 * lock.
1946 */
1947 for_each_possible_cpu(cpu) {
1948 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001949 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo15376632010-06-29 10:07:11 +02001950
Tejun Heo0f900042010-06-29 10:07:11 +02001951 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001952 cwq->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001953 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001954 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001955 cwq->max_active = max_active;
Tejun Heo15376632010-06-29 10:07:11 +02001956 INIT_LIST_HEAD(&cwq->worklist);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001957 INIT_LIST_HEAD(&cwq->delayed_works);
Tejun Heo15376632010-06-29 10:07:11 +02001958
Tejun Heoc34056a2010-06-29 10:07:11 +02001959 if (failed)
Tejun Heo15376632010-06-29 10:07:11 +02001960 continue;
Tejun Heo502ca9d2010-06-29 10:07:13 +02001961 cwq->worker = create_worker(cwq, cpu_online(cpu));
Tejun Heoc34056a2010-06-29 10:07:11 +02001962 if (cwq->worker)
1963 start_worker(cwq->worker);
Tejun Heo15376632010-06-29 10:07:11 +02001964 else
Tejun Heoc34056a2010-06-29 10:07:11 +02001965 failed = true;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001966 }
1967
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02001968 /*
1969 * workqueue_lock protects global freeze state and workqueues
1970 * list. Grab it, set max_active accordingly and add the new
1971 * workqueue to workqueues list.
1972 */
Tejun Heo15376632010-06-29 10:07:11 +02001973 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02001974
1975 if (workqueue_freezing && wq->flags & WQ_FREEZEABLE)
1976 for_each_possible_cpu(cpu)
1977 get_cwq(cpu, wq)->max_active = 0;
1978
Tejun Heo15376632010-06-29 10:07:11 +02001979 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02001980
Tejun Heo15376632010-06-29 10:07:11 +02001981 spin_unlock(&workqueue_lock);
1982
1983 cpu_maps_update_done();
1984
Tejun Heoc34056a2010-06-29 10:07:11 +02001985 if (failed) {
Oleg Nesterov3af244332007-05-09 02:34:09 -07001986 destroy_workqueue(wq);
1987 wq = NULL;
1988 }
1989 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02001990err:
1991 if (wq) {
Tejun Heo0f900042010-06-29 10:07:11 +02001992 free_cwqs(wq->cpu_wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001993 kfree(wq);
1994 }
1995 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001996}
Johannes Berg4e6045f2007-10-18 23:39:55 -07001997EXPORT_SYMBOL_GPL(__create_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001998
Oleg Nesterov3af244332007-05-09 02:34:09 -07001999/**
2000 * destroy_workqueue - safely terminate a workqueue
2001 * @wq: target workqueue
2002 *
2003 * Safely destroy a workqueue. All work currently pending will be done first.
2004 */
2005void destroy_workqueue(struct workqueue_struct *wq)
2006{
Tejun Heoc8e55f32010-06-29 10:07:12 +02002007 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002008
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002009 flush_workqueue(wq);
2010
2011 /*
2012 * wq list is used to freeze wq, remove from list after
2013 * flushing is complete in case freeze races us.
2014 */
Oleg Nesterov3da1c842008-07-25 01:47:50 -07002015 cpu_maps_update_begin();
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002016 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002017 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002018 spin_unlock(&workqueue_lock);
Tejun Heo15376632010-06-29 10:07:11 +02002019 cpu_maps_update_done();
Oleg Nesterov3af244332007-05-09 02:34:09 -07002020
Tejun Heo73f53c42010-06-29 10:07:11 +02002021 for_each_possible_cpu(cpu) {
2022 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2023 int i;
2024
Tejun Heoc34056a2010-06-29 10:07:11 +02002025 if (cwq->worker) {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002026 spin_lock_irq(&cwq->gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02002027 destroy_worker(cwq->worker);
2028 cwq->worker = NULL;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002029 spin_unlock_irq(&cwq->gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002030 }
2031
2032 for (i = 0; i < WORK_NR_COLORS; i++)
2033 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02002034 BUG_ON(cwq->nr_active);
2035 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02002036 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002037
Tejun Heo0f900042010-06-29 10:07:11 +02002038 free_cwqs(wq->cpu_wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002039 kfree(wq);
2040}
2041EXPORT_SYMBOL_GPL(destroy_workqueue);
2042
Tejun Heodb7bccf2010-06-29 10:07:12 +02002043/*
2044 * CPU hotplug.
2045 *
2046 * CPU hotplug is implemented by allowing cwqs to be detached from
2047 * CPU, running with unbound workers and allowing them to be
2048 * reattached later if the cpu comes back online. A separate thread
2049 * is created to govern cwqs in such state and is called the trustee.
2050 *
2051 * Trustee states and their descriptions.
2052 *
2053 * START Command state used on startup. On CPU_DOWN_PREPARE, a
2054 * new trustee is started with this state.
2055 *
2056 * IN_CHARGE Once started, trustee will enter this state after
2057 * making all existing workers rogue. DOWN_PREPARE waits
2058 * for trustee to enter this state. After reaching
2059 * IN_CHARGE, trustee tries to execute the pending
2060 * worklist until it's empty and the state is set to
2061 * BUTCHER, or the state is set to RELEASE.
2062 *
2063 * BUTCHER Command state which is set by the cpu callback after
2064 * the cpu has went down. Once this state is set trustee
2065 * knows that there will be no new works on the worklist
2066 * and once the worklist is empty it can proceed to
2067 * killing idle workers.
2068 *
2069 * RELEASE Command state which is set by the cpu callback if the
2070 * cpu down has been canceled or it has come online
2071 * again. After recognizing this state, trustee stops
2072 * trying to drain or butcher and transits to DONE.
2073 *
2074 * DONE Trustee will enter this state after BUTCHER or RELEASE
2075 * is complete.
2076 *
2077 * trustee CPU draining
2078 * took over down complete
2079 * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
2080 * | | ^
2081 * | CPU is back online v return workers |
2082 * ----------------> RELEASE --------------
2083 */
2084
2085/**
2086 * trustee_wait_event_timeout - timed event wait for trustee
2087 * @cond: condition to wait for
2088 * @timeout: timeout in jiffies
2089 *
2090 * wait_event_timeout() for trustee to use. Handles locking and
2091 * checks for RELEASE request.
2092 *
2093 * CONTEXT:
2094 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2095 * multiple times. To be used by trustee.
2096 *
2097 * RETURNS:
2098 * Positive indicating left time if @cond is satisfied, 0 if timed
2099 * out, -1 if canceled.
2100 */
2101#define trustee_wait_event_timeout(cond, timeout) ({ \
2102 long __ret = (timeout); \
2103 while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
2104 __ret) { \
2105 spin_unlock_irq(&gcwq->lock); \
2106 __wait_event_timeout(gcwq->trustee_wait, (cond) || \
2107 (gcwq->trustee_state == TRUSTEE_RELEASE), \
2108 __ret); \
2109 spin_lock_irq(&gcwq->lock); \
2110 } \
2111 gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \
2112})
2113
2114/**
2115 * trustee_wait_event - event wait for trustee
2116 * @cond: condition to wait for
2117 *
2118 * wait_event() for trustee to use. Automatically handles locking and
2119 * checks for CANCEL request.
2120 *
2121 * CONTEXT:
2122 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2123 * multiple times. To be used by trustee.
2124 *
2125 * RETURNS:
2126 * 0 if @cond is satisfied, -1 if canceled.
2127 */
2128#define trustee_wait_event(cond) ({ \
2129 long __ret1; \
2130 __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
2131 __ret1 < 0 ? -1 : 0; \
2132})
2133
2134static int __cpuinit trustee_thread(void *__gcwq)
2135{
2136 struct global_cwq *gcwq = __gcwq;
2137 struct worker *worker;
2138 struct hlist_node *pos;
2139 int i;
2140
2141 BUG_ON(gcwq->cpu != smp_processor_id());
2142
2143 spin_lock_irq(&gcwq->lock);
2144 /*
Tejun Heo502ca9d2010-06-29 10:07:13 +02002145 * Make all workers rogue. Trustee must be bound to the
2146 * target cpu and can't be cancelled.
Tejun Heodb7bccf2010-06-29 10:07:12 +02002147 */
2148 BUG_ON(gcwq->cpu != smp_processor_id());
2149
2150 list_for_each_entry(worker, &gcwq->idle_list, entry)
Tejun Heo502ca9d2010-06-29 10:07:13 +02002151 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02002152
2153 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo502ca9d2010-06-29 10:07:13 +02002154 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02002155
2156 /*
2157 * We're now in charge. Notify and proceed to drain. We need
2158 * to keep the gcwq running during the whole CPU down
2159 * procedure as other cpu hotunplug callbacks may need to
2160 * flush currently running tasks.
2161 */
2162 gcwq->trustee_state = TRUSTEE_IN_CHARGE;
2163 wake_up_all(&gcwq->trustee_wait);
2164
2165 /*
2166 * The original cpu is in the process of dying and may go away
2167 * anytime now. When that happens, we and all workers would
2168 * be migrated to other cpus. Try draining any left work.
2169 * Note that if the gcwq is frozen, there may be frozen works
2170 * in freezeable cwqs. Don't declare completion while frozen.
2171 */
2172 while (gcwq->nr_workers != gcwq->nr_idle ||
2173 gcwq->flags & GCWQ_FREEZING ||
2174 gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
2175 /* give a breather */
2176 if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
2177 break;
2178 }
2179
2180 /* notify completion */
2181 gcwq->trustee = NULL;
2182 gcwq->trustee_state = TRUSTEE_DONE;
2183 wake_up_all(&gcwq->trustee_wait);
2184 spin_unlock_irq(&gcwq->lock);
2185 return 0;
2186}
2187
2188/**
2189 * wait_trustee_state - wait for trustee to enter the specified state
2190 * @gcwq: gcwq the trustee of interest belongs to
2191 * @state: target state to wait for
2192 *
2193 * Wait for the trustee to reach @state. DONE is already matched.
2194 *
2195 * CONTEXT:
2196 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2197 * multiple times. To be used by cpu_callback.
2198 */
2199static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
2200{
2201 if (!(gcwq->trustee_state == state ||
2202 gcwq->trustee_state == TRUSTEE_DONE)) {
2203 spin_unlock_irq(&gcwq->lock);
2204 __wait_event(gcwq->trustee_wait,
2205 gcwq->trustee_state == state ||
2206 gcwq->trustee_state == TRUSTEE_DONE);
2207 spin_lock_irq(&gcwq->lock);
2208 }
2209}
2210
Oleg Nesterov3af244332007-05-09 02:34:09 -07002211static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
2212 unsigned long action,
2213 void *hcpu)
2214{
2215 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02002216 struct global_cwq *gcwq = get_gcwq(cpu);
2217 struct task_struct *new_trustee = NULL;
2218 struct worker *worker;
2219 struct hlist_node *pos;
2220 unsigned long flags;
2221 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222
Rafael J. Wysocki8bb78442007-05-09 02:35:10 -07002223 action &= ~CPU_TASKS_FROZEN;
2224
Tejun Heodb7bccf2010-06-29 10:07:12 +02002225 switch (action) {
2226 case CPU_DOWN_PREPARE:
2227 new_trustee = kthread_create(trustee_thread, gcwq,
2228 "workqueue_trustee/%d\n", cpu);
2229 if (IS_ERR(new_trustee))
2230 return notifier_from_errno(PTR_ERR(new_trustee));
2231 kthread_bind(new_trustee, cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 }
2233
Tejun Heodb7bccf2010-06-29 10:07:12 +02002234 /* some are called w/ irq disabled, don't disturb irq status */
2235 spin_lock_irqsave(&gcwq->lock, flags);
2236
2237 switch (action) {
2238 case CPU_DOWN_PREPARE:
2239 /* initialize trustee and tell it to acquire the gcwq */
2240 BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
2241 gcwq->trustee = new_trustee;
2242 gcwq->trustee_state = TRUSTEE_START;
2243 wake_up_process(gcwq->trustee);
2244 wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
2245 break;
2246
2247 case CPU_POST_DEAD:
2248 gcwq->trustee_state = TRUSTEE_BUTCHER;
2249 break;
2250
2251 case CPU_DOWN_FAILED:
2252 case CPU_ONLINE:
2253 if (gcwq->trustee_state != TRUSTEE_DONE) {
2254 gcwq->trustee_state = TRUSTEE_RELEASE;
2255 wake_up_process(gcwq->trustee);
2256 wait_trustee_state(gcwq, TRUSTEE_DONE);
2257 }
2258
Tejun Heo502ca9d2010-06-29 10:07:13 +02002259 /* clear ROGUE from all workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +02002260 list_for_each_entry(worker, &gcwq->idle_list, entry)
Tejun Heo502ca9d2010-06-29 10:07:13 +02002261 worker->flags &= ~WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02002262
2263 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo502ca9d2010-06-29 10:07:13 +02002264 worker->flags &= ~WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02002265 break;
2266 }
2267
2268 spin_unlock_irqrestore(&gcwq->lock, flags);
2269
Tejun Heo15376632010-06-29 10:07:11 +02002270 return notifier_from_errno(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272
Rusty Russell2d3854a2008-11-05 13:39:10 +11002273#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08002274
Rusty Russell2d3854a2008-11-05 13:39:10 +11002275struct work_for_cpu {
Andrew Morton6b44003e2009-04-09 09:50:37 -06002276 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11002277 long (*fn)(void *);
2278 void *arg;
2279 long ret;
2280};
2281
Andrew Morton6b44003e2009-04-09 09:50:37 -06002282static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11002283{
Andrew Morton6b44003e2009-04-09 09:50:37 -06002284 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11002285 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b44003e2009-04-09 09:50:37 -06002286 complete(&wfc->completion);
2287 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11002288}
2289
2290/**
2291 * work_on_cpu - run a function in user context on a particular cpu
2292 * @cpu: the cpu to run on
2293 * @fn: the function to run
2294 * @arg: the function arg
2295 *
Rusty Russell31ad9082009-01-16 15:31:15 -08002296 * This will return the value @fn returns.
2297 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06002298 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11002299 */
2300long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
2301{
Andrew Morton6b44003e2009-04-09 09:50:37 -06002302 struct task_struct *sub_thread;
2303 struct work_for_cpu wfc = {
2304 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
2305 .fn = fn,
2306 .arg = arg,
2307 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11002308
Andrew Morton6b44003e2009-04-09 09:50:37 -06002309 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
2310 if (IS_ERR(sub_thread))
2311 return PTR_ERR(sub_thread);
2312 kthread_bind(sub_thread, cpu);
2313 wake_up_process(sub_thread);
2314 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11002315 return wfc.ret;
2316}
2317EXPORT_SYMBOL_GPL(work_on_cpu);
2318#endif /* CONFIG_SMP */
2319
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002320#ifdef CONFIG_FREEZER
2321
2322/**
2323 * freeze_workqueues_begin - begin freezing workqueues
2324 *
2325 * Start freezing workqueues. After this function returns, all
2326 * freezeable workqueues will queue new works to their frozen_works
2327 * list instead of the cwq ones.
2328 *
2329 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002330 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002331 */
2332void freeze_workqueues_begin(void)
2333{
2334 struct workqueue_struct *wq;
2335 unsigned int cpu;
2336
2337 spin_lock(&workqueue_lock);
2338
2339 BUG_ON(workqueue_freezing);
2340 workqueue_freezing = true;
2341
2342 for_each_possible_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002343 struct global_cwq *gcwq = get_gcwq(cpu);
2344
2345 spin_lock_irq(&gcwq->lock);
2346
Tejun Heodb7bccf2010-06-29 10:07:12 +02002347 BUG_ON(gcwq->flags & GCWQ_FREEZING);
2348 gcwq->flags |= GCWQ_FREEZING;
2349
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002350 list_for_each_entry(wq, &workqueues, list) {
2351 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2352
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002353 if (wq->flags & WQ_FREEZEABLE)
2354 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002355 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02002356
2357 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002358 }
2359
2360 spin_unlock(&workqueue_lock);
2361}
2362
2363/**
2364 * freeze_workqueues_busy - are freezeable workqueues still busy?
2365 *
2366 * Check whether freezing is complete. This function must be called
2367 * between freeze_workqueues_begin() and thaw_workqueues().
2368 *
2369 * CONTEXT:
2370 * Grabs and releases workqueue_lock.
2371 *
2372 * RETURNS:
2373 * %true if some freezeable workqueues are still busy. %false if
2374 * freezing is complete.
2375 */
2376bool freeze_workqueues_busy(void)
2377{
2378 struct workqueue_struct *wq;
2379 unsigned int cpu;
2380 bool busy = false;
2381
2382 spin_lock(&workqueue_lock);
2383
2384 BUG_ON(!workqueue_freezing);
2385
2386 for_each_possible_cpu(cpu) {
2387 /*
2388 * nr_active is monotonically decreasing. It's safe
2389 * to peek without lock.
2390 */
2391 list_for_each_entry(wq, &workqueues, list) {
2392 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2393
2394 if (!(wq->flags & WQ_FREEZEABLE))
2395 continue;
2396
2397 BUG_ON(cwq->nr_active < 0);
2398 if (cwq->nr_active) {
2399 busy = true;
2400 goto out_unlock;
2401 }
2402 }
2403 }
2404out_unlock:
2405 spin_unlock(&workqueue_lock);
2406 return busy;
2407}
2408
2409/**
2410 * thaw_workqueues - thaw workqueues
2411 *
2412 * Thaw workqueues. Normal queueing is restored and all collected
2413 * frozen works are transferred to their respective cwq worklists.
2414 *
2415 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002416 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002417 */
2418void thaw_workqueues(void)
2419{
2420 struct workqueue_struct *wq;
2421 unsigned int cpu;
2422
2423 spin_lock(&workqueue_lock);
2424
2425 if (!workqueue_freezing)
2426 goto out_unlock;
2427
2428 for_each_possible_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002429 struct global_cwq *gcwq = get_gcwq(cpu);
2430
2431 spin_lock_irq(&gcwq->lock);
2432
Tejun Heodb7bccf2010-06-29 10:07:12 +02002433 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
2434 gcwq->flags &= ~GCWQ_FREEZING;
2435
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002436 list_for_each_entry(wq, &workqueues, list) {
2437 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2438
2439 if (!(wq->flags & WQ_FREEZEABLE))
2440 continue;
2441
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002442 /* restore max_active and repopulate worklist */
2443 cwq->max_active = wq->saved_max_active;
2444
2445 while (!list_empty(&cwq->delayed_works) &&
2446 cwq->nr_active < cwq->max_active)
2447 cwq_activate_first_delayed(cwq);
2448
Tejun Heo502ca9d2010-06-29 10:07:13 +02002449 /* perform delayed unbind from single cpu if empty */
2450 if (wq->single_cpu == gcwq->cpu &&
2451 !cwq->nr_active && list_empty(&cwq->delayed_works))
2452 cwq_unbind_single_cpu(cwq);
2453
Tejun Heoc8e55f32010-06-29 10:07:12 +02002454 wake_up_process(cwq->worker->task);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002455 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02002456
2457 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002458 }
2459
2460 workqueue_freezing = false;
2461out_unlock:
2462 spin_unlock(&workqueue_lock);
2463}
2464#endif /* CONFIG_FREEZER */
2465
Oleg Nesterovc12920d2007-05-09 02:34:14 -07002466void __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467{
Tejun Heoc34056a2010-06-29 10:07:11 +02002468 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002469 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02002470
Tejun Heo7a22ad72010-06-29 10:07:13 +02002471 /*
2472 * The pointer part of work->data is either pointing to the
2473 * cwq or contains the cpu number the work ran last on. Make
2474 * sure cpu number won't overflow into kernel pointer area so
2475 * that they can be distinguished.
2476 */
2477 BUILD_BUG_ON(NR_CPUS << WORK_STRUCT_FLAG_BITS >= PAGE_OFFSET);
2478
Tejun Heodb7bccf2010-06-29 10:07:12 +02002479 hotcpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002480
2481 /* initialize gcwqs */
2482 for_each_possible_cpu(cpu) {
2483 struct global_cwq *gcwq = get_gcwq(cpu);
2484
2485 spin_lock_init(&gcwq->lock);
2486 gcwq->cpu = cpu;
2487
Tejun Heoc8e55f32010-06-29 10:07:12 +02002488 INIT_LIST_HEAD(&gcwq->idle_list);
2489 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
2490 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
2491
Tejun Heo8b03ae32010-06-29 10:07:12 +02002492 ida_init(&gcwq->worker_ida);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002493
2494 gcwq->trustee_state = TRUSTEE_DONE;
2495 init_waitqueue_head(&gcwq->trustee_wait);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002496 }
2497
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498 keventd_wq = create_workqueue("events");
2499 BUG_ON(!keventd_wq);
2500}