io-wq.c 29.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
#include <linux/audit.h>
22
#include <linux/cpu.h>
23

24
#include "../kernel/sched/sched.h"
25 26 27 28 29 30 31 32
#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 */
33 34
	IO_WORKER_F_FIXED	= 8,	/* static idle worker */
	IO_WORKER_F_BOUND	= 16,	/* is doing bounded work */
35 36 37 38
};

enum {
	IO_WQ_BIT_EXIT		= 0,	/* wq exiting */
39
	IO_WQ_BIT_ERROR		= 1,	/* error on setup */
40 41 42 43 44 45 46 47 48 49 50 51 52
};

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;
53
	struct list_head all_list;
54 55
	struct task_struct *task;
	struct io_wqe *wqe;
56

57
	struct io_wq_work *cur_work;
58
	spinlock_t lock;
59 60 61

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

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

78 79
#define IO_WQ_NR_HASH_BUCKETS	(1u << IO_WQ_HASH_ORDER)

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

enum {
	IO_WQ_ACCT_BOUND,
	IO_WQ_ACCT_UNBOUND,
};

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

	int node;
103
	struct io_wqe_acct acct[2];
104

105
	struct hlist_nulls_head free_list;
106
	struct list_head all_list;
107 108

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

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

119
	free_work_fn *free_work;
120
	io_wq_work_fn *do_work;
121

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

127 128
	struct hlist_node cpuhp_node;

J
Jens Axboe 已提交
129
	refcount_t use_refs;
130 131
};

132 133
static enum cpuhp_state io_wq_online;

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
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)
{
152 153
	bool dropped_lock = false;

154 155 156
	if (worker->saved_creds) {
		revert_creds(worker->saved_creds);
		worker->cur_creds = worker->saved_creds = NULL;
157 158
	}

159 160
	if (current->files != worker->restore_files) {
		__acquire(&wqe->lock);
161
		raw_spin_unlock_irq(&wqe->lock);
162 163 164 165
		dropped_lock = true;

		task_lock(current);
		current->files = worker->restore_files;
166
		current->nsproxy = worker->restore_nsproxy;
167 168 169
		task_unlock(current);
	}

170 171 172
	if (current->fs != worker->restore_fs)
		current->fs = worker->restore_fs;

173 174 175 176 177
	/*
	 * 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) {
178 179
		if (!dropped_lock) {
			__acquire(&wqe->lock);
180
			raw_spin_unlock_irq(&wqe->lock);
181 182
			dropped_lock = true;
		}
183
		__set_current_state(TASK_RUNNING);
184
		kthread_unuse_mm(worker->mm);
185 186 187 188
		mmput(worker->mm);
		worker->mm = NULL;
	}

189 190 191 192 193 194
#ifdef CONFIG_BLK_CGROUP
	if (worker->blkcg_css) {
		kthread_associate_blkcg(NULL);
		worker->blkcg_css = NULL;
	}
#endif
195 196
	if (current->signal->rlim[RLIMIT_FSIZE].rlim_cur != RLIM_INFINITY)
		current->signal->rlim[RLIMIT_FSIZE].rlim_cur = RLIM_INFINITY;
197
	return dropped_lock;
198 199
}

200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
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];
}

218 219 220
static void io_worker_exit(struct io_worker *worker)
{
	struct io_wqe *wqe = worker->wqe;
221
	struct io_wqe_acct *acct = io_wqe_get_acct(wqe, worker);
222 223 224 225 226 227 228 229 230 231 232 233 234

	/*
	 * 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)
235 236 237
		atomic_dec(&acct->nr_running);
	if (!(worker->flags & IO_WORKER_F_BOUND))
		atomic_dec(&wqe->wq->user->processes);
238 239 240
	worker->flags = 0;
	preempt_enable();

241
	raw_spin_lock_irq(&wqe->lock);
242
	hlist_nulls_del_rcu(&worker->nulls_node);
243
	list_del_rcu(&worker->all_list);
244 245
	if (__io_worker_unuse(wqe, worker)) {
		__release(&wqe->lock);
246
		raw_spin_lock_irq(&wqe->lock);
247
	}
248
	acct->nr_workers--;
249
	raw_spin_unlock_irq(&wqe->lock);
250

251
	kfree_rcu(worker, rcu);
252 253
	if (refcount_dec_and_test(&wqe->wq->refs))
		complete(&wqe->wq->done);
254 255
}

256 257 258
static inline bool io_wqe_run_queue(struct io_wqe *wqe)
	__must_hold(wqe->lock)
{
J
Jens Axboe 已提交
259 260
	if (!wq_list_empty(&wqe->work_list) &&
	    !(wqe->flags & IO_WQE_FLAG_STALLED))
261 262 263 264 265 266 267 268 269 270 271 272 273 274
		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;

275
	n = rcu_dereference(hlist_nulls_first_rcu(&wqe->free_list));
276 277 278 279 280
	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 已提交
281
		wake_up_process(worker->task);
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 320 321 322 323 324 325 326
		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);
}

327 328 329 330 331 332 333
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);
334
	worker->restore_files = current->files;
335
	worker->restore_nsproxy = current->nsproxy;
336
	worker->restore_fs = current->fs;
337
	io_wqe_inc_running(wqe, worker);
338 339 340 341 342 343 344 345 346 347
}

/*
 * 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)
{
348 349
	bool worker_bound, work_bound;

350 351 352 353
	if (worker->flags & IO_WORKER_F_FREE) {
		worker->flags &= ~IO_WORKER_F_FREE;
		hlist_nulls_del_init_rcu(&worker->nulls_node);
	}
354 355 356 357 358

	/*
	 * If worker is moving from bound to unbound (or vice versa), then
	 * ensure we update the running accounting.
	 */
359 360 361
	worker_bound = (worker->flags & IO_WORKER_F_BOUND) != 0;
	work_bound = (work->flags & IO_WQ_WORK_UNBOUND) == 0;
	if (worker_bound != work_bound) {
362 363 364 365 366 367 368 369 370 371 372 373 374 375
		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);
	 }
