blob: c68277c204abf2432ad92793ab7e005cdda5fc76 [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 Heo502ca9d2010-06-29 10:07:13 +0200537 /* determine gcwq to use */
538 if (!(wq->flags & WQ_SINGLE_CPU)) {
539 /* just use the requested cpu for multicpu workqueues */
540 gcwq = get_gcwq(cpu);
541 spin_lock_irqsave(&gcwq->lock, flags);
542 } else {
543 unsigned int req_cpu = cpu;
544
545 /*
546 * It's a bit more complex for single cpu workqueues.
547 * We first need to determine which cpu is going to be
548 * used. If no cpu is currently serving this
549 * workqueue, arbitrate using atomic accesses to
550 * wq->single_cpu; otherwise, use the current one.
551 */
552 retry:
553 cpu = wq->single_cpu;
554 arbitrate = cpu == NR_CPUS;
555 if (arbitrate)
556 cpu = req_cpu;
557
558 gcwq = get_gcwq(cpu);
559 spin_lock_irqsave(&gcwq->lock, flags);
560
561 /*
562 * The following cmpxchg() is a full barrier paired
563 * with smp_wmb() in cwq_unbind_single_cpu() and
564 * guarantees that all changes to wq->st_* fields are
565 * visible on the new cpu after this point.
566 */
567 if (arbitrate)
568 cmpxchg(&wq->single_cpu, NR_CPUS, cpu);
569
570 if (unlikely(wq->single_cpu != cpu)) {
571 spin_unlock_irqrestore(&gcwq->lock, flags);
572 goto retry;
573 }
574 }
575
576 /* gcwq determined, get cwq and queue */
577 cwq = get_cwq(gcwq->cpu, wq);
578
Tejun Heo4690c4a2010-06-29 10:07:10 +0200579 BUG_ON(!list_empty(&work->entry));
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200580
Tejun Heo73f53c42010-06-29 10:07:11 +0200581 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200582
583 if (likely(cwq->nr_active < cwq->max_active)) {
584 cwq->nr_active++;
585 worklist = &cwq->worklist;
586 } else
587 worklist = &cwq->delayed_works;
588
589 insert_work(cwq, work, worklist, work_color_to_flags(cwq->work_color));
590
Tejun Heo8b03ae32010-06-29 10:07:12 +0200591 spin_unlock_irqrestore(&gcwq->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592}
593
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700594/**
595 * queue_work - queue work on a workqueue
596 * @wq: workqueue to use
597 * @work: work to queue
598 *
Alan Stern057647f2006-10-28 10:38:58 -0700599 * Returns 0 if @work was already on a queue, non-zero otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 *
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -0700601 * We queue the work to the CPU on which it was submitted, but if the CPU dies
602 * it can be processed by another CPU.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -0800604int queue_work(struct workqueue_struct *wq, struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605{
Oleg Nesterovef1ca232008-07-25 01:47:53 -0700606 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Oleg Nesterovef1ca232008-07-25 01:47:53 -0700608 ret = queue_work_on(get_cpu(), wq, work);
609 put_cpu();
610
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 return ret;
612}
Dave Jonesae90dd52006-06-30 01:40:45 -0400613EXPORT_SYMBOL_GPL(queue_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
Zhang Ruic1a220e2008-07-23 21:28:39 -0700615/**
616 * queue_work_on - queue work on specific cpu
617 * @cpu: CPU number to execute work on
618 * @wq: workqueue to use
619 * @work: work to queue
620 *
621 * Returns 0 if @work was already on a queue, non-zero otherwise.
622 *
623 * We queue the work to a specific CPU, the caller must ensure it
624 * can't go away.
625 */
626int
627queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
628{
629 int ret = 0;
630
Tejun Heo22df02b2010-06-29 10:07:10 +0200631 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +0200632 __queue_work(cpu, wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -0700633 ret = 1;
634 }
635 return ret;
636}
637EXPORT_SYMBOL_GPL(queue_work_on);
638
Li Zefan6d141c32008-02-08 04:21:09 -0800639static void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
David Howells52bad642006-11-22 14:54:01 +0000641 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200642 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
Tejun Heo4690c4a2010-06-29 10:07:10 +0200644 __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645}
646
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700647/**
648 * queue_delayed_work - queue work on a workqueue after delay
649 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800650 * @dwork: delayable work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700651 * @delay: number of jiffies to wait before queueing
652 *
Alan Stern057647f2006-10-28 10:38:58 -0700653 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700654 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -0800655int queue_delayed_work(struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +0000656 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657{
David Howells52bad642006-11-22 14:54:01 +0000658 if (delay == 0)
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700659 return queue_work(wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700661 return queue_delayed_work_on(-1, wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662}
Dave Jonesae90dd52006-06-30 01:40:45 -0400663EXPORT_SYMBOL_GPL(queue_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700665/**
666 * queue_delayed_work_on - queue work on specific CPU after delay
667 * @cpu: CPU number to execute work on
668 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800669 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700670 * @delay: number of jiffies to wait before queueing
671 *
Alan Stern057647f2006-10-28 10:38:58 -0700672 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700673 */
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700674int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +0000675 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700676{
677 int ret = 0;
David Howells52bad642006-11-22 14:54:01 +0000678 struct timer_list *timer = &dwork->timer;
679 struct work_struct *work = &dwork->work;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700680
Tejun Heo22df02b2010-06-29 10:07:10 +0200681 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7a22ad72010-06-29 10:07:13 +0200682 struct global_cwq *gcwq = get_work_gcwq(work);
683 unsigned int lcpu = gcwq ? gcwq->cpu : raw_smp_processor_id();
684
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700685 BUG_ON(timer_pending(timer));
686 BUG_ON(!list_empty(&work->entry));
687
Andrew Liu8a3e77c2008-05-01 04:35:14 -0700688 timer_stats_timer_set_start_info(&dwork->timer);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200689 /*
690 * This stores cwq for the moment, for the timer_fn.
691 * Note that the work's gcwq is preserved to allow
692 * reentrance detection for delayed works.
693 */
694 set_work_cwq(work, get_cwq(lcpu, wq), 0);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700695 timer->expires = jiffies + delay;
David Howells52bad642006-11-22 14:54:01 +0000696 timer->data = (unsigned long)dwork;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700697 timer->function = delayed_work_timer_fn;
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700698
699 if (unlikely(cpu >= 0))
700 add_timer_on(timer, cpu);
701 else
702 add_timer(timer);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700703 ret = 1;
704 }
705 return ret;
706}
Dave Jonesae90dd52006-06-30 01:40:45 -0400707EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Tejun Heoc8e55f32010-06-29 10:07:12 +0200709/**
710 * worker_enter_idle - enter idle state
711 * @worker: worker which is entering idle state
712 *
713 * @worker is entering idle state. Update stats and idle timer if
714 * necessary.
715 *
716 * LOCKING:
717 * spin_lock_irq(gcwq->lock).
718 */
719static void worker_enter_idle(struct worker *worker)
720{
721 struct global_cwq *gcwq = worker->gcwq;
722
723 BUG_ON(worker->flags & WORKER_IDLE);
724 BUG_ON(!list_empty(&worker->entry) &&
725 (worker->hentry.next || worker->hentry.pprev));
726
727 worker->flags |= WORKER_IDLE;
728 gcwq->nr_idle++;
729
730 /* idle_list is LIFO */
731 list_add(&worker->entry, &gcwq->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +0200732
733 if (unlikely(worker->flags & WORKER_ROGUE))
734 wake_up_all(&gcwq->trustee_wait);
Tejun Heoc8e55f32010-06-29 10:07:12 +0200735}
736
737/**
738 * worker_leave_idle - leave idle state
739 * @worker: worker which is leaving idle state
740 *
741 * @worker is leaving idle state. Update stats.
742 *
743 * LOCKING:
744 * spin_lock_irq(gcwq->lock).
745 */
746static void worker_leave_idle(struct worker *worker)
747{
748 struct global_cwq *gcwq = worker->gcwq;
749
750 BUG_ON(!(worker->flags & WORKER_IDLE));
751 worker->flags &= ~WORKER_IDLE;
752 gcwq->nr_idle--;
753 list_del_init(&worker->entry);
754}
755
Tejun Heoc34056a2010-06-29 10:07:11 +0200756static struct worker *alloc_worker(void)
757{
758 struct worker *worker;
759
760 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +0200761 if (worker) {
762 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +0200763 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heoc8e55f32010-06-29 10:07:12 +0200764 }
Tejun Heoc34056a2010-06-29 10:07:11 +0200765 return worker;
766}
767
768/**
769 * create_worker - create a new workqueue worker
770 * @cwq: cwq the new worker will belong to
771 * @bind: whether to set affinity to @cpu or not
772 *
773 * Create a new worker which is bound to @cwq. The returned worker
774 * can be started by calling start_worker() or destroyed using
775 * destroy_worker().
776 *
777 * CONTEXT:
778 * Might sleep. Does GFP_KERNEL allocations.
779 *
780 * RETURNS:
781 * Pointer to the newly created worker.
782 */
783static struct worker *create_worker(struct cpu_workqueue_struct *cwq, bool bind)
784{
Tejun Heo8b03ae32010-06-29 10:07:12 +0200785 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +0200786 int id = -1;
787 struct worker *worker = NULL;
788
Tejun Heo8b03ae32010-06-29 10:07:12 +0200789 spin_lock_irq(&gcwq->lock);
790 while (ida_get_new(&gcwq->worker_ida, &id)) {
791 spin_unlock_irq(&gcwq->lock);
792 if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +0200793 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200794 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +0200795 }
Tejun Heo8b03ae32010-06-29 10:07:12 +0200796 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +0200797
798 worker = alloc_worker();
799 if (!worker)
800 goto fail;
801
Tejun Heo8b03ae32010-06-29 10:07:12 +0200802 worker->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +0200803 worker->cwq = cwq;
804 worker->id = id;
805
806 worker->task = kthread_create(worker_thread, worker, "kworker/%u:%d",
Tejun Heo8b03ae32010-06-29 10:07:12 +0200807 gcwq->cpu, id);
Tejun Heoc34056a2010-06-29 10:07:11 +0200808 if (IS_ERR(worker->task))
809 goto fail;
810
Tejun Heodb7bccf2010-06-29 10:07:12 +0200811 /*
812 * A rogue worker will become a regular one if CPU comes
813 * online later on. Make sure every worker has
814 * PF_THREAD_BOUND set.
815 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200816 if (bind)
Tejun Heo8b03ae32010-06-29 10:07:12 +0200817 kthread_bind(worker->task, gcwq->cpu);
Tejun Heodb7bccf2010-06-29 10:07:12 +0200818 else
819 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heoc34056a2010-06-29 10:07:11 +0200820
821 return worker;
822fail:
823 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +0200824 spin_lock_irq(&gcwq->lock);
825 ida_remove(&gcwq->worker_ida, id);
826 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +0200827 }
828 kfree(worker);
829 return NULL;
830}
831
832/**
833 * start_worker - start a newly created worker
834 * @worker: worker to start
835 *
Tejun Heoc8e55f32010-06-29 10:07:12 +0200836 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +0200837 *
838 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200839 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +0200840 */
841static void start_worker(struct worker *worker)
842{
Tejun Heoc8e55f32010-06-29 10:07:12 +0200843 worker->flags |= WORKER_STARTED;
844 worker->gcwq->nr_workers++;
845 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +0200846 wake_up_process(worker->task);
847}
848
849/**
850 * destroy_worker - destroy a workqueue worker
851 * @worker: worker to be destroyed
852 *
Tejun Heoc8e55f32010-06-29 10:07:12 +0200853 * Destroy @worker and adjust @gcwq stats accordingly.
854 *
855 * CONTEXT:
856 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +0200857 */
858static void destroy_worker(struct worker *worker)
859{
Tejun Heo8b03ae32010-06-29 10:07:12 +0200860 struct global_cwq *gcwq = worker->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +0200861 int id = worker->id;
862
863 /* sanity check frenzy */
864 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +0200865 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +0200866
Tejun Heoc8e55f32010-06-29 10:07:12 +0200867 if (worker->flags & WORKER_STARTED)
868 gcwq->nr_workers--;
869 if (worker->flags & WORKER_IDLE)
870 gcwq->nr_idle--;
871
872 list_del_init(&worker->entry);
873 worker->flags |= WORKER_DIE;
874
875 spin_unlock_irq(&gcwq->lock);
876
Tejun Heoc34056a2010-06-29 10:07:11 +0200877 kthread_stop(worker->task);
878 kfree(worker);
879
Tejun Heo8b03ae32010-06-29 10:07:12 +0200880 spin_lock_irq(&gcwq->lock);
881 ida_remove(&gcwq->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +0200882}
883
Tejun Heoa62428c2010-06-29 10:07:10 +0200884/**
Tejun Heoaffee4b2010-06-29 10:07:12 +0200885 * move_linked_works - move linked works to a list
886 * @work: start of series of works to be scheduled
887 * @head: target list to append @work to
888 * @nextp: out paramter for nested worklist walking
889 *
890 * Schedule linked works starting from @work to @head. Work series to
891 * be scheduled starts at @work and includes any consecutive work with
892 * WORK_STRUCT_LINKED set in its predecessor.
893 *
894 * If @nextp is not NULL, it's updated to point to the next work of
895 * the last scheduled work. This allows move_linked_works() to be
896 * nested inside outer list_for_each_entry_safe().
897 *
898 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200899 * spin_lock_irq(gcwq->lock).
Tejun Heoaffee4b2010-06-29 10:07:12 +0200900 */
901static void move_linked_works(struct work_struct *work, struct list_head *head,
902 struct work_struct **nextp)
903{
904 struct work_struct *n;
905
906 /*
907 * Linked worklist will always end before the end of the list,
908 * use NULL for list head.
909 */
910 list_for_each_entry_safe_from(work, n, NULL, entry) {
911 list_move_tail(&work->entry, head);
912 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
913 break;
914 }
915
916 /*
917 * If we're already inside safe list traversal and have moved
918 * multiple works to the scheduled queue, the next position
919 * needs to be updated.
920 */
921 if (nextp)
922 *nextp = n;
923}
924
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200925static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
926{
927 struct work_struct *work = list_first_entry(&cwq->delayed_works,
928 struct work_struct, entry);
929
930 move_linked_works(work, &cwq->worklist, NULL);
931 cwq->nr_active++;
932}
933
Tejun Heoaffee4b2010-06-29 10:07:12 +0200934/**
Tejun Heo73f53c42010-06-29 10:07:11 +0200935 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
936 * @cwq: cwq of interest
937 * @color: color of work which left the queue
938 *
939 * A work either has completed or is removed from pending queue,
940 * decrement nr_in_flight of its cwq and handle workqueue flushing.
941 *
942 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200943 * spin_lock_irq(gcwq->lock).
Tejun Heo73f53c42010-06-29 10:07:11 +0200944 */
945static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
946{
947 /* ignore uncolored works */
948 if (color == WORK_NO_COLOR)
949 return;
950
951 cwq->nr_in_flight[color]--;
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200952 cwq->nr_active--;
953
Tejun Heo502ca9d2010-06-29 10:07:13 +0200954 if (!list_empty(&cwq->delayed_works)) {
955 /* one down, submit a delayed one */
956 if (cwq->nr_active < cwq->max_active)
957 cwq_activate_first_delayed(cwq);
958 } else if (!cwq->nr_active && cwq->wq->flags & WQ_SINGLE_CPU) {
959 /* this was the last work, unbind from single cpu */
960 cwq_unbind_single_cpu(cwq);
961 }
Tejun Heo73f53c42010-06-29 10:07:11 +0200962
963 /* is flush in progress and are we at the flushing tip? */
964 if (likely(cwq->flush_color != color))
965 return;
966
967 /* are there still in-flight works? */
968 if (cwq->nr_in_flight[color])
969 return;
970
971 /* this cwq is done, clear flush_color */
972 cwq->flush_color = -1;
973
974 /*
975 * If this was the last cwq, wake up the first flusher. It
976 * will handle the rest.
977 */
978 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
979 complete(&cwq->wq->first_flusher->done);
980}
981
982/**
Tejun Heoa62428c2010-06-29 10:07:10 +0200983 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +0200984 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +0200985 * @work: work to process
986 *
987 * Process @work. This function contains all the logics necessary to
988 * process a single work including synchronization against and
989 * interaction with other workers on the same cpu, queueing and
990 * flushing. As long as context requirement is met, any worker can
991 * call this function to process a work.
992 *
993 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200994 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +0200995 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200996static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heoa62428c2010-06-29 10:07:10 +0200997{
Tejun Heoc34056a2010-06-29 10:07:11 +0200998 struct cpu_workqueue_struct *cwq = worker->cwq;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200999 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001000 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heoa62428c2010-06-29 10:07:10 +02001001 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02001002 int work_color;
Tejun Heoa62428c2010-06-29 10:07:10 +02001003#ifdef CONFIG_LOCKDEP
1004 /*
1005 * It is permissible to free the struct work_struct from
1006 * inside the function that is called from it, this we need to
1007 * take into account for lockdep too. To avoid bogus "held
1008 * lock freed" warnings as well as problems when looking into
1009 * work->lockdep_map, make a copy and use that here.
1010 */
1011 struct lockdep_map lockdep_map = work->lockdep_map;
1012#endif
1013 /* claim and process */
Tejun Heoa62428c2010-06-29 10:07:10 +02001014 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001015 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02001016 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001017 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001018 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001019
1020 BUG_ON(get_work_cwq(work) != cwq);
1021 /* record the current cpu number in the work data and dequeue */
1022 set_work_cpu(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02001023 list_del_init(&work->entry);
1024
Tejun Heo8b03ae32010-06-29 10:07:12 +02001025 spin_unlock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001026
Tejun Heoa62428c2010-06-29 10:07:10 +02001027 work_clear_pending(work);
1028 lock_map_acquire(&cwq->wq->lockdep_map);
1029 lock_map_acquire(&lockdep_map);
1030 f(work);
1031 lock_map_release(&lockdep_map);
1032 lock_map_release(&cwq->wq->lockdep_map);
1033
1034 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1035 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1036 "%s/0x%08x/%d\n",
1037 current->comm, preempt_count(), task_pid_nr(current));
1038 printk(KERN_ERR " last function: ");
1039 print_symbol("%s\n", (unsigned long)f);
1040 debug_show_held_locks(current);
1041 dump_stack();
1042 }
1043
Tejun Heo8b03ae32010-06-29 10:07:12 +02001044 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001045
1046 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02001047 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001048 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001049 worker->current_cwq = NULL;
Tejun Heo73f53c42010-06-29 10:07:11 +02001050 cwq_dec_nr_in_flight(cwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02001051}
1052
Tejun Heoaffee4b2010-06-29 10:07:12 +02001053/**
1054 * process_scheduled_works - process scheduled works
1055 * @worker: self
1056 *
1057 * Process all scheduled works. Please note that the scheduled list
1058 * may change while processing a work, so this function repeatedly
1059 * fetches a work from the top and executes it.
1060 *
1061 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001062 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02001063 * multiple times.
1064 */
1065static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066{
Tejun Heoaffee4b2010-06-29 10:07:12 +02001067 while (!list_empty(&worker->scheduled)) {
1068 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001070 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072}
1073
Tejun Heo4690c4a2010-06-29 10:07:10 +02001074/**
1075 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02001076 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02001077 *
1078 * The cwq worker thread function.
1079 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001080static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081{
Tejun Heoc34056a2010-06-29 10:07:11 +02001082 struct worker *worker = __worker;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001083 struct global_cwq *gcwq = worker->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001084 struct cpu_workqueue_struct *cwq = worker->cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085
Tejun Heoc8e55f32010-06-29 10:07:12 +02001086woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02001087 spin_lock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001088
Tejun Heoc8e55f32010-06-29 10:07:12 +02001089 /* DIE can be set only while we're idle, checking here is enough */
1090 if (worker->flags & WORKER_DIE) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001091 spin_unlock_irq(&gcwq->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001092 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001094
Tejun Heoc8e55f32010-06-29 10:07:12 +02001095 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001096recheck:
Tejun Heoc8e55f32010-06-29 10:07:12 +02001097 /*
1098 * ->scheduled list can only be filled while a worker is
1099 * preparing to process a work or actually processing it.
1100 * Make sure nobody diddled with it while I was sleeping.
1101 */
1102 BUG_ON(!list_empty(&worker->scheduled));
1103
1104 while (!list_empty(&cwq->worklist)) {
1105 struct work_struct *work =
1106 list_first_entry(&cwq->worklist,
1107 struct work_struct, entry);
1108
Tejun Heodb7bccf2010-06-29 10:07:12 +02001109 /*
1110 * The following is a rather inefficient way to close
1111 * race window against cpu hotplug operations. Will
1112 * be replaced soon.
1113 */
1114 if (unlikely(!(worker->flags & WORKER_ROGUE) &&
1115 !cpumask_equal(&worker->task->cpus_allowed,
1116 get_cpu_mask(gcwq->cpu)))) {
1117 spin_unlock_irq(&gcwq->lock);
1118 set_cpus_allowed_ptr(worker->task,
1119 get_cpu_mask(gcwq->cpu));
1120 cpu_relax();
1121 spin_lock_irq(&gcwq->lock);
1122 goto recheck;
1123 }
1124
Tejun Heoc8e55f32010-06-29 10:07:12 +02001125 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1126 /* optimization path, not strictly necessary */
1127 process_one_work(worker, work);
1128 if (unlikely(!list_empty(&worker->scheduled)))
1129 process_scheduled_works(worker);
1130 } else {
1131 move_linked_works(work, &worker->scheduled, NULL);
1132 process_scheduled_works(worker);
1133 }
1134 }
1135
1136 /*
1137 * gcwq->lock is held and there's no work to process, sleep.
1138 * Workers are woken up only while holding gcwq->lock, so
1139 * setting the current state before releasing gcwq->lock is
1140 * enough to prevent losing any event.
1141 */
1142 worker_enter_idle(worker);
1143 __set_current_state(TASK_INTERRUPTIBLE);
1144 spin_unlock_irq(&gcwq->lock);
1145 schedule();
1146 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147}
1148
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07001149struct wq_barrier {
1150 struct work_struct work;
1151 struct completion done;
1152};
1153
1154static void wq_barrier_func(struct work_struct *work)
1155{
1156 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
1157 complete(&barr->done);
1158}
1159
Tejun Heo4690c4a2010-06-29 10:07:10 +02001160/**
1161 * insert_wq_barrier - insert a barrier work
1162 * @cwq: cwq to insert barrier into
1163 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02001164 * @target: target work to attach @barr to
1165 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02001166 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02001167 * @barr is linked to @target such that @barr is completed only after
1168 * @target finishes execution. Please note that the ordering
1169 * guarantee is observed only with respect to @target and on the local
1170 * cpu.
1171 *
1172 * Currently, a queued barrier can't be canceled. This is because
1173 * try_to_grab_pending() can't determine whether the work to be
1174 * grabbed is at the head of the queue and thus can't clear LINKED
1175 * flag of the previous work while there must be a valid next work
1176 * after a work with LINKED flag set.
1177 *
1178 * Note that when @worker is non-NULL, @target may be modified
1179 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001180 *
1181 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001182 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001183 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07001184static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02001185 struct wq_barrier *barr,
1186 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07001187{
Tejun Heoaffee4b2010-06-29 10:07:12 +02001188 struct list_head *head;
1189 unsigned int linked = 0;
1190
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001191 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02001192 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001193 * as we know for sure that this will not trigger any of the
1194 * checks and call back into the fixup functions where we
1195 * might deadlock.
1196 */
1197 INIT_WORK_ON_STACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02001198 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07001199 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07001200
Tejun Heoaffee4b2010-06-29 10:07:12 +02001201 /*
1202 * If @target is currently being executed, schedule the
1203 * barrier to the worker; otherwise, put it after @target.
1204 */
1205 if (worker)
1206 head = worker->scheduled.next;
1207 else {
1208 unsigned long *bits = work_data_bits(target);
1209
1210 head = target->entry.next;
1211 /* there can already be other linked works, inherit and set */
1212 linked = *bits & WORK_STRUCT_LINKED;
1213 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
1214 }
1215
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001216 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001217 insert_work(cwq, &barr->work, head,
1218 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07001219}
1220
Tejun Heo73f53c42010-06-29 10:07:11 +02001221/**
1222 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
1223 * @wq: workqueue being flushed
1224 * @flush_color: new flush color, < 0 for no-op
1225 * @work_color: new work color, < 0 for no-op
1226 *
1227 * Prepare cwqs for workqueue flushing.
1228 *
1229 * If @flush_color is non-negative, flush_color on all cwqs should be
1230 * -1. If no cwq has in-flight commands at the specified color, all
1231 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
1232 * has in flight commands, its cwq->flush_color is set to
1233 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
1234 * wakeup logic is armed and %true is returned.
1235 *
1236 * The caller should have initialized @wq->first_flusher prior to
1237 * calling this function with non-negative @flush_color. If
1238 * @flush_color is negative, no flush color update is done and %false
1239 * is returned.
1240 *
1241 * If @work_color is non-negative, all cwqs should have the same
1242 * work_color which is previous to @work_color and all will be
1243 * advanced to @work_color.
1244 *
1245 * CONTEXT:
1246 * mutex_lock(wq->flush_mutex).
1247 *
1248 * RETURNS:
1249 * %true if @flush_color >= 0 and there's something to flush. %false
1250 * otherwise.
1251 */
1252static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
1253 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254{
Tejun Heo73f53c42010-06-29 10:07:11 +02001255 bool wait = false;
1256 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07001257
Tejun Heo73f53c42010-06-29 10:07:11 +02001258 if (flush_color >= 0) {
1259 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
1260 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001261 }
Oleg Nesterov14441962007-05-23 13:57:57 -07001262
Tejun Heo73f53c42010-06-29 10:07:11 +02001263 for_each_possible_cpu(cpu) {
1264 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001265 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001266
Tejun Heo8b03ae32010-06-29 10:07:12 +02001267 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02001268
1269 if (flush_color >= 0) {
1270 BUG_ON(cwq->flush_color != -1);
1271
1272 if (cwq->nr_in_flight[flush_color]) {
1273 cwq->flush_color = flush_color;
1274 atomic_inc(&wq->nr_cwqs_to_flush);
1275 wait = true;
1276 }
1277 }
1278
1279 if (work_color >= 0) {
1280 BUG_ON(work_color != work_next_color(cwq->work_color));
1281 cwq->work_color = work_color;
1282 }
1283
Tejun Heo8b03ae32010-06-29 10:07:12 +02001284 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02001285 }
1286
1287 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
1288 complete(&wq->first_flusher->done);
1289
1290 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291}
1292
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001293/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001295 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 *
1297 * Forces execution of the workqueue and blocks until its completion.
1298 * This is typically used in driver shutdown handlers.
1299 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07001300 * We sleep until all works which were queued on entry have been handled,
1301 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001303void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304{
Tejun Heo73f53c42010-06-29 10:07:11 +02001305 struct wq_flusher this_flusher = {
1306 .list = LIST_HEAD_INIT(this_flusher.list),
1307 .flush_color = -1,
1308 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
1309 };
1310 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07001311
Ingo Molnar3295f0e2008-08-11 10:30:30 +02001312 lock_map_acquire(&wq->lockdep_map);
1313 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02001314
1315 mutex_lock(&wq->flush_mutex);
1316
1317 /*
1318 * Start-to-wait phase
1319 */
1320 next_color = work_next_color(wq->work_color);
1321
1322 if (next_color != wq->flush_color) {
1323 /*
1324 * Color space is not full. The current work_color
1325 * becomes our flush_color and work_color is advanced
1326 * by one.
1327 */
1328 BUG_ON(!list_empty(&wq->flusher_overflow));
1329 this_flusher.flush_color = wq->work_color;
1330 wq->work_color = next_color;
1331
1332 if (!wq->first_flusher) {
1333 /* no flush in progress, become the first flusher */
1334 BUG_ON(wq->flush_color != this_flusher.flush_color);
1335
1336 wq->first_flusher = &this_flusher;
1337
1338 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
1339 wq->work_color)) {
1340 /* nothing to flush, done */
1341 wq->flush_color = next_color;
1342 wq->first_flusher = NULL;
1343 goto out_unlock;
1344 }
1345 } else {
1346 /* wait in queue */
1347 BUG_ON(wq->flush_color == this_flusher.flush_color);
1348 list_add_tail(&this_flusher.list, &wq->flusher_queue);
1349 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
1350 }
1351 } else {
1352 /*
1353 * Oops, color space is full, wait on overflow queue.
1354 * The next flush completion will assign us
1355 * flush_color and transfer to flusher_queue.
1356 */
1357 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
1358 }
1359
1360 mutex_unlock(&wq->flush_mutex);
1361
1362 wait_for_completion(&this_flusher.done);
1363
1364 /*
1365 * Wake-up-and-cascade phase
1366 *
1367 * First flushers are responsible for cascading flushes and
1368 * handling overflow. Non-first flushers can simply return.
1369 */
1370 if (wq->first_flusher != &this_flusher)
1371 return;
1372
1373 mutex_lock(&wq->flush_mutex);
1374
1375 wq->first_flusher = NULL;
1376
1377 BUG_ON(!list_empty(&this_flusher.list));
1378 BUG_ON(wq->flush_color != this_flusher.flush_color);
1379
1380 while (true) {
1381 struct wq_flusher *next, *tmp;
1382
1383 /* complete all the flushers sharing the current flush color */
1384 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
1385 if (next->flush_color != wq->flush_color)
1386 break;
1387 list_del_init(&next->list);
1388 complete(&next->done);
1389 }
1390
1391 BUG_ON(!list_empty(&wq->flusher_overflow) &&
1392 wq->flush_color != work_next_color(wq->work_color));
1393
1394 /* this flush_color is finished, advance by one */
1395 wq->flush_color = work_next_color(wq->flush_color);
1396
1397 /* one color has been freed, handle overflow queue */
1398 if (!list_empty(&wq->flusher_overflow)) {
1399 /*
1400 * Assign the same color to all overflowed
1401 * flushers, advance work_color and append to
1402 * flusher_queue. This is the start-to-wait
1403 * phase for these overflowed flushers.
1404 */
1405 list_for_each_entry(tmp, &wq->flusher_overflow, list)
1406 tmp->flush_color = wq->work_color;
1407
1408 wq->work_color = work_next_color(wq->work_color);
1409
1410 list_splice_tail_init(&wq->flusher_overflow,
1411 &wq->flusher_queue);
1412 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
1413 }
1414
1415 if (list_empty(&wq->flusher_queue)) {
1416 BUG_ON(wq->flush_color != wq->work_color);
1417 break;
1418 }
1419
1420 /*
1421 * Need to flush more colors. Make the next flusher
1422 * the new first flusher and arm cwqs.
1423 */
1424 BUG_ON(wq->flush_color == wq->work_color);
1425 BUG_ON(wq->flush_color != next->flush_color);
1426
1427 list_del_init(&next->list);
1428 wq->first_flusher = next;
1429
1430 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
1431 break;
1432
1433 /*
1434 * Meh... this color is already done, clear first
1435 * flusher and repeat cascading.
1436 */
1437 wq->first_flusher = NULL;
1438 }
1439
1440out_unlock:
1441 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442}
Dave Jonesae90dd52006-06-30 01:40:45 -04001443EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444
Oleg Nesterovdb700892008-07-25 01:47:49 -07001445/**
1446 * flush_work - block until a work_struct's callback has terminated
1447 * @work: the work which is to be flushed
1448 *
Oleg Nesterova67da702008-07-25 01:47:52 -07001449 * Returns false if @work has already terminated.
1450 *
Oleg Nesterovdb700892008-07-25 01:47:49 -07001451 * It is expected that, prior to calling flush_work(), the caller has
1452 * arranged for the work to not be requeued, otherwise it doesn't make
1453 * sense to use this function.
1454 */
1455int flush_work(struct work_struct *work)
1456{
Tejun Heoaffee4b2010-06-29 10:07:12 +02001457 struct worker *worker = NULL;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001458 struct global_cwq *gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001459 struct cpu_workqueue_struct *cwq;
Oleg Nesterovdb700892008-07-25 01:47:49 -07001460 struct wq_barrier barr;
1461
1462 might_sleep();
Tejun Heo7a22ad72010-06-29 10:07:13 +02001463 gcwq = get_work_gcwq(work);
1464 if (!gcwq)
Oleg Nesterovdb700892008-07-25 01:47:49 -07001465 return 0;
Oleg Nesterova67da702008-07-25 01:47:52 -07001466
Tejun Heo8b03ae32010-06-29 10:07:12 +02001467 spin_lock_irq(&gcwq->lock);
Oleg Nesterovdb700892008-07-25 01:47:49 -07001468 if (!list_empty(&work->entry)) {
1469 /*
1470 * See the comment near try_to_grab_pending()->smp_rmb().
Tejun Heo7a22ad72010-06-29 10:07:13 +02001471 * If it was re-queued to a different gcwq under us, we
1472 * are not going to wait.
Oleg Nesterovdb700892008-07-25 01:47:49 -07001473 */
1474 smp_rmb();
Tejun Heo7a22ad72010-06-29 10:07:13 +02001475 cwq = get_work_cwq(work);
1476 if (unlikely(!cwq || gcwq != cwq->gcwq))
Tejun Heo4690c4a2010-06-29 10:07:10 +02001477 goto already_gone;
Oleg Nesterovdb700892008-07-25 01:47:49 -07001478 } else {
Tejun Heo7a22ad72010-06-29 10:07:13 +02001479 worker = find_worker_executing_work(gcwq, work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001480 if (!worker)
Tejun Heo4690c4a2010-06-29 10:07:10 +02001481 goto already_gone;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001482 cwq = worker->current_cwq;
Oleg Nesterovdb700892008-07-25 01:47:49 -07001483 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07001484
Tejun Heoaffee4b2010-06-29 10:07:12 +02001485 insert_wq_barrier(cwq, &barr, work, worker);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001486 spin_unlock_irq(&gcwq->lock);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001487
1488 lock_map_acquire(&cwq->wq->lockdep_map);
1489 lock_map_release(&cwq->wq->lockdep_map);
1490
Oleg Nesterovdb700892008-07-25 01:47:49 -07001491 wait_for_completion(&barr.done);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001492 destroy_work_on_stack(&barr.work);
Oleg Nesterovdb700892008-07-25 01:47:49 -07001493 return 1;
Tejun Heo4690c4a2010-06-29 10:07:10 +02001494already_gone:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001495 spin_unlock_irq(&gcwq->lock);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001496 return 0;
Oleg Nesterovdb700892008-07-25 01:47:49 -07001497}
1498EXPORT_SYMBOL_GPL(flush_work);
1499
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001500/*
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001501 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001502 * so this work can't be re-armed in any way.
1503 */
1504static int try_to_grab_pending(struct work_struct *work)
1505{
Tejun Heo8b03ae32010-06-29 10:07:12 +02001506 struct global_cwq *gcwq;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001507 int ret = -1;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001508
Tejun Heo22df02b2010-06-29 10:07:10 +02001509 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001510 return 0;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001511
1512 /*
1513 * The queueing is in progress, or it is already queued. Try to
1514 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1515 */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001516 gcwq = get_work_gcwq(work);
1517 if (!gcwq)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001518 return ret;
1519
Tejun Heo8b03ae32010-06-29 10:07:12 +02001520 spin_lock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001521 if (!list_empty(&work->entry)) {
1522 /*
Tejun Heo7a22ad72010-06-29 10:07:13 +02001523 * This work is queued, but perhaps we locked the wrong gcwq.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001524 * In that case we must see the new value after rmb(), see
1525 * insert_work()->wmb().
1526 */
1527 smp_rmb();
Tejun Heo7a22ad72010-06-29 10:07:13 +02001528 if (gcwq == get_work_gcwq(work)) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001529 debug_work_deactivate(work);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001530 list_del_init(&work->entry);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001531 cwq_dec_nr_in_flight(get_work_cwq(work),
1532 get_work_color(work));
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001533 ret = 1;
1534 }
1535 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001536 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001537
1538 return ret;
1539}
1540
Tejun Heo7a22ad72010-06-29 10:07:13 +02001541static void wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001542{
1543 struct wq_barrier barr;
Tejun Heoaffee4b2010-06-29 10:07:12 +02001544 struct worker *worker;
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001545
Tejun Heo8b03ae32010-06-29 10:07:12 +02001546 spin_lock_irq(&gcwq->lock);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001547
Tejun Heo7a22ad72010-06-29 10:07:13 +02001548 worker = find_worker_executing_work(gcwq, work);
1549 if (unlikely(worker))
1550 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001551
Tejun Heo8b03ae32010-06-29 10:07:12 +02001552 spin_unlock_irq(&gcwq->lock);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001553
Tejun Heoaffee4b2010-06-29 10:07:12 +02001554 if (unlikely(worker)) {
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001555 wait_for_completion(&barr.done);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001556 destroy_work_on_stack(&barr.work);
1557 }
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001558}
1559
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001560static void wait_on_work(struct work_struct *work)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001561{
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07001562 int cpu;
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001563
Oleg Nesterovf293ea92007-05-09 02:34:10 -07001564 might_sleep();
1565
Ingo Molnar3295f0e2008-08-11 10:30:30 +02001566 lock_map_acquire(&work->lockdep_map);
1567 lock_map_release(&work->lockdep_map);
Johannes Berg4e6045f2007-10-18 23:39:55 -07001568
Tejun Heo15376632010-06-29 10:07:11 +02001569 for_each_possible_cpu(cpu)
Tejun Heo7a22ad72010-06-29 10:07:13 +02001570 wait_on_cpu_work(get_gcwq(cpu), work);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001571}
1572
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001573static int __cancel_work_timer(struct work_struct *work,
1574 struct timer_list* timer)
1575{
1576 int ret;
1577
1578 do {
1579 ret = (timer && likely(del_timer(timer)));
1580 if (!ret)
1581 ret = try_to_grab_pending(work);
1582 wait_on_work(work);
1583 } while (unlikely(ret < 0));
1584
Tejun Heo7a22ad72010-06-29 10:07:13 +02001585 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001586 return ret;
1587}
1588
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001589/**
1590 * cancel_work_sync - block until a work_struct's callback has terminated
1591 * @work: the work which is to be flushed
1592 *
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001593 * Returns true if @work was pending.
1594 *
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001595 * cancel_work_sync() will cancel the work if it is queued. If the work's
1596 * callback appears to be running, cancel_work_sync() will block until it
1597 * has completed.
1598 *
1599 * It is possible to use this function if the work re-queues itself. It can
1600 * cancel the work even if it migrates to another workqueue, however in that
1601 * case it only guarantees that work->func() has completed on the last queued
1602 * workqueue.
1603 *
1604 * cancel_work_sync(&delayed_work->work) should be used only if ->timer is not
1605 * pending, otherwise it goes into a busy-wait loop until the timer expires.
1606 *
1607 * The caller must ensure that workqueue_struct on which this work was last
1608 * queued can't be destroyed before this function returns.
1609 */
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001610int cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001611{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001612 return __cancel_work_timer(work, NULL);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001613}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07001614EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001615
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001616/**
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07001617 * cancel_delayed_work_sync - reliably kill off a delayed work.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001618 * @dwork: the delayed work struct
1619 *
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001620 * Returns true if @dwork was pending.
1621 *
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001622 * It is possible to use this function if @dwork rearms itself via queue_work()
1623 * or queue_delayed_work(). See also the comment for cancel_work_sync().
1624 */
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001625int cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001626{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07001627 return __cancel_work_timer(&dwork->work, &dwork->timer);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001628}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07001629EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001631static struct workqueue_struct *keventd_wq __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001633/**
1634 * schedule_work - put work task in global workqueue
1635 * @work: job to be done
1636 *
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02001637 * Returns zero if @work was already on the kernel-global workqueue and
1638 * non-zero otherwise.
1639 *
1640 * This puts a job in the kernel-global workqueue if it was not already
1641 * queued and leaves it in the same position on the kernel-global
1642 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001643 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001644int schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645{
1646 return queue_work(keventd_wq, work);
1647}
Dave Jonesae90dd52006-06-30 01:40:45 -04001648EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649
Zhang Ruic1a220e2008-07-23 21:28:39 -07001650/*
1651 * schedule_work_on - put work task on a specific cpu
1652 * @cpu: cpu to put the work task on
1653 * @work: job to be done
1654 *
1655 * This puts a job on a specific cpu
1656 */
1657int schedule_work_on(int cpu, struct work_struct *work)
1658{
1659 return queue_work_on(cpu, keventd_wq, work);
1660}
1661EXPORT_SYMBOL(schedule_work_on);
1662
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001663/**
1664 * schedule_delayed_work - put work task in global workqueue after delay
David Howells52bad642006-11-22 14:54:01 +00001665 * @dwork: job to be done
1666 * @delay: number of jiffies to wait or 0 for immediate execution
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001667 *
1668 * After waiting for a given time this puts a job in the kernel-global
1669 * workqueue.
1670 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001671int schedule_delayed_work(struct delayed_work *dwork,
Ingo Molnar82f67cd2007-02-16 01:28:13 -08001672 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673{
David Howells52bad642006-11-22 14:54:01 +00001674 return queue_delayed_work(keventd_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675}
Dave Jonesae90dd52006-06-30 01:40:45 -04001676EXPORT_SYMBOL(schedule_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001678/**
Linus Torvalds8c53e462009-10-14 09:16:42 -07001679 * flush_delayed_work - block until a dwork_struct's callback has terminated
1680 * @dwork: the delayed work which is to be flushed
1681 *
1682 * Any timeout is cancelled, and any pending work is run immediately.
1683 */
1684void flush_delayed_work(struct delayed_work *dwork)
1685{
1686 if (del_timer_sync(&dwork->timer)) {
Tejun Heo7a22ad72010-06-29 10:07:13 +02001687 __queue_work(get_cpu(), get_work_cwq(&dwork->work)->wq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001688 &dwork->work);
Linus Torvalds8c53e462009-10-14 09:16:42 -07001689 put_cpu();
1690 }
1691 flush_work(&dwork->work);
1692}
1693EXPORT_SYMBOL(flush_delayed_work);
1694
1695/**
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001696 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
1697 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00001698 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001699 * @delay: number of jiffies to wait
1700 *
1701 * After waiting for a given time this puts a job in the kernel-global
1702 * workqueue on the specified CPU.
1703 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704int schedule_delayed_work_on(int cpu,
David Howells52bad642006-11-22 14:54:01 +00001705 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706{
David Howells52bad642006-11-22 14:54:01 +00001707 return queue_delayed_work_on(cpu, keventd_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708}
Dave Jonesae90dd52006-06-30 01:40:45 -04001709EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
Andrew Mortonb6136772006-06-25 05:47:49 -07001711/**
1712 * schedule_on_each_cpu - call a function on each online CPU from keventd
1713 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07001714 *
1715 * Returns zero on success.
1716 * Returns -ve errno on failure.
1717 *
Andrew Mortonb6136772006-06-25 05:47:49 -07001718 * schedule_on_each_cpu() is very slow.
1719 */
David Howells65f27f32006-11-22 14:55:48 +00001720int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08001721{
1722 int cpu;
Andi Kleen65a64462009-10-14 06:22:47 +02001723 int orig = -1;
Andrew Mortonb6136772006-06-25 05:47:49 -07001724 struct work_struct *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08001725
Andrew Mortonb6136772006-06-25 05:47:49 -07001726 works = alloc_percpu(struct work_struct);
1727 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08001728 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07001729
Gautham R Shenoy95402b32008-01-25 21:08:02 +01001730 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08001731
1732 /*
1733 * When running in keventd don't schedule a work item on
1734 * itself. Can just call directly because the work queue is
1735 * already bound. This also is faster.
1736 */
1737 if (current_is_keventd())
1738 orig = raw_smp_processor_id();
1739
Christoph Lameter15316ba2006-01-08 01:00:43 -08001740 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01001741 struct work_struct *work = per_cpu_ptr(works, cpu);
1742
1743 INIT_WORK(work, func);
Andi Kleen65a64462009-10-14 06:22:47 +02001744 if (cpu != orig)
Tejun Heo93981802009-11-17 14:06:20 -08001745 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02001746 }
Tejun Heo93981802009-11-17 14:06:20 -08001747 if (orig >= 0)
1748 func(per_cpu_ptr(works, orig));
1749
1750 for_each_online_cpu(cpu)
1751 flush_work(per_cpu_ptr(works, cpu));
1752
Gautham R Shenoy95402b32008-01-25 21:08:02 +01001753 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07001754 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08001755 return 0;
1756}
1757
Alan Sterneef6a7d2010-02-12 17:39:21 +09001758/**
1759 * flush_scheduled_work - ensure that any scheduled work has run to completion.
1760 *
1761 * Forces execution of the kernel-global workqueue and blocks until its
1762 * completion.
1763 *
1764 * Think twice before calling this function! It's very easy to get into
1765 * trouble if you don't take great care. Either of the following situations
1766 * will lead to deadlock:
1767 *
1768 * One of the work items currently on the workqueue needs to acquire
1769 * a lock held by your code or its caller.
1770 *
1771 * Your code is running in the context of a work routine.
1772 *
1773 * They will be detected by lockdep when they occur, but the first might not
1774 * occur very often. It depends on what work items are on the workqueue and
1775 * what locks they need, which you have no control over.
1776 *
1777 * In most situations flushing the entire workqueue is overkill; you merely
1778 * need to know that a particular work item isn't queued and isn't running.
1779 * In such cases you should use cancel_delayed_work_sync() or
1780 * cancel_work_sync() instead.
1781 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782void flush_scheduled_work(void)
1783{
1784 flush_workqueue(keventd_wq);
1785}
Dave Jonesae90dd52006-06-30 01:40:45 -04001786EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787
1788/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06001789 * execute_in_process_context - reliably execute the routine with user context
1790 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06001791 * @ew: guaranteed storage for the execute work structure (must
1792 * be available when the work executes)
1793 *
1794 * Executes the function immediately if process context is available,
1795 * otherwise schedules the function for delayed execution.
1796 *
1797 * Returns: 0 - function was executed
1798 * 1 - function was scheduled for execution
1799 */
David Howells65f27f32006-11-22 14:55:48 +00001800int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06001801{
1802 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00001803 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06001804 return 0;
1805 }
1806
David Howells65f27f32006-11-22 14:55:48 +00001807 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06001808 schedule_work(&ew->work);
1809
1810 return 1;
1811}
1812EXPORT_SYMBOL_GPL(execute_in_process_context);
1813
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814int keventd_up(void)
1815{
1816 return keventd_wq != NULL;
1817}
1818
1819int current_is_keventd(void)
1820{
1821 struct cpu_workqueue_struct *cwq;
Hugh Dickinsd2437692007-08-27 16:06:19 +01001822 int cpu = raw_smp_processor_id(); /* preempt-safe: keventd is per-cpu */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 int ret = 0;
1824
1825 BUG_ON(!keventd_wq);
1826
Tejun Heo15376632010-06-29 10:07:11 +02001827 cwq = get_cwq(cpu, keventd_wq);
Tejun Heoc34056a2010-06-29 10:07:11 +02001828 if (current == cwq->worker->task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 ret = 1;
1830
1831 return ret;
1832
1833}
1834
Tejun Heo0f900042010-06-29 10:07:11 +02001835static struct cpu_workqueue_struct *alloc_cwqs(void)
1836{
1837 /*
1838 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
1839 * Make sure that the alignment isn't lower than that of
1840 * unsigned long long.
1841 */
1842 const size_t size = sizeof(struct cpu_workqueue_struct);
1843 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
1844 __alignof__(unsigned long long));
1845 struct cpu_workqueue_struct *cwqs;
1846#ifndef CONFIG_SMP
1847 void *ptr;
1848
1849 /*
1850 * On UP, percpu allocator doesn't honor alignment parameter
1851 * and simply uses arch-dependent default. Allocate enough
1852 * room to align cwq and put an extra pointer at the end
1853 * pointing back to the originally allocated pointer which
1854 * will be used for free.
1855 *
1856 * FIXME: This really belongs to UP percpu code. Update UP
1857 * percpu code to honor alignment and remove this ugliness.
1858 */
1859 ptr = __alloc_percpu(size + align + sizeof(void *), 1);
1860 cwqs = PTR_ALIGN(ptr, align);
1861 *(void **)per_cpu_ptr(cwqs + 1, 0) = ptr;
1862#else
1863 /* On SMP, percpu allocator can do it itself */
1864 cwqs = __alloc_percpu(size, align);
1865#endif
1866 /* just in case, make sure it's actually aligned */
1867 BUG_ON(!IS_ALIGNED((unsigned long)cwqs, align));
1868 return cwqs;
1869}
1870
1871static void free_cwqs(struct cpu_workqueue_struct *cwqs)
1872{
1873#ifndef CONFIG_SMP
1874 /* on UP, the pointer to free is stored right after the cwq */
1875 if (cwqs)
1876 free_percpu(*(void **)per_cpu_ptr(cwqs + 1, 0));
1877#else
1878 free_percpu(cwqs);
1879#endif
1880}
1881
Johannes Berg4e6045f2007-10-18 23:39:55 -07001882struct workqueue_struct *__create_workqueue_key(const char *name,
Tejun Heo97e37d72010-06-29 10:07:10 +02001883 unsigned int flags,
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001884 int max_active,
Johannes Bergeb13ba82008-01-16 09:51:58 +01001885 struct lock_class_key *key,
1886 const char *lock_name)
Oleg Nesterov3af244332007-05-09 02:34:09 -07001887{
1888 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001889 bool failed = false;
1890 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001891
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001892 max_active = clamp_val(max_active, 1, INT_MAX);
1893
Oleg Nesterov3af244332007-05-09 02:34:09 -07001894 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
1895 if (!wq)
Tejun Heo4690c4a2010-06-29 10:07:10 +02001896 goto err;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001897
Tejun Heo0f900042010-06-29 10:07:11 +02001898 wq->cpu_wq = alloc_cwqs();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001899 if (!wq->cpu_wq)
1900 goto err;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001901
Tejun Heo97e37d72010-06-29 10:07:10 +02001902 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02001903 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02001904 mutex_init(&wq->flush_mutex);
1905 atomic_set(&wq->nr_cwqs_to_flush, 0);
1906 INIT_LIST_HEAD(&wq->flusher_queue);
1907 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001908 wq->single_cpu = NR_CPUS;
1909
Oleg Nesterov3af244332007-05-09 02:34:09 -07001910 wq->name = name;
Johannes Bergeb13ba82008-01-16 09:51:58 +01001911 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07001912 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001913
Tejun Heo15376632010-06-29 10:07:11 +02001914 cpu_maps_update_begin();
1915 /*
1916 * We must initialize cwqs for each possible cpu even if we
1917 * are going to call destroy_workqueue() finally. Otherwise
1918 * cpu_up() can hit the uninitialized cwq once we drop the
1919 * lock.
1920 */
1921 for_each_possible_cpu(cpu) {
1922 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001923 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo15376632010-06-29 10:07:11 +02001924
Tejun Heo0f900042010-06-29 10:07:11 +02001925 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001926 cwq->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001927 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001928 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001929 cwq->max_active = max_active;
Tejun Heo15376632010-06-29 10:07:11 +02001930 INIT_LIST_HEAD(&cwq->worklist);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001931 INIT_LIST_HEAD(&cwq->delayed_works);
Tejun Heo15376632010-06-29 10:07:11 +02001932
Tejun Heoc34056a2010-06-29 10:07:11 +02001933 if (failed)
Tejun Heo15376632010-06-29 10:07:11 +02001934 continue;
Tejun Heo502ca9d2010-06-29 10:07:13 +02001935 cwq->worker = create_worker(cwq, cpu_online(cpu));
Tejun Heoc34056a2010-06-29 10:07:11 +02001936 if (cwq->worker)
1937 start_worker(cwq->worker);
Tejun Heo15376632010-06-29 10:07:11 +02001938 else
Tejun Heoc34056a2010-06-29 10:07:11 +02001939 failed = true;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001940 }
1941
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02001942 /*
1943 * workqueue_lock protects global freeze state and workqueues
1944 * list. Grab it, set max_active accordingly and add the new
1945 * workqueue to workqueues list.
1946 */
Tejun Heo15376632010-06-29 10:07:11 +02001947 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02001948
1949 if (workqueue_freezing && wq->flags & WQ_FREEZEABLE)
1950 for_each_possible_cpu(cpu)
1951 get_cwq(cpu, wq)->max_active = 0;
1952
Tejun Heo15376632010-06-29 10:07:11 +02001953 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02001954
Tejun Heo15376632010-06-29 10:07:11 +02001955 spin_unlock(&workqueue_lock);
1956
1957 cpu_maps_update_done();
1958
Tejun Heoc34056a2010-06-29 10:07:11 +02001959 if (failed) {
Oleg Nesterov3af244332007-05-09 02:34:09 -07001960 destroy_workqueue(wq);
1961 wq = NULL;
1962 }
1963 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02001964err:
1965 if (wq) {
Tejun Heo0f900042010-06-29 10:07:11 +02001966 free_cwqs(wq->cpu_wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001967 kfree(wq);
1968 }
1969 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001970}
Johannes Berg4e6045f2007-10-18 23:39:55 -07001971EXPORT_SYMBOL_GPL(__create_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001972
Oleg Nesterov3af244332007-05-09 02:34:09 -07001973/**
1974 * destroy_workqueue - safely terminate a workqueue
1975 * @wq: target workqueue
1976 *
1977 * Safely destroy a workqueue. All work currently pending will be done first.
1978 */
1979void destroy_workqueue(struct workqueue_struct *wq)
1980{
Tejun Heoc8e55f32010-06-29 10:07:12 +02001981 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001982
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02001983 flush_workqueue(wq);
1984
1985 /*
1986 * wq list is used to freeze wq, remove from list after
1987 * flushing is complete in case freeze races us.
1988 */
Oleg Nesterov3da1c842008-07-25 01:47:50 -07001989 cpu_maps_update_begin();
Gautham R Shenoy95402b32008-01-25 21:08:02 +01001990 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07001991 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01001992 spin_unlock(&workqueue_lock);
Tejun Heo15376632010-06-29 10:07:11 +02001993 cpu_maps_update_done();
Oleg Nesterov3af244332007-05-09 02:34:09 -07001994
Tejun Heo73f53c42010-06-29 10:07:11 +02001995 for_each_possible_cpu(cpu) {
1996 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
1997 int i;
1998
Tejun Heoc34056a2010-06-29 10:07:11 +02001999 if (cwq->worker) {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002000 spin_lock_irq(&cwq->gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02002001 destroy_worker(cwq->worker);
2002 cwq->worker = NULL;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002003 spin_unlock_irq(&cwq->gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002004 }
2005
2006 for (i = 0; i < WORK_NR_COLORS; i++)
2007 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02002008 BUG_ON(cwq->nr_active);
2009 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02002010 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002011
Tejun Heo0f900042010-06-29 10:07:11 +02002012 free_cwqs(wq->cpu_wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002013 kfree(wq);
2014}
2015EXPORT_SYMBOL_GPL(destroy_workqueue);
2016
Tejun Heodb7bccf2010-06-29 10:07:12 +02002017/*
2018 * CPU hotplug.
2019 *
2020 * CPU hotplug is implemented by allowing cwqs to be detached from
2021 * CPU, running with unbound workers and allowing them to be
2022 * reattached later if the cpu comes back online. A separate thread
2023 * is created to govern cwqs in such state and is called the trustee.
2024 *
2025 * Trustee states and their descriptions.
2026 *
2027 * START Command state used on startup. On CPU_DOWN_PREPARE, a
2028 * new trustee is started with this state.
2029 *
2030 * IN_CHARGE Once started, trustee will enter this state after
2031 * making all existing workers rogue. DOWN_PREPARE waits
2032 * for trustee to enter this state. After reaching
2033 * IN_CHARGE, trustee tries to execute the pending
2034 * worklist until it's empty and the state is set to
2035 * BUTCHER, or the state is set to RELEASE.
2036 *
2037 * BUTCHER Command state which is set by the cpu callback after
2038 * the cpu has went down. Once this state is set trustee
2039 * knows that there will be no new works on the worklist
2040 * and once the worklist is empty it can proceed to
2041 * killing idle workers.
2042 *
2043 * RELEASE Command state which is set by the cpu callback if the
2044 * cpu down has been canceled or it has come online
2045 * again. After recognizing this state, trustee stops
2046 * trying to drain or butcher and transits to DONE.
2047 *
2048 * DONE Trustee will enter this state after BUTCHER or RELEASE
2049 * is complete.
2050 *
2051 * trustee CPU draining
2052 * took over down complete
2053 * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
2054 * | | ^
2055 * | CPU is back online v return workers |
2056 * ----------------> RELEASE --------------
2057 */
2058
2059/**
2060 * trustee_wait_event_timeout - timed event wait for trustee
2061 * @cond: condition to wait for
2062 * @timeout: timeout in jiffies
2063 *
2064 * wait_event_timeout() for trustee to use. Handles locking and
2065 * checks for RELEASE request.
2066 *
2067 * CONTEXT:
2068 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2069 * multiple times. To be used by trustee.
2070 *
2071 * RETURNS:
2072 * Positive indicating left time if @cond is satisfied, 0 if timed
2073 * out, -1 if canceled.
2074 */
2075#define trustee_wait_event_timeout(cond, timeout) ({ \
2076 long __ret = (timeout); \
2077 while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
2078 __ret) { \
2079 spin_unlock_irq(&gcwq->lock); \
2080 __wait_event_timeout(gcwq->trustee_wait, (cond) || \
2081 (gcwq->trustee_state == TRUSTEE_RELEASE), \
2082 __ret); \
2083 spin_lock_irq(&gcwq->lock); \
2084 } \
2085 gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \
2086})
2087
2088/**
2089 * trustee_wait_event - event wait for trustee
2090 * @cond: condition to wait for
2091 *
2092 * wait_event() for trustee to use. Automatically handles locking and
2093 * checks for CANCEL request.
2094 *
2095 * CONTEXT:
2096 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2097 * multiple times. To be used by trustee.
2098 *
2099 * RETURNS:
2100 * 0 if @cond is satisfied, -1 if canceled.
2101 */
2102#define trustee_wait_event(cond) ({ \
2103 long __ret1; \
2104 __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
2105 __ret1 < 0 ? -1 : 0; \
2106})
2107
2108static int __cpuinit trustee_thread(void *__gcwq)
2109{
2110 struct global_cwq *gcwq = __gcwq;
2111 struct worker *worker;
2112 struct hlist_node *pos;
2113 int i;
2114
2115 BUG_ON(gcwq->cpu != smp_processor_id());
2116
2117 spin_lock_irq(&gcwq->lock);
2118 /*
Tejun Heo502ca9d2010-06-29 10:07:13 +02002119 * Make all workers rogue. Trustee must be bound to the
2120 * target cpu and can't be cancelled.
Tejun Heodb7bccf2010-06-29 10:07:12 +02002121 */
2122 BUG_ON(gcwq->cpu != smp_processor_id());
2123
2124 list_for_each_entry(worker, &gcwq->idle_list, entry)
Tejun Heo502ca9d2010-06-29 10:07:13 +02002125 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02002126
2127 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo502ca9d2010-06-29 10:07:13 +02002128 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02002129
2130 /*
2131 * We're now in charge. Notify and proceed to drain. We need
2132 * to keep the gcwq running during the whole CPU down
2133 * procedure as other cpu hotunplug callbacks may need to
2134 * flush currently running tasks.
2135 */
2136 gcwq->trustee_state = TRUSTEE_IN_CHARGE;
2137 wake_up_all(&gcwq->trustee_wait);
2138
2139 /*
2140 * The original cpu is in the process of dying and may go away
2141 * anytime now. When that happens, we and all workers would
2142 * be migrated to other cpus. Try draining any left work.
2143 * Note that if the gcwq is frozen, there may be frozen works
2144 * in freezeable cwqs. Don't declare completion while frozen.
2145 */
2146 while (gcwq->nr_workers != gcwq->nr_idle ||
2147 gcwq->flags & GCWQ_FREEZING ||
2148 gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
2149 /* give a breather */
2150 if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
2151 break;
2152 }
2153
2154 /* notify completion */
2155 gcwq->trustee = NULL;
2156 gcwq->trustee_state = TRUSTEE_DONE;
2157 wake_up_all(&gcwq->trustee_wait);
2158 spin_unlock_irq(&gcwq->lock);
2159 return 0;
2160}
2161
2162/**
2163 * wait_trustee_state - wait for trustee to enter the specified state
2164 * @gcwq: gcwq the trustee of interest belongs to
2165 * @state: target state to wait for
2166 *
2167 * Wait for the trustee to reach @state. DONE is already matched.
2168 *
2169 * CONTEXT:
2170 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2171 * multiple times. To be used by cpu_callback.
2172 */
2173static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
2174{
2175 if (!(gcwq->trustee_state == state ||
2176 gcwq->trustee_state == TRUSTEE_DONE)) {
2177 spin_unlock_irq(&gcwq->lock);
2178 __wait_event(gcwq->trustee_wait,
2179 gcwq->trustee_state == state ||
2180 gcwq->trustee_state == TRUSTEE_DONE);
2181 spin_lock_irq(&gcwq->lock);
2182 }
2183}
2184
Oleg Nesterov3af244332007-05-09 02:34:09 -07002185static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
2186 unsigned long action,
2187 void *hcpu)
2188{
2189 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02002190 struct global_cwq *gcwq = get_gcwq(cpu);
2191 struct task_struct *new_trustee = NULL;
2192 struct worker *worker;
2193 struct hlist_node *pos;
2194 unsigned long flags;
2195 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196
Rafael J. Wysocki8bb78442007-05-09 02:35:10 -07002197 action &= ~CPU_TASKS_FROZEN;
2198
Tejun Heodb7bccf2010-06-29 10:07:12 +02002199 switch (action) {
2200 case CPU_DOWN_PREPARE:
2201 new_trustee = kthread_create(trustee_thread, gcwq,
2202 "workqueue_trustee/%d\n", cpu);
2203 if (IS_ERR(new_trustee))
2204 return notifier_from_errno(PTR_ERR(new_trustee));
2205 kthread_bind(new_trustee, cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 }
2207
Tejun Heodb7bccf2010-06-29 10:07:12 +02002208 /* some are called w/ irq disabled, don't disturb irq status */
2209 spin_lock_irqsave(&gcwq->lock, flags);
2210
2211 switch (action) {
2212 case CPU_DOWN_PREPARE:
2213 /* initialize trustee and tell it to acquire the gcwq */
2214 BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
2215 gcwq->trustee = new_trustee;
2216 gcwq->trustee_state = TRUSTEE_START;
2217 wake_up_process(gcwq->trustee);
2218 wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
2219 break;
2220
2221 case CPU_POST_DEAD:
2222 gcwq->trustee_state = TRUSTEE_BUTCHER;
2223 break;
2224
2225 case CPU_DOWN_FAILED:
2226 case CPU_ONLINE:
2227 if (gcwq->trustee_state != TRUSTEE_DONE) {
2228 gcwq->trustee_state = TRUSTEE_RELEASE;
2229 wake_up_process(gcwq->trustee);
2230 wait_trustee_state(gcwq, TRUSTEE_DONE);
2231 }
2232
Tejun Heo502ca9d2010-06-29 10:07:13 +02002233 /* clear ROGUE from all workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +02002234 list_for_each_entry(worker, &gcwq->idle_list, entry)
Tejun Heo502ca9d2010-06-29 10:07:13 +02002235 worker->flags &= ~WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02002236
2237 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo502ca9d2010-06-29 10:07:13 +02002238 worker->flags &= ~WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02002239 break;
2240 }
2241
2242 spin_unlock_irqrestore(&gcwq->lock, flags);
2243
Tejun Heo15376632010-06-29 10:07:11 +02002244 return notifier_from_errno(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246
Rusty Russell2d3854a2008-11-05 13:39:10 +11002247#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08002248
Rusty Russell2d3854a2008-11-05 13:39:10 +11002249struct work_for_cpu {
Andrew Morton6b440032009-04-09 09:50:37 -06002250 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11002251 long (*fn)(void *);
2252 void *arg;
2253 long ret;
2254};
2255
Andrew Morton6b440032009-04-09 09:50:37 -06002256static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11002257{
Andrew Morton6b440032009-04-09 09:50:37 -06002258 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11002259 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b440032009-04-09 09:50:37 -06002260 complete(&wfc->completion);
2261 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11002262}
2263
2264/**
2265 * work_on_cpu - run a function in user context on a particular cpu
2266 * @cpu: the cpu to run on
2267 * @fn: the function to run
2268 * @arg: the function arg
2269 *
Rusty Russell31ad9082009-01-16 15:31:15 -08002270 * This will return the value @fn returns.
2271 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06002272 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11002273 */
2274long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
2275{
Andrew Morton6b440032009-04-09 09:50:37 -06002276 struct task_struct *sub_thread;
2277 struct work_for_cpu wfc = {
2278 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
2279 .fn = fn,
2280 .arg = arg,
2281 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11002282
Andrew Morton6b440032009-04-09 09:50:37 -06002283 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
2284 if (IS_ERR(sub_thread))
2285 return PTR_ERR(sub_thread);
2286 kthread_bind(sub_thread, cpu);
2287 wake_up_process(sub_thread);
2288 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11002289 return wfc.ret;
2290}
2291EXPORT_SYMBOL_GPL(work_on_cpu);
2292#endif /* CONFIG_SMP */
2293
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002294#ifdef CONFIG_FREEZER
2295
2296/**
2297 * freeze_workqueues_begin - begin freezing workqueues
2298 *
2299 * Start freezing workqueues. After this function returns, all
2300 * freezeable workqueues will queue new works to their frozen_works
2301 * list instead of the cwq ones.
2302 *
2303 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002304 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002305 */
2306void freeze_workqueues_begin(void)
2307{
2308 struct workqueue_struct *wq;
2309 unsigned int cpu;
2310
2311 spin_lock(&workqueue_lock);
2312
2313 BUG_ON(workqueue_freezing);
2314 workqueue_freezing = true;
2315
2316 for_each_possible_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002317 struct global_cwq *gcwq = get_gcwq(cpu);
2318
2319 spin_lock_irq(&gcwq->lock);
2320
Tejun Heodb7bccf2010-06-29 10:07:12 +02002321 BUG_ON(gcwq->flags & GCWQ_FREEZING);
2322 gcwq->flags |= GCWQ_FREEZING;
2323
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002324 list_for_each_entry(wq, &workqueues, list) {
2325 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2326
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002327 if (wq->flags & WQ_FREEZEABLE)
2328 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002329 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02002330
2331 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002332 }
2333
2334 spin_unlock(&workqueue_lock);
2335}
2336
2337/**
2338 * freeze_workqueues_busy - are freezeable workqueues still busy?
2339 *
2340 * Check whether freezing is complete. This function must be called
2341 * between freeze_workqueues_begin() and thaw_workqueues().
2342 *
2343 * CONTEXT:
2344 * Grabs and releases workqueue_lock.
2345 *
2346 * RETURNS:
2347 * %true if some freezeable workqueues are still busy. %false if
2348 * freezing is complete.
2349 */
2350bool freeze_workqueues_busy(void)
2351{
2352 struct workqueue_struct *wq;
2353 unsigned int cpu;
2354 bool busy = false;
2355
2356 spin_lock(&workqueue_lock);
2357
2358 BUG_ON(!workqueue_freezing);
2359
2360 for_each_possible_cpu(cpu) {
2361 /*
2362 * nr_active is monotonically decreasing. It's safe
2363 * to peek without lock.
2364 */
2365 list_for_each_entry(wq, &workqueues, list) {
2366 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2367
2368 if (!(wq->flags & WQ_FREEZEABLE))
2369 continue;
2370
2371 BUG_ON(cwq->nr_active < 0);
2372 if (cwq->nr_active) {
2373 busy = true;
2374 goto out_unlock;
2375 }
2376 }
2377 }
2378out_unlock:
2379 spin_unlock(&workqueue_lock);
2380 return busy;
2381}
2382
2383/**
2384 * thaw_workqueues - thaw workqueues
2385 *
2386 * Thaw workqueues. Normal queueing is restored and all collected
2387 * frozen works are transferred to their respective cwq worklists.
2388 *
2389 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002390 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002391 */
2392void thaw_workqueues(void)
2393{
2394 struct workqueue_struct *wq;
2395 unsigned int cpu;
2396
2397 spin_lock(&workqueue_lock);
2398
2399 if (!workqueue_freezing)
2400 goto out_unlock;
2401
2402 for_each_possible_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002403 struct global_cwq *gcwq = get_gcwq(cpu);
2404
2405 spin_lock_irq(&gcwq->lock);
2406
Tejun Heodb7bccf2010-06-29 10:07:12 +02002407 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
2408 gcwq->flags &= ~GCWQ_FREEZING;
2409
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002410 list_for_each_entry(wq, &workqueues, list) {
2411 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2412
2413 if (!(wq->flags & WQ_FREEZEABLE))
2414 continue;
2415
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002416 /* restore max_active and repopulate worklist */
2417 cwq->max_active = wq->saved_max_active;
2418
2419 while (!list_empty(&cwq->delayed_works) &&
2420 cwq->nr_active < cwq->max_active)
2421 cwq_activate_first_delayed(cwq);
2422
Tejun Heo502ca9d2010-06-29 10:07:13 +02002423 /* perform delayed unbind from single cpu if empty */
2424 if (wq->single_cpu == gcwq->cpu &&
2425 !cwq->nr_active && list_empty(&cwq->delayed_works))
2426 cwq_unbind_single_cpu(cwq);
2427
Tejun Heoc8e55f32010-06-29 10:07:12 +02002428 wake_up_process(cwq->worker->task);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002429 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02002430
2431 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002432 }
2433
2434 workqueue_freezing = false;
2435out_unlock:
2436 spin_unlock(&workqueue_lock);
2437}
2438#endif /* CONFIG_FREEZER */
2439
Oleg Nesterovc12920d2007-05-09 02:34:14 -07002440void __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441{
Tejun Heoc34056a2010-06-29 10:07:11 +02002442 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002443 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02002444
Tejun Heo7a22ad72010-06-29 10:07:13 +02002445 /*
2446 * The pointer part of work->data is either pointing to the
2447 * cwq or contains the cpu number the work ran last on. Make
2448 * sure cpu number won't overflow into kernel pointer area so
2449 * that they can be distinguished.
2450 */
2451 BUILD_BUG_ON(NR_CPUS << WORK_STRUCT_FLAG_BITS >= PAGE_OFFSET);
2452
Tejun Heodb7bccf2010-06-29 10:07:12 +02002453 hotcpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002454
2455 /* initialize gcwqs */
2456 for_each_possible_cpu(cpu) {
2457 struct global_cwq *gcwq = get_gcwq(cpu);
2458
2459 spin_lock_init(&gcwq->lock);
2460 gcwq->cpu = cpu;
2461
Tejun Heoc8e55f32010-06-29 10:07:12 +02002462 INIT_LIST_HEAD(&gcwq->idle_list);
2463 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
2464 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
2465
Tejun Heo8b03ae32010-06-29 10:07:12 +02002466 ida_init(&gcwq->worker_ida);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002467
2468 gcwq->trustee_state = TRUSTEE_DONE;
2469 init_waitqueue_head(&gcwq->trustee_wait);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002470 }
2471
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 keventd_wq = create_workqueue("events");
2473 BUG_ON(!keventd_wq);
2474}