io-wq.c 25.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
// 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/mmu_context.h>
#include <linux/sched/mm.h>
#include <linux/percpu.h>
#include <linux/slab.h>
#include <linux/kthread.h>
#include <linux/rculist_nulls.h>
19
#include <linux/uaccess.h>
20 21 22 23 24 25 26 27 28 29 30

#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 */
	IO_WORKER_F_EXITING	= 8,	/* worker exiting */
	IO_WORKER_F_FIXED	= 16,	/* static idle worker */
31
	IO_WORKER_F_BOUND	= 32,	/* 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
	const struct cred *creds;
61
	struct files_struct *restore_files;
62 63 64 65 66 67 68 69
};

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

70 71 72 73 74 75 76 77 78 79 80
struct io_wqe_acct {
	unsigned nr_workers;
	unsigned max_workers;
	atomic_t nr_running;
};

enum {
	IO_WQ_ACCT_BOUND,
	IO_WQ_ACCT_UNBOUND,
};

81 82 83 84 85 86
/*
 * Per-node worker thread pool
 */
struct io_wqe {
	struct {
		spinlock_t lock;
J
Jens Axboe 已提交
87
		struct io_wq_work_list work_list;
88 89 90 91 92
		unsigned long hash_map;
		unsigned flags;
	} ____cacheline_aligned_in_smp;

	int node;
93
	struct io_wqe_acct acct[2];
94

95
	struct hlist_nulls_head free_list;
96
	struct list_head all_list;
97 98 99 100 101 102 103 104 105 106 107

	struct io_wq *wq;
};

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

108 109 110
	get_work_fn *get_work;
	put_work_fn *put_work;

111
	struct task_struct *manager;
112
	struct user_struct *user;
113
	const struct cred *creds;
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
	struct mm_struct *mm;
	refcount_t refs;
	struct completion done;
};

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)
{
137 138
	bool dropped_lock = false;

139 140 141 142 143
	if (worker->creds) {
		revert_creds(worker->creds);
		worker->creds = NULL;
	}

144 145 146 147 148 149 150 151 152 153
	if (current->files != worker->restore_files) {
		__acquire(&wqe->lock);
		spin_unlock_irq(&wqe->lock);
		dropped_lock = true;

		task_lock(current);
		current->files = worker->restore_files;
		task_unlock(current);
	}

154 155 156 157 158
	/*
	 * 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) {
159 160 161 162 163
		if (!dropped_lock) {
			__acquire(&wqe->lock);
			spin_unlock_irq(&wqe->lock);
			dropped_lock = true;
		}
164 165 166 167 168 169 170
		__set_current_state(TASK_RUNNING);
		set_fs(KERNEL_DS);
		unuse_mm(worker->mm);
		mmput(worker->mm);
		worker->mm = NULL;
	}

171
	return dropped_lock;
172 173
}

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
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];
}

192 193 194
static void io_worker_exit(struct io_worker *worker)
{
	struct io_wqe *wqe = worker->wqe;
195 196
	struct io_wqe_acct *acct = io_wqe_get_acct(wqe, worker);
	unsigned nr_workers;
197 198 199 200 201 202 203 204 205 206 207 208 209

	/*
	 * 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)
210 211 212
		atomic_dec(&acct->nr_running);
	if (!(worker->flags & IO_WORKER_F_BOUND))
		atomic_dec(&wqe->wq->user->processes);
213 214 215 216 217
	worker->flags = 0;
	preempt_enable();

	spin_lock_irq(&wqe->lock);
	hlist_nulls_del_rcu(&worker->nulls_node);
218
	list_del_rcu(&worker->all_list);
219 220 221 222
	if (__io_worker_unuse(wqe, worker)) {
		__release(&wqe->lock);
		spin_lock_irq(&wqe->lock);
	}
223 224 225
	acct->nr_workers--;
	nr_workers = wqe->acct[IO_WQ_ACCT_BOUND].nr_workers +
			wqe->acct[IO_WQ_ACCT_UNBOUND].nr_workers;
226 227 228
	spin_unlock_irq(&wqe->lock);

	/* all workers gone, wq exit can proceed */
229
	if (!nr_workers && refcount_dec_and_test(&wqe->wq->refs))
230 231
		complete(&wqe->wq->done);

232
	kfree_rcu(worker, rcu);
233 234
}