376 377 378 379 380 381 382 383 384 385 386 387 388 389
}

/*
 * 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;
390
		hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
391 392 393 394 395
	}

	return __io_worker_unuse(wqe, worker);
}

P
Pavel Begunkov 已提交
396 397 398 399 400 401
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)
402 403
	__must_hold(wqe->lock)
{
J
Jens Axboe 已提交
404
	struct io_wq_work_node *node, *prev;
405
	struct io_wq_work *work, *tail;
P
Pavel Begunkov 已提交
406
	unsigned int hash;
407

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

411
		/* not hashed, can run anytime */
412
		if (!io_wq_is_hashed(work)) {
413
			wq_list_del(&wqe->work_list, node, prev);
414 415 416 417
			return work;
		}

		/* hashed, can run if not already running */
P
Pavel Begunkov 已提交
418 419 420
		hash = io_get_work_hash(work);
		if (!(wqe->hash_map & BIT(hash))) {
			wqe->hash_map |= BIT(hash);
421 422 423 424
			/* 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);
425 426 427 428 429 430 431
			return work;
		}
	}

	return NULL;
}

432 433 434
static void io_wq_switch_mm(struct io_worker *worker, struct io_wq_work *work)
{
	if (worker->mm) {
435
		kthread_unuse_mm(worker->mm);
436 437 438
		mmput(worker->mm);
		worker->mm = NULL;
	}
439

440 441 442
	if (mmget_not_zero(work->identity->mm)) {
		kthread_use_mm(work->identity->mm);
		worker->mm = work->identity->mm;
443 444 445 446 447 448 449
		return;
	}

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

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

463 464 465
static void io_wq_switch_creds(struct io_worker *worker,
			       struct io_wq_work *work)
{
466
	const struct cred *old_creds = override_creds(work->identity->creds);
467

468
	worker->cur_creds = work->identity->creds;
469 470 471 472 473 474
	if (worker->saved_creds)
		put_cred(old_creds); /* creds set by previous switch */
	else
		worker->saved_creds = old_creds;
}

