Struct Module

pub struct Module(/* private fields */);

A compiled PolkaVM program module.

Implementations

impl Module

pub fn get_debug_string(&self, offset: u32) -> Result<&str, ProgramParseError>

pub fn new( engine: &Engine, config: &ModuleConfig, bytes: ArcBytes, ) -> Result<Self, Error>

Creates a new module by deserializing the program from the given bytes.

pub fn from_blob( engine: &Engine, config: &ModuleConfig, blob: ProgramBlob, ) -> Result<Self, Error>

Creates a new module from a deserialized program blob.

pub fn is_64_bit(&self) -> bool

Returns whether the module is 64-bit.

pub fn from_cache( engine: &Engine, config: &ModuleConfig, blob: &ProgramBlob, ) -> Option<Self>

Fetches a cached module for the given blob.

pub fn instantiate(&self) -> Result<RawInstance, Error>

Instantiates a new module.

pub fn memory_map(&self) -> &MemoryMap

The program’s memory map.

pub fn default_sp(&self) -> RegValue

The default stack pointer for the module.

pub fn exports(&self) -> impl Iterator<Item = ProgramExport<&[u8]>> + Clone

Returns the module’s exports.

pub fn imports(&self) -> Imports<'_>

Returns the module’s imports.

pub fn machine_code(&self) -> Option<&[u8]>

The raw machine code of the compiled module.

Will return None when running under an interpreter. Mostly only useful for debugging.

pub fn machine_code_origin(&self) -> Option<u64>

The address at which the raw machine code will be loaded.

Will return None unless compiled for the Linux sandbox. Mostly only useful for debugging.

pub fn program_counter_to_machine_code_offset( &self, ) -> Option<&[(ProgramCounter, u32)]>

A slice which contains pairs of PolkaVM bytecode offsets and native machine code offsets.

This makes it possible to map a position within the guest program into the exact range of native machine code instructions.

The returned slice has as many elements as there were instructions in the original guest program, plus one extra to make it possible to figure out the length of the machine code corresponding to the very last instruction.

This slice is guaranteed to be sorted, so you can binary search through it.

Will return None when running under an interpreter. Mostly only useful for debugging.

pub fn calculate_gas_cost_for(&self, code_offset: ProgramCounter) -> Option<Gas>

Calculates the gas cost for a given basic block starting at code_offset.

Will return None if the given code_offset is invalid. Mostly only useful for debugging.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for Module

fn drop(&mut self)

Executes the destructor for this type.