src/librustc_mir/build/mod.rs

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