Normalize opaques before defining them in the new solver

Author: compiler-errors

compiler/rustc_trait_selection/src/solve/mod.rs

@@ -22,6 +22,7 @@ use rustc_middle::traits::solve::{
     CanonicalResponse, Certainty, ExternalConstraintsData, Goal, IsNormalizesToHack, QueryResult,
     Response,
 };
+use rustc_middle::traits::Reveal;
 use rustc_middle::ty::{self, Ty, TyCtxt, UniverseIndex};
 use rustc_middle::ty::{
     CoercePredicate, RegionOutlivesPredicate, SubtypePredicate, TypeOutlivesPredicate,
@@ -302,10 +303,21 @@ impl<'tcx> EvalCtxt<'_, 'tcx> {
         mut ty: Ty<'tcx>,
     ) -> Result<Option<Ty<'tcx>>, NoSolution> {
         for _ in 0..self.local_overflow_limit() {
-            let ty::Alias(_, projection_ty) = *ty.kind() else {
+            let ty::Alias(kind, projection_ty) = *ty.kind() else {
                 return Ok(Some(ty));
             };
 
+            // Don't try normalizing an opaque that is not in the defining scope
+            if kind == ty::Opaque
+                && param_env.reveal() == Reveal::UserFacing
+                && !projection_ty
+                    .def_id
+                    .as_local()
+                    .is_some_and(|def_id| self.can_define_opaque_ty(def_id))
+            {
+                return Ok(Some(ty));
+            }
+
             let normalized_ty = self.next_ty_infer();
             let normalizes_to_goal = Goal::new(
                 self.tcx(),

compiler/rustc_trait_selection/src/solve/project_goals/opaques.rs

@@ -23,12 +23,14 @@ impl<'tcx> EvalCtxt<'_, 'tcx> {
                 let Some(opaque_ty_def_id) = opaque_ty.def_id.as_local() else {
                     return Err(NoSolution);
                 };
+
                 // FIXME: at some point we should call queries without defining
                 // new opaque types but having the existing opaque type definitions.
                 // This will require moving this below "Prefer opaques registered already".
                 if !self.can_define_opaque_ty(opaque_ty_def_id) {
                     return Err(NoSolution);
                 }
+
                 // FIXME: This may have issues when the args contain aliases...
                 match self.tcx().uses_unique_placeholders_ignoring_regions(opaque_ty.args) {
                     Err(NotUniqueParam::NotParam(param)) if param.is_non_region_infer() => {
@@ -41,6 +43,7 @@ impl<'tcx> EvalCtxt<'_, 'tcx> {
                     }
                     Ok(()) => {}
                 }
+
                 // Prefer opaques registered already.
                 let opaque_type_key =
                     ty::OpaqueTypeKey { def_id: opaque_ty_def_id, args: opaque_ty.args };
@@ -53,6 +56,22 @@ impl<'tcx> EvalCtxt<'_, 'tcx> {
                         return self.flounder(&matches);
                     }
                 }
+
+                // Try normalizing the opaque's hidden type. If it's a ty var,
+                // then refuse to define the opaque type yet. This allows us to
+                // avoid inferring opaque cycles so eagerly.
+                let expected = match self.try_normalize_ty(goal.param_env, expected) {
+                    Ok(Some(ty)) if !ty.is_ty_var() => ty,
+                    Ok(_) => {
+                        return self.evaluate_added_goals_and_make_canonical_response(
+                            Certainty::AMBIGUOUS,
+                        );
+                    }
+                    Err(_) => {
+                        return Err(NoSolution);
+                    }
+                };
+
                 // Otherwise, define a new opaque type
                 self.insert_hidden_type(opaque_type_key, goal.param_env, expected)?;
                 self.add_item_bounds_for_hidden_type(

tests/ui/impl-trait/issues/issue-83919.stderr renamed to tests/ui/impl-trait/issues/issue-83919.current.stderr

@@ -1,5 +1,5 @@
 error[E0277]: `{integer}` is not a future
-  --> $DIR/issue-83919.rs:21:26
+  --> $DIR/issue-83919.rs:23:26
    |
 LL |     fn get_fut(&self) -> Self::Fut {
    |                          ^^^^^^^^^ `{integer}` is not a future

tests/ui/impl-trait/issues/issue-83919.next.stderr

@@ -0,0 +1,23 @@
+error[E0308]: mismatched types
+  --> $DIR/issue-83919.rs:25:9
+   |
+LL |       fn get_fut(&self) -> Self::Fut {
+   |                            --------- expected `<Implementor as Foo>::Fut` because of return type
+LL |
+LL | /         async move {
+LL | |
+LL | |             42
+LL | |             // 42 does not impl Future and rustc does actually point out the error,
+LL | |             // but rustc used to panic.
+LL | |             // Putting a valid Future here always worked fine.
+LL | |         }
+   | |_________^ types differ
+   |
+   = note: expected associated type `<Implementor as Foo>::Fut`
+                found `async` block `{async block@$DIR/issue-83919.rs:25:9: 31:10}`
+   = help: consider constraining the associated type `<Implementor as Foo>::Fut` to `{async block@$DIR/issue-83919.rs:25:9: 31:10}` or calling a method that returns `<Implementor as Foo>::Fut`
+   = note: for more information, visit https://doc.rust-lang.org/book/ch19-03-advanced-traits.html
+
+error: aborting due to previous error
+
+For more information about this error, try `rustc --explain E0308`.

tests/ui/impl-trait/issues/issue-83919.rs

@@ -1,7 +1,9 @@
-#![feature(impl_trait_in_assoc_type)]
-
+// revisions: current next
+//[next] compile-flags: -Ztrait-solver=next
 // edition:2021
 
+#![feature(impl_trait_in_assoc_type)]
+
 use std::future::Future;
 
 trait Foo {
@@ -19,8 +21,9 @@ impl Foo for Implementor {
     type Fut = impl Future<Output = Self::Fut2>;
 
     fn get_fut(&self) -> Self::Fut {
-        //~^ ERROR `{integer}` is not a future
+        //[current]~^ ERROR `{integer}` is not a future
         async move {
+            //[next]~^ ERROR mismatched types
             42
             // 42 does not impl Future and rustc does actually point out the error,
             // but rustc used to panic.

tests/ui/impl-trait/recursive-generator.stderr renamed to tests/ui/impl-trait/recursive-generator.current.stderr

@@ -1,5 +1,5 @@
 error[E0720]: cannot resolve opaque type
-  --> $DIR/recursive-generator.rs:5:13
+  --> $DIR/recursive-generator.rs:8:13
    |
 LL | fn foo() -> impl Generator<Yield = (), Return = ()> {
    |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ recursive opaque type

tests/ui/impl-trait/recursive-generator.next.stderr

@@ -0,0 +1,12 @@
+error[E0720]: cannot resolve opaque type
+  --> $DIR/recursive-generator.rs:8:13
+   |
+LL | fn foo() -> impl Generator<Yield = (), Return = ()> {
+   |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ recursive opaque type
+...
+LL |         let mut gen = Box::pin(foo());
+   |             ------- generator captures itself here
+
+error: aborting due to previous error
+
+For more information about this error, try `rustc --explain E0720`.

tests/ui/impl-trait/recursive-generator.rs

@@ -1,3 +1,6 @@
+// revisions: current next
+//[next] compile-flags: -Ztrait-solver=next
+
 #![feature(generators, generator_trait)]
 
 use std::ops::{Generator, GeneratorState};

tests/ui/impl-trait/two_tait_defining_each_other.stderr renamed to tests/ui/impl-trait/two_tait_defining_each_other.current.stderr

@@ -1,16 +1,16 @@
 error: opaque type's hidden type cannot be another opaque type from the same scope
-  --> $DIR/two_tait_defining_each_other.rs:12:5
+  --> $DIR/two_tait_defining_each_other.rs:16:5
    |
 LL |     x // A's hidden type is `Bar`, because all the hidden types of `B` are compared with each other
    |     ^ one of the two opaque types used here has to be outside its defining scope
    |
 note: opaque type whose hidden type is being assigned
-  --> $DIR/two_tait_defining_each_other.rs:4:10
+  --> $DIR/two_tait_defining_each_other.rs:8:10
    |
 LL | type B = impl Foo;
    |          ^^^^^^^^
 note: opaque type being used as hidden type
-  --> $DIR/two_tait_defining_each_other.rs:3:10
+  --> $DIR/two_tait_defining_each_other.rs:7:10
    |
 LL | type A = impl Foo;
    |          ^^^^^^^^

tests/ui/impl-trait/two_tait_defining_each_other.rs

@@ -1,3 +1,7 @@
+// revisions: current next
+//[next] compile-flags: -Ztrait-solver=next
+//[next] check-pass
+
 #![feature(type_alias_impl_trait)]
 
 type A = impl Foo;
@@ -10,7 +14,7 @@ fn muh(x: A) -> B {
         return Bar; // B's hidden type is Bar
     }
     x // A's hidden type is `Bar`, because all the hidden types of `B` are compared with each other
-    //~^ ERROR opaque type's hidden type cannot be another opaque type
+    //[current]~^ ERROR opaque type's hidden type cannot be another opaque type
 }
 
 struct Bar;