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