workqueue.c 42.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11
/*
 * 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>
12
 *   Andrew Morton
L
Linus Torvalds 已提交
13 14
 *   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>
T
Tejun Heo 已提交
36
#include <linux/idr.h>
L
Linus Torvalds 已提交
37

T
Tejun Heo 已提交
38 39 40 41 42 43 44
/*
 * Structure fields follow one of the following exclusion rules.
 *
 * I: Set during initialization and read-only afterwards.
 *
 * L: cwq->lock protected.  Access with cwq->lock held.
 *
45 46
 * F: wq->flush_mutex protected.
 *
T
Tejun Heo 已提交
47 48 49
 * W: workqueue_lock protected.
 */

T
Tejun Heo 已提交
50 51 52 53
struct cpu_workqueue_struct;

struct worker {
	struct work_struct	*current_work;	/* L: work being processed */
54
	struct list_head	scheduled;	/* L: scheduled works */
T
Tejun Heo 已提交
55 56 57 58 59
	struct task_struct	*task;		/* I: worker task */
	struct cpu_workqueue_struct *cwq;	/* I: the associated cwq */
	int			id;		/* I: worker id */
};

L
Linus Torvalds 已提交
60
/*
61
 * The per-CPU workqueue (if single thread, we always use the first
T
Tejun Heo 已提交
62 63 64
 * possible cpu).  The lower WORK_STRUCT_FLAG_BITS of
 * work_struct->data are used for flags and thus cwqs need to be
 * aligned at two's power of the number of flag bits.
L
Linus Torvalds 已提交
65 66 67 68 69 70 71
 */
struct cpu_workqueue_struct {

	spinlock_t lock;

	struct list_head worklist;
	wait_queue_head_t more_work;
T
Tejun Heo 已提交
72
	unsigned int		cpu;
T
Tejun Heo 已提交
73
	struct worker		*worker;
L
Linus Torvalds 已提交
74

T
Tejun Heo 已提交
75
	struct workqueue_struct *wq;		/* I: the owning workqueue */
76 77 78 79
	int			work_color;	/* L: current color */
	int			flush_color;	/* L: flushing color */
	int			nr_in_flight[WORK_NR_COLORS];
						/* L: nr of in_flight works */
T
Tejun Heo 已提交
80
};
L
Linus Torvalds 已提交
81

82 83 84 85 86 87 88 89 90
/*
 * Structure used to wait for workqueue flush.
 */
struct wq_flusher {
	struct list_head	list;		/* F: list of flushers */
	int			flush_color;	/* F: flush color waiting for */
	struct completion	done;		/* flush completion */
};

L
Linus Torvalds 已提交
91 92 93 94 95
/*
 * The externally visible workqueue abstraction is an array of
 * per-CPU workqueues:
 */
struct workqueue_struct {
96
	unsigned int		flags;		/* I: WQ_* flags */
T
Tejun Heo 已提交
97 98
	struct cpu_workqueue_struct *cpu_wq;	/* I: cwq's */
	struct list_head	list;		/* W: list of all workqueues */
99 100 101 102 103 104 105 106 107

	struct mutex		flush_mutex;	/* protects wq flushing */
	int			work_color;	/* F: current work color */
	int			flush_color;	/* F: current flush color */
	atomic_t		nr_cwqs_to_flush; /* flush in progress */
	struct wq_flusher	*first_flusher;	/* F: first flusher */
	struct list_head	flusher_queue;	/* F: flush waiters */
	struct list_head	flusher_overflow; /* F: flush overflow list */

T
Tejun Heo 已提交
108
	const char		*name;		/* I: workqueue name */
109
#ifdef CONFIG_LOCKDEP
T
Tejun Heo 已提交
110
	struct lockdep_map	lockdep_map;
111
#endif
L
Linus Torvalds 已提交
112 113
};

114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
#ifdef CONFIG_DEBUG_OBJECTS_WORK

static struct debug_obj_descr work_debug_descr;

/*
 * fixup_init is called when:
 * - an active object is initialized
 */
static int work_fixup_init(void *addr, enum debug_obj_state state)
{
	struct work_struct *work = addr;

	switch (state) {
	case ODEBUG_STATE_ACTIVE:
		cancel_work_sync(work);
		debug_object_init(work, &work_debug_descr);
		return 1;
	default:
		return 0;
	}
}

/*
 * fixup_activate is called when:
 * - an active object is activated
 * - an unknown object is activated (might be a statically initialized object)
 */
static int work_fixup_activate(void *addr, enum debug_obj_state state)
{
	struct work_struct *work = addr;

	switch (state) {

	case ODEBUG_STATE_NOTAVAILABLE:
		/*
		 * This is not really a fixup. The work struct was
		 * statically initialized. We just make sure that it
		 * is tracked in the object tracker.
		 */
153
		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
			debug_object_init(work, &work_debug_descr);
			debug_object_activate(work, &work_debug_descr);
			return 0;
		}
		WARN_ON_ONCE(1);
		return 0;

	case ODEBUG_STATE_ACTIVE:
		WARN_ON(1);

	default:
		return 0;
	}
}

/*
 * fixup_free is called when:
 * - an active object is freed
 */
static int work_fixup_free(void *addr, enum debug_obj_state state)
{
	struct work_struct *work = addr;

	switch (state) {
	case ODEBUG_STATE_ACTIVE:
		cancel_work_sync(work);
		debug_object_free(work, &work_debug_descr);
		return 1;
	default:
		return 0;
	}
}

static struct debug_obj_descr work_debug_descr = {
	.name		= "work_struct",
	.fixup_init	= work_fixup_init,
	.fixup_activate	= work_fixup_activate,
	.fixup_free	= work_fixup_free,
};

static inline void debug_work_activate(struct work_struct *work)
{
	debug_object_activate(work, &work_debug_descr);
}

static inline void debug_work_deactivate(struct work_struct *work)
{
	debug_object_deactivate(work, &work_debug_descr);
}

void __init_work(struct work_struct *work, int onstack)
{
	if (onstack)
		debug_object_init_on_stack(work, &work_debug_descr);
	else
		debug_object_init(work, &work_debug_descr);
}
EXPORT_SYMBOL_GPL(__init_work);

void destroy_work_on_stack(struct work_struct *work)
{
	debug_object_free(work, &work_debug_descr);
}
EXPORT_SYMBOL_GPL(destroy_work_on_stack);

#else
static inline void debug_work_activate(struct work_struct *work) { }
static inline void debug_work_deactivate(struct work_struct *work) { }
#endif

224 225
/* Serializes the accesses to the list of workqueues. */
static DEFINE_SPINLOCK(workqueue_lock);
L
Linus Torvalds 已提交
226
static LIST_HEAD(workqueues);
T
Tejun Heo 已提交
227 228 229
static DEFINE_PER_CPU(struct ida, worker_ida);

static int worker_thread(void *__worker);
L
Linus Torvalds 已提交
230

