From 507d7cec8ab623e906c27d93fb0adaec7a6dccbf Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Mon, 22 Sep 2025 15:56:51 -0500 Subject: [PATCH] Added exec summary to changelog, misc other small fixes/corrections. (#5845) * Pull Release/snapshot description from Executive Summary of CHANGELOG.md. * Change bullets to h3 headings (###) --- .github/workflows/release-files.yml | 10 +- release_docs/CHANGELOG.md | 218 ++++++++++++++++------------ 2 files changed, 125 insertions(+), 103 deletions(-) diff --git a/.github/workflows/release-files.yml b/.github/workflows/release-files.yml index 8b6fac1ecc0..526c799ea82 100644 --- a/.github/workflows/release-files.yml +++ b/.github/workflows/release-files.yml @@ -208,15 +208,9 @@ jobs: run: | echo "${{ steps.get-file-base.outputs.FILE_BASE }}" > ./last-file.txt - - name: Get NEWSLETTER - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 - with: - name: NEWSLETTER - path: ${{ github.workspace }} - - - name: Create description file + - name: Create description for release/snapshot from "Executive Summary" section of CHANGELOG.md run: | - cat ${{ github.workspace }}/NEWSLETTER.txt > description.txt + sed -n '/^# .* Executive Summary: HDF5 Version .*/,/^# .* Breaking Changes/p' CHANGELOG.md | sed '$d' > description.txt - name: PreRelease tag id: create_prerelease diff --git a/release_docs/CHANGELOG.md b/release_docs/CHANGELOG.md index 2289bcca58e..877f614b7d1 100644 --- a/release_docs/CHANGELOG.md +++ b/release_docs/CHANGELOG.md @@ -13,38 +13,66 @@ HDF5 release, platforms tested, and known problems in this release. * [Getting help, questions, or comments](https://github.com/HDFGroup/hdf5#help-and-support) ## 📖 Contents +* [Executive Summary](CHANGELOG.md#-executive-summary-hdf5-version-200) * [Breaking Changes](CHANGELOG.md#%EF%B8%8F-breaking-changes) * [New Features & Improvements](CHANGELOG.md#-new-features--improvements) -* [Bug Fixes](#--bug-fixes) +* [Bug Fixes](#-bug-fixes) * [Support for new platforms and languages](#-support-for-new-platforms-and-languages) * [Platforms Tested](#%EF%B8%8F-platforms-tested) * [Known Problems](#-known-problems) - + +# 🔆 Executive Summary: HDF5 Version 2.0.0 + +## Performance Enhancements: + +- 30% faster opening and 25% faster closing of virtual datasets. +- Reduced memory overhead via shared name strings and optimized spatial search algorithms for virtual datasets. + +## Significant Advancements: + +- Full [UTF-8](https://github.com/HDFGroup/hdf5/blob/develop/release_docs/CHANGELOG.md#utf8) filename support on Windows, resolving encoding issues from previous versions. +- Introduction of bfloat16 predefined datatypes for efficient machine learning conversions. +- First-class support for [complex numbers](https://github.com/HDFGroup/hdf5/blob/develop/release_docs/CHANGELOG.md#complex), eliminating manual workarounds in scientific applications. + +## Updated Foundation: + +- New [file format](https://github.com/HDFGroup/hdf5/blob/develop/release_docs/CHANGELOG.md#fileformat) version (4.0) and compliance with the C11 standard. + +> [!IMPORTANT] +> +> - Transitioned to [CMake-only](https://github.com/HDFGroup/hdf5/blob/develop/release_docs/CHANGELOG.md#cmake) builds, and Autotools is no longer in use. +> - Renamed library state variables, notably `HDF5_ENABLE_PARALLEL` is now `HDF5_PROVIDES_PARALLEL`, see PR [#5716](https://github.com/HDFGroup/hdf5/pull/5716) for more details. +> - The default setting for `H5Fset_libver_bounds` has been updated to set the lower bound to the HDF5 library version 1.8. This change ensures that users can take advantage of the library's optimal performance and the latest features by default. If users need their files to be compatible with older versions of the HDF5 library, they will need to adjust this lower bound manually. + +## Enhanced Features: + +- Improved [ROS3 VFD](https://github.com/HDFGroup/hdf5/blob/develop/release_docs/CHANGELOG.md#ros3) capabilities using the aws-c-s3 library. + # ⚠️ Breaking Changes -- **Renamed the option: HDF5_ENABLE_Z_LIB_SUPPORT** +### Renamed the option: `HDF5_ENABLE_Z_LIB_SUPPORT` - The option has been renamed to HDF5_ENABLE_ZLIB_SUPPORT to be consistent with the naming of other options. **Also, the option defaults to OFF. This requires the user to explicitly enable zlib support when configuring the library.** + The option has been renamed to `HDF5_ENABLE_ZLIB_SUPPORT` to be consistent with the naming of other options. **Also, the option defaults to OFF. This requires the user to explicitly enable zlib support when configuring the library.** -- Autotools support was removed from HDF5 +### Autotools support was removed from HDF5 - CMake is now the build system available in HDF5 code. Version 3.26 or later is required. See the AutotoolsToCMakeOptions.md file for highlights of the CMake HDF5 install layout and CMake options to use in place of former Autotools options. + CMake is now the build system available in HDF5 code. Version 3.26 or later is required. See the AutotoolsToCMakeOptions.md file for highlights of the CMake HDF5 install layout and CMake options to use in place of former Autotools options. # 🚀 New Features & Improvements ## Configuration -- Refactored `HDF5_BUILD/ENABLE_{feature}` variable in hdf5-config.cmake file +### Refactored `HDF5_BUILD/ENABLE_{feature}` variable in hdf5-config.cmake file The variables used in hdf5-config.cmake to indicate what options were used to build the installed library have been renamed. All `HDF5_BUILD/ENABLE_{feature}` variables are now `HDF5_PROVIDES_{feature}`. This more clearly indicates that these variables reflect whether the feature is supported by the installed library, instead of whether the feature is an option that can be changed when building an application with the library. Created MACRO `EXTERNAL_HDF5_STATUS` to convert between the old and new names. The macro is in the config/examples/HDF5SubdirMacros.cmake file and can be copied into a project's CMakeLists.txt file to provide backward compatibility. -- CMake minimum version is now 3.26 +### CMake minimum version is now 3.26 The minimum version of CMake is now 3.26; this will remove workarounds to handle versions between 3.18 (the previous minimum) and 3.26. -- Removed `HDF5_ENABLE_THREADS` option +### Removed `HDF5_ENABLE_THREADS` option The `HDF5_ENABLE_THREADS` option has been removed, as it no longer functions as a proper build option. The library will always check for thread support and set the internal status variable, `HDF5_THREADS_ENABLED`. The `HDF5_ENABLE_THREADSAFE` option is still available to build with thread-safe API calls. @@ -57,7 +85,7 @@ HDF5 release, platforms tested, and known problems in this release. - The files in the config/flags folder are for compiler support. - The remaining folders remain unchanged. -- Added CMake configuration options to override compilers in h5cc: +### Added CMake configuration options to override compilers in h5cc: | | | | --- | --- | @@ -67,15 +95,15 @@ HDF5 release, platforms tested, and known problems in this release. These default to the currently used compiler, preserving the current behavior. However, they can be overridden by users who need to use a different compiler at runtime, for example, when they build via cache. -- Added `CMAKE_INSTALL_PREFIX` to the default plugin path +### Added `CMAKE_INSTALL_PREFIX` to the default plugin path To help users find their plugins, the default plugin path has been changed to include the `CMAKE_INSTALL_PREFIX`. Adding the install prefix allows users to skip setting the `HDF5_PLUGIN_PATH` environment variable when using plugins with the default lib/plugin location. -- Removed support for the autotools build system. +### Removed support for the autotools build system. -- Converted documentation in the source folder, doc, to doxygen files. +### Converted documentation in the source folder, doc, to doxygen files. -- Added configuration option for API concurrency support: +### Added configuration option for API concurrency support: CMake: `HDF5_ENABLE_CONCURRENCY` (ON/OFF) (Default: OFF) @@ -84,7 +112,7 @@ HDF5 release, platforms tested, and known problems in this release. The following API routines support concurrent multithreaded operation: -- Added support for MinGW + MSYS2 when building with CMake +### Added support for MinGW + MSYS2 when building with CMake We added support for this to the appropriate configure-time checks in CMake. CMake + MinGW + MSYS2 is now tested with the following environments: - mingw32 @@ -92,21 +120,21 @@ HDF5 release, platforms tested, and known problems in this release. - ucrt64 - clang64 -- Added CMake build mode flags to the libhdf5.settings file +### Added CMake build mode flags to the libhdf5.settings file Flags from the CMake build mode (e.g., optimization) are not a part of `CMAKE__FLAGS` and were not exported to the libhdf5.settings file. This has been fixed, and the C, Fortran, and C++ build mode flags are now exported to the file. This also affects the text output of `H5check_version()` and the libhdf5.settings string stored in the library (for those who use strings(1), etc. to get build info from the binary). -- CMake: Split compiler-specific flags into separate files +### CMake: Split compiler-specific flags into separate files The compiler-specific flags have been split into separate files to make it easier to maintain and add new compiler flags. The flags for NVHPC, Intel, GNU and Clang compilers are now in separate files included from the current compiler flags files; `HDFCompilerFlags.cmake`. -- Added support for native zlib-ng compression +### Added support for native zlib-ng compression Changed the zlib-ng CMake logic to prefer the native zlib-ng library. Added #ifdef around the compression function calls. Added including the correct header file with the same #ifdef. -- Renamed remaining HDF5 library CMake options except for CMake BUILD* variables +### Renamed remaining HDF5 library CMake options except for CMake BUILD* variables | | | | | --- | --- | --- | @@ -118,11 +146,11 @@ HDF5 release, platforms tested, and known problems in this release. All other HDF5 library CMake options are prefixed with `HDF5_` -- bin/cmakehdf5 has been removed +### bin/cmakehdf5 has been removed This was an unsupported build script that made building HDF5 via CMake work like building HDF5 via the Autotools. It has been unmaintained for a long time, has been marked deprecated, and is being removed. -- Generated files in src are now checked into version control +### Generated files in src are now checked into version control These files are infrequently updated, and generating them adds a dependency on Perl. The listed files are now checked in and do not need to be recreated when checking out development branches. - H5Edefin.h @@ -134,11 +162,11 @@ HDF5 release, platforms tested, and known problems in this release. - H5overflow.h - H5version.h -- Dropped some old Solaris Studio work-arounds +### Dropped some old Solaris Studio work-arounds Solaris Studio no longer seems to be maintained and the last version (12.4, circa 2015) doesn't seem to fully support C11. We've removed some hacks that work around things like `__attribute__()` support. -- Dropped support for the traditional MSVC preprocessor +### Dropped support for the traditional MSVC preprocessor Visual Studio has [recently started using a standards-compliant preprocessor](https://learn.microsoft.com/en-us/cpp/preprocessor/preprocessor-experimental-overview?view=msvc-170) (In VS2019+) and this is the default in C11. Because of this, we've dropped support for the traditional MSVC preprocessor. @@ -146,7 +174,7 @@ HDF5 release, platforms tested, and known problems in this release. ## Library -- Removed hbool_t from public API calls +### Removed hbool_t from public API calls The hbool_t type was introduced before the library supported C99's Boolean type. Originally typedef'd to an integer, it has been typedef'd to C99's bool for many years. @@ -154,15 +182,15 @@ HDF5 release, platforms tested, and known problems in this release. The hbool_t typedef remains in H5public.h so existing code does not need to be updated. -- H5public.h no longer includes features.h +### H5public.h no longer includes features.h features.h is supposed to be included by glibc headers and not used in application code. It is unnecessary given our use of feature test macros like _POSIX_C_SOURCE and has been removed. -- Improved performance of opening a virtual dataset with many mappings +### Improved performance of opening a virtual dataset with many mappings When opening a virtual dataset, the library would previously decode the mappings in the object header package, then copy them to the dataset struct, then copy them to the internal DCPL. Copying the VDS mappings could be very expensive if there were many mappings. Changed this to delay decoding the mappings until the dataset code, and delay copying the layout to the DCPL until it is needed. This results in only the decoding and no copies in most use cases, as opposed to the decoding and two copies with the previous code. -- Aligned the CMake compiler wrappers with the old Autotools versions +### Aligned the CMake compiler wrappers with the old Autotools versions The versions of `h5cc`, `h5fc`, `h5c++`, etc. generated by CMake were missing several options and features from the Autotools counterparts. Some of these options and features have now been implemented in the CMake versions, while some of them have not: - The missing `--help/-h`, `-c`, `-echo`, and `-shlib/-noshlib` options have been implemented. @@ -174,19 +202,19 @@ HDF5 release, platforms tested, and known problems in this release. Several issues were also fixed in the pkg-config files that are generated by CMake. -- Changed the default page buffer size for the ROS3 driver +### Changed the default page buffer size for the ROS3 driver Calling `H5Pset_fapl_ros3()` now has the side effect of setting the page buffer size in the FAPL to 64MiB if it was not previously set. This will only have an effect if the file uses paged allocation. Also added the `H5F_PAGE_BUFFER_SIZE_DEFAULT` to allow the user to unset the page buffer size in an FAPL so it can be similarly overridden. -- Default dataset chunk cache size increased +### Default dataset chunk cache size increased The default dataset chunk cache size was increased to 8 MiB (8,388,608 bytes). -- The file format has been updated to 4.0 +### The file format has been updated to 4.0 The Virtual Dataset Global Heap Block format has been updated to version 1 to support shared string storage for source filenames and dataset names, reducing file size when multiple mappings reference the same sources. This new format is only used when the HDF5 library version bounds lower bound is set to 2.0 or later. -- The `H5Dread_chunk()` signature has changed +### The `H5Dread_chunk()` signature has changed A new parameter, `nalloc`, has been added to `H5Dread_chunk()`. This parameter contains a pointer to a variable that holds the size of the buffer buf. If *nalloc is not large enough to hold the entire chunk being read, no data is read. On exit, the value of this variable is set to the buffer size needed to read the chunk. @@ -204,7 +232,7 @@ HDF5 release, platforms tested, and known problems in this release. `H5Dread_chunk()` will map to the new signature unless the library is explicitly configured to use an older version of the API. -- Replaced the ROS3 VFD's S3 backend based on libcurl with a new backend based on the [aws-c-s3 library](https://github.com/awslabs/aws-c-s3) +### Replaced the ROS3 VFD's S3 backend based on libcurl with a new backend based on the [aws-c-s3 library](https://github.com/awslabs/aws-c-s3) The ROS3 VFD now requires the aws-c-s3 library in order to be built. This library offers several useful features for the VFD, including the following - Automatic retries of non-fatal failed requests (where the libcurl backend would simply return an error), @@ -242,7 +270,7 @@ HDF5 release, platforms tested, and known problems in this release. Instructions for building the ROS3 VFD with the aws-c-s3 library have been added to release_docs/INSTALL_S3.txt. The ROS3 VFD and information about the usage of the driver are described in the HDF5 user's guide. -- Renamed some API decorations +### Renamed some API decorations Some API decorations (used to hide __declspec on Windows, among other things) have been renamed: @@ -255,7 +283,7 @@ HDF5 release, platforms tested, and known problems in this release. | H5_FCTESTDLL(VAR) | to | H5FC_TEST_DLL(VAR) | | HDF5_HL_F90CSTUBDLL(VAR) | to | H5FC_HL_DLL(VAR) | -- The `H5Iregister_type()` signature has changed +### The `H5Iregister_type()` signature has changed The hash_size parameter has not been used since early versions of HDF5 1.8, so it has been removed, and the API call has been versioned. @@ -269,7 +297,7 @@ HDF5 release, platforms tested, and known problems in this release. `H5Iregister_type()` will map to the new signature unless the library is explicitly configured to use an older version of the API. -- The `H5Tdecode()` signature has changed +### The `H5Tdecode()` signature has changed When provided malformed or too-small buffers, `H5Tdecode()` would crash. The new buffer size parameter allows this to be reliably avoided. @@ -283,16 +311,16 @@ HDF5 release, platforms tested, and known problems in this release. `H5Tdecode()` will map to the new signature unless the library is explicitly configured to use an older version of the API. -- `H5F_LIBVER_LATEST` is now an enum value +### `H5F_LIBVER_LATEST` is now an enum value This was previously #defined to the latest `H5F_libver_t API` version, but is now an enum value with an integer value equal to the latest `H5F_libver_t` API version's value. e.g.: ``` H5F_LIBVER_V200 = 5, - H5F_LIBVER_LATEST = 5, + H5F_LIBVER_LATEST = 5, ``` -- Added support for complex number datatypes +### Added support for complex number datatypes Support for the C99 "float _Complex", "double _Complex" and "long double _Complex" (with MSVC, "_Fcomplex", "_Dcomplex" and "_Lcomplex") types has been added for platforms/compilers that support them. These types have been implemented with a new datatype class, `H5T_COMPLEX`. Note that any datatypes of class H5T_COMPLEX will not be readable with previous versions of HDF5. If a file is accessed with a library version bounds "high" setting less than `H5F_LIBVER_V200`, an error will occur if the application tries to create an object with a complex number datatype. If compatibility with previous versions of HDF5 is desired, applications should instead consider adopting [one of the existing conventions](https://nc-complex.readthedocs.io/en/latest/#conventions-used-in-applications). @@ -308,7 +336,7 @@ HDF5 release, platforms tested, and known problems in this release. | `H5T_NATIVE_FLOAT_COMPLEX` | This macro maps to the ID of an HDF5 datatype representing the native C float complex datatype (either "float _Complex" or "_Fcomplex") for the platform. If support for a native float complex datatype is not available (`H5_HAVE_COMPLEX_NUMBERS` is not defined), the macro will map to `H5I_INVALID_HID` and should not be used. | | `H5T_NATIVE_DOUBLE_COMPLEX` | This macro maps to the ID of an HDF5 datatype representing the native C double complex datatype (either "double _Complex" or "_Dcomplex") for the platform. If support for a native double complex datatype is not available (`H5_HAVE_COMPLEX_NUMBERS` is not defined), the macro will map to `H5I_INVALID_HID` and should not be used. | | `H5T_NATIVE_LDOUBLE_COMPLEX` | This macro maps to the ID of an HDF5 datatype representing the native C long double complex datatype (either "long double _Complex" or "_Lcomplex") for the platform. If support for a native long double complex datatype is not available (`H5_HAVE_COMPLEX_NUMBERS` is not defined), the macro will map to `H5I_INVALID_HID` and should not be used. | - | `H5T_COMPLEX_IEEE_F16LE` / `H5T_COMPLEX_IEEE_F16BE` | These macros map to IDs of HDF5 datatypes representing a complex number of two parts, each of which is an IEEE 754 16-bit floating-point datatype in little- or big-endian order. These datatypes are available regardless of whether complex number support is available or not. | + | `H5T_COMPLEX_IEEE_F16LE` / `H5T_COMPLEX_IEEE_F16BE` | These macros map to IDs of HDF5 datatypes representing a complex number of two parts, each of which is an IEEE 754 16-bit floating-point datatype in little- or big-endian order. These datatypes are available regardless of whether complex number support is available or not. | | `H5T_COMPLEX_IEEE_F32LE` / `H5T_COMPLEX_IEEE_F32BE` | These macros map to IDs of HDF5 datatypes representing a complex number of two parts, each of which is an IEEE 754 32-bit floating-point datatype in little- or big-endian order. These datatypes are available regardless of whether complex number support is available or not. | | `H5T_COMPLEX_IEEE_F64LE` / `H5T_COMPLEX_IEEE_F64BE` | These macros map to IDs of HDF5 datatypes representing a complex number of two parts, each of which is an IEEE 754 64-bit floating-point datatype in little- or big-endian order. These datatypes are available regardless of whether complex number support is available or not. | @@ -340,7 +368,7 @@ HDF5 release, platforms tested, and known problems in this release. | H5T_NATIVE_SCHAR <-> H5T_NATIVE_LDOUBLE_COMPLEX | H5T_NATIVE_UCHAR <-> H5T_NATIVE_LDOUBLE_COMPLEX | | H5T_NATIVE_SHORT <-> H5T_NATIVE_LDOUBLE_COMPLEX | H5T_NATIVE_USHORT <-> H5T_NATIVE_LDOUBLE_COMPLEX | | H5T_NATIVE_INT <-> H5T_NATIVE_LDOUBLE_COMPLEX | H5T_NATIVE_UINT<-> H5T_NATIVE_LDOUBLE_COMPLEX | - | H5T_NATIVE_LONG<-> H5T_NATIVE_LDOUBLE_COMPLEX | H5T_NATIVE_ULONG <-> H5T_NATIVE_LDOUBLE_COMPLEX | + | H5T_NATIVE_LONG <-> H5T_NATIVE_LDOUBLE_COMPLEX | H5T_NATIVE_ULONG <-> H5T_NATIVE_LDOUBLE_COMPLEX | | H5T_NATIVE_LLONG <-> H5T_NATIVE_LDOUBLE_COMPLEX | H5T_NATIVE_ULLONG <-> H5T_NATIVE_LDOUBLE_COMPLEX | | H5T_NATIVE_FLOAT16 <-> H5T_NATIVE_LDOUBLE_COMPLEX | H5T_NATIVE_FLOAT <-> H5T_NATIVE_LDOUBLE_COMPLEX | | H5T_NATIVE_DOUBLE <-> H5T_NATIVE_LDOUBLE_COMPLEX | H5T_NATIVE_LDOUBLE <-> H5T_NATIVE_LDOUBLE_COMPLEX | @@ -375,15 +403,15 @@ HDF5 release, platforms tested, and known problems in this release. - HDF5Examples/C/H5T/200/h5ex_t_complex_msvc.c (Uses MSVC complex number types) - HDF5Examples/C/H5T/200/h5ex_t_complex_custom.c (Uses H5Tcomplex_create to create a custom complex number type) -- FOR VOL DEVELOPERS: Renamed `H5VLstart_lib_state` and `H5VLfinish_lib_state` +### FOR VOL DEVELOPERS: Renamed `H5VLstart_lib_state` and `H5VLfinish_lib_state` The APIs `H5VLstart_lib_state` and `H5VLfinish_lib_state` have been renamed to `H5VLopen_lib_context` and `H5VLclose_lib_context`, respectively, with the addition of a "context" argument. -- Removed `H5FDperform_init` API routine. +### Removed `H5FDperform_init` API routine. Virtual File Driver (VFD) developers who wish to provide an ID for their driver should create a routine specific to their individual implementation. -- `H5Pset_external()` now uses `HDoff_t`, which is always a 64-bit type +### `H5Pset_external()` now uses `HDoff_t`, which is always a 64-bit type The `H5Pset_external()` call took an off_t parameter in HDF5 1.14.x and earlier. On POSIX systems, off_t is specified as a 64-bit type via POSIX large-file support (LFS). On Windows, however, off_t is defined as a 32-bit type, even on 64-bit Windows. @@ -393,11 +421,11 @@ HDF5 release, platforms tested, and known problems in this release. Fixes GitHub issue [#3506](https://github.com/HDFGroup/hdf5/issues/3506) -- `H5Pset*` routines now fail when used on default property lists +### `H5Pset*` routines now fail when used on default property lists Modifying default property lists was never fully supported and could produce inconsistent and unexpected behavior. -- `H5Pset_vol()` now fails when used on a non-file-access property list +### `H5Pset_vol()` now fails when used on a non-file-access property list Similar to the above. Setting the connector on a non-FAPL had no effect on library behavior, and the connector ID and information could not be read back from that plist later. @@ -411,28 +439,28 @@ HDF5 release, platforms tested, and known problems in this release. ## Tools -- Added AWS endpoint command option to allow specifying an alternate endpoint URL when using the ROS3 VFD +### Added AWS endpoint command option to allow specifying an alternate endpoint URL when using the ROS3 VFD The new option is --endpoint-url, which allows the user to set an alternate endpoint URL other than the standard "protocol://service-code.region-code.amazonaws.com". If "--endpoint-url" is not specified, the ROS3 VFD will first check the AWS_ENDPOINT_URL_S3 and AWS_ENDPOINT_URL environment variables for an alternate endpoint URL before using a default one, with the region-code being supplied by the FAPL or standard AWS locations/environment variables. This option is supported by the following tools: `h5dump`, `h5ls`, `h5stat` -- Specifying ROS3 VFD on the command line is not required when using S3 URI +### Specifying ROS3 VFD on the command line is not required when using S3 URI If using an S3 URI to reference an HDF5 file in S3 (example: s3://mybucket/myfile.h5), then ROS3 VFD will be automatically selected unless the command-line option for the virtual file driver is used. This feature applies to the following tools: `h5dump`, `h5ls`, `h5stat`. -- Deprecated `h5dump` XML option +### Deprecated `h5dump` XML option The `h5dump` XML option is deprecated and will be removed in a future release. The XML output format has not been maintained and is not up-to-date with the latest features of HDF5. -- Added `h5dump` command option to set the floating point format for long double +### Added `h5dump` command option to set the floating point format for long double The new option is --lformat, which allows the user to set the floating point format for long double. The default format is %Lg. There is already an option --format to set the floating point format for double and float. The default format is %g. -- Removed the high-level GIF tools +### Removed the high-level GIF tools The high-level GIF tools, `h52gif` and `gif2h5`, have unfixed CVE issues (with no proof-of-concept files). They are not critical tools, are not well-maintained, and are an odd fit for building with the library. Because of this, they have been removed. We may move them to a separate repository in the future. @@ -447,26 +475,27 @@ HDF5 release, platforms tested, and known problems in this release. ## Documentation -- The COPYING file has been renamed to LICENSE +### The COPYING file has been renamed to LICENSE This is where most people will expect to find license information. The COPYING_LBNL_HDF5 file has also been renamed to LICENSE_LBNL_HDF5. The licenses are unchanged. -# 🪲 Bug Fixes +# 🪲 Bug Fixes ## Library -- Fixed security issue CVE-2025-6857 + +### Fixed security issue CVE-2025-6857 An HDF5 file had a corrupted v1 B-tree that would result in a stack overflow when performing a lookup on it. This has been fixed with additional integrity checks. Fixes GitHub issue #5575 -- Check for overflow in decoded heap block addresses +### Check for overflow in decoded heap block addresses Currently, we do not check for overflow when decoding addresses from the heap, which can cause overflow problems. We've added a check in H5HL__fl_deserialize to ensure no overflow can occur. - Fixes GitHub issue #5382 + Fixes GitHub issue [#5382](https://github.com/HDFGroup/hdf5/issues/5382) -- Revised handling of Unicode filenames on Windows +### Revised handling of Unicode filenames on Windows In the HDF5 1.14.4 release, a change was made to address some issues with the library's handling of code pages and file paths on Windows. This change introduced other issues with the handling of UTF-8 file names that caused breakage for software using the 1.14.4 and 1.14.5 releases of HDF5. That change was reverted for the 1.14.6 release and the behavior has been slightly modified for this release. @@ -474,48 +503,48 @@ HDF5 release, platforms tested, and known problems in this release. Support for a new environment variable, HDF5_PREFER_WINDOWS_CODE_PAGE, was added in order to instruct HDF5 to prefer interpreting filenames according to the active Windows code page rather than assuming UTF-8 encoding. If this environment variable is set to "1" or "TRUE" (case-insensitive), the active code page will be preferred. If it is unset or set to "0" or "FALSE" (case-insensitive), UTF-8 will be preferred. -- Fixed an issue with caching in the ROS3 VFD +### Fixed an issue with caching in the ROS3 VFD The ROS3 VFD uses a very simple caching mechanism that caches the first 16MiB of a file during file open and serves later reads from that cache if the offset + length falls within the cached range of bytes. Combinations of offset + length that extended exactly to the end of the cached range of bytes (for example, offset=0 and len=16777216) would end up not being served from the cache due to an incorrect range check. This has now been fixed. -- Fixed an error with `H5Fget_file_image()` with the latest file format +### Fixed an error with `H5Fget_file_image()` with the latest file format When using `H5Fget_file_image()` on a file created with the latest file format (or any format newer than the earliest), the library failed to recalculate the superblock checksum after changing the access flags in the superblock, causing any subsequent attempt to open the returned file image to fail due to the checksum failing to verify. Fixed `H5Fget_file_image()` to recalculate the checksum. Fixed GitHub issue [#1915](https://github.com/HDFGroup/hdf5/issues/1915) -- Fixed an assertion failure in `H5S__hyper_make_spans()` +### Fixed an assertion failure in `H5S__hyper_make_spans()` Calling H5Sselect_hyperslab() on dataspaces with invalid extents could result in an assertion failure in debug builds of the library if the dataspace has an extent with a rank value of 0. This has been fixed by converting the assertion failure into a normal error check. -- Fixed an assertion failure in `H5S__hyper_new_span_info()` +### Fixed an assertion failure in `H5S__hyper_new_span_info()` Calling `H5Scopy()` on hyperslab selection dataspaces with invalid extents could result in an assertion failure in debug builds of the library if the dataspace has an extent with a rank value of 0. This has been fixed by converting the assertion failure into a normal error check. -- Fixed a segfault in `H5S__get_select_hyper_blocklist()` +### Fixed a segfault in `H5S__get_select_hyper_blocklist()` When attempting to retrieve the list of hyperslab blocks selected within a dataspace, a segfault or bus error could occur when the dataspace has an extent with a rank value of 0. This would cause indexing into an array variable on the stack using a negative value. An error check was added to return failure from the function for such dataspaces. -- Fixed an error in `H5Ddebug` +### Fixed an error in `H5Ddebug` `H5Ddebug` would fail for any chunked dataset with a chunk index, due to its failure to tag the dataset before performing metadata operations. This caused `h5ls -va` to silently fail to print chunk addresses. This has been fixed. -- Fixed a bug in the `H5Oexists` and `H5Oexists_by_name` API routines that would cause those routines to return FAIL instead of FALSE when checking the existence of a non-existent object with a file ID instead of a group ID. +### Fixed a bug in the `H5Oexists` and `H5Oexists_by_name` API routines that would cause those routines to return FAIL instead of FALSE when checking the existence of a non-existent object with a file ID instead of a group ID. -- Fixed a segfault in h5dump when a B-tree node level is corrupted +### Fixed a segfault in h5dump when a B-tree node level is corrupted `h5dump` produced a segfault on a malformed file because a B-tree node level was corrupted. An internal function was modified to help detect when a decoded B-tree node level has an unexpected value, and an error will be produced. Fixed GitHub issue [#4432](https://github.com/HDFGroup/hdf5/issues/4432) -- Fixed `H5Ovisit2` to recursively visit all objects +### Fixed `H5Ovisit2` to recursively visit all objects `H5Ovisit2` visited only the root group and not all the nested groups. - This behavior occurred when the fields are not `H5O_INFO_BASIC` or `H5O_INFO_ALL` because an internal function did not obtain the basic information needed by its caller. This problem is now fixed. + This behavior occurred when the fields are not `H5O_INFO_BASIC` or `H5O_INFO_ALL` because an internal function did not obtain the basic information needed by its caller. This problem is now fixed. Fixed GitHub issue [#4941](https://github.com/HDFGroup/hdf5/issues/4941) -- Only clear `FE_INVALID` when that symbol is present on the system +### Only clear `FE_INVALID` when that symbol is present on the system When we initialize the floating-point types at library startup, it's possible to raise floating-point exceptions when we check which things are supported. Normally, we clear these floating-point exceptions via `feclearexcept(FE_INVALID)`, but `FE_INVALID` may not be present on all systems. Specifically, this was reported as being a problem when using Emscripten 3.1.68 to compile HDF5 1.14.5 to WebAssembly. @@ -525,30 +554,29 @@ HDF5 release, platforms tested, and known problems in this release. ## Java Library -- Renamed the Callbacks.java file to H5Callbacks.java +### Renamed the Callbacks.java file to H5Callbacks.java - The Callbacks.java file was renamed to H5Callbacks.java to match the file pattern used by doxygen. This change only affects the Java filenames and - does not change the classname or the package name. + The Callbacks.java file was renamed to H5Callbacks.java to match the file pattern used by doxygen. This change only affects the Java filenames and does not change the classname or the package name. ## Configuration -- Reorganized CMake HDF5 configuration options +### Reorganized CMake HDF5 configuration options The CMake configuration options have been reorganized to identify the primary options that are relevant to the build. These options are now in a separate file, CMakeBuildOptions.cmake, which is included by the root CMakeLists.txt file. In addition, some options have been converted to `cmake_dependent_option()` calls, which allows the options to be hidden from the CMake GUI when they are not relevant to the build. -- Remove default setting of `CMAKE_DEBUG_POSTFIX` +### Remove default setting of `CMAKE_DEBUG_POSTFIX` Move the default setting of `CMAKE_DEBUG_POSTFIX` to the cacheinit.cmake file usually used by testing. If `CMAKE_DEBUG_POSTFIX` is not set with a -D option then `CMAKE_DEBUG_POSTFIX` will be the default provided by CMake itself. -- The relative rpaths ($ORIGIN / @loader_path) are appended to the `CMAKE_INSTALL_RPATH` +### The relative rpaths ($ORIGIN / @loader_path) are appended to the `CMAKE_INSTALL_RPATH` The RPATH settings were removed by a pull-request [#5271](https://github.com/HDFGroup/hdf5/pull/5271), but the settings are needed under certain conditions. These settings have been restored by appending the necessary paths and will not override/overwrite any existing settings. -- When using a system-installed zlib library, the shared library is expected to be found in the system library path. +### When using a system-installed zlib library, the shared library is expected to be found in the system library path. Setting the `HDF5_MODULE_MODE_ZLIB` option to OFF will force find_package to use config mode first. An installed zlib, or an alternate installed zlib library, is expected to have a correct zlib-config.cmake file for config mode. Current zlib installs usually do not have a zlib-config.cmake file, so the option is set to ON by default. -- Use pre-installed libaec compression library +### Use pre-installed libaec compression library The CMake logic for finding the libaec compression library has been modified for a system-installed version of the library. Two options must be set: @@ -556,7 +584,8 @@ HDF5 release, platforms tested, and known problems in this release. ``` HDF5_ALLOW_EXTERNAL_SUPPORT:STRING=NO _USE_EXTERNAL:BOOL=OFF - ``` + ``` + where `` is one of `ZLIB`, `ZLIBNG`, `SZIP`, `PLUGIN`. Note that `HDF5_ALLOW_EXTERNAL_SUPPORT:STRING=NO` disables building all plugins and external libraries in-line with the HDF5 library. @@ -565,23 +594,23 @@ HDF5 release, platforms tested, and known problems in this release. See INSTALL_CMake.txt for more detailed information. -- Changed the zlib/szip compression find message to FATAL ERROR +### Changed the zlib/szip compression find message to FATAL ERROR The message was changed to indicate that zlib/szip compression was requested and that it was not found. If an option is requested, not finding it should always be an error. -- Removed the module search `find_package` for szip library +### Removed the module search `find_package` for szip library There is not an szip module file to use, so the `find_package` only uses `find_package` in config mode. The choice then is to either build szip, with libaec, inline, or find a system installed szip library, built with CMake. ## Tools -- `h5repack` did not properly parse User Defined filters +### `h5repack` did not properly parse User Defined filters The `h5repack` tool did not properly parse user-defined filter command-line arguments when the number of elements value was 0 (zero). Also, using a colon without a preceding object was enforced to behave the same as not using a colon. Fixed GitHub issue [#5132](https://github.com/HDFGroup/hdf5/issues/5132) -- Changed the default value for number of cd_values in filters. +### Changed the default value for number of cd_values in filters. The tools used an arbitrary value 0f 20 for the number of cd_values used in a filter. Created a new define `DEFAULT_CDELEMTS` in H5tools.h for the default value, which currently matches the library restriction of 256. @@ -593,7 +622,7 @@ HDF5 release, platforms tested, and known problems in this release. ## High-Level Library -- Fixed an issue with H5TB functions +### Fixed an issue with H5TB functions The H5TB functions were not correctly creating the FILL_INFO attribute for tables. This has been fixed by using the field offsets array from the call to H5TBAget_fill instead of using the compound type member offsets from the H5Tget_member_offset call for each compound type. @@ -607,15 +636,15 @@ HDF5 release, platforms tested, and known problems in this release. ## Testing -- Fixed an allocation in the t_bigio parallel test on 32-bit systems +### Fixed an allocation in the t_bigio parallel test on 32-bit systems - A test in t_bigio.c attempts to allocate more than 4 GiB of memory, which will overflow (and wrap) the size_t type on 32-bit systems, creating a very small allocation instead of a very large allocation. The test then segfaults when it accesses memory outside of the small buffer. + A test in t_bigio.c attempts to allocate more than 4 GiB of memory, which will overflow (and wrap) the size_t type on 32-bit systems, creating a very small allocation instead of a very large allocation. The test then segfaults when it accesses memory outside of the small buffer. The test has been fixed by limiting the buffer to 2 GiB on 32-bit systems. Fixed GitHub [#2510](https://github.com/HDFGroup/hdf5/issues/2510) -- Added skipping of a few parallel tests for OpenMPI 5.0.5 +### Added skipping of a few parallel tests for OpenMPI 5.0.5 An issue in OpenMPI 5.0.5 causes a few parallel HDF5 tests (mpiodup, props, fapl_preserve) to fail. These tests are now skipped for that release of OpenMPI. The issue has been fixed in the 5.0.6 release of OpenMPI. @@ -627,7 +656,7 @@ Data to come from cdash. # ⛔ Known Problems -- When the library detects and builds in support for the _Float16 datatype, an issue has been observed on at least one MacOS 14 system where the library +### When the library detects and builds in support for the _Float16 datatype, an issue has been observed on at least one MacOS 14 system where the library fails to initialize due to not being able to detect the byte order of the _Float16 type [#4310](https://github.com/HDFGroup/hdf5/issues/4310): #5: H5Tinit_float.c line 308 in H5T__fix_order(): failed to detect byte order @@ -638,7 +667,7 @@ fails to initialize due to not being able to detect the byte order of the _Float `CMake: HDF5_ENABLE_NONSTANDARD_FEATURE_FLOAT16=OFF` - - When HDF5 is compiled with NVHPC versions 23.5 - 23.9 (additional versions may also be applicable) and with -O2 (or higher) and -DNDEBUG, test failures occur in the following tests: + ### When HDF5 is compiled with NVHPC versions 23.5 - 23.9 (additional versions may also be applicable) and with -O2 (or higher) and -DNDEBUG, test failures occur in the following tests: H5PLUGIN-filter_plugin
H5TEST-flush2
@@ -654,27 +683,26 @@ fails to initialize due to not being able to detect the byte order of the _Float This is confirmed to be a [bug in the nvc compiler](https://forums.developer.nvidia.com/t/hdf5-no-longer-compiles-with-nv-23-9/269045) that has been fixed as of 23.11. If you are using an affected version of the NVidia compiler, the work-around is to set the optimization level to -O1. -- CMake files do not behave correctly with paths containing spaces +### CMake files do not behave correctly with paths containing spaces Do not use spaces in paths because the required escaping for handling spaces results in very complex and fragile build files. - - At present, metadata cache images may not be generated by parallel applications. Parallel applications can read files with metadata cache images, but since this is a collective operation, a deadlock is possible if one or more processes do not participate. +### At present, metadata cache images may not be generated by parallel applications. Parallel applications can read files with metadata cache images, but since this is a collective operation, a deadlock is possible if one or more processes do not participate. -- The subsetting option in `ph5diff` currently will fail and should be avoided +### The subsetting option in `ph5diff` currently will fail and should be avoided The subsetting option works correctly in serial `h5diff`. -- Flang Fortran compilation will fail (last check version 17) due to not yet implemented: (1) derived type argument passed by value (H5VLff.F90), and (2) support for REAL with KIND = 2 in intrinsic SPACING used in testing. +### Flang Fortran compilation will fail (last check version 17) due to not yet implemented: (1) derived type argument passed by value (H5VLff.F90), and (2) support for REAL with KIND = 2 in intrinsic SPACING used in testing. -- Fortran tests HDF5_1_8.F90 and HDF5_F03.F90 will fail with Cray compilers greater than version 16.0 due to a compiler bug. The latest version verified as failing was version 17.0. +### Fortran tests HDF5_1_8.F90 and HDF5_F03.F90 will fail with Cray compilers greater than version 16.0 due to a compiler bug. The latest version verified as failing was version 17.0. -- Several tests currently fail on certain platforms: +### Several tests currently fail on certain platforms: MPI_TEST-t_bigio fails with spectrum-mpi on ppc64le platforms. MPI_TEST-t_subfiling_vfd and MPI_TEST_EXAMPLES-ph5_subfiling fail with cray-mpich on theta and with XL compilers on ppc64le platforms. -- File space may not be released when overwriting or deleting certain nested variable length or reference types. - -- Known problems in previous releases can be found in the HISTORY*.txt files in the HDF5 source. Please report any new problems found to help@hdfgroup.org. +### File space may not be released when overwriting or deleting certain nested variable length or reference types. +### Known problems in previous releases can be found in the HISTORY*.txt files in the HDF5 source. Please report any new problems found to help@hdfgroup.org.