workqueue.c 62.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
enum {
39 40 41
	/* global_cwq flags */
	GCWQ_FREEZING		= 1 << 3,	/* freeze in progress */

T
Tejun Heo 已提交
42 43 44 45
	/* worker flags */
	WORKER_STARTED		= 1 << 0,	/* started */
	WORKER_DIE		= 1 << 1,	/* die die die */
	WORKER_IDLE		= 1 << 2,	/* is idle */
46 47 48 49 50 51 52 53
	WORKER_ROGUE		= 1 << 4,	/* not bound to any cpu */

	/* gcwq->trustee_state */
	TRUSTEE_START		= 0,		/* start */
	TRUSTEE_IN_CHARGE	= 1,		/* trustee in charge of gcwq */
	TRUSTEE_BUTCHER		= 2,		/* butcher workers */
	TRUSTEE_RELEASE		= 3,		/* release workers */
	TRUSTEE_DONE		= 4,		/* trustee is done */
T
Tejun Heo 已提交
54 55 56 57

	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
	BUSY_WORKER_HASH_SIZE	= 1 << BUSY_WORKER_HASH_ORDER,
	BUSY_WORKER_HASH_MASK	= BUSY_WORKER_HASH_SIZE - 1,
58 59

	TRUSTEE_COOLDOWN	= HZ / 10,	/* for trustee draining */
T
Tejun Heo 已提交
60 61
};

T
Tejun Heo 已提交
62 63 64 65 66
/*
 * Structure fields follow one of the following exclusion rules.
 *
 * I: Set during initialization and read-only afterwards.
 *
67
 * L: gcwq->lock protected.  Access with gcwq->lock held.
T
Tejun Heo 已提交
68
 *
69 70
 * F: wq->flush_mutex protected.
 *
T
Tejun Heo 已提交
71 72 73
 * W: workqueue_lock protected.
 */

74
struct global_cwq;
T
Tejun Heo 已提交
75 76 77
struct cpu_workqueue_struct;

struct worker {
T
Tejun Heo 已提交
78 79 80 81 82 83
	/* on idle list while idle, on busy hash table while busy */
	union {
		struct list_head	entry;	/* L: while idle */
		struct hlist_node	hentry;	/* L: while busy */
	};

T
Tejun Heo 已提交
84
	struct work_struct	*current_work;	/* L: work being processed */
85
	struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
86
	struct list_head	scheduled;	/* L: scheduled works */
T
Tejun Heo 已提交
87
	struct task_struct	*task;		/* I: worker task */
88
	struct global_cwq	*gcwq;		/* I: the associated gcwq */
T
Tejun Heo 已提交
89
	struct cpu_workqueue_struct *cwq;	/* I: the associated cwq */
T
Tejun Heo 已提交
90
	unsigned int		flags;		/* L: flags */
T
Tejun Heo 已提交
91 92 93
	int			id;		/* I: worker id */
};

94 95 96 97 98 99
/*
 * Global per-cpu workqueue.
 */
struct global_cwq {
	spinlock_t		lock;		/* the gcwq lock */
	unsigned int		cpu;		/* I: the associated cpu */
100
	unsigned int		flags;		/* L: GCWQ_* flags */
T
Tejun Heo 已提交
101 102 103 104 105 106 107 108 109

	int			nr_workers;	/* L: total number of workers */
	int			nr_idle;	/* L: currently idle ones */

	/* workers are chained either in the idle_list or busy_hash */
	struct list_head	idle_list;	/* L: list of idle workers */
	struct hlist_head	busy_hash[BUSY_WORKER_HASH_SIZE];
						/* L: hash of busy workers */

110
	struct ida		worker_ida;	/* L: for worker IDs */
111 112 113 114

	struct task_struct	*trustee;	/* L: for gcwq shutdown */
	unsigned int		trustee_state;	/* L: trustee state */
	wait_queue_head_t	trustee_wait;	/* trustee wait */
115 116
} ____cacheline_aligned_in_smp;

L
Linus Torvalds 已提交
117
/*
118
 * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
T
Tejun Heo 已提交
119 120
 * 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 已提交
121 122
 */
struct cpu_workqueue_struct {
123
	struct global_cwq	*gcwq;		/* I: the associated gcwq */
L
Linus Torvalds 已提交
124
	struct list_head worklist;
T
Tejun Heo 已提交
125
	struct worker		*worker;
T
Tejun Heo 已提交
126
	struct workqueue_struct *wq;		/* I: the owning workqueue */
127 128 129 130
	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 */
131
	int			nr_active;	/* L: nr of active works */
132
	int			max_active;	/* L: max active works */
133
	struct list_head	delayed_works;	/* L: delayed works */
T
Tejun Heo 已提交
134
};
L
Linus Torvalds 已提交
135

136 137 138 139 140 141 142 143 144
/*
 * 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 已提交
145 146 147 148 149
/*
 * The externally visible workqueue abstraction is an array of
 * per-CPU workqueues:
 */
struct workqueue_struct {
150
	unsigned int		flags;		/* I: WQ_* flags */
T
Tejun Heo 已提交
151 152
	struct cpu_workqueue_struct *cpu_wq;	/* I: cwq's */
	struct list_head	list;		/* W: list of all workqueues */
153 154 155 156 157 158 159 160 161

	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 */

162 163
	unsigned long		single_cpu;	/* cpu for single cpu wq */

164
	int			saved_max_active; /* I: saved cwq max_active */
T
Tejun Heo 已提交
165
	const char		*name;		/* I: workqueue name */
166
#ifdef CONFIG_LOCKDEP
T
Tejun Heo 已提交
167
	struct lockdep_map	lockdep_map;
168
#endif
L
Linus Torvalds 已提交
169 170
};

171 172 173 174
#define for_each_busy_worker(worker, i, pos, gcwq)			\
	for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)			\
		hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)

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
#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.
		 */
214
		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
			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

285 286
/* Serializes the accesses to the list of workqueues. */
static DEFINE_SPINLOCK(workqueue_lock);
L
Linus Torvalds 已提交
287
static LIST_HEAD(workqueues);
288
static bool workqueue_freezing;		/* W: have wqs started freezing? */
T
Tejun Heo 已提交
289

290 291
static DEFINE_PER_CPU(struct global_cwq, global_cwq);

T
Tejun Heo 已提交
292
static int worker_thread(void *__worker);
L
Linus Torvalds 已提交
293

294 295 296 297 298
static struct global_cwq *get_gcwq(unsigned int cpu)
{
	return &per_cpu(global_cwq, cpu);
}

T
Tejun Heo 已提交
299 300
static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
					    struct workqueue_struct *wq)
301
{
T
Tejun Heo 已提交
302
	return per_cpu_ptr(wq->cpu_wq, cpu);
303 304
}

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
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;
}

321 322 323 324
/*
 * Set the workqueue on which a work item is to be run
 * - Must *only* be called if the pending flag is set
 */
325
static inline void set_wq_data(struct work_struct *work,
T
Tejun Heo 已提交
326 327
			       struct cpu_workqueue_struct *cwq,
			       unsigned long extra_flags)
328
{
329
	BUG_ON(!work_pending(work));
330

T
Tejun Heo 已提交
331
	atomic_long_set(&work->data, (unsigned long)cwq | work_static(work) |
332
			WORK_STRUCT_PENDING | extra_flags);
333 334
}

335 336 337 338 339
/*
 * 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 已提交
340
	atomic_long_set(&work->data, work_static(work));
341 342
}

343
static inline struct cpu_workqueue_struct *get_wq_data(struct work_struct *work)
344
{
345 346
	return (void *)(atomic_long_read(&work->data) &
			WORK_STRUCT_WQ_DATA_MASK);
347 348
}

T
Tejun Heo 已提交
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
/**
 * busy_worker_head - return the busy hash head for a work
 * @gcwq: gcwq of interest
 * @work: work to be hashed
 *
 * Return hash head of @gcwq for @work.
 *
 * CONTEXT:
 * spin_lock_irq(gcwq->lock).
 *
 * RETURNS:
 * Pointer to the hash head.
 */
