Software Changes from Release to Release in HDF5 1.14

API Compatibility

See API Compatibility Macros for details on using HDF5 version 1.14 with previous releases.

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.

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.6 versus Release 1.14.5

New and Changed Functions, Classes, Subroutines, Wrappers, and Macros

Release 1.14.5 versus Release 1.14.4

New and Changed Functions, Classes, Subroutines, Wrappers, and Macros

Following are the new APIs/macros introduced in HDF5-1.14.5.

In the C Interface (main library)

H5Eis_paused - Check if pushing errors on an error stack is paused
H5Epause_stack - Pause pushing errors on an error stack
H5Eresume_stack - Resume pushing errors on an error stack

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)

H5Pget_relax_file_integrity_checks - Retrieves relaxed file integrity check flags
H5Pset_relax_file_integrity_checks - Relaxes certain file integrity checks

Macro

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)

H5Pget_actual_selection_io_mode - Retrieves the type(s) of I/O performed on raw data

In the Fortran Interface

h5lib.h5get_free_list_sizes_f - Gets the current size of the free lists used to manage memory
h5d.h5dwrite_chunk_f - Writes a raw data chunk from a buffer directly to a dataset in a file
h5d.h5dread_chunk_f - Reads a raw data chunk directly from a dataset in a file into a buffer
h5f.h5fget_info_f - Retrieves global file information
h5l.h5lvisit_f - Recursively visits all links starting from a specified group
h5l.h5lvisit_by_name_f - Recursively visits all links starting from a specified group
h5p.h5pget_no_selection_io_cause_f - Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call
h5p.h5pget_mpio_no_collective_cause_f - Retrieves local and global causes that broke collective I/O on the last parallel I/O call
h5s.h5sselect_shape_same_f - Checks if two selections are the same shape
h5s.h5sselect_intersect_block_f - Checks if current selection intersects with a block
h5p.h5pget_file_space_page_size_f - Gets the file space page size for a file creation property list
h5p.h5pset_file_space_page_size_f - Sets the file space page size for a file creation property list
h5p.h5pget_file_space_strategy_f - Gets the file space handling strategy and persisting free-space values for a file creation property list
h5p.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)

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)

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

h5p.h5pget_modify_write_buf_f - Retrieves the "modify write buffer" property
h5p.h5pget_selection_io_f - Retrieves the selection I/O mode
h5p.h5pset_modify_write_buf_f - Allows the library to modify the contents of the write buffer
h5p.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.

