path: root/test/flush2.c

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * Copyright by the Board of Trustees of the University of Illinois.         *
 * 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 files COPYING and Copyright.html.  COPYING can be found at the root   *
 * of the source code distribution tree; Copyright.html can be found at the  *
 * root level of an installed copy of the electronic HDF5 document set and   *
 * is linked from the top-level documents page.  It can also be found at     *
 * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
 * access to either file, you may request a copy from help@hdfgroup.org.     *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * Programmer:  Robb Matzke <matzke@llnl.gov>
 *              Friday, October 23, 1998
 *
 * Purpose:	This is the second 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.  This half tries to read the
 *		file created by the first half.
 */
#include "h5test.h"

/* Make this private property (defined in H5Fprivate.h) available */
/* This is used in the helper routine clear_status_flags() */
#define H5F_ACS_CLEAR_STATUS_FLAGS_NAME            "clear_status_flags"


const char *FILENAME[] = {
    "flush",
    "flush-swmr",
    "noflush",
    "noflush-swmr",
    "flush_extend",
    "flush_extend-swmr",
    "noflush_extend",
    "noflush_extend-swmr",
    NULL
};

static double	the_data[100][100];

/*-------------------------------------------------------------------------
 * Function:	check_dset
 *
 * Purpose:	Part 2 of a two-part H5Fflush() test, checks if the data in a dataset
 * 		is what it is supposed to be.
 *
 * Return:	Success:	0
 *
 *		Failure:	1
 *
 * Programmer:	Leon Arber
 *              Oct. 4, 2006.
 *
 *-------------------------------------------------------------------------
 */
static int
check_dset(hid_t file, const char* name)
{
    hid_t	space, dset;
    hsize_t	ds_size[2] = {100, 100};
    double	error;
    size_t	i, j;

    /* Open the dataset */
    if((dset = H5Dopen2(file, name, H5P_DEFAULT)) < 0) goto error;
    if((space = H5Dget_space(dset)) < 0) goto error;
    if(H5Sget_simple_extent_dims(space, ds_size, NULL) < 0) goto error;
    assert(100 == ds_size[0] && 100 == ds_size[1]);

    /* Read some data */
    if(H5Dread(dset, H5T_NATIVE_DOUBLE, space, space, H5P_DEFAULT, the_data) < 0) goto error;
    for(i = 0; i < (size_t)ds_size[0]; i++)
	for(j = 0; j < (size_t)ds_size[1]; j++) {
	    error = HDfabs(the_data[i][j] - (double)i / (double)(j + 1));
	    if(error > (double)0.0001F) {
		    H5_FAILED();
		    printf("    dset[%lu][%lu] = %g\n",
			    (unsigned long)i, (unsigned long)j, the_data[i][j]);
		    printf("    should be %g\n", (double)i / (double)(j + 1));
		    goto error;
	    }
	}
    if(H5Dclose(dset) < 0) goto error;
    return 0;

error:
    return 1;
}


/*-------------------------------------------------------------------------
 * Function:	check_file
 *
 * Purpose:	Part 2 of a two-part H5Fflush() test.
 *
 * Return:	Success:	0
 *
 *		Failure:	1
 *
 * Programmer:	Leon Arber
 *              Sept. 26, 2006.
 *
 *-------------------------------------------------------------------------
 */
static int
check_file(char* filename, hid_t fapl, int flag)
{
    hid_t	file = -1, groups = -1;
    char	name[1024];
    int		i;

    if((file = H5Fopen(filename, H5F_ACC_RDONLY, fapl)) < 0) goto error;
    if(check_dset(file, "dset")) goto error;

    /* Open some groups */
    if((groups = H5Gopen2(file, "some_groups", H5P_DEFAULT)) < 0) goto error;
    for(i = 0; i < 100; i++) {
        hid_t	grp;
	sprintf(name, "grp%02u", (unsigned)i);
	if((grp = H5Gopen2(groups, name, H5P_DEFAULT)) < 0) goto error;
	if(H5Gclose(grp) < 0) goto error;
    } /* end for */

    /* Check to see if that last added dataset in the third file is accessible
     * (it shouldn't be...but it might.  Flag an error in case it is for now */
    if(flag && check_dset(file, "dset2")) goto error;

    if(H5Gclose(groups) < 0) goto error;
    if(H5Fclose(file) < 0) goto error;

    return 0;

error:
    H5E_BEGIN_TRY {
        H5Gclose(groups);
        H5Fclose(file);
    } H5E_END_TRY;

    return 1;
} /* end check_file() */

