docs: document allocator override scope - #75
Merged
Conversation
Record why no preset or CMake option selects mimalloc, jemalloc, or tcmalloc: ASan's malloc interceptors, the per-platform override mechanism, and dependency binaries that come from the Conan cache unrebuilt. Point at the existing optional-tool pattern in the recipe for anyone adding one.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3c7253193e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
UBSan does not intercept malloc, so sanitize-ubsan can run an allocator override. Name the Address and AddressUndefinedBehavior settings instead of every sanitize* preset.
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.
Adds an
Allocatorssubsection under Build policy indocs/development.md, answering a question the template currently leaves open: why nothing here selects mimalloc, jemalloc, or tcmalloc.The note records the three constraints that make an allocator override more than a link-line change in this repo:
malloc/freeinterceptors, so an override either fails to link or leaves the heap diagnostics silently disabled, and everysanitize*preset would have to gate it off.DYLD_INSERT_LIBRARIESinterposition on macOS,mimalloc-redirect.dllbeside the executable on Windows, which the currentinstall(TARGETS)rule does not ship.It closes with the path to add one anyway, pointing at the optional-tool pattern the recipe already uses for
ccacheandmold/LLD.Documentation only. No build, preset, or recipe changes.
markdownlintandprettier --checkpass;make format-checkwas not run locally becausecmake-formatis not installed on this machine.