Struct wasmtime_environ::ModuleEnvironment

pub struct ModuleEnvironment<'data> { /* fields omitted */ }

Object containing the standalone environment information.

Methods

impl<'data> ModuleEnvironment<'data>

pub fn new(target_config: TargetFrontendConfig, tunables: Tunables) -> Self

Allocates the environment data structures.

pub fn translate(
    self,
    data: &'data [u8]
) -> WasmResult<ModuleTranslation<'data>>

Translate a wasm module using this environment. This consumes the ModuleEnvironment and produces a ModuleTranslation.

Trait Implementations

impl<'data> ModuleEnvironment<'data> for ModuleEnvironment<'data>

This trait is useful for translate_module because it tells how to translate environment-dependent wasm instructions. These functions should not be called by the user.

fn reserve_signatures(&mut self, num: u32) -> WasmResult<()>

Provides the number of signatures up front. By default this does nothing, but implementations can use this to preallocate memory if desired.

fn declare_signature(&mut self, sig: Signature) -> WasmResult<()>

Declares a function signature to the environment.

fn declare_func_import(
    &mut self,
    sig_index: SignatureIndex,
    module: &str,
    field: &str
) -> WasmResult<()>

Declares a function import to the environment.

fn declare_table_import(
    &mut self,
    table: Table,
    module: &str,
    field: &str
) -> WasmResult<()>

Declares a table import to the environment.

fn declare_memory_import(
    &mut self,
    memory: Memory,
    module: &str,
    field: &str
) -> WasmResult<()>

Declares a memory import to the environment.

fn declare_global_import(
    &mut self,
    global: Global,
    module: &str,
    field: &str
) -> WasmResult<()>

Declares a global import to the environment.

fn finish_imports(&mut self) -> WasmResult<()>

Notifies the implementation that all imports have been declared.

fn reserve_func_types(&mut self, num: u32) -> WasmResult<()>

Provides the number of defined functions up front. By default this does nothing, but implementations can use this to preallocate memory if desired.

fn declare_func_type(&mut self, sig_index: SignatureIndex) -> WasmResult<()>

Declares the type (signature) of a local function in the module.

fn reserve_tables(&mut self, num: u32) -> WasmResult<()>

Provides the number of defined tables up front. By default this does nothing, but implementations can use this to preallocate memory if desired.

fn declare_table(&mut self, table: Table) -> WasmResult<()>

Declares a table to the environment.

fn reserve_memories(&mut self, num: u32) -> WasmResult<()>

Provides the number of defined memories up front. By default this does nothing, but implementations can use this to preallocate memory if desired.

fn declare_memory(&mut self, memory: Memory) -> WasmResult<()>

Declares a memory to the environment

fn reserve_globals(&mut self, num: u32) -> WasmResult<()>

Provides the number of defined globals up front. By default this does nothing, but implementations can use this to preallocate memory if desired.

fn declare_global(&mut self, global: Global) -> WasmResult<()>

Declares a global to the environment.

fn reserve_exports(&mut self, num: u32) -> WasmResult<()>

Provides the number of exports up front. By default this does nothing, but implementations can use this to preallocate memory if desired.

fn declare_func_export(
    &mut self,
    func_index: FuncIndex,
    name: &str
) -> WasmResult<()>

Declares a function export to the environment.

fn declare_table_export(
    &mut self,
    table_index: TableIndex,
    name: &str
) -> WasmResult<()>

Declares a table export to the environment.

fn declare_memory_export(
    &mut self,
    memory_index: MemoryIndex,
    name: &str
) -> WasmResult<()>

Declares a memory export to the environment.

fn declare_global_export(
    &mut self,
    global_index: GlobalIndex,
    name: &str
) -> WasmResult<()>

Declares a global export to the environment.

fn declare_start_func(&mut self, func_index: FuncIndex) -> WasmResult<()>

Declares the optional start function.

fn reserve_table_elements(&mut self, num: u32) -> WasmResult<()>

Provides the number of element initializers up front. By default this does nothing, but implementations can use this to preallocate memory if desired.

fn declare_table_elements(
    &mut self,
    table_index: TableIndex,
    base: Option<GlobalIndex>,
    offset: usize,
    elements: Box<[FuncIndex]>
) -> WasmResult<()>

Fills a declared table with references to functions in the module.

fn declare_passive_element(
    &mut self,
    elem_index: ElemIndex,
    segments: Box<[FuncIndex]>
) -> WasmResult<()>

Declare a passive element segment.

fn define_function_body(
    &mut self,
    _module_translation: &ModuleTranslationState,
    body_bytes: &'data [u8],
    body_offset: usize
) -> WasmResult<()>

Provides the contents of a function body.

fn reserve_data_initializers(&mut self, num: u32) -> WasmResult<()>

Provides the number of data initializers up front. By default this does nothing, but implementations can use this to preallocate memory if desired.

fn declare_data_initialization(
    &mut self,
    memory_index: MemoryIndex,
    base: Option<GlobalIndex>,
    offset: usize,
    data: &'data [u8]
) -> WasmResult<()>

Fills a declared memory with bytes at module instantiation.

fn reserve_passive_data(&mut self, count: u32) -> WasmResult<()>

Provides the number of passive data segments up front.

fn declare_passive_data(
    &mut self,
    data_index: DataIndex,
    data: &'data [u8]
) -> WasmResult<()>

Declare a passive data segment.

fn declare_module_name(&mut self, name: &'data str) -> WasmResult<()>

Declares the name of a module to the environment.

fn declare_func_name(
    &mut self,
    func_index: FuncIndex,
    name: &'data str
) -> WasmResult<()>

Declares the name of a function to the environment.

fn reserve_imports(&mut self, _num: u32) -> Result<(), WasmError>

Provides the number of imports up front. By default this does nothing, but implementations can use this to preallocate memory if desired.

fn finish_exports(&mut self) -> Result<(), WasmError>

Notifies the implementation that all exports have been declared.

fn custom_section(
    &mut self,
    _name: &'data str,
    _data: &'data [u8]
) -> Result<(), WasmError>

Indicates that a custom section has been found in the wasm file

impl<'data> TargetEnvironment for ModuleEnvironment<'data>

fn target_config(&self) -> TargetFrontendConfig

Get the information needed to produce Cranelift IR for the given target.

fn pointer_type(&self) -> Type

Get the Cranelift integer type to use for native pointers.

fn pointer_bytes(&self) -> u8

Get the size of a native pointer, in bytes.

fn reference_type(&self) -> Type

Get the Cranelift reference type to use for native references.