Merged
Conversation
…clarify memory order explanations
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
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.
This pull request introduces a new section to the documentation aimed at consolidating knowledge about memory models and lock-free data structures. It adds detailed explanations and rationale for the memory ordering choices in the
SpinLockandSPSCRingBufferimplementations, replacing previous TODOs with comprehensive documentation. The most important changes are grouped by theme below.Documentation improvements and knowledge consolidation
README.md, linking to detailed explanations forSpinLock,Single-Producer-Single-Consumer Ring Buffer, and its V2 variant, and providing guidance on how to approach the material. [1] [2]Detailed rationale for memory ordering and implementation
README.mdforsrc/spinlock, explaining the TA-TAS spinlock implementation, the rationale for using Test-And-TAS instead of TAS, and detailed justification for memory order choices.README.mdforsrc/spscringbuffer, covering the SPSC ring buffer structure, memory ordering rationale, and happens-before chains, with clear explanations for each operation and memory order.Code comments and cleanup
src/spinlock/mod.rs, as the rationale and message passing scheme are now fully documented in the newREADME.md.