diff options
author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2016-04-13 18:48:16 (GMT) |
---|---|---|
committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2016-04-13 18:48:16 (GMT) |
commit | d9c4a4c747908d3fdfd7e8bbef13635b2f4d5a60 (patch) | |
tree | cd558dbf5fe5d25d0965251d2ba14924c446d526 /hl/src | |
parent | 933adde73a7a2cf25bb0716a275ebff56807bf11 (diff) | |
download | hdf5-d9c4a4c747908d3fdfd7e8bbef13635b2f4d5a60.zip hdf5-d9c4a4c747908d3fdfd7e8bbef13635b2f4d5a60.tar.gz hdf5-d9c4a4c747908d3fdfd7e8bbef13635b2f4d5a60.tar.bz2 |
[svn-r29690] Purpose: Merge PT improvements from trunk
Description:
Merged from trunk:
r29269: Improve Packet Table library
r29295: Replaced H5Acreate with H5Acreate2 (by Larry)
r29360: Adding missing tests
r29364: Improve C++ Packet Table library
r29554: Removed extra line in Copyright
Platforms tested:
Linux/32 2.6 (jam)
Linux/64 (platypus)
Darwin (osx1010test)
Diffstat (limited to 'hl/src')
-rw-r--r-- | hl/src/H5PT.c | 528 | ||||
-rw-r--r-- | hl/src/H5PTpublic.h | 68 |
2 files changed, 370 insertions, 226 deletions
diff --git a/hl/src/H5PT.c b/hl/src/H5PT.c index 6ed1ac0..e2d6a3d 100644 --- a/hl/src/H5PT.c +++ b/hl/src/H5PT.c @@ -48,15 +48,15 @@ static herr_t H5PT_get_index(htbl_t *table_id, hsize_t *pt_index); */ /*------------------------------------------------------------------------- - * Function: H5PTcreate_fl + * Function: H5PTcreate * * Purpose: Creates a dataset containing a table and returns the Identifier - * of the table. + * of the table. (Copied mostly from H5PTcreate_fl) * - * Return: Success: table ID, Failure: Negative + * Return: Success: table ID, Failure: FAIL * - * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu - * James Laird, jlaird@ncsa.uiuc.edu + * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu (Author of H5PTcreate_fl) + * James Laird, jlaird@ncsa.uiuc.edu (Author of H5PTcreate_fl) * * Date: March 12, 2004 * @@ -65,80 +65,93 @@ static herr_t H5PT_get_index(htbl_t *table_id, hsize_t *pt_index); * table is initially of size 0. * * Modifications: + * Mar 1, 2016 + * This function is added to replace H5PTcreate_fl and it differs + * from H5PTcreate_fl only because its last argument is plist_id + * instead of compression; this is to allow flexible compression. + * -BMR * *------------------------------------------------------------------------- */ - -hid_t H5PTcreate_fl ( hid_t loc_id, - const char *dset_name, - hid_t dtype_id, - hsize_t chunk_size, - int compression ) +hid_t H5PTcreate(hid_t loc_id, + const char *dset_name, + hid_t dtype_id, + hsize_t chunk_size, + hid_t plist_id) { htbl_t * table = NULL; - hid_t dset_id = H5I_BADID; - hid_t space_id = H5I_BADID; - hid_t plist_id = H5I_BADID; + hid_t dset_id = H5I_INVALID_HID; + hid_t space_id = H5I_INVALID_HID; + hid_t plistcopy_id = H5I_INVALID_HID; hsize_t dims[1]; hsize_t dims_chunk[1]; hsize_t maxdims[1]; - hid_t ret_value; + hid_t ret_value = H5I_INVALID_HID; /* check the arguments */ if (dset_name == NULL) { - goto out; + goto error; } /* Register the packet table ID type if this is the first table created */ if(H5PT_ptable_id_type < 0) if((H5PT_ptable_id_type = H5Iregister_type((size_t)H5PT_HASH_TABLE_SIZE, 0, (H5I_free_t)H5PT_free_id)) < 0) - goto out; + goto error; /* Get memory for the table identifier */ table = (htbl_t *)HDmalloc(sizeof(htbl_t)); + if ( table == NULL ) { + goto error; + } + table->dset_id = H5I_INVALID_HID; + table->type_id = H5I_INVALID_HID; /* Create a simple data space with unlimited size */ dims[0] = 0; dims_chunk[0] = chunk_size; maxdims[0] = H5S_UNLIMITED; if((space_id = H5Screate_simple(1, dims, maxdims)) < 0) - goto out; + goto error; /* Modify dataset creation properties to enable chunking */ - plist_id = H5Pcreate(H5P_DATASET_CREATE); - if(H5Pset_chunk(plist_id, 1, dims_chunk) < 0) - goto out; - if(compression >= 0 && compression <= 9) - if(H5Pset_deflate(plist_id, (unsigned)compression) < 0) - goto out; + if (plist_id == H5P_DEFAULT) { + plistcopy_id = H5Pcreate(H5P_DATASET_CREATE); + } + else { + plistcopy_id = H5Pcopy(plist_id); + } + if (chunk_size > 0) + { + if(H5Pset_chunk(plistcopy_id, 1, dims_chunk) < 0) + goto error; + } /* Create the dataset. */ - if((dset_id = H5Dcreate2(loc_id, dset_name, dtype_id, space_id, H5P_DEFAULT, plist_id, H5P_DEFAULT)) < 0) - goto out; + if((dset_id = H5Dcreate2(loc_id, dset_name, dtype_id, space_id, H5P_DEFAULT, plistcopy_id, H5P_DEFAULT)) < 0) + goto error; + + /* Create the table identifier */ + table->dset_id = dset_id; /* Terminate access to the data space. */ if(H5Sclose(space_id) < 0) - goto out; + goto error; /* End access to the property list */ - if(H5Pclose(plist_id) < 0) - goto out; - - /* Create the table identifier */ - table->dset_id = dset_id; + if(H5Pclose(plistcopy_id) < 0) + goto error; if((table->type_id = H5Tcopy(dtype_id)) < 0) - goto out; + goto error; if((table->type_id = H5Tget_native_type(table->type_id, H5T_DIR_DEFAULT)) < 0) - goto out; + goto error; H5PT_create_index(table); table->size = 0; /* Get an ID for this table */ ret_value = H5Iregister(H5PT_ptable_id_type, table); - if(ret_value != H5I_INVALID_HID) H5PT_ptable_count++; else @@ -146,32 +159,38 @@ hid_t H5PTcreate_fl ( hid_t loc_id, return ret_value; - out: - H5E_BEGIN_TRY - H5Sclose(space_id); - H5Pclose(plist_id); - H5Dclose(dset_id); - if(table) - HDfree(table); - H5E_END_TRY - return H5I_INVALID_HID; -} +error: + if (space_id != H5I_INVALID_HID) + H5Sclose(space_id); + if (plistcopy_id != H5I_INVALID_HID) + H5Pclose(plistcopy_id); + if (dset_id != H5I_INVALID_HID) + H5Dclose(dset_id); + if (table) + { + if (table->type_id != H5I_INVALID_HID) + H5Tclose(table->type_id); + HDfree(table); + } + + return ret_value; +} /* H5PTcreate */ + -#ifdef H5_VLPT_ENABLED /*------------------------------------------------------------------------- - * Function: H5PTcreate_vl + * Function: H5PTcreate_fl * - * Purpose: Creates a dataset containing a table of variable length records - * and returns the Identifier of the table. + * Purpose: Creates a dataset containing a table and returns the Identifier + * of the table. * * Return: Success: table ID, Failure: Negative * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu * James Laird, jlaird@ncsa.uiuc.edu * - * Date: April 12, 2004 + * Date: March 12, 2004 * - * Comments: This function does not handle compression or fill data + * Comments: This function does not handle fill data * currently. Fill data is not necessary because the * table is initially of size 0. * @@ -179,38 +198,104 @@ hid_t H5PTcreate_fl ( hid_t loc_id, * *------------------------------------------------------------------------- */ -hid_t H5PTcreate_vl ( hid_t loc_id, - const char*dset_name, - hsize_t chunk_size) + +hid_t H5PTcreate_fl ( hid_t loc_id, + const char *dset_name, + hid_t dtype_id, + hsize_t chunk_size, + int compression ) { - hid_t ret_value=H5I_BADID; - hid_t vltype; + htbl_t * table = NULL; + hid_t dset_id = H5I_INVALID_HID; + hid_t space_id = H5I_INVALID_HID; + hid_t plist_id = H5I_INVALID_HID; + hsize_t dims[1]; + hsize_t dims_chunk[1]; + hsize_t maxdims[1]; + hid_t ret_value = H5I_INVALID_HID; /* check the arguments */ if (dset_name == NULL) { - goto out; + goto error; + } + + /* Register the packet table ID type if this is the first table created */ + if(H5PT_ptable_id_type < 0) + if((H5PT_ptable_id_type = H5Iregister_type((size_t)H5PT_HASH_TABLE_SIZE, 0, (H5I_free_t)H5PT_free_id)) < 0) + goto error; + + /* Get memory for the table identifier */ + table = (htbl_t *)HDmalloc(sizeof(htbl_t)); + if ( table == NULL ) { + goto error; } + table->dset_id = H5I_INVALID_HID; + table->type_id = H5I_INVALID_HID; + + /* Create a simple data space with unlimited size */ + dims[0] = 0; + dims_chunk[0] = chunk_size; + maxdims[0] = H5S_UNLIMITED; + if((space_id = H5Screate_simple(1, dims, maxdims)) < 0) + goto error; + + /* Modify dataset creation properties to enable chunking */ + plist_id = H5Pcreate(H5P_DATASET_CREATE); + if(H5Pset_chunk(plist_id, 1, dims_chunk) < 0) + goto error; + if(compression >= 0 && compression <= 9) + if(H5Pset_deflate(plist_id, (unsigned)compression) < 0) + goto error; + + /* Create the dataset. */ + if((dset_id = H5Dcreate2(loc_id, dset_name, dtype_id, space_id, H5P_DEFAULT, plist_id, H5P_DEFAULT)) < 0) + goto error; - /* Create a variable length type that uses single bytes as its base type */ - vltype = H5Tvlen_create(H5T_NATIVE_UCHAR); - if(vltype < 0) - goto out; + /* Create the table identifier */ + table->dset_id = dset_id; - if((ret_value=H5PTcreate_fl(loc_id, dset_name, vltype, chunk_size, 0)) < 0) - goto out; + /* Terminate access to the data space. */ + if(H5Sclose(space_id) < 0) + goto error; - /* close the vltype */ - if(H5Tclose(vltype) < 0) - goto out; + /* End access to the property list */ + if(H5Pclose(plist_id) < 0) + goto error; + + if((table->type_id = H5Tcopy(dtype_id)) < 0) + goto error; + + if((table->type_id = H5Tget_native_type(table->type_id, H5T_DIR_DEFAULT)) < 0) + goto error; + + H5PT_create_index(table); + table->size = 0; + + /* Get an ID for this table */ + ret_value = H5Iregister(H5PT_ptable_id_type, table); + if(ret_value != H5I_INVALID_HID) + H5PT_ptable_count++; + else + H5PT_close(table); return ret_value; -out: - if(ret_value != H5I_BADID) - H5PTclose(ret_value); - return H5I_BADID; -} -#endif /* H%_VLPT_ENABLED */ +error: + if (space_id != H5I_INVALID_HID) + H5Sclose(space_id); + if (plist_id != H5I_INVALID_HID) + H5Pclose(plist_id); + if (dset_id != H5I_INVALID_HID) + H5Dclose(dset_id); + if (table) + { + if (table->type_id != H5I_INVALID_HID) + H5Tclose(table->type_id); + HDfree(table); + } + + return ret_value; +} /* H5PTcreate_fl */ /*------------------------------------------------------------------------- * Function: H5PTopen @@ -239,58 +324,59 @@ out: hid_t H5PTopen( hid_t loc_id, const char *dset_name ) { - hid_t type_id=H5I_BADID; - hid_t space_id=H5I_BADID; + hid_t type_id=H5I_INVALID_HID; + hid_t space_id=H5I_INVALID_HID; htbl_t * table = NULL; - hid_t ret_value; hsize_t dims[1]; + hid_t ret_value = H5I_INVALID_HID; /* check the arguments */ if (dset_name == NULL) { - goto out; + goto error; } /* Register the packet table ID type if this is the first table created */ if( H5PT_ptable_id_type < 0) if((H5PT_ptable_id_type = H5Iregister_type((size_t)H5PT_HASH_TABLE_SIZE, 0, (H5I_free_t)H5PT_free_id)) < 0) - goto out; + goto error; table = (htbl_t *)HDmalloc(sizeof(htbl_t)); - if ( table == NULL ) { - goto out; + goto error; } - table->dset_id = H5I_BADID; - table->type_id = H5I_BADID; + table->dset_id = H5I_INVALID_HID; + table->type_id = H5I_INVALID_HID; /* Open the dataset */ if((table->dset_id = H5Dopen2(loc_id, dset_name, H5P_DEFAULT)) < 0) - goto out; - if(table->dset_id < 0) - goto out; + goto error; /* Get the dataset's disk datatype */ if((type_id = H5Dget_type(table->dset_id)) < 0) - goto out; + goto error; /* Get the table's native datatype */ if((table->type_id = H5Tget_native_type(type_id, H5T_DIR_ASCEND)) < 0) - goto out; + goto error; + /* Close the disk datatype */ if(H5Tclose(type_id) < 0) - goto out; + goto error; + type_id = H5I_INVALID_HID; /* Initialize the current record pointer */ if((H5PT_create_index(table)) < 0) - goto out; + goto error; /* Get number of records in table */ if((space_id=H5Dget_space(table->dset_id)) < 0) - goto out; - if( H5Sget_simple_extent_dims( space_id, dims, NULL) < 0) - goto out; + goto error; + if(H5Sget_simple_extent_dims(space_id, dims, NULL) < 0) + goto error; if(H5Sclose(space_id) < 0) - goto out; + goto error; + space_id = H5I_INVALID_HID; + table->size = dims[0]; /* Get an ID for this table */ @@ -303,33 +389,36 @@ hid_t H5PTopen( hid_t loc_id, return ret_value; -out: - H5E_BEGIN_TRY - H5Tclose(type_id); - H5Sclose(space_id); - if(table) - { - H5Dclose(table->dset_id); - H5Tclose(table->type_id); - HDfree(table); - } - H5E_END_TRY - return H5I_INVALID_HID; -} +error: + if (type_id != H5I_INVALID_HID) + H5Dclose(type_id); + if (space_id != H5I_INVALID_HID) + H5Sclose(space_id); + if(table) + { + if (table->type_id != H5I_INVALID_HID) + H5Tclose(table->type_id); + if (table->dset_id != H5I_INVALID_HID) + H5Dclose(table->dset_id); + HDfree(table); + } + + return ret_value; +} /* H5PTopen */ /*------------------------------------------------------------------------- * Function: H5PT_free_id * * Purpose: Free an id. Callback for H5Iregister_type. * - * Return: Success: 0, Failure: N/A + * Return: Success: SUCCEED, Failure: N/A *------------------------------------------------------------------------- */ static herr_t H5PT_free_id(void *id) { HDfree(id); - return 0; + return SUCCEED; } /*------------------------------------------------------------------------- @@ -338,7 +427,7 @@ H5PT_free_id(void *id) * Purpose: Closes a table (i.e. cleans up all open resources used by a * table). * - * Return: Success: 0, Failure: -1 + * Return: Success: SUCCEED, Failure: FAIL * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu * James Laird, jlaird@ncsa.uiuc.edu @@ -355,21 +444,21 @@ static herr_t H5PT_close( htbl_t* table) { if(table == NULL) - goto out; + goto error; /* Close the dataset */ if(H5Dclose(table->dset_id) < 0) - goto out; + goto error; /* Close the memory datatype */ if(H5Tclose(table->type_id) < 0) - goto out; + goto error; HDfree(table); - return 0; + return SUCCEED; -out: +error: if(table) { H5E_BEGIN_TRY @@ -378,7 +467,7 @@ out: H5E_END_TRY HDfree(table); } - return -1; + return FAIL; } /*------------------------------------------------------------------------- @@ -387,7 +476,7 @@ out: * Purpose: Closes a table (i.e. cleans up all open resources used by a * table). * - * Return: Success: 0, Failure: -1 + * Return: Success: SUCCEED, Failure: FAIL * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu * James Laird, jlaird@ncsa.uiuc.edu @@ -406,11 +495,11 @@ herr_t H5PTclose( hid_t table_id ) /* Remove the ID from the library */ if((table = (htbl_t *)H5Iremove_verify(table_id, H5PT_ptable_id_type)) ==NULL) - goto out; + goto error; /* If the library found the table, remove it */ if( H5PT_close(table) < 0) - goto out; + goto error; /* One less packet table open */ H5PT_ptable_count--; @@ -423,10 +512,10 @@ herr_t H5PTclose( hid_t table_id ) H5PT_ptable_id_type = H5I_UNINIT; } - return 0; + return SUCCEED; -out: - return -1; +error: + return FAIL; } @@ -442,7 +531,7 @@ out: * * Purpose: Appends packets to the end of a packet table * - * Return: Success: 0, Failure: -1 + * Return: Success: SUCCEED, Failure: FAIL * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu * James Laird, jlaird@ncsa.uiuc.edu @@ -463,22 +552,22 @@ herr_t H5PTappend( hid_t table_id, /* Find the table struct from its ID */ if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL) - goto out; + goto error; /* If we are asked to write 0 records, just do nothing */ if(nrecords == 0) - return 0; + return SUCCEED; if((H5TB_common_append_records(table->dset_id, table->type_id, nrecords, table->size, data)) < 0) - goto out; + goto error; /* Update table size */ table->size += nrecords; - return 0; + return SUCCEED; -out: - return -1; +error: + return FAIL; } /*------------------------------------------------------------------------- @@ -495,7 +584,7 @@ out: * Purpose: Reads packets starting at the current index and updates * that index * - * Return: Success: 0, Failure: -1 + * Return: Success: SUCCEED, Failure: FAIL * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu * James Laird, jlaird@ncsa.uiuc.edu @@ -517,22 +606,22 @@ herr_t H5PTget_next( hid_t table_id, /* Find the table struct from its ID */ if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL) - goto out; + goto error; /* If nrecords == 0, do nothing */ if(nrecords == 0) - return 0; + return SUCCEED; if((H5TB_common_read_records(table->dset_id, table->type_id, table->current_index, nrecords, table->size, data)) < 0) - goto out; + goto error; /* Update the current index */ table->current_index += nrecords; - return 0; + return SUCCEED; -out: - return -1; +error: + return FAIL; } /*------------------------------------------------------------------------- @@ -540,7 +629,7 @@ out: * * Purpose: Reads packets from anywhere in a packet table * - * Return: Success: 0, Failure: -1 + * Return: Success: SUCCEED, Failure: FAIL * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu * James Laird, jlaird@ncsa.uiuc.edu @@ -564,20 +653,20 @@ herr_t H5PTread_packets( hid_t table_id, /* find the table struct from its ID */ table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type); if(table == NULL) - goto out; + goto error; /* If nrecords == 0, do nothing */ if(nrecords == 0) - return 0; + return SUCCEED; if( H5TB_common_read_records(table->dset_id, table->type_id, start, nrecords, table->size, data) < 0) - goto out; + goto error; - return 0; + return SUCCEED; -out: - return -1; +error: + return FAIL; } /*------------------------------------------------------------------------- @@ -592,7 +681,7 @@ out: * * Purpose: Resets, sets, and gets the current record index for a packet table * - * Return: Success: 0, Failure: -1 + * Return: Success: SUCCEED, Failure: FAIL * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu * James Laird, jlaird@ncsa.uiuc.edu @@ -611,37 +700,37 @@ H5PT_create_index(htbl_t *table) if( table != NULL) { table->current_index = 0; - return 0; + return SUCCEED; } - return -1; + return FAIL; } static herr_t -H5PT_set_index(htbl_t *table, hsize_t index) +H5PT_set_index(htbl_t *table, hsize_t pt_index) { /* Ensure index is valid */ if( table != NULL ) { - if( index < table->size ) + if( pt_index < table->size ) { - table->current_index = index; - return 0; + table->current_index = pt_index; + return SUCCEED; } } - return -1; + return FAIL; } static herr_t -H5PT_get_index(htbl_t *table, hsize_t *index) +H5PT_get_index(htbl_t *table, hsize_t *pt_index) { /* Ensure index is valid */ if( table != NULL ) { - if(index) - *index = table->current_index; - return 0; + if(pt_index) + *pt_index = table->current_index; + return SUCCEED; } - return -1; + return FAIL; } /*------------------------------------------------------------------------- @@ -649,7 +738,7 @@ H5PT_get_index(htbl_t *table, hsize_t *index) * * Purpose: Resets, sets, and gets the current record index for a packet table * - * Return: Success: 0, Failure: -1 + * Return: Success: SUCCEED, Failure: FAIL * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu * James Laird, jlaird@ncsa.uiuc.edu @@ -668,7 +757,7 @@ herr_t H5PTcreate_index(hid_t table_id) /* find the table struct from its ID */ if((table = (htbl_t *) (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL) - return -1; + return FAIL; return H5PT_create_index(table); } @@ -679,7 +768,7 @@ herr_t H5PTset_index(hid_t table_id, hsize_t pt_index) /* find the table struct from its ID */ if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL) - return -1; + return FAIL; return H5PT_set_index(table, pt_index); } @@ -690,7 +779,7 @@ herr_t H5PTget_index(hid_t table_id, hsize_t *pt_index) /* find the table struct from its ID */ if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL) - return -1; + return FAIL; return H5PT_get_index(table, pt_index); } @@ -705,9 +794,9 @@ herr_t H5PTget_index(hid_t table_id, hsize_t *pt_index) /*------------------------------------------------------------------------- * Function: H5PTget_num_packets * - * Purpose: Returns by reference the number of packets in the dataset + * Purpose: Returns by reference the number of packets in the packet table * - * Return: Success: 0, Failure: -1 + * Return: Success: SUCCEED, Failure: FAIL * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu * James Laird, jlaird@ncsa.uiuc.edu @@ -727,14 +816,15 @@ herr_t H5PTget_num_packets( hid_t table_id, hsize_t *nrecords) /* find the table struct from its ID */ if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL) - goto out; + goto error; if(nrecords) *nrecords = table->size; - return 0; -out: - return -1; + return SUCCEED; + +error: + return FAIL; } @@ -743,7 +833,7 @@ out: * * Purpose: Validates a table identifier * - * Return: Success: 0, Failure: -1 + * Return: Success: SUCCEED, Failure: FAIL * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu * James Laird, jlaird@ncsa.uiuc.edu @@ -761,19 +851,18 @@ herr_t H5PTis_valid(hid_t table_id) { /* find the table struct from its ID */ if(H5Iobject_verify(table_id, H5PT_ptable_id_type) ==NULL) - return -1; + return FAIL; - return 0; + return SUCCEED; } -#ifdef H5_VLPT_ENABLED /*------------------------------------------------------------------------- * Function: H5PTis_varlen * * Purpose: Returns 1 if a table_id corresponds to a packet table of variable- * length records or 0 for fixed-length records. * - * Return: True: 1, False: 0, Failure: -1 + * Return: True: 1, False: 0, Failure: FAIL * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu * James Laird, jlaird@ncsa.uiuc.edu @@ -794,17 +883,18 @@ herr_t H5PTis_varlen(hid_t table_id) /* find the table struct from its ID */ if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL) - goto out; + goto error; if((type = H5Tget_class( table->type_id )) == H5T_NO_CLASS) - goto out; + goto error; if( type == H5T_VLEN ) return 1; else return 0; -out: - return -1; + +error: + return FAIL; } /*------------------------------------------------------------------------- @@ -815,12 +905,12 @@ out: */ /*------------------------------------------------------------------------- - * Function: H5PTfree_vlen_readbuff + * Function: H5PTfree_vlen_buff * * Purpose: Frees memory used when reading from a variable length packet * table. * - * Return: Success: 0, Failure: -1 + * Return: Success: SUCCEED, Failure: FAIL * -2 if memory was reclaimed but another error occurred * * Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu @@ -836,25 +926,25 @@ out: *------------------------------------------------------------------------- */ -herr_t H5PTfree_vlen_readbuff( hid_t table_id, +herr_t H5PTfree_vlen_buff( hid_t table_id, size_t _bufflen, void * buff ) { - hid_t space_id = H5I_BADID; + hid_t space_id = H5I_INVALID_HID; htbl_t * table; hsize_t bufflen = _bufflen; herr_t ret_value; /* find the table struct from its ID */ if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL) - goto out; + goto error; if((space_id = H5Screate_simple(1, &bufflen, NULL)) < 0) - goto out; + goto error; /* Free the memory. If this succeeds, ret_value should be 0. */ if((ret_value = H5Dvlen_reclaim(table->type_id, space_id, H5P_DEFAULT, buff)) < 0) - goto out; + goto error; /* If the dataspace cannot be closed, return -2 to indicate that memory */ /* was freed successfully but an error still occurred. */ @@ -863,11 +953,83 @@ herr_t H5PTfree_vlen_readbuff( hid_t table_id, return ret_value; -out: +error: H5E_BEGIN_TRY H5Sclose(space_id); H5E_END_TRY - return -1; + return FAIL; +} /* H5PTfree_vlen_buff */ + +/*------------------------------------------------------------------------- + * + * Accessor functions + * + *------------------------------------------------------------------------- + */ +/*------------------------------------------------------------------------- + * Function: H5PTget_dataset + * + * Purpose: Returns the backend dataset of this packet table + * + * Return: Success: SUCCEED, Failure: FAIL + * + * Programmer: User's patch 0003, HDFFV-8623. -BMR + * + * Date: Feb 10, 2016 + * + * Comments: + * + * Modifications: + * + * + *------------------------------------------------------------------------- + */ +hid_t H5PTget_dataset(hid_t table_id) +{ + htbl_t * table; + hid_t ret_value = H5I_INVALID_HID; + + /* find the table struct from its ID */ + if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL) + goto error; + + ret_value = table->dset_id; + +error: + + return ret_value; } -#endif /* H5_VLPT_ENABLED */ +/*------------------------------------------------------------------------- + * Function: H5PTget_type + * + * Purpose: Returns the backend type of this packet table + * + * Return: Success: datatype ID, Failure: H5I_INVALID_HID + * + * Programmer: User's patch 0003, HDFFV-8623. -BMR + * + * Date: Feb 10, 2016 + * + * Comments: + * + * Modifications: + * + * + *------------------------------------------------------------------------- + */ +hid_t H5PTget_type( hid_t table_id) +{ + htbl_t * table; + hid_t ret_value = H5I_INVALID_HID; + + /* find the table struct from its ID */ + if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL) + goto error; + + ret_value = table->type_id; + +error: + + return ret_value; +} diff --git a/hl/src/H5PTpublic.h b/hl/src/H5PTpublic.h index f919010..420275a 100644 --- a/hl/src/H5PTpublic.h +++ b/hl/src/H5PTpublic.h @@ -22,74 +22,58 @@ extern "C" { #endif /*------------------------------------------------------------------------- - * * Create/Open/Close functions - * *------------------------------------------------------------------------- */ +/* NOTE: H5PTcreate is replacing H5PTcreate_fl for better name due to the + removal of H5PTcreate_vl. H5PTcreate_fl may be retired in 1.8.19. */ +H5_HLDLL hid_t H5PTcreate(hid_t loc_id, const char *dset_name, + hid_t dtype_id, hsize_t chunk_size, hid_t plist_id); -H5_HLDLL hid_t H5PTcreate_fl ( hid_t loc_id, - const char *dset_name, - hid_t dtype_id, - hsize_t chunk_size, - int compression ); +H5_HLDLL hid_t H5PTopen(hid_t loc_id, const char *dset_name); -#ifdef VLPT_REMOVED -H5_HLDLL hid_t H5PTcreate_vl ( hid_t loc_id, - const char *dset_name, - hsize_t chunk_size ); -#endif /* VLPT_REMOVED */ +H5_HLDLL herr_t H5PTclose(hid_t table_id); -H5_HLDLL hid_t H5PTopen( hid_t loc_id, - const char *dset_name ); - -H5_HLDLL herr_t H5PTclose( hid_t table_id ); +/* This function may be removed from the packet table in release 1.8.19. */ +H5_HLDLL hid_t H5PTcreate_fl(hid_t loc_id, const char *dset_name, + hid_t dtype_id, hsize_t chunk_size, int compression); /*------------------------------------------------------------------------- - * * Write functions - * *------------------------------------------------------------------------- */ - -H5_HLDLL herr_t H5PTappend( hid_t table_id, - size_t nrecords, - const void * data ); +H5_HLDLL herr_t H5PTappend(hid_t table_id, size_t nrecords, const void *data); /*------------------------------------------------------------------------- - * * Read functions - * *------------------------------------------------------------------------- */ +H5_HLDLL herr_t H5PTget_next(hid_t table_id, size_t nrecords, void * data); +H5_HLDLL herr_t H5PTread_packets(hid_t table_id, hsize_t start, + size_t nrecords, void *data); -H5_HLDLL herr_t H5PTget_next( hid_t table_id, - size_t nrecords, - void * data ); +/*------------------------------------------------------------------------- + * Inquiry functions + *------------------------------------------------------------------------- + */ +H5_HLDLL herr_t H5PTget_num_packets(hid_t table_id, hsize_t *nrecords); -H5_HLDLL herr_t H5PTread_packets( hid_t table_id, - hsize_t start, - size_t nrecords, - void *data ); +H5_HLDLL herr_t H5PTis_valid(hid_t table_id); + +H5_HLDLL herr_t H5PTis_varlen(hid_t table_id); /*------------------------------------------------------------------------- * - * Inquiry functions + * Accessor functions * *------------------------------------------------------------------------- */ +H5_HLDLL hid_t H5PTget_dataset(hid_t table_id); -H5_HLDLL herr_t H5PTget_num_packets( hid_t table_id, - hsize_t *nrecords ); - -H5_HLDLL herr_t H5PTis_valid( hid_t table_id ); - -#ifdef VLPT_REMOVED -H5_HLDLL herr_t H5PTis_varlen( hid_t table_id ); -#endif /* VLPT_REMOVED */ +H5_HLDLL hid_t H5PTget_type(hid_t table_id); /*------------------------------------------------------------------------- * @@ -113,11 +97,9 @@ H5_HLDLL herr_t H5PTget_index( hid_t table_id, *------------------------------------------------------------------------- */ -#ifdef VLPT_REMOVED -H5_HLDLL herr_t H5PTfree_vlen_readbuff( hid_t table_id, +H5_HLDLL herr_t H5PTfree_vlen_buff( hid_t table_id, size_t bufflen, void * buff ); -#endif /* VLPT_REMOVED */ #ifdef __cplusplus } |