address review

Author: jdonszelmann

compiler/rustc_infer/src/infer/relate/generalize.rs

@@ -355,13 +355,51 @@ impl<'tcx> TypeVisitor<TyCtxt<'tcx>> for MaxUniverse {
     }
 }
 
+/// This state determines how generalization treats aliases.
+///
+/// Based on which state we're in, we treat them either as rigid or normalizable,
+/// which might change depending on what types the generalization visitor encounters.
+/// See `handle_alias_ty` for the logic of how we change states.
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 enum GeneralizerState {
     /// Treat aliases as potentially normalizable.
+    ///
+    /// This is the default state that generalization starts in, unless we're
+    /// treating aliases as rigid. It also means we're not currently inside an
+    /// alias, since then we change the state to `IncompletelyRelateAliasArgs`.
     Default,
-    IncompletelyRelateHigherRankedAlias,
-    /// Only one layer
+    /// We enter this state when we're generalizing the arguments of a
+    /// potentially normalizeable alias.
+    ///
+    /// The behavior here is different between the old and the new solver:
+    ///
+    /// In the old solver, the difference between this and `Default` is needed to
+    /// correctly handle `<T as Bar<<?0 as Foo>::Assoc>::Assoc == ?0`. That
+    /// equality can hold by either normalizing the outer or the inner
+    /// associated type. In the old solver, we always structurally relate
+    /// aliases. If we we encounter an occurs check failure, we propagate the
+    /// failure to the outermost alias, for which we then emit a `Projection`
+    /// goal instead.
+    ///
+    /// In the new solver, we rarely get into this state.
+    /// When we encounter aliases we instead attempt to normalize them, and treat
+    /// them as rigid using `ShallowStructurallyRelate`. Only when an alias has
+    /// escaping bound variables do we continue with similar logic to the old
+    /// solver, except now we also explicitly relate the type and consts in the
+    /// arguments of aliases while in this mode.
+    ///
+    /// FIXME: Because we relate the type and consts in the arguments of aliases
+    ///        while in this mode, this is incomplete.
+    IncompletelyRelateAliasArgs,
+    /// During generalization, when we encounter aliases, we will first attempt
+    /// to normalize them when we're using the next trait solver. We can now
+    /// treat the normalized alias as rigid, but only for "one layer", hence
+    /// shallow. New aliases encountered inside the arguments of the outer alias
+    /// should once again be related as normal.
     ShallowStructurallyRelateAliases,
+    /// Treat aliases as rigid when relating them.
+    ///
+    /// This corresponds to `relation.structurally_relate_aliases()`.
     StructurallyRelateAliases,
 }
 
@@ -400,11 +438,10 @@ struct Generalizer<'me, 'tcx> {
     /// some other type. What will be the variance at this point?
     ambient_variance: ty::Variance,
 
-    /// This is set once we're generalizing the arguments of an alias.
+    /// This field keeps track of how we treat aliases during generalization.
     ///
-    /// This is necessary to correctly handle
-    /// `<T as Bar<<?0 as Foo>::Assoc>::Assoc == ?0`. This equality can
-    /// hold by either normalizing the outer or the inner associated type.
+    /// Refer to [`GeneralizerState`]'s docs for more information about the
+    /// all the possible values this can have, and when we use which.
     state: GeneralizerState,
 
     cache: SsoHashMap<(Ty<'tcx>, ty::Variance, GeneralizerState), Ty<'tcx>>,
@@ -483,11 +520,11 @@ impl<'tcx> Generalizer<'_, 'tcx> {
 
                 return res;
             }
-            GeneralizerState::Default | GeneralizerState::IncompletelyRelateHigherRankedAlias => {}
+            GeneralizerState::Default | GeneralizerState::IncompletelyRelateAliasArgs => {}
         }
 
         let previous_state =
