Centralize task creation in the Concurrency runtime #38076
Merged
Conversation
This file contains hidden or 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
introduce new options parameter to all task spawning [Concurrency] ABI for asynclet start to accept options [Concurrency] fix unittest usages of changed task creation ABI [Concurrency] introduce constants for parameter indexes in ownership [Concurrency] fix test/SILOptimizer/closure_lifetime_fixup_concurrency.swift (cherry picked from commit 8536100)
(cherry picked from commit f37ae3d)
ExecutorRefs are a (pointer, witness table) pair that are meant to be passed around. We don't need to form a reference to one because they are ABI already.
Collapse the `group` parameter of this API into the task options, and have existing callers set up the options appropriately. The goal for this function is to become the centralized entry point for all task creation, with an extensible interface.
The flags that are useful for task creation are a bit different from the flags that go on a job. Create a separate flag set for task creation and use that in the API for `swift_task_create`. For now, have the callers do the remapping.
Introduce a builtin `createAsyncTask` that maps to `swift_task_create`, and use that for the non-group task creation operations based on the task-creation flags. `swift_task_create` and the thin function version `swift_task_create_f` go through the dynamically-replaceable `swift_task_create_common`, where all of the task creation logic is present. While here, move copying of task locals and the initial scheduling of the task into `swift_task_create_common`, enabling by separate flags.
We no longer need these entry points.
Extend the behavior of `swift_task_create_common` to also encompass adding the pending group task (when requested) and attaching it to the group.
We've moved everything over to `CreateAsyncTask` now.
This is a small shim over `swift_task_create`. Use that instead.
…all. Introduce a task option record to capture the async-let storage, so that `swift_task_create` can perform the appropriate initialization.
It's a tiny shim over `swift_task_create_common` that is rarely used. Switch all of the former callers over the common API.
Rather than using group task options constructed from the Swift parts of the _Concurrency library and passed through `createAsyncTask`'s options, introduce a separate builtin that always takes a group. Move the responsibility for creating the options structure into IRGen, so we don't need to expose the TaskGroupTaskOptionRecord type in Swift.
We'll keep the task options entirely as a contract between IRGen and the concurrency runtime, so Swift code need not deal with them.
We're not actually performing the adjustments at the moment due to an unrelated bug, and will want to perform them within `swift_task_create_common` based on inheritContext and the given priority.
The `swift_task_create` entry point is our general runtime ABI for launching tasks. Make the various Swift APIs sitting on top of it always-emit-into-client to take them out of the ABI. This reduces the number of ABI entry points and allows us to make more ABI-compatible changes to the Swift side.
This entry point is a small shim over `swift_task_create_common`, which is overridable. We don't need a separate override point here.
|
@swift-ci please test |
|
Build failed |
|
@swift-ci please test |
|
Build failed |
|
Spurious failure on Linux. Retrying... |
|
@swift-ci please test Linux |
|
Build failed |
|
macOS hit the async_stream failure but is otherwise good. Rerunning... |
|
@swift-ci please test macOS |
|
@swift-ci please nominate |
|
Build failed |
|
@swift-ci please test |
|
Build failed |
|
@swift-ci please test Linux |
tkremenek
approved these changes
Jun 25, 2021
AnthonyLatsis
added
🍒 release cherry pick
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Explanation: Centralize and clean up task creation facilities for the concurrency runtime. This reduces the number of entry points we use to create tasks while making them more general, so we can extend the task-creation facilities without breaking the ABI again. This itself is a significant ABI break for Swift Concurrency.
Scope: Affects all programs using Swift Concurrency
Radar/SR Issue: rdar://79584250
Risk: Moderate. It's a rework of compiler/runtime interaction for concurrent task creation, so it carries some risk of breaking programs using concurrency.
Testing: PR testing and CI on main.
Original PR: #38021