Struct rustc_mir::dataflow::framework::engine::Engine

pub struct Engine<'a, 'tcx, A> where
    A: Analysis<'tcx>,  {
    tcx: TyCtxt<'tcx>,
    body: &'a Body<'tcx>,
    dead_unwinds: Option<&'a BitSet<BasicBlock>>,
    entry_sets: IndexVec<BasicBlock, A::Domain>,
    pass_name: Option<&'static str>,
    analysis: A,
    apply_trans_for_block: Option<Box<dyn Fn(BasicBlock, &mut A::Domain)>>,
}

A solver for dataflow problems.

Fields

tcx: TyCtxt<'tcx>

body: &'a Body<'tcx>

dead_unwinds: Option<&'a BitSet<BasicBlock>>

entry_sets: IndexVec<BasicBlock, A::Domain>

pass_name: Option<&'static str>

analysis: A

apply_trans_for_block: Option<Box<dyn Fn(BasicBlock, &mut A::Domain)>>

Cached, cumulative transfer functions for each block.

Implementations

impl<A, D, T, 'tcx, 'a> Engine<'a, 'tcx, A> where
    A: GenKillAnalysis<'tcx, Idx = T, Domain = D>,
    D: Clone + JoinSemiLattice + GenKill<T> + BorrowMut<BitSet<T>>,
    T: Idx, 

pub fn new_gen_kill(
    tcx: TyCtxt<'tcx>,
    body: &'a Body<'tcx>,
    analysis: A
) -> Self

Creates a new Engine to solve a gen-kill dataflow problem.

impl<A, D, 'tcx, 'a> Engine<'a, 'tcx, A> where
    A: Analysis<'tcx, Domain = D>,
    D: Clone + JoinSemiLattice, 

pub fn new_generic(tcx: TyCtxt<'tcx>, body: &'a Body<'tcx>, analysis: A) -> Self

Creates a new Engine to solve a dataflow problem with an arbitrary transfer function.

Gen-kill problems should use new_gen_kill, which will coalesce transfer functions for better performance.

pub(in dataflow::framework::engine) fn new(
    tcx: TyCtxt<'tcx>,
    body: &'a Body<'tcx>,
    analysis: A,
    apply_trans_for_block: Option<Box<dyn Fn(BasicBlock, &mut A::Domain)>>
) -> Self

pub fn dead_unwinds(self, dead_unwinds: &'a BitSet<BasicBlock>) -> Self

Signals that we do not want dataflow state to propagate across unwind edges for these BasicBlocks.

You must take care that dead_unwinds does not contain a BasicBlock that can actually unwind during execution. Otherwise, your dataflow results will not be correct.

pub fn pass_name(self, name: &'static str) -> Self

Adds an identifier to the graphviz output for this particular run of a dataflow analysis.

Some analyses are run multiple times in the compilation pipeline. Give them a pass_name to differentiate them. Otherwise, only the results for the latest run will be saved.

pub fn iterate_to_fixpoint(self) -> Results<'tcx, A> where
    A::Domain: DebugWithContext<A>, 

Computes the fixpoint for this dataflow problem and returns it.