WasmEdge (formerly SSVM) is a high performance and enterprise-ready WebAssembly (WASM) Virtual Machine for cloud, AI, and Blockchain applications. Its use cases include the following.
- A high performance runtime for Rust function-as-a-service (FaaS). Getting started | Tensorflow inference | Tencent Serverless | Rust on Node.js
- An embedded runtime for serverless functions in SaaS and PaaS platforms. Serverless Reactor for messaging apps | Plugin for IoT streaming framework YoMo
- A hardware-optimized runtime for ONNX AI models. ONNC compiler for AI
- Smart contract runtime engine for leading blockchain platforms. Polkadot/Substrate | CyberMiles
WasmEdge is hosted by the Cloud Native Computing Foundation (CNCF) as a sandbox project. For the information on related tools and the WasmEdge ecosystem, please refer to the WasmEdge ecosystem documentation.
$ git clone [email protected]:WasmEdge/WasmEdge.git
$ cd WasmEdge
$ git checkout 0.8.0Our docker image use ubuntu 20.04 as the base.
$ docker pull wasmedge/wasmedge# Tools and libraries
$ sudo apt install -y \
software-properties-common \
cmake \
libboost-all-dev
# And you will need to install llvm for wasmedgec tool
$ sudo apt install -y \
llvm-dev \
liblld-10-dev
# WasmEdge supports both clang++ and g++ compilers
# You can choose one of them for building this project
$ sudo apt install -y gcc g++
$ sudo apt install -y clangOur development environment requires libLLVM-10 and >=GLIBCXX_3.4.26.
If users are using the older operating system than Ubuntu 20.04, please use our special docker image to build WasmEdge. If you are looking for the pre-built binaries for the older operatoring system, we also provide several pre-built binaries based on manylinux* distribution.
| Portable Linux Built Distributions Tags | Base Image | Provided Requirements | Docker Image |
|---|---|---|---|
manylinux1 |
CentOS 5.11 | GLIBC <= 2.5 CXXABI <= 3.4.8 GLIBCXX <= 3.4.9 GCC <= 4.2.0 |
wasmedge/wasmedge:manylinux1_x86_64 |
manylinux2010 |
CentOS 6 | GLIBC <= 2.12 CXXABI <= 1.3.3 GLIBCXX <= 3.4.13 GCC <= 4.5.0 |
wasmedge/wasmedge:manylinux2010_x86_64 |
manylinux2014 |
CentOS 7 | GLIBC <= 2.17 CXXABI <= 1.3.7 GLIBCXX <= 3.4.19 GCC <= 4.8.0 |
wasmedge/wasmedge:manylinux2014_x86_64 |
If users don't need Ahead-of-Time runtime/compiler support, they can set the CMake option BUILD_AOT_RUNTIME to OFF.
$ cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_AOT_RUNTIME=OFF ..WasmEdge provides various tools for enabling different runtime environments for optimal performance. After the build is finished, you can find there are several wasmedge related tools:
wasmedgeis for general wasm runtime.wasmedgeexecutes aWASMfile in interpreter mode or a compiled WASMsofile in ahead-of-time compilation mode.- To disable building all tools, you can set the CMake option
BUILD_TOOLStoOFF.
wasmedgecis for ahead-of-timeWASMcompiler.wasmedgeccompiles a generalWASMfile into asofile.- To disable building the ahead-of-time compiler only, you can set the CMake option
BUILD_AOT_RUNTIMEtoOFF. - To disable building all tools, you can set the CMake option
BUILD_TOOLStoOFF.
libwasmedge_c.sois the WasmEdge C API shared library.libwasmedge_c.soprovides C API for the ahead-of-time compiler and the WASM runtime.- The APIs about the ahead-of-time compiler will always return failed if the CMake option
BUILD_AOT_RUNTIMEis set asOFF. - To disable building the shared library only, you can set the CMake option
BUILD_SHARED_LIBtoOFF.
ssvm-qitcis for AI application, supporting ONNC runtime for AI model in ONNX format.- If you want to try
ssvm-qitc, please refer to ONNC-Wasm project to set up the working environment and run several examples. - And here is our tutorial for ONNC-Wasm project(YouTube Video).
- If you want to try
# After pulling our wasmedge docker image
$ docker run -it --rm \
-v <path/to/your/wasmedge/source/folder>:/root/wasmedge \
wasmedge/wasmedge:latest
(docker)$ cd /root/wasmedge
(docker)$ mkdir -p build && cd build
(docker)$ cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=ON .. && make -jThe following built-in tests are only available when the build flag BUILD_TESTS sets to ON.
Users can use these tests to verify the correctness of WasmEdge binaries.
$ cd <path/to/wasmedge/build_folder>
$ LD_LIBRARY_PATH=$(pwd)/lib/api ctestTo run WasmEdge with general wasm runtime, users will need to provide the following parameters:
- (Optional) Reactor mode: use
--reactorto enable reactor mode.- WasmEdge will execute the function which name should be given in ARG[0].
- If there's exported function which names
_initialize, the function will be executed with the empty parameter at first.
- (Optional) Binding directories into WASI virtual filesystem.
- Each directory can be specified as
--dir host_path:guest_path.
- Each directory can be specified as
- (Optional) Environ variables.
- Each variable can be specified as
--env NAME=VALUE.
- Each variable can be specified as
- Wasm file(
/path/to/wasm/file). - (Optional) Arguments.
- In reactor mode, the first argument will be the function name, and the arguments after ARG[0] will be parameters of wasm function ARG[0].
- In command mode, the arguments will be parameters of function
_start.
# cd <path/to/wasmedge/build_folder>
$ cd tools/wasmedge
# ./wasmedge [-h|--help] [-v|--version] [--reactor] [--dir PREOPEN_DIRS ...] [--env ENVS ...] [--enable-bulk-memory] [--enable-reference-types] [--enable-simd] [--enable-all] [--allow-command COMMANDS ...] [--allow-command-all] [--] WASM_OR_SO [ARG ...]
$ ./wasmedge --reactor examples/fibonacci.wasm fib 10
89When wrong number of parameter given, the following error message is printed.
$ ./wasmedge --reactor examples/fibonacci.wasm fib 10 10
2020-08-21 06:30:37,304 ERROR [default] execution failed: function signature mismatch, Code: 0x83
2020-08-21 06:30:37,304 ERROR [default] Mismatched function type. Expected: params{i32} returns{i32} , Got: params{i32 , i32} returns{i32}
2020-08-21 06:30:37,304 ERROR [default] When executing function name: "fib"When calling unknown exported function, the following error message is printed.
$ ./wasmedge --reactor examples/fibonacci.wasm fib2 10
2020-08-21 06:30:56,981 ERROR [default] wasmedge runtime failed: wasm function not found, Code: 0x04
2020-08-21 06:30:56,981 ERROR [default] When executing function name: "fib2"# ./wasmedge [-h|--help] [-v|--version] [--reactor] [--dir PREOPEN_DIRS ...] [--env ENVS ...] [--enable-bulk-memory] [--enable-reference-types] [--enable-simd] [--enable-all] [--allow-command COMMANDS ...] [--allow-command-all] [--] WASM_OR_SO [ARG ...]
$ ./wasmedge --reactor examples/factorial.wasm fac 5
120Note: Some of those tools are stilling using WasmEdge's old name "SSVM". We are renaming those repos, artifacts, and docs when we make new releases on those projects.
The rustwasmc is a one-stop tool for building Rust functions into WebAssembly for deployment on the WasmEdge Runtime.
SSVM-EVMC provides support for Ewasm runtime which is compatible with EVMC.
This project provides a shared library that can initialize and execute by the EVMC interface.
SSVM-napi provides support for accessing WasmEdge as a Node.js addon.
It allows Node.js applications to call WebAssembly functions written in Rust or other high-performance languages.
Why do you want to run WebAssembly on the server-side?
The WasmEdge addon could interact with the wasm files generated by the rustwasmc compiler tool.
SSVM-TensorFlow provides support for accessing with TensorFlow C library.
This project provides a tool that can execute WASM with TensorFlow extension compiled from Rust ssvm_tensorflow_interface.
The Second State DevChain features a powerful and easy-to-use virtual machine that can quickly get you started with the smart contract and DApp development.
SSVM-evmc is integrated into our DevChain. Click here to learn how to run an ewasm smart contract on a real blockchain.
Design document shows how to register customized host functions into WasmEdge and execute with wasm files.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent