docs(advanced): document lock-free data structures (RCU, epoch-based reclamation)#369
Merged
Merged
Conversation
…reclamation) Add comprehensive documentation for internal lock-free primitives: - rcu_value<T>: RCU pattern with wait-free reads and lock-free updates - epoch_manager: epoch-based memory reclamation with 3-epoch rotation - Integration with lockfree_container_reader and auto_refresh_reader - Correctness guarantees, memory ordering, and ABA problem avoidance - Performance characteristics and comparison with alternatives
6 tasks
- Add copy/move constructors and assignment operators to rcu_value API table - Document legacy type alias lockfree_reader = snapshot_reader with warning - Fix code examples: use int32_t instead of int to match ValueVariantType concept
Owner
Author
Test Plan Verification1. Verify documentation renders correctly on GitHub
2. Cross-reference API descriptions against source code
3. Confirm all code examples are accurate and compile-ready
|
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
…reclamation) (#369) * docs(advanced): document lock-free data structures (RCU, epoch-based reclamation) Add comprehensive documentation for internal lock-free primitives: - rcu_value<T>: RCU pattern with wait-free reads and lock-free updates - epoch_manager: epoch-based memory reclamation with 3-epoch rotation - Integration with lockfree_container_reader and auto_refresh_reader - Correctness guarantees, memory ordering, and ABA problem avoidance - Performance characteristics and comparison with alternatives * docs(advanced): fix review findings in lock-free documentation - Add copy/move constructors and assignment operators to rcu_value API table - Document legacy type alias lockfree_reader = snapshot_reader with warning - Fix code examples: use int32_t instead of int to match ValueVariantType concept * docs(advanced): fix typo in epoch diagram (Retire -> List)
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
1 participant
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.
Closes #365
Summary
docs/advanced/LOCK_FREE.mdcovering internal lock-free primitivesrcu_value<T>RCU pattern: wait-free reads, lock-free updates, shared_ptr-based reclamationepoch_managerepoch-based reclamation: 3-epoch rotation, deferred deletion, RAII guardlockfree_container_readerandauto_refresh_readerTest Plan
internal/rcu_value.handinternal/epoch_manager.h