235 236 237
static inline bool io_wqe_run_queue(struct io_wqe *wqe)
	__must_hold(wqe->lock)
{
J
Jens Axboe 已提交
238 239
	if (!wq_list_empty(&wqe->work_list) &&
	    !(wqe->flags & IO_WQE_FLAG_STALLED))
240 241 242 243 244 245 246 247 248 249 250 251 252 253
		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;

254
	n = rcu_dereference(hlist_nulls_first_rcu(&wqe->free_list));
255 256 257 258 259
	if (is_a_nulls(n))
		return false;

	worker = hlist_nulls_entry(n, struct io_worker, nulls_node);
	if (io_worker_get(worker)) {
260
		wake_up_process(worker->task);
261 262 263 264 265 266 267 268 269 270 271 272 273 274 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
		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);
}

306 307 308 309 310 311 312
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);
313
	worker->restore_files = current->files;
314
	io_wqe_inc_running(wqe, worker);
315 316 317 318 319 320 321 322 323 324
}

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

327 328 329 330
	if (worker->flags & IO_WORKER_F_FREE) {
		worker->flags &= ~IO_WORKER_F_FREE;
		hlist_nulls_del_init_rcu(&worker->nulls_node);
	}
331 332 333 334 335

	/*
	 * If worker is moving from bound to unbound (or vice versa), then
	 * ensure we update the running accounting.
	 */
336 337 338
	worker_bound = (worker->flags & IO_WORKER_F_BOUND) != 0;
	work_bound = (work->flags & IO_WQ_WORK_UNBOUND) == 0;
	if (worker_bound != work_bound) {
339 340 341 342 343 344 345 346 347 348 349 350 351 352
		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);
	 }
353 354 355 356 357 358 359 360 361 362 363 364 365 366
}

/*
 * 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;
367
		hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
368 369 370 371 372 373 374 375
	}

	return __io_worker_unuse(wqe, worker);
}

static struct io_wq_work *io_get_next_work(struct io_wqe *wqe, unsigned *hash)
	__must_hold(wqe->lock)
{
J
Jens Axboe 已提交
376
	struct io_wq_work_node *node, *prev;
377 378
	struct io_wq_work *work;

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

382 383
		/* not hashed, can run anytime */
		if (!(work->flags & IO_WQ_WORK_HASHED)) {
J
Jens Axboe 已提交
384
			wq_node_del(&wqe->work_list, node, prev);
385 386 387 388 389 390 391
			return work;
		}

		/* hashed, can run if not already running */
		*hash = work->flags >> IO_WQ_HASH_SHIFT;
		if (!(wqe->hash_map & BIT_ULL(*hash))) {
			wqe->hash_map |= BIT_ULL(*hash);
J
Jens Axboe 已提交
392
			wq_node_del(&wqe->work_list, node, prev);
393 394 395 396 397 398 399 400 401 402
			return work;
		}
	}

	return NULL;
}

