workqueue.c 23.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * linux/kernel/workqueue.c
 *
 * Generic mechanism for defining kernel helper threads for running
 * arbitrary tasks in process context.
 *
 * Started by Ingo Molnar, Copyright (C) 2002
 *
 * Derived from the taskqueue/keventd code by:
 *
 *   David Woodhouse <dwmw2@infradead.org>
 *   Andrew Morton <andrewm@uow.edu.au>
 *   Kai Petzke <wpp@marie.physik.tu-berlin.de>
 *   Theodore Ts'o <tytso@mit.edu>
15
 *
C
Christoph Lameter 已提交
16
 * Made to use alloc_percpu by Christoph Lameter.
L
Linus Torvalds 已提交
17 18 19 20 21 22 23 24 25 26 27 28 29
 */

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/sched.h>
#include <linux/init.h>
#include <linux/signal.h>
#include <linux/completion.h>
#include <linux/workqueue.h>
#include <linux/slab.h>
#include <linux/cpu.h>
#include <linux/notifier.h>
#include <linux/kthread.h>
30
#include <linux/hardirq.h>
31
#include <linux/mempolicy.h>
32
#include <linux/freezer.h>
33 34
#include <linux/kallsyms.h>
#include <linux/debug_locks.h>
35
#include <linux/lockdep.h>
L
Linus Torvalds 已提交
36 37

/*
38 39
 * The per-CPU workqueue (if single thread, we always use the first
 * possible cpu).
L
Linus Torvalds 已提交
40 41 42 43 44 45 46
 */
struct cpu_workqueue_struct {

	spinlock_t lock;

	struct list_head worklist;
	wait_queue_head_t more_work;
47
	struct work_struct *current_work;
L
Linus Torvalds 已提交
48 49

	struct workqueue_struct *wq;
50
	struct task_struct *thread;
L
Linus Torvalds 已提交
51 52 53 54 55 56 57 58 59

	int run_depth;		/* Detect run_workqueue() recursion depth */
} ____cacheline_aligned;

/*
 * The externally visible workqueue abstraction is an array of
 * per-CPU workqueues:
 */
struct workqueue_struct {
60
	struct cpu_workqueue_struct *cpu_wq;
61
	struct list_head list;
L
Linus Torvalds 已提交
62
	const char *name;
63
	int singlethread;
64
	int freezeable;		/* Freeze threads during suspend */
65 66 67
#ifdef CONFIG_LOCKDEP
	struct lockdep_map lockdep_map;
#endif
L
Linus Torvalds 已提交
68 69
};

70 71
/* Serializes the accesses to the list of workqueues. */
static DEFINE_SPINLOCK(workqueue_lock);
L
Linus Torvalds 已提交
72 73
static LIST_HEAD(workqueues);

74
static int singlethread_cpu __read_mostly;
75
static cpumask_t cpu_singlethread_map __read_mostly;
76 77 78 79 80 81 82
/*
 * _cpu_down() first removes CPU from cpu_online_map, then CPU_DEAD
 * flushes cwq->worklist. This means that flush_workqueue/wait_on_work
 * which comes in between can't use for_each_online_cpu(). We could
 * use cpu_possible_map, the cpumask below is more a documentation
 * than optimization.
 */
83
static cpumask_t cpu_populated_map __read_mostly;
84

L
Linus Torvalds 已提交
85 86 87
/* If it's single threaded, it isn't in the list of workqueues. */
static inline int is_single_threaded(struct workqueue_struct *wq)
{
88
	return wq->singlethread;
L
Linus Torvalds 已提交
89 90
}

91 92 93 94 95 96
static const cpumask_t *wq_cpu_map(struct workqueue_struct *wq)
{
	return is_single_threaded(wq)
		? &cpu_singlethread_map : &cpu_populated_map;
}

97 98 99 100 101 102 103 104
static
struct cpu_workqueue_struct *wq_per_cpu(struct workqueue_struct *wq, int cpu)
{
	if (unlikely(is_single_threaded(wq)))
		cpu = singlethread_cpu;
	return per_cpu_ptr(wq->cpu_wq, cpu);
}

105 106 107 108
/*
 * Set the workqueue on which a work item is to be run
 * - Must *only* be called if the pending flag is set
 */
109 110
static inline void set_wq_data(struct work_struct *work,
				struct cpu_workqueue_struct *cwq)
111
{
112 113 114
	unsigned long new;

	BUG_ON(!work_pending(work));
115

116
	new = (unsigned long) cwq | (1UL << WORK_STRUCT_PENDING);
117 118
	new |= WORK_STRUCT_FLAG_MASK & *work_data_bits(work);
	atomic_long_set(&work->data, new);
119 120
}

