Add 2.1.0 CHANGELOG to HISTORY-2.X.md and set release default to draft. (#6291)

* Add 2.1.0 CHANGELOG to HISTORY-2.X.md. Set release default to draft. * Updated CHANGELOG.md Executive Summary "Important" section similar to that in HDF5 2.1.0 release.
2026-09-25 04:09:44 +03:00 · 2026-03-17 09:27:10 -05:00
parent 10b9801642
commit 8f2ee48e8f
3 changed files with 278 additions and 16 deletions
@@ -24,21 +24,18 @@ For releases prior to version 2.0.0, please see the release.txt file and for mor

 # 🔆 Executive Summary: HDF5 Version 2.2.0

+> [!IMPORTANT]
+>
+> - The format of the GitHub tag for HDF5 releases has been changed to Major.Minor.Patch, consistent with the versioning policy change to follow the Semantic Versioning Specification described in this [Wiki page](https://github.com/HDFGroup/hdf5/wiki/HDF5-Version-Numbers-and-Branch-Strategy).  The previous tag format hdf5_Major_Minor_Patch that was created in addition for the 2.0.0 and 2.1.0 releases will not be continued.   
+> - An RPM package is not provided for this release of HDF5 as an issue with the package was found during testing. The HDF Group is investigating alternative packaging methods for future releases.
+
+
 ## Performance Enhancements:


 ## Significant Advancements:


-## Updated Foundation:
-
-> [!IMPORTANT]
->
-> - Transitioned to [CMake-only](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.
-> - The format of the GitHub tag for HDF5 releases has been changed to Major.Minor.Patch, consistent with the versioning policy change to follow the Semantic Versioning Specification described in this [Wiki page](https://github.com/HDFGroup/hdf5/wiki/HDF5-Version-Numbers-and-Branch-Strategy).  The previous tag format hdf5_Major_Minor_Patch that was created in addition for the 2.0.0 and 2.1.0 releases will not be continued.   
-
 ## Enhanced Features:

 - Made several improvements to the CMake logic for handling filter libraries
@@ -3,10 +3,274 @@

 This file contains development history of the HDF5 2.X.X releases

+02.      Release Information for hdf5-2.1.0
 01.      Release Information for hdf5-2.0.0

 [Search on the string '%%%%' for section breaks of each release.]

+%%%%2.1.0%%%%
+
+HDF5 version 2.1.0 released on 2026-03-02
+
+# 🔺 HDF5 Changelog
+All notable changes to this project will be documented in this file. This document describes the differences between this release and the previous
+HDF5 release, platforms tested, and known problems in this release.
+
+For releases prior to version 2.0.0, please see the release.txt file and for more details check the HISTORY*.txt files in the HDF5 source.
+
+# 🔗 Quick Links
+* [HDF5 documentation](https://support.hdfgroup.org/documentation/hdf5/latest/)
+* [Official HDF5 releases](https://support.hdfgroup.org/downloads/index.html)
+* [Changes from Release to Release and New Features in the HDF5-2.x.y](https://support.hdfgroup.org/releases/hdf5/documentation/release_specific_info.md)
+* [Getting help, questions, or comments](https://github.com/HDFGroup/hdf5#help-and-support)
+
+## 📖 Contents
+* [Executive Summary](CHANGELOG.md#execsummary)
+* [Breaking Changes](CHANGELOG.md#%EF%B8%8F-breaking-changes)
+* [New Features & Improvements](CHANGELOG.md#-new-features--improvements)
+* [Bug Fixes](CHANGELOG.md#-bug-fixes)
+* [Support for new platforms and languages](CHANGELOG.md#-support-for-new-platforms-and-languages)
+* [Platforms Tested](CHANGELOG.md#%EF%B8%8F-platforms-tested)
+* [Known Problems](CHANGELOG.md#-known-problems)
+
+# 🔆 Executive Summary: HDF5 Version 2.1.0
+
+> [!IMPORTANT]
+>
+> - The format of the GitHub tag for HDF5 releases has been changed to Major.Minor.Patch, consistent with the versioning policy change to follow the Semantic Versioning Specification described in this [Wiki page](https://github.com/HDFGroup/hdf5/wiki/HDF5-Version-Numbers-and-Branch-Strategy).  The previous tag format hdf5_Major_Minor_Patch that was created in addition for HDF5 2.0.0 and this release will not be continued.
+
+## Performance Enhancements:
+
+
+## Significant Advancements:
+
+
+## Enhanced Features:
+
+
+## Java Enhancements:
+
+  
+## Acknowledgements: 
+
+We would like to thank the many HDF5 community members who contributed to this release of HDF5.
+
+# ⚠️ Breaking Changes
+
+
+# 🚀 New Features & Improvements
+
+## Configuration
+
+### Added a CMake module to locate libaec for SZIP support
+
+   A new `Findlibaec.cmake` CMake module has been added. This module is intended to locate libaec on the system for SZIP support in HDF5 when libaec was built with Autotools instead of CMake. When SZIP support is enabled in HDF5 with the `HDF5_ENABLE_SZIP_SUPPORT` option, this module will first check for an existing CMake-built libaec and use that if it's available. Otherwise, the module will heuristically search for libaec on the system. If necessary, the module can be hinted toward a particular libaec installation by setting the CMake variable `libaec_ROOT` to point to a directory. If it is known that a CMake-built libaec installation exists on the system in a non-standard location, the CMake variable `libaec_DIR` can instead be set to a directory containing a `libaec-config.cmake` file to cause the module to prefer that libaec installation.
+
+### Refactored CMake library export mechanism
+
+   The CMake build system now uses separate export targets for different library types: static libraries use `${HDF5_EXPORTED_TARGETS}_static`, Java libraries use `${HDF5_EXPORTED_TARGETS}_java`, and shared libraries continue using the main `${HDF5_EXPORTED_TARGETS}`. The generated `hdf5-config.cmake` file conditionally includes the appropriate target files (`hdf5-targets_static.cmake` and `hdf5-targets_java.cmake`), allowing downstream projects to selectively link against specific library variants. This refactoring improves build system maintainability and applies consistently across all HDF5 components (core, C++, Fortran, high-level APIs, tools, and Java JNI).
+
+## Library
+
+### Added predefined datatypes for FP6 data
+
+   Predefined datatypes have been added for FP6 data in [E2M3 and E3M2 formats](https://www.opencompute.org/documents/ocp-microscaling-formats-mx-v1-0-spec-final-pdf).
+
+   The following new macros have been added:
+
+   - `H5T_FLOAT_F6E2M3`
+   - `H5T_FLOAT_F6E3M2`
+
+   These macros map to IDs of HDF5 datatypes representing a 6-bit floating-point datatype with 1 sign bit and either 2 exponent bits and 3 mantissa bits (E2M3 format) or 3 exponent bits and 2 mantissa bits (E3M2 format).
+
+   Note that support for a native FP6 datatype has not been added yet. This means that any datatype conversions to/from the new FP6 datatypes will be emulated in software rather than potentially using specialized hardware instructions. Until support for a native FP6 type is added, an application can avoid datatype conversion performance issues if it is sure that the datatype used for in-memory data buffers matches one of the above floating-point formats. In this case, the application can specify one of the above macros for both the file datatype when creating a dataset or attribute and the memory datatype when performing I/O on the dataset or attribute.
+
+   Also note that HDF5 currently has incomplete support for datatype conversions involving non-IEEE floating-point format datatypes. Refer to the 'Known Problems' section for information about datatype conversions with these new datatypes.
+
+### Added predefined datatype for FP4 data
+
+   A predefined datatype has been added for FP4 data in [E2M1 format](https://www.opencompute.org/documents/ocp-microscaling-formats-mx-v1-0-spec-final-pdf).
+
+   The following new macro has been added:
+
+   - `H5T_FLOAT_F4E2M1`
+
+   This macro maps to the ID of an HDF5 datatype representing a 4-bit floating-point datatype with 1 sign bit, 2 exponent bits and 1 mantissa bit.
+
+   Note that support for a native FP4 datatype has not been added yet. This means that any datatype conversions to/from the new FP4 datatype will be emulated in software rather than potentially using specialized hardware instructions. Until support for a native FP4 type is added, an application can avoid datatype conversion performance issues if it is sure that the datatype used for in-memory data buffers matches the above floating-point format. In this case, the application can specify the above macro for both the file datatype when creating a dataset or attribute and the memory datatype when performing I/O on the dataset or attribute.
+
+   Also note that HDF5 currently has incomplete support for datatype conversions involving non-IEEE floating-point format datatypes. Refer to the 'Known Problems' section for information about datatype conversions with these new datatypes.
+
+## Parallel Library
+
+## Fortran Library
+
+## C++ Library
+
+## Java Library
+
+## Tools
+
+## High-Level APIs
+
+## C Packet Table API
+
+## Internal header file
+
+## Documentation
+
+
+# 🪲 Bug Fixes
+
+## Library
+
+### Fixed a problem with using filters with variable length datatypes
+
+   When using data filters with a dataset with a variable length datatype, the library would not invoke the filters' can_apply and set_local callbacks. This has been addressed and the library will now make those callbacks no matter what the datatype is.
+
+### Fixed a potential out of bound read
+
+   When a file is corrupted such that an array datatype's size, the number of elements, and the element size are not in agreement, it can trigger an out of bounds read.  A check has been added to detect such situation.
+
+### Fixed security issue [CVE-2025-44904](https://www.cve.org/CVERecord?id=CVE-2025-44904)
+
+   For unfiltered dataset chunks, the size on disk should be constant for all chunks in a dataset. In some cases the size of each chunk is stored even in this case where it can be inferred from the chunk dimensions and datatype. The code previously assumed this stored size was equal to the inferred size, leading to a mismatch in the expected and actual buffer size. Modified the library to throw an error if the size does not match the expected size.
+
+### Fixed security issue [CVE-2025-2309](https://www.cve.org/CVERecord?id=CVE-2025-2309)
+
+   Fixed a critical vulnerability in `H5T__bit_copy` of the component Type Conversion Logic which could lead to heap-based buffer overflow. 
+
+### Fixed security issue [CVE-2025-2308](https://www.cve.org/CVERecord?id=CVE-2025-2308)
+
+   Fixed a critical vulnerability in the function `H5Z__scaleoffset_decompress_one_byte` of the component Scale-Offset Filter which could lead to heap-based buffer overflow. 
+
+### Fixed a double-free bug in `H5D__chunk_copy`
+
+   Fixed a double-free bug in the internal `H5D__chunk_copy()` function which occurred when a buffer was re-allocated without updating the original pointer freed later on.
+
+   Fixes GitHub issues [#6123](https://github.com/HDFGroup/hdf5/issues/6123)
+                       [#6124](https://github.com/HDFGroup/hdf5/issues/6124)
+                       [#6125](https://github.com/HDFGroup/hdf5/issues/6125)
+                       [#6126](https://github.com/HDFGroup/hdf5/issues/6126)
+                       [#6133](https://github.com/HDFGroup/hdf5/issues/6133)
+### Fixes potential security issues
+
+   The `get_name` API functions allow passing NULL when querying the object name length. However, passing a non-NULL buffer with size == 0 will result in security vulnerability of invalid write. That was because the library wrote a null terminator to the buffer regardless of what the size of the buffer was as long as the buffer was non-NULL.
+   These functions are now fixed to treat (buffer != NULL, size == 0) as a length-only query to eliminate Valgrind error of invalid write.
+
+### Fixed a performance issue with chunked dataset I/O
+
+   When dataset chunks are unable to be placed in the dataset chunk cache (for example, if a chunk is too large), the library falls back to an alternative approach for I/O on dataset chunks. An issue with the logic in this approach prevented chunked dataset I/O from making use of the library's data sieve buffer I/O optimization functionality. For chunk shapes that are non-contiguous with the memory layout of a buffer, this could result in severely degraded I/O performance, with the worst-case behavior causing I/O to be performed on a single data element at a time.
+
+   The data sieve buffer functionality has been extended to cover the case of uncached chunks and will be used as long as the underlying Virtual File Driver supports data sieving.
+
+## Java Library
+
+## Configuration
+
+### Removed force-setting of `ZLIB_USE_EXTERNAL` and `SZIP_USE_EXTERNAL` CMake variables to `ON`
+
+   When the CMake variable `HDF5_ALLOW_EXTERNAL_SUPPORT` is set to `GIT` or `TGZ`, the library's build process previously force-set the `ZLIB_USE_EXTERNAL` and `SZIP_USE_EXTERNAL` variables to `ON`. This prevented the ability to independently choose whether zlib and szip are built from system libraries or from external sources. These variables are no longer forced to `ON` in this case and can be set individually.
+
+
+## Tools
+
+## Performance
+
+## Fortran API
+
+### Added Fortran wrappers for SWMR functionality
+
+   Added four new Fortran wrappers that provide direct access to SWMR (Single Writer Multiple Reader) C APIs:
+   - `h5fstart_swmr_write_f` - Enables SWMR writing mode for a file
+   - `h5dflush_f`            - Flushes dataset buffers to disk
+   - `h5pset_append_flush_f` - Sets append flush property values including optional callback function
+   - `h5pget_append_flush_f` - Retrieves append flush property values including callback function
+
+## High-Level Library
+
+## Fortran High-Level APIs
+
+## Documentation
+
+## F90 APIs
+
+## C++ APIs
+
+## Testing
+
+# ✨ Support for new platforms and languages
+
+# ☑️ Platforms Tested
+
+A table of platforms tested can be seen on the [wiki](https://github.com/HDFGroup/hdf5/wiki/Platforms-Tested).
+Current test results are available [here](https://my.cdash.org/index.php?project=HDF5).
+
+# ⛔ Known Problems
+
+- When performing implicit datatype conversion on specific non-IEEE floating-point format data, HDF5 may improperly convert some data values:
+
+   When performing I/O operations using a non-IEEE floating-point format datatype, HDF5 may improperly convert some data values due to incomplete handling of non-IEEE types. Such types include the following pre-defined datatypes:
+
+    `H5T_FLOAT_F8E4M3`<br>
+    `H5T_FLOAT_F8E5M2`<br>
+    `H5T_FLOAT_F6E2M3`<br>
+    `H5T_FLOAT_F6E3M2`<br>
+    `H5T_FLOAT_F4E2M1`
+
+   If possible, an application should perform I/O with these datatypes using an in-memory type that matches the specific floating-point format and perform explicit data conversion outside of HDF5, if necessary. Otherwise, read/written values should be verified to be correct.
+
+- 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
+     major: Datatype
+     minor: Unable to initialize object
+
+   If this issue is encountered, support for the _Float16 type can be disabled with a configuration option:
+
+     `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:
+
+   - H5PLUGIN-filter_plugin
+   - H5TEST-flush2
+   - H5TEST-testhdf5-base
+   - MPI_TEST_t_filters_parallel
+
+  Sporadic failures (even with lower -O levels):
+
+   - Java JUnit-TestH5Pfapl
+   - Java JUnit-TestH5D
+
+  Also, NVHPC will fail to compile the test/tselect.c test file with a compiler error of `use of undefined value` when the optimization level is -O2 or higher.
+
+   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
+
+   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.
+
+- 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.
+
+- 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:
+   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 <a href="mailto:help@hdfgroup.org">help@hdfgroup.org</a>.
+
+
 %%%%2.0.0%%%%

 HDF5 version 2.0.0 released on 2025-11-11
@@ -67,8 +331,8 @@ For releases prior to version 2.0.0, please see the release.txt file and for mor
 - Java FFM bindings generated for the C library if Java 25+ available and JNI option is FALSE.
 - Enhanced Maven artifact deployment with comprehensive multi-platform support (Linux, Windows, macOS x86_64, macOS aarch64).
 - Complete Java examples Maven integration (`org.hdfgroup:hdf5-java-examples`) with cross-platform CI/CD testing.
-
-## Acknowledgements:
+  
+## Acknowledgements: 

 We would like to thank the many HDF5 community members who contributed to HDF5 2.0.

@@ -253,7 +517,7 @@ All other HDF5 library CMake options are prefixed with `HDF5_`
 ### Changed default chunk cache hash table size to 8191

   In order to reduce hash collisions and take advantage of modern memory capacity, the default hash table size for the chunk cache has been increased from 521 to 8191. This means the hash table will consume approximately 64 KiB per open dataset. This value can be changed with `H5Pset_cache()` or `H5Pset_chunk_cache()`. This value was chosen because it is a prime number close to 8K.
-
+     
 ### Updated default file format to 1.8

   By default, HDF5 will now use the 1.8 file format (`H5F_LIBVER_V18`). This provides improved performance and space efficiency, particularly with groups and links. This behavior can be overridden with `H5Pset_libver_bounds()`.
@@ -373,7 +637,7 @@ If the ROS3 VFD cannot determine an AWS region from one of these locations, an e

 New API functions `H5Pset_fapl_ros3_endpoint()` and `H5Pget_fapl_ros3_endpoint()` have been added for use with the ROS3 VFD. These functions set/get an alternate endpoint URL to use when opening files with the ROS3 VFD. This is useful in cases where the application needs to access files that are in a location other than the standard `s3.<region-code>.amazonaws.com`, which is what the ROS3 VFD uses when an alternate endpoint URL isn't specified. The ROS3 VFD also checks the `AWS_ENDPOINT_URL_S3` and `AWS_ENDPOINT_URL` environment variables for an alternate endpoint URL if one isn't specified with `H5Pset_fapl_ros3_endpoint()`.

-Instructions for building the ROS3 VFD with the `aws-c-s3` library are in the [INSTALL_S3.md](./INSTALL_S3.md) file. The ROS3 VFD and information about the usage of the driver are described in the HDF5 user's guide.
+Instructions for building the ROS3 VFD with the `aws-c-s3` library are in the [INSTALL_S3.txt](./INSTALL_S3.txt) file. The ROS3 VFD and information about the usage of the driver are described in the HDF5 user's guide.

 ### Renamed some API decorations

@@ -647,7 +911,7 @@ Added Fortran wrapper `h5fdsubfiling_get_file_mapping_f()` for the subfiling fil
   Fixed a heap-based buffer overflow in H5F__accum_free caused by an integer overflow when calculating new_accum_size. Added validation in H5O__mdci_decode to detect and reject invalid values early, preventing the overflow condition.

   Fixes GitHub issue [#5380](https://github.com/HDFGroup/hdf5/issues/5380)
-
+  
 ### Fixed security issue [CVE-2025-7068](https://nvd.nist.gov/vuln/detail/CVE-2025-7068)

   Failures during the discard process on a metadata cache entry could cause the library to skip calling the callback to free the cache entry. This could result in resource leaks and issues with flushing and closing the metadata cache during file close. This has been fixed by noting errors during the discard process, but attempting to fully free a cache entry before signalling that an error has occurred.
@@ -735,7 +999,7 @@ Added Fortran wrapper `h5fdsubfiling_get_file_mapping_f()` for the subfiling fil
   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
-
+   
   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
@@ -829,7 +1093,7 @@ Added Fortran wrapper `h5fdsubfiling_get_file_mapping_f()` for the subfiling fil

   In addition, the `<LIB_PKG_NAME>_ROOT` environment variables must be set, where `<LIB_PKG_NAME>` is one of `ZLIB`, `ZLIBNG`, `SZIP`, `libaec`, `PLUGIN`. Note that libaec is the expected name for using the libaec library in place of original szip.

-   See [INSTALL_CMake.md](./INSTALL_CMake.md) for more detailed information.
+   See INSTALL_CMake.txt for more detailed information.

 ### Changed the zlib/szip compression find message to FATAL ERROR