Struct Config 

pub struct Config { /* private fields */ }

Defines Config struct used to check/set the configuration options.

Config manages the configuration options, which are used to initiate Loader, Validator, Executor, and Compiler.

The configuration options are categorized into the following four groups:

• WebAssembly Proposals

  This group of options are used to turn on/off the WebAssembly proposals. They are effective to any WasmEdge context created with Config.

  • MultiMemories enables to use multiple memories within a single Wasm module.

    Also see Multiple Memories for Wasm

  • ImportExportMutGlobals supports mutable imported and exported globals.

    Also see Import/Export Mutable Globals Proposal.

  • NonTrapFloatToIntConversions supports the non-trapping float-to-int conversion.

    Also see Non-trapping Float-to-int Conversions Proposal.

  • SignExtensionOperators supports new integer instructions for sign-extending 8-bit, 16-bit, and 32-bit values.

    Also see Sign-extension Operators Proposal.

  • MultiValue supports functions and instructions with multiple return values, and blocks with inputs.

    Also see Multi-value Extension.

  • BulkMemoryOperations supports bulk memory operations.

    Also see Bulk Memory Operations Proposal.

  • ReferenceTypes supports reference types.

    Also see Reference Types Proposal.

  • SIMD supports 128-bit packed SIMD extension to WebAssembly.

    Also see SIMD Proposal.

  • RelaxSIMD supports the relaxed SIMD instructions.

    Also see Relaxed SIMD Proposal.

  • TailCall supports tail call optimization.

    Also see Tail Call Proposal.

  • ExtendedConst supports extended constant expressions.

    Also see Extended Const Expressions Proposal.

  • Annotations supports annotations in WASM text format.

    Also see Annotations Proposal.

  • Memory64 supports 64-bit memory indexes.

    Also see Memory64 Proposal.

  • Threads supports threading feature.

    Also see Threading Proposal.

  • ExceptionHandling supports exception handling.

    Also see Exception Handling Proposal.

  • FunctionReferences supports typed function references for WebAssembly.

    Also see Function References Proposal.

  • Component supports the WebAssembly component model. The support is experimental.

    Also see Component Model Proposal.

• Host Registrations

  • Wasi turns on the WASI support.

  • WasmEdgeProcess turns on the wasmedge_process support.

• Memory Management

  • maximum_memory_page limits the page size of Memory.

• Runtime

  • allow_afunix allows the use of AF_UNIX sockets in the WASI socket implementation.

• AOT Compilation

  The AOT compiler options configure the behavior about optimization level, output format, dump IR, and generic binary.

  • Compiler Optimization Levels

    • O0 performs as many optimizations as possible.

    • O1 optimizes quickly without destroying debuggability.

    • 02 optimizes for fast execution as much as possible without triggering significant incremental compile time or code size growth.

    • O3 optimizes for fast execution as much as possible.

    • Os optimizes for small code size as much as possible without triggering significant incremental compile time or execution time slowdowns.

    • Oz optimizes for small code size as much as possible.

  • Compiler Output Formats

    • Native specifies the output format is native dynamic library (*.wasm.so).

    • Wasm specifies the output format is WebAssembly with AOT compiled codes in custom section (*.wasm).

  • dump_ir determines if AOT compiler generates IR or not.

  • generic_binary determines if AOT compiler generates the generic binary or not.

  • interruptible determines if AOT compiler generates interruptible binary or not.

  The configuration options above are only effective to Compiler.

• Runtime Statistics

  • instr_counting determines if measuring the count of instructions when running a compiled or pure WASM.

  • cost_measuring determines if measuring the instruction costs when running a compiled or pure WASM.

  • time_measuring determines if measuring the running time when running a compiled or pure WASM.

• Execution Mode

  • run_mode selects the engine used to execute a WASM module: interpreter (default), JIT, or AOT.

    Since WasmEdge 0.17.0, only the AOT mode loads the AOT custom sections from a universal WASM file or dlopens a shared-library WASM artifact; in the other modes, the AOT data is ignored.

API users can first set the options of interest, such as those related to the WebAssembly proposals, host registrations, AOT compiler options, and etc., then apply the configuration to create other WasmEdge runtime structs.

Implementations

impl Config

pub fn create() -> WasmEdgeResult<Self>

Creates a new Config.

Error

If fail to create, then an error is returned.

pub fn set_max_memory_pages(&mut self, count: u32)

Sets the maximum number of the memory pages available.

Argument

• count - The page count (64KB per page).

pub fn get_max_memory_pages(&self) -> u32

Returns the number of the memory pages available.

pub fn allow_afunix(&mut self, enable: bool)

Allows or disallows the use of AF_UNIX sockets in the WASI socket implementation. By default, the option is disabled.