121 122
static inline
struct cpu_workqueue_struct *get_wq_data(struct work_struct *work)
123
{
124
	return (void *) (atomic_long_read(&work->data) & WORK_STRUCT_WQ_DATA_MASK);
125 126
}

O
Oleg Nesterov 已提交
127
static void insert_work(struct cpu_workqueue_struct *cwq,
128
			struct work_struct *work, struct list_head *head)
O
Oleg Nesterov 已提交
129 130
{
	set_wq_data(work, cwq);
131 132 133 134 135
	/*
	 * Ensure that we get the right work->data if we see the
	 * result of list_add() below, see try_to_grab_pending().
	 */
	smp_wmb();
136
	list_add_tail(&work->entry, head);
O
Oleg Nesterov 已提交
137 138 139
	wake_up(&cwq->more_work);
}

L
Linus Torvalds 已提交
140 141 142 143 144 145
static void __queue_work(struct cpu_workqueue_struct *cwq,
			 struct work_struct *work)
{
	unsigned long flags;

	spin_lock_irqsave(&cwq->lock, flags);
146
	insert_work(cwq, work, &cwq->worklist);
L
Linus Torvalds 已提交
147 148 149
	spin_unlock_irqrestore(&cwq->lock, flags);
}

150 151 152 153 154
/**
 * queue_work - queue work on a workqueue
 * @wq: workqueue to use
 * @work: work to queue
 *
A
Alan Stern 已提交
155
 * Returns 0 if @work was already on a queue, non-zero otherwise.
L
Linus Torvalds 已提交
156
 *
157 158
 * We queue the work to the CPU on which it was submitted, but if the CPU dies
 * it can be processed by another CPU.
L
Linus Torvalds 已提交
159
 */
160
int queue_work(struct workqueue_struct *wq, struct work_struct *work)
L
Linus Torvalds 已提交
161
{
162 163 164 165 166
	int ret;

	ret = queue_work_on(get_cpu(), wq, work);
	put_cpu();

L
Linus Torvalds 已提交
167 168
	return ret;
}
169
EXPORT_SYMBOL_GPL(queue_work);
L
Linus Torvalds 已提交
170

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
/**
 * queue_work_on - queue work on specific cpu
 * @cpu: CPU number to execute work on
 * @wq: workqueue to use
 * @work: work to queue
 *
 * Returns 0 if @work was already on a queue, non-zero otherwise.
 *
 * We queue the work to a specific CPU, the caller must ensure it
 * can't go away.
 */
int
queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
{
	int ret = 0;

	if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work))) {
		BUG_ON(!list_empty(&work->entry));
		__queue_work(wq_per_cpu(wq, cpu), work);
		ret = 1;
	}
	return ret;
}
EXPORT_SYMBOL_GPL(queue_work_on);

196
static void delayed_work_timer_fn(unsigned long __data)
L
Linus Torvalds 已提交
197
{
198
	struct delayed_work *dwork = (struct delayed_work *)__data;
199 200
	struct cpu_workqueue_struct *cwq = get_wq_data(&dwork->work);
	struct workqueue_struct *wq = cwq->wq;
L
Linus Torvalds 已提交
201

202
	__queue_work(wq_per_cpu(wq, smp_processor_id()), &dwork->work);
L
Linus Torvalds 已提交
203 204
}

205 206 207
/**
 * queue_delayed_work - queue work on a workqueue after delay
 * @wq: workqueue to use
208
 * @dwork: delayable work to queue
209 210
 * @delay: number of jiffies to wait before queueing
 *
A
Alan Stern 已提交
211
 * Returns 0 if @work was already on a queue, non-zero otherwise.
212
 */
213
int queue_delayed_work(struct workqueue_struct *wq,
214
			struct delayed_work *dwork, unsigned long delay)
L
Linus Torvalds 已提交
215
{
216
	if (delay == 0)
217
		return queue_work(wq, &dwork->work);
L
Linus Torvalds 已提交
218

219
	return queue_delayed_work_on(-1, wq, dwork, delay);
L
Linus Torvalds 已提交
220
}
221
EXPORT_SYMBOL_GPL(queue_delayed_work);
L
Linus Torvalds 已提交
222

223 224 225 226
/**
 * queue_delayed_work_on - queue work on specific CPU after delay
 * @cpu: CPU number to execute work on
 * @wq: workqueue to use
227
 * @dwork: work to queue
228 229
 * @delay: number of jiffies to wait before queueing
 *
A
Alan Stern 已提交
230
 * Returns 0 if @work was already on a queue, non-zero otherwise.
231
 */
