compiler/rustc_typeck/src/expr_use_visitor.rs

   1 //! A different sort of visitor for walking fn bodies. Unlike the
   2 //! normal visitor, which just walks the entire body in one shot, the
   3 //! `ExprUseVisitor` determines how expressions are being used.
   4
   5 pub use self::ConsumeMode::*;
   6
   7 // Export these here so that Clippy can use them.
   8 pub use rustc_middle::hir::place::{Place, PlaceBase, PlaceWithHirId, Projection};
   9
  10 use rustc_data_structures::fx::FxIndexMap;
  11 use rustc_hir as hir;
  12 use rustc_hir::def::Res;
  13 use rustc_hir::def_id::LocalDefId;
  14 use rustc_hir::PatKind;
  15 use rustc_index::vec::Idx;
  16 use rustc_infer::infer::InferCtxt;
  17 use rustc_middle::hir::place::ProjectionKind;
  18 use rustc_middle::mir::FakeReadCause;
  19 use rustc_middle::ty::{self, adjustment, TyCtxt};
  20 use rustc_target::abi::VariantIdx;
  21
  22 use crate::mem_categorization as mc;
  23
  24 ///////////////////////////////////////////////////////////////////////////
  25 // The Delegate trait
  26
  27 /// This trait defines the callbacks you can expect to receive when
  28 /// employing the ExprUseVisitor.
  29 pub trait Delegate<'tcx> {
  30     // The value found at `place` is either copied or moved, depending
  31     // on `mode`. Where `diag_expr_id` is the id used for diagnostics for `place`.
  32     //
  33     // The parameter `diag_expr_id` indicates the HIR id that ought to be used for
  34     // diagnostics. Around pattern matching such as `let pat = expr`, the diagnostic
  35     // id will be the id of the expression `expr` but the place itself will have
  36     // the id of the binding in the pattern `pat`.
  37     fn consume(
  38         &mut self,
  39         place_with_id: &PlaceWithHirId<'tcx>,
  40         diag_expr_id: hir::HirId,
  41         mode: ConsumeMode,
  42     );
  43
  44     // The value found at `place` is being borrowed with kind `bk`.
  45     // `diag_expr_id` is the id used for diagnostics (see `consume` for more details).
  46     fn borrow(
  47         &mut self,
  48         place_with_id: &PlaceWithHirId<'tcx>,
  49         diag_expr_id: hir::HirId,
  50         bk: ty::BorrowKind,
  51     );
  52
  53     // The path at `assignee_place` is being assigned to.
  54     // `diag_expr_id` is the id used for diagnostics (see `consume` for more details).
  55     fn mutate(&mut self, assignee_place: &PlaceWithHirId<'tcx>, diag_expr_id: hir::HirId);
  56
  57     // The `place` should be a fake read because of specified `cause`.
  58     fn fake_read(&mut self, place: Place<'tcx>, cause: FakeReadCause, diag_expr_id: hir::HirId);
  59 }
  60
  61 #[derive(Copy, Clone, PartialEq, Debug)]
  62 pub enum ConsumeMode {
  63     Copy, // reference to x where x has a type that copies
  64     Move, // reference to x where x has a type that moves
  65 }
  66
  67 #[derive(Copy, Clone, PartialEq, Debug)]
  68 pub enum MutateMode {
  69     Init,
  70     JustWrite,    // x = y
  71     WriteAndRead, // x += y
  72 }
  73
  74 ///////////////////////////////////////////////////////////////////////////
  75 // The ExprUseVisitor type
  76 //
  77 // This is the code that actually walks the tree.
  78 pub struct ExprUseVisitor<'a, 'tcx> {
  79     mc: mc::MemCategorizationContext<'a, 'tcx>,
  80     body_owner: LocalDefId,
  81     delegate: &'a mut dyn Delegate<'tcx>,
  82 }
  83
  84 // If the MC results in an error, it's because the type check
  85 // failed (or will fail, when the error is uncovered and reported
  86 // during writeback). In this case, we just ignore this part of the
  87 // code.
  88 //
  89 // Note that this macro appears similar to try!(), but, unlike try!(),
  90 // it does not propagate the error.
  91 macro_rules! return_if_err {
  92     ($inp: expr) => {
  93         match $inp {
  94             Ok(v) => v,
  95             Err(()) => {
  96                 debug!("mc reported err");
  97                 return;
  98             }
  99         }
 100     };
 101 }
 102
 103 impl<'a, 'tcx> ExprUseVisitor<'a, 'tcx> {
 104     /// Creates the ExprUseVisitor, configuring it with the various options provided:
 105     ///
 106     /// - `delegate` -- who receives the callbacks
 107     /// - `param_env` --- parameter environment for trait lookups (esp. pertaining to `Copy`)
 108     /// - `typeck_results` --- typeck results for the code being analyzed
 109     pub fn new(
 110         delegate: &'a mut (dyn Delegate<'tcx> + 'a),
 111         infcx: &'a InferCtxt<'a, 'tcx>,
 112         body_owner: LocalDefId,
 113         param_env: ty::ParamEnv<'tcx>,
 114         typeck_results: &'a ty::TypeckResults<'tcx>,
 115     ) -> Self {
 116         ExprUseVisitor {
 117             mc: mc::MemCategorizationContext::new(infcx, param_env, body_owner, typeck_results),
 118             body_owner,
 119             delegate,
 120         }
 121     }
 122
 123     pub fn consume_body(&mut self, body: &hir::Body<'_>) {
 124         debug!("consume_body(body={:?})", body);
 125
 126         for param in body.params {
 127             let param_ty = return_if_err!(self.mc.pat_ty_adjusted(&param.pat));
 128             debug!("consume_body: param_ty = {:?}", param_ty);
 129
 130             let param_place = self.mc.cat_rvalue(param.hir_id, param.pat.span, param_ty);
 131
 132             self.walk_irrefutable_pat(&param_place, &param.pat);
 133         }
 134
 135         self.consume_expr(&body.value);
 136     }
 137
 138     fn tcx(&self) -> TyCtxt<'tcx> {
 139         self.mc.tcx()
 140     }
 141
 142     fn delegate_consume(&mut self, place_with_id: &PlaceWithHirId<'tcx>, diag_expr_id: hir::HirId) {
 143         debug!("delegate_consume(place_with_id={:?})", place_with_id);
 144
 145         let mode = copy_or_move(&self.mc, place_with_id);
 146         self.delegate.consume(place_with_id, diag_expr_id, mode);
 147     }
 148
 149     fn consume_exprs(&mut self, exprs: &[hir::Expr<'_>]) {
 150         for expr in exprs {
 151             self.consume_expr(&expr);
 152         }
 153     }
 154
 155     pub fn consume_expr(&mut self, expr: &hir::Expr<'_>) {
 156         debug!("consume_expr(expr={:?})", expr);
 157
 158         let place_with_id = return_if_err!(self.mc.cat_expr(expr));
 159         self.delegate_consume(&place_with_id, place_with_id.hir_id);
 160         self.walk_expr(expr);
 161     }
 162
 163     fn mutate_expr(&mut self, expr: &hir::Expr<'_>) {
 164         let place_with_id = return_if_err!(self.mc.cat_expr(expr));
 165         self.delegate.mutate(&place_with_id, place_with_id.hir_id);
 166         self.walk_expr(expr);
 167     }
 168
 169     fn borrow_expr(&mut self, expr: &hir::Expr<'_>, bk: ty::BorrowKind) {
 170         debug!("borrow_expr(expr={:?}, bk={:?})", expr, bk);
 171
 172         let place_with_id = return_if_err!(self.mc.cat_expr(expr));
 173         self.delegate.borrow(&place_with_id, place_with_id.hir_id, bk);
 174
 175         self.walk_expr(expr)
 176     }
 177
 178     fn select_from_expr(&mut self, expr: &hir::Expr<'_>) {
 179         self.walk_expr(expr)
 180     }
 181
 182     pub fn walk_expr(&mut self, expr: &hir::Expr<'_>) {
 183         debug!("walk_expr(expr={:?})", expr);
 184
 185         self.walk_adjustment(expr);
 186
 187         match expr.kind {
 188             hir::ExprKind::Path(_) => {}
 189
 190             hir::ExprKind::Type(ref subexpr, _) => self.walk_expr(subexpr),
 191
 192             hir::ExprKind::Unary(hir::UnOp::Deref, ref base) => {
 193                 // *base
 194                 self.select_from_expr(base);
 195             }
 196
 197             hir::ExprKind::Field(ref base, _) => {
 198                 // base.f
 199                 self.select_from_expr(base);
 200             }
 201
 202             hir::ExprKind::Index(ref lhs, ref rhs) => {
 203                 // lhs[rhs]
 204                 self.select_from_expr(lhs);
 205                 self.consume_expr(rhs);
 206             }
 207
 208             hir::ExprKind::Call(ref callee, ref args) => {
 209                 // callee(args)
 210                 self.consume_expr(callee);
 211                 self.consume_exprs(args);
 212             }
 213
 214             hir::ExprKind::MethodCall(.., ref args, _) => {
 215                 // callee.m(args)
 216                 self.consume_exprs(args);
 217             }
 218
 219             hir::ExprKind::Struct(_, ref fields, ref opt_with) => {
 220                 self.walk_struct_expr(fields, opt_with);
 221             }
 222
 223             hir::ExprKind::Tup(ref exprs) => {
 224                 self.consume_exprs(exprs);
 225             }
 226
 227             hir::ExprKind::If(ref cond_expr, ref then_expr, ref opt_else_expr) => {
 228                 self.consume_expr(&cond_expr);
 229                 self.consume_expr(&then_expr);
 230                 if let Some(ref else_expr) = *opt_else_expr {
 231                     self.consume_expr(&else_expr);
 232                 }
 233             }
 234
 235             hir::ExprKind::Match(ref discr, arms, _) => {
 236                 let discr_place = return_if_err!(self.mc.cat_expr(&discr));
 237
 238                 // Matching should not always be considered a use of the place, hence
 239                 // discr does not necessarily need to be borrowed.
 240                 // We only want to borrow discr if the pattern contain something other
 241                 // than wildcards.
 242                 let ExprUseVisitor { ref mc, body_owner: _, delegate: _ } = *self;
 243                 let mut needs_to_be_read = false;
 244                 for arm in arms.iter() {
 245                     return_if_err!(mc.cat_pattern(discr_place.clone(), &arm.pat, |place, pat| {
 246                         match &pat.kind {
 247                             PatKind::Binding(.., opt_sub_pat) => {
 248                                 // If the opt_sub_pat is None, than the binding does not count as
 249                                 // a wildcard for the purpose of borrowing discr.
 250                                 if opt_sub_pat.is_none() {
 251                                     needs_to_be_read = true;
 252                                 }
 253                             }
 254                             PatKind::TupleStruct(..)
 255                             | PatKind::Path(..)
 256                             | PatKind::Struct(..)
 257                             | PatKind::Tuple(..) => {
 258                                 // If the PatKind is a TupleStruct, Struct or Tuple then we want to check
 259                                 // whether the Variant is a MultiVariant or a SingleVariant. We only want
 260                                 // to borrow discr if it is a MultiVariant.
 261                                 // If it is a SingleVariant and creates a binding we will handle that when
 262                                 // this callback gets called again.
 263                                 if let ty::Adt(def, _) = place.place.base_ty.kind() {
 264                                     if def.variants.len() > 1 {
 265                                         needs_to_be_read = true;
 266                                     }
 267                                 }
 268                             }
 269                             PatKind::Lit(_) => {
 270                                 // If the PatKind is a Lit then we want
 271                                 // to borrow discr.
 272                                 needs_to_be_read = true;
 273                             }
 274                             _ => {}
 275                         }
 276                     }));
 277                 }
 278
 279                 if needs_to_be_read {
 280                     self.borrow_expr(&discr, ty::ImmBorrow);
 281                 } else {
 282                     self.delegate.fake_read(
 283                         discr_place.place.clone(),
 284                         FakeReadCause::ForMatchedPlace,
 285                         discr_place.hir_id,
 286                     );
 287
 288                     // We always want to walk the discriminant. We want to make sure, for instance,
 289                     // that the discriminant has been initialized.
 290                     self.walk_expr(&discr);
 291                 }
 292
 293                 // treatment of the discriminant is handled while walking the arms.
 294                 for arm in arms {
 295                     self.walk_arm(&discr_place, arm);
 296                 }
 297             }
 298
 299             hir::ExprKind::Array(ref exprs) => {
 300                 self.consume_exprs(exprs);
 301             }
 302
 303             hir::ExprKind::AddrOf(_, m, ref base) => {
 304                 // &base
 305                 // make sure that the thing we are pointing out stays valid
 306                 // for the lifetime `scope_r` of the resulting ptr:
 307                 let bk = ty::BorrowKind::from_mutbl(m);
 308                 self.borrow_expr(&base, bk);
 309             }
 310
 311             hir::ExprKind::InlineAsm(ref asm) => {
 312                 for (op, _op_sp) in asm.operands {
 313                     match op {
 314                         hir::InlineAsmOperand::In { expr, .. }
 315                         | hir::InlineAsmOperand::Const { expr, .. }
 316                         | hir::InlineAsmOperand::Sym { expr, .. } => self.consume_expr(expr),
 317                         hir::InlineAsmOperand::Out { expr, .. } => {
 318                             if let Some(expr) = expr {
 319                                 self.mutate_expr(expr);
 320                             }
 321                         }
 322                         hir::InlineAsmOperand::InOut { expr, .. } => {
 323                             self.mutate_expr(expr);
 324                         }
 325                         hir::InlineAsmOperand::SplitInOut { in_expr, out_expr, .. } => {
 326                             self.consume_expr(in_expr);
 327                             if let Some(out_expr) = out_expr {
 328                                 self.mutate_expr(out_expr);
 329                             }
 330                         }
 331                     }
 332                 }
 333             }
 334
 335             hir::ExprKind::LlvmInlineAsm(ref ia) => {
 336                 for (o, output) in ia.inner.outputs.iter().zip(ia.outputs_exprs) {
 337                     if o.is_indirect {
 338                         self.consume_expr(output);
 339                     } else {
 340                         self.mutate_expr(output);
 341                     }
 342                 }
 343                 self.consume_exprs(&ia.inputs_exprs);
 344             }
 345
 346             hir::ExprKind::Continue(..)
 347             | hir::ExprKind::Lit(..)
 348             | hir::ExprKind::ConstBlock(..)
 349             | hir::ExprKind::Err => {}
 350
 351             hir::ExprKind::Loop(ref blk, ..) => {
 352                 self.walk_block(blk);
 353             }
 354
 355             hir::ExprKind::Unary(_, ref lhs) => {
 356                 self.consume_expr(lhs);
 357             }
 358
 359             hir::ExprKind::Binary(_, ref lhs, ref rhs) => {
 360                 self.consume_expr(lhs);
 361                 self.consume_expr(rhs);
 362             }
 363
 364             hir::ExprKind::Block(ref blk, _) => {
 365                 self.walk_block(blk);
 366             }
 367
 368             hir::ExprKind::Break(_, ref opt_expr) | hir::ExprKind::Ret(ref opt_expr) => {
 369                 if let Some(ref expr) = *opt_expr {
 370                     self.consume_expr(expr);
 371                 }
 372             }
 373
 374             hir::ExprKind::Assign(ref lhs, ref rhs, _) => {
 375                 self.mutate_expr(lhs);
 376                 self.consume_expr(rhs);
 377             }
 378
 379             hir::ExprKind::Cast(ref base, _) => {
 380                 self.consume_expr(base);
 381             }
 382
 383             hir::ExprKind::DropTemps(ref expr) => {
 384                 self.consume_expr(expr);
 385             }
 386
 387             hir::ExprKind::AssignOp(_, ref lhs, ref rhs) => {
 388                 if self.mc.typeck_results.is_method_call(expr) {
 389                     self.consume_expr(lhs);
 390                 } else {
 391                     self.mutate_expr(lhs);
 392                 }
 393                 self.consume_expr(rhs);
 394             }
 395
 396             hir::ExprKind::Repeat(ref base, _) => {
 397                 self.consume_expr(base);
 398             }
 399
 400             hir::ExprKind::Closure(..) => {
 401                 self.walk_captures(expr);
 402             }
 403
 404             hir::ExprKind::Box(ref base) => {
 405                 self.consume_expr(base);
 406             }
 407
 408             hir::ExprKind::Yield(ref value, _) => {
 409                 self.consume_expr(value);
 410             }
 411         }
 412     }
 413
 414     fn walk_stmt(&mut self, stmt: &hir::Stmt<'_>) {
 415         match stmt.kind {
 416             hir::StmtKind::Local(ref local) => {
 417                 self.walk_local(&local);
 418             }
 419
 420             hir::StmtKind::Item(_) => {
 421                 // We don't visit nested items in this visitor,
 422                 // only the fn body we were given.
 423             }
 424
 425             hir::StmtKind::Expr(ref expr) | hir::StmtKind::Semi(ref expr) => {
 426                 self.consume_expr(&expr);
 427             }
 428         }
 429     }
 430
 431     fn walk_local(&mut self, local: &hir::Local<'_>) {
 432         if let Some(ref expr) = local.init {
 433             // Variable declarations with
 434             // initializers are considered
 435             // "assigns", which is handled by
 436             // `walk_pat`:
 437             self.walk_expr(&expr);
 438             let init_place = return_if_err!(self.mc.cat_expr(&expr));
 439             self.walk_irrefutable_pat(&init_place, &local.pat);
 440         }
 441     }
 442
 443     /// Indicates that the value of `blk` will be consumed, meaning either copied or moved
 444     /// depending on its type.
 445     fn walk_block(&mut self, blk: &hir::Block<'_>) {
 446         debug!("walk_block(blk.hir_id={})", blk.hir_id);
 447
 448         for stmt in blk.stmts {
 449             self.walk_stmt(stmt);
 450         }
 451
 452         if let Some(ref tail_expr) = blk.expr {
 453             self.consume_expr(&tail_expr);
 454         }
 455     }
 456
 457     fn walk_struct_expr(
 458         &mut self,
 459         fields: &[hir::ExprField<'_>],
 460         opt_with: &Option<&'hir hir::Expr<'_>>,
 461     ) {
 462         // Consume the expressions supplying values for each field.
 463         for field in fields {
 464             self.consume_expr(&field.expr);
 465         }
 466
 467         let with_expr = match *opt_with {
 468             Some(ref w) => &**w,
 469             None => {
 470                 return;
 471             }
 472         };
 473
 474         let with_place = return_if_err!(self.mc.cat_expr(&with_expr));
 475
 476         // Select just those fields of the `with`
 477         // expression that will actually be used
 478         match with_place.place.ty().kind() {
 479             ty::Adt(adt, substs) if adt.is_struct() => {
 480                 // Consume those fields of the with expression that are needed.
 481                 for (f_index, with_field) in adt.non_enum_variant().fields.iter().enumerate() {
 482                     let is_mentioned = fields.iter().any(|f| {
 483                         self.tcx().field_index(f.hir_id, self.mc.typeck_results) == f_index
 484                     });
 485                     if !is_mentioned {
 486                         let field_place = self.mc.cat_projection(
 487                             &*with_expr,
 488                             with_place.clone(),
 489                             with_field.ty(self.tcx(), substs),
 490                             ProjectionKind::Field(f_index as u32, VariantIdx::new(0)),
 491                         );
 492                         self.delegate_consume(&field_place, field_place.hir_id);
 493                     }
 494                 }
 495             }
 496             _ => {
 497                 // the base expression should always evaluate to a
 498                 // struct; however, when EUV is run during typeck, it
 499                 // may not. This will generate an error earlier in typeck,
 500                 // so we can just ignore it.
 501                 if !self.tcx().sess.has_errors() {
 502                     span_bug!(with_expr.span, "with expression doesn't evaluate to a struct");
 503                 }
 504             }
 505         }
 506
 507         // walk the with expression so that complex expressions
 508         // are properly handled.
 509         self.walk_expr(with_expr);
 510     }
 511
 512     // Invoke the appropriate delegate calls for anything that gets
 513     // consumed or borrowed as part of the automatic adjustment
 514     // process.
 515     fn walk_adjustment(&mut self, expr: &hir::Expr<'_>) {
 516         let adjustments = self.mc.typeck_results.expr_adjustments(expr);
 517         let mut place_with_id = return_if_err!(self.mc.cat_expr_unadjusted(expr));
 518         for adjustment in adjustments {
 519             debug!("walk_adjustment expr={:?} adj={:?}", expr, adjustment);
 520             match adjustment.kind {
 521                 adjustment::Adjust::NeverToAny | adjustment::Adjust::Pointer(_) => {
 522                     // Creating a closure/fn-pointer or unsizing consumes
 523                     // the input and stores it into the resulting rvalue.
 524                     self.delegate_consume(&place_with_id, place_with_id.hir_id);
 525                 }
 526
 527                 adjustment::Adjust::Deref(None) => {}
 528
 529                 // Autoderefs for overloaded Deref calls in fact reference
 530                 // their receiver. That is, if we have `(*x)` where `x`
 531                 // is of type `Rc<T>`, then this in fact is equivalent to
 532                 // `x.deref()`. Since `deref()` is declared with `&self`,
 533                 // this is an autoref of `x`.
 534                 adjustment::Adjust::Deref(Some(ref deref)) => {
 535                     let bk = ty::BorrowKind::from_mutbl(deref.mutbl);
 536                     self.delegate.borrow(&place_with_id, place_with_id.hir_id, bk);
 537                 }
 538
 539                 adjustment::Adjust::Borrow(ref autoref) => {
 540                     self.walk_autoref(expr, &place_with_id, autoref);
 541                 }
 542             }
 543             place_with_id =
 544                 return_if_err!(self.mc.cat_expr_adjusted(expr, place_with_id, &adjustment));
 545         }
 546     }
 547
 548     /// Walks the autoref `autoref` applied to the autoderef'd
 549     /// `expr`. `base_place` is the mem-categorized form of `expr`
 550     /// after all relevant autoderefs have occurred.
 551     fn walk_autoref(
 552         &mut self,
 553         expr: &hir::Expr<'_>,
 554         base_place: &PlaceWithHirId<'tcx>,
 555         autoref: &adjustment::AutoBorrow<'tcx>,
 556     ) {
 557         debug!(
 558             "walk_autoref(expr.hir_id={} base_place={:?} autoref={:?})",
 559             expr.hir_id, base_place, autoref
 560         );
 561
 562         match *autoref {
 563             adjustment::AutoBorrow::Ref(_, m) => {
 564                 self.delegate.borrow(
 565                     base_place,
 566                     base_place.hir_id,
 567                     ty::BorrowKind::from_mutbl(m.into()),
 568                 );
 569             }
 570
 571             adjustment::AutoBorrow::RawPtr(m) => {
 572                 debug!("walk_autoref: expr.hir_id={} base_place={:?}", expr.hir_id, base_place);
 573
 574                 self.delegate.borrow(base_place, base_place.hir_id, ty::BorrowKind::from_mutbl(m));
 575             }
 576         }
 577     }
 578
 579     fn walk_arm(&mut self, discr_place: &PlaceWithHirId<'tcx>, arm: &hir::Arm<'_>) {
 580         self.delegate.fake_read(
 581             discr_place.place.clone(),
 582             FakeReadCause::ForMatchedPlace,
 583             discr_place.hir_id,
 584         );
 585         self.walk_pat(discr_place, &arm.pat);
 586
 587         if let Some(hir::Guard::If(ref e)) = arm.guard {
 588             self.consume_expr(e)
 589         }
 590
 591         self.consume_expr(&arm.body);
 592     }
 593
 594     /// Walks a pat that occurs in isolation (i.e., top-level of fn argument or
 595     /// let binding, and *not* a match arm or nested pat.)
 596     fn walk_irrefutable_pat(&mut self, discr_place: &PlaceWithHirId<'tcx>, pat: &hir::Pat<'_>) {
 597         self.delegate.fake_read(
 598             discr_place.place.clone(),
 599             FakeReadCause::ForLet,
 600             discr_place.hir_id,
 601         );
 602         self.walk_pat(discr_place, pat);
 603     }
 604
 605     /// The core driver for walking a pattern
 606     fn walk_pat(&mut self, discr_place: &PlaceWithHirId<'tcx>, pat: &hir::Pat<'_>) {
 607         debug!("walk_pat(discr_place={:?}, pat={:?})", discr_place, pat);
 608
 609         let tcx = self.tcx();
 610         let ExprUseVisitor { ref mc, body_owner: _, ref mut delegate } = *self;
 611         return_if_err!(mc.cat_pattern(discr_place.clone(), pat, |place, pat| {
 612             if let PatKind::Binding(_, canonical_id, ..) = pat.kind {
 613                 debug!("walk_pat: binding place={:?} pat={:?}", place, pat,);
 614                 if let Some(bm) =
 615                     mc.typeck_results.extract_binding_mode(tcx.sess, pat.hir_id, pat.span)
 616                 {
 617                     debug!("walk_pat: pat.hir_id={:?} bm={:?}", pat.hir_id, bm);
 618
 619                     // pat_ty: the type of the binding being produced.
 620                     let pat_ty = return_if_err!(mc.node_ty(pat.hir_id));
 621                     debug!("walk_pat: pat_ty={:?}", pat_ty);
 622
 623                     // Each match binding is effectively an assignment to the
 624                     // binding being produced.
 625                     let def = Res::Local(canonical_id);
 626                     if let Ok(ref binding_place) = mc.cat_res(pat.hir_id, pat.span, pat_ty, def) {
 627                         delegate.mutate(binding_place, binding_place.hir_id);
 628                     }
 629
 630                     // It is also a borrow or copy/move of the value being matched.
 631                     // In a cases of pattern like `let pat = upvar`, don't use the span
 632                     // of the pattern, as this just looks confusing, instead use the span
 633                     // of the discriminant.
 634                     match bm {
 635                         ty::BindByReference(m) => {
 636                             let bk = ty::BorrowKind::from_mutbl(m);
 637                             delegate.borrow(place, discr_place.hir_id, bk);
 638                         }
 639                         ty::BindByValue(..) => {
 640                             let mode = copy_or_move(mc, &place);
 641                             debug!("walk_pat binding consuming pat");
 642                             delegate.consume(place, discr_place.hir_id, mode);
 643                         }
 644                     }
 645                 }
 646             }
 647         }));
 648     }
 649
 650     /// Handle the case where the current body contains a closure.
 651     ///
 652     /// When the current body being handled is a closure, then we must make sure that
 653     /// - The parent closure only captures Places from the nested closure that are not local to it.
 654     ///
 655     /// In the following example the closures `c` only captures `p.x`` even though `incr`
 656     /// is a capture of the nested closure
 657     ///
 658     /// ```rust,ignore(cannot-test-this-because-pseduo-code)
 659     /// let p = ..;
 660     /// let c = || {
 661     ///    let incr = 10;
 662     ///    let nested = || p.x += incr;
 663     /// }
 664     /// ```
 665     ///
 666     /// - When reporting the Place back to the Delegate, ensure that the UpvarId uses the enclosing
 667     /// closure as the DefId.
 668     fn walk_captures(&mut self, closure_expr: &hir::Expr<'_>) {
 669         fn upvar_is_local_variable(
 670             upvars: Option<&'tcx FxIndexMap<hir::HirId, hir::Upvar>>,
 671             upvar_id: &hir::HirId,
 672             body_owner_is_closure: bool,
 673         ) -> bool {
 674             upvars.map(|upvars| !upvars.contains_key(upvar_id)).unwrap_or(body_owner_is_closure)
 675         }
 676
 677         debug!("walk_captures({:?})", closure_expr);
 678
 679         let closure_def_id = self.tcx().hir().local_def_id(closure_expr.hir_id).to_def_id();
 680         let upvars = self.tcx().upvars_mentioned(self.body_owner);
 681
 682         // For purposes of this function, generator and closures are equivalent.
 683         let body_owner_is_closure = matches!(
 684             self.tcx().type_of(self.body_owner.to_def_id()).kind(),
 685             ty::Closure(..) | ty::Generator(..)
 686         );
 687
 688         // If we have a nested closure, we want to include the fake reads present in the nested closure.
 689         if let Some(fake_reads) = self.mc.typeck_results.closure_fake_reads.get(&closure_def_id) {
 690             for (fake_read, cause, hir_id) in fake_reads.iter() {
 691                 match fake_read.base {
 692                     PlaceBase::Upvar(upvar_id) => {
 693                         if upvar_is_local_variable(
 694                             upvars,
 695                             &upvar_id.var_path.hir_id,
 696                             body_owner_is_closure,
 697                         ) {
 698                             // The nested closure might be fake reading the current (enclosing) closure's local variables.
 699                             // The only places we want to fake read before creating the parent closure are the ones that
 700                             // are not local to it/ defined by it.
 701                             //
 702                             // ```rust,ignore(cannot-test-this-because-pseduo-code)
 703                             // let v1 = (0, 1);
 704                             // let c = || { // fake reads: v1
 705                             //    let v2 = (0, 1);
 706                             //    let e = || { // fake reads: v1, v2
 707                             //       let (_, t1) = v1;
 708                             //       let (_, t2) = v2;
 709                             //    }
 710                             // }
 711                             // ```
 712                             // This check is performed when visiting the body of the outermost closure (`c`) and ensures
 713                             // that we don't add a fake read of v2 in c.
 714                             continue;
 715                         }
 716                     }
 717                     _ => {
 718                         bug!(
 719                             "Do not know how to get HirId out of Rvalue and StaticItem {:?}",
 720                             fake_read.base
 721                         );
 722                     }
 723                 };
 724                 self.delegate.fake_read(fake_read.clone(), *cause, *hir_id);
 725             }
 726         }
 727
 728         if let Some(min_captures) = self.mc.typeck_results.closure_min_captures.get(&closure_def_id)
 729         {
 730             for (var_hir_id, min_list) in min_captures.iter() {
 731                 if upvars.map_or(body_owner_is_closure, |upvars| !upvars.contains_key(var_hir_id)) {
 732                     // The nested closure might be capturing the current (enclosing) closure's local variables.
 733                     // We check if the root variable is ever mentioned within the enclosing closure, if not
 734                     // then for the current body (if it's a closure) these aren't captures, we will ignore them.
 735                     continue;
 736                 }
 737                 for captured_place in min_list {
 738                     let place = &captured_place.place;
 739                     let capture_info = captured_place.info;
 740
 741                     let place_base = if body_owner_is_closure {
 742                         // Mark the place to be captured by the enclosing closure
 743                         PlaceBase::Upvar(ty::UpvarId::new(*var_hir_id, self.body_owner))
 744                     } else {
 745                         // If the body owner isn't a closure then the variable must
 746                         // be a local variable
 747                         PlaceBase::Local(*var_hir_id)
 748                     };
 749                     let place_with_id = PlaceWithHirId::new(
 750                         capture_info.path_expr_id.unwrap_or(closure_expr.hir_id),
 751                         place.base_ty,
 752                         place_base,
 753                         place.projections.clone(),
 754                     );
 755
 756                     match capture_info.capture_kind {
 757                         ty::UpvarCapture::ByValue(_) => {
 758                             let mode = copy_or_move(&self.mc, &place_with_id);
 759                             self.delegate.consume(&place_with_id, place_with_id.hir_id, mode);
 760                         }
 761                         ty::UpvarCapture::ByRef(upvar_borrow) => {
 762                             self.delegate.borrow(
 763                                 &place_with_id,
 764                                 place_with_id.hir_id,
 765                                 upvar_borrow.kind,
 766                             );
 767                         }
 768                     }
 769                 }
 770             }
 771         }
 772     }
 773 }
 774
 775 fn copy_or_move<'a, 'tcx>(
 776     mc: &mc::MemCategorizationContext<'a, 'tcx>,
 777     place_with_id: &PlaceWithHirId<'tcx>,
 778 ) -> ConsumeMode {
 779     if !mc.type_is_copy_modulo_regions(
 780         place_with_id.place.ty(),
 781         mc.tcx().hir().span(place_with_id.hir_id),
 782     ) {
 783         Move
 784     } else {
 785         Copy
 786     }
 787 }