Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Merge v1.13.1 #4236

Merged
merged 3 commits into from Nov 16, 2021
Merged

Merge v1.13.1 #4236

merged 3 commits into from Nov 16, 2021

Conversation

hawkw
Copy link
Member

@hawkw hawkw commented Nov 15, 2021

Refs: #4235

@hawkw
sync: fix racy UnsafeCell access on a closed oneshot (#4226)
ab0e60d
@hawkw
oneshot: document UnsafeCell invariants (#4229)
7d8de50 
Depends on #4226

## Motivation

Currently, the safety invariants and synchronization strategy used in
`tokio::sync::oneshot` are not particularly obvious, especially to a new
reader. It would be nice to better document this code to make these
invariants clearer.

## Solution

This branch adds `SAFETY:` comments to the `oneshot` channel
implementation. In particular, I've focused on documenting the
invariants around when the inner `UnsafeCell` that stores the value can
be accessed by the sender and receiver sides of the channel.

I still want to take a closer look at when the waker cells can be set,
and I'd like to add more documentation there in a follow-up branch.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw
chore: prepare Tokio v1.13.1 (#4235)
2a3c803 
# 1.13.1 (November 15, 2021)

### Fixed

- sync: fix a data race between `oneshot::Sender::send` and awaiting a
  `oneshot::Receiver` when the oneshot has been closed ([#4226])

[#4226]: #4226
Noah-Kennedy
Noah-Kennedy approved these changes Nov 16, 2021
View reviewed changes
Copy link
Contributor

@Noah-Kennedy Noah-Kennedy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rubber stamp of approval!

@hawkw hawkw merged commit e0be45e into master Nov 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Noah-Kennedy Noah-Kennedy Noah-Kennedy approved these changes

@carllerche carllerche Awaiting requested review from carllerche

@tobz tobz Awaiting requested review from tobz

@Darksonn Darksonn Awaiting requested review from Darksonn

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@hawkw @Noah-Kennedy