232
int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
233
			struct delayed_work *dwork, unsigned long delay)
234 235
{
	int ret = 0;
236 237
	struct timer_list *timer = &dwork->timer;
	struct work_struct *work = &dwork->work;
238

239
	if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work))) {
240 241 242
		BUG_ON(timer_pending(timer));
		BUG_ON(!list_empty(&work->entry));

243 244
		timer_stats_timer_set_start_info(&dwork->timer);

245
		/* This stores cwq for the moment, for the timer_fn */
246
		set_wq_data(work, wq_per_cpu(wq, raw_smp_processor_id()));
247
		timer->expires = jiffies + delay;
248
		timer->data = (unsigned long)dwork;
249
		timer->function = delayed_work_timer_fn;
250 251 252 253 254

		if (unlikely(cpu >= 0))
			add_timer_on(timer, cpu);
		else
			add_timer(timer);
255 256 257 258
		ret = 1;
	}
	return ret;
}
259
EXPORT_SYMBOL_GPL(queue_delayed_work_on);
L
Linus Torvalds 已提交
260

261
static void run_workqueue(struct cpu_workqueue_struct *cwq)
L
Linus Torvalds 已提交
262
{
263
	spin_lock_irq(&cwq->lock);
L
Linus Torvalds 已提交
264 265 266 267
	cwq->run_depth++;
	if (cwq->run_depth > 3) {
		/* morton gets to eat his hat */
		printk("%s: recursion depth exceeded: %d\n",
268
			__func__, cwq->run_depth);
L
Linus Torvalds 已提交
269 270 271 272 273
		dump_stack();
	}
	while (!list_empty(&cwq->worklist)) {
		struct work_struct *work = list_entry(cwq->worklist.next,
						struct work_struct, entry);
274
		work_func_t f = work->func;
275 276 277 278 279 280 281 282 283 284 285
#ifdef CONFIG_LOCKDEP
		/*
		 * It is permissible to free the struct work_struct
		 * from inside the function that is called from it,
		 * this we need to take into account for lockdep too.
		 * To avoid bogus "held lock freed" warnings as well
		 * as problems when looking into work->lockdep_map,
		 * make a copy and use that here.
		 */
		struct lockdep_map lockdep_map = work->lockdep_map;
#endif
L
Linus Torvalds 已提交
286

O
Oleg Nesterov 已提交
287
		cwq->current_work = work;
L
Linus Torvalds 已提交
288
		list_del_init(cwq->worklist.next);
289
		spin_unlock_irq(&cwq->lock);
L
Linus Torvalds 已提交
290

291
		BUG_ON(get_wq_data(work) != cwq);
O
Oleg Nesterov 已提交
292
		work_clear_pending(work);
293 294
		lock_acquire(&cwq->wq->lockdep_map, 0, 0, 0, 2, _THIS_IP_);
		lock_acquire(&lockdep_map, 0, 0, 0, 2, _THIS_IP_);
295
		f(work);
296 297
		lock_release(&lockdep_map, 1, _THIS_IP_);
		lock_release(&cwq->wq->lockdep_map, 1, _THIS_IP_);
L
Linus Torvalds 已提交
298

299 300 301 302
		if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
			printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
					"%s/0x%08x/%d\n",
					current->comm, preempt_count(),
303
				       	task_pid_nr(current));
304 305 306 307 308 309
			printk(KERN_ERR "    last function: ");
			print_symbol("%s\n", (unsigned long)f);
			debug_show_held_locks(current);
			dump_stack();
		}

310
		spin_lock_irq(&cwq->lock);
O
Oleg Nesterov 已提交
311
		cwq->current_work = NULL;
L
Linus Torvalds 已提交
312 313
	}
	cwq->run_depth--;
314
	spin_unlock_irq(&cwq->lock);
L
Linus Torvalds 已提交
315 316 317 318 319
}

static int worker_thread(void *__cwq)
{
	struct cpu_workqueue_struct *cwq = __cwq;
320
	DEFINE_WAIT(wait);
L
Linus Torvalds 已提交
321

322 323
	if (cwq->wq->freezeable)
		set_freezable();
L
Linus Torvalds 已提交
324 325 326

	set_user_nice(current, -5);

327 328
	for (;;) {
		prepare_to_wait(&cwq->more_work, &wait, TASK_INTERRUPTIBLE);
329 330 331
		if (!freezing(current) &&
		    !kthread_should_stop() &&
		    list_empty(&cwq->worklist))
L
Linus Torvalds 已提交
332
			schedule();
333 334
		finish_wait(&cwq->more_work, &wait);

335 336
		try_to_freeze();

337
		if (kthread_should_stop())
338
			break;
L
Linus Torvalds 已提交
339

340
		run_workqueue(cwq);
L
Linus Torvalds 已提交
341
	}
342

L
Linus Torvalds 已提交
343 344 345
	return 0;
}

