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 metadata::common::LinkMeta;
14 use middle::def::ExportMap;
15 use middle::def_id::DefId;
19 use trans::builder::Builder;
20 use trans::common::{ExternMap,BuilderRef_res};
23 use trans::glue::DropGlueKind;
24 use trans::monomorphize::MonoId;
25 use trans::type_::{Type, TypeNames};
26 use middle::subst::Substs;
27 use middle::ty::{self, Ty};
28 use session::config::NoDebugInfo;
30 use util::sha2::Sha256;
31 use util::nodemap::{NodeMap, NodeSet, DefIdMap, FnvHashMap, FnvHashSet};
33 use std::ffi::CString;
34 use std::cell::{Cell, RefCell};
38 use syntax::parse::token::InternedString;
41 pub n_glues_created: Cell<usize>,
42 pub n_null_glues: Cell<usize>,
43 pub n_real_glues: Cell<usize>,
44 pub n_fns: Cell<usize>,
45 pub n_monos: Cell<usize>,
46 pub n_inlines: Cell<usize>,
47 pub n_closures: Cell<usize>,
48 pub n_llvm_insns: Cell<usize>,
49 pub llvm_insns: RefCell<FnvHashMap<String, usize>>,
50 // (ident, llvm-instructions)
51 pub fn_stats: RefCell<Vec<(String, usize)> >,
54 /// The shared portion of a `CrateContext`. There is one `SharedCrateContext`
55 /// per crate. The data here is shared between all compilation units of the
56 /// crate, so it must not contain references to any LLVM data structures
57 /// (aside from metadata-related ones).
58 pub struct SharedCrateContext<'a, 'tcx: 'a> {
59 local_ccxs: Vec<LocalCrateContext<'tcx>>,
61 metadata_llmod: ModuleRef,
62 metadata_llcx: ContextRef,
64 export_map: ExportMap,
66 item_symbols: RefCell<NodeMap<String>>,
68 symbol_hasher: RefCell<Sha256>,
69 tcx: &'a ty::ctxt<'tcx>,
72 check_drop_flag_for_sanity: bool,
74 available_drop_glues: RefCell<FnvHashMap<DropGlueKind<'tcx>, String>>,
75 use_dll_storage_attrs: bool,
78 /// The local portion of a `CrateContext`. There is one `LocalCrateContext`
79 /// per compilation unit. Each one has its own LLVM `ContextRef` so that
80 /// several compilation units may be optimized in parallel. All other LLVM
81 /// data structures in the `LocalCrateContext` are tied to that `ContextRef`.
82 pub struct LocalCrateContext<'tcx> {
86 externs: RefCell<ExternMap>,
87 item_vals: RefCell<NodeMap<ValueRef>>,
88 needs_unwind_cleanup_cache: RefCell<FnvHashMap<Ty<'tcx>, bool>>,
89 fn_pointer_shims: RefCell<FnvHashMap<Ty<'tcx>, ValueRef>>,
90 drop_glues: RefCell<FnvHashMap<DropGlueKind<'tcx>, ValueRef>>,
91 /// Track mapping of external ids to local items imported for inlining
92 external: RefCell<DefIdMap<Option<ast::NodeId>>>,
93 /// Backwards version of the `external` map (inlined items to where they
95 external_srcs: RefCell<NodeMap<DefId>>,
96 /// Cache instances of monomorphized functions
97 monomorphized: RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>>,
98 monomorphizing: RefCell<DefIdMap<usize>>,
99 available_monomorphizations: RefCell<FnvHashSet<String>>,
100 /// Cache generated vtables
101 vtables: RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>, ValueRef>>,
102 /// Cache of constant strings,
103 const_cstr_cache: RefCell<FnvHashMap<InternedString, ValueRef>>,
105 /// Reverse-direction for const ptrs cast from globals.
106 /// Key is a ValueRef holding a *T,
107 /// Val is a ValueRef holding a *[T].
109 /// Needed because LLVM loses pointer->pointee association
110 /// when we ptrcast, and we have to ptrcast during translation
111 /// of a [T] const because we form a slice, a (*T,usize) pair, not
112 /// a pointer to an LLVM array type. Similar for trait objects.
113 const_unsized: RefCell<FnvHashMap<ValueRef, ValueRef>>,
115 /// Cache of emitted const globals (value -> global)
116 const_globals: RefCell<FnvHashMap<ValueRef, ValueRef>>,
118 /// Cache of emitted const values
119 const_values: RefCell<FnvHashMap<(ast::NodeId, &'tcx Substs<'tcx>), ValueRef>>,
121 /// Cache of external const values
122 extern_const_values: RefCell<DefIdMap<ValueRef>>,
124 impl_method_cache: RefCell<FnvHashMap<(DefId, ast::Name), DefId>>,
126 /// Cache of closure wrappers for bare fn's.
127 closure_bare_wrapper_cache: RefCell<FnvHashMap<ValueRef, ValueRef>>,
129 /// List of globals for static variables which need to be passed to the
130 /// LLVM function ReplaceAllUsesWith (RAUW) when translation is complete.
131 /// (We have to make sure we don't invalidate any ValueRefs referring
133 statics_to_rauw: RefCell<Vec<(ValueRef, ValueRef)>>,
135 lltypes: RefCell<FnvHashMap<Ty<'tcx>, Type>>,
136 llsizingtypes: RefCell<FnvHashMap<Ty<'tcx>, Type>>,
137 adt_reprs: RefCell<FnvHashMap<Ty<'tcx>, Rc<adt::Repr<'tcx>>>>,
138 type_hashcodes: RefCell<FnvHashMap<Ty<'tcx>, String>>,
140 opaque_vec_type: Type,
141 builder: BuilderRef_res,
143 /// Holds the LLVM values for closure IDs.
144 closure_vals: RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>>,
146 dbg_cx: Option<debuginfo::CrateDebugContext<'tcx>>,
148 eh_personality: RefCell<Option<ValueRef>>,
149 rust_try_fn: RefCell<Option<ValueRef>>,
150 unwind_resume_hooked: Cell<bool>,
152 intrinsics: RefCell<FnvHashMap<&'static str, ValueRef>>,
154 /// Number of LLVM instructions translated into this `LocalCrateContext`.
155 /// This is used to perform some basic load-balancing to keep all LLVM
156 /// contexts around the same size.
157 n_llvm_insns: Cell<usize>,
159 trait_cache: RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>,
160 traits::Vtable<'tcx, ()>>>,
163 pub struct CrateContext<'a, 'tcx: 'a> {
164 shared: &'a SharedCrateContext<'a, 'tcx>,
165 local: &'a LocalCrateContext<'tcx>,
166 /// The index of `local` in `shared.local_ccxs`. This is used in
167 /// `maybe_iter(true)` to identify the original `LocalCrateContext`.
171 pub struct CrateContextIterator<'a, 'tcx: 'a> {
172 shared: &'a SharedCrateContext<'a, 'tcx>,
176 impl<'a, 'tcx> Iterator for CrateContextIterator<'a,'tcx> {
177 type Item = CrateContext<'a, 'tcx>;
179 fn next(&mut self) -> Option<CrateContext<'a, 'tcx>> {
180 if self.index >= self.shared.local_ccxs.len() {
184 let index = self.index;
189 local: &self.shared.local_ccxs[index],
195 /// The iterator produced by `CrateContext::maybe_iter`.
196 pub struct CrateContextMaybeIterator<'a, 'tcx: 'a> {
197 shared: &'a SharedCrateContext<'a, 'tcx>,
203 impl<'a, 'tcx> Iterator for CrateContextMaybeIterator<'a, 'tcx> {
204 type Item = (CrateContext<'a, 'tcx>, bool);
206 fn next(&mut self) -> Option<(CrateContext<'a, 'tcx>, bool)> {
207 if self.index >= self.shared.local_ccxs.len() {
211 let index = self.index;
214 self.index = self.shared.local_ccxs.len();
217 let ccx = CrateContext {
219 local: &self.shared.local_ccxs[index],
222 Some((ccx, index == self.origin))
227 unsafe fn create_context_and_module(sess: &Session, mod_name: &str) -> (ContextRef, ModuleRef) {
228 let llcx = llvm::LLVMContextCreate();
229 let mod_name = CString::new(mod_name).unwrap();
230 let llmod = llvm::LLVMModuleCreateWithNameInContext(mod_name.as_ptr(), llcx);
232 if let Some(ref custom_data_layout) = sess.target.target.options.data_layout {
233 let data_layout = CString::new(&custom_data_layout[..]).unwrap();
234 llvm::LLVMSetDataLayout(llmod, data_layout.as_ptr());
236 let tm = ::back::write::create_target_machine(sess);
237 llvm::LLVMRustSetDataLayoutFromTargetMachine(llmod, tm);
238 llvm::LLVMRustDisposeTargetMachine(tm);
241 let llvm_target = sess.target.target.llvm_target.as_bytes();
242 let llvm_target = CString::new(llvm_target).unwrap();
243 llvm::LLVMRustSetNormalizedTarget(llmod, llvm_target.as_ptr());
247 impl<'b, 'tcx> SharedCrateContext<'b, 'tcx> {
248 pub fn new(crate_name: &str,
250 tcx: &'b ty::ctxt<'tcx>,
251 export_map: ExportMap,
252 symbol_hasher: Sha256,
255 check_overflow: bool,
256 check_drop_flag_for_sanity: bool)
257 -> SharedCrateContext<'b, 'tcx> {
258 let (metadata_llcx, metadata_llmod) = unsafe {
259 create_context_and_module(&tcx.sess, "metadata")
262 // An interesting part of Windows which MSVC forces our hand on (and
263 // apparently MinGW didn't) is the usage of `dllimport` and `dllexport`
264 // attributes in LLVM IR as well as native dependencies (in C these
265 // correspond to `__declspec(dllimport)`).
267 // Whenever a dynamic library is built by MSVC it must have its public
268 // interface specified by functions tagged with `dllexport` or otherwise
269 // they're not available to be linked against. This poses a few problems
270 // for the compiler, some of which are somewhat fundamental, but we use
271 // the `use_dll_storage_attrs` variable below to attach the `dllexport`
272 // attribute to all LLVM functions that are reachable (e.g. they're
273 // already tagged with external linkage). This is suboptimal for a few
276 // * If an object file will never be included in a dynamic library,
277 // there's no need to attach the dllexport attribute. Most object
278 // files in Rust are not destined to become part of a dll as binaries
279 // are statically linked by default.
280 // * If the compiler is emitting both an rlib and a dylib, the same
281 // source object file is currently used but with MSVC this may be less
282 // feasible. The compiler may be able to get around this, but it may
283 // involve some invasive changes to deal with this.
285 // The flipside of this situation is that whenever you link to a dll and
286 // you import a function from it, the import should be tagged with
287 // `dllimport`. At this time, however, the compiler does not emit
288 // `dllimport` for any declarations other than constants (where it is
289 // required), which is again suboptimal for even more reasons!
291 // * Calling a function imported from another dll without using
292 // `dllimport` causes the linker/compiler to have extra overhead (one
293 // `jmp` instruction on x86) when calling the function.
294 // * The same object file may be used in different circumstances, so a
295 // function may be imported from a dll if the object is linked into a
296 // dll, but it may be just linked against if linked into an rlib.
297 // * The compiler has no knowledge about whether native functions should
298 // be tagged dllimport or not.
300 // For now the compiler takes the perf hit (I do not have any numbers to
301 // this effect) by marking very little as `dllimport` and praying the
302 // linker will take care of everything. Fixing this problem will likely
303 // require adding a few attributes to Rust itself (feature gated at the
304 // start) and then strongly recommending static linkage on MSVC!
305 let use_dll_storage_attrs = tcx.sess.target.target.options.is_like_msvc;
307 let mut shared_ccx = SharedCrateContext {
308 local_ccxs: Vec::with_capacity(local_count),
309 metadata_llmod: metadata_llmod,
310 metadata_llcx: metadata_llcx,
311 export_map: export_map,
312 reachable: reachable,
313 item_symbols: RefCell::new(NodeMap()),
314 link_meta: link_meta,
315 symbol_hasher: RefCell::new(symbol_hasher),
318 n_glues_created: Cell::new(0),
319 n_null_glues: Cell::new(0),
320 n_real_glues: Cell::new(0),
322 n_monos: Cell::new(0),
323 n_inlines: Cell::new(0),
324 n_closures: Cell::new(0),
325 n_llvm_insns: Cell::new(0),
326 llvm_insns: RefCell::new(FnvHashMap()),
327 fn_stats: RefCell::new(Vec::new()),
329 check_overflow: check_overflow,
330 check_drop_flag_for_sanity: check_drop_flag_for_sanity,
331 available_drop_glues: RefCell::new(FnvHashMap()),
332 use_dll_storage_attrs: use_dll_storage_attrs,
335 for i in 0..local_count {
336 // Append ".rs" to crate name as LLVM module identifier.
338 // LLVM code generator emits a ".file filename" directive
339 // for ELF backends. Value of the "filename" is set as the
340 // LLVM module identifier. Due to a LLVM MC bug[1], LLVM
341 // crashes if the module identifier is same as other symbols
342 // such as a function name in the module.
343 // 1. http://llvm.org/bugs/show_bug.cgi?id=11479
344 let llmod_id = format!("{}.{}.rs", crate_name, i);
345 let local_ccx = LocalCrateContext::new(&shared_ccx, &llmod_id[..]);
346 shared_ccx.local_ccxs.push(local_ccx);
352 pub fn iter<'a>(&'a self) -> CrateContextIterator<'a, 'tcx> {
353 CrateContextIterator {
359 pub fn get_ccx<'a>(&'a self, index: usize) -> CrateContext<'a, 'tcx> {
362 local: &self.local_ccxs[index],
367 fn get_smallest_ccx<'a>(&'a self) -> CrateContext<'a, 'tcx> {
368 let (local_ccx, index) =
371 .zip(0..self.local_ccxs.len())
372 .min_by(|&(local_ccx, _idx)| local_ccx.n_llvm_insns.get())
382 pub fn metadata_llmod(&self) -> ModuleRef {
386 pub fn metadata_llcx(&self) -> ContextRef {
390 pub fn export_map<'a>(&'a self) -> &'a ExportMap {
394 pub fn reachable<'a>(&'a self) -> &'a NodeSet {
398 pub fn item_symbols<'a>(&'a self) -> &'a RefCell<NodeMap<String>> {
402 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
406 pub fn tcx<'a>(&'a self) -> &'a ty::ctxt<'tcx> {
410 pub fn sess<'a>(&'a self) -> &'a Session {
414 pub fn stats<'a>(&'a self) -> &'a Stats {
418 pub fn use_dll_storage_attrs(&self) -> bool {
419 self.use_dll_storage_attrs
423 impl<'tcx> LocalCrateContext<'tcx> {
424 fn new<'a>(shared: &SharedCrateContext<'a, 'tcx>,
426 -> LocalCrateContext<'tcx> {
428 let (llcx, llmod) = create_context_and_module(&shared.tcx.sess, name);
430 let dbg_cx = if shared.tcx.sess.opts.debuginfo != NoDebugInfo {
431 Some(debuginfo::CrateDebugContext::new(llmod))
436 let mut local_ccx = LocalCrateContext {
439 tn: TypeNames::new(),
440 externs: RefCell::new(FnvHashMap()),
441 item_vals: RefCell::new(NodeMap()),
442 needs_unwind_cleanup_cache: RefCell::new(FnvHashMap()),
443 fn_pointer_shims: RefCell::new(FnvHashMap()),
444 drop_glues: RefCell::new(FnvHashMap()),
445 external: RefCell::new(DefIdMap()),
446 external_srcs: RefCell::new(NodeMap()),
447 monomorphized: RefCell::new(FnvHashMap()),
448 monomorphizing: RefCell::new(DefIdMap()),
449 available_monomorphizations: RefCell::new(FnvHashSet()),
450 vtables: RefCell::new(FnvHashMap()),
451 const_cstr_cache: RefCell::new(FnvHashMap()),
452 const_unsized: RefCell::new(FnvHashMap()),
453 const_globals: RefCell::new(FnvHashMap()),
454 const_values: RefCell::new(FnvHashMap()),
455 extern_const_values: RefCell::new(DefIdMap()),
456 impl_method_cache: RefCell::new(FnvHashMap()),
457 closure_bare_wrapper_cache: RefCell::new(FnvHashMap()),
458 statics_to_rauw: RefCell::new(Vec::new()),
459 lltypes: RefCell::new(FnvHashMap()),
460 llsizingtypes: RefCell::new(FnvHashMap()),
461 adt_reprs: RefCell::new(FnvHashMap()),
462 type_hashcodes: RefCell::new(FnvHashMap()),
463 int_type: Type::from_ref(ptr::null_mut()),
464 opaque_vec_type: Type::from_ref(ptr::null_mut()),
465 builder: BuilderRef_res(llvm::LLVMCreateBuilderInContext(llcx)),
466 closure_vals: RefCell::new(FnvHashMap()),
468 eh_personality: RefCell::new(None),
469 rust_try_fn: RefCell::new(None),
470 unwind_resume_hooked: Cell::new(false),
471 intrinsics: RefCell::new(FnvHashMap()),
472 n_llvm_insns: Cell::new(0),
473 trait_cache: RefCell::new(FnvHashMap()),
476 local_ccx.int_type = Type::int(&local_ccx.dummy_ccx(shared));
477 local_ccx.opaque_vec_type = Type::opaque_vec(&local_ccx.dummy_ccx(shared));
479 // Done mutating local_ccx directly. (The rest of the
480 // initialization goes through RefCell.)
482 let ccx = local_ccx.dummy_ccx(shared);
484 let mut str_slice_ty = Type::named_struct(&ccx, "str_slice");
485 str_slice_ty.set_struct_body(&[Type::i8p(&ccx), ccx.int_type()], false);
486 ccx.tn().associate_type("str_slice", &str_slice_ty);
488 if ccx.sess().count_llvm_insns() {
489 base::init_insn_ctxt()
497 /// Create a dummy `CrateContext` from `self` and the provided
498 /// `SharedCrateContext`. This is somewhat dangerous because `self` may
499 /// not actually be an element of `shared.local_ccxs`, which can cause some
500 /// operations to panic unexpectedly.
502 /// This is used in the `LocalCrateContext` constructor to allow calling
503 /// functions that expect a complete `CrateContext`, even before the local
504 /// portion is fully initialized and attached to the `SharedCrateContext`.
505 fn dummy_ccx<'a>(&'a self, shared: &'a SharedCrateContext<'a, 'tcx>)
506 -> CrateContext<'a, 'tcx> {
515 impl<'b, 'tcx> CrateContext<'b, 'tcx> {
516 pub fn shared(&self) -> &'b SharedCrateContext<'b, 'tcx> {
520 pub fn local(&self) -> &'b LocalCrateContext<'tcx> {
525 /// Get a (possibly) different `CrateContext` from the same
526 /// `SharedCrateContext`.
527 pub fn rotate(&self) -> CrateContext<'b, 'tcx> {
528 self.shared.get_smallest_ccx()
531 /// Either iterate over only `self`, or iterate over all `CrateContext`s in
532 /// the `SharedCrateContext`. The iterator produces `(ccx, is_origin)`
533 /// pairs, where `is_origin` is `true` if `ccx` is `self` and `false`
534 /// otherwise. This method is useful for avoiding code duplication in
535 /// cases where it may or may not be necessary to translate code into every
537 pub fn maybe_iter(&self, iter_all: bool) -> CrateContextMaybeIterator<'b, 'tcx> {
538 CrateContextMaybeIterator {
540 index: if iter_all { 0 } else { self.index },
547 pub fn tcx<'a>(&'a self) -> &'a ty::ctxt<'tcx> {
551 pub fn sess<'a>(&'a self) -> &'a Session {
552 &self.shared.tcx.sess
555 pub fn builder<'a>(&'a self) -> Builder<'a, 'tcx> {
559 pub fn raw_builder<'a>(&'a self) -> BuilderRef {
563 pub fn get_intrinsic(&self, key: &str) -> ValueRef {
564 if let Some(v) = self.intrinsics().borrow().get(key).cloned() {
567 match declare_intrinsic(self, key) {
569 None => panic!("unknown intrinsic '{}'", key)
573 pub fn llmod(&self) -> ModuleRef {
577 pub fn llcx(&self) -> ContextRef {
581 pub fn td(&self) -> llvm::TargetDataRef {
582 unsafe { llvm::LLVMRustGetModuleDataLayout(self.llmod()) }
585 pub fn tn<'a>(&'a self) -> &'a TypeNames {
589 pub fn externs<'a>(&'a self) -> &'a RefCell<ExternMap> {
593 pub fn item_vals<'a>(&'a self) -> &'a RefCell<NodeMap<ValueRef>> {
594 &self.local.item_vals
597 pub fn export_map<'a>(&'a self) -> &'a ExportMap {
598 &self.shared.export_map
601 pub fn reachable<'a>(&'a self) -> &'a NodeSet {
602 &self.shared.reachable
605 pub fn item_symbols<'a>(&'a self) -> &'a RefCell<NodeMap<String>> {
606 &self.shared.item_symbols
609 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
610 &self.shared.link_meta
613 pub fn needs_unwind_cleanup_cache(&self) -> &RefCell<FnvHashMap<Ty<'tcx>, bool>> {
614 &self.local.needs_unwind_cleanup_cache
617 pub fn fn_pointer_shims(&self) -> &RefCell<FnvHashMap<Ty<'tcx>, ValueRef>> {
618 &self.local.fn_pointer_shims
621 pub fn drop_glues<'a>(&'a self) -> &'a RefCell<FnvHashMap<DropGlueKind<'tcx>, ValueRef>> {
622 &self.local.drop_glues
625 pub fn external<'a>(&'a self) -> &'a RefCell<DefIdMap<Option<ast::NodeId>>> {
629 pub fn external_srcs<'a>(&'a self) -> &'a RefCell<NodeMap<DefId>> {
630 &self.local.external_srcs
633 pub fn monomorphized<'a>(&'a self) -> &'a RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>> {
634 &self.local.monomorphized
637 pub fn monomorphizing<'a>(&'a self) -> &'a RefCell<DefIdMap<usize>> {
638 &self.local.monomorphizing
641 pub fn vtables<'a>(&'a self) -> &'a RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>, ValueRef>> {
645 pub fn const_cstr_cache<'a>(&'a self) -> &'a RefCell<FnvHashMap<InternedString, ValueRef>> {
646 &self.local.const_cstr_cache
649 pub fn const_unsized<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
650 &self.local.const_unsized
653 pub fn const_globals<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
654 &self.local.const_globals
657 pub fn const_values<'a>(&'a self) -> &'a RefCell<FnvHashMap<(ast::NodeId, &'tcx Substs<'tcx>),
659 &self.local.const_values
662 pub fn extern_const_values<'a>(&'a self) -> &'a RefCell<DefIdMap<ValueRef>> {
663 &self.local.extern_const_values
666 pub fn impl_method_cache<'a>(&'a self)
667 -> &'a RefCell<FnvHashMap<(DefId, ast::Name), DefId>> {
668 &self.local.impl_method_cache
671 pub fn closure_bare_wrapper_cache<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
672 &self.local.closure_bare_wrapper_cache
675 pub fn statics_to_rauw<'a>(&'a self) -> &'a RefCell<Vec<(ValueRef, ValueRef)>> {
676 &self.local.statics_to_rauw
679 pub fn lltypes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Type>> {
683 pub fn llsizingtypes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Type>> {
684 &self.local.llsizingtypes
687 pub fn adt_reprs<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Rc<adt::Repr<'tcx>>>> {
688 &self.local.adt_reprs
691 pub fn symbol_hasher<'a>(&'a self) -> &'a RefCell<Sha256> {
692 &self.shared.symbol_hasher
695 pub fn type_hashcodes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, String>> {
696 &self.local.type_hashcodes
699 pub fn stats<'a>(&'a self) -> &'a Stats {
703 pub fn available_monomorphizations<'a>(&'a self) -> &'a RefCell<FnvHashSet<String>> {
704 &self.local.available_monomorphizations
707 pub fn available_drop_glues(&self) -> &RefCell<FnvHashMap<DropGlueKind<'tcx>, String>> {
708 &self.shared.available_drop_glues
711 pub fn int_type(&self) -> Type {
715 pub fn opaque_vec_type(&self) -> Type {
716 self.local.opaque_vec_type
719 pub fn closure_vals<'a>(&'a self) -> &'a RefCell<FnvHashMap<MonoId<'tcx>, ValueRef>> {
720 &self.local.closure_vals
723 pub fn dbg_cx<'a>(&'a self) -> &'a Option<debuginfo::CrateDebugContext<'tcx>> {
727 pub fn eh_personality<'a>(&'a self) -> &'a RefCell<Option<ValueRef>> {
728 &self.local.eh_personality
731 pub fn rust_try_fn<'a>(&'a self) -> &'a RefCell<Option<ValueRef>> {
732 &self.local.rust_try_fn
735 pub fn unwind_resume_hooked<'a>(&'a self) -> &'a Cell<bool> {
736 &self.local.unwind_resume_hooked
739 fn intrinsics<'a>(&'a self) -> &'a RefCell<FnvHashMap<&'static str, ValueRef>> {
740 &self.local.intrinsics
743 pub fn count_llvm_insn(&self) {
744 self.local.n_llvm_insns.set(self.local.n_llvm_insns.get() + 1);
747 pub fn trait_cache(&self) -> &RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>,
748 traits::Vtable<'tcx, ()>>> {
749 &self.local.trait_cache
752 /// Return exclusive upper bound on object size.
754 /// The theoretical maximum object size is defined as the maximum positive `int` value. This
755 /// ensures that the `offset` semantics remain well-defined by allowing it to correctly index
756 /// every address within an object along with one byte past the end, along with allowing `int`
757 /// to store the difference between any two pointers into an object.
759 /// The upper bound on 64-bit currently needs to be lower because LLVM uses a 64-bit integer to
760 /// represent object size in bits. It would need to be 1 << 61 to account for this, but is
761 /// currently conservatively bounded to 1 << 47 as that is enough to cover the current usable
762 /// address space on 64-bit ARMv8 and x86_64.
763 pub fn obj_size_bound(&self) -> u64 {
764 match &self.sess().target.target.target_pointer_width[..] {
767 _ => unreachable!() // error handled by config::build_target_config
771 pub fn report_overbig_object(&self, obj: Ty<'tcx>) -> ! {
773 &format!("the type `{:?}` is too big for the current architecture",
777 pub fn check_overflow(&self) -> bool {
778 self.shared.check_overflow
781 pub fn check_drop_flag_for_sanity(&self) -> bool {
782 // This controls whether we emit a conditional llvm.debugtrap
783 // guarded on whether the dropflag is one of its (two) valid
785 self.shared.check_drop_flag_for_sanity
788 pub fn use_dll_storage_attrs(&self) -> bool {
789 self.shared.use_dll_storage_attrs()
793 /// Declare any llvm intrinsics that you might need
794 fn declare_intrinsic(ccx: &CrateContext, key: &str) -> Option<ValueRef> {
796 ($name:expr, fn() -> $ret:expr) => (
798 let f = declare::declare_cfn(ccx, $name, Type::func(&[], &$ret),
800 llvm::SetUnnamedAddr(f, false);
801 ccx.intrinsics().borrow_mut().insert($name, f.clone());
805 ($name:expr, fn($($arg:expr),*) -> $ret:expr) => (
807 let f = declare::declare_cfn(ccx, $name, Type::func(&[$($arg),*], &$ret),
809 llvm::SetUnnamedAddr(f, false);
810 ccx.intrinsics().borrow_mut().insert($name, f.clone());
815 macro_rules! mk_struct {
816 ($($field_ty:expr),*) => (Type::struct_(ccx, &[$($field_ty),*], false))
819 let i8p = Type::i8p(ccx);
820 let void = Type::void(ccx);
821 let i1 = Type::i1(ccx);
822 let t_i8 = Type::i8(ccx);
823 let t_i16 = Type::i16(ccx);
824 let t_i32 = Type::i32(ccx);
825 let t_i64 = Type::i64(ccx);
826 let t_f32 = Type::f32(ccx);
827 let t_f64 = Type::f64(ccx);
829 ifn!("llvm.memcpy.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
830 ifn!("llvm.memcpy.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
831 ifn!("llvm.memcpy.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
832 ifn!("llvm.memmove.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
833 ifn!("llvm.memmove.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
834 ifn!("llvm.memmove.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
835 ifn!("llvm.memset.p0i8.i16", fn(i8p, t_i8, t_i16, t_i32, i1) -> void);
836 ifn!("llvm.memset.p0i8.i32", fn(i8p, t_i8, t_i32, t_i32, i1) -> void);
837 ifn!("llvm.memset.p0i8.i64", fn(i8p, t_i8, t_i64, t_i32, i1) -> void);
839 ifn!("llvm.trap", fn() -> void);
840 ifn!("llvm.debugtrap", fn() -> void);
842 ifn!("llvm.powi.f32", fn(t_f32, t_i32) -> t_f32);
843 ifn!("llvm.powi.f64", fn(t_f64, t_i32) -> t_f64);
844 ifn!("llvm.pow.f32", fn(t_f32, t_f32) -> t_f32);
845 ifn!("llvm.pow.f64", fn(t_f64, t_f64) -> t_f64);
847 ifn!("llvm.sqrt.f32", fn(t_f32) -> t_f32);
848 ifn!("llvm.sqrt.f64", fn(t_f64) -> t_f64);
849 ifn!("llvm.sin.f32", fn(t_f32) -> t_f32);
850 ifn!("llvm.sin.f64", fn(t_f64) -> t_f64);
851 ifn!("llvm.cos.f32", fn(t_f32) -> t_f32);
852 ifn!("llvm.cos.f64", fn(t_f64) -> t_f64);
853 ifn!("llvm.exp.f32", fn(t_f32) -> t_f32);
854 ifn!("llvm.exp.f64", fn(t_f64) -> t_f64);
855 ifn!("llvm.exp2.f32", fn(t_f32) -> t_f32);
856 ifn!("llvm.exp2.f64", fn(t_f64) -> t_f64);
857 ifn!("llvm.log.f32", fn(t_f32) -> t_f32);
858 ifn!("llvm.log.f64", fn(t_f64) -> t_f64);
859 ifn!("llvm.log10.f32", fn(t_f32) -> t_f32);
860 ifn!("llvm.log10.f64", fn(t_f64) -> t_f64);
861 ifn!("llvm.log2.f32", fn(t_f32) -> t_f32);
862 ifn!("llvm.log2.f64", fn(t_f64) -> t_f64);
864 ifn!("llvm.fma.f32", fn(t_f32, t_f32, t_f32) -> t_f32);
865 ifn!("llvm.fma.f64", fn(t_f64, t_f64, t_f64) -> t_f64);
867 ifn!("llvm.fabs.f32", fn(t_f32) -> t_f32);
868 ifn!("llvm.fabs.f64", fn(t_f64) -> t_f64);
870 ifn!("llvm.floor.f32", fn(t_f32) -> t_f32);
871 ifn!("llvm.floor.f64", fn(t_f64) -> t_f64);
872 ifn!("llvm.ceil.f32", fn(t_f32) -> t_f32);
873 ifn!("llvm.ceil.f64", fn(t_f64) -> t_f64);
874 ifn!("llvm.trunc.f32", fn(t_f32) -> t_f32);
875 ifn!("llvm.trunc.f64", fn(t_f64) -> t_f64);
877 ifn!("llvm.copysign.f32", fn(t_f32, t_f32) -> t_f32);
878 ifn!("llvm.copysign.f64", fn(t_f64, t_f64) -> t_f64);
879 ifn!("llvm.round.f32", fn(t_f32) -> t_f32);
880 ifn!("llvm.round.f64", fn(t_f64) -> t_f64);
882 ifn!("llvm.rint.f32", fn(t_f32) -> t_f32);
883 ifn!("llvm.rint.f64", fn(t_f64) -> t_f64);
884 ifn!("llvm.nearbyint.f32", fn(t_f32) -> t_f32);
885 ifn!("llvm.nearbyint.f64", fn(t_f64) -> t_f64);
887 ifn!("llvm.ctpop.i8", fn(t_i8) -> t_i8);
888 ifn!("llvm.ctpop.i16", fn(t_i16) -> t_i16);
889 ifn!("llvm.ctpop.i32", fn(t_i32) -> t_i32);
890 ifn!("llvm.ctpop.i64", fn(t_i64) -> t_i64);
892 ifn!("llvm.ctlz.i8", fn(t_i8 , i1) -> t_i8);
893 ifn!("llvm.ctlz.i16", fn(t_i16, i1) -> t_i16);
894 ifn!("llvm.ctlz.i32", fn(t_i32, i1) -> t_i32);
895 ifn!("llvm.ctlz.i64", fn(t_i64, i1) -> t_i64);
897 ifn!("llvm.cttz.i8", fn(t_i8 , i1) -> t_i8);
898 ifn!("llvm.cttz.i16", fn(t_i16, i1) -> t_i16);
899 ifn!("llvm.cttz.i32", fn(t_i32, i1) -> t_i32);
900 ifn!("llvm.cttz.i64", fn(t_i64, i1) -> t_i64);
902 ifn!("llvm.bswap.i16", fn(t_i16) -> t_i16);
903 ifn!("llvm.bswap.i32", fn(t_i32) -> t_i32);
904 ifn!("llvm.bswap.i64", fn(t_i64) -> t_i64);
906 ifn!("llvm.sadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
907 ifn!("llvm.sadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
908 ifn!("llvm.sadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
909 ifn!("llvm.sadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
911 ifn!("llvm.uadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
912 ifn!("llvm.uadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
913 ifn!("llvm.uadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
914 ifn!("llvm.uadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
916 ifn!("llvm.ssub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
917 ifn!("llvm.ssub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
918 ifn!("llvm.ssub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
919 ifn!("llvm.ssub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
921 ifn!("llvm.usub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
922 ifn!("llvm.usub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
923 ifn!("llvm.usub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
924 ifn!("llvm.usub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
926 ifn!("llvm.smul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
927 ifn!("llvm.smul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
928 ifn!("llvm.smul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
929 ifn!("llvm.smul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
931 ifn!("llvm.umul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
932 ifn!("llvm.umul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
933 ifn!("llvm.umul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
934 ifn!("llvm.umul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
936 ifn!("llvm.lifetime.start", fn(t_i64,i8p) -> void);
937 ifn!("llvm.lifetime.end", fn(t_i64, i8p) -> void);
939 ifn!("llvm.expect.i1", fn(i1, i1) -> i1);
940 ifn!("llvm.eh.typeid.for", fn(i8p) -> t_i32);
942 // Some intrinsics were introduced in later versions of LLVM, but they have
943 // fallbacks in libc or libm and such.
944 macro_rules! compatible_ifn {
945 ($name:expr, noop($cname:ident ($($arg:expr),*) -> void), $llvm_version:expr) => (
946 if unsafe { llvm::LLVMVersionMinor() >= $llvm_version } {
947 // The `if key == $name` is already in ifn!
948 ifn!($name, fn($($arg),*) -> void);
949 } else if key == $name {
950 let f = declare::declare_cfn(ccx, stringify!($cname),
951 Type::func(&[$($arg),*], &void),
953 llvm::SetLinkage(f, llvm::InternalLinkage);
955 let bld = ccx.builder();
957 llvm::LLVMAppendBasicBlockInContext(ccx.llcx(), f,
958 "entry-block\0".as_ptr() as *const _)
961 bld.position_at_end(llbb);
964 ccx.intrinsics().borrow_mut().insert($name, f.clone());
968 ($name:expr, $cname:ident ($($arg:expr),*) -> $ret:expr, $llvm_version:expr) => (
969 if unsafe { llvm::LLVMVersionMinor() >= $llvm_version } {
970 // The `if key == $name` is already in ifn!
971 ifn!($name, fn($($arg),*) -> $ret);
972 } else if key == $name {
973 let f = declare::declare_cfn(ccx, stringify!($cname),
974 Type::func(&[$($arg),*], &$ret),
976 ccx.intrinsics().borrow_mut().insert($name, f.clone());
982 compatible_ifn!("llvm.assume", noop(llvmcompat_assume(i1) -> void), 6);
984 if ccx.sess().opts.debuginfo != NoDebugInfo {
985 ifn!("llvm.dbg.declare", fn(Type::metadata(ccx), Type::metadata(ccx)) -> void);
986 ifn!("llvm.dbg.value", fn(Type::metadata(ccx), t_i64, Type::metadata(ccx)) -> void);