static void io_worker_handle_work(struct io_worker *worker)
	__releases(wqe->lock)
{
403
	struct io_wq_work *work, *old_work = NULL, *put_work = NULL;
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
	struct io_wqe *wqe = worker->wqe;
	struct io_wq *wq = wqe->wq;

	do {
		unsigned hash = -1U;

		/*
		 * 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.
		 */
		work = io_get_next_work(wqe, &hash);
		if (work)
			__io_worker_busy(wqe, worker, work);
J
Jens Axboe 已提交
420
		else if (!wq_list_empty(&wqe->work_list))
421 422 423
			wqe->flags |= IO_WQE_FLAG_STALLED;

		spin_unlock_irq(&wqe->lock);
424 425
		if (put_work && wq->put_work)
			wq->put_work(old_work);
426 427 428
		if (!work)
			break;
next:
429 430 431 432 433 434 435 436
		/* flush any pending signals before assigning new work */
		if (signal_pending(current))
			flush_signals(current);

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

437 438 439
		if (work->flags & IO_WQ_WORK_CB)
			work->func(&work);

440 441 442 443 444 445
		if ((work->flags & IO_WQ_WORK_NEEDS_FILES) &&
		    current->files != work->files) {
			task_lock(current);
			current->files = work->files;
			task_unlock(current);
		}
446 447 448 449 450 451
		if ((work->flags & IO_WQ_WORK_NEEDS_USER) && !worker->mm &&
		    wq->mm && mmget_not_zero(wq->mm)) {
			use_mm(wq->mm);
			set_fs(USER_DS);
			worker->mm = wq->mm;
		}
452 453
		if (!worker->creds)
			worker->creds = override_creds(wq->creds);
454 455 456 457 458
		if (test_bit(IO_WQ_BIT_CANCEL, &wq->state))
			work->flags |= IO_WQ_WORK_CANCEL;
		if (worker->mm)
			work->flags |= IO_WQ_WORK_HAS_MM;

459 460 461 462 463
		if (wq->get_work && !(work->flags & IO_WQ_WORK_INTERNAL)) {
			put_work = work;
			wq->get_work(work);
		}

464 465 466
		old_work = work;
		work->func(&work);

467
		spin_lock_irq(&worker->lock);
468
		worker->cur_work = NULL;
469 470 471 472
		spin_unlock_irq(&worker->lock);

		spin_lock_irq(&wqe->lock);

473 474 475 476 477 478
		if (hash != -1U) {
			wqe->hash_map &= ~BIT_ULL(hash);
			wqe->flags &= ~IO_WQE_FLAG_STALLED;
		}
		if (work && work != old_work) {
			spin_unlock_irq(&wqe->lock);
479 480 481 482 483 484

			if (put_work && wq->put_work) {
				wq->put_work(put_work);
				put_work = NULL;
			}

485 486 487 488 489 490 491
			/* dependent work not hashed */
			hash = -1U;
			goto next;
		}
	} while (1);
}

492 493 494 495 496 497 498 499 500 501 502 503 504
static inline void io_worker_spin_for_work(struct io_wqe *wqe)
{
	int i = 0;

	while (++i < 1000) {
		if (io_wqe_run_queue(wqe))
			break;
		if (need_resched())
			break;
		cpu_relax();
	}
}

505 506 507 508 509
static int io_wqe_worker(void *data)
{
	struct io_worker *worker = data;
	struct io_wqe *wqe = worker->wqe;
	struct io_wq *wq = wqe->wq;
510
	bool did_work;
511 512 513

	io_worker_start(wqe, worker);

514
	did_work = false;
515
	while (!test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
516
		set_current_state(TASK_INTERRUPTIBLE);
517 518 519
loop:
		if (did_work)
			io_worker_spin_for_work(wqe);
520 521 522 523
		spin_lock_irq(&wqe->lock);
		if (io_wqe_run_queue(wqe)) {
			__set_current_state(TASK_RUNNING);
			io_worker_handle_work(worker);
524 525
			did_work = true;
			goto loop;
526
		}
527
		did_work = false;
528 529 530
		/* drops the lock on success, retry */
		if (__io_worker_idle(wqe, worker)) {
			__release(&wqe->lock);
531
			goto loop;
532 533 534 535 536 537 538 539 540 541 542 543 544 545
		}
		spin_unlock_irq(&wqe->lock);
		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)) {
		spin_lock_irq(&wqe->lock);
J
Jens Axboe 已提交
546
		if (!wq_list_empty(&wqe->work_list))
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
			io_worker_handle_work(worker);
		else
			spin_unlock_irq(&wqe->lock);
	}

	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;
569
	io_wqe_inc_running(wqe, worker);
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
}

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

	spin_lock_irq(&wqe->lock);
590
	io_wqe_dec_running(wqe, worker);
591 592 593
	spin_unlock_irq(&wqe->lock);
}

594
static bool create_io_worker(struct io_wq *wq, struct io_wqe *wqe, int index)
595
{
596
	struct io_wqe_acct *acct =&wqe->acct[index];
597 598
	struct io_worker *worker;

599
	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, wqe->node);
