Improve AsyncManualResetEvent implementation to address races #1843
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.
Proposed Changes
I used the implementation further in some very high concurrent scenarios and ran into token problems with the manual reset implementation under the cover. I have concluded the original version I tweaked had some races that we collectively missed.
The race condition occurs in WaitAsync() where the IsSet check and valueTaskSource.Version capture happen at different moments without synchronization, allowing Set() or Reset() to execute between these operations and change the state. If Reset() is called after the IsSet check passes but before the ValueTask is created, the version becomes stale and the awaited task will never complete because it references the old version while the ManualResetValueTaskSourceCore has been reset. Additionally, the gap between checking IsSet and updating state in both Set() and Reset() creates windows where multiple threads can pass the initial checks simultaneously, leading to operations being performed on inconsistent state.
This implementation passed my concurrency tests, but it doesn't hurt if the original involved reviewers give this another review @lukebakken @paulomorgado @bollhals
Types of Changes
What types of changes does your code introduce to this project?
Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creatingthe PR. If you're unsure about any of them, don't hesitate to ask on the
mailing list. We're here to help! This is simply a reminder of what we are
going to look for before merging your code.
CONTRIBUTING.md
documentFurther Comments
If this is a relatively large or complex change, kick off the discussion by
explaining why you chose the solution you did and what alternatives you
considered, etc.