231
static int singlethread_cpu __read_mostly;
L
Linus Torvalds 已提交
232

T
Tejun Heo 已提交
233 234
static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
					    struct workqueue_struct *wq)
235
{
T
Tejun Heo 已提交
236
	return per_cpu_ptr(wq->cpu_wq, cpu);
237 238
}

T
Tejun Heo 已提交
239 240
static struct cpu_workqueue_struct *target_cwq(unsigned int cpu,
					       struct workqueue_struct *wq)
241
{
T
Tejun Heo 已提交
242
	if (unlikely(wq->flags & WQ_SINGLE_THREAD))
243
		cpu = singlethread_cpu;
T
Tejun Heo 已提交
244
	return get_cwq(cpu, wq);
245 246
}

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
static unsigned int work_color_to_flags(int color)
{
	return color << WORK_STRUCT_COLOR_SHIFT;
}

static int get_work_color(struct work_struct *work)
{
	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
		((1 << WORK_STRUCT_COLOR_BITS) - 1);
}

static int work_next_color(int color)
{
	return (color + 1) % WORK_NR_COLORS;
}

263 264 265 266
/*
 * Set the workqueue on which a work item is to be run
 * - Must *only* be called if the pending flag is set
 */
267
static inline void set_wq_data(struct work_struct *work,
T
Tejun Heo 已提交
268 269
			       struct cpu_workqueue_struct *cwq,
			       unsigned long extra_flags)
270
{
271
	BUG_ON(!work_pending(work));
272

T
Tejun Heo 已提交
273
	atomic_long_set(&work->data, (unsigned long)cwq | work_static(work) |
274
			WORK_STRUCT_PENDING | extra_flags);
275 276
}

277 278 279 280 281
/*
 * Clear WORK_STRUCT_PENDING and the workqueue on which it was queued.
 */
static inline void clear_wq_data(struct work_struct *work)
{
T
Tejun Heo 已提交
282
	atomic_long_set(&work->data, work_static(work));
283 284
}

285
static inline struct cpu_workqueue_struct *get_wq_data(struct work_struct *work)
286
{
287 288
	return (void *)(atomic_long_read(&work->data) &
			WORK_STRUCT_WQ_DATA_MASK);
289 290
}

T
Tejun Heo 已提交
291 292 293 294 295 296 297 298 299 300 301 302
/**
 * insert_work - insert a work into cwq
 * @cwq: cwq @work belongs to
 * @work: work to insert
 * @head: insertion point
 * @extra_flags: extra WORK_STRUCT_* flags to set
 *
 * Insert @work into @cwq after @head.
 *
 * CONTEXT:
 * spin_lock_irq(cwq->lock).
 */
O
Oleg Nesterov 已提交
303
static void insert_work(struct cpu_workqueue_struct *cwq,
T
Tejun Heo 已提交
304 305
			struct work_struct *work, struct list_head *head,
			unsigned int extra_flags)
O
Oleg Nesterov 已提交
306
{
T
Tejun Heo 已提交
307 308 309
	/* we own @work, set data and link */
	set_wq_data(work, cwq, extra_flags);

310 311 312 313 314
	/*
	 * Ensure that we get the right work->data if we see the
	 * result of list_add() below, see try_to_grab_pending().
	 */
	smp_wmb();
T
Tejun Heo 已提交
315

316
	list_add_tail(&work->entry, head);
O
Oleg Nesterov 已提交
317 318 319
	wake_up(&cwq->more_work);
}

T
Tejun Heo 已提交
320
static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
L
Linus Torvalds 已提交
321 322
			 struct work_struct *work)
{
T
Tejun Heo 已提交
323
	struct cpu_workqueue_struct *cwq = target_cwq(cpu, wq);
L
Linus Torvalds 已提交
324 325
	unsigned long flags;

326
	debug_work_activate(work);
L
Linus Torvalds 已提交
327
	spin_lock_irqsave(&cwq->lock, flags);
T
Tejun Heo 已提交
328
	BUG_ON(!list_empty(&work->entry));
329 330 331
	cwq->nr_in_flight[cwq->work_color]++;
	insert_work(cwq, work, &cwq->worklist,
		    work_color_to_flags(cwq->work_color));
L
Linus Torvalds 已提交
332 333 334
	spin_unlock_irqrestore(&cwq->lock, flags);
}

335 336 337 338 339
/**
 * queue_work - queue work on a workqueue
 * @wq: workqueue to use
 * @work: work to queue
 *
A
Alan Stern 已提交
340
 * Returns 0 if @work was already on a queue, non-zero otherwise.
L
Linus Torvalds 已提交
341
 *
342 343
 * 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 已提交
344
 */
345
int queue_work(struct workqueue_struct *wq, struct work_struct *work)
L
Linus Torvalds 已提交
346
{
347 348 349 350 351
	int ret;

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

L
Linus Torvalds 已提交
352 353
	return ret;
}
354
EXPORT_SYMBOL_GPL(queue_work);
L
Linus Torvalds 已提交
355

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
/**
 * 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;

372
	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
T
Tejun Heo 已提交
373
		__queue_work(cpu, wq, work);
374 375 376 377 378 379
		ret = 1;
	}
	return ret;
}
EXPORT_SYMBOL_GPL(queue_work_on);

380
static void delayed_work_timer_fn(unsigned long __data)
L
Linus Torvalds 已提交
381
{
382
	struct delayed_work *dwork = (struct delayed_work *)__data;
383
	struct cpu_workqueue_struct *cwq = get_wq_data(&dwork->work);
L
Linus Torvalds 已提交
384

T
Tejun Heo 已提交
385
	__queue_work(smp_processor_id(), cwq->wq, &dwork->work);
L
Linus Torvalds 已提交
386 387
}

388 389 390
/**
 * queue_delayed_work - queue work on a workqueue after delay
 * @wq: workqueue to use
391
 * @dwork: delayable work to queue
392 393
 * @delay: number of jiffies to wait before queueing
 *
A
Alan Stern 已提交
394
 * Returns 0 if @work was already on a queue, non-zero otherwise.
395
 */
396
int queue_delayed_work(struct workqueue_struct *wq,
397
			struct delayed_work *dwork, unsigned long delay)
L
Linus Torvalds 已提交
398
{
399
	if (delay == 0)
400
		return queue_work(wq, &dwork->work);
L
Linus Torvalds 已提交
401

402
	return queue_delayed_work_on(-1, wq, dwork, delay);
L
Linus Torvalds 已提交
403
}
404
EXPORT_SYMBOL_GPL(queue_delayed_work);
L
Linus Torvalds 已提交
405

406 407 408 409
/**
 * queue_delayed_work_on - queue work on specific CPU after delay
 * @cpu: CPU number to execute work on
 * @wq: workqueue to use
410
 * @dwork: work to queue
411 412
 * @delay: number of jiffies to wait before queueing
 *
A
Alan Stern 已提交
413
 * Returns 0 if @work was already on a queue, non-zero otherwise.
414
 */
