[fio.git] / os / 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;
	__u8	flags;
	__u16	ioprio;
	__s32	fd;
	__u64	off;
	union {
		void	*addr;
		__u64	__pad;
	};
	__u32	len;
	union {
		__kernel_rwf_t	rw_flags;
		__u32		__resv;
	};
};

/*
 * io_uring_setup() flags
 */
#define IORING_SETUP_IOPOLL	(1 << 0)	/* io_context is polled */
#define	IORING_SETUP_SQTHREAD	(1 << 1)	/* Use SQ thread */
#define IORING_SETUP_SQWQ	(1 << 2)	/* Use SQ workqueue */
#define IORING_SETUP_SQPOLL	(1 << 3)	/* SQ thread polls */

#define IORING_OP_READV		1
#define IORING_OP_WRITEV	2
#define IORING_OP_FSYNC		3
#define IORING_OP_FDSYNC	4
#define IORING_OP_READ_FIXED	5
#define IORING_OP_WRITE_FIXED	6

/*
 * IO completion data structure (Completion Queue Entry)
 */
struct io_uring_cqe {
	__u64	index;		/* what sqe this event came from */
	__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];
};

#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;
};

#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 {
e2239016 JA	18	__u8 opcode;
	19	__u8 flags;
	20	__u16 ioprio;
	21	__s32 fd;
	22	__u64 off;
e31b8288 JA	23	union {
e31b8288 JA	24	void *addr;
e2239016	25	__u64 __pad;
e31b8288	26	};
e2239016	27	__u32 len;
e31b8288 JA	28	union {
e31b8288 JA	29	__kernel_rwf_t rw_flags;
e2239016	30	__u32 __resv;
e31b8288 JA	31	};
	32	};
	33
	34	/*
	35	* io_uring_setup() flags
	36	*/
	37	#define IORING_SETUP_IOPOLL (1 << 0) /* io_context is polled */
f0403f94 JA	38	#define IORING_SETUP_SQTHREAD (1 << 1) /* Use SQ thread */
	39	#define IORING_SETUP_SQWQ (1 << 2) /* Use SQ workqueue */
	40	#define IORING_SETUP_SQPOLL (1 << 3) /* SQ thread polls */
e31b8288	41
f0403f94 JA	42	#define IORING_OP_READV 1
f0403f94 JA	43	#define IORING_OP_WRITEV 2
e31b8288 JA	44	#define IORING_OP_FSYNC 3
	45	#define IORING_OP_FDSYNC 4
	46	#define IORING_OP_READ_FIXED 5
	47	#define IORING_OP_WRITE_FIXED 6
	48
	49	/*
f0403f94	50	* IO completion data structure (Completion Queue Entry)
e31b8288	51	*/
f0403f94 JA	52	struct io_uring_cqe {
f0403f94 JA	53	__u64 index; /* what sqe this event came from */
e2239016 JA	54	__s32 res; /* result code for this event */
e2239016 JA	55	__u32 flags;
e31b8288 JA	56	};
e31b8288 JA	57
e2239016 JA	58	/*
	59	* io_uring_event->flags
	60	*/
f0403f94	61	#define IOCQE_FLAG_CACHEHIT (1 << 0) /* IO did not hit media */
e31b8288 JA	62
	63	/*
	64	* Magic offsets for the application to mmap the data it needs
	65	*/
	66	#define IORING_OFF_SQ_RING 0ULL
	67	#define IORING_OFF_CQ_RING 0x8000000ULL
f0403f94	68	#define IORING_OFF_SQES 0x10000000ULL
e31b8288 JA	69
	70	/*
	71	* Filled with the offset for mmap(2)
	72	*/
	73	struct io_sqring_offsets {
e2239016 JA	74	__u32 head;
	75	__u32 tail;
	76	__u32 ring_mask;
	77	__u32 ring_entries;
	78	__u32 flags;
	79	__u32 dropped;
	80	__u32 array;
	81	__u32 resv[3];
e31b8288 JA	82	};
	83
	84	#define IORING_SQ_NEED_WAKEUP (1 << 0) /* needs io_uring_enter wakeup */
	85
	86	struct io_cqring_offsets {
e2239016 JA	87	__u32 head;
	88	__u32 tail;
	89	__u32 ring_mask;
	90	__u32 ring_entries;
	91	__u32 overflow;
f0403f94	92	__u32 cqes;
e2239016	93	__u32 resv[4];
e31b8288 JA	94	};
e31b8288 JA	95
e2239016 JA	96	/*
	97	* io_uring_enter(2) flags
	98	*/
e31b8288 JA	99	#define IORING_ENTER_GETEVENTS (1 << 0)
	100
	101	/*
	102	* Passed in for io_uring_setup(2). Copied back with updated info on success
	103	*/
	104	struct io_uring_params {
e2239016 JA	105	__u32 sq_entries;
	106	__u32 cq_entries;
	107	__u32 flags;
	108	__u16 sq_thread_cpu;
	109	__u16 resv[9];
e31b8288 JA	110	struct io_sqring_offsets sq_off;
	111	struct io_cqring_offsets cq_off;
	112	};
	113
	114	#endif