static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
					   struct work_struct *work)
{
	const int base_shift = ilog2(sizeof(struct work_struct));
	unsigned long v = (unsigned long)work;

	/* simple shift and fold hash, do we need something better? */
	v >>= base_shift;
	v += v >> BUSY_WORKER_HASH_ORDER;
	v &= BUSY_WORKER_HASH_MASK;

	return &gcwq->busy_hash[v];
}

376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
/**
 * __find_worker_executing_work - find worker which is executing a work
 * @gcwq: gcwq of interest
 * @bwh: hash head as returned by busy_worker_head()
 * @work: work to find worker for
 *
 * Find a worker which is executing @work on @gcwq.  @bwh should be
 * the hash head obtained by calling busy_worker_head() with the same
 * work.
 *
 * CONTEXT:
 * spin_lock_irq(gcwq->lock).
 *
 * RETURNS:
 * Pointer to worker which is executing @work if found, NULL
 * otherwise.
 */
static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
						   struct hlist_head *bwh,
						   struct work_struct *work)
{
	struct worker *worker;
	struct hlist_node *tmp;

	hlist_for_each_entry(worker, tmp, bwh, hentry)
		if (worker->current_work == work)
			return worker;
	return NULL;
}

/**
 * find_worker_executing_work - find worker which is executing a work
 * @gcwq: gcwq of interest
 * @work: work to find worker for
 *
 * Find a worker which is executing @work on @gcwq.  This function is
 * identical to __find_worker_executing_work() except that this
 * function calculates @bwh itself.
 *
 * CONTEXT:
 * spin_lock_irq(gcwq->lock).
 *
 * RETURNS:
 * Pointer to worker which is executing @work if found, NULL
 * otherwise.
 */
static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
						 struct work_struct *work)
{
	return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
					    work);
}

T
Tejun Heo 已提交
429 430 431 432 433 434 435 436 437 438
/**
 * 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:
439
 * spin_lock_irq(gcwq->lock).
T
Tejun Heo 已提交
440
 */
O
Oleg Nesterov 已提交
441
static void insert_work(struct cpu_workqueue_struct *cwq,
T
Tejun Heo 已提交
442 443
			struct work_struct *work, struct list_head *head,
			unsigned int extra_flags)
O
Oleg Nesterov 已提交
444
{
T
Tejun Heo 已提交
445 446 447
	/* we own @work, set data and link */
	set_wq_data(work, cwq, extra_flags);

448 449 450 451 452
	/*
	 * 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 已提交
453

454
	list_add_tail(&work->entry, head);
T
Tejun Heo 已提交
455
	wake_up_process(cwq->worker->task);
O
Oleg Nesterov 已提交
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
/**
 * cwq_unbind_single_cpu - unbind cwq from single cpu workqueue processing
 * @cwq: cwq to unbind
 *
 * Try to unbind @cwq from single cpu workqueue processing.  If
 * @cwq->wq is frozen, unbind is delayed till the workqueue is thawed.
 *
 * CONTEXT:
 * spin_lock_irq(gcwq->lock).
 */
static void cwq_unbind_single_cpu(struct cpu_workqueue_struct *cwq)
{
	struct workqueue_struct *wq = cwq->wq;
	struct global_cwq *gcwq = cwq->gcwq;

	BUG_ON(wq->single_cpu != gcwq->cpu);
	/*
	 * Unbind from workqueue if @cwq is not frozen.  If frozen,
	 * thaw_workqueues() will either restart processing on this
	 * cpu or unbind if empty.  This keeps works queued while
	 * frozen fully ordered and flushable.
	 */
	if (likely(!(gcwq->flags & GCWQ_FREEZING))) {
		smp_wmb();	/* paired with cmpxchg() in __queue_work() */
		wq->single_cpu = NR_CPUS;
	}
}

T
Tejun Heo 已提交
486
static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
L
Linus Torvalds 已提交
487 488
			 struct work_struct *work)
{
489 490
	struct global_cwq *gcwq;
	struct cpu_workqueue_struct *cwq;
491
	struct list_head *worklist;
L
Linus Torvalds 已提交
492
	unsigned long flags;
493
	bool arbitrate;
L
Linus Torvalds 已提交
494

495
	debug_work_activate(work);
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 536 537 538
	/* determine gcwq to use */
	if (!(wq->flags & WQ_SINGLE_CPU)) {
		/* just use the requested cpu for multicpu workqueues */
		gcwq = get_gcwq(cpu);
		spin_lock_irqsave(&gcwq->lock, flags);
	} else {
		unsigned int req_cpu = cpu;

		/*
		 * It's a bit more complex for single cpu workqueues.
		 * We first need to determine which cpu is going to be
		 * used.  If no cpu is currently serving this
		 * workqueue, arbitrate using atomic accesses to
		 * wq->single_cpu; otherwise, use the current one.
		 */
	retry:
		cpu = wq->single_cpu;
		arbitrate = cpu == NR_CPUS;
		if (arbitrate)
			cpu = req_cpu;

		gcwq = get_gcwq(cpu);
		spin_lock_irqsave(&gcwq->lock, flags);

		/*
		 * The following cmpxchg() is a full barrier paired
		 * with smp_wmb() in cwq_unbind_single_cpu() and
		 * guarantees that all changes to wq->st_* fields are
		 * visible on the new cpu after this point.
		 */
		if (arbitrate)
			cmpxchg(&wq->single_cpu, NR_CPUS, cpu);

		if (unlikely(wq->single_cpu != cpu)) {
			spin_unlock_irqrestore(&gcwq->lock, flags);
			goto retry;
		}
	}

	/* gcwq determined, get cwq and queue */
	cwq = get_cwq(gcwq->cpu, wq);

T
Tejun Heo 已提交
539
	BUG_ON(!list_empty(&work->entry));
540

541
	cwq->nr_in_flight[cwq->work_color]++;
542 543 544 545 546 547 548 549 550

	if (likely(cwq->nr_active < cwq->max_active)) {
		cwq->nr_active++;
		worklist = &cwq->worklist;
	} else
		worklist = &cwq->delayed_works;

	insert_work(cwq, work, worklist, work_color_to_flags(cwq->work_color));

551
	spin_unlock_irqrestore(&gcwq->lock, flags);
L
Linus Torvalds 已提交
552 553
}

554 555 556 557 558
/**
 * queue_work - queue work on a workqueue
 * @wq: workqueue to use
 * @work: work to queue
 *
A
Alan Stern 已提交
559
 * Returns 0 if @work was already on a queue, non-zero otherwise.
L
Linus Torvalds 已提交
560
 *
561 562
 * 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 已提交
563
 */
564
int queue_work(struct workqueue_struct *wq, struct work_struct *work)
L
Linus Torvalds 已提交
565
{
566 567 568 569 570
	int ret;

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

L
Linus Torvalds 已提交
571 572
	return ret;
}
573
EXPORT_SYMBOL_GPL(queue_work);
L
Linus Torvalds 已提交
574

575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
/**
 * 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;

591
	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
T
Tejun Heo 已提交
592
		__queue_work(cpu, wq, work);
593 594 595 596 597 598
		ret = 1;
	}
	return ret;
}
EXPORT_SYMBOL_GPL(queue_work_on);

599
static void delayed_work_timer_fn(unsigned long __data)
L
Linus Torvalds 已提交
600
{
601
	struct delayed_work *dwork = (struct delayed_work *)__data;
602
	struct cpu_workqueue_struct *cwq = get_wq_data(&dwork->work);
L
Linus Torvalds 已提交
603

T
Tejun Heo 已提交
604
	__queue_work(smp_processor_id(), cwq->wq, &dwork->work);
L
Linus Torvalds 已提交
605 606
}

607 608 609
/**
 * queue_delayed_work - queue work on a workqueue after delay
 * @wq: workqueue to use
610
 * @dwork: delayable work to queue
611 612
 * @delay: number of jiffies to wait before queueing
 *
A
Alan Stern 已提交
613
 * Returns 0 if @work was already on a queue, non-zero otherwise.
614
 */