415
int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
416
			struct delayed_work *dwork, unsigned long delay)
417 418
{
	int ret = 0;
419 420
	struct timer_list *timer = &dwork->timer;
	struct work_struct *work = &dwork->work;
421

422
	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
423 424 425
		BUG_ON(timer_pending(timer));
		BUG_ON(!list_empty(&work->entry));

426 427
		timer_stats_timer_set_start_info(&dwork->timer);

428
		/* This stores cwq for the moment, for the timer_fn */
T
Tejun Heo 已提交
429
		set_wq_data(work, target_cwq(raw_smp_processor_id(), wq), 0);
430
		timer->expires = jiffies + delay;
431
		timer->data = (unsigned long)dwork;
432
		timer->function = delayed_work_timer_fn;
433 434 435 436 437

		if (unlikely(cpu >= 0))
			add_timer_on(timer, cpu);
		else
			add_timer(timer);
438 439 440 441
		ret = 1;
	}
	return ret;
}
442
EXPORT_SYMBOL_GPL(queue_delayed_work_on);
L
Linus Torvalds 已提交
443

T
Tejun Heo 已提交
444 445 446 447 448
static struct worker *alloc_worker(void)
{
	struct worker *worker;

	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
449 450
	if (worker)
		INIT_LIST_HEAD(&worker->scheduled);
T
Tejun Heo 已提交
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 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 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
	return worker;
}

/**
 * create_worker - create a new workqueue worker
 * @cwq: cwq the new worker will belong to
 * @bind: whether to set affinity to @cpu or not
 *
 * Create a new worker which is bound to @cwq.  The returned worker
 * can be started by calling start_worker() or destroyed using
 * destroy_worker().
 *
 * CONTEXT:
 * Might sleep.  Does GFP_KERNEL allocations.
 *
 * RETURNS:
 * Pointer to the newly created worker.
 */
static struct worker *create_worker(struct cpu_workqueue_struct *cwq, bool bind)
{
	int id = -1;
	struct worker *worker = NULL;

	spin_lock(&workqueue_lock);
	while (ida_get_new(&per_cpu(worker_ida, cwq->cpu), &id)) {
		spin_unlock(&workqueue_lock);
		if (!ida_pre_get(&per_cpu(worker_ida, cwq->cpu), GFP_KERNEL))
			goto fail;
		spin_lock(&workqueue_lock);
	}
	spin_unlock(&workqueue_lock);

	worker = alloc_worker();
	if (!worker)
		goto fail;

	worker->cwq = cwq;
	worker->id = id;

	worker->task = kthread_create(worker_thread, worker, "kworker/%u:%d",
				      cwq->cpu, id);
	if (IS_ERR(worker->task))
		goto fail;

	if (bind)
		kthread_bind(worker->task, cwq->cpu);

	return worker;
fail:
	if (id >= 0) {
		spin_lock(&workqueue_lock);
		ida_remove(&per_cpu(worker_ida, cwq->cpu), id);
		spin_unlock(&workqueue_lock);
	}
	kfree(worker);
	return NULL;
}

/**
 * start_worker - start a newly created worker
 * @worker: worker to start
 *
 * Start @worker.
 *
 * CONTEXT:
 * spin_lock_irq(cwq->lock).
 */
static void start_worker(struct worker *worker)
{
	wake_up_process(worker->task);
}

/**
 * destroy_worker - destroy a workqueue worker
 * @worker: worker to be destroyed
 *
 * Destroy @worker.
 */
static void destroy_worker(struct worker *worker)
{
	int cpu = worker->cwq->cpu;
	int id = worker->id;

	/* sanity check frenzy */
	BUG_ON(worker->current_work);
536
	BUG_ON(!list_empty(&worker->scheduled));
T
Tejun Heo 已提交
537 538 539 540 541 542 543 544 545

	kthread_stop(worker->task);
	kfree(worker);

	spin_lock(&workqueue_lock);
	ida_remove(&per_cpu(worker_ida, cpu), id);
	spin_unlock(&workqueue_lock);
}

546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
/**
 * move_linked_works - move linked works to a list
 * @work: start of series of works to be scheduled
 * @head: target list to append @work to
 * @nextp: out paramter for nested worklist walking
 *
 * Schedule linked works starting from @work to @head.  Work series to
 * be scheduled starts at @work and includes any consecutive work with
 * WORK_STRUCT_LINKED set in its predecessor.
 *
 * If @nextp is not NULL, it's updated to point to the next work of
 * the last scheduled work.  This allows move_linked_works() to be
 * nested inside outer list_for_each_entry_safe().
 *
 * CONTEXT:
 * spin_lock_irq(cwq->lock).
 */
static void move_linked_works(struct work_struct *work, struct list_head *head,
			      struct work_struct **nextp)
{
	struct work_struct *n;

	/*
	 * Linked worklist will always end before the end of the list,
	 * use NULL for list head.
	 */
	list_for_each_entry_safe_from(work, n, NULL, entry) {
		list_move_tail(&work->entry, head);
		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
			break;
	}

	/*
	 * If we're already inside safe list traversal and have moved
	 * multiple works to the scheduled queue, the next position
	 * needs to be updated.
	 */
	if (nextp)
		*nextp = n;
}

587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
/**
 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
 * @cwq: cwq of interest
 * @color: color of work which left the queue
 *
 * A work either has completed or is removed from pending queue,
 * decrement nr_in_flight of its cwq and handle workqueue flushing.
 *
 * CONTEXT:
 * spin_lock_irq(cwq->lock).
 */
static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
{
	/* ignore uncolored works */
	if (color == WORK_NO_COLOR)
		return;

	cwq->nr_in_flight[color]--;

	/* is flush in progress and are we at the flushing tip? */
	if (likely(cwq->flush_color != color))
		return;

	/* are there still in-flight works? */
	if (cwq->nr_in_flight[color])
		return;

	/* this cwq is done, clear flush_color */
	cwq->flush_color = -1;

	/*
	 * If this was the last cwq, wake up the first flusher.  It
	 * will handle the rest.
	 */
	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
		complete(&cwq->wq->first_flusher->done);
}

625 626
/**
 * process_one_work - process single work
T
Tejun Heo 已提交
627
 * @worker: self
628 629 630 631 632 633 634 635 636 637 638
 * @work: work to process
 *
 * Process @work.  This function contains all the logics necessary to
 * process a single work including synchronization against and
 * interaction with other workers on the same cpu, queueing and
 * flushing.  As long as context requirement is met, any worker can
 * call this function to process a work.
 *
 * CONTEXT:
 * spin_lock_irq(cwq->lock) which is released and regrabbed.
 */
