src/librustc/middle/expr_use_visitor.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! A different sort of visitor for walking fn bodies.  Unlike the
  12 //! normal visitor, which just walks the entire body in one shot, the
  13 //! `ExprUseVisitor` determines how expressions are being used.
  14
  15 pub use self::LoanCause::*;
  16 pub use self::ConsumeMode::*;
  17 pub use self::MoveReason::*;
  18 pub use self::MatchMode::*;
  19 use self::TrackMatchMode::*;
  20 use self::OverloadedCallType::*;
  21
  22 use hir::def::Def;
  23 use hir::def_id::DefId;
  24 use infer::InferCtxt;
  25 use middle::mem_categorization as mc;
  26 use middle::region;
  27 use ty::{self, TyCtxt, adjustment};
  28
  29 use hir::{self, PatKind};
  30 use rustc_data_structures::sync::Lrc;
  31 use std::rc::Rc;
  32 use syntax::ast;
  33 use syntax::ptr::P;
  34 use syntax_pos::Span;
  35 use util::nodemap::ItemLocalSet;
  36
  37 ///////////////////////////////////////////////////////////////////////////
  38 // The Delegate trait
  39
  40 /// This trait defines the callbacks you can expect to receive when
  41 /// employing the ExprUseVisitor.
  42 pub trait Delegate<'tcx> {
  43     // The value found at `cmt` is either copied or moved, depending
  44     // on mode.
  45     fn consume(&mut self,
  46                consume_id: ast::NodeId,
  47                consume_span: Span,
  48                cmt: &mc::cmt_<'tcx>,
  49                mode: ConsumeMode);
  50
  51     // The value found at `cmt` has been determined to match the
  52     // pattern binding `matched_pat`, and its subparts are being
  53     // copied or moved depending on `mode`.  Note that `matched_pat`
  54     // is called on all variant/structs in the pattern (i.e., the
  55     // interior nodes of the pattern's tree structure) while
  56     // consume_pat is called on the binding identifiers in the pattern
  57     // (which are leaves of the pattern's tree structure).
  58     //
  59     // Note that variants/structs and identifiers are disjoint; thus
  60     // `matched_pat` and `consume_pat` are never both called on the
  61     // same input pattern structure (though of `consume_pat` can be
  62     // called on a subpart of an input passed to `matched_pat).
  63     fn matched_pat(&mut self,
  64                    matched_pat: &hir::Pat,
  65                    cmt: &mc::cmt_<'tcx>,
  66                    mode: MatchMode);
  67
  68     // The value found at `cmt` is either copied or moved via the
  69     // pattern binding `consume_pat`, depending on mode.
  70     fn consume_pat(&mut self,
  71                    consume_pat: &hir::Pat,
  72                    cmt: &mc::cmt_<'tcx>,
  73                    mode: ConsumeMode);
  74
  75     // The value found at `borrow` is being borrowed at the point
  76     // `borrow_id` for the region `loan_region` with kind `bk`.
  77     fn borrow(&mut self,
  78               borrow_id: ast::NodeId,
  79               borrow_span: Span,
  80               cmt: &mc::cmt_<'tcx>,
  81               loan_region: ty::Region<'tcx>,
  82               bk: ty::BorrowKind,
  83               loan_cause: LoanCause);
  84
  85     // The local variable `id` is declared but not initialized.
  86     fn decl_without_init(&mut self,
  87                          id: ast::NodeId,
  88                          span: Span);
  89
  90     // The path at `cmt` is being assigned to.
  91     fn mutate(&mut self,
  92               assignment_id: ast::NodeId,
  93               assignment_span: Span,
  94               assignee_cmt: &mc::cmt_<'tcx>,
  95               mode: MutateMode);
  96 }
  97
  98 #[derive(Copy, Clone, PartialEq, Debug)]
  99 pub enum LoanCause {
 100     ClosureCapture(Span),
 101     AddrOf,
 102     AutoRef,
 103     AutoUnsafe,
 104     RefBinding,
 105     OverloadedOperator,
 106     ClosureInvocation,
 107     ForLoop,
 108     MatchDiscriminant
 109 }
 110
 111 #[derive(Copy, Clone, PartialEq, Debug)]
 112 pub enum ConsumeMode {
 113     Copy,                // reference to x where x has a type that copies
 114     Move(MoveReason),    // reference to x where x has a type that moves
 115 }
 116
 117 #[derive(Copy, Clone, PartialEq, Debug)]
 118 pub enum MoveReason {
 119     DirectRefMove,
 120     PatBindingMove,
 121     CaptureMove,
 122 }
 123
 124 #[derive(Copy, Clone, PartialEq, Debug)]
 125 pub enum MatchMode {
 126     NonBindingMatch,
 127     BorrowingMatch,
 128     CopyingMatch,
 129     MovingMatch,
 130 }
 131
 132 #[derive(Copy, Clone, PartialEq, Debug)]
 133 enum TrackMatchMode {
 134     Unknown,
 135     Definite(MatchMode),
 136     Conflicting,
 137 }
 138
 139 impl TrackMatchMode {
 140     // Builds up the whole match mode for a pattern from its constituent
 141     // parts.  The lattice looks like this:
 142     //
 143     //          Conflicting
 144     //            /     \
 145     //           /       \
 146     //      Borrowing   Moving
 147     //           \       /
 148     //            \     /
 149     //            Copying
 150     //               |
 151     //          NonBinding
 152     //               |
 153     //            Unknown
 154     //
 155     // examples:
 156     //
 157     // * `(_, some_int)` pattern is Copying, since
 158     //   NonBinding + Copying => Copying
 159     //
 160     // * `(some_int, some_box)` pattern is Moving, since
 161     //   Copying + Moving => Moving
 162     //
 163     // * `(ref x, some_box)` pattern is Conflicting, since
 164     //   Borrowing + Moving => Conflicting
 165     //
 166     // Note that the `Unknown` and `Conflicting` states are
 167     // represented separately from the other more interesting
 168     // `Definite` states, which simplifies logic here somewhat.
 169     fn lub(&mut self, mode: MatchMode) {
 170         *self = match (*self, mode) {
 171             // Note that clause order below is very significant.
 172             (Unknown, new) => Definite(new),
 173             (Definite(old), new) if old == new => Definite(old),
 174
 175             (Definite(old), NonBindingMatch) => Definite(old),
 176             (Definite(NonBindingMatch), new) => Definite(new),
 177
 178             (Definite(old), CopyingMatch) => Definite(old),
 179             (Definite(CopyingMatch), new) => Definite(new),
 180
 181             (Definite(_), _) => Conflicting,
 182             (Conflicting, _) => *self,
 183         };
 184     }
 185
 186     fn match_mode(&self) -> MatchMode {
 187         match *self {
 188             Unknown => NonBindingMatch,
 189             Definite(mode) => mode,
 190             Conflicting => {
 191                 // Conservatively return MovingMatch to let the
 192                 // compiler continue to make progress.
 193                 MovingMatch
 194             }
 195         }
 196     }
 197 }
 198
 199 #[derive(Copy, Clone, PartialEq, Debug)]
 200 pub enum MutateMode {
 201     Init,
 202     JustWrite,    // x = y
 203     WriteAndRead, // x += y
 204 }
 205
 206 #[derive(Copy, Clone)]
 207 enum OverloadedCallType {
 208     FnOverloadedCall,
 209     FnMutOverloadedCall,
 210     FnOnceOverloadedCall,
 211 }
 212
 213 impl OverloadedCallType {
 214     fn from_trait_id(tcx: TyCtxt, trait_id: DefId) -> OverloadedCallType {
 215         for &(maybe_function_trait, overloaded_call_type) in &[
 216             (tcx.lang_items().fn_once_trait(), FnOnceOverloadedCall),
 217             (tcx.lang_items().fn_mut_trait(), FnMutOverloadedCall),
 218             (tcx.lang_items().fn_trait(), FnOverloadedCall)
 219         ] {
 220             match maybe_function_trait {
 221                 Some(function_trait) if function_trait == trait_id => {
 222                     return overloaded_call_type
 223                 }
 224                 _ => continue,
 225             }
 226         }
 227
 228         bug!("overloaded call didn't map to known function trait")
 229     }
 230
 231     fn from_method_id(tcx: TyCtxt, method_id: DefId) -> OverloadedCallType {
 232         let method = tcx.associated_item(method_id);
 233         OverloadedCallType::from_trait_id(tcx, method.container.id())
 234     }
 235 }
 236
 237 ///////////////////////////////////////////////////////////////////////////
 238 // The ExprUseVisitor type
 239 //
 240 // This is the code that actually walks the tree.
 241 pub struct ExprUseVisitor<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
 242     mc: mc::MemCategorizationContext<'a, 'gcx, 'tcx>,
 243     delegate: &'a mut dyn Delegate<'tcx>,
 244     param_env: ty::ParamEnv<'tcx>,
 245 }
 246
 247 // If the MC results in an error, it's because the type check
 248 // failed (or will fail, when the error is uncovered and reported
 249 // during writeback). In this case, we just ignore this part of the
 250 // code.
 251 //
 252 // Note that this macro appears similar to try!(), but, unlike try!(),
 253 // it does not propagate the error.
 254 macro_rules! return_if_err {
 255     ($inp: expr) => (
 256         match $inp {
 257             Ok(v) => v,
 258             Err(()) => {
 259                 debug!("mc reported err");
 260                 return
 261             }
 262         }
 263     )
 264 }
 265
 266 impl<'a, 'tcx> ExprUseVisitor<'a, 'tcx, 'tcx> {
 267     /// Creates the ExprUseVisitor, configuring it with the various options provided:
 268     ///
 269     /// - `delegate` -- who receives the callbacks
 270     /// - `param_env` --- parameter environment for trait lookups (esp. pertaining to `Copy`)
 271     /// - `region_scope_tree` --- region scope tree for the code being analyzed
 272     /// - `tables` --- typeck results for the code being analyzed
 273     /// - `rvalue_promotable_map` --- if you care about rvalue promotion, then provide
 274     ///   the map here (it can be computed with `tcx.rvalue_promotable_map(def_id)`).
 275     ///   `None` means that rvalues will be given more conservative lifetimes.
 276     ///
 277     /// See also `with_infer`, which is used *during* typeck.
 278     pub fn new(delegate: &'a mut (dyn Delegate<'tcx>+'a),
 279                tcx: TyCtxt<'a, 'tcx, 'tcx>,
 280                param_env: ty::ParamEnv<'tcx>,
 281                region_scope_tree: &'a region::ScopeTree,
 282                tables: &'a ty::TypeckTables<'tcx>,
 283                rvalue_promotable_map: Option<Lrc<ItemLocalSet>>)
 284                -> Self
 285     {
 286         ExprUseVisitor {
 287             mc: mc::MemCategorizationContext::new(tcx,
 288                                                   region_scope_tree,
 289                                                   tables,
 290                                                   rvalue_promotable_map),
 291             delegate,
 292             param_env,
 293         }
 294     }
 295 }
 296
 297 impl<'a, 'gcx, 'tcx> ExprUseVisitor<'a, 'gcx, 'tcx> {
 298     pub fn with_infer(delegate: &'a mut (dyn Delegate<'tcx>+'a),
 299                       infcx: &'a InferCtxt<'a, 'gcx, 'tcx>,
 300                       param_env: ty::ParamEnv<'tcx>,
 301                       region_scope_tree: &'a region::ScopeTree,
 302                       tables: &'a ty::TypeckTables<'tcx>)
 303                       -> Self
 304     {
 305         ExprUseVisitor {
 306             mc: mc::MemCategorizationContext::with_infer(infcx, region_scope_tree, tables),
 307             delegate,
 308             param_env,
 309         }
 310     }
 311
 312     pub fn consume_body(&mut self, body: &hir::Body) {
 313         debug!("consume_body(body={:?})", body);
 314
 315         for arg in &body.arguments {
 316             let arg_ty = return_if_err!(self.mc.pat_ty_adjusted(&arg.pat));
 317             debug!("consume_body: arg_ty = {:?}", arg_ty);
 318
 319             let fn_body_scope_r =
 320                 self.tcx().mk_region(ty::ReScope(region::Scope::Node(body.value.hir_id.local_id)));
 321             let arg_cmt = Rc::new(self.mc.cat_rvalue(
 322                 arg.hir_id,
 323                 arg.pat.span,
 324                 fn_body_scope_r, // Args live only as long as the fn body.
 325                 arg_ty));
 326
 327             self.walk_irrefutable_pat(arg_cmt, &arg.pat);
 328         }
 329
 330         self.consume_expr(&body.value);
 331     }
 332
 333     fn tcx(&self) -> TyCtxt<'a, 'gcx, 'tcx> {
 334         self.mc.tcx
 335     }
 336
 337     fn delegate_consume(&mut self,
 338                         consume_id: ast::NodeId,
 339                         consume_span: Span,
 340                         cmt: &mc::cmt_<'tcx>) {
 341         debug!("delegate_consume(consume_id={}, cmt={:?})",
 342                consume_id, cmt);
 343
 344         let mode = copy_or_move(&self.mc, self.param_env, cmt, DirectRefMove);
 345         self.delegate.consume(consume_id, consume_span, cmt, mode);
 346     }
 347
 348     fn consume_exprs(&mut self, exprs: &[hir::Expr]) {
 349         for expr in exprs {
 350             self.consume_expr(&expr);
 351         }
 352     }
 353
 354     pub fn consume_expr(&mut self, expr: &hir::Expr) {
 355         debug!("consume_expr(expr={:?})", expr);
 356
 357         let cmt = return_if_err!(self.mc.cat_expr(expr));
 358         self.delegate_consume(expr.id, expr.span, &cmt);
 359         self.walk_expr(expr);
 360     }
 361
 362     fn mutate_expr(&mut self,
 363                    assignment_expr: &hir::Expr,
 364                    expr: &hir::Expr,
 365                    mode: MutateMode) {
 366         let cmt = return_if_err!(self.mc.cat_expr(expr));
 367         self.delegate.mutate(assignment_expr.id, assignment_expr.span, &cmt, mode);
 368         self.walk_expr(expr);
 369     }
 370
 371     fn borrow_expr(&mut self,
 372                    expr: &hir::Expr,
 373                    r: ty::Region<'tcx>,
 374                    bk: ty::BorrowKind,
 375                    cause: LoanCause) {
 376         debug!("borrow_expr(expr={:?}, r={:?}, bk={:?})",
 377                expr, r, bk);
 378
 379         let cmt = return_if_err!(self.mc.cat_expr(expr));
 380         self.delegate.borrow(expr.id, expr.span, &cmt, r, bk, cause);
 381
 382         self.walk_expr(expr)
 383     }
 384
 385     fn select_from_expr(&mut self, expr: &hir::Expr) {
 386         self.walk_expr(expr)
 387     }
 388
 389     pub fn walk_expr(&mut self, expr: &hir::Expr) {
 390         debug!("walk_expr(expr={:?})", expr);
 391
 392         self.walk_adjustment(expr);
 393
 394         match expr.node {
 395             hir::ExprKind::Path(_) => { }
 396
 397             hir::ExprKind::Type(ref subexpr, _) => {
 398                 self.walk_expr(&subexpr)
 399             }
 400
 401             hir::ExprKind::Unary(hir::UnDeref, ref base) => {      // *base
 402                 self.select_from_expr(&base);
 403             }
 404
 405             hir::ExprKind::Field(ref base, _) => {         // base.f
 406                 self.select_from_expr(&base);
 407             }
 408
 409             hir::ExprKind::Index(ref lhs, ref rhs) => {       // lhs[rhs]
 410                 self.select_from_expr(&lhs);
 411                 self.consume_expr(&rhs);
 412             }
 413
 414             hir::ExprKind::Call(ref callee, ref args) => {    // callee(args)
 415                 self.walk_callee(expr, &callee);
 416                 self.consume_exprs(args);
 417             }
 418
 419             hir::ExprKind::MethodCall(.., ref args) => { // callee.m(args)
 420                 self.consume_exprs(args);
 421             }
 422
 423             hir::ExprKind::Struct(_, ref fields, ref opt_with) => {
 424                 self.walk_struct_expr(fields, opt_with);
 425             }
 426
 427             hir::ExprKind::Tup(ref exprs) => {
 428                 self.consume_exprs(exprs);
 429             }
 430
 431             hir::ExprKind::If(ref cond_expr, ref then_expr, ref opt_else_expr) => {
 432                 self.consume_expr(&cond_expr);
 433                 self.walk_expr(&then_expr);
 434                 if let Some(ref else_expr) = *opt_else_expr {
 435                     self.consume_expr(&else_expr);
 436                 }
 437             }
 438
 439             hir::ExprKind::Match(ref discr, ref arms, _) => {
 440                 let discr_cmt = Rc::new(return_if_err!(self.mc.cat_expr(&discr)));
 441                 let r = self.tcx().types.re_empty;
 442                 self.borrow_expr(&discr, r, ty::ImmBorrow, MatchDiscriminant);
 443
 444                 // treatment of the discriminant is handled while walking the arms.
 445                 for arm in arms {
 446                     let mode = self.arm_move_mode(discr_cmt.clone(), arm);
 447                     let mode = mode.match_mode();
 448                     self.walk_arm(discr_cmt.clone(), arm, mode);
 449                 }
 450             }
 451
 452             hir::ExprKind::Array(ref exprs) => {
 453                 self.consume_exprs(exprs);
 454             }
 455
 456             hir::ExprKind::AddrOf(m, ref base) => {   // &base
 457                 // make sure that the thing we are pointing out stays valid
 458                 // for the lifetime `scope_r` of the resulting ptr:
 459                 let expr_ty = return_if_err!(self.mc.expr_ty(expr));
 460                 if let ty::Ref(r, _, _) = expr_ty.sty {
 461                     let bk = ty::BorrowKind::from_mutbl(m);
 462                     self.borrow_expr(&base, r, bk, AddrOf);
 463                 }
 464             }
 465
 466             hir::ExprKind::InlineAsm(ref ia, ref outputs, ref inputs) => {
 467                 for (o, output) in ia.outputs.iter().zip(outputs) {
 468                     if o.is_indirect {
 469                         self.consume_expr(output);
 470                     } else {
 471                         self.mutate_expr(expr, output,
 472                                          if o.is_rw {
 473                                              MutateMode::WriteAndRead
 474                                          } else {
 475                                              MutateMode::JustWrite
 476                                          });
 477                     }
 478                 }
 479                 self.consume_exprs(inputs);
 480             }
 481
 482             hir::ExprKind::Continue(..) |
 483             hir::ExprKind::Lit(..) => {}
 484
 485             hir::ExprKind::Loop(ref blk, _, _) => {
 486                 self.walk_block(&blk);
 487             }
 488
 489             hir::ExprKind::While(ref cond_expr, ref blk, _) => {
 490                 self.consume_expr(&cond_expr);
 491                 self.walk_block(&blk);
 492             }
 493
 494             hir::ExprKind::Unary(_, ref lhs) => {
 495                 self.consume_expr(&lhs);
 496             }
 497
 498             hir::ExprKind::Binary(_, ref lhs, ref rhs) => {
 499                 self.consume_expr(&lhs);
 500                 self.consume_expr(&rhs);
 501             }
 502
 503             hir::ExprKind::Block(ref blk, _) => {
 504                 self.walk_block(&blk);
 505             }
 506
 507             hir::ExprKind::Break(_, ref opt_expr) | hir::ExprKind::Ret(ref opt_expr) => {
 508                 if let Some(ref expr) = *opt_expr {
 509                     self.consume_expr(&expr);
 510                 }
 511             }
 512
 513             hir::ExprKind::Assign(ref lhs, ref rhs) => {
 514                 self.mutate_expr(expr, &lhs, MutateMode::JustWrite);
 515                 self.consume_expr(&rhs);
 516             }
 517
 518             hir::ExprKind::Cast(ref base, _) => {
 519                 self.consume_expr(&base);
 520             }
 521
 522             hir::ExprKind::AssignOp(_, ref lhs, ref rhs) => {
 523                 if self.mc.tables.is_method_call(expr) {
 524                     self.consume_expr(lhs);
 525                 } else {
 526                     self.mutate_expr(expr, &lhs, MutateMode::WriteAndRead);
 527                 }
 528                 self.consume_expr(&rhs);
 529             }
 530
 531             hir::ExprKind::Repeat(ref base, _) => {
 532                 self.consume_expr(&base);
 533             }
 534
 535             hir::ExprKind::Closure(.., fn_decl_span, _) => {
 536                 self.walk_captures(expr, fn_decl_span)
 537             }
 538
 539             hir::ExprKind::Box(ref base) => {
 540                 self.consume_expr(&base);
 541             }
 542
 543             hir::ExprKind::Yield(ref value) => {
 544                 self.consume_expr(&value);
 545             }
 546         }
 547     }
 548
 549     fn walk_callee(&mut self, call: &hir::Expr, callee: &hir::Expr) {
 550         let callee_ty = return_if_err!(self.mc.expr_ty_adjusted(callee));
 551         debug!("walk_callee: callee={:?} callee_ty={:?}",
 552                callee, callee_ty);
 553         match callee_ty.sty {
 554             ty::FnDef(..) | ty::FnPtr(_) => {
 555                 self.consume_expr(callee);
 556             }
 557             ty::Error => { }
 558             _ => {
 559                 if let Some(def) = self.mc.tables.type_dependent_defs().get(call.hir_id) {
 560                     let def_id = def.def_id();
 561                     let call_scope = region::Scope::Node(call.hir_id.local_id);
 562                     match OverloadedCallType::from_method_id(self.tcx(), def_id) {
 563                         FnMutOverloadedCall => {
 564                             let call_scope_r = self.tcx().mk_region(ty::ReScope(call_scope));
 565                             self.borrow_expr(callee,
 566                                             call_scope_r,
 567                                             ty::MutBorrow,
 568                                             ClosureInvocation);
 569                         }
 570                         FnOverloadedCall => {
 571                             let call_scope_r = self.tcx().mk_region(ty::ReScope(call_scope));
 572                             self.borrow_expr(callee,
 573                                             call_scope_r,
 574                                             ty::ImmBorrow,
 575                                             ClosureInvocation);
 576                         }
 577                         FnOnceOverloadedCall => self.consume_expr(callee),
 578                     }
 579                 } else {
 580                     self.tcx().sess.delay_span_bug(call.span,
 581                                                    "no type-dependent def for overloaded call");
 582                 }
 583             }
 584         }
 585     }
 586
 587     fn walk_stmt(&mut self, stmt: &hir::Stmt) {
 588         match stmt.node {
 589             hir::StmtKind::Decl(ref decl, _) => {
 590                 match decl.node {
 591                     hir::DeclKind::Local(ref local) => {
 592                         self.walk_local(&local);
 593                     }
 594
 595                     hir::DeclKind::Item(_) => {
 596                         // we don't visit nested items in this visitor,
 597                         // only the fn body we were given.
 598                     }
 599                 }
 600             }
 601
 602             hir::StmtKind::Expr(ref expr, _) |
 603             hir::StmtKind::Semi(ref expr, _) => {
 604                 self.consume_expr(&expr);
 605             }
 606         }
 607     }
 608
 609     fn walk_local(&mut self, local: &hir::Local) {
 610         match local.init {
 611             None => {
 612                 local.pat.each_binding(|_, hir_id, span, _| {
 613                     let node_id = self.mc.tcx.hir.hir_to_node_id(hir_id);
 614                     self.delegate.decl_without_init(node_id, span);
 615                 })
 616             }
 617
 618             Some(ref expr) => {
 619                 // Variable declarations with
 620                 // initializers are considered
 621                 // "assigns", which is handled by
 622                 // `walk_pat`:
 623                 self.walk_expr(&expr);
 624                 let init_cmt = Rc::new(return_if_err!(self.mc.cat_expr(&expr)));
 625                 self.walk_irrefutable_pat(init_cmt, &local.pat);
 626             }
 627         }
 628     }
 629
 630     /// Indicates that the value of `blk` will be consumed, meaning either copied or moved
 631     /// depending on its type.
 632     fn walk_block(&mut self, blk: &hir::Block) {
 633         debug!("walk_block(blk.id={})", blk.id);
 634
 635         for stmt in &blk.stmts {
 636             self.walk_stmt(stmt);
 637         }
 638
 639         if let Some(ref tail_expr) = blk.expr {
 640             self.consume_expr(&tail_expr);
 641         }
 642     }
 643
 644     fn walk_struct_expr(&mut self,
 645                         fields: &[hir::Field],
 646                         opt_with: &Option<P<hir::Expr>>) {
 647         // Consume the expressions supplying values for each field.
 648         for field in fields {
 649             self.consume_expr(&field.expr);
 650         }
 651
 652         let with_expr = match *opt_with {
 653             Some(ref w) => &**w,
 654             None => { return; }
 655         };
 656
 657         let with_cmt = Rc::new(return_if_err!(self.mc.cat_expr(&with_expr)));
 658
 659         // Select just those fields of the `with`
 660         // expression that will actually be used
 661         match with_cmt.ty.sty {
 662             ty::Adt(adt, substs) if adt.is_struct() => {
 663                 // Consume those fields of the with expression that are needed.
 664                 for (f_index, with_field) in adt.non_enum_variant().fields.iter().enumerate() {
 665                     let is_mentioned = fields.iter().any(|f| {
 666                         self.tcx().field_index(f.id, self.mc.tables) == f_index
 667                     });
 668                     if !is_mentioned {
 669                         let cmt_field = self.mc.cat_field(
 670                             &*with_expr,
 671                             with_cmt.clone(),
 672                             f_index,
 673                             with_field.ident,
 674                             with_field.ty(self.tcx(), substs)
 675                         );
 676                         self.delegate_consume(with_expr.id, with_expr.span, &cmt_field);
 677                     }
 678                 }
 679             }
 680             _ => {
 681                 // the base expression should always evaluate to a
 682                 // struct; however, when EUV is run during typeck, it
 683                 // may not. This will generate an error earlier in typeck,
 684                 // so we can just ignore it.
 685                 if !self.tcx().sess.has_errors() {
 686                     span_bug!(
 687                         with_expr.span,
 688                         "with expression doesn't evaluate to a struct");
 689                 }
 690             }
 691         }
 692
 693         // walk the with expression so that complex expressions
 694         // are properly handled.
 695         self.walk_expr(with_expr);
 696     }
 697
 698     // Invoke the appropriate delegate calls for anything that gets
 699     // consumed or borrowed as part of the automatic adjustment
 700     // process.
 701     fn walk_adjustment(&mut self, expr: &hir::Expr) {
 702         let adjustments = self.mc.tables.expr_adjustments(expr);
 703         let mut cmt = return_if_err!(self.mc.cat_expr_unadjusted(expr));
 704         for adjustment in adjustments {
 705             debug!("walk_adjustment expr={:?} adj={:?}", expr, adjustment);
 706             match adjustment.kind {
 707                 adjustment::Adjust::NeverToAny |
 708                 adjustment::Adjust::ReifyFnPointer |
 709                 adjustment::Adjust::UnsafeFnPointer |
 710                 adjustment::Adjust::ClosureFnPointer |
 711                 adjustment::Adjust::MutToConstPointer |
 712                 adjustment::Adjust::Unsize => {
 713                     // Creating a closure/fn-pointer or unsizing consumes
 714                     // the input and stores it into the resulting rvalue.
 715                     self.delegate_consume(expr.id, expr.span, &cmt);
 716                 }
 717
 718                 adjustment::Adjust::Deref(None) => {}
 719
 720                 // Autoderefs for overloaded Deref calls in fact reference
 721                 // their receiver. That is, if we have `(*x)` where `x`
 722                 // is of type `Rc<T>`, then this in fact is equivalent to
 723                 // `x.deref()`. Since `deref()` is declared with `&self`,
 724                 // this is an autoref of `x`.
 725                 adjustment::Adjust::Deref(Some(ref deref)) => {
 726                     let bk = ty::BorrowKind::from_mutbl(deref.mutbl);
 727                     self.delegate.borrow(expr.id, expr.span, &cmt, deref.region, bk, AutoRef);
 728                 }
 729
 730                 adjustment::Adjust::Borrow(ref autoref) => {
 731                     self.walk_autoref(expr, &cmt, autoref);
 732                 }
 733             }
 734             cmt = return_if_err!(self.mc.cat_expr_adjusted(expr, cmt, &adjustment));
 735         }
 736     }
 737
 738     /// Walks the autoref `autoref` applied to the autoderef'd
 739     /// `expr`. `cmt_base` is the mem-categorized form of `expr`
 740     /// after all relevant autoderefs have occurred.
 741     fn walk_autoref(&mut self,
 742                     expr: &hir::Expr,
 743                     cmt_base: &mc::cmt_<'tcx>,
 744                     autoref: &adjustment::AutoBorrow<'tcx>) {
 745         debug!("walk_autoref(expr.id={} cmt_base={:?} autoref={:?})",
 746                expr.id,
 747                cmt_base,
 748                autoref);
 749
 750         match *autoref {
 751             adjustment::AutoBorrow::Ref(r, m) => {
 752                 self.delegate.borrow(expr.id,
 753                                      expr.span,
 754                                      cmt_base,
 755                                      r,
 756                                      ty::BorrowKind::from_mutbl(m.into()),
 757                                      AutoRef);
 758             }
 759
 760             adjustment::AutoBorrow::RawPtr(m) => {
 761                 debug!("walk_autoref: expr.id={} cmt_base={:?}",
 762                        expr.id,
 763                        cmt_base);
 764
 765                 // Converting from a &T to *T (or &mut T to *mut T) is
 766                 // treated as borrowing it for the enclosing temporary
 767                 // scope.
 768                 let r = self.tcx().mk_region(ty::ReScope(
 769                     region::Scope::Node(expr.hir_id.local_id)));
 770
 771                 self.delegate.borrow(expr.id,
 772                                      expr.span,
 773                                      cmt_base,
 774                                      r,
 775                                      ty::BorrowKind::from_mutbl(m),
 776                                      AutoUnsafe);
 777             }
 778         }
 779     }
 780
 781     fn arm_move_mode(&mut self, discr_cmt: mc::cmt<'tcx>, arm: &hir::Arm) -> TrackMatchMode {
 782         let mut mode = Unknown;
 783         for pat in &arm.pats {
 784             self.determine_pat_move_mode(discr_cmt.clone(), &pat, &mut mode);
 785         }
 786         mode
 787     }
 788
 789     fn walk_arm(&mut self, discr_cmt: mc::cmt<'tcx>, arm: &hir::Arm, mode: MatchMode) {
 790         for pat in &arm.pats {
 791             self.walk_pat(discr_cmt.clone(), &pat, mode);
 792         }
 793
 794         if let Some(ref guard) = arm.guard {
 795             match guard {
 796                 hir::Guard::If(ref e) => self.consume_expr(e),
 797             }
 798         }
 799
 800         self.consume_expr(&arm.body);
 801     }
 802
 803     /// Walks a pat that occurs in isolation (i.e. top-level of fn
 804     /// arg or let binding.  *Not* a match arm or nested pat.)
 805     fn walk_irrefutable_pat(&mut self, cmt_discr: mc::cmt<'tcx>, pat: &hir::Pat) {
 806         let mut mode = Unknown;
 807         self.determine_pat_move_mode(cmt_discr.clone(), pat, &mut mode);
 808         let mode = mode.match_mode();
 809         self.walk_pat(cmt_discr, pat, mode);
 810     }
 811
 812     /// Identifies any bindings within `pat` and accumulates within
 813     /// `mode` whether the overall pattern/match structure is a move,
 814     /// copy, or borrow.
 815     fn determine_pat_move_mode(&mut self,
 816                                cmt_discr: mc::cmt<'tcx>,
 817                                pat: &hir::Pat,
 818                                mode: &mut TrackMatchMode) {
 819         debug!("determine_pat_move_mode cmt_discr={:?} pat={:?}", cmt_discr,
 820                pat);
 821         return_if_err!(self.mc.cat_pattern(cmt_discr, pat, |cmt_pat, pat| {
 822             if let PatKind::Binding(..) = pat.node {
 823                 let bm = *self.mc.tables.pat_binding_modes().get(pat.hir_id)
 824                                                           .expect("missing binding mode");
 825                 match bm {
 826                     ty::BindByReference(..) =>
 827                         mode.lub(BorrowingMatch),
 828                     ty::BindByValue(..) => {
 829                         match copy_or_move(&self.mc, self.param_env, &cmt_pat, PatBindingMove) {
 830                             Copy => mode.lub(CopyingMatch),
 831                             Move(..) => mode.lub(MovingMatch),
 832                         }
 833                     }
 834                 }
 835             }
 836         }));
 837     }
 838
 839     /// The core driver for walking a pattern; `match_mode` must be
 840     /// established up front, e.g. via `determine_pat_move_mode` (see
 841     /// also `walk_irrefutable_pat` for patterns that stand alone).
 842     fn walk_pat(&mut self, cmt_discr: mc::cmt<'tcx>, pat: &hir::Pat, match_mode: MatchMode) {
 843         debug!("walk_pat(cmt_discr={:?}, pat={:?})", cmt_discr, pat);
 844
 845         let tcx = self.tcx();
 846         let ExprUseVisitor { ref mc, ref mut delegate, param_env } = *self;
 847         return_if_err!(mc.cat_pattern(cmt_discr.clone(), pat, |cmt_pat, pat| {
 848             if let PatKind::Binding(_, canonical_id, ..) = pat.node {
 849                 debug!(
 850                     "walk_pat: binding cmt_pat={:?} pat={:?} match_mode={:?}",
 851                     cmt_pat,
 852                     pat,
 853                     match_mode,
 854                 );
 855                 if let Some(&bm) = mc.tables.pat_binding_modes().get(pat.hir_id) {
 856                     debug!("walk_pat: pat.hir_id={:?} bm={:?}", pat.hir_id, bm);
 857
 858                     // pat_ty: the type of the binding being produced.
 859                     let pat_ty = return_if_err!(mc.node_ty(pat.hir_id));
 860                     debug!("walk_pat: pat_ty={:?}", pat_ty);
 861
 862                     // Each match binding is effectively an assignment to the
 863                     // binding being produced.
 864                     let def = Def::Local(canonical_id);
 865                     if let Ok(ref binding_cmt) = mc.cat_def(pat.hir_id, pat.span, pat_ty, def) {
 866                         delegate.mutate(pat.id, pat.span, binding_cmt, MutateMode::Init);
 867                     }
 868
 869                     // It is also a borrow or copy/move of the value being matched.
 870                     match bm {
 871                         ty::BindByReference(m) => {
 872                             if let ty::Ref(r, _, _) = pat_ty.sty {
 873                                 let bk = ty::BorrowKind::from_mutbl(m);
 874                                 delegate.borrow(pat.id, pat.span, &cmt_pat, r, bk, RefBinding);
 875                             }
 876                         }
 877                         ty::BindByValue(..) => {
 878                             let mode = copy_or_move(mc, param_env, &cmt_pat, PatBindingMove);
 879                             debug!("walk_pat binding consuming pat");
 880                             delegate.consume_pat(pat, &cmt_pat, mode);
 881                         }
 882                     }
 883                 } else {
 884                     tcx.sess.delay_span_bug(pat.span, "missing binding mode");
 885                 }
 886             }
 887         }));
 888
 889         // Do a second pass over the pattern, calling `matched_pat` on
 890         // the interior nodes (enum variants and structs), as opposed
 891         // to the above loop's visit of than the bindings that form
 892         // the leaves of the pattern tree structure.
 893         return_if_err!(mc.cat_pattern(cmt_discr, pat, |cmt_pat, pat| {
 894             let qpath = match pat.node {
 895                 PatKind::Path(ref qpath) |
 896                 PatKind::TupleStruct(ref qpath, ..) |
 897                 PatKind::Struct(ref qpath, ..) => qpath,
 898                 _ => return
 899             };
 900             let def = mc.tables.qpath_def(qpath, pat.hir_id);
 901             match def {
 902                 Def::Variant(variant_did) |
 903                 Def::VariantCtor(variant_did, ..) => {
 904                     let downcast_cmt = mc.cat_downcast_if_needed(pat, cmt_pat, variant_did);
 905
 906                     debug!("variant downcast_cmt={:?} pat={:?}", downcast_cmt, pat);
 907                     delegate.matched_pat(pat, &downcast_cmt, match_mode);
 908                 }
 909                 Def::Struct(..) | Def::StructCtor(..) | Def::Union(..) |
 910                 Def::TyAlias(..) | Def::AssociatedTy(..) | Def::SelfTy(..) => {
 911                     debug!("struct cmt_pat={:?} pat={:?}", cmt_pat, pat);
 912                     delegate.matched_pat(pat, &cmt_pat, match_mode);
 913                 }
 914                 _ => {}
 915             }
 916         }));
 917     }
 918
 919     fn walk_captures(&mut self, closure_expr: &hir::Expr, fn_decl_span: Span) {
 920         debug!("walk_captures({:?})", closure_expr);
 921
 922         self.tcx().with_freevars(closure_expr.id, |freevars| {
 923             for freevar in freevars {
 924                 let var_hir_id = self.tcx().hir.node_to_hir_id(freevar.var_id());
 925                 let closure_def_id = self.tcx().hir.local_def_id(closure_expr.id);
 926                 let upvar_id = ty::UpvarId {
 927                     var_id: var_hir_id,
 928                     closure_expr_id: closure_def_id.to_local(),
 929                 };
 930                 let upvar_capture = self.mc.tables.upvar_capture(upvar_id);
 931                 let cmt_var = return_if_err!(self.cat_captured_var(closure_expr.hir_id,
 932                                                                    fn_decl_span,
 933                                                                    freevar));
 934                 match upvar_capture {
 935                     ty::UpvarCapture::ByValue => {
 936                         let mode = copy_or_move(&self.mc,
 937                                                 self.param_env,
 938                                                 &cmt_var,
 939                                                 CaptureMove);
 940                         self.delegate.consume(closure_expr.id, freevar.span, &cmt_var, mode);
 941                     }
 942                     ty::UpvarCapture::ByRef(upvar_borrow) => {
 943                         self.delegate.borrow(closure_expr.id,
 944                                              fn_decl_span,
 945                                              &cmt_var,
 946                                              upvar_borrow.region,
 947                                              upvar_borrow.kind,
 948                                              ClosureCapture(freevar.span));
 949                     }
 950                 }
 951             }
 952         });
 953     }
 954
 955     fn cat_captured_var(&mut self,
 956                         closure_hir_id: hir::HirId,
 957                         closure_span: Span,
 958                         upvar: &hir::Freevar)
 959                         -> mc::McResult<mc::cmt_<'tcx>> {
 960         // Create the cmt for the variable being borrowed, from the
 961         // caller's perspective
 962         let var_hir_id = self.tcx().hir.node_to_hir_id(upvar.var_id());
 963         let var_ty = self.mc.node_ty(var_hir_id)?;
 964         self.mc.cat_def(closure_hir_id, closure_span, var_ty, upvar.def)
 965     }
 966 }
 967
 968 fn copy_or_move<'a, 'gcx, 'tcx>(mc: &mc::MemCategorizationContext<'a, 'gcx, 'tcx>,
 969                                 param_env: ty::ParamEnv<'tcx>,
 970                                 cmt: &mc::cmt_<'tcx>,
 971                                 move_reason: MoveReason)
 972                                 -> ConsumeMode
 973 {
 974     if mc.type_moves_by_default(param_env, cmt.ty, cmt.span) {
 975         Move(move_reason)
 976     } else {
 977         Copy
 978     }
 979 }