Trait rustc_mir::dataflow::framework::AnalysisDomain

pub trait AnalysisDomain<'tcx>: BottomValue {
    type Idx: Idx;
    type Direction: Direction = Forward;

    const NAME: &'static str;

    fn bits_per_block(&self, body: &Body<'tcx>) -> usize;
    fn initialize_start_block(
        &self, 
        body: &Body<'tcx>, 
        state: &mut BitSet<Self::Idx>
    );

    fn pretty_print_idx(&self, w: &mut impl Write, idx: Self::Idx) -> Result<()> { ... }
}

Define the domain of a dataflow problem.

This trait specifies the lattice on which this analysis operates. For now, this must be a powerset of values of type Idx. The elements of this lattice are represented with a BitSet and referred to as the state vector.

This trait also defines the initial value for the dataflow state upon entry to the START_BLOCK, as well as some names used to refer to this analysis when debugging.

Associated Types

type Idx: Idx

The type of the elements in the state vector.

type Direction: Direction = Forward

The direction of this analyis. Either Forward or Backward.

Loading content...

Associated Constants

const NAME: &'static str

A descriptive name for this analysis. Used only for debugging.

This name should be brief and contain no spaces, periods or other characters that are not suitable as part of a filename.

Loading content...

Required methods

fn bits_per_block(&self, body: &Body<'tcx>) -> usize

The size of the state vector.

fn initialize_start_block(
    &self,
    body: &Body<'tcx>,
    state: &mut BitSet<Self::Idx>
)

Mutates the entry set of the START_BLOCK to contain the initial state for dataflow analysis.

For backward analyses, initial state besides the bottom value is not yet supported. Trying to mutate the initial state will result in a panic.

Loading content...

Provided methods

fn pretty_print_idx(&self, w: &mut impl Write, idx: Self::Idx) -> Result<()>

Prints an element in the state vector for debugging.

Loading content...

Implementors

impl<'a, 'tcx> AnalysisDomain<'tcx> for DefinitelyInitializedPlaces<'a, 'tcx>

type Idx = MovePathIndex

const NAME: &'static str

fn bits_per_block(&self, _: &Body<'tcx>) -> usize

fn initialize_start_block(&self, _: &Body<'tcx>, state: &mut BitSet<Self::Idx>)

fn pretty_print_idx(&self, w: &mut impl Write, mpi: Self::Idx) -> Result<()>

impl<'mir, 'tcx> AnalysisDomain<'tcx> for MaybeRequiresStorage<'mir, 'tcx>

type Idx = Local

const NAME: &'static str

fn bits_per_block(&self, body: &Body<'tcx>) -> usize

fn initialize_start_block(
    &self,
    body: &Body<'tcx>,
    on_entry: &mut BitSet<Self::Idx>
)

impl<'tcx> AnalysisDomain<'tcx> for MaybeInitializedLocals

type Idx = Local

const NAME: &'static str

fn bits_per_block(&self, body: &Body<'tcx>) -> usize

fn initialize_start_block(
    &self,
    body: &Body<'tcx>,
    entry_set: &mut BitSet<Self::Idx>
)

impl<'tcx> AnalysisDomain<'tcx> for MaybeLiveLocals

type Idx = Local

type Direction = Backward

const NAME: &'static str

fn bits_per_block(&self, body: &Body<'tcx>) -> usize

fn initialize_start_block(&self, _: &Body<'tcx>, _: &mut BitSet<Self::Idx>)

impl<'tcx> AnalysisDomain<'tcx> for MaybeStorageLive

type Idx = Local

const NAME: &'static str

fn bits_per_block(&self, body: &Body<'tcx>) -> usize

fn initialize_start_block(
    &self,
    body: &Body<'tcx>,
    on_entry: &mut BitSet<Self::Idx>
)

impl<'tcx, '_> AnalysisDomain<'tcx> for Borrows<'_, 'tcx>

type Idx = BorrowIndex

const NAME: &'static str

fn bits_per_block(&self, _: &Body<'tcx>) -> usize

fn initialize_start_block(&self, _: &Body<'tcx>, _: &mut BitSet<Self::Idx>)

fn pretty_print_idx(&self, w: &mut impl Write, idx: Self::Idx) -> Result<()>

impl<'tcx, '_> AnalysisDomain<'tcx> for EverInitializedPlaces<'_, 'tcx>

type Idx = InitIndex

const NAME: &'static str

fn bits_per_block(&self, _: &Body<'tcx>) -> usize

fn initialize_start_block(
    &self,
    body: &Body<'tcx>,
    state: &mut BitSet<Self::Idx>
)

impl<'tcx, '_> AnalysisDomain<'tcx> for MaybeInitializedPlaces<'_, 'tcx>

type Idx = MovePathIndex

const NAME: &'static str

fn bits_per_block(&self, _: &Body<'tcx>) -> usize

fn initialize_start_block(&self, _: &Body<'tcx>, state: &mut BitSet<Self::Idx>)

fn pretty_print_idx(&self, w: &mut impl Write, mpi: Self::Idx) -> Result<()>

impl<'tcx, '_> AnalysisDomain<'tcx> for MaybeUninitializedPlaces<'_, 'tcx>

type Idx = MovePathIndex

const NAME: &'static str

fn bits_per_block(&self, _: &Body<'tcx>) -> usize

fn initialize_start_block(
    &self,
    body: &Body<'tcx>,
    state: &mut BitSet<Self::Idx>
)

fn pretty_print_idx(&self, w: &mut impl Write, mpi: Self::Idx) -> Result<()>

impl<K, 'tcx> AnalysisDomain<'tcx> for MaybeBorrowedLocals<K> where
    K: BorrowAnalysisKind<'tcx>, 

type Idx = Local

const NAME: &'static str

fn bits_per_block(&self, body: &Body<'tcx>) -> usize

fn initialize_start_block(&self, _: &Body<'tcx>, _: &mut BitSet<Self::Idx>)

impl<Q, 'tcx, '_, '_> AnalysisDomain<'tcx> for FlowSensitiveAnalysis<'_, '_, 'tcx, Q> where
    Q: Qualif, 

type Idx = Local

const NAME: &'static str

fn bits_per_block(&self, body: &Body<'tcx>) -> usize

fn initialize_start_block(
    &self,
    _body: &Body<'tcx>,
    state: &mut BitSet<Self::Idx>
)

Loading content...