Argument

• enable - Whether the option turns on or not.

pub fn allow_afunix_enabled(&self) -> bool

Checks if the AF_UNIX sockets option turns on or not.

pub fn mutable_globals(&mut self, enable: bool)

Enables or disables the ImportExportMutGlobals option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn mutable_globals_enabled(&self) -> bool

Checks if the ImportExportMutGlobals option turns on or not.

pub fn non_trap_conversions(&mut self, enable: bool)

Enables or disables the NonTrapFloatToIntConversions option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn non_trap_conversions_enabled(&self) -> bool

Checks if the NonTrapFloatToIntConversions option turns on or not.

pub fn sign_extension_operators(&mut self, enable: bool)

Enables or disables the SignExtensionOperators option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn sign_extension_operators_enabled(&self) -> bool

Checks if the SignExtensionOperators option turns on or not.

pub fn multi_value(&mut self, enable: bool)

Enables or disables the MultiValue option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn multi_value_enabled(&self) -> bool

Checks if the MultiValue option turns on or not.

pub fn bulk_memory_operations(&mut self, enable: bool)

Enables or disables the BulkMemoryOperations option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn bulk_memory_operations_enabled(&self) -> bool

Checks if the BulkMemoryOperations option turns on or not.

pub fn reference_types(&mut self, enable: bool)

Enables or disables the ReferenceTypes option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn reference_types_enabled(&self) -> bool

Checks if the ReferenceTypes option turns on or not.

pub fn simd(&mut self, enable: bool)

Enables or disables the SIMD option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn simd_enabled(&self) -> bool

Checks if the SIMD option turns on or not.

pub fn relax_simd(&mut self, enable: bool)

Enables or disables the RelaxSIMD option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn relax_simd_enabled(&self) -> bool

Checks if the RelaxSIMD option turns on or not.

pub fn tail_call(&mut self, enable: bool)

Enables or disables the TailCall option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn tail_call_enabled(&self) -> bool

Checks if the TailCall option turns on or not.

pub fn extended_const(&mut self, enable: bool)

Enables or disables the ExtendedConst option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn extended_const_enabled(&self) -> bool

Checks if the ExtendedConst option turns on or not.

pub fn annotations(&mut self, enable: bool)

Enables or disables the Annotations option. By default, the option is disabled.

Argument

• enable - Whether the option turns on or not.

pub fn annotations_enabled(&self) -> bool

Checks if the Annotations option turns on or not.

pub fn memory64(&mut self, enable: bool)

Enables or disables the Memory64 option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn memory64_enabled(&self) -> bool

Checks if the Memory64 option turns on or not.

pub fn threads(&mut self, enable: bool)

Enables or disables the Threads option. By default, the option is disabled.

Argument

• enable - Whether the option turns on or not.

pub fn threads_enabled(&self) -> bool

Checks if the Threads option turns on or not.

pub fn gc(&mut self, enable: bool)

Enables or disables the GC option. By default, the option is enabled.

The GC proposal depends on the FunctionReferences and ReferenceTypes proposals: enabling GC keeps both dependencies enabled, and disabling either dependency is ignored while GC stays enabled.

Argument

• enable - Whether the option turns on or not.

pub fn gc_enabled(&self) -> bool

Checks if the GC option turns on or not.

pub fn exception_handling(&mut self, enable: bool)

Enables or disables the ExceptionHandling option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn exception_handling_enabled(&self) -> bool

Checks if the ExceptionHandling option turns on or not.

pub fn function_references(&mut self, enable: bool)

Enables or disables the FunctionReferences option. By default, the option is enabled.

The FunctionReferences proposal depends on the ReferenceTypes proposal: enabling FunctionReferences keeps ReferenceTypes enabled, and disabling ReferenceTypes is ignored while FunctionReferences stays enabled. Disabling FunctionReferences is ignored while the GC proposal stays enabled.

Argument

• enable - Whether the option turns on or not.

pub fn function_references_enabled(&self) -> bool

Checks if the FunctionReferences option turns on or not.

pub fn multi_memories(&mut self, enable: bool)

Enables or disables the MultiMemories option. By default, the option is enabled.

Argument

• enable - Whether the option turns on or not.

pub fn multi_memories_enabled(&self) -> bool

Checks if the MultiMemories option turns on or not.

pub fn component_model(&mut self, enable: bool)

Enables or disables the Component option. By default, the option is disabled.

Notice that the WebAssembly component model support in WasmEdge is experimental.

Argument

• enable - Whether the option turns on or not.

pub fn component_model_enabled(&self) -> bool

Checks if the Component option turns on or not.

pub fn set_wasm_standard(&mut self, standard: WasmStandard)

Resets the enabled proposals to the preset of the given WebAssembly standard.

