nexosim 1.0.0

A high performance asynchronous compute framework for system simulation.
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

//! Timeout during simulation step execution.

use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::thread;
use std::time::Duration;

use serde::{Deserialize, Serialize};

use nexosim::model::{BuildContext, Model, ProtoModel};
use nexosim::ports::{EventSource, Output};
use nexosim::simulation::{ExecutionError, Mailbox, SimInit};
use nexosim::time::MonotonicTime;

const MT_NUM_THREADS: usize = 4;

#[derive(Serialize, Deserialize)]
struct TestModel {
    output: Output<()>,
}
#[Model(type Env=TestEnv)]
impl TestModel {
    async fn input(&mut self) {
        self.output.send(()).await;
    }
}

struct TestEnv {
    // A liveliness flag that is cleared when the model is dropped.
    is_alive: Arc<AtomicBool>,
}
impl Drop for TestEnv {
    fn drop(&mut self) {
        self.is_alive.store(false, Ordering::Relaxed);
    }
}

struct TestProto {
    output: Output<()>,
    is_alive: Arc<AtomicBool>,
}
impl ProtoModel for TestProto {
    type Model = TestModel;

    fn build(self, _: &mut BuildContext<Self>) -> (Self::Model, <Self::Model as Model>::Env) {
        (
            TestModel {
                output: self.output,
            },
            TestEnv {
                is_alive: self.is_alive,
            },
        )
    }
}

fn timeout_untriggered(num_threads: usize) {
    let model = TestProto {
        output: Output::default(),
        is_alive: Arc::new(AtomicBool::new(true)),
    };
    let mbox = Mailbox::new();
    let addr = mbox.address();

    let mut bench = SimInit::with_num_threads(num_threads);

    let input = EventSource::new()
        .connect(TestModel::input, &addr)
        .register(&mut bench);

    let mut simu = bench
        .add_model(model, mbox, "test")
        .with_timeout(Duration::from_secs(1))
        .init(MonotonicTime::EPOCH)
        .unwrap();

    assert!(simu.process_event(&input, ()).is_ok());
}

fn timeout_triggered(num_threads: usize) {
    let model_is_alive = Arc::new(AtomicBool::new(true));
    let mut model = TestProto {
        output: Output::default(),
        is_alive: model_is_alive.clone(),
    };
    let mbox = Mailbox::new();
    let addr = mbox.address();

    // Make a loopback connection.
    model.output.connect(TestModel::input, addr.clone());

    let mut bench = SimInit::with_num_threads(num_threads);

    let input = EventSource::new()
        .connect(TestModel::input, &addr)
        .register(&mut bench);

    let mut simu = bench
        .add_model(model, mbox, "test")
        .with_timeout(Duration::from_secs(1))
        .init(MonotonicTime::EPOCH)
        .unwrap();

    assert!(matches!(
        simu.process_event(&input, ()),
        Err(ExecutionError::Timeout)
    ));

    // Make sure the request to stop the simulation has succeeded.
    thread::sleep(Duration::from_millis(10));
    assert!(!model_is_alive.load(Ordering::Relaxed));
}

#[test]
fn timeout_untriggered_st() {
    timeout_untriggered(1);
}

#[test]
fn timeout_untriggered_mt() {
    timeout_untriggered(MT_NUM_THREADS);
}

#[test]
fn timeout_triggered_st() {
    timeout_triggered(1);
}

#[test]
fn timeout_triggered_mt() {
    timeout_triggered(MT_NUM_THREADS);
}