Refactor AddCallGuards in two loops.

This commit is contained in:
Camille Gillot 2025-10-08 13:40:12 +00:00
parent 4a54b26d30
commit 5702fbf03d

View file

@ -1,3 +1,20 @@
//! Breaks outgoing critical edges for call terminators in the MIR.
//!
//! Critical edges are edges that are neither the only edge leaving a
//! block, nor the only edge entering one.
//!
//! When you want something to happen "along" an edge, you can either
//! do at the end of the predecessor block, or at the start of the
//! successor block. Critical edges have to be broken in order to prevent
//! "edge actions" from affecting other edges. We need this for calls that are
//! codegened to LLVM invoke instructions, because invoke is a block terminator
//! in LLVM so we can't insert any code to handle the call's result into the
//! block that performs the call.
//!
//! This function will break those edges by inserting new blocks along them.
//!
//! NOTE: Simplify CFG will happily undo most of the work this pass does.
use rustc_index::{Idx, IndexVec};
use rustc_middle::mir::*;
use rustc_middle::ty::TyCtxt;
@ -10,26 +27,6 @@ pub(super) enum AddCallGuards {
}
pub(super) use self::AddCallGuards::*;
/**
* Breaks outgoing critical edges for call terminators in the MIR.
*
* Critical edges are edges that are neither the only edge leaving a
* block, nor the only edge entering one.
*
* When you want something to happen "along" an edge, you can either
* do at the end of the predecessor block, or at the start of the
* successor block. Critical edges have to be broken in order to prevent
* "edge actions" from affecting other edges. We need this for calls that are
* codegened to LLVM invoke instructions, because invoke is a block terminator
* in LLVM so we can't insert any code to handle the call's result into the
* block that performs the call.
*
* This function will break those edges by inserting new blocks along them.
*
* NOTE: Simplify CFG will happily undo most of the work this pass does.
*
*/
impl<'tcx> crate::MirPass<'tcx> for AddCallGuards {
fn run_pass(&self, _tcx: TyCtxt<'tcx>, body: &mut Body<'tcx>) {
let mut pred_count = IndexVec::from_elem(0u8, &body.basic_blocks);
@ -39,8 +36,52 @@ impl<'tcx> crate::MirPass<'tcx> for AddCallGuards {
}
}
enum Action {
Call,
Asm { target_index: usize },
}
let mut work = Vec::with_capacity(body.basic_blocks.len());
for (bb, block) in body.basic_blocks.iter_enumerated() {
let term = block.terminator();
match term.kind {
TerminatorKind::Call { target: Some(destination), unwind, .. }
if pred_count[destination] > 1
&& (generates_invoke(unwind) || self == &AllCallEdges) =>
{
// It's a critical edge, break it
work.push((bb, Action::Call));
}
TerminatorKind::InlineAsm {
asm_macro: InlineAsmMacro::Asm,
ref targets,
ref operands,
unwind,
..
} if self == &CriticalCallEdges => {
let has_outputs = operands.iter().any(|op| {
matches!(op, InlineAsmOperand::InOut { .. } | InlineAsmOperand::Out { .. })
});
let has_labels =
operands.iter().any(|op| matches!(op, InlineAsmOperand::Label { .. }));
if has_outputs && (has_labels || generates_invoke(unwind)) {
for (target_index, target) in targets.iter().enumerate() {
if pred_count[*target] > 1 {
work.push((bb, Action::Asm { target_index }));
}
}
}
}
_ => {}
}
}
if work.is_empty() {
return;
}
// We need a place to store the new blocks generated
let mut new_blocks = Vec::new();
let mut new_blocks = Vec::with_capacity(work.len());
let cur_len = body.basic_blocks.len();
let mut new_block = |source_info: SourceInfo, is_cleanup: bool, target: BasicBlock| {
@ -53,48 +94,32 @@ impl<'tcx> crate::MirPass<'tcx> for AddCallGuards {
BasicBlock::new(idx)
};
for block in body.basic_blocks_mut() {
match block.terminator {
Some(Terminator {
kind: TerminatorKind::Call { target: Some(ref mut destination), unwind, .. },
source_info,
}) if pred_count[*destination] > 1
&& (generates_invoke(unwind) || self == &AllCallEdges) =>
{
// It's a critical edge, break it
*destination = new_block(source_info, block.is_cleanup, *destination);
let basic_blocks = body.basic_blocks.as_mut();
for (source, action) in work {
let block = &mut basic_blocks[source];
let is_cleanup = block.is_cleanup;
let term = block.terminator_mut();
let source_info = term.source_info;
let destination = match action {
Action::Call => {
let TerminatorKind::Call { target: Some(ref mut destination), .. } = term.kind
else {
unreachable!()
};
destination
}
Some(Terminator {
kind:
TerminatorKind::InlineAsm {
asm_macro: InlineAsmMacro::Asm,
ref mut targets,
ref operands,
unwind,
..
},
source_info,
}) if self == &CriticalCallEdges => {
let has_outputs = operands.iter().any(|op| {
matches!(op, InlineAsmOperand::InOut { .. } | InlineAsmOperand::Out { .. })
});
let has_labels =
operands.iter().any(|op| matches!(op, InlineAsmOperand::Label { .. }));
if has_outputs && (has_labels || generates_invoke(unwind)) {
for target in targets.iter_mut() {
if pred_count[*target] > 1 {
*target = new_block(source_info, block.is_cleanup, *target);
}
}
}
Action::Asm { target_index } => {
let TerminatorKind::InlineAsm { ref mut targets, .. } = term.kind else {
unreachable!()
};
&mut targets[target_index]
}
_ => {}
}
};
*destination = new_block(source_info, is_cleanup, *destination);
}
debug!("Broke {} N edges", new_blocks.len());
body.basic_blocks_mut().extend(new_blocks);
basic_blocks.extend(new_blocks);
}
fn is_required(&self) -> bool {