io_uring.h 4.8 KB
Newer Older
J
Jens Axboe 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/* 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 */
J
Jens Axboe 已提交
19
	__u8	flags;		/* IOSQE_ flags */
J
Jens Axboe 已提交
20 21
	__u16	ioprio;		/* ioprio for the request */
	__s32	fd;		/* file descriptor to do IO on */
22 23 24 25
	union {
		__u64	off;	/* offset into file */
		__u64	addr2;
	};
J
Jens Axboe 已提交
26 27 28 29
	__u64	addr;		/* pointer to buffer or iovecs */
	__u32	len;		/* buffer size or number of iovecs */
	union {
		__kernel_rwf_t	rw_flags;
C
Christoph Hellwig 已提交
30
		__u32		fsync_flags;
31
		__u16		poll_events;
32
		__u32		sync_range_flags;
J
Jens Axboe 已提交
33
		__u32		msg_flags;
J
Jens Axboe 已提交
34
		__u32		timeout_flags;
35
		__u32		accept_flags;
36
		__u32		cancel_flags;
37
		__u32		open_flags;
38
		__u32		statx_flags;
J
Jens Axboe 已提交
39
		__u32		fadvise_advice;
J
Jens Axboe 已提交
40 41
	};
	__u64	user_data;	/* data to be passed back at completion time */
42 43 44 45
	union {
		__u16	buf_index;	/* index into fixed buffers, if used */
		__u64	__pad2[3];
	};
J
Jens Axboe 已提交
46 47
};

J
Jens Axboe 已提交
48 49 50 51
/*
 * sqe->flags
 */
#define IOSQE_FIXED_FILE	(1U << 0)	/* use fixed fileset */
52
#define IOSQE_IO_DRAIN		(1U << 1)	/* issue after inflight IO */
J
Jens Axboe 已提交
53
#define IOSQE_IO_LINK		(1U << 2)	/* links next sqe */
J
Jens Axboe 已提交
54
#define IOSQE_IO_HARDLINK	(1U << 3)	/* like LINK, but stronger */
J
Jens Axboe 已提交
55
#define IOSQE_ASYNC		(1U << 4)	/* always go async */
J
Jens Axboe 已提交
56

J
Jens Axboe 已提交
57 58 59 60
/*
 * io_uring_setup() flags
 */
#define IORING_SETUP_IOPOLL	(1U << 0)	/* io_context is polled */
J
Jens Axboe 已提交
61 62
#define IORING_SETUP_SQPOLL	(1U << 1)	/* SQ poll thread */
#define IORING_SETUP_SQ_AFF	(1U << 2)	/* sq_thread_cpu is valid */
63
#define IORING_SETUP_CQSIZE	(1U << 3)	/* app defines CQ size */
64
#define IORING_SETUP_CLAMP	(1U << 4)	/* clamp SQ/CQ ring sizes */
J
Jens Axboe 已提交
65

66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
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,
84
	IORING_OP_FALLOCATE,
85
	IORING_OP_OPENAT,
86
	IORING_OP_CLOSE,
87
	IORING_OP_FILES_UPDATE,
88
	IORING_OP_STATX,
89 90
	IORING_OP_READ,
	IORING_OP_WRITE,
J
Jens Axboe 已提交
91
	IORING_OP_FADVISE,
J
Jens Axboe 已提交
92
	IORING_OP_MADVISE,
93 94
	IORING_OP_SEND,
	IORING_OP_RECV,
95
	IORING_OP_OPENAT2,
96 97 98 99

	/* this goes last, obviously */
	IORING_OP_LAST,
};
C
Christoph Hellwig 已提交
100 101 102 103 104

/*
 * sqe->fsync_flags
 */
#define IORING_FSYNC_DATASYNC	(1U << 0)
J
Jens Axboe 已提交
105

106 107 108 109 110
/*
 * sqe->timeout_flags
 */
#define IORING_TIMEOUT_ABS	(1U << 0)

J
Jens Axboe 已提交
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
/*
 * 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;
};

J
Jens Axboe 已提交
142 143 144 145 146
/*
 * sq_ring->flags
 */
#define IORING_SQ_NEED_WAKEUP	(1U << 0) /* needs io_uring_enter wakeup */

J
Jens Axboe 已提交
147 148 149 150 151 152 153 154 155 156 157 158 159 160
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)
J
Jens Axboe 已提交
161
#define IORING_ENTER_SQ_WAKEUP	(1U << 1)
J
Jens Axboe 已提交
162 163 164 165 166 167 168 169

/*
 * 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;
J
Jens Axboe 已提交
170 171
	__u32 sq_thread_cpu;
	__u32 sq_thread_idle;
172 173
	__u32 features;
	__u32 resv[4];
J
Jens Axboe 已提交
174 175 176 177
	struct io_sqring_offsets sq_off;
	struct io_cqring_offsets cq_off;
};

178 179 180 181
/*
 * io_uring_params->features flags
 */
#define IORING_FEAT_SINGLE_MMAP		(1U << 0)
182
#define IORING_FEAT_NODROP		(1U << 1)
183
#define IORING_FEAT_SUBMIT_STABLE	(1U << 2)
184
#define IORING_FEAT_RW_CUR_POS		(1U << 3)
185

186 187 188 189 190
/*
 * io_uring_register(2) opcodes and arguments
 */
#define IORING_REGISTER_BUFFERS		0
#define IORING_UNREGISTER_BUFFERS	1
J
Jens Axboe 已提交
191 192
#define IORING_REGISTER_FILES		2
#define IORING_UNREGISTER_FILES		3
193 194
#define IORING_REGISTER_EVENTFD		4
#define IORING_UNREGISTER_EVENTFD	5
195
#define IORING_REGISTER_FILES_UPDATE	6
196
#define IORING_REGISTER_EVENTFD_ASYNC	7
197
#define IORING_REGISTER_PROBE		8
198 199 200

struct io_uring_files_update {
	__u32 offset;
201 202
	__u32 resv;
	__aligned_u64 /* __s32 * */ fds;
203
};
204

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
#define IO_URING_OP_SUPPORTED	(1U << 0)

struct io_uring_probe_op {
	__u8 op;
	__u8 resv;
	__u16 flags;	/* IO_URING_OP_* flags */
	__u32 resv2;
};

struct io_uring_probe {
	__u8 last_op;	/* last opcode supported */
	__u8 ops_len;	/* length of ops[] array below */
	__u16 resv;
	__u32 resv2[3];
	struct io_uring_probe_op ops[0];
};

J
Jens Axboe 已提交
222
#endif