wasmi_collections

Added

• Allows Wasmi CLI to be installed with locked dependencies. (#1096)
  • This can be done as follows: cargo install --locked wasmi_cli

Fixed

• Allow Wasm module instantiation in host functions called from Wasmi's executor. (#1116)

Changed

• Limit number of parameter and result types in FuncType to 1000, each. (#1116)

Dev. Note

• Significantly improved and Wasmi's CI and made it a lot faster.
  • Multi PR effort: #1098, #1100, #1104
• Refactored and cleaned-up call based and Rust sourced Wasmi benchmarks.
  • Call-based Benchmarks: #1102, #1113
  • Rust-sourced Benchmarks: #1107, #1108, #1109, #1111, #1115

Added

• Added Error trait impls for all Wasmi error types impleemnting Display. (https://github.com/wasmi-labs/wasmi/pull/1089)
  • Contributed by kajacx.

Fixed

• Fixed compilation for Rust versions <1.78. (https://github.com/wasmi-labs/wasmi/pull/1093)
• Fixed nightly clippy warning about map_err. (https://github.com/wasmi-labs/wasmi/pull/1094)

Added

• Added support for Wasm custom sections processing. (https://github.com/wasmi-labs/wasmi/pull/1085)
  • It is now possible to query name and data of Wasm custom sections of a Module.
  • Use the new Config::ignore_custom_sections flag to disable this functionality.
• Added Config::ignore_custom_sections flag to disable processing custom sections if this is unwanted. (https://github.com/wasmi-labs/wasmi/pull/1085)
• Add Memory::{data_ptr, data_size, size} methods. (https://github.com/wasmi-labs/wasmi/pull/1082)
• Added a Wasmi usage guide documentation. (https://github.com/wasmi-labs/wasmi/pull/1072)
  • Link: https://github.com/wasmi-labs/wasmi/blob/master/docs/usage.md

Changed

• Optimized the Wasmi executor in various ways.
  • In summary the Wasmi executor now more optimally caches the currently used Wasm instance and optimizes access to instance related data. In particular access to the default linear memory bytes as well as the value of the global variable at index 0 (often used as shadow stack pointer) are more efficient.
  • The following PRs are part of this effort:
    • https://github.com/wasmi-labs/wasmi/pull/1059
    • https://github.com/wasmi-labs/wasmi/pull/1062
    • https://github.com/wasmi-labs/wasmi/pull/1068
    • https://github.com/wasmi-labs/wasmi/pull/1069
    • https://github.com/wasmi-labs/wasmi/pull/1065
    • https://github.com/wasmi-labs/wasmi/pull/1075
    • https://github.com/wasmi-labs/wasmi/pull/1076
• Changed Memory::grow signature to mirror Wasmtime's Memory::grow method. (https://github.com/wasmi-labs/wasmi/pull/1082)

Removed

• Removed Memory::current_pages method. (https://github.com/wasmi-labs/wasmi/pull/1082)
  • Users should use the new Memory::size method instead.

Fixed

• Fix overlapping reuse of local preservation slots. (https://github.com/wasmi-labs/wasmi/pull/1057)
  • Thanks again to kaiavintr for reporting the bug.

Fixed

• Refine and generalize the fix for v0.32.1. (https://github.com/wasmi-labs/wasmi/pull/1054)

Fixed

• Fixes a miscompilation when merging two copy instructions where the result of the first copy is also the input to the second copy and vice versa. (https://github.com/wasmi-labs/wasmi/pull/1052)
  • Thanks to kaiavintr for reporting the bug.

Note:

• This release is the culmination of months of research, development and QA with a new execution engine utilizing register-based IR at its core boosting both startup and execution performance to new levels for the Wasmi interpreter.
• This release is accompanied with an article that presents some of the highlights.

Added

• Added a new execution engine based on register-based bytecode. (https://github.com/wasmi-labs/wasmi/pull/729)
  • The register-based Wasmi Engine executes roughly 80-100% faster and compiles roughly 30% slower according to benchmarks conducted so far.
• Added Module::new_unchecked API. (https://github.com/wasmi-labs/wasmi/pull/829)
  • This allows to compile a Wasm module without Wasm validation which can be useful when users know that their inputs are valid Wasm binaries.
  • This improves Wasm compilation performance for faster startup times by roughly 10-20%.
• Added Wasm compilation modes. (https://github.com/wasmi-labs/wasmi/pull/844)
  • When using Module::new Wasmi eagerly compiles Wasm bytecode into Wasmi bytecode which is optimized for efficient execution. However, this compilation can become very costly especially for large Wasm binaries.
  • The solution to this problem is to introduce new compilation modes, namely:
    • CompilationMode::Eager: Eager compilation, what Wasmi did so far. (default)
    • CompilationMode::LazyTranslation: Eager Wasm validation and lazy Wasm translation.
    • CompilationMode::Lazy: Lazy Wasm validation and translation.
  • Benchmarks concluded that
    • CompilationMode::LazyTanslation: Usually improves startup performance by a factor of 2 to 3.
    • CompilationMode::Lazy: Usually improves startup performance by a factor of up to 27.
  • Note that CompilationMode::Lazy can lead to partially validated Wasm modules which can introduce non-determinism when using different Wasm implementations. Therefore users should know what they are doing when using CompilationMode::Lazy if this is a concern.
  • Enable lazy Wasm compilation with:

    let mut config = wasmi::Config::default();
    config.compilation_mode(wasmi::CompilationMode::Lazy);
    

  • When CompilationMode::Lazy or CompilationMode::LazyTranslation and fuel metering is enabled the first function access that triggers compilation (and validation) will charge fuel respective to the number of bytes of the Wasm function body. (https://github.com/wasmi-labs/wasmi/pull/876)
• Added non-streaming Wasm module compilation. (https://github.com/wasmi-labs/wasmi/pull/1035)
  • So far Wasmi only offered a streaming Wasm module compilation API, however most users probably never really needed that. So starting from this version both Module::new and Module::new_unchecked are now non-streaming with insane performance improvements of up to 80% in certain configurations.
  • For streaming Wasm module users we added Module::new_streaming and Module::new_streaming_unchecked APIs.
• Added Module::validate API. (https://github.com/wasmi-labs/wasmi/pull/840)
  • This allows to quickly check if a Wasm binary is valid according to a Wasmi Engine config.
  • Note that this does not translate the Wasm and thus Module::new or Module::new_unchecked might still fail due to translation errors.
• CLI: Added --compilation-mode argument to enable lazy Wasm compilation. (https://github.com/wasmi-labs/wasmi/pull/849)
• Added --verbose mode to Wasmi CLI by @tjpalmer. (https://github.com/wasmi-labs/wasmi/pull/957)
  • By default Wasmi CLI no longer prints messages during execution.
• Added Memory::new_static constructor by @Ddystopia. (https://github.com/wasmi-labs/wasmi/pull/939)
  • This allows to construct a Wasm Memory from a static byte array which is especially handy for certain embedded use cases.
• Added LinkerBuilder type. (https://github.com/wasmi-labs/wasmi/pull/989)
  • Using LinkerBuilder to create new Linkers with the same set of host functions is a lot more efficient than creating those Linkers the original way. However, the initial LinkerBuilder construction will be as inefficient as building up a Linker previously.
• Added EnforcedLimits configuration option to Config. (https://github.com/wasmi-labs/wasmi/pull/985)
  • Some users want to run Wasm binaries in a specially restricted or limited mode. For example this mode limits the amount of functions, globals, tables etc. can be defined in a single Wasm module. With this change they can enable this new strict mode using

    let mut config = wasmi::Config::default();
    config.enforced_limits(wasmi::EnforcedLimits::strict());
    

    In future updates we might relax this to make EnforcedLimits fully customizable.
• Added EngineWeak constructed via Engine::weak. (https://github.com/wasmi-labs/wasmi/pull/1003)
  • This properly mirrors the Wasmtime API and allows users to store weak references to the Engine.
• Added no-hash-maps crate feature to the wasmi crate. (https://github.com/wasmi-labs/wasmi/pull/1007)
  • This tells the wasmi crate to avoid using hash based data structures which can be beneficial for running Wasmi in some embedded environments such as wasm32-unknown-unknown that do not support random sources and thus are incapable to spawn hash maps that are resilient to malicious actors.
  • Note that Wasmi has always avoided using hash map based data structures prior to this change so not enabling this new crate feature kind of acts as an optimization.
• Added Default implementation for Store<T> where T: Default. (https://github.com/wasmi-labs/wasmi/pull/1031)
  • This mostly serves as a convenient way to create a minimal Wasmi setup.
• Added WasmTy implementations for f32 and f64 Rust primitives. (https://github.com/wasmi-labs/wasmi/pull/1031)
  • This is convenience for Linker::func_wrap calls that take those primitives as arguments. Before this change users had to use F32 and F64 instead which is a bit cumbersome.

Changed

• Minimum Rust version set to 1.77. (https://github.com/wasmi-labs/wasmi/pull/961)
• CLI: Enabled Wasm tail-calls and extend-const proposals by default. (https://github.com/wasmi-labs/wasmi/pull/849)
  • We expect those Wasm proposals to be stabilized very soon so we feel safe to enable them by default already.
• Improved Debug and Display impls for NaNs of Wasm f32 and f64 values.
  • They now show nan:0x{bytes} where {bytes} is their respective raw bytes.
• Implement Sync for ResumableInvocation and TypedResumableInvocation. (https://github.com/wasmi-labs/wasmi/pull/870)
• Properly mirror Wasmtime's fuel API. (https://github.com/wasmi-labs/wasmi/pull/1002)
• Renamed some Wasmi items to improve its Wasmtime mirroring. (https://github.com/wasmi-labs/wasmi/pull/1011)
• Improved Wasmtime API mirror for Store fuel. (https://github.com/wasmi-labs/wasmi/pull/1002)
• Enabled Config::tail_call and Config::extended_const by default. (https://github.com/wasmi-labs/wasmi/pull/1031)
  • Those Wasm proposals have been moved to phase 4 for many months now.

Removed

• Removed the stack-machine bytecode based Wasmi Engine backend. (https://github.com/wasmi-labs/wasmi/pull/818)
  • The new register-based bytecode based Wasmi Engine is more promising and the Wasmi team does not want to maintain two different engine backends.
• Removed FuelConsumptionMode from Config. (https://github.com/wasmi-labs/wasmi/pull/877)
  • FuelConsumptionMode was required to differentiate between lazy and eager fuel consumption. This was necessary due to how lazy fuel consumption was implemented in that it would pre-charge for instruction execution were the exact amount of required fuel was not possible to determine at compilation time. Examples are memory.grow and table.copy instructions. The linked PR improved lazy fuel consumption to no longer pre-charge and instead pre-check if the operation is going to succeed and only charge fuel in that case.

Dev. Note

• Added execution fuzzing and differential fuzzing.
  • PRs: https://github.com/wasmi-labs/wasmi/pull/832, https://github.com/wasmi-labs/wasmi/pull/833
  • Both fuzzing strategies are applied on each commit in our CI pipeline.
• Updated CI jobs to use dtolnay/rust-toolchain instead of actions-rs because the latter was deprecated. (https://github.com/wasmi-labs/wasmi/pull/842)