/*-------------------------------------------------------------------------
 * Function:	clear_status_flags
 *
 * Purpose:	To clear the status_flags in the superblock of the file.
 * 		It is smilar to the tool "h5clear".
 *
 * Return:	Success:	0
 *		Failure:	1
 *
 * Programmer:	Vailin Choi
 *              July 2013
 *
 *-------------------------------------------------------------------------
 */
static int
clear_status_flags(char *name, hid_t fapl)
{
    hid_t new_fapl = -1;
    hid_t fid = -1;
    hbool_t clear = TRUE;

    /* Get a copy of fapl */
    if((new_fapl = H5Pcopy(fapl)) < 0)
	FAIL_STACK_ERROR;

    /* Set this private property */
    if(H5Pset(new_fapl, H5F_ACS_CLEAR_STATUS_FLAGS_NAME, &clear) < 0)
	FAIL_STACK_ERROR;

    /* Has to open rw */
    if((fid = H5Fopen(name, H5F_ACC_RDWR, new_fapl)) < 0)
	FAIL_STACK_ERROR;

    /* Close the file */
    if(H5Fclose(fid) < 0)
	FAIL_STACK_ERROR;

    /* CLose the property list */
    if(H5Pclose(new_fapl) < 0)
	FAIL_STACK_ERROR;

    return 0;

error:
    return 1;
} /* clear_status_flags() */


/*-------------------------------------------------------------------------
 * Function:	main
 *
 * Purpose:	Part 2 of a two-part H5Fflush() test.
 *
 * Return:	Success:	0
 *
 *		Failure:	1
 *
 * Programmer:	Robb Matzke
 *              Friday, October 23, 1998
 *
 * Modifications:
 * 		Leon Arber
 * 		Sept. 26, 2006, expand to check for case where the was file not flushed.
 *
 *-------------------------------------------------------------------------
 */
