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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
use super::*;
use std::{
    sync::mpsc::{self, RecvTimeoutError, TryRecvError},
    thread,
    time::*,
    u32, u64,
};

const STACK_SIZE: usize = 8 * 1024 * 1024;
const BADDER_STACK_LEN: usize = 200;

#[derive(Clone, Debug)]
pub struct Phase {
    pub id: u64,
    pub time: Instant,
    pub src: SourceRef,
    /// most recent function call ref relavant to this Ast, empty => top level code
    pub called_from: Vec<SourceRef>,
    kind: PhaseKind,
    unpaused: bool,
    pub stack: Arc<[FxIndexMap<Token, FrameData>]>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum PhaseKind {
    FunctionCall,
    Assignment,
    Other,
}

impl PhaseKind {
    fn from(ast: &Ast) -> PhaseKind {
        match *ast {
            Ast::Call(..) => PhaseKind::FunctionCall,
            Ast::Assign(..) | Ast::AssignFun(..) | Ast::AssignSeq(..) => PhaseKind::Assignment,

            _ => PhaseKind::Other,
        }
    }
}

#[derive(Debug, Clone)]
enum OverseerUpdate {
    Phase(Phase),
    FinishedFunCall(Token),
}

struct ControllerOverseer {
    next_id: u64,
    pause_time: single_value_channel::Receiver<Duration>,
    to_controller: mpsc::Sender<OverseerUpdate>,
    from_controller: mpsc::Receiver<Result<u64, ()>>,
    external_function_ids: Vec<Token>,
    external_function_call: mpsc::Sender<ExternalCall>,
    external_function_answer: mpsc::Receiver<Result<(Int, IntFlag), String>>,
    last_stack_copy: Option<Arc<[FxIndexMap<Token, FrameData>]>>,
}

fn interested_in(ast: &Ast) -> bool {
    use crate::Ast::*;
    !matches!(
        *ast,
        LinePair(..)
            | Line(..)
            | Empty(..)
            | Num(..)
            | ReferSeq(..)
            | ReferSeqIndex(..)
            | Refer(..)
    )
}

impl ControllerOverseer {
    fn replace_last_stack(
        &mut self,
        stack: &[FxIndexMap<Token, FrameData>],
    ) -> Arc<[FxIndexMap<Token, FrameData>]> {
        let last: Arc<[_]> = stack.into();
        self.last_stack_copy = Some(Arc::clone(&last));
        last
    }
}

impl Overseer for ControllerOverseer {
    fn oversee(
        &mut self,
        stack: &[FxIndexMap<Token, FrameData>], // Cow?
        ast: &Ast,
        _current_scope: usize,
        _stack_key: StackKey,
    ) -> Result<(), ()> {
        if !interested_in(ast) {
            return Ok(());
        }

        let id = self.next_id;
        let send_time = Instant::now();
        self.next_id = id.overflowing_add(1).0;

        let stack = {
            // kerfuffle to avoid cloning the stack when it hasn't changed
            if let Some(last) = self.last_stack_copy.take() {
                if &*last == stack {
                    self.last_stack_copy = Some(Arc::clone(&last));
                    last
                } else {
                    self.replace_last_stack(stack)
                }
            } else {
                self.replace_last_stack(stack)
            }
        };

        trace!("ControllerOverseer sending: {:?} {:?}", ast.src(), ast);
        self.to_controller
            .send(OverseerUpdate::Phase(Phase {
                id,
                src: ast.src(),
                called_from: Vec::new(), // unknown
                kind: PhaseKind::from(ast),
                unpaused: false,
                time: send_time,
                stack,
            }))
            .expect("send");

        let mut recv = self.from_controller.try_recv();
        while recv != Err(TryRecvError::Empty) {
            match recv {
                Ok(Ok(i)) => {
                    if i == id {
                        return Ok(());
                    }
                }
                Ok(Err(_)) | Err(TryRecvError::Disconnected) => {
                    debug!("ControllerOverseer cancelling: {:?} {:?}", ast.src(), ast);
                    return Err(());
                }
                _ => (),
            }
            recv = self.from_controller.try_recv();
        }

        let pause_time = *self.pause_time.latest();
        if send_time.elapsed() >= pause_time {
            Ok(())
        } else {
            // block until result received
            debug!("ControllerOverseer waiting: {:?} {:?}", ast.src(), ast);

            let mut elapsed = send_time.elapsed();
            while elapsed < pause_time {
                match self.from_controller.recv_timeout(pause_time - elapsed) {
                    Ok(Ok(i)) => {
                        if i == id {
                            return Ok(());
                        }
                    }
                    Ok(Err(_)) | Err(RecvTimeoutError::Disconnected) => {
                        debug!("ControllerOverseer cancelling: {:?} {:?}", ast.src(), ast);
                        return Err(());
                    }
                    _ => (),
                };

                elapsed = send_time.elapsed();
            }
            Ok(())
        }
    }

