[linux-2.6-block.git] / include / uapi / linux / io_uring.h

/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR MIT */
/*
 * Header file for the io_uring interface.
 *
 * Copyright (C) 2019 Jens Axboe
 * Copyright (C) 2019 Christoph Hellwig
 */
#ifndef LINUX_IO_URING_H
#define LINUX_IO_URING_H

#include <linux/fs.h>
#include <linux/types.h>

/*
 * IO submission data structure (Submission Queue Entry)
 */
struct io_uring_sqe {
	__u8	opcode;		/* type of operation for this sqe */
	__u8	flags;		/* IOSQE_ flags */
	__u16	ioprio;		/* ioprio for the request */
	__s32	fd;		/* file descriptor to do IO on */
	union {
		__u64	off;	/* offset into file */
		__u64	addr2;
	};
	union {
		__u64	addr;	/* pointer to buffer or iovecs */
		__u64	splice_off_in;
	};
	__u32	len;		/* buffer size or number of iovecs */
	union {
		__kernel_rwf_t	rw_flags;
		__u32		fsync_flags;
		__u16		poll_events;	/* compatibility */
		__u32		poll32_events;	/* word-reversed for BE */
		__u32		sync_range_flags;
		__u32		msg_flags;
		__u32		timeout_flags;
		__u32		accept_flags;
		__u32		cancel_flags;
		__u32		open_flags;
		__u32		statx_flags;
		__u32		fadvise_advice;
		__u32		splice_flags;
		__u32		rename_flags;
		__u32		unlink_flags;
	};
	__u64	user_data;	/* data to be passed back at completion time */
	/* pack this to avoid bogus arm OABI complaints */
	union {
		/* index into fixed buffers, if used */
		__u16	buf_index;
		/* for grouped buffer selection */
		__u16	buf_group;
	} __attribute__((packed));
	/* personality to use, if used */
	__u16	personality;
	union {
		__s32	splice_fd_in;
		__u32	file_index;
	};
	__u64	__pad2[2];
};

enum {
	IOSQE_FIXED_FILE_BIT,
	IOSQE_IO_DRAIN_BIT,
	IOSQE_IO_LINK_BIT,
	IOSQE_IO_HARDLINK_BIT,
	IOSQE_ASYNC_BIT,
	IOSQE_BUFFER_SELECT_BIT,
};

/*
 * sqe->flags
 */
/* use fixed fileset */
#define IOSQE_FIXED_FILE	(1U << IOSQE_FIXED_FILE_BIT)
/* issue after inflight IO */
#define IOSQE_IO_DRAIN		(1U << IOSQE_IO_DRAIN_BIT)
/* links next sqe */
#define IOSQE_IO_LINK		(1U << IOSQE_IO_LINK_BIT)
/* like LINK, but stronger */
#define IOSQE_IO_HARDLINK	(1U << IOSQE_IO_HARDLINK_BIT)
/* always go async */
#define IOSQE_ASYNC		(1U << IOSQE_ASYNC_BIT)
/* select buffer from sqe->buf_group */
#define IOSQE_BUFFER_SELECT	(1U << IOSQE_BUFFER_SELECT_BIT)

/*
 * io_uring_setup() flags
 */
#define IORING_SETUP_IOPOLL	(1U << 0)	/* io_context is polled */
#define IORING_SETUP_SQPOLL	(1U << 1)	/* SQ poll thread */
#define IORING_SETUP_SQ_AFF	(1U << 2)	/* sq_thread_cpu is valid */
#define IORING_SETUP_CQSIZE	(1U << 3)	/* app defines CQ size */
#define IORING_SETUP_CLAMP	(1U << 4)	/* clamp SQ/CQ ring sizes */
#define IORING_SETUP_ATTACH_WQ	(1U << 5)	/* attach to existing wq */
#define IORING_SETUP_R_DISABLED	(1U << 6)	/* start with ring disabled */

