io-wq.c 28.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// SPDX-License-Identifier: GPL-2.0
/*
 * Basic worker thread pool for io_uring
 *
 * Copyright (C) 2019 Jens Axboe
 *
 */
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/errno.h>
#include <linux/sched/signal.h>
#include <linux/mm.h>
#include <linux/sched/mm.h>
#include <linux/percpu.h>
#include <linux/slab.h>
#include <linux/kthread.h>
#include <linux/rculist_nulls.h>
18
#include <linux/fs_struct.h>
19
#include <linux/task_work.h>
20
#include <linux/blk-cgroup.h>
21 22 23 24 25 26 27 28 29

#include "io-wq.h"

#define WORKER_IDLE_TIMEOUT	(5 * HZ)

enum {
	IO_WORKER_F_UP		= 1,	/* up and active */
	IO_WORKER_F_RUNNING	= 2,	/* account as running */
	IO_WORKER_F_FREE	= 4,	/* worker on free list */
30 31
	IO_WORKER_F_FIXED	= 8,	/* static idle worker */
	IO_WORKER_F_BOUND	= 16,	/* is doing bounded work */
32 33 34 35 36
};

enum {
	IO_WQ_BIT_EXIT		= 0,	/* wq exiting */
	IO_WQ_BIT_CANCEL	= 1,	/* cancel work on list */
37
	IO_WQ_BIT_ERROR		= 2,	/* error on setup */
38 39 40 41 42 43 44 45 46 47 48 49 50
};

enum {
	IO_WQE_FLAG_STALLED	= 1,	/* stalled on hash */
};

/*
 * One for each thread in a wqe pool
 */
struct io_worker {
	refcount_t ref;
	unsigned flags;
	struct hlist_nulls_node nulls_node;
51
	struct list_head all_list;
52 53
	struct task_struct *task;
	struct io_wqe *wqe;
54

55
	struct io_wq_work *cur_work;
56
	spinlock_t lock;
57 58 59

	struct rcu_head rcu;
	struct mm_struct *mm;
60 61 62
#ifdef CONFIG_BLK_CGROUP
	struct cgroup_subsys_state *blkcg_css;
#endif
63 64
	const struct cred *cur_creds;
	const struct cred *saved_creds;
65
	struct files_struct *restore_files;
66
	struct nsproxy *restore_nsproxy;
67
	struct fs_struct *restore_fs;
68 69 70 71 72 73 74 75
};

#if BITS_PER_LONG == 64
#define IO_WQ_HASH_ORDER	6
#else
#define IO_WQ_HASH_ORDER	5
#endif

76 77
#define IO_WQ_NR_HASH_BUCKETS	(1u << IO_WQ_HASH_ORDER)

78 79 80 81 82 83 84 85 86 87 88
struct io_wqe_acct {
	unsigned nr_workers;
	unsigned max_workers;
	atomic_t nr_running;
};

enum {
	IO_WQ_ACCT_BOUND,
	IO_WQ_ACCT_UNBOUND,
};

89 90 91 92 93
/*
 * Per-node worker thread pool
 */
struct io_wqe {
	struct {
94
		raw_spinlock_t lock;
J
Jens Axboe 已提交
95
		struct io_wq_work_list work_list;
96 97 98 99 100
		unsigned long hash_map;
		unsigned flags;
	} ____cacheline_aligned_in_smp;

	int node;
101
	struct io_wqe_acct acct[2];
102

103
	struct hlist_nulls_head free_list;
104
	struct list_head all_list;
105 106

	struct io_wq *wq;
107
	struct io_wq_work *hash_tail[IO_WQ_NR_HASH_BUCKETS];
108 109 110 111 112 113 114 115 116
};

/*
 * Per io_wq state
  */
struct io_wq {
	struct io_wqe **wqes;
	unsigned long state;

117
	free_work_fn *free_work;
118
	io_wq_work_fn *do_work;
119

120
	struct task_struct *manager;
121
	struct user_struct *user;
122 123
	refcount_t refs;
	struct completion done;
J
Jens Axboe 已提交
124 125

	refcount_t use_refs;
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
};

static bool io_worker_get(struct io_worker *worker)
{
	return refcount_inc_not_zero(&worker->ref);
}

static void io_worker_release(struct io_worker *worker)
{
	if (refcount_dec_and_test(&worker->ref))
		wake_up_process(worker->task);
}

/*
 * Note: drops the wqe->lock if returning true! The caller must re-acquire
 * the lock in that case. Some callers need to restart handling if this
 * happens, so we can't just re-acquire the lock on behalf of the caller.
 */
static bool __io_worker_unuse(struct io_wqe *wqe, struct io_worker *worker)
{
146 147
	bool dropped_lock = false;

148 149 150
	if (worker->saved_creds) {
		revert_creds(worker->saved_creds);
		worker->cur_creds = worker->saved_creds = NULL;
151 152
	}

153 154
	if (current->files != worker->restore_files) {
		__acquire(&wqe->lock);
155
		raw_spin_unlock_irq(&wqe->lock);
156 157 158 159
		dropped_lock = true;

		task_lock(current);
		current->files = worker->restore_files;
160
		current->nsproxy = worker->restore_nsproxy;
161 162 163
		task_unlock(current);
	}

164 165 166
	if (current->fs != worker->restore_fs)
		current->fs = worker->restore_fs;

167 168 169 170 171
	/*
	 * If we have an active mm, we need to drop the wq lock before unusing
	 * it. If we do, return true and let the caller retry the idle loop.
	 */
	if (worker->mm) {
172 173
		if (!dropped_lock) {
			__acquire(&wqe->lock);
174
			raw_spin_unlock_irq(&wqe->lock);
175 176
			dropped_lock = true;
		}
177
		__set_current_state(TASK_RUNNING);
178
		kthread_unuse_mm(worker->mm);
179 180 181 182
		mmput(worker->mm);
		worker->mm = NULL;
	}

183 184 185 186 187 188 189
#ifdef CONFIG_BLK_CGROUP
	if (worker->blkcg_css) {
		kthread_associate_blkcg(NULL);
		worker->blkcg_css = NULL;
	}
#endif

190
	return dropped_lock;
191 192
}

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
static inline struct io_wqe_acct *io_work_get_acct(struct io_wqe *wqe,
						   struct io_wq_work *work)
{
	if (work->flags & IO_WQ_WORK_UNBOUND)
		return &wqe->acct[IO_WQ_ACCT_UNBOUND];