615
int queue_delayed_work(struct workqueue_struct *wq,
616
			struct delayed_work *dwork, unsigned long delay)
L
Linus Torvalds 已提交
617
{
618
	if (delay == 0)
619
		return queue_work(wq, &dwork->work);
L
Linus Torvalds 已提交
620

621
	return queue_delayed_work_on(-1, wq, dwork, delay);
L
Linus Torvalds 已提交
622
}
623
EXPORT_SYMBOL_GPL(queue_delayed_work);
L
Linus Torvalds 已提交
624

625 626 627 628
/**
 * queue_delayed_work_on - queue work on specific CPU after delay
 * @cpu: CPU number to execute work on
 * @wq: workqueue to use
629
 * @dwork: work to queue
630 631
 * @delay: number of jiffies to wait before queueing
 *
A
Alan Stern 已提交
632
 * Returns 0 if @work was already on a queue, non-zero otherwise.
633
 */
634
int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
635
			struct delayed_work *dwork, unsigned long delay)
636 637
{
	int ret = 0;
638 639
	struct timer_list *timer = &dwork->timer;
	struct work_struct *work = &dwork->work;
640

641
	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
642 643 644
		BUG_ON(timer_pending(timer));
		BUG_ON(!list_empty(&work->entry));

645 646
		timer_stats_timer_set_start_info(&dwork->timer);

647
		/* This stores cwq for the moment, for the timer_fn */
648
		set_wq_data(work, get_cwq(raw_smp_processor_id(), wq), 0);
649
		timer->expires = jiffies + delay;
650
		timer->data = (unsigned long)dwork;
651
		timer->function = delayed_work_timer_fn;
652 653 654 655 656

		if (unlikely(cpu >= 0))
			add_timer_on(timer, cpu);
		else
			add_timer(timer);
657 658 659 660
		ret = 1;
	}
	return ret;
}
661
EXPORT_SYMBOL_GPL(queue_delayed_work_on);
L
Linus Torvalds 已提交
662

T
Tejun Heo 已提交
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
/**
 * worker_enter_idle - enter idle state
 * @worker: worker which is entering idle state
 *
 * @worker is entering idle state.  Update stats and idle timer if
 * necessary.
 *
 * LOCKING:
 * spin_lock_irq(gcwq->lock).
 */
static void worker_enter_idle(struct worker *worker)
{
	struct global_cwq *gcwq = worker->gcwq;

	BUG_ON(worker->flags & WORKER_IDLE);
	BUG_ON(!list_empty(&worker->entry) &&
	       (worker->hentry.next || worker->hentry.pprev));

	worker->flags |= WORKER_IDLE;
	gcwq->nr_idle++;

	/* idle_list is LIFO */
	list_add(&worker->entry, &gcwq->idle_list);
686 687 688

	if (unlikely(worker->flags & WORKER_ROGUE))
		wake_up_all(&gcwq->trustee_wait);
T
Tejun Heo 已提交
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
}

/**
 * worker_leave_idle - leave idle state
 * @worker: worker which is leaving idle state
 *
 * @worker is leaving idle state.  Update stats.
 *
 * LOCKING:
 * spin_lock_irq(gcwq->lock).
 */
static void worker_leave_idle(struct worker *worker)
{
	struct global_cwq *gcwq = worker->gcwq;

	BUG_ON(!(worker->flags & WORKER_IDLE));
	worker->flags &= ~WORKER_IDLE;
	gcwq->nr_idle--;
	list_del_init(&worker->entry);
}

T
Tejun Heo 已提交
710 711 712 713 714
static struct worker *alloc_worker(void)
{
	struct worker *worker;

	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
T
Tejun Heo 已提交
715 716
	if (worker) {
		INIT_LIST_HEAD(&worker->entry);
717
		INIT_LIST_HEAD(&worker->scheduled);
T
Tejun Heo 已提交
718
	}
T
Tejun Heo 已提交
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
	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)
{
739
	struct global_cwq *gcwq = cwq->gcwq;
T
Tejun Heo 已提交
740 741 742
	int id = -1;
	struct worker *worker = NULL;

743 744 745 746
	spin_lock_irq(&gcwq->lock);
	while (ida_get_new(&gcwq->worker_ida, &id)) {
		spin_unlock_irq(&gcwq->lock);
		if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
T
Tejun Heo 已提交
747
			goto fail;
748
		spin_lock_irq(&gcwq->lock);
T
Tejun Heo 已提交
749
	}
750
	spin_unlock_irq(&gcwq->lock);
T
Tejun Heo 已提交
751 752 753 754 755

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

756
	worker->gcwq = gcwq;
T
Tejun Heo 已提交
757 758 759 760
	worker->cwq = cwq;
	worker->id = id;

	worker->task = kthread_create(worker_thread, worker, "kworker/%u:%d",
761
				      gcwq->cpu, id);
T
Tejun Heo 已提交
762 763 764
	if (IS_ERR(worker->task))
		goto fail;

765 766 767 768 769
	/*
	 * A rogue worker will become a regular one if CPU comes
	 * online later on.  Make sure every worker has
	 * PF_THREAD_BOUND set.
	 */
T
Tejun Heo 已提交
770
	if (bind)
771
		kthread_bind(worker->task, gcwq->cpu);
772 773
	else
		worker->task->flags |= PF_THREAD_BOUND;
T
Tejun Heo 已提交
774 775 776 777

	return worker;
fail:
	if (id >= 0) {
778 779 780
		spin_lock_irq(&gcwq->lock);
		ida_remove(&gcwq->worker_ida, id);
		spin_unlock_irq(&gcwq->lock);
T
Tejun Heo 已提交
781 782 783 784 785 786 787 788 789
	}
	kfree(worker);
	return NULL;
}

/**
 * start_worker - start a newly created worker
 * @worker: worker to start
 *
T
Tejun Heo 已提交
790
 * Make the gcwq aware of @worker and start it.
T
Tejun Heo 已提交
791 792
 *
 * CONTEXT:
793
 * spin_lock_irq(gcwq->lock).
T
Tejun Heo 已提交
794 795 796
 */
static void start_worker(struct worker *worker)
{
T
Tejun Heo 已提交
797 798 799
	worker->flags |= WORKER_STARTED;
	worker->gcwq->nr_workers++;
	worker_enter_idle(worker);
T
Tejun Heo 已提交
800 801 802 803 804 805 806
	wake_up_process(worker->task);
}

/**
 * destroy_worker - destroy a workqueue worker
 * @worker: worker to be destroyed
 *
T
Tejun Heo 已提交
807 808 809 810
 * Destroy @worker and adjust @gcwq stats accordingly.
 *
 * CONTEXT:
 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
T
Tejun Heo 已提交
811 812 813
 */
static void destroy_worker(struct worker *worker)
{
814
	struct global_cwq *gcwq = worker->gcwq;
T
Tejun Heo 已提交
815 816 817 818
	int id = worker->id;

	/* sanity check frenzy */
	BUG_ON(worker->current_work);
819
	BUG_ON(!list_empty(&worker->scheduled));
T
Tejun Heo 已提交
820

T
Tejun Heo 已提交
821 822 823 824 825 826 827 828 829 830
	if (worker->flags & WORKER_STARTED)
		gcwq->nr_workers--;
	if (worker->flags & WORKER_IDLE)
		gcwq->nr_idle--;

	list_del_init(&worker->entry);
	worker->flags |= WORKER_DIE;

	spin_unlock_irq(&gcwq->lock);

T
Tejun Heo 已提交
831 832 833
	kthread_stop(worker->task);
	kfree(worker);

834 835
	spin_lock_irq(&gcwq->lock);
	ida_remove(&gcwq->worker_ida, id);
T
Tejun Heo 已提交
836 837
}