T
Tejun Heo 已提交
639
static void process_one_work(struct worker *worker, struct work_struct *work)
640
{
T
Tejun Heo 已提交
641
	struct cpu_workqueue_struct *cwq = worker->cwq;
642
	work_func_t f = work->func;
643
	int work_color;
644 645 646 647 648 649 650 651 652 653 654 655
#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
	/* claim and process */
	debug_work_deactivate(work);
T
Tejun Heo 已提交
656
	worker->current_work = work;
657
	work_color = get_work_color(work);
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
	list_del_init(&work->entry);

	spin_unlock_irq(&cwq->lock);

	BUG_ON(get_wq_data(work) != cwq);
	work_clear_pending(work);
	lock_map_acquire(&cwq->wq->lockdep_map);
	lock_map_acquire(&lockdep_map);
	f(work);
	lock_map_release(&lockdep_map);
	lock_map_release(&cwq->wq->lockdep_map);

	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(), task_pid_nr(current));
		printk(KERN_ERR "    last function: ");
		print_symbol("%s\n", (unsigned long)f);
		debug_show_held_locks(current);
		dump_stack();
	}

	spin_lock_irq(&cwq->lock);

	/* we're done with it, release */
T
Tejun Heo 已提交
683
	worker->current_work = NULL;
684
	cwq_dec_nr_in_flight(cwq, work_color);
685 686
}

687 688 689 690 691 692 693 694 695 696 697 698 699
/**
 * process_scheduled_works - process scheduled works
 * @worker: self
 *
 * Process all scheduled works.  Please note that the scheduled list
 * may change while processing a work, so this function repeatedly
 * fetches a work from the top and executes it.
 *
 * CONTEXT:
 * spin_lock_irq(cwq->lock) which may be released and regrabbed
 * multiple times.
 */
static void process_scheduled_works(struct worker *worker)
L
Linus Torvalds 已提交
700
{
701 702
	while (!list_empty(&worker->scheduled)) {
		struct work_struct *work = list_first_entry(&worker->scheduled,
L
Linus Torvalds 已提交
703
						struct work_struct, entry);
T
Tejun Heo 已提交
704
		process_one_work(worker, work);
L
Linus Torvalds 已提交
705 706 707
	}
}

T
Tejun Heo 已提交
708 709
/**
 * worker_thread - the worker thread function
T
Tejun Heo 已提交
710
 * @__worker: self
T
Tejun Heo 已提交
711 712 713
 *
 * The cwq worker thread function.
 */
T
Tejun Heo 已提交
714
static int worker_thread(void *__worker)
L
Linus Torvalds 已提交
715
{
T
Tejun Heo 已提交
716 717
	struct worker *worker = __worker;
	struct cpu_workqueue_struct *cwq = worker->cwq;
718
	DEFINE_WAIT(wait);
L
Linus Torvalds 已提交
719

720
	if (cwq->wq->flags & WQ_FREEZEABLE)
721
		set_freezable();
L
Linus Torvalds 已提交
722

723 724
	for (;;) {
		prepare_to_wait(&cwq->more_work, &wait, TASK_INTERRUPTIBLE);
725 726 727
		if (!freezing(current) &&
		    !kthread_should_stop() &&
		    list_empty(&cwq->worklist))
L
Linus Torvalds 已提交
728
			schedule();
729 730
		finish_wait(&cwq->more_work, &wait);

731 732
		try_to_freeze();

733
		if (kthread_should_stop())
734
			break;
L
Linus Torvalds 已提交
735

T
Tejun Heo 已提交
736
		if (unlikely(!cpumask_equal(&worker->task->cpus_allowed,
T
Tejun Heo 已提交
737
					    get_cpu_mask(cwq->cpu))))
T
Tejun Heo 已提交
738
			set_cpus_allowed_ptr(worker->task,
T
Tejun Heo 已提交
739
					     get_cpu_mask(cwq->cpu));
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761

		spin_lock_irq(&cwq->lock);

		while (!list_empty(&cwq->worklist)) {
			struct work_struct *work =
				list_first_entry(&cwq->worklist,
						 struct work_struct, entry);

			if (likely(!(*work_data_bits(work) &
				     WORK_STRUCT_LINKED))) {
				/* optimization path, not strictly necessary */
				process_one_work(worker, work);
				if (unlikely(!list_empty(&worker->scheduled)))
					process_scheduled_works(worker);
			} else {
				move_linked_works(work, &worker->scheduled,
						  NULL);
				process_scheduled_works(worker);
			}
		}

		spin_unlock_irq(&cwq->lock);
L
Linus Torvalds 已提交
762
	}
763

L
Linus Torvalds 已提交
764 765 766
	return 0;
}

O
Oleg Nesterov 已提交
767 768 769 770 771 772 773 774 775 776 777
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);
}

T
Tejun Heo 已提交
778 779 780 781
/**
 * insert_wq_barrier - insert a barrier work
 * @cwq: cwq to insert barrier into
 * @barr: wq_barrier to insert
782 783
 * @target: target work to attach @barr to
 * @worker: worker currently executing @target, NULL if @target is not executing
T
Tejun Heo 已提交
784
 *
785 786 787 788 789 790 791 792 793 794 795 796 797
 * @barr is linked to @target such that @barr is completed only after
 * @target finishes execution.  Please note that the ordering
 * guarantee is observed only with respect to @target and on the local
 * cpu.
 *
 * Currently, a queued barrier can't be canceled.  This is because
 * try_to_grab_pending() can't determine whether the work to be
 * grabbed is at the head of the queue and thus can't clear LINKED
 * flag of the previous work while there must be a valid next work
 * after a work with LINKED flag set.
 *
 * Note that when @worker is non-NULL, @target may be modified
 * underneath us, so we can't reliably determine cwq from @target.
T
Tejun Heo 已提交
798 799 800 801
 *
 * CONTEXT:
 * spin_lock_irq(cwq->lock).
 */
802
static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
803 804
			      struct wq_barrier *barr,
			      struct work_struct *target, struct worker *worker)
O
Oleg Nesterov 已提交
805
{
806 807 808
	struct list_head *head;
	unsigned int linked = 0;

809 810 811 812 813 814 815
	/*
	 * debugobject calls are safe here even with cwq->lock locked
	 * as we know for sure that this will not trigger any of the
	 * checks and call back into the fixup functions where we
	 * might deadlock.
	 */
	INIT_WORK_ON_STACK(&barr->work, wq_barrier_func);
816
	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
O
Oleg Nesterov 已提交
817
	init_completion(&barr->done);
818

819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
	/*
	 * If @target is currently being executed, schedule the
	 * barrier to the worker; otherwise, put it after @target.
	 */
	if (worker)
		head = worker->scheduled.next;
	else {
		unsigned long *bits = work_data_bits(target);

		head = target->entry.next;
		/* there can already be other linked works, inherit and set */
		linked = *bits & WORK_STRUCT_LINKED;
		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
	}

834
	debug_work_activate(&barr->work);
835 836
	insert_work(cwq, &barr->work, head,
		    work_color_to_flags(WORK_NO_COLOR) | linked);
O
Oleg Nesterov 已提交
837 838
}

