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
use alloc::vec::{Drain, Vec};
use crate::core::indices::{FuncIdx, LocalIdx};
use crate::core::reader::types::{FuncType, ValType};
use crate::execution::assert_validated::UnwrapValidatedExt;
use crate::execution::value::Value;
use crate::locals::Locals;
use crate::unreachable_validated;
/// The stack at runtime containing
/// 1. Values
/// 2. Labels
/// 3. Activations
///
/// See <https://webassembly.github.io/spec/core/exec/runtime.html#stack>
#[derive(Default)]
pub(crate) struct Stack {
/// WASM values on the stack, i.e. the actual data that instructions operate on
values: Vec<Value>,
/// Stack frames
///
/// Each time a function is called, a new frame is pushed, whenever a function returns, a frame is popped
frames: Vec<CallFrame>,
}
impl Stack {
pub fn new() -> Self {
Self::default()
}
pub fn drop_value(&mut self) {
// If there is at least one stack frame, we shall not pop values past the current
// stackframe. However, there is one legitimate reason to pop when there is **no** current
// stackframe: after the outermost function returns, to extract the final return values of
// this interpreter invocation.
debug_assert!(
if !self.frames.is_empty() {
self.values.len() > self.current_stackframe().value_stack_base_idx
} else {
true
},
"can not pop values past the current stackframe"
);
self.values.pop().unwrap_validated();
}
/// Pop a value of the given [ValType] from the value stack
pub fn pop_value(&mut self, ty: ValType) -> Value {
// If there is at least one stack frame, we shall not pop values past the current
// stackframe. However, there is one legitimate reason to pop when there is **no** current
// stackframe: after the outermost function returns, to extract the final return values of
// this interpreter invocation.
debug_assert!(
if !self.frames.is_empty() {
self.values.len() > self.current_stackframe().value_stack_base_idx
} else {
true
},
"can not pop values past the current stackframe"
);
let popped = self.values.pop().unwrap_validated();
if popped.to_ty() == ty {
popped
} else {
unreachable_validated!()
}
}
/// Copy a value of the given [ValType] from the value stack without removing it
pub fn peek_value(&self, ty: ValType) -> Value {
let value = self.values.last().unwrap_validated();
if value.to_ty() == ty {
*value
} else {
unreachable_validated!()
}
}
/// Returns a cloned copy of the top value on the stack, or `None` if the stack is empty
pub fn peek_unknown_value(&self) -> Option<Value> {
self.values.last().copied()
}
/// Push a value to the value stack
pub fn push_value(&mut self, value: Value) {
self.values.push(value);
}
/// Copy a local variable to the top of the value stack
pub fn get_local(&mut self, idx: LocalIdx) {
let local_value = self.frames.last().unwrap_validated().locals.get(idx);
self.values.push(*local_value);
}
/// Pop value from the top of the value stack, writing it to the given local
pub fn set_local(&mut self, idx: LocalIdx) {
debug_assert!(
self.values.len() > self.current_stackframe().value_stack_base_idx,
"can not pop values past the current stackframe"
);
let local_ty = self.current_stackframe().locals.get_ty(idx);
let stack_value = self.pop_value(local_ty);
trace!("Instruction: local.set [{stack_value:?}] -> []");
*self.current_stackframe_mut().locals.get_mut(idx) = stack_value;
}
/// Copy value from top of the value stack to the given local
pub fn tee_local(&mut self, idx: LocalIdx) {
let local_ty = self.current_stackframe().locals.get_ty(idx);
let stack_value = self.peek_value(local_ty);
*self.current_stackframe_mut().locals.get_mut(idx) = stack_value;
}
/// Get a shared reference to the current [`CallFrame`]
pub fn current_stackframe(&self) -> &CallFrame {
self.frames.last().unwrap_validated()
}
/// Get a mutable reference to the current [`CallFrame`]
pub fn current_stackframe_mut(&mut self) -> &mut CallFrame {
self.frames.last_mut().unwrap_validated()
}
/// Pop a [`CallFrame`] from the call stack, returning the return address
pub fn pop_stackframe(&mut self) -> usize {
let CallFrame {
return_addr,
value_stack_base_idx,
return_value_count,
..
} = self.frames.pop().unwrap_validated();
let truncation_top = self.values.len() - return_value_count;
let _ = self.values.drain(value_stack_base_idx..truncation_top);
debug_assert_eq!(
self.values.len(),
value_stack_base_idx + return_value_count,
"after a function call finished, the stack must have exactly as many values as it had before calling the function plus the number of function return values"
);
return_addr
}
/// Push a stackframe to the call stack
///
/// Takes the current [`Self::values`]'s length as [`CallFrame::value_stack_base_idx`].
pub fn push_stackframe(
&mut self,
func_idx: FuncIdx,
func_ty: &FuncType,
locals: Locals,
return_addr: usize,
) {
self.frames.push(CallFrame {
func_idx,
locals,
return_addr,
value_stack_base_idx: self.values.len(),
return_value_count: func_ty.returns.valtypes.len(),
})
}
/// Returns how many stackframes are on the stack, in total.
pub fn callframe_count(&self) -> usize {
self.frames.len()
}
/// Pop `n` elements from the value stack's tail as an iterator, with the first element being
/// closest to the **bottom** of the value stack
///
/// Note that this is providing the values in reverse order compared to popping `n` values
/// (which would yield the element closest to the **top** of the value stack first).
pub fn pop_tail_iter(&mut self, n: usize) -> Drain<Value> {
let start = self.values.len() - n;
self.values.drain(start..)
}
/// Clear all of the values pushed to the value stack by the current stack frame
pub fn clear_callframe_values(&mut self) {
self.values
.truncate(self.current_stackframe().value_stack_base_idx);
}
}
/// The [WASM spec](https://webassembly.github.io/spec/core/exec/runtime.html#stack) calls this `Activations`, however it refers to the call frames of functions.
pub(crate) struct CallFrame {
/// Index to the function of this [`CallFrame`]
pub func_idx: FuncIdx,
/// Local variables such as parameters for this [`CallFrame`]'s function
pub locals: Locals,
/// Value that the PC has to be set to when this function returns
pub return_addr: usize,
/// The index to the first value on [`Stack::values`] that belongs to this [`CallFrame`]
pub value_stack_base_idx: usize,
/// Number of return values to retain on [`Stack::values`] when unwinding/popping a [`CallFrame`]
pub return_value_count: usize,
}