43b761ef5f
* Update the top-level README.md and embedding documentation. wasmtime-api is now the primary external API crate, so recommend that instead of wasmtime-jit. Also, enable wasmtime-api's C API by default, so that it shows up on docs.rs, and to make it easier to use. And, add basic embedding documentation and link to it from the README.md. Credit to @yurydelendik for the content. * Use the new wasm-c-api URL. * Don't pass --features wasm-c-api, as it is now on by default.
59 lines
2.8 KiB
Markdown
59 lines
2.8 KiB
Markdown
# Wasmtime: a WebAssembly Runtime.
|
|
|
|
Wasmtime is a standalone wasm-only optimizing runtime for [WebAssembly] and
|
|
[WASI]. It runs WebAssembly code [outside of the Web], and can be used both
|
|
as a command-line utility or as a library embedded in a larger application.
|
|
|
|
To get started, visit [wasmtime.dev](https://wasmtime.dev/).
|
|
|
|
[WebAssembly]: https://webassembly.org/
|
|
[WASI]: https://wasi.dev
|
|
[outside of the Web]: https://webassembly.org/docs/non-web/
|
|
|
|
[](https://dev.azure.com/CraneStation/Wasmtime/_build/latest?definitionId=4&branchName=master)
|
|
[](https://gitter.im/CraneStation/Lobby)
|
|
|
|
|
|
There are Rust, C, and C++ toolchains that can compile programs with WASI. See
|
|
the [WASI intro][WASI intro] for more information, and the [WASI tutorial][WASI tutorial]
|
|
for a tutorial on compiling and running programs using WASI and wasmtime, as
|
|
well as an overview of the filesystem sandboxing system.
|
|
|
|
Wasmtime passes the [WebAssembly spec testsuite]. To run it, update the
|
|
`spec_testsuite` submodule with `git submodule update --remote`, and it will
|
|
be run as part of `cargo test`.
|
|
|
|
Wasmtime does not yet implement Spectre mitigations, however this is a subject
|
|
of ongoing research.
|
|
|
|
[WebAssembly spec testsuite]: https://github.com/WebAssembly/testsuite
|
|
[CloudABI]: https://cloudabi.org/
|
|
[WebAssembly System Interface]: docs/WASI-overview.md
|
|
[WASI intro]: docs/WASI-intro.md
|
|
[WASI tutorial]: docs/WASI-tutorial.md
|
|
|
|
Additional goals for Wasmtime include:
|
|
- Support a variety of host APIs (not just WASI), with fast calling sequences,
|
|
and develop proposals for additional API modules to be part of WASI.
|
|
- Facilitate development and testing around the [Cranelift] and [Lightbeam] JITs,
|
|
and other WebAssembly execution strategies.
|
|
- Develop a native ABI used for compiling WebAssembly suitable for use in both
|
|
JIT and AOT to native object files.
|
|
|
|
[Cranelift]: https://github.com/CraneStation/cranelift
|
|
[Lightbeam]: https://github.com/CraneStation/wasmtime/tree/master/lightbeam
|
|
|
|
#### Including Wasmtime in your project
|
|
|
|
Wasmtime exposes an API for embedding as a library through the `wasmtime-api` subcrate,
|
|
which contains both a [high-level and safe Rust API], as well as a C-compatible API
|
|
compatible with the [proposed WebAssembly C API].
|
|
|
|
For more information, see the [Rust API embedding chapter] of the Wasmtime documentation.
|
|
|
|
[high-level and safe Rust API]: https://docs.rs/wasmtime-api/
|
|
[proposed WebAssembly C API]: https://github.com/WebAssembly/wasm-c-api
|
|
[Rust API embedding chapter]: https://cranestation.github.io/wasmtime/embed-rust.html
|
|
|
|
It's Wasmtime.
|