compiler/rustc_middle/src/mir/visit.rs

   1 //! # The MIR Visitor
   2 //!
   3 //! ## Overview
   4 //!
   5 //! There are two visitors, one for immutable and one for mutable references,
   6 //! but both are generated by the following macro. The code is written according
   7 //! to the following conventions:
   8 //!
   9 //! - introduce a `visit_foo` and a `super_foo` method for every MIR type
  10 //! - `visit_foo`, by default, calls `super_foo`
  11 //! - `super_foo`, by default, destructures the `foo` and calls `visit_foo`
  12 //!
  13 //! This allows you as a user to override `visit_foo` for types are
  14 //! interested in, and invoke (within that method) call
  15 //! `self.super_foo` to get the default behavior. Just as in an OO
  16 //! language, you should never call `super` methods ordinarily except
  17 //! in that circumstance.
  18 //!
  19 //! For the most part, we do not destructure things external to the
  20 //! MIR, e.g., types, spans, etc, but simply visit them and stop. This
  21 //! avoids duplication with other visitors like `TypeFoldable`.
  22 //!
  23 //! ## Updating
  24 //!
  25 //! The code is written in a very deliberate style intended to minimize
  26 //! the chance of things being overlooked. You'll notice that we always
  27 //! use pattern matching to reference fields and we ensure that all
  28 //! matches are exhaustive.
  29 //!
  30 //! For example, the `super_basic_block_data` method begins like this:
  31 //!
  32 //! ```rust
  33 //! fn super_basic_block_data(&mut self,
  34 //!                           block: BasicBlock,
  35 //!                           data: & $($mutability)? BasicBlockData<'tcx>) {
  36 //!     let BasicBlockData {
  37 //!         statements,
  38 //!         terminator,
  39 //!         is_cleanup: _
  40 //!     } = *data;
  41 //!
  42 //!     for statement in statements {
  43 //!         self.visit_statement(block, statement);
  44 //!     }
  45 //!
  46 //!     ...
  47 //! }
  48 //! ```
  49 //!
  50 //! Here we used `let BasicBlockData { <fields> } = *data` deliberately,
  51 //! rather than writing `data.statements` in the body. This is because if one
  52 //! adds a new field to `BasicBlockData`, one will be forced to revise this code,
  53 //! and hence one will (hopefully) invoke the correct visit methods (if any).
  54 //!
  55 //! For this to work, ALL MATCHES MUST BE EXHAUSTIVE IN FIELDS AND VARIANTS.
  56 //! That means you never write `..` to skip over fields, nor do you write `_`
  57 //! to skip over variants in a `match`.
  58 //!
  59 //! The only place that `_` is acceptable is to match a field (or
  60 //! variant argument) that does not require visiting, as in
  61 //! `is_cleanup` above.
  62
  63 use crate::mir::*;
  64 use crate::ty::subst::SubstsRef;
  65 use crate::ty::{CanonicalUserTypeAnnotation, Ty};
  66 use rustc_span::Span;
  67
  68 macro_rules! make_mir_visitor {
  69     ($visitor_trait_name:ident, $($mutability:ident)?) => {
  70         pub trait $visitor_trait_name<'tcx> {
  71             // Override these, and call `self.super_xxx` to revert back to the
  72             // default behavior.
  73
  74             fn visit_body(
  75                 &mut self,
  76                 body: &$($mutability)? Body<'tcx>,
  77             ) {
  78                 self.super_body(body);
  79             }
  80
  81             fn visit_basic_block_data(&mut self,
  82                                       block: BasicBlock,
  83                                       data: & $($mutability)? BasicBlockData<'tcx>) {
  84                 self.super_basic_block_data(block, data);
  85             }
  86
  87             fn visit_source_scope_data(&mut self,
  88                                            scope_data: & $($mutability)? SourceScopeData<'tcx>) {
  89                 self.super_source_scope_data(scope_data);
  90             }
  91
  92             fn visit_statement(&mut self,
  93                                statement: & $($mutability)? Statement<'tcx>,
  94                                location: Location) {
  95                 self.super_statement(statement, location);
  96             }
  97
  98             fn visit_assign(&mut self,
  99                             place: & $($mutability)? Place<'tcx>,
 100                             rvalue: & $($mutability)? Rvalue<'tcx>,
 101                             location: Location) {
 102                 self.super_assign(place, rvalue, location);
 103             }
 104
 105             fn visit_terminator(&mut self,
 106                                 terminator: & $($mutability)? Terminator<'tcx>,
 107                                 location: Location) {
 108                 self.super_terminator(terminator, location);
 109             }
 110
 111             fn visit_assert_message(&mut self,
 112                                     msg: & $($mutability)? AssertMessage<'tcx>,
 113                                     location: Location) {
 114                 self.super_assert_message(msg, location);
 115             }
 116
 117             fn visit_rvalue(&mut self,
 118                             rvalue: & $($mutability)? Rvalue<'tcx>,
 119                             location: Location) {
 120                 self.super_rvalue(rvalue, location);
 121             }
 122
 123             fn visit_operand(&mut self,
 124                              operand: & $($mutability)? Operand<'tcx>,
 125                              location: Location) {
 126                 self.super_operand(operand, location);
 127             }
 128
 129             fn visit_ascribe_user_ty(&mut self,
 130                                      place: & $($mutability)? Place<'tcx>,
 131                                      variance: & $($mutability)? ty::Variance,
 132                                      user_ty: & $($mutability)? UserTypeProjection,
 133                                      location: Location) {
 134                 self.super_ascribe_user_ty(place, variance, user_ty, location);
 135             }
 136
 137             fn visit_coverage(&mut self,
 138                               coverage: & $($mutability)? Coverage,
 139                               location: Location) {
 140                 self.super_coverage(coverage, location);
 141             }
 142
 143             fn visit_retag(&mut self,
 144                            kind: & $($mutability)? RetagKind,
 145                            place: & $($mutability)? Place<'tcx>,
 146                            location: Location) {
 147                 self.super_retag(kind, place, location);
 148             }
 149
 150             fn visit_place(&mut self,
 151                             place: & $($mutability)? Place<'tcx>,
 152                             context: PlaceContext,
 153                             location: Location) {
 154                 self.super_place(place, context, location);
 155             }
 156
 157             visit_place_fns!($($mutability)?);
 158
 159             fn visit_constant(&mut self,
 160                               constant: & $($mutability)? Constant<'tcx>,
 161                               location: Location) {
 162                 self.super_constant(constant, location);
 163             }
 164
 165             fn visit_span(&mut self,
 166                           span: & $($mutability)? Span) {
 167                 self.super_span(span);
 168             }
 169
 170             fn visit_source_info(&mut self,
 171                                  source_info: & $($mutability)? SourceInfo) {
 172                 self.super_source_info(source_info);
 173             }
 174
 175             fn visit_ty(&mut self,
 176                         ty: $(& $mutability)? Ty<'tcx>,
 177                         _: TyContext) {
 178                 self.super_ty(ty);
 179             }
 180
 181             fn visit_user_type_projection(
 182                 &mut self,
 183                 ty: & $($mutability)? UserTypeProjection,
 184             ) {
 185                 self.super_user_type_projection(ty);
 186             }
 187
 188             fn visit_user_type_annotation(
 189                 &mut self,
 190                 index: UserTypeAnnotationIndex,
 191                 ty: & $($mutability)? CanonicalUserTypeAnnotation<'tcx>,
 192             ) {
 193                 self.super_user_type_annotation(index, ty);
 194             }
 195
 196             fn visit_region(&mut self,
 197                             region: & $($mutability)? ty::Region<'tcx>,
 198                             _: Location) {
 199                 self.super_region(region);
 200             }
 201
 202             fn visit_const(&mut self,
 203                            constant: & $($mutability)? &'tcx ty::Const<'tcx>,
 204                            _: Location) {
 205                 self.super_const(constant);
 206             }
 207
 208             fn visit_substs(&mut self,
 209                             substs: & $($mutability)? SubstsRef<'tcx>,
 210                             _: Location) {
 211                 self.super_substs(substs);
 212             }
 213
 214             fn visit_local_decl(&mut self,
 215                                 local: Local,
 216                                 local_decl: & $($mutability)? LocalDecl<'tcx>) {
 217                 self.super_local_decl(local, local_decl);
 218             }
 219
 220             fn visit_var_debug_info(&mut self,
 221                                     var_debug_info: & $($mutability)* VarDebugInfo<'tcx>) {
 222                 self.super_var_debug_info(var_debug_info);
 223             }
 224
 225             fn visit_local(&mut self,
 226                             _local: & $($mutability)? Local,
 227                             _context: PlaceContext,
 228                             _location: Location) {
 229             }
 230
 231             fn visit_source_scope(&mut self,
 232                                       scope: & $($mutability)? SourceScope) {
 233                 self.super_source_scope(scope);
 234             }
 235
 236             // The `super_xxx` methods comprise the default behavior and are
 237             // not meant to be overridden.
 238
 239             fn super_body(
 240                 &mut self,
 241                 body: &$($mutability)? Body<'tcx>,
 242             ) {
 243                 let span = body.span;
 244                 if let Some(gen) = &$($mutability)? body.generator {
 245                     if let Some(yield_ty) = &$($mutability)? gen.yield_ty {
 246                         self.visit_ty(
 247                             yield_ty,
 248                             TyContext::YieldTy(SourceInfo::outermost(span))
 249                         );
 250                     }
 251                 }
 252
 253                 // for best performance, we want to use an iterator rather
 254                 // than a for-loop, to avoid calling `body::Body::invalidate` for
 255                 // each basic block.
 256                 macro_rules! basic_blocks {
 257                     (mut) => (body.basic_blocks_mut().iter_enumerated_mut());
 258                     () => (body.basic_blocks().iter_enumerated());
 259                 }
 260                 for (bb, data) in basic_blocks!($($mutability)?) {
 261                     self.visit_basic_block_data(bb, data);
 262                 }
 263
 264                 for scope in &$($mutability)? body.source_scopes {
 265                     self.visit_source_scope_data(scope);
 266                 }
 267
 268                 self.visit_ty(
 269                     &$($mutability)? body.return_ty(),
 270                     TyContext::ReturnTy(SourceInfo::outermost(body.span))
 271                 );
 272
 273                 for local in body.local_decls.indices() {
 274                     self.visit_local_decl(local, & $($mutability)? body.local_decls[local]);
 275                 }
 276
 277                 macro_rules! type_annotations {
 278                     (mut) => (body.user_type_annotations.iter_enumerated_mut());
 279                     () => (body.user_type_annotations.iter_enumerated());
 280                 }
 281
 282                 for (index, annotation) in type_annotations!($($mutability)?) {
 283                     self.visit_user_type_annotation(
 284                         index, annotation
 285                     );
 286                 }
 287
 288                 for var_debug_info in &$($mutability)? body.var_debug_info {
 289                     self.visit_var_debug_info(var_debug_info);
 290                 }
 291
 292                 self.visit_span(&$($mutability)? body.span);
 293
 294                 for const_ in &$($mutability)? body.required_consts {
 295                     let location = START_BLOCK.start_location();
 296                     self.visit_constant(const_, location);
 297                 }
 298             }
 299
 300             fn super_basic_block_data(&mut self,
 301                                       block: BasicBlock,
 302                                       data: & $($mutability)? BasicBlockData<'tcx>) {
 303                 let BasicBlockData {
 304                     statements,
 305                     terminator,
 306                     is_cleanup: _
 307                 } = data;
 308
 309                 let mut index = 0;
 310                 for statement in statements {
 311                     let location = Location { block, statement_index: index };
 312                     self.visit_statement(statement, location);
 313                     index += 1;
 314                 }
 315
 316                 if let Some(terminator) = terminator {
 317                     let location = Location { block, statement_index: index };
 318                     self.visit_terminator(terminator, location);
 319                 }
 320             }
 321
 322             fn super_source_scope_data(
 323                 &mut self,
 324                 scope_data: & $($mutability)? SourceScopeData<'tcx>,
 325             ) {
 326                 let SourceScopeData {
 327                     span,
 328                     parent_scope,
 329                     inlined,
 330                     inlined_parent_scope,
 331                     local_data: _,
 332                 } = scope_data;
 333
 334                 self.visit_span(span);
 335                 if let Some(parent_scope) = parent_scope {
 336                     self.visit_source_scope(parent_scope);
 337                 }
 338                 if let Some((callee, callsite_span)) = inlined {
 339                     let location = START_BLOCK.start_location();
 340
 341                     self.visit_span(callsite_span);
 342
 343                     let ty::Instance { def: callee_def, substs: callee_substs } = callee;
 344                     match callee_def {
 345                         ty::InstanceDef::Item(_def_id) => {}
 346
 347                         ty::InstanceDef::Intrinsic(_def_id) |
 348                         ty::InstanceDef::VtableShim(_def_id) |
 349                         ty::InstanceDef::ReifyShim(_def_id) |
 350                         ty::InstanceDef::Virtual(_def_id, _) |
 351                         ty::InstanceDef::ClosureOnceShim { call_once: _def_id } |
 352                         ty::InstanceDef::DropGlue(_def_id, None) => {}
 353
 354                         ty::InstanceDef::FnPtrShim(_def_id, ty) |
 355                         ty::InstanceDef::DropGlue(_def_id, Some(ty)) |
 356                         ty::InstanceDef::CloneShim(_def_id, ty) => {
 357                             // FIXME(eddyb) use a better `TyContext` here.
 358                             self.visit_ty(ty, TyContext::Location(location));
 359                         }
 360                     }
 361                     self.visit_substs(callee_substs, location);
 362                 }
 363                 if let Some(inlined_parent_scope) = inlined_parent_scope {
 364                     self.visit_source_scope(inlined_parent_scope);
 365                 }
 366             }
 367
 368             fn super_statement(&mut self,
 369                                statement: & $($mutability)? Statement<'tcx>,
 370                                location: Location) {
 371                 let Statement {
 372                     source_info,
 373                     kind,
 374                 } = statement;
 375
 376                 self.visit_source_info(source_info);
 377                 match kind {
 378                     StatementKind::Assign(
 379                         box(ref $($mutability)? place, ref $($mutability)? rvalue)
 380                     ) => {
 381                         self.visit_assign(place, rvalue, location);
 382                     }
 383                     StatementKind::FakeRead(_, place) => {
 384                         self.visit_place(
 385                             place,
 386                             PlaceContext::NonMutatingUse(NonMutatingUseContext::Inspect),
 387                             location
 388                         );
 389                     }
 390                     StatementKind::SetDiscriminant { place, .. } => {
 391                         self.visit_place(
 392                             place,
 393                             PlaceContext::MutatingUse(MutatingUseContext::Store),
 394                             location
 395                         );
 396                     }
 397                     StatementKind::StorageLive(local) => {
 398                         self.visit_local(
 399                             local,
 400                             PlaceContext::NonUse(NonUseContext::StorageLive),
 401                             location
 402                         );
 403                     }
 404                     StatementKind::StorageDead(local) => {
 405                         self.visit_local(
 406                             local,
 407                             PlaceContext::NonUse(NonUseContext::StorageDead),
 408                             location
 409                         );
 410                     }
 411                     StatementKind::LlvmInlineAsm(asm) => {
 412                         for output in & $($mutability)? asm.outputs[..] {
 413                             self.visit_place(
 414                                 output,
 415                                 PlaceContext::MutatingUse(MutatingUseContext::AsmOutput),
 416                                 location
 417                             );
 418                         }
 419                         for (span, input) in & $($mutability)? asm.inputs[..] {
 420                             self.visit_span(span);
 421                             self.visit_operand(input, location);
 422                         }
 423                     }
 424                     StatementKind::Retag(kind, place) => {
 425                         self.visit_retag(kind, place, location);
 426                     }
 427                     StatementKind::AscribeUserType(
 428                         box(ref $($mutability)? place, ref $($mutability)? user_ty),
 429                         variance
 430                     ) => {
 431                         self.visit_ascribe_user_ty(place, variance, user_ty, location);
 432                     }
 433                     StatementKind::Coverage(coverage) => {
 434                         self.visit_coverage(
 435                             coverage,
 436                             location
 437                         )
 438                     }
 439                     StatementKind::CopyNonOverlapping(box crate::mir::CopyNonOverlapping{
 440                       ref $($mutability)? src,
 441                       ref $($mutability)? dst,
 442                       ref $($mutability)? count,
 443                     }) => {
 444                       self.visit_operand(src, location);
 445                       self.visit_operand(dst, location);
 446                       self.visit_operand(count, location)
 447                     }
 448                     StatementKind::Nop => {}
 449                 }
 450             }
 451
 452             fn super_assign(&mut self,
 453                             place: &$($mutability)? Place<'tcx>,
 454                             rvalue: &$($mutability)? Rvalue<'tcx>,
 455                             location: Location) {
 456                 self.visit_place(
 457                     place,
 458                     PlaceContext::MutatingUse(MutatingUseContext::Store),
 459                     location
 460                 );
 461                 self.visit_rvalue(rvalue, location);
 462             }
 463
 464             fn super_terminator(&mut self,
 465                                 terminator: &$($mutability)? Terminator<'tcx>,
 466                                 location: Location) {
 467                 let Terminator { source_info, kind } = terminator;
 468
 469                 self.visit_source_info(source_info);
 470                 match kind {
 471                     TerminatorKind::Goto { .. } |
 472                     TerminatorKind::Resume |
 473                     TerminatorKind::Abort |
 474                     TerminatorKind::GeneratorDrop |
 475                     TerminatorKind::Unreachable |
 476                     TerminatorKind::FalseEdge { .. } |
 477                     TerminatorKind::FalseUnwind { .. } => {
 478                     }
 479
 480                     TerminatorKind::Return => {
 481                         // `return` logically moves from the return place `_0`. Note that the place
 482                         // cannot be changed by any visitor, though.
 483                         let $($mutability)? local = RETURN_PLACE;
 484                         self.visit_local(
 485                             & $($mutability)? local,
 486                             PlaceContext::NonMutatingUse(NonMutatingUseContext::Move),
 487                             location,
 488                         );
 489
 490                         assert_eq!(
 491                             local,
 492                             RETURN_PLACE,
 493                             "`MutVisitor` tried to mutate return place of `return` terminator"
 494                         );
 495                     }
 496
 497                     TerminatorKind::SwitchInt {
 498                         discr,
 499                         switch_ty,
 500                         targets: _
 501                     } => {
 502                         self.visit_operand(discr, location);
 503                         self.visit_ty(switch_ty, TyContext::Location(location));
 504                     }
 505
 506                     TerminatorKind::Drop {
 507                         place,
 508                         target: _,
 509                         unwind: _,
 510                     } => {
 511                         self.visit_place(
 512                             place,
 513                             PlaceContext::MutatingUse(MutatingUseContext::Drop),
 514                             location
 515                         );
 516                     }
 517
 518                     TerminatorKind::DropAndReplace {
 519                         place,
 520                         value,
 521                         target: _,
 522                         unwind: _,
 523                     } => {
 524                         self.visit_place(
 525                             place,
 526                             PlaceContext::MutatingUse(MutatingUseContext::Drop),
 527                             location
 528                         );
 529                         self.visit_operand(value, location);
 530                     }
 531
 532                     TerminatorKind::Call {
 533                         func,
 534                         args,
 535                         destination,
 536                         cleanup: _,
 537                         from_hir_call: _,
 538                         fn_span: _
 539                     } => {
 540                         self.visit_operand(func, location);
 541                         for arg in args {
 542                             self.visit_operand(arg, location);
 543                         }
 544                         if let Some((destination, _)) = destination {
 545                             self.visit_place(
 546                                 destination,
 547                                 PlaceContext::MutatingUse(MutatingUseContext::Call),
 548                                 location
 549                             );
 550                         }
 551                     }
 552
 553                     TerminatorKind::Assert {
 554                         cond,
 555                         expected: _,
 556                         msg,
 557                         target: _,
 558                         cleanup: _,
 559                     } => {
 560                         self.visit_operand(cond, location);
 561                         self.visit_assert_message(msg, location);
 562                     }
 563
 564                     TerminatorKind::Yield {
 565                         value,
 566                         resume: _,
 567                         resume_arg,
 568                         drop: _,
 569                     } => {
 570                         self.visit_operand(value, location);
 571                         self.visit_place(
 572                             resume_arg,
 573                             PlaceContext::MutatingUse(MutatingUseContext::Yield),
 574                             location,
 575                         );
 576                     }
 577
 578                     TerminatorKind::InlineAsm {
 579                         template: _,
 580                         operands,
 581                         options: _,
 582                         line_spans: _,
 583                         destination: _,
 584                     } => {
 585                         for op in operands {
 586                             match op {
 587                                 InlineAsmOperand::In { value, .. }
 588                                 | InlineAsmOperand::Const { value } => {
 589                                     self.visit_operand(value, location);
 590                                 }
 591                                 InlineAsmOperand::Out { place, .. } => {
 592                                     if let Some(place) = place {
 593                                         self.visit_place(
 594                                             place,
 595                                             PlaceContext::MutatingUse(MutatingUseContext::Store),
 596                                             location,
 597                                         );
 598                                     }
 599                                 }
 600                                 InlineAsmOperand::InOut { in_value, out_place, .. } => {
 601                                     self.visit_operand(in_value, location);
 602                                     if let Some(out_place) = out_place {
 603                                         self.visit_place(
 604                                             out_place,
 605                                             PlaceContext::MutatingUse(MutatingUseContext::Store),
 606                                             location,
 607                                         );
 608                                     }
 609                                 }
 610                                 InlineAsmOperand::SymFn { value } => {
 611                                     self.visit_constant(value, location);
 612                                 }
 613                                 InlineAsmOperand::SymStatic { def_id: _ } => {}
 614                             }
 615                         }
 616                     }
 617                 }
 618             }
 619
 620             fn super_assert_message(&mut self,
 621                                     msg: & $($mutability)? AssertMessage<'tcx>,
 622                                     location: Location) {
 623                 use crate::mir::AssertKind::*;
 624                 match msg {
 625                     BoundsCheck { len, index } => {
 626                         self.visit_operand(len, location);
 627                         self.visit_operand(index, location);
 628                     }
 629                     Overflow(_, l, r) => {
 630                         self.visit_operand(l, location);
 631                         self.visit_operand(r, location);
 632                     }
 633                     OverflowNeg(op) | DivisionByZero(op) | RemainderByZero(op) => {
 634                         self.visit_operand(op, location);
 635                     }
 636                     ResumedAfterReturn(_) | ResumedAfterPanic(_) => {
 637                         // Nothing to visit
 638                     }
 639                 }
 640             }
 641
 642             fn super_rvalue(&mut self,
 643                             rvalue: & $($mutability)? Rvalue<'tcx>,
 644                             location: Location) {
 645                 match rvalue {
 646                     Rvalue::Use(operand) => {
 647                         self.visit_operand(operand, location);
 648                     }
 649
 650                     Rvalue::Repeat(value, _) => {
 651                         self.visit_operand(value, location);
 652                     }
 653
 654                     Rvalue::ThreadLocalRef(_) => {}
 655
 656                     Rvalue::Ref(r, bk, path) => {
 657                         self.visit_region(r, location);
 658                         let ctx = match bk {
 659                             BorrowKind::Shared => PlaceContext::NonMutatingUse(
 660                                 NonMutatingUseContext::SharedBorrow
 661                             ),
 662                             BorrowKind::Shallow => PlaceContext::NonMutatingUse(
 663                                 NonMutatingUseContext::ShallowBorrow
 664                             ),
 665                             BorrowKind::Unique => PlaceContext::NonMutatingUse(
 666                                 NonMutatingUseContext::UniqueBorrow
 667                             ),
 668                             BorrowKind::Mut { .. } =>
 669                                 PlaceContext::MutatingUse(MutatingUseContext::Borrow),
 670                         };
 671                         self.visit_place(path, ctx, location);
 672                     }
 673
 674                     Rvalue::AddressOf(m, path) => {
 675                         let ctx = match m {
 676                             Mutability::Mut => PlaceContext::MutatingUse(
 677                                 MutatingUseContext::AddressOf
 678                             ),
 679                             Mutability::Not => PlaceContext::NonMutatingUse(
 680                                 NonMutatingUseContext::AddressOf
 681                             ),
 682                         };
 683                         self.visit_place(path, ctx, location);
 684                     }
 685
 686                     Rvalue::Len(path) => {
 687                         self.visit_place(
 688                             path,
 689                             PlaceContext::NonMutatingUse(NonMutatingUseContext::Inspect),
 690                             location
 691                         );
 692                     }
 693
 694                     Rvalue::Cast(_cast_kind, operand, ty) => {
 695                         self.visit_operand(operand, location);
 696                         self.visit_ty(ty, TyContext::Location(location));
 697                     }
 698
 699                     Rvalue::BinaryOp(_bin_op, box(lhs, rhs))
 700                     | Rvalue::CheckedBinaryOp(_bin_op, box(lhs, rhs)) => {
 701                         self.visit_operand(lhs, location);
 702                         self.visit_operand(rhs, location);
 703                     }
 704
 705                     Rvalue::UnaryOp(_un_op, op) => {
 706                         self.visit_operand(op, location);
 707                     }
 708
 709                     Rvalue::Discriminant(place) => {
 710                         self.visit_place(
 711                             place,
 712                             PlaceContext::NonMutatingUse(NonMutatingUseContext::Inspect),
 713                             location
 714                         );
 715                     }
 716
 717                     Rvalue::NullaryOp(_op, ty) => {
 718                         self.visit_ty(ty, TyContext::Location(location));
 719                     }
 720
 721                     Rvalue::Aggregate(kind, operands) => {
 722                         let kind = &$($mutability)? **kind;
 723                         match kind {
 724                             AggregateKind::Array(ty) => {
 725                                 self.visit_ty(ty, TyContext::Location(location));
 726                             }
 727                             AggregateKind::Tuple => {
 728                             }
 729                             AggregateKind::Adt(
 730                                 _adt_def,
 731                                 _variant_index,
 732                                 substs,
 733                                 _user_substs,
 734                                 _active_field_index
 735                             ) => {
 736                                 self.visit_substs(substs, location);
 737                             }
 738                             AggregateKind::Closure(
 739                                 _,
 740                                 closure_substs
 741                             ) => {
 742                                 self.visit_substs(closure_substs, location);
 743                             }
 744                             AggregateKind::Generator(
 745                                 _,
 746                                 generator_substs,
 747                                 _movability,
 748                             ) => {
 749                                 self.visit_substs(generator_substs, location);
 750                             }
 751                         }
 752
 753                         for operand in operands {
 754                             self.visit_operand(operand, location);
 755                         }
 756                     }
 757                 }
 758             }
 759
 760             fn super_operand(&mut self,
 761                              operand: & $($mutability)? Operand<'tcx>,
 762                              location: Location) {
 763                 match operand {
 764                     Operand::Copy(place) => {
 765                         self.visit_place(
 766                             place,
 767                             PlaceContext::NonMutatingUse(NonMutatingUseContext::Copy),
 768                             location
 769                         );
 770                     }
 771                     Operand::Move(place) => {
 772                         self.visit_place(
 773                             place,
 774                             PlaceContext::NonMutatingUse(NonMutatingUseContext::Move),
 775                             location
 776                         );
 777                     }
 778                     Operand::Constant(constant) => {
 779                         self.visit_constant(constant, location);
 780                     }
 781                 }
 782             }
 783
 784             fn super_ascribe_user_ty(&mut self,
 785                                      place: & $($mutability)? Place<'tcx>,
 786                                      _variance: & $($mutability)? ty::Variance,
 787                                      user_ty: & $($mutability)? UserTypeProjection,
 788                                      location: Location) {
 789                 self.visit_place(
 790                     place,
 791                     PlaceContext::NonUse(NonUseContext::AscribeUserTy),
 792                     location
 793                 );
 794                 self.visit_user_type_projection(user_ty);
 795             }
 796
 797             fn super_coverage(&mut self,
 798                               _coverage: & $($mutability)? Coverage,
 799                               _location: Location) {
 800             }
 801
 802             fn super_retag(&mut self,
 803                            _kind: & $($mutability)? RetagKind,
 804                            place: & $($mutability)? Place<'tcx>,
 805                            location: Location) {
 806                 self.visit_place(
 807                     place,
 808                     PlaceContext::MutatingUse(MutatingUseContext::Retag),
 809                     location,
 810                 );
 811             }
 812
 813             fn super_local_decl(&mut self,
 814                                 local: Local,
 815                                 local_decl: & $($mutability)? LocalDecl<'tcx>) {
 816                 let LocalDecl {
 817                     mutability: _,
 818                     ty,
 819                     user_ty,
 820                     source_info,
 821                     internal: _,
 822                     local_info: _,
 823                     is_block_tail: _,
 824                 } = local_decl;
 825
 826                 self.visit_ty(ty, TyContext::LocalDecl {
 827                     local,
 828                     source_info: *source_info,
 829                 });
 830                 if let Some(user_ty) = user_ty {
 831                     for (user_ty, _) in & $($mutability)? user_ty.contents {
 832                         self.visit_user_type_projection(user_ty);
 833                     }
 834                 }
 835                 self.visit_source_info(source_info);
 836             }
 837
 838             fn super_var_debug_info(&mut self,
 839                                     var_debug_info: & $($mutability)? VarDebugInfo<'tcx>) {
 840                 let VarDebugInfo {
 841                     name: _,
 842                     source_info,
 843                     value,
 844                 } = var_debug_info;
 845
 846                 self.visit_source_info(source_info);
 847                 let location = START_BLOCK.start_location();
 848                 match value {
 849                     VarDebugInfoContents::Const(c) => self.visit_constant(c, location),
 850                     VarDebugInfoContents::Place(place) =>
 851                         self.visit_place(
 852                             place,
 853                             PlaceContext::NonUse(NonUseContext::VarDebugInfo),
 854                             location
 855                         ),
 856                 }
 857             }
 858
 859             fn super_source_scope(&mut self,
 860                                       _scope: & $($mutability)? SourceScope) {
 861             }
 862
 863             fn super_constant(&mut self,
 864                               constant: & $($mutability)? Constant<'tcx>,
 865                               location: Location) {
 866                 let Constant {
 867                     span,
 868                     user_ty,
 869                     literal,
 870                 } = constant;
 871
 872                 self.visit_span(span);
 873                 drop(user_ty); // no visit method for this
 874                 match literal {
 875                     ConstantKind::Ty(ct) => self.visit_const(ct, location),
 876                     ConstantKind::Val(_, t) => self.visit_ty(t, TyContext::Location(location)),
 877                 }
 878             }
 879
 880             fn super_span(&mut self, _span: & $($mutability)? Span) {
 881             }
 882
 883             fn super_source_info(&mut self, source_info: & $($mutability)? SourceInfo) {
 884                 let SourceInfo {
 885                     span,
 886                     scope,
 887                 } = source_info;
 888
 889                 self.visit_span(span);
 890                 self.visit_source_scope(scope);
 891             }
 892
 893             fn super_user_type_projection(
 894                 &mut self,
 895                 _ty: & $($mutability)? UserTypeProjection,
 896             ) {
 897             }
 898
 899             fn super_user_type_annotation(
 900                 &mut self,
 901                 _index: UserTypeAnnotationIndex,
 902                 ty: & $($mutability)? CanonicalUserTypeAnnotation<'tcx>,
 903             ) {
 904                 self.visit_span(& $($mutability)? ty.span);
 905                 self.visit_ty(& $($mutability)? ty.inferred_ty, TyContext::UserTy(ty.span));
 906             }
 907
 908             fn super_ty(&mut self, _ty: $(& $mutability)? Ty<'tcx>) {
 909             }
 910
 911             fn super_region(&mut self, _region: & $($mutability)? ty::Region<'tcx>) {
 912             }
 913
 914             fn super_const(&mut self, _const: & $($mutability)? &'tcx ty::Const<'tcx>) {
 915             }
 916
 917             fn super_substs(&mut self, _substs: & $($mutability)? SubstsRef<'tcx>) {
 918             }
 919
 920             // Convenience methods
 921
 922             fn visit_location(
 923                 &mut self,
 924                 body: &$($mutability)? Body<'tcx>,
 925                 location: Location
 926             ) {
 927                 macro_rules! basic_blocks {
 928                     (mut) => (body.basic_blocks_mut());
 929                     () => (body.basic_blocks());
 930                 }
 931                 let basic_block = & $($mutability)? basic_blocks!($($mutability)?)[location.block];
 932                 if basic_block.statements.len() == location.statement_index {
 933                     if let Some(ref $($mutability)? terminator) = basic_block.terminator {
 934                         self.visit_terminator(terminator, location)
 935                     }
 936                 } else {
 937                     let statement = & $($mutability)?
 938                         basic_block.statements[location.statement_index];
 939                     self.visit_statement(statement, location)
 940                 }
 941             }
 942         }
 943     }
 944 }
 945
 946 macro_rules! visit_place_fns {
 947     (mut) => {
 948         fn tcx<'a>(&'a self) -> TyCtxt<'tcx>;
 949
 950         fn super_place(
 951             &mut self,
 952             place: &mut Place<'tcx>,
 953             context: PlaceContext,
 954             location: Location,
 955         ) {
 956             self.visit_local(&mut place.local, context, location);
 957
 958             if let Some(new_projection) = self.process_projection(&place.projection, location) {
 959                 place.projection = self.tcx().intern_place_elems(&new_projection);
 960             }
 961         }
 962
 963         fn process_projection(
 964             &mut self,
 965             projection: &'a [PlaceElem<'tcx>],
 966             location: Location,
 967         ) -> Option<Vec<PlaceElem<'tcx>>> {
 968             let mut projection = Cow::Borrowed(projection);
 969
 970             for i in 0..projection.len() {
 971                 if let Some(&elem) = projection.get(i) {
 972                     if let Some(elem) = self.process_projection_elem(elem, location) {
 973                         // This converts the borrowed projection into `Cow::Owned(_)` and returns a
 974                         // clone of the projection so we can mutate and reintern later.
 975                         let vec = projection.to_mut();
 976                         vec[i] = elem;
 977                     }
 978                 }
 979             }
 980
 981             match projection {
 982                 Cow::Borrowed(_) => None,
 983                 Cow::Owned(vec) => Some(vec),
 984             }
 985         }
 986
 987         fn process_projection_elem(
 988             &mut self,
 989             elem: PlaceElem<'tcx>,
 990             location: Location,
 991         ) -> Option<PlaceElem<'tcx>> {
 992             match elem {
 993                 PlaceElem::Index(local) => {
 994                     let mut new_local = local;
 995                     self.visit_local(
 996                         &mut new_local,
 997                         PlaceContext::NonMutatingUse(NonMutatingUseContext::Copy),
 998                         location,
 999                     );
1000
1001                     if new_local == local { None } else { Some(PlaceElem::Index(new_local)) }
1002                 }
1003                 PlaceElem::Deref
1004                 | PlaceElem::Field(..)
1005                 | PlaceElem::ConstantIndex { .. }
1006                 | PlaceElem::Subslice { .. }
1007                 | PlaceElem::Downcast(..) => None,
1008             }
1009         }
1010     };
1011
1012     () => {
1013         fn visit_projection(
1014             &mut self,
1015             place_ref: PlaceRef<'tcx>,
1016             context: PlaceContext,
1017             location: Location,
1018         ) {
1019             self.super_projection(place_ref, context, location);
1020         }
1021
1022         fn visit_projection_elem(
1023             &mut self,
1024             local: Local,
1025             proj_base: &[PlaceElem<'tcx>],
1026             elem: PlaceElem<'tcx>,
1027             context: PlaceContext,
1028             location: Location,
1029         ) {
1030             self.super_projection_elem(local, proj_base, elem, context, location);
1031         }
1032
1033         fn super_place(&mut self, place: &Place<'tcx>, context: PlaceContext, location: Location) {
1034             let mut context = context;
1035
1036             if !place.projection.is_empty() {
1037                 if context.is_use() {
1038                     // ^ Only change the context if it is a real use, not a "use" in debuginfo.
1039                     context = if context.is_mutating_use() {
1040                         PlaceContext::MutatingUse(MutatingUseContext::Projection)
1041                     } else {
1042                         PlaceContext::NonMutatingUse(NonMutatingUseContext::Projection)
1043                     };
1044                 }
1045             }
1046
1047             self.visit_local(&place.local, context, location);
1048
1049             self.visit_projection(place.as_ref(), context, location);
1050         }
1051
1052         fn super_projection(
1053             &mut self,
1054             place_ref: PlaceRef<'tcx>,
1055             context: PlaceContext,
1056             location: Location,
1057         ) {
1058             // FIXME: Use PlaceRef::iter_projections, once that exists.
1059             let mut cursor = place_ref.projection;
1060             while let &[ref proj_base @ .., elem] = cursor {
1061                 cursor = proj_base;
1062                 self.visit_projection_elem(place_ref.local, cursor, elem, context, location);
1063             }
1064         }
1065
1066         fn super_projection_elem(
1067             &mut self,
1068             _local: Local,
1069             _proj_base: &[PlaceElem<'tcx>],
1070             elem: PlaceElem<'tcx>,
1071             _context: PlaceContext,
1072             location: Location,
1073         ) {
1074             match elem {
1075                 ProjectionElem::Field(_field, ty) => {
1076                     self.visit_ty(ty, TyContext::Location(location));
1077                 }
1078                 ProjectionElem::Index(local) => {
1079                     self.visit_local(
1080                         &local,
1081                         PlaceContext::NonMutatingUse(NonMutatingUseContext::Copy),
1082                         location,
1083                     );
1084                 }
1085                 ProjectionElem::Deref
1086                 | ProjectionElem::Subslice { from: _, to: _, from_end: _ }
1087                 | ProjectionElem::ConstantIndex { offset: _, min_length: _, from_end: _ }
1088                 | ProjectionElem::Downcast(_, _) => {}
1089             }
1090         }
1091     };
1092 }
1093
1094 make_mir_visitor!(Visitor,);
1095 make_mir_visitor!(MutVisitor, mut);
1096
1097 pub trait MirVisitable<'tcx> {
1098     fn apply(&self, location: Location, visitor: &mut dyn Visitor<'tcx>);
1099 }
1100
1101 impl<'tcx> MirVisitable<'tcx> for Statement<'tcx> {
1102     fn apply(&self, location: Location, visitor: &mut dyn Visitor<'tcx>) {
1103         visitor.visit_statement(self, location)
1104     }
1105 }
1106
1107 impl<'tcx> MirVisitable<'tcx> for Terminator<'tcx> {
1108     fn apply(&self, location: Location, visitor: &mut dyn Visitor<'tcx>) {
1109         visitor.visit_terminator(self, location)
1110     }
1111 }
1112
1113 impl<'tcx> MirVisitable<'tcx> for Option<Terminator<'tcx>> {
1114     fn apply(&self, location: Location, visitor: &mut dyn Visitor<'tcx>) {
1115         visitor.visit_terminator(self.as_ref().unwrap(), location)
1116     }
1117 }
1118
1119 /// Extra information passed to `visit_ty` and friends to give context
1120 /// about where the type etc appears.
1121 #[derive(Debug)]
1122 pub enum TyContext {
1123     LocalDecl {
1124         /// The index of the local variable we are visiting.
1125         local: Local,
1126
1127         /// The source location where this local variable was declared.
1128         source_info: SourceInfo,
1129     },
1130
1131     /// The inferred type of a user type annotation.
1132     UserTy(Span),
1133
1134     /// The return type of the function.
1135     ReturnTy(SourceInfo),
1136
1137     YieldTy(SourceInfo),
1138
1139     /// A type found at some location.
1140     Location(Location),
1141 }
1142
1143 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
1144 pub enum NonMutatingUseContext {
1145     /// Being inspected in some way, like loading a len.
1146     Inspect,
1147     /// Consumed as part of an operand.
1148     Copy,
1149     /// Consumed as part of an operand.
1150     Move,
1151     /// Shared borrow.
1152     SharedBorrow,
1153     /// Shallow borrow.
1154     ShallowBorrow,
1155     /// Unique borrow.
1156     UniqueBorrow,
1157     /// AddressOf for *const pointer.
1158     AddressOf,
1159     /// Used as base for another place, e.g., `x` in `x.y`. Will not mutate the place.
1160     /// For example, the projection `x.y` is not marked as a mutation in these cases:
1161     ///
1162     ///     z = x.y;
1163     ///     f(&x.y);
1164     ///
1165     Projection,
1166 }
1167
1168 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
1169 pub enum MutatingUseContext {
1170     /// Appears as LHS of an assignment.
1171     Store,
1172     /// Can often be treated as a `Store`, but needs to be separate because
1173     /// ASM is allowed to read outputs as well, so a `Store`-`AsmOutput` sequence
1174     /// cannot be simplified the way a `Store`-`Store` can be.
1175     AsmOutput,
1176     /// Destination of a call.
1177     Call,
1178     /// Destination of a yield.
1179     Yield,
1180     /// Being dropped.
1181     Drop,
1182     /// Mutable borrow.
1183     Borrow,
1184     /// AddressOf for *mut pointer.
1185     AddressOf,
1186     /// Used as base for another place, e.g., `x` in `x.y`. Could potentially mutate the place.
1187     /// For example, the projection `x.y` is marked as a mutation in these cases:
1188     ///
1189     ///     x.y = ...;
1190     ///     f(&mut x.y);
1191     ///
1192     Projection,
1193     /// Retagging, a "Stacked Borrows" shadow state operation
1194     Retag,
1195 }
1196
1197 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
1198 pub enum NonUseContext {
1199     /// Starting a storage live range.
1200     StorageLive,
1201     /// Ending a storage live range.
1202     StorageDead,
1203     /// User type annotation assertions for NLL.
1204     AscribeUserTy,
1205     /// The data of an user variable, for debug info.
1206     VarDebugInfo,
1207 }
1208
1209 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
1210 pub enum PlaceContext {
1211     NonMutatingUse(NonMutatingUseContext),
1212     MutatingUse(MutatingUseContext),
1213     NonUse(NonUseContext),
1214 }
1215
1216 impl PlaceContext {
1217     /// Returns `true` if this place context represents a drop.
1218     #[inline]
1219     pub fn is_drop(&self) -> bool {
1220         matches!(self, PlaceContext::MutatingUse(MutatingUseContext::Drop))
1221     }
1222
1223     /// Returns `true` if this place context represents a borrow.
1224     pub fn is_borrow(&self) -> bool {
1225         matches!(
1226             self,
1227             PlaceContext::NonMutatingUse(
1228                 NonMutatingUseContext::SharedBorrow
1229                     | NonMutatingUseContext::ShallowBorrow
1230                     | NonMutatingUseContext::UniqueBorrow
1231             ) | PlaceContext::MutatingUse(MutatingUseContext::Borrow)
1232         )
1233     }
1234
1235     /// Returns `true` if this place context represents a storage live or storage dead marker.
1236     #[inline]
1237     pub fn is_storage_marker(&self) -> bool {
1238         matches!(
1239             self,
1240             PlaceContext::NonUse(NonUseContext::StorageLive | NonUseContext::StorageDead)
1241         )
1242     }
1243
1244     /// Returns `true` if this place context represents a use that potentially changes the value.
1245     #[inline]
1246     pub fn is_mutating_use(&self) -> bool {
1247         matches!(self, PlaceContext::MutatingUse(..))
1248     }
1249
1250     /// Returns `true` if this place context represents a use.
1251     #[inline]
1252     pub fn is_use(&self) -> bool {
1253         !matches!(self, PlaceContext::NonUse(..))
1254     }
1255
1256     /// Returns `true` if this place context represents an assignment statement.
1257     pub fn is_place_assignment(&self) -> bool {
1258         matches!(
1259             self,
1260             PlaceContext::MutatingUse(
1261                 MutatingUseContext::Store
1262                     | MutatingUseContext::Call
1263                     | MutatingUseContext::AsmOutput,
1264             )
1265         )
1266     }
1267 }