Skip to content

Be a bit more careful around exotic cycles in in the inliner #143704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 28 additions & 16 deletions compiler/rustc_mir_transform/src/inline/cycle.rs
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,15 @@ fn process<'tcx>(
typing_env: ty::TypingEnv<'tcx>,
caller: ty::Instance<'tcx>,
target: LocalDefId,
seen: &mut FxHashSet<ty::Instance<'tcx>>,
seen: &mut FxHashMap<ty::Instance<'tcx>, bool>,
involved: &mut FxHashSet<LocalDefId>,
recursion_limiter: &mut FxHashMap<DefId, usize>,
recursion_limit: Limit,
) -> bool {
trace!(%caller);
let mut cycle_found = false;
let mut reaches_root = false;
Copy link
Member Author

@compiler-errors compiler-errors Jul 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is more like "may reach root" given that we bail out with a possibly false-positive when hitting the recursion limit, but that was a mouthful.


for &(callee, args) in tcx.mir_inliner_callees(caller.def) {
for &(callee_def_id, args) in tcx.mir_inliner_callees(caller.def) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

with the name callee, DefId ends up shadowing Instance ends up shadowing DefId again 😆

let Ok(args) = caller.try_instantiate_mir_and_normalize_erasing_regions(
tcx,
typing_env,
Expand All @@ -81,14 +81,17 @@ fn process<'tcx>(
trace!(?caller, ?typing_env, ?args, "cannot normalize, skipping");
continue;
};
let Ok(Some(callee)) = ty::Instance::try_resolve(tcx, typing_env, callee, args) else {
trace!(?callee, "cannot resolve, skipping");
let Ok(Some(callee)) = ty::Instance::try_resolve(tcx, typing_env, callee_def_id, args)
else {
trace!(?callee_def_id, "cannot resolve, skipping");
continue;
};

// Found a path.
if callee.def_id() == target.to_def_id() {
cycle_found = true;
reaches_root = true;
seen.insert(callee, true);
continue;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's necessary to recurse on callees here, so I just continued.

}

if tcx.is_constructor(callee.def_id()) {
Expand All @@ -101,10 +104,17 @@ fn process<'tcx>(
continue;
}

if seen.insert(callee) {
let callee_reaches_root = if let Some(&c) = seen.get(&callee) {
// Even if we have seen this callee before, and thus don't need
// to recurse into it, we still need to propagate whether it reaches
// the root so that we can mark all the involved callers, in case we
// end up reaching that same recursive callee through some *other* cycle.
c
} else {
seen.insert(callee, false);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's safe to consider this to be false initially.

let recursion = recursion_limiter.entry(callee.def_id()).or_default();
trace!(?callee, recursion = *recursion);
let found_recursion = if recursion_limit.value_within_limit(*recursion) {
let callee_reaches_root = if recursion_limit.value_within_limit(*recursion) {
*recursion += 1;
ensure_sufficient_stack(|| {
process(
Expand All @@ -122,17 +132,19 @@ fn process<'tcx>(
// Pessimistically assume that there could be recursion.
true
};
if found_recursion {
if let Some(callee) = callee.def_id().as_local() {
// Calling `optimized_mir` of a non-local definition cannot cycle.
involved.insert(callee);
}
cycle_found = true;
seen.insert(callee, callee_reaches_root);
callee_reaches_root
};
if callee_reaches_root {
if let Some(callee_def_id) = callee.def_id().as_local() {
// Calling `optimized_mir` of a non-local definition cannot cycle.
involved.insert(callee_def_id);
}
reaches_root = true;
}
}

cycle_found
reaches_root
}

#[instrument(level = "debug", skip(tcx), ret)]
Expand Down Expand Up @@ -166,7 +178,7 @@ pub(crate) fn mir_callgraph_cyclic<'tcx>(
typing_env,
root_instance,
root,
&mut FxHashSet::default(),
&mut FxHashMap::default(),
&mut involved,
&mut FxHashMap::default(),
recursion_limit,
Expand Down
48 changes: 48 additions & 0 deletions tests/mir-opt/inline_double_cycle.a.Inline.panic-unwind.diff
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
- // MIR for `a` before Inline
+ // MIR for `a` after Inline

fn a() -> () {
let mut _0: ();
let _1: ();
let mut _2: ();
let _3: ();
let mut _4: ();
+ let mut _5: fn() {a};
+ let mut _6: fn() {b};
+ scope 1 (inlined <fn() {a} as FnOnce<()>>::call_once - shim(fn() {a})) {
+ }
+ scope 2 (inlined <fn() {b} as FnOnce<()>>::call_once - shim(fn() {b})) {
+ }

bb0: {
StorageLive(_1);
StorageLive(_2);
_2 = ();
- _1 = <fn() {a} as FnOnce<()>>::call_once(a, move _2) -> [return: bb1, unwind continue];
+ StorageLive(_5);
+ _5 = a;
+ _1 = move _5() -> [return: bb1, unwind continue];
}

bb1: {
+ StorageDead(_5);
StorageDead(_2);
StorageDead(_1);
StorageLive(_3);
StorageLive(_4);
_4 = ();
- _3 = <fn() {b} as FnOnce<()>>::call_once(b, move _4) -> [return: bb2, unwind continue];
+ StorageLive(_6);
+ _6 = b;
+ _3 = move _6() -> [return: bb2, unwind continue];
}

bb2: {
+ StorageDead(_6);
StorageDead(_4);
StorageDead(_3);
_0 = const ();
return;
}
}

48 changes: 48 additions & 0 deletions tests/mir-opt/inline_double_cycle.b.Inline.panic-unwind.diff
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
- // MIR for `b` before Inline
+ // MIR for `b` after Inline

fn b() -> () {
let mut _0: ();
let _1: ();
let mut _2: ();
let _3: ();
let mut _4: ();
+ let mut _5: fn() {b};
+ let mut _6: fn() {a};
+ scope 1 (inlined <fn() {b} as FnOnce<()>>::call_once - shim(fn() {b})) {
+ }
+ scope 2 (inlined <fn() {a} as FnOnce<()>>::call_once - shim(fn() {a})) {
+ }

bb0: {
StorageLive(_1);
StorageLive(_2);
_2 = ();
- _1 = <fn() {b} as FnOnce<()>>::call_once(b, move _2) -> [return: bb1, unwind continue];
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's nice to see we didn't break inlining at least for the FnOnce call. It's kind of a shame we can't inline a into b or vice versa, but it's obviously not clear which one to inline into the other without adding arbitrary ordering which is bad.

+ StorageLive(_5);
+ _5 = b;
+ _1 = move _5() -> [return: bb1, unwind continue];
}

bb1: {
+ StorageDead(_5);
StorageDead(_2);
StorageDead(_1);
StorageLive(_3);
StorageLive(_4);
_4 = ();
- _3 = <fn() {a} as FnOnce<()>>::call_once(a, move _4) -> [return: bb2, unwind continue];
+ StorageLive(_6);
+ _6 = a;
+ _3 = move _6() -> [return: bb2, unwind continue];
}

bb2: {
+ StorageDead(_6);
StorageDead(_4);
StorageDead(_3);
_0 = const ();
return;
}
}

22 changes: 22 additions & 0 deletions tests/mir-opt/inline_double_cycle.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// EMIT_MIR_FOR_EACH_PANIC_STRATEGY
// skip-filecheck
//@ test-mir-pass: Inline
//@ edition: 2021
//@ compile-flags: -Zinline-mir --crate-type=lib

// EMIT_MIR inline_double_cycle.a.Inline.diff
// EMIT_MIR inline_double_cycle.b.Inline.diff

#![feature(fn_traits)]

#[inline]
pub fn a() {
FnOnce::call_once(a, ());
FnOnce::call_once(b, ());
}

#[inline]
pub fn b() {
FnOnce::call_once(b, ());
FnOnce::call_once(a, ());
}
Loading