Merge branch 'perfcounters-fixes-for-linus' of git://git.kernel.org/pub/scm/linux...
[linux-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>
e1f8e874 12 * Andrew Morton
1da177e4
LT
13 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
14 * Theodore Ts'o <tytso@mit.edu>
89ada679 15 *
cde53535 16 * Made to use alloc_percpu by Christoph Lameter.
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>
fb39125f
Z
36#define CREATE_TRACE_POINTS
37#include <trace/events/workqueue.h>
1da177e4
LT
38
39/*
f756d5e2
NL
40 * The per-CPU workqueue (if single thread, we always use the first
41 * possible cpu).
1da177e4
LT
42 */
43struct cpu_workqueue_struct {
44
45 spinlock_t lock;
46
1da177e4
LT
47 struct list_head worklist;
48 wait_queue_head_t more_work;
3af24433 49 struct work_struct *current_work;
1da177e4
LT
50
51 struct workqueue_struct *wq;
36c8b586 52 struct task_struct *thread;
1da177e4
LT
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 */
0d557dc9 65 int rt;
4e6045f1
JB
66#ifdef CONFIG_LOCKDEP
67 struct lockdep_map lockdep_map;
68#endif
1da177e4
LT
69};
70
95402b38
GS
71/* Serializes the accesses to the list of workqueues. */
72static DEFINE_SPINLOCK(workqueue_lock);
1da177e4
LT
73static LIST_HEAD(workqueues);
74
3af24433 75static int singlethread_cpu __read_mostly;
e7577c50 76static const struct cpumask *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 */
e7577c50 84static cpumask_var_t cpu_populated_map __read_mostly;
f756d5e2 85
1da177e4 86/* If it's single threaded, it isn't in the list of workqueues. */
6cc88bc4 87static inline int is_wq_single_threaded(struct workqueue_struct *wq)
1da177e4 88{
cce1a165 89 return wq->singlethread;
1da177e4
LT
90}
91
e7577c50 92static const struct cpumask *wq_cpu_map(struct workqueue_struct *wq)
b1f4ec17 93{
6cc88bc4 94 return is_wq_single_threaded(wq)
e7577c50 95 ? cpu_singlethread_map : cpu_populated_map;
b1f4ec17
ON
96}
97
a848e3b6
ON
98static
99struct cpu_workqueue_struct *wq_per_cpu(struct workqueue_struct *wq, int cpu)
100{
6cc88bc4 101 if (unlikely(is_wq_single_threaded(wq)))
a848e3b6
ON
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 128static void insert_work(struct cpu_workqueue_struct *cwq,
1a4d9b0a 129 struct work_struct *work, struct list_head *head)
b89deed3 130{
e1d8aa9f
FW
131 trace_workqueue_insertion(cwq->thread, work);
132
b89deed3 133 set_wq_data(work, cwq);
6e84d644
ON
134 /*
135 * Ensure that we get the right work->data if we see the
136 * result of list_add() below, see try_to_grab_pending().
137 */
138 smp_wmb();
1a4d9b0a 139 list_add_tail(&work->entry, head);
b89deed3
ON
140 wake_up(&cwq->more_work);
141}
142
1da177e4
LT
143static void __queue_work(struct cpu_workqueue_struct *cwq,
144 struct work_struct *work)
145{
146 unsigned long flags;
147
148 spin_lock_irqsave(&cwq->lock, flags);
1a4d9b0a 149 insert_work(cwq, work, &cwq->worklist);
1da177e4
LT
150 spin_unlock_irqrestore(&cwq->lock, flags);
151}
152
0fcb78c2
REB
153/**
154 * queue_work - queue work on a workqueue
155 * @wq: workqueue to use
156 * @work: work to queue
157 *
057647fc 158 * Returns 0 if @work was already on a queue, non-zero otherwise.
1da177e4 159 *
00dfcaf7
ON
160 * We queue the work to the CPU on which it was submitted, but if the CPU dies
161 * it can be processed by another CPU.
1da177e4 162 */
7ad5b3a5 163int queue_work(struct workqueue_struct *wq, struct work_struct *work)
1da177e4 164{
ef1ca236
ON
165 int ret;
166
167 ret = queue_work_on(get_cpu(), wq, work);
168 put_cpu();
169
1da177e4
LT
170 return ret;
171}
ae90dd5d 172EXPORT_SYMBOL_GPL(queue_work);
1da177e4 173
c1a220e7
ZR
174/**
175 * queue_work_on - queue work on specific cpu
176 * @cpu: CPU number to execute work on
177 * @wq: workqueue to use
178 * @work: work to queue
179 *
180 * Returns 0 if @work was already on a queue, non-zero otherwise.
181 *
182 * We queue the work to a specific CPU, the caller must ensure it
183 * can't go away.
184 */
185int
186queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
187{
188 int ret = 0;
189
190 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work))) {
191 BUG_ON(!list_empty(&work->entry));
192 __queue_work(wq_per_cpu(wq, cpu), work);
193 ret = 1;
194 }
195 return ret;
196}
197EXPORT_SYMBOL_GPL(queue_work_on);
198
6d141c3f 199static void delayed_work_timer_fn(unsigned long __data)
1da177e4 200{
52bad64d 201 struct delayed_work *dwork = (struct delayed_work *)__data;
ed7c0fee
ON
202 struct cpu_workqueue_struct *cwq = get_wq_data(&dwork->work);
203 struct workqueue_struct *wq = cwq->wq;
1da177e4 204
a848e3b6 205 __queue_work(wq_per_cpu(wq, smp_processor_id()), &dwork->work);
1da177e4
LT
206}
207
0fcb78c2
REB
208/**
209 * queue_delayed_work - queue work on a workqueue after delay
210 * @wq: workqueue to use
af9997e4 211 * @dwork: delayable 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 */
7ad5b3a5 216int queue_delayed_work(struct workqueue_struct *wq,
52bad64d 217 struct delayed_work *dwork, unsigned long delay)
1da177e4 218{
52bad64d 219 if (delay == 0)
63bc0362 220 return queue_work(wq, &dwork->work);
1da177e4 221
63bc0362 222 return queue_delayed_work_on(-1, wq, dwork, delay);
1da177e4 223}
ae90dd5d 224EXPORT_SYMBOL_GPL(queue_delayed_work);
1da177e4 225
0fcb78c2
REB
226/**
227 * queue_delayed_work_on - queue work on specific CPU after delay
228 * @cpu: CPU number to execute work on
229 * @wq: workqueue to use
af9997e4 230 * @dwork: work to queue
0fcb78c2
REB
231 * @delay: number of jiffies to wait before queueing
232 *
057647fc 233 * Returns 0 if @work was already on a queue, non-zero otherwise.
0fcb78c2 234 */
7a6bc1cd 235int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
52bad64d 236 struct delayed_work *dwork, unsigned long delay)
7a6bc1cd
VP
237{
238 int ret = 0;
52bad64d
DH
239 struct timer_list *timer = &dwork->timer;
240 struct work_struct *work = &dwork->work;
7a6bc1cd 241
a08727ba 242 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work))) {
7a6bc1cd
VP
243 BUG_ON(timer_pending(timer));
244 BUG_ON(!list_empty(&work->entry));
245
8a3e77cc
AL
246 timer_stats_timer_set_start_info(&dwork->timer);
247
ed7c0fee 248 /* This stores cwq for the moment, for the timer_fn */
a848e3b6 249 set_wq_data(work, wq_per_cpu(wq, raw_smp_processor_id()));
7a6bc1cd 250 timer->expires = jiffies + delay;
52bad64d 251 timer->data = (unsigned long)dwork;
7a6bc1cd 252 timer->function = delayed_work_timer_fn;
63bc0362
ON
253
254 if (unlikely(cpu >= 0))
255 add_timer_on(timer, cpu);
256 else
257 add_timer(timer);
7a6bc1cd
VP
258 ret = 1;
259 }
260 return ret;
261}
ae90dd5d 262EXPORT_SYMBOL_GPL(queue_delayed_work_on);
1da177e4 263
858119e1 264static void run_workqueue(struct cpu_workqueue_struct *cwq)
1da177e4 265{
f293ea92 266 spin_lock_irq(&cwq->lock);
1da177e4
LT
267 while (!list_empty(&cwq->worklist)) {
268 struct work_struct *work = list_entry(cwq->worklist.next,
269 struct work_struct, entry);
6bb49e59 270 work_func_t f = work->func;
4e6045f1
JB
271#ifdef CONFIG_LOCKDEP
272 /*
273 * It is permissible to free the struct work_struct
274 * from inside the function that is called from it,
275 * this we need to take into account for lockdep too.
276 * To avoid bogus "held lock freed" warnings as well
277 * as problems when looking into work->lockdep_map,
278 * make a copy and use that here.
279 */
280 struct lockdep_map lockdep_map = work->lockdep_map;
281#endif
e1d8aa9f 282 trace_workqueue_execution(cwq->thread, work);
b89deed3 283 cwq->current_work = work;
1da177e4 284 list_del_init(cwq->worklist.next);
f293ea92 285 spin_unlock_irq(&cwq->lock);
1da177e4 286
365970a1 287 BUG_ON(get_wq_data(work) != cwq);
23b2e599 288 work_clear_pending(work);
3295f0ef
IM
289 lock_map_acquire(&cwq->wq->lockdep_map);
290 lock_map_acquire(&lockdep_map);
65f27f38 291 f(work);
3295f0ef
IM
292 lock_map_release(&lockdep_map);
293 lock_map_release(&cwq->wq->lockdep_map);
1da177e4 294
d5abe669
PZ
295 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
296 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
297 "%s/0x%08x/%d\n",
298 current->comm, preempt_count(),
ba25f9dc 299 task_pid_nr(current));
d5abe669
PZ
300 printk(KERN_ERR " last function: ");
301 print_symbol("%s\n", (unsigned long)f);
302 debug_show_held_locks(current);
303 dump_stack();
304 }
305
f293ea92 306 spin_lock_irq(&cwq->lock);
b89deed3 307 cwq->current_work = NULL;
1da177e4 308 }
f293ea92 309 spin_unlock_irq(&cwq->lock);
1da177e4
LT
310}
311
312static int worker_thread(void *__cwq)
313{
314 struct cpu_workqueue_struct *cwq = __cwq;
3af24433 315 DEFINE_WAIT(wait);
1da177e4 316
83144186
RW
317 if (cwq->wq->freezeable)
318 set_freezable();
1da177e4 319
3af24433 320 for (;;) {
3af24433 321 prepare_to_wait(&cwq->more_work, &wait, TASK_INTERRUPTIBLE);
14441960
ON
322 if (!freezing(current) &&
323 !kthread_should_stop() &&
324 list_empty(&cwq->worklist))
1da177e4 325 schedule();
3af24433
ON
326 finish_wait(&cwq->more_work, &wait);
327
85f4186a
ON
328 try_to_freeze();
329
14441960 330 if (kthread_should_stop())
3af24433 331 break;
1da177e4 332
3af24433 333 run_workqueue(cwq);
1da177e4 334 }
3af24433 335
1da177e4
LT
336 return 0;
337}
338
fc2e4d70
ON
339struct wq_barrier {
340 struct work_struct work;
341 struct completion done;
342};
343
344static void wq_barrier_func(struct work_struct *work)
345{
346 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
347 complete(&barr->done);
348}
349
83c22520 350static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
1a4d9b0a 351 struct wq_barrier *barr, struct list_head *head)
fc2e4d70
ON
352{
353 INIT_WORK(&barr->work, wq_barrier_func);
354 __set_bit(WORK_STRUCT_PENDING, work_data_bits(&barr->work));
355
356 init_completion(&barr->done);
83c22520 357
1a4d9b0a 358 insert_work(cwq, &barr->work, head);
fc2e4d70
ON
359}
360
14441960 361static int flush_cpu_workqueue(struct cpu_workqueue_struct *cwq)
1da177e4 362{
2355b70f
LJ
363 int active = 0;
364 struct wq_barrier barr;
1da177e4 365
2355b70f 366 WARN_ON(cwq->thread == current);
1da177e4 367
2355b70f
LJ
368 spin_lock_irq(&cwq->lock);
369 if (!list_empty(&cwq->worklist) || cwq->current_work != NULL) {
370 insert_wq_barrier(cwq, &barr, &cwq->worklist);
371 active = 1;
1da177e4 372 }
2355b70f
LJ
373 spin_unlock_irq(&cwq->lock);
374
375 if (active)
376 wait_for_completion(&barr.done);
14441960
ON
377
378 return active;
1da177e4
LT
379}
380
0fcb78c2 381/**
1da177e4 382 * flush_workqueue - ensure that any scheduled work has run to completion.
0fcb78c2 383 * @wq: workqueue to flush
1da177e4
LT
384 *
385 * Forces execution of the workqueue and blocks until its completion.
386 * This is typically used in driver shutdown handlers.
387 *
fc2e4d70
ON
388 * We sleep until all works which were queued on entry have been handled,
389 * but we are not livelocked by new incoming ones.
1da177e4
LT
390 *
391 * This function used to run the workqueues itself. Now we just wait for the
392 * helper threads to do it.
393 */
7ad5b3a5 394void flush_workqueue(struct workqueue_struct *wq)
1da177e4 395{
e7577c50 396 const struct cpumask *cpu_map = wq_cpu_map(wq);
cce1a165 397 int cpu;
1da177e4 398
b1f4ec17 399 might_sleep();
3295f0ef
IM
400 lock_map_acquire(&wq->lockdep_map);
401 lock_map_release(&wq->lockdep_map);
aa85ea5b 402 for_each_cpu(cpu, cpu_map)
b1f4ec17 403 flush_cpu_workqueue(per_cpu_ptr(wq->cpu_wq, cpu));
1da177e4 404}
ae90dd5d 405EXPORT_SYMBOL_GPL(flush_workqueue);
1da177e4 406
db700897
ON
407/**
408 * flush_work - block until a work_struct's callback has terminated
409 * @work: the work which is to be flushed
410 *
a67da70d
ON
411 * Returns false if @work has already terminated.
412 *
db700897
ON
413 * It is expected that, prior to calling flush_work(), the caller has
414 * arranged for the work to not be requeued, otherwise it doesn't make
415 * sense to use this function.
416 */
417int flush_work(struct work_struct *work)
418{
419 struct cpu_workqueue_struct *cwq;
420 struct list_head *prev;
421 struct wq_barrier barr;
422
423 might_sleep();
424 cwq = get_wq_data(work);
425 if (!cwq)
426 return 0;
427
3295f0ef
IM
428 lock_map_acquire(&cwq->wq->lockdep_map);
429 lock_map_release(&cwq->wq->lockdep_map);
a67da70d 430
db700897
ON
431 prev = NULL;
432 spin_lock_irq(&cwq->lock);
433 if (!list_empty(&work->entry)) {
434 /*
435 * See the comment near try_to_grab_pending()->smp_rmb().
436 * If it was re-queued under us we are not going to wait.
437 */
438 smp_rmb();
439 if (unlikely(cwq != get_wq_data(work)))
440 goto out;
441 prev = &work->entry;
442 } else {
443 if (cwq->current_work != work)
444 goto out;
445 prev = &cwq->worklist;
446 }
447 insert_wq_barrier(cwq, &barr, prev->next);
448out:
449 spin_unlock_irq(&cwq->lock);
450 if (!prev)
451 return 0;
452
453 wait_for_completion(&barr.done);
454 return 1;
455}
456EXPORT_SYMBOL_GPL(flush_work);
457
6e84d644 458/*
1f1f642e 459 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
6e84d644
ON
460 * so this work can't be re-armed in any way.
461 */
462static int try_to_grab_pending(struct work_struct *work)
463{
464 struct cpu_workqueue_struct *cwq;
1f1f642e 465 int ret = -1;
6e84d644
ON
466
467 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work)))
1f1f642e 468 return 0;
6e84d644
ON
469
470 /*
471 * The queueing is in progress, or it is already queued. Try to
472 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
473 */
474
475 cwq = get_wq_data(work);
476 if (!cwq)
477 return ret;
478
479 spin_lock_irq(&cwq->lock);
480 if (!list_empty(&work->entry)) {
481 /*
482 * This work is queued, but perhaps we locked the wrong cwq.
483 * In that case we must see the new value after rmb(), see
484 * insert_work()->wmb().
485 */
486 smp_rmb();
487 if (cwq == get_wq_data(work)) {
488 list_del_init(&work->entry);
489 ret = 1;
490 }
491 }
492 spin_unlock_irq(&cwq->lock);
493
494 return ret;
495}
496
497static void wait_on_cpu_work(struct cpu_workqueue_struct *cwq,
b89deed3
ON
498 struct work_struct *work)
499{
500 struct wq_barrier barr;
501 int running = 0;
502
503 spin_lock_irq(&cwq->lock);
504 if (unlikely(cwq->current_work == work)) {
1a4d9b0a 505 insert_wq_barrier(cwq, &barr, cwq->worklist.next);
b89deed3
ON
506 running = 1;
507 }
508 spin_unlock_irq(&cwq->lock);
509
3af24433 510 if (unlikely(running))
b89deed3 511 wait_for_completion(&barr.done);
b89deed3
ON
512}
513
6e84d644 514static void wait_on_work(struct work_struct *work)
b89deed3
ON
515{
516 struct cpu_workqueue_struct *cwq;
28e53bdd 517 struct workqueue_struct *wq;
e7577c50 518 const struct cpumask *cpu_map;
b1f4ec17 519 int cpu;
b89deed3 520
f293ea92
ON
521 might_sleep();
522
3295f0ef
IM
523 lock_map_acquire(&work->lockdep_map);
524 lock_map_release(&work->lockdep_map);
4e6045f1 525
b89deed3 526 cwq = get_wq_data(work);
b89deed3 527 if (!cwq)
3af24433 528 return;
b89deed3 529
28e53bdd
ON
530 wq = cwq->wq;
531 cpu_map = wq_cpu_map(wq);
532
aa85ea5b 533 for_each_cpu(cpu, cpu_map)
6e84d644
ON
534 wait_on_cpu_work(per_cpu_ptr(wq->cpu_wq, cpu), work);
535}
536
1f1f642e
ON
537static int __cancel_work_timer(struct work_struct *work,
538 struct timer_list* timer)
539{
540 int ret;
541
542 do {
543 ret = (timer && likely(del_timer(timer)));
544 if (!ret)
545 ret = try_to_grab_pending(work);
546 wait_on_work(work);
547 } while (unlikely(ret < 0));
548
549 work_clear_pending(work);
550 return ret;
551}
552
6e84d644
ON
553/**
554 * cancel_work_sync - block until a work_struct's callback has terminated
555 * @work: the work which is to be flushed
556 *
1f1f642e
ON
557 * Returns true if @work was pending.
558 *
6e84d644
ON
559 * cancel_work_sync() will cancel the work if it is queued. If the work's
560 * callback appears to be running, cancel_work_sync() will block until it
561 * has completed.
562 *
563 * It is possible to use this function if the work re-queues itself. It can
564 * cancel the work even if it migrates to another workqueue, however in that
565 * case it only guarantees that work->func() has completed on the last queued
566 * workqueue.
567 *
568 * cancel_work_sync(&delayed_work->work) should be used only if ->timer is not
569 * pending, otherwise it goes into a busy-wait loop until the timer expires.
570 *
571 * The caller must ensure that workqueue_struct on which this work was last
572 * queued can't be destroyed before this function returns.
573 */
1f1f642e 574int cancel_work_sync(struct work_struct *work)
6e84d644 575{
1f1f642e 576 return __cancel_work_timer(work, NULL);
b89deed3 577}
28e53bdd 578EXPORT_SYMBOL_GPL(cancel_work_sync);
b89deed3 579
6e84d644 580/**
f5a421a4 581 * cancel_delayed_work_sync - reliably kill off a delayed work.
6e84d644
ON
582 * @dwork: the delayed work struct
583 *
1f1f642e
ON
584 * Returns true if @dwork was pending.
585 *
6e84d644
ON
586 * It is possible to use this function if @dwork rearms itself via queue_work()
587 * or queue_delayed_work(). See also the comment for cancel_work_sync().
588 */
1f1f642e 589int cancel_delayed_work_sync(struct delayed_work *dwork)
6e84d644 590{
1f1f642e 591 return __cancel_work_timer(&dwork->work, &dwork->timer);
6e84d644 592}
f5a421a4 593EXPORT_SYMBOL(cancel_delayed_work_sync);
1da177e4 594
6e84d644 595static struct workqueue_struct *keventd_wq __read_mostly;
1da177e4 596
0fcb78c2
REB
597/**
598 * schedule_work - put work task in global workqueue
599 * @work: job to be done
600 *
5b0f437d
BVA
601 * Returns zero if @work was already on the kernel-global workqueue and
602 * non-zero otherwise.
603 *
604 * This puts a job in the kernel-global workqueue if it was not already
605 * queued and leaves it in the same position on the kernel-global
606 * workqueue otherwise.
0fcb78c2 607 */
7ad5b3a5 608int schedule_work(struct work_struct *work)
1da177e4
LT
609{
610 return queue_work(keventd_wq, work);
611}
ae90dd5d 612EXPORT_SYMBOL(schedule_work);
1da177e4 613
c1a220e7
ZR
614/*
615 * schedule_work_on - put work task on a specific cpu
616 * @cpu: cpu to put the work task on
617 * @work: job to be done
618 *
619 * This puts a job on a specific cpu
620 */
621int schedule_work_on(int cpu, struct work_struct *work)
622{
623 return queue_work_on(cpu, keventd_wq, work);
624}
625EXPORT_SYMBOL(schedule_work_on);
626
0fcb78c2
REB
627/**
628 * schedule_delayed_work - put work task in global workqueue after delay
52bad64d
DH
629 * @dwork: job to be done
630 * @delay: number of jiffies to wait or 0 for immediate execution
0fcb78c2
REB
631 *
632 * After waiting for a given time this puts a job in the kernel-global
633 * workqueue.
634 */
7ad5b3a5 635int schedule_delayed_work(struct delayed_work *dwork,
82f67cd9 636 unsigned long delay)
1da177e4 637{
52bad64d 638 return queue_delayed_work(keventd_wq, dwork, delay);
1da177e4 639}
ae90dd5d 640EXPORT_SYMBOL(schedule_delayed_work);
1da177e4 641
0fcb78c2
REB
642/**
643 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
644 * @cpu: cpu to use
52bad64d 645 * @dwork: job to be done
0fcb78c2
REB
646 * @delay: number of jiffies to wait
647 *
648 * After waiting for a given time this puts a job in the kernel-global
649 * workqueue on the specified CPU.
650 */
1da177e4 651int schedule_delayed_work_on(int cpu,
52bad64d 652 struct delayed_work *dwork, unsigned long delay)
1da177e4 653{
52bad64d 654 return queue_delayed_work_on(cpu, keventd_wq, dwork, delay);
1da177e4 655}
ae90dd5d 656EXPORT_SYMBOL(schedule_delayed_work_on);
1da177e4 657
b6136773
AM
658/**
659 * schedule_on_each_cpu - call a function on each online CPU from keventd
660 * @func: the function to call
b6136773
AM
661 *
662 * Returns zero on success.
663 * Returns -ve errno on failure.
664 *
b6136773
AM
665 * schedule_on_each_cpu() is very slow.
666 */
65f27f38 667int schedule_on_each_cpu(work_func_t func)
15316ba8
CL
668{
669 int cpu;
b6136773 670 struct work_struct *works;
15316ba8 671
b6136773
AM
672 works = alloc_percpu(struct work_struct);
673 if (!works)
15316ba8 674 return -ENOMEM;
b6136773 675
95402b38 676 get_online_cpus();
15316ba8 677 for_each_online_cpu(cpu) {
9bfb1839
IM
678 struct work_struct *work = per_cpu_ptr(works, cpu);
679
680 INIT_WORK(work, func);
8de6d308 681 schedule_work_on(cpu, work);
15316ba8 682 }
8616a89a
ON
683 for_each_online_cpu(cpu)
684 flush_work(per_cpu_ptr(works, cpu));
95402b38 685 put_online_cpus();
b6136773 686 free_percpu(works);
15316ba8
CL
687 return 0;
688}
689
1da177e4
LT
690void flush_scheduled_work(void)
691{
692 flush_workqueue(keventd_wq);
693}
ae90dd5d 694EXPORT_SYMBOL(flush_scheduled_work);
1da177e4 695
1fa44eca
JB
696/**
697 * execute_in_process_context - reliably execute the routine with user context
698 * @fn: the function to execute
1fa44eca
JB
699 * @ew: guaranteed storage for the execute work structure (must
700 * be available when the work executes)
701 *
702 * Executes the function immediately if process context is available,
703 * otherwise schedules the function for delayed execution.
704 *
705 * Returns: 0 - function was executed
706 * 1 - function was scheduled for execution
707 */
65f27f38 708int execute_in_process_context(work_func_t fn, struct execute_work *ew)
1fa44eca
JB
709{
710 if (!in_interrupt()) {
65f27f38 711 fn(&ew->work);
1fa44eca
JB
712 return 0;
713 }
714
65f27f38 715 INIT_WORK(&ew->work, fn);
1fa44eca
JB
716 schedule_work(&ew->work);
717
718 return 1;
719}
720EXPORT_SYMBOL_GPL(execute_in_process_context);
721
1da177e4
LT
722int keventd_up(void)
723{
724 return keventd_wq != NULL;
725}
726
727int current_is_keventd(void)
728{
729 struct cpu_workqueue_struct *cwq;
d243769d 730 int cpu = raw_smp_processor_id(); /* preempt-safe: keventd is per-cpu */
1da177e4
LT
731 int ret = 0;
732
733 BUG_ON(!keventd_wq);
734
89ada679 735 cwq = per_cpu_ptr(keventd_wq->cpu_wq, cpu);
1da177e4
LT
736 if (current == cwq->thread)
737 ret = 1;
738
739 return ret;
740
741}
742
3af24433
ON
743static struct cpu_workqueue_struct *
744init_cpu_workqueue(struct workqueue_struct *wq, int cpu)
1da177e4 745{
89ada679 746 struct cpu_workqueue_struct *cwq = per_cpu_ptr(wq->cpu_wq, cpu);
1da177e4 747
3af24433
ON
748 cwq->wq = wq;
749 spin_lock_init(&cwq->lock);
750 INIT_LIST_HEAD(&cwq->worklist);
751 init_waitqueue_head(&cwq->more_work);
752
753 return cwq;
1da177e4
LT
754}
755
3af24433
ON
756static int create_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
757{
0d557dc9 758 struct sched_param param = { .sched_priority = MAX_RT_PRIO-1 };
3af24433 759 struct workqueue_struct *wq = cwq->wq;
6cc88bc4 760 const char *fmt = is_wq_single_threaded(wq) ? "%s" : "%s/%d";
3af24433
ON
761 struct task_struct *p;
762
763 p = kthread_create(worker_thread, cwq, fmt, wq->name, cpu);
764 /*
765 * Nobody can add the work_struct to this cwq,
766 * if (caller is __create_workqueue)
767 * nobody should see this wq
768 * else // caller is CPU_UP_PREPARE
769 * cpu is not on cpu_online_map
770 * so we can abort safely.
771 */
772 if (IS_ERR(p))
773 return PTR_ERR(p);
0d557dc9
HC
774 if (cwq->wq->rt)
775 sched_setscheduler_nocheck(p, SCHED_FIFO, &param);
3af24433 776 cwq->thread = p;
3af24433 777
e1d8aa9f
FW
778 trace_workqueue_creation(cwq->thread, cpu);
779
3af24433
ON
780 return 0;
781}
782
06ba38a9
ON
783static void start_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
784{
785 struct task_struct *p = cwq->thread;
786
787 if (p != NULL) {
788 if (cpu >= 0)
789 kthread_bind(p, cpu);
790 wake_up_process(p);
791 }
792}
793
4e6045f1
JB
794struct workqueue_struct *__create_workqueue_key(const char *name,
795 int singlethread,
796 int freezeable,
0d557dc9 797 int rt,
eb13ba87
JB
798 struct lock_class_key *key,
799 const char *lock_name)
1da177e4 800{
1da177e4 801 struct workqueue_struct *wq;
3af24433
ON
802 struct cpu_workqueue_struct *cwq;
803 int err = 0, cpu;
1da177e4 804
3af24433
ON
805 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
806 if (!wq)
807 return NULL;
808
809 wq->cpu_wq = alloc_percpu(struct cpu_workqueue_struct);
810 if (!wq->cpu_wq) {
811 kfree(wq);
812 return NULL;
813 }
814
815 wq->name = name;
eb13ba87 816 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
cce1a165 817 wq->singlethread = singlethread;
3af24433 818 wq->freezeable = freezeable;
0d557dc9 819 wq->rt = rt;
cce1a165 820 INIT_LIST_HEAD(&wq->list);
3af24433
ON
821
822 if (singlethread) {
3af24433
ON
823 cwq = init_cpu_workqueue(wq, singlethread_cpu);
824 err = create_workqueue_thread(cwq, singlethread_cpu);
06ba38a9 825 start_workqueue_thread(cwq, -1);
3af24433 826 } else {
3da1c84c 827 cpu_maps_update_begin();
6af8bf3d
ON
828 /*
829 * We must place this wq on list even if the code below fails.
830 * cpu_down(cpu) can remove cpu from cpu_populated_map before
831 * destroy_workqueue() takes the lock, in that case we leak
832 * cwq[cpu]->thread.
833 */
95402b38 834 spin_lock(&workqueue_lock);
3af24433 835 list_add(&wq->list, &workqueues);
95402b38 836 spin_unlock(&workqueue_lock);
6af8bf3d
ON
837 /*
838 * We must initialize cwqs for each possible cpu even if we
839 * are going to call destroy_workqueue() finally. Otherwise
840 * cpu_up() can hit the uninitialized cwq once we drop the
841 * lock.
842 */
3af24433
ON
843 for_each_possible_cpu(cpu) {
844 cwq = init_cpu_workqueue(wq, cpu);
845 if (err || !cpu_online(cpu))
846 continue;
847 err = create_workqueue_thread(cwq, cpu);
06ba38a9 848 start_workqueue_thread(cwq, cpu);
1da177e4 849 }
3da1c84c 850 cpu_maps_update_done();
3af24433
ON
851 }
852
853 if (err) {
854 destroy_workqueue(wq);
855 wq = NULL;
856 }
857 return wq;
858}
4e6045f1 859EXPORT_SYMBOL_GPL(__create_workqueue_key);
1da177e4 860
1e35eaa2 861static void cleanup_workqueue_thread(struct cpu_workqueue_struct *cwq)
3af24433 862{
14441960 863 /*
3da1c84c
ON
864 * Our caller is either destroy_workqueue() or CPU_POST_DEAD,
865 * cpu_add_remove_lock protects cwq->thread.
14441960
ON
866 */
867 if (cwq->thread == NULL)
868 return;
3af24433 869
3295f0ef
IM
870 lock_map_acquire(&cwq->wq->lockdep_map);
871 lock_map_release(&cwq->wq->lockdep_map);
4e6045f1 872
13c22168 873 flush_cpu_workqueue(cwq);
14441960 874 /*
3da1c84c 875 * If the caller is CPU_POST_DEAD and cwq->worklist was not empty,
13c22168
ON
876 * a concurrent flush_workqueue() can insert a barrier after us.
877 * However, in that case run_workqueue() won't return and check
878 * kthread_should_stop() until it flushes all work_struct's.
14441960
ON
879 * When ->worklist becomes empty it is safe to exit because no
880 * more work_structs can be queued on this cwq: flush_workqueue
881 * checks list_empty(), and a "normal" queue_work() can't use
882 * a dead CPU.
883 */
e1d8aa9f 884 trace_workqueue_destruction(cwq->thread);
14441960
ON
885 kthread_stop(cwq->thread);
886 cwq->thread = NULL;
3af24433
ON
887}
888
889/**
890 * destroy_workqueue - safely terminate a workqueue
891 * @wq: target workqueue
892 *
893 * Safely destroy a workqueue. All work currently pending will be done first.
894 */
895void destroy_workqueue(struct workqueue_struct *wq)
896{
e7577c50 897 const struct cpumask *cpu_map = wq_cpu_map(wq);
b1f4ec17 898 int cpu;
3af24433 899
3da1c84c 900 cpu_maps_update_begin();
95402b38 901 spin_lock(&workqueue_lock);
b1f4ec17 902 list_del(&wq->list);
95402b38 903 spin_unlock(&workqueue_lock);
3af24433 904
aa85ea5b 905 for_each_cpu(cpu, cpu_map)
1e35eaa2 906 cleanup_workqueue_thread(per_cpu_ptr(wq->cpu_wq, cpu));
3da1c84c 907 cpu_maps_update_done();
9b41ea72 908
3af24433
ON
909 free_percpu(wq->cpu_wq);
910 kfree(wq);
911}
912EXPORT_SYMBOL_GPL(destroy_workqueue);
913
914static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
915 unsigned long action,
916 void *hcpu)
917{
918 unsigned int cpu = (unsigned long)hcpu;
919 struct cpu_workqueue_struct *cwq;
920 struct workqueue_struct *wq;
8448502c 921 int ret = NOTIFY_OK;
3af24433 922
8bb78442
RW
923 action &= ~CPU_TASKS_FROZEN;
924
3af24433 925 switch (action) {
3af24433 926 case CPU_UP_PREPARE:
e7577c50 927 cpumask_set_cpu(cpu, cpu_populated_map);
3af24433 928 }
8448502c 929undo:
3af24433
ON
930 list_for_each_entry(wq, &workqueues, list) {
931 cwq = per_cpu_ptr(wq->cpu_wq, cpu);
932
933 switch (action) {
934 case CPU_UP_PREPARE:
935 if (!create_workqueue_thread(cwq, cpu))
936 break;
95402b38
GS
937 printk(KERN_ERR "workqueue [%s] for %i failed\n",
938 wq->name, cpu);
8448502c
ON
939 action = CPU_UP_CANCELED;
940 ret = NOTIFY_BAD;
941 goto undo;
3af24433
ON
942
943 case CPU_ONLINE:
06ba38a9 944 start_workqueue_thread(cwq, cpu);
3af24433
ON
945 break;
946
947 case CPU_UP_CANCELED:
06ba38a9 948 start_workqueue_thread(cwq, -1);
3da1c84c 949 case CPU_POST_DEAD:
1e35eaa2 950 cleanup_workqueue_thread(cwq);
3af24433
ON
951 break;
952 }
1da177e4
LT
953 }
954
00dfcaf7
ON
955 switch (action) {
956 case CPU_UP_CANCELED:
3da1c84c 957 case CPU_POST_DEAD:
e7577c50 958 cpumask_clear_cpu(cpu, cpu_populated_map);
00dfcaf7
ON
959 }
960
8448502c 961 return ret;
1da177e4 962}
1da177e4 963
2d3854a3 964#ifdef CONFIG_SMP
8ccad40d 965
2d3854a3 966struct work_for_cpu {
6b44003e 967 struct completion completion;
2d3854a3
RR
968 long (*fn)(void *);
969 void *arg;
970 long ret;
971};
972
6b44003e 973static int do_work_for_cpu(void *_wfc)
2d3854a3 974{
6b44003e 975 struct work_for_cpu *wfc = _wfc;
2d3854a3 976 wfc->ret = wfc->fn(wfc->arg);
6b44003e
AM
977 complete(&wfc->completion);
978 return 0;
2d3854a3
RR
979}
980
981/**
982 * work_on_cpu - run a function in user context on a particular cpu
983 * @cpu: the cpu to run on
984 * @fn: the function to run
985 * @arg: the function arg
986 *
31ad9081
RR
987 * This will return the value @fn returns.
988 * It is up to the caller to ensure that the cpu doesn't go offline.
6b44003e 989 * The caller must not hold any locks which would prevent @fn from completing.
2d3854a3
RR
990 */
991long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
992{
6b44003e
AM
993 struct task_struct *sub_thread;
994 struct work_for_cpu wfc = {
995 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
996 .fn = fn,
997 .arg = arg,
998 };
999
1000 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
1001 if (IS_ERR(sub_thread))
1002 return PTR_ERR(sub_thread);
1003 kthread_bind(sub_thread, cpu);
1004 wake_up_process(sub_thread);
1005 wait_for_completion(&wfc.completion);
2d3854a3
RR
1006 return wfc.ret;
1007}
1008EXPORT_SYMBOL_GPL(work_on_cpu);
1009#endif /* CONFIG_SMP */
1010
c12920d1 1011void __init init_workqueues(void)
1da177e4 1012{
e7577c50
RR
1013 alloc_cpumask_var(&cpu_populated_map, GFP_KERNEL);
1014
1015 cpumask_copy(cpu_populated_map, cpu_online_mask);
1016 singlethread_cpu = cpumask_first(cpu_possible_mask);
1017 cpu_singlethread_map = cpumask_of(singlethread_cpu);
1da177e4
LT
1018 hotcpu_notifier(workqueue_cpu_callback, 0);
1019 keventd_wq = create_workqueue("events");
1020 BUG_ON(!keventd_wq);
1021}