Skip to content

Change default file format to 1.8 #5949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Oct 30, 2025
+371 −124
Merged

Change default file format to 1.8 #5949

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
022bf4c
Update default file format verison to 1.8. Not all tests are passing
fortnern Sep 17, 2025
ee97f34
Committing clang-format changes
github-actions[bot] Sep 17, 2025
6a8af24
Merge branch 'develop' into def_ff_18
fortnern Oct 27, 2025
85332ed
Fix remaining errors except for 2 h5import failures.
fortnern Oct 27, 2025
d40c6c8
Committing clang-format changes
github-actions[bot] Oct 27, 2025
b664b75
typo
fortnern Oct 27, 2025
8d44d38
Fix more test failures
fortnern Oct 27, 2025
179ce0f
Merge branch 'def_ff_18' of github.com:fortnern/hdf5 into def_ff_18
fortnern Oct 27, 2025
229f27a
Fix direct I/O test failure
fortnern Oct 27, 2025
9a7f6dc
Fix Java tests I hope
fortnern Oct 28, 2025
3e6db16
Changelog.md note
fortnern Oct 28, 2025
84a68b5
Update comment in test/vfd.c
fortnern Oct 28, 2025
4451a5e
Add breaking change note
fortnern Oct 29, 2025
8aa4fad
Fix problems with family driver with user block. Fix bugs in testhdf5…
fortnern Oct 30, 2025
6aaa4e1
Merge branch 'develop' into def_ff_18
lrknox Oct 30, 2025
02badad
Update changelog.md notes and fix spelling
fortnern Oct 30, 2025
b8d8ccb
Merge branch 'def_ff_18' of github.com:fortnern/hdf5 into def_ff_18
fortnern Oct 30, 2025
4914415
More typos
fortnern Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions HDF5Examples/C/H5G/h5ex_g_compact.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,17 @@ main(void)
H5G_info_t ginfo;
hsize_t size;

/*
* Set file access property list to use the earliest file format.
* This will force the library to create original format groups.
*/
fapl = H5Pcreate(H5P_FILE_ACCESS);
status = H5Pset_libver_bounds(fapl, H5F_LIBVER_EARLIEST, H5F_LIBVER_LATEST);

/*
* Create file 1. This file will use original format groups.
*/
file = H5Fcreate(FILENAME1, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT);
file = H5Fcreate(FILENAME1, H5F_ACC_TRUNC, H5P_DEFAULT, fapl);
group = H5Gcreate(file, GROUP, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT);

/*
Expand Down Expand Up @@ -72,16 +79,16 @@ main(void)
status = H5Fclose(file);

/*
* Set file access property list to allow the latest file format.
* This will allow the library to create new compact format groups.
* Now use the default file access property list to allow the latest file
* format. This will allow the library to create new compact format groups.
* Since HDF5 2.0, the default is to use the 1.8 file format as the low
* bound, which includes compact groups.
*/
fapl = H5Pcreate(H5P_FILE_ACCESS);
status = H5Pset_libver_bounds(fapl, H5F_LIBVER_LATEST, H5F_LIBVER_LATEST);

/*
* Create file 2 using the new file access property list.
* Create file 2 using the default access property list.
*/
file = H5Fcreate(FILENAME2, H5F_ACC_TRUNC, H5P_DEFAULT, fapl);
file = H5Fcreate(FILENAME2, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT);
group = H5Gcreate(file, GROUP, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT);

