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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
use crate::result::CompilerResult;
use crate::test_binary::RelayInstr;
use crate::test_descriptor::ast::{RelayOp, RelayStatement};
use crate::test_descriptor::concrete_test::ConcreteTest;

/// Timeline of all relay operations over the whole test
/// endpoints vector gives time for specific relay operations
/// `endpoints[0]` is the time for all relay statements in `operations[0]`
#[derive(PartialEq, Debug)]
pub struct RelaysTimeline {
    /// Times of relay operations
    pub endpoints: Vec<u32>,
    pub operations: Vec<Vec<RelayStatement>>,
}

impl RelaysTimeline {
    pub fn new() -> Self {
        RelaysTimeline {
            // Initial endpoints are empty
            endpoints: Vec::new(),
            // Initial operations are empty
            operations: vec![],
        }
    }

    /// Adds relay operation from relay statement
    /// into relay timeline and inserts any necessary endpoint
    pub fn add_relay_statement(&mut self, statement: &RelayStatement) -> CompilerResult<()> {
        let res = CompilerResult::status_only("Add relay statement to relay timeline");

        let start_time = statement.time as u32;

        //Find start index in timeline
        let start_idx = match self.endpoints.binary_search(&start_time) {
            Ok(exact_idx) => exact_idx,
            Err(one_above_idx) => one_above_idx,
        };

        //let start_idx = find_endpoint_idx(start_time, &timeline_relay.endpoints, 0);

        if start_idx >= self.endpoints.len() {
            //Append start time
            self.endpoints.push(start_time);
            self.operations.push(Vec::new());
        }

        //Get current start time from timeline
        let start_timeline = self.endpoints[start_idx];

        match start_timeline.cmp(&start_time) {
            // Check if start time is already present in timeline
            std::cmp::Ordering::Equal => {
                //Insert relay statement
                self.operations[start_idx].push((*statement).clone());
            }

            // Check if start time needs to be inserted
            std::cmp::Ordering::Greater => {
                //Insert start time
                self.endpoints.insert(start_idx, start_time);
                //Insert relay statement
                self.operations
                    .insert(start_idx, vec![(*statement).clone()]);
                //self.operations[start_idx].push((*statement).clone());
            }

            // We haven't gotten to start time in the timeline yet
            std::cmp::Ordering::Less => (),
        }
        res
    }
    /// Ensure relay timeline satisfies all design requirements
    /// such as all relays must be unset at end of test
    pub fn validate(&self, concrete: &ConcreteTest) -> CompilerResult<()> {
        let mut res = CompilerResult::status_only("Validate relay timeline");

        // Both active relays and unset relays are tracked separately and initialized to be empty.
        // This allows validate() to be used to validate the test body and all aborts.
        // Aborts start executing with potentially some relays already active, so while a single unset
        // operation in an abort may appear to be an unnecessary unset because there was no prior set
        // operation for that relay contained in the abort, it may not actually be unecessary.
        let mut active_relays: Vec<String> = Vec::new();
        let mut unset_relays: Vec<String> = Vec::new();
        for relay_idx in 0..self.endpoints.len() {
            for idx in 0..self.operations[relay_idx].len() {
                let operation = &self.operations[relay_idx][idx];
                match operation.op {
                    RelayOp::Set => {
                        if active_relays.contains(&operation.id) {
                            res.warning((
                                operation.metadata,
                                "Tried to set an already active relay",
                            ));
                        } else {
                            active_relays.push(operation.id.to_string());
                            unset_relays.retain(|x| !x.eq(&operation.id));
                        }
                    }
                    RelayOp::Unset => {
                        if unset_relays.contains(&operation.id) {
                            res.warning((
                                operation.metadata,
                                "Tried to unset an already inactive relay",
                            ));
                        } else {
                            unset_relays.push(operation.id.to_string());
                            active_relays.retain(|x| !x.eq(&operation.id));
                        }
                    }
                }
            }
        }
        active_relays.sort();

        if !active_relays.eq(&concrete.environment.config.safe_state) {
            res.error(format!(
                "Active relays at end of test did not match safe state {:?}",
                active_relays
            ));
        }
        res
    }