enum {
	IORING_OP_NOP,
	IORING_OP_READV,
	IORING_OP_WRITEV,
	IORING_OP_FSYNC,
	IORING_OP_READ_FIXED,
	IORING_OP_WRITE_FIXED,
	IORING_OP_POLL_ADD,
	IORING_OP_POLL_REMOVE,
	IORING_OP_SYNC_FILE_RANGE,
	IORING_OP_SENDMSG,
	IORING_OP_RECVMSG,
	IORING_OP_TIMEOUT,
	IORING_OP_TIMEOUT_REMOVE,
	IORING_OP_ACCEPT,
	IORING_OP_ASYNC_CANCEL,
	IORING_OP_LINK_TIMEOUT,
	IORING_OP_CONNECT,
	IORING_OP_FALLOCATE,
	IORING_OP_OPENAT,
	IORING_OP_CLOSE,
	IORING_OP_FILES_UPDATE,
	IORING_OP_STATX,
	IORING_OP_READ,
	IORING_OP_WRITE,
	IORING_OP_FADVISE,
	IORING_OP_MADVISE,
	IORING_OP_SEND,
	IORING_OP_RECV,
	IORING_OP_OPENAT2,
	IORING_OP_EPOLL_CTL,
	IORING_OP_SPLICE,
	IORING_OP_PROVIDE_BUFFERS,
	IORING_OP_REMOVE_BUFFERS,
	IORING_OP_TEE,
	IORING_OP_SHUTDOWN,
	IORING_OP_RENAMEAT,
	IORING_OP_UNLINKAT,

	/* this goes last, obviously */
	IORING_OP_LAST,
};

/*
 * sqe->fsync_flags
 */
#define IORING_FSYNC_DATASYNC	(1U << 0)

/*
 * sqe->timeout_flags
 */
#define IORING_TIMEOUT_ABS	(1U << 0)
#define IORING_TIMEOUT_UPDATE	(1U << 1)

/*
 * sqe->splice_flags
 * extends splice(2) flags
 */
#define SPLICE_F_FD_IN_FIXED	(1U << 31) /* the last bit of __u32 */

/*
 * POLL_ADD flags. Note that since sqe->poll_events is the flag space, the
 * command flags for POLL_ADD are stored in sqe->len.
 *
 * IORING_POLL_ADD_MULTI	Multishot poll. Sets IORING_CQE_F_MORE if
 *				the poll handler will continue to report
 *				CQEs on behalf of the same SQE.
 *
 * IORING_POLL_UPDATE		Update existing poll request, matching
 *				sqe->addr as the old user_data field.
 */
#define IORING_POLL_ADD_MULTI	(1U << 0)
#define IORING_POLL_UPDATE_EVENTS	(1U << 1)
#define IORING_POLL_UPDATE_USER_DATA	(1U << 2)

/*
 * IO completion data structure (Completion Queue Entry)
 */
struct io_uring_cqe {
	__u64	user_data;	/* sqe->data submission passed back */
	__s32	res;		/* result code for this event */
	__u32	flags;
};

/*
 * cqe->flags
 *
 * IORING_CQE_F_BUFFER	If set, the upper 16 bits are the buffer ID
 * IORING_CQE_F_MORE	If set, parent SQE will generate more CQE entries
 */
#define IORING_CQE_F_BUFFER		(1U << 0)
#define IORING_CQE_F_MORE		(1U << 1)

enum {
	IORING_CQE_BUFFER_SHIFT		= 16,
};

/*
 * Magic offsets for the application to mmap the data it needs
 */
#define IORING_OFF_SQ_RING		0ULL
#define IORING_OFF_CQ_RING		0x8000000ULL
#define IORING_OFF_SQES			0x10000000ULL

/*
 * Filled with the offset for mmap(2)
 */
struct io_sqring_offsets {
	__u32 head;
	__u32 tail;
	__u32 ring_mask;
	__u32 ring_entries;
	__u32 flags;
	__u32 dropped;
	__u32 array;
	__u32 resv1;
	__u64 resv2;
};

/*
 * sq_ring->flags
 */
#define IORING_SQ_NEED_WAKEUP	(1U << 0) /* needs io_uring_enter wakeup */
#define IORING_SQ_CQ_OVERFLOW	(1U << 1) /* CQ ring is overflown */

