Merge branch 'core-debug-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[deliverable/linux.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
LT
319
320 set_user_nice(current, -5);
1da177e4 321
3af24433 322 for (;;) {
3af24433 323 prepare_to_wait(&cwq->more_work, &wait, TASK_INTERRUPTIBLE);
14441960
ON
324 if (!freezing(current) &&
325 !kthread_should_stop() &&
326 list_empty(&cwq->worklist))
1da177e4 327 schedule();
3af24433
ON
328 finish_wait(&cwq->more_work, &wait);
329
85f4186a
ON
330 try_to_freeze();
331
14441960 332 if (kthread_should_stop())
3af24433 333 break;
1da177e4 334
3af24433 335 run_workqueue(cwq);
1da177e4 336 }
3af24433 337
1da177e4
LT
338 return 0;
339}
340
fc2e4d70
ON
341struct wq_barrier {
342 struct work_struct work;
343 struct completion done;
344};
345
346static void wq_barrier_func(struct work_struct *work)
347{
348 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
349 complete(&barr->done);
350}
351
83c22520 352static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
1a4d9b0a 353 struct wq_barrier *barr, struct list_head *head)
fc2e4d70
ON
354{
355 INIT_WORK(&barr->work, wq_barrier_func);
356 __set_bit(WORK_STRUCT_PENDING, work_data_bits(&barr->work));
357
358 init_completion(&barr->done);
83c22520 359
1a4d9b0a 360 insert_work(cwq, &barr->work, head);
fc2e4d70
ON
361}
362
14441960 363static int flush_cpu_workqueue(struct cpu_workqueue_struct *cwq)
1da177e4 364{
2355b70f
LJ
365 int active = 0;
366 struct wq_barrier barr;
1da177e4 367
2355b70f 368 WARN_ON(cwq->thread == current);
1da177e4 369
2355b70f
LJ
370 spin_lock_irq(&cwq->lock);
371 if (!list_empty(&cwq->worklist) || cwq->current_work != NULL) {
372 insert_wq_barrier(cwq, &barr, &cwq->worklist);
373 active = 1;
1da177e4 374 }
2355b70f
LJ
375 spin_unlock_irq(&cwq->lock);
376
377 if (active)
378 wait_for_completion(&barr.done);
14441960
ON
379
380 return active;
1da177e4
LT
381}
382
0fcb78c2 383/**
1da177e4 384 * flush_workqueue - ensure that any scheduled work has run to completion.
0fcb78c2 385 * @wq: workqueue to flush
1da177e4
LT
386 *
387 * Forces execution of the workqueue and blocks until its completion.
388 * This is typically used in driver shutdown handlers.
389 *
fc2e4d70
ON
390 * We sleep until all works which were queued on entry have been handled,
391 * but we are not livelocked by new incoming ones.
1da177e4
LT
392 *
393 * This function used to run the workqueues itself. Now we just wait for the
394 * helper threads to do it.
395 */
7ad5b3a5 396void flush_workqueue(struct workqueue_struct *wq)
1da177e4 397{
e7577c50 398 const struct cpumask *cpu_map = wq_cpu_map(wq);
cce1a165 399 int cpu;
1da177e4 400
b1f4ec17 401 might_sleep();
3295f0ef
IM
402 lock_map_acquire(&wq->lockdep_map);
403 lock_map_release(&wq->lockdep_map);
aa85ea5b 404 for_each_cpu(cpu, cpu_map)
b1f4ec17 405 flush_cpu_workqueue(per_cpu_ptr(wq->cpu_wq, cpu));
1da177e4 406}
ae90dd5d 407EXPORT_SYMBOL_GPL(flush_workqueue);
1da177e4 408
db700897
ON
409/**
410 * flush_work - block until a work_struct's callback has terminated
411 * @work: the work which is to be flushed
412 *
a67da70d
ON
413 * Returns false if @work has already terminated.
414 *
db700897
ON
415 * It is expected that, prior to calling flush_work(), the caller has
416 * arranged for the work to not be requeued, otherwise it doesn't make
417 * sense to use this function.
418 */
419int flush_work(struct work_struct *work)
420{
421 struct cpu_workqueue_struct *cwq;
422 struct list_head *prev;
423 struct wq_barrier barr;
424
425 might_sleep();
426 cwq = get_wq_data(work);
427 if (!cwq)
428 return 0;
429
3295f0ef
IM
430 lock_map_acquire(&cwq->wq->lockdep_map);
431 lock_map_release(&cwq->wq->lockdep_map);
a67da70d 432
db700897
ON
433 prev = NULL;
434 spin_lock_irq(&cwq->lock);
435 if (!list_empty(&work->entry)) {
436 /*
437 * See the comment near try_to_grab_pending()->smp_rmb().
438 * If it was re-queued under us we are not going to wait.
439 */
440 smp_rmb();
441 if (unlikely(cwq != get_wq_data(work)))
442 goto out;
443 prev = &work->entry;
444 } else {
445 if (cwq->current_work != work)
446 goto out;
447 prev = &cwq->worklist;
448 }
449 insert_wq_barrier(cwq, &barr, prev->next);
450out:
451 spin_unlock_irq(&cwq->lock);
452 if (!prev)
453 return 0;
454
455 wait_for_completion(&barr.done);
456 return 1;
457}
458EXPORT_SYMBOL_GPL(flush_work);
459
6e84d644 460/*
1f1f642e 461 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
6e84d644
ON
462 * so this work can't be re-armed in any way.
463 */
464static int try_to_grab_pending(struct work_struct *work)
465{
466 struct cpu_workqueue_struct *cwq;
1f1f642e 467 int ret = -1;
6e84d644
ON
468
469 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work)))
1f1f642e 470 return 0;
6e84d644
ON
471
472 /*
473 * The queueing is in progress, or it is already queued. Try to
474 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
475 */
476
477 cwq = get_wq_data(work);
478 if (!cwq)
479 return ret;
480
481 spin_lock_irq(&cwq->lock);
482 if (!list_empty(&work->entry)) {
483 /*
484 * This work is queued, but perhaps we locked the wrong cwq.
485 * In that case we must see the new value after rmb(), see
486 * insert_work()->wmb().
487 */
488 smp_rmb();
489 if (cwq == get_wq_data(work)) {
490 list_del_init(&work->entry);
491 ret = 1;
492 }
493 }
494 spin_unlock_irq(&cwq->lock);
495
496 return ret;
497}
498
499static void wait_on_cpu_work(struct cpu_workqueue_struct *cwq,
b89deed3
ON
500 struct work_struct *work)
501{
502 struct wq_barrier barr;
503 int running = 0;
504
505 spin_lock_irq(&cwq->lock);
506 if (unlikely(cwq->current_work == work)) {
1a4d9b0a 507 insert_wq_barrier(cwq, &barr, cwq->worklist.next);
b89deed3
ON
508 running = 1;
509 }
510 spin_unlock_irq(&cwq->lock);
511
3af24433 512 if (unlikely(running))
b89deed3 513 wait_for_completion(&barr.done);
b89deed3
ON
514}
515
6e84d644 516static void wait_on_work(struct work_struct *work)
b89deed3
ON
517{
518 struct cpu_workqueue_struct *cwq;
28e53bdd 519 struct workqueue_struct *wq;
e7577c50 520 const struct cpumask *cpu_map;
b1f4ec17 521 int cpu;
b89deed3 522
f293ea92
ON
523 might_sleep();
524
3295f0ef
IM
525 lock_map_acquire(&work->lockdep_map);
526 lock_map_release(&work->lockdep_map);
4e6045f1 527
b89deed3 528 cwq = get_wq_data(work);
b89deed3 529 if (!cwq)
3af24433 530 return;
b89deed3 531
28e53bdd
ON
532 wq = cwq->wq;
533 cpu_map = wq_cpu_map(wq);
534
aa85ea5b 535 for_each_cpu(cpu, cpu_map)
6e84d644
ON
536 wait_on_cpu_work(per_cpu_ptr(wq->cpu_wq, cpu), work);
537}
538
1f1f642e
ON
539static int __cancel_work_timer(struct work_struct *work,
540 struct timer_list* timer)
541{
542 int ret;
543
544 do {
545 ret = (timer && likely(del_timer(timer)));
546 if (!ret)
547 ret = try_to_grab_pending(work);
548 wait_on_work(work);
549 } while (unlikely(ret < 0));
550
551 work_clear_pending(work);
552 return ret;
553}
554
6e84d644
ON
555/**
556 * cancel_work_sync - block until a work_struct's callback has terminated
557 * @work: the work which is to be flushed
558 *
1f1f642e
ON
559 * Returns true if @work was pending.
560 *
6e84d644
ON
561 * cancel_work_sync() will cancel the work if it is queued. If the work's
562 * callback appears to be running, cancel_work_sync() will block until it
563 * has completed.
564 *
565 * It is possible to use this function if the work re-queues itself. It can
566 * cancel the work even if it migrates to another workqueue, however in that
567 * case it only guarantees that work->func() has completed on the last queued
568 * workqueue.
569 *
570 * cancel_work_sync(&delayed_work->work) should be used only if ->timer is not
571 * pending, otherwise it goes into a busy-wait loop until the timer expires.
572 *
573 * The caller must ensure that workqueue_struct on which this work was last
574 * queued can't be destroyed before this function returns.
575 */
1f1f642e 576int cancel_work_sync(struct work_struct *work)
6e84d644 577{
1f1f642e 578 return __cancel_work_timer(work, NULL);
b89deed3 579}
28e53bdd 580EXPORT_SYMBOL_GPL(cancel_work_sync);
b89deed3 581
6e84d644 582/**
f5a421a4 583 * cancel_delayed_work_sync - reliably kill off a delayed work.
6e84d644
ON
584 * @dwork: the delayed work struct
585 *
1f1f642e
ON
586 * Returns true if @dwork was pending.
587 *
6e84d644
ON
588 * It is possible to use this function if @dwork rearms itself via queue_work()
589 * or queue_delayed_work(). See also the comment for cancel_work_sync().
590 */
1f1f642e 591int cancel_delayed_work_sync(struct delayed_work *dwork)
6e84d644 592{
1f1f642e 593 return __cancel_work_timer(&dwork->work, &dwork->timer);
6e84d644 594}
f5a421a4 595EXPORT_SYMBOL(cancel_delayed_work_sync);
1da177e4 596
6e84d644 597static struct workqueue_struct *keventd_wq __read_mostly;
1da177e4 598
0fcb78c2
REB
599/**
600 * schedule_work - put work task in global workqueue
601 * @work: job to be done
602 *
5b0f437d
BVA
603 * Returns zero if @work was already on the kernel-global workqueue and
604 * non-zero otherwise.
605 *
606 * This puts a job in the kernel-global workqueue if it was not already
607 * queued and leaves it in the same position on the kernel-global
608 * workqueue otherwise.
0fcb78c2 609 */
7ad5b3a5 610int schedule_work(struct work_struct *work)
1da177e4
LT
611{
612 return queue_work(keventd_wq, work);
613}
ae90dd5d 614EXPORT_SYMBOL(schedule_work);
1da177e4 615
c1a220e7
ZR
616/*
617 * schedule_work_on - put work task on a specific cpu
618 * @cpu: cpu to put the work task on
619 * @work: job to be done
620 *
621 * This puts a job on a specific cpu
622 */
623int schedule_work_on(int cpu, struct work_struct *work)
624{
625 return queue_work_on(cpu, keventd_wq, work);
626}
627EXPORT_SYMBOL(schedule_work_on);
628
0fcb78c2
REB
629/**
630 * schedule_delayed_work - put work task in global workqueue after delay
52bad64d
DH
631 * @dwork: job to be done
632 * @delay: number of jiffies to wait or 0 for immediate execution
0fcb78c2
REB
633 *
634 * After waiting for a given time this puts a job in the kernel-global
635 * workqueue.
636 */
7ad5b3a5 637int schedule_delayed_work(struct delayed_work *dwork,
82f67cd9 638 unsigned long delay)
1da177e4 639{
52bad64d 640 return queue_delayed_work(keventd_wq, dwork, delay);
1da177e4 641}
ae90dd5d 642EXPORT_SYMBOL(schedule_delayed_work);
1da177e4 643
0fcb78c2
REB
644/**
645 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
646 * @cpu: cpu to use
52bad64d 647 * @dwork: job to be done
0fcb78c2
REB
648 * @delay: number of jiffies to wait
649 *
650 * After waiting for a given time this puts a job in the kernel-global
651 * workqueue on the specified CPU.
652 */
1da177e4 653int schedule_delayed_work_on(int cpu,
52bad64d 654 struct delayed_work *dwork, unsigned long delay)
1da177e4 655{
52bad64d 656 return queue_delayed_work_on(cpu, keventd_wq, dwork, delay);
1da177e4 657}
ae90dd5d 658EXPORT_SYMBOL(schedule_delayed_work_on);
1da177e4 659
b6136773
AM
660/**
661 * schedule_on_each_cpu - call a function on each online CPU from keventd
662 * @func: the function to call
b6136773
AM
663 *
664 * Returns zero on success.
665 * Returns -ve errno on failure.
666 *
b6136773
AM
667 * schedule_on_each_cpu() is very slow.
668 */
65f27f38 669int schedule_on_each_cpu(work_func_t func)
15316ba8
CL
670{
671 int cpu;
b6136773 672 struct work_struct *works;
15316ba8 673
b6136773
AM
674 works = alloc_percpu(struct work_struct);
675 if (!works)
15316ba8 676 return -ENOMEM;
b6136773 677
95402b38 678 get_online_cpus();
15316ba8 679 for_each_online_cpu(cpu) {
9bfb1839
IM
680 struct work_struct *work = per_cpu_ptr(works, cpu);
681
682 INIT_WORK(work, func);
8de6d308 683 schedule_work_on(cpu, work);
15316ba8 684 }
8616a89a
ON
685 for_each_online_cpu(cpu)
686 flush_work(per_cpu_ptr(works, cpu));
95402b38 687 put_online_cpus();
b6136773 688 free_percpu(works);
15316ba8
CL
689 return 0;
690}
691
1da177e4
LT
692void flush_scheduled_work(void)
693{
694 flush_workqueue(keventd_wq);
695}
ae90dd5d 696EXPORT_SYMBOL(flush_scheduled_work);
1da177e4 697
1fa44eca
JB
698/**
699 * execute_in_process_context - reliably execute the routine with user context
700 * @fn: the function to execute
1fa44eca
JB
701 * @ew: guaranteed storage for the execute work structure (must
702 * be available when the work executes)
703 *
704 * Executes the function immediately if process context is available,
705 * otherwise schedules the function for delayed execution.
706 *
707 * Returns: 0 - function was executed
708 * 1 - function was scheduled for execution
709 */
65f27f38 710int execute_in_process_context(work_func_t fn, struct execute_work *ew)
1fa44eca
JB
711{
712 if (!in_interrupt()) {
65f27f38 713 fn(&ew->work);
1fa44eca
JB
714 return 0;
715 }
716
65f27f38 717 INIT_WORK(&ew->work, fn);
1fa44eca
JB
718 schedule_work(&ew->work);
719
720 return 1;
721}
722EXPORT_SYMBOL_GPL(execute_in_process_context);
723
1da177e4
LT
724int keventd_up(void)
725{
726 return keventd_wq != NULL;
727}
728
729int current_is_keventd(void)
730{
731 struct cpu_workqueue_struct *cwq;
d243769d 732 int cpu = raw_smp_processor_id(); /* preempt-safe: keventd is per-cpu */
1da177e4
LT
733 int ret = 0;
734
735 BUG_ON(!keventd_wq);
736
89ada679 737 cwq = per_cpu_ptr(keventd_wq->cpu_wq, cpu);
1da177e4
LT
738 if (current == cwq->thread)
739 ret = 1;
740
741 return ret;
742
743}
744
3af24433
ON
745static struct cpu_workqueue_struct *
746init_cpu_workqueue(struct workqueue_struct *wq, int cpu)
1da177e4 747{
89ada679 748 struct cpu_workqueue_struct *cwq = per_cpu_ptr(wq->cpu_wq, cpu);
1da177e4 749
3af24433
ON
750 cwq->wq = wq;
751 spin_lock_init(&cwq->lock);
752 INIT_LIST_HEAD(&cwq->worklist);
753 init_waitqueue_head(&cwq->more_work);
754
755 return cwq;
1da177e4
LT
756}
757
3af24433
ON
758static int create_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
759{
0d557dc9 760 struct sched_param param = { .sched_priority = MAX_RT_PRIO-1 };
3af24433 761 struct workqueue_struct *wq = cwq->wq;
6cc88bc4 762 const char *fmt = is_wq_single_threaded(wq) ? "%s" : "%s/%d";
3af24433
ON
763 struct task_struct *p;
764
765 p = kthread_create(worker_thread, cwq, fmt, wq->name, cpu);
766 /*
767 * Nobody can add the work_struct to this cwq,
768 * if (caller is __create_workqueue)
769 * nobody should see this wq
770 * else // caller is CPU_UP_PREPARE
771 * cpu is not on cpu_online_map
772 * so we can abort safely.
773 */
774 if (IS_ERR(p))
775 return PTR_ERR(p);
0d557dc9
HC
776 if (cwq->wq->rt)
777 sched_setscheduler_nocheck(p, SCHED_FIFO, &param);
3af24433 778 cwq->thread = p;
3af24433 779
e1d8aa9f
FW
780 trace_workqueue_creation(cwq->thread, cpu);
781
3af24433
ON
782 return 0;
783}
784
06ba38a9
ON
785static void start_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
786{
787 struct task_struct *p = cwq->thread;
788
789 if (p != NULL) {
790 if (cpu >= 0)
791 kthread_bind(p, cpu);
792 wake_up_process(p);
793 }
794}
795
4e6045f1
JB
796struct workqueue_struct *__create_workqueue_key(const char *name,
797 int singlethread,
798 int freezeable,
0d557dc9 799 int rt,
eb13ba87
JB
800 struct lock_class_key *key,
801 const char *lock_name)
1da177e4 802{
1da177e4 803 struct workqueue_struct *wq;
3af24433
ON
804 struct cpu_workqueue_struct *cwq;
805 int err = 0, cpu;
1da177e4 806
3af24433
ON
807 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
808 if (!wq)
809 return NULL;
810
811 wq->cpu_wq = alloc_percpu(struct cpu_workqueue_struct);
812 if (!wq->cpu_wq) {
813 kfree(wq);
814 return NULL;
815 }
816
817 wq->name = name;
eb13ba87 818 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
cce1a165 819 wq->singlethread = singlethread;
3af24433 820 wq->freezeable = freezeable;
0d557dc9 821 wq->rt = rt;
cce1a165 822 INIT_LIST_HEAD(&wq->list);
3af24433
ON
823
824 if (singlethread) {
3af24433
ON
825 cwq = init_cpu_workqueue(wq, singlethread_cpu);
826 err = create_workqueue_thread(cwq, singlethread_cpu);
06ba38a9 827 start_workqueue_thread(cwq, -1);
3af24433 828 } else {
3da1c84c 829 cpu_maps_update_begin();
6af8bf3d
ON
830 /*
831 * We must place this wq on list even if the code below fails.
832 * cpu_down(cpu) can remove cpu from cpu_populated_map before
833 * destroy_workqueue() takes the lock, in that case we leak
834 * cwq[cpu]->thread.
835 */
95402b38 836 spin_lock(&workqueue_lock);
3af24433 837 list_add(&wq->list, &workqueues);
95402b38 838 spin_unlock(&workqueue_lock);
6af8bf3d
ON
839 /*
840 * We must initialize cwqs for each possible cpu even if we
841 * are going to call destroy_workqueue() finally. Otherwise
842 * cpu_up() can hit the uninitialized cwq once we drop the
843 * lock.
844 */
3af24433
ON
845 for_each_possible_cpu(cpu) {
846 cwq = init_cpu_workqueue(wq, cpu);
847 if (err || !cpu_online(cpu))
848 continue;
849 err = create_workqueue_thread(cwq, cpu);
06ba38a9 850 start_workqueue_thread(cwq, cpu);
1da177e4 851 }
3da1c84c 852 cpu_maps_update_done();
3af24433
ON
853 }
854
855 if (err) {
856 destroy_workqueue(wq);
857 wq = NULL;
858 }
859 return wq;
860}
4e6045f1 861EXPORT_SYMBOL_GPL(__create_workqueue_key);
1da177e4 862
1e35eaa2 863static void cleanup_workqueue_thread(struct cpu_workqueue_struct *cwq)
3af24433 864{
14441960 865 /*
3da1c84c
ON
866 * Our caller is either destroy_workqueue() or CPU_POST_DEAD,
867 * cpu_add_remove_lock protects cwq->thread.
14441960
ON
868 */
869 if (cwq->thread == NULL)
870 return;
3af24433 871
3295f0ef
IM
872 lock_map_acquire(&cwq->wq->lockdep_map);
873 lock_map_release(&cwq->wq->lockdep_map);
4e6045f1 874
13c22168 875 flush_cpu_workqueue(cwq);
14441960 876 /*
3da1c84c 877 * If the caller is CPU_POST_DEAD and cwq->worklist was not empty,
13c22168
ON
878 * a concurrent flush_workqueue() can insert a barrier after us.
879 * However, in that case run_workqueue() won't return and check
880 * kthread_should_stop() until it flushes all work_struct's.
14441960
ON
881 * When ->worklist becomes empty it is safe to exit because no
882 * more work_structs can be queued on this cwq: flush_workqueue
883 * checks list_empty(), and a "normal" queue_work() can't use
884 * a dead CPU.
885 */
e1d8aa9f 886 trace_workqueue_destruction(cwq->thread);
14441960
ON
887 kthread_stop(cwq->thread);
888 cwq->thread = NULL;
3af24433
ON
889}
890
891/**
892 * destroy_workqueue - safely terminate a workqueue
893 * @wq: target workqueue
894 *
895 * Safely destroy a workqueue. All work currently pending will be done first.
896 */
897void destroy_workqueue(struct workqueue_struct *wq)
898{
e7577c50 899 const struct cpumask *cpu_map = wq_cpu_map(wq);
b1f4ec17 900 int cpu;
3af24433 901
3da1c84c 902 cpu_maps_update_begin();
95402b38 903 spin_lock(&workqueue_lock);
b1f4ec17 904 list_del(&wq->list);
95402b38 905 spin_unlock(&workqueue_lock);
3af24433 906
aa85ea5b 907 for_each_cpu(cpu, cpu_map)
1e35eaa2 908 cleanup_workqueue_thread(per_cpu_ptr(wq->cpu_wq, cpu));
3da1c84c 909 cpu_maps_update_done();
9b41ea72 910
3af24433
ON
911 free_percpu(wq->cpu_wq);
912 kfree(wq);
913}
914EXPORT_SYMBOL_GPL(destroy_workqueue);
915
916static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
917 unsigned long action,
918 void *hcpu)
919{
920 unsigned int cpu = (unsigned long)hcpu;
921 struct cpu_workqueue_struct *cwq;
922 struct workqueue_struct *wq;
8448502c 923 int ret = NOTIFY_OK;
3af24433 924
8bb78442
RW
925 action &= ~CPU_TASKS_FROZEN;
926
3af24433 927 switch (action) {
3af24433 928 case CPU_UP_PREPARE:
e7577c50 929 cpumask_set_cpu(cpu, cpu_populated_map);
3af24433 930 }
8448502c 931undo:
3af24433
ON
932 list_for_each_entry(wq, &workqueues, list) {
933 cwq = per_cpu_ptr(wq->cpu_wq, cpu);
934
935 switch (action) {
936 case CPU_UP_PREPARE:
937 if (!create_workqueue_thread(cwq, cpu))
938 break;
95402b38
GS
939 printk(KERN_ERR "workqueue [%s] for %i failed\n",
940 wq->name, cpu);
8448502c
ON
941 action = CPU_UP_CANCELED;
942 ret = NOTIFY_BAD;
943 goto undo;
3af24433
ON
944
945 case CPU_ONLINE:
06ba38a9 946 start_workqueue_thread(cwq, cpu);
3af24433
ON
947 break;
948
949 case CPU_UP_CANCELED:
06ba38a9 950 start_workqueue_thread(cwq, -1);
3da1c84c 951 case CPU_POST_DEAD:
1e35eaa2 952 cleanup_workqueue_thread(cwq);
3af24433
ON
953 break;
954 }
1da177e4
LT
955 }
956
00dfcaf7
ON
957 switch (action) {
958 case CPU_UP_CANCELED:
3da1c84c 959 case CPU_POST_DEAD:
e7577c50 960 cpumask_clear_cpu(cpu, cpu_populated_map);
00dfcaf7
ON
961 }
962
8448502c 963 return ret;
1da177e4 964}
1da177e4 965
2d3854a3 966#ifdef CONFIG_SMP
8ccad40d 967
2d3854a3 968struct work_for_cpu {
6b44003e 969 struct completion completion;
2d3854a3
RR
970 long (*fn)(void *);
971 void *arg;
972 long ret;
973};
974
6b44003e 975static int do_work_for_cpu(void *_wfc)
2d3854a3 976{
6b44003e 977 struct work_for_cpu *wfc = _wfc;
2d3854a3 978 wfc->ret = wfc->fn(wfc->arg);
6b44003e
AM
979 complete(&wfc->completion);
980 return 0;
2d3854a3
RR
981}
982
983/**
984 * work_on_cpu - run a function in user context on a particular cpu
985 * @cpu: the cpu to run on
986 * @fn: the function to run
987 * @arg: the function arg
988 *
31ad9081
RR
989 * This will return the value @fn returns.
990 * It is up to the caller to ensure that the cpu doesn't go offline.
6b44003e 991 * The caller must not hold any locks which would prevent @fn from completing.
2d3854a3
RR
992 */
993long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
994{
6b44003e
AM
995 struct task_struct *sub_thread;
996 struct work_for_cpu wfc = {
997 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
998 .fn = fn,
999 .arg = arg,
1000 };
1001
1002 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
1003 if (IS_ERR(sub_thread))
1004 return PTR_ERR(sub_thread);
1005 kthread_bind(sub_thread, cpu);
1006 wake_up_process(sub_thread);
1007 wait_for_completion(&wfc.completion);
2d3854a3
RR
1008 return wfc.ret;
1009}
1010EXPORT_SYMBOL_GPL(work_on_cpu);
1011#endif /* CONFIG_SMP */
1012
c12920d1 1013void __init init_workqueues(void)
1da177e4 1014{
e7577c50
RR
1015 alloc_cpumask_var(&cpu_populated_map, GFP_KERNEL);
1016
1017 cpumask_copy(cpu_populated_map, cpu_online_mask);
1018 singlethread_cpu = cpumask_first(cpu_possible_mask);
1019 cpu_singlethread_map = cpumask_of(singlethread_cpu);
1da177e4
LT
1020 hotcpu_notifier(workqueue_cpu_callback, 0);
1021 keventd_wq = create_workqueue("events");
1022 BUG_ON(!keventd_wq);
1023}
This page took 0.660431 seconds and 5 git commands to generate.