-
Notifications
You must be signed in to change notification settings - Fork 4.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Covariant Returns Feature #35308
Merged
Merged
Covariant Returns Feature #35308
Changes from 17 commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
bf7501f
Covariant Returns Feature: Allowing return types on MethodImpl to be …
fef49b2
Adding the missing .ctor methods to the various types
f10119d
Perform covariant return signature matching only after an exact match…
8d5d87e
Add test coverage for implicit override with less derived return type
a14af6f
Change ValidateMethodImplRemainsInEffect attribute to apply to methods
0e4e472
Moving covariant return type checking to the final stage of type load…
698eafb
Rename attribute and reference it from System.Runtime instead of S.P.C
6848c40
Add test coverage for interface cases.
5a85da8
Handling for struct cases, and adding test coverage for it.
89bb5c3
Small test fixes
cbecf78
Fix consistency issue with the way the RequireMethodImplToRemainInEff…
1154b90
Support covariant returns and slot unifications in crossgen2
f97b9de
some CR feedback
1329fea
Add unit test coverage for delegates
997074f
Fix handling of covariant and contravariant generic interfaces
janvorli ed9fb4c
Added test cases to interfaces unit test
janvorli 6eaaa1a
Fix Nullable handling and add more tests
janvorli 688c263
Reflect Fadi's feedback - limit the GCX_COOP scope
janvorli 3636d03
Reflect PR feedback
janvorli c05f075
Rename the attribute to PreserveBaseOverridesAttribute
janvorli 7ccd3ed
Disable covariant returns tests on Mono for now
janvorli File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
# Covariant Return Methods | ||
|
||
Covariant return methods is a runtime feature designed to support the [covariant return types](https://github.com/dotnet/csharplang/blob/master/proposals/covariant-returns.md) and [records](https://github.com/dotnet/csharplang/blob/master/proposals/records.md) C# language features posed for C# 9.0. | ||
|
||
This feature allows an overriding method to have a return type that is different than the one on the method it overrides, but compatible with it. The type compability rules are defined in ECMA I.8.7.1. Example: using a more derived return type. | ||
|
||
Covariant return methods can only be described through MethodImpl records, and as an initial implementation will only be applicable to methods on reference types. Methods on interfaces and value types will not be supported (may be supported later in the future). | ||
|
||
MethodImpl checking will allow a return type to vary as long as the override is compatible with the return type of the method overriden (ECMA I.8.7.1). | ||
|
||
If a language wishes for the override to be semantically visible such that users of the more derived type may rely on the covariant return type it shall make the override a newslot method with appropriate visibility AND name to be used outside of the class. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This statement sounds like newslot is not required if the method is not semantically visible (BTW, what exactly does it mean to be semantically visible). Is this correct? |
||
|
||
For virtual method slot MethodImpl overrides, each slot shall be checked for compatible signature on type load. (Implementation note: This behavior can be triggered only if the type has a covariant return type override in its hierarchy, so as to make this pay for play.) | ||
|
||
A new `RequireMethodImplToRemainInEffectAttribute` shall be added. The presence of this attribute is to require the type loader to ensure that the MethodImpl records specified on the method have not lost their slot unifying behavior due to other actions. This is used to allow the C# language to require that overrides have the consistent behaviors expected. The expectation is that C# would place this attribute on covariant override methods in classes. | ||
|
||
## Implementation Notes | ||
|
||
### Return Type Checking | ||
|
||
During enumeration of MethodImpls on a type (`MethodTableBuilder::EnumerateMethodImpls()`), if the signatures of the MethodImpl and the MethodDecl do not match: | ||
1. We repeat the signature comparison a second time, but skip the comparison of the return type signatures. If the signatures for the rest of the method arguments match, we will conditionally treat that MethodImpl as a valid one, but flag it for a closer examination of the return type compatibility at a later stage of type loading (end of `CLASS_LOAD_EXACTPARENTS` stage). | ||
2. At the end of the `CLASS_LOAD_EXACTPARENTS` type loading stage, examing each virtual method on the type, and if it has been flagged for further return type checking: | ||
+ Load the `TypeHandle` of the return type of the method on base type. | ||
+ Load the `TypeHandle` of the return type of the method on the current type being validated. | ||
+ Verify that the second `TypeHandle` is compatible with the first `TypeHandle` using the `MethodTable::CanCastTo()` API. If they are not compatible, a TypeLoadException is thrown. | ||
|
||
The only exception where `CanCastTo()` will return true for an incompatible type according to the ECMA rules is for structs implementing interfaces, so we explicitly check for that case and throw a TypeLoadException if we hit it. | ||
|
||
Once a method is flagged for return type checking, every time the vtable slot containing that method gets overridden on a derived type, the new override will also be checked for compatiblity. This is to ensure that no derived type can implicitly override some virtual method that has already been overridden by some MethodImpl with a covariant return type. | ||
|
||
### VTable Slot Unification | ||
|
||
If a MethodImpl has the `RequireMethodImplToRemainInEffectAttribute` attribute, it needs to propagate all applicable vtable slots on the type. This is to ensure that if we use the signature of one of the base type methods to call the overriding method, we still execute the overriding method. | ||
|
||
Consider this case: | ||
``` C# | ||
class A { | ||
RetType VirtualFunction() { } | ||
} | ||
class B : A { | ||
[RequireMethodImplToRemainInEffect] | ||
DerivedRetType VirtualFunction() { .override A.VirtualFuncion } | ||
} | ||
class C : B { | ||
[RequireMethodImplToRemainInEffect] | ||
MoreDerivedRetType VirtualFunction() { .override A.VirtualFunction } | ||
} | ||
``` | ||
|
||
Given an object of type `C`, the attribute will ensure that: | ||
``` C# | ||
callvirt RetType A::VirtualFunc() -> executes the MethodImpl on C | ||
callvirt DerivedRetType B::VirtualFunc() -> executes the MethodImpl on C | ||
callvirt MoreDerivedRetType C::VirtualFunc() -> executes the MethodImpl on C | ||
``` | ||
|
||
Without the attribute, the second callvirt would normally execute the MethodImpl on `B` (the MethodImpl on `C` does not override the vtable slot of `B`'s MethodImpl, but only overrides the declaring method's vtable slot. | ||
|
||
This slot unification step will also take place during the last step of type loading (end of `CLASS_LOAD_EXACTPARENTS` stage). | ||
|
||
### [Future] Interface Support | ||
|
||
An interface method may be both non-final and have a MethodImpl that declares that it overrides another interface method. If it does, NO other interface method may .override it. Instead further overrides must override the method that it overrode. Also the overriding method may only override 1 method. | ||
|
||
The default interface method resolution algorithm shall change from: | ||
|
||
``` console | ||
Given interface method M and type T. | ||
Let MSearch = M | ||
Let MFound = Most specific implementation within the interfaces for MSearch within type T. If multiple implementations are found, throw Ambiguous match exception. | ||
Return MFound | ||
``` | ||
|
||
To: | ||
|
||
``` console | ||
Given interface method M and type T. | ||
Let MSearch = M | ||
|
||
If (MSearch overrides another method MBase) | ||
Let MSearch = MBase | ||
|
||
Let MFound = Most specific implementation within the interfaces for MSearch within type T. If multiple implementations are found, throw Ambiguous match exception. | ||
Let M Code = NULL | ||
|
||
If ((MFound != Msearch) and (MFound is not final)) | ||
Let M ClassVirtual = ResolveInterfaceMethod for MFound to virtual override on class T without using Default interface method implementation or return NULL if not found. | ||
If (M ClassVirtual != NULL) | ||
Let M Code= ResolveVirtualMethod for MFound on class T to implementation method | ||
|
||
If (M Code != NULL) | ||
Let M Code = MFound | ||
|
||
Check M Code For signature <compatible-with> interface method M. | ||
|
||
Return M Code | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please add a chapter on this to https://github.com/dotnet/runtime/blob/master/docs/design/specs/Ecma-335-Augments.md ? Try to match the style and language used by ECMA-335 (e.g. in the ideal case - we would just copy&paste it over once we figure out how to make edits to ECMA-335).