src/librustc_trans/trans/base.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 // trans.rs: Translate the completed AST to the LLVM IR.
  12 //
  13 // Some functions here, such as trans_block and trans_expr, return a value --
  14 // the result of the translation to LLVM -- while others, such as trans_fn,
  15 // trans_impl, and trans_item, are called only for the side effect of adding a
  16 // particular definition to the LLVM IR output we're producing.
  17 //
  18 // Hopefully useful general knowledge about trans:
  19 //
  20 //   * There's no way to find out the Ty type of a ValueRef.  Doing so
  21 //     would be "trying to get the eggs out of an omelette" (credit:
  22 //     pcwalton).  You can, instead, find out its TypeRef by calling val_ty,
  23 //     but one TypeRef corresponds to many `Ty`s; for instance, tup(int, int,
  24 //     int) and rec(x=int, y=int, z=int) will have the same TypeRef.
  25
  26 #![allow(non_camel_case_types)]
  27
  28 pub use self::ValueOrigin::*;
  29 pub use self::scalar_type::*;
  30
  31 use super::CrateTranslation;
  32 use super::ModuleTranslation;
  33
  34 use back::link::{mangle_exported_name};
  35 use back::{link, abi};
  36 use lint;
  37 use llvm::{BasicBlockRef, Linkage, ValueRef, Vector, get_param};
  38 use llvm;
  39 use metadata::{csearch, encoder, loader};
  40 use middle::astencode;
  41 use middle::cfg;
  42 use middle::lang_items::{LangItem, ExchangeMallocFnLangItem, StartFnLangItem};
  43 use middle::subst;
  44 use middle::weak_lang_items;
  45 use middle::subst::{Subst, Substs};
  46 use middle::ty::{self, Ty, UnboxedClosureTyper};
  47 use session::config::{self, NoDebugInfo};
  48 use session::Session;
  49 use trans::_match;
  50 use trans::adt;
  51 use trans::build::*;
  52 use trans::builder::{Builder, noname};
  53 use trans::callee;
  54 use trans::cleanup::CleanupMethods;
  55 use trans::cleanup;
  56 use trans::closure;
  57 use trans::common::{Block, C_bool, C_bytes_in_context, C_i32, C_integral};
  58 use trans::common::{C_null, C_struct_in_context, C_u64, C_u8, C_undef};
  59 use trans::common::{CrateContext, ExternMap, FunctionContext};
  60 use trans::common::{NodeInfo, Result};
  61 use trans::common::{node_id_type, return_type_is_void};
  62 use trans::common::{tydesc_info, type_is_immediate};
  63 use trans::common::{type_is_zero_size, val_ty};
  64 use trans::common;
  65 use trans::consts;
  66 use trans::context::SharedCrateContext;
  67 use trans::controlflow;
  68 use trans::datum;
  69 use trans::debuginfo;
  70 use trans::expr;
  71 use trans::foreign;
  72 use trans::glue;
  73 use trans::inline;
  74 use trans::intrinsic;
  75 use trans::machine;
  76 use trans::machine::{llsize_of, llsize_of_real};
  77 use trans::meth;
  78 use trans::monomorphize;
  79 use trans::tvec;
  80 use trans::type_::Type;
  81 use trans::type_of;
  82 use trans::type_of::*;
  83 use trans::value::Value;
  84 use util::common::indenter;
  85 use util::ppaux::{Repr, ty_to_string};
  86 use util::sha2::Sha256;
  87 use util::nodemap::NodeMap;
  88
  89 use arena::TypedArena;
  90 use libc::{c_uint, uint64_t};
  91 use std::ffi::{self, CString};
  92 use std::cell::{Cell, RefCell};
  93 use std::collections::HashSet;
  94 use std::mem;
  95 use std::rc::Rc;
  96 use std::str;
  97 use std::{i8, i16, i32, i64};
  98 use syntax::abi::{Rust, RustCall, RustIntrinsic, Abi};
  99 use syntax::ast_util::local_def;
 100 use syntax::attr::AttrMetaMethods;
 101 use syntax::attr;
 102 use syntax::codemap::Span;
 103 use syntax::parse::token::InternedString;
 104 use syntax::visit::Visitor;
 105 use syntax::visit;
 106 use syntax::{ast, ast_util, ast_map};
 107
 108 thread_local! {
 109     static TASK_LOCAL_INSN_KEY: RefCell<Option<Vec<&'static str>>> = {
 110         RefCell::new(None)
 111     }
 112 }
 113
 114 pub fn with_insn_ctxt<F>(blk: F) where
 115     F: FnOnce(&[&'static str]),
 116 {
 117     TASK_LOCAL_INSN_KEY.with(move |slot| {
 118         slot.borrow().as_ref().map(move |s| blk(s.as_slice()));
 119     })
 120 }
 121
 122 pub fn init_insn_ctxt() {
 123     TASK_LOCAL_INSN_KEY.with(|slot| {
 124         *slot.borrow_mut() = Some(Vec::new());
 125     });
 126 }
 127
 128 pub struct _InsnCtxt {
 129     _cannot_construct_outside_of_this_module: ()
 130 }
 131
 132 #[unsafe_destructor]
 133 impl Drop for _InsnCtxt {
 134     fn drop(&mut self) {
 135         TASK_LOCAL_INSN_KEY.with(|slot| {
 136             match slot.borrow_mut().as_mut() {
 137                 Some(ctx) => { ctx.pop(); }
 138                 None => {}
 139             }
 140         })
 141     }
 142 }
 143
 144 pub fn push_ctxt(s: &'static str) -> _InsnCtxt {
 145     debug!("new InsnCtxt: {}", s);
 146     TASK_LOCAL_INSN_KEY.with(|slot| {
 147         match slot.borrow_mut().as_mut() {
 148             Some(ctx) => ctx.push(s),
 149             None => {}
 150         }
 151     });
 152     _InsnCtxt { _cannot_construct_outside_of_this_module: () }
 153 }
 154
 155 pub struct StatRecorder<'a, 'tcx: 'a> {
 156     ccx: &'a CrateContext<'a, 'tcx>,
 157     name: Option<String>,
 158     istart: uint,
 159 }
 160
 161 impl<'a, 'tcx> StatRecorder<'a, 'tcx> {
 162     pub fn new(ccx: &'a CrateContext<'a, 'tcx>, name: String)
 163                -> StatRecorder<'a, 'tcx> {
 164         let istart = ccx.stats().n_llvm_insns.get();
 165         StatRecorder {
 166             ccx: ccx,
 167             name: Some(name),
 168             istart: istart,
 169         }
 170     }
 171 }
 172
 173 #[unsafe_destructor]
 174 impl<'a, 'tcx> Drop for StatRecorder<'a, 'tcx> {
 175     fn drop(&mut self) {
 176         if self.ccx.sess().trans_stats() {
 177             let iend = self.ccx.stats().n_llvm_insns.get();
 178             self.ccx.stats().fn_stats.borrow_mut().push((self.name.take().unwrap(),
 179                                                        iend - self.istart));
 180             self.ccx.stats().n_fns.set(self.ccx.stats().n_fns.get() + 1);
 181             // Reset LLVM insn count to avoid compound costs.
 182             self.ccx.stats().n_llvm_insns.set(self.istart);
 183         }
 184     }
 185 }
 186
 187 // only use this for foreign function ABIs and glue, use `decl_rust_fn` for Rust functions
 188 pub fn decl_fn(ccx: &CrateContext, name: &str, cc: llvm::CallConv,
 189                ty: Type, output: ty::FnOutput) -> ValueRef {
 190
 191     let buf = CString::from_slice(name.as_bytes());
 192     let llfn: ValueRef = unsafe {
 193         llvm::LLVMGetOrInsertFunction(ccx.llmod(), buf.as_ptr(), ty.to_ref())
 194     };
 195
 196     // diverging functions may unwind, but can never return normally
 197     if output == ty::FnDiverging {
 198         llvm::SetFunctionAttribute(llfn, llvm::NoReturnAttribute);
 199     }
 200
 201     if ccx.tcx().sess.opts.cg.no_redzone
 202         .unwrap_or(ccx.tcx().sess.target.target.options.disable_redzone) {
 203         llvm::SetFunctionAttribute(llfn, llvm::NoRedZoneAttribute)
 204     }
 205
 206     llvm::SetFunctionCallConv(llfn, cc);
 207     // Function addresses in Rust are never significant, allowing functions to be merged.
 208     llvm::SetUnnamedAddr(llfn, true);
 209
 210     if ccx.is_split_stack_supported() && !ccx.sess().opts.cg.no_stack_check {
 211         set_split_stack(llfn);
 212     }
 213
 214     llfn
 215 }
 216
 217 // only use this for foreign function ABIs and glue, use `decl_rust_fn` for Rust functions
 218 pub fn decl_cdecl_fn(ccx: &CrateContext,
 219                      name: &str,
 220                      ty: Type,
 221                      output: Ty) -> ValueRef {
 222     decl_fn(ccx, name, llvm::CCallConv, ty, ty::FnConverging(output))
 223 }
 224
 225 // only use this for foreign function ABIs and glue, use `get_extern_rust_fn` for Rust functions
 226 pub fn get_extern_fn(ccx: &CrateContext,
 227                      externs: &mut ExternMap,
 228                      name: &str,
 229                      cc: llvm::CallConv,
 230                      ty: Type,
 231                      output: Ty)
 232                      -> ValueRef {
 233     match externs.get(name) {
 234         Some(n) => return *n,
 235         None => {}
 236     }
 237     let f = decl_fn(ccx, name, cc, ty, ty::FnConverging(output));
 238     externs.insert(name.to_string(), f);
 239     f
 240 }
 241
 242 fn get_extern_rust_fn<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>, fn_ty: Ty<'tcx>,
 243                                 name: &str, did: ast::DefId) -> ValueRef {
 244     match ccx.externs().borrow().get(name) {
 245         Some(n) => return *n,
 246         None => ()
 247     }
 248
 249     let f = decl_rust_fn(ccx, fn_ty, name);
 250
 251     let attrs = csearch::get_item_attrs(&ccx.sess().cstore, did);
 252     set_llvm_fn_attrs(ccx, &attrs[], f);
 253
 254     ccx.externs().borrow_mut().insert(name.to_string(), f);
 255     f
 256 }
 257
 258 pub fn self_type_for_unboxed_closure<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
 259                                                closure_id: ast::DefId,
 260                                                fn_ty: Ty<'tcx>)
 261                                                -> Ty<'tcx>
 262 {
 263     let unboxed_closure_kind = ccx.tcx().unboxed_closure_kind(closure_id);
 264     match unboxed_closure_kind {
 265         ty::FnUnboxedClosureKind => {
 266             ty::mk_imm_rptr(ccx.tcx(), ccx.tcx().mk_region(ty::ReStatic), fn_ty)
 267         }
 268         ty::FnMutUnboxedClosureKind => {
 269             ty::mk_mut_rptr(ccx.tcx(), ccx.tcx().mk_region(ty::ReStatic), fn_ty)
 270         }
 271         ty::FnOnceUnboxedClosureKind => fn_ty
 272     }
 273 }
 274
 275 pub fn kind_for_unboxed_closure(ccx: &CrateContext, closure_id: ast::DefId)
 276                                 -> ty::UnboxedClosureKind {
 277     let unboxed_closures = ccx.tcx().unboxed_closures.borrow();
 278     (*unboxed_closures)[closure_id].kind
 279 }
 280
 281 pub fn decl_rust_fn<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
 282                               fn_ty: Ty<'tcx>, name: &str) -> ValueRef {
 283     debug!("decl_rust_fn(fn_ty={}, name={:?})",
 284            fn_ty.repr(ccx.tcx()),
 285            name);
 286
 287     let fn_ty = monomorphize::normalize_associated_type(ccx.tcx(), &fn_ty);
 288
 289     debug!("decl_rust_fn: fn_ty={} (after normalized associated types)",
 290            fn_ty.repr(ccx.tcx()));
 291
 292     let function_type; // placeholder so that the memory ownership works out ok
 293
 294     let (sig, abi, env) = match fn_ty.sty {
 295         ty::ty_bare_fn(_, ref f) => {
 296             (&f.sig, f.abi, None)
 297         }
 298         ty::ty_unboxed_closure(closure_did, _, substs) => {
 299             let typer = common::NormalizingUnboxedClosureTyper::new(ccx.tcx());
 300             function_type = typer.unboxed_closure_type(closure_did, substs);
 301             let self_type = self_type_for_unboxed_closure(ccx, closure_did, fn_ty);
 302             let llenvironment_type = type_of_explicit_arg(ccx, self_type);
 303             debug!("decl_rust_fn: function_type={} self_type={}",
 304                    function_type.repr(ccx.tcx()),
 305                    self_type.repr(ccx.tcx()));
 306             (&function_type.sig, RustCall, Some(llenvironment_type))
 307         }
 308         _ => panic!("expected closure or fn")
 309     };
 310
 311     let sig = ty::erase_late_bound_regions(ccx.tcx(), sig);
 312     let sig = ty::Binder(sig);
 313
 314     debug!("decl_rust_fn: sig={} (after erasing regions)",
 315            sig.repr(ccx.tcx()));
 316
 317     let llfty = type_of_rust_fn(ccx, env, &sig, abi);
 318
 319     debug!("decl_rust_fn: llfty={}",
 320            ccx.tn().type_to_string(llfty));
 321
 322     let llfn = decl_fn(ccx, name, llvm::CCallConv, llfty, sig.0.output /* (1) */);
 323     let attrs = get_fn_llvm_attributes(ccx, fn_ty);
 324     attrs.apply_llfn(llfn);
 325
 326     // (1) it's ok to directly access sig.0.output because we erased all late-bound-regions above
 327
 328     llfn
 329 }
 330
 331 pub fn decl_internal_rust_fn<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
 332                                        fn_ty: Ty<'tcx>, name: &str) -> ValueRef {
 333     let llfn = decl_rust_fn(ccx, fn_ty, name);
 334     llvm::SetLinkage(llfn, llvm::InternalLinkage);
 335     llfn
 336 }
 337
 338 pub fn get_extern_const<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>, did: ast::DefId,
 339                                   t: Ty<'tcx>) -> ValueRef {
 340     let name = csearch::get_symbol(&ccx.sess().cstore, did);
 341     let ty = type_of(ccx, t);
 342     match ccx.externs().borrow_mut().get(&name) {
 343         Some(n) => return *n,
 344         None => ()
 345     }
 346     unsafe {
 347         let buf = CString::from_slice(name.as_bytes());
 348         let c = llvm::LLVMAddGlobal(ccx.llmod(), ty.to_ref(), buf.as_ptr());
 349         // Thread-local statics in some other crate need to *always* be linked
 350         // against in a thread-local fashion, so we need to be sure to apply the
 351         // thread-local attribute locally if it was present remotely. If we
 352         // don't do this then linker errors can be generated where the linker
 353         // complains that one object files has a thread local version of the
 354         // symbol and another one doesn't.
 355         for attr in ty::get_attrs(ccx.tcx(), did).iter() {
 356             if attr.check_name("thread_local") {
 357                 llvm::set_thread_local(c, true);
 358             }
 359         }
 360         ccx.externs().borrow_mut().insert(name.to_string(), c);
 361         return c;
 362     }
 363 }
 364
 365 fn require_alloc_fn<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
 366                                 info_ty: Ty<'tcx>, it: LangItem) -> ast::DefId {
 367     match bcx.tcx().lang_items.require(it) {
 368         Ok(id) => id,
 369         Err(s) => {
 370             bcx.sess().fatal(&format!("allocation of `{}` {}",
 371                                      bcx.ty_to_string(info_ty),
 372                                      s)[]);
 373         }
 374     }
 375 }
 376
 377 // The following malloc_raw_dyn* functions allocate a box to contain
 378 // a given type, but with a potentially dynamic size.
 379
 380 pub fn malloc_raw_dyn<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
 381                                   llty_ptr: Type,
 382                                   info_ty: Ty<'tcx>,
 383                                   size: ValueRef,
 384                                   align: ValueRef)
 385                                   -> Result<'blk, 'tcx> {
 386     let _icx = push_ctxt("malloc_raw_exchange");
 387
 388     // Allocate space:
 389     let r = callee::trans_lang_call(bcx,
 390         require_alloc_fn(bcx, info_ty, ExchangeMallocFnLangItem),
 391         &[size, align],
 392         None);
 393
 394     Result::new(r.bcx, PointerCast(r.bcx, r.val, llty_ptr))
 395 }
 396
 397 // Type descriptor and type glue stuff
 398
 399 pub fn get_tydesc<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
 400                             t: Ty<'tcx>) -> Rc<tydesc_info<'tcx>> {
 401     match ccx.tydescs().borrow().get(&t) {
 402         Some(inf) => return inf.clone(),
 403         _ => { }
 404     }
 405
 406     ccx.stats().n_static_tydescs.set(ccx.stats().n_static_tydescs.get() + 1u);
 407     let inf = Rc::new(glue::declare_tydesc(ccx, t));
 408
 409     ccx.tydescs().borrow_mut().insert(t, inf.clone());
 410     inf
 411 }
 412
 413 #[allow(dead_code)] // useful
 414 pub fn set_optimize_for_size(f: ValueRef) {
 415     llvm::SetFunctionAttribute(f, llvm::OptimizeForSizeAttribute)
 416 }
 417
 418 pub fn set_no_inline(f: ValueRef) {
 419     llvm::SetFunctionAttribute(f, llvm::NoInlineAttribute)
 420 }
 421
 422 #[allow(dead_code)] // useful
 423 pub fn set_no_unwind(f: ValueRef) {
 424     llvm::SetFunctionAttribute(f, llvm::NoUnwindAttribute)
 425 }
 426
 427 // Tell LLVM to emit the information necessary to unwind the stack for the
 428 // function f.
 429 pub fn set_uwtable(f: ValueRef) {
 430     llvm::SetFunctionAttribute(f, llvm::UWTableAttribute)
 431 }
 432
 433 pub fn set_inline_hint(f: ValueRef) {
 434     llvm::SetFunctionAttribute(f, llvm::InlineHintAttribute)
 435 }
 436
 437 pub fn set_llvm_fn_attrs(ccx: &CrateContext, attrs: &[ast::Attribute], llfn: ValueRef) {
 438     use syntax::attr::*;
 439     // Set the inline hint if there is one
 440     match find_inline_attr(attrs) {
 441         InlineHint   => set_inline_hint(llfn),
 442         InlineAlways => set_always_inline(llfn),
 443         InlineNever  => set_no_inline(llfn),
 444         InlineNone   => { /* fallthrough */ }
 445     }
 446
 447     for attr in attrs.iter() {
 448         let mut used = true;
 449         match attr.name().get() {
 450             "no_stack_check" => unset_split_stack(llfn),
 451             "no_split_stack" => {
 452                 unset_split_stack(llfn);
 453                 ccx.sess().span_warn(attr.span,
 454                                      "no_split_stack is a deprecated synonym for no_stack_check");
 455             }
 456             "cold" => unsafe {
 457                 llvm::LLVMAddFunctionAttribute(llfn,
 458                                                llvm::FunctionIndex as c_uint,
 459                                                llvm::ColdAttribute as uint64_t)
 460             },
 461             _ => used = false,
 462         }
 463         if used {
 464             attr::mark_used(attr);
 465         }
 466     }
 467 }
 468
 469 pub fn set_always_inline(f: ValueRef) {
 470     llvm::SetFunctionAttribute(f, llvm::AlwaysInlineAttribute)
 471 }
 472
 473 pub fn set_split_stack(f: ValueRef) {
 474     unsafe {
 475         llvm::LLVMAddFunctionAttrString(f, llvm::FunctionIndex as c_uint,
 476                                         "split-stack\0".as_ptr() as *const _);
 477     }
 478 }
 479
 480 pub fn unset_split_stack(f: ValueRef) {
 481     unsafe {
 482         llvm::LLVMRemoveFunctionAttrString(f, llvm::FunctionIndex as c_uint,
 483                                            "split-stack\0".as_ptr() as *const _);
 484     }
 485 }
 486
 487 // Double-check that we never ask LLVM to declare the same symbol twice. It
 488 // silently mangles such symbols, breaking our linkage model.
 489 pub fn note_unique_llvm_symbol(ccx: &CrateContext, sym: String) {
 490     if ccx.all_llvm_symbols().borrow().contains(&sym) {
 491         ccx.sess().bug(&format!("duplicate LLVM symbol: {}", sym)[]);
 492     }
 493     ccx.all_llvm_symbols().borrow_mut().insert(sym);
 494 }
 495
 496
 497 pub fn get_res_dtor<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
 498                               did: ast::DefId,
 499                               t: Ty<'tcx>,
 500                               parent_id: ast::DefId,
 501                               substs: &subst::Substs<'tcx>)
 502                               -> ValueRef {
 503     let _icx = push_ctxt("trans_res_dtor");
 504     let did = inline::maybe_instantiate_inline(ccx, did);
 505
 506     if !substs.types.is_empty() {
 507         assert_eq!(did.krate, ast::LOCAL_CRATE);
 508
 509         // Since we're in trans we don't care for any region parameters
 510         let substs = subst::Substs::erased(substs.types.clone());
 511
 512         let (val, _, _) = monomorphize::monomorphic_fn(ccx, did, &substs, None);
 513
 514         val
 515     } else if did.krate == ast::LOCAL_CRATE {
 516         get_item_val(ccx, did.node)
 517     } else {
 518         let tcx = ccx.tcx();
 519         let name = csearch::get_symbol(&ccx.sess().cstore, did);
 520         let class_ty = ty::lookup_item_type(tcx, parent_id).ty.subst(tcx, substs);
 521         let llty = type_of_dtor(ccx, class_ty);
 522         let dtor_ty = ty::mk_ctor_fn(ccx.tcx(),
 523                                      did,
 524                                      &[glue::get_drop_glue_type(ccx, t)],
 525                                      ty::mk_nil(ccx.tcx()));
 526         get_extern_fn(ccx,
 527                       &mut *ccx.externs().borrow_mut(),
 528                       &name[],
 529                       llvm::CCallConv,
 530                       llty,
 531                       dtor_ty)
 532     }
 533 }
 534
 535 // Used only for creating scalar comparison glue.
 536 #[derive(Copy)]
 537 pub enum scalar_type { nil_type, signed_int, unsigned_int, floating_point, }
 538
 539 pub fn compare_scalar_types<'blk, 'tcx>(cx: Block<'blk, 'tcx>,
 540                                         lhs: ValueRef,
 541                                         rhs: ValueRef,
 542                                         t: Ty<'tcx>,
 543                                         op: ast::BinOp)
 544                                         -> Result<'blk, 'tcx> {
 545     let f = |&: a| Result::new(cx, compare_scalar_values(cx, lhs, rhs, a, op));
 546
 547     match t.sty {
 548         ty::ty_tup(ref tys) if tys.is_empty() => f(nil_type),
 549         ty::ty_bool | ty::ty_uint(_) | ty::ty_char => f(unsigned_int),
 550         ty::ty_ptr(mt) if common::type_is_sized(cx.tcx(), mt.ty) => f(unsigned_int),
 551         ty::ty_int(_) => f(signed_int),
 552         ty::ty_float(_) => f(floating_point),
 553             // Should never get here, because t is scalar.
 554         _ => cx.sess().bug("non-scalar type passed to compare_scalar_types")
 555     }
 556 }
 557
 558
 559 // A helper function to do the actual comparison of scalar values.
 560 pub fn compare_scalar_values<'blk, 'tcx>(cx: Block<'blk, 'tcx>,
 561                                          lhs: ValueRef,
 562                                          rhs: ValueRef,
 563                                          nt: scalar_type,
 564                                          op: ast::BinOp)
 565                                          -> ValueRef {
 566     let _icx = push_ctxt("compare_scalar_values");
 567     fn die(cx: Block) -> ! {
 568         cx.sess().bug("compare_scalar_values: must be a comparison operator");
 569     }
 570     match nt {
 571       nil_type => {
 572         // We don't need to do actual comparisons for nil.
 573         // () == () holds but () < () does not.
 574         match op {
 575           ast::BiEq | ast::BiLe | ast::BiGe => return C_bool(cx.ccx(), true),
 576           ast::BiNe | ast::BiLt | ast::BiGt => return C_bool(cx.ccx(), false),
 577           // refinements would be nice
 578           _ => die(cx)
 579         }
 580       }
 581       floating_point => {
 582         let cmp = match op {
 583           ast::BiEq => llvm::RealOEQ,
 584           ast::BiNe => llvm::RealUNE,
 585           ast::BiLt => llvm::RealOLT,
 586           ast::BiLe => llvm::RealOLE,
 587           ast::BiGt => llvm::RealOGT,
 588           ast::BiGe => llvm::RealOGE,
 589           _ => die(cx)
 590         };
 591         return FCmp(cx, cmp, lhs, rhs);
 592       }
 593       signed_int => {
 594         let cmp = match op {
 595           ast::BiEq => llvm::IntEQ,
 596           ast::BiNe => llvm::IntNE,
 597           ast::BiLt => llvm::IntSLT,
 598           ast::BiLe => llvm::IntSLE,
 599           ast::BiGt => llvm::IntSGT,
 600           ast::BiGe => llvm::IntSGE,
 601           _ => die(cx)
 602         };
 603         return ICmp(cx, cmp, lhs, rhs);
 604       }
 605       unsigned_int => {
 606         let cmp = match op {
 607           ast::BiEq => llvm::IntEQ,
 608           ast::BiNe => llvm::IntNE,
 609           ast::BiLt => llvm::IntULT,
 610           ast::BiLe => llvm::IntULE,
 611           ast::BiGt => llvm::IntUGT,
 612           ast::BiGe => llvm::IntUGE,
 613           _ => die(cx)
 614         };
 615         return ICmp(cx, cmp, lhs, rhs);
 616       }
 617     }
 618 }
 619
 620 pub fn compare_simd_types<'blk, 'tcx>(
 621                     cx: Block<'blk, 'tcx>,
 622                     lhs: ValueRef,
 623                     rhs: ValueRef,
 624                     t: Ty<'tcx>,
 625                     size: uint,
 626                     op: ast::BinOp)
 627                     -> ValueRef {
 628     match t.sty {
 629         ty::ty_float(_) => {
 630             // The comparison operators for floating point vectors are challenging.
 631             // LLVM outputs a `< size x i1 >`, but if we perform a sign extension
 632             // then bitcast to a floating point vector, the result will be `-NaN`
 633             // for each truth value. Because of this they are unsupported.
 634             cx.sess().bug("compare_simd_types: comparison operators \
 635                            not supported for floating point SIMD types")
 636         },
 637         ty::ty_uint(_) | ty::ty_int(_) => {
 638             let cmp = match op {
 639                 ast::BiEq => llvm::IntEQ,
 640                 ast::BiNe => llvm::IntNE,
 641                 ast::BiLt => llvm::IntSLT,
 642                 ast::BiLe => llvm::IntSLE,
 643                 ast::BiGt => llvm::IntSGT,
 644                 ast::BiGe => llvm::IntSGE,
 645                 _ => cx.sess().bug("compare_simd_types: must be a comparison operator"),
 646             };
 647             let return_ty = Type::vector(&type_of(cx.ccx(), t), size as u64);
 648             // LLVM outputs an `< size x i1 >`, so we need to perform a sign extension
 649             // to get the correctly sized type. This will compile to a single instruction
 650             // once the IR is converted to assembly if the SIMD instruction is supported
 651             // by the target architecture.
 652             SExt(cx, ICmp(cx, cmp, lhs, rhs), return_ty)
 653         },
 654         _ => cx.sess().bug("compare_simd_types: invalid SIMD type"),
 655     }
 656 }
 657
 658 // Iterates through the elements of a structural type.
 659 pub fn iter_structural_ty<'blk, 'tcx, F>(cx: Block<'blk, 'tcx>,
 660                                          av: ValueRef,
 661                                          t: Ty<'tcx>,
 662                                          mut f: F)
 663                                          -> Block<'blk, 'tcx> where
 664     F: FnMut(Block<'blk, 'tcx>, ValueRef, Ty<'tcx>) -> Block<'blk, 'tcx>,
 665 {
 666     let _icx = push_ctxt("iter_structural_ty");
 667
 668     fn iter_variant<'blk, 'tcx, F>(cx: Block<'blk, 'tcx>,
 669                                    repr: &adt::Repr<'tcx>,
 670                                    av: ValueRef,
 671                                    variant: &ty::VariantInfo<'tcx>,
 672                                    substs: &subst::Substs<'tcx>,
 673                                    f: &mut F)
 674                                    -> Block<'blk, 'tcx> where
 675         F: FnMut(Block<'blk, 'tcx>, ValueRef, Ty<'tcx>) -> Block<'blk, 'tcx>,
 676     {
 677         let _icx = push_ctxt("iter_variant");
 678         let tcx = cx.tcx();
 679         let mut cx = cx;
 680
 681         for (i, &arg) in variant.args.iter().enumerate() {
 682             let arg = monomorphize::apply_param_substs(tcx, substs, &arg);
 683             cx = f(cx, adt::trans_field_ptr(cx, repr, av, variant.disr_val, i), arg);
 684         }
 685         return cx;
 686     }
 687
 688     let (data_ptr, info) = if common::type_is_sized(cx.tcx(), t) {
 689         (av, None)
 690     } else {
 691         let data = GEPi(cx, av, &[0, abi::FAT_PTR_ADDR]);
 692         let info = GEPi(cx, av, &[0, abi::FAT_PTR_EXTRA]);
 693         (Load(cx, data), Some(Load(cx, info)))
 694     };
 695
 696     let mut cx = cx;
 697     match t.sty {
 698       ty::ty_struct(..) => {
 699           let repr = adt::represent_type(cx.ccx(), t);
 700           expr::with_field_tys(cx.tcx(), t, None, |discr, field_tys| {
 701               for (i, field_ty) in field_tys.iter().enumerate() {
 702                   let field_ty = field_ty.mt.ty;
 703                   let llfld_a = adt::trans_field_ptr(cx, &*repr, data_ptr, discr, i);
 704
 705                   let val = if common::type_is_sized(cx.tcx(), field_ty) {
 706                       llfld_a
 707                   } else {
 708                       let boxed_ty = ty::mk_open(cx.tcx(), field_ty);
 709                       let scratch = datum::rvalue_scratch_datum(cx, boxed_ty, "__fat_ptr_iter");
 710                       Store(cx, llfld_a, GEPi(cx, scratch.val, &[0, abi::FAT_PTR_ADDR]));
 711                       Store(cx, info.unwrap(), GEPi(cx, scratch.val, &[0, abi::FAT_PTR_EXTRA]));
 712                       scratch.val
 713                   };
 714                   cx = f(cx, val, field_ty);
 715               }
 716           })
 717       }
 718       ty::ty_unboxed_closure(def_id, _, substs) => {
 719           let repr = adt::represent_type(cx.ccx(), t);
 720           let typer = common::NormalizingUnboxedClosureTyper::new(cx.tcx());
 721           let upvars = typer.unboxed_closure_upvars(def_id, substs).unwrap();
 722           for (i, upvar) in upvars.iter().enumerate() {
 723               let llupvar = adt::trans_field_ptr(cx, &*repr, data_ptr, 0, i);
 724               cx = f(cx, llupvar, upvar.ty);
 725           }
 726       }
 727       ty::ty_vec(_, Some(n)) => {
 728         let (base, len) = tvec::get_fixed_base_and_len(cx, data_ptr, n);
 729         let unit_ty = ty::sequence_element_type(cx.tcx(), t);
 730         cx = tvec::iter_vec_raw(cx, base, unit_ty, len, f);
 731       }
 732       ty::ty_tup(ref args) => {
 733           let repr = adt::represent_type(cx.ccx(), t);
 734           for (i, arg) in args.iter().enumerate() {
 735               let llfld_a = adt::trans_field_ptr(cx, &*repr, data_ptr, 0, i);
 736               cx = f(cx, llfld_a, *arg);
 737           }
 738       }
 739       ty::ty_enum(tid, substs) => {
 740           let fcx = cx.fcx;
 741           let ccx = fcx.ccx;
 742
 743           let repr = adt::represent_type(ccx, t);
 744           let variants = ty::enum_variants(ccx.tcx(), tid);
 745           let n_variants = (*variants).len();
 746
 747           // NB: we must hit the discriminant first so that structural
 748           // comparison know not to proceed when the discriminants differ.
 749
 750           match adt::trans_switch(cx, &*repr, av) {
 751               (_match::Single, None) => {
 752                   cx = iter_variant(cx, &*repr, av, &*(*variants)[0],
 753                                     substs, &mut f);
 754               }
 755               (_match::Switch, Some(lldiscrim_a)) => {
 756                   cx = f(cx, lldiscrim_a, cx.tcx().types.int);
 757                   let unr_cx = fcx.new_temp_block("enum-iter-unr");
 758                   Unreachable(unr_cx);
 759                   let llswitch = Switch(cx, lldiscrim_a, unr_cx.llbb,
 760                                         n_variants);
 761                   let next_cx = fcx.new_temp_block("enum-iter-next");
 762
 763                   for variant in (*variants).iter() {
 764                       let variant_cx =
 765                           fcx.new_temp_block(
 766                               &format!("enum-iter-variant-{}",
 767                                       &variant.disr_val.to_string()[])
 768                               []);
 769                       match adt::trans_case(cx, &*repr, variant.disr_val) {
 770                           _match::SingleResult(r) => {
 771                               AddCase(llswitch, r.val, variant_cx.llbb)
 772                           }
 773                           _ => ccx.sess().unimpl("value from adt::trans_case \
 774                                                   in iter_structural_ty")
 775                       }
 776                       let variant_cx =
 777                           iter_variant(variant_cx,
 778                                        &*repr,
 779                                        data_ptr,
 780                                        &**variant,
 781                                        substs,
 782                                        &mut f);
 783                       Br(variant_cx, next_cx.llbb);
 784                   }
 785                   cx = next_cx;
 786               }
 787               _ => ccx.sess().unimpl("value from adt::trans_switch \
 788                                       in iter_structural_ty")
 789           }
 790       }
 791       _ => {
 792           cx.sess().unimpl(&format!("type in iter_structural_ty: {}",
 793                                    ty_to_string(cx.tcx(), t))[])
 794       }
 795     }
 796     return cx;
 797 }
 798
 799 pub fn cast_shift_expr_rhs(cx: Block,
 800                            op: ast::BinOp,
 801                            lhs: ValueRef,
 802                            rhs: ValueRef)
 803                            -> ValueRef {
 804     cast_shift_rhs(op, lhs, rhs,
 805                    |a,b| Trunc(cx, a, b),
 806                    |a,b| ZExt(cx, a, b))
 807 }
 808
 809 pub fn cast_shift_const_rhs(op: ast::BinOp,
 810                             lhs: ValueRef, rhs: ValueRef) -> ValueRef {
 811     cast_shift_rhs(op, lhs, rhs,
 812                    |a, b| unsafe { llvm::LLVMConstTrunc(a, b.to_ref()) },
 813                    |a, b| unsafe { llvm::LLVMConstZExt(a, b.to_ref()) })
 814 }
 815
 816 pub fn cast_shift_rhs<F, G>(op: ast::BinOp,
 817                             lhs: ValueRef,
 818                             rhs: ValueRef,
 819                             trunc: F,
 820                             zext: G)
 821                             -> ValueRef where
 822     F: FnOnce(ValueRef, Type) -> ValueRef,
 823     G: FnOnce(ValueRef, Type) -> ValueRef,
 824 {
 825     // Shifts may have any size int on the rhs
 826     if ast_util::is_shift_binop(op) {
 827         let mut rhs_llty = val_ty(rhs);
 828         let mut lhs_llty = val_ty(lhs);
 829         if rhs_llty.kind() == Vector { rhs_llty = rhs_llty.element_type() }
 830         if lhs_llty.kind() == Vector { lhs_llty = lhs_llty.element_type() }
 831         let rhs_sz = rhs_llty.int_width();
 832         let lhs_sz = lhs_llty.int_width();
 833         if lhs_sz < rhs_sz {
 834             trunc(rhs, lhs_llty)
 835         } else if lhs_sz > rhs_sz {
 836             // FIXME (#1877: If shifting by negative
 837             // values becomes not undefined then this is wrong.
 838             zext(rhs, lhs_llty)
 839         } else {
 840             rhs
 841         }
 842     } else {
 843         rhs
 844     }
 845 }
 846
 847 pub fn fail_if_zero_or_overflows<'blk, 'tcx>(
 848                                 cx: Block<'blk, 'tcx>,
 849                                 span: Span,
 850                                 divrem: ast::BinOp,
 851                                 lhs: ValueRef,
 852                                 rhs: ValueRef,
 853                                 rhs_t: Ty<'tcx>)
 854                                 -> Block<'blk, 'tcx> {
 855     let (zero_text, overflow_text) = if divrem == ast::BiDiv {
 856         ("attempted to divide by zero",
 857          "attempted to divide with overflow")
 858     } else {
 859         ("attempted remainder with a divisor of zero",
 860          "attempted remainder with overflow")
 861     };
 862     let (is_zero, is_signed) = match rhs_t.sty {
 863         ty::ty_int(t) => {
 864             let zero = C_integral(Type::int_from_ty(cx.ccx(), t), 0u64, false);
 865             (ICmp(cx, llvm::IntEQ, rhs, zero), true)
 866         }
 867         ty::ty_uint(t) => {
 868             let zero = C_integral(Type::uint_from_ty(cx.ccx(), t), 0u64, false);
 869             (ICmp(cx, llvm::IntEQ, rhs, zero), false)
 870         }
 871         _ => {
 872             cx.sess().bug(&format!("fail-if-zero on unexpected type: {}",
 873                                   ty_to_string(cx.tcx(), rhs_t))[]);
 874         }
 875     };
 876     let bcx = with_cond(cx, is_zero, |bcx| {
 877         controlflow::trans_fail(bcx, span, InternedString::new(zero_text))
 878     });
 879
 880     // To quote LLVM's documentation for the sdiv instruction:
 881     //
 882     //      Division by zero leads to undefined behavior. Overflow also leads
 883     //      to undefined behavior; this is a rare case, but can occur, for
 884     //      example, by doing a 32-bit division of -2147483648 by -1.
 885     //
 886     // In order to avoid undefined behavior, we perform runtime checks for
 887     // signed division/remainder which would trigger overflow. For unsigned
 888     // integers, no action beyond checking for zero need be taken.
 889     if is_signed {
 890         let (llty, min) = match rhs_t.sty {
 891             ty::ty_int(t) => {
 892                 let llty = Type::int_from_ty(cx.ccx(), t);
 893                 let min = match t {
 894                     ast::TyIs(_) if llty == Type::i32(cx.ccx()) => i32::MIN as u64,
 895                     ast::TyIs(_) => i64::MIN as u64,
 896                     ast::TyI8 => i8::MIN as u64,
 897                     ast::TyI16 => i16::MIN as u64,
 898                     ast::TyI32 => i32::MIN as u64,
 899                     ast::TyI64 => i64::MIN as u64,
 900                 };
 901                 (llty, min)
 902             }
 903             _ => unreachable!(),
 904         };
 905         let minus_one = ICmp(bcx, llvm::IntEQ, rhs,
 906                              C_integral(llty, -1, false));
 907         with_cond(bcx, minus_one, |bcx| {
 908             let is_min = ICmp(bcx, llvm::IntEQ, lhs,
 909                               C_integral(llty, min, true));
 910             with_cond(bcx, is_min, |bcx| {
 911                 controlflow::trans_fail(bcx, span,
 912                                         InternedString::new(overflow_text))
 913             })
 914         })
 915     } else {
 916         bcx
 917     }
 918 }
 919
 920 pub fn trans_external_path<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
 921                                      did: ast::DefId, t: Ty<'tcx>) -> ValueRef {
 922     let name = csearch::get_symbol(&ccx.sess().cstore, did);
 923     match t.sty {
 924         ty::ty_bare_fn(_, ref fn_ty) => {
 925             match ccx.sess().target.target.adjust_abi(fn_ty.abi) {
 926                 Rust | RustCall => {
 927                     get_extern_rust_fn(ccx, t, &name[], did)
 928                 }
 929                 RustIntrinsic => {
 930                     ccx.sess().bug("unexpected intrinsic in trans_external_path")
 931                 }
 932                 _ => {
 933                     foreign::register_foreign_item_fn(ccx, fn_ty.abi, t,
 934                                                       &name[])
 935                 }
 936             }
 937         }
 938         _ => {
 939             get_extern_const(ccx, did, t)
 940         }
 941     }
 942 }
 943
 944 pub fn invoke<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
 945                           llfn: ValueRef,
 946                           llargs: &[ValueRef],
 947                           fn_ty: Ty<'tcx>,
 948                           call_info: Option<NodeInfo>)
 949                           -> (ValueRef, Block<'blk, 'tcx>) {
 950     let _icx = push_ctxt("invoke_");
 951     if bcx.unreachable.get() {
 952         return (C_null(Type::i8(bcx.ccx())), bcx);
 953     }
 954
 955     let attributes = get_fn_llvm_attributes(bcx.ccx(), fn_ty);
 956
 957     match bcx.opt_node_id {
 958         None => {
 959             debug!("invoke at ???");
 960         }
 961         Some(id) => {
 962             debug!("invoke at {}", bcx.tcx().map.node_to_string(id));
 963         }
 964     }
 965
 966     if need_invoke(bcx) {
 967         debug!("invoking {} at {:?}", bcx.val_to_string(llfn), bcx.llbb);
 968         for &llarg in llargs.iter() {
 969             debug!("arg: {}", bcx.val_to_string(llarg));
 970         }
 971         let normal_bcx = bcx.fcx.new_temp_block("normal-return");
 972         let landing_pad = bcx.fcx.get_landing_pad();
 973
 974         match call_info {
 975             Some(info) => debuginfo::set_source_location(bcx.fcx, info.id, info.span),
 976             None => debuginfo::clear_source_location(bcx.fcx)
 977         };
 978
 979         let llresult = Invoke(bcx,
 980                               llfn,
 981                               &llargs[],
 982                               normal_bcx.llbb,
 983                               landing_pad,
 984                               Some(attributes));
 985         return (llresult, normal_bcx);
 986     } else {
 987         debug!("calling {} at {:?}", bcx.val_to_string(llfn), bcx.llbb);
 988         for &llarg in llargs.iter() {
 989             debug!("arg: {}", bcx.val_to_string(llarg));
 990         }
 991
 992         match call_info {
 993             Some(info) => debuginfo::set_source_location(bcx.fcx, info.id, info.span),
 994             None => debuginfo::clear_source_location(bcx.fcx)
 995         };
 996
 997         let llresult = Call(bcx, llfn, &llargs[], Some(attributes));
 998         return (llresult, bcx);
 999     }
1000 }
1001
1002 pub fn need_invoke(bcx: Block) -> bool {
1003     if bcx.sess().no_landing_pads() {
1004         return false;
1005     }
1006
1007     // Avoid using invoke if we are already inside a landing pad.
1008     if bcx.is_lpad {
1009         return false;
1010     }
1011
1012     bcx.fcx.needs_invoke()
1013 }
1014
1015 pub fn load_if_immediate<'blk, 'tcx>(cx: Block<'blk, 'tcx>,
1016                                      v: ValueRef, t: Ty<'tcx>) -> ValueRef {
1017     let _icx = push_ctxt("load_if_immediate");
1018     if type_is_immediate(cx.ccx(), t) { return load_ty(cx, v, t); }
1019     return v;
1020 }
1021
1022 /// Helper for loading values from memory. Does the necessary conversion if the in-memory type
1023 /// differs from the type used for SSA values. Also handles various special cases where the type
1024 /// gives us better information about what we are loading.
1025 pub fn load_ty<'blk, 'tcx>(cx: Block<'blk, 'tcx>,
1026                            ptr: ValueRef, t: Ty<'tcx>) -> ValueRef {
1027     if type_is_zero_size(cx.ccx(), t) {
1028         C_undef(type_of::type_of(cx.ccx(), t))
1029     } else if ty::type_is_bool(t) {
1030         Trunc(cx, LoadRangeAssert(cx, ptr, 0, 2, llvm::False), Type::i1(cx.ccx()))
1031     } else if type_is_immediate(cx.ccx(), t) && type_of::type_of(cx.ccx(), t).is_aggregate() {
1032         // We want to pass small aggregates as immediate values, but using an aggregate LLVM type
1033         // for this leads to bad optimizations, so its arg type is an appropriately sized integer
1034         // and we have to convert it
1035         Load(cx, BitCast(cx, ptr, type_of::arg_type_of(cx.ccx(), t).ptr_to()))
1036     } else if ty::type_is_char(t) {
1037         // a char is a Unicode codepoint, and so takes values from 0
1038         // to 0x10FFFF inclusive only.
1039         LoadRangeAssert(cx, ptr, 0, 0x10FFFF + 1, llvm::False)
1040     } else {
1041         Load(cx, ptr)
1042     }
1043 }
1044
1045 /// Helper for storing values in memory. Does the necessary conversion if the in-memory type
1046 /// differs from the type used for SSA values.
1047 pub fn store_ty<'blk, 'tcx>(cx: Block<'blk, 'tcx>, v: ValueRef, dst: ValueRef, t: Ty<'tcx>) {
1048     if ty::type_is_bool(t) {
1049         Store(cx, ZExt(cx, v, Type::i8(cx.ccx())), dst);
1050     } else if type_is_immediate(cx.ccx(), t) && type_of::type_of(cx.ccx(), t).is_aggregate() {
1051         // We want to pass small aggregates as immediate values, but using an aggregate LLVM type
1052         // for this leads to bad optimizations, so its arg type is an appropriately sized integer
1053         // and we have to convert it
1054         Store(cx, v, BitCast(cx, dst, type_of::arg_type_of(cx.ccx(), t).ptr_to()));
1055     } else {
1056         Store(cx, v, dst);
1057     };
1058 }
1059
1060 pub fn init_local<'blk, 'tcx>(bcx: Block<'blk, 'tcx>, local: &ast::Local)
1061                               -> Block<'blk, 'tcx> {
1062     debug!("init_local(bcx={}, local.id={})", bcx.to_str(), local.id);
1063     let _indenter = indenter();
1064     let _icx = push_ctxt("init_local");
1065     _match::store_local(bcx, local)
1066 }
1067
1068 pub fn raw_block<'blk, 'tcx>(fcx: &'blk FunctionContext<'blk, 'tcx>,
1069                              is_lpad: bool,
1070                              llbb: BasicBlockRef)
1071                              -> Block<'blk, 'tcx> {
1072     common::BlockS::new(llbb, is_lpad, None, fcx)
1073 }
1074
1075 pub fn with_cond<'blk, 'tcx, F>(bcx: Block<'blk, 'tcx>,
1076                                 val: ValueRef,
1077                                 f: F)
1078                                 -> Block<'blk, 'tcx> where
1079     F: FnOnce(Block<'blk, 'tcx>) -> Block<'blk, 'tcx>,
1080 {
1081     let _icx = push_ctxt("with_cond");
1082     let fcx = bcx.fcx;
1083     let next_cx = fcx.new_temp_block("next");
1084     let cond_cx = fcx.new_temp_block("cond");
1085     CondBr(bcx, val, cond_cx.llbb, next_cx.llbb);
1086     let after_cx = f(cond_cx);
1087     if !after_cx.terminated.get() {
1088         Br(after_cx, next_cx.llbb);
1089     }
1090     next_cx
1091 }
1092
1093 pub fn call_lifetime_start(cx: Block, ptr: ValueRef) {
1094     if cx.sess().opts.optimize == config::No {
1095         return;
1096     }
1097
1098     let _icx = push_ctxt("lifetime_start");
1099     let ccx = cx.ccx();
1100
1101     let llsize = C_u64(ccx, machine::llsize_of_alloc(ccx, val_ty(ptr).element_type()));
1102     let ptr = PointerCast(cx, ptr, Type::i8p(ccx));
1103     let lifetime_start = ccx.get_intrinsic(&"llvm.lifetime.start");
1104     Call(cx, lifetime_start, &[llsize, ptr], None);
1105 }
1106
1107 pub fn call_lifetime_end(cx: Block, ptr: ValueRef) {
1108     if cx.sess().opts.optimize == config::No {
1109         return;
1110     }
1111
1112     let _icx = push_ctxt("lifetime_end");
1113     let ccx = cx.ccx();
1114
1115     let llsize = C_u64(ccx, machine::llsize_of_alloc(ccx, val_ty(ptr).element_type()));
1116     let ptr = PointerCast(cx, ptr, Type::i8p(ccx));
1117     let lifetime_end = ccx.get_intrinsic(&"llvm.lifetime.end");
1118     Call(cx, lifetime_end, &[llsize, ptr], None);
1119 }
1120
1121 pub fn call_memcpy(cx: Block, dst: ValueRef, src: ValueRef, n_bytes: ValueRef, align: u32) {
1122     let _icx = push_ctxt("call_memcpy");
1123     let ccx = cx.ccx();
1124     let key = match &ccx.sess().target.target.target_pointer_width[] {
1125         "32" => "llvm.memcpy.p0i8.p0i8.i32",
1126         "64" => "llvm.memcpy.p0i8.p0i8.i64",
1127         tws => panic!("Unsupported target word size for memcpy: {}", tws),
1128     };
1129     let memcpy = ccx.get_intrinsic(&key);
1130     let src_ptr = PointerCast(cx, src, Type::i8p(ccx));
1131     let dst_ptr = PointerCast(cx, dst, Type::i8p(ccx));
1132     let size = IntCast(cx, n_bytes, ccx.int_type());
1133     let align = C_i32(ccx, align as i32);
1134     let volatile = C_bool(ccx, false);
1135     Call(cx, memcpy, &[dst_ptr, src_ptr, size, align, volatile], None);
1136 }
1137
1138 pub fn memcpy_ty<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
1139                              dst: ValueRef, src: ValueRef,
1140                              t: Ty<'tcx>) {
1141     let _icx = push_ctxt("memcpy_ty");
1142     let ccx = bcx.ccx();
1143     if ty::type_is_structural(t) {
1144         let llty = type_of::type_of(ccx, t);
1145         let llsz = llsize_of(ccx, llty);
1146         let llalign = type_of::align_of(ccx, t);
1147         call_memcpy(bcx, dst, src, llsz, llalign as u32);
1148     } else {
1149         store_ty(bcx, Load(bcx, src), dst, t);
1150     }
1151 }
1152
1153 pub fn zero_mem<'blk, 'tcx>(cx: Block<'blk, 'tcx>, llptr: ValueRef, t: Ty<'tcx>) {
1154     if cx.unreachable.get() { return; }
1155     let _icx = push_ctxt("zero_mem");
1156     let bcx = cx;
1157     memzero(&B(bcx), llptr, t);
1158 }
1159
1160 // Always use this function instead of storing a zero constant to the memory
1161 // in question. If you store a zero constant, LLVM will drown in vreg
1162 // allocation for large data structures, and the generated code will be
1163 // awful. (A telltale sign of this is large quantities of
1164 // `mov [byte ptr foo],0` in the generated code.)
1165 fn memzero<'a, 'tcx>(b: &Builder<'a, 'tcx>, llptr: ValueRef, ty: Ty<'tcx>) {
1166     let _icx = push_ctxt("memzero");
1167     let ccx = b.ccx;
1168
1169     let llty = type_of::type_of(ccx, ty);
1170
1171     let intrinsic_key = match &ccx.sess().target.target.target_pointer_width[] {
1172         "32" => "llvm.memset.p0i8.i32",
1173         "64" => "llvm.memset.p0i8.i64",
1174         tws => panic!("Unsupported target word size for memset: {}", tws),
1175     };
1176
1177     let llintrinsicfn = ccx.get_intrinsic(&intrinsic_key);
1178     let llptr = b.pointercast(llptr, Type::i8(ccx).ptr_to());
1179     let llzeroval = C_u8(ccx, 0);
1180     let size = machine::llsize_of(ccx, llty);
1181     let align = C_i32(ccx, type_of::align_of(ccx, ty) as i32);
1182     let volatile = C_bool(ccx, false);
1183     b.call(llintrinsicfn, &[llptr, llzeroval, size, align, volatile], None);
1184 }
1185
1186 pub fn alloc_ty<'blk, 'tcx>(bcx: Block<'blk, 'tcx>, t: Ty<'tcx>, name: &str) -> ValueRef {
1187     let _icx = push_ctxt("alloc_ty");
1188     let ccx = bcx.ccx();
1189     let ty = type_of::type_of(ccx, t);
1190     assert!(!ty::type_has_params(t));
1191     let val = alloca(bcx, ty, name);
1192     return val;
1193 }
1194
1195 pub fn alloca(cx: Block, ty: Type, name: &str) -> ValueRef {
1196     let p = alloca_no_lifetime(cx, ty, name);
1197     call_lifetime_start(cx, p);
1198     p
1199 }
1200
1201 pub fn alloca_no_lifetime(cx: Block, ty: Type, name: &str) -> ValueRef {
1202     let _icx = push_ctxt("alloca");
1203     if cx.unreachable.get() {
1204         unsafe {
1205             return llvm::LLVMGetUndef(ty.ptr_to().to_ref());
1206         }
1207     }
1208     debuginfo::clear_source_location(cx.fcx);
1209     Alloca(cx, ty, name)
1210 }
1211
1212 pub fn alloca_zeroed<'blk, 'tcx>(cx: Block<'blk, 'tcx>, ty: Ty<'tcx>,
1213                                  name: &str) -> ValueRef {
1214     let llty = type_of::type_of(cx.ccx(), ty);
1215     if cx.unreachable.get() {
1216         unsafe {
1217             return llvm::LLVMGetUndef(llty.ptr_to().to_ref());
1218         }
1219     }
1220     let p = alloca_no_lifetime(cx, llty, name);
1221     let b = cx.fcx.ccx.builder();
1222     b.position_before(cx.fcx.alloca_insert_pt.get().unwrap());
1223     memzero(&b, p, ty);
1224     p
1225 }
1226
1227 pub fn arrayalloca(cx: Block, ty: Type, v: ValueRef) -> ValueRef {
1228     let _icx = push_ctxt("arrayalloca");
1229     if cx.unreachable.get() {
1230         unsafe {
1231             return llvm::LLVMGetUndef(ty.to_ref());
1232         }
1233     }
1234     debuginfo::clear_source_location(cx.fcx);
1235     let p = ArrayAlloca(cx, ty, v);
1236     call_lifetime_start(cx, p);
1237     p
1238 }
1239
1240 // Creates the alloca slot which holds the pointer to the slot for the final return value
1241 pub fn make_return_slot_pointer<'a, 'tcx>(fcx: &FunctionContext<'a, 'tcx>,
1242                                           output_type: Ty<'tcx>) -> ValueRef {
1243     let lloutputtype = type_of::type_of(fcx.ccx, output_type);
1244
1245     // We create an alloca to hold a pointer of type `output_type`
1246     // which will hold the pointer to the right alloca which has the
1247     // final ret value
1248     if fcx.needs_ret_allocas {
1249         // Let's create the stack slot
1250         let slot = AllocaFcx(fcx, lloutputtype.ptr_to(), "llretslotptr");
1251
1252         // and if we're using an out pointer, then store that in our newly made slot
1253         if type_of::return_uses_outptr(fcx.ccx, output_type) {
1254             let outptr = get_param(fcx.llfn, 0);
1255
1256             let b = fcx.ccx.builder();
1257             b.position_before(fcx.alloca_insert_pt.get().unwrap());
1258             b.store(outptr, slot);
1259         }
1260
1261         slot
1262
1263     // But if there are no nested returns, we skip the indirection and have a single
1264     // retslot
1265     } else {
1266         if type_of::return_uses_outptr(fcx.ccx, output_type) {
1267             get_param(fcx.llfn, 0)
1268         } else {
1269             AllocaFcx(fcx, lloutputtype, "sret_slot")
1270         }
1271     }
1272 }
1273
1274 struct FindNestedReturn {
1275     found: bool,
1276 }
1277
1278 impl FindNestedReturn {
1279     fn new() -> FindNestedReturn {
1280         FindNestedReturn { found: false }
1281     }
1282 }
1283
1284 impl<'v> Visitor<'v> for FindNestedReturn {
1285     fn visit_expr(&mut self, e: &ast::Expr) {
1286         match e.node {
1287             ast::ExprRet(..) => {
1288                 self.found = true;
1289             }
1290             _ => visit::walk_expr(self, e)
1291         }
1292     }
1293 }
1294
1295 fn build_cfg(tcx: &ty::ctxt, id: ast::NodeId) -> (ast::NodeId, Option<cfg::CFG>) {
1296     let blk = match tcx.map.find(id) {
1297         Some(ast_map::NodeItem(i)) => {
1298             match i.node {
1299                 ast::ItemFn(_, _, _, _, ref blk) => {
1300                     blk
1301                 }
1302                 _ => tcx.sess.bug("unexpected item variant in has_nested_returns")
1303             }
1304         }
1305         Some(ast_map::NodeTraitItem(trait_method)) => {
1306             match *trait_method {
1307                 ast::ProvidedMethod(ref m) => {
1308                     match m.node {
1309                         ast::MethDecl(_, _, _, _, _, _, ref blk, _) => {
1310                             blk
1311                         }
1312                         ast::MethMac(_) => tcx.sess.bug("unexpanded macro")
1313                     }
1314                 }
1315                 ast::RequiredMethod(_) => {
1316                     tcx.sess.bug("unexpected variant: required trait method \
1317                                   in has_nested_returns")
1318                 }
1319                 ast::TypeTraitItem(_) => {
1320                     tcx.sess.bug("unexpected variant: type trait item in \
1321                                   has_nested_returns")
1322                 }
1323             }
1324         }
1325         Some(ast_map::NodeImplItem(ii)) => {
1326             match *ii {
1327                 ast::MethodImplItem(ref m) => {
1328                     match m.node {
1329                         ast::MethDecl(_, _, _, _, _, _, ref blk, _) => {
1330                             blk
1331                         }
1332                         ast::MethMac(_) => tcx.sess.bug("unexpanded macro")
1333                     }
1334                 }
1335                 ast::TypeImplItem(_) => {
1336                     tcx.sess.bug("unexpected variant: type impl item in \
1337                                   has_nested_returns")
1338                 }
1339             }
1340         }
1341         Some(ast_map::NodeExpr(e)) => {
1342             match e.node {
1343                 ast::ExprClosure(_, _, _, ref blk) => {
1344                     blk
1345                 }
1346                 _ => tcx.sess.bug("unexpected expr variant in has_nested_returns")
1347             }
1348         }
1349         Some(ast_map::NodeVariant(..)) |
1350         Some(ast_map::NodeStructCtor(..)) => return (ast::DUMMY_NODE_ID, None),
1351
1352         // glue, shims, etc
1353         None if id == ast::DUMMY_NODE_ID => return (ast::DUMMY_NODE_ID, None),
1354
1355         _ => tcx.sess.bug(format!("unexpected variant in has_nested_returns: {}",
1356                                   tcx.map.path_to_string(id)).as_slice())
1357     };
1358
1359     (blk.id, Some(cfg::CFG::new(tcx, &**blk)))
1360 }
1361
1362 // Checks for the presence of "nested returns" in a function.
1363 // Nested returns are when the inner expression of a return expression
1364 // (the 'expr' in 'return expr') contains a return expression. Only cases
1365 // where the outer return is actually reachable are considered. Implicit
1366 // returns from the end of blocks are considered as well.
1367 //
1368 // This check is needed to handle the case where the inner expression is
1369 // part of a larger expression that may have already partially-filled the
1370 // return slot alloca. This can cause errors related to clean-up due to
1371 // the clobbering of the existing value in the return slot.
1372 fn has_nested_returns(tcx: &ty::ctxt, cfg: &cfg::CFG, blk_id: ast::NodeId) -> bool {
1373     for n in cfg.graph.depth_traverse(cfg.entry) {
1374         match tcx.map.find(n.id) {
1375             Some(ast_map::NodeExpr(ex)) => {
1376                 if let ast::ExprRet(Some(ref ret_expr)) = ex.node {
1377                     let mut visitor = FindNestedReturn::new();
1378                     visit::walk_expr(&mut visitor, &**ret_expr);
1379                     if visitor.found {
1380                         return true;
1381                     }
1382                 }
1383             }
1384             Some(ast_map::NodeBlock(blk)) if blk.id == blk_id => {
1385                 let mut visitor = FindNestedReturn::new();
1386                 visit::walk_expr_opt(&mut visitor, &blk.expr);
1387                 if visitor.found {
1388                     return true;
1389                 }
1390             }
1391             _ => {}
1392         }
1393     }
1394
1395     return false;
1396 }
1397
1398 // NB: must keep 4 fns in sync:
1399 //
1400 //  - type_of_fn
1401 //  - create_datums_for_fn_args.
1402 //  - new_fn_ctxt
1403 //  - trans_args
1404 //
1405 // Be warned! You must call `init_function` before doing anything with the
1406 // returned function context.
1407 pub fn new_fn_ctxt<'a, 'tcx>(ccx: &'a CrateContext<'a, 'tcx>,
1408                              llfndecl: ValueRef,
1409                              id: ast::NodeId,
1410                              has_env: bool,
1411                              output_type: ty::FnOutput<'tcx>,
1412                              param_substs: &'a Substs<'tcx>,
1413                              sp: Option<Span>,
1414                              block_arena: &'a TypedArena<common::BlockS<'a, 'tcx>>)
1415                              -> FunctionContext<'a, 'tcx> {
1416     common::validate_substs(param_substs);
1417
1418     debug!("new_fn_ctxt(path={}, id={}, param_substs={})",
1419            if id == -1 {
1420                "".to_string()
1421            } else {
1422                ccx.tcx().map.path_to_string(id).to_string()
1423            },
1424            id, param_substs.repr(ccx.tcx()));
1425
1426     let uses_outptr = match output_type {
1427         ty::FnConverging(output_type) => {
1428             let substd_output_type =
1429                 monomorphize::apply_param_substs(ccx.tcx(), param_substs, &output_type);
1430             type_of::return_uses_outptr(ccx, substd_output_type)
1431         }
1432         ty::FnDiverging => false
1433     };
1434     let debug_context = debuginfo::create_function_debug_context(ccx, id, param_substs, llfndecl);
1435     let (blk_id, cfg) = build_cfg(ccx.tcx(), id);
1436     let nested_returns = if let Some(ref cfg) = cfg {
1437         has_nested_returns(ccx.tcx(), cfg, blk_id)
1438     } else {
1439         false
1440     };
1441
1442     let mut fcx = FunctionContext {
1443           llfn: llfndecl,
1444           llenv: None,
1445           llretslotptr: Cell::new(None),
1446           param_env: ty::empty_parameter_environment(ccx.tcx()),
1447           alloca_insert_pt: Cell::new(None),
1448           llreturn: Cell::new(None),
1449           needs_ret_allocas: nested_returns,
1450           personality: Cell::new(None),
1451           caller_expects_out_pointer: uses_outptr,
1452           lllocals: RefCell::new(NodeMap()),
1453           llupvars: RefCell::new(NodeMap()),
1454           id: id,
1455           param_substs: param_substs,
1456           span: sp,
1457           block_arena: block_arena,
1458           ccx: ccx,
1459           debug_context: debug_context,
1460           scopes: RefCell::new(Vec::new()),
1461           cfg: cfg
1462     };
1463
1464     if has_env {
1465         fcx.llenv = Some(get_param(fcx.llfn, fcx.env_arg_pos() as c_uint))
1466     }
1467
1468     fcx
1469 }
1470
1471 /// Performs setup on a newly created function, creating the entry scope block
1472 /// and allocating space for the return pointer.
1473 pub fn init_function<'a, 'tcx>(fcx: &'a FunctionContext<'a, 'tcx>,
1474                                skip_retptr: bool,
1475                                output: ty::FnOutput<'tcx>)
1476                                -> Block<'a, 'tcx> {
1477     let entry_bcx = fcx.new_temp_block("entry-block");
1478
1479     // Use a dummy instruction as the insertion point for all allocas.
1480     // This is later removed in FunctionContext::cleanup.
1481     fcx.alloca_insert_pt.set(Some(unsafe {
1482         Load(entry_bcx, C_null(Type::i8p(fcx.ccx)));
1483         llvm::LLVMGetFirstInstruction(entry_bcx.llbb)
1484     }));
1485
1486     if let ty::FnConverging(output_type) = output {
1487         // This shouldn't need to recompute the return type,
1488         // as new_fn_ctxt did it already.
1489         let substd_output_type = fcx.monomorphize(&output_type);
1490         if !return_type_is_void(fcx.ccx, substd_output_type) {
1491             // If the function returns nil/bot, there is no real return
1492             // value, so do not set `llretslotptr`.
1493             if !skip_retptr || fcx.caller_expects_out_pointer {
1494                 // Otherwise, we normally allocate the llretslotptr, unless we
1495                 // have been instructed to skip it for immediate return
1496                 // values.
1497                 fcx.llretslotptr.set(Some(make_return_slot_pointer(fcx, substd_output_type)));
1498             }
1499         }
1500     }
1501
1502     entry_bcx
1503 }
1504
1505 // NB: must keep 4 fns in sync:
1506 //
1507 //  - type_of_fn
1508 //  - create_datums_for_fn_args.
1509 //  - new_fn_ctxt
1510 //  - trans_args
1511
1512 pub fn arg_kind<'a, 'tcx>(cx: &FunctionContext<'a, 'tcx>, t: Ty<'tcx>)
1513                           -> datum::Rvalue {
1514     use trans::datum::{ByRef, ByValue};
1515
1516     datum::Rvalue {
1517         mode: if arg_is_indirect(cx.ccx, t) { ByRef } else { ByValue }
1518     }
1519 }
1520
1521 // work around bizarre resolve errors
1522 type RvalueDatum<'tcx> = datum::Datum<'tcx, datum::Rvalue>;
1523
1524 // create_datums_for_fn_args: creates rvalue datums for each of the
1525 // incoming function arguments. These will later be stored into
1526 // appropriate lvalue datums.
1527 pub fn create_datums_for_fn_args<'a, 'tcx>(fcx: &FunctionContext<'a, 'tcx>,
1528                                            arg_tys: &[Ty<'tcx>])
1529                                            -> Vec<RvalueDatum<'tcx>> {
1530     let _icx = push_ctxt("create_datums_for_fn_args");
1531
1532     // Return an array wrapping the ValueRefs that we get from `get_param` for
1533     // each argument into datums.
1534     arg_tys.iter().enumerate().map(|(i, &arg_ty)| {
1535         let llarg = get_param(fcx.llfn, fcx.arg_pos(i) as c_uint);
1536         datum::Datum::new(llarg, arg_ty, arg_kind(fcx, arg_ty))
1537     }).collect()
1538 }
1539
1540 /// Creates rvalue datums for each of the incoming function arguments and
1541 /// tuples the arguments. These will later be stored into appropriate lvalue
1542 /// datums.
1543 ///
1544 /// FIXME(pcwalton): Reduce the amount of code bloat this is responsible for.
1545 fn create_datums_for_fn_args_under_call_abi<'blk, 'tcx>(
1546         mut bcx: Block<'blk, 'tcx>,
1547         arg_scope: cleanup::CustomScopeIndex,
1548         arg_tys: &[Ty<'tcx>])
1549         -> Vec<RvalueDatum<'tcx>> {
1550     let mut result = Vec::new();
1551     for (i, &arg_ty) in arg_tys.iter().enumerate() {
1552         if i < arg_tys.len() - 1 {
1553             // Regular argument.
1554             let llarg = get_param(bcx.fcx.llfn, bcx.fcx.arg_pos(i) as c_uint);
1555             result.push(datum::Datum::new(llarg, arg_ty, arg_kind(bcx.fcx,
1556                                                                   arg_ty)));
1557             continue
1558         }
1559
1560         // This is the last argument. Tuple it.
1561         match arg_ty.sty {
1562             ty::ty_tup(ref tupled_arg_tys) => {
1563                 let tuple_args_scope_id = cleanup::CustomScope(arg_scope);
1564                 let tuple =
1565                     unpack_datum!(bcx,
1566                                   datum::lvalue_scratch_datum(bcx,
1567                                                               arg_ty,
1568                                                               "tupled_args",
1569                                                               false,
1570                                                               tuple_args_scope_id,
1571                                                               (),
1572                                                               |(),
1573                                                                mut bcx,
1574                                                                llval| {
1575                         for (j, &tupled_arg_ty) in
1576                                     tupled_arg_tys.iter().enumerate() {
1577                             let llarg =
1578                                 get_param(bcx.fcx.llfn,
1579                                           bcx.fcx.arg_pos(i + j) as c_uint);
1580                             let lldest = GEPi(bcx, llval, &[0, j]);
1581                             let datum = datum::Datum::new(
1582                                 llarg,
1583                                 tupled_arg_ty,
1584                                 arg_kind(bcx.fcx, tupled_arg_ty));
1585                             bcx = datum.store_to(bcx, lldest);
1586                         }
1587                         bcx
1588                     }));
1589                 let tuple = unpack_datum!(bcx,
1590                                           tuple.to_expr_datum()
1591                                                .to_rvalue_datum(bcx,
1592                                                                 "argtuple"));
1593                 result.push(tuple);
1594             }
1595             _ => {
1596                 bcx.tcx().sess.bug("last argument of a function with \
1597                                     `rust-call` ABI isn't a tuple?!")
1598             }
1599         };
1600
1601     }
1602
1603     result
1604 }
1605
1606 fn copy_args_to_allocas<'blk, 'tcx>(bcx: Block<'blk, 'tcx>,
1607                                     arg_scope: cleanup::CustomScopeIndex,
1608                                     args: &[ast::Arg],
1609                                     arg_datums: Vec<RvalueDatum<'tcx>>)
1610                                     -> Block<'blk, 'tcx> {
1611     debug!("copy_args_to_allocas");
1612
1613     let _icx = push_ctxt("copy_args_to_allocas");
1614     let mut bcx = bcx;
1615
1616     let arg_scope_id = cleanup::CustomScope(arg_scope);
1617
1618     for (i, arg_datum) in arg_datums.into_iter().enumerate() {
1619         // For certain mode/type combinations, the raw llarg values are passed
1620         // by value.  However, within the fn body itself, we want to always
1621         // have all locals and arguments be by-ref so that we can cancel the
1622         // cleanup and for better interaction with LLVM's debug info.  So, if
1623         // the argument would be passed by value, we store it into an alloca.
1624         // This alloca should be optimized away by LLVM's mem-to-reg pass in
1625         // the event it's not truly needed.
1626
1627         bcx = _match::store_arg(bcx, &*args[i].pat, arg_datum, arg_scope_id);
1628         debuginfo::create_argument_metadata(bcx, &args[i]);
1629     }
1630
1631     bcx
1632 }
1633
1634 fn copy_unboxed_closure_args_to_allocas<'blk, 'tcx>(
1635                                         mut bcx: Block<'blk, 'tcx>,
1636                                         arg_scope: cleanup::CustomScopeIndex,
1637                                         args: &[ast::Arg],
1638                                         arg_datums: Vec<RvalueDatum<'tcx>>,
1639                                         monomorphized_arg_types: &[Ty<'tcx>])
1640                                         -> Block<'blk, 'tcx> {
1641     let _icx = push_ctxt("copy_unboxed_closure_args_to_allocas");
1642     let arg_scope_id = cleanup::CustomScope(arg_scope);
1643
1644     assert_eq!(arg_datums.len(), 1);
1645
1646     let arg_datum = arg_datums.into_iter().next().unwrap();
1647
1648     // Untuple the rest of the arguments.
1649     let tuple_datum =
1650         unpack_datum!(bcx,
1651                       arg_datum.to_lvalue_datum_in_scope(bcx,
1652                                                          "argtuple",
1653                                                          arg_scope_id));
1654     let untupled_arg_types = match monomorphized_arg_types[0].sty {
1655         ty::ty_tup(ref types) => &types[],
1656         _ => {
1657             bcx.tcx().sess.span_bug(args[0].pat.span,
1658                                     "first arg to `rust-call` ABI function \
1659                                      wasn't a tuple?!")
1660         }
1661     };
1662     for j in range(0, args.len()) {
1663         let tuple_element_type = untupled_arg_types[j];
1664         let tuple_element_datum =
1665             tuple_datum.get_element(bcx,
1666                                     tuple_element_type,
1667                                     |llval| GEPi(bcx, llval, &[0, j]));
1668         let tuple_element_datum = tuple_element_datum.to_expr_datum();
1669         let tuple_element_datum =
1670             unpack_datum!(bcx,
1671                           tuple_element_datum.to_rvalue_datum(bcx,
1672                                                               "arg"));
1673         bcx = _match::store_arg(bcx,
1674                                 &*args[j].pat,
1675                                 tuple_element_datum,
1676                                 arg_scope_id);
1677
1678         debuginfo::create_argument_metadata(bcx, &args[j]);
1679     }
1680
1681     bcx
1682 }
1683
1684 // Ties up the llstaticallocas -> llloadenv -> lltop edges,
1685 // and builds the return block.
1686 pub fn finish_fn<'blk, 'tcx>(fcx: &'blk FunctionContext<'blk, 'tcx>,
1687                              last_bcx: Block<'blk, 'tcx>,
1688                              retty: ty::FnOutput<'tcx>) {
1689     let _icx = push_ctxt("finish_fn");
1690
1691     let ret_cx = match fcx.llreturn.get() {
1692         Some(llreturn) => {
1693             if !last_bcx.terminated.get() {
1694                 Br(last_bcx, llreturn);
1695             }
1696             raw_block(fcx, false, llreturn)
1697         }
1698         None => last_bcx
1699     };
1700
1701     // This shouldn't need to recompute the return type,
1702     // as new_fn_ctxt did it already.
1703     let substd_retty = fcx.monomorphize(&retty);
1704     build_return_block(fcx, ret_cx, substd_retty);
1705
1706     debuginfo::clear_source_location(fcx);
1707     fcx.cleanup();
1708 }
1709
1710 // Builds the return block for a function.
1711 pub fn build_return_block<'blk, 'tcx>(fcx: &FunctionContext<'blk, 'tcx>,
1712                                       ret_cx: Block<'blk, 'tcx>,
1713                                       retty: ty::FnOutput<'tcx>) {
1714     if fcx.llretslotptr.get().is_none() ||
1715        (!fcx.needs_ret_allocas && fcx.caller_expects_out_pointer) {
1716         return RetVoid(ret_cx);
1717     }
1718
1719     let retslot = if fcx.needs_ret_allocas {
1720         Load(ret_cx, fcx.llretslotptr.get().unwrap())
1721     } else {
1722         fcx.llretslotptr.get().unwrap()
1723     };
1724     let retptr = Value(retslot);
1725     match retptr.get_dominating_store(ret_cx) {
1726         // If there's only a single store to the ret slot, we can directly return
1727         // the value that was stored and omit the store and the alloca
1728         Some(s) => {
1729             let retval = s.get_operand(0).unwrap().get();
1730             s.erase_from_parent();
1731
1732             if retptr.has_no_uses() {
1733                 retptr.erase_from_parent();
1734             }
1735
1736             let retval = if retty == ty::FnConverging(fcx.ccx.tcx().types.bool) {
1737                 Trunc(ret_cx, retval, Type::i1(fcx.ccx))
1738             } else {
1739                 retval
1740             };
1741
1742             if fcx.caller_expects_out_pointer {
1743                 if let ty::FnConverging(retty) = retty {
1744                     store_ty(ret_cx, retval, get_param(fcx.llfn, 0), retty);
1745                 }
1746                 RetVoid(ret_cx)
1747             } else {
1748                 Ret(ret_cx, retval)
1749             }
1750         }
1751         // Otherwise, copy the return value to the ret slot
1752         None => match retty {
1753             ty::FnConverging(retty) => {
1754                 if fcx.caller_expects_out_pointer {
1755                     memcpy_ty(ret_cx, get_param(fcx.llfn, 0), retslot, retty);
1756                     RetVoid(ret_cx)
1757                 } else {
1758                     Ret(ret_cx, load_ty(ret_cx, retslot, retty))
1759                 }
1760             }
1761             ty::FnDiverging => {
1762                 if fcx.caller_expects_out_pointer {
1763                     RetVoid(ret_cx)
1764                 } else {
1765                     Ret(ret_cx, C_undef(Type::nil(fcx.ccx)))
1766                 }
1767             }
1768         }
1769     }
1770 }
1771
1772 #[derive(Clone, Copy, Eq, PartialEq)]
1773 pub enum IsUnboxedClosureFlag {
1774     NotUnboxedClosure,
1775     IsUnboxedClosure,
1776 }
1777
1778 // trans_closure: Builds an LLVM function out of a source function.
1779 // If the function closes over its environment a closure will be
1780 // returned.
1781 pub fn trans_closure<'a, 'b, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
1782                                    decl: &ast::FnDecl,
1783                                    body: &ast::Block,
1784                                    llfndecl: ValueRef,
1785                                    param_substs: &Substs<'tcx>,
1786                                    fn_ast_id: ast::NodeId,
1787                                    _attributes: &[ast::Attribute],
1788                                    output_type: ty::FnOutput<'tcx>,
1789                                    abi: Abi,
1790                                    closure_env: closure::ClosureEnv<'b, 'tcx>) {
1791     ccx.stats().n_closures.set(ccx.stats().n_closures.get() + 1);
1792
1793     let _icx = push_ctxt("trans_closure");
1794     set_uwtable(llfndecl);
1795
1796     debug!("trans_closure(..., param_substs={})",
1797            param_substs.repr(ccx.tcx()));
1798
1799     let arena = TypedArena::new();
1800     let fcx = new_fn_ctxt(ccx,
1801                           llfndecl,
1802                           fn_ast_id,
1803                           closure_env.kind != closure::NotClosure,
1804                           output_type,
1805                           param_substs,
1806                           Some(body.span),
1807                           &arena);
1808     let mut bcx = init_function(&fcx, false, output_type);
1809
1810     // cleanup scope for the incoming arguments
1811     let fn_cleanup_debug_loc =
1812         debuginfo::get_cleanup_debug_loc_for_ast_node(ccx, fn_ast_id, body.span, true);
1813     let arg_scope = fcx.push_custom_cleanup_scope_with_debug_loc(fn_cleanup_debug_loc);
1814
1815     let block_ty = node_id_type(bcx, body.id);
1816
1817     // Set up arguments to the function.
1818     let monomorphized_arg_types =
1819         decl.inputs.iter()
1820                    .map(|arg| node_id_type(bcx, arg.id))
1821                    .collect::<Vec<_>>();
1822     let monomorphized_arg_types = match closure_env.kind {
1823         closure::NotClosure => {
1824             monomorphized_arg_types
1825         }
1826
1827         // Tuple up closure argument types for the "rust-call" ABI.
1828         closure::UnboxedClosure(..) => {
1829             vec![ty::mk_tup(ccx.tcx(), monomorphized_arg_types)]
1830         }
1831     };
1832     for monomorphized_arg_type in monomorphized_arg_types.iter() {
1833         debug!("trans_closure: monomorphized_arg_type: {}",
1834                ty_to_string(ccx.tcx(), *monomorphized_arg_type));
1835     }
1836     debug!("trans_closure: function lltype: {}",
1837            bcx.fcx.ccx.tn().val_to_string(bcx.fcx.llfn));
1838
1839     let arg_datums = if abi != RustCall {
1840         create_datums_for_fn_args(&fcx,
1841                                   &monomorphized_arg_types[])
1842     } else {
1843         create_datums_for_fn_args_under_call_abi(
1844             bcx,
1845             arg_scope,
1846             &monomorphized_arg_types[])
1847     };
1848
1849     bcx = match closure_env.kind {
1850         closure::NotClosure => {
1851             copy_args_to_allocas(bcx,
1852                                  arg_scope,
1853                                  &decl.inputs[],
1854                                  arg_datums)
1855         }
1856         closure::UnboxedClosure(..) => {
1857             copy_unboxed_closure_args_to_allocas(
1858                 bcx,
1859                 arg_scope,
1860                 &decl.inputs[],
1861                 arg_datums,
1862                 &monomorphized_arg_types[])
1863         }
1864     };
1865
1866     bcx = closure_env.load(bcx, cleanup::CustomScope(arg_scope));
1867
1868     // Up until here, IR instructions for this function have explicitly not been annotated with
1869     // source code location, so we don't step into call setup code. From here on, source location
1870     // emitting should be enabled.
1871     debuginfo::start_emitting_source_locations(&fcx);
1872
1873     let dest = match fcx.llretslotptr.get() {
1874         Some(_) => expr::SaveIn(fcx.get_ret_slot(bcx, ty::FnConverging(block_ty), "iret_slot")),
1875         None => {
1876             assert!(type_is_zero_size(bcx.ccx(), block_ty));
1877             expr::Ignore
1878         }
1879     };
1880
1881     // This call to trans_block is the place where we bridge between
1882     // translation calls that don't have a return value (trans_crate,
1883     // trans_mod, trans_item, et cetera) and those that do
1884     // (trans_block, trans_expr, et cetera).
1885     bcx = controlflow::trans_block(bcx, body, dest);
1886
1887     match dest {
1888         expr::SaveIn(slot) if fcx.needs_ret_allocas => {
1889             Store(bcx, slot, fcx.llretslotptr.get().unwrap());
1890         }
1891         _ => {}
1892     }
1893
1894     match fcx.llreturn.get() {
1895         Some(_) => {
1896             Br(bcx, fcx.return_exit_block());
1897             fcx.pop_custom_cleanup_scope(arg_scope);
1898         }
1899         None => {
1900             // Microoptimization writ large: avoid creating a separate
1901             // llreturn basic block
1902             bcx = fcx.pop_and_trans_custom_cleanup_scope(bcx, arg_scope);
1903         }
1904     };
1905
1906     // Put return block after all other blocks.
1907     // This somewhat improves single-stepping experience in debugger.
1908     unsafe {
1909         let llreturn = fcx.llreturn.get();
1910         for &llreturn in llreturn.iter() {
1911             llvm::LLVMMoveBasicBlockAfter(llreturn, bcx.llbb);
1912         }
1913     }
1914
1915     // Insert the mandatory first few basic blocks before lltop.
1916     finish_fn(&fcx, bcx, output_type);
1917 }
1918
1919 // trans_fn: creates an LLVM function corresponding to a source language
1920 // function.
1921 pub fn trans_fn<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
1922                           decl: &ast::FnDecl,
1923                           body: &ast::Block,
1924                           llfndecl: ValueRef,
1925                           param_substs: &Substs<'tcx>,
1926                           id: ast::NodeId,
1927                           attrs: &[ast::Attribute]) {
1928     let _s = StatRecorder::new(ccx, ccx.tcx().map.path_to_string(id).to_string());
1929     debug!("trans_fn(param_substs={})", param_substs.repr(ccx.tcx()));
1930     let _icx = push_ctxt("trans_fn");
1931     let fn_ty = ty::node_id_to_type(ccx.tcx(), id);
1932     let output_type = ty::erase_late_bound_regions(ccx.tcx(), &ty::ty_fn_ret(fn_ty));
1933     let abi = ty::ty_fn_abi(fn_ty);
1934     trans_closure(ccx,
1935                   decl,
1936                   body,
1937                   llfndecl,
1938                   param_substs,
1939                   id,
1940                   attrs,
1941                   output_type,
1942                   abi,
1943                   closure::ClosureEnv::new(&[], closure::NotClosure));
1944 }
1945
1946 pub fn trans_enum_variant<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
1947                                     _enum_id: ast::NodeId,
1948                                     variant: &ast::Variant,
1949                                     _args: &[ast::VariantArg],
1950                                     disr: ty::Disr,
1951                                     param_substs: &Substs<'tcx>,
1952                                     llfndecl: ValueRef) {
1953     let _icx = push_ctxt("trans_enum_variant");
1954
1955     trans_enum_variant_or_tuple_like_struct(
1956         ccx,
1957         variant.node.id,
1958         disr,
1959         param_substs,
1960         llfndecl);
1961 }
1962
1963 pub fn trans_named_tuple_constructor<'blk, 'tcx>(mut bcx: Block<'blk, 'tcx>,
1964                                                  ctor_ty: Ty<'tcx>,
1965                                                  disr: ty::Disr,
1966                                                  args: callee::CallArgs,
1967                                                  dest: expr::Dest,
1968                                                  call_info: Option<NodeInfo>)
1969                                                  -> Result<'blk, 'tcx> {
1970
1971     let ccx = bcx.fcx.ccx;
1972     let tcx = ccx.tcx();
1973
1974     let result_ty = match ctor_ty.sty {
1975         ty::ty_bare_fn(_, ref bft) => {
1976             ty::erase_late_bound_regions(bcx.tcx(), &bft.sig.output()).unwrap()
1977         }
1978         _ => ccx.sess().bug(
1979             &format!("trans_enum_variant_constructor: \
1980                      unexpected ctor return type {}",
1981                      ctor_ty.repr(tcx))[])
1982     };
1983
1984     // Get location to store the result. If the user does not care about
1985     // the result, just make a stack slot
1986     let llresult = match dest {
1987         expr::SaveIn(d) => d,
1988         expr::Ignore => {
1989             if !type_is_zero_size(ccx, result_ty) {
1990                 alloc_ty(bcx, result_ty, "constructor_result")
1991             } else {
1992                 C_undef(type_of::type_of(ccx, result_ty))
1993             }
1994         }
1995     };
1996
1997     if !type_is_zero_size(ccx, result_ty) {
1998         match args {
1999             callee::ArgExprs(exprs) => {
2000                 let fields = exprs.iter().map(|x| &**x).enumerate().collect::<Vec<_>>();
2001                 bcx = expr::trans_adt(bcx,
2002                                       result_ty,
2003                                       disr,
2004                                       &fields[],
2005                                       None,
2006                                       expr::SaveIn(llresult),
2007                                       call_info);
2008             }
2009             _ => ccx.sess().bug("expected expr as arguments for variant/struct tuple constructor")
2010         }
2011     }
2012
2013     // If the caller doesn't care about the result
2014     // drop the temporary we made
2015     let bcx = match dest {
2016         expr::SaveIn(_) => bcx,
2017         expr::Ignore => {
2018             glue::drop_ty(bcx, llresult, result_ty, call_info)
2019         }
2020     };
2021
2022     Result::new(bcx, llresult)
2023 }
2024
2025 pub fn trans_tuple_struct<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
2026                                     _fields: &[ast::StructField],
2027                                     ctor_id: ast::NodeId,
2028                                     param_substs: &Substs<'tcx>,
2029                                     llfndecl: ValueRef) {
2030     let _icx = push_ctxt("trans_tuple_struct");
2031
2032     trans_enum_variant_or_tuple_like_struct(
2033         ccx,
2034         ctor_id,
2035         0,
2036         param_substs,
2037         llfndecl);
2038 }
2039
2040 fn trans_enum_variant_or_tuple_like_struct<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
2041                                                      ctor_id: ast::NodeId,
2042                                                      disr: ty::Disr,
2043                                                      param_substs: &Substs<'tcx>,
2044                                                      llfndecl: ValueRef) {
2045     let ctor_ty = ty::node_id_to_type(ccx.tcx(), ctor_id);
2046     let ctor_ty = monomorphize::apply_param_substs(ccx.tcx(), param_substs, &ctor_ty);
2047
2048     let result_ty = match ctor_ty.sty {
2049         ty::ty_bare_fn(_, ref bft) => {
2050             ty::erase_late_bound_regions(ccx.tcx(), &bft.sig.output())
2051         }
2052         _ => ccx.sess().bug(
2053             &format!("trans_enum_variant_or_tuple_like_struct: \
2054                      unexpected ctor return type {}",
2055                     ty_to_string(ccx.tcx(), ctor_ty))[])
2056     };
2057
2058     let arena = TypedArena::new();
2059     let fcx = new_fn_ctxt(ccx, llfndecl, ctor_id, false, result_ty,
2060                           param_substs, None, &arena);
2061     let bcx = init_function(&fcx, false, result_ty);
2062
2063     assert!(!fcx.needs_ret_allocas);
2064
2065     let arg_tys =
2066         ty::erase_late_bound_regions(
2067             ccx.tcx(), &ty::ty_fn_args(ctor_ty));
2068
2069     let arg_datums = create_datums_for_fn_args(&fcx, &arg_tys[]);
2070
2071     if !type_is_zero_size(fcx.ccx, result_ty.unwrap()) {
2072         let dest = fcx.get_ret_slot(bcx, result_ty, "eret_slot");
2073         let repr = adt::represent_type(ccx, result_ty.unwrap());
2074         for (i, arg_datum) in arg_datums.into_iter().enumerate() {
2075             let lldestptr = adt::trans_field_ptr(bcx,
2076                                                  &*repr,
2077                                                  dest,
2078                                                  disr,
2079                                                  i);
2080             arg_datum.store_to(bcx, lldestptr);
2081         }
2082         adt::trans_set_discr(bcx, &*repr, dest, disr);
2083     }
2084
2085     finish_fn(&fcx, bcx, result_ty);
2086 }
2087
2088 fn enum_variant_size_lint(ccx: &CrateContext, enum_def: &ast::EnumDef, sp: Span, id: ast::NodeId) {
2089     let mut sizes = Vec::new(); // does no allocation if no pushes, thankfully
2090
2091     let print_info = ccx.sess().print_enum_sizes();
2092
2093     let levels = ccx.tcx().node_lint_levels.borrow();
2094     let lint_id = lint::LintId::of(lint::builtin::VARIANT_SIZE_DIFFERENCES);
2095     let lvlsrc = levels.get(&(id, lint_id));
2096     let is_allow = lvlsrc.map_or(true, |&(lvl, _)| lvl == lint::Allow);
2097
2098     if is_allow && !print_info {
2099         // we're not interested in anything here
2100         return
2101     }
2102
2103     let ty = ty::node_id_to_type(ccx.tcx(), id);
2104     let avar = adt::represent_type(ccx, ty);
2105     match *avar {
2106         adt::General(_, ref variants, _) => {
2107             for var in variants.iter() {
2108                 let mut size = 0;
2109                 for field in var.fields.iter().skip(1) {
2110                     // skip the discriminant
2111                     size += llsize_of_real(ccx, sizing_type_of(ccx, *field));
2112                 }
2113                 sizes.push(size);
2114             }
2115         },
2116         _ => { /* its size is either constant or unimportant */ }
2117     }
2118
2119     let (largest, slargest, largest_index) = sizes.iter().enumerate().fold((0, 0, 0),
2120         |(l, s, li), (idx, &size)|
2121             if size > l {
2122                 (size, l, idx)
2123             } else if size > s {
2124                 (l, size, li)
2125             } else {
2126                 (l, s, li)
2127             }
2128     );
2129
2130     if print_info {
2131         let llty = type_of::sizing_type_of(ccx, ty);
2132
2133         let sess = &ccx.tcx().sess;
2134         sess.span_note(sp, &*format!("total size: {} bytes", llsize_of_real(ccx, llty)));
2135         match *avar {
2136             adt::General(..) => {
2137                 for (i, var) in enum_def.variants.iter().enumerate() {
2138                     ccx.tcx().sess.span_note(var.span,
2139                                              &*format!("variant data: {} bytes", sizes[i]));
2140                 }
2141             }
2142             _ => {}
2143         }
2144     }
2145
2146     // we only warn if the largest variant is at least thrice as large as
2147     // the second-largest.
2148     if !is_allow && largest > slargest * 3 && slargest > 0 {
2149         // Use lint::raw_emit_lint rather than sess.add_lint because the lint-printing
2150         // pass for the latter already ran.
2151         lint::raw_emit_lint(&ccx.tcx().sess, lint::builtin::VARIANT_SIZE_DIFFERENCES,
2152                             *lvlsrc.unwrap(), Some(sp),
2153                             &format!("enum variant is more than three times larger \
2154                                      ({} bytes) than the next largest (ignoring padding)",
2155                                     largest)[]);
2156
2157         ccx.sess().span_note(enum_def.variants[largest_index].span,
2158                              "this variant is the largest");
2159     }
2160 }
2161
2162 pub struct TransItemVisitor<'a, 'tcx: 'a> {
2163     pub ccx: &'a CrateContext<'a, 'tcx>,
2164 }
2165
2166 impl<'a, 'tcx, 'v> Visitor<'v> for TransItemVisitor<'a, 'tcx> {
2167     fn visit_item(&mut self, i: &ast::Item) {
2168         trans_item(self.ccx, i);
2169     }
2170 }
2171
2172 pub fn llvm_linkage_by_name(name: &str) -> Option<Linkage> {
2173     // Use the names from src/llvm/docs/LangRef.rst here. Most types are only
2174     // applicable to variable declarations and may not really make sense for
2175     // Rust code in the first place but whitelist them anyway and trust that
2176     // the user knows what s/he's doing. Who knows, unanticipated use cases
2177     // may pop up in the future.
2178     //
2179     // ghost, dllimport, dllexport and linkonce_odr_autohide are not supported
2180     // and don't have to be, LLVM treats them as no-ops.
2181     match name {
2182         "appending" => Some(llvm::AppendingLinkage),
2183         "available_externally" => Some(llvm::AvailableExternallyLinkage),
2184         "common" => Some(llvm::CommonLinkage),
2185         "extern_weak" => Some(llvm::ExternalWeakLinkage),
2186         "external" => Some(llvm::ExternalLinkage),
2187         "internal" => Some(llvm::InternalLinkage),
2188         "linkonce" => Some(llvm::LinkOnceAnyLinkage),
2189         "linkonce_odr" => Some(llvm::LinkOnceODRLinkage),
2190         "private" => Some(llvm::PrivateLinkage),
2191         "weak" => Some(llvm::WeakAnyLinkage),
2192         "weak_odr" => Some(llvm::WeakODRLinkage),
2193         _ => None,
2194     }
2195 }
2196
2197
2198 /// Enum describing the origin of an LLVM `Value`, for linkage purposes.
2199 #[derive(Copy)]
2200 pub enum ValueOrigin {
2201     /// The LLVM `Value` is in this context because the corresponding item was
2202     /// assigned to the current compilation unit.
2203     OriginalTranslation,
2204     /// The `Value`'s corresponding item was assigned to some other compilation
2205     /// unit, but the `Value` was translated in this context anyway because the
2206     /// item is marked `#[inline]`.
2207     InlinedCopy,
2208 }
2209
2210 /// Set the appropriate linkage for an LLVM `ValueRef` (function or global).
2211 /// If the `llval` is the direct translation of a specific Rust item, `id`
2212 /// should be set to the `NodeId` of that item.  (This mapping should be
2213 /// 1-to-1, so monomorphizations and drop/visit glue should have `id` set to
2214 /// `None`.)  `llval_origin` indicates whether `llval` is the translation of an
2215 /// item assigned to `ccx`'s compilation unit or an inlined copy of an item
2216 /// assigned to a different compilation unit.
2217 pub fn update_linkage(ccx: &CrateContext,
2218                       llval: ValueRef,
2219                       id: Option<ast::NodeId>,
2220                       llval_origin: ValueOrigin) {
2221     match llval_origin {
2222         InlinedCopy => {
2223             // `llval` is a translation of an item defined in a separate
2224             // compilation unit.  This only makes sense if there are at least
2225             // two compilation units.
2226             assert!(ccx.sess().opts.cg.codegen_units > 1);
2227             // `llval` is a copy of something defined elsewhere, so use
2228             // `AvailableExternallyLinkage` to avoid duplicating code in the
2229             // output.
2230             llvm::SetLinkage(llval, llvm::AvailableExternallyLinkage);
2231             return;
2232         },
2233         OriginalTranslation => {},
2234     }
2235
2236     if let Some(id) = id {
2237         let item = ccx.tcx().map.get(id);
2238         if let ast_map::NodeItem(i) = item {
2239             if let Some(name) = attr::first_attr_value_str_by_name(i.attrs.as_slice(), "linkage") {
2240                 if let Some(linkage) = llvm_linkage_by_name(name.get()) {
2241                     llvm::SetLinkage(llval, linkage);
2242                 } else {
2243                     ccx.sess().span_fatal(i.span, "invalid linkage specified");
2244                 }
2245                 return;
2246             }
2247         }
2248     }
2249
2250     match id {
2251         Some(id) if ccx.reachable().contains(&id) => {
2252             llvm::SetLinkage(llval, llvm::ExternalLinkage);
2253         },
2254         _ => {
2255             // `id` does not refer to an item in `ccx.reachable`.
2256             if ccx.sess().opts.cg.codegen_units > 1 {
2257                 llvm::SetLinkage(llval, llvm::ExternalLinkage);
2258             } else {
2259                 llvm::SetLinkage(llval, llvm::InternalLinkage);
2260             }
2261         },
2262     }
2263 }
2264
2265 pub fn trans_item(ccx: &CrateContext, item: &ast::Item) {
2266     let _icx = push_ctxt("trans_item");
2267
2268     let from_external = ccx.external_srcs().borrow().contains_key(&item.id);
2269
2270     match item.node {
2271       ast::ItemFn(ref decl, _fn_style, abi, ref generics, ref body) => {
2272         if !generics.is_type_parameterized() {
2273             let trans_everywhere = attr::requests_inline(&item.attrs[]);
2274             // Ignore `trans_everywhere` for cross-crate inlined items
2275             // (`from_external`).  `trans_item` will be called once for each
2276             // compilation unit that references the item, so it will still get
2277             // translated everywhere it's needed.
2278             for (ref ccx, is_origin) in ccx.maybe_iter(!from_external && trans_everywhere) {
2279                 let llfn = get_item_val(ccx, item.id);
2280                 if abi != Rust {
2281                     foreign::trans_rust_fn_with_foreign_abi(ccx,
2282                                                             &**decl,
2283                                                             &**body,
2284                                                             &item.attrs[],
2285                                                             llfn,
2286                                                             &Substs::trans_empty(),
2287                                                             item.id,
2288                                                             None);
2289                 } else {
2290                     trans_fn(ccx,
2291                              &**decl,
2292                              &**body,
2293                              llfn,
2294                              &Substs::trans_empty(),
2295                              item.id,
2296                              &item.attrs[]);
2297                 }
2298                 update_linkage(ccx,
2299                                llfn,
2300                                Some(item.id),
2301                                if is_origin { OriginalTranslation } else { InlinedCopy });
2302             }
2303         }
2304
2305         // Be sure to travel more than just one layer deep to catch nested
2306         // items in blocks and such.
2307         let mut v = TransItemVisitor{ ccx: ccx };
2308         v.visit_block(&**body);
2309       }
2310       ast::ItemImpl(_, _, ref generics, _, _, ref impl_items) => {
2311         meth::trans_impl(ccx,
2312                          item.ident,
2313                          &impl_items[],
2314                          generics,
2315                          item.id);
2316       }
2317       ast::ItemMod(ref m) => {
2318         trans_mod(&ccx.rotate(), m);
2319       }
2320       ast::ItemEnum(ref enum_definition, ref gens) => {
2321         if gens.ty_params.is_empty() {
2322             // sizes only make sense for non-generic types
2323
2324             enum_variant_size_lint(ccx, enum_definition, item.span, item.id);
2325         }
2326       }
2327       ast::ItemConst(_, ref expr) => {
2328           // Recurse on the expression to catch items in blocks
2329           let mut v = TransItemVisitor{ ccx: ccx };
2330           v.visit_expr(&**expr);
2331       }
2332       ast::ItemStatic(_, m, ref expr) => {
2333           // Recurse on the expression to catch items in blocks
2334           let mut v = TransItemVisitor{ ccx: ccx };
2335           v.visit_expr(&**expr);
2336
2337           consts::trans_static(ccx, m, item.id);
2338           let g = get_item_val(ccx, item.id);
2339           update_linkage(ccx, g, Some(item.id), OriginalTranslation);
2340
2341           // Do static_assert checking. It can't really be done much earlier
2342           // because we need to get the value of the bool out of LLVM
2343           if attr::contains_name(&item.attrs[], "static_assert") {
2344               if m == ast::MutMutable {
2345                   ccx.sess().span_fatal(expr.span,
2346                                         "cannot have static_assert on a mutable \
2347                                          static");
2348               }
2349
2350               let v = ccx.static_values().borrow()[item.id].clone();
2351               unsafe {
2352                   if !(llvm::LLVMConstIntGetZExtValue(v) != 0) {
2353                       ccx.sess().span_fatal(expr.span, "static assertion failed");
2354                   }
2355               }
2356           }
2357       },
2358       ast::ItemForeignMod(ref foreign_mod) => {
2359         foreign::trans_foreign_mod(ccx, foreign_mod);
2360       }
2361       ast::ItemTrait(..) => {
2362         // Inside of this trait definition, we won't be actually translating any
2363         // functions, but the trait still needs to be walked. Otherwise default
2364         // methods with items will not get translated and will cause ICE's when
2365         // metadata time comes around.
2366         let mut v = TransItemVisitor{ ccx: ccx };
2367         visit::walk_item(&mut v, item);
2368       }
2369       _ => {/* fall through */ }
2370     }
2371 }
2372
2373 // Translate a module. Doing this amounts to translating the items in the
2374 // module; there ends up being no artifact (aside from linkage names) of
2375 // separate modules in the compiled program.  That's because modules exist
2376 // only as a convenience for humans working with the code, to organize names
2377 // and control visibility.
2378 pub fn trans_mod(ccx: &CrateContext, m: &ast::Mod) {
2379     let _icx = push_ctxt("trans_mod");
2380     for item in m.items.iter() {
2381         trans_item(ccx, &**item);
2382     }
2383 }
2384
2385 fn finish_register_fn(ccx: &CrateContext, sp: Span, sym: String, node_id: ast::NodeId,
2386                       llfn: ValueRef) {
2387     ccx.item_symbols().borrow_mut().insert(node_id, sym);
2388
2389     // The stack exhaustion lang item shouldn't have a split stack because
2390     // otherwise it would continue to be exhausted (bad), and both it and the
2391     // eh_personality functions need to be externally linkable.
2392     let def = ast_util::local_def(node_id);
2393     if ccx.tcx().lang_items.stack_exhausted() == Some(def) {
2394         unset_split_stack(llfn);
2395         llvm::SetLinkage(llfn, llvm::ExternalLinkage);
2396     }
2397     if ccx.tcx().lang_items.eh_personality() == Some(def) {
2398         llvm::SetLinkage(llfn, llvm::ExternalLinkage);
2399     }
2400
2401
2402     if is_entry_fn(ccx.sess(), node_id) {
2403         create_entry_wrapper(ccx, sp, llfn);
2404     }
2405 }
2406
2407 fn register_fn<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
2408                          sp: Span,
2409                          sym: String,
2410                          node_id: ast::NodeId,
2411                          node_type: Ty<'tcx>)
2412                          -> ValueRef {
2413     match node_type.sty {
2414         ty::ty_bare_fn(_, ref f) => {
2415             assert!(f.abi == Rust || f.abi == RustCall);
2416         }
2417         _ => panic!("expected bare rust fn")
2418     };
2419
2420     let llfn = decl_rust_fn(ccx, node_type, &sym[]);
2421     finish_register_fn(ccx, sp, sym, node_id, llfn);
2422     llfn
2423 }
2424
2425 pub fn get_fn_llvm_attributes<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>, fn_ty: Ty<'tcx>)
2426                                         -> llvm::AttrBuilder
2427 {
2428     use middle::ty::{BrAnon, ReLateBound};
2429
2430     let function_type;
2431     let (fn_sig, abi, has_env) = match fn_ty.sty {
2432         ty::ty_bare_fn(_, ref f) => (&f.sig, f.abi, false),
2433         ty::ty_unboxed_closure(closure_did, _, substs) => {
2434             let typer = common::NormalizingUnboxedClosureTyper::new(ccx.tcx());
2435             function_type = typer.unboxed_closure_type(closure_did, substs);
2436             (&function_type.sig, RustCall, true)
2437         }
2438         _ => ccx.sess().bug("expected closure or function.")
2439     };
2440
2441     let fn_sig = ty::erase_late_bound_regions(ccx.tcx(), fn_sig);
2442
2443     // Since index 0 is the return value of the llvm func, we start
2444     // at either 1 or 2 depending on whether there's an env slot or not
2445     let mut first_arg_offset = if has_env { 2 } else { 1 };
2446     let mut attrs = llvm::AttrBuilder::new();
2447     let ret_ty = fn_sig.output;
2448
2449     // These have an odd calling convention, so we need to manually
2450     // unpack the input ty's
2451     let input_tys = match fn_ty.sty {
2452         ty::ty_unboxed_closure(_, _, _) => {
2453             assert!(abi == RustCall);
2454
2455             match fn_sig.inputs[0].sty {
2456                 ty::ty_tup(ref inputs) => inputs.clone(),
2457                 _ => ccx.sess().bug("expected tuple'd inputs")
2458             }
2459         },
2460         ty::ty_bare_fn(..) if abi == RustCall => {
2461             let mut inputs = vec![fn_sig.inputs[0]];
2462
2463             match fn_sig.inputs[1].sty {
2464                 ty::ty_tup(ref t_in) => {
2465                     inputs.push_all(&t_in[]);
2466                     inputs
2467                 }
2468                 _ => ccx.sess().bug("expected tuple'd inputs")
2469             }
2470         }
2471         _ => fn_sig.inputs.clone()
2472     };
2473
2474     if let ty::FnConverging(ret_ty) = ret_ty {
2475         // A function pointer is called without the declaration
2476         // available, so we have to apply any attributes with ABI
2477         // implications directly to the call instruction. Right now,
2478         // the only attribute we need to worry about is `sret`.
2479         if type_of::return_uses_outptr(ccx, ret_ty) {
2480             let llret_sz = llsize_of_real(ccx, type_of::type_of(ccx, ret_ty));
2481
2482             // The outptr can be noalias and nocapture because it's entirely
2483             // invisible to the program. We also know it's nonnull as well
2484             // as how many bytes we can dereference
2485             attrs.arg(1, llvm::StructRetAttribute)
2486                  .arg(1, llvm::NoAliasAttribute)
2487                  .arg(1, llvm::NoCaptureAttribute)
2488                  .arg(1, llvm::DereferenceableAttribute(llret_sz));
2489
2490             // Add one more since there's an outptr
2491             first_arg_offset += 1;
2492         } else {
2493             // The `noalias` attribute on the return value is useful to a
2494             // function ptr caller.
2495             match ret_ty.sty {
2496                 // `~` pointer return values never alias because ownership
2497                 // is transferred
2498                 ty::ty_uniq(it) if !common::type_is_sized(ccx.tcx(), it) => {}
2499                 ty::ty_uniq(_) => {
2500                     attrs.ret(llvm::NoAliasAttribute);
2501                 }
2502                 _ => {}
2503             }
2504
2505             // We can also mark the return value as `dereferenceable` in certain cases
2506             match ret_ty.sty {
2507                 // These are not really pointers but pairs, (pointer, len)
2508                 ty::ty_uniq(it) |
2509                 ty::ty_rptr(_, ty::mt { ty: it, .. }) if !common::type_is_sized(ccx.tcx(), it) => {}
2510                 ty::ty_uniq(inner) | ty::ty_rptr(_, ty::mt { ty: inner, .. }) => {
2511                     let llret_sz = llsize_of_real(ccx, type_of::type_of(ccx, inner));
2512                     attrs.ret(llvm::DereferenceableAttribute(llret_sz));
2513                 }
2514                 _ => {}
2515             }
2516
2517             if let ty::ty_bool = ret_ty.sty {
2518                 attrs.ret(llvm::ZExtAttribute);
2519             }
2520         }
2521     }
2522
2523     for (idx, &t) in input_tys.iter().enumerate().map(|(i, v)| (i + first_arg_offset, v)) {
2524         match t.sty {
2525             // this needs to be first to prevent fat pointers from falling through
2526             _ if !type_is_immediate(ccx, t) => {
2527                 let llarg_sz = llsize_of_real(ccx, type_of::type_of(ccx, t));
2528
2529                 // For non-immediate arguments the callee gets its own copy of
2530                 // the value on the stack, so there are no aliases. It's also
2531                 // program-invisible so can't possibly capture
2532                 attrs.arg(idx, llvm::NoAliasAttribute)
2533                      .arg(idx, llvm::NoCaptureAttribute)
2534                      .arg(idx, llvm::DereferenceableAttribute(llarg_sz));
2535             }
2536
2537             ty::ty_bool => {
2538                 attrs.arg(idx, llvm::ZExtAttribute);
2539             }
2540
2541             // `~` pointer parameters never alias because ownership is transferred
2542             ty::ty_uniq(inner) => {
2543                 let llsz = llsize_of_real(ccx, type_of::type_of(ccx, inner));
2544
2545                 attrs.arg(idx, llvm::NoAliasAttribute)
2546                      .arg(idx, llvm::DereferenceableAttribute(llsz));
2547             }
2548
2549             // `&mut` pointer parameters never alias other parameters, or mutable global data
2550             //
2551             // `&T` where `T` contains no `UnsafeCell<U>` is immutable, and can be marked as both
2552             // `readonly` and `noalias`, as LLVM's definition of `noalias` is based solely on
2553             // memory dependencies rather than pointer equality
2554             ty::ty_rptr(b, mt) if mt.mutbl == ast::MutMutable ||
2555                                   !ty::type_contents(ccx.tcx(), mt.ty).interior_unsafe() => {
2556
2557                 let llsz = llsize_of_real(ccx, type_of::type_of(ccx, mt.ty));
2558                 attrs.arg(idx, llvm::NoAliasAttribute)
2559                      .arg(idx, llvm::DereferenceableAttribute(llsz));
2560
2561                 if mt.mutbl == ast::MutImmutable {
2562                     attrs.arg(idx, llvm::ReadOnlyAttribute);
2563                 }
2564
2565                 if let ReLateBound(_, BrAnon(_)) = *b {
2566                     attrs.arg(idx, llvm::NoCaptureAttribute);
2567                 }
2568             }
2569
2570             // When a reference in an argument has no named lifetime, it's impossible for that
2571             // reference to escape this function (returned or stored beyond the call by a closure).
2572             ty::ty_rptr(&ReLateBound(_, BrAnon(_)), mt) => {
2573                 let llsz = llsize_of_real(ccx, type_of::type_of(ccx, mt.ty));
2574                 attrs.arg(idx, llvm::NoCaptureAttribute)
2575                      .arg(idx, llvm::DereferenceableAttribute(llsz));
2576             }
2577
2578             // & pointer parameters are also never null and we know exactly how
2579             // many bytes we can dereference
2580             ty::ty_rptr(_, mt) => {
2581                 let llsz = llsize_of_real(ccx, type_of::type_of(ccx, mt.ty));
2582                 attrs.arg(idx, llvm::DereferenceableAttribute(llsz));
2583             }
2584             _ => ()
2585         }
2586     }
2587
2588     attrs
2589 }
2590
2591 // only use this for foreign function ABIs and glue, use `register_fn` for Rust functions
2592 pub fn register_fn_llvmty(ccx: &CrateContext,
2593                           sp: Span,
2594                           sym: String,
2595                           node_id: ast::NodeId,
2596                           cc: llvm::CallConv,
2597                           llfty: Type) -> ValueRef {
2598     debug!("register_fn_llvmty id={} sym={}", node_id, sym);
2599
2600     let llfn = decl_fn(ccx,
2601                        &sym[],
2602                        cc,
2603                        llfty,
2604                        ty::FnConverging(ty::mk_nil(ccx.tcx())));
2605     finish_register_fn(ccx, sp, sym, node_id, llfn);
2606     llfn
2607 }
2608
2609 pub fn is_entry_fn(sess: &Session, node_id: ast::NodeId) -> bool {
2610     match *sess.entry_fn.borrow() {
2611         Some((entry_id, _)) => node_id == entry_id,
2612         None => false
2613     }
2614 }
2615
2616 // Create a _rust_main(args: ~[str]) function which will be called from the
2617 // runtime rust_start function
2618 pub fn create_entry_wrapper(ccx: &CrateContext,
2619                            _sp: Span,
2620                            main_llfn: ValueRef) {
2621     let et = ccx.sess().entry_type.get().unwrap();
2622     match et {
2623         config::EntryMain => {
2624             create_entry_fn(ccx, main_llfn, true);
2625         }
2626         config::EntryStart => create_entry_fn(ccx, main_llfn, false),
2627         config::EntryNone => {}    // Do nothing.
2628     }
2629
2630     fn create_entry_fn(ccx: &CrateContext,
2631                        rust_main: ValueRef,
2632                        use_start_lang_item: bool) {
2633         let llfty = Type::func(&[ccx.int_type(), Type::i8p(ccx).ptr_to()],
2634                                &ccx.int_type());
2635
2636         let llfn = decl_cdecl_fn(ccx, "main", llfty, ty::mk_nil(ccx.tcx()));
2637
2638         // FIXME: #16581: Marking a symbol in the executable with `dllexport`
2639         // linkage forces MinGW's linker to output a `.reloc` section for ASLR
2640         if ccx.sess().target.target.options.is_like_windows {
2641             unsafe { llvm::LLVMRustSetDLLExportStorageClass(llfn) }
2642         }
2643
2644         let llbb = unsafe {
2645             llvm::LLVMAppendBasicBlockInContext(ccx.llcx(), llfn,
2646                                                 "top\0".as_ptr() as *const _)
2647         };
2648         let bld = ccx.raw_builder();
2649         unsafe {
2650             llvm::LLVMPositionBuilderAtEnd(bld, llbb);
2651
2652             debuginfo::insert_reference_to_gdb_debug_scripts_section_global(ccx);
2653
2654             let (start_fn, args) = if use_start_lang_item {
2655                 let start_def_id = match ccx.tcx().lang_items.require(StartFnLangItem) {
2656                     Ok(id) => id,
2657                     Err(s) => { ccx.sess().fatal(&s[]); }
2658                 };
2659                 let start_fn = if start_def_id.krate == ast::LOCAL_CRATE {
2660                     get_item_val(ccx, start_def_id.node)
2661                 } else {
2662                     let start_fn_type = csearch::get_type(ccx.tcx(),
2663                                                           start_def_id).ty;
2664                     trans_external_path(ccx, start_def_id, start_fn_type)
2665                 };
2666
2667                 let args = {
2668                     let opaque_rust_main = llvm::LLVMBuildPointerCast(bld,
2669                         rust_main, Type::i8p(ccx).to_ref(),
2670                         "rust_main\0".as_ptr() as *const _);
2671
2672                     vec!(
2673                         opaque_rust_main,
2674                         get_param(llfn, 0),
2675                         get_param(llfn, 1)
2676                      )
2677                 };
2678                 (start_fn, args)
2679             } else {
2680                 debug!("using user-defined start fn");
2681                 let args = vec!(
2682                     get_param(llfn, 0 as c_uint),
2683                     get_param(llfn, 1 as c_uint)
2684                 );
2685
2686                 (rust_main, args)
2687             };
2688
2689             let result = llvm::LLVMBuildCall(bld,
2690                                              start_fn,
2691                                              args.as_ptr(),
2692                                              args.len() as c_uint,
2693                                              noname());
2694
2695             llvm::LLVMBuildRet(bld, result);
2696         }
2697     }
2698 }
2699
2700 fn exported_name<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>, id: ast::NodeId,
2701                            ty: Ty<'tcx>, attrs: &[ast::Attribute]) -> String {
2702     match ccx.external_srcs().borrow().get(&id) {
2703         Some(&did) => {
2704             let sym = csearch::get_symbol(&ccx.sess().cstore, did);
2705             debug!("found item {} in other crate...", sym);
2706             return sym;
2707         }
2708         None => {}
2709     }
2710
2711     match attr::first_attr_value_str_by_name(attrs, "export_name") {
2712         // Use provided name
2713         Some(name) => name.get().to_string(),
2714
2715         _ => ccx.tcx().map.with_path(id, |path| {
2716             if attr::contains_name(attrs, "no_mangle") {
2717                 // Don't mangle
2718                 path.last().unwrap().to_string()
2719             } else {
2720                 match weak_lang_items::link_name(attrs) {
2721                     Some(name) => name.get().to_string(),
2722                     None => {
2723                         // Usual name mangling
2724                         mangle_exported_name(ccx, path, ty, id)
2725                     }
2726                 }
2727             }
2728         })
2729     }
2730 }
2731
2732 fn contains_null(s: &str) -> bool {
2733     s.bytes().any(|b| b == 0)
2734 }
2735
2736 pub fn get_item_val(ccx: &CrateContext, id: ast::NodeId) -> ValueRef {
2737     debug!("get_item_val(id=`{}`)", id);
2738
2739     match ccx.item_vals().borrow().get(&id).cloned() {
2740         Some(v) => return v,
2741         None => {}
2742     }
2743
2744     let item = ccx.tcx().map.get(id);
2745     debug!("get_item_val: id={} item={:?}", id, item);
2746     let val = match item {
2747         ast_map::NodeItem(i) => {
2748             let ty = ty::node_id_to_type(ccx.tcx(), i.id);
2749             let sym = |&:| exported_name(ccx, id, ty, &i.attrs[]);
2750
2751             let v = match i.node {
2752                 ast::ItemStatic(_, _, ref expr) => {
2753                     // If this static came from an external crate, then
2754                     // we need to get the symbol from csearch instead of
2755                     // using the current crate's name/version
2756                     // information in the hash of the symbol
2757                     let sym = sym();
2758                     debug!("making {}", sym);
2759
2760                     // We need the translated value here, because for enums the
2761                     // LLVM type is not fully determined by the Rust type.
2762                     let (v, ty) = consts::const_expr(ccx, &**expr);
2763                     ccx.static_values().borrow_mut().insert(id, v);
2764                     unsafe {
2765                         // boolean SSA values are i1, but they have to be stored in i8 slots,
2766                         // otherwise some LLVM optimization passes don't work as expected
2767                         let llty = if ty::type_is_bool(ty) {
2768                             llvm::LLVMInt8TypeInContext(ccx.llcx())
2769                         } else {
2770                             llvm::LLVMTypeOf(v)
2771                         };
2772                         if contains_null(&sym[]) {
2773                             ccx.sess().fatal(
2774                                 &format!("Illegal null byte in export_name \
2775                                          value: `{}`", sym)[]);
2776                         }
2777                         let buf = CString::from_slice(sym.as_bytes());
2778                         let g = llvm::LLVMAddGlobal(ccx.llmod(), llty,
2779                                                     buf.as_ptr());
2780
2781                         if attr::contains_name(&i.attrs[],
2782                                                "thread_local") {
2783                             llvm::set_thread_local(g, true);
2784                         }
2785                         ccx.item_symbols().borrow_mut().insert(i.id, sym);
2786                         g
2787                     }
2788                 }
2789
2790                 ast::ItemConst(_, ref expr) => {
2791                     let (v, _) = consts::const_expr(ccx, &**expr);
2792                     ccx.const_values().borrow_mut().insert(id, v);
2793                     v
2794                 }
2795
2796                 ast::ItemFn(_, _, abi, _, _) => {
2797                     let sym = sym();
2798                     let llfn = if abi == Rust {
2799                         register_fn(ccx, i.span, sym, i.id, ty)
2800                     } else {
2801                         foreign::register_rust_fn_with_foreign_abi(ccx,
2802                                                                    i.span,
2803                                                                    sym,
2804                                                                    i.id)
2805                     };
2806                     set_llvm_fn_attrs(ccx, &i.attrs[], llfn);
2807                     llfn
2808                 }
2809
2810                 _ => panic!("get_item_val: weird result in table")
2811             };
2812
2813             match attr::first_attr_value_str_by_name(&i.attrs[],
2814                                                      "link_section") {
2815                 Some(sect) => {
2816                     if contains_null(sect.get()) {
2817                         ccx.sess().fatal(&format!("Illegal null byte in link_section value: `{}`",
2818                                                  sect.get())[]);
2819                     }
2820                     unsafe {
2821                         let buf = CString::from_slice(sect.get().as_bytes());
2822                         llvm::LLVMSetSection(v, buf.as_ptr());
2823                     }
2824                 },
2825                 None => ()
2826             }
2827
2828             v
2829         }
2830
2831         ast_map::NodeTraitItem(trait_method) => {
2832             debug!("get_item_val(): processing a NodeTraitItem");
2833             match *trait_method {
2834                 ast::RequiredMethod(_) | ast::TypeTraitItem(_) => {
2835                     ccx.sess().bug("unexpected variant: required trait \
2836                                     method in get_item_val()");
2837                 }
2838                 ast::ProvidedMethod(ref m) => {
2839                     register_method(ccx, id, &**m)
2840                 }
2841             }
2842         }
2843
2844         ast_map::NodeImplItem(ii) => {
2845             match *ii {
2846                 ast::MethodImplItem(ref m) => register_method(ccx, id, &**m),
2847                 ast::TypeImplItem(ref typedef) => {
2848                     ccx.sess().span_bug(typedef.span,
2849                                         "unexpected variant: required impl \
2850                                          method in get_item_val()")
2851                 }
2852             }
2853         }
2854
2855         ast_map::NodeForeignItem(ni) => {
2856             match ni.node {
2857                 ast::ForeignItemFn(..) => {
2858                     let abi = ccx.tcx().map.get_foreign_abi(id);
2859                     let ty = ty::node_id_to_type(ccx.tcx(), ni.id);
2860                     let name = foreign::link_name(&*ni);
2861                     foreign::register_foreign_item_fn(ccx, abi, ty, &name.get()[])
2862                 }
2863                 ast::ForeignItemStatic(..) => {
2864                     foreign::register_static(ccx, &*ni)
2865                 }
2866             }
2867         }
2868
2869         ast_map::NodeVariant(ref v) => {
2870             let llfn;
2871             let args = match v.node.kind {
2872                 ast::TupleVariantKind(ref args) => args,
2873                 ast::StructVariantKind(_) => {
2874                     panic!("struct variant kind unexpected in get_item_val")
2875                 }
2876             };
2877             assert!(args.len() != 0u);
2878             let ty = ty::node_id_to_type(ccx.tcx(), id);
2879             let parent = ccx.tcx().map.get_parent(id);
2880             let enm = ccx.tcx().map.expect_item(parent);
2881             let sym = exported_name(ccx,
2882                                     id,
2883                                     ty,
2884                                     &enm.attrs[]);
2885
2886             llfn = match enm.node {
2887                 ast::ItemEnum(_, _) => {
2888                     register_fn(ccx, (*v).span, sym, id, ty)
2889                 }
2890                 _ => panic!("NodeVariant, shouldn't happen")
2891             };
2892             set_inline_hint(llfn);
2893             llfn
2894         }
2895
2896         ast_map::NodeStructCtor(struct_def) => {
2897             // Only register the constructor if this is a tuple-like struct.
2898             let ctor_id = match struct_def.ctor_id {
2899                 None => {
2900                     ccx.sess().bug("attempt to register a constructor of \
2901                                     a non-tuple-like struct")
2902                 }
2903                 Some(ctor_id) => ctor_id,
2904             };
2905             let parent = ccx.tcx().map.get_parent(id);
2906             let struct_item = ccx.tcx().map.expect_item(parent);
2907             let ty = ty::node_id_to_type(ccx.tcx(), ctor_id);
2908             let sym = exported_name(ccx,
2909                                     id,
2910                                     ty,
2911                                     &struct_item.attrs[]);
2912             let llfn = register_fn(ccx, struct_item.span,
2913                                    sym, ctor_id, ty);
2914             set_inline_hint(llfn);
2915             llfn
2916         }
2917
2918         ref variant => {
2919             ccx.sess().bug(&format!("get_item_val(): unexpected variant: {:?}",
2920                                    variant)[])
2921         }
2922     };
2923
2924     // All LLVM globals and functions are initially created as external-linkage
2925     // declarations.  If `trans_item`/`trans_fn` later turns the declaration
2926     // into a definition, it adjusts the linkage then (using `update_linkage`).
2927     //
2928     // The exception is foreign items, which have their linkage set inside the
2929     // call to `foreign::register_*` above.  We don't touch the linkage after
2930     // that (`foreign::trans_foreign_mod` doesn't adjust the linkage like the
2931     // other item translation functions do).
2932
2933     ccx.item_vals().borrow_mut().insert(id, val);
2934     val
2935 }
2936
2937 fn register_method(ccx: &CrateContext, id: ast::NodeId,
2938                    m: &ast::Method) -> ValueRef {
2939     let mty = ty::node_id_to_type(ccx.tcx(), id);
2940
2941     let sym = exported_name(ccx, id, mty, &m.attrs[]);
2942
2943     let llfn = register_fn(ccx, m.span, sym, id, mty);
2944     set_llvm_fn_attrs(ccx, &m.attrs[], llfn);
2945     llfn
2946 }
2947
2948 pub fn crate_ctxt_to_encode_parms<'a, 'tcx>(cx: &'a SharedCrateContext<'tcx>,
2949                                             ie: encoder::EncodeInlinedItem<'a>)
2950                                             -> encoder::EncodeParams<'a, 'tcx> {
2951     encoder::EncodeParams {
2952         diag: cx.sess().diagnostic(),
2953         tcx: cx.tcx(),
2954         reexports: cx.export_map(),
2955         item_symbols: cx.item_symbols(),
2956         link_meta: cx.link_meta(),
2957         cstore: &cx.sess().cstore,
2958         encode_inlined_item: ie,
2959         reachable: cx.reachable(),
2960     }
2961 }
2962
2963 pub fn write_metadata(cx: &SharedCrateContext, krate: &ast::Crate) -> Vec<u8> {
2964     use flate;
2965
2966     let any_library = cx.sess().crate_types.borrow().iter().any(|ty| {
2967         *ty != config::CrateTypeExecutable
2968     });
2969     if !any_library {
2970         return Vec::new()
2971     }
2972
2973     let encode_inlined_item: encoder::EncodeInlinedItem =
2974         box |ecx, rbml_w, ii| astencode::encode_inlined_item(ecx, rbml_w, ii);
2975
2976     let encode_parms = crate_ctxt_to_encode_parms(cx, encode_inlined_item);
2977     let metadata = encoder::encode_metadata(encode_parms, krate);
2978     let mut compressed = encoder::metadata_encoding_version.to_vec();
2979     compressed.push_all(match flate::deflate_bytes(metadata.as_slice()) {
2980         Some(compressed) => compressed,
2981         None => cx.sess().fatal("failed to compress metadata"),
2982     }.as_slice());
2983     let llmeta = C_bytes_in_context(cx.metadata_llcx(), &compressed[]);
2984     let llconst = C_struct_in_context(cx.metadata_llcx(), &[llmeta], false);
2985     let name = format!("rust_metadata_{}_{}",
2986                        cx.link_meta().crate_name,
2987                        cx.link_meta().crate_hash);
2988     let buf = CString::from_vec(name.into_bytes());
2989     let llglobal = unsafe {
2990         llvm::LLVMAddGlobal(cx.metadata_llmod(), val_ty(llconst).to_ref(),
2991                             buf.as_ptr())
2992     };
2993     unsafe {
2994         llvm::LLVMSetInitializer(llglobal, llconst);
2995         let name = loader::meta_section_name(cx.sess().target.target.options.is_like_osx);
2996         let name = CString::from_slice(name.as_bytes());
2997         llvm::LLVMSetSection(llglobal, name.as_ptr())
2998     }
2999     return metadata;
3000 }
3001
3002 /// Find any symbols that are defined in one compilation unit, but not declared
3003 /// in any other compilation unit.  Give these symbols internal linkage.
3004 fn internalize_symbols(cx: &SharedCrateContext, reachable: &HashSet<String>) {
3005     unsafe {
3006         let mut declared = HashSet::new();
3007
3008         let iter_globals = |&: llmod| {
3009             ValueIter {
3010                 cur: llvm::LLVMGetFirstGlobal(llmod),
3011                 step: llvm::LLVMGetNextGlobal,
3012             }
3013         };
3014
3015         let iter_functions = |&: llmod| {
3016             ValueIter {
3017                 cur: llvm::LLVMGetFirstFunction(llmod),
3018                 step: llvm::LLVMGetNextFunction,
3019             }
3020         };
3021
3022         // Collect all external declarations in all compilation units.
3023         for ccx in cx.iter() {
3024             for val in iter_globals(ccx.llmod()).chain(iter_functions(ccx.llmod())) {
3025                 let linkage = llvm::LLVMGetLinkage(val);
3026                 // We only care about external declarations (not definitions)
3027                 // and available_externally definitions.
3028                 if !(linkage == llvm::ExternalLinkage as c_uint &&
3029                      llvm::LLVMIsDeclaration(val) != 0) &&
3030                    !(linkage == llvm::AvailableExternallyLinkage as c_uint) {
3031                     continue
3032                 }
3033
3034                 let name = ffi::c_str_to_bytes(&llvm::LLVMGetValueName(val))
3035                                .to_vec();
3036                 declared.insert(name);
3037             }
3038         }
3039
3040         // Examine each external definition.  If the definition is not used in
3041         // any other compilation unit, and is not reachable from other crates,
3042         // then give it internal linkage.
3043         for ccx in cx.iter() {
3044             for val in iter_globals(ccx.llmod()).chain(iter_functions(ccx.llmod())) {
3045                 // We only care about external definitions.
3046                 if !(llvm::LLVMGetLinkage(val) == llvm::ExternalLinkage as c_uint &&
3047                      llvm::LLVMIsDeclaration(val) == 0) {
3048                     continue
3049                 }
3050
3051                 let name = ffi::c_str_to_bytes(&llvm::LLVMGetValueName(val))
3052                                .to_vec();
3053                 if !declared.contains(&name) &&
3054                    !reachable.contains(str::from_utf8(name.as_slice()).unwrap()) {
3055                     llvm::SetLinkage(val, llvm::InternalLinkage);
3056                 }
3057             }
3058         }
3059     }
3060
3061
3062     struct ValueIter {
3063         cur: ValueRef,
3064         step: unsafe extern "C" fn(ValueRef) -> ValueRef,
3065     }
3066
3067     impl Iterator for ValueIter {
3068         type Item = ValueRef;
3069
3070         fn next(&mut self) -> Option<ValueRef> {
3071             let old = self.cur;
3072             if !old.is_null() {
3073                 self.cur = unsafe {
3074                     let step: unsafe extern "C" fn(ValueRef) -> ValueRef =
3075                         mem::transmute_copy(&self.step);
3076                     step(old)
3077                 };
3078                 Some(old)
3079             } else {
3080                 None
3081             }
3082         }
3083     }
3084 }
3085
3086 pub fn trans_crate<'tcx>(analysis: ty::CrateAnalysis<'tcx>)
3087                          -> (ty::ctxt<'tcx>, CrateTranslation) {
3088     let ty::CrateAnalysis { ty_cx: tcx, export_map, reachable, name, .. } = analysis;
3089     let krate = tcx.map.krate();
3090
3091     // Before we touch LLVM, make sure that multithreading is enabled.
3092     unsafe {
3093         use std::sync::{Once, ONCE_INIT};
3094         static INIT: Once = ONCE_INIT;
3095         static mut POISONED: bool = false;
3096         INIT.call_once(|| {
3097             if llvm::LLVMStartMultithreaded() != 1 {
3098                 // use an extra bool to make sure that all future usage of LLVM
3099                 // cannot proceed despite the Once not running more than once.
3100                 POISONED = true;
3101             }
3102         });
3103
3104         if POISONED {
3105             tcx.sess.bug("couldn't enable multi-threaded LLVM");
3106         }
3107     }
3108
3109     let link_meta = link::build_link_meta(&tcx.sess, krate, name);
3110
3111     let codegen_units = tcx.sess.opts.cg.codegen_units;
3112     let shared_ccx = SharedCrateContext::new(&link_meta.crate_name[],
3113                                              codegen_units,
3114                                              tcx,
3115                                              export_map,
3116                                              Sha256::new(),
3117                                              link_meta.clone(),
3118                                              reachable);
3119
3120     {
3121         let ccx = shared_ccx.get_ccx(0);
3122
3123         // First, verify intrinsics.
3124         intrinsic::check_intrinsics(&ccx);
3125
3126         // Next, translate the module.
3127         {
3128             let _icx = push_ctxt("text");
3129             trans_mod(&ccx, &krate.module);
3130         }
3131     }
3132
3133     for ccx in shared_ccx.iter() {
3134         glue::emit_tydescs(&ccx);
3135         if ccx.sess().opts.debuginfo != NoDebugInfo {
3136             debuginfo::finalize(&ccx);
3137         }
3138     }
3139
3140     // Translate the metadata.
3141     let metadata = write_metadata(&shared_ccx, krate);
3142
3143     if shared_ccx.sess().trans_stats() {
3144         let stats = shared_ccx.stats();
3145         println!("--- trans stats ---");
3146         println!("n_static_tydescs: {}", stats.n_static_tydescs.get());
3147         println!("n_glues_created: {}", stats.n_glues_created.get());
3148         println!("n_null_glues: {}", stats.n_null_glues.get());
3149         println!("n_real_glues: {}", stats.n_real_glues.get());
3150
3151         println!("n_fns: {}", stats.n_fns.get());
3152         println!("n_monos: {}", stats.n_monos.get());
3153         println!("n_inlines: {}", stats.n_inlines.get());
3154         println!("n_closures: {}", stats.n_closures.get());
3155         println!("fn stats:");
3156         stats.fn_stats.borrow_mut().sort_by(|&(_, insns_a), &(_, insns_b)| {
3157             insns_b.cmp(&insns_a)
3158         });
3159         for tuple in stats.fn_stats.borrow().iter() {
3160             match *tuple {
3161                 (ref name, insns) => {
3162                     println!("{} insns, {}", insns, *name);
3163                 }
3164             }
3165         }
3166     }
3167     if shared_ccx.sess().count_llvm_insns() {
3168         for (k, v) in shared_ccx.stats().llvm_insns.borrow().iter() {
3169             println!("{:7} {}", *v, *k);
3170         }
3171     }
3172
3173     let modules = shared_ccx.iter()
3174         .map(|ccx| ModuleTranslation { llcx: ccx.llcx(), llmod: ccx.llmod() })
3175         .collect();
3176
3177     let mut reachable: Vec<String> = shared_ccx.reachable().iter().filter_map(|id| {
3178         shared_ccx.item_symbols().borrow().get(id).map(|s| s.to_string())
3179     }).collect();
3180
3181     // For the purposes of LTO, we add to the reachable set all of the upstream
3182     // reachable extern fns. These functions are all part of the public ABI of
3183     // the final product, so LTO needs to preserve them.
3184     shared_ccx.sess().cstore.iter_crate_data(|cnum, _| {
3185         let syms = csearch::get_reachable_extern_fns(&shared_ccx.sess().cstore, cnum);
3186         reachable.extend(syms.into_iter().map(|did| {
3187             csearch::get_symbol(&shared_ccx.sess().cstore, did)
3188         }));
3189     });
3190
3191     // Make sure that some other crucial symbols are not eliminated from the
3192     // module. This includes the main function, the crate map (used for debug
3193     // log settings and I/O), and finally the curious rust_stack_exhausted
3194     // symbol. This symbol is required for use by the libmorestack library that
3195     // we link in, so we must ensure that this symbol is not internalized (if
3196     // defined in the crate).
3197     reachable.push("main".to_string());
3198     reachable.push("rust_stack_exhausted".to_string());
3199
3200     // referenced from .eh_frame section on some platforms
3201     reachable.push("rust_eh_personality".to_string());
3202     // referenced from rt/rust_try.ll
3203     reachable.push("rust_eh_personality_catch".to_string());
3204
3205     if codegen_units > 1 {
3206         internalize_symbols(&shared_ccx, &reachable.iter().map(|x| x.clone()).collect());
3207     }
3208
3209     let metadata_module = ModuleTranslation {
3210         llcx: shared_ccx.metadata_llcx(),
3211         llmod: shared_ccx.metadata_llmod(),
3212     };
3213     let formats = shared_ccx.tcx().dependency_formats.borrow().clone();
3214     let no_builtins = attr::contains_name(&krate.attrs[], "no_builtins");
3215
3216     let translation = CrateTranslation {
3217         modules: modules,
3218         metadata_module: metadata_module,
3219         link: link_meta,
3220         metadata: metadata,
3221         reachable: reachable,
3222         crate_formats: formats,
3223         no_builtins: no_builtins,
3224     };
3225
3226     (shared_ccx.take_tcx(), translation)
3227 }