838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
/**
 * 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:
853
 * spin_lock_irq(gcwq->lock).
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
 */
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;
}

879 880 881 882 883 884 885 886 887
static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
{
	struct work_struct *work = list_first_entry(&cwq->delayed_works,
						    struct work_struct, entry);

	move_linked_works(work, &cwq->worklist, NULL);
	cwq->nr_active++;
}

888 889 890 891 892 893 894 895 896
/**
 * 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:
897
 * spin_lock_irq(gcwq->lock).
898 899 900 901 902 903 904 905
 */
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]--;
906 907
	cwq->nr_active--;

908 909 910 911 912 913 914 915
	if (!list_empty(&cwq->delayed_works)) {
		/* one down, submit a delayed one */
		if (cwq->nr_active < cwq->max_active)
			cwq_activate_first_delayed(cwq);
	} else if (!cwq->nr_active && cwq->wq->flags & WQ_SINGLE_CPU) {
		/* this was the last work, unbind from single cpu */
		cwq_unbind_single_cpu(cwq);
	}
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935

	/* 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);
}

936 937
/**
 * process_one_work - process single work
T
Tejun Heo 已提交
938
 * @worker: self
939 940 941 942 943 944 945 946 947
 * @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:
948
 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
949
 */
T
Tejun Heo 已提交
950
static void process_one_work(struct worker *worker, struct work_struct *work)
951
{
T
Tejun Heo 已提交
952
	struct cpu_workqueue_struct *cwq = worker->cwq;
953
	struct global_cwq *gcwq = cwq->gcwq;
T
Tejun Heo 已提交
954
	struct hlist_head *bwh = busy_worker_head(gcwq, work);
955
	work_func_t f = work->func;
956
	int work_color;
957 958 959 960 961 962 963 964 965 966 967 968
#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 已提交
969
	hlist_add_head(&worker->hentry, bwh);
T
Tejun Heo 已提交
970
	worker->current_work = work;
971
	worker->current_cwq = cwq;
972
	work_color = get_work_color(work);
973 974
	list_del_init(&work->entry);

975
	spin_unlock_irq(&gcwq->lock);
976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994

	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();
	}

995
	spin_lock_irq(&gcwq->lock);
996 997

	/* we're done with it, release */
T
Tejun Heo 已提交
998
	hlist_del_init(&worker->hentry);
T
Tejun Heo 已提交
999
	worker->current_work = NULL;
1000
	worker->current_cwq = NULL;
1001
	cwq_dec_nr_in_flight(cwq, work_color);
1002 1003
}

1004 1005 1006 1007 1008 1009 1010 1011 1012
/**
 * 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:
1013
 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1014 1015 1016
 * multiple times.
 */
static void process_scheduled_works(struct worker *worker)
L
Linus Torvalds 已提交
1017
{
1018 1019
	while (!list_empty(&worker->scheduled)) {
		struct work_struct *work = list_first_entry(&worker->scheduled,
L
Linus Torvalds 已提交
1020
						struct work_struct, entry);
T
Tejun Heo 已提交
1021
		process_one_work(worker, work);
L
Linus Torvalds 已提交
1022 1023 1024
	}
}

T
Tejun Heo 已提交
1025 1026
/**
 * worker_thread - the worker thread function
T
Tejun Heo 已提交
1027
 * @__worker: self
T
Tejun Heo 已提交
1028 1029 1030
 *
 * The cwq worker thread function.
 */
T
Tejun Heo 已提交
1031
static int worker_thread(void *__worker)
L
Linus Torvalds 已提交
1032
{
T
Tejun Heo 已提交
1033
	struct worker *worker = __worker;
1034
	struct global_cwq *gcwq = worker->gcwq;
T
Tejun Heo 已提交
1035
	struct cpu_workqueue_struct *cwq = worker->cwq;
L
Linus Torvalds 已提交
1036

T
Tejun Heo 已提交
1037 1038
woke_up:
	spin_lock_irq(&gcwq->lock);
L
Linus Torvalds 已提交
1039

T
Tejun Heo 已提交
1040 1041 1042 1043 1044
	/* DIE can be set only while we're idle, checking here is enough */
	if (worker->flags & WORKER_DIE) {
		spin_unlock_irq(&gcwq->lock);
		return 0;
	}
1045

T
Tejun Heo 已提交
1046
	worker_leave_idle(worker);
1047
recheck:
T
Tejun Heo 已提交
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
	/*
	 * ->scheduled list can only be filled while a worker is
	 * preparing to process a work or actually processing it.
	 * Make sure nobody diddled with it while I was sleeping.
	 */
	BUG_ON(!list_empty(&worker->scheduled));

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

1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
		/*
		 * The following is a rather inefficient way to close
		 * race window against cpu hotplug operations.  Will
		 * be replaced soon.
		 */
		if (unlikely(!(worker->flags & WORKER_ROGUE) &&
			     !cpumask_equal(&worker->task->cpus_allowed,
					    get_cpu_mask(gcwq->cpu)))) {
			spin_unlock_irq(&gcwq->lock);
			set_cpus_allowed_ptr(worker->task,
					     get_cpu_mask(gcwq->cpu));
			cpu_relax();
			spin_lock_irq(&gcwq->lock);
			goto recheck;
		}

T
Tejun Heo 已提交
1076 1077 1078 1079
		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)))
1080
				process_scheduled_works(worker);
T
Tejun Heo 已提交
1081 1082 1083
		} else {
			move_linked_works(work, &worker->scheduled, NULL);
			process_scheduled_works(worker);
1084
		}
L
Linus Torvalds 已提交
1085
	}
1086

T
Tejun Heo 已提交
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
	/*
	 * gcwq->lock is held and there's no work to process, sleep.
	 * Workers are woken up only while holding gcwq->lock, so
	 * setting the current state before releasing gcwq->lock is
	 * enough to prevent losing any event.
	 */
	worker_enter_idle(worker);
	__set_current_state(TASK_INTERRUPTIBLE);
	spin_unlock_irq(&gcwq->lock);
	schedule();
	goto woke_up;
L
Linus Torvalds 已提交
1098 1099
}

O
Oleg Nesterov 已提交
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
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 已提交
1111 1112 1113 1114
/**
 * insert_wq_barrier - insert a barrier work
 * @cwq: cwq to insert barrier into
 * @barr: wq_barrier to insert
1115 1116
 * @target: target work to attach @barr to
 * @worker: worker currently executing @target, NULL if @target is not executing
T
Tejun Heo 已提交
1117
 *
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
 * @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 已提交
1131 1132
 *
 * CONTEXT:
1133
 * spin_lock_irq(gcwq->lock).
T
Tejun Heo 已提交
1134
 */
1135
static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
1136 1137
			      struct wq_barrier *barr,
			      struct work_struct *target, struct worker *worker)
