[fio.git] / os / linux / io_uring.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/*
 * 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;
	};
	__u64	addr;		/* pointer to buffer or iovecs */
	__u32	len;		/* buffer size or number of iovecs */
	union {
		__kernel_rwf_t	rw_flags;
		__u32		fsync_flags;
		__u16		poll_events;
		__u32		sync_range_flags;
		__u32		msg_flags;
		__u32		timeout_flags;
		__u32		accept_flags;
		__u32		cancel_flags;
		__u32		open_flags;
		__u32		statx_flags;
	};
	__u64	user_data;	/* data to be passed back at completion time */
	union {
		__u16	buf_index;	/* index into fixed buffers, if used */
		__u64	__pad2[3];
	};
};

/*
 * sqe->flags
 */
#define IOSQE_FIXED_FILE	(1U << 0)	/* use fixed fileset */
#define IOSQE_IO_DRAIN		(1U << 1)	/* issue after inflight IO */
#define IOSQE_IO_LINK		(1U << 2)	/* links next sqe */
#define IOSQE_IO_HARDLINK	(1U << 3)	/* like LINK, but stronger */
#define IOSQE_ASYNC		(1U << 4)	/* always go async */

/*
 * 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 */

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,

	/* 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)

/*
 * 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;
};

/*
 * 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 */

struct io_cqring_offsets {
	__u32 head;
	__u32 tail;
	__u32 ring_mask;
	__u32 ring_entries;
	__u32 overflow;
	__u32 cqes;
	__u64 resv[2];
};

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

/*
 * 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 resv[4];
	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)

/*
 * io_uring_register(2) opcodes and arguments
 */
#define IORING_REGISTER_BUFFERS		0
#define IORING_UNREGISTER_BUFFERS	1
#define IORING_REGISTER_FILES		2
#define IORING_UNREGISTER_FILES		3
#define IORING_REGISTER_EVENTFD		4
#define IORING_UNREGISTER_EVENTFD	5
#define IORING_REGISTER_FILES_UPDATE	6

struct io_uring_files_update {
	__u32 offset;
	__s32 *fds;
};

#endif
Commit	Line	Data
e2239016 JA	1	/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
	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
e31b8288	10
6e70fd30	11	#include <linux/fs.h>
e2239016	12	#include <linux/types.h>
6e70fd30	13
e31b8288	14	/*
f0403f94	15	* IO submission data structure (Submission Queue Entry)
e31b8288	16	*/
f0403f94	17	struct io_uring_sqe {
a7086591	18	__u8 opcode; /* type of operation for this sqe */
48e698fa	19	__u8 flags; /* IOSQE_ flags */
a7086591 JA	20	__u16 ioprio; /* ioprio for the request */
a7086591 JA	21	__s32 fd; /* file descriptor to do IO on */
b10b1e70 JA	22	union {
	23	__u64 off; /* offset into file */
	24	__u64 addr2;
	25	};
919850d2	26	__u64 addr; /* pointer to buffer or iovecs */
a7086591	27	__u32 len; /* buffer size or number of iovecs */
e31b8288 JA	28	union {
e31b8288 JA	29	__kernel_rwf_t rw_flags;
48e698fa	30	__u32 fsync_flags;
b532dd6d	31	__u16 poll_events;
a819dfb6	32	__u32 sync_range_flags;
b10b1e70 JA	33	__u32 msg_flags;
	34	__u32 timeout_flags;
	35	__u32 accept_flags;
	36	__u32 cancel_flags;
	37	__u32 open_flags;
	38	__u32 statx_flags;
e31b8288	39	};
48e698fa	40	__u64 user_data; /* data to be passed back at completion time */
f3e769a4 JA	41	union {
	42	__u16 buf_index; /* index into fixed buffers, if used */
	43	__u64 __pad2[3];
	44	};
e31b8288 JA	45	};
e31b8288 JA	46
2ea53ca3 JA	47	/*
	48	* sqe->flags
	49	*/
e9d4aa07	50	#define IOSQE_FIXED_FILE (1U << 0) /* use fixed fileset */
a819dfb6	51	#define IOSQE_IO_DRAIN (1U << 1) /* issue after inflight IO */
b10b1e70 JA	52	#define IOSQE_IO_LINK (1U << 2) /* links next sqe */
	53	#define IOSQE_IO_HARDLINK (1U << 3) /* like LINK, but stronger */
	54	#define IOSQE_ASYNC (1U << 4) /* always go async */
2ea53ca3	55
e31b8288 JA	56	/*
	57	* io_uring_setup() flags
	58	*/
e9d4aa07 JA	59	#define IORING_SETUP_IOPOLL (1U << 0) /* io_context is polled */
	60	#define IORING_SETUP_SQPOLL (1U << 1) /* SQ poll thread */
	61	#define IORING_SETUP_SQ_AFF (1U << 2) /* sq_thread_cpu is valid */
