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