You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
wasm3/README.md

113 lines
7.9 KiB
Markdown

4 years ago
<img align="right" width="30%" src="/extra/screenshot-ios.png">
5 years ago
5 years ago
# <img src="/extra/wasm-symbol.svg" width="32" height="32" /> Wasm3
5 years ago
[![WAPM](https://wapm.io/package/vshymanskyy/wasm3/badge.svg)](https://wapm.io/package/vshymanskyy/wasm3)
4 years ago
[![GitHub issues](https://img.shields.io/github/issues-raw/wasm3/wasm3?style=flat-square&label=issues&color=success)](https://github.com/wasm3/wasm3/issues)
3 years ago
[![Tests status](https://img.shields.io/github/workflow/status/wasm3/wasm3/tests/main?style=flat-square&logo=github&label=tests)](https://github.com/wasm3/wasm3/actions)
3 years ago
[![Fuzzing Status](https://img.shields.io/badge/oss--fuzz-fuzzing-success?style=flat-square)](https://bugs.chromium.org/p/oss-fuzz/issues/list?can=1&q=proj:wasm3)
5 years ago
[![GitHub license](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://github.com/wasm3/wasm3)
5 years ago
3 years ago
The fastest WebAssembly interpreter, and the most universal runtime.
<sub>Based on [**CoreMark 1.0** benchmark](./docs/Performance.md). Your mileage may vary.</sub>
5 years ago
4 years ago
[![Twitter](https://img.shields.io/twitter/follow/wasm3_engine?style=flat-square&color=1da1f2&label=twitter&logo=twitter)](https://twitter.com/wasm3_engine)
4 years ago
[![Discord](https://img.shields.io/discord/671415645073702925?style=flat-square&logo=discord&color=7289da&label=discord)](https://discord.gg/qmZjgnd)
[![Telegram](https://img.shields.io/badge/telegram-chat-0088cc?style=flat-square&logo=telegram)](https://t.me/joinchat/DD8s3xVG8Vj_LxRDm52eTQ)
4 years ago
5 years ago
## Getting Started
4 years ago
Here's an online demo and a small [getting started guide](https://wapm.io/package/vshymanskyy/wasm3):
5 years ago
4 years ago
[![LIVE DEMO](extra/button.png)](https://webassembly.sh/?run-command=wasm3)
5 years ago
3 years ago
## Installation
**Please follow the [installation instructions](./docs/Installation.md).**
Wasm3 can also be used as a library for:
[<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/python.svg" width="18" height="18" /> Python3](https://github.com/wasm3/pywasm3) │
3 years ago
[<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/cplusplus.svg" width="18" height="18" /> C/C++](https://github.com/wasm3/wasm3) │
[<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/go.svg" width="18" height="18" /> GoLang](https://github.com/matiasinsaurralde/go-wasm3) │
[<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/rust.svg" width="18" height="18" /> Rust](https://github.com/Veykril/wasm3-rs) │
3 years ago
[  Zig](https://github.com/alichay/zig-wasm3)
3 years ago
[<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/swift.svg" width="18" height="18" /> Swift](https://github.com/shareup/wasm-interpreter-apple) │
3 years ago
[<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/dot-net.svg" width="18" height="18" /> .Net](https://github.com/tana/Wasm3DotNet) │
3 years ago
[<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/arduino.svg" width="18" height="18" /> Arduino, PlatformIO, Particle](https://github.com/wasm3/wasm3-arduino)
5 years ago
## Status
5 years ago
5 years ago
`wasm3` passes the [WebAssembly spec testsuite](https://github.com/WebAssembly/spec/tree/master/test/core) and is able to run many `WASI` apps.
5 years ago
5 years ago
Minimum useful system requirements: **~64Kb** for code and **~10Kb** RAM
4 years ago
`wasm3` runs on a wide range of architectures (`x86`, `x86_64`, `ARM`, `RISC-V`, `PowerPC`, `MIPS`, `Xtensa`, `ARC32`, ...) and [platforms](/platforms):
5 years ago
- <img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/linux.svg" width="18" height="18" /> Linux,
<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/windows.svg" width="18" height="18" /> Windows,
4 years ago
<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/apple.svg" width="18" height="18" /> OS X,
3 years ago
<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/freebsd.svg" width="18" height="18" /> FreeBSD,
<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/android.svg" width="18" height="18" /> Android,
5 years ago
<img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/apple.svg" width="18" height="18" /> iOS
3 years ago
- <img src="https://cdn.rawgit.com/feathericons/feather/master/icons/wifi.svg" width="18" height="18" /> OpenWrt, Yocto, Buildroot (routers, modems, etc.)
3 years ago
- <img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/raspberrypi.svg" width="18" height="18" /> Raspberry Pi, Orange Pi and other SBCs
- <img src="https://cdn.rawgit.com/feathericons/feather/master/icons/cpu.svg" width="18" height="18" /> MCUs: Arduino, ESP8266, ESP32, Particle, ... [see full list](./docs/Hardware.md)
- <img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/firefoxbrowser.svg" width="18" height="18" /> Browsers. Yes, using WebAssembly itself!
5 years ago
- <img src="extra/wasm-symbol.svg" width="18" height="18" /> `wasm3` can execute `wasm3` (self-hosting)
5 years ago
3 years ago
## Advanced features and [post-mvp proposals](https://github.com/WebAssembly/proposals) support
4 years ago
4 years ago
☑ Sign-extension operators
☑ Non-trapping float-to-int conversions
3 years ago
☑ Import/Export of Mutable Globals
3 years ago
☑ Structured execution tracing
3 years ago
☑ Big-Endian systems support
3 years ago
☑ Self-hosting
☑ Gas metering
3 years ago
☑ Multi-value
3 years ago
☐ Reference types
3 years ago
☐ Bulk memory operations
3 years ago
☐ Tail call optimization
4 years ago
5 years ago
## Motivation
5 years ago
**Why use a "slow interpreter" versus a "fast JIT"?**
5 years ago
3 years ago
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.
5 years ago
3 years ago
**Why would you want to run WASM on embedded devices?**
5 years ago
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.
5 years ago
3 years ago
## Used by
3 years ago
[<img src="https://wasmcloud.dev/images/logo.png" height="32" />](https://wasmcloud.dev/) 
3 years ago
[<img src="/extra/wowcube.png" height="32" />](https://wowcube.com/) 
3 years ago
[<img src="/extra/scailable.png" height="32" />](https://scailable.net/) 
3 years ago
[<img src="/extra/blynk.png" height="32" />](https://blynk.io/) 
3 years ago
[<img src="/extra/iden3.svg" height="32" />](https://www.iden3.io/) 
3 years ago
[<img src="https://user-images.githubusercontent.com/1506708/114701856-069ce700-9d2c-11eb-9b72-9ce2dfd9f0fb.png" height="32" />](https://github.com/kateinoigakukun/wasmic-ios) 
3 years ago
[<img src="https://www.balena.io/blog/content/images/2018/10/balena_logo.png" height="32" />](https://github.com/balena-io-playground/balena-wasm3) 
3 years ago
[<img src="https://krustlet.dev/images/horizontal.svg" height="32" />](https://github.com/deislabs/krustlet-wasm3) 
3 years ago
[<img src="/extra/shareup_app.svg" height="24" />](https://shareup.app/blog/introducing-shareup/) 
3 years ago
[<img src="/extra/txiki_js.png" height="32" />](https://github.com/saghul/txiki.js) 
5 years ago
5 years ago
## Further Resources
5 years ago
4 years ago
[Demos](./docs/Demos.md)
3 years ago
[Cookbook](./docs/Cookbook.md)
3 years ago
[Installation instructions](./docs/Installation.md)
4 years ago
[Build and Development instructions](./docs/Development.md)
4 years ago
[Supported Hardware](./docs/Hardware.md)
4 years ago
[Testing & Fuzzing](./docs/Testing.md)
[Performance](./docs/Performance.md)
4 years ago
[Interpreter Architecture](./docs/Interpreter.md)
3 years ago
[Logging](./docs/Diagnostics.md)
[Awesome WebAssembly Tools](https://github.com/vshymanskyy/awesome-wasm-tools/blob/main/README.md)
5 years ago
5 years ago
### License
This project is released under The MIT License (MIT)