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 rustc::hir::def::ExportMap;
16 use rustc::hir::def_id::DefId;
18 use rustc::mir::mir_map::MirMap;
19 use rustc::mir::repr as mir;
23 use common::BuilderRef_res;
26 use glue::DropGlueKind;
28 use monomorphize::Instance;
30 use partitioning::CodegenUnit;
31 use collector::TransItemState;
32 use trans_item::TransItem;
33 use type_::{Type, TypeNames};
34 use rustc::ty::subst::{Substs, VecPerParamSpace};
35 use rustc::ty::{self, Ty, TyCtxt};
36 use session::config::NoDebugInfo;
38 use util::sha2::Sha256;
39 use util::nodemap::{NodeMap, NodeSet, DefIdMap, FnvHashMap, FnvHashSet};
41 use std::ffi::{CStr, CString};
42 use std::cell::{Cell, RefCell};
43 use std::marker::PhantomData;
48 use syntax::parse::token::InternedString;
51 pub n_glues_created: Cell<usize>,
52 pub n_null_glues: Cell<usize>,
53 pub n_real_glues: Cell<usize>,
54 pub n_fns: Cell<usize>,
55 pub n_monos: Cell<usize>,
56 pub n_inlines: Cell<usize>,
57 pub n_closures: Cell<usize>,
58 pub n_llvm_insns: Cell<usize>,
59 pub llvm_insns: RefCell<FnvHashMap<String, usize>>,
60 // (ident, llvm-instructions)
61 pub fn_stats: RefCell<Vec<(String, usize)> >,
64 /// The shared portion of a `CrateContext`. There is one `SharedCrateContext`
65 /// per crate. The data here is shared between all compilation units of the
66 /// crate, so it must not contain references to any LLVM data structures
67 /// (aside from metadata-related ones).
68 pub struct SharedCrateContext<'a, 'tcx: 'a> {
69 metadata_llmod: ModuleRef,
70 metadata_llcx: ContextRef,
72 export_map: ExportMap,
75 symbol_hasher: RefCell<Sha256>,
76 tcx: TyCtxt<'a, 'tcx, 'tcx>,
79 check_drop_flag_for_sanity: bool,
80 mir_map: &'a MirMap<'tcx>,
81 mir_cache: RefCell<DefIdMap<Rc<mir::Mir<'tcx>>>>,
83 available_monomorphizations: RefCell<FnvHashSet<String>>,
84 available_drop_glues: RefCell<FnvHashMap<DropGlueKind<'tcx>, String>>,
85 use_dll_storage_attrs: bool,
87 translation_items: RefCell<FnvHashMap<TransItem<'tcx>, TransItemState>>,
88 trait_cache: RefCell<DepTrackingMap<TraitSelectionCache<'tcx>>>,
91 /// The local portion of a `CrateContext`. There is one `LocalCrateContext`
92 /// per compilation unit. Each one has its own LLVM `ContextRef` so that
93 /// several compilation units may be optimized in parallel. All other LLVM
94 /// data structures in the `LocalCrateContext` are tied to that `ContextRef`.
95 pub struct LocalCrateContext<'tcx> {
98 tn: TypeNames, // FIXME: This seems to be largely unused.
99 codegen_unit: CodegenUnit<'tcx>,
100 needs_unwind_cleanup_cache: RefCell<FnvHashMap<Ty<'tcx>, bool>>,
101 fn_pointer_shims: RefCell<FnvHashMap<Ty<'tcx>, ValueRef>>,
102 drop_glues: RefCell<FnvHashMap<DropGlueKind<'tcx>, ValueRef>>,
103 /// Track mapping of external ids to local items imported for inlining
104 external: RefCell<DefIdMap<Option<ast::NodeId>>>,
105 /// Backwards version of the `external` map (inlined items to where they
107 external_srcs: RefCell<NodeMap<DefId>>,
108 /// Cache instances of monomorphic and polymorphic items
109 instances: RefCell<FnvHashMap<Instance<'tcx>, ValueRef>>,
110 monomorphizing: RefCell<DefIdMap<usize>>,
111 /// Cache generated vtables
112 vtables: RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>, ValueRef>>,
113 /// Cache of constant strings,
114 const_cstr_cache: RefCell<FnvHashMap<InternedString, ValueRef>>,
116 /// Reverse-direction for const ptrs cast from globals.
117 /// Key is a ValueRef holding a *T,
118 /// Val is a ValueRef holding a *[T].
120 /// Needed because LLVM loses pointer->pointee association
121 /// when we ptrcast, and we have to ptrcast during translation
122 /// of a [T] const because we form a slice, a (*T,usize) pair, not
123 /// a pointer to an LLVM array type. Similar for trait objects.
124 const_unsized: RefCell<FnvHashMap<ValueRef, ValueRef>>,
126 /// Cache of emitted const globals (value -> global)
127 const_globals: RefCell<FnvHashMap<ValueRef, ValueRef>>,
129 /// Cache of emitted const values
130 const_values: RefCell<FnvHashMap<(ast::NodeId, &'tcx Substs<'tcx>), ValueRef>>,
132 /// Cache of external const values
133 extern_const_values: RefCell<DefIdMap<ValueRef>>,
135 /// Mapping from static definitions to their DefId's.
136 statics: RefCell<FnvHashMap<ValueRef, DefId>>,
138 impl_method_cache: RefCell<FnvHashMap<(DefId, ast::Name), DefId>>,
140 /// Cache of closure wrappers for bare fn's.
141 closure_bare_wrapper_cache: RefCell<FnvHashMap<ValueRef, ValueRef>>,
143 /// List of globals for static variables which need to be passed to the
144 /// LLVM function ReplaceAllUsesWith (RAUW) when translation is complete.
145 /// (We have to make sure we don't invalidate any ValueRefs referring
147 statics_to_rauw: RefCell<Vec<(ValueRef, ValueRef)>>,
149 lltypes: RefCell<FnvHashMap<Ty<'tcx>, Type>>,
150 llsizingtypes: RefCell<FnvHashMap<Ty<'tcx>, Type>>,
151 adt_reprs: RefCell<FnvHashMap<Ty<'tcx>, Rc<adt::Repr<'tcx>>>>,
152 type_hashcodes: RefCell<FnvHashMap<Ty<'tcx>, String>>,
154 opaque_vec_type: Type,
155 builder: BuilderRef_res,
157 /// Holds the LLVM values for closure IDs.
158 closure_vals: RefCell<FnvHashMap<Instance<'tcx>, ValueRef>>,
160 dbg_cx: Option<debuginfo::CrateDebugContext<'tcx>>,
162 eh_personality: Cell<Option<ValueRef>>,
163 eh_unwind_resume: Cell<Option<ValueRef>>,
164 rust_try_fn: Cell<Option<ValueRef>>,
166 intrinsics: RefCell<FnvHashMap<&'static str, ValueRef>>,
168 /// Number of LLVM instructions translated into this `LocalCrateContext`.
169 /// This is used to perform some basic load-balancing to keep all LLVM
170 /// contexts around the same size.
171 n_llvm_insns: Cell<usize>,
173 /// Depth of the current type-of computation - used to bail out
174 type_of_depth: Cell<usize>,
177 // Implement DepTrackingMapConfig for `trait_cache`
178 pub struct TraitSelectionCache<'tcx> {
179 data: PhantomData<&'tcx ()>
182 impl<'tcx> DepTrackingMapConfig for TraitSelectionCache<'tcx> {
183 type Key = ty::PolyTraitRef<'tcx>;
184 type Value = traits::Vtable<'tcx, ()>;
185 fn to_dep_node(key: &ty::PolyTraitRef<'tcx>) -> DepNode<DefId> {
186 key.to_poly_trait_predicate().dep_node()
190 /// This list owns a number of LocalCrateContexts and binds them to their common
191 /// SharedCrateContext. This type just exists as a convenience, something to
192 /// pass around all LocalCrateContexts with and get an iterator over them.
193 pub struct CrateContextList<'a, 'tcx: 'a> {
194 shared: &'a SharedCrateContext<'a, 'tcx>,
195 local_ccxs: Vec<LocalCrateContext<'tcx>>,
198 impl<'a, 'tcx: 'a> CrateContextList<'a, 'tcx> {
200 pub fn new(shared_ccx: &'a SharedCrateContext<'a, 'tcx>,
201 codegen_units: Vec<CodegenUnit<'tcx>>)
202 -> CrateContextList<'a, 'tcx> {
205 local_ccxs: codegen_units.into_iter().map(|codegen_unit| {
206 LocalCrateContext::new(shared_ccx, codegen_unit)
211 pub fn iter<'b>(&'b self) -> CrateContextIterator<'b, 'tcx> {
212 CrateContextIterator {
215 local_ccxs: &self.local_ccxs[..]
219 pub fn get_ccx<'b>(&'b self, index: usize) -> CrateContext<'b, 'tcx> {
223 local_ccxs: &self.local_ccxs[..],
227 pub fn shared(&self) -> &'a SharedCrateContext<'a, 'tcx> {
232 /// A CrateContext value binds together one LocalCrateContext with the
233 /// SharedCrateContext. It exists as a convenience wrapper, so we don't have to
234 /// pass around (SharedCrateContext, LocalCrateContext) tuples all over trans.
235 pub struct CrateContext<'a, 'tcx: 'a> {
236 shared: &'a SharedCrateContext<'a, 'tcx>,
237 local_ccxs: &'a [LocalCrateContext<'tcx>],
238 /// The index of `local` in `local_ccxs`. This is used in
239 /// `maybe_iter(true)` to identify the original `LocalCrateContext`.
243 pub struct CrateContextIterator<'a, 'tcx: 'a> {
244 shared: &'a SharedCrateContext<'a, 'tcx>,
245 local_ccxs: &'a [LocalCrateContext<'tcx>],
249 impl<'a, 'tcx> Iterator for CrateContextIterator<'a,'tcx> {
250 type Item = CrateContext<'a, 'tcx>;
252 fn next(&mut self) -> Option<CrateContext<'a, 'tcx>> {
253 if self.index >= self.local_ccxs.len() {
257 let index = self.index;
263 local_ccxs: self.local_ccxs,
268 /// The iterator produced by `CrateContext::maybe_iter`.
269 pub struct CrateContextMaybeIterator<'a, 'tcx: 'a> {
270 shared: &'a SharedCrateContext<'a, 'tcx>,
271 local_ccxs: &'a [LocalCrateContext<'tcx>],
277 impl<'a, 'tcx> Iterator for CrateContextMaybeIterator<'a, 'tcx> {
278 type Item = (CrateContext<'a, 'tcx>, bool);
280 fn next(&mut self) -> Option<(CrateContext<'a, 'tcx>, bool)> {
281 if self.index >= self.local_ccxs.len() {
285 let index = self.index;
288 self.index = self.local_ccxs.len();
291 let ccx = CrateContext {
294 local_ccxs: self.local_ccxs
296 Some((ccx, index == self.origin))
300 unsafe fn create_context_and_module(sess: &Session, mod_name: &str) -> (ContextRef, ModuleRef) {
301 let llcx = llvm::LLVMContextCreate();
302 let mod_name = CString::new(mod_name).unwrap();
303 let llmod = llvm::LLVMModuleCreateWithNameInContext(mod_name.as_ptr(), llcx);
305 // Ensure the data-layout values hardcoded remain the defaults.
306 if sess.target.target.options.is_builtin {
307 let tm = ::back::write::create_target_machine(sess);
308 llvm::LLVMRustSetDataLayoutFromTargetMachine(llmod, tm);
309 llvm::LLVMRustDisposeTargetMachine(tm);
311 let data_layout = llvm::LLVMGetDataLayout(llmod);
312 let data_layout = str::from_utf8(CStr::from_ptr(data_layout).to_bytes())
313 .ok().expect("got a non-UTF8 data-layout from LLVM");
315 if sess.target.target.data_layout != data_layout {
316 bug!("data-layout for builtin `{}` target, `{}`, \
317 differs from LLVM default, `{}`",
318 sess.target.target.llvm_target,
319 sess.target.target.data_layout,
324 let data_layout = CString::new(&sess.target.target.data_layout[..]).unwrap();
325 llvm::LLVMSetDataLayout(llmod, data_layout.as_ptr());
327 let llvm_target = sess.target.target.llvm_target.as_bytes();
328 let llvm_target = CString::new(llvm_target).unwrap();
329 llvm::LLVMRustSetNormalizedTarget(llmod, llvm_target.as_ptr());
333 impl<'b, 'tcx> SharedCrateContext<'b, 'tcx> {
334 pub fn new(tcx: TyCtxt<'b, 'tcx, 'tcx>,
335 mir_map: &'b MirMap<'tcx>,
336 export_map: ExportMap,
337 symbol_hasher: Sha256,
340 check_overflow: bool,
341 check_drop_flag_for_sanity: bool)
342 -> SharedCrateContext<'b, 'tcx> {
343 let (metadata_llcx, metadata_llmod) = unsafe {
344 create_context_and_module(&tcx.sess, "metadata")
347 // An interesting part of Windows which MSVC forces our hand on (and
348 // apparently MinGW didn't) is the usage of `dllimport` and `dllexport`
349 // attributes in LLVM IR as well as native dependencies (in C these
350 // correspond to `__declspec(dllimport)`).
352 // Whenever a dynamic library is built by MSVC it must have its public
353 // interface specified by functions tagged with `dllexport` or otherwise
354 // they're not available to be linked against. This poses a few problems
355 // for the compiler, some of which are somewhat fundamental, but we use
356 // the `use_dll_storage_attrs` variable below to attach the `dllexport`
357 // attribute to all LLVM functions that are reachable (e.g. they're
358 // already tagged with external linkage). This is suboptimal for a few
361 // * If an object file will never be included in a dynamic library,
362 // there's no need to attach the dllexport attribute. Most object
363 // files in Rust are not destined to become part of a dll as binaries
364 // are statically linked by default.
365 // * If the compiler is emitting both an rlib and a dylib, the same
366 // source object file is currently used but with MSVC this may be less
367 // feasible. The compiler may be able to get around this, but it may
368 // involve some invasive changes to deal with this.
370 // The flipside of this situation is that whenever you link to a dll and
371 // you import a function from it, the import should be tagged with
372 // `dllimport`. At this time, however, the compiler does not emit
373 // `dllimport` for any declarations other than constants (where it is
374 // required), which is again suboptimal for even more reasons!
376 // * Calling a function imported from another dll without using
377 // `dllimport` causes the linker/compiler to have extra overhead (one
378 // `jmp` instruction on x86) when calling the function.
379 // * The same object file may be used in different circumstances, so a
380 // function may be imported from a dll if the object is linked into a
381 // dll, but it may be just linked against if linked into an rlib.
382 // * The compiler has no knowledge about whether native functions should
383 // be tagged dllimport or not.
385 // For now the compiler takes the perf hit (I do not have any numbers to
386 // this effect) by marking very little as `dllimport` and praying the
387 // linker will take care of everything. Fixing this problem will likely
388 // require adding a few attributes to Rust itself (feature gated at the
389 // start) and then strongly recommending static linkage on MSVC!
390 let use_dll_storage_attrs = tcx.sess.target.target.options.is_like_msvc;
393 metadata_llmod: metadata_llmod,
394 metadata_llcx: metadata_llcx,
395 export_map: export_map,
396 reachable: reachable,
397 link_meta: link_meta,
398 symbol_hasher: RefCell::new(symbol_hasher),
401 mir_cache: RefCell::new(DefIdMap()),
403 n_glues_created: Cell::new(0),
404 n_null_glues: Cell::new(0),
405 n_real_glues: Cell::new(0),
407 n_monos: Cell::new(0),
408 n_inlines: Cell::new(0),
409 n_closures: Cell::new(0),
410 n_llvm_insns: Cell::new(0),
411 llvm_insns: RefCell::new(FnvHashMap()),
412 fn_stats: RefCell::new(Vec::new()),
414 check_overflow: check_overflow,
415 check_drop_flag_for_sanity: check_drop_flag_for_sanity,
416 available_monomorphizations: RefCell::new(FnvHashSet()),
417 available_drop_glues: RefCell::new(FnvHashMap()),
418 use_dll_storage_attrs: use_dll_storage_attrs,
419 translation_items: RefCell::new(FnvHashMap()),
420 trait_cache: RefCell::new(DepTrackingMap::new(tcx.dep_graph.clone())),
424 pub fn metadata_llmod(&self) -> ModuleRef {
428 pub fn metadata_llcx(&self) -> ContextRef {
432 pub fn export_map<'a>(&'a self) -> &'a ExportMap {
436 pub fn reachable<'a>(&'a self) -> &'a NodeSet {
440 pub fn trait_cache(&self) -> &RefCell<DepTrackingMap<TraitSelectionCache<'tcx>>> {
444 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
448 pub fn tcx<'a>(&'a self) -> TyCtxt<'a, 'tcx, 'tcx> {
452 pub fn sess<'a>(&'a self) -> &'a Session {
456 pub fn stats<'a>(&'a self) -> &'a Stats {
460 pub fn use_dll_storage_attrs(&self) -> bool {
461 self.use_dll_storage_attrs
464 pub fn get_mir(&self, def_id: DefId) -> Option<CachedMir<'b, 'tcx>> {
465 if def_id.is_local() {
466 let node_id = self.tcx.map.as_local_node_id(def_id).unwrap();
467 self.mir_map.map.get(&node_id).map(CachedMir::Ref)
469 if let Some(mir) = self.mir_cache.borrow().get(&def_id).cloned() {
470 return Some(CachedMir::Owned(mir));
473 let mir = self.sess().cstore.maybe_get_item_mir(self.tcx, def_id);
474 let cached = mir.map(Rc::new);
475 if let Some(ref mir) = cached {
476 self.mir_cache.borrow_mut().insert(def_id, mir.clone());
478 cached.map(CachedMir::Owned)
482 pub fn translation_items(&self) -> &RefCell<FnvHashMap<TransItem<'tcx>, TransItemState>> {
483 &self.translation_items
486 /// Given the def-id of some item that has no type parameters, make
487 /// a suitable "empty substs" for it.
488 pub fn empty_substs_for_def_id(&self, item_def_id: DefId) -> &'tcx Substs<'tcx> {
489 let scheme = self.tcx().lookup_item_type(item_def_id);
490 self.empty_substs_for_scheme(&scheme)
493 pub fn empty_substs_for_scheme(&self, scheme: &ty::TypeScheme<'tcx>)
494 -> &'tcx Substs<'tcx> {
495 assert!(scheme.generics.types.is_empty());
496 self.tcx().mk_substs(
497 Substs::new(VecPerParamSpace::empty(),
498 scheme.generics.regions.map(|_| ty::ReErased)))
501 pub fn symbol_hasher(&self) -> &RefCell<Sha256> {
505 pub fn mir_map(&self) -> &MirMap<'tcx> {
509 pub fn metadata_symbol_name(&self) -> String {
510 format!("rust_metadata_{}_{}",
511 self.link_meta().crate_name,
512 self.link_meta().crate_hash)
516 impl<'tcx> LocalCrateContext<'tcx> {
517 fn new<'a>(shared: &SharedCrateContext<'a, 'tcx>,
518 codegen_unit: CodegenUnit<'tcx>)
519 -> LocalCrateContext<'tcx> {
521 // Append ".rs" to LLVM module identifier.
523 // LLVM code generator emits a ".file filename" directive
524 // for ELF backends. Value of the "filename" is set as the
525 // LLVM module identifier. Due to a LLVM MC bug[1], LLVM
526 // crashes if the module identifier is same as other symbols
527 // such as a function name in the module.
528 // 1. http://llvm.org/bugs/show_bug.cgi?id=11479
529 let llmod_id = format!("{}.rs", codegen_unit.name);
531 let (llcx, llmod) = create_context_and_module(&shared.tcx.sess,
534 let dbg_cx = if shared.tcx.sess.opts.debuginfo != NoDebugInfo {
535 Some(debuginfo::CrateDebugContext::new(llmod))
540 let local_ccx = LocalCrateContext {
543 codegen_unit: codegen_unit,
544 tn: TypeNames::new(),
545 needs_unwind_cleanup_cache: RefCell::new(FnvHashMap()),
546 fn_pointer_shims: RefCell::new(FnvHashMap()),
547 drop_glues: RefCell::new(FnvHashMap()),
548 external: RefCell::new(DefIdMap()),
549 external_srcs: RefCell::new(NodeMap()),
550 instances: RefCell::new(FnvHashMap()),
551 monomorphizing: RefCell::new(DefIdMap()),
552 vtables: RefCell::new(FnvHashMap()),
553 const_cstr_cache: RefCell::new(FnvHashMap()),
554 const_unsized: RefCell::new(FnvHashMap()),
555 const_globals: RefCell::new(FnvHashMap()),
556 const_values: RefCell::new(FnvHashMap()),
557 extern_const_values: RefCell::new(DefIdMap()),
558 statics: RefCell::new(FnvHashMap()),
559 impl_method_cache: RefCell::new(FnvHashMap()),
560 closure_bare_wrapper_cache: RefCell::new(FnvHashMap()),
561 statics_to_rauw: RefCell::new(Vec::new()),
562 lltypes: RefCell::new(FnvHashMap()),
563 llsizingtypes: RefCell::new(FnvHashMap()),
564 adt_reprs: RefCell::new(FnvHashMap()),
565 type_hashcodes: RefCell::new(FnvHashMap()),
566 int_type: Type::from_ref(ptr::null_mut()),
567 opaque_vec_type: Type::from_ref(ptr::null_mut()),
568 builder: BuilderRef_res(llvm::LLVMCreateBuilderInContext(llcx)),
569 closure_vals: RefCell::new(FnvHashMap()),
571 eh_personality: Cell::new(None),
572 eh_unwind_resume: Cell::new(None),
573 rust_try_fn: Cell::new(None),
574 intrinsics: RefCell::new(FnvHashMap()),
575 n_llvm_insns: Cell::new(0),
576 type_of_depth: Cell::new(0),
579 let (int_type, opaque_vec_type, str_slice_ty, mut local_ccx) = {
580 // Do a little dance to create a dummy CrateContext, so we can
581 // create some things in the LLVM module of this codegen unit
582 let mut local_ccxs = vec![local_ccx];
583 let (int_type, opaque_vec_type, str_slice_ty) = {
584 let dummy_ccx = LocalCrateContext::dummy_ccx(shared,
585 local_ccxs.as_mut_slice());
586 let mut str_slice_ty = Type::named_struct(&dummy_ccx, "str_slice");
587 str_slice_ty.set_struct_body(&[Type::i8p(&dummy_ccx),
588 Type::int(&dummy_ccx)],
590 (Type::int(&dummy_ccx), Type::opaque_vec(&dummy_ccx), str_slice_ty)
592 (int_type, opaque_vec_type, str_slice_ty, local_ccxs.pop().unwrap())
595 local_ccx.int_type = int_type;
596 local_ccx.opaque_vec_type = opaque_vec_type;
597 local_ccx.tn.associate_type("str_slice", &str_slice_ty);
599 if shared.tcx.sess.count_llvm_insns() {
600 base::init_insn_ctxt()
607 /// Create a dummy `CrateContext` from `self` and the provided
608 /// `SharedCrateContext`. This is somewhat dangerous because `self` may
609 /// not be fully initialized.
611 /// This is used in the `LocalCrateContext` constructor to allow calling
612 /// functions that expect a complete `CrateContext`, even before the local
613 /// portion is fully initialized and attached to the `SharedCrateContext`.
614 fn dummy_ccx<'a>(shared: &'a SharedCrateContext<'a, 'tcx>,
615 local_ccxs: &'a [LocalCrateContext<'tcx>])
616 -> CrateContext<'a, 'tcx> {
617 assert!(local_ccxs.len() == 1);
621 local_ccxs: local_ccxs
626 impl<'b, 'tcx> CrateContext<'b, 'tcx> {
627 pub fn shared(&self) -> &'b SharedCrateContext<'b, 'tcx> {
631 pub fn local(&self) -> &'b LocalCrateContext<'tcx> {
632 &self.local_ccxs[self.index]
635 /// Get a (possibly) different `CrateContext` from the same
636 /// `SharedCrateContext`.
637 pub fn rotate(&'b self) -> CrateContext<'b, 'tcx> {
641 .zip(0..self.local_ccxs.len())
642 .min_by_key(|&(local_ccx, _idx)| local_ccx.n_llvm_insns.get())
647 local_ccxs: &self.local_ccxs[..],
651 /// Either iterate over only `self`, or iterate over all `CrateContext`s in
652 /// the `SharedCrateContext`. The iterator produces `(ccx, is_origin)`
653 /// pairs, where `is_origin` is `true` if `ccx` is `self` and `false`
654 /// otherwise. This method is useful for avoiding code duplication in
655 /// cases where it may or may not be necessary to translate code into every
657 pub fn maybe_iter(&self, iter_all: bool) -> CrateContextMaybeIterator<'b, 'tcx> {
658 CrateContextMaybeIterator {
660 index: if iter_all { 0 } else { self.index },
663 local_ccxs: self.local_ccxs,
667 pub fn tcx<'a>(&'a self) -> TyCtxt<'a, 'tcx, 'tcx> {
671 pub fn sess<'a>(&'a self) -> &'a Session {
672 &self.shared.tcx.sess
675 pub fn builder<'a>(&'a self) -> Builder<'a, 'tcx> {
679 pub fn raw_builder<'a>(&'a self) -> BuilderRef {
680 self.local().builder.b
683 pub fn get_intrinsic(&self, key: &str) -> ValueRef {
684 if let Some(v) = self.intrinsics().borrow().get(key).cloned() {
687 match declare_intrinsic(self, key) {
689 None => bug!("unknown intrinsic '{}'", key)
693 pub fn llmod(&self) -> ModuleRef {
697 pub fn llcx(&self) -> ContextRef {
701 pub fn codegen_unit(&self) -> &CodegenUnit<'tcx> {
702 &self.local().codegen_unit
705 pub fn td(&self) -> llvm::TargetDataRef {
706 unsafe { llvm::LLVMRustGetModuleDataLayout(self.llmod()) }
709 pub fn tn<'a>(&'a self) -> &'a TypeNames {
713 pub fn export_map<'a>(&'a self) -> &'a ExportMap {
714 &self.shared.export_map
717 pub fn reachable<'a>(&'a self) -> &'a NodeSet {
718 &self.shared.reachable
721 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
722 &self.shared.link_meta
725 pub fn needs_unwind_cleanup_cache(&self) -> &RefCell<FnvHashMap<Ty<'tcx>, bool>> {
726 &self.local().needs_unwind_cleanup_cache
729 pub fn fn_pointer_shims(&self) -> &RefCell<FnvHashMap<Ty<'tcx>, ValueRef>> {
730 &self.local().fn_pointer_shims
733 pub fn drop_glues<'a>(&'a self) -> &'a RefCell<FnvHashMap<DropGlueKind<'tcx>, ValueRef>> {
734 &self.local().drop_glues
737 pub fn external<'a>(&'a self) -> &'a RefCell<DefIdMap<Option<ast::NodeId>>> {
738 &self.local().external
741 pub fn external_srcs<'a>(&'a self) -> &'a RefCell<NodeMap<DefId>> {
742 &self.local().external_srcs
745 pub fn instances<'a>(&'a self) -> &'a RefCell<FnvHashMap<Instance<'tcx>, ValueRef>> {
746 &self.local().instances
749 pub fn monomorphizing<'a>(&'a self) -> &'a RefCell<DefIdMap<usize>> {
750 &self.local().monomorphizing
753 pub fn vtables<'a>(&'a self) -> &'a RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>, ValueRef>> {
754 &self.local().vtables
757 pub fn const_cstr_cache<'a>(&'a self) -> &'a RefCell<FnvHashMap<InternedString, ValueRef>> {
758 &self.local().const_cstr_cache
761 pub fn const_unsized<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
762 &self.local().const_unsized
765 pub fn const_globals<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
766 &self.local().const_globals
769 pub fn const_values<'a>(&'a self) -> &'a RefCell<FnvHashMap<(ast::NodeId, &'tcx Substs<'tcx>),
771 &self.local().const_values
774 pub fn extern_const_values<'a>(&'a self) -> &'a RefCell<DefIdMap<ValueRef>> {
775 &self.local().extern_const_values
778 pub fn statics<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, DefId>> {
779 &self.local().statics
782 pub fn impl_method_cache<'a>(&'a self)
783 -> &'a RefCell<FnvHashMap<(DefId, ast::Name), DefId>> {
784 &self.local().impl_method_cache
787 pub fn closure_bare_wrapper_cache<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
788 &self.local().closure_bare_wrapper_cache
791 pub fn statics_to_rauw<'a>(&'a self) -> &'a RefCell<Vec<(ValueRef, ValueRef)>> {
792 &self.local().statics_to_rauw
795 pub fn lltypes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Type>> {
796 &self.local().lltypes
799 pub fn llsizingtypes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Type>> {
800 &self.local().llsizingtypes
803 pub fn adt_reprs<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Rc<adt::Repr<'tcx>>>> {
804 &self.local().adt_reprs
807 pub fn symbol_hasher<'a>(&'a self) -> &'a RefCell<Sha256> {
808 &self.shared.symbol_hasher
811 pub fn type_hashcodes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, String>> {
812 &self.local().type_hashcodes
815 pub fn stats<'a>(&'a self) -> &'a Stats {
819 pub fn available_monomorphizations<'a>(&'a self) -> &'a RefCell<FnvHashSet<String>> {
820 &self.shared.available_monomorphizations
823 pub fn available_drop_glues(&self) -> &RefCell<FnvHashMap<DropGlueKind<'tcx>, String>> {
824 &self.shared.available_drop_glues
827 pub fn int_type(&self) -> Type {
828 self.local().int_type
831 pub fn opaque_vec_type(&self) -> Type {
832 self.local().opaque_vec_type
835 pub fn closure_vals<'a>(&'a self) -> &'a RefCell<FnvHashMap<Instance<'tcx>, ValueRef>> {
836 &self.local().closure_vals
839 pub fn dbg_cx<'a>(&'a self) -> &'a Option<debuginfo::CrateDebugContext<'tcx>> {
843 pub fn eh_personality<'a>(&'a self) -> &'a Cell<Option<ValueRef>> {
844 &self.local().eh_personality
847 pub fn eh_unwind_resume<'a>(&'a self) -> &'a Cell<Option<ValueRef>> {
848 &self.local().eh_unwind_resume
851 pub fn rust_try_fn<'a>(&'a self) -> &'a Cell<Option<ValueRef>> {
852 &self.local().rust_try_fn
855 fn intrinsics<'a>(&'a self) -> &'a RefCell<FnvHashMap<&'static str, ValueRef>> {
856 &self.local().intrinsics
859 pub fn count_llvm_insn(&self) {
860 self.local().n_llvm_insns.set(self.local().n_llvm_insns.get() + 1);
863 pub fn obj_size_bound(&self) -> u64 {
864 self.tcx().data_layout.obj_size_bound()
867 pub fn report_overbig_object(&self, obj: Ty<'tcx>) -> ! {
869 &format!("the type `{:?}` is too big for the current architecture",
873 pub fn enter_type_of(&self, ty: Ty<'tcx>) -> TypeOfDepthLock<'b, 'tcx> {
874 let current_depth = self.local().type_of_depth.get();
875 debug!("enter_type_of({:?}) at depth {:?}", ty, current_depth);
876 if current_depth > self.sess().recursion_limit.get() {
878 &format!("overflow representing the type `{}`", ty))
880 self.local().type_of_depth.set(current_depth + 1);
881 TypeOfDepthLock(self.local())
884 pub fn check_overflow(&self) -> bool {
885 self.shared.check_overflow
888 pub fn check_drop_flag_for_sanity(&self) -> bool {
889 // This controls whether we emit a conditional llvm.debugtrap
890 // guarded on whether the dropflag is one of its (two) valid
892 self.shared.check_drop_flag_for_sanity
895 pub fn use_dll_storage_attrs(&self) -> bool {
896 self.shared.use_dll_storage_attrs()
899 pub fn get_mir(&self, def_id: DefId) -> Option<CachedMir<'b, 'tcx>> {
900 self.shared.get_mir(def_id)
903 pub fn translation_items(&self) -> &RefCell<FnvHashMap<TransItem<'tcx>, TransItemState>> {
904 &self.shared.translation_items
907 pub fn record_translation_item_as_generated(&self, cgi: TransItem<'tcx>) {
908 if self.sess().opts.debugging_opts.print_trans_items.is_none() {
912 let mut codegen_items = self.translation_items().borrow_mut();
914 if codegen_items.contains_key(&cgi) {
915 codegen_items.insert(cgi, TransItemState::PredictedAndGenerated);
917 codegen_items.insert(cgi, TransItemState::NotPredictedButGenerated);
921 /// Given the def-id of some item that has no type parameters, make
922 /// a suitable "empty substs" for it.
923 pub fn empty_substs_for_def_id(&self, item_def_id: DefId) -> &'tcx Substs<'tcx> {
924 self.shared().empty_substs_for_def_id(item_def_id)
927 pub fn empty_substs_for_scheme(&self, scheme: &ty::TypeScheme<'tcx>)
928 -> &'tcx Substs<'tcx> {
929 self.shared().empty_substs_for_scheme(scheme)
933 pub struct TypeOfDepthLock<'a, 'tcx: 'a>(&'a LocalCrateContext<'tcx>);
935 impl<'a, 'tcx> Drop for TypeOfDepthLock<'a, 'tcx> {
937 self.0.type_of_depth.set(self.0.type_of_depth.get() - 1);
941 /// Declare any llvm intrinsics that you might need
942 fn declare_intrinsic(ccx: &CrateContext, key: &str) -> Option<ValueRef> {
944 ($name:expr, fn() -> $ret:expr) => (
946 let f = declare::declare_cfn(ccx, $name, Type::func(&[], &$ret));
947 llvm::SetUnnamedAddr(f, false);
948 ccx.intrinsics().borrow_mut().insert($name, f.clone());
952 ($name:expr, fn(...) -> $ret:expr) => (
954 let f = declare::declare_cfn(ccx, $name, Type::variadic_func(&[], &$ret));
955 llvm::SetUnnamedAddr(f, false);
956 ccx.intrinsics().borrow_mut().insert($name, f.clone());
960 ($name:expr, fn($($arg:expr),*) -> $ret:expr) => (
962 let f = declare::declare_cfn(ccx, $name, Type::func(&[$($arg),*], &$ret));
963 llvm::SetUnnamedAddr(f, false);
964 ccx.intrinsics().borrow_mut().insert($name, f.clone());
969 macro_rules! mk_struct {
970 ($($field_ty:expr),*) => (Type::struct_(ccx, &[$($field_ty),*], false))
973 let i8p = Type::i8p(ccx);
974 let void = Type::void(ccx);
975 let i1 = Type::i1(ccx);
976 let t_i8 = Type::i8(ccx);
977 let t_i16 = Type::i16(ccx);
978 let t_i32 = Type::i32(ccx);
979 let t_i64 = Type::i64(ccx);
980 let t_f32 = Type::f32(ccx);
981 let t_f64 = Type::f64(ccx);
983 ifn!("llvm.memcpy.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
984 ifn!("llvm.memcpy.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
985 ifn!("llvm.memcpy.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
986 ifn!("llvm.memmove.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
987 ifn!("llvm.memmove.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
988 ifn!("llvm.memmove.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
989 ifn!("llvm.memset.p0i8.i16", fn(i8p, t_i8, t_i16, t_i32, i1) -> void);
990 ifn!("llvm.memset.p0i8.i32", fn(i8p, t_i8, t_i32, t_i32, i1) -> void);
991 ifn!("llvm.memset.p0i8.i64", fn(i8p, t_i8, t_i64, t_i32, i1) -> void);
993 ifn!("llvm.trap", fn() -> void);
994 ifn!("llvm.debugtrap", fn() -> void);
995 ifn!("llvm.frameaddress", fn(t_i32) -> i8p);
997 ifn!("llvm.powi.f32", fn(t_f32, t_i32) -> t_f32);
998 ifn!("llvm.powi.f64", fn(t_f64, t_i32) -> t_f64);
999 ifn!("llvm.pow.f32", fn(t_f32, t_f32) -> t_f32);
1000 ifn!("llvm.pow.f64", fn(t_f64, t_f64) -> t_f64);
1002 ifn!("llvm.sqrt.f32", fn(t_f32) -> t_f32);
1003 ifn!("llvm.sqrt.f64", fn(t_f64) -> t_f64);
1004 ifn!("llvm.sin.f32", fn(t_f32) -> t_f32);
1005 ifn!("llvm.sin.f64", fn(t_f64) -> t_f64);
1006 ifn!("llvm.cos.f32", fn(t_f32) -> t_f32);
1007 ifn!("llvm.cos.f64", fn(t_f64) -> t_f64);
1008 ifn!("llvm.exp.f32", fn(t_f32) -> t_f32);
1009 ifn!("llvm.exp.f64", fn(t_f64) -> t_f64);
1010 ifn!("llvm.exp2.f32", fn(t_f32) -> t_f32);
1011 ifn!("llvm.exp2.f64", fn(t_f64) -> t_f64);
1012 ifn!("llvm.log.f32", fn(t_f32) -> t_f32);
1013 ifn!("llvm.log.f64", fn(t_f64) -> t_f64);
1014 ifn!("llvm.log10.f32", fn(t_f32) -> t_f32);
1015 ifn!("llvm.log10.f64", fn(t_f64) -> t_f64);
1016 ifn!("llvm.log2.f32", fn(t_f32) -> t_f32);
1017 ifn!("llvm.log2.f64", fn(t_f64) -> t_f64);
1019 ifn!("llvm.fma.f32", fn(t_f32, t_f32, t_f32) -> t_f32);
1020 ifn!("llvm.fma.f64", fn(t_f64, t_f64, t_f64) -> t_f64);
1022 ifn!("llvm.fabs.f32", fn(t_f32) -> t_f32);
1023 ifn!("llvm.fabs.f64", fn(t_f64) -> t_f64);
1025 ifn!("llvm.floor.f32", fn(t_f32) -> t_f32);
1026 ifn!("llvm.floor.f64", fn(t_f64) -> t_f64);
1027 ifn!("llvm.ceil.f32", fn(t_f32) -> t_f32);
1028 ifn!("llvm.ceil.f64", fn(t_f64) -> t_f64);
1029 ifn!("llvm.trunc.f32", fn(t_f32) -> t_f32);
1030 ifn!("llvm.trunc.f64", fn(t_f64) -> t_f64);
1032 ifn!("llvm.copysign.f32", fn(t_f32, t_f32) -> t_f32);
1033 ifn!("llvm.copysign.f64", fn(t_f64, t_f64) -> t_f64);
1034 ifn!("llvm.round.f32", fn(t_f32) -> t_f32);
1035 ifn!("llvm.round.f64", fn(t_f64) -> t_f64);
1037 ifn!("llvm.rint.f32", fn(t_f32) -> t_f32);
1038 ifn!("llvm.rint.f64", fn(t_f64) -> t_f64);
1039 ifn!("llvm.nearbyint.f32", fn(t_f32) -> t_f32);
1040 ifn!("llvm.nearbyint.f64", fn(t_f64) -> t_f64);
1042 ifn!("llvm.ctpop.i8", fn(t_i8) -> t_i8);
1043 ifn!("llvm.ctpop.i16", fn(t_i16) -> t_i16);
1044 ifn!("llvm.ctpop.i32", fn(t_i32) -> t_i32);
1045 ifn!("llvm.ctpop.i64", fn(t_i64) -> t_i64);
1047 ifn!("llvm.ctlz.i8", fn(t_i8 , i1) -> t_i8);
1048 ifn!("llvm.ctlz.i16", fn(t_i16, i1) -> t_i16);
1049 ifn!("llvm.ctlz.i32", fn(t_i32, i1) -> t_i32);
1050 ifn!("llvm.ctlz.i64", fn(t_i64, i1) -> t_i64);
1052 ifn!("llvm.cttz.i8", fn(t_i8 , i1) -> t_i8);
1053 ifn!("llvm.cttz.i16", fn(t_i16, i1) -> t_i16);
1054 ifn!("llvm.cttz.i32", fn(t_i32, i1) -> t_i32);
1055 ifn!("llvm.cttz.i64", fn(t_i64, i1) -> t_i64);
1057 ifn!("llvm.bswap.i16", fn(t_i16) -> t_i16);
1058 ifn!("llvm.bswap.i32", fn(t_i32) -> t_i32);
1059 ifn!("llvm.bswap.i64", fn(t_i64) -> t_i64);
1061 ifn!("llvm.sadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1062 ifn!("llvm.sadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1063 ifn!("llvm.sadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1064 ifn!("llvm.sadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1066 ifn!("llvm.uadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1067 ifn!("llvm.uadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1068 ifn!("llvm.uadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1069 ifn!("llvm.uadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1071 ifn!("llvm.ssub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1072 ifn!("llvm.ssub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1073 ifn!("llvm.ssub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1074 ifn!("llvm.ssub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1076 ifn!("llvm.usub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1077 ifn!("llvm.usub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1078 ifn!("llvm.usub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1079 ifn!("llvm.usub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1081 ifn!("llvm.smul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1082 ifn!("llvm.smul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1083 ifn!("llvm.smul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1084 ifn!("llvm.smul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1086 ifn!("llvm.umul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1087 ifn!("llvm.umul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1088 ifn!("llvm.umul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1089 ifn!("llvm.umul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1091 ifn!("llvm.lifetime.start", fn(t_i64,i8p) -> void);
1092 ifn!("llvm.lifetime.end", fn(t_i64, i8p) -> void);
1094 ifn!("llvm.expect.i1", fn(i1, i1) -> i1);
1095 ifn!("llvm.eh.typeid.for", fn(i8p) -> t_i32);
1096 ifn!("llvm.localescape", fn(...) -> void);
1097 ifn!("llvm.localrecover", fn(i8p, i8p, t_i32) -> i8p);
1098 ifn!("llvm.x86.seh.recoverfp", fn(i8p, i8p) -> i8p);
1100 // Some intrinsics were introduced in later versions of LLVM, but they have
1101 // fallbacks in libc or libm and such.
1102 macro_rules! compatible_ifn {
1103 ($name:expr, noop($cname:ident ($($arg:expr),*) -> void), $llvm_version:expr) => (
1104 if unsafe { llvm::LLVMVersionMinor() >= $llvm_version } {
1105 // The `if key == $name` is already in ifn!
1106 ifn!($name, fn($($arg),*) -> void);
1107 } else if key == $name {
1108 let f = declare::declare_cfn(ccx, stringify!($cname),
1109 Type::func(&[$($arg),*], &void));
1110 llvm::SetLinkage(f, llvm::InternalLinkage);
1112 let bld = ccx.builder();
1114 llvm::LLVMAppendBasicBlockInContext(ccx.llcx(), f,
1115 "entry-block\0".as_ptr() as *const _)
1118 bld.position_at_end(llbb);
1121 ccx.intrinsics().borrow_mut().insert($name, f.clone());
1125 ($name:expr, $cname:ident ($($arg:expr),*) -> $ret:expr, $llvm_version:expr) => (
1126 if unsafe { llvm::LLVMVersionMinor() >= $llvm_version } {
1127 // The `if key == $name` is already in ifn!
1128 ifn!($name, fn($($arg),*) -> $ret);
1129 } else if key == $name {
1130 let f = declare::declare_cfn(ccx, stringify!($cname),
1131 Type::func(&[$($arg),*], &$ret));
1132 ccx.intrinsics().borrow_mut().insert($name, f.clone());
1138 compatible_ifn!("llvm.assume", noop(llvmcompat_assume(i1) -> void), 6);
1140 if ccx.sess().opts.debuginfo != NoDebugInfo {
1141 ifn!("llvm.dbg.declare", fn(Type::metadata(ccx), Type::metadata(ccx)) -> void);
1142 ifn!("llvm.dbg.value", fn(Type::metadata(ccx), t_i64, Type::metadata(ccx)) -> void);