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
use std::fmt;
use std::sync::MutexGuard;
use std::ops::{Deref, DerefMut, Index, IndexMut, Range, RangeTo, RangeFrom, RangeFull};

use base::symbol::Symbol;

use Variants;
use gc::GcPtr;
use value::{ClosureData, Value, DataStruct, ExternFunction};
use types::VMIndex;

#[derive(Copy, Clone, Debug, PartialEq)]
pub enum State {
    Unknown,
    /// Locked frame which can only be unlocked by the caller which introduced the lock
    Lock,
    /// Extra frame introduced to store a call with excess arguments
    Excess,
    Closure(GcPtr<ClosureData>),
    Extern(GcPtr<ExternFunction>),
}

#[derive(Copy, Clone, Debug, PartialEq)]
pub struct Frame {
    pub offset: VMIndex,
    pub instruction_index: usize,
    pub state: State,
    pub excess: bool,
}

#[derive(Debug)]
pub struct Lock(VMIndex);

#[derive(Debug)]
pub struct Stack {
    values: Vec<Value>,
    frames: Vec<Frame>,
}

impl Stack {
    pub fn new() -> Stack {
        Stack {
            values: Vec::new(),
            frames: Vec::new(),
        }
    }

    pub fn pop(&mut self) -> Value {
        if let Some(&frame) = self.frames.last() {
            assert!(self.len() > frame.offset,
                    "Attempted to pop value which did not belong to the current frame");
        }
        self.values
            .pop()
            .expect("pop on empty stack")
    }

    pub fn push(&mut self, v: Value) {
        self.values.push(v)
    }

    pub fn remove_range(&mut self, from: VMIndex, to: VMIndex) {
        let from = from as usize;
        let to = to as usize;
        let len = to - from;
        let mid = from + ::std::cmp::min(self.values.len() - to, len);
        for i in from..mid {
            self.values[i] = self.values[i + len];
        }
        for i in mid..(self.values.len() - len) {
            self.values[i] = self.values[i + len];
        }
        unsafe {
            let current_len = self.values.len();
            self.values.set_len(current_len - len as usize);
        }
    }

    pub fn len(&self) -> VMIndex {
        self.values.len() as VMIndex
    }

    pub fn get_values(&self) -> &[Value] {
        &self.values
    }

    pub fn get_frames(&self) -> &[Frame] {
        &self.frames
    }

    /// Release a lock on the stack.
    ///
    /// Panics if the lock is not the top-most lock
    pub fn release_lock(&mut self, lock: Lock) {
        assert!(self.frames.pop().map(|frame| frame.offset) == Some(lock.0));
    }
}

impl Index<VMIndex> for Stack {
    type Output = Value;
    fn index(&self, index: VMIndex) -> &Value {
        &self.values[index as usize]
    }
}

impl IndexMut<VMIndex> for Stack {
    fn index_mut(&mut self, index: VMIndex) -> &mut Value {
        &mut self.values[index as usize]
    }
}

impl Index<RangeFrom<VMIndex>> for Stack {
    type Output = [Value];
    fn index(&self, range: RangeFrom<VMIndex>) -> &[Value] {
        &self.values[range.start as usize..]
    }
}

impl Index<RangeTo<VMIndex>> for Stack {
    type Output = [Value];
    fn index(&self, range: RangeTo<VMIndex>) -> &[Value] {
        &self.values[..range.end as usize]
    }
}

pub struct StackFrame<'b> {
    pub stack: MutexGuard<'b, Stack>,
    pub frame: Frame,
}

impl<'b> Drop for StackFrame<'b> {
    fn drop(&mut self) {
        // Move the cached frame back to storage
        *self.stack.frames.last_mut().unwrap() = self.frame;
    }
}

impl<'b> fmt::Debug for StackFrame<'b> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("StackFrame")
         .field("stack", &*self.stack)
         .field("frame", &self.frame)
         .finish()
    }
}

impl<'a: 'b, 'b> StackFrame<'b> {
    pub fn len(&self) -> VMIndex {
        self.stack.len() - self.frame.offset
    }

    pub fn push(&mut self, v: Value) {
        self.stack.values.push(v);
    }

    pub fn top(&mut self) -> Value {
        *self.stack.values.last().expect("StackFrame: top")
    }

    pub fn pop(&mut self) -> Value {
        self.stack.pop()
    }

    pub fn get_variants(&self, index: VMIndex) -> Option<Variants> {
        if index < self.len() {
            Some(Variants(&self[index]))
        } else {
            None
        }
    }

    pub fn insert_slice(&mut self, index: VMIndex, values: &[Value]) {
        self.stack.values.reserve(values.len());
        unsafe {
            let old_len = self.len();
            for i in (index..old_len).rev() {
                *self.get_unchecked_mut(i as usize + values.len()) = self[i];
            }
            for (i, val) in (index..).zip(values) {
                *self.get_unchecked_mut(i as usize) = *val;
            }
            let new_len = self.stack.values.len() + values.len();
            self.stack.values.set_len(new_len);
        }
    }