/*
Expand Down
6 changes: 4 additions & 2 deletions c++/test/tfile.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -847,8 +847,10 @@ test_file_info()
H5F_fspace_strategy_t out_strategy = H5F_FSPACE_STRATEGY_FSM_AGGR;

try {
// Create a file using default properties.
H5File tempfile(FILE7, H5F_ACC_TRUNC);
// Create a file using the earliest format.
FileAccPropList fapl;
fapl.setLibverBounds(H5F_LIBVER_EARLIEST, H5F_LIBVER_LATEST);
H5File tempfile(FILE7, H5F_ACC_TRUNC, FileCreatPropList::DEFAULT, fapl);

// Get the file's version information.
H5F_info2_t finfo;
Expand Down
6 changes: 3 additions & 3 deletions fortran/test/tH5F.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1145,7 +1145,7 @@ SUBROUTINE file_space(filename, cleanup, total_error)

CALL h5fget_freespace_f(fid, free_space, error)
CALL check("h5fget_freespace_f",error,total_error)
IF(error .EQ.0 .AND. free_space .NE. 1248) THEN
IF(error .EQ.0 .AND. free_space .NE. 1853) THEN
total_error = total_error + 1
WRITE(*,*) "1: Wrong amount of free space reported, ", free_space
ENDIF
Expand All @@ -1161,7 +1161,7 @@ SUBROUTINE file_space(filename, cleanup, total_error)
! Check the free space now
CALL h5fget_freespace_f(fid, free_space, error)
CALL check("h5fget_freespace_f",error,total_error)
IF(error .EQ.0 .AND. free_space .NE. 216) THEN
IF(error .EQ.0 .AND. free_space .NE. 1706) THEN
total_error = total_error + 1
WRITE(*,*) "2: Wrong amount of free space reported, ", free_space
ENDIF
Expand All @@ -1173,7 +1173,7 @@ SUBROUTINE file_space(filename, cleanup, total_error)
! Check the free space now
CALL h5fget_freespace_f(fid, free_space, error)
CALL check("h5fget_freespace_f",error,total_error)
IF(error .EQ.0 .AND. free_space .NE. 1248) THEN
IF(error .EQ.0 .AND. free_space .NE. 1853) THEN
total_error = total_error + 1
WRITE(*,*) "3: Wrong amount of free space reported, ", free_space
ENDIF
Expand Down
47 changes: 31 additions & 16 deletions hl/test/test_file_image.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,12 @@
static int
test_file_image(size_t open_images, size_t nflags, const unsigned *flags)
{
hid_t *file_id = NULL, *dset_id = NULL, file_space, plist; /* HDF5 ids */
hsize_t dims1[RANK] = {2, 3}; /* original dimension of datasets */
hid_t *file_id = NULL; /* Array of file IDs */
hid_t *dset_id = NULL; /* Array of dataset IDs */
hid_t file_space_id = H5I_INVALID_HID; /* Dataspace ID */
hid_t dcpl_id = H5I_INVALID_HID; /* DCPL ID */
hid_t fapl_id = H5I_INVALID_HID; /* FAPL ID */
hsize_t dims1[RANK] = {2, 3}; /* original dimension of datasets */
hsize_t max_dims[RANK] = {H5S_UNLIMITED, H5S_UNLIMITED};
int data1[6] = {1, 2, 3, 4, 5, 6}; /* original contents of dataset */
int data2[6] = {7, 8, 9, 10, 11, 12}; /* "wrong" contents of dataset */
Expand Down Expand Up @@ -99,6 +103,13 @@ test_file_image(size_t open_images, size_t nflags, const unsigned *flags)
if (NULL == (dset_id = (hid_t *)malloc(sizeof(hid_t) * open_images)))
FAIL_PUTS_ERROR("malloc() failed");

/* Create FAPL and set earliest format */
/* TODO: run this test with all different formats */
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO still relevant here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. It will require different hacking of the superblock for each format version which is why I didn't have time to do it for this release. I can file an issue for it.

if ((fapl_id = H5Pcreate(H5P_FILE_ACCESS)) < 0)
FAIL_PUTS_ERROR("H5Pcreate() failed");
if (H5Pset_libver_bounds(fapl_id, H5F_LIBVER_EARLIEST, H5F_LIBVER_LATEST) < 0)
FAIL_PUTS_ERROR("H5Pset_libver_bounds() failed");

HL_TESTING2("get file images");

/* create several file images */
Expand All @@ -117,24 +128,24 @@ test_file_image(size_t open_images, size_t nflags, const unsigned *flags)
snprintf(filename[i], filenamelength, "image_file%d.h5", (int)i);

/* create file */
if ((file_id[i] = H5Fcreate(filename[i], H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT)) < 0)
if ((file_id[i] = H5Fcreate(filename[i], H5F_ACC_TRUNC, H5P_DEFAULT, fapl_id)) < 0)
FAIL_PUTS_ERROR("H5Fcreate() failed");

/* define dataspace for the dataset */
if ((file_space = H5Screate_simple(RANK, dims1, max_dims)) < 0)
if ((file_space_id = H5Screate_simple(RANK, dims1, max_dims)) < 0)
FAIL_PUTS_ERROR("H5Screate_simple() failed");

/* create dataset property list */
if ((plist = H5Pcreate(H5P_DATASET_CREATE)) < 0)
if ((dcpl_id = H5Pcreate(H5P_DATASET_CREATE)) < 0)
FAIL_PUTS_ERROR("H5Pcreate() failed");

