Struct rustc_middle::mir::BasicBlocks

pub struct BasicBlocks<'tcx> {
    basic_blocks: IndexVec<BasicBlock, BasicBlockData<'tcx>>,
    cache: Cache,
}

Fields

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

cache: Cache

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 reverse_postorder(&self) -> &[BasicBlock]

Returns basic blocks in a reverse postorder.

See traversal::reverse_postorder’s docs to learn what is preorder traversal.

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.

Methods from Deref<Target = IndexSlice<BasicBlock, BasicBlockData<'tcx>>>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn next_index(&self) -> I

Gives the next index that will be assigned when push is called.

Manual bounds checks can be done using idx < slice.next_index() (as opposed to idx.index() < slice.len()).

pub fn iter(&self) -> Iter<'_, T>

pub fn iter_enumerated(&self) -> impl DoubleEndedIterator + ExactSizeIterator

pub fn indices( &self, ) -> impl DoubleEndedIterator + ExactSizeIterator + Clone + 'static

pub fn last_index(&self) -> Option<I>

pub fn get(&self, index: I) -> Option<&T>

pub fn binary_search(&self, value: &T) -> Result<I, I>

where T: Ord,

pub fn invert_bijective_mapping(&self) -> IndexVec<J, I>

Invert a bijective mapping, i.e. invert(map)[y] = x if map[x] = y, assuming the values in self are a permutation of 0..self.len().

This is used to go between memory_index (source field order to memory order) and inverse_memory_index (memory order to source field order). See also FieldsShape::Arbitrary::memory_index for more details.

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 = IndexSlice<BasicBlock, BasicBlockData<'tcx>>

The resulting type after dereferencing.

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

Dereferences the value.

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

type Node = BasicBlock

fn num_nodes(&self) -> usize

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

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

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

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

impl<'tcx> Predecessors for BasicBlocks<'tcx>

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

impl<'tcx> StartNode for BasicBlocks<'tcx>

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

impl<'tcx> Successors for BasicBlocks<'tcx>

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

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

fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'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>(self, folder: &mut F) -> Self

where F: TypeFolder<I>,

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<TyCtxt<'tcx>> for BasicBlocks<'tcx>

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

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

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: 184 bytes