1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
macro_rules! resultify {
($ret:expr) => {
match $ret >= 0 {
true => Ok($ret as _),
false => Err(io::Error::from_raw_os_error(-$ret)),
}
}
}
mod cqe;
mod sqe;
mod registrar;
#[doc(inline)]
pub use uring_sys as sys;
use std::io;
use std::mem::MaybeUninit;
use std::ptr::{self, NonNull};
use std::time::Duration;
pub use sqe::{SubmissionQueue, SubmissionQueueEvent, SubmissionFlags, FsyncFlags};
pub use cqe::{CompletionQueue, CompletionQueueEvent};
pub use registrar::Registrar;
bitflags::bitflags! {
pub struct SetupFlags: u32 {
const IOPOLL = 1 << 0;
const SQPOLL = 1 << 1;
const SQ_AFF = 1 << 2;
}
}
pub struct IoUring {
ring: sys::io_uring,
}
impl IoUring {
pub fn new(entries: u32) -> io::Result<IoUring> {
IoUring::new_with_flags(entries, SetupFlags::empty())
}
pub fn new_with_flags(entries: u32, flags: SetupFlags) -> io::Result<IoUring> {
unsafe {
let mut ring = MaybeUninit::uninit();
let _: i32 = resultify! {
sys::io_uring_queue_init(entries as _, ring.as_mut_ptr(), flags.bits() as _)
}?;
Ok(IoUring { ring: ring.assume_init() })
}
}
pub fn sq(&mut self) -> SubmissionQueue<'_> {
SubmissionQueue::new(&*self)
}
pub fn cq(&mut self) -> CompletionQueue<'_> {
CompletionQueue::new(&*self)
}
pub fn registrar(&self) -> Registrar<'_> {
Registrar::new(self)
}
pub fn queues(&mut self) -> (SubmissionQueue<'_>, CompletionQueue<'_>, Registrar<'_>) {
(SubmissionQueue::new(&*self), CompletionQueue::new(&*self), Registrar::new(&*self))
}
pub fn next_sqe(&mut self) -> Option<SubmissionQueueEvent<'_>> {
unsafe {
let sqe = sys::io_uring_get_sqe(&mut self.ring);
if sqe != ptr::null_mut() {
let mut sqe = SubmissionQueueEvent::new(&mut *sqe);
sqe.clear();
Some(sqe)
} else {
None
}
}
}
pub fn submit_sqes(&mut self) -> io::Result<usize> {
self.sq().submit()
}
pub fn submit_sqes_and_wait(&mut self, wait_for: u32) -> io::Result<usize> {
self.sq().submit_and_wait(wait_for)
}
pub fn submit_sqes_and_wait_with_timeout(&mut self, wait_for: u32, duration: Duration)
-> io::Result<usize>
{
self.sq().submit_and_wait_with_timeout(wait_for, duration)
}
pub fn peek_for_cqe(&mut self) -> Option<CompletionQueueEvent<'_>> {
unsafe {
let mut cqe = MaybeUninit::uninit();
sys::io_uring_peek_batch_cqe(&mut self.ring, cqe.as_mut_ptr(), 1);
let cqe = cqe.assume_init();
if cqe != ptr::null_mut() {
Some(CompletionQueueEvent::new(NonNull::from(&self.ring), &mut *cqe))
} else {
None
}
}
}
pub fn wait_for_cqe(&mut self) -> io::Result<CompletionQueueEvent<'_>> {
self.inner_wait_for_cqes(1, ptr::null())
}
pub fn wait_for_cqe_with_timeout(&mut self, duration: Duration)
-> io::Result<CompletionQueueEvent<'_>>
{
let ts = sys::__kernel_timespec {
tv_sec: duration.as_secs() as _,
tv_nsec: duration.subsec_nanos() as _
};
self.inner_wait_for_cqes(1, &ts)
}
pub fn wait_for_cqes(&mut self, count: usize) -> io::Result<CompletionQueueEvent<'_>> {
self.inner_wait_for_cqes(count as _, ptr::null())
}
pub fn wait_for_cqes_with_timeout(&mut self, count: usize, duration: Duration)
-> io::Result<CompletionQueueEvent<'_>>
{
let ts = sys::__kernel_timespec {
tv_sec: duration.as_secs() as _,
tv_nsec: duration.subsec_nanos() as _
};
self.inner_wait_for_cqes(count as _, &ts)
}
fn inner_wait_for_cqes(&mut self, count: u32, ts: *const sys::__kernel_timespec)
-> io::Result<CompletionQueueEvent<'_>>
{
unsafe {
let mut cqe = MaybeUninit::uninit();
let _: i32 = resultify!(sys::io_uring_wait_cqes(
&mut self.ring,
cqe.as_mut_ptr(),
count,
ts,
ptr::null(),
))?;
Ok(CompletionQueueEvent::new(NonNull::from(&self.ring), &mut *cqe.assume_init()))
}
}
pub fn raw(&self) -> &sys::io_uring {
&self.ring
}
pub fn raw_mut(&mut self) -> &mut sys::io_uring {
&mut self.ring
}
}
impl Drop for IoUring {
fn drop(&mut self) {
unsafe { sys::io_uring_queue_exit(&mut self.ring) };
}
}
unsafe impl Send for IoUring { }
unsafe impl Sync for IoUring { }