blob: 0611de815a8f921a4d2215f52959de832acb5c9d [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>
12 * Andrew Morton <andrewm@uow.edu.au>
13 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
14 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080015 *
16 * Made to use alloc_percpu by Christoph Lameter <clameter@sgi.com>.
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 Lameter46934022006-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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
36/*
Nathan Lynchf756d5e2006-01-08 01:05:12 -080037 * The per-CPU workqueue (if single thread, we always use the first
38 * possible cpu).
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 */
40struct cpu_workqueue_struct {
41
42 spinlock_t lock;
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 struct list_head worklist;
45 wait_queue_head_t more_work;
Oleg Nesterov3af244332007-05-09 02:34:09 -070046 struct work_struct *current_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48 struct workqueue_struct *wq;
Ingo Molnar36c8b582006-07-03 00:25:41 -070049 struct task_struct *thread;
Oleg Nesterov3af244332007-05-09 02:34:09 -070050 int should_stop;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52 int run_depth; /* Detect run_workqueue() recursion depth */
53} ____cacheline_aligned;
54
55/*
56 * The externally visible workqueue abstraction is an array of
57 * per-CPU workqueues:
58 */
59struct workqueue_struct {
Christoph Lameter89ada672005-10-30 15:01:59 -080060 struct cpu_workqueue_struct *cpu_wq;
Oleg Nesterovcce1a162007-05-09 02:34:13 -070061 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 const char *name;
Oleg Nesterovcce1a162007-05-09 02:34:13 -070063 int singlethread;
Oleg Nesterov319c2a92007-05-09 02:34:06 -070064 int freezeable; /* Freeze threads during suspend */
Linus Torvalds1da177e2005-04-16 15:20:36 -070065};
66
67/* All the per-cpu workqueues on the system, for hotplug cpu to add/remove
68 threads to each one as cpus come/go. */
Andrew Morton9b41ea72006-08-13 23:24:26 -070069static DEFINE_MUTEX(workqueue_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070static LIST_HEAD(workqueues);
71
Oleg Nesterov3af244332007-05-09 02:34:09 -070072static int singlethread_cpu __read_mostly;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -070073static cpumask_t cpu_singlethread_map __read_mostly;
Oleg Nesterov3af244332007-05-09 02:34:09 -070074/* optimization, we could use cpu_possible_map */
75static cpumask_t cpu_populated_map __read_mostly;
Nathan Lynchf756d5e2006-01-08 01:05:12 -080076
Linus Torvalds1da177e2005-04-16 15:20:36 -070077/* If it's single threaded, it isn't in the list of workqueues. */
78static inline int is_single_threaded(struct workqueue_struct *wq)
79{
Oleg Nesterovcce1a162007-05-09 02:34:13 -070080 return wq->singlethread;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081}
82
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -070083static const cpumask_t *wq_cpu_map(struct workqueue_struct *wq)
84{
85 return is_single_threaded(wq)
86 ? &cpu_singlethread_map : &cpu_populated_map;
87}
88
Oleg Nesterova848e3b2007-05-09 02:34:17 -070089static
90struct cpu_workqueue_struct *wq_per_cpu(struct workqueue_struct *wq, int cpu)
91{
92 if (unlikely(is_single_threaded(wq)))
93 cpu = singlethread_cpu;
94 return per_cpu_ptr(wq->cpu_wq, cpu);
95}
96
David Howells4594bf12006-12-07 11:33:26 +000097/*
98 * Set the workqueue on which a work item is to be run
99 * - Must *only* be called if the pending flag is set
100 */
Oleg Nesteroved7c0fe2007-05-09 02:34:16 -0700101static inline void set_wq_data(struct work_struct *work,
102 struct cpu_workqueue_struct *cwq)
David Howells365970a2006-11-22 14:54:49 +0000103{
David Howells4594bf12006-12-07 11:33:26 +0000104 unsigned long new;
David Howells365970a2006-11-22 14:54:49 +0000105
David Howells4594bf12006-12-07 11:33:26 +0000106 BUG_ON(!work_pending(work));
107
Oleg Nesteroved7c0fe2007-05-09 02:34:16 -0700108 new = (unsigned long) cwq | (1UL << WORK_STRUCT_PENDING);
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800109 new |= WORK_STRUCT_FLAG_MASK & *work_data_bits(work);
110 atomic_long_set(&work->data, new);
David Howells365970a2006-11-22 14:54:49 +0000111}
112
Oleg Nesteroved7c0fe2007-05-09 02:34:16 -0700113static inline
114struct cpu_workqueue_struct *get_wq_data(struct work_struct *work)
David Howells365970a2006-11-22 14:54:49 +0000115{
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800116 return (void *) (atomic_long_read(&work->data) & WORK_STRUCT_WQ_DATA_MASK);
David Howells365970a2006-11-22 14:54:49 +0000117}
118
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700119static void insert_work(struct cpu_workqueue_struct *cwq,
120 struct work_struct *work, int tail)
121{
122 set_wq_data(work, cwq);
123 if (tail)
124 list_add_tail(&work->entry, &cwq->worklist);
125 else
126 list_add(&work->entry, &cwq->worklist);
127 wake_up(&cwq->more_work);
128}
129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130/* Preempt must be disabled. */
131static void __queue_work(struct cpu_workqueue_struct *cwq,
132 struct work_struct *work)
133{
134 unsigned long flags;
135
136 spin_lock_irqsave(&cwq->lock, flags);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700137 insert_work(cwq, work, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 spin_unlock_irqrestore(&cwq->lock, flags);
139}
140
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700141/**
142 * queue_work - queue work on a workqueue
143 * @wq: workqueue to use
144 * @work: work to queue
145 *
Alan Stern057647f2006-10-28 10:38:58 -0700146 * Returns 0 if @work was already on a queue, non-zero otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 *
148 * We queue the work to the CPU it was submitted, but there is no
149 * guarantee that it will be processed by that CPU.
150 */
151int fastcall queue_work(struct workqueue_struct *wq, struct work_struct *work)
152{
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700153 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800155 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 BUG_ON(!list_empty(&work->entry));
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700157 __queue_work(wq_per_cpu(wq, get_cpu()), work);
158 put_cpu();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 ret = 1;
160 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 return ret;
162}
Dave Jonesae90dd52006-06-30 01:40:45 -0400163EXPORT_SYMBOL_GPL(queue_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800165void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166{
David Howells52bad642006-11-22 14:54:01 +0000167 struct delayed_work *dwork = (struct delayed_work *)__data;
Oleg Nesteroved7c0fe2007-05-09 02:34:16 -0700168 struct cpu_workqueue_struct *cwq = get_wq_data(&dwork->work);
169 struct workqueue_struct *wq = cwq->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700171 __queue_work(wq_per_cpu(wq, smp_processor_id()), &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172}
173
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700174/**
175 * queue_delayed_work - queue work on a workqueue after delay
176 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800177 * @dwork: delayable work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700178 * @delay: number of jiffies to wait before queueing
179 *
Alan Stern057647f2006-10-28 10:38:58 -0700180 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700181 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182int fastcall queue_delayed_work(struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +0000183 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700185 timer_stats_timer_set_start_info(&dwork->timer);
David Howells52bad642006-11-22 14:54:01 +0000186 if (delay == 0)
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700187 return queue_work(wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700189 return queue_delayed_work_on(-1, wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190}
Dave Jonesae90dd52006-06-30 01:40:45 -0400191EXPORT_SYMBOL_GPL(queue_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700193/**
194 * queue_delayed_work_on - queue work on specific CPU after delay
195 * @cpu: CPU number to execute work on
196 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800197 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700198 * @delay: number of jiffies to wait before queueing
199 *
Alan Stern057647f2006-10-28 10:38:58 -0700200 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700201 */
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700202int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +0000203 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700204{
205 int ret = 0;
David Howells52bad642006-11-22 14:54:01 +0000206 struct timer_list *timer = &dwork->timer;
207 struct work_struct *work = &dwork->work;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700208
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800209 if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work))) {
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700210 BUG_ON(timer_pending(timer));
211 BUG_ON(!list_empty(&work->entry));
212
Oleg Nesteroved7c0fe2007-05-09 02:34:16 -0700213 /* This stores cwq for the moment, for the timer_fn */
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700214 set_wq_data(work, wq_per_cpu(wq, raw_smp_processor_id()));
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700215 timer->expires = jiffies + delay;
David Howells52bad642006-11-22 14:54:01 +0000216 timer->data = (unsigned long)dwork;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700217 timer->function = delayed_work_timer_fn;
Oleg Nesterov63bc0362007-05-09 02:34:16 -0700218
219 if (unlikely(cpu >= 0))
220 add_timer_on(timer, cpu);
221 else
222 add_timer(timer);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700223 ret = 1;
224 }
225 return ret;
226}
Dave Jonesae90dd52006-06-30 01:40:45 -0400227EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Arjan van de Ven858119e2006-01-14 13:20:43 -0800229static void run_workqueue(struct cpu_workqueue_struct *cwq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230{
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700231 spin_lock_irq(&cwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 cwq->run_depth++;
233 if (cwq->run_depth > 3) {
234 /* morton gets to eat his hat */
235 printk("%s: recursion depth exceeded: %d\n",
236 __FUNCTION__, cwq->run_depth);
237 dump_stack();
238 }
239 while (!list_empty(&cwq->worklist)) {
240 struct work_struct *work = list_entry(cwq->worklist.next,
241 struct work_struct, entry);
David Howells6bb49e52006-11-22 14:54:45 +0000242 work_func_t f = work->func;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700244 cwq->current_work = work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 list_del_init(cwq->worklist.next);
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700246 spin_unlock_irq(&cwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
David Howells365970a2006-11-22 14:54:49 +0000248 BUG_ON(get_wq_data(work) != cwq);
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700249 work_clear_pending(work);
David Howells65f27f32006-11-22 14:55:48 +0000250 f(work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
Peter Zijlstrad5abe662006-12-06 20:37:26 -0800252 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
253 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
254 "%s/0x%08x/%d\n",
255 current->comm, preempt_count(),
256 current->pid);
257 printk(KERN_ERR " last function: ");
258 print_symbol("%s\n", (unsigned long)f);
259 debug_show_held_locks(current);
260 dump_stack();
261 }
262
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700263 spin_lock_irq(&cwq->lock);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700264 cwq->current_work = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 }
266 cwq->run_depth--;
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700267 spin_unlock_irq(&cwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268}
269
Oleg Nesterov3af244332007-05-09 02:34:09 -0700270/*
271 * NOTE: the caller must not touch *cwq if this func returns true
272 */
273static int cwq_should_stop(struct cpu_workqueue_struct *cwq)
274{
275 int should_stop = cwq->should_stop;
276
277 if (unlikely(should_stop)) {
278 spin_lock_irq(&cwq->lock);
279 should_stop = cwq->should_stop && list_empty(&cwq->worklist);
280 if (should_stop)
281 cwq->thread = NULL;
282 spin_unlock_irq(&cwq->lock);
283 }
284
285 return should_stop;
286}
287
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288static int worker_thread(void *__cwq)
289{
290 struct cpu_workqueue_struct *cwq = __cwq;
Oleg Nesterov3af244332007-05-09 02:34:09 -0700291 DEFINE_WAIT(wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 struct k_sigaction sa;
293 sigset_t blocked;
294
Oleg Nesterov319c2a92007-05-09 02:34:06 -0700295 if (!cwq->wq->freezeable)
Rafael J. Wysocki341a5952006-12-06 20:34:49 -0800296 current->flags |= PF_NOFREEZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
298 set_user_nice(current, -5);
299
300 /* Block and flush all signals */
301 sigfillset(&blocked);
302 sigprocmask(SIG_BLOCK, &blocked, NULL);
303 flush_signals(current);
304
Christoph Lameter46934022006-10-11 01:21:26 -0700305 /*
306 * We inherited MPOL_INTERLEAVE from the booting kernel.
307 * Set MPOL_DEFAULT to insure node local allocations.
308 */
309 numa_default_policy();
310
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 /* SIG_IGN makes children autoreap: see do_notify_parent(). */
312 sa.sa.sa_handler = SIG_IGN;
313 sa.sa.sa_flags = 0;
314 siginitset(&sa.sa.sa_mask, sigmask(SIGCHLD));
315 do_sigaction(SIGCHLD, &sa, (struct k_sigaction *)0);
316
Oleg Nesterov3af244332007-05-09 02:34:09 -0700317 for (;;) {
Oleg Nesterov319c2a92007-05-09 02:34:06 -0700318 if (cwq->wq->freezeable)
Rafael J. Wysocki341a5952006-12-06 20:34:49 -0800319 try_to_freeze();
320
Oleg Nesterov3af244332007-05-09 02:34:09 -0700321 prepare_to_wait(&cwq->more_work, &wait, TASK_INTERRUPTIBLE);
322 if (!cwq->should_stop && list_empty(&cwq->worklist))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 schedule();
Oleg Nesterov3af244332007-05-09 02:34:09 -0700324 finish_wait(&cwq->more_work, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
Oleg Nesterov3af244332007-05-09 02:34:09 -0700326 if (cwq_should_stop(cwq))
327 break;
328
329 run_workqueue(cwq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 }
Oleg Nesterov3af244332007-05-09 02:34:09 -0700331
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 return 0;
333}
334
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -0700335struct wq_barrier {
336 struct work_struct work;
337 struct completion done;
338};
339
340static void wq_barrier_func(struct work_struct *work)
341{
342 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
343 complete(&barr->done);
344}
345
Oleg Nesterov83c22522007-05-09 02:33:54 -0700346static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
347 struct wq_barrier *barr, int tail)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -0700348{
349 INIT_WORK(&barr->work, wq_barrier_func);
350 __set_bit(WORK_STRUCT_PENDING, work_data_bits(&barr->work));
351
352 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -0700353
354 insert_work(cwq, &barr->work, tail);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -0700355}
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357static void flush_cpu_workqueue(struct cpu_workqueue_struct *cwq)
358{
359 if (cwq->thread == current) {
360 /*
361 * Probably keventd trying to flush its own queue. So simply run
362 * it by hand rather than deadlocking.
363 */
364 run_workqueue(cwq);
365 } else {
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -0700366 struct wq_barrier barr;
Oleg Nesterov83c22522007-05-09 02:33:54 -0700367 int active = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Oleg Nesterov83c22522007-05-09 02:33:54 -0700369 spin_lock_irq(&cwq->lock);
370 if (!list_empty(&cwq->worklist) || cwq->current_work != NULL) {
371 insert_wq_barrier(cwq, &barr, 1);
372 active = 1;
373 }
374 spin_unlock_irq(&cwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Oleg Nesterovd7213042007-05-09 02:34:07 -0700376 if (active)
Oleg Nesterov83c22522007-05-09 02:33:54 -0700377 wait_for_completion(&barr.done);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 }
379}
380
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700381/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700383 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 *
385 * Forces execution of the workqueue and blocks until its completion.
386 * This is typically used in driver shutdown handlers.
387 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -0700388 * We sleep until all works which were queued on entry have been handled,
389 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 *
391 * This function used to run the workqueues itself. Now we just wait for the
392 * helper threads to do it.
393 */
394void fastcall flush_workqueue(struct workqueue_struct *wq)
395{
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700396 const cpumask_t *cpu_map = wq_cpu_map(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -0700397 int cpu;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700398
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700399 might_sleep();
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700400 for_each_cpu_mask(cpu, *cpu_map)
401 flush_cpu_workqueue(per_cpu_ptr(wq->cpu_wq, cpu));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402}
Dave Jonesae90dd52006-06-30 01:40:45 -0400403EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700405static void wait_on_work(struct cpu_workqueue_struct *cwq,
406 struct work_struct *work)
407{
408 struct wq_barrier barr;
409 int running = 0;
410
411 spin_lock_irq(&cwq->lock);
412 if (unlikely(cwq->current_work == work)) {
Oleg Nesterov83c22522007-05-09 02:33:54 -0700413 insert_wq_barrier(cwq, &barr, 0);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700414 running = 1;
415 }
416 spin_unlock_irq(&cwq->lock);
417
Oleg Nesterov3af244332007-05-09 02:34:09 -0700418 if (unlikely(running))
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700419 wait_for_completion(&barr.done);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700420}
421
422/**
423 * flush_work - block until a work_struct's callback has terminated
424 * @wq: the workqueue on which the work is queued
425 * @work: the work which is to be flushed
426 *
427 * flush_work() will attempt to cancel the work if it is queued. If the work's
428 * callback appears to be running, flush_work() will block until it has
429 * completed.
430 *
431 * flush_work() is designed to be used when the caller is tearing down data
432 * structures which the callback function operates upon. It is expected that,
433 * prior to calling flush_work(), the caller has arranged for the work to not
434 * be requeued.
435 */
436void flush_work(struct workqueue_struct *wq, struct work_struct *work)
437{
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700438 const cpumask_t *cpu_map = wq_cpu_map(wq);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700439 struct cpu_workqueue_struct *cwq;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700440 int cpu;
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700441
Oleg Nesterovf293ea92007-05-09 02:34:10 -0700442 might_sleep();
443
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700444 cwq = get_wq_data(work);
445 /* Was it ever queued ? */
446 if (!cwq)
Oleg Nesterov3af244332007-05-09 02:34:09 -0700447 return;
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700448
449 /*
Oleg Nesterov3af244332007-05-09 02:34:09 -0700450 * This work can't be re-queued, no need to re-check that
451 * get_wq_data() is still the same when we take cwq->lock.
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700452 */
453 spin_lock_irq(&cwq->lock);
454 list_del_init(&work->entry);
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700455 work_clear_pending(work);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700456 spin_unlock_irq(&cwq->lock);
457
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700458 for_each_cpu_mask(cpu, *cpu_map)
459 wait_on_work(per_cpu_ptr(wq->cpu_wq, cpu), work);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700460}
461EXPORT_SYMBOL_GPL(flush_work);
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
464static struct workqueue_struct *keventd_wq;
465
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700466/**
467 * schedule_work - put work task in global workqueue
468 * @work: job to be done
469 *
470 * This puts a job in the kernel-global workqueue.
471 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472int fastcall schedule_work(struct work_struct *work)
473{
474 return queue_work(keventd_wq, work);
475}
Dave Jonesae90dd52006-06-30 01:40:45 -0400476EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700478/**
479 * schedule_delayed_work - put work task in global workqueue after delay
David Howells52bad642006-11-22 14:54:01 +0000480 * @dwork: job to be done
481 * @delay: number of jiffies to wait or 0 for immediate execution
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700482 *
483 * After waiting for a given time this puts a job in the kernel-global
484 * workqueue.
485 */
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800486int fastcall schedule_delayed_work(struct delayed_work *dwork,
487 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488{
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800489 timer_stats_timer_set_start_info(&dwork->timer);
David Howells52bad642006-11-22 14:54:01 +0000490 return queue_delayed_work(keventd_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491}
Dave Jonesae90dd52006-06-30 01:40:45 -0400492EXPORT_SYMBOL(schedule_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700494/**
495 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
496 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +0000497 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700498 * @delay: number of jiffies to wait
499 *
500 * After waiting for a given time this puts a job in the kernel-global
501 * workqueue on the specified CPU.
502 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503int schedule_delayed_work_on(int cpu,
David Howells52bad642006-11-22 14:54:01 +0000504 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
David Howells52bad642006-11-22 14:54:01 +0000506 return queue_delayed_work_on(cpu, keventd_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507}
Dave Jonesae90dd52006-06-30 01:40:45 -0400508EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
Andrew Mortonb6136772006-06-25 05:47:49 -0700510/**
511 * schedule_on_each_cpu - call a function on each online CPU from keventd
512 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -0700513 *
514 * Returns zero on success.
515 * Returns -ve errno on failure.
516 *
517 * Appears to be racy against CPU hotplug.
518 *
519 * schedule_on_each_cpu() is very slow.
520 */
David Howells65f27f32006-11-22 14:55:48 +0000521int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -0800522{
523 int cpu;
Andrew Mortonb6136772006-06-25 05:47:49 -0700524 struct work_struct *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -0800525
Andrew Mortonb6136772006-06-25 05:47:49 -0700526 works = alloc_percpu(struct work_struct);
527 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -0800528 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -0700529
Andrew Mortone18f3ff2007-05-09 02:33:50 -0700530 preempt_disable(); /* CPU hotplug */
Christoph Lameter15316ba2006-01-08 01:00:43 -0800531 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +0100532 struct work_struct *work = per_cpu_ptr(works, cpu);
533
534 INIT_WORK(work, func);
535 set_bit(WORK_STRUCT_PENDING, work_data_bits(work));
536 __queue_work(per_cpu_ptr(keventd_wq->cpu_wq, cpu), work);
Christoph Lameter15316ba2006-01-08 01:00:43 -0800537 }
Andrew Mortone18f3ff2007-05-09 02:33:50 -0700538 preempt_enable();
Christoph Lameter15316ba2006-01-08 01:00:43 -0800539 flush_workqueue(keventd_wq);
Andrew Mortonb6136772006-06-25 05:47:49 -0700540 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -0800541 return 0;
542}
543
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544void flush_scheduled_work(void)
545{
546 flush_workqueue(keventd_wq);
547}
Dave Jonesae90dd52006-06-30 01:40:45 -0400548EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700550void flush_work_keventd(struct work_struct *work)
551{
552 flush_work(keventd_wq, work);
553}
554EXPORT_SYMBOL(flush_work_keventd);
555
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556/**
Oleg Nesterov1634c482007-05-09 02:34:18 -0700557 * cancel_rearming_delayed_work - kill off a delayed work whose handler rearms the delayed work.
David Howells52bad642006-11-22 14:54:01 +0000558 * @dwork: the delayed work struct
Oleg Nesteroved7c0fe2007-05-09 02:34:16 -0700559 *
560 * Note that the work callback function may still be running on return from
561 * cancel_delayed_work(). Run flush_workqueue() or flush_work() to wait on it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 */
David Howells52bad642006-11-22 14:54:01 +0000563void cancel_rearming_delayed_work(struct delayed_work *dwork)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564{
Oleg Nesterov1634c482007-05-09 02:34:18 -0700565 struct cpu_workqueue_struct *cwq = get_wq_data(&dwork->work);
566
567 /* Was it ever queued ? */
568 if (cwq != NULL) {
569 struct workqueue_struct *wq = cwq->wq;
570
571 while (!cancel_delayed_work(dwork))
572 flush_workqueue(wq);
573 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574}
575EXPORT_SYMBOL(cancel_rearming_delayed_work);
576
James Bottomley1fa44ec2006-02-23 12:43:43 -0600577/**
578 * execute_in_process_context - reliably execute the routine with user context
579 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -0600580 * @ew: guaranteed storage for the execute work structure (must
581 * be available when the work executes)
582 *
583 * Executes the function immediately if process context is available,
584 * otherwise schedules the function for delayed execution.
585 *
586 * Returns: 0 - function was executed
587 * 1 - function was scheduled for execution
588 */
David Howells65f27f32006-11-22 14:55:48 +0000589int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -0600590{
591 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +0000592 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -0600593 return 0;
594 }
595
David Howells65f27f32006-11-22 14:55:48 +0000596 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -0600597 schedule_work(&ew->work);
598
599 return 1;
600}
601EXPORT_SYMBOL_GPL(execute_in_process_context);
602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603int keventd_up(void)
604{
605 return keventd_wq != NULL;
606}
607
608int current_is_keventd(void)
609{
610 struct cpu_workqueue_struct *cwq;
611 int cpu = smp_processor_id(); /* preempt-safe: keventd is per-cpu */
612 int ret = 0;
613
614 BUG_ON(!keventd_wq);
615
Christoph Lameter89ada672005-10-30 15:01:59 -0800616 cwq = per_cpu_ptr(keventd_wq->cpu_wq, cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 if (current == cwq->thread)
618 ret = 1;
619
620 return ret;
621
622}
623
Oleg Nesterov3af244332007-05-09 02:34:09 -0700624static struct cpu_workqueue_struct *
625init_cpu_workqueue(struct workqueue_struct *wq, int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626{
Christoph Lameter89ada672005-10-30 15:01:59 -0800627 struct cpu_workqueue_struct *cwq = per_cpu_ptr(wq->cpu_wq, cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Oleg Nesterov3af244332007-05-09 02:34:09 -0700629 cwq->wq = wq;
630 spin_lock_init(&cwq->lock);
631 INIT_LIST_HEAD(&cwq->worklist);
632 init_waitqueue_head(&cwq->more_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
Oleg Nesterov3af244332007-05-09 02:34:09 -0700634 return cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635}
636
Oleg Nesterov3af244332007-05-09 02:34:09 -0700637static int create_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
Oleg Nesterov3af244332007-05-09 02:34:09 -0700639 struct workqueue_struct *wq = cwq->wq;
640 const char *fmt = is_single_threaded(wq) ? "%s" : "%s/%d";
641 struct task_struct *p;
642
643 p = kthread_create(worker_thread, cwq, fmt, wq->name, cpu);
644 /*
645 * Nobody can add the work_struct to this cwq,
646 * if (caller is __create_workqueue)
647 * nobody should see this wq
648 * else // caller is CPU_UP_PREPARE
649 * cpu is not on cpu_online_map
650 * so we can abort safely.
651 */
652 if (IS_ERR(p))
653 return PTR_ERR(p);
654
655 cwq->thread = p;
656 cwq->should_stop = 0;
Oleg Nesterov3af244332007-05-09 02:34:09 -0700657
658 return 0;
659}
660
Oleg Nesterov06ba38a2007-05-09 02:34:15 -0700661static void start_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
662{
663 struct task_struct *p = cwq->thread;
664
665 if (p != NULL) {
666 if (cpu >= 0)
667 kthread_bind(p, cpu);
668 wake_up_process(p);
669 }
670}
671
Oleg Nesterov3af244332007-05-09 02:34:09 -0700672struct workqueue_struct *__create_workqueue(const char *name,
673 int singlethread, int freezeable)
674{
675 struct workqueue_struct *wq;
676 struct cpu_workqueue_struct *cwq;
677 int err = 0, cpu;
678
679 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
680 if (!wq)
681 return NULL;
682
683 wq->cpu_wq = alloc_percpu(struct cpu_workqueue_struct);
684 if (!wq->cpu_wq) {
685 kfree(wq);
686 return NULL;
687 }
688
689 wq->name = name;
Oleg Nesterovcce1a162007-05-09 02:34:13 -0700690 wq->singlethread = singlethread;
Oleg Nesterov3af244332007-05-09 02:34:09 -0700691 wq->freezeable = freezeable;
Oleg Nesterovcce1a162007-05-09 02:34:13 -0700692 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700693
694 if (singlethread) {
Oleg Nesterov3af244332007-05-09 02:34:09 -0700695 cwq = init_cpu_workqueue(wq, singlethread_cpu);
696 err = create_workqueue_thread(cwq, singlethread_cpu);
Oleg Nesterov06ba38a2007-05-09 02:34:15 -0700697 start_workqueue_thread(cwq, -1);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700698 } else {
699 mutex_lock(&workqueue_mutex);
700 list_add(&wq->list, &workqueues);
701
702 for_each_possible_cpu(cpu) {
703 cwq = init_cpu_workqueue(wq, cpu);
704 if (err || !cpu_online(cpu))
705 continue;
706 err = create_workqueue_thread(cwq, cpu);
Oleg Nesterov06ba38a2007-05-09 02:34:15 -0700707 start_workqueue_thread(cwq, cpu);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700708 }
709 mutex_unlock(&workqueue_mutex);
710 }
711
712 if (err) {
713 destroy_workqueue(wq);
714 wq = NULL;
715 }
716 return wq;
717}
718EXPORT_SYMBOL_GPL(__create_workqueue);
719
720static void cleanup_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
721{
722 struct wq_barrier barr;
723 int alive = 0;
724
725 spin_lock_irq(&cwq->lock);
726 if (cwq->thread != NULL) {
727 insert_wq_barrier(cwq, &barr, 1);
728 cwq->should_stop = 1;
729 alive = 1;
730 }
731 spin_unlock_irq(&cwq->lock);
732
733 if (alive) {
734 wait_for_completion(&barr.done);
735
736 while (unlikely(cwq->thread != NULL))
737 cpu_relax();
738 /*
739 * Wait until cwq->thread unlocks cwq->lock,
740 * it won't touch *cwq after that.
741 */
742 smp_rmb();
743 spin_unlock_wait(&cwq->lock);
744 }
745}
746
747/**
748 * destroy_workqueue - safely terminate a workqueue
749 * @wq: target workqueue
750 *
751 * Safely destroy a workqueue. All work currently pending will be done first.
752 */
753void destroy_workqueue(struct workqueue_struct *wq)
754{
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700755 const cpumask_t *cpu_map = wq_cpu_map(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700756 struct cpu_workqueue_struct *cwq;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700757 int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -0700758
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700759 mutex_lock(&workqueue_mutex);
760 list_del(&wq->list);
761 mutex_unlock(&workqueue_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700762
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700763 for_each_cpu_mask(cpu, *cpu_map) {
764 cwq = per_cpu_ptr(wq->cpu_wq, cpu);
765 cleanup_workqueue_thread(cwq, cpu);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700766 }
767
768 free_percpu(wq->cpu_wq);
769 kfree(wq);
770}
771EXPORT_SYMBOL_GPL(destroy_workqueue);
772
773static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
774 unsigned long action,
775 void *hcpu)
776{
777 unsigned int cpu = (unsigned long)hcpu;
778 struct cpu_workqueue_struct *cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 struct workqueue_struct *wq;
780
781 switch (action) {
Oleg Nesterov3af244332007-05-09 02:34:09 -0700782 case CPU_LOCK_ACQUIRE:
783 mutex_lock(&workqueue_mutex);
784 return NOTIFY_OK;
785
786 case CPU_LOCK_RELEASE:
787 mutex_unlock(&workqueue_mutex);
788 return NOTIFY_OK;
789
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 case CPU_UP_PREPARE:
Oleg Nesterov3af244332007-05-09 02:34:09 -0700791 cpu_set(cpu, cpu_populated_map);
792 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Oleg Nesterov3af244332007-05-09 02:34:09 -0700794 list_for_each_entry(wq, &workqueues, list) {
795 cwq = per_cpu_ptr(wq->cpu_wq, cpu);
Christoph Lameter89ada672005-10-30 15:01:59 -0800796
Oleg Nesterov3af244332007-05-09 02:34:09 -0700797 switch (action) {
798 case CPU_UP_PREPARE:
799 if (!create_workqueue_thread(cwq, cpu))
800 break;
801 printk(KERN_ERR "workqueue for %i failed\n", cpu);
802 return NOTIFY_BAD;
803
804 case CPU_ONLINE:
Oleg Nesterov06ba38a2007-05-09 02:34:15 -0700805 start_workqueue_thread(cwq, cpu);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700806 break;
807
808 case CPU_UP_CANCELED:
Oleg Nesterov06ba38a2007-05-09 02:34:15 -0700809 start_workqueue_thread(cwq, -1);
Oleg Nesterov3af244332007-05-09 02:34:09 -0700810 case CPU_DEAD:
811 cleanup_workqueue_thread(cwq, cpu);
812 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 }
815
816 return NOTIFY_OK;
817}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818
Oleg Nesterovc12920d2007-05-09 02:34:14 -0700819void __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820{
Oleg Nesterov3af244332007-05-09 02:34:09 -0700821 cpu_populated_map = cpu_online_map;
Nathan Lynchf756d5e2006-01-08 01:05:12 -0800822 singlethread_cpu = first_cpu(cpu_possible_map);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700823 cpu_singlethread_map = cpumask_of_cpu(singlethread_cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 hotcpu_notifier(workqueue_cpu_callback, 0);
825 keventd_wq = create_workqueue("events");
826 BUG_ON(!keventd_wq);
827}