dope-core 0.20.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
117
118
119

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

/// Reusable parent capability for one exact ready node.
#[derive(Clone, Copy, Eq, PartialEq)]
#[repr(transparent)]
pub struct Parent<'d>(pub(in crate::driver::schedule::ready::task) ready::Address<'d>);

impl<'d> Parent<'d> {
    pub fn wake(self) {
        self.0.wake();
    }

    #[doc(hidden)]
    pub fn belongs_to(self, driver: driver::Reference<'_>) -> bool {
        self.0.belongs_to(driver)
    }

    pub(in crate::driver::schedule::ready) fn address(self) -> ready::Address<'d> {
        self.0
    }

    pub(in crate::driver::schedule::ready::task) fn driver(self) -> driver::Reference<'d> {
        self.0.driver
    }

    pub(in crate::driver::schedule::ready::task) fn key(self) -> ready::Key<'d> {
        self.0.key()
    }

    pub(in crate::driver::schedule::ready::task) fn validate(
        self,
        max: usize,
    ) -> Result<(), task::Error> {
        let address = self.0;
        let driver = address.driver;
        let mut key = address.key();
        let mut hops = max;
        let access = ready::Access::new(&driver);

        loop {
            match driver.ready().arena().task_parent(access, key) {
                ready::TaskParent::Root => return Ok(()),
                ready::TaskParent::Task(parent) => {
                    if hops == 0 {
                        return Err(task::Error::WakeHopCeiling {
                            minimum: max + 1,
                            maximum: max,
                        });
                    }
                    hops -= 1;
                    key = parent;
                }
                ready::TaskParent::Stale => return Err(task::Error::ParentStale),
            }
        }
    }

    /// Admits one exact child after validating the complete wake chain and capacity.
    pub fn try_admit(self) -> Result<task::raw::Admission<'d>, task::Error> {
        self.validate(task::MAX_WAKE_HOPS - 1)?;
        let arena = self.0.driver.ready().arena();
        let vacant = arena.entries.pool.prepare_task(&arena.entries.slots)?;
        let child = vacant.commit();
        Ok(task::raw::Admission::new(self, child))
    }

    pub(in crate::driver::schedule::ready) fn return_lease(
        self,
        held: ready::Permit<'d>,
        chain: &ready::Chain,
    ) {
        let entries = &self.0.driver.ready().arena().entries;
        chain.restore(&entries.slots, held.into_key());
    }

    pub(in crate::driver::schedule::ready) fn install_task(
        self,
        held: ready::Permit<'d>,
        root: &ready::TopologyKey<'d>,
        local: u32,
    ) -> ready::TaskKey<'d> {
        let arena = self.0.driver.ready().arena();
        let task = ready::Task::new(self.key(), root, local);
        held.install(&arena.entries.slots, root, task)
    }

    pub(in crate::driver::schedule::ready) fn release_hold(self, held: ready::Permit<'d>) {
        let entries = &self.0.driver.ready().arena().entries;
        entries.pool.recycle(&entries.slots, held.into_key());
    }

    pub(in crate::driver::schedule::ready) fn retarget(self, key: ready::Key<'d>) -> Self {
        Self(self.0.retarget(key))
    }

    pub(in crate::driver::schedule::ready) fn release(self, key: ready::TaskKey<'d>) {
        self.0.driver.ready().arena().free_task(key)
    }

    pub(in crate::driver::schedule::ready) fn reclaim_task(
        self,
        key: ready::TaskKey<'d>,
    ) -> ready::Reclaimed<'d> {
        self.0.driver.ready().arena().reclaim_task(key)
    }
}

impl<'d> From<ready::Target<'d>> for Parent<'d> {
    fn from(target: ready::Target<'d>) -> Self {
        Self(target.address())
    }
}

const _: () = {
    assert!(std::mem::size_of::<Parent<'static>>() == 2 * std::mem::size_of::<usize>());
};