| 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 |
| 10 | |
| 11 | #include <linux/fs.h> |
| 12 | #include <linux/types.h> |
| 13 | |
| 14 | /* |
| 15 | * IO submission data structure (Submission Queue Entry) |
| 16 | */ |
| 17 | struct io_uring_sqe { |
| 18 | __u8 opcode; /* type of operation for this sqe */ |
| 19 | __u8 flags; /* IOSQE_ flags */ |
| 20 | __u16 ioprio; /* ioprio for the request */ |
| 21 | __s32 fd; /* file descriptor to do IO on */ |
| 22 | union { |
| 23 | __u64 off; /* offset into file */ |
| 24 | __u64 addr2; |
| 25 | }; |
| 26 | __u64 addr; /* pointer to buffer or iovecs */ |
| 27 | __u32 len; /* buffer size or number of iovecs */ |
| 28 | union { |
| 29 | __kernel_rwf_t rw_flags; |
| 30 | __u32 fsync_flags; |
| 31 | __u16 poll_events; |
| 32 | __u32 sync_range_flags; |
| 33 | __u32 msg_flags; |
| 34 | __u32 timeout_flags; |
| 35 | __u32 accept_flags; |
| 36 | __u32 cancel_flags; |
| 37 | __u32 open_flags; |
| 38 | __u32 statx_flags; |
| 39 | }; |
| 40 | __u64 user_data; /* data to be passed back at completion time */ |
| 41 | union { |
| 42 | __u16 buf_index; /* index into fixed buffers, if used */ |
| 43 | __u64 __pad2[3]; |
| 44 | }; |
| 45 | }; |
| 46 | |
| 47 | /* |
| 48 | * sqe->flags |
| 49 | */ |
| 50 | #define IOSQE_FIXED_FILE (1U << 0) /* use fixed fileset */ |
| 51 | #define IOSQE_IO_DRAIN (1U << 1) /* issue after inflight IO */ |
| 52 | #define IOSQE_IO_LINK (1U << 2) /* links next sqe */ |
| 53 | #define IOSQE_IO_HARDLINK (1U << 3) /* like LINK, but stronger */ |
| 54 | #define IOSQE_ASYNC (1U << 4) /* always go async */ |
| 55 | |
| 56 | /* |
| 57 | * io_uring_setup() flags |
| 58 | */ |
| 59 | #define IORING_SETUP_IOPOLL (1U << 0) /* io_context is polled */ |
| 60 | #define IORING_SETUP_SQPOLL (1U << 1) /* SQ poll thread */ |
| 61 | #define IORING_SETUP_SQ_AFF (1U << 2) /* sq_thread_cpu is valid */ |
| 62 | #define IORING_SETUP_CQSIZE (1U << 3) /* app defines CQ size */ |
| 63 | |
| 64 | enum { |
| 65 | IORING_OP_NOP, |
| 66 | IORING_OP_READV, |
| 67 | IORING_OP_WRITEV, |
| 68 | IORING_OP_FSYNC, |
| 69 | IORING_OP_READ_FIXED, |
| 70 | IORING_OP_WRITE_FIXED, |
| 71 | IORING_OP_POLL_ADD, |
| 72 | IORING_OP_POLL_REMOVE, |
| 73 | IORING_OP_SYNC_FILE_RANGE, |
| 74 | IORING_OP_SENDMSG, |
| 75 | IORING_OP_RECVMSG, |
| 76 | IORING_OP_TIMEOUT, |
| 77 | IORING_OP_TIMEOUT_REMOVE, |
| 78 | IORING_OP_ACCEPT, |
| 79 | IORING_OP_ASYNC_CANCEL, |
| 80 | IORING_OP_LINK_TIMEOUT, |
| 81 | IORING_OP_CONNECT, |
| 82 | IORING_OP_FALLOCATE, |
| 83 | IORING_OP_OPENAT, |
| 84 | IORING_OP_CLOSE, |
| 85 | IORING_OP_FILES_UPDATE, |
| 86 | IORING_OP_STATX, |
| 87 | IORING_OP_READ, |
| 88 | IORING_OP_WRITE, |
| 89 | |
| 90 | /* this goes last, obviously */ |
| 91 | IORING_OP_LAST, |
| 92 | }; |
| 93 | |
| 94 | /* |
| 95 | * sqe->fsync_flags |
| 96 | */ |
| 97 | #define IORING_FSYNC_DATASYNC (1U << 0) |
| 98 | |
| 99 | /* |
| 100 | * sqe->timeout_flags |
| 101 | */ |
| 102 | #define IORING_TIMEOUT_ABS (1U << 0) |
| 103 | |
| 104 | /* |
| 105 | * IO completion data structure (Completion Queue Entry) |
| 106 | */ |
| 107 | struct io_uring_cqe { |
| 108 | __u64 user_data; /* sqe->data submission passed back */ |
| 109 | __s32 res; /* result code for this event */ |
| 110 | __u32 flags; |
| 111 | }; |
| 112 | |
| 113 | /* |
| 114 | * Magic offsets for the application to mmap the data it needs |
| 115 | */ |
| 116 | #define IORING_OFF_SQ_RING 0ULL |
| 117 | #define IORING_OFF_CQ_RING 0x8000000ULL |
| 118 | #define IORING_OFF_SQES 0x10000000ULL |
| 119 | |
| 120 | /* |
| 121 | * Filled with the offset for mmap(2) |
| 122 | */ |
| 123 | struct io_sqring_offsets { |
| 124 | __u32 head; |
| 125 | __u32 tail; |
| 126 | __u32 ring_mask; |
| 127 | __u32 ring_entries; |
| 128 | __u32 flags; |
| 129 | __u32 dropped; |
| 130 | __u32 array; |
| 131 | __u32 resv1; |
| 132 | __u64 resv2; |
| 133 | }; |
| 134 | |
| 135 | /* |
| 136 | * sq_ring->flags |
| 137 | */ |
| 138 | #define IORING_SQ_NEED_WAKEUP (1U << 0) /* needs io_uring_enter wakeup */ |
| 139 | |
| 140 | struct io_cqring_offsets { |
| 141 | __u32 head; |
| 142 | __u32 tail; |
| 143 | __u32 ring_mask; |
| 144 | __u32 ring_entries; |
| 145 | __u32 overflow; |
| 146 | __u32 cqes; |
| 147 | __u64 resv[2]; |
| 148 | }; |
| 149 | |
| 150 | /* |
| 151 | * io_uring_enter(2) flags |
| 152 | */ |
| 153 | #define IORING_ENTER_GETEVENTS (1U << 0) |
| 154 | #define IORING_ENTER_SQ_WAKEUP (1U << 1) |
| 155 | |
| 156 | /* |
| 157 | * Passed in for io_uring_setup(2). Copied back with updated info on success |
| 158 | */ |
| 159 | struct io_uring_params { |
| 160 | __u32 sq_entries; |
| 161 | __u32 cq_entries; |
| 162 | __u32 flags; |
| 163 | __u32 sq_thread_cpu; |
| 164 | __u32 sq_thread_idle; |
| 165 | __u32 features; |
| 166 | __u32 resv[4]; |
| 167 | struct io_sqring_offsets sq_off; |
| 168 | struct io_cqring_offsets cq_off; |
| 169 | }; |
| 170 | |
| 171 | /* |
| 172 | * io_uring_params->features flags |
| 173 | */ |
| 174 | #define IORING_FEAT_SINGLE_MMAP (1U << 0) |
| 175 | #define IORING_FEAT_NODROP (1U << 1) |
| 176 | #define IORING_FEAT_SUBMIT_STABLE (1U << 2) |
| 177 | |
| 178 | /* |
| 179 | * io_uring_register(2) opcodes and arguments |
| 180 | */ |
| 181 | #define IORING_REGISTER_BUFFERS 0 |
| 182 | #define IORING_UNREGISTER_BUFFERS 1 |
| 183 | #define IORING_REGISTER_FILES 2 |
| 184 | #define IORING_UNREGISTER_FILES 3 |
| 185 | #define IORING_REGISTER_EVENTFD 4 |
| 186 | #define IORING_UNREGISTER_EVENTFD 5 |
| 187 | #define IORING_REGISTER_FILES_UPDATE 6 |
| 188 | |
| 189 | struct io_uring_files_update { |
| 190 | __u32 offset; |
| 191 | __s32 *fds; |
| 192 | }; |
| 193 | |
| 194 | #endif |