dope-runtime 0.21.0

Thread-per-core execution and process lifecycle 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

use std::{pin, task};

use dope_core::driver::{
    retained,
    schedule::{app, ready},
};

/// Runtime poll capability tying one exact root and driver to a poll.
pub struct Context<'poll, 'd: 'poll, R> {
    root: pin::Pin<&'poll mut R>,
    wake: ready::Target<'d>,
    work: app::Work<'poll, 'd>,
    driver: retained::Context<'poll, 'poll, 'd>,
}

/// Remaining application-lane credits for one root poll.
#[derive(Clone, Copy)]
pub struct Budget<'poll, 'd> {
    wake: ready::Target<'d>,
    work: app::Work<'poll, 'd>,
}

impl<'poll, 'd: 'poll, R> Context<'poll, 'd, R> {
    pub(crate) fn new(
        root: pin::Pin<&'poll mut R>,
        wake: ready::Target<'d>,
        work: app::Work<'poll, 'd>,
        driver: retained::Context<'poll, 'poll, 'd>,
    ) -> Self {
        Self {
            root,
            wake,
            work,
            driver,
        }
    }

    pub fn into_parts(
        self,
    ) -> (
        pin::Pin<&'poll mut R>,
        ready::Target<'d>,
        app::Work<'poll, 'd>,
        retained::Context<'poll, 'poll, 'd>,
    ) {
        (self.root, self.wake, self.work, self.driver)
    }

    pub fn into_poll(
        self,
    ) -> (
        pin::Pin<&'poll mut R>,
        Budget<'poll, 'd>,
        retained::Context<'poll, 'poll, 'd>,
    ) {
        (self.root, Budget::new(self.wake, self.work), self.driver)
    }
}

impl<'poll, 'd> Budget<'poll, 'd> {
    pub(crate) const fn new(wake: ready::Target<'d>, work: app::Work<'poll, 'd>) -> Self {
        Self { wake, work }
    }

    pub fn target(self) -> ready::Target<'d> {
        self.wake
    }

    /// Reserves one more application transition, requeueing the root when its
    /// current application-lane share is exhausted.
    pub fn try_continue(self) -> Option<app::Permit<'poll, 'd>> {
        let permit = self.work.permit();
        if permit.is_none() {
            self.wake.wake();
        }
        permit
    }
}

/// Transient pinned control-flow root.
/// Driver authority retains the application through terminal quiescence.
pub trait Root<'d>: Sized {
    type Output;
    fn poll(context: Context<'_, 'd, Self>) -> task::Poll<Self::Output>;
}