Skip to content
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

Improve performance of the nc_reclaim_data and nc_copy_data functions. #2699

Merged
merged 3 commits into from
Jun 7, 2023

Conversation

DennisHeimbigner
Copy link
Collaborator

re: Issue #2685
re: PR #2179

As noted in PR #2179, the old code did not allow for reclaiming instances of types, nor for properly copying them. That PR provided new functions capable of reclaiming/copying instances of arbitrary types.

However, as noted by Issue #2685, using these most general functions resulted in a significant performance degradation, even for common cases.

This PR attempts to mitigate the cost of using the general reclaim/copy functions in two ways.

First, the previous functions operating at the top level by using ncid and typeid arguments. These functions were augmented with equivalent versions that used the netcdf-c library internal data structures to allow direct access to needed information. These new functions are used internally to the library.

The second mitigation involves optimizing the internal functions by providing early tests for common cases. This avoids unnecessary recursive function calls.

The overall result is a significant improvement in speed by a factor of roughly twenty -- your mileage may vary. These optimized functions are still not as fast as the original (more limited) functions, but they are getting close. Additional optimizations are possible. But the cost is a significant "uglification" of the code that I deemed a step too far, at least for now.

Misc. Changes

  1. Added a test case to check the proper reclamation/copy of complex types.
  2. Found and fixed some places where nc_reclaim/copy should have been used.
  3. Replaced, in the netcdf-c library, (almost all) occurrences of nc_reclaim_copy with calls to NC_reclaim/copy. This plus the optimizations is the primary speed-up mechanism.
  4. In DAP4, the metadata is held in a substrate in-memory file; this required some changes so that the reclaim/copy code accessed that substrate dispatcher rather than the DAP4 dispatcher.
  5. Re-factored and isolated the code that computes if a type is (transitively) variable-sized or not.
  6. Clean up the reclamation code in ncgen; adding the use of nc_reclaim exposed some memory problems.

re: Issue Unidata#2685
re: PR Unidata#2179

As noted in PR Unidata#2179,
the old code did not allow for reclaiming instances of types,
nor for properly copying them. That PR provided new functions
capable of reclaiming/copying instances of arbitrary types.

However, as noted by Issue Unidata#2685, using these
most general functions resulted in a significant performance
degradation, even for common cases.

This PR attempts to mitigate the cost of using the general
reclaim/copy functions in two ways.

First, the previous functions operating at the top level by
using ncid and typeid arguments. These functions were augmented
with equivalent versions that used the netcdf-c library internal
data structures to allow direct access to needed information.
These new functions are used internally to the library.

The second mitigation involves optimizing the internal functions
by providing early tests for common cases. This avoids
unnecessary recursive function calls.

The overall result is a significant improvement in speed by a
factor of roughly twenty -- your mileage may vary. These
optimized functions are still not as fast as the original (more
limited) functions, but they are getting close. Additional optimizations are
possible. But the cost is a significant "uglification" of the
code that I deemed a step too far, at least for now.

## Misc. Changes
1. Added a test case to check the proper reclamation/copy of complex types.
2. Found and fixed some places where nc_reclaim/copy should have been used.
3. Replaced, in the netcdf-c library, (almost all) occurrences of nc_reclaim_copy with calls to NC_reclaim/copy. This plus the optimizations is the primary speed-up mechanism.
4. In DAP4, the metadata is held in a substrate in-memory file; this required some changes so that the reclaim/copy code accessed that substrate dispatcher rather than the DAP4 dispatcher.
5. Re-factored and isolated the code that computes if a type is (transitively) variable-sized or not.
6. Clean up the reclamation code in ncgen; adding the use of nc_reclaim exposed some memory problems.
@WardF WardF self-assigned this Jun 6, 2023
@WardF WardF added this to the 4.9.3 milestone Jun 6, 2023
@WardF
Copy link
Member

WardF commented Jun 6, 2023

Fixed a small conflict, will merge as soon as the tests run. Might be a few, GitHub actions are currently running for another PR as well. Trying to get all caught up.

@WardF WardF merged commit 032ab7c into Unidata:main Jun 7, 2023
@DennisHeimbigner DennisHeimbigner deleted the vlenperf.dmh branch June 10, 2023 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants