Document internal function pointer stability guarantees #15721
Merged
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
matheusaaguiar
approved these changes
Jan 15, 2025
1983234 to
4b1bf33
Compare
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.
Resolves #15716.
As discussed on today's call, I'm updating docs regarding internal function pointers.
I decided to add a whole subsection regarding internal pointer values since it got a bit too long to be just a warning. I split the section about function types into subsections and gave this new bit a subsection of its own. I also added an entry in "Security considerations", because this is something users must be aware of.
Specifically regarding #15716, I added notes that the compiler is free to remove internal functions that are not referenced explicitly, by name. Both in function type docs and in IR breaking changes.