cpu-hotplug: replace lock_cpu_hotplug() with get_online_cpus()
[linux-2.6-block.git] / kernel / workqueue.c
CommitLineData
1da177e4
LT
1/*
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>
12 * Andrew Morton <andrewm@uow.edu.au>
13 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
14 * Theodore Ts'o <tytso@mit.edu>
89ada679
CL
15 *
16 * Made to use alloc_percpu by Christoph Lameter <clameter@sgi.com>.
1da177e4
LT
17 */
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>
1fa44eca 30#include <linux/hardirq.h>
46934023 31#include <linux/mempolicy.h>
341a5958 32#include <linux/freezer.h>
d5abe669
PZ
33#include <linux/kallsyms.h>
34#include <linux/debug_locks.h>
4e6045f1 35#include <linux/lockdep.h>
1da177e4
LT
36
37/*
f756d5e2
NL
38 * The per-CPU workqueue (if single thread, we always use the first
39 * possible cpu).
1da177e4
LT
40 */
41struct cpu_workqueue_struct {
42
43 spinlock_t lock;
44
1da177e4
LT
45 struct list_head worklist;
46 wait_queue_head_t more_work;
3af24433 47 struct work_struct *current_work;
1da177e4
LT
48
49 struct workqueue_struct *wq;
36c8b586 50 struct task_struct *thread;
1da177e4
LT
51
52 int run_depth; /* Detect run_workqueue() recursion depth */
53} ____cacheline_aligned;
54
55/*
56 * The externally visible workqueue abstraction is an array of
57 * per-CPU workqueues:
58 */
59struct workqueue_struct {
89ada679 60 struct cpu_workqueue_struct *cpu_wq;
cce1a165 61 struct list_head list;
1da177e4 62 const char *name;
cce1a165 63 int singlethread;
319c2a98 64 int freezeable; /* Freeze threads during suspend */
4e6045f1
JB
65#ifdef CONFIG_LOCKDEP
66 struct lockdep_map lockdep_map;
67#endif
1da177e4
LT
68};
69
70/* All the per-cpu workqueues on the system, for hotplug cpu to add/remove
71 threads to each one as cpus come/go. */
9b41ea72 72static DEFINE_MUTEX(workqueue_mutex);
1da177e4
LT
73static LIST_HEAD(workqueues);
74
3af24433 75static int singlethread_cpu __read_mostly;
b1f4ec17 76static cpumask_t cpu_singlethread_map __read_mostly;
14441960
ON
77/*
78 * _cpu_down() first removes CPU from cpu_online_map, then CPU_DEAD
79 * flushes cwq->worklist. This means that flush_workqueue/wait_on_work
80 * which comes in between can't use for_each_online_cpu(). We could
81 * use cpu_possible_map, the cpumask below is more a documentation
82 * than optimization.
83 */
3af24433 84static cpumask_t cpu_populated_map __read_mostly;
f756d5e2 85
1da177e4
LT
86/* If it's single threaded, it isn't in the list of workqueues. */
87static inline int is_single_threaded(struct workqueue_struct *wq)
88{
cce1a165 89 return wq->singlethread;
1da177e4
LT
90}
91
b1f4ec17
ON
92static const cpumask_t *wq_cpu_map(struct workqueue_struct *wq)
93{
94 return is_single_threaded(wq)
95 ? &cpu_singlethread_map : &cpu_populated_map;
96}
97
a848e3b6
ON
98static
99struct cpu_workqueue_struct *wq_per_cpu(struct workqueue_struct *wq, int cpu)
100{
101 if (unlikely(is_single_threaded(wq)))
102 cpu = singlethread_cpu;
103 return per_cpu_ptr(wq->cpu_wq, cpu);
104}
105
4594bf15
DH
106/*
107 * Set the workqueue on which a work item is to be run
108 * - Must *only* be called if the pending flag is set
109 */
ed7c0fee
ON
110static inline void set_wq_data(struct work_struct *work,
111 struct cpu_workqueue_struct *cwq)
365970a1 112{
4594bf15
DH
113 unsigned long new;
114
115 BUG_ON(!work_pending(work));
365970a1 116
ed7c0fee 117 new = (unsigned long) cwq | (1UL << WORK_STRUCT_PENDING);
a08727ba
LT
118 new |= WORK_STRUCT_FLAG_MASK & *work_data_bits(work);
119 atomic_long_set(&work->data, new);
365970a1
DH
120}
121
ed7c0fee
ON
122static inline
123struct cpu_workqueue_struct *get_wq_data(struct work_struct *work)
365970a1 124{
a08727ba 125 return (void *) (atomic_long_read(&work->data) & WORK_STRUCT_WQ_DATA_MASK);
365970a1
DH
126}
127
b89deed3
ON
128static void insert_work(struct cpu_workqueue_struct *cwq,
129 struct work_struct *work, int tail)
130{
131 set_wq_data(work, cwq);
6e84d644
ON
132 /*
133 * Ensure that we get the right work->data if we see the
134 * result of list_add() below, see try_to_grab_pending().
135 */
136 smp_wmb();
b89deed3
ON
137 if (tail)
138 list_add_tail(&work->entry, &cwq->worklist);
139 else
140 list_add(&work->entry, &cwq->worklist);
141 wake_up(&cwq->more_work);
142}
143
1da177e4
LT
144/* Preempt must be disabled. */
145static void __queue_work(struct cpu_workqueue_struct *cwq,
146 struct work_struct *work)
147{
148 unsigned long flags;
149
150 spin_lock_irqsave(&cwq->lock, flags);
b89deed3 151 insert_work(cwq, work, 1);
1da177e4
LT
152 spin_unlock_irqrestore(&cwq->lock, flags);
153}
154
0fcb78c2
REB
155/**
156 * queue_work - queue work on a workqueue
157 * @wq: workqueue to use
158 * @work: work to queue
159 *
057647fc 160 * Returns 0 if @work was already on a queue, non-zero otherwise.
1da177e4
LT
161 *
162 * We queue the work to the CPU it was submitted, but there is no
163 * guarantee that it will be processed by that CPU.
164 */
165int fastcall queue_work(struct workqueue_struct *wq, struct work_struct *work)
166{
a848e3b6 167 int ret = 0;
1da177e4 168
a08727ba 169 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work))) {
1da177e4 170 BUG_ON(!list_empty(&work->entry));
a848e3b6
ON
171 __queue_work(wq_per_cpu(wq, get_cpu()), work);
172 put_cpu();
1da177e4
LT
173 ret = 1;
174 }
1da177e4
LT
175 return ret;
176}
ae90dd5d 177EXPORT_SYMBOL_GPL(queue_work);
1da177e4 178
82f67cd9 179void delayed_work_timer_fn(unsigned long __data)
1da177e4 180{
52bad64d 181 struct delayed_work *dwork = (struct delayed_work *)__data;
ed7c0fee
ON
182 struct cpu_workqueue_struct *cwq = get_wq_data(&dwork->work);
183 struct workqueue_struct *wq = cwq->wq;
1da177e4 184
a848e3b6 185 __queue_work(wq_per_cpu(wq, smp_processor_id()), &dwork->work);
1da177e4
LT
186}
187
0fcb78c2
REB
188/**
189 * queue_delayed_work - queue work on a workqueue after delay
190 * @wq: workqueue to use
af9997e4 191 * @dwork: delayable work to queue
0fcb78c2
REB
192 * @delay: number of jiffies to wait before queueing
193 *
057647fc 194 * Returns 0 if @work was already on a queue, non-zero otherwise.
0fcb78c2 195 */
1da177e4 196int fastcall queue_delayed_work(struct workqueue_struct *wq,
52bad64d 197 struct delayed_work *dwork, unsigned long delay)
1da177e4 198{
63bc0362 199 timer_stats_timer_set_start_info(&dwork->timer);
52bad64d 200 if (delay == 0)
63bc0362 201 return queue_work(wq, &dwork->work);
1da177e4 202
63bc0362 203 return queue_delayed_work_on(-1, wq, dwork, delay);
1da177e4 204}
ae90dd5d 205EXPORT_SYMBOL_GPL(queue_delayed_work);
1da177e4 206
0fcb78c2
REB
207/**
208 * queue_delayed_work_on - queue work on specific CPU after delay
209 * @cpu: CPU number to execute work on
210 * @wq: workqueue to use
af9997e4 211 * @dwork: work to queue
0fcb78c2
REB
212 * @delay: number of jiffies to wait before queueing
213 *
057647fc 214 * Returns 0 if @work was already on a queue, non-zero otherwise.
0fcb78c2 215 */
7a6bc1cd 216int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
52bad64d 217 struct delayed_work *dwork, unsigned long delay)
7a6bc1cd
VP
218{
219 int ret = 0;
52bad64d
DH
220 struct timer_list *timer = &dwork->timer;
221 struct work_struct *work = &dwork->work;
7a6bc1cd 222
a08727ba 223 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work))) {
7a6bc1cd
VP
224 BUG_ON(timer_pending(timer));
225 BUG_ON(!list_empty(&work->entry));
226
ed7c0fee 227 /* This stores cwq for the moment, for the timer_fn */
a848e3b6 228 set_wq_data(work, wq_per_cpu(wq, raw_smp_processor_id()));
7a6bc1cd 229 timer->expires = jiffies + delay;
52bad64d 230 timer->data = (unsigned long)dwork;
7a6bc1cd 231 timer->function = delayed_work_timer_fn;
63bc0362
ON
232
233 if (unlikely(cpu >= 0))
234 add_timer_on(timer, cpu);
235 else
236 add_timer(timer);
7a6bc1cd
VP
237 ret = 1;
238 }
239 return ret;
240}
ae90dd5d 241EXPORT_SYMBOL_GPL(queue_delayed_work_on);
1da177e4 242
858119e1 243static void run_workqueue(struct cpu_workqueue_struct *cwq)
1da177e4 244{
f293ea92 245 spin_lock_irq(&cwq->lock);
1da177e4
LT
246 cwq->run_depth++;
247 if (cwq->run_depth > 3) {
248 /* morton gets to eat his hat */
249 printk("%s: recursion depth exceeded: %d\n",
250 __FUNCTION__, cwq->run_depth);
251 dump_stack();
252 }
253 while (!list_empty(&cwq->worklist)) {
254 struct work_struct *work = list_entry(cwq->worklist.next,
255 struct work_struct, entry);
6bb49e59 256 work_func_t f = work->func;
4e6045f1
JB
257#ifdef CONFIG_LOCKDEP
258 /*
259 * It is permissible to free the struct work_struct
260 * from inside the function that is called from it,
261 * this we need to take into account for lockdep too.
262 * To avoid bogus "held lock freed" warnings as well
263 * as problems when looking into work->lockdep_map,
264 * make a copy and use that here.
265 */
266 struct lockdep_map lockdep_map = work->lockdep_map;
267#endif
1da177e4 268
b89deed3 269 cwq->current_work = work;
1da177e4 270 list_del_init(cwq->worklist.next);
f293ea92 271 spin_unlock_irq(&cwq->lock);
1da177e4 272
365970a1 273 BUG_ON(get_wq_data(work) != cwq);
23b2e599 274 work_clear_pending(work);
4e6045f1
JB
275 lock_acquire(&cwq->wq->lockdep_map, 0, 0, 0, 2, _THIS_IP_);
276 lock_acquire(&lockdep_map, 0, 0, 0, 2, _THIS_IP_);
65f27f38 277 f(work);
4e6045f1
JB
278 lock_release(&lockdep_map, 1, _THIS_IP_);
279 lock_release(&cwq->wq->lockdep_map, 1, _THIS_IP_);
1da177e4 280
d5abe669
PZ
281 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
282 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
283 "%s/0x%08x/%d\n",
284 current->comm, preempt_count(),
ba25f9dc 285 task_pid_nr(current));
d5abe669
PZ
286 printk(KERN_ERR " last function: ");
287 print_symbol("%s\n", (unsigned long)f);
288 debug_show_held_locks(current);
289 dump_stack();
290 }
291
f293ea92 292 spin_lock_irq(&cwq->lock);
b89deed3 293 cwq->current_work = NULL;
1da177e4
LT
294 }
295 cwq->run_depth--;
f293ea92 296 spin_unlock_irq(&cwq->lock);
1da177e4
LT
297}
298
299static int worker_thread(void *__cwq)
300{
301 struct cpu_workqueue_struct *cwq = __cwq;
3af24433 302 DEFINE_WAIT(wait);
1da177e4 303
83144186
RW
304 if (cwq->wq->freezeable)
305 set_freezable();
1da177e4
LT
306
307 set_user_nice(current, -5);
1da177e4 308
3af24433 309 for (;;) {
3af24433 310 prepare_to_wait(&cwq->more_work, &wait, TASK_INTERRUPTIBLE);
14441960
ON
311 if (!freezing(current) &&
312 !kthread_should_stop() &&
313 list_empty(&cwq->worklist))
1da177e4 314 schedule();
3af24433
ON
315 finish_wait(&cwq->more_work, &wait);
316
85f4186a
ON
317 try_to_freeze();
318
14441960 319 if (kthread_should_stop())
3af24433 320 break;
1da177e4 321
3af24433 322 run_workqueue(cwq);
1da177e4 323 }
3af24433 324
1da177e4
LT
325 return 0;
326}
327
fc2e4d70
ON
328struct wq_barrier {
329 struct work_struct work;
330 struct completion done;
331};
332
333static void wq_barrier_func(struct work_struct *work)
334{
335 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
336 complete(&barr->done);
337}
338
83c22520
ON
339static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
340 struct wq_barrier *barr, int tail)
fc2e4d70
ON
341{
342 INIT_WORK(&barr->work, wq_barrier_func);
343 __set_bit(WORK_STRUCT_PENDING, work_data_bits(&barr->work));
344
345 init_completion(&barr->done);
83c22520
ON
346
347 insert_work(cwq, &barr->work, tail);
fc2e4d70
ON
348}
349
14441960 350static int flush_cpu_workqueue(struct cpu_workqueue_struct *cwq)
1da177e4 351{
14441960
ON
352 int active;
353
1da177e4
LT
354 if (cwq->thread == current) {
355 /*
356 * Probably keventd trying to flush its own queue. So simply run
357 * it by hand rather than deadlocking.
358 */
359 run_workqueue(cwq);
14441960 360 active = 1;
1da177e4 361 } else {
fc2e4d70 362 struct wq_barrier barr;
1da177e4 363
14441960 364 active = 0;
83c22520
ON
365 spin_lock_irq(&cwq->lock);
366 if (!list_empty(&cwq->worklist) || cwq->current_work != NULL) {
367 insert_wq_barrier(cwq, &barr, 1);
368 active = 1;
369 }
370 spin_unlock_irq(&cwq->lock);
1da177e4 371
d721304d 372 if (active)
83c22520 373 wait_for_completion(&barr.done);
1da177e4 374 }
14441960
ON
375
376 return active;
1da177e4
LT
377}
378
0fcb78c2 379/**
1da177e4 380 * flush_workqueue - ensure that any scheduled work has run to completion.
0fcb78c2 381 * @wq: workqueue to flush
1da177e4
LT
382 *
383 * Forces execution of the workqueue and blocks until its completion.
384 * This is typically used in driver shutdown handlers.
385 *
fc2e4d70
ON
386 * We sleep until all works which were queued on entry have been handled,
387 * but we are not livelocked by new incoming ones.
1da177e4
LT
388 *
389 * This function used to run the workqueues itself. Now we just wait for the
390 * helper threads to do it.
391 */
392void fastcall flush_workqueue(struct workqueue_struct *wq)
393{
b1f4ec17 394 const cpumask_t *cpu_map = wq_cpu_map(wq);
cce1a165 395 int cpu;
1da177e4 396
b1f4ec17 397 might_sleep();
4e6045f1
JB
398 lock_acquire(&wq->lockdep_map, 0, 0, 0, 2, _THIS_IP_);
399 lock_release(&wq->lockdep_map, 1, _THIS_IP_);
b1f4ec17
ON
400 for_each_cpu_mask(cpu, *cpu_map)
401 flush_cpu_workqueue(per_cpu_ptr(wq->cpu_wq, cpu));
1da177e4 402}
ae90dd5d 403EXPORT_SYMBOL_GPL(flush_workqueue);
1da177e4 404
6e84d644 405/*
1f1f642e 406 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
6e84d644
ON
407 * so this work can't be re-armed in any way.
408 */
409static int try_to_grab_pending(struct work_struct *work)
410{
411 struct cpu_workqueue_struct *cwq;
1f1f642e 412 int ret = -1;
6e84d644
ON
413
414 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work)))
1f1f642e 415 return 0;
6e84d644
ON
416
417 /*
418 * The queueing is in progress, or it is already queued. Try to
419 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
420 */
421
422 cwq = get_wq_data(work);
423 if (!cwq)
424 return ret;
425
426 spin_lock_irq(&cwq->lock);
427 if (!list_empty(&work->entry)) {
428 /*
429 * This work is queued, but perhaps we locked the wrong cwq.
430 * In that case we must see the new value after rmb(), see
431 * insert_work()->wmb().
432 */
433 smp_rmb();
434 if (cwq == get_wq_data(work)) {
435 list_del_init(&work->entry);
436 ret = 1;
437 }
438 }
439 spin_unlock_irq(&cwq->lock);
440
441 return ret;
442}
443
444static void wait_on_cpu_work(struct cpu_workqueue_struct *cwq,
b89deed3
ON
445 struct work_struct *work)
446{
447 struct wq_barrier barr;
448 int running = 0;
449
450 spin_lock_irq(&cwq->lock);
451 if (unlikely(cwq->current_work == work)) {
83c22520 452 insert_wq_barrier(cwq, &barr, 0);
b89deed3
ON
453 running = 1;
454 }
455 spin_unlock_irq(&cwq->lock);
456
3af24433 457 if (unlikely(running))
b89deed3 458 wait_for_completion(&barr.done);
b89deed3
ON
459}
460
6e84d644 461static void wait_on_work(struct work_struct *work)
b89deed3
ON
462{
463 struct cpu_workqueue_struct *cwq;
28e53bdd
ON
464 struct workqueue_struct *wq;
465 const cpumask_t *cpu_map;
b1f4ec17 466 int cpu;
b89deed3 467
f293ea92
ON
468 might_sleep();
469
4e6045f1
JB
470 lock_acquire(&work->lockdep_map, 0, 0, 0, 2, _THIS_IP_);
471 lock_release(&work->lockdep_map, 1, _THIS_IP_);
472
b89deed3 473 cwq = get_wq_data(work);
b89deed3 474 if (!cwq)
3af24433 475 return;
b89deed3 476
28e53bdd
ON
477 wq = cwq->wq;
478 cpu_map = wq_cpu_map(wq);
479
b1f4ec17 480 for_each_cpu_mask(cpu, *cpu_map)
6e84d644
ON
481 wait_on_cpu_work(per_cpu_ptr(wq->cpu_wq, cpu), work);
482}
483
1f1f642e
ON
484static int __cancel_work_timer(struct work_struct *work,
485 struct timer_list* timer)
486{
487 int ret;
488
489 do {
490 ret = (timer && likely(del_timer(timer)));
491 if (!ret)
492 ret = try_to_grab_pending(work);
493 wait_on_work(work);
494 } while (unlikely(ret < 0));
495
496 work_clear_pending(work);
497 return ret;
498}
499
6e84d644
ON
500/**
501 * cancel_work_sync - block until a work_struct's callback has terminated
502 * @work: the work which is to be flushed
503 *
1f1f642e
ON
504 * Returns true if @work was pending.
505 *
6e84d644
ON
506 * cancel_work_sync() will cancel the work if it is queued. If the work's
507 * callback appears to be running, cancel_work_sync() will block until it
508 * has completed.
509 *
510 * It is possible to use this function if the work re-queues itself. It can
511 * cancel the work even if it migrates to another workqueue, however in that
512 * case it only guarantees that work->func() has completed on the last queued
513 * workqueue.
514 *
515 * cancel_work_sync(&delayed_work->work) should be used only if ->timer is not
516 * pending, otherwise it goes into a busy-wait loop until the timer expires.
517 *
518 * The caller must ensure that workqueue_struct on which this work was last
519 * queued can't be destroyed before this function returns.
520 */
1f1f642e 521int cancel_work_sync(struct work_struct *work)
6e84d644 522{
1f1f642e 523 return __cancel_work_timer(work, NULL);
b89deed3 524}
28e53bdd 525EXPORT_SYMBOL_GPL(cancel_work_sync);
b89deed3 526
6e84d644 527/**
f5a421a4 528 * cancel_delayed_work_sync - reliably kill off a delayed work.
6e84d644
ON
529 * @dwork: the delayed work struct
530 *
1f1f642e
ON
531 * Returns true if @dwork was pending.
532 *
6e84d644
ON
533 * It is possible to use this function if @dwork rearms itself via queue_work()
534 * or queue_delayed_work(). See also the comment for cancel_work_sync().
535 */
1f1f642e 536int cancel_delayed_work_sync(struct delayed_work *dwork)
6e84d644 537{
1f1f642e 538 return __cancel_work_timer(&dwork->work, &dwork->timer);
6e84d644 539}
f5a421a4 540EXPORT_SYMBOL(cancel_delayed_work_sync);
1da177e4 541
6e84d644 542static struct workqueue_struct *keventd_wq __read_mostly;
1da177e4 543
0fcb78c2
REB
544/**
545 * schedule_work - put work task in global workqueue
546 * @work: job to be done
547 *
548 * This puts a job in the kernel-global workqueue.
549 */
1da177e4
LT
550int fastcall schedule_work(struct work_struct *work)
551{
552 return queue_work(keventd_wq, work);
553}
ae90dd5d 554EXPORT_SYMBOL(schedule_work);
1da177e4 555
0fcb78c2
REB
556/**
557 * schedule_delayed_work - put work task in global workqueue after delay
52bad64d
DH
558 * @dwork: job to be done
559 * @delay: number of jiffies to wait or 0 for immediate execution
0fcb78c2
REB
560 *
561 * After waiting for a given time this puts a job in the kernel-global
562 * workqueue.
563 */
82f67cd9
IM
564int fastcall schedule_delayed_work(struct delayed_work *dwork,
565 unsigned long delay)
1da177e4 566{
82f67cd9 567 timer_stats_timer_set_start_info(&dwork->timer);
52bad64d 568 return queue_delayed_work(keventd_wq, dwork, delay);
1da177e4 569}
ae90dd5d 570EXPORT_SYMBOL(schedule_delayed_work);
1da177e4 571
0fcb78c2
REB
572/**
573 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
574 * @cpu: cpu to use
52bad64d 575 * @dwork: job to be done
0fcb78c2
REB
576 * @delay: number of jiffies to wait
577 *
578 * After waiting for a given time this puts a job in the kernel-global
579 * workqueue on the specified CPU.
580 */
1da177e4 581int schedule_delayed_work_on(int cpu,
52bad64d 582 struct delayed_work *dwork, unsigned long delay)
1da177e4 583{
52bad64d 584 return queue_delayed_work_on(cpu, keventd_wq, dwork, delay);
1da177e4 585}
ae90dd5d 586EXPORT_SYMBOL(schedule_delayed_work_on);
1da177e4 587
b6136773
AM
588/**
589 * schedule_on_each_cpu - call a function on each online CPU from keventd
590 * @func: the function to call
b6136773
AM
591 *
592 * Returns zero on success.
593 * Returns -ve errno on failure.
594 *
595 * Appears to be racy against CPU hotplug.
596 *
597 * schedule_on_each_cpu() is very slow.
598 */
65f27f38 599int schedule_on_each_cpu(work_func_t func)
15316ba8
CL
600{
601 int cpu;
b6136773 602 struct work_struct *works;
15316ba8 603
b6136773
AM
604 works = alloc_percpu(struct work_struct);
605 if (!works)
15316ba8 606 return -ENOMEM;
b6136773 607
e18f3ffb 608 preempt_disable(); /* CPU hotplug */
15316ba8 609 for_each_online_cpu(cpu) {
9bfb1839
IM
610 struct work_struct *work = per_cpu_ptr(works, cpu);
611
612 INIT_WORK(work, func);
613 set_bit(WORK_STRUCT_PENDING, work_data_bits(work));
614 __queue_work(per_cpu_ptr(keventd_wq->cpu_wq, cpu), work);
15316ba8 615 }
e18f3ffb 616 preempt_enable();
15316ba8 617 flush_workqueue(keventd_wq);
b6136773 618 free_percpu(works);
15316ba8
CL
619 return 0;
620}
621
1da177e4
LT
622void flush_scheduled_work(void)
623{
624 flush_workqueue(keventd_wq);
625}
ae90dd5d 626EXPORT_SYMBOL(flush_scheduled_work);
1da177e4 627
1fa44eca
JB
628/**
629 * execute_in_process_context - reliably execute the routine with user context
630 * @fn: the function to execute
1fa44eca
JB
631 * @ew: guaranteed storage for the execute work structure (must
632 * be available when the work executes)
633 *
634 * Executes the function immediately if process context is available,
635 * otherwise schedules the function for delayed execution.
636 *
637 * Returns: 0 - function was executed
638 * 1 - function was scheduled for execution
639 */
65f27f38 640int execute_in_process_context(work_func_t fn, struct execute_work *ew)
1fa44eca
JB
641{
642 if (!in_interrupt()) {
65f27f38 643 fn(&ew->work);
1fa44eca
JB
644 return 0;
645 }
646
65f27f38 647 INIT_WORK(&ew->work, fn);
1fa44eca
JB
648 schedule_work(&ew->work);
649
650 return 1;
651}
652EXPORT_SYMBOL_GPL(execute_in_process_context);
653
1da177e4
LT
654int keventd_up(void)
655{
656 return keventd_wq != NULL;
657}
658
659int current_is_keventd(void)
660{
661 struct cpu_workqueue_struct *cwq;
d243769d 662 int cpu = raw_smp_processor_id(); /* preempt-safe: keventd is per-cpu */
1da177e4
LT
663 int ret = 0;
664
665 BUG_ON(!keventd_wq);
666
89ada679 667 cwq = per_cpu_ptr(keventd_wq->cpu_wq, cpu);
1da177e4
LT
668 if (current == cwq->thread)
669 ret = 1;
670
671 return ret;
672
673}
674
3af24433
ON
675static struct cpu_workqueue_struct *
676init_cpu_workqueue(struct workqueue_struct *wq, int cpu)
1da177e4 677{
89ada679 678 struct cpu_workqueue_struct *cwq = per_cpu_ptr(wq->cpu_wq, cpu);
1da177e4 679
3af24433
ON
680 cwq->wq = wq;
681 spin_lock_init(&cwq->lock);
682 INIT_LIST_HEAD(&cwq->worklist);
683 init_waitqueue_head(&cwq->more_work);
684
685 return cwq;
1da177e4
LT
686}
687
3af24433
ON
688static int create_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
689{
690 struct workqueue_struct *wq = cwq->wq;
691 const char *fmt = is_single_threaded(wq) ? "%s" : "%s/%d";
692 struct task_struct *p;
693
694 p = kthread_create(worker_thread, cwq, fmt, wq->name, cpu);
695 /*
696 * Nobody can add the work_struct to this cwq,
697 * if (caller is __create_workqueue)
698 * nobody should see this wq
699 * else // caller is CPU_UP_PREPARE
700 * cpu is not on cpu_online_map
701 * so we can abort safely.
702 */
703 if (IS_ERR(p))
704 return PTR_ERR(p);
705
706 cwq->thread = p;
3af24433
ON
707
708 return 0;
709}
710
06ba38a9
ON
711static void start_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
712{
713 struct task_struct *p = cwq->thread;
714
715 if (p != NULL) {
716 if (cpu >= 0)
717 kthread_bind(p, cpu);
718 wake_up_process(p);
719 }
720}
721
4e6045f1
JB
722struct workqueue_struct *__create_workqueue_key(const char *name,
723 int singlethread,
724 int freezeable,
eb13ba87
JB
725 struct lock_class_key *key,
726 const char *lock_name)
1da177e4 727{
1da177e4 728 struct workqueue_struct *wq;
3af24433
ON
729 struct cpu_workqueue_struct *cwq;
730 int err = 0, cpu;
1da177e4 731
3af24433
ON
732 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
733 if (!wq)
734 return NULL;
735
736 wq->cpu_wq = alloc_percpu(struct cpu_workqueue_struct);
737 if (!wq->cpu_wq) {
738 kfree(wq);
739 return NULL;
740 }
741
742 wq->name = name;
eb13ba87 743 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
cce1a165 744 wq->singlethread = singlethread;
3af24433 745 wq->freezeable = freezeable;
cce1a165 746 INIT_LIST_HEAD(&wq->list);
3af24433
ON
747
748 if (singlethread) {
3af24433
ON
749 cwq = init_cpu_workqueue(wq, singlethread_cpu);
750 err = create_workqueue_thread(cwq, singlethread_cpu);
06ba38a9 751 start_workqueue_thread(cwq, -1);
3af24433 752 } else {
9b41ea72 753 mutex_lock(&workqueue_mutex);
3af24433
ON
754 list_add(&wq->list, &workqueues);
755
756 for_each_possible_cpu(cpu) {
757 cwq = init_cpu_workqueue(wq, cpu);
758 if (err || !cpu_online(cpu))
759 continue;
760 err = create_workqueue_thread(cwq, cpu);
06ba38a9 761 start_workqueue_thread(cwq, cpu);
1da177e4 762 }
3af24433
ON
763 mutex_unlock(&workqueue_mutex);
764 }
765
766 if (err) {
767 destroy_workqueue(wq);
768 wq = NULL;
769 }
770 return wq;
771}
4e6045f1 772EXPORT_SYMBOL_GPL(__create_workqueue_key);
1da177e4 773
3af24433
ON
774static void cleanup_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
775{
14441960
ON
776 /*
777 * Our caller is either destroy_workqueue() or CPU_DEAD,
778 * workqueue_mutex protects cwq->thread
779 */
780 if (cwq->thread == NULL)
781 return;
3af24433 782
4e6045f1
JB
783 lock_acquire(&cwq->wq->lockdep_map, 0, 0, 0, 2, _THIS_IP_);
784 lock_release(&cwq->wq->lockdep_map, 1, _THIS_IP_);
785
13c22168 786 flush_cpu_workqueue(cwq);
14441960 787 /*
13c22168
ON
788 * If the caller is CPU_DEAD and cwq->worklist was not empty,
789 * a concurrent flush_workqueue() can insert a barrier after us.
790 * However, in that case run_workqueue() won't return and check
791 * kthread_should_stop() until it flushes all work_struct's.
14441960
ON
792 * When ->worklist becomes empty it is safe to exit because no
793 * more work_structs can be queued on this cwq: flush_workqueue
794 * checks list_empty(), and a "normal" queue_work() can't use
795 * a dead CPU.
796 */
14441960
ON
797 kthread_stop(cwq->thread);
798 cwq->thread = NULL;
3af24433
ON
799}
800
801/**
802 * destroy_workqueue - safely terminate a workqueue
803 * @wq: target workqueue
804 *
805 * Safely destroy a workqueue. All work currently pending will be done first.
806 */
807void destroy_workqueue(struct workqueue_struct *wq)
808{
b1f4ec17 809 const cpumask_t *cpu_map = wq_cpu_map(wq);
3af24433 810 struct cpu_workqueue_struct *cwq;
b1f4ec17 811 int cpu;
3af24433 812
b1f4ec17
ON
813 mutex_lock(&workqueue_mutex);
814 list_del(&wq->list);
815 mutex_unlock(&workqueue_mutex);
3af24433 816
b1f4ec17
ON
817 for_each_cpu_mask(cpu, *cpu_map) {
818 cwq = per_cpu_ptr(wq->cpu_wq, cpu);
819 cleanup_workqueue_thread(cwq, cpu);
3af24433 820 }
9b41ea72 821
3af24433
ON
822 free_percpu(wq->cpu_wq);
823 kfree(wq);
824}
825EXPORT_SYMBOL_GPL(destroy_workqueue);
826
827static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
828 unsigned long action,
829 void *hcpu)
830{
831 unsigned int cpu = (unsigned long)hcpu;
832 struct cpu_workqueue_struct *cwq;
833 struct workqueue_struct *wq;
834
8bb78442
RW
835 action &= ~CPU_TASKS_FROZEN;
836
3af24433
ON
837 switch (action) {
838 case CPU_LOCK_ACQUIRE:
9b41ea72 839 mutex_lock(&workqueue_mutex);
3af24433 840 return NOTIFY_OK;
9b41ea72 841
3af24433 842 case CPU_LOCK_RELEASE:
9b41ea72 843 mutex_unlock(&workqueue_mutex);
3af24433 844 return NOTIFY_OK;
1da177e4 845
3af24433
ON
846 case CPU_UP_PREPARE:
847 cpu_set(cpu, cpu_populated_map);
848 }
849
850 list_for_each_entry(wq, &workqueues, list) {
851 cwq = per_cpu_ptr(wq->cpu_wq, cpu);
852
853 switch (action) {
854 case CPU_UP_PREPARE:
855 if (!create_workqueue_thread(cwq, cpu))
856 break;
857 printk(KERN_ERR "workqueue for %i failed\n", cpu);
858 return NOTIFY_BAD;
859
860 case CPU_ONLINE:
06ba38a9 861 start_workqueue_thread(cwq, cpu);
3af24433
ON
862 break;
863
864 case CPU_UP_CANCELED:
06ba38a9 865 start_workqueue_thread(cwq, -1);
3af24433
ON
866 case CPU_DEAD:
867 cleanup_workqueue_thread(cwq, cpu);
868 break;
869 }
1da177e4
LT
870 }
871
872 return NOTIFY_OK;
873}
1da177e4 874
c12920d1 875void __init init_workqueues(void)
1da177e4 876{
3af24433 877 cpu_populated_map = cpu_online_map;
f756d5e2 878 singlethread_cpu = first_cpu(cpu_possible_map);
b1f4ec17 879 cpu_singlethread_map = cpumask_of_cpu(singlethread_cpu);
1da177e4
LT
880 hotcpu_notifier(workqueue_cpu_callback, 0);
881 keventd_wq = create_workqueue("events");
882 BUG_ON(!keventd_wq);
883}