xref: /openbmc/linux/io_uring/io_uring.h (revision 99f15d8d)
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 
897b388d7SJens Axboe enum {
997b388d7SJens Axboe 	IOU_OK			= 0,
1097b388d7SJens Axboe 	IOU_ISSUE_SKIP_COMPLETE	= -EIOCBQUEUED,
1197b388d7SJens Axboe };
1297b388d7SJens Axboe 
13531113bbSJens Axboe static inline void req_set_fail(struct io_kiocb *req)
14531113bbSJens Axboe {
15531113bbSJens Axboe 	req->flags |= REQ_F_FAIL;
16531113bbSJens Axboe 	if (req->flags & REQ_F_CQE_SKIP) {
17531113bbSJens Axboe 		req->flags &= ~REQ_F_CQE_SKIP;
18531113bbSJens Axboe 		req->flags |= REQ_F_SKIP_LINK_CQES;
19531113bbSJens Axboe 	}
20531113bbSJens Axboe }
21531113bbSJens Axboe 
22de23077eSJens Axboe static inline void io_req_set_res(struct io_kiocb *req, s32 res, u32 cflags)
23de23077eSJens Axboe {
24de23077eSJens Axboe 	req->cqe.res = res;
25de23077eSJens Axboe 	req->cqe.flags = cflags;
26de23077eSJens Axboe }
27de23077eSJens Axboe 
28*99f15d8dSJens Axboe static inline bool req_has_async_data(struct io_kiocb *req)
29*99f15d8dSJens Axboe {
30*99f15d8dSJens Axboe 	return req->flags & REQ_F_ASYNC_DATA;
31*99f15d8dSJens Axboe }
32*99f15d8dSJens Axboe 
33531113bbSJens Axboe static inline void io_put_file(struct file *file)
34531113bbSJens Axboe {
35531113bbSJens Axboe 	if (file)
36531113bbSJens Axboe 		fput(file);
37531113bbSJens Axboe }
38531113bbSJens Axboe 
39cd40cae2SJens Axboe static inline void io_ring_submit_unlock(struct io_ring_ctx *ctx,
40cd40cae2SJens Axboe 					 unsigned issue_flags)
41cd40cae2SJens Axboe {
42cd40cae2SJens Axboe 	lockdep_assert_held(&ctx->uring_lock);
43cd40cae2SJens Axboe 	if (issue_flags & IO_URING_F_UNLOCKED)
44cd40cae2SJens Axboe 		mutex_unlock(&ctx->uring_lock);
45cd40cae2SJens Axboe }
46cd40cae2SJens Axboe 
47cd40cae2SJens Axboe static inline void io_ring_submit_lock(struct io_ring_ctx *ctx,
48cd40cae2SJens Axboe 				       unsigned issue_flags)
49cd40cae2SJens Axboe {
50cd40cae2SJens Axboe 	/*
51cd40cae2SJens Axboe 	 * "Normal" inline submissions always hold the uring_lock, since we
52cd40cae2SJens Axboe 	 * grab it from the system call. Same is true for the SQPOLL offload.
53cd40cae2SJens Axboe 	 * The only exception is when we've detached the request and issue it
54cd40cae2SJens Axboe 	 * from an async worker thread, grab the lock for that case.
55cd40cae2SJens Axboe 	 */
56cd40cae2SJens Axboe 	if (issue_flags & IO_URING_F_UNLOCKED)
57cd40cae2SJens Axboe 		mutex_lock(&ctx->uring_lock);
58cd40cae2SJens Axboe 	lockdep_assert_held(&ctx->uring_lock);
59cd40cae2SJens Axboe }
60cd40cae2SJens Axboe 
61*99f15d8dSJens Axboe void __io_req_complete(struct io_kiocb *req, unsigned issue_flags);
62*99f15d8dSJens Axboe 
63531113bbSJens Axboe struct file *io_file_get_normal(struct io_kiocb *req, int fd);
64531113bbSJens Axboe struct file *io_file_get_fixed(struct io_kiocb *req, int fd,
65531113bbSJens Axboe 			       unsigned issue_flags);
66cd40cae2SJens Axboe int io_fixed_fd_install(struct io_kiocb *req, unsigned int issue_flags,
67cd40cae2SJens Axboe 			struct file *file, unsigned int file_slot);
68cd40cae2SJens Axboe 
69cd40cae2SJens Axboe int io_rsrc_node_switch_start(struct io_ring_ctx *ctx);
70cd40cae2SJens Axboe int io_queue_rsrc_removal(struct io_rsrc_data *data, unsigned idx,
71cd40cae2SJens Axboe 			  struct io_rsrc_node *node, void *rsrc);
72cd40cae2SJens Axboe void io_rsrc_node_switch(struct io_ring_ctx *ctx,
73cd40cae2SJens Axboe 			 struct io_rsrc_data *data_to_kill);
74cd40cae2SJens Axboe bool io_is_uring_fops(struct file *file);
75*99f15d8dSJens Axboe bool io_alloc_async_data(struct io_kiocb *req);
76*99f15d8dSJens Axboe void io_req_task_work_add(struct io_kiocb *req);
77531113bbSJens Axboe 
78de23077eSJens Axboe #endif
79