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