600
	if (!worker)
601
		return false;
602 603 604 605

	refcount_set(&worker->ref, 1);
	worker->nulls_node.pprev = NULL;
	worker->wqe = wqe;
606
	spin_lock_init(&worker->lock);
607 608

	worker->task = kthread_create_on_node(io_wqe_worker, worker, wqe->node,
609
				"io_wqe_worker-%d/%d", index, wqe->node);
610 611
	if (IS_ERR(worker->task)) {
		kfree(worker);
612
		return false;
613 614 615
	}

	spin_lock_irq(&wqe->lock);
616
	hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
617
	list_add_tail_rcu(&worker->all_list, &wqe->all_list);
618
	worker->flags |= IO_WORKER_F_FREE;
619 620 621
	if (index == IO_WQ_ACCT_BOUND)
		worker->flags |= IO_WORKER_F_BOUND;
	if (!acct->nr_workers && (worker->flags & IO_WORKER_F_BOUND))
622
		worker->flags |= IO_WORKER_F_FIXED;
623
	acct->nr_workers++;
624 625
	spin_unlock_irq(&wqe->lock);

626 627 628
	if (index == IO_WQ_ACCT_UNBOUND)
		atomic_inc(&wq->user->processes);

629
	wake_up_process(worker->task);
630
	return true;
631 632
}

633
static inline bool io_wqe_need_worker(struct io_wqe *wqe, int index)
634 635
	__must_hold(wqe->lock)
{
636
	struct io_wqe_acct *acct = &wqe->acct[index];
637

638
	/* if we have available workers or no work, no need */
639
	if (!hlist_nulls_empty(&wqe->free_list) || !io_wqe_run_queue(wqe))
640 641
		return false;
	return acct->nr_workers < acct->max_workers;
642 643 644 645 646 647 648 649
}

/*
 * 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 已提交
650 651
	int workers_to_create = num_possible_nodes();
	int node;
652

653
	/* create fixed workers */
J
Jann Horn 已提交
654 655 656 657 658
	refcount_set(&wq->refs, workers_to_create);
	for_each_node(node) {
		if (!create_io_worker(wq, wq->wqes[node], IO_WQ_ACCT_BOUND))
			goto err;
		workers_to_create--;
659
	}
660

661 662 663
	complete(&wq->done);

	while (!kthread_should_stop()) {
J
Jann Horn 已提交
664 665
		for_each_node(node) {
			struct io_wqe *wqe = wq->wqes[node];
666
			bool fork_worker[2] = { false, false };
667 668

			spin_lock_irq(&wqe->lock);
669 670 671 672
			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;
673
			spin_unlock_irq(&wqe->lock);
674 675 676 677
			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);
678 679 680 681 682 683
		}
		set_current_state(TASK_INTERRUPTIBLE);
		schedule_timeout(HZ);
	}

	return 0;
684 685 686
err:
	set_bit(IO_WQ_BIT_ERROR, &wq->state);
	set_bit(IO_WQ_BIT_EXIT, &wq->state);
J
Jann Horn 已提交
687
	if (refcount_sub_and_test(workers_to_create, &wq->refs))
688 689
		complete(&wq->done);
	return 0;
690 691
}

692 693 694 695 696 697 698 699 700 701 702
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();
703
	free_worker = !hlist_nulls_empty(&wqe->free_list);
704 705 706 707 708 709 710 711 712 713 714
	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;
}