839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
/**
 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
 * @wq: workqueue being flushed
 * @flush_color: new flush color, < 0 for no-op
 * @work_color: new work color, < 0 for no-op
 *
 * Prepare cwqs for workqueue flushing.
 *
 * If @flush_color is non-negative, flush_color on all cwqs should be
 * -1.  If no cwq has in-flight commands at the specified color, all
 * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
 * has in flight commands, its cwq->flush_color is set to
 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
 * wakeup logic is armed and %true is returned.
 *
 * The caller should have initialized @wq->first_flusher prior to
 * calling this function with non-negative @flush_color.  If
 * @flush_color is negative, no flush color update is done and %false
 * is returned.
 *
 * If @work_color is non-negative, all cwqs should have the same
 * work_color which is previous to @work_color and all will be
 * advanced to @work_color.
 *
 * CONTEXT:
 * mutex_lock(wq->flush_mutex).
 *
 * RETURNS:
 * %true if @flush_color >= 0 and there's something to flush.  %false
 * otherwise.
 */
static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
				      int flush_color, int work_color)
L
Linus Torvalds 已提交
872
{
873 874
	bool wait = false;
	unsigned int cpu;
L
Linus Torvalds 已提交
875

876 877 878
	if (flush_color >= 0) {
		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
		atomic_set(&wq->nr_cwqs_to_flush, 1);
L
Linus Torvalds 已提交
879
	}
880

881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
	for_each_possible_cpu(cpu) {
		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);

		spin_lock_irq(&cwq->lock);

		if (flush_color >= 0) {
			BUG_ON(cwq->flush_color != -1);

			if (cwq->nr_in_flight[flush_color]) {
				cwq->flush_color = flush_color;
				atomic_inc(&wq->nr_cwqs_to_flush);
				wait = true;
			}
		}

		if (work_color >= 0) {
			BUG_ON(work_color != work_next_color(cwq->work_color));
			cwq->work_color = work_color;
		}

		spin_unlock_irq(&cwq->lock);
902
	}
903

904 905 906 907
	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
		complete(&wq->first_flusher->done);

	return wait;
L
Linus Torvalds 已提交
908 909
}

910
/**
L
Linus Torvalds 已提交
911
 * flush_workqueue - ensure that any scheduled work has run to completion.
912
 * @wq: workqueue to flush
L
Linus Torvalds 已提交
913 914 915 916
 *
 * Forces execution of the workqueue and blocks until its completion.
 * This is typically used in driver shutdown handlers.
 *
O
Oleg Nesterov 已提交
917 918
 * 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 已提交
919
 */
920
void flush_workqueue(struct workqueue_struct *wq)
L
Linus Torvalds 已提交
921
{
922 923 924 925 926 927
	struct wq_flusher this_flusher = {
		.list = LIST_HEAD_INIT(this_flusher.list),
		.flush_color = -1,
		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
	};
	int next_color;
L
Linus Torvalds 已提交
928

929 930
	lock_map_acquire(&wq->lockdep_map);
	lock_map_release(&wq->lockdep_map);
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058

	mutex_lock(&wq->flush_mutex);

	/*
	 * Start-to-wait phase
	 */
	next_color = work_next_color(wq->work_color);

	if (next_color != wq->flush_color) {
		/*
		 * Color space is not full.  The current work_color
		 * becomes our flush_color and work_color is advanced
		 * by one.
		 */
		BUG_ON(!list_empty(&wq->flusher_overflow));
		this_flusher.flush_color = wq->work_color;
		wq->work_color = next_color;

		if (!wq->first_flusher) {
			/* no flush in progress, become the first flusher */
			BUG_ON(wq->flush_color != this_flusher.flush_color);

			wq->first_flusher = &this_flusher;

			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
						       wq->work_color)) {
				/* nothing to flush, done */
				wq->flush_color = next_color;
				wq->first_flusher = NULL;
				goto out_unlock;
			}
		} else {
			/* wait in queue */
			BUG_ON(wq->flush_color == this_flusher.flush_color);
			list_add_tail(&this_flusher.list, &wq->flusher_queue);
			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
		}
	} else {
		/*
		 * Oops, color space is full, wait on overflow queue.
		 * The next flush completion will assign us
		 * flush_color and transfer to flusher_queue.
		 */
		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
	}

	mutex_unlock(&wq->flush_mutex);

	wait_for_completion(&this_flusher.done);

	/*
	 * Wake-up-and-cascade phase
	 *
	 * First flushers are responsible for cascading flushes and
	 * handling overflow.  Non-first flushers can simply return.
	 */
	if (wq->first_flusher != &this_flusher)
		return;

	mutex_lock(&wq->flush_mutex);

	wq->first_flusher = NULL;

	BUG_ON(!list_empty(&this_flusher.list));
	BUG_ON(wq->flush_color != this_flusher.flush_color);

	while (true) {
		struct wq_flusher *next, *tmp;

		/* complete all the flushers sharing the current flush color */
		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
			if (next->flush_color != wq->flush_color)
				break;
			list_del_init(&next->list);
			complete(&next->done);
		}

		BUG_ON(!list_empty(&wq->flusher_overflow) &&
		       wq->flush_color != work_next_color(wq->work_color));

		/* this flush_color is finished, advance by one */
		wq->flush_color = work_next_color(wq->flush_color);

		/* one color has been freed, handle overflow queue */
		if (!list_empty(&wq->flusher_overflow)) {
			/*
			 * Assign the same color to all overflowed
			 * flushers, advance work_color and append to
			 * flusher_queue.  This is the start-to-wait
			 * phase for these overflowed flushers.
			 */
			list_for_each_entry(tmp, &wq->flusher_overflow, list)
				tmp->flush_color = wq->work_color;

			wq->work_color = work_next_color(wq->work_color);

			list_splice_tail_init(&wq->flusher_overflow,
					      &wq->flusher_queue);
			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
		}

		if (list_empty(&wq->flusher_queue)) {
			BUG_ON(wq->flush_color != wq->work_color);
			break;
		}

		/*
		 * Need to flush more colors.  Make the next flusher
		 * the new first flusher and arm cwqs.
		 */
		BUG_ON(wq->flush_color == wq->work_color);
		BUG_ON(wq->flush_color != next->flush_color);

		list_del_init(&next->list);
		wq->first_flusher = next;

		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
			break;

		/*
		 * Meh... this color is already done, clear first
		 * flusher and repeat cascading.
		 */
		wq->first_flusher = NULL;
	}

out_unlock:
	mutex_unlock(&wq->flush_mutex);
L
Linus Torvalds 已提交
1059
}
1060
EXPORT_SYMBOL_GPL(flush_workqueue);
L
Linus Torvalds 已提交
1061