475 476 477
static void io_impersonate_work(struct io_worker *worker,
				struct io_wq_work *work)
{
478 479
	if ((work->flags & IO_WQ_WORK_FILES) &&
	    current->files != work->identity->files) {
480
		task_lock(current);
481 482
		current->files = work->identity->files;
		current->nsproxy = work->identity->nsproxy;
483
		task_unlock(current);
484 485 486 487
		if (!work->identity->files) {
			/* failed grabbing files, ensure work gets cancelled */
			work->flags |= IO_WQ_WORK_CANCEL;
		}
488
	}
489 490 491
	if ((work->flags & IO_WQ_WORK_FS) && current->fs != work->identity->fs)
		current->fs = work->identity->fs;
	if ((work->flags & IO_WQ_WORK_MM) && work->identity->mm != worker->mm)
492
		io_wq_switch_mm(worker, work);
493 494
	if ((work->flags & IO_WQ_WORK_CREDS) &&
	    worker->cur_creds != work->identity->creds)
495
		io_wq_switch_creds(worker, work);
496 497 498 499
	if (work->flags & IO_WQ_WORK_FSIZE)
		current->signal->rlim[RLIMIT_FSIZE].rlim_cur = work->identity->fsize;
	else if (current->signal->rlim[RLIMIT_FSIZE].rlim_cur != RLIM_INFINITY)
		current->signal->rlim[RLIMIT_FSIZE].rlim_cur = RLIM_INFINITY;
500
	io_wq_switch_blkcg(worker, work);
501 502 503 504
#ifdef CONFIG_AUDIT
	current->loginuid = work->identity->loginuid;
	current->sessionid = work->identity->sessionid;
#endif
505 506 507 508 509
}

static void io_assign_current_work(struct io_worker *worker,
				   struct io_wq_work *work)
{
510 511 512 513 514 515
	if (work) {
		/* flush pending signals before assigning new work */
		if (signal_pending(current))
			flush_signals(current);
		cond_resched();
	}
516

517 518 519 520 521
#ifdef CONFIG_AUDIT
	current->loginuid = KUIDT_INIT(AUDIT_UID_UNSET);
	current->sessionid = AUDIT_SID_UNSET;
#endif

522 523 524 525 526
	spin_lock_irq(&worker->lock);
	worker->cur_work = work;
	spin_unlock_irq(&worker->lock);
}

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

529 530 531 532 533 534 535
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 {
536
		struct io_wq_work *work;
537
get_next:
538 539 540 541 542 543 544
		/*
		 * 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 已提交
545
		work = io_get_next_work(wqe);
546 547
		if (work)
			__io_worker_busy(wqe, worker, work);
J
Jens Axboe 已提交
548
		else if (!wq_list_empty(&wqe->work_list))
549 550
			wqe->flags |= IO_WQE_FLAG_STALLED;

551
		raw_spin_unlock_irq(&wqe->lock);
552 553
		if (!work)
			break;
554
		io_assign_current_work(worker, work);
555

556 557
		/* handle a whole dependent link */
		do {
558
			struct io_wq_work *next_hashed, *linked;
P
Pavel Begunkov 已提交
559
			unsigned int hash = io_get_work_hash(work);
560

561
			next_hashed = wq_next_work(work);
562
			io_impersonate_work(worker, work);
563 564
			wq->do_work(work);
			io_assign_current_work(worker, NULL);
565

566
			linked = wq->free_work(work);
567 568 569 570 571 572 573 574 575 576
			work = next_hashed;
			if (!work && linked && !io_wq_is_hashed(linked)) {
				work = linked;
				linked = NULL;
			}
			io_assign_current_work(worker, work);
			if (linked)
				io_wqe_enqueue(wqe, linked);

			if (hash != -1U && !next_hashed) {
577
				raw_spin_lock_irq(&wqe->lock);
578 579
				wqe->hash_map &= ~BIT_ULL(hash);
				wqe->flags &= ~IO_WQE_FLAG_STALLED;
580 581 582
				/* skip unnecessary unlock-lock wqe->lock */
				if (!work)
					goto get_next;
583
				raw_spin_unlock_irq(&wqe->lock);
584
			}
585
		} while (work);
586

587
		raw_spin_lock_irq(&wqe->lock);
588 589 590 591 592 593 594 595 596 597 598 599
	} 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 已提交