struct io_cqring_offsets {
	__u32 head;
	__u32 tail;
	__u32 ring_mask;
	__u32 ring_entries;
	__u32 overflow;
	__u32 cqes;
	__u32 flags;
	__u32 resv1;
	__u64 resv2;
};

/*
 * cq_ring->flags
 */

/* disable eventfd notifications */
#define IORING_CQ_EVENTFD_DISABLED	(1U << 0)

/*
 * io_uring_enter(2) flags
 */
#define IORING_ENTER_GETEVENTS	(1U << 0)
#define IORING_ENTER_SQ_WAKEUP	(1U << 1)
#define IORING_ENTER_SQ_WAIT	(1U << 2)
#define IORING_ENTER_EXT_ARG	(1U << 3)

/*
 * Passed in for io_uring_setup(2). Copied back with updated info on success
 */
struct io_uring_params {
	__u32 sq_entries;
	__u32 cq_entries;
	__u32 flags;
	__u32 sq_thread_cpu;
	__u32 sq_thread_idle;
	__u32 features;
	__u32 wq_fd;
	__u32 resv[3];
	struct io_sqring_offsets sq_off;
	struct io_cqring_offsets cq_off;
};

/*
 * io_uring_params->features flags
 */
#define IORING_FEAT_SINGLE_MMAP		(1U << 0)
#define IORING_FEAT_NODROP		(1U << 1)
#define IORING_FEAT_SUBMIT_STABLE	(1U << 2)
#define IORING_FEAT_RW_CUR_POS		(1U << 3)
#define IORING_FEAT_CUR_PERSONALITY	(1U << 4)
#define IORING_FEAT_FAST_POLL		(1U << 5)
#define IORING_FEAT_POLL_32BITS 	(1U << 6)
#define IORING_FEAT_SQPOLL_NONFIXED	(1U << 7)
#define IORING_FEAT_EXT_ARG		(1U << 8)
#define IORING_FEAT_NATIVE_WORKERS	(1U << 9)
#define IORING_FEAT_RSRC_TAGS		(1U << 10)

/*
 * io_uring_register(2) opcodes and arguments
 */
enum {
	IORING_REGISTER_BUFFERS			= 0,
	IORING_UNREGISTER_BUFFERS		= 1,
	IORING_REGISTER_FILES			= 2,
	IORING_UNREGISTER_FILES			= 3,
	IORING_REGISTER_EVENTFD			= 4,
	IORING_UNREGISTER_EVENTFD		= 5,
	IORING_REGISTER_FILES_UPDATE		= 6,
	IORING_REGISTER_EVENTFD_ASYNC		= 7,
	IORING_REGISTER_PROBE			= 8,
	IORING_REGISTER_PERSONALITY		= 9,
	IORING_UNREGISTER_PERSONALITY		= 10,
	IORING_REGISTER_RESTRICTIONS		= 11,
	IORING_REGISTER_ENABLE_RINGS		= 12,

	/* extended with tagging */
	IORING_REGISTER_FILES2			= 13,
	IORING_REGISTER_FILES_UPDATE2		= 14,
	IORING_REGISTER_BUFFERS2		= 15,
	IORING_REGISTER_BUFFERS_UPDATE		= 16,

	/* set/clear io-wq thread affinities */
	IORING_REGISTER_IOWQ_AFF		= 17,
	IORING_UNREGISTER_IOWQ_AFF		= 18,

	/* this goes last */
	IORING_REGISTER_LAST
};

/* deprecated, see struct io_uring_rsrc_update */
struct io_uring_files_update {
	__u32 offset;
	__u32 resv;
	__aligned_u64 /* __s32 * */ fds;
};

struct io_uring_rsrc_register {
	__u32 nr;
	__u32 resv;
	__u64 resv2;
	__aligned_u64 data;
	__aligned_u64 tags;
};

struct io_uring_rsrc_update {
	__u32 offset;
	__u32 resv;
	__aligned_u64 data;
};

struct io_uring_rsrc_update2 {
	__u32 offset;
	__u32 resv;
	__aligned_u64 data;
	__aligned_u64 tags;
	__u32 nr;
	__u32 resv2;
};

/* Skip updating fd indexes set to this value in the fd table */
#define IORING_REGISTER_FILES_SKIP	(-2)

