workqueue: temporarily remove workqueue tracing
[linux-2.6.git] / kernel / workqueue.c
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
13  *   Kai Petzke <wpp@marie.physik.tu-berlin.de>
14  *   Theodore Ts'o <tytso@mit.edu>
15  *
16  * Made to use alloc_percpu by Christoph Lameter.
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>
30 #include <linux/hardirq.h>
31 #include <linux/mempolicy.h>
32 #include <linux/freezer.h>
33 #include <linux/kallsyms.h>
34 #include <linux/debug_locks.h>
35 #include <linux/lockdep.h>
36
37 /*
38  * Structure fields follow one of the following exclusion rules.
39  *
40  * I: Set during initialization and read-only afterwards.
41  *
42  * L: cwq->lock protected.  Access with cwq->lock held.
43  *
44  * W: workqueue_lock protected.
45  */
46
47 /*
48  * The per-CPU workqueue (if single thread, we always use the first
49  * possible cpu).
50  */
51 struct cpu_workqueue_struct {
52
53         spinlock_t lock;
54
55         struct list_head worklist;
56         wait_queue_head_t more_work;
57         struct work_struct *current_work;
58
59         struct workqueue_struct *wq;            /* I: the owning workqueue */
60         struct task_struct      *thread;
61 } ____cacheline_aligned;
62
63 /*
64  * The externally visible workqueue abstraction is an array of
65  * per-CPU workqueues:
66  */
67 struct workqueue_struct {
68         unsigned int            flags;          /* I: WQ_* flags */
69         struct cpu_workqueue_struct *cpu_wq;    /* I: cwq's */
70         struct list_head        list;           /* W: list of all workqueues */
71         const char              *name;          /* I: workqueue name */
72 #ifdef CONFIG_LOCKDEP
73         struct lockdep_map      lockdep_map;
74 #endif
75 };
76
77 #ifdef CONFIG_DEBUG_OBJECTS_WORK
78
79 static struct debug_obj_descr work_debug_descr;
80
81 /*
82  * fixup_init is called when:
83  * - an active object is initialized
84  */
85 static int work_fixup_init(void *addr, enum debug_obj_state state)
86 {
87         struct work_struct *work = addr;
88
89         switch (state) {
90         case ODEBUG_STATE_ACTIVE:
91                 cancel_work_sync(work);
92                 debug_object_init(work, &work_debug_descr);
93                 return 1;
94         default:
95                 return 0;
96         }
97 }
98
99 /*
100  * fixup_activate is called when:
101  * - an active object is activated
102  * - an unknown object is activated (might be a statically initialized object)
103  */
104 static int work_fixup_activate(void *addr, enum debug_obj_state state)
105 {
106         struct work_struct *work = addr;
107
108         switch (state) {
109
110         case ODEBUG_STATE_NOTAVAILABLE:
111                 /*
112                  * This is not really a fixup. The work struct was
113                  * statically initialized. We just make sure that it
114                  * is tracked in the object tracker.
115                  */
116                 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
117                         debug_object_init(work, &work_debug_descr);
118                         debug_object_activate(work, &work_debug_descr);
119                         return 0;
120                 }
121                 WARN_ON_ONCE(1);
122                 return 0;
123
124         case ODEBUG_STATE_ACTIVE:
125                 WARN_ON(1);
126
127         default:
128                 return 0;
129         }
130 }
131
132 /*
133  * fixup_free is called when:
134  * - an active object is freed
135  */
136 static int work_fixup_free(void *addr, enum debug_obj_state state)
137 {
138         struct work_struct *work = addr;
139
140         switch (state) {
141         case ODEBUG_STATE_ACTIVE:
142                 cancel_work_sync(work);
143                 debug_object_free(work, &work_debug_descr);
144                 return 1;
145         default:
146                 return 0;
147         }
148 }
149
150 static struct debug_obj_descr work_debug_descr = {
151         .name           = "work_struct",
152         .fixup_init     = work_fixup_init,
153         .fixup_activate = work_fixup_activate,
154         .fixup_free     = work_fixup_free,
155 };
156
157 static inline void debug_work_activate(struct work_struct *work)
158 {
159         debug_object_activate(work, &work_debug_descr);
160 }
161
162 static inline void debug_work_deactivate(struct work_struct *work)
163 {
164         debug_object_deactivate(work, &work_debug_descr);
165 }
166
167 void __init_work(struct work_struct *work, int onstack)
168 {
169         if (onstack)
170                 debug_object_init_on_stack(work, &work_debug_descr);
171         else
172                 debug_object_init(work, &work_debug_descr);
173 }
174 EXPORT_SYMBOL_GPL(__init_work);
175
176 void destroy_work_on_stack(struct work_struct *work)
177 {
178         debug_object_free(work, &work_debug_descr);
179 }
180 EXPORT_SYMBOL_GPL(destroy_work_on_stack);
181
182 #else
183 static inline void debug_work_activate(struct work_struct *work) { }
184 static inline void debug_work_deactivate(struct work_struct *work) { }
185 #endif
186
187 /* Serializes the accesses to the list of workqueues. */
188 static DEFINE_SPINLOCK(workqueue_lock);
189 static LIST_HEAD(workqueues);
190
191 static int singlethread_cpu __read_mostly;
192 static const struct cpumask *cpu_singlethread_map __read_mostly;
193 /*
194  * _cpu_down() first removes CPU from cpu_online_map, then CPU_DEAD
195  * flushes cwq->worklist. This means that flush_workqueue/wait_on_work
196  * which comes in between can't use for_each_online_cpu(). We could
197  * use cpu_possible_map, the cpumask below is more a documentation
198  * than optimization.
199  */
200 static cpumask_var_t cpu_populated_map __read_mostly;
201
202 /* If it's single threaded, it isn't in the list of workqueues. */
203 static inline bool is_wq_single_threaded(struct workqueue_struct *wq)
204 {
205         return wq->flags & WQ_SINGLE_THREAD;
206 }
207
208 static const struct cpumask *wq_cpu_map(struct workqueue_struct *wq)
209 {
210         return is_wq_single_threaded(wq)
211                 ? cpu_singlethread_map : cpu_populated_map;
212 }
213
214 static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
215                                             struct workqueue_struct *wq)
216 {
217         if (unlikely(is_wq_single_threaded(wq)))
218                 cpu = singlethread_cpu;
219         return per_cpu_ptr(wq->cpu_wq, cpu);
220 }
221
222 /*
223  * Set the workqueue on which a work item is to be run
224  * - Must *only* be called if the pending flag is set
225  */
226 static inline void set_wq_data(struct work_struct *work,
227                                struct cpu_workqueue_struct *cwq,
228                                unsigned long extra_flags)
229 {
230         BUG_ON(!work_pending(work));
231
232         atomic_long_set(&work->data, (unsigned long)cwq | work_static(work) |
233                         WORK_STRUCT_PENDING | extra_flags);
234 }
235
236 /*
237  * Clear WORK_STRUCT_PENDING and the workqueue on which it was queued.
238  */
239 static inline void clear_wq_data(struct work_struct *work)
240 {
241         atomic_long_set(&work->data, work_static(work));
242 }
243
244 static inline struct cpu_workqueue_struct *get_wq_data(struct work_struct *work)
245 {
246         return (void *)(atomic_long_read(&work->data) &
247                         WORK_STRUCT_WQ_DATA_MASK);
248 }
249
250 /**
251  * insert_work - insert a work into cwq
252  * @cwq: cwq @work belongs to
253  * @work: work to insert
254  * @head: insertion point
255  * @extra_flags: extra WORK_STRUCT_* flags to set
256  *
257  * Insert @work into @cwq after @head.
258  *
259  * CONTEXT:
260  * spin_lock_irq(cwq->lock).
261  */
262 static void insert_work(struct cpu_workqueue_struct *cwq,
263                         struct work_struct *work, struct list_head *head,
264                         unsigned int extra_flags)
265 {
266         /* we own @work, set data and link */
267         set_wq_data(work, cwq, extra_flags);
268
269         /*
270          * Ensure that we get the right work->data if we see the
271          * result of list_add() below, see try_to_grab_pending().
272          */
273         smp_wmb();
274
275         list_add_tail(&work->entry, head);
276         wake_up(&cwq->more_work);
277 }
278
279 static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
280                          struct work_struct *work)
281 {
282         struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
283         unsigned long flags;
284
285         debug_work_activate(work);
286         spin_lock_irqsave(&cwq->lock, flags);
287         BUG_ON(!list_empty(&work->entry));
288         insert_work(cwq, work, &cwq->worklist, 0);
289         spin_unlock_irqrestore(&cwq->lock, flags);
290 }
291
292 /**
293  * queue_work - queue work on a workqueue
294  * @wq: workqueue to use
295  * @work: work to queue
296  *
297  * Returns 0 if @work was already on a queue, non-zero otherwise.
298  *
299  * We queue the work to the CPU on which it was submitted, but if the CPU dies
300  * it can be processed by another CPU.
301  */
302 int queue_work(struct workqueue_struct *wq, struct work_struct *work)
303 {
304         int ret;
305
306         ret = queue_work_on(get_cpu(), wq, work);
307         put_cpu();
308
309         return ret;
310 }
311 EXPORT_SYMBOL_GPL(queue_work);
312
313 /**
314  * queue_work_on - queue work on specific cpu
315  * @cpu: CPU number to execute work on
316  * @wq: workqueue to use
317  * @work: work to queue
318  *
319  * Returns 0 if @work was already on a queue, non-zero otherwise.
320  *
321  * We queue the work to a specific CPU, the caller must ensure it
322  * can't go away.
323  */
324 int
325 queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
326 {
327         int ret = 0;
328
329         if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
330                 __queue_work(cpu, wq, work);
331                 ret = 1;
332         }
333         return ret;
334 }
335 EXPORT_SYMBOL_GPL(queue_work_on);
336
337 static void delayed_work_timer_fn(unsigned long __data)
338 {
339         struct delayed_work *dwork = (struct delayed_work *)__data;
340         struct cpu_workqueue_struct *cwq = get_wq_data(&dwork->work);
341
342         __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
343 }
344
345 /**
346  * queue_delayed_work - queue work on a workqueue after delay
347  * @wq: workqueue to use
348  * @dwork: delayable work to queue
349  * @delay: number of jiffies to wait before queueing
350  *
351  * Returns 0 if @work was already on a queue, non-zero otherwise.
352  */
353 int queue_delayed_work(struct workqueue_struct *wq,
354                         struct delayed_work *dwork, unsigned long delay)
355 {
356         if (delay == 0)
357                 return queue_work(wq, &dwork->work);
358
359         return queue_delayed_work_on(-1, wq, dwork, delay);
360 }
361 EXPORT_SYMBOL_GPL(queue_delayed_work);
362
363 /**
364  * queue_delayed_work_on - queue work on specific CPU after delay
365  * @cpu: CPU number to execute work on
366  * @wq: workqueue to use
367  * @dwork: work to queue
368  * @delay: number of jiffies to wait before queueing
369  *
370  * Returns 0 if @work was already on a queue, non-zero otherwise.
371  */
372 int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
373                         struct delayed_work *dwork, unsigned long delay)
374 {
375         int ret = 0;
376         struct timer_list *timer = &dwork->timer;
377         struct work_struct *work = &dwork->work;
378
379         if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
380                 BUG_ON(timer_pending(timer));
381                 BUG_ON(!list_empty(&work->entry));
382
383                 timer_stats_timer_set_start_info(&dwork->timer);
384
385                 /* This stores cwq for the moment, for the timer_fn */
386                 set_wq_data(work, get_cwq(raw_smp_processor_id(), wq), 0);
387                 timer->expires = jiffies + delay;
388                 timer->data = (unsigned long)dwork;
389                 timer->function = delayed_work_timer_fn;
390
391                 if (unlikely(cpu >= 0))
392                         add_timer_on(timer, cpu);
393                 else
394                         add_timer(timer);
395                 ret = 1;
396         }
397         return ret;
398 }
399 EXPORT_SYMBOL_GPL(queue_delayed_work_on);
400
401 /**
402  * process_one_work - process single work
403  * @cwq: cwq to process work for
404  * @work: work to process
405  *
406  * Process @work.  This function contains all the logics necessary to
407  * process a single work including synchronization against and
408  * interaction with other workers on the same cpu, queueing and
409  * flushing.  As long as context requirement is met, any worker can
410  * call this function to process a work.
411  *
412  * CONTEXT:
413  * spin_lock_irq(cwq->lock) which is released and regrabbed.
414  */
415 static void process_one_work(struct cpu_workqueue_struct *cwq,
416                              struct work_struct *work)
417 {
418         work_func_t f = work->func;
419 #ifdef CONFIG_LOCKDEP
420         /*
421          * It is permissible to free the struct work_struct from
422          * inside the function that is called from it, this we need to
423          * take into account for lockdep too.  To avoid bogus "held
424          * lock freed" warnings as well as problems when looking into
425          * work->lockdep_map, make a copy and use that here.
426          */
427         struct lockdep_map lockdep_map = work->lockdep_map;
428 #endif
429         /* claim and process */
430         debug_work_deactivate(work);
431         cwq->current_work = work;
432         list_del_init(&work->entry);
433
434         spin_unlock_irq(&cwq->lock);
435
436         BUG_ON(get_wq_data(work) != cwq);
437         work_clear_pending(work);
438         lock_map_acquire(&cwq->wq->lockdep_map);
439         lock_map_acquire(&lockdep_map);
440         f(work);
441         lock_map_release(&lockdep_map);
442         lock_map_release(&cwq->wq->lockdep_map);
443
444         if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
445                 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
446                        "%s/0x%08x/%d\n",
447                        current->comm, preempt_count(), task_pid_nr(current));
448                 printk(KERN_ERR "    last function: ");
449                 print_symbol("%s\n", (unsigned long)f);
450                 debug_show_held_locks(current);
451                 dump_stack();
452         }
453
454         spin_lock_irq(&cwq->lock);
455
456         /* we're done with it, release */
457         cwq->current_work = NULL;
458 }
459
460 static void run_workqueue(struct cpu_workqueue_struct *cwq)
461 {
462         spin_lock_irq(&cwq->lock);
463         while (!list_empty(&cwq->worklist)) {
464                 struct work_struct *work = list_entry(cwq->worklist.next,
465                                                 struct work_struct, entry);
466                 process_one_work(cwq, work);
467         }
468         spin_unlock_irq(&cwq->lock);
469 }
470
471 /**
472  * worker_thread - the worker thread function
473  * @__cwq: cwq to serve
474  *
475  * The cwq worker thread function.
476  */
477 static int worker_thread(void *__cwq)
478 {
479         struct cpu_workqueue_struct *cwq = __cwq;
480         DEFINE_WAIT(wait);
481
482         if (cwq->wq->flags & WQ_FREEZEABLE)
483                 set_freezable();
484
485         for (;;) {
486                 prepare_to_wait(&cwq->more_work, &wait, TASK_INTERRUPTIBLE);
487                 if (!freezing(current) &&
488                     !kthread_should_stop() &&
489                     list_empty(&cwq->worklist))
490                         schedule();
491                 finish_wait(&cwq->more_work, &wait);
492
493                 try_to_freeze();
494
495                 if (kthread_should_stop())
496                         break;
497
498                 run_workqueue(cwq);
499         }
500
501         return 0;
502 }
503
504 struct wq_barrier {
505         struct work_struct      work;
506         struct completion       done;
507 };
508
509 static void wq_barrier_func(struct work_struct *work)
510 {
511         struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
512         complete(&barr->done);
513 }
514
515 /**
516  * insert_wq_barrier - insert a barrier work
517  * @cwq: cwq to insert barrier into
518  * @barr: wq_barrier to insert
519  * @head: insertion point
520  *
521  * Insert barrier @barr into @cwq before @head.
522  *
523  * CONTEXT:
524  * spin_lock_irq(cwq->lock).
525  */
526 static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
527                         struct wq_barrier *barr, struct list_head *head)
528 {
529         /*
530          * debugobject calls are safe here even with cwq->lock locked
531          * as we know for sure that this will not trigger any of the
532          * checks and call back into the fixup functions where we
533          * might deadlock.
534          */
535         INIT_WORK_ON_STACK(&barr->work, wq_barrier_func);
536         __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
537         init_completion(&barr->done);
538
539         debug_work_activate(&barr->work);
540         insert_work(cwq, &barr->work, head, 0);
541 }
542
543 static int flush_cpu_workqueue(struct cpu_workqueue_struct *cwq)
544 {
545         int active = 0;
546         struct wq_barrier barr;
547
548         WARN_ON(cwq->thread == current);
549
550         spin_lock_irq(&cwq->lock);
551         if (!list_empty(&cwq->worklist) || cwq->current_work != NULL) {
552                 insert_wq_barrier(cwq, &barr, &cwq->worklist);
553                 active = 1;
554         }
555         spin_unlock_irq(&cwq->lock);
556
557         if (active) {
558                 wait_for_completion(&barr.done);
559                 destroy_work_on_stack(&barr.work);
560         }
561
562         return active;
563 }
564
565 /**
566  * flush_workqueue - ensure that any scheduled work has run to completion.
567  * @wq: workqueue to flush
568  *
569  * Forces execution of the workqueue and blocks until its completion.
570  * This is typically used in driver shutdown handlers.
571  *
572  * We sleep until all works which were queued on entry have been handled,
573  * but we are not livelocked by new incoming ones.
574  */
575 void flush_workqueue(struct workqueue_struct *wq)
576 {
577         const struct cpumask *cpu_map = wq_cpu_map(wq);
578         int cpu;
579
580         might_sleep();
581         lock_map_acquire(&wq->lockdep_map);
582         lock_map_release(&wq->lockdep_map);
583         for_each_cpu(cpu, cpu_map)
584                 flush_cpu_workqueue(per_cpu_ptr(wq->cpu_wq, cpu));
585 }
586 EXPORT_SYMBOL_GPL(flush_workqueue);
587
588 /**
589  * flush_work - block until a work_struct's callback has terminated
590  * @work: the work which is to be flushed
591  *
592  * Returns false if @work has already terminated.
593  *
594  * It is expected that, prior to calling flush_work(), the caller has
595  * arranged for the work to not be requeued, otherwise it doesn't make
596  * sense to use this function.
597  */
598 int flush_work(struct work_struct *work)
599 {
600         struct cpu_workqueue_struct *cwq;
601         struct list_head *prev;
602         struct wq_barrier barr;
603
604         might_sleep();
605         cwq = get_wq_data(work);
606         if (!cwq)
607                 return 0;
608
609         lock_map_acquire(&cwq->wq->lockdep_map);
610         lock_map_release(&cwq->wq->lockdep_map);
611
612         spin_lock_irq(&cwq->lock);
613         if (!list_empty(&work->entry)) {
614                 /*
615                  * See the comment near try_to_grab_pending()->smp_rmb().
616                  * If it was re-queued under us we are not going to wait.
617                  */
618                 smp_rmb();
619                 if (unlikely(cwq != get_wq_data(work)))
620                         goto already_gone;
621                 prev = &work->entry;
622         } else {
623                 if (cwq->current_work != work)
624                         goto already_gone;
625                 prev = &cwq->worklist;
626         }
627         insert_wq_barrier(cwq, &barr, prev->next);
628
629         spin_unlock_irq(&cwq->lock);
630         wait_for_completion(&barr.done);
631         destroy_work_on_stack(&barr.work);
632         return 1;
633 already_gone:
634         spin_unlock_irq(&cwq->lock);
635         return 0;
636 }
637 EXPORT_SYMBOL_GPL(flush_work);
638
639 /*
640  * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
641  * so this work can't be re-armed in any way.
642  */
643 static int try_to_grab_pending(struct work_struct *work)
644 {
645         struct cpu_workqueue_struct *cwq;
646         int ret = -1;
647
648         if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
649                 return 0;
650
651         /*
652          * The queueing is in progress, or it is already queued. Try to
653          * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
654          */
655
656         cwq = get_wq_data(work);
657         if (!cwq)
658                 return ret;
659
660         spin_lock_irq(&cwq->lock);
661         if (!list_empty(&work->entry)) {
662                 /*
663                  * This work is queued, but perhaps we locked the wrong cwq.
664                  * In that case we must see the new value after rmb(), see
665                  * insert_work()->wmb().
666                  */
667                 smp_rmb();
668                 if (cwq == get_wq_data(work)) {
669                         debug_work_deactivate(work);
670                         list_del_init(&work->entry);
671                         ret = 1;
672                 }
673         }
674         spin_unlock_irq(&cwq->lock);
675
676         return ret;
677 }
678
679 static void wait_on_cpu_work(struct cpu_workqueue_struct *cwq,
680                                 struct work_struct *work)
681 {
682         struct wq_barrier barr;
683         int running = 0;
684
685         spin_lock_irq(&cwq->lock);
686         if (unlikely(cwq->current_work == work)) {
687                 insert_wq_barrier(cwq, &barr, cwq->worklist.next);
688                 running = 1;
689         }
690         spin_unlock_irq(&cwq->lock);
691
692         if (unlikely(running)) {
693                 wait_for_completion(&barr.done);
694                 destroy_work_on_stack(&barr.work);
695         }
696 }
697
698 static void wait_on_work(struct work_struct *work)
699 {
700         struct cpu_workqueue_struct *cwq;
701         struct workqueue_struct *wq;
702         const struct cpumask *cpu_map;
703         int cpu;
704
705         might_sleep();
706
707         lock_map_acquire(&work->lockdep_map);
708         lock_map_release(&work->lockdep_map);
709
710         cwq = get_wq_data(work);
711         if (!cwq)
712                 return;
713
714         wq = cwq->wq;
715         cpu_map = wq_cpu_map(wq);
716
717         for_each_cpu(cpu, cpu_map)
718                 wait_on_cpu_work(get_cwq(cpu, wq), work);
719 }
720
721 static int __cancel_work_timer(struct work_struct *work,
722                                 struct timer_list* timer)
723 {
724         int ret;
725
726         do {
727                 ret = (timer && likely(del_timer(timer)));
728                 if (!ret)
729                         ret = try_to_grab_pending(work);
730                 wait_on_work(work);
731         } while (unlikely(ret < 0));
732
733         clear_wq_data(work);
734         return ret;
735 }
736
737 /**
738  * cancel_work_sync - block until a work_struct's callback has terminated
739  * @work: the work which is to be flushed
740  *
741  * Returns true if @work was pending.
742  *
743  * cancel_work_sync() will cancel the work if it is queued. If the work's
744  * callback appears to be running, cancel_work_sync() will block until it
745  * has completed.
746  *
747  * It is possible to use this function if the work re-queues itself. It can
748  * cancel the work even if it migrates to another workqueue, however in that
749  * case it only guarantees that work->func() has completed on the last queued
750  * workqueue.
751  *
752  * cancel_work_sync(&delayed_work->work) should be used only if ->timer is not
753  * pending, otherwise it goes into a busy-wait loop until the timer expires.
754  *
755  * The caller must ensure that workqueue_struct on which this work was last
756  * queued can't be destroyed before this function returns.
757  */
758 int cancel_work_sync(struct work_struct *work)
759 {
760         return __cancel_work_timer(work, NULL);
761 }
762 EXPORT_SYMBOL_GPL(cancel_work_sync);
763
764 /**
765  * cancel_delayed_work_sync - reliably kill off a delayed work.
766  * @dwork: the delayed work struct
767  *
768  * Returns true if @dwork was pending.
769  *
770  * It is possible to use this function if @dwork rearms itself via queue_work()
771  * or queue_delayed_work(). See also the comment for cancel_work_sync().
772  */
773 int cancel_delayed_work_sync(struct delayed_work *dwork)
774 {
775         return __cancel_work_timer(&dwork->work, &dwork->timer);
776 }
777 EXPORT_SYMBOL(cancel_delayed_work_sync);
778
779 static struct workqueue_struct *keventd_wq __read_mostly;
780
781 /**
782  * schedule_work - put work task in global workqueue
783  * @work: job to be done
784  *
785  * Returns zero if @work was already on the kernel-global workqueue and
786  * non-zero otherwise.
787  *
788  * This puts a job in the kernel-global workqueue if it was not already
789  * queued and leaves it in the same position on the kernel-global
790  * workqueue otherwise.
791  */
792 int schedule_work(struct work_struct *work)
793 {
794         return queue_work(keventd_wq, work);
795 }
796 EXPORT_SYMBOL(schedule_work);
797
798 /*
799  * schedule_work_on - put work task on a specific cpu
800  * @cpu: cpu to put the work task on
801  * @work: job to be done
802  *
803  * This puts a job on a specific cpu
804  */
805 int schedule_work_on(int cpu, struct work_struct *work)
806 {
807         return queue_work_on(cpu, keventd_wq, work);
808 }
809 EXPORT_SYMBOL(schedule_work_on);
810
811 /**
812  * schedule_delayed_work - put work task in global workqueue after delay
813  * @dwork: job to be done
814  * @delay: number of jiffies to wait or 0 for immediate execution
815  *
816  * After waiting for a given time this puts a job in the kernel-global
817  * workqueue.
818  */
819 int schedule_delayed_work(struct delayed_work *dwork,
820                                         unsigned long delay)
821 {
822         return queue_delayed_work(keventd_wq, dwork, delay);
823 }
824 EXPORT_SYMBOL(schedule_delayed_work);
825
826 /**
827  * flush_delayed_work - block until a dwork_struct's callback has terminated
828  * @dwork: the delayed work which is to be flushed
829  *
830  * Any timeout is cancelled, and any pending work is run immediately.
831  */
832 void flush_delayed_work(struct delayed_work *dwork)
833 {
834         if (del_timer_sync(&dwork->timer)) {
835                 __queue_work(get_cpu(), get_wq_data(&dwork->work)->wq,
836                              &dwork->work);
837                 put_cpu();
838         }
839         flush_work(&dwork->work);
840 }
841 EXPORT_SYMBOL(flush_delayed_work);
842
843 /**
844  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
845  * @cpu: cpu to use
846  * @dwork: job to be done
847  * @delay: number of jiffies to wait
848  *
849  * After waiting for a given time this puts a job in the kernel-global
850  * workqueue on the specified CPU.
851  */
852 int schedule_delayed_work_on(int cpu,
853                         struct delayed_work *dwork, unsigned long delay)
854 {
855         return queue_delayed_work_on(cpu, keventd_wq, dwork, delay);
856 }
857 EXPORT_SYMBOL(schedule_delayed_work_on);
858
859 /**
860  * schedule_on_each_cpu - call a function on each online CPU from keventd
861  * @func: the function to call
862  *
863  * Returns zero on success.
864  * Returns -ve errno on failure.
865  *
866  * schedule_on_each_cpu() is very slow.
867  */
868 int schedule_on_each_cpu(work_func_t func)
869 {
870         int cpu;
871         int orig = -1;
872         struct work_struct *works;
873
874         works = alloc_percpu(struct work_struct);
875         if (!works)
876                 return -ENOMEM;
877
878         get_online_cpus();
879
880         /*
881          * When running in keventd don't schedule a work item on
882          * itself.  Can just call directly because the work queue is
883          * already bound.  This also is faster.
884          */
885         if (current_is_keventd())
886                 orig = raw_smp_processor_id();
887
888         for_each_online_cpu(cpu) {
889                 struct work_struct *work = per_cpu_ptr(works, cpu);
890
891                 INIT_WORK(work, func);
892                 if (cpu != orig)
893                         schedule_work_on(cpu, work);
894         }
895         if (orig >= 0)
896                 func(per_cpu_ptr(works, orig));
897
898         for_each_online_cpu(cpu)
899                 flush_work(per_cpu_ptr(works, cpu));
900
901         put_online_cpus();
902         free_percpu(works);
903         return 0;
904 }
905
906 /**
907  * flush_scheduled_work - ensure that any scheduled work has run to completion.
908  *
909  * Forces execution of the kernel-global workqueue and blocks until its
910  * completion.
911  *
912  * Think twice before calling this function!  It's very easy to get into
913  * trouble if you don't take great care.  Either of the following situations
914  * will lead to deadlock:
915  *
916  *      One of the work items currently on the workqueue needs to acquire
917  *      a lock held by your code or its caller.
918  *
919  *      Your code is running in the context of a work routine.
920  *
921  * They will be detected by lockdep when they occur, but the first might not
922  * occur very often.  It depends on what work items are on the workqueue and
923  * what locks they need, which you have no control over.
924  *
925  * In most situations flushing the entire workqueue is overkill; you merely
926  * need to know that a particular work item isn't queued and isn't running.
927  * In such cases you should use cancel_delayed_work_sync() or
928  * cancel_work_sync() instead.
929  */
930 void flush_scheduled_work(void)
931 {
932         flush_workqueue(keventd_wq);
933 }
934 EXPORT_SYMBOL(flush_scheduled_work);
935
936 /**
937  * execute_in_process_context - reliably execute the routine with user context
938  * @fn:         the function to execute
939  * @ew:         guaranteed storage for the execute work structure (must
940  *              be available when the work executes)
941  *
942  * Executes the function immediately if process context is available,
943  * otherwise schedules the function for delayed execution.
944  *
945  * Returns:     0 - function was executed
946  *              1 - function was scheduled for execution
947  */
948 int execute_in_process_context(work_func_t fn, struct execute_work *ew)
949 {
950         if (!in_interrupt()) {
951                 fn(&ew->work);
952                 return 0;
953         }
954
955         INIT_WORK(&ew->work, fn);
956         schedule_work(&ew->work);
957
958         return 1;
959 }
960 EXPORT_SYMBOL_GPL(execute_in_process_context);
961
962 int keventd_up(void)
963 {
964         return keventd_wq != NULL;
965 }
966
967 int current_is_keventd(void)
968 {
969         struct cpu_workqueue_struct *cwq;
970         int cpu = raw_smp_processor_id(); /* preempt-safe: keventd is per-cpu */
971         int ret = 0;
972
973         BUG_ON(!keventd_wq);
974
975         cwq = per_cpu_ptr(keventd_wq->cpu_wq, cpu);
976         if (current == cwq->thread)
977                 ret = 1;
978
979         return ret;
980
981 }
982
983 static struct cpu_workqueue_struct *
984 init_cpu_workqueue(struct workqueue_struct *wq, int cpu)
985 {
986         struct cpu_workqueue_struct *cwq = per_cpu_ptr(wq->cpu_wq, cpu);
987
988         cwq->wq = wq;
989         spin_lock_init(&cwq->lock);
990         INIT_LIST_HEAD(&cwq->worklist);
991         init_waitqueue_head(&cwq->more_work);
992
993         return cwq;
994 }
995
996 static int create_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
997 {
998         struct workqueue_struct *wq = cwq->wq;
999         const char *fmt = is_wq_single_threaded(wq) ? "%s" : "%s/%d";
1000         struct task_struct *p;
1001
1002         p = kthread_create(worker_thread, cwq, fmt, wq->name, cpu);
1003         /*
1004          * Nobody can add the work_struct to this cwq,
1005          *      if (caller is __create_workqueue)
1006          *              nobody should see this wq
1007          *      else // caller is CPU_UP_PREPARE
1008          *              cpu is not on cpu_online_map
1009          * so we can abort safely.
1010          */
1011         if (IS_ERR(p))
1012                 return PTR_ERR(p);
1013         cwq->thread = p;
1014
1015         return 0;
1016 }
1017
1018 static void start_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
1019 {
1020         struct task_struct *p = cwq->thread;
1021
1022         if (p != NULL) {
1023                 if (cpu >= 0)
1024                         kthread_bind(p, cpu);
1025                 wake_up_process(p);
1026         }
1027 }
1028
1029 struct workqueue_struct *__create_workqueue_key(const char *name,
1030                                                 unsigned int flags,
1031                                                 struct lock_class_key *key,
1032                                                 const char *lock_name)
1033 {
1034         struct workqueue_struct *wq;
1035         struct cpu_workqueue_struct *cwq;
1036         int err = 0, cpu;
1037
1038         wq = kzalloc(sizeof(*wq), GFP_KERNEL);
1039         if (!wq)
1040                 goto err;
1041
1042         wq->cpu_wq = alloc_percpu(struct cpu_workqueue_struct);
1043         if (!wq->cpu_wq)
1044                 goto err;
1045
1046         wq->flags = flags;
1047         wq->name = name;
1048         lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
1049         INIT_LIST_HEAD(&wq->list);
1050
1051         if (flags & WQ_SINGLE_THREAD) {
1052                 cwq = init_cpu_workqueue(wq, singlethread_cpu);
1053                 err = create_workqueue_thread(cwq, singlethread_cpu);
1054                 start_workqueue_thread(cwq, -1);
1055         } else {
1056                 cpu_maps_update_begin();
1057                 /*
1058                  * We must place this wq on list even if the code below fails.
1059                  * cpu_down(cpu) can remove cpu from cpu_populated_map before
1060                  * destroy_workqueue() takes the lock, in that case we leak
1061                  * cwq[cpu]->thread.
1062                  */
1063                 spin_lock(&workqueue_lock);
1064                 list_add(&wq->list, &workqueues);
1065                 spin_unlock(&workqueue_lock);
1066                 /*
1067                  * We must initialize cwqs for each possible cpu even if we
1068                  * are going to call destroy_workqueue() finally. Otherwise
1069                  * cpu_up() can hit the uninitialized cwq once we drop the
1070                  * lock.
1071                  */
1072                 for_each_possible_cpu(cpu) {
1073                         cwq = init_cpu_workqueue(wq, cpu);
1074                         if (err || !cpu_online(cpu))
1075                                 continue;
1076                         err = create_workqueue_thread(cwq, cpu);
1077                         start_workqueue_thread(cwq, cpu);
1078                 }
1079                 cpu_maps_update_done();
1080         }
1081
1082         if (err) {
1083                 destroy_workqueue(wq);
1084                 wq = NULL;
1085         }
1086         return wq;
1087 err:
1088         if (wq) {
1089                 free_percpu(wq->cpu_wq);
1090                 kfree(wq);
1091         }
1092         return NULL;
1093 }
1094 EXPORT_SYMBOL_GPL(__create_workqueue_key);
1095
1096 static void cleanup_workqueue_thread(struct cpu_workqueue_struct *cwq)
1097 {
1098         /*
1099          * Our caller is either destroy_workqueue() or CPU_POST_DEAD,
1100          * cpu_add_remove_lock protects cwq->thread.
1101          */
1102         if (cwq->thread == NULL)
1103                 return;
1104
1105         lock_map_acquire(&cwq->wq->lockdep_map);
1106         lock_map_release(&cwq->wq->lockdep_map);
1107
1108         flush_cpu_workqueue(cwq);
1109         /*
1110          * If the caller is CPU_POST_DEAD and cwq->worklist was not empty,
1111          * a concurrent flush_workqueue() can insert a barrier after us.
1112          * However, in that case run_workqueue() won't return and check
1113          * kthread_should_stop() until it flushes all work_struct's.
1114          * When ->worklist becomes empty it is safe to exit because no
1115          * more work_structs can be queued on this cwq: flush_workqueue
1116          * checks list_empty(), and a "normal" queue_work() can't use
1117          * a dead CPU.
1118          */
1119         kthread_stop(cwq->thread);
1120         cwq->thread = NULL;
1121 }
1122
1123 /**
1124  * destroy_workqueue - safely terminate a workqueue
1125  * @wq: target workqueue
1126  *
1127  * Safely destroy a workqueue. All work currently pending will be done first.
1128  */
1129 void destroy_workqueue(struct workqueue_struct *wq)
1130 {
1131         const struct cpumask *cpu_map = wq_cpu_map(wq);
1132         int cpu;
1133
1134         cpu_maps_update_begin();
1135         spin_lock(&workqueue_lock);
1136         list_del(&wq->list);
1137         spin_unlock(&workqueue_lock);
1138
1139         for_each_cpu(cpu, cpu_map)
1140                 cleanup_workqueue_thread(per_cpu_ptr(wq->cpu_wq, cpu));
1141         cpu_maps_update_done();
1142
1143         free_percpu(wq->cpu_wq);
1144         kfree(wq);
1145 }
1146 EXPORT_SYMBOL_GPL(destroy_workqueue);
1147
1148 static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
1149                                                 unsigned long action,
1150                                                 void *hcpu)
1151 {
1152         unsigned int cpu = (unsigned long)hcpu;
1153         struct cpu_workqueue_struct *cwq;
1154         struct workqueue_struct *wq;
1155         int err = 0;
1156
1157         action &= ~CPU_TASKS_FROZEN;
1158
1159         switch (action) {
1160         case CPU_UP_PREPARE:
1161                 cpumask_set_cpu(cpu, cpu_populated_map);
1162         }
1163 undo:
1164         list_for_each_entry(wq, &workqueues, list) {
1165                 cwq = per_cpu_ptr(wq->cpu_wq, cpu);
1166
1167                 switch (action) {
1168                 case CPU_UP_PREPARE:
1169                         err = create_workqueue_thread(cwq, cpu);
1170                         if (!err)
1171                                 break;
1172                         printk(KERN_ERR "workqueue [%s] for %i failed\n",
1173                                 wq->name, cpu);
1174                         action = CPU_UP_CANCELED;
1175                         err = -ENOMEM;
1176                         goto undo;
1177
1178                 case CPU_ONLINE:
1179                         start_workqueue_thread(cwq, cpu);
1180                         break;
1181
1182                 case CPU_UP_CANCELED:
1183                         start_workqueue_thread(cwq, -1);
1184                 case CPU_POST_DEAD:
1185                         cleanup_workqueue_thread(cwq);
1186                         break;
1187                 }
1188         }
1189
1190         switch (action) {
1191         case CPU_UP_CANCELED:
1192         case CPU_POST_DEAD:
1193                 cpumask_clear_cpu(cpu, cpu_populated_map);
1194         }
1195
1196         return notifier_from_errno(err);
1197 }
1198
1199 #ifdef CONFIG_SMP
1200
1201 struct work_for_cpu {
1202         struct completion completion;
1203         long (*fn)(void *);
1204         void *arg;
1205         long ret;
1206 };
1207
1208 static int do_work_for_cpu(void *_wfc)
1209 {
1210         struct work_for_cpu *wfc = _wfc;
1211         wfc->ret = wfc->fn(wfc->arg);
1212         complete(&wfc->completion);
1213         return 0;
1214 }
1215
1216 /**
1217  * work_on_cpu - run a function in user context on a particular cpu
1218  * @cpu: the cpu to run on
1219  * @fn: the function to run
1220  * @arg: the function arg
1221  *
1222  * This will return the value @fn returns.
1223  * It is up to the caller to ensure that the cpu doesn't go offline.
1224  * The caller must not hold any locks which would prevent @fn from completing.
1225  */
1226 long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
1227 {
1228         struct task_struct *sub_thread;
1229         struct work_for_cpu wfc = {
1230                 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
1231                 .fn = fn,
1232                 .arg = arg,
1233         };
1234
1235         sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
1236         if (IS_ERR(sub_thread))
1237                 return PTR_ERR(sub_thread);
1238         kthread_bind(sub_thread, cpu);
1239         wake_up_process(sub_thread);
1240         wait_for_completion(&wfc.completion);
1241         return wfc.ret;
1242 }
1243 EXPORT_SYMBOL_GPL(work_on_cpu);
1244 #endif /* CONFIG_SMP */
1245
1246 void __init init_workqueues(void)
1247 {
1248         alloc_cpumask_var(&cpu_populated_map, GFP_KERNEL);
1249
1250         cpumask_copy(cpu_populated_map, cpu_online_mask);
1251         singlethread_cpu = cpumask_first(cpu_possible_mask);
1252         cpu_singlethread_map = cpumask_of(singlethread_cpu);
1253         hotcpu_notifier(workqueue_cpu_callback, 0);
1254         keventd_wq = create_workqueue("events");
1255         BUG_ON(!keventd_wq);
1256 }