netcdf-c/h5_test/tst_h_vars.c

/* This is part of the netCDF package.
   Copyright 2018 University Corporation for Atmospheric Research/Unidata
   See COPYRIGHT file for conditions of use.

   Test HDF5 file code. These are not intended to be exhaustive tests,
   but they use HDF5 the same way that netCDF-4 does, so if these
   tests don't work, than netCDF-4 won't work either.

   This files tests dataset creation and writing.
*/

#include "h5_err_macros.h"
#include <hdf5.h>

#define FILE_NAME "tst_h_vars.h5"
#define GRP_NAME "Henry_V"
#define VAR_BOOL_NAME "Southhamptons_Battle_Record"
#define GRP2_NAME "Some_3D_Met_Data"
#define DIM1_LEN 3
#define MAX_DIMS 255

int
main()
{
   hid_t fileid, grpid, spaceid, datasetid;
   int bool_out[DIM1_LEN] = {0, 1, 0};
   hsize_t dims[1];

   printf("\n*** Checking HDF5 variable functions.\n");
   printf("*** Checking HDF5 boolean variables...");

   /* Open file and create group. */
   if ((fileid = H5Fcreate(FILE_NAME, H5F_ACC_TRUNC, H5P_DEFAULT,
			   H5P_DEFAULT)) < 0) ERR;
   if ((grpid = H5Gcreate(fileid, GRP_NAME, 0)) < 0) ERR;

   /* Write an array of bools. */
   dims[0] = DIM1_LEN;
   if ((spaceid = H5Screate_simple(1, dims, dims)) < 0) ERR;
   if ((datasetid = H5Dcreate(grpid, VAR_BOOL_NAME, H5T_NATIVE_HBOOL,
			      spaceid, H5P_DEFAULT)) < 0) ERR;
   if (H5Dwrite(datasetid, H5T_NATIVE_HBOOL, H5S_ALL, H5S_ALL, H5P_DEFAULT,
		bool_out) < 0) ERR;
   if (H5Dclose(datasetid) < 0 ||
       H5Sclose(spaceid) < 0 ||
       H5Gclose(grpid) < 0 ||
       H5Fclose(fileid) < 0)
      ERR;

   SUMMARIZE_ERR;

   printf("*** Checking HDF5 variable with unlimited dimension...");
   {
#define LAT_LEN 2
#define LON_LEN 3
#define NDIMS 3
#define LAT_NAME "Lat"
#define LON_NAME "Lon"
#define TIME_NAME "Time"
#define PRES_NAME "Pressure"
#define TEMP_NAME "Temperature"

      hid_t fileid, grpid, spaceid, write_spaceid, spaceid_in, mem_spaceid;
      hid_t pres_dsid, temp_dsid, cparmsid;
      float float_data_out[LAT_LEN][LON_LEN];
      hsize_t dims[NDIMS], max_dims[NDIMS];
      hsize_t dims_in[NDIMS], max_dims_in[NDIMS];
      hsize_t start[MAX_DIMS], count[MAX_DIMS];
      int lat, lon;

      /* Set up some phoney data, 1 record's worth. In C, first
       * dimension varies most slowly. */
      for (lat = 0; lat < LAT_LEN; lat++)
	 for (lon = 0; lon < LON_LEN; lon++)
	    float_data_out[lat][lon] = -666.666;

      /* Create file and group. */
      if ((fileid = H5Fcreate(FILE_NAME, H5F_ACC_TRUNC, H5P_DEFAULT,
			      H5P_DEFAULT)) < 0) ERR;
      if ((grpid = H5Gcreate(fileid, GRP2_NAME, 0)) < 0) ERR;

      /* Create a space corresponding to these three dimensions. */
      dims[0] = 0;
      dims[1] = LAT_LEN;
      dims[2] = LON_LEN;
      max_dims[0] = H5S_UNLIMITED;
      max_dims[1] = LAT_LEN;
      max_dims[2] = LON_LEN;
      if ((spaceid = H5Screate_simple(NDIMS, dims, max_dims)) < 0) ERR;

      /* Enable chunking for unlimited datasets.  */
      if ((cparmsid = H5Pcreate(H5P_DATASET_CREATE)) < 0) ERR;
      dims[0] = 1;
      dims[1] = 1;
      dims[2] = 1;
      if (H5Pset_chunk(cparmsid, NDIMS, dims) < 0) ERR;

      /* Create two variables which use this space. */
      if ((pres_dsid = H5Dcreate(grpid, PRES_NAME, H5T_NATIVE_FLOAT,
				 spaceid, cparmsid)) < 0) ERR;
      if ((temp_dsid = H5Dcreate(grpid, TEMP_NAME, H5T_NATIVE_FLOAT,
				 spaceid, cparmsid)) < 0) ERR;

      /* Get the spaceid and check various things. */
      if ((spaceid_in = H5Dget_space(pres_dsid)) < 0) ERR;
      if (H5Sget_simple_extent_dims(spaceid_in, dims_in,
				    max_dims_in) < 0) ERR;
      if (dims_in[0] != 0 || dims_in[1] != LAT_LEN || dims_in[2] != LON_LEN) ERR;
      if (max_dims_in[0] != H5S_UNLIMITED || max_dims_in[1] != LAT_LEN || max_dims_in[2] != LON_LEN) ERR;

      /* Extend each of them to hold one record. */
      dims[0] = 1;
      dims[1] = LAT_LEN;
      dims[2] = LON_LEN;
      if (H5Dextend(pres_dsid, dims) < 0) ERR;
      if (H5Dextend(temp_dsid, dims) < 0) ERR;

      /* Create a space to deal with one record at a time in memory. */
      if ((mem_spaceid = H5Screate_simple(NDIMS, dims, NULL)) < 0) ERR;

      /* Create a space to write one record. */
      if ((write_spaceid = H5Screate_simple(NDIMS, dims, NULL)) < 0) ERR;

      /* Write one record of data to each dataset. */
      if (H5Dwrite(pres_dsid, H5T_IEEE_F32BE, mem_spaceid, write_spaceid,
		   H5P_DEFAULT, float_data_out) < 0) ERR;
      if (H5Dwrite(temp_dsid, H5T_IEEE_F32LE, mem_spaceid, write_spaceid,
		   H5P_DEFAULT, float_data_out) < 0) ERR;

      /* Get the spaceid and check various things. */
      if ((spaceid_in = H5Dget_space(temp_dsid)) < 0) ERR;
      if (H5Sget_simple_extent_dims(spaceid_in, dims_in,
				    max_dims_in) < 0) ERR;
      if (dims_in[0] != 1 || dims_in[1] != LAT_LEN || dims_in[2] != LON_LEN) ERR;
      if (max_dims_in[0] != H5S_UNLIMITED || max_dims_in[1] != LAT_LEN || max_dims_in[2] != LON_LEN) ERR;

      /* Extend each of them to hold a second record. */
      dims[0] = 2;
      dims[1] = LAT_LEN;
      dims[2] = LON_LEN;
      if (H5Dextend(pres_dsid, dims) < 0) ERR;
      if (H5Dextend(temp_dsid, dims) < 0) ERR;

      /* Create a space to write second record. */
      if ((write_spaceid = H5Screate_simple(NDIMS, dims, NULL)) < 0) ERR;
      count[0] = 1;
      count[1] = LAT_LEN;
      count[2] = LON_LEN;
      start[0] = 1;
      start[1] = 0;
      start[2] = 0;
      if (H5Sselect_hyperslab(write_spaceid, H5S_SELECT_SET,
			      start, NULL, count, NULL) < 0) ERR;

      /* Write second record of data to each dataset. */
      if (H5Dwrite(pres_dsid, H5T_IEEE_F32LE, mem_spaceid, write_spaceid,
		   H5P_DEFAULT, float_data_out) < 0) ERR;
      if (H5Dwrite(temp_dsid, H5T_IEEE_F32LE, mem_spaceid, write_spaceid,
		   H5P_DEFAULT, float_data_out) < 0) ERR;

      /* Get the spaceid and check various things. */
      if ((spaceid_in = H5Dget_space(pres_dsid)) < 0) ERR;
      if (H5Sget_simple_extent_dims(spaceid_in, dims_in,
				    max_dims_in) < 0) ERR;
      if (dims_in[0] != 2 || dims_in[1] != LAT_LEN || dims_in[2] != LON_LEN) ERR;
      if (max_dims_in[0] != H5S_UNLIMITED || max_dims_in[1] != LAT_LEN || max_dims_in[2] != LON_LEN) ERR;

      /* Close up the shop. */
      if (H5Dclose(pres_dsid) < 0 ||
	  H5Dclose(temp_dsid) < 0 ||
	  H5Sclose(spaceid) < 0 ||
	  H5Gclose(grpid) < 0 ||
	  H5Fclose(fileid) < 0) ERR;

   }

   SUMMARIZE_ERR;
   printf("*** Checking HDF5 deflate filter setting and getting...");
#define DEFLATE_LEVEL 9
#define MAX_NAME 100
#define NUM_CD_ELEM 10
/* HDF5 defines this... */
#define DEFLATE_NAME "deflate"
   {
      H5Z_filter_t filter;
      int num_filters;
      hid_t propid;
      unsigned int flags, cd_values[NUM_CD_ELEM], filter_config;
      size_t cd_nelems = NUM_CD_ELEM;
      size_t namelen = MAX_NAME;
      char name[MAX_NAME + 1];


      /* Open file and create group. */
      if ((fileid = H5Fcreate(FILE_NAME, H5F_ACC_TRUNC, H5P_DEFAULT,
			      H5P_DEFAULT)) < 0) ERR;
      if ((grpid = H5Gcreate(fileid, GRP_NAME, 0)) < 0) ERR;

      /* Write an array of bools, with compression. */
      dims[0] = DIM1_LEN;
      if ((propid = H5Pcreate(H5P_DATASET_CREATE)) < 0) ERR;
      if (H5Pset_layout(propid, H5D_CHUNKED)) ERR;
      if (H5Pset_chunk(propid, 1, dims)) ERR;
      if (H5Pset_deflate(propid, DEFLATE_LEVEL)) ERR;
      if ((spaceid = H5Screate_simple(1, dims, dims)) < 0) ERR;
      if ((datasetid = H5Dcreate(grpid, VAR_BOOL_NAME, H5T_NATIVE_HBOOL,
				 spaceid, propid)) < 0) ERR;
      if (H5Dwrite(datasetid, H5T_NATIVE_HBOOL, H5S_ALL, H5S_ALL, H5P_DEFAULT,
		   bool_out) < 0) ERR;
      if (H5Dclose(datasetid) < 0 ||
	  H5Pclose(propid) < 0 ||
	  H5Sclose(spaceid) < 0 ||
	  H5Gclose(grpid) < 0 ||
	  H5Fclose(fileid) < 0)
	 ERR;

      /* Now reopen the file and check. */
      if ((fileid = H5Fopen(FILE_NAME, H5F_ACC_RDONLY, H5P_DEFAULT)) < 0) ERR;
      if ((grpid = H5Gopen(fileid, GRP_NAME)) < 0) ERR;
      if ((datasetid = H5Dopen1(grpid, VAR_BOOL_NAME)) < 0) ERR;
      if ((propid = H5Dget_create_plist(datasetid)) < 0) ERR;

      /* The possible values of filter (which is just an int) can be
       * found in H5Zpublic.h. */
      if ((num_filters = H5Pget_nfilters(propid)) < 0) ERR;
      if (num_filters != 1) ERR;
      if ((filter = H5Pget_filter2(propid, 0, &flags, &cd_nelems, cd_values,
				  namelen, name, &filter_config)) < 0) ERR;
      if (filter != H5Z_FILTER_DEFLATE || cd_nelems != 1 ||
	  cd_values[0] != DEFLATE_LEVEL || strcmp(name, DEFLATE_NAME)) ERR;

      if (H5Dclose(datasetid) < 0 ||
	  H5Pclose(propid) < 0 ||
	  H5Gclose(grpid) < 0 ||
	  H5Fclose(fileid) < 0)
	 ERR;
   }

   SUMMARIZE_ERR;
   printf("*** Checking HDF5 deflate, fletcher32, shuffle filter setting and getting...");
   {
      H5Z_filter_t filter;
      int num_filters;
      hid_t propid;
      unsigned int flags, cd_values[NUM_CD_ELEM], filter_config;
      size_t cd_nelems = NUM_CD_ELEM;
      size_t namelen = MAX_NAME;
      char name[MAX_NAME + 1];
      int found_shuffle = 0, found_fletcher32 = 0, found_deflate = 0;
      int f;

      /* Open file and create group. */
      if ((fileid = H5Fcreate(FILE_NAME, H5F_ACC_TRUNC, H5P_DEFAULT,
			      H5P_DEFAULT)) < 0) ERR;
      if ((grpid = H5Gcreate(fileid, GRP_NAME, 0)) < 0) ERR;

      /* Write an array of bools, with compression, fletcher32
       * checksum, shuffle filters. Like a hoogie with "the works." */
      dims[0] = DIM1_LEN;
      if ((propid = H5Pcreate(H5P_DATASET_CREATE)) < 0) ERR;
      if (H5Pset_layout(propid, H5D_CHUNKED)) ERR;
      if (H5Pset_chunk(propid, 1, dims)) ERR;
      if (H5Pset_shuffle(propid)) ERR;
      if (H5Pset_deflate(propid, DEFLATE_LEVEL)) ERR;
      if (H5Pset_fletcher32(propid)) ERR;
      if ((spaceid = H5Screate_simple(1, dims, dims)) < 0) ERR;
      if ((datasetid = H5Dcreate(grpid, VAR_BOOL_NAME, H5T_NATIVE_HBOOL,
				 spaceid, propid)) < 0) ERR;
      if (H5Dwrite(datasetid, H5T_NATIVE_HBOOL, H5S_ALL, H5S_ALL, H5P_DEFAULT,
		   bool_out) < 0) ERR;
      if (H5Dclose(datasetid) < 0 ||
	  H5Pclose(propid) < 0 ||
	  H5Sclose(spaceid) < 0 ||
	  H5Gclose(grpid) < 0 ||
	  H5Fclose(fileid) < 0)
	 ERR;

      /* Now reopen the file and check. */
      if ((fileid = H5Fopen(FILE_NAME, H5F_ACC_RDONLY, H5P_DEFAULT)) < 0) ERR;
      if ((grpid = H5Gopen(fileid, GRP_NAME)) < 0) ERR;
      if ((datasetid = H5Dopen1(grpid, VAR_BOOL_NAME)) < 0) ERR;
      if ((propid = H5Dget_create_plist(datasetid)) < 0) ERR;

      /* The possible values of filter (which is just an int) can be
       * found in H5Zpublic.h. */
      if ((num_filters = H5Pget_nfilters(propid)) < 0) ERR;
      if (num_filters != 3) ERR;
      for (f = 0; f < num_filters; f++)
      {
	 if ((filter = H5Pget_filter2(propid, f, &flags, &cd_nelems, cd_values,
				      namelen, name, &filter_config)) < 0) ERR;
	 switch (filter)
	 {
	    case H5Z_FILTER_SHUFFLE:
	       found_shuffle++;
	       break;
	    case H5Z_FILTER_FLETCHER32:
	       found_fletcher32++;
	       break;
	    case H5Z_FILTER_DEFLATE:
	       found_deflate++;
	       if (cd_nelems != 1 || cd_values[0] != DEFLATE_LEVEL ||
		   strcmp(name, DEFLATE_NAME)) ERR;
	       break;
	    default:
	       break;
	 }
      }
      if (!found_fletcher32 || !found_deflate || !found_shuffle) ERR;

      if (H5Dclose(datasetid) < 0 ||
	  H5Pclose(propid) < 0 ||
	  H5Gclose(grpid) < 0 ||
	  H5Fclose(fileid) < 0)
	 ERR;
   }

   SUMMARIZE_ERR;
   printf("*** Checking HDF5 endianness control...");

#define NATIVE_VAR_NAME "native_var"
#define LE_VAR_NAME "le_var"
#define BE_VAR_NAME "be_var"
   {
      int data[DIM1_LEN], data_in[DIM1_LEN];
      hid_t typeid, native_typeid;
      hid_t native_did, le_did, be_did;
      H5T_order_t order;
      htri_t equal;
      int i;

      for (i = 0; i < DIM1_LEN; i++)
	 data[i] = i;

      /* Open file and create group. */
      if ((fileid = H5Fcreate(FILE_NAME, H5F_ACC_TRUNC, H5P_DEFAULT,
			      H5P_DEFAULT)) < 0) ERR;
      if ((grpid = H5Gcreate(fileid, GRP_NAME, 0)) < 0) ERR;

      /* Create a dataset of native endian. */
      dims[0] = DIM1_LEN;
      if ((spaceid = H5Screate_simple(1, dims, dims)) < 0) ERR;
      if ((native_did = H5Dcreate(grpid, NATIVE_VAR_NAME, H5T_NATIVE_INT,
				  spaceid, H5P_DEFAULT)) < 0) ERR;
      if ((le_did = H5Dcreate(grpid, LE_VAR_NAME, H5T_STD_I32LE,
			      spaceid, H5P_DEFAULT)) < 0) ERR;
      if ((be_did = H5Dcreate(grpid, BE_VAR_NAME, H5T_STD_I32BE,
			      spaceid, H5P_DEFAULT)) < 0) ERR;
      if (H5Dwrite(native_did, H5T_NATIVE_INT, H5S_ALL, H5S_ALL, H5P_DEFAULT,
		   data) < 0) ERR;
      if (H5Dwrite(le_did, H5T_NATIVE_INT, H5S_ALL, H5S_ALL, H5P_DEFAULT,
		   data) < 0) ERR;
      if (H5Dwrite(be_did, H5T_NATIVE_INT, H5S_ALL, H5S_ALL, H5P_DEFAULT,
		   data) < 0) ERR;
      if (H5Dclose(native_did) < 0 ||
	  H5Dclose(le_did) < 0 ||
	  H5Dclose(be_did) < 0 ||
	  H5Sclose(spaceid) < 0 ||
	  H5Gclose(grpid) < 0 ||
	  H5Fclose(fileid) < 0)
	 ERR;

      /* Now reopen the file and check. */
      if ((fileid = H5Fopen(FILE_NAME, H5F_ACC_RDONLY, H5P_DEFAULT)) < 0) ERR;
      if ((grpid = H5Gopen(fileid, GRP_NAME)) < 0) ERR;

      if ((native_did = H5Dopen1(grpid, NATIVE_VAR_NAME)) < 0) ERR;
      if ((typeid = H5Dget_type(native_did)) < 0) ERR;
      if ((native_typeid = H5Tget_native_type(typeid, H5T_DIR_DESCEND)) < 0) ERR;
      if ((order = H5Tget_order(typeid)) < 0) ERR;
      if ((equal = H5Tequal(typeid, native_typeid)) < 0) ERR;
      if (!equal) ERR;

      if (H5Dread(native_did, H5T_NATIVE_INT, H5S_ALL, H5S_ALL, H5P_DEFAULT,
		   data_in) < 0) ERR;
      for (i = 0; i < DIM1_LEN; i++)
	 if (data[i] != data_in[i]) ERR;

      if ((le_did = H5Dopen1(grpid, LE_VAR_NAME)) < 0) ERR;
      if ((typeid = H5Dget_type(le_did)) < 0) ERR;
      if ((order = H5Tget_order(typeid)) < 0) ERR;
      if (order != H5T_ORDER_LE) ERR;

      if (H5Dread(le_did, H5T_NATIVE_INT, H5S_ALL, H5S_ALL, H5P_DEFAULT,
		   data_in) < 0) ERR;
      for (i = 0; i < DIM1_LEN; i++)
	 if (data[i] != data_in[i]) ERR;

      if ((be_did = H5Dopen1(grpid, BE_VAR_NAME)) < 0) ERR;
      if ((typeid = H5Dget_type(be_did)) < 0) ERR;
      if ((order = H5Tget_order(typeid)) < 0) ERR;
      if (order != H5T_ORDER_BE) ERR;

      if (H5Dread(be_did, H5T_NATIVE_INT, H5S_ALL, H5S_ALL, H5P_DEFAULT,
		   data_in) < 0) ERR;
      for (i = 0; i < DIM1_LEN; i++)
	 if (data[i] != data_in[i]) ERR;

      if (H5Dclose(native_did) < 0 ||
	  H5Dclose(le_did) < 0 ||
	  H5Dclose(be_did) < 0 ||
	  H5Gclose(grpid) < 0 ||
	  H5Fclose(fileid) < 0)
	 ERR;
   }

   SUMMARIZE_ERR;
   FINAL_RESULTS;
}