Struct cranelift_codegen::loop_analysis::LoopAnalysis

pub struct LoopAnalysis { /* fields omitted */ }

Loop tree information for a single function.

Loops are referenced by the Loop object, and for each loop you can access its header block, its eventual parent in the loop tree and all the block belonging to the loop.

Implementations

impl LoopAnalysis

Methods for querying the loop analysis.

pub fn new() -> Self

Allocate a new blank loop analysis struct. Use compute to compute the loop analysis for a function.

pub fn loops(&self) -> Keys<Loop>

Returns all the loops contained in a function.

pub fn loop_header(&self, lp: Loop) -> Block

Returns the header block of a particular loop.

The characteristic property of a loop header block is that it dominates some of its predecessors.

pub fn loop_parent(&self, lp: Loop) -> Option<Loop>

Return the eventual parent of a loop in the loop tree.

pub fn is_in_loop(&self, block: Block, lp: Loop) -> bool

Determine if a Block belongs to a loop by running a finger along the loop tree.

Returns true if block is in loop lp.

pub fn is_child_loop(&self, child: Loop, parent: Loop) -> bool

Determines if a loop is contained in another loop.

is_child_loop(child,parent) returns true if and only if child is a child loop of parent (or child == parent).

impl LoopAnalysis

pub fn compute(
    &mut self,
    func: &Function,
    cfg: &ControlFlowGraph,
    domtree: &DominatorTree
)

Detects the loops in a function. Needs the control flow graph and the dominator tree.

pub fn is_valid(&self) -> bool

Check if the loop analysis is in a valid state.

Note that this doesn’t perform any kind of validity checks. It simply checks if the compute() method has been called since the last clear(). It does not check that the loop analysis is consistent with the CFG.

pub fn clear(&mut self)

Clear all the data structures contained in the loop analysis. This will leave the analysis in a similar state to a context returned by new() except that allocated memory be retained.