]> git.proxmox.com Git - rustc.git/blob - src/librustc_trans/trans/context.rs
Imported Upstream version 1.6.0+dfsg1
[rustc.git] / src / librustc_trans / 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, BuilderRef};
13 use middle::cstore::LinkMeta;
14 use middle::def::ExportMap;
15 use middle::def_id::DefId;
16 use middle::traits;
17 use rustc_mir::mir_map::MirMap;
18 use trans::adt;
19 use trans::base;
20 use trans::builder::Builder;
21 use trans::common::{ExternMap,BuilderRef_res};
22 use trans::debuginfo;
23 use trans::declare;
24 use trans::glue::DropGlueKind;
25 use trans::monomorphize::MonoId;
26 use trans::type_::{Type, TypeNames};
27 use middle::subst::Substs;
28 use middle::ty::{self, Ty};
29 use session::config::NoDebugInfo;
30 use session::Session;
31 use util::sha2::Sha256;
32 use util::nodemap::{NodeMap, NodeSet, DefIdMap, FnvHashMap, FnvHashSet};
33
34 use std::ffi::CString;
35 use std::cell::{Cell, RefCell};
36 use std::ptr;
37 use std::rc::Rc;
38 use syntax::ast;
39 use syntax::parse::token::InternedString;
40
41 pub struct Stats {
42 pub n_glues_created: Cell<usize>,
43 pub n_null_glues: Cell<usize>,
44 pub n_real_glues: Cell<usize>,
45 pub n_fns: Cell<usize>,
46 pub n_monos: Cell<usize>,
47 pub n_inlines: Cell<usize>,
48 pub n_closures: Cell<usize>,
49 pub n_llvm_insns: Cell<usize>,
50 pub llvm_insns: RefCell<FnvHashMap<String, usize>>,
51 // (ident, llvm-instructions)
52 pub fn_stats: RefCell<Vec<(String, usize)> >,
53 }
54
55 /// The shared portion of a `CrateContext`. There is one `SharedCrateContext`
56 /// per crate. The data here is shared between all compilation units of the
57 /// crate, so it must not contain references to any LLVM data structures
58 /// (aside from metadata-related ones).
59 pub struct SharedCrateContext<'a, 'tcx: 'a> {
60 local_ccxs: Vec<LocalCrateContext<'tcx>>,
61
62 metadata_llmod: ModuleRef,
63 metadata_llcx: ContextRef,
64
65 export_map: ExportMap,
66 reachable: NodeSet,
67 item_symbols: RefCell<NodeMap<String>>,
68 link_meta: LinkMeta,
69 symbol_hasher: RefCell<Sha256>,
70 tcx: &'a ty::ctxt<'tcx>,
71 stats: Stats,
72 check_overflow: bool,
73 check_drop_flag_for_sanity: bool,
74 mir_map: &'a MirMap<'tcx>,
75
76 available_drop_glues: RefCell<FnvHashMap<DropGlueKind<'tcx>, String>>,
77 use_dll_storage_attrs: bool,
78 }
79
80 /// The local portion of a `CrateContext`. There is one `LocalCrateContext`
81 /// per compilation unit. Each one has its own LLVM `ContextRef` so that
82 /// several compilation units may be optimized in parallel. All other LLVM
83 /// data structures in the `LocalCrateContext` are tied to that `ContextRef`.
84 pub struct LocalCrateContext<'tcx> {
85 llmod: ModuleRef,
86 llcx: ContextRef,
87 tn: TypeNames,
88 externs: RefCell<ExternMap>,
89 item_vals: RefCell<NodeMap<ValueRef>>,
90 needs_unwind_cleanup_cache: RefCell<FnvHashMap<Ty<'tcx>, bool>>,
91 fn_pointer_shims: RefCell<FnvHashMap<Ty<'tcx>, ValueRef>>,
92 drop_glues: RefCell<FnvHashMap<DropGlueKind<'tcx>, ValueRef>>,
93 /// Track mapping of external ids to local items imported for inlining
94 external: RefCell<DefIdMap<Option<ast::NodeId>>>,
95 /// Backwards version of the `external` map (inlined items to where they
96 /// came from)
97 external_srcs: RefCell<NodeMap<DefId>>,
98 /// Cache instances of monomorphized functions
99 monomorphized: RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>>,
100 monomorphizing: RefCell<DefIdMap<usize>>,
101 available_monomorphizations: RefCell<FnvHashSet<String>>,
102 /// Cache generated vtables
103 vtables: RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>, ValueRef>>,
104 /// Cache of constant strings,
105 const_cstr_cache: RefCell<FnvHashMap<InternedString, ValueRef>>,
106
107 /// Reverse-direction for const ptrs cast from globals.
108 /// Key is a ValueRef holding a *T,
109 /// Val is a ValueRef holding a *[T].
110 ///
111 /// Needed because LLVM loses pointer->pointee association
112 /// when we ptrcast, and we have to ptrcast during translation
113 /// of a [T] const because we form a slice, a (*T,usize) pair, not
114 /// a pointer to an LLVM array type. Similar for trait objects.
115 const_unsized: RefCell<FnvHashMap<ValueRef, ValueRef>>,
116
117 /// Cache of emitted const globals (value -> global)
118 const_globals: RefCell<FnvHashMap<ValueRef, ValueRef>>,
119
120 /// Cache of emitted const values
121 const_values: RefCell<FnvHashMap<(ast::NodeId, &'tcx Substs<'tcx>), ValueRef>>,
122
123 /// Cache of external const values
124 extern_const_values: RefCell<DefIdMap<ValueRef>>,
125
126 impl_method_cache: RefCell<FnvHashMap<(DefId, ast::Name), DefId>>,
127
128 /// Cache of closure wrappers for bare fn's.
129 closure_bare_wrapper_cache: RefCell<FnvHashMap<ValueRef, ValueRef>>,
130
131 /// List of globals for static variables which need to be passed to the
132 /// LLVM function ReplaceAllUsesWith (RAUW) when translation is complete.
133 /// (We have to make sure we don't invalidate any ValueRefs referring
134 /// to constants.)
135 statics_to_rauw: RefCell<Vec<(ValueRef, ValueRef)>>,
136
137 lltypes: RefCell<FnvHashMap<Ty<'tcx>, Type>>,
138 llsizingtypes: RefCell<FnvHashMap<Ty<'tcx>, Type>>,
139 adt_reprs: RefCell<FnvHashMap<Ty<'tcx>, Rc<adt::Repr<'tcx>>>>,
140 type_hashcodes: RefCell<FnvHashMap<Ty<'tcx>, String>>,
141 int_type: Type,
142 opaque_vec_type: Type,
143 builder: BuilderRef_res,
144
145 /// Holds the LLVM values for closure IDs.
146 closure_vals: RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>>,
147
148 dbg_cx: Option<debuginfo::CrateDebugContext<'tcx>>,
149
150 eh_personality: RefCell<Option<ValueRef>>,
151 eh_unwind_resume: RefCell<Option<ValueRef>>,
152 rust_try_fn: RefCell<Option<ValueRef>>,
153
154 intrinsics: RefCell<FnvHashMap<&'static str, ValueRef>>,
155
156 /// Number of LLVM instructions translated into this `LocalCrateContext`.
157 /// This is used to perform some basic load-balancing to keep all LLVM
158 /// contexts around the same size.
159 n_llvm_insns: Cell<usize>,
160
161 /// Depth of the current type-of computation - used to bail out
162 type_of_depth: Cell<usize>,
163
164 trait_cache: RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>,
165 traits::Vtable<'tcx, ()>>>,
166 }
167
168 pub struct CrateContext<'a, 'tcx: 'a> {
169 shared: &'a SharedCrateContext<'a, 'tcx>,
170 local: &'a LocalCrateContext<'tcx>,
171 /// The index of `local` in `shared.local_ccxs`. This is used in
172 /// `maybe_iter(true)` to identify the original `LocalCrateContext`.
173 index: usize,
174 }
175
176 pub struct CrateContextIterator<'a, 'tcx: 'a> {
177 shared: &'a SharedCrateContext<'a, 'tcx>,
178 index: usize,
179 }
180
181 impl<'a, 'tcx> Iterator for CrateContextIterator<'a,'tcx> {
182 type Item = CrateContext<'a, 'tcx>;
183
184 fn next(&mut self) -> Option<CrateContext<'a, 'tcx>> {
185 if self.index >= self.shared.local_ccxs.len() {
186 return None;
187 }
188
189 let index = self.index;
190 self.index += 1;
191
192 Some(CrateContext {
193 shared: self.shared,
194 local: &self.shared.local_ccxs[index],
195 index: index,
196 })
197 }
198 }
199
200 /// The iterator produced by `CrateContext::maybe_iter`.
201 pub struct CrateContextMaybeIterator<'a, 'tcx: 'a> {
202 shared: &'a SharedCrateContext<'a, 'tcx>,
203 index: usize,
204 single: bool,
205 origin: usize,
206 }
207
208 impl<'a, 'tcx> Iterator for CrateContextMaybeIterator<'a, 'tcx> {
209 type Item = (CrateContext<'a, 'tcx>, bool);
210
211 fn next(&mut self) -> Option<(CrateContext<'a, 'tcx>, bool)> {
212 if self.index >= self.shared.local_ccxs.len() {
213 return None;
214 }
215
216 let index = self.index;
217 self.index += 1;
218 if self.single {
219 self.index = self.shared.local_ccxs.len();
220 }
221
222 let ccx = CrateContext {
223 shared: self.shared,
224 local: &self.shared.local_ccxs[index],
225 index: index,
226 };
227 Some((ccx, index == self.origin))
228 }
229 }
230
231
232 unsafe fn create_context_and_module(sess: &Session, mod_name: &str) -> (ContextRef, ModuleRef) {
233 let llcx = llvm::LLVMContextCreate();
234 let mod_name = CString::new(mod_name).unwrap();
235 let llmod = llvm::LLVMModuleCreateWithNameInContext(mod_name.as_ptr(), llcx);
236
237 if let Some(ref custom_data_layout) = sess.target.target.options.data_layout {
238 let data_layout = CString::new(&custom_data_layout[..]).unwrap();
239 llvm::LLVMSetDataLayout(llmod, data_layout.as_ptr());
240 } else {
241 let tm = ::back::write::create_target_machine(sess);
242 llvm::LLVMRustSetDataLayoutFromTargetMachine(llmod, tm);
243 llvm::LLVMRustDisposeTargetMachine(tm);
244 }
245
246 let llvm_target = sess.target.target.llvm_target.as_bytes();
247 let llvm_target = CString::new(llvm_target).unwrap();
248 llvm::LLVMRustSetNormalizedTarget(llmod, llvm_target.as_ptr());
249 (llcx, llmod)
250 }
251
252 impl<'b, 'tcx> SharedCrateContext<'b, 'tcx> {
253 pub fn new(crate_name: &str,
254 local_count: usize,
255 tcx: &'b ty::ctxt<'tcx>,
256 mir_map: &'b MirMap<'tcx>,
257 export_map: ExportMap,
258 symbol_hasher: Sha256,
259 link_meta: LinkMeta,
260 reachable: NodeSet,
261 check_overflow: bool,
262 check_drop_flag_for_sanity: bool)
263 -> SharedCrateContext<'b, 'tcx> {
264 let (metadata_llcx, metadata_llmod) = unsafe {
265 create_context_and_module(&tcx.sess, "metadata")
266 };
267
268 // An interesting part of Windows which MSVC forces our hand on (and
269 // apparently MinGW didn't) is the usage of `dllimport` and `dllexport`
270 // attributes in LLVM IR as well as native dependencies (in C these
271 // correspond to `__declspec(dllimport)`).
272 //
273 // Whenever a dynamic library is built by MSVC it must have its public
274 // interface specified by functions tagged with `dllexport` or otherwise
275 // they're not available to be linked against. This poses a few problems
276 // for the compiler, some of which are somewhat fundamental, but we use
277 // the `use_dll_storage_attrs` variable below to attach the `dllexport`
278 // attribute to all LLVM functions that are reachable (e.g. they're
279 // already tagged with external linkage). This is suboptimal for a few
280 // reasons:
281 //
282 // * If an object file will never be included in a dynamic library,
283 // there's no need to attach the dllexport attribute. Most object
284 // files in Rust are not destined to become part of a dll as binaries
285 // are statically linked by default.
286 // * If the compiler is emitting both an rlib and a dylib, the same
287 // source object file is currently used but with MSVC this may be less
288 // feasible. The compiler may be able to get around this, but it may
289 // involve some invasive changes to deal with this.
290 //
291 // The flipside of this situation is that whenever you link to a dll and
292 // you import a function from it, the import should be tagged with
293 // `dllimport`. At this time, however, the compiler does not emit
294 // `dllimport` for any declarations other than constants (where it is
295 // required), which is again suboptimal for even more reasons!
296 //
297 // * Calling a function imported from another dll without using
298 // `dllimport` causes the linker/compiler to have extra overhead (one
299 // `jmp` instruction on x86) when calling the function.
300 // * The same object file may be used in different circumstances, so a
301 // function may be imported from a dll if the object is linked into a
302 // dll, but it may be just linked against if linked into an rlib.
303 // * The compiler has no knowledge about whether native functions should
304 // be tagged dllimport or not.
305 //
306 // For now the compiler takes the perf hit (I do not have any numbers to
307 // this effect) by marking very little as `dllimport` and praying the
308 // linker will take care of everything. Fixing this problem will likely
309 // require adding a few attributes to Rust itself (feature gated at the
310 // start) and then strongly recommending static linkage on MSVC!
311 let use_dll_storage_attrs = tcx.sess.target.target.options.is_like_msvc;
312
313 let mut shared_ccx = SharedCrateContext {
314 local_ccxs: Vec::with_capacity(local_count),
315 metadata_llmod: metadata_llmod,
316 metadata_llcx: metadata_llcx,
317 export_map: export_map,
318 reachable: reachable,
319 item_symbols: RefCell::new(NodeMap()),
320 link_meta: link_meta,
321 symbol_hasher: RefCell::new(symbol_hasher),
322 tcx: tcx,
323 mir_map: mir_map,
324 stats: Stats {
325 n_glues_created: Cell::new(0),
326 n_null_glues: Cell::new(0),
327 n_real_glues: Cell::new(0),
328 n_fns: Cell::new(0),
329 n_monos: Cell::new(0),
330 n_inlines: Cell::new(0),
331 n_closures: Cell::new(0),
332 n_llvm_insns: Cell::new(0),
333 llvm_insns: RefCell::new(FnvHashMap()),
334 fn_stats: RefCell::new(Vec::new()),
335 },
336 check_overflow: check_overflow,
337 check_drop_flag_for_sanity: check_drop_flag_for_sanity,
338 available_drop_glues: RefCell::new(FnvHashMap()),
339 use_dll_storage_attrs: use_dll_storage_attrs,
340 };
341
342 for i in 0..local_count {
343 // Append ".rs" to crate name as LLVM module identifier.
344 //
345 // LLVM code generator emits a ".file filename" directive
346 // for ELF backends. Value of the "filename" is set as the
347 // LLVM module identifier. Due to a LLVM MC bug[1], LLVM
348 // crashes if the module identifier is same as other symbols
349 // such as a function name in the module.
350 // 1. http://llvm.org/bugs/show_bug.cgi?id=11479
351 let llmod_id = format!("{}.{}.rs", crate_name, i);
352 let local_ccx = LocalCrateContext::new(&shared_ccx, &llmod_id[..]);
353 shared_ccx.local_ccxs.push(local_ccx);
354 }
355
356 shared_ccx
357 }
358
359 pub fn iter<'a>(&'a self) -> CrateContextIterator<'a, 'tcx> {
360 CrateContextIterator {
361 shared: self,
362 index: 0,
363 }
364 }
365
366 pub fn get_ccx<'a>(&'a self, index: usize) -> CrateContext<'a, 'tcx> {
367 CrateContext {
368 shared: self,
369 local: &self.local_ccxs[index],
370 index: index,
371 }
372 }
373
374 fn get_smallest_ccx<'a>(&'a self) -> CrateContext<'a, 'tcx> {
375 let (local_ccx, index) =
376 self.local_ccxs
377 .iter()
378 .zip(0..self.local_ccxs.len())
379 .min_by_key(|&(local_ccx, _idx)| local_ccx.n_llvm_insns.get())
380 .unwrap();
381 CrateContext {
382 shared: self,
383 local: local_ccx,
384 index: index,
385 }
386 }
387
388
389 pub fn metadata_llmod(&self) -> ModuleRef {
390 self.metadata_llmod
391 }
392
393 pub fn metadata_llcx(&self) -> ContextRef {
394 self.metadata_llcx
395 }
396
397 pub fn export_map<'a>(&'a self) -> &'a ExportMap {
398 &self.export_map
399 }
400
401 pub fn reachable<'a>(&'a self) -> &'a NodeSet {
402 &self.reachable
403 }
404
405 pub fn item_symbols<'a>(&'a self) -> &'a RefCell<NodeMap<String>> {
406 &self.item_symbols
407 }
408
409 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
410 &self.link_meta
411 }
412
413 pub fn tcx<'a>(&'a self) -> &'a ty::ctxt<'tcx> {
414 self.tcx
415 }
416
417 pub fn sess<'a>(&'a self) -> &'a Session {
418 &self.tcx.sess
419 }
420
421 pub fn stats<'a>(&'a self) -> &'a Stats {
422 &self.stats
423 }
424
425 pub fn use_dll_storage_attrs(&self) -> bool {
426 self.use_dll_storage_attrs
427 }
428 }
429
430 impl<'tcx> LocalCrateContext<'tcx> {
431 fn new<'a>(shared: &SharedCrateContext<'a, 'tcx>,
432 name: &str)
433 -> LocalCrateContext<'tcx> {
434 unsafe {
435 let (llcx, llmod) = create_context_and_module(&shared.tcx.sess, name);
436
437 let dbg_cx = if shared.tcx.sess.opts.debuginfo != NoDebugInfo {
438 Some(debuginfo::CrateDebugContext::new(llmod))
439 } else {
440 None
441 };
442
443 let mut local_ccx = LocalCrateContext {
444 llmod: llmod,
445 llcx: llcx,
446 tn: TypeNames::new(),
447 externs: RefCell::new(FnvHashMap()),
448 item_vals: RefCell::new(NodeMap()),
449 needs_unwind_cleanup_cache: RefCell::new(FnvHashMap()),
450 fn_pointer_shims: RefCell::new(FnvHashMap()),
451 drop_glues: RefCell::new(FnvHashMap()),
452 external: RefCell::new(DefIdMap()),
453 external_srcs: RefCell::new(NodeMap()),
454 monomorphized: RefCell::new(FnvHashMap()),
455 monomorphizing: RefCell::new(DefIdMap()),
456 available_monomorphizations: RefCell::new(FnvHashSet()),
457 vtables: RefCell::new(FnvHashMap()),
458 const_cstr_cache: RefCell::new(FnvHashMap()),
459 const_unsized: RefCell::new(FnvHashMap()),
460 const_globals: RefCell::new(FnvHashMap()),
461 const_values: RefCell::new(FnvHashMap()),
462 extern_const_values: RefCell::new(DefIdMap()),
463 impl_method_cache: RefCell::new(FnvHashMap()),
464 closure_bare_wrapper_cache: RefCell::new(FnvHashMap()),
465 statics_to_rauw: RefCell::new(Vec::new()),
466 lltypes: RefCell::new(FnvHashMap()),
467 llsizingtypes: RefCell::new(FnvHashMap()),
468 adt_reprs: RefCell::new(FnvHashMap()),
469 type_hashcodes: RefCell::new(FnvHashMap()),
470 int_type: Type::from_ref(ptr::null_mut()),
471 opaque_vec_type: Type::from_ref(ptr::null_mut()),
472 builder: BuilderRef_res(llvm::LLVMCreateBuilderInContext(llcx)),
473 closure_vals: RefCell::new(FnvHashMap()),
474 dbg_cx: dbg_cx,
475 eh_personality: RefCell::new(None),
476 eh_unwind_resume: RefCell::new(None),
477 rust_try_fn: RefCell::new(None),
478 intrinsics: RefCell::new(FnvHashMap()),
479 n_llvm_insns: Cell::new(0),
480 type_of_depth: Cell::new(0),
481 trait_cache: RefCell::new(FnvHashMap()),
482 };
483
484 local_ccx.int_type = Type::int(&local_ccx.dummy_ccx(shared));
485 local_ccx.opaque_vec_type = Type::opaque_vec(&local_ccx.dummy_ccx(shared));
486
487 // Done mutating local_ccx directly. (The rest of the
488 // initialization goes through RefCell.)
489 {
490 let ccx = local_ccx.dummy_ccx(shared);
491
492 let mut str_slice_ty = Type::named_struct(&ccx, "str_slice");
493 str_slice_ty.set_struct_body(&[Type::i8p(&ccx), ccx.int_type()], false);
494 ccx.tn().associate_type("str_slice", &str_slice_ty);
495
496 if ccx.sess().count_llvm_insns() {
497 base::init_insn_ctxt()
498 }
499 }
500
501 local_ccx
502 }
503 }
504
505 /// Create a dummy `CrateContext` from `self` and the provided
506 /// `SharedCrateContext`. This is somewhat dangerous because `self` may
507 /// not actually be an element of `shared.local_ccxs`, which can cause some
508 /// operations to panic unexpectedly.
509 ///
510 /// This is used in the `LocalCrateContext` constructor to allow calling
511 /// functions that expect a complete `CrateContext`, even before the local
512 /// portion is fully initialized and attached to the `SharedCrateContext`.
513 fn dummy_ccx<'a>(&'a self, shared: &'a SharedCrateContext<'a, 'tcx>)
514 -> CrateContext<'a, 'tcx> {
515 CrateContext {
516 shared: shared,
517 local: self,
518 index: !0 as usize,
519 }
520 }
521 }
522
523 impl<'b, 'tcx> CrateContext<'b, 'tcx> {
524 pub fn shared(&self) -> &'b SharedCrateContext<'b, 'tcx> {
525 self.shared
526 }
527
528 pub fn local(&self) -> &'b LocalCrateContext<'tcx> {
529 self.local
530 }
531
532
533 /// Get a (possibly) different `CrateContext` from the same
534 /// `SharedCrateContext`.
535 pub fn rotate(&self) -> CrateContext<'b, 'tcx> {
536 self.shared.get_smallest_ccx()
537 }
538
539 /// Either iterate over only `self`, or iterate over all `CrateContext`s in
540 /// the `SharedCrateContext`. The iterator produces `(ccx, is_origin)`
541 /// pairs, where `is_origin` is `true` if `ccx` is `self` and `false`
542 /// otherwise. This method is useful for avoiding code duplication in
543 /// cases where it may or may not be necessary to translate code into every
544 /// context.
545 pub fn maybe_iter(&self, iter_all: bool) -> CrateContextMaybeIterator<'b, 'tcx> {
546 CrateContextMaybeIterator {
547 shared: self.shared,
548 index: if iter_all { 0 } else { self.index },
549 single: !iter_all,
550 origin: self.index,
551 }
552 }
553
554
555 pub fn tcx<'a>(&'a self) -> &'a ty::ctxt<'tcx> {
556 self.shared.tcx
557 }
558
559 pub fn sess<'a>(&'a self) -> &'a Session {
560 &self.shared.tcx.sess
561 }
562
563 pub fn builder<'a>(&'a self) -> Builder<'a, 'tcx> {
564 Builder::new(self)
565 }
566
567 pub fn raw_builder<'a>(&'a self) -> BuilderRef {
568 self.local.builder.b
569 }
570
571 pub fn get_intrinsic(&self, key: &str) -> ValueRef {
572 if let Some(v) = self.intrinsics().borrow().get(key).cloned() {
573 return v;
574 }
575 match declare_intrinsic(self, key) {
576 Some(v) => return v,
577 None => panic!("unknown intrinsic '{}'", key)
578 }
579 }
580
581 pub fn llmod(&self) -> ModuleRef {
582 self.local.llmod
583 }
584
585 pub fn llcx(&self) -> ContextRef {
586 self.local.llcx
587 }
588
589 pub fn td(&self) -> llvm::TargetDataRef {
590 unsafe { llvm::LLVMRustGetModuleDataLayout(self.llmod()) }
591 }
592
593 pub fn tn<'a>(&'a self) -> &'a TypeNames {
594 &self.local.tn
595 }
596
597 pub fn externs<'a>(&'a self) -> &'a RefCell<ExternMap> {
598 &self.local.externs
599 }
600
601 pub fn item_vals<'a>(&'a self) -> &'a RefCell<NodeMap<ValueRef>> {
602 &self.local.item_vals
603 }
604
605 pub fn export_map<'a>(&'a self) -> &'a ExportMap {
606 &self.shared.export_map
607 }
608
609 pub fn reachable<'a>(&'a self) -> &'a NodeSet {
610 &self.shared.reachable
611 }
612
613 pub fn item_symbols<'a>(&'a self) -> &'a RefCell<NodeMap<String>> {
614 &self.shared.item_symbols
615 }
616
617 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
618 &self.shared.link_meta
619 }
620
621 pub fn needs_unwind_cleanup_cache(&self) -> &RefCell<FnvHashMap<Ty<'tcx>, bool>> {
622 &self.local.needs_unwind_cleanup_cache
623 }
624
625 pub fn fn_pointer_shims(&self) -> &RefCell<FnvHashMap<Ty<'tcx>, ValueRef>> {
626 &self.local.fn_pointer_shims
627 }
628
629 pub fn drop_glues<'a>(&'a self) -> &'a RefCell<FnvHashMap<DropGlueKind<'tcx>, ValueRef>> {
630 &self.local.drop_glues
631 }
632
633 pub fn external<'a>(&'a self) -> &'a RefCell<DefIdMap<Option<ast::NodeId>>> {
634 &self.local.external
635 }
636
637 pub fn external_srcs<'a>(&'a self) -> &'a RefCell<NodeMap<DefId>> {
638 &self.local.external_srcs
639 }
640
641 pub fn monomorphized<'a>(&'a self) -> &'a RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>> {
642 &self.local.monomorphized
643 }
644
645 pub fn monomorphizing<'a>(&'a self) -> &'a RefCell<DefIdMap<usize>> {
646 &self.local.monomorphizing
647 }
648
649 pub fn vtables<'a>(&'a self) -> &'a RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>, ValueRef>> {
650 &self.local.vtables
651 }
652
653 pub fn const_cstr_cache<'a>(&'a self) -> &'a RefCell<FnvHashMap<InternedString, ValueRef>> {
654 &self.local.const_cstr_cache
655 }
656
657 pub fn const_unsized<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
658 &self.local.const_unsized
659 }
660
661 pub fn const_globals<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
662 &self.local.const_globals
663 }
664
665 pub fn const_values<'a>(&'a self) -> &'a RefCell<FnvHashMap<(ast::NodeId, &'tcx Substs<'tcx>),
666 ValueRef>> {
667 &self.local.const_values
668 }
669
670 pub fn extern_const_values<'a>(&'a self) -> &'a RefCell<DefIdMap<ValueRef>> {
671 &self.local.extern_const_values
672 }
673
674 pub fn impl_method_cache<'a>(&'a self)
675 -> &'a RefCell<FnvHashMap<(DefId, ast::Name), DefId>> {
676 &self.local.impl_method_cache
677 }
678
679 pub fn closure_bare_wrapper_cache<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
680 &self.local.closure_bare_wrapper_cache
681 }
682
683 pub fn statics_to_rauw<'a>(&'a self) -> &'a RefCell<Vec<(ValueRef, ValueRef)>> {
684 &self.local.statics_to_rauw
685 }
686
687 pub fn lltypes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Type>> {
688 &self.local.lltypes
689 }
690
691 pub fn llsizingtypes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Type>> {
692 &self.local.llsizingtypes
693 }
694
695 pub fn adt_reprs<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Rc<adt::Repr<'tcx>>>> {
696 &self.local.adt_reprs
697 }
698
699 pub fn symbol_hasher<'a>(&'a self) -> &'a RefCell<Sha256> {
700 &self.shared.symbol_hasher
701 }
702
703 pub fn type_hashcodes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, String>> {
704 &self.local.type_hashcodes
705 }
706
707 pub fn stats<'a>(&'a self) -> &'a Stats {
708 &self.shared.stats
709 }
710
711 pub fn available_monomorphizations<'a>(&'a self) -> &'a RefCell<FnvHashSet<String>> {
712 &self.local.available_monomorphizations
713 }
714
715 pub fn available_drop_glues(&self) -> &RefCell<FnvHashMap<DropGlueKind<'tcx>, String>> {
716 &self.shared.available_drop_glues
717 }
718
719 pub fn int_type(&self) -> Type {
720 self.local.int_type
721 }
722
723 pub fn opaque_vec_type(&self) -> Type {
724 self.local.opaque_vec_type
725 }
726
727 pub fn closure_vals<'a>(&'a self) -> &'a RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>> {
728 &self.local.closure_vals
729 }
730
731 pub fn dbg_cx<'a>(&'a self) -> &'a Option<debuginfo::CrateDebugContext<'tcx>> {
732 &self.local.dbg_cx
733 }
734
735 pub fn eh_personality<'a>(&'a self) -> &'a RefCell<Option<ValueRef>> {
736 &self.local.eh_personality
737 }
738
739 pub fn eh_unwind_resume<'a>(&'a self) -> &'a RefCell<Option<ValueRef>> {
740 &self.local.eh_unwind_resume
741 }
742
743 pub fn rust_try_fn<'a>(&'a self) -> &'a RefCell<Option<ValueRef>> {
744 &self.local.rust_try_fn
745 }
746
747 fn intrinsics<'a>(&'a self) -> &'a RefCell<FnvHashMap<&'static str, ValueRef>> {
748 &self.local.intrinsics
749 }
750
751 pub fn count_llvm_insn(&self) {
752 self.local.n_llvm_insns.set(self.local.n_llvm_insns.get() + 1);
753 }
754
755 pub fn trait_cache(&self) -> &RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>,
756 traits::Vtable<'tcx, ()>>> {
757 &self.local.trait_cache
758 }
759
760 /// Return exclusive upper bound on object size.
761 ///
762 /// The theoretical maximum object size is defined as the maximum positive `int` value. This
763 /// ensures that the `offset` semantics remain well-defined by allowing it to correctly index
764 /// every address within an object along with one byte past the end, along with allowing `int`
765 /// to store the difference between any two pointers into an object.
766 ///
767 /// The upper bound on 64-bit currently needs to be lower because LLVM uses a 64-bit integer to
768 /// represent object size in bits. It would need to be 1 << 61 to account for this, but is
769 /// currently conservatively bounded to 1 << 47 as that is enough to cover the current usable
770 /// address space on 64-bit ARMv8 and x86_64.
771 pub fn obj_size_bound(&self) -> u64 {
772 match &self.sess().target.target.target_pointer_width[..] {
773 "32" => 1 << 31,
774 "64" => 1 << 47,
775 _ => unreachable!() // error handled by config::build_target_config
776 }
777 }
778
779 pub fn report_overbig_object(&self, obj: Ty<'tcx>) -> ! {
780 self.sess().fatal(
781 &format!("the type `{:?}` is too big for the current architecture",
782 obj))
783 }
784
785 pub fn enter_type_of(&self, ty: Ty<'tcx>) -> TypeOfDepthLock<'b, 'tcx> {
786 let current_depth = self.local.type_of_depth.get();
787 debug!("enter_type_of({:?}) at depth {:?}", ty, current_depth);
788 if current_depth > self.sess().recursion_limit.get() {
789 self.sess().fatal(
790 &format!("overflow representing the type `{}`", ty))
791 }
792 self.local.type_of_depth.set(current_depth + 1);
793 TypeOfDepthLock(self.local)
794 }
795
796 pub fn check_overflow(&self) -> bool {
797 self.shared.check_overflow
798 }
799
800 pub fn check_drop_flag_for_sanity(&self) -> bool {
801 // This controls whether we emit a conditional llvm.debugtrap
802 // guarded on whether the dropflag is one of its (two) valid
803 // values.
804 self.shared.check_drop_flag_for_sanity
805 }
806
807 pub fn use_dll_storage_attrs(&self) -> bool {
808 self.shared.use_dll_storage_attrs()
809 }
810
811 pub fn mir_map(&self) -> &'b MirMap<'tcx> {
812 self.shared.mir_map
813 }
814 }
815
816 pub struct TypeOfDepthLock<'a, 'tcx: 'a>(&'a LocalCrateContext<'tcx>);
817
818 impl<'a, 'tcx> Drop for TypeOfDepthLock<'a, 'tcx> {
819 fn drop(&mut self) {
820 self.0.type_of_depth.set(self.0.type_of_depth.get() - 1);
821 }
822 }
823
824 /// Declare any llvm intrinsics that you might need
825 fn declare_intrinsic(ccx: &CrateContext, key: &str) -> Option<ValueRef> {
826 macro_rules! ifn {
827 ($name:expr, fn() -> $ret:expr) => (
828 if key == $name {
829 let f = declare::declare_cfn(ccx, $name, Type::func(&[], &$ret),
830 ccx.tcx().mk_nil());
831 llvm::SetUnnamedAddr(f, false);
832 ccx.intrinsics().borrow_mut().insert($name, f.clone());
833 return Some(f);
834 }
835 );
836 ($name:expr, fn($($arg:expr),*) -> $ret:expr) => (
837 if key == $name {
838 let f = declare::declare_cfn(ccx, $name, Type::func(&[$($arg),*], &$ret),
839 ccx.tcx().mk_nil());
840 llvm::SetUnnamedAddr(f, false);
841 ccx.intrinsics().borrow_mut().insert($name, f.clone());
842 return Some(f);
843 }
844 )
845 }
846 macro_rules! mk_struct {
847 ($($field_ty:expr),*) => (Type::struct_(ccx, &[$($field_ty),*], false))
848 }
849
850 let i8p = Type::i8p(ccx);
851 let void = Type::void(ccx);
852 let i1 = Type::i1(ccx);
853 let t_i8 = Type::i8(ccx);
854 let t_i16 = Type::i16(ccx);
855 let t_i32 = Type::i32(ccx);
856 let t_i64 = Type::i64(ccx);
857 let t_f32 = Type::f32(ccx);
858 let t_f64 = Type::f64(ccx);
859
860 ifn!("llvm.memcpy.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
861 ifn!("llvm.memcpy.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
862 ifn!("llvm.memcpy.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
863 ifn!("llvm.memmove.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
864 ifn!("llvm.memmove.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
865 ifn!("llvm.memmove.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
866 ifn!("llvm.memset.p0i8.i16", fn(i8p, t_i8, t_i16, t_i32, i1) -> void);
867 ifn!("llvm.memset.p0i8.i32", fn(i8p, t_i8, t_i32, t_i32, i1) -> void);
868 ifn!("llvm.memset.p0i8.i64", fn(i8p, t_i8, t_i64, t_i32, i1) -> void);
869
870 ifn!("llvm.trap", fn() -> void);
871 ifn!("llvm.debugtrap", fn() -> void);
872
873 ifn!("llvm.powi.f32", fn(t_f32, t_i32) -> t_f32);
874 ifn!("llvm.powi.f64", fn(t_f64, t_i32) -> t_f64);
875 ifn!("llvm.pow.f32", fn(t_f32, t_f32) -> t_f32);
876 ifn!("llvm.pow.f64", fn(t_f64, t_f64) -> t_f64);
877
878 ifn!("llvm.sqrt.f32", fn(t_f32) -> t_f32);
879 ifn!("llvm.sqrt.f64", fn(t_f64) -> t_f64);
880 ifn!("llvm.sin.f32", fn(t_f32) -> t_f32);
881 ifn!("llvm.sin.f64", fn(t_f64) -> t_f64);
882 ifn!("llvm.cos.f32", fn(t_f32) -> t_f32);
883 ifn!("llvm.cos.f64", fn(t_f64) -> t_f64);
884 ifn!("llvm.exp.f32", fn(t_f32) -> t_f32);
885 ifn!("llvm.exp.f64", fn(t_f64) -> t_f64);
886 ifn!("llvm.exp2.f32", fn(t_f32) -> t_f32);
887 ifn!("llvm.exp2.f64", fn(t_f64) -> t_f64);
888 ifn!("llvm.log.f32", fn(t_f32) -> t_f32);
889 ifn!("llvm.log.f64", fn(t_f64) -> t_f64);
890 ifn!("llvm.log10.f32", fn(t_f32) -> t_f32);
891 ifn!("llvm.log10.f64", fn(t_f64) -> t_f64);
892 ifn!("llvm.log2.f32", fn(t_f32) -> t_f32);
893 ifn!("llvm.log2.f64", fn(t_f64) -> t_f64);
894
895 ifn!("llvm.fma.f32", fn(t_f32, t_f32, t_f32) -> t_f32);
896 ifn!("llvm.fma.f64", fn(t_f64, t_f64, t_f64) -> t_f64);
897
898 ifn!("llvm.fabs.f32", fn(t_f32) -> t_f32);
899 ifn!("llvm.fabs.f64", fn(t_f64) -> t_f64);
900
901 ifn!("llvm.floor.f32", fn(t_f32) -> t_f32);
902 ifn!("llvm.floor.f64", fn(t_f64) -> t_f64);
903 ifn!("llvm.ceil.f32", fn(t_f32) -> t_f32);
904 ifn!("llvm.ceil.f64", fn(t_f64) -> t_f64);
905 ifn!("llvm.trunc.f32", fn(t_f32) -> t_f32);
906 ifn!("llvm.trunc.f64", fn(t_f64) -> t_f64);
907
908 ifn!("llvm.copysign.f32", fn(t_f32, t_f32) -> t_f32);
909 ifn!("llvm.copysign.f64", fn(t_f64, t_f64) -> t_f64);
910 ifn!("llvm.round.f32", fn(t_f32) -> t_f32);
911 ifn!("llvm.round.f64", fn(t_f64) -> t_f64);
912
913 ifn!("llvm.rint.f32", fn(t_f32) -> t_f32);
914 ifn!("llvm.rint.f64", fn(t_f64) -> t_f64);
915 ifn!("llvm.nearbyint.f32", fn(t_f32) -> t_f32);
916 ifn!("llvm.nearbyint.f64", fn(t_f64) -> t_f64);
917
918 ifn!("llvm.ctpop.i8", fn(t_i8) -> t_i8);
919 ifn!("llvm.ctpop.i16", fn(t_i16) -> t_i16);
920 ifn!("llvm.ctpop.i32", fn(t_i32) -> t_i32);
921 ifn!("llvm.ctpop.i64", fn(t_i64) -> t_i64);
922
923 ifn!("llvm.ctlz.i8", fn(t_i8 , i1) -> t_i8);
924 ifn!("llvm.ctlz.i16", fn(t_i16, i1) -> t_i16);
925 ifn!("llvm.ctlz.i32", fn(t_i32, i1) -> t_i32);
926 ifn!("llvm.ctlz.i64", fn(t_i64, i1) -> t_i64);
927
928 ifn!("llvm.cttz.i8", fn(t_i8 , i1) -> t_i8);
929 ifn!("llvm.cttz.i16", fn(t_i16, i1) -> t_i16);
930 ifn!("llvm.cttz.i32", fn(t_i32, i1) -> t_i32);
931 ifn!("llvm.cttz.i64", fn(t_i64, i1) -> t_i64);
932
933 ifn!("llvm.bswap.i16", fn(t_i16) -> t_i16);
934 ifn!("llvm.bswap.i32", fn(t_i32) -> t_i32);
935 ifn!("llvm.bswap.i64", fn(t_i64) -> t_i64);
936
937 ifn!("llvm.sadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
938 ifn!("llvm.sadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
939 ifn!("llvm.sadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
940 ifn!("llvm.sadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
941
942 ifn!("llvm.uadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
943 ifn!("llvm.uadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
944 ifn!("llvm.uadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
945 ifn!("llvm.uadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
946
947 ifn!("llvm.ssub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
948 ifn!("llvm.ssub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
949 ifn!("llvm.ssub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
950 ifn!("llvm.ssub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
951
952 ifn!("llvm.usub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
953 ifn!("llvm.usub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
954 ifn!("llvm.usub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
955 ifn!("llvm.usub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
956
957 ifn!("llvm.smul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
958 ifn!("llvm.smul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
959 ifn!("llvm.smul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
960 ifn!("llvm.smul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
961
962 ifn!("llvm.umul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
963 ifn!("llvm.umul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
964 ifn!("llvm.umul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
965 ifn!("llvm.umul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
966
967 ifn!("llvm.lifetime.start", fn(t_i64,i8p) -> void);
968 ifn!("llvm.lifetime.end", fn(t_i64, i8p) -> void);
969
970 ifn!("llvm.expect.i1", fn(i1, i1) -> i1);
971 ifn!("llvm.eh.typeid.for", fn(i8p) -> t_i32);
972
973 // Some intrinsics were introduced in later versions of LLVM, but they have
974 // fallbacks in libc or libm and such.
975 macro_rules! compatible_ifn {
976 ($name:expr, noop($cname:ident ($($arg:expr),*) -> void), $llvm_version:expr) => (
977 if unsafe { llvm::LLVMVersionMinor() >= $llvm_version } {
978 // The `if key == $name` is already in ifn!
979 ifn!($name, fn($($arg),*) -> void);
980 } else if key == $name {
981 let f = declare::declare_cfn(ccx, stringify!($cname),
982 Type::func(&[$($arg),*], &void),
983 ccx.tcx().mk_nil());
984 llvm::SetLinkage(f, llvm::InternalLinkage);
985
986 let bld = ccx.builder();
987 let llbb = unsafe {
988 llvm::LLVMAppendBasicBlockInContext(ccx.llcx(), f,
989 "entry-block\0".as_ptr() as *const _)
990 };
991
992 bld.position_at_end(llbb);
993 bld.ret_void();
994
995 ccx.intrinsics().borrow_mut().insert($name, f.clone());
996 return Some(f);
997 }
998 );
999 ($name:expr, $cname:ident ($($arg:expr),*) -> $ret:expr, $llvm_version:expr) => (
1000 if unsafe { llvm::LLVMVersionMinor() >= $llvm_version } {
1001 // The `if key == $name` is already in ifn!
1002 ifn!($name, fn($($arg),*) -> $ret);
1003 } else if key == $name {
1004 let f = declare::declare_cfn(ccx, stringify!($cname),
1005 Type::func(&[$($arg),*], &$ret),
1006 ccx.tcx().mk_nil());
1007 ccx.intrinsics().borrow_mut().insert($name, f.clone());
1008 return Some(f);
1009 }
1010 )
1011 }
1012
1013 compatible_ifn!("llvm.assume", noop(llvmcompat_assume(i1) -> void), 6);
1014
1015 if ccx.sess().opts.debuginfo != NoDebugInfo {
1016 ifn!("llvm.dbg.declare", fn(Type::metadata(ccx), Type::metadata(ccx)) -> void);
1017 ifn!("llvm.dbg.value", fn(Type::metadata(ccx), t_i64, Type::metadata(ccx)) -> void);
1018 }
1019 return None;
1020 }