1 //! See docs in build/expr/mod.rs
3 use crate::build::expr::category::{Category, RvalueFunc};
4 use crate::build::{BlockAnd, BlockAndExtension, BlockFrame, Builder, NeedsTemporary};
5 use rustc_ast::InlineAsmOptions;
6 use rustc_data_structures::fx::FxHashMap;
7 use rustc_data_structures::stack::ensure_sufficient_stack;
9 use rustc_index::vec::Idx;
10 use rustc_middle::mir::*;
11 use rustc_middle::thir::*;
12 use rustc_middle::ty::CanonicalUserTypeAnnotation;
15 impl<'a, 'tcx> Builder<'a, 'tcx> {
16 /// Compile `expr`, storing the result into `destination`, which
17 /// is assumed to be uninitialized.
18 pub(crate) fn expr_into_dest(
20 destination: Place<'tcx>,
21 mut block: BasicBlock,
24 debug!("expr_into_dest(destination={:?}, block={:?}, expr={:?})", destination, block, expr);
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
30 let expr_span = expr.span;
31 let source_info = this.source_info(expr_span);
33 let expr_is_block_or_scope =
34 matches!(expr.kind, ExprKind::Block { .. } | ExprKind::Scope { .. });
36 if !expr_is_block_or_scope {
37 this.block_context.push(BlockFrame::SubExpr);
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])
49 ExprKind::Block { body: ref ast_block } => {
50 this.ast_block(destination, block, ast_block, source_info)
52 ExprKind::Match { scrutinee, ref arms } => {
53 this.match_expr(destination, expr_span, block, &this.thir[scrutinee], arms)
55 ExprKind::If { cond, then, else_opt, if_then_scope } => {
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();
61 let mut else_blk = unpack!(
62 then_blk = this.in_scope(
63 (if_then_scope, then_source_info),
66 let source_info = if this.is_let(cond) {
67 let variable_scope = this.new_source_scope(
72 this.source_scope = variable_scope;
73 SourceInfo { span: then_expr.span, scope: variable_scope }
75 this.source_info(then_expr.span)
77 let (then_block, else_block) =
78 this.in_if_then_scope(condition_scope, |this| {
79 let then_blk = unpack!(this.then_else_break(
82 Some(condition_scope),
87 this.expr_into_dest(destination, then_blk, then_expr)
89 then_block.and(else_block)
94 else_blk = if let Some(else_opt) = else_opt {
95 unpack!(this.expr_into_dest(destination, else_blk, &this.thir[else_opt]))
97 // Body of the `if` expression without an `else` clause must return `()`, thus
98 // we implicitly generate an `else {}` if it is not specified.
99 let correct_si = this.source_info(expr_span.shrink_to_hi());
100 this.cfg.push_assign_unit(else_blk, correct_si, destination, this.tcx);
104 let join_block = this.cfg.start_new_block();
105 this.cfg.goto(then_blk, source_info, join_block);
106 this.cfg.goto(else_blk, source_info, join_block);
109 ExprKind::Let { expr, ref pat } => {
110 let scope = this.local_scope();
111 let (true_block, false_block) = this.in_if_then_scope(scope, |this| {
112 this.lower_let_expr(block, &this.thir[expr], pat, scope, None, expr_span)
115 this.cfg.push_assign_constant(
122 literal: ConstantKind::from_bool(this.tcx, true),
126 this.cfg.push_assign_constant(
133 literal: ConstantKind::from_bool(this.tcx, false),
137 let join_block = this.cfg.start_new_block();
138 this.cfg.goto(true_block, source_info, join_block);
139 this.cfg.goto(false_block, source_info, join_block);
142 ExprKind::NeverToAny { source } => {
143 let source = &this.thir[source];
145 matches!(source.kind, ExprKind::Call { .. } | ExprKind::InlineAsm { .. });
147 // (#66975) Source could be a const of type `!`, so has to
148 // exist in the generated MIR.
150 block = this.as_temp(block, Some(this.local_scope()), source, Mutability::Mut,)
153 // This is an optimization. If the expression was a call then we already have an
154 // unreachable block. Don't bother to terminate it and create a new one.
158 this.cfg.terminate(block, source_info, TerminatorKind::Unreachable);
159 let end_block = this.cfg.start_new_block();
163 ExprKind::LogicalOp { op, lhs, rhs } => {
166 // [block: If(lhs)] -true-> [else_block: dest = (rhs)]
168 // [shortcurcuit_block: dest = false]
172 // [block: If(lhs)] -false-> [else_block: dest = (rhs)]
174 // [shortcurcuit_block: dest = true]
176 let (shortcircuit_block, mut else_block, join_block) = (
177 this.cfg.start_new_block(),
178 this.cfg.start_new_block(),
179 this.cfg.start_new_block(),
182 let lhs = unpack!(block = this.as_local_operand(block, &this.thir[lhs]));
183 let blocks = match op {
184 LogicalOp::And => (else_block, shortcircuit_block),
185 LogicalOp::Or => (shortcircuit_block, else_block),
187 let term = TerminatorKind::if_(this.tcx, lhs, blocks.0, blocks.1);
188 this.cfg.terminate(block, source_info, term);
190 this.cfg.push_assign_constant(
198 LogicalOp::And => ConstantKind::from_bool(this.tcx, false),
199 LogicalOp::Or => ConstantKind::from_bool(this.tcx, true),
203 this.cfg.goto(shortcircuit_block, source_info, join_block);
205 let rhs = unpack!(else_block = this.as_local_operand(else_block, &this.thir[rhs]));
206 this.cfg.push_assign(else_block, source_info, destination, Rvalue::Use(rhs));
207 this.cfg.goto(else_block, source_info, join_block);
211 ExprKind::Loop { body } => {
214 // [loop_block] -> [body_block] -/eval. body/-> [body_block_end]
217 // | +-----------------------------------------+
218 // +-> [diverge_cleanup]
219 // The false link is required to make sure borrowck considers unwinds through the
220 // body, even when the exact code in the body cannot unwind
222 let loop_block = this.cfg.start_new_block();
225 this.cfg.goto(block, source_info, loop_block);
227 this.in_breakable_scope(Some(loop_block), destination, expr_span, move |this| {
228 // conduct the test, if necessary
229 let body_block = this.cfg.start_new_block();
233 TerminatorKind::FalseUnwind { real_target: body_block, unwind: None },
235 this.diverge_from(loop_block);
237 // The “return” value of the loop body must always be a unit. We therefore
238 // introduce a unit temporary as the destination for the loop body.
239 let tmp = this.get_unit_temp();
240 // Execute the body, branching back to the test.
242 unpack!(this.expr_into_dest(tmp, body_block, &this.thir[body]));
243 this.cfg.goto(body_block_end, source_info, loop_block);
245 // Loops are only exited by `break` expressions.
249 ExprKind::Call { ty: _, fun, ref args, from_hir_call, fn_span } => {
250 let fun = unpack!(block = this.as_local_operand(block, &this.thir[fun]));
251 let args: Vec<_> = args
254 .map(|arg| unpack!(block = this.as_local_call_operand(block, &this.thir[arg])))
257 let success = this.cfg.start_new_block();
259 this.record_operands_moved(&args);
261 debug!("expr_into_dest: fn_span={:?}", fn_span);
266 TerminatorKind::Call {
271 // The presence or absence of a return edge affects control-flow sensitive
272 // MIR checks and ultimately whether code is accepted or not. We can only
273 // omit the return edge if a return type is visibly uninhabited to a module
274 // that makes the call.
275 target: if this.tcx.is_ty_uninhabited_from(
288 this.diverge_from(block);
291 ExprKind::Use { source } => this.expr_into_dest(destination, block, &this.thir[source]),
292 ExprKind::Borrow { arg, borrow_kind } => {
293 let arg = &this.thir[arg];
294 // We don't do this in `as_rvalue` because we use `as_place`
295 // for borrow expressions, so we cannot create an `RValue` that
296 // remains valid across user code. `as_rvalue` is usually called
297 // by this method anyway, so this shouldn't cause too many
298 // unnecessary temporaries.
299 let arg_place = match borrow_kind {
300 BorrowKind::Shared => unpack!(block = this.as_read_only_place(block, arg)),
301 _ => unpack!(block = this.as_place(block, arg)),
303 let borrow = Rvalue::Ref(this.tcx.lifetimes.re_erased, borrow_kind, arg_place);
304 this.cfg.push_assign(block, source_info, destination, borrow);
307 ExprKind::AddressOf { mutability, arg } => {
308 let arg = &this.thir[arg];
309 let place = match mutability {
310 hir::Mutability::Not => this.as_read_only_place(block, arg),
311 hir::Mutability::Mut => this.as_place(block, arg),
313 let address_of = Rvalue::AddressOf(mutability, unpack!(block = place));
314 this.cfg.push_assign(block, source_info, destination, address_of);
317 ExprKind::Adt(box Adt {
325 // See the notes for `ExprKind::Array` in `as_rvalue` and for
326 // `ExprKind::Borrow` above.
327 let is_union = adt_def.is_union();
328 let active_field_index = if is_union { Some(fields[0].name.index()) } else { None };
330 let scope = this.local_scope();
332 // first process the set of fields that were provided
333 // (evaluating them in order given by user)
334 let fields_map: FxHashMap<_, _> = fields
337 let local_info = Box::new(LocalInfo::AggregateTemp);
341 block = this.as_operand(
346 NeedsTemporary::Maybe,
353 let field_names: Vec<_> =
354 (0..adt_def.variant(variant_index).fields.len()).map(Field::new).collect();
356 let fields: Vec<_> = if let Some(FruInfo { base, field_types }) = base {
358 unpack!(block = this.as_place_builder(block, &this.thir[*base]));
360 // MIR does not natively support FRU, so for each
361 // base-supplied field, generate an operand that
362 // reads it from the base.
363 iter::zip(field_names, &**field_types)
364 .map(|(n, ty)| match fields_map.get(&n) {
365 Some(v) => v.clone(),
367 let place_builder = place_builder.clone();
368 this.consume_by_copy_or_move(
371 .into_place(this.tcx, this.typeck_results),
377 field_names.iter().filter_map(|n| fields_map.get(n).cloned()).collect()
380 let inferred_ty = expr.ty;
381 let user_ty = user_ty.map(|ty| {
382 this.canonical_user_type_annotations.push(CanonicalUserTypeAnnotation {
383 span: source_info.span,
388 let adt = Box::new(AggregateKind::Adt(
395 this.cfg.push_assign(
399 Rvalue::Aggregate(adt, fields),
403 ExprKind::InlineAsm { template, ref operands, options, line_spans } => {
404 use rustc_middle::{mir, thir};
405 let operands = operands
407 .map(|op| match *op {
408 thir::InlineAsmOperand::In { reg, expr } => mir::InlineAsmOperand::In {
410 value: unpack!(block = this.as_local_operand(block, &this.thir[expr])),
412 thir::InlineAsmOperand::Out { reg, late, expr } => {
413 mir::InlineAsmOperand::Out {
416 place: expr.map(|expr| {
417 unpack!(block = this.as_place(block, &this.thir[expr]))
421 thir::InlineAsmOperand::InOut { reg, late, expr } => {
422 let place = unpack!(block = this.as_place(block, &this.thir[expr]));
423 mir::InlineAsmOperand::InOut {
426 // This works because asm operands must be Copy
427 in_value: Operand::Copy(place),
428 out_place: Some(place),
431 thir::InlineAsmOperand::SplitInOut { reg, late, in_expr, out_expr } => {
432 mir::InlineAsmOperand::InOut {
436 block = this.as_local_operand(block, &this.thir[in_expr])
438 out_place: out_expr.map(|out_expr| {
439 unpack!(block = this.as_place(block, &this.thir[out_expr]))
443 thir::InlineAsmOperand::Const { value, span } => {
444 mir::InlineAsmOperand::Const {
445 value: Box::new(Constant { span, user_ty: None, literal: value }),
448 thir::InlineAsmOperand::SymFn { value, span } => {
449 mir::InlineAsmOperand::SymFn {
450 value: Box::new(Constant { span, user_ty: None, literal: value }),
453 thir::InlineAsmOperand::SymStatic { def_id } => {
454 mir::InlineAsmOperand::SymStatic { def_id }
459 if !options.contains(InlineAsmOptions::NORETURN) {
460 this.cfg.push_assign_unit(block, source_info, destination, this.tcx);
463 let destination_block = this.cfg.start_new_block();
467 TerminatorKind::InlineAsm {
472 destination: if options.contains(InlineAsmOptions::NORETURN) {
475 Some(destination_block)
480 if options.contains(InlineAsmOptions::MAY_UNWIND) {
481 this.diverge_from(block);
483 destination_block.unit()
486 // These cases don't actually need a destination
487 ExprKind::Assign { .. } | ExprKind::AssignOp { .. } => {
488 unpack!(block = this.stmt_expr(block, expr, None));
489 this.cfg.push_assign_unit(block, source_info, destination, this.tcx);
493 ExprKind::Continue { .. } | ExprKind::Break { .. } | ExprKind::Return { .. } => {
494 unpack!(block = this.stmt_expr(block, expr, None));
495 // No assign, as these have type `!`.
499 // Avoid creating a temporary
500 ExprKind::VarRef { .. }
501 | ExprKind::UpvarRef { .. }
502 | ExprKind::PlaceTypeAscription { .. }
503 | ExprKind::ValueTypeAscription { .. } => {
504 debug_assert!(Category::of(&expr.kind) == Some(Category::Place));
506 let place = unpack!(block = this.as_place(block, expr));
507 let rvalue = Rvalue::Use(this.consume_by_copy_or_move(place));
508 this.cfg.push_assign(block, source_info, destination, rvalue);
511 ExprKind::Index { .. } | ExprKind::Deref { .. } | ExprKind::Field { .. } => {
512 debug_assert_eq!(Category::of(&expr.kind), Some(Category::Place));
514 // Create a "fake" temporary variable so that we check that the
515 // value is Sized. Usually, this is caught in type checking, but
516 // in the case of box expr there is no such check.
517 if !destination.projection.is_empty() {
518 this.local_decls.push(LocalDecl::new(expr.ty, expr.span));
521 let place = unpack!(block = this.as_place(block, expr));
522 let rvalue = Rvalue::Use(this.consume_by_copy_or_move(place));
523 this.cfg.push_assign(block, source_info, destination, rvalue);
527 ExprKind::Yield { value } => {
528 let scope = this.local_scope();
530 block = this.as_operand(
538 let resume = this.cfg.start_new_block();
542 TerminatorKind::Yield { value, resume, resume_arg: destination, drop: None },
544 this.generator_drop_cleanup(block);
548 // these are the cases that are more naturally handled by some other mode
549 ExprKind::Unary { .. }
550 | ExprKind::Binary { .. }
551 | ExprKind::Box { .. }
552 | ExprKind::Cast { .. }
553 | ExprKind::Pointer { .. }
554 | ExprKind::Repeat { .. }
555 | ExprKind::Array { .. }
556 | ExprKind::Tuple { .. }
557 | ExprKind::Closure { .. }
558 | ExprKind::ConstBlock { .. }
559 | ExprKind::Literal { .. }
560 | ExprKind::NamedConst { .. }
561 | ExprKind::NonHirLiteral { .. }
562 | ExprKind::ConstParam { .. }
563 | ExprKind::ThreadLocalRef(_)
564 | ExprKind::StaticRef { .. } => {
565 debug_assert!(match Category::of(&expr.kind).unwrap() {
566 // should be handled above
567 Category::Rvalue(RvalueFunc::Into) => false,
569 // must be handled above or else we get an
570 // infinite loop in the builder; see
571 // e.g., `ExprKind::VarRef` above
572 Category::Place => false,
577 let rvalue = unpack!(block = this.as_local_rvalue(block, expr));
578 this.cfg.push_assign(block, source_info, destination, rvalue);
583 if !expr_is_block_or_scope {
584 let popped = this.block_context.pop();
585 assert!(popped.is_some());
591 fn is_let(&self, expr: ExprId) -> bool {
592 match self.thir[expr].kind {
593 ExprKind::Let { .. } => true,
594 ExprKind::Scope { value, .. } => self.is_let(value),