O
Oleg Nesterov 已提交
1138
{
1139 1140 1141
	struct list_head *head;
	unsigned int linked = 0;

1142
	/*
1143
	 * debugobject calls are safe here even with gcwq->lock locked
1144 1145 1146 1147 1148
	 * 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);
1149
	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
O
Oleg Nesterov 已提交
1150
	init_completion(&barr->done);
1151

1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
	/*
	 * 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);
	}

1167
	debug_work_activate(&barr->work);
1168 1169
	insert_work(cwq, &barr->work, head,
		    work_color_to_flags(WORK_NO_COLOR) | linked);
O
Oleg Nesterov 已提交
1170 1171
}

1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
/**
 * 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 已提交
1205
{
1206 1207
	bool wait = false;
	unsigned int cpu;
L
Linus Torvalds 已提交
1208

1209 1210 1211
	if (flush_color >= 0) {
		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
		atomic_set(&wq->nr_cwqs_to_flush, 1);
L
Linus Torvalds 已提交
1212
	}
1213

1214 1215
	for_each_possible_cpu(cpu) {
		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
1216
		struct global_cwq *gcwq = cwq->gcwq;
1217

1218
		spin_lock_irq(&gcwq->lock);
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234

		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;
		}

1235
		spin_unlock_irq(&gcwq->lock);
1236
	}
1237

1238 1239 1240 1241
	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
		complete(&wq->first_flusher->done);

	return wait;
L
Linus Torvalds 已提交
1242 1243
}

1244
/**
L
Linus Torvalds 已提交
1245
 * flush_workqueue - ensure that any scheduled work has run to completion.
1246
 * @wq: workqueue to flush
L
Linus Torvalds 已提交
1247 1248 1249 1250
 *
 * Forces execution of the workqueue and blocks until its completion.
 * This is typically used in driver shutdown handlers.
 *
O
Oleg Nesterov 已提交
1251 1252
 * 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 已提交
1253
 */
1254
void flush_workqueue(struct workqueue_struct *wq)
L
Linus Torvalds 已提交
1255
{
1256 1257 1258 1259 1260 1261
	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 已提交
1262

1263 1264
	lock_map_acquire(&wq->lockdep_map);
	lock_map_release(&wq->lockdep_map);
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392

	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 已提交
1393
}
1394
EXPORT_SYMBOL_GPL(flush_workqueue);
L
Linus Torvalds 已提交
1395

1396 1397 1398 1399
/**
 * flush_work - block until a work_struct's callback has terminated
 * @work: the work which is to be flushed
 *
1400 1401
 * Returns false if @work has already terminated.
 *
1402 1403 1404 1405 1406 1407
 * 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)
{
1408
	struct worker *worker = NULL;
1409
	struct cpu_workqueue_struct *cwq;
1410
	struct global_cwq *gcwq;
1411 1412 1413 1414 1415 1416
	struct wq_barrier barr;

	might_sleep();
	cwq = get_wq_data(work);
	if (!cwq)
		return 0;
1417
	gcwq = cwq->gcwq;
1418

1419 1420
	lock_map_acquire(&cwq->wq->lockdep_map);
	lock_map_release(&cwq->wq->lockdep_map);
1421

1422
	spin_lock_irq(&gcwq->lock);
1423 1424 1425 1426 1427 1428 1429
	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 已提交
1430
			goto already_gone;
1431
	} else {
1432 1433 1434
		if (cwq->worker && cwq->worker->current_work == work)
			worker = cwq->worker;
		if (!worker)
T
Tejun Heo 已提交
1435
			goto already_gone;
1436 1437
	}

1438
	insert_wq_barrier(cwq, &barr, work, worker);
1439
	spin_unlock_irq(&gcwq->lock);
1440
	wait_for_completion(&barr.done);
1441
	destroy_work_on_stack(&barr.work);
1442
	return 1;
T
Tejun Heo 已提交
1443
already_gone:
1444
	spin_unlock_irq(&gcwq->lock);
T
Tejun Heo 已提交
1445
	return 0;
1446 1447 1448
}
EXPORT_SYMBOL_GPL(flush_work);

1449
/*
1450
 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
1451 1452 1453 1454
 * so this work can't be re-armed in any way.
 */
static int try_to_grab_pending(struct work_struct *work)
{
1455
	struct global_cwq *gcwq;
1456
	struct cpu_workqueue_struct *cwq;
1457
	int ret = -1;
1458

1459
	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1460
		return 0;
1461 1462 1463 1464 1465 1466 1467 1468 1469

	/*
	 * 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;
1470
	gcwq = cwq->gcwq;
1471

1472
	spin_lock_irq(&gcwq->lock);
1473 1474 1475 1476 1477 1478 1479 1480
	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)) {
1481
			debug_work_deactivate(work);
1482
			list_del_init(&work->entry);
1483
			cwq_dec_nr_in_flight(cwq, get_work_color(work));
1484 1485 1486
			ret = 1;
		}
	}
1487
	spin_unlock_irq(&gcwq->lock);
1488 1489 1490 1491 1492

	return ret;
}

static void wait_on_cpu_work(struct cpu_workqueue_struct *cwq,
O
Oleg Nesterov 已提交
1493 1494
				struct work_struct *work)
{
1495
	struct global_cwq *gcwq = cwq->gcwq;
O
Oleg Nesterov 已提交
1496
	struct wq_barrier barr;
1497
	struct worker *worker;
O
Oleg Nesterov 已提交
1498

1499
	spin_lock_irq(&gcwq->lock);
1500 1501

	worker = NULL;
T
Tejun Heo 已提交
1502
	if (unlikely(cwq->worker && cwq->worker->current_work == work)) {
1503 1504
		worker = cwq->worker;
		insert_wq_barrier(cwq, &barr, work, worker);
O
Oleg Nesterov 已提交
1505
	}
1506

1507
	spin_unlock_irq(&gcwq->lock);
O
Oleg Nesterov 已提交
1508

1509
	if (unlikely(worker)) {
O
Oleg Nesterov 已提交
1510
		wait_for_completion(&barr.done);
1511 1512
		destroy_work_on_stack(&barr.work);
	}
O
Oleg Nesterov 已提交
1513 1514
}

1515
static void wait_on_work(struct work_struct *work)
O
Oleg Nesterov 已提交
1516 1517
{
	struct cpu_workqueue_struct *cwq;
1518
	struct workqueue_struct *wq;
1519
	int cpu;
O
Oleg Nesterov 已提交
1520

1521 1522
	might_sleep();

1523 1524
	lock_map_acquire(&work->lockdep_map);
	lock_map_release(&work->lockdep_map);
1525

O
Oleg Nesterov 已提交
1526 1527
	cwq = get_wq_data(work);
	if (!cwq)
1528
		return;
O
Oleg Nesterov 已提交
1529

1530 1531
	wq = cwq->wq;

T
Tejun Heo 已提交
1532
	for_each_possible_cpu(cpu)
T
Tejun Heo 已提交
1533
		wait_on_cpu_work(get_cwq(cpu, wq), work);
1534 1535
}

1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
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));

1548
	clear_wq_data(work);
1549 1550 1551
	return ret;
}

1552 1553 1554 1555
/**
 * cancel_work_sync - block until a work_struct's callback has terminated
 * @work: the work which is to be flushed
 *
1556 1557
 * Returns true if @work was pending.
 *
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
 * 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.
 */
1573
int cancel_work_sync(struct work_struct *work)
1574
{
1575
	return __cancel_work_timer(work, NULL);
O
Oleg Nesterov 已提交
1576
}
1577
EXPORT_SYMBOL_GPL(cancel_work_sync);
O
Oleg Nesterov 已提交
1578

1579
/**
1580
 * cancel_delayed_work_sync - reliably kill off a delayed work.
1581 1582
 * @dwork: the delayed work struct
 *
1583 1584
 * Returns true if @dwork was pending.
 *
1585 1586 1587
 * 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().
 */
1588
int cancel_delayed_work_sync(struct delayed_work *dwork)
1589
{
1590
	return __cancel_work_timer(&dwork->work, &dwork->timer);
1591
}
1592
EXPORT_SYMBOL(cancel_delayed_work_sync);
L
Linus Torvalds 已提交
1593

1594
static struct workqueue_struct *keventd_wq __read_mostly;
L
Linus Torvalds 已提交
1595

1596 1597 1598 1599
/**
 * schedule_work - put work task in global workqueue
 * @work: job to be done
 *
1600 1601 1602 1603 1604 1605
 * 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.
1606
 */
1607
int schedule_work(struct work_struct *work)
L
Linus Torvalds 已提交
1608 1609 1610
{
	return queue_work(keventd_wq, work);
}
1611
EXPORT_SYMBOL(schedule_work);
L
Linus Torvalds 已提交
1612

1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
/*
 * 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);

1626 1627
/**
 * schedule_delayed_work - put work task in global workqueue after delay
1628 1629
 * @dwork: job to be done
 * @delay: number of jiffies to wait or 0 for immediate execution
1630 1631 1632 1633
 *
 * After waiting for a given time this puts a job in the kernel-global
 * workqueue.
 */
1634
int schedule_delayed_work(struct delayed_work *dwork,
1635
					unsigned long delay)
L
Linus Torvalds 已提交
1636
{
1637
	return queue_delayed_work(keventd_wq, dwork, delay);
L
Linus Torvalds 已提交
1638
}
1639
EXPORT_SYMBOL(schedule_delayed_work);
L
Linus Torvalds 已提交
1640

1641 1642 1643 1644 1645 1646 1647 1648 1649
/**
 * 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 已提交
1650 1651
		__queue_work(get_cpu(), get_wq_data(&dwork->work)->wq,
			     &dwork->work);
1652 1653 1654 1655 1656 1657
		put_cpu();
	}
	flush_work(&dwork->work);
}
EXPORT_SYMBOL(flush_delayed_work);

1658 1659 1660
/**
 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
 * @cpu: cpu to use
1661
 * @dwork: job to be done
1662 1663 1664 1665 1666
 * @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 已提交
1667
int schedule_delayed_work_on(int cpu,
1668
			struct delayed_work *dwork, unsigned long delay)
L
Linus Torvalds 已提交
1669
{
1670
	return queue_delayed_work_on(cpu, keventd_wq, dwork, delay);
L
Linus Torvalds 已提交
1671
}
1672
EXPORT_SYMBOL(schedule_delayed_work_on);
L
Linus Torvalds 已提交
1673

1674 1675 1676 1677 1678 1679 1680 1681 1682
/**
 * 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.
 */
1683
int schedule_on_each_cpu(work_func_t func)
1684 1685
{
	int cpu;
1686
	int orig = -1;
1687
	struct work_struct *works;
1688

1689 1690
	works = alloc_percpu(struct work_struct);
	if (!works)
1691
		return -ENOMEM;
1692

1693 1694
	get_online_cpus();

1695
	/*
1696 1697 1698
	 * 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.
1699
	 */
1700
	if (current_is_keventd())
1701 1702
		orig = raw_smp_processor_id();

1703
	for_each_online_cpu(cpu) {
1704 1705 1706
		struct work_struct *work = per_cpu_ptr(works, cpu);

		INIT_WORK(work, func);
1707
		if (cpu != orig)
1708
			schedule_work_on(cpu, work);
1709
	}
1710 1711 1712 1713 1714 1715
	if (orig >= 0)
		func(per_cpu_ptr(works, orig));

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

1716
	put_online_cpus();
1717
	free_percpu(works);
1718 1719 1720
	return 0;
}

1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744
/**
 * 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 已提交
1745 1746 1747 1748
void flush_scheduled_work(void)
{
	flush_workqueue(keventd_wq);
}
1749
EXPORT_SYMBOL(flush_scheduled_work);
L
Linus Torvalds 已提交
1750

1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
/**
 * 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
 */
1763
int execute_in_process_context(work_func_t fn, struct execute_work *ew)
1764 1765
{
	if (!in_interrupt()) {
1766
		fn(&ew->work);
1767 1768 1769
		return 0;
	}

1770
	INIT_WORK(&ew->work, fn);
1771 1772 1773 1774 1775 1776
	schedule_work(&ew->work);

	return 1;
}
EXPORT_SYMBOL_GPL(execute_in_process_context);

L
Linus Torvalds 已提交
1777 1778 1779 1780 1781 1782 1783 1784
int keventd_up(void)
{
	return keventd_wq != NULL;
}

int current_is_keventd(void)
{
	struct cpu_workqueue_struct *cwq;
H
Hugh Dickins 已提交
1785
	int cpu = raw_smp_processor_id(); /* preempt-safe: keventd is per-cpu */
L
Linus Torvalds 已提交
1786 1787 1788 1789
	int ret = 0;

	BUG_ON(!keventd_wq);

T
Tejun Heo 已提交
1790
	cwq = get_cwq(cpu, keventd_wq);
T
Tejun Heo 已提交
1791
	if (current == cwq->worker->task)
L
Linus Torvalds 已提交
1792 1793 1794 1795 1796 1797
		ret = 1;

	return ret;

}

T
Tejun Heo 已提交
1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844
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
}

1845
struct workqueue_struct *__create_workqueue_key(const char *name,
1846
						unsigned int flags,
1847
						int max_active,
1848 1849
						struct lock_class_key *key,
						const char *lock_name)
L
Linus Torvalds 已提交
1850 1851
{
	struct workqueue_struct *wq;
T
Tejun Heo 已提交
1852 1853
	bool failed = false;
	unsigned int cpu;
L
Linus Torvalds 已提交
1854

1855 1856
	max_active = clamp_val(max_active, 1, INT_MAX);

1857 1858
	wq = kzalloc(sizeof(*wq), GFP_KERNEL);
	if (!wq)
T
Tejun Heo 已提交
1859
		goto err;
1860

T
Tejun Heo 已提交
1861
	wq->cpu_wq = alloc_cwqs();
T
Tejun Heo 已提交
1862 1863
	if (!wq->cpu_wq)
		goto err;
1864

1865
	wq->flags = flags;
1866
	wq->saved_max_active = max_active;
1867 1868 1869 1870
	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);
1871 1872
	wq->single_cpu = NR_CPUS;

1873
	wq->name = name;
1874
	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
1875
	INIT_LIST_HEAD(&wq->list);
1876

T
Tejun Heo 已提交
1877 1878 1879 1880 1881 1882 1883 1884 1885
	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);
