Skip to content

Support using a simple overload resolution for finding Await helpers from the BCL #79135

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

Merged
merged 3 commits into from
Jul 8, 2025

Conversation

333fred
Copy link
Member

@333fred 333fred commented Jun 25, 2025

This PR removes special knowledge of what Await helpers correspond to what types, and instead implements a very simple form of overload resolution. We immediately bail on any conflict or error and fall back to attempting to use AwaitAwaiter or UnsafeAwaitAwaiter when such scenarios are detected. I've also updated the rules to better reflect what is actually implementable.

Relates to test plan #75960

…from the BCL

This PR removes special knowledge of what `Await` helpers correspond to what types, and instead implements a very simple form of overload resolution. We immediately bail on any conflict or error and fall back to attempting to use `AwaitAwaiter` or `UnsafeAwaitAwaiter` when such scenarios are detected. I've also updated the rules to better reflect what is actually implementable.
@333fred
Copy link
Member Author

333fred commented Jun 26, 2025

@RikkiGibson @jcouv for review

1 similar comment
@333fred
Copy link
Member Author

333fred commented Jun 30, 2025

@RikkiGibson @jcouv for review

@RikkiGibson RikkiGibson self-assigned this Jul 1, 2025
Copy link
Member

@jcouv jcouv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done with review pass (commit 1)

Copy link
Member

@RikkiGibson RikkiGibson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM modulo Julien's comments

@333fred
Copy link
Member Author

333fred commented Jul 3, 2025

@jcouv @RikkiGibson addressed feedback.

