Crate dusk_wasmtime_environ 

Standalone environment for WebAssembly using Cranelift. Provides functions to translate get_global, set_global, memory.size, memory.grow, call_indirect that hardcode in the translation the base addresses of regions of memory that will hold the globals, tables and linear memories.

Re-exports

pub use object;

Modules

__core

The Rust Core Library

obj

Utilities for working with object files that operate as Wasmtime’s serialization and intermediate format for compiled modules.

packed_option

Compact representation of Option<T> for types with a reserved value.

wasmparser

A simple event-driven library for parsing WebAssembly binary files (or streams).

Macros

entity_impl

Macro which provides the common implementation of a 32-bit entity reference.

foreach_builtin_function

Helper macro to iterate over all builtin functions and their signatures.

wasm_unsupported

Return an Err(WasmError::Unsupported(msg)) where msg the string built by calling format! on the arguments to this macro.

Structs

BoxedSlice

A slice mapping K -> V allocating dense entity references.

BuiltinFunctionIndex

An index type for builtin functions.

CompiledFunctionInfo

Secondary in-memory results of function compilation.

CompiledModuleInfo

Secondary in-memory results of module compilation.

DataIndex

Index type of a passive data segment inside the WebAssembly module.

DefinedFuncIndex

Index type of a defined function inside the WebAssembly module.

DefinedGlobalIndex

Index type of a defined global inside the WebAssembly module.

DefinedMemoryIndex

Index type of a defined memory inside the WebAssembly module.

DefinedTableIndex

Index type of a defined table inside the WebAssembly module.

ElemIndex

Index type of a passive element segment inside the WebAssembly module.

EntityList

A small list of entity references allocated from a pool.

EntitySet

A set of K for densely indexed entity references.

FilePos

A position within an original source file,

FuncIndex

Index type of a function (imported or defined) inside the WebAssembly module.

FuncRefIndex

Index into the funcref table within a VMContext for a function.

FunctionLoc

Description of where a function is located in the text section of a compiled image.

FunctionName

The name of a function stored in the ELF_NAME_DATA section.

FunctionType

Type information about functions in a wasm module.

Global

A WebAssembly global.

GlobalIndex

Index type of a global variable (imported or defined) inside the WebAssembly module.

HostPtr

Type representing the size of a pointer for the current compilation host

InstructionAddressMap

Single source location to generated address mapping.

Iter

Iterate over all keys in order.

IterMut

Iterate over all keys in order.

Keys

Iterate over all keys in order.

ListPool

A memory pool for storing lists of T.

Memory

WebAssembly linear memory.

MemoryIndex

Index type of a linear memory (imported or defined) inside the WebAssembly module.

MemoryInitializer

A WebAssembly linear memory initializer.

MemoryPlan

A WebAssembly linear memory description along with our chosen style for implementing it.

Metadata

Metadata associated with a compiled ELF artifact.

Module

A translated WebAssembly module, excluding the function bodies and memory initializers.

ModuleInternedTypeIndex

Index type of a deduplicated type (imported or defined) inside a WebAssembly module.

ModuleTypes

All types used in a core wasm module.

ModuleTypesBuilder

A builder for ModuleTypes.

OperatorCost

The fuel cost of each operator.

OwnedMemoryIndex

Index type of a defined memory inside the WebAssembly module.

PrimaryMap

A primary mapping K -> V allocating dense entity references.

ScopeVec

Small data structure to help extend the lifetime of a slice to a higher scope.

SecondaryMap

A mapping K -> V for densely indexed entity references.

SparseMap

A sparse mapping of entity references.

StackMap

A map for determining where live GC references live in a stack frame.

StackMapInformation

The offset within a function of a GC safepoint, and its associated stack map.

StaticMemoryInitializer

Similar to the above MemoryInitializer but only used when memory initializers are statically known to be valid.

StaticModuleIndex

Index into the global list of modules found within an entire component.

Table

WebAssembly table.

TableIndex

Index type of a table (imported or defined) inside the WebAssembly module.

TableInitialization

Table initialization data for all tables in the module.

TablePlan

A WebAssembly table description along with our chosen style for implementing it.

TableSegment

A WebAssembly table initializer segment.

Tag

WebAssembly event.

TagIndex

