Include the error reason when loading a nif fails #5199
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
When a nifs `on_load` function returns a non-ok value loading fails today silently without showing the returned error reason.
This is especially sad when the `on_load` callback is calling `erlang:load_nif/2` as it lasts statement which many nif `on_load` callbacks do. `erlang:load_nif/2` typically returns quite helpful error tuples that help to identify the reasons for why the nif failed loading. This change makes the error message appear in the output and in debug messages when debugging is enabled.
```erlang
-on_load(init/0).
init() ->
SoName = filename:join(code:priv_dir(?APPNAME), ?LIBNAME),
erlang:load_nif(SoName, 0).
```
Contributor
|
This PR seems to address |
|
@sverker Curious, why hasn't this enhancement made it into an erlang release yet? I'm having some starting problems in embedded mode, and this fix would be a welcome addition to my debugging. |
Contributor
|
@samwar Because the PR was based on If you really want it for 24.3 do |
Contributor
|
OTP-24.3 is planned for March and 25.0 for May. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
When a nifs
on_loadfunction returns a non-ok value loading fails today silently without showing the returned error reason.This is especially sad when the
on_loadcallback is callingerlang:load_nif/2as it lasts statement which many nifon_loadcallbacks do.erlang:load_nif/2typically returns quite helpful error tuples that help to identify the reasons for why the nif failed loading. This change makes the error message appear in the output and in debug messages when debugging is enabled.