O
Oleg Nesterov 已提交
346 347 348 349 350 351 352 353 354 355 356
struct wq_barrier {
	struct work_struct	work;
	struct completion	done;
};

static void wq_barrier_func(struct work_struct *work)
{
	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
	complete(&barr->done);
}

357
static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
358
			struct wq_barrier *barr, struct list_head *head)
O
Oleg Nesterov 已提交
359 360 361 362 363
{
	INIT_WORK(&barr->work, wq_barrier_func);
	__set_bit(WORK_STRUCT_PENDING, work_data_bits(&barr->work));

	init_completion(&barr->done);
364

365
	insert_work(cwq, &barr->work, head);
O
Oleg Nesterov 已提交
366 367
}

368
static int flush_cpu_workqueue(struct cpu_workqueue_struct *cwq)
L
Linus Torvalds 已提交
369
{
370 371
	int active;

L
Linus Torvalds 已提交
372 373 374 375 376 377
	if (cwq->thread == current) {
		/*
		 * Probably keventd trying to flush its own queue. So simply run
		 * it by hand rather than deadlocking.
		 */
		run_workqueue(cwq);
378
		active = 1;
L
Linus Torvalds 已提交
379
	} else {
O
Oleg Nesterov 已提交
380
		struct wq_barrier barr;
L
Linus Torvalds 已提交
381

382
		active = 0;
383 384
		spin_lock_irq(&cwq->lock);
		if (!list_empty(&cwq->worklist) || cwq->current_work != NULL) {
385
			insert_wq_barrier(cwq, &barr, &cwq->worklist);
386 387 388
			active = 1;
		}
		spin_unlock_irq(&cwq->lock);
L
Linus Torvalds 已提交
389

390
		if (active)
391
			wait_for_completion(&barr.done);
L
Linus Torvalds 已提交
392
	}
393 394

	return active;
L
Linus Torvalds 已提交
395 396
}

397
/**
L
Linus Torvalds 已提交
398
 * flush_workqueue - ensure that any scheduled work has run to completion.
399
 * @wq: workqueue to flush
L
Linus Torvalds 已提交
400 401 402 403
 *
 * Forces execution of the workqueue and blocks until its completion.
 * This is typically used in driver shutdown handlers.
 *
O
Oleg Nesterov 已提交
404 405
 * We sleep until all works which were queued on entry have been handled,
 * but we are not livelocked by new incoming ones.
L
Linus Torvalds 已提交
406 407 408 409
 *
 * This function used to run the workqueues itself.  Now we just wait for the
 * helper threads to do it.
 */
410
void flush_workqueue(struct workqueue_struct *wq)
L
Linus Torvalds 已提交
411
{
412
	const cpumask_t *cpu_map = wq_cpu_map(wq);
413
	int cpu;
L
Linus Torvalds 已提交
414

415
	might_sleep();
416 417
	lock_acquire(&wq->lockdep_map, 0, 0, 0, 2, _THIS_IP_);
	lock_release(&wq->lockdep_map, 1, _THIS_IP_);
418
	for_each_cpu_mask_nr(cpu, *cpu_map)
419
		flush_cpu_workqueue(per_cpu_ptr(wq->cpu_wq, cpu));
L
Linus Torvalds 已提交
420
}
421
EXPORT_SYMBOL_GPL(flush_workqueue);
L
Linus Torvalds 已提交
422

423 424 425 426
/**
 * flush_work - block until a work_struct's callback has terminated
 * @work: the work which is to be flushed
 *
427 428
 * Returns false if @work has already terminated.
 *
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
 * It is expected that, prior to calling flush_work(), the caller has
 * arranged for the work to not be requeued, otherwise it doesn't make
 * sense to use this function.
 */
int flush_work(struct work_struct *work)
{
	struct cpu_workqueue_struct *cwq;
	struct list_head *prev;
	struct wq_barrier barr;

	might_sleep();
	cwq = get_wq_data(work);
	if (!cwq)
		return 0;

444 445 446
	lock_acquire(&cwq->wq->lockdep_map, 0, 0, 0, 2, _THIS_IP_);
	lock_release(&cwq->wq->lockdep_map, 1, _THIS_IP_);

447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
	prev = NULL;
	spin_lock_irq(&cwq->lock);
	if (!list_empty(&work->entry)) {
		/*
		 * See the comment near try_to_grab_pending()->smp_rmb().
		 * If it was re-queued under us we are not going to wait.
		 */
		smp_rmb();
		if (unlikely(cwq != get_wq_data(work)))
			goto out;
		prev = &work->entry;
	} else {
		if (cwq->current_work != work)
			goto out;
		prev = &cwq->worklist;
	}
	insert_wq_barrier(cwq, &barr, prev->next);
out:
	spin_unlock_irq(&cwq->lock);
	if (!prev)
		return 0;

	wait_for_completion(&barr.done);
	return 1;
}
EXPORT_SYMBOL_GPL(flush_work);

