Struct cranelift_codegen::Context

pub struct Context {
    pub func: Function,
    pub cfg: ControlFlowGraph,
    pub domtree: DominatorTree,
    pub loop_analysis: LoopAnalysis,
    pub mach_compile_result: Option<MachCompileResult>,
    pub want_disasm: bool,
}

Persistent data structures and compilation pipeline.

Fields

func: Function

The function we’re compiling.

cfg: ControlFlowGraph

The control flow graph of func.

domtree: DominatorTree

Dominator tree for func.

loop_analysis: LoopAnalysis

Loop analysis of func.

mach_compile_result: Option<MachCompileResult>

Result of MachBackend compilation, if computed.

want_disasm: bool

Flag: do we want a disassembly with the MachCompileResult?

Implementations

impl Context

pub fn new() -> Self

Allocate a new compilation context.

The returned instance should be reused for compiling multiple functions in order to avoid needless allocator thrashing.

pub fn for_function(func: Function) -> Self

Allocate a new compilation context with an existing Function.

The returned instance should be reused for compiling multiple functions in order to avoid needless allocator thrashing.

pub fn clear(&mut self)

Clear all data structures in this context.

pub fn set_disasm(&mut self, val: bool)

Set the flag to request a disassembly when compiling with a MachBackend backend.

pub fn compile_and_emit(
    &mut self,
    isa: &dyn TargetIsa,
    mem: &mut Vec<u8>
) -> CodegenResult<()>

Compile the function, and emit machine code into a Vec<u8>.

Run the function through all the passes necessary to generate code for the target ISA represented by isa, as well as the final step of emitting machine code into a Vec<u8>. The machine code is not relocated. Instead, any relocations can be obtained from mach_compile_result.

This function calls compile and emit_to_memory, taking care to resize mem as needed, so it provides a safe interface.

Returns information about the function’s code and read-only data.

pub fn compile(&mut self, isa: &dyn TargetIsa) -> CodegenResult<CodeInfo>

Compile the function.

Run the function through all the passes necessary to generate code for the target ISA represented by isa. This does not include the final step of emitting machine code into a code sink.

Returns information about the function’s code and read-only data.

pub unsafe fn emit_to_memory(&self, mem: *mut u8) -> CodeInfo

Emit machine code directly into raw memory.

Write all of the function’s machine code to the memory at mem. The size of the machine code is returned by compile above.

The machine code is not relocated. Instead, any relocations can be obtained from mach_compile_result.

Safety

This function is unsafe since it does not perform bounds checking on the memory buffer, and it can’t guarantee that the mem pointer is valid.

Returns information about the emitted code and data.

pub fn get_code_bb_layout(&self) -> Option<(Vec<usize>, Vec<(usize, usize)>)>

If available, return information about the code layout in the final machine code: the offsets (in bytes) of each basic-block start, and all basic-block edges.

pub fn create_unwind_info(
    &self,
    isa: &dyn TargetIsa
) -> CodegenResult<Option<UnwindInfo>>

Creates unwind information for the function.

Returns None if the function has no unwind information.

pub fn verify<'a, FOI: Into<FlagsOrIsa<'a>>>(
    &self,
    fisa: FOI
) -> VerifierResult<()>

Run the verifier on the function.

Also check that the dominator tree and control flow graph are consistent with the function.

pub fn verify_if<'a, FOI: Into<FlagsOrIsa<'a>>>(
    &self,
    fisa: FOI
) -> CodegenResult<()>

Run the verifier only if the enable_verifier setting is true.

pub fn dce<'a, FOI: Into<FlagsOrIsa<'a>>>(
    &mut self,
    fisa: FOI
) -> CodegenResult<()>

Perform dead-code elimination on the function.

pub fn remove_constant_phis<'a, FOI: Into<FlagsOrIsa<'a>>>(
    &mut self,
    fisa: FOI
) -> CodegenResult<()>

Perform constant-phi removal on the function.

pub fn preopt(&mut self, isa: &dyn TargetIsa) -> CodegenResult<()>

Perform pre-legalization rewrites on the function.

pub fn canonicalize_nans(&mut self, isa: &dyn TargetIsa) -> CodegenResult<()>

Perform NaN canonicalizing rewrites on the function.

pub fn legalize(&mut self, isa: &dyn TargetIsa) -> CodegenResult<()>

Run the legalizer for isa on the function.

pub fn compute_cfg(&mut self)

Compute the control flow graph.

pub fn compute_domtree(&mut self)

Compute dominator tree.

pub fn compute_loop_analysis(&mut self)

Compute the loop analysis.

pub fn flowgraph(&mut self)

Compute the control flow graph and dominator tree.

pub fn simple_gvn<'a, FOI: Into<FlagsOrIsa<'a>>>(
    &mut self,
    fisa: FOI
) -> CodegenResult<()>

Perform simple GVN on the function.

pub fn licm(&mut self, isa: &dyn TargetIsa) -> CodegenResult<()>

Perform LICM on the function.

pub fn eliminate_unreachable_code<'a, FOI>(
    &mut self,
    fisa: FOI
) -> CodegenResult<()> where
    FOI: Into<FlagsOrIsa<'a>>, 

Perform unreachable code elimination.

pub fn replace_redundant_loads(&mut self) -> CodegenResult<()>

Replace all redundant loads with the known values in memory. These are loads whose values were already loaded by other loads earlier, as well as loads whose values were stored by a store instruction to the same instruction (so-called “store-to-load forwarding”).