dope-core 0.24.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
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

use std::{marker, mem, num};

use dope_sys::table::permit;

use crate::{
    driver,
    driver::schedule::{ready, ready::task},
};

/// A driver-scoped lease of `N` task admissions without a stored parent.
#[doc(hidden)]
pub struct Pool<'d, Tag, const N: usize> {
    driver: driver::Reference<'d>,
    chain: ready::Chain,
    tag: marker::PhantomData<fn(Tag) -> Tag>,
}

/// One parent key proven to belong to a pool's driver and wake-hop ceiling.
#[doc(hidden)]
#[derive(Clone, Copy, Eq, PartialEq)]
#[repr(transparent)]
pub struct Root<'d>(ready::Key<'d>);

/// Lifetime-free identity of one exact task root generation.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(transparent)]
pub struct RootId(u64);

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum RootError {
    Foreign,
    Invalid(task::Error),
}

impl<'d> Root<'d> {
    pub(super) fn initial(parent: task::Parent<'d>) -> Result<Self, task::Error> {
        parent.validate(task::MAX_WAKE_HOPS - 1)?;
        Ok(Self(parent.key()))
    }

    pub fn id(self) -> RootId {
        RootId(permit::raw::Key::identity(self.0.raw()))
    }
}

impl<'d, Tag, const N: usize> Pool<'d, Tag, N> {
    pub fn try_new(parent: task::Parent<'d>) -> Result<Self, task::Error> {
        let Some(count) = num::NonZero::<usize>::new(N) else {
            return Err(task::Error::Capacity {
                requested: num::NonZero::<usize>::MIN,
                available: 0,
            });
        };
        let driver = parent.driver();
        let entries = &driver.ready().arena().entries;
        let chain = entries.pool.try_take(&entries.slots, count)?;
        Ok(Self {
            driver,
            chain,
            tag: marker::PhantomData,
        })
    }

    pub fn try_root(&self, parent: task::Parent<'d>) -> Result<Root<'d>, RootError> {
        if !parent.belongs_to(self.driver) {
            return Err(RootError::Foreign);
        }
        Root::initial(parent).map_err(RootError::Invalid)
    }

    pub fn parent(&self, root: Root<'d>) -> task::Parent<'d> {
        task::Parent(ready::Address::new(self.driver, root.0))
    }

    pub fn try_admit<'lease>(
        &'lease self,
        root: Root<'d>,
    ) -> Result<task::raw::Lease<'lease, 'd>, task::Error> {
        let entries = &self.driver.ready().arena().entries;
        let Some((child, chain)) = self.chain.try_claim(&entries.slots) else {
            return Err(task::Error::Capacity {
                requested: num::NonZero::<usize>::MIN,
                available: 0,
            });
        };
        Ok(task::raw::Lease::new(self.parent(root), child, chain))
    }

    pub(in crate::driver::schedule::ready::task) fn reclaim<R>(
        &self,
        root: Root<'d>,
        child: ready::Renewal<'d>,
        reusable: R,
        retired: R,
    ) -> R {
        match child {
            ready::Renewal::Reusable(child) => {
                self.parent(root).return_lease(child, &self.chain);
                reusable
            }
            ready::Renewal::Retired => retired,
        }
    }
}

impl<Tag, const N: usize> Drop for Pool<'_, Tag, N> {
    fn drop(&mut self) {
        let entries = &self.driver.ready().arena().entries;
        entries.pool.restore(&entries.slots, &self.chain);
    }
}

const _: () = assert!(mem::size_of::<Pool<'static, (), 0>>() == 2 * mem::size_of::<usize>());
const _: () =
    assert!(mem::size_of::<Pool<'static, (), 4096>>() == mem::size_of::<Pool<'static, (), 0>>());
const _: () = assert!(mem::size_of::<Root<'static>>() == mem::size_of::<usize>());