src/librustc_mir/build/mod.rs

   1 use crate::build;
   2 use crate::build::scope::DropKind;
   3 use crate::hair::cx::Cx;
   4 use crate::hair::{LintLevel, BindingMode, PatternKind};
   5 use crate::transform::MirSource;
   6 use crate::util as mir_util;
   7 use rustc::hir;
   8 use rustc::hir::Node;
   9 use rustc::hir::def_id::DefId;
  10 use rustc::middle::region;
  11 use rustc::mir::*;
  12 use rustc::ty::{self, Ty, TyCtxt};
  13 use rustc::util::nodemap::HirIdMap;
  14 use rustc_target::spec::PanicStrategy;
  15 use rustc_data_structures::indexed_vec::{IndexVec, Idx};
  16 use std::u32;
  17 use rustc_target::spec::abi::Abi;
  18 use syntax::attr::{self, UnwindAttr};
  19 use syntax::symbol::kw;
  20 use syntax_pos::Span;
  21
  22 use super::lints;
  23
  24 /// Construct the MIR for a given `DefId`.
  25 pub fn mir_build<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> Body<'tcx> {
  26     let id = tcx.hir().as_local_hir_id(def_id).unwrap();
  27
  28     // Figure out what primary body this item has.
  29     let (body_id, return_ty_span) = match tcx.hir().get(id) {
  30         Node::Expr(hir::Expr { node: hir::ExprKind::Closure(_, decl, body_id, _, _), .. })
  31         | Node::Item(hir::Item { node: hir::ItemKind::Fn(decl, _, _, body_id), .. })
  32         | Node::ImplItem(
  33             hir::ImplItem {
  34                 node: hir::ImplItemKind::Method(hir::MethodSig { decl, .. }, body_id),
  35                 ..
  36             }
  37         )
  38         | Node::TraitItem(
  39             hir::TraitItem {
  40                 node: hir::TraitItemKind::Method(
  41                     hir::MethodSig { decl, .. },
  42                     hir::TraitMethod::Provided(body_id),
  43                 ),
  44                 ..
  45             }
  46         ) => {
  47             (*body_id, decl.output.span())
  48         }
  49         Node::Item(hir::Item { node: hir::ItemKind::Static(ty, _, body_id), .. })
  50         | Node::Item(hir::Item { node: hir::ItemKind::Const(ty, body_id), .. })
  51         | Node::ImplItem(hir::ImplItem { node: hir::ImplItemKind::Const(ty, body_id), .. })
  52         | Node::TraitItem(
  53             hir::TraitItem { node: hir::TraitItemKind::Const(ty, Some(body_id)), .. }
  54         ) => {
  55             (*body_id, ty.span)
  56         }
  57         Node::AnonConst(hir::AnonConst { body, hir_id, .. }) => {
  58             (*body, tcx.hir().span(*hir_id))
  59         }
  60
  61         _ => span_bug!(tcx.hir().span(id), "can't build MIR for {:?}", def_id),
  62     };
  63
  64     tcx.infer_ctxt().enter(|infcx| {
  65         let cx = Cx::new(&infcx, id);
  66         let body = if cx.tables().tainted_by_errors {
  67             build::construct_error(cx, body_id)
  68         } else if cx.body_owner_kind.is_fn_or_closure() {
  69             // fetch the fully liberated fn signature (that is, all bound
  70             // types/lifetimes replaced)
  71             let fn_sig = cx.tables().liberated_fn_sigs()[id].clone();
  72             let fn_def_id = tcx.hir().local_def_id_from_hir_id(id);
  73
  74             let ty = tcx.type_of(fn_def_id);
  75             let mut abi = fn_sig.abi;
  76             let implicit_argument = match ty.sty {
  77                 ty::Closure(..) => {
  78                     // HACK(eddyb) Avoid having RustCall on closures,
  79                     // as it adds unnecessary (and wrong) auto-tupling.
  80                     abi = Abi::Rust;
  81                     Some(ArgInfo(liberated_closure_env_ty(tcx, id, body_id), None, None, None))
  82                 }
  83                 ty::Generator(..) => {
  84                     let gen_ty = tcx.body_tables(body_id).node_type(id);
  85                     Some(ArgInfo(gen_ty, None, None, None))
  86                 }
  87                 _ => None,
  88             };
  89
  90             let safety = match fn_sig.unsafety {
  91                 hir::Unsafety::Normal => Safety::Safe,
  92                 hir::Unsafety::Unsafe => Safety::FnUnsafe,
  93             };
  94
  95             let body = tcx.hir().body(body_id);
  96             let explicit_arguments =
  97                 body.arguments
  98                     .iter()
  99                     .enumerate()
 100                     .map(|(index, arg)| {
 101                         let owner_id = tcx.hir().body_owner(body_id);
 102                         let opt_ty_info;
 103                         let self_arg;
 104                         if let Some(ref fn_decl) = tcx.hir().fn_decl_by_hir_id(owner_id) {
 105                             let ty_hir_id = fn_decl.inputs[index].hir_id;
 106                             let ty_span = tcx.hir().span(ty_hir_id);
 107                             opt_ty_info = Some(ty_span);
 108                             self_arg = if index == 0 && fn_decl.implicit_self.has_implicit_self() {
 109                                 match fn_decl.implicit_self {
 110                                     hir::ImplicitSelfKind::Imm => Some(ImplicitSelfKind::Imm),
 111                                     hir::ImplicitSelfKind::Mut => Some(ImplicitSelfKind::Mut),
 112                                     hir::ImplicitSelfKind::ImmRef => Some(ImplicitSelfKind::ImmRef),
 113                                     hir::ImplicitSelfKind::MutRef => Some(ImplicitSelfKind::MutRef),
 114                                     _ => None,
 115                                 }
 116                             } else {
 117                                 None
 118                             };
 119                         } else {
 120                             opt_ty_info = None;
 121                             self_arg = None;
 122                         }
 123
 124                         ArgInfo(fn_sig.inputs()[index], opt_ty_info, Some(&*arg.pat), self_arg)
 125                     });
 126
 127             let arguments = implicit_argument.into_iter().chain(explicit_arguments);
 128
 129             let (yield_ty, return_ty) = if body.generator_kind.is_some() {
 130                 let gen_sig = match ty.sty {
 131                     ty::Generator(gen_def_id, gen_substs, ..) =>
 132                         gen_substs.sig(gen_def_id, tcx),
 133                     _ =>
 134                         span_bug!(tcx.hir().span(id),
 135                                   "generator w/o generator type: {:?}", ty),
 136                 };
 137                 (Some(gen_sig.yield_ty), gen_sig.return_ty)
 138             } else {
 139                 (None, fn_sig.output())
 140             };
 141
 142             build::construct_fn(cx, id, arguments, safety, abi,
 143                                 return_ty, yield_ty, return_ty_span, body)
 144         } else {
 145             // Get the revealed type of this const. This is *not* the adjusted
 146             // type of its body, which may be a subtype of this type. For
 147             // example:
 148             //
 149             // fn foo(_: &()) {}
 150             // static X: fn(&'static ()) = foo;
 151             //
 152             // The adjusted type of the body of X is `for<'a> fn(&'a ())` which
 153             // is not the same as the type of X. We need the type of the return
 154             // place to be the type of the constant because NLL typeck will
 155             // equate them.
 156
 157             let return_ty = cx.tables().node_type(id);
 158
 159             build::construct_const(cx, body_id, return_ty, return_ty_span)
 160         };
 161
 162         mir_util::dump_mir(tcx, None, "mir_map", &0,
 163                            MirSource::item(def_id), &body, |_, _| Ok(()) );
 164
 165         lints::check(tcx, &body, def_id);
 166
 167         body
 168     })
 169 }
 170
 171 ///////////////////////////////////////////////////////////////////////////
 172 // BuildMir -- walks a crate, looking for fn items and methods to build MIR from
 173
 174 fn liberated_closure_env_ty<'tcx>(
 175     tcx: TyCtxt<'tcx>,
 176     closure_expr_id: hir::HirId,
 177     body_id: hir::BodyId,
 178 ) -> Ty<'tcx> {
 179     let closure_ty = tcx.body_tables(body_id).node_type(closure_expr_id);
 180
 181     let (closure_def_id, closure_substs) = match closure_ty.sty {
 182         ty::Closure(closure_def_id, closure_substs) => (closure_def_id, closure_substs),
 183         _ => bug!("closure expr does not have closure type: {:?}", closure_ty)
 184     };
 185
 186     let closure_env_ty = tcx.closure_env_ty(closure_def_id, closure_substs).unwrap();
 187     tcx.liberate_late_bound_regions(closure_def_id, &closure_env_ty)
 188 }
 189
 190 #[derive(Debug, PartialEq, Eq)]
 191 pub enum BlockFrame {
 192     /// Evaluation is currently within a statement.
 193     ///
 194     /// Examples include:
 195     /// 1. `EXPR;`
 196     /// 2. `let _ = EXPR;`
 197     /// 3. `let x = EXPR;`
 198     Statement {
 199         /// If true, then statement discards result from evaluating
 200         /// the expression (such as examples 1 and 2 above).
 201         ignores_expr_result: bool
 202     },
 203
 204     /// Evaluation is currently within the tail expression of a block.
 205     ///
 206     /// Example: `{ STMT_1; STMT_2; EXPR }`
 207     TailExpr {
 208         /// If true, then the surrounding context of the block ignores
 209         /// the result of evaluating the block's tail expression.
 210         ///
 211         /// Example: `let _ = { STMT_1; EXPR };`
 212         tail_result_is_ignored: bool
 213     },
 214
 215     /// Generic mark meaning that the block occurred as a subexpression
 216     /// where the result might be used.
 217     ///
 218     /// Examples: `foo(EXPR)`, `match EXPR { ... }`
 219     SubExpr,
 220 }
 221
 222 impl BlockFrame {
 223     fn is_tail_expr(&self) -> bool {
 224         match *self {
 225             BlockFrame::TailExpr { .. } => true,
 226
 227             BlockFrame::Statement { .. } |
 228             BlockFrame::SubExpr => false,
 229         }
 230     }
 231     fn is_statement(&self) -> bool {
 232         match *self {
 233             BlockFrame::Statement { .. } => true,
 234
 235             BlockFrame::TailExpr { .. } |
 236             BlockFrame::SubExpr => false,
 237         }
 238     }
 239  }
 240
 241 #[derive(Debug)]
 242 struct BlockContext(Vec<BlockFrame>);
 243
 244 struct Builder<'a, 'tcx> {
 245     hir: Cx<'a, 'tcx>,
 246     cfg: CFG<'tcx>,
 247
 248     fn_span: Span,
 249     arg_count: usize,
 250     is_generator: bool,
 251
 252     /// The current set of scopes, updated as we traverse;
 253     /// see the `scope` module for more details.
 254     scopes: Vec<scope::Scope<'tcx>>,
 255
 256     /// The block-context: each time we build the code within an hair::Block,
 257     /// we push a frame here tracking whether we are building a statement or
 258     /// if we are pushing the tail expression of the block. This is used to
 259     /// embed information in generated temps about whether they were created
 260     /// for a block tail expression or not.
 261     ///
 262     /// It would be great if we could fold this into `self.scopes`
 263     /// somehow, but right now I think that is very tightly tied to
 264     /// the code generation in ways that we cannot (or should not)
 265     /// start just throwing new entries onto that vector in order to
 266     /// distinguish the context of EXPR1 from the context of EXPR2 in
 267     /// `{ STMTS; EXPR1 } + EXPR2`.
 268     block_context: BlockContext,
 269
 270     /// The current unsafe block in scope, even if it is hidden by
 271     /// a `PushUnsafeBlock`.
 272     unpushed_unsafe: Safety,
 273
 274     /// The number of `push_unsafe_block` levels in scope.
 275     push_unsafe_count: usize,
 276
 277     /// The current set of breakables; see the `scope` module for more
 278     /// details.
 279     breakable_scopes: Vec<scope::BreakableScope<'tcx>>,
 280
 281     /// The vector of all scopes that we have created thus far;
 282     /// we track this for debuginfo later.
 283     source_scopes: IndexVec<SourceScope, SourceScopeData>,
 284     source_scope_local_data: IndexVec<SourceScope, SourceScopeLocalData>,
 285     source_scope: SourceScope,
 286
 287     /// The guard-context: each time we build the guard expression for
 288     /// a match arm, we push onto this stack, and then pop when we
 289     /// finish building it.
 290     guard_context: Vec<GuardFrame>,
 291
 292     /// Maps `HirId`s of variable bindings to the `Local`s created for them.
 293     /// (A match binding can have two locals; the 2nd is for the arm's guard.)
 294     var_indices: HirIdMap<LocalsForNode>,
 295     local_decls: IndexVec<Local, LocalDecl<'tcx>>,
 296     canonical_user_type_annotations: ty::CanonicalUserTypeAnnotations<'tcx>,
 297     __upvar_debuginfo_codegen_only_do_not_use: Vec<UpvarDebuginfo>,
 298     upvar_mutbls: Vec<Mutability>,
 299     unit_temp: Option<Place<'tcx>>,
 300
 301     /// Cached block with the `RESUME` terminator; this is created
 302     /// when first set of cleanups are built.
 303     cached_resume_block: Option<BasicBlock>,
 304     /// Cached block with the `RETURN` terminator.
 305     cached_return_block: Option<BasicBlock>,
 306     /// Cached block with the `UNREACHABLE` terminator.
 307     cached_unreachable_block: Option<BasicBlock>,
 308 }
 309
 310 impl<'a, 'tcx> Builder<'a, 'tcx> {
 311     fn is_bound_var_in_guard(&self, id: hir::HirId) -> bool {
 312         self.guard_context.iter().any(|frame| frame.locals.iter().any(|local| local.id == id))
 313     }
 314
 315     fn var_local_id(&self, id: hir::HirId, for_guard: ForGuard) -> Local {
 316         self.var_indices[&id].local_id(for_guard)
 317     }
 318 }
 319
 320 impl BlockContext {
 321     fn new() -> Self { BlockContext(vec![]) }
 322     fn push(&mut self, bf: BlockFrame) { self.0.push(bf); }
 323     fn pop(&mut self) -> Option<BlockFrame> { self.0.pop() }
 324
 325     /// Traverses the frames on the `BlockContext`, searching for either
 326     /// the first block-tail expression frame with no intervening
 327     /// statement frame.
 328     ///
 329     /// Notably, this skips over `SubExpr` frames; this method is
 330     /// meant to be used in the context of understanding the
 331     /// relationship of a temp (created within some complicated
 332     /// expression) with its containing expression, and whether the
 333     /// value of that *containing expression* (not the temp!) is
 334     /// ignored.
 335     fn currently_in_block_tail(&self) -> Option<BlockTailInfo> {
 336         for bf in self.0.iter().rev() {
 337             match bf {
 338                 BlockFrame::SubExpr => continue,
 339                 BlockFrame::Statement { .. } => break,
 340                 &BlockFrame::TailExpr { tail_result_is_ignored } =>
 341                     return Some(BlockTailInfo { tail_result_is_ignored })
 342             }
 343         }
 344
 345         return None;
 346     }
 347
 348     /// Looks at the topmost frame on the BlockContext and reports
 349     /// whether its one that would discard a block tail result.
 350     ///
 351     /// Unlike `currently_within_ignored_tail_expression`, this does
 352     /// *not* skip over `SubExpr` frames: here, we want to know
 353     /// whether the block result itself is discarded.
 354     fn currently_ignores_tail_results(&self) -> bool {
 355         match self.0.last() {
 356             // no context: conservatively assume result is read
 357             None => false,
 358
 359             // sub-expression: block result feeds into some computation
 360             Some(BlockFrame::SubExpr) => false,
 361
 362             // otherwise: use accumulated is_ignored state.
 363             Some(BlockFrame::TailExpr { tail_result_is_ignored: ignored }) |
 364             Some(BlockFrame::Statement { ignores_expr_result: ignored }) => *ignored,
 365         }
 366     }
 367 }
 368
 369 #[derive(Debug)]
 370 enum LocalsForNode {
 371     /// In the usual case, a `HirId` for an identifier maps to at most
 372     /// one `Local` declaration.
 373     One(Local),
 374
 375     /// The exceptional case is identifiers in a match arm's pattern
 376     /// that are referenced in a guard of that match arm. For these,
 377     /// we have `2` Locals.
 378     ///
 379     /// * `for_arm_body` is the Local used in the arm body (which is
 380     ///   just like the `One` case above),
 381     ///
 382     /// * `ref_for_guard` is the Local used in the arm's guard (which
 383     ///   is a reference to a temp that is an alias of
 384     ///   `for_arm_body`).
 385     ForGuard { ref_for_guard: Local, for_arm_body: Local },
 386 }
 387
 388 #[derive(Debug)]
 389 struct GuardFrameLocal {
 390     id: hir::HirId,
 391 }
 392
 393 impl GuardFrameLocal {
 394     fn new(id: hir::HirId, _binding_mode: BindingMode) -> Self {
 395         GuardFrameLocal {
 396             id: id,
 397         }
 398     }
 399 }
 400
 401 #[derive(Debug)]
 402 struct GuardFrame {
 403     /// These are the id's of names that are bound by patterns of the
 404     /// arm of *this* guard.
 405     ///
 406     /// (Frames higher up the stack will have the id's bound in arms
 407     /// further out, such as in a case like:
 408     ///
 409     /// match E1 {
 410     ///      P1(id1) if (... (match E2 { P2(id2) if ... => B2 })) => B1,
 411     /// }
 412     ///
 413     /// here, when building for FIXME.
 414     locals: Vec<GuardFrameLocal>,
 415 }
 416
 417 /// `ForGuard` indicates whether we are talking about:
 418 ///   1. The variable for use outside of guard expressions, or
 419 ///   2. The temp that holds reference to (1.), which is actually what the
 420 ///      guard expressions see.
 421 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 422 enum ForGuard {
 423     RefWithinGuard,
 424     OutsideGuard,
 425 }
 426
 427 impl LocalsForNode {
 428     fn local_id(&self, for_guard: ForGuard) -> Local {
 429         match (self, for_guard) {
 430             (&LocalsForNode::One(local_id), ForGuard::OutsideGuard) |
 431             (&LocalsForNode::ForGuard { ref_for_guard: local_id, .. }, ForGuard::RefWithinGuard) |
 432             (&LocalsForNode::ForGuard { for_arm_body: local_id, .. }, ForGuard::OutsideGuard) =>
 433                 local_id,
 434
 435             (&LocalsForNode::One(_), ForGuard::RefWithinGuard) =>
 436                 bug!("anything with one local should never be within a guard."),
 437         }
 438     }
 439 }
 440
 441 struct CFG<'tcx> {
 442     basic_blocks: IndexVec<BasicBlock, BasicBlockData<'tcx>>,
 443 }
 444
 445 newtype_index! {
 446     pub struct ScopeId { .. }
 447 }
 448
 449 ///////////////////////////////////////////////////////////////////////////
 450 /// The `BlockAnd` "monad" packages up the new basic block along with a
 451 /// produced value (sometimes just unit, of course). The `unpack!`
 452 /// macro (and methods below) makes working with `BlockAnd` much more
 453 /// convenient.
 454
 455 #[must_use = "if you don't use one of these results, you're leaving a dangling edge"]
 456 struct BlockAnd<T>(BasicBlock, T);
 457
 458 trait BlockAndExtension {
 459     fn and<T>(self, v: T) -> BlockAnd<T>;
 460     fn unit(self) -> BlockAnd<()>;
 461 }
 462
 463 impl BlockAndExtension for BasicBlock {
 464     fn and<T>(self, v: T) -> BlockAnd<T> {
 465         BlockAnd(self, v)
 466     }
 467
 468     fn unit(self) -> BlockAnd<()> {
 469         BlockAnd(self, ())
 470     }
 471 }
 472
 473 /// Update a block pointer and return the value.
 474 /// Use it like `let x = unpack!(block = self.foo(block, foo))`.
 475 macro_rules! unpack {
 476     ($x:ident = $c:expr) => {
 477         {
 478             let BlockAnd(b, v) = $c;
 479             $x = b;
 480             v
 481         }
 482     };
 483
 484     ($c:expr) => {
 485         {
 486             let BlockAnd(b, ()) = $c;
 487             b
 488         }
 489     };
 490 }
 491
 492 fn should_abort_on_panic<'tcx>(tcx: TyCtxt<'tcx>, fn_def_id: DefId, abi: Abi) -> bool {
 493     // Not callable from C, so we can safely unwind through these
 494     if abi == Abi::Rust || abi == Abi::RustCall { return false; }
 495
 496     // Validate `#[unwind]` syntax regardless of platform-specific panic strategy
 497     let attrs = &tcx.get_attrs(fn_def_id);
 498     let unwind_attr = attr::find_unwind_attr(Some(tcx.sess.diagnostic()), attrs);
 499
 500     // We never unwind, so it's not relevant to stop an unwind
 501     if tcx.sess.panic_strategy() != PanicStrategy::Unwind { return false; }
 502
 503     // We cannot add landing pads, so don't add one
 504     if tcx.sess.no_landing_pads() { return false; }
 505
 506     // This is a special case: some functions have a C abi but are meant to
 507     // unwind anyway. Don't stop them.
 508     match unwind_attr {
 509         None => true,
 510         Some(UnwindAttr::Allowed) => false,
 511         Some(UnwindAttr::Aborts) => true,
 512     }
 513 }
 514
 515 ///////////////////////////////////////////////////////////////////////////
 516 /// the main entry point for building MIR for a function
 517
 518 struct ArgInfo<'tcx>(Ty<'tcx>, Option<Span>, Option<&'tcx hir::Pat>, Option<ImplicitSelfKind>);
 519
 520 fn construct_fn<'a, 'tcx, A>(
 521     hir: Cx<'a, 'tcx>,
 522     fn_id: hir::HirId,
 523     arguments: A,
 524     safety: Safety,
 525     abi: Abi,
 526     return_ty: Ty<'tcx>,
 527     yield_ty: Option<Ty<'tcx>>,
 528     return_ty_span: Span,
 529     body: &'tcx hir::Body,
 530 ) -> Body<'tcx>
 531 where
 532     A: Iterator<Item=ArgInfo<'tcx>>
 533 {
 534     let arguments: Vec<_> = arguments.collect();
 535
 536     let tcx = hir.tcx();
 537     let tcx_hir = tcx.hir();
 538     let span = tcx_hir.span(fn_id);
 539
 540     let hir_tables = hir.tables();
 541     let fn_def_id = tcx_hir.local_def_id_from_hir_id(fn_id);
 542
 543     // Gather the upvars of a closure, if any.
 544     let mut upvar_mutbls = vec![];
 545     // In analyze_closure() in upvar.rs we gathered a list of upvars used by a
 546     // closure and we stored in a map called upvar_list in TypeckTables indexed
 547     // with the closure's DefId. Here, we run through that vec of UpvarIds for
 548     // the given closure and use the necessary information to create UpvarDecl.
 549     let upvar_debuginfo: Vec<_> = hir_tables
 550         .upvar_list
 551         .get(&fn_def_id)
 552         .into_iter()
 553         .flatten()
 554         .map(|(&var_hir_id, &upvar_id)| {
 555             let capture = hir_tables.upvar_capture(upvar_id);
 556             let by_ref = match capture {
 557                 ty::UpvarCapture::ByValue => false,
 558                 ty::UpvarCapture::ByRef(..) => true,
 559             };
 560             let mut debuginfo = UpvarDebuginfo {
 561                 debug_name: kw::Invalid,
 562                 by_ref,
 563             };
 564             let mut mutability = Mutability::Not;
 565             if let Some(Node::Binding(pat)) = tcx_hir.find(var_hir_id) {
 566                 if let hir::PatKind::Binding(_, _, ident, _) = pat.node {
 567                     debuginfo.debug_name = ident.name;
 568                     if let Some(&bm) = hir.tables.pat_binding_modes().get(pat.hir_id) {
 569                         if bm == ty::BindByValue(hir::MutMutable) {
 570                             mutability = Mutability::Mut;
 571                         } else {
 572                             mutability = Mutability::Not;
 573                         }
 574                     } else {
 575                         tcx.sess.delay_span_bug(pat.span, "missing binding mode");
 576                     }
 577                 }
 578             }
 579             upvar_mutbls.push(mutability);
 580             debuginfo
 581         })
 582         .collect();
 583
 584     let mut builder = Builder::new(hir,
 585         span,
 586         arguments.len(),
 587         safety,
 588         return_ty,
 589         return_ty_span,
 590         upvar_debuginfo,
 591         upvar_mutbls,
 592         body.generator_kind.is_some());
 593
 594     let call_site_scope = region::Scope {
 595         id: body.value.hir_id.local_id,
 596         data: region::ScopeData::CallSite
 597     };
 598     let arg_scope = region::Scope {
 599         id: body.value.hir_id.local_id,
 600         data: region::ScopeData::Arguments
 601     };
 602     let mut block = START_BLOCK;
 603     let source_info = builder.source_info(span);
 604     let call_site_s = (call_site_scope, source_info);
 605     unpack!(block = builder.in_scope(call_site_s, LintLevel::Inherited, |builder| {
 606         if should_abort_on_panic(tcx, fn_def_id, abi) {
 607             builder.schedule_abort();
 608         }
 609
 610         let arg_scope_s = (arg_scope, source_info);
 611         unpack!(block = builder.in_scope(arg_scope_s, LintLevel::Inherited, |builder| {
 612             builder.args_and_body(block, &arguments, arg_scope, &body.value)
 613         }));
 614         // Attribute epilogue to function's closing brace
 615         let fn_end = span.shrink_to_hi();
 616         let source_info = builder.source_info(fn_end);
 617         let return_block = builder.return_block();
 618         builder.cfg.terminate(block, source_info,
 619                               TerminatorKind::Goto { target: return_block });
 620         builder.cfg.terminate(return_block, source_info,
 621                               TerminatorKind::Return);
 622         // Attribute any unreachable codepaths to the function's closing brace
 623         if let Some(unreachable_block) = builder.cached_unreachable_block {
 624             builder.cfg.terminate(unreachable_block, source_info,
 625                                   TerminatorKind::Unreachable);
 626         }
 627         return_block.unit()
 628     }));
 629     assert_eq!(block, builder.return_block());
 630
 631     let mut spread_arg = None;
 632     if abi == Abi::RustCall {
 633         // RustCall pseudo-ABI untuples the last argument.
 634         spread_arg = Some(Local::new(arguments.len()));
 635     }
 636     info!("fn_id {:?} has attrs {:?}", fn_def_id,
 637           tcx.get_attrs(fn_def_id));
 638
 639     let mut body = builder.finish(yield_ty);
 640     body.spread_arg = spread_arg;
 641     body
 642 }
 643
 644 fn construct_const<'a, 'tcx>(
 645     hir: Cx<'a, 'tcx>,
 646     body_id: hir::BodyId,
 647     const_ty: Ty<'tcx>,
 648     const_ty_span: Span,
 649 ) -> Body<'tcx> {
 650     let tcx = hir.tcx();
 651     let owner_id = tcx.hir().body_owner(body_id);
 652     let span = tcx.hir().span(owner_id);
 653     let mut builder = Builder::new(
 654         hir,
 655         span,
 656         0,
 657         Safety::Safe,
 658         const_ty,
 659         const_ty_span,
 660         vec![],
 661         vec![],
 662         false,
 663     );
 664
 665     let mut block = START_BLOCK;
 666     let ast_expr = &tcx.hir().body(body_id).value;
 667     let expr = builder.hir.mirror(ast_expr);
 668     unpack!(block = builder.into_expr(&Place::RETURN_PLACE, block, expr));
 669
 670     let source_info = builder.source_info(span);
 671     builder.cfg.terminate(block, source_info, TerminatorKind::Return);
 672
 673     // Constants can't `return` so a return block should not be created.
 674     assert_eq!(builder.cached_return_block, None);
 675
 676     // Constants may be match expressions in which case an unreachable block may
 677     // be created, so terminate it properly.
 678     if let Some(unreachable_block) = builder.cached_unreachable_block {
 679         builder.cfg.terminate(unreachable_block, source_info,
 680                               TerminatorKind::Unreachable);
 681     }
 682
 683     builder.finish(None)
 684 }
 685
 686 fn construct_error<'a, 'tcx>(
 687     hir: Cx<'a, 'tcx>,
 688     body_id: hir::BodyId
 689 ) -> Body<'tcx> {
 690     let owner_id = hir.tcx().hir().body_owner(body_id);
 691     let span = hir.tcx().hir().span(owner_id);
 692     let ty = hir.tcx().types.err;
 693     let mut builder = Builder::new(hir, span, 0, Safety::Safe, ty, span, vec![], vec![], false);
 694     let source_info = builder.source_info(span);
 695     builder.cfg.terminate(START_BLOCK, source_info, TerminatorKind::Unreachable);
 696     builder.finish(None)
 697 }
 698
 699 impl<'a, 'tcx> Builder<'a, 'tcx> {
 700     fn new(hir: Cx<'a, 'tcx>,
 701            span: Span,
 702            arg_count: usize,
 703            safety: Safety,
 704            return_ty: Ty<'tcx>,
 705            return_span: Span,
 706            __upvar_debuginfo_codegen_only_do_not_use: Vec<UpvarDebuginfo>,
 707            upvar_mutbls: Vec<Mutability>,
 708            is_generator: bool)
 709            -> Builder<'a, 'tcx> {
 710         let lint_level = LintLevel::Explicit(hir.root_lint_level);
 711         let mut builder = Builder {
 712             hir,
 713             cfg: CFG { basic_blocks: IndexVec::new() },
 714             fn_span: span,
 715             arg_count,
 716             is_generator,
 717             scopes: vec![],
 718             block_context: BlockContext::new(),
 719             source_scopes: IndexVec::new(),
 720             source_scope: OUTERMOST_SOURCE_SCOPE,
 721             source_scope_local_data: IndexVec::new(),
 722             guard_context: vec![],
 723             push_unsafe_count: 0,
 724             unpushed_unsafe: safety,
 725             breakable_scopes: vec![],
 726             local_decls: IndexVec::from_elem_n(
 727                 LocalDecl::new_return_place(return_ty, return_span),
 728                 1,
 729             ),
 730             canonical_user_type_annotations: IndexVec::new(),
 731             __upvar_debuginfo_codegen_only_do_not_use,
 732             upvar_mutbls,
 733             var_indices: Default::default(),
 734             unit_temp: None,
 735             cached_resume_block: None,
 736             cached_return_block: None,
 737             cached_unreachable_block: None,
 738         };
 739
 740         assert_eq!(builder.cfg.start_new_block(), START_BLOCK);
 741         assert_eq!(
 742             builder.new_source_scope(span, lint_level, Some(safety)),
 743             OUTERMOST_SOURCE_SCOPE);
 744         builder.source_scopes[OUTERMOST_SOURCE_SCOPE].parent_scope = None;
 745
 746         builder
 747     }
 748
 749     fn finish(self,
 750               yield_ty: Option<Ty<'tcx>>)
 751               -> Body<'tcx> {
 752         for (index, block) in self.cfg.basic_blocks.iter().enumerate() {
 753             if block.terminator.is_none() {
 754                 span_bug!(self.fn_span, "no terminator on block {:?}", index);
 755             }
 756         }
 757
 758         Body::new(
 759             self.cfg.basic_blocks,
 760             self.source_scopes,
 761             ClearCrossCrate::Set(self.source_scope_local_data),
 762             IndexVec::new(),
 763             yield_ty,
 764             self.local_decls,
 765             self.canonical_user_type_annotations,
 766             self.arg_count,
 767             self.__upvar_debuginfo_codegen_only_do_not_use,
 768             self.fn_span,
 769             self.hir.control_flow_destroyed(),
 770         )
 771     }
 772
 773     fn args_and_body(&mut self,
 774                      mut block: BasicBlock,
 775                      arguments: &[ArgInfo<'tcx>],
 776                      argument_scope: region::Scope,
 777                      ast_body: &'tcx hir::Expr)
 778                      -> BlockAnd<()>
 779     {
 780         // Allocate locals for the function arguments
 781         for &ArgInfo(ty, _, pattern, _) in arguments.iter() {
 782             // If this is a simple binding pattern, give the local a name for
 783             // debuginfo and so that error reporting knows that this is a user
 784             // variable. For any other pattern the pattern introduces new
 785             // variables which will be named instead.
 786             let (name, span) = if let Some(pat) = pattern {
 787                 (pat.simple_ident().map(|ident| ident.name), pat.span)
 788             } else {
 789                 (None, self.fn_span)
 790             };
 791
 792             let source_info = SourceInfo { scope: OUTERMOST_SOURCE_SCOPE, span, };
 793             self.local_decls.push(LocalDecl {
 794                 mutability: Mutability::Mut,
 795                 ty,
 796                 user_ty: UserTypeProjections::none(),
 797                 source_info,
 798                 visibility_scope: source_info.scope,
 799                 name,
 800                 internal: false,
 801                 is_user_variable: None,
 802                 is_block_tail: None,
 803             });
 804         }
 805
 806         let mut scope = None;
 807         // Bind the argument patterns
 808         for (index, arg_info) in arguments.iter().enumerate() {
 809             // Function arguments always get the first Local indices after the return place
 810             let local = Local::new(index + 1);
 811             let place = Place::from(local);
 812             let &ArgInfo(ty, opt_ty_info, pattern, ref self_binding) = arg_info;
 813
 814             // Make sure we drop (parts of) the argument even when not matched on.
 815             self.schedule_drop(
 816                 pattern.as_ref().map_or(ast_body.span, |pat| pat.span),
 817                 argument_scope, &place, ty, DropKind::Value,
 818             );
 819
 820             if let Some(pattern) = pattern {
 821                 let pattern = self.hir.pattern_from_hir(pattern);
 822                 let span = pattern.span;
 823
 824                 match *pattern.kind {
 825                     // Don't introduce extra copies for simple bindings
 826                     PatternKind::Binding {
 827                         mutability,
 828                         var,
 829                         mode: BindingMode::ByValue,
 830                         subpattern: None,
 831                         ..
 832                     } => {
 833                         self.local_decls[local].mutability = mutability;
 834                         self.local_decls[local].is_user_variable =
 835                             if let Some(kind) = self_binding {
 836                                 Some(ClearCrossCrate::Set(BindingForm::ImplicitSelf(*kind)))
 837                             } else {
 838                                 let binding_mode = ty::BindingMode::BindByValue(mutability.into());
 839                                 Some(ClearCrossCrate::Set(BindingForm::Var(VarBindingForm {
 840                                     binding_mode,
 841                                     opt_ty_info,
 842                                     opt_match_place: Some((Some(place.clone()), span)),
 843                                     pat_span: span,
 844                                 })))
 845                             };
 846                         self.var_indices.insert(var, LocalsForNode::One(local));
 847                     }
 848                     _ => {
 849                         scope = self.declare_bindings(
 850                             scope,
 851                             ast_body.span,
 852                             &pattern,
 853                             matches::ArmHasGuard(false),
 854                             Some((Some(&place), span)),
 855                         );
 856                         unpack!(block = self.place_into_pattern(block, pattern, &place, false));
 857                     }
 858                 }
 859             }
 860         }
 861
 862         // Enter the argument pattern bindings source scope, if it exists.
 863         if let Some(source_scope) = scope {
 864             self.source_scope = source_scope;
 865         }
 866
 867         let body = self.hir.mirror(ast_body);
 868         self.into(&Place::RETURN_PLACE, block, body)
 869     }
 870
 871     fn get_unit_temp(&mut self) -> Place<'tcx> {
 872         match self.unit_temp {
 873             Some(ref tmp) => tmp.clone(),
 874             None => {
 875                 let ty = self.hir.unit_ty();
 876                 let fn_span = self.fn_span;
 877                 let tmp = self.temp(ty, fn_span);
 878                 self.unit_temp = Some(tmp.clone());
 879                 tmp
 880             }
 881         }
 882     }
 883
 884     fn return_block(&mut self) -> BasicBlock {
 885         match self.cached_return_block {
 886             Some(rb) => rb,
 887             None => {
 888                 let rb = self.cfg.start_new_block();
 889                 self.cached_return_block = Some(rb);
 890                 rb
 891             }
 892         }
 893     }
 894 }
 895
 896 ///////////////////////////////////////////////////////////////////////////
 897 // Builder methods are broken up into modules, depending on what kind
 898 // of thing is being lowered. Note that they use the `unpack` macro
 899 // above extensively.
 900
 901 mod block;
 902 mod cfg;
 903 mod expr;
 904 mod into;
 905 mod matches;
 906 mod misc;
 907 mod scope;