1 use crate::infer::{DefiningAnchor, InferCtxt, InferOk};
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;
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,
17 use std::ops::ControlFlow;
19 pub type OpaqueTypeMap<'tcx> = VecMap<OpaqueTypeKey<'tcx>, OpaqueTypeDecl<'tcx>>;
23 pub use table::{OpaqueTypeStorage, OpaqueTypeTable};
25 use super::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
26 use super::InferResult;
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>,
38 /// The origin of the opaque type.
39 pub origin: hir::OpaqueTyOrigin,
42 impl<'a, 'tcx> InferCtxt<'a, 'tcx> {
43 pub fn replace_opaque_types_with_inference_vars(
48 param_env: ty::ParamEnv<'tcx>,
49 ) -> InferOk<'tcx, Ty<'tcx>> {
50 if !ty.has_opaque_types() {
51 return InferOk { value: ty, obligations: vec![] };
53 let mut obligations = vec![];
54 let replace_opaque_type = |def_id: DefId| {
57 .map_or(false, |def_id| self.opaque_type_origin(def_id, span).is_some())
59 let value = ty.fold_with(&mut ty::fold::BottomUpFolder {
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,
77 self.handle_opaque_type(ty, ty_var, true, &cause, param_env)
86 InferOk { value, obligations }
89 pub fn handle_opaque_type(
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![] });
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.
114 // Here is an example using type alias `impl Trait`
115 // that indicates the distinction we are checking for:
119 // pub type Foo = impl Iterator;
120 // pub fn make_foo() -> Foo { .. }
124 // fn foo() -> a::Foo { a::make_foo() }
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
135 // fn foo() -> impl Iterator { .. }
137 // let x = || foo(); // returns the Opaque assoc with `foo`
140 self.opaque_type_origin(def_id, cause.span)?
142 DefiningAnchor::Bubble => self.opaque_ty_origin_unchecked(def_id, cause.span),
143 DefiningAnchor::Error => return None,
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))
158 "opaque type's hidden type cannot be another opaque type from the same scope",
160 .span_label(cause.span, "one of the two opaque types used here has to be outside its defining scope")
162 self.tcx.def_span(def_id),
163 "opaque type whose hidden type is being assigned",
166 self.tcx.def_span(did2),
167 "opaque type being used as hidden type",
172 Some(self.register_hidden_type(
173 OpaqueTypeKey { def_id, substs },
182 if let Some(res) = process(a, b) {
184 } else if let Some(res) = process(b, a) {
187 // Rerun equality check, but this time error out due to
189 match self.at(cause, param_env).define_opaque_types(false).eq(a, b) {
192 "opaque types are never equal to anything but themselves: {:#?}",
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.
211 /// Let's work through an example to explain how it works. Assume
212 /// the current function is as follows:
215 /// fn foo<'a, 'b>(..) -> (impl Bar<'a>, impl Bar<'b>)
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:
225 /// type Foo1<'x> = impl Bar<'x>;
226 /// type Foo2<'x> = impl Bar<'x>;
227 /// fn foo<'a, 'b>(..) -> (Foo1<'a>, Foo2<'b>) { .. }
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`).
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:
247 /// for<'a> (Foo1<'a> = C1)
248 /// for<'b> (Foo1<'b> = C2)
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
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`:
263 /// fn foo<'a, 'b>(x: &'a i32, y: &'b i32) -> (impl Bar<'a>, impl Bar<'b>) {
268 /// Here, the values for the concrete types of the two impl
269 /// traits will include inference variables:
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.
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
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`).
300 /// In some cases, there is no minimum. Consider this example:
303 /// fn baz<'a, 'b>() -> impl Trait<'a, 'b> { ... }
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).
310 /// # Constrain regions, not the hidden concrete type
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:
317 /// # #![feature(type_alias_impl_trait)]
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> {
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> {
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(
343 param_env: ty::ParamEnv<'tcx>,
344 opaque_type_key: OpaqueTypeKey<'tcx>,
345 concrete_ty: Ty<'tcx>,
348 let def_id = opaque_type_key.def_id;
352 let concrete_ty = self.resolve_vars_if_possible(concrete_ty);
354 debug!(?concrete_ty);
356 let first_own_region = match self.opaque_ty_origin_unchecked(def_id, span) {
357 hir::OpaqueTyOrigin::FnReturn(..) | hir::OpaqueTyOrigin::AsyncFn(..) => {
360 // fn foo<'l0..'ln>() -> impl Trait<'l0..'lm>
364 // type foo::<'p0..'pn>::Foo<'q0..'qm>
365 // fn foo<l0..'ln>() -> foo::<'static..'static>::Foo<'l0..'lm>.
367 // For these types we only iterate over `'l0..lm` below.
368 tcx.generics_of(def_id).parent_count
370 // These opaque type inherit all lifetime parameters from their
371 // parent, so we have to check them all.
372 hir::OpaqueTyOrigin::TyAlias => 0,
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`).
379 // `conflict1` and `conflict2` are the two region bounds that we
380 // detected which were unrelated. They are used for diagnostics.
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..]
388 .filter_map(|arg| match arg.unpack() {
389 GenericArgKind::Lifetime(r) => Some(r),
390 GenericArgKind::Type(_) | GenericArgKind::Const(_) => None,
392 .chain(std::iter::once(self.tcx.lifetimes.re_static))
396 concrete_ty.visit_with(&mut ConstrainOpaqueTypeRegionVisitor {
397 op: |r| self.member_constraint(opaque_type_key, span, concrete_ty, r, &choice_regions),
401 #[instrument(skip(self), level = "trace")]
402 pub fn opaque_type_origin(&self, def_id: LocalDefId, span: Span) -> Option<OpaqueTyOrigin> {
403 let opaque_hir_id = self.tcx.hir().local_def_id_to_hir_id(def_id);
404 let parent_def_id = match self.defining_use_anchor {
405 DefiningAnchor::Bubble | DefiningAnchor::Error => return None,
406 DefiningAnchor::Bind(bind) => bind,
408 let item_kind = &self.tcx.hir().expect_item(def_id).kind;
410 let hir::ItemKind::OpaqueTy(hir::OpaqueTy { origin, .. }) = item_kind else {
413 "weird opaque type: {:#?}, {:#?}",
418 let in_definition_scope = match *origin {
419 // Async `impl Trait`
420 hir::OpaqueTyOrigin::AsyncFn(parent) => parent == parent_def_id,
421 // Anonymous `impl Trait`
422 hir::OpaqueTyOrigin::FnReturn(parent) => parent == parent_def_id,
423 // Named `type Foo = impl Bar;`
424 hir::OpaqueTyOrigin::TyAlias => {
425 may_define_opaque_type(self.tcx, parent_def_id, opaque_hir_id)
429 in_definition_scope.then_some(*origin)
432 #[instrument(skip(self), level = "trace")]
433 pub fn opaque_ty_origin_unchecked(&self, def_id: LocalDefId, span: Span) -> OpaqueTyOrigin {
434 let origin = match self.tcx.hir().expect_item(def_id).kind {
435 hir::ItemKind::OpaqueTy(hir::OpaqueTy { origin, .. }) => origin,
437 span_bug!(span, "weird opaque type: {:?}, {:#?}", def_id, itemkind)
445 // Visitor that requires that (almost) all regions in the type visited outlive
446 // `least_region`. We cannot use `push_outlives_components` because regions in
447 // closure signatures are not included in their outlives components. We need to
448 // ensure all regions outlive the given bound so that we don't end up with,
449 // say, `ReVar` appearing in a return type and causing ICEs when other
450 // functions end up with region constraints involving regions from other
453 // We also cannot use `for_each_free_region` because for closures it includes
454 // the regions parameters from the enclosing item.
456 // We ignore any type parameters because impl trait values are assumed to
457 // capture all the in-scope type parameters.
458 struct ConstrainOpaqueTypeRegionVisitor<OP> {
462 impl<'tcx, OP> TypeVisitor<'tcx> for ConstrainOpaqueTypeRegionVisitor<OP>
464 OP: FnMut(ty::Region<'tcx>),
466 fn visit_binder<T: TypeVisitable<'tcx>>(
468 t: &ty::Binder<'tcx, T>,
469 ) -> ControlFlow<Self::BreakTy> {
470 t.super_visit_with(self);
471 ControlFlow::CONTINUE
474 fn visit_region(&mut self, r: ty::Region<'tcx>) -> ControlFlow<Self::BreakTy> {
476 // ignore bound regions, keep visiting
477 ty::ReLateBound(_, _) => ControlFlow::CONTINUE,
480 ControlFlow::CONTINUE
485 fn visit_ty(&mut self, ty: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
486 // We're only interested in types involving regions
487 if !ty.flags().intersects(ty::TypeFlags::HAS_FREE_REGIONS) {
488 return ControlFlow::CONTINUE;
492 ty::Closure(_, ref substs) => {
493 // Skip lifetime parameters of the enclosing item(s)
495 substs.as_closure().tupled_upvars_ty().visit_with(self);
496 substs.as_closure().sig_as_fn_ptr_ty().visit_with(self);
499 ty::Generator(_, ref substs, _) => {
500 // Skip lifetime parameters of the enclosing item(s)
501 // Also skip the witness type, because that has no free regions.
503 substs.as_generator().tupled_upvars_ty().visit_with(self);
504 substs.as_generator().return_ty().visit_with(self);
505 substs.as_generator().yield_ty().visit_with(self);
506 substs.as_generator().resume_ty().visit_with(self);
509 ty.super_visit_with(self);
513 ControlFlow::CONTINUE
523 pub fn is_defining(self) -> bool {
525 UseKind::DefiningUse => true,
526 UseKind::OpaqueUse => false,
531 impl<'a, 'tcx> InferCtxt<'a, 'tcx> {
532 #[instrument(skip(self), level = "debug")]
533 pub fn register_hidden_type(
535 opaque_type_key: OpaqueTypeKey<'tcx>,
536 cause: ObligationCause<'tcx>,
537 param_env: ty::ParamEnv<'tcx>,
539 origin: hir::OpaqueTyOrigin,
540 ) -> InferResult<'tcx, ()> {
542 let OpaqueTypeKey { def_id, substs } = opaque_type_key;
544 // Ideally, we'd get the span where *this specific `ty` came
545 // from*, but right now we just use the span from the overall
546 // value being folded. In simple cases like `-> impl Foo`,
547 // these are the same span, but not in cases like `-> (impl
549 let span = cause.span;
551 let mut obligations = vec![];
552 let prev = self.inner.borrow_mut().opaque_types().register(
553 OpaqueTypeKey { def_id, substs },
554 OpaqueHiddenType { ty: hidden_ty, span },
557 if let Some(prev) = prev {
558 obligations = self.at(&cause, param_env).eq(prev, hidden_ty)?.obligations;
561 let item_bounds = tcx.bound_explicit_item_bounds(def_id.to_def_id());
563 for predicate in item_bounds.transpose_iter().map(|e| e.map_bound(|(p, _)| *p)) {
565 let predicate = predicate.subst(tcx, substs);
567 let predicate = predicate.fold_with(&mut BottomUpFolder {
569 ty_op: |ty| match *ty.kind() {
570 // We can't normalize associated types from `rustc_infer`,
571 // but we can eagerly register inference variables for them.
572 ty::Projection(projection_ty) if !projection_ty.has_escaping_bound_vars() => {
573 self.infer_projection(
581 // Replace all other mentions of the same opaque type with the hidden type,
582 // as the bounds must hold on the hidden type after all.
583 ty::Opaque(def_id2, substs2)
584 if def_id.to_def_id() == def_id2 && substs == substs2 =>
594 if let ty::PredicateKind::Projection(projection) = predicate.kind().skip_binder() {
595 if projection.term.references_error() {
596 // No point on adding these obligations since there's a type error involved.
597 return Ok(InferOk { value: (), obligations: vec![] });
599 trace!("{:#?}", projection.term);
601 // Require that the predicate holds for the concrete type.
603 obligations.push(traits::Obligation::new(cause.clone(), param_env, predicate));
605 Ok(InferOk { value: (), obligations })
609 /// Returns `true` if `opaque_hir_id` is a sibling or a child of a sibling of `def_id`.
612 /// ```ignore UNSOLVED (is this a bug?)
613 /// # #![feature(type_alias_impl_trait)]
616 /// pub trait Bar { /* ... */ }
617 /// pub type Baz = impl Bar;
619 /// # impl Bar for () {}
620 /// fn f1() -> Baz { /* ... */ }
622 /// fn f2() -> bar::Baz { /* ... */ }
626 /// Here, `def_id` is the `LocalDefId` of the defining use of the opaque type (e.g., `f1` or `f2`),
627 /// and `opaque_hir_id` is the `HirId` of the definition of the opaque type `Baz`.
628 /// For the above example, this function returns `true` for `f1` and `false` for `f2`.
629 fn may_define_opaque_type(tcx: TyCtxt<'_>, def_id: LocalDefId, opaque_hir_id: hir::HirId) -> bool {
630 let mut hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
632 // Named opaque types can be defined by any siblings or children of siblings.
633 let scope = tcx.hir().get_defining_scope(opaque_hir_id);
634 // We walk up the node tree until we hit the root or the scope of the opaque type.
635 while hir_id != scope && hir_id != hir::CRATE_HIR_ID {
636 hir_id = tcx.hir().local_def_id_to_hir_id(tcx.hir().get_parent_item(hir_id));
638 // Syntactically, we are allowed to define the concrete type if:
639 let res = hir_id == scope;
641 "may_define_opaque_type(def={:?}, opaque_node={:?}) = {}",
642 tcx.hir().find(hir_id),
643 tcx.hir().get(opaque_hir_id),