simulon 0.0.8

A simulation engine for distributed algorithms
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

use std::cmp::Reverse;

use derive_more::{Deref, DerefMut};

use crate::{api::RemoteAddr, future::DeferredFutureWaker, state::ResourceId};

#[derive(PartialEq, Eq, PartialOrd, Ord, Debug)]
pub struct Message {
    // Time must be the first field so the derived impl of ord works as expected.
    // Also we reverse it since we use a max heap but we want the messages with smaller
    // time to come first.
    pub time: Reverse<u128>,
    pub sender: RemoteAddr,
    pub receiver: RemoteAddr,
    pub detail: MessageDetail,
}

#[derive(PartialEq, Eq, PartialOrd, Ord, Debug)]
pub enum MessageDetail {
    Connect {
        port: u16,
        rid: ResourceId,
    },
    ConnectionAccepted {
        sender_rid: ResourceId,
        receiver_rid: ResourceId,
    },
    ConnectionRefused {
        receiver_rid: ResourceId,
    },
    ConnectionClosed {
        receiver_rid: ResourceId,
    },
    Data {
        receiver_rid: ResourceId,
        data: Vec<u8>,
    },
    WakeUp {
        waker: Ignored<DeferredFutureWaker<()>>,
    },
}

#[derive(Deref, DerefMut)]
pub struct Ignored<T>(pub T);

impl<T> std::fmt::Debug for Ignored<T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "[IGNORED]")
    }
}

impl<T> Ord for Ignored<T> {
    fn cmp(&self, _other: &Self) -> std::cmp::Ordering {
        std::cmp::Ordering::Equal
    }
}
impl<T> Eq for Ignored<T> {}
impl<T> PartialEq for Ignored<T> {
    fn eq(&self, _other: &Self) -> bool {
        true
    }
}
impl<T> PartialOrd for Ignored<T> {
    fn partial_cmp(&self, _other: &Self) -> Option<std::cmp::Ordering> {
        Some(std::cmp::Ordering::Equal)
    }
}

#[cfg(test)]
mod tests {
    use std::collections::BinaryHeap;

    use super::*;
    use crate::state::ResourceId;

    #[test]
    fn test_ordering() {
        let m1 = Message {
            time: Reverse(0),
            sender: RemoteAddr(1),
            receiver: RemoteAddr(2),
            detail: super::MessageDetail::ConnectionClosed {
                receiver_rid: ResourceId(18),
            },
        };

        let m2 = Message {
            time: Reverse(17),
            sender: RemoteAddr(1),
            receiver: RemoteAddr(2),
            detail: super::MessageDetail::ConnectionClosed {
                receiver_rid: ResourceId(18),
            },
        };

        let m3 = Message {
            time: Reverse(3),
            sender: RemoteAddr(0),
            receiver: RemoteAddr(0),
            detail: super::MessageDetail::ConnectionClosed {
                receiver_rid: ResourceId(0),
            },
        };

        let m4 = Message {
            time: Reverse(5),
            sender: RemoteAddr(0),
            receiver: RemoteAddr(0),
            detail: super::MessageDetail::ConnectionClosed {
                receiver_rid: ResourceId(0),
            },
        };

        let m5 = Message {
            time: Reverse(2),
            sender: RemoteAddr(18),
            receiver: RemoteAddr(0),
            detail: super::MessageDetail::ConnectionClosed {
                receiver_rid: ResourceId(0),
            },
        };

        let mut set: BinaryHeap<Message> = BinaryHeap::new();

        set.push(m1);
        set.push(m2);
        set.push(m3);
        set.push(m4);
        set.push(m5);

        assert_eq!(set.pop().unwrap().time.0, 0);
        assert_eq!(set.pop().unwrap().time.0, 2);
        assert_eq!(set.pop().unwrap().time.0, 3);
        assert_eq!(set.pop().unwrap().time.0, 5);
        assert_eq!(set.pop().unwrap().time.0, 17);
    }
}