src/librustc_trans/context.rs

   1 // Copyright 2013 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use llvm;
  12 use llvm::{ContextRef, ModuleRef, ValueRef};
  13 use rustc::dep_graph::{DepGraph, DepGraphSafe};
  14 use rustc::hir;
  15 use rustc::hir::def_id::DefId;
  16 use rustc::traits;
  17 use debuginfo;
  18 use callee;
  19 use base;
  20 use declare;
  21 use monomorphize::Instance;
  22
  23 use partitioning::CodegenUnit;
  24 use type_::Type;
  25 use rustc_data_structures::base_n;
  26 use rustc::ty::subst::Substs;
  27 use rustc::ty::{self, Ty, TyCtxt};
  28 use rustc::ty::layout::{LayoutTyper, TyLayout};
  29 use session::config::NoDebugInfo;
  30 use session::Session;
  31 use session::config;
  32 use util::nodemap::{NodeSet, DefIdMap, FxHashMap};
  33
  34 use std::ffi::{CStr, CString};
  35 use std::cell::{Cell, RefCell};
  36 use std::ptr;
  37 use std::iter;
  38 use std::str;
  39 use std::marker::PhantomData;
  40 use syntax::ast;
  41 use syntax::symbol::InternedString;
  42 use syntax_pos::DUMMY_SP;
  43 use abi::Abi;
  44
  45 #[derive(Clone, Default)]
  46 pub struct Stats {
  47     pub n_glues_created: Cell<usize>,
  48     pub n_null_glues: Cell<usize>,
  49     pub n_real_glues: Cell<usize>,
  50     pub n_fns: Cell<usize>,
  51     pub n_inlines: Cell<usize>,
  52     pub n_closures: Cell<usize>,
  53     pub n_llvm_insns: Cell<usize>,
  54     pub llvm_insns: RefCell<FxHashMap<String, usize>>,
  55     // (ident, llvm-instructions)
  56     pub fn_stats: RefCell<Vec<(String, usize)> >,
  57 }
  58
  59 impl Stats {
  60     pub fn extend(&mut self, stats: Stats) {
  61         self.n_glues_created.set(self.n_glues_created.get() + stats.n_glues_created.get());
  62         self.n_null_glues.set(self.n_null_glues.get() + stats.n_null_glues.get());
  63         self.n_real_glues.set(self.n_real_glues.get() + stats.n_real_glues.get());
  64         self.n_fns.set(self.n_fns.get() + stats.n_fns.get());
  65         self.n_inlines.set(self.n_inlines.get() + stats.n_inlines.get());
  66         self.n_closures.set(self.n_closures.get() + stats.n_closures.get());
  67         self.n_llvm_insns.set(self.n_llvm_insns.get() + stats.n_llvm_insns.get());
  68         self.llvm_insns.borrow_mut().extend(
  69             stats.llvm_insns.borrow().iter()
  70                                      .map(|(key, value)| (key.clone(), value.clone())));
  71         self.fn_stats.borrow_mut().append(&mut *stats.fn_stats.borrow_mut());
  72     }
  73 }
  74
  75 /// The shared portion of a `CrateContext`.  There is one `SharedCrateContext`
  76 /// per crate.  The data here is shared between all compilation units of the
  77 /// crate, so it must not contain references to any LLVM data structures
  78 /// (aside from metadata-related ones).
  79 pub struct SharedCrateContext<'a, 'tcx: 'a> {
  80     exported_symbols: NodeSet,
  81     tcx: TyCtxt<'a, 'tcx, 'tcx>,
  82     check_overflow: bool,
  83
  84     use_dll_storage_attrs: bool,
  85 }
  86
  87 /// The local portion of a `CrateContext`.  There is one `LocalCrateContext`
  88 /// per compilation unit.  Each one has its own LLVM `ContextRef` so that
  89 /// several compilation units may be optimized in parallel.  All other LLVM
  90 /// data structures in the `LocalCrateContext` are tied to that `ContextRef`.
  91 pub struct LocalCrateContext<'a, 'tcx: 'a> {
  92     llmod: ModuleRef,
  93     llcx: ContextRef,
  94     stats: Stats,
  95     codegen_unit: CodegenUnit<'tcx>,
  96     /// Cache instances of monomorphic and polymorphic items
  97     instances: RefCell<FxHashMap<Instance<'tcx>, ValueRef>>,
  98     /// Cache generated vtables
  99     vtables: RefCell<FxHashMap<(ty::Ty<'tcx>,
 100                                 Option<ty::PolyExistentialTraitRef<'tcx>>), ValueRef>>,
 101     /// Cache of constant strings,
 102     const_cstr_cache: RefCell<FxHashMap<InternedString, ValueRef>>,
 103
 104     /// Reverse-direction for const ptrs cast from globals.
 105     /// Key is a ValueRef holding a *T,
 106     /// Val is a ValueRef holding a *[T].
 107     ///
 108     /// Needed because LLVM loses pointer->pointee association
 109     /// when we ptrcast, and we have to ptrcast during translation
 110     /// of a [T] const because we form a slice, a (*T,usize) pair, not
 111     /// a pointer to an LLVM array type. Similar for trait objects.
 112     const_unsized: RefCell<FxHashMap<ValueRef, ValueRef>>,
 113
 114     /// Cache of emitted const globals (value -> global)
 115     const_globals: RefCell<FxHashMap<ValueRef, ValueRef>>,
 116
 117     /// Cache of emitted const values
 118     const_values: RefCell<FxHashMap<(ast::NodeId, &'tcx Substs<'tcx>), ValueRef>>,
 119
 120     /// Cache of external const values
 121     extern_const_values: RefCell<DefIdMap<ValueRef>>,
 122
 123     /// Mapping from static definitions to their DefId's.
 124     statics: RefCell<FxHashMap<ValueRef, DefId>>,
 125
 126     /// List of globals for static variables which need to be passed to the
 127     /// LLVM function ReplaceAllUsesWith (RAUW) when translation is complete.
 128     /// (We have to make sure we don't invalidate any ValueRefs referring
 129     /// to constants.)
 130     statics_to_rauw: RefCell<Vec<(ValueRef, ValueRef)>>,
 131
 132     /// Statics that will be placed in the llvm.used variable
 133     /// See http://llvm.org/docs/LangRef.html#the-llvm-used-global-variable for details
 134     used_statics: RefCell<Vec<ValueRef>>,
 135
 136     lltypes: RefCell<FxHashMap<Ty<'tcx>, Type>>,
 137     type_hashcodes: RefCell<FxHashMap<Ty<'tcx>, String>>,
 138     int_type: Type,
 139     opaque_vec_type: Type,
 140     str_slice_type: Type,
 141
 142     dbg_cx: Option<debuginfo::CrateDebugContext<'tcx>>,
 143
 144     eh_personality: Cell<Option<ValueRef>>,
 145     eh_unwind_resume: Cell<Option<ValueRef>>,
 146     rust_try_fn: Cell<Option<ValueRef>>,
 147
 148     intrinsics: RefCell<FxHashMap<&'static str, ValueRef>>,
 149
 150     /// Depth of the current type-of computation - used to bail out
 151     type_of_depth: Cell<usize>,
 152
 153     /// A counter that is used for generating local symbol names
 154     local_gen_sym_counter: Cell<usize>,
 155
 156     /// A placeholder so we can add lifetimes
 157     placeholder: PhantomData<&'a ()>,
 158 }
 159
 160 /// A CrateContext value binds together one LocalCrateContext with the
 161 /// SharedCrateContext. It exists as a convenience wrapper, so we don't have to
 162 /// pass around (SharedCrateContext, LocalCrateContext) tuples all over trans.
 163 pub struct CrateContext<'a, 'tcx: 'a> {
 164     shared: &'a SharedCrateContext<'a, 'tcx>,
 165     local_ccx: &'a LocalCrateContext<'a, 'tcx>,
 166 }
 167
 168 impl<'a, 'tcx> CrateContext<'a, 'tcx> {
 169     pub fn new(shared: &'a SharedCrateContext<'a, 'tcx>,
 170                local_ccx: &'a LocalCrateContext<'a, 'tcx>)
 171                -> Self {
 172         CrateContext { shared, local_ccx }
 173     }
 174 }
 175
 176 impl<'a, 'tcx> DepGraphSafe for CrateContext<'a, 'tcx> {
 177 }
 178
 179 pub fn get_reloc_model(sess: &Session) -> llvm::RelocMode {
 180     let reloc_model_arg = match sess.opts.cg.relocation_model {
 181         Some(ref s) => &s[..],
 182         None => &sess.target.target.options.relocation_model[..],
 183     };
 184
 185     match ::back::write::RELOC_MODEL_ARGS.iter().find(
 186         |&&arg| arg.0 == reloc_model_arg) {
 187         Some(x) => x.1,
 188         _ => {
 189             sess.err(&format!("{:?} is not a valid relocation mode",
 190                              sess.opts
 191                                  .cg
 192                                  .code_model));
 193             sess.abort_if_errors();
 194             bug!();
 195         }
 196     }
 197 }
 198
 199 fn is_any_library(sess: &Session) -> bool {
 200     sess.crate_types.borrow().iter().any(|ty| {
 201         *ty != config::CrateTypeExecutable
 202     })
 203 }
 204
 205 pub fn is_pie_binary(sess: &Session) -> bool {
 206     !is_any_library(sess) && get_reloc_model(sess) == llvm::RelocMode::PIC
 207 }
 208
 209 pub unsafe fn create_context_and_module(sess: &Session, mod_name: &str) -> (ContextRef, ModuleRef) {
 210     let llcx = llvm::LLVMContextCreate();
 211     let mod_name = CString::new(mod_name).unwrap();
 212     let llmod = llvm::LLVMModuleCreateWithNameInContext(mod_name.as_ptr(), llcx);
 213
 214     // Ensure the data-layout values hardcoded remain the defaults.
 215     if sess.target.target.options.is_builtin {
 216         let tm = ::back::write::create_target_machine(sess);
 217         llvm::LLVMRustSetDataLayoutFromTargetMachine(llmod, tm);
 218         llvm::LLVMRustDisposeTargetMachine(tm);
 219
 220         let data_layout = llvm::LLVMGetDataLayout(llmod);
 221         let data_layout = str::from_utf8(CStr::from_ptr(data_layout).to_bytes())
 222             .ok().expect("got a non-UTF8 data-layout from LLVM");
 223
 224         // Unfortunately LLVM target specs change over time, and right now we
 225         // don't have proper support to work with any more than one
 226         // `data_layout` than the one that is in the rust-lang/rust repo. If
 227         // this compiler is configured against a custom LLVM, we may have a
 228         // differing data layout, even though we should update our own to use
 229         // that one.
 230         //
 231         // As an interim hack, if CFG_LLVM_ROOT is not an empty string then we
 232         // disable this check entirely as we may be configured with something
 233         // that has a different target layout.
 234         //
 235         // Unsure if this will actually cause breakage when rustc is configured
 236         // as such.
 237         //
 238         // FIXME(#34960)
 239         let cfg_llvm_root = option_env!("CFG_LLVM_ROOT").unwrap_or("");
 240         let custom_llvm_used = cfg_llvm_root.trim() != "";
 241
 242         if !custom_llvm_used && sess.target.target.data_layout != data_layout {
 243             bug!("data-layout for builtin `{}` target, `{}`, \
 244                   differs from LLVM default, `{}`",
 245                  sess.target.target.llvm_target,
 246                  sess.target.target.data_layout,
 247                  data_layout);
 248         }
 249     }
 250
 251     let data_layout = CString::new(&sess.target.target.data_layout[..]).unwrap();
 252     llvm::LLVMSetDataLayout(llmod, data_layout.as_ptr());
 253
 254     let llvm_target = sess.target.target.llvm_target.as_bytes();
 255     let llvm_target = CString::new(llvm_target).unwrap();
 256     llvm::LLVMRustSetNormalizedTarget(llmod, llvm_target.as_ptr());
 257
 258     if is_pie_binary(sess) {
 259         llvm::LLVMRustSetModulePIELevel(llmod);
 260     }
 261
 262     (llcx, llmod)
 263 }
 264
 265 impl<'b, 'tcx> SharedCrateContext<'b, 'tcx> {
 266     pub fn new(tcx: TyCtxt<'b, 'tcx, 'tcx>,
 267                exported_symbols: NodeSet,
 268                check_overflow: bool)
 269                -> SharedCrateContext<'b, 'tcx> {
 270         // An interesting part of Windows which MSVC forces our hand on (and
 271         // apparently MinGW didn't) is the usage of `dllimport` and `dllexport`
 272         // attributes in LLVM IR as well as native dependencies (in C these
 273         // correspond to `__declspec(dllimport)`).
 274         //
 275         // Whenever a dynamic library is built by MSVC it must have its public
 276         // interface specified by functions tagged with `dllexport` or otherwise
 277         // they're not available to be linked against. This poses a few problems
 278         // for the compiler, some of which are somewhat fundamental, but we use
 279         // the `use_dll_storage_attrs` variable below to attach the `dllexport`
 280         // attribute to all LLVM functions that are exported e.g. they're
 281         // already tagged with external linkage). This is suboptimal for a few
 282         // reasons:
 283         //
 284         // * If an object file will never be included in a dynamic library,
 285         //   there's no need to attach the dllexport attribute. Most object
 286         //   files in Rust are not destined to become part of a dll as binaries
 287         //   are statically linked by default.
 288         // * If the compiler is emitting both an rlib and a dylib, the same
 289         //   source object file is currently used but with MSVC this may be less
 290         //   feasible. The compiler may be able to get around this, but it may
 291         //   involve some invasive changes to deal with this.
 292         //
 293         // The flipside of this situation is that whenever you link to a dll and
 294         // you import a function from it, the import should be tagged with
 295         // `dllimport`. At this time, however, the compiler does not emit
 296         // `dllimport` for any declarations other than constants (where it is
 297         // required), which is again suboptimal for even more reasons!
 298         //
 299         // * Calling a function imported from another dll without using
 300         //   `dllimport` causes the linker/compiler to have extra overhead (one
 301         //   `jmp` instruction on x86) when calling the function.
 302         // * The same object file may be used in different circumstances, so a
 303         //   function may be imported from a dll if the object is linked into a
 304         //   dll, but it may be just linked against if linked into an rlib.
 305         // * The compiler has no knowledge about whether native functions should
 306         //   be tagged dllimport or not.
 307         //
 308         // For now the compiler takes the perf hit (I do not have any numbers to
 309         // this effect) by marking very little as `dllimport` and praying the
 310         // linker will take care of everything. Fixing this problem will likely
 311         // require adding a few attributes to Rust itself (feature gated at the
 312         // start) and then strongly recommending static linkage on MSVC!
 313         let use_dll_storage_attrs = tcx.sess.target.target.options.is_like_msvc;
 314
 315         SharedCrateContext {
 316             exported_symbols: exported_symbols,
 317             tcx: tcx,
 318             check_overflow: check_overflow,
 319             use_dll_storage_attrs: use_dll_storage_attrs,
 320         }
 321     }
 322
 323     pub fn type_needs_drop(&self, ty: Ty<'tcx>) -> bool {
 324         ty.needs_drop(self.tcx, ty::ParamEnv::empty())
 325     }
 326
 327     pub fn type_is_sized(&self, ty: Ty<'tcx>) -> bool {
 328         ty.is_sized(self.tcx, ty::ParamEnv::empty(), DUMMY_SP)
 329     }
 330
 331     pub fn type_is_freeze(&self, ty: Ty<'tcx>) -> bool {
 332         ty.is_freeze(self.tcx, ty::ParamEnv::empty(), DUMMY_SP)
 333     }
 334
 335     pub fn exported_symbols<'a>(&'a self) -> &'a NodeSet {
 336         &self.exported_symbols
 337     }
 338
 339     pub fn tcx<'a>(&'a self) -> TyCtxt<'a, 'tcx, 'tcx> {
 340         self.tcx
 341     }
 342
 343     pub fn sess<'a>(&'a self) -> &'a Session {
 344         &self.tcx.sess
 345     }
 346
 347     pub fn dep_graph<'a>(&'a self) -> &'a DepGraph {
 348         &self.tcx.dep_graph
 349     }
 350
 351     pub fn use_dll_storage_attrs(&self) -> bool {
 352         self.use_dll_storage_attrs
 353     }
 354 }
 355
 356 impl<'a, 'tcx> LocalCrateContext<'a, 'tcx> {
 357     pub fn new(shared: &SharedCrateContext<'a, 'tcx>,
 358                codegen_unit: CodegenUnit<'tcx>)
 359                -> LocalCrateContext<'a, 'tcx> {
 360         unsafe {
 361             // Append ".rs" to LLVM module identifier.
 362             //
 363             // LLVM code generator emits a ".file filename" directive
 364             // for ELF backends. Value of the "filename" is set as the
 365             // LLVM module identifier.  Due to a LLVM MC bug[1], LLVM
 366             // crashes if the module identifier is same as other symbols
 367             // such as a function name in the module.
 368             // 1. http://llvm.org/bugs/show_bug.cgi?id=11479
 369             let llmod_id = format!("{}.rs", codegen_unit.name());
 370
 371             let (llcx, llmod) = create_context_and_module(&shared.tcx.sess,
 372                                                           &llmod_id[..]);
 373
 374             let dbg_cx = if shared.tcx.sess.opts.debuginfo != NoDebugInfo {
 375                 let dctx = debuginfo::CrateDebugContext::new(llmod);
 376                 debuginfo::metadata::compile_unit_metadata(shared,
 377                                                            codegen_unit.name(),
 378                                                            &dctx,
 379                                                            shared.tcx.sess);
 380                 Some(dctx)
 381             } else {
 382                 None
 383             };
 384
 385             let local_ccx = LocalCrateContext {
 386                 llmod: llmod,
 387                 llcx: llcx,
 388                 stats: Stats::default(),
 389                 codegen_unit: codegen_unit,
 390                 instances: RefCell::new(FxHashMap()),
 391                 vtables: RefCell::new(FxHashMap()),
 392                 const_cstr_cache: RefCell::new(FxHashMap()),
 393                 const_unsized: RefCell::new(FxHashMap()),
 394                 const_globals: RefCell::new(FxHashMap()),
 395                 const_values: RefCell::new(FxHashMap()),
 396                 extern_const_values: RefCell::new(DefIdMap()),
 397                 statics: RefCell::new(FxHashMap()),
 398                 statics_to_rauw: RefCell::new(Vec::new()),
 399                 used_statics: RefCell::new(Vec::new()),
 400                 lltypes: RefCell::new(FxHashMap()),
 401                 type_hashcodes: RefCell::new(FxHashMap()),
 402                 int_type: Type::from_ref(ptr::null_mut()),
 403                 opaque_vec_type: Type::from_ref(ptr::null_mut()),
 404                 str_slice_type: Type::from_ref(ptr::null_mut()),
 405                 dbg_cx: dbg_cx,
 406                 eh_personality: Cell::new(None),
 407                 eh_unwind_resume: Cell::new(None),
 408                 rust_try_fn: Cell::new(None),
 409                 intrinsics: RefCell::new(FxHashMap()),
 410                 type_of_depth: Cell::new(0),
 411                 local_gen_sym_counter: Cell::new(0),
 412                 placeholder: PhantomData,
 413             };
 414
 415             let (int_type, opaque_vec_type, str_slice_ty, mut local_ccx) = {
 416                 // Do a little dance to create a dummy CrateContext, so we can
 417                 // create some things in the LLVM module of this codegen unit
 418                 let mut local_ccxs = vec![local_ccx];
 419                 let (int_type, opaque_vec_type, str_slice_ty) = {
 420                     let dummy_ccx = LocalCrateContext::dummy_ccx(shared,
 421                                                                  local_ccxs.as_mut_slice());
 422                     let mut str_slice_ty = Type::named_struct(&dummy_ccx, "str_slice");
 423                     str_slice_ty.set_struct_body(&[Type::i8p(&dummy_ccx),
 424                                                    Type::int(&dummy_ccx)],
 425                                                  false);
 426                     (Type::int(&dummy_ccx), Type::opaque_vec(&dummy_ccx), str_slice_ty)
 427                 };
 428                 (int_type, opaque_vec_type, str_slice_ty, local_ccxs.pop().unwrap())
 429             };
 430
 431             local_ccx.int_type = int_type;
 432             local_ccx.opaque_vec_type = opaque_vec_type;
 433             local_ccx.str_slice_type = str_slice_ty;
 434
 435             local_ccx
 436         }
 437     }
 438
 439     /// Create a dummy `CrateContext` from `self` and  the provided
 440     /// `SharedCrateContext`.  This is somewhat dangerous because `self` may
 441     /// not be fully initialized.
 442     ///
 443     /// This is used in the `LocalCrateContext` constructor to allow calling
 444     /// functions that expect a complete `CrateContext`, even before the local
 445     /// portion is fully initialized and attached to the `SharedCrateContext`.
 446     fn dummy_ccx(shared: &'a SharedCrateContext<'a, 'tcx>,
 447                  local_ccxs: &'a [LocalCrateContext<'a, 'tcx>])
 448                  -> CrateContext<'a, 'tcx> {
 449         assert!(local_ccxs.len() == 1);
 450         CrateContext {
 451             shared: shared,
 452             local_ccx: &local_ccxs[0]
 453         }
 454     }
 455
 456     pub fn into_stats(self) -> Stats {
 457         self.stats
 458     }
 459 }
 460
 461 impl<'b, 'tcx> CrateContext<'b, 'tcx> {
 462     pub fn shared(&self) -> &'b SharedCrateContext<'b, 'tcx> {
 463         self.shared
 464     }
 465
 466     fn local(&self) -> &'b LocalCrateContext<'b, 'tcx> {
 467         self.local_ccx
 468     }
 469
 470     pub fn tcx<'a>(&'a self) -> TyCtxt<'a, 'tcx, 'tcx> {
 471         self.shared.tcx
 472     }
 473
 474     pub fn sess<'a>(&'a self) -> &'a Session {
 475         &self.shared.tcx.sess
 476     }
 477
 478     pub fn get_intrinsic(&self, key: &str) -> ValueRef {
 479         if let Some(v) = self.intrinsics().borrow().get(key).cloned() {
 480             return v;
 481         }
 482         match declare_intrinsic(self, key) {
 483             Some(v) => return v,
 484             None => bug!("unknown intrinsic '{}'", key)
 485         }
 486     }
 487
 488     pub fn llmod(&self) -> ModuleRef {
 489         self.local().llmod
 490     }
 491
 492     pub fn llcx(&self) -> ContextRef {
 493         self.local().llcx
 494     }
 495
 496     pub fn codegen_unit(&self) -> &CodegenUnit<'tcx> {
 497         &self.local().codegen_unit
 498     }
 499
 500     pub fn td(&self) -> llvm::TargetDataRef {
 501         unsafe { llvm::LLVMRustGetModuleDataLayout(self.llmod()) }
 502     }
 503
 504     pub fn instances<'a>(&'a self) -> &'a RefCell<FxHashMap<Instance<'tcx>, ValueRef>> {
 505         &self.local().instances
 506     }
 507
 508     pub fn vtables<'a>(&'a self)
 509         -> &'a RefCell<FxHashMap<(ty::Ty<'tcx>,
 510                                   Option<ty::PolyExistentialTraitRef<'tcx>>), ValueRef>> {
 511         &self.local().vtables
 512     }
 513
 514     pub fn const_cstr_cache<'a>(&'a self) -> &'a RefCell<FxHashMap<InternedString, ValueRef>> {
 515         &self.local().const_cstr_cache
 516     }
 517
 518     pub fn const_unsized<'a>(&'a self) -> &'a RefCell<FxHashMap<ValueRef, ValueRef>> {
 519         &self.local().const_unsized
 520     }
 521
 522     pub fn const_globals<'a>(&'a self) -> &'a RefCell<FxHashMap<ValueRef, ValueRef>> {
 523         &self.local().const_globals
 524     }
 525
 526     pub fn const_values<'a>(&'a self) -> &'a RefCell<FxHashMap<(ast::NodeId, &'tcx Substs<'tcx>),
 527                                                                ValueRef>> {
 528         &self.local().const_values
 529     }
 530
 531     pub fn extern_const_values<'a>(&'a self) -> &'a RefCell<DefIdMap<ValueRef>> {
 532         &self.local().extern_const_values
 533     }
 534
 535     pub fn statics<'a>(&'a self) -> &'a RefCell<FxHashMap<ValueRef, DefId>> {
 536         &self.local().statics
 537     }
 538
 539     pub fn statics_to_rauw<'a>(&'a self) -> &'a RefCell<Vec<(ValueRef, ValueRef)>> {
 540         &self.local().statics_to_rauw
 541     }
 542
 543     pub fn used_statics<'a>(&'a self) -> &'a RefCell<Vec<ValueRef>> {
 544         &self.local().used_statics
 545     }
 546
 547     pub fn lltypes<'a>(&'a self) -> &'a RefCell<FxHashMap<Ty<'tcx>, Type>> {
 548         &self.local().lltypes
 549     }
 550
 551     pub fn type_hashcodes<'a>(&'a self) -> &'a RefCell<FxHashMap<Ty<'tcx>, String>> {
 552         &self.local().type_hashcodes
 553     }
 554
 555     pub fn stats<'a>(&'a self) -> &'a Stats {
 556         &self.local().stats
 557     }
 558
 559     pub fn int_type(&self) -> Type {
 560         self.local().int_type
 561     }
 562
 563     pub fn opaque_vec_type(&self) -> Type {
 564         self.local().opaque_vec_type
 565     }
 566
 567     pub fn str_slice_type(&self) -> Type {
 568         self.local().str_slice_type
 569     }
 570
 571     pub fn dbg_cx<'a>(&'a self) -> &'a Option<debuginfo::CrateDebugContext<'tcx>> {
 572         &self.local().dbg_cx
 573     }
 574
 575     pub fn rust_try_fn<'a>(&'a self) -> &'a Cell<Option<ValueRef>> {
 576         &self.local().rust_try_fn
 577     }
 578
 579     fn intrinsics<'a>(&'a self) -> &'a RefCell<FxHashMap<&'static str, ValueRef>> {
 580         &self.local().intrinsics
 581     }
 582
 583     pub fn obj_size_bound(&self) -> u64 {
 584         self.tcx().data_layout.obj_size_bound()
 585     }
 586
 587     pub fn report_overbig_object(&self, obj: Ty<'tcx>) -> ! {
 588         self.sess().fatal(
 589             &format!("the type `{:?}` is too big for the current architecture",
 590                     obj))
 591     }
 592
 593     pub fn enter_type_of(&self, ty: Ty<'tcx>) -> TypeOfDepthLock<'b, 'tcx> {
 594         let current_depth = self.local().type_of_depth.get();
 595         debug!("enter_type_of({:?}) at depth {:?}", ty, current_depth);
 596         if current_depth > self.sess().recursion_limit.get() {
 597             self.sess().fatal(
 598                 &format!("overflow representing the type `{}`", ty))
 599         }
 600         self.local().type_of_depth.set(current_depth + 1);
 601         TypeOfDepthLock(self.local())
 602     }
 603
 604     pub fn check_overflow(&self) -> bool {
 605         self.shared.check_overflow
 606     }
 607
 608     pub fn use_dll_storage_attrs(&self) -> bool {
 609         self.shared.use_dll_storage_attrs()
 610     }
 611
 612     /// Given the def-id of some item that has no type parameters, make
 613     /// a suitable "empty substs" for it.
 614     pub fn empty_substs_for_def_id(&self, item_def_id: DefId) -> &'tcx Substs<'tcx> {
 615         self.tcx().empty_substs_for_def_id(item_def_id)
 616     }
 617
 618     /// Generate a new symbol name with the given prefix. This symbol name must
 619     /// only be used for definitions with `internal` or `private` linkage.
 620     pub fn generate_local_symbol_name(&self, prefix: &str) -> String {
 621         let idx = self.local().local_gen_sym_counter.get();
 622         self.local().local_gen_sym_counter.set(idx + 1);
 623         // Include a '.' character, so there can be no accidental conflicts with
 624         // user defined names
 625         let mut name = String::with_capacity(prefix.len() + 6);
 626         name.push_str(prefix);
 627         name.push_str(".");
 628         base_n::push_str(idx as u64, base_n::ALPHANUMERIC_ONLY, &mut name);
 629         name
 630     }
 631
 632     pub fn eh_personality(&self) -> ValueRef {
 633         // The exception handling personality function.
 634         //
 635         // If our compilation unit has the `eh_personality` lang item somewhere
 636         // within it, then we just need to translate that. Otherwise, we're
 637         // building an rlib which will depend on some upstream implementation of
 638         // this function, so we just codegen a generic reference to it. We don't
 639         // specify any of the types for the function, we just make it a symbol
 640         // that LLVM can later use.
 641         //
 642         // Note that MSVC is a little special here in that we don't use the
 643         // `eh_personality` lang item at all. Currently LLVM has support for
 644         // both Dwarf and SEH unwind mechanisms for MSVC targets and uses the
 645         // *name of the personality function* to decide what kind of unwind side
 646         // tables/landing pads to emit. It looks like Dwarf is used by default,
 647         // injecting a dependency on the `_Unwind_Resume` symbol for resuming
 648         // an "exception", but for MSVC we want to force SEH. This means that we
 649         // can't actually have the personality function be our standard
 650         // `rust_eh_personality` function, but rather we wired it up to the
 651         // CRT's custom personality function, which forces LLVM to consider
 652         // landing pads as "landing pads for SEH".
 653         if let Some(llpersonality) = self.local().eh_personality.get() {
 654             return llpersonality
 655         }
 656         let tcx = self.tcx();
 657         let llfn = match tcx.lang_items.eh_personality() {
 658             Some(def_id) if !base::wants_msvc_seh(self.sess()) => {
 659                 callee::resolve_and_get_fn(self, def_id, tcx.intern_substs(&[]))
 660             }
 661             _ => {
 662                 let name = if base::wants_msvc_seh(self.sess()) {
 663                     "__CxxFrameHandler3"
 664                 } else {
 665                     "rust_eh_personality"
 666                 };
 667                 let fty = Type::variadic_func(&[], &Type::i32(self));
 668                 declare::declare_cfn(self, name, fty)
 669             }
 670         };
 671         self.local().eh_personality.set(Some(llfn));
 672         llfn
 673     }
 674
 675     // Returns a ValueRef of the "eh_unwind_resume" lang item if one is defined,
 676     // otherwise declares it as an external function.
 677     pub fn eh_unwind_resume(&self) -> ValueRef {
 678         use attributes;
 679         let unwresume = &self.local().eh_unwind_resume;
 680         if let Some(llfn) = unwresume.get() {
 681             return llfn;
 682         }
 683
 684         let tcx = self.tcx();
 685         assert!(self.sess().target.target.options.custom_unwind_resume);
 686         if let Some(def_id) = tcx.lang_items.eh_unwind_resume() {
 687             let llfn = callee::resolve_and_get_fn(self, def_id, tcx.intern_substs(&[]));
 688             unwresume.set(Some(llfn));
 689             return llfn;
 690         }
 691
 692         let ty = tcx.mk_fn_ptr(ty::Binder(tcx.mk_fn_sig(
 693             iter::once(tcx.mk_mut_ptr(tcx.types.u8)),
 694             tcx.types.never,
 695             false,
 696             hir::Unsafety::Unsafe,
 697             Abi::C
 698         )));
 699
 700         let llfn = declare::declare_fn(self, "rust_eh_unwind_resume", ty);
 701         attributes::unwind(llfn, true);
 702         unwresume.set(Some(llfn));
 703         llfn
 704     }
 705 }
 706
 707 impl<'a, 'tcx> ty::layout::HasDataLayout for &'a SharedCrateContext<'a, 'tcx> {
 708     fn data_layout(&self) -> &ty::layout::TargetDataLayout {
 709         &self.tcx.data_layout
 710     }
 711 }
 712
 713 impl<'a, 'tcx> ty::layout::HasTyCtxt<'tcx> for &'a SharedCrateContext<'a, 'tcx> {
 714     fn tcx<'b>(&'b self) -> TyCtxt<'b, 'tcx, 'tcx> {
 715         self.tcx
 716     }
 717 }
 718
 719 impl<'a, 'tcx> ty::layout::HasDataLayout for &'a CrateContext<'a, 'tcx> {
 720     fn data_layout(&self) -> &ty::layout::TargetDataLayout {
 721         &self.shared.tcx.data_layout
 722     }
 723 }
 724
 725 impl<'a, 'tcx> ty::layout::HasTyCtxt<'tcx> for &'a CrateContext<'a, 'tcx> {
 726     fn tcx<'b>(&'b self) -> TyCtxt<'b, 'tcx, 'tcx> {
 727         self.shared.tcx
 728     }
 729 }
 730
 731 impl<'a, 'tcx> LayoutTyper<'tcx> for &'a SharedCrateContext<'a, 'tcx> {
 732     type TyLayout = TyLayout<'tcx>;
 733
 734     fn layout_of(self, ty: Ty<'tcx>) -> Self::TyLayout {
 735         if let Some(&layout) = self.tcx().layout_cache.borrow().get(&ty) {
 736             return TyLayout { ty: ty, layout: layout, variant_index: None };
 737         }
 738
 739         self.tcx().infer_ctxt((), traits::Reveal::All).enter(|infcx| {
 740             infcx.layout_of(ty).unwrap_or_else(|e| {
 741                 match e {
 742                     ty::layout::LayoutError::SizeOverflow(_) =>
 743                         self.sess().fatal(&e.to_string()),
 744                     _ => bug!("failed to get layout for `{}`: {}", ty, e)
 745                 }
 746             })
 747         })
 748     }
 749
 750     fn normalize_projections(self, ty: Ty<'tcx>) -> Ty<'tcx> {
 751         self.tcx().normalize_associated_type(&ty)
 752     }
 753 }
 754
 755 impl<'a, 'tcx> LayoutTyper<'tcx> for &'a CrateContext<'a, 'tcx> {
 756     type TyLayout = TyLayout<'tcx>;
 757
 758     fn layout_of(self, ty: Ty<'tcx>) -> Self::TyLayout {
 759         self.shared.layout_of(ty)
 760     }
 761
 762     fn normalize_projections(self, ty: Ty<'tcx>) -> Ty<'tcx> {
 763         self.shared.normalize_projections(ty)
 764     }
 765 }
 766
 767 pub struct TypeOfDepthLock<'a, 'tcx: 'a>(&'a LocalCrateContext<'a, 'tcx>);
 768
 769 impl<'a, 'tcx> Drop for TypeOfDepthLock<'a, 'tcx> {
 770     fn drop(&mut self) {
 771         self.0.type_of_depth.set(self.0.type_of_depth.get() - 1);
 772     }
 773 }
 774
 775 /// Declare any llvm intrinsics that you might need
 776 fn declare_intrinsic(ccx: &CrateContext, key: &str) -> Option<ValueRef> {
 777     macro_rules! ifn {
 778         ($name:expr, fn() -> $ret:expr) => (
 779             if key == $name {
 780                 let f = declare::declare_cfn(ccx, $name, Type::func(&[], &$ret));
 781                 llvm::SetUnnamedAddr(f, false);
 782                 ccx.intrinsics().borrow_mut().insert($name, f.clone());
 783                 return Some(f);
 784             }
 785         );
 786         ($name:expr, fn(...) -> $ret:expr) => (
 787             if key == $name {
 788                 let f = declare::declare_cfn(ccx, $name, Type::variadic_func(&[], &$ret));
 789                 llvm::SetUnnamedAddr(f, false);
 790                 ccx.intrinsics().borrow_mut().insert($name, f.clone());
 791                 return Some(f);
 792             }
 793         );
 794         ($name:expr, fn($($arg:expr),*) -> $ret:expr) => (
 795             if key == $name {
 796                 let f = declare::declare_cfn(ccx, $name, Type::func(&[$($arg),*], &$ret));
 797                 llvm::SetUnnamedAddr(f, false);
 798                 ccx.intrinsics().borrow_mut().insert($name, f.clone());
 799                 return Some(f);
 800             }
 801         );
 802     }
 803     macro_rules! mk_struct {
 804         ($($field_ty:expr),*) => (Type::struct_(ccx, &[$($field_ty),*], false))
 805     }
 806
 807     let i8p = Type::i8p(ccx);
 808     let void = Type::void(ccx);
 809     let i1 = Type::i1(ccx);
 810     let t_i8 = Type::i8(ccx);
 811     let t_i16 = Type::i16(ccx);
 812     let t_i32 = Type::i32(ccx);
 813     let t_i64 = Type::i64(ccx);
 814     let t_i128 = Type::i128(ccx);
 815     let t_f32 = Type::f32(ccx);
 816     let t_f64 = Type::f64(ccx);
 817
 818     ifn!("llvm.memcpy.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
 819     ifn!("llvm.memcpy.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
 820     ifn!("llvm.memcpy.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
 821     ifn!("llvm.memmove.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
 822     ifn!("llvm.memmove.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
 823     ifn!("llvm.memmove.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
 824     ifn!("llvm.memset.p0i8.i16", fn(i8p, t_i8, t_i16, t_i32, i1) -> void);
 825     ifn!("llvm.memset.p0i8.i32", fn(i8p, t_i8, t_i32, t_i32, i1) -> void);
 826     ifn!("llvm.memset.p0i8.i64", fn(i8p, t_i8, t_i64, t_i32, i1) -> void);
 827
 828     ifn!("llvm.trap", fn() -> void);
 829     ifn!("llvm.debugtrap", fn() -> void);
 830     ifn!("llvm.frameaddress", fn(t_i32) -> i8p);
 831
 832     ifn!("llvm.powi.f32", fn(t_f32, t_i32) -> t_f32);
 833     ifn!("llvm.powi.f64", fn(t_f64, t_i32) -> t_f64);
 834     ifn!("llvm.pow.f32", fn(t_f32, t_f32) -> t_f32);
 835     ifn!("llvm.pow.f64", fn(t_f64, t_f64) -> t_f64);
 836
 837     ifn!("llvm.sqrt.f32", fn(t_f32) -> t_f32);
 838     ifn!("llvm.sqrt.f64", fn(t_f64) -> t_f64);
 839     ifn!("llvm.sin.f32", fn(t_f32) -> t_f32);
 840     ifn!("llvm.sin.f64", fn(t_f64) -> t_f64);
 841     ifn!("llvm.cos.f32", fn(t_f32) -> t_f32);
 842     ifn!("llvm.cos.f64", fn(t_f64) -> t_f64);
 843     ifn!("llvm.exp.f32", fn(t_f32) -> t_f32);
 844     ifn!("llvm.exp.f64", fn(t_f64) -> t_f64);
 845     ifn!("llvm.exp2.f32", fn(t_f32) -> t_f32);
 846     ifn!("llvm.exp2.f64", fn(t_f64) -> t_f64);
 847     ifn!("llvm.log.f32", fn(t_f32) -> t_f32);
 848     ifn!("llvm.log.f64", fn(t_f64) -> t_f64);
 849     ifn!("llvm.log10.f32", fn(t_f32) -> t_f32);
 850     ifn!("llvm.log10.f64", fn(t_f64) -> t_f64);
 851     ifn!("llvm.log2.f32", fn(t_f32) -> t_f32);
 852     ifn!("llvm.log2.f64", fn(t_f64) -> t_f64);
 853
 854     ifn!("llvm.fma.f32", fn(t_f32, t_f32, t_f32) -> t_f32);
 855     ifn!("llvm.fma.f64", fn(t_f64, t_f64, t_f64) -> t_f64);
 856
 857     ifn!("llvm.fabs.f32", fn(t_f32) -> t_f32);
 858     ifn!("llvm.fabs.f64", fn(t_f64) -> t_f64);
 859
 860     ifn!("llvm.floor.f32", fn(t_f32) -> t_f32);
 861     ifn!("llvm.floor.f64", fn(t_f64) -> t_f64);
 862     ifn!("llvm.ceil.f32", fn(t_f32) -> t_f32);
 863     ifn!("llvm.ceil.f64", fn(t_f64) -> t_f64);
 864     ifn!("llvm.trunc.f32", fn(t_f32) -> t_f32);
 865     ifn!("llvm.trunc.f64", fn(t_f64) -> t_f64);
 866
 867     ifn!("llvm.copysign.f32", fn(t_f32, t_f32) -> t_f32);
 868     ifn!("llvm.copysign.f64", fn(t_f64, t_f64) -> t_f64);
 869     ifn!("llvm.round.f32", fn(t_f32) -> t_f32);
 870     ifn!("llvm.round.f64", fn(t_f64) -> t_f64);
 871
 872     ifn!("llvm.rint.f32", fn(t_f32) -> t_f32);
 873     ifn!("llvm.rint.f64", fn(t_f64) -> t_f64);
 874     ifn!("llvm.nearbyint.f32", fn(t_f32) -> t_f32);
 875     ifn!("llvm.nearbyint.f64", fn(t_f64) -> t_f64);
 876
 877     ifn!("llvm.ctpop.i8", fn(t_i8) -> t_i8);
 878     ifn!("llvm.ctpop.i16", fn(t_i16) -> t_i16);
 879     ifn!("llvm.ctpop.i32", fn(t_i32) -> t_i32);
 880     ifn!("llvm.ctpop.i64", fn(t_i64) -> t_i64);
 881     ifn!("llvm.ctpop.i128", fn(t_i128) -> t_i128);
 882
 883     ifn!("llvm.ctlz.i8", fn(t_i8 , i1) -> t_i8);
 884     ifn!("llvm.ctlz.i16", fn(t_i16, i1) -> t_i16);
 885     ifn!("llvm.ctlz.i32", fn(t_i32, i1) -> t_i32);
 886     ifn!("llvm.ctlz.i64", fn(t_i64, i1) -> t_i64);
 887     ifn!("llvm.ctlz.i128", fn(t_i128, i1) -> t_i128);
 888
 889     ifn!("llvm.cttz.i8", fn(t_i8 , i1) -> t_i8);
 890     ifn!("llvm.cttz.i16", fn(t_i16, i1) -> t_i16);
 891     ifn!("llvm.cttz.i32", fn(t_i32, i1) -> t_i32);
 892     ifn!("llvm.cttz.i64", fn(t_i64, i1) -> t_i64);
 893     ifn!("llvm.cttz.i128", fn(t_i128, i1) -> t_i128);
 894
 895     ifn!("llvm.bswap.i16", fn(t_i16) -> t_i16);
 896     ifn!("llvm.bswap.i32", fn(t_i32) -> t_i32);
 897     ifn!("llvm.bswap.i64", fn(t_i64) -> t_i64);
 898     ifn!("llvm.bswap.i128", fn(t_i128) -> t_i128);
 899
 900     ifn!("llvm.sadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
 901     ifn!("llvm.sadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
 902     ifn!("llvm.sadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
 903     ifn!("llvm.sadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
 904     ifn!("llvm.sadd.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
 905
 906     ifn!("llvm.uadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
 907     ifn!("llvm.uadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
 908     ifn!("llvm.uadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
 909     ifn!("llvm.uadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
 910     ifn!("llvm.uadd.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
 911
 912     ifn!("llvm.ssub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
 913     ifn!("llvm.ssub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
 914     ifn!("llvm.ssub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
 915     ifn!("llvm.ssub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
 916     ifn!("llvm.ssub.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
 917
 918     ifn!("llvm.usub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
 919     ifn!("llvm.usub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
 920     ifn!("llvm.usub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
 921     ifn!("llvm.usub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
 922     ifn!("llvm.usub.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
 923
 924     ifn!("llvm.smul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
 925     ifn!("llvm.smul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
 926     ifn!("llvm.smul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
 927     ifn!("llvm.smul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
 928     ifn!("llvm.smul.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
 929
 930     ifn!("llvm.umul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
 931     ifn!("llvm.umul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
 932     ifn!("llvm.umul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
 933     ifn!("llvm.umul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
 934     ifn!("llvm.umul.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
 935
 936     ifn!("llvm.lifetime.start", fn(t_i64,i8p) -> void);
 937     ifn!("llvm.lifetime.end", fn(t_i64, i8p) -> void);
 938
 939     ifn!("llvm.expect.i1", fn(i1, i1) -> i1);
 940     ifn!("llvm.eh.typeid.for", fn(i8p) -> t_i32);
 941     ifn!("llvm.localescape", fn(...) -> void);
 942     ifn!("llvm.localrecover", fn(i8p, i8p, t_i32) -> i8p);
 943     ifn!("llvm.x86.seh.recoverfp", fn(i8p, i8p) -> i8p);
 944
 945     ifn!("llvm.assume", fn(i1) -> void);
 946
 947     if ccx.sess().opts.debuginfo != NoDebugInfo {
 948         ifn!("llvm.dbg.declare", fn(Type::metadata(ccx), Type::metadata(ccx)) -> void);
 949         ifn!("llvm.dbg.value", fn(Type::metadata(ccx), t_i64, Type::metadata(ccx)) -> void);
 950     }
 951     return None;
 952 }