1062 1063 1064 1065
/**
 * flush_work - block until a work_struct's callback has terminated
 * @work: the work which is to be flushed
 *
1066 1067
 * Returns false if @work has already terminated.
 *
1068 1069 1070 1071 1072 1073
 * 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)
{
1074
	struct worker *worker = NULL;
1075 1076 1077 1078 1079 1080 1081 1082
	struct cpu_workqueue_struct *cwq;
	struct wq_barrier barr;

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

1083 1084
	lock_map_acquire(&cwq->wq->lockdep_map);
	lock_map_release(&cwq->wq->lockdep_map);
1085

1086 1087 1088 1089 1090 1091 1092 1093
	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)))
T
Tejun Heo 已提交
1094
			goto already_gone;
1095
	} else {
1096 1097 1098
		if (cwq->worker && cwq->worker->current_work == work)
			worker = cwq->worker;
		if (!worker)
T
Tejun Heo 已提交
1099
			goto already_gone;
1100 1101
	}

1102
	insert_wq_barrier(cwq, &barr, work, worker);
T
Tejun Heo 已提交
1103
	spin_unlock_irq(&cwq->lock);
1104
	wait_for_completion(&barr.done);
1105
	destroy_work_on_stack(&barr.work);
1106
	return 1;
T
Tejun Heo 已提交
1107 1108 1109
already_gone:
	spin_unlock_irq(&cwq->lock);
	return 0;
1110 1111 1112
}
EXPORT_SYMBOL_GPL(flush_work);

1113
/*
1114
 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
1115 1116 1117 1118 1119
 * 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;
1120
	int ret = -1;
1121

1122
	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1123
		return 0;
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142

	/*
	 * 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)) {
1143
			debug_work_deactivate(work);
1144
			list_del_init(&work->entry);
1145
			cwq_dec_nr_in_flight(cwq, get_work_color(work));
1146 1147 1148 1149 1150 1151 1152 1153 1154
			ret = 1;
		}
	}
	spin_unlock_irq(&cwq->lock);

	return ret;
}

static void wait_on_cpu_work(struct cpu_workqueue_struct *cwq,
O
Oleg Nesterov 已提交
1155 1156 1157
				struct work_struct *work)
{
	struct wq_barrier barr;
1158
	struct worker *worker;
O
Oleg Nesterov 已提交
1159 1160

	spin_lock_irq(&cwq->lock);
1161 1162

	worker = NULL;
T
Tejun Heo 已提交
1163
	if (unlikely(cwq->worker && cwq->worker->current_work == work)) {
1164 1165
		worker = cwq->worker;
		insert_wq_barrier(cwq, &barr, work, worker);
O
Oleg Nesterov 已提交
1166
	}
1167

O
Oleg Nesterov 已提交
1168 1169
	spin_unlock_irq(&cwq->lock);

1170
	if (unlikely(worker)) {
O
Oleg Nesterov 已提交
1171
		wait_for_completion(&barr.done);
1172 1173
		destroy_work_on_stack(&barr.work);
	}
O
Oleg Nesterov 已提交
1174 1175
}

1176
static void wait_on_work(struct work_struct *work)
O
Oleg Nesterov 已提交
1177 1178
{
	struct cpu_workqueue_struct *cwq;
1179
	struct workqueue_struct *wq;
1180
	int cpu;
O
Oleg Nesterov 已提交
1181

1182 1183
	might_sleep();

1184 1185
	lock_map_acquire(&work->lockdep_map);
	lock_map_release(&work->lockdep_map);
1186

O
Oleg Nesterov 已提交
1187 1188
	cwq = get_wq_data(work);
	if (!cwq)
1189
		return;
O
Oleg Nesterov 已提交
1190

1191 1192
	wq = cwq->wq;

T
Tejun Heo 已提交
1193
	for_each_possible_cpu(cpu)
T
Tejun Heo 已提交
1194
		wait_on_cpu_work(get_cwq(cpu, wq), work);
1195 1196
}

1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
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));

1209
	clear_wq_data(work);
1210 1211 1212
	return ret;
}

1213 1214 1215 1216
/**
 * cancel_work_sync - block until a work_struct's callback has terminated
 * @work: the work which is to be flushed
 *
1217 1218
 * Returns true if @work was pending.
 *
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
 * 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.
 */
1234
int cancel_work_sync(struct work_struct *work)
1235
{
1236
	return __cancel_work_timer(work, NULL);
O
Oleg Nesterov 已提交
1237
}
1238
EXPORT_SYMBOL_GPL(cancel_work_sync);
O
Oleg Nesterov 已提交
1239

1240
/**
1241
 * cancel_delayed_work_sync - reliably kill off a delayed work.
1242 1243
 * @dwork: the delayed work struct
 *
1244 1245
 * Returns true if @dwork was pending.
 *
1246 1247 1248
 * 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().
 */
1249
int cancel_delayed_work_sync(struct delayed_work *dwork)
1250
{
1251
	return __cancel_work_timer(&dwork->work, &dwork->timer);
1252
}
1253
EXPORT_SYMBOL(cancel_delayed_work_sync);
L
Linus Torvalds 已提交
1254

1255
static struct workqueue_struct *keventd_wq __read_mostly;
L
Linus Torvalds 已提交
1256

1257 1258 1259 1260
/**
 * schedule_work - put work task in global workqueue
 * @work: job to be done
 *
1261 1262 1263 1264 1265 1266
 * Returns zero if @work was already on the kernel-global workqueue and
 * non-zero otherwise.
 *
 * This puts a job in the kernel-global workqueue if it was not already
 * queued and leaves it in the same position on the kernel-global
 * workqueue otherwise.
1267
 */
1268
int schedule_work(struct work_struct *work)
L
Linus Torvalds 已提交
1269 1270 1271
{
	return queue_work(keventd_wq, work);
}
1272
EXPORT_SYMBOL(schedule_work);
L
Linus Torvalds 已提交
1273

1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
/*
 * 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);

1287 1288
/**
 * schedule_delayed_work - put work task in global workqueue after delay
1289 1290
 * @dwork: job to be done
 * @delay: number of jiffies to wait or 0 for immediate execution
1291 1292 1293 1294
 *
 * After waiting for a given time this puts a job in the kernel-global
 * workqueue.
 */
1295
int schedule_delayed_work(struct delayed_work *dwork,
1296
					unsigned long delay)
L
Linus Torvalds 已提交
1297
{
1298
	return queue_delayed_work(keventd_wq, dwork, delay);
L
Linus Torvalds 已提交
1299
}
1300
EXPORT_SYMBOL(schedule_delayed_work);
L
Linus Torvalds 已提交
1301

1302 1303 1304 1305 1306 1307 1308 1309 1310
/**
 * flush_delayed_work - block until a dwork_struct's callback has terminated
 * @dwork: the delayed work which is to be flushed
 *
 * Any timeout is cancelled, and any pending work is run immediately.
 */