int
main(void)
{
    hid_t fapl;
    H5E_auto2_t func;
    char	name[1024];

    h5_reset();
    fapl = h5_fileaccess();
    TESTING("H5Fflush (part2 with flush)");

    /* Check the case where the file was flushed */
    h5_fixname(FILENAME[0], fapl, name, sizeof name);

    if(check_file(name, fapl, FALSE)) {
        H5_FAILED()
        goto error;
    }
    else
        PASSED();


    TESTING("H5Fflush (part2 with flush + SWMR)");

    /* Check the case where the file was flushed w/SWMR */
    h5_fixname(FILENAME[1], fapl, name, sizeof name);

    /* Clear the status_flags of the file which is flushed and exited in flush1.c */
    if(clear_status_flags(name, fapl) < 0) {
        H5_FAILED()
        goto error;
    }

    if(check_file(name, fapl, FALSE)) {
        H5_FAILED()
        goto error;
    }
    else
        PASSED();


    /* Check the case where the file was not flushed.  This should give an error
     * so we turn off the error stack temporarily */
    TESTING("H5Fflush (part2 without flush)");
    H5Eget_auto2(H5E_DEFAULT,&func,NULL);
    H5Eset_auto2(H5E_DEFAULT, NULL, NULL);

    h5_fixname(FILENAME[2], fapl, name, sizeof name);
    /* No need to clear the status_flags because this file is not flushed in flush1.c */
    /* H5Fopen() in check_file() will just return error */
    if(check_file(name, fapl, FALSE))
        PASSED()
    else {
#if defined H5_HAVE_WIN32_API && !defined (hdf5_EXPORTS)
        SKIPPED();
        puts("   DLL will flush the file even when calling _exit, skip this test temporarily");
#else
        H5_FAILED()
        goto error;
#endif
    }
    H5Eset_auto2(H5E_DEFAULT, func, NULL);

    /* Check the case where the file was not flushed.  This should give an error
     * so we turn off the error stack temporarily */
    TESTING("H5Fflush (part2 without flush + SWMR)");
    H5Eget_auto2(H5E_DEFAULT,&func,NULL);
    H5Eset_auto2(H5E_DEFAULT, NULL, NULL);

    h5_fixname(FILENAME[3], fapl, name, sizeof name);
    /* No need to clear the status_flags because this file is not flushed in flush1.c */
    /* H5Fopen() in check_file() will just return error */
    if(check_file(name, fapl, FALSE))
        PASSED()
    else {
#if defined H5_HAVE_WIN32_API && !defined (hdf5_EXPORTS)
        SKIPPED();
        puts("   DLL will flush the file even when calling _exit, skip this test temporarily");
#else
        H5_FAILED()
        goto error;
#endif
    }
    H5Eset_auto2(H5E_DEFAULT, func, NULL);

    /* Check the case where the file was flushed, but more data was added afterward.  This should give an error
     * so we turn off the error stack temporarily */
    TESTING("H5Fflush (part2 with flush and later addition and another flush)");
    H5Eget_auto2(H5E_DEFAULT,&func,NULL);
    H5Eset_auto2(H5E_DEFAULT, NULL, NULL);

    h5_fixname(FILENAME[4], fapl, name, sizeof name);

    /* Clear the status_flags of the file which is flushed and exited in flush1.c */
    if(clear_status_flags(name, fapl) < 0) {
        H5_FAILED()
        goto error;
    }

    if(check_file(name, fapl, TRUE)) {
        H5_FAILED()
        goto error;
    }
    else
        PASSED();

    H5Eset_auto2(H5E_DEFAULT, func, NULL);

    /* Check the case where the file was flushed, but more data was added afterward.  This should give an error
     * so we turn off the error stack temporarily */
    TESTING("H5Fflush (part2 with flush and later addition and another flush + SWMR)");
    H5Eget_auto2(H5E_DEFAULT,&func,NULL);
    H5Eset_auto2(H5E_DEFAULT, NULL, NULL);

    h5_fixname(FILENAME[5], fapl, name, sizeof name);

    if(check_file(name, fapl, TRUE))
        PASSED()
    else {
#if defined H5_HAVE_WIN32_API && !defined (hdf5_EXPORTS)
        SKIPPED();
        puts("   DLL will flush the file even when calling _exit, skip this test temporarily");
#else
        H5_FAILED()
        goto error;
#endif
    }

    H5Eset_auto2(H5E_DEFAULT, func, NULL);

    /* Check the case where the file was flushed, but more data was added afterward.  This should give an error
     * so we turn off the error stack temporarily */
    TESTING("H5Fflush (part2 with flush and later addition)");
    H5Eget_auto2(H5E_DEFAULT,&func,NULL);
    H5Eset_auto2(H5E_DEFAULT, NULL, NULL);

    h5_fixname(FILENAME[6], fapl, name, sizeof name);

    if(check_file(name, fapl, TRUE))
        PASSED()
    else {
#if defined H5_HAVE_WIN32_API && !defined (hdf5_EXPORTS)
        SKIPPED();
        puts("   DLL will flush the file even when calling _exit, skip this test temporarily");
#else
        H5_FAILED()
        goto error;
#endif
    }

    H5Eset_auto2(H5E_DEFAULT, func, NULL);

    /* Check the case where the file was flushed, but more data was added afterward.  This should give an error
     * so we turn off the error stack temporarily */
    TESTING("H5Fflush (part2 with flush and later addition + SWMR)");
    H5Eget_auto2(H5E_DEFAULT,&func,NULL);
    H5Eset_auto2(H5E_DEFAULT, NULL, NULL);

    h5_fixname(FILENAME[7], fapl, name, sizeof name);

    if(check_file(name, fapl, TRUE))
        PASSED()
    else {
#if defined H5_HAVE_WIN32_API && !defined (hdf5_EXPORTS)
        SKIPPED();
        puts("   DLL will flush the file even when calling _exit, skip this test temporarily");
#else
        H5_FAILED()
        goto error;
#endif
    }

    H5Eset_auto2(H5E_DEFAULT, func, NULL);

    h5_cleanup(FILENAME, fapl);

    return 0;

error:
    return 1;
}