dope-uring 0.2.2

Thin io_uring adaptor with "Manifolds"
Documentation 
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

use std::{io, time::Duration};

use io_uring::{CompletionQueue, IoUring, Submitter, opcode, types};

use crate::driver::wire;

pub struct Ring {
    inner: IoUring,
}

impl Ring {
    pub(crate) fn new(uring: IoUring) -> Self {
        Self { inner: uring }
    }

    pub(crate) fn submitter<'a>(&'a self) -> Submitter<'a> {
        self.inner.submitter()
    }

    pub(crate) fn completion<'a>(&'a mut self) -> CompletionQueue<'a> {
        self.inner.completion()
    }

    pub(in crate::driver) fn submission_len(&mut self) -> usize {
        self.inner.submission().len()
    }

    pub(in crate::driver) fn is_full(&mut self) -> bool {
        self.inner.submission().is_full()
    }

    pub(in crate::driver) fn has_submission(&mut self) -> bool {
        !self.inner.submission().is_empty()
    }

    pub(in crate::driver) fn has_completion(&mut self) -> bool {
        !self.inner.completion().is_empty()
    }

    pub(in crate::driver) fn submit_and_wait(&mut self, min_complete: u32) -> io::Result<()> {
        self.inner.submit_and_wait(min_complete as usize)?;
        Ok(())
    }

    pub(in crate::driver) fn submit(&mut self) -> io::Result<usize> {
        let before = self.submission_len();
        self.inner
            .submit()
            .map(|_| before.saturating_sub(self.submission_len()))
    }

    pub(in crate::driver) fn submit_with_timeout(
        &mut self,
        min_complete: u32,
        duration: Duration,
    ) -> io::Result<()> {
        let ts = types::Timespec::from(duration);
        let args = types::SubmitArgs::new().timespec(&ts);
        let want = min_complete as usize;
        match self.inner.submitter().submit_with_args(want, &args) {
            Ok(_) => Ok(()),
            Err(e) if e.raw_os_error() == Some(libc::ETIME) => Ok(()),
            Err(e) => Err(e),
        }
    }

    pub(in crate::driver) fn try_push_arm(&mut self, sqe: io_uring::squeue::Entry) -> bool {
        unsafe {
            let mut sq = self.inner.submission();
            sq.push(&sqe).is_ok()
        }
    }

    pub(in crate::driver) fn push(&mut self, sqe: &io_uring::squeue::Entry) -> bool {
        unsafe {
            let mut sq = self.inner.submission();
            sq.push(sqe).is_ok()
        }
    }

    pub(in crate::driver) fn submit_cancel(&mut self, target_user_data: u64) {
        let sqe = opcode::AsyncCancel::new(target_user_data)
            .build()
            .user_data(wire::ignore());

        unsafe {
            let mut sq = self.inner.submission();
            if sq.push(&sqe).is_ok() {
                return;
            }
        }
        if let Err(e) = self.submit() {
            panic!("dope invariant violated: cancel submit failed: {e}");
        }
        unsafe {
            let mut sq = self.inner.submission();
            if sq.push(&sqe).is_err() {
                panic!("dope invariant violated: cancel SQE enqueue failed after submit");
            }
        }
    }
}