1886
		struct global_cwq *gcwq = get_gcwq(cpu);
T
Tejun Heo 已提交
1887

T
Tejun Heo 已提交
1888
		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
1889
		cwq->gcwq = gcwq;
T
Tejun Heo 已提交
1890
		cwq->wq = wq;
1891
		cwq->flush_color = -1;
1892
		cwq->max_active = max_active;
T
Tejun Heo 已提交
1893
		INIT_LIST_HEAD(&cwq->worklist);
1894
		INIT_LIST_HEAD(&cwq->delayed_works);
T
Tejun Heo 已提交
1895

T
Tejun Heo 已提交
1896
		if (failed)
T
Tejun Heo 已提交
1897
			continue;
1898
		cwq->worker = create_worker(cwq, cpu_online(cpu));
T
Tejun Heo 已提交
1899 1900
		if (cwq->worker)
			start_worker(cwq->worker);
T
Tejun Heo 已提交
1901
		else
T
Tejun Heo 已提交
1902
			failed = true;
1903 1904
	}

1905 1906 1907 1908 1909
	/*
	 * workqueue_lock protects global freeze state and workqueues
	 * list.  Grab it, set max_active accordingly and add the new
	 * workqueue to workqueues list.
	 */
T
Tejun Heo 已提交
1910
	spin_lock(&workqueue_lock);
1911 1912 1913 1914 1915

	if (workqueue_freezing && wq->flags & WQ_FREEZEABLE)
		for_each_possible_cpu(cpu)
			get_cwq(cpu, wq)->max_active = 0;

T
Tejun Heo 已提交
1916
	list_add(&wq->list, &workqueues);
1917

T
Tejun Heo 已提交
1918 1919 1920 1921
	spin_unlock(&workqueue_lock);

	cpu_maps_update_done();

T
Tejun Heo 已提交
1922
	if (failed) {
1923 1924 1925 1926
		destroy_workqueue(wq);
		wq = NULL;
	}
	return wq;
T
Tejun Heo 已提交
1927 1928
err:
	if (wq) {
T
Tejun Heo 已提交
1929
		free_cwqs(wq->cpu_wq);
T
Tejun Heo 已提交
1930 1931 1932
		kfree(wq);
	}
	return NULL;
1933
}
1934
EXPORT_SYMBOL_GPL(__create_workqueue_key);
L
Linus Torvalds 已提交
1935