474
/*
475
 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
476 477 478 479 480
 * so this work can't be re-armed in any way.
 */
static int try_to_grab_pending(struct work_struct *work)
{
	struct cpu_workqueue_struct *cwq;
481
	int ret = -1;
482 483

	if (!test_and_set_bit(WORK_STRUCT_PENDING, work_data_bits(work)))
484
		return 0;
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513

	/*
	 * The queueing is in progress, or it is already queued. Try to
	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
	 */

	cwq = get_wq_data(work);
	if (!cwq)
		return ret;

	spin_lock_irq(&cwq->lock);
	if (!list_empty(&work->entry)) {
		/*
		 * This work is queued, but perhaps we locked the wrong cwq.
		 * In that case we must see the new value after rmb(), see
		 * insert_work()->wmb().
		 */
		smp_rmb();
		if (cwq == get_wq_data(work)) {
			list_del_init(&work->entry);
			ret = 1;
		}
	}
	spin_unlock_irq(&cwq->lock);

	return ret;
}

static void wait_on_cpu_work(struct cpu_workqueue_struct *cwq,
O
Oleg Nesterov 已提交
514 515 516 517 518 519 520
				struct work_struct *work)
{
	struct wq_barrier barr;
	int running = 0;

	spin_lock_irq(&cwq->lock);
	if (unlikely(cwq->current_work == work)) {
521
		insert_wq_barrier(cwq, &barr, cwq->worklist.next);
O
Oleg Nesterov 已提交
522 523 524 525
		running = 1;
	}
	spin_unlock_irq(&cwq->lock);

526
	if (unlikely(running))
O
Oleg Nesterov 已提交
527 528 529
		wait_for_completion(&barr.done);
}

530
static void wait_on_work(struct work_struct *work)
O
Oleg Nesterov 已提交
531 532
{
	struct cpu_workqueue_struct *cwq;
533 534
	struct workqueue_struct *wq;
	const cpumask_t *cpu_map;
535
	int cpu;
O
Oleg Nesterov 已提交
536

537 538
	might_sleep();

539 540 541
	lock_acquire(&work->lockdep_map, 0, 0, 0, 2, _THIS_IP_);
	lock_release(&work->lockdep_map, 1, _THIS_IP_);

O
Oleg Nesterov 已提交
542 543
	cwq = get_wq_data(work);
	if (!cwq)
544
		return;
O
Oleg Nesterov 已提交
545

546 547 548
	wq = cwq->wq;
	cpu_map = wq_cpu_map(wq);

549
	for_each_cpu_mask_nr(cpu, *cpu_map)
550 551 552
		wait_on_cpu_work(per_cpu_ptr(wq->cpu_wq, cpu), work);
}

553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
static int __cancel_work_timer(struct work_struct *work,
				struct timer_list* timer)
{
	int ret;

	do {
		ret = (timer && likely(del_timer(timer)));
		if (!ret)
			ret = try_to_grab_pending(work);
		wait_on_work(work);
	} while (unlikely(ret < 0));

	work_clear_pending(work);
	return ret;
}

569 570 571 572
/**
 * cancel_work_sync - block until a work_struct's callback has terminated
 * @work: the work which is to be flushed
 *
573 574
 * Returns true if @work was pending.
 *
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
 * cancel_work_sync() will cancel the work if it is queued. If the work's
 * callback appears to be running, cancel_work_sync() will block until it
 * has completed.
 *
 * It is possible to use this function if the work re-queues itself. It can
 * cancel the work even if it migrates to another workqueue, however in that
 * case it only guarantees that work->func() has completed on the last queued
 * workqueue.
 *
 * cancel_work_sync(&delayed_work->work) should be used only if ->timer is not
 * pending, otherwise it goes into a busy-wait loop until the timer expires.
 *
 * The caller must ensure that workqueue_struct on which this work was last
 * queued can't be destroyed before this function returns.
 */
590
int cancel_work_sync(struct work_struct *work)
591
{
592
	return __cancel_work_timer(work, NULL);
O
Oleg Nesterov 已提交
593
}
594
EXPORT_SYMBOL_GPL(cancel_work_sync);
O
Oleg Nesterov 已提交
595

