The HDF Group
- HDF Software Priority Support
- HDF Consulting
- Downloads
- Documentation
- Community Forum
- Help Desk
- Licenses
Got HDF5?
Curious to see what’s inside? Try this
Software Changes from Release to Release in HDF5 1.14
API Compatibility
See API Compatibility Macros in HDF5 for details on using HDF5 version 1.14 with previous releases.
- Compatibility report for Release 1.14.4 versus Release 1.14.3
- Compatibility report for Release 1.14.3 versus Release 1.14.2
- Compatibility report for Release 1.14.2 versus Release 1.14.1
- Compatibility report for Release 1.14.1 versus Release 1.14.0
- Compatibility report for Release 1.14.0 versus Release 1.12.2
This page provides information on the changes that a maintenance developer needs to be aware of between successive releases of HDF5, such as:
New or changed features or tools Syntax and behavioral changes in the existing application programming interface (the API) Certain types of changes in configuration or build processes Note that bug fixes and performance enhancements in the C library are automatically picked up by the C++, Fortran, and Java libraries.
The following information is included below.
- Release 1.14.4 versus Release 1.14.3
- Release 1.14.3 versus Release 1.14.2
- Release 1.14.2 versus Release 1.14.1
- Release 1.14.1 versus Release 1.14.0
- Release 1.14.1 versus Release 1.12.2
The release notes also list changes made to the library, but these notes tend to be more at a more detail-oriented level. The release notes may include new features, bugs fixed, supported configuration features, platforms on which the library has been tested, and known problems. The release note files are listed in each release section and can be found at the top level of the HDF5 source code tree in the release_docs directory.
Release 1.14.4 versus Release 1.14.3
New and Changed Functions, Classes, Subroutines, Wrappers, and Macros
Following are the new APIs/macros introduced in HDF5-1.14.4.
In the C Interface (main library)
| Function | Description |
|---|---|
| H5Pget_relax_file_integrity_checks() | Retrieves relaxed file integrity check flags |
| H5Pset_relax_file_integrity_checks() | Relaxes certain file integrity checks |
| Macro | Description |
|---|---|
| H5T_IEEE_F16BE | 16-bit big-endian IEEE floating-point numbers |
| H5T_IEEE_F16LE | 16-bit little-endian IEEE floating-point numbers |
| H5T_NATIVE_FLOAT16 | C-style _Float16 |
Release 1.14.3 versus Release 1.14.2
This section lists interface-level changes and other user-visible changes in behavior in the transition from HDF5 Release 1.14.2 to Release 1.14.3.
New and Changed Functions, Classes, Subroutines, Wrappers, and Macros
Following are the new APIs introduced in HDF5-1.14.3.
In the C Interface (main library)
| Function | Description |
|---|---|
| H5Pget_actual_selection_io_mode() | Retrieves the type(s) of I/O performed on raw data |
In the Fortran Interface
| Function | Description |
|---|---|
| h5get_free_list_sizes_f | Gets the current size of the free lists used to manage memory |
| h5dwrite_chunk_f | Writes a raw data chunk from a buffer directly to a dataset in a file |
| h5dread_chunk_f | Reads a raw data chunk directly from a dataset in a file into a buffer |
| h5fget_info_f | Retrieves global file information |
| h5lvisit_f | Recursively visits all links starting from a specified group |
| h5lvisit_by_name_f | Recursively visits all links starting from a specified group |
| h5pget_no_selection_io_cause_f | Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call |
| h5pget_mpio_no_collective_cause_f | Retrieves local and global causes that broke collective I/O on the last parallel I/O call |
| h5sselect_shape_same_f | Checks if two selections are the same shape |
| h5sselect_intersect_block_f | Checks if current selection intersects with a block |
| h5pget_file_space_page_size_f | Gets the file space page size for a file creation property list |
| h5pset_file_space_page_size_f | Sets the file space page size for a file creation property list |
| h5pget_file_space_strategy_f | Gets the file space handling strategy and persisting free-space values for a file creation property list |
| h5pset_file_space_strategy_f | Sets the file space handling strategy and persisting free-space values for a file creation property list |
In addition, there are other new Fortran functions including the Fortran async APIs and the Fortran VOL capability definitions.
Release 1.14.2 versus Release 1.14.1
This section lists interface-level changes and other user-visible changes in behavior in the transition from HDF5 Release 1.14.1 to Release 1.14.2.
New and Changed Functions, Classes, Subroutines, Wrappers, and Macros
Following are the new APIs introduced in HDF5-1.14.2.
In the C Interface (main library)
| Function | Description |
|---|---|
| H5FDread_from_selection | Performs a series of scalar reads. |
| H5FDread_vector_from_selection | Performs a vector read if vector reads are supported, or a series of scalar reads, otherwise. |
| H5FDwrite_from_selection | Performs a series of scalar writes. |
| H5FDwrite_vector_from_selection | Performs a vector write if vector writes are supported, or a series of scalar writes, otherwise. |
| H5Pget_fapl_ros3_token | Returns session/security token of the ros3 file access property list |
| H5Pset_fapl_ros3_token | Modifies the file access property list to use the H5FD_ROS3 driver |
Release 1.14.1 versus Release 1.14.0
This section lists interface-level changes and other user-visible changes in behavior in the transition from HDF5 Release 1.14.0 to Release 1.14.1.
New and Changed Functions, Classes, Subroutines, Wrappers, and Macros
Following are the new APIs introduced in HDF5-1.14.1.
In the C Interface (main library)
| Function | Description |
|---|---|
| H5PGET_MODIFY_WRITE_BUF | Retrieves the “modify write buffer” property |
| H5PGET_NO_SELECTION_IO_CAUSE | Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call |
| H5PGET_SELECTION_IO | Retrieves the selection I/O mode |
| H5PSET_MODIFY_WRITE_BUF | Allows the library to modify the contents of the write buffer |
| H5PSET_SELECTION_IO | Sets the selection I/O mode |
In the Fortran Interface
| Function | Description |
|---|---|
| h5pget_modify_write_buf_f | Retrieves the “modify write buffer” property |
| h5pget_selection_io_f | Retrieves the selection I/O mode |
| h5pset_modify_write_buf_f | Allows the library to modify the contents of the write buffer |
| h5pset_selection_io_f | Sets the selection I/O mode |
Release 1.14.0 versus Release 1.12.2
HDF5 version 1.14.0 introduces the following new features:
- Asynchronous I/O operations
- New tools h5dwalk and h5delete
- Subfiling VFD
- Onion VFD
- Multi Dataset I/O
Users might find these names familiar already and that is because they were introduced in the experimental series 1.13.
In addition, this version provides many new C APIs and other user-visible changes in behavior in the transition from HDF5 Release 1.12.2 to Release 1.14.0. HDF5 1.14.0 adds no new API calls that require use of the API Compatibility Macros for the main library. Some calls have been removed or have had their signature change, however.
New and Changed Functions, Classes, Subroutines, Wrappers, and Macros In the C Interface (main library)
Following are the new APIs introduced in HDF5-1.14.0.
| Function | Fortran | Description |
|---|---|---|
| H5A_CLOSE_ASYNC | N | Asynchronous version of H5Aclose |
| H5A_CREATE_ASYNC | N | Asynchronous version of H5Acreate |
| H5A_CREATE_BY_NAME_ASYNC | N | Asynchronous version of H5Acreate_by_name |
| H5A_EXISTS_ASYNC | N | Asynchronous version of H5Aexists |
| H5A_EXISTS_BY_NAME_ASYNC | N | Asynchronous version of H5Aexists_by_name |
| H5A_OPEN_ASYNC | N | Asynchronous version of H5Aopen |
| H5A_OPEN_BY_IDX_ASYNC | N | Asynchronous version of H5Aopen_by_idx |
| H5A_OPEN_BY_NAME_ASYNC | N | Asynchronous version of H5Aopen_by_name |
| H5A_READ_ASYNC | N | Asynchronous version of H5Aread |
| H5A_RENAME_ASYNC | N | Asynchronous version of H5Arename |
| H5A_RENAME_BY_NAME_ASYNC | N | Asynchronous version of H5Arename_by_name |
| H5A_WRITE_ASYNC | N | Asynchronous version of H5Awrite |
| H5D_CHUNK_ITER | N | Iterate over all chunks of a chunked dataset |
| H5D_CLOSE_ASYNC | N | Asynchronous version of H5Dclose |
| H5D_CREATE_ASYNC | N | Asynchronous version of H5Dcreate |
| H5D_GET_SPACE_ASYNC | N | Asynchronous version of H5Dget_space |
| H5D_OPEN_ASYNC | N | Asynchronous version of H5Dopen |
| H5D_READ_ASYNC | N | Asynchronous version of H5Dread |
| H5D_READ_MULTI | N | Reads raw data from a set of datasets into the provided buffers |
| H5D_READ_MULTI_ASYNC | N | Asynchronous version of H5Dread_multi |
| H5D_SET_EXTENT_ASYNC | N | Asynchronous version of H5Dset_extent |
| H5D_WRITE_ASYNC | N | Asynchronous version of H5Dwrite |
| H5D_WRITE_MULTI | N | Writes raw data from a set buffers to a set of datasets |
| H5D_WRITE_MULTI_ASYNC | N | Asynchronous version of H5Dwrite_multi |
| H5E_APPEND_STACK | N | Appends one error stack to another, optionally closing the source stack |
| H5ES_CANCEL | N | Attempt to cancel operations in an event set |
| H5ES_CLOSE | N | Terminates access to an event set |
| H5ES_CREATE | N | Creates an event set |
| H5ES_FREE_ERR_INFO | N | Convenience routine to free an array of H5ES_err_info_t structs |
| H5ES_GET_COUNT | N | Retrieves number of events in an event set |
| H5ES_GET_ERR_COUNT | N | Retrieves the number of failed operations |
| H5ES_GET_ERR_INFO | N | Retrieves information about failed operations |
| H5ES_GET_ERR_STATUS | N | Checks for failed operations |
| H5ES_GET_OP_COUNTER | N | Retrieves the accumulative operation counter for an event set |
| H5ES_REGISTER_COMPLETE_FUNC | N | Registers a callback to invoke when an operation completes within an event set |
| H5ES_REGISTER_INSERT_FUNC | N | Registers a callback to invoke when a new operation is inserted into |
| H5ES_WAIT | N | Waits for operations in event set to complete |
| H5FD_ONION_GET_REVISION_COUNT | N | Gets the number of revisions |
| H5P_GET_FAPL_ONION | N | Gets the onion info from the file access property list |
| H5P_SET_FAPL_ONION | N | Sets the onion info for the file access property list |
| H5F_CLOSE_ASYNC | N | Asynchronous version of H5Fclose |
| H5F_CREATE_ASYNC | N | Asynchronous version of H5Fcreate |
| H5F_FLUSH_ASYNC | N | Asynchronous version of H5Fflush |
| H5F_OPEN_ASYNC | N | Asynchronous version of H5Fopen |
| H5F_REOPEN_ASYNC | N | Asynchronous version of H5Freopen |
| H5G_CLOSE_ASYNC | N | Asynchronous version of H5Gclose |
| H5G_CREATE_ASYNC | N | Asynchronous version of H5Gcreate |
| H5G_GET_INFO_ASYNC | N | Asynchronous version of H5Gget_info |
| H5G_GET_INFO_BY_IDX_ASYNC | N | Asynchronous version of H5Gget_info_by_idx |
| H5G_GET_INFO_BY_NAME_ASYNC | N | Asynchronous version of H5Gget_info_by_name |
| H5G_OPEN_ASYNC | N | Asynchronous version of H5Gopen |
| H5I_REGISTER_FUTURE | N | Registers a “future” object under a type and returns an ID for it |
| H5L_CREATE_HARD_ASYNC | N | Asynchronous version of H5Lcreate_hard |
| H5L_CREATE_SOFT_ASYNC | N | Asynchronous version of H5Lcreate_soft |
| H5L_DELETE_ASYNC | N | Asynchronous version of H5Ldelete |
| H5L_DELETE_BY_IDX_ASYNC | N | Asynchronous version of H5Ldelete_by_idx |
| H5L_EXISTS_ASYNC | N | Asynchronous version of H5Lexists |
| H5L_ITERATE_ASYNC | N | Asynchronous version of H5Literate |
| H5O_CLOSE_ASYNC | N | Asynchronous version of H5Oclose |
| H5O_COPY_ASYNC | N | Asynchronous version of H5Ocopy |
| H5O_FLUSH_ASYNC | N | Asynchronous version of H5Oflush |
| H5O_GET_INFO_BY_NAME_ASYNC | N | Asynchronous version of H5Oget_info_by_name |
| H5O_OPEN_ASYNC | N | Asynchronous version of H5Oopen |
| H5O_OPEN_BY_IDX_ASYNC | N | Asynchronous version of H5Oopen_by_idx |
| H5O_REFRESH_ASYNC | N | Asynchronous version of H5Orefresh |
| H5P_GET_DRIVER_CONFIG_STR | N | Retrieves a string representation of the configuration for the driver set on the given FAPL |
| H5P_GET_VOL_CAP_FLAGS | N | Query the capability flags for the VOL connector that will be used with this file access property list (FAPL) |
| H5P_SET_DATASET_IO_HYPERSLAB_SELECTION | N | Sets a hyperslab file selection for a dataset I/O operation |
| H5P_SET_DRIVER_BY_NAME | N | Sets a file driver according to a given driver name |
| H5P_SET_DRIVER_BY_VALUE | N | Sets a file driver according to a given driver value (ID) |
| H5_ATCLOSE | N | Registers a callback for the library to invoke when it’s closing |
| H5_IS_LIBRARY_TERMINATING | N | Checks whether the HDF5 library is closing |
| H5R_OPEN_ATTR_ASYNC | N | Asynchronous version of H5Ropen_attr |
| H5R_OPEN_OBJECT_ASYNC | N | Asynchronous version of H5Ropen_object |
| H5R_OPEN_REGION_ASYNC | N | Asynchronous version of H5Ropen_region |
| H5T_CLOSE_ASYNC | N | Asynchronous version of H5Tclose |
| H5T_COMMIT_ASYNC | N | Asynchronous version of H5Tcommit2 |
| H5T_OPEN_ASYNC | N | Asynchronous version of H5Topen2 |