hdf5/test/flush1.c
Dana Robinson 7f1e49206d
Renamed COPYING to LICENSE (#4978)
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.
2024-10-18 21:13:04 -07:00

325 lines
11 KiB
C

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the LICENSE file, which can be found at the root of the source code *
* distribution tree, or in https://www.hdfgroup.org/licenses. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Purpose: This is the first half of a two-part test that makes sure
* that a file can be read after an application crashes as long
* as the file was flushed first. We simulate a crash by
* calling _exit(EXIT_SUCCESS) since this doesn't flush HDF5 caches but
* still exits with success.
*/
#include "h5test.h"
/* This file needs to access the file driver testing code */
#define H5FD_FRIEND /*suppress error about including H5FDpkg */
#define H5FD_TESTING
#include "H5FDpkg.h" /* File drivers */
static const char *FILENAME[] = {"flush", "flush-swmr", "noflush",
"noflush-swmr", "flush_extend", "flush_extend-swmr",
"noflush_extend", "noflush_extend-swmr", NULL};
/* Number and size of dataset dims, chunk size, etc. */
#define NDIMS 1
#define NELEMENTS 10000
#define CHUNK_SIZE 25
#define FIRST_DSET_NAME "dset1"
#define SECOND_DSET_NAME "dset2"
/* Number of sub-groups created in the containing group */
#define NGROUPS 100
static hid_t create_file(const char *filename, hid_t fapl_id, bool swmr);
static herr_t add_dset_to_file(hid_t fid, const char *dset_name);
/*-------------------------------------------------------------------------
* Function: create_file
*
* Purpose: Creates files and datasets used in part 1 of the test
*
* Return: Success: a valid file ID
* Failure: -1
*
*-------------------------------------------------------------------------
*/
static hid_t
create_file(const char *filename, hid_t fapl_id, bool swmr)
{
hid_t fid = H5I_INVALID_HID; /* file ID */
hid_t top_gid = H5I_INVALID_HID; /* containing group ID */
hid_t gid = H5I_INVALID_HID; /* subgroup ID */
char group_name[32]; /* group name */
unsigned flags; /* file open flags */
int i; /* iterator */
flags = H5F_ACC_TRUNC | (swmr ? H5F_ACC_SWMR_WRITE : 0);
if ((fid = H5Fcreate(filename, flags, H5P_DEFAULT, fapl_id)) < 0)
STACK_ERROR;
/* Create a chunked dataset */
if (add_dset_to_file(fid, FIRST_DSET_NAME) < 0)
TEST_ERROR;
/* Create some groups */
if ((top_gid = H5Gcreate2(fid, "top_group", H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
STACK_ERROR;
for (i = 0; i < NGROUPS; i++) {
snprintf(group_name, sizeof(group_name), "group%02d", i);
if ((gid = H5Gcreate2(top_gid, group_name, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
STACK_ERROR;
if (H5Gclose(gid) < 0)
STACK_ERROR;
} /* end for */
if (H5Gclose(top_gid) < 0)
STACK_ERROR;
return fid;
error:
H5E_BEGIN_TRY
{
H5Fclose(fid);
H5Gclose(gid);
H5Gclose(top_gid);
}
H5E_END_TRY
return -1;
} /* end create_file() */
/*-------------------------------------------------------------------------
* Function: add_dset_to_file
*
* Purpose: Add a dataset to the file.
*
* Return: SUCCEED/FAIL
*
*-------------------------------------------------------------------------
*/
static herr_t
add_dset_to_file(hid_t fid, const char *dset_name)
{
hid_t dcpl_id = H5I_INVALID_HID; /* dataset creation plist ID */
hid_t sid = H5I_INVALID_HID; /* dataspace ID */
hid_t did = H5I_INVALID_HID; /* dataset ID */
int *data = NULL; /* data buffer */
hsize_t dims[1] = {NELEMENTS}; /* size of dataset */
hsize_t chunk_dims[1] = {CHUNK_SIZE}; /* chunk size */
int i; /* iterator */
/* Create a chunked dataset */
if ((dcpl_id = H5Pcreate(H5P_DATASET_CREATE)) < 0)
STACK_ERROR;
if (H5Pset_chunk(dcpl_id, NDIMS, chunk_dims) < 0)
STACK_ERROR;
if ((sid = H5Screate_simple(NDIMS, dims, NULL)) < 0)
STACK_ERROR;
if ((did = H5Dcreate2(fid, dset_name, H5T_NATIVE_FLOAT, sid, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
STACK_ERROR;
/* Write some data */
if (NULL == (data = (int *)calloc((size_t)NELEMENTS, sizeof(int))))
STACK_ERROR;
for (i = 0; i < NELEMENTS; i++)
data[i] = i;
if (H5Dwrite(did, H5T_NATIVE_INT, sid, sid, H5P_DEFAULT, data) < 0)
STACK_ERROR;
if (H5Pclose(dcpl_id) < 0)
STACK_ERROR;
if (H5Sclose(sid) < 0)
STACK_ERROR;
if (H5Dclose(did) < 0)
STACK_ERROR;
free(data);
return SUCCEED;
error:
H5E_BEGIN_TRY
{
H5Pclose(dcpl_id);
H5Sclose(sid);
H5Dclose(did);
}
H5E_END_TRY
free(data);
return FAIL;
} /* end add_dset_to_file() */
/*-------------------------------------------------------------------------
* Function: main
*
* Purpose: Creates files and datasets with and without flushing in
* a variety of situations.
*
* Part 1 of a two-part H5Fflush() test.
*
* Return: EXIT_SUCCESS/EXIT_FAILURE
*
*-------------------------------------------------------------------------
*/
int
main(void)
{
const char *driver_name; /* name of current VFD (from env var) */
bool vfd_supports_swmr; /* whether the current VFD supports SWMR */
hid_t fid = H5I_INVALID_HID; /* file ID */
hid_t fapl_id = H5I_INVALID_HID; /* file access proplist ID */
char filename[1024]; /* filename */
bool use_swmr; /* whether or not to use SWMR I/O */
h5_test_init();
if ((fapl_id = h5_fileaccess()) < 0)
TEST_ERROR;
/* Check if the current VFD supports SWMR */
driver_name = h5_get_test_driver_name();
vfd_supports_swmr = H5FD__supports_swmr_test(driver_name);
/*************************************************/
/* NOTE: Not closing the file ID is intentional! */
/*************************************************/
/* Create a file and flush */
TESTING("H5Fflush (part1 with flush)");
h5_fixname(FILENAME[0], fapl_id, filename, sizeof(filename));
use_swmr = false;
if ((fid = create_file(filename, fapl_id, use_swmr)) < 0)
TEST_ERROR;
if (H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
FAIL_STACK_ERROR;
PASSED();
/* Create a file and flush w/ SWMR I/O */
TESTING("H5Fflush (part1 with flush + SWMR)");
if (vfd_supports_swmr) {
h5_fixname(FILENAME[1], fapl_id, filename, sizeof(filename));
use_swmr = true;
if ((fid = create_file(filename, fapl_id, use_swmr)) < 0)
TEST_ERROR;
if (H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
FAIL_STACK_ERROR;
PASSED();
} /* end if */
else
SKIPPED();
/* Create a file which will not be flushed */
TESTING("H5Fflush (part1 without flush)");
h5_fixname(FILENAME[2], fapl_id, filename, sizeof(filename));
use_swmr = false;
if ((fid = create_file(filename, fapl_id, use_swmr)) < 0)
TEST_ERROR;
PASSED();
/* Create a file which will not be flushed w/ SWMR I/O */
TESTING("H5Fflush (part1 without flush + SWMR)");
if (vfd_supports_swmr) {
h5_fixname(FILENAME[3], fapl_id, filename, sizeof(filename));
use_swmr = true;
if ((fid = create_file(filename, fapl_id, use_swmr)) < 0)
TEST_ERROR;
PASSED();
} /* end if */
else
SKIPPED();
/* Create a file, flush, add a dataset, flush */
TESTING("H5Fflush (part1 with flush and later addition and another flush)");
h5_fixname(FILENAME[4], fapl_id, filename, sizeof(filename));
use_swmr = false;
if ((fid = create_file(filename, fapl_id, use_swmr)) < 0)
TEST_ERROR;
if (H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
FAIL_STACK_ERROR;
if (add_dset_to_file(fid, SECOND_DSET_NAME) < 0)
TEST_ERROR;
if (H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
FAIL_STACK_ERROR;
PASSED();
/* Create a file, flush, add a dataset, flush w/ SWMR I/O */
TESTING("H5Fflush (part1 with flush and later addition and another flush + SWMR)");
if (vfd_supports_swmr) {
h5_fixname(FILENAME[5], fapl_id, filename, sizeof(filename));
use_swmr = true;
if ((fid = create_file(filename, fapl_id, use_swmr)) < 0)
TEST_ERROR;
if (H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
FAIL_STACK_ERROR;
if (add_dset_to_file(fid, SECOND_DSET_NAME) < 0)
TEST_ERROR;
if (H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
FAIL_STACK_ERROR;
PASSED();
} /* end if */
else
SKIPPED();
/* Create a file, flush, add a dataset, (no flush) */
TESTING("H5Fflush (part1 with flush and later addition)");
h5_fixname(FILENAME[6], fapl_id, filename, sizeof(filename));
use_swmr = false;
if ((fid = create_file(filename, fapl_id, use_swmr)) < 0)
TEST_ERROR;
if (H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
FAIL_STACK_ERROR;
if (add_dset_to_file(fid, SECOND_DSET_NAME) < 0)
TEST_ERROR;
PASSED();
/* Create a file, flush, add a dataset, (no flush) w/ SWMR I/O */
TESTING("H5Fflush (part1 with flush and later addition + SWMR)");
if (vfd_supports_swmr) {
h5_fixname(FILENAME[7], fapl_id, filename, sizeof(filename));
use_swmr = true;
if ((fid = create_file(filename, fapl_id, use_swmr)) < 0)
TEST_ERROR;
if (H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
FAIL_STACK_ERROR;
if (add_dset_to_file(fid, SECOND_DSET_NAME) < 0)
TEST_ERROR;
PASSED();
} /* end if */
else
SKIPPED();
if (!vfd_supports_swmr)
printf("NOTE: Some tests were skipped since the current VFD lacks SWMR support\n");
/* Flush console output streams */
fflush(stdout);
fflush(stderr);
/* DO NOT CLOSE FILE ID! */
if (H5Pclose(fapl_id) < 0)
STACK_ERROR;
/* _exit() is necessary since we want a hard close of the library */
_exit(EXIT_SUCCESS);
error:
H5E_BEGIN_TRY
{
H5Pclose(fapl_id);
}
H5E_END_TRY
exit(EXIT_FAILURE);
} /* end main() */