dope-runtime 0.20.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
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

use std::mem;

use dope_core::platform::affinity;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u32)]
pub enum Event {
    Installed,
    Ready,
    Drain,
    Done,
    Failed,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(transparent)]
pub struct Invalid(u32);

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct RecordSize {
    pub expected: usize,
    pub actual: usize,
}

#[derive(Debug)]
pub struct Startup {
    pub cpu: affinity::Cpu,
    pub event: Event,
    pub workers: usize,
    pub installed: usize,
    pub ready: usize,
    pub gated: bool,
}

#[derive(Debug)]
pub struct Drain {
    pub cause: DrainCause,
    pub workers: usize,
    pub drained: usize,
    pub done: usize,
}

#[derive(Debug)]
pub enum DrainCause {
    Event { cpu: affinity::Cpu, event: Event },
    Order,
}

#[derive(Debug)]
pub struct Shutdown {
    pub cpu: affinity::Cpu,
    pub event: Event,
    pub workers: usize,
    pub done: usize,
}

impl Event {
    pub(in crate::process) const fn encode(self) -> u32 {
        self as u32
    }

    pub(in crate::process) const fn decode(value: u32) -> Result<Self, Invalid> {
        match value {
            0 => Ok(Self::Installed),
            1 => Ok(Self::Ready),
            2 => Ok(Self::Drain),
            3 => Ok(Self::Done),
            4 => Ok(Self::Failed),
            value => Err(Invalid(value)),
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Write {
    Syscall(dope_core::Errno),
    Record(RecordSize),
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Fault {
    pub event: Event,
    pub failure: Write,
    pub shutdown: Option<dope_core::Errno>,
}

#[derive(Debug)]
pub enum Report {
    Clean,
    Failed(Fault),
}

#[derive(Debug)]
pub struct Sequence {
    pub gated: bool,
    pub previous: Option<Event>,
    pub event: Event,
}

#[derive(Debug)]
pub enum Read {
    Syscall(dope_core::Errno),
    /// The coordinator consumed this Main after an exact shutdown failure.
    Stopped(dope_core::Errno),
    Closed,
    Record(RecordSize),
    Event(Invalid),
    Sequence(Sequence),
}

#[derive(Debug)]
pub enum State {
    StartupEvent(Startup),
    RuntimeEvent { cpu: affinity::Cpu, event: Event },
    DrainEvent(Drain),
    DrainOrder(Drain),
    ShutdownEvent(Shutdown),
}

const _: () = {
    assert!(mem::size_of::<Event>() == mem::size_of::<u32>());
    assert!(mem::size_of::<Invalid>() == mem::size_of::<u32>());
};