Runtime async via intrinsic - #20235
Conversation
❗ Release notes requiredYou can open this PR in browser to add release notes: open in github.dev
|
…c; add Language preview release notes
The features dictionary lost ImplicitDIMCoverage, MethodOverloadsCache,
ErrorOnMissingSignatureAttribute, DirectDelegateConstruction,
AccessProtectedBaseFieldFromClosure and RecordSpreads entries, causing
54 CI test failures ('Unable to find feature' internal errors and
preview features not enabled).
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
| Microsoft.FSharp.Core.CompilerServices.SetStateMachineMethodImpl`1[TData]: Void Invoke(Microsoft.FSharp.Core.CompilerServices.ResumableStateMachine`1[TData] ByRef, System.Runtime.CompilerServices.IAsyncStateMachine) | ||
| Microsoft.FSharp.Core.CompilerServices.StateMachineHelpers: Boolean __useResumableCode[T]() | ||
| Microsoft.FSharp.Core.CompilerServices.StateMachineHelpers: Microsoft.FSharp.Core.FSharpOption`1[System.Int32] __resumableEntry() | ||
| Microsoft.FSharp.Core.CompilerServices.StateMachineHelpers: System.Threading.Tasks.Task`1[T] __runtimeAsync[T](T) |
There was a problem hiding this comment.
So this would be the only public addition and initial usage would come via library provided CE ?
(I agree its better to keep it out of dotnet/fsharp to iterate faster, and only move once stabilized 👍 )
There was a problem hiding this comment.
Yes, I guess we cannot just replace current task builder implementation while the library is ns21. (not sure about it).
There was a problem hiding this comment.
From agility perspective, I feel like its better to start with it outside of dotnet/fsharp.
Btw. this intrinsic might be a good candidate for - #20229 .
That eliminates a class of issues of people targeting it with an unsupported runtime.
With #20229 , the implementation of the library addition (now just the slim intrinsic) might also be doing calls to the BCL apis for AsyncHelpers (or better leave those to the CE implementation ?)
| "__stateMachine should always be guarded by __useResumableCode and only used in valid state machine implementations" | ||
|
|
||
| [<MethodImpl(MethodImplOptions.NoInlining)>] | ||
| let __runtimeAsync<'T> (value: 'T) : Task<'T> = |
There was a problem hiding this comment.
Why a fail and not a retype?
I also wonder about the "older compiler, newer Fsharp.Core" consequences here.
There was a problem hiding this comment.
Retype as in different nominal type than actual resulting type? The idea here is to have it typecheck correctly with no extra compiler work. By the spec we need the resulting method to actually return 't, but have a Task<'t> nominal return type, so this covers it. During typecheck we got Task<'t> just from the signature here. Optimizer erases __runtimeAsync and we emit async method which returns 't just like the runtime expects.
As for FSharp.Core / compiler mismatch, this is, kind of like __stateMachine, an "expert" feature for authoring CE builders or low level runtime async methods. The fail with unsupported compiler is same behavior as __stateMachine.
There was a problem hiding this comment.
Got it, this is just for the final return/Run.
Maybe the name could indicate it?
Like __return_from_runtimeAsync ?
There was a problem hiding this comment.
Yes, that's the intent . more ideas: __asyncReturn, __runtimeAsyncReturn
T-Gro
left a comment
There was a problem hiding this comment.
🕵️🤖 A couple more notes without inline anchors:
- Non-generic
Task/ValueTaskreturns are silently unsupported — worth a diagnostic so it errors instead of miscompiling (docs L31). - ILVerify can't verify
async-returning methods yet, so this codegen stays unverified in CI — known gap.
Backed by a small runtime-async edge-case suite (runtime behavior + emitted IL) driven through a test-only runtimeTask CE.
| .WithSynchronized(hasSynchronizedImplFlag) | ||
| .WithNoInlining(hasNoInliningFlag) | ||
| .WithAggressiveInlining(hasAggressiveInliningImplFlag) | ||
| .WithAsync(isRuntimeAsync) |
There was a problem hiding this comment.
🕵️🤖 With the method marked async here, remember to also disallow .tail in the body — ilverify flags TailRetType on a tail-call after Await.
F# test
[<Fact>]
let ``runtime async currently emits a forbidden tail prefix (C1)`` () =
compileDirect "let f (g: int -> int) (x: int) : Task<int> = StateMachineHelpers.__runtimeAsync (AsyncHelpers.Await(Task.Delay(1)); g x)"
|> verifyILContains [ "tail." ] // .tail is emitted today; ilverify -> TailRetType
|> shouldSucceed|
|
||
| * `tail.` and `localloc` are forbidden. | ||
| * suspension cannot occur inside exception-handling regions. Awaiting in a | ||
| `try` body now works on the current runtime; awaiting inside a `finally` |
There was a problem hiding this comment.
🕵️🤖 await in finally/catch compiles with no diagnostic and fail-fasts at runtime (0xC0000409) — wants a real error eventually.
F# test
[<Theory>]
[<InlineData("await-in-finally",
"let f () : Task<int> = StateMachineHelpers.__runtimeAsync (try 1 finally AsyncHelpers.Await(Task.Delay(1)))")>] // runtime: fail-fast 0xC0000409 / SIGSEGV
[<InlineData("await-in-catch",
"let f () : Task<int> = StateMachineHelpers.__runtimeAsync (try failwith \"boom\" with _ -> AsyncHelpers.Await(Task.Delay(1)); 7)")>] // runtime: crash
let ``contract-forbidden suspension pattern compiles with no diagnostic`` (_label: string) (body: string) =
compileDirect body |> shouldSucceed // NO diagnostic today| `try`, then restores a pending exception. This makes `use` on an | ||
| `IAsyncDisposable` work under runtime async (`testUsingAsyncDisposableSync` | ||
| executes). | ||
| * Byref, byref-like, and pinned locals cannot be preserved across suspension. |
There was a problem hiding this comment.
🕵️🤖 Same undiagnosed gap for ref-struct/byref across a suspension (→ IndexOutOfRange at runtime); C# gives CS4007/CS1988.
F# test
[<Theory>]
[<InlineData("refstruct-across-suspension",
"let f () : Task<int> = StateMachineHelpers.__runtimeAsync (let data = [| 10; 20; 30 |] in let span = ReadOnlySpan<int>(data) in AsyncHelpers.Await(Task.Delay(1)); span[0] + span[1] + span[2])")>] // runtime: IndexOutOfRange (C14)
[<InlineData("byref-param-across-suspension",
"let f (x: byref<int>) : Task<int> = StateMachineHelpers.__runtimeAsync (AsyncHelpers.Await(Task.Delay(1)); x)")>] // C# gives CS1988
let ``contract-forbidden suspension pattern compiles with no diagnostic`` (_label: string) (body: string) =
compileDirect body |> shouldSucceed // NO diagnostic today|
Another thing to think through is inlining. Currently there are no checks at all for use of suspending Currently it is up to the "expert" user to not misuse This is still a sketch, but it successfully compiles |
We could have a notion of PostIlxGen checks. |
|
🕵️🤖 Parked a runtime-async edge-case suite on |
Roslyn-async2-inspired edge cases for the runtime-async intrinsic, driven through
the test-only runtimeTask CE (treated as a hypothetical library):
* execution fixture (RuntimeAsync/RuntimeAsyncEdgeCases.fs): locals/loops across
suspension, non-ref struct across suspension, ValueTask operand, exception
propagation, IAsyncDisposable with genuinely-async DisposeAsync.
* facts (RuntimeAsyncEdgeCaseTests.fs): Await overload selection per operand type,
no compiler state machine (direct + CE), the C1 forbidden `tail.` prefix, and a
parametrized set of currently-undiagnosed contract-forbidden patterns
(await-in-finally/catch, ref-struct- and byref-across-suspension).
Every asserted IL substring and runtime symptom was captured empirically on the
pinned net11 preview; the forbidden patterns match docs/runtime-async.md.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 55dd72c8-46d3-4959-9677-c52d41779596
The sequence-points baseline (and ildasm) cannot render MethodImplOptions.Async (0x2000), so the lifted __runtimeAsync body shows up as a plain outer@<line> closure. Factor the metadata flag check into assertAsyncFlagOnLiftedClosureOnly and chain it onto the sequence-points fact so the exact program that emits the .bsl also proves the async marker lands only on the lifted closure, never on the user's outer/helper methods. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 55dd72c8-46d3-4959-9677-c52d41779596
|
Looks like the runtime feature is quickly evolving, see #19056 (comment) |
|
I wonder how to support the other allowed return types. __runtimeAsyncReturn<'T> : 'T -> Task<'T>
__runtimeAsyncReturnValueTask<'T> : 'T -> ValueTask<'T>
__runtimeAsyncReturnUnit : unit -> Task
__runtimeAsyncReturnValueTaskUnit : unit -> ValueTaskand it quickly becomes a whole zoo. Do we need the non-generic versions at all? Only for potential C# interop, I guess. The upside is that the current type check is all we need to keep it correct, without any extra handling. The other alternative it to have a unconstrained |
I pulled them in and adjusted to |
|
|
The downside is the errors surface only during build, not in the IDE, just like with resumable state machines. |
|
Regarding suspension in exception handling blocks, it's not hard to do a rewrite during optimization, just like C# compiler does. |
04e7fb3 to
27944e7
Compare
Yet another proof of concept (see also #19449)
The experiment here is to explore viability of working CE builders with just a minimal compiler support.
consider
intrinsic, which when used as a member or function body, promotes it to
managed async.We can have a fully inlining builder which wraps the code in it's Run method:
Because resumption is handled by the runtime, the builder is effectively just a sync builder with
There are more concerns than suspension / resumption that the runtime apparently does not handle and they would have to be covered either by the compiler or the builder implementations:
awaits in EH blocks (IAsyncDisposable) - this has a PoC in the tests here.
byref locals and execution context / sync context, see C# docs below.
runtime spec :
Runtime-async specification
interesting docs on C# implementation