Struct MirPatch

pub(crate) struct MirPatch<'tcx> {
    term_patch_map: IndexVec<BasicBlock, Option<TerminatorKind<'tcx>>>,
    new_blocks: Vec<BasicBlockData<'tcx>>,
    new_statements: Vec<(Location, StatementKind<'tcx>)>,
    new_locals: Vec<LocalDecl<'tcx>>,
    resume_block: Option<BasicBlock>,
    unreachable_cleanup_block: Option<BasicBlock>,
    unreachable_no_cleanup_block: Option<BasicBlock>,
    terminate_block: Option<(BasicBlock, UnwindTerminateReason)>,
    body_span: Span,
    next_local: usize,
}

This struct lets you “patch” a MIR body, i.e. modify it. You can queue up various changes, such as the addition of new statements and basic blocks and replacement of terminators, and then apply the queued changes all at once with apply. This is useful for MIR transformation passes.

Fields

term_patch_map: IndexVec<BasicBlock, Option<TerminatorKind<'tcx>>>

new_blocks: Vec<BasicBlockData<'tcx>>

new_statements: Vec<(Location, StatementKind<'tcx>)>

new_locals: Vec<LocalDecl<'tcx>>

resume_block: Option<BasicBlock>

unreachable_cleanup_block: Option<BasicBlock>

unreachable_no_cleanup_block: Option<BasicBlock>

terminate_block: Option<(BasicBlock, UnwindTerminateReason)>

body_span: Span

next_local: usize

Implementations

impl<'tcx> MirPatch<'tcx>

pub(crate) fn new(body: &Body<'tcx>) -> Self

Creates a new, empty patch.

pub(crate) fn resume_block(&mut self) -> BasicBlock

pub(crate) fn unreachable_cleanup_block(&mut self) -> BasicBlock

pub(crate) fn unreachable_no_cleanup_block(&mut self) -> BasicBlock

pub(crate) fn terminate_block( &mut self, reason: UnwindTerminateReason, ) -> BasicBlock

pub(crate) fn is_term_patched(&self, bb: BasicBlock) -> bool

Has a replacement of this block’s terminator been queued in this patch?

pub(crate) fn new_local_with_info( &mut self, ty: Ty<'tcx>, span: Span, local_info: LocalInfo<'tcx>, ) -> Local

Queues the addition of a new temporary with additional local info.

pub(crate) fn new_temp(&mut self, ty: Ty<'tcx>, span: Span) -> Local

Queues the addition of a new temporary.

pub(crate) fn local_ty(&self, local: Local) -> Ty<'tcx>

Returns the type of a local that’s newly-added in the patch.

pub(crate) fn new_block(&mut self, data: BasicBlockData<'tcx>) -> BasicBlock

Queues the addition of a new basic block.

pub(crate) fn patch_terminator( &mut self, block: BasicBlock, new: TerminatorKind<'tcx>, )

Queues the replacement of a block’s terminator.

pub(crate) fn add_statement(&mut self, loc: Location, stmt: StatementKind<'tcx>)

Queues the insertion of a statement at a given location. The statement currently at that location, and all statements that follow, are shifted down. If multiple statements are queued for addition at the same location, the final statement order after calling apply will match the queue insertion order.

E.g. if we have s0 at location loc and do these calls:

p.add_statement(loc, s1); p.add_statement(loc, s2); p.apply(body);

then the final order will be s1, s2, s0, with s1 at loc.

pub(crate) fn add_assign( &mut self, loc: Location, place: Place<'tcx>, rv: Rvalue<'tcx>, )

Like add_statement, but specialized for assignments.

pub(crate) fn apply(self, body: &mut Body<'tcx>)

Applies the queued changes.

fn source_info_for_index(data: &BasicBlockData<'_>, loc: Location) -> SourceInfo

pub(crate) fn source_info_for_location( &self, body: &Body<'tcx>, loc: Location, ) -> SourceInfo

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