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