-
Notifications
You must be signed in to change notification settings - Fork 3.5k
[Docs] Improve function pointer docs #26667
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kripken
wants to merge
1
commit into
emscripten-core:main
Choose a base branch
from
kripken:fp.docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+24
−10
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -329,15 +329,15 @@ unaligned. To do so you can: | |
| Function Pointer Issues | ||
| ----------------------- | ||
|
|
||
| If you get an ``abort()`` from a function pointer call to ``nullFunc`` or ``b0`` | ||
| or ``b1`` (possibly with an error message saying "incorrect function pointer"), | ||
| the problem is that the function pointer was not found in the expected function | ||
| pointer table when called. | ||
|
|
||
| .. note:: ``nullFunc`` is the function used to populate empty index entries in | ||
| the function pointer tables (``b0`` and ``b1`` are shorter names used for | ||
| ``nullFunc`` in more optimized builds). A function pointer to an invalid | ||
| index will call this function, which simply calls ``abort()``. | ||
| If you get | ||
|
|
||
| :: | ||
|
|
||
| RuntimeError: null function or function signature mismatch | ||
|
|
||
| (or, in certain build types, an ``abort()`` or an error of "incorrect function | ||
| pointer"), the problem is that a proper function pointer was not found in the | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. .. the problem is that a function of the correct type was not found in the .. |
||
| function pointer table when called. | ||
|
|
||
| There are several possible causes: | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,12 +10,20 @@ There are two main issues with function pointers: | |
| #. | ||
| Function pointer casts can cause function pointer calls to fail. | ||
|
|
||
| Function pointers must be called with the correct type: it is undefined behavior in C and C++ to cast a function pointer to another type and call it that way. This does work in most native platforms, however, despite it being UB, but in Wasm it can fail. In that case, you may see an ``abort(10)`` or some other number, and if assertions are on you may see a message with details that start with | ||
| Function pointers must be called with the correct type: it is undefined behavior in C and C++ to cast a function pointer to another type and call it that way. This does work in most native platforms, however, despite it being UB, but in Wasm it can fail. In that case, you may see an error like this: | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. C/C++ |
||
|
|
||
| :: | ||
|
|
||
| RuntimeError: null function or function signature mismatch | ||
|
|
||
| or | ||
|
|
||
| :: | ||
|
|
||
| Invalid function pointer called | ||
|
|
||
| or ``abort(10)`` or some other number (depending on the type of build). | ||
|
|
||
| Rarely, you may see a compiler warning like this: | ||
|
|
||
| :: | ||
|
|
@@ -38,6 +46,12 @@ Debugging function pointer issues | |
|
|
||
| The ``SAFE_HEAP`` and ``ASSERTION`` options can catch some of these errors at runtime and provide useful information. You can also see if ``EMULATE_FUNCTION_POINTER_CASTS`` fixes things for you, but see later down about the overhead. | ||
|
|
||
| You can get compiler errors for some of these problems with | ||
|
|
||
| :: | ||
|
|
||
| -Werror=cast-function-type | ||
|
|
||
| Working around function pointer issues | ||
| ====================================== | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you combine there lines.
e.g.If you get ::`?