src/librustc_trans/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 //! Translate the completed AST to the LLVM IR.
  11 //!
  12 //! Some functions here, such as trans_block and trans_expr, return a value --
  13 //! the result of the translation to LLVM -- while others, such as trans_fn,
  14 //! trans_impl, and trans_item, are called only for the side effect of adding a
  15 //! particular definition to the LLVM IR output we're producing.
  16 //!
  17 //! Hopefully useful general knowledge about trans:
  18 //!
  19 //!   * There's no way to find out the Ty type of a ValueRef.  Doing so
  20 //!     would be "trying to get the eggs out of an omelette" (credit:
  21 //!     pcwalton).  You can, instead, find out its TypeRef by calling val_ty,
  22 //!     but one TypeRef corresponds to many `Ty`s; for instance, tup(int, int,
  23 //!     int) and rec(x=int, y=int, z=int) will have the same TypeRef.
  24
  25 #![allow(non_camel_case_types)]
  26
  27 pub use self::ValueOrigin::*;
  28
  29 use super::CrateTranslation;
  30 use super::ModuleTranslation;
  31
  32 use back::link::mangle_exported_name;
  33 use back::{link, abi};
  34 use lint;
  35 use llvm::{BasicBlockRef, Linkage, ValueRef, Vector, get_param};
  36 use llvm;
  37 use middle::cfg;
  38 use middle::cstore::CrateStore;
  39 use middle::def_id::DefId;
  40 use middle::infer;
  41 use middle::lang_items::{LangItem, ExchangeMallocFnLangItem, StartFnLangItem};
  42 use middle::weak_lang_items;
  43 use middle::pat_util::simple_name;
  44 use middle::subst::{self, Substs};
  45 use middle::traits;
  46 use middle::ty::{self, Ty, TypeFoldable};
  47 use middle::ty::adjustment::CustomCoerceUnsized;
  48 use rustc::dep_graph::DepNode;
  49 use rustc::front::map as hir_map;
  50 use rustc::util::common::time;
  51 use rustc::mir::mir_map::MirMap;
  52 use session::config::{self, NoDebugInfo, FullDebugInfo};
  53 use session::Session;
  54 use trans::_match;
  55 use trans::adt;
  56 use trans::assert_dep_graph;
  57 use trans::attributes;
  58 use trans::build::*;
  59 use trans::builder::{Builder, noname};
  60 use trans::callee;
  61 use trans::cleanup::{self, CleanupMethods, DropHint};
  62 use trans::closure;
  63 use trans::common::{Block, C_bool, C_bytes_in_context, C_i32, C_int, C_uint, C_integral};
  64 use trans::collector::{self, TransItem, TransItemState, TransItemCollectionMode};
  65 use trans::common::{C_null, C_struct_in_context, C_u64, C_u8, C_undef};
  66 use trans::common::{CrateContext, DropFlagHintsMap, Field, FunctionContext};
  67 use trans::common::{Result, NodeIdAndSpan, VariantInfo};
  68 use trans::common::{node_id_type, return_type_is_void, fulfill_obligation};
  69 use trans::common::{type_is_immediate, type_is_zero_size, val_ty};
  70 use trans::common;
  71 use trans::consts;
  72 use trans::context::SharedCrateContext;
  73 use trans::controlflow;
  74 use trans::datum;
  75 use trans::debuginfo::{self, DebugLoc, ToDebugLoc};
  76 use trans::declare;
  77 use trans::expr;
  78 use trans::foreign;
  79 use trans::glue;
  80 use trans::intrinsic;
  81 use trans::machine;
  82 use trans::machine::{llsize_of, llsize_of_real};
  83 use trans::meth;
  84 use trans::mir;
  85 use trans::monomorphize;
  86 use trans::tvec;
  87 use trans::type_::Type;
  88 use trans::type_of;
  89 use trans::type_of::*;
  90 use trans::value::Value;
  91 use trans::Disr;
  92 use util::common::indenter;
  93 use util::sha2::Sha256;
  94 use util::nodemap::{NodeMap, NodeSet};
  95
  96 use arena::TypedArena;
  97 use libc::c_uint;
  98 use std::ffi::{CStr, CString};
  99 use std::cell::{Cell, RefCell};
 100 use std::collections::{HashMap, HashSet};
 101 use std::str;
 102 use std::{i8, i16, i32, i64};
 103 use syntax::abi::Abi;
 104 use syntax::codemap::{Span, DUMMY_SP};
 105 use syntax::parse::token::InternedString;
 106 use syntax::attr::AttrMetaMethods;
 107 use syntax::attr;
 108 use rustc_front;
 109 use rustc_front::intravisit::{self, Visitor};
 110 use rustc_front::hir;
 111 use syntax::ast;
 112
 113 thread_local! {
 114     static TASK_LOCAL_INSN_KEY: RefCell<Option<Vec<&'static str>>> = {
 115         RefCell::new(None)
 116     }
 117 }
 118
 119 pub fn with_insn_ctxt<F>(blk: F)
 120     where F: FnOnce(&[&'static str])
 121 {
 122     TASK_LOCAL_INSN_KEY.with(move |slot| {
 123         slot.borrow().as_ref().map(move |s| blk(s));
 124     })
 125 }
 126
 127 pub fn init_insn_ctxt() {
 128     TASK_LOCAL_INSN_KEY.with(|slot| {
 129         *slot.borrow_mut() = Some(Vec::new());
 130     });
 131 }
 132
 133 pub struct _InsnCtxt {
 134     _cannot_construct_outside_of_this_module: (),
 135 }
 136
 137 impl Drop for _InsnCtxt {
 138     fn drop(&mut self) {
 139         TASK_LOCAL_INSN_KEY.with(|slot| {
 140             match slot.borrow_mut().as_mut() {
 141                 Some(ctx) => {
 142                     ctx.pop();
 143                 }
 144                 None => {}
 145             }
 146         })
 147     }
 148 }
 149
 150 pub fn push_ctxt(s: &'static str) -> _InsnCtxt {
 151     debug!("new InsnCtxt: {}", s);
 152     TASK_LOCAL_INSN_KEY.with(|slot| {
 153         match slot.borrow_mut().as_mut() {
 154             Some(ctx) => ctx.push(s),
 155             None => {}
 156         }
 157     });
 158     _InsnCtxt {
 159         _cannot_construct_outside_of_this_module: (),
 160     }
 161 }
 162
 163 pub struct StatRecorder<'a, 'tcx: 'a> {
 164     ccx: &'a CrateContext<'a, 'tcx>,
 165     name: Option<String>,
 166     istart: usize,
 167 }
 168
 169 impl<'a, 'tcx> StatRecorder<'a, 'tcx> {
 170     pub fn new(ccx: &'a CrateContext<'a, 'tcx>, name: String) -> StatRecorder<'a, 'tcx> {
 171         let istart = ccx.stats().n_llvm_insns.get();
 172         StatRecorder {
 173             ccx: ccx,
 174             name: Some(name),
 175             istart: istart,
 176         }
 177     }
 178 }
 179
 180 impl<'a, 'tcx> Drop for StatRecorder<'a, 'tcx> {
 181     fn drop(&mut self) {
 182         if self.ccx.sess().trans_stats() {
 183             let iend = self.ccx.stats().n_llvm_insns.get();
 184             self.ccx
 185                 .stats()
 186                 .fn_stats
 187                 .borrow_mut()
 188                 .push((self.name.take().unwrap(), iend - self.istart));
 189             self.ccx.stats().n_fns.set(self.ccx.stats().n_fns.get() + 1);
 190             // Reset LLVM insn count to avoid compound costs.
 191             self.ccx.stats().n_llvm_insns.set(self.istart);
 192         }
 193     }
 194 }
 195
 196 fn get_extern_rust_fn<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
 197                                 fn_ty: Ty<'tcx>,
 198                                 name: &str,
 199                                 did: DefId)
 200                                 -> ValueRef {
 201     match ccx.externs().borrow().get(name) {
 202         Some(n) => return *n,
 203         None => (),
 204     }
 205
 206     let f = declare::declare_rust_fn(ccx, name, fn_ty);
 207
 208     let attrs = ccx.sess().cstore.item_attrs(did);
 209     attributes::from_fn_attrs(ccx, &attrs[..], f);
 210
 211     ccx.externs().borrow_mut().insert(name.to_string(), f);
 212     f
 213 }
 214
 215 pub fn self_type_for_closure<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
 216                                        closure_id: DefId,
 217                                        fn_ty: Ty<'tcx>)
 218                                        -> Ty<'tcx> {
 219     let closure_kind = ccx.tcx().closure_kind(closure_id);
 220     match closure_kind {
 221         ty::FnClosureKind => {
 222             ccx.tcx().mk_imm_ref(ccx.tcx().mk_region(ty::ReStatic), fn_ty)
 223         }
 224         ty::FnMutClosureKind => {
 225             ccx.tcx().mk_mut_ref(ccx.tcx().mk_region(ty::ReStatic), fn_ty)
 226         }
 227         ty::FnOnceClosureKind => fn_ty,
 228     }
 229 }
 230
 231 pub fn kind_for_closure(ccx: &CrateContext, closure_id: DefId) -> ty::ClosureKind {
 232     *ccx.tcx().tables.borrow().closure_kinds.get(&closure_id).unwrap()
 233 }
 234
 235 pub fn get_extern_const<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
 236                                   did: DefId,
 237                                   t: Ty<'tcx>)
 238                                   -> ValueRef {
 239     let name = ccx.sess().cstore.item_symbol(did);
 240     let ty = type_of(ccx, t);
 241     match ccx.externs().borrow_mut().get(&name) {
 242         Some(n) => return *n,
 243         None => (),
 244     }
 245     // FIXME(nagisa): perhaps the map of externs could be offloaded to llvm somehow?
 246     // FIXME(nagisa): investigate whether it can be changed into define_global
 247     let c = declare::declare_global(ccx, &name[..], ty);
 248     // Thread-local statics in some other crate need to *always* be linked
 249     // against in a thread-local fashion, so we need to be sure to apply the
 250     // thread-local attribute locally if it was present remotely. If we
 251     // don't do this then linker errors can be generated where the linker
 252     // complains that one object files has a thread local version of the
 253     // symbol and another one doesn't.
 254     for attr in ccx.tcx().get_attrs(did).iter() {
 255         if attr.check_name("thread_local") {
 256             llvm::set_thread_local(c, true);
 257         }
 258     }
 259     if ccx.use_dll_storage_attrs() {
 260         llvm::SetDLLStorageClass(c, llvm::DLLImportStorageClass);
 261     }
 262     ccx.externs().borrow_mut().insert(name.to_string(), c);
 263     return c;
 264 }
 265
 266 fn require_alloc_fn<'blk, 'tcx>(bcx: Block<'blk, 'tcx>, info_ty: Ty<'tcx>, it: LangItem) -> DefId {
 267     match bcx.tcx().lang_items.require(it) {
 268         Ok(id) => id,
 269         Err(s) => {
 270             bcx.sess().fatal(&format!("allocation of `{}` {}", info_ty, s));
 271         }
 272     }
 273 }
 274
 275 // The following malloc_raw_dyn* functions allocate a box to contain
 276 // a given type, but with a potentially dynamic size.
 277
 278 pub fn malloc_raw_dyn<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
 279                                   llty_ptr: Type,
 280                                   info_ty: Ty<'tcx>,
 281                                   size: ValueRef,
 282                                   align: ValueRef,
 283                                   debug_loc: DebugLoc)
 284                                   -> Result<'blk, 'tcx> {
 285     let _icx = push_ctxt("malloc_raw_exchange");
 286
 287     // Allocate space:
 288     let r = callee::trans_lang_call(bcx,
 289                                     require_alloc_fn(bcx, info_ty, ExchangeMallocFnLangItem),
 290                                     &[size, align],
 291                                     None,
 292                                     debug_loc);
 293
 294     Result::new(r.bcx, PointerCast(r.bcx, r.val, llty_ptr))
 295 }
 296
 297
 298 pub fn bin_op_to_icmp_predicate(ccx: &CrateContext,
 299                                 op: hir::BinOp_,
 300                                 signed: bool)
 301                                 -> llvm::IntPredicate {
 302     match op {
 303         hir::BiEq => llvm::IntEQ,
 304         hir::BiNe => llvm::IntNE,
 305         hir::BiLt => if signed { llvm::IntSLT } else { llvm::IntULT },
 306         hir::BiLe => if signed { llvm::IntSLE } else { llvm::IntULE },
 307         hir::BiGt => if signed { llvm::IntSGT } else { llvm::IntUGT },
 308         hir::BiGe => if signed { llvm::IntSGE } else { llvm::IntUGE },
 309         op => {
 310             ccx.sess()
 311                .bug(&format!("comparison_op_to_icmp_predicate: expected comparison operator, \
 312                               found {:?}",
 313                              op));
 314         }
 315     }
 316 }
 317
 318 pub fn bin_op_to_fcmp_predicate(ccx: &CrateContext, op: hir::BinOp_) -> llvm::RealPredicate {
 319     match op {
 320         hir::BiEq => llvm::RealOEQ,
 321         hir::BiNe => llvm::RealUNE,
 322         hir::BiLt => llvm::RealOLT,
 323         hir::BiLe => llvm::RealOLE,
 324         hir::BiGt => llvm::RealOGT,
 325         hir::BiGe => llvm::RealOGE,
 326         op => {
 327             ccx.sess()
 328                .bug(&format!("comparison_op_to_fcmp_predicate: expected comparison operator, \
 329                               found {:?}",
 330                              op));
 331         }
 332     }
 333 }
 334
 335 pub fn compare_fat_ptrs<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
 336                                     lhs_addr: ValueRef,
 337                                     lhs_extra: ValueRef,
 338                                     rhs_addr: ValueRef,
 339                                     rhs_extra: ValueRef,
 340                                     _t: Ty<'tcx>,
 341                                     op: hir::BinOp_,
 342                                     debug_loc: DebugLoc)
 343                                     -> ValueRef {
 344     match op {
 345         hir::BiEq => {
 346             let addr_eq = ICmp(bcx, llvm::IntEQ, lhs_addr, rhs_addr, debug_loc);
 347             let extra_eq = ICmp(bcx, llvm::IntEQ, lhs_extra, rhs_extra, debug_loc);
 348             And(bcx, addr_eq, extra_eq, debug_loc)
 349         }
 350         hir::BiNe => {
 351             let addr_eq = ICmp(bcx, llvm::IntNE, lhs_addr, rhs_addr, debug_loc);
 352             let extra_eq = ICmp(bcx, llvm::IntNE, lhs_extra, rhs_extra, debug_loc);
 353             Or(bcx, addr_eq, extra_eq, debug_loc)
 354         }
 355         hir::BiLe | hir::BiLt | hir::BiGe | hir::BiGt => {
 356             // a OP b ~ a.0 STRICT(OP) b.0 | (a.0 == b.0 && a.1 OP a.1)
 357             let (op, strict_op) = match op {
 358                 hir::BiLt => (llvm::IntULT, llvm::IntULT),
 359                 hir::BiLe => (llvm::IntULE, llvm::IntULT),
 360                 hir::BiGt => (llvm::IntUGT, llvm::IntUGT),
 361                 hir::BiGe => (llvm::IntUGE, llvm::IntUGT),
 362                 _ => unreachable!(),
 363             };
 364
 365             let addr_eq = ICmp(bcx, llvm::IntEQ, lhs_addr, rhs_addr, debug_loc);
 366             let extra_op = ICmp(bcx, op, lhs_extra, rhs_extra, debug_loc);
 367             let addr_eq_extra_op = And(bcx, addr_eq, extra_op, debug_loc);
 368
 369             let addr_strict = ICmp(bcx, strict_op, lhs_addr, rhs_addr, debug_loc);
 370             Or(bcx, addr_strict, addr_eq_extra_op, debug_loc)
 371         }
 372         _ => {
 373             bcx.tcx().sess.bug("unexpected fat ptr binop");
 374         }
 375     }
 376 }
 377
 378 pub fn compare_scalar_types<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
 379                                         lhs: ValueRef,
 380                                         rhs: ValueRef,
 381                                         t: Ty<'tcx>,
 382                                         op: hir::BinOp_,
 383                                         debug_loc: DebugLoc)
 384                                         -> ValueRef {
 385     match t.sty {
 386         ty::TyTuple(ref tys) if tys.is_empty() => {
 387             // We don't need to do actual comparisons for nil.
 388             // () == () holds but () < () does not.
 389             match op {
 390                 hir::BiEq | hir::BiLe | hir::BiGe => return C_bool(bcx.ccx(), true),
 391                 hir::BiNe | hir::BiLt | hir::BiGt => return C_bool(bcx.ccx(), false),
 392                 // refinements would be nice
 393                 _ => bcx.sess().bug("compare_scalar_types: must be a comparison operator"),
 394             }
 395         }
 396         ty::TyBareFn(..) | ty::TyBool | ty::TyUint(_) | ty::TyChar => {
 397             ICmp(bcx,
 398                  bin_op_to_icmp_predicate(bcx.ccx(), op, false),
 399                  lhs,
 400                  rhs,
 401                  debug_loc)
 402         }
 403         ty::TyRawPtr(mt) if common::type_is_sized(bcx.tcx(), mt.ty) => {
 404             ICmp(bcx,
 405                  bin_op_to_icmp_predicate(bcx.ccx(), op, false),
 406                  lhs,
 407                  rhs,
 408                  debug_loc)
 409         }
 410         ty::TyRawPtr(_) => {
 411             let lhs_addr = Load(bcx, GEPi(bcx, lhs, &[0, abi::FAT_PTR_ADDR]));
 412             let lhs_extra = Load(bcx, GEPi(bcx, lhs, &[0, abi::FAT_PTR_EXTRA]));
 413
 414             let rhs_addr = Load(bcx, GEPi(bcx, rhs, &[0, abi::FAT_PTR_ADDR]));
 415             let rhs_extra = Load(bcx, GEPi(bcx, rhs, &[0, abi::FAT_PTR_EXTRA]));
 416             compare_fat_ptrs(bcx,
 417                              lhs_addr,
 418                              lhs_extra,
 419                              rhs_addr,
 420                              rhs_extra,
 421                              t,
 422                              op,
 423                              debug_loc)
 424         }
 425         ty::TyInt(_) => {
 426             ICmp(bcx,
 427                  bin_op_to_icmp_predicate(bcx.ccx(), op, true),
 428                  lhs,
 429                  rhs,
 430                  debug_loc)
 431         }
 432         ty::TyFloat(_) => {
 433             FCmp(bcx,
 434                  bin_op_to_fcmp_predicate(bcx.ccx(), op),
 435                  lhs,
 436                  rhs,
 437                  debug_loc)
 438         }
 439         // Should never get here, because t is scalar.
 440         _ => bcx.sess().bug("non-scalar type passed to compare_scalar_types"),
 441     }
 442 }
 443
 444 pub fn compare_simd_types<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
 445                                       lhs: ValueRef,
 446                                       rhs: ValueRef,
 447                                       t: Ty<'tcx>,
 448                                       ret_ty: Type,
 449                                       op: hir::BinOp_,
 450                                       debug_loc: DebugLoc)
 451                                       -> ValueRef {
 452     let signed = match t.sty {
 453         ty::TyFloat(_) => {
 454             let cmp = bin_op_to_fcmp_predicate(bcx.ccx(), op);
 455             return SExt(bcx, FCmp(bcx, cmp, lhs, rhs, debug_loc), ret_ty);
 456         },
 457         ty::TyUint(_) => false,
 458         ty::TyInt(_) => true,
 459         _ => bcx.sess().bug("compare_simd_types: invalid SIMD type"),
 460     };
 461
 462     let cmp = bin_op_to_icmp_predicate(bcx.ccx(), op, signed);
 463     // LLVM outputs an `< size x i1 >`, so we need to perform a sign extension
 464     // to get the correctly sized type. This will compile to a single instruction
 465     // once the IR is converted to assembly if the SIMD instruction is supported
 466     // by the target architecture.
 467     SExt(bcx, ICmp(bcx, cmp, lhs, rhs, debug_loc), ret_ty)
 468 }
 469
 470 // Iterates through the elements of a structural type.
 471 pub fn iter_structural_ty<'blk, 'tcx, F>(cx: Block<'blk, 'tcx>,
 472                                          av: ValueRef,
 473                                          t: Ty<'tcx>,
 474                                          mut f: F)
 475                                          -> Block<'blk, 'tcx>
 476     where F: FnMut(Block<'blk, 'tcx>, ValueRef, Ty<'tcx>) -> Block<'blk, 'tcx>
 477 {
 478     let _icx = push_ctxt("iter_structural_ty");
 479
 480     fn iter_variant<'blk, 'tcx, F>(cx: Block<'blk, 'tcx>,
 481                                    repr: &adt::Repr<'tcx>,
 482                                    av: adt::MaybeSizedValue,
 483                                    variant: ty::VariantDef<'tcx>,
 484                                    substs: &Substs<'tcx>,
 485                                    f: &mut F)
 486                                    -> Block<'blk, 'tcx>
 487         where F: FnMut(Block<'blk, 'tcx>, ValueRef, Ty<'tcx>) -> Block<'blk, 'tcx>
 488     {
 489         let _icx = push_ctxt("iter_variant");
 490         let tcx = cx.tcx();
 491         let mut cx = cx;
 492
 493         for (i, field) in variant.fields.iter().enumerate() {
 494             let arg = monomorphize::field_ty(tcx, substs, field);
 495             cx = f(cx,
 496                    adt::trans_field_ptr(cx, repr, av, Disr::from(variant.disr_val), i),
 497                    arg);
 498         }
 499         return cx;
 500     }
 501
 502     let value = if common::type_is_sized(cx.tcx(), t) {
 503         adt::MaybeSizedValue::sized(av)
 504     } else {
 505         let data = Load(cx, expr::get_dataptr(cx, av));
 506         let info = Load(cx, expr::get_meta(cx, av));
 507         adt::MaybeSizedValue::unsized_(data, info)
 508     };
 509
 510     let mut cx = cx;
 511     match t.sty {
 512         ty::TyStruct(..) => {
 513             let repr = adt::represent_type(cx.ccx(), t);
 514             let VariantInfo { fields, discr } = VariantInfo::from_ty(cx.tcx(), t, None);
 515             for (i, &Field(_, field_ty)) in fields.iter().enumerate() {
 516                 let llfld_a = adt::trans_field_ptr(cx, &*repr, value, Disr::from(discr), i);
 517
 518                 let val = if common::type_is_sized(cx.tcx(), field_ty) {
 519                     llfld_a
 520                 } else {
 521                     let scratch = datum::rvalue_scratch_datum(cx, field_ty, "__fat_ptr_iter");
 522                     Store(cx, llfld_a, expr::get_dataptr(cx, scratch.val));
 523                     Store(cx, value.meta, expr::get_meta(cx, scratch.val));
 524                     scratch.val
 525                 };
 526                 cx = f(cx, val, field_ty);
 527             }
 528         }
 529         ty::TyClosure(_, ref substs) => {
 530             let repr = adt::represent_type(cx.ccx(), t);
 531             for (i, upvar_ty) in substs.upvar_tys.iter().enumerate() {
 532                 let llupvar = adt::trans_field_ptr(cx, &*repr, value, Disr(0), i);
 533                 cx = f(cx, llupvar, upvar_ty);
 534             }
 535         }
 536         ty::TyArray(_, n) => {
 537             let (base, len) = tvec::get_fixed_base_and_len(cx, value.value, n);
 538             let unit_ty = t.sequence_element_type(cx.tcx());
 539             cx = tvec::iter_vec_raw(cx, base, unit_ty, len, f);
 540         }
 541         ty::TySlice(_) | ty::TyStr => {
 542             let unit_ty = t.sequence_element_type(cx.tcx());
 543             cx = tvec::iter_vec_raw(cx, value.value, unit_ty, value.meta, f);
 544         }
 545         ty::TyTuple(ref args) => {
 546             let repr = adt::represent_type(cx.ccx(), t);
 547             for (i, arg) in args.iter().enumerate() {
 548                 let llfld_a = adt::trans_field_ptr(cx, &*repr, value, Disr(0), i);
 549                 cx = f(cx, llfld_a, *arg);
 550             }
 551         }
 552         ty::TyEnum(en, substs) => {
 553             let fcx = cx.fcx;
 554             let ccx = fcx.ccx;
 555
 556             let repr = adt::represent_type(ccx, t);
 557             let n_variants = en.variants.len();
 558
 559             // NB: we must hit the discriminant first so that structural
 560             // comparison know not to proceed when the discriminants differ.
 561
 562             match adt::trans_switch(cx, &*repr, av, false) {
 563                 (_match::Single, None) => {
 564                     if n_variants != 0 {
 565                         assert!(n_variants == 1);
 566                         cx = iter_variant(cx, &*repr, adt::MaybeSizedValue::sized(av),
 567                                           &en.variants[0], substs, &mut f);
 568                     }
 569                 }
 570                 (_match::Switch, Some(lldiscrim_a)) => {
 571                     cx = f(cx, lldiscrim_a, cx.tcx().types.isize);
 572
 573                     // Create a fall-through basic block for the "else" case of
 574                     // the switch instruction we're about to generate. Note that
 575                     // we do **not** use an Unreachable instruction here, even
 576                     // though most of the time this basic block will never be hit.
 577                     //
 578                     // When an enum is dropped it's contents are currently
 579                     // overwritten to DTOR_DONE, which means the discriminant
 580                     // could have changed value to something not within the actual
 581                     // range of the discriminant. Currently this function is only
 582                     // used for drop glue so in this case we just return quickly
 583                     // from the outer function, and any other use case will only
 584                     // call this for an already-valid enum in which case the `ret
 585                     // void` will never be hit.
 586                     let ret_void_cx = fcx.new_temp_block("enum-iter-ret-void");
 587                     RetVoid(ret_void_cx, DebugLoc::None);
 588                     let llswitch = Switch(cx, lldiscrim_a, ret_void_cx.llbb, n_variants);
 589                     let next_cx = fcx.new_temp_block("enum-iter-next");
 590
 591                     for variant in &en.variants {
 592                         let variant_cx = fcx.new_temp_block(&format!("enum-iter-variant-{}",
 593                                                                      &variant.disr_val
 594                                                                              .to_string()));
 595                         let case_val = adt::trans_case(cx, &*repr, Disr::from(variant.disr_val));
 596                         AddCase(llswitch, case_val, variant_cx.llbb);
 597                         let variant_cx = iter_variant(variant_cx,
 598                                                       &*repr,
 599                                                       value,
 600                                                       variant,
 601                                                       substs,
 602                                                       &mut f);
 603                         Br(variant_cx, next_cx.llbb, DebugLoc::None);
 604                     }
 605                     cx = next_cx;
 606                 }
 607                 _ => ccx.sess().unimpl("value from adt::trans_switch in iter_structural_ty"),
 608             }
 609         }
 610         _ => {
 611             cx.sess().unimpl(&format!("type in iter_structural_ty: {}", t))
 612         }
 613     }
 614     return cx;
 615 }
 616
 617
 618 /// Retrieve the information we are losing (making dynamic) in an unsizing
 619 /// adjustment.
 620 ///
 621 /// The `old_info` argument is a bit funny. It is intended for use
 622 /// in an upcast, where the new vtable for an object will be drived
 623 /// from the old one.
 624 pub fn unsized_info<'ccx, 'tcx>(ccx: &CrateContext<'ccx, 'tcx>,
 625                                 source: Ty<'tcx>,
 626                                 target: Ty<'tcx>,
 627                                 old_info: Option<ValueRef>,
 628                                 param_substs: &'tcx Substs<'tcx>)
 629                                 -> ValueRef {
 630     let (source, target) = ccx.tcx().struct_lockstep_tails(source, target);
 631     match (&source.sty, &target.sty) {
 632         (&ty::TyArray(_, len), &ty::TySlice(_)) => C_uint(ccx, len),
 633         (&ty::TyTrait(_), &ty::TyTrait(_)) => {
 634             // For now, upcasts are limited to changes in marker
 635             // traits, and hence never actually require an actual
 636             // change to the vtable.
 637             old_info.expect("unsized_info: missing old info for trait upcast")
 638         }
 639         (_, &ty::TyTrait(box ty::TraitTy { ref principal, .. })) => {
 640             // Note that we preserve binding levels here:
 641             let substs = principal.0.substs.with_self_ty(source).erase_regions();
 642             let substs = ccx.tcx().mk_substs(substs);
 643             let trait_ref = ty::Binder(ty::TraitRef {
 644                 def_id: principal.def_id(),
 645                 substs: substs,
 646             });
 647             consts::ptrcast(meth::get_vtable(ccx, trait_ref, param_substs),
 648                             Type::vtable_ptr(ccx))
 649         }
 650         _ => ccx.sess().bug(&format!("unsized_info: invalid unsizing {:?} -> {:?}",
 651                                      source,
 652                                      target)),
 653     }
 654 }
 655
 656 /// Coerce `src` to `dst_ty`. `src_ty` must be a thin pointer.
 657 pub fn unsize_thin_ptr<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
 658                                    src: ValueRef,
 659                                    src_ty: Ty<'tcx>,
 660                                    dst_ty: Ty<'tcx>)
 661                                    -> (ValueRef, ValueRef) {
 662     debug!("unsize_thin_ptr: {:?} => {:?}", src_ty, dst_ty);
 663     match (&src_ty.sty, &dst_ty.sty) {
 664         (&ty::TyBox(a), &ty::TyBox(b)) |
 665         (&ty::TyRef(_, ty::TypeAndMut { ty: a, .. }),
 666          &ty::TyRef(_, ty::TypeAndMut { ty: b, .. })) |
 667         (&ty::TyRef(_, ty::TypeAndMut { ty: a, .. }),
 668          &ty::TyRawPtr(ty::TypeAndMut { ty: b, .. })) |
 669         (&ty::TyRawPtr(ty::TypeAndMut { ty: a, .. }),
 670          &ty::TyRawPtr(ty::TypeAndMut { ty: b, .. })) => {
 671             assert!(common::type_is_sized(bcx.tcx(), a));
 672             let ptr_ty = type_of::in_memory_type_of(bcx.ccx(), b).ptr_to();
 673             (PointerCast(bcx, src, ptr_ty),
 674              unsized_info(bcx.ccx(), a, b, None, bcx.fcx.param_substs))
 675         }
 676         _ => bcx.sess().bug("unsize_thin_ptr: called on bad types"),
 677     }
 678 }
 679
 680 /// Coerce `src`, which is a reference to a value of type `src_ty`,
 681 /// to a value of type `dst_ty` and store the result in `dst`
 682 pub fn coerce_unsized_into<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
 683                                        src: ValueRef,
 684                                        src_ty: Ty<'tcx>,
 685                                        dst: ValueRef,
 686                                        dst_ty: Ty<'tcx>) {
 687     match (&src_ty.sty, &dst_ty.sty) {
 688         (&ty::TyBox(..), &ty::TyBox(..)) |
 689         (&ty::TyRef(..), &ty::TyRef(..)) |
 690         (&ty::TyRef(..), &ty::TyRawPtr(..)) |
 691         (&ty::TyRawPtr(..), &ty::TyRawPtr(..)) => {
 692             let (base, info) = if common::type_is_fat_ptr(bcx.tcx(), src_ty) {
 693                 // fat-ptr to fat-ptr unsize preserves the vtable
 694                 load_fat_ptr(bcx, src, src_ty)
 695             } else {
 696                 let base = load_ty(bcx, src, src_ty);
 697                 unsize_thin_ptr(bcx, base, src_ty, dst_ty)
 698             };
 699             store_fat_ptr(bcx, base, info, dst, dst_ty);
 700         }
 701
 702         // This can be extended to enums and tuples in the future.
 703         // (&ty::TyEnum(def_id_a, _), &ty::TyEnum(def_id_b, _)) |
 704         (&ty::TyStruct(def_a, _), &ty::TyStruct(def_b, _)) => {
 705             assert_eq!(def_a, def_b);
 706
 707             let src_repr = adt::represent_type(bcx.ccx(), src_ty);
 708             let src_fields = match &*src_repr {
 709                 &adt::Repr::Univariant(ref s, _) => &s.fields,
 710                 _ => bcx.sess().bug("struct has non-univariant repr"),
 711             };
 712             let dst_repr = adt::represent_type(bcx.ccx(), dst_ty);
 713             let dst_fields = match &*dst_repr {
 714                 &adt::Repr::Univariant(ref s, _) => &s.fields,
 715                 _ => bcx.sess().bug("struct has non-univariant repr"),
 716             };
 717
 718             let src = adt::MaybeSizedValue::sized(src);
 719             let dst = adt::MaybeSizedValue::sized(dst);
 720
 721             let iter = src_fields.iter().zip(dst_fields).enumerate();
 722             for (i, (src_fty, dst_fty)) in iter {
 723                 if type_is_zero_size(bcx.ccx(), dst_fty) {
 724                     continue;
 725                 }
 726
 727                 let src_f = adt::trans_field_ptr(bcx, &src_repr, src, Disr(0), i);
 728                 let dst_f = adt::trans_field_ptr(bcx, &dst_repr, dst, Disr(0), i);
 729                 if src_fty == dst_fty {
 730                     memcpy_ty(bcx, dst_f, src_f, src_fty);
 731                 } else {
 732                     coerce_unsized_into(bcx, src_f, src_fty, dst_f, dst_fty);
 733                 }
 734             }
 735         }
 736         _ => bcx.sess().bug(&format!("coerce_unsized_into: invalid coercion {:?} -> {:?}",
 737                                      src_ty,
 738                                      dst_ty)),
 739     }
 740 }
 741
 742 pub fn custom_coerce_unsize_info<'ccx, 'tcx>(ccx: &CrateContext<'ccx, 'tcx>,
 743                                              source_ty: Ty<'tcx>,
 744                                              target_ty: Ty<'tcx>)
 745                                              -> CustomCoerceUnsized {
 746     let trait_substs = Substs::erased(subst::VecPerParamSpace::new(vec![target_ty],
 747                                                                    vec![source_ty],
 748                                                                    Vec::new()));
 749     let trait_ref = ty::Binder(ty::TraitRef {
 750         def_id: ccx.tcx().lang_items.coerce_unsized_trait().unwrap(),
 751         substs: ccx.tcx().mk_substs(trait_substs)
 752     });
 753
 754     match fulfill_obligation(ccx, DUMMY_SP, trait_ref) {
 755         traits::VtableImpl(traits::VtableImplData { impl_def_id, .. }) => {
 756             ccx.tcx().custom_coerce_unsized_kind(impl_def_id)
 757         }
 758         vtable => {
 759             ccx.sess().bug(&format!("invalid CoerceUnsized vtable: {:?}",
 760                                     vtable));
 761         }
 762     }
 763 }
 764
 765 pub fn cast_shift_expr_rhs(cx: Block, op: hir::BinOp_, lhs: ValueRef, rhs: ValueRef) -> ValueRef {
 766     cast_shift_rhs(op, lhs, rhs, |a, b| Trunc(cx, a, b), |a, b| ZExt(cx, a, b))
 767 }
 768
 769 pub fn cast_shift_const_rhs(op: hir::BinOp_, lhs: ValueRef, rhs: ValueRef) -> ValueRef {
 770     cast_shift_rhs(op,
 771                    lhs,
 772                    rhs,
 773                    |a, b| unsafe { llvm::LLVMConstTrunc(a, b.to_ref()) },
 774                    |a, b| unsafe { llvm::LLVMConstZExt(a, b.to_ref()) })
 775 }
 776
 777 fn cast_shift_rhs<F, G>(op: hir::BinOp_,
 778                         lhs: ValueRef,
 779                         rhs: ValueRef,
 780                         trunc: F,
 781                         zext: G)
 782                         -> ValueRef
 783     where F: FnOnce(ValueRef, Type) -> ValueRef,
 784           G: FnOnce(ValueRef, Type) -> ValueRef
 785 {
 786     // Shifts may have any size int on the rhs
 787     if rustc_front::util::is_shift_binop(op) {
 788         let mut rhs_llty = val_ty(rhs);
 789         let mut lhs_llty = val_ty(lhs);
 790         if rhs_llty.kind() == Vector {
 791             rhs_llty = rhs_llty.element_type()
 792         }
 793         if lhs_llty.kind() == Vector {
 794             lhs_llty = lhs_llty.element_type()
 795         }
 796         let rhs_sz = rhs_llty.int_width();
 797         let lhs_sz = lhs_llty.int_width();
 798         if lhs_sz < rhs_sz {
 799             trunc(rhs, lhs_llty)
 800         } else if lhs_sz > rhs_sz {
 801             // FIXME (#1877: If shifting by negative
 802             // values becomes not undefined then this is wrong.
 803             zext(rhs, lhs_llty)
 804         } else {
 805             rhs
 806         }
 807     } else {
 808         rhs
 809     }
 810 }
 811
 812 pub fn llty_and_min_for_signed_ty<'blk, 'tcx>(cx: Block<'blk, 'tcx>,
 813                                               val_t: Ty<'tcx>)
 814                                               -> (Type, u64) {
 815     match val_t.sty {
 816         ty::TyInt(t) => {
 817             let llty = Type::int_from_ty(cx.ccx(), t);
 818             let min = match t {
 819                 ast::IntTy::Is if llty == Type::i32(cx.ccx()) => i32::MIN as u64,
 820                 ast::IntTy::Is => i64::MIN as u64,
 821                 ast::IntTy::I8 => i8::MIN as u64,
 822                 ast::IntTy::I16 => i16::MIN as u64,
 823                 ast::IntTy::I32 => i32::MIN as u64,
 824                 ast::IntTy::I64 => i64::MIN as u64,
 825             };
 826             (llty, min)
 827         }
 828         _ => unreachable!(),
 829     }
 830 }
 831
 832 pub fn fail_if_zero_or_overflows<'blk, 'tcx>(cx: Block<'blk, 'tcx>,
 833                                              call_info: NodeIdAndSpan,
 834                                              divrem: hir::BinOp,
 835                                              lhs: ValueRef,
 836                                              rhs: ValueRef,
 837                                              rhs_t: Ty<'tcx>)
 838                                              -> Block<'blk, 'tcx> {
 839     let (zero_text, overflow_text) = if divrem.node == hir::BiDiv {
 840         ("attempted to divide by zero",
 841          "attempted to divide with overflow")
 842     } else {
 843         ("attempted remainder with a divisor of zero",
 844          "attempted remainder with overflow")
 845     };
 846     let debug_loc = call_info.debug_loc();
 847
 848     let (is_zero, is_signed) = match rhs_t.sty {
 849         ty::TyInt(t) => {
 850             let zero = C_integral(Type::int_from_ty(cx.ccx(), t), 0, false);
 851             (ICmp(cx, llvm::IntEQ, rhs, zero, debug_loc), true)
 852         }
 853         ty::TyUint(t) => {
 854             let zero = C_integral(Type::uint_from_ty(cx.ccx(), t), 0, false);
 855             (ICmp(cx, llvm::IntEQ, rhs, zero, debug_loc), false)
 856         }
 857         ty::TyStruct(def, _) if def.is_simd() => {
 858             let mut res = C_bool(cx.ccx(), false);
 859             for i in 0..rhs_t.simd_size(cx.tcx()) {
 860                 res = Or(cx,
 861                          res,
 862                          IsNull(cx, ExtractElement(cx, rhs, C_int(cx.ccx(), i as i64))),
 863                          debug_loc);
 864             }
 865             (res, false)
 866         }
 867         _ => {
 868             cx.sess().bug(&format!("fail-if-zero on unexpected type: {}", rhs_t));
 869         }
 870     };
 871     let bcx = with_cond(cx, is_zero, |bcx| {
 872         controlflow::trans_fail(bcx, call_info, InternedString::new(zero_text))
 873     });
 874
 875     // To quote LLVM's documentation for the sdiv instruction:
 876     //
 877     //      Division by zero leads to undefined behavior. Overflow also leads
 878     //      to undefined behavior; this is a rare case, but can occur, for
 879     //      example, by doing a 32-bit division of -2147483648 by -1.
 880     //
 881     // In order to avoid undefined behavior, we perform runtime checks for
 882     // signed division/remainder which would trigger overflow. For unsigned
 883     // integers, no action beyond checking for zero need be taken.
 884     if is_signed {
 885         let (llty, min) = llty_and_min_for_signed_ty(cx, rhs_t);
 886         let minus_one = ICmp(bcx,
 887                              llvm::IntEQ,
 888                              rhs,
 889                              C_integral(llty, !0, false),
 890                              debug_loc);
 891         with_cond(bcx, minus_one, |bcx| {
 892             let is_min = ICmp(bcx,
 893                               llvm::IntEQ,
 894                               lhs,
 895                               C_integral(llty, min, true),
 896                               debug_loc);
 897             with_cond(bcx, is_min, |bcx| {
 898                 controlflow::trans_fail(bcx, call_info, InternedString::new(overflow_text))
 899             })
 900         })
 901     } else {
 902         bcx
 903     }
 904 }
 905
 906 pub fn trans_external_path<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
 907                                      did: DefId,
 908                                      t: Ty<'tcx>)
 909                                      -> ValueRef {
 910     let name = ccx.sess().cstore.item_symbol(did);
 911     match t.sty {
 912         ty::TyBareFn(_, ref fn_ty) => {
 913             match ccx.sess().target.target.adjust_abi(fn_ty.abi) {
 914                 Abi::Rust | Abi::RustCall => {
 915                     get_extern_rust_fn(ccx, t, &name[..], did)
 916                 }
 917                 Abi::RustIntrinsic | Abi::PlatformIntrinsic => {
 918                     ccx.sess().bug("unexpected intrinsic in trans_external_path")
 919                 }
 920                 _ => {
 921                     let attrs = ccx.sess().cstore.item_attrs(did);
 922                     foreign::register_foreign_item_fn(ccx, fn_ty.abi, t, &name, &attrs)
 923                 }
 924             }
 925         }
 926         _ => {
 927             get_extern_const(ccx, did, t)
 928         }
 929     }
 930 }
 931
 932 pub fn invoke<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
 933                           llfn: ValueRef,
 934                           llargs: &[ValueRef],
 935                           fn_ty: Ty<'tcx>,
 936                           debug_loc: DebugLoc)
 937                           -> (ValueRef, Block<'blk, 'tcx>) {
 938     let _icx = push_ctxt("invoke_");
 939     if bcx.unreachable.get() {
 940         return (C_null(Type::i8(bcx.ccx())), bcx);
 941     }
 942
 943     let attributes = attributes::from_fn_type(bcx.ccx(), fn_ty);
 944
 945     match bcx.opt_node_id {
 946         None => {
 947             debug!("invoke at ???");
 948         }
 949         Some(id) => {
 950             debug!("invoke at {}", bcx.tcx().map.node_to_string(id));
 951         }
 952     }
 953
 954     if need_invoke(bcx) {
 955         debug!("invoking {} at {:?}", bcx.val_to_string(llfn), bcx.llbb);
 956         for &llarg in llargs {
 957             debug!("arg: {}", bcx.val_to_string(llarg));
 958         }
 959         let normal_bcx = bcx.fcx.new_temp_block("normal-return");
 960         let landing_pad = bcx.fcx.get_landing_pad();
 961
 962         let llresult = Invoke(bcx,
 963                               llfn,
 964                               &llargs[..],
 965                               normal_bcx.llbb,
 966                               landing_pad,
 967                               Some(attributes),
 968                               debug_loc);
 969         return (llresult, normal_bcx);
 970     } else {
 971         debug!("calling {} at {:?}", bcx.val_to_string(llfn), bcx.llbb);
 972         for &llarg in llargs {
 973             debug!("arg: {}", bcx.val_to_string(llarg));
 974         }
 975
 976         let llresult = Call(bcx, llfn, &llargs[..], Some(attributes), debug_loc);
 977         return (llresult, bcx);
 978     }
 979 }
 980
 981 /// Returns whether this session's target will use SEH-based unwinding.
 982 ///
 983 /// This is only true for MSVC targets, and even then the 64-bit MSVC target
 984 /// currently uses SEH-ish unwinding with DWARF info tables to the side (same as
 985 /// 64-bit MinGW) instead of "full SEH".
 986 pub fn wants_msvc_seh(sess: &Session) -> bool {
 987     sess.target.target.options.is_like_msvc
 988 }
 989
 990 pub fn avoid_invoke(bcx: Block) -> bool {
 991     bcx.sess().no_landing_pads() || bcx.lpad().is_some()
 992 }
 993
 994 pub fn need_invoke(bcx: Block) -> bool {
 995     if avoid_invoke(bcx) {
 996         false
 997     } else {
 998         bcx.fcx.needs_invoke()
 999     }
1000 }
1001
1002 pub fn load_if_immediate<'blk, 'tcx>(cx: Block<'blk, 'tcx>, v: ValueRef, t: Ty<'tcx>) -> ValueRef {
1003     let _icx = push_ctxt("load_if_immediate");
1004     if type_is_immediate(cx.ccx(), t) {
1005         return load_ty(cx, v, t);
1006     }
1007     return v;
1008 }
1009
1010 /// Helper for loading values from memory. Does the necessary conversion if the in-memory type
1011 /// differs from the type used for SSA values. Also handles various special cases where the type
1012 /// gives us better information about what we are loading.
1013 pub fn load_ty<'blk, 'tcx>(cx: Block<'blk, 'tcx>, ptr: ValueRef, t: Ty<'tcx>) -> ValueRef {
1014     if cx.unreachable.get() || type_is_zero_size(cx.ccx(), t) {
1015         return C_undef(type_of::type_of(cx.ccx(), t));
1016     }
1017
1018     let ptr = to_arg_ty_ptr(cx, ptr, t);
1019     let align = type_of::align_of(cx.ccx(), t);
1020
1021     if type_is_immediate(cx.ccx(), t) && type_of::type_of(cx.ccx(), t).is_aggregate() {
1022         let load = Load(cx, ptr);
1023         unsafe {
1024             llvm::LLVMSetAlignment(load, align);
1025         }
1026         return load;
1027     }
1028
1029     unsafe {
1030         let global = llvm::LLVMIsAGlobalVariable(ptr);
1031         if !global.is_null() && llvm::LLVMIsGlobalConstant(global) == llvm::True {
1032             let val = llvm::LLVMGetInitializer(global);
1033             if !val.is_null() {
1034                 return to_arg_ty(cx, val, t);
1035             }
1036         }
1037     }
1038
1039     let val = if t.is_bool() {
1040         LoadRangeAssert(cx, ptr, 0, 2, llvm::False)
1041     } else if t.is_char() {
1042         // a char is a Unicode codepoint, and so takes values from 0
1043         // to 0x10FFFF inclusive only.
1044         LoadRangeAssert(cx, ptr, 0, 0x10FFFF + 1, llvm::False)
1045     } else if (t.is_region_ptr() || t.is_unique()) && !common::type_is_fat_ptr(cx.tcx(), t) {
1046         LoadNonNull(cx, ptr)
1047     } else {
1048         Load(cx, ptr)
1049     };
1050
1051     unsafe {
1052         llvm::LLVMSetAlignment(val, align);
1053     }
1054
1055     to_arg_ty(cx, val, t)
1056 }
1057
1058 /// Helper for storing values in memory. Does the necessary conversion if the in-memory type
1059 /// differs from the type used for SSA values.
1060 pub fn store_ty<'blk, 'tcx>(cx: Block<'blk, 'tcx>, v: ValueRef, dst: ValueRef, t: Ty<'tcx>) {
1061     if cx.unreachable.get() {
1062         return;
1063     }
1064
1065     debug!("store_ty: {} : {:?} <- {}",
1066            cx.val_to_string(dst),
1067            t,
1068            cx.val_to_string(v));
1069
1070     if common::type_is_fat_ptr(cx.tcx(), t) {
1071         Store(cx,
1072               ExtractValue(cx, v, abi::FAT_PTR_ADDR),
1073               expr::get_dataptr(cx, dst));
1074         Store(cx,
1075               ExtractValue(cx, v, abi::FAT_PTR_EXTRA),
1076               expr::get_meta(cx, dst));
1077     } else {
1078         let store = Store(cx, from_arg_ty(cx, v, t), to_arg_ty_ptr(cx, dst, t));
1079         unsafe {
1080             llvm::LLVMSetAlignment(store, type_of::align_of(cx.ccx(), t));
1081         }
1082     }
1083 }
1084
1085 pub fn store_fat_ptr<'blk, 'tcx>(cx: Block<'blk, 'tcx>,
1086                                  data: ValueRef,
1087                                  extra: ValueRef,
1088                                  dst: ValueRef,
1089                                  _ty: Ty<'tcx>) {
1090     // FIXME: emit metadata
1091     Store(cx, data, expr::get_dataptr(cx, dst));
1092     Store(cx, extra, expr::get_meta(cx, dst));
1093 }
1094
1095 pub fn load_fat_ptr<'blk, 'tcx>(cx: Block<'blk, 'tcx>,
1096                                 src: ValueRef,
1097                                 _ty: Ty<'tcx>)
1098                                 -> (ValueRef, ValueRef) {
1099     // FIXME: emit metadata
1100     (Load(cx, expr::get_dataptr(cx, src)),
1101      Load(cx, expr::get_meta(cx, src)))
1102 }
1103
1104 pub fn from_arg_ty(bcx: Block, val: ValueRef, ty: Ty) -> ValueRef {
1105     if ty.is_bool() {
1106         ZExt(bcx, val, Type::i8(bcx.ccx()))
1107     } else {
1108         val
1109     }
1110 }
1111
1112 pub fn to_arg_ty(bcx: Block, val: ValueRef, ty: Ty) -> ValueRef {
1113     if ty.is_bool() {
1114         Trunc(bcx, val, Type::i1(bcx.ccx()))
1115     } else {
1116         val
1117     }
1118 }
1119
1120 pub fn to_arg_ty_ptr<'blk, 'tcx>(bcx: Block<'blk, 'tcx>, ptr: ValueRef, ty: Ty<'tcx>) -> ValueRef {
1121     if type_is_immediate(bcx.ccx(), ty) && type_of::type_of(bcx.ccx(), ty).is_aggregate() {
1122         // We want to pass small aggregates as immediate values, but using an aggregate LLVM type
1123         // for this leads to bad optimizations, so its arg type is an appropriately sized integer
1124         // and we have to convert it
1125         BitCast(bcx, ptr, type_of::arg_type_of(bcx.ccx(), ty).ptr_to())
1126     } else {
1127         ptr
1128     }
1129 }
1130
1131 pub fn init_local<'blk, 'tcx>(bcx: Block<'blk, 'tcx>, local: &hir::Local) -> Block<'blk, 'tcx> {
1132     debug!("init_local(bcx={}, local.id={})", bcx.to_str(), local.id);
1133     let _indenter = indenter();
1134     let _icx = push_ctxt("init_local");
1135     _match::store_local(bcx, local)
1136 }
1137
1138 pub fn raw_block<'blk, 'tcx>(fcx: &'blk FunctionContext<'blk, 'tcx>,
1139                              llbb: BasicBlockRef)
1140                              -> Block<'blk, 'tcx> {
1141     common::BlockS::new(llbb, None, fcx)
1142 }
1143
1144 pub fn with_cond<'blk, 'tcx, F>(bcx: Block<'blk, 'tcx>, val: ValueRef, f: F) -> Block<'blk, 'tcx>
1145     where F: FnOnce(Block<'blk, 'tcx>) -> Block<'blk, 'tcx>
1146 {
1147     let _icx = push_ctxt("with_cond");
1148
1149     if bcx.unreachable.get() || common::const_to_opt_uint(val) == Some(0) {
1150         return bcx;
1151     }
1152
1153     let fcx = bcx.fcx;
1154     let next_cx = fcx.new_temp_block("next");
1155     let cond_cx = fcx.new_temp_block("cond");
1156     CondBr(bcx, val, cond_cx.llbb, next_cx.llbb, DebugLoc::None);
1157     let after_cx = f(cond_cx);
1158     if !after_cx.terminated.get() {
1159         Br(after_cx, next_cx.llbb, DebugLoc::None);
1160     }
1161     next_cx
1162 }
1163
1164 enum Lifetime { Start, End }
1165
1166 // If LLVM lifetime intrinsic support is enabled (i.e. optimizations
1167 // on), and `ptr` is nonzero-sized, then extracts the size of `ptr`
1168 // and the intrinsic for `lt` and passes them to `emit`, which is in
1169 // charge of generating code to call the passed intrinsic on whatever
1170 // block of generated code is targetted for the intrinsic.
1171 //
1172 // If LLVM lifetime intrinsic support is disabled (i.e.  optimizations
1173 // off) or `ptr` is zero-sized, then no-op (does not call `emit`).
1174 fn core_lifetime_emit<'blk, 'tcx, F>(ccx: &'blk CrateContext<'blk, 'tcx>,
1175                                      ptr: ValueRef,
1176                                      lt: Lifetime,
1177                                      emit: F)
1178     where F: FnOnce(&'blk CrateContext<'blk, 'tcx>, machine::llsize, ValueRef)
1179 {
1180     if ccx.sess().opts.optimize == config::OptLevel::No {
1181         return;
1182     }
1183
1184     let _icx = push_ctxt(match lt {
1185         Lifetime::Start => "lifetime_start",
1186         Lifetime::End => "lifetime_end"
1187     });
1188
1189     let size = machine::llsize_of_alloc(ccx, val_ty(ptr).element_type());
1190     if size == 0 {
1191         return;
1192     }
1193
1194     let lifetime_intrinsic = ccx.get_intrinsic(match lt {
1195         Lifetime::Start => "llvm.lifetime.start",
1196         Lifetime::End => "llvm.lifetime.end"
1197     });
1198     emit(ccx, size, lifetime_intrinsic)
1199 }
1200
1201 pub fn call_lifetime_start(cx: Block, ptr: ValueRef) {
1202     core_lifetime_emit(cx.ccx(), ptr, Lifetime::Start, |ccx, size, lifetime_start| {
1203         let ptr = PointerCast(cx, ptr, Type::i8p(ccx));
1204         Call(cx,
1205              lifetime_start,
1206              &[C_u64(ccx, size), ptr],
1207              None,
1208              DebugLoc::None);
1209     })
1210 }
1211
1212 pub fn call_lifetime_end(cx: Block, ptr: ValueRef) {
1213     core_lifetime_emit(cx.ccx(), ptr, Lifetime::End, |ccx, size, lifetime_end| {
1214         let ptr = PointerCast(cx, ptr, Type::i8p(ccx));
1215         Call(cx,
1216              lifetime_end,
1217              &[C_u64(ccx, size), ptr],
1218              None,
1219              DebugLoc::None);
1220     })
1221 }
1222
1223 // Generates code for resumption of unwind at the end of a landing pad.
1224 pub fn trans_unwind_resume(bcx: Block, lpval: ValueRef) {
1225     if !bcx.sess().target.target.options.custom_unwind_resume {
1226         Resume(bcx, lpval);
1227     } else {
1228         let exc_ptr = ExtractValue(bcx, lpval, 0);
1229         let llunwresume = bcx.fcx.eh_unwind_resume();
1230         Call(bcx, llunwresume, &[exc_ptr], None, DebugLoc::None);
1231         Unreachable(bcx);
1232     }
1233 }
1234
1235
1236 pub fn call_memcpy(cx: Block, dst: ValueRef, src: ValueRef, n_bytes: ValueRef, align: u32) {
1237     let _icx = push_ctxt("call_memcpy");
1238     let ccx = cx.ccx();
1239     let ptr_width = &ccx.sess().target.target.target_pointer_width[..];
1240     let key = format!("llvm.memcpy.p0i8.p0i8.i{}", ptr_width);
1241     let memcpy = ccx.get_intrinsic(&key);
1242     let src_ptr = PointerCast(cx, src, Type::i8p(ccx));
1243     let dst_ptr = PointerCast(cx, dst, Type::i8p(ccx));
1244     let size = IntCast(cx, n_bytes, ccx.int_type());
1245     let align = C_i32(ccx, align as i32);
1246     let volatile = C_bool(ccx, false);
1247     Call(cx,
1248          memcpy,
1249          &[dst_ptr, src_ptr, size, align, volatile],
1250          None,
1251          DebugLoc::None);
1252 }
1253
1254 pub fn memcpy_ty<'blk, 'tcx>(bcx: Block<'blk, 'tcx>, dst: ValueRef, src: ValueRef, t: Ty<'tcx>) {
1255     let _icx = push_ctxt("memcpy_ty");
1256     let ccx = bcx.ccx();
1257
1258     if type_is_zero_size(ccx, t) {
1259         return;
1260     }
1261
1262     if t.is_structural() {
1263         let llty = type_of::type_of(ccx, t);
1264         let llsz = llsize_of(ccx, llty);
1265         let llalign = type_of::align_of(ccx, t);
1266         call_memcpy(bcx, dst, src, llsz, llalign as u32);
1267     } else if common::type_is_fat_ptr(bcx.tcx(), t) {
1268         let (data, extra) = load_fat_ptr(bcx, src, t);
1269         store_fat_ptr(bcx, data, extra, dst, t);
1270     } else {
1271         store_ty(bcx, load_ty(bcx, src, t), dst, t);
1272     }
1273 }
1274
1275 pub fn drop_done_fill_mem<'blk, 'tcx>(cx: Block<'blk, 'tcx>, llptr: ValueRef, t: Ty<'tcx>) {
1276     if cx.unreachable.get() {
1277         return;
1278     }
1279     let _icx = push_ctxt("drop_done_fill_mem");
1280     let bcx = cx;
1281     memfill(&B(bcx), llptr, t, adt::DTOR_DONE);
1282 }
1283
1284 pub fn init_zero_mem<'blk, 'tcx>(cx: Block<'blk, 'tcx>, llptr: ValueRef, t: Ty<'tcx>) {
1285     if cx.unreachable.get() {
1286         return;
1287     }
1288     let _icx = push_ctxt("init_zero_mem");
1289     let bcx = cx;
1290     memfill(&B(bcx), llptr, t, 0);
1291 }
1292
1293 // Always use this function instead of storing a constant byte to the memory
1294 // in question. e.g. if you store a zero constant, LLVM will drown in vreg
1295 // allocation for large data structures, and the generated code will be
1296 // awful. (A telltale sign of this is large quantities of
1297 // `mov [byte ptr foo],0` in the generated code.)
1298 fn memfill<'a, 'tcx>(b: &Builder<'a, 'tcx>, llptr: ValueRef, ty: Ty<'tcx>, byte: u8) {
1299     let _icx = push_ctxt("memfill");
1300     let ccx = b.ccx;
1301
1302     let llty = type_of::type_of(ccx, ty);
1303     let ptr_width = &ccx.sess().target.target.target_pointer_width[..];
1304     let intrinsic_key = format!("llvm.memset.p0i8.i{}", ptr_width);
1305
1306     let llintrinsicfn = ccx.get_intrinsic(&intrinsic_key);
1307     let llptr = b.pointercast(llptr, Type::i8(ccx).ptr_to());
1308     let llzeroval = C_u8(ccx, byte);
1309     let size = machine::llsize_of(ccx, llty);
1310     let align = C_i32(ccx, type_of::align_of(ccx, ty) as i32);
1311     let volatile = C_bool(ccx, false);
1312     b.call(llintrinsicfn,
1313            &[llptr, llzeroval, size, align, volatile],
1314            None, None);
1315 }
1316
1317 /// In general, when we create an scratch value in an alloca, the
1318 /// creator may not know if the block (that initializes the scratch
1319 /// with the desired value) actually dominates the cleanup associated
1320 /// with the scratch value.
1321 ///
1322 /// To deal with this, when we do an alloca (at the *start* of whole
1323 /// function body), we optionally can also set the associated
1324 /// dropped-flag state of the alloca to "dropped."
1325 #[derive(Copy, Clone, Debug)]
1326 pub enum InitAlloca {
1327     /// Indicates that the state should have its associated drop flag
1328     /// set to "dropped" at the point of allocation.
1329     Dropped,
1330     /// Indicates the value of the associated drop flag is irrelevant.
1331     /// The embedded string literal is a programmer provided argument
1332     /// for why. This is a safeguard forcing compiler devs to
1333     /// document; it might be a good idea to also emit this as a
1334     /// comment with the alloca itself when emitting LLVM output.ll.
1335     Uninit(&'static str),
1336 }
1337
1338
1339 pub fn alloc_ty<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
1340                             t: Ty<'tcx>,
1341                             name: &str) -> ValueRef {
1342     // pnkfelix: I do not know why alloc_ty meets the assumptions for
1343     // passing Uninit, but it was never needed (even back when we had
1344     // the original boolean `zero` flag on `lvalue_scratch_datum`).
1345     alloc_ty_init(bcx, t, InitAlloca::Uninit("all alloc_ty are uninit"), name)
1346 }
1347
1348 /// This variant of `fn alloc_ty` does not necessarily assume that the
1349 /// alloca should be created with no initial value. Instead the caller
1350 /// controls that assumption via the `init` flag.
1351 ///
1352 /// Note that if the alloca *is* initialized via `init`, then we will
1353 /// also inject an `llvm.lifetime.start` before that initialization
1354 /// occurs, and thus callers should not call_lifetime_start
1355 /// themselves.  But if `init` says "uninitialized", then callers are
1356 /// in charge of choosing where to call_lifetime_start and
1357 /// subsequently populate the alloca.
1358 ///
1359 /// (See related discussion on PR #30823.)
1360 pub fn alloc_ty_init<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
1361                              t: Ty<'tcx>,
1362                              init: InitAlloca,
1363                              name: &str) -> ValueRef {
1364     let _icx = push_ctxt("alloc_ty");
1365     let ccx = bcx.ccx();
1366     let ty = type_of::type_of(ccx, t);
1367     assert!(!t.has_param_types());
1368     match init {
1369         InitAlloca::Dropped => alloca_dropped(bcx, t, name),
1370         InitAlloca::Uninit(_) => alloca(bcx, ty, name),
1371     }
1372 }
1373
1374 pub fn alloca_dropped<'blk, 'tcx>(cx: Block<'blk, 'tcx>, ty: Ty<'tcx>, name: &str) -> ValueRef {
1375     let _icx = push_ctxt("alloca_dropped");
1376     let llty = type_of::type_of(cx.ccx(), ty);
1377     if cx.unreachable.get() {
1378         unsafe { return llvm::LLVMGetUndef(llty.ptr_to().to_ref()); }
1379     }
1380     let p = alloca(cx, llty, name);
1381     let b = cx.fcx.ccx.builder();
1382     b.position_before(cx.fcx.alloca_insert_pt.get().unwrap());
1383
1384     // This is just like `call_lifetime_start` (but latter expects a
1385     // Block, which we do not have for `alloca_insert_pt`).
1386     core_lifetime_emit(cx.ccx(), p, Lifetime::Start, |ccx, size, lifetime_start| {
1387         let ptr = b.pointercast(p, Type::i8p(ccx));
1388         b.call(lifetime_start, &[C_u64(ccx, size), ptr], None, None);
1389     });
1390     memfill(&b, p, ty, adt::DTOR_DONE);
1391     p
1392 }
1393
1394 pub fn alloca(cx: Block, ty: Type, name: &str) -> ValueRef {
1395     let _icx = push_ctxt("alloca");
1396     if cx.unreachable.get() {
1397         unsafe {
1398             return llvm::LLVMGetUndef(ty.ptr_to().to_ref());
1399         }
1400     }
1401     debuginfo::clear_source_location(cx.fcx);
1402     Alloca(cx, ty, name)
1403 }
1404
1405 pub fn set_value_name(val: ValueRef, name: &str) {
1406     unsafe {
1407         let name = CString::new(name).unwrap();
1408         llvm::LLVMSetValueName(val, name.as_ptr());
1409     }
1410 }
1411
1412 // Creates the alloca slot which holds the pointer to the slot for the final return value
1413 pub fn make_return_slot_pointer<'a, 'tcx>(fcx: &FunctionContext<'a, 'tcx>,
1414                                           output_type: Ty<'tcx>)
1415                                           -> ValueRef {
1416     let lloutputtype = type_of::type_of(fcx.ccx, output_type);
1417
1418     // We create an alloca to hold a pointer of type `output_type`
1419     // which will hold the pointer to the right alloca which has the
1420     // final ret value
1421     if fcx.needs_ret_allocas {
1422         // Let's create the stack slot
1423         let slot = AllocaFcx(fcx, lloutputtype.ptr_to(), "llretslotptr");
1424
1425         // and if we're using an out pointer, then store that in our newly made slot
1426         if type_of::return_uses_outptr(fcx.ccx, output_type) {
1427             let outptr = get_param(fcx.llfn, 0);
1428
1429             let b = fcx.ccx.builder();
1430             b.position_before(fcx.alloca_insert_pt.get().unwrap());
1431             b.store(outptr, slot);
1432         }
1433
1434         slot
1435
1436     // But if there are no nested returns, we skip the indirection and have a single
1437     // retslot
1438     } else {
1439         if type_of::return_uses_outptr(fcx.ccx, output_type) {
1440             get_param(fcx.llfn, 0)
1441         } else {
1442             AllocaFcx(fcx, lloutputtype, "sret_slot")
1443         }
1444     }
1445 }
1446
1447 struct FindNestedReturn {
1448     found: bool,
1449 }
1450
1451 impl FindNestedReturn {
1452     fn new() -> FindNestedReturn {
1453         FindNestedReturn {
1454             found: false,
1455         }
1456     }
1457 }
1458
1459 impl<'v> Visitor<'v> for FindNestedReturn {
1460     fn visit_expr(&mut self, e: &hir::Expr) {
1461         match e.node {
1462             hir::ExprRet(..) => {
1463                 self.found = true;
1464             }
1465             _ => intravisit::walk_expr(self, e),
1466         }
1467     }
1468 }
1469
1470 fn build_cfg(tcx: &ty::ctxt, id: ast::NodeId) -> (ast::NodeId, Option<cfg::CFG>) {
1471     let blk = match tcx.map.find(id) {
1472         Some(hir_map::NodeItem(i)) => {
1473             match i.node {
1474                 hir::ItemFn(_, _, _, _, _, ref blk) => {
1475                     blk
1476                 }
1477                 _ => tcx.sess.bug("unexpected item variant in has_nested_returns"),
1478             }
1479         }
1480         Some(hir_map::NodeTraitItem(trait_item)) => {
1481             match trait_item.node {
1482                 hir::MethodTraitItem(_, Some(ref body)) => body,
1483                 _ => {
1484                     tcx.sess.bug("unexpected variant: trait item other than a provided method in \
1485                                   has_nested_returns")
1486                 }
1487             }
1488         }
1489         Some(hir_map::NodeImplItem(impl_item)) => {
1490             match impl_item.node {
1491                 hir::ImplItemKind::Method(_, ref body) => body,
1492                 _ => {
1493                     tcx.sess.bug("unexpected variant: non-method impl item in has_nested_returns")
1494                 }
1495             }
1496         }
1497         Some(hir_map::NodeExpr(e)) => {
1498             match e.node {
1499                 hir::ExprClosure(_, _, ref blk) => blk,
1500                 _ => tcx.sess.bug("unexpected expr variant in has_nested_returns"),
1501             }
1502         }
1503         Some(hir_map::NodeVariant(..)) |
1504         Some(hir_map::NodeStructCtor(..)) => return (ast::DUMMY_NODE_ID, None),
1505
1506         // glue, shims, etc
1507         None if id == ast::DUMMY_NODE_ID => return (ast::DUMMY_NODE_ID, None),
1508
1509         _ => tcx.sess.bug(&format!("unexpected variant in has_nested_returns: {}",
1510                                    tcx.map.path_to_string(id))),
1511     };
1512
1513     (blk.id, Some(cfg::CFG::new(tcx, blk)))
1514 }
1515
1516 // Checks for the presence of "nested returns" in a function.
1517 // Nested returns are when the inner expression of a return expression
1518 // (the 'expr' in 'return expr') contains a return expression. Only cases
1519 // where the outer return is actually reachable are considered. Implicit
1520 // returns from the end of blocks are considered as well.
1521 //
1522 // This check is needed to handle the case where the inner expression is
1523 // part of a larger expression that may have already partially-filled the
1524 // return slot alloca. This can cause errors related to clean-up due to
1525 // the clobbering of the existing value in the return slot.
1526 fn has_nested_returns(tcx: &ty::ctxt, cfg: &cfg::CFG, blk_id: ast::NodeId) -> bool {
1527     for index in cfg.graph.depth_traverse(cfg.entry) {
1528         let n = cfg.graph.node_data(index);
1529         match tcx.map.find(n.id()) {
1530             Some(hir_map::NodeExpr(ex)) => {
1531                 if let hir::ExprRet(Some(ref ret_expr)) = ex.node {
1532                     let mut visitor = FindNestedReturn::new();
1533                     intravisit::walk_expr(&mut visitor, &**ret_expr);
1534                     if visitor.found {
1535                         return true;
1536                     }
1537                 }
1538             }
1539             Some(hir_map::NodeBlock(blk)) if blk.id == blk_id => {
1540                 let mut visitor = FindNestedReturn::new();
1541                 walk_list!(&mut visitor, visit_expr, &blk.expr);
1542                 if visitor.found {
1543                     return true;
1544                 }
1545             }
1546             _ => {}
1547         }
1548     }
1549
1550     return false;
1551 }
1552
1553 // NB: must keep 4 fns in sync:
1554 //
1555 //  - type_of_fn
1556 //  - create_datums_for_fn_args.
1557 //  - new_fn_ctxt
1558 //  - trans_args
1559 //
1560 // Be warned! You must call `init_function` before doing anything with the
1561 // returned function context.
1562 pub fn new_fn_ctxt<'a, 'tcx>(ccx: &'a CrateContext<'a, 'tcx>,
1563                              llfndecl: ValueRef,
1564                              id: ast::NodeId,
1565                              has_env: bool,
1566                              output_type: ty::FnOutput<'tcx>,
1567                              param_substs: &'tcx Substs<'tcx>,
1568                              sp: Option<Span>,
1569                              block_arena: &'a TypedArena<common::BlockS<'a, 'tcx>>)
1570                              -> FunctionContext<'a, 'tcx> {
1571     common::validate_substs(param_substs);
1572
1573     debug!("new_fn_ctxt(path={}, id={}, param_substs={:?})",
1574            if id == !0 {
1575                "".to_string()
1576            } else {
1577                ccx.tcx().map.path_to_string(id).to_string()
1578            },
1579            id,
1580            param_substs);
1581
1582     let uses_outptr = match output_type {
1583         ty::FnConverging(output_type) => {
1584             let substd_output_type = monomorphize::apply_param_substs(ccx.tcx(),
1585                                                                       param_substs,
1586                                                                       &output_type);
1587             type_of::return_uses_outptr(ccx, substd_output_type)
1588         }
1589         ty::FnDiverging => false,
1590     };
1591     let debug_context = debuginfo::create_function_debug_context(ccx, id, param_substs, llfndecl);
1592     let (blk_id, cfg) = build_cfg(ccx.tcx(), id);
1593     let nested_returns = if let Some(ref cfg) = cfg {
1594         has_nested_returns(ccx.tcx(), cfg, blk_id)
1595     } else {
1596         false
1597     };
1598
1599     let mir = ccx.mir_map().map.get(&id);
1600
1601     let mut fcx = FunctionContext {
1602         mir: mir,
1603         llfn: llfndecl,
1604         llenv: None,
1605         llretslotptr: Cell::new(None),
1606         param_env: ccx.tcx().empty_parameter_environment(),
1607         alloca_insert_pt: Cell::new(None),
1608         llreturn: Cell::new(None),
1609         needs_ret_allocas: nested_returns,
1610         landingpad_alloca: Cell::new(None),
1611         caller_expects_out_pointer: uses_outptr,
1612         lllocals: RefCell::new(NodeMap()),
1613         llupvars: RefCell::new(NodeMap()),
1614         lldropflag_hints: RefCell::new(DropFlagHintsMap::new()),
1615         id: id,
1616         param_substs: param_substs,
1617         span: sp,
1618         block_arena: block_arena,
1619         lpad_arena: TypedArena::new(),
1620         ccx: ccx,
1621         debug_context: debug_context,
1622         scopes: RefCell::new(Vec::new()),
1623         cfg: cfg,
1624     };
1625
1626     if has_env {
1627         fcx.llenv = Some(get_param(fcx.llfn, fcx.env_arg_pos() as c_uint))
1628     }
1629
1630     fcx
1631 }
1632
1633 /// Performs setup on a newly created function, creating the entry scope block
1634 /// and allocating space for the return pointer.
1635 pub fn init_function<'a, 'tcx>(fcx: &'a FunctionContext<'a, 'tcx>,
1636                                skip_retptr: bool,
1637                                output: ty::FnOutput<'tcx>)
1638                                -> Block<'a, 'tcx> {
1639     let entry_bcx = fcx.new_temp_block("entry-block");
1640
1641     // Use a dummy instruction as the insertion point for all allocas.
1642     // This is later removed in FunctionContext::cleanup.
1643     fcx.alloca_insert_pt.set(Some(unsafe {
1644         Load(entry_bcx, C_null(Type::i8p(fcx.ccx)));
1645         llvm::LLVMGetFirstInstruction(entry_bcx.llbb)
1646     }));
1647
1648     if let ty::FnConverging(output_type) = output {
1649         // This shouldn't need to recompute the return type,
1650         // as new_fn_ctxt did it already.
1651         let substd_output_type = fcx.monomorphize(&output_type);
1652         if !return_type_is_void(fcx.ccx, substd_output_type) {
1653             // If the function returns nil/bot, there is no real return
1654             // value, so do not set `llretslotptr`.
1655             if !skip_retptr || fcx.caller_expects_out_pointer {
1656                 // Otherwise, we normally allocate the llretslotptr, unless we
1657                 // have been instructed to skip it for immediate return
1658                 // values.
1659                 fcx.llretslotptr.set(Some(make_return_slot_pointer(fcx, substd_output_type)));
1660             }
1661         }
1662     }
1663
1664     // Create the drop-flag hints for every unfragmented path in the function.
1665     let tcx = fcx.ccx.tcx();
1666     let fn_did = tcx.map.local_def_id(fcx.id);
1667     let tables = tcx.tables.borrow();
1668     let mut hints = fcx.lldropflag_hints.borrow_mut();
1669     let fragment_infos = tcx.fragment_infos.borrow();
1670
1671     // Intern table for drop-flag hint datums.
1672     let mut seen = HashMap::new();
1673
1674     if let Some(fragment_infos) = fragment_infos.get(&fn_did) {
1675         for &info in fragment_infos {
1676
1677             let make_datum = |id| {
1678                 let init_val = C_u8(fcx.ccx, adt::DTOR_NEEDED_HINT);
1679                 let llname = &format!("dropflag_hint_{}", id);
1680                 debug!("adding hint {}", llname);
1681                 let ty = tcx.types.u8;
1682                 let ptr = alloc_ty(entry_bcx, ty, llname);
1683                 Store(entry_bcx, init_val, ptr);
1684                 let flag = datum::Lvalue::new_dropflag_hint("base::init_function");
1685                 datum::Datum::new(ptr, ty, flag)
1686             };
1687
1688             let (var, datum) = match info {
1689                 ty::FragmentInfo::Moved { var, .. } |
1690                 ty::FragmentInfo::Assigned { var, .. } => {
1691                     let opt_datum = seen.get(&var).cloned().unwrap_or_else(|| {
1692                         let ty = tables.node_types[&var];
1693                         if fcx.type_needs_drop(ty) {
1694                             let datum = make_datum(var);
1695                             seen.insert(var, Some(datum.clone()));
1696                             Some(datum)
1697                         } else {
1698                             // No drop call needed, so we don't need a dropflag hint
1699                             None
1700                         }
1701                     });
1702                     if let Some(datum) = opt_datum {
1703                         (var, datum)
1704                     } else {
1705                         continue
1706                     }
1707                 }
1708             };
1709             match info {
1710                 ty::FragmentInfo::Moved { move_expr: expr_id, .. } => {
1711                     debug!("FragmentInfo::Moved insert drop hint for {}", expr_id);
1712                     hints.insert(expr_id, DropHint::new(var, datum));
1713                 }
1714                 ty::FragmentInfo::Assigned { assignee_id: expr_id, .. } => {
1715                     debug!("FragmentInfo::Assigned insert drop hint for {}", expr_id);
1716                     hints.insert(expr_id, DropHint::new(var, datum));
1717                 }
1718             }
1719         }
1720     }
1721
1722     entry_bcx
1723 }
1724
1725 // NB: must keep 4 fns in sync:
1726 //
1727 //  - type_of_fn
1728 //  - create_datums_for_fn_args.
1729 //  - new_fn_ctxt
1730 //  - trans_args
1731
1732 pub fn arg_kind<'a, 'tcx>(cx: &FunctionContext<'a, 'tcx>, t: Ty<'tcx>) -> datum::Rvalue {
1733     use trans::datum::{ByRef, ByValue};
1734
1735     datum::Rvalue {
1736         mode: if arg_is_indirect(cx.ccx, t) { ByRef } else { ByValue }
1737     }
1738 }
1739
1740 // create_datums_for_fn_args: creates lvalue datums for each of the
1741 // incoming function arguments.
1742 pub fn create_datums_for_fn_args<'a, 'tcx>(mut bcx: Block<'a, 'tcx>,
1743                                            args: &[hir::Arg],
1744                                            arg_tys: &[Ty<'tcx>],
1745                                            has_tupled_arg: bool,
1746                                            arg_scope: cleanup::CustomScopeIndex)
1747                                            -> Block<'a, 'tcx> {
1748     let _icx = push_ctxt("create_datums_for_fn_args");
1749     let fcx = bcx.fcx;
1750     let arg_scope_id = cleanup::CustomScope(arg_scope);
1751
1752     debug!("create_datums_for_fn_args");
1753
1754     // Return an array wrapping the ValueRefs that we get from `get_param` for
1755     // each argument into datums.
1756     //
1757     // For certain mode/type combinations, the raw llarg values are passed
1758     // by value.  However, within the fn body itself, we want to always
1759     // have all locals and arguments be by-ref so that we can cancel the
1760     // cleanup and for better interaction with LLVM's debug info.  So, if
1761     // the argument would be passed by value, we store it into an alloca.
1762     // This alloca should be optimized away by LLVM's mem-to-reg pass in
1763     // the event it's not truly needed.
1764     let mut idx = fcx.arg_offset() as c_uint;
1765     let uninit_reason = InitAlloca::Uninit("fn_arg populate dominates dtor");
1766     for (i, &arg_ty) in arg_tys.iter().enumerate() {
1767         let arg_datum = if !has_tupled_arg || i < arg_tys.len() - 1 {
1768             if type_of::arg_is_indirect(bcx.ccx(), arg_ty) &&
1769                bcx.sess().opts.debuginfo != FullDebugInfo {
1770                 // Don't copy an indirect argument to an alloca, the caller
1771                 // already put it in a temporary alloca and gave it up, unless
1772                 // we emit extra-debug-info, which requires local allocas :(.
1773                 let llarg = get_param(fcx.llfn, idx);
1774                 idx += 1;
1775                 bcx.fcx.schedule_lifetime_end(arg_scope_id, llarg);
1776                 bcx.fcx.schedule_drop_mem(arg_scope_id, llarg, arg_ty, None);
1777
1778                 datum::Datum::new(llarg,
1779                                   arg_ty,
1780                                   datum::Lvalue::new("create_datum_for_fn_args"))
1781             } else if common::type_is_fat_ptr(bcx.tcx(), arg_ty) {
1782                 let data = get_param(fcx.llfn, idx);
1783                 let extra = get_param(fcx.llfn, idx + 1);
1784                 idx += 2;
1785                 unpack_datum!(bcx, datum::lvalue_scratch_datum(bcx, arg_ty, "", uninit_reason,
1786                                                         arg_scope_id, (data, extra),
1787                                                         |(data, extra), bcx, dst| {
1788                     debug!("populate call for create_datum_for_fn_args \
1789                             early fat arg, on arg[{}] ty={:?}", i, arg_ty);
1790
1791                     Store(bcx, data, expr::get_dataptr(bcx, dst));
1792                     Store(bcx, extra, expr::get_meta(bcx, dst));
1793                     bcx
1794                 }))
1795             } else {
1796                 let llarg = get_param(fcx.llfn, idx);
1797                 idx += 1;
1798                 let tmp = datum::Datum::new(llarg, arg_ty, arg_kind(fcx, arg_ty));
1799                 unpack_datum!(bcx,
1800                               datum::lvalue_scratch_datum(bcx,
1801                                                           arg_ty,
1802                                                           "",
1803                                                           uninit_reason,
1804                                                           arg_scope_id,
1805                                                           tmp,
1806                                                           |tmp, bcx, dst| {
1807
1808                         debug!("populate call for create_datum_for_fn_args \
1809                                 early thin arg, on arg[{}] ty={:?}", i, arg_ty);
1810
1811                                                               tmp.store_to(bcx, dst)
1812                                                           }))
1813             }
1814         } else {
1815             // FIXME(pcwalton): Reduce the amount of code bloat this is responsible for.
1816             match arg_ty.sty {
1817                 ty::TyTuple(ref tupled_arg_tys) => {
1818                     unpack_datum!(bcx,
1819                                   datum::lvalue_scratch_datum(bcx,
1820                                                               arg_ty,
1821                                                               "tupled_args",
1822                                                               uninit_reason,
1823                                                               arg_scope_id,
1824                                                               (),
1825                                                               |(),
1826                                                                mut bcx,
1827                                                               llval| {
1828                         debug!("populate call for create_datum_for_fn_args \
1829                                 tupled_args, on arg[{}] ty={:?}", i, arg_ty);
1830                         for (j, &tupled_arg_ty) in
1831                                     tupled_arg_tys.iter().enumerate() {
1832                             let lldest = StructGEP(bcx, llval, j);
1833                             if common::type_is_fat_ptr(bcx.tcx(), tupled_arg_ty) {
1834                                 let data = get_param(bcx.fcx.llfn, idx);
1835                                 let extra = get_param(bcx.fcx.llfn, idx + 1);
1836                                 Store(bcx, data, expr::get_dataptr(bcx, lldest));
1837                                 Store(bcx, extra, expr::get_meta(bcx, lldest));
1838                                 idx += 2;
1839                             } else {
1840                                 let datum = datum::Datum::new(
1841                                     get_param(bcx.fcx.llfn, idx),
1842                                     tupled_arg_ty,
1843                                     arg_kind(bcx.fcx, tupled_arg_ty));
1844                                 idx += 1;
1845                                 bcx = datum.store_to(bcx, lldest);
1846                             };
1847                         }
1848                         bcx
1849                     }))
1850                 }
1851                 _ => {
1852                     bcx.tcx()
1853                        .sess
1854                        .bug("last argument of a function with `rust-call` ABI isn't a tuple?!")
1855                 }
1856             }
1857         };
1858
1859         let pat = &*args[i].pat;
1860         bcx = if let Some(name) = simple_name(pat) {
1861             // Generate nicer LLVM for the common case of fn a pattern
1862             // like `x: T`
1863             set_value_name(arg_datum.val, &bcx.name(name));
1864             bcx.fcx.lllocals.borrow_mut().insert(pat.id, arg_datum);
1865             bcx
1866         } else {
1867             // General path. Copy out the values that are used in the
1868             // pattern.
1869             _match::bind_irrefutable_pat(bcx, pat, arg_datum.match_input(), arg_scope_id)
1870         };
1871         debuginfo::create_argument_metadata(bcx, &args[i]);
1872     }
1873
1874     bcx
1875 }
1876
1877 // Ties up the llstaticallocas -> llloadenv -> lltop edges,
1878 // and builds the return block.
1879 pub fn finish_fn<'blk, 'tcx>(fcx: &'blk FunctionContext<'blk, 'tcx>,
1880                              last_bcx: Block<'blk, 'tcx>,
1881                              retty: ty::FnOutput<'tcx>,
1882                              ret_debug_loc: DebugLoc) {
1883     let _icx = push_ctxt("finish_fn");
1884
1885     let ret_cx = match fcx.llreturn.get() {
1886         Some(llreturn) => {
1887             if !last_bcx.terminated.get() {
1888                 Br(last_bcx, llreturn, DebugLoc::None);
1889             }
1890             raw_block(fcx, llreturn)
1891         }
1892         None => last_bcx,
1893     };
1894
1895     // This shouldn't need to recompute the return type,
1896     // as new_fn_ctxt did it already.
1897     let substd_retty = fcx.monomorphize(&retty);
1898     build_return_block(fcx, ret_cx, substd_retty, ret_debug_loc);
1899
1900     debuginfo::clear_source_location(fcx);
1901     fcx.cleanup();
1902 }
1903
1904 // Builds the return block for a function.
1905 pub fn build_return_block<'blk, 'tcx>(fcx: &FunctionContext<'blk, 'tcx>,
1906                                       ret_cx: Block<'blk, 'tcx>,
1907                                       retty: ty::FnOutput<'tcx>,
1908                                       ret_debug_location: DebugLoc) {
1909     if fcx.llretslotptr.get().is_none() ||
1910        (!fcx.needs_ret_allocas && fcx.caller_expects_out_pointer) {
1911         return RetVoid(ret_cx, ret_debug_location);
1912     }
1913
1914     let retslot = if fcx.needs_ret_allocas {
1915         Load(ret_cx, fcx.llretslotptr.get().unwrap())
1916     } else {
1917         fcx.llretslotptr.get().unwrap()
1918     };
1919     let retptr = Value(retslot);
1920     match retptr.get_dominating_store(ret_cx) {
1921         // If there's only a single store to the ret slot, we can directly return
1922         // the value that was stored and omit the store and the alloca
1923         Some(s) => {
1924             let retval = s.get_operand(0).unwrap().get();
1925             s.erase_from_parent();
1926
1927             if retptr.has_no_uses() {
1928                 retptr.erase_from_parent();
1929             }
1930
1931             let retval = if retty == ty::FnConverging(fcx.ccx.tcx().types.bool) {
1932                 Trunc(ret_cx, retval, Type::i1(fcx.ccx))
1933             } else {
1934                 retval
1935             };
1936
1937             if fcx.caller_expects_out_pointer {
1938                 if let ty::FnConverging(retty) = retty {
1939                     store_ty(ret_cx, retval, get_param(fcx.llfn, 0), retty);
1940                 }
1941                 RetVoid(ret_cx, ret_debug_location)
1942             } else {
1943                 Ret(ret_cx, retval, ret_debug_location)
1944             }
1945         }
1946         // Otherwise, copy the return value to the ret slot
1947         None => match retty {
1948             ty::FnConverging(retty) => {
1949                 if fcx.caller_expects_out_pointer {
1950                     memcpy_ty(ret_cx, get_param(fcx.llfn, 0), retslot, retty);
1951                     RetVoid(ret_cx, ret_debug_location)
1952                 } else {
1953                     Ret(ret_cx, load_ty(ret_cx, retslot, retty), ret_debug_location)
1954                 }
1955             }
1956             ty::FnDiverging => {
1957                 if fcx.caller_expects_out_pointer {
1958                     RetVoid(ret_cx, ret_debug_location)
1959                 } else {
1960                     Ret(ret_cx, C_undef(Type::nil(fcx.ccx)), ret_debug_location)
1961                 }
1962             }
1963         },
1964     }
1965 }
1966
1967 /// Builds an LLVM function out of a source function.
1968 ///
1969 /// If the function closes over its environment a closure will be returned.
1970 pub fn trans_closure<'a, 'b, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
1971                                    decl: &hir::FnDecl,
1972                                    body: &hir::Block,
1973                                    llfndecl: ValueRef,
1974                                    param_substs: &'tcx Substs<'tcx>,
1975                                    fn_ast_id: ast::NodeId,
1976                                    attributes: &[ast::Attribute],
1977                                    output_type: ty::FnOutput<'tcx>,
1978                                    abi: Abi,
1979                                    closure_env: closure::ClosureEnv<'b>) {
1980     ccx.stats().n_closures.set(ccx.stats().n_closures.get() + 1);
1981
1982     record_translation_item_as_generated(ccx, fn_ast_id, param_substs);
1983
1984     let _icx = push_ctxt("trans_closure");
1985     attributes::emit_uwtable(llfndecl, true);
1986
1987     debug!("trans_closure(..., param_substs={:?})", param_substs);
1988
1989     let has_env = match closure_env {
1990         closure::ClosureEnv::Closure(..) => true,
1991         closure::ClosureEnv::NotClosure => false,
1992     };
1993
1994     let (arena, fcx): (TypedArena<_>, FunctionContext);
1995     arena = TypedArena::new();
1996     fcx = new_fn_ctxt(ccx,
1997                       llfndecl,
1998                       fn_ast_id,
1999                       has_env,
2000                       output_type,
2001                       param_substs,
2002                       Some(body.span),
2003                       &arena);
2004     let mut bcx = init_function(&fcx, false, output_type);
2005
2006     if attributes.iter().any(|item| item.check_name("rustc_mir")) {
2007         mir::trans_mir(bcx.build());
2008         fcx.cleanup();
2009         return;
2010     }
2011
2012     // cleanup scope for the incoming arguments
2013     let fn_cleanup_debug_loc = debuginfo::get_cleanup_debug_loc_for_ast_node(ccx,
2014                                                                              fn_ast_id,
2015                                                                              body.span,
2016                                                                              true);
2017     let arg_scope = fcx.push_custom_cleanup_scope_with_debug_loc(fn_cleanup_debug_loc);
2018
2019     let block_ty = node_id_type(bcx, body.id);
2020
2021     // Set up arguments to the function.
2022     let monomorphized_arg_types = decl.inputs
2023                                       .iter()
2024                                       .map(|arg| node_id_type(bcx, arg.id))
2025                                       .collect::<Vec<_>>();
2026     for monomorphized_arg_type in &monomorphized_arg_types {
2027         debug!("trans_closure: monomorphized_arg_type: {:?}",
2028                monomorphized_arg_type);
2029     }
2030     debug!("trans_closure: function lltype: {}",
2031            bcx.fcx.ccx.tn().val_to_string(bcx.fcx.llfn));
2032
2033     let has_tupled_arg = match closure_env {
2034         closure::ClosureEnv::NotClosure => abi == Abi::RustCall,
2035         _ => false,
2036     };
2037
2038     bcx = create_datums_for_fn_args(bcx,
2039                                     &decl.inputs,
2040                                     &monomorphized_arg_types,
2041                                     has_tupled_arg,
2042                                     arg_scope);
2043
2044     bcx = closure_env.load(bcx, cleanup::CustomScope(arg_scope));
2045
2046     // Up until here, IR instructions for this function have explicitly not been annotated with
2047     // source code location, so we don't step into call setup code. From here on, source location
2048     // emitting should be enabled.
2049     debuginfo::start_emitting_source_locations(&fcx);
2050
2051     let dest = match fcx.llretslotptr.get() {
2052         Some(_) => expr::SaveIn(fcx.get_ret_slot(bcx, ty::FnConverging(block_ty), "iret_slot")),
2053         None => {
2054             assert!(type_is_zero_size(bcx.ccx(), block_ty));
2055             expr::Ignore
2056         }
2057     };
2058
2059     // This call to trans_block is the place where we bridge between
2060     // translation calls that don't have a return value (trans_crate,
2061     // trans_mod, trans_item, et cetera) and those that do
2062     // (trans_block, trans_expr, et cetera).
2063     bcx = controlflow::trans_block(bcx, body, dest);
2064
2065     match dest {
2066         expr::SaveIn(slot) if fcx.needs_ret_allocas => {
2067             Store(bcx, slot, fcx.llretslotptr.get().unwrap());
2068         }
2069         _ => {}
2070     }
2071
2072     match fcx.llreturn.get() {
2073         Some(_) => {
2074             Br(bcx, fcx.return_exit_block(), DebugLoc::None);
2075             fcx.pop_custom_cleanup_scope(arg_scope);
2076         }
2077         None => {
2078             // Microoptimization writ large: avoid creating a separate
2079             // llreturn basic block
2080             bcx = fcx.pop_and_trans_custom_cleanup_scope(bcx, arg_scope);
2081         }
2082     };
2083
2084     // Put return block after all other blocks.
2085     // This somewhat improves single-stepping experience in debugger.
2086     unsafe {
2087         let llreturn = fcx.llreturn.get();
2088         if let Some(llreturn) = llreturn {
2089             llvm::LLVMMoveBasicBlockAfter(llreturn, bcx.llbb);
2090         }
2091     }
2092
2093     let ret_debug_loc = DebugLoc::At(fn_cleanup_debug_loc.id, fn_cleanup_debug_loc.span);
2094
2095     // Insert the mandatory first few basic blocks before lltop.
2096     finish_fn(&fcx, bcx, output_type, ret_debug_loc);
2097
2098     fn record_translation_item_as_generated<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
2099                                                       node_id: ast::NodeId,
2100                                                       param_substs: &'tcx Substs<'tcx>) {
2101         if !collector::collecting_debug_information(ccx) {
2102             return;
2103         }
2104
2105         let def_id = match ccx.tcx().node_id_to_type(node_id).sty {
2106             ty::TyClosure(def_id, _) => def_id,
2107             _ => ccx.external_srcs()
2108                     .borrow()
2109                     .get(&node_id)
2110                     .map(|did| *did)
2111                     .unwrap_or_else(|| ccx.tcx().map.local_def_id(node_id)),
2112         };
2113
2114         ccx.record_translation_item_as_generated(TransItem::Fn{
2115             def_id: def_id,
2116             substs: ccx.tcx().mk_substs(ccx.tcx().erase_regions(param_substs)),
2117         });
2118     }
2119 }
2120
2121 /// Creates an LLVM function corresponding to a source language function.
2122 pub fn trans_fn<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
2123                           decl: &hir::FnDecl,
2124                           body: &hir::Block,
2125                           llfndecl: ValueRef,
2126                           param_substs: &'tcx Substs<'tcx>,
2127                           id: ast::NodeId,
2128                           attrs: &[ast::Attribute]) {
2129     let _s = StatRecorder::new(ccx, ccx.tcx().map.path_to_string(id).to_string());
2130     debug!("trans_fn(param_substs={:?})", param_substs);
2131     let _icx = push_ctxt("trans_fn");
2132     let fn_ty = ccx.tcx().node_id_to_type(id);
2133     let fn_ty = monomorphize::apply_param_substs(ccx.tcx(), param_substs, &fn_ty);
2134     let sig = fn_ty.fn_sig();
2135     let sig = ccx.tcx().erase_late_bound_regions(&sig);
2136     let sig = infer::normalize_associated_type(ccx.tcx(), &sig);
2137     let output_type = sig.output;
2138     let abi = fn_ty.fn_abi();
2139     trans_closure(ccx,
2140                   decl,
2141                   body,
2142                   llfndecl,
2143                   param_substs,
2144                   id,
2145                   attrs,
2146                   output_type,
2147                   abi,
2148                   closure::ClosureEnv::NotClosure);
2149 }
2150
2151 pub fn trans_enum_variant<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
2152                                     ctor_id: ast::NodeId,
2153                                     disr: Disr,
2154                                     param_substs: &'tcx Substs<'tcx>,
2155                                     llfndecl: ValueRef) {
2156     let _icx = push_ctxt("trans_enum_variant");
2157
2158     trans_enum_variant_or_tuple_like_struct(ccx, ctor_id, disr, param_substs, llfndecl);
2159 }
2160
2161 pub fn trans_named_tuple_constructor<'blk, 'tcx>(mut bcx: Block<'blk, 'tcx>,
2162                                                  ctor_ty: Ty<'tcx>,
2163                                                  disr: Disr,
2164                                                  args: callee::CallArgs,
2165                                                  dest: expr::Dest,
2166                                                  debug_loc: DebugLoc)
2167                                                  -> Result<'blk, 'tcx> {
2168
2169     let ccx = bcx.fcx.ccx;
2170
2171     let sig = ccx.tcx().erase_late_bound_regions(&ctor_ty.fn_sig());
2172     let sig = infer::normalize_associated_type(ccx.tcx(), &sig);
2173     let result_ty = sig.output.unwrap();
2174
2175     // Get location to store the result. If the user does not care about
2176     // the result, just make a stack slot
2177     let llresult = match dest {
2178         expr::SaveIn(d) => d,
2179         expr::Ignore => {
2180             if !type_is_zero_size(ccx, result_ty) {
2181                 let llresult = alloc_ty(bcx, result_ty, "constructor_result");
2182                 call_lifetime_start(bcx, llresult);
2183                 llresult
2184             } else {
2185                 C_undef(type_of::type_of(ccx, result_ty).ptr_to())
2186             }
2187         }
2188     };
2189
2190     if !type_is_zero_size(ccx, result_ty) {
2191         match args {
2192             callee::ArgExprs(exprs) => {
2193                 let fields = exprs.iter().map(|x| &**x).enumerate().collect::<Vec<_>>();
2194                 bcx = expr::trans_adt(bcx,
2195                                       result_ty,
2196                                       disr,
2197                                       &fields[..],
2198                                       None,
2199                                       expr::SaveIn(llresult),
2200                                       debug_loc);
2201             }
2202             _ => ccx.sess().bug("expected expr as arguments for variant/struct tuple constructor"),
2203         }
2204     } else {
2205         // Just eval all the expressions (if any). Since expressions in Rust can have arbitrary
2206         // contents, there could be side-effects we need from them.
2207         match args {
2208             callee::ArgExprs(exprs) => {
2209                 for expr in exprs {
2210                     bcx = expr::trans_into(bcx, expr, expr::Ignore);
2211                 }
2212             }
2213             _ => (),
2214         }
2215     }
2216
2217     // If the caller doesn't care about the result
2218     // drop the temporary we made
2219     let bcx = match dest {
2220         expr::SaveIn(_) => bcx,
2221         expr::Ignore => {
2222             let bcx = glue::drop_ty(bcx, llresult, result_ty, debug_loc);
2223             if !type_is_zero_size(ccx, result_ty) {
2224                 call_lifetime_end(bcx, llresult);
2225             }
2226             bcx
2227         }
2228     };
2229
2230     Result::new(bcx, llresult)
2231 }
2232
2233 pub fn trans_tuple_struct<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
2234                                     ctor_id: ast::NodeId,
2235                                     param_substs: &'tcx Substs<'tcx>,
2236                                     llfndecl: ValueRef) {
2237     let _icx = push_ctxt("trans_tuple_struct");
2238
2239     trans_enum_variant_or_tuple_like_struct(ccx, ctor_id, Disr(0), param_substs, llfndecl);
2240 }
2241
2242 fn trans_enum_variant_or_tuple_like_struct<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
2243                                                      ctor_id: ast::NodeId,
2244                                                      disr: Disr,
2245                                                      param_substs: &'tcx Substs<'tcx>,
2246                                                      llfndecl: ValueRef) {
2247     let ctor_ty = ccx.tcx().node_id_to_type(ctor_id);
2248     let ctor_ty = monomorphize::apply_param_substs(ccx.tcx(), param_substs, &ctor_ty);
2249
2250     let sig = ccx.tcx().erase_late_bound_regions(&ctor_ty.fn_sig());
2251     let sig = infer::normalize_associated_type(ccx.tcx(), &sig);
2252     let arg_tys = sig.inputs;
2253     let result_ty = sig.output;
2254
2255     let (arena, fcx): (TypedArena<_>, FunctionContext);
2256     arena = TypedArena::new();
2257     fcx = new_fn_ctxt(ccx,
2258                       llfndecl,
2259                       ctor_id,
2260                       false,
2261                       result_ty,
2262                       param_substs,
2263                       None,
2264                       &arena);
2265     let bcx = init_function(&fcx, false, result_ty);
2266
2267     assert!(!fcx.needs_ret_allocas);
2268
2269     if !type_is_zero_size(fcx.ccx, result_ty.unwrap()) {
2270         let dest = fcx.get_ret_slot(bcx, result_ty, "eret_slot");
2271         let dest_val = adt::MaybeSizedValue::sized(dest); // Can return unsized value
2272         let repr = adt::represent_type(ccx, result_ty.unwrap());
2273         let mut llarg_idx = fcx.arg_offset() as c_uint;
2274         for (i, arg_ty) in arg_tys.into_iter().enumerate() {
2275             let lldestptr = adt::trans_field_ptr(bcx, &*repr, dest_val, Disr::from(disr), i);
2276             if common::type_is_fat_ptr(bcx.tcx(), arg_ty) {
2277                 Store(bcx,
2278                       get_param(fcx.llfn, llarg_idx),
2279                       expr::get_dataptr(bcx, lldestptr));
2280                 Store(bcx,
2281                       get_param(fcx.llfn, llarg_idx + 1),
2282                       expr::get_meta(bcx, lldestptr));
2283                 llarg_idx += 2;
2284             } else {
2285                 let arg = get_param(fcx.llfn, llarg_idx);
2286                 llarg_idx += 1;
2287
2288                 if arg_is_indirect(ccx, arg_ty) {
2289                     memcpy_ty(bcx, lldestptr, arg, arg_ty);
2290                 } else {
2291                     store_ty(bcx, arg, lldestptr, arg_ty);
2292                 }
2293             }
2294         }
2295         adt::trans_set_discr(bcx, &*repr, dest, disr);
2296     }
2297
2298     finish_fn(&fcx, bcx, result_ty, DebugLoc::None);
2299 }
2300
2301 fn enum_variant_size_lint(ccx: &CrateContext, enum_def: &hir::EnumDef, sp: Span, id: ast::NodeId) {
2302     let mut sizes = Vec::new(); // does no allocation if no pushes, thankfully
2303
2304     let print_info = ccx.sess().print_enum_sizes();
2305
2306     let levels = ccx.tcx().node_lint_levels.borrow();
2307     let lint_id = lint::LintId::of(lint::builtin::VARIANT_SIZE_DIFFERENCES);
2308     let lvlsrc = levels.get(&(id, lint_id));
2309     let is_allow = lvlsrc.map_or(true, |&(lvl, _)| lvl == lint::Allow);
2310
2311     if is_allow && !print_info {
2312         // we're not interested in anything here
2313         return;
2314     }
2315
2316     let ty = ccx.tcx().node_id_to_type(id);
2317     let avar = adt::represent_type(ccx, ty);
2318     match *avar {
2319         adt::General(_, ref variants, _) => {
2320             for var in variants {
2321                 let mut size = 0;
2322                 for field in var.fields.iter().skip(1) {
2323                     // skip the discriminant
2324                     size += llsize_of_real(ccx, sizing_type_of(ccx, *field));
2325                 }
2326                 sizes.push(size);
2327             }
2328         },
2329         _ => { /* its size is either constant or unimportant */ }
2330     }
2331
2332     let (largest, slargest, largest_index) = sizes.iter().enumerate().fold((0, 0, 0),
2333         |(l, s, li), (idx, &size)|
2334             if size > l {
2335                 (size, l, idx)
2336             } else if size > s {
2337                 (l, size, li)
2338             } else {
2339                 (l, s, li)
2340             }
2341     );
2342
2343     // FIXME(#30505) Should use logging for this.
2344     if print_info {
2345         let llty = type_of::sizing_type_of(ccx, ty);
2346
2347         let sess = &ccx.tcx().sess;
2348         sess.span_note_without_error(sp,
2349                                      &*format!("total size: {} bytes", llsize_of_real(ccx, llty)));
2350         match *avar {
2351             adt::General(..) => {
2352                 for (i, var) in enum_def.variants.iter().enumerate() {
2353                     ccx.tcx()
2354                        .sess
2355                        .span_note_without_error(var.span,
2356                                                 &*format!("variant data: {} bytes", sizes[i]));
2357                 }
2358             }
2359             _ => {}
2360         }
2361     }
2362
2363     // we only warn if the largest variant is at least thrice as large as
2364     // the second-largest.
2365     if !is_allow && largest > slargest * 3 && slargest > 0 {
2366         // Use lint::raw_emit_lint rather than sess.add_lint because the lint-printing
2367         // pass for the latter already ran.
2368         lint::raw_struct_lint(&ccx.tcx().sess,
2369                               &ccx.tcx().sess.lint_store.borrow(),
2370                               lint::builtin::VARIANT_SIZE_DIFFERENCES,
2371                               *lvlsrc.unwrap(),
2372                               Some(sp),
2373                               &format!("enum variant is more than three times larger ({} bytes) \
2374                                         than the next largest (ignoring padding)",
2375                                        largest))
2376             .span_note(enum_def.variants[largest_index].span,
2377                        "this variant is the largest")
2378             .emit();
2379     }
2380 }
2381
2382 pub fn llvm_linkage_by_name(name: &str) -> Option<Linkage> {
2383     // Use the names from src/llvm/docs/LangRef.rst here. Most types are only
2384     // applicable to variable declarations and may not really make sense for
2385     // Rust code in the first place but whitelist them anyway and trust that
2386     // the user knows what s/he's doing. Who knows, unanticipated use cases
2387     // may pop up in the future.
2388     //
2389     // ghost, dllimport, dllexport and linkonce_odr_autohide are not supported
2390     // and don't have to be, LLVM treats them as no-ops.
2391     match name {
2392         "appending" => Some(llvm::AppendingLinkage),
2393         "available_externally" => Some(llvm::AvailableExternallyLinkage),
2394         "common" => Some(llvm::CommonLinkage),
2395         "extern_weak" => Some(llvm::ExternalWeakLinkage),
2396         "external" => Some(llvm::ExternalLinkage),
2397         "internal" => Some(llvm::InternalLinkage),
2398         "linkonce" => Some(llvm::LinkOnceAnyLinkage),
2399         "linkonce_odr" => Some(llvm::LinkOnceODRLinkage),
2400         "private" => Some(llvm::PrivateLinkage),
2401         "weak" => Some(llvm::WeakAnyLinkage),
2402         "weak_odr" => Some(llvm::WeakODRLinkage),
2403         _ => None,
2404     }
2405 }
2406
2407
2408 /// Enum describing the origin of an LLVM `Value`, for linkage purposes.
2409 #[derive(Copy, Clone)]
2410 pub enum ValueOrigin {
2411     /// The LLVM `Value` is in this context because the corresponding item was
2412     /// assigned to the current compilation unit.
2413     OriginalTranslation,
2414     /// The `Value`'s corresponding item was assigned to some other compilation
2415     /// unit, but the `Value` was translated in this context anyway because the
2416     /// item is marked `#[inline]`.
2417     InlinedCopy,
2418 }
2419
2420 /// Set the appropriate linkage for an LLVM `ValueRef` (function or global).
2421 /// If the `llval` is the direct translation of a specific Rust item, `id`
2422 /// should be set to the `NodeId` of that item.  (This mapping should be
2423 /// 1-to-1, so monomorphizations and drop/visit glue should have `id` set to
2424 /// `None`.)  `llval_origin` indicates whether `llval` is the translation of an
2425 /// item assigned to `ccx`'s compilation unit or an inlined copy of an item
2426 /// assigned to a different compilation unit.
2427 pub fn update_linkage(ccx: &CrateContext,
2428                       llval: ValueRef,
2429                       id: Option<ast::NodeId>,
2430                       llval_origin: ValueOrigin) {
2431     match llval_origin {
2432         InlinedCopy => {
2433             // `llval` is a translation of an item defined in a separate
2434             // compilation unit.  This only makes sense if there are at least
2435             // two compilation units.
2436             assert!(ccx.sess().opts.cg.codegen_units > 1);
2437             // `llval` is a copy of something defined elsewhere, so use
2438             // `AvailableExternallyLinkage` to avoid duplicating code in the
2439             // output.
2440             llvm::SetLinkage(llval, llvm::AvailableExternallyLinkage);
2441             return;
2442         },
2443         OriginalTranslation => {},
2444     }
2445
2446     if let Some(id) = id {
2447         let item = ccx.tcx().map.get(id);
2448         if let hir_map::NodeItem(i) = item {
2449             if let Some(name) = attr::first_attr_value_str_by_name(&i.attrs, "linkage") {
2450                 if let Some(linkage) = llvm_linkage_by_name(&name) {
2451                     llvm::SetLinkage(llval, linkage);
2452                 } else {
2453                     ccx.sess().span_fatal(i.span, "invalid linkage specified");
2454                 }
2455                 return;
2456             }
2457         }
2458     }
2459
2460     match id {
2461         Some(id) if ccx.reachable().contains(&id) => {
2462             llvm::SetLinkage(llval, llvm::ExternalLinkage);
2463         },
2464         _ => {
2465             // `id` does not refer to an item in `ccx.reachable`.
2466             if ccx.sess().opts.cg.codegen_units > 1 {
2467                 llvm::SetLinkage(llval, llvm::ExternalLinkage);
2468             } else {
2469                 llvm::SetLinkage(llval, llvm::InternalLinkage);
2470             }
2471         },
2472     }
2473 }
2474
2475 fn set_global_section(ccx: &CrateContext, llval: ValueRef, i: &hir::Item) {
2476     match attr::first_attr_value_str_by_name(&i.attrs, "link_section") {
2477         Some(sect) => {
2478             if contains_null(&sect) {
2479                 ccx.sess().fatal(&format!("Illegal null byte in link_section value: `{}`", &sect));
2480             }
2481             unsafe {
2482                 let buf = CString::new(sect.as_bytes()).unwrap();
2483                 llvm::LLVMSetSection(llval, buf.as_ptr());
2484             }
2485         },
2486         None => ()
2487     }
2488 }
2489
2490 pub fn trans_item(ccx: &CrateContext, item: &hir::Item) {
2491     let _icx = push_ctxt("trans_item");
2492
2493     let from_external = ccx.external_srcs().borrow().contains_key(&item.id);
2494
2495     match item.node {
2496         hir::ItemFn(ref decl, _, _, abi, ref generics, ref body) => {
2497             if !generics.is_type_parameterized() {
2498                 let trans_everywhere = attr::requests_inline(&item.attrs);
2499                 // Ignore `trans_everywhere` for cross-crate inlined items
2500                 // (`from_external`).  `trans_item` will be called once for each
2501                 // compilation unit that references the item, so it will still get
2502                 // translated everywhere it's needed.
2503                 for (ref ccx, is_origin) in ccx.maybe_iter(!from_external && trans_everywhere) {
2504                     let llfn = get_item_val(ccx, item.id);
2505                     let empty_substs = ccx.tcx().mk_substs(Substs::trans_empty());
2506                     if abi != Abi::Rust {
2507                         foreign::trans_rust_fn_with_foreign_abi(ccx,
2508                                                                 &**decl,
2509                                                                 &**body,
2510                                                                 &item.attrs,
2511                                                                 llfn,
2512                                                                 empty_substs,
2513                                                                 item.id,
2514                                                                 None);
2515                     } else {
2516                         trans_fn(ccx,
2517                                  &**decl,
2518                                  &**body,
2519                                  llfn,
2520                                  empty_substs,
2521                                  item.id,
2522                                  &item.attrs);
2523                     }
2524                     set_global_section(ccx, llfn, item);
2525                     update_linkage(ccx,
2526                                    llfn,
2527                                    Some(item.id),
2528                                    if is_origin {
2529                                        OriginalTranslation
2530                                    } else {
2531                                        InlinedCopy
2532                                    });
2533
2534                     if is_entry_fn(ccx.sess(), item.id) {
2535                         create_entry_wrapper(ccx, item.span, llfn);
2536                         // check for the #[rustc_error] annotation, which forces an
2537                         // error in trans. This is used to write compile-fail tests
2538                         // that actually test that compilation succeeds without
2539                         // reporting an error.
2540                         let item_def_id = ccx.tcx().map.local_def_id(item.id);
2541                         if ccx.tcx().has_attr(item_def_id, "rustc_error") {
2542                             ccx.tcx().sess.span_fatal(item.span, "compilation successful");
2543                         }
2544                     }
2545                 }
2546             }
2547         }
2548         hir::ItemImpl(_, _, ref generics, _, _, ref impl_items) => {
2549             meth::trans_impl(ccx, item.name, impl_items, generics, item.id);
2550         }
2551         hir::ItemMod(_) => {
2552             // modules have no equivalent at runtime, they just affect
2553             // the mangled names of things contained within
2554         }
2555         hir::ItemEnum(ref enum_definition, ref gens) => {
2556             if gens.ty_params.is_empty() {
2557                 // sizes only make sense for non-generic types
2558
2559                 enum_variant_size_lint(ccx, enum_definition, item.span, item.id);
2560             }
2561         }
2562         hir::ItemConst(..) => {}
2563         hir::ItemStatic(_, m, ref expr) => {
2564             let g = match consts::trans_static(ccx, m, expr, item.id, &item.attrs) {
2565                 Ok(g) => g,
2566                 Err(err) => ccx.tcx().sess.span_fatal(expr.span, &err.description()),
2567             };
2568             set_global_section(ccx, g, item);
2569             update_linkage(ccx, g, Some(item.id), OriginalTranslation);
2570         }
2571         hir::ItemForeignMod(ref foreign_mod) => {
2572             foreign::trans_foreign_mod(ccx, foreign_mod);
2573         }
2574         hir::ItemTrait(..) => {}
2575         _ => {
2576             // fall through
2577         }
2578     }
2579 }
2580
2581 // only use this for foreign function ABIs and glue, use `register_fn` for Rust functions
2582 pub fn register_fn_llvmty(ccx: &CrateContext,
2583                           sp: Span,
2584                           sym: String,
2585                           node_id: ast::NodeId,
2586                           cc: llvm::CallConv,
2587                           llfty: Type)
2588                           -> ValueRef {
2589     debug!("register_fn_llvmty id={} sym={}", node_id, sym);
2590
2591     let llfn = declare::define_fn(ccx, &sym[..], cc, llfty,
2592                                    ty::FnConverging(ccx.tcx().mk_nil())).unwrap_or_else(||{
2593         ccx.sess().span_fatal(sp, &format!("symbol `{}` is already defined", sym));
2594     });
2595     finish_register_fn(ccx, sym, node_id);
2596     llfn
2597 }
2598
2599 fn finish_register_fn(ccx: &CrateContext, sym: String, node_id: ast::NodeId) {
2600     ccx.item_symbols().borrow_mut().insert(node_id, sym);
2601 }
2602
2603 fn register_fn<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
2604                          sp: Span,
2605                          sym: String,
2606                          node_id: ast::NodeId,
2607                          node_type: Ty<'tcx>)
2608                          -> ValueRef {
2609     if let ty::TyBareFn(_, ref f) = node_type.sty {
2610         if f.abi != Abi::Rust && f.abi != Abi::RustCall {
2611             ccx.sess().span_bug(sp,
2612                                 &format!("only the `{}` or `{}` calling conventions are valid \
2613                                           for this function; `{}` was specified",
2614                                          Abi::Rust.name(),
2615                                          Abi::RustCall.name(),
2616                                          f.abi.name()));
2617         }
2618     } else {
2619         ccx.sess().span_bug(sp, "expected bare rust function")
2620     }
2621
2622     let llfn = declare::define_rust_fn(ccx, &sym[..], node_type).unwrap_or_else(|| {
2623         ccx.sess().span_fatal(sp, &format!("symbol `{}` is already defined", sym));
2624     });
2625     finish_register_fn(ccx, sym, node_id);
2626     llfn
2627 }
2628
2629 pub fn is_entry_fn(sess: &Session, node_id: ast::NodeId) -> bool {
2630     match *sess.entry_fn.borrow() {
2631         Some((entry_id, _)) => node_id == entry_id,
2632         None => false,
2633     }
2634 }
2635
2636 /// Create the `main` function which will initialise the rust runtime and call users’ main
2637 /// function.
2638 pub fn create_entry_wrapper(ccx: &CrateContext, sp: Span, main_llfn: ValueRef) {
2639     let et = ccx.sess().entry_type.get().unwrap();
2640     match et {
2641         config::EntryMain => {
2642             create_entry_fn(ccx, sp, main_llfn, true);
2643         }
2644         config::EntryStart => create_entry_fn(ccx, sp, main_llfn, false),
2645         config::EntryNone => {}    // Do nothing.
2646     }
2647
2648     fn create_entry_fn(ccx: &CrateContext,
2649                        sp: Span,
2650                        rust_main: ValueRef,
2651                        use_start_lang_item: bool) {
2652         let llfty = Type::func(&[ccx.int_type(), Type::i8p(ccx).ptr_to()], &ccx.int_type());
2653
2654         let llfn = declare::define_cfn(ccx, "main", llfty, ccx.tcx().mk_nil()).unwrap_or_else(|| {
2655             // FIXME: We should be smart and show a better diagnostic here.
2656             ccx.sess().struct_span_err(sp, "entry symbol `main` defined multiple times")
2657                       .help("did you use #[no_mangle] on `fn main`? Use #[start] instead")
2658                       .emit();
2659             ccx.sess().abort_if_errors();
2660             panic!();
2661         });
2662
2663         let llbb = unsafe {
2664             llvm::LLVMAppendBasicBlockInContext(ccx.llcx(), llfn, "top\0".as_ptr() as *const _)
2665         };
2666         let bld = ccx.raw_builder();
2667         unsafe {
2668             llvm::LLVMPositionBuilderAtEnd(bld, llbb);
2669
2670             debuginfo::gdb::insert_reference_to_gdb_debug_scripts_section_global(ccx);
2671
2672             let (start_fn, args) = if use_start_lang_item {
2673                 let start_def_id = match ccx.tcx().lang_items.require(StartFnLangItem) {
2674                     Ok(id) => id,
2675                     Err(s) => {
2676                         ccx.sess().fatal(&s[..]);
2677                     }
2678                 };
2679                 let start_fn = if let Some(start_node_id) = ccx.tcx()
2680                                                                .map
2681                                                                .as_local_node_id(start_def_id) {
2682                     get_item_val(ccx, start_node_id)
2683                 } else {
2684                     let start_fn_type = ccx.tcx().lookup_item_type(start_def_id).ty;
2685                     trans_external_path(ccx, start_def_id, start_fn_type)
2686                 };
2687                 let args = {
2688                     let opaque_rust_main =
2689                         llvm::LLVMBuildPointerCast(bld,
2690                                                    rust_main,
2691                                                    Type::i8p(ccx).to_ref(),
2692                                                    "rust_main\0".as_ptr() as *const _);
2693
2694                     vec![opaque_rust_main, get_param(llfn, 0), get_param(llfn, 1)]
2695                 };
2696                 (start_fn, args)
2697             } else {
2698                 debug!("using user-defined start fn");
2699                 let args = vec![get_param(llfn, 0 as c_uint), get_param(llfn, 1 as c_uint)];
2700
2701                 (rust_main, args)
2702             };
2703
2704             let result = llvm::LLVMRustBuildCall(bld,
2705                                                  start_fn,
2706                                                  args.as_ptr(),
2707                                                  args.len() as c_uint,
2708                                                  0 as *mut _,
2709                                                  noname());
2710
2711             llvm::LLVMBuildRet(bld, result);
2712         }
2713     }
2714 }
2715
2716 fn exported_name<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
2717                            id: ast::NodeId,
2718                            ty: Ty<'tcx>,
2719                            attrs: &[ast::Attribute])
2720                            -> String {
2721     match ccx.external_srcs().borrow().get(&id) {
2722         Some(&did) => {
2723             let sym = ccx.sess().cstore.item_symbol(did);
2724             debug!("found item {} in other crate...", sym);
2725             return sym;
2726         }
2727         None => {}
2728     }
2729
2730     match attr::find_export_name_attr(Some(ccx.sess().diagnostic()), attrs) {
2731         // Use provided name
2732         Some(name) => name.to_string(),
2733         _ => {
2734             let path = ccx.tcx().map.def_path_from_id(id);
2735             if attr::contains_name(attrs, "no_mangle") {
2736                 // Don't mangle
2737                 path.last().unwrap().data.to_string()
2738             } else {
2739                 match weak_lang_items::link_name(attrs) {
2740                     Some(name) => name.to_string(),
2741                     None => {
2742                         // Usual name mangling
2743                         mangle_exported_name(ccx, path, ty, id)
2744                     }
2745                 }
2746             }
2747         }
2748     }
2749 }
2750
2751 fn contains_null(s: &str) -> bool {
2752     s.bytes().any(|b| b == 0)
2753 }
2754
2755 pub fn get_item_val(ccx: &CrateContext, id: ast::NodeId) -> ValueRef {
2756     debug!("get_item_val(id=`{}`)", id);
2757
2758     match ccx.item_vals().borrow().get(&id).cloned() {
2759         Some(v) => return v,
2760         None => {}
2761     }
2762
2763     let item = ccx.tcx().map.get(id);
2764     debug!("get_item_val: id={} item={:?}", id, item);
2765     let val = match item {
2766         hir_map::NodeItem(i) => {
2767             let ty = ccx.tcx().node_id_to_type(i.id);
2768             let sym = || exported_name(ccx, id, ty, &i.attrs);
2769
2770             let v = match i.node {
2771                 hir::ItemStatic(..) => {
2772                     // If this static came from an external crate, then
2773                     // we need to get the symbol from metadata instead of
2774                     // using the current crate's name/version
2775                     // information in the hash of the symbol
2776                     let sym = sym();
2777                     debug!("making {}", sym);
2778
2779                     // Create the global before evaluating the initializer;
2780                     // this is necessary to allow recursive statics.
2781                     let llty = type_of(ccx, ty);
2782                     let g = declare::define_global(ccx, &sym[..], llty).unwrap_or_else(|| {
2783                         ccx.sess()
2784                            .span_fatal(i.span, &format!("symbol `{}` is already defined", sym))
2785                     });
2786
2787                     ccx.item_symbols().borrow_mut().insert(i.id, sym);
2788                     g
2789                 }
2790
2791                 hir::ItemFn(_, _, _, abi, _, _) => {
2792                     let sym = sym();
2793                     let llfn = if abi == Abi::Rust {
2794                         register_fn(ccx, i.span, sym, i.id, ty)
2795                     } else {
2796                         foreign::register_rust_fn_with_foreign_abi(ccx, i.span, sym, i.id)
2797                     };
2798                     attributes::from_fn_attrs(ccx, &i.attrs, llfn);
2799                     llfn
2800                 }
2801
2802                 _ => ccx.sess().bug("get_item_val: weird result in table"),
2803             };
2804
2805             v
2806         }
2807
2808         hir_map::NodeTraitItem(trait_item) => {
2809             debug!("get_item_val(): processing a NodeTraitItem");
2810             match trait_item.node {
2811                 hir::MethodTraitItem(_, Some(_)) => {
2812                     register_method(ccx, id, &trait_item.attrs, trait_item.span)
2813                 }
2814                 _ => {
2815                     ccx.sess().span_bug(trait_item.span,
2816                                         "unexpected variant: trait item other than a provided \
2817                                          method in get_item_val()");
2818                 }
2819             }
2820         }
2821
2822         hir_map::NodeImplItem(impl_item) => {
2823             match impl_item.node {
2824                 hir::ImplItemKind::Method(..) => {
2825                     register_method(ccx, id, &impl_item.attrs, impl_item.span)
2826                 }
2827                 _ => {
2828                     ccx.sess().span_bug(impl_item.span,
2829                                         "unexpected variant: non-method impl item in \
2830                                          get_item_val()");
2831                 }
2832             }
2833         }
2834
2835         hir_map::NodeForeignItem(ni) => {
2836             match ni.node {
2837                 hir::ForeignItemFn(..) => {
2838                     let abi = ccx.tcx().map.get_foreign_abi(id);
2839                     let ty = ccx.tcx().node_id_to_type(ni.id);
2840                     let name = foreign::link_name(&*ni);
2841                     foreign::register_foreign_item_fn(ccx, abi, ty, &name, &ni.attrs)
2842                 }
2843                 hir::ForeignItemStatic(..) => {
2844                     foreign::register_static(ccx, &*ni)
2845                 }
2846             }
2847         }
2848
2849         hir_map::NodeVariant(ref v) => {
2850             let llfn;
2851             let fields = if v.node.data.is_struct() {
2852                 ccx.sess().bug("struct variant kind unexpected in get_item_val")
2853             } else {
2854                 v.node.data.fields()
2855             };
2856             assert!(!fields.is_empty());
2857             let ty = ccx.tcx().node_id_to_type(id);
2858             let parent = ccx.tcx().map.get_parent(id);
2859             let enm = ccx.tcx().map.expect_item(parent);
2860             let sym = exported_name(ccx, id, ty, &enm.attrs);
2861
2862             llfn = match enm.node {
2863                 hir::ItemEnum(_, _) => {
2864                     register_fn(ccx, (*v).span, sym, id, ty)
2865                 }
2866                 _ => ccx.sess().bug("NodeVariant, shouldn't happen"),
2867             };
2868             attributes::inline(llfn, attributes::InlineAttr::Hint);
2869             llfn
2870         }
2871
2872         hir_map::NodeStructCtor(struct_def) => {
2873             // Only register the constructor if this is a tuple-like struct.
2874             let ctor_id = if struct_def.is_struct() {
2875                 ccx.sess().bug("attempt to register a constructor of a non-tuple-like struct")
2876             } else {
2877                 struct_def.id()
2878             };
2879             let parent = ccx.tcx().map.get_parent(id);
2880             let struct_item = ccx.tcx().map.expect_item(parent);
2881             let ty = ccx.tcx().node_id_to_type(ctor_id);
2882             let sym = exported_name(ccx, id, ty, &struct_item.attrs);
2883             let llfn = register_fn(ccx, struct_item.span, sym, ctor_id, ty);
2884             attributes::inline(llfn, attributes::InlineAttr::Hint);
2885             llfn
2886         }
2887
2888         ref variant => {
2889             ccx.sess().bug(&format!("get_item_val(): unexpected variant: {:?}", variant))
2890         }
2891     };
2892
2893     // All LLVM globals and functions are initially created as external-linkage
2894     // declarations.  If `trans_item`/`trans_fn` later turns the declaration
2895     // into a definition, it adjusts the linkage then (using `update_linkage`).
2896     //
2897     // The exception is foreign items, which have their linkage set inside the
2898     // call to `foreign::register_*` above.  We don't touch the linkage after
2899     // that (`foreign::trans_foreign_mod` doesn't adjust the linkage like the
2900     // other item translation functions do).
2901
2902     ccx.item_vals().borrow_mut().insert(id, val);
2903     val
2904 }
2905
2906 fn register_method(ccx: &CrateContext,
2907                    id: ast::NodeId,
2908                    attrs: &[ast::Attribute],
2909                    span: Span)
2910                    -> ValueRef {
2911     let mty = ccx.tcx().node_id_to_type(id);
2912
2913     let sym = exported_name(ccx, id, mty, &attrs);
2914
2915     if let ty::TyBareFn(_, ref f) = mty.sty {
2916         let llfn = if f.abi == Abi::Rust || f.abi == Abi::RustCall {
2917             register_fn(ccx, span, sym, id, mty)
2918         } else {
2919             foreign::register_rust_fn_with_foreign_abi(ccx, span, sym, id)
2920         };
2921         attributes::from_fn_attrs(ccx, &attrs, llfn);
2922         return llfn;
2923     } else {
2924         ccx.sess().span_bug(span, "expected bare rust function");
2925     }
2926 }
2927
2928 pub fn write_metadata<'a, 'tcx>(cx: &SharedCrateContext<'a, 'tcx>,
2929                                 krate: &hir::Crate,
2930                                 reachable: &NodeSet,
2931                                 mir_map: &MirMap<'tcx>)
2932                                 -> Vec<u8> {
2933     use flate;
2934
2935     let any_library = cx.sess()
2936                         .crate_types
2937                         .borrow()
2938                         .iter()
2939                         .any(|ty| *ty != config::CrateTypeExecutable);
2940     if !any_library {
2941         return Vec::new();
2942     }
2943
2944     let cstore = &cx.tcx().sess.cstore;
2945     let metadata = cstore.encode_metadata(cx.tcx(),
2946                                           cx.export_map(),
2947                                           cx.item_symbols(),
2948                                           cx.link_meta(),
2949                                           reachable,
2950                                           mir_map,
2951                                           krate);
2952     let mut compressed = cstore.metadata_encoding_version().to_vec();
2953     compressed.extend_from_slice(&flate::deflate_bytes(&metadata));
2954
2955     let llmeta = C_bytes_in_context(cx.metadata_llcx(), &compressed[..]);
2956     let llconst = C_struct_in_context(cx.metadata_llcx(), &[llmeta], false);
2957     let name = format!("rust_metadata_{}_{}",
2958                        cx.link_meta().crate_name,
2959                        cx.link_meta().crate_hash);
2960     let buf = CString::new(name).unwrap();
2961     let llglobal = unsafe {
2962         llvm::LLVMAddGlobal(cx.metadata_llmod(), val_ty(llconst).to_ref(), buf.as_ptr())
2963     };
2964     unsafe {
2965         llvm::LLVMSetInitializer(llglobal, llconst);
2966         let name =
2967             cx.tcx().sess.cstore.metadata_section_name(&cx.sess().target.target);
2968         let name = CString::new(name).unwrap();
2969         llvm::LLVMSetSection(llglobal, name.as_ptr())
2970     }
2971     return metadata;
2972 }
2973
2974 /// Find any symbols that are defined in one compilation unit, but not declared
2975 /// in any other compilation unit.  Give these symbols internal linkage.
2976 fn internalize_symbols(cx: &SharedCrateContext, reachable: &HashSet<&str>) {
2977     unsafe {
2978         let mut declared = HashSet::new();
2979
2980         // Collect all external declarations in all compilation units.
2981         for ccx in cx.iter() {
2982             for val in iter_globals(ccx.llmod()).chain(iter_functions(ccx.llmod())) {
2983                 let linkage = llvm::LLVMGetLinkage(val);
2984                 // We only care about external declarations (not definitions)
2985                 // and available_externally definitions.
2986                 if !(linkage == llvm::ExternalLinkage as c_uint &&
2987                      llvm::LLVMIsDeclaration(val) != 0) &&
2988                    !(linkage == llvm::AvailableExternallyLinkage as c_uint) {
2989                     continue;
2990                 }
2991
2992                 let name = CStr::from_ptr(llvm::LLVMGetValueName(val))
2993                                .to_bytes()
2994                                .to_vec();
2995                 declared.insert(name);
2996             }
2997         }
2998
2999         // Examine each external definition.  If the definition is not used in
3000         // any other compilation unit, and is not reachable from other crates,
3001         // then give it internal linkage.
3002         for ccx in cx.iter() {
3003             for val in iter_globals(ccx.llmod()).chain(iter_functions(ccx.llmod())) {
3004                 // We only care about external definitions.
3005                 if !(llvm::LLVMGetLinkage(val) == llvm::ExternalLinkage as c_uint &&
3006                      llvm::LLVMIsDeclaration(val) == 0) {
3007                     continue;
3008                 }
3009
3010                 let name = CStr::from_ptr(llvm::LLVMGetValueName(val))
3011                                .to_bytes()
3012                                .to_vec();
3013                 if !declared.contains(&name) &&
3014                    !reachable.contains(str::from_utf8(&name).unwrap()) {
3015                     llvm::SetLinkage(val, llvm::InternalLinkage);
3016                     llvm::SetDLLStorageClass(val, llvm::DefaultStorageClass);
3017                 }
3018             }
3019         }
3020     }
3021 }
3022
3023 // Create a `__imp_<symbol> = &symbol` global for every public static `symbol`.
3024 // This is required to satisfy `dllimport` references to static data in .rlibs
3025 // when using MSVC linker.  We do this only for data, as linker can fix up
3026 // code references on its own.
3027 // See #26591, #27438
3028 fn create_imps(cx: &SharedCrateContext) {
3029     // The x86 ABI seems to require that leading underscores are added to symbol
3030     // names, so we need an extra underscore on 32-bit. There's also a leading
3031     // '\x01' here which disables LLVM's symbol mangling (e.g. no extra
3032     // underscores added in front).
3033     let prefix = if cx.sess().target.target.target_pointer_width == "32" {
3034         "\x01__imp__"
3035     } else {
3036         "\x01__imp_"
3037     };
3038     unsafe {
3039         for ccx in cx.iter() {
3040             let exported: Vec<_> = iter_globals(ccx.llmod())
3041                                        .filter(|&val| {
3042                                            llvm::LLVMGetLinkage(val) ==
3043                                            llvm::ExternalLinkage as c_uint &&
3044                                            llvm::LLVMIsDeclaration(val) == 0
3045                                        })
3046                                        .collect();
3047
3048             let i8p_ty = Type::i8p(&ccx);
3049             for val in exported {
3050                 let name = CStr::from_ptr(llvm::LLVMGetValueName(val));
3051                 let mut imp_name = prefix.as_bytes().to_vec();
3052                 imp_name.extend(name.to_bytes());
3053                 let imp_name = CString::new(imp_name).unwrap();
3054                 let imp = llvm::LLVMAddGlobal(ccx.llmod(),
3055                                               i8p_ty.to_ref(),
3056                                               imp_name.as_ptr() as *const _);
3057                 let init = llvm::LLVMConstBitCast(val, i8p_ty.to_ref());
3058                 llvm::LLVMSetInitializer(imp, init);
3059                 llvm::SetLinkage(imp, llvm::ExternalLinkage);
3060             }
3061         }
3062     }
3063 }
3064
3065 struct ValueIter {
3066     cur: ValueRef,
3067     step: unsafe extern "C" fn(ValueRef) -> ValueRef,
3068 }
3069
3070 impl Iterator for ValueIter {
3071     type Item = ValueRef;
3072
3073     fn next(&mut self) -> Option<ValueRef> {
3074         let old = self.cur;
3075         if !old.is_null() {
3076             self.cur = unsafe { (self.step)(old) };
3077             Some(old)
3078         } else {
3079             None
3080         }
3081     }
3082 }
3083
3084 fn iter_globals(llmod: llvm::ModuleRef) -> ValueIter {
3085     unsafe {
3086         ValueIter {
3087             cur: llvm::LLVMGetFirstGlobal(llmod),
3088             step: llvm::LLVMGetNextGlobal,
3089         }
3090     }
3091 }
3092
3093 fn iter_functions(llmod: llvm::ModuleRef) -> ValueIter {
3094     unsafe {
3095         ValueIter {
3096             cur: llvm::LLVMGetFirstFunction(llmod),
3097             step: llvm::LLVMGetNextFunction,
3098         }
3099     }
3100 }
3101
3102 /// The context provided lists a set of reachable ids as calculated by
3103 /// middle::reachable, but this contains far more ids and symbols than we're
3104 /// actually exposing from the object file. This function will filter the set in
3105 /// the context to the set of ids which correspond to symbols that are exposed
3106 /// from the object file being generated.
3107 ///
3108 /// This list is later used by linkers to determine the set of symbols needed to
3109 /// be exposed from a dynamic library and it's also encoded into the metadata.
3110 pub fn filter_reachable_ids(ccx: &SharedCrateContext) -> NodeSet {
3111     ccx.reachable().iter().map(|x| *x).filter(|id| {
3112         // First, only worry about nodes which have a symbol name
3113         ccx.item_symbols().borrow().contains_key(id)
3114     }).filter(|&id| {
3115         // Next, we want to ignore some FFI functions that are not exposed from
3116         // this crate. Reachable FFI functions can be lumped into two
3117         // categories:
3118         //
3119         // 1. Those that are included statically via a static library
3120         // 2. Those included otherwise (e.g. dynamically or via a framework)
3121         //
3122         // Although our LLVM module is not literally emitting code for the
3123         // statically included symbols, it's an export of our library which
3124         // needs to be passed on to the linker and encoded in the metadata.
3125         //
3126         // As a result, if this id is an FFI item (foreign item) then we only
3127         // let it through if it's included statically.
3128         match ccx.tcx().map.get(id) {
3129             hir_map::NodeForeignItem(..) => {
3130                 ccx.sess().cstore.is_statically_included_foreign_item(id)
3131             }
3132             _ => true,
3133         }
3134     }).collect()
3135 }
3136
3137 pub fn trans_crate<'tcx>(tcx: &ty::ctxt<'tcx>,
3138                          mir_map: &MirMap<'tcx>,
3139                          analysis: ty::CrateAnalysis)
3140                          -> CrateTranslation {
3141     let _task = tcx.dep_graph.in_task(DepNode::TransCrate);
3142
3143     // Be careful with this krate: obviously it gives access to the
3144     // entire contents of the krate. So if you push any subtasks of
3145     // `TransCrate`, you need to be careful to register "reads" of the
3146     // particular items that will be processed.
3147     let krate = tcx.map.krate();
3148
3149     let ty::CrateAnalysis { export_map, reachable, name, .. } = analysis;
3150
3151     let check_overflow = if let Some(v) = tcx.sess.opts.debugging_opts.force_overflow_checks {
3152         v
3153     } else {
3154         tcx.sess.opts.debug_assertions
3155     };
3156
3157     let check_dropflag = if let Some(v) = tcx.sess.opts.debugging_opts.force_dropflag_checks {
3158         v
3159     } else {
3160         tcx.sess.opts.debug_assertions
3161     };
3162
3163     // Before we touch LLVM, make sure that multithreading is enabled.
3164     unsafe {
3165         use std::sync::Once;
3166         static INIT: Once = Once::new();
3167         static mut POISONED: bool = false;
3168         INIT.call_once(|| {
3169             if llvm::LLVMStartMultithreaded() != 1 {
3170                 // use an extra bool to make sure that all future usage of LLVM
3171                 // cannot proceed despite the Once not running more than once.
3172                 POISONED = true;
3173             }
3174
3175             ::back::write::configure_llvm(&tcx.sess);
3176         });
3177
3178         if POISONED {
3179             tcx.sess.bug("couldn't enable multi-threaded LLVM");
3180         }
3181     }
3182
3183     let link_meta = link::build_link_meta(&tcx.sess, krate, name);
3184
3185     let codegen_units = tcx.sess.opts.cg.codegen_units;
3186     let shared_ccx = SharedCrateContext::new(&link_meta.crate_name,
3187                                              codegen_units,
3188                                              tcx,
3189                                              &mir_map,
3190                                              export_map,
3191                                              Sha256::new(),
3192                                              link_meta.clone(),
3193                                              reachable,
3194                                              check_overflow,
3195                                              check_dropflag);
3196
3197     {
3198         let ccx = shared_ccx.get_ccx(0);
3199
3200         // First, verify intrinsics.
3201         intrinsic::check_intrinsics(&ccx);
3202
3203         collect_translation_items(&ccx);
3204
3205         // Next, translate all items. See `TransModVisitor` for
3206         // details on why we walk in this particular way.
3207         {
3208             let _icx = push_ctxt("text");
3209             intravisit::walk_mod(&mut TransItemsWithinModVisitor { ccx: &ccx }, &krate.module);
3210             krate.visit_all_items(&mut TransModVisitor { ccx: &ccx });
3211         }
3212
3213         collector::print_collection_results(&ccx);
3214     }
3215
3216     for ccx in shared_ccx.iter() {
3217         if ccx.sess().opts.debuginfo != NoDebugInfo {
3218             debuginfo::finalize(&ccx);
3219         }
3220         for &(old_g, new_g) in ccx.statics_to_rauw().borrow().iter() {
3221             unsafe {
3222                 let bitcast = llvm::LLVMConstPointerCast(new_g, llvm::LLVMTypeOf(old_g));
3223                 llvm::LLVMReplaceAllUsesWith(old_g, bitcast);
3224                 llvm::LLVMDeleteGlobal(old_g);
3225             }
3226         }
3227     }
3228
3229     let reachable_symbol_ids = filter_reachable_ids(&shared_ccx);
3230
3231     // Translate the metadata.
3232     let metadata = time(tcx.sess.time_passes(), "write metadata", || {
3233         write_metadata(&shared_ccx, krate, &reachable_symbol_ids, mir_map)
3234     });
3235
3236     if shared_ccx.sess().trans_stats() {
3237         let stats = shared_ccx.stats();
3238         println!("--- trans stats ---");
3239         println!("n_glues_created: {}", stats.n_glues_created.get());
3240         println!("n_null_glues: {}", stats.n_null_glues.get());
3241         println!("n_real_glues: {}", stats.n_real_glues.get());
3242
3243         println!("n_fns: {}", stats.n_fns.get());
3244         println!("n_monos: {}", stats.n_monos.get());
3245         println!("n_inlines: {}", stats.n_inlines.get());
3246         println!("n_closures: {}", stats.n_closures.get());
3247         println!("fn stats:");
3248         stats.fn_stats.borrow_mut().sort_by(|&(_, insns_a), &(_, insns_b)| {
3249             insns_b.cmp(&insns_a)
3250         });
3251         for tuple in stats.fn_stats.borrow().iter() {
3252             match *tuple {
3253                 (ref name, insns) => {
3254                     println!("{} insns, {}", insns, *name);
3255                 }
3256             }
3257         }
3258     }
3259     if shared_ccx.sess().count_llvm_insns() {
3260         for (k, v) in shared_ccx.stats().llvm_insns.borrow().iter() {
3261             println!("{:7} {}", *v, *k);
3262         }
3263     }
3264
3265     let modules = shared_ccx.iter()
3266         .map(|ccx| ModuleTranslation { llcx: ccx.llcx(), llmod: ccx.llmod() })
3267         .collect();
3268
3269     let sess = shared_ccx.sess();
3270     let mut reachable_symbols = reachable_symbol_ids.iter().map(|id| {
3271         shared_ccx.item_symbols().borrow()[id].to_string()
3272     }).collect::<Vec<_>>();
3273     if sess.entry_fn.borrow().is_some() {
3274         reachable_symbols.push("main".to_string());
3275     }
3276
3277     // For the purposes of LTO, we add to the reachable set all of the upstream
3278     // reachable extern fns. These functions are all part of the public ABI of
3279     // the final product, so LTO needs to preserve them.
3280     if sess.lto() {
3281         for cnum in sess.cstore.crates() {
3282             let syms = sess.cstore.reachable_ids(cnum);
3283             reachable_symbols.extend(syms.into_iter().filter(|did| {
3284                 sess.cstore.is_extern_item(shared_ccx.tcx(), *did)
3285             }).map(|did| {
3286                 sess.cstore.item_symbol(did)
3287             }));
3288         }
3289     }
3290
3291     if codegen_units > 1 {
3292         internalize_symbols(&shared_ccx,
3293                             &reachable_symbols.iter().map(|x| &x[..]).collect());
3294     }
3295
3296     if sess.target.target.options.is_like_msvc &&
3297        sess.crate_types.borrow().iter().any(|ct| *ct == config::CrateTypeRlib) {
3298         create_imps(&shared_ccx);
3299     }
3300
3301     let metadata_module = ModuleTranslation {
3302         llcx: shared_ccx.metadata_llcx(),
3303         llmod: shared_ccx.metadata_llmod(),
3304     };
3305     let no_builtins = attr::contains_name(&krate.attrs, "no_builtins");
3306
3307     assert_dep_graph::assert_dep_graph(tcx);
3308
3309     CrateTranslation {
3310         modules: modules,
3311         metadata_module: metadata_module,
3312         link: link_meta,
3313         metadata: metadata,
3314         reachable: reachable_symbols,
3315         no_builtins: no_builtins,
3316     }
3317 }
3318
3319 /// We visit all the items in the krate and translate them.  We do
3320 /// this in two walks. The first walk just finds module items. It then
3321 /// walks the full contents of those module items and translates all
3322 /// the items within. Note that this entire process is O(n). The
3323 /// reason for this two phased walk is that each module is
3324 /// (potentially) placed into a distinct codegen-unit. This walk also
3325 /// ensures that the immediate contents of each module is processed
3326 /// entirely before we proceed to find more modules, helping to ensure
3327 /// an equitable distribution amongst codegen-units.
3328 pub struct TransModVisitor<'a, 'tcx: 'a> {
3329     pub ccx: &'a CrateContext<'a, 'tcx>,
3330 }
3331
3332 impl<'a, 'tcx, 'v> Visitor<'v> for TransModVisitor<'a, 'tcx> {
3333     fn visit_item(&mut self, i: &hir::Item) {
3334         match i.node {
3335             hir::ItemMod(_) => {
3336                 let item_ccx = self.ccx.rotate();
3337                 intravisit::walk_item(&mut TransItemsWithinModVisitor { ccx: &item_ccx }, i);
3338             }
3339             _ => { }
3340         }
3341     }
3342 }
3343
3344 /// Translates all the items within a given module. Expects owner to
3345 /// invoke `walk_item` on a module item. Ignores nested modules.
3346 pub struct TransItemsWithinModVisitor<'a, 'tcx: 'a> {
3347     pub ccx: &'a CrateContext<'a, 'tcx>,
3348 }
3349
3350 impl<'a, 'tcx, 'v> Visitor<'v> for TransItemsWithinModVisitor<'a, 'tcx> {
3351     fn visit_nested_item(&mut self, item_id: hir::ItemId) {
3352         self.visit_item(self.ccx.tcx().map.expect_item(item_id.id));
3353     }
3354
3355     fn visit_item(&mut self, i: &hir::Item) {
3356         match i.node {
3357             hir::ItemMod(..) => {
3358                 // skip modules, they will be uncovered by the TransModVisitor
3359             }
3360             _ => {
3361                 let def_id = self.ccx.tcx().map.local_def_id(i.id);
3362                 let tcx = self.ccx.tcx();
3363
3364                 // Create a subtask for trans'ing a particular item. We are
3365                 // giving `trans_item` access to this item, so also record a read.
3366                 tcx.dep_graph.with_task(DepNode::TransCrateItem(def_id), || {
3367                     tcx.dep_graph.read(DepNode::Hir(def_id));
3368
3369                     // We are going to be accessing various tables
3370                     // generated by TypeckItemBody; we also assume
3371                     // that the body passes type check. These tables
3372                     // are not individually tracked, so just register
3373                     // a read here.
3374                     tcx.dep_graph.read(DepNode::TypeckItemBody(def_id));
3375
3376                     trans_item(self.ccx, i);
3377                 });
3378
3379                 intravisit::walk_item(self, i);
3380             }
3381         }
3382     }
3383 }
3384
3385 fn collect_translation_items<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>) {
3386     let time_passes = ccx.sess().time_passes();
3387
3388     let collection_mode = match ccx.sess().opts.debugging_opts.print_trans_items {
3389         Some(ref s) => {
3390             let mode_string = s.to_lowercase();
3391             let mode_string = mode_string.trim();
3392             if mode_string == "eager" {
3393                 TransItemCollectionMode::Eager
3394             } else {
3395                 if mode_string != "lazy" {
3396                     let message = format!("Unknown codegen-item collection mode '{}'. \
3397                                            Falling back to 'lazy' mode.",
3398                                            mode_string);
3399                     ccx.sess().warn(&message);
3400                 }
3401
3402                 TransItemCollectionMode::Lazy
3403             }
3404         }
3405         None => TransItemCollectionMode::Lazy
3406     };
3407
3408     let items = time(time_passes, "translation item collection", || {
3409         collector::collect_crate_translation_items(&ccx, collection_mode)
3410     });
3411
3412     if ccx.sess().opts.debugging_opts.print_trans_items.is_some() {
3413         let mut item_keys: Vec<_> = items.iter()
3414                                          .map(|i| i.to_string(ccx))
3415                                          .collect();
3416         item_keys.sort();
3417
3418         for item in item_keys {
3419             println!("TRANS_ITEM {}", item);
3420         }
3421
3422         let mut ccx_map = ccx.translation_items().borrow_mut();
3423
3424         for cgi in items {
3425             ccx_map.insert(cgi, TransItemState::PredictedButNotGenerated);
3426         }
3427     }
3428 }