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.
6 use std::{fmt, iter, mem};
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;
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,
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,
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;
48 use rustc_mir_dataflow::impls::MaybeInitializedPlaces;
49 use rustc_mir_dataflow::move_paths::MoveData;
50 use rustc_mir_dataflow::ResultsCursor;
52 use crate::session_diagnostics::MoveUnsized;
54 borrow_set::BorrowSet,
55 constraints::{OutlivesConstraint, OutlivesConstraintSet},
56 diagnostics::UniverseInfo,
58 location::LocationTable,
59 member_constraints::MemberConstraintSet,
62 region_infer::values::{
63 LivenessValues, PlaceholderIndex, PlaceholderIndices, RegionValueElements,
65 region_infer::TypeTest,
66 type_check::free_region_relations::{CreateResult, UniversalRegionRelations},
67 universal_regions::{DefiningTy, UniversalRegions},
71 macro_rules! span_mirbug {
72 ($context:expr, $elem:expr, $($message:tt)*) => ({
73 $crate::type_check::mirbug(
77 "broken MIR in {:?} ({:?}): {}",
78 $context.body().source.def_id(),
80 format_args!($($message)*),
86 macro_rules! span_mirbug_and_err {
87 ($context:expr, $elem:expr, $($message:tt)*) => ({
89 span_mirbug!($context, $elem, $($message)*);
96 mod constraint_conversion;
97 pub mod free_region_relations;
99 pub(crate) mod liveness;
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
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.
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>,
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>],
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(),
153 universal_region_relations,
155 normalized_inputs_and_output,
156 } = free_region_relations::create(
159 implicit_region_bound,
164 debug!(?normalized_inputs_and_output);
166 for u in ty::UniverseIndex::ROOT..=infcx.universe() {
167 constraints.universe_causes.insert(u, UniverseInfo::other());
170 let mut borrowck_context = BorrowCheckContext {
175 constraints: &mut constraints,
179 let mut checker = TypeChecker::new(
184 implicit_region_bound,
185 &mut borrowck_context,
188 let errors_reported = {
189 let mut verifier = TypeVerifier::new(&mut checker, promoted);
190 verifier.visit_body(&body);
191 verifier.errors_reported
194 if !errors_reported {
195 // if verifier failed, don't do further checks to avoid ICEs
196 checker.typeck_mir(body);
199 checker.equate_inputs_and_outputs(&body, universal_regions, &normalized_inputs_and_output);
210 translate_outlives_facts(&mut checker);
211 let opaque_type_values = infcx.inner.borrow_mut().opaque_type_storage.take_opaque_types();
213 let opaque_type_values = opaque_type_values
215 .map(|(opaque_type_key, decl)| {
218 Locations::All(body.span),
219 ConstraintCategory::OpaqueType,
222 infcx.register_member_constraints(
226 decl.hidden_type.span,
228 Ok(InferOk { value: (), obligations: vec![] })
230 || "opaque_type_map".to_string(),
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()),
241 hidden_type.ty = infcx.tcx.ty_error_with_guaranteed(reported);
244 (opaque_type_key, (hidden_type, decl.origin))
248 MirTypeckResults { constraints, universal_region_relations, opaque_type_values }
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((
262 location_table.mid_index(from_location),
268 .map(move |location| (constraint.sup, constraint.sub, location)),
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);
284 enum FieldAccessError {
285 OutOfRange { field_count: usize },
288 /// Verifies that MIR types are sane to not crash further checks.
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
293 struct TypeVerifier<'a, 'b, 'tcx> {
294 cx: &'a mut TypeChecker<'b, 'tcx>,
295 promoted: &'b IndexVec<Promoted, Body<'tcx>>,
297 errors_reported: bool,
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;
307 fn visit_place(&mut self, place: &Place<'tcx>, context: PlaceContext, location: Location) {
308 self.sanitize_place(place, location, context);
311 fn visit_constant(&mut self, constant: &Constant<'tcx>, location: Location) {
312 debug!(?constant, ?location, "visit_constant");
314 self.super_constant(constant, location);
315 let ty = self.sanitize_type(constant, constant.literal.ty());
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);
323 .liveness_constraints
324 .add_element(live_region_vid, location);
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()
332 Locations::All(constant.span)
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![] },
341 ConstraintCategory::Boring,
343 let annotation = &self.cx.user_type_annotations[annotation_index];
347 "bad constant user type {:?} vs {:?}: {:?}",
349 constant.literal.ty(),
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)
362 ConstantKind::Unevaluated(uv, _) => Some(uv),
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>,
373 verifier.cx.eq_types(ty, san_ty, locations, ConstraintCategory::Boring)
378 "bad promoted type ({:?}: {:?}): {:?}",
386 if !self.errors_reported {
387 let promoted_body = &self.promoted[promoted];
388 self.sanitize_promoted(promoted_body, location);
390 let promoted_ty = promoted_body.return_ty();
391 check_err(self, promoted_body, ty, promoted_ty);
394 if let Err(terr) = self.cx.fully_perform_op(
396 ConstraintCategory::Boring,
397 self.cx.param_env.and(type_op::ascribe_user_type::AscribeUserType::new(
398 constant.literal.ty(),
400 UserSubsts { substs: uv.substs, user_self_ty: None },
406 "bad constant type {:?} ({:?})",
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;
417 if let Err(terr) = self.cx.eq_types(
421 ConstraintCategory::Boring,
423 span_mirbug!(self, constant, "bad static type {:?} ({:?})", constant, terr);
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(
436 instantiated_predicates,
439 self.cx.param_env = prev;
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);
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);
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() {
463 bug!("{:?} with ref binding has wrong type {}", local, local_decl.ty);
469 if let Err(terr) = self.cx.relate_type_and_user_type(
471 ty::Variance::Invariant,
473 Locations::All(*span),
474 ConstraintCategory::TypeAnnotation,
479 "bad user type on variable {:?}: {:?} != {:?} ({:?})",
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);
495 if self.errors_reported {
498 self.super_body(body);
502 impl<'a, 'b, 'tcx> TypeVerifier<'a, 'b, 'tcx> {
504 cx: &'a mut TypeChecker<'b, 'tcx>,
505 promoted: &'b IndexVec<Promoted, Body<'tcx>>,
507 TypeVerifier { promoted, last_span: cx.body.span, cx, errors_reported: false }
510 fn body(&self) -> &Body<'tcx> {
514 fn tcx(&self) -> TyCtxt<'tcx> {
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)
526 /// Checks that the types internal to the `place` match up with
527 /// what would be expected.
532 context: PlaceContext,
534 debug!("sanitize_place: {:?}", place);
536 let mut place_ty = PlaceTy::from_ty(self.body().local_decls[place.local].ty);
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());
545 place_ty = self.sanitize_projection(place_ty, elem, place, location);
548 if let PlaceContext::NonMutatingUse(NonMutatingUseContext::Copy) = context {
549 let tcx = self.tcx();
550 let trait_ref = ty::TraitRef {
551 def_id: tcx.require_lang_item(LangItem::Copy, Some(self.last_span)),
552 substs: tcx.mk_substs_trait(place_ty.ty, &[]),
555 // To have a `Copy` operand, the type `T` of the
556 // value must be `Copy`. Note that we prove that `T: Copy`,
557 // rather than using the `is_copy_modulo_regions`
558 // test. This is important because
559 // `is_copy_modulo_regions` ignores the resulting region
560 // obligations and assumes they pass. This can result in
561 // bounds from `Copy` impls being unsoundly ignored (e.g.,
562 // #29149). Note that we decide to use `Copy` before knowing
563 // whether the bounds fully apply: in effect, the rule is
564 // that if a value of some type could implement `Copy`, then
566 self.cx.prove_trait_ref(
568 location.to_locations(),
569 ConstraintCategory::CopyBound,
576 fn sanitize_promoted(&mut self, promoted_body: &'b Body<'tcx>, location: Location) {
577 // Determine the constraints from the promoted MIR by running the type
578 // checker on the promoted MIR, then transfer the constraints back to
579 // the main MIR, changing the locations to the provided location.
581 let parent_body = mem::replace(&mut self.cx.body, promoted_body);
583 // Use new sets of constraints and closure bounds so that we can
584 // modify their locations.
585 let all_facts = &mut None;
586 let mut constraints = Default::default();
587 let mut liveness_constraints =
588 LivenessValues::new(Rc::new(RegionValueElements::new(&promoted_body)));
589 // Don't try to add borrow_region facts for the promoted MIR
591 let mut swap_constraints = |this: &mut Self| {
592 mem::swap(this.cx.borrowck_context.all_facts, all_facts);
594 &mut this.cx.borrowck_context.constraints.outlives_constraints,
598 &mut this.cx.borrowck_context.constraints.liveness_constraints,
599 &mut liveness_constraints,
603 swap_constraints(self);
605 self.visit_body(&promoted_body);
607 if !self.errors_reported {
608 // if verifier failed, don't do further checks to avoid ICEs
609 self.cx.typeck_mir(promoted_body);
612 self.cx.body = parent_body;
613 // Merge the outlives constraints back in, at the given location.
614 swap_constraints(self);
616 let locations = location.to_locations();
617 for constraint in constraints.outlives().iter() {
618 let mut constraint = constraint.clone();
619 constraint.locations = locations;
620 if let ConstraintCategory::Return(_)
621 | ConstraintCategory::UseAsConst
622 | ConstraintCategory::UseAsStatic = constraint.category
624 // "Returning" from a promoted is an assignment to a
625 // temporary from the user's point of view.
626 constraint.category = ConstraintCategory::Boring;
628 self.cx.borrowck_context.constraints.outlives_constraints.push(constraint)
630 for region in liveness_constraints.rows() {
631 // If the region is live at at least one location in the promoted MIR,
632 // then add a liveness constraint to the main MIR for this region
633 // at the location provided as an argument to this method
634 if liveness_constraints.get_elements(region).next().is_some() {
638 .liveness_constraints
639 .add_element(region, location);
644 fn sanitize_projection(
651 debug!("sanitize_projection: {:?} {:?} {:?}", base, pi, place);
652 let tcx = self.tcx();
653 let base_ty = base.ty;
655 ProjectionElem::Deref => {
656 let deref_ty = base_ty.builtin_deref(true);
657 PlaceTy::from_ty(deref_ty.map(|t| t.ty).unwrap_or_else(|| {
658 span_mirbug_and_err!(self, place, "deref of non-pointer {:?}", base_ty)
661 ProjectionElem::Index(i) => {
662 let index_ty = Place::from(i).ty(self.body(), tcx).ty;
663 if index_ty != tcx.types.usize {
664 PlaceTy::from_ty(span_mirbug_and_err!(self, i, "index by non-usize {:?}", i))
666 PlaceTy::from_ty(base_ty.builtin_index().unwrap_or_else(|| {
667 span_mirbug_and_err!(self, place, "index of non-array {:?}", base_ty)
671 ProjectionElem::ConstantIndex { .. } => {
672 // consider verifying in-bounds
673 PlaceTy::from_ty(base_ty.builtin_index().unwrap_or_else(|| {
674 span_mirbug_and_err!(self, place, "index of non-array {:?}", base_ty)
677 ProjectionElem::Subslice { from, to, from_end } => {
678 PlaceTy::from_ty(match base_ty.kind() {
679 ty::Array(inner, _) => {
680 assert!(!from_end, "array subslices should not use from_end");
681 tcx.mk_array(*inner, to - from)
684 assert!(from_end, "slice subslices should use from_end");
687 _ => span_mirbug_and_err!(self, place, "slice of non-array {:?}", base_ty),
690 ProjectionElem::Downcast(maybe_name, index) => match base_ty.kind() {
691 ty::Adt(adt_def, _substs) if adt_def.is_enum() => {
692 if index.as_usize() >= adt_def.variants().len() {
693 PlaceTy::from_ty(span_mirbug_and_err!(
696 "cast to variant #{:?} but enum only has {:?}",
698 adt_def.variants().len()
701 PlaceTy { ty: base_ty, variant_index: Some(index) }
704 // We do not need to handle generators here, because this runs
705 // before the generator transform stage.
707 let ty = if let Some(name) = maybe_name {
708 span_mirbug_and_err!(
711 "can't downcast {:?} as {:?}",
716 span_mirbug_and_err!(self, place, "can't downcast {:?}", base_ty)
721 ProjectionElem::Field(field, fty) => {
722 let fty = self.sanitize_type(place, fty);
723 let fty = self.cx.normalize(fty, location);
724 match self.field_ty(place, base, field, location) {
726 let ty = self.cx.normalize(ty, location);
727 if let Err(terr) = self.cx.eq_types(
730 location.to_locations(),
731 ConstraintCategory::Boring,
736 "bad field access ({:?}: {:?}): {:?}",
743 Err(FieldAccessError::OutOfRange { field_count }) => span_mirbug!(
746 "accessed field #{} but variant only has {}",
751 PlaceTy::from_ty(fty)
753 ProjectionElem::OpaqueCast(ty) => {
754 let ty = self.sanitize_type(place, ty);
755 let ty = self.cx.normalize(ty, location);
760 location.to_locations(),
761 ConstraintCategory::TypeAnnotation,
769 fn error(&mut self) -> Ty<'tcx> {
770 self.errors_reported = true;
771 self.tcx().ty_error()
776 parent: &dyn fmt::Debug,
777 base_ty: PlaceTy<'tcx>,
780 ) -> Result<Ty<'tcx>, FieldAccessError> {
781 let tcx = self.tcx();
783 let (variant, substs) = match base_ty {
784 PlaceTy { ty, variant_index: Some(variant_index) } => match *ty.kind() {
785 ty::Adt(adt_def, substs) => (adt_def.variant(variant_index), substs),
786 ty::Generator(def_id, substs, _) => {
787 let mut variants = substs.as_generator().state_tys(def_id, tcx);
788 let Some(mut variant) = variants.nth(variant_index.into()) else {
790 "variant_index of generator out of range: {:?}/{:?}",
792 substs.as_generator().state_tys(def_id, tcx).count()
795 return match variant.nth(field.index()) {
797 None => Err(FieldAccessError::OutOfRange { field_count: variant.count() }),
800 _ => bug!("can't have downcast of non-adt non-generator type"),
802 PlaceTy { ty, variant_index: None } => match *ty.kind() {
803 ty::Adt(adt_def, substs) if !adt_def.is_enum() => {
804 (adt_def.variant(VariantIdx::new(0)), substs)
806 ty::Closure(_, substs) => {
814 None => Err(FieldAccessError::OutOfRange {
815 field_count: substs.as_closure().upvar_tys().count(),
819 ty::Generator(_, substs, _) => {
820 // Only prefix fields (upvars and current state) are
821 // accessible without a variant index.
822 return match substs.as_generator().prefix_tys().nth(field.index()) {
824 None => Err(FieldAccessError::OutOfRange {
825 field_count: substs.as_generator().prefix_tys().count(),
830 return match tys.get(field.index()) {
832 None => Err(FieldAccessError::OutOfRange { field_count: tys.len() }),
836 return Ok(span_mirbug_and_err!(
839 "can't project out of {:?}",
846 if let Some(field) = variant.fields.get(field.index()) {
847 Ok(self.cx.normalize(field.ty(tcx, substs), location))
849 Err(FieldAccessError::OutOfRange { field_count: variant.fields.len() })
854 /// The MIR type checker. Visits the MIR and enforces all the
855 /// constraints needed for it to be valid and well-typed. Along the
856 /// way, it accrues region constraints -- these can later be used by
857 /// NLL region checking.
858 struct TypeChecker<'a, 'tcx> {
859 infcx: &'a InferCtxt<'tcx>,
860 param_env: ty::ParamEnv<'tcx>,
862 body: &'a Body<'tcx>,
863 /// User type annotations are shared between the main MIR and the MIR of
864 /// all of the promoted items.
865 user_type_annotations: &'a CanonicalUserTypeAnnotations<'tcx>,
866 region_bound_pairs: &'a RegionBoundPairs<'tcx>,
867 implicit_region_bound: ty::Region<'tcx>,
868 reported_errors: FxHashSet<(Ty<'tcx>, Span)>,
869 borrowck_context: &'a mut BorrowCheckContext<'a, 'tcx>,
872 struct BorrowCheckContext<'a, 'tcx> {
873 pub(crate) universal_regions: &'a UniversalRegions<'tcx>,
874 location_table: &'a LocationTable,
875 all_facts: &'a mut Option<AllFacts>,
876 borrow_set: &'a BorrowSet<'tcx>,
877 pub(crate) constraints: &'a mut MirTypeckRegionConstraints<'tcx>,
878 upvars: &'a [Upvar<'tcx>],
881 pub(crate) struct MirTypeckResults<'tcx> {
882 pub(crate) constraints: MirTypeckRegionConstraints<'tcx>,
883 pub(crate) universal_region_relations: Frozen<UniversalRegionRelations<'tcx>>,
884 pub(crate) opaque_type_values:
885 VecMap<OpaqueTypeKey<'tcx>, (OpaqueHiddenType<'tcx>, OpaqueTyOrigin)>,
888 /// A collection of region constraints that must be satisfied for the
889 /// program to be considered well-typed.
890 pub(crate) struct MirTypeckRegionConstraints<'tcx> {
891 /// Maps from a `ty::Placeholder` to the corresponding
892 /// `PlaceholderIndex` bit that we will use for it.
894 /// To keep everything in sync, do not insert this set
895 /// directly. Instead, use the `placeholder_region` helper.
896 pub(crate) placeholder_indices: PlaceholderIndices,
898 /// Each time we add a placeholder to `placeholder_indices`, we
899 /// also create a corresponding "representative" region vid for
900 /// that wraps it. This vector tracks those. This way, when we
901 /// convert the same `ty::RePlaceholder(p)` twice, we can map to
902 /// the same underlying `RegionVid`.
903 pub(crate) placeholder_index_to_region: IndexVec<PlaceholderIndex, ty::Region<'tcx>>,
905 /// In general, the type-checker is not responsible for enforcing
906 /// liveness constraints; this job falls to the region inferencer,
907 /// which performs a liveness analysis. However, in some limited
908 /// cases, the MIR type-checker creates temporary regions that do
909 /// not otherwise appear in the MIR -- in particular, the
910 /// late-bound regions that it instantiates at call-sites -- and
911 /// hence it must report on their liveness constraints.
912 pub(crate) liveness_constraints: LivenessValues<RegionVid>,
914 pub(crate) outlives_constraints: OutlivesConstraintSet<'tcx>,
916 pub(crate) member_constraints: MemberConstraintSet<'tcx, RegionVid>,
918 pub(crate) universe_causes: FxHashMap<ty::UniverseIndex, UniverseInfo<'tcx>>,
920 pub(crate) type_tests: Vec<TypeTest<'tcx>>,
923 impl<'tcx> MirTypeckRegionConstraints<'tcx> {
924 fn placeholder_region(
926 infcx: &InferCtxt<'tcx>,
927 placeholder: ty::PlaceholderRegion,
928 ) -> ty::Region<'tcx> {
929 let placeholder_index = self.placeholder_indices.insert(placeholder);
930 match self.placeholder_index_to_region.get(placeholder_index) {
933 let origin = NllRegionVariableOrigin::Placeholder(placeholder);
934 let region = infcx.next_nll_region_var_in_universe(origin, placeholder.universe);
935 self.placeholder_index_to_region.push(region);
942 /// The `Locations` type summarizes *where* region constraints are
943 /// required to hold. Normally, this is at a particular point which
944 /// created the obligation, but for constraints that the user gave, we
945 /// want the constraint to hold at all points.
946 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
948 /// Indicates that a type constraint should always be true. This
949 /// is particularly important in the new borrowck analysis for
950 /// things like the type of the return slot. Consider this
953 /// ```compile_fail,E0515
954 /// fn foo<'a>(x: &'a u32) -> &'a u32 {
956 /// return &y; // error
960 /// Here, we wind up with the signature from the return type being
961 /// something like `&'1 u32` where `'1` is a universal region. But
962 /// the type of the return slot `_0` is something like `&'2 u32`
963 /// where `'2` is an existential region variable. The type checker
964 /// requires that `&'2 u32 = &'1 u32` -- but at what point? In the
965 /// older NLL analysis, we required this only at the entry point
966 /// to the function. By the nature of the constraints, this wound
967 /// up propagating to all points reachable from start (because
968 /// `'1` -- as a universal region -- is live everywhere). In the
969 /// newer analysis, though, this doesn't work: `_0` is considered
970 /// dead at the start (it has no usable value) and hence this type
971 /// equality is basically a no-op. Then, later on, when we do `_0
972 /// = &'3 y`, that region `'3` never winds up related to the
973 /// universal region `'1` and hence no error occurs. Therefore, we
974 /// use Locations::All instead, which ensures that the `'1` and
975 /// `'2` are equal everything. We also use this for other
976 /// user-given type annotations; e.g., if the user wrote `let mut
977 /// x: &'static u32 = ...`, we would ensure that all values
978 /// assigned to `x` are of `'static` lifetime.
980 /// The span points to the place the constraint arose. For example,
981 /// it points to the type in a user-given type annotation. If
982 /// there's no sensible span then it's DUMMY_SP.
985 /// An outlives constraint that only has to hold at a single location,
986 /// usually it represents a point where references flow from one spot to
987 /// another (e.g., `x = y`)
992 pub fn from_location(&self) -> Option<Location> {
994 Locations::All(_) => None,
995 Locations::Single(from_location) => Some(*from_location),
999 /// Gets a span representing the location.
1000 pub fn span(&self, body: &Body<'_>) -> Span {
1002 Locations::All(span) => *span,
1003 Locations::Single(l) => body.source_info(*l).span,
1008 impl<'a, 'tcx> TypeChecker<'a, 'tcx> {
1010 infcx: &'a InferCtxt<'tcx>,
1011 body: &'a Body<'tcx>,
1012 param_env: ty::ParamEnv<'tcx>,
1013 region_bound_pairs: &'a RegionBoundPairs<'tcx>,
1014 implicit_region_bound: ty::Region<'tcx>,
1015 borrowck_context: &'a mut BorrowCheckContext<'a, 'tcx>,
1017 let mut checker = Self {
1019 last_span: DUMMY_SP,
1021 user_type_annotations: &body.user_type_annotations,
1024 implicit_region_bound,
1026 reported_errors: Default::default(),
1028 checker.check_user_type_annotations();
1032 fn body(&self) -> &Body<'tcx> {
1036 fn unsized_feature_enabled(&self) -> bool {
1037 let features = self.tcx().features();
1038 features.unsized_locals || features.unsized_fn_params
1041 /// Equate the inferred type and the annotated type for user type annotations
1042 #[instrument(skip(self), level = "debug")]
1043 fn check_user_type_annotations(&mut self) {
1044 debug!(?self.user_type_annotations);
1045 for user_annotation in self.user_type_annotations {
1046 let CanonicalUserTypeAnnotation { span, ref user_ty, inferred_ty } = *user_annotation;
1047 let inferred_ty = self.normalize(inferred_ty, Locations::All(span));
1048 let annotation = self.instantiate_canonical_with_fresh_inference_vars(span, user_ty);
1049 debug!(?annotation);
1051 UserType::Ty(mut ty) => {
1052 ty = self.normalize(ty, Locations::All(span));
1054 if let Err(terr) = self.eq_types(
1057 Locations::All(span),
1058 ConstraintCategory::BoringNoLocation,
1063 "bad user type ({:?} = {:?}): {:?}",
1070 self.prove_predicate(
1071 ty::Binder::dummy(ty::PredicateKind::WellFormed(inferred_ty.into())),
1072 Locations::All(span),
1073 ConstraintCategory::TypeAnnotation,
1076 UserType::TypeOf(def_id, user_substs) => {
1077 if let Err(terr) = self.fully_perform_op(
1078 Locations::All(span),
1079 ConstraintCategory::BoringNoLocation,
1080 self.param_env.and(type_op::ascribe_user_type::AscribeUserType::new(
1089 "bad user type AscribeUserType({:?}, {:?} {:?}, type_of={:?}): {:?}",
1093 self.tcx().type_of(def_id),
1102 #[instrument(skip(self, data), level = "debug")]
1103 fn push_region_constraints(
1105 locations: Locations,
1106 category: ConstraintCategory<'tcx>,
1107 data: &QueryRegionConstraints<'tcx>,
1109 debug!("constraints generated: {:#?}", data);
1111 constraint_conversion::ConstraintConversion::new(
1113 self.borrowck_context.universal_regions,
1114 self.region_bound_pairs,
1115 self.implicit_region_bound,
1118 locations.span(self.body),
1120 &mut self.borrowck_context.constraints,
1125 /// Try to relate `sub <: sup`
1130 locations: Locations,
1131 category: ConstraintCategory<'tcx>,
1133 // Use this order of parameters because the sup type is usually the
1134 // "expected" type in diagnostics.
1135 self.relate_types(sup, ty::Variance::Contravariant, sub, locations, category)
1138 #[instrument(skip(self, category), level = "debug")]
1143 locations: Locations,
1144 category: ConstraintCategory<'tcx>,
1146 self.relate_types(expected, ty::Variance::Invariant, found, locations, category)
1149 #[instrument(skip(self), level = "debug")]
1150 fn relate_type_and_user_type(
1154 user_ty: &UserTypeProjection,
1155 locations: Locations,
1156 category: ConstraintCategory<'tcx>,
1158 let annotated_type = self.user_type_annotations[user_ty.base].inferred_ty;
1159 let mut curr_projected_ty = PlaceTy::from_ty(annotated_type);
1161 let tcx = self.infcx.tcx;
1163 for proj in &user_ty.projs {
1164 let projected_ty = curr_projected_ty.projection_ty_core(
1169 let ty = this.field_ty(tcx, field);
1170 self.normalize(ty, locations)
1172 |_, _| unreachable!(),
1174 curr_projected_ty = projected_ty;
1177 "user_ty base: {:?} freshened: {:?} projs: {:?} yields: {:?}",
1178 user_ty.base, annotated_type, user_ty.projs, curr_projected_ty
1181 let ty = curr_projected_ty.ty;
1182 self.relate_types(ty, v.xform(ty::Variance::Contravariant), a, locations, category)?;
1187 fn tcx(&self) -> TyCtxt<'tcx> {
1191 #[instrument(skip(self, body, location), level = "debug")]
1192 fn check_stmt(&mut self, body: &Body<'tcx>, stmt: &Statement<'tcx>, location: Location) {
1193 let tcx = self.tcx();
1194 debug!("stmt kind: {:?}", stmt.kind);
1196 StatementKind::Assign(box (ref place, ref rv)) => {
1197 // Assignments to temporaries are not "interesting";
1198 // they are not caused by the user, but rather artifacts
1199 // of lowering. Assignments to other sorts of places *are* interesting
1201 let category = match place.as_local() {
1202 Some(RETURN_PLACE) => {
1203 let defining_ty = &self.borrowck_context.universal_regions.defining_ty;
1204 if defining_ty.is_const() {
1205 if tcx.is_static(defining_ty.def_id()) {
1206 ConstraintCategory::UseAsStatic
1208 ConstraintCategory::UseAsConst
1211 ConstraintCategory::Return(ReturnConstraint::Normal)
1216 body.local_decls[l].local_info,
1217 Some(box LocalInfo::AggregateTemp)
1220 ConstraintCategory::Usage
1222 Some(l) if !body.local_decls[l].is_user_variable() => {
1223 ConstraintCategory::Boring
1225 _ => ConstraintCategory::Assignment,
1228 "assignment category: {:?} {:?}",
1230 place.as_local().map(|l| &body.local_decls[l])
1233 let place_ty = place.ty(body, tcx).ty;
1235 let place_ty = self.normalize(place_ty, location);
1236 debug!("place_ty normalized: {:?}", place_ty);
1237 let rv_ty = rv.ty(body, tcx);
1239 let rv_ty = self.normalize(rv_ty, location);
1240 debug!("normalized rv_ty: {:?}", rv_ty);
1242 self.sub_types(rv_ty, place_ty, location.to_locations(), category)
1247 "bad assignment ({:?} = {:?}): {:?}",
1254 if let Some(annotation_index) = self.rvalue_user_ty(rv) {
1255 if let Err(terr) = self.relate_type_and_user_type(
1257 ty::Variance::Invariant,
1258 &UserTypeProjection { base: annotation_index, projs: vec![] },
1259 location.to_locations(),
1260 ConstraintCategory::Boring,
1262 let annotation = &self.user_type_annotations[annotation_index];
1266 "bad user type on rvalue ({:?} = {:?}): {:?}",
1274 self.check_rvalue(body, rv, location);
1275 if !self.unsized_feature_enabled() {
1276 let trait_ref = ty::TraitRef {
1277 def_id: tcx.require_lang_item(LangItem::Sized, Some(self.last_span)),
1278 substs: tcx.mk_substs_trait(place_ty, &[]),
1280 self.prove_trait_ref(
1282 location.to_locations(),
1283 ConstraintCategory::SizedBound,
1287 StatementKind::AscribeUserType(box (ref place, ref projection), variance) => {
1288 let place_ty = place.ty(body, tcx).ty;
1289 if let Err(terr) = self.relate_type_and_user_type(
1293 Locations::All(stmt.source_info.span),
1294 ConstraintCategory::TypeAnnotation,
1296 let annotation = &self.user_type_annotations[projection.base];
1300 "bad type assert ({:?} <: {:?} with projections {:?}): {:?}",
1308 StatementKind::Intrinsic(box ref kind) => match kind {
1309 NonDivergingIntrinsic::Assume(op) => self.check_operand(op, location),
1310 NonDivergingIntrinsic::CopyNonOverlapping(..) => span_bug!(
1311 stmt.source_info.span,
1312 "Unexpected NonDivergingIntrinsic::CopyNonOverlapping, should only appear after lowering_intrinsics",
1315 StatementKind::FakeRead(..)
1316 | StatementKind::StorageLive(..)
1317 | StatementKind::StorageDead(..)
1318 | StatementKind::Retag { .. }
1319 | StatementKind::Coverage(..)
1320 | StatementKind::Nop => {}
1321 StatementKind::Deinit(..) | StatementKind::SetDiscriminant { .. } => {
1322 bug!("Statement not allowed in this MIR phase")
1327 #[instrument(skip(self, body, term_location), level = "debug")]
1328 fn check_terminator(
1331 term: &Terminator<'tcx>,
1332 term_location: Location,
1334 let tcx = self.tcx();
1335 debug!("terminator kind: {:?}", term.kind);
1337 TerminatorKind::Goto { .. }
1338 | TerminatorKind::Resume
1339 | TerminatorKind::Abort
1340 | TerminatorKind::Return
1341 | TerminatorKind::GeneratorDrop
1342 | TerminatorKind::Unreachable
1343 | TerminatorKind::Drop { .. }
1344 | TerminatorKind::FalseEdge { .. }
1345 | TerminatorKind::FalseUnwind { .. }
1346 | TerminatorKind::InlineAsm { .. } => {
1347 // no checks needed for these
1350 TerminatorKind::DropAndReplace { ref place, ref value, target: _, unwind: _ } => {
1351 let place_ty = place.ty(body, tcx).ty;
1352 let rv_ty = value.ty(body, tcx);
1354 let locations = term_location.to_locations();
1356 self.sub_types(rv_ty, place_ty, locations, ConstraintCategory::Assignment)
1361 "bad DropAndReplace ({:?} = {:?}): {:?}",
1368 TerminatorKind::SwitchInt { ref discr, switch_ty, .. } => {
1369 self.check_operand(discr, term_location);
1371 let discr_ty = discr.ty(body, tcx);
1372 if let Err(terr) = self.sub_types(
1375 term_location.to_locations(),
1376 ConstraintCategory::Assignment,
1381 "bad SwitchInt ({:?} on {:?}): {:?}",
1387 if !switch_ty.is_integral() && !switch_ty.is_char() && !switch_ty.is_bool() {
1388 span_mirbug!(self, term, "bad SwitchInt discr ty {:?}", switch_ty);
1390 // FIXME: check the values
1392 TerminatorKind::Call {
1400 self.check_operand(func, term_location);
1402 self.check_operand(arg, term_location);
1405 let func_ty = func.ty(body, tcx);
1406 debug!("func_ty.kind: {:?}", func_ty.kind());
1408 let sig = match func_ty.kind() {
1409 ty::FnDef(..) | ty::FnPtr(_) => func_ty.fn_sig(tcx),
1411 span_mirbug!(self, term, "call to non-function {:?}", func_ty);
1415 let (sig, map) = tcx.replace_late_bound_regions(sig, |br| {
1416 self.infcx.next_region_var(LateBoundRegion(
1417 term.source_info.span,
1419 LateBoundRegionConversionTime::FnCall,
1423 // IMPORTANT: We have to prove well formed for the function signature before
1424 // we normalize it, as otherwise types like `<&'a &'b () as Trait>::Assoc`
1425 // get normalized away, causing us to ignore the `'b: 'a` bound used by the function.
1427 // Normalization results in a well formed type if the input is well formed, so we
1428 // don't have to check it twice.
1430 // See #91068 for an example.
1431 self.prove_predicates(
1432 sig.inputs_and_output
1434 .map(|ty| ty::Binder::dummy(ty::PredicateKind::WellFormed(ty.into()))),
1435 term_location.to_locations(),
1436 ConstraintCategory::Boring,
1438 let sig = self.normalize(sig, term_location);
1439 self.check_call_dest(body, term, &sig, *destination, target, term_location);
1441 // The ordinary liveness rules will ensure that all
1442 // regions in the type of the callee are live here. We
1443 // then further constrain the late-bound regions that
1444 // were instantiated at the call site to be live as
1445 // well. The resulting is that all the input (and
1446 // output) types in the signature must be live, since
1447 // all the inputs that fed into it were live.
1448 for &late_bound_region in map.values() {
1450 self.borrowck_context.universal_regions.to_region_vid(late_bound_region);
1451 self.borrowck_context
1453 .liveness_constraints
1454 .add_element(region_vid, term_location);
1457 self.check_call_inputs(body, term, &sig, args, term_location, from_hir_call);
1459 TerminatorKind::Assert { ref cond, ref msg, .. } => {
1460 self.check_operand(cond, term_location);
1462 let cond_ty = cond.ty(body, tcx);
1463 if cond_ty != tcx.types.bool {
1464 span_mirbug!(self, term, "bad Assert ({:?}, not bool", cond_ty);
1467 if let AssertKind::BoundsCheck { ref len, ref index } = *msg {
1468 if len.ty(body, tcx) != tcx.types.usize {
1469 span_mirbug!(self, len, "bounds-check length non-usize {:?}", len)
1471 if index.ty(body, tcx) != tcx.types.usize {
1472 span_mirbug!(self, index, "bounds-check index non-usize {:?}", index)
1476 TerminatorKind::Yield { ref value, .. } => {
1477 self.check_operand(value, term_location);
1479 let value_ty = value.ty(body, tcx);
1480 match body.yield_ty() {
1481 None => span_mirbug!(self, term, "yield in non-generator"),
1483 if let Err(terr) = self.sub_types(
1486 term_location.to_locations(),
1487 ConstraintCategory::Yield,
1492 "type of yield value is {:?}, but the yield type is {:?}: {:?}",
1507 term: &Terminator<'tcx>,
1508 sig: &ty::FnSig<'tcx>,
1509 destination: Place<'tcx>,
1510 target: Option<BasicBlock>,
1511 term_location: Location,
1513 let tcx = self.tcx();
1516 let dest_ty = destination.ty(body, tcx).ty;
1517 let dest_ty = self.normalize(dest_ty, term_location);
1518 let category = match destination.as_local() {
1519 Some(RETURN_PLACE) => {
1520 if let BorrowCheckContext {
1524 DefiningTy::Const(def_id, _)
1525 | DefiningTy::InlineConst(def_id, _),
1529 } = self.borrowck_context
1531 if tcx.is_static(*def_id) {
1532 ConstraintCategory::UseAsStatic
1534 ConstraintCategory::UseAsConst
1537 ConstraintCategory::Return(ReturnConstraint::Normal)
1540 Some(l) if !body.local_decls[l].is_user_variable() => {
1541 ConstraintCategory::Boring
1543 _ => ConstraintCategory::Assignment,
1546 let locations = term_location.to_locations();
1548 if let Err(terr) = self.sub_types(sig.output(), dest_ty, locations, category) {
1552 "call dest mismatch ({:?} <- {:?}): {:?}",
1559 // When `unsized_fn_params` and `unsized_locals` are both not enabled,
1560 // this check is done at `check_local`.
1561 if self.unsized_feature_enabled() {
1562 let span = term.source_info.span;
1563 self.ensure_place_sized(dest_ty, span);
1569 .conservative_is_privately_uninhabited(self.param_env.and(sig.output()))
1571 span_mirbug!(self, term, "call to converging function {:?} w/o dest", sig);
1577 fn check_call_inputs(
1580 term: &Terminator<'tcx>,
1581 sig: &ty::FnSig<'tcx>,
1582 args: &[Operand<'tcx>],
1583 term_location: Location,
1584 from_hir_call: bool,
1586 debug!("check_call_inputs({:?}, {:?})", sig, args);
1587 if args.len() < sig.inputs().len() || (args.len() > sig.inputs().len() && !sig.c_variadic) {
1588 span_mirbug!(self, term, "call to {:?} with wrong # of args", sig);
1591 let func_ty = if let TerminatorKind::Call { func, .. } = &term.kind {
1592 Some(func.ty(body, self.infcx.tcx))
1598 for (n, (fn_arg, op_arg)) in iter::zip(sig.inputs(), args).enumerate() {
1599 let op_arg_ty = op_arg.ty(body, self.tcx());
1601 let op_arg_ty = self.normalize(op_arg_ty, term_location);
1602 let category = if from_hir_call {
1603 ConstraintCategory::CallArgument(self.infcx.tcx.erase_regions(func_ty))
1605 ConstraintCategory::Boring
1608 self.sub_types(op_arg_ty, *fn_arg, term_location.to_locations(), category)
1613 "bad arg #{:?} ({:?} <- {:?}): {:?}",
1623 fn check_iscleanup(&mut self, body: &Body<'tcx>, block_data: &BasicBlockData<'tcx>) {
1624 let is_cleanup = block_data.is_cleanup;
1625 self.last_span = block_data.terminator().source_info.span;
1626 match block_data.terminator().kind {
1627 TerminatorKind::Goto { target } => {
1628 self.assert_iscleanup(body, block_data, target, is_cleanup)
1630 TerminatorKind::SwitchInt { ref targets, .. } => {
1631 for target in targets.all_targets() {
1632 self.assert_iscleanup(body, block_data, *target, is_cleanup);
1635 TerminatorKind::Resume => {
1637 span_mirbug!(self, block_data, "resume on non-cleanup block!")
1640 TerminatorKind::Abort => {
1642 span_mirbug!(self, block_data, "abort on non-cleanup block!")
1645 TerminatorKind::Return => {
1647 span_mirbug!(self, block_data, "return on cleanup block")
1650 TerminatorKind::GeneratorDrop { .. } => {
1652 span_mirbug!(self, block_data, "generator_drop in cleanup block")
1655 TerminatorKind::Yield { resume, drop, .. } => {
1657 span_mirbug!(self, block_data, "yield in cleanup block")
1659 self.assert_iscleanup(body, block_data, resume, is_cleanup);
1660 if let Some(drop) = drop {
1661 self.assert_iscleanup(body, block_data, drop, is_cleanup);
1664 TerminatorKind::Unreachable => {}
1665 TerminatorKind::Drop { target, unwind, .. }
1666 | TerminatorKind::DropAndReplace { target, unwind, .. }
1667 | TerminatorKind::Assert { target, cleanup: unwind, .. } => {
1668 self.assert_iscleanup(body, block_data, target, is_cleanup);
1669 if let Some(unwind) = unwind {
1671 span_mirbug!(self, block_data, "unwind on cleanup block")
1673 self.assert_iscleanup(body, block_data, unwind, true);
1676 TerminatorKind::Call { ref target, cleanup, .. } => {
1677 if let &Some(target) = target {
1678 self.assert_iscleanup(body, block_data, target, is_cleanup);
1680 if let Some(cleanup) = cleanup {
1682 span_mirbug!(self, block_data, "cleanup on cleanup block")
1684 self.assert_iscleanup(body, block_data, cleanup, true);
1687 TerminatorKind::FalseEdge { real_target, imaginary_target } => {
1688 self.assert_iscleanup(body, block_data, real_target, is_cleanup);
1689 self.assert_iscleanup(body, block_data, imaginary_target, is_cleanup);
1691 TerminatorKind::FalseUnwind { real_target, unwind } => {
1692 self.assert_iscleanup(body, block_data, real_target, is_cleanup);
1693 if let Some(unwind) = unwind {
1695 span_mirbug!(self, block_data, "cleanup in cleanup block via false unwind");
1697 self.assert_iscleanup(body, block_data, unwind, true);
1700 TerminatorKind::InlineAsm { destination, cleanup, .. } => {
1701 if let Some(target) = destination {
1702 self.assert_iscleanup(body, block_data, target, is_cleanup);
1704 if let Some(cleanup) = cleanup {
1706 span_mirbug!(self, block_data, "cleanup on cleanup block")
1708 self.assert_iscleanup(body, block_data, cleanup, true);
1714 fn assert_iscleanup(
1717 ctxt: &dyn fmt::Debug,
1721 if body[bb].is_cleanup != iscleanuppad {
1722 span_mirbug!(self, ctxt, "cleanuppad mismatch: {:?} should be {:?}", bb, iscleanuppad);
1726 fn check_local(&mut self, body: &Body<'tcx>, local: Local, local_decl: &LocalDecl<'tcx>) {
1727 match body.local_kind(local) {
1728 LocalKind::ReturnPointer | LocalKind::Arg => {
1729 // return values of normal functions are required to be
1730 // sized by typeck, but return values of ADT constructors are
1731 // not because we don't include a `Self: Sized` bounds on them.
1733 // Unbound parts of arguments were never required to be Sized
1734 // - maybe we should make that a warning.
1737 LocalKind::Var | LocalKind::Temp => {}
1740 // When `unsized_fn_params` or `unsized_locals` is enabled, only function calls
1741 // and nullary ops are checked in `check_call_dest`.
1742 if !self.unsized_feature_enabled() {
1743 let span = local_decl.source_info.span;
1744 let ty = local_decl.ty;
1745 self.ensure_place_sized(ty, span);
1749 fn ensure_place_sized(&mut self, ty: Ty<'tcx>, span: Span) {
1750 let tcx = self.tcx();
1752 // Erase the regions from `ty` to get a global type. The
1753 // `Sized` bound in no way depends on precise regions, so this
1754 // shouldn't affect `is_sized`.
1755 let erased_ty = tcx.erase_regions(ty);
1756 if !erased_ty.is_sized(tcx, self.param_env) {
1757 // in current MIR construction, all non-control-flow rvalue
1758 // expressions evaluate through `as_temp` or `into` a return
1759 // slot or local, so to find all unsized rvalues it is enough
1760 // to check all temps, return slots and locals.
1761 if self.reported_errors.replace((ty, span)).is_none() {
1762 // While this is located in `nll::typeck` this error is not
1763 // an NLL error, it's a required check to prevent creation
1764 // of unsized rvalues in a call expression.
1765 self.tcx().sess.emit_err(MoveUnsized { ty, span });
1770 fn aggregate_field_ty(
1772 ak: &AggregateKind<'tcx>,
1775 ) -> Result<Ty<'tcx>, FieldAccessError> {
1776 let tcx = self.tcx();
1779 AggregateKind::Adt(adt_did, variant_index, substs, _, active_field_index) => {
1780 let def = tcx.adt_def(adt_did);
1781 let variant = &def.variant(variant_index);
1782 let adj_field_index = active_field_index.unwrap_or(field_index);
1783 if let Some(field) = variant.fields.get(adj_field_index) {
1784 Ok(self.normalize(field.ty(tcx, substs), location))
1786 Err(FieldAccessError::OutOfRange { field_count: variant.fields.len() })
1789 AggregateKind::Closure(_, substs) => {
1790 match substs.as_closure().upvar_tys().nth(field_index) {
1792 None => Err(FieldAccessError::OutOfRange {
1793 field_count: substs.as_closure().upvar_tys().count(),
1797 AggregateKind::Generator(_, substs, _) => {
1798 // It doesn't make sense to look at a field beyond the prefix;
1799 // these require a variant index, and are not initialized in
1800 // aggregate rvalues.
1801 match substs.as_generator().prefix_tys().nth(field_index) {
1803 None => Err(FieldAccessError::OutOfRange {
1804 field_count: substs.as_generator().prefix_tys().count(),
1808 AggregateKind::Array(ty) => Ok(ty),
1809 AggregateKind::Tuple => {
1810 unreachable!("This should have been covered in check_rvalues");
1815 fn check_operand(&mut self, op: &Operand<'tcx>, location: Location) {
1816 debug!(?op, ?location, "check_operand");
1818 if let Operand::Constant(constant) = op {
1819 let maybe_uneval = match constant.literal {
1820 ConstantKind::Val(..) | ConstantKind::Ty(_) => None,
1821 ConstantKind::Unevaluated(uv, _) => Some(uv),
1824 if let Some(uv) = maybe_uneval {
1825 if uv.promoted.is_none() {
1826 let tcx = self.tcx();
1827 let def_id = uv.def.def_id_for_type_of();
1828 if tcx.def_kind(def_id) == DefKind::InlineConst {
1829 let def_id = def_id.expect_local();
1831 self.prove_closure_bounds(tcx, def_id, uv.substs, location);
1832 self.normalize_and_prove_instantiated_predicates(
1835 location.to_locations(),
1843 #[instrument(skip(self, body), level = "debug")]
1844 fn check_rvalue(&mut self, body: &Body<'tcx>, rvalue: &Rvalue<'tcx>, location: Location) {
1845 let tcx = self.tcx();
1848 Rvalue::Aggregate(ak, ops) => {
1850 self.check_operand(op, location);
1852 self.check_aggregate_rvalue(&body, rvalue, ak, ops, location)
1855 Rvalue::Repeat(operand, len) => {
1856 self.check_operand(operand, location);
1858 // If the length cannot be evaluated we must assume that the length can be larger
1860 // If the length is larger than 1, the repeat expression will need to copy the
1861 // element, so we require the `Copy` trait.
1862 if len.try_eval_usize(tcx, self.param_env).map_or(true, |len| len > 1) {
1864 Operand::Copy(..) | Operand::Constant(..) => {
1865 // These are always okay: direct use of a const, or a value that can evidently be copied.
1867 Operand::Move(place) => {
1868 // Make sure that repeated elements implement `Copy`.
1869 let span = body.source_info(location).span;
1870 let ty = place.ty(body, tcx).ty;
1871 let trait_ref = ty::TraitRef::new(
1872 tcx.require_lang_item(LangItem::Copy, Some(span)),
1873 tcx.mk_substs_trait(ty, &[]),
1876 self.prove_trait_ref(
1878 Locations::Single(location),
1879 ConstraintCategory::CopyBound,
1886 &Rvalue::NullaryOp(NullOp::SizeOf | NullOp::AlignOf, ty) => {
1887 let trait_ref = ty::TraitRef {
1888 def_id: tcx.require_lang_item(LangItem::Sized, Some(self.last_span)),
1889 substs: tcx.mk_substs_trait(ty, &[]),
1892 self.prove_trait_ref(
1894 location.to_locations(),
1895 ConstraintCategory::SizedBound,
1899 Rvalue::ShallowInitBox(operand, ty) => {
1900 self.check_operand(operand, location);
1902 let trait_ref = ty::TraitRef {
1903 def_id: tcx.require_lang_item(LangItem::Sized, Some(self.last_span)),
1904 substs: tcx.mk_substs_trait(*ty, &[]),
1907 self.prove_trait_ref(
1909 location.to_locations(),
1910 ConstraintCategory::SizedBound,
1914 Rvalue::Cast(cast_kind, op, ty) => {
1915 self.check_operand(op, location);
1918 CastKind::Pointer(PointerCast::ReifyFnPointer) => {
1919 let fn_sig = op.ty(body, tcx).fn_sig(tcx);
1921 // The type that we see in the fcx is like
1922 // `foo::<'a, 'b>`, where `foo` is the path to a
1923 // function definition. When we extract the
1924 // signature, it comes from the `fn_sig` query,
1925 // and hence may contain unnormalized results.
1926 let fn_sig = self.normalize(fn_sig, location);
1928 let ty_fn_ptr_from = tcx.mk_fn_ptr(fn_sig);
1930 if let Err(terr) = self.eq_types(
1933 location.to_locations(),
1934 ConstraintCategory::Cast,
1939 "equating {:?} with {:?} yields {:?}",
1947 CastKind::Pointer(PointerCast::ClosureFnPointer(unsafety)) => {
1948 let sig = match op.ty(body, tcx).kind() {
1949 ty::Closure(_, substs) => substs.as_closure().sig(),
1952 let ty_fn_ptr_from = tcx.mk_fn_ptr(tcx.signature_unclosure(sig, *unsafety));
1954 if let Err(terr) = self.eq_types(
1957 location.to_locations(),
1958 ConstraintCategory::Cast,
1963 "equating {:?} with {:?} yields {:?}",
1971 CastKind::Pointer(PointerCast::UnsafeFnPointer) => {
1972 let fn_sig = op.ty(body, tcx).fn_sig(tcx);
1974 // The type that we see in the fcx is like
1975 // `foo::<'a, 'b>`, where `foo` is the path to a
1976 // function definition. When we extract the
1977 // signature, it comes from the `fn_sig` query,
1978 // and hence may contain unnormalized results.
1979 let fn_sig = self.normalize(fn_sig, location);
1981 let ty_fn_ptr_from = tcx.safe_to_unsafe_fn_ty(fn_sig);
1983 if let Err(terr) = self.eq_types(
1986 location.to_locations(),
1987 ConstraintCategory::Cast,
1992 "equating {:?} with {:?} yields {:?}",
2000 CastKind::Pointer(PointerCast::Unsize) => {
2002 let trait_ref = ty::TraitRef {
2004 .require_lang_item(LangItem::CoerceUnsized, Some(self.last_span)),
2005 substs: tcx.mk_substs_trait(op.ty(body, tcx), &[ty.into()]),
2008 self.prove_trait_ref(
2010 location.to_locations(),
2011 ConstraintCategory::Cast,
2015 CastKind::DynStar => {
2016 // get the constraints from the target type (`dyn* Clone`)
2018 // apply them to prove that the source type `Foo` implements `Clone` etc
2019 let (existential_predicates, region) = match ty.kind() {
2020 Dynamic(predicates, region, ty::DynStar) => (predicates, region),
2021 _ => panic!("Invalid dyn* cast_ty"),
2024 let self_ty = op.ty(body, tcx);
2026 self.prove_predicates(
2027 existential_predicates
2029 .map(|predicate| predicate.with_self_ty(tcx, self_ty)),
2030 location.to_locations(),
2031 ConstraintCategory::Cast,
2034 let outlives_predicate =
2035 tcx.mk_predicate(Binder::dummy(ty::PredicateKind::TypeOutlives(
2036 ty::OutlivesPredicate(self_ty, *region),
2038 self.prove_predicate(
2040 location.to_locations(),
2041 ConstraintCategory::Cast,
2045 CastKind::Pointer(PointerCast::MutToConstPointer) => {
2046 let ty::RawPtr(ty::TypeAndMut {
2048 mutbl: hir::Mutability::Mut,
2049 }) = op.ty(body, tcx).kind() else {
2053 "unexpected base type for cast {:?}",
2058 let ty::RawPtr(ty::TypeAndMut {
2060 mutbl: hir::Mutability::Not,
2061 }) = ty.kind() else {
2065 "unexpected target type for cast {:?}",
2070 if let Err(terr) = self.sub_types(
2073 location.to_locations(),
2074 ConstraintCategory::Cast,
2079 "relating {:?} with {:?} yields {:?}",
2087 CastKind::Pointer(PointerCast::ArrayToPointer) => {
2088 let ty_from = op.ty(body, tcx);
2090 let opt_ty_elem_mut = match ty_from.kind() {
2091 ty::RawPtr(ty::TypeAndMut { mutbl: array_mut, ty: array_ty }) => {
2092 match array_ty.kind() {
2093 ty::Array(ty_elem, _) => Some((ty_elem, *array_mut)),
2100 let Some((ty_elem, ty_mut)) = opt_ty_elem_mut else {
2104 "ArrayToPointer cast from unexpected type {:?}",
2110 let (ty_to, ty_to_mut) = match ty.kind() {
2111 ty::RawPtr(ty::TypeAndMut { mutbl: ty_to_mut, ty: ty_to }) => {
2118 "ArrayToPointer cast to unexpected type {:?}",
2125 if ty_to_mut == Mutability::Mut && ty_mut == Mutability::Not {
2129 "ArrayToPointer cast from const {:?} to mut {:?}",
2136 if let Err(terr) = self.sub_types(
2139 location.to_locations(),
2140 ConstraintCategory::Cast,
2145 "relating {:?} with {:?} yields {:?}",
2153 CastKind::PointerExposeAddress => {
2154 let ty_from = op.ty(body, tcx);
2155 let cast_ty_from = CastTy::from_ty(ty_from);
2156 let cast_ty_to = CastTy::from_ty(*ty);
2157 match (cast_ty_from, cast_ty_to) {
2158 (Some(CastTy::Ptr(_) | CastTy::FnPtr), Some(CastTy::Int(_))) => (),
2163 "Invalid PointerExposeAddress cast {:?} -> {:?}",
2171 CastKind::PointerFromExposedAddress => {
2172 let ty_from = op.ty(body, tcx);
2173 let cast_ty_from = CastTy::from_ty(ty_from);
2174 let cast_ty_to = CastTy::from_ty(*ty);
2175 match (cast_ty_from, cast_ty_to) {
2176 (Some(CastTy::Int(_)), Some(CastTy::Ptr(_))) => (),
2181 "Invalid PointerFromExposedAddress cast {:?} -> {:?}",
2188 CastKind::IntToInt => {
2189 let ty_from = op.ty(body, tcx);
2190 let cast_ty_from = CastTy::from_ty(ty_from);
2191 let cast_ty_to = CastTy::from_ty(*ty);
2192 match (cast_ty_from, cast_ty_to) {
2193 (Some(CastTy::Int(_)), Some(CastTy::Int(_))) => (),
2198 "Invalid IntToInt cast {:?} -> {:?}",
2205 CastKind::IntToFloat => {
2206 let ty_from = op.ty(body, tcx);
2207 let cast_ty_from = CastTy::from_ty(ty_from);
2208 let cast_ty_to = CastTy::from_ty(*ty);
2209 match (cast_ty_from, cast_ty_to) {
2210 (Some(CastTy::Int(_)), Some(CastTy::Float)) => (),
2215 "Invalid IntToFloat cast {:?} -> {:?}",
2222 CastKind::FloatToInt => {
2223 let ty_from = op.ty(body, tcx);
2224 let cast_ty_from = CastTy::from_ty(ty_from);
2225 let cast_ty_to = CastTy::from_ty(*ty);
2226 match (cast_ty_from, cast_ty_to) {
2227 (Some(CastTy::Float), Some(CastTy::Int(_))) => (),
2232 "Invalid FloatToInt cast {:?} -> {:?}",
2239 CastKind::FloatToFloat => {
2240 let ty_from = op.ty(body, tcx);
2241 let cast_ty_from = CastTy::from_ty(ty_from);
2242 let cast_ty_to = CastTy::from_ty(*ty);
2243 match (cast_ty_from, cast_ty_to) {
2244 (Some(CastTy::Float), Some(CastTy::Float)) => (),
2249 "Invalid FloatToFloat cast {:?} -> {:?}",
2256 CastKind::FnPtrToPtr => {
2257 let ty_from = op.ty(body, tcx);
2258 let cast_ty_from = CastTy::from_ty(ty_from);
2259 let cast_ty_to = CastTy::from_ty(*ty);
2260 match (cast_ty_from, cast_ty_to) {
2261 (Some(CastTy::FnPtr), Some(CastTy::Ptr(_))) => (),
2266 "Invalid FnPtrToPtr cast {:?} -> {:?}",
2273 CastKind::PtrToPtr => {
2274 let ty_from = op.ty(body, tcx);
2275 let cast_ty_from = CastTy::from_ty(ty_from);
2276 let cast_ty_to = CastTy::from_ty(*ty);
2277 match (cast_ty_from, cast_ty_to) {
2278 (Some(CastTy::Ptr(_)), Some(CastTy::Ptr(_))) => (),
2283 "Invalid PtrToPtr cast {:?} -> {:?}",
2293 Rvalue::Ref(region, _borrow_kind, borrowed_place) => {
2294 self.add_reborrow_constraint(&body, location, *region, borrowed_place);
2298 BinOp::Eq | BinOp::Ne | BinOp::Lt | BinOp::Le | BinOp::Gt | BinOp::Ge,
2301 self.check_operand(left, location);
2302 self.check_operand(right, location);
2304 let ty_left = left.ty(body, tcx);
2305 match ty_left.kind() {
2306 // Types with regions are comparable if they have a common super-type.
2307 ty::RawPtr(_) | ty::FnPtr(_) => {
2308 let ty_right = right.ty(body, tcx);
2309 let common_ty = self.infcx.next_ty_var(TypeVariableOrigin {
2310 kind: TypeVariableOriginKind::MiscVariable,
2311 span: body.source_info(location).span,
2316 location.to_locations(),
2317 ConstraintCategory::Boring,
2319 .unwrap_or_else(|err| {
2320 bug!("Could not equate type variable with {:?}: {:?}", ty_left, err)
2322 if let Err(terr) = self.sub_types(
2325 location.to_locations(),
2326 ConstraintCategory::Boring,
2331 "unexpected comparison types {:?} and {:?} yields {:?}",
2338 // For types with no regions we can just check that the
2339 // both operands have the same type.
2340 ty::Int(_) | ty::Uint(_) | ty::Bool | ty::Char | ty::Float(_)
2341 if ty_left == right.ty(body, tcx) => {}
2342 // Other types are compared by trait methods, not by
2343 // `Rvalue::BinaryOp`.
2347 "unexpected comparison types {:?} and {:?}",
2354 Rvalue::Use(operand) | Rvalue::UnaryOp(_, operand) => {
2355 self.check_operand(operand, location);
2357 Rvalue::CopyForDeref(place) => {
2358 let op = &Operand::Copy(*place);
2359 self.check_operand(op, location);
2362 Rvalue::BinaryOp(_, box (left, right))
2363 | Rvalue::CheckedBinaryOp(_, box (left, right)) => {
2364 self.check_operand(left, location);
2365 self.check_operand(right, location);
2368 Rvalue::AddressOf(..)
2369 | Rvalue::ThreadLocalRef(..)
2371 | Rvalue::Discriminant(..) => {}
2375 /// If this rvalue supports a user-given type annotation, then
2376 /// extract and return it. This represents the final type of the
2377 /// rvalue and will be unified with the inferred type.
2378 fn rvalue_user_ty(&self, rvalue: &Rvalue<'tcx>) -> Option<UserTypeAnnotationIndex> {
2381 | Rvalue::ThreadLocalRef(_)
2382 | Rvalue::Repeat(..)
2384 | Rvalue::AddressOf(..)
2387 | Rvalue::ShallowInitBox(..)
2388 | Rvalue::BinaryOp(..)
2389 | Rvalue::CheckedBinaryOp(..)
2390 | Rvalue::NullaryOp(..)
2391 | Rvalue::CopyForDeref(..)
2392 | Rvalue::UnaryOp(..)
2393 | Rvalue::Discriminant(..) => None,
2395 Rvalue::Aggregate(aggregate, _) => match **aggregate {
2396 AggregateKind::Adt(_, _, _, user_ty, _) => user_ty,
2397 AggregateKind::Array(_) => None,
2398 AggregateKind::Tuple => None,
2399 AggregateKind::Closure(_, _) => None,
2400 AggregateKind::Generator(_, _, _) => None,
2405 fn check_aggregate_rvalue(
2408 rvalue: &Rvalue<'tcx>,
2409 aggregate_kind: &AggregateKind<'tcx>,
2410 operands: &[Operand<'tcx>],
2413 let tcx = self.tcx();
2415 self.prove_aggregate_predicates(aggregate_kind, location);
2417 if *aggregate_kind == AggregateKind::Tuple {
2418 // tuple rvalue field type is always the type of the op. Nothing to check here.
2422 for (i, operand) in operands.iter().enumerate() {
2423 let field_ty = match self.aggregate_field_ty(aggregate_kind, i, location) {
2424 Ok(field_ty) => field_ty,
2425 Err(FieldAccessError::OutOfRange { field_count }) => {
2429 "accessed field #{} but variant only has {}",
2436 let operand_ty = operand.ty(body, tcx);
2437 let operand_ty = self.normalize(operand_ty, location);
2439 if let Err(terr) = self.sub_types(
2442 location.to_locations(),
2443 ConstraintCategory::Boring,
2448 "{:?} is not a subtype of {:?}: {:?}",
2457 /// Adds the constraints that arise from a borrow expression `&'a P` at the location `L`.
2461 /// - `location`: the location `L` where the borrow expression occurs
2462 /// - `borrow_region`: the region `'a` associated with the borrow
2463 /// - `borrowed_place`: the place `P` being borrowed
2464 fn add_reborrow_constraint(
2468 borrow_region: ty::Region<'tcx>,
2469 borrowed_place: &Place<'tcx>,
2471 // These constraints are only meaningful during borrowck:
2472 let BorrowCheckContext { borrow_set, location_table, all_facts, constraints, .. } =
2473 self.borrowck_context;
2475 // In Polonius mode, we also push a `loan_issued_at` fact
2476 // linking the loan to the region (in some cases, though,
2477 // there is no loan associated with this borrow expression --
2478 // that occurs when we are borrowing an unsafe place, for
2480 if let Some(all_facts) = all_facts {
2481 let _prof_timer = self.infcx.tcx.prof.generic_activity("polonius_fact_generation");
2482 if let Some(borrow_index) = borrow_set.get_index_of(&location) {
2483 let region_vid = borrow_region.to_region_vid();
2484 all_facts.loan_issued_at.push((
2487 location_table.mid_index(location),
2492 // If we are reborrowing the referent of another reference, we
2493 // need to add outlives relationships. In a case like `&mut
2494 // *p`, where the `p` has type `&'b mut Foo`, for example, we
2495 // need to ensure that `'b: 'a`.
2498 "add_reborrow_constraint({:?}, {:?}, {:?})",
2499 location, borrow_region, borrowed_place
2502 let mut cursor = borrowed_place.projection.as_ref();
2503 let tcx = self.infcx.tcx;
2504 let field = path_utils::is_upvar_field_projection(
2506 &self.borrowck_context.upvars,
2507 borrowed_place.as_ref(),
2510 let category = if let Some(field) = field {
2511 ConstraintCategory::ClosureUpvar(field)
2513 ConstraintCategory::Boring
2516 while let [proj_base @ .., elem] = cursor {
2519 debug!("add_reborrow_constraint - iteration {:?}", elem);
2522 ProjectionElem::Deref => {
2523 let base_ty = Place::ty_from(borrowed_place.local, proj_base, body, tcx).ty;
2525 debug!("add_reborrow_constraint - base_ty = {:?}", base_ty);
2526 match base_ty.kind() {
2527 ty::Ref(ref_region, _, mutbl) => {
2528 constraints.outlives_constraints.push(OutlivesConstraint {
2529 sup: ref_region.to_region_vid(),
2530 sub: borrow_region.to_region_vid(),
2531 locations: location.to_locations(),
2532 span: location.to_locations().span(body),
2534 variance_info: ty::VarianceDiagInfo::default(),
2535 from_closure: false,
2539 hir::Mutability::Not => {
2540 // Immutable reference. We don't need the base
2541 // to be valid for the entire lifetime of
2545 hir::Mutability::Mut => {
2546 // Mutable reference. We *do* need the base
2547 // to be valid, because after the base becomes
2548 // invalid, someone else can use our mutable deref.
2550 // This is in order to make the following function
2553 // fn unsafe_deref<'a, 'b>(x: &'a &'b mut T) -> &'b mut T {
2558 // As otherwise you could clone `&mut T` using the
2559 // following function:
2561 // fn bad(x: &mut T) -> (&mut T, &mut T) {
2562 // let my_clone = unsafe_deref(&'a x);
2571 // deref of raw pointer, guaranteed to be valid
2574 ty::Adt(def, _) if def.is_box() => {
2575 // deref of `Box`, need the base to be valid - propagate
2577 _ => bug!("unexpected deref ty {:?} in {:?}", base_ty, borrowed_place),
2580 ProjectionElem::Field(..)
2581 | ProjectionElem::Downcast(..)
2582 | ProjectionElem::OpaqueCast(..)
2583 | ProjectionElem::Index(..)
2584 | ProjectionElem::ConstantIndex { .. }
2585 | ProjectionElem::Subslice { .. } => {
2586 // other field access
2592 fn prove_aggregate_predicates(
2594 aggregate_kind: &AggregateKind<'tcx>,
2597 let tcx = self.tcx();
2600 "prove_aggregate_predicates(aggregate_kind={:?}, location={:?})",
2601 aggregate_kind, location
2604 let (def_id, instantiated_predicates) = match *aggregate_kind {
2605 AggregateKind::Adt(adt_did, _, substs, _, _) => {
2606 (adt_did, tcx.predicates_of(adt_did).instantiate(tcx, substs))
2609 // For closures, we have some **extra requirements** we
2611 // have to check. In particular, in their upvars and
2612 // signatures, closures often reference various regions
2613 // from the surrounding function -- we call those the
2614 // closure's free regions. When we borrow-check (and hence
2615 // region-check) closures, we may find that the closure
2616 // requires certain relationships between those free
2617 // regions. However, because those free regions refer to
2618 // portions of the CFG of their caller, the closure is not
2619 // in a position to verify those relationships. In that
2620 // case, the requirements get "propagated" to us, and so
2621 // we have to solve them here where we instantiate the
2624 // Despite the opacity of the previous paragraph, this is
2625 // actually relatively easy to understand in terms of the
2626 // desugaring. A closure gets desugared to a struct, and
2627 // these extra requirements are basically like where
2628 // clauses on the struct.
2629 AggregateKind::Closure(def_id, substs)
2630 | AggregateKind::Generator(def_id, substs, _) => {
2631 (def_id.to_def_id(), self.prove_closure_bounds(tcx, def_id, substs, location))
2634 AggregateKind::Array(_) | AggregateKind::Tuple => {
2635 (CRATE_DEF_ID.to_def_id(), ty::InstantiatedPredicates::empty())
2639 self.normalize_and_prove_instantiated_predicates(
2641 instantiated_predicates,
2642 location.to_locations(),
2646 fn prove_closure_bounds(
2650 substs: SubstsRef<'tcx>,
2652 ) -> ty::InstantiatedPredicates<'tcx> {
2653 if let Some(ref closure_requirements) = tcx.mir_borrowck(def_id).closure_requirements {
2654 constraint_conversion::ConstraintConversion::new(
2656 self.borrowck_context.universal_regions,
2657 self.region_bound_pairs,
2658 self.implicit_region_bound,
2660 location.to_locations(),
2661 DUMMY_SP, // irrelevant; will be overrided.
2662 ConstraintCategory::Boring, // same as above.
2663 &mut self.borrowck_context.constraints,
2665 .apply_closure_requirements(
2666 &closure_requirements,
2672 // Now equate closure substs to regions inherited from `typeck_root_def_id`. Fixes #98589.
2673 let typeck_root_def_id = tcx.typeck_root_def_id(self.body.source.def_id());
2674 let typeck_root_substs = ty::InternalSubsts::identity_for_item(tcx, typeck_root_def_id);
2676 let parent_substs = match tcx.def_kind(def_id) {
2677 DefKind::Closure => substs.as_closure().parent_substs(),
2678 DefKind::Generator => substs.as_generator().parent_substs(),
2679 DefKind::InlineConst => substs.as_inline_const().parent_substs(),
2680 other => bug!("unexpected item {:?}", other),
2682 let parent_substs = tcx.mk_substs(parent_substs.iter());
2684 assert_eq!(typeck_root_substs.len(), parent_substs.len());
2685 if let Err(_) = self.eq_substs(
2688 location.to_locations(),
2689 ConstraintCategory::BoringNoLocation,
2694 "could not relate closure to parent {:?} != {:?}",
2700 tcx.predicates_of(def_id).instantiate(tcx, substs)
2703 #[instrument(skip(self, body), level = "debug")]
2704 fn typeck_mir(&mut self, body: &Body<'tcx>) {
2705 self.last_span = body.span;
2708 for (local, local_decl) in body.local_decls.iter_enumerated() {
2709 self.check_local(&body, local, local_decl);
2712 for (block, block_data) in body.basic_blocks.iter_enumerated() {
2713 let mut location = Location { block, statement_index: 0 };
2714 for stmt in &block_data.statements {
2715 if !stmt.source_info.span.is_dummy() {
2716 self.last_span = stmt.source_info.span;
2718 self.check_stmt(body, stmt, location);
2719 location.statement_index += 1;
2722 self.check_terminator(&body, block_data.terminator(), location);
2723 self.check_iscleanup(&body, block_data);
2728 trait NormalizeLocation: fmt::Debug + Copy {
2729 fn to_locations(self) -> Locations;
2732 impl NormalizeLocation for Locations {
2733 fn to_locations(self) -> Locations {
2738 impl NormalizeLocation for Location {
2739 fn to_locations(self) -> Locations {
2740 Locations::Single(self)
2744 /// Runs `infcx.instantiate_opaque_types`. Unlike other `TypeOp`s,
2745 /// this is not canonicalized - it directly affects the main `InferCtxt`
2746 /// that we use during MIR borrowchecking.
2748 pub(super) struct InstantiateOpaqueType<'tcx> {
2749 pub base_universe: Option<ty::UniverseIndex>,
2750 pub region_constraints: Option<RegionConstraintData<'tcx>>,
2751 pub obligations: Vec<PredicateObligation<'tcx>>,
2754 impl<'tcx> TypeOp<'tcx> for InstantiateOpaqueType<'tcx> {
2756 /// We use this type itself to store the information used
2757 /// when reporting errors. Since this is not a query, we don't
2758 /// re-run anything during error reporting - we just use the information
2759 /// we saved to help extract an error from the already-existing region
2760 /// constraints in our `InferCtxt`
2761 type ErrorInfo = InstantiateOpaqueType<'tcx>;
2763 fn fully_perform(mut self, infcx: &InferCtxt<'tcx>) -> Fallible<TypeOpOutput<'tcx, Self>> {
2764 let (mut output, region_constraints) = scrape_region_constraints(infcx, || {
2765 Ok(InferOk { value: (), obligations: self.obligations.clone() })
2767 self.region_constraints = Some(region_constraints);
2768 output.error_info = Some(self);