Skip to content
Cranelift code generator
Rust WebAssembly Shell
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Ensure builds are deterministic in CI. Dec 4, 2019
ci Ensure builds are deterministic in CI. Dec 4, 2019
cranelift-bforest Bump version to 0.51.0 (#1250) Nov 21, 2019
cranelift-codegen Fix some clippy warnings (#1277) Dec 7, 2019
cranelift-entity Fix some clippy warnings (#1277) Dec 7, 2019
cranelift-faerie Derive Debug for FaerieProduct (#1252) Nov 25, 2019
cranelift-filetests Bump version to 0.51.0 (#1250) Nov 21, 2019
cranelift-frontend Bump version to 0.51.0 (#1250) Nov 21, 2019
cranelift-module Bump version to 0.51.0 (#1250) Nov 21, 2019
cranelift-native Bump version to 0.51.0 (#1250) Nov 21, 2019
cranelift-object Use a published version of `object` Dec 2, 2019
cranelift-preopt Bump version to 0.51.0 (#1250) Nov 21, 2019
cranelift-reader Bump version to 0.51.0 (#1250) Nov 21, 2019
cranelift-serde Bump version to 0.51.0 (#1250) Nov 21, 2019
cranelift-simplejit Bump version to 0.51.0 (#1250) Nov 21, 2019
cranelift-umbrella Bump version to 0.51.0 (#1250) Nov 21, 2019
cranelift-wasm Add wasm reference/pointers translation. (#1073) Dec 6, 2019
docs Document the `test run` filetest mode (#1189) Oct 31, 2019
filetests More i8 legalizations (#1253) Dec 4, 2019
fuzz build: update everything to target-lexicon 0.9; Nov 6, 2019
media Check in the Crane and Ferris drawing so that people can remix it :-). Sep 13, 2018
src Add wasm reference/pointers translation. (#1073) Dec 6, 2019
tests [bugpoint] Implement replacing a single instruction by several ones; Oct 15, 2019
wasmtests [wasm] Include more large tests; Oct 23, 2019
.gitignore Add Emacs backup and autosave files to .gitignore. Oct 6, 2018
.rustfmt.toml More introductory documentation (#520) Sep 22, 2018
CODE_OF_CONDUCT.md Make it a Bytecode Alliance project (#1220) Nov 12, 2019
CONTRIBUTING.md Fix rendered links in CONTRIBUTING.md Nov 15, 2019
Cargo.toml Bump version to 0.51.0 (#1250) Nov 21, 2019
FUZZING.md Move URLs out of line and wrap long lines. Oct 5, 2018
LICENSE Adjust whitespace to match the upstream exception text. Oct 30, 2018
ORG_CODE_OF_CONDUCT.md Make it a Bytecode Alliance project (#1220) Nov 12, 2019
README.md Update build badge (#1264) Dec 2, 2019
SECURITY.md Make it a Bytecode Alliance project (#1220) Nov 12, 2019
clippy.toml Use clippy (#276) Mar 22, 2018
format-all.sh Fix shellcheck warnings in shell scripts. Jun 12, 2018
publish-all.sh publish cranelift-object to crates.io Dec 2, 2019
rustc.md Replace CraneStation by bytecodealliance everywhere; (#1221) Nov 12, 2019
spidermonkey.md Convert top-level *.rst files to markdown. Jul 17, 2018
test-all.sh Build documentation with private items in cranelift-codegen/meta Oct 31, 2019
test-no_std.sh Enable all-arch feature in test-no_std.sh Oct 2, 2019

README.md

Cranelift Code Generator

A Bytecode Alliance project

Cranelift is a low-level retargetable code generator. It translates a target-independent intermediate representation into executable machine code.

Documentation Status Build Status Fuzzit Status Gitter chat Minimum rustc 1.37

For more information, see the documentation.

For an example of how to use the JIT, see the SimpleJIT Demo, which implements a toy language.

For an example of how to use Cranelift to run WebAssembly code, see Wasmtime, which implements a standalone, embeddable, VM using Cranelift.

Status

Cranelift currently supports enough functionality to run a wide variety of programs, including all the functionality needed to execute WebAssembly MVP functions, although it needs to be used within an external WebAssembly embedding to be part of a complete WebAssembly implementation.

The x86-64 backend is currently the most complete and stable; other architectures are in various stages of development. Cranelift currently supports both the System V AMD64 ABI calling convention used on many platforms and the Windows x64 calling convention. The performance of code produced by Cranelift is not yet impressive, though we have plans to fix that.

The core codegen crates have minimal dependencies, support no_std mode (see below), and do not require any host floating-point support, and do not use callstack recursion.

Cranelift does not yet perform mitigations for Spectre or related security issues, though it may do so in the future. It does not currently make any security-relevant instruction timing guarantees. It has seen a fair amount of testing and fuzzing, although more work is needed before it would be ready for a production use case.

Cranelift's APIs are not yet stable.

Cranelift currently requires Rust 1.37 or later to build.

Contributing

If you're interested in contributing to Cranelift: thank you! We have a contributing guide which will help you getting involved in the Cranelift project.

Planned uses

Cranelift is designed to be a code generator for WebAssembly, but it is general enough to be useful elsewhere too. The initial planned uses that affected its design are:

Building Cranelift

Cranelift uses a conventional Cargo build process.

Cranelift consists of a collection of crates, and uses a Cargo Workspace, so for some cargo commands, such as cargo test, the --all is needed to tell cargo to visit all of the crates.

test-all.sh at the top level is a script which runs all the cargo tests and also performs code format, lint, and documentation checks.

Building with no_std

The following crates support `no_std`, although they do depend on liballoc:

  • cranelift-entity
  • cranelift-bforest
  • cranelift-codegen
  • cranelift-frontend
  • cranelift-native
  • cranelift-wasm
  • cranelift-module
  • cranelift-preopt
  • cranelift

To use no_std mode, disable the std feature and enable the core feature. This currently requires nightly rust.

For example, to build `cranelift-codegen`:

cd cranelift-codegen
cargo build --no-default-features --features core

Or, when using cranelift-codegen as a dependency (in Cargo.toml):

[dependency.cranelift-codegen]
...
default-features = false
features = ["core"]

no_std support is currently "best effort". We won't try to break it, and we'll accept patches fixing problems, however we don't expect all developers to build and test no_std when submitting patches. Accordingly, the ./test-all.sh script does not test no_std.

There is a separate ./test-no_std.sh script that tests the no_std support in packages which support it.

It's important to note that cranelift still needs liballoc to compile. Thus, whatever environment is used must implement an allocator.

Also, to allow the use of HashMaps with no_std, an external crate called hashmap_core is pulled in (via the core feature). This is mostly the same as std::collections::HashMap, except that it doesn't have DOS protection. Just something to think about.

Log configuration

Cranelift uses the log crate to log messages at various levels. It doesn't specify any maximal logging level, so embedders can choose what it should be; however, this can have an impact of Cranelift's code size. You can use log features to reduce the maximum logging level. For instance if you want to limit the level of logging to warn messages and above in release mode:

[dependency.log]
...
features = ["release_max_level_warn"]
Building the documentation

Cranelift's documentation is published online.

To build the documentation locally, you need the Sphinx documentation generator as well as Python 3::

$ pip install sphinx sphinx-autobuild sphinx_rtd_theme
$ cd cranelift/docs
$ make html
$ open _build/html/index.html

Editor Support

Editor support for working with Cranelift IR (clif) files:

You can’t perform that action at this time.