compiler/rustc_middle/src/ty/relate.rs

   1 //! Generalized type relating mechanism.
   2 //!
   3 //! A type relation `R` relates a pair of values `(A, B)`. `A and B` are usually
   4 //! types or regions but can be other things. Examples of type relations are
   5 //! subtyping, type equality, etc.
   6
   7 use crate::ty::error::{ExpectedFound, TypeError};
   8 use crate::ty::{self, ImplSubject, Term, TermKind, Ty, TyCtxt, TypeFoldable};
   9 use crate::ty::{GenericArg, GenericArgKind, SubstsRef};
  10 use rustc_hir as ast;
  11 use rustc_hir::def_id::DefId;
  12 use rustc_span::DUMMY_SP;
  13 use rustc_target::spec::abi;
  14 use std::iter;
  15
  16 pub type RelateResult<'tcx, T> = Result<T, TypeError<'tcx>>;
  17
  18 #[derive(Clone, Debug)]
  19 pub enum Cause {
  20     ExistentialRegionBound, // relating an existential region bound
  21 }
  22
  23 pub trait TypeRelation<'tcx>: Sized {
  24     fn tcx(&self) -> TyCtxt<'tcx>;
  25
  26     fn param_env(&self) -> ty::ParamEnv<'tcx>;
  27
  28     /// Returns a static string we can use for printouts.
  29     fn tag(&self) -> &'static str;
  30
  31     /// Returns `true` if the value `a` is the "expected" type in the
  32     /// relation. Just affects error messages.
  33     fn a_is_expected(&self) -> bool;
  34
  35     fn with_cause<F, R>(&mut self, _cause: Cause, f: F) -> R
  36     where
  37         F: FnOnce(&mut Self) -> R,
  38     {
  39         f(self)
  40     }
  41
  42     /// Generic relation routine suitable for most anything.
  43     fn relate<T: Relate<'tcx>>(&mut self, a: T, b: T) -> RelateResult<'tcx, T> {
  44         Relate::relate(self, a, b)
  45     }
  46
  47     /// Relate the two substitutions for the given item. The default
  48     /// is to look up the variance for the item and proceed
  49     /// accordingly.
  50     fn relate_item_substs(
  51         &mut self,
  52         item_def_id: DefId,
  53         a_subst: SubstsRef<'tcx>,
  54         b_subst: SubstsRef<'tcx>,
  55     ) -> RelateResult<'tcx, SubstsRef<'tcx>> {
  56         debug!(
  57             "relate_item_substs(item_def_id={:?}, a_subst={:?}, b_subst={:?})",
  58             item_def_id, a_subst, b_subst
  59         );
  60
  61         let tcx = self.tcx();
  62         let opt_variances = tcx.variances_of(item_def_id);
  63         relate_substs_with_variances(self, item_def_id, opt_variances, a_subst, b_subst)
  64     }
  65
  66     /// Switch variance for the purpose of relating `a` and `b`.
  67     fn relate_with_variance<T: Relate<'tcx>>(
  68         &mut self,
  69         variance: ty::Variance,
  70         info: ty::VarianceDiagInfo<'tcx>,
  71         a: T,
  72         b: T,
  73     ) -> RelateResult<'tcx, T>;
  74
  75     // Overridable relations. You shouldn't typically call these
  76     // directly, instead call `relate()`, which in turn calls
  77     // these. This is both more uniform but also allows us to add
  78     // additional hooks for other types in the future if needed
  79     // without making older code, which called `relate`, obsolete.
  80
  81     fn tys(&mut self, a: Ty<'tcx>, b: Ty<'tcx>) -> RelateResult<'tcx, Ty<'tcx>>;
  82
  83     fn regions(
  84         &mut self,
  85         a: ty::Region<'tcx>,
  86         b: ty::Region<'tcx>,
  87     ) -> RelateResult<'tcx, ty::Region<'tcx>>;
  88
  89     fn consts(
  90         &mut self,
  91         a: ty::Const<'tcx>,
  92         b: ty::Const<'tcx>,
  93     ) -> RelateResult<'tcx, ty::Const<'tcx>>;
  94
  95     fn binders<T>(
  96         &mut self,
  97         a: ty::Binder<'tcx, T>,
  98         b: ty::Binder<'tcx, T>,
  99     ) -> RelateResult<'tcx, ty::Binder<'tcx, T>>
 100     where
 101         T: Relate<'tcx>;
 102 }
 103
 104 pub trait Relate<'tcx>: TypeFoldable<'tcx> + Copy {
 105     fn relate<R: TypeRelation<'tcx>>(
 106         relation: &mut R,
 107         a: Self,
 108         b: Self,
 109     ) -> RelateResult<'tcx, Self>;
 110 }
 111
 112 ///////////////////////////////////////////////////////////////////////////
 113 // Relate impls
 114
 115 pub fn relate_type_and_mut<'tcx, R: TypeRelation<'tcx>>(
 116     relation: &mut R,
 117     a: ty::TypeAndMut<'tcx>,
 118     b: ty::TypeAndMut<'tcx>,
 119     base_ty: Ty<'tcx>,
 120 ) -> RelateResult<'tcx, ty::TypeAndMut<'tcx>> {
 121     debug!("{}.mts({:?}, {:?})", relation.tag(), a, b);
 122     if a.mutbl != b.mutbl {
 123         Err(TypeError::Mutability)
 124     } else {
 125         let mutbl = a.mutbl;
 126         let (variance, info) = match mutbl {
 127             ast::Mutability::Not => (ty::Covariant, ty::VarianceDiagInfo::None),
 128             ast::Mutability::Mut => {
 129                 (ty::Invariant, ty::VarianceDiagInfo::Invariant { ty: base_ty, param_index: 0 })
 130             }
 131         };
 132         let ty = relation.relate_with_variance(variance, info, a.ty, b.ty)?;
 133         Ok(ty::TypeAndMut { ty, mutbl })
 134     }
 135 }
 136
 137 #[inline]
 138 pub fn relate_substs<'tcx, R: TypeRelation<'tcx>>(
 139     relation: &mut R,
 140     a_subst: SubstsRef<'tcx>,
 141     b_subst: SubstsRef<'tcx>,
 142 ) -> RelateResult<'tcx, SubstsRef<'tcx>> {
 143     relation.tcx().mk_substs(iter::zip(a_subst, b_subst).map(|(a, b)| {
 144         relation.relate_with_variance(ty::Invariant, ty::VarianceDiagInfo::default(), a, b)
 145     }))
 146 }
 147
 148 pub fn relate_substs_with_variances<'tcx, R: TypeRelation<'tcx>>(
 149     relation: &mut R,
 150     ty_def_id: DefId,
 151     variances: &[ty::Variance],
 152     a_subst: SubstsRef<'tcx>,
 153     b_subst: SubstsRef<'tcx>,
 154 ) -> RelateResult<'tcx, SubstsRef<'tcx>> {
 155     let tcx = relation.tcx();
 156
 157     let mut cached_ty = None;
 158     let params = iter::zip(a_subst, b_subst).enumerate().map(|(i, (a, b))| {
 159         let variance = variances[i];
 160         let variance_info = if variance == ty::Invariant {
 161             let ty =
 162                 *cached_ty.get_or_insert_with(|| tcx.bound_type_of(ty_def_id).subst(tcx, a_subst));
 163             ty::VarianceDiagInfo::Invariant { ty, param_index: i.try_into().unwrap() }
 164         } else {
 165             ty::VarianceDiagInfo::default()
 166         };
 167         relation.relate_with_variance(variance, variance_info, a, b)
 168     });
 169
 170     tcx.mk_substs(params)
 171 }
 172
 173 impl<'tcx> Relate<'tcx> for ty::FnSig<'tcx> {
 174     fn relate<R: TypeRelation<'tcx>>(
 175         relation: &mut R,
 176         a: ty::FnSig<'tcx>,
 177         b: ty::FnSig<'tcx>,
 178     ) -> RelateResult<'tcx, ty::FnSig<'tcx>> {
 179         let tcx = relation.tcx();
 180
 181         if a.c_variadic != b.c_variadic {
 182             return Err(TypeError::VariadicMismatch(expected_found(
 183                 relation,
 184                 a.c_variadic,
 185                 b.c_variadic,
 186             )));
 187         }
 188         let unsafety = relation.relate(a.unsafety, b.unsafety)?;
 189         let abi = relation.relate(a.abi, b.abi)?;
 190
 191         if a.inputs().len() != b.inputs().len() {
 192             return Err(TypeError::ArgCount);
 193         }
 194
 195         let inputs_and_output = iter::zip(a.inputs(), b.inputs())
 196             .map(|(&a, &b)| ((a, b), false))
 197             .chain(iter::once(((a.output(), b.output()), true)))
 198             .map(|((a, b), is_output)| {
 199                 if is_output {
 200                     relation.relate(a, b)
 201                 } else {
 202                     relation.relate_with_variance(
 203                         ty::Contravariant,
 204                         ty::VarianceDiagInfo::default(),
 205                         a,
 206                         b,
 207                     )
 208                 }
 209             })
 210             .enumerate()
 211             .map(|(i, r)| match r {
 212                 Err(TypeError::Sorts(exp_found) | TypeError::ArgumentSorts(exp_found, _)) => {
 213                     Err(TypeError::ArgumentSorts(exp_found, i))
 214                 }
 215                 Err(TypeError::Mutability | TypeError::ArgumentMutability(_)) => {
 216                     Err(TypeError::ArgumentMutability(i))
 217                 }
 218                 r => r,
 219             });
 220         Ok(ty::FnSig {
 221             inputs_and_output: tcx.mk_type_list(inputs_and_output)?,
 222             c_variadic: a.c_variadic,
 223             unsafety,
 224             abi,
 225         })
 226     }
 227 }
 228
 229 impl<'tcx> Relate<'tcx> for ty::BoundConstness {
 230     fn relate<R: TypeRelation<'tcx>>(
 231         relation: &mut R,
 232         a: ty::BoundConstness,
 233         b: ty::BoundConstness,
 234     ) -> RelateResult<'tcx, ty::BoundConstness> {
 235         if a != b {
 236             Err(TypeError::ConstnessMismatch(expected_found(relation, a, b)))
 237         } else {
 238             Ok(a)
 239         }
 240     }
 241 }
 242
 243 impl<'tcx> Relate<'tcx> for ast::Unsafety {
 244     fn relate<R: TypeRelation<'tcx>>(
 245         relation: &mut R,
 246         a: ast::Unsafety,
 247         b: ast::Unsafety,
 248     ) -> RelateResult<'tcx, ast::Unsafety> {
 249         if a != b {
 250             Err(TypeError::UnsafetyMismatch(expected_found(relation, a, b)))
 251         } else {
 252             Ok(a)
 253         }
 254     }
 255 }
 256
 257 impl<'tcx> Relate<'tcx> for abi::Abi {
 258     fn relate<R: TypeRelation<'tcx>>(
 259         relation: &mut R,
 260         a: abi::Abi,
 261         b: abi::Abi,
 262     ) -> RelateResult<'tcx, abi::Abi> {
 263         if a == b { Ok(a) } else { Err(TypeError::AbiMismatch(expected_found(relation, a, b))) }
 264     }
 265 }
 266
 267 impl<'tcx> Relate<'tcx> for ty::ProjectionTy<'tcx> {
 268     fn relate<R: TypeRelation<'tcx>>(
 269         relation: &mut R,
 270         a: ty::ProjectionTy<'tcx>,
 271         b: ty::ProjectionTy<'tcx>,
 272     ) -> RelateResult<'tcx, ty::ProjectionTy<'tcx>> {
 273         if a.item_def_id != b.item_def_id {
 274             Err(TypeError::ProjectionMismatched(expected_found(
 275                 relation,
 276                 a.item_def_id,
 277                 b.item_def_id,
 278             )))
 279         } else {
 280             let substs = relation.relate(a.substs, b.substs)?;
 281             Ok(ty::ProjectionTy { item_def_id: a.item_def_id, substs: &substs })
 282         }
 283     }
 284 }
 285
 286 impl<'tcx> Relate<'tcx> for ty::ExistentialProjection<'tcx> {
 287     fn relate<R: TypeRelation<'tcx>>(
 288         relation: &mut R,
 289         a: ty::ExistentialProjection<'tcx>,
 290         b: ty::ExistentialProjection<'tcx>,
 291     ) -> RelateResult<'tcx, ty::ExistentialProjection<'tcx>> {
 292         if a.item_def_id != b.item_def_id {
 293             Err(TypeError::ProjectionMismatched(expected_found(
 294                 relation,
 295                 a.item_def_id,
 296                 b.item_def_id,
 297             )))
 298         } else {
 299             let term = relation.relate_with_variance(
 300                 ty::Invariant,
 301                 ty::VarianceDiagInfo::default(),
 302                 a.term,
 303                 b.term,
 304             )?;
 305             let substs = relation.relate_with_variance(
 306                 ty::Invariant,
 307                 ty::VarianceDiagInfo::default(),
 308                 a.substs,
 309                 b.substs,
 310             )?;
 311             Ok(ty::ExistentialProjection { item_def_id: a.item_def_id, substs, term })
 312         }
 313     }
 314 }
 315
 316 impl<'tcx> Relate<'tcx> for ty::TraitRef<'tcx> {
 317     fn relate<R: TypeRelation<'tcx>>(
 318         relation: &mut R,
 319         a: ty::TraitRef<'tcx>,
 320         b: ty::TraitRef<'tcx>,
 321     ) -> RelateResult<'tcx, ty::TraitRef<'tcx>> {
 322         // Different traits cannot be related.
 323         if a.def_id != b.def_id {
 324             Err(TypeError::Traits(expected_found(relation, a.def_id, b.def_id)))
 325         } else {
 326             let substs = relate_substs(relation, a.substs, b.substs)?;
 327             Ok(ty::TraitRef { def_id: a.def_id, substs })
 328         }
 329     }
 330 }
 331
 332 impl<'tcx> Relate<'tcx> for ty::ExistentialTraitRef<'tcx> {
 333     fn relate<R: TypeRelation<'tcx>>(
 334         relation: &mut R,
 335         a: ty::ExistentialTraitRef<'tcx>,
 336         b: ty::ExistentialTraitRef<'tcx>,
 337     ) -> RelateResult<'tcx, ty::ExistentialTraitRef<'tcx>> {
 338         // Different traits cannot be related.
 339         if a.def_id != b.def_id {
 340             Err(TypeError::Traits(expected_found(relation, a.def_id, b.def_id)))
 341         } else {
 342             let substs = relate_substs(relation, a.substs, b.substs)?;
 343             Ok(ty::ExistentialTraitRef { def_id: a.def_id, substs })
 344         }
 345     }
 346 }
 347
 348 #[derive(Copy, Debug, Clone, TypeFoldable, TypeVisitable)]
 349 struct GeneratorWitness<'tcx>(&'tcx ty::List<Ty<'tcx>>);
 350
 351 impl<'tcx> Relate<'tcx> for GeneratorWitness<'tcx> {
 352     fn relate<R: TypeRelation<'tcx>>(
 353         relation: &mut R,
 354         a: GeneratorWitness<'tcx>,
 355         b: GeneratorWitness<'tcx>,
 356     ) -> RelateResult<'tcx, GeneratorWitness<'tcx>> {
 357         assert_eq!(a.0.len(), b.0.len());
 358         let tcx = relation.tcx();
 359         let types = tcx.mk_type_list(iter::zip(a.0, b.0).map(|(a, b)| relation.relate(a, b)))?;
 360         Ok(GeneratorWitness(types))
 361     }
 362 }
 363
 364 impl<'tcx> Relate<'tcx> for ImplSubject<'tcx> {
 365     #[inline]
 366     fn relate<R: TypeRelation<'tcx>>(
 367         relation: &mut R,
 368         a: ImplSubject<'tcx>,
 369         b: ImplSubject<'tcx>,
 370     ) -> RelateResult<'tcx, ImplSubject<'tcx>> {
 371         match (a, b) {
 372             (ImplSubject::Trait(trait_ref_a), ImplSubject::Trait(trait_ref_b)) => {
 373                 let trait_ref = ty::TraitRef::relate(relation, trait_ref_a, trait_ref_b)?;
 374                 Ok(ImplSubject::Trait(trait_ref))
 375             }
 376             (ImplSubject::Inherent(ty_a), ImplSubject::Inherent(ty_b)) => {
 377                 let ty = Ty::relate(relation, ty_a, ty_b)?;
 378                 Ok(ImplSubject::Inherent(ty))
 379             }
 380             (ImplSubject::Trait(_), ImplSubject::Inherent(_))
 381             | (ImplSubject::Inherent(_), ImplSubject::Trait(_)) => {
 382                 bug!("can not relate TraitRef and Ty");
 383             }
 384         }
 385     }
 386 }
 387
 388 impl<'tcx> Relate<'tcx> for Ty<'tcx> {
 389     #[inline]
 390     fn relate<R: TypeRelation<'tcx>>(
 391         relation: &mut R,
 392         a: Ty<'tcx>,
 393         b: Ty<'tcx>,
 394     ) -> RelateResult<'tcx, Ty<'tcx>> {
 395         relation.tys(a, b)
 396     }
 397 }
 398
 399 /// The main "type relation" routine. Note that this does not handle
 400 /// inference artifacts, so you should filter those out before calling
 401 /// it.
 402 pub fn super_relate_tys<'tcx, R: TypeRelation<'tcx>>(
 403     relation: &mut R,
 404     a: Ty<'tcx>,
 405     b: Ty<'tcx>,
 406 ) -> RelateResult<'tcx, Ty<'tcx>> {
 407     let tcx = relation.tcx();
 408     debug!("super_relate_tys: a={:?} b={:?}", a, b);
 409     match (a.kind(), b.kind()) {
 410         (&ty::Infer(_), _) | (_, &ty::Infer(_)) => {
 411             // The caller should handle these cases!
 412             bug!("var types encountered in super_relate_tys")
 413         }
 414
 415         (ty::Bound(..), _) | (_, ty::Bound(..)) => {
 416             bug!("bound types encountered in super_relate_tys")
 417         }
 418
 419         (&ty::Error(_), _) | (_, &ty::Error(_)) => Ok(tcx.ty_error()),
 420
 421         (&ty::Never, _)
 422         | (&ty::Char, _)
 423         | (&ty::Bool, _)
 424         | (&ty::Int(_), _)
 425         | (&ty::Uint(_), _)
 426         | (&ty::Float(_), _)
 427         | (&ty::Str, _)
 428             if a == b =>
 429         {
 430             Ok(a)
 431         }
 432
 433         (&ty::Param(ref a_p), &ty::Param(ref b_p)) if a_p.index == b_p.index => Ok(a),
 434
 435         (ty::Placeholder(p1), ty::Placeholder(p2)) if p1 == p2 => Ok(a),
 436
 437         (&ty::Adt(a_def, a_substs), &ty::Adt(b_def, b_substs)) if a_def == b_def => {
 438             let substs = relation.relate_item_substs(a_def.did(), a_substs, b_substs)?;
 439             Ok(tcx.mk_adt(a_def, substs))
 440         }
 441
 442         (&ty::Foreign(a_id), &ty::Foreign(b_id)) if a_id == b_id => Ok(tcx.mk_foreign(a_id)),
 443
 444         (&ty::Dynamic(a_obj, a_region, a_repr), &ty::Dynamic(b_obj, b_region, b_repr))
 445             if a_repr == b_repr =>
 446         {
 447             let region_bound = relation.with_cause(Cause::ExistentialRegionBound, |relation| {
 448                 relation.relate_with_variance(
 449                     ty::Contravariant,
 450                     ty::VarianceDiagInfo::default(),
 451                     a_region,
 452                     b_region,
 453                 )
 454             })?;
 455             Ok(tcx.mk_dynamic(relation.relate(a_obj, b_obj)?, region_bound, a_repr))
 456         }
 457
 458         (&ty::Generator(a_id, a_substs, movability), &ty::Generator(b_id, b_substs, _))
 459             if a_id == b_id =>
 460         {
 461             // All Generator types with the same id represent
 462             // the (anonymous) type of the same generator expression. So
 463             // all of their regions should be equated.
 464             let substs = relation.relate(a_substs, b_substs)?;
 465             Ok(tcx.mk_generator(a_id, substs, movability))
 466         }
 467
 468         (&ty::GeneratorWitness(a_types), &ty::GeneratorWitness(b_types)) => {
 469             // Wrap our types with a temporary GeneratorWitness struct
 470             // inside the binder so we can related them
 471             let a_types = a_types.map_bound(GeneratorWitness);
 472             let b_types = b_types.map_bound(GeneratorWitness);
 473             // Then remove the GeneratorWitness for the result
 474             let types = relation.relate(a_types, b_types)?.map_bound(|witness| witness.0);
 475             Ok(tcx.mk_generator_witness(types))
 476         }
 477
 478         (&ty::Closure(a_id, a_substs), &ty::Closure(b_id, b_substs)) if a_id == b_id => {
 479             // All Closure types with the same id represent
 480             // the (anonymous) type of the same closure expression. So
 481             // all of their regions should be equated.
 482             let substs = relation.relate(a_substs, b_substs)?;
 483             Ok(tcx.mk_closure(a_id, &substs))
 484         }
 485
 486         (&ty::RawPtr(a_mt), &ty::RawPtr(b_mt)) => {
 487             let mt = relate_type_and_mut(relation, a_mt, b_mt, a)?;
 488             Ok(tcx.mk_ptr(mt))
 489         }
 490
 491         (&ty::Ref(a_r, a_ty, a_mutbl), &ty::Ref(b_r, b_ty, b_mutbl)) => {
 492             let r = relation.relate_with_variance(
 493                 ty::Contravariant,
 494                 ty::VarianceDiagInfo::default(),
 495                 a_r,
 496                 b_r,
 497             )?;
 498             let a_mt = ty::TypeAndMut { ty: a_ty, mutbl: a_mutbl };
 499             let b_mt = ty::TypeAndMut { ty: b_ty, mutbl: b_mutbl };
 500             let mt = relate_type_and_mut(relation, a_mt, b_mt, a)?;
 501             Ok(tcx.mk_ref(r, mt))
 502         }
 503
 504         (&ty::Array(a_t, sz_a), &ty::Array(b_t, sz_b)) => {
 505             let t = relation.relate(a_t, b_t)?;
 506             match relation.relate(sz_a, sz_b) {
 507                 Ok(sz) => Ok(tcx.mk_ty(ty::Array(t, sz))),
 508                 Err(err) => {
 509                     // Check whether the lengths are both concrete/known values,
 510                     // but are unequal, for better diagnostics.
 511                     //
 512                     // It might seem dubious to eagerly evaluate these constants here,
 513                     // we however cannot end up with errors in `Relate` during both
 514                     // `type_of` and `predicates_of`. This means that evaluating the
 515                     // constants should not cause cycle errors here.
 516                     let sz_a = sz_a.try_eval_usize(tcx, relation.param_env());
 517                     let sz_b = sz_b.try_eval_usize(tcx, relation.param_env());
 518                     match (sz_a, sz_b) {
 519                         (Some(sz_a_val), Some(sz_b_val)) if sz_a_val != sz_b_val => Err(
 520                             TypeError::FixedArraySize(expected_found(relation, sz_a_val, sz_b_val)),
 521                         ),
 522                         _ => Err(err),
 523                     }
 524                 }
 525             }
 526         }
 527
 528         (&ty::Slice(a_t), &ty::Slice(b_t)) => {
 529             let t = relation.relate(a_t, b_t)?;
 530             Ok(tcx.mk_slice(t))
 531         }
 532
 533         (&ty::Tuple(as_), &ty::Tuple(bs)) => {
 534             if as_.len() == bs.len() {
 535                 Ok(tcx.mk_tup(iter::zip(as_, bs).map(|(a, b)| relation.relate(a, b)))?)
 536             } else if !(as_.is_empty() || bs.is_empty()) {
 537                 Err(TypeError::TupleSize(expected_found(relation, as_.len(), bs.len())))
 538             } else {
 539                 Err(TypeError::Sorts(expected_found(relation, a, b)))
 540             }
 541         }
 542
 543         (&ty::FnDef(a_def_id, a_substs), &ty::FnDef(b_def_id, b_substs))
 544             if a_def_id == b_def_id =>
 545         {
 546             let substs = relation.relate_item_substs(a_def_id, a_substs, b_substs)?;
 547             Ok(tcx.mk_fn_def(a_def_id, substs))
 548         }
 549
 550         (&ty::FnPtr(a_fty), &ty::FnPtr(b_fty)) => {
 551             let fty = relation.relate(a_fty, b_fty)?;
 552             Ok(tcx.mk_fn_ptr(fty))
 553         }
 554
 555         // these two are already handled downstream in case of lazy normalization
 556         (&ty::Projection(a_data), &ty::Projection(b_data)) => {
 557             let projection_ty = relation.relate(a_data, b_data)?;
 558             Ok(tcx.mk_projection(projection_ty.item_def_id, projection_ty.substs))
 559         }
 560
 561         (&ty::Opaque(a_def_id, a_substs), &ty::Opaque(b_def_id, b_substs))
 562             if a_def_id == b_def_id =>
 563         {
 564             let substs = relate_substs(relation, a_substs, b_substs)?;
 565             Ok(tcx.mk_opaque(a_def_id, substs))
 566         }
 567
 568         _ => Err(TypeError::Sorts(expected_found(relation, a, b))),
 569     }
 570 }
 571
 572 /// The main "const relation" routine. Note that this does not handle
 573 /// inference artifacts, so you should filter those out before calling
 574 /// it.
 575 pub fn super_relate_consts<'tcx, R: TypeRelation<'tcx>>(
 576     relation: &mut R,
 577     a: ty::Const<'tcx>,
 578     b: ty::Const<'tcx>,
 579 ) -> RelateResult<'tcx, ty::Const<'tcx>> {
 580     debug!("{}.super_relate_consts(a = {:?}, b = {:?})", relation.tag(), a, b);
 581     let tcx = relation.tcx();
 582
 583     let a_ty;
 584     let b_ty;
 585     if relation.tcx().features().adt_const_params {
 586         a_ty = tcx.normalize_erasing_regions(relation.param_env(), a.ty());
 587         b_ty = tcx.normalize_erasing_regions(relation.param_env(), b.ty());
 588     } else {
 589         a_ty = tcx.erase_regions(a.ty());
 590         b_ty = tcx.erase_regions(b.ty());
 591     }
 592     if a_ty != b_ty {
 593         relation.tcx().sess.delay_span_bug(
 594             DUMMY_SP,
 595             &format!("cannot relate constants of different types: {} != {}", a_ty, b_ty),
 596         );
 597     }
 598
 599     // Currently, the values that can be unified are primitive types,
 600     // and those that derive both `PartialEq` and `Eq`, corresponding
 601     // to structural-match types.
 602     let is_match = match (a.kind(), b.kind()) {
 603         (ty::ConstKind::Infer(_), _) | (_, ty::ConstKind::Infer(_)) => {
 604             // The caller should handle these cases!
 605             bug!("var types encountered in super_relate_consts: {:?} {:?}", a, b)
 606         }
 607
 608         (ty::ConstKind::Error(_), _) => return Ok(a),
 609         (_, ty::ConstKind::Error(_)) => return Ok(b),
 610
 611         (ty::ConstKind::Param(a_p), ty::ConstKind::Param(b_p)) => a_p.index == b_p.index,
 612         (ty::ConstKind::Placeholder(p1), ty::ConstKind::Placeholder(p2)) => p1 == p2,
 613         (ty::ConstKind::Value(a_val), ty::ConstKind::Value(b_val)) => a_val == b_val,
 614
 615         (ty::ConstKind::Unevaluated(au), ty::ConstKind::Unevaluated(bu))
 616             if tcx.features().generic_const_exprs =>
 617         {
 618             tcx.try_unify_abstract_consts(relation.param_env().and((au, bu)))
 619         }
 620
 621         // While this is slightly incorrect, it shouldn't matter for `min_const_generics`
 622         // and is the better alternative to waiting until `generic_const_exprs` can
 623         // be stabilized.
 624         (ty::ConstKind::Unevaluated(au), ty::ConstKind::Unevaluated(bu)) if au.def == bu.def => {
 625             let substs = relation.relate_with_variance(
 626                 ty::Variance::Invariant,
 627                 ty::VarianceDiagInfo::default(),
 628                 au.substs,
 629                 bu.substs,
 630             )?;
 631             return Ok(tcx.mk_const(ty::ConstS {
 632                 kind: ty::ConstKind::Unevaluated(ty::UnevaluatedConst { def: au.def, substs }),
 633                 ty: a.ty(),
 634             }));
 635         }
 636         _ => false,
 637     };
 638     if is_match { Ok(a) } else { Err(TypeError::ConstMismatch(expected_found(relation, a, b))) }
 639 }
 640
 641 impl<'tcx> Relate<'tcx> for &'tcx ty::List<ty::Binder<'tcx, ty::ExistentialPredicate<'tcx>>> {
 642     fn relate<R: TypeRelation<'tcx>>(
 643         relation: &mut R,
 644         a: Self,
 645         b: Self,
 646     ) -> RelateResult<'tcx, Self> {
 647         let tcx = relation.tcx();
 648
 649         // FIXME: this is wasteful, but want to do a perf run to see how slow it is.
 650         // We need to perform this deduplication as we sometimes generate duplicate projections
 651         // in `a`.
 652         let mut a_v: Vec<_> = a.into_iter().collect();
 653         let mut b_v: Vec<_> = b.into_iter().collect();
 654         // `skip_binder` here is okay because `stable_cmp` doesn't look at binders
 655         a_v.sort_by(|a, b| a.skip_binder().stable_cmp(tcx, &b.skip_binder()));
 656         a_v.dedup();
 657         b_v.sort_by(|a, b| a.skip_binder().stable_cmp(tcx, &b.skip_binder()));
 658         b_v.dedup();
 659         if a_v.len() != b_v.len() {
 660             return Err(TypeError::ExistentialMismatch(expected_found(relation, a, b)));
 661         }
 662
 663         let v = iter::zip(a_v, b_v).map(|(ep_a, ep_b)| {
 664             use crate::ty::ExistentialPredicate::*;
 665             match (ep_a.skip_binder(), ep_b.skip_binder()) {
 666                 (Trait(a), Trait(b)) => Ok(ep_a
 667                     .rebind(Trait(relation.relate(ep_a.rebind(a), ep_b.rebind(b))?.skip_binder()))),
 668                 (Projection(a), Projection(b)) => Ok(ep_a.rebind(Projection(
 669                     relation.relate(ep_a.rebind(a), ep_b.rebind(b))?.skip_binder(),
 670                 ))),
 671                 (AutoTrait(a), AutoTrait(b)) if a == b => Ok(ep_a.rebind(AutoTrait(a))),
 672                 _ => Err(TypeError::ExistentialMismatch(expected_found(relation, a, b))),
 673             }
 674         });
 675         tcx.mk_poly_existential_predicates(v)
 676     }
 677 }
 678
 679 impl<'tcx> Relate<'tcx> for ty::ClosureSubsts<'tcx> {
 680     fn relate<R: TypeRelation<'tcx>>(
 681         relation: &mut R,
 682         a: ty::ClosureSubsts<'tcx>,
 683         b: ty::ClosureSubsts<'tcx>,
 684     ) -> RelateResult<'tcx, ty::ClosureSubsts<'tcx>> {
 685         let substs = relate_substs(relation, a.substs, b.substs)?;
 686         Ok(ty::ClosureSubsts { substs })
 687     }
 688 }
 689
 690 impl<'tcx> Relate<'tcx> for ty::GeneratorSubsts<'tcx> {
 691     fn relate<R: TypeRelation<'tcx>>(
 692         relation: &mut R,
 693         a: ty::GeneratorSubsts<'tcx>,
 694         b: ty::GeneratorSubsts<'tcx>,
 695     ) -> RelateResult<'tcx, ty::GeneratorSubsts<'tcx>> {
 696         let substs = relate_substs(relation, a.substs, b.substs)?;
 697         Ok(ty::GeneratorSubsts { substs })
 698     }
 699 }
 700
 701 impl<'tcx> Relate<'tcx> for SubstsRef<'tcx> {
 702     fn relate<R: TypeRelation<'tcx>>(
 703         relation: &mut R,
 704         a: SubstsRef<'tcx>,
 705         b: SubstsRef<'tcx>,
 706     ) -> RelateResult<'tcx, SubstsRef<'tcx>> {
 707         relate_substs(relation, a, b)
 708     }
 709 }
 710
 711 impl<'tcx> Relate<'tcx> for ty::Region<'tcx> {
 712     fn relate<R: TypeRelation<'tcx>>(
 713         relation: &mut R,
 714         a: ty::Region<'tcx>,
 715         b: ty::Region<'tcx>,
 716     ) -> RelateResult<'tcx, ty::Region<'tcx>> {
 717         relation.regions(a, b)
 718     }
 719 }
 720
 721 impl<'tcx> Relate<'tcx> for ty::Const<'tcx> {
 722     fn relate<R: TypeRelation<'tcx>>(
 723         relation: &mut R,
 724         a: ty::Const<'tcx>,
 725         b: ty::Const<'tcx>,
 726     ) -> RelateResult<'tcx, ty::Const<'tcx>> {
 727         relation.consts(a, b)
 728     }
 729 }
 730
 731 impl<'tcx, T: Relate<'tcx>> Relate<'tcx> for ty::Binder<'tcx, T> {
 732     fn relate<R: TypeRelation<'tcx>>(
 733         relation: &mut R,
 734         a: ty::Binder<'tcx, T>,
 735         b: ty::Binder<'tcx, T>,
 736     ) -> RelateResult<'tcx, ty::Binder<'tcx, T>> {
 737         relation.binders(a, b)
 738     }
 739 }
 740
 741 impl<'tcx> Relate<'tcx> for GenericArg<'tcx> {
 742     fn relate<R: TypeRelation<'tcx>>(
 743         relation: &mut R,
 744         a: GenericArg<'tcx>,
 745         b: GenericArg<'tcx>,
 746     ) -> RelateResult<'tcx, GenericArg<'tcx>> {
 747         match (a.unpack(), b.unpack()) {
 748             (GenericArgKind::Lifetime(a_lt), GenericArgKind::Lifetime(b_lt)) => {
 749                 Ok(relation.relate(a_lt, b_lt)?.into())
 750             }
 751             (GenericArgKind::Type(a_ty), GenericArgKind::Type(b_ty)) => {
 752                 Ok(relation.relate(a_ty, b_ty)?.into())
 753             }
 754             (GenericArgKind::Const(a_ct), GenericArgKind::Const(b_ct)) => {
 755                 Ok(relation.relate(a_ct, b_ct)?.into())
 756             }
 757             (GenericArgKind::Lifetime(unpacked), x) => {
 758                 bug!("impossible case reached: can't relate: {:?} with {:?}", unpacked, x)
 759             }
 760             (GenericArgKind::Type(unpacked), x) => {
 761                 bug!("impossible case reached: can't relate: {:?} with {:?}", unpacked, x)
 762             }
 763             (GenericArgKind::Const(unpacked), x) => {
 764                 bug!("impossible case reached: can't relate: {:?} with {:?}", unpacked, x)
 765             }
 766         }
 767     }
 768 }
 769
 770 impl<'tcx> Relate<'tcx> for ty::ImplPolarity {
 771     fn relate<R: TypeRelation<'tcx>>(
 772         relation: &mut R,
 773         a: ty::ImplPolarity,
 774         b: ty::ImplPolarity,
 775     ) -> RelateResult<'tcx, ty::ImplPolarity> {
 776         if a != b {
 777             Err(TypeError::PolarityMismatch(expected_found(relation, a, b)))
 778         } else {
 779             Ok(a)
 780         }
 781     }
 782 }
 783
 784 impl<'tcx> Relate<'tcx> for ty::TraitPredicate<'tcx> {
 785     fn relate<R: TypeRelation<'tcx>>(
 786         relation: &mut R,
 787         a: ty::TraitPredicate<'tcx>,
 788         b: ty::TraitPredicate<'tcx>,
 789     ) -> RelateResult<'tcx, ty::TraitPredicate<'tcx>> {
 790         Ok(ty::TraitPredicate {
 791             trait_ref: relation.relate(a.trait_ref, b.trait_ref)?,
 792             constness: relation.relate(a.constness, b.constness)?,
 793             polarity: relation.relate(a.polarity, b.polarity)?,
 794         })
 795     }
 796 }
 797
 798 impl<'tcx> Relate<'tcx> for Term<'tcx> {
 799     fn relate<R: TypeRelation<'tcx>>(
 800         relation: &mut R,
 801         a: Self,
 802         b: Self,
 803     ) -> RelateResult<'tcx, Self> {
 804         Ok(match (a.unpack(), b.unpack()) {
 805             (TermKind::Ty(a), TermKind::Ty(b)) => relation.relate(a, b)?.into(),
 806             (TermKind::Const(a), TermKind::Const(b)) => relation.relate(a, b)?.into(),
 807             _ => return Err(TypeError::Mismatch),
 808         })
 809     }
 810 }
 811
 812 impl<'tcx> Relate<'tcx> for ty::ProjectionPredicate<'tcx> {
 813     fn relate<R: TypeRelation<'tcx>>(
 814         relation: &mut R,
 815         a: ty::ProjectionPredicate<'tcx>,
 816         b: ty::ProjectionPredicate<'tcx>,
 817     ) -> RelateResult<'tcx, ty::ProjectionPredicate<'tcx>> {
 818         Ok(ty::ProjectionPredicate {
 819             projection_ty: relation.relate(a.projection_ty, b.projection_ty)?,
 820             term: relation.relate(a.term, b.term)?,
 821         })
 822     }
 823 }
 824
 825 ///////////////////////////////////////////////////////////////////////////
 826 // Error handling
 827
 828 pub fn expected_found<'tcx, R, T>(relation: &mut R, a: T, b: T) -> ExpectedFound<T>
 829 where
 830     R: TypeRelation<'tcx>,
 831 {
 832     ExpectedFound::new(relation.a_is_expected(), a, b)
 833 }