1de23077eSJens Axboe #ifndef IOU_CORE_H 2de23077eSJens Axboe #define IOU_CORE_H 3de23077eSJens Axboe 4de23077eSJens Axboe #include <linux/errno.h> 5cd40cae2SJens Axboe #include <linux/lockdep.h> 6de23077eSJens Axboe #include "io_uring_types.h" 7de23077eSJens Axboe 8*f3b44f92SJens Axboe #ifndef CREATE_TRACE_POINTS 9*f3b44f92SJens Axboe #include <trace/events/io_uring.h> 10*f3b44f92SJens Axboe #endif 11*f3b44f92SJens Axboe 1297b388d7SJens Axboe enum { 1397b388d7SJens Axboe IOU_OK = 0, 1497b388d7SJens Axboe IOU_ISSUE_SKIP_COMPLETE = -EIOCBQUEUED, 1597b388d7SJens Axboe }; 1697b388d7SJens Axboe 17*f3b44f92SJens Axboe bool io_cqring_event_overflow(struct io_ring_ctx *ctx, u64 user_data, s32 res, 18*f3b44f92SJens Axboe u32 cflags, u64 extra1, u64 extra2); 19*f3b44f92SJens Axboe 20*f3b44f92SJens Axboe static inline unsigned int __io_cqring_events(struct io_ring_ctx *ctx) 21*f3b44f92SJens Axboe { 22*f3b44f92SJens Axboe return ctx->cached_cq_tail - READ_ONCE(ctx->rings->cq.head); 23*f3b44f92SJens Axboe } 24*f3b44f92SJens Axboe 25*f3b44f92SJens Axboe /* 26*f3b44f92SJens Axboe * writes to the cq entry need to come after reading head; the 27*f3b44f92SJens Axboe * control dependency is enough as we're using WRITE_ONCE to 28*f3b44f92SJens Axboe * fill the cq entry 29*f3b44f92SJens Axboe */ 30*f3b44f92SJens Axboe static inline struct io_uring_cqe *__io_get_cqe(struct io_ring_ctx *ctx) 31*f3b44f92SJens Axboe { 32*f3b44f92SJens Axboe struct io_rings *rings = ctx->rings; 33*f3b44f92SJens Axboe unsigned int off = ctx->cached_cq_tail & (ctx->cq_entries - 1); 34*f3b44f92SJens Axboe unsigned int shift = 0; 35*f3b44f92SJens Axboe unsigned int free, queued, len; 36*f3b44f92SJens Axboe 37*f3b44f92SJens Axboe if (ctx->flags & IORING_SETUP_CQE32) 38*f3b44f92SJens Axboe shift = 1; 39*f3b44f92SJens Axboe 40*f3b44f92SJens Axboe /* userspace may cheat modifying the tail, be safe and do min */ 41*f3b44f92SJens Axboe queued = min(__io_cqring_events(ctx), ctx->cq_entries); 42*f3b44f92SJens Axboe free = ctx->cq_entries - queued; 43*f3b44f92SJens Axboe /* we need a contiguous range, limit based on the current array offset */ 44*f3b44f92SJens Axboe len = min(free, ctx->cq_entries - off); 45*f3b44f92SJens Axboe if (!len) 46*f3b44f92SJens Axboe return NULL; 47*f3b44f92SJens Axboe 48*f3b44f92SJens Axboe ctx->cached_cq_tail++; 49*f3b44f92SJens Axboe ctx->cqe_cached = &rings->cqes[off]; 50*f3b44f92SJens Axboe ctx->cqe_sentinel = ctx->cqe_cached + len; 51*f3b44f92SJens Axboe ctx->cqe_cached++; 52*f3b44f92SJens Axboe return &rings->cqes[off << shift]; 53*f3b44f92SJens Axboe } 54*f3b44f92SJens Axboe 55*f3b44f92SJens Axboe static inline struct io_uring_cqe *io_get_cqe(struct io_ring_ctx *ctx) 56*f3b44f92SJens Axboe { 57*f3b44f92SJens Axboe if (likely(ctx->cqe_cached < ctx->cqe_sentinel)) { 58*f3b44f92SJens Axboe struct io_uring_cqe *cqe = ctx->cqe_cached; 59*f3b44f92SJens Axboe 60*f3b44f92SJens Axboe if (ctx->flags & IORING_SETUP_CQE32) { 61*f3b44f92SJens Axboe unsigned int off = ctx->cqe_cached - ctx->rings->cqes; 62*f3b44f92SJens Axboe 63*f3b44f92SJens Axboe cqe += off; 64*f3b44f92SJens Axboe } 65*f3b44f92SJens Axboe 66*f3b44f92SJens Axboe ctx->cached_cq_tail++; 67*f3b44f92SJens Axboe ctx->cqe_cached++; 68*f3b44f92SJens Axboe return cqe; 69*f3b44f92SJens Axboe } 70*f3b44f92SJens Axboe 71*f3b44f92SJens Axboe return __io_get_cqe(ctx); 72*f3b44f92SJens Axboe } 73*f3b44f92SJens Axboe 74*f3b44f92SJens Axboe static inline bool __io_fill_cqe_req(struct io_ring_ctx *ctx, 75*f3b44f92SJens Axboe struct io_kiocb *req) 76*f3b44f92SJens Axboe { 77*f3b44f92SJens Axboe struct io_uring_cqe *cqe; 78*f3b44f92SJens Axboe 79*f3b44f92SJens Axboe if (!(ctx->flags & IORING_SETUP_CQE32)) { 80*f3b44f92SJens Axboe trace_io_uring_complete(req->ctx, req, req->cqe.user_data, 81*f3b44f92SJens Axboe req->cqe.res, req->cqe.flags, 0, 0); 82*f3b44f92SJens Axboe 83*f3b44f92SJens Axboe /* 84*f3b44f92SJens Axboe * If we can't get a cq entry, userspace overflowed the 85*f3b44f92SJens Axboe * submission (by quite a lot). Increment the overflow count in 86*f3b44f92SJens Axboe * the ring. 87*f3b44f92SJens Axboe */ 88*f3b44f92SJens Axboe cqe = io_get_cqe(ctx); 89*f3b44f92SJens Axboe if (likely(cqe)) { 90*f3b44f92SJens Axboe memcpy(cqe, &req->cqe, sizeof(*cqe)); 91*f3b44f92SJens Axboe return true; 92*f3b44f92SJens Axboe } 93*f3b44f92SJens Axboe 94*f3b44f92SJens Axboe return io_cqring_event_overflow(ctx, req->cqe.user_data, 95*f3b44f92SJens Axboe req->cqe.res, req->cqe.flags, 96*f3b44f92SJens Axboe 0, 0); 97*f3b44f92SJens Axboe } else { 98*f3b44f92SJens Axboe u64 extra1 = 0, extra2 = 0; 99*f3b44f92SJens Axboe 100*f3b44f92SJens Axboe if (req->flags & REQ_F_CQE32_INIT) { 101*f3b44f92SJens Axboe extra1 = req->extra1; 102*f3b44f92SJens Axboe extra2 = req->extra2; 103*f3b44f92SJens Axboe } 104*f3b44f92SJens Axboe 105*f3b44f92SJens Axboe trace_io_uring_complete(req->ctx, req, req->cqe.user_data, 106*f3b44f92SJens Axboe req->cqe.res, req->cqe.flags, extra1, extra2); 107*f3b44f92SJens Axboe 108*f3b44f92SJens Axboe /* 109*f3b44f92SJens Axboe * If we can't get a cq entry, userspace overflowed the 110*f3b44f92SJens Axboe * submission (by quite a lot). Increment the overflow count in 111*f3b44f92SJens Axboe * the ring. 112*f3b44f92SJens Axboe */ 113*f3b44f92SJens Axboe cqe = io_get_cqe(ctx); 114*f3b44f92SJens Axboe if (likely(cqe)) { 115*f3b44f92SJens Axboe memcpy(cqe, &req->cqe, sizeof(struct io_uring_cqe)); 116*f3b44f92SJens Axboe WRITE_ONCE(cqe->big_cqe[0], extra1); 117*f3b44f92SJens Axboe WRITE_ONCE(cqe->big_cqe[1], extra2); 118*f3b44f92SJens Axboe return true; 119*f3b44f92SJens Axboe } 120*f3b44f92SJens Axboe 121*f3b44f92SJens Axboe return io_cqring_event_overflow(ctx, req->cqe.user_data, 122*f3b44f92SJens Axboe req->cqe.res, req->cqe.flags, 123*f3b44f92SJens Axboe extra1, extra2); 124*f3b44f92SJens Axboe } 125*f3b44f92SJens Axboe } 126*f3b44f92SJens Axboe 127531113bbSJens Axboe static inline void req_set_fail(struct io_kiocb *req) 128531113bbSJens Axboe { 129531113bbSJens Axboe req->flags |= REQ_F_FAIL; 130531113bbSJens Axboe if (req->flags & REQ_F_CQE_SKIP) { 131531113bbSJens Axboe req->flags &= ~REQ_F_CQE_SKIP; 132531113bbSJens Axboe req->flags |= REQ_F_SKIP_LINK_CQES; 133531113bbSJens Axboe } 134531113bbSJens Axboe } 135531113bbSJens Axboe 136de23077eSJens Axboe static inline void io_req_set_res(struct io_kiocb *req, s32 res, u32 cflags) 137de23077eSJens Axboe { 138de23077eSJens Axboe req->cqe.res = res; 139de23077eSJens Axboe req->cqe.flags = cflags; 140de23077eSJens Axboe } 141de23077eSJens Axboe 14299f15d8dSJens Axboe static inline bool req_has_async_data(struct io_kiocb *req) 14399f15d8dSJens Axboe { 14499f15d8dSJens Axboe return req->flags & REQ_F_ASYNC_DATA; 14599f15d8dSJens Axboe } 14699f15d8dSJens Axboe 147531113bbSJens Axboe static inline void io_put_file(struct file *file) 148531113bbSJens Axboe { 149531113bbSJens Axboe if (file) 150531113bbSJens Axboe fput(file); 151531113bbSJens Axboe } 152531113bbSJens Axboe 153cd40cae2SJens Axboe static inline void io_ring_submit_unlock(struct io_ring_ctx *ctx, 154cd40cae2SJens Axboe unsigned issue_flags) 155cd40cae2SJens Axboe { 156cd40cae2SJens Axboe lockdep_assert_held(&ctx->uring_lock); 157cd40cae2SJens Axboe if (issue_flags & IO_URING_F_UNLOCKED) 158cd40cae2SJens Axboe mutex_unlock(&ctx->uring_lock); 159cd40cae2SJens Axboe } 160cd40cae2SJens Axboe 161cd40cae2SJens Axboe static inline void io_ring_submit_lock(struct io_ring_ctx *ctx, 162cd40cae2SJens Axboe unsigned issue_flags) 163cd40cae2SJens Axboe { 164cd40cae2SJens Axboe /* 165cd40cae2SJens Axboe * "Normal" inline submissions always hold the uring_lock, since we 166cd40cae2SJens Axboe * grab it from the system call. Same is true for the SQPOLL offload. 167cd40cae2SJens Axboe * The only exception is when we've detached the request and issue it 168cd40cae2SJens Axboe * from an async worker thread, grab the lock for that case. 169cd40cae2SJens Axboe */ 170cd40cae2SJens Axboe if (issue_flags & IO_URING_F_UNLOCKED) 171cd40cae2SJens Axboe mutex_lock(&ctx->uring_lock); 172cd40cae2SJens Axboe lockdep_assert_held(&ctx->uring_lock); 173cd40cae2SJens Axboe } 174cd40cae2SJens Axboe 175f9ead18cSJens Axboe static inline void io_commit_cqring(struct io_ring_ctx *ctx) 176f9ead18cSJens Axboe { 177f9ead18cSJens Axboe /* order cqe stores with ring update */ 178f9ead18cSJens Axboe smp_store_release(&ctx->rings->cq.tail, ctx->cached_cq_tail); 179f9ead18cSJens Axboe } 180f9ead18cSJens Axboe 181*f3b44f92SJens Axboe static inline void io_cqring_wake(struct io_ring_ctx *ctx) 182*f3b44f92SJens Axboe { 183*f3b44f92SJens Axboe /* 184*f3b44f92SJens Axboe * wake_up_all() may seem excessive, but io_wake_function() and 185*f3b44f92SJens Axboe * io_should_wake() handle the termination of the loop and only 186*f3b44f92SJens Axboe * wake as many waiters as we need to. 187*f3b44f92SJens Axboe */ 188*f3b44f92SJens Axboe if (wq_has_sleeper(&ctx->cq_wait)) 189*f3b44f92SJens Axboe wake_up_all(&ctx->cq_wait); 190*f3b44f92SJens Axboe } 191*f3b44f92SJens Axboe 19217437f31SJens Axboe static inline bool io_sqring_full(struct io_ring_ctx *ctx) 19317437f31SJens Axboe { 19417437f31SJens Axboe struct io_rings *r = ctx->rings; 19517437f31SJens Axboe 19617437f31SJens Axboe return READ_ONCE(r->sq.tail) - ctx->cached_sq_head == ctx->sq_entries; 19717437f31SJens Axboe } 19817437f31SJens Axboe 19917437f31SJens Axboe static inline unsigned int io_sqring_entries(struct io_ring_ctx *ctx) 20017437f31SJens Axboe { 20117437f31SJens Axboe struct io_rings *rings = ctx->rings; 20217437f31SJens Axboe 20317437f31SJens Axboe /* make sure SQ entry isn't read before tail */ 20417437f31SJens Axboe return smp_load_acquire(&rings->sq.tail) - ctx->cached_sq_head; 20517437f31SJens Axboe } 20617437f31SJens Axboe 20717437f31SJens Axboe static inline bool io_run_task_work(void) 20817437f31SJens Axboe { 20917437f31SJens Axboe if (test_thread_flag(TIF_NOTIFY_SIGNAL) || task_work_pending(current)) { 21017437f31SJens Axboe __set_current_state(TASK_RUNNING); 21117437f31SJens Axboe clear_notify_signal(); 21217437f31SJens Axboe if (task_work_pending(current)) 21317437f31SJens Axboe task_work_run(); 21417437f31SJens Axboe return true; 21517437f31SJens Axboe } 21617437f31SJens Axboe 21717437f31SJens Axboe return false; 21817437f31SJens Axboe } 21917437f31SJens Axboe 22073572984SJens Axboe int io_run_task_work_sig(void); 221329061d3SJens Axboe void io_req_complete_failed(struct io_kiocb *req, s32 res); 22299f15d8dSJens Axboe void __io_req_complete(struct io_kiocb *req, unsigned issue_flags); 22359915143SJens Axboe void io_req_complete_post(struct io_kiocb *req); 22459915143SJens Axboe void __io_req_complete_post(struct io_kiocb *req); 225f9ead18cSJens Axboe bool io_fill_cqe_aux(struct io_ring_ctx *ctx, u64 user_data, s32 res, 226f9ead18cSJens Axboe u32 cflags); 227f9ead18cSJens Axboe void io_cqring_ev_posted(struct io_ring_ctx *ctx); 228*f3b44f92SJens Axboe void __io_commit_cqring_flush(struct io_ring_ctx *ctx); 229f9ead18cSJens Axboe 2303b77495aSJens Axboe struct page **io_pin_pages(unsigned long ubuf, unsigned long len, int *npages); 231329061d3SJens Axboe 232531113bbSJens Axboe struct file *io_file_get_normal(struct io_kiocb *req, int fd); 233531113bbSJens Axboe struct file *io_file_get_fixed(struct io_kiocb *req, int fd, 234531113bbSJens Axboe unsigned issue_flags); 235cd40cae2SJens Axboe 236cd40cae2SJens Axboe bool io_is_uring_fops(struct file *file); 23799f15d8dSJens Axboe bool io_alloc_async_data(struct io_kiocb *req); 23899f15d8dSJens Axboe void io_req_task_work_add(struct io_kiocb *req); 239*f3b44f92SJens Axboe void io_req_task_prio_work_add(struct io_kiocb *req); 24059915143SJens Axboe void io_req_tw_post_queue(struct io_kiocb *req, s32 res, u32 cflags); 241*f3b44f92SJens Axboe void io_req_task_queue(struct io_kiocb *req); 242*f3b44f92SJens Axboe void io_queue_iowq(struct io_kiocb *req, bool *dont_use); 24359915143SJens Axboe void io_req_task_complete(struct io_kiocb *req, bool *locked); 24459915143SJens Axboe void io_req_task_queue_fail(struct io_kiocb *req, int ret); 245329061d3SJens Axboe void io_req_task_submit(struct io_kiocb *req, bool *locked); 246c9f06aa7SJens Axboe void tctx_task_work(struct callback_head *cb); 24717437f31SJens Axboe __cold void io_uring_cancel_generic(bool cancel_all, struct io_sq_data *sqd); 24817437f31SJens Axboe int io_uring_alloc_task_context(struct task_struct *task, 24917437f31SJens Axboe struct io_ring_ctx *ctx); 25017437f31SJens Axboe 251329061d3SJens Axboe int io_poll_issue(struct io_kiocb *req, bool *locked); 25217437f31SJens Axboe int io_submit_sqes(struct io_ring_ctx *ctx, unsigned int nr); 25317437f31SJens Axboe int io_do_iopoll(struct io_ring_ctx *ctx, bool force_nonspin); 254*f3b44f92SJens Axboe void io_free_batch_list(struct io_ring_ctx *ctx, struct io_wq_work_node *node); 255*f3b44f92SJens Axboe int io_req_prep_async(struct io_kiocb *req); 25659915143SJens Axboe 257c9f06aa7SJens Axboe struct io_wq_work *io_wq_free_work(struct io_wq_work *work); 258c9f06aa7SJens Axboe void io_wq_submit_work(struct io_wq_work *work); 259c9f06aa7SJens Axboe 26059915143SJens Axboe void io_free_req(struct io_kiocb *req); 26159915143SJens Axboe void io_queue_next(struct io_kiocb *req); 26259915143SJens Axboe 263329061d3SJens Axboe bool io_match_task_safe(struct io_kiocb *head, struct task_struct *task, 264329061d3SJens Axboe bool cancel_all); 265329061d3SJens Axboe 26659915143SJens Axboe #define io_for_each_link(pos, head) \ 26759915143SJens Axboe for (pos = (head); pos; pos = pos->link) 268531113bbSJens Axboe 269de23077eSJens Axboe #endif 270