596
/**
597
 * cancel_delayed_work_sync - reliably kill off a delayed work.
598 599
 * @dwork: the delayed work struct
 *
600 601
 * Returns true if @dwork was pending.
 *
602 603 604
 * It is possible to use this function if @dwork rearms itself via queue_work()
 * or queue_delayed_work(). See also the comment for cancel_work_sync().
 */
605
int cancel_delayed_work_sync(struct delayed_work *dwork)
606
{
607
	return __cancel_work_timer(&dwork->work, &dwork->timer);
608
}
609
EXPORT_SYMBOL(cancel_delayed_work_sync);
L
Linus Torvalds 已提交
610

611
static struct workqueue_struct *keventd_wq __read_mostly;
L
Linus Torvalds 已提交
612

613 614 615 616 617 618
/**
 * schedule_work - put work task in global workqueue
 * @work: job to be done
 *
 * This puts a job in the kernel-global workqueue.
 */
619
int schedule_work(struct work_struct *work)
L
Linus Torvalds 已提交
620 621 622
{
	return queue_work(keventd_wq, work);
}
623
EXPORT_SYMBOL(schedule_work);
L
Linus Torvalds 已提交
624

625 626 627 628 629 630 631 632 633 634 635 636 637
/*
 * schedule_work_on - put work task on a specific cpu
 * @cpu: cpu to put the work task on
 * @work: job to be done
 *
 * This puts a job on a specific cpu
 */
int schedule_work_on(int cpu, struct work_struct *work)
{
	return queue_work_on(cpu, keventd_wq, work);
}
EXPORT_SYMBOL(schedule_work_on);

638 639
/**
 * schedule_delayed_work - put work task in global workqueue after delay
640 641
 * @dwork: job to be done
 * @delay: number of jiffies to wait or 0 for immediate execution
642 643 644 645
 *
 * After waiting for a given time this puts a job in the kernel-global
 * workqueue.
 */
646
int schedule_delayed_work(struct delayed_work *dwork,
647
					unsigned long delay)
L
Linus Torvalds 已提交
648
{
649
	return queue_delayed_work(keventd_wq, dwork, delay);
L
Linus Torvalds 已提交
650
}
651
EXPORT_SYMBOL(schedule_delayed_work);
L
Linus Torvalds 已提交
652

653 654 655
/**
 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
 * @cpu: cpu to use
656
 * @dwork: job to be done
657 658 659 660 661
 * @delay: number of jiffies to wait
 *
 * After waiting for a given time this puts a job in the kernel-global
 * workqueue on the specified CPU.
 */
L
Linus Torvalds 已提交
662
int schedule_delayed_work_on(int cpu,
663
			struct delayed_work *dwork, unsigned long delay)
L
Linus Torvalds 已提交
664
{
665
	return queue_delayed_work_on(cpu, keventd_wq, dwork, delay);
L
Linus Torvalds 已提交
666
}
667
EXPORT_SYMBOL(schedule_delayed_work_on);
L
Linus Torvalds 已提交
668

669 670 671 672 673 674 675 676 677
/**
 * schedule_on_each_cpu - call a function on each online CPU from keventd
 * @func: the function to call
 *
 * Returns zero on success.
 * Returns -ve errno on failure.
 *
 * schedule_on_each_cpu() is very slow.
 */
678
int schedule_on_each_cpu(work_func_t func)
679 680
{
	int cpu;
681
	struct work_struct *works;
682

683 684
	works = alloc_percpu(struct work_struct);
	if (!works)
685
		return -ENOMEM;
686

687
	get_online_cpus();
688
	for_each_online_cpu(cpu) {
689 690 691
		struct work_struct *work = per_cpu_ptr(works, cpu);

		INIT_WORK(work, func);
692
		schedule_work_on(cpu, work);
693
	}
694 695
	for_each_online_cpu(cpu)
		flush_work(per_cpu_ptr(works, cpu));
696
	put_online_cpus();
697
	free_percpu(works);
698 699 700
	return 0;
}

L
Linus Torvalds 已提交
701 702 703 704
void flush_scheduled_work(void)
{
	flush_workqueue(keventd_wq);
}
705
EXPORT_SYMBOL(flush_scheduled_work);
L
Linus Torvalds 已提交
706

707 708 709 710 711 712 713 714 715 716 717 718
/**
 * execute_in_process_context - reliably execute the routine with user context
 * @fn:		the function to execute
 * @ew:		guaranteed storage for the execute work structure (must
 *		be available when the work executes)
 *
 * Executes the function immediately if process context is available,
 * otherwise schedules the function for delayed execution.
 *
 * Returns:	0 - function was executed
 *		1 - function was scheduled for execution
 */
