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.
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.
12 use llvm::{ContextRef, ModuleRef, ValueRef, BuilderRef};
13 use rustc::dep_graph::{DepNode, DepTrackingMap, DepTrackingMapConfig};
14 use middle::cstore::LinkMeta;
15 use middle::def::ExportMap;
16 use middle::def_id::DefId;
18 use rustc_mir::mir_map::MirMap;
21 use trans::builder::Builder;
22 use trans::common::{ExternMap,BuilderRef_res};
25 use trans::glue::DropGlueKind;
26 use trans::monomorphize::MonoId;
27 use trans::collector::{TransItem, TransItemState};
28 use trans::type_::{Type, TypeNames};
29 use middle::subst::Substs;
30 use middle::ty::{self, Ty};
31 use session::config::NoDebugInfo;
33 use util::sha2::Sha256;
34 use util::nodemap::{NodeMap, NodeSet, DefIdMap, FnvHashMap, FnvHashSet};
36 use std::ffi::CString;
37 use std::cell::{Cell, RefCell};
38 use std::marker::PhantomData;
42 use syntax::parse::token::InternedString;
45 pub n_glues_created: Cell<usize>,
46 pub n_null_glues: Cell<usize>,
47 pub n_real_glues: Cell<usize>,
48 pub n_fns: Cell<usize>,
49 pub n_monos: 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<FnvHashMap<String, usize>>,
54 // (ident, llvm-instructions)
55 pub fn_stats: RefCell<Vec<(String, usize)> >,
58 /// The shared portion of a `CrateContext`. There is one `SharedCrateContext`
59 /// per crate. The data here is shared between all compilation units of the
60 /// crate, so it must not contain references to any LLVM data structures
61 /// (aside from metadata-related ones).
62 pub struct SharedCrateContext<'a, 'tcx: 'a> {
63 local_ccxs: Vec<LocalCrateContext<'tcx>>,
65 metadata_llmod: ModuleRef,
66 metadata_llcx: ContextRef,
68 export_map: ExportMap,
70 item_symbols: RefCell<NodeMap<String>>,
72 symbol_hasher: RefCell<Sha256>,
73 tcx: &'a ty::ctxt<'tcx>,
76 check_drop_flag_for_sanity: bool,
77 mir_map: &'a MirMap<'tcx>,
79 available_drop_glues: RefCell<FnvHashMap<DropGlueKind<'tcx>, String>>,
80 use_dll_storage_attrs: bool,
82 translation_items: RefCell<FnvHashMap<TransItem<'tcx>, TransItemState>>,
85 /// The local portion of a `CrateContext`. There is one `LocalCrateContext`
86 /// per compilation unit. Each one has its own LLVM `ContextRef` so that
87 /// several compilation units may be optimized in parallel. All other LLVM
88 /// data structures in the `LocalCrateContext` are tied to that `ContextRef`.
89 pub struct LocalCrateContext<'tcx> {
93 externs: RefCell<ExternMap>,
94 item_vals: RefCell<NodeMap<ValueRef>>,
95 needs_unwind_cleanup_cache: RefCell<FnvHashMap<Ty<'tcx>, bool>>,
96 fn_pointer_shims: RefCell<FnvHashMap<Ty<'tcx>, ValueRef>>,
97 drop_glues: RefCell<FnvHashMap<DropGlueKind<'tcx>, ValueRef>>,
98 /// Track mapping of external ids to local items imported for inlining
99 external: RefCell<DefIdMap<Option<ast::NodeId>>>,
100 /// Backwards version of the `external` map (inlined items to where they
102 external_srcs: RefCell<NodeMap<DefId>>,
103 /// Cache instances of monomorphized functions
104 monomorphized: RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>>,
105 monomorphizing: RefCell<DefIdMap<usize>>,
106 available_monomorphizations: RefCell<FnvHashSet<String>>,
107 /// Cache generated vtables
108 vtables: RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>, ValueRef>>,
109 /// Cache of constant strings,
110 const_cstr_cache: RefCell<FnvHashMap<InternedString, ValueRef>>,
112 /// Reverse-direction for const ptrs cast from globals.
113 /// Key is a ValueRef holding a *T,
114 /// Val is a ValueRef holding a *[T].
116 /// Needed because LLVM loses pointer->pointee association
117 /// when we ptrcast, and we have to ptrcast during translation
118 /// of a [T] const because we form a slice, a (*T,usize) pair, not
119 /// a pointer to an LLVM array type. Similar for trait objects.
120 const_unsized: RefCell<FnvHashMap<ValueRef, ValueRef>>,
122 /// Cache of emitted const globals (value -> global)
123 const_globals: RefCell<FnvHashMap<ValueRef, ValueRef>>,
125 /// Cache of emitted const values
126 const_values: RefCell<FnvHashMap<(ast::NodeId, &'tcx Substs<'tcx>), ValueRef>>,
128 /// Cache of external const values
129 extern_const_values: RefCell<DefIdMap<ValueRef>>,
131 impl_method_cache: RefCell<FnvHashMap<(DefId, ast::Name), DefId>>,
133 /// Cache of closure wrappers for bare fn's.
134 closure_bare_wrapper_cache: RefCell<FnvHashMap<ValueRef, ValueRef>>,
136 /// List of globals for static variables which need to be passed to the
137 /// LLVM function ReplaceAllUsesWith (RAUW) when translation is complete.
138 /// (We have to make sure we don't invalidate any ValueRefs referring
140 statics_to_rauw: RefCell<Vec<(ValueRef, ValueRef)>>,
142 lltypes: RefCell<FnvHashMap<Ty<'tcx>, Type>>,
143 llsizingtypes: RefCell<FnvHashMap<Ty<'tcx>, Type>>,
144 adt_reprs: RefCell<FnvHashMap<Ty<'tcx>, Rc<adt::Repr<'tcx>>>>,
145 type_hashcodes: RefCell<FnvHashMap<Ty<'tcx>, String>>,
147 opaque_vec_type: Type,
148 builder: BuilderRef_res,
150 /// Holds the LLVM values for closure IDs.
151 closure_vals: RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>>,
153 dbg_cx: Option<debuginfo::CrateDebugContext<'tcx>>,
155 eh_personality: RefCell<Option<ValueRef>>,
156 eh_unwind_resume: RefCell<Option<ValueRef>>,
157 rust_try_fn: RefCell<Option<ValueRef>>,
159 intrinsics: RefCell<FnvHashMap<&'static str, ValueRef>>,
161 /// Number of LLVM instructions translated into this `LocalCrateContext`.
162 /// This is used to perform some basic load-balancing to keep all LLVM
163 /// contexts around the same size.
164 n_llvm_insns: Cell<usize>,
166 /// Depth of the current type-of computation - used to bail out
167 type_of_depth: Cell<usize>,
169 trait_cache: RefCell<DepTrackingMap<TraitSelectionCache<'tcx>>>,
172 // Implement DepTrackingMapConfig for `trait_cache`
173 pub struct TraitSelectionCache<'tcx> {
174 data: PhantomData<&'tcx ()>
177 impl<'tcx> DepTrackingMapConfig for TraitSelectionCache<'tcx> {
178 type Key = ty::PolyTraitRef<'tcx>;
179 type Value = traits::Vtable<'tcx, ()>;
180 fn to_dep_node(key: &ty::PolyTraitRef<'tcx>) -> DepNode {
181 ty::tls::with(|tcx| {
182 let lifted_key = tcx.lift(key).unwrap();
183 lifted_key.to_poly_trait_predicate().dep_node()
188 pub struct CrateContext<'a, 'tcx: 'a> {
189 shared: &'a SharedCrateContext<'a, 'tcx>,
190 local: &'a LocalCrateContext<'tcx>,
191 /// The index of `local` in `shared.local_ccxs`. This is used in
192 /// `maybe_iter(true)` to identify the original `LocalCrateContext`.
196 pub struct CrateContextIterator<'a, 'tcx: 'a> {
197 shared: &'a SharedCrateContext<'a, 'tcx>,
201 impl<'a, 'tcx> Iterator for CrateContextIterator<'a,'tcx> {
202 type Item = CrateContext<'a, 'tcx>;
204 fn next(&mut self) -> Option<CrateContext<'a, 'tcx>> {
205 if self.index >= self.shared.local_ccxs.len() {
209 let index = self.index;
214 local: &self.shared.local_ccxs[index],
220 /// The iterator produced by `CrateContext::maybe_iter`.
221 pub struct CrateContextMaybeIterator<'a, 'tcx: 'a> {
222 shared: &'a SharedCrateContext<'a, 'tcx>,
228 impl<'a, 'tcx> Iterator for CrateContextMaybeIterator<'a, 'tcx> {
229 type Item = (CrateContext<'a, 'tcx>, bool);
231 fn next(&mut self) -> Option<(CrateContext<'a, 'tcx>, bool)> {
232 if self.index >= self.shared.local_ccxs.len() {
236 let index = self.index;
239 self.index = self.shared.local_ccxs.len();
242 let ccx = CrateContext {
244 local: &self.shared.local_ccxs[index],
247 Some((ccx, index == self.origin))
251 unsafe fn create_context_and_module(sess: &Session, mod_name: &str) -> (ContextRef, ModuleRef) {
252 let llcx = llvm::LLVMContextCreate();
253 let mod_name = CString::new(mod_name).unwrap();
254 let llmod = llvm::LLVMModuleCreateWithNameInContext(mod_name.as_ptr(), llcx);
256 if let Some(ref custom_data_layout) = sess.target.target.options.data_layout {
257 let data_layout = CString::new(&custom_data_layout[..]).unwrap();
258 llvm::LLVMSetDataLayout(llmod, data_layout.as_ptr());
260 let tm = ::back::write::create_target_machine(sess);
261 llvm::LLVMRustSetDataLayoutFromTargetMachine(llmod, tm);
262 llvm::LLVMRustDisposeTargetMachine(tm);
265 let llvm_target = sess.target.target.llvm_target.as_bytes();
266 let llvm_target = CString::new(llvm_target).unwrap();
267 llvm::LLVMRustSetNormalizedTarget(llmod, llvm_target.as_ptr());
271 impl<'b, 'tcx> SharedCrateContext<'b, 'tcx> {
272 pub fn new(crate_name: &str,
274 tcx: &'b ty::ctxt<'tcx>,
275 mir_map: &'b MirMap<'tcx>,
276 export_map: ExportMap,
277 symbol_hasher: Sha256,
280 check_overflow: bool,
281 check_drop_flag_for_sanity: bool)
282 -> SharedCrateContext<'b, 'tcx> {
283 let (metadata_llcx, metadata_llmod) = unsafe {
284 create_context_and_module(&tcx.sess, "metadata")
287 // An interesting part of Windows which MSVC forces our hand on (and
288 // apparently MinGW didn't) is the usage of `dllimport` and `dllexport`
289 // attributes in LLVM IR as well as native dependencies (in C these
290 // correspond to `__declspec(dllimport)`).
292 // Whenever a dynamic library is built by MSVC it must have its public
293 // interface specified by functions tagged with `dllexport` or otherwise
294 // they're not available to be linked against. This poses a few problems
295 // for the compiler, some of which are somewhat fundamental, but we use
296 // the `use_dll_storage_attrs` variable below to attach the `dllexport`
297 // attribute to all LLVM functions that are reachable (e.g. they're
298 // already tagged with external linkage). This is suboptimal for a few
301 // * If an object file will never be included in a dynamic library,
302 // there's no need to attach the dllexport attribute. Most object
303 // files in Rust are not destined to become part of a dll as binaries
304 // are statically linked by default.
305 // * If the compiler is emitting both an rlib and a dylib, the same
306 // source object file is currently used but with MSVC this may be less
307 // feasible. The compiler may be able to get around this, but it may
308 // involve some invasive changes to deal with this.
310 // The flipside of this situation is that whenever you link to a dll and
311 // you import a function from it, the import should be tagged with
312 // `dllimport`. At this time, however, the compiler does not emit
313 // `dllimport` for any declarations other than constants (where it is
314 // required), which is again suboptimal for even more reasons!
316 // * Calling a function imported from another dll without using
317 // `dllimport` causes the linker/compiler to have extra overhead (one
318 // `jmp` instruction on x86) when calling the function.
319 // * The same object file may be used in different circumstances, so a
320 // function may be imported from a dll if the object is linked into a
321 // dll, but it may be just linked against if linked into an rlib.
322 // * The compiler has no knowledge about whether native functions should
323 // be tagged dllimport or not.
325 // For now the compiler takes the perf hit (I do not have any numbers to
326 // this effect) by marking very little as `dllimport` and praying the
327 // linker will take care of everything. Fixing this problem will likely
328 // require adding a few attributes to Rust itself (feature gated at the
329 // start) and then strongly recommending static linkage on MSVC!
330 let use_dll_storage_attrs = tcx.sess.target.target.options.is_like_msvc;
332 let mut shared_ccx = SharedCrateContext {
333 local_ccxs: Vec::with_capacity(local_count),
334 metadata_llmod: metadata_llmod,
335 metadata_llcx: metadata_llcx,
336 export_map: export_map,
337 reachable: reachable,
338 item_symbols: RefCell::new(NodeMap()),
339 link_meta: link_meta,
340 symbol_hasher: RefCell::new(symbol_hasher),
344 n_glues_created: Cell::new(0),
345 n_null_glues: Cell::new(0),
346 n_real_glues: Cell::new(0),
348 n_monos: Cell::new(0),
349 n_inlines: Cell::new(0),
350 n_closures: Cell::new(0),
351 n_llvm_insns: Cell::new(0),
352 llvm_insns: RefCell::new(FnvHashMap()),
353 fn_stats: RefCell::new(Vec::new()),
355 check_overflow: check_overflow,
356 check_drop_flag_for_sanity: check_drop_flag_for_sanity,
357 available_drop_glues: RefCell::new(FnvHashMap()),
358 use_dll_storage_attrs: use_dll_storage_attrs,
359 translation_items: RefCell::new(FnvHashMap()),
362 for i in 0..local_count {
363 // Append ".rs" to crate name as LLVM module identifier.
365 // LLVM code generator emits a ".file filename" directive
366 // for ELF backends. Value of the "filename" is set as the
367 // LLVM module identifier. Due to a LLVM MC bug[1], LLVM
368 // crashes if the module identifier is same as other symbols
369 // such as a function name in the module.
370 // 1. http://llvm.org/bugs/show_bug.cgi?id=11479
371 let llmod_id = format!("{}.{}.rs", crate_name, i);
372 let local_ccx = LocalCrateContext::new(&shared_ccx, &llmod_id[..]);
373 shared_ccx.local_ccxs.push(local_ccx);
379 pub fn iter<'a>(&'a self) -> CrateContextIterator<'a, 'tcx> {
380 CrateContextIterator {
386 pub fn get_ccx<'a>(&'a self, index: usize) -> CrateContext<'a, 'tcx> {
389 local: &self.local_ccxs[index],
394 fn get_smallest_ccx<'a>(&'a self) -> CrateContext<'a, 'tcx> {
395 let (local_ccx, index) =
398 .zip(0..self.local_ccxs.len())
399 .min_by_key(|&(local_ccx, _idx)| local_ccx.n_llvm_insns.get())
409 pub fn metadata_llmod(&self) -> ModuleRef {
413 pub fn metadata_llcx(&self) -> ContextRef {
417 pub fn export_map<'a>(&'a self) -> &'a ExportMap {
421 pub fn reachable<'a>(&'a self) -> &'a NodeSet {
425 pub fn item_symbols<'a>(&'a self) -> &'a RefCell<NodeMap<String>> {
429 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
433 pub fn tcx<'a>(&'a self) -> &'a ty::ctxt<'tcx> {
437 pub fn sess<'a>(&'a self) -> &'a Session {
441 pub fn stats<'a>(&'a self) -> &'a Stats {
445 pub fn use_dll_storage_attrs(&self) -> bool {
446 self.use_dll_storage_attrs
450 impl<'tcx> LocalCrateContext<'tcx> {
451 fn new<'a>(shared: &SharedCrateContext<'a, 'tcx>,
453 -> LocalCrateContext<'tcx> {
455 let (llcx, llmod) = create_context_and_module(&shared.tcx.sess, name);
457 let dbg_cx = if shared.tcx.sess.opts.debuginfo != NoDebugInfo {
458 Some(debuginfo::CrateDebugContext::new(llmod))
463 let mut local_ccx = LocalCrateContext {
466 tn: TypeNames::new(),
467 externs: RefCell::new(FnvHashMap()),
468 item_vals: RefCell::new(NodeMap()),
469 needs_unwind_cleanup_cache: RefCell::new(FnvHashMap()),
470 fn_pointer_shims: RefCell::new(FnvHashMap()),
471 drop_glues: RefCell::new(FnvHashMap()),
472 external: RefCell::new(DefIdMap()),
473 external_srcs: RefCell::new(NodeMap()),
474 monomorphized: RefCell::new(FnvHashMap()),
475 monomorphizing: RefCell::new(DefIdMap()),
476 available_monomorphizations: RefCell::new(FnvHashSet()),
477 vtables: RefCell::new(FnvHashMap()),
478 const_cstr_cache: RefCell::new(FnvHashMap()),
479 const_unsized: RefCell::new(FnvHashMap()),
480 const_globals: RefCell::new(FnvHashMap()),
481 const_values: RefCell::new(FnvHashMap()),
482 extern_const_values: RefCell::new(DefIdMap()),
483 impl_method_cache: RefCell::new(FnvHashMap()),
484 closure_bare_wrapper_cache: RefCell::new(FnvHashMap()),
485 statics_to_rauw: RefCell::new(Vec::new()),
486 lltypes: RefCell::new(FnvHashMap()),
487 llsizingtypes: RefCell::new(FnvHashMap()),
488 adt_reprs: RefCell::new(FnvHashMap()),
489 type_hashcodes: RefCell::new(FnvHashMap()),
490 int_type: Type::from_ref(ptr::null_mut()),
491 opaque_vec_type: Type::from_ref(ptr::null_mut()),
492 builder: BuilderRef_res(llvm::LLVMCreateBuilderInContext(llcx)),
493 closure_vals: RefCell::new(FnvHashMap()),
495 eh_personality: RefCell::new(None),
496 eh_unwind_resume: RefCell::new(None),
497 rust_try_fn: RefCell::new(None),
498 intrinsics: RefCell::new(FnvHashMap()),
499 n_llvm_insns: Cell::new(0),
500 type_of_depth: Cell::new(0),
501 trait_cache: RefCell::new(DepTrackingMap::new(shared.tcx
506 local_ccx.int_type = Type::int(&local_ccx.dummy_ccx(shared));
507 local_ccx.opaque_vec_type = Type::opaque_vec(&local_ccx.dummy_ccx(shared));
509 // Done mutating local_ccx directly. (The rest of the
510 // initialization goes through RefCell.)
512 let ccx = local_ccx.dummy_ccx(shared);
514 let mut str_slice_ty = Type::named_struct(&ccx, "str_slice");
515 str_slice_ty.set_struct_body(&[Type::i8p(&ccx), ccx.int_type()], false);
516 ccx.tn().associate_type("str_slice", &str_slice_ty);
518 if ccx.sess().count_llvm_insns() {
519 base::init_insn_ctxt()
527 /// Create a dummy `CrateContext` from `self` and the provided
528 /// `SharedCrateContext`. This is somewhat dangerous because `self` may
529 /// not actually be an element of `shared.local_ccxs`, which can cause some
530 /// operations to panic unexpectedly.
532 /// This is used in the `LocalCrateContext` constructor to allow calling
533 /// functions that expect a complete `CrateContext`, even before the local
534 /// portion is fully initialized and attached to the `SharedCrateContext`.
535 fn dummy_ccx<'a>(&'a self, shared: &'a SharedCrateContext<'a, 'tcx>)
536 -> CrateContext<'a, 'tcx> {
545 impl<'b, 'tcx> CrateContext<'b, 'tcx> {
546 pub fn shared(&self) -> &'b SharedCrateContext<'b, 'tcx> {
550 pub fn local(&self) -> &'b LocalCrateContext<'tcx> {
555 /// Get a (possibly) different `CrateContext` from the same
556 /// `SharedCrateContext`.
557 pub fn rotate(&self) -> CrateContext<'b, 'tcx> {
558 self.shared.get_smallest_ccx()
561 /// Either iterate over only `self`, or iterate over all `CrateContext`s in
562 /// the `SharedCrateContext`. The iterator produces `(ccx, is_origin)`
563 /// pairs, where `is_origin` is `true` if `ccx` is `self` and `false`
564 /// otherwise. This method is useful for avoiding code duplication in
565 /// cases where it may or may not be necessary to translate code into every
567 pub fn maybe_iter(&self, iter_all: bool) -> CrateContextMaybeIterator<'b, 'tcx> {
568 CrateContextMaybeIterator {
570 index: if iter_all { 0 } else { self.index },
577 pub fn tcx<'a>(&'a self) -> &'a ty::ctxt<'tcx> {
581 pub fn sess<'a>(&'a self) -> &'a Session {
582 &self.shared.tcx.sess
585 pub fn builder<'a>(&'a self) -> Builder<'a, 'tcx> {
589 pub fn raw_builder<'a>(&'a self) -> BuilderRef {
593 pub fn get_intrinsic(&self, key: &str) -> ValueRef {
594 if let Some(v) = self.intrinsics().borrow().get(key).cloned() {
597 match declare_intrinsic(self, key) {
599 None => panic!("unknown intrinsic '{}'", key)
603 pub fn llmod(&self) -> ModuleRef {
607 pub fn llcx(&self) -> ContextRef {
611 pub fn td(&self) -> llvm::TargetDataRef {
612 unsafe { llvm::LLVMRustGetModuleDataLayout(self.llmod()) }
615 pub fn tn<'a>(&'a self) -> &'a TypeNames {
619 pub fn externs<'a>(&'a self) -> &'a RefCell<ExternMap> {
623 pub fn item_vals<'a>(&'a self) -> &'a RefCell<NodeMap<ValueRef>> {
624 &self.local.item_vals
627 pub fn export_map<'a>(&'a self) -> &'a ExportMap {
628 &self.shared.export_map
631 pub fn reachable<'a>(&'a self) -> &'a NodeSet {
632 &self.shared.reachable
635 pub fn item_symbols<'a>(&'a self) -> &'a RefCell<NodeMap<String>> {
636 &self.shared.item_symbols
639 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
640 &self.shared.link_meta
643 pub fn needs_unwind_cleanup_cache(&self) -> &RefCell<FnvHashMap<Ty<'tcx>, bool>> {
644 &self.local.needs_unwind_cleanup_cache
647 pub fn fn_pointer_shims(&self) -> &RefCell<FnvHashMap<Ty<'tcx>, ValueRef>> {
648 &self.local.fn_pointer_shims
651 pub fn drop_glues<'a>(&'a self) -> &'a RefCell<FnvHashMap<DropGlueKind<'tcx>, ValueRef>> {
652 &self.local.drop_glues
655 pub fn external<'a>(&'a self) -> &'a RefCell<DefIdMap<Option<ast::NodeId>>> {
659 pub fn external_srcs<'a>(&'a self) -> &'a RefCell<NodeMap<DefId>> {
660 &self.local.external_srcs
663 pub fn monomorphized<'a>(&'a self) -> &'a RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>> {
664 &self.local.monomorphized
667 pub fn monomorphizing<'a>(&'a self) -> &'a RefCell<DefIdMap<usize>> {
668 &self.local.monomorphizing
671 pub fn vtables<'a>(&'a self) -> &'a RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>, ValueRef>> {
675 pub fn const_cstr_cache<'a>(&'a self) -> &'a RefCell<FnvHashMap<InternedString, ValueRef>> {
676 &self.local.const_cstr_cache
679 pub fn const_unsized<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
680 &self.local.const_unsized
683 pub fn const_globals<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
684 &self.local.const_globals
687 pub fn const_values<'a>(&'a self) -> &'a RefCell<FnvHashMap<(ast::NodeId, &'tcx Substs<'tcx>),
689 &self.local.const_values
692 pub fn extern_const_values<'a>(&'a self) -> &'a RefCell<DefIdMap<ValueRef>> {
693 &self.local.extern_const_values
696 pub fn impl_method_cache<'a>(&'a self)
697 -> &'a RefCell<FnvHashMap<(DefId, ast::Name), DefId>> {
698 &self.local.impl_method_cache
701 pub fn closure_bare_wrapper_cache<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
702 &self.local.closure_bare_wrapper_cache
705 pub fn statics_to_rauw<'a>(&'a self) -> &'a RefCell<Vec<(ValueRef, ValueRef)>> {
706 &self.local.statics_to_rauw
709 pub fn lltypes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Type>> {
713 pub fn llsizingtypes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Type>> {
714 &self.local.llsizingtypes
717 pub fn adt_reprs<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Rc<adt::Repr<'tcx>>>> {
718 &self.local.adt_reprs
721 pub fn symbol_hasher<'a>(&'a self) -> &'a RefCell<Sha256> {
722 &self.shared.symbol_hasher
725 pub fn type_hashcodes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, String>> {
726 &self.local.type_hashcodes
729 pub fn stats<'a>(&'a self) -> &'a Stats {
733 pub fn available_monomorphizations<'a>(&'a self) -> &'a RefCell<FnvHashSet<String>> {
734 &self.local.available_monomorphizations
737 pub fn available_drop_glues(&self) -> &RefCell<FnvHashMap<DropGlueKind<'tcx>, String>> {
738 &self.shared.available_drop_glues
741 pub fn int_type(&self) -> Type {
745 pub fn opaque_vec_type(&self) -> Type {
746 self.local.opaque_vec_type
749 pub fn closure_vals<'a>(&'a self) -> &'a RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>> {
750 &self.local.closure_vals
753 pub fn dbg_cx<'a>(&'a self) -> &'a Option<debuginfo::CrateDebugContext<'tcx>> {
757 pub fn eh_personality<'a>(&'a self) -> &'a RefCell<Option<ValueRef>> {
758 &self.local.eh_personality
761 pub fn eh_unwind_resume<'a>(&'a self) -> &'a RefCell<Option<ValueRef>> {
762 &self.local.eh_unwind_resume
765 pub fn rust_try_fn<'a>(&'a self) -> &'a RefCell<Option<ValueRef>> {
766 &self.local.rust_try_fn
769 fn intrinsics<'a>(&'a self) -> &'a RefCell<FnvHashMap<&'static str, ValueRef>> {
770 &self.local.intrinsics
773 pub fn count_llvm_insn(&self) {
774 self.local.n_llvm_insns.set(self.local.n_llvm_insns.get() + 1);
777 pub fn trait_cache(&self) -> &RefCell<DepTrackingMap<TraitSelectionCache<'tcx>>> {
778 &self.local.trait_cache
781 /// Return exclusive upper bound on object size.
783 /// The theoretical maximum object size is defined as the maximum positive `int` value. This
784 /// ensures that the `offset` semantics remain well-defined by allowing it to correctly index
785 /// every address within an object along with one byte past the end, along with allowing `int`
786 /// to store the difference between any two pointers into an object.
788 /// The upper bound on 64-bit currently needs to be lower because LLVM uses a 64-bit integer to
789 /// represent object size in bits. It would need to be 1 << 61 to account for this, but is
790 /// currently conservatively bounded to 1 << 47 as that is enough to cover the current usable
791 /// address space on 64-bit ARMv8 and x86_64.
792 pub fn obj_size_bound(&self) -> u64 {
793 match &self.sess().target.target.target_pointer_width[..] {
796 _ => unreachable!() // error handled by config::build_target_config
800 pub fn report_overbig_object(&self, obj: Ty<'tcx>) -> ! {
802 &format!("the type `{:?}` is too big for the current architecture",
806 pub fn enter_type_of(&self, ty: Ty<'tcx>) -> TypeOfDepthLock<'b, 'tcx> {
807 let current_depth = self.local.type_of_depth.get();
808 debug!("enter_type_of({:?}) at depth {:?}", ty, current_depth);
809 if current_depth > self.sess().recursion_limit.get() {
811 &format!("overflow representing the type `{}`", ty))
813 self.local.type_of_depth.set(current_depth + 1);
814 TypeOfDepthLock(self.local)
817 pub fn check_overflow(&self) -> bool {
818 self.shared.check_overflow
821 pub fn check_drop_flag_for_sanity(&self) -> bool {
822 // This controls whether we emit a conditional llvm.debugtrap
823 // guarded on whether the dropflag is one of its (two) valid
825 self.shared.check_drop_flag_for_sanity
828 pub fn use_dll_storage_attrs(&self) -> bool {
829 self.shared.use_dll_storage_attrs()
832 pub fn mir_map(&self) -> &'b MirMap<'tcx> {
836 pub fn translation_items(&self) -> &RefCell<FnvHashMap<TransItem<'tcx>, TransItemState>> {
837 &self.shared.translation_items
840 pub fn record_translation_item_as_generated(&self, cgi: TransItem<'tcx>) {
841 if self.sess().opts.debugging_opts.print_trans_items.is_none() {
845 let mut codegen_items = self.translation_items().borrow_mut();
847 if codegen_items.contains_key(&cgi) {
848 codegen_items.insert(cgi, TransItemState::PredictedAndGenerated);
850 codegen_items.insert(cgi, TransItemState::NotPredictedButGenerated);
855 pub struct TypeOfDepthLock<'a, 'tcx: 'a>(&'a LocalCrateContext<'tcx>);
857 impl<'a, 'tcx> Drop for TypeOfDepthLock<'a, 'tcx> {
859 self.0.type_of_depth.set(self.0.type_of_depth.get() - 1);
863 /// Declare any llvm intrinsics that you might need
864 fn declare_intrinsic(ccx: &CrateContext, key: &str) -> Option<ValueRef> {
866 ($name:expr, fn() -> $ret:expr) => (
868 let f = declare::declare_cfn(ccx, $name, Type::func(&[], &$ret),
870 llvm::SetUnnamedAddr(f, false);
871 ccx.intrinsics().borrow_mut().insert($name, f.clone());
875 ($name:expr, fn($($arg:expr),*) -> $ret:expr) => (
877 let f = declare::declare_cfn(ccx, $name, Type::func(&[$($arg),*], &$ret),
879 llvm::SetUnnamedAddr(f, false);
880 ccx.intrinsics().borrow_mut().insert($name, f.clone());
885 macro_rules! mk_struct {
886 ($($field_ty:expr),*) => (Type::struct_(ccx, &[$($field_ty),*], false))
889 let i8p = Type::i8p(ccx);
890 let void = Type::void(ccx);
891 let i1 = Type::i1(ccx);
892 let t_i8 = Type::i8(ccx);
893 let t_i16 = Type::i16(ccx);
894 let t_i32 = Type::i32(ccx);
895 let t_i64 = Type::i64(ccx);
896 let t_f32 = Type::f32(ccx);
897 let t_f64 = Type::f64(ccx);
899 ifn!("llvm.memcpy.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
900 ifn!("llvm.memcpy.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
901 ifn!("llvm.memcpy.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
902 ifn!("llvm.memmove.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
903 ifn!("llvm.memmove.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
904 ifn!("llvm.memmove.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
905 ifn!("llvm.memset.p0i8.i16", fn(i8p, t_i8, t_i16, t_i32, i1) -> void);
906 ifn!("llvm.memset.p0i8.i32", fn(i8p, t_i8, t_i32, t_i32, i1) -> void);
907 ifn!("llvm.memset.p0i8.i64", fn(i8p, t_i8, t_i64, t_i32, i1) -> void);
909 ifn!("llvm.trap", fn() -> void);
910 ifn!("llvm.debugtrap", fn() -> void);
912 ifn!("llvm.powi.f32", fn(t_f32, t_i32) -> t_f32);
913 ifn!("llvm.powi.f64", fn(t_f64, t_i32) -> t_f64);
914 ifn!("llvm.pow.f32", fn(t_f32, t_f32) -> t_f32);
915 ifn!("llvm.pow.f64", fn(t_f64, t_f64) -> t_f64);
917 ifn!("llvm.sqrt.f32", fn(t_f32) -> t_f32);
918 ifn!("llvm.sqrt.f64", fn(t_f64) -> t_f64);
919 ifn!("llvm.sin.f32", fn(t_f32) -> t_f32);
920 ifn!("llvm.sin.f64", fn(t_f64) -> t_f64);
921 ifn!("llvm.cos.f32", fn(t_f32) -> t_f32);
922 ifn!("llvm.cos.f64", fn(t_f64) -> t_f64);
923 ifn!("llvm.exp.f32", fn(t_f32) -> t_f32);
924 ifn!("llvm.exp.f64", fn(t_f64) -> t_f64);
925 ifn!("llvm.exp2.f32", fn(t_f32) -> t_f32);
926 ifn!("llvm.exp2.f64", fn(t_f64) -> t_f64);
927 ifn!("llvm.log.f32", fn(t_f32) -> t_f32);
928 ifn!("llvm.log.f64", fn(t_f64) -> t_f64);
929 ifn!("llvm.log10.f32", fn(t_f32) -> t_f32);
930 ifn!("llvm.log10.f64", fn(t_f64) -> t_f64);
931 ifn!("llvm.log2.f32", fn(t_f32) -> t_f32);
932 ifn!("llvm.log2.f64", fn(t_f64) -> t_f64);
934 ifn!("llvm.fma.f32", fn(t_f32, t_f32, t_f32) -> t_f32);
935 ifn!("llvm.fma.f64", fn(t_f64, t_f64, t_f64) -> t_f64);
937 ifn!("llvm.fabs.f32", fn(t_f32) -> t_f32);
938 ifn!("llvm.fabs.f64", fn(t_f64) -> t_f64);
940 ifn!("llvm.floor.f32", fn(t_f32) -> t_f32);
941 ifn!("llvm.floor.f64", fn(t_f64) -> t_f64);
942 ifn!("llvm.ceil.f32", fn(t_f32) -> t_f32);
943 ifn!("llvm.ceil.f64", fn(t_f64) -> t_f64);
944 ifn!("llvm.trunc.f32", fn(t_f32) -> t_f32);
945 ifn!("llvm.trunc.f64", fn(t_f64) -> t_f64);
947 ifn!("llvm.copysign.f32", fn(t_f32, t_f32) -> t_f32);
948 ifn!("llvm.copysign.f64", fn(t_f64, t_f64) -> t_f64);
949 ifn!("llvm.round.f32", fn(t_f32) -> t_f32);
950 ifn!("llvm.round.f64", fn(t_f64) -> t_f64);
952 ifn!("llvm.rint.f32", fn(t_f32) -> t_f32);
953 ifn!("llvm.rint.f64", fn(t_f64) -> t_f64);
954 ifn!("llvm.nearbyint.f32", fn(t_f32) -> t_f32);
955 ifn!("llvm.nearbyint.f64", fn(t_f64) -> t_f64);
957 ifn!("llvm.ctpop.i8", fn(t_i8) -> t_i8);
958 ifn!("llvm.ctpop.i16", fn(t_i16) -> t_i16);
959 ifn!("llvm.ctpop.i32", fn(t_i32) -> t_i32);
960 ifn!("llvm.ctpop.i64", fn(t_i64) -> t_i64);
962 ifn!("llvm.ctlz.i8", fn(t_i8 , i1) -> t_i8);
963 ifn!("llvm.ctlz.i16", fn(t_i16, i1) -> t_i16);
964 ifn!("llvm.ctlz.i32", fn(t_i32, i1) -> t_i32);
965 ifn!("llvm.ctlz.i64", fn(t_i64, i1) -> t_i64);
967 ifn!("llvm.cttz.i8", fn(t_i8 , i1) -> t_i8);
968 ifn!("llvm.cttz.i16", fn(t_i16, i1) -> t_i16);
969 ifn!("llvm.cttz.i32", fn(t_i32, i1) -> t_i32);
970 ifn!("llvm.cttz.i64", fn(t_i64, i1) -> t_i64);
972 ifn!("llvm.bswap.i16", fn(t_i16) -> t_i16);
973 ifn!("llvm.bswap.i32", fn(t_i32) -> t_i32);
974 ifn!("llvm.bswap.i64", fn(t_i64) -> t_i64);
976 ifn!("llvm.sadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
977 ifn!("llvm.sadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
978 ifn!("llvm.sadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
979 ifn!("llvm.sadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
981 ifn!("llvm.uadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
982 ifn!("llvm.uadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
983 ifn!("llvm.uadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
984 ifn!("llvm.uadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
986 ifn!("llvm.ssub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
987 ifn!("llvm.ssub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
988 ifn!("llvm.ssub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
989 ifn!("llvm.ssub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
991 ifn!("llvm.usub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
992 ifn!("llvm.usub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
993 ifn!("llvm.usub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
994 ifn!("llvm.usub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
996 ifn!("llvm.smul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
997 ifn!("llvm.smul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
998 ifn!("llvm.smul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
999 ifn!("llvm.smul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1001 ifn!("llvm.umul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1002 ifn!("llvm.umul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1003 ifn!("llvm.umul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1004 ifn!("llvm.umul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1006 ifn!("llvm.lifetime.start", fn(t_i64,i8p) -> void);
1007 ifn!("llvm.lifetime.end", fn(t_i64, i8p) -> void);
1009 ifn!("llvm.expect.i1", fn(i1, i1) -> i1);
1010 ifn!("llvm.eh.typeid.for", fn(i8p) -> t_i32);
1012 // Some intrinsics were introduced in later versions of LLVM, but they have
1013 // fallbacks in libc or libm and such.
1014 macro_rules! compatible_ifn {
1015 ($name:expr, noop($cname:ident ($($arg:expr),*) -> void), $llvm_version:expr) => (
1016 if unsafe { llvm::LLVMVersionMinor() >= $llvm_version } {
1017 // The `if key == $name` is already in ifn!
1018 ifn!($name, fn($($arg),*) -> void);
1019 } else if key == $name {
1020 let f = declare::declare_cfn(ccx, stringify!($cname),
1021 Type::func(&[$($arg),*], &void),
1022 ccx.tcx().mk_nil());
1023 llvm::SetLinkage(f, llvm::InternalLinkage);
1025 let bld = ccx.builder();
1027 llvm::LLVMAppendBasicBlockInContext(ccx.llcx(), f,
1028 "entry-block\0".as_ptr() as *const _)
1031 bld.position_at_end(llbb);
1034 ccx.intrinsics().borrow_mut().insert($name, f.clone());
1038 ($name:expr, $cname:ident ($($arg:expr),*) -> $ret:expr, $llvm_version:expr) => (
1039 if unsafe { llvm::LLVMVersionMinor() >= $llvm_version } {
1040 // The `if key == $name` is already in ifn!
1041 ifn!($name, fn($($arg),*) -> $ret);
1042 } else if key == $name {
1043 let f = declare::declare_cfn(ccx, stringify!($cname),
1044 Type::func(&[$($arg),*], &$ret),
1045 ccx.tcx().mk_nil());
1046 ccx.intrinsics().borrow_mut().insert($name, f.clone());
1052 compatible_ifn!("llvm.assume", noop(llvmcompat_assume(i1) -> void), 6);
1054 if ccx.sess().opts.debuginfo != NoDebugInfo {
1055 ifn!("llvm.dbg.declare", fn(Type::metadata(ccx), Type::metadata(ccx)) -> void);
1056 ifn!("llvm.dbg.value", fn(Type::metadata(ccx), t_i64, Type::metadata(ccx)) -> void);