xref: /linux-6.15/tools/include/uapi/linux/io_uring.h (revision 7746a6ad)
1*7746a6adSBreno Leitao /* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR MIT */
2*7746a6adSBreno Leitao /*
3*7746a6adSBreno Leitao  * Header file for the io_uring interface.
4*7746a6adSBreno Leitao  *
5*7746a6adSBreno Leitao  * Copyright (C) 2019 Jens Axboe
6*7746a6adSBreno Leitao  * Copyright (C) 2019 Christoph Hellwig
7*7746a6adSBreno Leitao  */
8*7746a6adSBreno Leitao #ifndef LINUX_IO_URING_H
9*7746a6adSBreno Leitao #define LINUX_IO_URING_H
10*7746a6adSBreno Leitao 
11*7746a6adSBreno Leitao #include <linux/fs.h>
12*7746a6adSBreno Leitao #include <linux/types.h>
13*7746a6adSBreno Leitao /*
14*7746a6adSBreno Leitao  * this file is shared with liburing and that has to autodetect
15*7746a6adSBreno Leitao  * if linux/time_types.h is available or not, it can
16*7746a6adSBreno Leitao  * define UAPI_LINUX_IO_URING_H_SKIP_LINUX_TIME_TYPES_H
17*7746a6adSBreno Leitao  * if linux/time_types.h is not available
18*7746a6adSBreno Leitao  */
19*7746a6adSBreno Leitao #ifndef UAPI_LINUX_IO_URING_H_SKIP_LINUX_TIME_TYPES_H
20*7746a6adSBreno Leitao #include <linux/time_types.h>
21*7746a6adSBreno Leitao #endif
22*7746a6adSBreno Leitao 
23*7746a6adSBreno Leitao #ifdef __cplusplus
24*7746a6adSBreno Leitao extern "C" {
25*7746a6adSBreno Leitao #endif
26*7746a6adSBreno Leitao 
27*7746a6adSBreno Leitao /*
28*7746a6adSBreno Leitao  * IO submission data structure (Submission Queue Entry)
29*7746a6adSBreno Leitao  */
30*7746a6adSBreno Leitao struct io_uring_sqe {
31*7746a6adSBreno Leitao 	__u8	opcode;		/* type of operation for this sqe */
32*7746a6adSBreno Leitao 	__u8	flags;		/* IOSQE_ flags */
33*7746a6adSBreno Leitao 	__u16	ioprio;		/* ioprio for the request */
34*7746a6adSBreno Leitao 	__s32	fd;		/* file descriptor to do IO on */
35*7746a6adSBreno Leitao 	union {
36*7746a6adSBreno Leitao 		__u64	off;	/* offset into file */
37*7746a6adSBreno Leitao 		__u64	addr2;
38*7746a6adSBreno Leitao 		struct {
39*7746a6adSBreno Leitao 			__u32	cmd_op;
40*7746a6adSBreno Leitao 			__u32	__pad1;
41*7746a6adSBreno Leitao 		};
42*7746a6adSBreno Leitao 	};
43*7746a6adSBreno Leitao 	union {
44*7746a6adSBreno Leitao 		__u64	addr;	/* pointer to buffer or iovecs */
45*7746a6adSBreno Leitao 		__u64	splice_off_in;
46*7746a6adSBreno Leitao 		struct {
47*7746a6adSBreno Leitao 			__u32	level;
48*7746a6adSBreno Leitao 			__u32	optname;
49*7746a6adSBreno Leitao 		};
50*7746a6adSBreno Leitao 	};
51*7746a6adSBreno Leitao 	__u32	len;		/* buffer size or number of iovecs */
52*7746a6adSBreno Leitao 	union {
53*7746a6adSBreno Leitao 		__kernel_rwf_t	rw_flags;
54*7746a6adSBreno Leitao 		__u32		fsync_flags;
55*7746a6adSBreno Leitao 		__u16		poll_events;	/* compatibility */
56*7746a6adSBreno Leitao 		__u32		poll32_events;	/* word-reversed for BE */
57*7746a6adSBreno Leitao 		__u32		sync_range_flags;
58*7746a6adSBreno Leitao 		__u32		msg_flags;
59*7746a6adSBreno Leitao 		__u32		timeout_flags;
60*7746a6adSBreno Leitao 		__u32		accept_flags;
61*7746a6adSBreno Leitao 		__u32		cancel_flags;
62*7746a6adSBreno Leitao 		__u32		open_flags;
63*7746a6adSBreno Leitao 		__u32		statx_flags;
64*7746a6adSBreno Leitao 		__u32		fadvise_advice;
65*7746a6adSBreno Leitao 		__u32		splice_flags;
66*7746a6adSBreno Leitao 		__u32		rename_flags;
67*7746a6adSBreno Leitao 		__u32		unlink_flags;
68*7746a6adSBreno Leitao 		__u32		hardlink_flags;
69*7746a6adSBreno Leitao 		__u32		xattr_flags;
70*7746a6adSBreno Leitao 		__u32		msg_ring_flags;
71*7746a6adSBreno Leitao 		__u32		uring_cmd_flags;
72*7746a6adSBreno Leitao 		__u32		waitid_flags;
73*7746a6adSBreno Leitao 		__u32		futex_flags;
74*7746a6adSBreno Leitao 	};
75*7746a6adSBreno Leitao 	__u64	user_data;	/* data to be passed back at completion time */
76*7746a6adSBreno Leitao 	/* pack this to avoid bogus arm OABI complaints */
77*7746a6adSBreno Leitao 	union {
78*7746a6adSBreno Leitao 		/* index into fixed buffers, if used */
79*7746a6adSBreno Leitao 		__u16	buf_index;
80*7746a6adSBreno Leitao 		/* for grouped buffer selection */
81*7746a6adSBreno Leitao 		__u16	buf_group;
82*7746a6adSBreno Leitao 	} __attribute__((packed));
83*7746a6adSBreno Leitao 	/* personality to use, if used */
84*7746a6adSBreno Leitao 	__u16	personality;
85*7746a6adSBreno Leitao 	union {
86*7746a6adSBreno Leitao 		__s32	splice_fd_in;
87*7746a6adSBreno Leitao 		__u32	file_index;
88*7746a6adSBreno Leitao 		__u32	optlen;
89*7746a6adSBreno Leitao 		struct {
90*7746a6adSBreno Leitao 			__u16	addr_len;
91*7746a6adSBreno Leitao 			__u16	__pad3[1];
92*7746a6adSBreno Leitao 		};
93*7746a6adSBreno Leitao 	};
94*7746a6adSBreno Leitao 	union {
95*7746a6adSBreno Leitao 		struct {
96*7746a6adSBreno Leitao 			__u64	addr3;
97*7746a6adSBreno Leitao 			__u64	__pad2[1];
98*7746a6adSBreno Leitao 		};
99*7746a6adSBreno Leitao 		__u64	optval;
100*7746a6adSBreno Leitao 		/*
101*7746a6adSBreno Leitao 		 * If the ring is initialized with IORING_SETUP_SQE128, then
102*7746a6adSBreno Leitao 		 * this field is used for 80 bytes of arbitrary command data
103*7746a6adSBreno Leitao 		 */
104*7746a6adSBreno Leitao 		__u8	cmd[0];
105*7746a6adSBreno Leitao 	};
106*7746a6adSBreno Leitao };
107*7746a6adSBreno Leitao 
108*7746a6adSBreno Leitao /*
109*7746a6adSBreno Leitao  * If sqe->file_index is set to this for opcodes that instantiate a new
110*7746a6adSBreno Leitao  * direct descriptor (like openat/openat2/accept), then io_uring will allocate
111*7746a6adSBreno Leitao  * an available direct descriptor instead of having the application pass one
112*7746a6adSBreno Leitao  * in. The picked direct descriptor will be returned in cqe->res, or -ENFILE
113*7746a6adSBreno Leitao  * if the space is full.
114*7746a6adSBreno Leitao  */
115*7746a6adSBreno Leitao #define IORING_FILE_INDEX_ALLOC		(~0U)
116*7746a6adSBreno Leitao 
117*7746a6adSBreno Leitao enum {
118*7746a6adSBreno Leitao 	IOSQE_FIXED_FILE_BIT,
119*7746a6adSBreno Leitao 	IOSQE_IO_DRAIN_BIT,
120*7746a6adSBreno Leitao 	IOSQE_IO_LINK_BIT,
121*7746a6adSBreno Leitao 	IOSQE_IO_HARDLINK_BIT,
122*7746a6adSBreno Leitao 	IOSQE_ASYNC_BIT,
123*7746a6adSBreno Leitao 	IOSQE_BUFFER_SELECT_BIT,
124*7746a6adSBreno Leitao 	IOSQE_CQE_SKIP_SUCCESS_BIT,
125*7746a6adSBreno Leitao };
126*7746a6adSBreno Leitao 
127*7746a6adSBreno Leitao /*
128*7746a6adSBreno Leitao  * sqe->flags
129*7746a6adSBreno Leitao  */
130*7746a6adSBreno Leitao /* use fixed fileset */
131*7746a6adSBreno Leitao #define IOSQE_FIXED_FILE	(1U << IOSQE_FIXED_FILE_BIT)
132*7746a6adSBreno Leitao /* issue after inflight IO */
133*7746a6adSBreno Leitao #define IOSQE_IO_DRAIN		(1U << IOSQE_IO_DRAIN_BIT)
134*7746a6adSBreno Leitao /* links next sqe */
135*7746a6adSBreno Leitao #define IOSQE_IO_LINK		(1U << IOSQE_IO_LINK_BIT)
136*7746a6adSBreno Leitao /* like LINK, but stronger */
137*7746a6adSBreno Leitao #define IOSQE_IO_HARDLINK	(1U << IOSQE_IO_HARDLINK_BIT)
138*7746a6adSBreno Leitao /* always go async */
139*7746a6adSBreno Leitao #define IOSQE_ASYNC		(1U << IOSQE_ASYNC_BIT)
140*7746a6adSBreno Leitao /* select buffer from sqe->buf_group */
141*7746a6adSBreno Leitao #define IOSQE_BUFFER_SELECT	(1U << IOSQE_BUFFER_SELECT_BIT)
142*7746a6adSBreno Leitao /* don't post CQE if request succeeded */
143*7746a6adSBreno Leitao #define IOSQE_CQE_SKIP_SUCCESS	(1U << IOSQE_CQE_SKIP_SUCCESS_BIT)
144*7746a6adSBreno Leitao 
145*7746a6adSBreno Leitao /*
146*7746a6adSBreno Leitao  * io_uring_setup() flags
147*7746a6adSBreno Leitao  */
148*7746a6adSBreno Leitao #define IORING_SETUP_IOPOLL	(1U << 0)	/* io_context is polled */
149*7746a6adSBreno Leitao #define IORING_SETUP_SQPOLL	(1U << 1)	/* SQ poll thread */
150*7746a6adSBreno Leitao #define IORING_SETUP_SQ_AFF	(1U << 2)	/* sq_thread_cpu is valid */
151*7746a6adSBreno Leitao #define IORING_SETUP_CQSIZE	(1U << 3)	/* app defines CQ size */
152*7746a6adSBreno Leitao #define IORING_SETUP_CLAMP	(1U << 4)	/* clamp SQ/CQ ring sizes */
153*7746a6adSBreno Leitao #define IORING_SETUP_ATTACH_WQ	(1U << 5)	/* attach to existing wq */
154*7746a6adSBreno Leitao #define IORING_SETUP_R_DISABLED	(1U << 6)	/* start with ring disabled */
155*7746a6adSBreno Leitao #define IORING_SETUP_SUBMIT_ALL	(1U << 7)	/* continue submit on error */
156*7746a6adSBreno Leitao /*
157*7746a6adSBreno Leitao  * Cooperative task running. When requests complete, they often require
158*7746a6adSBreno Leitao  * forcing the submitter to transition to the kernel to complete. If this
159*7746a6adSBreno Leitao  * flag is set, work will be done when the task transitions anyway, rather
160*7746a6adSBreno Leitao  * than force an inter-processor interrupt reschedule. This avoids interrupting
161*7746a6adSBreno Leitao  * a task running in userspace, and saves an IPI.
162*7746a6adSBreno Leitao  */
163*7746a6adSBreno Leitao #define IORING_SETUP_COOP_TASKRUN	(1U << 8)
164*7746a6adSBreno Leitao /*
165*7746a6adSBreno Leitao  * If COOP_TASKRUN is set, get notified if task work is available for
166*7746a6adSBreno Leitao  * running and a kernel transition would be needed to run it. This sets
167*7746a6adSBreno Leitao  * IORING_SQ_TASKRUN in the sq ring flags. Not valid with COOP_TASKRUN.
168*7746a6adSBreno Leitao  */
169*7746a6adSBreno Leitao #define IORING_SETUP_TASKRUN_FLAG	(1U << 9)
170*7746a6adSBreno Leitao #define IORING_SETUP_SQE128		(1U << 10) /* SQEs are 128 byte */
171*7746a6adSBreno Leitao #define IORING_SETUP_CQE32		(1U << 11) /* CQEs are 32 byte */
172*7746a6adSBreno Leitao /*
173*7746a6adSBreno Leitao  * Only one task is allowed to submit requests
174*7746a6adSBreno Leitao  */
175*7746a6adSBreno Leitao #define IORING_SETUP_SINGLE_ISSUER	(1U << 12)
176*7746a6adSBreno Leitao 
177*7746a6adSBreno Leitao /*
178*7746a6adSBreno Leitao  * Defer running task work to get events.
179*7746a6adSBreno Leitao  * Rather than running bits of task work whenever the task transitions
180*7746a6adSBreno Leitao  * try to do it just before it is needed.
181*7746a6adSBreno Leitao  */
182*7746a6adSBreno Leitao #define IORING_SETUP_DEFER_TASKRUN	(1U << 13)
183*7746a6adSBreno Leitao 
184*7746a6adSBreno Leitao /*
185*7746a6adSBreno Leitao  * Application provides the memory for the rings
186*7746a6adSBreno Leitao  */
187*7746a6adSBreno Leitao #define IORING_SETUP_NO_MMAP		(1U << 14)
188*7746a6adSBreno Leitao 
189*7746a6adSBreno Leitao /*
190*7746a6adSBreno Leitao  * Register the ring fd in itself for use with
191*7746a6adSBreno Leitao  * IORING_REGISTER_USE_REGISTERED_RING; return a registered fd index rather
192*7746a6adSBreno Leitao  * than an fd.
193*7746a6adSBreno Leitao  */
194*7746a6adSBreno Leitao #define IORING_SETUP_REGISTERED_FD_ONLY	(1U << 15)
195*7746a6adSBreno Leitao 
196*7746a6adSBreno Leitao /*
197*7746a6adSBreno Leitao  * Removes indirection through the SQ index array.
198*7746a6adSBreno Leitao  */
199*7746a6adSBreno Leitao #define IORING_SETUP_NO_SQARRAY		(1U << 16)
200*7746a6adSBreno Leitao 
201*7746a6adSBreno Leitao enum io_uring_op {
202*7746a6adSBreno Leitao 	IORING_OP_NOP,
203*7746a6adSBreno Leitao 	IORING_OP_READV,
204*7746a6adSBreno Leitao 	IORING_OP_WRITEV,
205*7746a6adSBreno Leitao 	IORING_OP_FSYNC,
206*7746a6adSBreno Leitao 	IORING_OP_READ_FIXED,
207*7746a6adSBreno Leitao 	IORING_OP_WRITE_FIXED,
208*7746a6adSBreno Leitao 	IORING_OP_POLL_ADD,
209*7746a6adSBreno Leitao 	IORING_OP_POLL_REMOVE,
210*7746a6adSBreno Leitao 	IORING_OP_SYNC_FILE_RANGE,
211*7746a6adSBreno Leitao 	IORING_OP_SENDMSG,
212*7746a6adSBreno Leitao 	IORING_OP_RECVMSG,
213*7746a6adSBreno Leitao 	IORING_OP_TIMEOUT,
214*7746a6adSBreno Leitao 	IORING_OP_TIMEOUT_REMOVE,
215*7746a6adSBreno Leitao 	IORING_OP_ACCEPT,
216*7746a6adSBreno Leitao 	IORING_OP_ASYNC_CANCEL,
217*7746a6adSBreno Leitao 	IORING_OP_LINK_TIMEOUT,
218*7746a6adSBreno Leitao 	IORING_OP_CONNECT,
219*7746a6adSBreno Leitao 	IORING_OP_FALLOCATE,
220*7746a6adSBreno Leitao 	IORING_OP_OPENAT,
221*7746a6adSBreno Leitao 	IORING_OP_CLOSE,
222*7746a6adSBreno Leitao 	IORING_OP_FILES_UPDATE,
223*7746a6adSBreno Leitao 	IORING_OP_STATX,
224*7746a6adSBreno Leitao 	IORING_OP_READ,
225*7746a6adSBreno Leitao 	IORING_OP_WRITE,
226*7746a6adSBreno Leitao 	IORING_OP_FADVISE,
227*7746a6adSBreno Leitao 	IORING_OP_MADVISE,
228*7746a6adSBreno Leitao 	IORING_OP_SEND,
229*7746a6adSBreno Leitao 	IORING_OP_RECV,
230*7746a6adSBreno Leitao 	IORING_OP_OPENAT2,
231*7746a6adSBreno Leitao 	IORING_OP_EPOLL_CTL,
232*7746a6adSBreno Leitao 	IORING_OP_SPLICE,
233*7746a6adSBreno Leitao 	IORING_OP_PROVIDE_BUFFERS,
234*7746a6adSBreno Leitao 	IORING_OP_REMOVE_BUFFERS,
235*7746a6adSBreno Leitao 	IORING_OP_TEE,
236*7746a6adSBreno Leitao 	IORING_OP_SHUTDOWN,
237*7746a6adSBreno Leitao 	IORING_OP_RENAMEAT,
238*7746a6adSBreno Leitao 	IORING_OP_UNLINKAT,
239*7746a6adSBreno Leitao 	IORING_OP_MKDIRAT,
240*7746a6adSBreno Leitao 	IORING_OP_SYMLINKAT,
241*7746a6adSBreno Leitao 	IORING_OP_LINKAT,
242*7746a6adSBreno Leitao 	IORING_OP_MSG_RING,
243*7746a6adSBreno Leitao 	IORING_OP_FSETXATTR,
244*7746a6adSBreno Leitao 	IORING_OP_SETXATTR,
245*7746a6adSBreno Leitao 	IORING_OP_FGETXATTR,
246*7746a6adSBreno Leitao 	IORING_OP_GETXATTR,
247*7746a6adSBreno Leitao 	IORING_OP_SOCKET,
248*7746a6adSBreno Leitao 	IORING_OP_URING_CMD,
249*7746a6adSBreno Leitao 	IORING_OP_SEND_ZC,
250*7746a6adSBreno Leitao 	IORING_OP_SENDMSG_ZC,
251*7746a6adSBreno Leitao 	IORING_OP_READ_MULTISHOT,
252*7746a6adSBreno Leitao 	IORING_OP_WAITID,
253*7746a6adSBreno Leitao 	IORING_OP_FUTEX_WAIT,
254*7746a6adSBreno Leitao 	IORING_OP_FUTEX_WAKE,
255*7746a6adSBreno Leitao 	IORING_OP_FUTEX_WAITV,
256*7746a6adSBreno Leitao 
257*7746a6adSBreno Leitao 	/* this goes last, obviously */
258*7746a6adSBreno Leitao 	IORING_OP_LAST,
259*7746a6adSBreno Leitao };
260*7746a6adSBreno Leitao 
261*7746a6adSBreno Leitao /*
262*7746a6adSBreno Leitao  * sqe->uring_cmd_flags		top 8bits aren't available for userspace
263*7746a6adSBreno Leitao  * IORING_URING_CMD_FIXED	use registered buffer; pass this flag
264*7746a6adSBreno Leitao  *				along with setting sqe->buf_index.
265*7746a6adSBreno Leitao  */
266*7746a6adSBreno Leitao #define IORING_URING_CMD_FIXED	(1U << 0)
267*7746a6adSBreno Leitao #define IORING_URING_CMD_MASK	IORING_URING_CMD_FIXED
268*7746a6adSBreno Leitao 
269*7746a6adSBreno Leitao 
270*7746a6adSBreno Leitao /*
271*7746a6adSBreno Leitao  * sqe->fsync_flags
272*7746a6adSBreno Leitao  */
273*7746a6adSBreno Leitao #define IORING_FSYNC_DATASYNC	(1U << 0)
274*7746a6adSBreno Leitao 
275*7746a6adSBreno Leitao /*
276*7746a6adSBreno Leitao  * sqe->timeout_flags
277*7746a6adSBreno Leitao  */
278*7746a6adSBreno Leitao #define IORING_TIMEOUT_ABS		(1U << 0)
279*7746a6adSBreno Leitao #define IORING_TIMEOUT_UPDATE		(1U << 1)
280*7746a6adSBreno Leitao #define IORING_TIMEOUT_BOOTTIME		(1U << 2)
281*7746a6adSBreno Leitao #define IORING_TIMEOUT_REALTIME		(1U << 3)
282*7746a6adSBreno Leitao #define IORING_LINK_TIMEOUT_UPDATE	(1U << 4)
283*7746a6adSBreno Leitao #define IORING_TIMEOUT_ETIME_SUCCESS	(1U << 5)
284*7746a6adSBreno Leitao #define IORING_TIMEOUT_MULTISHOT	(1U << 6)
285*7746a6adSBreno Leitao #define IORING_TIMEOUT_CLOCK_MASK	(IORING_TIMEOUT_BOOTTIME | IORING_TIMEOUT_REALTIME)
286*7746a6adSBreno Leitao #define IORING_TIMEOUT_UPDATE_MASK	(IORING_TIMEOUT_UPDATE | IORING_LINK_TIMEOUT_UPDATE)
287*7746a6adSBreno Leitao /*
288*7746a6adSBreno Leitao  * sqe->splice_flags
289*7746a6adSBreno Leitao  * extends splice(2) flags
290*7746a6adSBreno Leitao  */
291*7746a6adSBreno Leitao #define SPLICE_F_FD_IN_FIXED	(1U << 31) /* the last bit of __u32 */
292*7746a6adSBreno Leitao 
293*7746a6adSBreno Leitao /*
294*7746a6adSBreno Leitao  * POLL_ADD flags. Note that since sqe->poll_events is the flag space, the
295*7746a6adSBreno Leitao  * command flags for POLL_ADD are stored in sqe->len.
296*7746a6adSBreno Leitao  *
297*7746a6adSBreno Leitao  * IORING_POLL_ADD_MULTI	Multishot poll. Sets IORING_CQE_F_MORE if
298*7746a6adSBreno Leitao  *				the poll handler will continue to report
299*7746a6adSBreno Leitao  *				CQEs on behalf of the same SQE.
300*7746a6adSBreno Leitao  *
301*7746a6adSBreno Leitao  * IORING_POLL_UPDATE		Update existing poll request, matching
302*7746a6adSBreno Leitao  *				sqe->addr as the old user_data field.
303*7746a6adSBreno Leitao  *
304*7746a6adSBreno Leitao  * IORING_POLL_LEVEL		Level triggered poll.
305*7746a6adSBreno Leitao  */
306*7746a6adSBreno Leitao #define IORING_POLL_ADD_MULTI	(1U << 0)
307*7746a6adSBreno Leitao #define IORING_POLL_UPDATE_EVENTS	(1U << 1)
308*7746a6adSBreno Leitao #define IORING_POLL_UPDATE_USER_DATA	(1U << 2)
309*7746a6adSBreno Leitao #define IORING_POLL_ADD_LEVEL		(1U << 3)
310*7746a6adSBreno Leitao 
311*7746a6adSBreno Leitao /*
312*7746a6adSBreno Leitao  * ASYNC_CANCEL flags.
313*7746a6adSBreno Leitao  *
314*7746a6adSBreno Leitao  * IORING_ASYNC_CANCEL_ALL	Cancel all requests that match the given key
315*7746a6adSBreno Leitao  * IORING_ASYNC_CANCEL_FD	Key off 'fd' for cancelation rather than the
316*7746a6adSBreno Leitao  *				request 'user_data'
317*7746a6adSBreno Leitao  * IORING_ASYNC_CANCEL_ANY	Match any request
318*7746a6adSBreno Leitao  * IORING_ASYNC_CANCEL_FD_FIXED	'fd' passed in is a fixed descriptor
319*7746a6adSBreno Leitao  * IORING_ASYNC_CANCEL_USERDATA	Match on user_data, default for no other key
320*7746a6adSBreno Leitao  * IORING_ASYNC_CANCEL_OP	Match request based on opcode
321*7746a6adSBreno Leitao  */
322*7746a6adSBreno Leitao #define IORING_ASYNC_CANCEL_ALL	(1U << 0)
323*7746a6adSBreno Leitao #define IORING_ASYNC_CANCEL_FD	(1U << 1)
324*7746a6adSBreno Leitao #define IORING_ASYNC_CANCEL_ANY	(1U << 2)
325*7746a6adSBreno Leitao #define IORING_ASYNC_CANCEL_FD_FIXED	(1U << 3)
326*7746a6adSBreno Leitao #define IORING_ASYNC_CANCEL_USERDATA	(1U << 4)
327*7746a6adSBreno Leitao #define IORING_ASYNC_CANCEL_OP	(1U << 5)
328*7746a6adSBreno Leitao 
329*7746a6adSBreno Leitao /*
330*7746a6adSBreno Leitao  * send/sendmsg and recv/recvmsg flags (sqe->ioprio)
331*7746a6adSBreno Leitao  *
332*7746a6adSBreno Leitao  * IORING_RECVSEND_POLL_FIRST	If set, instead of first attempting to send
333*7746a6adSBreno Leitao  *				or receive and arm poll if that yields an
334*7746a6adSBreno Leitao  *				-EAGAIN result, arm poll upfront and skip
335*7746a6adSBreno Leitao  *				the initial transfer attempt.
336*7746a6adSBreno Leitao  *
337*7746a6adSBreno Leitao  * IORING_RECV_MULTISHOT	Multishot recv. Sets IORING_CQE_F_MORE if
338*7746a6adSBreno Leitao  *				the handler will continue to report
339*7746a6adSBreno Leitao  *				CQEs on behalf of the same SQE.
340*7746a6adSBreno Leitao  *
341*7746a6adSBreno Leitao  * IORING_RECVSEND_FIXED_BUF	Use registered buffers, the index is stored in
342*7746a6adSBreno Leitao  *				the buf_index field.
343*7746a6adSBreno Leitao  *
344*7746a6adSBreno Leitao  * IORING_SEND_ZC_REPORT_USAGE
345*7746a6adSBreno Leitao  *				If set, SEND[MSG]_ZC should report
346*7746a6adSBreno Leitao  *				the zerocopy usage in cqe.res
347*7746a6adSBreno Leitao  *				for the IORING_CQE_F_NOTIF cqe.
348*7746a6adSBreno Leitao  *				0 is reported if zerocopy was actually possible.
349*7746a6adSBreno Leitao  *				IORING_NOTIF_USAGE_ZC_COPIED if data was copied
350*7746a6adSBreno Leitao  *				(at least partially).
351*7746a6adSBreno Leitao  */
352*7746a6adSBreno Leitao #define IORING_RECVSEND_POLL_FIRST	(1U << 0)
353*7746a6adSBreno Leitao #define IORING_RECV_MULTISHOT		(1U << 1)
354*7746a6adSBreno Leitao #define IORING_RECVSEND_FIXED_BUF	(1U << 2)
355*7746a6adSBreno Leitao #define IORING_SEND_ZC_REPORT_USAGE	(1U << 3)
356*7746a6adSBreno Leitao 
357*7746a6adSBreno Leitao /*
358*7746a6adSBreno Leitao  * cqe.res for IORING_CQE_F_NOTIF if
359*7746a6adSBreno Leitao  * IORING_SEND_ZC_REPORT_USAGE was requested
360*7746a6adSBreno Leitao  *
361*7746a6adSBreno Leitao  * It should be treated as a flag, all other
362*7746a6adSBreno Leitao  * bits of cqe.res should be treated as reserved!
363*7746a6adSBreno Leitao  */
364*7746a6adSBreno Leitao #define IORING_NOTIF_USAGE_ZC_COPIED    (1U << 31)
365*7746a6adSBreno Leitao 
366*7746a6adSBreno Leitao /*
367*7746a6adSBreno Leitao  * accept flags stored in sqe->ioprio
368*7746a6adSBreno Leitao  */
369*7746a6adSBreno Leitao #define IORING_ACCEPT_MULTISHOT	(1U << 0)
370*7746a6adSBreno Leitao 
371*7746a6adSBreno Leitao /*
372*7746a6adSBreno Leitao  * IORING_OP_MSG_RING command types, stored in sqe->addr
373*7746a6adSBreno Leitao  */
374*7746a6adSBreno Leitao enum {
375*7746a6adSBreno Leitao 	IORING_MSG_DATA,	/* pass sqe->len as 'res' and off as user_data */
376*7746a6adSBreno Leitao 	IORING_MSG_SEND_FD,	/* send a registered fd to another ring */
377*7746a6adSBreno Leitao };
378*7746a6adSBreno Leitao 
379*7746a6adSBreno Leitao /*
380*7746a6adSBreno Leitao  * IORING_OP_MSG_RING flags (sqe->msg_ring_flags)
381*7746a6adSBreno Leitao  *
382*7746a6adSBreno Leitao  * IORING_MSG_RING_CQE_SKIP	Don't post a CQE to the target ring. Not
383*7746a6adSBreno Leitao  *				applicable for IORING_MSG_DATA, obviously.
384*7746a6adSBreno Leitao  */
385*7746a6adSBreno Leitao #define IORING_MSG_RING_CQE_SKIP	(1U << 0)
386*7746a6adSBreno Leitao /* Pass through the flags from sqe->file_index to cqe->flags */
387*7746a6adSBreno Leitao #define IORING_MSG_RING_FLAGS_PASS	(1U << 1)
388*7746a6adSBreno Leitao 
389*7746a6adSBreno Leitao /*
390*7746a6adSBreno Leitao  * IO completion data structure (Completion Queue Entry)
391*7746a6adSBreno Leitao  */
392*7746a6adSBreno Leitao struct io_uring_cqe {
393*7746a6adSBreno Leitao 	__u64	user_data;	/* sqe->data submission passed back */
394*7746a6adSBreno Leitao 	__s32	res;		/* result code for this event */
395*7746a6adSBreno Leitao 	__u32	flags;
396*7746a6adSBreno Leitao 
397*7746a6adSBreno Leitao 	/*
398*7746a6adSBreno Leitao 	 * If the ring is initialized with IORING_SETUP_CQE32, then this field
399*7746a6adSBreno Leitao 	 * contains 16-bytes of padding, doubling the size of the CQE.
400*7746a6adSBreno Leitao 	 */
401*7746a6adSBreno Leitao 	__u64 big_cqe[];
402*7746a6adSBreno Leitao };
403*7746a6adSBreno Leitao 
404*7746a6adSBreno Leitao /*
405*7746a6adSBreno Leitao  * cqe->flags
406*7746a6adSBreno Leitao  *
407*7746a6adSBreno Leitao  * IORING_CQE_F_BUFFER	If set, the upper 16 bits are the buffer ID
408*7746a6adSBreno Leitao  * IORING_CQE_F_MORE	If set, parent SQE will generate more CQE entries
409*7746a6adSBreno Leitao  * IORING_CQE_F_SOCK_NONEMPTY	If set, more data to read after socket recv
410*7746a6adSBreno Leitao  * IORING_CQE_F_NOTIF	Set for notification CQEs. Can be used to distinct
411*7746a6adSBreno Leitao  * 			them from sends.
412*7746a6adSBreno Leitao  */
413*7746a6adSBreno Leitao #define IORING_CQE_F_BUFFER		(1U << 0)
414*7746a6adSBreno Leitao #define IORING_CQE_F_MORE		(1U << 1)
415*7746a6adSBreno Leitao #define IORING_CQE_F_SOCK_NONEMPTY	(1U << 2)
416*7746a6adSBreno Leitao #define IORING_CQE_F_NOTIF		(1U << 3)
417*7746a6adSBreno Leitao 
418*7746a6adSBreno Leitao enum {
419*7746a6adSBreno Leitao 	IORING_CQE_BUFFER_SHIFT		= 16,
420*7746a6adSBreno Leitao };
421*7746a6adSBreno Leitao 
422*7746a6adSBreno Leitao /*
423*7746a6adSBreno Leitao  * Magic offsets for the application to mmap the data it needs
424*7746a6adSBreno Leitao  */
425*7746a6adSBreno Leitao #define IORING_OFF_SQ_RING		0ULL
426*7746a6adSBreno Leitao #define IORING_OFF_CQ_RING		0x8000000ULL
427*7746a6adSBreno Leitao #define IORING_OFF_SQES			0x10000000ULL
428*7746a6adSBreno Leitao #define IORING_OFF_PBUF_RING		0x80000000ULL
429*7746a6adSBreno Leitao #define IORING_OFF_PBUF_SHIFT		16
430*7746a6adSBreno Leitao #define IORING_OFF_MMAP_MASK		0xf8000000ULL
431*7746a6adSBreno Leitao 
432*7746a6adSBreno Leitao /*
433*7746a6adSBreno Leitao  * Filled with the offset for mmap(2)
434*7746a6adSBreno Leitao  */
435*7746a6adSBreno Leitao struct io_sqring_offsets {
436*7746a6adSBreno Leitao 	__u32 head;
437*7746a6adSBreno Leitao 	__u32 tail;
438*7746a6adSBreno Leitao 	__u32 ring_mask;
439*7746a6adSBreno Leitao 	__u32 ring_entries;
440*7746a6adSBreno Leitao 	__u32 flags;
441*7746a6adSBreno Leitao 	__u32 dropped;
442*7746a6adSBreno Leitao 	__u32 array;
443*7746a6adSBreno Leitao 	__u32 resv1;
444*7746a6adSBreno Leitao 	__u64 user_addr;
445*7746a6adSBreno Leitao };
446*7746a6adSBreno Leitao 
447*7746a6adSBreno Leitao /*
448*7746a6adSBreno Leitao  * sq_ring->flags
449*7746a6adSBreno Leitao  */
450*7746a6adSBreno Leitao #define IORING_SQ_NEED_WAKEUP	(1U << 0) /* needs io_uring_enter wakeup */
451*7746a6adSBreno Leitao #define IORING_SQ_CQ_OVERFLOW	(1U << 1) /* CQ ring is overflown */
452*7746a6adSBreno Leitao #define IORING_SQ_TASKRUN	(1U << 2) /* task should enter the kernel */
453*7746a6adSBreno Leitao 
454*7746a6adSBreno Leitao struct io_cqring_offsets {
455*7746a6adSBreno Leitao 	__u32 head;
456*7746a6adSBreno Leitao 	__u32 tail;
457*7746a6adSBreno Leitao 	__u32 ring_mask;
458*7746a6adSBreno Leitao 	__u32 ring_entries;
459*7746a6adSBreno Leitao 	__u32 overflow;
460*7746a6adSBreno Leitao 	__u32 cqes;
461*7746a6adSBreno Leitao 	__u32 flags;
462*7746a6adSBreno Leitao 	__u32 resv1;
463*7746a6adSBreno Leitao 	__u64 user_addr;
464*7746a6adSBreno Leitao };
465*7746a6adSBreno Leitao 
466*7746a6adSBreno Leitao /*
467*7746a6adSBreno Leitao  * cq_ring->flags
468*7746a6adSBreno Leitao  */
469*7746a6adSBreno Leitao 
470*7746a6adSBreno Leitao /* disable eventfd notifications */
471*7746a6adSBreno Leitao #define IORING_CQ_EVENTFD_DISABLED	(1U << 0)
472*7746a6adSBreno Leitao 
473*7746a6adSBreno Leitao /*
474*7746a6adSBreno Leitao  * io_uring_enter(2) flags
475*7746a6adSBreno Leitao  */
476*7746a6adSBreno Leitao #define IORING_ENTER_GETEVENTS		(1U << 0)
477*7746a6adSBreno Leitao #define IORING_ENTER_SQ_WAKEUP		(1U << 1)
478*7746a6adSBreno Leitao #define IORING_ENTER_SQ_WAIT		(1U << 2)
479*7746a6adSBreno Leitao #define IORING_ENTER_EXT_ARG		(1U << 3)
480*7746a6adSBreno Leitao #define IORING_ENTER_REGISTERED_RING	(1U << 4)
481*7746a6adSBreno Leitao 
482*7746a6adSBreno Leitao /*
483*7746a6adSBreno Leitao  * Passed in for io_uring_setup(2). Copied back with updated info on success
484*7746a6adSBreno Leitao  */
485*7746a6adSBreno Leitao struct io_uring_params {
486*7746a6adSBreno Leitao 	__u32 sq_entries;
487*7746a6adSBreno Leitao 	__u32 cq_entries;
488*7746a6adSBreno Leitao 	__u32 flags;
489*7746a6adSBreno Leitao 	__u32 sq_thread_cpu;
490*7746a6adSBreno Leitao 	__u32 sq_thread_idle;
491*7746a6adSBreno Leitao 	__u32 features;
492*7746a6adSBreno Leitao 	__u32 wq_fd;
493*7746a6adSBreno Leitao 	__u32 resv[3];
494*7746a6adSBreno Leitao 	struct io_sqring_offsets sq_off;
495*7746a6adSBreno Leitao 	struct io_cqring_offsets cq_off;
496*7746a6adSBreno Leitao };
497*7746a6adSBreno Leitao 
498*7746a6adSBreno Leitao /*
499*7746a6adSBreno Leitao  * io_uring_params->features flags
500*7746a6adSBreno Leitao  */
501*7746a6adSBreno Leitao #define IORING_FEAT_SINGLE_MMAP		(1U << 0)
502*7746a6adSBreno Leitao #define IORING_FEAT_NODROP		(1U << 1)
503*7746a6adSBreno Leitao #define IORING_FEAT_SUBMIT_STABLE	(1U << 2)
504*7746a6adSBreno Leitao #define IORING_FEAT_RW_CUR_POS		(1U << 3)
505*7746a6adSBreno Leitao #define IORING_FEAT_CUR_PERSONALITY	(1U << 4)
506*7746a6adSBreno Leitao #define IORING_FEAT_FAST_POLL		(1U << 5)
507*7746a6adSBreno Leitao #define IORING_FEAT_POLL_32BITS 	(1U << 6)
508*7746a6adSBreno Leitao #define IORING_FEAT_SQPOLL_NONFIXED	(1U << 7)
509*7746a6adSBreno Leitao #define IORING_FEAT_EXT_ARG		(1U << 8)
510*7746a6adSBreno Leitao #define IORING_FEAT_NATIVE_WORKERS	(1U << 9)
511*7746a6adSBreno Leitao #define IORING_FEAT_RSRC_TAGS		(1U << 10)
512*7746a6adSBreno Leitao #define IORING_FEAT_CQE_SKIP		(1U << 11)
513*7746a6adSBreno Leitao #define IORING_FEAT_LINKED_FILE		(1U << 12)
514*7746a6adSBreno Leitao #define IORING_FEAT_REG_REG_RING	(1U << 13)
515*7746a6adSBreno Leitao 
516*7746a6adSBreno Leitao /*
517*7746a6adSBreno Leitao  * io_uring_register(2) opcodes and arguments
518*7746a6adSBreno Leitao  */
519*7746a6adSBreno Leitao enum {
520*7746a6adSBreno Leitao 	IORING_REGISTER_BUFFERS			= 0,
521*7746a6adSBreno Leitao 	IORING_UNREGISTER_BUFFERS		= 1,
522*7746a6adSBreno Leitao 	IORING_REGISTER_FILES			= 2,
523*7746a6adSBreno Leitao 	IORING_UNREGISTER_FILES			= 3,
524*7746a6adSBreno Leitao 	IORING_REGISTER_EVENTFD			= 4,
525*7746a6adSBreno Leitao 	IORING_UNREGISTER_EVENTFD		= 5,
526*7746a6adSBreno Leitao 	IORING_REGISTER_FILES_UPDATE		= 6,
527*7746a6adSBreno Leitao 	IORING_REGISTER_EVENTFD_ASYNC		= 7,
528*7746a6adSBreno Leitao 	IORING_REGISTER_PROBE			= 8,
529*7746a6adSBreno Leitao 	IORING_REGISTER_PERSONALITY		= 9,
530*7746a6adSBreno Leitao 	IORING_UNREGISTER_PERSONALITY		= 10,
531*7746a6adSBreno Leitao 	IORING_REGISTER_RESTRICTIONS		= 11,
532*7746a6adSBreno Leitao 	IORING_REGISTER_ENABLE_RINGS		= 12,
533*7746a6adSBreno Leitao 
534*7746a6adSBreno Leitao 	/* extended with tagging */
535*7746a6adSBreno Leitao 	IORING_REGISTER_FILES2			= 13,
536*7746a6adSBreno Leitao 	IORING_REGISTER_FILES_UPDATE2		= 14,
537*7746a6adSBreno Leitao 	IORING_REGISTER_BUFFERS2		= 15,
538*7746a6adSBreno Leitao 	IORING_REGISTER_BUFFERS_UPDATE		= 16,
539*7746a6adSBreno Leitao 
540*7746a6adSBreno Leitao 	/* set/clear io-wq thread affinities */
541*7746a6adSBreno Leitao 	IORING_REGISTER_IOWQ_AFF		= 17,
542*7746a6adSBreno Leitao 	IORING_UNREGISTER_IOWQ_AFF		= 18,
543*7746a6adSBreno Leitao 
544*7746a6adSBreno Leitao 	/* set/get max number of io-wq workers */
545*7746a6adSBreno Leitao 	IORING_REGISTER_IOWQ_MAX_WORKERS	= 19,
546*7746a6adSBreno Leitao 
547*7746a6adSBreno Leitao 	/* register/unregister io_uring fd with the ring */
548*7746a6adSBreno Leitao 	IORING_REGISTER_RING_FDS		= 20,
549*7746a6adSBreno Leitao 	IORING_UNREGISTER_RING_FDS		= 21,
550*7746a6adSBreno Leitao 
551*7746a6adSBreno Leitao 	/* register ring based provide buffer group */
552*7746a6adSBreno Leitao 	IORING_REGISTER_PBUF_RING		= 22,
553*7746a6adSBreno Leitao 	IORING_UNREGISTER_PBUF_RING		= 23,
554*7746a6adSBreno Leitao 
555*7746a6adSBreno Leitao 	/* sync cancelation API */
556*7746a6adSBreno Leitao 	IORING_REGISTER_SYNC_CANCEL		= 24,
557*7746a6adSBreno Leitao 
558*7746a6adSBreno Leitao 	/* register a range of fixed file slots for automatic slot allocation */
559*7746a6adSBreno Leitao 	IORING_REGISTER_FILE_ALLOC_RANGE	= 25,
560*7746a6adSBreno Leitao 
561*7746a6adSBreno Leitao 	/* this goes last */
562*7746a6adSBreno Leitao 	IORING_REGISTER_LAST,
563*7746a6adSBreno Leitao 
564*7746a6adSBreno Leitao 	/* flag added to the opcode to use a registered ring fd */
565*7746a6adSBreno Leitao 	IORING_REGISTER_USE_REGISTERED_RING	= 1U << 31
566*7746a6adSBreno Leitao };
567*7746a6adSBreno Leitao 
568*7746a6adSBreno Leitao /* io-wq worker categories */
569*7746a6adSBreno Leitao enum {
570*7746a6adSBreno Leitao 	IO_WQ_BOUND,
571*7746a6adSBreno Leitao 	IO_WQ_UNBOUND,
572*7746a6adSBreno Leitao };
573*7746a6adSBreno Leitao 
574*7746a6adSBreno Leitao /* deprecated, see struct io_uring_rsrc_update */
575*7746a6adSBreno Leitao struct io_uring_files_update {
576*7746a6adSBreno Leitao 	__u32 offset;
577*7746a6adSBreno Leitao 	__u32 resv;
578*7746a6adSBreno Leitao 	__aligned_u64 /* __s32 * */ fds;
579*7746a6adSBreno Leitao };
580*7746a6adSBreno Leitao 
581*7746a6adSBreno Leitao /*
582*7746a6adSBreno Leitao  * Register a fully sparse file space, rather than pass in an array of all
583*7746a6adSBreno Leitao  * -1 file descriptors.
584*7746a6adSBreno Leitao  */
585*7746a6adSBreno Leitao #define IORING_RSRC_REGISTER_SPARSE	(1U << 0)
586*7746a6adSBreno Leitao 
587*7746a6adSBreno Leitao struct io_uring_rsrc_register {
588*7746a6adSBreno Leitao 	__u32 nr;
589*7746a6adSBreno Leitao 	__u32 flags;
590*7746a6adSBreno Leitao 	__u64 resv2;
591*7746a6adSBreno Leitao 	__aligned_u64 data;
592*7746a6adSBreno Leitao 	__aligned_u64 tags;
593*7746a6adSBreno Leitao };
594*7746a6adSBreno Leitao 
595*7746a6adSBreno Leitao struct io_uring_rsrc_update {
596*7746a6adSBreno Leitao 	__u32 offset;
597*7746a6adSBreno Leitao 	__u32 resv;
598*7746a6adSBreno Leitao 	__aligned_u64 data;
599*7746a6adSBreno Leitao };
600*7746a6adSBreno Leitao 
601*7746a6adSBreno Leitao struct io_uring_rsrc_update2 {
602*7746a6adSBreno Leitao 	__u32 offset;
603*7746a6adSBreno Leitao 	__u32 resv;
604*7746a6adSBreno Leitao 	__aligned_u64 data;
605*7746a6adSBreno Leitao 	__aligned_u64 tags;
606*7746a6adSBreno Leitao 	__u32 nr;
607*7746a6adSBreno Leitao 	__u32 resv2;
608*7746a6adSBreno Leitao };
609*7746a6adSBreno Leitao 
610*7746a6adSBreno Leitao /* Skip updating fd indexes set to this value in the fd table */
611*7746a6adSBreno Leitao #define IORING_REGISTER_FILES_SKIP	(-2)
612*7746a6adSBreno Leitao 
613*7746a6adSBreno Leitao #define IO_URING_OP_SUPPORTED	(1U << 0)
614*7746a6adSBreno Leitao 
615*7746a6adSBreno Leitao struct io_uring_probe_op {
616*7746a6adSBreno Leitao 	__u8 op;
617*7746a6adSBreno Leitao 	__u8 resv;
618*7746a6adSBreno Leitao 	__u16 flags;	/* IO_URING_OP_* flags */
619*7746a6adSBreno Leitao 	__u32 resv2;
620*7746a6adSBreno Leitao };
621*7746a6adSBreno Leitao 
622*7746a6adSBreno Leitao struct io_uring_probe {
623*7746a6adSBreno Leitao 	__u8 last_op;	/* last opcode supported */
624*7746a6adSBreno Leitao 	__u8 ops_len;	/* length of ops[] array below */
625*7746a6adSBreno Leitao 	__u16 resv;
626*7746a6adSBreno Leitao 	__u32 resv2[3];
627*7746a6adSBreno Leitao 	struct io_uring_probe_op ops[];
628*7746a6adSBreno Leitao };
629*7746a6adSBreno Leitao 
630*7746a6adSBreno Leitao struct io_uring_restriction {
631*7746a6adSBreno Leitao 	__u16 opcode;
632*7746a6adSBreno Leitao 	union {
633*7746a6adSBreno Leitao 		__u8 register_op; /* IORING_RESTRICTION_REGISTER_OP */
634*7746a6adSBreno Leitao 		__u8 sqe_op;      /* IORING_RESTRICTION_SQE_OP */
635*7746a6adSBreno Leitao 		__u8 sqe_flags;   /* IORING_RESTRICTION_SQE_FLAGS_* */
636*7746a6adSBreno Leitao 	};
637*7746a6adSBreno Leitao 	__u8 resv;
638*7746a6adSBreno Leitao 	__u32 resv2[3];
639*7746a6adSBreno Leitao };
640*7746a6adSBreno Leitao 
641*7746a6adSBreno Leitao struct io_uring_buf {
642*7746a6adSBreno Leitao 	__u64	addr;
643*7746a6adSBreno Leitao 	__u32	len;
644*7746a6adSBreno Leitao 	__u16	bid;
645*7746a6adSBreno Leitao 	__u16	resv;
646*7746a6adSBreno Leitao };
647*7746a6adSBreno Leitao 
648*7746a6adSBreno Leitao struct io_uring_buf_ring {
649*7746a6adSBreno Leitao 	union {
650*7746a6adSBreno Leitao 		/*
651*7746a6adSBreno Leitao 		 * To avoid spilling into more pages than we need to, the
652*7746a6adSBreno Leitao 		 * ring tail is overlaid with the io_uring_buf->resv field.
653*7746a6adSBreno Leitao 		 */
654*7746a6adSBreno Leitao 		struct {
655*7746a6adSBreno Leitao 			__u64	resv1;
656*7746a6adSBreno Leitao 			__u32	resv2;
657*7746a6adSBreno Leitao 			__u16	resv3;
658*7746a6adSBreno Leitao 			__u16	tail;
659*7746a6adSBreno Leitao 		};
660*7746a6adSBreno Leitao 		__DECLARE_FLEX_ARRAY(struct io_uring_buf, bufs);
661*7746a6adSBreno Leitao 	};
662*7746a6adSBreno Leitao };
663*7746a6adSBreno Leitao 
664*7746a6adSBreno Leitao /*
665*7746a6adSBreno Leitao  * Flags for IORING_REGISTER_PBUF_RING.
666*7746a6adSBreno Leitao  *
667*7746a6adSBreno Leitao  * IOU_PBUF_RING_MMAP:	If set, kernel will allocate the memory for the ring.
668*7746a6adSBreno Leitao  *			The application must not set a ring_addr in struct
669*7746a6adSBreno Leitao  *			io_uring_buf_reg, instead it must subsequently call
670*7746a6adSBreno Leitao  *			mmap(2) with the offset set as:
671*7746a6adSBreno Leitao  *			IORING_OFF_PBUF_RING | (bgid << IORING_OFF_PBUF_SHIFT)
672*7746a6adSBreno Leitao  *			to get a virtual mapping for the ring.
673*7746a6adSBreno Leitao  */
674*7746a6adSBreno Leitao enum {
675*7746a6adSBreno Leitao 	IOU_PBUF_RING_MMAP	= 1,
676*7746a6adSBreno Leitao };
677*7746a6adSBreno Leitao 
678*7746a6adSBreno Leitao /* argument for IORING_(UN)REGISTER_PBUF_RING */
679*7746a6adSBreno Leitao struct io_uring_buf_reg {
680*7746a6adSBreno Leitao 	__u64	ring_addr;
681*7746a6adSBreno Leitao 	__u32	ring_entries;
682*7746a6adSBreno Leitao 	__u16	bgid;
683*7746a6adSBreno Leitao 	__u16	flags;
684*7746a6adSBreno Leitao 	__u64	resv[3];
685*7746a6adSBreno Leitao };
686*7746a6adSBreno Leitao 
687*7746a6adSBreno Leitao /*
688*7746a6adSBreno Leitao  * io_uring_restriction->opcode values
689*7746a6adSBreno Leitao  */
690*7746a6adSBreno Leitao enum {
691*7746a6adSBreno Leitao 	/* Allow an io_uring_register(2) opcode */
692*7746a6adSBreno Leitao 	IORING_RESTRICTION_REGISTER_OP		= 0,
693*7746a6adSBreno Leitao 
694*7746a6adSBreno Leitao 	/* Allow an sqe opcode */
695*7746a6adSBreno Leitao 	IORING_RESTRICTION_SQE_OP		= 1,
696*7746a6adSBreno Leitao 
697*7746a6adSBreno Leitao 	/* Allow sqe flags */
698*7746a6adSBreno Leitao 	IORING_RESTRICTION_SQE_FLAGS_ALLOWED	= 2,
699*7746a6adSBreno Leitao 
700*7746a6adSBreno Leitao 	/* Require sqe flags (these flags must be set on each submission) */
701*7746a6adSBreno Leitao 	IORING_RESTRICTION_SQE_FLAGS_REQUIRED	= 3,
702*7746a6adSBreno Leitao 
703*7746a6adSBreno Leitao 	IORING_RESTRICTION_LAST
704*7746a6adSBreno Leitao };
705*7746a6adSBreno Leitao 
706*7746a6adSBreno Leitao struct io_uring_getevents_arg {
707*7746a6adSBreno Leitao 	__u64	sigmask;
708*7746a6adSBreno Leitao 	__u32	sigmask_sz;
709*7746a6adSBreno Leitao 	__u32	pad;
710*7746a6adSBreno Leitao 	__u64	ts;
711*7746a6adSBreno Leitao };
712*7746a6adSBreno Leitao 
713*7746a6adSBreno Leitao /*
714*7746a6adSBreno Leitao  * Argument for IORING_REGISTER_SYNC_CANCEL
715*7746a6adSBreno Leitao  */
716*7746a6adSBreno Leitao struct io_uring_sync_cancel_reg {
717*7746a6adSBreno Leitao 	__u64				addr;
718*7746a6adSBreno Leitao 	__s32				fd;
719*7746a6adSBreno Leitao 	__u32				flags;
720*7746a6adSBreno Leitao 	struct __kernel_timespec	timeout;
721*7746a6adSBreno Leitao 	__u8				opcode;
722*7746a6adSBreno Leitao 	__u8				pad[7];
723*7746a6adSBreno Leitao 	__u64				pad2[3];
724*7746a6adSBreno Leitao };
725*7746a6adSBreno Leitao 
726*7746a6adSBreno Leitao /*
727*7746a6adSBreno Leitao  * Argument for IORING_REGISTER_FILE_ALLOC_RANGE
728*7746a6adSBreno Leitao  * The range is specified as [off, off + len)
729*7746a6adSBreno Leitao  */
730*7746a6adSBreno Leitao struct io_uring_file_index_range {
731*7746a6adSBreno Leitao 	__u32	off;
732*7746a6adSBreno Leitao 	__u32	len;
733*7746a6adSBreno Leitao 	__u64	resv;
734*7746a6adSBreno Leitao };
735*7746a6adSBreno Leitao 
736*7746a6adSBreno Leitao struct io_uring_recvmsg_out {
737*7746a6adSBreno Leitao 	__u32 namelen;
738*7746a6adSBreno Leitao 	__u32 controllen;
739*7746a6adSBreno Leitao 	__u32 payloadlen;
740*7746a6adSBreno Leitao 	__u32 flags;
741*7746a6adSBreno Leitao };
742*7746a6adSBreno Leitao 
743*7746a6adSBreno Leitao /*
744*7746a6adSBreno Leitao  * Argument for IORING_OP_URING_CMD when file is a socket
745*7746a6adSBreno Leitao  */
746*7746a6adSBreno Leitao enum {
747*7746a6adSBreno Leitao 	SOCKET_URING_OP_SIOCINQ		= 0,
748*7746a6adSBreno Leitao 	SOCKET_URING_OP_SIOCOUTQ,
749*7746a6adSBreno Leitao 	SOCKET_URING_OP_GETSOCKOPT,
750*7746a6adSBreno Leitao 	SOCKET_URING_OP_SETSOCKOPT,
751*7746a6adSBreno Leitao };
752*7746a6adSBreno Leitao 
753*7746a6adSBreno Leitao #ifdef __cplusplus
754*7746a6adSBreno Leitao }
755*7746a6adSBreno Leitao #endif
756*7746a6adSBreno Leitao 
757*7746a6adSBreno Leitao #endif
758