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};
13 use rustc::dep_graph::{DepGraph, DepGraphSafe, DepNode, DepTrackingMap,
14 DepTrackingMapConfig, WorkProduct};
15 use middle::cstore::LinkMeta;
17 use rustc::hir::def_id::DefId;
23 use monomorphize::Instance;
25 use partitioning::CodegenUnit;
26 use trans_item::TransItem;
28 use rustc_data_structures::base_n;
29 use rustc::ty::subst::Substs;
30 use rustc::ty::{self, Ty, TyCtxt};
31 use session::config::NoDebugInfo;
34 use symbol_map::SymbolMap;
35 use util::nodemap::{NodeSet, DefIdMap, FxHashMap, FxHashSet};
37 use std::ffi::{CStr, CString};
38 use std::cell::{Cell, RefCell};
39 use std::marker::PhantomData;
45 use syntax::symbol::InternedString;
46 use syntax_pos::DUMMY_SP;
50 pub n_glues_created: Cell<usize>,
51 pub n_null_glues: Cell<usize>,
52 pub n_real_glues: Cell<usize>,
53 pub n_fns: Cell<usize>,
54 pub n_inlines: Cell<usize>,
55 pub n_closures: Cell<usize>,
56 pub n_llvm_insns: Cell<usize>,
57 pub llvm_insns: RefCell<FxHashMap<String, usize>>,
58 // (ident, llvm-instructions)
59 pub fn_stats: RefCell<Vec<(String, usize)> >,
62 /// The shared portion of a `CrateContext`. There is one `SharedCrateContext`
63 /// per crate. The data here is shared between all compilation units of the
64 /// crate, so it must not contain references to any LLVM data structures
65 /// (aside from metadata-related ones).
66 pub struct SharedCrateContext<'a, 'tcx: 'a> {
67 metadata_llmod: ModuleRef,
68 metadata_llcx: ContextRef,
70 exported_symbols: NodeSet,
72 tcx: TyCtxt<'a, 'tcx, 'tcx>,
73 empty_param_env: ty::ParameterEnvironment<'tcx>,
77 use_dll_storage_attrs: bool,
79 translation_items: RefCell<FxHashSet<TransItem<'tcx>>>,
80 trait_cache: RefCell<DepTrackingMap<TraitSelectionCache<'tcx>>>,
81 project_cache: RefCell<DepTrackingMap<ProjectionCache<'tcx>>>,
84 /// The local portion of a `CrateContext`. There is one `LocalCrateContext`
85 /// per compilation unit. Each one has its own LLVM `ContextRef` so that
86 /// several compilation units may be optimized in parallel. All other LLVM
87 /// data structures in the `LocalCrateContext` are tied to that `ContextRef`.
88 pub struct LocalCrateContext<'tcx> {
91 previous_work_product: Option<WorkProduct>,
92 codegen_unit: CodegenUnit<'tcx>,
93 needs_unwind_cleanup_cache: RefCell<FxHashMap<Ty<'tcx>, bool>>,
94 /// Cache instances of monomorphic and polymorphic items
95 instances: RefCell<FxHashMap<Instance<'tcx>, ValueRef>>,
96 /// Cache generated vtables
97 vtables: RefCell<FxHashMap<(ty::Ty<'tcx>,
98 Option<ty::PolyExistentialTraitRef<'tcx>>), ValueRef>>,
99 /// Cache of constant strings,
100 const_cstr_cache: RefCell<FxHashMap<InternedString, ValueRef>>,
102 /// Reverse-direction for const ptrs cast from globals.
103 /// Key is a ValueRef holding a *T,
104 /// Val is a ValueRef holding a *[T].
106 /// Needed because LLVM loses pointer->pointee association
107 /// when we ptrcast, and we have to ptrcast during translation
108 /// of a [T] const because we form a slice, a (*T,usize) pair, not
109 /// a pointer to an LLVM array type. Similar for trait objects.
110 const_unsized: RefCell<FxHashMap<ValueRef, ValueRef>>,
112 /// Cache of emitted const globals (value -> global)
113 const_globals: RefCell<FxHashMap<ValueRef, ValueRef>>,
115 /// Cache of emitted const values
116 const_values: RefCell<FxHashMap<(ast::NodeId, &'tcx Substs<'tcx>), ValueRef>>,
118 /// Cache of external const values
119 extern_const_values: RefCell<DefIdMap<ValueRef>>,
121 /// Mapping from static definitions to their DefId's.
122 statics: RefCell<FxHashMap<ValueRef, DefId>>,
124 impl_method_cache: RefCell<FxHashMap<(DefId, ast::Name), DefId>>,
126 /// Cache of closure wrappers for bare fn's.
127 closure_bare_wrapper_cache: RefCell<FxHashMap<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 /// Statics that will be placed in the llvm.used variable
136 /// See http://llvm.org/docs/LangRef.html#the-llvm-used-global-variable for details
137 used_statics: RefCell<Vec<ValueRef>>,
139 lltypes: RefCell<FxHashMap<Ty<'tcx>, Type>>,
140 llsizingtypes: RefCell<FxHashMap<Ty<'tcx>, Type>>,
141 type_hashcodes: RefCell<FxHashMap<Ty<'tcx>, String>>,
143 opaque_vec_type: Type,
144 str_slice_type: Type,
146 /// Holds the LLVM values for closure IDs.
147 closure_vals: RefCell<FxHashMap<Instance<'tcx>, ValueRef>>,
149 dbg_cx: Option<debuginfo::CrateDebugContext<'tcx>>,
151 eh_personality: Cell<Option<ValueRef>>,
152 eh_unwind_resume: Cell<Option<ValueRef>>,
153 rust_try_fn: Cell<Option<ValueRef>>,
155 intrinsics: RefCell<FxHashMap<&'static str, ValueRef>>,
157 /// Depth of the current type-of computation - used to bail out
158 type_of_depth: Cell<usize>,
160 symbol_map: Rc<SymbolMap<'tcx>>,
162 /// A counter that is used for generating local symbol names
163 local_gen_sym_counter: Cell<usize>,
166 // Implement DepTrackingMapConfig for `trait_cache`
167 pub struct TraitSelectionCache<'tcx> {
168 data: PhantomData<&'tcx ()>
171 impl<'tcx> DepTrackingMapConfig for TraitSelectionCache<'tcx> {
172 type Key = ty::PolyTraitRef<'tcx>;
173 type Value = traits::Vtable<'tcx, ()>;
174 fn to_dep_node(key: &ty::PolyTraitRef<'tcx>) -> DepNode<DefId> {
175 key.to_poly_trait_predicate().dep_node()
181 pub struct ProjectionCache<'gcx> {
182 data: PhantomData<&'gcx ()>
185 impl<'gcx> DepTrackingMapConfig for ProjectionCache<'gcx> {
187 type Value = Ty<'gcx>;
188 fn to_dep_node(key: &Self::Key) -> DepNode<DefId> {
189 // Ideally, we'd just put `key` into the dep-node, but we
190 // can't put full types in there. So just collect up all the
191 // def-ids of structs/enums as well as any traits that we
192 // project out of. It doesn't matter so much what we do here,
193 // except that if we are too coarse, we'll create overly
194 // coarse edges between impls and the trans. For example, if
195 // we just used the def-id of things we are projecting out of,
196 // then the key for `<Foo as SomeTrait>::T` and `<Bar as
197 // SomeTrait>::T` would both share a dep-node
198 // (`TraitSelect(SomeTrait)`), and hence the impls for both
199 // `Foo` and `Bar` would be considered inputs. So a change to
200 // `Bar` would affect things that just normalized `Foo`.
201 // Anyway, this heuristic is not ideal, but better than
203 let def_ids: Vec<DefId> =
205 .filter_map(|t| match t.sty {
206 ty::TyAdt(adt_def, _) => Some(adt_def.did),
207 ty::TyProjection(ref proj) => Some(proj.trait_ref.def_id),
212 DepNode::ProjectionCache { def_ids: def_ids }
216 /// This list owns a number of LocalCrateContexts and binds them to their common
217 /// SharedCrateContext. This type just exists as a convenience, something to
218 /// pass around all LocalCrateContexts with and get an iterator over them.
219 pub struct CrateContextList<'a, 'tcx: 'a> {
220 shared: &'a SharedCrateContext<'a, 'tcx>,
221 local_ccxs: Vec<LocalCrateContext<'tcx>>,
224 impl<'a, 'tcx: 'a> CrateContextList<'a, 'tcx> {
225 pub fn new(shared_ccx: &'a SharedCrateContext<'a, 'tcx>,
226 codegen_units: Vec<CodegenUnit<'tcx>>,
227 previous_work_products: Vec<Option<WorkProduct>>,
228 symbol_map: Rc<SymbolMap<'tcx>>)
229 -> CrateContextList<'a, 'tcx> {
232 local_ccxs: codegen_units.into_iter().zip(previous_work_products).map(|(cgu, wp)| {
233 LocalCrateContext::new(shared_ccx, cgu, wp, symbol_map.clone())
238 /// Iterate over all crate contexts, whether or not they need
239 /// translation. That is, whether or not a `.o` file is available
240 /// for re-use from a previous incr. comp.).
241 pub fn iter_all<'b>(&'b self) -> CrateContextIterator<'b, 'tcx> {
242 CrateContextIterator {
245 local_ccxs: &self.local_ccxs[..],
246 filter_to_previous_work_product_unavail: false,
250 /// Iterator over all CCX that need translation (cannot reuse results from
251 /// previous incr. comp.).
252 pub fn iter_need_trans<'b>(&'b self) -> CrateContextIterator<'b, 'tcx> {
253 CrateContextIterator {
256 local_ccxs: &self.local_ccxs[..],
257 filter_to_previous_work_product_unavail: true,
261 pub fn shared(&self) -> &'a SharedCrateContext<'a, 'tcx> {
266 /// A CrateContext value binds together one LocalCrateContext with the
267 /// SharedCrateContext. It exists as a convenience wrapper, so we don't have to
268 /// pass around (SharedCrateContext, LocalCrateContext) tuples all over trans.
269 pub struct CrateContext<'a, 'tcx: 'a> {
270 shared: &'a SharedCrateContext<'a, 'tcx>,
271 local_ccxs: &'a [LocalCrateContext<'tcx>],
272 /// The index of `local` in `local_ccxs`. This is used in
273 /// `maybe_iter(true)` to identify the original `LocalCrateContext`.
277 impl<'a, 'tcx> DepGraphSafe for CrateContext<'a, 'tcx> {
280 pub struct CrateContextIterator<'a, 'tcx: 'a> {
281 shared: &'a SharedCrateContext<'a, 'tcx>,
282 local_ccxs: &'a [LocalCrateContext<'tcx>],
285 /// if true, only return results where `previous_work_product` is none
286 filter_to_previous_work_product_unavail: bool,
289 impl<'a, 'tcx> Iterator for CrateContextIterator<'a,'tcx> {
290 type Item = CrateContext<'a, 'tcx>;
292 fn next(&mut self) -> Option<CrateContext<'a, 'tcx>> {
294 if self.index >= self.local_ccxs.len() {
298 let index = self.index;
301 let ccx = CrateContext {
304 local_ccxs: self.local_ccxs,
308 self.filter_to_previous_work_product_unavail &&
309 ccx.previous_work_product().is_some()
319 pub fn get_reloc_model(sess: &Session) -> llvm::RelocMode {
320 let reloc_model_arg = match sess.opts.cg.relocation_model {
321 Some(ref s) => &s[..],
322 None => &sess.target.target.options.relocation_model[..],
325 match ::back::write::RELOC_MODEL_ARGS.iter().find(
326 |&&arg| arg.0 == reloc_model_arg) {
329 sess.err(&format!("{:?} is not a valid relocation mode",
333 sess.abort_if_errors();
339 fn is_any_library(sess: &Session) -> bool {
340 sess.crate_types.borrow().iter().any(|ty| {
341 *ty != config::CrateTypeExecutable
345 pub fn is_pie_binary(sess: &Session) -> bool {
346 !is_any_library(sess) && get_reloc_model(sess) == llvm::RelocMode::PIC
349 unsafe fn create_context_and_module(sess: &Session, mod_name: &str) -> (ContextRef, ModuleRef) {
350 let llcx = llvm::LLVMContextCreate();
351 let mod_name = CString::new(mod_name).unwrap();
352 let llmod = llvm::LLVMModuleCreateWithNameInContext(mod_name.as_ptr(), llcx);
354 // Ensure the data-layout values hardcoded remain the defaults.
355 if sess.target.target.options.is_builtin {
356 let tm = ::back::write::create_target_machine(sess);
357 llvm::LLVMRustSetDataLayoutFromTargetMachine(llmod, tm);
358 llvm::LLVMRustDisposeTargetMachine(tm);
360 let data_layout = llvm::LLVMGetDataLayout(llmod);
361 let data_layout = str::from_utf8(CStr::from_ptr(data_layout).to_bytes())
362 .ok().expect("got a non-UTF8 data-layout from LLVM");
364 // Unfortunately LLVM target specs change over time, and right now we
365 // don't have proper support to work with any more than one
366 // `data_layout` than the one that is in the rust-lang/rust repo. If
367 // this compiler is configured against a custom LLVM, we may have a
368 // differing data layout, even though we should update our own to use
371 // As an interim hack, if CFG_LLVM_ROOT is not an empty string then we
372 // disable this check entirely as we may be configured with something
373 // that has a different target layout.
375 // Unsure if this will actually cause breakage when rustc is configured
379 let cfg_llvm_root = option_env!("CFG_LLVM_ROOT").unwrap_or("");
380 let custom_llvm_used = cfg_llvm_root.trim() != "";
382 if !custom_llvm_used && sess.target.target.data_layout != data_layout {
383 bug!("data-layout for builtin `{}` target, `{}`, \
384 differs from LLVM default, `{}`",
385 sess.target.target.llvm_target,
386 sess.target.target.data_layout,
391 let data_layout = CString::new(&sess.target.target.data_layout[..]).unwrap();
392 llvm::LLVMSetDataLayout(llmod, data_layout.as_ptr());
394 let llvm_target = sess.target.target.llvm_target.as_bytes();
395 let llvm_target = CString::new(llvm_target).unwrap();
396 llvm::LLVMRustSetNormalizedTarget(llmod, llvm_target.as_ptr());
398 if is_pie_binary(sess) {
399 llvm::LLVMRustSetModulePIELevel(llmod);
405 impl<'b, 'tcx> SharedCrateContext<'b, 'tcx> {
406 pub fn new(tcx: TyCtxt<'b, 'tcx, 'tcx>,
408 exported_symbols: NodeSet,
409 check_overflow: bool)
410 -> SharedCrateContext<'b, 'tcx> {
411 let (metadata_llcx, metadata_llmod) = unsafe {
412 create_context_and_module(&tcx.sess, "metadata")
415 // An interesting part of Windows which MSVC forces our hand on (and
416 // apparently MinGW didn't) is the usage of `dllimport` and `dllexport`
417 // attributes in LLVM IR as well as native dependencies (in C these
418 // correspond to `__declspec(dllimport)`).
420 // Whenever a dynamic library is built by MSVC it must have its public
421 // interface specified by functions tagged with `dllexport` or otherwise
422 // they're not available to be linked against. This poses a few problems
423 // for the compiler, some of which are somewhat fundamental, but we use
424 // the `use_dll_storage_attrs` variable below to attach the `dllexport`
425 // attribute to all LLVM functions that are exported e.g. they're
426 // already tagged with external linkage). This is suboptimal for a few
429 // * If an object file will never be included in a dynamic library,
430 // there's no need to attach the dllexport attribute. Most object
431 // files in Rust are not destined to become part of a dll as binaries
432 // are statically linked by default.
433 // * If the compiler is emitting both an rlib and a dylib, the same
434 // source object file is currently used but with MSVC this may be less
435 // feasible. The compiler may be able to get around this, but it may
436 // involve some invasive changes to deal with this.
438 // The flipside of this situation is that whenever you link to a dll and
439 // you import a function from it, the import should be tagged with
440 // `dllimport`. At this time, however, the compiler does not emit
441 // `dllimport` for any declarations other than constants (where it is
442 // required), which is again suboptimal for even more reasons!
444 // * Calling a function imported from another dll without using
445 // `dllimport` causes the linker/compiler to have extra overhead (one
446 // `jmp` instruction on x86) when calling the function.
447 // * The same object file may be used in different circumstances, so a
448 // function may be imported from a dll if the object is linked into a
449 // dll, but it may be just linked against if linked into an rlib.
450 // * The compiler has no knowledge about whether native functions should
451 // be tagged dllimport or not.
453 // For now the compiler takes the perf hit (I do not have any numbers to
454 // this effect) by marking very little as `dllimport` and praying the
455 // linker will take care of everything. Fixing this problem will likely
456 // require adding a few attributes to Rust itself (feature gated at the
457 // start) and then strongly recommending static linkage on MSVC!
458 let use_dll_storage_attrs = tcx.sess.target.target.options.is_like_msvc;
461 metadata_llmod: metadata_llmod,
462 metadata_llcx: metadata_llcx,
463 exported_symbols: exported_symbols,
464 link_meta: link_meta,
465 empty_param_env: tcx.empty_parameter_environment(),
468 n_glues_created: Cell::new(0),
469 n_null_glues: Cell::new(0),
470 n_real_glues: Cell::new(0),
472 n_inlines: Cell::new(0),
473 n_closures: Cell::new(0),
474 n_llvm_insns: Cell::new(0),
475 llvm_insns: RefCell::new(FxHashMap()),
476 fn_stats: RefCell::new(Vec::new()),
478 check_overflow: check_overflow,
479 use_dll_storage_attrs: use_dll_storage_attrs,
480 translation_items: RefCell::new(FxHashSet()),
481 trait_cache: RefCell::new(DepTrackingMap::new(tcx.dep_graph.clone())),
482 project_cache: RefCell::new(DepTrackingMap::new(tcx.dep_graph.clone())),
486 pub fn type_needs_drop(&self, ty: Ty<'tcx>) -> bool {
487 self.tcx.type_needs_drop_given_env(ty, &self.empty_param_env)
490 pub fn type_is_sized(&self, ty: Ty<'tcx>) -> bool {
491 ty.is_sized(self.tcx, &self.empty_param_env, DUMMY_SP)
494 pub fn metadata_llmod(&self) -> ModuleRef {
498 pub fn metadata_llcx(&self) -> ContextRef {
502 pub fn exported_symbols<'a>(&'a self) -> &'a NodeSet {
503 &self.exported_symbols
506 pub fn trait_cache(&self) -> &RefCell<DepTrackingMap<TraitSelectionCache<'tcx>>> {
510 pub fn project_cache(&self) -> &RefCell<DepTrackingMap<ProjectionCache<'tcx>>> {
514 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
518 pub fn tcx<'a>(&'a self) -> TyCtxt<'a, 'tcx, 'tcx> {
522 pub fn sess<'a>(&'a self) -> &'a Session {
526 pub fn dep_graph<'a>(&'a self) -> &'a DepGraph {
530 pub fn stats<'a>(&'a self) -> &'a Stats {
534 pub fn use_dll_storage_attrs(&self) -> bool {
535 self.use_dll_storage_attrs
538 pub fn translation_items(&self) -> &RefCell<FxHashSet<TransItem<'tcx>>> {
539 &self.translation_items
542 pub fn metadata_symbol_name(&self) -> String {
543 format!("rust_metadata_{}_{}",
544 self.link_meta().crate_name,
545 self.link_meta().crate_hash)
549 impl<'tcx> LocalCrateContext<'tcx> {
550 fn new<'a>(shared: &SharedCrateContext<'a, 'tcx>,
551 codegen_unit: CodegenUnit<'tcx>,
552 previous_work_product: Option<WorkProduct>,
553 symbol_map: Rc<SymbolMap<'tcx>>)
554 -> LocalCrateContext<'tcx> {
556 // Append ".rs" to LLVM module identifier.
558 // LLVM code generator emits a ".file filename" directive
559 // for ELF backends. Value of the "filename" is set as the
560 // LLVM module identifier. Due to a LLVM MC bug[1], LLVM
561 // crashes if the module identifier is same as other symbols
562 // such as a function name in the module.
563 // 1. http://llvm.org/bugs/show_bug.cgi?id=11479
564 let llmod_id = format!("{}.rs", codegen_unit.name());
566 let (llcx, llmod) = create_context_and_module(&shared.tcx.sess,
569 let dbg_cx = if shared.tcx.sess.opts.debuginfo != NoDebugInfo {
570 let dctx = debuginfo::CrateDebugContext::new(llmod);
571 debuginfo::metadata::compile_unit_metadata(shared, &dctx, shared.tcx.sess);
577 let local_ccx = LocalCrateContext {
580 previous_work_product: previous_work_product,
581 codegen_unit: codegen_unit,
582 needs_unwind_cleanup_cache: RefCell::new(FxHashMap()),
583 instances: RefCell::new(FxHashMap()),
584 vtables: RefCell::new(FxHashMap()),
585 const_cstr_cache: RefCell::new(FxHashMap()),
586 const_unsized: RefCell::new(FxHashMap()),
587 const_globals: RefCell::new(FxHashMap()),
588 const_values: RefCell::new(FxHashMap()),
589 extern_const_values: RefCell::new(DefIdMap()),
590 statics: RefCell::new(FxHashMap()),
591 impl_method_cache: RefCell::new(FxHashMap()),
592 closure_bare_wrapper_cache: RefCell::new(FxHashMap()),
593 statics_to_rauw: RefCell::new(Vec::new()),
594 used_statics: RefCell::new(Vec::new()),
595 lltypes: RefCell::new(FxHashMap()),
596 llsizingtypes: RefCell::new(FxHashMap()),
597 type_hashcodes: RefCell::new(FxHashMap()),
598 int_type: Type::from_ref(ptr::null_mut()),
599 opaque_vec_type: Type::from_ref(ptr::null_mut()),
600 str_slice_type: Type::from_ref(ptr::null_mut()),
601 closure_vals: RefCell::new(FxHashMap()),
603 eh_personality: Cell::new(None),
604 eh_unwind_resume: Cell::new(None),
605 rust_try_fn: Cell::new(None),
606 intrinsics: RefCell::new(FxHashMap()),
607 type_of_depth: Cell::new(0),
608 symbol_map: symbol_map,
609 local_gen_sym_counter: Cell::new(0),
612 let (int_type, opaque_vec_type, str_slice_ty, mut local_ccx) = {
613 // Do a little dance to create a dummy CrateContext, so we can
614 // create some things in the LLVM module of this codegen unit
615 let mut local_ccxs = vec![local_ccx];
616 let (int_type, opaque_vec_type, str_slice_ty) = {
617 let dummy_ccx = LocalCrateContext::dummy_ccx(shared,
618 local_ccxs.as_mut_slice());
619 let mut str_slice_ty = Type::named_struct(&dummy_ccx, "str_slice");
620 str_slice_ty.set_struct_body(&[Type::i8p(&dummy_ccx),
621 Type::int(&dummy_ccx)],
623 (Type::int(&dummy_ccx), Type::opaque_vec(&dummy_ccx), str_slice_ty)
625 (int_type, opaque_vec_type, str_slice_ty, local_ccxs.pop().unwrap())
628 local_ccx.int_type = int_type;
629 local_ccx.opaque_vec_type = opaque_vec_type;
630 local_ccx.str_slice_type = str_slice_ty;
636 /// Create a dummy `CrateContext` from `self` and the provided
637 /// `SharedCrateContext`. This is somewhat dangerous because `self` may
638 /// not be fully initialized.
640 /// This is used in the `LocalCrateContext` constructor to allow calling
641 /// functions that expect a complete `CrateContext`, even before the local
642 /// portion is fully initialized and attached to the `SharedCrateContext`.
643 fn dummy_ccx<'a>(shared: &'a SharedCrateContext<'a, 'tcx>,
644 local_ccxs: &'a [LocalCrateContext<'tcx>])
645 -> CrateContext<'a, 'tcx> {
646 assert!(local_ccxs.len() == 1);
650 local_ccxs: local_ccxs
655 impl<'b, 'tcx> CrateContext<'b, 'tcx> {
656 pub fn shared(&self) -> &'b SharedCrateContext<'b, 'tcx> {
660 fn local(&self) -> &'b LocalCrateContext<'tcx> {
661 &self.local_ccxs[self.index]
664 pub fn tcx<'a>(&'a self) -> TyCtxt<'a, 'tcx, 'tcx> {
668 pub fn sess<'a>(&'a self) -> &'a Session {
669 &self.shared.tcx.sess
672 pub fn get_intrinsic(&self, key: &str) -> ValueRef {
673 if let Some(v) = self.intrinsics().borrow().get(key).cloned() {
676 match declare_intrinsic(self, key) {
678 None => bug!("unknown intrinsic '{}'", key)
682 pub fn llmod(&self) -> ModuleRef {
686 pub fn llcx(&self) -> ContextRef {
690 pub fn previous_work_product(&self) -> Option<&WorkProduct> {
691 self.local().previous_work_product.as_ref()
694 pub fn codegen_unit(&self) -> &CodegenUnit<'tcx> {
695 &self.local().codegen_unit
698 pub fn td(&self) -> llvm::TargetDataRef {
699 unsafe { llvm::LLVMRustGetModuleDataLayout(self.llmod()) }
702 pub fn exported_symbols<'a>(&'a self) -> &'a NodeSet {
703 &self.shared.exported_symbols
706 pub fn link_meta<'a>(&'a self) -> &'a LinkMeta {
707 &self.shared.link_meta
710 pub fn needs_unwind_cleanup_cache(&self) -> &RefCell<FxHashMap<Ty<'tcx>, bool>> {
711 &self.local().needs_unwind_cleanup_cache
714 pub fn instances<'a>(&'a self) -> &'a RefCell<FxHashMap<Instance<'tcx>, ValueRef>> {
715 &self.local().instances
718 pub fn vtables<'a>(&'a self)
719 -> &'a RefCell<FxHashMap<(ty::Ty<'tcx>,
720 Option<ty::PolyExistentialTraitRef<'tcx>>), ValueRef>> {
721 &self.local().vtables
724 pub fn const_cstr_cache<'a>(&'a self) -> &'a RefCell<FxHashMap<InternedString, ValueRef>> {
725 &self.local().const_cstr_cache
728 pub fn const_unsized<'a>(&'a self) -> &'a RefCell<FxHashMap<ValueRef, ValueRef>> {
729 &self.local().const_unsized
732 pub fn const_globals<'a>(&'a self) -> &'a RefCell<FxHashMap<ValueRef, ValueRef>> {
733 &self.local().const_globals
736 pub fn const_values<'a>(&'a self) -> &'a RefCell<FxHashMap<(ast::NodeId, &'tcx Substs<'tcx>),
738 &self.local().const_values
741 pub fn extern_const_values<'a>(&'a self) -> &'a RefCell<DefIdMap<ValueRef>> {
742 &self.local().extern_const_values
745 pub fn statics<'a>(&'a self) -> &'a RefCell<FxHashMap<ValueRef, DefId>> {
746 &self.local().statics
749 pub fn impl_method_cache<'a>(&'a self)
750 -> &'a RefCell<FxHashMap<(DefId, ast::Name), DefId>> {
751 &self.local().impl_method_cache
754 pub fn closure_bare_wrapper_cache<'a>(&'a self) -> &'a RefCell<FxHashMap<ValueRef, ValueRef>> {
755 &self.local().closure_bare_wrapper_cache
758 pub fn statics_to_rauw<'a>(&'a self) -> &'a RefCell<Vec<(ValueRef, ValueRef)>> {
759 &self.local().statics_to_rauw
762 pub fn used_statics<'a>(&'a self) -> &'a RefCell<Vec<ValueRef>> {
763 &self.local().used_statics
766 pub fn lltypes<'a>(&'a self) -> &'a RefCell<FxHashMap<Ty<'tcx>, Type>> {
767 &self.local().lltypes
770 pub fn llsizingtypes<'a>(&'a self) -> &'a RefCell<FxHashMap<Ty<'tcx>, Type>> {
771 &self.local().llsizingtypes
774 pub fn type_hashcodes<'a>(&'a self) -> &'a RefCell<FxHashMap<Ty<'tcx>, String>> {
775 &self.local().type_hashcodes
778 pub fn stats<'a>(&'a self) -> &'a Stats {
782 pub fn int_type(&self) -> Type {
783 self.local().int_type
786 pub fn opaque_vec_type(&self) -> Type {
787 self.local().opaque_vec_type
790 pub fn str_slice_type(&self) -> Type {
791 self.local().str_slice_type
794 pub fn closure_vals<'a>(&'a self) -> &'a RefCell<FxHashMap<Instance<'tcx>, ValueRef>> {
795 &self.local().closure_vals
798 pub fn dbg_cx<'a>(&'a self) -> &'a Option<debuginfo::CrateDebugContext<'tcx>> {
802 pub fn rust_try_fn<'a>(&'a self) -> &'a Cell<Option<ValueRef>> {
803 &self.local().rust_try_fn
806 fn intrinsics<'a>(&'a self) -> &'a RefCell<FxHashMap<&'static str, ValueRef>> {
807 &self.local().intrinsics
810 pub fn obj_size_bound(&self) -> u64 {
811 self.tcx().data_layout.obj_size_bound()
814 pub fn report_overbig_object(&self, obj: Ty<'tcx>) -> ! {
816 &format!("the type `{:?}` is too big for the current architecture",
820 pub fn enter_type_of(&self, ty: Ty<'tcx>) -> TypeOfDepthLock<'b, 'tcx> {
821 let current_depth = self.local().type_of_depth.get();
822 debug!("enter_type_of({:?}) at depth {:?}", ty, current_depth);
823 if current_depth > self.sess().recursion_limit.get() {
825 &format!("overflow representing the type `{}`", ty))
827 self.local().type_of_depth.set(current_depth + 1);
828 TypeOfDepthLock(self.local())
831 pub fn layout_of(&self, ty: Ty<'tcx>) -> &'tcx ty::layout::Layout {
832 self.tcx().infer_ctxt((), traits::Reveal::All).enter(|infcx| {
833 ty.layout(&infcx).unwrap_or_else(|e| {
835 ty::layout::LayoutError::SizeOverflow(_) =>
836 self.sess().fatal(&e.to_string()),
837 _ => bug!("failed to get layout for `{}`: {}", ty, e)
843 pub fn check_overflow(&self) -> bool {
844 self.shared.check_overflow
847 pub fn use_dll_storage_attrs(&self) -> bool {
848 self.shared.use_dll_storage_attrs()
851 pub fn symbol_map(&self) -> &SymbolMap<'tcx> {
852 &*self.local().symbol_map
855 pub fn translation_items(&self) -> &RefCell<FxHashSet<TransItem<'tcx>>> {
856 &self.shared.translation_items
859 /// Given the def-id of some item that has no type parameters, make
860 /// a suitable "empty substs" for it.
861 pub fn empty_substs_for_def_id(&self, item_def_id: DefId) -> &'tcx Substs<'tcx> {
862 self.tcx().empty_substs_for_def_id(item_def_id)
865 /// Generate a new symbol name with the given prefix. This symbol name must
866 /// only be used for definitions with `internal` or `private` linkage.
867 pub fn generate_local_symbol_name(&self, prefix: &str) -> String {
868 let idx = self.local().local_gen_sym_counter.get();
869 self.local().local_gen_sym_counter.set(idx + 1);
870 // Include a '.' character, so there can be no accidental conflicts with
871 // user defined names
872 let mut name = String::with_capacity(prefix.len() + 6);
873 name.push_str(prefix);
875 base_n::push_str(idx as u64, base_n::ALPHANUMERIC_ONLY, &mut name);
879 pub fn eh_personality(&self) -> ValueRef {
880 // The exception handling personality function.
882 // If our compilation unit has the `eh_personality` lang item somewhere
883 // within it, then we just need to translate that. Otherwise, we're
884 // building an rlib which will depend on some upstream implementation of
885 // this function, so we just codegen a generic reference to it. We don't
886 // specify any of the types for the function, we just make it a symbol
887 // that LLVM can later use.
889 // Note that MSVC is a little special here in that we don't use the
890 // `eh_personality` lang item at all. Currently LLVM has support for
891 // both Dwarf and SEH unwind mechanisms for MSVC targets and uses the
892 // *name of the personality function* to decide what kind of unwind side
893 // tables/landing pads to emit. It looks like Dwarf is used by default,
894 // injecting a dependency on the `_Unwind_Resume` symbol for resuming
895 // an "exception", but for MSVC we want to force SEH. This means that we
896 // can't actually have the personality function be our standard
897 // `rust_eh_personality` function, but rather we wired it up to the
898 // CRT's custom personality function, which forces LLVM to consider
899 // landing pads as "landing pads for SEH".
900 if let Some(llpersonality) = self.local().eh_personality.get() {
903 let tcx = self.tcx();
904 let llfn = match tcx.lang_items.eh_personality() {
905 Some(def_id) if !base::wants_msvc_seh(self.sess()) => {
906 callee::resolve_and_get_fn(self, def_id, tcx.intern_substs(&[]))
909 let name = if base::wants_msvc_seh(self.sess()) {
912 "rust_eh_personality"
914 let fty = Type::variadic_func(&[], &Type::i32(self));
915 declare::declare_cfn(self, name, fty)
918 self.local().eh_personality.set(Some(llfn));
922 // Returns a ValueRef of the "eh_unwind_resume" lang item if one is defined,
923 // otherwise declares it as an external function.
924 pub fn eh_unwind_resume(&self) -> ValueRef {
926 let unwresume = &self.local().eh_unwind_resume;
927 if let Some(llfn) = unwresume.get() {
931 let tcx = self.tcx();
932 assert!(self.sess().target.target.options.custom_unwind_resume);
933 if let Some(def_id) = tcx.lang_items.eh_unwind_resume() {
934 let llfn = callee::resolve_and_get_fn(self, def_id, tcx.intern_substs(&[]));
935 unwresume.set(Some(llfn));
939 let ty = tcx.mk_fn_ptr(ty::Binder(tcx.mk_fn_sig(
940 iter::once(tcx.mk_mut_ptr(tcx.types.u8)),
943 hir::Unsafety::Unsafe,
947 let llfn = declare::declare_fn(self, "rust_eh_unwind_resume", ty);
948 attributes::unwind(llfn, true);
949 unwresume.set(Some(llfn));
954 pub struct TypeOfDepthLock<'a, 'tcx: 'a>(&'a LocalCrateContext<'tcx>);
956 impl<'a, 'tcx> Drop for TypeOfDepthLock<'a, 'tcx> {
958 self.0.type_of_depth.set(self.0.type_of_depth.get() - 1);
962 /// Declare any llvm intrinsics that you might need
963 fn declare_intrinsic(ccx: &CrateContext, key: &str) -> Option<ValueRef> {
965 ($name:expr, fn() -> $ret:expr) => (
967 let f = declare::declare_cfn(ccx, $name, Type::func(&[], &$ret));
968 llvm::SetUnnamedAddr(f, false);
969 ccx.intrinsics().borrow_mut().insert($name, f.clone());
973 ($name:expr, fn(...) -> $ret:expr) => (
975 let f = declare::declare_cfn(ccx, $name, Type::variadic_func(&[], &$ret));
976 llvm::SetUnnamedAddr(f, false);
977 ccx.intrinsics().borrow_mut().insert($name, f.clone());
981 ($name:expr, fn($($arg:expr),*) -> $ret:expr) => (
983 let f = declare::declare_cfn(ccx, $name, Type::func(&[$($arg),*], &$ret));
984 llvm::SetUnnamedAddr(f, false);
985 ccx.intrinsics().borrow_mut().insert($name, f.clone());
990 macro_rules! mk_struct {
991 ($($field_ty:expr),*) => (Type::struct_(ccx, &[$($field_ty),*], false))
994 let i8p = Type::i8p(ccx);
995 let void = Type::void(ccx);
996 let i1 = Type::i1(ccx);
997 let t_i8 = Type::i8(ccx);
998 let t_i16 = Type::i16(ccx);
999 let t_i32 = Type::i32(ccx);
1000 let t_i64 = Type::i64(ccx);
1001 let t_i128 = Type::i128(ccx);
1002 let t_f32 = Type::f32(ccx);
1003 let t_f64 = Type::f64(ccx);
1005 ifn!("llvm.memcpy.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
1006 ifn!("llvm.memcpy.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
1007 ifn!("llvm.memcpy.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
1008 ifn!("llvm.memmove.p0i8.p0i8.i16", fn(i8p, i8p, t_i16, t_i32, i1) -> void);
1009 ifn!("llvm.memmove.p0i8.p0i8.i32", fn(i8p, i8p, t_i32, t_i32, i1) -> void);
1010 ifn!("llvm.memmove.p0i8.p0i8.i64", fn(i8p, i8p, t_i64, t_i32, i1) -> void);
1011 ifn!("llvm.memset.p0i8.i16", fn(i8p, t_i8, t_i16, t_i32, i1) -> void);
1012 ifn!("llvm.memset.p0i8.i32", fn(i8p, t_i8, t_i32, t_i32, i1) -> void);
1013 ifn!("llvm.memset.p0i8.i64", fn(i8p, t_i8, t_i64, t_i32, i1) -> void);
1015 ifn!("llvm.trap", fn() -> void);
1016 ifn!("llvm.debugtrap", fn() -> void);
1017 ifn!("llvm.frameaddress", fn(t_i32) -> i8p);
1019 ifn!("llvm.powi.f32", fn(t_f32, t_i32) -> t_f32);
1020 ifn!("llvm.powi.f64", fn(t_f64, t_i32) -> t_f64);
1021 ifn!("llvm.pow.f32", fn(t_f32, t_f32) -> t_f32);
1022 ifn!("llvm.pow.f64", fn(t_f64, t_f64) -> t_f64);
1024 ifn!("llvm.sqrt.f32", fn(t_f32) -> t_f32);
1025 ifn!("llvm.sqrt.f64", fn(t_f64) -> t_f64);
1026 ifn!("llvm.sin.f32", fn(t_f32) -> t_f32);
1027 ifn!("llvm.sin.f64", fn(t_f64) -> t_f64);
1028 ifn!("llvm.cos.f32", fn(t_f32) -> t_f32);
1029 ifn!("llvm.cos.f64", fn(t_f64) -> t_f64);
1030 ifn!("llvm.exp.f32", fn(t_f32) -> t_f32);
1031 ifn!("llvm.exp.f64", fn(t_f64) -> t_f64);
1032 ifn!("llvm.exp2.f32", fn(t_f32) -> t_f32);
1033 ifn!("llvm.exp2.f64", fn(t_f64) -> t_f64);
1034 ifn!("llvm.log.f32", fn(t_f32) -> t_f32);
1035 ifn!("llvm.log.f64", fn(t_f64) -> t_f64);
1036 ifn!("llvm.log10.f32", fn(t_f32) -> t_f32);
1037 ifn!("llvm.log10.f64", fn(t_f64) -> t_f64);
1038 ifn!("llvm.log2.f32", fn(t_f32) -> t_f32);
1039 ifn!("llvm.log2.f64", fn(t_f64) -> t_f64);
1041 ifn!("llvm.fma.f32", fn(t_f32, t_f32, t_f32) -> t_f32);
1042 ifn!("llvm.fma.f64", fn(t_f64, t_f64, t_f64) -> t_f64);
1044 ifn!("llvm.fabs.f32", fn(t_f32) -> t_f32);
1045 ifn!("llvm.fabs.f64", fn(t_f64) -> t_f64);
1047 ifn!("llvm.floor.f32", fn(t_f32) -> t_f32);
1048 ifn!("llvm.floor.f64", fn(t_f64) -> t_f64);
1049 ifn!("llvm.ceil.f32", fn(t_f32) -> t_f32);
1050 ifn!("llvm.ceil.f64", fn(t_f64) -> t_f64);
1051 ifn!("llvm.trunc.f32", fn(t_f32) -> t_f32);
1052 ifn!("llvm.trunc.f64", fn(t_f64) -> t_f64);
1054 ifn!("llvm.copysign.f32", fn(t_f32, t_f32) -> t_f32);
1055 ifn!("llvm.copysign.f64", fn(t_f64, t_f64) -> t_f64);
1056 ifn!("llvm.round.f32", fn(t_f32) -> t_f32);
1057 ifn!("llvm.round.f64", fn(t_f64) -> t_f64);
1059 ifn!("llvm.rint.f32", fn(t_f32) -> t_f32);
1060 ifn!("llvm.rint.f64", fn(t_f64) -> t_f64);
1061 ifn!("llvm.nearbyint.f32", fn(t_f32) -> t_f32);
1062 ifn!("llvm.nearbyint.f64", fn(t_f64) -> t_f64);
1064 ifn!("llvm.ctpop.i8", fn(t_i8) -> t_i8);
1065 ifn!("llvm.ctpop.i16", fn(t_i16) -> t_i16);
1066 ifn!("llvm.ctpop.i32", fn(t_i32) -> t_i32);
1067 ifn!("llvm.ctpop.i64", fn(t_i64) -> t_i64);
1068 ifn!("llvm.ctpop.i128", fn(t_i128) -> t_i128);
1070 ifn!("llvm.ctlz.i8", fn(t_i8 , i1) -> t_i8);
1071 ifn!("llvm.ctlz.i16", fn(t_i16, i1) -> t_i16);
1072 ifn!("llvm.ctlz.i32", fn(t_i32, i1) -> t_i32);
1073 ifn!("llvm.ctlz.i64", fn(t_i64, i1) -> t_i64);
1074 ifn!("llvm.ctlz.i128", fn(t_i128, i1) -> t_i128);
1076 ifn!("llvm.cttz.i8", fn(t_i8 , i1) -> t_i8);
1077 ifn!("llvm.cttz.i16", fn(t_i16, i1) -> t_i16);
1078 ifn!("llvm.cttz.i32", fn(t_i32, i1) -> t_i32);
1079 ifn!("llvm.cttz.i64", fn(t_i64, i1) -> t_i64);
1080 ifn!("llvm.cttz.i128", fn(t_i128, i1) -> t_i128);
1082 ifn!("llvm.bswap.i16", fn(t_i16) -> t_i16);
1083 ifn!("llvm.bswap.i32", fn(t_i32) -> t_i32);
1084 ifn!("llvm.bswap.i64", fn(t_i64) -> t_i64);
1085 ifn!("llvm.bswap.i128", fn(t_i128) -> t_i128);
1087 ifn!("llvm.sadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1088 ifn!("llvm.sadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1089 ifn!("llvm.sadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1090 ifn!("llvm.sadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1091 ifn!("llvm.sadd.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
1093 ifn!("llvm.uadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1094 ifn!("llvm.uadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1095 ifn!("llvm.uadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1096 ifn!("llvm.uadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1097 ifn!("llvm.uadd.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
1099 ifn!("llvm.ssub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1100 ifn!("llvm.ssub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1101 ifn!("llvm.ssub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1102 ifn!("llvm.ssub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1103 ifn!("llvm.ssub.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
1105 ifn!("llvm.usub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1106 ifn!("llvm.usub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1107 ifn!("llvm.usub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1108 ifn!("llvm.usub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1109 ifn!("llvm.usub.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
1111 ifn!("llvm.smul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1112 ifn!("llvm.smul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1113 ifn!("llvm.smul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1114 ifn!("llvm.smul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1115 ifn!("llvm.smul.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
1117 ifn!("llvm.umul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct!{t_i8, i1});
1118 ifn!("llvm.umul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct!{t_i16, i1});
1119 ifn!("llvm.umul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct!{t_i32, i1});
1120 ifn!("llvm.umul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct!{t_i64, i1});
1121 ifn!("llvm.umul.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct!{t_i128, i1});
1123 ifn!("llvm.lifetime.start", fn(t_i64,i8p) -> void);
1124 ifn!("llvm.lifetime.end", fn(t_i64, i8p) -> void);
1126 ifn!("llvm.expect.i1", fn(i1, i1) -> i1);
1127 ifn!("llvm.eh.typeid.for", fn(i8p) -> t_i32);
1128 ifn!("llvm.localescape", fn(...) -> void);
1129 ifn!("llvm.localrecover", fn(i8p, i8p, t_i32) -> i8p);
1130 ifn!("llvm.x86.seh.recoverfp", fn(i8p, i8p) -> i8p);
1132 ifn!("llvm.assume", fn(i1) -> void);
1134 if ccx.sess().opts.debuginfo != NoDebugInfo {
1135 ifn!("llvm.dbg.declare", fn(Type::metadata(ccx), Type::metadata(ccx)) -> void);
1136 ifn!("llvm.dbg.value", fn(Type::metadata(ccx), t_i64, Type::metadata(ccx)) -> void);