Go to file
2019-07-25 10:38:20 -07:00
.circleci Moved scripts to scripts folder 2019-07-24 17:36:08 -07:00
.github Added CODEOWNERS file 2019-07-24 17:32:04 -07:00
docs Add Dockerfile and documentation 2019-04-09 01:35:48 -05:00
examples Cleanup internal logic. 2019-06-27 17:54:06 +08:00
fuzz Add a readme. 2019-07-13 18:41:06 -07:00
integration_tests Added WASI integration tests 2019-04-22 17:06:42 -07:00
lib fix semver issue with clif 0.31 + new version of wasmparser 2019-07-25 10:38:20 -07:00
media add images to installer and add wapm bin dir to path 2019-04-30 09:21:08 -07:00
scripts Moved scripts to scripts folder 2019-07-24 17:36:08 -07:00
src Only enable SIMD when using the LLVM backend. 2019-07-24 14:10:09 -07:00
wapm-cli@62ec59a53c Prepare for release of 0.5.7 2019-07-23 11:20:59 -07:00
.appveyor.yml Merge branch 'master' into simd 2019-07-23 13:51:15 -07:00
.dockerignore Add Dockerfile and documentation 2019-04-09 01:35:48 -05:00
.gitattributes Fixed spectests ignored by git attributes 2019-01-31 13:43:04 -08:00
.gitignore Improved install script 2019-04-11 15:05:14 -07:00
.gitmodules rm clif submodule; fix master 2019-07-10 10:38:38 -07:00
ARCHITECTURE.md Update ARCHITECTURE.md 2019-05-29 15:12:45 -07:00
ATTRIBUTIONS.md Fix formatting and grammar in documentation 2019-02-19 17:01:44 -07:00
bors.toml increase bors timeout threshold 2019-07-24 13:49:21 -07:00
Cargo.lock fix semver issue with clif 0.31 + new version of wasmparser 2019-07-25 10:38:20 -07:00
Cargo.toml Update to wabt 0.9.0. 2019-07-24 10:03:08 -07:00
CHANGELOG.md Improved CHANGELOG 2019-07-24 18:50:26 -07:00
Dockerfile Updated LLVM to 8.0 2019-07-22 14:04:17 -07:00
install.sh Update install.sh 2019-07-11 18:01:42 -07:00
LICENSE Update LICENSE author 2019-04-16 12:11:00 -07:00
logo.png Updated logo 2018-11-12 18:50:58 -08:00
Makefile further improve sandbox, rework syscalls, add tests 2019-07-18 17:14:01 -07:00
README.md Added Twitter badge 2019-07-24 18:35:57 -07:00
rustfmt.toml update rustfmt.toml to ignore and fmt 2019-07-15 10:43:30 -07:00
SECURITY.md Fix security contact 2019-05-27 14:41:18 -07:00

Wasmer logo

Build Status License Join the Wasmer Community Follow @wasmerio on Twitter

Introduction

Wasmer is a standalone JIT WebAssembly runtime, aiming to be fully compatible with WASI and Emscripten.

Install Wasmer with:

curl https://get.wasmer.io -sSfL | sh

Wasmer runtime can also be embedded in different languages, so you can use WebAssembly anywhere :

Usage

Wasmer can execute both the standard binary format (.wasm) and the text format defined by the WebAssembly reference interpreter (.wat).

Once installed, you will be able to run any WebAssembly files (including Lua, PHP, SQLite and nginx!):

# Run Lua
wasmer run examples/lua.wasm

You can find more wasm/wat examples in the examples directory.

With WAPM

Installing Wasmer through wasmer.io includes wapm, the WebAssembly Package Manager.

Wapm allows you to easily download, run, and distribute WebAssembly binaries.

# Install cowsay globally
wapm install -g cowsay

# Run cowsay
wapm run cowsay "Hello, world!"

For more information about wapm, check out the website and this example program.

Code Structure

Wasmer is structured into different directories:

  • src: code related to the Wasmer executable itself
  • lib: modularized libraries that Wasmer uses under the hood
  • examples: some useful examples to getting started with Wasmer

Dependencies

Building Wasmer requires rustup.

To build on Windows, download and run rustup-init.exe then follow the onscreen instructions.

To build on other systems, run:

curl https://sh.rustup.rs -sSf | sh

Other dependencies

Please select your operating system:

macOS

macOS

If you have Homebrew installed:

brew install cmake

Or, in case you have MacPorts:

sudo port install cmake

Debian-based Linuxes

Debian-based Linuxes

sudo apt install cmake pkg-config libssl-dev

FreeBSD

FreeBSD

pkg install cmake

Windows

Windows (MSVC)

Windows support is highly experimental. Only simple Wasm programs may be run, and no syscalls are allowed. This means nginx and Lua do not work on Windows. See this issue regarding Emscripten syscall polyfills for Windows.

  1. Install Visual Studio

  2. Install Rust for Windows

  3. Install Python for Windows. The Windows x86-64 MSI installer is fine. Make sure to enable "Add python.exe to Path" during installation.

  4. Install Git for Windows. Allow it to add git.exe to your PATH (default settings for the installer are fine).

  5. Install CMake. Ensure CMake is in your PATH.

  6. Install LLVM 8.0

Building

Wasmer is built with Cargo, the Rust package manager.

Set Rust Nightly:

rustup default nightly

And install Wasmer

# checkout code
git clone https://github.com/wasmerio/wasmer.git
cd wasmer

# install tools
# make sure that `python` is accessible.
make install

Testing

Thanks to spec tests we can ensure 100% compatibility with the WebAssembly spec test suite.

You can run all the tests with:

rustup default nightly
make test

Testing backends

Each backend can be tested separately:

  • Singlepass: make singlepass
  • Cranelift: make cranelift
  • LLVM: make llvm

Testing integrations

Each integration can be tested separately:

  • Spec tests: make spectests
  • Emscripten: make emtests
  • WASI: make wasi
  • Middleware: make middleware
  • C API: make capi

Benchmarking

Benchmarks can be run with:

make bench

Roadmap

Wasmer is an open project guided by strong principles, aiming to be modular, flexible and fast. It is open to the community to help set its direction.

Below are some of the goals of this project (in order of priority):

  • It should be 100% compatible with the WebAssembly spec tests
  • It should be fast (partially achieved)
  • Support WASI - released in 0.3.0
  • Support Emscripten calls (in the works)
  • Support Go js ABI calls

Architecture

If you would like to know how Wasmer works under the hood, please see ARCHITECTURE.md.

License

Wasmer is primarily distributed under the terms of the MIT license (LICENSE).

ATTRIBUTIONS