b10b1e70 JA	62	#define IORING_SETUP_CQSIZE (1U << 3) /* app defines CQ size */
	63
	64	enum {
	65	IORING_OP_NOP,
	66	IORING_OP_READV,
	67	IORING_OP_WRITEV,
	68	IORING_OP_FSYNC,
	69	IORING_OP_READ_FIXED,
	70	IORING_OP_WRITE_FIXED,
	71	IORING_OP_POLL_ADD,
	72	IORING_OP_POLL_REMOVE,
	73	IORING_OP_SYNC_FILE_RANGE,
	74	IORING_OP_SENDMSG,
	75	IORING_OP_RECVMSG,
	76	IORING_OP_TIMEOUT,
	77	IORING_OP_TIMEOUT_REMOVE,
	78	IORING_OP_ACCEPT,
	79	IORING_OP_ASYNC_CANCEL,
	80	IORING_OP_LINK_TIMEOUT,
	81	IORING_OP_CONNECT,
	82	IORING_OP_FALLOCATE,
	83	IORING_OP_OPENAT,
	84	IORING_OP_CLOSE,
	85	IORING_OP_FILES_UPDATE,
	86	IORING_OP_STATX,
	87	IORING_OP_READ,
	88	IORING_OP_WRITE,
e31b8288	89
b10b1e70 JA	90	/* this goes last, obviously */
	91	IORING_OP_LAST,
	92	};
48e698fa JA	93
	94	/*
	95	* sqe->fsync_flags
	96	*/
e9d4aa07	97	#define IORING_FSYNC_DATASYNC (1U << 0)
e31b8288	98
b10b1e70 JA	99	/*
	100	* sqe->timeout_flags
	101	*/
	102	#define IORING_TIMEOUT_ABS (1U << 0)
	103
e31b8288	104	/*
f0403f94	105	* IO completion data structure (Completion Queue Entry)
e31b8288	106	*/
f0403f94	107	struct io_uring_cqe {
48e698fa	108	__u64 user_data; /* sqe->data submission passed back */
e2239016 JA	109	__s32 res; /* result code for this event */
e2239016 JA	110	__u32 flags;
e31b8288 JA	111	};
e31b8288 JA	112
e31b8288 JA	113	/*
	114	* Magic offsets for the application to mmap the data it needs
	115	*/
	116	#define IORING_OFF_SQ_RING 0ULL
	117	#define IORING_OFF_CQ_RING 0x8000000ULL
f0403f94	118	#define IORING_OFF_SQES 0x10000000ULL
e31b8288 JA	119
	120	/*
	121	* Filled with the offset for mmap(2)
	122	*/
	123	struct io_sqring_offsets {
e2239016 JA	124	__u32 head;
	125	__u32 tail;
	126	__u32 ring_mask;
	127	__u32 ring_entries;
	128	__u32 flags;
	129	__u32 dropped;
	130	__u32 array;
66169493 JA	131	__u32 resv1;
66169493 JA	132	__u64 resv2;
e31b8288 JA	133	};
e31b8288 JA	134
48e698fa JA	135	/*
	136	* sq_ring->flags
	137	*/
e9d4aa07	138	#define IORING_SQ_NEED_WAKEUP (1U << 0) /* needs io_uring_enter wakeup */
e31b8288 JA	139
e31b8288 JA	140	struct io_cqring_offsets {
e2239016 JA	141	__u32 head;
	142	__u32 tail;
	143	__u32 ring_mask;
	144	__u32 ring_entries;
	145	__u32 overflow;
f0403f94	146	__u32 cqes;
66169493	147	__u64 resv[2];
e31b8288 JA	148	};
e31b8288 JA	149
e2239016 JA	150	/*
	151	* io_uring_enter(2) flags
	152	*/
e9d4aa07 JA	153	#define IORING_ENTER_GETEVENTS (1U << 0)
e9d4aa07 JA	154	#define IORING_ENTER_SQ_WAKEUP (1U << 1)
e31b8288 JA	155
	156	/*
	157	* Passed in for io_uring_setup(2). Copied back with updated info on success
	158	*/
	159	struct io_uring_params {
e2239016 JA	160	__u32 sq_entries;
	161	__u32 cq_entries;
	162	__u32 flags;
e9d4aa07 JA	163	__u32 sq_thread_cpu;
e9d4aa07 JA	164	__u32 sq_thread_idle;
b10b1e70 JA	165	__u32 features;
b10b1e70 JA	166	__u32 resv[4];
e31b8288 JA	167	struct io_sqring_offsets sq_off;
	168	struct io_cqring_offsets cq_off;
	169	};
	170
b10b1e70 JA	171	/*
	172	* io_uring_params->features flags
	173	*/
	174	#define IORING_FEAT_SINGLE_MMAP (1U << 0)
	175	#define IORING_FEAT_NODROP (1U << 1)
	176	#define IORING_FEAT_SUBMIT_STABLE (1U << 2)
	177
2ea53ca3 JA	178	/*
	179	* io_uring_register(2) opcodes and arguments
	180	*/
	181	#define IORING_REGISTER_BUFFERS 0
	182	#define IORING_UNREGISTER_BUFFERS 1
a7abc9fb JA	183	#define IORING_REGISTER_FILES 2
a7abc9fb JA	184	#define IORING_UNREGISTER_FILES 3
a819dfb6 JA	185	#define IORING_REGISTER_EVENTFD 4
a819dfb6 JA	186	#define IORING_UNREGISTER_EVENTFD 5
b10b1e70 JA	187	#define IORING_REGISTER_FILES_UPDATE 6
	188
	189	struct io_uring_files_update {
	190	__u32 offset;
	191	__s32 *fds;
	192	};
2ea53ca3	193
e31b8288	194	#endif