39 releases (3 stable)

2.0.0-rc1 Jun 2, 2021
1.0.2 Feb 5, 2021
1.0.1 Jan 13, 2021
1.0.0-rc1 Dec 23, 2020
0.5.7 Jul 23, 2019

#5 in WebAssembly

Download history 415/week @ 2021-02-23 340/week @ 2021-03-02 304/week @ 2021-03-09 172/week @ 2021-03-16 349/week @ 2021-03-23 340/week @ 2021-03-30 388/week @ 2021-04-06 517/week @ 2021-04-13 3445/week @ 2021-04-20 1548/week @ 2021-04-27 1311/week @ 2021-05-04 1657/week @ 2021-05-11 1063/week @ 2021-05-18 1053/week @ 2021-05-25 628/week @ 2021-06-01 434/week @ 2021-06-08

4,156 downloads per month
Used in 9 crates (8 directly)

MIT license

460KB
9K SLoC

wasmer-wasi Build Status Join Wasmer Slack MIT License crates.io

This crate provides the necessary imports to use WASI easily from Wasmer. WebAssembly System Interface (WASI for short) is a modular system interface for WebAssembly. WASI is being standardized in the WebAssembly subgroup.

Very succinctly, from the user perspective, WASI is a set of WebAssembly module imports under a specific namespace (which varies based on the WASI version). A program compiled for the wasm32-wasi target will be able to support standard I/O, file I/O, filesystem manipulation, memory management, time, string, environment variables, program startup etc.

This crate provides the necessary API to create the imports to use WASI easily from the Wasmer runtime, through our ImportObject API.

Supported WASI versions

WASI version Support
wasi_unstable
wasi_snapshot_preview1

The special Latest version points to wasi_snapshot_preview1.

Learn more about the WASI version process (ephemeral, snapshot, old).

Usage

Let's consider the following hello.rs Rust program:

fn main() {
    println!("Hello, {:?}", std::env::args().nth(1));
}

Then, let's compile it to a WebAssembly module with WASI support:

$ rustc --target wasm32-wasi hello.rs

Finally, let's execute it with the wasmer CLI:

$ wasmer run hello.wasm Gordon
Hello, Some("Gordon")

… and programatically with the wasmer and the wasmer-wasi libraries:

use wasmer::{Store, Module, Instance};
use wasmer_wasi::WasiState;

let store = Store::default();
let module = Module::from_file(&store, "hello.wasm")?;

// Create the `WasiEnv`.
let wasi_env = WasiState::new("command-name")
    .args(&["Gordon"])
    .finalize()?;

// Generate an `ImportObject`.
let import_object = wasi_env.import_object(&module)?;

// Let's instantiate the module with the imports.
let instance = Instance::new(&module, &import_object)?;

// Let's call the `_start` function, which is our `main` function in Rust.
let start = instance.exports.get_function("_start")?;
start.call(&[])?;

Check the fully working example using WASI.

More resources

This library is about the WASI implementation inside the Wasmer runtime. It contains documentation about the implementation itself. However, if you wish to learn more about WASI, here is a list of links that may help you:

  • wasi-libc, WASI libc implementation for WebAssembly programs built on top of WASI system calls. It provides a wide array of POSIX-compatible C APIs, including support for standard I/O, file I/O, filesystem manipulation, memory management, time, string, environment variables, program startup, and many other APIs,
  • wasi-sdk, WASI-enabled WebAssembly C/C++ toolchain, based on wasi-libc,
  • WASI API documentation,
  • WASI C API header file,
  • WASI Application Binary Interface (ABI), where we learn about _start and _initialize (for reactors) for example.

Dependencies

~8MB
~162K SLoC