	return &wqe->acct[IO_WQ_ACCT_BOUND];
}

static inline struct io_wqe_acct *io_wqe_get_acct(struct io_wqe *wqe,
						  struct io_worker *worker)
{
	if (worker->flags & IO_WORKER_F_BOUND)
		return &wqe->acct[IO_WQ_ACCT_BOUND];

	return &wqe->acct[IO_WQ_ACCT_UNBOUND];
}

211 212 213
static void io_worker_exit(struct io_worker *worker)
{
	struct io_wqe *wqe = worker->wqe;
214
	struct io_wqe_acct *acct = io_wqe_get_acct(wqe, worker);
215 216 217 218 219 220 221 222 223 224 225 226 227

	/*
	 * If we're not at zero, someone else is holding a brief reference
	 * to the worker. Wait for that to go away.
	 */
	set_current_state(TASK_INTERRUPTIBLE);
	if (!refcount_dec_and_test(&worker->ref))
		schedule();
	__set_current_state(TASK_RUNNING);

	preempt_disable();
	current->flags &= ~PF_IO_WORKER;
	if (worker->flags & IO_WORKER_F_RUNNING)
228 229 230
		atomic_dec(&acct->nr_running);
	if (!(worker->flags & IO_WORKER_F_BOUND))
		atomic_dec(&wqe->wq->user->processes);
231 232 233
	worker->flags = 0;
	preempt_enable();

234
	raw_spin_lock_irq(&wqe->lock);
235
	hlist_nulls_del_rcu(&worker->nulls_node);
236
	list_del_rcu(&worker->all_list);
237 238
	if (__io_worker_unuse(wqe, worker)) {
		__release(&wqe->lock);
239
		raw_spin_lock_irq(&wqe->lock);
240
	}
241
	acct->nr_workers--;
242
	raw_spin_unlock_irq(&wqe->lock);
243

244
	kfree_rcu(worker, rcu);
245 246
	if (refcount_dec_and_test(&wqe->wq->refs))
		complete(&wqe->wq->done);
247 248
}

249 250 251
static inline bool io_wqe_run_queue(struct io_wqe *wqe)
	__must_hold(wqe->lock)
{
J
Jens Axboe 已提交
252 253
	if (!wq_list_empty(&wqe->work_list) &&
	    !(wqe->flags & IO_WQE_FLAG_STALLED))
254 255 256 257 258 259 260 261 262 263 264 265 266 267
		return true;
	return false;
}

/*
 * Check head of free list for an available worker. If one isn't available,
 * caller must wake up the wq manager to create one.
 */
static bool io_wqe_activate_free_worker(struct io_wqe *wqe)
	__must_hold(RCU)
{
	struct hlist_nulls_node *n;
	struct io_worker *worker;

268
	n = rcu_dereference(hlist_nulls_first_rcu(&wqe->free_list));
269 270 271 272 273
	if (is_a_nulls(n))
		return false;

	worker = hlist_nulls_entry(n, struct io_worker, nulls_node);
	if (io_worker_get(worker)) {
J
Jens Axboe 已提交
274
		wake_up_process(worker->task);
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
		io_worker_release(worker);
		return true;
	}

	return false;
}

/*
 * We need a worker. If we find a free one, we're good. If not, and we're
 * below the max number of workers, wake up the manager to create one.
 */
static void io_wqe_wake_worker(struct io_wqe *wqe, struct io_wqe_acct *acct)
{
	bool ret;

	/*
	 * Most likely an attempt to queue unbounded work on an io_wq that
	 * wasn't setup with any unbounded workers.
	 */
	WARN_ON_ONCE(!acct->max_workers);

	rcu_read_lock();
	ret = io_wqe_activate_free_worker(wqe);
	rcu_read_unlock();

	if (!ret && acct->nr_workers < acct->max_workers)
		wake_up_process(wqe->wq->manager);
}

static void io_wqe_inc_running(struct io_wqe *wqe, struct io_worker *worker)
{
	struct io_wqe_acct *acct = io_wqe_get_acct(wqe, worker);

	atomic_inc(&acct->nr_running);
}

static void io_wqe_dec_running(struct io_wqe *wqe, struct io_worker *worker)
	__must_hold(wqe->lock)
{
	struct io_wqe_acct *acct = io_wqe_get_acct(wqe, worker);

	if (atomic_dec_and_test(&acct->nr_running) && io_wqe_run_queue(wqe))
		io_wqe_wake_worker(wqe, acct);
}

