blob: f71fb2a089503534eec8d8790f82d9702a3545cc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/kernel/workqueue.c
3 *
4 * Generic mechanism for defining kernel helper threads for running
5 * arbitrary tasks in process context.
6 *
7 * Started by Ingo Molnar, Copyright (C) 2002
8 *
9 * Derived from the taskqueue/keventd code by:
10 *
11 * David Woodhouse <dwmw2@infradead.org>
Francois Camie1f8e872008-10-15 22:01:59 -070012 * Andrew Morton
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
14 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080015 *
Christoph Lametercde53532008-07-04 09:59:22 -070016 * Made to use alloc_percpu by Christoph Lameter.
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18
19#include <linux/module.h>
20#include <linux/kernel.h>
21#include <linux/sched.h>
22#include <linux/init.h>
23#include <linux/signal.h>
24#include <linux/completion.h>
25#include <linux/workqueue.h>
26#include <linux/slab.h>
27#include <linux/cpu.h>
28#include <linux/notifier.h>
29#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060030#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070031#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080032#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080033#include <linux/kallsyms.h>
34#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070035#include <linux/lockdep.h>
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +010036#include <trace/workqueue.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38/*
Nathan Lynchf756d5e2006-01-08 01:05:12 -080039 * The per-CPU workqueue (if single thread, we always use the first
40 * possible cpu).
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 */
42struct cpu_workqueue_struct {
43
44 spinlock_t lock;
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 struct list_head worklist;
47 wait_queue_head_t more_work;
Oleg Nesterov3af244332007-05-09 02:34:09 -070048 struct work_struct *current_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50 struct workqueue_struct *wq;
Ingo Molnar36c8b582006-07-03 00:25:41 -070051 struct task_struct *thread;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052} ____cacheline_aligned;
53
54/*
55 * The externally visible workqueue abstraction is an array of
56 * per-CPU workqueues:
57 */
58struct workqueue_struct {
Christoph Lameter89ada672005-10-30 15:01:59 -080059 struct cpu_workqueue_struct *cpu_wq;
Oleg Nesterovcce1a162007-05-09 02:34:13 -070060 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 const char *name;
Oleg Nesterovcce1a162007-05-09 02:34:13 -070062 int singlethread;
Oleg Nesterov319c2a92007-05-09 02:34:06 -070063 int freezeable; /* Freeze threads during suspend */
Heiko Carstens0d557dc2008-10-13 23:50:09 +020064 int rt;
Johannes Berg4e6045f2007-10-18 23:39:55 -070065#ifdef CONFIG_LOCKDEP
66 struct lockdep_map lockdep_map;
67#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070068};
69
Gautham R Shenoy95402b32008-01-25 21:08:02 +010070/* Serializes the accesses to the list of workqueues. */
71static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072static LIST_HEAD(workqueues);
73
Oleg Nesterov3af244332007-05-09 02:34:09 -070074static int singlethread_cpu __read_mostly;
Rusty Russelle7577c52009-01-01 10:12:25 +103075static const struct cpumask *cpu_singlethread_map __read_mostly;
Oleg Nesterov14441962007-05-23 13:57:57 -070076/*
77 * _cpu_down() first removes CPU from cpu_online_map, then CPU_DEAD
78 * flushes cwq->worklist. This means that flush_workqueue/wait_on_work
79 * which comes in between can't use for_each_online_cpu(). We could
80 * use cpu_possible_map, the cpumask below is more a documentation
81 * than optimization.
82 */
Rusty Russelle7577c52009-01-01 10:12:25 +103083static cpumask_var_t cpu_populated_map __read_mostly;
Nathan Lynchf756d5e2006-01-08 01:05:12 -080084
Linus Torvalds1da177e2005-04-16 15:20:36 -070085/* If it's single threaded, it isn't in the list of workqueues. */
David Howells6cc88bc2008-11-14 10:39:21 +110086static inline int is_wq_single_threaded(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087{
Oleg Nesterovcce1a162007-05-09 02:34:13 -070088 return wq->singlethread;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089}
90
Rusty Russelle7577c52009-01-01 10:12:25 +103091static const struct cpumask *wq_cpu_map(struct workqueue_struct *wq)
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -070092{
David Howells6cc88bc2008-11-14 10:39:21 +110093 return is_wq_single_threaded(wq)
Rusty Russelle7577c52009-01-01 10:12:25 +103094 ? cpu_singlethread_map : cpu_populated_map;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -070095}
96
Oleg Nesterova848e3b2007-05-09 02:34:17 -070097static
98struct cpu_workqueue_struct *wq_per_cpu(struct workqueue_struct *wq, int cpu)
99{
David Howells6cc88bc2008-11-14 10:39:21 +1100100 if (unlikely(is_wq_single_threaded(wq)))
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700101 cpu = singlethread_cpu;
102 return per_cpu_ptr(wq->cpu_wq, cpu);
103}
104
David Howells4594bf12006-12-07 11:33:26 +0000105/*
106 * Set the workqueue on which a work item is to be run
107 * - Must *only* be called if the pending flag is set
108 */
Oleg Nesteroved7c0fe2007-05-09 02:34:16 -0700109static inline void set_wq_data(struct work_struct *work,
110 struct cpu_workqueue_struct *cwq)
David Howells365970a2006-11-22 14:54:49 +0000111{
David Howells4594bf12006-12-07 11:33:26 +0000112 unsigned long new;
David Howells365970a2006-11-22 14:54:49 +0000113
David Howells4594bf12006-12-07 11:33:26 +0000114 BUG_ON(!work_pending(work));
115
Oleg Nesteroved7c0fe2007-05-09 02:34:16 -0700116 new = (unsigned long) cwq | (1UL << WORK_STRUCT_PENDING);
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800117 new |= WORK_STRUCT_FLAG_MASK & *work_data_bits(work);
118 atomic_long_set(&work->data, new);
David Howells365970a2006-11-22 14:54:49 +0000119}
120
Oleg Nesteroved7c0fe2007-05-09 02:34:16 -0700121static inline
122struct cpu_workqueue_struct *get_wq_data(struct work_struct *work)
David Howells365970a2006-11-22 14:54:49 +0000123{
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800124 return (void *) (atomic_long_read(&work->data) & WORK_STRUCT_WQ_DATA_MASK);
David Howells365970a2006-11-22 14:54:49 +0000125}
126
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100127DEFINE_TRACE(workqueue_insertion);
128
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700129static void insert_work(struct cpu_workqueue_struct *cwq,
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700130 struct work_struct *work, struct list_head *head)
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700131{
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100132 trace_workqueue_insertion(cwq->thread, work);
133
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700134 set_wq_data(work, cwq);
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700135 /*
136 * Ensure that we get the right work->data if we see the
137 * result of list_add() below, see try_to_grab_pending().
138 */
139 smp_wmb();
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700140 list_add_tail(&work->entry, head);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700141 wake_up(&cwq->more_work);
142}
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144static void __queue_work(struct cpu_workqueue_struct *cwq,
145 struct work_struct *work)
146{
147 unsigned long flags;
148
149 spin_lock_irqsave(&cwq->lock, flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700150 insert_work(cwq, work, &cwq->worklist);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 spin_unlock_irqrestore(&cwq->lock, flags);
152}
153
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700154/**
155 * queue_work - queue work on a workqueue
156 * @wq: workqueue to use
157 * @work: work to queue
158 *
Alan Stern057647f2006-10-28 10:38:58 -0700159 * Returns 0 if @work was already on a queue, non-zero otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 *
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -0700161 * We queue the work to the CPU on which it was submitted, but if the CPU dies
162 * it can be processed by another CPU.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -0800164int queue_work(struct workqueue_struct *wq, struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
Oleg Nesterovef1ca232008-07-25 01:47:53 -0700166 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Oleg Nesterovef1ca232008-07-25 01:47:53 -0700168 ret = queue_work_on(get_cpu(), wq, work);
169 put_cpu();
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 return ret;
172}
Dave Jonesae90dd52006-06-30 01:40:45 -0400173EXPORT_SYMBOL_GPL(queue_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Zhang Ruic1a220e2008-07-23 21:28:39 -0700175/**
176 * queue_work_on - queue work on specific cpu
177 * @cpu: CPU number to execute work on
178 * @wq: workqueue to use
179 * @work: work to queue
180 *
181 * Returns 0 if @work was already on a queue, non-zero otherwise.
182 *
183 * We queue the work to a specific CPU, the caller must ensure it
184 * can't go away.
185 */
186int
187queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
188{
189 int ret = 0;
190
191 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work))) {
192 BUG_ON(!list_empty(&work->entry));
193 __queue_work(wq_per_cpu(wq, cpu), work);
194 ret = 1;
195 }
196 return ret;
197}
198EXPORT_SYMBOL_GPL(queue_work_on);
199
Li Zefan6d141c32008-02-08 04:21:09 -0800200static void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201{
David Howells52bad642006-11-22 14:54:01 +0000202 struct delayed_work *dwork = (struct delayed_work *)__data;
Oleg Nesteroved7c0fe2007-05-09 02:34:16 -0700203 struct cpu_workqueue_struct *cwq = get_wq_data(&dwork->work);
204 struct workqueue_struct *wq = cwq->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700206 __queue_work(wq_per_cpu(wq, smp_processor_id()), &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207}
208
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700209/**
210 * queue_delayed_work - queue work on a workqueue after delay
211 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800212 * @dwork: delayable work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700213 * @delay: number of jiffies to wait before queueing
214 *
Alan Stern057647f2006-10-28 10:38:58 -0700215 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700216 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -0800217int queue_delayed_work(struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +0000218 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219{
David Howells52bad642006-11-22 14:54:01 +0000220 if (delay == 0)
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700221 return queue_work(wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700223 return queue_delayed_work_on(-1, wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224}
Dave Jonesae90dd52006-06-30 01:40:45 -0400225EXPORT_SYMBOL_GPL(queue_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700227/**
228 * queue_delayed_work_on - queue work on specific CPU after delay
229 * @cpu: CPU number to execute work on
230 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800231 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700232 * @delay: number of jiffies to wait before queueing
233 *
Alan Stern057647f2006-10-28 10:38:58 -0700234 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700235 */
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700236int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +0000237 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700238{
239 int ret = 0;
David Howells52bad642006-11-22 14:54:01 +0000240 struct timer_list *timer = &dwork->timer;
241 struct work_struct *work = &dwork->work;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700242
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800243 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work))) {
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700244 BUG_ON(timer_pending(timer));
245 BUG_ON(!list_empty(&work->entry));
246
Andrew Liu8a3e77c2008-05-01 04:35:14 -0700247 timer_stats_timer_set_start_info(&dwork->timer);
248
Oleg Nesteroved7c0fe2007-05-09 02:34:16 -0700249 /* This stores cwq for the moment, for the timer_fn */
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700250 set_wq_data(work, wq_per_cpu(wq, raw_smp_processor_id()));
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700251 timer->expires = jiffies + delay;
David Howells52bad642006-11-22 14:54:01 +0000252 timer->data = (unsigned long)dwork;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700253 timer->function = delayed_work_timer_fn;
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700254
255 if (unlikely(cpu >= 0))
256 add_timer_on(timer, cpu);
257 else
258 add_timer(timer);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700259 ret = 1;
260 }
261 return ret;
262}
Dave Jonesae90dd52006-06-30 01:40:45 -0400263EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100265DEFINE_TRACE(workqueue_execution);
266
Arjan van de Ven858119e2006-01-14 13:20:43 -0800267static void run_workqueue(struct cpu_workqueue_struct *cwq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268{
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700269 spin_lock_irq(&cwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 while (!list_empty(&cwq->worklist)) {
271 struct work_struct *work = list_entry(cwq->worklist.next,
272 struct work_struct, entry);
David Howells6bb49e52006-11-22 14:54:45 +0000273 work_func_t f = work->func;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700274#ifdef CONFIG_LOCKDEP
275 /*
276 * It is permissible to free the struct work_struct
277 * from inside the function that is called from it,
278 * this we need to take into account for lockdep too.
279 * To avoid bogus "held lock freed" warnings as well
280 * as problems when looking into work->lockdep_map,
281 * make a copy and use that here.
282 */
283 struct lockdep_map lockdep_map = work->lockdep_map;
284#endif
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100285 trace_workqueue_execution(cwq->thread, work);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700286 cwq->current_work = work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 list_del_init(cwq->worklist.next);
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700288 spin_unlock_irq(&cwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
David Howells365970a2006-11-22 14:54:49 +0000290 BUG_ON(get_wq_data(work) != cwq);
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700291 work_clear_pending(work);
Ingo Molnar3295f0e2008-08-11 10:30:30 +0200292 lock_map_acquire(&cwq->wq->lockdep_map);
293 lock_map_acquire(&lockdep_map);
David Howells65f27f32006-11-22 14:55:48 +0000294 f(work);
Ingo Molnar3295f0e2008-08-11 10:30:30 +0200295 lock_map_release(&lockdep_map);
296 lock_map_release(&cwq->wq->lockdep_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Peter Zijlstrad5abe662006-12-06 20:37:26 -0800298 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
299 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
300 "%s/0x%08x/%d\n",
301 current->comm, preempt_count(),
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700302 task_pid_nr(current));
Peter Zijlstrad5abe662006-12-06 20:37:26 -0800303 printk(KERN_ERR " last function: ");
304 print_symbol("%s\n", (unsigned long)f);
305 debug_show_held_locks(current);
306 dump_stack();
307 }
308
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700309 spin_lock_irq(&cwq->lock);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700310 cwq->current_work = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 }
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700312 spin_unlock_irq(&cwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313}
314
315static int worker_thread(void *__cwq)
316{
317 struct cpu_workqueue_struct *cwq = __cwq;
Oleg Nesterov3af244332007-05-09 02:34:09 -0700318 DEFINE_WAIT(wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
Rafael J. Wysocki83144182007-07-17 04:03:35 -0700320 if (cwq->wq->freezeable)
321 set_freezable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323 set_user_nice(current, -5);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
Oleg Nesterov3af244332007-05-09 02:34:09 -0700325 for (;;) {
Oleg Nesterov3af244332007-05-09 02:34:09 -0700326 prepare_to_wait(&cwq->more_work, &wait, TASK_INTERRUPTIBLE);
Oleg Nesterov14441962007-05-23 13:57:57 -0700327 if (!freezing(current) &&
328 !kthread_should_stop() &&
329 list_empty(&cwq->worklist))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 schedule();
Oleg Nesterov3af244332007-05-09 02:34:09 -0700331 finish_wait(&cwq->more_work, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
Oleg Nesterov85f41862007-05-09 02:34:20 -0700333 try_to_freeze();
334
Oleg Nesterov14441962007-05-23 13:57:57 -0700335 if (kthread_should_stop())
Oleg Nesterov3af244332007-05-09 02:34:09 -0700336 break;
337
338 run_workqueue(cwq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 }
Oleg Nesterov3af244332007-05-09 02:34:09 -0700340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 return 0;
342}
343
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -0700344struct wq_barrier {
345 struct work_struct work;
346 struct completion done;
347};
348
349static void wq_barrier_func(struct work_struct *work)
350{
351 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
352 complete(&barr->done);
353}
354
Oleg Nesterov83c22522007-05-09 02:33:54 -0700355static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700356 struct wq_barrier *barr, struct list_head *head)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -0700357{
358 INIT_WORK(&barr->work, wq_barrier_func);
359 __set_bit(WORK_STRUCT_PENDING, work_data_bits(&barr->work));
360
361 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -0700362
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700363 insert_work(cwq, &barr->work, head);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -0700364}
365
Oleg Nesterov14441962007-05-23 13:57:57 -0700366static int flush_cpu_workqueue(struct cpu_workqueue_struct *cwq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367{
Lai Jiangshan2355b702009-04-02 16:58:24 -0700368 int active = 0;
369 struct wq_barrier barr;
Oleg Nesterov14441962007-05-23 13:57:57 -0700370
Lai Jiangshan2355b702009-04-02 16:58:24 -0700371 WARN_ON(cwq->thread == current);
372
373 spin_lock_irq(&cwq->lock);
374 if (!list_empty(&cwq->worklist) || cwq->current_work != NULL) {
375 insert_wq_barrier(cwq, &barr, &cwq->worklist);
Oleg Nesterov14441962007-05-23 13:57:57 -0700376 active = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 }
Lai Jiangshan2355b702009-04-02 16:58:24 -0700378 spin_unlock_irq(&cwq->lock);
379
380 if (active)
381 wait_for_completion(&barr.done);
Oleg Nesterov14441962007-05-23 13:57:57 -0700382
383 return active;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384}
385
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700386/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700388 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 *
390 * Forces execution of the workqueue and blocks until its completion.
391 * This is typically used in driver shutdown handlers.
392 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -0700393 * We sleep until all works which were queued on entry have been handled,
394 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 *
396 * This function used to run the workqueues itself. Now we just wait for the
397 * helper threads to do it.
398 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -0800399void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400{
Rusty Russelle7577c52009-01-01 10:12:25 +1030401 const struct cpumask *cpu_map = wq_cpu_map(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -0700402 int cpu;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -0700403
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700404 might_sleep();
Ingo Molnar3295f0e2008-08-11 10:30:30 +0200405 lock_map_acquire(&wq->lockdep_map);
406 lock_map_release(&wq->lockdep_map);
Rusty Russellaa85ea52009-03-30 22:05:15 -0600407 for_each_cpu(cpu, cpu_map)
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -0700408 flush_cpu_workqueue(per_cpu_ptr(wq->cpu_wq, cpu));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409}
Dave Jonesae90dd52006-06-30 01:40:45 -0400410EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
Oleg Nesterovdb700892008-07-25 01:47:49 -0700412/**
413 * flush_work - block until a work_struct's callback has terminated
414 * @work: the work which is to be flushed
415 *
Oleg Nesterova67da702008-07-25 01:47:52 -0700416 * Returns false if @work has already terminated.
417 *
Oleg Nesterovdb700892008-07-25 01:47:49 -0700418 * It is expected that, prior to calling flush_work(), the caller has
419 * arranged for the work to not be requeued, otherwise it doesn't make
420 * sense to use this function.
421 */
422int flush_work(struct work_struct *work)
423{
424 struct cpu_workqueue_struct *cwq;
425 struct list_head *prev;
426 struct wq_barrier barr;
427
428 might_sleep();
429 cwq = get_wq_data(work);
430 if (!cwq)
431 return 0;
432
Ingo Molnar3295f0e2008-08-11 10:30:30 +0200433 lock_map_acquire(&cwq->wq->lockdep_map);
434 lock_map_release(&cwq->wq->lockdep_map);
Oleg Nesterova67da702008-07-25 01:47:52 -0700435
Oleg Nesterovdb700892008-07-25 01:47:49 -0700436 prev = NULL;
437 spin_lock_irq(&cwq->lock);
438 if (!list_empty(&work->entry)) {
439 /*
440 * See the comment near try_to_grab_pending()->smp_rmb().
441 * If it was re-queued under us we are not going to wait.
442 */
443 smp_rmb();
444 if (unlikely(cwq != get_wq_data(work)))
445 goto out;
446 prev = &work->entry;
447 } else {
448 if (cwq->current_work != work)
449 goto out;
450 prev = &cwq->worklist;
451 }
452 insert_wq_barrier(cwq, &barr, prev->next);
453out:
454 spin_unlock_irq(&cwq->lock);
455 if (!prev)
456 return 0;
457
458 wait_for_completion(&barr.done);
459 return 1;
460}
461EXPORT_SYMBOL_GPL(flush_work);
462
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700463/*
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700464 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700465 * so this work can't be re-armed in any way.
466 */
467static int try_to_grab_pending(struct work_struct *work)
468{
469 struct cpu_workqueue_struct *cwq;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700470 int ret = -1;
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700471
472 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work)))
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700473 return 0;
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700474
475 /*
476 * The queueing is in progress, or it is already queued. Try to
477 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
478 */
479
480 cwq = get_wq_data(work);
481 if (!cwq)
482 return ret;
483
484 spin_lock_irq(&cwq->lock);
485 if (!list_empty(&work->entry)) {
486 /*
487 * This work is queued, but perhaps we locked the wrong cwq.
488 * In that case we must see the new value after rmb(), see
489 * insert_work()->wmb().
490 */
491 smp_rmb();
492 if (cwq == get_wq_data(work)) {
493 list_del_init(&work->entry);
494 ret = 1;
495 }
496 }
497 spin_unlock_irq(&cwq->lock);
498
499 return ret;
500}
501
502static void wait_on_cpu_work(struct cpu_workqueue_struct *cwq,
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700503 struct work_struct *work)
504{
505 struct wq_barrier barr;
506 int running = 0;
507
508 spin_lock_irq(&cwq->lock);
509 if (unlikely(cwq->current_work == work)) {
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700510 insert_wq_barrier(cwq, &barr, cwq->worklist.next);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700511 running = 1;
512 }
513 spin_unlock_irq(&cwq->lock);
514
Oleg Nesterov3af244332007-05-09 02:34:09 -0700515 if (unlikely(running))
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700516 wait_for_completion(&barr.done);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700517}
518
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700519static void wait_on_work(struct work_struct *work)
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700520{
521 struct cpu_workqueue_struct *cwq;
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700522 struct workqueue_struct *wq;
Rusty Russelle7577c52009-01-01 10:12:25 +1030523 const struct cpumask *cpu_map;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -0700524 int cpu;
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700525
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700526 might_sleep();
527
Ingo Molnar3295f0e2008-08-11 10:30:30 +0200528 lock_map_acquire(&work->lockdep_map);
529 lock_map_release(&work->lockdep_map);
Johannes Berg4e6045f2007-10-18 23:39:55 -0700530
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700531 cwq = get_wq_data(work);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700532 if (!cwq)
Oleg Nesterov3af244332007-05-09 02:34:09 -0700533 return;
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700534
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700535 wq = cwq->wq;
536 cpu_map = wq_cpu_map(wq);
537
Rusty Russellaa85ea52009-03-30 22:05:15 -0600538 for_each_cpu(cpu, cpu_map)
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700539 wait_on_cpu_work(per_cpu_ptr(wq->cpu_wq, cpu), work);
540}
541
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700542static int __cancel_work_timer(struct work_struct *work,
543 struct timer_list* timer)
544{
545 int ret;
546
547 do {
548 ret = (timer && likely(del_timer(timer)));
549 if (!ret)
550 ret = try_to_grab_pending(work);
551 wait_on_work(work);
552 } while (unlikely(ret < 0));
553
554 work_clear_pending(work);
555 return ret;
556}
557
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700558/**
559 * cancel_work_sync - block until a work_struct's callback has terminated
560 * @work: the work which is to be flushed
561 *
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700562 * Returns true if @work was pending.
563 *
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700564 * cancel_work_sync() will cancel the work if it is queued. If the work's
565 * callback appears to be running, cancel_work_sync() will block until it
566 * has completed.
567 *
568 * It is possible to use this function if the work re-queues itself. It can
569 * cancel the work even if it migrates to another workqueue, however in that
570 * case it only guarantees that work->func() has completed on the last queued
571 * workqueue.
572 *
573 * cancel_work_sync(&delayed_work->work) should be used only if ->timer is not
574 * pending, otherwise it goes into a busy-wait loop until the timer expires.
575 *
576 * The caller must ensure that workqueue_struct on which this work was last
577 * queued can't be destroyed before this function returns.
578 */
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700579int cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700580{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700581 return __cancel_work_timer(work, NULL);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700582}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700583EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700584
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700585/**
Oleg Nesterovf5a421a2007-07-15 23:41:44 -0700586 * cancel_delayed_work_sync - reliably kill off a delayed work.
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700587 * @dwork: the delayed work struct
588 *
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700589 * Returns true if @dwork was pending.
590 *
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700591 * It is possible to use this function if @dwork rearms itself via queue_work()
592 * or queue_delayed_work(). See also the comment for cancel_work_sync().
593 */
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700594int cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700595{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700596 return __cancel_work_timer(&dwork->work, &dwork->timer);
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700597}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -0700598EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700600static struct workqueue_struct *keventd_wq __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700602/**
603 * schedule_work - put work task in global workqueue
604 * @work: job to be done
605 *
606 * This puts a job in the kernel-global workqueue.
607 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -0800608int schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609{
610 return queue_work(keventd_wq, work);
611}
Dave Jonesae90dd52006-06-30 01:40:45 -0400612EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
Zhang Ruic1a220e2008-07-23 21:28:39 -0700614/*
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
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700627/**
628 * schedule_delayed_work - put work task in global workqueue after delay
David Howells52bad642006-11-22 14:54:01 +0000629 * @dwork: job to be done
630 * @delay: number of jiffies to wait or 0 for immediate execution
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700631 *
632 * After waiting for a given time this puts a job in the kernel-global
633 * workqueue.
634 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -0800635int schedule_delayed_work(struct delayed_work *dwork,
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800636 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637{
David Howells52bad642006-11-22 14:54:01 +0000638 return queue_delayed_work(keventd_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639}
Dave Jonesae90dd52006-06-30 01:40:45 -0400640EXPORT_SYMBOL(schedule_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700642/**
643 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
644 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +0000645 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700646 * @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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651int schedule_delayed_work_on(int cpu,
David Howells52bad642006-11-22 14:54:01 +0000652 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653{
David Howells52bad642006-11-22 14:54:01 +0000654 return queue_delayed_work_on(cpu, keventd_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655}
Dave Jonesae90dd52006-06-30 01:40:45 -0400656EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Andrew Mortonb6136772006-06-25 05:47:49 -0700658/**
659 * schedule_on_each_cpu - call a function on each online CPU from keventd
660 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -0700661 *
662 * Returns zero on success.
663 * Returns -ve errno on failure.
664 *
Andrew Mortonb6136772006-06-25 05:47:49 -0700665 * schedule_on_each_cpu() is very slow.
666 */
David Howells65f27f32006-11-22 14:55:48 +0000667int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -0800668{
669 int cpu;
Andrew Mortonb6136772006-06-25 05:47:49 -0700670 struct work_struct *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -0800671
Andrew Mortonb6136772006-06-25 05:47:49 -0700672 works = alloc_percpu(struct work_struct);
673 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -0800674 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -0700675
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100676 get_online_cpus();
Christoph Lameter15316ba2006-01-08 01:00:43 -0800677 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +0100678 struct work_struct *work = per_cpu_ptr(works, cpu);
679
680 INIT_WORK(work, func);
Oleg Nesterov8de6d302008-07-25 01:47:53 -0700681 schedule_work_on(cpu, work);
Christoph Lameter15316ba2006-01-08 01:00:43 -0800682 }
Oleg Nesterov8616a892008-07-25 01:47:49 -0700683 for_each_online_cpu(cpu)
684 flush_work(per_cpu_ptr(works, cpu));
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100685 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -0700686 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -0800687 return 0;
688}
689
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690void flush_scheduled_work(void)
691{
692 flush_workqueue(keventd_wq);
693}
Dave Jonesae90dd52006-06-30 01:40:45 -0400694EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
696/**
James Bottomley1fa44ec2006-02-23 12:43:43 -0600697 * execute_in_process_context - reliably execute the routine with user context
698 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -0600699 * @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 */
David Howells65f27f32006-11-22 14:55:48 +0000708int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -0600709{
710 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +0000711 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -0600712 return 0;
713 }
714
David Howells65f27f32006-11-22 14:55:48 +0000715 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -0600716 schedule_work(&ew->work);
717
718 return 1;
719}
720EXPORT_SYMBOL_GPL(execute_in_process_context);
721
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722int keventd_up(void)
723{
724 return keventd_wq != NULL;
725}
726
727int current_is_keventd(void)
728{
729 struct cpu_workqueue_struct *cwq;
Hugh Dickinsd2437692007-08-27 16:06:19 +0100730 int cpu = raw_smp_processor_id(); /* preempt-safe: keventd is per-cpu */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 int ret = 0;
732
733 BUG_ON(!keventd_wq);
734
Christoph Lameter89ada672005-10-30 15:01:59 -0800735 cwq = per_cpu_ptr(keventd_wq->cpu_wq, cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 if (current == cwq->thread)
737 ret = 1;
738
739 return ret;
740
741}
742
Oleg Nesterov3af244332007-05-09 02:34:09 -0700743static struct cpu_workqueue_struct *
744init_cpu_workqueue(struct workqueue_struct *wq, int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745{
Christoph Lameter89ada672005-10-30 15:01:59 -0800746 struct cpu_workqueue_struct *cwq = per_cpu_ptr(wq->cpu_wq, cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
Oleg Nesterov3af244332007-05-09 02:34:09 -0700748 cwq->wq = wq;
749 spin_lock_init(&cwq->lock);
750 INIT_LIST_HEAD(&cwq->worklist);
751 init_waitqueue_head(&cwq->more_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
Oleg Nesterov3af244332007-05-09 02:34:09 -0700753 return cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754}
755
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100756DEFINE_TRACE(workqueue_creation);
757
Oleg Nesterov3af244332007-05-09 02:34:09 -0700758static int create_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759{
Heiko Carstens0d557dc2008-10-13 23:50:09 +0200760 struct sched_param param = { .sched_priority = MAX_RT_PRIO-1 };
Oleg Nesterov3af244332007-05-09 02:34:09 -0700761 struct workqueue_struct *wq = cwq->wq;
David Howells6cc88bc2008-11-14 10:39:21 +1100762 const char *fmt = is_wq_single_threaded(wq) ? "%s" : "%s/%d";
Oleg Nesterov3af244332007-05-09 02:34:09 -0700763 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);
Heiko Carstens0d557dc2008-10-13 23:50:09 +0200776 if (cwq->wq->rt)
777 sched_setscheduler_nocheck(p, SCHED_FIFO, &param);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700778 cwq->thread = p;
Oleg Nesterov3af244332007-05-09 02:34:09 -0700779
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100780 trace_workqueue_creation(cwq->thread, cpu);
781
Oleg Nesterov3af244332007-05-09 02:34:09 -0700782 return 0;
783}
784
Oleg Nesterov06ba38a2007-05-09 02:34:15 -0700785static 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
Johannes Berg4e6045f2007-10-18 23:39:55 -0700796struct workqueue_struct *__create_workqueue_key(const char *name,
797 int singlethread,
798 int freezeable,
Heiko Carstens0d557dc2008-10-13 23:50:09 +0200799 int rt,
Johannes Bergeb13ba82008-01-16 09:51:58 +0100800 struct lock_class_key *key,
801 const char *lock_name)
Oleg Nesterov3af244332007-05-09 02:34:09 -0700802{
803 struct workqueue_struct *wq;
804 struct cpu_workqueue_struct *cwq;
805 int err = 0, cpu;
806
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;
Johannes Bergeb13ba82008-01-16 09:51:58 +0100818 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -0700819 wq->singlethread = singlethread;
Oleg Nesterov3af244332007-05-09 02:34:09 -0700820 wq->freezeable = freezeable;
Heiko Carstens0d557dc2008-10-13 23:50:09 +0200821 wq->rt = rt;
Oleg Nesterovcce1a162007-05-09 02:34:13 -0700822 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700823
824 if (singlethread) {
Oleg Nesterov3af244332007-05-09 02:34:09 -0700825 cwq = init_cpu_workqueue(wq, singlethread_cpu);
826 err = create_workqueue_thread(cwq, singlethread_cpu);
Oleg Nesterov06ba38a2007-05-09 02:34:15 -0700827 start_workqueue_thread(cwq, -1);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700828 } else {
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700829 cpu_maps_update_begin();
Oleg Nesterov6af8bf32008-07-29 22:33:49 -0700830 /*
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 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100836 spin_lock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700837 list_add(&wq->list, &workqueues);
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100838 spin_unlock(&workqueue_lock);
Oleg Nesterov6af8bf32008-07-29 22:33:49 -0700839 /*
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 */
Oleg Nesterov3af244332007-05-09 02:34:09 -0700845 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);
Oleg Nesterov06ba38a2007-05-09 02:34:15 -0700850 start_workqueue_thread(cwq, cpu);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700851 }
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700852 cpu_maps_update_done();
Oleg Nesterov3af244332007-05-09 02:34:09 -0700853 }
854
855 if (err) {
856 destroy_workqueue(wq);
857 wq = NULL;
858 }
859 return wq;
860}
Johannes Berg4e6045f2007-10-18 23:39:55 -0700861EXPORT_SYMBOL_GPL(__create_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700862
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100863DEFINE_TRACE(workqueue_destruction);
864
Oleg Nesterov1e35eaa22008-04-29 01:00:28 -0700865static void cleanup_workqueue_thread(struct cpu_workqueue_struct *cwq)
Oleg Nesterov3af244332007-05-09 02:34:09 -0700866{
Oleg Nesterov14441962007-05-23 13:57:57 -0700867 /*
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700868 * Our caller is either destroy_workqueue() or CPU_POST_DEAD,
869 * cpu_add_remove_lock protects cwq->thread.
Oleg Nesterov14441962007-05-23 13:57:57 -0700870 */
871 if (cwq->thread == NULL)
872 return;
Oleg Nesterov3af244332007-05-09 02:34:09 -0700873
Ingo Molnar3295f0e2008-08-11 10:30:30 +0200874 lock_map_acquire(&cwq->wq->lockdep_map);
875 lock_map_release(&cwq->wq->lockdep_map);
Johannes Berg4e6045f2007-10-18 23:39:55 -0700876
Oleg Nesterov13c22162007-07-17 04:03:55 -0700877 flush_cpu_workqueue(cwq);
Oleg Nesterov14441962007-05-23 13:57:57 -0700878 /*
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700879 * If the caller is CPU_POST_DEAD and cwq->worklist was not empty,
Oleg Nesterov13c22162007-07-17 04:03:55 -0700880 * a concurrent flush_workqueue() can insert a barrier after us.
881 * However, in that case run_workqueue() won't return and check
882 * kthread_should_stop() until it flushes all work_struct's.
Oleg Nesterov14441962007-05-23 13:57:57 -0700883 * When ->worklist becomes empty it is safe to exit because no
884 * more work_structs can be queued on this cwq: flush_workqueue
885 * checks list_empty(), and a "normal" queue_work() can't use
886 * a dead CPU.
887 */
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100888 trace_workqueue_destruction(cwq->thread);
Oleg Nesterov14441962007-05-23 13:57:57 -0700889 kthread_stop(cwq->thread);
890 cwq->thread = NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -0700891}
892
893/**
894 * destroy_workqueue - safely terminate a workqueue
895 * @wq: target workqueue
896 *
897 * Safely destroy a workqueue. All work currently pending will be done first.
898 */
899void destroy_workqueue(struct workqueue_struct *wq)
900{
Rusty Russelle7577c52009-01-01 10:12:25 +1030901 const struct cpumask *cpu_map = wq_cpu_map(wq);
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -0700902 int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -0700903
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700904 cpu_maps_update_begin();
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100905 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -0700906 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100907 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700908
Rusty Russellaa85ea52009-03-30 22:05:15 -0600909 for_each_cpu(cpu, cpu_map)
Oleg Nesterov1e35eaa22008-04-29 01:00:28 -0700910 cleanup_workqueue_thread(per_cpu_ptr(wq->cpu_wq, cpu));
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700911 cpu_maps_update_done();
Oleg Nesterov3af244332007-05-09 02:34:09 -0700912
913 free_percpu(wq->cpu_wq);
914 kfree(wq);
915}
916EXPORT_SYMBOL_GPL(destroy_workqueue);
917
918static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
919 unsigned long action,
920 void *hcpu)
921{
922 unsigned int cpu = (unsigned long)hcpu;
923 struct cpu_workqueue_struct *cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 struct workqueue_struct *wq;
Oleg Nesterov84485022008-07-25 01:47:54 -0700925 int ret = NOTIFY_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
Rafael J. Wysocki8bb78442007-05-09 02:35:10 -0700927 action &= ~CPU_TASKS_FROZEN;
928
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 switch (action) {
930 case CPU_UP_PREPARE:
Rusty Russelle7577c52009-01-01 10:12:25 +1030931 cpumask_set_cpu(cpu, cpu_populated_map);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700932 }
Oleg Nesterov84485022008-07-25 01:47:54 -0700933undo:
Oleg Nesterov3af244332007-05-09 02:34:09 -0700934 list_for_each_entry(wq, &workqueues, list) {
935 cwq = per_cpu_ptr(wq->cpu_wq, cpu);
Christoph Lameter89ada672005-10-30 15:01:59 -0800936
Oleg Nesterov3af244332007-05-09 02:34:09 -0700937 switch (action) {
938 case CPU_UP_PREPARE:
939 if (!create_workqueue_thread(cwq, cpu))
940 break;
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100941 printk(KERN_ERR "workqueue [%s] for %i failed\n",
942 wq->name, cpu);
Oleg Nesterov84485022008-07-25 01:47:54 -0700943 action = CPU_UP_CANCELED;
944 ret = NOTIFY_BAD;
945 goto undo;
Oleg Nesterov3af244332007-05-09 02:34:09 -0700946
947 case CPU_ONLINE:
Oleg Nesterov06ba38a2007-05-09 02:34:15 -0700948 start_workqueue_thread(cwq, cpu);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700949 break;
950
951 case CPU_UP_CANCELED:
Oleg Nesterov06ba38a2007-05-09 02:34:15 -0700952 start_workqueue_thread(cwq, -1);
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700953 case CPU_POST_DEAD:
Oleg Nesterov1e35eaa22008-04-29 01:00:28 -0700954 cleanup_workqueue_thread(cwq);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700955 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 }
958
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -0700959 switch (action) {
960 case CPU_UP_CANCELED:
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700961 case CPU_POST_DEAD:
Rusty Russelle7577c52009-01-01 10:12:25 +1030962 cpumask_clear_cpu(cpu, cpu_populated_map);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -0700963 }
964
Oleg Nesterov84485022008-07-25 01:47:54 -0700965 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
Rusty Russell2d3854a2008-11-05 13:39:10 +1100968#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -0800969
Rusty Russell2d3854a2008-11-05 13:39:10 +1100970struct work_for_cpu {
Andrew Morton6b44003e2009-04-09 09:50:37 -0600971 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +1100972 long (*fn)(void *);
973 void *arg;
974 long ret;
975};
976
Andrew Morton6b44003e2009-04-09 09:50:37 -0600977static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +1100978{
Andrew Morton6b44003e2009-04-09 09:50:37 -0600979 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +1100980 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b44003e2009-04-09 09:50:37 -0600981 complete(&wfc->completion);
982 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +1100983}
984
985/**
986 * work_on_cpu - run a function in user context on a particular cpu
987 * @cpu: the cpu to run on
988 * @fn: the function to run
989 * @arg: the function arg
990 *
Rusty Russell31ad9082009-01-16 15:31:15 -0800991 * This will return the value @fn returns.
992 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -0600993 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +1100994 */
995long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
996{
Andrew Morton6b44003e2009-04-09 09:50:37 -0600997 struct task_struct *sub_thread;
998 struct work_for_cpu wfc = {
999 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
1000 .fn = fn,
1001 .arg = arg,
1002 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11001003
Andrew Morton6b44003e2009-04-09 09:50:37 -06001004 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
1005 if (IS_ERR(sub_thread))
1006 return PTR_ERR(sub_thread);
1007 kthread_bind(sub_thread, cpu);
1008 wake_up_process(sub_thread);
1009 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11001010 return wfc.ret;
1011}
1012EXPORT_SYMBOL_GPL(work_on_cpu);
1013#endif /* CONFIG_SMP */
1014
Oleg Nesterovc12920d2007-05-09 02:34:14 -07001015void __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016{
Rusty Russelle7577c52009-01-01 10:12:25 +10301017 alloc_cpumask_var(&cpu_populated_map, GFP_KERNEL);
1018
1019 cpumask_copy(cpu_populated_map, cpu_online_mask);
1020 singlethread_cpu = cpumask_first(cpu_possible_mask);
1021 cpu_singlethread_map = cpumask_of(singlethread_cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 hotcpu_notifier(workqueue_cpu_callback, 0);
1023 keventd_wq = create_workqueue("events");
1024 BUG_ON(!keventd_wq);
1025}