Struct rustc_mir::transform::coverage::graph::BasicCoverageBlockData

pub(super) struct BasicCoverageBlockData {
    pub basic_blocks: Vec<BasicBlock>,
    pub counter_kind: Option<CoverageKind>,
    edge_from_bcbs: Option<FxHashMap<BasicCoverageBlock, CoverageKind>>,
}

BasicCoverageBlockData holds the data indexed by a BasicCoverageBlock.

A BasicCoverageBlock (BCB) represents the maximal-length sequence of MIR BasicBlocks without conditional branches, and form a new, simplified, coverage-specific Control Flow Graph, without altering the original MIR CFG.

Note that running the MIR SimplifyCfg transform is not sufficient (and therefore not necessary). The BCB-based CFG is a more aggressive simplification. For example:

• The BCB CFG ignores (trims) branches not relevant to coverage, such as unwind-related code, that is injected by the Rust compiler but has no physical source code to count. This also means a BasicBlock with a Call terminator can be merged into its primary successor target block, in the same BCB. (But, note: Issue #78544: “MIR InstrumentCoverage: Improve coverage of #[should_panic] tests and catch_unwind() handlers”)
• Some BasicBlock terminators support Rust-specific concerns–like borrow-checking–that are not relevant to coverage analysis. FalseUnwind, for example, can be treated the same as a Goto, and merged with its successor into the same BCB.

Each BCB with at least one computed CoverageSpan will have no more than one Counter. In some cases, a BCB’s execution count can be computed by Expression. Additional disjoint CoverageSpans in a BCB can also be counted by Expression (by adding ZERO to the BCB’s primary counter or expression).

The BCB CFG is critical to simplifying the coverage analysis by ensuring graph path-based queries (is_dominated_by(), predecessors, successors, etc.) have branch (control flow) significance.

Fields

basic_blocks: Vec<BasicBlock>

counter_kind: Option<CoverageKind>

edge_from_bcbs: Option<FxHashMap<BasicCoverageBlock, CoverageKind>>

Implementations

impl BasicCoverageBlockData

pub fn from(basic_blocks: Vec<BasicBlock>) -> Self

pub fn leader_bb(&self) -> BasicBlock

pub fn last_bb(&self) -> BasicBlock

pub fn terminator<'a, 'tcx>(
    &self,
    mir_body: &'a Body<'tcx>
) -> &'a Terminator<'tcx>

pub fn set_counter(
    &mut self,
    counter_kind: CoverageKind
) -> Result<ExpressionOperandId, Error>

pub fn counter(&self) -> Option<&CoverageKind>

pub fn take_counter(&mut self) -> Option<CoverageKind>

pub fn set_edge_counter_from(
    &mut self,
    from_bcb: BasicCoverageBlock,
    counter_kind: CoverageKind
) -> Result<ExpressionOperandId, Error>

pub fn edge_counter_from(
    &self,
    from_bcb: BasicCoverageBlock
) -> Option<&CoverageKind>

pub fn take_edge_counters(
    &mut self
) -> Option<impl Iterator<Item = (BasicCoverageBlock, CoverageKind)>>

pub fn id(&self) -> String

Trait Implementations

impl Clone for BasicCoverageBlockData

fn clone(&self) -> BasicCoverageBlockData

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BasicCoverageBlockData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.