320 321 322 323 324 325 326
static void io_worker_start(struct io_wqe *wqe, struct io_worker *worker)
{
	allow_kernel_signal(SIGINT);

	current->flags |= PF_IO_WORKER;

	worker->flags |= (IO_WORKER_F_UP | IO_WORKER_F_RUNNING);
327
	worker->restore_files = current->files;
328
	worker->restore_nsproxy = current->nsproxy;
329
	worker->restore_fs = current->fs;
330
	io_wqe_inc_running(wqe, worker);
331 332 333 334 335 336 337 338 339 340
}

/*
 * Worker will start processing some work. Move it to the busy list, if
 * it's currently on the freelist
 */
static void __io_worker_busy(struct io_wqe *wqe, struct io_worker *worker,
			     struct io_wq_work *work)
	__must_hold(wqe->lock)
{
341 342
	bool worker_bound, work_bound;

343 344 345 346
	if (worker->flags & IO_WORKER_F_FREE) {
		worker->flags &= ~IO_WORKER_F_FREE;
		hlist_nulls_del_init_rcu(&worker->nulls_node);
	}
347 348 349 350 351

	/*
	 * If worker is moving from bound to unbound (or vice versa), then
	 * ensure we update the running accounting.
	 */
352 353 354
	worker_bound = (worker->flags & IO_WORKER_F_BOUND) != 0;
	work_bound = (work->flags & IO_WQ_WORK_UNBOUND) == 0;
	if (worker_bound != work_bound) {
355 356 357 358 359 360 361 362 363 364 365 366 367 368
		io_wqe_dec_running(wqe, worker);
		if (work_bound) {
			worker->flags |= IO_WORKER_F_BOUND;
			wqe->acct[IO_WQ_ACCT_UNBOUND].nr_workers--;
			wqe->acct[IO_WQ_ACCT_BOUND].nr_workers++;
			atomic_dec(&wqe->wq->user->processes);
		} else {
			worker->flags &= ~IO_WORKER_F_BOUND;
			wqe->acct[IO_WQ_ACCT_UNBOUND].nr_workers++;
			wqe->acct[IO_WQ_ACCT_BOUND].nr_workers--;
			atomic_inc(&wqe->wq->user->processes);
		}
		io_wqe_inc_running(wqe, worker);
	 }
369 370 371 372 373 374 375 376 377 378 379 380 381 382
}

/*
 * No work, worker going to sleep. Move to freelist, and unuse mm if we
 * have one attached. Dropping the mm may potentially sleep, so we drop
 * the lock in that case and return success. Since the caller has to
 * retry the loop in that case (we changed task state), we don't regrab
 * the lock if we return success.
 */
static bool __io_worker_idle(struct io_wqe *wqe, struct io_worker *worker)
	__must_hold(wqe->lock)
{
	if (!(worker->flags & IO_WORKER_F_FREE)) {
		worker->flags |= IO_WORKER_F_FREE;
383
		hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
384 385 386 387 388
	}

	return __io_worker_unuse(wqe, worker);
}

P
Pavel Begunkov 已提交
389 390 391 392 393 394
static inline unsigned int io_get_work_hash(struct io_wq_work *work)
{
	return work->flags >> IO_WQ_HASH_SHIFT;
}

static struct io_wq_work *io_get_next_work(struct io_wqe *wqe)
395 396
	__must_hold(wqe->lock)
{
J
Jens Axboe 已提交
397
	struct io_wq_work_node *node, *prev;
398
	struct io_wq_work *work, *tail;
P
Pavel Begunkov 已提交
399
	unsigned int hash;
400

J
Jens Axboe 已提交
401 402 403
	wq_list_for_each(node, prev, &wqe->work_list) {
		work = container_of(node, struct io_wq_work, list);

404
		/* not hashed, can run anytime */
405
		if (!io_wq_is_hashed(work)) {
406
			wq_list_del(&wqe->work_list, node, prev);
407 408 409 410
			return work;
		}

		/* hashed, can run if not already running */
P
Pavel Begunkov 已提交
411 412 413
		hash = io_get_work_hash(work);
		if (!(wqe->hash_map & BIT(hash))) {
			wqe->hash_map |= BIT(hash);
414 415 416 417
			/* all items with this hash lie in [work, tail] */
			tail = wqe->hash_tail[hash];
			wqe->hash_tail[hash] = NULL;
			wq_list_cut(&wqe->work_list, &tail->list, prev);
418 419 420 421 422 423 424
			return work;
		}
	}

	return NULL;
}

425 426 427
static void io_wq_switch_mm(struct io_worker *worker, struct io_wq_work *work)
{
	if (worker->mm) {
428
		kthread_unuse_mm(worker->mm);
429 430 431
		mmput(worker->mm);
		worker->mm = NULL;
	}
432
	if (!work->mm)
433
		return;
434

435
	if (mmget_not_zero(work->mm)) {
436
		kthread_use_mm(work->mm);
437 438 439 440 441 442 443 444 445 446
		worker->mm = work->mm;
		/* hang on to this mm */
		work->mm = NULL;
		return;
	}

	/* failed grabbing mm, ensure work gets cancelled */
	work->flags |= IO_WQ_WORK_CANCEL;
}

447 448 449 450
static inline void io_wq_switch_blkcg(struct io_worker *worker,
				      struct io_wq_work *work)
{
#ifdef CONFIG_BLK_CGROUP
451 452
	if (!(work->flags & IO_WQ_WORK_BLKCG))
		return;
453 454 455 456 457 458 459
	if (work->blkcg_css != worker->blkcg_css) {
		kthread_associate_blkcg(work->blkcg_css);
		worker->blkcg_css = work->blkcg_css;
	}
#endif
}

