compiler/rustc_middle/src/mir/mono.rs

   1 use crate::dep_graph::{DepNode, WorkProduct, WorkProductId};
   2 use crate::ty::{subst::InternalSubsts, Instance, InstanceDef, SymbolName, TyCtxt};
   3 use rustc_attr::InlineAttr;
   4 use rustc_data_structures::base_n;
   5 use rustc_data_structures::fingerprint::Fingerprint;
   6 use rustc_data_structures::fx::FxHashMap;
   7 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
   8 use rustc_hir::def_id::{CrateNum, DefId, LOCAL_CRATE};
   9 use rustc_hir::ItemId;
  10 use rustc_query_system::ich::{NodeIdHashingMode, StableHashingContext};
  11 use rustc_session::config::OptLevel;
  12 use rustc_span::source_map::Span;
  13 use rustc_span::symbol::Symbol;
  14 use std::fmt;
  15 use std::hash::Hash;
  16
  17 /// Describes how a monomorphization will be instantiated in object files.
  18 #[derive(PartialEq)]
  19 pub enum InstantiationMode {
  20     /// There will be exactly one instance of the given MonoItem. It will have
  21     /// external linkage so that it can be linked to from other codegen units.
  22     GloballyShared {
  23         /// In some compilation scenarios we may decide to take functions that
  24         /// are typically `LocalCopy` and instead move them to `GloballyShared`
  25         /// to avoid codegenning them a bunch of times. In this situation,
  26         /// however, our local copy may conflict with other crates also
  27         /// inlining the same function.
  28         ///
  29         /// This flag indicates that this situation is occurring, and informs
  30         /// symbol name calculation that some extra mangling is needed to
  31         /// avoid conflicts. Note that this may eventually go away entirely if
  32         /// ThinLTO enables us to *always* have a globally shared instance of a
  33         /// function within one crate's compilation.
  34         may_conflict: bool,
  35     },
  36
  37     /// Each codegen unit containing a reference to the given MonoItem will
  38     /// have its own private copy of the function (with internal linkage).
  39     LocalCopy,
  40 }
  41
  42 #[derive(PartialEq, Eq, Clone, Copy, Debug, Hash)]
  43 pub enum MonoItem<'tcx> {
  44     Fn(Instance<'tcx>),
  45     Static(DefId),
  46     GlobalAsm(ItemId),
  47 }
  48
  49 impl<'tcx> MonoItem<'tcx> {
  50     /// Returns `true` if the mono item is user-defined (i.e. not compiler-generated, like shims).
  51     pub fn is_user_defined(&self) -> bool {
  52         match *self {
  53             MonoItem::Fn(instance) => matches!(instance.def, InstanceDef::Item(..)),
  54             MonoItem::Static(..) | MonoItem::GlobalAsm(..) => true,
  55         }
  56     }
  57
  58     pub fn size_estimate(&self, tcx: TyCtxt<'tcx>) -> usize {
  59         match *self {
  60             MonoItem::Fn(instance) => {
  61                 // Estimate the size of a function based on how many statements
  62                 // it contains.
  63                 tcx.instance_def_size_estimate(instance.def)
  64             }
  65             // Conservatively estimate the size of a static declaration
  66             // or assembly to be 1.
  67             MonoItem::Static(_) | MonoItem::GlobalAsm(_) => 1,
  68         }
  69     }
  70
  71     pub fn is_generic_fn(&self) -> bool {
  72         match *self {
  73             MonoItem::Fn(ref instance) => instance.substs.non_erasable_generics().next().is_some(),
  74             MonoItem::Static(..) | MonoItem::GlobalAsm(..) => false,
  75         }
  76     }
  77
  78     pub fn symbol_name(&self, tcx: TyCtxt<'tcx>) -> SymbolName<'tcx> {
  79         match *self {
  80             MonoItem::Fn(instance) => tcx.symbol_name(instance),
  81             MonoItem::Static(def_id) => tcx.symbol_name(Instance::mono(tcx, def_id)),
  82             MonoItem::GlobalAsm(item_id) => {
  83                 SymbolName::new(tcx, &format!("global_asm_{:?}", item_id.def_id))
  84             }
  85         }
  86     }
  87
  88     pub fn instantiation_mode(&self, tcx: TyCtxt<'tcx>) -> InstantiationMode {
  89         let generate_cgu_internal_copies = tcx
  90             .sess
  91             .opts
  92             .debugging_opts
  93             .inline_in_all_cgus
  94             .unwrap_or_else(|| tcx.sess.opts.optimize != OptLevel::No)
  95             && !tcx.sess.link_dead_code();
  96
  97         match *self {
  98             MonoItem::Fn(ref instance) => {
  99                 let entry_def_id = tcx.entry_fn(()).map(|(id, _)| id);
 100                 // If this function isn't inlined or otherwise has an extern
 101                 // indicator, then we'll be creating a globally shared version.
 102                 if tcx.codegen_fn_attrs(instance.def_id()).contains_extern_indicator()
 103                     || !instance.def.generates_cgu_internal_copy(tcx)
 104                     || Some(instance.def_id()) == entry_def_id
 105                 {
 106                     return InstantiationMode::GloballyShared { may_conflict: false };
 107                 }
 108
 109                 // At this point we don't have explicit linkage and we're an
 110                 // inlined function. If we're inlining into all CGUs then we'll
 111                 // be creating a local copy per CGU.
 112                 if generate_cgu_internal_copies {
 113                     return InstantiationMode::LocalCopy;
 114                 }
 115
 116                 // Finally, if this is `#[inline(always)]` we're sure to respect
 117                 // that with an inline copy per CGU, but otherwise we'll be
 118                 // creating one copy of this `#[inline]` function which may
 119                 // conflict with upstream crates as it could be an exported
 120                 // symbol.
 121                 match tcx.codegen_fn_attrs(instance.def_id()).inline {
 122                     InlineAttr::Always => InstantiationMode::LocalCopy,
 123                     _ => InstantiationMode::GloballyShared { may_conflict: true },
 124                 }
 125             }
 126             MonoItem::Static(..) | MonoItem::GlobalAsm(..) => {
 127                 InstantiationMode::GloballyShared { may_conflict: false }
 128             }
 129         }
 130     }
 131
 132     pub fn explicit_linkage(&self, tcx: TyCtxt<'tcx>) -> Option<Linkage> {
 133         let def_id = match *self {
 134             MonoItem::Fn(ref instance) => instance.def_id(),
 135             MonoItem::Static(def_id) => def_id,
 136             MonoItem::GlobalAsm(..) => return None,
 137         };
 138
 139         let codegen_fn_attrs = tcx.codegen_fn_attrs(def_id);
 140         codegen_fn_attrs.linkage
 141     }
 142
 143     /// Returns `true` if this instance is instantiable - whether it has no unsatisfied
 144     /// predicates.
 145     ///
 146     /// In order to codegen an item, all of its predicates must hold, because
 147     /// otherwise the item does not make sense. Type-checking ensures that
 148     /// the predicates of every item that is *used by* a valid item *do*
 149     /// hold, so we can rely on that.
 150     ///
 151     /// However, we codegen collector roots (reachable items) and functions
 152     /// in vtables when they are seen, even if they are not used, and so they
 153     /// might not be instantiable. For example, a programmer can define this
 154     /// public function:
 155     ///
 156     ///     pub fn foo<'a>(s: &'a mut ()) where &'a mut (): Clone {
 157     ///         <&mut () as Clone>::clone(&s);
 158     ///     }
 159     ///
 160     /// That function can't be codegened, because the method `<&mut () as Clone>::clone`
 161     /// does not exist. Luckily for us, that function can't ever be used,
 162     /// because that would require for `&'a mut (): Clone` to hold, so we
 163     /// can just not emit any code, or even a linker reference for it.
 164     ///
 165     /// Similarly, if a vtable method has such a signature, and therefore can't
 166     /// be used, we can just not emit it and have a placeholder (a null pointer,
 167     /// which will never be accessed) in its place.
 168     pub fn is_instantiable(&self, tcx: TyCtxt<'tcx>) -> bool {
 169         debug!("is_instantiable({:?})", self);
 170         let (def_id, substs) = match *self {
 171             MonoItem::Fn(ref instance) => (instance.def_id(), instance.substs),
 172             MonoItem::Static(def_id) => (def_id, InternalSubsts::empty()),
 173             // global asm never has predicates
 174             MonoItem::GlobalAsm(..) => return true,
 175         };
 176
 177         !tcx.subst_and_check_impossible_predicates((def_id, &substs))
 178     }
 179
 180     pub fn local_span(&self, tcx: TyCtxt<'tcx>) -> Option<Span> {
 181         match *self {
 182             MonoItem::Fn(Instance { def, .. }) => {
 183                 def.def_id().as_local().map(|def_id| tcx.hir().local_def_id_to_hir_id(def_id))
 184             }
 185             MonoItem::Static(def_id) => {
 186                 def_id.as_local().map(|def_id| tcx.hir().local_def_id_to_hir_id(def_id))
 187             }
 188             MonoItem::GlobalAsm(item_id) => Some(item_id.hir_id()),
 189         }
 190         .map(|hir_id| tcx.hir().span(hir_id))
 191     }
 192
 193     // Only used by rustc_codegen_cranelift
 194     pub fn codegen_dep_node(&self, tcx: TyCtxt<'tcx>) -> DepNode {
 195         crate::dep_graph::make_compile_mono_item(tcx, self)
 196     }
 197
 198     /// Returns the item's `CrateNum`
 199     pub fn krate(&self) -> CrateNum {
 200         match self {
 201             MonoItem::Fn(ref instance) => instance.def_id().krate,
 202             MonoItem::Static(def_id) => def_id.krate,
 203             MonoItem::GlobalAsm(..) => LOCAL_CRATE,
 204         }
 205     }
 206 }
 207
 208 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for MonoItem<'tcx> {
 209     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
 210         ::std::mem::discriminant(self).hash_stable(hcx, hasher);
 211
 212         match *self {
 213             MonoItem::Fn(ref instance) => {
 214                 instance.hash_stable(hcx, hasher);
 215             }
 216             MonoItem::Static(def_id) => {
 217                 def_id.hash_stable(hcx, hasher);
 218             }
 219             MonoItem::GlobalAsm(item_id) => {
 220                 hcx.with_node_id_hashing_mode(NodeIdHashingMode::HashDefPath, |hcx| {
 221                     item_id.hash_stable(hcx, hasher);
 222                 })
 223             }
 224         }
 225     }
 226 }
 227
 228 impl<'tcx> fmt::Display for MonoItem<'tcx> {
 229     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 230         match *self {
 231             MonoItem::Fn(instance) => write!(f, "fn {}", instance),
 232             MonoItem::Static(def_id) => {
 233                 write!(f, "static {}", Instance::new(def_id, InternalSubsts::empty()))
 234             }
 235             MonoItem::GlobalAsm(..) => write!(f, "global_asm"),
 236         }
 237     }
 238 }
 239
 240 #[derive(Debug)]
 241 pub struct CodegenUnit<'tcx> {
 242     /// A name for this CGU. Incremental compilation requires that
 243     /// name be unique amongst **all** crates. Therefore, it should
 244     /// contain something unique to this crate (e.g., a module path)
 245     /// as well as the crate name and disambiguator.
 246     name: Symbol,
 247     items: FxHashMap<MonoItem<'tcx>, (Linkage, Visibility)>,
 248     size_estimate: Option<usize>,
 249     primary: bool,
 250 }
 251
 252 /// Specifies the linkage type for a `MonoItem`.
 253 ///
 254 /// See <https://llvm.org/docs/LangRef.html#linkage-types> for more details about these variants.
 255 #[derive(Copy, Clone, PartialEq, Debug, TyEncodable, TyDecodable, HashStable)]
 256 pub enum Linkage {
 257     External,
 258     AvailableExternally,
 259     LinkOnceAny,
 260     LinkOnceODR,
 261     WeakAny,
 262     WeakODR,
 263     Appending,
 264     Internal,
 265     Private,
 266     ExternalWeak,
 267     Common,
 268 }
 269
 270 #[derive(Copy, Clone, PartialEq, Debug, HashStable)]
 271 pub enum Visibility {
 272     Default,
 273     Hidden,
 274     Protected,
 275 }
 276
 277 impl<'tcx> CodegenUnit<'tcx> {
 278     #[inline]
 279     pub fn new(name: Symbol) -> CodegenUnit<'tcx> {
 280         CodegenUnit { name, items: Default::default(), size_estimate: None, primary: false }
 281     }
 282
 283     pub fn name(&self) -> Symbol {
 284         self.name
 285     }
 286
 287     pub fn set_name(&mut self, name: Symbol) {
 288         self.name = name;
 289     }
 290
 291     pub fn is_primary(&self) -> bool {
 292         self.primary
 293     }
 294
 295     pub fn make_primary(&mut self) {
 296         self.primary = true;
 297     }
 298
 299     pub fn items(&self) -> &FxHashMap<MonoItem<'tcx>, (Linkage, Visibility)> {
 300         &self.items
 301     }
 302
 303     pub fn items_mut(&mut self) -> &mut FxHashMap<MonoItem<'tcx>, (Linkage, Visibility)> {
 304         &mut self.items
 305     }
 306
 307     pub fn mangle_name(human_readable_name: &str) -> String {
 308         // We generate a 80 bit hash from the name. This should be enough to
 309         // avoid collisions and is still reasonably short for filenames.
 310         let mut hasher = StableHasher::new();
 311         human_readable_name.hash(&mut hasher);
 312         let hash: u128 = hasher.finish();
 313         let hash = hash & ((1u128 << 80) - 1);
 314         base_n::encode(hash, base_n::CASE_INSENSITIVE)
 315     }
 316
 317     pub fn estimate_size(&mut self, tcx: TyCtxt<'tcx>) {
 318         // Estimate the size of a codegen unit as (approximately) the number of MIR
 319         // statements it corresponds to.
 320         self.size_estimate = Some(self.items.keys().map(|mi| mi.size_estimate(tcx)).sum());
 321     }
 322
 323     #[inline]
 324     pub fn size_estimate(&self) -> usize {
 325         // Should only be called if `estimate_size` has previously been called.
 326         self.size_estimate.expect("estimate_size must be called before getting a size_estimate")
 327     }
 328
 329     pub fn modify_size_estimate(&mut self, delta: usize) {
 330         assert!(self.size_estimate.is_some());
 331         if let Some(size_estimate) = self.size_estimate {
 332             self.size_estimate = Some(size_estimate + delta);
 333         }
 334     }
 335
 336     pub fn contains_item(&self, item: &MonoItem<'tcx>) -> bool {
 337         self.items().contains_key(item)
 338     }
 339
 340     pub fn work_product_id(&self) -> WorkProductId {
 341         WorkProductId::from_cgu_name(self.name().as_str())
 342     }
 343
 344     pub fn work_product(&self, tcx: TyCtxt<'_>) -> WorkProduct {
 345         let work_product_id = self.work_product_id();
 346         tcx.dep_graph
 347             .previous_work_product(&work_product_id)
 348             .unwrap_or_else(|| panic!("Could not find work-product for CGU `{}`", self.name()))
 349     }
 350
 351     pub fn items_in_deterministic_order(
 352         &self,
 353         tcx: TyCtxt<'tcx>,
 354     ) -> Vec<(MonoItem<'tcx>, (Linkage, Visibility))> {
 355         // The codegen tests rely on items being process in the same order as
 356         // they appear in the file, so for local items, we sort by node_id first
 357         #[derive(PartialEq, Eq, PartialOrd, Ord)]
 358         pub struct ItemSortKey<'tcx>(Option<usize>, SymbolName<'tcx>);
 359
 360         fn item_sort_key<'tcx>(tcx: TyCtxt<'tcx>, item: MonoItem<'tcx>) -> ItemSortKey<'tcx> {
 361             ItemSortKey(
 362                 match item {
 363                     MonoItem::Fn(ref instance) => {
 364                         match instance.def {
 365                             // We only want to take HirIds of user-defined
 366                             // instances into account. The others don't matter for
 367                             // the codegen tests and can even make item order
 368                             // unstable.
 369                             InstanceDef::Item(def) => Some(def.did.index.as_usize()),
 370                             InstanceDef::VtableShim(..)
 371                             | InstanceDef::ReifyShim(..)
 372                             | InstanceDef::Intrinsic(..)
 373                             | InstanceDef::FnPtrShim(..)
 374                             | InstanceDef::Virtual(..)
 375                             | InstanceDef::ClosureOnceShim { .. }
 376                             | InstanceDef::DropGlue(..)
 377                             | InstanceDef::CloneShim(..) => None,
 378                         }
 379                     }
 380                     MonoItem::Static(def_id) => Some(def_id.index.as_usize()),
 381                     MonoItem::GlobalAsm(item_id) => {
 382                         Some(item_id.def_id.to_def_id().index.as_usize())
 383                     }
 384                 },
 385                 item.symbol_name(tcx),
 386             )
 387         }
 388
 389         let mut items: Vec<_> = self.items().iter().map(|(&i, &l)| (i, l)).collect();
 390         items.sort_by_cached_key(|&(i, _)| item_sort_key(tcx, i));
 391         items
 392     }
 393
 394     pub fn codegen_dep_node(&self, tcx: TyCtxt<'tcx>) -> DepNode {
 395         crate::dep_graph::make_compile_codegen_unit(tcx, self.name())
 396     }
 397 }
 398
 399 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for CodegenUnit<'tcx> {
 400     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
 401         let CodegenUnit {
 402             ref items,
 403             name,
 404             // The size estimate is not relevant to the hash
 405             size_estimate: _,
 406             primary: _,
 407         } = *self;
 408
 409         name.hash_stable(hcx, hasher);
 410
 411         let mut items: Vec<(Fingerprint, _)> = items
 412             .iter()
 413             .map(|(mono_item, &attrs)| {
 414                 let mut hasher = StableHasher::new();
 415                 mono_item.hash_stable(hcx, &mut hasher);
 416                 let mono_item_fingerprint = hasher.finish();
 417                 (mono_item_fingerprint, attrs)
 418             })
 419             .collect();
 420
 421         items.sort_unstable_by_key(|i| i.0);
 422         items.hash_stable(hcx, hasher);
 423     }
 424 }
 425
 426 pub struct CodegenUnitNameBuilder<'tcx> {
 427     tcx: TyCtxt<'tcx>,
 428     cache: FxHashMap<CrateNum, String>,
 429 }
 430
 431 impl<'tcx> CodegenUnitNameBuilder<'tcx> {
 432     pub fn new(tcx: TyCtxt<'tcx>) -> Self {
 433         CodegenUnitNameBuilder { tcx, cache: Default::default() }
 434     }
 435
 436     /// CGU names should fulfill the following requirements:
 437     /// - They should be able to act as a file name on any kind of file system
 438     /// - They should not collide with other CGU names, even for different versions
 439     ///   of the same crate.
 440     ///
 441     /// Consequently, we don't use special characters except for '.' and '-' and we
 442     /// prefix each name with the crate-name and crate-disambiguator.
 443     ///
 444     /// This function will build CGU names of the form:
 445     ///
 446     /// ```
 447     /// <crate-name>.<crate-disambiguator>[-in-<local-crate-id>](-<component>)*[.<special-suffix>]
 448     /// <local-crate-id> = <local-crate-name>.<local-crate-disambiguator>
 449     /// ```
 450     ///
 451     /// The '.' before `<special-suffix>` makes sure that names with a special
 452     /// suffix can never collide with a name built out of regular Rust
 453     /// identifiers (e.g., module paths).
 454     pub fn build_cgu_name<I, C, S>(
 455         &mut self,
 456         cnum: CrateNum,
 457         components: I,
 458         special_suffix: Option<S>,
 459     ) -> Symbol
 460     where
 461         I: IntoIterator<Item = C>,
 462         C: fmt::Display,
 463         S: fmt::Display,
 464     {
 465         let cgu_name = self.build_cgu_name_no_mangle(cnum, components, special_suffix);
 466
 467         if self.tcx.sess.opts.debugging_opts.human_readable_cgu_names {
 468             cgu_name
 469         } else {
 470             Symbol::intern(&CodegenUnit::mangle_name(cgu_name.as_str()))
 471         }
 472     }
 473
 474     /// Same as `CodegenUnit::build_cgu_name()` but will never mangle the
 475     /// resulting name.
 476     pub fn build_cgu_name_no_mangle<I, C, S>(
 477         &mut self,
 478         cnum: CrateNum,
 479         components: I,
 480         special_suffix: Option<S>,
 481     ) -> Symbol
 482     where
 483         I: IntoIterator<Item = C>,
 484         C: fmt::Display,
 485         S: fmt::Display,
 486     {
 487         use std::fmt::Write;
 488
 489         let mut cgu_name = String::with_capacity(64);
 490
 491         // Start out with the crate name and disambiguator
 492         let tcx = self.tcx;
 493         let crate_prefix = self.cache.entry(cnum).or_insert_with(|| {
 494             // Whenever the cnum is not LOCAL_CRATE we also mix in the
 495             // local crate's ID. Otherwise there can be collisions between CGUs
 496             // instantiating stuff for upstream crates.
 497             let local_crate_id = if cnum != LOCAL_CRATE {
 498                 let local_stable_crate_id = tcx.sess.local_stable_crate_id();
 499                 format!(
 500                     "-in-{}.{:08x}",
 501                     tcx.crate_name(LOCAL_CRATE),
 502                     local_stable_crate_id.to_u64() as u32,
 503                 )
 504             } else {
 505                 String::new()
 506             };
 507
 508             let stable_crate_id = tcx.sess.local_stable_crate_id();
 509             format!(
 510                 "{}.{:08x}{}",
 511                 tcx.crate_name(cnum),
 512                 stable_crate_id.to_u64() as u32,
 513                 local_crate_id,
 514             )
 515         });
 516
 517         write!(cgu_name, "{}", crate_prefix).unwrap();
 518
 519         // Add the components
 520         for component in components {
 521             write!(cgu_name, "-{}", component).unwrap();
 522         }
 523
 524         if let Some(special_suffix) = special_suffix {
 525             // We add a dot in here so it cannot clash with anything in a regular
 526             // Rust identifier
 527             write!(cgu_name, ".{}", special_suffix).unwrap();
 528         }
 529
 530         Symbol::intern(&cgu_name)
 531     }
 532 }