-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Update documentation of as_ptr
function of Atomic$Int to clarify circumstances of usage
#139637
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
Open
madhav-madhusoodanan
wants to merge
2
commits into
rust-lang:master
Choose a base branch
from
madhav-madhusoodanan:Atomic_as_ptr_doc_update
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Update documentation of as_ptr
function of Atomic$Int to clarify circumstances of usage
#139637
madhav-madhusoodanan
wants to merge
2
commits into
rust-lang:master
from
madhav-madhusoodanan:Atomic_as_ptr_doc_update
+9
−21
Conversation
This file contains 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
as_ptr
to reflect that its usage must not lead to data racesas_ptr
function of Atomic$Int to reflect that its usage must not lead to data races
as_ptr
function of Atomic$Int to reflect that its usage must not lead to data racesas_ptr
function of Atomic$Int to clarify circumstances of usage
briansmith
suggested changes
Apr 10, 2025
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.
Thanks for taking this on.
This comment has been minimized.
This comment has been minimized.
c1108bf
to
27c0b65
Compare
I've added an example where there is no |
RalfJung
reviewed
Apr 17, 2025
RalfJung
reviewed
Apr 17, 2025
RalfJung
reviewed
Apr 17, 2025
@rustbot author |
Reminder, once the PR becomes ready for a review, use |
…ead to data races.
…mstances of usage
27c0b65
to
a87f6ea
Compare
@rustbot ready |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
T-libs
Relevant to the library team, which will review and decide on the PR/issue.
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.
Context
The documentation of
as_ptr
mentions that "operations on it must be atomic". This may confuse developers, since non-atomic reads may be safely performed in certain circumstances (eg: when they do not lead to a data race).The core message is that non-atomic accesses are UB if they cause a data race.
This update ensures such clarity on the circumstances of usage of the
as_ptr
function.Associated Issue
cc: @RalfJung @briansmith