compiler/rustc_borrowck/src/diagnostics/mod.rs

   1 //! Borrow checker diagnostics.
   2
   3 use rustc_const_eval::util::call_kind;
   4 use rustc_errors::Diagnostic;
   5 use rustc_hir as hir;
   6 use rustc_hir::def::Namespace;
   7 use rustc_hir::def_id::DefId;
   8 use rustc_hir::GeneratorKind;
   9 use rustc_middle::mir::{
  10     AggregateKind, Constant, FakeReadCause, Field, Local, LocalInfo, LocalKind, Location, Operand,
  11     Place, PlaceRef, ProjectionElem, Rvalue, Statement, StatementKind, Terminator, TerminatorKind,
  12 };
  13 use rustc_middle::ty::print::Print;
  14 use rustc_middle::ty::{self, DefIdTree, Instance, Ty, TyCtxt};
  15 use rustc_mir_dataflow::move_paths::{InitLocation, LookupResult};
  16 use rustc_span::{symbol::sym, Span};
  17 use rustc_target::abi::VariantIdx;
  18
  19 use super::borrow_set::BorrowData;
  20 use super::MirBorrowckCtxt;
  21
  22 mod find_all_local_uses;
  23 mod find_use;
  24 mod outlives_suggestion;
  25 mod region_name;
  26 mod var_name;
  27
  28 mod bound_region_errors;
  29 mod conflict_errors;
  30 mod explain_borrow;
  31 mod move_errors;
  32 mod mutability_errors;
  33 mod region_errors;
  34
  35 crate use bound_region_errors::{ToUniverseInfo, UniverseInfo};
  36 crate use mutability_errors::AccessKind;
  37 crate use outlives_suggestion::OutlivesSuggestionBuilder;
  38 crate use region_errors::{ErrorConstraintInfo, RegionErrorKind, RegionErrors};
  39 crate use region_name::{RegionName, RegionNameSource};
  40 crate use rustc_const_eval::util::CallKind;
  41
  42 pub(super) struct IncludingDowncast(pub(super) bool);
  43
  44 impl<'cx, 'tcx> MirBorrowckCtxt<'cx, 'tcx> {
  45     /// Adds a suggestion when a closure is invoked twice with a moved variable or when a closure
  46     /// is moved after being invoked.
  47     ///
  48     /// ```text
  49     /// note: closure cannot be invoked more than once because it moves the variable `dict` out of
  50     ///       its environment
  51     ///   --> $DIR/issue-42065.rs:16:29
  52     ///    |
  53     /// LL |         for (key, value) in dict {
  54     ///    |                             ^^^^
  55     /// ```
  56     pub(super) fn add_moved_or_invoked_closure_note(
  57         &self,
  58         location: Location,
  59         place: PlaceRef<'tcx>,
  60         diag: &mut Diagnostic,
  61     ) {
  62         debug!("add_moved_or_invoked_closure_note: location={:?} place={:?}", location, place);
  63         let mut target = place.local_or_deref_local();
  64         for stmt in &self.body[location.block].statements[location.statement_index..] {
  65             debug!("add_moved_or_invoked_closure_note: stmt={:?} target={:?}", stmt, target);
  66             if let StatementKind::Assign(box (into, Rvalue::Use(from))) = &stmt.kind {
  67                 debug!("add_fnonce_closure_note: into={:?} from={:?}", into, from);
  68                 match from {
  69                     Operand::Copy(ref place) | Operand::Move(ref place)
  70                         if target == place.local_or_deref_local() =>
  71                     {
  72                         target = into.local_or_deref_local()
  73                     }
  74                     _ => {}
  75                 }
  76             }
  77         }
  78
  79         // Check if we are attempting to call a closure after it has been invoked.
  80         let terminator = self.body[location.block].terminator();
  81         debug!("add_moved_or_invoked_closure_note: terminator={:?}", terminator);
  82         if let TerminatorKind::Call {
  83             func: Operand::Constant(box Constant { literal, .. }),
  84             args,
  85             ..
  86         } = &terminator.kind
  87         {
  88             if let ty::FnDef(id, _) = *literal.ty().kind() {
  89                 debug!("add_moved_or_invoked_closure_note: id={:?}", id);
  90                 if self.infcx.tcx.parent(id) == self.infcx.tcx.lang_items().fn_once_trait() {
  91                     let closure = match args.first() {
  92                         Some(Operand::Copy(ref place)) | Some(Operand::Move(ref place))
  93                             if target == place.local_or_deref_local() =>
  94                         {
  95                             place.local_or_deref_local().unwrap()
  96                         }
  97                         _ => return,
  98                     };
  99
 100                     debug!("add_moved_or_invoked_closure_note: closure={:?}", closure);
 101                     if let ty::Closure(did, _) = self.body.local_decls[closure].ty.kind() {
 102                         let did = did.expect_local();
 103                         let hir_id = self.infcx.tcx.hir().local_def_id_to_hir_id(did);
 104
 105                         if let Some((span, hir_place)) =
 106                             self.infcx.tcx.typeck(did).closure_kind_origins().get(hir_id)
 107                         {
 108                             diag.span_note(
 109                                 *span,
 110                                 &format!(
 111                                     "closure cannot be invoked more than once because it moves the \
 112                                     variable `{}` out of its environment",
 113                                     ty::place_to_string_for_capture(self.infcx.tcx, hir_place)
 114                                 ),
 115                             );
 116                             return;
 117                         }
 118                     }
 119                 }
 120             }
 121         }
 122
 123         // Check if we are just moving a closure after it has been invoked.
 124         if let Some(target) = target {
 125             if let ty::Closure(did, _) = self.body.local_decls[target].ty.kind() {
 126                 let did = did.expect_local();
 127                 let hir_id = self.infcx.tcx.hir().local_def_id_to_hir_id(did);
 128
 129                 if let Some((span, hir_place)) =
 130                     self.infcx.tcx.typeck(did).closure_kind_origins().get(hir_id)
 131                 {
 132                     diag.span_note(
 133                         *span,
 134                         &format!(
 135                             "closure cannot be moved more than once as it is not `Copy` due to \
 136                              moving the variable `{}` out of its environment",
 137                             ty::place_to_string_for_capture(self.infcx.tcx, hir_place)
 138                         ),
 139                     );
 140                 }
 141             }
 142         }
 143     }
 144
 145     /// End-user visible description of `place` if one can be found.
 146     /// If the place is a temporary for instance, `"value"` will be returned.
 147     pub(super) fn describe_any_place(&self, place_ref: PlaceRef<'tcx>) -> String {
 148         match self.describe_place(place_ref) {
 149             Some(mut descr) => {
 150                 // Surround descr with `backticks`.
 151                 descr.reserve(2);
 152                 descr.insert(0, '`');
 153                 descr.push('`');
 154                 descr
 155             }
 156             None => "value".to_string(),
 157         }
 158     }
 159
 160     /// End-user visible description of `place` if one can be found.
 161     /// If the place is a temporary for instance, None will be returned.
 162     pub(super) fn describe_place(&self, place_ref: PlaceRef<'tcx>) -> Option<String> {
 163         self.describe_place_with_options(place_ref, IncludingDowncast(false))
 164     }
 165
 166     /// End-user visible description of `place` if one can be found. If the
 167     /// place is a temporary for instance, None will be returned.
 168     /// `IncludingDowncast` parameter makes the function return `Err` if `ProjectionElem` is
 169     /// `Downcast` and `IncludingDowncast` is true
 170     pub(super) fn describe_place_with_options(
 171         &self,
 172         place: PlaceRef<'tcx>,
 173         including_downcast: IncludingDowncast,
 174     ) -> Option<String> {
 175         let mut buf = String::new();
 176         match self.append_place_to_string(place, &mut buf, false, &including_downcast) {
 177             Ok(()) => Some(buf),
 178             Err(()) => None,
 179         }
 180     }
 181
 182     /// Appends end-user visible description of `place` to `buf`.
 183     fn append_place_to_string(
 184         &self,
 185         place: PlaceRef<'tcx>,
 186         buf: &mut String,
 187         mut autoderef: bool,
 188         including_downcast: &IncludingDowncast,
 189     ) -> Result<(), ()> {
 190         match place {
 191             PlaceRef { local, projection: [] } => {
 192                 self.append_local_to_string(local, buf)?;
 193             }
 194             PlaceRef { local, projection: [ProjectionElem::Deref] }
 195                 if self.body.local_decls[local].is_ref_for_guard() =>
 196             {
 197                 self.append_place_to_string(
 198                     PlaceRef { local, projection: &[] },
 199                     buf,
 200                     autoderef,
 201                     &including_downcast,
 202                 )?;
 203             }
 204             PlaceRef { local, projection: [ProjectionElem::Deref] }
 205                 if self.body.local_decls[local].is_ref_to_static() =>
 206             {
 207                 let local_info = &self.body.local_decls[local].local_info;
 208                 if let Some(box LocalInfo::StaticRef { def_id, .. }) = *local_info {
 209                     buf.push_str(self.infcx.tcx.item_name(def_id).as_str());
 210                 } else {
 211                     unreachable!();
 212                 }
 213             }
 214             PlaceRef { local, projection: [proj_base @ .., elem] } => {
 215                 match elem {
 216                     ProjectionElem::Deref => {
 217                         let upvar_field_projection = self.is_upvar_field_projection(place);
 218                         if let Some(field) = upvar_field_projection {
 219                             let var_index = field.index();
 220                             let name = self.upvars[var_index].place.to_string(self.infcx.tcx);
 221                             if self.upvars[var_index].by_ref {
 222                                 buf.push_str(&name);
 223                             } else {
 224                                 buf.push('*');
 225                                 buf.push_str(&name);
 226                             }
 227                         } else {
 228                             if autoderef {
 229                                 // FIXME turn this recursion into iteration
 230                                 self.append_place_to_string(
 231                                     PlaceRef { local, projection: proj_base },
 232                                     buf,
 233                                     autoderef,
 234                                     &including_downcast,
 235                                 )?;
 236                             } else {
 237                                 buf.push('*');
 238                                 self.append_place_to_string(
 239                                     PlaceRef { local, projection: proj_base },
 240                                     buf,
 241                                     autoderef,
 242                                     &including_downcast,
 243                                 )?;
 244                             }
 245                         }
 246                     }
 247                     ProjectionElem::Downcast(..) => {
 248                         self.append_place_to_string(
 249                             PlaceRef { local, projection: proj_base },
 250                             buf,
 251                             autoderef,
 252                             &including_downcast,
 253                         )?;
 254                         if including_downcast.0 {
 255                             return Err(());
 256                         }
 257                     }
 258                     ProjectionElem::Field(field, _ty) => {
 259                         autoderef = true;
 260
 261                         // FIXME(project-rfc_2229#36): print capture precisely here.
 262                         let upvar_field_projection = self.is_upvar_field_projection(place);
 263                         if let Some(field) = upvar_field_projection {
 264                             let var_index = field.index();
 265                             let name = self.upvars[var_index].place.to_string(self.infcx.tcx);
 266                             buf.push_str(&name);
 267                         } else {
 268                             let field_name = self
 269                                 .describe_field(PlaceRef { local, projection: proj_base }, *field);
 270                             self.append_place_to_string(
 271                                 PlaceRef { local, projection: proj_base },
 272                                 buf,
 273                                 autoderef,
 274                                 &including_downcast,
 275                             )?;
 276                             buf.push('.');
 277                             buf.push_str(&field_name);
 278                         }
 279                     }
 280                     ProjectionElem::Index(index) => {
 281                         autoderef = true;
 282
 283                         self.append_place_to_string(
 284                             PlaceRef { local, projection: proj_base },
 285                             buf,
 286                             autoderef,
 287                             &including_downcast,
 288                         )?;
 289                         buf.push('[');
 290                         if self.append_local_to_string(*index, buf).is_err() {
 291                             buf.push('_');
 292                         }
 293                         buf.push(']');
 294                     }
 295                     ProjectionElem::ConstantIndex { .. } | ProjectionElem::Subslice { .. } => {
 296                         autoderef = true;
 297                         // Since it isn't possible to borrow an element on a particular index and
 298                         // then use another while the borrow is held, don't output indices details
 299                         // to avoid confusing the end-user
 300                         self.append_place_to_string(
 301                             PlaceRef { local, projection: proj_base },
 302                             buf,
 303                             autoderef,
 304                             &including_downcast,
 305                         )?;
 306                         buf.push_str("[..]");
 307                     }
 308                 };
 309             }
 310         }
 311
 312         Ok(())
 313     }
 314
 315     /// Appends end-user visible description of the `local` place to `buf`. If `local` doesn't have
 316     /// a name, or its name was generated by the compiler, then `Err` is returned
 317     fn append_local_to_string(&self, local: Local, buf: &mut String) -> Result<(), ()> {
 318         let decl = &self.body.local_decls[local];
 319         match self.local_names[local] {
 320             Some(name) if !decl.from_compiler_desugaring() => {
 321                 buf.push_str(name.as_str());
 322                 Ok(())
 323             }
 324             _ => Err(()),
 325         }
 326     }
 327
 328     /// End-user visible description of the `field`nth field of `base`
 329     fn describe_field(&self, place: PlaceRef<'tcx>, field: Field) -> String {
 330         // FIXME Place2 Make this work iteratively
 331         match place {
 332             PlaceRef { local, projection: [] } => {
 333                 let local = &self.body.local_decls[local];
 334                 self.describe_field_from_ty(local.ty, field, None)
 335             }
 336             PlaceRef { local, projection: [proj_base @ .., elem] } => match elem {
 337                 ProjectionElem::Deref => {
 338                     self.describe_field(PlaceRef { local, projection: proj_base }, field)
 339                 }
 340                 ProjectionElem::Downcast(_, variant_index) => {
 341                     let base_ty = place.ty(self.body, self.infcx.tcx).ty;
 342                     self.describe_field_from_ty(base_ty, field, Some(*variant_index))
 343                 }
 344                 ProjectionElem::Field(_, field_type) => {
 345                     self.describe_field_from_ty(*field_type, field, None)
 346                 }
 347                 ProjectionElem::Index(..)
 348                 | ProjectionElem::ConstantIndex { .. }
 349                 | ProjectionElem::Subslice { .. } => {
 350                     self.describe_field(PlaceRef { local, projection: proj_base }, field)
 351                 }
 352             },
 353         }
 354     }
 355
 356     /// End-user visible description of the `field_index`nth field of `ty`
 357     fn describe_field_from_ty(
 358         &self,
 359         ty: Ty<'_>,
 360         field: Field,
 361         variant_index: Option<VariantIdx>,
 362     ) -> String {
 363         if ty.is_box() {
 364             // If the type is a box, the field is described from the boxed type
 365             self.describe_field_from_ty(ty.boxed_ty(), field, variant_index)
 366         } else {
 367             match *ty.kind() {
 368                 ty::Adt(def, _) => {
 369                     let variant = if let Some(idx) = variant_index {
 370                         assert!(def.is_enum());
 371                         &def.variants[idx]
 372                     } else {
 373                         def.non_enum_variant()
 374                     };
 375                     variant.fields[field.index()].name.to_string()
 376                 }
 377                 ty::Tuple(_) => field.index().to_string(),
 378                 ty::Ref(_, ty, _) | ty::RawPtr(ty::TypeAndMut { ty, .. }) => {
 379                     self.describe_field_from_ty(ty, field, variant_index)
 380                 }
 381                 ty::Array(ty, _) | ty::Slice(ty) => {
 382                     self.describe_field_from_ty(ty, field, variant_index)
 383                 }
 384                 ty::Closure(def_id, _) | ty::Generator(def_id, _, _) => {
 385                     // We won't be borrowck'ing here if the closure came from another crate,
 386                     // so it's safe to call `expect_local`.
 387                     //
 388                     // We know the field exists so it's safe to call operator[] and `unwrap` here.
 389                     let var_id = self
 390                         .infcx
 391                         .tcx
 392                         .typeck(def_id.expect_local())
 393                         .closure_min_captures_flattened(def_id)
 394                         .nth(field.index())
 395                         .unwrap()
 396                         .get_root_variable();
 397
 398                     self.infcx.tcx.hir().name(var_id).to_string()
 399                 }
 400                 _ => {
 401                     // Might need a revision when the fields in trait RFC is implemented
 402                     // (https://github.com/rust-lang/rfcs/pull/1546)
 403                     bug!("End-user description not implemented for field access on `{:?}`", ty);
 404                 }
 405             }
 406         }
 407     }
 408
 409     /// Add a note that a type does not implement `Copy`
 410     pub(super) fn note_type_does_not_implement_copy(
 411         &self,
 412         err: &mut Diagnostic,
 413         place_desc: &str,
 414         ty: Ty<'tcx>,
 415         span: Option<Span>,
 416         move_prefix: &str,
 417     ) {
 418         let message = format!(
 419             "{}move occurs because {} has type `{}`, which does not implement the `Copy` trait",
 420             move_prefix, place_desc, ty,
 421         );
 422         if let Some(span) = span {
 423             err.span_label(span, message);
 424         } else {
 425             err.note(&message);
 426         }
 427     }
 428
 429     pub(super) fn borrowed_content_source(
 430         &self,
 431         deref_base: PlaceRef<'tcx>,
 432     ) -> BorrowedContentSource<'tcx> {
 433         let tcx = self.infcx.tcx;
 434
 435         // Look up the provided place and work out the move path index for it,
 436         // we'll use this to check whether it was originally from an overloaded
 437         // operator.
 438         match self.move_data.rev_lookup.find(deref_base) {
 439             LookupResult::Exact(mpi) | LookupResult::Parent(Some(mpi)) => {
 440                 debug!("borrowed_content_source: mpi={:?}", mpi);
 441
 442                 for i in &self.move_data.init_path_map[mpi] {
 443                     let init = &self.move_data.inits[*i];
 444                     debug!("borrowed_content_source: init={:?}", init);
 445                     // We're only interested in statements that initialized a value, not the
 446                     // initializations from arguments.
 447                     let InitLocation::Statement(loc) = init.location else { continue };
 448
 449                     let bbd = &self.body[loc.block];
 450                     let is_terminator = bbd.statements.len() == loc.statement_index;
 451                     debug!(
 452                         "borrowed_content_source: loc={:?} is_terminator={:?}",
 453                         loc, is_terminator,
 454                     );
 455                     if !is_terminator {
 456                         continue;
 457                     } else if let Some(Terminator {
 458                         kind: TerminatorKind::Call { ref func, from_hir_call: false, .. },
 459                         ..
 460                     }) = bbd.terminator
 461                     {
 462                         if let Some(source) =
 463                             BorrowedContentSource::from_call(func.ty(self.body, tcx), tcx)
 464                         {
 465                             return source;
 466                         }
 467                     }
 468                 }
 469             }
 470             // Base is a `static` so won't be from an overloaded operator
 471             _ => (),
 472         };
 473
 474         // If we didn't find an overloaded deref or index, then assume it's a
 475         // built in deref and check the type of the base.
 476         let base_ty = deref_base.ty(self.body, tcx).ty;
 477         if base_ty.is_unsafe_ptr() {
 478             BorrowedContentSource::DerefRawPointer
 479         } else if base_ty.is_mutable_ptr() {
 480             BorrowedContentSource::DerefMutableRef
 481         } else {
 482             BorrowedContentSource::DerefSharedRef
 483         }
 484     }
 485 }
 486
 487 impl<'cx, 'tcx> MirBorrowckCtxt<'cx, 'tcx> {
 488     /// Return the name of the provided `Ty` (that must be a reference) with a synthesized lifetime
 489     /// name where required.
 490     pub(super) fn get_name_for_ty(&self, ty: Ty<'tcx>, counter: usize) -> String {
 491         let mut printer = ty::print::FmtPrinter::new(self.infcx.tcx, Namespace::TypeNS);
 492
 493         // We need to add synthesized lifetimes where appropriate. We do
 494         // this by hooking into the pretty printer and telling it to label the
 495         // lifetimes without names with the value `'0`.
 496         if let ty::Ref(region, ..) = ty.kind() {
 497             match **region {
 498                 ty::ReLateBound(_, ty::BoundRegion { kind: br, .. })
 499                 | ty::RePlaceholder(ty::PlaceholderRegion { name: br, .. }) => {
 500                     printer.region_highlight_mode.highlighting_bound_region(br, counter)
 501                 }
 502                 _ => {}
 503             }
 504         }
 505
 506         ty.print(printer).unwrap().into_buffer()
 507     }
 508
 509     /// Returns the name of the provided `Ty` (that must be a reference)'s region with a
 510     /// synthesized lifetime name where required.
 511     pub(super) fn get_region_name_for_ty(&self, ty: Ty<'tcx>, counter: usize) -> String {
 512         let mut printer = ty::print::FmtPrinter::new(self.infcx.tcx, Namespace::TypeNS);
 513
 514         let region = if let ty::Ref(region, ..) = ty.kind() {
 515             match **region {
 516                 ty::ReLateBound(_, ty::BoundRegion { kind: br, .. })
 517                 | ty::RePlaceholder(ty::PlaceholderRegion { name: br, .. }) => {
 518                     printer.region_highlight_mode.highlighting_bound_region(br, counter)
 519                 }
 520                 _ => {}
 521             }
 522             region
 523         } else {
 524             bug!("ty for annotation of borrow region is not a reference");
 525         };
 526
 527         region.print(printer).unwrap().into_buffer()
 528     }
 529 }
 530
 531 /// The span(s) associated to a use of a place.
 532 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
 533 pub(super) enum UseSpans<'tcx> {
 534     /// The access is caused by capturing a variable for a closure.
 535     ClosureUse {
 536         /// This is true if the captured variable was from a generator.
 537         generator_kind: Option<GeneratorKind>,
 538         /// The span of the args of the closure, including the `move` keyword if
 539         /// it's present.
 540         args_span: Span,
 541         /// The span of the use resulting in capture kind
 542         /// Check `ty::CaptureInfo` for more details
 543         capture_kind_span: Span,
 544         /// The span of the use resulting in the captured path
 545         /// Check `ty::CaptureInfo` for more details
 546         path_span: Span,
 547     },
 548     /// The access is caused by using a variable as the receiver of a method
 549     /// that takes 'self'
 550     FnSelfUse {
 551         /// The span of the variable being moved
 552         var_span: Span,
 553         /// The span of the method call on the variable
 554         fn_call_span: Span,
 555         /// The definition span of the method being called
 556         fn_span: Span,
 557         kind: CallKind<'tcx>,
 558     },
 559     /// This access is caused by a `match` or `if let` pattern.
 560     PatUse(Span),
 561     /// This access has a single span associated to it: common case.
 562     OtherUse(Span),
 563 }
 564
 565 impl UseSpans<'_> {
 566     pub(super) fn args_or_use(self) -> Span {
 567         match self {
 568             UseSpans::ClosureUse { args_span: span, .. }
 569             | UseSpans::PatUse(span)
 570             | UseSpans::OtherUse(span) => span,
 571             UseSpans::FnSelfUse { fn_call_span, kind: CallKind::DerefCoercion { .. }, .. } => {
 572                 fn_call_span
 573             }
 574             UseSpans::FnSelfUse { var_span, .. } => var_span,
 575         }
 576     }
 577
 578     /// Returns the span of `self`, in the case of a `ClosureUse` returns the `path_span`
 579     pub(super) fn var_or_use_path_span(self) -> Span {
 580         match self {
 581             UseSpans::ClosureUse { path_span: span, .. }
 582             | UseSpans::PatUse(span)
 583             | UseSpans::OtherUse(span) => span,
 584             UseSpans::FnSelfUse { fn_call_span, kind: CallKind::DerefCoercion { .. }, .. } => {
 585                 fn_call_span
 586             }
 587             UseSpans::FnSelfUse { var_span, .. } => var_span,
 588         }
 589     }
 590
 591     /// Returns the span of `self`, in the case of a `ClosureUse` returns the `capture_kind_span`
 592     pub(super) fn var_or_use(self) -> Span {
 593         match self {
 594             UseSpans::ClosureUse { capture_kind_span: span, .. }
 595             | UseSpans::PatUse(span)
 596             | UseSpans::OtherUse(span) => span,
 597             UseSpans::FnSelfUse { fn_call_span, kind: CallKind::DerefCoercion { .. }, .. } => {
 598                 fn_call_span
 599             }
 600             UseSpans::FnSelfUse { var_span, .. } => var_span,
 601         }
 602     }
 603
 604     pub(super) fn generator_kind(self) -> Option<GeneratorKind> {
 605         match self {
 606             UseSpans::ClosureUse { generator_kind, .. } => generator_kind,
 607             _ => None,
 608         }
 609     }
 610
 611     // Add a span label to the arguments of the closure, if it exists.
 612     pub(super) fn args_span_label(self, err: &mut Diagnostic, message: impl Into<String>) {
 613         if let UseSpans::ClosureUse { args_span, .. } = self {
 614             err.span_label(args_span, message);
 615         }
 616     }
 617
 618     // Add a span label to the use of the captured variable, if it exists.
 619     // only adds label to the `path_span`
 620     pub(super) fn var_span_label_path_only(self, err: &mut Diagnostic, message: impl Into<String>) {
 621         if let UseSpans::ClosureUse { path_span, .. } = self {
 622             err.span_label(path_span, message);
 623         }
 624     }
 625
 626     // Add a span label to the use of the captured variable, if it exists.
 627     pub(super) fn var_span_label(
 628         self,
 629         err: &mut Diagnostic,
 630         message: impl Into<String>,
 631         kind_desc: impl Into<String>,
 632     ) {
 633         if let UseSpans::ClosureUse { capture_kind_span, path_span, .. } = self {
 634             if capture_kind_span == path_span {
 635                 err.span_label(capture_kind_span, message);
 636             } else {
 637                 let capture_kind_label =
 638                     format!("capture is {} because of use here", kind_desc.into());
 639                 let path_label = message;
 640                 err.span_label(capture_kind_span, capture_kind_label);
 641                 err.span_label(path_span, path_label);
 642             }
 643         }
 644     }
 645
 646     /// Returns `false` if this place is not used in a closure.
 647     pub(super) fn for_closure(&self) -> bool {
 648         match *self {
 649             UseSpans::ClosureUse { generator_kind, .. } => generator_kind.is_none(),
 650             _ => false,
 651         }
 652     }
 653
 654     /// Returns `false` if this place is not used in a generator.
 655     pub(super) fn for_generator(&self) -> bool {
 656         match *self {
 657             UseSpans::ClosureUse { generator_kind, .. } => generator_kind.is_some(),
 658             _ => false,
 659         }
 660     }
 661
 662     /// Describe the span associated with a use of a place.
 663     pub(super) fn describe(&self) -> String {
 664         match *self {
 665             UseSpans::ClosureUse { generator_kind, .. } => {
 666                 if generator_kind.is_some() {
 667                     " in generator".to_string()
 668                 } else {
 669                     " in closure".to_string()
 670                 }
 671             }
 672             _ => String::new(),
 673         }
 674     }
 675
 676     pub(super) fn or_else<F>(self, if_other: F) -> Self
 677     where
 678         F: FnOnce() -> Self,
 679     {
 680         match self {
 681             closure @ UseSpans::ClosureUse { .. } => closure,
 682             UseSpans::PatUse(_) | UseSpans::OtherUse(_) => if_other(),
 683             fn_self @ UseSpans::FnSelfUse { .. } => fn_self,
 684         }
 685     }
 686 }
 687
 688 pub(super) enum BorrowedContentSource<'tcx> {
 689     DerefRawPointer,
 690     DerefMutableRef,
 691     DerefSharedRef,
 692     OverloadedDeref(Ty<'tcx>),
 693     OverloadedIndex(Ty<'tcx>),
 694 }
 695
 696 impl<'tcx> BorrowedContentSource<'tcx> {
 697     pub(super) fn describe_for_unnamed_place(&self, tcx: TyCtxt<'_>) -> String {
 698         match *self {
 699             BorrowedContentSource::DerefRawPointer => "a raw pointer".to_string(),
 700             BorrowedContentSource::DerefSharedRef => "a shared reference".to_string(),
 701             BorrowedContentSource::DerefMutableRef => "a mutable reference".to_string(),
 702             BorrowedContentSource::OverloadedDeref(ty) => ty
 703                 .ty_adt_def()
 704                 .and_then(|adt| match tcx.get_diagnostic_name(adt.did)? {
 705                     name @ (sym::Rc | sym::Arc) => Some(format!("an `{}`", name)),
 706                     _ => None,
 707                 })
 708                 .unwrap_or_else(|| format!("dereference of `{}`", ty)),
 709             BorrowedContentSource::OverloadedIndex(ty) => format!("index of `{}`", ty),
 710         }
 711     }
 712
 713     pub(super) fn describe_for_named_place(&self) -> Option<&'static str> {
 714         match *self {
 715             BorrowedContentSource::DerefRawPointer => Some("raw pointer"),
 716             BorrowedContentSource::DerefSharedRef => Some("shared reference"),
 717             BorrowedContentSource::DerefMutableRef => Some("mutable reference"),
 718             // Overloaded deref and index operators should be evaluated into a
 719             // temporary. So we don't need a description here.
 720             BorrowedContentSource::OverloadedDeref(_)
 721             | BorrowedContentSource::OverloadedIndex(_) => None,
 722         }
 723     }
 724
 725     pub(super) fn describe_for_immutable_place(&self, tcx: TyCtxt<'_>) -> String {
 726         match *self {
 727             BorrowedContentSource::DerefRawPointer => "a `*const` pointer".to_string(),
 728             BorrowedContentSource::DerefSharedRef => "a `&` reference".to_string(),
 729             BorrowedContentSource::DerefMutableRef => {
 730                 bug!("describe_for_immutable_place: DerefMutableRef isn't immutable")
 731             }
 732             BorrowedContentSource::OverloadedDeref(ty) => ty
 733                 .ty_adt_def()
 734                 .and_then(|adt| match tcx.get_diagnostic_name(adt.did)? {
 735                     name @ (sym::Rc | sym::Arc) => Some(format!("an `{}`", name)),
 736                     _ => None,
 737                 })
 738                 .unwrap_or_else(|| format!("dereference of `{}`", ty)),
 739             BorrowedContentSource::OverloadedIndex(ty) => format!("an index of `{}`", ty),
 740         }
 741     }
 742
 743     fn from_call(func: Ty<'tcx>, tcx: TyCtxt<'tcx>) -> Option<Self> {
 744         match *func.kind() {
 745             ty::FnDef(def_id, substs) => {
 746                 let trait_id = tcx.trait_of_item(def_id)?;
 747
 748                 let lang_items = tcx.lang_items();
 749                 if Some(trait_id) == lang_items.deref_trait()
 750                     || Some(trait_id) == lang_items.deref_mut_trait()
 751                 {
 752                     Some(BorrowedContentSource::OverloadedDeref(substs.type_at(0)))
 753                 } else if Some(trait_id) == lang_items.index_trait()
 754                     || Some(trait_id) == lang_items.index_mut_trait()
 755                 {
 756                     Some(BorrowedContentSource::OverloadedIndex(substs.type_at(0)))
 757                 } else {
 758                     None
 759                 }
 760             }
 761             _ => None,
 762         }
 763     }
 764 }
 765
 766 impl<'cx, 'tcx> MirBorrowckCtxt<'cx, 'tcx> {
 767     /// Finds the spans associated to a move or copy of move_place at location.
 768     pub(super) fn move_spans(
 769         &self,
 770         moved_place: PlaceRef<'tcx>, // Could also be an upvar.
 771         location: Location,
 772     ) -> UseSpans<'tcx> {
 773         use self::UseSpans::*;
 774
 775         let Some(stmt) = self.body[location.block].statements.get(location.statement_index) else {
 776             return OtherUse(self.body.source_info(location).span);
 777         };
 778
 779         debug!("move_spans: moved_place={:?} location={:?} stmt={:?}", moved_place, location, stmt);
 780         if let StatementKind::Assign(box (_, Rvalue::Aggregate(ref kind, ref places))) = stmt.kind {
 781             match kind {
 782                 box AggregateKind::Closure(def_id, _)
 783                 | box AggregateKind::Generator(def_id, _, _) => {
 784                     debug!("move_spans: def_id={:?} places={:?}", def_id, places);
 785                     if let Some((args_span, generator_kind, capture_kind_span, path_span)) =
 786                         self.closure_span(*def_id, moved_place, places)
 787                     {
 788                         return ClosureUse {
 789                             generator_kind,
 790                             args_span,
 791                             capture_kind_span,
 792                             path_span,
 793                         };
 794                     }
 795                 }
 796                 _ => {}
 797             }
 798         }
 799
 800         // StatementKind::FakeRead only contains a def_id if they are introduced as a result
 801         // of pattern matching within a closure.
 802         if let StatementKind::FakeRead(box (cause, ref place)) = stmt.kind {
 803             match cause {
 804                 FakeReadCause::ForMatchedPlace(Some(closure_def_id))
 805                 | FakeReadCause::ForLet(Some(closure_def_id)) => {
 806                     debug!("move_spans: def_id={:?} place={:?}", closure_def_id, place);
 807                     let places = &[Operand::Move(*place)];
 808                     if let Some((args_span, generator_kind, capture_kind_span, path_span)) =
 809                         self.closure_span(closure_def_id, moved_place, places)
 810                     {
 811                         return ClosureUse {
 812                             generator_kind,
 813                             args_span,
 814                             capture_kind_span,
 815                             path_span,
 816                         };
 817                     }
 818                 }
 819                 _ => {}
 820             }
 821         }
 822
 823         let normal_ret =
 824             if moved_place.projection.iter().any(|p| matches!(p, ProjectionElem::Downcast(..))) {
 825                 PatUse(stmt.source_info.span)
 826             } else {
 827                 OtherUse(stmt.source_info.span)
 828             };
 829
 830         // We are trying to find MIR of the form:
 831         // ```
 832         // _temp = _moved_val;
 833         // ...
 834         // FnSelfCall(_temp, ...)
 835         // ```
 836         //
 837         // where `_moved_val` is the place we generated the move error for,
 838         // `_temp` is some other local, and `FnSelfCall` is a function
 839         // that has a `self` parameter.
 840
 841         let target_temp = match stmt.kind {
 842             StatementKind::Assign(box (temp, _)) if temp.as_local().is_some() => {
 843                 temp.as_local().unwrap()
 844             }
 845             _ => return normal_ret,
 846         };
 847
 848         debug!("move_spans: target_temp = {:?}", target_temp);
 849
 850         if let Some(Terminator {
 851             kind: TerminatorKind::Call { fn_span, from_hir_call, .. }, ..
 852         }) = &self.body[location.block].terminator
 853         {
 854             let Some((method_did, method_substs)) =
 855                 rustc_const_eval::util::find_self_call(
 856                     self.infcx.tcx,
 857                     &self.body,
 858                     target_temp,
 859                     location.block,
 860                 )
 861             else {
 862                 return normal_ret;
 863             };
 864
 865             let kind = call_kind(
 866                 self.infcx.tcx,
 867                 self.param_env,
 868                 method_did,
 869                 method_substs,
 870                 *fn_span,
 871                 *from_hir_call,
 872                 Some(self.infcx.tcx.fn_arg_names(method_did)[0]),
 873             );
 874
 875             return FnSelfUse {
 876                 var_span: stmt.source_info.span,
 877                 fn_call_span: *fn_span,
 878                 fn_span: self
 879                     .infcx
 880                     .tcx
 881                     .sess
 882                     .source_map()
 883                     .guess_head_span(self.infcx.tcx.def_span(method_did)),
 884                 kind,
 885             };
 886         }
 887         normal_ret
 888     }
 889
 890     /// Finds the span of arguments of a closure (within `maybe_closure_span`)
 891     /// and its usage of the local assigned at `location`.
 892     /// This is done by searching in statements succeeding `location`
 893     /// and originating from `maybe_closure_span`.
 894     pub(super) fn borrow_spans(&self, use_span: Span, location: Location) -> UseSpans<'tcx> {
 895         use self::UseSpans::*;
 896         debug!("borrow_spans: use_span={:?} location={:?}", use_span, location);
 897
 898         let target = match self.body[location.block].statements.get(location.statement_index) {
 899             Some(&Statement { kind: StatementKind::Assign(box (ref place, _)), .. }) => {
 900                 if let Some(local) = place.as_local() {
 901                     local
 902                 } else {
 903                     return OtherUse(use_span);
 904                 }
 905             }
 906             _ => return OtherUse(use_span),
 907         };
 908
 909         if self.body.local_kind(target) != LocalKind::Temp {
 910             // operands are always temporaries.
 911             return OtherUse(use_span);
 912         }
 913
 914         for stmt in &self.body[location.block].statements[location.statement_index + 1..] {
 915             if let StatementKind::Assign(box (_, Rvalue::Aggregate(ref kind, ref places))) =
 916                 stmt.kind
 917             {
 918                 let (def_id, is_generator) = match kind {
 919                     box AggregateKind::Closure(def_id, _) => (def_id, false),
 920                     box AggregateKind::Generator(def_id, _, _) => (def_id, true),
 921                     _ => continue,
 922                 };
 923
 924                 debug!(
 925                     "borrow_spans: def_id={:?} is_generator={:?} places={:?}",
 926                     def_id, is_generator, places
 927                 );
 928                 if let Some((args_span, generator_kind, capture_kind_span, path_span)) =
 929                     self.closure_span(*def_id, Place::from(target).as_ref(), places)
 930                 {
 931                     return ClosureUse { generator_kind, args_span, capture_kind_span, path_span };
 932                 } else {
 933                     return OtherUse(use_span);
 934                 }
 935             }
 936
 937             if use_span != stmt.source_info.span {
 938                 break;
 939             }
 940         }
 941
 942         OtherUse(use_span)
 943     }
 944
 945     /// Finds the spans of a captured place within a closure or generator.
 946     /// The first span is the location of the use resulting in the capture kind of the capture
 947     /// The second span is the location the use resulting in the captured path of the capture
 948     fn closure_span(
 949         &self,
 950         def_id: DefId,
 951         target_place: PlaceRef<'tcx>,
 952         places: &[Operand<'tcx>],
 953     ) -> Option<(Span, Option<GeneratorKind>, Span, Span)> {
 954         debug!(
 955             "closure_span: def_id={:?} target_place={:?} places={:?}",
 956             def_id, target_place, places
 957         );
 958         let local_did = def_id.as_local()?;
 959         let hir_id = self.infcx.tcx.hir().local_def_id_to_hir_id(local_did);
 960         let expr = &self.infcx.tcx.hir().expect_expr(hir_id).kind;
 961         debug!("closure_span: hir_id={:?} expr={:?}", hir_id, expr);
 962         if let hir::ExprKind::Closure(.., body_id, args_span, _) = expr {
 963             for (captured_place, place) in self
 964                 .infcx
 965                 .tcx
 966                 .typeck(def_id.expect_local())
 967                 .closure_min_captures_flattened(def_id)
 968                 .zip(places)
 969             {
 970                 match place {
 971                     Operand::Copy(place) | Operand::Move(place)
 972                         if target_place == place.as_ref() =>
 973                     {
 974                         debug!("closure_span: found captured local {:?}", place);
 975                         let body = self.infcx.tcx.hir().body(*body_id);
 976                         let generator_kind = body.generator_kind();
 977
 978                         return Some((
 979                             *args_span,
 980                             generator_kind,
 981                             captured_place.get_capture_kind_span(self.infcx.tcx),
 982                             captured_place.get_path_span(self.infcx.tcx),
 983                         ));
 984                     }
 985                     _ => {}
 986                 }
 987             }
 988         }
 989         None
 990     }
 991
 992     /// Helper to retrieve span(s) of given borrow from the current MIR
 993     /// representation
 994     pub(super) fn retrieve_borrow_spans(&self, borrow: &BorrowData<'_>) -> UseSpans<'tcx> {
 995         let span = self.body.source_info(borrow.reserve_location).span;
 996         self.borrow_spans(span, borrow.reserve_location)
 997     }
 998 }