    fn oversee_after(&mut self, _stack: &[FxIndexMap<Token, FrameData>], ast: &Ast) {
        if let Ast::Call(ref id, ..) = *ast {
            let _ = self
                .to_controller
                .send(OverseerUpdate::FinishedFunCall(id.clone()));
        }
    }

    fn external_function_signatures(&self) -> &[Token] {
        &self.external_function_ids
    }

    fn call_external_function(
        &mut self,
        id: Token,
        args: Vec<(Int, IntFlag)>,
    ) -> Result<(Int, IntFlag), String> {
        debug!(
            "ControllerOverseer awaiting answer: {:?}, args {:?}",
            id, args
        );
        self.external_function_call
            .send(ExternalCall { id, args })
            .expect("send");

        // block until answer received
        match self.external_function_answer.recv() {
            Ok(result) => result,
            Err(err) => {
                debug!("ControllerOverseer cancelling: {:?}", err);
                Err("cancelled".into())
            }
        }
    }
}

#[derive(Debug)]
pub struct Controller {
    pause_time: Duration,
    current_phase: Option<Phase>,
    fun_call_history: Vec<SourceRef>,
    result: Option<Res<Int>>,
    current_external_call: Option<ExternalCall>,
    external_function_ids: Vec<Token>,
    run_stats: RunStats,

    /// #cancel() has been called this run
    cancelled: bool,

    from_overseer: mpsc::Receiver<OverseerUpdate>,
    execution_result: mpsc::Receiver<Res<Int>>,
    to_overseer: mpsc::Sender<Result<u64, ()>>,
    overseer_pause: single_value_channel::Updater<Duration>,
    external_function_call: mpsc::Receiver<ExternalCall>,
    external_function_answer: mpsc::Sender<Result<(Int, IntFlag), String>>,
}

impl Controller {
    pub fn new(pause: Duration) -> Controller {
        Controller {
            pause_time: pause,
            current_phase: None,
            fun_call_history: Vec::new(),
            result: None,
            current_external_call: None,
            external_function_ids: Vec::new(),
            run_stats: RunStats::default(),

            cancelled: false,
            from_overseer: mpsc::channel().1,
            execution_result: mpsc::channel().1,
            to_overseer: mpsc::channel().0,
            overseer_pause: single_value_channel::channel_starting_with(Duration::from_secs(0)).1,
            external_function_answer: mpsc::channel().0,
            external_function_call: mpsc::channel().1,
        }
    }

    pub fn new_no_pause() -> Controller {
        Controller::new(Duration::from_secs(0))
    }

    pub fn new_max_pause() -> Controller {
        // just a large amount of seconds, for some reason u64::MAX caused issues on windows
        Controller::new(Duration::from_secs(u64::from(u32::MAX)))
    }

    /// Modifies the pause time, the duration the interpreter will block for
    /// before non-trivial AST interpretation waiting for a #unpause() or #cancel() call
    /// after the duration execution will continue automatically
    pub fn set_pause_duration(&mut self, pause_time: Duration) {
        self.pause_time = pause_time;
        // ignore errors to allow setting pause_time before execution
        let _ = self.overseer_pause.update(self.pause_time);
    }

    pub fn pause_duration(&self) -> Duration {
        self.pause_time
    }

    /// Unblocks current waiting phase's execution, if it is blocked.
    /// Requires a recent (in terms of set pause_time) call to #refresh() to be valid
    pub fn unpause(&mut self) {
        if let Some(Phase {
            id,
            unpaused: false,
            ..
        }) = self.current_phase
        {
            // ignore errors as send can happen after execution finishes
            let _ = self.to_overseer.send(Ok(id));
            self.current_phase.as_mut().unwrap().unpaused = true;
        }
    }

    /// Requests any current executing interpreter be cancelled
    pub fn cancel(&mut self) {
        if !self.cancelled {
            self.cancelled = true;
            self.fun_call_history.clear();
            let _ = self.to_overseer.send(Err(()));
        }
    }

    /// Returns current execution phase, requires a recent (in terms of set pause_time)
    /// call to #refresh() to be valid
    pub fn current_phase(&self) -> Option<Phase> {
        if self.cancelled {
            None
        } else {
            self.current_phase.clone()
        }
    }

    pub fn run_stats(&self) -> &RunStats {
        &self.run_stats
    }

    /// Returns result of execution
    pub fn result(&self) -> Option<&Res<Int>> {
        self.result.as_ref()
    }

    /// Returns current execution is paused, requires a recent (in terms of set pause_time)
    /// call to #refresh() to be valid
    pub fn paused(&self) -> bool {
        if self.cancelled {
            return false;
        }

        if let Some(Phase { time, unpaused, .. }) = self.current_phase {
            !unpaused && time.elapsed() < self.pause_time
        } else {
            false
        }
    }