Index type of an event inside the WebAssembly module.

TrapInformation

Information about trap.

Tunables

Tunable parameters for WebAssembly compilation.

TypeIndex

Index type of a type (imported or defined) inside the WebAssembly module.

VMOffsets

This class computes offsets to fields within VMContext and other related structs that JIT code accesses directly.

VMOffsetsFields

Used to construct a VMOffsets

WasmFuncType

WebAssembly function type – equivalent of wasmparser’s FuncType.

WasmFunctionInfo

Information about a function, such as trap information, address map, and stack maps.

WasmRefType

WebAssembly reference type – equivalent of wasmparser’s RefType

WasmparserTypeConverter

Enums

EngineOrModuleTypeIndex

An interned type index, either at the module or engine level.

EntityIndex

An index of an entity.

EntityType

A type of an item in a wasm module where an item is typically something that can be exported.

FlagValue

Value of a configured setting for a Compiler

GlobalInit

Globals are initialized via the const operators or by referring to another import.

InitMemory

Argument to MemoryInitialization::init_memory indicating the current status of the instance.

Initializer

Initialization routines for creating an instance, encompassing imports, modules, instances, aliases, etc.

MemoryInitialization

The type of WebAssembly linear memory initialization to use for a module.

MemoryStyle

Implementation styles for WebAssembly linear memory.

ModuleType

Different types that can appear in a module.

ObjectKind

Types of objects that can be created by Compiler::object

TableElementExpression

Different kinds of expression that can initialize table elements.

TableInitialValue

Initial value for all elements in a table.

TableSegmentElements

Elements of a table segment, either a list of functions or list of arbitrary expressions.

TableStyle

Implementation styles for WebAssembly tables.

Trap

VMGcKind

The kind of an object in a GC heap.

WasmError

A WebAssembly translation error.

WasmHeapType

WebAssembly heap type – equivalent of wasmparser’s HeapType

WasmValType

WebAssembly value type – equivalent of wasmparser::ValType.

Constants

FUNCREF_INIT_BIT

An “initialized bit” in a funcref table.

FUNCREF_MASK

The mask we apply to all refs loaded from funcref tables.

I31_DISCRIMINANT

Discriminant to check whether GC reference is an i31ref or not.

NON_NULL_NON_I31_MASK

A mask that can be used to check for non-null and non-i31ref GC references with a single bitwise-and operation.

VERSION

Version number of this crate.

VMCONTEXT_MAGIC

Magic value for core Wasm VM contexts.

VM_ARRAY_CALL_HOST_FUNC_MAGIC

Equivalent of VMCONTEXT_MAGIC except for array-call host functions.

VM_NATIVE_CALL_HOST_FUNC_MAGIC

Equivalent of VMCONTEXT_MAGIC except for native-call host functions.

WASM32_MAX_PAGES

The number of pages (for 32-bit modules) we can have before we run out of byte index space.

WASM64_MAX_PAGES

The number of pages (for 64-bit modules) we can have before we run out of byte index space.

WASM_PAGE_SIZE

WebAssembly page sizes are defined to be 64KiB.

Traits

EntityRef

A type wrapping a small integer index should implement EntityRef so it can be used as the key of an SecondaryMap or SparseMap.

PtrSize

Trait used for the ptr representation of the field of VMOffsets

SparseMapValue

Trait for extracting keys from values stored in a SparseMap.

TypeConvert

Helpers used to convert a wasmparser type to a type in this crate.

TypeTrace

A trait for things that can trace all type-to-type edges, aka all type indices within this thing.

Unsigned

Helper trait used to add unsigned() methods to primitive signed integer types.

Functions

demangle_function_name

Demangles a single function name into a user-readable form.

demangle_function_name_or_index

Demangles a function name if it’s provided, or returns a unified representation based on the function index otherwise.

iterate_address_map

Iterate over the address map contained in the given address map section.

lookup_file_pos

Lookup an offset within an encoded address map section, returning the original FilePos that corresponds to the offset, if found.

lookup_trap_code

Decodes the provided trap information section and attempts to find the trap code corresponding to the offset specified.

Type Aliases

SparseSet

A sparse set of entity references.

WasmResult

A convenient alias for a Result that uses WasmError as the error type.