]> git.lizzy.rs Git - rust.git/blob - src/librustc_trans/base.rs
Rollup merge of #41120 - clarcharr:c_str_transmute, r=alexcrichton
[rust.git] / src / librustc_trans / base.rs
1 // Copyright 2012-2015 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.
4 //
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.
10
11 //! Translate the completed AST to the LLVM IR.
12 //!
13 //! Some functions here, such as trans_block and trans_expr, return a value --
14 //! the result of the translation to LLVM -- while others, such as trans_fn
15 //! and trans_item, are called only for the side effect of adding a
16 //! particular definition to the LLVM IR output we're producing.
17 //!
18 //! Hopefully useful general knowledge about trans:
19 //!
20 //!   * There's no way to find out the Ty type of a ValueRef.  Doing so
21 //!     would be "trying to get the eggs out of an omelette" (credit:
22 //!     pcwalton).  You can, instead, find out its TypeRef by calling val_ty,
23 //!     but one TypeRef corresponds to many `Ty`s; for instance, tup(int, int,
24 //!     int) and rec(x=int, y=int, z=int) will have the same TypeRef.
25
26 use super::CrateTranslation;
27 use super::ModuleLlvm;
28 use super::ModuleSource;
29 use super::ModuleTranslation;
30
31 use assert_module_sources;
32 use back::link;
33 use back::linker::LinkerInfo;
34 use back::symbol_export::{self, ExportedSymbols};
35 use llvm::{Linkage, ValueRef, Vector, get_param};
36 use llvm;
37 use rustc::hir::def_id::LOCAL_CRATE;
38 use middle::lang_items::StartFnLangItem;
39 use rustc::ty::{self, Ty, TyCtxt};
40 use rustc::dep_graph::{AssertDepGraphSafe, DepNode, WorkProduct};
41 use rustc::hir::map as hir_map;
42 use rustc::util::common::time;
43 use session::config::{self, NoDebugInfo};
44 use rustc_incremental::IncrementalHashesMap;
45 use session::{self, DataTypeKind, Session};
46 use abi;
47 use mir::lvalue::LvalueRef;
48 use attributes;
49 use builder::Builder;
50 use callee;
51 use common::{C_bool, C_bytes_in_context, C_i32, C_uint};
52 use collector::{self, TransItemCollectionMode};
53 use common::{C_struct_in_context, C_u64, C_undef, C_array};
54 use common::CrateContext;
55 use common::{type_is_zero_size, val_ty};
56 use common;
57 use consts;
58 use context::{SharedCrateContext, CrateContextList};
59 use debuginfo;
60 use declare;
61 use machine;
62 use machine::llsize_of;
63 use meth;
64 use mir;
65 use monomorphize::{self, Instance};
66 use partitioning::{self, PartitioningStrategy, CodegenUnit};
67 use symbol_map::SymbolMap;
68 use symbol_names_test;
69 use trans_item::{TransItem, DefPathBasedNames};
70 use type_::Type;
71 use type_of;
72 use value::Value;
73 use util::nodemap::{NodeSet, FxHashMap, FxHashSet};
74
75 use libc::c_uint;
76 use std::ffi::{CStr, CString};
77 use std::rc::Rc;
78 use std::str;
79 use std::i32;
80 use syntax_pos::Span;
81 use syntax::attr;
82 use rustc::hir;
83 use rustc::ty::layout::{self, Layout};
84 use syntax::ast;
85
86 use mir::lvalue::Alignment;
87
88 pub struct StatRecorder<'a, 'tcx: 'a> {
89     ccx: &'a CrateContext<'a, 'tcx>,
90     name: Option<String>,
91     istart: usize,
92 }
93
94 impl<'a, 'tcx> StatRecorder<'a, 'tcx> {
95     pub fn new(ccx: &'a CrateContext<'a, 'tcx>, name: String) -> StatRecorder<'a, 'tcx> {
96         let istart = ccx.stats().n_llvm_insns.get();
97         StatRecorder {
98             ccx: ccx,
99             name: Some(name),
100             istart: istart,
101         }
102     }
103 }
104
105 impl<'a, 'tcx> Drop for StatRecorder<'a, 'tcx> {
106     fn drop(&mut self) {
107         if self.ccx.sess().trans_stats() {
108             let iend = self.ccx.stats().n_llvm_insns.get();
109             self.ccx.stats().fn_stats.borrow_mut()
110                 .push((self.name.take().unwrap(), iend - self.istart));
111             self.ccx.stats().n_fns.set(self.ccx.stats().n_fns.get() + 1);
112             // Reset LLVM insn count to avoid compound costs.
113             self.ccx.stats().n_llvm_insns.set(self.istart);
114         }
115     }
116 }
117
118 pub fn get_meta(bcx: &Builder, fat_ptr: ValueRef) -> ValueRef {
119     bcx.struct_gep(fat_ptr, abi::FAT_PTR_EXTRA)
120 }
121
122 pub fn get_dataptr(bcx: &Builder, fat_ptr: ValueRef) -> ValueRef {
123     bcx.struct_gep(fat_ptr, abi::FAT_PTR_ADDR)
124 }
125
126 pub fn bin_op_to_icmp_predicate(op: hir::BinOp_,
127                                 signed: bool)
128                                 -> llvm::IntPredicate {
129     match op {
130         hir::BiEq => llvm::IntEQ,
131         hir::BiNe => llvm::IntNE,
132         hir::BiLt => if signed { llvm::IntSLT } else { llvm::IntULT },
133         hir::BiLe => if signed { llvm::IntSLE } else { llvm::IntULE },
134         hir::BiGt => if signed { llvm::IntSGT } else { llvm::IntUGT },
135         hir::BiGe => if signed { llvm::IntSGE } else { llvm::IntUGE },
136         op => {
137             bug!("comparison_op_to_icmp_predicate: expected comparison operator, \
138                   found {:?}",
139                  op)
140         }
141     }
142 }
143
144 pub fn bin_op_to_fcmp_predicate(op: hir::BinOp_) -> llvm::RealPredicate {
145     match op {
146         hir::BiEq => llvm::RealOEQ,
147         hir::BiNe => llvm::RealUNE,
148         hir::BiLt => llvm::RealOLT,
149         hir::BiLe => llvm::RealOLE,
150         hir::BiGt => llvm::RealOGT,
151         hir::BiGe => llvm::RealOGE,
152         op => {
153             bug!("comparison_op_to_fcmp_predicate: expected comparison operator, \
154                   found {:?}",
155                  op);
156         }
157     }
158 }
159
160 pub fn compare_simd_types<'a, 'tcx>(
161     bcx: &Builder<'a, 'tcx>,
162     lhs: ValueRef,
163     rhs: ValueRef,
164     t: Ty<'tcx>,
165     ret_ty: Type,
166     op: hir::BinOp_
167 ) -> ValueRef {
168     let signed = match t.sty {
169         ty::TyFloat(_) => {
170             let cmp = bin_op_to_fcmp_predicate(op);
171             return bcx.sext(bcx.fcmp(cmp, lhs, rhs), ret_ty);
172         },
173         ty::TyUint(_) => false,
174         ty::TyInt(_) => true,
175         _ => bug!("compare_simd_types: invalid SIMD type"),
176     };
177
178     let cmp = bin_op_to_icmp_predicate(op, signed);
179     // LLVM outputs an `< size x i1 >`, so we need to perform a sign extension
180     // to get the correctly sized type. This will compile to a single instruction
181     // once the IR is converted to assembly if the SIMD instruction is supported
182     // by the target architecture.
183     bcx.sext(bcx.icmp(cmp, lhs, rhs), ret_ty)
184 }
185
186 /// Retrieve the information we are losing (making dynamic) in an unsizing
187 /// adjustment.
188 ///
189 /// The `old_info` argument is a bit funny. It is intended for use
190 /// in an upcast, where the new vtable for an object will be drived
191 /// from the old one.
192 pub fn unsized_info<'ccx, 'tcx>(ccx: &CrateContext<'ccx, 'tcx>,
193                                 source: Ty<'tcx>,
194                                 target: Ty<'tcx>,
195                                 old_info: Option<ValueRef>)
196                                 -> ValueRef {
197     let (source, target) = ccx.tcx().struct_lockstep_tails(source, target);
198     match (&source.sty, &target.sty) {
199         (&ty::TyArray(_, len), &ty::TySlice(_)) => C_uint(ccx, len),
200         (&ty::TyDynamic(..), &ty::TyDynamic(..)) => {
201             // For now, upcasts are limited to changes in marker
202             // traits, and hence never actually require an actual
203             // change to the vtable.
204             old_info.expect("unsized_info: missing old info for trait upcast")
205         }
206         (_, &ty::TyDynamic(ref data, ..)) => {
207             consts::ptrcast(meth::get_vtable(ccx, source, data.principal()),
208                             Type::vtable_ptr(ccx))
209         }
210         _ => bug!("unsized_info: invalid unsizing {:?} -> {:?}",
211                                      source,
212                                      target),
213     }
214 }
215
216 /// Coerce `src` to `dst_ty`. `src_ty` must be a thin pointer.
217 pub fn unsize_thin_ptr<'a, 'tcx>(
218     bcx: &Builder<'a, 'tcx>,
219     src: ValueRef,
220     src_ty: Ty<'tcx>,
221     dst_ty: Ty<'tcx>
222 ) -> (ValueRef, ValueRef) {
223     debug!("unsize_thin_ptr: {:?} => {:?}", src_ty, dst_ty);
224     match (&src_ty.sty, &dst_ty.sty) {
225         (&ty::TyRef(_, ty::TypeAndMut { ty: a, .. }),
226          &ty::TyRef(_, ty::TypeAndMut { ty: b, .. })) |
227         (&ty::TyRef(_, ty::TypeAndMut { ty: a, .. }),
228          &ty::TyRawPtr(ty::TypeAndMut { ty: b, .. })) |
229         (&ty::TyRawPtr(ty::TypeAndMut { ty: a, .. }),
230          &ty::TyRawPtr(ty::TypeAndMut { ty: b, .. })) => {
231             assert!(bcx.ccx.shared().type_is_sized(a));
232             let ptr_ty = type_of::in_memory_type_of(bcx.ccx, b).ptr_to();
233             (bcx.pointercast(src, ptr_ty), unsized_info(bcx.ccx, a, b, None))
234         }
235         (&ty::TyAdt(def_a, _), &ty::TyAdt(def_b, _)) if def_a.is_box() && def_b.is_box() => {
236             let (a, b) = (src_ty.boxed_ty(), dst_ty.boxed_ty());
237             assert!(bcx.ccx.shared().type_is_sized(a));
238             let ptr_ty = type_of::in_memory_type_of(bcx.ccx, b).ptr_to();
239             (bcx.pointercast(src, ptr_ty), unsized_info(bcx.ccx, a, b, None))
240         }
241         _ => bug!("unsize_thin_ptr: called on bad types"),
242     }
243 }
244
245 /// Coerce `src`, which is a reference to a value of type `src_ty`,
246 /// to a value of type `dst_ty` and store the result in `dst`
247 pub fn coerce_unsized_into<'a, 'tcx>(bcx: &Builder<'a, 'tcx>,
248                                      src: &LvalueRef<'tcx>,
249                                      dst: &LvalueRef<'tcx>) {
250     let src_ty = src.ty.to_ty(bcx.tcx());
251     let dst_ty = dst.ty.to_ty(bcx.tcx());
252     let coerce_ptr = || {
253         let (base, info) = if common::type_is_fat_ptr(bcx.ccx, src_ty) {
254             // fat-ptr to fat-ptr unsize preserves the vtable
255             // i.e. &'a fmt::Debug+Send => &'a fmt::Debug
256             // So we need to pointercast the base to ensure
257             // the types match up.
258             let (base, info) = load_fat_ptr(bcx, src.llval, src.alignment, src_ty);
259             let llcast_ty = type_of::fat_ptr_base_ty(bcx.ccx, dst_ty);
260             let base = bcx.pointercast(base, llcast_ty);
261             (base, info)
262         } else {
263             let base = load_ty(bcx, src.llval, src.alignment, src_ty);
264             unsize_thin_ptr(bcx, base, src_ty, dst_ty)
265         };
266         store_fat_ptr(bcx, base, info, dst.llval, dst.alignment, dst_ty);
267     };
268     match (&src_ty.sty, &dst_ty.sty) {
269         (&ty::TyRef(..), &ty::TyRef(..)) |
270         (&ty::TyRef(..), &ty::TyRawPtr(..)) |
271         (&ty::TyRawPtr(..), &ty::TyRawPtr(..)) => {
272             coerce_ptr()
273         }
274         (&ty::TyAdt(def_a, _), &ty::TyAdt(def_b, _)) if def_a.is_box() && def_b.is_box() => {
275             coerce_ptr()
276         }
277
278         (&ty::TyAdt(def_a, substs_a), &ty::TyAdt(def_b, substs_b)) => {
279             assert_eq!(def_a, def_b);
280
281             let src_fields = def_a.variants[0].fields.iter().map(|f| {
282                 monomorphize::field_ty(bcx.tcx(), substs_a, f)
283             });
284             let dst_fields = def_b.variants[0].fields.iter().map(|f| {
285                 monomorphize::field_ty(bcx.tcx(), substs_b, f)
286             });
287
288             let iter = src_fields.zip(dst_fields).enumerate();
289             for (i, (src_fty, dst_fty)) in iter {
290                 if type_is_zero_size(bcx.ccx, dst_fty) {
291                     continue;
292                 }
293
294                 let (src_f, src_f_align) = src.trans_field_ptr(bcx, i);
295                 let (dst_f, dst_f_align) = dst.trans_field_ptr(bcx, i);
296                 if src_fty == dst_fty {
297                     memcpy_ty(bcx, dst_f, src_f, src_fty, None);
298                 } else {
299                     coerce_unsized_into(
300                         bcx,
301                         &LvalueRef::new_sized_ty(src_f, src_fty, src_f_align),
302                         &LvalueRef::new_sized_ty(dst_f, dst_fty, dst_f_align)
303                     );
304                 }
305             }
306         }
307         _ => bug!("coerce_unsized_into: invalid coercion {:?} -> {:?}",
308                   src_ty,
309                   dst_ty),
310     }
311 }
312
313 pub fn cast_shift_expr_rhs(
314     cx: &Builder, op: hir::BinOp_, lhs: ValueRef, rhs: ValueRef
315 ) -> ValueRef {
316     cast_shift_rhs(op, lhs, rhs, |a, b| cx.trunc(a, b), |a, b| cx.zext(a, b))
317 }
318
319 pub fn cast_shift_const_rhs(op: hir::BinOp_, lhs: ValueRef, rhs: ValueRef) -> ValueRef {
320     cast_shift_rhs(op,
321                    lhs,
322                    rhs,
323                    |a, b| unsafe { llvm::LLVMConstTrunc(a, b.to_ref()) },
324                    |a, b| unsafe { llvm::LLVMConstZExt(a, b.to_ref()) })
325 }
326
327 fn cast_shift_rhs<F, G>(op: hir::BinOp_,
328                         lhs: ValueRef,
329                         rhs: ValueRef,
330                         trunc: F,
331                         zext: G)
332                         -> ValueRef
333     where F: FnOnce(ValueRef, Type) -> ValueRef,
334           G: FnOnce(ValueRef, Type) -> ValueRef
335 {
336     // Shifts may have any size int on the rhs
337     if op.is_shift() {
338         let mut rhs_llty = val_ty(rhs);
339         let mut lhs_llty = val_ty(lhs);
340         if rhs_llty.kind() == Vector {
341             rhs_llty = rhs_llty.element_type()
342         }
343         if lhs_llty.kind() == Vector {
344             lhs_llty = lhs_llty.element_type()
345         }
346         let rhs_sz = rhs_llty.int_width();
347         let lhs_sz = lhs_llty.int_width();
348         if lhs_sz < rhs_sz {
349             trunc(rhs, lhs_llty)
350         } else if lhs_sz > rhs_sz {
351             // FIXME (#1877: If shifting by negative
352             // values becomes not undefined then this is wrong.
353             zext(rhs, lhs_llty)
354         } else {
355             rhs
356         }
357     } else {
358         rhs
359     }
360 }
361
362 /// Returns whether this session's target will use SEH-based unwinding.
363 ///
364 /// This is only true for MSVC targets, and even then the 64-bit MSVC target
365 /// currently uses SEH-ish unwinding with DWARF info tables to the side (same as
366 /// 64-bit MinGW) instead of "full SEH".
367 pub fn wants_msvc_seh(sess: &Session) -> bool {
368     sess.target.target.options.is_like_msvc
369 }
370
371 pub fn call_assume<'a, 'tcx>(b: &Builder<'a, 'tcx>, val: ValueRef) {
372     let assume_intrinsic = b.ccx.get_intrinsic("llvm.assume");
373     b.call(assume_intrinsic, &[val], None);
374 }
375
376 /// Helper for loading values from memory. Does the necessary conversion if the in-memory type
377 /// differs from the type used for SSA values. Also handles various special cases where the type
378 /// gives us better information about what we are loading.
379 pub fn load_ty<'a, 'tcx>(b: &Builder<'a, 'tcx>, ptr: ValueRef,
380                          alignment: Alignment, t: Ty<'tcx>) -> ValueRef {
381     let ccx = b.ccx;
382     if type_is_zero_size(ccx, t) {
383         return C_undef(type_of::type_of(ccx, t));
384     }
385
386     unsafe {
387         let global = llvm::LLVMIsAGlobalVariable(ptr);
388         if !global.is_null() && llvm::LLVMIsGlobalConstant(global) == llvm::True {
389             let val = llvm::LLVMGetInitializer(global);
390             if !val.is_null() {
391                 if t.is_bool() {
392                     return llvm::LLVMConstTrunc(val, Type::i1(ccx).to_ref());
393                 }
394                 return val;
395             }
396         }
397     }
398
399     if t.is_bool() {
400         b.trunc(b.load_range_assert(ptr, 0, 2, llvm::False, alignment.to_align()),
401                 Type::i1(ccx))
402     } else if t.is_char() {
403         // a char is a Unicode codepoint, and so takes values from 0
404         // to 0x10FFFF inclusive only.
405         b.load_range_assert(ptr, 0, 0x10FFFF + 1, llvm::False, alignment.to_align())
406     } else if (t.is_region_ptr() || t.is_box() || t.is_fn())
407         && !common::type_is_fat_ptr(ccx, t)
408     {
409         b.load_nonnull(ptr, alignment.to_align())
410     } else {
411         b.load(ptr, alignment.to_align())
412     }
413 }
414
415 /// Helper for storing values in memory. Does the necessary conversion if the in-memory type
416 /// differs from the type used for SSA values.
417 pub fn store_ty<'a, 'tcx>(cx: &Builder<'a, 'tcx>, v: ValueRef, dst: ValueRef,
418                           dst_align: Alignment, t: Ty<'tcx>) {
419     debug!("store_ty: {:?} : {:?} <- {:?}", Value(dst), t, Value(v));
420
421     if common::type_is_fat_ptr(cx.ccx, t) {
422         let lladdr = cx.extract_value(v, abi::FAT_PTR_ADDR);
423         let llextra = cx.extract_value(v, abi::FAT_PTR_EXTRA);
424         store_fat_ptr(cx, lladdr, llextra, dst, dst_align, t);
425     } else {
426         cx.store(from_immediate(cx, v), dst, dst_align.to_align());
427     }
428 }
429
430 pub fn store_fat_ptr<'a, 'tcx>(cx: &Builder<'a, 'tcx>,
431                                data: ValueRef,
432                                extra: ValueRef,
433                                dst: ValueRef,
434                                dst_align: Alignment,
435                                _ty: Ty<'tcx>) {
436     // FIXME: emit metadata
437     cx.store(data, get_dataptr(cx, dst), dst_align.to_align());
438     cx.store(extra, get_meta(cx, dst), dst_align.to_align());
439 }
440
441 pub fn load_fat_ptr<'a, 'tcx>(
442     b: &Builder<'a, 'tcx>, src: ValueRef, alignment: Alignment, t: Ty<'tcx>
443 ) -> (ValueRef, ValueRef) {
444     let ptr = get_dataptr(b, src);
445     let ptr = if t.is_region_ptr() || t.is_box() {
446         b.load_nonnull(ptr, alignment.to_align())
447     } else {
448         b.load(ptr, alignment.to_align())
449     };
450
451     let meta = get_meta(b, src);
452     let meta_ty = val_ty(meta);
453     // If the 'meta' field is a pointer, it's a vtable, so use load_nonnull
454     // instead
455     let meta = if meta_ty.element_type().kind() == llvm::TypeKind::Pointer {
456         b.load_nonnull(meta, None)
457     } else {
458         b.load(meta, None)
459     };
460
461     (ptr, meta)
462 }
463
464 pub fn from_immediate(bcx: &Builder, val: ValueRef) -> ValueRef {
465     if val_ty(val) == Type::i1(bcx.ccx) {
466         bcx.zext(val, Type::i8(bcx.ccx))
467     } else {
468         val
469     }
470 }
471
472 pub fn to_immediate(bcx: &Builder, val: ValueRef, ty: Ty) -> ValueRef {
473     if ty.is_bool() {
474         bcx.trunc(val, Type::i1(bcx.ccx))
475     } else {
476         val
477     }
478 }
479
480 pub enum Lifetime { Start, End }
481
482 impl Lifetime {
483     // If LLVM lifetime intrinsic support is enabled (i.e. optimizations
484     // on), and `ptr` is nonzero-sized, then extracts the size of `ptr`
485     // and the intrinsic for `lt` and passes them to `emit`, which is in
486     // charge of generating code to call the passed intrinsic on whatever
487     // block of generated code is targetted for the intrinsic.
488     //
489     // If LLVM lifetime intrinsic support is disabled (i.e.  optimizations
490     // off) or `ptr` is zero-sized, then no-op (does not call `emit`).
491     pub fn call(self, b: &Builder, ptr: ValueRef) {
492         if b.ccx.sess().opts.optimize == config::OptLevel::No {
493             return;
494         }
495
496         let size = machine::llsize_of_alloc(b.ccx, val_ty(ptr).element_type());
497         if size == 0 {
498             return;
499         }
500
501         let lifetime_intrinsic = b.ccx.get_intrinsic(match self {
502             Lifetime::Start => "llvm.lifetime.start",
503             Lifetime::End => "llvm.lifetime.end"
504         });
505
506         let ptr = b.pointercast(ptr, Type::i8p(b.ccx));
507         b.call(lifetime_intrinsic, &[C_u64(b.ccx, size), ptr], None);
508     }
509 }
510
511 pub fn call_memcpy<'a, 'tcx>(b: &Builder<'a, 'tcx>,
512                                dst: ValueRef,
513                                src: ValueRef,
514                                n_bytes: ValueRef,
515                                align: u32) {
516     let ccx = b.ccx;
517     let ptr_width = &ccx.sess().target.target.target_pointer_width;
518     let key = format!("llvm.memcpy.p0i8.p0i8.i{}", ptr_width);
519     let memcpy = ccx.get_intrinsic(&key);
520     let src_ptr = b.pointercast(src, Type::i8p(ccx));
521     let dst_ptr = b.pointercast(dst, Type::i8p(ccx));
522     let size = b.intcast(n_bytes, ccx.int_type(), false);
523     let align = C_i32(ccx, align as i32);
524     let volatile = C_bool(ccx, false);
525     b.call(memcpy, &[dst_ptr, src_ptr, size, align, volatile], None);
526 }
527
528 pub fn memcpy_ty<'a, 'tcx>(
529     bcx: &Builder<'a, 'tcx>,
530     dst: ValueRef,
531     src: ValueRef,
532     t: Ty<'tcx>,
533     align: Option<u32>,
534 ) {
535     let ccx = bcx.ccx;
536
537     if type_is_zero_size(ccx, t) {
538         return;
539     }
540
541     let llty = type_of::type_of(ccx, t);
542     let llsz = llsize_of(ccx, llty);
543     let llalign = align.unwrap_or_else(|| type_of::align_of(ccx, t));
544     call_memcpy(bcx, dst, src, llsz, llalign as u32);
545 }
546
547 pub fn call_memset<'a, 'tcx>(b: &Builder<'a, 'tcx>,
548                              ptr: ValueRef,
549                              fill_byte: ValueRef,
550                              size: ValueRef,
551                              align: ValueRef,
552                              volatile: bool) -> ValueRef {
553     let ptr_width = &b.ccx.sess().target.target.target_pointer_width;
554     let intrinsic_key = format!("llvm.memset.p0i8.i{}", ptr_width);
555     let llintrinsicfn = b.ccx.get_intrinsic(&intrinsic_key);
556     let volatile = C_bool(b.ccx, volatile);
557     b.call(llintrinsicfn, &[ptr, fill_byte, size, align, volatile], None)
558 }
559
560 pub fn trans_instance<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>, instance: Instance<'tcx>) {
561     let _s = if ccx.sess().trans_stats() {
562         let mut instance_name = String::new();
563         DefPathBasedNames::new(ccx.tcx(), true, true)
564             .push_def_path(instance.def_id(), &mut instance_name);
565         Some(StatRecorder::new(ccx, instance_name))
566     } else {
567         None
568     };
569
570     // this is an info! to allow collecting monomorphization statistics
571     // and to allow finding the last function before LLVM aborts from
572     // release builds.
573     info!("trans_instance({})", instance);
574
575     let fn_ty = common::instance_ty(ccx.shared(), &instance);
576     let sig = common::ty_fn_sig(ccx, fn_ty);
577     let sig = ccx.tcx().erase_late_bound_regions_and_normalize(&sig);
578
579     let lldecl = match ccx.instances().borrow().get(&instance) {
580         Some(&val) => val,
581         None => bug!("Instance `{:?}` not already declared", instance)
582     };
583
584     ccx.stats().n_closures.set(ccx.stats().n_closures.get() + 1);
585
586     // The `uwtable` attribute according to LLVM is:
587     //
588     //     This attribute indicates that the ABI being targeted requires that an
589     //     unwind table entry be produced for this function even if we can show
590     //     that no exceptions passes by it. This is normally the case for the
591     //     ELF x86-64 abi, but it can be disabled for some compilation units.
592     //
593     // Typically when we're compiling with `-C panic=abort` (which implies this
594     // `no_landing_pads` check) we don't need `uwtable` because we can't
595     // generate any exceptions! On Windows, however, exceptions include other
596     // events such as illegal instructions, segfaults, etc. This means that on
597     // Windows we end up still needing the `uwtable` attribute even if the `-C
598     // panic=abort` flag is passed.
599     //
600     // You can also find more info on why Windows is whitelisted here in:
601     //      https://bugzilla.mozilla.org/show_bug.cgi?id=1302078
602     if !ccx.sess().no_landing_pads() ||
603        ccx.sess().target.target.options.is_like_windows {
604         attributes::emit_uwtable(lldecl, true);
605     }
606
607     let mir = ccx.tcx().instance_mir(instance.def);
608     mir::trans_mir(ccx, lldecl, &mir, instance, sig);
609 }
610
611 pub fn llvm_linkage_by_name(name: &str) -> Option<Linkage> {
612     // Use the names from src/llvm/docs/LangRef.rst here. Most types are only
613     // applicable to variable declarations and may not really make sense for
614     // Rust code in the first place but whitelist them anyway and trust that
615     // the user knows what s/he's doing. Who knows, unanticipated use cases
616     // may pop up in the future.
617     //
618     // ghost, dllimport, dllexport and linkonce_odr_autohide are not supported
619     // and don't have to be, LLVM treats them as no-ops.
620     match name {
621         "appending" => Some(llvm::Linkage::AppendingLinkage),
622         "available_externally" => Some(llvm::Linkage::AvailableExternallyLinkage),
623         "common" => Some(llvm::Linkage::CommonLinkage),
624         "extern_weak" => Some(llvm::Linkage::ExternalWeakLinkage),
625         "external" => Some(llvm::Linkage::ExternalLinkage),
626         "internal" => Some(llvm::Linkage::InternalLinkage),
627         "linkonce" => Some(llvm::Linkage::LinkOnceAnyLinkage),
628         "linkonce_odr" => Some(llvm::Linkage::LinkOnceODRLinkage),
629         "private" => Some(llvm::Linkage::PrivateLinkage),
630         "weak" => Some(llvm::Linkage::WeakAnyLinkage),
631         "weak_odr" => Some(llvm::Linkage::WeakODRLinkage),
632         _ => None,
633     }
634 }
635
636 pub fn set_link_section(ccx: &CrateContext,
637                         llval: ValueRef,
638                         attrs: &[ast::Attribute]) {
639     if let Some(sect) = attr::first_attr_value_str_by_name(attrs, "link_section") {
640         if contains_null(&sect.as_str()) {
641             ccx.sess().fatal(&format!("Illegal null byte in link_section value: `{}`", &sect));
642         }
643         unsafe {
644             let buf = CString::new(sect.as_str().as_bytes()).unwrap();
645             llvm::LLVMSetSection(llval, buf.as_ptr());
646         }
647     }
648 }
649
650 /// Create the `main` function which will initialise the rust runtime and call
651 /// users main function.
652 pub fn maybe_create_entry_wrapper(ccx: &CrateContext) {
653     let (main_def_id, span) = match *ccx.sess().entry_fn.borrow() {
654         Some((id, span)) => {
655             (ccx.tcx().hir.local_def_id(id), span)
656         }
657         None => return,
658     };
659
660     // check for the #[rustc_error] annotation, which forces an
661     // error in trans. This is used to write compile-fail tests
662     // that actually test that compilation succeeds without
663     // reporting an error.
664     if ccx.tcx().has_attr(main_def_id, "rustc_error") {
665         ccx.tcx().sess.span_fatal(span, "compilation successful");
666     }
667
668     let instance = Instance::mono(ccx.tcx(), main_def_id);
669
670     if !ccx.codegen_unit().contains_item(&TransItem::Fn(instance)) {
671         // We want to create the wrapper in the same codegen unit as Rust's main
672         // function.
673         return;
674     }
675
676     let main_llfn = callee::get_fn(ccx, instance);
677
678     let et = ccx.sess().entry_type.get().unwrap();
679     match et {
680         config::EntryMain => create_entry_fn(ccx, span, main_llfn, true),
681         config::EntryStart => create_entry_fn(ccx, span, main_llfn, false),
682         config::EntryNone => {}    // Do nothing.
683     }
684
685     fn create_entry_fn(ccx: &CrateContext,
686                        sp: Span,
687                        rust_main: ValueRef,
688                        use_start_lang_item: bool) {
689         let llfty = Type::func(&[ccx.int_type(), Type::i8p(ccx).ptr_to()], &ccx.int_type());
690
691         if declare::get_defined_value(ccx, "main").is_some() {
692             // FIXME: We should be smart and show a better diagnostic here.
693             ccx.sess().struct_span_err(sp, "entry symbol `main` defined multiple times")
694                       .help("did you use #[no_mangle] on `fn main`? Use #[start] instead")
695                       .emit();
696             ccx.sess().abort_if_errors();
697             bug!();
698         }
699         let llfn = declare::declare_cfn(ccx, "main", llfty);
700
701         // `main` should respect same config for frame pointer elimination as rest of code
702         attributes::set_frame_pointer_elimination(ccx, llfn);
703
704         let bld = Builder::new_block(ccx, llfn, "top");
705
706         debuginfo::gdb::insert_reference_to_gdb_debug_scripts_section_global(ccx, &bld);
707
708         let (start_fn, args) = if use_start_lang_item {
709             let start_def_id = ccx.tcx().require_lang_item(StartFnLangItem);
710             let start_instance = Instance::mono(ccx.tcx(), start_def_id);
711             let start_fn = callee::get_fn(ccx, start_instance);
712             (start_fn, vec![bld.pointercast(rust_main, Type::i8p(ccx).ptr_to()), get_param(llfn, 0),
713                 get_param(llfn, 1)])
714         } else {
715             debug!("using user-defined start fn");
716             (rust_main, vec![get_param(llfn, 0 as c_uint), get_param(llfn, 1 as c_uint)])
717         };
718
719         let result = bld.call(start_fn, &args, None);
720         bld.ret(result);
721     }
722 }
723
724 fn contains_null(s: &str) -> bool {
725     s.bytes().any(|b| b == 0)
726 }
727
728 fn write_metadata(cx: &SharedCrateContext,
729                   exported_symbols: &NodeSet) -> Vec<u8> {
730     use flate;
731
732     #[derive(PartialEq, Eq, PartialOrd, Ord)]
733     enum MetadataKind {
734         None,
735         Uncompressed,
736         Compressed
737     }
738
739     let kind = cx.sess().crate_types.borrow().iter().map(|ty| {
740         match *ty {
741             config::CrateTypeExecutable |
742             config::CrateTypeStaticlib |
743             config::CrateTypeCdylib => MetadataKind::None,
744
745             config::CrateTypeRlib => MetadataKind::Uncompressed,
746
747             config::CrateTypeDylib |
748             config::CrateTypeProcMacro => MetadataKind::Compressed,
749         }
750     }).max().unwrap();
751
752     if kind == MetadataKind::None {
753         return Vec::new();
754     }
755
756     let cstore = &cx.tcx().sess.cstore;
757     let metadata = cstore.encode_metadata(cx.tcx(),
758                                           cx.link_meta(),
759                                           exported_symbols);
760     if kind == MetadataKind::Uncompressed {
761         return metadata;
762     }
763
764     assert!(kind == MetadataKind::Compressed);
765     let mut compressed = cstore.metadata_encoding_version().to_vec();
766     compressed.extend_from_slice(&flate::deflate_bytes(&metadata));
767
768     let llmeta = C_bytes_in_context(cx.metadata_llcx(), &compressed);
769     let llconst = C_struct_in_context(cx.metadata_llcx(), &[llmeta], false);
770     let name = cx.metadata_symbol_name();
771     let buf = CString::new(name).unwrap();
772     let llglobal = unsafe {
773         llvm::LLVMAddGlobal(cx.metadata_llmod(), val_ty(llconst).to_ref(), buf.as_ptr())
774     };
775     unsafe {
776         llvm::LLVMSetInitializer(llglobal, llconst);
777         let section_name =
778             cx.tcx().sess.cstore.metadata_section_name(&cx.sess().target.target);
779         let name = CString::new(section_name).unwrap();
780         llvm::LLVMSetSection(llglobal, name.as_ptr());
781
782         // Also generate a .section directive to force no
783         // flags, at least for ELF outputs, so that the
784         // metadata doesn't get loaded into memory.
785         let directive = format!(".section {}", section_name);
786         let directive = CString::new(directive).unwrap();
787         llvm::LLVMSetModuleInlineAsm(cx.metadata_llmod(), directive.as_ptr())
788     }
789     return metadata;
790 }
791
792 /// Find any symbols that are defined in one compilation unit, but not declared
793 /// in any other compilation unit.  Give these symbols internal linkage.
794 fn internalize_symbols<'a, 'tcx>(sess: &Session,
795                                  ccxs: &CrateContextList<'a, 'tcx>,
796                                  symbol_map: &SymbolMap<'tcx>,
797                                  exported_symbols: &ExportedSymbols) {
798     let export_threshold =
799         symbol_export::crates_export_threshold(&sess.crate_types.borrow());
800
801     let exported_symbols = exported_symbols
802         .exported_symbols(LOCAL_CRATE)
803         .iter()
804         .filter(|&&(_, export_level)| {
805             symbol_export::is_below_threshold(export_level, export_threshold)
806         })
807         .map(|&(ref name, _)| &name[..])
808         .collect::<FxHashSet<&str>>();
809
810     let scx = ccxs.shared();
811     let tcx = scx.tcx();
812
813     let incr_comp = sess.opts.debugging_opts.incremental.is_some();
814
815     // 'unsafe' because we are holding on to CStr's from the LLVM module within
816     // this block.
817     unsafe {
818         let mut referenced_somewhere = FxHashSet();
819
820         // Collect all symbols that need to stay externally visible because they
821         // are referenced via a declaration in some other codegen unit. In
822         // incremental compilation, we don't need to collect. See below for more
823         // information.
824         if !incr_comp {
825             for ccx in ccxs.iter_need_trans() {
826                 for val in iter_globals(ccx.llmod()).chain(iter_functions(ccx.llmod())) {
827                     let linkage = llvm::LLVMRustGetLinkage(val);
828                     // We only care about external declarations (not definitions)
829                     // and available_externally definitions.
830                     let is_available_externally =
831                         linkage == llvm::Linkage::AvailableExternallyLinkage;
832                     let is_decl = llvm::LLVMIsDeclaration(val) == llvm::True;
833
834                     if is_decl || is_available_externally {
835                         let symbol_name = CStr::from_ptr(llvm::LLVMGetValueName(val));
836                         referenced_somewhere.insert(symbol_name);
837                     }
838                 }
839             }
840         }
841
842         // Also collect all symbols for which we cannot adjust linkage, because
843         // it is fixed by some directive in the source code.
844         let (locally_defined_symbols, linkage_fixed_explicitly) = {
845             let mut locally_defined_symbols = FxHashSet();
846             let mut linkage_fixed_explicitly = FxHashSet();
847
848             for trans_item in scx.translation_items().borrow().iter() {
849                 let symbol_name = symbol_map.get_or_compute(scx, *trans_item);
850                 if trans_item.explicit_linkage(tcx).is_some() {
851                     linkage_fixed_explicitly.insert(symbol_name.clone());
852                 }
853                 locally_defined_symbols.insert(symbol_name);
854             }
855
856             (locally_defined_symbols, linkage_fixed_explicitly)
857         };
858
859         // Examine each external definition.  If the definition is not used in
860         // any other compilation unit, and is not reachable from other crates,
861         // then give it internal linkage.
862         for ccx in ccxs.iter_need_trans() {
863             for val in iter_globals(ccx.llmod()).chain(iter_functions(ccx.llmod())) {
864                 let linkage = llvm::LLVMRustGetLinkage(val);
865
866                 let is_externally_visible = (linkage == llvm::Linkage::ExternalLinkage) ||
867                                             (linkage == llvm::Linkage::LinkOnceODRLinkage) ||
868                                             (linkage == llvm::Linkage::WeakODRLinkage);
869
870                 if !is_externally_visible {
871                     // This symbol is not visible outside of its codegen unit,
872                     // so there is nothing to do for it.
873                     continue;
874                 }
875
876                 let name_cstr = CStr::from_ptr(llvm::LLVMGetValueName(val));
877                 let name_str = name_cstr.to_str().unwrap();
878
879                 if exported_symbols.contains(&name_str) {
880                     // This symbol is explicitly exported, so we can't
881                     // mark it as internal or hidden.
882                     continue;
883                 }
884
885                 let is_declaration = llvm::LLVMIsDeclaration(val) == llvm::True;
886
887                 if is_declaration {
888                     if locally_defined_symbols.contains(name_str) {
889                         // Only mark declarations from the current crate as hidden.
890                         // Otherwise we would mark things as hidden that are
891                         // imported from other crates or native libraries.
892                         llvm::LLVMRustSetVisibility(val, llvm::Visibility::Hidden);
893                     }
894                 } else {
895                     let has_fixed_linkage = linkage_fixed_explicitly.contains(name_str);
896
897                     if !has_fixed_linkage {
898                         // In incremental compilation mode, we can't be sure that
899                         // we saw all references because we don't know what's in
900                         // cached compilation units, so we always assume that the
901                         // given item has been referenced.
902                         if incr_comp || referenced_somewhere.contains(&name_cstr) {
903                             llvm::LLVMRustSetVisibility(val, llvm::Visibility::Hidden);
904                         } else {
905                             llvm::LLVMRustSetLinkage(val, llvm::Linkage::InternalLinkage);
906                         }
907
908                         llvm::LLVMSetDLLStorageClass(val, llvm::DLLStorageClass::Default);
909                         llvm::UnsetComdat(val);
910                     }
911                 }
912             }
913         }
914     }
915 }
916
917 // Create a `__imp_<symbol> = &symbol` global for every public static `symbol`.
918 // This is required to satisfy `dllimport` references to static data in .rlibs
919 // when using MSVC linker.  We do this only for data, as linker can fix up
920 // code references on its own.
921 // See #26591, #27438
922 fn create_imps(cx: &CrateContextList) {
923     // The x86 ABI seems to require that leading underscores are added to symbol
924     // names, so we need an extra underscore on 32-bit. There's also a leading
925     // '\x01' here which disables LLVM's symbol mangling (e.g. no extra
926     // underscores added in front).
927     let prefix = if cx.shared().sess().target.target.target_pointer_width == "32" {
928         "\x01__imp__"
929     } else {
930         "\x01__imp_"
931     };
932     unsafe {
933         for ccx in cx.iter_need_trans() {
934             let exported: Vec<_> = iter_globals(ccx.llmod())
935                                        .filter(|&val| {
936                                            llvm::LLVMRustGetLinkage(val) ==
937                                            llvm::Linkage::ExternalLinkage &&
938                                            llvm::LLVMIsDeclaration(val) == 0
939                                        })
940                                        .collect();
941
942             let i8p_ty = Type::i8p(&ccx);
943             for val in exported {
944                 let name = CStr::from_ptr(llvm::LLVMGetValueName(val));
945                 let mut imp_name = prefix.as_bytes().to_vec();
946                 imp_name.extend(name.to_bytes());
947                 let imp_name = CString::new(imp_name).unwrap();
948                 let imp = llvm::LLVMAddGlobal(ccx.llmod(),
949                                               i8p_ty.to_ref(),
950                                               imp_name.as_ptr() as *const _);
951                 let init = llvm::LLVMConstBitCast(val, i8p_ty.to_ref());
952                 llvm::LLVMSetInitializer(imp, init);
953                 llvm::LLVMRustSetLinkage(imp, llvm::Linkage::ExternalLinkage);
954             }
955         }
956     }
957 }
958
959 struct ValueIter {
960     cur: ValueRef,
961     step: unsafe extern "C" fn(ValueRef) -> ValueRef,
962 }
963
964 impl Iterator for ValueIter {
965     type Item = ValueRef;
966
967     fn next(&mut self) -> Option<ValueRef> {
968         let old = self.cur;
969         if !old.is_null() {
970             self.cur = unsafe { (self.step)(old) };
971             Some(old)
972         } else {
973             None
974         }
975     }
976 }
977
978 fn iter_globals(llmod: llvm::ModuleRef) -> ValueIter {
979     unsafe {
980         ValueIter {
981             cur: llvm::LLVMGetFirstGlobal(llmod),
982             step: llvm::LLVMGetNextGlobal,
983         }
984     }
985 }
986
987 fn iter_functions(llmod: llvm::ModuleRef) -> ValueIter {
988     unsafe {
989         ValueIter {
990             cur: llvm::LLVMGetFirstFunction(llmod),
991             step: llvm::LLVMGetNextFunction,
992         }
993     }
994 }
995
996 /// The context provided lists a set of reachable ids as calculated by
997 /// middle::reachable, but this contains far more ids and symbols than we're
998 /// actually exposing from the object file. This function will filter the set in
999 /// the context to the set of ids which correspond to symbols that are exposed
1000 /// from the object file being generated.
1001 ///
1002 /// This list is later used by linkers to determine the set of symbols needed to
1003 /// be exposed from a dynamic library and it's also encoded into the metadata.
1004 pub fn find_exported_symbols(tcx: TyCtxt, reachable: NodeSet) -> NodeSet {
1005     reachable.into_iter().filter(|&id| {
1006         // Next, we want to ignore some FFI functions that are not exposed from
1007         // this crate. Reachable FFI functions can be lumped into two
1008         // categories:
1009         //
1010         // 1. Those that are included statically via a static library
1011         // 2. Those included otherwise (e.g. dynamically or via a framework)
1012         //
1013         // Although our LLVM module is not literally emitting code for the
1014         // statically included symbols, it's an export of our library which
1015         // needs to be passed on to the linker and encoded in the metadata.
1016         //
1017         // As a result, if this id is an FFI item (foreign item) then we only
1018         // let it through if it's included statically.
1019         match tcx.hir.get(id) {
1020             hir_map::NodeForeignItem(..) => {
1021                 let def_id = tcx.hir.local_def_id(id);
1022                 tcx.sess.cstore.is_statically_included_foreign_item(def_id)
1023             }
1024
1025             // Only consider nodes that actually have exported symbols.
1026             hir_map::NodeItem(&hir::Item {
1027                 node: hir::ItemStatic(..), .. }) |
1028             hir_map::NodeItem(&hir::Item {
1029                 node: hir::ItemFn(..), .. }) |
1030             hir_map::NodeImplItem(&hir::ImplItem {
1031                 node: hir::ImplItemKind::Method(..), .. }) => {
1032                 let def_id = tcx.hir.local_def_id(id);
1033                 let generics = tcx.item_generics(def_id);
1034                 let attributes = tcx.get_attrs(def_id);
1035                 (generics.parent_types == 0 && generics.types.is_empty()) &&
1036                 // Functions marked with #[inline] are only ever translated
1037                 // with "internal" linkage and are never exported.
1038                 !attr::requests_inline(&attributes)
1039             }
1040
1041             _ => false
1042         }
1043     }).collect()
1044 }
1045
1046 pub fn trans_crate<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1047                              analysis: ty::CrateAnalysis,
1048                              incremental_hashes_map: &IncrementalHashesMap)
1049                              -> CrateTranslation {
1050     let _task = tcx.dep_graph.in_task(DepNode::TransCrate);
1051
1052     // Be careful with this krate: obviously it gives access to the
1053     // entire contents of the krate. So if you push any subtasks of
1054     // `TransCrate`, you need to be careful to register "reads" of the
1055     // particular items that will be processed.
1056     let krate = tcx.hir.krate();
1057
1058     let ty::CrateAnalysis { reachable, name, .. } = analysis;
1059     let exported_symbols = find_exported_symbols(tcx, reachable);
1060
1061     let check_overflow = tcx.sess.overflow_checks();
1062
1063     let link_meta = link::build_link_meta(incremental_hashes_map, &name);
1064
1065     let shared_ccx = SharedCrateContext::new(tcx,
1066                                              link_meta.clone(),
1067                                              exported_symbols,
1068                                              check_overflow);
1069     // Translate the metadata.
1070     let metadata = time(tcx.sess.time_passes(), "write metadata", || {
1071         write_metadata(&shared_ccx, shared_ccx.exported_symbols())
1072     });
1073
1074     let metadata_module = ModuleTranslation {
1075         name: link::METADATA_MODULE_NAME.to_string(),
1076         symbol_name_hash: 0, // we always rebuild metadata, at least for now
1077         source: ModuleSource::Translated(ModuleLlvm {
1078             llcx: shared_ccx.metadata_llcx(),
1079             llmod: shared_ccx.metadata_llmod(),
1080         }),
1081     };
1082     let no_builtins = attr::contains_name(&krate.attrs, "no_builtins");
1083
1084     // Skip crate items and just output metadata in -Z no-trans mode.
1085     if tcx.sess.opts.debugging_opts.no_trans ||
1086        !tcx.sess.opts.output_types.should_trans() {
1087         let empty_exported_symbols = ExportedSymbols::empty();
1088         let linker_info = LinkerInfo::new(&shared_ccx, &empty_exported_symbols);
1089         return CrateTranslation {
1090             modules: vec![],
1091             metadata_module: metadata_module,
1092             link: link_meta,
1093             metadata: metadata,
1094             exported_symbols: empty_exported_symbols,
1095             no_builtins: no_builtins,
1096             linker_info: linker_info,
1097             windows_subsystem: None,
1098         };
1099     }
1100
1101     // Run the translation item collector and partition the collected items into
1102     // codegen units.
1103     let (codegen_units, symbol_map) = collect_and_partition_translation_items(&shared_ccx);
1104
1105     let symbol_map = Rc::new(symbol_map);
1106
1107     let previous_work_products = trans_reuse_previous_work_products(&shared_ccx,
1108                                                                     &codegen_units,
1109                                                                     &symbol_map);
1110
1111     let crate_context_list = CrateContextList::new(&shared_ccx,
1112                                                    codegen_units,
1113                                                    previous_work_products,
1114                                                    symbol_map.clone());
1115     let modules: Vec<_> = crate_context_list.iter_all()
1116         .map(|ccx| {
1117             let source = match ccx.previous_work_product() {
1118                 Some(buf) => ModuleSource::Preexisting(buf.clone()),
1119                 None => ModuleSource::Translated(ModuleLlvm {
1120                     llcx: ccx.llcx(),
1121                     llmod: ccx.llmod(),
1122                 }),
1123             };
1124
1125             ModuleTranslation {
1126                 name: String::from(ccx.codegen_unit().name()),
1127                 symbol_name_hash: ccx.codegen_unit()
1128                                      .compute_symbol_name_hash(&shared_ccx,
1129                                                                &symbol_map),
1130                 source: source,
1131             }
1132         })
1133         .collect();
1134
1135     assert_module_sources::assert_module_sources(tcx, &modules);
1136
1137     // Instantiate translation items without filling out definitions yet...
1138     for ccx in crate_context_list.iter_need_trans() {
1139         let dep_node = ccx.codegen_unit().work_product_dep_node();
1140         tcx.dep_graph.with_task(dep_node,
1141                                 ccx,
1142                                 AssertDepGraphSafe(symbol_map.clone()),
1143                                 trans_decl_task);
1144
1145         fn trans_decl_task<'a, 'tcx>(ccx: CrateContext<'a, 'tcx>,
1146                                      symbol_map: AssertDepGraphSafe<Rc<SymbolMap<'tcx>>>) {
1147             // FIXME(#40304): Instead of this, the symbol-map should be an
1148             // on-demand thing that we compute.
1149             let AssertDepGraphSafe(symbol_map) = symbol_map;
1150             let cgu = ccx.codegen_unit();
1151             let trans_items = cgu.items_in_deterministic_order(ccx.tcx(), &symbol_map);
1152             for (trans_item, linkage) in trans_items {
1153                 trans_item.predefine(&ccx, linkage);
1154             }
1155         }
1156     }
1157
1158     // ... and now that we have everything pre-defined, fill out those definitions.
1159     for ccx in crate_context_list.iter_need_trans() {
1160         let dep_node = ccx.codegen_unit().work_product_dep_node();
1161         tcx.dep_graph.with_task(dep_node,
1162                                 ccx,
1163                                 AssertDepGraphSafe(symbol_map.clone()),
1164                                 trans_def_task);
1165
1166         fn trans_def_task<'a, 'tcx>(ccx: CrateContext<'a, 'tcx>,
1167                                     symbol_map: AssertDepGraphSafe<Rc<SymbolMap<'tcx>>>) {
1168             // FIXME(#40304): Instead of this, the symbol-map should be an
1169             // on-demand thing that we compute.
1170             let AssertDepGraphSafe(symbol_map) = symbol_map;
1171             let cgu = ccx.codegen_unit();
1172             let trans_items = cgu.items_in_deterministic_order(ccx.tcx(), &symbol_map);
1173             for (trans_item, _) in trans_items {
1174                 trans_item.define(&ccx);
1175             }
1176
1177             // If this codegen unit contains the main function, also create the
1178             // wrapper here
1179             maybe_create_entry_wrapper(&ccx);
1180
1181             // Run replace-all-uses-with for statics that need it
1182             for &(old_g, new_g) in ccx.statics_to_rauw().borrow().iter() {
1183                 unsafe {
1184                     let bitcast = llvm::LLVMConstPointerCast(new_g, llvm::LLVMTypeOf(old_g));
1185                     llvm::LLVMReplaceAllUsesWith(old_g, bitcast);
1186                     llvm::LLVMDeleteGlobal(old_g);
1187                 }
1188             }
1189
1190             // Create the llvm.used variable
1191             // This variable has type [N x i8*] and is stored in the llvm.metadata section
1192             if !ccx.used_statics().borrow().is_empty() {
1193                 let name = CString::new("llvm.used").unwrap();
1194                 let section = CString::new("llvm.metadata").unwrap();
1195                 let array = C_array(Type::i8(&ccx).ptr_to(), &*ccx.used_statics().borrow());
1196
1197                 unsafe {
1198                     let g = llvm::LLVMAddGlobal(ccx.llmod(),
1199                                                 val_ty(array).to_ref(),
1200                                                 name.as_ptr());
1201                     llvm::LLVMSetInitializer(g, array);
1202                     llvm::LLVMRustSetLinkage(g, llvm::Linkage::AppendingLinkage);
1203                     llvm::LLVMSetSection(g, section.as_ptr());
1204                 }
1205             }
1206
1207             // Finalize debuginfo
1208             if ccx.sess().opts.debuginfo != NoDebugInfo {
1209                 debuginfo::finalize(&ccx);
1210             }
1211         }
1212     }
1213
1214     symbol_names_test::report_symbol_names(&shared_ccx);
1215
1216     if shared_ccx.sess().trans_stats() {
1217         let stats = shared_ccx.stats();
1218         println!("--- trans stats ---");
1219         println!("n_glues_created: {}", stats.n_glues_created.get());
1220         println!("n_null_glues: {}", stats.n_null_glues.get());
1221         println!("n_real_glues: {}", stats.n_real_glues.get());
1222
1223         println!("n_fns: {}", stats.n_fns.get());
1224         println!("n_inlines: {}", stats.n_inlines.get());
1225         println!("n_closures: {}", stats.n_closures.get());
1226         println!("fn stats:");
1227         stats.fn_stats.borrow_mut().sort_by(|&(_, insns_a), &(_, insns_b)| {
1228             insns_b.cmp(&insns_a)
1229         });
1230         for tuple in stats.fn_stats.borrow().iter() {
1231             match *tuple {
1232                 (ref name, insns) => {
1233                     println!("{} insns, {}", insns, *name);
1234                 }
1235             }
1236         }
1237     }
1238
1239     if shared_ccx.sess().count_llvm_insns() {
1240         for (k, v) in shared_ccx.stats().llvm_insns.borrow().iter() {
1241             println!("{:7} {}", *v, *k);
1242         }
1243     }
1244
1245     let sess = shared_ccx.sess();
1246
1247     let exported_symbols = ExportedSymbols::compute_from(&shared_ccx,
1248                                                          &symbol_map);
1249
1250     // Now that we have all symbols that are exported from the CGUs of this
1251     // crate, we can run the `internalize_symbols` pass.
1252     time(shared_ccx.sess().time_passes(), "internalize symbols", || {
1253         internalize_symbols(sess,
1254                             &crate_context_list,
1255                             &symbol_map,
1256                             &exported_symbols);
1257     });
1258
1259     if tcx.sess.opts.debugging_opts.print_type_sizes {
1260         gather_type_sizes(tcx);
1261     }
1262
1263     if sess.target.target.options.is_like_msvc &&
1264        sess.crate_types.borrow().iter().any(|ct| *ct == config::CrateTypeRlib) {
1265         create_imps(&crate_context_list);
1266     }
1267
1268     let linker_info = LinkerInfo::new(&shared_ccx, &exported_symbols);
1269
1270     let subsystem = attr::first_attr_value_str_by_name(&krate.attrs,
1271                                                        "windows_subsystem");
1272     let windows_subsystem = subsystem.map(|subsystem| {
1273         if subsystem != "windows" && subsystem != "console" {
1274             tcx.sess.fatal(&format!("invalid windows subsystem `{}`, only \
1275                                      `windows` and `console` are allowed",
1276                                     subsystem));
1277         }
1278         subsystem.to_string()
1279     });
1280
1281     CrateTranslation {
1282         modules: modules,
1283         metadata_module: metadata_module,
1284         link: link_meta,
1285         metadata: metadata,
1286         exported_symbols: exported_symbols,
1287         no_builtins: no_builtins,
1288         linker_info: linker_info,
1289         windows_subsystem: windows_subsystem,
1290     }
1291 }
1292
1293 fn gather_type_sizes<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>) {
1294     let layout_cache = tcx.layout_cache.borrow();
1295     for (ty, layout) in layout_cache.iter() {
1296
1297         // (delay format until we actually need it)
1298         let record = |kind, opt_discr_size, variants| {
1299             let type_desc = format!("{:?}", ty);
1300             let overall_size = layout.size(&tcx.data_layout);
1301             let align = layout.align(&tcx.data_layout);
1302             tcx.sess.code_stats.borrow_mut().record_type_size(kind,
1303                                                               type_desc,
1304                                                               align,
1305                                                               overall_size,
1306                                                               opt_discr_size,
1307                                                               variants);
1308         };
1309
1310         let (adt_def, substs) = match ty.sty {
1311             ty::TyAdt(ref adt_def, substs) => {
1312                 debug!("print-type-size t: `{:?}` process adt", ty);
1313                 (adt_def, substs)
1314             }
1315
1316             ty::TyClosure(..) => {
1317                 debug!("print-type-size t: `{:?}` record closure", ty);
1318                 record(DataTypeKind::Closure, None, vec![]);
1319                 continue;
1320             }
1321
1322             _ => {
1323                 debug!("print-type-size t: `{:?}` skip non-nominal", ty);
1324                 continue;
1325             }
1326         };
1327
1328         let adt_kind = adt_def.adt_kind();
1329
1330         let build_field_info = |(field_name, field_ty): (ast::Name, Ty), offset: &layout::Size| {
1331             match layout_cache.get(&field_ty) {
1332                 None => bug!("no layout found for field {} type: `{:?}`", field_name, field_ty),
1333                 Some(field_layout) => {
1334                     session::FieldInfo {
1335                         name: field_name.to_string(),
1336                         offset: offset.bytes(),
1337                         size: field_layout.size(&tcx.data_layout).bytes(),
1338                         align: field_layout.align(&tcx.data_layout).abi(),
1339                     }
1340                 }
1341             }
1342         };
1343
1344         let build_primitive_info = |name: ast::Name, value: &layout::Primitive| {
1345             session::VariantInfo {
1346                 name: Some(name.to_string()),
1347                 kind: session::SizeKind::Exact,
1348                 align: value.align(&tcx.data_layout).abi(),
1349                 size: value.size(&tcx.data_layout).bytes(),
1350                 fields: vec![],
1351             }
1352         };
1353
1354         enum Fields<'a> {
1355             WithDiscrim(&'a layout::Struct),
1356             NoDiscrim(&'a layout::Struct),
1357         }
1358
1359         let build_variant_info = |n: Option<ast::Name>, flds: &[(ast::Name, Ty)], layout: Fields| {
1360             let (s, field_offsets) = match layout {
1361                 Fields::WithDiscrim(s) => (s, &s.offsets[1..]),
1362                 Fields::NoDiscrim(s) => (s, &s.offsets[0..]),
1363             };
1364             let field_info: Vec<_> = flds.iter()
1365                 .zip(field_offsets.iter())
1366                 .map(|(&field_name_ty, offset)| build_field_info(field_name_ty, offset))
1367                 .collect();
1368
1369             session::VariantInfo {
1370                 name: n.map(|n|n.to_string()),
1371                 kind: if s.sized {
1372                     session::SizeKind::Exact
1373                 } else {
1374                     session::SizeKind::Min
1375                 },
1376                 align: s.align.abi(),
1377                 size: s.min_size.bytes(),
1378                 fields: field_info,
1379             }
1380         };
1381
1382         match **layout {
1383             Layout::StructWrappedNullablePointer { nonnull: ref variant_layout,
1384                                                    nndiscr,
1385                                                    discrfield: _,
1386                                                    discrfield_source: _ } => {
1387                 debug!("print-type-size t: `{:?}` adt struct-wrapped nullable nndiscr {} is {:?}",
1388                        ty, nndiscr, variant_layout);
1389                 let variant_def = &adt_def.variants[nndiscr as usize];
1390                 let fields: Vec<_> = variant_def.fields.iter()
1391                     .map(|field_def| (field_def.name, field_def.ty(tcx, substs)))
1392                     .collect();
1393                 record(adt_kind.into(),
1394                        None,
1395                        vec![build_variant_info(Some(variant_def.name),
1396                                                &fields,
1397                                                Fields::NoDiscrim(variant_layout))]);
1398             }
1399             Layout::RawNullablePointer { nndiscr, value } => {
1400                 debug!("print-type-size t: `{:?}` adt raw nullable nndiscr {} is {:?}",
1401                        ty, nndiscr, value);
1402                 let variant_def = &adt_def.variants[nndiscr as usize];
1403                 record(adt_kind.into(), None,
1404                        vec![build_primitive_info(variant_def.name, &value)]);
1405             }
1406             Layout::Univariant { variant: ref variant_layout, non_zero: _ } => {
1407                 let variant_names = || {
1408                     adt_def.variants.iter().map(|v|format!("{}", v.name)).collect::<Vec<_>>()
1409                 };
1410                 debug!("print-type-size t: `{:?}` adt univariant {:?} variants: {:?}",
1411                        ty, variant_layout, variant_names());
1412                 assert!(adt_def.variants.len() <= 1,
1413                         "univariant with variants {:?}", variant_names());
1414                 if adt_def.variants.len() == 1 {
1415                     let variant_def = &adt_def.variants[0];
1416                     let fields: Vec<_> = variant_def.fields.iter()
1417                         .map(|field_def| (field_def.name, field_def.ty(tcx, substs)))
1418                         .collect();
1419                     record(adt_kind.into(),
1420                            None,
1421                            vec![build_variant_info(Some(variant_def.name),
1422                                                    &fields,
1423                                                    Fields::NoDiscrim(variant_layout))]);
1424                 } else {
1425                     // (This case arises for *empty* enums; so give it
1426                     // zero variants.)
1427                     record(adt_kind.into(), None, vec![]);
1428                 }
1429             }
1430
1431             Layout::General { ref variants, discr, .. } => {
1432                 debug!("print-type-size t: `{:?}` adt general variants def {} layouts {} {:?}",
1433                        ty, adt_def.variants.len(), variants.len(), variants);
1434                 let variant_infos: Vec<_> = adt_def.variants.iter()
1435                     .zip(variants.iter())
1436                     .map(|(variant_def, variant_layout)| {
1437                         let fields: Vec<_> = variant_def.fields.iter()
1438                             .map(|field_def| (field_def.name, field_def.ty(tcx, substs)))
1439                             .collect();
1440                         build_variant_info(Some(variant_def.name),
1441                                            &fields,
1442                                            Fields::WithDiscrim(variant_layout))
1443                     })
1444                     .collect();
1445                 record(adt_kind.into(), Some(discr.size()), variant_infos);
1446             }
1447
1448             Layout::UntaggedUnion { ref variants } => {
1449                 debug!("print-type-size t: `{:?}` adt union variants {:?}",
1450                        ty, variants);
1451                 // layout does not currently store info about each
1452                 // variant...
1453                 record(adt_kind.into(), None, Vec::new());
1454             }
1455
1456             Layout::CEnum { discr, .. } => {
1457                 debug!("print-type-size t: `{:?}` adt c-like enum", ty);
1458                 let variant_infos: Vec<_> = adt_def.variants.iter()
1459                     .map(|variant_def| {
1460                         build_primitive_info(variant_def.name,
1461                                              &layout::Primitive::Int(discr))
1462                     })
1463                     .collect();
1464                 record(adt_kind.into(), Some(discr.size()), variant_infos);
1465             }
1466
1467             // other cases provide little interesting (i.e. adjustable
1468             // via representation tweaks) size info beyond total size.
1469             Layout::Scalar { .. } |
1470             Layout::Vector { .. } |
1471             Layout::Array { .. } |
1472             Layout::FatPointer { .. } => {
1473                 debug!("print-type-size t: `{:?}` adt other", ty);
1474                 record(adt_kind.into(), None, Vec::new())
1475             }
1476         }
1477     }
1478 }
1479
1480 /// For each CGU, identify if we can reuse an existing object file (or
1481 /// maybe other context).
1482 fn trans_reuse_previous_work_products(scx: &SharedCrateContext,
1483                                       codegen_units: &[CodegenUnit],
1484                                       symbol_map: &SymbolMap)
1485                                       -> Vec<Option<WorkProduct>> {
1486     debug!("trans_reuse_previous_work_products()");
1487     codegen_units
1488         .iter()
1489         .map(|cgu| {
1490             let id = cgu.work_product_id();
1491
1492             let hash = cgu.compute_symbol_name_hash(scx, symbol_map);
1493
1494             debug!("trans_reuse_previous_work_products: id={:?} hash={}", id, hash);
1495
1496             if let Some(work_product) = scx.dep_graph().previous_work_product(&id) {
1497                 if work_product.input_hash == hash {
1498                     debug!("trans_reuse_previous_work_products: reusing {:?}", work_product);
1499                     return Some(work_product);
1500                 } else {
1501                     if scx.sess().opts.debugging_opts.incremental_info {
1502                         println!("incremental: CGU `{}` invalidated because of \
1503                                   changed partitioning hash.",
1504                                   cgu.name());
1505                     }
1506                     debug!("trans_reuse_previous_work_products: \
1507                             not reusing {:?} because hash changed to {:?}",
1508                            work_product, hash);
1509                 }
1510             }
1511
1512             None
1513         })
1514         .collect()
1515 }
1516
1517 fn collect_and_partition_translation_items<'a, 'tcx>(scx: &SharedCrateContext<'a, 'tcx>)
1518                                                      -> (Vec<CodegenUnit<'tcx>>, SymbolMap<'tcx>) {
1519     let time_passes = scx.sess().time_passes();
1520
1521     let collection_mode = match scx.sess().opts.debugging_opts.print_trans_items {
1522         Some(ref s) => {
1523             let mode_string = s.to_lowercase();
1524             let mode_string = mode_string.trim();
1525             if mode_string == "eager" {
1526                 TransItemCollectionMode::Eager
1527             } else {
1528                 if mode_string != "lazy" {
1529                     let message = format!("Unknown codegen-item collection mode '{}'. \
1530                                            Falling back to 'lazy' mode.",
1531                                            mode_string);
1532                     scx.sess().warn(&message);
1533                 }
1534
1535                 TransItemCollectionMode::Lazy
1536             }
1537         }
1538         None => TransItemCollectionMode::Lazy
1539     };
1540
1541     let (items, inlining_map) =
1542         time(time_passes, "translation item collection", || {
1543             collector::collect_crate_translation_items(&scx, collection_mode)
1544     });
1545
1546     let symbol_map = SymbolMap::build(scx, items.iter().cloned());
1547
1548     let strategy = if scx.sess().opts.debugging_opts.incremental.is_some() {
1549         PartitioningStrategy::PerModule
1550     } else {
1551         PartitioningStrategy::FixedUnitCount(scx.sess().opts.cg.codegen_units)
1552     };
1553
1554     let codegen_units = time(time_passes, "codegen unit partitioning", || {
1555         partitioning::partition(scx,
1556                                 items.iter().cloned(),
1557                                 strategy,
1558                                 &inlining_map)
1559     });
1560
1561     assert!(scx.tcx().sess.opts.cg.codegen_units == codegen_units.len() ||
1562             scx.tcx().sess.opts.debugging_opts.incremental.is_some());
1563
1564     {
1565         let mut ccx_map = scx.translation_items().borrow_mut();
1566
1567         for trans_item in items.iter().cloned() {
1568             ccx_map.insert(trans_item);
1569         }
1570     }
1571
1572     if scx.sess().opts.debugging_opts.print_trans_items.is_some() {
1573         let mut item_to_cgus = FxHashMap();
1574
1575         for cgu in &codegen_units {
1576             for (&trans_item, &linkage) in cgu.items() {
1577                 item_to_cgus.entry(trans_item)
1578                             .or_insert(Vec::new())
1579                             .push((cgu.name().clone(), linkage));
1580             }
1581         }
1582
1583         let mut item_keys: Vec<_> = items
1584             .iter()
1585             .map(|i| {
1586                 let mut output = i.to_string(scx.tcx());
1587                 output.push_str(" @@");
1588                 let mut empty = Vec::new();
1589                 let mut cgus = item_to_cgus.get_mut(i).unwrap_or(&mut empty);
1590                 cgus.as_mut_slice().sort_by_key(|&(ref name, _)| name.clone());
1591                 cgus.dedup();
1592                 for &(ref cgu_name, linkage) in cgus.iter() {
1593                     output.push_str(" ");
1594                     output.push_str(&cgu_name);
1595
1596                     let linkage_abbrev = match linkage {
1597                         llvm::Linkage::ExternalLinkage => "External",
1598                         llvm::Linkage::AvailableExternallyLinkage => "Available",
1599                         llvm::Linkage::LinkOnceAnyLinkage => "OnceAny",
1600                         llvm::Linkage::LinkOnceODRLinkage => "OnceODR",
1601                         llvm::Linkage::WeakAnyLinkage => "WeakAny",
1602                         llvm::Linkage::WeakODRLinkage => "WeakODR",
1603                         llvm::Linkage::AppendingLinkage => "Appending",
1604                         llvm::Linkage::InternalLinkage => "Internal",
1605                         llvm::Linkage::PrivateLinkage => "Private",
1606                         llvm::Linkage::ExternalWeakLinkage => "ExternalWeak",
1607                         llvm::Linkage::CommonLinkage => "Common",
1608                     };
1609
1610                     output.push_str("[");
1611                     output.push_str(linkage_abbrev);
1612                     output.push_str("]");
1613                 }
1614                 output
1615             })
1616             .collect();
1617
1618         item_keys.sort();
1619
1620         for item in item_keys {
1621             println!("TRANS_ITEM {}", item);
1622         }
1623     }
1624
1625     (codegen_units, symbol_map)
1626 }