[Concurrency] Updates after second SE pitch. #82456
Open
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
|
@swift-ci Please smoke test |
al45tair
force-pushed
the
concurrency-updates
branch
from
2a19c34 to
8c00ea0
Compare
|
@swift-ci Please smoke test |
ktoso
reviewed
Jun 27, 2025
| /// | ||
| /// Parameters: | ||
| /// | ||
| /// - from duration: The `Duration` to convert | ||
| /// - job: The job we wish to run | ||
| /// - at instant: The time at which we would like it to run. |
There was a problem hiding this comment.
does spelling params like this actually parse well in docc? I thought one has to put only the second name 🤔
ktoso
reviewed
Jun 27, 2025
| /// given instant. | ||
| /// | ||
| /// The default implementation uses the `run` method to trigger a job that | ||
| /// does `executor.enqueue(job)`. If a particular `Clock` knows that the |
There was a problem hiding this comment.
minor
Suggested change
| /// does `executor.enqueue(job)`. If a particular `Clock` knows that the | |
| /// does `executor.enqueue(job)`. If a particular ``Clock`` knows that the |
maybe worth ref like that?
ktoso
reviewed
Jun 27, 2025
| run(trampoline, at: instant, tolerance: tolerance) | ||
| } | ||
|
|
||
| // Clocks that do not implement run will fatalError() if you try to use |
There was a problem hiding this comment.
Suggested change
| // Clocks that do not implement run will fatalError() if you try to use | |
| // Clocks that do not implement this method will fatalError() if you try to use |
maybe? "implement run" sounds a bit weird mid-sentence
ktoso
reviewed
Jun 27, 2025
| // Convert to `Swift.Duration` | ||
| let duration = clock.convert(from: delay)! | ||
| let duration = delay as! Swift.Duration |
There was a problem hiding this comment.
can we put a comment here discussing the as!'s risk, could it ever fail?
ktoso
reviewed
Jun 27, 2025
| // executor. | ||
| extension ExecutorJob { | ||
|
|
||
| /// Create a trampoline to enqueue the specified job on the specified |
There was a problem hiding this comment.
minor?
Suggested change
| /// Create a trampoline to enqueue the specified job on the specified | |
| /// Create a trampoline to enqueue this job on the specified |
ktoso
reviewed
Jun 27, 2025
| /// Create a trampoline to enqueue the specified job on the specified | ||
| /// executor. | ||
| /// | ||
| /// This is useful in conjunction with the `Clock.run()` API, which |
There was a problem hiding this comment.
I think this'll link well:
Suggested change
| /// This is useful in conjunction with the `Clock.run()` API, which | |
| /// This is useful in conjunction with the ``Clock.run(_:at:tolerance:)`` API, which |
ktoso
reviewed
Jun 27, 2025
| /// | ||
| /// Returns: | ||
| /// | ||
| /// A new ExecutorJob that will enqueue the specified job on the specified |
There was a problem hiding this comment.
Suggested change
| /// A new ExecutorJob that will enqueue the specified job on the specified | |
| // - Returns: A new ExecutorJob that will enqueue the specified job on the specified |
needs the - I think?
ktoso
reviewed
Jun 27, 2025
| /// This is useful in conjunction with the `Clock.run()` API, which | ||
| /// runs a job on an unspecified executor. | ||
| /// | ||
| /// Parameters: |
There was a problem hiding this comment.
Suggested change
| /// Parameters: | |
| /// - Parameters: |
Needs the - I think?
ktoso
reviewed
Jun 27, 2025
ktoso
approved these changes
Jun 27, 2025
No worries. I think you're right about the doc comments; I'll go and update them all. |
We no longer attempt to convert timestamps from the passed-in `Clock` in order to allow any clock to work with any executor. Instead, executors that do not recognise a clock should call the `enqueue` function on that `Clock`, which lets the `Clock` itself decide how to proceed. Additionally, rename `SchedulableExecutor` to `SchedulingExecutor`.
…cks. The built-in clocks should have implementations of `run` and `enqueue`, to allow derived clocks to call those implementations.
I don't think we actually need this. If you have a non-canonical (i.e. derived) clock, you can just implement `enqueue` and/or `run` and call those methods on the clock you're wrapping.
If a job enqueues another job on the executor, we might never leave the inner `while` loop in the `run()` method. Fix this by taking the contents of the run queue and only running those jobs in the queue at the time we enter the inner loop.
Add some documentation comments to the Dispatch and CF executors, and update the comments for the allocation and private data APIs.
Rather than just looking at top level in the module, start by searching the type marked as `@main`. This means that a library that provides a protocol or superclass that the `@main` type can conform to can specify an executor in a reasonable manner.
Also add `final` to the `CooperativeExecutor` declaration.
al45tair
force-pushed
the
concurrency-updates
branch
from
38ead6d to
262f07a
Compare
|
(Haven't updated doc comments yet; that's the next job…) |
Some formatting fixes for the doc comments.
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.
We're changing our approach to
Clocksupport in executors such that a clock that isn't recognised by an executor will result in a call to anenqueuemethod onClockitself; this will allow clocks to have control over exactly how they schedule jobs in cases where the executor doesn't already know what to do.Also includes a small bug fix for
CooperativeExecutorand some updated comments.rdar://154191435