dope-uring 0.37.0

Owned io_uring backend for dope
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

use dope_sys::{
    memory,
    memory::buffer::canary,
    probe::{State, Stopped, session},
    table::token,
};

use crate::reactor::{
    cq, register,
    ring::{
        Session, Waiting,
        session::{Checked, Fault, Stage},
    },
};

type Progression<T, L, F> = (Stage<T, L, F>, Result<Checked<T>, Fault<T>>);

type Native<T, L, F> = Waiting<Session<T, L, F>, T>;
type Progress<T, L, F> = State<Session<T, L, F>, Native<T, L, F>>;
type Inspection<L, E> = canary::Failure<
    cq::Buffer,
    <<L as memory::raw::Receive>::Extent as memory::raw::Extent>::Length,
    <<L as memory::raw::Receive>::Extent as memory::raw::Extent>::Capacity,
    E,
>;

/// Pending sessions permit cancellation while retaining their exact native owner.
#[repr(transparent)]
pub struct Pending<T: token::Codec, L: memory::raw::Canary, F>(Waiting<Session<T, L, F>, T>);

impl<T: token::Codec, L: memory::raw::Canary, F> Pending<T, L, F> {
    pub(super) fn new(waiting: Waiting<Session<T, L, F>, T>) -> Self {
        Self(waiting)
    }

    fn retained<E>(failed: Stopped<Native<T, L, F>, E>) -> Stopped<Self, E> {
        failed.map(Self)
    }

    pub(super) fn stage(state: Progress<T, L, F>) -> Stage<T, L, F> {
        match state {
            State::Idle(state) => State::Idle(state),
            State::Active(waiting) => State::Active(Self(waiting)),
        }
    }

    fn stopped(failed: Stopped<Progress<T, L, F>, Fault<T>>) -> Stopped<Stage<T, L, F>, Fault<T>> {
        failed.map(Self::stage)
    }

    pub(super) fn next(self) -> Progression<T, L, F> {
        use dope_sys::probe::raw::Wait as _;
        match self.0.next(Session::ring) {
            Ok((state, done)) => (Self::stage(state), Ok(done)),
            Err(Stopped { state, cause }) => (Self::stage(state), Err(cause)),
        }
    }
}

impl<T: token::Codec, L: memory::raw::Canary> Pending<T, L, register::raw::Occupied> {
    pub(super) fn inspect<E>(
        self,
        buffer: cq::Buffer,
        len: <L::Extent as memory::raw::Extent>::Length,
        check: impl FnOnce(&[u8]) -> Result<(), E>,
    ) -> (Self, Result<(), Inspection<L, E>>) {
        use dope_sys::{memory::buffer::canary::raw::Storage as _, probe::raw::Wait as _};
        // SAFETY: only Occupied::next calls this after consuming its unique CQE;
        // inspection retains the exact owner and all outstanding kernel borrows.
        match unsafe {
            self.0
                .inspect(|state| state.owner.storage_mut().inspect(buffer, len, check))
        } {
            Ok(state) => (Self(state), Ok(())),
            Err(Stopped { state, cause }) => (Self(state), Err(cause)),
        }
    }
}

impl<T: token::Codec, L: memory::raw::Canary, F> session::Pending for Pending<T, L, F> {
    type Session = Session<T, L, F>;

    fn resume(
        stopped: Stopped<Self, Fault<T>>,
        report: impl FnMut(Fault<T>),
    ) -> Result<Self, Stopped<Self, Fault<T>>> {
        use dope_sys::probe::raw::Wait as _;
        Waiting::resume(stopped.map(|pending| pending.0), Session::ring, report)
            .map(Self)
            .map_err(Self::retained)
    }

    fn cancel(self) -> Result<Self::Session, Stopped<Stage<T, L, F>, Fault<T>>> {
        use dope_sys::probe::raw::Wait as _;
        self.0.cancel(Session::ring).map_err(Self::stopped)
    }
}