src/librustc_mir/borrow_check/error_reporting.rs

   1 use borrow_check::nll::explain_borrow::BorrowExplanation;
   2 use borrow_check::nll::region_infer::{RegionName, RegionNameSource};
   3 use borrow_check::prefixes::IsPrefixOf;
   4 use borrow_check::WriteKind;
   5 use rustc::hir;
   6 use rustc::hir::def_id::DefId;
   7 use rustc::middle::region::ScopeTree;
   8 use rustc::mir::{
   9     self, AggregateKind, BindingForm, BorrowKind, ClearCrossCrate, Constant,
  10     ConstraintCategory, Field, Local, LocalDecl, LocalKind, Location, Operand,
  11     Place, PlaceProjection, ProjectionElem, Rvalue, Statement, StatementKind,
  12     TerminatorKind, VarBindingForm,
  13 };
  14 use rustc::ty::{self, DefIdTree};
  15 use rustc::util::ppaux::RegionHighlightMode;
  16 use rustc_data_structures::fx::FxHashSet;
  17 use rustc_data_structures::indexed_vec::Idx;
  18 use rustc_data_structures::sync::Lrc;
  19 use rustc_errors::{Applicability, DiagnosticBuilder};
  20 use syntax_pos::Span;
  21
  22 use super::borrow_set::BorrowData;
  23 use super::{Context, MirBorrowckCtxt};
  24 use super::{InitializationRequiringAction, PrefixSet};
  25 use dataflow::drop_flag_effects;
  26 use dataflow::move_paths::indexes::MoveOutIndex;
  27 use dataflow::move_paths::MovePathIndex;
  28 use util::borrowck_errors::{BorrowckErrors, Origin};
  29
  30 #[derive(Debug)]
  31 struct MoveSite {
  32     /// Index of the "move out" that we found. The `MoveData` can
  33     /// then tell us where the move occurred.
  34     moi: MoveOutIndex,
  35
  36     /// True if we traversed a back edge while walking from the point
  37     /// of error to the move site.
  38     traversed_back_edge: bool
  39 }
  40
  41 impl<'cx, 'gcx, 'tcx> MirBorrowckCtxt<'cx, 'gcx, 'tcx> {
  42     pub(super) fn report_use_of_moved_or_uninitialized(
  43         &mut self,
  44         context: Context,
  45         desired_action: InitializationRequiringAction,
  46         (moved_place, used_place, span): (&Place<'tcx>, &Place<'tcx>, Span),
  47         mpi: MovePathIndex,
  48     ) {
  49         debug!(
  50             "report_use_of_moved_or_uninitialized: context={:?} desired_action={:?} \
  51              moved_place={:?} used_place={:?} span={:?} mpi={:?}",
  52             context, desired_action, moved_place, used_place, span, mpi
  53         );
  54
  55         let use_spans = self.move_spans(moved_place, context.loc)
  56             .or_else(|| self.borrow_spans(span, context.loc));
  57         let span = use_spans.args_or_use();
  58
  59         let move_site_vec = self.get_moved_indexes(context, mpi);
  60         debug!(
  61             "report_use_of_moved_or_uninitialized: move_site_vec={:?}",
  62             move_site_vec
  63         );
  64         let move_out_indices: Vec<_> = move_site_vec
  65             .iter()
  66             .map(|move_site| move_site.moi)
  67             .collect();
  68
  69         if move_out_indices.is_empty() {
  70             let root_place = self.prefixes(&used_place, PrefixSet::All).last().unwrap();
  71
  72             if self.uninitialized_error_reported.contains(root_place) {
  73                 debug!(
  74                     "report_use_of_moved_or_uninitialized place: error about {:?} suppressed",
  75                     root_place
  76                 );
  77                 return;
  78             }
  79
  80             self.uninitialized_error_reported.insert(root_place.clone());
  81
  82             let item_msg = match self.describe_place_with_options(used_place,
  83                                                                   IncludingDowncast(true)) {
  84                 Some(name) => format!("`{}`", name),
  85                 None => "value".to_owned(),
  86             };
  87             let mut err = self.infcx.tcx.cannot_act_on_uninitialized_variable(
  88                 span,
  89                 desired_action.as_noun(),
  90                 &self.describe_place_with_options(moved_place, IncludingDowncast(true))
  91                     .unwrap_or_else(|| "_".to_owned()),
  92                 Origin::Mir,
  93             );
  94             err.span_label(span, format!("use of possibly uninitialized {}", item_msg));
  95
  96             use_spans.var_span_label(
  97                 &mut err,
  98                 format!("{} occurs due to use{}", desired_action.as_noun(), use_spans.describe()),
  99             );
 100
 101             err.buffer(&mut self.errors_buffer);
 102         } else {
 103             if let Some((reported_place, _)) = self.move_error_reported.get(&move_out_indices) {
 104                 if self.prefixes(&reported_place, PrefixSet::All)
 105                     .any(|p| p == used_place)
 106                 {
 107                     debug!(
 108                         "report_use_of_moved_or_uninitialized place: error suppressed \
 109                          mois={:?}",
 110                         move_out_indices
 111                     );
 112                     return;
 113                 }
 114             }
 115
 116             let msg = ""; //FIXME: add "partially " or "collaterally "
 117
 118             let mut err = self.infcx.tcx.cannot_act_on_moved_value(
 119                 span,
 120                 desired_action.as_noun(),
 121                 msg,
 122                 self.describe_place_with_options(&moved_place, IncludingDowncast(true)),
 123                 Origin::Mir,
 124             );
 125
 126             self.add_closure_invoked_twice_with_moved_variable_suggestion(
 127                 context.loc,
 128                 used_place,
 129                 &mut err,
 130             );
 131
 132             let mut is_loop_move = false;
 133             for move_site in &move_site_vec {
 134                 let move_out = self.move_data.moves[(*move_site).moi];
 135                 let moved_place = &self.move_data.move_paths[move_out.path].place;
 136
 137                 let move_spans = self.move_spans(moved_place, move_out.source);
 138                 let move_span = move_spans.args_or_use();
 139
 140                 let move_msg = if move_spans.for_closure() {
 141                     " into closure"
 142                 } else {
 143                     ""
 144                 };
 145
 146                 if span == move_span {
 147                     err.span_label(
 148                         span,
 149                         format!("value moved{} here, in previous iteration of loop", move_msg),
 150                     );
 151                     is_loop_move = true;
 152                 } else if move_site.traversed_back_edge {
 153                     err.span_label(
 154                         move_span,
 155                         format!(
 156                             "value moved{} here, in previous iteration of loop",
 157                             move_msg
 158                         ),
 159                     );
 160                 } else {
 161                     err.span_label(move_span, format!("value moved{} here", move_msg));
 162                     move_spans.var_span_label(
 163                         &mut err,
 164                         format!("variable moved due to use{}", move_spans.describe()),
 165                     );
 166                 };
 167             }
 168
 169             use_spans.var_span_label(
 170                 &mut err,
 171                 format!("{} occurs due to use{}", desired_action.as_noun(), use_spans.describe()),
 172             );
 173
 174             if !is_loop_move {
 175                 err.span_label(
 176                     span,
 177                     format!(
 178                         "value {} here after move",
 179                         desired_action.as_verb_in_past_tense()
 180                     ),
 181                 );
 182             }
 183
 184             let ty = used_place.ty(self.mir, self.infcx.tcx).to_ty(self.infcx.tcx);
 185             let needs_note = match ty.sty {
 186                 ty::Closure(id, _) => {
 187                     let tables = self.infcx.tcx.typeck_tables_of(id);
 188                     let node_id = self.infcx.tcx.hir().as_local_node_id(id).unwrap();
 189                     let hir_id = self.infcx.tcx.hir().node_to_hir_id(node_id);
 190
 191                     tables.closure_kind_origins().get(hir_id).is_none()
 192                 }
 193                 _ => true,
 194             };
 195
 196             if needs_note {
 197                 let mpi = self.move_data.moves[move_out_indices[0]].path;
 198                 let place = &self.move_data.move_paths[mpi].place;
 199
 200                 let ty = place.ty(self.mir, self.infcx.tcx).to_ty(self.infcx.tcx);
 201                 let note_msg = match self.describe_place_with_options(
 202                     place,
 203                     IncludingDowncast(true),
 204                 ) {
 205                     Some(name) => format!("`{}`", name),
 206                     None => "value".to_owned(),
 207                 };
 208
 209                 err.note(&format!(
 210                     "move occurs because {} has type `{}`, \
 211                      which does not implement the `Copy` trait",
 212                     note_msg, ty
 213                 ));
 214             }
 215
 216             if let Some((_, mut old_err)) = self.move_error_reported
 217                 .insert(move_out_indices, (used_place.clone(), err))
 218             {
 219                 // Cancel the old error so it doesn't ICE.
 220                 old_err.cancel();
 221             }
 222         }
 223     }
 224
 225     pub(super) fn report_move_out_while_borrowed(
 226         &mut self,
 227         context: Context,
 228         (place, span): (&Place<'tcx>, Span),
 229         borrow: &BorrowData<'tcx>,
 230     ) {
 231         debug!(
 232             "report_move_out_while_borrowed: context={:?} place={:?} span={:?} borrow={:?}",
 233             context, place, span, borrow
 234         );
 235         let tcx = self.infcx.tcx;
 236         let value_msg = match self.describe_place(place) {
 237             Some(name) => format!("`{}`", name),
 238             None => "value".to_owned(),
 239         };
 240         let borrow_msg = match self.describe_place(&borrow.borrowed_place) {
 241             Some(name) => format!("`{}`", name),
 242             None => "value".to_owned(),
 243         };
 244
 245         let borrow_spans = self.retrieve_borrow_spans(borrow);
 246         let borrow_span = borrow_spans.args_or_use();
 247
 248         let move_spans = self.move_spans(place, context.loc);
 249         let span = move_spans.args_or_use();
 250
 251         let mut err = tcx.cannot_move_when_borrowed(
 252             span,
 253             &self.describe_place(place).unwrap_or_else(|| "_".to_owned()),
 254             Origin::Mir,
 255         );
 256         err.span_label(borrow_span, format!("borrow of {} occurs here", borrow_msg));
 257         err.span_label(span, format!("move out of {} occurs here", value_msg));
 258
 259         borrow_spans.var_span_label(
 260             &mut err,
 261             format!("borrow occurs due to use{}", borrow_spans.describe())
 262         );
 263
 264         move_spans.var_span_label(
 265             &mut err,
 266             format!("move occurs due to use{}", move_spans.describe())
 267         );
 268
 269         self.explain_why_borrow_contains_point(context, borrow, None)
 270             .add_explanation_to_diagnostic(self.infcx.tcx, self.mir, &mut err, "");
 271         err.buffer(&mut self.errors_buffer);
 272     }
 273
 274     pub(super) fn report_use_while_mutably_borrowed(
 275         &mut self,
 276         context: Context,
 277         (place, _span): (&Place<'tcx>, Span),
 278         borrow: &BorrowData<'tcx>,
 279     ) {
 280         let tcx = self.infcx.tcx;
 281
 282         let borrow_spans = self.retrieve_borrow_spans(borrow);
 283         let borrow_span = borrow_spans.args_or_use();
 284
 285         // Conflicting borrows are reported separately, so only check for move
 286         // captures.
 287         let use_spans = self.move_spans(place, context.loc);
 288         let span = use_spans.var_or_use();
 289
 290         let mut err = tcx.cannot_use_when_mutably_borrowed(
 291             span,
 292             &self.describe_place(place).unwrap_or_else(|| "_".to_owned()),
 293             borrow_span,
 294             &self.describe_place(&borrow.borrowed_place)
 295                 .unwrap_or_else(|| "_".to_owned()),
 296             Origin::Mir,
 297         );
 298
 299         borrow_spans.var_span_label(&mut err, {
 300             let place = &borrow.borrowed_place;
 301             let desc_place = self.describe_place(place).unwrap_or_else(|| "_".to_owned());
 302
 303             format!("borrow occurs due to use of `{}`{}", desc_place, borrow_spans.describe())
 304         });
 305
 306         self.explain_why_borrow_contains_point(context, borrow, None)
 307             .add_explanation_to_diagnostic(self.infcx.tcx, self.mir, &mut err, "");
 308         err.buffer(&mut self.errors_buffer);
 309     }
 310
 311     pub(super) fn report_conflicting_borrow(
 312         &mut self,
 313         context: Context,
 314         (place, span): (&Place<'tcx>, Span),
 315         gen_borrow_kind: BorrowKind,
 316         issued_borrow: &BorrowData<'tcx>,
 317     ) {
 318         let issued_spans = self.retrieve_borrow_spans(issued_borrow);
 319         let issued_span = issued_spans.args_or_use();
 320
 321         let borrow_spans = self.borrow_spans(span, context.loc);
 322         let span = borrow_spans.args_or_use();
 323
 324         let container_name = if issued_spans.for_generator() || borrow_spans.for_generator() {
 325             "generator"
 326         } else {
 327             "closure"
 328         };
 329
 330         let desc_place = self.describe_place(place).unwrap_or_else(|| "_".to_owned());
 331         let tcx = self.infcx.tcx;
 332
 333         let first_borrow_desc;
 334
 335         let explanation = self.explain_why_borrow_contains_point(context, issued_borrow, None);
 336         let second_borrow_desc = if explanation.is_explained() {
 337             "second "
 338         } else {
 339             ""
 340         };
 341
 342         // FIXME: supply non-"" `opt_via` when appropriate
 343         let mut err = match (
 344             gen_borrow_kind,
 345             "immutable",
 346             "mutable",
 347             issued_borrow.kind,
 348             "immutable",
 349             "mutable",
 350         ) {
 351             (BorrowKind::Shared, lft, _, BorrowKind::Mut { .. }, _, rgt) => {
 352                 first_borrow_desc = "mutable ";
 353                 tcx.cannot_reborrow_already_borrowed(
 354                     span,
 355                     &desc_place,
 356                     "",
 357                     lft,
 358                     issued_span,
 359                     "it",
 360                     rgt,
 361                     "",
 362                     None,
 363                     Origin::Mir,
 364                 )
 365             }
 366             (BorrowKind::Mut { .. }, _, lft, BorrowKind::Shared, rgt, _) => {
 367                 first_borrow_desc = "immutable ";
 368                 tcx.cannot_reborrow_already_borrowed(
 369                     span,
 370                     &desc_place,
 371                     "",
 372                     lft,
 373                     issued_span,
 374                     "it",
 375                     rgt,
 376                     "",
 377                     None,
 378                     Origin::Mir,
 379                 )
 380             }
 381
 382             (BorrowKind::Mut { .. }, _, _, BorrowKind::Mut { .. }, _, _) => {
 383                 first_borrow_desc = "first ";
 384                 tcx.cannot_mutably_borrow_multiply(
 385                     span,
 386                     &desc_place,
 387                     "",
 388                     issued_span,
 389                     "",
 390                     None,
 391                     Origin::Mir,
 392                 )
 393             }
 394
 395             (BorrowKind::Unique, _, _, BorrowKind::Unique, _, _) => {
 396                 first_borrow_desc = "first ";
 397                 tcx.cannot_uniquely_borrow_by_two_closures(
 398                     span,
 399                     &desc_place,
 400                     issued_span,
 401                     None,
 402                     Origin::Mir,
 403                 )
 404             }
 405
 406             (BorrowKind::Mut { .. }, _, _, BorrowKind::Shallow, _, _)
 407             | (BorrowKind::Unique, _, _, BorrowKind::Shallow, _, _) => {
 408                 let mut err = tcx.cannot_mutate_in_match_guard(
 409                     span,
 410                     issued_span,
 411                     &desc_place,
 412                     "mutably borrow",
 413                     Origin::Mir,
 414                 );
 415                 borrow_spans.var_span_label(
 416                     &mut err,
 417                     format!(
 418                         "borrow occurs due to use of `{}`{}", desc_place, borrow_spans.describe()
 419                     ),
 420                 );
 421                 err.buffer(&mut self.errors_buffer);
 422
 423                 return;
 424             }
 425
 426             (BorrowKind::Unique, _, _, _, _, _) => {
 427                 first_borrow_desc = "first ";
 428                 tcx.cannot_uniquely_borrow_by_one_closure(
 429                     span,
 430                     container_name,
 431                     &desc_place,
 432                     "",
 433                     issued_span,
 434                     "it",
 435                     "",
 436                     None,
 437                     Origin::Mir,
 438                 )
 439             },
 440
 441             (BorrowKind::Shared, lft, _, BorrowKind::Unique, _, _) => {
 442                 first_borrow_desc = "first ";
 443                 tcx.cannot_reborrow_already_uniquely_borrowed(
 444                     span,
 445                     container_name,
 446                     &desc_place,
 447                     "",
 448                     lft,
 449                     issued_span,
 450                     "",
 451                     None,
 452                     second_borrow_desc,
 453                     Origin::Mir,
 454                 )
 455             }
 456
 457             (BorrowKind::Mut { .. }, _, lft, BorrowKind::Unique, _, _) => {
 458                 first_borrow_desc = "first ";
 459                 tcx.cannot_reborrow_already_uniquely_borrowed(
 460                     span,
 461                     container_name,
 462                     &desc_place,
 463                     "",
 464                     lft,
 465                     issued_span,
 466                     "",
 467                     None,
 468                     second_borrow_desc,
 469                     Origin::Mir,
 470                 )
 471             }
 472
 473             (BorrowKind::Shallow, _, _, BorrowKind::Unique, _, _)
 474             | (BorrowKind::Shallow, _, _, BorrowKind::Mut { .. }, _, _) => {
 475                 // Shallow borrows are uses from the user's point of view.
 476                 self.report_use_while_mutably_borrowed(context, (place, span), issued_borrow);
 477                 return;
 478             }
 479             (BorrowKind::Shared, _, _, BorrowKind::Shared, _, _)
 480             | (BorrowKind::Shared, _, _, BorrowKind::Shallow, _, _)
 481             | (BorrowKind::Shallow, _, _, BorrowKind::Shared, _, _)
 482             | (BorrowKind::Shallow, _, _, BorrowKind::Shallow, _, _) => unreachable!(),
 483         };
 484
 485         if issued_spans == borrow_spans {
 486             borrow_spans.var_span_label(
 487                 &mut err,
 488                 format!("borrows occur due to use of `{}`{}", desc_place, borrow_spans.describe()),
 489             );
 490         } else {
 491             let borrow_place = &issued_borrow.borrowed_place;
 492             let borrow_place_desc = self.describe_place(borrow_place)
 493                                         .unwrap_or_else(|| "_".to_owned());
 494             issued_spans.var_span_label(
 495                 &mut err,
 496                 format!(
 497                     "first borrow occurs due to use of `{}`{}",
 498                     borrow_place_desc,
 499                     issued_spans.describe(),
 500                 ),
 501             );
 502
 503             borrow_spans.var_span_label(
 504                 &mut err,
 505                 format!(
 506                     "second borrow occurs due to use of `{}`{}",
 507                     desc_place,
 508                     borrow_spans.describe(),
 509                 ),
 510             );
 511         }
 512
 513         explanation
 514             .add_explanation_to_diagnostic(self.infcx.tcx, self.mir, &mut err, first_borrow_desc);
 515
 516         err.buffer(&mut self.errors_buffer);
 517     }
 518
 519     /// Reports StorageDeadOrDrop of `place` conflicts with `borrow`.
 520     ///
 521     /// This means that some data referenced by `borrow` needs to live
 522     /// past the point where the StorageDeadOrDrop of `place` occurs.
 523     /// This is usually interpreted as meaning that `place` has too
 524     /// short a lifetime. (But sometimes it is more useful to report
 525     /// it as a more direct conflict between the execution of a
 526     /// `Drop::drop` with an aliasing borrow.)
 527     pub(super) fn report_borrowed_value_does_not_live_long_enough(
 528         &mut self,
 529         context: Context,
 530         borrow: &BorrowData<'tcx>,
 531         place_span: (&Place<'tcx>, Span),
 532         kind: Option<WriteKind>,
 533     ) {
 534         debug!(
 535             "report_borrowed_value_does_not_live_long_enough(\
 536              {:?}, {:?}, {:?}, {:?}\
 537              )",
 538             context, borrow, place_span, kind
 539         );
 540
 541         let drop_span = place_span.1;
 542         let scope_tree = self.infcx.tcx.region_scope_tree(self.mir_def_id);
 543         let root_place = self.prefixes(&borrow.borrowed_place, PrefixSet::All)
 544             .last()
 545             .unwrap();
 546
 547         let borrow_spans = self.retrieve_borrow_spans(borrow);
 548         let borrow_span = borrow_spans.var_or_use();
 549
 550         let proper_span = match *root_place {
 551             Place::Local(local) => self.mir.local_decls[local].source_info.span,
 552             _ => drop_span,
 553         };
 554
 555         if self.access_place_error_reported
 556             .contains(&(root_place.clone(), borrow_span))
 557         {
 558             debug!(
 559                 "suppressing access_place error when borrow doesn't live long enough for {:?}",
 560                 borrow_span
 561             );
 562             return;
 563         }
 564
 565         self.access_place_error_reported
 566             .insert((root_place.clone(), borrow_span));
 567
 568         if let StorageDeadOrDrop::Destructor(dropped_ty) =
 569             self.classify_drop_access_kind(&borrow.borrowed_place)
 570         {
 571             // If a borrow of path `B` conflicts with drop of `D` (and
 572             // we're not in the uninteresting case where `B` is a
 573             // prefix of `D`), then report this as a more interesting
 574             // destructor conflict.
 575             if !borrow.borrowed_place.is_prefix_of(place_span.0) {
 576                 self.report_borrow_conflicts_with_destructor(
 577                     context, borrow, place_span, kind, dropped_ty,
 578                 );
 579                 return;
 580             }
 581         }
 582
 583         let place_desc = self.describe_place(&borrow.borrowed_place);
 584
 585         let kind_place = kind.filter(|_| place_desc.is_some()).map(|k| (k, place_span.0));
 586         let explanation = self.explain_why_borrow_contains_point(context, &borrow, kind_place);
 587
 588         let err = match (place_desc, explanation) {
 589             (Some(_), _) if self.is_place_thread_local(root_place) => {
 590                 self.report_thread_local_value_does_not_live_long_enough(drop_span, borrow_span)
 591             }
 592             // If the outlives constraint comes from inside the closure,
 593             // for example:
 594             //
 595             // let x = 0;
 596             // let y = &x;
 597             // Box::new(|| y) as Box<Fn() -> &'static i32>
 598             //
 599             // then just use the normal error. The closure isn't escaping
 600             // and `move` will not help here.
 601             (
 602                 Some(ref name),
 603                 BorrowExplanation::MustBeValidFor {
 604                     category: category @ ConstraintCategory::Return,
 605                     from_closure: false,
 606                     ref region_name,
 607                     span,
 608                     ..
 609                 },
 610             )
 611             | (
 612                 Some(ref name),
 613                 BorrowExplanation::MustBeValidFor {
 614                     category: category @ ConstraintCategory::CallArgument,
 615                     from_closure: false,
 616                     ref region_name,
 617                     span,
 618                     ..
 619                 },
 620             ) if borrow_spans.for_closure() => self.report_escaping_closure_capture(
 621                 borrow_spans.args_or_use(),
 622                 borrow_span,
 623                 region_name,
 624                 category,
 625                 span,
 626                 &format!("`{}`", name),
 627             ),
 628             (
 629                 ref name,
 630                 BorrowExplanation::MustBeValidFor {
 631                     category: ConstraintCategory::Assignment,
 632                     from_closure: false,
 633                     region_name: RegionName {
 634                         source: RegionNameSource::AnonRegionFromUpvar(upvar_span, ref upvar_name),
 635                         ..
 636                     },
 637                     span,
 638                     ..
 639                 },
 640             ) => self.report_escaping_data(borrow_span, name, upvar_span, upvar_name, span),
 641             (Some(name), explanation) => self.report_local_value_does_not_live_long_enough(
 642                 context,
 643                 &name,
 644                 &scope_tree,
 645                 &borrow,
 646                 drop_span,
 647                 borrow_spans,
 648                 explanation,
 649             ),
 650             (None, explanation) => self.report_temporary_value_does_not_live_long_enough(
 651                 context,
 652                 &scope_tree,
 653                 &borrow,
 654                 drop_span,
 655                 borrow_spans,
 656                 proper_span,
 657                 explanation,
 658             ),
 659         };
 660
 661         err.buffer(&mut self.errors_buffer);
 662     }
 663
 664     fn report_local_value_does_not_live_long_enough(
 665         &mut self,
 666         context: Context,
 667         name: &str,
 668         scope_tree: &Lrc<ScopeTree>,
 669         borrow: &BorrowData<'tcx>,
 670         drop_span: Span,
 671         borrow_spans: UseSpans,
 672         explanation: BorrowExplanation,
 673     ) -> DiagnosticBuilder<'cx> {
 674         debug!(
 675             "report_local_value_does_not_live_long_enough(\
 676              {:?}, {:?}, {:?}, {:?}, {:?}, {:?}\
 677              )",
 678             context, name, scope_tree, borrow, drop_span, borrow_spans
 679         );
 680
 681         let borrow_span = borrow_spans.var_or_use();
 682         if let BorrowExplanation::MustBeValidFor {
 683             category: ConstraintCategory::Return,
 684             span,
 685             ref opt_place_desc,
 686             from_closure: false,
 687             ..
 688         } = explanation {
 689             return self.report_cannot_return_reference_to_local(
 690                 borrow,
 691                 borrow_span,
 692                 span,
 693                 opt_place_desc.as_ref(),
 694             );
 695         }
 696
 697         let mut err = self.infcx.tcx.path_does_not_live_long_enough(
 698             borrow_span,
 699             &format!("`{}`", name),
 700             Origin::Mir,
 701         );
 702
 703         if let Some(annotation) = self.annotate_argument_and_return_for_borrow(borrow) {
 704             let region_name = annotation.emit(&mut err);
 705
 706             err.span_label(
 707                 borrow_span,
 708                 format!("`{}` would have to be valid for `{}`...", name, region_name),
 709             );
 710
 711             if let Some(fn_node_id) = self.infcx.tcx.hir().as_local_node_id(self.mir_def_id) {
 712                 err.span_label(
 713                     drop_span,
 714                     format!(
 715                         "...but `{}` will be dropped here, when the function `{}` returns",
 716                         name,
 717                         self.infcx.tcx.hir().name(fn_node_id),
 718                     ),
 719                 );
 720
 721                 err.note(
 722                     "functions cannot return a borrow to data owned within the function's scope, \
 723                      functions can only return borrows to data passed as arguments",
 724                 );
 725                 err.note(
 726                     "to learn more, visit <https://doc.rust-lang.org/book/second-edition/ch04-02-\
 727                      references-and-borrowing.html#dangling-references>",
 728                 );
 729             } else {
 730                 err.span_label(
 731                     drop_span,
 732                     format!("...but `{}` dropped here while still borrowed", name),
 733                 );
 734             }
 735
 736             if let BorrowExplanation::MustBeValidFor { .. } = explanation {
 737             } else {
 738                 explanation.add_explanation_to_diagnostic(self.infcx.tcx, self.mir, &mut err, "");
 739             }
 740         } else {
 741             err.span_label(borrow_span, "borrowed value does not live long enough");
 742             err.span_label(
 743                 drop_span,
 744                 format!("`{}` dropped here while still borrowed", name),
 745             );
 746
 747             let within = if borrow_spans.for_generator() {
 748                 " by generator"
 749             } else {
 750                 ""
 751             };
 752
 753             borrow_spans.args_span_label(
 754                 &mut err,
 755                 format!("value captured here{}", within),
 756             );
 757
 758             explanation.add_explanation_to_diagnostic(self.infcx.tcx, self.mir, &mut err, "");
 759         }
 760
 761         err
 762     }
 763
 764     fn report_borrow_conflicts_with_destructor(
 765         &mut self,
 766         context: Context,
 767         borrow: &BorrowData<'tcx>,
 768         (place, drop_span): (&Place<'tcx>, Span),
 769         kind: Option<WriteKind>,
 770         dropped_ty: ty::Ty<'tcx>,
 771     ) {
 772         debug!(
 773             "report_borrow_conflicts_with_destructor(\
 774              {:?}, {:?}, ({:?}, {:?}), {:?}\
 775              )",
 776             context, borrow, place, drop_span, kind,
 777         );
 778
 779         let borrow_spans = self.retrieve_borrow_spans(borrow);
 780         let borrow_span = borrow_spans.var_or_use();
 781
 782         let mut err = self.infcx
 783             .tcx
 784             .cannot_borrow_across_destructor(borrow_span, Origin::Mir);
 785
 786         let what_was_dropped = match self.describe_place(place) {
 787             Some(name) => format!("`{}`", name.as_str()),
 788             None => String::from("temporary value"),
 789         };
 790
 791         let label = match self.describe_place(&borrow.borrowed_place) {
 792             Some(borrowed) => format!(
 793                 "here, drop of {D} needs exclusive access to `{B}`, \
 794                  because the type `{T}` implements the `Drop` trait",
 795                 D = what_was_dropped,
 796                 T = dropped_ty,
 797                 B = borrowed
 798             ),
 799             None => format!(
 800                 "here is drop of {D}; whose type `{T}` implements the `Drop` trait",
 801                 D = what_was_dropped,
 802                 T = dropped_ty
 803             ),
 804         };
 805         err.span_label(drop_span, label);
 806
 807         // Only give this note and suggestion if they could be relevant.
 808         let explanation =
 809             self.explain_why_borrow_contains_point(context, borrow, kind.map(|k| (k, place)));
 810         match explanation {
 811             BorrowExplanation::UsedLater { .. }
 812             | BorrowExplanation::UsedLaterWhenDropped { .. } => {
 813                 err.note("consider using a `let` binding to create a longer lived value");
 814             }
 815             _ => {}
 816         }
 817
 818         explanation.add_explanation_to_diagnostic(self.infcx.tcx, self.mir, &mut err, "");
 819
 820         err.buffer(&mut self.errors_buffer);
 821     }
 822
 823     fn report_thread_local_value_does_not_live_long_enough(
 824         &mut self,
 825         drop_span: Span,
 826         borrow_span: Span,
 827     ) -> DiagnosticBuilder<'cx> {
 828         debug!(
 829             "report_thread_local_value_does_not_live_long_enough(\
 830              {:?}, {:?}\
 831              )",
 832             drop_span, borrow_span
 833         );
 834
 835         let mut err = self.infcx
 836             .tcx
 837             .thread_local_value_does_not_live_long_enough(borrow_span, Origin::Mir);
 838
 839         err.span_label(
 840             borrow_span,
 841             "thread-local variables cannot be borrowed beyond the end of the function",
 842         );
 843         err.span_label(drop_span, "end of enclosing function is here");
 844
 845         err
 846     }
 847
 848     fn report_temporary_value_does_not_live_long_enough(
 849         &mut self,
 850         context: Context,
 851         scope_tree: &Lrc<ScopeTree>,
 852         borrow: &BorrowData<'tcx>,
 853         drop_span: Span,
 854         borrow_spans: UseSpans,
 855         proper_span: Span,
 856         explanation: BorrowExplanation,
 857     ) -> DiagnosticBuilder<'cx> {
 858         debug!(
 859             "report_temporary_value_does_not_live_long_enough(\
 860              {:?}, {:?}, {:?}, {:?}, {:?}\
 861              )",
 862             context, scope_tree, borrow, drop_span, proper_span
 863         );
 864
 865         if let BorrowExplanation::MustBeValidFor {
 866             category: ConstraintCategory::Return,
 867             span,
 868             from_closure: false,
 869             ..
 870         } = explanation {
 871             return self.report_cannot_return_reference_to_local(
 872                 borrow,
 873                 proper_span,
 874                 span,
 875                 None,
 876             );
 877         }
 878
 879         let tcx = self.infcx.tcx;
 880         let mut err = tcx.temporary_value_borrowed_for_too_long(proper_span, Origin::Mir);
 881         err.span_label(
 882             proper_span,
 883             "creates a temporary which is freed while still in use",
 884         );
 885         err.span_label(
 886             drop_span,
 887             "temporary value is freed at the end of this statement",
 888         );
 889
 890         match explanation {
 891             BorrowExplanation::UsedLater(..)
 892             | BorrowExplanation::UsedLaterInLoop(..)
 893             | BorrowExplanation::UsedLaterWhenDropped { .. } => {
 894                 // Only give this note and suggestion if it could be relevant.
 895                 err.note("consider using a `let` binding to create a longer lived value");
 896             }
 897             _ => {}
 898         }
 899         explanation.add_explanation_to_diagnostic(self.infcx.tcx, self.mir, &mut err, "");
 900
 901         let within = if borrow_spans.for_generator() {
 902             " by generator"
 903         } else {
 904             ""
 905         };
 906
 907         borrow_spans.args_span_label(
 908             &mut err,
 909             format!("value captured here{}", within),
 910         );
 911
 912         err
 913     }
 914
 915     fn report_cannot_return_reference_to_local(
 916         &self,
 917         borrow: &BorrowData<'tcx>,
 918         borrow_span: Span,
 919         return_span: Span,
 920         opt_place_desc: Option<&String>,
 921     ) -> DiagnosticBuilder<'cx> {
 922         let tcx = self.infcx.tcx;
 923
 924         // FIXME use a better heuristic than Spans
 925         let reference_desc = if return_span == self.mir.source_info(borrow.reserve_location).span {
 926             "reference to"
 927         } else {
 928             "value referencing"
 929         };
 930
 931         let (place_desc, note) = if let Some(place_desc) = opt_place_desc {
 932             let local_kind = match borrow.borrowed_place {
 933                 Place::Local(local) => {
 934                     match self.mir.local_kind(local) {
 935                         LocalKind::ReturnPointer
 936                         | LocalKind::Temp => bug!("temporary or return pointer with a name"),
 937                         LocalKind::Var => "local variable ",
 938                         LocalKind::Arg
 939                         if !self.mir.upvar_decls.is_empty()
 940                             && local == Local::new(1) => {
 941                             "variable captured by `move` "
 942                         }
 943                         LocalKind::Arg => {
 944                             "function parameter "
 945                         }
 946                     }
 947                 }
 948                 _ => "local data ",
 949             };
 950             (
 951                 format!("{}`{}`", local_kind, place_desc),
 952                 format!("`{}` is borrowed here", place_desc),
 953             )
 954         } else {
 955             let root_place = self.prefixes(&borrow.borrowed_place, PrefixSet::All)
 956                 .last()
 957                 .unwrap();
 958             let local = if let Place::Local(local) = *root_place {
 959                 local
 960             } else {
 961                 bug!("report_cannot_return_reference_to_local: not a local")
 962             };
 963             match self.mir.local_kind(local) {
 964                 LocalKind::ReturnPointer | LocalKind::Temp => {
 965                     (
 966                         "temporary value".to_string(),
 967                         "temporary value created here".to_string(),
 968                     )
 969                 }
 970                 LocalKind::Arg => {
 971                     (
 972                         "function parameter".to_string(),
 973                         "function parameter borrowed here".to_string(),
 974                     )
 975                 },
 976                 LocalKind::Var => bug!("local variable without a name"),
 977             }
 978         };
 979
 980         let mut err = tcx.cannot_return_reference_to_local(
 981             return_span,
 982             reference_desc,
 983             &place_desc,
 984             Origin::Mir,
 985         );
 986
 987         if return_span != borrow_span {
 988             err.span_label(borrow_span, note);
 989         }
 990
 991         err
 992     }
 993
 994     fn report_escaping_closure_capture(
 995         &mut self,
 996         args_span: Span,
 997         var_span: Span,
 998         fr_name: &RegionName,
 999         category: ConstraintCategory,
1000         constraint_span: Span,
1001         captured_var: &str,
1002     ) -> DiagnosticBuilder<'cx> {
1003         let tcx = self.infcx.tcx;
1004
1005         let mut err = tcx.cannot_capture_in_long_lived_closure(
1006             args_span,
1007             captured_var,
1008             var_span,
1009           Origin::Mir,
1010         );
1011
1012         let suggestion = match tcx.sess.source_map().span_to_snippet(args_span) {
1013             Ok(string) => format!("move {}", string),
1014             Err(_) => "move |<args>| <body>".to_string()
1015         };
1016
1017         err.span_suggestion_with_applicability(
1018             args_span,
1019             &format!("to force the closure to take ownership of {} (and any \
1020                       other referenced variables), use the `move` keyword",
1021                       captured_var),
1022             suggestion,
1023             Applicability::MachineApplicable,
1024         );
1025
1026         match category {
1027             ConstraintCategory::Return => {
1028                 err.span_note(constraint_span, "closure is returned here");
1029             }
1030             ConstraintCategory::CallArgument => {
1031                 fr_name.highlight_region_name(&mut err);
1032                 err.span_note(
1033                     constraint_span,
1034                     &format!("function requires argument type to outlive `{}`", fr_name),
1035                 );
1036             }
1037             _ => bug!("report_escaping_closure_capture called with unexpected constraint \
1038                        category: `{:?}`", category),
1039         }
1040         err
1041     }
1042
1043     fn report_escaping_data(
1044         &mut self,
1045         borrow_span: Span,
1046         name: &Option<String>,
1047         upvar_span: Span,
1048         upvar_name: &str,
1049         escape_span: Span,
1050     ) -> DiagnosticBuilder<'cx> {
1051         let tcx = self.infcx.tcx;
1052
1053         let escapes_from = if tcx.is_closure(self.mir_def_id) {
1054             let tables = tcx.typeck_tables_of(self.mir_def_id);
1055             let mir_hir_id = tcx.hir().def_index_to_hir_id(self.mir_def_id.index);
1056             match tables.node_id_to_type(mir_hir_id).sty {
1057                 ty::Closure(..) => "closure",
1058                 ty::Generator(..) => "generator",
1059                 _ => bug!("Closure body doesn't have a closure or generator type"),
1060             }
1061         } else {
1062             "function"
1063         };
1064
1065         let mut err = tcx.borrowed_data_escapes_closure(escape_span, escapes_from, Origin::Mir);
1066
1067         err.span_label(
1068             upvar_span,
1069             format!(
1070                 "`{}` is declared here, outside of the {} body",
1071                 upvar_name, escapes_from
1072             ),
1073         );
1074
1075         err.span_label(
1076             borrow_span,
1077             format!(
1078                 "borrow is only valid in the {} body",
1079                 escapes_from
1080             ),
1081         );
1082
1083         if let Some(name) = name {
1084             err.span_label(
1085                 escape_span,
1086                 format!("reference to `{}` escapes the {} body here", name, escapes_from),
1087             );
1088         } else {
1089             err.span_label(
1090                 escape_span,
1091                 format!("reference escapes the {} body here", escapes_from),
1092             );
1093         }
1094
1095         err
1096     }
1097
1098     fn get_moved_indexes(&mut self, context: Context, mpi: MovePathIndex) -> Vec<MoveSite> {
1099         let mir = self.mir;
1100
1101         let mut stack = Vec::new();
1102         stack.extend(mir.predecessor_locations(context.loc).map(|predecessor| {
1103             let is_back_edge = context.loc.dominates(predecessor, &self.dominators);
1104             (predecessor, is_back_edge)
1105         }));
1106
1107         let mut visited = FxHashSet::default();
1108         let mut result = vec![];
1109
1110         'dfs: while let Some((location, is_back_edge)) = stack.pop() {
1111             debug!(
1112                 "report_use_of_moved_or_uninitialized: (current_location={:?}, back_edge={})",
1113                 location, is_back_edge
1114             );
1115
1116             if !visited.insert(location) {
1117                 continue;
1118             }
1119
1120             // check for moves
1121             let stmt_kind = mir[location.block]
1122                 .statements
1123                 .get(location.statement_index)
1124                 .map(|s| &s.kind);
1125             if let Some(StatementKind::StorageDead(..)) = stmt_kind {
1126                 // this analysis only tries to find moves explicitly
1127                 // written by the user, so we ignore the move-outs
1128                 // created by `StorageDead` and at the beginning
1129                 // of a function.
1130             } else {
1131                 // If we are found a use of a.b.c which was in error, then we want to look for
1132                 // moves not only of a.b.c but also a.b and a.
1133                 //
1134                 // Note that the moves data already includes "parent" paths, so we don't have to
1135                 // worry about the other case: that is, if there is a move of a.b.c, it is already
1136                 // marked as a move of a.b and a as well, so we will generate the correct errors
1137                 // there.
1138                 let mut mpis = vec![mpi];
1139                 let move_paths = &self.move_data.move_paths;
1140                 mpis.extend(move_paths[mpi].parents(move_paths));
1141
1142                 for moi in &self.move_data.loc_map[location] {
1143                     debug!("report_use_of_moved_or_uninitialized: moi={:?}", moi);
1144                     if mpis.contains(&self.move_data.moves[*moi].path) {
1145                         debug!("report_use_of_moved_or_uninitialized: found");
1146                         result.push(MoveSite {
1147                             moi: *moi,
1148                             traversed_back_edge: is_back_edge,
1149                         });
1150
1151                         // Strictly speaking, we could continue our DFS here. There may be
1152                         // other moves that can reach the point of error. But it is kind of
1153                         // confusing to highlight them.
1154                         //
1155                         // Example:
1156                         //
1157                         // ```
1158                         // let a = vec![];
1159                         // let b = a;
1160                         // let c = a;
1161                         // drop(a); // <-- current point of error
1162                         // ```
1163                         //
1164                         // Because we stop the DFS here, we only highlight `let c = a`,
1165                         // and not `let b = a`. We will of course also report an error at
1166                         // `let c = a` which highlights `let b = a` as the move.
1167                         continue 'dfs;
1168                     }
1169                 }
1170             }
1171
1172             // check for inits
1173             let mut any_match = false;
1174             drop_flag_effects::for_location_inits(
1175                 self.infcx.tcx,
1176                 self.mir,
1177                 self.move_data,
1178                 location,
1179                 |m| {
1180                     if m == mpi {
1181                         any_match = true;
1182                     }
1183                 },
1184             );
1185             if any_match {
1186                 continue 'dfs;
1187             }
1188
1189             stack.extend(mir.predecessor_locations(location).map(|predecessor| {
1190                 let back_edge = location.dominates(predecessor, &self.dominators);
1191                 (predecessor, is_back_edge || back_edge)
1192             }));
1193         }
1194
1195         result
1196     }
1197
1198     pub(super) fn report_illegal_mutation_of_borrowed(
1199         &mut self,
1200         context: Context,
1201         (place, span): (&Place<'tcx>, Span),
1202         loan: &BorrowData<'tcx>,
1203     ) {
1204         let loan_spans = self.retrieve_borrow_spans(loan);
1205         let loan_span = loan_spans.args_or_use();
1206
1207         let tcx = self.infcx.tcx;
1208         let mut err = if loan.kind == BorrowKind::Shallow {
1209             tcx.cannot_mutate_in_match_guard(
1210                 span,
1211                 loan_span,
1212                 &self.describe_place(place).unwrap_or_else(|| "_".to_owned()),
1213                 "assign",
1214                 Origin::Mir,
1215             )
1216         } else {
1217             tcx.cannot_assign_to_borrowed(
1218                 span,
1219                 loan_span,
1220                 &self.describe_place(place).unwrap_or_else(|| "_".to_owned()),
1221                 Origin::Mir,
1222             )
1223         };
1224
1225         loan_spans.var_span_label(
1226             &mut err,
1227             format!("borrow occurs due to use{}", loan_spans.describe()),
1228         );
1229
1230         self.explain_why_borrow_contains_point(context, loan, None)
1231             .add_explanation_to_diagnostic(self.infcx.tcx, self.mir, &mut err, "");
1232
1233         err.buffer(&mut self.errors_buffer);
1234     }
1235
1236     /// Reports an illegal reassignment; for example, an assignment to
1237     /// (part of) a non-`mut` local that occurs potentially after that
1238     /// local has already been initialized. `place` is the path being
1239     /// assigned; `err_place` is a place providing a reason why
1240     /// `place` is not mutable (e.g., the non-`mut` local `x` in an
1241     /// assignment to `x.f`).
1242     pub(super) fn report_illegal_reassignment(
1243         &mut self,
1244         _context: Context,
1245         (place, span): (&Place<'tcx>, Span),
1246         assigned_span: Span,
1247         err_place: &Place<'tcx>,
1248     ) {
1249         let (from_arg, local_decl) = if let Place::Local(local) = *err_place {
1250             if let LocalKind::Arg = self.mir.local_kind(local) {
1251                 (true, Some(&self.mir.local_decls[local]))
1252             } else {
1253                 (false, Some(&self.mir.local_decls[local]))
1254             }
1255         } else {
1256             (false, None)
1257         };
1258
1259         // If root local is initialized immediately (everything apart from let
1260         // PATTERN;) then make the error refer to that local, rather than the
1261         // place being assigned later.
1262         let (place_description, assigned_span) = match local_decl {
1263             Some(LocalDecl {
1264                 is_user_variable: Some(ClearCrossCrate::Clear),
1265                 ..
1266             })
1267             | Some(LocalDecl {
1268                 is_user_variable:
1269                     Some(ClearCrossCrate::Set(BindingForm::Var(VarBindingForm {
1270                         opt_match_place: None,
1271                         ..
1272                     }))),
1273                 ..
1274             })
1275             | Some(LocalDecl {
1276                 is_user_variable: None,
1277                 ..
1278             })
1279             | None => (self.describe_place(place), assigned_span),
1280             Some(decl) => (self.describe_place(err_place), decl.source_info.span),
1281         };
1282
1283         let mut err = self.infcx.tcx.cannot_reassign_immutable(
1284             span,
1285             place_description.as_ref().map(AsRef::as_ref).unwrap_or("_"),
1286             from_arg,
1287             Origin::Mir,
1288         );
1289         let msg = if from_arg {
1290             "cannot assign to immutable argument"
1291         } else {
1292             "cannot assign twice to immutable variable"
1293         };
1294         if span != assigned_span {
1295             if !from_arg {
1296                 let value_msg = match place_description {
1297                     Some(name) => format!("`{}`", name),
1298                     None => "value".to_owned(),
1299                 };
1300                 err.span_label(assigned_span, format!("first assignment to {}", value_msg));
1301             }
1302         }
1303         if let Some(decl) = local_decl {
1304             if let Some(name) = decl.name {
1305                 if decl.can_be_made_mutable() {
1306                     err.span_suggestion_with_applicability(
1307                         decl.source_info.span,
1308                         "make this binding mutable",
1309                         format!("mut {}", name),
1310                         Applicability::MachineApplicable,
1311                     );
1312                 }
1313             }
1314         }
1315         err.span_label(span, msg);
1316         err.buffer(&mut self.errors_buffer);
1317     }
1318 }
1319
1320 pub(super) struct IncludingDowncast(bool);
1321
1322 /// Which case a StorageDeadOrDrop is for.
1323 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
1324 enum StorageDeadOrDrop<'tcx> {
1325     LocalStorageDead,
1326     BoxedStorageDead,
1327     Destructor(ty::Ty<'tcx>),
1328 }
1329
1330 impl<'cx, 'gcx, 'tcx> MirBorrowckCtxt<'cx, 'gcx, 'tcx> {
1331
1332     /// Adds a suggestion when a closure is invoked twice with a moved variable.
1333     ///
1334     /// ```text
1335     /// note: closure cannot be invoked more than once because it moves the variable `dict` out of
1336     ///       its environment
1337     ///   --> $DIR/issue-42065.rs:16:29
1338     ///    |
1339     /// LL |         for (key, value) in dict {
1340     ///    |                             ^^^^
1341     /// ```
1342     pub(super) fn add_closure_invoked_twice_with_moved_variable_suggestion(
1343         &self,
1344         location: Location,
1345         place: &Place<'tcx>,
1346         diag: &mut DiagnosticBuilder<'_>,
1347     ) {
1348         let mut target = place.local();
1349         debug!(
1350             "add_closure_invoked_twice_with_moved_variable_suggestion: location={:?} place={:?} \
1351              target={:?}",
1352              location, place, target,
1353         );
1354         for stmt in &self.mir[location.block].statements[location.statement_index..] {
1355             debug!(
1356                 "add_closure_invoked_twice_with_moved_variable_suggestion: stmt={:?} \
1357                  target={:?}",
1358                  stmt, target,
1359             );
1360             if let StatementKind::Assign(into, box Rvalue::Use(from)) = &stmt.kind {
1361                 debug!(
1362                     "add_closure_invoked_twice_with_moved_variable_suggestion: into={:?} \
1363                      from={:?}",
1364                      into, from,
1365                 );
1366                 match from {
1367                     Operand::Copy(ref place) |
1368                     Operand::Move(ref place) if target == place.local() =>
1369                         target = into.local(),
1370                     _ => {},
1371                 }
1372             }
1373         }
1374
1375
1376         let terminator = self.mir[location.block].terminator();
1377         debug!(
1378             "add_closure_invoked_twice_with_moved_variable_suggestion: terminator={:?}",
1379             terminator,
1380         );
1381         if let TerminatorKind::Call {
1382             func: Operand::Constant(box Constant {
1383                 literal: ty::LazyConst::Evaluated(ty::Const {
1384                     ty: &ty::TyS { sty: ty::TyKind::FnDef(id, _), ..  },
1385                     ..
1386                 }),
1387                 ..
1388             }),
1389             args,
1390             ..
1391         } = &terminator.kind {
1392             debug!("add_closure_invoked_twice_with_moved_variable_suggestion: id={:?}", id);
1393             if self.infcx.tcx.parent(id) == self.infcx.tcx.lang_items().fn_once_trait() {
1394                 let closure = match args.first() {
1395                     Some(Operand::Copy(ref place)) |
1396                     Some(Operand::Move(ref place)) if target == place.local() =>
1397                         place.local().unwrap(),
1398                     _ => return,
1399                 };
1400                 debug!(
1401                     "add_closure_invoked_twice_with_moved_variable_suggestion: closure={:?}",
1402                      closure,
1403                 );
1404
1405                 if let ty::TyKind::Closure(did, _substs) = self.mir.local_decls[closure].ty.sty {
1406                     let node_id = match self.infcx.tcx.hir().as_local_node_id(did) {
1407                         Some(node_id) => node_id,
1408                         _ => return,
1409                     };
1410                     let hir_id = self.infcx.tcx.hir().node_to_hir_id(node_id);
1411
1412                     if let Some((
1413                         span, name
1414                     )) = self.infcx.tcx.typeck_tables_of(did).closure_kind_origins().get(hir_id) {
1415                         diag.span_note(
1416                             *span,
1417                             &format!(
1418                                 "closure cannot be invoked more than once because it \
1419                                  moves the variable `{}` out of its environment",
1420                                  name,
1421                             ),
1422                         );
1423                     }
1424                 }
1425             }
1426         }
1427     }
1428
1429     /// End-user visible description of `place` if one can be found. If the
1430     /// place is a temporary for instance, None will be returned.
1431     pub(super) fn describe_place(&self, place: &Place<'tcx>) -> Option<String> {
1432         self.describe_place_with_options(place, IncludingDowncast(false))
1433     }
1434
1435     /// End-user visible description of `place` if one can be found. If the
1436     /// place is a temporary for instance, None will be returned.
1437     /// `IncludingDowncast` parameter makes the function return `Err` if `ProjectionElem` is
1438     /// `Downcast` and `IncludingDowncast` is true
1439     pub(super) fn describe_place_with_options(
1440         &self,
1441         place: &Place<'tcx>,
1442         including_downcast: IncludingDowncast,
1443     ) -> Option<String> {
1444         let mut buf = String::new();
1445         match self.append_place_to_string(place, &mut buf, false, &including_downcast) {
1446             Ok(()) => Some(buf),
1447             Err(()) => None,
1448         }
1449     }
1450
1451     /// Appends end-user visible description of `place` to `buf`.
1452     fn append_place_to_string(
1453         &self,
1454         place: &Place<'tcx>,
1455         buf: &mut String,
1456         mut autoderef: bool,
1457         including_downcast: &IncludingDowncast,
1458     ) -> Result<(), ()> {
1459         match *place {
1460             Place::Promoted(_) => {
1461                 buf.push_str("promoted");
1462             }
1463             Place::Local(local) => {
1464                 self.append_local_to_string(local, buf)?;
1465             }
1466             Place::Static(ref static_) => {
1467                 buf.push_str(&self.infcx.tcx.item_name(static_.def_id).to_string());
1468             }
1469             Place::Projection(ref proj) => {
1470                 match proj.elem {
1471                     ProjectionElem::Deref => {
1472                         let upvar_field_projection =
1473                             place.is_upvar_field_projection(self.mir, &self.infcx.tcx);
1474                         if let Some(field) = upvar_field_projection {
1475                             let var_index = field.index();
1476                             let name = self.mir.upvar_decls[var_index].debug_name.to_string();
1477                             if self.mir.upvar_decls[var_index].by_ref {
1478                                 buf.push_str(&name);
1479                             } else {
1480                                 buf.push_str(&format!("*{}", &name));
1481                             }
1482                         } else {
1483                             if autoderef {
1484                                 self.append_place_to_string(
1485                                     &proj.base,
1486                                     buf,
1487                                     autoderef,
1488                                     &including_downcast,
1489                                 )?;
1490                             } else if let Place::Local(local) = proj.base {
1491                                 if let Some(ClearCrossCrate::Set(BindingForm::RefForGuard)) =
1492                                     self.mir.local_decls[local].is_user_variable
1493                                 {
1494                                     self.append_place_to_string(
1495                                         &proj.base,
1496                                         buf,
1497                                         autoderef,
1498                                         &including_downcast,
1499                                     )?;
1500                                 } else {
1501                                     buf.push_str(&"*");
1502                                     self.append_place_to_string(
1503                                         &proj.base,
1504                                         buf,
1505                                         autoderef,
1506                                         &including_downcast,
1507                                     )?;
1508                                 }
1509                             } else {
1510                                 buf.push_str(&"*");
1511                                 self.append_place_to_string(
1512                                     &proj.base,
1513                                     buf,
1514                                     autoderef,
1515                                     &including_downcast,
1516                                 )?;
1517                             }
1518                         }
1519                     }
1520                     ProjectionElem::Downcast(..) => {
1521                         self.append_place_to_string(
1522                             &proj.base,
1523                             buf,
1524                             autoderef,
1525                             &including_downcast,
1526                         )?;
1527                         if including_downcast.0 {
1528                             return Err(());
1529                         }
1530                     }
1531                     ProjectionElem::Field(field, _ty) => {
1532                         autoderef = true;
1533
1534                         let upvar_field_projection =
1535                             place.is_upvar_field_projection(self.mir, &self.infcx.tcx);
1536                         if let Some(field) = upvar_field_projection {
1537                             let var_index = field.index();
1538                             let name = self.mir.upvar_decls[var_index].debug_name.to_string();
1539                             buf.push_str(&name);
1540                         } else {
1541                             let field_name = self.describe_field(&proj.base, field);
1542                             self.append_place_to_string(
1543                                 &proj.base,
1544                                 buf,
1545                                 autoderef,
1546                                 &including_downcast,
1547                             )?;
1548                             buf.push_str(&format!(".{}", field_name));
1549                         }
1550                     }
1551                     ProjectionElem::Index(index) => {
1552                         autoderef = true;
1553
1554                         self.append_place_to_string(
1555                             &proj.base,
1556                             buf,
1557                             autoderef,
1558                             &including_downcast,
1559                         )?;
1560                         buf.push_str("[");
1561                         if self.append_local_to_string(index, buf).is_err() {
1562                             buf.push_str("_");
1563                         }
1564                         buf.push_str("]");
1565                     }
1566                     ProjectionElem::ConstantIndex { .. } | ProjectionElem::Subslice { .. } => {
1567                         autoderef = true;
1568                         // Since it isn't possible to borrow an element on a particular index and
1569                         // then use another while the borrow is held, don't output indices details
1570                         // to avoid confusing the end-user
1571                         self.append_place_to_string(
1572                             &proj.base,
1573                             buf,
1574                             autoderef,
1575                             &including_downcast,
1576                         )?;
1577                         buf.push_str(&"[..]");
1578                     }
1579                 };
1580             }
1581         }
1582
1583         Ok(())
1584     }
1585
1586     /// Appends end-user visible description of the `local` place to `buf`. If `local` doesn't have
1587     /// a name, then `Err` is returned
1588     fn append_local_to_string(&self, local_index: Local, buf: &mut String) -> Result<(), ()> {
1589         let local = &self.mir.local_decls[local_index];
1590         match local.name {
1591             Some(name) => {
1592                 buf.push_str(&name.to_string());
1593                 Ok(())
1594             }
1595             None => Err(()),
1596         }
1597     }
1598
1599     /// End-user visible description of the `field`nth field of `base`
1600     fn describe_field(&self, base: &Place, field: Field) -> String {
1601         match *base {
1602             Place::Local(local) => {
1603                 let local = &self.mir.local_decls[local];
1604                 self.describe_field_from_ty(&local.ty, field)
1605             }
1606             Place::Promoted(ref prom) => self.describe_field_from_ty(&prom.1, field),
1607             Place::Static(ref static_) => self.describe_field_from_ty(&static_.ty, field),
1608             Place::Projection(ref proj) => match proj.elem {
1609                 ProjectionElem::Deref => self.describe_field(&proj.base, field),
1610                 ProjectionElem::Downcast(def, variant_index) =>
1611                     def.variants[variant_index].fields[field.index()].ident.to_string(),
1612                 ProjectionElem::Field(_, field_type) => {
1613                     self.describe_field_from_ty(&field_type, field)
1614                 }
1615                 ProjectionElem::Index(..)
1616                 | ProjectionElem::ConstantIndex { .. }
1617                 | ProjectionElem::Subslice { .. } => {
1618                     self.describe_field(&proj.base, field)
1619                 }
1620             },
1621         }
1622     }
1623
1624     /// End-user visible description of the `field_index`nth field of `ty`
1625     fn describe_field_from_ty(&self, ty: &ty::Ty, field: Field) -> String {
1626         if ty.is_box() {
1627             // If the type is a box, the field is described from the boxed type
1628             self.describe_field_from_ty(&ty.boxed_ty(), field)
1629         } else {
1630             match ty.sty {
1631                 ty::Adt(def, _) => if def.is_enum() {
1632                     field.index().to_string()
1633                 } else {
1634                     def.non_enum_variant().fields[field.index()]
1635                         .ident
1636                         .to_string()
1637                 },
1638                 ty::Tuple(_) => field.index().to_string(),
1639                 ty::Ref(_, ty, _) | ty::RawPtr(ty::TypeAndMut { ty, .. }) => {
1640                     self.describe_field_from_ty(&ty, field)
1641                 }
1642                 ty::Array(ty, _) | ty::Slice(ty) => self.describe_field_from_ty(&ty, field),
1643                 ty::Closure(def_id, _) | ty::Generator(def_id, _, _) => {
1644                     // Convert the def-id into a node-id. node-ids are only valid for
1645                     // the local code in the current crate, so this returns an `Option` in case
1646                     // the closure comes from another crate. But in that case we wouldn't
1647                     // be borrowck'ing it, so we can just unwrap:
1648                     let node_id = self.infcx.tcx.hir().as_local_node_id(def_id).unwrap();
1649                     let freevar = self.infcx
1650                         .tcx
1651                         .with_freevars(node_id, |fv| fv[field.index()]);
1652
1653                     self.infcx.tcx.hir().name(freevar.var_id()).to_string()
1654                 }
1655                 _ => {
1656                     // Might need a revision when the fields in trait RFC is implemented
1657                     // (https://github.com/rust-lang/rfcs/pull/1546)
1658                     bug!(
1659                         "End-user description not implemented for field access on `{:?}`",
1660                         ty.sty
1661                     );
1662                 }
1663             }
1664         }
1665     }
1666
1667     /// Check if a place is a thread-local static.
1668     pub fn is_place_thread_local(&self, place: &Place<'tcx>) -> bool {
1669         if let Place::Static(statik) = place {
1670             let attrs = self.infcx.tcx.get_attrs(statik.def_id);
1671             let is_thread_local = attrs.iter().any(|attr| attr.check_name("thread_local"));
1672
1673             debug!(
1674                 "is_place_thread_local: attrs={:?} is_thread_local={:?}",
1675                 attrs, is_thread_local
1676             );
1677             is_thread_local
1678         } else {
1679             debug!("is_place_thread_local: no");
1680             false
1681         }
1682     }
1683
1684     fn classify_drop_access_kind(&self, place: &Place<'tcx>) -> StorageDeadOrDrop<'tcx> {
1685         let tcx = self.infcx.tcx;
1686         match place {
1687             Place::Local(_) | Place::Static(_) | Place::Promoted(_) => {
1688                 StorageDeadOrDrop::LocalStorageDead
1689             }
1690             Place::Projection(box PlaceProjection { base, elem }) => {
1691                 let base_access = self.classify_drop_access_kind(base);
1692                 match elem {
1693                     ProjectionElem::Deref => match base_access {
1694                         StorageDeadOrDrop::LocalStorageDead
1695                         | StorageDeadOrDrop::BoxedStorageDead => {
1696                             assert!(
1697                                 base.ty(self.mir, tcx).to_ty(tcx).is_box(),
1698                                 "Drop of value behind a reference or raw pointer"
1699                             );
1700                             StorageDeadOrDrop::BoxedStorageDead
1701                         }
1702                         StorageDeadOrDrop::Destructor(_) => base_access,
1703                     },
1704                     ProjectionElem::Field(..) | ProjectionElem::Downcast(..) => {
1705                         let base_ty = base.ty(self.mir, tcx).to_ty(tcx);
1706                         match base_ty.sty {
1707                             ty::Adt(def, _) if def.has_dtor(tcx) => {
1708                                 // Report the outermost adt with a destructor
1709                                 match base_access {
1710                                     StorageDeadOrDrop::Destructor(_) => base_access,
1711                                     StorageDeadOrDrop::LocalStorageDead
1712                                     | StorageDeadOrDrop::BoxedStorageDead => {
1713                                         StorageDeadOrDrop::Destructor(base_ty)
1714                                     }
1715                                 }
1716                             }
1717                             _ => base_access,
1718                         }
1719                     }
1720
1721                     ProjectionElem::ConstantIndex { .. }
1722                     | ProjectionElem::Subslice { .. }
1723                     | ProjectionElem::Index(_) => base_access,
1724                 }
1725             }
1726         }
1727     }
1728
1729     /// Annotate argument and return type of function and closure with (synthesized) lifetime for
1730     /// borrow of local value that does not live long enough.
1731     fn annotate_argument_and_return_for_borrow(
1732         &self,
1733         borrow: &BorrowData<'tcx>,
1734     ) -> Option<AnnotatedBorrowFnSignature> {
1735         // Define a fallback for when we can't match a closure.
1736         let fallback = || {
1737             let is_closure = self.infcx.tcx.is_closure(self.mir_def_id);
1738             if is_closure {
1739                 None
1740             } else {
1741                 let ty = self.infcx.tcx.type_of(self.mir_def_id);
1742                 match ty.sty {
1743                     ty::TyKind::FnDef(_, _) | ty::TyKind::FnPtr(_) => self.annotate_fn_sig(
1744                         self.mir_def_id,
1745                         self.infcx.tcx.fn_sig(self.mir_def_id),
1746                     ),
1747                     _ => None,
1748                 }
1749             }
1750         };
1751
1752         // In order to determine whether we need to annotate, we need to check whether the reserve
1753         // place was an assignment into a temporary.
1754         //
1755         // If it was, we check whether or not that temporary is eventually assigned into the return
1756         // place. If it was, we can add annotations about the function's return type and arguments
1757         // and it'll make sense.
1758         let location = borrow.reserve_location;
1759         debug!(
1760             "annotate_argument_and_return_for_borrow: location={:?}",
1761             location
1762         );
1763         if let Some(&Statement { kind: StatementKind::Assign(ref reservation, _), ..})
1764              = &self.mir[location.block].statements.get(location.statement_index)
1765         {
1766             debug!(
1767                 "annotate_argument_and_return_for_borrow: reservation={:?}",
1768                 reservation
1769             );
1770             // Check that the initial assignment of the reserve location is into a temporary.
1771             let mut target = *match reservation {
1772                 Place::Local(local) if self.mir.local_kind(*local) == LocalKind::Temp => local,
1773                 _ => return None,
1774             };
1775
1776             // Next, look through the rest of the block, checking if we are assigning the
1777             // `target` (that is, the place that contains our borrow) to anything.
1778             let mut annotated_closure = None;
1779             for stmt in &self.mir[location.block].statements[location.statement_index + 1..] {
1780                 debug!(
1781                     "annotate_argument_and_return_for_borrow: target={:?} stmt={:?}",
1782                     target, stmt
1783                 );
1784                 if let StatementKind::Assign(Place::Local(assigned_to), box rvalue) = &stmt.kind
1785                 {
1786                     debug!(
1787                         "annotate_argument_and_return_for_borrow: assigned_to={:?} \
1788                          rvalue={:?}",
1789                         assigned_to, rvalue
1790                     );
1791                     // Check if our `target` was captured by a closure.
1792                     if let Rvalue::Aggregate(
1793                         box AggregateKind::Closure(def_id, substs),
1794                         operands,
1795                     ) = rvalue
1796                     {
1797                         for operand in operands {
1798                             let assigned_from = match operand {
1799                                 Operand::Copy(assigned_from) | Operand::Move(assigned_from) => {
1800                                     assigned_from
1801                                 }
1802                                 _ => continue,
1803                             };
1804                             debug!(
1805                                 "annotate_argument_and_return_for_borrow: assigned_from={:?}",
1806                                 assigned_from
1807                             );
1808
1809                             // Find the local from the operand.
1810                             let assigned_from_local = match assigned_from.local() {
1811                                 Some(local) => local,
1812                                 None => continue,
1813                             };
1814
1815                             if assigned_from_local != target {
1816                                 continue;
1817                             }
1818
1819                             // If a closure captured our `target` and then assigned
1820                             // into a place then we should annotate the closure in
1821                             // case it ends up being assigned into the return place.
1822                             annotated_closure = self.annotate_fn_sig(
1823                                 *def_id,
1824                                 self.infcx.closure_sig(*def_id, *substs),
1825                             );
1826                             debug!(
1827                                 "annotate_argument_and_return_for_borrow: \
1828                                  annotated_closure={:?} assigned_from_local={:?} \
1829                                  assigned_to={:?}",
1830                                 annotated_closure, assigned_from_local, assigned_to
1831                             );
1832
1833                             if *assigned_to == mir::RETURN_PLACE {
1834                                 // If it was assigned directly into the return place, then
1835                                 // return now.
1836                                 return annotated_closure;
1837                             } else {
1838                                 // Otherwise, update the target.
1839                                 target = *assigned_to;
1840                             }
1841                         }
1842
1843                         // If none of our closure's operands matched, then skip to the next
1844                         // statement.
1845                         continue;
1846                     }
1847
1848                     // Otherwise, look at other types of assignment.
1849                     let assigned_from = match rvalue {
1850                         Rvalue::Ref(_, _, assigned_from) => assigned_from,
1851                         Rvalue::Use(operand) => match operand {
1852                             Operand::Copy(assigned_from) | Operand::Move(assigned_from) => {
1853                                 assigned_from
1854                             }
1855                             _ => continue,
1856                         },
1857                         _ => continue,
1858                     };
1859                     debug!(
1860                         "annotate_argument_and_return_for_borrow: \
1861                          assigned_from={:?}",
1862                         assigned_from,
1863                     );
1864
1865                     // Find the local from the rvalue.
1866                     let assigned_from_local = match assigned_from.local() {
1867                         Some(local) => local,
1868                         None => continue,
1869                     };
1870                     debug!(
1871                         "annotate_argument_and_return_for_borrow: \
1872                          assigned_from_local={:?}",
1873                         assigned_from_local,
1874                     );
1875
1876                     // Check if our local matches the target - if so, we've assigned our
1877                     // borrow to a new place.
1878                     if assigned_from_local != target {
1879                         continue;
1880                     }
1881
1882                     // If we assigned our `target` into a new place, then we should
1883                     // check if it was the return place.
1884                     debug!(
1885                         "annotate_argument_and_return_for_borrow: \
1886                          assigned_from_local={:?} assigned_to={:?}",
1887                         assigned_from_local, assigned_to
1888                     );
1889                     if *assigned_to == mir::RETURN_PLACE {
1890                         // If it was then return the annotated closure if there was one,
1891                         // else, annotate this function.
1892                         return annotated_closure.or_else(fallback);
1893                     }
1894
1895                     // If we didn't assign into the return place, then we just update
1896                     // the target.
1897                     target = *assigned_to;
1898                 }
1899             }
1900
1901             // Check the terminator if we didn't find anything in the statements.
1902             let terminator = &self.mir[location.block].terminator();
1903             debug!(
1904                 "annotate_argument_and_return_for_borrow: target={:?} terminator={:?}",
1905                 target, terminator
1906             );
1907             if let TerminatorKind::Call {
1908                 destination: Some((Place::Local(assigned_to), _)),
1909                 args,
1910                 ..
1911             } = &terminator.kind
1912             {
1913                 debug!(
1914                     "annotate_argument_and_return_for_borrow: assigned_to={:?} args={:?}",
1915                     assigned_to, args
1916                 );
1917                 for operand in args {
1918                     let assigned_from = match operand {
1919                         Operand::Copy(assigned_from) | Operand::Move(assigned_from) => {
1920                             assigned_from
1921                         }
1922                         _ => continue,
1923                     };
1924                     debug!(
1925                         "annotate_argument_and_return_for_borrow: assigned_from={:?}",
1926                         assigned_from,
1927                     );
1928
1929                     if let Some(assigned_from_local) = assigned_from.local() {
1930                         debug!(
1931                             "annotate_argument_and_return_for_borrow: assigned_from_local={:?}",
1932                             assigned_from_local,
1933                         );
1934
1935                         if *assigned_to == mir::RETURN_PLACE && assigned_from_local == target {
1936                             return annotated_closure.or_else(fallback);
1937                         }
1938                     }
1939                 }
1940             }
1941         }
1942
1943         // If we haven't found an assignment into the return place, then we need not add
1944         // any annotations.
1945         debug!("annotate_argument_and_return_for_borrow: none found");
1946         None
1947     }
1948
1949     /// Annotate the first argument and return type of a function signature if they are
1950     /// references.
1951     fn annotate_fn_sig(
1952         &self,
1953         did: DefId,
1954         sig: ty::PolyFnSig<'tcx>,
1955     ) -> Option<AnnotatedBorrowFnSignature> {
1956         debug!("annotate_fn_sig: did={:?} sig={:?}", did, sig);
1957         let is_closure = self.infcx.tcx.is_closure(did);
1958         let fn_node_id = self.infcx.tcx.hir().as_local_node_id(did)?;
1959         let fn_decl = self.infcx.tcx.hir().fn_decl(fn_node_id)?;
1960
1961         // We need to work out which arguments to highlight. We do this by looking
1962         // at the return type, where there are three cases:
1963         //
1964         // 1. If there are named arguments, then we should highlight the return type and
1965         //    highlight any of the arguments that are also references with that lifetime.
1966         //    If there are no arguments that have the same lifetime as the return type,
1967         //    then don't highlight anything.
1968         // 2. The return type is a reference with an anonymous lifetime. If this is
1969         //    the case, then we can take advantage of (and teach) the lifetime elision
1970         //    rules.
1971         //
1972         //    We know that an error is being reported. So the arguments and return type
1973         //    must satisfy the elision rules. Therefore, if there is a single argument
1974         //    then that means the return type and first (and only) argument have the same
1975         //    lifetime and the borrow isn't meeting that, we can highlight the argument
1976         //    and return type.
1977         //
1978         //    If there are multiple arguments then the first argument must be self (else
1979         //    it would not satisfy the elision rules), so we can highlight self and the
1980         //    return type.
1981         // 3. The return type is not a reference. In this case, we don't highlight
1982         //    anything.
1983         let return_ty = sig.output();
1984         match return_ty.skip_binder().sty {
1985             ty::TyKind::Ref(return_region, _, _) if return_region.has_name() && !is_closure => {
1986                 // This is case 1 from above, return type is a named reference so we need to
1987                 // search for relevant arguments.
1988                 let mut arguments = Vec::new();
1989                 for (index, argument) in sig.inputs().skip_binder().iter().enumerate() {
1990                     if let ty::TyKind::Ref(argument_region, _, _) = argument.sty {
1991                         if argument_region == return_region {
1992                             // Need to use the `rustc::ty` types to compare against the
1993                             // `return_region`. Then use the `rustc::hir` type to get only
1994                             // the lifetime span.
1995                             if let hir::TyKind::Rptr(lifetime, _) = &fn_decl.inputs[index].node {
1996                                 // With access to the lifetime, we can get
1997                                 // the span of it.
1998                                 arguments.push((*argument, lifetime.span));
1999                             } else {
2000                                 bug!("ty type is a ref but hir type is not");
2001                             }
2002                         }
2003                     }
2004                 }
2005
2006                 // We need to have arguments. This shouldn't happen, but it's worth checking.
2007                 if arguments.is_empty() {
2008                     return None;
2009                 }
2010
2011                 // We use a mix of the HIR and the Ty types to get information
2012                 // as the HIR doesn't have full types for closure arguments.
2013                 let return_ty = *sig.output().skip_binder();
2014                 let mut return_span = fn_decl.output.span();
2015                 if let hir::FunctionRetTy::Return(ty) = fn_decl.output {
2016                     if let hir::TyKind::Rptr(lifetime, _) = ty.into_inner().node {
2017                         return_span = lifetime.span;
2018                     }
2019                 }
2020
2021                 Some(AnnotatedBorrowFnSignature::NamedFunction {
2022                     arguments,
2023                     return_ty,
2024                     return_span,
2025                 })
2026             }
2027             ty::TyKind::Ref(_, _, _) if is_closure => {
2028                 // This is case 2 from above but only for closures, return type is anonymous
2029                 // reference so we select
2030                 // the first argument.
2031                 let argument_span = fn_decl.inputs.first()?.span;
2032                 let argument_ty = sig.inputs().skip_binder().first()?;
2033
2034                 // Closure arguments are wrapped in a tuple, so we need to get the first
2035                 // from that.
2036                 if let ty::TyKind::Tuple(elems) = argument_ty.sty {
2037                     let argument_ty = elems.first()?;
2038                     if let ty::TyKind::Ref(_, _, _) = argument_ty.sty {
2039                         return Some(AnnotatedBorrowFnSignature::Closure {
2040                             argument_ty,
2041                             argument_span,
2042                         });
2043                     }
2044                 }
2045
2046                 None
2047             }
2048             ty::TyKind::Ref(_, _, _) => {
2049                 // This is also case 2 from above but for functions, return type is still an
2050                 // anonymous reference so we select the first argument.
2051                 let argument_span = fn_decl.inputs.first()?.span;
2052                 let argument_ty = sig.inputs().skip_binder().first()?;
2053
2054                 let return_span = fn_decl.output.span();
2055                 let return_ty = *sig.output().skip_binder();
2056
2057                 // We expect the first argument to be a reference.
2058                 match argument_ty.sty {
2059                     ty::TyKind::Ref(_, _, _) => {}
2060                     _ => return None,
2061                 }
2062
2063                 Some(AnnotatedBorrowFnSignature::AnonymousFunction {
2064                     argument_ty,
2065                     argument_span,
2066                     return_ty,
2067                     return_span,
2068                 })
2069             }
2070             _ => {
2071                 // This is case 3 from above, return type is not a reference so don't highlight
2072                 // anything.
2073                 None
2074             }
2075         }
2076     }
2077 }
2078
2079 #[derive(Debug)]
2080 enum AnnotatedBorrowFnSignature<'tcx> {
2081     NamedFunction {
2082         arguments: Vec<(ty::Ty<'tcx>, Span)>,
2083         return_ty: ty::Ty<'tcx>,
2084         return_span: Span,
2085     },
2086     AnonymousFunction {
2087         argument_ty: ty::Ty<'tcx>,
2088         argument_span: Span,
2089         return_ty: ty::Ty<'tcx>,
2090         return_span: Span,
2091     },
2092     Closure {
2093         argument_ty: ty::Ty<'tcx>,
2094         argument_span: Span,
2095     },
2096 }
2097
2098 impl<'tcx> AnnotatedBorrowFnSignature<'tcx> {
2099     /// Annotate the provided diagnostic with information about borrow from the fn signature that
2100     /// helps explain.
2101     fn emit(&self, diag: &mut DiagnosticBuilder<'_>) -> String {
2102         match self {
2103             AnnotatedBorrowFnSignature::Closure {
2104                 argument_ty,
2105                 argument_span,
2106             } => {
2107                 diag.span_label(
2108                     *argument_span,
2109                     format!("has type `{}`", self.get_name_for_ty(argument_ty, 0)),
2110                 );
2111
2112                 self.get_region_name_for_ty(argument_ty, 0)
2113             }
2114             AnnotatedBorrowFnSignature::AnonymousFunction {
2115                 argument_ty,
2116                 argument_span,
2117                 return_ty,
2118                 return_span,
2119             } => {
2120                 let argument_ty_name = self.get_name_for_ty(argument_ty, 0);
2121                 diag.span_label(*argument_span, format!("has type `{}`", argument_ty_name));
2122
2123                 let return_ty_name = self.get_name_for_ty(return_ty, 0);
2124                 let types_equal = return_ty_name == argument_ty_name;
2125                 diag.span_label(
2126                     *return_span,
2127                     format!(
2128                         "{}has type `{}`",
2129                         if types_equal { "also " } else { "" },
2130                         return_ty_name,
2131                     ),
2132                 );
2133
2134                 diag.note(
2135                     "argument and return type have the same lifetime due to lifetime elision rules",
2136                 );
2137                 diag.note(
2138                     "to learn more, visit <https://doc.rust-lang.org/book/second-edition/ch10-03-\
2139                      lifetime-syntax.html#lifetime-elision>",
2140                 );
2141
2142                 self.get_region_name_for_ty(return_ty, 0)
2143             }
2144             AnnotatedBorrowFnSignature::NamedFunction {
2145                 arguments,
2146                 return_ty,
2147                 return_span,
2148             } => {
2149                 // Region of return type and arguments checked to be the same earlier.
2150                 let region_name = self.get_region_name_for_ty(return_ty, 0);
2151                 for (_, argument_span) in arguments {
2152                     diag.span_label(*argument_span, format!("has lifetime `{}`", region_name));
2153                 }
2154
2155                 diag.span_label(
2156                     *return_span,
2157                     format!("also has lifetime `{}`", region_name,),
2158                 );
2159
2160                 diag.help(&format!(
2161                     "use data from the highlighted arguments which match the `{}` lifetime of \
2162                      the return type",
2163                     region_name,
2164                 ));
2165
2166                 region_name
2167             }
2168         }
2169     }
2170
2171     /// Return the name of the provided `Ty` (that must be a reference) with a synthesized lifetime
2172     /// name where required.
2173     fn get_name_for_ty(&self, ty: ty::Ty<'tcx>, counter: usize) -> String {
2174         // We need to add synthesized lifetimes where appropriate. We do
2175         // this by hooking into the pretty printer and telling it to label the
2176         // lifetimes without names with the value `'0`.
2177         match ty.sty {
2178             ty::TyKind::Ref(ty::RegionKind::ReLateBound(_, br), _, _)
2179             | ty::TyKind::Ref(
2180                 ty::RegionKind::RePlaceholder(ty::PlaceholderRegion { name: br, .. }),
2181                 _,
2182                 _,
2183             ) => RegionHighlightMode::highlighting_bound_region(*br, counter, || ty.to_string()),
2184             _ => ty.to_string(),
2185         }
2186     }
2187
2188     /// Return the name of the provided `Ty` (that must be a reference)'s region with a
2189     /// synthesized lifetime name where required.
2190     fn get_region_name_for_ty(&self, ty: ty::Ty<'tcx>, counter: usize) -> String {
2191         match ty.sty {
2192             ty::TyKind::Ref(region, _, _) => match region {
2193                 ty::RegionKind::ReLateBound(_, br)
2194                 | ty::RegionKind::RePlaceholder(ty::PlaceholderRegion { name: br, .. }) => {
2195                     RegionHighlightMode::highlighting_bound_region(
2196                         *br,
2197                         counter,
2198                         || region.to_string(),
2199                     )
2200                 }
2201                 _ => region.to_string(),
2202             },
2203             _ => bug!("ty for annotation of borrow region is not a reference"),
2204         }
2205     }
2206 }
2207
2208 // The span(s) associated to a use of a place.
2209 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
2210 pub(super) enum UseSpans {
2211     // The access is caused by capturing a variable for a closure.
2212     ClosureUse {
2213         // This is true if the captured variable was from a generator.
2214         is_generator: bool,
2215         // The span of the args of the closure, including the `move` keyword if
2216         // it's present.
2217         args_span: Span,
2218         // The span of the first use of the captured variable inside the closure.
2219         var_span: Span,
2220     },
2221     // This access has a single span associated to it: common case.
2222     OtherUse(Span),
2223 }
2224
2225 impl UseSpans {
2226     pub(super) fn args_or_use(self) -> Span {
2227         match self {
2228             UseSpans::ClosureUse {
2229                 args_span: span, ..
2230             }
2231             | UseSpans::OtherUse(span) => span,
2232         }
2233     }
2234
2235     pub(super) fn var_or_use(self) -> Span {
2236         match self {
2237             UseSpans::ClosureUse { var_span: span, .. } | UseSpans::OtherUse(span) => span,
2238         }
2239     }
2240
2241     // Add a span label to the arguments of the closure, if it exists.
2242     pub(super) fn args_span_label(self, err: &mut DiagnosticBuilder, message: impl Into<String>) {
2243         if let UseSpans::ClosureUse { args_span, .. } = self {
2244             err.span_label(args_span, message);
2245         }
2246     }
2247
2248     // Add a span label to the use of the captured variable, if it exists.
2249     pub(super) fn var_span_label(self, err: &mut DiagnosticBuilder, message: impl Into<String>) {
2250         if let UseSpans::ClosureUse { var_span, .. } = self {
2251             err.span_label(var_span, message);
2252         }
2253     }
2254
2255     /// Return `false` if this place is not used in a closure.
2256     fn for_closure(&self) -> bool {
2257         match *self {
2258             UseSpans::ClosureUse { is_generator, .. } => !is_generator,
2259             _ => false,
2260         }
2261     }
2262
2263     /// Return `false` if this place is not used in a generator.
2264     fn for_generator(&self) -> bool {
2265         match *self {
2266             UseSpans::ClosureUse { is_generator, .. } => is_generator,
2267             _ => false,
2268         }
2269     }
2270
2271     /// Describe the span associated with a use of a place.
2272     fn describe(&self) -> String {
2273         match *self {
2274             UseSpans::ClosureUse { is_generator, .. } => if is_generator {
2275                 " in generator".to_string()
2276             } else {
2277                 " in closure".to_string()
2278             },
2279             _ => "".to_string(),
2280         }
2281     }
2282
2283     pub(super) fn or_else<F>(self, if_other: F) -> Self
2284     where
2285         F: FnOnce() -> Self,
2286     {
2287         match self {
2288             closure @ UseSpans::ClosureUse { .. } => closure,
2289             UseSpans::OtherUse(_) => if_other(),
2290         }
2291     }
2292 }
2293
2294 impl<'cx, 'gcx, 'tcx> MirBorrowckCtxt<'cx, 'gcx, 'tcx> {
2295     /// Finds the spans associated to a move or copy of move_place at location.
2296     pub(super) fn move_spans(
2297         &self,
2298         moved_place: &Place<'tcx>, // Could also be an upvar.
2299         location: Location,
2300     ) -> UseSpans {
2301         use self::UseSpans::*;
2302
2303         let stmt = match self.mir[location.block].statements.get(location.statement_index) {
2304             Some(stmt) => stmt,
2305             None => return OtherUse(self.mir.source_info(location).span),
2306         };
2307
2308         debug!("move_spans: moved_place={:?} location={:?} stmt={:?}", moved_place, location, stmt);
2309         if let  StatementKind::Assign(
2310             _,
2311             box Rvalue::Aggregate(ref kind, ref places)
2312         ) = stmt.kind {
2313             let (def_id, is_generator) = match kind {
2314                 box AggregateKind::Closure(def_id, _) => (def_id, false),
2315                 box AggregateKind::Generator(def_id, _, _) => (def_id, true),
2316                 _ => return OtherUse(stmt.source_info.span),
2317             };
2318
2319             debug!(
2320                 "move_spans: def_id={:?} is_generator={:?} places={:?}",
2321                 def_id, is_generator, places
2322             );
2323             if let Some((args_span, var_span)) = self.closure_span(*def_id, moved_place, places) {
2324                 return ClosureUse {
2325                     is_generator,
2326                     args_span,
2327                     var_span,
2328                 };
2329             }
2330         }
2331
2332         OtherUse(stmt.source_info.span)
2333     }
2334
2335     /// Finds the span of arguments of a closure (within `maybe_closure_span`)
2336     /// and its usage of the local assigned at `location`.
2337     /// This is done by searching in statements succeeding `location`
2338     /// and originating from `maybe_closure_span`.
2339     pub(super) fn borrow_spans(&self, use_span: Span, location: Location) -> UseSpans {
2340         use self::UseSpans::*;
2341         debug!("borrow_spans: use_span={:?} location={:?}", use_span, location);
2342
2343         let target = match self.mir[location.block]
2344             .statements
2345             .get(location.statement_index)
2346         {
2347             Some(&Statement {
2348                 kind: StatementKind::Assign(Place::Local(local), _),
2349                 ..
2350             }) => local,
2351             _ => return OtherUse(use_span),
2352         };
2353
2354         if self.mir.local_kind(target) != LocalKind::Temp {
2355             // operands are always temporaries.
2356             return OtherUse(use_span);
2357         }
2358
2359         for stmt in &self.mir[location.block].statements[location.statement_index + 1..] {
2360             if let StatementKind::Assign(
2361                 _, box Rvalue::Aggregate(ref kind, ref places)
2362             ) = stmt.kind {
2363                 let (def_id, is_generator) = match kind {
2364                     box AggregateKind::Closure(def_id, _) => (def_id, false),
2365                     box AggregateKind::Generator(def_id, _, _) => (def_id, true),
2366                     _ => continue,
2367                 };
2368
2369                 debug!(
2370                     "borrow_spans: def_id={:?} is_generator={:?} places={:?}",
2371                     def_id, is_generator, places
2372                 );
2373                 if let Some((args_span, var_span)) = self.closure_span(
2374                     *def_id, &Place::Local(target), places
2375                 ) {
2376                     return ClosureUse {
2377                         is_generator,
2378                         args_span,
2379                         var_span,
2380                     };
2381                 } else {
2382                     return OtherUse(use_span);
2383                 }
2384             }
2385
2386             if use_span != stmt.source_info.span {
2387                 break;
2388             }
2389         }
2390
2391         OtherUse(use_span)
2392     }
2393
2394     /// Finds the span of a captured variable within a closure or generator.
2395     fn closure_span(
2396         &self,
2397         def_id: DefId,
2398         target_place: &Place<'tcx>,
2399         places: &Vec<Operand<'tcx>>,
2400     ) -> Option<(Span, Span)> {
2401         debug!(
2402             "closure_span: def_id={:?} target_place={:?} places={:?}",
2403             def_id, target_place, places
2404         );
2405         let node_id = self.infcx.tcx.hir().as_local_node_id(def_id)?;
2406         let expr = &self.infcx.tcx.hir().expect_expr(node_id).node;
2407         debug!("closure_span: node_id={:?} expr={:?}", node_id, expr);
2408         if let hir::ExprKind::Closure(
2409             .., args_span, _
2410         ) = expr {
2411             let var_span = self.infcx.tcx.with_freevars(
2412                 node_id,
2413                 |freevars| {
2414                     for (v, place) in freevars.iter().zip(places) {
2415                         match place {
2416                             Operand::Copy(place) |
2417                             Operand::Move(place) if target_place == place => {
2418                                 debug!("closure_span: found captured local {:?}", place);
2419                                 return Some(v.span);
2420                             },
2421                             _ => {}
2422                         }
2423                     }
2424
2425                     None
2426                 },
2427             )?;
2428
2429             Some((*args_span, var_span))
2430         } else {
2431             None
2432         }
2433     }
2434
2435     /// Helper to retrieve span(s) of given borrow from the current MIR
2436     /// representation
2437     pub(super) fn retrieve_borrow_spans(&self, borrow: &BorrowData) -> UseSpans {
2438         let span = self.mir.source_info(borrow.reserve_location).span;
2439         self.borrow_spans(span, borrow.reserve_location)
2440     }
2441 }