1 // SPDX-License-Identifier: GPL-2.0
3 * Shared application/kernel submission and completion ring pairs, for
4 * supporting fast/efficient IO.
6 * A note on the read/write ordering memory barriers that are matched between
7 * the application and kernel side.
9 * After the application reads the CQ ring tail, it must use an
10 * appropriate smp_rmb() to pair with the smp_wmb() the kernel uses
11 * before writing the tail (using smp_load_acquire to read the tail will
12 * do). It also needs a smp_mb() before updating CQ head (ordering the
13 * entry load(s) with the head store), pairing with an implicit barrier
14 * through a control-dependency in io_get_cqe (smp_store_release to
15 * store head will do). Failure to do so could lead to reading invalid
18 * Likewise, the application must use an appropriate smp_wmb() before
19 * writing the SQ tail (ordering SQ entry stores with the tail store),
20 * which pairs with smp_load_acquire in io_get_sqring (smp_store_release
21 * to store the tail will do). And it needs a barrier ordering the SQ
22 * head load before writing new SQ entries (smp_load_acquire to read
25 * When using the SQ poll thread (IORING_SETUP_SQPOLL), the application
26 * needs to check the SQ flags for IORING_SQ_NEED_WAKEUP *after*
27 * updating the SQ tail; a full memory barrier smp_mb() is needed
30 * Also see the examples in the liburing library:
32 * git://git.kernel.dk/liburing
34 * io_uring also uses READ/WRITE_ONCE() for _any_ store or load that happens
35 * from data shared between the kernel and application. This is done both
36 * for ordering purposes, but also to ensure that once a value is loaded from
37 * data that the application could potentially modify, it remains stable.
39 * Copyright (C) 2018-2019 Jens Axboe
40 * Copyright (c) 2018-2019 Christoph Hellwig
42 #include <linux/kernel.h>
43 #include <linux/init.h>
44 #include <linux/errno.h>
45 #include <linux/syscalls.h>
46 #include <net/compat.h>
47 #include <linux/refcount.h>
48 #include <linux/uio.h>
49 #include <linux/bits.h>
51 #include <linux/sched/signal.h>
53 #include <linux/file.h>
54 #include <linux/fdtable.h>
56 #include <linux/mman.h>
57 #include <linux/percpu.h>
58 #include <linux/slab.h>
59 #include <linux/bvec.h>
60 #include <linux/net.h>
62 #include <net/af_unix.h>
64 #include <linux/anon_inodes.h>
65 #include <linux/sched/mm.h>
66 #include <linux/uaccess.h>
67 #include <linux/nospec.h>
68 #include <linux/highmem.h>
69 #include <linux/fsnotify.h>
70 #include <linux/fadvise.h>
71 #include <linux/task_work.h>
72 #include <linux/io_uring.h>
73 #include <linux/audit.h>
74 #include <linux/security.h>
76 #define CREATE_TRACE_POINTS
77 #include <trace/events/io_uring.h>
79 #include <uapi/linux/io_uring.h>
97 #include "alloc_cache.h"
99 #define IORING_MAX_ENTRIES 32768
100 #define IORING_MAX_CQ_ENTRIES (2 * IORING_MAX_ENTRIES)
102 #define IORING_MAX_RESTRICTIONS (IORING_RESTRICTION_LAST + \
103 IORING_REGISTER_LAST + IORING_OP_LAST)
105 #define SQE_COMMON_FLAGS (IOSQE_FIXED_FILE | IOSQE_IO_LINK | \
106 IOSQE_IO_HARDLINK | IOSQE_ASYNC)
108 #define SQE_VALID_FLAGS (SQE_COMMON_FLAGS | IOSQE_BUFFER_SELECT | \
109 IOSQE_IO_DRAIN | IOSQE_CQE_SKIP_SUCCESS)
111 #define IO_REQ_CLEAN_FLAGS (REQ_F_BUFFER_SELECTED | REQ_F_NEED_CLEANUP | \
112 REQ_F_POLLED | REQ_F_INFLIGHT | REQ_F_CREDS | \
115 #define IO_REQ_CLEAN_SLOW_FLAGS (REQ_F_REFCOUNT | REQ_F_LINK | REQ_F_HARDLINK |\
118 #define IO_TCTX_REFS_CACHE_NR (1U << 10)
120 #define IO_COMPL_BATCH 32
121 #define IO_REQ_ALLOC_BATCH 8
124 IO_CHECK_CQ_OVERFLOW_BIT,
125 IO_CHECK_CQ_DROPPED_BIT,
129 IO_EVENTFD_OP_SIGNAL_BIT,
130 IO_EVENTFD_OP_FREE_BIT,
133 struct io_defer_entry {
134 struct list_head list;
135 struct io_kiocb *req;
139 /* requests with any of those set should undergo io_disarm_next() */
140 #define IO_DISARM_MASK (REQ_F_ARM_LTIMEOUT | REQ_F_LINK_TIMEOUT | REQ_F_FAIL)
141 #define IO_REQ_LINK_FLAGS (REQ_F_LINK | REQ_F_HARDLINK)
143 static bool io_uring_try_cancel_requests(struct io_ring_ctx *ctx,
144 struct task_struct *task,
147 static void io_dismantle_req(struct io_kiocb *req);
148 static void io_clean_op(struct io_kiocb *req);
149 static void io_queue_sqe(struct io_kiocb *req);
150 static void io_move_task_work_from_local(struct io_ring_ctx *ctx);
151 static void __io_submit_flush_completions(struct io_ring_ctx *ctx);
152 static __cold void io_fallback_tw(struct io_uring_task *tctx);
154 static struct kmem_cache *req_cachep;
156 struct sock *io_uring_get_socket(struct file *file)
158 #if defined(CONFIG_UNIX)
159 if (io_is_uring_fops(file)) {
160 struct io_ring_ctx *ctx = file->private_data;
162 return ctx->ring_sock->sk;
167 EXPORT_SYMBOL(io_uring_get_socket);
169 static inline void io_submit_flush_completions(struct io_ring_ctx *ctx)
171 if (!wq_list_empty(&ctx->submit_state.compl_reqs) ||
172 ctx->submit_state.cqes_count)
173 __io_submit_flush_completions(ctx);
176 static inline unsigned int __io_cqring_events(struct io_ring_ctx *ctx)
178 return ctx->cached_cq_tail - READ_ONCE(ctx->rings->cq.head);
181 static inline unsigned int __io_cqring_events_user(struct io_ring_ctx *ctx)
183 return READ_ONCE(ctx->rings->cq.tail) - READ_ONCE(ctx->rings->cq.head);
186 static bool io_match_linked(struct io_kiocb *head)
188 struct io_kiocb *req;
190 io_for_each_link(req, head) {
191 if (req->flags & REQ_F_INFLIGHT)
198 * As io_match_task() but protected against racing with linked timeouts.
199 * User must not hold timeout_lock.
201 bool io_match_task_safe(struct io_kiocb *head, struct task_struct *task,
206 if (task && head->task != task)
211 if (head->flags & REQ_F_LINK_TIMEOUT) {
212 struct io_ring_ctx *ctx = head->ctx;
214 /* protect against races with linked timeouts */
215 spin_lock_irq(&ctx->timeout_lock);
216 matched = io_match_linked(head);
217 spin_unlock_irq(&ctx->timeout_lock);
219 matched = io_match_linked(head);
224 static inline void req_fail_link_node(struct io_kiocb *req, int res)
227 io_req_set_res(req, res, 0);
230 static inline void io_req_add_to_cache(struct io_kiocb *req, struct io_ring_ctx *ctx)
232 wq_stack_add_head(&req->comp_list, &ctx->submit_state.free_list);
235 static __cold void io_ring_ctx_ref_free(struct percpu_ref *ref)
237 struct io_ring_ctx *ctx = container_of(ref, struct io_ring_ctx, refs);
239 complete(&ctx->ref_comp);
242 static __cold void io_fallback_req_func(struct work_struct *work)
244 struct io_ring_ctx *ctx = container_of(work, struct io_ring_ctx,
246 struct llist_node *node = llist_del_all(&ctx->fallback_llist);
247 struct io_kiocb *req, *tmp;
250 percpu_ref_get(&ctx->refs);
251 llist_for_each_entry_safe(req, tmp, node, io_task_work.node)
252 req->io_task_work.func(req, &locked);
255 io_submit_flush_completions(ctx);
256 mutex_unlock(&ctx->uring_lock);
258 percpu_ref_put(&ctx->refs);
261 static int io_alloc_hash_table(struct io_hash_table *table, unsigned bits)
263 unsigned hash_buckets = 1U << bits;
264 size_t hash_size = hash_buckets * sizeof(table->hbs[0]);
266 table->hbs = kmalloc(hash_size, GFP_KERNEL);
270 table->hash_bits = bits;
271 init_hash_table(table, hash_buckets);
275 static __cold struct io_ring_ctx *io_ring_ctx_alloc(struct io_uring_params *p)
277 struct io_ring_ctx *ctx;
280 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
284 xa_init(&ctx->io_bl_xa);
287 * Use 5 bits less than the max cq entries, that should give us around
288 * 32 entries per hash list if totally full and uniformly spread, but
289 * don't keep too many buckets to not overconsume memory.
291 hash_bits = ilog2(p->cq_entries) - 5;
292 hash_bits = clamp(hash_bits, 1, 8);
293 if (io_alloc_hash_table(&ctx->cancel_table, hash_bits))
295 if (io_alloc_hash_table(&ctx->cancel_table_locked, hash_bits))
298 ctx->dummy_ubuf = kzalloc(sizeof(*ctx->dummy_ubuf), GFP_KERNEL);
299 if (!ctx->dummy_ubuf)
301 /* set invalid range, so io_import_fixed() fails meeting it */
302 ctx->dummy_ubuf->ubuf = -1UL;
304 if (percpu_ref_init(&ctx->refs, io_ring_ctx_ref_free,
308 ctx->flags = p->flags;
309 init_waitqueue_head(&ctx->sqo_sq_wait);
310 INIT_LIST_HEAD(&ctx->sqd_list);
311 INIT_LIST_HEAD(&ctx->cq_overflow_list);
312 INIT_LIST_HEAD(&ctx->io_buffers_cache);
313 io_alloc_cache_init(&ctx->apoll_cache);
314 io_alloc_cache_init(&ctx->netmsg_cache);
315 init_completion(&ctx->ref_comp);
316 xa_init_flags(&ctx->personalities, XA_FLAGS_ALLOC1);
317 mutex_init(&ctx->uring_lock);
318 init_waitqueue_head(&ctx->cq_wait);
319 init_waitqueue_head(&ctx->poll_wq);
320 spin_lock_init(&ctx->completion_lock);
321 spin_lock_init(&ctx->timeout_lock);
322 INIT_WQ_LIST(&ctx->iopoll_list);
323 INIT_LIST_HEAD(&ctx->io_buffers_pages);
324 INIT_LIST_HEAD(&ctx->io_buffers_comp);
325 INIT_LIST_HEAD(&ctx->defer_list);
326 INIT_LIST_HEAD(&ctx->timeout_list);
327 INIT_LIST_HEAD(&ctx->ltimeout_list);
328 spin_lock_init(&ctx->rsrc_ref_lock);
329 INIT_LIST_HEAD(&ctx->rsrc_ref_list);
330 INIT_DELAYED_WORK(&ctx->rsrc_put_work, io_rsrc_put_work);
331 init_task_work(&ctx->rsrc_put_tw, io_rsrc_put_tw);
332 init_llist_head(&ctx->rsrc_put_llist);
333 init_llist_head(&ctx->work_llist);
334 INIT_LIST_HEAD(&ctx->tctx_list);
335 ctx->submit_state.free_list.next = NULL;
336 INIT_WQ_LIST(&ctx->locked_free_list);
337 INIT_DELAYED_WORK(&ctx->fallback_work, io_fallback_req_func);
338 INIT_WQ_LIST(&ctx->submit_state.compl_reqs);
341 kfree(ctx->dummy_ubuf);
342 kfree(ctx->cancel_table.hbs);
343 kfree(ctx->cancel_table_locked.hbs);
345 xa_destroy(&ctx->io_bl_xa);
350 static void io_account_cq_overflow(struct io_ring_ctx *ctx)
352 struct io_rings *r = ctx->rings;
354 WRITE_ONCE(r->cq_overflow, READ_ONCE(r->cq_overflow) + 1);
358 static bool req_need_defer(struct io_kiocb *req, u32 seq)
360 if (unlikely(req->flags & REQ_F_IO_DRAIN)) {
361 struct io_ring_ctx *ctx = req->ctx;
363 return seq + READ_ONCE(ctx->cq_extra) != ctx->cached_cq_tail;
369 static inline void io_req_track_inflight(struct io_kiocb *req)
371 if (!(req->flags & REQ_F_INFLIGHT)) {
372 req->flags |= REQ_F_INFLIGHT;
373 atomic_inc(&req->task->io_uring->inflight_tracked);
377 static struct io_kiocb *__io_prep_linked_timeout(struct io_kiocb *req)
379 if (WARN_ON_ONCE(!req->link))
382 req->flags &= ~REQ_F_ARM_LTIMEOUT;
383 req->flags |= REQ_F_LINK_TIMEOUT;
385 /* linked timeouts should have two refs once prep'ed */
386 io_req_set_refcount(req);
387 __io_req_set_refcount(req->link, 2);
391 static inline struct io_kiocb *io_prep_linked_timeout(struct io_kiocb *req)
393 if (likely(!(req->flags & REQ_F_ARM_LTIMEOUT)))
395 return __io_prep_linked_timeout(req);
398 static noinline void __io_arm_ltimeout(struct io_kiocb *req)
400 io_queue_linked_timeout(__io_prep_linked_timeout(req));
403 static inline void io_arm_ltimeout(struct io_kiocb *req)
405 if (unlikely(req->flags & REQ_F_ARM_LTIMEOUT))
406 __io_arm_ltimeout(req);
409 static void io_prep_async_work(struct io_kiocb *req)
411 const struct io_op_def *def = &io_op_defs[req->opcode];
412 struct io_ring_ctx *ctx = req->ctx;
414 if (!(req->flags & REQ_F_CREDS)) {
415 req->flags |= REQ_F_CREDS;
416 req->creds = get_current_cred();
419 req->work.list.next = NULL;
421 req->work.cancel_seq = atomic_read(&ctx->cancel_seq);
422 if (req->flags & REQ_F_FORCE_ASYNC)
423 req->work.flags |= IO_WQ_WORK_CONCURRENT;
425 if (req->file && !io_req_ffs_set(req))
426 req->flags |= io_file_get_flags(req->file) << REQ_F_SUPPORT_NOWAIT_BIT;
428 if (req->flags & REQ_F_ISREG) {
429 if (def->hash_reg_file || (ctx->flags & IORING_SETUP_IOPOLL))
430 io_wq_hash_work(&req->work, file_inode(req->file));
431 } else if (!req->file || !S_ISBLK(file_inode(req->file)->i_mode)) {
432 if (def->unbound_nonreg_file)
433 req->work.flags |= IO_WQ_WORK_UNBOUND;
437 static void io_prep_async_link(struct io_kiocb *req)
439 struct io_kiocb *cur;
441 if (req->flags & REQ_F_LINK_TIMEOUT) {
442 struct io_ring_ctx *ctx = req->ctx;
444 spin_lock_irq(&ctx->timeout_lock);
445 io_for_each_link(cur, req)
446 io_prep_async_work(cur);
447 spin_unlock_irq(&ctx->timeout_lock);
449 io_for_each_link(cur, req)
450 io_prep_async_work(cur);
454 void io_queue_iowq(struct io_kiocb *req, bool *dont_use)
456 struct io_kiocb *link = io_prep_linked_timeout(req);
457 struct io_uring_task *tctx = req->task->io_uring;
460 BUG_ON(!tctx->io_wq);
462 /* init ->work of the whole link before punting */
463 io_prep_async_link(req);
466 * Not expected to happen, but if we do have a bug where this _can_
467 * happen, catch it here and ensure the request is marked as
468 * canceled. That will make io-wq go through the usual work cancel
469 * procedure rather than attempt to run this request (or create a new
472 if (WARN_ON_ONCE(!same_thread_group(req->task, current)))
473 req->work.flags |= IO_WQ_WORK_CANCEL;
475 trace_io_uring_queue_async_work(req, io_wq_is_hashed(&req->work));
476 io_wq_enqueue(tctx->io_wq, &req->work);
478 io_queue_linked_timeout(link);
481 static __cold void io_queue_deferred(struct io_ring_ctx *ctx)
483 while (!list_empty(&ctx->defer_list)) {
484 struct io_defer_entry *de = list_first_entry(&ctx->defer_list,
485 struct io_defer_entry, list);
487 if (req_need_defer(de->req, de->seq))
489 list_del_init(&de->list);
490 io_req_task_queue(de->req);
496 static void io_eventfd_ops(struct rcu_head *rcu)
498 struct io_ev_fd *ev_fd = container_of(rcu, struct io_ev_fd, rcu);
499 int ops = atomic_xchg(&ev_fd->ops, 0);
501 if (ops & BIT(IO_EVENTFD_OP_SIGNAL_BIT))
502 eventfd_signal_mask(ev_fd->cq_ev_fd, 1, EPOLL_URING_WAKE);
504 /* IO_EVENTFD_OP_FREE_BIT may not be set here depending on callback
505 * ordering in a race but if references are 0 we know we have to free
508 if (atomic_dec_and_test(&ev_fd->refs)) {
509 eventfd_ctx_put(ev_fd->cq_ev_fd);
514 static void io_eventfd_signal(struct io_ring_ctx *ctx)
516 struct io_ev_fd *ev_fd = NULL;
520 * rcu_dereference ctx->io_ev_fd once and use it for both for checking
523 ev_fd = rcu_dereference(ctx->io_ev_fd);
526 * Check again if ev_fd exists incase an io_eventfd_unregister call
527 * completed between the NULL check of ctx->io_ev_fd at the start of
528 * the function and rcu_read_lock.
530 if (unlikely(!ev_fd))
532 if (READ_ONCE(ctx->rings->cq_flags) & IORING_CQ_EVENTFD_DISABLED)
534 if (ev_fd->eventfd_async && !io_wq_current_is_worker())
537 if (likely(eventfd_signal_allowed())) {
538 eventfd_signal_mask(ev_fd->cq_ev_fd, 1, EPOLL_URING_WAKE);
540 atomic_inc(&ev_fd->refs);
541 if (!atomic_fetch_or(BIT(IO_EVENTFD_OP_SIGNAL_BIT), &ev_fd->ops))
542 call_rcu_hurry(&ev_fd->rcu, io_eventfd_ops);
544 atomic_dec(&ev_fd->refs);
551 static void io_eventfd_flush_signal(struct io_ring_ctx *ctx)
555 spin_lock(&ctx->completion_lock);
558 * Eventfd should only get triggered when at least one event has been
559 * posted. Some applications rely on the eventfd notification count
560 * only changing IFF a new CQE has been added to the CQ ring. There's
561 * no depedency on 1:1 relationship between how many times this
562 * function is called (and hence the eventfd count) and number of CQEs
563 * posted to the CQ ring.
565 skip = ctx->cached_cq_tail == ctx->evfd_last_cq_tail;
566 ctx->evfd_last_cq_tail = ctx->cached_cq_tail;
567 spin_unlock(&ctx->completion_lock);
571 io_eventfd_signal(ctx);
574 void __io_commit_cqring_flush(struct io_ring_ctx *ctx)
576 if (ctx->poll_activated)
577 io_poll_wq_wake(ctx);
578 if (ctx->off_timeout_used)
579 io_flush_timeouts(ctx);
580 if (ctx->drain_active) {
581 spin_lock(&ctx->completion_lock);
582 io_queue_deferred(ctx);
583 spin_unlock(&ctx->completion_lock);
586 io_eventfd_flush_signal(ctx);
589 static inline void __io_cq_lock(struct io_ring_ctx *ctx)
590 __acquires(ctx->completion_lock)
592 if (!ctx->task_complete)
593 spin_lock(&ctx->completion_lock);
596 static inline void __io_cq_unlock(struct io_ring_ctx *ctx)
598 if (!ctx->task_complete)
599 spin_unlock(&ctx->completion_lock);
602 static inline void io_cq_lock(struct io_ring_ctx *ctx)
603 __acquires(ctx->completion_lock)
605 spin_lock(&ctx->completion_lock);
608 static inline void io_cq_unlock(struct io_ring_ctx *ctx)
609 __releases(ctx->completion_lock)
611 spin_unlock(&ctx->completion_lock);
614 /* keep it inlined for io_submit_flush_completions() */
615 static inline void __io_cq_unlock_post(struct io_ring_ctx *ctx)
616 __releases(ctx->completion_lock)
618 io_commit_cqring(ctx);
620 io_commit_cqring_flush(ctx);
624 static inline void __io_cq_unlock_post_flush(struct io_ring_ctx *ctx)
625 __releases(ctx->completion_lock)
627 io_commit_cqring(ctx);
629 io_commit_cqring_flush(ctx);
632 * As ->task_complete implies that the ring is single tasked, cq_wait
633 * may only be waited on by the current in io_cqring_wait(), but since
634 * it will re-check the wakeup conditions once we return we can safely
637 if (!(ctx->flags & IORING_SETUP_DEFER_TASKRUN)) {
639 __io_cqring_wake(ctx);
643 void io_cq_unlock_post(struct io_ring_ctx *ctx)
644 __releases(ctx->completion_lock)
646 io_commit_cqring(ctx);
647 spin_unlock(&ctx->completion_lock);
648 io_commit_cqring_flush(ctx);
652 /* Returns true if there are no backlogged entries after the flush */
653 static void io_cqring_overflow_kill(struct io_ring_ctx *ctx)
655 struct io_overflow_cqe *ocqe;
659 list_splice_init(&ctx->cq_overflow_list, &list);
660 clear_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq);
663 while (!list_empty(&list)) {
664 ocqe = list_first_entry(&list, struct io_overflow_cqe, list);
665 list_del(&ocqe->list);
670 /* Returns true if there are no backlogged entries after the flush */
671 static void __io_cqring_overflow_flush(struct io_ring_ctx *ctx)
673 size_t cqe_size = sizeof(struct io_uring_cqe);
675 if (__io_cqring_events(ctx) == ctx->cq_entries)
678 if (ctx->flags & IORING_SETUP_CQE32)
682 while (!list_empty(&ctx->cq_overflow_list)) {
683 struct io_uring_cqe *cqe = io_get_cqe_overflow(ctx, true);
684 struct io_overflow_cqe *ocqe;
688 ocqe = list_first_entry(&ctx->cq_overflow_list,
689 struct io_overflow_cqe, list);
690 memcpy(cqe, &ocqe->cqe, cqe_size);
691 list_del(&ocqe->list);
695 if (list_empty(&ctx->cq_overflow_list)) {
696 clear_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq);
697 atomic_andnot(IORING_SQ_CQ_OVERFLOW, &ctx->rings->sq_flags);
699 io_cq_unlock_post(ctx);
702 static void io_cqring_do_overflow_flush(struct io_ring_ctx *ctx)
704 /* iopoll syncs against uring_lock, not completion_lock */
705 if (ctx->flags & IORING_SETUP_IOPOLL)
706 mutex_lock(&ctx->uring_lock);
707 __io_cqring_overflow_flush(ctx);
708 if (ctx->flags & IORING_SETUP_IOPOLL)
709 mutex_unlock(&ctx->uring_lock);
712 static void io_cqring_overflow_flush(struct io_ring_ctx *ctx)
714 if (test_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq))
715 io_cqring_do_overflow_flush(ctx);
718 static void __io_put_task(struct task_struct *task, int nr)
720 struct io_uring_task *tctx = task->io_uring;
722 percpu_counter_sub(&tctx->inflight, nr);
723 if (unlikely(atomic_read(&tctx->in_idle)))
724 wake_up(&tctx->wait);
725 put_task_struct_many(task, nr);
728 /* must to be called somewhat shortly after putting a request */
729 static inline void io_put_task(struct task_struct *task, int nr)
731 if (likely(task == current))
732 task->io_uring->cached_refs += nr;
734 __io_put_task(task, nr);
737 void io_task_refs_refill(struct io_uring_task *tctx)
739 unsigned int refill = -tctx->cached_refs + IO_TCTX_REFS_CACHE_NR;
741 percpu_counter_add(&tctx->inflight, refill);
742 refcount_add(refill, ¤t->usage);
743 tctx->cached_refs += refill;
746 static __cold void io_uring_drop_tctx_refs(struct task_struct *task)
748 struct io_uring_task *tctx = task->io_uring;
749 unsigned int refs = tctx->cached_refs;
752 tctx->cached_refs = 0;
753 percpu_counter_sub(&tctx->inflight, refs);
754 put_task_struct_many(task, refs);
758 static bool io_cqring_event_overflow(struct io_ring_ctx *ctx, u64 user_data,
759 s32 res, u32 cflags, u64 extra1, u64 extra2)
761 struct io_overflow_cqe *ocqe;
762 size_t ocq_size = sizeof(struct io_overflow_cqe);
763 bool is_cqe32 = (ctx->flags & IORING_SETUP_CQE32);
765 lockdep_assert_held(&ctx->completion_lock);
768 ocq_size += sizeof(struct io_uring_cqe);
770 ocqe = kmalloc(ocq_size, GFP_ATOMIC | __GFP_ACCOUNT);
771 trace_io_uring_cqe_overflow(ctx, user_data, res, cflags, ocqe);
774 * If we're in ring overflow flush mode, or in task cancel mode,
775 * or cannot allocate an overflow entry, then we need to drop it
778 io_account_cq_overflow(ctx);
779 set_bit(IO_CHECK_CQ_DROPPED_BIT, &ctx->check_cq);
782 if (list_empty(&ctx->cq_overflow_list)) {
783 set_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq);
784 atomic_or(IORING_SQ_CQ_OVERFLOW, &ctx->rings->sq_flags);
787 ocqe->cqe.user_data = user_data;
789 ocqe->cqe.flags = cflags;
791 ocqe->cqe.big_cqe[0] = extra1;
792 ocqe->cqe.big_cqe[1] = extra2;
794 list_add_tail(&ocqe->list, &ctx->cq_overflow_list);
798 bool io_req_cqe_overflow(struct io_kiocb *req)
800 if (!(req->flags & REQ_F_CQE32_INIT)) {
804 return io_cqring_event_overflow(req->ctx, req->cqe.user_data,
805 req->cqe.res, req->cqe.flags,
806 req->extra1, req->extra2);
810 * writes to the cq entry need to come after reading head; the
811 * control dependency is enough as we're using WRITE_ONCE to
814 struct io_uring_cqe *__io_get_cqe(struct io_ring_ctx *ctx, bool overflow)
816 struct io_rings *rings = ctx->rings;
817 unsigned int off = ctx->cached_cq_tail & (ctx->cq_entries - 1);
818 unsigned int free, queued, len;
821 * Posting into the CQ when there are pending overflowed CQEs may break
822 * ordering guarantees, which will affect links, F_MORE users and more.
823 * Force overflow the completion.
825 if (!overflow && (ctx->check_cq & BIT(IO_CHECK_CQ_OVERFLOW_BIT)))
828 /* userspace may cheat modifying the tail, be safe and do min */
829 queued = min(__io_cqring_events(ctx), ctx->cq_entries);
830 free = ctx->cq_entries - queued;
831 /* we need a contiguous range, limit based on the current array offset */
832 len = min(free, ctx->cq_entries - off);
836 if (ctx->flags & IORING_SETUP_CQE32) {
841 ctx->cqe_cached = &rings->cqes[off];
842 ctx->cqe_sentinel = ctx->cqe_cached + len;
844 ctx->cached_cq_tail++;
846 if (ctx->flags & IORING_SETUP_CQE32)
848 return &rings->cqes[off];
851 static bool io_fill_cqe_aux(struct io_ring_ctx *ctx, u64 user_data, s32 res,
854 struct io_uring_cqe *cqe;
859 * If we can't get a cq entry, userspace overflowed the
860 * submission (by quite a lot). Increment the overflow count in
863 cqe = io_get_cqe(ctx);
865 trace_io_uring_complete(ctx, NULL, user_data, res, cflags, 0, 0);
867 WRITE_ONCE(cqe->user_data, user_data);
868 WRITE_ONCE(cqe->res, res);
869 WRITE_ONCE(cqe->flags, cflags);
871 if (ctx->flags & IORING_SETUP_CQE32) {
872 WRITE_ONCE(cqe->big_cqe[0], 0);
873 WRITE_ONCE(cqe->big_cqe[1], 0);
880 static void __io_flush_post_cqes(struct io_ring_ctx *ctx)
881 __must_hold(&ctx->uring_lock)
883 struct io_submit_state *state = &ctx->submit_state;
886 lockdep_assert_held(&ctx->uring_lock);
887 for (i = 0; i < state->cqes_count; i++) {
888 struct io_uring_cqe *cqe = &state->cqes[i];
890 if (!io_fill_cqe_aux(ctx, cqe->user_data, cqe->res, cqe->flags)) {
891 if (ctx->task_complete) {
892 spin_lock(&ctx->completion_lock);
893 io_cqring_event_overflow(ctx, cqe->user_data,
894 cqe->res, cqe->flags, 0, 0);
895 spin_unlock(&ctx->completion_lock);
897 io_cqring_event_overflow(ctx, cqe->user_data,
898 cqe->res, cqe->flags, 0, 0);
902 state->cqes_count = 0;
905 static bool __io_post_aux_cqe(struct io_ring_ctx *ctx, u64 user_data, s32 res, u32 cflags,
911 filled = io_fill_cqe_aux(ctx, user_data, res, cflags);
912 if (!filled && allow_overflow)
913 filled = io_cqring_event_overflow(ctx, user_data, res, cflags, 0, 0);
915 io_cq_unlock_post(ctx);
919 bool io_post_aux_cqe(struct io_ring_ctx *ctx, u64 user_data, s32 res, u32 cflags)
921 return __io_post_aux_cqe(ctx, user_data, res, cflags, true);
924 bool io_aux_cqe(struct io_ring_ctx *ctx, bool defer, u64 user_data, s32 res, u32 cflags,
927 struct io_uring_cqe *cqe;
931 return __io_post_aux_cqe(ctx, user_data, res, cflags, allow_overflow);
933 length = ARRAY_SIZE(ctx->submit_state.cqes);
935 lockdep_assert_held(&ctx->uring_lock);
937 if (ctx->submit_state.cqes_count == length) {
939 __io_flush_post_cqes(ctx);
940 /* no need to flush - flush is deferred */
941 __io_cq_unlock_post(ctx);
944 /* For defered completions this is not as strict as it is otherwise,
945 * however it's main job is to prevent unbounded posted completions,
946 * and in that it works just as well.
948 if (!allow_overflow && test_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq))
951 cqe = &ctx->submit_state.cqes[ctx->submit_state.cqes_count++];
952 cqe->user_data = user_data;
958 static void __io_req_complete_post(struct io_kiocb *req)
960 struct io_ring_ctx *ctx = req->ctx;
963 if (!(req->flags & REQ_F_CQE_SKIP))
964 io_fill_cqe_req(ctx, req);
967 * If we're the last reference to this request, add to our locked
970 if (req_ref_put_and_test(req)) {
971 if (req->flags & IO_REQ_LINK_FLAGS) {
972 if (req->flags & IO_DISARM_MASK)
975 io_req_task_queue(req->link);
979 io_req_put_rsrc(req);
981 * Selected buffer deallocation in io_clean_op() assumes that
982 * we don't hold ->completion_lock. Clean them here to avoid
985 io_put_kbuf_comp(req);
986 io_dismantle_req(req);
987 io_put_task(req->task, 1);
988 wq_list_add_head(&req->comp_list, &ctx->locked_free_list);
989 ctx->locked_free_nr++;
991 io_cq_unlock_post(ctx);
994 void io_req_complete_post(struct io_kiocb *req, unsigned issue_flags)
996 if (req->ctx->task_complete && (issue_flags & IO_URING_F_IOWQ)) {
997 req->io_task_work.func = io_req_task_complete;
998 io_req_task_work_add(req);
999 } else if (!(issue_flags & IO_URING_F_UNLOCKED) ||
1000 !(req->ctx->flags & IORING_SETUP_IOPOLL)) {
1001 __io_req_complete_post(req);
1003 struct io_ring_ctx *ctx = req->ctx;
1005 mutex_lock(&ctx->uring_lock);
1006 __io_req_complete_post(req);
1007 mutex_unlock(&ctx->uring_lock);
1011 void io_req_defer_failed(struct io_kiocb *req, s32 res)
1012 __must_hold(&ctx->uring_lock)
1014 const struct io_op_def *def = &io_op_defs[req->opcode];
1016 lockdep_assert_held(&req->ctx->uring_lock);
1019 io_req_set_res(req, res, io_put_kbuf(req, IO_URING_F_UNLOCKED));
1022 io_req_complete_defer(req);
1026 * Don't initialise the fields below on every allocation, but do that in
1027 * advance and keep them valid across allocations.
1029 static void io_preinit_req(struct io_kiocb *req, struct io_ring_ctx *ctx)
1033 req->async_data = NULL;
1034 /* not necessary, but safer to zero */
1038 static void io_flush_cached_locked_reqs(struct io_ring_ctx *ctx,
1039 struct io_submit_state *state)
1041 spin_lock(&ctx->completion_lock);
1042 wq_list_splice(&ctx->locked_free_list, &state->free_list);
1043 ctx->locked_free_nr = 0;
1044 spin_unlock(&ctx->completion_lock);
1048 * A request might get retired back into the request caches even before opcode
1049 * handlers and io_issue_sqe() are done with it, e.g. inline completion path.
1050 * Because of that, io_alloc_req() should be called only under ->uring_lock
1051 * and with extra caution to not get a request that is still worked on.
1053 __cold bool __io_alloc_req_refill(struct io_ring_ctx *ctx)
1054 __must_hold(&ctx->uring_lock)
1056 gfp_t gfp = GFP_KERNEL | __GFP_NOWARN;
1057 void *reqs[IO_REQ_ALLOC_BATCH];
1061 * If we have more than a batch's worth of requests in our IRQ side
1062 * locked cache, grab the lock and move them over to our submission
1065 if (data_race(ctx->locked_free_nr) > IO_COMPL_BATCH) {
1066 io_flush_cached_locked_reqs(ctx, &ctx->submit_state);
1067 if (!io_req_cache_empty(ctx))
1071 ret = kmem_cache_alloc_bulk(req_cachep, gfp, ARRAY_SIZE(reqs), reqs);
1074 * Bulk alloc is all-or-nothing. If we fail to get a batch,
1075 * retry single alloc to be on the safe side.
1077 if (unlikely(ret <= 0)) {
1078 reqs[0] = kmem_cache_alloc(req_cachep, gfp);
1084 percpu_ref_get_many(&ctx->refs, ret);
1085 for (i = 0; i < ret; i++) {
1086 struct io_kiocb *req = reqs[i];
1088 io_preinit_req(req, ctx);
1089 io_req_add_to_cache(req, ctx);
1094 static inline void io_dismantle_req(struct io_kiocb *req)
1096 unsigned int flags = req->flags;
1098 if (unlikely(flags & IO_REQ_CLEAN_FLAGS))
1100 if (!(flags & REQ_F_FIXED_FILE))
1101 io_put_file(req->file);
1104 __cold void io_free_req(struct io_kiocb *req)
1106 struct io_ring_ctx *ctx = req->ctx;
1108 io_req_put_rsrc(req);
1109 io_dismantle_req(req);
1110 io_put_task(req->task, 1);
1112 spin_lock(&ctx->completion_lock);
1113 wq_list_add_head(&req->comp_list, &ctx->locked_free_list);
1114 ctx->locked_free_nr++;
1115 spin_unlock(&ctx->completion_lock);
1118 static void __io_req_find_next_prep(struct io_kiocb *req)
1120 struct io_ring_ctx *ctx = req->ctx;
1122 spin_lock(&ctx->completion_lock);
1123 io_disarm_next(req);
1124 spin_unlock(&ctx->completion_lock);
1127 static inline struct io_kiocb *io_req_find_next(struct io_kiocb *req)
1129 struct io_kiocb *nxt;
1132 * If LINK is set, we have dependent requests in this chain. If we
1133 * didn't fail this request, queue the first one up, moving any other
1134 * dependencies to the next request. In case of failure, fail the rest
1137 if (unlikely(req->flags & IO_DISARM_MASK))
1138 __io_req_find_next_prep(req);
1144 static void ctx_flush_and_put(struct io_ring_ctx *ctx, bool *locked)
1148 if (ctx->flags & IORING_SETUP_TASKRUN_FLAG)
1149 atomic_andnot(IORING_SQ_TASKRUN, &ctx->rings->sq_flags);
1151 io_submit_flush_completions(ctx);
1152 mutex_unlock(&ctx->uring_lock);
1155 percpu_ref_put(&ctx->refs);
1158 static unsigned int handle_tw_list(struct llist_node *node,
1159 struct io_ring_ctx **ctx, bool *locked,
1160 struct llist_node *last)
1162 unsigned int count = 0;
1164 while (node != last) {
1165 struct llist_node *next = node->next;
1166 struct io_kiocb *req = container_of(node, struct io_kiocb,
1169 prefetch(container_of(next, struct io_kiocb, io_task_work.node));
1171 if (req->ctx != *ctx) {
1172 ctx_flush_and_put(*ctx, locked);
1174 /* if not contended, grab and improve batching */
1175 *locked = mutex_trylock(&(*ctx)->uring_lock);
1176 percpu_ref_get(&(*ctx)->refs);
1178 req->io_task_work.func(req, locked);
1187 * io_llist_xchg - swap all entries in a lock-less list
1188 * @head: the head of lock-less list to delete all entries
1189 * @new: new entry as the head of the list
1191 * If list is empty, return NULL, otherwise, return the pointer to the first entry.
1192 * The order of entries returned is from the newest to the oldest added one.
1194 static inline struct llist_node *io_llist_xchg(struct llist_head *head,
1195 struct llist_node *new)
1197 return xchg(&head->first, new);
1201 * io_llist_cmpxchg - possibly swap all entries in a lock-less list
1202 * @head: the head of lock-less list to delete all entries
1203 * @old: expected old value of the first entry of the list
1204 * @new: new entry as the head of the list
1206 * perform a cmpxchg on the first entry of the list.
1209 static inline struct llist_node *io_llist_cmpxchg(struct llist_head *head,
1210 struct llist_node *old,
1211 struct llist_node *new)
1213 return cmpxchg(&head->first, old, new);
1216 void tctx_task_work(struct callback_head *cb)
1218 bool uring_locked = false;
1219 struct io_ring_ctx *ctx = NULL;
1220 struct io_uring_task *tctx = container_of(cb, struct io_uring_task,
1222 struct llist_node fake = {};
1223 struct llist_node *node;
1224 unsigned int loops = 1;
1227 if (unlikely(current->flags & PF_EXITING)) {
1228 io_fallback_tw(tctx);
1232 node = io_llist_xchg(&tctx->task_list, &fake);
1233 count = handle_tw_list(node, &ctx, &uring_locked, NULL);
1234 node = io_llist_cmpxchg(&tctx->task_list, &fake, NULL);
1235 while (node != &fake) {
1237 node = io_llist_xchg(&tctx->task_list, &fake);
1238 count += handle_tw_list(node, &ctx, &uring_locked, &fake);
1239 node = io_llist_cmpxchg(&tctx->task_list, &fake, NULL);
1242 ctx_flush_and_put(ctx, &uring_locked);
1244 /* relaxed read is enough as only the task itself sets ->in_idle */
1245 if (unlikely(atomic_read(&tctx->in_idle)))
1246 io_uring_drop_tctx_refs(current);
1248 trace_io_uring_task_work_run(tctx, count, loops);
1251 static __cold void io_fallback_tw(struct io_uring_task *tctx)
1253 struct llist_node *node = llist_del_all(&tctx->task_list);
1254 struct io_kiocb *req;
1257 req = container_of(node, struct io_kiocb, io_task_work.node);
1259 if (llist_add(&req->io_task_work.node,
1260 &req->ctx->fallback_llist))
1261 schedule_delayed_work(&req->ctx->fallback_work, 1);
1265 static void io_req_local_work_add(struct io_kiocb *req)
1267 struct io_ring_ctx *ctx = req->ctx;
1269 percpu_ref_get(&ctx->refs);
1271 if (!llist_add(&req->io_task_work.node, &ctx->work_llist)) {
1272 percpu_ref_put(&ctx->refs);
1275 /* needed for the following wake up */
1276 smp_mb__after_atomic();
1278 if (unlikely(atomic_read(&req->task->io_uring->in_idle))) {
1279 io_move_task_work_from_local(ctx);
1280 percpu_ref_put(&ctx->refs);
1284 if (ctx->flags & IORING_SETUP_TASKRUN_FLAG)
1285 atomic_or(IORING_SQ_TASKRUN, &ctx->rings->sq_flags);
1287 io_eventfd_signal(ctx);
1289 if (READ_ONCE(ctx->cq_waiting))
1290 wake_up_state(ctx->submitter_task, TASK_INTERRUPTIBLE);
1291 percpu_ref_put(&ctx->refs);
1294 void __io_req_task_work_add(struct io_kiocb *req, bool allow_local)
1296 struct io_uring_task *tctx = req->task->io_uring;
1297 struct io_ring_ctx *ctx = req->ctx;
1299 if (allow_local && ctx->flags & IORING_SETUP_DEFER_TASKRUN) {
1300 io_req_local_work_add(req);
1304 /* task_work already pending, we're done */
1305 if (!llist_add(&req->io_task_work.node, &tctx->task_list))
1308 if (ctx->flags & IORING_SETUP_TASKRUN_FLAG)
1309 atomic_or(IORING_SQ_TASKRUN, &ctx->rings->sq_flags);
1311 if (likely(!task_work_add(req->task, &tctx->task_work, ctx->notify_method)))
1314 io_fallback_tw(tctx);
1317 static void __cold io_move_task_work_from_local(struct io_ring_ctx *ctx)
1319 struct llist_node *node;
1321 node = llist_del_all(&ctx->work_llist);
1323 struct io_kiocb *req = container_of(node, struct io_kiocb,
1327 __io_req_task_work_add(req, false);
1331 static int __io_run_local_work(struct io_ring_ctx *ctx, bool *locked)
1333 struct llist_node *node;
1334 unsigned int loops = 0;
1337 if (WARN_ON_ONCE(ctx->submitter_task != current))
1339 if (ctx->flags & IORING_SETUP_TASKRUN_FLAG)
1340 atomic_andnot(IORING_SQ_TASKRUN, &ctx->rings->sq_flags);
1342 node = io_llist_xchg(&ctx->work_llist, NULL);
1344 struct llist_node *next = node->next;
1345 struct io_kiocb *req = container_of(node, struct io_kiocb,
1347 prefetch(container_of(next, struct io_kiocb, io_task_work.node));
1348 req->io_task_work.func(req, locked);
1354 if (!llist_empty(&ctx->work_llist))
1357 io_submit_flush_completions(ctx);
1358 if (!llist_empty(&ctx->work_llist))
1361 trace_io_uring_local_work_run(ctx, ret, loops);
1365 static inline int io_run_local_work_locked(struct io_ring_ctx *ctx)
1370 if (llist_empty(&ctx->work_llist))
1374 ret = __io_run_local_work(ctx, &locked);
1375 /* shouldn't happen! */
1376 if (WARN_ON_ONCE(!locked))
1377 mutex_lock(&ctx->uring_lock);
1381 static int io_run_local_work(struct io_ring_ctx *ctx)
1383 bool locked = mutex_trylock(&ctx->uring_lock);
1386 ret = __io_run_local_work(ctx, &locked);
1388 mutex_unlock(&ctx->uring_lock);
1393 static void io_req_task_cancel(struct io_kiocb *req, bool *locked)
1395 io_tw_lock(req->ctx, locked);
1396 io_req_defer_failed(req, req->cqe.res);
1399 void io_req_task_submit(struct io_kiocb *req, bool *locked)
1401 io_tw_lock(req->ctx, locked);
1402 /* req->task == current here, checking PF_EXITING is safe */
1403 if (likely(!(req->task->flags & PF_EXITING)))
1406 io_req_defer_failed(req, -EFAULT);
1409 void io_req_task_queue_fail(struct io_kiocb *req, int ret)
1411 io_req_set_res(req, ret, 0);
1412 req->io_task_work.func = io_req_task_cancel;
1413 io_req_task_work_add(req);
1416 void io_req_task_queue(struct io_kiocb *req)
1418 req->io_task_work.func = io_req_task_submit;
1419 io_req_task_work_add(req);
1422 void io_queue_next(struct io_kiocb *req)
1424 struct io_kiocb *nxt = io_req_find_next(req);
1427 io_req_task_queue(nxt);
1430 void io_free_batch_list(struct io_ring_ctx *ctx, struct io_wq_work_node *node)
1431 __must_hold(&ctx->uring_lock)
1433 struct task_struct *task = NULL;
1437 struct io_kiocb *req = container_of(node, struct io_kiocb,
1440 if (unlikely(req->flags & IO_REQ_CLEAN_SLOW_FLAGS)) {
1441 if (req->flags & REQ_F_REFCOUNT) {
1442 node = req->comp_list.next;
1443 if (!req_ref_put_and_test(req))
1446 if ((req->flags & REQ_F_POLLED) && req->apoll) {
1447 struct async_poll *apoll = req->apoll;
1449 if (apoll->double_poll)
1450 kfree(apoll->double_poll);
1451 if (!io_alloc_cache_put(&ctx->apoll_cache, &apoll->cache))
1453 req->flags &= ~REQ_F_POLLED;
1455 if (req->flags & IO_REQ_LINK_FLAGS)
1457 if (unlikely(req->flags & IO_REQ_CLEAN_FLAGS))
1460 if (!(req->flags & REQ_F_FIXED_FILE))
1461 io_put_file(req->file);
1463 io_req_put_rsrc_locked(req, ctx);
1465 if (req->task != task) {
1467 io_put_task(task, task_refs);
1472 node = req->comp_list.next;
1473 io_req_add_to_cache(req, ctx);
1477 io_put_task(task, task_refs);
1480 static void __io_submit_flush_completions(struct io_ring_ctx *ctx)
1481 __must_hold(&ctx->uring_lock)
1483 struct io_wq_work_node *node, *prev;
1484 struct io_submit_state *state = &ctx->submit_state;
1487 /* must come first to preserve CQE ordering in failure cases */
1488 if (state->cqes_count)
1489 __io_flush_post_cqes(ctx);
1490 wq_list_for_each(node, prev, &state->compl_reqs) {
1491 struct io_kiocb *req = container_of(node, struct io_kiocb,
1494 if (!(req->flags & REQ_F_CQE_SKIP) &&
1495 unlikely(!__io_fill_cqe_req(ctx, req))) {
1496 if (ctx->task_complete) {
1497 spin_lock(&ctx->completion_lock);
1498 io_req_cqe_overflow(req);
1499 spin_unlock(&ctx->completion_lock);
1501 io_req_cqe_overflow(req);
1505 __io_cq_unlock_post_flush(ctx);
1507 if (!wq_list_empty(&ctx->submit_state.compl_reqs)) {
1508 io_free_batch_list(ctx, state->compl_reqs.first);
1509 INIT_WQ_LIST(&state->compl_reqs);
1514 * Drop reference to request, return next in chain (if there is one) if this
1515 * was the last reference to this request.
1517 static inline struct io_kiocb *io_put_req_find_next(struct io_kiocb *req)
1519 struct io_kiocb *nxt = NULL;
1521 if (req_ref_put_and_test(req)) {
1522 if (unlikely(req->flags & IO_REQ_LINK_FLAGS))
1523 nxt = io_req_find_next(req);
1529 static unsigned io_cqring_events(struct io_ring_ctx *ctx)
1531 /* See comment at the top of this file */
1533 return __io_cqring_events(ctx);
1537 * We can't just wait for polled events to come to us, we have to actively
1538 * find and complete them.
1540 static __cold void io_iopoll_try_reap_events(struct io_ring_ctx *ctx)
1542 if (!(ctx->flags & IORING_SETUP_IOPOLL))
1545 mutex_lock(&ctx->uring_lock);
1546 while (!wq_list_empty(&ctx->iopoll_list)) {
1547 /* let it sleep and repeat later if can't complete a request */
1548 if (io_do_iopoll(ctx, true) == 0)
1551 * Ensure we allow local-to-the-cpu processing to take place,
1552 * in this case we need to ensure that we reap all events.
1553 * Also let task_work, etc. to progress by releasing the mutex
1555 if (need_resched()) {
1556 mutex_unlock(&ctx->uring_lock);
1558 mutex_lock(&ctx->uring_lock);
1561 mutex_unlock(&ctx->uring_lock);
1564 static int io_iopoll_check(struct io_ring_ctx *ctx, long min)
1566 unsigned int nr_events = 0;
1568 unsigned long check_cq;
1570 if (!io_allowed_run_tw(ctx))
1573 check_cq = READ_ONCE(ctx->check_cq);
1574 if (unlikely(check_cq)) {
1575 if (check_cq & BIT(IO_CHECK_CQ_OVERFLOW_BIT))
1576 __io_cqring_overflow_flush(ctx);
1578 * Similarly do not spin if we have not informed the user of any
1581 if (check_cq & BIT(IO_CHECK_CQ_DROPPED_BIT))
1585 * Don't enter poll loop if we already have events pending.
1586 * If we do, we can potentially be spinning for commands that
1587 * already triggered a CQE (eg in error).
1589 if (io_cqring_events(ctx))
1594 * If a submit got punted to a workqueue, we can have the
1595 * application entering polling for a command before it gets
1596 * issued. That app will hold the uring_lock for the duration
1597 * of the poll right here, so we need to take a breather every
1598 * now and then to ensure that the issue has a chance to add
1599 * the poll to the issued list. Otherwise we can spin here
1600 * forever, while the workqueue is stuck trying to acquire the
1603 if (wq_list_empty(&ctx->iopoll_list) ||
1604 io_task_work_pending(ctx)) {
1605 u32 tail = ctx->cached_cq_tail;
1607 (void) io_run_local_work_locked(ctx);
1609 if (task_work_pending(current) ||
1610 wq_list_empty(&ctx->iopoll_list)) {
1611 mutex_unlock(&ctx->uring_lock);
1613 mutex_lock(&ctx->uring_lock);
1615 /* some requests don't go through iopoll_list */
1616 if (tail != ctx->cached_cq_tail ||
1617 wq_list_empty(&ctx->iopoll_list))
1620 ret = io_do_iopoll(ctx, !min);
1625 } while (nr_events < min && !need_resched());
1630 void io_req_task_complete(struct io_kiocb *req, bool *locked)
1633 io_req_complete_defer(req);
1635 io_req_complete_post(req, IO_URING_F_UNLOCKED);
1639 * After the iocb has been issued, it's safe to be found on the poll list.
1640 * Adding the kiocb to the list AFTER submission ensures that we don't
1641 * find it from a io_do_iopoll() thread before the issuer is done
1642 * accessing the kiocb cookie.
1644 static void io_iopoll_req_issued(struct io_kiocb *req, unsigned int issue_flags)
1646 struct io_ring_ctx *ctx = req->ctx;
1647 const bool needs_lock = issue_flags & IO_URING_F_UNLOCKED;
1649 /* workqueue context doesn't hold uring_lock, grab it now */
1650 if (unlikely(needs_lock))
1651 mutex_lock(&ctx->uring_lock);
1654 * Track whether we have multiple files in our lists. This will impact
1655 * how we do polling eventually, not spinning if we're on potentially
1656 * different devices.
1658 if (wq_list_empty(&ctx->iopoll_list)) {
1659 ctx->poll_multi_queue = false;
1660 } else if (!ctx->poll_multi_queue) {
1661 struct io_kiocb *list_req;
1663 list_req = container_of(ctx->iopoll_list.first, struct io_kiocb,
1665 if (list_req->file != req->file)
1666 ctx->poll_multi_queue = true;
1670 * For fast devices, IO may have already completed. If it has, add
1671 * it to the front so we find it first.
1673 if (READ_ONCE(req->iopoll_completed))
1674 wq_list_add_head(&req->comp_list, &ctx->iopoll_list);
1676 wq_list_add_tail(&req->comp_list, &ctx->iopoll_list);
1678 if (unlikely(needs_lock)) {
1680 * If IORING_SETUP_SQPOLL is enabled, sqes are either handle
1681 * in sq thread task context or in io worker task context. If
1682 * current task context is sq thread, we don't need to check
1683 * whether should wake up sq thread.
1685 if ((ctx->flags & IORING_SETUP_SQPOLL) &&
1686 wq_has_sleeper(&ctx->sq_data->wait))
1687 wake_up(&ctx->sq_data->wait);
1689 mutex_unlock(&ctx->uring_lock);
1693 static bool io_bdev_nowait(struct block_device *bdev)
1695 return !bdev || bdev_nowait(bdev);
1699 * If we tracked the file through the SCM inflight mechanism, we could support
1700 * any file. For now, just ensure that anything potentially problematic is done
1703 static bool __io_file_supports_nowait(struct file *file, umode_t mode)
1705 if (S_ISBLK(mode)) {
1706 if (IS_ENABLED(CONFIG_BLOCK) &&
1707 io_bdev_nowait(I_BDEV(file->f_mapping->host)))
1713 if (S_ISREG(mode)) {
1714 if (IS_ENABLED(CONFIG_BLOCK) &&
1715 io_bdev_nowait(file->f_inode->i_sb->s_bdev) &&
1716 !io_is_uring_fops(file))
1721 /* any ->read/write should understand O_NONBLOCK */
1722 if (file->f_flags & O_NONBLOCK)
1724 return file->f_mode & FMODE_NOWAIT;
1728 * If we tracked the file through the SCM inflight mechanism, we could support
1729 * any file. For now, just ensure that anything potentially problematic is done
1732 unsigned int io_file_get_flags(struct file *file)
1734 umode_t mode = file_inode(file)->i_mode;
1735 unsigned int res = 0;
1739 if (__io_file_supports_nowait(file, mode))
1744 bool io_alloc_async_data(struct io_kiocb *req)
1746 WARN_ON_ONCE(!io_op_defs[req->opcode].async_size);
1747 req->async_data = kmalloc(io_op_defs[req->opcode].async_size, GFP_KERNEL);
1748 if (req->async_data) {
1749 req->flags |= REQ_F_ASYNC_DATA;
1755 int io_req_prep_async(struct io_kiocb *req)
1757 const struct io_op_def *def = &io_op_defs[req->opcode];
1759 /* assign early for deferred execution for non-fixed file */
1760 if (def->needs_file && !(req->flags & REQ_F_FIXED_FILE))
1761 req->file = io_file_get_normal(req, req->cqe.fd);
1762 if (!def->prep_async)
1764 if (WARN_ON_ONCE(req_has_async_data(req)))
1766 if (!io_op_defs[req->opcode].manual_alloc) {
1767 if (io_alloc_async_data(req))
1770 return def->prep_async(req);
1773 static u32 io_get_sequence(struct io_kiocb *req)
1775 u32 seq = req->ctx->cached_sq_head;
1776 struct io_kiocb *cur;
1778 /* need original cached_sq_head, but it was increased for each req */
1779 io_for_each_link(cur, req)
1784 static __cold void io_drain_req(struct io_kiocb *req)
1785 __must_hold(&ctx->uring_lock)
1787 struct io_ring_ctx *ctx = req->ctx;
1788 struct io_defer_entry *de;
1790 u32 seq = io_get_sequence(req);
1792 /* Still need defer if there is pending req in defer list. */
1793 spin_lock(&ctx->completion_lock);
1794 if (!req_need_defer(req, seq) && list_empty_careful(&ctx->defer_list)) {
1795 spin_unlock(&ctx->completion_lock);
1797 ctx->drain_active = false;
1798 io_req_task_queue(req);
1801 spin_unlock(&ctx->completion_lock);
1803 io_prep_async_link(req);
1804 de = kmalloc(sizeof(*de), GFP_KERNEL);
1807 io_req_defer_failed(req, ret);
1811 spin_lock(&ctx->completion_lock);
1812 if (!req_need_defer(req, seq) && list_empty(&ctx->defer_list)) {
1813 spin_unlock(&ctx->completion_lock);
1818 trace_io_uring_defer(req);
1821 list_add_tail(&de->list, &ctx->defer_list);
1822 spin_unlock(&ctx->completion_lock);
1825 static void io_clean_op(struct io_kiocb *req)
1827 if (req->flags & REQ_F_BUFFER_SELECTED) {
1828 spin_lock(&req->ctx->completion_lock);
1829 io_put_kbuf_comp(req);
1830 spin_unlock(&req->ctx->completion_lock);
1833 if (req->flags & REQ_F_NEED_CLEANUP) {
1834 const struct io_op_def *def = &io_op_defs[req->opcode];
1839 if ((req->flags & REQ_F_POLLED) && req->apoll) {
1840 kfree(req->apoll->double_poll);
1844 if (req->flags & REQ_F_INFLIGHT) {
1845 struct io_uring_task *tctx = req->task->io_uring;
1847 atomic_dec(&tctx->inflight_tracked);
1849 if (req->flags & REQ_F_CREDS)
1850 put_cred(req->creds);
1851 if (req->flags & REQ_F_ASYNC_DATA) {
1852 kfree(req->async_data);
1853 req->async_data = NULL;
1855 req->flags &= ~IO_REQ_CLEAN_FLAGS;
1858 static bool io_assign_file(struct io_kiocb *req, unsigned int issue_flags)
1860 if (req->file || !io_op_defs[req->opcode].needs_file)
1863 if (req->flags & REQ_F_FIXED_FILE)
1864 req->file = io_file_get_fixed(req, req->cqe.fd, issue_flags);
1866 req->file = io_file_get_normal(req, req->cqe.fd);
1871 static int io_issue_sqe(struct io_kiocb *req, unsigned int issue_flags)
1873 const struct io_op_def *def = &io_op_defs[req->opcode];
1874 const struct cred *creds = NULL;
1877 if (unlikely(!io_assign_file(req, issue_flags)))
1880 if (unlikely((req->flags & REQ_F_CREDS) && req->creds != current_cred()))
1881 creds = override_creds(req->creds);
1883 if (!def->audit_skip)
1884 audit_uring_entry(req->opcode);
1886 ret = def->issue(req, issue_flags);
1888 if (!def->audit_skip)
1889 audit_uring_exit(!ret, ret);
1892 revert_creds(creds);
1894 if (ret == IOU_OK) {
1895 if (issue_flags & IO_URING_F_COMPLETE_DEFER)
1896 io_req_complete_defer(req);
1898 io_req_complete_post(req, issue_flags);
1899 } else if (ret != IOU_ISSUE_SKIP_COMPLETE)
1902 /* If the op doesn't have a file, we're not polling for it */
1903 if ((req->ctx->flags & IORING_SETUP_IOPOLL) && def->iopoll_queue)
1904 io_iopoll_req_issued(req, issue_flags);
1909 int io_poll_issue(struct io_kiocb *req, bool *locked)
1911 io_tw_lock(req->ctx, locked);
1912 return io_issue_sqe(req, IO_URING_F_NONBLOCK|IO_URING_F_MULTISHOT|
1913 IO_URING_F_COMPLETE_DEFER);
1916 struct io_wq_work *io_wq_free_work(struct io_wq_work *work)
1918 struct io_kiocb *req = container_of(work, struct io_kiocb, work);
1920 req = io_put_req_find_next(req);
1921 return req ? &req->work : NULL;
1924 void io_wq_submit_work(struct io_wq_work *work)
1926 struct io_kiocb *req = container_of(work, struct io_kiocb, work);
1927 const struct io_op_def *def = &io_op_defs[req->opcode];
1928 unsigned int issue_flags = IO_URING_F_UNLOCKED | IO_URING_F_IOWQ;
1929 bool needs_poll = false;
1930 int ret = 0, err = -ECANCELED;
1932 /* one will be dropped by ->io_wq_free_work() after returning to io-wq */
1933 if (!(req->flags & REQ_F_REFCOUNT))
1934 __io_req_set_refcount(req, 2);
1938 io_arm_ltimeout(req);
1940 /* either cancelled or io-wq is dying, so don't touch tctx->iowq */
1941 if (work->flags & IO_WQ_WORK_CANCEL) {
1943 io_req_task_queue_fail(req, err);
1946 if (!io_assign_file(req, issue_flags)) {
1948 work->flags |= IO_WQ_WORK_CANCEL;
1952 if (req->flags & REQ_F_FORCE_ASYNC) {
1953 bool opcode_poll = def->pollin || def->pollout;
1955 if (opcode_poll && file_can_poll(req->file)) {
1957 issue_flags |= IO_URING_F_NONBLOCK;
1962 ret = io_issue_sqe(req, issue_flags);
1966 * We can get EAGAIN for iopolled IO even though we're
1967 * forcing a sync submission from here, since we can't
1968 * wait for request slots on the block side.
1971 if (!(req->ctx->flags & IORING_SETUP_IOPOLL))
1977 if (io_arm_poll_handler(req, issue_flags) == IO_APOLL_OK)
1979 /* aborted or ready, in either case retry blocking */
1981 issue_flags &= ~IO_URING_F_NONBLOCK;
1984 /* avoid locking problems by failing it from a clean context */
1986 io_req_task_queue_fail(req, ret);
1989 inline struct file *io_file_get_fixed(struct io_kiocb *req, int fd,
1990 unsigned int issue_flags)
1992 struct io_ring_ctx *ctx = req->ctx;
1993 struct file *file = NULL;
1994 unsigned long file_ptr;
1996 io_ring_submit_lock(ctx, issue_flags);
1998 if (unlikely((unsigned int)fd >= ctx->nr_user_files))
2000 fd = array_index_nospec(fd, ctx->nr_user_files);
2001 file_ptr = io_fixed_file_slot(&ctx->file_table, fd)->file_ptr;
2002 file = (struct file *) (file_ptr & FFS_MASK);
2003 file_ptr &= ~FFS_MASK;
2004 /* mask in overlapping REQ_F and FFS bits */
2005 req->flags |= (file_ptr << REQ_F_SUPPORT_NOWAIT_BIT);
2006 io_req_set_rsrc_node(req, ctx, 0);
2008 io_ring_submit_unlock(ctx, issue_flags);
2012 struct file *io_file_get_normal(struct io_kiocb *req, int fd)
2014 struct file *file = fget(fd);
2016 trace_io_uring_file_get(req, fd);
2018 /* we don't allow fixed io_uring files */
2019 if (file && io_is_uring_fops(file))
2020 io_req_track_inflight(req);
2024 static void io_queue_async(struct io_kiocb *req, int ret)
2025 __must_hold(&req->ctx->uring_lock)
2027 struct io_kiocb *linked_timeout;
2029 if (ret != -EAGAIN || (req->flags & REQ_F_NOWAIT)) {
2030 io_req_defer_failed(req, ret);
2034 linked_timeout = io_prep_linked_timeout(req);
2036 switch (io_arm_poll_handler(req, 0)) {
2037 case IO_APOLL_READY:
2038 io_kbuf_recycle(req, 0);
2039 io_req_task_queue(req);
2041 case IO_APOLL_ABORTED:
2042 io_kbuf_recycle(req, 0);
2043 io_queue_iowq(req, NULL);
2050 io_queue_linked_timeout(linked_timeout);
2053 static inline void io_queue_sqe(struct io_kiocb *req)
2054 __must_hold(&req->ctx->uring_lock)
2058 ret = io_issue_sqe(req, IO_URING_F_NONBLOCK|IO_URING_F_COMPLETE_DEFER);
2061 * We async punt it if the file wasn't marked NOWAIT, or if the file
2062 * doesn't support non-blocking read/write attempts
2065 io_arm_ltimeout(req);
2067 io_queue_async(req, ret);
2070 static void io_queue_sqe_fallback(struct io_kiocb *req)
2071 __must_hold(&req->ctx->uring_lock)
2073 if (unlikely(req->flags & REQ_F_FAIL)) {
2075 * We don't submit, fail them all, for that replace hardlinks
2076 * with normal links. Extra REQ_F_LINK is tolerated.
2078 req->flags &= ~REQ_F_HARDLINK;
2079 req->flags |= REQ_F_LINK;
2080 io_req_defer_failed(req, req->cqe.res);
2082 int ret = io_req_prep_async(req);
2084 if (unlikely(ret)) {
2085 io_req_defer_failed(req, ret);
2089 if (unlikely(req->ctx->drain_active))
2092 io_queue_iowq(req, NULL);
2097 * Check SQE restrictions (opcode and flags).
2099 * Returns 'true' if SQE is allowed, 'false' otherwise.
2101 static inline bool io_check_restriction(struct io_ring_ctx *ctx,
2102 struct io_kiocb *req,
2103 unsigned int sqe_flags)
2105 if (!test_bit(req->opcode, ctx->restrictions.sqe_op))
2108 if ((sqe_flags & ctx->restrictions.sqe_flags_required) !=
2109 ctx->restrictions.sqe_flags_required)
2112 if (sqe_flags & ~(ctx->restrictions.sqe_flags_allowed |
2113 ctx->restrictions.sqe_flags_required))
2119 static void io_init_req_drain(struct io_kiocb *req)
2121 struct io_ring_ctx *ctx = req->ctx;
2122 struct io_kiocb *head = ctx->submit_state.link.head;
2124 ctx->drain_active = true;
2127 * If we need to drain a request in the middle of a link, drain
2128 * the head request and the next request/link after the current
2129 * link. Considering sequential execution of links,
2130 * REQ_F_IO_DRAIN will be maintained for every request of our
2133 head->flags |= REQ_F_IO_DRAIN | REQ_F_FORCE_ASYNC;
2134 ctx->drain_next = true;
2138 static int io_init_req(struct io_ring_ctx *ctx, struct io_kiocb *req,
2139 const struct io_uring_sqe *sqe)
2140 __must_hold(&ctx->uring_lock)
2142 const struct io_op_def *def;
2143 unsigned int sqe_flags;
2147 /* req is partially pre-initialised, see io_preinit_req() */
2148 req->opcode = opcode = READ_ONCE(sqe->opcode);
2149 /* same numerical values with corresponding REQ_F_*, safe to copy */
2150 req->flags = sqe_flags = READ_ONCE(sqe->flags);
2151 req->cqe.user_data = READ_ONCE(sqe->user_data);
2153 req->rsrc_node = NULL;
2154 req->task = current;
2156 if (unlikely(opcode >= IORING_OP_LAST)) {
2160 def = &io_op_defs[opcode];
2161 if (unlikely(sqe_flags & ~SQE_COMMON_FLAGS)) {
2162 /* enforce forwards compatibility on users */
2163 if (sqe_flags & ~SQE_VALID_FLAGS)
2165 if (sqe_flags & IOSQE_BUFFER_SELECT) {
2166 if (!def->buffer_select)
2168 req->buf_index = READ_ONCE(sqe->buf_group);
2170 if (sqe_flags & IOSQE_CQE_SKIP_SUCCESS)
2171 ctx->drain_disabled = true;
2172 if (sqe_flags & IOSQE_IO_DRAIN) {
2173 if (ctx->drain_disabled)
2175 io_init_req_drain(req);
2178 if (unlikely(ctx->restricted || ctx->drain_active || ctx->drain_next)) {
2179 if (ctx->restricted && !io_check_restriction(ctx, req, sqe_flags))
2181 /* knock it to the slow queue path, will be drained there */
2182 if (ctx->drain_active)
2183 req->flags |= REQ_F_FORCE_ASYNC;
2184 /* if there is no link, we're at "next" request and need to drain */
2185 if (unlikely(ctx->drain_next) && !ctx->submit_state.link.head) {
2186 ctx->drain_next = false;
2187 ctx->drain_active = true;
2188 req->flags |= REQ_F_IO_DRAIN | REQ_F_FORCE_ASYNC;
2192 if (!def->ioprio && sqe->ioprio)
2194 if (!def->iopoll && (ctx->flags & IORING_SETUP_IOPOLL))
2197 if (def->needs_file) {
2198 struct io_submit_state *state = &ctx->submit_state;
2200 req->cqe.fd = READ_ONCE(sqe->fd);
2203 * Plug now if we have more than 2 IO left after this, and the
2204 * target is potentially a read/write to block based storage.
2206 if (state->need_plug && def->plug) {
2207 state->plug_started = true;
2208 state->need_plug = false;
2209 blk_start_plug_nr_ios(&state->plug, state->submit_nr);
2213 personality = READ_ONCE(sqe->personality);
2217 req->creds = xa_load(&ctx->personalities, personality);
2220 get_cred(req->creds);
2221 ret = security_uring_override_creds(req->creds);
2223 put_cred(req->creds);
2226 req->flags |= REQ_F_CREDS;
2229 return def->prep(req, sqe);
2232 static __cold int io_submit_fail_init(const struct io_uring_sqe *sqe,
2233 struct io_kiocb *req, int ret)
2235 struct io_ring_ctx *ctx = req->ctx;
2236 struct io_submit_link *link = &ctx->submit_state.link;
2237 struct io_kiocb *head = link->head;
2239 trace_io_uring_req_failed(sqe, req, ret);
2242 * Avoid breaking links in the middle as it renders links with SQPOLL
2243 * unusable. Instead of failing eagerly, continue assembling the link if
2244 * applicable and mark the head with REQ_F_FAIL. The link flushing code
2245 * should find the flag and handle the rest.
2247 req_fail_link_node(req, ret);
2248 if (head && !(head->flags & REQ_F_FAIL))
2249 req_fail_link_node(head, -ECANCELED);
2251 if (!(req->flags & IO_REQ_LINK_FLAGS)) {
2253 link->last->link = req;
2257 io_queue_sqe_fallback(req);
2262 link->last->link = req;
2269 static inline int io_submit_sqe(struct io_ring_ctx *ctx, struct io_kiocb *req,
2270 const struct io_uring_sqe *sqe)
2271 __must_hold(&ctx->uring_lock)
2273 struct io_submit_link *link = &ctx->submit_state.link;
2276 ret = io_init_req(ctx, req, sqe);
2278 return io_submit_fail_init(sqe, req, ret);
2280 /* don't need @sqe from now on */
2281 trace_io_uring_submit_sqe(req, true);
2284 * If we already have a head request, queue this one for async
2285 * submittal once the head completes. If we don't have a head but
2286 * IOSQE_IO_LINK is set in the sqe, start a new head. This one will be
2287 * submitted sync once the chain is complete. If none of those
2288 * conditions are true (normal request), then just queue it.
2290 if (unlikely(link->head)) {
2291 ret = io_req_prep_async(req);
2293 return io_submit_fail_init(sqe, req, ret);
2295 trace_io_uring_link(req, link->head);
2296 link->last->link = req;
2299 if (req->flags & IO_REQ_LINK_FLAGS)
2301 /* last request of the link, flush it */
2304 if (req->flags & (REQ_F_FORCE_ASYNC | REQ_F_FAIL))
2307 } else if (unlikely(req->flags & (IO_REQ_LINK_FLAGS |
2308 REQ_F_FORCE_ASYNC | REQ_F_FAIL))) {
2309 if (req->flags & IO_REQ_LINK_FLAGS) {
2314 io_queue_sqe_fallback(req);
2324 * Batched submission is done, ensure local IO is flushed out.
2326 static void io_submit_state_end(struct io_ring_ctx *ctx)
2328 struct io_submit_state *state = &ctx->submit_state;
2330 if (unlikely(state->link.head))
2331 io_queue_sqe_fallback(state->link.head);
2332 /* flush only after queuing links as they can generate completions */
2333 io_submit_flush_completions(ctx);
2334 if (state->plug_started)
2335 blk_finish_plug(&state->plug);
2339 * Start submission side cache.
2341 static void io_submit_state_start(struct io_submit_state *state,
2342 unsigned int max_ios)
2344 state->plug_started = false;
2345 state->need_plug = max_ios > 2;
2346 state->submit_nr = max_ios;
2347 /* set only head, no need to init link_last in advance */
2348 state->link.head = NULL;
2351 static void io_commit_sqring(struct io_ring_ctx *ctx)
2353 struct io_rings *rings = ctx->rings;
2356 * Ensure any loads from the SQEs are done at this point,
2357 * since once we write the new head, the application could
2358 * write new data to them.
2360 smp_store_release(&rings->sq.head, ctx->cached_sq_head);
2364 * Fetch an sqe, if one is available. Note this returns a pointer to memory
2365 * that is mapped by userspace. This means that care needs to be taken to
2366 * ensure that reads are stable, as we cannot rely on userspace always
2367 * being a good citizen. If members of the sqe are validated and then later
2368 * used, it's important that those reads are done through READ_ONCE() to
2369 * prevent a re-load down the line.
2371 static const struct io_uring_sqe *io_get_sqe(struct io_ring_ctx *ctx)
2373 unsigned head, mask = ctx->sq_entries - 1;
2374 unsigned sq_idx = ctx->cached_sq_head++ & mask;
2377 * The cached sq head (or cq tail) serves two purposes:
2379 * 1) allows us to batch the cost of updating the user visible
2381 * 2) allows the kernel side to track the head on its own, even
2382 * though the application is the one updating it.
2384 head = READ_ONCE(ctx->sq_array[sq_idx]);
2385 if (likely(head < ctx->sq_entries)) {
2386 /* double index for 128-byte SQEs, twice as long */
2387 if (ctx->flags & IORING_SETUP_SQE128)
2389 return &ctx->sq_sqes[head];
2392 /* drop invalid entries */
2394 WRITE_ONCE(ctx->rings->sq_dropped,
2395 READ_ONCE(ctx->rings->sq_dropped) + 1);
2399 int io_submit_sqes(struct io_ring_ctx *ctx, unsigned int nr)
2400 __must_hold(&ctx->uring_lock)
2402 unsigned int entries = io_sqring_entries(ctx);
2406 if (unlikely(!entries))
2408 /* make sure SQ entry isn't read before tail */
2409 ret = left = min3(nr, ctx->sq_entries, entries);
2410 io_get_task_refs(left);
2411 io_submit_state_start(&ctx->submit_state, left);
2414 const struct io_uring_sqe *sqe;
2415 struct io_kiocb *req;
2417 if (unlikely(!io_alloc_req_refill(ctx)))
2419 req = io_alloc_req(ctx);
2420 sqe = io_get_sqe(ctx);
2421 if (unlikely(!sqe)) {
2422 io_req_add_to_cache(req, ctx);
2427 * Continue submitting even for sqe failure if the
2428 * ring was setup with IORING_SETUP_SUBMIT_ALL
2430 if (unlikely(io_submit_sqe(ctx, req, sqe)) &&
2431 !(ctx->flags & IORING_SETUP_SUBMIT_ALL)) {
2437 if (unlikely(left)) {
2439 /* try again if it submitted nothing and can't allocate a req */
2440 if (!ret && io_req_cache_empty(ctx))
2442 current->io_uring->cached_refs += left;
2445 io_submit_state_end(ctx);
2446 /* Commit SQ ring head once we've consumed and submitted all SQEs */
2447 io_commit_sqring(ctx);
2451 struct io_wait_queue {
2452 struct wait_queue_entry wq;
2453 struct io_ring_ctx *ctx;
2455 unsigned nr_timeouts;
2459 static inline bool io_has_work(struct io_ring_ctx *ctx)
2461 return test_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq) ||
2462 !llist_empty(&ctx->work_llist);
2465 static inline bool io_should_wake(struct io_wait_queue *iowq)
2467 struct io_ring_ctx *ctx = iowq->ctx;
2468 int dist = READ_ONCE(ctx->rings->cq.tail) - (int) iowq->cq_tail;
2471 * Wake up if we have enough events, or if a timeout occurred since we
2472 * started waiting. For timeouts, we always want to return to userspace,
2473 * regardless of event count.
2475 return dist >= 0 || atomic_read(&ctx->cq_timeouts) != iowq->nr_timeouts;
2478 static int io_wake_function(struct wait_queue_entry *curr, unsigned int mode,
2479 int wake_flags, void *key)
2481 struct io_wait_queue *iowq = container_of(curr, struct io_wait_queue, wq);
2484 * Cannot safely flush overflowed CQEs from here, ensure we wake up
2485 * the task, and the next invocation will do it.
2487 if (io_should_wake(iowq) || io_has_work(iowq->ctx))
2488 return autoremove_wake_function(curr, mode, wake_flags, key);
2492 int io_run_task_work_sig(struct io_ring_ctx *ctx)
2494 if (!llist_empty(&ctx->work_llist)) {
2495 __set_current_state(TASK_RUNNING);
2496 if (io_run_local_work(ctx) > 0)
2499 if (io_run_task_work() > 0)
2501 if (task_sigpending(current))
2506 /* when returns >0, the caller should retry */
2507 static inline int io_cqring_wait_schedule(struct io_ring_ctx *ctx,
2508 struct io_wait_queue *iowq)
2510 if (unlikely(READ_ONCE(ctx->check_cq)))
2512 if (unlikely(!llist_empty(&ctx->work_llist)))
2514 if (unlikely(test_thread_flag(TIF_NOTIFY_SIGNAL)))
2516 if (unlikely(task_sigpending(current)))
2518 if (unlikely(io_should_wake(iowq)))
2520 if (iowq->timeout == KTIME_MAX)
2522 else if (!schedule_hrtimeout(&iowq->timeout, HRTIMER_MODE_ABS))
2528 * Wait until events become available, if we don't already have some. The
2529 * application must reap them itself, as they reside on the shared cq ring.
2531 static int io_cqring_wait(struct io_ring_ctx *ctx, int min_events,
2532 const sigset_t __user *sig, size_t sigsz,
2533 struct __kernel_timespec __user *uts)
2535 struct io_wait_queue iowq;
2536 struct io_rings *rings = ctx->rings;
2539 if (!io_allowed_run_tw(ctx))
2541 if (!llist_empty(&ctx->work_llist))
2542 io_run_local_work(ctx);
2544 io_cqring_overflow_flush(ctx);
2545 /* if user messes with these they will just get an early return */
2546 if (__io_cqring_events_user(ctx) >= min_events)
2550 #ifdef CONFIG_COMPAT
2551 if (in_compat_syscall())
2552 ret = set_compat_user_sigmask((const compat_sigset_t __user *)sig,
2556 ret = set_user_sigmask(sig, sigsz);
2562 init_waitqueue_func_entry(&iowq.wq, io_wake_function);
2563 iowq.wq.private = current;
2564 INIT_LIST_HEAD(&iowq.wq.entry);
2566 iowq.nr_timeouts = atomic_read(&ctx->cq_timeouts);
2567 iowq.cq_tail = READ_ONCE(ctx->rings->cq.head) + min_events;
2568 iowq.timeout = KTIME_MAX;
2571 struct timespec64 ts;
2573 if (get_timespec64(&ts, uts))
2575 iowq.timeout = ktime_add_ns(timespec64_to_ktime(ts), ktime_get_ns());
2578 trace_io_uring_cqring_wait(ctx, min_events);
2580 unsigned long check_cq;
2582 if (ctx->flags & IORING_SETUP_DEFER_TASKRUN) {
2583 WRITE_ONCE(ctx->cq_waiting, 1);
2584 set_current_state(TASK_INTERRUPTIBLE);
2586 prepare_to_wait_exclusive(&ctx->cq_wait, &iowq.wq,
2587 TASK_INTERRUPTIBLE);
2590 ret = io_cqring_wait_schedule(ctx, &iowq);
2591 __set_current_state(TASK_RUNNING);
2592 WRITE_ONCE(ctx->cq_waiting, 0);
2597 * Run task_work after scheduling and before io_should_wake().
2598 * If we got woken because of task_work being processed, run it
2599 * now rather than let the caller do another wait loop.
2602 if (!llist_empty(&ctx->work_llist))
2603 io_run_local_work(ctx);
2605 check_cq = READ_ONCE(ctx->check_cq);
2606 if (unlikely(check_cq)) {
2607 /* let the caller flush overflows, retry */
2608 if (check_cq & BIT(IO_CHECK_CQ_OVERFLOW_BIT))
2609 io_cqring_do_overflow_flush(ctx);
2610 if (check_cq & BIT(IO_CHECK_CQ_DROPPED_BIT)) {
2616 if (io_should_wake(&iowq)) {
2623 if (!(ctx->flags & IORING_SETUP_DEFER_TASKRUN))
2624 finish_wait(&ctx->cq_wait, &iowq.wq);
2625 restore_saved_sigmask_unless(ret == -EINTR);
2627 return READ_ONCE(rings->cq.head) == READ_ONCE(rings->cq.tail) ? ret : 0;
2630 static void io_mem_free(void *ptr)
2637 page = virt_to_head_page(ptr);
2638 if (put_page_testzero(page))
2639 free_compound_page(page);
2642 static void *io_mem_alloc(size_t size)
2644 gfp_t gfp = GFP_KERNEL_ACCOUNT | __GFP_ZERO | __GFP_NOWARN | __GFP_COMP;
2646 return (void *) __get_free_pages(gfp, get_order(size));
2649 static unsigned long rings_size(struct io_ring_ctx *ctx, unsigned int sq_entries,
2650 unsigned int cq_entries, size_t *sq_offset)
2652 struct io_rings *rings;
2653 size_t off, sq_array_size;
2655 off = struct_size(rings, cqes, cq_entries);
2656 if (off == SIZE_MAX)
2658 if (ctx->flags & IORING_SETUP_CQE32) {
2659 if (check_shl_overflow(off, 1, &off))
2664 off = ALIGN(off, SMP_CACHE_BYTES);
2672 sq_array_size = array_size(sizeof(u32), sq_entries);
2673 if (sq_array_size == SIZE_MAX)
2676 if (check_add_overflow(off, sq_array_size, &off))
2682 static int io_eventfd_register(struct io_ring_ctx *ctx, void __user *arg,
2683 unsigned int eventfd_async)
2685 struct io_ev_fd *ev_fd;
2686 __s32 __user *fds = arg;
2689 ev_fd = rcu_dereference_protected(ctx->io_ev_fd,
2690 lockdep_is_held(&ctx->uring_lock));
2694 if (copy_from_user(&fd, fds, sizeof(*fds)))
2697 ev_fd = kmalloc(sizeof(*ev_fd), GFP_KERNEL);
2701 ev_fd->cq_ev_fd = eventfd_ctx_fdget(fd);
2702 if (IS_ERR(ev_fd->cq_ev_fd)) {
2703 int ret = PTR_ERR(ev_fd->cq_ev_fd);
2708 spin_lock(&ctx->completion_lock);
2709 ctx->evfd_last_cq_tail = ctx->cached_cq_tail;
2710 spin_unlock(&ctx->completion_lock);
2712 ev_fd->eventfd_async = eventfd_async;
2713 ctx->has_evfd = true;
2714 rcu_assign_pointer(ctx->io_ev_fd, ev_fd);
2715 atomic_set(&ev_fd->refs, 1);
2716 atomic_set(&ev_fd->ops, 0);
2720 static int io_eventfd_unregister(struct io_ring_ctx *ctx)
2722 struct io_ev_fd *ev_fd;
2724 ev_fd = rcu_dereference_protected(ctx->io_ev_fd,
2725 lockdep_is_held(&ctx->uring_lock));
2727 ctx->has_evfd = false;
2728 rcu_assign_pointer(ctx->io_ev_fd, NULL);
2729 if (!atomic_fetch_or(BIT(IO_EVENTFD_OP_FREE_BIT), &ev_fd->ops))
2730 call_rcu(&ev_fd->rcu, io_eventfd_ops);
2737 static void io_req_caches_free(struct io_ring_ctx *ctx)
2741 mutex_lock(&ctx->uring_lock);
2742 io_flush_cached_locked_reqs(ctx, &ctx->submit_state);
2744 while (!io_req_cache_empty(ctx)) {
2745 struct io_kiocb *req = io_alloc_req(ctx);
2747 kmem_cache_free(req_cachep, req);
2751 percpu_ref_put_many(&ctx->refs, nr);
2752 mutex_unlock(&ctx->uring_lock);
2755 static __cold void io_ring_ctx_free(struct io_ring_ctx *ctx)
2757 io_sq_thread_finish(ctx);
2758 io_rsrc_refs_drop(ctx);
2759 /* __io_rsrc_put_work() may need uring_lock to progress, wait w/o it */
2760 io_wait_rsrc_data(ctx->buf_data);
2761 io_wait_rsrc_data(ctx->file_data);
2763 mutex_lock(&ctx->uring_lock);
2765 __io_sqe_buffers_unregister(ctx);
2767 __io_sqe_files_unregister(ctx);
2768 io_cqring_overflow_kill(ctx);
2769 io_eventfd_unregister(ctx);
2770 io_alloc_cache_free(&ctx->apoll_cache, io_apoll_cache_free);
2771 io_alloc_cache_free(&ctx->netmsg_cache, io_netmsg_cache_free);
2772 mutex_unlock(&ctx->uring_lock);
2773 io_destroy_buffers(ctx);
2775 put_cred(ctx->sq_creds);
2776 if (ctx->submitter_task)
2777 put_task_struct(ctx->submitter_task);
2779 /* there are no registered resources left, nobody uses it */
2781 io_rsrc_node_destroy(ctx->rsrc_node);
2782 if (ctx->rsrc_backup_node)
2783 io_rsrc_node_destroy(ctx->rsrc_backup_node);
2784 flush_delayed_work(&ctx->rsrc_put_work);
2785 flush_delayed_work(&ctx->fallback_work);
2787 WARN_ON_ONCE(!list_empty(&ctx->rsrc_ref_list));
2788 WARN_ON_ONCE(!llist_empty(&ctx->rsrc_put_llist));
2790 #if defined(CONFIG_UNIX)
2791 if (ctx->ring_sock) {
2792 ctx->ring_sock->file = NULL; /* so that iput() is called */
2793 sock_release(ctx->ring_sock);
2796 WARN_ON_ONCE(!list_empty(&ctx->ltimeout_list));
2798 if (ctx->mm_account) {
2799 mmdrop(ctx->mm_account);
2800 ctx->mm_account = NULL;
2802 io_mem_free(ctx->rings);
2803 io_mem_free(ctx->sq_sqes);
2805 percpu_ref_exit(&ctx->refs);
2806 free_uid(ctx->user);
2807 io_req_caches_free(ctx);
2809 io_wq_put_hash(ctx->hash_map);
2810 kfree(ctx->cancel_table.hbs);
2811 kfree(ctx->cancel_table_locked.hbs);
2812 kfree(ctx->dummy_ubuf);
2814 xa_destroy(&ctx->io_bl_xa);
2818 static __cold void io_activate_pollwq_cb(struct callback_head *cb)
2820 struct io_ring_ctx *ctx = container_of(cb, struct io_ring_ctx,
2823 mutex_lock(&ctx->uring_lock);
2824 ctx->poll_activated = true;
2825 mutex_unlock(&ctx->uring_lock);
2828 * Wake ups for some events between start of polling and activation
2829 * might've been lost due to loose synchronisation.
2831 wake_up_all(&ctx->poll_wq);
2832 percpu_ref_put(&ctx->refs);
2835 static __cold void io_activate_pollwq(struct io_ring_ctx *ctx)
2837 spin_lock(&ctx->completion_lock);
2838 /* already activated or in progress */
2839 if (ctx->poll_activated || ctx->poll_wq_task_work.func)
2841 if (WARN_ON_ONCE(!ctx->task_complete))
2843 if (!ctx->submitter_task)
2846 * with ->submitter_task only the submitter task completes requests, we
2847 * only need to sync with it, which is done by injecting a tw
2849 init_task_work(&ctx->poll_wq_task_work, io_activate_pollwq_cb);
2850 percpu_ref_get(&ctx->refs);
2851 if (task_work_add(ctx->submitter_task, &ctx->poll_wq_task_work, TWA_SIGNAL))
2852 percpu_ref_put(&ctx->refs);
2854 spin_unlock(&ctx->completion_lock);
2857 static __poll_t io_uring_poll(struct file *file, poll_table *wait)
2859 struct io_ring_ctx *ctx = file->private_data;
2862 if (unlikely(!ctx->poll_activated))
2863 io_activate_pollwq(ctx);
2865 poll_wait(file, &ctx->poll_wq, wait);
2867 * synchronizes with barrier from wq_has_sleeper call in
2871 if (!io_sqring_full(ctx))
2872 mask |= EPOLLOUT | EPOLLWRNORM;
2875 * Don't flush cqring overflow list here, just do a simple check.
2876 * Otherwise there could possible be ABBA deadlock:
2879 * lock(&ctx->uring_lock);
2881 * lock(&ctx->uring_lock);
2884 * Users may get EPOLLIN meanwhile seeing nothing in cqring, this
2885 * pushes them to do the flush.
2888 if (io_cqring_events(ctx) || io_has_work(ctx))
2889 mask |= EPOLLIN | EPOLLRDNORM;
2894 static int io_unregister_personality(struct io_ring_ctx *ctx, unsigned id)
2896 const struct cred *creds;
2898 creds = xa_erase(&ctx->personalities, id);
2907 struct io_tctx_exit {
2908 struct callback_head task_work;
2909 struct completion completion;
2910 struct io_ring_ctx *ctx;
2913 static __cold void io_tctx_exit_cb(struct callback_head *cb)
2915 struct io_uring_task *tctx = current->io_uring;
2916 struct io_tctx_exit *work;
2918 work = container_of(cb, struct io_tctx_exit, task_work);
2920 * When @in_idle, we're in cancellation and it's racy to remove the
2921 * node. It'll be removed by the end of cancellation, just ignore it.
2922 * tctx can be NULL if the queueing of this task_work raced with
2923 * work cancelation off the exec path.
2925 if (tctx && !atomic_read(&tctx->in_idle))
2926 io_uring_del_tctx_node((unsigned long)work->ctx);
2927 complete(&work->completion);
2930 static __cold bool io_cancel_ctx_cb(struct io_wq_work *work, void *data)
2932 struct io_kiocb *req = container_of(work, struct io_kiocb, work);
2934 return req->ctx == data;
2937 static __cold void io_ring_exit_work(struct work_struct *work)
2939 struct io_ring_ctx *ctx = container_of(work, struct io_ring_ctx, exit_work);
2940 unsigned long timeout = jiffies + HZ * 60 * 5;
2941 unsigned long interval = HZ / 20;
2942 struct io_tctx_exit exit;
2943 struct io_tctx_node *node;
2947 * If we're doing polled IO and end up having requests being
2948 * submitted async (out-of-line), then completions can come in while
2949 * we're waiting for refs to drop. We need to reap these manually,
2950 * as nobody else will be looking for them.
2953 if (test_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq)) {
2954 mutex_lock(&ctx->uring_lock);
2955 io_cqring_overflow_kill(ctx);
2956 mutex_unlock(&ctx->uring_lock);
2959 if (ctx->flags & IORING_SETUP_DEFER_TASKRUN)
2960 io_move_task_work_from_local(ctx);
2962 while (io_uring_try_cancel_requests(ctx, NULL, true))
2966 struct io_sq_data *sqd = ctx->sq_data;
2967 struct task_struct *tsk;
2969 io_sq_thread_park(sqd);
2971 if (tsk && tsk->io_uring && tsk->io_uring->io_wq)
2972 io_wq_cancel_cb(tsk->io_uring->io_wq,
2973 io_cancel_ctx_cb, ctx, true);
2974 io_sq_thread_unpark(sqd);
2977 io_req_caches_free(ctx);
2979 if (WARN_ON_ONCE(time_after(jiffies, timeout))) {
2980 /* there is little hope left, don't run it too often */
2983 } while (!wait_for_completion_timeout(&ctx->ref_comp, interval));
2985 init_completion(&exit.completion);
2986 init_task_work(&exit.task_work, io_tctx_exit_cb);
2989 * Some may use context even when all refs and requests have been put,
2990 * and they are free to do so while still holding uring_lock or
2991 * completion_lock, see io_req_task_submit(). Apart from other work,
2992 * this lock/unlock section also waits them to finish.
2994 mutex_lock(&ctx->uring_lock);
2995 while (!list_empty(&ctx->tctx_list)) {
2996 WARN_ON_ONCE(time_after(jiffies, timeout));
2998 node = list_first_entry(&ctx->tctx_list, struct io_tctx_node,
3000 /* don't spin on a single task if cancellation failed */
3001 list_rotate_left(&ctx->tctx_list);
3002 ret = task_work_add(node->task, &exit.task_work, TWA_SIGNAL);
3003 if (WARN_ON_ONCE(ret))
3006 mutex_unlock(&ctx->uring_lock);
3007 wait_for_completion(&exit.completion);
3008 mutex_lock(&ctx->uring_lock);
3010 mutex_unlock(&ctx->uring_lock);
3011 spin_lock(&ctx->completion_lock);
3012 spin_unlock(&ctx->completion_lock);
3014 io_ring_ctx_free(ctx);
3017 static __cold void io_ring_ctx_wait_and_kill(struct io_ring_ctx *ctx)
3019 unsigned long index;
3020 struct creds *creds;
3022 mutex_lock(&ctx->uring_lock);
3023 percpu_ref_kill(&ctx->refs);
3024 xa_for_each(&ctx->personalities, index, creds)
3025 io_unregister_personality(ctx, index);
3027 io_poll_remove_all(ctx, NULL, true);
3028 mutex_unlock(&ctx->uring_lock);
3031 * If we failed setting up the ctx, we might not have any rings
3032 * and therefore did not submit any requests
3035 io_kill_timeouts(ctx, NULL, true);
3037 INIT_WORK(&ctx->exit_work, io_ring_exit_work);
3039 * Use system_unbound_wq to avoid spawning tons of event kworkers
3040 * if we're exiting a ton of rings at the same time. It just adds
3041 * noise and overhead, there's no discernable change in runtime
3042 * over using system_wq.
3044 queue_work(system_unbound_wq, &ctx->exit_work);
3047 static int io_uring_release(struct inode *inode, struct file *file)
3049 struct io_ring_ctx *ctx = file->private_data;
3051 file->private_data = NULL;
3052 io_ring_ctx_wait_and_kill(ctx);
3056 struct io_task_cancel {
3057 struct task_struct *task;
3061 static bool io_cancel_task_cb(struct io_wq_work *work, void *data)
3063 struct io_kiocb *req = container_of(work, struct io_kiocb, work);
3064 struct io_task_cancel *cancel = data;
3066 return io_match_task_safe(req, cancel->task, cancel->all);
3069 static __cold bool io_cancel_defer_files(struct io_ring_ctx *ctx,
3070 struct task_struct *task,
3073 struct io_defer_entry *de;
3076 spin_lock(&ctx->completion_lock);
3077 list_for_each_entry_reverse(de, &ctx->defer_list, list) {
3078 if (io_match_task_safe(de->req, task, cancel_all)) {
3079 list_cut_position(&list, &ctx->defer_list, &de->list);
3083 spin_unlock(&ctx->completion_lock);
3084 if (list_empty(&list))
3087 while (!list_empty(&list)) {
3088 de = list_first_entry(&list, struct io_defer_entry, list);
3089 list_del_init(&de->list);
3090 io_req_task_queue_fail(de->req, -ECANCELED);
3096 static __cold bool io_uring_try_cancel_iowq(struct io_ring_ctx *ctx)
3098 struct io_tctx_node *node;
3099 enum io_wq_cancel cret;
3102 mutex_lock(&ctx->uring_lock);
3103 list_for_each_entry(node, &ctx->tctx_list, ctx_node) {
3104 struct io_uring_task *tctx = node->task->io_uring;
3107 * io_wq will stay alive while we hold uring_lock, because it's
3108 * killed after ctx nodes, which requires to take the lock.
3110 if (!tctx || !tctx->io_wq)
3112 cret = io_wq_cancel_cb(tctx->io_wq, io_cancel_ctx_cb, ctx, true);
3113 ret |= (cret != IO_WQ_CANCEL_NOTFOUND);
3115 mutex_unlock(&ctx->uring_lock);
3120 static __cold bool io_uring_try_cancel_requests(struct io_ring_ctx *ctx,
3121 struct task_struct *task,
3124 struct io_task_cancel cancel = { .task = task, .all = cancel_all, };
3125 struct io_uring_task *tctx = task ? task->io_uring : NULL;
3126 enum io_wq_cancel cret;
3129 /* failed during ring init, it couldn't have issued any requests */
3134 ret |= io_uring_try_cancel_iowq(ctx);
3135 } else if (tctx && tctx->io_wq) {
3137 * Cancels requests of all rings, not only @ctx, but
3138 * it's fine as the task is in exit/exec.
3140 cret = io_wq_cancel_cb(tctx->io_wq, io_cancel_task_cb,
3142 ret |= (cret != IO_WQ_CANCEL_NOTFOUND);
3145 /* SQPOLL thread does its own polling */
3146 if ((!(ctx->flags & IORING_SETUP_SQPOLL) && cancel_all) ||
3147 (ctx->sq_data && ctx->sq_data->thread == current)) {
3148 while (!wq_list_empty(&ctx->iopoll_list)) {
3149 io_iopoll_try_reap_events(ctx);
3154 if ((ctx->flags & IORING_SETUP_DEFER_TASKRUN) &&
3155 io_allowed_defer_tw_run(ctx))
3156 ret |= io_run_local_work(ctx) > 0;
3157 ret |= io_cancel_defer_files(ctx, task, cancel_all);
3158 mutex_lock(&ctx->uring_lock);
3159 ret |= io_poll_remove_all(ctx, task, cancel_all);
3160 mutex_unlock(&ctx->uring_lock);
3161 ret |= io_kill_timeouts(ctx, task, cancel_all);
3163 ret |= io_run_task_work() > 0;
3167 static s64 tctx_inflight(struct io_uring_task *tctx, bool tracked)
3170 return atomic_read(&tctx->inflight_tracked);
3171 return percpu_counter_sum(&tctx->inflight);
3175 * Find any io_uring ctx that this task has registered or done IO on, and cancel
3176 * requests. @sqd should be not-null IFF it's an SQPOLL thread cancellation.
3178 __cold void io_uring_cancel_generic(bool cancel_all, struct io_sq_data *sqd)
3180 struct io_uring_task *tctx = current->io_uring;
3181 struct io_ring_ctx *ctx;
3185 WARN_ON_ONCE(sqd && sqd->thread != current);
3187 if (!current->io_uring)
3190 io_wq_exit_start(tctx->io_wq);
3192 atomic_inc(&tctx->in_idle);
3196 io_uring_drop_tctx_refs(current);
3197 /* read completions before cancelations */
3198 inflight = tctx_inflight(tctx, !cancel_all);
3203 struct io_tctx_node *node;
3204 unsigned long index;
3206 xa_for_each(&tctx->xa, index, node) {
3207 /* sqpoll task will cancel all its requests */
3208 if (node->ctx->sq_data)
3210 loop |= io_uring_try_cancel_requests(node->ctx,
3211 current, cancel_all);
3214 list_for_each_entry(ctx, &sqd->ctx_list, sqd_list)
3215 loop |= io_uring_try_cancel_requests(ctx,
3225 prepare_to_wait(&tctx->wait, &wait, TASK_INTERRUPTIBLE);
3227 io_uring_drop_tctx_refs(current);
3230 * If we've seen completions, retry without waiting. This
3231 * avoids a race where a completion comes in before we did
3232 * prepare_to_wait().
3234 if (inflight == tctx_inflight(tctx, !cancel_all))
3236 finish_wait(&tctx->wait, &wait);
3239 io_uring_clean_tctx(tctx);
3242 * We shouldn't run task_works after cancel, so just leave
3243 * ->in_idle set for normal exit.
3245 atomic_dec(&tctx->in_idle);
3246 /* for exec all current's requests should be gone, kill tctx */
3247 __io_uring_free(current);
3251 void __io_uring_cancel(bool cancel_all)
3253 io_uring_cancel_generic(cancel_all, NULL);
3256 static void *io_uring_validate_mmap_request(struct file *file,
3257 loff_t pgoff, size_t sz)
3259 struct io_ring_ctx *ctx = file->private_data;
3260 loff_t offset = pgoff << PAGE_SHIFT;
3265 case IORING_OFF_SQ_RING:
3266 case IORING_OFF_CQ_RING:
3269 case IORING_OFF_SQES:
3273 return ERR_PTR(-EINVAL);
3276 page = virt_to_head_page(ptr);
3277 if (sz > page_size(page))
3278 return ERR_PTR(-EINVAL);
3285 static __cold int io_uring_mmap(struct file *file, struct vm_area_struct *vma)
3287 size_t sz = vma->vm_end - vma->vm_start;
3291 ptr = io_uring_validate_mmap_request(file, vma->vm_pgoff, sz);
3293 return PTR_ERR(ptr);
3295 pfn = virt_to_phys(ptr) >> PAGE_SHIFT;
3296 return remap_pfn_range(vma, vma->vm_start, pfn, sz, vma->vm_page_prot);
3299 #else /* !CONFIG_MMU */
3301 static int io_uring_mmap(struct file *file, struct vm_area_struct *vma)
3303 return vma->vm_flags & (VM_SHARED | VM_MAYSHARE) ? 0 : -EINVAL;
3306 static unsigned int io_uring_nommu_mmap_capabilities(struct file *file)
3308 return NOMMU_MAP_DIRECT | NOMMU_MAP_READ | NOMMU_MAP_WRITE;
3311 static unsigned long io_uring_nommu_get_unmapped_area(struct file *file,
3312 unsigned long addr, unsigned long len,
3313 unsigned long pgoff, unsigned long flags)
3317 ptr = io_uring_validate_mmap_request(file, pgoff, len);
3319 return PTR_ERR(ptr);
3321 return (unsigned long) ptr;
3324 #endif /* !CONFIG_MMU */
3326 static int io_validate_ext_arg(unsigned flags, const void __user *argp, size_t argsz)
3328 if (flags & IORING_ENTER_EXT_ARG) {
3329 struct io_uring_getevents_arg arg;
3331 if (argsz != sizeof(arg))
3333 if (copy_from_user(&arg, argp, sizeof(arg)))
3339 static int io_get_ext_arg(unsigned flags, const void __user *argp, size_t *argsz,
3340 struct __kernel_timespec __user **ts,
3341 const sigset_t __user **sig)
3343 struct io_uring_getevents_arg arg;
3346 * If EXT_ARG isn't set, then we have no timespec and the argp pointer
3347 * is just a pointer to the sigset_t.
3349 if (!(flags & IORING_ENTER_EXT_ARG)) {
3350 *sig = (const sigset_t __user *) argp;
3356 * EXT_ARG is set - ensure we agree on the size of it and copy in our
3357 * timespec and sigset_t pointers if good.
3359 if (*argsz != sizeof(arg))
3361 if (copy_from_user(&arg, argp, sizeof(arg)))
3365 *sig = u64_to_user_ptr(arg.sigmask);
3366 *argsz = arg.sigmask_sz;
3367 *ts = u64_to_user_ptr(arg.ts);
3371 SYSCALL_DEFINE6(io_uring_enter, unsigned int, fd, u32, to_submit,
3372 u32, min_complete, u32, flags, const void __user *, argp,
3375 struct io_ring_ctx *ctx;
3379 if (unlikely(flags & ~(IORING_ENTER_GETEVENTS | IORING_ENTER_SQ_WAKEUP |
3380 IORING_ENTER_SQ_WAIT | IORING_ENTER_EXT_ARG |
3381 IORING_ENTER_REGISTERED_RING)))
3385 * Ring fd has been registered via IORING_REGISTER_RING_FDS, we
3386 * need only dereference our task private array to find it.
3388 if (flags & IORING_ENTER_REGISTERED_RING) {
3389 struct io_uring_task *tctx = current->io_uring;
3391 if (unlikely(!tctx || fd >= IO_RINGFD_REG_MAX))
3393 fd = array_index_nospec(fd, IO_RINGFD_REG_MAX);
3394 f.file = tctx->registered_rings[fd];
3396 if (unlikely(!f.file))
3400 if (unlikely(!f.file))
3403 if (unlikely(!io_is_uring_fops(f.file)))
3407 ctx = f.file->private_data;
3409 if (unlikely(ctx->flags & IORING_SETUP_R_DISABLED))
3413 * For SQ polling, the thread will do all submissions and completions.
3414 * Just return the requested submit count, and wake the thread if
3418 if (ctx->flags & IORING_SETUP_SQPOLL) {
3419 io_cqring_overflow_flush(ctx);
3421 if (unlikely(ctx->sq_data->thread == NULL)) {
3425 if (flags & IORING_ENTER_SQ_WAKEUP)
3426 wake_up(&ctx->sq_data->wait);
3427 if (flags & IORING_ENTER_SQ_WAIT)
3428 io_sqpoll_wait_sq(ctx);
3431 } else if (to_submit) {
3432 ret = io_uring_add_tctx_node(ctx);
3436 mutex_lock(&ctx->uring_lock);
3437 ret = io_submit_sqes(ctx, to_submit);
3438 if (ret != to_submit) {
3439 mutex_unlock(&ctx->uring_lock);
3442 if (flags & IORING_ENTER_GETEVENTS) {
3443 if (ctx->syscall_iopoll)
3446 * Ignore errors, we'll soon call io_cqring_wait() and
3447 * it should handle ownership problems if any.
3449 if (ctx->flags & IORING_SETUP_DEFER_TASKRUN)
3450 (void)io_run_local_work_locked(ctx);
3452 mutex_unlock(&ctx->uring_lock);
3455 if (flags & IORING_ENTER_GETEVENTS) {
3458 if (ctx->syscall_iopoll) {
3460 * We disallow the app entering submit/complete with
3461 * polling, but we still need to lock the ring to
3462 * prevent racing with polled issue that got punted to
3465 mutex_lock(&ctx->uring_lock);
3467 ret2 = io_validate_ext_arg(flags, argp, argsz);
3468 if (likely(!ret2)) {
3469 min_complete = min(min_complete,
3471 ret2 = io_iopoll_check(ctx, min_complete);
3473 mutex_unlock(&ctx->uring_lock);
3475 const sigset_t __user *sig;
3476 struct __kernel_timespec __user *ts;
3478 ret2 = io_get_ext_arg(flags, argp, &argsz, &ts, &sig);
3479 if (likely(!ret2)) {
3480 min_complete = min(min_complete,
3482 ret2 = io_cqring_wait(ctx, min_complete, sig,
3491 * EBADR indicates that one or more CQE were dropped.
3492 * Once the user has been informed we can clear the bit
3493 * as they are obviously ok with those drops.
3495 if (unlikely(ret2 == -EBADR))
3496 clear_bit(IO_CHECK_CQ_DROPPED_BIT,
3505 static const struct file_operations io_uring_fops = {
3506 .release = io_uring_release,
3507 .mmap = io_uring_mmap,
3509 .get_unmapped_area = io_uring_nommu_get_unmapped_area,
3510 .mmap_capabilities = io_uring_nommu_mmap_capabilities,
3512 .poll = io_uring_poll,
3513 #ifdef CONFIG_PROC_FS
3514 .show_fdinfo = io_uring_show_fdinfo,
3518 bool io_is_uring_fops(struct file *file)
3520 return file->f_op == &io_uring_fops;
3523 static __cold int io_allocate_scq_urings(struct io_ring_ctx *ctx,
3524 struct io_uring_params *p)
3526 struct io_rings *rings;
3527 size_t size, sq_array_offset;
3529 /* make sure these are sane, as we already accounted them */
3530 ctx->sq_entries = p->sq_entries;
3531 ctx->cq_entries = p->cq_entries;
3533 size = rings_size(ctx, p->sq_entries, p->cq_entries, &sq_array_offset);
3534 if (size == SIZE_MAX)
3537 rings = io_mem_alloc(size);
3542 ctx->sq_array = (u32 *)((char *)rings + sq_array_offset);
3543 rings->sq_ring_mask = p->sq_entries - 1;
3544 rings->cq_ring_mask = p->cq_entries - 1;
3545 rings->sq_ring_entries = p->sq_entries;
3546 rings->cq_ring_entries = p->cq_entries;
3548 if (p->flags & IORING_SETUP_SQE128)
3549 size = array_size(2 * sizeof(struct io_uring_sqe), p->sq_entries);
3551 size = array_size(sizeof(struct io_uring_sqe), p->sq_entries);
3552 if (size == SIZE_MAX) {
3553 io_mem_free(ctx->rings);
3558 ctx->sq_sqes = io_mem_alloc(size);
3559 if (!ctx->sq_sqes) {
3560 io_mem_free(ctx->rings);
3568 static int io_uring_install_fd(struct io_ring_ctx *ctx, struct file *file)
3572 fd = get_unused_fd_flags(O_RDWR | O_CLOEXEC);
3576 ret = __io_uring_add_tctx_node(ctx);
3581 fd_install(fd, file);
3586 * Allocate an anonymous fd, this is what constitutes the application
3587 * visible backing of an io_uring instance. The application mmaps this
3588 * fd to gain access to the SQ/CQ ring details. If UNIX sockets are enabled,
3589 * we have to tie this fd to a socket for file garbage collection purposes.
3591 static struct file *io_uring_get_file(struct io_ring_ctx *ctx)
3594 #if defined(CONFIG_UNIX)
3597 ret = sock_create_kern(&init_net, PF_UNIX, SOCK_RAW, IPPROTO_IP,
3600 return ERR_PTR(ret);
3603 file = anon_inode_getfile_secure("[io_uring]", &io_uring_fops, ctx,
3604 O_RDWR | O_CLOEXEC, NULL);
3605 #if defined(CONFIG_UNIX)
3607 sock_release(ctx->ring_sock);
3608 ctx->ring_sock = NULL;
3610 ctx->ring_sock->file = file;
3616 static __cold int io_uring_create(unsigned entries, struct io_uring_params *p,
3617 struct io_uring_params __user *params)
3619 struct io_ring_ctx *ctx;
3625 if (entries > IORING_MAX_ENTRIES) {
3626 if (!(p->flags & IORING_SETUP_CLAMP))
3628 entries = IORING_MAX_ENTRIES;
3632 * Use twice as many entries for the CQ ring. It's possible for the
3633 * application to drive a higher depth than the size of the SQ ring,
3634 * since the sqes are only used at submission time. This allows for
3635 * some flexibility in overcommitting a bit. If the application has
3636 * set IORING_SETUP_CQSIZE, it will have passed in the desired number
3637 * of CQ ring entries manually.
3639 p->sq_entries = roundup_pow_of_two(entries);
3640 if (p->flags & IORING_SETUP_CQSIZE) {
3642 * If IORING_SETUP_CQSIZE is set, we do the same roundup
3643 * to a power-of-two, if it isn't already. We do NOT impose
3644 * any cq vs sq ring sizing.
3648 if (p->cq_entries > IORING_MAX_CQ_ENTRIES) {
3649 if (!(p->flags & IORING_SETUP_CLAMP))
3651 p->cq_entries = IORING_MAX_CQ_ENTRIES;
3653 p->cq_entries = roundup_pow_of_two(p->cq_entries);
3654 if (p->cq_entries < p->sq_entries)
3657 p->cq_entries = 2 * p->sq_entries;
3660 ctx = io_ring_ctx_alloc(p);
3664 if ((ctx->flags & IORING_SETUP_DEFER_TASKRUN) &&
3665 !(ctx->flags & IORING_SETUP_IOPOLL) &&
3666 !(ctx->flags & IORING_SETUP_SQPOLL))
3667 ctx->task_complete = true;
3670 * lazy poll_wq activation relies on ->task_complete for synchronisation
3671 * purposes, see io_activate_pollwq()
3673 if (!ctx->task_complete)
3674 ctx->poll_activated = true;
3677 * When SETUP_IOPOLL and SETUP_SQPOLL are both enabled, user
3678 * space applications don't need to do io completion events
3679 * polling again, they can rely on io_sq_thread to do polling
3680 * work, which can reduce cpu usage and uring_lock contention.
3682 if (ctx->flags & IORING_SETUP_IOPOLL &&
3683 !(ctx->flags & IORING_SETUP_SQPOLL))
3684 ctx->syscall_iopoll = 1;
3686 ctx->compat = in_compat_syscall();
3687 if (!capable(CAP_IPC_LOCK))
3688 ctx->user = get_uid(current_user());
3691 * For SQPOLL, we just need a wakeup, always. For !SQPOLL, if
3692 * COOP_TASKRUN is set, then IPIs are never needed by the app.
3695 if (ctx->flags & IORING_SETUP_SQPOLL) {
3696 /* IPI related flags don't make sense with SQPOLL */
3697 if (ctx->flags & (IORING_SETUP_COOP_TASKRUN |
3698 IORING_SETUP_TASKRUN_FLAG |
3699 IORING_SETUP_DEFER_TASKRUN))
3701 ctx->notify_method = TWA_SIGNAL_NO_IPI;
3702 } else if (ctx->flags & IORING_SETUP_COOP_TASKRUN) {
3703 ctx->notify_method = TWA_SIGNAL_NO_IPI;
3705 if (ctx->flags & IORING_SETUP_TASKRUN_FLAG &&
3706 !(ctx->flags & IORING_SETUP_DEFER_TASKRUN))
3708 ctx->notify_method = TWA_SIGNAL;
3712 * For DEFER_TASKRUN we require the completion task to be the same as the
3713 * submission task. This implies that there is only one submitter, so enforce
3716 if (ctx->flags & IORING_SETUP_DEFER_TASKRUN &&
3717 !(ctx->flags & IORING_SETUP_SINGLE_ISSUER)) {
3722 * This is just grabbed for accounting purposes. When a process exits,
3723 * the mm is exited and dropped before the files, hence we need to hang
3724 * on to this mm purely for the purposes of being able to unaccount
3725 * memory (locked/pinned vm). It's not used for anything else.
3727 mmgrab(current->mm);
3728 ctx->mm_account = current->mm;
3730 ret = io_allocate_scq_urings(ctx, p);
3734 ret = io_sq_offload_create(ctx, p);
3737 /* always set a rsrc node */
3738 ret = io_rsrc_node_switch_start(ctx);
3741 io_rsrc_node_switch(ctx, NULL);
3743 memset(&p->sq_off, 0, sizeof(p->sq_off));
3744 p->sq_off.head = offsetof(struct io_rings, sq.head);
3745 p->sq_off.tail = offsetof(struct io_rings, sq.tail);
3746 p->sq_off.ring_mask = offsetof(struct io_rings, sq_ring_mask);
3747 p->sq_off.ring_entries = offsetof(struct io_rings, sq_ring_entries);
3748 p->sq_off.flags = offsetof(struct io_rings, sq_flags);
3749 p->sq_off.dropped = offsetof(struct io_rings, sq_dropped);
3750 p->sq_off.array = (char *)ctx->sq_array - (char *)ctx->rings;
3752 memset(&p->cq_off, 0, sizeof(p->cq_off));
3753 p->cq_off.head = offsetof(struct io_rings, cq.head);
3754 p->cq_off.tail = offsetof(struct io_rings, cq.tail);
3755 p->cq_off.ring_mask = offsetof(struct io_rings, cq_ring_mask);
3756 p->cq_off.ring_entries = offsetof(struct io_rings, cq_ring_entries);
3757 p->cq_off.overflow = offsetof(struct io_rings, cq_overflow);
3758 p->cq_off.cqes = offsetof(struct io_rings, cqes);
3759 p->cq_off.flags = offsetof(struct io_rings, cq_flags);
3761 p->features = IORING_FEAT_SINGLE_MMAP | IORING_FEAT_NODROP |
3762 IORING_FEAT_SUBMIT_STABLE | IORING_FEAT_RW_CUR_POS |
3763 IORING_FEAT_CUR_PERSONALITY | IORING_FEAT_FAST_POLL |
3764 IORING_FEAT_POLL_32BITS | IORING_FEAT_SQPOLL_NONFIXED |
3765 IORING_FEAT_EXT_ARG | IORING_FEAT_NATIVE_WORKERS |
3766 IORING_FEAT_RSRC_TAGS | IORING_FEAT_CQE_SKIP |
3767 IORING_FEAT_LINKED_FILE;
3769 if (copy_to_user(params, p, sizeof(*p))) {
3774 if (ctx->flags & IORING_SETUP_SINGLE_ISSUER
3775 && !(ctx->flags & IORING_SETUP_R_DISABLED))
3776 WRITE_ONCE(ctx->submitter_task, get_task_struct(current));
3778 file = io_uring_get_file(ctx);
3780 ret = PTR_ERR(file);
3785 * Install ring fd as the very last thing, so we don't risk someone
3786 * having closed it before we finish setup
3788 ret = io_uring_install_fd(ctx, file);
3790 /* fput will clean it up */
3795 trace_io_uring_create(ret, ctx, p->sq_entries, p->cq_entries, p->flags);
3798 io_ring_ctx_wait_and_kill(ctx);
3803 * Sets up an aio uring context, and returns the fd. Applications asks for a
3804 * ring size, we return the actual sq/cq ring sizes (among other things) in the
3805 * params structure passed in.
3807 static long io_uring_setup(u32 entries, struct io_uring_params __user *params)
3809 struct io_uring_params p;
3812 if (copy_from_user(&p, params, sizeof(p)))
3814 for (i = 0; i < ARRAY_SIZE(p.resv); i++) {
3819 if (p.flags & ~(IORING_SETUP_IOPOLL | IORING_SETUP_SQPOLL |
3820 IORING_SETUP_SQ_AFF | IORING_SETUP_CQSIZE |
3821 IORING_SETUP_CLAMP | IORING_SETUP_ATTACH_WQ |
3822 IORING_SETUP_R_DISABLED | IORING_SETUP_SUBMIT_ALL |
3823 IORING_SETUP_COOP_TASKRUN | IORING_SETUP_TASKRUN_FLAG |
3824 IORING_SETUP_SQE128 | IORING_SETUP_CQE32 |
3825 IORING_SETUP_SINGLE_ISSUER | IORING_SETUP_DEFER_TASKRUN))
3828 return io_uring_create(entries, &p, params);
3831 SYSCALL_DEFINE2(io_uring_setup, u32, entries,
3832 struct io_uring_params __user *, params)
3834 return io_uring_setup(entries, params);
3837 static __cold int io_probe(struct io_ring_ctx *ctx, void __user *arg,
3840 struct io_uring_probe *p;
3844 size = struct_size(p, ops, nr_args);
3845 if (size == SIZE_MAX)
3847 p = kzalloc(size, GFP_KERNEL);
3852 if (copy_from_user(p, arg, size))
3855 if (memchr_inv(p, 0, size))
3858 p->last_op = IORING_OP_LAST - 1;
3859 if (nr_args > IORING_OP_LAST)
3860 nr_args = IORING_OP_LAST;
3862 for (i = 0; i < nr_args; i++) {
3864 if (!io_op_defs[i].not_supported)
3865 p->ops[i].flags = IO_URING_OP_SUPPORTED;
3870 if (copy_to_user(arg, p, size))
3877 static int io_register_personality(struct io_ring_ctx *ctx)
3879 const struct cred *creds;
3883 creds = get_current_cred();
3885 ret = xa_alloc_cyclic(&ctx->personalities, &id, (void *)creds,
3886 XA_LIMIT(0, USHRT_MAX), &ctx->pers_next, GFP_KERNEL);
3894 static __cold int io_register_restrictions(struct io_ring_ctx *ctx,
3895 void __user *arg, unsigned int nr_args)
3897 struct io_uring_restriction *res;
3901 /* Restrictions allowed only if rings started disabled */
3902 if (!(ctx->flags & IORING_SETUP_R_DISABLED))
3905 /* We allow only a single restrictions registration */
3906 if (ctx->restrictions.registered)
3909 if (!arg || nr_args > IORING_MAX_RESTRICTIONS)
3912 size = array_size(nr_args, sizeof(*res));
3913 if (size == SIZE_MAX)
3916 res = memdup_user(arg, size);
3918 return PTR_ERR(res);
3922 for (i = 0; i < nr_args; i++) {
3923 switch (res[i].opcode) {
3924 case IORING_RESTRICTION_REGISTER_OP:
3925 if (res[i].register_op >= IORING_REGISTER_LAST) {
3930 __set_bit(res[i].register_op,
3931 ctx->restrictions.register_op);
3933 case IORING_RESTRICTION_SQE_OP:
3934 if (res[i].sqe_op >= IORING_OP_LAST) {
3939 __set_bit(res[i].sqe_op, ctx->restrictions.sqe_op);
3941 case IORING_RESTRICTION_SQE_FLAGS_ALLOWED:
3942 ctx->restrictions.sqe_flags_allowed = res[i].sqe_flags;
3944 case IORING_RESTRICTION_SQE_FLAGS_REQUIRED:
3945 ctx->restrictions.sqe_flags_required = res[i].sqe_flags;
3954 /* Reset all restrictions if an error happened */
3956 memset(&ctx->restrictions, 0, sizeof(ctx->restrictions));
3958 ctx->restrictions.registered = true;
3964 static int io_register_enable_rings(struct io_ring_ctx *ctx)
3966 if (!(ctx->flags & IORING_SETUP_R_DISABLED))
3969 if (ctx->flags & IORING_SETUP_SINGLE_ISSUER && !ctx->submitter_task) {
3970 WRITE_ONCE(ctx->submitter_task, get_task_struct(current));
3972 * Lazy activation attempts would fail if it was polled before
3973 * submitter_task is set.
3975 if (wq_has_sleeper(&ctx->poll_wq))
3976 io_activate_pollwq(ctx);
3979 if (ctx->restrictions.registered)
3980 ctx->restricted = 1;
3982 ctx->flags &= ~IORING_SETUP_R_DISABLED;
3983 if (ctx->sq_data && wq_has_sleeper(&ctx->sq_data->wait))
3984 wake_up(&ctx->sq_data->wait);
3988 static __cold int io_register_iowq_aff(struct io_ring_ctx *ctx,
3989 void __user *arg, unsigned len)
3991 struct io_uring_task *tctx = current->io_uring;
3992 cpumask_var_t new_mask;
3995 if (!tctx || !tctx->io_wq)
3998 if (!alloc_cpumask_var(&new_mask, GFP_KERNEL))
4001 cpumask_clear(new_mask);
4002 if (len > cpumask_size())
4003 len = cpumask_size();
4005 if (in_compat_syscall()) {
4006 ret = compat_get_bitmap(cpumask_bits(new_mask),
4007 (const compat_ulong_t __user *)arg,
4008 len * 8 /* CHAR_BIT */);
4010 ret = copy_from_user(new_mask, arg, len);
4014 free_cpumask_var(new_mask);
4018 ret = io_wq_cpu_affinity(tctx->io_wq, new_mask);
4019 free_cpumask_var(new_mask);
4023 static __cold int io_unregister_iowq_aff(struct io_ring_ctx *ctx)
4025 struct io_uring_task *tctx = current->io_uring;
4027 if (!tctx || !tctx->io_wq)
4030 return io_wq_cpu_affinity(tctx->io_wq, NULL);
4033 static __cold int io_register_iowq_max_workers(struct io_ring_ctx *ctx,
4035 __must_hold(&ctx->uring_lock)
4037 struct io_tctx_node *node;
4038 struct io_uring_task *tctx = NULL;
4039 struct io_sq_data *sqd = NULL;
4043 if (copy_from_user(new_count, arg, sizeof(new_count)))
4045 for (i = 0; i < ARRAY_SIZE(new_count); i++)
4046 if (new_count[i] > INT_MAX)
4049 if (ctx->flags & IORING_SETUP_SQPOLL) {
4053 * Observe the correct sqd->lock -> ctx->uring_lock
4054 * ordering. Fine to drop uring_lock here, we hold
4057 refcount_inc(&sqd->refs);
4058 mutex_unlock(&ctx->uring_lock);
4059 mutex_lock(&sqd->lock);
4060 mutex_lock(&ctx->uring_lock);
4062 tctx = sqd->thread->io_uring;
4065 tctx = current->io_uring;
4068 BUILD_BUG_ON(sizeof(new_count) != sizeof(ctx->iowq_limits));
4070 for (i = 0; i < ARRAY_SIZE(new_count); i++)
4072 ctx->iowq_limits[i] = new_count[i];
4073 ctx->iowq_limits_set = true;
4075 if (tctx && tctx->io_wq) {
4076 ret = io_wq_max_workers(tctx->io_wq, new_count);
4080 memset(new_count, 0, sizeof(new_count));
4084 mutex_unlock(&sqd->lock);
4085 io_put_sq_data(sqd);
4088 if (copy_to_user(arg, new_count, sizeof(new_count)))
4091 /* that's it for SQPOLL, only the SQPOLL task creates requests */
4095 /* now propagate the restriction to all registered users */
4096 list_for_each_entry(node, &ctx->tctx_list, ctx_node) {
4097 struct io_uring_task *tctx = node->task->io_uring;
4099 if (WARN_ON_ONCE(!tctx->io_wq))
4102 for (i = 0; i < ARRAY_SIZE(new_count); i++)
4103 new_count[i] = ctx->iowq_limits[i];
4104 /* ignore errors, it always returns zero anyway */
4105 (void)io_wq_max_workers(tctx->io_wq, new_count);
4110 mutex_unlock(&sqd->lock);
4111 io_put_sq_data(sqd);
4116 static int __io_uring_register(struct io_ring_ctx *ctx, unsigned opcode,
4117 void __user *arg, unsigned nr_args)
4118 __releases(ctx->uring_lock)
4119 __acquires(ctx->uring_lock)
4124 * We don't quiesce the refs for register anymore and so it can't be
4125 * dying as we're holding a file ref here.
4127 if (WARN_ON_ONCE(percpu_ref_is_dying(&ctx->refs)))
4130 if (ctx->submitter_task && ctx->submitter_task != current)
4133 if (ctx->restricted) {
4134 opcode = array_index_nospec(opcode, IORING_REGISTER_LAST);
4135 if (!test_bit(opcode, ctx->restrictions.register_op))
4140 case IORING_REGISTER_BUFFERS:
4144 ret = io_sqe_buffers_register(ctx, arg, nr_args, NULL);
4146 case IORING_UNREGISTER_BUFFERS:
4150 ret = io_sqe_buffers_unregister(ctx);
4152 case IORING_REGISTER_FILES:
4156 ret = io_sqe_files_register(ctx, arg, nr_args, NULL);
4158 case IORING_UNREGISTER_FILES:
4162 ret = io_sqe_files_unregister(ctx);
4164 case IORING_REGISTER_FILES_UPDATE:
4165 ret = io_register_files_update(ctx, arg, nr_args);
4167 case IORING_REGISTER_EVENTFD:
4171 ret = io_eventfd_register(ctx, arg, 0);
4173 case IORING_REGISTER_EVENTFD_ASYNC:
4177 ret = io_eventfd_register(ctx, arg, 1);
4179 case IORING_UNREGISTER_EVENTFD:
4183 ret = io_eventfd_unregister(ctx);
4185 case IORING_REGISTER_PROBE:
4187 if (!arg || nr_args > 256)
4189 ret = io_probe(ctx, arg, nr_args);
4191 case IORING_REGISTER_PERSONALITY:
4195 ret = io_register_personality(ctx);
4197 case IORING_UNREGISTER_PERSONALITY:
4201 ret = io_unregister_personality(ctx, nr_args);
4203 case IORING_REGISTER_ENABLE_RINGS:
4207 ret = io_register_enable_rings(ctx);
4209 case IORING_REGISTER_RESTRICTIONS:
4210 ret = io_register_restrictions(ctx, arg, nr_args);
4212 case IORING_REGISTER_FILES2:
4213 ret = io_register_rsrc(ctx, arg, nr_args, IORING_RSRC_FILE);
4215 case IORING_REGISTER_FILES_UPDATE2:
4216 ret = io_register_rsrc_update(ctx, arg, nr_args,
4219 case IORING_REGISTER_BUFFERS2:
4220 ret = io_register_rsrc(ctx, arg, nr_args, IORING_RSRC_BUFFER);
4222 case IORING_REGISTER_BUFFERS_UPDATE:
4223 ret = io_register_rsrc_update(ctx, arg, nr_args,
4224 IORING_RSRC_BUFFER);
4226 case IORING_REGISTER_IOWQ_AFF:
4228 if (!arg || !nr_args)
4230 ret = io_register_iowq_aff(ctx, arg, nr_args);
4232 case IORING_UNREGISTER_IOWQ_AFF:
4236 ret = io_unregister_iowq_aff(ctx);
4238 case IORING_REGISTER_IOWQ_MAX_WORKERS:
4240 if (!arg || nr_args != 2)
4242 ret = io_register_iowq_max_workers(ctx, arg);
4244 case IORING_REGISTER_RING_FDS:
4245 ret = io_ringfd_register(ctx, arg, nr_args);
4247 case IORING_UNREGISTER_RING_FDS:
4248 ret = io_ringfd_unregister(ctx, arg, nr_args);
4250 case IORING_REGISTER_PBUF_RING:
4252 if (!arg || nr_args != 1)
4254 ret = io_register_pbuf_ring(ctx, arg);
4256 case IORING_UNREGISTER_PBUF_RING:
4258 if (!arg || nr_args != 1)
4260 ret = io_unregister_pbuf_ring(ctx, arg);
4262 case IORING_REGISTER_SYNC_CANCEL:
4264 if (!arg || nr_args != 1)
4266 ret = io_sync_cancel(ctx, arg);
4268 case IORING_REGISTER_FILE_ALLOC_RANGE:
4270 if (!arg || nr_args)
4272 ret = io_register_file_alloc_range(ctx, arg);
4282 SYSCALL_DEFINE4(io_uring_register, unsigned int, fd, unsigned int, opcode,
4283 void __user *, arg, unsigned int, nr_args)
4285 struct io_ring_ctx *ctx;
4289 if (opcode >= IORING_REGISTER_LAST)
4297 if (!io_is_uring_fops(f.file))
4300 ctx = f.file->private_data;
4302 mutex_lock(&ctx->uring_lock);
4303 ret = __io_uring_register(ctx, opcode, arg, nr_args);
4304 mutex_unlock(&ctx->uring_lock);
4305 trace_io_uring_register(ctx, opcode, ctx->nr_user_files, ctx->nr_user_bufs, ret);
4311 static int __init io_uring_init(void)
4313 #define __BUILD_BUG_VERIFY_OFFSET_SIZE(stype, eoffset, esize, ename) do { \
4314 BUILD_BUG_ON(offsetof(stype, ename) != eoffset); \
4315 BUILD_BUG_ON(sizeof_field(stype, ename) != esize); \
4318 #define BUILD_BUG_SQE_ELEM(eoffset, etype, ename) \
4319 __BUILD_BUG_VERIFY_OFFSET_SIZE(struct io_uring_sqe, eoffset, sizeof(etype), ename)
4320 #define BUILD_BUG_SQE_ELEM_SIZE(eoffset, esize, ename) \
4321 __BUILD_BUG_VERIFY_OFFSET_SIZE(struct io_uring_sqe, eoffset, esize, ename)
4322 BUILD_BUG_ON(sizeof(struct io_uring_sqe) != 64);
4323 BUILD_BUG_SQE_ELEM(0, __u8, opcode);
4324 BUILD_BUG_SQE_ELEM(1, __u8, flags);
4325 BUILD_BUG_SQE_ELEM(2, __u16, ioprio);
4326 BUILD_BUG_SQE_ELEM(4, __s32, fd);
4327 BUILD_BUG_SQE_ELEM(8, __u64, off);
4328 BUILD_BUG_SQE_ELEM(8, __u64, addr2);
4329 BUILD_BUG_SQE_ELEM(8, __u32, cmd_op);
4330 BUILD_BUG_SQE_ELEM(12, __u32, __pad1);
4331 BUILD_BUG_SQE_ELEM(16, __u64, addr);
4332 BUILD_BUG_SQE_ELEM(16, __u64, splice_off_in);
4333 BUILD_BUG_SQE_ELEM(24, __u32, len);
4334 BUILD_BUG_SQE_ELEM(28, __kernel_rwf_t, rw_flags);
4335 BUILD_BUG_SQE_ELEM(28, /* compat */ int, rw_flags);
4336 BUILD_BUG_SQE_ELEM(28, /* compat */ __u32, rw_flags);
4337 BUILD_BUG_SQE_ELEM(28, __u32, fsync_flags);
4338 BUILD_BUG_SQE_ELEM(28, /* compat */ __u16, poll_events);
4339 BUILD_BUG_SQE_ELEM(28, __u32, poll32_events);
4340 BUILD_BUG_SQE_ELEM(28, __u32, sync_range_flags);
4341 BUILD_BUG_SQE_ELEM(28, __u32, msg_flags);
4342 BUILD_BUG_SQE_ELEM(28, __u32, timeout_flags);
4343 BUILD_BUG_SQE_ELEM(28, __u32, accept_flags);
4344 BUILD_BUG_SQE_ELEM(28, __u32, cancel_flags);
4345 BUILD_BUG_SQE_ELEM(28, __u32, open_flags);
4346 BUILD_BUG_SQE_ELEM(28, __u32, statx_flags);
4347 BUILD_BUG_SQE_ELEM(28, __u32, fadvise_advice);
4348 BUILD_BUG_SQE_ELEM(28, __u32, splice_flags);
4349 BUILD_BUG_SQE_ELEM(28, __u32, rename_flags);
4350 BUILD_BUG_SQE_ELEM(28, __u32, unlink_flags);
4351 BUILD_BUG_SQE_ELEM(28, __u32, hardlink_flags);
4352 BUILD_BUG_SQE_ELEM(28, __u32, xattr_flags);
4353 BUILD_BUG_SQE_ELEM(28, __u32, msg_ring_flags);
4354 BUILD_BUG_SQE_ELEM(32, __u64, user_data);
4355 BUILD_BUG_SQE_ELEM(40, __u16, buf_index);
4356 BUILD_BUG_SQE_ELEM(40, __u16, buf_group);
4357 BUILD_BUG_SQE_ELEM(42, __u16, personality);
4358 BUILD_BUG_SQE_ELEM(44, __s32, splice_fd_in);
4359 BUILD_BUG_SQE_ELEM(44, __u32, file_index);
4360 BUILD_BUG_SQE_ELEM(44, __u16, addr_len);
4361 BUILD_BUG_SQE_ELEM(46, __u16, __pad3[0]);
4362 BUILD_BUG_SQE_ELEM(48, __u64, addr3);
4363 BUILD_BUG_SQE_ELEM_SIZE(48, 0, cmd);
4364 BUILD_BUG_SQE_ELEM(56, __u64, __pad2);
4366 BUILD_BUG_ON(sizeof(struct io_uring_files_update) !=
4367 sizeof(struct io_uring_rsrc_update));
4368 BUILD_BUG_ON(sizeof(struct io_uring_rsrc_update) >
4369 sizeof(struct io_uring_rsrc_update2));
4371 /* ->buf_index is u16 */
4372 BUILD_BUG_ON(offsetof(struct io_uring_buf_ring, bufs) != 0);
4373 BUILD_BUG_ON(offsetof(struct io_uring_buf, resv) !=
4374 offsetof(struct io_uring_buf_ring, tail));
4376 /* should fit into one byte */
4377 BUILD_BUG_ON(SQE_VALID_FLAGS >= (1 << 8));
4378 BUILD_BUG_ON(SQE_COMMON_FLAGS >= (1 << 8));
4379 BUILD_BUG_ON((SQE_VALID_FLAGS | SQE_COMMON_FLAGS) != SQE_VALID_FLAGS);
4381 BUILD_BUG_ON(__REQ_F_LAST_BIT > 8 * sizeof(int));
4383 BUILD_BUG_ON(sizeof(atomic_t) != sizeof(u32));
4385 io_uring_optable_init();
4387 req_cachep = KMEM_CACHE(io_kiocb, SLAB_HWCACHE_ALIGN | SLAB_PANIC |
4391 __initcall(io_uring_init);