[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 */
	__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;
	};
	__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	(1 << 0)	/* use fixed fileset */

/*
 * io_uring_setup() flags
 */
#define IORING_SETUP_IOPOLL	(1 << 0)	/* io_context is polled */
#define IORING_SETUP_SQPOLL	(1 << 1)	/* SQ poll thread */
#define IORING_SETUP_SQ_AFF	(1 << 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

/*
 * sqe->fsync_flags
 */
#define IORING_FSYNC_DATASYNC	(1 << 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	(1 << 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	(1 << 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	(1 << 0)

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