T0b1/wasmtime
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
001d91c73c34ddba2c11df7c23d3b754d91f08c9
wasmtime/cranelift/docs/index.md
Chris Fallin b6bed81ba2 Add ISLE reference documentation. 
This documentation provides details for all of the ISLE language
features, and detailed rationale for why many of them are designed in
the way that they are. It is hopefully both a reasonable tutorial and
reference for someone looking to understand the DSL.

Note that this documentation is separate from and orthogonal to the
work to document the Cranelift bindings and integration work that
@fitzgen has covered well in #3556. This document can link to that one
and vice-versa once they are both in-tree.
2021-11-30 11:42:17 -08:00

2.3 KiB
Raw Blame History

Cranelift Documentation

Miscellaneous documentation pages:

  • Cranelift IR Cranelift IR is the data structure that most of the compiler operates on.

  • Testing Cranelift This page documents Cranelift's testing frameworks.

  • Cranelift compared to LLVM LLVM and Cranelift have similarities and differences.

  • Cranelift's register allocator This page document Cranelift's current register allocator.

  • ISLE This page documents the domain-specific language (DSL), ISLE, that we use to define instruction-lowering patterns.

Cranelift crate documentation:

  • cranelift This is an umbrella crate that re-exports the codegen and frontend crates, to make them easier to use.

  • cranelift-codegen This is the core code generator crate. It takes Cranelift IR as input and emits encoded machine instructions, along with symbolic relocations, as output.

  • cranelift-codegen-meta This crate contains the meta-language utilities and descriptions used by the code generator.

  • cranelift-wasm This crate translates WebAssembly code into Cranelift IR.

  • cranelift-frontend This crate provides utilities for translating code into Cranelift IR.

  • cranelift-native This crate performs auto-detection of the host, allowing Cranelift to generate code optimized for the machine it's running on.

  • cranelift-reader This crate translates from Cranelift IR's text format into Cranelift IR in in-memory data structures.

  • cranelift-module This crate manages compiling multiple functions and data objects together.

  • cranelift-object This crate provides a object-based backend for cranelift-module, which emits native object files using the object <https://github.com/gimli-rs/object>_ library.

  • cranelift-jit This crate provides a JIT backend for cranelift-module, which emits code and data into memory.