600
		set_current_state(TASK_INTERRUPTIBLE);
601
loop:
602
		raw_spin_lock_irq(&wqe->lock);
603 604 605
		if (io_wqe_run_queue(wqe)) {
			__set_current_state(TASK_RUNNING);
			io_worker_handle_work(worker);
606
			goto loop;
607 608 609 610
		}
		/* drops the lock on success, retry */
		if (__io_worker_idle(wqe, worker)) {
			__release(&wqe->lock);
611
			goto loop;
612
		}
613
		raw_spin_unlock_irq(&wqe->lock);
614 615 616 617 618 619 620 621 622 623 624
		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)) {
625
		raw_spin_lock_irq(&wqe->lock);
J
Jens Axboe 已提交
626
		if (!wq_list_empty(&wqe->work_list))
627 628
			io_worker_handle_work(worker);
		else
629
			raw_spin_unlock_irq(&wqe->lock);
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
	}

	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;
649
	io_wqe_inc_running(wqe, worker);
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
}

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

669
	raw_spin_lock_irq(&wqe->lock);
670
	io_wqe_dec_running(wqe, worker);
671
	raw_spin_unlock_irq(&wqe->lock);
672 673
}

674
static bool create_io_worker(struct io_wq *wq, struct io_wqe *wqe, int index)
675
{
676
	struct io_wqe_acct *acct = &wqe->acct[index];
677 678
	struct io_worker *worker;

679
	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, wqe->node);
680
	if (!worker)
681
		return false;
682 683 684 685

	refcount_set(&worker->ref, 1);
	worker->nulls_node.pprev = NULL;
	worker->wqe = wqe;
686
	spin_lock_init(&worker->lock);
687 688

	worker->task = kthread_create_on_node(io_wqe_worker, worker, wqe->node,
689
				"io_wqe_worker-%d/%d", index, wqe->node);
690 691
	if (IS_ERR(worker->task)) {
		kfree(worker);
692
		return false;
693
	}
694
	kthread_bind_mask(worker->task, cpumask_of_node(wqe->node));
695

696
	raw_spin_lock_irq(&wqe->lock);
697
	hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
698
	list_add_tail_rcu(&worker->all_list, &wqe->all_list);
699
	worker->flags |= IO_WORKER_F_FREE;
700 701 702
	if (index == IO_WQ_ACCT_BOUND)
		worker->flags |= IO_WORKER_F_BOUND;
	if (!acct->nr_workers && (worker->flags & IO_WORKER_F_BOUND))
703
		worker->flags |= IO_WORKER_F_FIXED;
704
	acct->nr_workers++;
705
	raw_spin_unlock_irq(&wqe->lock);
706

707 708 709
	if (index == IO_WQ_ACCT_UNBOUND)
		atomic_inc(&wq->user->processes);

710
	refcount_inc(&wq->refs);
711
	wake_up_process(worker->task);
712
	return true;
713 714
}

715
static inline bool io_wqe_need_worker(struct io_wqe *wqe, int index)
716 717
	__must_hold(wqe->lock)
{
718
	struct io_wqe_acct *acct = &wqe->acct[index];
719

720
	/* if we have available workers or no work, no need */
721
	if (!hlist_nulls_empty(&wqe->free_list) || !io_wqe_run_queue(wqe))
722 723
		return false;
	return acct->nr_workers < acct->max_workers;
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 750 751 752 753 754 755 756
/*
 * 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;
}

757 758 759 760 761 762
/*
 * 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 已提交
763
	int node;
764

765
	/* create fixed workers */
766
	refcount_set(&wq->refs, 1);
J
Jann Horn 已提交
767
	for_each_node(node) {
768 769
		if (!node_online(node))
			continue;
770 771 772 773 774
		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;
775
	}
776

777 778 779
	complete(&wq->done);

	while (!kthread_should_stop()) {
780 781 782
		if (current->task_works)
			task_work_run();

J
Jann Horn 已提交
783 784
		for_each_node(node) {
			struct io_wqe *wqe = wq->wqes[node];
785
			bool fork_worker[2] = { false, false };
786

787 788 789
			if (!node_online(node))
				continue;

790
			raw_spin_lock_irq(&wqe->lock);
791 792 793 794
			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;
795
			raw_spin_unlock_irq(&wqe->lock);
796 797 798 799
			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);
800 801 802 803 804
		}
		set_current_state(TASK_INTERRUPTIBLE);
		schedule_timeout(HZ);
	}

