compiler/rustc_mir_build/src/build/expr/into.rs

   1 //! See docs in build/expr/mod.rs
   2
   3 use crate::build::expr::category::{Category, RvalueFunc};
   4 use crate::build::{BlockAnd, BlockAndExtension, BlockFrame, Builder};
   5 use rustc_ast::InlineAsmOptions;
   6 use rustc_data_structures::fx::FxHashMap;
   7 use rustc_data_structures::stack::ensure_sufficient_stack;
   8 use rustc_hir as hir;
   9 use rustc_index::vec::Idx;
  10 use rustc_middle::mir::*;
  11 use rustc_middle::thir::*;
  12 use rustc_middle::ty::CanonicalUserTypeAnnotation;
  13 use std::iter;
  14
  15 impl<'a, 'tcx> Builder<'a, 'tcx> {
  16     /// Compile `expr`, storing the result into `destination`, which
  17     /// is assumed to be uninitialized.
  18     crate fn expr_into_dest(
  19         &mut self,
  20         destination: Place<'tcx>,
  21         mut block: BasicBlock,
  22         expr: &Expr<'tcx>,
  23     ) -> BlockAnd<()> {
  24         debug!("expr_into_dest(destination={:?}, block={:?}, expr={:?})", destination, block, expr);
  25
  26         // since we frequently have to reference `self` from within a
  27         // closure, where `self` would be shadowed, it's easier to
  28         // just use the name `this` uniformly
  29         let this = self;
  30         let expr_span = expr.span;
  31         let source_info = this.source_info(expr_span);
  32
  33         let expr_is_block_or_scope =
  34             matches!(expr.kind, ExprKind::Block { .. } | ExprKind::Scope { .. });
  35
  36         if !expr_is_block_or_scope {
  37             this.block_context.push(BlockFrame::SubExpr);
  38         }
  39
  40         let block_and = match expr.kind {
  41             ExprKind::Scope { region_scope, lint_level, value } => {
  42                 let region_scope = (region_scope, source_info);
  43                 ensure_sufficient_stack(|| {
  44                     this.in_scope(region_scope, lint_level, |this| {
  45                         this.expr_into_dest(destination, block, &this.thir[value])
  46                     })
  47                 })
  48             }
  49             ExprKind::Block { body: ref ast_block } => {
  50                 this.ast_block(destination, block, ast_block, source_info)
  51             }
  52             ExprKind::Match { scrutinee, ref arms } => {
  53                 this.match_expr(destination, expr_span, block, &this.thir[scrutinee], arms)
  54             }
  55             ExprKind::If { cond, then, else_opt, if_then_scope } => {
  56                 let then_blk;
  57                 let then_expr = &this.thir[then];
  58                 let then_source_info = this.source_info(then_expr.span);
  59                 let condition_scope = this.local_scope();
  60
  61                 let mut else_blk = unpack!(
  62                     then_blk = this.in_scope(
  63                         (if_then_scope, then_source_info),
  64                         LintLevel::Inherited,
  65                         |this| {
  66                             let (then_block, else_block) =
  67                                 this.in_if_then_scope(condition_scope, |this| {
  68                                     let then_blk = unpack!(this.then_else_break(
  69                                         block,
  70                                         &this.thir[cond],
  71                                         Some(condition_scope),
  72                                         condition_scope,
  73                                         then_expr.span,
  74                                     ));
  75                                     this.expr_into_dest(destination, then_blk, then_expr)
  76                                 });
  77                             then_block.and(else_block)
  78                         },
  79                     )
  80                 );
  81
  82                 else_blk = if let Some(else_opt) = else_opt {
  83                     unpack!(this.expr_into_dest(destination, else_blk, &this.thir[else_opt]))
  84                 } else {
  85                     // Body of the `if` expression without an `else` clause must return `()`, thus
  86                     // we implicitly generate an `else {}` if it is not specified.
  87                     let correct_si = this.source_info(expr_span.shrink_to_hi());
  88                     this.cfg.push_assign_unit(else_blk, correct_si, destination, this.tcx);
  89                     else_blk
  90                 };
  91
  92                 let join_block = this.cfg.start_new_block();
  93                 this.cfg.goto(then_blk, source_info, join_block);
  94                 this.cfg.goto(else_blk, source_info, join_block);
  95                 join_block.unit()
  96             }
  97             ExprKind::Let { expr, ref pat } => {
  98                 let scope = this.local_scope();
  99                 let (true_block, false_block) = this.in_if_then_scope(scope, |this| {
 100                     this.lower_let_expr(block, &this.thir[expr], pat, scope, expr_span)
 101                 });
 102
 103                 this.cfg.push_assign_constant(
 104                     true_block,
 105                     source_info,
 106                     destination,
 107                     Constant {
 108                         span: expr_span,
 109                         user_ty: None,
 110                         literal: ConstantKind::from_bool(this.tcx, true),
 111                     },
 112                 );
 113
 114                 this.cfg.push_assign_constant(
 115                     false_block,
 116                     source_info,
 117                     destination,
 118                     Constant {
 119                         span: expr_span,
 120                         user_ty: None,
 121                         literal: ConstantKind::from_bool(this.tcx, false),
 122                     },
 123                 );
 124
 125                 let join_block = this.cfg.start_new_block();
 126                 this.cfg.goto(true_block, source_info, join_block);
 127                 this.cfg.goto(false_block, source_info, join_block);
 128                 join_block.unit()
 129             }
 130             ExprKind::NeverToAny { source } => {
 131                 let source = &this.thir[source];
 132                 let is_call =
 133                     matches!(source.kind, ExprKind::Call { .. } | ExprKind::InlineAsm { .. });
 134
 135                 // (#66975) Source could be a const of type `!`, so has to
 136                 // exist in the generated MIR.
 137                 unpack!(
 138                     block = this.as_temp(block, Some(this.local_scope()), source, Mutability::Mut,)
 139                 );
 140
 141                 // This is an optimization. If the expression was a call then we already have an
 142                 // unreachable block. Don't bother to terminate it and create a new one.
 143                 if is_call {
 144                     block.unit()
 145                 } else {
 146                     this.cfg.terminate(block, source_info, TerminatorKind::Unreachable);
 147                     let end_block = this.cfg.start_new_block();
 148                     end_block.unit()
 149                 }
 150             }
 151             ExprKind::LogicalOp { op, lhs, rhs } => {
 152                 // And:
 153                 //
 154                 // [block: If(lhs)] -true-> [else_block: dest = (rhs)]
 155                 //        | (false)
 156                 //  [shortcurcuit_block: dest = false]
 157                 //
 158                 // Or:
 159                 //
 160                 // [block: If(lhs)] -false-> [else_block: dest = (rhs)]
 161                 //        | (true)
 162                 //  [shortcurcuit_block: dest = true]
 163
 164                 let (shortcircuit_block, mut else_block, join_block) = (
 165                     this.cfg.start_new_block(),
 166                     this.cfg.start_new_block(),
 167                     this.cfg.start_new_block(),
 168                 );
 169
 170                 let lhs = unpack!(block = this.as_local_operand(block, &this.thir[lhs]));
 171                 let blocks = match op {
 172                     LogicalOp::And => (else_block, shortcircuit_block),
 173                     LogicalOp::Or => (shortcircuit_block, else_block),
 174                 };
 175                 let term = TerminatorKind::if_(this.tcx, lhs, blocks.0, blocks.1);
 176                 this.cfg.terminate(block, source_info, term);
 177
 178                 this.cfg.push_assign_constant(
 179                     shortcircuit_block,
 180                     source_info,
 181                     destination,
 182                     Constant {
 183                         span: expr_span,
 184                         user_ty: None,
 185                         literal: match op {
 186                             LogicalOp::And => ConstantKind::from_bool(this.tcx, false),
 187                             LogicalOp::Or => ConstantKind::from_bool(this.tcx, true),
 188                         },
 189                     },
 190                 );
 191                 this.cfg.goto(shortcircuit_block, source_info, join_block);
 192
 193                 let rhs = unpack!(else_block = this.as_local_operand(else_block, &this.thir[rhs]));
 194                 this.cfg.push_assign(else_block, source_info, destination, Rvalue::Use(rhs));
 195                 this.cfg.goto(else_block, source_info, join_block);
 196
 197                 join_block.unit()
 198             }
 199             ExprKind::Loop { body } => {
 200                 // [block]
 201                 //    |
 202                 //   [loop_block] -> [body_block] -/eval. body/-> [body_block_end]
 203                 //    |        ^                                         |
 204                 // false link  |                                         |
 205                 //    |        +-----------------------------------------+
 206                 //    +-> [diverge_cleanup]
 207                 // The false link is required to make sure borrowck considers unwinds through the
 208                 // body, even when the exact code in the body cannot unwind
 209
 210                 let loop_block = this.cfg.start_new_block();
 211
 212                 // Start the loop.
 213                 this.cfg.goto(block, source_info, loop_block);
 214
 215                 this.in_breakable_scope(Some(loop_block), destination, expr_span, move |this| {
 216                     // conduct the test, if necessary
 217                     let body_block = this.cfg.start_new_block();
 218                     this.cfg.terminate(
 219                         loop_block,
 220                         source_info,
 221                         TerminatorKind::FalseUnwind { real_target: body_block, unwind: None },
 222                     );
 223                     this.diverge_from(loop_block);
 224
 225                     // The “return” value of the loop body must always be a unit. We therefore
 226                     // introduce a unit temporary as the destination for the loop body.
 227                     let tmp = this.get_unit_temp();
 228                     // Execute the body, branching back to the test.
 229                     let body_block_end =
 230                         unpack!(this.expr_into_dest(tmp, body_block, &this.thir[body]));
 231                     this.cfg.goto(body_block_end, source_info, loop_block);
 232
 233                     // Loops are only exited by `break` expressions.
 234                     None
 235                 })
 236             }
 237             ExprKind::Call { ty: _, fun, ref args, from_hir_call, fn_span } => {
 238                 let fun = unpack!(block = this.as_local_operand(block, &this.thir[fun]));
 239                 let args: Vec<_> = args
 240                     .into_iter()
 241                     .copied()
 242                     .map(|arg| unpack!(block = this.as_local_call_operand(block, &this.thir[arg])))
 243                     .collect();
 244
 245                 let success = this.cfg.start_new_block();
 246
 247                 this.record_operands_moved(&args);
 248
 249                 debug!("expr_into_dest: fn_span={:?}", fn_span);
 250
 251                 this.cfg.terminate(
 252                     block,
 253                     source_info,
 254                     TerminatorKind::Call {
 255                         func: fun,
 256                         args,
 257                         cleanup: None,
 258                         // FIXME(varkor): replace this with an uninhabitedness-based check.
 259                         // This requires getting access to the current module to call
 260                         // `tcx.is_ty_uninhabited_from`, which is currently tricky to do.
 261                         destination: if expr.ty.is_never() {
 262                             None
 263                         } else {
 264                             Some((destination, success))
 265                         },
 266                         from_hir_call,
 267                         fn_span,
 268                     },
 269                 );
 270                 this.diverge_from(block);
 271                 success.unit()
 272             }
 273             ExprKind::Use { source } => this.expr_into_dest(destination, block, &this.thir[source]),
 274             ExprKind::Borrow { arg, borrow_kind } => {
 275                 let arg = &this.thir[arg];
 276                 // We don't do this in `as_rvalue` because we use `as_place`
 277                 // for borrow expressions, so we cannot create an `RValue` that
 278                 // remains valid across user code. `as_rvalue` is usually called
 279                 // by this method anyway, so this shouldn't cause too many
 280                 // unnecessary temporaries.
 281                 let arg_place = match borrow_kind {
 282                     BorrowKind::Shared => unpack!(block = this.as_read_only_place(block, arg)),
 283                     _ => unpack!(block = this.as_place(block, arg)),
 284                 };
 285                 let borrow = Rvalue::Ref(this.tcx.lifetimes.re_erased, borrow_kind, arg_place);
 286                 this.cfg.push_assign(block, source_info, destination, borrow);
 287                 block.unit()
 288             }
 289             ExprKind::AddressOf { mutability, arg } => {
 290                 let arg = &this.thir[arg];
 291                 let place = match mutability {
 292                     hir::Mutability::Not => this.as_read_only_place(block, arg),
 293                     hir::Mutability::Mut => this.as_place(block, arg),
 294                 };
 295                 let address_of = Rvalue::AddressOf(mutability, unpack!(block = place));
 296                 this.cfg.push_assign(block, source_info, destination, address_of);
 297                 block.unit()
 298             }
 299             ExprKind::Adt(box Adt {
 300                 adt_def,
 301                 variant_index,
 302                 substs,
 303                 user_ty,
 304                 ref fields,
 305                 ref base,
 306             }) => {
 307                 // See the notes for `ExprKind::Array` in `as_rvalue` and for
 308                 // `ExprKind::Borrow` above.
 309                 let is_union = adt_def.is_union();
 310                 let active_field_index = if is_union { Some(fields[0].name.index()) } else { None };
 311
 312                 let scope = this.local_scope();
 313
 314                 // first process the set of fields that were provided
 315                 // (evaluating them in order given by user)
 316                 let fields_map: FxHashMap<_, _> = fields
 317                     .into_iter()
 318                     .map(|f| {
 319                         let local_info = Box::new(LocalInfo::AggregateTemp);
 320                         (
 321                             f.name,
 322                             unpack!(
 323                                 block = this.as_operand(
 324                                     block,
 325                                     Some(scope),
 326                                     &this.thir[f.expr],
 327                                     Some(local_info)
 328                                 )
 329                             ),
 330                         )
 331                     })
 332                     .collect();
 333
 334                 let field_names: Vec<_> =
 335                     (0..adt_def.variant(variant_index).fields.len()).map(Field::new).collect();
 336
 337                 let fields: Vec<_> = if let Some(FruInfo { base, field_types }) = base {
 338                     let place_builder =
 339                         unpack!(block = this.as_place_builder(block, &this.thir[*base]));
 340
 341                     // MIR does not natively support FRU, so for each
 342                     // base-supplied field, generate an operand that
 343                     // reads it from the base.
 344                     iter::zip(field_names, &**field_types)
 345                         .map(|(n, ty)| match fields_map.get(&n) {
 346                             Some(v) => v.clone(),
 347                             None => {
 348                                 let place_builder = place_builder.clone();
 349                                 this.consume_by_copy_or_move(
 350                                     place_builder
 351                                         .field(n, *ty)
 352                                         .into_place(this.tcx, this.typeck_results),
 353                                 )
 354                             }
 355                         })
 356                         .collect()
 357                 } else {
 358                     field_names.iter().filter_map(|n| fields_map.get(n).cloned()).collect()
 359                 };
 360
 361                 let inferred_ty = expr.ty;
 362                 let user_ty = user_ty.map(|ty| {
 363                     this.canonical_user_type_annotations.push(CanonicalUserTypeAnnotation {
 364                         span: source_info.span,
 365                         user_ty: ty,
 366                         inferred_ty,
 367                     })
 368                 });
 369                 let adt = Box::new(AggregateKind::Adt(
 370                     adt_def.did(),
 371                     variant_index,
 372                     substs,
 373                     user_ty,
 374                     active_field_index,
 375                 ));
 376                 this.cfg.push_assign(
 377                     block,
 378                     source_info,
 379                     destination,
 380                     Rvalue::Aggregate(adt, fields),
 381                 );
 382                 block.unit()
 383             }
 384             ExprKind::InlineAsm { template, ref operands, options, line_spans } => {
 385                 use rustc_middle::{mir, thir};
 386                 let operands = operands
 387                     .into_iter()
 388                     .map(|op| match *op {
 389                         thir::InlineAsmOperand::In { reg, expr } => mir::InlineAsmOperand::In {
 390                             reg,
 391                             value: unpack!(block = this.as_local_operand(block, &this.thir[expr])),
 392                         },
 393                         thir::InlineAsmOperand::Out { reg, late, expr } => {
 394                             mir::InlineAsmOperand::Out {
 395                                 reg,
 396                                 late,
 397                                 place: expr.map(|expr| {
 398                                     unpack!(block = this.as_place(block, &this.thir[expr]))
 399                                 }),
 400                             }
 401                         }
 402                         thir::InlineAsmOperand::InOut { reg, late, expr } => {
 403                             let place = unpack!(block = this.as_place(block, &this.thir[expr]));
 404                             mir::InlineAsmOperand::InOut {
 405                                 reg,
 406                                 late,
 407                                 // This works because asm operands must be Copy
 408                                 in_value: Operand::Copy(place),
 409                                 out_place: Some(place),
 410                             }
 411                         }
 412                         thir::InlineAsmOperand::SplitInOut { reg, late, in_expr, out_expr } => {
 413                             mir::InlineAsmOperand::InOut {
 414                                 reg,
 415                                 late,
 416                                 in_value: unpack!(
 417                                     block = this.as_local_operand(block, &this.thir[in_expr])
 418                                 ),
 419                                 out_place: out_expr.map(|out_expr| {
 420                                     unpack!(block = this.as_place(block, &this.thir[out_expr]))
 421                                 }),
 422                             }
 423                         }
 424                         thir::InlineAsmOperand::Const { value, span } => {
 425                             mir::InlineAsmOperand::Const {
 426                                 value: Box::new(Constant {
 427                                     span,
 428                                     user_ty: None,
 429                                     literal: value.into(),
 430                                 }),
 431                             }
 432                         }
 433                         thir::InlineAsmOperand::SymFn { expr } => mir::InlineAsmOperand::SymFn {
 434                             value: Box::new(this.as_constant(&this.thir[expr])),
 435                         },
 436                         thir::InlineAsmOperand::SymStatic { def_id } => {
 437                             mir::InlineAsmOperand::SymStatic { def_id }
 438                         }
 439                     })
 440                     .collect();
 441
 442                 if !options.contains(InlineAsmOptions::NORETURN) {
 443                     this.cfg.push_assign_unit(block, source_info, destination, this.tcx);
 444                 }
 445
 446                 let destination_block = this.cfg.start_new_block();
 447                 this.cfg.terminate(
 448                     block,
 449                     source_info,
 450                     TerminatorKind::InlineAsm {
 451                         template,
 452                         operands,
 453                         options,
 454                         line_spans,
 455                         destination: if options.contains(InlineAsmOptions::NORETURN) {
 456                             None
 457                         } else {
 458                             Some(destination_block)
 459                         },
 460                         cleanup: None,
 461                     },
 462                 );
 463                 if options.contains(InlineAsmOptions::MAY_UNWIND) {
 464                     this.diverge_from(block);
 465                 }
 466                 destination_block.unit()
 467             }
 468
 469             // These cases don't actually need a destination
 470             ExprKind::Assign { .. } | ExprKind::AssignOp { .. } => {
 471                 unpack!(block = this.stmt_expr(block, expr, None));
 472                 this.cfg.push_assign_unit(block, source_info, destination, this.tcx);
 473                 block.unit()
 474             }
 475
 476             ExprKind::Continue { .. } | ExprKind::Break { .. } | ExprKind::Return { .. } => {
 477                 unpack!(block = this.stmt_expr(block, expr, None));
 478                 // No assign, as these have type `!`.
 479                 block.unit()
 480             }
 481
 482             // Avoid creating a temporary
 483             ExprKind::VarRef { .. }
 484             | ExprKind::UpvarRef { .. }
 485             | ExprKind::PlaceTypeAscription { .. }
 486             | ExprKind::ValueTypeAscription { .. } => {
 487                 debug_assert!(Category::of(&expr.kind) == Some(Category::Place));
 488
 489                 let place = unpack!(block = this.as_place(block, expr));
 490                 let rvalue = Rvalue::Use(this.consume_by_copy_or_move(place));
 491                 this.cfg.push_assign(block, source_info, destination, rvalue);
 492                 block.unit()
 493             }
 494             ExprKind::Index { .. } | ExprKind::Deref { .. } | ExprKind::Field { .. } => {
 495                 debug_assert_eq!(Category::of(&expr.kind), Some(Category::Place));
 496
 497                 // Create a "fake" temporary variable so that we check that the
 498                 // value is Sized. Usually, this is caught in type checking, but
 499                 // in the case of box expr there is no such check.
 500                 if !destination.projection.is_empty() {
 501                     this.local_decls.push(LocalDecl::new(expr.ty, expr.span));
 502                 }
 503
 504                 let place = unpack!(block = this.as_place(block, expr));
 505                 let rvalue = Rvalue::Use(this.consume_by_copy_or_move(place));
 506                 this.cfg.push_assign(block, source_info, destination, rvalue);
 507                 block.unit()
 508             }
 509
 510             ExprKind::Yield { value } => {
 511                 let scope = this.local_scope();
 512                 let value =
 513                     unpack!(block = this.as_operand(block, Some(scope), &this.thir[value], None));
 514                 let resume = this.cfg.start_new_block();
 515                 this.cfg.terminate(
 516                     block,
 517                     source_info,
 518                     TerminatorKind::Yield { value, resume, resume_arg: destination, drop: None },
 519                 );
 520                 this.generator_drop_cleanup(block);
 521                 resume.unit()
 522             }
 523
 524             // these are the cases that are more naturally handled by some other mode
 525             ExprKind::Unary { .. }
 526             | ExprKind::Binary { .. }
 527             | ExprKind::Box { .. }
 528             | ExprKind::Cast { .. }
 529             | ExprKind::Pointer { .. }
 530             | ExprKind::Repeat { .. }
 531             | ExprKind::Array { .. }
 532             | ExprKind::Tuple { .. }
 533             | ExprKind::Closure { .. }
 534             | ExprKind::ConstBlock { .. }
 535             | ExprKind::Literal { .. }
 536             | ExprKind::ThreadLocalRef(_)
 537             | ExprKind::StaticRef { .. } => {
 538                 debug_assert!(match Category::of(&expr.kind).unwrap() {
 539                     // should be handled above
 540                     Category::Rvalue(RvalueFunc::Into) => false,
 541
 542                     // must be handled above or else we get an
 543                     // infinite loop in the builder; see
 544                     // e.g., `ExprKind::VarRef` above
 545                     Category::Place => false,
 546
 547                     _ => true,
 548                 });
 549
 550                 let rvalue = unpack!(block = this.as_local_rvalue(block, expr));
 551                 this.cfg.push_assign(block, source_info, destination, rvalue);
 552                 block.unit()
 553             }
 554         };
 555
 556         if !expr_is_block_or_scope {
 557             let popped = this.block_context.pop();
 558             assert!(popped.is_some());
 559         }
 560
 561         block_and
 562     }
 563 }