#define IO_URING_OP_SUPPORTED	(1U << 0)

struct io_uring_probe_op {
	__u8 op;
	__u8 resv;
	__u16 flags;	/* IO_URING_OP_* flags */
	__u32 resv2;
};

struct io_uring_probe {
	__u8 last_op;	/* last opcode supported */
	__u8 ops_len;	/* length of ops[] array below */
	__u16 resv;
	__u32 resv2[3];
	struct io_uring_probe_op ops[0];
};

struct io_uring_restriction {
	__u16 opcode;
	union {
		__u8 register_op; /* IORING_RESTRICTION_REGISTER_OP */
		__u8 sqe_op;      /* IORING_RESTRICTION_SQE_OP */
		__u8 sqe_flags;   /* IORING_RESTRICTION_SQE_FLAGS_* */
	};
	__u8 resv;
	__u32 resv2[3];
};

/*
 * io_uring_restriction->opcode values
 */
enum {
	/* Allow an io_uring_register(2) opcode */
	IORING_RESTRICTION_REGISTER_OP		= 0,

	/* Allow an sqe opcode */
	IORING_RESTRICTION_SQE_OP		= 1,

	/* Allow sqe flags */
	IORING_RESTRICTION_SQE_FLAGS_ALLOWED	= 2,

	/* Require sqe flags (these flags must be set on each submission) */
	IORING_RESTRICTION_SQE_FLAGS_REQUIRED	= 3,

	IORING_RESTRICTION_LAST
};

struct io_uring_getevents_arg {
	__u64	sigmask;
	__u32	sigmask_sz;
	__u32	pad;
	__u64	ts;
};

#endif
Commit	Line	Data
9f5834c8	1	/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR MIT */
2b188cc1 JA	2	/*
	3	* Header file for the io_uring interface.
	4	*
	5	* Copyright (C) 2019 Jens Axboe
	6	* Copyright (C) 2019 Christoph Hellwig
	7	*/
	8	#ifndef LINUX_IO_URING_H
	9	#define LINUX_IO_URING_H
	10
	11	#include <linux/fs.h>
	12	#include <linux/types.h>
	13
	14	/*
	15	* IO submission data structure (Submission Queue Entry)
	16	*/
	17	struct io_uring_sqe {
	18	__u8 opcode; /* type of operation for this sqe */
6b06314c	19	__u8 flags; /* IOSQE_ flags */
2b188cc1 JA	20	__u16 ioprio; /* ioprio for the request */
2b188cc1 JA	21	__s32 fd; /* file descriptor to do IO on */
17f2fe35 JA	22	union {
	23	__u64 off; /* offset into file */
	24	__u64 addr2;
	25	};
7d67af2c PB	26	union {
	27	__u64 addr; /* pointer to buffer or iovecs */
	28	__u64 splice_off_in;
	29	};
2b188cc1 JA	30	__u32 len; /* buffer size or number of iovecs */
	31	union {
	32	__kernel_rwf_t rw_flags;
c992fe29	33	__u32 fsync_flags;
5769a351 JX	34	__u16 poll_events; /* compatibility */
5769a351 JX	35	__u32 poll32_events; /* word-reversed for BE */
5d17b4a4	36	__u32 sync_range_flags;
0fa03c62	37	__u32 msg_flags;
5262f567	38	__u32 timeout_flags;
17f2fe35	39	__u32 accept_flags;
62755e35	40	__u32 cancel_flags;
15b71abe	41	__u32 open_flags;
eddc7ef5	42	__u32 statx_flags;
4840e418	43	__u32 fadvise_advice;
7d67af2c	44	__u32 splice_flags;
80a261fd	45	__u32 rename_flags;
14a1143b	46	__u32 unlink_flags;
2b188cc1 JA	47	};
2b188cc1 JA	48	__u64 user_data; /* data to be passed back at completion time */
9ba6a1c0	49	/* pack this to avoid bogus arm OABI complaints */
edafccee	50	union {
9ba6a1c0 PB	51	/* index into fixed buffers, if used */
	52	__u16 buf_index;
	53	/* for grouped buffer selection */
	54	__u16 buf_group;
	55	} __attribute__((packed));
	56	/* personality to use, if used */
	57	__u16 personality;
b9445598 PB	58	union {
	59	__s32 splice_fd_in;
	60	__u32 file_index;
	61	};
9ba6a1c0	62	__u64 __pad2[2];
2b188cc1 JA	63	};
2b188cc1 JA	64
6b47ee6e PB	65	enum {
	66	IOSQE_FIXED_FILE_BIT,
	67	IOSQE_IO_DRAIN_BIT,
	68	IOSQE_IO_LINK_BIT,
	69	IOSQE_IO_HARDLINK_BIT,
	70	IOSQE_ASYNC_BIT,
bcda7baa	71	IOSQE_BUFFER_SELECT_BIT,
6b47ee6e PB	72	};
6b47ee6e PB	73
6b06314c JA	74	/*
	75	* sqe->flags
	76	*/