/* set property list to create chunked dataset */
if (H5Pset_chunk(plist, RANK, dims1) < 0)
if (H5Pset_chunk(dcpl_id, RANK, dims1) < 0)
FAIL_PUTS_ERROR("H5Pset_chunk() failed");

/* create and write an integer type dataset named "dset" */
if ((dset_id[i] = H5Dcreate2(file_id[i], DSET_NAME, H5T_NATIVE_INT, file_space, H5P_DEFAULT, plist,
H5P_DEFAULT)) < 0)
if ((dset_id[i] = H5Dcreate2(file_id[i], DSET_NAME, H5T_NATIVE_INT, file_space_id, H5P_DEFAULT,
dcpl_id, H5P_DEFAULT)) < 0)
FAIL_PUTS_ERROR("H5Dcreate() failed");

/* dataset in open image 1 is written with "wrong" data */
Expand All @@ -153,11 +164,11 @@ test_file_image(size_t open_images, size_t nflags, const unsigned *flags)
FAIL_PUTS_ERROR("H5Fflush() failed");

/* close dataset property list */
if (H5Pclose(plist) < 0)
if (H5Pclose(dcpl_id) < 0)
FAIL_PUTS_ERROR("H5Pclose() failed");

/* close dataspace */
if (H5Sclose(file_space) < 0)
if (H5Sclose(file_space_id) < 0)
FAIL_PUTS_ERROR("H5Sclose() failed");

/* close dataset */
Expand Down Expand Up @@ -277,11 +288,11 @@ test_file_image(size_t open_images, size_t nflags, const unsigned *flags)
FAIL_PUTS_ERROR("H5Dopen() failed");

/* get dataspace for the dataset */
if ((file_space = H5Dget_space(dset_id[i])) < 0)
if ((file_space_id = H5Dget_space(dset_id[i])) < 0)
FAIL_PUTS_ERROR("H5Dget_space() failed");

/* get dimensions for the dataset */
if (H5Sget_simple_extent_dims(file_space, dims3, NULL) < 0)
if (H5Sget_simple_extent_dims(file_space_id, dims3, NULL) < 0)
FAIL_PUTS_ERROR("H5Sget_simple_extent_dims() failed");

/* read dataset */
Expand Down Expand Up @@ -312,7 +323,7 @@ test_file_image(size_t open_images, size_t nflags, const unsigned *flags)
} /* end else */

/* close dataspace */
if (H5Sclose(file_space) < 0)
if (H5Sclose(file_space_id) < 0)
FAIL_PUTS_ERROR("H5Sclose() failed");
} /* end for */

Expand Down Expand Up @@ -455,11 +466,11 @@ test_file_image(size_t open_images, size_t nflags, const unsigned *flags)
FAIL_PUTS_ERROR("H5Dopen() failed");

/* get dataspace for the dataset */
if ((file_space = H5Dget_space(dset_id[i])) < 0)
if ((file_space_id = H5Dget_space(dset_id[i])) < 0)
FAIL_PUTS_ERROR("H5Dget_space() failed");

/* get dimensions for the dataset */
if (H5Sget_simple_extent_dims(file_space, dims3, NULL) < 0)
if (H5Sget_simple_extent_dims(file_space_id, dims3, NULL) < 0)
FAIL_PUTS_ERROR("H5Sget_simple_extent_dims() failed");

/* read dataset */
Expand All @@ -479,7 +490,7 @@ test_file_image(size_t open_images, size_t nflags, const unsigned *flags)
FAIL_PUTS_ERROR("comparison of image values with original data failed");

/* close dataspace */
if (H5Sclose(file_space) < 0)
if (H5Sclose(file_space_id) < 0)
FAIL_PUTS_ERROR("H5Sclose() failed");

/* close dataset */
Expand Down Expand Up @@ -513,6 +524,10 @@ test_file_image(size_t open_images, size_t nflags, const unsigned *flags)

} /* end for */

/* close file access property list */
if (H5Pclose(fapl_id) < 0)
FAIL_PUTS_ERROR("H5Pclose() failed");

/* release temporary working buffers */
for (i = 0; i < open_images; i++)
free(filename[i]);
Expand Down
2 changes: 1 addition & 1 deletion java/test/TestH5Fbasic.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ public void testH5Fget_mdc_size()
catch (Throwable err) {
fail("H5.H5Fget_mdc_size: " + err);
}
assertTrue("H5.H5Fget_mdc_size #:" + nentries, nentries == 4);
assertTrue("H5.H5Fget_mdc_size #:" + nentries, nentries == 2);
}

