Improve documentation for aligned allocation on heap with registered arena and add contract tests - #1409
Open
OscarTHZhang wants to merge 2 commits into
Open
Improve documentation for aligned allocation on heap with registered arena and add contract tests#1409OscarTHZhang wants to merge 2 commits into
OscarTHZhang wants to merge 2 commits 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
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.
For alignment allocations on heaps (
mi_heap_malloc_aligned,mi_heap_zalloc_aligned,mi_heap_calloc_aligned, andmi_heap_realloc_aligned), there is an internal max limit on the alignment of 64 KiB. When the heap is from a registered arena, once the caller requests an alignment over this 64 KiB-limit, even if there is space available in the arena-backed heap, the request would fail and return a NULL pointer because it cannot fallback to OS-backed memory for over 64KiB alignment request.This PR adds contract API tests to validate this behavior and improve the documentation over these functions to make it clear that there is a 64 KiB alignment limit when using with arena-backed heaps.
The issue is discussed in #1406