compiler/rustc_passes/src/reachable.rs

   1 // Finds items that are externally reachable, to determine which items
   2 // need to have their metadata (and possibly their AST) serialized.
   3 // All items that can be referred to through an exported name are
   4 // reachable, and when a reachable thing is inline or generic, it
   5 // makes all other generics or inline functions that it references
   6 // reachable as well.
   7
   8 use rustc_data_structures::fx::FxHashSet;
   9 use rustc_hir as hir;
  10 use rustc_hir::def::{DefKind, Res};
  11 use rustc_hir::def_id::{DefId, LocalDefId};
  12 use rustc_hir::intravisit::{self, Visitor};
  13 use rustc_hir::Node;
  14 use rustc_middle::middle::codegen_fn_attrs::{CodegenFnAttrFlags, CodegenFnAttrs};
  15 use rustc_middle::middle::privacy::{self, Level};
  16 use rustc_middle::ty::query::Providers;
  17 use rustc_middle::ty::{self, DefIdTree, TyCtxt};
  18 use rustc_session::config::CrateType;
  19 use rustc_target::spec::abi::Abi;
  20
  21 // Returns true if the given item must be inlined because it may be
  22 // monomorphized or it was marked with `#[inline]`. This will only return
  23 // true for functions.
  24 fn item_might_be_inlined(tcx: TyCtxt<'_>, item: &hir::Item<'_>, attrs: &CodegenFnAttrs) -> bool {
  25     if attrs.requests_inline() {
  26         return true;
  27     }
  28
  29     match item.kind {
  30         hir::ItemKind::Fn(ref sig, ..) if sig.header.is_const() => true,
  31         hir::ItemKind::Impl { .. } | hir::ItemKind::Fn(..) => {
  32             let generics = tcx.generics_of(item.owner_id);
  33             generics.requires_monomorphization(tcx)
  34         }
  35         _ => false,
  36     }
  37 }
  38
  39 fn method_might_be_inlined(
  40     tcx: TyCtxt<'_>,
  41     impl_item: &hir::ImplItem<'_>,
  42     impl_src: LocalDefId,
  43 ) -> bool {
  44     let codegen_fn_attrs = tcx.codegen_fn_attrs(impl_item.hir_id().owner.to_def_id());
  45     let generics = tcx.generics_of(impl_item.owner_id);
  46     if codegen_fn_attrs.requests_inline() || generics.requires_monomorphization(tcx) {
  47         return true;
  48     }
  49     if let hir::ImplItemKind::Fn(method_sig, _) = &impl_item.kind {
  50         if method_sig.header.is_const() {
  51             return true;
  52         }
  53     }
  54     match tcx.hir().find_by_def_id(impl_src) {
  55         Some(Node::Item(item)) => item_might_be_inlined(tcx, &item, codegen_fn_attrs),
  56         Some(..) | None => span_bug!(impl_item.span, "impl did is not an item"),
  57     }
  58 }
  59
  60 // Information needed while computing reachability.
  61 struct ReachableContext<'tcx> {
  62     // The type context.
  63     tcx: TyCtxt<'tcx>,
  64     maybe_typeck_results: Option<&'tcx ty::TypeckResults<'tcx>>,
  65     // The set of items which must be exported in the linkage sense.
  66     reachable_symbols: FxHashSet<LocalDefId>,
  67     // A worklist of item IDs. Each item ID in this worklist will be inlined
  68     // and will be scanned for further references.
  69     // FIXME(eddyb) benchmark if this would be faster as a `VecDeque`.
  70     worklist: Vec<LocalDefId>,
  71     // Whether any output of this compilation is a library
  72     any_library: bool,
  73 }
  74
  75 impl<'tcx> Visitor<'tcx> for ReachableContext<'tcx> {
  76     fn visit_nested_body(&mut self, body: hir::BodyId) {
  77         let old_maybe_typeck_results =
  78             self.maybe_typeck_results.replace(self.tcx.typeck_body(body));
  79         let body = self.tcx.hir().body(body);
  80         self.visit_body(body);
  81         self.maybe_typeck_results = old_maybe_typeck_results;
  82     }
  83
  84     fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
  85         let res = match expr.kind {
  86             hir::ExprKind::Path(ref qpath) => {
  87                 Some(self.typeck_results().qpath_res(qpath, expr.hir_id))
  88             }
  89             hir::ExprKind::MethodCall(..) => self
  90                 .typeck_results()
  91                 .type_dependent_def(expr.hir_id)
  92                 .map(|(kind, def_id)| Res::Def(kind, def_id)),
  93             _ => None,
  94         };
  95
  96         if let Some(res) = res && let Some(def_id) = res.opt_def_id().and_then(|el| el.as_local()) {
  97             if self.def_id_represents_local_inlined_item(def_id.to_def_id()) {
  98                 self.worklist.push(def_id);
  99             } else {
 100                 match res {
 101                     // If this path leads to a constant, then we need to
 102                     // recurse into the constant to continue finding
 103                     // items that are reachable.
 104                     Res::Def(DefKind::Const | DefKind::AssocConst, _) => {
 105                         self.worklist.push(def_id);
 106                     }
 107
 108                     // If this wasn't a static, then the destination is
 109                     // surely reachable.
 110                     _ => {
 111                         self.reachable_symbols.insert(def_id);
 112                     }
 113                 }
 114             }
 115         }
 116
 117         intravisit::walk_expr(self, expr)
 118     }
 119 }
 120
 121 impl<'tcx> ReachableContext<'tcx> {
 122     /// Gets the type-checking results for the current body.
 123     /// As this will ICE if called outside bodies, only call when working with
 124     /// `Expr` or `Pat` nodes (they are guaranteed to be found only in bodies).
 125     #[track_caller]
 126     fn typeck_results(&self) -> &'tcx ty::TypeckResults<'tcx> {
 127         self.maybe_typeck_results
 128             .expect("`ReachableContext::typeck_results` called outside of body")
 129     }
 130
 131     // Returns true if the given def ID represents a local item that is
 132     // eligible for inlining and false otherwise.
 133     fn def_id_represents_local_inlined_item(&self, def_id: DefId) -> bool {
 134         let Some(def_id) = def_id.as_local() else {
 135             return false;
 136         };
 137
 138         match self.tcx.hir().find_by_def_id(def_id) {
 139             Some(Node::Item(item)) => match item.kind {
 140                 hir::ItemKind::Fn(..) => {
 141                     item_might_be_inlined(self.tcx, &item, self.tcx.codegen_fn_attrs(def_id))
 142                 }
 143                 _ => false,
 144             },
 145             Some(Node::TraitItem(trait_method)) => match trait_method.kind {
 146                 hir::TraitItemKind::Const(_, ref default) => default.is_some(),
 147                 hir::TraitItemKind::Fn(_, hir::TraitFn::Provided(_)) => true,
 148                 hir::TraitItemKind::Fn(_, hir::TraitFn::Required(_))
 149                 | hir::TraitItemKind::Type(..) => false,
 150             },
 151             Some(Node::ImplItem(impl_item)) => match impl_item.kind {
 152                 hir::ImplItemKind::Const(..) => true,
 153                 hir::ImplItemKind::Fn(..) => {
 154                     let hir_id = self.tcx.hir().local_def_id_to_hir_id(def_id);
 155                     let impl_did = self.tcx.hir().get_parent_item(hir_id);
 156                     method_might_be_inlined(self.tcx, impl_item, impl_did.def_id)
 157                 }
 158                 hir::ImplItemKind::Type(_) => false,
 159             },
 160             Some(_) => false,
 161             None => false, // This will happen for default methods.
 162         }
 163     }
 164
 165     // Step 2: Mark all symbols that the symbols on the worklist touch.
 166     fn propagate(&mut self) {
 167         let mut scanned = FxHashSet::default();
 168         while let Some(search_item) = self.worklist.pop() {
 169             if !scanned.insert(search_item) {
 170                 continue;
 171             }
 172
 173             if let Some(ref item) = self.tcx.hir().find_by_def_id(search_item) {
 174                 self.propagate_node(item, search_item);
 175             }
 176         }
 177     }
 178
 179     fn propagate_node(&mut self, node: &Node<'tcx>, search_item: LocalDefId) {
 180         if !self.any_library {
 181             // If we are building an executable, only explicitly extern
 182             // types need to be exported.
 183             let reachable =
 184                 if let Node::Item(hir::Item { kind: hir::ItemKind::Fn(sig, ..), .. })
 185                 | Node::ImplItem(hir::ImplItem {
 186                     kind: hir::ImplItemKind::Fn(sig, ..), ..
 187                 }) = *node
 188                 {
 189                     sig.header.abi != Abi::Rust
 190                 } else {
 191                     false
 192                 };
 193             let codegen_attrs = if self.tcx.def_kind(search_item).has_codegen_attrs() {
 194                 self.tcx.codegen_fn_attrs(search_item)
 195             } else {
 196                 CodegenFnAttrs::EMPTY
 197             };
 198             let is_extern = codegen_attrs.contains_extern_indicator();
 199             let std_internal =
 200                 codegen_attrs.flags.contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL);
 201             if reachable || is_extern || std_internal {
 202                 self.reachable_symbols.insert(search_item);
 203             }
 204         } else {
 205             // If we are building a library, then reachable symbols will
 206             // continue to participate in linkage after this product is
 207             // produced. In this case, we traverse the ast node, recursing on
 208             // all reachable nodes from this one.
 209             self.reachable_symbols.insert(search_item);
 210         }
 211
 212         match *node {
 213             Node::Item(item) => {
 214                 match item.kind {
 215                     hir::ItemKind::Fn(.., body) => {
 216                         if item_might_be_inlined(
 217                             self.tcx,
 218                             &item,
 219                             self.tcx.codegen_fn_attrs(item.owner_id),
 220                         ) {
 221                             self.visit_nested_body(body);
 222                         }
 223                     }
 224
 225                     // Reachable constants will be inlined into other crates
 226                     // unconditionally, so we need to make sure that their
 227                     // contents are also reachable.
 228                     hir::ItemKind::Const(_, init) | hir::ItemKind::Static(_, _, init) => {
 229                         self.visit_nested_body(init);
 230                     }
 231
 232                     // These are normal, nothing reachable about these
 233                     // inherently and their children are already in the
 234                     // worklist, as determined by the privacy pass
 235                     hir::ItemKind::ExternCrate(_)
 236                     | hir::ItemKind::Use(..)
 237                     | hir::ItemKind::OpaqueTy(..)
 238                     | hir::ItemKind::TyAlias(..)
 239                     | hir::ItemKind::Macro(..)
 240                     | hir::ItemKind::Mod(..)
 241                     | hir::ItemKind::ForeignMod { .. }
 242                     | hir::ItemKind::Impl { .. }
 243                     | hir::ItemKind::Trait(..)
 244                     | hir::ItemKind::TraitAlias(..)
 245                     | hir::ItemKind::Struct(..)
 246                     | hir::ItemKind::Enum(..)
 247                     | hir::ItemKind::Union(..)
 248                     | hir::ItemKind::GlobalAsm(..) => {}
 249                 }
 250             }
 251             Node::TraitItem(trait_method) => {
 252                 match trait_method.kind {
 253                     hir::TraitItemKind::Const(_, None)
 254                     | hir::TraitItemKind::Fn(_, hir::TraitFn::Required(_)) => {
 255                         // Keep going, nothing to get exported
 256                     }
 257                     hir::TraitItemKind::Const(_, Some(body_id))
 258                     | hir::TraitItemKind::Fn(_, hir::TraitFn::Provided(body_id)) => {
 259                         self.visit_nested_body(body_id);
 260                     }
 261                     hir::TraitItemKind::Type(..) => {}
 262                 }
 263             }
 264             Node::ImplItem(impl_item) => match impl_item.kind {
 265                 hir::ImplItemKind::Const(_, body) => {
 266                     self.visit_nested_body(body);
 267                 }
 268                 hir::ImplItemKind::Fn(_, body) => {
 269                     let impl_def_id = self.tcx.local_parent(search_item);
 270                     if method_might_be_inlined(self.tcx, impl_item, impl_def_id) {
 271                         self.visit_nested_body(body)
 272                     }
 273                 }
 274                 hir::ImplItemKind::Type(_) => {}
 275             },
 276             Node::Expr(&hir::Expr {
 277                 kind: hir::ExprKind::Closure(&hir::Closure { body, .. }),
 278                 ..
 279             }) => {
 280                 self.visit_nested_body(body);
 281             }
 282             // Nothing to recurse on for these
 283             Node::ForeignItem(_)
 284             | Node::Variant(_)
 285             | Node::Ctor(..)
 286             | Node::Field(_)
 287             | Node::Ty(_)
 288             | Node::Crate(_) => {}
 289             _ => {
 290                 bug!(
 291                     "found unexpected node kind in worklist: {} ({:?})",
 292                     self.tcx
 293                         .hir()
 294                         .node_to_string(self.tcx.hir().local_def_id_to_hir_id(search_item)),
 295                     node,
 296                 );
 297             }
 298         }
 299     }
 300 }
 301
 302 fn check_item<'tcx>(
 303     tcx: TyCtxt<'tcx>,
 304     id: hir::ItemId,
 305     worklist: &mut Vec<LocalDefId>,
 306     effective_visibilities: &privacy::EffectiveVisibilities,
 307 ) {
 308     if has_custom_linkage(tcx, id.owner_id.def_id) {
 309         worklist.push(id.owner_id.def_id);
 310     }
 311
 312     if !matches!(tcx.def_kind(id.owner_id), DefKind::Impl) {
 313         return;
 314     }
 315
 316     // We need only trait impls here, not inherent impls, and only non-exported ones
 317     let item = tcx.hir().item(id);
 318     if let hir::ItemKind::Impl(hir::Impl { of_trait: Some(ref trait_ref), ref items, .. }) =
 319         item.kind
 320     {
 321         if !effective_visibilities.is_reachable(item.owner_id.def_id) {
 322             worklist.extend(items.iter().map(|ii_ref| ii_ref.id.owner_id.def_id));
 323
 324             let Res::Def(DefKind::Trait, trait_def_id) = trait_ref.path.res else {
 325                 unreachable!();
 326             };
 327
 328             if !trait_def_id.is_local() {
 329                 return;
 330             }
 331
 332             worklist.extend(
 333                 tcx.provided_trait_methods(trait_def_id).map(|assoc| assoc.def_id.expect_local()),
 334             );
 335         }
 336     }
 337 }
 338
 339 fn has_custom_linkage<'tcx>(tcx: TyCtxt<'tcx>, def_id: LocalDefId) -> bool {
 340     // Anything which has custom linkage gets thrown on the worklist no
 341     // matter where it is in the crate, along with "special std symbols"
 342     // which are currently akin to allocator symbols.
 343     if !tcx.def_kind(def_id).has_codegen_attrs() {
 344         return false;
 345     }
 346     let codegen_attrs = tcx.codegen_fn_attrs(def_id);
 347     codegen_attrs.contains_extern_indicator()
 348         || codegen_attrs.flags.contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL)
 349         // FIXME(nbdd0121): `#[used]` are marked as reachable here so it's picked up by
 350         // `linked_symbols` in cg_ssa. They won't be exported in binary or cdylib due to their
 351         // `SymbolExportLevel::Rust` export level but may end up being exported in dylibs.
 352         || codegen_attrs.flags.contains(CodegenFnAttrFlags::USED)
 353         || codegen_attrs.flags.contains(CodegenFnAttrFlags::USED_LINKER)
 354 }
 355
 356 fn reachable_set<'tcx>(tcx: TyCtxt<'tcx>, (): ()) -> FxHashSet<LocalDefId> {
 357     let effective_visibilities = &tcx.effective_visibilities(());
 358
 359     let any_library =
 360         tcx.sess.crate_types().iter().any(|ty| {
 361             *ty == CrateType::Rlib || *ty == CrateType::Dylib || *ty == CrateType::ProcMacro
 362         });
 363     let mut reachable_context = ReachableContext {
 364         tcx,
 365         maybe_typeck_results: None,
 366         reachable_symbols: Default::default(),
 367         worklist: Vec::new(),
 368         any_library,
 369     };
 370
 371     // Step 1: Seed the worklist with all nodes which were found to be public as
 372     //         a result of the privacy pass along with all local lang items and impl items.
 373     //         If other crates link to us, they're going to expect to be able to
 374     //         use the lang items, so we need to be sure to mark them as
 375     //         exported.
 376     reachable_context.worklist = effective_visibilities
 377         .iter()
 378         .filter_map(|(&id, effective_vis)| {
 379             effective_vis.is_public_at_level(Level::ReachableThroughImplTrait).then_some(id)
 380         })
 381         .collect::<Vec<_>>();
 382
 383     for (_, def_id) in tcx.lang_items().iter() {
 384         if let Some(def_id) = def_id.as_local() {
 385             reachable_context.worklist.push(def_id);
 386         }
 387     }
 388     {
 389         // Some methods from non-exported (completely private) trait impls still have to be
 390         // reachable if they are called from inlinable code. Generally, it's not known until
 391         // monomorphization if a specific trait impl item can be reachable or not. So, we
 392         // conservatively mark all of them as reachable.
 393         // FIXME: One possible strategy for pruning the reachable set is to avoid marking impl
 394         // items of non-exported traits (or maybe all local traits?) unless their respective
 395         // trait items are used from inlinable code through method call syntax or UFCS, or their
 396         // trait is a lang item.
 397         let crate_items = tcx.hir_crate_items(());
 398
 399         for id in crate_items.items() {
 400             check_item(tcx, id, &mut reachable_context.worklist, effective_visibilities);
 401         }
 402
 403         for id in crate_items.impl_items() {
 404             if has_custom_linkage(tcx, id.owner_id.def_id) {
 405                 reachable_context.worklist.push(id.owner_id.def_id);
 406             }
 407         }
 408     }
 409
 410     // Step 2: Mark all symbols that the symbols on the worklist touch.
 411     reachable_context.propagate();
 412
 413     debug!("Inline reachability shows: {:?}", reachable_context.reachable_symbols);
 414
 415     // Return the set of reachable symbols.
 416     reachable_context.reachable_symbols
 417 }
 418
 419 pub fn provide(providers: &mut Providers) {
 420     *providers = Providers { reachable_set, ..*providers };
 421 }