    /// Communicate with the current execution
    /// populates #result & #current_phase if available
    /// Returns if a change has taken place
    pub fn refresh(&mut self) -> bool {
        if self.result.is_some() {
            return false;
        }

        if let Ok(result) = self.execution_result.try_recv() {
            self.result = Some(result);
            self.current_phase = None;
            return true;
        }

        let mut change = self.refresh_overseer_updates();

        if let Ok(call) = self.external_function_call.try_recv() {
            // refresh overseer updates again in case the external call
            // occurred just after the last `refresh_overseer_updates` call
            // call before setting `current_external_call` as it has an assert
            self.refresh_overseer_updates();

            self.current_external_call = Some(call);
            change = true;
        }

        change
    }

    /// Returns if a change occurred
    #[inline]
    fn refresh_overseer_updates(&mut self) -> bool {
        let mut change = false;
        while let Ok(update) = self.from_overseer.try_recv() {
            debug_assert!(
                self.current_external_call.is_none(),
                "Update received during external call: {:?}\nupdate: {:?}",
                self.current_external_call,
                update,
            );

            match update {
                OverseerUpdate::Phase(mut phase) => {
                    phase.called_from = self.current_call_info();
                    if phase.kind == PhaseKind::FunctionCall {
                        self.fun_call_history.push(phase.src)
                    }
                    if !self.cancelled {
                        self.run_stats.consider(&phase);
                    }
                    self.current_phase = Some(phase);
                }
                OverseerUpdate::FinishedFunCall(_) => {
                    self.fun_call_history.pop();
                }
            };
            change = true;
        }
        change
    }

    fn current_call_info(&self) -> Vec<SourceRef> {
        if self.cancelled {
            vec![]
        } else {
            self.fun_call_history.iter().rev().cloned().collect()
        }
    }

    /// Adds an external function signature
    /// must be a valid badder signature to work
    /// ie `some_ext_function(svv)` for a 3 arg function taking a sequence & 2 variable arguments
    pub fn add_external_function(&mut self, id: &str) {
        self.external_function_ids.push(Token::Id(id.into()));
    }

    pub fn clear_external_functions(&mut self) {
        self.external_function_ids.clear();
    }

    pub fn current_external_call(&self) -> Option<ExternalCall> {
        if self.cancelled {
            None
        } else {
            self.current_external_call.clone()
        }
    }

    pub fn answer_external_call(&mut self, result: Result<(Int, IntFlag), String>) {
        self.current_external_call = None;
        if let Err(err) = self.external_function_answer.send(result) {
            warn!(
                "Comms failure with badder runtime when answering external call: {}",
                err
            );
        }
    }

    /// Start executing code with a new thread.
    /// Effectively resets this instances state.
    pub fn execute(&mut self, code: Ast) {
        let (to_controller, from_overseer) = mpsc::channel();
        let (to_overseer, from_controller) = mpsc::channel();
        let (final_result, execution_result) = mpsc::channel();
        let (get_pause, set_pause) = single_value_channel::channel_starting_with(self.pause_time);
        let (send_fun_call, recv_fun_call) = mpsc::channel();
        let (send_fun_answer, recv_fun_answer) = mpsc::channel();

        self.to_overseer = to_overseer;
        self.from_overseer = from_overseer;
        self.execution_result = execution_result;
        self.overseer_pause = set_pause;
        self.external_function_call = recv_fun_call;
        self.external_function_answer = send_fun_answer;
        self.result = None;
        self.current_phase = None;
        self.fun_call_history.clear();
        self.current_external_call = None;
        self.cancelled = false;
        self.run_stats = RunStats::default();

        let external_function_ids = self.external_function_ids.clone();

        thread::Builder::new()
            .name("badder-exe".into())
            .stack_size(STACK_SIZE)
            .spawn(move || {
                let overseer = ControllerOverseer {
                    next_id: 0,
                    pause_time: get_pause,
                    to_controller,
                    from_controller,
                    external_function_ids,
                    external_function_call: send_fun_call,
                    external_function_answer: recv_fun_answer,
                    last_stack_copy: None,
                };
                let _ =
                    final_result.send(Interpreter::new(BADDER_STACK_LEN, overseer).evaluate(&code));
            })
            .unwrap();
    }
}

#[derive(Debug, PartialEq, Clone, Eq, Hash)]
pub struct ExternalCall {
    pub id: Token,
    pub args: Vec<(Int, IntFlag)>,
}

impl ExternalCall {
    pub fn id_str(&self) -> &str {
        match self.id {
            Token::Id(ref s) => s,
            _ => unreachable!(),
        }
    }
}

#[derive(Debug, Clone, Default)]
pub struct RunStats {
    /// source_ref -> evaluation count
    pub eval_counts: IndexMap<SourceRef, usize>,
    last_phase: Option<u64>,
}

impl RunStats {
    fn consider(&mut self, phase: &Phase) {
        if phase.kind != PhaseKind::Assignment {
            if let Some(id) = self.last_phase {
                if id != phase.id {
                    *(self.eval_counts.entry(phase.src).or_insert(0)) += 1;
                }
            } else {
                *(self.eval_counts.entry(phase.src).or_insert(0)) += 1;
            }

            self.last_phase = Some(phase.id);
        }
    }
}