modVM 0.3.0

A framework for easily creating modular VMs.
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

#![allow(dead_code)]
#![allow(unused_variables)]

use std::sync::mpsc::{self, *};

pub mod machines;

pub use self::machines::Machine;

/* The Main datatypes for modular_vm */

#[derive(Debug)]
pub enum Query<BASE> {
    LoadRequest(BASE),
    SaveRequest(BASE, BASE),
}

#[derive(Debug)]
pub enum Response<BASE> {
    Data(BASE),
    Good,
    Fail(BASE),
}

pub struct TwoWayChannel<B, T> {
    out: Sender<B>,
    back: Receiver<T>
}

impl<I, O> TwoWayChannel<I, O> {
    pub fn construct() -> (TwoWayChannel<I, O>, TwoWayChannel<O, I>) {
        let (senderout, receiverout) = mpsc::channel();
        let (senderin, receiverin) = mpsc::channel();

        (
            TwoWayChannel {
                out: senderout,
                back: receiverin,
            },

            TwoWayChannel {
                out: senderin,
                back: receiverout,
            }
        )
    }

    pub fn send(&self, data: I) -> Result<(), SendError<I>> {
        self.out.send(data)
    }

    pub fn recv(&self) -> Result<O, RecvError> {
        self.back.recv()
    }

    pub fn try_recv(&self) -> Result<O, TryRecvError> {
        self.back.try_recv()
    }

    pub fn iter(&self) -> Iter<O> {
        self.back.iter()
    }

    pub fn try_iter(&self) -> TryIter<O> {
        self.back.try_iter()
    }

    pub fn query(&self, data: I) -> Result<O, RecvError> {
        self.send(data).unwrap();
        self.recv()
    }
}

pub struct Metadata {
    pub model: String,
}

pub type FrontEnd<BASE> = TwoWayChannel<Query<BASE>, Response<BASE>>;

pub type BackEnd<BASE> = TwoWayChannel<Response<BASE>, Query<BASE>>;

/* Peripherals and Processors for a normal machine */

pub trait Peripheral<BASE> {
    fn handle(&mut self, incoming: Query<BASE>) -> Result<Response<BASE>, BASE>;

    fn metadata(&self) -> Metadata {
        Metadata {
            model: String::from("Peripheral"),
        }
    }

    fn cycle(&mut self) -> Result<(), BASE> {
        Ok(())
    }

    fn boot(&mut self) -> Result<(), BASE> {
        Ok(())
    }

    fn halt(&mut self) -> Result<(), BASE> {
        Ok(())
    }
}

pub trait Processor<BASE> {
    fn exe_ins(&mut self, channels: &Vec<FrontEnd<BASE>>) -> Result<(), BASE>;

    fn metadata(&self) -> Metadata {
        Metadata {
            model: String::from("Processor"),
        }
    }

    fn boot(&mut self, channels: &Vec<FrontEnd<BASE>>) -> Result<(), BASE> {
        Ok(())
    }

    fn halt(&mut self, channels: &Vec<FrontEnd<BASE>>) -> Result<(), BASE> {
        Ok(())
    }
}

/* Processors for a Processor Network machine */

pub trait ProcessorNode<BASE> {
    fn exe_ins(&mut self, channels: &Vec<FrontEnd<BASE>>) -> Result<(), BASE>;

    fn metadata(&self) -> Metadata {
        Metadata {
            model: String::from("ProcessorNode"),
        }
    }

    fn handle(&mut self, incoming: Query<BASE>) -> Result<Response<BASE>, BASE>;

    fn boot(&mut self, channels: &Vec<FrontEnd<BASE>>) -> Result<(), BASE> {
        Ok(())
    }

    fn halt(&mut self, channels: &Vec<FrontEnd<BASE>>) -> Result<(), BASE> {
        Ok(())
    }
}

/* Nodes for a Node Network machine */

pub trait Node<BASE> {
    fn cycle(&mut self, channels: &Vec<FrontEnd<BASE>>) -> Result<(), BASE>;

    fn handle(&mut self, incoming: Query<BASE>) -> Result<Response<BASE>, BASE>;

    fn metadata(&self) -> Metadata {
        Metadata {
            model: String::from("Node"),
        }
    }

    fn boot(&mut self, channels: &Vec<FrontEnd<BASE>>) -> Result<(), BASE> {
        Ok(())
    }

    fn halt(&mut self, channels: &Vec<FrontEnd<BASE>>) -> Result<(), BASE> {
        Ok(())
    }
}