T0b1/wasmtime
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add more documentation about Module and Backend.

Browse Source
This commit is contained in:
Dan Gohman
2018-09-05 15:19:14 -07:00
parent 437a657899
commit f3c46ad2a2
4 changed files with 28 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
lib/module/README.md
View File

@@ -1,7 +1,20 @@
This crate provides the `Module` trait, which provides an interface for
multiple functions and data to be emitted with
This crate provides module-level functionality, which allow multiple
functions and data to be emitted with
[Cranelift](https://crates.io/crates/cranelift) and then linked together.
This crate is structured as an optional layer on top of cranelift-codegen.
It provides additional functionality, such as linking, however users that
require greater flexibility don't need to use it.
A `Module` is a collection of functions and data objects that are linked
together. `Backend` is a trait that defines an interface for backends
that compile modules into various forms. Most users will use one of the
following `Backend` implementations:
- `SimpleJITBackend`, provided by [cranelift-simplejit], which JITs
code to memory for direct execution.
- `FaerieBackend`, provided by [cranelift-faerie], which emits native
object files.
[cranelift-simplejit]: https://crates.io/crates/cranelift-simplejit
[cranelift-faerie]: https://crates.io/crates/cranelift-faerie