-            mem::replace(&mut self.state, GeneralizerState::IncompletelyRelateHigherRankedAlias);
+            mem::replace(&mut self.state, GeneralizerState::IncompletelyRelateAliasArgs);
         let result = match self.relate(alias, alias) {
             Ok(alias) => Ok(alias.to_ty(self.cx())),
             Err(e) => match previous_state {
@@ -504,7 +541,7 @@ impl<'tcx> Generalizer<'_, 'tcx> {
                     debug!("generalization failure in alias");
                     Ok(self.next_ty_var_for_alias())
                 }
-                GeneralizerState::IncompletelyRelateHigherRankedAlias => return Err(e),
+                GeneralizerState::IncompletelyRelateAliasArgs => return Err(e),
 
                 // Early return.
                 GeneralizerState::ShallowStructurallyRelateAliases
@@ -613,6 +650,7 @@ impl<'tcx> TypeRelation<TyCtxt<'tcx>> for Generalizer<'_, 'tcx> {
                             // of each other. This is currently only used for diagnostics.
                             // To see why, see the docs in the `type_variables` module.
                             inner.type_variables().sub_unify(vid, new_var_id);
+
                             // If we're in the new solver and create a new inference
                             // variable inside of an alias we eagerly constrain that
                             // inference variable to prevent unexpected ambiguity errors.
@@ -632,13 +670,13 @@ impl<'tcx> TypeRelation<TyCtxt<'tcx>> for Generalizer<'_, 'tcx> {
                                 && !matches!(self.infcx.typing_mode(), TypingMode::Coherence)
                             {
                                 match self.state {
-                                    GeneralizerState::IncompletelyRelateHigherRankedAlias => {
+                                    GeneralizerState::IncompletelyRelateAliasArgs => {
                                         inner.type_variables().equate(vid, new_var_id);
                                     }
+                                    GeneralizerState::Default
+                                    | GeneralizerState::ShallowStructurallyRelateAliases
+                                    | GeneralizerState::StructurallyRelateAliases => {}
                                 }
-                                GeneralizerState::Default
-                                | GeneralizerState::ShallowStructurallyRelateAliases
-                                | GeneralizerState::StructurallyRelateAliases => {}
                             }
 
                             debug!("replacing original vid={:?} with new={:?}", vid, new_var_id);
@@ -765,13 +803,13 @@ impl<'tcx> TypeRelation<TyCtxt<'tcx>> for Generalizer<'_, 'tcx> {
                                 && !matches!(self.infcx.typing_mode(), TypingMode::Coherence)
                             {
                                 match self.state {
-                                    GeneralizerState::IncompletelyRelateHigherRankedAlias => {
+                                    GeneralizerState::IncompletelyRelateAliasArgs => {
                                         variable_table.union(vid, new_var_id);
                                     }
+                                    GeneralizerState::Default
+                                    | GeneralizerState::ShallowStructurallyRelateAliases
+                                    | GeneralizerState::StructurallyRelateAliases => {}
                                 }
-                                GeneralizerState::Default
-                                | GeneralizerState::ShallowStructurallyRelateAliases
-                                | GeneralizerState::StructurallyRelateAliases => {}
                             }
                             Ok(ty::Const::new_var(self.cx(), new_var_id))
                         }

compiler/rustc_middle/src/hooks/mod.rs

@@ -132,7 +132,12 @@ declare_hooks! {
     ) -> Ty<'tcx>;
 }
 
-// `repr(transparent)` so we can transmute a `&'a Infcx<'tcx>` to this struct.
+/// The `try_eagerly_normalize_alias` hook passes an `Infcx` from where it's called (in `rustc_infer`)
+/// to where it's provided (in `rustc_trait_selection`).
+/// Both of those crates have that type available, but `rustc_middle` does not.
+/// Instead we pass this type-erased `Infcx` and transmute on both sides.
+///
+/// Has to be `repr(transparent)` so we can transmute a `&'a Infcx<'tcx>` to this struct.
 #[repr(transparent)]
 pub struct TypeErasedInfcx<'a, 'tcx> {
     _infcx: *const (),

compiler/rustc_trait_selection/src/solve.rs

@@ -56,8 +56,7 @@ fn try_eagerly_normalize_alias<'a, 'tcx>(
     let cause = ObligationCause::dummy_with_span(span);
     let obligation = Obligation::new(
         tcx,
-        // we ignore the error anyway
-        ObligationCause::dummy_with_span(span),
+        cause,
         param_env,
         ty::PredicateKind::AliasRelate(
             alias.to_ty(tcx).into(),
@@ -68,7 +67,8 @@ fn try_eagerly_normalize_alias<'a, 'tcx>(
 
     ocx.register_obligation(obligation);
 
-    // This only tries to eagerly resolve, if it errors we don't care.
+    // We only use this to constrain inference variables.
+    // We don't care if it errors.
     let _ = ocx.try_evaluate_obligations();
 
     infcx.resolve_vars_if_possible(infer_term)

tests/ui/impl-trait/unsized_coercion.rs

@@ -3,8 +3,7 @@
 
 //@ revisions: next old
 //@[next] compile-flags: -Znext-solver
-//@[old] check-pass
-//@[next] check-pass
+//@ check-pass
 
 trait Trait {}