1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * Copyright (c) 2020 ARM. All rights reserved.
4 * Copyright (c) 2020 Petr Vorel <pvorel@suse.cz>
5 *
6 * Mostly copied/adapted from <linux/io_uring.h>
7 */
8
9 #ifndef IO_URING_H__
10 #define IO_URING_H__
11
12 #include <unistd.h>
13 #include <fcntl.h>
14 #include <sys/types.h>
15 #include <sys/uio.h>
16 #include <stdlib.h>
17 #include <linux/fs.h>
18
19 #include "lapi/syscalls.h"
20
21 #ifndef IOSQE_FIXED_FILE
22
23 /*
24 * IO submission data structure (Submission Queue Entry)
25 */
26 struct io_uring_sqe {
27 uint8_t opcode; /* type of operation for this sqe */
28 uint8_t flags; /* IOSQE_ flags */
29 uint16_t ioprio; /* ioprio for the request */
30 int32_t fd; /* file descriptor to do IO on */
31 union {
32 uint64_t off; /* offset into file */
33 uint64_t addr2;
34 };
35 uint64_t addr; /* pointer to buffer or iovecs */
36 uint32_t len; /* buffer size or number of iovecs */
37 union {
38 __kernel_rwf_t rw_flags;
39 uint32_t fsync_flags;
40 uint16_t poll_events;
41 uint32_t sync_range_flags;
42 uint32_t msg_flags;
43 uint32_t timeout_flags;
44 uint32_t accept_flags;
45 uint32_t cancel_flags;
46 uint32_t open_flags;
47 uint32_t statx_flags;
48 uint32_t fadvise_advice;
49 };
50 uint64_t user_data; /* data to be passed back at completion time */
51 union {
52 struct {
53 /* index into fixed buffers, if used */
54 uint16_t buf_index;
55 /* personality to use, if used */
56 uint16_t personality;
57 };
58 uint64_t __pad2[3];
59 };
60 };
61
62 enum {
63 IOSQE_FIXED_FILE_BIT,
64 IOSQE_IO_DRAIN_BIT,
65 IOSQE_IO_LINK_BIT,
66 IOSQE_IO_HARDLINK_BIT,
67 IOSQE_ASYNC_BIT,
68 };
69
70 /*
71 * sqe->flags
72 */
73 /* use fixed fileset */
74 #define IOSQE_FIXED_FILE (1U << IOSQE_FIXED_FILE_BIT)
75 /* issue after inflight IO */
76 #define IOSQE_IO_DRAIN (1U << IOSQE_IO_DRAIN_BIT)
77 /* links next sqe */
78 #define IOSQE_IO_LINK (1U << IOSQE_IO_LINK_BIT)
79 /* like LINK, but stronger */
80 #define IOSQE_IO_HARDLINK (1U << IOSQE_IO_HARDLINK_BIT)
81 /* always go async */
82 #define IOSQE_ASYNC (1U << IOSQE_ASYNC_BIT)
83
84 /*
85 * io_uring_setup() flags
86 */
87 #define IORING_SETUP_IOPOLL (1U << 0) /* io_context is polled */
88 #define IORING_SETUP_SQPOLL (1U << 1) /* SQ poll thread */
89 #define IORING_SETUP_SQ_AFF (1U << 2) /* sq_thread_cpu is valid */
90 #define IORING_SETUP_CQSIZE (1U << 3) /* app defines CQ size */
91 #define IORING_SETUP_CLAMP (1U << 4) /* clamp SQ/CQ ring sizes */
92 #define IORING_SETUP_ATTACH_WQ (1U << 5) /* attach to existing wq */
93
94 enum {
95 IORING_OP_NOP,
96 IORING_OP_READV,
97 IORING_OP_WRITEV,
98 IORING_OP_FSYNC,
99 IORING_OP_READ_FIXED,
100 IORING_OP_WRITE_FIXED,
101 IORING_OP_POLL_ADD,
102 IORING_OP_POLL_REMOVE,
103 IORING_OP_SYNC_FILE_RANGE,
104 IORING_OP_SENDMSG,
105 IORING_OP_RECVMSG,
106 IORING_OP_TIMEOUT,
107 IORING_OP_TIMEOUT_REMOVE,
108 IORING_OP_ACCEPT,
109 IORING_OP_ASYNC_CANCEL,
110 IORING_OP_LINK_TIMEOUT,
111 IORING_OP_CONNECT,
112 IORING_OP_FALLOCATE,
113 IORING_OP_OPENAT,
114 IORING_OP_CLOSE,
115 IORING_OP_FILES_UPDATE,
116 IORING_OP_STATX,
117 IORING_OP_READ,
118 IORING_OP_WRITE,
119 IORING_OP_FADVISE,
120 IORING_OP_MADVISE,
121 IORING_OP_SEND,
122 IORING_OP_RECV,
123 IORING_OP_OPENAT2,
124 IORING_OP_EPOLL_CTL,
125
126 /* this goes last, obviously */
127 IORING_OP_LAST,
128 };
129
130 /*
131 * sqe->fsync_flags
132 */
133 #define IORING_FSYNC_DATASYNC (1U << 0)
134
135 /*
136 * sqe->timeout_flags
137 */
138 #define IORING_TIMEOUT_ABS (1U << 0)
139
140 /*
141 * IO completion data structure (Completion Queue Entry)
142 */
143 struct io_uring_cqe {
144 uint64_t user_data; /* sqe->data submission passed back */
145 int32_t res; /* result code for this event */
146 uint32_t flags;
147 };
148
149 /*
150 * Magic offsets for the application to mmap the data it needs
151 */
152 #define IORING_OFF_SQ_RING 0ULL
153 #define IORING_OFF_CQ_RING 0x8000000ULL
154 #define IORING_OFF_SQES 0x10000000ULL
155
156 /*
157 * Filled with the offset for mmap(2)
158 */
159 struct io_sqring_offsets {
160 uint32_t head;
161 uint32_t tail;
162 uint32_t ring_mask;
163 uint32_t ring_entries;
164 uint32_t flags;
165 uint32_t dropped;
166 uint32_t array;
167 uint32_t resv1;
168 uint64_t resv2;
169 };
170
171 /*
172 * sq_ring->flags
173 */
174 #define IORING_SQ_NEED_WAKEUP (1U << 0) /* needs io_uring_enter wakeup */
175
176 struct io_cqring_offsets {
177 uint32_t head;
178 uint32_t tail;
179 uint32_t ring_mask;
180 uint32_t ring_entries;
181 uint32_t overflow;
182 uint32_t cqes;
183 uint64_t resv[2];
184 };
185
186 /*
187 * io_uring_enter(2) flags
188 */
189 #define IORING_ENTER_GETEVENTS (1U << 0)
190 #define IORING_ENTER_SQ_WAKEUP (1U << 1)
191
192 /*
193 * Passed in for io_uring_setup(2). Copied back with updated info on success
194 */
195 struct io_uring_params {
196 uint32_t sq_entries;
197 uint32_t cq_entries;
198 uint32_t flags;
199 uint32_t sq_thread_cpu;
200 uint32_t sq_thread_idle;
201 uint32_t features;
202 uint32_t wq_fd;
203 uint32_t resv[3];
204 struct io_sqring_offsets sq_off;
205 struct io_cqring_offsets cq_off;
206 };
207
208 /*
209 * io_uring_params->features flags
210 */
211 #define IORING_FEAT_SINGLE_MMAP (1U << 0)
212 #define IORING_FEAT_NODROP (1U << 1)
213 #define IORING_FEAT_SUBMIT_STABLE (1U << 2)
214 #define IORING_FEAT_RW_CUR_POS (1U << 3)
215 #define IORING_FEAT_CUR_PERSONALITY (1U << 4)
216
217 /*
218 * io_uring_register(2) opcodes and arguments
219 */
220 #define IORING_REGISTER_BUFFERS 0
221 #define IORING_UNREGISTER_BUFFERS 1
222 #define IORING_REGISTER_FILES 2
223 #define IORING_UNREGISTER_FILES 3
224 #define IORING_REGISTER_EVENTFD 4
225 #define IORING_UNREGISTER_EVENTFD 5
226 #define IORING_REGISTER_FILES_UPDATE 6
227 #define IORING_REGISTER_EVENTFD_ASYNC 7
228 #define IORING_REGISTER_PROBE 8
229 #define IORING_REGISTER_PERSONALITY 9
230 #define IORING_UNREGISTER_PERSONALITY 10
231
232 struct io_uring_files_update {
233 uint32_t offset;
234 uint32_t resv;
235 uint64_t __attribute__((aligned(8))) fds;
236 };
237
238 #define IO_URING_OP_SUPPORTED (1U << 0)
239
240 struct io_uring_probe_op {
241 uint8_t op;
242 uint8_t resv;
243 uint16_t flags; /* IO_URING_OP_* flags */
244 uint32_t resv2;
245 };
246
247 struct io_uring_probe {
248 uint8_t last_op; /* last opcode supported */
249 uint8_t ops_len; /* length of ops[] array below */
250 uint16_t resv;
251 uint32_t resv2[3];
252 struct io_uring_probe_op ops[0];
253 };
254
255 #endif /* IOSQE_FIXED_FILE */
256
257
258 #ifndef HAVE_IO_URING_REGISTER
io_uring_register(int fd,unsigned int opcode,void * arg,unsigned int nr_args)259 int io_uring_register(int fd, unsigned int opcode, void *arg,
260 unsigned int nr_args)
261 {
262 return tst_syscall(__NR_io_uring_register, fd, opcode, arg, nr_args);
263 }
264 #endif /* HAVE_IO_URING_REGISTER */
265
266
267 #ifndef HAVE_IO_URING_SETUP
io_uring_setup(unsigned int entries,struct io_uring_params * p)268 int io_uring_setup(unsigned int entries, struct io_uring_params *p)
269 {
270 return tst_syscall(__NR_io_uring_setup, entries, p);
271 }
272 #endif /* HAVE_IO_URING_SETUP */
273
274 #ifndef HAVE_IO_URING_ENTER
io_uring_enter(int fd,unsigned int to_submit,unsigned int min_complete,unsigned int flags,sigset_t * sig)275 int io_uring_enter(int fd, unsigned int to_submit, unsigned int min_complete,
276 unsigned int flags, sigset_t *sig)
277 {
278 return tst_syscall(__NR_io_uring_enter, fd, to_submit, min_complete,
279 flags, sig, _NSIG / 8);
280 }
281 #endif /* HAVE_IO_URING_ENTER */
282
283 #endif /* IO_URING_H__ */
284