desim 0.4.0

A discrete-time events simulation framework inspired by Simpy
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

/* Copyright © 2021 Gianmarco Garrisi

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>. */

//! This example shows how to create a custom resource and implement the resource trait.
//!
//! Features shown in this example:
//! * Custom Resources
//! * Prelude
//! * Custom state
//! * EndCondition::NoEvents

#![feature(coroutines)]

use desim::prelude::*;
use desim::resources::Resource;

use rand::{
    distributions::{Distribution, Uniform},
    rngs::SmallRng as Rng,
    SeedableRng,
};

const Q_SIZE: usize = 30;
const NUM_CLIENTS: usize = 800;
const SIM_TIME: f64 = 50.0;

#[derive(Copy, Clone, Debug)]
struct State {
    effect: Effect,
    queue_full: bool,
}

impl State {
    fn new(effect: Effect) -> State {
        State {
            effect,
            queue_full: false,
        }
    }
}

struct FiniteQueue {
    _quantity: usize,
    available: usize,
    queue: [Option<Event<State>>; Q_SIZE],
    queue_start: usize,
    queue_len: usize,
}

impl SimState for State {
    fn get_effect(&self) -> Effect {
        self.effect
    }
    fn set_effect(&mut self, effect: Effect) {
        self.effect = effect;
    }
    fn should_log(&self) -> bool {
        true
    }
}

impl Resource<State> for FiniteQueue {
    fn allocate_or_enqueue(&mut self, event: Event<State>) -> Option<Event<State>> {
        if self.available > 0 {
            self.available -= 1;
            Some(event)
        } else if self.queue_len == Q_SIZE {
            let mut event = event;
            event.state_mut().queue_full = true;
            Some(event)
        } else {
            let first_position = (self.queue_start + self.queue_len) % Q_SIZE;
            self.queue[first_position] = Some(event);
            self.queue_len += 1;
            None
        }
    }
    fn release_and_schedule_next(&mut self, event: Event<State>) -> Option<Event<State>> {
        if self.queue_len > 0 {
            let mut next_event = self.queue[self.queue_start].take().unwrap();
            self.queue_start = (self.queue_start + 1) % Q_SIZE;
            self.queue_len -= 1;
            next_event.set_time(event.time());
            Some(next_event)
        } else {
            self.available += 1;
            None
        }
    }
}

fn client_process(res: ResourceId) -> Box<Process<State>> {
    Box::new(move |response: SimContext<State>| {
        yield State::new(Effect::Request(res));
        if !response.state().queue_full {
            yield State::new(Effect::TimeOut(5.0));
            yield State::new(Effect::Release(res));
        } else {
            yield State::new(Effect::Trace);
        }
    })
}

fn main() {
    let mut sim = Simulation::new();
    let unif = Uniform::new(0.0, SIM_TIME);
    let rng = Rng::from_entropy();

    let res = FiniteQueue {
        _quantity: 4,
        available: 4,
        queue: [None; Q_SIZE],
        queue_start: 0,
        queue_len: 0,
    };
    let res = sim.create_resource(Box::new(res));

    // Create NUM_CLIENTS processes and schedule them at random times
    for t in unif.sample_iter(rng).take(NUM_CLIENTS) {
        let p = sim.create_process(client_process(res));
        sim.schedule_event(t, p, State::new(Effect::TimeOut(0.0)));
    }

    sim = sim.run(EndCondition::NoEvents);
    // Print the simulation log
    for (e, state) in sim.processed_events() {
        println!("{}\t{:?}\t{:?}", e.time(), e.state(), state);
    }

    println!(
        "Lost clients: {}",
        sim.processed_events()
            .iter()
            .filter(|(e, _)| e.state().queue_full)
            .count()
    );
}