6b47ee6e PB	77	/* use fixed fileset */
	78	#define IOSQE_FIXED_FILE (1U << IOSQE_FIXED_FILE_BIT)
	79	/* issue after inflight IO */
	80	#define IOSQE_IO_DRAIN (1U << IOSQE_IO_DRAIN_BIT)
	81	/* links next sqe */
	82	#define IOSQE_IO_LINK (1U << IOSQE_IO_LINK_BIT)
	83	/* like LINK, but stronger */
	84	#define IOSQE_IO_HARDLINK (1U << IOSQE_IO_HARDLINK_BIT)
	85	/* always go async */
	86	#define IOSQE_ASYNC (1U << IOSQE_ASYNC_BIT)
bcda7baa JA	87	/* select buffer from sqe->buf_group */
bcda7baa JA	88	#define IOSQE_BUFFER_SELECT (1U << IOSQE_BUFFER_SELECT_BIT)
6b06314c	89
def596e9 JA	90	/*
	91	* io_uring_setup() flags
	92	*/
	93	#define IORING_SETUP_IOPOLL (1U << 0) /* io_context is polled */
6c271ce2 JA	94	#define IORING_SETUP_SQPOLL (1U << 1) /* SQ poll thread */
6c271ce2 JA	95	#define IORING_SETUP_SQ_AFF (1U << 2) /* sq_thread_cpu is valid */
33a107f0	96	#define IORING_SETUP_CQSIZE (1U << 3) /* app defines CQ size */
8110c1a6	97	#define IORING_SETUP_CLAMP (1U << 4) /* clamp SQ/CQ ring sizes */
24369c2e	98	#define IORING_SETUP_ATTACH_WQ (1U << 5) /* attach to existing wq */
7e84e1c7	99	#define IORING_SETUP_R_DISABLED (1U << 6) /* start with ring disabled */
def596e9	100
9e3aa61a JA	101	enum {
	102	IORING_OP_NOP,
	103	IORING_OP_READV,
	104	IORING_OP_WRITEV,
	105	IORING_OP_FSYNC,
	106	IORING_OP_READ_FIXED,
	107	IORING_OP_WRITE_FIXED,
	108	IORING_OP_POLL_ADD,
	109	IORING_OP_POLL_REMOVE,
	110	IORING_OP_SYNC_FILE_RANGE,
	111	IORING_OP_SENDMSG,
	112	IORING_OP_RECVMSG,
	113	IORING_OP_TIMEOUT,
	114	IORING_OP_TIMEOUT_REMOVE,
	115	IORING_OP_ACCEPT,
	116	IORING_OP_ASYNC_CANCEL,
	117	IORING_OP_LINK_TIMEOUT,
	118	IORING_OP_CONNECT,
d63d1b5e	119	IORING_OP_FALLOCATE,
15b71abe	120	IORING_OP_OPENAT,
b5dba59e	121	IORING_OP_CLOSE,
05f3fb3c	122	IORING_OP_FILES_UPDATE,
eddc7ef5	123	IORING_OP_STATX,
3a6820f2 JA	124	IORING_OP_READ,
3a6820f2 JA	125	IORING_OP_WRITE,
4840e418	126	IORING_OP_FADVISE,
c1ca757b	127	IORING_OP_MADVISE,
fddaface JA	128	IORING_OP_SEND,
fddaface JA	129	IORING_OP_RECV,
cebdb986	130	IORING_OP_OPENAT2,
3e4827b0	131	IORING_OP_EPOLL_CTL,
7d67af2c	132	IORING_OP_SPLICE,
ddf0322d	133	IORING_OP_PROVIDE_BUFFERS,
067524e9	134	IORING_OP_REMOVE_BUFFERS,
f2a8d5c7	135	IORING_OP_TEE,
36f4fa68	136	IORING_OP_SHUTDOWN,
80a261fd	137	IORING_OP_RENAMEAT,
14a1143b	138	IORING_OP_UNLINKAT,
9e3aa61a JA	139
	140	/* this goes last, obviously */
	141	IORING_OP_LAST,
	142	};