460 461 462 463 464 465 466 467 468 469 470 471
static void io_wq_switch_creds(struct io_worker *worker,
			       struct io_wq_work *work)
{
	const struct cred *old_creds = override_creds(work->creds);

	worker->cur_creds = work->creds;
	if (worker->saved_creds)
		put_cred(old_creds); /* creds set by previous switch */
	else
		worker->saved_creds = old_creds;
}

472 473 474
static void io_impersonate_work(struct io_worker *worker,
				struct io_wq_work *work)
{
475
	if ((work->flags & IO_WQ_WORK_FILES) && current->files != work->files) {
476 477
		task_lock(current);
		current->files = work->files;
478
		current->nsproxy = work->nsproxy;
479 480
		task_unlock(current);
	}
481
	if ((work->flags & IO_WQ_WORK_FS) && current->fs != work->fs)
482
		current->fs = work->fs;
483
	if ((work->flags & IO_WQ_WORK_MM) && work->mm != worker->mm)
484
		io_wq_switch_mm(worker, work);
485
	if ((work->flags & IO_WQ_WORK_CREDS) && worker->cur_creds != work->creds)
486
		io_wq_switch_creds(worker, work);
487
	current->signal->rlim[RLIMIT_FSIZE].rlim_cur = work->fsize;
488
	io_wq_switch_blkcg(worker, work);
489 490 491 492 493
}

static void io_assign_current_work(struct io_worker *worker,
				   struct io_wq_work *work)
{
494 495 496 497 498 499
	if (work) {
		/* flush pending signals before assigning new work */
		if (signal_pending(current))
			flush_signals(current);
		cond_resched();
	}
500 501 502 503 504 505

	spin_lock_irq(&worker->lock);
	worker->cur_work = work;
	spin_unlock_irq(&worker->lock);
}

P
Pavel Begunkov 已提交
506 507
static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work);

508 509 510 511 512 513 514
static void io_worker_handle_work(struct io_worker *worker)
	__releases(wqe->lock)
{
	struct io_wqe *wqe = worker->wqe;
	struct io_wq *wq = wqe->wq;

	do {
515
		struct io_wq_work *work;
516
get_next:
517 518 519 520 521 522 523
		/*
		 * If we got some work, mark us as busy. If we didn't, but
		 * the list isn't empty, it means we stalled on hashed work.
		 * Mark us stalled so we don't keep looking for work when we
		 * can't make progress, any work completion or insertion will
		 * clear the stalled flag.
		 */
P
Pavel Begunkov 已提交
524
		work = io_get_next_work(wqe);
525 526
		if (work)
			__io_worker_busy(wqe, worker, work);
J
Jens Axboe 已提交
527
		else if (!wq_list_empty(&wqe->work_list))
528 529
			wqe->flags |= IO_WQE_FLAG_STALLED;

530
		raw_spin_unlock_irq(&wqe->lock);
531 532
		if (!work)
			break;
533
		io_assign_current_work(worker, work);
534

535 536
		/* handle a whole dependent link */
		do {
537
			struct io_wq_work *old_work, *next_hashed, *linked;
P
Pavel Begunkov 已提交
538
			unsigned int hash = io_get_work_hash(work);
539

540
			next_hashed = wq_next_work(work);
541
			io_impersonate_work(worker, work);
542 543 544 545 546 547 548
			/*
			 * OK to set IO_WQ_WORK_CANCEL even for uncancellable
			 * work, the worker function will do the right thing.
			 */
			if (test_bit(IO_WQ_BIT_CANCEL, &wq->state))
				work->flags |= IO_WQ_WORK_CANCEL;

549 550
			old_work = work;
			linked = wq->do_work(work);
551 552 553 554 555 556 557

			work = next_hashed;
			if (!work && linked && !io_wq_is_hashed(linked)) {
				work = linked;
				linked = NULL;
			}
			io_assign_current_work(worker, work);
558
			wq->free_work(old_work);
559

560 561 562 563
			if (linked)
				io_wqe_enqueue(wqe, linked);

			if (hash != -1U && !next_hashed) {
564
				raw_spin_lock_irq(&wqe->lock);
565 566
				wqe->hash_map &= ~BIT_ULL(hash);
				wqe->flags &= ~IO_WQE_FLAG_STALLED;
567 568 569
				/* skip unnecessary unlock-lock wqe->lock */
				if (!work)
					goto get_next;
570
				raw_spin_unlock_irq(&wqe->lock);
571
			}
572
		} while (work);
573

574
		raw_spin_lock_irq(&wqe->lock);
575 576 577 578 579 580 581 582 583 584 585 586
	} while (1);
}

static int io_wqe_worker(void *data)
{
	struct io_worker *worker = data;
	struct io_wqe *wqe = worker->wqe;
	struct io_wq *wq = wqe->wq;

	io_worker_start(wqe, worker);

	while (!test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
J
Jens Axboe 已提交
587
		set_current_state(TASK_INTERRUPTIBLE);
588
loop:
589
		raw_spin_lock_irq(&wqe->lock);
590 591 592
		if (io_wqe_run_queue(wqe)) {
			__set_current_state(TASK_RUNNING);
			io_worker_handle_work(worker);
593
			goto loop;
594 595 596 597
		}
		/* drops the lock on success, retry */
		if (__io_worker_idle(wqe, worker)) {
			__release(&wqe->lock);
598
			goto loop;
599
		}
600
		raw_spin_unlock_irq(&wqe->lock);
601 602 603 604 605 606 607 608 609 610 611
		if (signal_pending(current))
			flush_signals(current);
		if (schedule_timeout(WORKER_IDLE_TIMEOUT))
			continue;
		/* timed out, exit unless we're the fixed worker */
		if (test_bit(IO_WQ_BIT_EXIT, &wq->state) ||
		    !(worker->flags & IO_WORKER_F_FIXED))
			break;
	}

	if (test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
612
		raw_spin_lock_irq(&wqe->lock);
J
Jens Axboe 已提交
613
		if (!wq_list_empty(&wqe->work_list))
614 615
			io_worker_handle_work(worker);
		else
616
			raw_spin_unlock_irq(&wqe->lock);
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
	}

	io_worker_exit(worker);
	return 0;
}

