-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Mark BufferedChannelIterator.continuation @BeningDataRace to address … #3873
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
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
8ad012a
Mark BufferedChannelIterator.continuation @BeningDataRace to address …
qwwdfsad 3e5acfd
Explain benign data-race on SelectImplementation.clauses and mark it …
qwwdfsad 6d91be8
Explain benign data-race on SelectImplementation.internalResult and m…
qwwdfsad be2aa9f
~move benign race explanation to declaration site
qwwdfsad File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -372,7 +372,12 @@ internal open class SelectImplementation<R>( | |
|
||
/** | ||
* List of clauses waiting on this `select` instance. | ||
* | ||
* This property is the subject to bening data-race: concurrent cancellation might null-out this property | ||
* while [trySelect] operation reads it and iterates over its content. | ||
* A logical race is resolved by the consensus on [state] property. | ||
*/ | ||
@BenignDataRace | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I like the explanation here, for example. |
||
private var clauses: MutableList<ClauseData>? = ArrayList(2) | ||
|
||
/** | ||
|
@@ -408,6 +413,7 @@ internal open class SelectImplementation<R>( | |
* or [DisposableHandle] instance when the clause is completed during registration ([inRegistrationPhase] is `false`). | ||
* Yet, this optimization is omitted for code simplicity. | ||
*/ | ||
@BenignDataRace // See its cleanup phase for the explanation | ||
private var internalResult: Any? = NO_RESULT | ||
|
||
/** | ||
|
@@ -621,9 +627,11 @@ internal open class SelectImplementation<R>( | |
// try to resume the continuation. | ||
this.internalResult = internalResult | ||
if (cont.tryResume(onCancellation)) return TRY_SELECT_SUCCESSFUL | ||
// If the resumption failed, we need to clean | ||
// the [result] field to avoid memory leaks. | ||
this.internalResult = null | ||
/* | ||
* If the resumption failed, we need to clean the [result] field to avoid memory leaks. | ||
* This write is benignly races with the very same write in cancellation invoke() handler | ||
qwwdfsad marked this conversation as resolved.
Show resolved
Hide resolved
|
||
*/ | ||
this.internalResult = NO_RESULT | ||
return TRY_SELECT_CANCELLED | ||
} | ||
} | ||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should explicitly list the races right next to the annotation. This way, if a new race is discovered, we won't look at the annotation and go, "oh yeah, we know about this race, it's benign, no worries."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea, fixed