c992fe29 CH	143
	144	/*
	145	* sqe->fsync_flags
	146	*/
	147	#define IORING_FSYNC_DATASYNC (1U << 0)
2b188cc1	148
a41525ab JA	149	/*
	150	* sqe->timeout_flags
	151	*/
	152	#define IORING_TIMEOUT_ABS (1U << 0)
9c8e11b3	153	#define IORING_TIMEOUT_UPDATE (1U << 1)
a41525ab	154
7d67af2c PB	155	/*
	156	* sqe->splice_flags
	157	* extends splice(2) flags
	158	*/
	159	#define SPLICE_F_FD_IN_FIXED (1U << 31) /* the last bit of __u32 */
	160
88e41cf9 JA	161	/*
	162	* POLL_ADD flags. Note that since sqe->poll_events is the flag space, the
	163	* command flags for POLL_ADD are stored in sqe->len.
	164	*
	165	* IORING_POLL_ADD_MULTI Multishot poll. Sets IORING_CQE_F_MORE if
	166	* the poll handler will continue to report
	167	* CQEs on behalf of the same SQE.
b69de288 JA	168	*
	169	* IORING_POLL_UPDATE Update existing poll request, matching
	170	* sqe->addr as the old user_data field.
88e41cf9 JA	171	*/
88e41cf9 JA	172	#define IORING_POLL_ADD_MULTI (1U << 0)
b69de288 JA	173	#define IORING_POLL_UPDATE_EVENTS (1U << 1)
b69de288 JA	174	#define IORING_POLL_UPDATE_USER_DATA (1U << 2)
88e41cf9	175
2b188cc1 JA	176	/*
	177	* IO completion data structure (Completion Queue Entry)
	178	*/
	179	struct io_uring_cqe {
	180	__u64 user_data; /* sqe->data submission passed back */
	181	__s32 res; /* result code for this event */
	182	__u32 flags;
	183	};
	184
bcda7baa JA	185	/*
	186	* cqe->flags
	187	*
	188	* IORING_CQE_F_BUFFER If set, the upper 16 bits are the buffer ID
88e41cf9	189	* IORING_CQE_F_MORE If set, parent SQE will generate more CQE entries
bcda7baa JA	190	*/
bcda7baa JA	191	#define IORING_CQE_F_BUFFER (1U << 0)
88e41cf9	192	#define IORING_CQE_F_MORE (1U << 1)
bcda7baa JA	193
	194	enum {
	195	IORING_CQE_BUFFER_SHIFT = 16,
	196	};
	197
2b188cc1 JA	198	/*
	199	* Magic offsets for the application to mmap the data it needs
	200	*/
	201	#define IORING_OFF_SQ_RING 0ULL
	202	#define IORING_OFF_CQ_RING 0x8000000ULL
	203	#define IORING_OFF_SQES 0x10000000ULL
	204
	205	/*
	206	* Filled with the offset for mmap(2)
	207	*/
	208	struct io_sqring_offsets {
	209	__u32 head;
	210	__u32 tail;
	211	__u32 ring_mask;
	212	__u32 ring_entries;
	213	__u32 flags;
	214	__u32 dropped;
	215	__u32 array;
	216	__u32 resv1;
	217	__u64 resv2;
	218	};
	219