    pub fn remove_range(&mut self, from: VMIndex, to: VMIndex) {
        self.stack.remove_range(self.frame.offset + from, self.frame.offset + to);
    }

    pub fn get_rooted_value(&self, index: VMIndex) -> Value {
        self[index]
    }

    pub fn get_upvar(&self, index: VMIndex) -> Value {
        let upvars = match self.frame.state {
            State::Closure(ref c) => c,
            _ => panic!("Attempted to access upvar in non closure function"),
        };
        upvars.upvars[index as usize]
    }

    pub fn excess_args(&self) -> Option<GcPtr<DataStruct>> {
        let i = self.stack.values.len() - self.len() as usize - 2;
        match self.stack.values[i] {
            Value::Data(data) => Some(data),
            _ => None,
        }
    }

    pub fn enter_scope(mut self, args: VMIndex, state: State) -> StackFrame<'b> {
        if let Some(frame) = self.stack.frames.last_mut() {
            *frame = self.frame;
        }
        let frame = StackFrame::add_new_frame(&mut self.stack, args, state);
        self.frame = frame;
        self
    }

    pub fn exit_scope(mut self) -> Option<StackFrame<'b>> {
        let current_frame = self.stack.frames.pop().expect("Expected frame");
        assert!(current_frame.offset == self.frame.offset,
                "Attempted to exit a scope other than the top-most scope");
        let frame = self.stack
                        .frames
                        .last()
                        .cloned();
        frame.and_then(move |frame| {
            self.frame = frame;
            if frame.state == State::Lock {
                // Locks must be unlocked manually using release lock
                None
            } else {
                debug!("<---- Restore {} {:?}", self.stack.frames.len(), frame);
                Some(self)
            }
        })
    }

    pub fn frame(mut stack: MutexGuard<'b, Stack>, args: VMIndex, state: State) -> StackFrame<'b> {
        let frame = StackFrame::add_new_frame(&mut stack, args, state);
        StackFrame {
            stack: stack,
            frame: frame,
        }
    }

    pub fn current(stack: MutexGuard<Stack>) -> StackFrame {
        StackFrame {
            frame: stack.get_frames().last().expect("Frame").clone(),
            stack: stack,
        }
    }

    /// Lock the stack below the current offset
    pub fn into_lock(mut self) -> Lock {
        let offset = self.stack.len();
        self.frame = StackFrame::add_new_frame(&mut self.stack, 0, State::Lock);
        Lock(offset)
    }

    /// Creates a stackrace starting from `frame_level`
    pub fn stacktrace(&self, frame_level: usize) -> Stacktrace {
        let frames = self.stack.get_frames()[frame_level..].iter().filter_map(|frame| {
            match frame.state {
                State::Closure(ref closure) => Some(Some(closure.function.name.clone())),
                State::Extern(ref ext) => Some(Some(ext.id.clone())),
                State::Unknown => Some(None),
                State::Lock | State::Excess => None,
            }
        }).collect();
        Stacktrace { frames: frames }
    }

    fn add_new_frame(stack: &mut Stack, args: VMIndex, state: State) -> Frame {
        assert!(stack.len() >= args);
        let prev = stack.frames.last().cloned();
        let offset = stack.len() - args;
        let frame = Frame {
            offset: offset,
            instruction_index: 0,
            state: state,
            excess: false,
        };
        // Panic if the frame attempts to take ownership past the current frame
        if let Some(frame) = stack.frames.last() {
            assert!(frame.offset <= offset);
        }
        stack.frames.push(frame);
        debug!("----> Store {} {:?}\n||| {:?}",
               stack.frames.len(),
               frame,
               prev);
        frame
    }
}

impl<'b> Deref for StackFrame<'b> {
    type Target = [Value];
    fn deref(&self) -> &[Value] {
        &self.stack.values[self.frame.offset as usize..]
    }
}

impl<'b> DerefMut for StackFrame<'b> {
    fn deref_mut(&mut self) -> &mut [Value] {
        &mut self.stack.values[self.frame.offset as usize..]
    }
}

