xref: /linux-6.15/include/linux/io_uring.h (revision 9397fa2e)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef _LINUX_IO_URING_H
3 #define _LINUX_IO_URING_H
4 
5 #include <linux/sched.h>
6 #include <linux/xarray.h>
7 #include <uapi/linux/io_uring.h>
8 
9 enum io_uring_cmd_flags {
10 	IO_URING_F_COMPLETE_DEFER	= 1,
11 	IO_URING_F_UNLOCKED		= 2,
12 	/* the request is executed from poll, it should not be freed */
13 	IO_URING_F_MULTISHOT		= 4,
14 	/* executed by io-wq */
15 	IO_URING_F_IOWQ			= 8,
16 	/* int's last bit, sign checks are usually faster than a bit test */
17 	IO_URING_F_NONBLOCK		= INT_MIN,
18 
19 	/* ctx state flags, for URING_CMD */
20 	IO_URING_F_SQE128		= (1 << 8),
21 	IO_URING_F_CQE32		= (1 << 9),
22 	IO_URING_F_IOPOLL		= (1 << 10),
23 };
24 
25 struct io_uring_cmd {
26 	struct file	*file;
27 	const struct io_uring_sqe *sqe;
28 	union {
29 		/* callback to defer completions to task context */
30 		void (*task_work_cb)(struct io_uring_cmd *cmd, unsigned);
31 		/* used for polled completion */
32 		void *cookie;
33 	};
34 	u32		cmd_op;
35 	u32		flags;
36 	u8		pdu[32]; /* available inline for free use */
37 };
38 
39 #if defined(CONFIG_IO_URING)
40 int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
41 			      struct iov_iter *iter, void *ioucmd);
42 void io_uring_cmd_done(struct io_uring_cmd *cmd, ssize_t ret, ssize_t res2,
43 			unsigned issue_flags);
44 void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd,
45 			void (*task_work_cb)(struct io_uring_cmd *, unsigned));
46 struct sock *io_uring_get_socket(struct file *file);
47 void __io_uring_cancel(bool cancel_all);
48 void __io_uring_free(struct task_struct *tsk);
49 void io_uring_unreg_ringfd(void);
50 const char *io_uring_get_opcode(u8 opcode);
51 
52 static inline void io_uring_files_cancel(void)
53 {
54 	if (current->io_uring) {
55 		io_uring_unreg_ringfd();
56 		__io_uring_cancel(false);
57 	}
58 }
59 static inline void io_uring_task_cancel(void)
60 {
61 	if (current->io_uring)
62 		__io_uring_cancel(true);
63 }
64 static inline void io_uring_free(struct task_struct *tsk)
65 {
66 	if (tsk->io_uring)
67 		__io_uring_free(tsk);
68 }
69 
70 static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe)
71 {
72 	return sqe->cmd;
73 }
74 #else
75 static inline int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,
76 			      struct iov_iter *iter, void *ioucmd)
77 {
78 	return -EOPNOTSUPP;
79 }
80 static inline void io_uring_cmd_done(struct io_uring_cmd *cmd, ssize_t ret,
81 		ssize_t ret2, unsigned issue_flags)
82 {
83 }
84 static inline void io_uring_cmd_complete_in_task(struct io_uring_cmd *ioucmd,
85 			void (*task_work_cb)(struct io_uring_cmd *, unsigned))
86 {
87 }
88 static inline struct sock *io_uring_get_socket(struct file *file)
89 {
90 	return NULL;
91 }
92 static inline void io_uring_task_cancel(void)
93 {
94 }
95 static inline void io_uring_files_cancel(void)
96 {
97 }
98 static inline void io_uring_free(struct task_struct *tsk)
99 {
100 }
101 static inline const char *io_uring_get_opcode(u8 opcode)
102 {
103 	return "";
104 }
105 #endif
106 
107 #endif
108