805 806 807
	if (current->task_works)
		task_work_run();

808 809
out:
	if (refcount_dec_and_test(&wq->refs)) {
810
		complete(&wq->done);
811 812 813 814 815 816 817 818 819
		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();
	}
820
	return 0;
821 822
}

823 824 825 826 827 828 829 830 831 832 833
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();
834
	free_worker = !hlist_nulls_empty(&wqe->free_list);
835 836 837 838 839 840 841 842 843 844 845
	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;
}

846
static void io_run_cancel(struct io_wq_work *work, struct io_wqe *wqe)
847
{
848 849
	struct io_wq *wq = wqe->wq;

850 851
	do {
		work->flags |= IO_WQ_WORK_CANCEL;
852 853
		wq->do_work(work);
		work = wq->free_work(work);
854 855 856
	} while (work);
}

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
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);
}

877 878
static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work)
{
879
	struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
880
	int work_flags;
881 882
	unsigned long flags;

883 884 885 886 887 888 889
	/*
	 * 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))) {
890
		io_run_cancel(work, wqe);
891 892 893
		return;
	}

894
	work_flags = work->flags;
895
	raw_spin_lock_irqsave(&wqe->lock, flags);
896
	io_wqe_insert_work(wqe, work);
897
	wqe->flags &= ~IO_WQE_FLAG_STALLED;
898
	raw_spin_unlock_irqrestore(&wqe->lock, flags);
899

900 901
	if ((work_flags & IO_WQ_WORK_CONCURRENT) ||
	    !atomic_read(&acct->nr_running))
902
		io_wqe_wake_worker(wqe, acct);
903 904 905 906 907 908 909 910 911 912
}

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

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

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

924
struct io_cb_cancel_data {
925 926
	work_cancel_fn *fn;
	void *data;
927 928 929
	int nr_running;
	int nr_pending;
	bool cancel_all;
930 931
};

932
static bool io_wq_worker_cancel(struct io_worker *worker, void *data)
933
{
934
	struct io_cb_cancel_data *match = data;
935
	unsigned long flags;
936 937 938

	/*
	 * Hold the lock to avoid ->cur_work going out of scope, caller
939
	 * may dereference the passed in work.
940
	 */
941
	spin_lock_irqsave(&worker->lock, flags);
942
	if (worker->cur_work &&
943
	    match->fn(worker->cur_work, match->data)) {
944
		send_sig(SIGINT, worker->task, 1);
945
		match->nr_running++;
946
	}
947
	spin_unlock_irqrestore(&worker->lock, flags);
948

949
	return match->nr_running && !match->cancel_all;
950 951
}

952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
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);
}

970
static void io_wqe_cancel_pending_work(struct io_wqe *wqe,
971
				       struct io_cb_cancel_data *match)
972
{
J
Jens Axboe 已提交
973
	struct io_wq_work_node *node, *prev;
974
	struct io_wq_work *work;
975
	unsigned long flags;
976

977
retry:
978
	raw_spin_lock_irqsave(&wqe->lock, flags);
J
Jens Axboe 已提交
979 980
	wq_list_for_each(node, prev, &wqe->work_list) {
		work = container_of(node, struct io_wq_work, list);
981 982
		if (!match->fn(work, match->data))
			continue;
983
		io_wqe_remove_pending(wqe, work, prev);
984
		raw_spin_unlock_irqrestore(&wqe->lock, flags);
985 986 987 988 989 990 991
		io_run_cancel(work, wqe);
		match->nr_pending++;
		if (!match->cancel_all)
			return;

		/* not safe to continue after unlock */
		goto retry;
992
	}
993
	raw_spin_unlock_irqrestore(&wqe->lock, flags);
994 995
}

