Crate cranelift_codegen

Cranelift code generation library.

Re-exports

• pub use crate::verifier::verify_function;
• pub use crate::write::write_function;
• pub use cranelift_bforest as bforest;
• pub use cranelift_control as control;
• pub use cranelift_entity as entity;
• pub use gimli;

Modules

• binemit
  Binary machine code emission.
• cfg_printer
  The CFGPrinter utility.
• cursor
  Cursor library.
• data_value
  This module gives users to instantiate values that Cranelift understands. These values are used, for example, during interpretation and for wrapping immediates.
• dbg
  Debug tracing helpers.
• dominator_tree
  A Dominator Tree represented as mappings of Blocks to their immediate dominator.
• flowgraph
  A control flow graph represented as mappings of basic blocks to their predecessors and successors.
• ir
  Representation of Cranelift IR functions.
• isa
  Instruction Set Architectures.
• loop_analysis
  A loop analysis represented as mappings of loops to their header Block and parent in the loop tree.
• packed_option
  Compact representation of Option<T> for types with a reserved value.
• print_errors
  Utility routines for pretty-printing error messages.
• settings
  Shared settings module.
• timing
  Pass timing.
• verifier
  A verifier for ensuring that functions are well formed. It verifies:
• write
  Converting Cranelift IR to text.

Macros

• trace
  Even when trace logging is disabled, the trace macro has a significant performance cost so we disable it by default.

Structs

• CompileError
  Compilation error, with the accompanying function to help printing it.
• Context
  Persistent data structures and compilation pipeline.
• Final
  Status of a compiled artifact ready to use.
• MachBuffer
  A buffer of output to be produced, fixed up, and then emitted to a CodeSink in bulk.
• MachBufferFinalized
  A MachBuffer once emission is completed: holds generated code and records, without fixups. This allows the type to be independent of the backend.
• MachCallSite
  A call site record resulting from a compilation.
• MachLabel
  A label refers to some offset in a MachBuffer. It may not be resolved at the point at which it is used by emitted code; the buffer records “fixups” for references to the label, and will come back and patch the code appropriately when the label’s location is eventually known.
• MachSrcLoc
  A source-location mapping resulting from a compilation.
• MachStackMap
  Record of stack map metadata: stack offsets containing references.
• MachTextSectionBuilder
  Implementation of the TextSectionBuilder trait backed by MachBuffer.
• MachTrap
  A trap record resulting from a compilation.
• Reg
  A register named in an instruction. This register can be either a virtual register or a fixed physical register. It does not have any constraints applied to it: those can be added later in MachInst::get_operands() when the Regs are converted to Operands.
• VCodeConstants
  This structure tracks the large constants used in VCode that will be emitted separately by the MachBuffer.
• ValueLocRange
  Value location range.
• Writable
  A type wrapper that indicates a register type is writable. The underlying register can be extracted, and the type wrapper can be built using an arbitrary register. Hence, this type-level wrapper is not strictly a guarantee. However, “casting” to a writable register is an explicit operation for which we can audit. Ordinarily, internal APIs in the compiler backend should take a Writable<Reg> whenever the register is written, and the usual, frictionless way to get one of these is to allocate a new temporary.

Enums

• CodegenError
  A compilation error.
• FinalizedRelocTarget
  A Relocation target
• LabelValueLoc
  The particular location for a value.
• VCodeConstantData
  Identify the different types of constant that can be inserted into VCodeConstants. Tracking these separately instead of as raw byte buffers allows us to avoid some duplication.

Constants

• VERSION
  Version number of this crate.

Traits

• MachInst
  A machine instruction.
• MachInstEmit
  A trait describing the ability to encode a MachInst into binary machine code.
• MachInstEmitState
  A trait describing the emission state carried between MachInsts when emitting a function body.
• TextSectionBuilder
  An object that can be used to create the text section of an executable.

Type Aliases

• CodegenResult
  A convenient alias for a Result that uses CodegenError as the error type.
• CompiledCode
  CompiledCode in its final form (i.e. after FunctionParameters have been applied), ready for consumption.
• FinalizedMachReloc
  A relocation resulting from a compilation.
• ValueLabelsRanges
  Resulting map of Value labels and their ranges/locations.