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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
use std::io;
use std::ops::*;
use std::os::unix::io::{AsRawFd, RawFd};

use crate::SQE;

pub const PLACEHOLDER_FD: RawFd = -1;

/// A member of the kernel's registered fileset.
///
/// Valid `RegisteredFd`s can be obtained through a [`Registrar`](crate::registrar::Registrar).
///
/// Registered files handle kernel fileset indexing behind the scenes and can often be used in place
/// of raw file descriptors. Not all IO operations support registered files.
///
/// Submission event prep methods on `RegisteredFd` will ensure that the submission event's
/// `SubmissionFlags::FIXED_FILE` flag is properly set.
pub type RegisteredFd           = Registered<RawFd>;
pub type RegisteredBuf          = Registered<Box<[u8]>>;
pub type RegisteredBufRef<'a>   = Registered<&'a [u8]>;
pub type RegisteredBufMut<'a>   = Registered<&'a mut [u8]>;

/// An object registered with an io-uring instance through a [`Registrar`](crate::Registrar).
#[derive(Copy, Clone, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub struct Registered<T> {
    data: T,
    index: u32,
}

impl<T> Registered<T> {
    pub fn new(index: u32, data: T) -> Registered<T> {
        Registered { data, index }
    }

    pub fn index(&self) -> u32 {
        self.index
    }
}

impl RegisteredFd {
    pub fn is_placeholder(&self) -> bool {
        self.data == PLACEHOLDER_FD
    }
}

impl AsRawFd for RegisteredFd {
    fn as_raw_fd(&self) -> RawFd {
        self.data
    }
}

impl RegisteredBuf {
    pub fn as_ref(&self) -> RegisteredBufRef<'_> {
        Registered::new(self.index, &self.data[..])
    }

    pub fn as_mut(&mut self) -> RegisteredBufMut<'_> {
        Registered::new(self.index, &mut self.data[..])
    }

    pub fn slice(&self, range: Range<usize>) -> RegisteredBufRef<'_> {
        Registered::new(self.index, &self.data[range])
    }

    pub fn slice_mut(&mut self, range: Range<usize>) -> RegisteredBufMut<'_> {
        Registered::new(self.index, &mut self.data[range])
    }

    pub fn slice_to(&self, index: usize) -> RegisteredBufRef<'_> {
        Registered::new(self.index, &self.data[..index])
    }

    pub fn slice_to_mut(&mut self, index: usize) -> RegisteredBufMut<'_> {
        Registered::new(self.index, &mut self.data[..index])
    }

    pub fn slice_from(&self, index: usize) -> RegisteredBufRef<'_> {
        Registered::new(self.index, &self.data[index..])
    }

    pub fn slice_from_mut(&mut self, index: usize) -> RegisteredBufMut<'_> {
        Registered::new(self.index, &mut self.data[index..])
    }
}

impl<'a> RegisteredBufRef<'a> {
    pub fn as_ref(&self) -> RegisteredBufRef<'_> {
        Registered::new(self.index, &self.data[..])
    }

    pub fn slice(self, range: Range<usize>) -> RegisteredBufRef<'a> {
        Registered::new(self.index, &self.data[range])
    }

    pub fn slice_to(&self, index: usize) -> RegisteredBufRef<'_> {
        Registered::new(self.index, &self.data[..index])
    }

    pub fn slice_from(&self, index: usize) -> RegisteredBufRef<'_> {
        Registered::new(self.index, &self.data[index..])
    }
}

impl<'a> RegisteredBufMut<'a> {
    pub fn as_ref(&self) -> RegisteredBufRef<'_> {
        Registered::new(self.index, &self.data[..])
    }

    pub fn as_mut(&mut self) -> RegisteredBufMut<'_> {
        Registered::new(self.index, &mut self.data[..])
    }

    pub fn slice(self, range: Range<usize>) -> RegisteredBufRef<'a> {
        Registered::new(self.index, &self.data[range])
    }

    pub fn slice_mut(self, range: Range<usize>) -> RegisteredBufMut<'a> {
        Registered::new(self.index, &mut self.data[range])
    }

    pub fn slice_to(&self, index: usize) -> RegisteredBufRef<'_> {
        Registered::new(self.index, &self.data[..index])
    }

    pub fn slice_to_mut(&mut self, index: usize) -> RegisteredBufMut<'_> {
        Registered::new(self.index, &mut self.data[..index])
    }

    pub fn slice_from(&self, index: usize) -> RegisteredBufRef<'_> {
        Registered::new(self.index, &self.data[index..])
    }

    pub fn slice_from_mut(&mut self, index: usize) -> RegisteredBufMut<'_> {
        Registered::new(self.index, &mut self.data[index..])
    }
}

impl Deref for RegisteredBuf {
    type Target = [u8];

    fn deref(&self) -> &[u8] {
        &self.data[..]
    }
}

impl Deref for RegisteredBufRef<'_> {
    type Target = [u8];

    fn deref(&self) -> &[u8] {
        &self.data[..]
    }
}

impl Deref for RegisteredBufMut<'_> {
    type Target = [u8];

    fn deref(&self) -> &[u8] {
        &self.data[..]
    }
}