/*
 * Called when a worker is scheduled in. Mark us as currently running.
 */
void io_wq_worker_running(struct task_struct *tsk)
{
	struct io_worker *worker = kthread_data(tsk);
	struct io_wqe *wqe = worker->wqe;

	if (!(worker->flags & IO_WORKER_F_UP))
		return;
	if (worker->flags & IO_WORKER_F_RUNNING)
		return;
	worker->flags |= IO_WORKER_F_RUNNING;
636
	io_wqe_inc_running(wqe, worker);
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
}

/*
 * Called when worker is going to sleep. If there are no workers currently
 * running and we have work pending, wake up a free one or have the manager
 * set one up.
 */
void io_wq_worker_sleeping(struct task_struct *tsk)
{
	struct io_worker *worker = kthread_data(tsk);
	struct io_wqe *wqe = worker->wqe;

	if (!(worker->flags & IO_WORKER_F_UP))
		return;
	if (!(worker->flags & IO_WORKER_F_RUNNING))
		return;

	worker->flags &= ~IO_WORKER_F_RUNNING;

656
	raw_spin_lock_irq(&wqe->lock);
657
	io_wqe_dec_running(wqe, worker);
658
	raw_spin_unlock_irq(&wqe->lock);
659 660
}

661
static bool create_io_worker(struct io_wq *wq, struct io_wqe *wqe, int index)
662
{
663
	struct io_wqe_acct *acct = &wqe->acct[index];
664 665
	struct io_worker *worker;

666
	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, wqe->node);
667
	if (!worker)
668
		return false;
669 670 671 672

	refcount_set(&worker->ref, 1);
	worker->nulls_node.pprev = NULL;
	worker->wqe = wqe;
673
	spin_lock_init(&worker->lock);
674 675

	worker->task = kthread_create_on_node(io_wqe_worker, worker, wqe->node,
676
				"io_wqe_worker-%d/%d", index, wqe->node);
677 678
	if (IS_ERR(worker->task)) {
		kfree(worker);
679
		return false;
680
	}
681
	kthread_bind_mask(worker->task, cpumask_of_node(wqe->node));
682

683
	raw_spin_lock_irq(&wqe->lock);
684
	hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
685
	list_add_tail_rcu(&worker->all_list, &wqe->all_list);
686
	worker->flags |= IO_WORKER_F_FREE;
687 688 689
	if (index == IO_WQ_ACCT_BOUND)
		worker->flags |= IO_WORKER_F_BOUND;
	if (!acct->nr_workers && (worker->flags & IO_WORKER_F_BOUND))
690
		worker->flags |= IO_WORKER_F_FIXED;
691
	acct->nr_workers++;
692
	raw_spin_unlock_irq(&wqe->lock);
693

694 695 696
	if (index == IO_WQ_ACCT_UNBOUND)
		atomic_inc(&wq->user->processes);

697
	refcount_inc(&wq->refs);
698
	wake_up_process(worker->task);
699
	return true;
700 701
}

702
static inline bool io_wqe_need_worker(struct io_wqe *wqe, int index)
703 704
	__must_hold(wqe->lock)
{
705
	struct io_wqe_acct *acct = &wqe->acct[index];
706

707
	/* if we have available workers or no work, no need */
708
	if (!hlist_nulls_empty(&wqe->free_list) || !io_wqe_run_queue(wqe))
709 710
		return false;
	return acct->nr_workers < acct->max_workers;
711 712
}

713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
static bool io_wqe_worker_send_sig(struct io_worker *worker, void *data)
{
	send_sig(SIGINT, worker->task, 1);
	return false;
}

/*
 * Iterate the passed in list and call the specific function for each
 * worker that isn't exiting
 */
static bool io_wq_for_each_worker(struct io_wqe *wqe,
				  bool (*func)(struct io_worker *, void *),
				  void *data)
{
	struct io_worker *worker;
	bool ret = false;

	list_for_each_entry_rcu(worker, &wqe->all_list, all_list) {
		if (io_worker_get(worker)) {
			/* no task if node is/was offline */
			if (worker->task)
				ret = func(worker, data);
			io_worker_release(worker);
			if (ret)
				break;
		}
	}

	return ret;
}

static bool io_wq_worker_wake(struct io_worker *worker, void *data)
{
	wake_up_process(worker->task);
	return false;
}

750 751 752 753 754 755
/*
 * Manager thread. Tasked with creating new workers, if we need them.
 */
