compiler/rustc_infer/src/infer/opaque_types.rs

   1 use crate::infer::{DefiningAnchor, InferCtxt, InferOk};
   2 use crate::traits;
   3 use hir::def_id::{DefId, LocalDefId};
   4 use hir::{HirId, OpaqueTyOrigin};
   5 use rustc_data_structures::sync::Lrc;
   6 use rustc_data_structures::vec_map::VecMap;
   7 use rustc_hir as hir;
   8 use rustc_middle::traits::ObligationCause;
   9 use rustc_middle::ty::fold::BottomUpFolder;
  10 use rustc_middle::ty::subst::{GenericArgKind, Subst};
  11 use rustc_middle::ty::{
  12     self, OpaqueHiddenType, OpaqueTypeKey, Ty, TyCtxt, TypeFoldable, TypeSuperVisitable,
  13     TypeVisitable, TypeVisitor,
  14 };
  15 use rustc_span::Span;
  16
  17 use std::ops::ControlFlow;
  18
  19 pub type OpaqueTypeMap<'tcx> = VecMap<OpaqueTypeKey<'tcx>, OpaqueTypeDecl<'tcx>>;
  20
  21 mod table;
  22
  23 pub use table::{OpaqueTypeStorage, OpaqueTypeTable};
  24
  25 use super::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
  26 use super::InferResult;
  27
  28 /// Information about the opaque types whose values we
  29 /// are inferring in this function (these are the `impl Trait` that
  30 /// appear in the return type).
  31 #[derive(Clone, Debug)]
  32 pub struct OpaqueTypeDecl<'tcx> {
  33     /// The hidden types that have been inferred for this opaque type.
  34     /// There can be multiple, but they are all `lub`ed together at the end
  35     /// to obtain the canonical hidden type.
  36     pub hidden_type: OpaqueHiddenType<'tcx>,
  37
  38     /// The origin of the opaque type.
  39     pub origin: hir::OpaqueTyOrigin,
  40 }
  41
  42 impl<'a, 'tcx> InferCtxt<'a, 'tcx> {
  43     pub fn replace_opaque_types_with_inference_vars(
  44         &self,
  45         ty: Ty<'tcx>,
  46         body_id: HirId,
  47         span: Span,
  48         param_env: ty::ParamEnv<'tcx>,
  49     ) -> InferOk<'tcx, Ty<'tcx>> {
  50         if !ty.has_opaque_types() {
  51             return InferOk { value: ty, obligations: vec![] };
  52         }
  53         let mut obligations = vec![];
  54         let replace_opaque_type = |def_id: DefId| {
  55             def_id
  56                 .as_local()
  57                 .map_or(false, |def_id| self.opaque_type_origin(def_id, span).is_some())
  58         };
  59         let value = ty.fold_with(&mut ty::fold::BottomUpFolder {
  60             tcx: self.tcx,
  61             lt_op: |lt| lt,
  62             ct_op: |ct| ct,
  63             ty_op: |ty| match *ty.kind() {
  64                 ty::Opaque(def_id, _substs) if replace_opaque_type(def_id) => {
  65                     let def_span = self.tcx.def_span(def_id);
  66                     let span = if span.contains(def_span) { def_span } else { span };
  67                     let code = traits::ObligationCauseCode::OpaqueReturnType(None);
  68                     let cause = ObligationCause::new(span, body_id, code);
  69                     // FIXME(compiler-errors): We probably should add a new TypeVariableOriginKind
  70                     // for opaque types, and then use that kind to fix the spans for type errors
  71                     // that we see later on.
  72                     let ty_var = self.next_ty_var(TypeVariableOrigin {
  73                         kind: TypeVariableOriginKind::TypeInference,
  74                         span,
  75                     });
  76                     obligations.extend(
  77                         self.handle_opaque_type(ty, ty_var, true, &cause, param_env)
  78                             .unwrap()
  79                             .obligations,
  80                     );
  81                     ty_var
  82                 }
  83                 _ => ty,
  84             },
  85         });
  86         InferOk { value, obligations }
  87     }
  88
  89     pub fn handle_opaque_type(
  90         &self,
  91         a: Ty<'tcx>,
  92         b: Ty<'tcx>,
  93         a_is_expected: bool,
  94         cause: &ObligationCause<'tcx>,
  95         param_env: ty::ParamEnv<'tcx>,
  96     ) -> InferResult<'tcx, ()> {
  97         if a.references_error() || b.references_error() {
  98             return Ok(InferOk { value: (), obligations: vec![] });
  99         }
 100         let (a, b) = if a_is_expected { (a, b) } else { (b, a) };
 101         let process = |a: Ty<'tcx>, b: Ty<'tcx>| match *a.kind() {
 102             ty::Opaque(def_id, substs) if def_id.is_local() => {
 103                 let def_id = def_id.expect_local();
 104                 let origin = match self.defining_use_anchor {
 105                     DefiningAnchor::Bind(_) => {
 106                         // Check that this is `impl Trait` type is
 107                         // declared by `parent_def_id` -- i.e., one whose
 108                         // value we are inferring.  At present, this is
 109                         // always true during the first phase of
 110                         // type-check, but not always true later on during
 111                         // NLL. Once we support named opaque types more fully,
 112                         // this same scenario will be able to arise during all phases.
 113                         //
 114                         // Here is an example using type alias `impl Trait`
 115                         // that indicates the distinction we are checking for:
 116                         //
 117                         // ```rust
 118                         // mod a {
 119                         //   pub type Foo = impl Iterator;
 120                         //   pub fn make_foo() -> Foo { .. }
 121                         // }
 122                         //
 123                         // mod b {
 124                         //   fn foo() -> a::Foo { a::make_foo() }
 125                         // }
 126                         // ```
 127                         //
 128                         // Here, the return type of `foo` references an
 129                         // `Opaque` indeed, but not one whose value is
 130                         // presently being inferred. You can get into a
 131                         // similar situation with closure return types
 132                         // today:
 133                         //
 134                         // ```rust
 135                         // fn foo() -> impl Iterator { .. }
 136                         // fn bar() {
 137                         //     let x = || foo(); // returns the Opaque assoc with `foo`
 138                         // }
 139                         // ```
 140                         self.opaque_type_origin(def_id, cause.span)?
 141                     }
 142                     DefiningAnchor::Bubble => self.opaque_ty_origin_unchecked(def_id, cause.span),
 143                     DefiningAnchor::Error => return None,
 144                 };
 145                 if let ty::Opaque(did2, _) = *b.kind() {
 146                     // We could accept this, but there are various ways to handle this situation, and we don't
 147                     // want to make a decision on it right now. Likely this case is so super rare anyway, that
 148                     // no one encounters it in practice.
 149                     // It does occur however in `fn fut() -> impl Future<Output = i32> { async { 42 } }`,
 150                     // where it is of no concern, so we only check for TAITs.
 151                     if let Some(OpaqueTyOrigin::TyAlias) =
 152                         did2.as_local().and_then(|did2| self.opaque_type_origin(did2, cause.span))
 153                     {
 154                         self.tcx
 155                                 .sess
 156                                 .struct_span_err(
 157                                     cause.span,
 158                                     "opaque type's hidden type cannot be another opaque type from the same scope",
 159                                 )
 160                                 .span_label(cause.span, "one of the two opaque types used here has to be outside its defining scope")
 161                                 .span_note(
 162                                     self.tcx.def_span(def_id),
 163                                     "opaque type whose hidden type is being assigned",
 164                                 )
 165                                 .span_note(
 166                                     self.tcx.def_span(did2),
 167                                     "opaque type being used as hidden type",
 168                                 )
 169                                 .emit();
 170                     }
 171                 }
 172                 Some(self.register_hidden_type(
 173                     OpaqueTypeKey { def_id, substs },
 174                     cause.clone(),
 175                     param_env,
 176                     b,
 177                     origin,
 178                 ))
 179             }
 180             _ => None,
 181         };
 182         if let Some(res) = process(a, b) {
 183             res
 184         } else if let Some(res) = process(b, a) {
 185             res
 186         } else {
 187             // Rerun equality check, but this time error out due to
 188             // different types.
 189             match self.at(cause, param_env).define_opaque_types(false).eq(a, b) {
 190                 Ok(_) => span_bug!(
 191                     cause.span,
 192                     "opaque types are never equal to anything but themselves: {:#?}",
 193                     (a.kind(), b.kind())
 194                 ),
 195                 Err(e) => Err(e),
 196             }
 197         }
 198     }
 199
 200     /// Given the map `opaque_types` containing the opaque
 201     /// `impl Trait` types whose underlying, hidden types are being
 202     /// inferred, this method adds constraints to the regions
 203     /// appearing in those underlying hidden types to ensure that they
 204     /// at least do not refer to random scopes within the current
 205     /// function. These constraints are not (quite) sufficient to
 206     /// guarantee that the regions are actually legal values; that
 207     /// final condition is imposed after region inference is done.
 208     ///
 209     /// # The Problem
 210     ///
 211     /// Let's work through an example to explain how it works. Assume
 212     /// the current function is as follows:
 213     ///
 214     /// ```text
 215     /// fn foo<'a, 'b>(..) -> (impl Bar<'a>, impl Bar<'b>)
 216     /// ```
 217     ///
 218     /// Here, we have two `impl Trait` types whose values are being
 219     /// inferred (the `impl Bar<'a>` and the `impl
 220     /// Bar<'b>`). Conceptually, this is sugar for a setup where we
 221     /// define underlying opaque types (`Foo1`, `Foo2`) and then, in
 222     /// the return type of `foo`, we *reference* those definitions:
 223     ///
 224     /// ```text
 225     /// type Foo1<'x> = impl Bar<'x>;
 226     /// type Foo2<'x> = impl Bar<'x>;
 227     /// fn foo<'a, 'b>(..) -> (Foo1<'a>, Foo2<'b>) { .. }
 228     ///                    //  ^^^^ ^^
 229     ///                    //  |    |
 230     ///                    //  |    substs
 231     ///                    //  def_id
 232     /// ```
 233     ///
 234     /// As indicating in the comments above, each of those references
 235     /// is (in the compiler) basically a substitution (`substs`)
 236     /// applied to the type of a suitable `def_id` (which identifies
 237     /// `Foo1` or `Foo2`).
 238     ///
 239     /// Now, at this point in compilation, what we have done is to
 240     /// replace each of the references (`Foo1<'a>`, `Foo2<'b>`) with
 241     /// fresh inference variables C1 and C2. We wish to use the values
 242     /// of these variables to infer the underlying types of `Foo1` and
 243     /// `Foo2`. That is, this gives rise to higher-order (pattern) unification
 244     /// constraints like:
 245     ///
 246     /// ```text
 247     /// for<'a> (Foo1<'a> = C1)
 248     /// for<'b> (Foo1<'b> = C2)
 249     /// ```
 250     ///
 251     /// For these equation to be satisfiable, the types `C1` and `C2`
 252     /// can only refer to a limited set of regions. For example, `C1`
 253     /// can only refer to `'static` and `'a`, and `C2` can only refer
 254     /// to `'static` and `'b`. The job of this function is to impose that
 255     /// constraint.
 256     ///
 257     /// Up to this point, C1 and C2 are basically just random type
 258     /// inference variables, and hence they may contain arbitrary
 259     /// regions. In fact, it is fairly likely that they do! Consider
 260     /// this possible definition of `foo`:
 261     ///
 262     /// ```text
 263     /// fn foo<'a, 'b>(x: &'a i32, y: &'b i32) -> (impl Bar<'a>, impl Bar<'b>) {
 264     ///         (&*x, &*y)
 265     ///     }
 266     /// ```
 267     ///
 268     /// Here, the values for the concrete types of the two impl
 269     /// traits will include inference variables:
 270     ///
 271     /// ```text
 272     /// &'0 i32
 273     /// &'1 i32
 274     /// ```
 275     ///
 276     /// Ordinarily, the subtyping rules would ensure that these are
 277     /// sufficiently large. But since `impl Bar<'a>` isn't a specific
 278     /// type per se, we don't get such constraints by default. This
 279     /// is where this function comes into play. It adds extra
 280     /// constraints to ensure that all the regions which appear in the
 281     /// inferred type are regions that could validly appear.
 282     ///
 283     /// This is actually a bit of a tricky constraint in general. We
 284     /// want to say that each variable (e.g., `'0`) can only take on
 285     /// values that were supplied as arguments to the opaque type
 286     /// (e.g., `'a` for `Foo1<'a>`) or `'static`, which is always in
 287     /// scope. We don't have a constraint quite of this kind in the current
 288     /// region checker.
 289     ///
 290     /// # The Solution
 291     ///
 292     /// We generally prefer to make `<=` constraints, since they
 293     /// integrate best into the region solver. To do that, we find the
 294     /// "minimum" of all the arguments that appear in the substs: that
 295     /// is, some region which is less than all the others. In the case
 296     /// of `Foo1<'a>`, that would be `'a` (it's the only choice, after
 297     /// all). Then we apply that as a least bound to the variables
 298     /// (e.g., `'a <= '0`).
 299     ///
 300     /// In some cases, there is no minimum. Consider this example:
 301     ///
 302     /// ```text
 303     /// fn baz<'a, 'b>() -> impl Trait<'a, 'b> { ... }
 304     /// ```
 305     ///
 306     /// Here we would report a more complex "in constraint", like `'r
 307     /// in ['a, 'b, 'static]` (where `'r` is some region appearing in
 308     /// the hidden type).
 309     ///
 310     /// # Constrain regions, not the hidden concrete type
 311     ///
 312     /// Note that generating constraints on each region `Rc` is *not*
 313     /// the same as generating an outlives constraint on `Tc` itself.
 314     /// For example, if we had a function like this:
 315     ///
 316     /// ```
 317     /// # #![feature(type_alias_impl_trait)]
 318     /// # fn main() {}
 319     /// # trait Foo<'a> {}
 320     /// # impl<'a, T> Foo<'a> for (&'a u32, T) {}
 321     /// fn foo<'a, T>(x: &'a u32, y: T) -> impl Foo<'a> {
 322     ///   (x, y)
 323     /// }
 324     ///
 325     /// // Equivalent to:
 326     /// # mod dummy { use super::*;
 327     /// type FooReturn<'a, T> = impl Foo<'a>;
 328     /// fn foo<'a, T>(x: &'a u32, y: T) -> FooReturn<'a, T> {
 329     ///   (x, y)
 330     /// }
 331     /// # }
 332     /// ```
 333     ///
 334     /// then the hidden type `Tc` would be `(&'0 u32, T)` (where `'0`
 335     /// is an inference variable). If we generated a constraint that
 336     /// `Tc: 'a`, then this would incorrectly require that `T: 'a` --
 337     /// but this is not necessary, because the opaque type we
 338     /// create will be allowed to reference `T`. So we only generate a
 339     /// constraint that `'0: 'a`.
 340     #[instrument(level = "debug", skip(self))]
 341     pub fn register_member_constraints(
 342         &self,
 343         param_env: ty::ParamEnv<'tcx>,
 344         opaque_type_key: OpaqueTypeKey<'tcx>,
 345         concrete_ty: Ty<'tcx>,
 346         span: Span,
 347     ) {
 348         let def_id = opaque_type_key.def_id;
 349
 350         let tcx = self.tcx;
 351
 352         let concrete_ty = self.resolve_vars_if_possible(concrete_ty);
 353
 354         debug!(?concrete_ty);
 355
 356         let first_own_region = match self.opaque_ty_origin_unchecked(def_id, span) {
 357             hir::OpaqueTyOrigin::FnReturn(..) | hir::OpaqueTyOrigin::AsyncFn(..) => {
 358                 // We lower
 359                 //
 360                 // fn foo<'l0..'ln>() -> impl Trait<'l0..'lm>
 361                 //
 362                 // into
 363                 //
 364                 // type foo::<'p0..'pn>::Foo<'q0..'qm>
 365                 // fn foo<l0..'ln>() -> foo::<'static..'static>::Foo<'l0..'lm>.
 366                 //
 367                 // For these types we only iterate over `'l0..lm` below.
 368                 tcx.generics_of(def_id).parent_count
 369             }
 370             // These opaque type inherit all lifetime parameters from their
 371             // parent, so we have to check them all.
 372             hir::OpaqueTyOrigin::TyAlias => 0,
 373         };
 374
 375         // For a case like `impl Foo<'a, 'b>`, we would generate a constraint
 376         // `'r in ['a, 'b, 'static]` for each region `'r` that appears in the
 377         // hidden type (i.e., it must be equal to `'a`, `'b`, or `'static`).
 378         //
 379         // `conflict1` and `conflict2` are the two region bounds that we
 380         // detected which were unrelated. They are used for diagnostics.
 381
 382         // Create the set of choice regions: each region in the hidden
 383         // type can be equal to any of the region parameters of the
 384         // opaque type definition.
 385         let choice_regions: Lrc<Vec<ty::Region<'tcx>>> = Lrc::new(
 386             opaque_type_key.substs[first_own_region..]
 387                 .iter()
 388                 .filter_map(|arg| match arg.unpack() {
 389                     GenericArgKind::Lifetime(r) => Some(r),
 390                     GenericArgKind::Type(_) | GenericArgKind::Const(_) => None,
 391                 })
 392                 .chain(std::iter::once(self.tcx.lifetimes.re_static))
 393                 .collect(),
 394         );
 395
 396         concrete_ty.visit_with(&mut ConstrainOpaqueTypeRegionVisitor {
 397             op: |r| {
 398                 self.member_constraint(
 399                     opaque_type_key.def_id,
 400                     span,
 401                     concrete_ty,
 402                     r,
 403                     &choice_regions,
 404                 )
 405             },
 406         });
 407     }
 408
 409     #[instrument(skip(self), level = "trace")]
 410     pub fn opaque_type_origin(&self, def_id: LocalDefId, span: Span) -> Option<OpaqueTyOrigin> {
 411         let opaque_hir_id = self.tcx.hir().local_def_id_to_hir_id(def_id);
 412         let parent_def_id = match self.defining_use_anchor {
 413             DefiningAnchor::Bubble | DefiningAnchor::Error => return None,
 414             DefiningAnchor::Bind(bind) => bind,
 415         };
 416         let item_kind = &self.tcx.hir().expect_item(def_id).kind;
 417
 418         let hir::ItemKind::OpaqueTy(hir::OpaqueTy { origin, ..  }) = item_kind else {
 419             span_bug!(
 420                 span,
 421                 "weird opaque type: {:#?}, {:#?}",
 422                 def_id,
 423                 item_kind
 424             )
 425         };
 426         let in_definition_scope = match *origin {
 427             // Async `impl Trait`
 428             hir::OpaqueTyOrigin::AsyncFn(parent) => parent == parent_def_id,
 429             // Anonymous `impl Trait`
 430             hir::OpaqueTyOrigin::FnReturn(parent) => parent == parent_def_id,
 431             // Named `type Foo = impl Bar;`
 432             hir::OpaqueTyOrigin::TyAlias => {
 433                 may_define_opaque_type(self.tcx, parent_def_id, opaque_hir_id)
 434             }
 435         };
 436         trace!(?origin);
 437         in_definition_scope.then_some(*origin)
 438     }
 439
 440     #[instrument(skip(self), level = "trace")]
 441     pub fn opaque_ty_origin_unchecked(&self, def_id: LocalDefId, span: Span) -> OpaqueTyOrigin {
 442         let origin = match self.tcx.hir().expect_item(def_id).kind {
 443             hir::ItemKind::OpaqueTy(hir::OpaqueTy { origin, .. }) => origin,
 444             ref itemkind => {
 445                 span_bug!(span, "weird opaque type: {:?}, {:#?}", def_id, itemkind)
 446             }
 447         };
 448         trace!(?origin);
 449         origin
 450     }
 451 }
 452
 453 // Visitor that requires that (almost) all regions in the type visited outlive
 454 // `least_region`. We cannot use `push_outlives_components` because regions in
 455 // closure signatures are not included in their outlives components. We need to
 456 // ensure all regions outlive the given bound so that we don't end up with,
 457 // say, `ReVar` appearing in a return type and causing ICEs when other
 458 // functions end up with region constraints involving regions from other
 459 // functions.
 460 //
 461 // We also cannot use `for_each_free_region` because for closures it includes
 462 // the regions parameters from the enclosing item.
 463 //
 464 // We ignore any type parameters because impl trait values are assumed to
 465 // capture all the in-scope type parameters.
 466 struct ConstrainOpaqueTypeRegionVisitor<OP> {
 467     op: OP,
 468 }
 469
 470 impl<'tcx, OP> TypeVisitor<'tcx> for ConstrainOpaqueTypeRegionVisitor<OP>
 471 where
 472     OP: FnMut(ty::Region<'tcx>),
 473 {
 474     fn visit_binder<T: TypeVisitable<'tcx>>(
 475         &mut self,
 476         t: &ty::Binder<'tcx, T>,
 477     ) -> ControlFlow<Self::BreakTy> {
 478         t.super_visit_with(self);
 479         ControlFlow::CONTINUE
 480     }
 481
 482     fn visit_region(&mut self, r: ty::Region<'tcx>) -> ControlFlow<Self::BreakTy> {
 483         match *r {
 484             // ignore bound regions, keep visiting
 485             ty::ReLateBound(_, _) => ControlFlow::CONTINUE,
 486             _ => {
 487                 (self.op)(r);
 488                 ControlFlow::CONTINUE
 489             }
 490         }
 491     }
 492
 493     fn visit_ty(&mut self, ty: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
 494         // We're only interested in types involving regions
 495         if !ty.flags().intersects(ty::TypeFlags::HAS_FREE_REGIONS) {
 496             return ControlFlow::CONTINUE;
 497         }
 498
 499         match ty.kind() {
 500             ty::Closure(_, ref substs) => {
 501                 // Skip lifetime parameters of the enclosing item(s)
 502
 503                 substs.as_closure().tupled_upvars_ty().visit_with(self);
 504                 substs.as_closure().sig_as_fn_ptr_ty().visit_with(self);
 505             }
 506
 507             ty::Generator(_, ref substs, _) => {
 508                 // Skip lifetime parameters of the enclosing item(s)
 509                 // Also skip the witness type, because that has no free regions.
 510
 511                 substs.as_generator().tupled_upvars_ty().visit_with(self);
 512                 substs.as_generator().return_ty().visit_with(self);
 513                 substs.as_generator().yield_ty().visit_with(self);
 514                 substs.as_generator().resume_ty().visit_with(self);
 515             }
 516             _ => {
 517                 ty.super_visit_with(self);
 518             }
 519         }
 520
 521         ControlFlow::CONTINUE
 522     }
 523 }
 524
 525 pub enum UseKind {
 526     DefiningUse,
 527     OpaqueUse,
 528 }
 529
 530 impl UseKind {
 531     pub fn is_defining(self) -> bool {
 532         match self {
 533             UseKind::DefiningUse => true,
 534             UseKind::OpaqueUse => false,
 535         }
 536     }
 537 }
 538
 539 impl<'a, 'tcx> InferCtxt<'a, 'tcx> {
 540     #[instrument(skip(self), level = "debug")]
 541     pub fn register_hidden_type(
 542         &self,
 543         opaque_type_key: OpaqueTypeKey<'tcx>,
 544         cause: ObligationCause<'tcx>,
 545         param_env: ty::ParamEnv<'tcx>,
 546         hidden_ty: Ty<'tcx>,
 547         origin: hir::OpaqueTyOrigin,
 548     ) -> InferResult<'tcx, ()> {
 549         let tcx = self.tcx;
 550         let OpaqueTypeKey { def_id, substs } = opaque_type_key;
 551
 552         // Ideally, we'd get the span where *this specific `ty` came
 553         // from*, but right now we just use the span from the overall
 554         // value being folded. In simple cases like `-> impl Foo`,
 555         // these are the same span, but not in cases like `-> (impl
 556         // Foo, impl Bar)`.
 557         let span = cause.span;
 558
 559         let mut obligations = vec![];
 560         let prev = self.inner.borrow_mut().opaque_types().register(
 561             OpaqueTypeKey { def_id, substs },
 562             OpaqueHiddenType { ty: hidden_ty, span },
 563             origin,
 564         );
 565         if let Some(prev) = prev {
 566             obligations = self.at(&cause, param_env).eq(prev, hidden_ty)?.obligations;
 567         }
 568
 569         let item_bounds = tcx.bound_explicit_item_bounds(def_id.to_def_id());
 570
 571         for predicate in item_bounds.transpose_iter().map(|e| e.map_bound(|(p, _)| *p)) {
 572             debug!(?predicate);
 573             let predicate = predicate.subst(tcx, substs);
 574
 575             let predicate = predicate.fold_with(&mut BottomUpFolder {
 576                 tcx,
 577                 ty_op: |ty| match *ty.kind() {
 578                     // We can't normalize associated types from `rustc_infer`,
 579                     // but we can eagerly register inference variables for them.
 580                     ty::Projection(projection_ty) if !projection_ty.has_escaping_bound_vars() => {
 581                         self.infer_projection(
 582                             param_env,
 583                             projection_ty,
 584                             cause.clone(),
 585                             0,
 586                             &mut obligations,
 587                         )
 588                     }
 589                     // Replace all other mentions of the same opaque type with the hidden type,
 590                     // as the bounds must hold on the hidden type after all.
 591                     ty::Opaque(def_id2, substs2)
 592                         if def_id.to_def_id() == def_id2 && substs == substs2 =>
 593                     {
 594                         hidden_ty
 595                     }
 596                     _ => ty,
 597                 },
 598                 lt_op: |lt| lt,
 599                 ct_op: |ct| ct,
 600             });
 601
 602             if let ty::PredicateKind::Projection(projection) = predicate.kind().skip_binder() {
 603                 if projection.term.references_error() {
 604                     // No point on adding these obligations since there's a type error involved.
 605                     return Ok(InferOk { value: (), obligations: vec![] });
 606                 }
 607                 trace!("{:#?}", projection.term);
 608             }
 609             // Require that the predicate holds for the concrete type.
 610             debug!(?predicate);
 611             obligations.push(traits::Obligation::new(cause.clone(), param_env, predicate));
 612         }
 613         Ok(InferOk { value: (), obligations })
 614     }
 615 }
 616
 617 /// Returns `true` if `opaque_hir_id` is a sibling or a child of a sibling of `def_id`.
 618 ///
 619 /// Example:
 620 /// ```ignore UNSOLVED (is this a bug?)
 621 /// # #![feature(type_alias_impl_trait)]
 622 /// pub mod foo {
 623 ///     pub mod bar {
 624 ///         pub trait Bar { /* ... */ }
 625 ///         pub type Baz = impl Bar;
 626 ///
 627 ///         # impl Bar for () {}
 628 ///         fn f1() -> Baz { /* ... */ }
 629 ///     }
 630 ///     fn f2() -> bar::Baz { /* ... */ }
 631 /// }
 632 /// ```
 633 ///
 634 /// Here, `def_id` is the `LocalDefId` of the defining use of the opaque type (e.g., `f1` or `f2`),
 635 /// and `opaque_hir_id` is the `HirId` of the definition of the opaque type `Baz`.
 636 /// For the above example, this function returns `true` for `f1` and `false` for `f2`.
 637 fn may_define_opaque_type(tcx: TyCtxt<'_>, def_id: LocalDefId, opaque_hir_id: hir::HirId) -> bool {
 638     let mut hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
 639
 640     // Named opaque types can be defined by any siblings or children of siblings.
 641     let scope = tcx.hir().get_defining_scope(opaque_hir_id);
 642     // We walk up the node tree until we hit the root or the scope of the opaque type.
 643     while hir_id != scope && hir_id != hir::CRATE_HIR_ID {
 644         hir_id = tcx.hir().local_def_id_to_hir_id(tcx.hir().get_parent_item(hir_id));
 645     }
 646     // Syntactically, we are allowed to define the concrete type if:
 647     let res = hir_id == scope;
 648     trace!(
 649         "may_define_opaque_type(def={:?}, opaque_node={:?}) = {}",
 650         tcx.hir().find(hir_id),
 651         tcx.hir().get(opaque_hir_id),
 652         res
 653     );
 654     res
 655 }