dope-core 0.29.0

Owned native I/O and completion driver 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

use dope_sys::{engine::admit, io::file::File};

use crate::{
    Backend, Engine,
    driver::{
        life::native::{host::Host, request, request::bound},
        retained::flight,
        route,
        route::kind,
    },
};

type Guard<'a> = <Engine as admit::Admit<Host<Backend>>>::Admission<'a>;

/// Native reserved capacity bound to the exact driver that owns its operation.
#[repr(transparent)]
pub(crate) struct Admission<'a, 'd> {
    native: Guard<'a>,
    driver: route::Brand<'d, Engine>,
}
impl<'a, 'd> Admission<'a, 'd> {
    pub(crate) fn new(native: Guard<'a>, driver: route::Brand<'d, Engine>) -> Self {
        const {
            assert!(std::mem::size_of::<Self>() == std::mem::size_of::<Guard<'a>>());
            assert!(std::mem::align_of::<Self>() == std::mem::align_of::<Guard<'a>>());
        }
        Self { native, driver }
    }

    pub(crate) fn submit<C: kind::Class>(
        self,
        bound: bound::Bound<'d, request::Lowered, C>,
    ) -> flight::Flight<'d, C> {
        let (raw, reserve) = bound.into_parts();
        admit::Guard::<Host<Backend>>::submit(self.native, raw.into_inner(), reserve.key());
        reserve.commit()
    }

    /// # Safety
    /// Encoded handles and the reservation belong to this driver. Keep encoded
    /// addresses valid with their borrowed access through completion or quiescence.
    pub(crate) unsafe fn retain<'borrow, C: kind::Class>(
        self,
        bound: bound::Bound<'d, request::Borrowed<'borrow>, C>,
    ) -> flight::Flight<'d, C>
    where
        'd: 'borrow,
    {
        let (raw, reserve) = bound.into_parts();
        // SAFETY: the caller retains these exact native inputs. Submission
        // precedes commitment of the reserved flight.
        unsafe {
            admit::raw::Retain::<Host<Backend>>::retain(
                self.native,
                raw.into_inner(),
                reserve.key(),
            )
        };
        reserve.commit()
    }

    /// # Safety
    /// The reservation belongs to this driver. Retain every descriptor, path
    /// and buffer borrow through terminal completion or quiescence.
    pub(crate) unsafe fn file<'borrow, C: kind::Class>(
        self,
        bound: bound::Bound<'d, <Backend as File>::Request<'borrow>, C>,
    ) -> flight::Flight<'d, C>
    where
        'd: 'borrow,
    {
        let (raw, reserve) = bound.into_parts();
        // SAFETY: the caller retains these exact file borrows. Submission
        // precedes commitment of the reserved flight.
        unsafe { admit::raw::Retain::<Host<Backend>>::file(self.native, raw, reserve.key()) };
        reserve.commit()
    }
}