dfir_rs 0.16.0

DFIR runtime for Rust, used by Hydro.
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192

use dfir_rs::dfir_syntax;
use dfir_rs::scheduled::ticks::TickInstant;
use dfir_rs::util::collect_ready;
use multiplatform_test::multiplatform_test;

#[multiplatform_test]
pub fn test_repeat_iter() {
    let (out_send, mut out_recv) = dfir_rs::util::unbounded_channel::<usize>();

    let mut df = dfir_syntax! {
        source_iter([1]) -> persist::<'static>() -> for_each(|v| out_send.send(v).unwrap());
    };
    assert_eq!(TickInstant::new(0), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(2), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(3), df.current_tick());

    assert_eq!(&[1, 1, 1], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    df.run_available_sync(); // Should return quickly and not hang
}

#[multiplatform_test]
pub fn test_fold_tick() {
    let (out_send, mut out_recv) = dfir_rs::util::unbounded_channel::<usize>();

    let mut df = dfir_syntax! {
        source_iter([1]) -> fold::<'tick>(|| 0, |accum: &mut _, elem| *accum += elem) -> for_each(|v| out_send.send(v).unwrap());
    };
    assert_eq!(TickInstant::new(0), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(2), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(3), df.current_tick());

    assert_eq!(&[1, 0, 0], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    df.run_available_sync(); // Should return quickly and not hang
}

#[multiplatform_test]
pub fn test_fold_static() {
    let (out_send, mut out_recv) = dfir_rs::util::unbounded_channel::<usize>();

    let mut df = dfir_syntax! {
        source_iter([1]) -> fold::<'static>(|| 0, |accum: &mut _, elem| *accum += elem) -> for_each(|v| out_send.send(v).unwrap());
    };
    assert_eq!(TickInstant::new(0), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(2), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(3), df.current_tick());

    assert_eq!(&[1, 1, 1], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    df.run_available_sync(); // Should return quickly and not hang
}

#[multiplatform_test]
pub fn test_reduce_tick() {
    let (out_send, mut out_recv) = dfir_rs::util::unbounded_channel::<usize>();

    let mut df = dfir_syntax! {
        source_iter([1]) -> reduce::<'tick>(|a: &mut _, b| *a += b) -> for_each(|v| out_send.send(v).unwrap());
    };
    assert_eq!(TickInstant::new(0), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(2), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(3), df.current_tick());

    assert_eq!(&[1], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    df.run_available_sync(); // Should return quickly and not hang
}

#[multiplatform_test]
pub fn test_reduce_static() {
    let (out_send, mut out_recv) = dfir_rs::util::unbounded_channel::<usize>();

    let mut df = dfir_syntax! {
        source_iter([1]) -> reduce::<'static>(|a: &mut _, b| *a += b) -> for_each(|v| out_send.send(v).unwrap());
    };
    assert_eq!(TickInstant::new(0), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(2), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(3), df.current_tick());

    assert_eq!(&[1, 1, 1], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    df.run_available_sync(); // Should return quickly and not hang
}

#[multiplatform_test]
pub fn test_fold_keyed_tick() {
    let (out_send, mut out_recv) = dfir_rs::util::unbounded_channel::<(char, usize)>();

    let mut df = dfir_syntax! {
        source_iter([('a', 1), ('a', 2)]) -> fold_keyed::<'tick>(|| 0, |acc: &mut usize, item| { *acc += item; }) -> for_each(|v| out_send.send(v).unwrap());
    };
    assert_eq!(TickInstant::new(0), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(2), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(3), df.current_tick());

    assert_eq!(&[('a', 3)], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    df.run_available_sync(); // Should return quickly and not hang
}

#[multiplatform_test]
pub fn test_fold_keyed_static() {
    let (out_send, mut out_recv) = dfir_rs::util::unbounded_channel::<(char, usize)>();

    let mut df = dfir_syntax! {
        source_iter([('a', 1), ('a', 2)]) -> fold_keyed::<'static>(|| 0, |acc: &mut usize, item| { *acc += item; }) -> for_each(|v| out_send.send(v).unwrap());
    };
    assert_eq!(TickInstant::new(0), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(2), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(3), df.current_tick());

    assert_eq!(
        &[('a', 3), ('a', 3), ('a', 3)],
        &*collect_ready::<Vec<_>, _>(&mut out_recv)
    );

    df.run_available_sync(); // Should return quickly and not hang
}

/// Check that the scheduler does not unnecsarily schedule internal events,
/// but will resume when external events come in.
#[multiplatform_test(test, wasm, env_tracing)]
pub fn test_resume_external_event() {
    let (in_send, in_recv) = dfir_rs::util::unbounded_channel::<usize>();
    let (out_send, mut out_recv) = dfir_rs::util::unbounded_channel::<usize>();

    let mut df = dfir_syntax! {
        source_stream(in_recv) -> fold::<'static>(|| 0, |a: &mut _, b| *a += b) -> for_each(|v| out_send.send(v).unwrap());
    };

    assert_eq!(TickInstant::new(0), df.current_tick());
    assert_eq!(&[] as &[usize], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());
    assert_eq!(&[0], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    df.run_tick_sync();
    assert_eq!(TickInstant::new(2), df.current_tick());
    assert_eq!(&[0], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    df.run_tick_sync();
    assert_eq!(TickInstant::new(3), df.current_tick());
    assert_eq!(&[0], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    df.run_available_sync();
    assert_eq!(TickInstant::new(4), df.current_tick());
    assert_eq!(&[0], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    in_send.send(1).unwrap();
    df.run_tick_sync();
    assert_eq!(TickInstant::new(5), df.current_tick());
    assert_eq!(&[1], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    in_send.send(2).unwrap();
    df.run_available_sync();
    assert_eq!(TickInstant::new(6), df.current_tick());
    assert_eq!(&[3], &*collect_ready::<Vec<_>, _>(&mut out_recv));

    df.run_available_sync();
    assert_eq!(TickInstant::new(7), df.current_tick());
    assert_eq!(&[3], &*collect_ready::<Vec<_>, _>(&mut out_recv));
}