void flush_delayed_work(struct delayed_work *dwork)
{
	if (del_timer_sync(&dwork->timer)) {
T
Tejun Heo 已提交
1311 1312
		__queue_work(get_cpu(), get_wq_data(&dwork->work)->wq,
			     &dwork->work);
1313 1314 1315 1316 1317 1318
		put_cpu();
	}
	flush_work(&dwork->work);
}
EXPORT_SYMBOL(flush_delayed_work);

1319 1320 1321
/**
 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
 * @cpu: cpu to use
1322
 * @dwork: job to be done
1323 1324 1325 1326 1327
 * @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 已提交
1328
int schedule_delayed_work_on(int cpu,
1329
			struct delayed_work *dwork, unsigned long delay)
L
Linus Torvalds 已提交
1330
{
1331
	return queue_delayed_work_on(cpu, keventd_wq, dwork, delay);
L
Linus Torvalds 已提交
1332
}
1333
EXPORT_SYMBOL(schedule_delayed_work_on);
L
Linus Torvalds 已提交
1334

1335 1336 1337 1338 1339 1340 1341 1342 1343
/**
 * 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.
 */
1344
int schedule_on_each_cpu(work_func_t func)
1345 1346
{
	int cpu;
1347
	int orig = -1;
1348
	struct work_struct *works;
1349

1350 1351
	works = alloc_percpu(struct work_struct);
	if (!works)
1352
		return -ENOMEM;
1353

1354 1355
	get_online_cpus();

1356
	/*
1357 1358 1359
	 * When running in keventd don't schedule a work item on
	 * itself.  Can just call directly because the work queue is
	 * already bound.  This also is faster.
1360
	 */
1361
	if (current_is_keventd())
1362 1363
		orig = raw_smp_processor_id();

1364
	for_each_online_cpu(cpu) {
1365 1366 1367
		struct work_struct *work = per_cpu_ptr(works, cpu);

		INIT_WORK(work, func);
1368
		if (cpu != orig)
1369
			schedule_work_on(cpu, work);
1370
	}
1371 1372 1373 1374 1375 1376
	if (orig >= 0)
		func(per_cpu_ptr(works, orig));

	for_each_online_cpu(cpu)
		flush_work(per_cpu_ptr(works, cpu));

1377
	put_online_cpus();
1378
	free_percpu(works);
1379 1380 1381
	return 0;
}

1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
/**
 * flush_scheduled_work - ensure that any scheduled work has run to completion.
 *
 * Forces execution of the kernel-global workqueue and blocks until its
 * completion.
 *
 * Think twice before calling this function!  It's very easy to get into
 * trouble if you don't take great care.  Either of the following situations
 * will lead to deadlock:
 *
 *	One of the work items currently on the workqueue needs to acquire
 *	a lock held by your code or its caller.
 *
 *	Your code is running in the context of a work routine.
 *
 * They will be detected by lockdep when they occur, but the first might not
 * occur very often.  It depends on what work items are on the workqueue and
 * what locks they need, which you have no control over.
 *
 * In most situations flushing the entire workqueue is overkill; you merely
 * need to know that a particular work item isn't queued and isn't running.
 * In such cases you should use cancel_delayed_work_sync() or
 * cancel_work_sync() instead.
 */
L
Linus Torvalds 已提交
1406 1407 1408 1409
void flush_scheduled_work(void)
{
	flush_workqueue(keventd_wq);
}
1410
EXPORT_SYMBOL(flush_scheduled_work);
L
Linus Torvalds 已提交
1411

1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
/**
 * 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
 */
1424
int execute_in_process_context(work_func_t fn, struct execute_work *ew)
1425 1426
{
	if (!in_interrupt()) {
1427
		fn(&ew->work);
1428 1429 1430
		return 0;
	}

1431
	INIT_WORK(&ew->work, fn);
1432 1433 1434 1435 1436 1437
	schedule_work(&ew->work);

	return 1;
}
EXPORT_SYMBOL_GPL(execute_in_process_context);

L
Linus Torvalds 已提交
1438 1439 1440 1441 1442 1443 1444 1445
int keventd_up(void)
{
	return keventd_wq != NULL;
}

int current_is_keventd(void)
{
	struct cpu_workqueue_struct *cwq;
H
Hugh Dickins 已提交
1446
	int cpu = raw_smp_processor_id(); /* preempt-safe: keventd is per-cpu */
L
Linus Torvalds 已提交
1447 1448 1449 1450
	int ret = 0;

	BUG_ON(!keventd_wq);

T
Tejun Heo 已提交
1451
	cwq = get_cwq(cpu, keventd_wq);
T
Tejun Heo 已提交
1452
	if (current == cwq->worker->task)
L
Linus Torvalds 已提交
1453 1454 1455 1456 1457 1458
		ret = 1;

	return ret;

}

T
Tejun Heo 已提交
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
static struct cpu_workqueue_struct *alloc_cwqs(void)
{
	/*
	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
	 * Make sure that the alignment isn't lower than that of
	 * unsigned long long.
	 */
	const size_t size = sizeof(struct cpu_workqueue_struct);
	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
				   __alignof__(unsigned long long));
	struct cpu_workqueue_struct *cwqs;
#ifndef CONFIG_SMP
	void *ptr;

	/*
	 * On UP, percpu allocator doesn't honor alignment parameter
	 * and simply uses arch-dependent default.  Allocate enough
	 * room to align cwq and put an extra pointer at the end
	 * pointing back to the originally allocated pointer which
	 * will be used for free.
	 *
	 * FIXME: This really belongs to UP percpu code.  Update UP
	 * percpu code to honor alignment and remove this ugliness.
	 */
	ptr = __alloc_percpu(size + align + sizeof(void *), 1);
	cwqs = PTR_ALIGN(ptr, align);
	*(void **)per_cpu_ptr(cwqs + 1, 0) = ptr;
#else
	/* On SMP, percpu allocator can do it itself */
	cwqs = __alloc_percpu(size, align);
#endif
	/* just in case, make sure it's actually aligned */
	BUG_ON(!IS_ALIGNED((unsigned long)cwqs, align));
	return cwqs;
}

static void free_cwqs(struct cpu_workqueue_struct *cwqs)
{
#ifndef CONFIG_SMP
	/* on UP, the pointer to free is stored right after the cwq */
	if (cwqs)
		free_percpu(*(void **)per_cpu_ptr(cwqs + 1, 0));
#else
	free_percpu(cwqs);
#endif
}

1506
struct workqueue_struct *__create_workqueue_key(const char *name,
1507
						unsigned int flags,
1508 1509
						struct lock_class_key *key,
						const char *lock_name)
