Struct wasmtime_jit::CompiledModule

pub struct CompiledModule { /* private fields */ }

A compiled wasm module, ready to be instantiated.

Implementations

impl CompiledModule

pub fn from_artifacts( code_memory: Arc<CodeMemory>, info: CompiledModuleInfo, profiler: &dyn ProfilingAgent, id_allocator: &CompiledModuleIdAllocator ) -> Result<Self>

Creates CompiledModule directly from a precompiled artifact.

The code_memory argument is expected to be the result of a previous call to ObjectBuilder::finish above. This is an ELF image, at this time, which contains all necessary information to create a CompiledModule from a compilation.

This method also takes info, an optionally-provided deserialization of the artifacts’ compilation metadata section. If this information is not provided then the information will be deserialized from the image of the compilation artifacts. Otherwise it will be assumed to be what would otherwise happen if the section were to be deserialized.

The profiler argument here is used to inform JIT profiling runtimes about new code that is loaded.

pub fn unique_id(&self) -> CompiledModuleId

Get this module’s unique ID. It is unique with respect to a single allocator (which is ordinarily held on a Wasm engine).

pub fn mmap(&self) -> &MmapVec

Returns the underlying memory which contains the compiled module’s image.

pub fn code_memory(&self) -> &Arc<CodeMemory>

Returns the underlying owned mmap of this compiled image.

pub fn text(&self) -> &[u8]

Returns the text section of the ELF image for this compiled module.

This memory should have the read/execute permissions.

pub fn module(&self) -> &Arc<Module>

Return a reference-counting pointer to a module.

pub fn func_name(&self, idx: FuncIndex) -> Option<&str>

Looks up the name section name for the function index idx, if one was specified in the original wasm module.

pub fn module_mut(&mut self) -> Option<&mut Module>

Return a reference to a mutable module (if possible).

pub fn finished_functions( &self ) -> impl ExactSizeIterator<Item = (DefinedFuncIndex, &[u8])> + '_

Returns an iterator over all functions defined within this module with their index and their body in memory.

pub fn finished_function(&self, index: DefinedFuncIndex) -> &[u8]

Returns the body of the function that index points to.

pub fn array_to_wasm_trampoline(&self, index: DefinedFuncIndex) -> Option<&[u8]>

Get the array-to-Wasm trampoline for the function index points to.

If the function index points to does not escape, then None is returned.

These trampolines are used for array callers (e.g. Func::new) calling Wasm callees.

pub fn native_to_wasm_trampoline( &self, index: DefinedFuncIndex ) -> Option<&[u8]>

Get the native-to-Wasm trampoline for the function index points to.

If the function index points to does not escape, then None is returned.

These trampolines are used for native callers (e.g. Func::wrap) calling Wasm callees.

pub fn wasm_to_native_trampoline(&self, signature: SignatureIndex) -> &[u8]

Get the Wasm-to-native trampoline for the given signature.

These trampolines are used for filling in VMFuncRef::wasm_call for Func::wrap-style host funcrefs that don’t have access to a compiler when created.

pub fn stack_maps( &self ) -> impl Iterator<Item = (&[u8], &[StackMapInformation])>

Returns the stack map information for all functions defined in this module.

The iterator returned iterates over the span of the compiled function in memory with the stack maps associated with those bytes.

pub fn func_by_text_offset( &self, text_offset: usize ) -> Option<(DefinedFuncIndex, u32)>

Lookups a defined function by a program counter value.

Returns the defined function index and the relative address of text_offset within the function itself.

pub fn func_loc(&self, index: DefinedFuncIndex) -> &FunctionLoc

Gets the function location information for a given function index.

pub fn wasm_func_info(&self, index: DefinedFuncIndex) -> &WasmFunctionInfo

Gets the function information for a given function index.

pub fn has_unparsed_debuginfo(&self) -> bool

Returns whether the original wasm module had unparsed debug information based on the tunables configuration.

pub fn has_address_map(&self) -> bool

Indicates whether this module came with n address map such that lookups via wasmtime_environ::lookup_file_pos will succeed.

If this function returns false then lookup_file_pos will always return None.

pub fn image_range(&self) -> Range<usize>

Returns the bounds, in host memory, of where this module’s compiled image resides.