Make trait refs & assoc ty paths properly induce trait object lifetime defaults#129543
Make trait refs & assoc ty paths properly induce trait object lifetime defaults#129543fmease wants to merge 8 commits intorust-lang:mainfrom
Conversation
|
@bors try |
[crater] Properly deduce the object lifetime default in GAT paths Fixes rust-lang#115379. r? ghost
|
☀️ Try build successful - checks-actions |
|
@craterbot check |
|
👌 Experiment ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more |
[CRATER] Crater Rollup This is a " crater rollup" of: * rust-lang#126452 * rust-lang#128784 * rust-lang#129392 * rust-lang#129422 * rust-lang#129543 **What is a crater rollup?** It's simply a crater job that is run on all of the containing PRs *together*, and then we can set the crates list for each of these jobs to just the failures after it's done. It should cut out on the bulk of "normal" crates that do nothing and simply just take time to build. r? `@ghost`
[CRATER] Crater Rollup This is a " crater rollup" of: * rust-lang#126452 * rust-lang#128784 * rust-lang#129392 * rust-lang#129422 * rust-lang#129543 * rust-lang#129604 **What is a crater rollup?** It's simply a crater job that is run on all of the containing PRs *together*, and then we can set the crates list for each of these jobs to just the failures after it's done. It should cut out on the bulk of "normal" crates that do nothing and simply just take time to build. r? `@ghost`
[CRATER] Crater Rollup This is a " crater rollup" of: * rust-lang#126452 * rust-lang#128784 * rust-lang#129392 * rust-lang#129422 * rust-lang#129543 * rust-lang#129604 **What is a crater rollup?** It's simply a crater job that is run on all of the containing PRs *together*, and then we can set the crates list for each of these jobs to just the failures after it's done. It should cut out on the bulk of "normal" crates that do nothing and simply just take time to build. r? `@ghost`
|
📝 Configuration of the ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more |
|
@craterbot crates=https://gist.githubusercontent.com/compiler-errors/4a09d64cd15dc3dca50edeea26cc9938/raw/b4181c225709e120a11d91cce69d0d4da3e652d0/regressed.txt p=1 (Bump it up the queue as this will go quickly.) |
|
📝 Configuration of the ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more |
|
🚧 Experiment ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more |
|
🎉 Experiment
|
|
Alright, this is now finally ready for a rereview wrt. both implementation and pFCP'ed semantic changes! Changes since last comment of mine:
@lcnr, @BoxyUwU, I'd be super happy if you both could take a look esp. in regards to the (latest version of the) pFCP'ed semantic changes since I'd love it if this can finally go into FCP :D Thanks a lot in advance :) |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
This test didn't actually test what it meant to test. I've therefore replaced it with a new one (tests/ui/object-lifetime/object-lifetime-default-inferred-args.rs). It was added in the initial generic_arg_infer PR.
It's meant to test that the presence of _ in a generic arg list doesn't throw off the trait object lifetime default calculations which is a very valuable thing to test (hence me adding a replacement). Sadly, it doesn't test that.
First of all, the only places in this file that contain implicit trait object lifetime bounds that are in the mere vicinity of an inferred arg _ are the two &dyn Tests at the bottom. However, these just get elab'ed to &'?0 (dyn Test + '?1) and &'2 (dyn Test + '?3) since the implicit inferred lifetimes passed to & aren't named, so the default is indeterminate meaning fresh region vars for both since we're in a body.
The two _ passed as part of the fn calls have no influence whatsoever on the defaults chosen for the dyn Test "in random as-casts"; that's not how trait object lifetime defaulting works.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
| // | ||
| // FIXME(mgca, #151649): Assoc (and free?) consts should also qualify. | ||
| // FIXME(return_type_notation, #151662): Assoc fns should also qualify. | ||
| let depth = path.segments.len() - index - 1; |
There was a problem hiding this comment.
can you add a comment explaining what "depth" is, afaict what we care about for AssocTy is if we have T::Assoc, are we in T and for variant we have T::Variant we check whether we're in Variant? That feels odd to me.
I guess assoc types want the info from their trait and everything else wants it from itself, but that doesn't explain variant, with enums you can have generic args both on the enum and on the variant, i.e. both Enum::<args>::Variant and Enum::Variant::<args> are valid
There was a problem hiding this comment.
can you add a comment explaining what "depth" is
Will do.
I guess assoc types want the info from their trait and everything else wants it from itself
I'd like to clarify: On main, we already "accept" AssocTy but only at depth 1 (thereby setting the container to the corresp. trait). On my branch we now also "accept" AssocTy at depth 0 (thereby setting the container to itself).
AssocTy@depth=1 is necessary for resolving obj lt defs in the trait ref. <A as TraitRef<B>>::AssocTy<C> essentially gets represented as QPath(Some(`A`), [`TraitRef<B>`, `AssocTy<C>`]) in the HIR. Given such a qpath, we're reaching both AssocTy@1 and AssocTy@0 (it doesn't reach Trait@0 since the overall resolution of the path is AssocTy).
but that doesn't explain variant, with enums you can have generic args both on the enum and on the variant
That is indeed odd and should be rectified soon (not in this PR tho imo). However, IINM this issue cannot be observed at the moment thanks to a different bug (#108224). AFAICT, in this context DefKind::Variant can only be reached by "braced enum constructions" …V { … } as unit & tuple constructions will have DefKind::Ctor(Variant, Const | Fn). Now, due to aforesaid bug (concerning lifetime elision, I think) (#108224), E::<'a, …>::V { … } gets rejected (it gets expanded to E::<'a, …>::V::<'_, …> { … } which later gets rejected by HIR ty lowering for obvious reasons), so we can "assume" E::V::<'a, …> {} here (i.e., only Variant@0 bears args, never Variant@1) (until that bug is fixed).
(Note that even if we stopped computing obj lt defs in bodies (as suggested by you and with which I agree), this issue is still relevant for (m)GCA under which Variant | Ctor(Variant, Const | Fn) (ref'ing lifetime args & trait object types) can legally appear in item signatures / contexts without inference (edit: conditions apply)).
There was a problem hiding this comment.
Added comments describing depth reversed segment indices. Added a FIXME for the preexisting variant bug.
Edit: I've opened PR that fixes both issues: #154918. Can be merged before or after this PR, it doesn't matter.
| ) if depth == 0 => Some((def_id, path.segments)), | ||
| // Note: We don't need to care about definition kinds that may have generics if they | ||
| // can only ever appear in positions where we can perform type inference (i.e., bodies). | ||
| _ => None, |
There was a problem hiding this comment.
how annoying is it to make this exhaustive?
There was a problem hiding this comment.
Done. See new final commit, new function eligible_container.
| generics: &ty::Generics, | ||
| tcx: TyCtxt<'_>, | ||
| def_id: DefId, | ||
| ) -> (usize, usize) { |
There was a problem hiding this comment.
comment please 🤔 depth is "index of segment in reverse order" and "index" is "index of args of segment"?
There was a problem hiding this comment.
Yea I'll prolly rename it to rev_index, rev_seg_index or similar (and index to arg_index or similar). I might even newtype it cuz a very early version of this PR actually had them mixed up at some point ^^).
Edit: That's exactly what I ended up doing (see the final commit).
| //@ check-pass | ||
|
|
||
| trait Trait<T: ?Sized> { type Assoc<'a> where T: 'a; } | ||
| impl<T: ?Sized> Trait<T> for () { type Assoc<'a> = &'a T where T: 'a; } |
There was a problem hiding this comment.
It's needed for the test case at the bottom:
// We deduce `dyn Bound + 'static` (and not `dyn Bound + 'r`).
fn f2<'r>(x: <() as Trait<dyn Bound>>::Assoc<'r>) { /*check*/ g2(x) }
fn g2<'r>(_: <() as Trait<dyn Bound + 'static>>::Assoc<'r>) {}However, I could rewrite this test the following way if you wanted me to:
@@ -6,7 +6,6 @@
//@ check-pass
trait Trait<T: ?Sized> { type Assoc<'a> where T: 'a; }
-impl<T: ?Sized> Trait<T> for () { type Assoc<'a> = &'a T where T: 'a; }
trait Bound {}
@@ -21,7 +20,9 @@
fn g1(_: impl Trait<dyn Bound + 'static>) {}
// We deduce `dyn Bound + 'static` (and not `dyn Bound + 'r`).
-fn f2<'r>(x: <() as Trait<dyn Bound>>::Assoc<'r>) { /*check*/ g2(x) }
-fn g2<'r>(_: <() as Trait<dyn Bound + 'static>>::Assoc<'r>) {}
+fn f2<'r, T>(_: <T as Trait<dyn Bound>>::Assoc<'r>)
+where
+ /*check*/ T: Trait<dyn Bound + 'static>
+{}
fn main() {}Alternatively, I could rewrite all test cases in this file using the "AbideBy pattern" (on the one hand I love it because it makes all test case super concise, on the other hand I hate it because it renders the tests even more artificial IMO (now most of my tests use it ^^'))
| // We deduce `dyn Inner + 'r` from bound `'a` on ty param `T` of trait `Outer`. | ||
| fn assoc_ty_proj<'r>(_: <() as Outer<'r, dyn Inner>>::Ty) {} | ||
|
|
||
| impl<'a, T: 'a + AbideBy<'a> + ?Sized> Outer<'a, T> for () { type Ty = &'a T; } |
There was a problem hiding this comment.
move this to trait definition?
|
|
||
| impl<'a, T: 'a + AbideBy<'a> + ?Sized> Outer<'a, T> for () { type Ty = &'a T; } | ||
|
|
||
| trait Inner {} |
| self.tcx.parent(def_id), | ||
| &path.segments[..path.segments.len() - 1], | ||
| )), | ||
| _ => None, |
There was a problem hiding this comment.
what are the cases where this change goes from indeterminate to pass-through due to this change?
something something exhaustive match possible?
There was a problem hiding this comment.
what are the cases where this change goes from indeterminate to pass-through due to this change?
I'm not sure I fully understand the question, pass-through whereto? I don't think there are any such cases.
- If the "indeterminacy scope" is inside of the self type (pseudo:
<INDET<dyn Inner> as Outer<'r>>::INELIGIBLE1), then the inner indeterminacy prevails / shadows any potential outer obj lt defs- meaning: indeterminate → indeterminate
- If the "indeterminacy scope" is outside of the resolved (ineligible) projection (pseudo:
INDET<<dyn Inner as Outer<'r>>::INELIGIBLE>1) then we'll "pass through to" the "indeterminacy" … but that's already what happens on stable&main where resolved projections are always pass through wrt. object lifetime defaulting- meaning: indeterminate → indeterminate
Of course, "pass-through to indeterminate" is possible and so is "indeterminate to check-pass" (if the container is eligible) but that's probably not what you meant.
Footnotes
There was a problem hiding this comment.
something something exhaustive match possible?
The final commit introduces function eligible_container that's called here in visit_qpath and there in visit_path_segment_args. Said function exhaustively matches on the Def as per #129543 (comment).
|
|
||
| fn is_static<T>(_: T) where T: 'static {} | ||
|
|
||
| // FIXME: Ideally, we'd elaborate `dyn Bar` to `dyn Bar + 'static` instead of rejecting it. |
There was a problem hiding this comment.
do we? 😅 I am not even sure whether this is desirable or not.
There was a problem hiding this comment.
Could you clarify? Which semantics would you desire?
AFAICT, there are 5 options for how we could make associated type bindings behave: The associated type binding could...
- ...artificially induce "indeterminacy" unconditionally
- i.e., reject implicit object lifetimes in item signatures
- ...artificially induce
'staticunconditionally - ...induce a lifetime default that's determined by the item bounds
- here that would be
'staticsince OLD(Foo::Item) would beEmptywhich turns into'staticin item signatures - unlikely to be implemented anytime soon since RBV & HIR ty lowering would need to be consolidated or be able to interlock smh.
- not sure if it's "desirable" but it's consistent / not surprising:
- type arguments induce a default determined by the parameter bounds
- assoc type bindings would induce a default determined by the item bounds
- here that would be
- ...not induce any object lifetime default
- aka it's pass-through
- here that would mean elab'ing
dyn Bartodyn Bar + 'asince it'd take on the default induced by the outer& - that'd be surprising I think à la "why are type arguments 'solid' (not pass through) but assoc type bindings are not despite being in the same
<…>list?" - (although I have to admit that we do already have containers on stable that "look" eligible but actually aren't (apart from the things that are fixed in this PR, of course), most notably tuple type constructors which are pass-through contrary to ADTs (
Solo<·>!=(·,)wrt. obj lt defaulting); still, using that as a counterargument would probably be a stretch)
- ...artificially induce *indeterminacy" if any generic arg list contains lifetime args, otherwise artificially induce
'static- that's the behavior on main, stable & this branch
- it's a HACK for reservation purposes (namely transitioning to option (3))
|
In the list of examples, can you match them to each of the changes from this PR. i.e have
// this now chooses `'a` and compiles
// this previously chose `'b` and now chooses `'c`, causing an error... after this I am gonna start the FCP this is a really impressive PR :> sorry for taking so long to get to it. |
This comment was marked as outdated.
This comment was marked as outdated.
If there are no lifetime bound on the trait, and if you annotate a lifetime that corresponds to the default (e.g. a reference lifetime) and completely elide the trait Trait {}
impl Trait for () {}
fn example<'a>(arg: &'a ()) {
let dt: &'a dyn Trait = arg;
// fails
let _: &(dyn Trait + 'static) = dt;
}But if you use If there is a single lifetime bound on the trait, the default bound is used in function bodies, and even overrides trait Single<'a>: 'a {}
impl Single<'_> for () {}
fn non_inferred_examples<'a>() {
let bx: Box<dyn Single<'a>> = Box::new(());
// Fails
let _: Box<dyn Single<'a> + 'static> = bx;
let bx: Box<dyn Single<'a> + '_> = Box::new(());
// Fails
let _: Box<dyn Single<'a> + 'static> = bx;
}If there are multiple lifetime bounds on the trait, elision and trait Double<'a, 'b>: 'a + 'b {}
impl Double<'_, '_> for () {}
fn ambiguous<'a, 'b>() {
// Both fail
let _: Box<dyn Double<'a, 'b>> = Box::new(());
let _: Box<dyn Double<'a, 'b> + '_> = Box::new(());
}Personally, I agree that just inferring would be an improvement for all these cases. See also #91302. |
|
Oh yeah, all these examples seem very undesirable to me 🤣 unsure if that should happen in this PR |
| // | ||
| // FIXME(mgca, #151649): Assoc (and free?) consts should also qualify. | ||
| // FIXME(return_type_notation, #151662): Assoc fns should also qualify. | ||
| let depth = path.segments.len() - index - 1; |
There was a problem hiding this comment.
can you add a comment explaining what "depth" is
Will do.
I guess assoc types want the info from their trait and everything else wants it from itself
I'd like to clarify: On main, we already "accept" AssocTy but only at depth 1 (thereby setting the container to the corresp. trait). On my branch we now also "accept" AssocTy at depth 0 (thereby setting the container to itself).
AssocTy@depth=1 is necessary for resolving obj lt defs in the trait ref. <A as TraitRef<B>>::AssocTy<C> essentially gets represented as QPath(Some(`A`), [`TraitRef<B>`, `AssocTy<C>`]) in the HIR. Given such a qpath, we're reaching both AssocTy@1 and AssocTy@0 (it doesn't reach Trait@0 since the overall resolution of the path is AssocTy).
but that doesn't explain variant, with enums you can have generic args both on the enum and on the variant
That is indeed odd and should be rectified soon (not in this PR tho imo). However, IINM this issue cannot be observed at the moment thanks to a different bug (#108224). AFAICT, in this context DefKind::Variant can only be reached by "braced enum constructions" …V { … } as unit & tuple constructions will have DefKind::Ctor(Variant, Const | Fn). Now, due to aforesaid bug (concerning lifetime elision, I think) (#108224), E::<'a, …>::V { … } gets rejected (it gets expanded to E::<'a, …>::V::<'_, …> { … } which later gets rejected by HIR ty lowering for obvious reasons), so we can "assume" E::V::<'a, …> {} here (i.e., only Variant@0 bears args, never Variant@1) (until that bug is fixed).
(Note that even if we stopped computing obj lt defs in bodies (as suggested by you and with which I agree), this issue is still relevant for (m)GCA under which Variant | Ctor(Variant, Const | Fn) (ref'ing lifetime args & trait object types) can legally appear in item signatures / contexts without inference (edit: conditions apply)).
| generics: &ty::Generics, | ||
| tcx: TyCtxt<'_>, | ||
| def_id: DefId, | ||
| ) -> (usize, usize) { |
There was a problem hiding this comment.
Yea I'll prolly rename it to rev_index, rev_seg_index or similar (and index to arg_index or similar). I might even newtype it cuz a very early version of this PR actually had them mixed up at some point ^^).
Edit: That's exactly what I ended up doing (see the final commit).
They are indeed used in bodies as well (which also surprised me quite a bit when I first noticed). As alluded to by QuineDot, changing that would make us accept more code. I agree with just performing inference in bodies. However, I'd strongly prefer it if we didn't implement this in this PR ^^' whose scope I no longer wish to increase. I hope that's understandable. |
|
Some changes occurred in need_type_info.rs cc @lcnr |
|
This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed. Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers. |
…ir own args (excl. self ty) This automatically fixes trait object lifetime defaulting for trait refs and trait alias refs, too. These used to be broken because the index calculation for going from middle generic args back to HIR ones didn't take into account the implicit self ty param present on traits. Moreover, in item signatures reject hidden trait object lifetime bounds inside type-relative paths (excl. the self ty) on grounds of the default being indeterminate.
* print `Empty` as it's called in code, otherwise it's unnecessarily confusing * go through the middle::ty Generics instead of the HIR ones, so we can dump the default for the implicit `Self` type parameter of traits, too
…ntiated assoc ty bindings Namely, on the RHS and in the args of the bindings.
Done. I've addressed all of your review comments. To 3 of these comments I have replied with a counterquestion, namely: (1) #129543 (comment), (2) #129543 (comment), (3) #129543 (comment). The final commit (Introduce fn @rustbot review |
View all comments
Trait Object Lifetime Defaults
Primer & Definitions
You could read this section in the Reference but it has several issues (see rust-lang/reference#1407). Here's a small explainer by me that only mentions the parts relevant to this PR:
Basically, given
dyn Trait(≠dyn Trait + '_) we want to deduce its trait object lifetime bound from context without relying on normal region inference as we might not be in a body1. The "context" means the closest – what I call — (eligible) containerC<X0, …, Xn>that wraps this trait object type. A container is to be understood as a use site of a "parametrized definition" (more general than type constructors). Currently eligible are ADTs, type aliases, traits and enum variants.So if we have
C<dyn Trait>(e.g.,&'r dyn TraitorStruct<'r, dyn Trait>),D<C<dyn Trait>>orC<N<dyn Trait>>(e.g.,Struct<'r, (dyn Trait,)>), we use the explicit2 outlives-bounds on the corresponding type parameter ofCto determine the trait object lifetime bound. Here,C&Ddenote (eligible) containers andNdenotes a generic type that is not an eligible container. E.g., givenstruct Struct<'a, T: 'a + ?Sized>(…);, we elaborateStruct<'r, dyn Trait>toStruct<'r, dyn Trait + 'r>.Finally, we call lifetime bounds used as the default for constituent trait object types of an eligible container
Cthe trait object lifetime defaults (induced byC) which may be shadowed by inner containers.Changes Made
These changes are theoretically breaking.
<Y0 as TraitRef<X0, …, Xn>>::AssocTy<Y1, …, Ym>now induces trait object lifetime defaults for constituentsY0toYm(TraitRefis considered a separate container, see also list item (3)).Y0of (resolved) projections we now look at the bounds on theSelftype param of the relevant trait (e.g., giventrait Outer<'a>: 'a { type Proj; }ortrait Outer<'a> where Self: 'a { type Proj; }we elaborate<dyn Inner as Outer<'r>>::Projto<dyn Inner + 'r as Outer<'r>>::Proj).Y0::Name<Y1, …, Ym>consider the trait object lifetime default indeterminateTraitRef<X0, …, Xn>(this fell out from the previous changes). They used to be completely broken due to a nasty off-by-one error for not accounting for the implicitSelftype param of traits which lead to cases likeOuter<'r, dyn Inner>(withtrait Outer<'a, T: 'a + ?Sized> {}) getting rejected as indeterminate (it tries to access a lifetime at index 1 instead 0) (playground)Outer<'r, 's, dyn Inner>(withtrait Outer<'a, 'b, T: 'a + ?Sized> {}) elaboratingdyn Innertodyn Inner + 'sinstead ofdyn Inner + 'r(!) (playground)trait_alias)TraitRef<AssocTy<X0, …, Xn> = Y>consider the trait object lifetime default indeterminate (inX0, …,XnandY) ifX0, …,Xncontains any lifetime arguments.AssocTyin the future when computing the default forY(2) take into account the parameter bounds ofAssocTyin the future when computing the defaults forX0, …,Xn.TraitRef<X0, …, Xn, AssocTy<Y0, …, Ym> = Z>– treats the default indeterminate inY0, …,YmandZifX0, …,Xncontains any lifetime arguments.Motivation
Both trait object lifetime default RFCs (599 and 1156) never explicitly specify what constitutes a — what I call — (eligible) container but it only makes sense to include anything that can be parametrized by generics and can be mentioned in places where we don't perform full region inference … like associated types. So it's only consistent to make this change.
Breakages
These changes are theoretically breaking because they can lead to different trait object lifetime bounds getting deduced compared to main which is obviously user observable. Moreover, we're now explicitly rejecting implicit trait object lifetime bounds inside type-relative paths (excl. the self type) and on the RHS of assoc type bindings if the assoc type has lifetime params.
However, the latest crater run found 0 non-spurious regressions (see here and here).
Fixes #115379.
Fixes #140710.
Fixes #141997.
Footnotes
If we are in a body we do use to normal region inference as a fallback. ↩
Indeed, we don't consider implied bounds (inferred outlives-bounds). ↩