719
int execute_in_process_context(work_func_t fn, struct execute_work *ew)
720 721
{
	if (!in_interrupt()) {
722
		fn(&ew->work);
723 724 725
		return 0;
	}

726
	INIT_WORK(&ew->work, fn);
727 728 729 730 731 732
	schedule_work(&ew->work);

	return 1;
}
EXPORT_SYMBOL_GPL(execute_in_process_context);

L
Linus Torvalds 已提交
733 734 735 736 737 738 739 740
int keventd_up(void)
{
	return keventd_wq != NULL;
}

int current_is_keventd(void)
{
	struct cpu_workqueue_struct *cwq;
H
Hugh Dickins 已提交
741
	int cpu = raw_smp_processor_id(); /* preempt-safe: keventd is per-cpu */
L
Linus Torvalds 已提交
742 743 744 745
	int ret = 0;

	BUG_ON(!keventd_wq);

746
	cwq = per_cpu_ptr(keventd_wq->cpu_wq, cpu);
L
Linus Torvalds 已提交
747 748 749 750 751 752 753
	if (current == cwq->thread)
		ret = 1;

	return ret;

}

754 755
static struct cpu_workqueue_struct *
init_cpu_workqueue(struct workqueue_struct *wq, int cpu)
L
Linus Torvalds 已提交
756
{
757
	struct cpu_workqueue_struct *cwq = per_cpu_ptr(wq->cpu_wq, cpu);
L
Linus Torvalds 已提交
758

759 760 761 762 763 764
	cwq->wq = wq;
	spin_lock_init(&cwq->lock);
	INIT_LIST_HEAD(&cwq->worklist);
	init_waitqueue_head(&cwq->more_work);

	return cwq;
L
Linus Torvalds 已提交
765 766
}

767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
static int create_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
{
	struct workqueue_struct *wq = cwq->wq;
	const char *fmt = is_single_threaded(wq) ? "%s" : "%s/%d";
	struct task_struct *p;

	p = kthread_create(worker_thread, cwq, fmt, wq->name, cpu);
	/*
	 * Nobody can add the work_struct to this cwq,
	 *	if (caller is __create_workqueue)
	 *		nobody should see this wq
	 *	else // caller is CPU_UP_PREPARE
	 *		cpu is not on cpu_online_map
	 * so we can abort safely.
	 */
	if (IS_ERR(p))
		return PTR_ERR(p);

	cwq->thread = p;

	return 0;
}

790 791 792 793 794 795 796 797 798 799 800
static void start_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu)
{
	struct task_struct *p = cwq->thread;

	if (p != NULL) {
		if (cpu >= 0)
			kthread_bind(p, cpu);
		wake_up_process(p);
	}
}

801 802 803
struct workqueue_struct *__create_workqueue_key(const char *name,
						int singlethread,
						int freezeable,
804 805
						struct lock_class_key *key,
						const char *lock_name)
L
Linus Torvalds 已提交
806 807
{
	struct workqueue_struct *wq;
808 809
	struct cpu_workqueue_struct *cwq;
	int err = 0, cpu;
L
Linus Torvalds 已提交
810

811 812 813 814 815 816 817 818 819 820 821
	wq = kzalloc(sizeof(*wq), GFP_KERNEL);
	if (!wq)
		return NULL;

	wq->cpu_wq = alloc_percpu(struct cpu_workqueue_struct);
	if (!wq->cpu_wq) {
		kfree(wq);
		return NULL;
	}

	wq->name = name;
822
	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
823
	wq->singlethread = singlethread;
824
	wq->freezeable = freezeable;
825
	INIT_LIST_HEAD(&wq->list);
826 827 828 829

	if (singlethread) {
		cwq = init_cpu_workqueue(wq, singlethread_cpu);
		err = create_workqueue_thread(cwq, singlethread_cpu);
830
		start_workqueue_thread(cwq, -1);
831
	} else {
832
		cpu_maps_update_begin();
833
		spin_lock(&workqueue_lock);
834
		list_add(&wq->list, &workqueues);
835
		spin_unlock(&workqueue_lock);
836 837 838 839 840 841

		for_each_possible_cpu(cpu) {
			cwq = init_cpu_workqueue(wq, cpu);
			if (err || !cpu_online(cpu))
				continue;
			err = create_workqueue_thread(cwq, cpu);
842
			start_workqueue_thread(cwq, cpu);
L
Linus Torvalds 已提交
843
		}
844
		cpu_maps_update_done();
845 846 847 848 849 850 851 852
	}

	if (err) {
		destroy_workqueue(wq);
		wq = NULL;
	}
	return wq;
}
853
EXPORT_SYMBOL_GPL(__create_workqueue_key);
L
Linus Torvalds 已提交
854

