Continuous Integration	Test Coverage	Documentation	Crates.io

Wasmi - WebAssembly (Wasm) Interpreter

Wasmi is an efficient and lightweight WebAssembly interpreter with a focus on constrained and embedded systems.

Version 0.31.0 has been audited by SRLabs.

Announcement: Transfer of Ownership

As of 2024-02-01, the original owner and maintainer of the Wasmi project, Parity Technologies, has officially transferred ownership of the project to me, Robin Freyler. Read more about this transfer here.

Distinct Features

The following list states some of the distinct features of Wasmi.

• Simple, correct and deterministic execution of WebAssembly.
• Low-overhead and cross-platform WebAssembly runtime for embedded environments.
• JIT bomb resisting translation.
• Loosely mirrors the Wasmtime API.
• 100% WebAssembly spec testsuite compliance.
• Built-in support for fuel metering.

WebAssembly Proposals

The new Wasmi engine supports a variety of WebAssembly proposals and will support even more of them in the future.

Usage

As CLI Application

Install the newest Wasmi CLI version:

cargo install wasmi_cli

Run wasm32-unknown-unknown or wasm32-wasi Wasm binaries:

wasmi_cli <WASM_FILE> --invoke <FUNC_NAME> [<FUNC_ARGS>]*

As Rust Library

Refer to the Wasmi crate docs to learn how to use the Wasmi crate as library.

Development

Build & Test

Clone the Wasmi repository and build using cargo:

git clone https://github.com/paritytech/wasmi.git --recursive
cd wasmi
cargo build
cargo test

Benchmarks

In order to benchmark Wasmi use the following command:

cargo bench

Use translate, instantiate, execute or overhead filters to only run benchmarks that test performance of Wasm translation, instantiation, execution or miscellaneous overhead respectively, e.g. cargo bench execute.

We maintain a timeline for benchmarks of every commit to master that can be viewed here.

Supported Platforms

Wasmi supports a wide variety of architectures and platforms.

• Fore more details see this list of supported platforms for Rust.
• Note: Wasmi can be used in no_std embedded environments, thus not requiring the standard library (std).
• Only some platforms are checked in CI and guaranteed to be fully working by the Wasmi maintainers.

Production Builds

In order to reap the most performance out of Wasmi we highly recommended to compile the Wasmi crate using the following Cargo profile:

[profile.release]
lto = "fat"
codegen-units = 1

When compiling for the WebAssembly target we highly recommend to post-optimize Wasmi using Binaryen's wasm-opt tool since our experiments displayed a 80-100% performance improvements when executed under Wasmtime and also slightly smaller Wasm binaries.

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.