compiler/rustc_borrowck/src/type_check/mod.rs

   1 #![deny(rustc::untranslatable_diagnostic)]
   2 #![deny(rustc::diagnostic_outside_of_impl)]
   3 //! This pass type-checks the MIR to ensure it is not broken.
   4
   5 use std::rc::Rc;
   6 use std::{fmt, iter, mem};
   7
   8 use either::Either;
   9
  10 use hir::OpaqueTyOrigin;
  11 use rustc_data_structures::frozen::Frozen;
  12 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  13 use rustc_data_structures::vec_map::VecMap;
  14 use rustc_hir as hir;
  15 use rustc_hir::def::DefKind;
  16 use rustc_hir::def_id::LocalDefId;
  17 use rustc_hir::lang_items::LangItem;
  18 use rustc_index::vec::{Idx, IndexVec};
  19 use rustc_infer::infer::canonical::QueryRegionConstraints;
  20 use rustc_infer::infer::outlives::env::RegionBoundPairs;
  21 use rustc_infer::infer::region_constraints::RegionConstraintData;
  22 use rustc_infer::infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
  23 use rustc_infer::infer::{
  24     InferCtxt, InferOk, LateBoundRegion, LateBoundRegionConversionTime, NllRegionVariableOrigin,
  25 };
  26 use rustc_middle::mir::tcx::PlaceTy;
  27 use rustc_middle::mir::visit::{NonMutatingUseContext, PlaceContext, Visitor};
  28 use rustc_middle::mir::AssertKind;
  29 use rustc_middle::mir::*;
  30 use rustc_middle::ty::adjustment::PointerCast;
  31 use rustc_middle::ty::cast::CastTy;
  32 use rustc_middle::ty::subst::{SubstsRef, UserSubsts};
  33 use rustc_middle::ty::visit::TypeVisitable;
  34 use rustc_middle::ty::{
  35     self, Binder, CanonicalUserTypeAnnotation, CanonicalUserTypeAnnotations, Dynamic,
  36     OpaqueHiddenType, OpaqueTypeKey, RegionVid, Ty, TyCtxt, UserType, UserTypeAnnotationIndex,
  37 };
  38 use rustc_span::def_id::CRATE_DEF_ID;
  39 use rustc_span::{Span, DUMMY_SP};
  40 use rustc_target::abi::VariantIdx;
  41 use rustc_trait_selection::traits::query::type_op;
  42 use rustc_trait_selection::traits::query::type_op::custom::scrape_region_constraints;
  43 use rustc_trait_selection::traits::query::type_op::custom::CustomTypeOp;
  44 use rustc_trait_selection::traits::query::type_op::{TypeOp, TypeOpOutput};
  45 use rustc_trait_selection::traits::query::Fallible;
  46 use rustc_trait_selection::traits::PredicateObligation;
  47
  48 use rustc_mir_dataflow::impls::MaybeInitializedPlaces;
  49 use rustc_mir_dataflow::move_paths::MoveData;
  50 use rustc_mir_dataflow::ResultsCursor;
  51
  52 use crate::session_diagnostics::MoveUnsized;
  53 use crate::{
  54     borrow_set::BorrowSet,
  55     constraints::{OutlivesConstraint, OutlivesConstraintSet},
  56     diagnostics::UniverseInfo,
  57     facts::AllFacts,
  58     location::LocationTable,
  59     member_constraints::MemberConstraintSet,
  60     nll::ToRegionVid,
  61     path_utils,
  62     region_infer::values::{
  63         LivenessValues, PlaceholderIndex, PlaceholderIndices, RegionValueElements,
  64     },
  65     region_infer::TypeTest,
  66     type_check::free_region_relations::{CreateResult, UniversalRegionRelations},
  67     universal_regions::{DefiningTy, UniversalRegions},
  68     Upvar,
  69 };
  70
  71 macro_rules! span_mirbug {
  72     ($context:expr, $elem:expr, $($message:tt)*) => ({
  73         $crate::type_check::mirbug(
  74             $context.tcx(),
  75             $context.last_span,
  76             &format!(
  77                 "broken MIR in {:?} ({:?}): {}",
  78                 $context.body().source.def_id(),
  79                 $elem,
  80                 format_args!($($message)*),
  81             ),
  82         )
  83     })
  84 }
  85
  86 macro_rules! span_mirbug_and_err {
  87     ($context:expr, $elem:expr, $($message:tt)*) => ({
  88         {
  89             span_mirbug!($context, $elem, $($message)*);
  90             $context.error()
  91         }
  92     })
  93 }
  94
  95 mod canonical;
  96 mod constraint_conversion;
  97 pub mod free_region_relations;
  98 mod input_output;
  99 pub(crate) mod liveness;
 100 mod relate_tys;
 101
 102 /// Type checks the given `mir` in the context of the inference
 103 /// context `infcx`. Returns any region constraints that have yet to
 104 /// be proven. This result includes liveness constraints that
 105 /// ensure that regions appearing in the types of all local variables
 106 /// are live at all points where that local variable may later be
 107 /// used.
 108 ///
 109 /// This phase of type-check ought to be infallible -- this is because
 110 /// the original, HIR-based type-check succeeded. So if any errors
 111 /// occur here, we will get a `bug!` reported.
 112 ///
 113 /// # Parameters
 114 ///
 115 /// - `infcx` -- inference context to use
 116 /// - `param_env` -- parameter environment to use for trait solving
 117 /// - `body` -- MIR body to type-check
 118 /// - `promoted` -- map of promoted constants within `body`
 119 /// - `universal_regions` -- the universal regions from `body`s function signature
 120 /// - `location_table` -- MIR location map of `body`
 121 /// - `borrow_set` -- information about borrows occurring in `body`
 122 /// - `all_facts` -- when using Polonius, this is the generated set of Polonius facts
 123 /// - `flow_inits` -- results of a maybe-init dataflow analysis
 124 /// - `move_data` -- move-data constructed when performing the maybe-init dataflow analysis
 125 /// - `elements` -- MIR region map
 126 pub(crate) fn type_check<'mir, 'tcx>(
 127     infcx: &InferCtxt<'tcx>,
 128     param_env: ty::ParamEnv<'tcx>,
 129     body: &Body<'tcx>,
 130     promoted: &IndexVec<Promoted, Body<'tcx>>,
 131     universal_regions: &Rc<UniversalRegions<'tcx>>,
 132     location_table: &LocationTable,
 133     borrow_set: &BorrowSet<'tcx>,
 134     all_facts: &mut Option<AllFacts>,
 135     flow_inits: &mut ResultsCursor<'mir, 'tcx, MaybeInitializedPlaces<'mir, 'tcx>>,
 136     move_data: &MoveData<'tcx>,
 137     elements: &Rc<RegionValueElements>,
 138     upvars: &[Upvar<'tcx>],
 139     use_polonius: bool,
 140 ) -> MirTypeckResults<'tcx> {
 141     let implicit_region_bound = infcx.tcx.mk_region(ty::ReVar(universal_regions.fr_fn_body));
 142     let mut constraints = MirTypeckRegionConstraints {
 143         placeholder_indices: PlaceholderIndices::default(),
 144         placeholder_index_to_region: IndexVec::default(),
 145         liveness_constraints: LivenessValues::new(elements.clone()),
 146         outlives_constraints: OutlivesConstraintSet::default(),
 147         member_constraints: MemberConstraintSet::default(),
 148         type_tests: Vec::default(),
 149         universe_causes: FxHashMap::default(),
 150     };
 151
 152     let CreateResult {
 153         universal_region_relations,
 154         region_bound_pairs,
 155         normalized_inputs_and_output,
 156     } = free_region_relations::create(
 157         infcx,
 158         param_env,
 159         implicit_region_bound,
 160         universal_regions,
 161         &mut constraints,
 162     );
 163
 164     debug!(?normalized_inputs_and_output);
 165
 166     for u in ty::UniverseIndex::ROOT..=infcx.universe() {
 167         constraints.universe_causes.insert(u, UniverseInfo::other());
 168     }
 169
 170     let mut borrowck_context = BorrowCheckContext {
 171         universal_regions,
 172         location_table,
 173         borrow_set,
 174         all_facts,
 175         constraints: &mut constraints,
 176         upvars,
 177     };
 178
 179     let mut checker = TypeChecker::new(
 180         infcx,
 181         body,
 182         param_env,
 183         &region_bound_pairs,
 184         implicit_region_bound,
 185         &mut borrowck_context,
 186     );
 187
 188     let errors_reported = {
 189         let mut verifier = TypeVerifier::new(&mut checker, promoted);
 190         verifier.visit_body(&body);
 191         verifier.errors_reported
 192     };
 193
 194     if !errors_reported {
 195         // if verifier failed, don't do further checks to avoid ICEs
 196         checker.typeck_mir(body);
 197     }
 198
 199     checker.equate_inputs_and_outputs(&body, universal_regions, &normalized_inputs_and_output);
 200     liveness::generate(
 201         &mut checker,
 202         body,
 203         elements,
 204         flow_inits,
 205         move_data,
 206         location_table,
 207         use_polonius,
 208     );
 209
 210     translate_outlives_facts(&mut checker);
 211     let opaque_type_values = infcx.inner.borrow_mut().opaque_type_storage.take_opaque_types();
 212
 213     let opaque_type_values = opaque_type_values
 214         .into_iter()
 215         .map(|(opaque_type_key, decl)| {
 216             checker
 217                 .fully_perform_op(
 218                     Locations::All(body.span),
 219                     ConstraintCategory::OpaqueType,
 220                     CustomTypeOp::new(
 221                         |infcx| {
 222                             infcx.register_member_constraints(
 223                                 param_env,
 224                                 opaque_type_key,
 225                                 decl.hidden_type.ty,
 226                                 decl.hidden_type.span,
 227                             );
 228                             Ok(InferOk { value: (), obligations: vec![] })
 229                         },
 230                         || "opaque_type_map".to_string(),
 231                     ),
 232                 )
 233                 .unwrap();
 234             let mut hidden_type = infcx.resolve_vars_if_possible(decl.hidden_type);
 235             trace!("finalized opaque type {:?} to {:#?}", opaque_type_key, hidden_type.ty.kind());
 236             if hidden_type.has_non_region_infer() {
 237                 let reported = infcx.tcx.sess.delay_span_bug(
 238                     decl.hidden_type.span,
 239                     &format!("could not resolve {:#?}", hidden_type.ty.kind()),
 240                 );
 241                 hidden_type.ty = infcx.tcx.ty_error_with_guaranteed(reported);
 242             }
 243
 244             (opaque_type_key, (hidden_type, decl.origin))
 245         })
 246         .collect();
 247
 248     MirTypeckResults { constraints, universal_region_relations, opaque_type_values }
 249 }
 250
 251 fn translate_outlives_facts(typeck: &mut TypeChecker<'_, '_>) {
 252     let cx = &mut typeck.borrowck_context;
 253     if let Some(facts) = cx.all_facts {
 254         let _prof_timer = typeck.infcx.tcx.prof.generic_activity("polonius_fact_generation");
 255         let location_table = cx.location_table;
 256         facts.subset_base.extend(cx.constraints.outlives_constraints.outlives().iter().flat_map(
 257             |constraint: &OutlivesConstraint<'_>| {
 258                 if let Some(from_location) = constraint.locations.from_location() {
 259                     Either::Left(iter::once((
 260                         constraint.sup,
 261                         constraint.sub,
 262                         location_table.mid_index(from_location),
 263                     )))
 264                 } else {
 265                     Either::Right(
 266                         location_table
 267                             .all_points()
 268                             .map(move |location| (constraint.sup, constraint.sub, location)),
 269                     )
 270                 }
 271             },
 272         ));
 273     }
 274 }
 275
 276 #[track_caller]
 277 fn mirbug(tcx: TyCtxt<'_>, span: Span, msg: &str) {
 278     // We sometimes see MIR failures (notably predicate failures) due to
 279     // the fact that we check rvalue sized predicates here. So use `delay_span_bug`
 280     // to avoid reporting bugs in those cases.
 281     tcx.sess.diagnostic().delay_span_bug(span, msg);
 282 }
 283
 284 enum FieldAccessError {
 285     OutOfRange { field_count: usize },
 286 }
 287
 288 /// Verifies that MIR types are sane to not crash further checks.
 289 ///
 290 /// The sanitize_XYZ methods here take an MIR object and compute its
 291 /// type, calling `span_mirbug` and returning an error type if there
 292 /// is a problem.
 293 struct TypeVerifier<'a, 'b, 'tcx> {
 294     cx: &'a mut TypeChecker<'b, 'tcx>,
 295     promoted: &'b IndexVec<Promoted, Body<'tcx>>,
 296     last_span: Span,
 297     errors_reported: bool,
 298 }
 299
 300 impl<'a, 'b, 'tcx> Visitor<'tcx> for TypeVerifier<'a, 'b, 'tcx> {
 301     fn visit_span(&mut self, span: Span) {
 302         if !span.is_dummy() {
 303             self.last_span = span;
 304         }
 305     }
 306
 307     fn visit_place(&mut self, place: &Place<'tcx>, context: PlaceContext, location: Location) {
 308         self.sanitize_place(place, location, context);
 309     }
 310
 311     fn visit_constant(&mut self, constant: &Constant<'tcx>, location: Location) {
 312         debug!(?constant, ?location, "visit_constant");
 313
 314         self.super_constant(constant, location);
 315         let ty = self.sanitize_type(constant, constant.literal.ty());
 316
 317         self.cx.infcx.tcx.for_each_free_region(&ty, |live_region| {
 318             let live_region_vid =
 319                 self.cx.borrowck_context.universal_regions.to_region_vid(live_region);
 320             self.cx
 321                 .borrowck_context
 322                 .constraints
 323                 .liveness_constraints
 324                 .add_element(live_region_vid, location);
 325         });
 326
 327         // HACK(compiler-errors): Constants that are gathered into Body.required_consts
 328         // have their locations erased...
 329         let locations = if location != Location::START {
 330             location.to_locations()
 331         } else {
 332             Locations::All(constant.span)
 333         };
 334
 335         if let Some(annotation_index) = constant.user_ty {
 336             if let Err(terr) = self.cx.relate_type_and_user_type(
 337                 constant.literal.ty(),
 338                 ty::Variance::Invariant,
 339                 &UserTypeProjection { base: annotation_index, projs: vec![] },
 340                 locations,
 341                 ConstraintCategory::Boring,
 342             ) {
 343                 let annotation = &self.cx.user_type_annotations[annotation_index];
 344                 span_mirbug!(
 345                     self,
 346                     constant,
 347                     "bad constant user type {:?} vs {:?}: {:?}",
 348                     annotation,
 349                     constant.literal.ty(),
 350                     terr,
 351                 );
 352             }
 353         } else {
 354             let tcx = self.tcx();
 355             let maybe_uneval = match constant.literal {
 356                 ConstantKind::Ty(ct) => match ct.kind() {
 357                     ty::ConstKind::Unevaluated(_) => {
 358                         bug!("should not encounter unevaluated ConstantKind::Ty here, got {:?}", ct)
 359                     }
 360                     _ => None,
 361                 },
 362                 ConstantKind::Unevaluated(uv, _) => Some(uv),
 363                 _ => None,
 364             };
 365
 366             if let Some(uv) = maybe_uneval {
 367                 if let Some(promoted) = uv.promoted {
 368                     let check_err = |verifier: &mut TypeVerifier<'a, 'b, 'tcx>,
 369                                      promoted: &Body<'tcx>,
 370                                      ty,
 371                                      san_ty| {
 372                         if let Err(terr) =
 373                             verifier.cx.eq_types(ty, san_ty, locations, ConstraintCategory::Boring)
 374                         {
 375                             span_mirbug!(
 376                                 verifier,
 377                                 promoted,
 378                                 "bad promoted type ({:?}: {:?}): {:?}",
 379                                 ty,
 380                                 san_ty,
 381                                 terr
 382                             );
 383                         };
 384                     };
 385
 386                     if !self.errors_reported {
 387                         let promoted_body = &self.promoted[promoted];
 388                         self.sanitize_promoted(promoted_body, location);
 389
 390                         let promoted_ty = promoted_body.return_ty();
 391                         check_err(self, promoted_body, ty, promoted_ty);
 392                     }
 393                 } else {
 394                     if let Err(terr) = self.cx.fully_perform_op(
 395                         locations,
 396                         ConstraintCategory::Boring,
 397                         self.cx.param_env.and(type_op::ascribe_user_type::AscribeUserType::new(
 398                             constant.literal.ty(),
 399                             uv.def.did,
 400                             UserSubsts { substs: uv.substs, user_self_ty: None },
 401                         )),
 402                     ) {
 403                         span_mirbug!(
 404                             self,
 405                             constant,
 406                             "bad constant type {:?} ({:?})",
 407                             constant,
 408                             terr
 409                         );
 410                     }
 411                 }
 412             } else if let Some(static_def_id) = constant.check_static_ptr(tcx) {
 413                 let unnormalized_ty = tcx.type_of(static_def_id);
 414                 let normalized_ty = self.cx.normalize(unnormalized_ty, locations);
 415                 let literal_ty = constant.literal.ty().builtin_deref(true).unwrap().ty;
 416
 417                 if let Err(terr) = self.cx.eq_types(
 418                     literal_ty,
 419                     normalized_ty,
 420                     locations,
 421                     ConstraintCategory::Boring,
 422                 ) {
 423                     span_mirbug!(self, constant, "bad static type {:?} ({:?})", constant, terr);
 424                 }
 425             }
 426
 427             if let ty::FnDef(def_id, substs) = *constant.literal.ty().kind() {
 428                 // const_trait_impl: use a non-const param env when checking that a FnDef type is well formed.
 429                 // this is because the well-formedness of the function does not need to be proved to have `const`
 430                 // impls for trait bounds.
 431                 let instantiated_predicates = tcx.predicates_of(def_id).instantiate(tcx, substs);
 432                 let prev = self.cx.param_env;
 433                 self.cx.param_env = prev.without_const();
 434                 self.cx.normalize_and_prove_instantiated_predicates(
 435                     def_id,
 436                     instantiated_predicates,
 437                     locations,
 438                 );
 439                 self.cx.param_env = prev;
 440             }
 441         }
 442     }
 443
 444     fn visit_rvalue(&mut self, rvalue: &Rvalue<'tcx>, location: Location) {
 445         self.super_rvalue(rvalue, location);
 446         let rval_ty = rvalue.ty(self.body(), self.tcx());
 447         self.sanitize_type(rvalue, rval_ty);
 448     }
 449
 450     fn visit_local_decl(&mut self, local: Local, local_decl: &LocalDecl<'tcx>) {
 451         self.super_local_decl(local, local_decl);
 452         self.sanitize_type(local_decl, local_decl.ty);
 453
 454         if let Some(user_ty) = &local_decl.user_ty {
 455             for (user_ty, span) in user_ty.projections_and_spans() {
 456                 let ty = if !local_decl.is_nonref_binding() {
 457                     // If we have a binding of the form `let ref x: T = ..`
 458                     // then remove the outermost reference so we can check the
 459                     // type annotation for the remaining type.
 460                     if let ty::Ref(_, rty, _) = local_decl.ty.kind() {
 461                         *rty
 462                     } else {
 463                         bug!("{:?} with ref binding has wrong type {}", local, local_decl.ty);
 464                     }
 465                 } else {
 466                     local_decl.ty
 467                 };
 468
 469                 if let Err(terr) = self.cx.relate_type_and_user_type(
 470                     ty,
 471                     ty::Variance::Invariant,
 472                     user_ty,
 473                     Locations::All(*span),
 474                     ConstraintCategory::TypeAnnotation,
 475                 ) {
 476                     span_mirbug!(
 477                         self,
 478                         local,
 479                         "bad user type on variable {:?}: {:?} != {:?} ({:?})",
 480                         local,
 481                         local_decl.ty,
 482                         local_decl.user_ty,
 483                         terr,
 484                     );
 485                 }
 486             }
 487         }
 488     }
 489
 490     fn visit_body(&mut self, body: &Body<'tcx>) {
 491         self.sanitize_type(&"return type", body.return_ty());
 492         for local_decl in &body.local_decls {
 493             self.sanitize_type(local_decl, local_decl.ty);
 494         }
 495         if self.errors_reported {
 496             return;
 497         }
 498         self.super_body(body);
 499     }
 500 }
 501
 502 impl<'a, 'b, 'tcx> TypeVerifier<'a, 'b, 'tcx> {
 503     fn new(
 504         cx: &'a mut TypeChecker<'b, 'tcx>,
 505         promoted: &'b IndexVec<Promoted, Body<'tcx>>,
 506     ) -> Self {
 507         TypeVerifier { promoted, last_span: cx.body.span, cx, errors_reported: false }
 508     }
 509
 510     fn body(&self) -> &Body<'tcx> {
 511         self.cx.body
 512     }
 513
 514     fn tcx(&self) -> TyCtxt<'tcx> {
 515         self.cx.infcx.tcx
 516     }
 517
 518     fn sanitize_type(&mut self, parent: &dyn fmt::Debug, ty: Ty<'tcx>) -> Ty<'tcx> {
 519         if ty.has_escaping_bound_vars() || ty.references_error() {
 520             span_mirbug_and_err!(self, parent, "bad type {:?}", ty)
 521         } else {
 522             ty
 523         }
 524     }
 525
 526     /// Checks that the types internal to the `place` match up with
 527     /// what would be expected.
 528     fn sanitize_place(
 529         &mut self,
 530         place: &Place<'tcx>,
 531         location: Location,
 532         context: PlaceContext,
 533     ) -> PlaceTy<'tcx> {
 534         debug!("sanitize_place: {:?}", place);
 535
 536         let mut place_ty = PlaceTy::from_ty(self.body().local_decls[place.local].ty);
 537
 538         for elem in place.projection.iter() {
 539             if place_ty.variant_index.is_none() {
 540                 if place_ty.ty.references_error() {
 541                     assert!(self.errors_reported);
 542                     return PlaceTy::from_ty(self.tcx().ty_error());
 543                 }
 544             }
 545             place_ty = self.sanitize_projection(place_ty, elem, place, location);
 546         }
 547
 548         if let PlaceContext::NonMutatingUse(NonMutatingUseContext::Copy) = context {
 549             let tcx = self.tcx();
 550             let trait_ref = tcx.at(self.last_span).mk_trait_ref(LangItem::Copy, [place_ty.ty]);
 551
 552             // To have a `Copy` operand, the type `T` of the
 553             // value must be `Copy`. Note that we prove that `T: Copy`,
 554             // rather than using the `is_copy_modulo_regions`
 555             // test. This is important because
 556             // `is_copy_modulo_regions` ignores the resulting region
 557             // obligations and assumes they pass. This can result in
 558             // bounds from `Copy` impls being unsoundly ignored (e.g.,
 559             // #29149). Note that we decide to use `Copy` before knowing
 560             // whether the bounds fully apply: in effect, the rule is
 561             // that if a value of some type could implement `Copy`, then
 562             // it must.
 563             self.cx.prove_trait_ref(
 564                 trait_ref,
 565                 location.to_locations(),
 566                 ConstraintCategory::CopyBound,
 567             );
 568         }
 569
 570         place_ty
 571     }
 572
 573     fn sanitize_promoted(&mut self, promoted_body: &'b Body<'tcx>, location: Location) {
 574         // Determine the constraints from the promoted MIR by running the type
 575         // checker on the promoted MIR, then transfer the constraints back to
 576         // the main MIR, changing the locations to the provided location.
 577
 578         let parent_body = mem::replace(&mut self.cx.body, promoted_body);
 579
 580         // Use new sets of constraints and closure bounds so that we can
 581         // modify their locations.
 582         let all_facts = &mut None;
 583         let mut constraints = Default::default();
 584         let mut liveness_constraints =
 585             LivenessValues::new(Rc::new(RegionValueElements::new(&promoted_body)));
 586         // Don't try to add borrow_region facts for the promoted MIR
 587
 588         let mut swap_constraints = |this: &mut Self| {
 589             mem::swap(this.cx.borrowck_context.all_facts, all_facts);
 590             mem::swap(
 591                 &mut this.cx.borrowck_context.constraints.outlives_constraints,
 592                 &mut constraints,
 593             );
 594             mem::swap(
 595                 &mut this.cx.borrowck_context.constraints.liveness_constraints,
 596                 &mut liveness_constraints,
 597             );
 598         };
 599
 600         swap_constraints(self);
 601
 602         self.visit_body(&promoted_body);
 603
 604         if !self.errors_reported {
 605             // if verifier failed, don't do further checks to avoid ICEs
 606             self.cx.typeck_mir(promoted_body);
 607         }
 608
 609         self.cx.body = parent_body;
 610         // Merge the outlives constraints back in, at the given location.
 611         swap_constraints(self);
 612
 613         let locations = location.to_locations();
 614         for constraint in constraints.outlives().iter() {
 615             let mut constraint = constraint.clone();
 616             constraint.locations = locations;
 617             if let ConstraintCategory::Return(_)
 618             | ConstraintCategory::UseAsConst
 619             | ConstraintCategory::UseAsStatic = constraint.category
 620             {
 621                 // "Returning" from a promoted is an assignment to a
 622                 // temporary from the user's point of view.
 623                 constraint.category = ConstraintCategory::Boring;
 624             }
 625             self.cx.borrowck_context.constraints.outlives_constraints.push(constraint)
 626         }
 627         for region in liveness_constraints.rows() {
 628             // If the region is live at at least one location in the promoted MIR,
 629             // then add a liveness constraint to the main MIR for this region
 630             // at the location provided as an argument to this method
 631             if liveness_constraints.get_elements(region).next().is_some() {
 632                 self.cx
 633                     .borrowck_context
 634                     .constraints
 635                     .liveness_constraints
 636                     .add_element(region, location);
 637             }
 638         }
 639     }
 640
 641     fn sanitize_projection(
 642         &mut self,
 643         base: PlaceTy<'tcx>,
 644         pi: PlaceElem<'tcx>,
 645         place: &Place<'tcx>,
 646         location: Location,
 647     ) -> PlaceTy<'tcx> {
 648         debug!("sanitize_projection: {:?} {:?} {:?}", base, pi, place);
 649         let tcx = self.tcx();
 650         let base_ty = base.ty;
 651         match pi {
 652             ProjectionElem::Deref => {
 653                 let deref_ty = base_ty.builtin_deref(true);
 654                 PlaceTy::from_ty(deref_ty.map(|t| t.ty).unwrap_or_else(|| {
 655                     span_mirbug_and_err!(self, place, "deref of non-pointer {:?}", base_ty)
 656                 }))
 657             }
 658             ProjectionElem::Index(i) => {
 659                 let index_ty = Place::from(i).ty(self.body(), tcx).ty;
 660                 if index_ty != tcx.types.usize {
 661                     PlaceTy::from_ty(span_mirbug_and_err!(self, i, "index by non-usize {:?}", i))
 662                 } else {
 663                     PlaceTy::from_ty(base_ty.builtin_index().unwrap_or_else(|| {
 664                         span_mirbug_and_err!(self, place, "index of non-array {:?}", base_ty)
 665                     }))
 666                 }
 667             }
 668             ProjectionElem::ConstantIndex { .. } => {
 669                 // consider verifying in-bounds
 670                 PlaceTy::from_ty(base_ty.builtin_index().unwrap_or_else(|| {
 671                     span_mirbug_and_err!(self, place, "index of non-array {:?}", base_ty)
 672                 }))
 673             }
 674             ProjectionElem::Subslice { from, to, from_end } => {
 675                 PlaceTy::from_ty(match base_ty.kind() {
 676                     ty::Array(inner, _) => {
 677                         assert!(!from_end, "array subslices should not use from_end");
 678                         tcx.mk_array(*inner, to - from)
 679                     }
 680                     ty::Slice(..) => {
 681                         assert!(from_end, "slice subslices should use from_end");
 682                         base_ty
 683                     }
 684                     _ => span_mirbug_and_err!(self, place, "slice of non-array {:?}", base_ty),
 685                 })
 686             }
 687             ProjectionElem::Downcast(maybe_name, index) => match base_ty.kind() {
 688                 ty::Adt(adt_def, _substs) if adt_def.is_enum() => {
 689                     if index.as_usize() >= adt_def.variants().len() {
 690                         PlaceTy::from_ty(span_mirbug_and_err!(
 691                             self,
 692                             place,
 693                             "cast to variant #{:?} but enum only has {:?}",
 694                             index,
 695                             adt_def.variants().len()
 696                         ))
 697                     } else {
 698                         PlaceTy { ty: base_ty, variant_index: Some(index) }
 699                     }
 700                 }
 701                 // We do not need to handle generators here, because this runs
 702                 // before the generator transform stage.
 703                 _ => {
 704                     let ty = if let Some(name) = maybe_name {
 705                         span_mirbug_and_err!(
 706                             self,
 707                             place,
 708                             "can't downcast {:?} as {:?}",
 709                             base_ty,
 710                             name
 711                         )
 712                     } else {
 713                         span_mirbug_and_err!(self, place, "can't downcast {:?}", base_ty)
 714                     };
 715                     PlaceTy::from_ty(ty)
 716                 }
 717             },
 718             ProjectionElem::Field(field, fty) => {
 719                 let fty = self.sanitize_type(place, fty);
 720                 let fty = self.cx.normalize(fty, location);
 721                 match self.field_ty(place, base, field, location) {
 722                     Ok(ty) => {
 723                         let ty = self.cx.normalize(ty, location);
 724                         if let Err(terr) = self.cx.eq_types(
 725                             ty,
 726                             fty,
 727                             location.to_locations(),
 728                             ConstraintCategory::Boring,
 729                         ) {
 730                             span_mirbug!(
 731                                 self,
 732                                 place,
 733                                 "bad field access ({:?}: {:?}): {:?}",
 734                                 ty,
 735                                 fty,
 736                                 terr
 737                             );
 738                         }
 739                     }
 740                     Err(FieldAccessError::OutOfRange { field_count }) => span_mirbug!(
 741                         self,
 742                         place,
 743                         "accessed field #{} but variant only has {}",
 744                         field.index(),
 745                         field_count
 746                     ),
 747                 }
 748                 PlaceTy::from_ty(fty)
 749             }
 750             ProjectionElem::OpaqueCast(ty) => {
 751                 let ty = self.sanitize_type(place, ty);
 752                 let ty = self.cx.normalize(ty, location);
 753                 self.cx
 754                     .eq_types(
 755                         base.ty,
 756                         ty,
 757                         location.to_locations(),
 758                         ConstraintCategory::TypeAnnotation,
 759                     )
 760                     .unwrap();
 761                 PlaceTy::from_ty(ty)
 762             }
 763         }
 764     }
 765
 766     fn error(&mut self) -> Ty<'tcx> {
 767         self.errors_reported = true;
 768         self.tcx().ty_error()
 769     }
 770
 771     fn field_ty(
 772         &mut self,
 773         parent: &dyn fmt::Debug,
 774         base_ty: PlaceTy<'tcx>,
 775         field: Field,
 776         location: Location,
 777     ) -> Result<Ty<'tcx>, FieldAccessError> {
 778         let tcx = self.tcx();
 779
 780         let (variant, substs) = match base_ty {
 781             PlaceTy { ty, variant_index: Some(variant_index) } => match *ty.kind() {
 782                 ty::Adt(adt_def, substs) => (adt_def.variant(variant_index), substs),
 783                 ty::Generator(def_id, substs, _) => {
 784                     let mut variants = substs.as_generator().state_tys(def_id, tcx);
 785                     let Some(mut variant) = variants.nth(variant_index.into()) else {
 786                         bug!(
 787                             "variant_index of generator out of range: {:?}/{:?}",
 788                             variant_index,
 789                             substs.as_generator().state_tys(def_id, tcx).count()
 790                         );
 791                     };
 792                     return match variant.nth(field.index()) {
 793                         Some(ty) => Ok(ty),
 794                         None => Err(FieldAccessError::OutOfRange { field_count: variant.count() }),
 795                     };
 796                 }
 797                 _ => bug!("can't have downcast of non-adt non-generator type"),
 798             },
 799             PlaceTy { ty, variant_index: None } => match *ty.kind() {
 800                 ty::Adt(adt_def, substs) if !adt_def.is_enum() => {
 801                     (adt_def.variant(VariantIdx::new(0)), substs)
 802                 }
 803                 ty::Closure(_, substs) => {
 804                     return match substs
 805                         .as_closure()
 806                         .tupled_upvars_ty()
 807                         .tuple_fields()
 808                         .get(field.index())
 809                     {
 810                         Some(&ty) => Ok(ty),
 811                         None => Err(FieldAccessError::OutOfRange {
 812                             field_count: substs.as_closure().upvar_tys().count(),
 813                         }),
 814                     };
 815                 }
 816                 ty::Generator(_, substs, _) => {
 817                     // Only prefix fields (upvars and current state) are
 818                     // accessible without a variant index.
 819                     return match substs.as_generator().prefix_tys().nth(field.index()) {
 820                         Some(ty) => Ok(ty),
 821                         None => Err(FieldAccessError::OutOfRange {
 822                             field_count: substs.as_generator().prefix_tys().count(),
 823                         }),
 824                     };
 825                 }
 826                 ty::Tuple(tys) => {
 827                     return match tys.get(field.index()) {
 828                         Some(&ty) => Ok(ty),
 829                         None => Err(FieldAccessError::OutOfRange { field_count: tys.len() }),
 830                     };
 831                 }
 832                 _ => {
 833                     return Ok(span_mirbug_and_err!(
 834                         self,
 835                         parent,
 836                         "can't project out of {:?}",
 837                         base_ty
 838                     ));
 839                 }
 840             },
 841         };
 842
 843         if let Some(field) = variant.fields.get(field.index()) {
 844             Ok(self.cx.normalize(field.ty(tcx, substs), location))
 845         } else {
 846             Err(FieldAccessError::OutOfRange { field_count: variant.fields.len() })
 847         }
 848     }
 849 }
 850
 851 /// The MIR type checker. Visits the MIR and enforces all the
 852 /// constraints needed for it to be valid and well-typed. Along the
 853 /// way, it accrues region constraints -- these can later be used by
 854 /// NLL region checking.
 855 struct TypeChecker<'a, 'tcx> {
 856     infcx: &'a InferCtxt<'tcx>,
 857     param_env: ty::ParamEnv<'tcx>,
 858     last_span: Span,
 859     body: &'a Body<'tcx>,
 860     /// User type annotations are shared between the main MIR and the MIR of
 861     /// all of the promoted items.
 862     user_type_annotations: &'a CanonicalUserTypeAnnotations<'tcx>,
 863     region_bound_pairs: &'a RegionBoundPairs<'tcx>,
 864     implicit_region_bound: ty::Region<'tcx>,
 865     reported_errors: FxHashSet<(Ty<'tcx>, Span)>,
 866     borrowck_context: &'a mut BorrowCheckContext<'a, 'tcx>,
 867 }
 868
 869 struct BorrowCheckContext<'a, 'tcx> {
 870     pub(crate) universal_regions: &'a UniversalRegions<'tcx>,
 871     location_table: &'a LocationTable,
 872     all_facts: &'a mut Option<AllFacts>,
 873     borrow_set: &'a BorrowSet<'tcx>,
 874     pub(crate) constraints: &'a mut MirTypeckRegionConstraints<'tcx>,
 875     upvars: &'a [Upvar<'tcx>],
 876 }
 877
 878 pub(crate) struct MirTypeckResults<'tcx> {
 879     pub(crate) constraints: MirTypeckRegionConstraints<'tcx>,
 880     pub(crate) universal_region_relations: Frozen<UniversalRegionRelations<'tcx>>,
 881     pub(crate) opaque_type_values:
 882         VecMap<OpaqueTypeKey<'tcx>, (OpaqueHiddenType<'tcx>, OpaqueTyOrigin)>,
 883 }
 884
 885 /// A collection of region constraints that must be satisfied for the
 886 /// program to be considered well-typed.
 887 pub(crate) struct MirTypeckRegionConstraints<'tcx> {
 888     /// Maps from a `ty::Placeholder` to the corresponding
 889     /// `PlaceholderIndex` bit that we will use for it.
 890     ///
 891     /// To keep everything in sync, do not insert this set
 892     /// directly. Instead, use the `placeholder_region` helper.
 893     pub(crate) placeholder_indices: PlaceholderIndices,
 894
 895     /// Each time we add a placeholder to `placeholder_indices`, we
 896     /// also create a corresponding "representative" region vid for
 897     /// that wraps it. This vector tracks those. This way, when we
 898     /// convert the same `ty::RePlaceholder(p)` twice, we can map to
 899     /// the same underlying `RegionVid`.
 900     pub(crate) placeholder_index_to_region: IndexVec<PlaceholderIndex, ty::Region<'tcx>>,
 901
 902     /// In general, the type-checker is not responsible for enforcing
 903     /// liveness constraints; this job falls to the region inferencer,
 904     /// which performs a liveness analysis. However, in some limited
 905     /// cases, the MIR type-checker creates temporary regions that do
 906     /// not otherwise appear in the MIR -- in particular, the
 907     /// late-bound regions that it instantiates at call-sites -- and
 908     /// hence it must report on their liveness constraints.
 909     pub(crate) liveness_constraints: LivenessValues<RegionVid>,
 910
 911     pub(crate) outlives_constraints: OutlivesConstraintSet<'tcx>,
 912
 913     pub(crate) member_constraints: MemberConstraintSet<'tcx, RegionVid>,
 914
 915     pub(crate) universe_causes: FxHashMap<ty::UniverseIndex, UniverseInfo<'tcx>>,
 916
 917     pub(crate) type_tests: Vec<TypeTest<'tcx>>,
 918 }
 919
 920 impl<'tcx> MirTypeckRegionConstraints<'tcx> {
 921     fn placeholder_region(
 922         &mut self,
 923         infcx: &InferCtxt<'tcx>,
 924         placeholder: ty::PlaceholderRegion,
 925     ) -> ty::Region<'tcx> {
 926         let placeholder_index = self.placeholder_indices.insert(placeholder);
 927         match self.placeholder_index_to_region.get(placeholder_index) {
 928             Some(&v) => v,
 929             None => {
 930                 let origin = NllRegionVariableOrigin::Placeholder(placeholder);
 931                 let region = infcx.next_nll_region_var_in_universe(origin, placeholder.universe);
 932                 self.placeholder_index_to_region.push(region);
 933                 region
 934             }
 935         }
 936     }
 937 }
 938
 939 /// The `Locations` type summarizes *where* region constraints are
 940 /// required to hold. Normally, this is at a particular point which
 941 /// created the obligation, but for constraints that the user gave, we
 942 /// want the constraint to hold at all points.
 943 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
 944 pub enum Locations {
 945     /// Indicates that a type constraint should always be true. This
 946     /// is particularly important in the new borrowck analysis for
 947     /// things like the type of the return slot. Consider this
 948     /// example:
 949     ///
 950     /// ```compile_fail,E0515
 951     /// fn foo<'a>(x: &'a u32) -> &'a u32 {
 952     ///     let y = 22;
 953     ///     return &y; // error
 954     /// }
 955     /// ```
 956     ///
 957     /// Here, we wind up with the signature from the return type being
 958     /// something like `&'1 u32` where `'1` is a universal region. But
 959     /// the type of the return slot `_0` is something like `&'2 u32`
 960     /// where `'2` is an existential region variable. The type checker
 961     /// requires that `&'2 u32 = &'1 u32` -- but at what point? In the
 962     /// older NLL analysis, we required this only at the entry point
 963     /// to the function. By the nature of the constraints, this wound
 964     /// up propagating to all points reachable from start (because
 965     /// `'1` -- as a universal region -- is live everywhere). In the
 966     /// newer analysis, though, this doesn't work: `_0` is considered
 967     /// dead at the start (it has no usable value) and hence this type
 968     /// equality is basically a no-op. Then, later on, when we do `_0
 969     /// = &'3 y`, that region `'3` never winds up related to the
 970     /// universal region `'1` and hence no error occurs. Therefore, we
 971     /// use Locations::All instead, which ensures that the `'1` and
 972     /// `'2` are equal everything. We also use this for other
 973     /// user-given type annotations; e.g., if the user wrote `let mut
 974     /// x: &'static u32 = ...`, we would ensure that all values
 975     /// assigned to `x` are of `'static` lifetime.
 976     ///
 977     /// The span points to the place the constraint arose. For example,
 978     /// it points to the type in a user-given type annotation. If
 979     /// there's no sensible span then it's DUMMY_SP.
 980     All(Span),
 981
 982     /// An outlives constraint that only has to hold at a single location,
 983     /// usually it represents a point where references flow from one spot to
 984     /// another (e.g., `x = y`)
 985     Single(Location),
 986 }
 987
 988 impl Locations {
 989     pub fn from_location(&self) -> Option<Location> {
 990         match self {
 991             Locations::All(_) => None,
 992             Locations::Single(from_location) => Some(*from_location),
 993         }
 994     }
 995
 996     /// Gets a span representing the location.
 997     pub fn span(&self, body: &Body<'_>) -> Span {
 998         match self {
 999             Locations::All(span) => *span,
1000             Locations::Single(l) => body.source_info(*l).span,
1001         }
1002     }
1003 }
1004
1005 impl<'a, 'tcx> TypeChecker<'a, 'tcx> {
1006     fn new(
1007         infcx: &'a InferCtxt<'tcx>,
1008         body: &'a Body<'tcx>,
1009         param_env: ty::ParamEnv<'tcx>,
1010         region_bound_pairs: &'a RegionBoundPairs<'tcx>,
1011         implicit_region_bound: ty::Region<'tcx>,
1012         borrowck_context: &'a mut BorrowCheckContext<'a, 'tcx>,
1013     ) -> Self {
1014         let mut checker = Self {
1015             infcx,
1016             last_span: DUMMY_SP,
1017             body,
1018             user_type_annotations: &body.user_type_annotations,
1019             param_env,
1020             region_bound_pairs,
1021             implicit_region_bound,
1022             borrowck_context,
1023             reported_errors: Default::default(),
1024         };
1025         checker.check_user_type_annotations();
1026         checker
1027     }
1028
1029     fn body(&self) -> &Body<'tcx> {
1030         self.body
1031     }
1032
1033     fn unsized_feature_enabled(&self) -> bool {
1034         let features = self.tcx().features();
1035         features.unsized_locals || features.unsized_fn_params
1036     }
1037
1038     /// Equate the inferred type and the annotated type for user type annotations
1039     #[instrument(skip(self), level = "debug")]
1040     fn check_user_type_annotations(&mut self) {
1041         debug!(?self.user_type_annotations);
1042         for user_annotation in self.user_type_annotations {
1043             let CanonicalUserTypeAnnotation { span, ref user_ty, inferred_ty } = *user_annotation;
1044             let inferred_ty = self.normalize(inferred_ty, Locations::All(span));
1045             let annotation = self.instantiate_canonical_with_fresh_inference_vars(span, user_ty);
1046             debug!(?annotation);
1047             match annotation {
1048                 UserType::Ty(mut ty) => {
1049                     ty = self.normalize(ty, Locations::All(span));
1050
1051                     if let Err(terr) = self.eq_types(
1052                         ty,
1053                         inferred_ty,
1054                         Locations::All(span),
1055                         ConstraintCategory::BoringNoLocation,
1056                     ) {
1057                         span_mirbug!(
1058                             self,
1059                             user_annotation,
1060                             "bad user type ({:?} = {:?}): {:?}",
1061                             ty,
1062                             inferred_ty,
1063                             terr
1064                         );
1065                     }
1066
1067                     self.prove_predicate(
1068                         ty::Binder::dummy(ty::PredicateKind::WellFormed(inferred_ty.into())),
1069                         Locations::All(span),
1070                         ConstraintCategory::TypeAnnotation,
1071                     );
1072                 }
1073                 UserType::TypeOf(def_id, user_substs) => {
1074                     if let Err(terr) = self.fully_perform_op(
1075                         Locations::All(span),
1076                         ConstraintCategory::BoringNoLocation,
1077                         self.param_env.and(type_op::ascribe_user_type::AscribeUserType::new(
1078                             inferred_ty,
1079                             def_id,
1080                             user_substs,
1081                         )),
1082                     ) {
1083                         span_mirbug!(
1084                             self,
1085                             user_annotation,
1086                             "bad user type AscribeUserType({:?}, {:?} {:?}, type_of={:?}): {:?}",
1087                             inferred_ty,
1088                             def_id,
1089                             user_substs,
1090                             self.tcx().type_of(def_id),
1091                             terr,
1092                         );
1093                     }
1094                 }
1095             }
1096         }
1097     }
1098
1099     #[instrument(skip(self, data), level = "debug")]
1100     fn push_region_constraints(
1101         &mut self,
1102         locations: Locations,
1103         category: ConstraintCategory<'tcx>,
1104         data: &QueryRegionConstraints<'tcx>,
1105     ) {
1106         debug!("constraints generated: {:#?}", data);
1107
1108         constraint_conversion::ConstraintConversion::new(
1109             self.infcx,
1110             self.borrowck_context.universal_regions,
1111             self.region_bound_pairs,
1112             self.implicit_region_bound,
1113             self.param_env,
1114             locations,
1115             locations.span(self.body),
1116             category,
1117             &mut self.borrowck_context.constraints,
1118         )
1119         .convert_all(data);
1120     }
1121
1122     /// Try to relate `sub <: sup`
1123     fn sub_types(
1124         &mut self,
1125         sub: Ty<'tcx>,
1126         sup: Ty<'tcx>,
1127         locations: Locations,
1128         category: ConstraintCategory<'tcx>,
1129     ) -> Fallible<()> {
1130         // Use this order of parameters because the sup type is usually the
1131         // "expected" type in diagnostics.
1132         self.relate_types(sup, ty::Variance::Contravariant, sub, locations, category)
1133     }
1134
1135     #[instrument(skip(self, category), level = "debug")]
1136     fn eq_types(
1137         &mut self,
1138         expected: Ty<'tcx>,
1139         found: Ty<'tcx>,
1140         locations: Locations,
1141         category: ConstraintCategory<'tcx>,
1142     ) -> Fallible<()> {
1143         self.relate_types(expected, ty::Variance::Invariant, found, locations, category)
1144     }
1145
1146     #[instrument(skip(self), level = "debug")]
1147     fn relate_type_and_user_type(
1148         &mut self,
1149         a: Ty<'tcx>,
1150         v: ty::Variance,
1151         user_ty: &UserTypeProjection,
1152         locations: Locations,
1153         category: ConstraintCategory<'tcx>,
1154     ) -> Fallible<()> {
1155         let annotated_type = self.user_type_annotations[user_ty.base].inferred_ty;
1156         let mut curr_projected_ty = PlaceTy::from_ty(annotated_type);
1157
1158         let tcx = self.infcx.tcx;
1159
1160         for proj in &user_ty.projs {
1161             let projected_ty = curr_projected_ty.projection_ty_core(
1162                 tcx,
1163                 self.param_env,
1164                 proj,
1165                 |this, field, _| {
1166                     let ty = this.field_ty(tcx, field);
1167                     self.normalize(ty, locations)
1168                 },
1169                 |_, _| unreachable!(),
1170             );
1171             curr_projected_ty = projected_ty;
1172         }
1173         debug!(
1174             "user_ty base: {:?} freshened: {:?} projs: {:?} yields: {:?}",
1175             user_ty.base, annotated_type, user_ty.projs, curr_projected_ty
1176         );
1177
1178         let ty = curr_projected_ty.ty;
1179         self.relate_types(ty, v.xform(ty::Variance::Contravariant), a, locations, category)?;
1180
1181         Ok(())
1182     }
1183
1184     fn tcx(&self) -> TyCtxt<'tcx> {
1185         self.infcx.tcx
1186     }
1187
1188     #[instrument(skip(self, body, location), level = "debug")]
1189     fn check_stmt(&mut self, body: &Body<'tcx>, stmt: &Statement<'tcx>, location: Location) {
1190         let tcx = self.tcx();
1191         debug!("stmt kind: {:?}", stmt.kind);
1192         match stmt.kind {
1193             StatementKind::Assign(box (ref place, ref rv)) => {
1194                 // Assignments to temporaries are not "interesting";
1195                 // they are not caused by the user, but rather artifacts
1196                 // of lowering. Assignments to other sorts of places *are* interesting
1197                 // though.
1198                 let category = match place.as_local() {
1199                     Some(RETURN_PLACE) => {
1200                         let defining_ty = &self.borrowck_context.universal_regions.defining_ty;
1201                         if defining_ty.is_const() {
1202                             if tcx.is_static(defining_ty.def_id()) {
1203                                 ConstraintCategory::UseAsStatic
1204                             } else {
1205                                 ConstraintCategory::UseAsConst
1206                             }
1207                         } else {
1208                             ConstraintCategory::Return(ReturnConstraint::Normal)
1209                         }
1210                     }
1211                     Some(l)
1212                         if matches!(
1213                             body.local_decls[l].local_info,
1214                             Some(box LocalInfo::AggregateTemp)
1215                         ) =>
1216                     {
1217                         ConstraintCategory::Usage
1218                     }
1219                     Some(l) if !body.local_decls[l].is_user_variable() => {
1220                         ConstraintCategory::Boring
1221                     }
1222                     _ => ConstraintCategory::Assignment,
1223                 };
1224                 debug!(
1225                     "assignment category: {:?} {:?}",
1226                     category,
1227                     place.as_local().map(|l| &body.local_decls[l])
1228                 );
1229
1230                 let place_ty = place.ty(body, tcx).ty;
1231                 debug!(?place_ty);
1232                 let place_ty = self.normalize(place_ty, location);
1233                 debug!("place_ty normalized: {:?}", place_ty);
1234                 let rv_ty = rv.ty(body, tcx);
1235                 debug!(?rv_ty);
1236                 let rv_ty = self.normalize(rv_ty, location);
1237                 debug!("normalized rv_ty: {:?}", rv_ty);
1238                 if let Err(terr) =
1239                     self.sub_types(rv_ty, place_ty, location.to_locations(), category)
1240                 {
1241                     span_mirbug!(
1242                         self,
1243                         stmt,
1244                         "bad assignment ({:?} = {:?}): {:?}",
1245                         place_ty,
1246                         rv_ty,
1247                         terr
1248                     );
1249                 }
1250
1251                 if let Some(annotation_index) = self.rvalue_user_ty(rv) {
1252                     if let Err(terr) = self.relate_type_and_user_type(
1253                         rv_ty,
1254                         ty::Variance::Invariant,
1255                         &UserTypeProjection { base: annotation_index, projs: vec![] },
1256                         location.to_locations(),
1257                         ConstraintCategory::Boring,
1258                     ) {
1259                         let annotation = &self.user_type_annotations[annotation_index];
1260                         span_mirbug!(
1261                             self,
1262                             stmt,
1263                             "bad user type on rvalue ({:?} = {:?}): {:?}",
1264                             annotation,
1265                             rv_ty,
1266                             terr
1267                         );
1268                     }
1269                 }
1270
1271                 self.check_rvalue(body, rv, location);
1272                 if !self.unsized_feature_enabled() {
1273                     let trait_ref =
1274                         tcx.at(self.last_span).mk_trait_ref(LangItem::Sized, [place_ty]);
1275                     self.prove_trait_ref(
1276                         trait_ref,
1277                         location.to_locations(),
1278                         ConstraintCategory::SizedBound,
1279                     );
1280                 }
1281             }
1282             StatementKind::AscribeUserType(box (ref place, ref projection), variance) => {
1283                 let place_ty = place.ty(body, tcx).ty;
1284                 if let Err(terr) = self.relate_type_and_user_type(
1285                     place_ty,
1286                     variance,
1287                     projection,
1288                     Locations::All(stmt.source_info.span),
1289                     ConstraintCategory::TypeAnnotation,
1290                 ) {
1291                     let annotation = &self.user_type_annotations[projection.base];
1292                     span_mirbug!(
1293                         self,
1294                         stmt,
1295                         "bad type assert ({:?} <: {:?} with projections {:?}): {:?}",
1296                         place_ty,
1297                         annotation,
1298                         projection.projs,
1299                         terr
1300                     );
1301                 }
1302             }
1303             StatementKind::Intrinsic(box ref kind) => match kind {
1304                 NonDivergingIntrinsic::Assume(op) => self.check_operand(op, location),
1305                 NonDivergingIntrinsic::CopyNonOverlapping(..) => span_bug!(
1306                     stmt.source_info.span,
1307                     "Unexpected NonDivergingIntrinsic::CopyNonOverlapping, should only appear after lowering_intrinsics",
1308                 ),
1309             },
1310             StatementKind::FakeRead(..)
1311             | StatementKind::StorageLive(..)
1312             | StatementKind::StorageDead(..)
1313             | StatementKind::Retag { .. }
1314             | StatementKind::Coverage(..)
1315             | StatementKind::Nop => {}
1316             StatementKind::Deinit(..) | StatementKind::SetDiscriminant { .. } => {
1317                 bug!("Statement not allowed in this MIR phase")
1318             }
1319         }
1320     }
1321
1322     #[instrument(skip(self, body, term_location), level = "debug")]
1323     fn check_terminator(
1324         &mut self,
1325         body: &Body<'tcx>,
1326         term: &Terminator<'tcx>,
1327         term_location: Location,
1328     ) {
1329         let tcx = self.tcx();
1330         debug!("terminator kind: {:?}", term.kind);
1331         match term.kind {
1332             TerminatorKind::Goto { .. }
1333             | TerminatorKind::Resume
1334             | TerminatorKind::Abort
1335             | TerminatorKind::Return
1336             | TerminatorKind::GeneratorDrop
1337             | TerminatorKind::Unreachable
1338             | TerminatorKind::Drop { .. }
1339             | TerminatorKind::FalseEdge { .. }
1340             | TerminatorKind::FalseUnwind { .. }
1341             | TerminatorKind::InlineAsm { .. } => {
1342                 // no checks needed for these
1343             }
1344
1345             TerminatorKind::DropAndReplace { ref place, ref value, target: _, unwind: _ } => {
1346                 let place_ty = place.ty(body, tcx).ty;
1347                 let rv_ty = value.ty(body, tcx);
1348
1349                 let locations = term_location.to_locations();
1350                 if let Err(terr) =
1351                     self.sub_types(rv_ty, place_ty, locations, ConstraintCategory::Assignment)
1352                 {
1353                     span_mirbug!(
1354                         self,
1355                         term,
1356                         "bad DropAndReplace ({:?} = {:?}): {:?}",
1357                         place_ty,
1358                         rv_ty,
1359                         terr
1360                     );
1361                 }
1362             }
1363             TerminatorKind::SwitchInt { ref discr, switch_ty, .. } => {
1364                 self.check_operand(discr, term_location);
1365
1366                 let discr_ty = discr.ty(body, tcx);
1367                 if let Err(terr) = self.sub_types(
1368                     discr_ty,
1369                     switch_ty,
1370                     term_location.to_locations(),
1371                     ConstraintCategory::Assignment,
1372                 ) {
1373                     span_mirbug!(
1374                         self,
1375                         term,
1376                         "bad SwitchInt ({:?} on {:?}): {:?}",
1377                         switch_ty,
1378                         discr_ty,
1379                         terr
1380                     );
1381                 }
1382                 if !switch_ty.is_integral() && !switch_ty.is_char() && !switch_ty.is_bool() {
1383                     span_mirbug!(self, term, "bad SwitchInt discr ty {:?}", switch_ty);
1384                 }
1385                 // FIXME: check the values
1386             }
1387             TerminatorKind::Call {
1388                 ref func,
1389                 ref args,
1390                 ref destination,
1391                 from_hir_call,
1392                 target,
1393                 ..
1394             } => {
1395                 self.check_operand(func, term_location);
1396                 for arg in args {
1397                     self.check_operand(arg, term_location);
1398                 }
1399
1400                 let func_ty = func.ty(body, tcx);
1401                 debug!("func_ty.kind: {:?}", func_ty.kind());
1402
1403                 let sig = match func_ty.kind() {
1404                     ty::FnDef(..) | ty::FnPtr(_) => func_ty.fn_sig(tcx),
1405                     _ => {
1406                         span_mirbug!(self, term, "call to non-function {:?}", func_ty);
1407                         return;
1408                     }
1409                 };
1410                 let (sig, map) = tcx.replace_late_bound_regions(sig, |br| {
1411                     self.infcx.next_region_var(LateBoundRegion(
1412                         term.source_info.span,
1413                         br.kind,
1414                         LateBoundRegionConversionTime::FnCall,
1415                     ))
1416                 });
1417                 debug!(?sig);
1418                 // IMPORTANT: We have to prove well formed for the function signature before
1419                 // we normalize it, as otherwise types like `<&'a &'b () as Trait>::Assoc`
1420                 // get normalized away, causing us to ignore the `'b: 'a` bound used by the function.
1421                 //
1422                 // Normalization results in a well formed type if the input is well formed, so we
1423                 // don't have to check it twice.
1424                 //
1425                 // See #91068 for an example.
1426                 self.prove_predicates(
1427                     sig.inputs_and_output
1428                         .iter()
1429                         .map(|ty| ty::Binder::dummy(ty::PredicateKind::WellFormed(ty.into()))),
1430                     term_location.to_locations(),
1431                     ConstraintCategory::Boring,
1432                 );
1433                 let sig = self.normalize(sig, term_location);
1434                 self.check_call_dest(body, term, &sig, *destination, target, term_location);
1435
1436                 // The ordinary liveness rules will ensure that all
1437                 // regions in the type of the callee are live here. We
1438                 // then further constrain the late-bound regions that
1439                 // were instantiated at the call site to be live as
1440                 // well. The resulting is that all the input (and
1441                 // output) types in the signature must be live, since
1442                 // all the inputs that fed into it were live.
1443                 for &late_bound_region in map.values() {
1444                     let region_vid =
1445                         self.borrowck_context.universal_regions.to_region_vid(late_bound_region);
1446                     self.borrowck_context
1447                         .constraints
1448                         .liveness_constraints
1449                         .add_element(region_vid, term_location);
1450                 }
1451
1452                 self.check_call_inputs(body, term, &sig, args, term_location, from_hir_call);
1453             }
1454             TerminatorKind::Assert { ref cond, ref msg, .. } => {
1455                 self.check_operand(cond, term_location);
1456
1457                 let cond_ty = cond.ty(body, tcx);
1458                 if cond_ty != tcx.types.bool {
1459                     span_mirbug!(self, term, "bad Assert ({:?}, not bool", cond_ty);
1460                 }
1461
1462                 if let AssertKind::BoundsCheck { ref len, ref index } = *msg {
1463                     if len.ty(body, tcx) != tcx.types.usize {
1464                         span_mirbug!(self, len, "bounds-check length non-usize {:?}", len)
1465                     }
1466                     if index.ty(body, tcx) != tcx.types.usize {
1467                         span_mirbug!(self, index, "bounds-check index non-usize {:?}", index)
1468                     }
1469                 }
1470             }
1471             TerminatorKind::Yield { ref value, .. } => {
1472                 self.check_operand(value, term_location);
1473
1474                 let value_ty = value.ty(body, tcx);
1475                 match body.yield_ty() {
1476                     None => span_mirbug!(self, term, "yield in non-generator"),
1477                     Some(ty) => {
1478                         if let Err(terr) = self.sub_types(
1479                             value_ty,
1480                             ty,
1481                             term_location.to_locations(),
1482                             ConstraintCategory::Yield,
1483                         ) {
1484                             span_mirbug!(
1485                                 self,
1486                                 term,
1487                                 "type of yield value is {:?}, but the yield type is {:?}: {:?}",
1488                                 value_ty,
1489                                 ty,
1490                                 terr
1491                             );
1492                         }
1493                     }
1494                 }
1495             }
1496         }
1497     }
1498
1499     fn check_call_dest(
1500         &mut self,
1501         body: &Body<'tcx>,
1502         term: &Terminator<'tcx>,
1503         sig: &ty::FnSig<'tcx>,
1504         destination: Place<'tcx>,
1505         target: Option<BasicBlock>,
1506         term_location: Location,
1507     ) {
1508         let tcx = self.tcx();
1509         match target {
1510             Some(_) => {
1511                 let dest_ty = destination.ty(body, tcx).ty;
1512                 let dest_ty = self.normalize(dest_ty, term_location);
1513                 let category = match destination.as_local() {
1514                     Some(RETURN_PLACE) => {
1515                         if let BorrowCheckContext {
1516                             universal_regions:
1517                                 UniversalRegions {
1518                                     defining_ty:
1519                                         DefiningTy::Const(def_id, _)
1520                                         | DefiningTy::InlineConst(def_id, _),
1521                                     ..
1522                                 },
1523                             ..
1524                         } = self.borrowck_context
1525                         {
1526                             if tcx.is_static(*def_id) {
1527                                 ConstraintCategory::UseAsStatic
1528                             } else {
1529                                 ConstraintCategory::UseAsConst
1530                             }
1531                         } else {
1532                             ConstraintCategory::Return(ReturnConstraint::Normal)
1533                         }
1534                     }
1535                     Some(l) if !body.local_decls[l].is_user_variable() => {
1536                         ConstraintCategory::Boring
1537                     }
1538                     _ => ConstraintCategory::Assignment,
1539                 };
1540
1541                 let locations = term_location.to_locations();
1542
1543                 if let Err(terr) = self.sub_types(sig.output(), dest_ty, locations, category) {
1544                     span_mirbug!(
1545                         self,
1546                         term,
1547                         "call dest mismatch ({:?} <- {:?}): {:?}",
1548                         dest_ty,
1549                         sig.output(),
1550                         terr
1551                     );
1552                 }
1553
1554                 // When `unsized_fn_params` and `unsized_locals` are both not enabled,
1555                 // this check is done at `check_local`.
1556                 if self.unsized_feature_enabled() {
1557                     let span = term.source_info.span;
1558                     self.ensure_place_sized(dest_ty, span);
1559                 }
1560             }
1561             None => {
1562                 if !sig.output().is_privately_uninhabited(self.tcx(), self.param_env) {
1563                     span_mirbug!(self, term, "call to converging function {:?} w/o dest", sig);
1564                 }
1565             }
1566         }
1567     }
1568
1569     fn check_call_inputs(
1570         &mut self,
1571         body: &Body<'tcx>,
1572         term: &Terminator<'tcx>,
1573         sig: &ty::FnSig<'tcx>,
1574         args: &[Operand<'tcx>],
1575         term_location: Location,
1576         from_hir_call: bool,
1577     ) {
1578         debug!("check_call_inputs({:?}, {:?})", sig, args);
1579         if args.len() < sig.inputs().len() || (args.len() > sig.inputs().len() && !sig.c_variadic) {
1580             span_mirbug!(self, term, "call to {:?} with wrong # of args", sig);
1581         }
1582
1583         let func_ty = if let TerminatorKind::Call { func, .. } = &term.kind {
1584             Some(func.ty(body, self.infcx.tcx))
1585         } else {
1586             None
1587         };
1588         debug!(?func_ty);
1589
1590         for (n, (fn_arg, op_arg)) in iter::zip(sig.inputs(), args).enumerate() {
1591             let op_arg_ty = op_arg.ty(body, self.tcx());
1592
1593             let op_arg_ty = self.normalize(op_arg_ty, term_location);
1594             let category = if from_hir_call {
1595                 ConstraintCategory::CallArgument(self.infcx.tcx.erase_regions(func_ty))
1596             } else {
1597                 ConstraintCategory::Boring
1598             };
1599             if let Err(terr) =
1600                 self.sub_types(op_arg_ty, *fn_arg, term_location.to_locations(), category)
1601             {
1602                 span_mirbug!(
1603                     self,
1604                     term,
1605                     "bad arg #{:?} ({:?} <- {:?}): {:?}",
1606                     n,
1607                     fn_arg,
1608                     op_arg_ty,
1609                     terr
1610                 );
1611             }
1612         }
1613     }
1614
1615     fn check_iscleanup(&mut self, body: &Body<'tcx>, block_data: &BasicBlockData<'tcx>) {
1616         let is_cleanup = block_data.is_cleanup;
1617         self.last_span = block_data.terminator().source_info.span;
1618         match block_data.terminator().kind {
1619             TerminatorKind::Goto { target } => {
1620                 self.assert_iscleanup(body, block_data, target, is_cleanup)
1621             }
1622             TerminatorKind::SwitchInt { ref targets, .. } => {
1623                 for target in targets.all_targets() {
1624                     self.assert_iscleanup(body, block_data, *target, is_cleanup);
1625                 }
1626             }
1627             TerminatorKind::Resume => {
1628                 if !is_cleanup {
1629                     span_mirbug!(self, block_data, "resume on non-cleanup block!")
1630                 }
1631             }
1632             TerminatorKind::Abort => {
1633                 if !is_cleanup {
1634                     span_mirbug!(self, block_data, "abort on non-cleanup block!")
1635                 }
1636             }
1637             TerminatorKind::Return => {
1638                 if is_cleanup {
1639                     span_mirbug!(self, block_data, "return on cleanup block")
1640                 }
1641             }
1642             TerminatorKind::GeneratorDrop { .. } => {
1643                 if is_cleanup {
1644                     span_mirbug!(self, block_data, "generator_drop in cleanup block")
1645                 }
1646             }
1647             TerminatorKind::Yield { resume, drop, .. } => {
1648                 if is_cleanup {
1649                     span_mirbug!(self, block_data, "yield in cleanup block")
1650                 }
1651                 self.assert_iscleanup(body, block_data, resume, is_cleanup);
1652                 if let Some(drop) = drop {
1653                     self.assert_iscleanup(body, block_data, drop, is_cleanup);
1654                 }
1655             }
1656             TerminatorKind::Unreachable => {}
1657             TerminatorKind::Drop { target, unwind, .. }
1658             | TerminatorKind::DropAndReplace { target, unwind, .. }
1659             | TerminatorKind::Assert { target, cleanup: unwind, .. } => {
1660                 self.assert_iscleanup(body, block_data, target, is_cleanup);
1661                 if let Some(unwind) = unwind {
1662                     if is_cleanup {
1663                         span_mirbug!(self, block_data, "unwind on cleanup block")
1664                     }
1665                     self.assert_iscleanup(body, block_data, unwind, true);
1666                 }
1667             }
1668             TerminatorKind::Call { ref target, cleanup, .. } => {
1669                 if let &Some(target) = target {
1670                     self.assert_iscleanup(body, block_data, target, is_cleanup);
1671                 }
1672                 if let Some(cleanup) = cleanup {
1673                     if is_cleanup {
1674                         span_mirbug!(self, block_data, "cleanup on cleanup block")
1675                     }
1676                     self.assert_iscleanup(body, block_data, cleanup, true);
1677                 }
1678             }
1679             TerminatorKind::FalseEdge { real_target, imaginary_target } => {
1680                 self.assert_iscleanup(body, block_data, real_target, is_cleanup);
1681                 self.assert_iscleanup(body, block_data, imaginary_target, is_cleanup);
1682             }
1683             TerminatorKind::FalseUnwind { real_target, unwind } => {
1684                 self.assert_iscleanup(body, block_data, real_target, is_cleanup);
1685                 if let Some(unwind) = unwind {
1686                     if is_cleanup {
1687                         span_mirbug!(self, block_data, "cleanup in cleanup block via false unwind");
1688                     }
1689                     self.assert_iscleanup(body, block_data, unwind, true);
1690                 }
1691             }
1692             TerminatorKind::InlineAsm { destination, cleanup, .. } => {
1693                 if let Some(target) = destination {
1694                     self.assert_iscleanup(body, block_data, target, is_cleanup);
1695                 }
1696                 if let Some(cleanup) = cleanup {
1697                     if is_cleanup {
1698                         span_mirbug!(self, block_data, "cleanup on cleanup block")
1699                     }
1700                     self.assert_iscleanup(body, block_data, cleanup, true);
1701                 }
1702             }
1703         }
1704     }
1705
1706     fn assert_iscleanup(
1707         &mut self,
1708         body: &Body<'tcx>,
1709         ctxt: &dyn fmt::Debug,
1710         bb: BasicBlock,
1711         iscleanuppad: bool,
1712     ) {
1713         if body[bb].is_cleanup != iscleanuppad {
1714             span_mirbug!(self, ctxt, "cleanuppad mismatch: {:?} should be {:?}", bb, iscleanuppad);
1715         }
1716     }
1717
1718     fn check_local(&mut self, body: &Body<'tcx>, local: Local, local_decl: &LocalDecl<'tcx>) {
1719         match body.local_kind(local) {
1720             LocalKind::ReturnPointer | LocalKind::Arg => {
1721                 // return values of normal functions are required to be
1722                 // sized by typeck, but return values of ADT constructors are
1723                 // not because we don't include a `Self: Sized` bounds on them.
1724                 //
1725                 // Unbound parts of arguments were never required to be Sized
1726                 // - maybe we should make that a warning.
1727                 return;
1728             }
1729             LocalKind::Var | LocalKind::Temp => {}
1730         }
1731
1732         // When `unsized_fn_params` or `unsized_locals` is enabled, only function calls
1733         // and nullary ops are checked in `check_call_dest`.
1734         if !self.unsized_feature_enabled() {
1735             let span = local_decl.source_info.span;
1736             let ty = local_decl.ty;
1737             self.ensure_place_sized(ty, span);
1738         }
1739     }
1740
1741     fn ensure_place_sized(&mut self, ty: Ty<'tcx>, span: Span) {
1742         let tcx = self.tcx();
1743
1744         // Erase the regions from `ty` to get a global type.  The
1745         // `Sized` bound in no way depends on precise regions, so this
1746         // shouldn't affect `is_sized`.
1747         let erased_ty = tcx.erase_regions(ty);
1748         if !erased_ty.is_sized(tcx, self.param_env) {
1749             // in current MIR construction, all non-control-flow rvalue
1750             // expressions evaluate through `as_temp` or `into` a return
1751             // slot or local, so to find all unsized rvalues it is enough
1752             // to check all temps, return slots and locals.
1753             if self.reported_errors.replace((ty, span)).is_none() {
1754                 // While this is located in `nll::typeck` this error is not
1755                 // an NLL error, it's a required check to prevent creation
1756                 // of unsized rvalues in a call expression.
1757                 self.tcx().sess.emit_err(MoveUnsized { ty, span });
1758             }
1759         }
1760     }
1761
1762     fn aggregate_field_ty(
1763         &mut self,
1764         ak: &AggregateKind<'tcx>,
1765         field_index: usize,
1766         location: Location,
1767     ) -> Result<Ty<'tcx>, FieldAccessError> {
1768         let tcx = self.tcx();
1769
1770         match *ak {
1771             AggregateKind::Adt(adt_did, variant_index, substs, _, active_field_index) => {
1772                 let def = tcx.adt_def(adt_did);
1773                 let variant = &def.variant(variant_index);
1774                 let adj_field_index = active_field_index.unwrap_or(field_index);
1775                 if let Some(field) = variant.fields.get(adj_field_index) {
1776                     Ok(self.normalize(field.ty(tcx, substs), location))
1777                 } else {
1778                     Err(FieldAccessError::OutOfRange { field_count: variant.fields.len() })
1779                 }
1780             }
1781             AggregateKind::Closure(_, substs) => {
1782                 match substs.as_closure().upvar_tys().nth(field_index) {
1783                     Some(ty) => Ok(ty),
1784                     None => Err(FieldAccessError::OutOfRange {
1785                         field_count: substs.as_closure().upvar_tys().count(),
1786                     }),
1787                 }
1788             }
1789             AggregateKind::Generator(_, substs, _) => {
1790                 // It doesn't make sense to look at a field beyond the prefix;
1791                 // these require a variant index, and are not initialized in
1792                 // aggregate rvalues.
1793                 match substs.as_generator().prefix_tys().nth(field_index) {
1794                     Some(ty) => Ok(ty),
1795                     None => Err(FieldAccessError::OutOfRange {
1796                         field_count: substs.as_generator().prefix_tys().count(),
1797                     }),
1798                 }
1799             }
1800             AggregateKind::Array(ty) => Ok(ty),
1801             AggregateKind::Tuple => {
1802                 unreachable!("This should have been covered in check_rvalues");
1803             }
1804         }
1805     }
1806
1807     fn check_operand(&mut self, op: &Operand<'tcx>, location: Location) {
1808         debug!(?op, ?location, "check_operand");
1809
1810         if let Operand::Constant(constant) = op {
1811             let maybe_uneval = match constant.literal {
1812                 ConstantKind::Val(..) | ConstantKind::Ty(_) => None,
1813                 ConstantKind::Unevaluated(uv, _) => Some(uv),
1814             };
1815
1816             if let Some(uv) = maybe_uneval {
1817                 if uv.promoted.is_none() {
1818                     let tcx = self.tcx();
1819                     let def_id = uv.def.def_id_for_type_of();
1820                     if tcx.def_kind(def_id) == DefKind::InlineConst {
1821                         let def_id = def_id.expect_local();
1822                         let predicates =
1823                             self.prove_closure_bounds(tcx, def_id, uv.substs, location);
1824                         self.normalize_and_prove_instantiated_predicates(
1825                             def_id.to_def_id(),
1826                             predicates,
1827                             location.to_locations(),
1828                         );
1829                     }
1830                 }
1831             }
1832         }
1833     }
1834
1835     #[instrument(skip(self, body), level = "debug")]
1836     fn check_rvalue(&mut self, body: &Body<'tcx>, rvalue: &Rvalue<'tcx>, location: Location) {
1837         let tcx = self.tcx();
1838         let span = body.source_info(location).span;
1839
1840         match rvalue {
1841             Rvalue::Aggregate(ak, ops) => {
1842                 for op in ops {
1843                     self.check_operand(op, location);
1844                 }
1845                 self.check_aggregate_rvalue(&body, rvalue, ak, ops, location)
1846             }
1847
1848             Rvalue::Repeat(operand, len) => {
1849                 self.check_operand(operand, location);
1850
1851                 // If the length cannot be evaluated we must assume that the length can be larger
1852                 // than 1.
1853                 // If the length is larger than 1, the repeat expression will need to copy the
1854                 // element, so we require the `Copy` trait.
1855                 if len.try_eval_usize(tcx, self.param_env).map_or(true, |len| len > 1) {
1856                     match operand {
1857                         Operand::Copy(..) | Operand::Constant(..) => {
1858                             // These are always okay: direct use of a const, or a value that can evidently be copied.
1859                         }
1860                         Operand::Move(place) => {
1861                             // Make sure that repeated elements implement `Copy`.
1862                             let ty = place.ty(body, tcx).ty;
1863                             let trait_ref = tcx.at(span).mk_trait_ref(LangItem::Copy, [ty]);
1864
1865                             self.prove_trait_ref(
1866                                 trait_ref,
1867                                 Locations::Single(location),
1868                                 ConstraintCategory::CopyBound,
1869                             );
1870                         }
1871                     }
1872                 }
1873             }
1874
1875             &Rvalue::NullaryOp(NullOp::SizeOf | NullOp::AlignOf, ty) => {
1876                 let trait_ref = tcx.at(span).mk_trait_ref(LangItem::Sized, [ty]);
1877
1878                 self.prove_trait_ref(
1879                     trait_ref,
1880                     location.to_locations(),
1881                     ConstraintCategory::SizedBound,
1882                 );
1883             }
1884
1885             Rvalue::ShallowInitBox(operand, ty) => {
1886                 self.check_operand(operand, location);
1887
1888                 let trait_ref = tcx.at(span).mk_trait_ref(LangItem::Sized, [*ty]);
1889
1890                 self.prove_trait_ref(
1891                     trait_ref,
1892                     location.to_locations(),
1893                     ConstraintCategory::SizedBound,
1894                 );
1895             }
1896
1897             Rvalue::Cast(cast_kind, op, ty) => {
1898                 self.check_operand(op, location);
1899
1900                 match cast_kind {
1901                     CastKind::Pointer(PointerCast::ReifyFnPointer) => {
1902                         let fn_sig = op.ty(body, tcx).fn_sig(tcx);
1903
1904                         // The type that we see in the fcx is like
1905                         // `foo::<'a, 'b>`, where `foo` is the path to a
1906                         // function definition. When we extract the
1907                         // signature, it comes from the `fn_sig` query,
1908                         // and hence may contain unnormalized results.
1909                         let fn_sig = self.normalize(fn_sig, location);
1910
1911                         let ty_fn_ptr_from = tcx.mk_fn_ptr(fn_sig);
1912
1913                         if let Err(terr) = self.eq_types(
1914                             *ty,
1915                             ty_fn_ptr_from,
1916                             location.to_locations(),
1917                             ConstraintCategory::Cast,
1918                         ) {
1919                             span_mirbug!(
1920                                 self,
1921                                 rvalue,
1922                                 "equating {:?} with {:?} yields {:?}",
1923                                 ty_fn_ptr_from,
1924                                 ty,
1925                                 terr
1926                             );
1927                         }
1928                     }
1929
1930                     CastKind::Pointer(PointerCast::ClosureFnPointer(unsafety)) => {
1931                         let sig = match op.ty(body, tcx).kind() {
1932                             ty::Closure(_, substs) => substs.as_closure().sig(),
1933                             _ => bug!(),
1934                         };
1935                         let ty_fn_ptr_from = tcx.mk_fn_ptr(tcx.signature_unclosure(sig, *unsafety));
1936
1937                         if let Err(terr) = self.eq_types(
1938                             *ty,
1939                             ty_fn_ptr_from,
1940                             location.to_locations(),
1941                             ConstraintCategory::Cast,
1942                         ) {
1943                             span_mirbug!(
1944                                 self,
1945                                 rvalue,
1946                                 "equating {:?} with {:?} yields {:?}",
1947                                 ty_fn_ptr_from,
1948                                 ty,
1949                                 terr
1950                             );
1951                         }
1952                     }
1953
1954                     CastKind::Pointer(PointerCast::UnsafeFnPointer) => {
1955                         let fn_sig = op.ty(body, tcx).fn_sig(tcx);
1956
1957                         // The type that we see in the fcx is like
1958                         // `foo::<'a, 'b>`, where `foo` is the path to a
1959                         // function definition. When we extract the
1960                         // signature, it comes from the `fn_sig` query,
1961                         // and hence may contain unnormalized results.
1962                         let fn_sig = self.normalize(fn_sig, location);
1963
1964                         let ty_fn_ptr_from = tcx.safe_to_unsafe_fn_ty(fn_sig);
1965
1966                         if let Err(terr) = self.eq_types(
1967                             *ty,
1968                             ty_fn_ptr_from,
1969                             location.to_locations(),
1970                             ConstraintCategory::Cast,
1971                         ) {
1972                             span_mirbug!(
1973                                 self,
1974                                 rvalue,
1975                                 "equating {:?} with {:?} yields {:?}",
1976                                 ty_fn_ptr_from,
1977                                 ty,
1978                                 terr
1979                             );
1980                         }
1981                     }
1982
1983                     CastKind::Pointer(PointerCast::Unsize) => {
1984                         let &ty = ty;
1985                         let trait_ref = tcx
1986                             .at(span)
1987                             .mk_trait_ref(LangItem::CoerceUnsized, [op.ty(body, tcx), ty]);
1988
1989                         self.prove_trait_ref(
1990                             trait_ref,
1991                             location.to_locations(),
1992                             ConstraintCategory::Cast,
1993                         );
1994                     }
1995
1996                     CastKind::DynStar => {
1997                         // get the constraints from the target type (`dyn* Clone`)
1998                         //
1999                         // apply them to prove that the source type `Foo` implements `Clone` etc
2000                         let (existential_predicates, region) = match ty.kind() {
2001                             Dynamic(predicates, region, ty::DynStar) => (predicates, region),
2002                             _ => panic!("Invalid dyn* cast_ty"),
2003                         };
2004
2005                         let self_ty = op.ty(body, tcx);
2006
2007                         self.prove_predicates(
2008                             existential_predicates
2009                                 .iter()
2010                                 .map(|predicate| predicate.with_self_ty(tcx, self_ty)),
2011                             location.to_locations(),
2012                             ConstraintCategory::Cast,
2013                         );
2014
2015                         let outlives_predicate =
2016                             tcx.mk_predicate(Binder::dummy(ty::PredicateKind::Clause(
2017                                 ty::Clause::TypeOutlives(ty::OutlivesPredicate(self_ty, *region)),
2018                             )));
2019                         self.prove_predicate(
2020                             outlives_predicate,
2021                             location.to_locations(),
2022                             ConstraintCategory::Cast,
2023                         );
2024                     }
2025
2026                     CastKind::Pointer(PointerCast::MutToConstPointer) => {
2027                         let ty::RawPtr(ty::TypeAndMut {
2028                             ty: ty_from,
2029                             mutbl: hir::Mutability::Mut,
2030                         }) = op.ty(body, tcx).kind() else {
2031                             span_mirbug!(
2032                                 self,
2033                                 rvalue,
2034                                 "unexpected base type for cast {:?}",
2035                                 ty,
2036                             );
2037                             return;
2038                         };
2039                         let ty::RawPtr(ty::TypeAndMut {
2040                             ty: ty_to,
2041                             mutbl: hir::Mutability::Not,
2042                         }) = ty.kind() else {
2043                             span_mirbug!(
2044                                 self,
2045                                 rvalue,
2046                                 "unexpected target type for cast {:?}",
2047                                 ty,
2048                             );
2049                             return;
2050                         };
2051                         if let Err(terr) = self.sub_types(
2052                             *ty_from,
2053                             *ty_to,
2054                             location.to_locations(),
2055                             ConstraintCategory::Cast,
2056                         ) {
2057                             span_mirbug!(
2058                                 self,
2059                                 rvalue,
2060                                 "relating {:?} with {:?} yields {:?}",
2061                                 ty_from,
2062                                 ty_to,
2063                                 terr
2064                             );
2065                         }
2066                     }
2067
2068                     CastKind::Pointer(PointerCast::ArrayToPointer) => {
2069                         let ty_from = op.ty(body, tcx);
2070
2071                         let opt_ty_elem_mut = match ty_from.kind() {
2072                             ty::RawPtr(ty::TypeAndMut { mutbl: array_mut, ty: array_ty }) => {
2073                                 match array_ty.kind() {
2074                                     ty::Array(ty_elem, _) => Some((ty_elem, *array_mut)),
2075                                     _ => None,
2076                                 }
2077                             }
2078                             _ => None,
2079                         };
2080
2081                         let Some((ty_elem, ty_mut)) = opt_ty_elem_mut else {
2082                             span_mirbug!(
2083                                 self,
2084                                 rvalue,
2085                                 "ArrayToPointer cast from unexpected type {:?}",
2086                                 ty_from,
2087                             );
2088                             return;
2089                         };
2090
2091                         let (ty_to, ty_to_mut) = match ty.kind() {
2092                             ty::RawPtr(ty::TypeAndMut { mutbl: ty_to_mut, ty: ty_to }) => {
2093                                 (ty_to, *ty_to_mut)
2094                             }
2095                             _ => {
2096                                 span_mirbug!(
2097                                     self,
2098                                     rvalue,
2099                                     "ArrayToPointer cast to unexpected type {:?}",
2100                                     ty,
2101                                 );
2102                                 return;
2103                             }
2104                         };
2105
2106                         if ty_to_mut == Mutability::Mut && ty_mut == Mutability::Not {
2107                             span_mirbug!(
2108                                 self,
2109                                 rvalue,
2110                                 "ArrayToPointer cast from const {:?} to mut {:?}",
2111                                 ty,
2112                                 ty_to
2113                             );
2114                             return;
2115                         }
2116
2117                         if let Err(terr) = self.sub_types(
2118                             *ty_elem,
2119                             *ty_to,
2120                             location.to_locations(),
2121                             ConstraintCategory::Cast,
2122                         ) {
2123                             span_mirbug!(
2124                                 self,
2125                                 rvalue,
2126                                 "relating {:?} with {:?} yields {:?}",
2127                                 ty_elem,
2128                                 ty_to,
2129                                 terr
2130                             )
2131                         }
2132                     }
2133
2134                     CastKind::PointerExposeAddress => {
2135                         let ty_from = op.ty(body, tcx);
2136                         let cast_ty_from = CastTy::from_ty(ty_from);
2137                         let cast_ty_to = CastTy::from_ty(*ty);
2138                         match (cast_ty_from, cast_ty_to) {
2139                             (Some(CastTy::Ptr(_) | CastTy::FnPtr), Some(CastTy::Int(_))) => (),
2140                             _ => {
2141                                 span_mirbug!(
2142                                     self,
2143                                     rvalue,
2144                                     "Invalid PointerExposeAddress cast {:?} -> {:?}",
2145                                     ty_from,
2146                                     ty
2147                                 )
2148                             }
2149                         }
2150                     }
2151
2152                     CastKind::PointerFromExposedAddress => {
2153                         let ty_from = op.ty(body, tcx);
2154                         let cast_ty_from = CastTy::from_ty(ty_from);
2155                         let cast_ty_to = CastTy::from_ty(*ty);
2156                         match (cast_ty_from, cast_ty_to) {
2157                             (Some(CastTy::Int(_)), Some(CastTy::Ptr(_))) => (),
2158                             _ => {
2159                                 span_mirbug!(
2160                                     self,
2161                                     rvalue,
2162                                     "Invalid PointerFromExposedAddress cast {:?} -> {:?}",
2163                                     ty_from,
2164                                     ty
2165                                 )
2166                             }
2167                         }
2168                     }
2169                     CastKind::IntToInt => {
2170                         let ty_from = op.ty(body, tcx);
2171                         let cast_ty_from = CastTy::from_ty(ty_from);
2172                         let cast_ty_to = CastTy::from_ty(*ty);
2173                         match (cast_ty_from, cast_ty_to) {
2174                             (Some(CastTy::Int(_)), Some(CastTy::Int(_))) => (),
2175                             _ => {
2176                                 span_mirbug!(
2177                                     self,
2178                                     rvalue,
2179                                     "Invalid IntToInt cast {:?} -> {:?}",
2180                                     ty_from,
2181                                     ty
2182                                 )
2183                             }
2184                         }
2185                     }
2186                     CastKind::IntToFloat => {
2187                         let ty_from = op.ty(body, tcx);
2188                         let cast_ty_from = CastTy::from_ty(ty_from);
2189                         let cast_ty_to = CastTy::from_ty(*ty);
2190                         match (cast_ty_from, cast_ty_to) {
2191                             (Some(CastTy::Int(_)), Some(CastTy::Float)) => (),
2192                             _ => {
2193                                 span_mirbug!(
2194                                     self,
2195                                     rvalue,
2196                                     "Invalid IntToFloat cast {:?} -> {:?}",
2197                                     ty_from,
2198                                     ty
2199                                 )
2200                             }
2201                         }
2202                     }
2203                     CastKind::FloatToInt => {
2204                         let ty_from = op.ty(body, tcx);
2205                         let cast_ty_from = CastTy::from_ty(ty_from);
2206                         let cast_ty_to = CastTy::from_ty(*ty);
2207                         match (cast_ty_from, cast_ty_to) {
2208                             (Some(CastTy::Float), Some(CastTy::Int(_))) => (),
2209                             _ => {
2210                                 span_mirbug!(
2211                                     self,
2212                                     rvalue,
2213                                     "Invalid FloatToInt cast {:?} -> {:?}",
2214                                     ty_from,
2215                                     ty
2216                                 )
2217                             }
2218                         }
2219                     }
2220                     CastKind::FloatToFloat => {
2221                         let ty_from = op.ty(body, tcx);
2222                         let cast_ty_from = CastTy::from_ty(ty_from);
2223                         let cast_ty_to = CastTy::from_ty(*ty);
2224                         match (cast_ty_from, cast_ty_to) {
2225                             (Some(CastTy::Float), Some(CastTy::Float)) => (),
2226                             _ => {
2227                                 span_mirbug!(
2228                                     self,
2229                                     rvalue,
2230                                     "Invalid FloatToFloat cast {:?} -> {:?}",
2231                                     ty_from,
2232                                     ty
2233                                 )
2234                             }
2235                         }
2236                     }
2237                     CastKind::FnPtrToPtr => {
2238                         let ty_from = op.ty(body, tcx);
2239                         let cast_ty_from = CastTy::from_ty(ty_from);
2240                         let cast_ty_to = CastTy::from_ty(*ty);
2241                         match (cast_ty_from, cast_ty_to) {
2242                             (Some(CastTy::FnPtr), Some(CastTy::Ptr(_))) => (),
2243                             _ => {
2244                                 span_mirbug!(
2245                                     self,
2246                                     rvalue,
2247                                     "Invalid FnPtrToPtr cast {:?} -> {:?}",
2248                                     ty_from,
2249                                     ty
2250                                 )
2251                             }
2252                         }
2253                     }
2254                     CastKind::PtrToPtr => {
2255                         let ty_from = op.ty(body, tcx);
2256                         let cast_ty_from = CastTy::from_ty(ty_from);
2257                         let cast_ty_to = CastTy::from_ty(*ty);
2258                         match (cast_ty_from, cast_ty_to) {
2259                             (Some(CastTy::Ptr(_)), Some(CastTy::Ptr(_))) => (),
2260                             _ => {
2261                                 span_mirbug!(
2262                                     self,
2263                                     rvalue,
2264                                     "Invalid PtrToPtr cast {:?} -> {:?}",
2265                                     ty_from,
2266                                     ty
2267                                 )
2268                             }
2269                         }
2270                     }
2271                 }
2272             }
2273
2274             Rvalue::Ref(region, _borrow_kind, borrowed_place) => {
2275                 self.add_reborrow_constraint(&body, location, *region, borrowed_place);
2276             }
2277
2278             Rvalue::BinaryOp(
2279                 BinOp::Eq | BinOp::Ne | BinOp::Lt | BinOp::Le | BinOp::Gt | BinOp::Ge,
2280                 box (left, right),
2281             ) => {
2282                 self.check_operand(left, location);
2283                 self.check_operand(right, location);
2284
2285                 let ty_left = left.ty(body, tcx);
2286                 match ty_left.kind() {
2287                     // Types with regions are comparable if they have a common super-type.
2288                     ty::RawPtr(_) | ty::FnPtr(_) => {
2289                         let ty_right = right.ty(body, tcx);
2290                         let common_ty = self.infcx.next_ty_var(TypeVariableOrigin {
2291                             kind: TypeVariableOriginKind::MiscVariable,
2292                             span: body.source_info(location).span,
2293                         });
2294                         self.sub_types(
2295                             ty_left,
2296                             common_ty,
2297                             location.to_locations(),
2298                             ConstraintCategory::Boring,
2299                         )
2300                         .unwrap_or_else(|err| {
2301                             bug!("Could not equate type variable with {:?}: {:?}", ty_left, err)
2302                         });
2303                         if let Err(terr) = self.sub_types(
2304                             ty_right,
2305                             common_ty,
2306                             location.to_locations(),
2307                             ConstraintCategory::Boring,
2308                         ) {
2309                             span_mirbug!(
2310                                 self,
2311                                 rvalue,
2312                                 "unexpected comparison types {:?} and {:?} yields {:?}",
2313                                 ty_left,
2314                                 ty_right,
2315                                 terr
2316                             )
2317                         }
2318                     }
2319                     // For types with no regions we can just check that the
2320                     // both operands have the same type.
2321                     ty::Int(_) | ty::Uint(_) | ty::Bool | ty::Char | ty::Float(_)
2322                         if ty_left == right.ty(body, tcx) => {}
2323                     // Other types are compared by trait methods, not by
2324                     // `Rvalue::BinaryOp`.
2325                     _ => span_mirbug!(
2326                         self,
2327                         rvalue,
2328                         "unexpected comparison types {:?} and {:?}",
2329                         ty_left,
2330                         right.ty(body, tcx)
2331                     ),
2332                 }
2333             }
2334
2335             Rvalue::Use(operand) | Rvalue::UnaryOp(_, operand) => {
2336                 self.check_operand(operand, location);
2337             }
2338             Rvalue::CopyForDeref(place) => {
2339                 let op = &Operand::Copy(*place);
2340                 self.check_operand(op, location);
2341             }
2342
2343             Rvalue::BinaryOp(_, box (left, right))
2344             | Rvalue::CheckedBinaryOp(_, box (left, right)) => {
2345                 self.check_operand(left, location);
2346                 self.check_operand(right, location);
2347             }
2348
2349             Rvalue::AddressOf(..)
2350             | Rvalue::ThreadLocalRef(..)
2351             | Rvalue::Len(..)
2352             | Rvalue::Discriminant(..) => {}
2353         }
2354     }
2355
2356     /// If this rvalue supports a user-given type annotation, then
2357     /// extract and return it. This represents the final type of the
2358     /// rvalue and will be unified with the inferred type.
2359     fn rvalue_user_ty(&self, rvalue: &Rvalue<'tcx>) -> Option<UserTypeAnnotationIndex> {
2360         match rvalue {
2361             Rvalue::Use(_)
2362             | Rvalue::ThreadLocalRef(_)
2363             | Rvalue::Repeat(..)
2364             | Rvalue::Ref(..)
2365             | Rvalue::AddressOf(..)
2366             | Rvalue::Len(..)
2367             | Rvalue::Cast(..)
2368             | Rvalue::ShallowInitBox(..)
2369             | Rvalue::BinaryOp(..)
2370             | Rvalue::CheckedBinaryOp(..)
2371             | Rvalue::NullaryOp(..)
2372             | Rvalue::CopyForDeref(..)
2373             | Rvalue::UnaryOp(..)
2374             | Rvalue::Discriminant(..) => None,
2375
2376             Rvalue::Aggregate(aggregate, _) => match **aggregate {
2377                 AggregateKind::Adt(_, _, _, user_ty, _) => user_ty,
2378                 AggregateKind::Array(_) => None,
2379                 AggregateKind::Tuple => None,
2380                 AggregateKind::Closure(_, _) => None,
2381                 AggregateKind::Generator(_, _, _) => None,
2382             },
2383         }
2384     }
2385
2386     fn check_aggregate_rvalue(
2387         &mut self,
2388         body: &Body<'tcx>,
2389         rvalue: &Rvalue<'tcx>,
2390         aggregate_kind: &AggregateKind<'tcx>,
2391         operands: &[Operand<'tcx>],
2392         location: Location,
2393     ) {
2394         let tcx = self.tcx();
2395
2396         self.prove_aggregate_predicates(aggregate_kind, location);
2397
2398         if *aggregate_kind == AggregateKind::Tuple {
2399             // tuple rvalue field type is always the type of the op. Nothing to check here.
2400             return;
2401         }
2402
2403         for (i, operand) in operands.iter().enumerate() {
2404             let field_ty = match self.aggregate_field_ty(aggregate_kind, i, location) {
2405                 Ok(field_ty) => field_ty,
2406                 Err(FieldAccessError::OutOfRange { field_count }) => {
2407                     span_mirbug!(
2408                         self,
2409                         rvalue,
2410                         "accessed field #{} but variant only has {}",
2411                         i,
2412                         field_count
2413                     );
2414                     continue;
2415                 }
2416             };
2417             let operand_ty = operand.ty(body, tcx);
2418             let operand_ty = self.normalize(operand_ty, location);
2419
2420             if let Err(terr) = self.sub_types(
2421                 operand_ty,
2422                 field_ty,
2423                 location.to_locations(),
2424                 ConstraintCategory::Boring,
2425             ) {
2426                 span_mirbug!(
2427                     self,
2428                     rvalue,
2429                     "{:?} is not a subtype of {:?}: {:?}",
2430                     operand_ty,
2431                     field_ty,
2432                     terr
2433                 );
2434             }
2435         }
2436     }
2437
2438     /// Adds the constraints that arise from a borrow expression `&'a P` at the location `L`.
2439     ///
2440     /// # Parameters
2441     ///
2442     /// - `location`: the location `L` where the borrow expression occurs
2443     /// - `borrow_region`: the region `'a` associated with the borrow
2444     /// - `borrowed_place`: the place `P` being borrowed
2445     fn add_reborrow_constraint(
2446         &mut self,
2447         body: &Body<'tcx>,
2448         location: Location,
2449         borrow_region: ty::Region<'tcx>,
2450         borrowed_place: &Place<'tcx>,
2451     ) {
2452         // These constraints are only meaningful during borrowck:
2453         let BorrowCheckContext { borrow_set, location_table, all_facts, constraints, .. } =
2454             self.borrowck_context;
2455
2456         // In Polonius mode, we also push a `loan_issued_at` fact
2457         // linking the loan to the region (in some cases, though,
2458         // there is no loan associated with this borrow expression --
2459         // that occurs when we are borrowing an unsafe place, for
2460         // example).
2461         if let Some(all_facts) = all_facts {
2462             let _prof_timer = self.infcx.tcx.prof.generic_activity("polonius_fact_generation");
2463             if let Some(borrow_index) = borrow_set.get_index_of(&location) {
2464                 let region_vid = borrow_region.to_region_vid();
2465                 all_facts.loan_issued_at.push((
2466                     region_vid,
2467                     borrow_index,
2468                     location_table.mid_index(location),
2469                 ));
2470             }
2471         }
2472
2473         // If we are reborrowing the referent of another reference, we
2474         // need to add outlives relationships. In a case like `&mut
2475         // *p`, where the `p` has type `&'b mut Foo`, for example, we
2476         // need to ensure that `'b: 'a`.
2477
2478         debug!(
2479             "add_reborrow_constraint({:?}, {:?}, {:?})",
2480             location, borrow_region, borrowed_place
2481         );
2482
2483         let mut cursor = borrowed_place.projection.as_ref();
2484         let tcx = self.infcx.tcx;
2485         let field = path_utils::is_upvar_field_projection(
2486             tcx,
2487             &self.borrowck_context.upvars,
2488             borrowed_place.as_ref(),
2489             body,
2490         );
2491         let category = if let Some(field) = field {
2492             ConstraintCategory::ClosureUpvar(field)
2493         } else {
2494             ConstraintCategory::Boring
2495         };
2496
2497         while let [proj_base @ .., elem] = cursor {
2498             cursor = proj_base;
2499
2500             debug!("add_reborrow_constraint - iteration {:?}", elem);
2501
2502             match elem {
2503                 ProjectionElem::Deref => {
2504                     let base_ty = Place::ty_from(borrowed_place.local, proj_base, body, tcx).ty;
2505
2506                     debug!("add_reborrow_constraint - base_ty = {:?}", base_ty);
2507                     match base_ty.kind() {
2508                         ty::Ref(ref_region, _, mutbl) => {
2509                             constraints.outlives_constraints.push(OutlivesConstraint {
2510                                 sup: ref_region.to_region_vid(),
2511                                 sub: borrow_region.to_region_vid(),
2512                                 locations: location.to_locations(),
2513                                 span: location.to_locations().span(body),
2514                                 category,
2515                                 variance_info: ty::VarianceDiagInfo::default(),
2516                                 from_closure: false,
2517                             });
2518
2519                             match mutbl {
2520                                 hir::Mutability::Not => {
2521                                     // Immutable reference. We don't need the base
2522                                     // to be valid for the entire lifetime of
2523                                     // the borrow.
2524                                     break;
2525                                 }
2526                                 hir::Mutability::Mut => {
2527                                     // Mutable reference. We *do* need the base
2528                                     // to be valid, because after the base becomes
2529                                     // invalid, someone else can use our mutable deref.
2530
2531                                     // This is in order to make the following function
2532                                     // illegal:
2533                                     // ```
2534                                     // fn unsafe_deref<'a, 'b>(x: &'a &'b mut T) -> &'b mut T {
2535                                     //     &mut *x
2536                                     // }
2537                                     // ```
2538                                     //
2539                                     // As otherwise you could clone `&mut T` using the
2540                                     // following function:
2541                                     // ```
2542                                     // fn bad(x: &mut T) -> (&mut T, &mut T) {
2543                                     //     let my_clone = unsafe_deref(&'a x);
2544                                     //     ENDREGION 'a;
2545                                     //     (my_clone, x)
2546                                     // }
2547                                     // ```
2548                                 }
2549                             }
2550                         }
2551                         ty::RawPtr(..) => {
2552                             // deref of raw pointer, guaranteed to be valid
2553                             break;
2554                         }
2555                         ty::Adt(def, _) if def.is_box() => {
2556                             // deref of `Box`, need the base to be valid - propagate
2557                         }
2558                         _ => bug!("unexpected deref ty {:?} in {:?}", base_ty, borrowed_place),
2559                     }
2560                 }
2561                 ProjectionElem::Field(..)
2562                 | ProjectionElem::Downcast(..)
2563                 | ProjectionElem::OpaqueCast(..)
2564                 | ProjectionElem::Index(..)
2565                 | ProjectionElem::ConstantIndex { .. }
2566                 | ProjectionElem::Subslice { .. } => {
2567                     // other field access
2568                 }
2569             }
2570         }
2571     }
2572
2573     fn prove_aggregate_predicates(
2574         &mut self,
2575         aggregate_kind: &AggregateKind<'tcx>,
2576         location: Location,
2577     ) {
2578         let tcx = self.tcx();
2579
2580         debug!(
2581             "prove_aggregate_predicates(aggregate_kind={:?}, location={:?})",
2582             aggregate_kind, location
2583         );
2584
2585         let (def_id, instantiated_predicates) = match *aggregate_kind {
2586             AggregateKind::Adt(adt_did, _, substs, _, _) => {
2587                 (adt_did, tcx.predicates_of(adt_did).instantiate(tcx, substs))
2588             }
2589
2590             // For closures, we have some **extra requirements** we
2591             // have to check. In particular, in their upvars and
2592             // signatures, closures often reference various regions
2593             // from the surrounding function -- we call those the
2594             // closure's free regions. When we borrow-check (and hence
2595             // region-check) closures, we may find that the closure
2596             // requires certain relationships between those free
2597             // regions. However, because those free regions refer to
2598             // portions of the CFG of their caller, the closure is not
2599             // in a position to verify those relationships. In that
2600             // case, the requirements get "propagated" to us, and so
2601             // we have to solve them here where we instantiate the
2602             // closure.
2603             //
2604             // Despite the opacity of the previous paragraph, this is
2605             // actually relatively easy to understand in terms of the
2606             // desugaring. A closure gets desugared to a struct, and
2607             // these extra requirements are basically like where
2608             // clauses on the struct.
2609             AggregateKind::Closure(def_id, substs)
2610             | AggregateKind::Generator(def_id, substs, _) => {
2611                 (def_id.to_def_id(), self.prove_closure_bounds(tcx, def_id, substs, location))
2612             }
2613
2614             AggregateKind::Array(_) | AggregateKind::Tuple => {
2615                 (CRATE_DEF_ID.to_def_id(), ty::InstantiatedPredicates::empty())
2616             }
2617         };
2618
2619         self.normalize_and_prove_instantiated_predicates(
2620             def_id,
2621             instantiated_predicates,
2622             location.to_locations(),
2623         );
2624     }
2625
2626     fn prove_closure_bounds(
2627         &mut self,
2628         tcx: TyCtxt<'tcx>,
2629         def_id: LocalDefId,
2630         substs: SubstsRef<'tcx>,
2631         location: Location,
2632     ) -> ty::InstantiatedPredicates<'tcx> {
2633         if let Some(ref closure_requirements) = tcx.mir_borrowck(def_id).closure_requirements {
2634             constraint_conversion::ConstraintConversion::new(
2635                 self.infcx,
2636                 self.borrowck_context.universal_regions,
2637                 self.region_bound_pairs,
2638                 self.implicit_region_bound,
2639                 self.param_env,
2640                 location.to_locations(),
2641                 DUMMY_SP,                   // irrelevant; will be overrided.
2642                 ConstraintCategory::Boring, // same as above.
2643                 &mut self.borrowck_context.constraints,
2644             )
2645             .apply_closure_requirements(
2646                 &closure_requirements,
2647                 def_id.to_def_id(),
2648                 substs,
2649             );
2650         }
2651
2652         // Now equate closure substs to regions inherited from `typeck_root_def_id`. Fixes #98589.
2653         let typeck_root_def_id = tcx.typeck_root_def_id(self.body.source.def_id());
2654         let typeck_root_substs = ty::InternalSubsts::identity_for_item(tcx, typeck_root_def_id);
2655
2656         let parent_substs = match tcx.def_kind(def_id) {
2657             DefKind::Closure => substs.as_closure().parent_substs(),
2658             DefKind::Generator => substs.as_generator().parent_substs(),
2659             DefKind::InlineConst => substs.as_inline_const().parent_substs(),
2660             other => bug!("unexpected item {:?}", other),
2661         };
2662         let parent_substs = tcx.mk_substs(parent_substs.iter());
2663
2664         assert_eq!(typeck_root_substs.len(), parent_substs.len());
2665         if let Err(_) = self.eq_substs(
2666             typeck_root_substs,
2667             parent_substs,
2668             location.to_locations(),
2669             ConstraintCategory::BoringNoLocation,
2670         ) {
2671             span_mirbug!(
2672                 self,
2673                 def_id,
2674                 "could not relate closure to parent {:?} != {:?}",
2675                 typeck_root_substs,
2676                 parent_substs
2677             );
2678         }
2679
2680         tcx.predicates_of(def_id).instantiate(tcx, substs)
2681     }
2682
2683     #[instrument(skip(self, body), level = "debug")]
2684     fn typeck_mir(&mut self, body: &Body<'tcx>) {
2685         self.last_span = body.span;
2686         debug!(?body.span);
2687
2688         for (local, local_decl) in body.local_decls.iter_enumerated() {
2689             self.check_local(&body, local, local_decl);
2690         }
2691
2692         for (block, block_data) in body.basic_blocks.iter_enumerated() {
2693             let mut location = Location { block, statement_index: 0 };
2694             for stmt in &block_data.statements {
2695                 if !stmt.source_info.span.is_dummy() {
2696                     self.last_span = stmt.source_info.span;
2697                 }
2698                 self.check_stmt(body, stmt, location);
2699                 location.statement_index += 1;
2700             }
2701
2702             self.check_terminator(&body, block_data.terminator(), location);
2703             self.check_iscleanup(&body, block_data);
2704         }
2705     }
2706 }
2707
2708 trait NormalizeLocation: fmt::Debug + Copy {
2709     fn to_locations(self) -> Locations;
2710 }
2711
2712 impl NormalizeLocation for Locations {
2713     fn to_locations(self) -> Locations {
2714         self
2715     }
2716 }
2717
2718 impl NormalizeLocation for Location {
2719     fn to_locations(self) -> Locations {
2720         Locations::Single(self)
2721     }
2722 }
2723
2724 /// Runs `infcx.instantiate_opaque_types`. Unlike other `TypeOp`s,
2725 /// this is not canonicalized - it directly affects the main `InferCtxt`
2726 /// that we use during MIR borrowchecking.
2727 #[derive(Debug)]
2728 pub(super) struct InstantiateOpaqueType<'tcx> {
2729     pub base_universe: Option<ty::UniverseIndex>,
2730     pub region_constraints: Option<RegionConstraintData<'tcx>>,
2731     pub obligations: Vec<PredicateObligation<'tcx>>,
2732 }
2733
2734 impl<'tcx> TypeOp<'tcx> for InstantiateOpaqueType<'tcx> {
2735     type Output = ();
2736     /// We use this type itself to store the information used
2737     /// when reporting errors. Since this is not a query, we don't
2738     /// re-run anything during error reporting - we just use the information
2739     /// we saved to help extract an error from the already-existing region
2740     /// constraints in our `InferCtxt`
2741     type ErrorInfo = InstantiateOpaqueType<'tcx>;
2742
2743     fn fully_perform(mut self, infcx: &InferCtxt<'tcx>) -> Fallible<TypeOpOutput<'tcx, Self>> {
2744         let (mut output, region_constraints) = scrape_region_constraints(infcx, || {
2745             Ok(InferOk { value: (), obligations: self.obligations.clone() })
2746         })?;
2747         self.region_constraints = Some(region_constraints);
2748         output.error_info = Some(self);
2749         Ok(output)
2750     }
2751 }