H5Aclose_async - Asynchronous version of H5Aclose
H5Acreate_async - Asynchronous version of H5Acreate
H5Acreate_by_name_async - Asynchronous version of H5Acreate_by_name
H5Aexists_async - Asynchronous version of H5Aexists
H5Aexists_by_name_async - Asynchronous version of H5Aexists_by_name
H5Aopen_async - Asynchronous version of H5Aopen
H5Aopen_by_idx_async - Asynchronous version of H5Aopen_by_idx
H5Aopen_by_name_async - Asynchronous version of H5Aopen_by_name
H5Aread_async - Asynchronous version of H5Aread
H5Arename_async - Asynchronous version of H5Arename
H5Arename_by_name_async - Asynchronous version of H5Arename_by_name
H5Awrite_async - Asynchronous version of H5Awrite
H5Dchunk_iter - Iterate over all chunks of a chunked dataset
H5Dclose_async - Asynchronous version of H5Dclose
H5Dcreate_async - Asynchronous version of H5Dcreate
H5Dget_space_async - Asynchronous version of H5Dget_space
H5Dopen_async - Asynchronous version of H5Dopen
H5Dread_async - Asynchronous version of H5Dread
H5Dread_multi - Reads raw data from a set of datasets into the provided buffers
H5Dread_multi_async - Asynchronous version of H5Dread_multi
H5Dset_extent_async - Asynchronous version of H5Dset_extent
H5Dwrite_async - Asynchronous version of H5Dwrite
H5Dwrite_multi - Writes raw data from a set buffers to a set of datasets
H5Dwrite_multi_async - Asynchronous version of H5Dwrite_multi
H5Eappend_stack - Appends one error stack to another, optionally closing the source stack
H5EScancel - Attempt to cancel operations in an event set
H5ESclose - Terminates access to an event set
H5EScreate - Creates an event set
H5ESfree_err_info - Convenience routine to free an array of H5ES_err_info_t structs
H5ESget_count - Retrieves number of events in an event set
H5ESget_err_count - Retrieves the number of failed operations
H5ESget_err_info - Retrieves information about failed operations
H5ESget_err_status] - Checks for failed operations
H5ESget_op_counter - Retrieves the accumulative operation counter for an event set
H5ESregister_complete_func - Registers a callback to invoke when an operation completes within an event set
H5ESregister_insert_func - Registers a callback to invoke when a new operation is inserted into
H5ESwait - Waits for operations in event set to complete
H5FDonion_get_revision_count - Gets the number of revisions
H5Pget_fapl_onion - Gets the onion info from the file access property list
H5Pset_fapl_onion - Sets the onion info for the file access property list
H5Fclose_async - Asynchronous version of H5Fclose
H5Fcreate_async - Asynchronous version of H5Fcreate
H5Fflush_async - Asynchronous version of H5Fflush
H5Fopen_async - Asynchronous version of H5Fopen
H5Freopen_async - Asynchronous version of H5Freopen
H5Gclose_async - Asynchronous version of H5Gclose
H5Gcreate_async - Asynchronous version of H5Gcreate
H5Gget_info_async - Asynchronous version of H5Gget_info
H5Gget_info_by_idx_async - Asynchronous version of H5Gget_info_by_idx
H5Gget_info_by_name_async - Asynchronous version of H5Gget_info_by_name
H5Gopen_async - Asynchronous version of H5Gopen
H5Iregister_future - Registers a "future" object under a type and returns an ID for it
H5Lcreate_hard_async - Asynchronous version of H5Lcreate_hard
H5Lcreate_soft_async - Asynchronous version of H5Lcreate_soft
H5Ldelete_async - Asynchronous version of H5Ldelete
H5Ldelete_by_idx_async - Asynchronous version of H5Ldelete_by_idx
H5Lexists_async - Asynchronous version of H5Lexists
H5Literate_async - Asynchronous version of H5Literate
H5Oclose_async - Asynchronous version of H5Oclose
H5Ocopy_async - Asynchronous version of H5Ocopy
H5Oflush_async - Asynchronous version of H5Oflush
H5Oget_info_by_name_async - Asynchronous version of H5Oget_info_by_name
H5Oopen_async - Asynchronous version of H5Oopen
H5Oopen_by_idx_async - Asynchronous version of H5Oopen_by_idx
H5Orefresh_async - Asynchronous version of H5Orefresh
H5Pget_driver_config_str - Retrieves a string representation of the configuration for the driver set on the given FAPL
H5Pget_vol_cap_flags - Query the capability flags for the VOL connector that will be used with this file access property list (FAPL)
H5Pset_dataset_io_hyperslab_selection - Sets a hyperslab file selection for a dataset I/O operation
H5Pset_driver_by_name - Sets a file driver according to a given driver name
H5Pset_driver_by_value - Sets a file driver according to a given driver value (ID)
H5atclose - Registers a callback for the library to invoke when it's closing
H5is_library_terminating - Checks whether the HDF5 library is closing
H5Ropen_attr_async - Asynchronous version of H5Ropen_attr
H5Ropen_object_async - Asynchronous version of H5Ropen_object
H5Ropen_region_async - Asynchronous version of H5Ropen_region
H5Tclose_async - Asynchronous version of H5Tclose
H5Tcommit_async - Asynchronous version of H5Tcommit2
H5Topen_async - Asynchronous version of H5Topen2