Skip to content

Commit

Permalink
Stop walking the bodies of statics for reachability, and evaluate the…
Browse files Browse the repository at this point in the history
…m instead
  • Loading branch information
oli-obk committed Mar 14, 2024
1 parent 54d83be commit 8332b47
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 39 deletions.
89 changes: 51 additions & 38 deletions compiler/rustc_passes/src/reachable.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
// reachable as well.

use hir::def_id::LocalDefIdSet;
use rustc_data_structures::stack::ensure_sufficient_stack;
use rustc_hir as hir;
use rustc_hir::def::{DefKind, Res};
use rustc_hir::def_id::{DefId, LocalDefId};
Expand Down Expand Up @@ -65,23 +66,8 @@ impl<'tcx> Visitor<'tcx> for ReachableContext<'tcx> {
_ => None,
};

if let Some(res) = res
&& let Some(def_id) = res.opt_def_id().and_then(|el| el.as_local())
{
if self.def_id_represents_local_inlined_item(def_id.to_def_id()) {
self.worklist.push(def_id);
} else {
match res {
// Reachable constants and reachable statics can have their contents inlined
// into other crates. Mark them as reachable and recurse into their body.
Res::Def(DefKind::Const | DefKind::AssocConst | DefKind::Static { .. }, _) => {
self.worklist.push(def_id);
}
_ => {
self.reachable_symbols.insert(def_id);
}
}
}
if let Some(res) = res {
self.propagate_item(res);
}

intravisit::walk_expr(self, expr)
Expand Down Expand Up @@ -201,17 +187,9 @@ impl<'tcx> ReachableContext<'tcx> {
hir::ItemKind::Const(_, _, init) => {
self.visit_nested_body(init);
}

// Reachable statics are inlined if read from another constant or static
// in other crates. Additionally anonymous nested statics may be created
// when evaluating a static, so preserve those, too.
hir::ItemKind::Static(_, _, init) => {
// FIXME(oli-obk): remove this body walking and instead walk the evaluated initializer
// to find nested items that end up in the final value instead of also marking symbols
// as reachable that are only needed for evaluation.
self.visit_nested_body(init);
hir::ItemKind::Static(..) => {
if let Ok(alloc) = self.tcx.eval_static_initializer(item.owner_id.def_id) {
self.propagate_statics_from_alloc(item.owner_id.def_id, alloc);
self.propagate_from_alloc(alloc);
}
}

Expand Down Expand Up @@ -281,25 +259,60 @@ impl<'tcx> ReachableContext<'tcx> {
}
}

/// Finds anonymous nested statics created for nested allocations and adds them to `reachable_symbols`.
fn propagate_statics_from_alloc(&mut self, root: LocalDefId, alloc: ConstAllocation<'tcx>) {
/// Finds things to add to `reachable_symbols` within allocations.
/// In contrast to visit_nested_body this ignores things that were only needed to evaluate
/// the allocation.
fn propagate_from_alloc(&mut self, alloc: ConstAllocation<'tcx>) {
if !self.any_library {
return;
}
for (_, prov) in alloc.0.provenance().ptrs().iter() {
match self.tcx.global_alloc(prov.alloc_id()) {
GlobalAlloc::Static(def_id) => {
if let Some(def_id) = def_id.as_local()
&& self.tcx.local_parent(def_id) == root
// This is the main purpose of this function: add the def_id we find
// to `reachable_symbols`.
&& self.reachable_symbols.insert(def_id)
&& let Ok(alloc) = self.tcx.eval_static_initializer(def_id)
{
self.propagate_statics_from_alloc(root, alloc);
self.propagate_item(Res::Def(self.tcx.def_kind(def_id), def_id))
}
GlobalAlloc::Function(instance) => {
self.propagate_item(Res::Def(
self.tcx.def_kind(instance.def_id()),
instance.def_id(),
))
// TODO: walk generic args
}
GlobalAlloc::VTable(ty, trait_ref) => todo!("{ty:?}, {trait_ref:?}"),
GlobalAlloc::Memory(alloc) => self.propagate_from_alloc(alloc),
}
}
}

fn propagate_item(&mut self, res: Res) {
let Res::Def(kind, def_id) = res else { return };
let Some(def_id) = def_id.as_local() else { return };
match kind {
DefKind::Static { nested: true, .. } => {
// This is the main purpose of this function: add the def_id we find
// to `reachable_symbols`.
if self.reachable_symbols.insert(def_id) {
if let Ok(alloc) = self.tcx.eval_static_initializer(def_id) {
// This cannot cause infinite recursion, because we abort by inserting into the
// work list once we hit a normal static. Nested statics, even if they somehow
// become recursive, are also not infinitely recursing, because of the
// `reachable_symbols` check above.
// We still need to protect against stack overflow due to deeply nested statics.
ensure_sufficient_stack(|| self.propagate_from_alloc(alloc));
}
}
GlobalAlloc::Function(_) | GlobalAlloc::VTable(_, _) | GlobalAlloc::Memory(_) => {}
}
// Reachable constants and reachable statics can have their contents inlined
// into other crates. Mark them as reachable and recurse into their body.
DefKind::Const | DefKind::AssocConst | DefKind::Static { .. } => {
self.worklist.push(def_id);
}
_ => {
if self.def_id_represents_local_inlined_item(def_id.to_def_id()) {
self.worklist.push(def_id);
} else {
self.reachable_symbols.insert(def_id);
}
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ const fn foo() {}

pub static FOO: () = foo();

// CHECK: define{{.*}}foo{{.*}}
// CHECK-NOT: define{{.*}}foo{{.*}}

0 comments on commit 8332b47

Please sign in to comment.