1 // SPDX-License-Identifier: GPL-2.0
3 * Basic worker thread pool for io_uring
5 * Copyright (C) 2019 Jens Axboe
8 #include <linux/kernel.h>
9 #include <linux/init.h>
10 #include <linux/errno.h>
11 #include <linux/sched/signal.h>
13 #include <linux/sched/mm.h>
14 #include <linux/percpu.h>
15 #include <linux/slab.h>
16 #include <linux/kthread.h>
17 #include <linux/rculist_nulls.h>
18 #include <linux/fs_struct.h>
19 #include <linux/task_work.h>
20 #include <linux/blk-cgroup.h>
24 #define WORKER_IDLE_TIMEOUT (5 * HZ)
27 IO_WORKER_F_UP = 1, /* up and active */
28 IO_WORKER_F_RUNNING = 2, /* account as running */
29 IO_WORKER_F_FREE = 4, /* worker on free list */
30 IO_WORKER_F_FIXED = 8, /* static idle worker */
31 IO_WORKER_F_BOUND = 16, /* is doing bounded work */
35 IO_WQ_BIT_EXIT = 0, /* wq exiting */
36 IO_WQ_BIT_CANCEL = 1, /* cancel work on list */
37 IO_WQ_BIT_ERROR = 2, /* error on setup */
41 IO_WQE_FLAG_STALLED = 1, /* stalled on hash */
45 * One for each thread in a wqe pool
50 struct hlist_nulls_node nulls_node;
51 struct list_head all_list;
52 struct task_struct *task;
55 struct io_wq_work *cur_work;
60 #ifdef CONFIG_BLK_CGROUP
61 struct cgroup_subsys_state *blkcg_css;
63 const struct cred *cur_creds;
64 const struct cred *saved_creds;
65 struct files_struct *restore_files;
66 struct nsproxy *restore_nsproxy;
67 struct fs_struct *restore_fs;
70 #if BITS_PER_LONG == 64
71 #define IO_WQ_HASH_ORDER 6
73 #define IO_WQ_HASH_ORDER 5
76 #define IO_WQ_NR_HASH_BUCKETS (1u << IO_WQ_HASH_ORDER)
90 * Per-node worker thread pool
95 struct io_wq_work_list work_list;
96 unsigned long hash_map;
98 } ____cacheline_aligned_in_smp;
101 struct io_wqe_acct acct[2];
103 struct hlist_nulls_head free_list;
104 struct list_head all_list;
107 struct io_wq_work *hash_tail[IO_WQ_NR_HASH_BUCKETS];
114 struct io_wqe **wqes;
117 free_work_fn *free_work;
118 io_wq_work_fn *do_work;
120 struct task_struct *manager;
121 struct user_struct *user;
123 struct completion done;
128 static bool io_worker_get(struct io_worker *worker)
130 return refcount_inc_not_zero(&worker->ref);
133 static void io_worker_release(struct io_worker *worker)
135 if (refcount_dec_and_test(&worker->ref))
136 wake_up_process(worker->task);
140 * Note: drops the wqe->lock if returning true! The caller must re-acquire
141 * the lock in that case. Some callers need to restart handling if this
142 * happens, so we can't just re-acquire the lock on behalf of the caller.
144 static bool __io_worker_unuse(struct io_wqe *wqe, struct io_worker *worker)
146 bool dropped_lock = false;
148 if (worker->saved_creds) {
149 revert_creds(worker->saved_creds);
150 worker->cur_creds = worker->saved_creds = NULL;
153 if (current->files != worker->restore_files) {
154 __acquire(&wqe->lock);
155 raw_spin_unlock_irq(&wqe->lock);
159 current->files = worker->restore_files;
160 current->nsproxy = worker->restore_nsproxy;
161 task_unlock(current);
164 if (current->fs != worker->restore_fs)
165 current->fs = worker->restore_fs;
168 * If we have an active mm, we need to drop the wq lock before unusing
169 * it. If we do, return true and let the caller retry the idle loop.
173 __acquire(&wqe->lock);
174 raw_spin_unlock_irq(&wqe->lock);
177 __set_current_state(TASK_RUNNING);
178 kthread_unuse_mm(worker->mm);
183 #ifdef CONFIG_BLK_CGROUP
184 if (worker->blkcg_css) {
185 kthread_associate_blkcg(NULL);
186 worker->blkcg_css = NULL;
193 static inline struct io_wqe_acct *io_work_get_acct(struct io_wqe *wqe,
194 struct io_wq_work *work)
196 if (work->flags & IO_WQ_WORK_UNBOUND)
197 return &wqe->acct[IO_WQ_ACCT_UNBOUND];
199 return &wqe->acct[IO_WQ_ACCT_BOUND];
202 static inline struct io_wqe_acct *io_wqe_get_acct(struct io_wqe *wqe,
203 struct io_worker *worker)
205 if (worker->flags & IO_WORKER_F_BOUND)
206 return &wqe->acct[IO_WQ_ACCT_BOUND];
208 return &wqe->acct[IO_WQ_ACCT_UNBOUND];
211 static void io_worker_exit(struct io_worker *worker)
213 struct io_wqe *wqe = worker->wqe;
214 struct io_wqe_acct *acct = io_wqe_get_acct(wqe, worker);
217 * If we're not at zero, someone else is holding a brief reference
218 * to the worker. Wait for that to go away.
220 set_current_state(TASK_INTERRUPTIBLE);
221 if (!refcount_dec_and_test(&worker->ref))
223 __set_current_state(TASK_RUNNING);
226 current->flags &= ~PF_IO_WORKER;
227 if (worker->flags & IO_WORKER_F_RUNNING)
228 atomic_dec(&acct->nr_running);
229 if (!(worker->flags & IO_WORKER_F_BOUND))
230 atomic_dec(&wqe->wq->user->processes);
234 raw_spin_lock_irq(&wqe->lock);
235 hlist_nulls_del_rcu(&worker->nulls_node);
236 list_del_rcu(&worker->all_list);
237 if (__io_worker_unuse(wqe, worker)) {
238 __release(&wqe->lock);
239 raw_spin_lock_irq(&wqe->lock);
242 raw_spin_unlock_irq(&wqe->lock);
244 kfree_rcu(worker, rcu);
245 if (refcount_dec_and_test(&wqe->wq->refs))
246 complete(&wqe->wq->done);
249 static inline bool io_wqe_run_queue(struct io_wqe *wqe)
250 __must_hold(wqe->lock)
252 if (!wq_list_empty(&wqe->work_list) &&
253 !(wqe->flags & IO_WQE_FLAG_STALLED))
259 * Check head of free list for an available worker. If one isn't available,
260 * caller must wake up the wq manager to create one.
262 static bool io_wqe_activate_free_worker(struct io_wqe *wqe)
265 struct hlist_nulls_node *n;
266 struct io_worker *worker;
268 n = rcu_dereference(hlist_nulls_first_rcu(&wqe->free_list));
272 worker = hlist_nulls_entry(n, struct io_worker, nulls_node);
273 if (io_worker_get(worker)) {
274 wake_up_process(worker->task);
275 io_worker_release(worker);
283 * We need a worker. If we find a free one, we're good. If not, and we're
284 * below the max number of workers, wake up the manager to create one.
286 static void io_wqe_wake_worker(struct io_wqe *wqe, struct io_wqe_acct *acct)
291 * Most likely an attempt to queue unbounded work on an io_wq that
292 * wasn't setup with any unbounded workers.
294 WARN_ON_ONCE(!acct->max_workers);
297 ret = io_wqe_activate_free_worker(wqe);
300 if (!ret && acct->nr_workers < acct->max_workers)
301 wake_up_process(wqe->wq->manager);
304 static void io_wqe_inc_running(struct io_wqe *wqe, struct io_worker *worker)
306 struct io_wqe_acct *acct = io_wqe_get_acct(wqe, worker);
308 atomic_inc(&acct->nr_running);
311 static void io_wqe_dec_running(struct io_wqe *wqe, struct io_worker *worker)
312 __must_hold(wqe->lock)
314 struct io_wqe_acct *acct = io_wqe_get_acct(wqe, worker);
316 if (atomic_dec_and_test(&acct->nr_running) && io_wqe_run_queue(wqe))
317 io_wqe_wake_worker(wqe, acct);
320 static void io_worker_start(struct io_wqe *wqe, struct io_worker *worker)
322 allow_kernel_signal(SIGINT);
324 current->flags |= PF_IO_WORKER;
326 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);
334 * Worker will start processing some work. Move it to the busy list, if
335 * it's currently on the freelist
337 static void __io_worker_busy(struct io_wqe *wqe, struct io_worker *worker,
338 struct io_wq_work *work)
339 __must_hold(wqe->lock)
341 bool worker_bound, work_bound;
343 if (worker->flags & IO_WORKER_F_FREE) {
344 worker->flags &= ~IO_WORKER_F_FREE;
345 hlist_nulls_del_init_rcu(&worker->nulls_node);
349 * If worker is moving from bound to unbound (or vice versa), then
350 * ensure we update the running accounting.
352 worker_bound = (worker->flags & IO_WORKER_F_BOUND) != 0;
353 work_bound = (work->flags & IO_WQ_WORK_UNBOUND) == 0;
354 if (worker_bound != work_bound) {
355 io_wqe_dec_running(wqe, worker);
357 worker->flags |= IO_WORKER_F_BOUND;
358 wqe->acct[IO_WQ_ACCT_UNBOUND].nr_workers--;
359 wqe->acct[IO_WQ_ACCT_BOUND].nr_workers++;
360 atomic_dec(&wqe->wq->user->processes);
362 worker->flags &= ~IO_WORKER_F_BOUND;
363 wqe->acct[IO_WQ_ACCT_UNBOUND].nr_workers++;
364 wqe->acct[IO_WQ_ACCT_BOUND].nr_workers--;
365 atomic_inc(&wqe->wq->user->processes);
367 io_wqe_inc_running(wqe, worker);
372 * No work, worker going to sleep. Move to freelist, and unuse mm if we
373 * have one attached. Dropping the mm may potentially sleep, so we drop
374 * the lock in that case and return success. Since the caller has to
375 * retry the loop in that case (we changed task state), we don't regrab
376 * the lock if we return success.
378 static bool __io_worker_idle(struct io_wqe *wqe, struct io_worker *worker)
379 __must_hold(wqe->lock)
381 if (!(worker->flags & IO_WORKER_F_FREE)) {
382 worker->flags |= IO_WORKER_F_FREE;
383 hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
386 return __io_worker_unuse(wqe, worker);
389 static inline unsigned int io_get_work_hash(struct io_wq_work *work)
391 return work->flags >> IO_WQ_HASH_SHIFT;
394 static struct io_wq_work *io_get_next_work(struct io_wqe *wqe)
395 __must_hold(wqe->lock)
397 struct io_wq_work_node *node, *prev;
398 struct io_wq_work *work, *tail;
401 wq_list_for_each(node, prev, &wqe->work_list) {
402 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);
410 /* hashed, can run if not already running */
411 hash = io_get_work_hash(work);
412 if (!(wqe->hash_map & BIT(hash))) {
413 wqe->hash_map |= BIT(hash);
414 /* all items with this hash lie in [work, tail] */
415 tail = wqe->hash_tail[hash];
416 wqe->hash_tail[hash] = NULL;
417 wq_list_cut(&wqe->work_list, &tail->list, prev);
425 static void io_wq_switch_mm(struct io_worker *worker, struct io_wq_work *work)
428 kthread_unuse_mm(worker->mm);
435 if (mmget_not_zero(work->mm)) {
436 kthread_use_mm(work->mm);
437 worker->mm = work->mm;
438 /* hang on to this mm */
443 /* failed grabbing mm, ensure work gets cancelled */
444 work->flags |= IO_WQ_WORK_CANCEL;
447 static inline void io_wq_switch_blkcg(struct io_worker *worker,
448 struct io_wq_work *work)
450 #ifdef CONFIG_BLK_CGROUP
451 if (work->blkcg_css != worker->blkcg_css) {
452 kthread_associate_blkcg(work->blkcg_css);
453 worker->blkcg_css = work->blkcg_css;
458 static void io_wq_switch_creds(struct io_worker *worker,
459 struct io_wq_work *work)
461 const struct cred *old_creds = override_creds(work->creds);
463 worker->cur_creds = work->creds;
464 if (worker->saved_creds)
465 put_cred(old_creds); /* creds set by previous switch */
467 worker->saved_creds = old_creds;
470 static void io_impersonate_work(struct io_worker *worker,
471 struct io_wq_work *work)
473 if (work->files && current->files != work->files) {
475 current->files = work->files;
476 current->nsproxy = work->nsproxy;
477 task_unlock(current);
479 if (work->fs && current->fs != work->fs)
480 current->fs = work->fs;
481 if (work->mm != worker->mm)
482 io_wq_switch_mm(worker, work);
483 if (worker->cur_creds != work->creds)
484 io_wq_switch_creds(worker, work);
485 current->signal->rlim[RLIMIT_FSIZE].rlim_cur = work->fsize;
486 io_wq_switch_blkcg(worker, work);
489 static void io_assign_current_work(struct io_worker *worker,
490 struct io_wq_work *work)
493 /* flush pending signals before assigning new work */
494 if (signal_pending(current))
495 flush_signals(current);
499 spin_lock_irq(&worker->lock);
500 worker->cur_work = work;
501 spin_unlock_irq(&worker->lock);
504 static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work);
506 static void io_worker_handle_work(struct io_worker *worker)
507 __releases(wqe->lock)
509 struct io_wqe *wqe = worker->wqe;
510 struct io_wq *wq = wqe->wq;
513 struct io_wq_work *work;
516 * If we got some work, mark us as busy. If we didn't, but
517 * the list isn't empty, it means we stalled on hashed work.
518 * Mark us stalled so we don't keep looking for work when we
519 * can't make progress, any work completion or insertion will
520 * clear the stalled flag.
522 work = io_get_next_work(wqe);
524 __io_worker_busy(wqe, worker, work);
525 else if (!wq_list_empty(&wqe->work_list))
526 wqe->flags |= IO_WQE_FLAG_STALLED;
528 raw_spin_unlock_irq(&wqe->lock);
531 io_assign_current_work(worker, work);
533 /* handle a whole dependent link */
535 struct io_wq_work *old_work, *next_hashed, *linked;
536 unsigned int hash = io_get_work_hash(work);
538 next_hashed = wq_next_work(work);
539 io_impersonate_work(worker, work);
541 * OK to set IO_WQ_WORK_CANCEL even for uncancellable
542 * work, the worker function will do the right thing.
544 if (test_bit(IO_WQ_BIT_CANCEL, &wq->state))
545 work->flags |= IO_WQ_WORK_CANCEL;
548 linked = wq->do_work(work);
551 if (!work && linked && !io_wq_is_hashed(linked)) {
555 io_assign_current_work(worker, work);
556 wq->free_work(old_work);
559 io_wqe_enqueue(wqe, linked);
561 if (hash != -1U && !next_hashed) {
562 raw_spin_lock_irq(&wqe->lock);
563 wqe->hash_map &= ~BIT_ULL(hash);
564 wqe->flags &= ~IO_WQE_FLAG_STALLED;
565 /* skip unnecessary unlock-lock wqe->lock */
568 raw_spin_unlock_irq(&wqe->lock);
572 raw_spin_lock_irq(&wqe->lock);
576 static int io_wqe_worker(void *data)
578 struct io_worker *worker = data;
579 struct io_wqe *wqe = worker->wqe;
580 struct io_wq *wq = wqe->wq;
582 io_worker_start(wqe, worker);
584 while (!test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
585 set_current_state(TASK_INTERRUPTIBLE);
587 raw_spin_lock_irq(&wqe->lock);
588 if (io_wqe_run_queue(wqe)) {
589 __set_current_state(TASK_RUNNING);
590 io_worker_handle_work(worker);
593 /* drops the lock on success, retry */
594 if (__io_worker_idle(wqe, worker)) {
595 __release(&wqe->lock);
598 raw_spin_unlock_irq(&wqe->lock);
599 if (signal_pending(current))
600 flush_signals(current);
601 if (schedule_timeout(WORKER_IDLE_TIMEOUT))
603 /* timed out, exit unless we're the fixed worker */
604 if (test_bit(IO_WQ_BIT_EXIT, &wq->state) ||
605 !(worker->flags & IO_WORKER_F_FIXED))
609 if (test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
610 raw_spin_lock_irq(&wqe->lock);
611 if (!wq_list_empty(&wqe->work_list))
612 io_worker_handle_work(worker);
614 raw_spin_unlock_irq(&wqe->lock);
617 io_worker_exit(worker);
622 * Called when a worker is scheduled in. Mark us as currently running.
624 void io_wq_worker_running(struct task_struct *tsk)
626 struct io_worker *worker = kthread_data(tsk);
627 struct io_wqe *wqe = worker->wqe;
629 if (!(worker->flags & IO_WORKER_F_UP))
631 if (worker->flags & IO_WORKER_F_RUNNING)
633 worker->flags |= IO_WORKER_F_RUNNING;
634 io_wqe_inc_running(wqe, worker);
638 * Called when worker is going to sleep. If there are no workers currently
639 * running and we have work pending, wake up a free one or have the manager
642 void io_wq_worker_sleeping(struct task_struct *tsk)
644 struct io_worker *worker = kthread_data(tsk);
645 struct io_wqe *wqe = worker->wqe;
647 if (!(worker->flags & IO_WORKER_F_UP))
649 if (!(worker->flags & IO_WORKER_F_RUNNING))
652 worker->flags &= ~IO_WORKER_F_RUNNING;
654 raw_spin_lock_irq(&wqe->lock);
655 io_wqe_dec_running(wqe, worker);
656 raw_spin_unlock_irq(&wqe->lock);
659 static bool create_io_worker(struct io_wq *wq, struct io_wqe *wqe, int index)
661 struct io_wqe_acct *acct = &wqe->acct[index];
662 struct io_worker *worker;
664 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, wqe->node);
668 refcount_set(&worker->ref, 1);
669 worker->nulls_node.pprev = NULL;
671 spin_lock_init(&worker->lock);
673 worker->task = kthread_create_on_node(io_wqe_worker, worker, wqe->node,
674 "io_wqe_worker-%d/%d", index, wqe->node);
675 if (IS_ERR(worker->task)) {
680 raw_spin_lock_irq(&wqe->lock);
681 hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
682 list_add_tail_rcu(&worker->all_list, &wqe->all_list);
683 worker->flags |= IO_WORKER_F_FREE;
684 if (index == IO_WQ_ACCT_BOUND)
685 worker->flags |= IO_WORKER_F_BOUND;
686 if (!acct->nr_workers && (worker->flags & IO_WORKER_F_BOUND))
687 worker->flags |= IO_WORKER_F_FIXED;
689 raw_spin_unlock_irq(&wqe->lock);
691 if (index == IO_WQ_ACCT_UNBOUND)
692 atomic_inc(&wq->user->processes);
694 refcount_inc(&wq->refs);
695 wake_up_process(worker->task);
699 static inline bool io_wqe_need_worker(struct io_wqe *wqe, int index)
700 __must_hold(wqe->lock)
702 struct io_wqe_acct *acct = &wqe->acct[index];
704 /* if we have available workers or no work, no need */
705 if (!hlist_nulls_empty(&wqe->free_list) || !io_wqe_run_queue(wqe))
707 return acct->nr_workers < acct->max_workers;
710 static bool io_wqe_worker_send_sig(struct io_worker *worker, void *data)
712 send_sig(SIGINT, worker->task, 1);
717 * Iterate the passed in list and call the specific function for each
718 * worker that isn't exiting
720 static bool io_wq_for_each_worker(struct io_wqe *wqe,
721 bool (*func)(struct io_worker *, void *),
724 struct io_worker *worker;
727 list_for_each_entry_rcu(worker, &wqe->all_list, all_list) {
728 if (io_worker_get(worker)) {
729 /* no task if node is/was offline */
731 ret = func(worker, data);
732 io_worker_release(worker);
741 static bool io_wq_worker_wake(struct io_worker *worker, void *data)
743 wake_up_process(worker->task);
748 * Manager thread. Tasked with creating new workers, if we need them.
750 static int io_wq_manager(void *data)
752 struct io_wq *wq = data;
755 /* create fixed workers */
756 refcount_set(&wq->refs, 1);
757 for_each_node(node) {
758 if (!node_online(node))
760 if (create_io_worker(wq, wq->wqes[node], IO_WQ_ACCT_BOUND))
762 set_bit(IO_WQ_BIT_ERROR, &wq->state);
763 set_bit(IO_WQ_BIT_EXIT, &wq->state);
769 while (!kthread_should_stop()) {
770 if (current->task_works)
773 for_each_node(node) {
774 struct io_wqe *wqe = wq->wqes[node];
775 bool fork_worker[2] = { false, false };
777 if (!node_online(node))
780 raw_spin_lock_irq(&wqe->lock);
781 if (io_wqe_need_worker(wqe, IO_WQ_ACCT_BOUND))
782 fork_worker[IO_WQ_ACCT_BOUND] = true;
783 if (io_wqe_need_worker(wqe, IO_WQ_ACCT_UNBOUND))
784 fork_worker[IO_WQ_ACCT_UNBOUND] = true;
785 raw_spin_unlock_irq(&wqe->lock);
786 if (fork_worker[IO_WQ_ACCT_BOUND])
787 create_io_worker(wq, wqe, IO_WQ_ACCT_BOUND);
788 if (fork_worker[IO_WQ_ACCT_UNBOUND])
789 create_io_worker(wq, wqe, IO_WQ_ACCT_UNBOUND);
791 set_current_state(TASK_INTERRUPTIBLE);
792 schedule_timeout(HZ);
795 if (current->task_works)
799 if (refcount_dec_and_test(&wq->refs)) {
803 /* if ERROR is set and we get here, we have workers to wake */
804 if (test_bit(IO_WQ_BIT_ERROR, &wq->state)) {
807 io_wq_for_each_worker(wq->wqes[node], io_wq_worker_wake, NULL);
813 static bool io_wq_can_queue(struct io_wqe *wqe, struct io_wqe_acct *acct,
814 struct io_wq_work *work)
818 if (!(work->flags & IO_WQ_WORK_UNBOUND))
820 if (atomic_read(&acct->nr_running))
824 free_worker = !hlist_nulls_empty(&wqe->free_list);
829 if (atomic_read(&wqe->wq->user->processes) >= acct->max_workers &&
830 !(capable(CAP_SYS_RESOURCE) || capable(CAP_SYS_ADMIN)))
836 static void io_run_cancel(struct io_wq_work *work, struct io_wqe *wqe)
838 struct io_wq *wq = wqe->wq;
841 struct io_wq_work *old_work = work;
843 work->flags |= IO_WQ_WORK_CANCEL;
844 work = wq->do_work(work);
845 wq->free_work(old_work);
849 static void io_wqe_insert_work(struct io_wqe *wqe, struct io_wq_work *work)
852 struct io_wq_work *tail;
854 if (!io_wq_is_hashed(work)) {
856 wq_list_add_tail(&work->list, &wqe->work_list);
860 hash = io_get_work_hash(work);
861 tail = wqe->hash_tail[hash];
862 wqe->hash_tail[hash] = work;
866 wq_list_add_after(&work->list, &tail->list, &wqe->work_list);
869 static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work)
871 struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
876 * Do early check to see if we need a new unbound worker, and if we do,
877 * if we're allowed to do so. This isn't 100% accurate as there's a
878 * gap between this check and incrementing the value, but that's OK.
879 * It's close enough to not be an issue, fork() has the same delay.
881 if (unlikely(!io_wq_can_queue(wqe, acct, work))) {
882 io_run_cancel(work, wqe);
886 work_flags = work->flags;
887 raw_spin_lock_irqsave(&wqe->lock, flags);
888 io_wqe_insert_work(wqe, work);
889 wqe->flags &= ~IO_WQE_FLAG_STALLED;
890 raw_spin_unlock_irqrestore(&wqe->lock, flags);
892 if ((work_flags & IO_WQ_WORK_CONCURRENT) ||
893 !atomic_read(&acct->nr_running))
894 io_wqe_wake_worker(wqe, acct);
897 void io_wq_enqueue(struct io_wq *wq, struct io_wq_work *work)
899 struct io_wqe *wqe = wq->wqes[numa_node_id()];
901 io_wqe_enqueue(wqe, work);
905 * Work items that hash to the same value will not be done in parallel.
906 * Used to limit concurrent writes, generally hashed by inode.
908 void io_wq_hash_work(struct io_wq_work *work, void *val)
912 bit = hash_ptr(val, IO_WQ_HASH_ORDER);
913 work->flags |= (IO_WQ_WORK_HASHED | (bit << IO_WQ_HASH_SHIFT));
916 void io_wq_cancel_all(struct io_wq *wq)
920 set_bit(IO_WQ_BIT_CANCEL, &wq->state);
923 for_each_node(node) {
924 struct io_wqe *wqe = wq->wqes[node];
926 io_wq_for_each_worker(wqe, io_wqe_worker_send_sig, NULL);
931 struct io_cb_cancel_data {
939 static bool io_wq_worker_cancel(struct io_worker *worker, void *data)
941 struct io_cb_cancel_data *match = data;
945 * Hold the lock to avoid ->cur_work going out of scope, caller
946 * may dereference the passed in work.
948 spin_lock_irqsave(&worker->lock, flags);
949 if (worker->cur_work &&
950 !(worker->cur_work->flags & IO_WQ_WORK_NO_CANCEL) &&
951 match->fn(worker->cur_work, match->data)) {
952 send_sig(SIGINT, worker->task, 1);
955 spin_unlock_irqrestore(&worker->lock, flags);
957 return match->nr_running && !match->cancel_all;
960 static inline void io_wqe_remove_pending(struct io_wqe *wqe,
961 struct io_wq_work *work,
962 struct io_wq_work_node *prev)
964 unsigned int hash = io_get_work_hash(work);
965 struct io_wq_work *prev_work = NULL;
967 if (io_wq_is_hashed(work) && work == wqe->hash_tail[hash]) {
969 prev_work = container_of(prev, struct io_wq_work, list);
970 if (prev_work && io_get_work_hash(prev_work) == hash)
971 wqe->hash_tail[hash] = prev_work;
973 wqe->hash_tail[hash] = NULL;
975 wq_list_del(&wqe->work_list, &work->list, prev);
978 static void io_wqe_cancel_pending_work(struct io_wqe *wqe,
979 struct io_cb_cancel_data *match)
981 struct io_wq_work_node *node, *prev;
982 struct io_wq_work *work;
986 raw_spin_lock_irqsave(&wqe->lock, flags);
987 wq_list_for_each(node, prev, &wqe->work_list) {
988 work = container_of(node, struct io_wq_work, list);
989 if (!match->fn(work, match->data))
991 io_wqe_remove_pending(wqe, work, prev);
992 raw_spin_unlock_irqrestore(&wqe->lock, flags);
993 io_run_cancel(work, wqe);
995 if (!match->cancel_all)
998 /* not safe to continue after unlock */
1001 raw_spin_unlock_irqrestore(&wqe->lock, flags);
1004 static void io_wqe_cancel_running_work(struct io_wqe *wqe,
1005 struct io_cb_cancel_data *match)
1008 io_wq_for_each_worker(wqe, io_wq_worker_cancel, match);
1012 enum io_wq_cancel io_wq_cancel_cb(struct io_wq *wq, work_cancel_fn *cancel,
1013 void *data, bool cancel_all)
1015 struct io_cb_cancel_data match = {
1018 .cancel_all = cancel_all,
1023 * First check pending list, if we're lucky we can just remove it
1024 * from there. CANCEL_OK means that the work is returned as-new,
1025 * no completion will be posted for it.
1027 for_each_node(node) {
1028 struct io_wqe *wqe = wq->wqes[node];
1030 io_wqe_cancel_pending_work(wqe, &match);
1031 if (match.nr_pending && !match.cancel_all)
1032 return IO_WQ_CANCEL_OK;
1036 * Now check if a free (going busy) or busy worker has the work
1037 * currently running. If we find it there, we'll return CANCEL_RUNNING
1038 * as an indication that we attempt to signal cancellation. The
1039 * completion will run normally in this case.
1041 for_each_node(node) {
1042 struct io_wqe *wqe = wq->wqes[node];
1044 io_wqe_cancel_running_work(wqe, &match);
1045 if (match.nr_running && !match.cancel_all)
1046 return IO_WQ_CANCEL_RUNNING;
1049 if (match.nr_running)
1050 return IO_WQ_CANCEL_RUNNING;
1051 if (match.nr_pending)
1052 return IO_WQ_CANCEL_OK;
1053 return IO_WQ_CANCEL_NOTFOUND;
1056 static bool io_wq_io_cb_cancel_data(struct io_wq_work *work, void *data)
1058 return work == data;
1061 enum io_wq_cancel io_wq_cancel_work(struct io_wq *wq, struct io_wq_work *cwork)
1063 return io_wq_cancel_cb(wq, io_wq_io_cb_cancel_data, (void *)cwork, false);
1066 struct io_wq *io_wq_create(unsigned bounded, struct io_wq_data *data)
1068 int ret = -ENOMEM, node;
1071 if (WARN_ON_ONCE(!data->free_work || !data->do_work))
1072 return ERR_PTR(-EINVAL);
1074 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
1076 return ERR_PTR(-ENOMEM);
1078 wq->wqes = kcalloc(nr_node_ids, sizeof(struct io_wqe *), GFP_KERNEL);
1081 return ERR_PTR(-ENOMEM);
1084 wq->free_work = data->free_work;
1085 wq->do_work = data->do_work;
1087 /* caller must already hold a reference to this */
1088 wq->user = data->user;
1090 for_each_node(node) {
1092 int alloc_node = node;
1094 if (!node_online(alloc_node))
1095 alloc_node = NUMA_NO_NODE;
1096 wqe = kzalloc_node(sizeof(struct io_wqe), GFP_KERNEL, alloc_node);
1099 wq->wqes[node] = wqe;
1100 wqe->node = alloc_node;
1101 wqe->acct[IO_WQ_ACCT_BOUND].max_workers = bounded;
1102 atomic_set(&wqe->acct[IO_WQ_ACCT_BOUND].nr_running, 0);
1104 wqe->acct[IO_WQ_ACCT_UNBOUND].max_workers =
1105 task_rlimit(current, RLIMIT_NPROC);
1107 atomic_set(&wqe->acct[IO_WQ_ACCT_UNBOUND].nr_running, 0);
1109 raw_spin_lock_init(&wqe->lock);
1110 INIT_WQ_LIST(&wqe->work_list);
1111 INIT_HLIST_NULLS_HEAD(&wqe->free_list, 0);
1112 INIT_LIST_HEAD(&wqe->all_list);
1115 init_completion(&wq->done);
1117 wq->manager = kthread_create(io_wq_manager, wq, "io_wq_manager");
1118 if (!IS_ERR(wq->manager)) {
1119 wake_up_process(wq->manager);
1120 wait_for_completion(&wq->done);
1121 if (test_bit(IO_WQ_BIT_ERROR, &wq->state)) {
1125 refcount_set(&wq->use_refs, 1);
1126 reinit_completion(&wq->done);
1130 ret = PTR_ERR(wq->manager);
1131 complete(&wq->done);
1134 kfree(wq->wqes[node]);
1137 return ERR_PTR(ret);
1140 bool io_wq_get(struct io_wq *wq, struct io_wq_data *data)
1142 if (data->free_work != wq->free_work || data->do_work != wq->do_work)
1145 return refcount_inc_not_zero(&wq->use_refs);
1148 static void __io_wq_destroy(struct io_wq *wq)
1152 set_bit(IO_WQ_BIT_EXIT, &wq->state);
1154 kthread_stop(wq->manager);
1158 io_wq_for_each_worker(wq->wqes[node], io_wq_worker_wake, NULL);
1161 wait_for_completion(&wq->done);
1164 kfree(wq->wqes[node]);
1169 void io_wq_destroy(struct io_wq *wq)
1171 if (refcount_dec_and_test(&wq->use_refs))
1172 __io_wq_destroy(wq);
1175 struct task_struct *io_wq_get_task(struct io_wq *wq)