Struct Machine

pub struct Machine {
    pub prog: Program,
    pub closures: ClosureStorage,
    pub ext_fun_table: Vec<(Symbol, ExtFunType)>,
    pub ext_cls_table: Vec<(Symbol, ExtClsType)>,
    /* private fields */
}

The virtual machine that executes mimium bytecode programs.

A Machine holds the compiled Program, value stack and all live closures. External functions and closures installed from plugins are also managed here.

Fields

prog: Program

closures: ClosureStorage

ext_fun_table: Vec<(Symbol, ExtFunType)>

ext_cls_table: Vec<(Symbol, ExtClsType)>

Implementations

impl Machine

pub fn new( prog: Program, extfns: impl Iterator<Item = ExtFnInfo>, extcls: impl Iterator<Item = ExtClsInfo>, ) -> Self

Create a new VM from a compiled Program and external functions.

pub fn clear_stack(&mut self)

pub fn get_stack(&self, offset: i64) -> RawVal

pub fn get_stack_range( &self, offset: i64, word_size: TypeSize, ) -> (Range<usize>, &[RawVal])

pub fn get_stack_range_mut( &mut self, offset: i64, word_size: TypeSize, ) -> (Range<usize>, &mut [RawVal])

pub fn set_stack(&mut self, offset: i64, v: RawVal)

pub fn set_stack_range(&mut self, offset: i64, vs: &[RawVal])

pub fn get_top_n(&self, n: usize) -> &[RawVal]

pub fn get_open_upvalue( &self, upper_base: usize, ov: OpenUpValue, ) -> (Range<usize>, &[RawVal])

pub fn get_closure(&self, idx: ClosureIdx) -> &Closure

pub fn get_as<T>(v: RawVal) -> T

pub fn get_as_array<T>(v: &[RawVal]) -> &[T]

pub fn to_value<T>(v: T) -> RawVal

pub fn wrap_extern_cls(&mut self, extcls: ExtClsInfo) -> ClosureIdx

This API is used for defining higher-order external function that returns some external rust closure. Because the native closure cannot be called with CallCls directly, the vm appends an additional function the program, that wraps external closure call with an internal closure.

pub fn execute( &mut self, func_i: usize, cls_i: Option<ClosureIdx>, ) -> ReturnCode

Execute a function within the VM.

func_i is an index into the program’s function table and cls_i is an optional closure that provides the environment for the call. The returned ReturnCode is the number of values pushed on the stack as a result of the call.

pub fn install_extern_fn(&mut self, name: Symbol, f: ExtFunType) -> usize

pub fn install_extern_cls(&mut self, name: Symbol, f: ExtClsType) -> usize

pub fn execute_idx(&mut self, idx: usize) -> ReturnCode

pub fn execute_entry(&mut self, entry: &Symbol) -> ReturnCode

pub fn execute_main(&mut self) -> ReturnCode