6c271ce2 JA	220	/*
	221	* sq_ring->flags
	222	*/
	223	#define IORING_SQ_NEED_WAKEUP (1U << 0) /* needs io_uring_enter wakeup */
6d5f9049	224	#define IORING_SQ_CQ_OVERFLOW (1U << 1) /* CQ ring is overflown */
6c271ce2	225
2b188cc1 JA	226	struct io_cqring_offsets {
	227	__u32 head;
	228	__u32 tail;
	229	__u32 ring_mask;
	230	__u32 ring_entries;
	231	__u32 overflow;
	232	__u32 cqes;
0d9b5b3a SG	233	__u32 flags;
	234	__u32 resv1;
	235	__u64 resv2;
2b188cc1 JA	236	};
2b188cc1 JA	237
7e55a19c SG	238	/*
	239	* cq_ring->flags
	240	*/
	241
	242	/* disable eventfd notifications */
	243	#define IORING_CQ_EVENTFD_DISABLED (1U << 0)
	244
2b188cc1 JA	245	/*
	246	* io_uring_enter(2) flags
	247	*/
	248	#define IORING_ENTER_GETEVENTS (1U << 0)
6c271ce2	249	#define IORING_ENTER_SQ_WAKEUP (1U << 1)
90554200	250	#define IORING_ENTER_SQ_WAIT (1U << 2)
c73ebb68	251	#define IORING_ENTER_EXT_ARG (1U << 3)
2b188cc1 JA	252
	253	/*
	254	* Passed in for io_uring_setup(2). Copied back with updated info on success
	255	*/
	256	struct io_uring_params {
	257	__u32 sq_entries;
	258	__u32 cq_entries;
	259	__u32 flags;
6c271ce2 JA	260	__u32 sq_thread_cpu;
6c271ce2 JA	261	__u32 sq_thread_idle;
ac90f249	262	__u32 features;
24369c2e PB	263	__u32 wq_fd;
24369c2e PB	264	__u32 resv[3];
2b188cc1 JA	265	struct io_sqring_offsets sq_off;
	266	struct io_cqring_offsets cq_off;
	267	};
	268
ac90f249 JA	269	/*
	270	* io_uring_params->features flags
	271	*/
	272	#define IORING_FEAT_SINGLE_MMAP (1U << 0)
1d7bb1d5	273	#define IORING_FEAT_NODROP (1U << 1)
da8c9690	274	#define IORING_FEAT_SUBMIT_STABLE (1U << 2)
ba04291e	275	#define IORING_FEAT_RW_CUR_POS (1U << 3)
cccf0ee8	276	#define IORING_FEAT_CUR_PERSONALITY (1U << 4)
d7718a9d	277	#define IORING_FEAT_FAST_POLL (1U << 5)
5769a351	278	#define IORING_FEAT_POLL_32BITS (1U << 6)
28cea78a	279	#define IORING_FEAT_SQPOLL_NONFIXED (1U << 7)
c73ebb68	280	#define IORING_FEAT_EXT_ARG (1U << 8)
1c0aa1fa	281	#define IORING_FEAT_NATIVE_WORKERS (1U << 9)
9690557e	282	#define IORING_FEAT_RSRC_TAGS (1U << 10)
ac90f249	283
edafccee JA	284	/*
	285	* io_uring_register(2) opcodes and arguments
	286	*/
9d4a75ef SG	287	enum {
	288	IORING_REGISTER_BUFFERS = 0,
	289	IORING_UNREGISTER_BUFFERS = 1,
	290	IORING_REGISTER_FILES = 2,
	291	IORING_UNREGISTER_FILES = 3,
	292	IORING_REGISTER_EVENTFD = 4,
	293	IORING_UNREGISTER_EVENTFD = 5,
	294	IORING_REGISTER_FILES_UPDATE = 6,
	295	IORING_REGISTER_EVENTFD_ASYNC = 7,
	296	IORING_REGISTER_PROBE = 8,
	297	IORING_REGISTER_PERSONALITY = 9,
	298	IORING_UNREGISTER_PERSONALITY = 10,
21b55dbc	299	IORING_REGISTER_RESTRICTIONS = 11,
7e84e1c7	300	IORING_REGISTER_ENABLE_RINGS = 12,
992da01a PB	301
	302	/* extended with tagging */
	303	IORING_REGISTER_FILES2 = 13,
	304	IORING_REGISTER_FILES_UPDATE2 = 14,
	305	IORING_REGISTER_BUFFERS2 = 15,
	306	IORING_REGISTER_BUFFERS_UPDATE = 16,
9d4a75ef	307
fe76421d JA	308	/* set/clear io-wq thread affinities */
	309	IORING_REGISTER_IOWQ_AFF = 17,
	310	IORING_UNREGISTER_IOWQ_AFF = 18,
	311
9d4a75ef SG	312	/* this goes last */
	313	IORING_REGISTER_LAST
	314	};
