src/librustc_mir/monomorphize/item.rs

   1 use crate::monomorphize::Instance;
   2 use rustc::hir;
   3 use rustc::hir::def_id::{DefId, LOCAL_CRATE};
   4 use rustc::session::config::OptLevel;
   5 use rustc::ty::{self, Ty, TyCtxt, ClosureSubsts, GeneratorSubsts};
   6 use rustc::ty::subst::Substs;
   7 use syntax::ast;
   8 use syntax::attr::InlineAttr;
   9 use std::fmt::{self, Write};
  10 use std::iter;
  11 use rustc::mir::mono::Linkage;
  12 use syntax_pos::symbol::Symbol;
  13 use syntax::source_map::Span;
  14 pub use rustc::mir::mono::MonoItem;
  15
  16 /// Describes how a monomorphization will be instantiated in object files.
  17 #[derive(PartialEq, Eq, Clone, Copy, Debug, Hash)]
  18 pub enum InstantiationMode {
  19     /// There will be exactly one instance of the given MonoItem. It will have
  20     /// external linkage so that it can be linked to from other codegen units.
  21     GloballyShared {
  22         /// In some compilation scenarios we may decide to take functions that
  23         /// are typically `LocalCopy` and instead move them to `GloballyShared`
  24         /// to avoid codegenning them a bunch of times. In this situation,
  25         /// however, our local copy may conflict with other crates also
  26         /// inlining the same function.
  27         ///
  28         /// This flag indicates that this situation is occurring, and informs
  29         /// symbol name calculation that some extra mangling is needed to
  30         /// avoid conflicts. Note that this may eventually go away entirely if
  31         /// ThinLTO enables us to *always* have a globally shared instance of a
  32         /// function within one crate's compilation.
  33         may_conflict: bool,
  34     },
  35
  36     /// Each codegen unit containing a reference to the given MonoItem will
  37     /// have its own private copy of the function (with internal linkage).
  38     LocalCopy,
  39 }
  40
  41 pub trait MonoItemExt<'a, 'tcx>: fmt::Debug {
  42     fn as_mono_item(&self) -> &MonoItem<'tcx>;
  43
  44     fn is_generic_fn(&self) -> bool {
  45         match *self.as_mono_item() {
  46             MonoItem::Fn(ref instance) => {
  47                 instance.substs.types().next().is_some()
  48             }
  49             MonoItem::Static(..) |
  50             MonoItem::GlobalAsm(..) => false,
  51         }
  52     }
  53
  54     fn symbol_name(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> ty::SymbolName {
  55         match *self.as_mono_item() {
  56             MonoItem::Fn(instance) => tcx.symbol_name(instance),
  57             MonoItem::Static(def_id) => {
  58                 tcx.symbol_name(Instance::mono(tcx, def_id))
  59             }
  60             MonoItem::GlobalAsm(node_id) => {
  61                 let def_id = tcx.hir().local_def_id(node_id);
  62                 ty::SymbolName {
  63                     name: Symbol::intern(&format!("global_asm_{:?}", def_id)).as_interned_str()
  64                 }
  65             }
  66         }
  67     }
  68     fn instantiation_mode(&self,
  69                           tcx: TyCtxt<'a, 'tcx, 'tcx>)
  70                           -> InstantiationMode {
  71         let inline_in_all_cgus =
  72             tcx.sess.opts.debugging_opts.inline_in_all_cgus.unwrap_or_else(|| {
  73                 tcx.sess.opts.optimize != OptLevel::No
  74             }) && !tcx.sess.opts.cg.link_dead_code;
  75
  76         match *self.as_mono_item() {
  77             MonoItem::Fn(ref instance) => {
  78                 let entry_def_id = tcx.entry_fn(LOCAL_CRATE).map(|(id, _)| id);
  79                 // If this function isn't inlined or otherwise has explicit
  80                 // linkage, then we'll be creating a globally shared version.
  81                 if self.explicit_linkage(tcx).is_some() ||
  82                     !instance.def.requires_local(tcx) ||
  83                     Some(instance.def_id()) == entry_def_id
  84                 {
  85                     return InstantiationMode::GloballyShared  { may_conflict: false }
  86                 }
  87
  88                 // At this point we don't have explicit linkage and we're an
  89                 // inlined function. If we're inlining into all CGUs then we'll
  90                 // be creating a local copy per CGU
  91                 if inline_in_all_cgus {
  92                     return InstantiationMode::LocalCopy
  93                 }
  94
  95                 // Finally, if this is `#[inline(always)]` we're sure to respect
  96                 // that with an inline copy per CGU, but otherwise we'll be
  97                 // creating one copy of this `#[inline]` function which may
  98                 // conflict with upstream crates as it could be an exported
  99                 // symbol.
 100                 match tcx.codegen_fn_attrs(instance.def_id()).inline {
 101                     InlineAttr::Always => InstantiationMode::LocalCopy,
 102                     _ => {
 103                         InstantiationMode::GloballyShared  { may_conflict: true }
 104                     }
 105                 }
 106             }
 107             MonoItem::Static(..) |
 108             MonoItem::GlobalAsm(..) => {
 109                 InstantiationMode::GloballyShared { may_conflict: false }
 110             }
 111         }
 112     }
 113
 114     fn explicit_linkage(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Option<Linkage> {
 115         let def_id = match *self.as_mono_item() {
 116             MonoItem::Fn(ref instance) => instance.def_id(),
 117             MonoItem::Static(def_id) => def_id,
 118             MonoItem::GlobalAsm(..) => return None,
 119         };
 120
 121         let codegen_fn_attrs = tcx.codegen_fn_attrs(def_id);
 122         codegen_fn_attrs.linkage
 123     }
 124
 125     /// Returns `true` if this instance is instantiable - whether it has no unsatisfied
 126     /// predicates.
 127     ///
 128     /// In order to codegen an item, all of its predicates must hold, because
 129     /// otherwise the item does not make sense. Type-checking ensures that
 130     /// the predicates of every item that is *used by* a valid item *do*
 131     /// hold, so we can rely on that.
 132     ///
 133     /// However, we codegen collector roots (reachable items) and functions
 134     /// in vtables when they are seen, even if they are not used, and so they
 135     /// might not be instantiable. For example, a programmer can define this
 136     /// public function:
 137     ///
 138     ///     pub fn foo<'a>(s: &'a mut ()) where &'a mut (): Clone {
 139     ///         <&mut () as Clone>::clone(&s);
 140     ///     }
 141     ///
 142     /// That function can't be codegened, because the method `<&mut () as Clone>::clone`
 143     /// does not exist. Luckily for us, that function can't ever be used,
 144     /// because that would require for `&'a mut (): Clone` to hold, so we
 145     /// can just not emit any code, or even a linker reference for it.
 146     ///
 147     /// Similarly, if a vtable method has such a signature, and therefore can't
 148     /// be used, we can just not emit it and have a placeholder (a null pointer,
 149     /// which will never be accessed) in its place.
 150     fn is_instantiable(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> bool {
 151         debug!("is_instantiable({:?})", self);
 152         let (def_id, substs) = match *self.as_mono_item() {
 153             MonoItem::Fn(ref instance) => (instance.def_id(), instance.substs),
 154             MonoItem::Static(def_id) => (def_id, Substs::empty()),
 155             // global asm never has predicates
 156             MonoItem::GlobalAsm(..) => return true
 157         };
 158
 159         tcx.substitute_normalize_and_test_predicates((def_id, &substs))
 160     }
 161
 162     fn to_string(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, debug: bool) -> String {
 163         return match *self.as_mono_item() {
 164             MonoItem::Fn(instance) => {
 165                 to_string_internal(tcx, "fn ", instance, debug)
 166             },
 167             MonoItem::Static(def_id) => {
 168                 let instance = Instance::new(def_id, tcx.intern_substs(&[]));
 169                 to_string_internal(tcx, "static ", instance, debug)
 170             },
 171             MonoItem::GlobalAsm(..) => {
 172                 "global_asm".to_string()
 173             }
 174         };
 175
 176         fn to_string_internal<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
 177                                         prefix: &str,
 178                                         instance: Instance<'tcx>,
 179                                         debug: bool)
 180                                         -> String {
 181             let mut result = String::with_capacity(32);
 182             result.push_str(prefix);
 183             let printer = DefPathBasedNames::new(tcx, false, false);
 184             printer.push_instance_as_string(instance, &mut result, debug);
 185             result
 186         }
 187     }
 188
 189     fn local_span(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Option<Span> {
 190         match *self.as_mono_item() {
 191             MonoItem::Fn(Instance { def, .. }) => {
 192                 tcx.hir().as_local_node_id(def.def_id())
 193             }
 194             MonoItem::Static(def_id) => {
 195                 tcx.hir().as_local_node_id(def_id)
 196             }
 197             MonoItem::GlobalAsm(node_id) => {
 198                 Some(node_id)
 199             }
 200         }.map(|node_id| tcx.hir().span(node_id))
 201     }
 202 }
 203
 204 impl<'a, 'tcx> MonoItemExt<'a, 'tcx> for MonoItem<'tcx> {
 205     fn as_mono_item(&self) -> &MonoItem<'tcx> {
 206         self
 207     }
 208 }
 209
 210 //=-----------------------------------------------------------------------------
 211 // MonoItem String Keys
 212 //=-----------------------------------------------------------------------------
 213
 214 // The code below allows for producing a unique string key for a mono item.
 215 // These keys are used by the handwritten auto-tests, so they need to be
 216 // predictable and human-readable.
 217 //
 218 // Note: A lot of this could looks very similar to what's already in the
 219 //       ppaux module. It would be good to refactor things so we only have one
 220 //       parameterizable implementation for printing types.
 221
 222 /// Same as `unique_type_name()` but with the result pushed onto the given
 223 /// `output` parameter.
 224 pub struct DefPathBasedNames<'a, 'tcx: 'a> {
 225     tcx: TyCtxt<'a, 'tcx, 'tcx>,
 226     omit_disambiguators: bool,
 227     omit_local_crate_name: bool,
 228 }
 229
 230 impl<'a, 'tcx> DefPathBasedNames<'a, 'tcx> {
 231     pub fn new(tcx: TyCtxt<'a, 'tcx, 'tcx>,
 232                omit_disambiguators: bool,
 233                omit_local_crate_name: bool)
 234                -> Self {
 235         DefPathBasedNames {
 236             tcx,
 237             omit_disambiguators,
 238             omit_local_crate_name,
 239         }
 240     }
 241
 242     // Pushes the type name of the specified type to the provided string.
 243     // If 'debug' is true, printing normally unprintable types is allowed
 244     // (e.g. ty::GeneratorWitness). This parameter should only be set when
 245     // this method is being used for logging purposes (e.g. with debug! or info!)
 246     // When being used for codegen purposes, 'debug' should be set to 'false'
 247     // in order to catch unexpected types that should never end up in a type name
 248     pub fn push_type_name(&self, t: Ty<'tcx>, output: &mut String, debug: bool) {
 249         match t.sty {
 250             ty::Bool              => output.push_str("bool"),
 251             ty::Char              => output.push_str("char"),
 252             ty::Str               => output.push_str("str"),
 253             ty::Never             => output.push_str("!"),
 254             ty::Int(ast::IntTy::Isize)    => output.push_str("isize"),
 255             ty::Int(ast::IntTy::I8)    => output.push_str("i8"),
 256             ty::Int(ast::IntTy::I16)   => output.push_str("i16"),
 257             ty::Int(ast::IntTy::I32)   => output.push_str("i32"),
 258             ty::Int(ast::IntTy::I64)   => output.push_str("i64"),
 259             ty::Int(ast::IntTy::I128)   => output.push_str("i128"),
 260             ty::Uint(ast::UintTy::Usize)   => output.push_str("usize"),
 261             ty::Uint(ast::UintTy::U8)   => output.push_str("u8"),
 262             ty::Uint(ast::UintTy::U16)  => output.push_str("u16"),
 263             ty::Uint(ast::UintTy::U32)  => output.push_str("u32"),
 264             ty::Uint(ast::UintTy::U64)  => output.push_str("u64"),
 265             ty::Uint(ast::UintTy::U128)  => output.push_str("u128"),
 266             ty::Float(ast::FloatTy::F32) => output.push_str("f32"),
 267             ty::Float(ast::FloatTy::F64) => output.push_str("f64"),
 268             ty::Adt(adt_def, substs) => {
 269                 self.push_def_path(adt_def.did, output);
 270                 self.push_type_params(substs, iter::empty(), output, debug);
 271             },
 272             ty::Tuple(component_types) => {
 273                 output.push('(');
 274                 for &component_type in component_types {
 275                     self.push_type_name(component_type, output, debug);
 276                     output.push_str(", ");
 277                 }
 278                 if !component_types.is_empty() {
 279                     output.pop();
 280                     output.pop();
 281                 }
 282                 output.push(')');
 283             },
 284             ty::RawPtr(ty::TypeAndMut { ty: inner_type, mutbl } ) => {
 285                 output.push('*');
 286                 match mutbl {
 287                     hir::MutImmutable => output.push_str("const "),
 288                     hir::MutMutable => output.push_str("mut "),
 289                 }
 290
 291                 self.push_type_name(inner_type, output, debug);
 292             },
 293             ty::Ref(_, inner_type, mutbl) => {
 294                 output.push('&');
 295                 if mutbl == hir::MutMutable {
 296                     output.push_str("mut ");
 297                 }
 298
 299                 self.push_type_name(inner_type, output, debug);
 300             },
 301             ty::Array(inner_type, len) => {
 302                 output.push('[');
 303                 self.push_type_name(inner_type, output, debug);
 304                 write!(output, "; {}", len.unwrap_usize(self.tcx)).unwrap();
 305                 output.push(']');
 306             },
 307             ty::Slice(inner_type) => {
 308                 output.push('[');
 309                 self.push_type_name(inner_type, output, debug);
 310                 output.push(']');
 311             },
 312             ty::Dynamic(ref trait_data, ..) => {
 313                 if let Some(principal) = trait_data.principal() {
 314                     self.push_def_path(principal.def_id(), output);
 315                     self.push_type_params(
 316                         principal.skip_binder().substs,
 317                         trait_data.projection_bounds(),
 318                         output,
 319                         debug
 320                     );
 321                 } else {
 322                     output.push_str("dyn '_");
 323                 }
 324             },
 325             ty::Foreign(did) => self.push_def_path(did, output),
 326             ty::FnDef(..) |
 327             ty::FnPtr(_) => {
 328                 let sig = t.fn_sig(self.tcx);
 329                 if sig.unsafety() == hir::Unsafety::Unsafe {
 330                     output.push_str("unsafe ");
 331                 }
 332
 333                 let abi = sig.abi();
 334                 if abi != ::rustc_target::spec::abi::Abi::Rust {
 335                     output.push_str("extern \"");
 336                     output.push_str(abi.name());
 337                     output.push_str("\" ");
 338                 }
 339
 340                 output.push_str("fn(");
 341
 342                 let sig = self.tcx.normalize_erasing_late_bound_regions(
 343                     ty::ParamEnv::reveal_all(),
 344                     &sig,
 345                 );
 346
 347                 if !sig.inputs().is_empty() {
 348                     for &parameter_type in sig.inputs() {
 349                         self.push_type_name(parameter_type, output, debug);
 350                         output.push_str(", ");
 351                     }
 352                     output.pop();
 353                     output.pop();
 354                 }
 355
 356                 if sig.variadic {
 357                     if !sig.inputs().is_empty() {
 358                         output.push_str(", ...");
 359                     } else {
 360                         output.push_str("...");
 361                     }
 362                 }
 363
 364                 output.push(')');
 365
 366                 if !sig.output().is_unit() {
 367                     output.push_str(" -> ");
 368                     self.push_type_name(sig.output(), output, debug);
 369                 }
 370             },
 371             ty::Generator(def_id, GeneratorSubsts { ref substs }, _) |
 372             ty::Closure(def_id, ClosureSubsts { ref substs }) => {
 373                 self.push_def_path(def_id, output);
 374                 let generics = self.tcx.generics_of(self.tcx.closure_base_def_id(def_id));
 375                 let substs = substs.truncate_to(self.tcx, generics);
 376                 self.push_type_params(substs, iter::empty(), output, debug);
 377             }
 378             ty::Error |
 379             ty::Bound(..) |
 380             ty::Infer(_) |
 381             ty::Placeholder(..) |
 382             ty::UnnormalizedProjection(..) |
 383             ty::Projection(..) |
 384             ty::Param(_) |
 385             ty::GeneratorWitness(_) |
 386             ty::Opaque(..) => {
 387                 if debug {
 388                     output.push_str(&format!("`{:?}`", t));
 389                 } else {
 390                     bug!("DefPathBasedNames: Trying to create type name for \
 391                                          unexpected type: {:?}", t);
 392                 }
 393             }
 394         }
 395     }
 396
 397     pub fn push_def_path(&self,
 398                          def_id: DefId,
 399                          output: &mut String) {
 400         let def_path = self.tcx.def_path(def_id);
 401
 402         // some_crate::
 403         if !(self.omit_local_crate_name && def_id.is_local()) {
 404             output.push_str(&self.tcx.crate_name(def_path.krate).as_str());
 405             output.push_str("::");
 406         }
 407
 408         // foo::bar::ItemName::
 409         for part in self.tcx.def_path(def_id).data {
 410             if self.omit_disambiguators {
 411                 write!(output, "{}::", part.data.as_interned_str()).unwrap();
 412             } else {
 413                 write!(output, "{}[{}]::",
 414                        part.data.as_interned_str(),
 415                        part.disambiguator).unwrap();
 416             }
 417         }
 418
 419         // remove final "::"
 420         output.pop();
 421         output.pop();
 422     }
 423
 424     fn push_type_params<I>(&self,
 425                             substs: &Substs<'tcx>,
 426                             projections: I,
 427                             output: &mut String,
 428                             debug: bool)
 429         where I: Iterator<Item=ty::PolyExistentialProjection<'tcx>>
 430     {
 431         let mut projections = projections.peekable();
 432         if substs.types().next().is_none() && projections.peek().is_none() {
 433             return;
 434         }
 435
 436         output.push('<');
 437
 438         for type_parameter in substs.types() {
 439             self.push_type_name(type_parameter, output, debug);
 440             output.push_str(", ");
 441         }
 442
 443         for projection in projections {
 444             let projection = projection.skip_binder();
 445             let name = &self.tcx.associated_item(projection.item_def_id).ident.as_str();
 446             output.push_str(name);
 447             output.push_str("=");
 448             self.push_type_name(projection.ty, output, debug);
 449             output.push_str(", ");
 450         }
 451
 452         output.pop();
 453         output.pop();
 454
 455         output.push('>');
 456     }
 457
 458     pub fn push_instance_as_string(&self,
 459                                    instance: Instance<'tcx>,
 460                                    output: &mut String,
 461                                    debug: bool) {
 462         self.push_def_path(instance.def_id(), output);
 463         self.push_type_params(instance.substs, iter::empty(), output, debug);
 464     }
 465 }