Struct rustc_middle::mir::BasicBlocks

pub struct BasicBlocks<'tcx> {
    basic_blocks: IndexVec<BasicBlock, BasicBlockData<'tcx>>,
    predecessor_cache: PredecessorCache,
    switch_source_cache: SwitchSourceCache,
    is_cyclic: GraphIsCyclicCache,
    postorder_cache: PostorderCache,
}

Fields

basic_blocks: IndexVec<BasicBlock, BasicBlockData<'tcx>>

predecessor_cache: PredecessorCache

switch_source_cache: SwitchSourceCache

is_cyclic: GraphIsCyclicCache

postorder_cache: PostorderCache

Implementations

impl<'tcx> BasicBlocks<'tcx>

pub fn new(basic_blocks: IndexVec<BasicBlock, BasicBlockData<'tcx>>) -> Self

pub fn is_cfg_cyclic(&self) -> bool

Returns true if control-flow graph contains a cycle reachable from the START_BLOCK.

pub fn dominators(&self) -> Dominators<BasicBlock>

pub fn predecessors(&self) -> &IndexVec<BasicBlock, SmallVec<[BasicBlock; 4]>>

Returns predecessors for each basic block.

pub fn postorder(&self) -> &[BasicBlock]

Returns basic blocks in a postorder.

pub fn switch_sources(
    &self
) -> &FxHashMap<(BasicBlock, BasicBlock), SmallVec<[Option<u128>; 1]>>

switch_sources()[&(target, switch)] returns a list of switch values that lead to a target block from a switch block.

pub fn as_mut(&mut self) -> &mut IndexVec<BasicBlock, BasicBlockData<'tcx>>

Returns mutable reference to basic blocks. Invalidates CFG cache.

pub fn as_mut_preserves_cfg(
    &mut self
) -> &mut IndexVec<BasicBlock, BasicBlockData<'tcx>>

Get mutable access to basic blocks without invalidating the CFG cache.

By calling this method instead of e.g. BasicBlocks::as_mut you promise not to change the CFG. This means that

1. The number of basic blocks remains unchanged
2. The set of successors of each terminator remains unchanged.
3. For each TerminatorKind::SwitchInt, the targets remains the same and the terminator kind is not changed.

If any of these conditions cannot be upheld, you should call BasicBlocks::invalidate_cfg_cache.

pub fn invalidate_cfg_cache(&mut self)

Invalidates cached information about the CFG.

You will only ever need this if you have also called BasicBlocks::as_mut_preserves_cfg. All other methods that allow you to mutate the basic blocks also call this method themselves, thereby avoiding any risk of accidentally cache invalidation.

Trait Implementations

impl<'tcx> Clone for BasicBlocks<'tcx>

fn clone(&self) -> BasicBlocks<'tcx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for BasicBlocks<'tcx>

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

Formats the value using the given formatter.

impl<'tcx, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for BasicBlocks<'tcx>

fn decode(__decoder: &mut __D) -> Self

impl<'tcx> Deref for BasicBlocks<'tcx>

type Target = IndexVec<BasicBlock, BasicBlockData<'tcx>>

The resulting type after dereferencing.

fn deref(&self) -> &IndexVec<BasicBlock, BasicBlockData<'tcx>>

Dereferences the value.

impl<'tcx> DirectedGraph for BasicBlocks<'tcx>

type Node = BasicBlock

impl<'tcx, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for BasicBlocks<'tcx>

fn encode(&self, __encoder: &mut __E)

impl<'tcx, 'graph> GraphPredecessors<'graph> for BasicBlocks<'tcx>

type Item = BasicBlock

type Iter = Copied<Iter<'graph, BasicBlock>>

impl<'a, 'b> GraphSuccessors<'b> for BasicBlocks<'a>

type Item = BasicBlock

type Iter = impl Iterator<Item = BasicBlock> + 'b

impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for BasicBlocks<'tcx>

fn hash_stable(
    &self,
    __hcx: &mut StableHashingContext<'__ctx>,
    __hasher: &mut StableHasher
)

impl<'tcx> TypeFoldable<'tcx> for BasicBlocks<'tcx>

fn try_fold_with<__F: FallibleTypeFolder<'tcx>>(
    self,
    __folder: &mut __F
) -> Result<Self, __F::Error>

The entry point for folding. To fold a value t with a folder f call: t.try_fold_with(f).

fn fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with.

impl<'tcx> TypeVisitable<'tcx> for BasicBlocks<'tcx>

fn visit_with<__V: TypeVisitor<'tcx>>(
    &self,
    __visitor: &mut __V
) -> ControlFlow<__V::BreakTy>

The entry point for visiting. To visit a value t with a visitor v call: t.visit_with(v).

fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool

Returns true if self has any late-bound regions that are either bound by binder or bound by some binder outside of binder. If binder is ty::INNERMOST, this indicates whether there are any late-bound regions that appear free.

fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool

Returns true if this self has any regions that escape binder (and hence are not bound by it).

fn has_escaping_bound_vars(&self) -> bool

fn has_type_flags(&self, flags: TypeFlags) -> bool

fn has_projections(&self) -> bool

fn has_opaque_types(&self) -> bool

fn references_error(&self) -> bool

fn error_reported(&self) -> Option<ErrorGuaranteed>

fn has_param_types_or_consts(&self) -> bool

fn has_infer_regions(&self) -> bool

fn has_infer_types(&self) -> bool

fn has_infer_types_or_consts(&self) -> bool

fn needs_infer(&self) -> bool

fn has_placeholders(&self) -> bool

fn needs_subst(&self) -> bool

fn has_free_regions(&self) -> bool

“Free” regions in this context means that it has any region that is not (a) erased or (b) late-bound.

fn has_erased_regions(&self) -> bool

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.

fn is_global(&self) -> bool

Indicates whether this value references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching.

fn has_late_bound_regions(&self) -> bool

True if there are any late-bound regions

fn still_further_specializable(&self) -> bool

Indicates whether this value still has parameters/placeholders/inference variables which could be replaced later, in a way that would change the results of impl specialization.

impl<'tcx> WithNumNodes for BasicBlocks<'tcx>

fn num_nodes(&self) -> usize

impl<'tcx> WithPredecessors for BasicBlocks<'tcx>

fn predecessors(&self, node: Self::Node) -> Copied<Iter<'_, BasicBlock>>

impl<'tcx> WithStartNode for BasicBlocks<'tcx>

fn start_node(&self) -> Self::Node

impl<'tcx> WithSuccessors for BasicBlocks<'tcx>

fn successors(&self, node: Self::Node) -> impl Iterator<Item = BasicBlock>

fn depth_first_search(&self, from: Self::Node) -> DepthFirstSearch<'_, Self>where
    Self: WithNumNodes,

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 112 bytes