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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
use std::fmt;
#[cfg(feature = "unstable")]
use std::mem::MaybeUninit;
use std::sync::atomic;
use crate::sys;
use crate::util::{unsync_load, Mmap};
pub(crate) struct Inner {
head: *const atomic::AtomicU32,
tail: *const atomic::AtomicU32,
ring_mask: u32,
ring_entries: u32,
overflow: *const atomic::AtomicU32,
cqes: *const sys::io_uring_cqe,
#[allow(dead_code)]
flags: *const atomic::AtomicU32,
}
pub struct CompletionQueue<'a> {
head: u32,
tail: u32,
queue: &'a Inner,
}
#[repr(transparent)]
#[derive(Clone)]
pub struct Entry(pub(crate) sys::io_uring_cqe);
impl Inner {
#[rustfmt::skip]
pub(crate) unsafe fn new(cq_mmap: &Mmap, p: &sys::io_uring_params) -> Self {
let head = cq_mmap.offset(p.cq_off.head ) as *const atomic::AtomicU32;
let tail = cq_mmap.offset(p.cq_off.tail ) as *const atomic::AtomicU32;
let ring_mask = cq_mmap.offset(p.cq_off.ring_mask ).cast::<u32>().read();
let ring_entries = cq_mmap.offset(p.cq_off.ring_entries ).cast::<u32>().read();
let overflow = cq_mmap.offset(p.cq_off.overflow ) as *const atomic::AtomicU32;
let cqes = cq_mmap.offset(p.cq_off.cqes ) as *const sys::io_uring_cqe;
let flags = cq_mmap.offset(p.cq_off.flags ) as *const atomic::AtomicU32;
Self {
head,
tail,
ring_mask,
ring_entries,
overflow,
cqes,
flags,
}
}
#[inline]
pub(crate) unsafe fn borrow_shared(&self) -> CompletionQueue<'_> {
CompletionQueue {
head: unsync_load(self.head),
tail: (*self.tail).load(atomic::Ordering::Acquire),
queue: self,
}
}
#[inline]
pub(crate) fn borrow(&mut self) -> CompletionQueue<'_> {
unsafe { self.borrow_shared() }
}
}
impl CompletionQueue<'_> {
#[inline]
pub fn sync(&mut self) {
unsafe {
(*self.queue.head).store(self.head, atomic::Ordering::Release);
self.tail = (*self.queue.tail).load(atomic::Ordering::Acquire);
}
}
pub fn overflow(&self) -> u32 {
unsafe { (*self.queue.overflow).load(atomic::Ordering::Acquire) }
}
#[cfg(feature = "unstable")]
pub fn eventfd_disabled(&self) -> bool {
unsafe {
(*self.queue.flags).load(atomic::Ordering::Acquire) & sys::IORING_CQ_EVENTFD_DISABLED
!= 0
}
}
#[inline]
pub fn capacity(&self) -> usize {
self.queue.ring_entries as usize
}
#[inline]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
#[inline]
pub fn is_full(&self) -> bool {
self.len() == self.capacity()
}
#[cfg(feature = "unstable")]
#[inline]
pub fn fill<'a>(&mut self, entries: &'a mut [MaybeUninit<Entry>]) -> &'a mut [Entry] {
let len = std::cmp::min(self.len(), entries.len());
for entry in &mut entries[..len] {
*entry = MaybeUninit::new(Entry(unsafe {
*self
.queue
.cqes
.add((self.head & self.queue.ring_mask) as usize)
}));
self.head = self.head.wrapping_add(1);
}
unsafe { std::slice::from_raw_parts_mut(entries as *mut _ as *mut Entry, len) }
}
}
impl Drop for CompletionQueue<'_> {
#[inline]
fn drop(&mut self) {
unsafe { &*self.queue.head }.store(self.head, atomic::Ordering::Release);
}
}
impl Iterator for CompletionQueue<'_> {
type Item = Entry;
#[inline]
fn next(&mut self) -> Option<Self::Item> {
if self.head != self.tail {
let entry = unsafe {
*self
.queue
.cqes
.add((self.head & self.queue.ring_mask) as usize)
};
self.head = self.head.wrapping_add(1);
Some(Entry(entry))
} else {
None
}
}
#[inline]
fn size_hint(&self) -> (usize, Option<usize>) {
(self.len(), Some(self.len()))
}
}
impl ExactSizeIterator for CompletionQueue<'_> {
#[inline]
fn len(&self) -> usize {
self.tail.wrapping_sub(self.head) as usize
}
}
impl Entry {
#[inline]
pub fn result(&self) -> i32 {
self.0.res
}
#[inline]
pub fn user_data(&self) -> u64 {
self.0.user_data
}
#[inline]
pub fn flags(&self) -> u32 {
self.0.flags
}
}
impl fmt::Debug for Entry {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Entry")
.field("result", &self.0.res)
.field("user_data", &self.0.user_data)
.field("flags", &self.0.flags)
.finish()
}
}
#[cfg(feature = "unstable")]
pub fn buffer_select(flags: u32) -> Option<u16> {
if flags & sys::IORING_CQE_F_BUFFER != 0 {
let id = flags >> sys::IORING_CQE_BUFFER_SHIFT;
Some(id as u16)
} else {
None
}
}