Crate wasmer_asml_fork[−][src]
Expand description
This crate contains the wasmer API. The wasmer API facilitates the efficient,
sandboxed execution of WebAssembly (Wasm) modules.
Here’s an example of the wasmer API in action:
use wasmer::{Store, Module, Instance, Value, imports};
fn main() -> anyhow::Result<()> {
let module_wat = r#"
(module
(type $t0 (func (param i32) (result i32)))
(func $add_one (export "add_one") (type $t0) (param $p0 i32) (result i32)
get_local $p0
i32.const 1
i32.add))
"#;
let store = Store::default();
let module = Module::new(&store, &module_wat)?;
// The module doesn't import anything, so we create an empty import object.
let import_object = imports! {};
let instance = Instance::new(&module, &import_object)?;
let add_one = instance.exports.get_function("add_one")?;
let result = add_one.call(&[Value::I32(42)])?;
assert_eq!(result[0], Value::I32(43));
Ok(())
}For more examples of using the wasmer API, check out the
wasmer examples.
Table of Contents
Wasm Primitives
In order to make use of the power of the wasmer API, it’s important
to understand the primitives around which the API is built.
Wasm only deals with a small number of core data types, these data
types can be found in the Value type.
In addition to the core Wasm types, the core types of the API are referred to as “externs”.
Externs
An Extern is a type that can be imported or exported from a Wasm
module.
To import an extern, simply give it a namespace and a name with the
imports macro:
let memory = Memory::new(&store, MemoryType::new(1, None, false)).unwrap();
imports! {
"env" => {
"my_function" => Function::new_native(store, || println!("Hello")),
"memory" => memory,
}
}And to access an exported extern, see the Exports API, accessible
from any instance via instance.exports:
let memory = instance.exports.get_memory("memory")?;
let memory: &Memory = instance.exports.get("some_other_memory")?;
let add: NativeFunc<(i32, i32), i32> = instance.exports.get_native_function("add")?;
let result = add.call(5, 37)?;
assert_eq!(result, 42);These are the primary types that the wasmer API uses.
Functions
There are 2 types of functions in wasmer:
- Wasm functions
- Host functions
A Wasm function is a function defined in a WebAssembly module that can only perform computation without side effects and call other functions.
Wasm functions take 0 or more arguments and return 0 or more results.
Wasm functions can only deal with the primitive types defined in
Value.
A Host function is any function implemented on the host, in this case in Rust.
Host functions can optionally be created with an environment that
implements WasmerEnv. This environment is useful for maintaining
host state (for example the filesystem in WASI).
Thus WebAssembly modules by themselves cannot do anything but computation
on the core types in Value. In order to make them more useful we
give them access to the outside world with imports.
If you’re looking for a sandboxed, POSIX-like environment to execute Wasm
in, check out the wasmer-wasi crate for our implementation of WASI,
the WebAssembly System Interface.
In the wasmer API we support functions which take their arguments and
return their results dynamically, Function, and functions which
take their arguments and return their results statically, NativeFunc.
Memories
Memories store data.
In most Wasm programs, nearly all data will live in a Memory.
This data can be shared between the host and guest to allow for more interesting programs.
Globals
A Global is a type that may be either mutable or immutable, and
contains one of the core Wasm types defined in Value.
Tables
A Table is an indexed list of items.
Project Layout
The Wasmer project is divided into a number of crates, below is a dependency graph with transitive dependencies removed.
While this crate is the top level API, we also publish crates built on top of this API that you may be interested in using, including:
- wasmer-cache for caching compiled Wasm modules.
- wasmer-emscripten for running Wasm modules compiled to the Emscripten ABI.
- wasmer-wasi for running Wasm modules compiled to the WASI ABI.
The Wasmer project has two major abstractions:
These two abstractions have multiple options that can be enabled with features.
Engines
An engine is a system that uses a compiler to make a WebAssembly module executable.
Compilers
A compiler is a system that handles the details of making a Wasm module executable. For example, by generating native machine code for each Wasm function.
Features
This crate’s features can be broken down into 2 kinds, features that enable new functionality and features that set defaults.
The features that enable new functionality are:
universal- enable the Universal engine. (See wasmer-universal)native- enable the native engine. (See wasmer-native)cranelift- enable Wasmer’s Cranelift compiler. (See wasmer-cranelift)llvm- enable Wasmer’s LLVM compiler. (See wasmer-llvm)singlepass- enable Wasmer’s Singlepass compiler. (See wasmer-singlepass)wat- enablewasmerto parse the WebAssembly text format.
The features that set defaults come in sets that are mutually exclusive.
The first set is the default compiler set:
default-cranelift- set Wasmer’s Cranelift compiler as the default.default-llvm- set Wasmer’s LLVM compiler as the default.default-singlepass- set Wasmer’s Singlepass compiler as the default.
The next set is the default engine set:
default-universal- set the Universal engine as the default.default-native- set the native engine as the default.
By default the wat, default-cranelift, and default-universal features
are enabled.
Re-exports
pub use wasmer_compiler::wasmparser;Modules
The vm module re-exports wasmer-vm types.
Macros
Generate an ImportObject easily with the imports! macro.
Structs
The Array marker type. This type can be used like WasmPtr<T, Array>
to get access to methods
Atomically.
Tunable parameters for WebAssembly compilation.
This is the reference implementation of the Tunables trait,
used by default.
Units of WebAssembly memory in terms of 8-bit bytes.
Global configuration options used to create an
wasmer_engine::Engine and customize its behavior.
A descriptor for an exported WebAssembly value.
Exports is a special kind of map that allows easily unwrapping the types of instances.
An iterator over exports.
Controls which experimental features will be enabled. Features usually have a corresponding WebAssembly proposal.
Description of a frame in a backtrace for a RuntimeError::trace.
A WebAssembly function instance.
The signature of a function that is either implemented in a Wasm module or exposed to Wasm by the host.
A WebAssembly global instance.
WebAssembly global.
All of the import data used when instantiating.
Iterator for an ImportObject’s exports.
A descriptor for an imported value into a wasm module.
The Item marker type. This is the default and does not usually need to be
specified.
Lazily init an item
Index type of a function defined locally inside the WebAssembly module.
A WebAssembly memory instance.
A descriptor for a WebAssembly memory type.
A view into a memory.
A error in the middleware.
The state of the binary reader. Exposed to middlewares to push their outputs.
A WebAssembly Module contains stateless WebAssembly code that has already been compiled and can be instantiated multiple times.
A Resolver that links two resolvers together in a chain.
A WebAssembly function that can be called natively (using the Native ABI).
Units of WebAssembly pages (as specified to be 65,536 bytes).
A struct representing an aborted instruction execution, with a message indicating the cause.
The store represents all global state that can be manipulated by WebAssembly programs. It consists of the runtime representation of all instances of functions, tables, memories, and globals that have been allocated during the lifetime of the abstract machine.
A WebAssembly table instance.
A descriptor for a table in a WebAssembly module.
This is the target that we will use for compiling the WebAssembly ModuleInfo, and then run it.
A target “triple”. Historically such things had three fields, though they’ve added additional fields over time.
The Universal builder
A compiled wasm module, ready to be instantiated.
A WebAssembly Universal Engine.
A zero-cost type that represents a pointer to something in Wasm linear memory.
Enums
The “architecture” field, which in some cases also specifies a specific subarchitecture.
The calling convention, which specifies things like which registers are used for passing arguments, which registers are callee-saved, and so on.
The WebAssembly.CompileError object indicates an error during WebAssembly decoding or validation.
The nomenclature is inspired by the cpuid crate.
The list of supported features was initially retrieved from
cranelift-native.
Possible optimization levels for the Cranelift codegen backend.
The Deserialize error can occur when loading a compiled Module from a binary.
The value of an export passed from one instance to another.
An entity to export.
An Extern is the runtime representation of an entity that
can be imported or exported.
A list of all possible types which can be externally referenced from a WebAssembly module.
Globals are initialized via the const operators or by referring to another import.
An error while initializing the user supplied host env with the WasmerEnv trait.
An error while instantiating a module.
The WebAssembly.LinkError object indicates an error during module instantiation (besides traps from the start function).
Error type describing things that can go wrong when operating on Wasm Memories.
Indicator of whether a global is mutable or not
The “operating system” field, which sometimes implies an environment, and sometimes isn’t an actual operating system.
The error that can happen while parsing a str
to retrieve a CpuFeature.
The Serialize error can occur when serializing a compiled Module into a binary.
A list of all possible value types in WebAssembly.
A list of all possible value types in WebAssembly.
A WebAssembly translation error.
Constants
The Triple of the current host.
Version number of this crate.
The number of pages we can have before we run out of byte index space.
The minimum number of pages allowed.
WebAssembly page sizes are fixed to be 64KiB. Note: large page support may be added in an opt-in manner in the future.
Traits
A trait for chaining resolvers together.
The compiler configuration options.
A unimplemented Wasmer Engine.
This trait is used to mark types as gettable from an Instance.
A trait to convert a Rust value to a WasmNativeType value,
or to convert WasmNativeType value to a Rust value.
A function middleware specialized for a single function.
The HostFunction trait represents the set of functions that
can be used as host function. To uphold this statement, it is
necessary for a function to be transformed into a pointer to
VMFunctionBody.
The LikeNamespace trait represents objects that act as a namespace for imports.
For example, an Instance or Namespace could be
considered namespaces that could provide imports to an instance.
A shared builder for function middlewares.
Import resolver connects imports with available exported values.
Import resolver connects imports with available exported values.
A trait represinting any object that lives in the Store.
An engine delegates the creation of memories, tables, and globals to a foreign implementor of this trait.
Trait for a Value type. A Value type is a type that is always valid and may be safely copied.
The WasmTypeList trait represents a tuple (list) of Wasm
typed values. It is used to get low-level representation of
such a tuple.
Trait for initializing the environments passed to host functions after instantiation but before execution.
Functions
Check if the provided bytes are wasm-like
Raises a user-defined trap immediately.
Parses in-memory bytes as either the WebAssembly Text format, or a binary WebAssembly module.
Type Definitions
WebAssembly computations manipulate values of basic value types:
WebAssembly computations manipulate values of basic value types:
A convenient alias for a Result that uses WasmError as the error type.