// TODO: test more cases of different cache sizes.
Expand Down
2 changes: 1 addition & 1 deletion java/test/TestH5Fparams.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ public void testH5Fget_info()

try {
H5F_info2_t finfo = H5.H5Fget_info(fid);
assertEquals(finfo.super_version, 0);
assertEquals(finfo.super_version, 2);
assertEquals(finfo.free_version, 0);
assertEquals(finfo.sohm_version, 0);
}
Expand Down
8 changes: 4 additions & 4 deletions java/test/TestH5P.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1038,7 +1038,7 @@ public void testH5P_userblock()

/* Get the file's version information */
H5F_info2_t finfo = H5.H5Fget_info(H5fid);
assertTrue("super block version: " + finfo.super_version, finfo.super_version == 0);
assertTrue("super block version: " + finfo.super_version, finfo.super_version == 2);
assertTrue("free-space manager version: " + finfo.free_version, finfo.free_version == 0);
assertTrue("shared object header version: " + finfo.sohm_version, finfo.sohm_version == 0);
H5.H5Pget_userblock(fcpl_id, size);
Expand Down Expand Up @@ -1074,7 +1074,7 @@ public void testH5P_sizes()

/* Get the file's version information */
H5F_info2_t finfo = H5.H5Fget_info(H5fid);
assertTrue("super block version: " + finfo.super_version, finfo.super_version == 0);
assertTrue("super block version: " + finfo.super_version, finfo.super_version == 2);
assertTrue("free-space manager version: " + finfo.free_version, finfo.free_version == 0);
assertTrue("shared object header version: " + finfo.sohm_version, finfo.sohm_version == 0);
H5.H5Pget_sizes(fcpl_id, size);
Expand Down Expand Up @@ -1111,7 +1111,7 @@ public void testH5P_sym_k()

/* Get the file's version information */
H5F_info2_t finfo = H5.H5Fget_info(H5fid);
assertTrue("super block version: " + finfo.super_version, finfo.super_version == 0);
assertTrue("super block version: " + finfo.super_version, finfo.super_version == 2);
assertTrue("free-space manager version: " + finfo.free_version, finfo.free_version == 0);
assertTrue("shared object header version: " + finfo.sohm_version, finfo.sohm_version == 0);
H5.H5Pget_sym_k(fcpl_id, size);
Expand Down Expand Up @@ -1148,7 +1148,7 @@ public void testH5P_istore_k()

/* Get the file's version information */
H5F_info2_t finfo = H5.H5Fget_info(H5fid);
assertTrue("super block version: " + finfo.super_version, finfo.super_version == 1);
assertTrue("super block version: " + finfo.super_version, finfo.super_version == 2);
assertTrue("free-space manager version: " + finfo.free_version, finfo.free_version == 0);
assertTrue("shared object header version: " + finfo.sohm_version, finfo.sohm_version == 0);
H5.H5Pget_istore_k(fcpl_id, size);
Expand Down
2 changes: 1 addition & 1 deletion java/test/TestH5Pfapl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ public void testH5Pget_libver_bounds()
}
assertTrue("testH5Pget_libver_bounds", ret_val >= 0);
// Check the Earliest Version if the library
assertEquals(HDF5Constants.H5F_LIBVER_EARLIEST, libver[0]);
assertEquals(HDF5Constants.H5F_LIBVER_V18, libver[0]);
// Check the Latest Version if the library
assertEquals(HDF5Constants.H5F_LIBVER_LATEST, libver[1]);
}
Expand Down
4 changes: 4 additions & 0 deletions release_docs/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,10 @@ All other HDF5 library CMake options are prefixed with `HDF5_`

## Library

### 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()`.

### Added predefined datatypes for bfloat16 data

Predefined datatypes have been added for little- and big-endian bfloat16 (https://en.wikipedia.org/wiki/Bfloat16_floating-point_format) data.
Expand Down
2 changes: 1 addition & 1 deletion src/H5Pfapl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@

/* Definition for "low" bound of library format versions */
#define H5F_ACS_LIBVER_LOW_BOUND_SIZE sizeof(H5F_libver_t)
#define H5F_ACS_LIBVER_LOW_BOUND_DEF H5F_LIBVER_EARLIEST
#define H5F_ACS_LIBVER_LOW_BOUND_DEF H5F_LIBVER_V18
#define H5F_ACS_LIBVER_LOW_BOUND_ENC H5P__facc_libver_type_enc
#define H5F_ACS_LIBVER_LOW_BOUND_DEC H5P__facc_libver_type_dec

Expand Down
Loading
Loading