BoundExpression argument = placeholder;
if (!argumentConversion.IsIdentity)
{
argument = new BoundConversion(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we use CreateConversion here? It has additional logic that just constructing a BoundConversion even for simple identity conversions.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I forgot we had a helper in the binder for that. Thanks for pointing it out.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a test that observes the difference

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think there is one.

Copy link
Member

@jcouv jcouv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done with review pass (iteration 2)

Copy link
Member

@jcouv jcouv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM Thanks (commit 3)

@333fred
Copy link
Member Author

333fred commented Jul 8, 2025

@RikkiGibson, can you take another look since there were larger changes?

@333fred 333fred merged commit 7de7718 into dotnet:features/runtime-async Jul 8, 2025
24 checks passed
@333fred 333fred deleted the resolve-getawaiter branch July 8, 2025 21:57
333fred added a commit that referenced this pull request Aug 19, 2025
* Handle basic await scenarios (#76121)

Add initial handling of expressions that return `Task`, `Task<T>`, `ValueTask`, `ValueTask<T>`.

* Add RuntimeAsyncMethodGenerationAttribute (#77543)

Adds control for whether to use runtime async. The flowchart is as follows:

1. The flag `System.Runtime.CompilerServices.RuntimeFeature.Async` must be present.
2. Assuming that flag is present, we look for the presence of `System.Runtime.CompilerServices.RuntimeAsyncMethodGenerationAttribute` on the method. If that attribute is present, we use the preference expressed in the attribute. The preference does not carry to nested contexts, such as local functions or lambdas.
3. If the attribute is not present, we look for `features:runtime-async=on` on the command line. If that is present, then the feature is on by default. Otherwise, the feature is off.

* Semantic search info

* Implement custom awaitable support (#78071)

This adds support for awaiting task-like types that are not natively supported by runtime async. Closes #77897.

* Move runtime async method validation into initial binding (#78310)

We now do method construction and validation for runtime async helpers up front in initial binding, rather than doing it in `RuntimeAsyncRewriter`. I've also renamed the APIs as per dotnet/runtime#114310 (comment) (though I haven't added ConfigureAwait support yet, that will be the next PR). We now validate:

* The helpers come from `System.Runtime.CompilerServices.AsyncHelpers`, defined in corelib. This means that I now need a fairly extensive corelib mock to be able to compile. When we have a testing runtime that defines these helpers, we can remove the giant mock and use the real one.
* We properly error when expected helpers aren't present.
* We properly check to make sure that constraints are satisfied when doing generic substitution in one of the runtime helpers.
* Runtime async is not turned on if the async method does not return `Task`, `Task<T>`, `ValueTask`, or `ValueTask<T>`.

Relates to test plan #75960

* React to main changes #78246 and #78231.

* Switch MethodImplAttributes.Async to 0x2000 (#78536)

It was changed in dotnet/runtime#114310 as 0x400 is a thing in framework.

* Ensure return local is the correct type for runtime async (#78603)

* Add test demonstrating current behavior

* Ensure return local is the correct type in async scenarios

* Ensure method is actually async when doing local rewrite

* Exception Handler support (#78773)

* Update EH tests to run with runtime async

* Handle non-null exception filter prologues in the spill sequencer

* Add more testing to show current incorrect behavior

* Unskip ConditionalFacts that do not need to be skipped.

* Handle ensuring that the method remains valid, even when there is an `await` in a finally section. Add signifcant testing of `await using`.

* Fix baselines

* Support `await foreach` and add runtime async verification to existing tests.

* Remove unnecessary generic

* Failing tests, add async void test suggestion

* CI failures

* Add additional test

* Test fixes

* Remove implemented PROTOTYPE, add assertion on behavior.

* Update to SpillSequenceSpiller after some more debugging and tightening the assertion

* Fix nullref

* Enable nullable for VisitCatchBlock

* Support using a simple overload resolution for finding Await helpers from the BCL (#79135)

* Support using a simple overload resolution for finding Await helpers from the BCL

This PR removes special knowledge of what `Await` helpers correspond to what types, and instead implements a very simple form of overload resolution. We immediately bail on any conflict or error and fall back to attempting to use `AwaitAwaiter` or `UnsafeAwaitAwaiter` when such scenarios are detected. I've also updated the rules to better reflect what is actually implementable.

* Create the full BoundCall in initial binding.

* PR feedback.

* Baseline struct lifting tests (#79505)

* Extract expectedOutput constants, minor touchups

* Rename expected -> expectedOutput

* Include new testing with placeholder baselines

* Progress

* First ILVerify pass

* Initial baseline IL run.

* Further baseline additions and skips based on missing corelib apis.

* Clone async void tests and have them use async Task, and validate existing code spit for these under runtime async

* Update baselines after .NET 10 intake

* Delete the stub

* Remove long dynamic baseline and leave a prototype.

* Feedback.

* BOM

* Remove unused references parameter

* Block `await dynamic`

* Block hoisted variables from runtime async for now

* Update test baselines for block

* Block arglist in runtime async

* Add IL baseline

* Handle an additional branch beyond the end of the method case.

* Move prototype comments to issues.

* Remove entry point prototypes

* Add assert and comment

* Add back assert

* Report obsolete/experimental diagnostics on await helpers.

* Fix ref safety analysis build error.

---------

Signed-off-by: Emmanuel Ferdman <[email protected]>
Co-authored-by: Jan Jones <[email protected]>
Co-authored-by: dotnet-maestro[bot] <dotnet-maestro[bot]@users.noreply.github.com>
Co-authored-by: Cyrus Najmabadi <[email protected]>
Co-authored-by: David Barbet <[email protected]>
Co-authored-by: Ankita Khera <[email protected]>
Co-authored-by: David Wengier <[email protected]>
Co-authored-by: Rikki Gibson <[email protected]>
Co-authored-by: Cyrus Najmabadi <[email protected]>
Co-authored-by: Rikki Gibson <[email protected]>
Co-authored-by: akhera99 <[email protected]>
Co-authored-by: Joey Robichaud <[email protected]>
Co-authored-by: Todd Grunke <[email protected]>
Co-authored-by: Youssef1313 <[email protected]>
Co-authored-by: Joey Robichaud <[email protected]>
Co-authored-by: Tomáš Matoušek <[email protected]>
Co-authored-by: Amadeusz Wieczorek <[email protected]>
Co-authored-by: Charles Stoner <[email protected]>
Co-authored-by: Jared Parsons <[email protected]>
Co-authored-by: Sam Harwell <[email protected]>
Co-authored-by: dotnet-maestro[bot] <42748379+dotnet-maestro[bot]@users.noreply.github.com>
Co-authored-by: Jason Malinowski <[email protected]>
Co-authored-by: Etienne Baudoux <[email protected]>
Co-authored-by: AlekseyTs <[email protected]>
Co-authored-by: Jan Jones <[email protected]>
Co-authored-by: Maryam Ariyan <[email protected]>
Co-authored-by: Andrew Hall <[email protected]>
Co-authored-by: Arun Chander <[email protected]>
Co-authored-by: Kauwai Lucchesi <[email protected]>
Co-authored-by: Bill Wagner <[email protected]>
Co-authored-by: PaddiM8 <[email protected]>
Co-authored-by: Matteo Prosperi <[email protected]>
Co-authored-by: Julien Couvreur <[email protected]>
Co-authored-by: Matteo Prosperi <[email protected]>
Co-authored-by: Carlos Sánchez López <[email protected]>
Co-authored-by: Tomas Matousek <[email protected]>
Co-authored-by: Deepak Rathore (ALLYIS INC) <[email protected]>
Co-authored-by: Emmanuel Ferdman <[email protected]>
Co-authored-by: Evgeny Tvorun <[email protected]>
Co-authored-by: Victor Pogor <[email protected]>
Co-authored-by: Ella Hathaway <[email protected]>
Co-authored-by: Viktor Hofer <[email protected]>
Co-authored-by: Jason Malinowski <[email protected]>
Co-authored-by: DoctorKrolic <[email protected]>
Co-authored-by: John Douglas Leitch <[email protected]>
Co-authored-by: Matt Thalman <[email protected]>
Co-authored-by: Bernd Baumanns <[email protected]>
Co-authored-by: Thomas Shephard <[email protected]>
Co-authored-by: DoctorKrolic <[email protected]>
Co-authored-by: David Barbet <[email protected]>
Co-authored-by: Chris Sienkiewicz <[email protected]>
Co-authored-by: tmat <[email protected]>
Co-authored-by: [email protected] <[email protected]>
Co-authored-by: Gen Lu <[email protected]>
Co-authored-by: Oleg Tkachenko <[email protected]>
Co-authored-by: Matt Mitchell <[email protected]>
Co-authored-by: Djuradj Kurepa <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Stuart Lang <[email protected]>
Co-authored-by: RaymondY <[email protected]>
Co-authored-by: Gobind Singh <[email protected]>
Co-authored-by: David Kean <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants