WebAssembly Micro Runtime

Notice: We've Arrived

WAMR has arrived to its new home. Honestly, you shouldn’t see much of a difference. Github’s tools mean that the repositories and forks you have of the WAMR project should continue to work with no changes. However, if you run into any difficulty at all the table below should help. – If you are still stuck, please do send us an email to this google message group and we’ll do our best to help.

Delayed Domain Transfer

There is just one exception at the moment and that is the domain wamr.dev. This hasn’t been moved over yet. However, we hope this will happen soon.

Ongoing CI/CD Pipeline checks

We are continuing to double-check that all of our CI/CD pipelines / Github Actions continue to work as expected. This work is ongoing. If you encounter any issues, please do let us know via the google group.

Location Table

Description	Current Location	New Location
Wasm Micro Runtime	https://github.com/bytecodealliance/wasm-micro-runtime	https://github.com/wasm-micro-runtime/wasm-micro-runtime
wamr-rust-dsk	https://github.com/bytecodealliance/wamr-rust-sdk	https://github.com/wasm-micro-runtime/wamr-rust-sdk
wamr-app-framework	https://github.com/bytecodealliance/wamr-app-framework	https://github.com/wasm-micro-runtime/wamr-app-framework
wamr-python	https://github.com/bytecodealliance/wamr-python	https://github.com/wasm-micro-runtime/wamr-python

---

Guide  Website

Build WAMR | Build AOT Compiler | Embed WAMR | Export Native API | Build Wasm Apps | Samples

WebAssembly Micro Runtime (WAMR) is a lightweight standalone WebAssembly (Wasm) runtime with small footprint, high performance and highly configurable features for applications cross from embedded, IoT, edge to Trusted Execution Environment (TEE), smart contract, cloud native and so on. It includes a few parts as below:

• VMcore: A set of runtime libraries for loading and running Wasm modules. It supports rich running modes including interpreter, Ahead-of-Time compilation(AoT) and Just-in-Time compilation (JIT). WAMR supports two JIT tiers - Fast JIT, LLVM JIT, and dynamic tier-up from Fast JIT to LLVM JIT.
• iwasm: The executable binary built with WAMR VMcore which supports WASI and command line interface.
• wamrc: The AOT compiler to compile Wasm file into AOT file
• Useful components and tools for building real solutions with WAMR vmcore:
  • App-framework: A framework for supporting APIs for the Wasm applications
  • App-manager: A framework for dynamical loading the Wasm module remotely
  • WAMR-IDE: An experimental VSCode extension for developping WebAssembly applications with C/C++

Key features

• Full compliant to the W3C Wasm MVP
• Small runtime binary size (core vmlib on cortex-m4f with tail-call/bulk memory/shared memory support, text size from bloaty)
  • ~58.9K for fast interpreter
  • ~56.3K for classic interpreter
  • ~29.4K for aot runtime
  • ~21.4K for libc-wasi library
  • ~3.7K for libc-builtin library
• Near to native speed by AOT and JIT
• Self-implemented AOT module loader to enable AOT working on Linux, Windows, MacOS, Android, SGX and MCU systems
• Choices of Wasm application libc support: the built-in libc subset for the embedded environment or WASI for the standard libc
• The simple C APIs to embed WAMR into host environment, see how to integrate WAMR and the API list
• The mechanism to export native APIs to Wasm applications, see how to register native APIs
• Multiple modules as dependencies, ref to document and sample
• Multi-thread, pthread APIs and thread management, ref to document and

Wasm post-MVP features

• wasm-c-api, ref to document and sample
• 128-bit SIMD, ref to samples/workload
• Reference Types, ref to document and sample
• Bulk memory operations, Shared memory, Memory64
• Tail-call, Garbage Collection, Exception Handling, Branch Hinting
• Extended Constant Expressions

Supported architectures and platforms

The WAMR VMcore supports the following architectures:

• X86-64, X86-32
• ARM, THUMB (ARMV7 Cortex-M7 and Cortex-A15 are tested)
• AArch64 (Cortex-A57 and Cortex-A53 are tested)
• RISCV64, RISCV32 (RISC-V LP64 and RISC-V LP64D are tested)
• XTENSA, MIPS, ARC

The following platforms are supported, click each link below for how to build iwasm on that platform. Refer to WAMR porting guide for how to port WAMR to a new platform.

• Linux, Linux SGX (Intel Software Guard Extension), MacOS, Android, Windows, Windows (MinGW, MSVC)
• Zephyr, AliOS-Things, VxWorks, NuttX, RT-Thread, ESP-IDF(FreeRTOS)

Getting started

• Build VM core and Build wamrc AOT compiler
• Build iwasm (mini product): Linux, SGX, MacOS and Windows
• Embed into C/C++, Embed into Python, Embed into Go, Embed in Rust
• Register native APIs for Wasm applications
• Build wamrc AOT compiler
• Build Wasm applications
• Port WAMR to a new platform

Performance and memory

• Blog: The WAMR memory model
• Blog: Understand WAMR heaps and stacks
• Blog: Introduction to WAMR running modes
• Memory usage tuning: the memory model and how to tune the memory usage
• Memory usage profiling: how to profile the memory usage
• Performance tuning: how to tune the performance
• Benchmarks: checkout these links for how to run the benchmarks: PolyBench, CoreMark, Sightglass, JetStream2
• Performance and footprint data: the performance and footprint data

Project Technical Steering Committee

The WAMR PTSC Charter governs the operations of the project TSC. The current TSC members:

• dongsheng28849455 - Dongsheng Yan, [email protected]
• loganek - Marcin Kolny, [email protected]
• lum1n0us - Liang He， [email protected]
• no1wudi Qi Huang, [email protected]
• qinxk-inter - Xiaokang Qin， [email protected]
• ttrenner - Trenner, Thomas， [email protected]
• wei-tang - Wei Tang， [email protected]
• wenyongh - Wenyong Huang， [email protected]
• woodsmc - Woods, Chris， [email protected]
• xujuntwt95329 - Jun Xu， [email protected]
• xwang98 - Xin Wang， [email protected] (chair)
• yamt - Takashi Yamamoto, [email protected]

License

WAMR uses the same license as LLVM: the Apache 2.0 license with the LLVM exception. See the LICENSE file for details. This license allows you to freely use, modify, distribute and sell your own products based on WAMR. Any contributions you make will be under the same license.

More resources

• Who use WAMR?
• WAMR Blogs
• Community news and events
• WAMR TSC meetings