sync: fix notification permit getting dropped on receiver drop #3652
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.
Noticed this small bug when reading through notify.rs.
Motivation
The Drop implementation for sync::notify::Notified has a case where it sets the notification state to EMPTY, regardless of previous state. This is motivated by a comment claiming that this is correct in all cases except when the previous state is NOTIFIED, in which case the state will be changed back to NOTIFIED further down in notify_locked. But with the introduction of notify_waiters this is no longer always true, because that call is filtered by the notification type being NotificationType::OneWaiter. Indeed the following can happen:
Solution
Condition the write on state being WAITING. (I'm guessing the previous code is a remnant from when state wasn't already previously being read higher up in the function?)