715 716
static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work)
{
717
	struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
718 719
	unsigned long flags;

720 721 722 723 724 725 726 727 728 729 730 731
	/*
	 * 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))) {
		work->flags |= IO_WQ_WORK_CANCEL;
		work->func(&work);
		return;
	}

732
	spin_lock_irqsave(&wqe->lock, flags);
J
Jens Axboe 已提交
733
	wq_list_add_tail(&work->list, &wqe->work_list);
734 735 736
	wqe->flags &= ~IO_WQE_FLAG_STALLED;
	spin_unlock_irqrestore(&wqe->lock, flags);

737 738
	if (!atomic_read(&acct->nr_running))
		io_wqe_wake_worker(wqe, acct);
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
}

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

/*
 * Enqueue work, hashed by some key. Work items that hash to the same value
 * will not be done in parallel. Used to limit concurrent writes, generally
 * hashed by inode.
 */
void io_wq_enqueue_hashed(struct io_wq *wq, struct io_wq_work *work, void *val)
{
	struct io_wqe *wqe = wq->wqes[numa_node_id()];
	unsigned bit;


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

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;

781
	list_for_each_entry_rcu(worker, &wqe->all_list, all_list) {
782 783 784 785 786 787 788
		if (io_worker_get(worker)) {
			ret = func(worker, data);
			io_worker_release(worker);
			if (ret)
				break;
		}
	}
789

790 791 792 793 794
	return ret;
}

void io_wq_cancel_all(struct io_wq *wq)
{
J
Jann Horn 已提交
795
	int node;
796 797 798 799

	set_bit(IO_WQ_BIT_CANCEL, &wq->state);

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

803
		io_wq_for_each_worker(wqe, io_wqe_worker_send_sig, NULL);
804 805 806 807
	}
	rcu_read_unlock();
}

808 809 810 811 812 813 814 815 816
struct io_cb_cancel_data {
	struct io_wqe *wqe;
	work_cancel_fn *cancel;
	void *caller_data;
};

static bool io_work_cancel(struct io_worker *worker, void *cancel_data)
{
	struct io_cb_cancel_data *data = cancel_data;
817
	unsigned long flags;
818 819 820 821
	bool ret = false;

	/*
	 * Hold the lock to avoid ->cur_work going out of scope, caller
822
	 * may dereference the passed in work.
823
	 */
824
	spin_lock_irqsave(&worker->lock, flags);
825 826 827 828 829
	if (worker->cur_work &&
	    data->cancel(worker->cur_work, data->caller_data)) {
		send_sig(SIGINT, worker->task, 1);
		ret = true;
	}
830
	spin_unlock_irqrestore(&worker->lock, flags);
831 832 833 834 835 836 837 838 839 840 841 842 843

	return ret;
}

static enum io_wq_cancel io_wqe_cancel_cb_work(struct io_wqe *wqe,
					       work_cancel_fn *cancel,
					       void *cancel_data)
{
	struct io_cb_cancel_data data = {
		.wqe = wqe,
		.cancel = cancel,
		.caller_data = cancel_data,
	};
J
Jens Axboe 已提交
844
	struct io_wq_work_node *node, *prev;
845
	struct io_wq_work *work;
846
	unsigned long flags;
847 848
	bool found = false;

849
	spin_lock_irqsave(&wqe->lock, flags);
J
Jens Axboe 已提交
850 851 852
	wq_list_for_each(node, prev, &wqe->work_list) {
		work = container_of(node, struct io_wq_work, list);

853
		if (cancel(work, cancel_data)) {
J
Jens Axboe 已提交
854
			wq_node_del(&wqe->work_list, node, prev);
855 856 857 858
			found = true;
			break;
		}
	}
859
	spin_unlock_irqrestore(&wqe->lock, flags);
860 861 862 863 864 865 866 867

	if (found) {
		work->flags |= IO_WQ_WORK_CANCEL;
		work->func(&work);
		return IO_WQ_CANCEL_OK;
	}

	rcu_read_lock();
868
	found = io_wq_for_each_worker(wqe, io_work_cancel, &data);
869 870 871 872 873 874 875 876
	rcu_read_unlock();
	return found ? IO_WQ_CANCEL_RUNNING : IO_WQ_CANCEL_NOTFOUND;
}

enum io_wq_cancel io_wq_cancel_cb(struct io_wq *wq, work_cancel_fn *cancel,
				  void *data)
{
	enum io_wq_cancel ret = IO_WQ_CANCEL_NOTFOUND;
J
Jann Horn 已提交
877
	int node;
878

J
Jann Horn 已提交
879 880
	for_each_node(node) {
		struct io_wqe *wqe = wq->wqes[node];
881 882 883 884 885 886 887 888 889

		ret = io_wqe_cancel_cb_work(wqe, cancel, data);
		if (ret != IO_WQ_CANCEL_NOTFOUND)
			break;
	}

	return ret;
}

