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 8f3b44f92SJens Axboe #ifndef CREATE_TRACE_POINTS 9f3b44f92SJens Axboe #include <trace/events/io_uring.h> 10f3b44f92SJens Axboe #endif 11f3b44f92SJens Axboe 1297b388d7SJens Axboe enum { 1397b388d7SJens Axboe IOU_OK = 0, 1497b388d7SJens Axboe IOU_ISSUE_SKIP_COMPLETE = -EIOCBQUEUED, 1597b388d7SJens Axboe }; 1697b388d7SJens Axboe 17faf88ddeSPavel Begunkov struct io_uring_cqe *__io_get_cqe(struct io_ring_ctx *ctx); 1868494a65SPavel Begunkov bool io_req_cqe_overflow(struct io_kiocb *req); 19f3b44f92SJens Axboe 20f3b44f92SJens Axboe static inline struct io_uring_cqe *io_get_cqe(struct io_ring_ctx *ctx) 21f3b44f92SJens Axboe { 22f3b44f92SJens Axboe if (likely(ctx->cqe_cached < ctx->cqe_sentinel)) { 23f3b44f92SJens Axboe struct io_uring_cqe *cqe = ctx->cqe_cached; 24f3b44f92SJens Axboe 25f3b44f92SJens Axboe ctx->cached_cq_tail++; 26f3b44f92SJens Axboe ctx->cqe_cached++; 27*b3659a65SPavel Begunkov if (ctx->flags & IORING_SETUP_CQE32) 28*b3659a65SPavel Begunkov ctx->cqe_cached++; 29f3b44f92SJens Axboe return cqe; 30f3b44f92SJens Axboe } 31f3b44f92SJens Axboe 32f3b44f92SJens Axboe return __io_get_cqe(ctx); 33f3b44f92SJens Axboe } 34f3b44f92SJens Axboe 35f3b44f92SJens Axboe static inline bool __io_fill_cqe_req(struct io_ring_ctx *ctx, 36f3b44f92SJens Axboe struct io_kiocb *req) 37f3b44f92SJens Axboe { 38f3b44f92SJens Axboe struct io_uring_cqe *cqe; 39f3b44f92SJens Axboe 40f3b44f92SJens Axboe trace_io_uring_complete(req->ctx, req, req->cqe.user_data, 41ae5735c6SPavel Begunkov req->cqe.res, req->cqe.flags, 42ae5735c6SPavel Begunkov (req->flags & REQ_F_CQE32_INIT) ? req->extra1 : 0, 43ae5735c6SPavel Begunkov (req->flags & REQ_F_CQE32_INIT) ? req->extra2 : 0); 44f3b44f92SJens Axboe /* 45f3b44f92SJens Axboe * If we can't get a cq entry, userspace overflowed the 46f3b44f92SJens Axboe * submission (by quite a lot). Increment the overflow count in 47f3b44f92SJens Axboe * the ring. 48f3b44f92SJens Axboe */ 49f3b44f92SJens Axboe cqe = io_get_cqe(ctx); 50e8c328c3SPavel Begunkov if (unlikely(!cqe)) 51e8c328c3SPavel Begunkov return io_req_cqe_overflow(req); 52f3b44f92SJens Axboe memcpy(cqe, &req->cqe, sizeof(*cqe)); 53e8c328c3SPavel Begunkov 54e8c328c3SPavel Begunkov if (ctx->flags & IORING_SETUP_CQE32) { 55f3b44f92SJens Axboe u64 extra1 = 0, extra2 = 0; 56f3b44f92SJens Axboe 57f3b44f92SJens Axboe if (req->flags & REQ_F_CQE32_INIT) { 58f3b44f92SJens Axboe extra1 = req->extra1; 59f3b44f92SJens Axboe extra2 = req->extra2; 60f3b44f92SJens Axboe } 61f3b44f92SJens Axboe 62f3b44f92SJens Axboe WRITE_ONCE(cqe->big_cqe[0], extra1); 63f3b44f92SJens Axboe WRITE_ONCE(cqe->big_cqe[1], extra2); 64e8c328c3SPavel Begunkov } 65f3b44f92SJens Axboe return true; 66f3b44f92SJens Axboe } 67f3b44f92SJens Axboe 68531113bbSJens Axboe static inline void req_set_fail(struct io_kiocb *req) 69531113bbSJens Axboe { 70531113bbSJens Axboe req->flags |= REQ_F_FAIL; 71531113bbSJens Axboe if (req->flags & REQ_F_CQE_SKIP) { 72531113bbSJens Axboe req->flags &= ~REQ_F_CQE_SKIP; 73531113bbSJens Axboe req->flags |= REQ_F_SKIP_LINK_CQES; 74531113bbSJens Axboe } 75531113bbSJens Axboe } 76531113bbSJens Axboe 77de23077eSJens Axboe static inline void io_req_set_res(struct io_kiocb *req, s32 res, u32 cflags) 78de23077eSJens Axboe { 79de23077eSJens Axboe req->cqe.res = res; 80de23077eSJens Axboe req->cqe.flags = cflags; 81de23077eSJens Axboe } 82de23077eSJens Axboe 8399f15d8dSJens Axboe static inline bool req_has_async_data(struct io_kiocb *req) 8499f15d8dSJens Axboe { 8599f15d8dSJens Axboe return req->flags & REQ_F_ASYNC_DATA; 8699f15d8dSJens Axboe } 8799f15d8dSJens Axboe 88531113bbSJens Axboe static inline void io_put_file(struct file *file) 89531113bbSJens Axboe { 90531113bbSJens Axboe if (file) 91531113bbSJens Axboe fput(file); 92531113bbSJens Axboe } 93531113bbSJens Axboe 94cd40cae2SJens Axboe static inline void io_ring_submit_unlock(struct io_ring_ctx *ctx, 95cd40cae2SJens Axboe unsigned issue_flags) 96cd40cae2SJens Axboe { 97cd40cae2SJens Axboe lockdep_assert_held(&ctx->uring_lock); 98cd40cae2SJens Axboe if (issue_flags & IO_URING_F_UNLOCKED) 99cd40cae2SJens Axboe mutex_unlock(&ctx->uring_lock); 100cd40cae2SJens Axboe } 101cd40cae2SJens Axboe 102cd40cae2SJens Axboe static inline void io_ring_submit_lock(struct io_ring_ctx *ctx, 103cd40cae2SJens Axboe unsigned issue_flags) 104cd40cae2SJens Axboe { 105cd40cae2SJens Axboe /* 106cd40cae2SJens Axboe * "Normal" inline submissions always hold the uring_lock, since we 107cd40cae2SJens Axboe * grab it from the system call. Same is true for the SQPOLL offload. 108cd40cae2SJens Axboe * The only exception is when we've detached the request and issue it 109cd40cae2SJens Axboe * from an async worker thread, grab the lock for that case. 110cd40cae2SJens Axboe */ 111cd40cae2SJens Axboe if (issue_flags & IO_URING_F_UNLOCKED) 112cd40cae2SJens Axboe mutex_lock(&ctx->uring_lock); 113cd40cae2SJens Axboe lockdep_assert_held(&ctx->uring_lock); 114cd40cae2SJens Axboe } 115cd40cae2SJens Axboe 116f9ead18cSJens Axboe static inline void io_commit_cqring(struct io_ring_ctx *ctx) 117f9ead18cSJens Axboe { 118f9ead18cSJens Axboe /* order cqe stores with ring update */ 119f9ead18cSJens Axboe smp_store_release(&ctx->rings->cq.tail, ctx->cached_cq_tail); 120f9ead18cSJens Axboe } 121f9ead18cSJens Axboe 122f3b44f92SJens Axboe static inline void io_cqring_wake(struct io_ring_ctx *ctx) 123f3b44f92SJens Axboe { 124f3b44f92SJens Axboe /* 125f3b44f92SJens Axboe * wake_up_all() may seem excessive, but io_wake_function() and 126f3b44f92SJens Axboe * io_should_wake() handle the termination of the loop and only 127f3b44f92SJens Axboe * wake as many waiters as we need to. 128f3b44f92SJens Axboe */ 129f3b44f92SJens Axboe if (wq_has_sleeper(&ctx->cq_wait)) 130f3b44f92SJens Axboe wake_up_all(&ctx->cq_wait); 131f3b44f92SJens Axboe } 132f3b44f92SJens Axboe 13317437f31SJens Axboe static inline bool io_sqring_full(struct io_ring_ctx *ctx) 13417437f31SJens Axboe { 13517437f31SJens Axboe struct io_rings *r = ctx->rings; 13617437f31SJens Axboe 13717437f31SJens Axboe return READ_ONCE(r->sq.tail) - ctx->cached_sq_head == ctx->sq_entries; 13817437f31SJens Axboe } 13917437f31SJens Axboe 14017437f31SJens Axboe static inline unsigned int io_sqring_entries(struct io_ring_ctx *ctx) 14117437f31SJens Axboe { 14217437f31SJens Axboe struct io_rings *rings = ctx->rings; 14317437f31SJens Axboe 14417437f31SJens Axboe /* make sure SQ entry isn't read before tail */ 14517437f31SJens Axboe return smp_load_acquire(&rings->sq.tail) - ctx->cached_sq_head; 14617437f31SJens Axboe } 14717437f31SJens Axboe 14817437f31SJens Axboe static inline bool io_run_task_work(void) 14917437f31SJens Axboe { 15017437f31SJens Axboe if (test_thread_flag(TIF_NOTIFY_SIGNAL) || task_work_pending(current)) { 15117437f31SJens Axboe __set_current_state(TASK_RUNNING); 15217437f31SJens Axboe clear_notify_signal(); 15317437f31SJens Axboe if (task_work_pending(current)) 15417437f31SJens Axboe task_work_run(); 15517437f31SJens Axboe return true; 15617437f31SJens Axboe } 15717437f31SJens Axboe 15817437f31SJens Axboe return false; 15917437f31SJens Axboe } 16017437f31SJens Axboe 161aa1e90f6SPavel Begunkov static inline void io_tw_lock(struct io_ring_ctx *ctx, bool *locked) 162aa1e90f6SPavel Begunkov { 163aa1e90f6SPavel Begunkov if (!*locked) { 164aa1e90f6SPavel Begunkov mutex_lock(&ctx->uring_lock); 165aa1e90f6SPavel Begunkov *locked = true; 166aa1e90f6SPavel Begunkov } 167aa1e90f6SPavel Begunkov } 168aa1e90f6SPavel Begunkov 169aa1e90f6SPavel Begunkov static inline void io_req_add_compl_list(struct io_kiocb *req) 170aa1e90f6SPavel Begunkov { 171aa1e90f6SPavel Begunkov struct io_submit_state *state = &req->ctx->submit_state; 172aa1e90f6SPavel Begunkov 173aa1e90f6SPavel Begunkov if (!(req->flags & REQ_F_CQE_SKIP)) 174aa1e90f6SPavel Begunkov state->flush_cqes = true; 175aa1e90f6SPavel Begunkov wq_list_add_tail(&req->comp_list, &state->compl_reqs); 176aa1e90f6SPavel Begunkov } 177aa1e90f6SPavel Begunkov 17873572984SJens Axboe int io_run_task_work_sig(void); 179329061d3SJens Axboe void io_req_complete_failed(struct io_kiocb *req, s32 res); 18099f15d8dSJens Axboe void __io_req_complete(struct io_kiocb *req, unsigned issue_flags); 18159915143SJens Axboe void io_req_complete_post(struct io_kiocb *req); 18259915143SJens Axboe void __io_req_complete_post(struct io_kiocb *req); 183d245bca6SPavel Begunkov bool io_post_aux_cqe(struct io_ring_ctx *ctx, u64 user_data, s32 res, u32 cflags); 184f9ead18cSJens Axboe void io_cqring_ev_posted(struct io_ring_ctx *ctx); 185f3b44f92SJens Axboe void __io_commit_cqring_flush(struct io_ring_ctx *ctx); 186f9ead18cSJens Axboe 1873b77495aSJens Axboe struct page **io_pin_pages(unsigned long ubuf, unsigned long len, int *npages); 188329061d3SJens Axboe 189531113bbSJens Axboe struct file *io_file_get_normal(struct io_kiocb *req, int fd); 190531113bbSJens Axboe struct file *io_file_get_fixed(struct io_kiocb *req, int fd, 191531113bbSJens Axboe unsigned issue_flags); 192cd40cae2SJens Axboe 193cd40cae2SJens Axboe bool io_is_uring_fops(struct file *file); 19499f15d8dSJens Axboe bool io_alloc_async_data(struct io_kiocb *req); 19599f15d8dSJens Axboe void io_req_task_work_add(struct io_kiocb *req); 196f3b44f92SJens Axboe void io_req_task_prio_work_add(struct io_kiocb *req); 19759915143SJens Axboe void io_req_tw_post_queue(struct io_kiocb *req, s32 res, u32 cflags); 198f3b44f92SJens Axboe void io_req_task_queue(struct io_kiocb *req); 199f3b44f92SJens Axboe void io_queue_iowq(struct io_kiocb *req, bool *dont_use); 20059915143SJens Axboe void io_req_task_complete(struct io_kiocb *req, bool *locked); 20159915143SJens Axboe void io_req_task_queue_fail(struct io_kiocb *req, int ret); 202329061d3SJens Axboe void io_req_task_submit(struct io_kiocb *req, bool *locked); 203c9f06aa7SJens Axboe void tctx_task_work(struct callback_head *cb); 20417437f31SJens Axboe __cold void io_uring_cancel_generic(bool cancel_all, struct io_sq_data *sqd); 20517437f31SJens Axboe int io_uring_alloc_task_context(struct task_struct *task, 20617437f31SJens Axboe struct io_ring_ctx *ctx); 20717437f31SJens Axboe 208329061d3SJens Axboe int io_poll_issue(struct io_kiocb *req, bool *locked); 20917437f31SJens Axboe int io_submit_sqes(struct io_ring_ctx *ctx, unsigned int nr); 21017437f31SJens Axboe int io_do_iopoll(struct io_ring_ctx *ctx, bool force_nonspin); 211f3b44f92SJens Axboe void io_free_batch_list(struct io_ring_ctx *ctx, struct io_wq_work_node *node); 212f3b44f92SJens Axboe int io_req_prep_async(struct io_kiocb *req); 21359915143SJens Axboe 214c9f06aa7SJens Axboe struct io_wq_work *io_wq_free_work(struct io_wq_work *work); 215c9f06aa7SJens Axboe void io_wq_submit_work(struct io_wq_work *work); 216c9f06aa7SJens Axboe 21759915143SJens Axboe void io_free_req(struct io_kiocb *req); 21859915143SJens Axboe void io_queue_next(struct io_kiocb *req); 21959915143SJens Axboe 220329061d3SJens Axboe bool io_match_task_safe(struct io_kiocb *head, struct task_struct *task, 221329061d3SJens Axboe bool cancel_all); 222329061d3SJens Axboe 22359915143SJens Axboe #define io_for_each_link(pos, head) \ 22459915143SJens Axboe for (pos = (head); pos; pos = pos->link) 225531113bbSJens Axboe 226de23077eSJens Axboe #endif 227