RFC: Add portability risk for atomics #2269
Merged
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
teor2345
added
A-docs
5 tasks
3 tasks
teor2345
commented
Jun 11, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
Atomics also carry a portability risk.
We've collected a few potential issues with atomics, including correctness, maintainability, testing, and portability. So let's just avoid them going forward.
Specifications
API documentation:
https://doc.rust-lang.org/std/sync/atomic/#portability
Designs
Updates the atomics section from the "async Rust in Zebra" RFC:
https://github.com/ZcashFoundation/zebra/edit/main/book/src/dev/rfcs/0011-async-rust-in-zebra.md#using-atomics
Solution
Review
@jvff and @oxarbitrage will probably want to check this one.
It's a low-priority documentation update.
Reviewer Checklist
Follow Up Work
Replace atomics with channels #2268