996
static void io_wqe_cancel_running_work(struct io_wqe *wqe,
997 998
				       struct io_cb_cancel_data *match)
{
999
	rcu_read_lock();
1000
	io_wq_for_each_worker(wqe, io_wq_worker_cancel, match);
1001 1002 1003
	rcu_read_unlock();
}

1004
enum io_wq_cancel io_wq_cancel_cb(struct io_wq *wq, work_cancel_fn *cancel,
1005
				  void *data, bool cancel_all)
1006
{
1007
	struct io_cb_cancel_data match = {
1008 1009 1010
		.fn		= cancel,
		.data		= data,
		.cancel_all	= cancel_all,
1011
	};
J
Jann Horn 已提交
1012
	int node;
1013

1014 1015 1016 1017 1018
	/*
	 * 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 已提交
1019 1020
	for_each_node(node) {
		struct io_wqe *wqe = wq->wqes[node];
1021

1022 1023
		io_wqe_cancel_pending_work(wqe, &match);
		if (match.nr_pending && !match.cancel_all)
1024
			return IO_WQ_CANCEL_OK;
1025 1026
	}

1027 1028 1029 1030 1031 1032 1033 1034 1035
	/*
	 * 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];

1036 1037
		io_wqe_cancel_running_work(wqe, &match);
		if (match.nr_running && !match.cancel_all)
1038 1039 1040
			return IO_WQ_CANCEL_RUNNING;
	}

1041 1042 1043 1044
	if (match.nr_running)
		return IO_WQ_CANCEL_RUNNING;
	if (match.nr_pending)
		return IO_WQ_CANCEL_OK;
1045
	return IO_WQ_CANCEL_NOTFOUND;
1046 1047
}

1048
struct io_wq *io_wq_create(unsigned bounded, struct io_wq_data *data)
1049
{
J
Jann Horn 已提交
1050
	int ret = -ENOMEM, node;
1051 1052
	struct io_wq *wq;

1053
	if (WARN_ON_ONCE(!data->free_work || !data->do_work))
1054 1055
		return ERR_PTR(-EINVAL);

1056
	wq = kzalloc(sizeof(*wq), GFP_KERNEL);
1057 1058 1059
	if (!wq)
		return ERR_PTR(-ENOMEM);

J
Jann Horn 已提交
1060
	wq->wqes = kcalloc(nr_node_ids, sizeof(struct io_wqe *), GFP_KERNEL);
1061 1062 1063 1064 1065 1066
	if (!wq->wqes)
		goto err_wq;

	ret = cpuhp_state_add_instance_nocalls(io_wq_online, &wq->cpuhp_node);
	if (ret)
		goto err_wqes;
1067

1068
	wq->free_work = data->free_work;
1069
	wq->do_work = data->do_work;
1070

1071
	/* caller must already hold a reference to this */
1072
	wq->user = data->user;
1073

1074
	ret = -ENOMEM;
J
Jann Horn 已提交
1075
	for_each_node(node) {
1076
		struct io_wqe *wqe;
1077
		int alloc_node = node;
1078

1079 1080 1081
		if (!node_online(alloc_node))
			alloc_node = NUMA_NO_NODE;
		wqe = kzalloc_node(sizeof(struct io_wqe), GFP_KERNEL, alloc_node);
1082
		if (!wqe)
J
Jann Horn 已提交
1083 1084
			goto err;
		wq->wqes[node] = wqe;
1085
		wqe->node = alloc_node;
1086 1087
		wqe->acct[IO_WQ_ACCT_BOUND].max_workers = bounded;
		atomic_set(&wqe->acct[IO_WQ_ACCT_BOUND].nr_running, 0);
1088
		if (wq->user) {
1089 1090 1091 1092
			wqe->acct[IO_WQ_ACCT_UNBOUND].max_workers =
					task_rlimit(current, RLIMIT_NPROC);
		}
		atomic_set(&wqe->acct[IO_WQ_ACCT_UNBOUND].nr_running, 0);
1093
		wqe->wq = wq;
1094
		raw_spin_lock_init(&wqe->lock);
J
Jens Axboe 已提交
1095
		INIT_WQ_LIST(&wqe->work_list);
1096
		INIT_HLIST_NULLS_HEAD(&wqe->free_list, 0);
1097
		INIT_LIST_HEAD(&wqe->all_list);
1098 1099 1100 1101 1102 1103 1104
	}

	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);
