fix: Add memory lifetime warnings to ReadOnlySpan properties - #406
Open
Abhilash437 wants to merge 1 commit into
Open
fix: Add memory lifetime warnings to ReadOnlySpan properties#406Abhilash437 wants to merge 1 commit into
Abhilash437 wants to merge 1 commit into
Conversation
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.
What's Changed
Adds explicit XML documentation remarks (
<remarks>) to properties and methods that return aReadOnlySpanover managed or unmanaged memory across Apache Arrow array and buffer classes.Motivation & Relation to PR #393
When an
ArrowBufferorArrayis backed by unmanaged memory (e.g., allocated via a customMemoryAllocatororNativeMemoryManager), extracting aReadOnlySpaninto a local variable and subsequently disposing the parent buffer/array can lead to use-after-free memory access issues.While PR #393 explores structural lifecycle/pinning mechanisms, this PR provides an immediate, non-breaking developer safety improvement:
<remarks>warning callouts toArrowBuffer.Span,PrimitiveArray.Values,BooleanArray.Values, andBinaryArray.GetBytes. These surface as visible safety notes in IDE tooltips and IntelliSense (Visual Studio, VS Code, Rider) without breaking builds or requiring API breaking changes underTreatWarningsAsErrors=true.PoisonMemoryAllocatorand unit testTestNativeMemoryManagerUseAfterFreetoApache.Arrow.Teststo verify memory poisoning on buffer release.Closes #397. Relates to #393.