src/librustc/mir/mono.rs

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