Add documentation warning for Interlocked.Read write access requirement on 32-bit platforms #11659
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 PR adds critical documentation to the
Interlocked.Read
methods to warn developers about a non-intuitive behavior that can cause crashes.Problem
The
Interlocked.Read
method takes a readonly reference parameter (in
parameter), which suggests it only needs read access to the memory location. However, on 32-bit platforms, the method internally usesCompareExchange
to ensure atomicity, which requires write access to the memory location.This causes
AccessViolationException
when developers attempt to useInterlocked.Read
with read-only memory, such as memory-mapped files opened with read-only access:Solution
Added important documentation warnings to both
Interlocked.Read(ref long)
andInterlocked.Read(ref ulong)
methods that clearly explain:CompareExchange
for atomicityAccessViolationException
The documentation uses a prominent
[!IMPORTANT]
callout to ensure this critical limitation is highly visible to developers.Impact
This change helps prevent runtime crashes by making developers aware of this limitation upfront, allowing them to choose alternative approaches when working with read-only memory on 32-bit platforms.
Fixes #11658.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.