Fix a bug when passing data to GMT in Session.open_virtual_file() #490
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
External programs like PyGMT can pass dataset/momory to GMT. By default, GMT can read, modify and free the momery, which sometimes can cause crashes. Issue #406 reports an example in which PyGMT crashes. The issue was reported to the upstream (see GenericMappingTools/gmt#3515 and GenericMappingTools/gmt#3528). It turns out to be a API user error (i.e., a PyGMT bug). As per the explanation of Paul, external programs like PyGMT should always use `GMT_IN|GMT_IS_REFERENCE` to tell GMT that the data is read-only, so that GMT won't try to change and free the memory. This PR makes the change from `GMT_IN` to `GMT_IN|GMT_IS_REFERENCE` in the `Session.open_virtual_file()` function, updates a few docstrings, and also adds the script in #406 as a test.
seisman
added
bug
weiji14
approved these changes
Jun 24, 2020
Member
weiji14
left a comment
weiji14
left a comment
There was a problem hiding this comment.
Cool, the test looks good. Can you edit the top post and add a link/reference to the GMT C API documentation section for GMT_ IN|GMT_IS_REFERENCE (I'm guessing it's https://docs.generic-mapping-tools.org/dev/api.html#resource-registration?) so others know about it in the future.
Anyways, should be good to merge 🎉
5 tasks
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.
Description of proposed changes
External programs like PyGMT can pass dataset/momory to GMT. By default,
GMT can read, modify and free the momery, which sometimes can cause
crashes.
Issue #406 reports an example in which PyGMT crashes. The issue was reported
to the upstream (see GenericMappingTools/gmt#3515
and GenericMappingTools/gmt#3528). It turns out
to be an API user error (i.e., a PyGMT bug).
As per the explanation of Paul, external programs like PyGMT should
always use
GMT_IN|GMT_IS_REFERENCEto tell GMT that the data isread-only, so that GMT won't try to change and free the memory.
This PR makes the change from
GMT_INtoGMT_IN|GMT_IS_REFERENCEin the
Session.open_virtual_file()function, updates a few docstrings,and also adds the script in #406 as a test.
Fixes #406.
GMT C API references: https://docs.generic-mapping-tools.org/latest/api.html#resource-registration
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.