855
static void cleanup_workqueue_thread(struct cpu_workqueue_struct *cwq)
856
{
857
	/*
858 859
	 * Our caller is either destroy_workqueue() or CPU_POST_DEAD,
	 * cpu_add_remove_lock protects cwq->thread.
860 861 862
	 */
	if (cwq->thread == NULL)
		return;
863

864 865 866
	lock_acquire(&cwq->wq->lockdep_map, 0, 0, 0, 2, _THIS_IP_);
	lock_release(&cwq->wq->lockdep_map, 1, _THIS_IP_);

O
Oleg Nesterov 已提交
867
	flush_cpu_workqueue(cwq);
868
	/*
869
	 * If the caller is CPU_POST_DEAD and cwq->worklist was not empty,
O
Oleg Nesterov 已提交
870 871 872
	 * a concurrent flush_workqueue() can insert a barrier after us.
	 * However, in that case run_workqueue() won't return and check
	 * kthread_should_stop() until it flushes all work_struct's.
873 874 875 876 877 878 879
	 * When ->worklist becomes empty it is safe to exit because no
	 * more work_structs can be queued on this cwq: flush_workqueue
	 * checks list_empty(), and a "normal" queue_work() can't use
	 * a dead CPU.
	 */
	kthread_stop(cwq->thread);
	cwq->thread = NULL;
880 881 882 883 884 885 886 887 888 889
}

/**
 * destroy_workqueue - safely terminate a workqueue
 * @wq: target workqueue
 *
 * Safely destroy a workqueue. All work currently pending will be done first.
 */
void destroy_workqueue(struct workqueue_struct *wq)
{
890 891
	const cpumask_t *cpu_map = wq_cpu_map(wq);
	int cpu;
892

893
	cpu_maps_update_begin();
894
	spin_lock(&workqueue_lock);
895
	list_del(&wq->list);
896
	spin_unlock(&workqueue_lock);
897

898
	for_each_cpu_mask_nr(cpu, *cpu_map)
899
		cleanup_workqueue_thread(per_cpu_ptr(wq->cpu_wq, cpu));
900
 	cpu_maps_update_done();
901

902 903 904 905 906 907 908 909 910 911 912 913
	free_percpu(wq->cpu_wq);
	kfree(wq);
}
EXPORT_SYMBOL_GPL(destroy_workqueue);

static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
						unsigned long action,
						void *hcpu)
{
	unsigned int cpu = (unsigned long)hcpu;
	struct cpu_workqueue_struct *cwq;
	struct workqueue_struct *wq;
914
	int ret = NOTIFY_OK;
915

916 917
	action &= ~CPU_TASKS_FROZEN;

918 919 920 921
	switch (action) {
	case CPU_UP_PREPARE:
		cpu_set(cpu, cpu_populated_map);
	}
922
undo:
923 924 925 926 927 928 929
	list_for_each_entry(wq, &workqueues, list) {
		cwq = per_cpu_ptr(wq->cpu_wq, cpu);

		switch (action) {
		case CPU_UP_PREPARE:
			if (!create_workqueue_thread(cwq, cpu))
				break;
930 931
			printk(KERN_ERR "workqueue [%s] for %i failed\n",
				wq->name, cpu);
932 933 934
			action = CPU_UP_CANCELED;
			ret = NOTIFY_BAD;
			goto undo;
935 936

		case CPU_ONLINE:
937
			start_workqueue_thread(cwq, cpu);
938 939 940
			break;

		case CPU_UP_CANCELED:
941
			start_workqueue_thread(cwq, -1);
942
		case CPU_POST_DEAD:
943
			cleanup_workqueue_thread(cwq);
944 945
			break;
		}
L
Linus Torvalds 已提交
946 947
	}

948 949
	switch (action) {
	case CPU_UP_CANCELED:
950
	case CPU_POST_DEAD:
951 952 953
		cpu_clear(cpu, cpu_populated_map);
	}

954
	return ret;
L
Linus Torvalds 已提交
955 956
}

957
void __init init_workqueues(void)
L
Linus Torvalds 已提交
958
{
959
	cpu_populated_map = cpu_online_map;
960
	singlethread_cpu = first_cpu(cpu_possible_map);
961
	cpu_singlethread_map = cpumask_of_cpu(singlethread_cpu);
L
Linus Torvalds 已提交
962 963 964 965
	hotcpu_notifier(workqueue_cpu_callback, 0);
	keventd_wq = create_workqueue("events");
	BUG_ON(!keventd_wq);
}