static int io_wq_manager(void *data)
{
	struct io_wq *wq = data;
J
Jann Horn 已提交
756
	int node;
757

758
	/* create fixed workers */
759
	refcount_set(&wq->refs, 1);
J
Jann Horn 已提交
760
	for_each_node(node) {
761 762
		if (!node_online(node))
			continue;
763 764 765 766 767
		if (create_io_worker(wq, wq->wqes[node], IO_WQ_ACCT_BOUND))
			continue;
		set_bit(IO_WQ_BIT_ERROR, &wq->state);
		set_bit(IO_WQ_BIT_EXIT, &wq->state);
		goto out;
768
	}
769

770 771 772
	complete(&wq->done);

	while (!kthread_should_stop()) {
773 774 775
		if (current->task_works)
			task_work_run();

J
Jann Horn 已提交
776 777
		for_each_node(node) {
			struct io_wqe *wqe = wq->wqes[node];
778
			bool fork_worker[2] = { false, false };
779

780 781 782
			if (!node_online(node))
				continue;

783
			raw_spin_lock_irq(&wqe->lock);
784 785 786 787
			if (io_wqe_need_worker(wqe, IO_WQ_ACCT_BOUND))
				fork_worker[IO_WQ_ACCT_BOUND] = true;
			if (io_wqe_need_worker(wqe, IO_WQ_ACCT_UNBOUND))
				fork_worker[IO_WQ_ACCT_UNBOUND] = true;
788
			raw_spin_unlock_irq(&wqe->lock);
789 790 791 792
			if (fork_worker[IO_WQ_ACCT_BOUND])
				create_io_worker(wq, wqe, IO_WQ_ACCT_BOUND);
			if (fork_worker[IO_WQ_ACCT_UNBOUND])
				create_io_worker(wq, wqe, IO_WQ_ACCT_UNBOUND);
793 794 795 796 797
		}
		set_current_state(TASK_INTERRUPTIBLE);
		schedule_timeout(HZ);
	}

798 799 800
	if (current->task_works)
		task_work_run();

801 802
out:
	if (refcount_dec_and_test(&wq->refs)) {
803
		complete(&wq->done);
804 805 806 807 808 809 810 811 812
		return 0;
	}
	/* if ERROR is set and we get here, we have workers to wake */
	if (test_bit(IO_WQ_BIT_ERROR, &wq->state)) {
		rcu_read_lock();
		for_each_node(node)
			io_wq_for_each_worker(wq->wqes[node], io_wq_worker_wake, NULL);
		rcu_read_unlock();
	}
813
	return 0;
814 815
}

816 817 818 819 820 821 822 823 824 825 826
static bool io_wq_can_queue(struct io_wqe *wqe, struct io_wqe_acct *acct,
			    struct io_wq_work *work)
{
	bool free_worker;

	if (!(work->flags & IO_WQ_WORK_UNBOUND))
		return true;
	if (atomic_read(&acct->nr_running))
		return true;

	rcu_read_lock();
827
	free_worker = !hlist_nulls_empty(&wqe->free_list);
828 829 830 831 832 833 834 835 836 837 838
	rcu_read_unlock();
	if (free_worker)
		return true;

	if (atomic_read(&wqe->wq->user->processes) >= acct->max_workers &&
	    !(capable(CAP_SYS_RESOURCE) || capable(CAP_SYS_ADMIN)))
		return false;

	return true;
}

839
static void io_run_cancel(struct io_wq_work *work, struct io_wqe *wqe)
840
{
841 842
	struct io_wq *wq = wqe->wq;

843 844 845 846
	do {
		struct io_wq_work *old_work = work;

		work->flags |= IO_WQ_WORK_CANCEL;
847
		work = wq->do_work(work);
848
		wq->free_work(old_work);
849 850 851
	} while (work);
}

852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
static void io_wqe_insert_work(struct io_wqe *wqe, struct io_wq_work *work)
{
	unsigned int hash;
	struct io_wq_work *tail;

	if (!io_wq_is_hashed(work)) {
append:
		wq_list_add_tail(&work->list, &wqe->work_list);
		return;
	}

	hash = io_get_work_hash(work);
	tail = wqe->hash_tail[hash];
	wqe->hash_tail[hash] = work;
	if (!tail)
		goto append;

	wq_list_add_after(&work->list, &tail->list, &wqe->work_list);
}

872 873
static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work)
{
874
	struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
875
	int work_flags;
876 877
	unsigned long flags;

878 879 880 881 882 883 884
	/*
	 * Do early check to see if we need a new unbound worker, and if we do,
	 * if we're allowed to do so. This isn't 100% accurate as there's a
	 * gap between this check and incrementing the value, but that's OK.
	 * It's close enough to not be an issue, fork() has the same delay.
	 */
	if (unlikely(!io_wq_can_queue(wqe, acct, work))) {
885
		io_run_cancel(work, wqe);
886 887 888
		return;
	}

889
	work_flags = work->flags;
890
	raw_spin_lock_irqsave(&wqe->lock, flags);
891
	io_wqe_insert_work(wqe, work);
892
	wqe->flags &= ~IO_WQE_FLAG_STALLED;
893
	raw_spin_unlock_irqrestore(&wqe->lock, flags);
894

895 896
	if ((work_flags & IO_WQ_WORK_CONCURRENT) ||
	    !atomic_read(&acct->nr_running))
897
		io_wqe_wake_worker(wqe, acct);
898 899 900 901 902 903 904 905 906 907
}

void io_wq_enqueue(struct io_wq *wq, struct io_wq_work *work)
{
	struct io_wqe *wqe = wq->wqes[numa_node_id()];

	io_wqe_enqueue(wqe, work);
}

/*
908 909
 * Work items that hash to the same value will not be done in parallel.
 * Used to limit concurrent writes, generally hashed by inode.
910
 */