890 891 892
static bool io_wq_worker_cancel(struct io_worker *worker, void *data)
{
	struct io_wq_work *work = data;
893 894
	unsigned long flags;
	bool ret = false;
895

896 897 898 899
	if (worker->cur_work != work)
		return false;

	spin_lock_irqsave(&worker->lock, flags);
900 901
	if (worker->cur_work == work) {
		send_sig(SIGINT, worker->task, 1);
902
		ret = true;
903
	}
904
	spin_unlock_irqrestore(&worker->lock, flags);
905

906
	return ret;
907 908 909 910 911
}

static enum io_wq_cancel io_wqe_cancel_work(struct io_wqe *wqe,
					    struct io_wq_work *cwork)
{
J
Jens Axboe 已提交
912
	struct io_wq_work_node *node, *prev;
913
	struct io_wq_work *work;
914
	unsigned long flags;
915 916 917 918 919 920 921 922 923
	bool found = false;

	cwork->flags |= IO_WQ_WORK_CANCEL;

	/*
	 * 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.
	 */
924
	spin_lock_irqsave(&wqe->lock, flags);
J
Jens Axboe 已提交
925 926 927
	wq_list_for_each(node, prev, &wqe->work_list) {
		work = container_of(node, struct io_wq_work, list);

928
		if (work == cwork) {
J
Jens Axboe 已提交
929
			wq_node_del(&wqe->work_list, node, prev);
930 931 932 933
			found = true;
			break;
		}
	}
934
	spin_unlock_irqrestore(&wqe->lock, flags);
935 936 937 938 939 940 941 942 943 944

	if (found) {
		work->flags |= IO_WQ_WORK_CANCEL;
		work->func(&work);
		return IO_WQ_CANCEL_OK;
	}

	/*
	 * 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
945
	 * as an indication that we attempt to signal cancellation. The
946 947 948
	 * completion will run normally in this case.
	 */
	rcu_read_lock();
949
	found = io_wq_for_each_worker(wqe, io_wq_worker_cancel, cwork);
950 951 952 953 954 955 956
	rcu_read_unlock();
	return found ? IO_WQ_CANCEL_RUNNING : IO_WQ_CANCEL_NOTFOUND;
}

enum io_wq_cancel io_wq_cancel_work(struct io_wq *wq, struct io_wq_work *cwork)
{
	enum io_wq_cancel ret = IO_WQ_CANCEL_NOTFOUND;
J
Jann Horn 已提交
957
	int node;
958

J
Jann Horn 已提交
959 960
	for_each_node(node) {
		struct io_wqe *wqe = wq->wqes[node];
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990

		ret = io_wqe_cancel_work(wqe, cwork);
		if (ret != IO_WQ_CANCEL_NOTFOUND)
			break;
	}

	return ret;
}

struct io_wq_flush_data {
	struct io_wq_work work;
	struct completion done;
};

static void io_wq_flush_func(struct io_wq_work **workptr)
{
	struct io_wq_work *work = *workptr;
	struct io_wq_flush_data *data;

	data = container_of(work, struct io_wq_flush_data, work);
	complete(&data->done);
}

/*
 * Doesn't wait for previously queued work to finish. When this completes,
 * it just means that previously queued work was started.
 */
void io_wq_flush(struct io_wq *wq)
{
	struct io_wq_flush_data data;
J
Jann Horn 已提交
991
	int node;
992

J
Jann Horn 已提交
993 994
	for_each_node(node) {
		struct io_wqe *wqe = wq->wqes[node];
995 996 997

		init_completion(&data.done);
		INIT_IO_WORK(&data.work, io_wq_flush_func);
998
		data.work.flags |= IO_WQ_WORK_INTERNAL;
999 1000 1001 1002 1003
		io_wqe_enqueue(wqe, &data.work);
		wait_for_completion(&data.done);
	}
}

