src/librustc/infer/nll_relate/mod.rs

   1 //! This code is kind of an alternate way of doing subtyping,
   2 //! supertyping, and type equating, distinct from the `combine.rs`
   3 //! code but very similar in its effect and design. Eventually the two
   4 //! ought to be merged. This code is intended for use in NLL and chalk.
   5 //!
   6 //! Here are the key differences:
   7 //!
   8 //! - This code may choose to bypass some checks (e.g., the occurs check)
   9 //!   in the case where we know that there are no unbound type inference
  10 //!   variables. This is the case for NLL, because at NLL time types are fully
  11 //!   inferred up-to regions.
  12 //! - This code uses "universes" to handle higher-ranked regions and
  13 //!   not the leak-check. This is "more correct" than what rustc does
  14 //!   and we are generally migrating in this direction, but NLL had to
  15 //!   get there first.
  16 //!
  17 //! Also, this code assumes that there are no bound types at all, not even
  18 //! free ones. This is ok because:
  19 //! - we are not relating anything quantified over some type variable
  20 //! - we will have instantiated all the bound type vars already (the one
  21 //!   thing we relate in chalk are basically domain goals and their
  22 //!   constituents)
  23
  24 use crate::infer::InferCtxt;
  25 use crate::traits::DomainGoal;
  26 use crate::ty::error::TypeError;
  27 use crate::ty::fold::{TypeFoldable, TypeVisitor};
  28 use crate::ty::relate::{self, Relate, RelateResult, TypeRelation};
  29 use crate::ty::subst::Kind;
  30 use crate::ty::{self, Ty, TyCtxt, InferConst};
  31 use crate::mir::interpret::ConstValue;
  32 use rustc_data_structures::fx::FxHashMap;
  33 use std::fmt::Debug;
  34
  35 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
  36 pub enum NormalizationStrategy {
  37     Lazy,
  38     Eager,
  39 }
  40
  41 pub struct TypeRelating<'me, 'tcx, D>
  42 where
  43     D: TypeRelatingDelegate<'tcx>,
  44 {
  45     infcx: &'me InferCtxt<'me, 'tcx>,
  46
  47     /// Callback to use when we deduce an outlives relationship
  48     delegate: D,
  49
  50     /// How are we relating `a` and `b`?
  51     ///
  52     /// - Covariant means `a <: b`.
  53     /// - Contravariant means `b <: a`.
  54     /// - Invariant means `a == b.
  55     /// - Bivariant means that it doesn't matter.
  56     ambient_variance: ty::Variance,
  57
  58     /// When we pass through a set of binders (e.g., when looking into
  59     /// a `fn` type), we push a new bound region scope onto here. This
  60     /// will contain the instantiated region for each region in those
  61     /// binders. When we then encounter a `ReLateBound(d, br)`, we can
  62     /// use the De Bruijn index `d` to find the right scope, and then
  63     /// bound region name `br` to find the specific instantiation from
  64     /// within that scope. See `replace_bound_region`.
  65     ///
  66     /// This field stores the instantiations for late-bound regions in
  67     /// the `a` type.
  68     a_scopes: Vec<BoundRegionScope<'tcx>>,
  69
  70     /// Same as `a_scopes`, but for the `b` type.
  71     b_scopes: Vec<BoundRegionScope<'tcx>>,
  72 }
  73
  74 pub trait TypeRelatingDelegate<'tcx> {
  75     /// Push a constraint `sup: sub` -- this constraint must be
  76     /// satisfied for the two types to be related. `sub` and `sup` may
  77     /// be regions from the type or new variables created through the
  78     /// delegate.
  79     fn push_outlives(&mut self, sup: ty::Region<'tcx>, sub: ty::Region<'tcx>);
  80
  81     /// Push a domain goal that will need to be proved for the two types to
  82     /// be related. Used for lazy normalization.
  83     fn push_domain_goal(&mut self, domain_goal: DomainGoal<'tcx>);
  84
  85     /// Creates a new universe index. Used when instantiating placeholders.
  86     fn create_next_universe(&mut self) -> ty::UniverseIndex;
  87
  88     /// Creates a new region variable representing a higher-ranked
  89     /// region that is instantiated existentially. This creates an
  90     /// inference variable, typically.
  91     ///
  92     /// So e.g., if you have `for<'a> fn(..) <: for<'b> fn(..)`, then
  93     /// we will invoke this method to instantiate `'a` with an
  94     /// inference variable (though `'b` would be instantiated first,
  95     /// as a placeholder).
  96     fn next_existential_region_var(&mut self) -> ty::Region<'tcx>;
  97
  98     /// Creates a new region variable representing a
  99     /// higher-ranked region that is instantiated universally.
 100     /// This creates a new region placeholder, typically.
 101     ///
 102     /// So e.g., if you have `for<'a> fn(..) <: for<'b> fn(..)`, then
 103     /// we will invoke this method to instantiate `'b` with a
 104     /// placeholder region.
 105     fn next_placeholder_region(&mut self, placeholder: ty::PlaceholderRegion) -> ty::Region<'tcx>;
 106
 107     /// Creates a new existential region in the given universe. This
 108     /// is used when handling subtyping and type variables -- if we
 109     /// have that `?X <: Foo<'a>`, for example, we would instantiate
 110     /// `?X` with a type like `Foo<'?0>` where `'?0` is a fresh
 111     /// existential variable created by this function. We would then
 112     /// relate `Foo<'?0>` with `Foo<'a>` (and probably add an outlives
 113     /// relation stating that `'?0: 'a`).
 114     fn generalize_existential(&mut self, universe: ty::UniverseIndex) -> ty::Region<'tcx>;
 115
 116     /// Define the normalization strategy to use, eager or lazy.
 117     fn normalization() -> NormalizationStrategy;
 118
 119     /// Enables some optimizations if we do not expect inference variables
 120     /// in the RHS of the relation.
 121     fn forbid_inference_vars() -> bool;
 122 }
 123
 124 #[derive(Clone, Debug)]
 125 struct ScopesAndKind<'tcx> {
 126     scopes: Vec<BoundRegionScope<'tcx>>,
 127     kind: Kind<'tcx>,
 128 }
 129
 130 #[derive(Clone, Debug, Default)]
 131 struct BoundRegionScope<'tcx> {
 132     map: FxHashMap<ty::BoundRegion, ty::Region<'tcx>>,
 133 }
 134
 135 #[derive(Copy, Clone)]
 136 struct UniversallyQuantified(bool);
 137
 138 impl<'me, 'tcx, D> TypeRelating<'me, 'tcx, D>
 139 where
 140     D: TypeRelatingDelegate<'tcx>,
 141 {
 142     pub fn new(
 143         infcx: &'me InferCtxt<'me, 'tcx>,
 144         delegate: D,
 145         ambient_variance: ty::Variance,
 146     ) -> Self {
 147         Self {
 148             infcx,
 149             delegate,
 150             ambient_variance,
 151             a_scopes: vec![],
 152             b_scopes: vec![],
 153         }
 154     }
 155
 156     fn ambient_covariance(&self) -> bool {
 157         match self.ambient_variance {
 158             ty::Variance::Covariant | ty::Variance::Invariant => true,
 159             ty::Variance::Contravariant | ty::Variance::Bivariant => false,
 160         }
 161     }
 162
 163     fn ambient_contravariance(&self) -> bool {
 164         match self.ambient_variance {
 165             ty::Variance::Contravariant | ty::Variance::Invariant => true,
 166             ty::Variance::Covariant | ty::Variance::Bivariant => false,
 167         }
 168     }
 169
 170     fn create_scope(
 171         &mut self,
 172         value: &ty::Binder<impl TypeFoldable<'tcx>>,
 173         universally_quantified: UniversallyQuantified,
 174     ) -> BoundRegionScope<'tcx> {
 175         let mut scope = BoundRegionScope::default();
 176
 177         // Create a callback that creates (via the delegate) either an
 178         // existential or placeholder region as needed.
 179         let mut next_region = {
 180             let delegate = &mut self.delegate;
 181             let mut lazy_universe = None;
 182             move |br: ty::BoundRegion| {
 183                 if universally_quantified.0 {
 184                     // The first time this closure is called, create a
 185                     // new universe for the placeholders we will make
 186                     // from here out.
 187                     let universe = lazy_universe.unwrap_or_else(|| {
 188                         let universe = delegate.create_next_universe();
 189                         lazy_universe = Some(universe);
 190                         universe
 191                     });
 192
 193                     let placeholder = ty::PlaceholderRegion { universe, name: br };
 194                     delegate.next_placeholder_region(placeholder)
 195                 } else {
 196                     delegate.next_existential_region_var()
 197                 }
 198             }
 199         };
 200
 201         value.skip_binder().visit_with(&mut ScopeInstantiator {
 202             next_region: &mut next_region,
 203             target_index: ty::INNERMOST,
 204             bound_region_scope: &mut scope,
 205         });
 206
 207         scope
 208     }
 209
 210     /// When we encounter binders during the type traversal, we record
 211     /// the value to substitute for each of the things contained in
 212     /// that binder. (This will be either a universal placeholder or
 213     /// an existential inference variable.) Given the De Bruijn index
 214     /// `debruijn` (and name `br`) of some binder we have now
 215     /// encountered, this routine finds the value that we instantiated
 216     /// the region with; to do so, it indexes backwards into the list
 217     /// of ambient scopes `scopes`.
 218     fn lookup_bound_region(
 219         debruijn: ty::DebruijnIndex,
 220         br: &ty::BoundRegion,
 221         first_free_index: ty::DebruijnIndex,
 222         scopes: &[BoundRegionScope<'tcx>],
 223     ) -> ty::Region<'tcx> {
 224         // The debruijn index is a "reverse index" into the
 225         // scopes listing. So when we have INNERMOST (0), we
 226         // want the *last* scope pushed, and so forth.
 227         let debruijn_index = debruijn.index() - first_free_index.index();
 228         let scope = &scopes[scopes.len() - debruijn_index - 1];
 229
 230         // Find this bound region in that scope to map to a
 231         // particular region.
 232         scope.map[br]
 233     }
 234
 235     /// If `r` is a bound region, find the scope in which it is bound
 236     /// (from `scopes`) and return the value that we instantiated it
 237     /// with. Otherwise just return `r`.
 238     fn replace_bound_region(
 239         &self,
 240         r: ty::Region<'tcx>,
 241         first_free_index: ty::DebruijnIndex,
 242         scopes: &[BoundRegionScope<'tcx>],
 243     ) -> ty::Region<'tcx> {
 244         debug!("replace_bound_regions(scopes={:?})", scopes);
 245         if let ty::ReLateBound(debruijn, br) = r {
 246             Self::lookup_bound_region(*debruijn, br, first_free_index, scopes)
 247         } else {
 248             r
 249         }
 250     }
 251
 252     /// Push a new outlives requirement into our output set of
 253     /// constraints.
 254     fn push_outlives(&mut self, sup: ty::Region<'tcx>, sub: ty::Region<'tcx>) {
 255         debug!("push_outlives({:?}: {:?})", sup, sub);
 256
 257         self.delegate.push_outlives(sup, sub);
 258     }
 259
 260     /// Relate a projection type and some value type lazily. This will always
 261     /// succeed, but we push an additional `ProjectionEq` goal depending
 262     /// on the value type:
 263     /// - if the value type is any type `T` which is not a projection, we push
 264     ///   `ProjectionEq(projection = T)`.
 265     /// - if the value type is another projection `other_projection`, we create
 266     ///   a new inference variable `?U` and push the two goals
 267     ///   `ProjectionEq(projection = ?U)`, `ProjectionEq(other_projection = ?U)`.
 268     fn relate_projection_ty(
 269         &mut self,
 270         projection_ty: ty::ProjectionTy<'tcx>,
 271         value_ty: Ty<'tcx>,
 272     ) -> Ty<'tcx> {
 273         use crate::infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
 274         use crate::traits::WhereClause;
 275         use syntax_pos::DUMMY_SP;
 276
 277         match value_ty.sty {
 278             ty::Projection(other_projection_ty) => {
 279                 let var = self.infcx.next_ty_var(TypeVariableOrigin {
 280                     kind: TypeVariableOriginKind::MiscVariable,
 281                     span: DUMMY_SP,
 282                 });
 283                 self.relate_projection_ty(projection_ty, var);
 284                 self.relate_projection_ty(other_projection_ty, var);
 285                 var
 286             }
 287
 288             _ => {
 289                 let projection = ty::ProjectionPredicate {
 290                     projection_ty,
 291                     ty: value_ty,
 292                 };
 293                 self.delegate
 294                     .push_domain_goal(DomainGoal::Holds(WhereClause::ProjectionEq(projection)));
 295                 value_ty
 296             }
 297         }
 298     }
 299
 300     /// Relate a type inference variable with a value type. This works
 301     /// by creating a "generalization" G of the value where all the
 302     /// lifetimes are replaced with fresh inference values. This
 303     /// genearlization G becomes the value of the inference variable,
 304     /// and is then related in turn to the value. So e.g. if you had
 305     /// `vid = ?0` and `value = &'a u32`, we might first instantiate
 306     /// `?0` to a type like `&'0 u32` where `'0` is a fresh variable,
 307     /// and then relate `&'0 u32` with `&'a u32` (resulting in
 308     /// relations between `'0` and `'a`).
 309     ///
 310     /// The variable `pair` can be either a `(vid, ty)` or `(ty, vid)`
 311     /// -- in other words, it is always a (unresolved) inference
 312     /// variable `vid` and a type `ty` that are being related, but the
 313     /// vid may appear either as the "a" type or the "b" type,
 314     /// depending on where it appears in the tuple. The trait
 315     /// `VidValuePair` lets us work with the vid/type while preserving
 316     /// the "sidedness" when necessary -- the sidedness is relevant in
 317     /// particular for the variance and set of in-scope things.
 318     fn relate_ty_var<PAIR: VidValuePair<'tcx>>(
 319         &mut self,
 320         pair: PAIR,
 321     ) -> RelateResult<'tcx, Ty<'tcx>> {
 322         debug!("relate_ty_var({:?})", pair);
 323
 324         let vid = pair.vid();
 325         let value_ty = pair.value_ty();
 326
 327         // FIXME -- this logic assumes invariance, but that is wrong.
 328         // This only presently applies to chalk integration, as NLL
 329         // doesn't permit type variables to appear on both sides (and
 330         // doesn't use lazy norm).
 331         match value_ty.sty {
 332             ty::Infer(ty::TyVar(value_vid)) => {
 333                 // Two type variables: just equate them.
 334                 self.infcx
 335                     .type_variables
 336                     .borrow_mut()
 337                     .equate(vid, value_vid);
 338                 return Ok(value_ty);
 339             }
 340
 341             ty::Projection(projection_ty) if D::normalization() == NormalizationStrategy::Lazy => {
 342                 return Ok(self.relate_projection_ty(projection_ty, self.infcx.tcx.mk_ty_var(vid)));
 343             }
 344
 345             _ => (),
 346         }
 347
 348         let generalized_ty = self.generalize_value(value_ty, vid)?;
 349         debug!("relate_ty_var: generalized_ty = {:?}", generalized_ty);
 350
 351         if D::forbid_inference_vars() {
 352             // In NLL, we don't have type inference variables
 353             // floating around, so we can do this rather imprecise
 354             // variant of the occurs-check.
 355             assert!(!generalized_ty.has_infer_types());
 356         }
 357
 358         self.infcx
 359             .type_variables
 360             .borrow_mut()
 361             .instantiate(vid, generalized_ty);
 362
 363         // The generalized values we extract from `canonical_var_values` have
 364         // been fully instantiated and hence the set of scopes we have
 365         // doesn't matter -- just to be sure, put an empty vector
 366         // in there.
 367         let old_a_scopes = ::std::mem::replace(pair.vid_scopes(self), vec![]);
 368
 369         // Relate the generalized kind to the original one.
 370         let result = pair.relate_generalized_ty(self, generalized_ty);
 371
 372         // Restore the old scopes now.
 373         *pair.vid_scopes(self) = old_a_scopes;
 374
 375         debug!("relate_ty_var: complete, result = {:?}", result);
 376         result
 377     }
 378
 379     fn generalize_value<T: Relate<'tcx>>(
 380         &mut self,
 381         value: T,
 382         for_vid: ty::TyVid,
 383     ) -> RelateResult<'tcx, T> {
 384         let universe = self.infcx.probe_ty_var(for_vid).unwrap_err();
 385
 386         let mut generalizer = TypeGeneralizer {
 387             infcx: self.infcx,
 388             delegate: &mut self.delegate,
 389             first_free_index: ty::INNERMOST,
 390             ambient_variance: self.ambient_variance,
 391             for_vid_sub_root: self.infcx.type_variables.borrow_mut().sub_root_var(for_vid),
 392             universe,
 393         };
 394
 395         generalizer.relate(&value, &value)
 396     }
 397 }
 398
 399 /// When we instantiate a inference variable with a value in
 400 /// `relate_ty_var`, we always have the pair of a `TyVid` and a `Ty`,
 401 /// but the ordering may vary (depending on whether the inference
 402 /// variable was found on the `a` or `b` sides). Therefore, this trait
 403 /// allows us to factor out common code, while preserving the order
 404 /// when needed.
 405 trait VidValuePair<'tcx>: Debug {
 406     /// Extract the inference variable (which could be either the
 407     /// first or second part of the tuple).
 408     fn vid(&self) -> ty::TyVid;
 409
 410     /// Extract the value it is being related to (which will be the
 411     /// opposite part of the tuple from the vid).
 412     fn value_ty(&self) -> Ty<'tcx>;
 413
 414     /// Extract the scopes that apply to whichever side of the tuple
 415     /// the vid was found on.  See the comment where this is called
 416     /// for more details on why we want them.
 417     fn vid_scopes<D: TypeRelatingDelegate<'tcx>>(
 418         &self,
 419         relate: &'r mut TypeRelating<'_, 'tcx, D>,
 420     ) -> &'r mut Vec<BoundRegionScope<'tcx>>;
 421
 422     /// Given a generalized type G that should replace the vid, relate
 423     /// G to the value, putting G on whichever side the vid would have
 424     /// appeared.
 425     fn relate_generalized_ty<D>(
 426         &self,
 427         relate: &mut TypeRelating<'_, 'tcx, D>,
 428         generalized_ty: Ty<'tcx>,
 429     ) -> RelateResult<'tcx, Ty<'tcx>>
 430     where
 431         D: TypeRelatingDelegate<'tcx>;
 432 }
 433
 434 impl VidValuePair<'tcx> for (ty::TyVid, Ty<'tcx>) {
 435     fn vid(&self) -> ty::TyVid {
 436         self.0
 437     }
 438
 439     fn value_ty(&self) -> Ty<'tcx> {
 440         self.1
 441     }
 442
 443     fn vid_scopes<D>(
 444         &self,
 445         relate: &'r mut TypeRelating<'_, 'tcx, D>,
 446     ) -> &'r mut Vec<BoundRegionScope<'tcx>>
 447     where
 448         D: TypeRelatingDelegate<'tcx>,
 449     {
 450         &mut relate.a_scopes
 451     }
 452
 453     fn relate_generalized_ty<D>(
 454         &self,
 455         relate: &mut TypeRelating<'_, 'tcx, D>,
 456         generalized_ty: Ty<'tcx>,
 457     ) -> RelateResult<'tcx, Ty<'tcx>>
 458     where
 459         D: TypeRelatingDelegate<'tcx>,
 460     {
 461         relate.relate(&generalized_ty, &self.value_ty())
 462     }
 463 }
 464
 465 // In this case, the "vid" is the "b" type.
 466 impl VidValuePair<'tcx> for (Ty<'tcx>, ty::TyVid) {
 467     fn vid(&self) -> ty::TyVid {
 468         self.1
 469     }
 470
 471     fn value_ty(&self) -> Ty<'tcx> {
 472         self.0
 473     }
 474
 475     fn vid_scopes<D>(
 476         &self,
 477         relate: &'r mut TypeRelating<'_, 'tcx, D>,
 478     ) -> &'r mut Vec<BoundRegionScope<'tcx>>
 479     where
 480         D: TypeRelatingDelegate<'tcx>,
 481     {
 482         &mut relate.b_scopes
 483     }
 484
 485     fn relate_generalized_ty<D>(
 486         &self,
 487         relate: &mut TypeRelating<'_, 'tcx, D>,
 488         generalized_ty: Ty<'tcx>,
 489     ) -> RelateResult<'tcx, Ty<'tcx>>
 490     where
 491         D: TypeRelatingDelegate<'tcx>,
 492     {
 493         relate.relate(&self.value_ty(), &generalized_ty)
 494     }
 495 }
 496
 497 impl<D> TypeRelation<'tcx> for TypeRelating<'me, 'tcx, D>
 498 where
 499     D: TypeRelatingDelegate<'tcx>,
 500 {
 501     fn tcx(&self) -> TyCtxt<'tcx> {
 502         self.infcx.tcx
 503     }
 504
 505     fn tag(&self) -> &'static str {
 506         "nll::subtype"
 507     }
 508
 509     fn a_is_expected(&self) -> bool {
 510         true
 511     }
 512
 513     fn relate_with_variance<T: Relate<'tcx>>(
 514         &mut self,
 515         variance: ty::Variance,
 516         a: &T,
 517         b: &T,
 518     ) -> RelateResult<'tcx, T> {
 519         debug!(
 520             "relate_with_variance(variance={:?}, a={:?}, b={:?})",
 521             variance, a, b
 522         );
 523
 524         let old_ambient_variance = self.ambient_variance;
 525         self.ambient_variance = self.ambient_variance.xform(variance);
 526
 527         debug!(
 528             "relate_with_variance: ambient_variance = {:?}",
 529             self.ambient_variance
 530         );
 531
 532         let r = self.relate(a, b)?;
 533
 534         self.ambient_variance = old_ambient_variance;
 535
 536         debug!("relate_with_variance: r={:?}", r);
 537
 538         Ok(r)
 539     }
 540
 541     fn tys(&mut self, a: Ty<'tcx>, mut b: Ty<'tcx>) -> RelateResult<'tcx, Ty<'tcx>> {
 542         let a = self.infcx.shallow_resolve(a);
 543
 544         if !D::forbid_inference_vars() {
 545             b = self.infcx.shallow_resolve(b);
 546         }
 547
 548         match (&a.sty, &b.sty) {
 549             (_, &ty::Infer(ty::TyVar(vid))) => {
 550                 if D::forbid_inference_vars() {
 551                     // Forbid inference variables in the RHS.
 552                     bug!("unexpected inference var {:?}", b)
 553                 } else {
 554                     self.relate_ty_var((a, vid))
 555                 }
 556             }
 557
 558             (&ty::Infer(ty::TyVar(vid)), _) => self.relate_ty_var((vid, b)),
 559
 560             (&ty::Projection(projection_ty), _)
 561                 if D::normalization() == NormalizationStrategy::Lazy =>
 562             {
 563                 Ok(self.relate_projection_ty(projection_ty, b))
 564             }
 565
 566             (_, &ty::Projection(projection_ty))
 567                 if D::normalization() == NormalizationStrategy::Lazy =>
 568             {
 569                 Ok(self.relate_projection_ty(projection_ty, a))
 570             }
 571
 572             _ => {
 573                 debug!(
 574                     "tys(a={:?}, b={:?}, variance={:?})",
 575                     a, b, self.ambient_variance
 576                 );
 577
 578                 // Will also handle unification of `IntVar` and `FloatVar`.
 579                 self.infcx.super_combine_tys(self, a, b)
 580             }
 581         }
 582     }
 583
 584     fn regions(
 585         &mut self,
 586         a: ty::Region<'tcx>,
 587         b: ty::Region<'tcx>,
 588     ) -> RelateResult<'tcx, ty::Region<'tcx>> {
 589         debug!(
 590             "regions(a={:?}, b={:?}, variance={:?})",
 591             a, b, self.ambient_variance
 592         );
 593
 594         let v_a = self.replace_bound_region(a, ty::INNERMOST, &self.a_scopes);
 595         let v_b = self.replace_bound_region(b, ty::INNERMOST, &self.b_scopes);
 596
 597         debug!("regions: v_a = {:?}", v_a);
 598         debug!("regions: v_b = {:?}", v_b);
 599
 600         if self.ambient_covariance() {
 601             // Covariance: a <= b. Hence, `b: a`.
 602             self.push_outlives(v_b, v_a);
 603         }
 604
 605         if self.ambient_contravariance() {
 606             // Contravariant: b <= a. Hence, `a: b`.
 607             self.push_outlives(v_a, v_b);
 608         }
 609
 610         Ok(a)
 611     }
 612
 613     fn consts(
 614         &mut self,
 615         a: &'tcx ty::Const<'tcx>,
 616         b: &'tcx ty::Const<'tcx>,
 617     ) -> RelateResult<'tcx, &'tcx ty::Const<'tcx>> {
 618         if let ty::Const { val: ConstValue::Infer(InferConst::Canonical(_, _)), .. } = a {
 619             // FIXME(const_generics): I'm unsure how this branch should actually be handled,
 620             // so this is probably not correct.
 621             self.infcx.super_combine_consts(self, a, b)
 622         } else {
 623             debug!("consts(a={:?}, b={:?}, variance={:?})", a, b, self.ambient_variance);
 624             relate::super_relate_consts(self, a, b)
 625         }
 626     }
 627
 628     fn binders<T>(
 629         &mut self,
 630         a: &ty::Binder<T>,
 631         b: &ty::Binder<T>,
 632     ) -> RelateResult<'tcx, ty::Binder<T>>
 633     where
 634         T: Relate<'tcx>,
 635     {
 636         // We want that
 637         //
 638         // ```
 639         // for<'a> fn(&'a u32) -> &'a u32 <:
 640         //   fn(&'b u32) -> &'b u32
 641         // ```
 642         //
 643         // but not
 644         //
 645         // ```
 646         // fn(&'a u32) -> &'a u32 <:
 647         //   for<'b> fn(&'b u32) -> &'b u32
 648         // ```
 649         //
 650         // We therefore proceed as follows:
 651         //
 652         // - Instantiate binders on `b` universally, yielding a universe U1.
 653         // - Instantiate binders on `a` existentially in U1.
 654
 655         debug!(
 656             "binders({:?}: {:?}, ambient_variance={:?})",
 657             a, b, self.ambient_variance
 658         );
 659
 660         if self.ambient_covariance() {
 661             // Covariance, so we want `for<..> A <: for<..> B` --
 662             // therefore we compare any instantiation of A (i.e., A
 663             // instantiated with existentials) against every
 664             // instantiation of B (i.e., B instantiated with
 665             // universals).
 666
 667             let b_scope = self.create_scope(b, UniversallyQuantified(true));
 668             let a_scope = self.create_scope(a, UniversallyQuantified(false));
 669
 670             debug!("binders: a_scope = {:?} (existential)", a_scope);
 671             debug!("binders: b_scope = {:?} (universal)", b_scope);
 672
 673             self.b_scopes.push(b_scope);
 674             self.a_scopes.push(a_scope);
 675
 676             // Reset the ambient variance to covariant. This is needed
 677             // to correctly handle cases like
 678             //
 679             //     for<'a> fn(&'a u32, &'a u3) == for<'b, 'c> fn(&'b u32, &'c u32)
 680             //
 681             // Somewhat surprisingly, these two types are actually
 682             // **equal**, even though the one on the right looks more
 683             // polymorphic. The reason is due to subtyping. To see it,
 684             // consider that each function can call the other:
 685             //
 686             // - The left function can call the right with `'b` and
 687             //   `'c` both equal to `'a`
 688             //
 689             // - The right function can call the left with `'a` set to
 690             //   `{P}`, where P is the point in the CFG where the call
 691             //   itself occurs. Note that `'b` and `'c` must both
 692             //   include P. At the point, the call works because of
 693             //   subtyping (i.e., `&'b u32 <: &{P} u32`).
 694             let variance = ::std::mem::replace(&mut self.ambient_variance, ty::Variance::Covariant);
 695
 696             self.relate(a.skip_binder(), b.skip_binder())?;
 697
 698             self.ambient_variance = variance;
 699
 700             self.b_scopes.pop().unwrap();
 701             self.a_scopes.pop().unwrap();
 702         }
 703
 704         if self.ambient_contravariance() {
 705             // Contravariance, so we want `for<..> A :> for<..> B`
 706             // -- therefore we compare every instantiation of A (i.e.,
 707             // A instantiated with universals) against any
 708             // instantiation of B (i.e., B instantiated with
 709             // existentials). Opposite of above.
 710
 711             let a_scope = self.create_scope(a, UniversallyQuantified(true));
 712             let b_scope = self.create_scope(b, UniversallyQuantified(false));
 713
 714             debug!("binders: a_scope = {:?} (universal)", a_scope);
 715             debug!("binders: b_scope = {:?} (existential)", b_scope);
 716
 717             self.a_scopes.push(a_scope);
 718             self.b_scopes.push(b_scope);
 719
 720             // Reset ambient variance to contravariance. See the
 721             // covariant case above for an explanation.
 722             let variance =
 723                 ::std::mem::replace(&mut self.ambient_variance, ty::Variance::Contravariant);
 724
 725             self.relate(a.skip_binder(), b.skip_binder())?;
 726
 727             self.ambient_variance = variance;
 728
 729             self.b_scopes.pop().unwrap();
 730             self.a_scopes.pop().unwrap();
 731         }
 732
 733         Ok(a.clone())
 734     }
 735 }
 736
 737 /// When we encounter a binder like `for<..> fn(..)`, we actually have
 738 /// to walk the `fn` value to find all the values bound by the `for`
 739 /// (these are not explicitly present in the ty representation right
 740 /// now). This visitor handles that: it descends the type, tracking
 741 /// binder depth, and finds late-bound regions targeting the
 742 /// `for<..`>.  For each of those, it creates an entry in
 743 /// `bound_region_scope`.
 744 struct ScopeInstantiator<'me, 'tcx> {
 745     next_region: &'me mut dyn FnMut(ty::BoundRegion) -> ty::Region<'tcx>,
 746     // The debruijn index of the scope we are instantiating.
 747     target_index: ty::DebruijnIndex,
 748     bound_region_scope: &'me mut BoundRegionScope<'tcx>,
 749 }
 750
 751 impl<'me, 'tcx> TypeVisitor<'tcx> for ScopeInstantiator<'me, 'tcx> {
 752     fn visit_binder<T: TypeFoldable<'tcx>>(&mut self, t: &ty::Binder<T>) -> bool {
 753         self.target_index.shift_in(1);
 754         t.super_visit_with(self);
 755         self.target_index.shift_out(1);
 756
 757         false
 758     }
 759
 760     fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 761         let ScopeInstantiator {
 762             bound_region_scope,
 763             next_region,
 764             ..
 765         } = self;
 766
 767         match r {
 768             ty::ReLateBound(debruijn, br) if *debruijn == self.target_index => {
 769                 bound_region_scope
 770                     .map
 771                     .entry(*br)
 772                     .or_insert_with(|| next_region(*br));
 773             }
 774
 775             _ => {}
 776         }
 777
 778         false
 779     }
 780 }
 781
 782 /// The "type generalize" is used when handling inference variables.
 783 ///
 784 /// The basic strategy for handling a constraint like `?A <: B` is to
 785 /// apply a "generalization strategy" to the type `B` -- this replaces
 786 /// all the lifetimes in the type `B` with fresh inference
 787 /// variables. (You can read more about the strategy in this [blog
 788 /// post].)
 789 ///
 790 /// As an example, if we had `?A <: &'x u32`, we would generalize `&'x
 791 /// u32` to `&'0 u32` where `'0` is a fresh variable. This becomes the
 792 /// value of `A`. Finally, we relate `&'0 u32 <: &'x u32`, which
 793 /// establishes `'0: 'x` as a constraint.
 794 ///
 795 /// As a side-effect of this generalization procedure, we also replace
 796 /// all the bound regions that we have traversed with concrete values,
 797 /// so that the resulting generalized type is independent from the
 798 /// scopes.
 799 ///
 800 /// [blog post]: https://is.gd/0hKvIr
 801 struct TypeGeneralizer<'me, 'tcx, D>
 802 where
 803     D: TypeRelatingDelegate<'tcx>,
 804 {
 805     infcx: &'me InferCtxt<'me, 'tcx>,
 806
 807     delegate: &'me mut D,
 808
 809     /// After we generalize this type, we are going to relative it to
 810     /// some other type. What will be the variance at this point?
 811     ambient_variance: ty::Variance,
 812
 813     first_free_index: ty::DebruijnIndex,
 814
 815     /// The vid of the type variable that is in the process of being
 816     /// instantiated. If we find this within the value we are folding,
 817     /// that means we would have created a cyclic value.
 818     for_vid_sub_root: ty::TyVid,
 819
 820     /// The universe of the type variable that is in the process of being
 821     /// instantiated. If we find anything that this universe cannot name,
 822     /// we reject the relation.
 823     universe: ty::UniverseIndex,
 824 }
 825
 826 impl<D> TypeRelation<'tcx> for TypeGeneralizer<'me, 'tcx, D>
 827 where
 828     D: TypeRelatingDelegate<'tcx>,
 829 {
 830     fn tcx(&self) -> TyCtxt<'tcx> {
 831         self.infcx.tcx
 832     }
 833
 834     fn tag(&self) -> &'static str {
 835         "nll::generalizer"
 836     }
 837
 838     fn a_is_expected(&self) -> bool {
 839         true
 840     }
 841
 842     fn relate_with_variance<T: Relate<'tcx>>(
 843         &mut self,
 844         variance: ty::Variance,
 845         a: &T,
 846         b: &T,
 847     ) -> RelateResult<'tcx, T> {
 848         debug!(
 849             "TypeGeneralizer::relate_with_variance(variance={:?}, a={:?}, b={:?})",
 850             variance, a, b
 851         );
 852
 853         let old_ambient_variance = self.ambient_variance;
 854         self.ambient_variance = self.ambient_variance.xform(variance);
 855
 856         debug!(
 857             "TypeGeneralizer::relate_with_variance: ambient_variance = {:?}",
 858             self.ambient_variance
 859         );
 860
 861         let r = self.relate(a, b)?;
 862
 863         self.ambient_variance = old_ambient_variance;
 864
 865         debug!("TypeGeneralizer::relate_with_variance: r={:?}", r);
 866
 867         Ok(r)
 868     }
 869
 870     fn tys(&mut self, a: Ty<'tcx>, _: Ty<'tcx>) -> RelateResult<'tcx, Ty<'tcx>> {
 871         use crate::infer::type_variable::TypeVariableValue;
 872
 873         debug!("TypeGeneralizer::tys(a={:?})", a);
 874
 875         match a.sty {
 876             ty::Infer(ty::TyVar(_)) | ty::Infer(ty::IntVar(_)) | ty::Infer(ty::FloatVar(_))
 877                 if D::forbid_inference_vars() =>
 878             {
 879                 bug!(
 880                     "unexpected inference variable encountered in NLL generalization: {:?}",
 881                     a
 882                 );
 883             }
 884
 885             ty::Infer(ty::TyVar(vid)) => {
 886                 let mut variables = self.infcx.type_variables.borrow_mut();
 887                 let vid = variables.root_var(vid);
 888                 let sub_vid = variables.sub_root_var(vid);
 889                 if sub_vid == self.for_vid_sub_root {
 890                     // If sub-roots are equal, then `for_vid` and
 891                     // `vid` are related via subtyping.
 892                     debug!("TypeGeneralizer::tys: occurs check failed");
 893                     return Err(TypeError::Mismatch);
 894                 } else {
 895                     match variables.probe(vid) {
 896                         TypeVariableValue::Known { value: u } => {
 897                             drop(variables);
 898                             self.relate(&u, &u)
 899                         }
 900                         TypeVariableValue::Unknown {
 901                             universe: _universe,
 902                         } => {
 903                             if self.ambient_variance == ty::Bivariant {
 904                                 // FIXME: we may need a WF predicate (related to #54105).
 905                             }
 906
 907                             let origin = *variables.var_origin(vid);
 908
 909                             // Replacing with a new variable in the universe `self.universe`,
 910                             // it will be unified later with the original type variable in
 911                             // the universe `_universe`.
 912                             let new_var_id = variables.new_var(self.universe, false, origin);
 913
 914                             let u = self.tcx().mk_ty_var(new_var_id);
 915                             debug!(
 916                                 "generalize: replacing original vid={:?} with new={:?}",
 917                                 vid, u
 918                             );
 919                             return Ok(u);
 920                         }
 921                     }
 922                 }
 923             }
 924
 925             ty::Infer(ty::IntVar(_)) | ty::Infer(ty::FloatVar(_)) => {
 926                 // No matter what mode we are in,
 927                 // integer/floating-point types must be equal to be
 928                 // relatable.
 929                 Ok(a)
 930             }
 931
 932             ty::Placeholder(placeholder) => {
 933                 if self.universe.cannot_name(placeholder.universe) {
 934                     debug!(
 935                         "TypeGeneralizer::tys: root universe {:?} cannot name\
 936                          placeholder in universe {:?}",
 937                         self.universe, placeholder.universe
 938                     );
 939                     Err(TypeError::Mismatch)
 940                 } else {
 941                     Ok(a)
 942                 }
 943             }
 944
 945             _ => relate::super_relate_tys(self, a, a),
 946         }
 947     }
 948
 949     fn regions(
 950         &mut self,
 951         a: ty::Region<'tcx>,
 952         _: ty::Region<'tcx>,
 953     ) -> RelateResult<'tcx, ty::Region<'tcx>> {
 954         debug!("TypeGeneralizer::regions(a={:?})", a);
 955
 956         if let ty::ReLateBound(debruijn, _) = a {
 957             if *debruijn < self.first_free_index {
 958                 return Ok(a);
 959             }
 960         }
 961
 962         // For now, we just always create a fresh region variable to
 963         // replace all the regions in the source type. In the main
 964         // type checker, we special case the case where the ambient
 965         // variance is `Invariant` and try to avoid creating a fresh
 966         // region variable, but since this comes up so much less in
 967         // NLL (only when users use `_` etc) it is much less
 968         // important.
 969         //
 970         // As an aside, since these new variables are created in
 971         // `self.universe` universe, this also serves to enforce the
 972         // universe scoping rules.
 973         //
 974         // FIXME(#54105) -- if the ambient variance is bivariant,
 975         // though, we may however need to check well-formedness or
 976         // risk a problem like #41677 again.
 977
 978         let replacement_region_vid = self.delegate.generalize_existential(self.universe);
 979
 980         Ok(replacement_region_vid)
 981     }
 982
 983     fn consts(
 984         &mut self,
 985         a: &'tcx ty::Const<'tcx>,
 986         _: &'tcx ty::Const<'tcx>,
 987     ) -> RelateResult<'tcx, &'tcx ty::Const<'tcx>> {
 988         debug!("TypeGeneralizer::consts(a={:?})", a);
 989
 990         if let ty::Const { val: ConstValue::Infer(InferConst::Canonical(_, _)), .. } = a {
 991             bug!(
 992                 "unexpected inference variable encountered in NLL generalization: {:?}",
 993                 a
 994             );
 995         } else {
 996             relate::super_relate_consts(self, a, a)
 997         }
 998     }
 999
1000     fn binders<T>(
1001         &mut self,
1002         a: &ty::Binder<T>,
1003         _: &ty::Binder<T>,
1004     ) -> RelateResult<'tcx, ty::Binder<T>>
1005     where
1006         T: Relate<'tcx>,
1007     {
1008         debug!("TypeGeneralizer::binders(a={:?})", a);
1009
1010         self.first_free_index.shift_in(1);
1011         let result = self.relate(a.skip_binder(), a.skip_binder())?;
1012         self.first_free_index.shift_out(1);
1013         Ok(ty::Binder::bind(result))
1014     }
1015 }