911
void io_wq_hash_work(struct io_wq_work *work, void *val)
912
{
913
	unsigned int bit;
914 915 916 917 918 919 920

	bit = hash_ptr(val, IO_WQ_HASH_ORDER);
	work->flags |= (IO_WQ_WORK_HASHED | (bit << IO_WQ_HASH_SHIFT));
}

void io_wq_cancel_all(struct io_wq *wq)
{
J
Jann Horn 已提交
921
	int node;
922 923 924 925

	set_bit(IO_WQ_BIT_CANCEL, &wq->state);

	rcu_read_lock();
J
Jann Horn 已提交
926 927
	for_each_node(node) {
		struct io_wqe *wqe = wq->wqes[node];
928

929
		io_wq_for_each_worker(wqe, io_wqe_worker_send_sig, NULL);
930 931 932 933
	}
	rcu_read_unlock();
}

934
struct io_cb_cancel_data {
935 936
	work_cancel_fn *fn;
	void *data;
937 938 939
	int nr_running;
	int nr_pending;
	bool cancel_all;
940 941
};

942
static bool io_wq_worker_cancel(struct io_worker *worker, void *data)
943
{
944
	struct io_cb_cancel_data *match = data;
945
	unsigned long flags;
946 947 948

	/*
	 * Hold the lock to avoid ->cur_work going out of scope, caller
949
	 * may dereference the passed in work.
950
	 */
951
	spin_lock_irqsave(&worker->lock, flags);
952
	if (worker->cur_work &&
953
	    !(worker->cur_work->flags & IO_WQ_WORK_NO_CANCEL) &&
954
	    match->fn(worker->cur_work, match->data)) {
955
		send_sig(SIGINT, worker->task, 1);
956
		match->nr_running++;
957
	}
958
	spin_unlock_irqrestore(&worker->lock, flags);
959

960
	return match->nr_running && !match->cancel_all;
961 962
}

963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
static inline void io_wqe_remove_pending(struct io_wqe *wqe,
					 struct io_wq_work *work,
					 struct io_wq_work_node *prev)
{
	unsigned int hash = io_get_work_hash(work);
	struct io_wq_work *prev_work = NULL;

	if (io_wq_is_hashed(work) && work == wqe->hash_tail[hash]) {
		if (prev)
			prev_work = container_of(prev, struct io_wq_work, list);
		if (prev_work && io_get_work_hash(prev_work) == hash)
			wqe->hash_tail[hash] = prev_work;
		else
			wqe->hash_tail[hash] = NULL;
	}
	wq_list_del(&wqe->work_list, &work->list, prev);
}

981
static void io_wqe_cancel_pending_work(struct io_wqe *wqe,
982
				       struct io_cb_cancel_data *match)
983
{
J
Jens Axboe 已提交
984
	struct io_wq_work_node *node, *prev;
985
	struct io_wq_work *work;
986
	unsigned long flags;
987

988
retry:
989
	raw_spin_lock_irqsave(&wqe->lock, flags);
J
Jens Axboe 已提交
990 991
	wq_list_for_each(node, prev, &wqe->work_list) {
		work = container_of(node, struct io_wq_work, list);
992 993
		if (!match->fn(work, match->data))
			continue;
994
		io_wqe_remove_pending(wqe, work, prev);
995
		raw_spin_unlock_irqrestore(&wqe->lock, flags);
996 997 998 999 1000 1001 1002
		io_run_cancel(work, wqe);
		match->nr_pending++;
		if (!match->cancel_all)
			return;

		/* not safe to continue after unlock */
		goto retry;
1003
	}
1004
	raw_spin_unlock_irqrestore(&wqe->lock, flags);
1005 1006
}

1007
static void io_wqe_cancel_running_work(struct io_wqe *wqe,
1008 1009
				       struct io_cb_cancel_data *match)
{
1010
	rcu_read_lock();
1011
	io_wq_for_each_worker(wqe, io_wq_worker_cancel, match);
1012 1013 1014
	rcu_read_unlock();
}

1015
enum io_wq_cancel io_wq_cancel_cb(struct io_wq *wq, work_cancel_fn *cancel,
1016
				  void *data, bool cancel_all)
1017
{
1018
	struct io_cb_cancel_data match = {
1019 1020 1021
		.fn		= cancel,
		.data		= data,
		.cancel_all	= cancel_all,
1022
	};
J
Jann Horn 已提交
1023
	int node;
1024

1025 1026 1027 1028 1029
	/*
	 * First check pending list, if we're lucky we can just remove it
	 * from there. CANCEL_OK means that the work is returned as-new,
	 * no completion will be posted for it.
	 */
J
Jann Horn 已提交
1030 1031
	for_each_node(node) {
		struct io_wqe *wqe = wq->wqes[node];
1032

1033 1034
		io_wqe_cancel_pending_work(wqe, &match);
		if (match.nr_pending && !match.cancel_all)
1035
			return IO_WQ_CANCEL_OK;
1036 1037
	}

1038 1039 1040 1041 1042 1043 1044 1045 1046
	/*
	 * Now check if a free (going busy) or busy worker has the work
	 * currently running. If we find it there, we'll return CANCEL_RUNNING
	 * as an indication that we attempt to signal cancellation. The
	 * completion will run normally in this case.
	 */
	for_each_node(node) {
		struct io_wqe *wqe = wq->wqes[node];

1047 1048
		io_wqe_cancel_running_work(wqe, &match);
		if (match.nr_running && !match.cancel_all)
1049 1050 1051
			return IO_WQ_CANCEL_RUNNING;
	}

1052 1053 1054 1055
	if (match.nr_running)
		return IO_WQ_CANCEL_RUNNING;
	if (match.nr_pending)
		return IO_WQ_CANCEL_OK;
1056
	return IO_WQ_CANCEL_NOTFOUND;
1057 1058
}

