Struct aluvm::vm::Vm

pub struct Vm<Isa = Instr<ReservedOp>> where
    Isa: InstructionSet,  { /* fields omitted */ }

Alu virtual machine providing single-core execution environment

Implementations

impl<Isa> Vm<Isa> where
    Isa: InstructionSet, 

pub fn libs_ref(&self) -> &BTreeMap<LibId, Lib>

Method borrowing Vm::libs field. Libraries known to the runtime, identified by their hashes

pub fn entrypoint_ref(&self) -> &LibSite

Method borrowing Vm::entrypoint field. Entrypoint for the main function

pub fn registers_ref(&self) -> &Box<CoreRegs>

Method borrowing Vm::registers field. A set of registers

pub fn phantom_ref(&self) -> &PhantomData<Isa>

Method borrowing Vm::phantom field.

impl<Isa> Vm<Isa> where
    Isa: InstructionSet, 

pub fn new() -> Vm<Isa>

Constructs new virtual machine with no code in it.

Calling Vm::main on it will result in machine termination with st0 set to false.

pub fn with(lib: Lib) -> Vm<Isa>

Constructs new virtual machine using the provided library.

pub fn add_lib(&mut self, lib: Lib) -> Result<bool, Error>

Adds Alu bytecode library to the virtual machine.

Errors

Checks requirement that the total number of libraries must not exceed LIBS_MAX_TOTAL and returns Error::TooManyLibs otherwise.

Checks that the ISA used by the VM supports ISA extensions specified by the library and returns Error::IsaNotSupported otherwise.

Returns

true if the library was already known and false otherwise.

pub fn set_entrypoint(&mut self, entrypoint: LibSite)

Sets new entry point value (used when calling Vm::main)

pub fn main(&mut self) -> bool

Executes the program starting from the provided entry point (set with Vm::set_entrypoint or initialized to 0 offset of the first used library if Vm::new, Vm::default or Vm::with were used).

Returns

Value of the st0 register at the end of the program execution.

pub fn call(&mut self, method: LibSite) -> bool

Executes the program starting from the provided entry point.

Returns

Value of the st0 register at the end of the program execution.

Trait Implementations

impl<Isa: Debug> Debug for Vm<Isa> where
    Isa: InstructionSet, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Isa: Default> Default for Vm<Isa> where
    Isa: InstructionSet, 

fn default() -> Vm<Isa>

Returns the “default value” for a type.