1105 1106 1107 1108 1109
		wait_for_completion(&wq->done);
		if (test_bit(IO_WQ_BIT_ERROR, &wq->state)) {
			ret = -ENOMEM;
			goto err;
		}
J
Jens Axboe 已提交
1110
		refcount_set(&wq->use_refs, 1);
1111
		reinit_completion(&wq->done);
1112 1113 1114 1115 1116
		return wq;
	}

	ret = PTR_ERR(wq->manager);
	complete(&wq->done);
1117
err:
1118
	cpuhp_state_remove_instance_nocalls(io_wq_online, &wq->cpuhp_node);
J
Jann Horn 已提交
1119 1120
	for_each_node(node)
		kfree(wq->wqes[node]);
1121
err_wqes:
1122
	kfree(wq->wqes);
1123
err_wq:
1124
	kfree(wq);
1125 1126 1127
	return ERR_PTR(ret);
}

1128 1129
bool io_wq_get(struct io_wq *wq, struct io_wq_data *data)
{
1130
	if (data->free_work != wq->free_work || data->do_work != wq->do_work)
1131 1132 1133 1134 1135
		return false;

	return refcount_inc_not_zero(&wq->use_refs);
}

J
Jens Axboe 已提交
1136
static void __io_wq_destroy(struct io_wq *wq)
1137
{
J
Jann Horn 已提交
1138
	int node;
1139

1140 1141
	cpuhp_state_remove_instance_nocalls(io_wq_online, &wq->cpuhp_node);

1142 1143
	set_bit(IO_WQ_BIT_EXIT, &wq->state);
	if (wq->manager)
1144 1145 1146
		kthread_stop(wq->manager);

	rcu_read_lock();
J
Jann Horn 已提交
1147 1148
	for_each_node(node)
		io_wq_for_each_worker(wq->wqes[node], io_wq_worker_wake, NULL);
1149 1150 1151 1152
	rcu_read_unlock();

	wait_for_completion(&wq->done);

J
Jann Horn 已提交
1153 1154
	for_each_node(node)
		kfree(wq->wqes[node]);
1155 1156 1157
	kfree(wq->wqes);
	kfree(wq);
}
J
Jens Axboe 已提交
1158 1159 1160 1161 1162 1163

void io_wq_destroy(struct io_wq *wq)
{
	if (refcount_dec_and_test(&wq->use_refs))
		__io_wq_destroy(wq);
}
1164 1165 1166 1167 1168

struct task_struct *io_wq_get_task(struct io_wq *wq)
{
	return wq->manager;
}
1169 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 1205 1206

static bool io_wq_worker_affinity(struct io_worker *worker, void *data)
{
	struct task_struct *task = worker->task;
	struct rq_flags rf;
	struct rq *rq;

	rq = task_rq_lock(task, &rf);
	do_set_cpus_allowed(task, cpumask_of_node(worker->wqe->node));
	task->flags |= PF_NO_SETAFFINITY;
	task_rq_unlock(rq, task, &rf);
	return false;
}

static int io_wq_cpu_online(unsigned int cpu, struct hlist_node *node)
{
	struct io_wq *wq = hlist_entry_safe(node, struct io_wq, cpuhp_node);
	int i;

	rcu_read_lock();
	for_each_node(i)
		io_wq_for_each_worker(wq->wqes[i], io_wq_worker_affinity, NULL);
	rcu_read_unlock();
	return 0;
}

static __init int io_wq_init(void)
{
	int ret;

	ret = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, "io-wq/online",
					io_wq_cpu_online, NULL);
	if (ret < 0)
		return ret;
	io_wq_online = ret;
	return 0;
}
subsys_initcall(io_wq_init);