dope-core 0.27.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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use std::mem;

use o3::mem::quota;
use state::lanes;

use crate::driver::{
    schedule,
    schedule::{clock, ready, state, timers},
};

pub(in crate::driver) const REACTORS: usize = 2;

pub struct Scope<'scope, 'd> {
    state: &'scope mut state::Core<'d>,
}

#[must_use = "the active turn must remain live for the complete driver cycle"]
pub struct Guard<'turn, 'd> {
    state: &'turn mut state::Core<'d>,
}

#[must_use = "reactor authority must be consumed by Poll or Source"]
pub struct Reactor<'turn, 'd> {
    pub(in crate::driver::schedule) quota: quota::Shared<'turn, lanes::Domain<'d>>,
    pub(in crate::driver::schedule) cursor: state::Cursor,
}

pub struct Coord<'turn, 'd> {
    state: &'turn state::Core<'d>,
}

impl<'scope, 'd> Scope<'scope, 'd> {
    pub(in crate::driver) fn new(state: &'scope mut state::Core<'d>) -> Self {
        Self { state }
    }

    pub fn begin_at(&mut self, sample: clock::Sample) -> Guard<'_, 'd> {
        self.sample(sample);
        self.begin()
    }

    /// Installs the clock sample for work that opens no driver cycle.
    pub fn sample(&mut self, sample: clock::Sample) {
        self.state
            .driver
            .scheduler()
            .set_turn_now(sample.into_raw());
    }

    pub fn begin(&mut self) -> Guard<'_, 'd> {
        self.state.reset();
        Guard {
            state: &mut *self.state,
        }
    }
}

impl<'turn, 'd> Guard<'turn, 'd> {
    pub fn turn(&self) -> schedule::Turn<'_, 'd> {
        schedule::Turn::new(&*self.state)
    }

    pub fn reactor(&mut self) -> Reactor<'_, 'd> {
        self.split().0
    }

    pub fn split(&mut self) -> (Reactor<'_, 'd>, schedule::Turn<'_, 'd>) {
        let state = &*self.state;
        let cursor = state.reactor.cursor.get();
        state.reactor.cursor.set(cursor.next());
        (
            Reactor {
                quota: quota::Shared::reserve_all(&state.reactor.ledger),
                cursor,
            },
            schedule::Turn::new(state),
        )
    }

    /// Runs every timer that has expired at the current turn sample.
    pub fn expire(&mut self) {
        let state = &*self.state;
        timers::expire(state.driver, &state.lanes.timers);
    }

    pub fn is_exhausted(&self) -> bool {
        self.state.is_exhausted()
    }

    pub fn ready(&self) -> ready::Rounds<'_, 'd> {
        let state = &*self.state;
        ready::Rounds::new(state.driver, lanes::Budget::reserve_all(&state.lanes.ready))
    }
}

impl<'turn, 'd> Reactor<'turn, 'd> {
    pub(crate) fn remaining(&self) -> usize {
        self.quota.remaining()
    }

    pub(crate) const fn cursor(&self) -> usize {
        self.cursor.index()
    }

    pub(crate) fn budget<'budget, Lane>(
        &'budget self,
        limit: usize,
    ) -> lanes::Budget<'budget, 'd, Lane> {
        lanes::Budget::lease(&self.quota, limit)
    }
}

impl<'turn, 'd> Coord<'turn, 'd> {
    pub(in crate::driver::schedule) fn new(state: &'turn state::Core<'d>) -> Self {
        Self { state }
    }

    pub fn take(&mut self) -> quota::Take {
        match self.state.lanes.coord.take() {
            quota::Take::Taken => quota::Take::Taken,
            quota::Take::Exhausted => {
                self.state.deferred.set(true);
                quota::Take::Exhausted
            }
        }
    }

    pub fn remaining(&self) -> usize {
        self.state.lanes.coord.remaining()
    }

    pub fn share<const N: usize, T>(
        &self,
        rank: usize,
        weights: [usize; 2],
        run: impl FnOnce() -> T,
    ) -> T {
        let _held = lanes::weighted::<N, _>(&self.state.lanes.coord, rank, weights);
        run()
    }
}

const _: () = {
    let word = mem::size_of::<usize>();
    assert!(mem::size_of::<Scope<'static, 'static>>() == word);
    assert!(mem::size_of::<Guard<'static, 'static>>() == word);
};