1004
struct io_wq *io_wq_create(unsigned bounded, struct io_wq_data *data)
1005
{
J
Jann Horn 已提交
1006
	int ret = -ENOMEM, node;
1007 1008
	struct io_wq *wq;

1009
	wq = kzalloc(sizeof(*wq), GFP_KERNEL);
1010 1011 1012
	if (!wq)
		return ERR_PTR(-ENOMEM);

J
Jann Horn 已提交
1013
	wq->wqes = kcalloc(nr_node_ids, sizeof(struct io_wqe *), GFP_KERNEL);
1014 1015 1016 1017 1018
	if (!wq->wqes) {
		kfree(wq);
		return ERR_PTR(-ENOMEM);
	}

1019 1020
	wq->get_work = data->get_work;
	wq->put_work = data->put_work;
1021

1022
	/* caller must already hold a reference to this */
1023
	wq->user = data->user;
1024
	wq->creds = data->creds;
1025

J
Jann Horn 已提交
1026
	for_each_node(node) {
1027 1028
		struct io_wqe *wqe;

1029
		wqe = kzalloc_node(sizeof(struct io_wqe), GFP_KERNEL, node);
1030
		if (!wqe)
J
Jann Horn 已提交
1031 1032
			goto err;
		wq->wqes[node] = wqe;
1033
		wqe->node = node;
1034 1035
		wqe->acct[IO_WQ_ACCT_BOUND].max_workers = bounded;
		atomic_set(&wqe->acct[IO_WQ_ACCT_BOUND].nr_running, 0);
1036
		if (wq->user) {
1037 1038 1039 1040
			wqe->acct[IO_WQ_ACCT_UNBOUND].max_workers =
					task_rlimit(current, RLIMIT_NPROC);
		}
		atomic_set(&wqe->acct[IO_WQ_ACCT_UNBOUND].nr_running, 0);
1041 1042 1043
		wqe->node = node;
		wqe->wq = wq;
		spin_lock_init(&wqe->lock);
J
Jens Axboe 已提交
1044
		INIT_WQ_LIST(&wqe->work_list);
1045
		INIT_HLIST_NULLS_HEAD(&wqe->free_list, 0);
1046
		INIT_LIST_HEAD(&wqe->all_list);
1047 1048 1049 1050 1051
	}

	init_completion(&wq->done);

	/* caller must have already done mmgrab() on this mm */
1052
	wq->mm = data->mm;
1053 1054 1055 1056

	wq->manager = kthread_create(io_wq_manager, wq, "io_wq_manager");
	if (!IS_ERR(wq->manager)) {
		wake_up_process(wq->manager);
1057 1058 1059 1060 1061 1062
		wait_for_completion(&wq->done);
		if (test_bit(IO_WQ_BIT_ERROR, &wq->state)) {
			ret = -ENOMEM;
			goto err;
		}
		reinit_completion(&wq->done);
1063 1064 1065 1066 1067
		return wq;
	}

	ret = PTR_ERR(wq->manager);
	complete(&wq->done);
1068
err:
J
Jann Horn 已提交
1069 1070
	for_each_node(node)
		kfree(wq->wqes[node]);
1071 1072
	kfree(wq->wqes);
	kfree(wq);
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
	return ERR_PTR(ret);
}

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

void io_wq_destroy(struct io_wq *wq)
{
J
Jann Horn 已提交
1084
	int node;
1085

1086 1087
	set_bit(IO_WQ_BIT_EXIT, &wq->state);
	if (wq->manager)
1088 1089 1090
		kthread_stop(wq->manager);

	rcu_read_lock();
J
Jann Horn 已提交
1091 1092
	for_each_node(node)
		io_wq_for_each_worker(wq->wqes[node], io_wq_worker_wake, NULL);
1093 1094 1095 1096
	rcu_read_unlock();

	wait_for_completion(&wq->done);

J
Jann Horn 已提交
1097 1098
	for_each_node(node)
		kfree(wq->wqes[node]);
1099 1100 1101
	kfree(wq->wqes);
	kfree(wq);
}