src/librustc_codegen_llvm/mir/block.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 use llvm::{self, BasicBlock};
  12 use rustc::middle::lang_items;
  13 use rustc::ty::{self, Ty, TypeFoldable};
  14 use rustc::ty::layout::{self, LayoutOf};
  15 use rustc::mir;
  16 use rustc::mir::interpret::EvalErrorKind;
  17 use abi::{Abi, ArgType, ArgTypeExt, FnType, FnTypeExt, LlvmType, PassMode};
  18 use base;
  19 use callee;
  20 use builder::{Builder, MemFlags};
  21 use common::{self, C_bool, C_str_slice, C_struct, C_u32, C_uint_big, C_undef};
  22 use consts;
  23 use meth;
  24 use monomorphize;
  25 use type_of::LayoutLlvmExt;
  26 use type_::Type;
  27 use value::Value;
  28
  29 use syntax::symbol::Symbol;
  30 use syntax_pos::Pos;
  31
  32 use super::{FunctionCx, LocalRef};
  33 use super::place::PlaceRef;
  34 use super::operand::OperandRef;
  35 use super::operand::OperandValue::{Pair, Ref, Immediate};
  36
  37 impl FunctionCx<'a, 'll, 'tcx> {
  38     pub fn codegen_block(&mut self, bb: mir::BasicBlock) {
  39         let mut bx = self.build_block(bb);
  40         let data = &self.mir[bb];
  41
  42         debug!("codegen_block({:?}={:?})", bb, data);
  43
  44         for statement in &data.statements {
  45             bx = self.codegen_statement(bx, statement);
  46         }
  47
  48         self.codegen_terminator(bx, bb, data.terminator());
  49     }
  50
  51     fn codegen_terminator(&mut self,
  52                         mut bx: Builder<'a, 'll, 'tcx>,
  53                         bb: mir::BasicBlock,
  54                         terminator: &mir::Terminator<'tcx>)
  55     {
  56         debug!("codegen_terminator: {:?}", terminator);
  57
  58         // Create the cleanup bundle, if needed.
  59         let tcx = bx.tcx();
  60         let span = terminator.source_info.span;
  61         let funclet_bb = self.cleanup_kinds[bb].funclet_bb(bb);
  62         let funclet = funclet_bb.and_then(|funclet_bb| self.funclets[funclet_bb].as_ref());
  63
  64         let cleanup_pad = funclet.map(|lp| lp.cleanuppad());
  65         let cleanup_bundle = funclet.map(|l| l.bundle());
  66
  67         let lltarget = |this: &mut Self, target: mir::BasicBlock| {
  68             let lltarget = this.blocks[target];
  69             let target_funclet = this.cleanup_kinds[target].funclet_bb(target);
  70             match (funclet_bb, target_funclet) {
  71                 (None, None) => (lltarget, false),
  72                 (Some(f), Some(t_f))
  73                     if f == t_f || !base::wants_msvc_seh(tcx.sess)
  74                     => (lltarget, false),
  75                 (None, Some(_)) => {
  76                     // jump *into* cleanup - need a landing pad if GNU
  77                     (this.landing_pad_to(target), false)
  78                 }
  79                 (Some(_), None) => span_bug!(span, "{:?} - jump out of cleanup?", terminator),
  80                 (Some(_), Some(_)) => {
  81                     (this.landing_pad_to(target), true)
  82                 }
  83             }
  84         };
  85
  86         let llblock = |this: &mut Self, target: mir::BasicBlock| {
  87             let (lltarget, is_cleanupret) = lltarget(this, target);
  88             if is_cleanupret {
  89                 // MSVC cross-funclet jump - need a trampoline
  90
  91                 debug!("llblock: creating cleanup trampoline for {:?}", target);
  92                 let name = &format!("{:?}_cleanup_trampoline_{:?}", bb, target);
  93                 let trampoline = this.new_block(name);
  94                 trampoline.cleanup_ret(cleanup_pad.unwrap(), Some(lltarget));
  95                 trampoline.llbb()
  96             } else {
  97                 lltarget
  98             }
  99         };
 100
 101         let funclet_br = |this: &mut Self, bx: Builder<'_, 'll, '_>, target: mir::BasicBlock| {
 102             let (lltarget, is_cleanupret) = lltarget(this, target);
 103             if is_cleanupret {
 104                 // micro-optimization: generate a `ret` rather than a jump
 105                 // to a trampoline.
 106                 bx.cleanup_ret(cleanup_pad.unwrap(), Some(lltarget));
 107             } else {
 108                 bx.br(lltarget);
 109             }
 110         };
 111
 112         let do_call = |
 113             this: &mut Self,
 114             bx: Builder<'a, 'll, 'tcx>,
 115             fn_ty: FnType<'tcx, Ty<'tcx>>,
 116             fn_ptr: &'ll Value,
 117             llargs: &[&'ll Value],
 118             destination: Option<(ReturnDest<'ll, 'tcx>, mir::BasicBlock)>,
 119             cleanup: Option<mir::BasicBlock>
 120         | {
 121             if let Some(cleanup) = cleanup {
 122                 let ret_bx = if let Some((_, target)) = destination {
 123                     this.blocks[target]
 124                 } else {
 125                     this.unreachable_block()
 126                 };
 127                 let invokeret = bx.invoke(fn_ptr,
 128                                            &llargs,
 129                                            ret_bx,
 130                                            llblock(this, cleanup),
 131                                            cleanup_bundle);
 132                 fn_ty.apply_attrs_callsite(&bx, invokeret);
 133
 134                 if let Some((ret_dest, target)) = destination {
 135                     let ret_bx = this.build_block(target);
 136                     this.set_debug_loc(&ret_bx, terminator.source_info);
 137                     this.store_return(&ret_bx, ret_dest, &fn_ty.ret, invokeret);
 138                 }
 139             } else {
 140                 let llret = bx.call(fn_ptr, &llargs, cleanup_bundle);
 141                 fn_ty.apply_attrs_callsite(&bx, llret);
 142                 if this.mir[bb].is_cleanup {
 143                     // Cleanup is always the cold path. Don't inline
 144                     // drop glue. Also, when there is a deeply-nested
 145                     // struct, there are "symmetry" issues that cause
 146                     // exponential inlining - see issue #41696.
 147                     llvm::Attribute::NoInline.apply_callsite(llvm::AttributePlace::Function, llret);
 148                 }
 149
 150                 if let Some((ret_dest, target)) = destination {
 151                     this.store_return(&bx, ret_dest, &fn_ty.ret, llret);
 152                     funclet_br(this, bx, target);
 153                 } else {
 154                     bx.unreachable();
 155                 }
 156             }
 157         };
 158
 159         self.set_debug_loc(&bx, terminator.source_info);
 160         match terminator.kind {
 161             mir::TerminatorKind::Resume => {
 162                 if let Some(cleanup_pad) = cleanup_pad {
 163                     bx.cleanup_ret(cleanup_pad, None);
 164                 } else {
 165                     let slot = self.get_personality_slot(&bx);
 166                     let lp0 = slot.project_field(&bx, 0).load(&bx).immediate();
 167                     let lp1 = slot.project_field(&bx, 1).load(&bx).immediate();
 168                     slot.storage_dead(&bx);
 169
 170                     if !bx.sess().target.target.options.custom_unwind_resume {
 171                         let mut lp = C_undef(self.landing_pad_type());
 172                         lp = bx.insert_value(lp, lp0, 0);
 173                         lp = bx.insert_value(lp, lp1, 1);
 174                         bx.resume(lp);
 175                     } else {
 176                         bx.call(bx.cx.eh_unwind_resume(), &[lp0], cleanup_bundle);
 177                         bx.unreachable();
 178                     }
 179                 }
 180             }
 181
 182             mir::TerminatorKind::Abort => {
 183                 // Call core::intrinsics::abort()
 184                 let fnname = bx.cx.get_intrinsic(&("llvm.trap"));
 185                 bx.call(fnname, &[], None);
 186                 bx.unreachable();
 187             }
 188
 189             mir::TerminatorKind::Goto { target } => {
 190                 funclet_br(self, bx, target);
 191             }
 192
 193             mir::TerminatorKind::SwitchInt { ref discr, switch_ty, ref values, ref targets } => {
 194                 let discr = self.codegen_operand(&bx, discr);
 195                 if targets.len() == 2 {
 196                     // If there are two targets, emit br instead of switch
 197                     let lltrue = llblock(self, targets[0]);
 198                     let llfalse = llblock(self, targets[1]);
 199                     if switch_ty == bx.tcx().types.bool {
 200                         // Don't generate trivial icmps when switching on bool
 201                         if let [0] = values[..] {
 202                             bx.cond_br(discr.immediate(), llfalse, lltrue);
 203                         } else {
 204                             assert_eq!(&values[..], &[1]);
 205                             bx.cond_br(discr.immediate(), lltrue, llfalse);
 206                         }
 207                     } else {
 208                         let switch_llty = bx.cx.layout_of(switch_ty).immediate_llvm_type(bx.cx);
 209                         let llval = C_uint_big(switch_llty, values[0]);
 210                         let cmp = bx.icmp(llvm::IntEQ, discr.immediate(), llval);
 211                         bx.cond_br(cmp, lltrue, llfalse);
 212                     }
 213                 } else {
 214                     let (otherwise, targets) = targets.split_last().unwrap();
 215                     let switch = bx.switch(discr.immediate(),
 216                                             llblock(self, *otherwise), values.len());
 217                     let switch_llty = bx.cx.layout_of(switch_ty).immediate_llvm_type(bx.cx);
 218                     for (&value, target) in values.iter().zip(targets) {
 219                         let llval = C_uint_big(switch_llty, value);
 220                         let llbb = llblock(self, *target);
 221                         bx.add_case(switch, llval, llbb)
 222                     }
 223                 }
 224             }
 225
 226             mir::TerminatorKind::Return => {
 227                 let llval = match self.fn_ty.ret.mode {
 228                     PassMode::Ignore | PassMode::Indirect(..) => {
 229                         bx.ret_void();
 230                         return;
 231                     }
 232
 233                     PassMode::Direct(_) | PassMode::Pair(..) => {
 234                         let op = self.codegen_consume(&bx, &mir::Place::Local(mir::RETURN_PLACE));
 235                         if let Ref(llval, _, align) = op.val {
 236                             bx.load(llval, align)
 237                         } else {
 238                             op.immediate_or_packed_pair(&bx)
 239                         }
 240                     }
 241
 242                     PassMode::Cast(cast_ty) => {
 243                         let op = match self.locals[mir::RETURN_PLACE] {
 244                             LocalRef::Operand(Some(op)) => op,
 245                             LocalRef::Operand(None) => bug!("use of return before def"),
 246                             LocalRef::Place(cg_place) => {
 247                                 OperandRef {
 248                                     val: Ref(cg_place.llval, None, cg_place.align),
 249                                     layout: cg_place.layout
 250                                 }
 251                             }
 252                             LocalRef::UnsizedPlace(_) => bug!("return type must be sized"),
 253                         };
 254                         let llslot = match op.val {
 255                             Immediate(_) | Pair(..) => {
 256                                 let scratch = PlaceRef::alloca(&bx, self.fn_ty.ret.layout, "ret");
 257                                 op.val.store(&bx, scratch);
 258                                 scratch.llval
 259                             }
 260                             Ref(llval, _, align) => {
 261                                 assert_eq!(align.abi(), op.layout.align.abi(),
 262                                            "return place is unaligned!");
 263                                 llval
 264                             }
 265                         };
 266                         bx.load(
 267                             bx.pointercast(llslot, cast_ty.llvm_type(bx.cx).ptr_to()),
 268                             self.fn_ty.ret.layout.align)
 269                     }
 270                 };
 271                 bx.ret(llval);
 272             }
 273
 274             mir::TerminatorKind::Unreachable => {
 275                 bx.unreachable();
 276             }
 277
 278             mir::TerminatorKind::Drop { ref location, target, unwind } => {
 279                 let ty = location.ty(self.mir, bx.tcx()).to_ty(bx.tcx());
 280                 let ty = self.monomorphize(&ty);
 281                 let drop_fn = monomorphize::resolve_drop_in_place(bx.cx.tcx, ty);
 282
 283                 if let ty::InstanceDef::DropGlue(_, None) = drop_fn.def {
 284                     // we don't actually need to drop anything.
 285                     funclet_br(self, bx, target);
 286                     return
 287                 }
 288
 289                 let place = self.codegen_place(&bx, location);
 290                 let (args1, args2);
 291                 let mut args = if let Some(llextra) = place.llextra {
 292                     args2 = [place.llval, llextra];
 293                     &args2[..]
 294                 } else {
 295                     args1 = [place.llval];
 296                     &args1[..]
 297                 };
 298                 let (drop_fn, fn_ty) = match ty.sty {
 299                     ty::Dynamic(..) => {
 300                         let fn_ty = drop_fn.ty(bx.cx.tcx);
 301                         let sig = common::ty_fn_sig(bx.cx, fn_ty);
 302                         let sig = bx.tcx().normalize_erasing_late_bound_regions(
 303                             ty::ParamEnv::reveal_all(),
 304                             &sig,
 305                         );
 306                         let fn_ty = FnType::new_vtable(bx.cx, sig, &[]);
 307                         let vtable = args[1];
 308                         args = &args[..1];
 309                         (meth::DESTRUCTOR.get_fn(&bx, vtable, &fn_ty), fn_ty)
 310                     }
 311                     _ => {
 312                         (callee::get_fn(bx.cx, drop_fn),
 313                          FnType::of_instance(bx.cx, &drop_fn))
 314                     }
 315                 };
 316                 do_call(self, bx, fn_ty, drop_fn, args,
 317                         Some((ReturnDest::Nothing, target)),
 318                         unwind);
 319             }
 320
 321             mir::TerminatorKind::Assert { ref cond, expected, ref msg, target, cleanup } => {
 322                 let cond = self.codegen_operand(&bx, cond).immediate();
 323                 let mut const_cond = common::const_to_opt_u128(cond, false).map(|c| c == 1);
 324
 325                 // This case can currently arise only from functions marked
 326                 // with #[rustc_inherit_overflow_checks] and inlined from
 327                 // another crate (mostly core::num generic/#[inline] fns),
 328                 // while the current crate doesn't use overflow checks.
 329                 // NOTE: Unlike binops, negation doesn't have its own
 330                 // checked operation, just a comparison with the minimum
 331                 // value, so we have to check for the assert message.
 332                 if !bx.cx.check_overflow {
 333                     if let mir::interpret::EvalErrorKind::OverflowNeg = *msg {
 334                         const_cond = Some(expected);
 335                     }
 336                 }
 337
 338                 // Don't codegen the panic block if success if known.
 339                 if const_cond == Some(expected) {
 340                     funclet_br(self, bx, target);
 341                     return;
 342                 }
 343
 344                 // Pass the condition through llvm.expect for branch hinting.
 345                 let expect = bx.cx.get_intrinsic(&"llvm.expect.i1");
 346                 let cond = bx.call(expect, &[cond, C_bool(bx.cx, expected)], None);
 347
 348                 // Create the failure block and the conditional branch to it.
 349                 let lltarget = llblock(self, target);
 350                 let panic_block = self.new_block("panic");
 351                 if expected {
 352                     bx.cond_br(cond, lltarget, panic_block.llbb());
 353                 } else {
 354                     bx.cond_br(cond, panic_block.llbb(), lltarget);
 355                 }
 356
 357                 // After this point, bx is the block for the call to panic.
 358                 bx = panic_block;
 359                 self.set_debug_loc(&bx, terminator.source_info);
 360
 361                 // Get the location information.
 362                 let loc = bx.sess().source_map().lookup_char_pos(span.lo());
 363                 let filename = Symbol::intern(&loc.file.name.to_string()).as_str();
 364                 let filename = C_str_slice(bx.cx, filename);
 365                 let line = C_u32(bx.cx, loc.line as u32);
 366                 let col = C_u32(bx.cx, loc.col.to_usize() as u32 + 1);
 367                 let align = tcx.data_layout.aggregate_align
 368                     .max(tcx.data_layout.i32_align)
 369                     .max(tcx.data_layout.pointer_align);
 370
 371                 // Put together the arguments to the panic entry point.
 372                 let (lang_item, args) = match *msg {
 373                     EvalErrorKind::BoundsCheck { ref len, ref index } => {
 374                         let len = self.codegen_operand(&mut bx, len).immediate();
 375                         let index = self.codegen_operand(&mut bx, index).immediate();
 376
 377                         let file_line_col = C_struct(bx.cx, &[filename, line, col], false);
 378                         let file_line_col = consts::addr_of(bx.cx,
 379                                                             file_line_col,
 380                                                             align,
 381                                                             Some("panic_bounds_check_loc"));
 382                         (lang_items::PanicBoundsCheckFnLangItem,
 383                          vec![file_line_col, index, len])
 384                     }
 385                     _ => {
 386                         let str = msg.description();
 387                         let msg_str = Symbol::intern(str).as_str();
 388                         let msg_str = C_str_slice(bx.cx, msg_str);
 389                         let msg_file_line_col = C_struct(bx.cx,
 390                                                      &[msg_str, filename, line, col],
 391                                                      false);
 392                         let msg_file_line_col = consts::addr_of(bx.cx,
 393                                                                 msg_file_line_col,
 394                                                                 align,
 395                                                                 Some("panic_loc"));
 396                         (lang_items::PanicFnLangItem,
 397                          vec![msg_file_line_col])
 398                     }
 399                 };
 400
 401                 // Obtain the panic entry point.
 402                 let def_id = common::langcall(bx.tcx(), Some(span), "", lang_item);
 403                 let instance = ty::Instance::mono(bx.tcx(), def_id);
 404                 let fn_ty = FnType::of_instance(bx.cx, &instance);
 405                 let llfn = callee::get_fn(bx.cx, instance);
 406
 407                 // Codegen the actual panic invoke/call.
 408                 do_call(self, bx, fn_ty, llfn, &args, None, cleanup);
 409             }
 410
 411             mir::TerminatorKind::DropAndReplace { .. } => {
 412                 bug!("undesugared DropAndReplace in codegen: {:?}", terminator);
 413             }
 414
 415             mir::TerminatorKind::Call { ref func, ref args, ref destination, cleanup } => {
 416                 // Create the callee. This is a fn ptr or zero-sized and hence a kind of scalar.
 417                 let callee = self.codegen_operand(&bx, func);
 418
 419                 let (instance, mut llfn) = match callee.layout.ty.sty {
 420                     ty::FnDef(def_id, substs) => {
 421                         (Some(ty::Instance::resolve(bx.cx.tcx,
 422                                                     ty::ParamEnv::reveal_all(),
 423                                                     def_id,
 424                                                     substs).unwrap()),
 425                          None)
 426                     }
 427                     ty::FnPtr(_) => {
 428                         (None, Some(callee.immediate()))
 429                     }
 430                     _ => bug!("{} is not callable", callee.layout.ty)
 431                 };
 432                 let def = instance.map(|i| i.def);
 433                 let sig = callee.layout.ty.fn_sig(bx.tcx());
 434                 let sig = bx.tcx().normalize_erasing_late_bound_regions(
 435                     ty::ParamEnv::reveal_all(),
 436                     &sig,
 437                 );
 438                 let abi = sig.abi;
 439
 440                 // Handle intrinsics old codegen wants Expr's for, ourselves.
 441                 let intrinsic = match def {
 442                     Some(ty::InstanceDef::Intrinsic(def_id))
 443                         => Some(bx.tcx().item_name(def_id).as_str()),
 444                     _ => None
 445                 };
 446                 let intrinsic = intrinsic.as_ref().map(|s| &s[..]);
 447
 448                 if intrinsic == Some("transmute") {
 449                     if let Some(destination_ref) = destination.as_ref() {
 450                         let &(ref dest, target) = destination_ref;
 451                         self.codegen_transmute(&bx, &args[0], dest);
 452                         funclet_br(self, bx, target);
 453                     } else {
 454                         // If we are trying to transmute to an uninhabited type,
 455                         // it is likely there is no allotted destination. In fact,
 456                         // transmuting to an uninhabited type is UB, which means
 457                         // we can do what we like. Here, we declare that transmuting
 458                         // into an uninhabited type is impossible, so anything following
 459                         // it must be unreachable.
 460                         assert_eq!(bx.cx.layout_of(sig.output()).abi, layout::Abi::Uninhabited);
 461                         bx.unreachable();
 462                     }
 463                     return;
 464                 }
 465
 466                 if (intrinsic == Some("init") || intrinsic == Some("uninit")) &&
 467                     bx.cx.layout_of(sig.output()).abi.is_uninhabited()
 468                 {
 469                     let loc = bx.sess().codemap().lookup_char_pos(span.lo());
 470                     let filename = Symbol::intern(&loc.file.name.to_string()).as_str();
 471                     let filename = C_str_slice(bx.cx, filename);
 472                     let line = C_u32(bx.cx, loc.line as u32);
 473                     let col = C_u32(bx.cx, loc.col.to_usize() as u32 + 1);
 474                     let align = tcx.data_layout.aggregate_align
 475                         .max(tcx.data_layout.i32_align)
 476                         .max(tcx.data_layout.pointer_align);
 477
 478                     let str = format!(
 479                         "Attempted to instantiate uninhabited type {} using mem::{}",
 480                         sig.output(),
 481                         if intrinsic == Some("init") { "zeroed" } else { "uninitialized" }
 482                     );
 483                     let msg_str = Symbol::intern(&str).as_str();
 484                     let msg_str = C_str_slice(bx.cx, msg_str);
 485                     let msg_file_line_col = C_struct(bx.cx,
 486                                                     &[msg_str, filename, line, col],
 487                                                     false);
 488                     let msg_file_line_col = consts::addr_of(bx.cx,
 489                                                             msg_file_line_col,
 490                                                             align,
 491                                                             Some("panic_loc"));
 492
 493                     // Obtain the panic entry point.
 494                     let def_id =
 495                         common::langcall(bx.tcx(), Some(span), "", lang_items::PanicFnLangItem);
 496                     let instance = ty::Instance::mono(bx.tcx(), def_id);
 497                     let fn_ty = FnType::of_instance(bx.cx, &instance);
 498                     let llfn = callee::get_fn(bx.cx, instance);
 499
 500                     // Codegen the actual panic invoke/call.
 501                     do_call(
 502                         self,
 503                         bx,
 504                         fn_ty,
 505                         llfn,
 506                         &[msg_file_line_col],
 507                         destination.as_ref().map(|(_, bb)| (ReturnDest::Nothing, *bb)),
 508                         cleanup,
 509                     );
 510                     return;
 511                 }
 512
 513                 let extra_args = &args[sig.inputs().len()..];
 514                 let extra_args = extra_args.iter().map(|op_arg| {
 515                     let op_ty = op_arg.ty(self.mir, bx.tcx());
 516                     self.monomorphize(&op_ty)
 517                 }).collect::<Vec<_>>();
 518
 519                 let fn_ty = match def {
 520                     Some(ty::InstanceDef::Virtual(..)) => {
 521                         FnType::new_vtable(bx.cx, sig, &extra_args)
 522                     }
 523                     Some(ty::InstanceDef::DropGlue(_, None)) => {
 524                         // empty drop glue - a nop.
 525                         let &(_, target) = destination.as_ref().unwrap();
 526                         funclet_br(self, bx, target);
 527                         return;
 528                     }
 529                     _ => FnType::new(bx.cx, sig, &extra_args)
 530                 };
 531
 532                 // The arguments we'll be passing. Plus one to account for outptr, if used.
 533                 let arg_count = fn_ty.args.len() + fn_ty.ret.is_indirect() as usize;
 534                 let mut llargs = Vec::with_capacity(arg_count);
 535
 536                 // Prepare the return value destination
 537                 let ret_dest = if let Some((ref dest, _)) = *destination {
 538                     let is_intrinsic = intrinsic.is_some();
 539                     self.make_return_dest(&bx, dest, &fn_ty.ret, &mut llargs,
 540                                           is_intrinsic)
 541                 } else {
 542                     ReturnDest::Nothing
 543                 };
 544
 545                 if intrinsic.is_some() && intrinsic != Some("drop_in_place") {
 546                     use intrinsic::codegen_intrinsic_call;
 547
 548                     let dest = match ret_dest {
 549                         _ if fn_ty.ret.is_indirect() => llargs[0],
 550                         ReturnDest::Nothing => {
 551                             C_undef(fn_ty.ret.memory_ty(bx.cx).ptr_to())
 552                         }
 553                         ReturnDest::IndirectOperand(dst, _) |
 554                         ReturnDest::Store(dst) => dst.llval,
 555                         ReturnDest::DirectOperand(_) =>
 556                             bug!("Cannot use direct operand with an intrinsic call")
 557                     };
 558
 559                     let args: Vec<_> = args.iter().enumerate().map(|(i, arg)| {
 560                         // The indices passed to simd_shuffle* in the
 561                         // third argument must be constant. This is
 562                         // checked by const-qualification, which also
 563                         // promotes any complex rvalues to constants.
 564                         if i == 2 && intrinsic.unwrap().starts_with("simd_shuffle") {
 565                             match *arg {
 566                                 // The shuffle array argument is usually not an explicit constant,
 567                                 // but specified directly in the code. This means it gets promoted
 568                                 // and we can then extract the value by evaluating the promoted.
 569                                 mir::Operand::Copy(mir::Place::Promoted(box(index, ty))) |
 570                                 mir::Operand::Move(mir::Place::Promoted(box(index, ty))) => {
 571                                     let param_env = ty::ParamEnv::reveal_all();
 572                                     let cid = mir::interpret::GlobalId {
 573                                         instance: self.instance,
 574                                         promoted: Some(index),
 575                                     };
 576                                     let c = bx.tcx().const_eval(param_env.and(cid));
 577                                     let (llval, ty) = self.simd_shuffle_indices(
 578                                         &bx,
 579                                         terminator.source_info.span,
 580                                         ty,
 581                                         c,
 582                                     );
 583                                     return OperandRef {
 584                                         val: Immediate(llval),
 585                                         layout: bx.cx.layout_of(ty),
 586                                     };
 587
 588                                 },
 589                                 mir::Operand::Copy(_) |
 590                                 mir::Operand::Move(_) => {
 591                                     span_bug!(span, "shuffle indices must be constant");
 592                                 }
 593                                 mir::Operand::Constant(ref constant) => {
 594                                     let c = self.eval_mir_constant(&bx, constant);
 595                                     let (llval, ty) = self.simd_shuffle_indices(
 596                                         &bx,
 597                                         constant.span,
 598                                         constant.ty,
 599                                         c,
 600                                     );
 601                                     return OperandRef {
 602                                         val: Immediate(llval),
 603                                         layout: bx.cx.layout_of(ty)
 604                                     };
 605                                 }
 606                             }
 607                         }
 608
 609                         self.codegen_operand(&bx, arg)
 610                     }).collect();
 611
 612
 613                     let callee_ty = instance.as_ref().unwrap().ty(bx.cx.tcx);
 614                     codegen_intrinsic_call(&bx, callee_ty, &fn_ty, &args, dest,
 615                                          terminator.source_info.span);
 616
 617                     if let ReturnDest::IndirectOperand(dst, _) = ret_dest {
 618                         self.store_return(&bx, ret_dest, &fn_ty.ret, dst.llval);
 619                     }
 620
 621                     if let Some((_, target)) = *destination {
 622                         funclet_br(self, bx, target);
 623                     } else {
 624                         bx.unreachable();
 625                     }
 626
 627                     return;
 628                 }
 629
 630                 // Split the rust-call tupled arguments off.
 631                 let (first_args, untuple) = if abi == Abi::RustCall && !args.is_empty() {
 632                     let (tup, args) = args.split_last().unwrap();
 633                     (args, Some(tup))
 634                 } else {
 635                     (&args[..], None)
 636                 };
 637
 638                 for (i, arg) in first_args.iter().enumerate() {
 639                     let mut op = self.codegen_operand(&bx, arg);
 640                     if let (0, Some(ty::InstanceDef::Virtual(_, idx))) = (i, def) {
 641                         if let Pair(data_ptr, meta) = op.val {
 642                             llfn = Some(meth::VirtualIndex::from_index(idx)
 643                                 .get_fn(&bx, meta, &fn_ty));
 644                             llargs.push(data_ptr);
 645                             continue;
 646                         }
 647                     }
 648
 649                     // The callee needs to own the argument memory if we pass it
 650                     // by-ref, so make a local copy of non-immediate constants.
 651                     match (arg, op.val) {
 652                         (&mir::Operand::Copy(_), Ref(_, None, _)) |
 653                         (&mir::Operand::Constant(_), Ref(_, None, _)) => {
 654                             let tmp = PlaceRef::alloca(&bx, op.layout, "const");
 655                             op.val.store(&bx, tmp);
 656                             op.val = Ref(tmp.llval, None, tmp.align);
 657                         }
 658                         _ => {}
 659                     }
 660
 661                     self.codegen_argument(&bx, op, &mut llargs, &fn_ty.args[i]);
 662                 }
 663                 if let Some(tup) = untuple {
 664                     self.codegen_arguments_untupled(&bx, tup, &mut llargs,
 665                         &fn_ty.args[first_args.len()..])
 666                 }
 667
 668                 let fn_ptr = match (llfn, instance) {
 669                     (Some(llfn), _) => llfn,
 670                     (None, Some(instance)) => callee::get_fn(bx.cx, instance),
 671                     _ => span_bug!(span, "no llfn for call"),
 672                 };
 673
 674                 do_call(self, bx, fn_ty, fn_ptr, &llargs,
 675                         destination.as_ref().map(|&(_, target)| (ret_dest, target)),
 676                         cleanup);
 677             }
 678             mir::TerminatorKind::GeneratorDrop |
 679             mir::TerminatorKind::Yield { .. } => bug!("generator ops in codegen"),
 680             mir::TerminatorKind::FalseEdges { .. } |
 681             mir::TerminatorKind::FalseUnwind { .. } => bug!("borrowck false edges in codegen"),
 682         }
 683     }
 684
 685     fn codegen_argument(&mut self,
 686                       bx: &Builder<'a, 'll, 'tcx>,
 687                       op: OperandRef<'ll, 'tcx>,
 688                       llargs: &mut Vec<&'ll Value>,
 689                       arg: &ArgType<'tcx, Ty<'tcx>>) {
 690         // Fill padding with undef value, where applicable.
 691         if let Some(ty) = arg.pad {
 692             llargs.push(C_undef(ty.llvm_type(bx.cx)));
 693         }
 694
 695         if arg.is_ignore() {
 696             return;
 697         }
 698
 699         if let PassMode::Pair(..) = arg.mode {
 700             match op.val {
 701                 Pair(a, b) => {
 702                     llargs.push(a);
 703                     llargs.push(b);
 704                     return;
 705                 }
 706                 _ => bug!("codegen_argument: {:?} invalid for pair argument", op)
 707             }
 708         } else if arg.is_unsized_indirect() {
 709             match op.val {
 710                 Ref(a, Some(b), _) => {
 711                     llargs.push(a);
 712                     llargs.push(b);
 713                     return;
 714                 }
 715                 _ => bug!("codegen_argument: {:?} invalid for unsized indirect argument", op)
 716             }
 717         }
 718
 719         // Force by-ref if we have to load through a cast pointer.
 720         let (mut llval, align, by_ref) = match op.val {
 721             Immediate(_) | Pair(..) => {
 722                 match arg.mode {
 723                     PassMode::Indirect(..) | PassMode::Cast(_) => {
 724                         let scratch = PlaceRef::alloca(bx, arg.layout, "arg");
 725                         op.val.store(bx, scratch);
 726                         (scratch.llval, scratch.align, true)
 727                     }
 728                     _ => {
 729                         (op.immediate_or_packed_pair(bx), arg.layout.align, false)
 730                     }
 731                 }
 732             }
 733             Ref(llval, _, align) => {
 734                 if arg.is_indirect() && align.abi() < arg.layout.align.abi() {
 735                     // `foo(packed.large_field)`. We can't pass the (unaligned) field directly. I
 736                     // think that ATM (Rust 1.16) we only pass temporaries, but we shouldn't
 737                     // have scary latent bugs around.
 738
 739                     let scratch = PlaceRef::alloca(bx, arg.layout, "arg");
 740                     base::memcpy_ty(bx, scratch.llval, llval, op.layout, align, MemFlags::empty());
 741                     (scratch.llval, scratch.align, true)
 742                 } else {
 743                     (llval, align, true)
 744                 }
 745             }
 746         };
 747
 748         if by_ref && !arg.is_indirect() {
 749             // Have to load the argument, maybe while casting it.
 750             if let PassMode::Cast(ty) = arg.mode {
 751                 llval = bx.load(bx.pointercast(llval, ty.llvm_type(bx.cx).ptr_to()),
 752                                  align.min(arg.layout.align));
 753             } else {
 754                 // We can't use `PlaceRef::load` here because the argument
 755                 // may have a type we don't treat as immediate, but the ABI
 756                 // used for this call is passing it by-value. In that case,
 757                 // the load would just produce `OperandValue::Ref` instead
 758                 // of the `OperandValue::Immediate` we need for the call.
 759                 llval = bx.load(llval, align);
 760                 if let layout::Abi::Scalar(ref scalar) = arg.layout.abi {
 761                     if scalar.is_bool() {
 762                         bx.range_metadata(llval, 0..2);
 763                     }
 764                 }
 765                 // We store bools as i8 so we need to truncate to i1.
 766                 llval = base::to_immediate(bx, llval, arg.layout);
 767             }
 768         }
 769
 770         llargs.push(llval);
 771     }
 772
 773     fn codegen_arguments_untupled(&mut self,
 774                                 bx: &Builder<'a, 'll, 'tcx>,
 775                                 operand: &mir::Operand<'tcx>,
 776                                 llargs: &mut Vec<&'ll Value>,
 777                                 args: &[ArgType<'tcx, Ty<'tcx>>]) {
 778         let tuple = self.codegen_operand(bx, operand);
 779
 780         // Handle both by-ref and immediate tuples.
 781         if let Ref(llval, None, align) = tuple.val {
 782             let tuple_ptr = PlaceRef::new_sized(llval, tuple.layout, align);
 783             for i in 0..tuple.layout.fields.count() {
 784                 let field_ptr = tuple_ptr.project_field(bx, i);
 785                 self.codegen_argument(bx, field_ptr.load(bx), llargs, &args[i]);
 786             }
 787         } else if let Ref(_, Some(_), _) = tuple.val {
 788             bug!("closure arguments must be sized")
 789         } else {
 790             // If the tuple is immediate, the elements are as well.
 791             for i in 0..tuple.layout.fields.count() {
 792                 let op = tuple.extract_field(bx, i);
 793                 self.codegen_argument(bx, op, llargs, &args[i]);
 794             }
 795         }
 796     }
 797
 798     fn get_personality_slot(&mut self, bx: &Builder<'a, 'll, 'tcx>) -> PlaceRef<'ll, 'tcx> {
 799         let cx = bx.cx;
 800         if let Some(slot) = self.personality_slot {
 801             slot
 802         } else {
 803             let layout = cx.layout_of(cx.tcx.intern_tup(&[
 804                 cx.tcx.mk_mut_ptr(cx.tcx.types.u8),
 805                 cx.tcx.types.i32
 806             ]));
 807             let slot = PlaceRef::alloca(bx, layout, "personalityslot");
 808             self.personality_slot = Some(slot);
 809             slot
 810         }
 811     }
 812
 813     /// Return the landingpad wrapper around the given basic block
 814     ///
 815     /// No-op in MSVC SEH scheme.
 816     fn landing_pad_to(&mut self, target_bb: mir::BasicBlock) -> &'ll BasicBlock {
 817         if let Some(block) = self.landing_pads[target_bb] {
 818             return block;
 819         }
 820
 821         let block = self.blocks[target_bb];
 822         let landing_pad = self.landing_pad_uncached(block);
 823         self.landing_pads[target_bb] = Some(landing_pad);
 824         landing_pad
 825     }
 826
 827     fn landing_pad_uncached(&mut self, target_bb: &'ll BasicBlock) -> &'ll BasicBlock {
 828         if base::wants_msvc_seh(self.cx.sess()) {
 829             span_bug!(self.mir.span, "landing pad was not inserted?")
 830         }
 831
 832         let bx = self.new_block("cleanup");
 833
 834         let llpersonality = self.cx.eh_personality();
 835         let llretty = self.landing_pad_type();
 836         let lp = bx.landing_pad(llretty, llpersonality, 1);
 837         bx.set_cleanup(lp);
 838
 839         let slot = self.get_personality_slot(&bx);
 840         slot.storage_live(&bx);
 841         Pair(bx.extract_value(lp, 0), bx.extract_value(lp, 1)).store(&bx, slot);
 842
 843         bx.br(target_bb);
 844         bx.llbb()
 845     }
 846
 847     fn landing_pad_type(&self) -> &'ll Type {
 848         let cx = self.cx;
 849         Type::struct_(cx, &[Type::i8p(cx), Type::i32(cx)], false)
 850     }
 851
 852     fn unreachable_block(&mut self) -> &'ll BasicBlock {
 853         self.unreachable_block.unwrap_or_else(|| {
 854             let bl = self.new_block("unreachable");
 855             bl.unreachable();
 856             self.unreachable_block = Some(bl.llbb());
 857             bl.llbb()
 858         })
 859     }
 860
 861     pub fn new_block(&self, name: &str) -> Builder<'a, 'll, 'tcx> {
 862         Builder::new_block(self.cx, self.llfn, name)
 863     }
 864
 865     pub fn build_block(&self, bb: mir::BasicBlock) -> Builder<'a, 'll, 'tcx> {
 866         let bx = Builder::with_cx(self.cx);
 867         bx.position_at_end(self.blocks[bb]);
 868         bx
 869     }
 870
 871     fn make_return_dest(&mut self, bx: &Builder<'a, 'll, 'tcx>,
 872                         dest: &mir::Place<'tcx>, fn_ret: &ArgType<'tcx, Ty<'tcx>>,
 873                         llargs: &mut Vec<&'ll Value>, is_intrinsic: bool)
 874                         -> ReturnDest<'ll, 'tcx> {
 875         // If the return is ignored, we can just return a do-nothing ReturnDest
 876         if fn_ret.is_ignore() {
 877             return ReturnDest::Nothing;
 878         }
 879         let dest = if let mir::Place::Local(index) = *dest {
 880             match self.locals[index] {
 881                 LocalRef::Place(dest) => dest,
 882                 LocalRef::UnsizedPlace(_) => bug!("return type must be sized"),
 883                 LocalRef::Operand(None) => {
 884                     // Handle temporary places, specifically Operand ones, as
 885                     // they don't have allocas
 886                     return if fn_ret.is_indirect() {
 887                         // Odd, but possible, case, we have an operand temporary,
 888                         // but the calling convention has an indirect return.
 889                         let tmp = PlaceRef::alloca(bx, fn_ret.layout, "tmp_ret");
 890                         tmp.storage_live(bx);
 891                         llargs.push(tmp.llval);
 892                         ReturnDest::IndirectOperand(tmp, index)
 893                     } else if is_intrinsic {
 894                         // Currently, intrinsics always need a location to store
 895                         // the result. so we create a temporary alloca for the
 896                         // result
 897                         let tmp = PlaceRef::alloca(bx, fn_ret.layout, "tmp_ret");
 898                         tmp.storage_live(bx);
 899                         ReturnDest::IndirectOperand(tmp, index)
 900                     } else {
 901                         ReturnDest::DirectOperand(index)
 902                     };
 903                 }
 904                 LocalRef::Operand(Some(_)) => {
 905                     bug!("place local already assigned to");
 906                 }
 907             }
 908         } else {
 909             self.codegen_place(bx, dest)
 910         };
 911         if fn_ret.is_indirect() {
 912             if dest.align.abi() < dest.layout.align.abi() {
 913                 // Currently, MIR code generation does not create calls
 914                 // that store directly to fields of packed structs (in
 915                 // fact, the calls it creates write only to temps),
 916                 //
 917                 // If someone changes that, please update this code path
 918                 // to create a temporary.
 919                 span_bug!(self.mir.span, "can't directly store to unaligned value");
 920             }
 921             llargs.push(dest.llval);
 922             ReturnDest::Nothing
 923         } else {
 924             ReturnDest::Store(dest)
 925         }
 926     }
 927
 928     fn codegen_transmute(&mut self, bx: &Builder<'a, 'll, 'tcx>,
 929                        src: &mir::Operand<'tcx>,
 930                        dst: &mir::Place<'tcx>) {
 931         if let mir::Place::Local(index) = *dst {
 932             match self.locals[index] {
 933                 LocalRef::Place(place) => self.codegen_transmute_into(bx, src, place),
 934                 LocalRef::UnsizedPlace(_) => bug!("transmute must not involve unsized locals"),
 935                 LocalRef::Operand(None) => {
 936                     let dst_layout = bx.cx.layout_of(self.monomorphized_place_ty(dst));
 937                     assert!(!dst_layout.ty.has_erasable_regions());
 938                     let place = PlaceRef::alloca(bx, dst_layout, "transmute_temp");
 939                     place.storage_live(bx);
 940                     self.codegen_transmute_into(bx, src, place);
 941                     let op = place.load(bx);
 942                     place.storage_dead(bx);
 943                     self.locals[index] = LocalRef::Operand(Some(op));
 944                 }
 945                 LocalRef::Operand(Some(op)) => {
 946                     assert!(op.layout.is_zst(),
 947                             "assigning to initialized SSAtemp");
 948                 }
 949             }
 950         } else {
 951             let dst = self.codegen_place(bx, dst);
 952             self.codegen_transmute_into(bx, src, dst);
 953         }
 954     }
 955
 956     fn codegen_transmute_into(&mut self, bx: &Builder<'a, 'll, 'tcx>,
 957                             src: &mir::Operand<'tcx>,
 958                             dst: PlaceRef<'ll, 'tcx>) {
 959         let src = self.codegen_operand(bx, src);
 960         let llty = src.layout.llvm_type(bx.cx);
 961         let cast_ptr = bx.pointercast(dst.llval, llty.ptr_to());
 962         let align = src.layout.align.min(dst.layout.align);
 963         src.val.store(bx, PlaceRef::new_sized(cast_ptr, src.layout, align));
 964     }
 965
 966
 967     // Stores the return value of a function call into it's final location.
 968     fn store_return(&mut self,
 969                     bx: &Builder<'a, 'll, 'tcx>,
 970                     dest: ReturnDest<'ll, 'tcx>,
 971                     ret_ty: &ArgType<'tcx, Ty<'tcx>>,
 972                     llval: &'ll Value) {
 973         use self::ReturnDest::*;
 974
 975         match dest {
 976             Nothing => (),
 977             Store(dst) => ret_ty.store(bx, llval, dst),
 978             IndirectOperand(tmp, index) => {
 979                 let op = tmp.load(bx);
 980                 tmp.storage_dead(bx);
 981                 self.locals[index] = LocalRef::Operand(Some(op));
 982             }
 983             DirectOperand(index) => {
 984                 // If there is a cast, we have to store and reload.
 985                 let op = if let PassMode::Cast(_) = ret_ty.mode {
 986                     let tmp = PlaceRef::alloca(bx, ret_ty.layout, "tmp_ret");
 987                     tmp.storage_live(bx);
 988                     ret_ty.store(bx, llval, tmp);
 989                     let op = tmp.load(bx);
 990                     tmp.storage_dead(bx);
 991                     op
 992                 } else {
 993                     OperandRef::from_immediate_or_packed_pair(bx, llval, ret_ty.layout)
 994                 };
 995                 self.locals[index] = LocalRef::Operand(Some(op));
 996             }
 997         }
 998     }
 999 }
1000
1001 enum ReturnDest<'ll, 'tcx> {
1002     // Do nothing, the return value is indirect or ignored
1003     Nothing,
1004     // Store the return value to the pointer
1005     Store(PlaceRef<'ll, 'tcx>),
1006     // Stores an indirect return value to an operand local place
1007     IndirectOperand(PlaceRef<'ll, 'tcx>, mir::Local),
1008     // Stores a direct return value to an operand local place
1009     DirectOperand(mir::Local)
1010 }