🚀 A fast WebAssembly interpreter and the most universal WASM runtime

Go to file

Steven Massey f73ee05023 no message		3 years ago
.github/workflows	Use clang for "build-as-cpp" tests	3 years ago
docs	Add Grain WASI app example	3 years ago
extra	Add iden3	3 years ago
platforms	uhg. git confusion.	3 years ago
source	no message	3 years ago
test	m3Ext_ReserveFunctions	3 years ago
.codespellrc	Separate action for spellcheck	3 years ago
.gitignore	Cleanup	3 years ago
CMakeLists.txt	Move most embedded platforms to a separate subdirectory	3 years ago
LICENSE	Update LICENSE	5 years ago
README.md	Update README.md	3 years ago

README.md

Unescape Escape

Wasm3

The fastest WebAssembly interpreter, and the most universal runtime.
_{Based on CoreMark 1.0 benchmark. Your mileage may vary.}

Getting Started

Here's an online demo and a small getting started guide:

Installation

Please follow the installation instructions.

Wasm3 can also be used as a library for:

Python3 │ C/C++ │ GoLang │ Rust │ 　 Zig
Swift │ .Net │ Arduino, PlatformIO, Particle

Status

wasm3 passes the WebAssembly spec testsuite and is able to run many WASI apps.

Minimum useful system requirements: ~64Kb for code and ~10Kb RAM

wasm3 runs on a wide range of architectures (x86, x86_64, ARM, RISC-V, PowerPC, MIPS, Xtensa, ARC32, ...) and platforms:

Linux, Windows, OS X, FreeBSD, Android, iOS
OpenWrt, Yocto, Buildroot (routers, modems, etc.)
Raspberry Pi, Orange Pi and other SBCs
MCUs: Arduino, ESP8266, ESP32, Particle, ... see full list
Browsers. Yes, using WebAssembly itself!
wasm3 can execute wasm3 (self-hosting)

Advanced features and post-mvp proposals support

☑ Sign-extension operators
☑ Non-trapping float-to-int conversions
☑ Import/Export of Mutable Globals
☑ Structured execution tracing
☑ Big-Endian systems support
☑ Self-hosting
☑ Gas metering
☑ Multi-value
☐ Reference types
☐ Bulk memory operations
☐ Tail call optimization

Motivation

Why use a "slow interpreter" versus a "fast JIT"?

In many situations, speed is not the main concern. Runtime executable size, memory usage, startup latency can be improved with the interpreter approach. Portability and security are much easier to achieve and maintain. Additionally, development impedance is much lower. A simple library like Wasm3 is easy to compile and integrate into an existing project. (Wasm3 builds in a just few seconds). Finally, on some platforms (i.e. iOS and WebAssembly itself) you can't generate executable code pages in runtime, so JIT is unavailable.

Why would you want to run WASM on embedded devices?

Wasm3 started as a research project and remains so by many means. Evaluating the engine in different environments is part of the research. Given that we have Lua, JS, Python, Lisp, ... running on MCUs, WebAssembly is actually a promising alternative. It provides toolchain decoupling as well as a completely sandboxed, well-defined, predictable environment. Among practical use cases we can list edge computing, scripting, running IoT rules, smart contracts, etc.