1936 1937 1938 1939 1940 1941 1942 1943
/**
 * 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)
{
T
Tejun Heo 已提交
1944
	unsigned int cpu;
1945

1946 1947 1948 1949 1950 1951
	flush_workqueue(wq);

	/*
	 * wq list is used to freeze wq, remove from list after
	 * flushing is complete in case freeze races us.
	 */
1952
	cpu_maps_update_begin();
1953
	spin_lock(&workqueue_lock);
1954
	list_del(&wq->list);
1955
	spin_unlock(&workqueue_lock);
T
Tejun Heo 已提交
1956
	cpu_maps_update_done();
1957

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

T
Tejun Heo 已提交
1962
		if (cwq->worker) {
T
Tejun Heo 已提交
1963
			spin_lock_irq(&cwq->gcwq->lock);
T
Tejun Heo 已提交
1964 1965
			destroy_worker(cwq->worker);
			cwq->worker = NULL;
T
Tejun Heo 已提交
1966
			spin_unlock_irq(&cwq->gcwq->lock);
1967 1968 1969 1970
		}

		for (i = 0; i < WORK_NR_COLORS; i++)
			BUG_ON(cwq->nr_in_flight[i]);
1971 1972
		BUG_ON(cwq->nr_active);
		BUG_ON(!list_empty(&cwq->delayed_works));
1973
	}
1974

T
Tejun Heo 已提交
1975
	free_cwqs(wq->cpu_wq);
1976 1977 1978 1979
	kfree(wq);
}
EXPORT_SYMBOL_GPL(destroy_workqueue);

1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081
/*
 * CPU hotplug.
 *
 * CPU hotplug is implemented by allowing cwqs to be detached from
 * CPU, running with unbound workers and allowing them to be
 * reattached later if the cpu comes back online.  A separate thread
 * is created to govern cwqs in such state and is called the trustee.
 *
 * Trustee states and their descriptions.
 *
 * START	Command state used on startup.  On CPU_DOWN_PREPARE, a
 *		new trustee is started with this state.
 *
 * IN_CHARGE	Once started, trustee will enter this state after
 *		making all existing workers rogue.  DOWN_PREPARE waits
 *		for trustee to enter this state.  After reaching
 *		IN_CHARGE, trustee tries to execute the pending
 *		worklist until it's empty and the state is set to
 *		BUTCHER, or the state is set to RELEASE.
 *
 * BUTCHER	Command state which is set by the cpu callback after
 *		the cpu has went down.  Once this state is set trustee
 *		knows that there will be no new works on the worklist
 *		and once the worklist is empty it can proceed to
 *		killing idle workers.
 *
 * RELEASE	Command state which is set by the cpu callback if the
 *		cpu down has been canceled or it has come online
 *		again.  After recognizing this state, trustee stops
 *		trying to drain or butcher and transits to DONE.
 *
 * DONE		Trustee will enter this state after BUTCHER or RELEASE
 *		is complete.
 *
 *          trustee                 CPU                draining
 *         took over                down               complete
 * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
 *                        |                     |                  ^
 *                        | CPU is back online  v   return workers |
 *                         ----------------> RELEASE --------------
 */

/**
 * trustee_wait_event_timeout - timed event wait for trustee
 * @cond: condition to wait for
 * @timeout: timeout in jiffies
 *
 * wait_event_timeout() for trustee to use.  Handles locking and
 * checks for RELEASE request.
 *
 * CONTEXT:
 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
 * multiple times.  To be used by trustee.
 *
 * RETURNS:
 * Positive indicating left time if @cond is satisfied, 0 if timed
 * out, -1 if canceled.
 */
#define trustee_wait_event_timeout(cond, timeout) ({			\
	long __ret = (timeout);						\
	while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) &&	\
	       __ret) {							\
		spin_unlock_irq(&gcwq->lock);				\
		__wait_event_timeout(gcwq->trustee_wait, (cond) ||	\
			(gcwq->trustee_state == TRUSTEE_RELEASE),	\
			__ret);						\
		spin_lock_irq(&gcwq->lock);				\
	}								\
	gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret);		\
})

/**
 * trustee_wait_event - event wait for trustee
 * @cond: condition to wait for
 *
 * wait_event() for trustee to use.  Automatically handles locking and
 * checks for CANCEL request.
 *
 * CONTEXT:
 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
 * multiple times.  To be used by trustee.
 *
 * RETURNS:
 * 0 if @cond is satisfied, -1 if canceled.
 */
#define trustee_wait_event(cond) ({					\
	long __ret1;							\
	__ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
	__ret1 < 0 ? -1 : 0;						\
})

static int __cpuinit trustee_thread(void *__gcwq)
{
	struct global_cwq *gcwq = __gcwq;
	struct worker *worker;
	struct hlist_node *pos;
	int i;

	BUG_ON(gcwq->cpu != smp_processor_id());

	spin_lock_irq(&gcwq->lock);
	/*
2082 2083
	 * Make all workers rogue.  Trustee must be bound to the
	 * target cpu and can't be cancelled.
2084 2085 2086 2087
	 */
	BUG_ON(gcwq->cpu != smp_processor_id());

	list_for_each_entry(worker, &gcwq->idle_list, entry)
2088
		worker->flags |= WORKER_ROGUE;
2089 2090

	for_each_busy_worker(worker, i, pos, gcwq)
2091
		worker->flags |= WORKER_ROGUE;
2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147

	/*
	 * We're now in charge.  Notify and proceed to drain.  We need
	 * to keep the gcwq running during the whole CPU down
	 * procedure as other cpu hotunplug callbacks may need to
	 * flush currently running tasks.
	 */
	gcwq->trustee_state = TRUSTEE_IN_CHARGE;
	wake_up_all(&gcwq->trustee_wait);

	/*
	 * The original cpu is in the process of dying and may go away
	 * anytime now.  When that happens, we and all workers would
	 * be migrated to other cpus.  Try draining any left work.
	 * Note that if the gcwq is frozen, there may be frozen works
	 * in freezeable cwqs.  Don't declare completion while frozen.
	 */
	while (gcwq->nr_workers != gcwq->nr_idle ||
	       gcwq->flags & GCWQ_FREEZING ||
	       gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
		/* give a breather */
		if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
			break;
	}

	/* notify completion */
	gcwq->trustee = NULL;
	gcwq->trustee_state = TRUSTEE_DONE;
	wake_up_all(&gcwq->trustee_wait);
	spin_unlock_irq(&gcwq->lock);
	return 0;
}

/**
 * wait_trustee_state - wait for trustee to enter the specified state
 * @gcwq: gcwq the trustee of interest belongs to
 * @state: target state to wait for
 *
 * Wait for the trustee to reach @state.  DONE is already matched.
 *
 * CONTEXT:
 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
 * multiple times.  To be used by cpu_callback.
 */
static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
{
	if (!(gcwq->trustee_state == state ||
	      gcwq->trustee_state == TRUSTEE_DONE)) {
		spin_unlock_irq(&gcwq->lock);
		__wait_event(gcwq->trustee_wait,
			     gcwq->trustee_state == state ||
			     gcwq->trustee_state == TRUSTEE_DONE);
		spin_lock_irq(&gcwq->lock);
	}
}