    pub fn to_instrs(&self, concrete: &ConcreteTest) -> CompilerResult<Vec<(u32, RelayInstr)>> {
        let mut res = CompilerResult::new("Convert relays timeline into a vector of RelayInstr");
        let mut relay_instructions: Vec<(u32, RelayInstr)> = Vec::new();
        // Convert relay statements into relay instructions
        for (time, operations_vec) in self.endpoints.iter().zip(self.operations.iter()) {
            for statement in operations_vec {
                relay_instructions.push((
                    *time,
                    check!(res, RelayInstr::try_from(concrete, statement)),
                ));
            }
        }

        res.with_value(relay_instructions)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::result::diagnostic::Location;
    use crate::result::Status;
    use crate::test_builder::TestBuilder;
    use crate::test_descriptor::ast::RelayOp;

    #[test]
    fn construct_relay_timeline() {
        let empty_location = Location::from_raw(0, 0, 0);

        let endpoints: Vec<u32> = vec![0, 2, 5, 20];

        let relay1_set = RelayStatement {
            time: 0,
            id: "1".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let relay2_set = RelayStatement {
            time: 2,
            id: "2".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let relay1_unset = RelayStatement {
            time: 20,
            id: "1".to_string(),
            op: RelayOp::Unset,
            metadata: empty_location,
        };

        let relay2_unset = RelayStatement {
            time: 5,
            id: "2".to_string(),
            op: RelayOp::Unset,
            metadata: empty_location,
        };

        let operations = vec![
            vec![relay1_set.clone()],
            vec![relay2_set.clone()],
            vec![relay2_unset.clone()],
            vec![relay1_unset.clone()],
        ];
        let simple_timeline = RelaysTimeline {
            endpoints,
            operations,
        };

        let mut timeline_relay = RelaysTimeline::new();
        timeline_relay.add_relay_statement(&relay1_set);
        timeline_relay.add_relay_statement(&relay2_set);
        timeline_relay.add_relay_statement(&relay2_unset);
        timeline_relay.add_relay_statement(&relay1_unset);
        assert_eq!(timeline_relay, simple_timeline);
    }

    #[test]
    fn validate_one_relay_active() {
        let mut testbuilder = TestBuilder::new();
        testbuilder.with_relay("relay1");
        let concrete = ConcreteTest::try_new(testbuilder.env, testbuilder.test)
            .to_option()
            .unwrap();

        let empty_location = Location::from_raw(0, 0, 0);
        let relay1_set = RelayStatement {
            time: 0,
            id: "1".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let mut timeline_relay = RelaysTimeline::new();
        timeline_relay.add_relay_statement(&relay1_set);
        assert_eq!(
            timeline_relay.validate(&concrete).get_status(),
            Status::Failed
        );
    }

    #[test]
    fn validate_one_relay_inactive() {
        let mut testbuilder = TestBuilder::new();
        testbuilder.with_relay("relay1");
        let concrete = ConcreteTest::try_new(testbuilder.env, testbuilder.test)
            .to_option()
            .unwrap();

        let empty_location = Location::from_raw(0, 0, 0);

        let relay1_set = RelayStatement {
            time: 0,
            id: "1".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let relay1_unset = RelayStatement {
            time: 0,
            id: "1".to_string(),
            op: RelayOp::Unset,
            metadata: empty_location,
        };

        let mut timeline_relay = RelaysTimeline::new();
        timeline_relay.add_relay_statement(&relay1_set);
        timeline_relay.add_relay_statement(&relay1_unset);
        // Relays that have all set and unset don't return "passed" at the moment, they just don't fail
        assert_ne!(
            timeline_relay.validate(&concrete).get_status(),
            Status::Failed
        );
    }

    #[test]
    fn validate_failed_multiple_relays_active() {
        let mut testbuilder = TestBuilder::new();
        testbuilder.with_relay("relay1");
        let concrete = ConcreteTest::try_new(testbuilder.env, testbuilder.test)
            .to_option()
            .unwrap();

        let empty_location = Location::from_raw(0, 0, 0);

        let relay1_set = RelayStatement {
            time: 0,
            id: "1".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let relay1_unset = RelayStatement {
            time: 20,
            id: "1".to_string(),
            op: RelayOp::Unset,
            metadata: empty_location,
        };

        let relay2_set = RelayStatement {
            time: 2,
            id: "2".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let relay3_set = RelayStatement {
            time: 2,
            id: "3".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let mut timeline_relay = RelaysTimeline::new();
        timeline_relay.add_relay_statement(&relay1_set);
        timeline_relay.add_relay_statement(&relay1_unset);
        timeline_relay.add_relay_statement(&relay2_set);
        timeline_relay.add_relay_statement(&relay3_set);
        assert_eq!(
            timeline_relay.validate(&concrete).get_status(),
            Status::Failed
        );
    }

    #[test]
    fn validate_failed_first_relay_active() {
        let mut testbuilder = TestBuilder::new();
        testbuilder.with_relay("relay1");
        let concrete = ConcreteTest::try_new(testbuilder.env, testbuilder.test)
            .to_option()
            .unwrap();

        let empty_location = Location::from_raw(0, 0, 0);

        let relay1_set = RelayStatement {
            time: 0,
            id: "1".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let relay2_set = RelayStatement {
            time: 2,
            id: "2".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let relay2_unset = RelayStatement {
            time: 5,
            id: "2".to_string(),
            op: RelayOp::Unset,
            metadata: empty_location,
        };

        let relay3_set = RelayStatement {
            time: 2,
            id: "3".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let relay3_unset = RelayStatement {
            time: 5,
            id: "3".to_string(),
            op: RelayOp::Unset,
            metadata: empty_location,
        };

        let mut timeline_relay = RelaysTimeline::new();
        timeline_relay.add_relay_statement(&relay1_set);
        timeline_relay.add_relay_statement(&relay2_set);
        timeline_relay.add_relay_statement(&relay2_unset);
        timeline_relay.add_relay_statement(&relay3_set);
        timeline_relay.add_relay_statement(&relay3_unset);
        assert_eq!(
            timeline_relay.validate(&concrete).get_status(),
            Status::Failed
        );
    }

    #[test]
    fn validate_all_relays_set_unset() {
        let mut testbuilder = TestBuilder::new();
        testbuilder.with_relay("relay1");
        let concrete = ConcreteTest::try_new(testbuilder.env, testbuilder.test)
            .to_option()
            .unwrap();

        let empty_location = Location::from_raw(0, 0, 0);

        let relay1_set = RelayStatement {
            time: 0,
            id: "1".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let relay1_unset = RelayStatement {
            time: 0,
            id: "1".to_string(),
            op: RelayOp::Unset,
            metadata: empty_location,
        };

        let relay2_set = RelayStatement {
            time: 2,
            id: "2".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let relay2_unset = RelayStatement {
            time: 5,
            id: "2".to_string(),
            op: RelayOp::Unset,
            metadata: empty_location,
        };

        let relay3_set = RelayStatement {
            time: 2,
            id: "3".to_string(),
            op: RelayOp::Set,
            metadata: empty_location,
        };

        let relay3_unset = RelayStatement {
            time: 5,
            id: "3".to_string(),
            op: RelayOp::Unset,
            metadata: empty_location,
        };

        let mut timeline_relay = RelaysTimeline::new();
        timeline_relay.add_relay_statement(&relay1_set);
        timeline_relay.add_relay_statement(&relay1_unset);
        timeline_relay.add_relay_statement(&relay2_set);
        timeline_relay.add_relay_statement(&relay2_unset);
        timeline_relay.add_relay_statement(&relay3_set);
        timeline_relay.add_relay_statement(&relay3_unset);
        assert_ne!(
            timeline_relay.validate(&concrete).get_status(),
            Status::Failed
        );
    }
}