c3a31e60	315
269bbe5f	316	/* deprecated, see struct io_uring_rsrc_update */
c3a31e60 JA	317	struct io_uring_files_update {
c3a31e60 JA	318	__u32 offset;
1292e972 ES	319	__u32 resv;
1292e972 ES	320	__aligned_u64 /* __s32 * */ fds;
c3a31e60	321	};
edafccee	322
792e3582	323	struct io_uring_rsrc_register {
792e3582	324	__u32 nr;
992da01a PB	325	__u32 resv;
992da01a PB	326	__u64 resv2;
792e3582 PB	327	__aligned_u64 data;
	328	__aligned_u64 tags;
	329	};
	330
c3bdad02 PB	331	struct io_uring_rsrc_update {
	332	__u32 offset;
	333	__u32 resv;
	334	__aligned_u64 data;
	335	};
	336
	337	struct io_uring_rsrc_update2 {
	338	__u32 offset;
	339	__u32 resv;
	340	__aligned_u64 data;
	341	__aligned_u64 tags;
c3bdad02	342	__u32 nr;
992da01a	343	__u32 resv2;
c3bdad02 PB	344	};
c3bdad02 PB	345
4e0377a1	346	/* Skip updating fd indexes set to this value in the fd table */
	347	#define IORING_REGISTER_FILES_SKIP (-2)
	348
66f4af93 JA	349	#define IO_URING_OP_SUPPORTED (1U << 0)
	350
	351	struct io_uring_probe_op {
	352	__u8 op;
	353	__u8 resv;
	354	__u16 flags; /* IO_URING_OP_* flags */
	355	__u32 resv2;
	356	};
	357
	358	struct io_uring_probe {
	359	__u8 last_op; /* last opcode supported */
	360	__u8 ops_len; /* length of ops[] array below */
	361	__u16 resv;
	362	__u32 resv2[3];
	363	struct io_uring_probe_op ops[0];
	364	};
	365
21b55dbc SG	366	struct io_uring_restriction {
	367	__u16 opcode;
	368	union {
	369	__u8 register_op; /* IORING_RESTRICTION_REGISTER_OP */
	370	__u8 sqe_op; /* IORING_RESTRICTION_SQE_OP */
	371	__u8 sqe_flags; /* IORING_RESTRICTION_SQE_FLAGS_* */
	372	};
	373	__u8 resv;
	374	__u32 resv2[3];
	375	};
	376
	377	/*
	378	* io_uring_restriction->opcode values
	379	*/
	380	enum {
	381	/* Allow an io_uring_register(2) opcode */
	382	IORING_RESTRICTION_REGISTER_OP = 0,
	383
	384	/* Allow an sqe opcode */
	385	IORING_RESTRICTION_SQE_OP = 1,
	386
	387	/* Allow sqe flags */
	388	IORING_RESTRICTION_SQE_FLAGS_ALLOWED = 2,
	389
	390	/* Require sqe flags (these flags must be set on each submission) */
	391	IORING_RESTRICTION_SQE_FLAGS_REQUIRED = 3,
	392
	393	IORING_RESTRICTION_LAST
	394	};
	395
c73ebb68 HX	396	struct io_uring_getevents_arg {
	397	__u64 sigmask;
	398	__u32 sigmask_sz;
	399	__u32 pad;
	400	__u64 ts;
	401	};
	402
2b188cc1	403	#endif