diff options
author | Gaute Hope <eg@gaute.vetsj.com> | 2021-05-19 22:21:52 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-05-19 22:21:52 (GMT) |
commit | 509a068f628826b8d1d09b7ab267400f4cec0852 (patch) | |
tree | 3e780797310237f158ba542bf0430b27cdc829c5 /src/H5Dpublic.h | |
parent | d179f9d79ca9ed3f94715b907e3d8426a26ee766 (diff) | |
download | hdf5-509a068f628826b8d1d09b7ab267400f4cec0852.zip hdf5-509a068f628826b8d1d09b7ab267400f4cec0852.tar.gz hdf5-509a068f628826b8d1d09b7ab267400f4cec0852.tar.bz2 |
Add H5Dchunk_iter method for iterating over chunks (#6)
* Add H5Dchunk_iter method for iterating over chunks
This method iterates over all chunks in dataset, calling a user-supplied
callback with the chunk information and optional user supplied data.
The iterator is stopped when ITER_STOP is returned by the user-supplied
callback or the iterator is exhausted.
Existing methods to get chunk_info performs an iteration each time, so
to get many or all chunks causes SUM(i) for i = 0 -> N operations for N
chunks, as opposed to N operations when using this iterator for this use case.
* H5Dchunk_iter: test iterating all chunks, some chunks and failing iteration.
* H5D: move H5Dchunk_iter private methods to specific
* trace: add H5D_chunk_iter_op_t and trace H5D.c
* chunks-iter: document chunk_iter
* chunk-iter: chunk add FUNC_ENTER/FUNC_LEAVE macros
* Committing clang-format changes
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Diffstat (limited to 'src/H5Dpublic.h')
-rw-r--r-- | src/H5Dpublic.h | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/src/H5Dpublic.h b/src/H5Dpublic.h index e48b727..0b5fac6 100644 --- a/src/H5Dpublic.h +++ b/src/H5Dpublic.h @@ -160,6 +160,14 @@ typedef herr_t (*H5D_scatter_func_t)(const void **src_buf /*out*/, size_t *src_b typedef herr_t (*H5D_gather_func_t)(const void *dst_buf, size_t dst_buf_bytes_used, void *op_data); //! <!-- [H5D_gather_func_t_snip] --> +//! <!-- [H5D_chunk_iter_op_t_snip] --> +/** + * Define the operator function pointer for H5Dchunk_iter() + */ +//! <!-- [H5D_chunk_iter_op_t_snip] --> +typedef int (*H5D_chunk_iter_op_t)(const hsize_t *offset, uint32_t filter_mask, haddr_t addr, uint32_t nbytes, + void *op_data); + /********************/ /* Public Variables */ /********************/ @@ -630,6 +638,51 @@ H5_DLL herr_t H5Dget_chunk_info_by_coord(hid_t dset_id, const hsize_t *offset, u * -------------------------------------------------------------------------- * \ingroup H5D * + * \brief Iterate over all chunks + * + * \dset_id + * \param[in] cb User callback function, called for every chunk. + * \param[in] op_data User-defined pointer to data required by op + * + * \return \herr_t + * + * \details H5Dget_chunk_iter iterates over all chunks in the dataset, calling the + * user supplied callback with the details of the chunk and the supplied + * \p op_data. + * + * Callback information: + * H5D_chunk_iter_op_t is defined as: + * + * typedef int (*H5D_chunk_iter_op_t)( + * const hsize_t *offset, + * uint32_t filter_mask, + * haddr_t addr, + * uint32_t nbytes, + * void *op_data); + * + * H5D_chunk_iter_op_t parameters: + * hsize_t *offset; IN/OUT: Array of starting logical coordinates of chunk. + * uint32_t filter_mask; IN: Filter mask of chunk. + * haddr_t addr; IN: Offset in file of chunk data. + * uint32_t nbytes; IN: Size in number of bytes of chunk data in file. + * void *op_data; IN/OUT: Pointer to any user-defined data + * associated with the operation. + * + * The return values from an operator are: + * Zero (H5_ITER_CONT) causes the iterator to continue, returning zero when all + * elements have been processed. + * Positive (H5_ITER_STOP) causes the iterator to immediately return that positive + * value, indicating short-circuit success. + * Negative (H5_ITER_ERROR) causes the iterator to immediately return that value, + * indicating failure. + * + */ +H5_DLL herr_t H5Dchunk_iter(hid_t dset_id, H5D_chunk_iter_op_t cb, void *op_data); + +/** + * -------------------------------------------------------------------------- + * \ingroup H5D + * * \brief Retrieves information about a chunk specified by its index * * \dset_id |