impl<'b> Index<VMIndex> for StackFrame<'b> {
    type Output = Value;
    fn index(&self, index: VMIndex) -> &Value {
        &self.stack.values[(self.frame.offset + index) as usize]
    }
}
impl<'b> IndexMut<VMIndex> for StackFrame<'b> {
    fn index_mut(&mut self, index: VMIndex) -> &mut Value {
        &mut self.stack.values[(self.frame.offset + index) as usize]
    }
}
impl<'b> Index<RangeFull> for StackFrame<'b> {
    type Output = [Value];
    fn index(&self, _: RangeFull) -> &[Value] {
        &self.stack.values[self.frame.offset as usize..]
    }
}
impl<'b> IndexMut<RangeFull> for StackFrame<'b> {
    fn index_mut(&mut self, _: RangeFull) -> &mut [Value] {
        &mut self.stack.values[self.frame.offset as usize..]
    }
}
impl<'b> Index<Range<VMIndex>> for StackFrame<'b> {
    type Output = [Value];
    fn index(&self, range: Range<VMIndex>) -> &[Value] {
        let offset = self.frame.offset;
        &self.stack.values[(range.start + offset) as usize..(range.end + offset) as usize]
    }
}
impl<'b> IndexMut<Range<VMIndex>> for StackFrame<'b> {
    fn index_mut(&mut self, range: Range<VMIndex>) -> &mut [Value] {
        let offset = self.frame.offset;
        &mut self.stack.values[(range.start + offset) as usize..(range.end + offset) as usize]
    }
}
impl<'b> Index<RangeTo<VMIndex>> for StackFrame<'b> {
    type Output = [Value];
    fn index(&self, range: RangeTo<VMIndex>) -> &[Value] {
        &self.stack.values[..(range.end + self.frame.offset) as usize]
    }
}
impl<'b> IndexMut<RangeTo<VMIndex>> for StackFrame<'b> {
    fn index_mut(&mut self, range: RangeTo<VMIndex>) -> &mut [Value] {
        &mut self.stack.values[..(range.end + self.frame.offset) as usize]
    }
}
impl<'b> Index<RangeFrom<VMIndex>> for StackFrame<'b> {
    type Output = [Value];
    fn index(&self, range: RangeFrom<VMIndex>) -> &[Value] {
        &self.stack.values[(range.start + self.frame.offset) as usize..]
    }
}
impl<'b> IndexMut<RangeFrom<VMIndex>> for StackFrame<'b> {
    fn index_mut(&mut self, range: RangeFrom<VMIndex>) -> &mut [Value] {
        &mut self.stack.values[(range.start + self.frame.offset) as usize..]
    }
}

#[derive(Debug)]
pub struct Stacktrace {
    frames: Vec<Option<Symbol>>,
}

impl fmt::Display for Stacktrace {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        try!(writeln!(f, "Stacktrace:\n"));
        for (i, frame) in self.frames.iter().enumerate() {
            let name = frame.as_ref().map_or("<unknown>", |frame| frame.as_ref());
            try!(writeln!(f, "{}: {}", i, name));
        }
        Ok(())
    }
}


#[cfg(test)]
mod tests {
    use std::sync::Mutex;

    use super::*;
    use value::Value::*;

    #[test]
    fn remove_range() {
        let _ = ::env_logger::init();

        let stack = Mutex::new(Stack::new());
        let stack = stack.lock().unwrap();
        let mut frame = StackFrame::frame(stack, 0, State::Unknown);
        frame.push(Int(0));
        frame.push(Int(1));
        let mut frame = frame.enter_scope(2, State::Unknown);
        frame.push(Int(2));
        frame.push(Int(3));
        frame = frame.enter_scope(1, State::Unknown);
        frame.push(Int(4));
        frame.push(Int(5));
        frame.push(Int(6));
        frame = frame.exit_scope().unwrap();
        frame.remove_range(2, 5);
        assert_eq!(frame.stack.values, vec![Int(0), Int(1), Int(5), Int(6)]);
        frame = frame.exit_scope().unwrap();
        frame.remove_range(1, 3);
        assert_eq!(frame.stack.values, vec![Int(0), Int(6)]);
    }

    #[test]
    #[should_panic]
    fn attempt_take_locked_range() {
        let _ = ::env_logger::init();

        let stack = Mutex::new(Stack::new());
        let mut frame = StackFrame::frame(stack.lock().unwrap(), 0, State::Unknown);
        frame.push(Int(0));
        frame.push(Int(1));
        let frame = frame.enter_scope(2, State::Unknown);
        let _lock = frame.into_lock();
        // Panic as it attempts to access past the lock
        StackFrame::frame(stack.lock().unwrap(), 1, State::Unknown);
    }

    #[test]
    fn lock_unlock() {
        let _ = ::env_logger::init();

        let stack = Mutex::new(Stack::new());
        let mut frame = StackFrame::frame(stack.lock().unwrap(), 0, State::Unknown);
        frame.push(Int(0));
        frame.push(Int(1));
        frame = frame.enter_scope(2, State::Unknown);
        let lock = frame.into_lock();
        frame = StackFrame::frame(stack.lock().unwrap(), 0, State::Unknown);
        frame.push(Int(2));
        frame.exit_scope();
        stack.lock().unwrap().release_lock(lock);
        frame = StackFrame::current(stack.lock().unwrap());
        assert_eq!(frame.pop(), Int(2));
    }
}