L
Linus Torvalds 已提交
1510
{
T
Tejun Heo 已提交
1511
	bool singlethread = flags & WQ_SINGLE_THREAD;
L
Linus Torvalds 已提交
1512
	struct workqueue_struct *wq;
T
Tejun Heo 已提交
1513 1514
	bool failed = false;
	unsigned int cpu;
L
Linus Torvalds 已提交
1515

1516 1517
	wq = kzalloc(sizeof(*wq), GFP_KERNEL);
	if (!wq)
T
Tejun Heo 已提交
1518
		goto err;
1519

T
Tejun Heo 已提交
1520
	wq->cpu_wq = alloc_cwqs();
T
Tejun Heo 已提交
1521 1522
	if (!wq->cpu_wq)
		goto err;
1523

1524
	wq->flags = flags;
1525 1526 1527 1528
	mutex_init(&wq->flush_mutex);
	atomic_set(&wq->nr_cwqs_to_flush, 0);
	INIT_LIST_HEAD(&wq->flusher_queue);
	INIT_LIST_HEAD(&wq->flusher_overflow);
1529
	wq->name = name;
1530
	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
1531
	INIT_LIST_HEAD(&wq->list);
1532

T
Tejun Heo 已提交
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
	cpu_maps_update_begin();
	/*
	 * We must initialize cwqs for each possible cpu even if we
	 * are going to call destroy_workqueue() finally. Otherwise
	 * cpu_up() can hit the uninitialized cwq once we drop the
	 * lock.
	 */
	for_each_possible_cpu(cpu) {
		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);

T
Tejun Heo 已提交
1543
		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
T
Tejun Heo 已提交
1544
		cwq->cpu = cpu;
T
Tejun Heo 已提交
1545
		cwq->wq = wq;
1546
		cwq->flush_color = -1;
T
Tejun Heo 已提交
1547 1548 1549 1550
		spin_lock_init(&cwq->lock);
		INIT_LIST_HEAD(&cwq->worklist);
		init_waitqueue_head(&cwq->more_work);

T
Tejun Heo 已提交
1551
		if (failed)
T
Tejun Heo 已提交
1552
			continue;
T
Tejun Heo 已提交
1553 1554 1555 1556
		cwq->worker = create_worker(cwq,
					    cpu_online(cpu) && !singlethread);
		if (cwq->worker)
			start_worker(cwq->worker);
T
Tejun Heo 已提交
1557
		else
T
Tejun Heo 已提交
1558
			failed = true;
1559 1560
	}

T
Tejun Heo 已提交
1561 1562 1563 1564 1565 1566
	spin_lock(&workqueue_lock);
	list_add(&wq->list, &workqueues);
	spin_unlock(&workqueue_lock);

	cpu_maps_update_done();

T
Tejun Heo 已提交
1567
	if (failed) {
1568 1569 1570 1571
		destroy_workqueue(wq);
		wq = NULL;
	}
	return wq;
T
Tejun Heo 已提交
1572 1573
err:
	if (wq) {
T
Tejun Heo 已提交
1574
		free_cwqs(wq->cpu_wq);
T
Tejun Heo 已提交
1575 1576 1577
		kfree(wq);
	}
	return NULL;
1578
}
1579
EXPORT_SYMBOL_GPL(__create_workqueue_key);
L
Linus Torvalds 已提交
1580

1581 1582 1583 1584 1585 1586 1587 1588
/**
 * 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)
{
1589
	int cpu;
1590

1591
	cpu_maps_update_begin();
1592
	spin_lock(&workqueue_lock);
1593
	list_del(&wq->list);
1594
	spin_unlock(&workqueue_lock);
T
Tejun Heo 已提交
1595
	cpu_maps_update_done();
1596

1597 1598 1599 1600 1601 1602
	flush_workqueue(wq);

	for_each_possible_cpu(cpu) {
		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
		int i;

T
Tejun Heo 已提交
1603 1604 1605
		if (cwq->worker) {
			destroy_worker(cwq->worker);
			cwq->worker = NULL;
1606 1607 1608 1609 1610
		}

		for (i = 0; i < WORK_NR_COLORS; i++)
			BUG_ON(cwq->nr_in_flight[i]);
	}
1611

T
Tejun Heo 已提交
1612
	free_cwqs(wq->cpu_wq);
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
	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;

1625 1626
	action &= ~CPU_TASKS_FROZEN;

1627
	list_for_each_entry(wq, &workqueues, list) {
T
Tejun Heo 已提交
1628 1629
		if (wq->flags & WQ_SINGLE_THREAD)
			continue;
1630

T
Tejun Heo 已提交
1631
		cwq = get_cwq(cpu, wq);
1632

T
Tejun Heo 已提交
1633
		switch (action) {
1634
		case CPU_POST_DEAD:
1635
			flush_workqueue(wq);
1636 1637
			break;
		}
L
Linus Torvalds 已提交
1638 1639
	}

T
Tejun Heo 已提交
1640
	return notifier_from_errno(0);
L
Linus Torvalds 已提交
1641 1642
}

1643
#ifdef CONFIG_SMP
1644

1645
struct work_for_cpu {
1646
	struct completion completion;
1647 1648 1649 1650 1651
	long (*fn)(void *);
	void *arg;
	long ret;
};

1652
static int do_work_for_cpu(void *_wfc)
1653
{
1654
	struct work_for_cpu *wfc = _wfc;
1655
	wfc->ret = wfc->fn(wfc->arg);
1656 1657
	complete(&wfc->completion);
	return 0;
1658 1659 1660 1661 1662 1663 1664 1665
}

/**
 * work_on_cpu - run a function in user context on a particular cpu
 * @cpu: the cpu to run on
 * @fn: the function to run
 * @arg: the function arg
 *
1666 1667
 * This will return the value @fn returns.
 * It is up to the caller to ensure that the cpu doesn't go offline.
1668
 * The caller must not hold any locks which would prevent @fn from completing.
1669 1670 1671
 */
long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
{
1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
	struct task_struct *sub_thread;
	struct work_for_cpu wfc = {
		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
		.fn = fn,
		.arg = arg,
	};

	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
	if (IS_ERR(sub_thread))
		return PTR_ERR(sub_thread);
	kthread_bind(sub_thread, cpu);
	wake_up_process(sub_thread);
	wait_for_completion(&wfc.completion);
1685 1686 1687 1688 1689
	return wfc.ret;
}
EXPORT_SYMBOL_GPL(work_on_cpu);
#endif /* CONFIG_SMP */

1690
void __init init_workqueues(void)
L
Linus Torvalds 已提交
1691
{
T
Tejun Heo 已提交
1692 1693 1694 1695 1696
	unsigned int cpu;

	for_each_possible_cpu(cpu)
		ida_init(&per_cpu(worker_ida, cpu));

1697
	singlethread_cpu = cpumask_first(cpu_possible_mask);
L
Linus Torvalds 已提交
1698 1699 1700 1701
	hotcpu_notifier(workqueue_cpu_callback, 0);
	keventd_wq = create_workqueue("events");
	BUG_ON(!keventd_wq);
}