1059 1060 1061 1062 1063 1064 1065
static bool io_wq_io_cb_cancel_data(struct io_wq_work *work, void *data)
{
	return work == data;
}

enum io_wq_cancel io_wq_cancel_work(struct io_wq *wq, struct io_wq_work *cwork)
{
1066
	return io_wq_cancel_cb(wq, io_wq_io_cb_cancel_data, (void *)cwork, false);
1067 1068
}

1069
struct io_wq *io_wq_create(unsigned bounded, struct io_wq_data *data)
1070
{
J
Jann Horn 已提交
1071
	int ret = -ENOMEM, node;
1072 1073
	struct io_wq *wq;

1074
	if (WARN_ON_ONCE(!data->free_work || !data->do_work))
1075 1076
		return ERR_PTR(-EINVAL);

1077
	wq = kzalloc(sizeof(*wq), GFP_KERNEL);
1078 1079 1080
	if (!wq)
		return ERR_PTR(-ENOMEM);

J
Jann Horn 已提交
1081
	wq->wqes = kcalloc(nr_node_ids, sizeof(struct io_wqe *), GFP_KERNEL);
1082 1083 1084 1085 1086
	if (!wq->wqes) {
		kfree(wq);
		return ERR_PTR(-ENOMEM);
	}

1087
	wq->free_work = data->free_work;
1088
	wq->do_work = data->do_work;
1089

1090
	/* caller must already hold a reference to this */
1091
	wq->user = data->user;
1092

J
Jann Horn 已提交
1093
	for_each_node(node) {
1094
		struct io_wqe *wqe;
1095
		int alloc_node = node;
1096

1097 1098 1099
		if (!node_online(alloc_node))
			alloc_node = NUMA_NO_NODE;
		wqe = kzalloc_node(sizeof(struct io_wqe), GFP_KERNEL, alloc_node);
1100
		if (!wqe)
J
Jann Horn 已提交
1101 1102
			goto err;
		wq->wqes[node] = wqe;
1103
		wqe->node = alloc_node;
1104 1105
		wqe->acct[IO_WQ_ACCT_BOUND].max_workers = bounded;
		atomic_set(&wqe->acct[IO_WQ_ACCT_BOUND].nr_running, 0);
1106
		if (wq->user) {
1107 1108 1109 1110
			wqe->acct[IO_WQ_ACCT_UNBOUND].max_workers =
					task_rlimit(current, RLIMIT_NPROC);
		}
		atomic_set(&wqe->acct[IO_WQ_ACCT_UNBOUND].nr_running, 0);
1111
		wqe->wq = wq;
1112
		raw_spin_lock_init(&wqe->lock);
J
Jens Axboe 已提交
1113
		INIT_WQ_LIST(&wqe->work_list);
1114
		INIT_HLIST_NULLS_HEAD(&wqe->free_list, 0);
1115
		INIT_LIST_HEAD(&wqe->all_list);
1116 1117 1118 1119 1120 1121 1122
	}

	init_completion(&wq->done);

	wq->manager = kthread_create(io_wq_manager, wq, "io_wq_manager");
	if (!IS_ERR(wq->manager)) {
		wake_up_process(wq->manager);
1123 1124 1125 1126 1127
		wait_for_completion(&wq->done);
		if (test_bit(IO_WQ_BIT_ERROR, &wq->state)) {
			ret = -ENOMEM;
			goto err;
		}
J
Jens Axboe 已提交
1128
		refcount_set(&wq->use_refs, 1);
1129
		reinit_completion(&wq->done);
1130 1131 1132 1133 1134
		return wq;
	}

	ret = PTR_ERR(wq->manager);
	complete(&wq->done);
1135
err:
J
Jann Horn 已提交
1136 1137
	for_each_node(node)
		kfree(wq->wqes[node]);
1138 1139
	kfree(wq->wqes);
	kfree(wq);
1140 1141 1142
	return ERR_PTR(ret);
}

1143 1144
bool io_wq_get(struct io_wq *wq, struct io_wq_data *data)
{
1145
	if (data->free_work != wq->free_work || data->do_work != wq->do_work)
1146 1147 1148 1149 1150
		return false;

	return refcount_inc_not_zero(&wq->use_refs);
}

J
Jens Axboe 已提交
1151
static void __io_wq_destroy(struct io_wq *wq)
1152
{
J
Jann Horn 已提交
1153
	int node;
1154

1155 1156
	set_bit(IO_WQ_BIT_EXIT, &wq->state);
	if (wq->manager)
1157 1158 1159
		kthread_stop(wq->manager);

	rcu_read_lock();
J
Jann Horn 已提交
1160 1161
	for_each_node(node)
		io_wq_for_each_worker(wq->wqes[node], io_wq_worker_wake, NULL);
1162 1163 1164 1165
	rcu_read_unlock();

	wait_for_completion(&wq->done);

J
Jann Horn 已提交
1166 1167
	for_each_node(node)
		kfree(wq->wqes[node]);
1168 1169 1170
	kfree(wq->wqes);
	kfree(wq);
}
J
Jens Axboe 已提交
1171 1172 1173 1174 1175 1176

void io_wq_destroy(struct io_wq *wq)
{
	if (refcount_dec_and_test(&wq->use_refs))
		__io_wq_destroy(wq);
}
1177 1178 1179 1180 1181

struct task_struct *io_wq_get_task(struct io_wq *wq)
{
	return wq->manager;
}