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, WorkProduct};
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 trans_item::TransItem;
32 use type_::{Type, TypeNames};
33 use rustc::ty::subst::{Substs, VecPerParamSpace};
34 use rustc::ty::{self, Ty, TyCtxt};
35 use session::config::NoDebugInfo;
38 use symbol_map::SymbolMap;
39 use util::sha2::Sha256;
40 use util::nodemap::{NodeMap, NodeSet, DefIdMap, FnvHashMap, FnvHashSet};
42 use std::ffi::{CStr, CString};
43 use std::cell::{Cell, RefCell};
44 use std::marker::PhantomData;
49 use syntax::parse::token::InternedString;
53 pub n_glues_created: Cell<usize>,
54 pub n_null_glues: Cell<usize>,
55 pub n_real_glues: Cell<usize>,
56 pub n_fallback_instantiations: Cell<usize>,
57 pub n_fns: Cell<usize>,
58 pub n_monos: Cell<usize>,
59 pub n_inlines: Cell<usize>,
60 pub n_closures: Cell<usize>,
61 pub n_llvm_insns: Cell<usize>,
62 pub llvm_insns: RefCell<FnvHashMap<String, usize>>,
63 // (ident, llvm-instructions)
64 pub fn_stats: RefCell<Vec<(String, usize)> >,
67 /// The shared portion of a `CrateContext`. There is one `SharedCrateContext`
68 /// per crate. The data here is shared between all compilation units of the
69 /// crate, so it must not contain references to any LLVM data structures
70 /// (aside from metadata-related ones).
71 pub struct SharedCrateContext<'a, 'tcx: 'a> {
72 metadata_llmod: ModuleRef,
73 metadata_llcx: ContextRef,
75 export_map: ExportMap,
78 symbol_hasher: RefCell<Sha256>,
79 tcx: TyCtxt<'a, 'tcx, 'tcx>,
82 check_drop_flag_for_sanity: bool,
83 mir_map: &'a MirMap<'tcx>,
84 mir_cache: RefCell<DefIdMap<Rc<mir::Mir<'tcx>>>>,
86 use_dll_storage_attrs: bool,
88 translation_items: RefCell<FnvHashSet<TransItem<'tcx>>>,
89 trait_cache: RefCell<DepTrackingMap<TraitSelectionCache<'tcx>>>,
92 /// The local portion of a `CrateContext`. There is one `LocalCrateContext`
93 /// per compilation unit. Each one has its own LLVM `ContextRef` so that
94 /// several compilation units may be optimized in parallel. All other LLVM
95 /// data structures in the `LocalCrateContext` are tied to that `ContextRef`.
96 pub struct LocalCrateContext<'tcx> {
99 previous_work_product: Option<WorkProduct>,
100 tn: TypeNames, // FIXME: This seems to be largely unused.
101 codegen_unit: CodegenUnit<'tcx>,
102 needs_unwind_cleanup_cache: RefCell<FnvHashMap<Ty<'tcx>, bool>>,
103 fn_pointer_shims: RefCell<FnvHashMap<Ty<'tcx>, ValueRef>>,
104 drop_glues: RefCell<FnvHashMap<DropGlueKind<'tcx>, (ValueRef, FnType)>>,
105 /// Track mapping of external ids to local items imported for inlining
106 external: RefCell<DefIdMap<Option<ast::NodeId>>>,
107 /// Backwards version of the `external` map (inlined items to where they
109 external_srcs: RefCell<NodeMap<DefId>>,
110 /// Cache instances of monomorphic and polymorphic items
111 instances: RefCell<FnvHashMap<Instance<'tcx>, ValueRef>>,
112 monomorphizing: RefCell<DefIdMap<usize>>,
113 /// Cache generated vtables
114 vtables: RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>, ValueRef>>,
115 /// Cache of constant strings,
116 const_cstr_cache: RefCell<FnvHashMap<InternedString, ValueRef>>,
118 /// Reverse-direction for const ptrs cast from globals.
119 /// Key is a ValueRef holding a *T,
120 /// Val is a ValueRef holding a *[T].
122 /// Needed because LLVM loses pointer->pointee association
123 /// when we ptrcast, and we have to ptrcast during translation
124 /// of a [T] const because we form a slice, a (*T,usize) pair, not
125 /// a pointer to an LLVM array type. Similar for trait objects.
126 const_unsized: RefCell<FnvHashMap<ValueRef, ValueRef>>,
128 /// Cache of emitted const globals (value -> global)
129 const_globals: RefCell<FnvHashMap<ValueRef, ValueRef>>,
131 /// Cache of emitted const values
132 const_values: RefCell<FnvHashMap<(ast::NodeId, &'tcx Substs<'tcx>), ValueRef>>,
134 /// Cache of external const values
135 extern_const_values: RefCell<DefIdMap<ValueRef>>,
137 /// Mapping from static definitions to their DefId's.
138 statics: RefCell<FnvHashMap<ValueRef, DefId>>,
140 impl_method_cache: RefCell<FnvHashMap<(DefId, ast::Name), DefId>>,
142 /// Cache of closure wrappers for bare fn's.
143 closure_bare_wrapper_cache: RefCell<FnvHashMap<ValueRef, ValueRef>>,
145 /// List of globals for static variables which need to be passed to the
146 /// LLVM function ReplaceAllUsesWith (RAUW) when translation is complete.
147 /// (We have to make sure we don't invalidate any ValueRefs referring
149 statics_to_rauw: RefCell<Vec<(ValueRef, ValueRef)>>,
151 lltypes: RefCell<FnvHashMap<Ty<'tcx>, Type>>,
152 llsizingtypes: RefCell<FnvHashMap<Ty<'tcx>, Type>>,
153 adt_reprs: RefCell<FnvHashMap<Ty<'tcx>, Rc<adt::Repr<'tcx>>>>,
154 type_hashcodes: RefCell<FnvHashMap<Ty<'tcx>, String>>,
156 opaque_vec_type: Type,
157 builder: BuilderRef_res,
159 /// Holds the LLVM values for closure IDs.
160 closure_vals: RefCell<FnvHashMap<Instance<'tcx>, ValueRef>>,
162 dbg_cx: Option<debuginfo::CrateDebugContext<'tcx>>,
164 eh_personality: Cell<Option<ValueRef>>,
165 eh_unwind_resume: Cell<Option<ValueRef>>,
166 rust_try_fn: Cell<Option<ValueRef>>,
168 intrinsics: RefCell<FnvHashMap<&'static str, ValueRef>>,
170 /// Number of LLVM instructions translated into this `LocalCrateContext`.
171 /// This is used to perform some basic load-balancing to keep all LLVM
172 /// contexts around the same size.
173 n_llvm_insns: Cell<usize>,
175 /// Depth of the current type-of computation - used to bail out
176 type_of_depth: Cell<usize>,
178 symbol_map: Rc<SymbolMap<'tcx>>,
181 // Implement DepTrackingMapConfig for `trait_cache`
182 pub struct TraitSelectionCache<'tcx> {
183 data: PhantomData<&'tcx ()>
186 impl<'tcx> DepTrackingMapConfig for TraitSelectionCache<'tcx> {
187 type Key = ty::PolyTraitRef<'tcx>;
188 type Value = traits::Vtable<'tcx, ()>;
189 fn to_dep_node(key: &ty::PolyTraitRef<'tcx>) -> DepNode<DefId> {
190 key.to_poly_trait_predicate().dep_node()
194 /// This list owns a number of LocalCrateContexts and binds them to their common
195 /// SharedCrateContext. This type just exists as a convenience, something to
196 /// pass around all LocalCrateContexts with and get an iterator over them.
197 pub struct CrateContextList<'a, 'tcx: 'a> {
198 shared: &'a SharedCrateContext<'a, 'tcx>,
199 local_ccxs: Vec<LocalCrateContext<'tcx>>,
202 impl<'a, 'tcx: 'a> CrateContextList<'a, 'tcx> {
203 pub fn new(shared_ccx: &'a SharedCrateContext<'a, 'tcx>,
204 codegen_units: Vec<CodegenUnit<'tcx>>,
205 previous_work_products: Vec<Option<WorkProduct>>,
206 symbol_map: Rc<SymbolMap<'tcx>>)
207 -> CrateContextList<'a, 'tcx> {
210 local_ccxs: codegen_units.into_iter().zip(previous_work_products).map(|(cgu, wp)| {
211 LocalCrateContext::new(shared_ccx, cgu, wp, symbol_map.clone())
216 /// Iterate over all crate contexts, whether or not they need
217 /// translation. That is, whether or not a `.o` file is available
218 /// for re-use from a previous incr. comp.).
219 pub fn iter_all<'b>(&'b self) -> CrateContextIterator<'b, 'tcx> {
220 CrateContextIterator {
223 local_ccxs: &self.local_ccxs[..],
224 filter_to_previous_work_product_unavail: false,
228 /// Iterator over all CCX that need translation (cannot reuse results from
229 /// previous incr. comp.).
230 pub fn iter_need_trans<'b>(&'b self) -> CrateContextIterator<'b, 'tcx> {
231 CrateContextIterator {
234 local_ccxs: &self.local_ccxs[..],
235 filter_to_previous_work_product_unavail: true,
239 pub fn shared(&self) -> &'a SharedCrateContext<'a, 'tcx> {
244 /// A CrateContext value binds together one LocalCrateContext with the
245 /// SharedCrateContext. It exists as a convenience wrapper, so we don't have to
246 /// pass around (SharedCrateContext, LocalCrateContext) tuples all over trans.
247 pub struct CrateContext<'a, 'tcx: 'a> {
248 shared: &'a SharedCrateContext<'a, 'tcx>,
249 local_ccxs: &'a [LocalCrateContext<'tcx>],
250 /// The index of `local` in `local_ccxs`. This is used in
251 /// `maybe_iter(true)` to identify the original `LocalCrateContext`.
255 pub struct CrateContextIterator<'a, 'tcx: 'a> {
256 shared: &'a SharedCrateContext<'a, 'tcx>,
257 local_ccxs: &'a [LocalCrateContext<'tcx>],
260 /// if true, only return results where `previous_work_product` is none
261 filter_to_previous_work_product_unavail: bool,
264 impl<'a, 'tcx> Iterator for CrateContextIterator<'a,'tcx> {
265 type Item = CrateContext<'a, 'tcx>;
267 fn next(&mut self) -> Option<CrateContext<'a, 'tcx>> {
269 if self.index >= self.local_ccxs.len() {
273 let index = self.index;
276 let ccx = CrateContext {
279 local_ccxs: self.local_ccxs,
283 self.filter_to_previous_work_product_unavail &&
284 ccx.previous_work_product().is_some()
294 /// The iterator produced by `CrateContext::maybe_iter`.
295 pub struct CrateContextMaybeIterator<'a, 'tcx: 'a> {
296 shared: &'a SharedCrateContext<'a, 'tcx>,
297 local_ccxs: &'a [LocalCrateContext<'tcx>],
303 impl<'a, 'tcx> Iterator for CrateContextMaybeIterator<'a, 'tcx> {
304 type Item = (CrateContext<'a, 'tcx>, bool);
306 fn next(&mut self) -> Option<(CrateContext<'a, 'tcx>, bool)> {
307 if self.index >= self.local_ccxs.len() {
311 let index = self.index;
314 self.index = self.local_ccxs.len();
317 let ccx = CrateContext {
320 local_ccxs: self.local_ccxs
322 Some((ccx, index == self.origin))
326 pub fn get_reloc_model(sess: &Session) -> llvm::RelocMode {
327 let reloc_model_arg = match sess.opts.cg.relocation_model {
328 Some(ref s) => &s[..],
329 None => &sess.target.target.options.relocation_model[..],
332 match reloc_model_arg {
333 "pic" => llvm::RelocPIC,
334 "static" => llvm::RelocStatic,
335 "default" => llvm::RelocDefault,
336 "dynamic-no-pic" => llvm::RelocDynamicNoPic,
338 sess.err(&format!("{:?} is not a valid relocation mode",
342 sess.abort_if_errors();
348 fn is_any_library(sess: &Session) -> bool {
349 sess.crate_types.borrow().iter().any(|ty| {
350 *ty != config::CrateTypeExecutable
354 pub fn is_pie_binary(sess: &Session) -> bool {
355 !is_any_library(sess) && get_reloc_model(sess) == llvm::RelocPIC
358 unsafe fn create_context_and_module(sess: &Session, mod_name: &str) -> (ContextRef, ModuleRef) {
359 let llcx = llvm::LLVMContextCreate();
360 let mod_name = CString::new(mod_name).unwrap();
361 let llmod = llvm::LLVMModuleCreateWithNameInContext(mod_name.as_ptr(), llcx);
363 // Ensure the data-layout values hardcoded remain the defaults.
364 if sess.target.target.options.is_builtin {
365 let tm = ::back::write::create_target_machine(sess);
366 llvm::LLVMRustSetDataLayoutFromTargetMachine(llmod, tm);
367 llvm::LLVMRustDisposeTargetMachine(tm);
369 let data_layout = llvm::LLVMGetDataLayout(llmod);
370 let data_layout = str::from_utf8(CStr::from_ptr(data_layout).to_bytes())
371 .ok().expect("got a non-UTF8 data-layout from LLVM");
373 // Unfortunately LLVM target specs change over time, and right now we
374 // don't have proper support to work with any more than one
375 // `data_layout` than the one that is in the rust-lang/rust repo. If
376 // this compiler is configured against a custom LLVM, we may have a
377 // differing data layout, even though we should update our own to use
380 // As an interim hack, if CFG_LLVM_ROOT is not an empty string then we
381 // disable this check entirely as we may be configured with something
382 // that has a different target layout.
384 // Unsure if this will actually cause breakage when rustc is configured
388 let cfg_llvm_root = option_env!("CFG_LLVM_ROOT").unwrap_or("");
389 let custom_llvm_used = cfg_llvm_root.trim() != "";
391 if !custom_llvm_used && sess.target.target.data_layout != data_layout {
392 bug!("data-layout for builtin `{}` target, `{}`, \
393 differs from LLVM default, `{}`",
394 sess.target.target.llvm_target,
395 sess.target.target.data_layout,
400 let data_layout = CString::new(&sess.target.target.data_layout[..]).unwrap();
401 llvm::LLVMSetDataLayout(llmod, data_layout.as_ptr());
403 let llvm_target = sess.target.target.llvm_target.as_bytes();
404 let llvm_target = CString::new(llvm_target).unwrap();
405 llvm::LLVMRustSetNormalizedTarget(llmod, llvm_target.as_ptr());
407 if is_pie_binary(sess) {
408 llvm::LLVMRustSetModulePIELevel(llmod);
414 impl<'b, 'tcx> SharedCrateContext<'b, 'tcx> {
415 pub fn new(tcx: TyCtxt<'b, 'tcx, 'tcx>,
416 mir_map: &'b MirMap<'tcx>,
417 export_map: ExportMap,
418 symbol_hasher: Sha256,
421 check_overflow: bool,
422 check_drop_flag_for_sanity: bool)
423 -> SharedCrateContext<'b, 'tcx> {
424 let (metadata_llcx, metadata_llmod) = unsafe {
425 create_context_and_module(&tcx.sess, "metadata")
428 // An interesting part of Windows which MSVC forces our hand on (and
429 // apparently MinGW didn't) is the usage of `dllimport` and `dllexport`
430 // attributes in LLVM IR as well as native dependencies (in C these
431 // correspond to `__declspec(dllimport)`).
433 // Whenever a dynamic library is built by MSVC it must have its public
434 // interface specified by functions tagged with `dllexport` or otherwise
435 // they're not available to be linked against. This poses a few problems
436 // for the compiler, some of which are somewhat fundamental, but we use
437 // the `use_dll_storage_attrs` variable below to attach the `dllexport`
438 // attribute to all LLVM functions that are reachable (e.g. they're
439 // already tagged with external linkage). This is suboptimal for a few
442 // * If an object file will never be included in a dynamic library,
443 // there's no need to attach the dllexport attribute. Most object
444 // files in Rust are not destined to become part of a dll as binaries
445 // are statically linked by default.
446 // * If the compiler is emitting both an rlib and a dylib, the same
447 // source object file is currently used but with MSVC this may be less
448 // feasible. The compiler may be able to get around this, but it may
449 // involve some invasive changes to deal with this.
451 // The flipside of this situation is that whenever you link to a dll and
452 // you import a function from it, the import should be tagged with
453 // `dllimport`. At this time, however, the compiler does not emit
454 // `dllimport` for any declarations other than constants (where it is
455 // required), which is again suboptimal for even more reasons!
457 // * Calling a function imported from another dll without using
458 // `dllimport` causes the linker/compiler to have extra overhead (one
459 // `jmp` instruction on x86) when calling the function.
460 // * The same object file may be used in different circumstances, so a
461 // function may be imported from a dll if the object is linked into a
462 // dll, but it may be just linked against if linked into an rlib.
463 // * The compiler has no knowledge about whether native functions should
464 // be tagged dllimport or not.
466 // For now the compiler takes the perf hit (I do not have any numbers to
467 // this effect) by marking very little as `dllimport` and praying the
468 // linker will take care of everything. Fixing this problem will likely
469 // require adding a few attributes to Rust itself (feature gated at the
470 // start) and then strongly recommending static linkage on MSVC!
471 let use_dll_storage_attrs = tcx.sess.target.target.options.is_like_msvc;
474 metadata_llmod: metadata_llmod,
475 metadata_llcx: metadata_llcx,
476 export_map: export_map,
477 reachable: reachable,
478 link_meta: link_meta,
479 symbol_hasher: RefCell::new(symbol_hasher),
482 mir_cache: RefCell::new(DefIdMap()),
484 n_glues_created: Cell::new(0),
485 n_null_glues: Cell::new(0),
486 n_real_glues: Cell::new(0),
487 n_fallback_instantiations: Cell::new(0),
489 n_monos: Cell::new(0),
490 n_inlines: Cell::new(0),
491 n_closures: Cell::new(0),
492 n_llvm_insns: Cell::new(0),
493 llvm_insns: RefCell::new(FnvHashMap()),
494 fn_stats: RefCell::new(Vec::new()),
496 check_overflow: check_overflow,
497 check_drop_flag_for_sanity: check_drop_flag_for_sanity,
498 use_dll_storage_attrs: use_dll_storage_attrs,
499 translation_items: RefCell::new(FnvHashSet()),
500 trait_cache: RefCell::new(DepTrackingMap::new(tcx.dep_graph.clone())),
504 pub fn metadata_llmod(&self) -> ModuleRef {
508 pub fn metadata_llcx(&self) -> ContextRef {
512 pub fn export_map<'a>(&'a self) -> &'a ExportMap {
516 pub fn reachable<'a>(&'a self) -> &'a NodeSet {
520 pub fn trait_cache(&self) -> &RefCell<DepTrackingMap<TraitSelectionCache<'tcx>>> {
524 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
528 pub fn tcx<'a>(&'a self) -> TyCtxt<'a, 'tcx, 'tcx> {
532 pub fn sess<'a>(&'a self) -> &'a Session {
536 pub fn stats<'a>(&'a self) -> &'a Stats {
540 pub fn use_dll_storage_attrs(&self) -> bool {
541 self.use_dll_storage_attrs
544 pub fn get_mir(&self, def_id: DefId) -> Option<CachedMir<'b, 'tcx>> {
545 if def_id.is_local() {
546 let node_id = self.tcx.map.as_local_node_id(def_id).unwrap();
547 self.mir_map.map.get(&node_id).map(CachedMir::Ref)
549 if let Some(mir) = self.mir_cache.borrow().get(&def_id).cloned() {
550 return Some(CachedMir::Owned(mir));
553 let mir = self.sess().cstore.maybe_get_item_mir(self.tcx, def_id);
554 let cached = mir.map(Rc::new);
555 if let Some(ref mir) = cached {
556 self.mir_cache.borrow_mut().insert(def_id, mir.clone());
558 cached.map(CachedMir::Owned)
562 pub fn translation_items(&self) -> &RefCell<FnvHashSet<TransItem<'tcx>>> {
563 &self.translation_items
566 /// Given the def-id of some item that has no type parameters, make
567 /// a suitable "empty substs" for it.
568 pub fn empty_substs_for_def_id(&self, item_def_id: DefId) -> &'tcx Substs<'tcx> {
569 let scheme = self.tcx().lookup_item_type(item_def_id);
570 self.empty_substs_for_scheme(&scheme)
573 pub fn empty_substs_for_scheme(&self, scheme: &ty::TypeScheme<'tcx>)
574 -> &'tcx Substs<'tcx> {
575 assert!(scheme.generics.types.is_empty());
576 self.tcx().mk_substs(
577 Substs::new(VecPerParamSpace::empty(),
578 scheme.generics.regions.map(|_| ty::ReErased)))
581 pub fn symbol_hasher(&self) -> &RefCell<Sha256> {
585 pub fn mir_map(&self) -> &MirMap<'tcx> {
589 pub fn metadata_symbol_name(&self) -> String {
590 format!("rust_metadata_{}_{}",
591 self.link_meta().crate_name,
592 self.link_meta().crate_hash)
596 impl<'tcx> LocalCrateContext<'tcx> {
597 fn new<'a>(shared: &SharedCrateContext<'a, 'tcx>,
598 codegen_unit: CodegenUnit<'tcx>,
599 previous_work_product: Option<WorkProduct>,
600 symbol_map: Rc<SymbolMap<'tcx>>)
601 -> LocalCrateContext<'tcx> {
603 // Append ".rs" to LLVM module identifier.
605 // LLVM code generator emits a ".file filename" directive
606 // for ELF backends. Value of the "filename" is set as the
607 // LLVM module identifier. Due to a LLVM MC bug[1], LLVM
608 // crashes if the module identifier is same as other symbols
609 // such as a function name in the module.
610 // 1. http://llvm.org/bugs/show_bug.cgi?id=11479
611 let llmod_id = format!("{}.rs", codegen_unit.name());
613 let (llcx, llmod) = create_context_and_module(&shared.tcx.sess,
616 let dbg_cx = if shared.tcx.sess.opts.debuginfo != NoDebugInfo {
617 let dctx = debuginfo::CrateDebugContext::new(llmod);
618 debuginfo::metadata::compile_unit_metadata(shared, &dctx, shared.tcx.sess);
624 let local_ccx = LocalCrateContext {
627 previous_work_product: previous_work_product,
628 codegen_unit: codegen_unit,
629 tn: TypeNames::new(),
630 needs_unwind_cleanup_cache: RefCell::new(FnvHashMap()),
631 fn_pointer_shims: RefCell::new(FnvHashMap()),
632 drop_glues: RefCell::new(FnvHashMap()),
633 external: RefCell::new(DefIdMap()),
634 external_srcs: RefCell::new(NodeMap()),
635 instances: RefCell::new(FnvHashMap()),
636 monomorphizing: RefCell::new(DefIdMap()),
637 vtables: RefCell::new(FnvHashMap()),
638 const_cstr_cache: RefCell::new(FnvHashMap()),
639 const_unsized: RefCell::new(FnvHashMap()),
640 const_globals: RefCell::new(FnvHashMap()),
641 const_values: RefCell::new(FnvHashMap()),
642 extern_const_values: RefCell::new(DefIdMap()),
643 statics: RefCell::new(FnvHashMap()),
644 impl_method_cache: RefCell::new(FnvHashMap()),
645 closure_bare_wrapper_cache: RefCell::new(FnvHashMap()),
646 statics_to_rauw: RefCell::new(Vec::new()),
647 lltypes: RefCell::new(FnvHashMap()),
648 llsizingtypes: RefCell::new(FnvHashMap()),
649 adt_reprs: RefCell::new(FnvHashMap()),
650 type_hashcodes: RefCell::new(FnvHashMap()),
651 int_type: Type::from_ref(ptr::null_mut()),
652 opaque_vec_type: Type::from_ref(ptr::null_mut()),
653 builder: BuilderRef_res(llvm::LLVMCreateBuilderInContext(llcx)),
654 closure_vals: RefCell::new(FnvHashMap()),
656 eh_personality: Cell::new(None),
657 eh_unwind_resume: Cell::new(None),
658 rust_try_fn: Cell::new(None),
659 intrinsics: RefCell::new(FnvHashMap()),
660 n_llvm_insns: Cell::new(0),
661 type_of_depth: Cell::new(0),
662 symbol_map: symbol_map,
665 let (int_type, opaque_vec_type, str_slice_ty, mut local_ccx) = {
666 // Do a little dance to create a dummy CrateContext, so we can
667 // create some things in the LLVM module of this codegen unit
668 let mut local_ccxs = vec![local_ccx];
669 let (int_type, opaque_vec_type, str_slice_ty) = {
670 let dummy_ccx = LocalCrateContext::dummy_ccx(shared,
671 local_ccxs.as_mut_slice());
672 let mut str_slice_ty = Type::named_struct(&dummy_ccx, "str_slice");
673 str_slice_ty.set_struct_body(&[Type::i8p(&dummy_ccx),
674 Type::int(&dummy_ccx)],
676 (Type::int(&dummy_ccx), Type::opaque_vec(&dummy_ccx), str_slice_ty)
678 (int_type, opaque_vec_type, str_slice_ty, local_ccxs.pop().unwrap())
681 local_ccx.int_type = int_type;
682 local_ccx.opaque_vec_type = opaque_vec_type;
683 local_ccx.tn.associate_type("str_slice", &str_slice_ty);
685 if shared.tcx.sess.count_llvm_insns() {
686 base::init_insn_ctxt()
693 /// Create a dummy `CrateContext` from `self` and the provided
694 /// `SharedCrateContext`. This is somewhat dangerous because `self` may
695 /// not be fully initialized.
697 /// This is used in the `LocalCrateContext` constructor to allow calling
698 /// functions that expect a complete `CrateContext`, even before the local
699 /// portion is fully initialized and attached to the `SharedCrateContext`.
700 fn dummy_ccx<'a>(shared: &'a SharedCrateContext<'a, 'tcx>,
701 local_ccxs: &'a [LocalCrateContext<'tcx>])
702 -> CrateContext<'a, 'tcx> {
703 assert!(local_ccxs.len() == 1);
707 local_ccxs: local_ccxs
712 impl<'b, 'tcx> CrateContext<'b, 'tcx> {
713 pub fn shared(&self) -> &'b SharedCrateContext<'b, 'tcx> {
717 pub fn local(&self) -> &'b LocalCrateContext<'tcx> {
718 &self.local_ccxs[self.index]
721 /// Get a (possibly) different `CrateContext` from the same
722 /// `SharedCrateContext`.
723 pub fn rotate(&'b self) -> CrateContext<'b, 'tcx> {
727 .zip(0..self.local_ccxs.len())
728 .min_by_key(|&(local_ccx, _idx)| local_ccx.n_llvm_insns.get())
733 local_ccxs: &self.local_ccxs[..],
737 /// Either iterate over only `self`, or iterate over all `CrateContext`s in
738 /// the `SharedCrateContext`. The iterator produces `(ccx, is_origin)`
739 /// pairs, where `is_origin` is `true` if `ccx` is `self` and `false`
740 /// otherwise. This method is useful for avoiding code duplication in
741 /// cases where it may or may not be necessary to translate code into every
743 pub fn maybe_iter(&self, iter_all: bool) -> CrateContextMaybeIterator<'b, 'tcx> {
744 CrateContextMaybeIterator {
746 index: if iter_all { 0 } else { self.index },
749 local_ccxs: self.local_ccxs,
753 pub fn tcx<'a>(&'a self) -> TyCtxt<'a, 'tcx, 'tcx> {
757 pub fn sess<'a>(&'a self) -> &'a Session {
758 &self.shared.tcx.sess
761 pub fn builder<'a>(&'a self) -> Builder<'a, 'tcx> {
765 pub fn raw_builder<'a>(&'a self) -> BuilderRef {
766 self.local().builder.b
769 pub fn get_intrinsic(&self, key: &str) -> ValueRef {
770 if let Some(v) = self.intrinsics().borrow().get(key).cloned() {
773 match declare_intrinsic(self, key) {
775 None => bug!("unknown intrinsic '{}'", key)
779 pub fn llmod(&self) -> ModuleRef {
783 pub fn llcx(&self) -> ContextRef {
787 pub fn previous_work_product(&self) -> Option<&WorkProduct> {
788 self.local().previous_work_product.as_ref()
791 pub fn codegen_unit(&self) -> &CodegenUnit<'tcx> {
792 &self.local().codegen_unit
795 pub fn td(&self) -> llvm::TargetDataRef {
796 unsafe { llvm::LLVMRustGetModuleDataLayout(self.llmod()) }
799 pub fn tn<'a>(&'a self) -> &'a TypeNames {
803 pub fn export_map<'a>(&'a self) -> &'a ExportMap {
804 &self.shared.export_map
807 pub fn reachable<'a>(&'a self) -> &'a NodeSet {
808 &self.shared.reachable
811 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
812 &self.shared.link_meta
815 pub fn needs_unwind_cleanup_cache(&self) -> &RefCell<FnvHashMap<Ty<'tcx>, bool>> {
816 &self.local().needs_unwind_cleanup_cache
819 pub fn fn_pointer_shims(&self) -> &RefCell<FnvHashMap<Ty<'tcx>, ValueRef>> {
820 &self.local().fn_pointer_shims
823 pub fn drop_glues<'a>(&'a self)
824 -> &'a RefCell<FnvHashMap<DropGlueKind<'tcx>, (ValueRef, FnType)>> {
825 &self.local().drop_glues
828 pub fn external<'a>(&'a self) -> &'a RefCell<DefIdMap<Option<ast::NodeId>>> {
829 &self.local().external
832 pub fn external_srcs<'a>(&'a self) -> &'a RefCell<NodeMap<DefId>> {
833 &self.local().external_srcs
836 pub fn instances<'a>(&'a self) -> &'a RefCell<FnvHashMap<Instance<'tcx>, ValueRef>> {
837 &self.local().instances
840 pub fn monomorphizing<'a>(&'a self) -> &'a RefCell<DefIdMap<usize>> {
841 &self.local().monomorphizing
844 pub fn vtables<'a>(&'a self) -> &'a RefCell<FnvHashMap<ty::PolyTraitRef<'tcx>, ValueRef>> {
845 &self.local().vtables
848 pub fn const_cstr_cache<'a>(&'a self) -> &'a RefCell<FnvHashMap<InternedString, ValueRef>> {
849 &self.local().const_cstr_cache
852 pub fn const_unsized<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
853 &self.local().const_unsized
856 pub fn const_globals<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
857 &self.local().const_globals
860 pub fn const_values<'a>(&'a self) -> &'a RefCell<FnvHashMap<(ast::NodeId, &'tcx Substs<'tcx>),
862 &self.local().const_values
865 pub fn extern_const_values<'a>(&'a self) -> &'a RefCell<DefIdMap<ValueRef>> {
866 &self.local().extern_const_values
869 pub fn statics<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, DefId>> {
870 &self.local().statics
873 pub fn impl_method_cache<'a>(&'a self)
874 -> &'a RefCell<FnvHashMap<(DefId, ast::Name), DefId>> {
875 &self.local().impl_method_cache
878 pub fn closure_bare_wrapper_cache<'a>(&'a self) -> &'a RefCell<FnvHashMap<ValueRef, ValueRef>> {
879 &self.local().closure_bare_wrapper_cache
882 pub fn statics_to_rauw<'a>(&'a self) -> &'a RefCell<Vec<(ValueRef, ValueRef)>> {
883 &self.local().statics_to_rauw
886 pub fn lltypes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Type>> {
887 &self.local().lltypes
890 pub fn llsizingtypes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Type>> {
891 &self.local().llsizingtypes
894 pub fn adt_reprs<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, Rc<adt::Repr<'tcx>>>> {
895 &self.local().adt_reprs
898 pub fn symbol_hasher<'a>(&'a self) -> &'a RefCell<Sha256> {
899 &self.shared.symbol_hasher
902 pub fn type_hashcodes<'a>(&'a self) -> &'a RefCell<FnvHashMap<Ty<'tcx>, String>> {
903 &self.local().type_hashcodes
906 pub fn stats<'a>(&'a self) -> &'a Stats {
910 pub fn int_type(&self) -> Type {
911 self.local().int_type
914 pub fn opaque_vec_type(&self) -> Type {
915 self.local().opaque_vec_type
918 pub fn closure_vals<'a>(&'a self) -> &'a RefCell<FnvHashMap<Instance<'tcx>, ValueRef>> {
919 &self.local().closure_vals
922 pub fn dbg_cx<'a>(&'a self) -> &'a Option<debuginfo::CrateDebugContext<'tcx>> {
926 pub fn eh_personality<'a>(&'a self) -> &'a Cell<Option<ValueRef>> {
927 &self.local().eh_personality
930 pub fn eh_unwind_resume<'a>(&'a self) -> &'a Cell<Option<ValueRef>> {
931 &self.local().eh_unwind_resume
934 pub fn rust_try_fn<'a>(&'a self) -> &'a Cell<Option<ValueRef>> {
935 &self.local().rust_try_fn
938 fn intrinsics<'a>(&'a self) -> &'a RefCell<FnvHashMap<&'static str, ValueRef>> {
939 &self.local().intrinsics
942 pub fn count_llvm_insn(&self) {
943 self.local().n_llvm_insns.set(self.local().n_llvm_insns.get() + 1);
946 pub fn obj_size_bound(&self) -> u64 {
947 self.tcx().data_layout.obj_size_bound()
950 pub fn report_overbig_object(&self, obj: Ty<'tcx>) -> ! {
952 &format!("the type `{:?}` is too big for the current architecture",
956 pub fn enter_type_of(&self, ty: Ty<'tcx>) -> TypeOfDepthLock<'b, 'tcx> {
957 let current_depth = self.local().type_of_depth.get();
958 debug!("enter_type_of({:?}) at depth {:?}", ty, current_depth);
959 if current_depth > self.sess().recursion_limit.get() {
961 &format!("overflow representing the type `{}`", ty))
963 self.local().type_of_depth.set(current_depth + 1);
964 TypeOfDepthLock(self.local())
967 pub fn check_overflow(&self) -> bool {
968 self.shared.check_overflow
971 pub fn check_drop_flag_for_sanity(&self) -> bool {
972 // This controls whether we emit a conditional llvm.debugtrap
973 // guarded on whether the dropflag is one of its (two) valid
975 self.shared.check_drop_flag_for_sanity
978 pub fn use_dll_storage_attrs(&self) -> bool {
979 self.shared.use_dll_storage_attrs()
982 pub fn get_mir(&self, def_id: DefId) -> Option<CachedMir<'b, 'tcx>> {
983 self.shared.get_mir(def_id)
986 pub fn symbol_map(&self) -> &SymbolMap<'tcx> {
987 &*self.local().symbol_map
990 pub fn translation_items(&self) -> &RefCell<FnvHashSet<TransItem<'tcx>>> {
991 &self.shared.translation_items
994 /// Given the def-id of some item that has no type parameters, make
995 /// a suitable "empty substs" for it.
996 pub fn empty_substs_for_def_id(&self, item_def_id: DefId) -> &'tcx Substs<'tcx> {
997 self.shared().empty_substs_for_def_id(item_def_id)
1000 pub fn empty_substs_for_scheme(&self, scheme: &ty::TypeScheme<'tcx>)
1001 -> &'tcx Substs<'tcx> {
1002 self.shared().empty_substs_for_scheme(scheme)
1006 pub struct TypeOfDepthLock<'a, 'tcx: 'a>(&'a LocalCrateContext<'tcx>);
1008 impl<'a, 'tcx> Drop for TypeOfDepthLock<'a, 'tcx> {
1009 fn drop(&mut self) {
1010 self.0.type_of_depth.set(self.0.type_of_depth.get() - 1);
1014 /// Declare any llvm intrinsics that you might need
1015 fn declare_intrinsic(ccx: &CrateContext, key: &str) -> Option<ValueRef> {
1017 ($name:expr, fn() -> $ret:expr) => (
1019 let f = declare::declare_cfn(ccx, $name, Type::func(&[], &$ret));
1020 llvm::SetUnnamedAddr(f, false);
1021 ccx.intrinsics().borrow_mut().insert($name, f.clone());
1025 ($name:expr, fn(...) -> $ret:expr) => (
1027 let f = declare::declare_cfn(ccx, $name, Type::variadic_func(&[], &$ret));
1028 llvm::SetUnnamedAddr(f, false);
1029 ccx.intrinsics().borrow_mut().insert($name, f.clone());
1033 ($name:expr, fn($($arg:expr),*) -> $ret:expr) => (
1035 let f = declare::declare_cfn(ccx, $name, Type::func(&[$($arg),*], &$ret));
1036 llvm::SetUnnamedAddr(f, false);
1037 ccx.intrinsics().borrow_mut().insert($name, f.clone());
1042 macro_rules! mk_struct {
1043 ($($field_ty:expr),*) => (Type::struct_(ccx, &[$($field_ty),*], false))
1046 let i8p = Type::i8p(ccx);
1047 let void = Type::void(ccx);
1048 let i1 = Type::i1(ccx);
1049 let t_i8 = Type::i8(ccx);
1050 let t_i16 = Type::i16(ccx);
1051 let t_i32 = Type::i32(ccx);
1052 let t_i64 = Type::i64(ccx);
1053 let t_f32 = Type::f32(ccx);
1054 let t_f64 = Type::f64(ccx);
1056 ifn!("llvm.memcpy.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
1057 ifn!("llvm.memcpy.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
1058 ifn!("llvm.memcpy.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
1059 ifn!("llvm.memmove.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
1060 ifn!("llvm.memmove.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
1061 ifn!("llvm.memmove.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
1062 ifn!("llvm.memset.p0i8.i16", fn(i8p, t_i8, t_i16, t_i32, i1) -> void);
1063 ifn!("llvm.memset.p0i8.i32", fn(i8p, t_i8, t_i32, t_i32, i1) -> void);
1064 ifn!("llvm.memset.p0i8.i64", fn(i8p, t_i8, t_i64, t_i32, i1) -> void);
1066 ifn!("llvm.trap", fn() -> void);
1067 ifn!("llvm.debugtrap", fn() -> void);
1068 ifn!("llvm.frameaddress", fn(t_i32) -> i8p);
1070 ifn!("llvm.powi.f32", fn(t_f32, t_i32) -> t_f32);
1071 ifn!("llvm.powi.f64", fn(t_f64, t_i32) -> t_f64);
1072 ifn!("llvm.pow.f32", fn(t_f32, t_f32) -> t_f32);
1073 ifn!("llvm.pow.f64", fn(t_f64, t_f64) -> t_f64);
1075 ifn!("llvm.sqrt.f32", fn(t_f32) -> t_f32);
1076 ifn!("llvm.sqrt.f64", fn(t_f64) -> t_f64);
1077 ifn!("llvm.sin.f32", fn(t_f32) -> t_f32);
1078 ifn!("llvm.sin.f64", fn(t_f64) -> t_f64);
1079 ifn!("llvm.cos.f32", fn(t_f32) -> t_f32);
1080 ifn!("llvm.cos.f64", fn(t_f64) -> t_f64);
1081 ifn!("llvm.exp.f32", fn(t_f32) -> t_f32);
1082 ifn!("llvm.exp.f64", fn(t_f64) -> t_f64);
1083 ifn!("llvm.exp2.f32", fn(t_f32) -> t_f32);
1084 ifn!("llvm.exp2.f64", fn(t_f64) -> t_f64);
1085 ifn!("llvm.log.f32", fn(t_f32) -> t_f32);
1086 ifn!("llvm.log.f64", fn(t_f64) -> t_f64);
1087 ifn!("llvm.log10.f32", fn(t_f32) -> t_f32);
1088 ifn!("llvm.log10.f64", fn(t_f64) -> t_f64);
1089 ifn!("llvm.log2.f32", fn(t_f32) -> t_f32);
1090 ifn!("llvm.log2.f64", fn(t_f64) -> t_f64);
1092 ifn!("llvm.fma.f32", fn(t_f32, t_f32, t_f32) -> t_f32);
1093 ifn!("llvm.fma.f64", fn(t_f64, t_f64, t_f64) -> t_f64);
1095 ifn!("llvm.fabs.f32", fn(t_f32) -> t_f32);
1096 ifn!("llvm.fabs.f64", fn(t_f64) -> t_f64);
1098 ifn!("llvm.floor.f32", fn(t_f32) -> t_f32);
1099 ifn!("llvm.floor.f64", fn(t_f64) -> t_f64);
1100 ifn!("llvm.ceil.f32", fn(t_f32) -> t_f32);
1101 ifn!("llvm.ceil.f64", fn(t_f64) -> t_f64);
1102 ifn!("llvm.trunc.f32", fn(t_f32) -> t_f32);
1103 ifn!("llvm.trunc.f64", fn(t_f64) -> t_f64);
1105 ifn!("llvm.copysign.f32", fn(t_f32, t_f32) -> t_f32);
1106 ifn!("llvm.copysign.f64", fn(t_f64, t_f64) -> t_f64);
1107 ifn!("llvm.round.f32", fn(t_f32) -> t_f32);
1108 ifn!("llvm.round.f64", fn(t_f64) -> t_f64);
1110 ifn!("llvm.rint.f32", fn(t_f32) -> t_f32);
1111 ifn!("llvm.rint.f64", fn(t_f64) -> t_f64);
1112 ifn!("llvm.nearbyint.f32", fn(t_f32) -> t_f32);
1113 ifn!("llvm.nearbyint.f64", fn(t_f64) -> t_f64);
1115 ifn!("llvm.ctpop.i8", fn(t_i8) -> t_i8);
1116 ifn!("llvm.ctpop.i16", fn(t_i16) -> t_i16);
1117 ifn!("llvm.ctpop.i32", fn(t_i32) -> t_i32);
1118 ifn!("llvm.ctpop.i64", fn(t_i64) -> t_i64);
1120 ifn!("llvm.ctlz.i8", fn(t_i8 , i1) -> t_i8);
1121 ifn!("llvm.ctlz.i16", fn(t_i16, i1) -> t_i16);
1122 ifn!("llvm.ctlz.i32", fn(t_i32, i1) -> t_i32);
1123 ifn!("llvm.ctlz.i64", fn(t_i64, i1) -> t_i64);
1125 ifn!("llvm.cttz.i8", fn(t_i8 , i1) -> t_i8);
1126 ifn!("llvm.cttz.i16", fn(t_i16, i1) -> t_i16);
1127 ifn!("llvm.cttz.i32", fn(t_i32, i1) -> t_i32);
1128 ifn!("llvm.cttz.i64", fn(t_i64, i1) -> t_i64);
1130 ifn!("llvm.bswap.i16", fn(t_i16) -> t_i16);
1131 ifn!("llvm.bswap.i32", fn(t_i32) -> t_i32);
1132 ifn!("llvm.bswap.i64", fn(t_i64) -> t_i64);
1134 ifn!("llvm.sadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1135 ifn!("llvm.sadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1136 ifn!("llvm.sadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1137 ifn!("llvm.sadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1139 ifn!("llvm.uadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1140 ifn!("llvm.uadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1141 ifn!("llvm.uadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1142 ifn!("llvm.uadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1144 ifn!("llvm.ssub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1145 ifn!("llvm.ssub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1146 ifn!("llvm.ssub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1147 ifn!("llvm.ssub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1149 ifn!("llvm.usub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1150 ifn!("llvm.usub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1151 ifn!("llvm.usub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1152 ifn!("llvm.usub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1154 ifn!("llvm.smul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1155 ifn!("llvm.smul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1156 ifn!("llvm.smul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1157 ifn!("llvm.smul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1159 ifn!("llvm.umul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1160 ifn!("llvm.umul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1161 ifn!("llvm.umul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1162 ifn!("llvm.umul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1164 ifn!("llvm.lifetime.start", fn(t_i64,i8p) -> void);
1165 ifn!("llvm.lifetime.end", fn(t_i64, i8p) -> void);
1167 ifn!("llvm.expect.i1", fn(i1, i1) -> i1);
1168 ifn!("llvm.eh.typeid.for", fn(i8p) -> t_i32);
1169 ifn!("llvm.localescape", fn(...) -> void);
1170 ifn!("llvm.localrecover", fn(i8p, i8p, t_i32) -> i8p);
1171 ifn!("llvm.x86.seh.recoverfp", fn(i8p, i8p) -> i8p);
1173 ifn!("llvm.assume", fn(i1) -> void);
1175 if ccx.sess().opts.debuginfo != NoDebugInfo {
1176 ifn!("llvm.dbg.declare", fn(Type::metadata(ccx), Type::metadata(ccx)) -> void);
1177 ifn!("llvm.dbg.value", fn(Type::metadata(ccx), t_i64, Type::metadata(ccx)) -> void);