[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;		/* type of operation for this sqe */
	__u8	flags;		/* as of now unused */
	__u16	ioprio;		/* ioprio for the request */
	__s32	fd;		/* file descriptor to do IO on */
	__u64	off;		/* offset into file */
	union {
		void	*addr;	/* buffer or iovecs */
		__u64	__pad;
	};
	__u32	len;		/* buffer size or number of iovecs */
	union {
		__kernel_rwf_t	rw_flags;
		__u32		__resv;
	};
	__u16	index;		/* index into fixed buffers, if used */
	__u16	__pad2[3];
	__u64	data;		/* data to be passed back at completion time */
};

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

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