impl DerefMut for RegisteredBuf {
    fn deref_mut(&mut self) -> &mut [u8] {
        &mut self.data[..]
    }
}

impl DerefMut for RegisteredBufMut<'_> {
    fn deref_mut(&mut self) -> &mut [u8] {
        &mut self.data[..]
    }
}
/// A file descriptor that can be used to prepare SQEs.
///
/// The standard library's [`RawFd`] type implements this trait, but so does [`RegisteredFd`], a
/// type which is returned when a user pre-registers file descriptors with an io-uring instance.
pub trait UringFd {
    fn as_raw_fd(&self) -> RawFd;
    fn update_sqe(&self, sqe: &mut SQE<'_>);
}

impl UringFd for RawFd {
    fn as_raw_fd(&self) -> RawFd {
        *self
    }

    fn update_sqe(&self, _: &mut SQE<'_>) { }
}

impl UringFd for RegisteredFd {
    fn as_raw_fd(&self) -> RawFd {
        AsRawFd::as_raw_fd(self)
    }

    fn update_sqe(&self, sqe: &mut SQE<'_>) {
        unsafe { sqe.raw_mut().fd = self.index as RawFd; }
        sqe.set_fixed_file();
    }
}

/// A buffer that can be used to prepare read events.
pub trait UringReadBuf {
    unsafe fn prep_read(self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64);
}

/// A buffer that can be used to prepare write events.
pub trait UringWriteBuf {
    unsafe fn prep_write(self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64);
}

impl UringReadBuf for RegisteredBufMut<'_> {
    unsafe fn prep_read(self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64) {
        uring_sys::io_uring_prep_read_fixed(
            sqe.raw_mut(),
            fd.as_raw_fd(),
            self.data.as_mut_ptr() as _,
            self.data.len() as _,
            offset as _,
            self.index() as _
        );
        fd.update_sqe(sqe);
    }
}

impl UringReadBuf for &'_ mut [u8] {
    unsafe fn prep_read(self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64) {
        uring_sys::io_uring_prep_read(
            sqe.raw_mut(),
            fd.as_raw_fd(),
            self.as_mut_ptr() as _,
            self.len() as _,
            offset as _,
        );
        fd.update_sqe(sqe);
    }
}

impl UringReadBuf for io::IoSliceMut<'_> {
    unsafe fn prep_read(mut self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64) {
        uring_sys::io_uring_prep_read(
            sqe.raw_mut(),
            fd.as_raw_fd(),
            self.as_mut_ptr() as _,
            self.len() as _,
            offset as _,
        );
        fd.update_sqe(sqe);
    }
}

impl UringReadBuf for &'_ mut [&'_ mut [u8]] {
    unsafe fn prep_read(self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64) {
        uring_sys::io_uring_prep_readv(
            sqe.raw_mut(),
            fd.as_raw_fd(),
            self.as_mut_ptr() as _,
            self.len() as _,
            offset as _,
        );
        fd.update_sqe(sqe);
    }
}

impl UringReadBuf for &'_ mut [io::IoSliceMut<'_>] {
    unsafe fn prep_read(self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64) {
        uring_sys::io_uring_prep_readv(
            sqe.raw_mut(),
            fd.as_raw_fd(),
            self.as_mut_ptr() as _,
            self.len() as _,
            offset as _,
        );
        fd.update_sqe(sqe);
    }
}

impl UringWriteBuf for RegisteredBufRef<'_> {
    unsafe fn prep_write(self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64) {
        uring_sys::io_uring_prep_write_fixed(
            sqe.raw_mut(),
            fd.as_raw_fd(),
            self.data.as_ptr() as _,
            self.data.len() as _,
            offset as _,
            self.index() as _
        );
        fd.update_sqe(sqe);
    }
}

impl UringWriteBuf for &'_ [u8] {
    unsafe fn prep_write(self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64) {
        uring_sys::io_uring_prep_write(
            sqe.raw_mut(),
            fd.as_raw_fd(),
            self.as_ptr() as _,
            self.len() as _,
            offset as _,
        );
        fd.update_sqe(sqe);
    }
}

impl UringWriteBuf for io::IoSlice<'_> {
    unsafe fn prep_write(self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64) {
        uring_sys::io_uring_prep_write(
            sqe.raw_mut(),
            fd.as_raw_fd(),
            self.as_ptr() as _,
            self.len() as _,
            offset as _,
        );
        fd.update_sqe(sqe);
    }
}

impl UringWriteBuf for &'_ [io::IoSlice<'_>] {
    unsafe fn prep_write(self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64) {
        uring_sys::io_uring_prep_writev(
            sqe.raw_mut(),
            fd.as_raw_fd(),
            self.as_ptr() as _,
            self.len() as _,
            offset as _,
        );
        fd.update_sqe(sqe);
    }
}

impl UringWriteBuf for &'_ [&'_ [u8]] {
    unsafe fn prep_write(self, fd: impl UringFd, sqe: &mut SQE<'_>, offset: u64) {
        uring_sys::io_uring_prep_writev(
            sqe.raw_mut(),
            fd.as_raw_fd(),
            self.as_ptr() as _,
            self.len() as _,
            offset as _,
        );
        fd.update_sqe(sqe);
    }
}