[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>

#define IORING_MAX_ENTRIES	4096

/*
 * 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 */
	__u64	off;		/* offset into file */
	__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;
	};
	__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 */

/*
 * 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_OP_NOP		0
#define IORING_OP_READV		1
#define IORING_OP_WRITEV	2
#define IORING_OP_FSYNC		3
#define IORING_OP_READ_FIXED	4
#define IORING_OP_WRITE_FIXED	5
#define IORING_OP_POLL_ADD	6
#define IORING_OP_POLL_REMOVE	7

/*
 * sqe->fsync_flags
 */
#define IORING_FSYNC_DATASYNC	(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;
};

/*
 * io_uring_event->flags
 */
#define IOCQE_FLAG_CACHEHIT	(1U << 0)	/* IO did not hit media */

/*
 * 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 resv[3];
};

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

/*
 * 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 resv[5];
	struct io_sqring_offsets sq_off;
	struct io_cqring_offsets cq_off;
};

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

#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
b532dd6d JA	14	#define IORING_MAX_ENTRIES 4096
b532dd6d JA	15
e31b8288	16	/*
f0403f94	17	* IO submission data structure (Submission Queue Entry)
e31b8288	18	*/
f0403f94	19	struct io_uring_sqe {
a7086591	20	__u8 opcode; /* type of operation for this sqe */
48e698fa	21	__u8 flags; /* IOSQE_ flags */
a7086591 JA	22	__u16 ioprio; /* ioprio for the request */
	23	__s32 fd; /* file descriptor to do IO on */
	24	__u64 off; /* offset into file */
919850d2	25	__u64 addr; /* pointer to buffer or iovecs */
a7086591	26	__u32 len; /* buffer size or number of iovecs */
e31b8288 JA	27	union {
e31b8288 JA	28	__kernel_rwf_t rw_flags;
48e698fa	29	__u32 fsync_flags;
b532dd6d	30	__u16 poll_events;
e31b8288	31	};
48e698fa	32	__u64 user_data; /* data to be passed back at completion time */
f3e769a4 JA	33	union {
	34	__u16 buf_index; /* index into fixed buffers, if used */
	35	__u64 __pad2[3];
	36	};
e31b8288 JA	37	};
e31b8288 JA	38
2ea53ca3 JA	39	/*
	40	* sqe->flags
	41	*/
e9d4aa07	42	#define IOSQE_FIXED_FILE (1U << 0) /* use fixed fileset */
2ea53ca3	43
e31b8288 JA	44	/*
	45	* io_uring_setup() flags
	46	*/
e9d4aa07 JA	47	#define IORING_SETUP_IOPOLL (1U << 0) /* io_context is polled */
	48	#define IORING_SETUP_SQPOLL (1U << 1) /* SQ poll thread */
	49	#define IORING_SETUP_SQ_AFF (1U << 2) /* sq_thread_cpu is valid */
e31b8288	50
8025517d	51	#define IORING_OP_NOP 0
f0403f94 JA	52	#define IORING_OP_READV 1
f0403f94 JA	53	#define IORING_OP_WRITEV 2
e31b8288	54	#define IORING_OP_FSYNC 3
48e698fa JA	55	#define IORING_OP_READ_FIXED 4
48e698fa JA	56	#define IORING_OP_WRITE_FIXED 5
b532dd6d JA	57	#define IORING_OP_POLL_ADD 6
b532dd6d JA	58	#define IORING_OP_POLL_REMOVE 7
48e698fa JA	59
	60	/*
	61	* sqe->fsync_flags
	62	*/
e9d4aa07	63	#define IORING_FSYNC_DATASYNC (1U << 0)
e31b8288 JA	64
e31b8288 JA	65	/*
f0403f94	66	* IO completion data structure (Completion Queue Entry)
e31b8288	67	*/
f0403f94	68	struct io_uring_cqe {
48e698fa	69	__u64 user_data; /* sqe->data submission passed back */
e2239016 JA	70	__s32 res; /* result code for this event */
e2239016 JA	71	__u32 flags;
e31b8288 JA	72	};
e31b8288 JA	73
e2239016 JA	74	/*
	75	* io_uring_event->flags
	76	*/
e9d4aa07	77	#define IOCQE_FLAG_CACHEHIT (1U << 0) /* IO did not hit media */
e31b8288 JA	78
	79	/*
	80	* Magic offsets for the application to mmap the data it needs
	81	*/
	82	#define IORING_OFF_SQ_RING 0ULL
	83	#define IORING_OFF_CQ_RING 0x8000000ULL
f0403f94	84	#define IORING_OFF_SQES 0x10000000ULL
e31b8288 JA	85
	86	/*
	87	* Filled with the offset for mmap(2)
	88	*/
	89	struct io_sqring_offsets {
e2239016 JA	90	__u32 head;
	91	__u32 tail;
	92	__u32 ring_mask;
	93	__u32 ring_entries;
	94	__u32 flags;
	95	__u32 dropped;
	96	__u32 array;
	97	__u32 resv[3];
e31b8288 JA	98	};
e31b8288 JA	99
48e698fa JA	100	/*
	101	* sq_ring->flags
	102	*/
e9d4aa07	103	#define IORING_SQ_NEED_WAKEUP (1U << 0) /* needs io_uring_enter wakeup */
e31b8288 JA	104
e31b8288 JA	105	struct io_cqring_offsets {
e2239016 JA	106	__u32 head;
	107	__u32 tail;
	108	__u32 ring_mask;
	109	__u32 ring_entries;
	110	__u32 overflow;
f0403f94	111	__u32 cqes;
e2239016	112	__u32 resv[4];
e31b8288 JA	113	};
e31b8288 JA	114
e2239016 JA	115	/*
	116	* io_uring_enter(2) flags
	117	*/
e9d4aa07 JA	118	#define IORING_ENTER_GETEVENTS (1U << 0)
e9d4aa07 JA	119	#define IORING_ENTER_SQ_WAKEUP (1U << 1)
e31b8288 JA	120
	121	/*
	122	* Passed in for io_uring_setup(2). Copied back with updated info on success
	123	*/
	124	struct io_uring_params {
e2239016 JA	125	__u32 sq_entries;
	126	__u32 cq_entries;
	127	__u32 flags;
e9d4aa07 JA	128	__u32 sq_thread_cpu;
	129	__u32 sq_thread_idle;
	130	__u32 resv[5];
e31b8288 JA	131	struct io_sqring_offsets sq_off;
	132	struct io_cqring_offsets cq_off;
	133	};
	134
2ea53ca3 JA	135	/*
	136	* io_uring_register(2) opcodes and arguments
	137	*/
	138	#define IORING_REGISTER_BUFFERS 0
	139	#define IORING_UNREGISTER_BUFFERS 1
a7abc9fb JA	140	#define IORING_REGISTER_FILES 2
a7abc9fb JA	141	#define IORING_UNREGISTER_FILES 3
2ea53ca3	142
e31b8288	143	#endif