mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-12 13:55:32 +00:00
![Pavel Begunkov](/assets/img/avatar_default.png)
There is a bunch of inline helpers that will be useful not only to the core of io_uring, move them to headers. Signed-off-by: Pavel Begunkov <asml.silence@gmail.com> Link: https://lore.kernel.org/r/22df99c83723e44cba7e945e8519e64e3642c064.1655310733.git.asml.silence@gmail.com Signed-off-by: Jens Axboe <axboe@kernel.dk>
291 lines
8 KiB
C
291 lines
8 KiB
C
#ifndef IOU_CORE_H
|
|
#define IOU_CORE_H
|
|
|
|
#include <linux/errno.h>
|
|
#include <linux/lockdep.h>
|
|
#include "io_uring_types.h"
|
|
|
|
#ifndef CREATE_TRACE_POINTS
|
|
#include <trace/events/io_uring.h>
|
|
#endif
|
|
|
|
enum {
|
|
IOU_OK = 0,
|
|
IOU_ISSUE_SKIP_COMPLETE = -EIOCBQUEUED,
|
|
};
|
|
|
|
bool io_cqring_event_overflow(struct io_ring_ctx *ctx, u64 user_data, s32 res,
|
|
u32 cflags, u64 extra1, u64 extra2);
|
|
|
|
static inline unsigned int __io_cqring_events(struct io_ring_ctx *ctx)
|
|
{
|
|
return ctx->cached_cq_tail - READ_ONCE(ctx->rings->cq.head);
|
|
}
|
|
|
|
/*
|
|
* writes to the cq entry need to come after reading head; the
|
|
* control dependency is enough as we're using WRITE_ONCE to
|
|
* fill the cq entry
|
|
*/
|
|
static inline struct io_uring_cqe *__io_get_cqe(struct io_ring_ctx *ctx)
|
|
{
|
|
struct io_rings *rings = ctx->rings;
|
|
unsigned int off = ctx->cached_cq_tail & (ctx->cq_entries - 1);
|
|
unsigned int shift = 0;
|
|
unsigned int free, queued, len;
|
|
|
|
if (ctx->flags & IORING_SETUP_CQE32)
|
|
shift = 1;
|
|
|
|
/* userspace may cheat modifying the tail, be safe and do min */
|
|
queued = min(__io_cqring_events(ctx), ctx->cq_entries);
|
|
free = ctx->cq_entries - queued;
|
|
/* we need a contiguous range, limit based on the current array offset */
|
|
len = min(free, ctx->cq_entries - off);
|
|
if (!len)
|
|
return NULL;
|
|
|
|
ctx->cached_cq_tail++;
|
|
ctx->cqe_cached = &rings->cqes[off];
|
|
ctx->cqe_sentinel = ctx->cqe_cached + len;
|
|
ctx->cqe_cached++;
|
|
return &rings->cqes[off << shift];
|
|
}
|
|
|
|
static inline struct io_uring_cqe *io_get_cqe(struct io_ring_ctx *ctx)
|
|
{
|
|
if (likely(ctx->cqe_cached < ctx->cqe_sentinel)) {
|
|
struct io_uring_cqe *cqe = ctx->cqe_cached;
|
|
|
|
if (ctx->flags & IORING_SETUP_CQE32) {
|
|
unsigned int off = ctx->cqe_cached - ctx->rings->cqes;
|
|
|
|
cqe += off;
|
|
}
|
|
|
|
ctx->cached_cq_tail++;
|
|
ctx->cqe_cached++;
|
|
return cqe;
|
|
}
|
|
|
|
return __io_get_cqe(ctx);
|
|
}
|
|
|
|
static inline bool __io_fill_cqe_req(struct io_ring_ctx *ctx,
|
|
struct io_kiocb *req)
|
|
{
|
|
struct io_uring_cqe *cqe;
|
|
|
|
if (!(ctx->flags & IORING_SETUP_CQE32)) {
|
|
trace_io_uring_complete(req->ctx, req, req->cqe.user_data,
|
|
req->cqe.res, req->cqe.flags, 0, 0);
|
|
|
|
/*
|
|
* If we can't get a cq entry, userspace overflowed the
|
|
* submission (by quite a lot). Increment the overflow count in
|
|
* the ring.
|
|
*/
|
|
cqe = io_get_cqe(ctx);
|
|
if (likely(cqe)) {
|
|
memcpy(cqe, &req->cqe, sizeof(*cqe));
|
|
return true;
|
|
}
|
|
|
|
return io_cqring_event_overflow(ctx, req->cqe.user_data,
|
|
req->cqe.res, req->cqe.flags,
|
|
0, 0);
|
|
} else {
|
|
u64 extra1 = 0, extra2 = 0;
|
|
|
|
if (req->flags & REQ_F_CQE32_INIT) {
|
|
extra1 = req->extra1;
|
|
extra2 = req->extra2;
|
|
}
|
|
|
|
trace_io_uring_complete(req->ctx, req, req->cqe.user_data,
|
|
req->cqe.res, req->cqe.flags, extra1, extra2);
|
|
|
|
/*
|
|
* If we can't get a cq entry, userspace overflowed the
|
|
* submission (by quite a lot). Increment the overflow count in
|
|
* the ring.
|
|
*/
|
|
cqe = io_get_cqe(ctx);
|
|
if (likely(cqe)) {
|
|
memcpy(cqe, &req->cqe, sizeof(struct io_uring_cqe));
|
|
WRITE_ONCE(cqe->big_cqe[0], extra1);
|
|
WRITE_ONCE(cqe->big_cqe[1], extra2);
|
|
return true;
|
|
}
|
|
|
|
return io_cqring_event_overflow(ctx, req->cqe.user_data,
|
|
req->cqe.res, req->cqe.flags,
|
|
extra1, extra2);
|
|
}
|
|
}
|
|
|
|
static inline void req_set_fail(struct io_kiocb *req)
|
|
{
|
|
req->flags |= REQ_F_FAIL;
|
|
if (req->flags & REQ_F_CQE_SKIP) {
|
|
req->flags &= ~REQ_F_CQE_SKIP;
|
|
req->flags |= REQ_F_SKIP_LINK_CQES;
|
|
}
|
|
}
|
|
|
|
static inline void io_req_set_res(struct io_kiocb *req, s32 res, u32 cflags)
|
|
{
|
|
req->cqe.res = res;
|
|
req->cqe.flags = cflags;
|
|
}
|
|
|
|
static inline bool req_has_async_data(struct io_kiocb *req)
|
|
{
|
|
return req->flags & REQ_F_ASYNC_DATA;
|
|
}
|
|
|
|
static inline void io_put_file(struct file *file)
|
|
{
|
|
if (file)
|
|
fput(file);
|
|
}
|
|
|
|
static inline void io_ring_submit_unlock(struct io_ring_ctx *ctx,
|
|
unsigned issue_flags)
|
|
{
|
|
lockdep_assert_held(&ctx->uring_lock);
|
|
if (issue_flags & IO_URING_F_UNLOCKED)
|
|
mutex_unlock(&ctx->uring_lock);
|
|
}
|
|
|
|
static inline void io_ring_submit_lock(struct io_ring_ctx *ctx,
|
|
unsigned issue_flags)
|
|
{
|
|
/*
|
|
* "Normal" inline submissions always hold the uring_lock, since we
|
|
* grab it from the system call. Same is true for the SQPOLL offload.
|
|
* The only exception is when we've detached the request and issue it
|
|
* from an async worker thread, grab the lock for that case.
|
|
*/
|
|
if (issue_flags & IO_URING_F_UNLOCKED)
|
|
mutex_lock(&ctx->uring_lock);
|
|
lockdep_assert_held(&ctx->uring_lock);
|
|
}
|
|
|
|
static inline void io_commit_cqring(struct io_ring_ctx *ctx)
|
|
{
|
|
/* order cqe stores with ring update */
|
|
smp_store_release(&ctx->rings->cq.tail, ctx->cached_cq_tail);
|
|
}
|
|
|
|
static inline void io_cqring_wake(struct io_ring_ctx *ctx)
|
|
{
|
|
/*
|
|
* wake_up_all() may seem excessive, but io_wake_function() and
|
|
* io_should_wake() handle the termination of the loop and only
|
|
* wake as many waiters as we need to.
|
|
*/
|
|
if (wq_has_sleeper(&ctx->cq_wait))
|
|
wake_up_all(&ctx->cq_wait);
|
|
}
|
|
|
|
static inline bool io_sqring_full(struct io_ring_ctx *ctx)
|
|
{
|
|
struct io_rings *r = ctx->rings;
|
|
|
|
return READ_ONCE(r->sq.tail) - ctx->cached_sq_head == ctx->sq_entries;
|
|
}
|
|
|
|
static inline unsigned int io_sqring_entries(struct io_ring_ctx *ctx)
|
|
{
|
|
struct io_rings *rings = ctx->rings;
|
|
|
|
/* make sure SQ entry isn't read before tail */
|
|
return smp_load_acquire(&rings->sq.tail) - ctx->cached_sq_head;
|
|
}
|
|
|
|
static inline bool io_run_task_work(void)
|
|
{
|
|
if (test_thread_flag(TIF_NOTIFY_SIGNAL) || task_work_pending(current)) {
|
|
__set_current_state(TASK_RUNNING);
|
|
clear_notify_signal();
|
|
if (task_work_pending(current))
|
|
task_work_run();
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
static inline void io_req_complete_state(struct io_kiocb *req)
|
|
{
|
|
req->flags |= REQ_F_COMPLETE_INLINE;
|
|
}
|
|
|
|
static inline void io_tw_lock(struct io_ring_ctx *ctx, bool *locked)
|
|
{
|
|
if (!*locked) {
|
|
mutex_lock(&ctx->uring_lock);
|
|
*locked = true;
|
|
}
|
|
}
|
|
|
|
static inline void io_req_add_compl_list(struct io_kiocb *req)
|
|
{
|
|
struct io_submit_state *state = &req->ctx->submit_state;
|
|
|
|
if (!(req->flags & REQ_F_CQE_SKIP))
|
|
state->flush_cqes = true;
|
|
wq_list_add_tail(&req->comp_list, &state->compl_reqs);
|
|
}
|
|
|
|
int io_run_task_work_sig(void);
|
|
void io_req_complete_failed(struct io_kiocb *req, s32 res);
|
|
void __io_req_complete(struct io_kiocb *req, unsigned issue_flags);
|
|
void io_req_complete_post(struct io_kiocb *req);
|
|
void __io_req_complete_post(struct io_kiocb *req);
|
|
bool io_fill_cqe_aux(struct io_ring_ctx *ctx, u64 user_data, s32 res,
|
|
u32 cflags);
|
|
void io_cqring_ev_posted(struct io_ring_ctx *ctx);
|
|
void __io_commit_cqring_flush(struct io_ring_ctx *ctx);
|
|
|
|
struct page **io_pin_pages(unsigned long ubuf, unsigned long len, int *npages);
|
|
|
|
struct file *io_file_get_normal(struct io_kiocb *req, int fd);
|
|
struct file *io_file_get_fixed(struct io_kiocb *req, int fd,
|
|
unsigned issue_flags);
|
|
|
|
bool io_is_uring_fops(struct file *file);
|
|
bool io_alloc_async_data(struct io_kiocb *req);
|
|
void io_req_task_work_add(struct io_kiocb *req);
|
|
void io_req_task_prio_work_add(struct io_kiocb *req);
|
|
void io_req_tw_post_queue(struct io_kiocb *req, s32 res, u32 cflags);
|
|
void io_req_task_queue(struct io_kiocb *req);
|
|
void io_queue_iowq(struct io_kiocb *req, bool *dont_use);
|
|
void io_req_task_complete(struct io_kiocb *req, bool *locked);
|
|
void io_req_task_queue_fail(struct io_kiocb *req, int ret);
|
|
void io_req_task_submit(struct io_kiocb *req, bool *locked);
|
|
void tctx_task_work(struct callback_head *cb);
|
|
__cold void io_uring_cancel_generic(bool cancel_all, struct io_sq_data *sqd);
|
|
int io_uring_alloc_task_context(struct task_struct *task,
|
|
struct io_ring_ctx *ctx);
|
|
|
|
int io_poll_issue(struct io_kiocb *req, bool *locked);
|
|
int io_submit_sqes(struct io_ring_ctx *ctx, unsigned int nr);
|
|
int io_do_iopoll(struct io_ring_ctx *ctx, bool force_nonspin);
|
|
void io_free_batch_list(struct io_ring_ctx *ctx, struct io_wq_work_node *node);
|
|
int io_req_prep_async(struct io_kiocb *req);
|
|
|
|
struct io_wq_work *io_wq_free_work(struct io_wq_work *work);
|
|
void io_wq_submit_work(struct io_wq_work *work);
|
|
|
|
void io_free_req(struct io_kiocb *req);
|
|
void io_queue_next(struct io_kiocb *req);
|
|
|
|
bool io_match_task_safe(struct io_kiocb *head, struct task_struct *task,
|
|
bool cancel_all);
|
|
|
|
#define io_for_each_link(pos, head) \
|
|
for (pos = (head); pos; pos = pos->link)
|
|
|
|
#endif
|