All proposals set before this call are overwritten; the proposals that do not belong to the given standard, such as Annotations, Threads, and Component, are disabled.

Argument

• standard - The WebAssembly standard whose proposal preset is applied.

pub fn set_run_mode(&mut self, mode: RunMode)

Sets the execution mode: interpreter, JIT, or AOT. By default, the mode is [RunMode::Interpreter].

Since WasmEdge 0.17.0, only [RunMode::Aot] loads the AOT custom sections from a universal WASM file or dlopens a shared-library WASM artifact; in the other modes, the AOT data is ignored and the WASM runs in the selected engine.

Argument

• mode - The execution mode to set.

pub fn get_run_mode(&self) -> RunMode

Returns the execution mode.

pub fn interpreter_mode(&mut self, enable: bool)

👎Deprecated:

use set_run_mode instead; since WasmEdge 0.17.0, passing false is a no-op

Enables or disables the ForceInterpreter option. By default, the option is disabled.

Argument

• enable - Whether the option turns on or not.

pub fn interpreter_mode_enabled(&self) -> bool

👎Deprecated:

use get_run_mode instead

Checks if the ForceInterpreter option turns on or not.

pub fn set_aot_optimization_level( &mut self, opt_level: CompilerOptimizationLevel, )

Available on crate feature aot only.

Sets the optimization level of AOT compiler. By default, the optimization level is O3.

Notice that this function is only available when the aot feature is enabled.

Argument

• opt_level - The optimization level of AOT compiler.

pub fn get_aot_optimization_level(&self) -> CompilerOptimizationLevel

Available on crate feature aot only.

Returns the optimization level of AOT compiler.

Notice that this function is only available when the aot feature is enabled.

pub fn set_aot_compiler_output_format(&mut self, format: CompilerOutputFormat)

Available on crate feature aot only.

Sets the output binary format of AOT compiler. By default, the compiler output format is Wasm.

Notice that this function is only available when the aot feature is enabled.

Argument

• format - The format of the output binary.

pub fn get_aot_compiler_output_format(&self) -> CompilerOutputFormat

Available on crate feature aot only.

Returns the output binary format of AOT compiler.

Notice that this function is only available when the aot feature is enabled.

pub fn dump_ir(&mut self, flag: bool)

Available on crate feature aot only.

Sets the dump IR option of AOT compiler. By default, the option is disabled.

Notice that this function is only available when the aot feature is enabled.

Argument

• flag - Whether dump ir or not.

pub fn dump_ir_enabled(&self) -> bool

Available on crate feature aot only.

Checks if the dump IR option turns on or not.

Notice that this function is only available when the aot feature is enabled.

pub fn generic_binary(&mut self, flag: bool)

Available on crate feature aot only.

Sets the generic binary option of AOT compiler. By default, the option is disabled.

Notice that this function is only available when the aot feature is enabled.

Argument

• flag - Whether generate the generic binary or not when perform AOT compilation.

pub fn generic_binary_enabled(&self) -> bool

Available on crate feature aot only.

Checks if the generic binary option of AOT compiler turns on or not.

Notice that this function is only available when the aot feature is enabled.

pub fn interruptible(&mut self, enable: bool)

Available on crate feature aot only.

Enables or Disables the Interruptible option of AOT compiler. This option determines to generate interruptible binary or not when compilation in AOT compiler. By default, the option is disabled.

Notice that this function is only available when the aot feature is enabled.

Argument

• enable - Whether turn on the Interruptible option.

pub fn interruptible_enabled(&self) -> bool

Available on crate feature aot only.

Checks if the Interruptible option of AOT Compiler turns on or not.

Notice that this function is only available when the aot feature is enabled.

pub fn count_instructions(&mut self, flag: bool)

Sets the instruction counting option. By default, the option is disabled.

Argument

• flag - Whether support instruction counting or not when execution after AOT compilation.

pub fn is_instruction_counting(&self) -> bool

Checks if the instruction counting option turns on or not.

pub fn measure_cost(&mut self, flag: bool)

Sets the cost measuring option. By default, the option is disabled.

Argument

• flag - Whether support cost measuring or not when execution after AOT compilation.

pub fn is_cost_measuring(&self) -> bool

Checks if the cost measuring option turns on or not.

pub fn measure_time(&mut self, flag: bool)

Sets the time measuring option. By default, the option is disabled.

Argument

• flag - Whether support time measuring or not when execution after AOT compilation.

pub fn is_time_measuring(&self) -> bool

Checks if the time measuring option turns on or not.

pub fn as_ptr(&self) -> *const WasmEdge_ConfigureContext

Available on crate feature ffi only.

Provides a raw pointer to the inner Configure context.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Drop for Config

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.