2148 2149 2150 2151 2152
static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
						unsigned long action,
						void *hcpu)
{
	unsigned int cpu = (unsigned long)hcpu;
2153 2154 2155 2156 2157 2158
	struct global_cwq *gcwq = get_gcwq(cpu);
	struct task_struct *new_trustee = NULL;
	struct worker *worker;
	struct hlist_node *pos;
	unsigned long flags;
	int i;
2159

2160 2161
	action &= ~CPU_TASKS_FROZEN;

2162 2163 2164 2165 2166 2167 2168 2169
	switch (action) {
	case CPU_DOWN_PREPARE:
		new_trustee = kthread_create(trustee_thread, gcwq,
					     "workqueue_trustee/%d\n", cpu);
		if (IS_ERR(new_trustee))
			return notifier_from_errno(PTR_ERR(new_trustee));
		kthread_bind(new_trustee, cpu);
	}
2170

2171 2172
	/* some are called w/ irq disabled, don't disturb irq status */
	spin_lock_irqsave(&gcwq->lock, flags);
2173

2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193
	switch (action) {
	case CPU_DOWN_PREPARE:
		/* initialize trustee and tell it to acquire the gcwq */
		BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
		gcwq->trustee = new_trustee;
		gcwq->trustee_state = TRUSTEE_START;
		wake_up_process(gcwq->trustee);
		wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
		break;

	case CPU_POST_DEAD:
		gcwq->trustee_state = TRUSTEE_BUTCHER;
		break;

	case CPU_DOWN_FAILED:
	case CPU_ONLINE:
		if (gcwq->trustee_state != TRUSTEE_DONE) {
			gcwq->trustee_state = TRUSTEE_RELEASE;
			wake_up_process(gcwq->trustee);
			wait_trustee_state(gcwq, TRUSTEE_DONE);
2194
		}
2195

2196
		/* clear ROGUE from all workers */
2197
		list_for_each_entry(worker, &gcwq->idle_list, entry)
2198
			worker->flags &= ~WORKER_ROGUE;
2199 2200

		for_each_busy_worker(worker, i, pos, gcwq)
2201
			worker->flags &= ~WORKER_ROGUE;
2202
		break;
L
Linus Torvalds 已提交
2203 2204
	}

2205 2206
	spin_unlock_irqrestore(&gcwq->lock, flags);

T
Tejun Heo 已提交
2207
	return notifier_from_errno(0);
L
Linus Torvalds 已提交
2208 2209
}

2210
#ifdef CONFIG_SMP
2211

2212
struct work_for_cpu {
2213
	struct completion completion;
2214 2215 2216 2217 2218
	long (*fn)(void *);
	void *arg;
	long ret;
};

2219
static int do_work_for_cpu(void *_wfc)
2220
{
2221
	struct work_for_cpu *wfc = _wfc;
2222
	wfc->ret = wfc->fn(wfc->arg);
2223 2224
	complete(&wfc->completion);
	return 0;
2225 2226 2227 2228 2229 2230 2231 2232
}

/**
 * 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
 *
2233 2234
 * This will return the value @fn returns.
 * It is up to the caller to ensure that the cpu doesn't go offline.
2235
 * The caller must not hold any locks which would prevent @fn from completing.
2236 2237 2238
 */
long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
{
2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251
	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);
2252 2253 2254 2255 2256
	return wfc.ret;
}
EXPORT_SYMBOL_GPL(work_on_cpu);
#endif /* CONFIG_SMP */

2257 2258 2259 2260 2261 2262 2263 2264 2265 2266
#ifdef CONFIG_FREEZER

/**
 * freeze_workqueues_begin - begin freezing workqueues
 *
 * Start freezing workqueues.  After this function returns, all
 * freezeable workqueues will queue new works to their frozen_works
 * list instead of the cwq ones.
 *
 * CONTEXT:
2267
 * Grabs and releases workqueue_lock and gcwq->lock's.
2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279
 */
void freeze_workqueues_begin(void)
{
	struct workqueue_struct *wq;
	unsigned int cpu;

	spin_lock(&workqueue_lock);

	BUG_ON(workqueue_freezing);
	workqueue_freezing = true;

	for_each_possible_cpu(cpu) {
2280 2281 2282 2283
		struct global_cwq *gcwq = get_gcwq(cpu);

		spin_lock_irq(&gcwq->lock);

2284 2285 2286
		BUG_ON(gcwq->flags & GCWQ_FREEZING);
		gcwq->flags |= GCWQ_FREEZING;

2287 2288 2289 2290 2291 2292
		list_for_each_entry(wq, &workqueues, list) {
			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);

			if (wq->flags & WQ_FREEZEABLE)
				cwq->max_active = 0;
		}
2293 2294

		spin_unlock_irq(&gcwq->lock);
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352
	}

	spin_unlock(&workqueue_lock);
}

/**
 * freeze_workqueues_busy - are freezeable workqueues still busy?
 *
 * Check whether freezing is complete.  This function must be called
 * between freeze_workqueues_begin() and thaw_workqueues().
 *
 * CONTEXT:
 * Grabs and releases workqueue_lock.
 *
 * RETURNS:
 * %true if some freezeable workqueues are still busy.  %false if
 * freezing is complete.
 */
bool freeze_workqueues_busy(void)
{
	struct workqueue_struct *wq;
	unsigned int cpu;
	bool busy = false;

	spin_lock(&workqueue_lock);

	BUG_ON(!workqueue_freezing);

	for_each_possible_cpu(cpu) {
		/*
		 * nr_active is monotonically decreasing.  It's safe
		 * to peek without lock.
		 */
		list_for_each_entry(wq, &workqueues, list) {
			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);

			if (!(wq->flags & WQ_FREEZEABLE))
				continue;

			BUG_ON(cwq->nr_active < 0);
			if (cwq->nr_active) {
				busy = true;
				goto out_unlock;
			}
		}
	}
out_unlock:
	spin_unlock(&workqueue_lock);
	return busy;
}

/**
 * thaw_workqueues - thaw workqueues
 *
 * Thaw workqueues.  Normal queueing is restored and all collected
 * frozen works are transferred to their respective cwq worklists.
 *
 * CONTEXT:
2353
 * Grabs and releases workqueue_lock and gcwq->lock's.
2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365
 */
void thaw_workqueues(void)
{
	struct workqueue_struct *wq;
	unsigned int cpu;

	spin_lock(&workqueue_lock);

	if (!workqueue_freezing)
		goto out_unlock;

	for_each_possible_cpu(cpu) {
2366 2367 2368 2369
		struct global_cwq *gcwq = get_gcwq(cpu);

		spin_lock_irq(&gcwq->lock);

2370 2371 2372
		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
		gcwq->flags &= ~GCWQ_FREEZING;

2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385
		list_for_each_entry(wq, &workqueues, list) {
			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);

			if (!(wq->flags & WQ_FREEZEABLE))
				continue;

			/* restore max_active and repopulate worklist */
			cwq->max_active = wq->saved_max_active;

			while (!list_empty(&cwq->delayed_works) &&
			       cwq->nr_active < cwq->max_active)
				cwq_activate_first_delayed(cwq);

2386 2387 2388 2389 2390
			/* perform delayed unbind from single cpu if empty */
			if (wq->single_cpu == gcwq->cpu &&
			    !cwq->nr_active && list_empty(&cwq->delayed_works))
				cwq_unbind_single_cpu(cwq);

T
Tejun Heo 已提交
2391
			wake_up_process(cwq->worker->task);
2392
		}
2393 2394

		spin_unlock_irq(&gcwq->lock);
2395 2396 2397 2398 2399 2400 2401 2402
	}

	workqueue_freezing = false;
out_unlock:
	spin_unlock(&workqueue_lock);
}
#endif /* CONFIG_FREEZER */

2403
void __init init_workqueues(void)
L
Linus Torvalds 已提交
2404
{
T
Tejun Heo 已提交
2405
	unsigned int cpu;
T
Tejun Heo 已提交
2406
	int i;
T
Tejun Heo 已提交
2407

2408
	hotcpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
2409 2410 2411 2412 2413 2414 2415 2416

	/* initialize gcwqs */
	for_each_possible_cpu(cpu) {
		struct global_cwq *gcwq = get_gcwq(cpu);

		spin_lock_init(&gcwq->lock);
		gcwq->cpu = cpu;

T
Tejun Heo 已提交
2417 2418 2419 2420
		INIT_LIST_HEAD(&gcwq->idle_list);
		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);

2421
		ida_init(&gcwq->worker_ida);
2422 2423 2424

		gcwq->trustee_state = TRUSTEE_DONE;
		init_waitqueue_head(&gcwq->trustee_wait);
2425 2426
	}

L
Linus Torvalds 已提交
2427 2428 2429
	keventd_wq = create_workqueue("events");
	BUG_ON(!keventd_wq);
}