diff options
Diffstat (limited to 'src/H5X.c')
| -rw-r--r-- | src/H5X.c | 685 |
1 files changed, 685 insertions, 0 deletions
diff --git a/src/H5X.c b/src/H5X.c new file mode 100644 index 0000000..9ca9289 --- /dev/null +++ b/src/H5X.c @@ -0,0 +1,685 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * 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 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. * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +/* + * Purpose: Index routines. + */ + +/****************/ +/* Module Setup */ +/****************/ + +#define H5X_PACKAGE /* Suppress error about including H5Xpkg */ + +/* Interface initialization */ +#define H5_INTERFACE_INIT_FUNC H5X_init_interface + +/***********/ +/* Headers */ +/***********/ +#include "H5private.h" /* Generic Functions */ +#include "H5Eprivate.h" /* Error handling */ +#include "H5Iprivate.h" /* IDs */ +#include "H5MMprivate.h" /* Memory management */ +#include "H5Pprivate.h" /* Property lists */ +#include "H5VLprivate.h" /* VOL plugins */ +#include "H5ESprivate.h" + +#include "H5FFprivate.h" /* FF */ +#include "H5Xpkg.h" /* Index plugins */ + +/****************/ +/* Local Macros */ +/****************/ + +/******************/ +/* Local Typedefs */ +/******************/ + +/********************/ +/* Local Prototypes */ +/********************/ + +/*********************/ +/* Package Variables */ +/*********************/ + +/*****************************/ +/* Library Private Variables */ +/*****************************/ + +/*******************/ +/* Local Variables */ +/*******************/ +static size_t H5X_table_alloc_g = 0; +static size_t H5X_table_used_g = 0; +static H5X_class_t *H5X_table_g = NULL; + + +static H5_inline hbool_t +H5X__registered(unsigned plugin_id, size_t *index) +{ + size_t plugin_index; + hbool_t registered = FALSE; + + /* Is the filter already registered? */ + for (plugin_index = 0; plugin_index < H5X_table_used_g; plugin_index++) { + if (H5X_table_g[plugin_index].id == plugin_id) { + registered = TRUE; + if (index) *index = plugin_index; + break; + } + } + + return registered; +} + +/*------------------------------------------------------------------------- + * Function: H5X_init + * + * Purpose: Initialize the interface from some other package. + * + * Return: Success: non-negative + * Failure: negative + * + *------------------------------------------------------------------------- + */ +herr_t +H5X_init(void) +{ + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_NOAPI(FAIL) + /* FUNC_ENTER() does all the work */ + +done: + FUNC_LEAVE_NOAPI(ret_value) +} /* end H5X_init() */ + +/*-------------------------------------------------------------------------- +NAME + H5X_init_interface -- Initialize interface-specific information +USAGE + herr_t H5X_init_interface() + +RETURNS + Non-negative on success/Negative on failure +DESCRIPTION + Initializes any interface-specific data or routines. + +--------------------------------------------------------------------------*/ +static herr_t +H5X_init_interface(void) +{ + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_NOAPI_NOINIT + +//#ifdef H5_HAVE_INDEX_PLUGIN_DUMMY + if (H5X_register(H5X_DUMMY) < 0) + HGOTO_ERROR (H5E_PLINE, H5E_CANTINIT, FAIL, "unable to register dummy index plugin") +//#endif /* H5_HAVE_INDEX_PLUGIN_DUMMY */ + +done: + FUNC_LEAVE_NOAPI(ret_value) +} /* end H5X_init_interface() */ + +/*-------------------------------------------------------------------------- + NAME + H5X_term_interface + PURPOSE + Terminate various H5X objects + USAGE + void H5X_term_interface() + RETURNS + Non-negative on success/Negative on failure + DESCRIPTION + Release the atom group and any other resources allocated. + GLOBAL VARIABLES + COMMENTS, BUGS, ASSUMPTIONS + Can't report errors... + EXAMPLES + REVISION LOG +--------------------------------------------------------------------------*/ +int +H5X_term_interface(void) +{ + int n = 0; + + FUNC_ENTER_NOAPI_NOINIT_NOERR + + if (H5_interface_initialize_g) { + /* Free the table of filters */ + H5X_table_g = (H5X_class_t *) H5MM_xfree(H5X_table_g); + H5X_table_used_g = H5X_table_alloc_g = 0; + + /* Shut down interface */ + H5_interface_initialize_g = 0; + } /* end if */ + + FUNC_LEAVE_NOAPI(n) +} /* end H5X_term_interface() */ + +/*------------------------------------------------------------------------- + * Function: H5X_registered + * + * Purpose: Get registered plugin index class from plugin ID. + * + * Return: Success: pointer to registered index class + * Failure: NULL + * + *------------------------------------------------------------------------- + */ +H5X_class_t * +H5X_registered(unsigned plugin_id) +{ + H5X_class_t *ret_value = NULL; + size_t plugin_index; + + FUNC_ENTER_NOAPI_NOINIT + + if (H5X__registered(plugin_id, &plugin_index)) { + ret_value = &H5X_table_g[plugin_index]; + } + +done: + FUNC_LEAVE_NOAPI(ret_value) +} + +/*------------------------------------------------------------------------- + * Function: H5Xregister + * + * Purpose: This function registers new index classes. + * + * Return: Non-negative on success/Negative on failure + * + *------------------------------------------------------------------------- + */ +herr_t +H5Xregister(const H5X_class_t *index_class) +{ + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_API(FAIL) + + /* Check args */ + if (!index_class) + HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid index plugin class"); + if (index_class->version != H5X_CLASS_T_VERS) + HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid index plugin version number"); + if ((index_class->id < 0) || (index_class->id > H5X_PLUGIN_MAX)) + HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid index plugin identification number"); + if (index_class->id < H5X_PLUGIN_RESERVED) + HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "unable to modify predefined index plugins"); + + /* Do or do not. There is no try. */ + if (H5X_register(index_class) < 0) + HGOTO_ERROR (H5E_PLINE, H5E_CANTINIT, FAIL, "unable to register index") + +done: + FUNC_LEAVE_API(ret_value) +} /* end H5Xregister() */ + +/*------------------------------------------------------------------------- + * Function: H5X_register + * + * Purpose: Same as the public version except this one allows plugins + * to be set for predefined method numbers < H5X_INDEX_RESERVED + * + * Return: Non-negative on success/Negative on failure + * + *------------------------------------------------------------------------- + */ +herr_t +H5X_register(const H5X_class_t *index_class) +{ + size_t i; + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_NOAPI_NOINIT + + HDassert(index_class); + HDassert(index_class->id >= 0 && index_class->id <= H5X_PLUGIN_MAX); + + /* Is the index class already registered? */ + for (i = 0; i < H5X_table_used_g; i++) + if (H5X_table_g[i].id == index_class->id) + break; + + /* Filter not already registered */ + if (i >= H5X_table_used_g) { + if (H5X_table_used_g >= H5X_table_alloc_g) { + size_t n = MAX(H5X_MAX_NPLUGINS, 2 * H5X_table_alloc_g); + H5X_class_t *table = (H5X_class_t *) H5MM_realloc(H5X_table_g, + n * sizeof(H5X_class_t)); + if(!table) + HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "unable to extend index plugin table"); + H5X_table_g = table; + H5X_table_alloc_g = n; + } /* end if */ + + /* Initialize */ + i = H5X_table_used_g++; + HDmemcpy(H5X_table_g + i, index_class, sizeof(H5X_class_t)); + } /* end if */ + else { /* Filter already registered */ + /* Replace old contents */ + HDmemcpy(H5X_table_g + i, index_class, sizeof(H5X_class_t)); + } /* end else */ + +done: + FUNC_LEAVE_NOAPI(ret_value) +} /* end H5X_register() */ + +/*------------------------------------------------------------------------- + * Function: H5Xunregister + * + * Purpose: This function unregisters an index class. + * + * Return: Non-negative on success/Negative on failure + * + *------------------------------------------------------------------------- + */ +herr_t +H5Xunregister(unsigned plugin_id) +{ + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_API(FAIL) + + /* Check args */ + if ((plugin_id < 0) || (plugin_id > H5X_PLUGIN_MAX)) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid filter identification number"); + if (plugin_id < H5X_PLUGIN_RESERVED) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "unable to modify predefined index plugins"); + + /* Do it */ + if (H5X_unregister(plugin_id) < 0) + HGOTO_ERROR(H5E_PLINE, H5E_CANTINIT, FAIL, "unable to unregister index plugin"); + +done: + FUNC_LEAVE_API(ret_value) +} /* end H5Xunregister() */ + +/*------------------------------------------------------------------------- + * Function: H5X_unregister + * + * Purpose: Same as the public version except this one allows plugins + * to be unset for predefined method numbers < H5X_PLUGIN_RESERVED + * + * Return: Non-negative on success/Negative on failure + * + *------------------------------------------------------------------------- + */ +herr_t +H5X_unregister(unsigned plugin_id) +{ + size_t plugin_index; /* Local index variable for filter */ +// H5X_object_t object; + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_NOAPI_NOINIT + + HDassert((plugin_id >= 0) && (plugin_id <= H5X_PLUGIN_MAX)); + + /* Is the plugin already registered? */ + if (FALSE == H5X__registered(plugin_id, &plugin_index)) + HGOTO_ERROR(H5E_PLINE, H5E_NOTFOUND, FAIL, "plugin is not registered") + + /* Initialize the structure object for iteration */ +// object.plugin_id = plugin_id; +// object.found = FALSE; + + /* Iterate through all opened datasets, returns a failure if any of them uses the filter */ +// if(H5I_iterate(H5I_DATASET, H5Z__check_unregister_dset_cb, &object, FALSE) < 0) +// HGOTO_ERROR(H5E_FILE, H5E_BADITER, FAIL, "iteration failed") + +// if(object.found) +// HGOTO_ERROR(H5E_PLINE, H5E_CANTRELEASE, FAIL, "can't unregister plugin because a dataset is still using it") + + /* Iterate through all opened groups, returns a failure if any of them uses the filter */ +// if(H5I_iterate(H5I_GROUP, H5Z__check_unregister_group_cb, &object, FALSE) < 0) +// HGOTO_ERROR(H5E_FILE, H5E_BADITER, FAIL, "iteration failed") + +// if(object.found) +// HGOTO_ERROR(H5E_PLINE, H5E_CANTRELEASE, FAIL, "can't unregister plugin because a group is still using it") + + /* Iterate through all opened files and flush them */ +// if(H5I_iterate(H5I_FILE, H5Z__flush_file_cb, NULL, FALSE) < 0) +// HGOTO_ERROR(H5E_FILE, H5E_BADITER, FAIL, "iteration failed") + + /* Remove filter from table */ + /* Don't worry about shrinking table size (for now) */ + HDmemmove(&H5X_table_g[plugin_index], &H5X_table_g[plugin_index + 1], + sizeof(H5X_class_t) * ((H5X_table_used_g - 1) - plugin_index)); + + H5X_table_used_g--; + +done: + FUNC_LEAVE_NOAPI(ret_value) +} /* end H5X_unregister() */ + +/*------------------------------------------------------------------------- + * Function: H5Xcreate + * + * Purpose: Create a new index in a container. + * + * Return: Non-negative on success/Negative on failure + * + *------------------------------------------------------------------------- + */ +herr_t +H5Xcreate(hid_t file_id, unsigned plugin_id, hid_t scope_id, hid_t xcpl_id) +{ + void *file = NULL, *obj = NULL; + H5VL_t *vol_plugin = NULL; /* VOL plugin information */ + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_API(FAIL) + + /* Check args */ + if ((plugin_id < 0) || (plugin_id > H5X_PLUGIN_MAX)) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid plugin identification number"); + if (NULL == (file = (void *)H5I_object_verify(file_id, H5I_FILE))) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file ID"); + if (NULL == (obj = (void *) H5VL_get_object(scope_id))) + HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid object/file identifier"); + if (NULL == (vol_plugin = (H5VL_t *)H5I_get_aux(file_id))) + HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "ID does not contain VOL information"); + + /* TODO */ + /* Call H5VL layer */ +done: + FUNC_LEAVE_API(ret_value) +} /* end H5Xcreate() */ + +/*------------------------------------------------------------------------- + * Function: H5Xcreate_ff + * + * Purpose: Create a new index in a container. + * + * Return: Non-negative on success/Negative on failure + * + *------------------------------------------------------------------------- + */ +herr_t +H5Xcreate_ff(hid_t file_id, unsigned plugin_id, hid_t scope_id, hid_t xcpl_id, + hid_t trans_id, hid_t estack_id) +{ + H5_priv_request_t *request = NULL; /* private request struct inserted in event queue */ + void **req = NULL; /* pointer to plugin generate requests (NULL if VOL plugin does not support async) */ + void *idx_handle = NULL; /* pointer to index object created */ + void *file = NULL, *dset = NULL; + H5VL_t *vol_plugin = NULL; /* VOL plugin information */ + size_t plugin_index; + H5P_genplist_t *plist; + hid_t dataset_id = scope_id; /* TODO for now */ + hid_t xapl_id = H5P_INDEX_ACCESS_DEFAULT; /* TODO for now */ + size_t metadata_size; /* size of metadata created by plugin */ + void *metadata; /* metadata created by plugin that needs to be stored */ + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_API(FAIL) + + /* Check args */ + if ((plugin_id < 0) || (plugin_id > H5X_PLUGIN_MAX)) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid plugin identification number"); + if (NULL == (file = (void *) H5I_object_verify(file_id, H5I_FILE))) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file ID"); + if (NULL == H5I_object_verify(scope_id, H5I_DATASET)) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "scope_id is restricted to dataset ID"); + if (NULL == (dset = (void *) H5VL_get_object(scope_id))) + HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid object/file identifier"); + if (NULL == (vol_plugin = (H5VL_t *) H5I_get_aux(file_id))) + HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "ID does not contain VOL information"); + + /* Is the plugin already registered */ + if (FALSE == H5X__registered(plugin_id, &plugin_index)) + HGOTO_ERROR(H5E_INDEX, H5E_BADVALUE, FAIL, "plugin is not registered"); + + /* Get correct property list */ + if (H5P_DEFAULT == xcpl_id) + xcpl_id = H5P_INDEX_CREATE_DEFAULT; + else + if (TRUE != H5P_isa_class(xcpl_id, H5P_INDEX_CREATE)) + HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not index creation property list"); + + if (estack_id != H5_EVENT_STACK_NULL) { + /* create the private request */ + if (NULL == (request = (H5_priv_request_t *) H5MM_calloc(sizeof(H5_priv_request_t)))) + HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed") + request->req = NULL; + req = &request->req; + request->next = NULL; + request->vol_plugin = vol_plugin; + vol_plugin->nrefs ++; + } + + /* Store the transaction ID in the xapl_id */ + if (NULL == (plist = (H5P_genplist_t *)H5I_object(xapl_id))) + HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID") + if (H5P_set(plist, H5VL_TRANS_ID, &trans_id) < 0) + HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't set property value for trans_id") + + /* Call create of the plugin */ + if (NULL == (idx_handle = H5X_table_g[plugin_index].create( + file_id, dataset_id, xcpl_id, xapl_id, &metadata_size, &metadata))) + HGOTO_ERROR(H5E_INDEX, H5E_CANTCREATE, FAIL, "cannot create new plugin index"); + + /* Add idx_handle to dataset */ + if (FAIL == H5VL_iod_dataset_set_index(dset, idx_handle)) + HGOTO_ERROR(H5E_INDEX, H5E_CANTSET, FAIL, "cannot set index to dataset"); + if (FAIL == H5VL_iod_dataset_set_index_info(dset, plugin_id, + metadata_size, metadata, trans_id, req)) + HGOTO_ERROR(H5E_INDEX, H5E_CANTSET, FAIL, "cannot set index info to dataset"); + + if (request && *req) { + if(H5ES_insert(estack_id, request) < 0) + HGOTO_ERROR(H5E_SYM, H5E_CANTINIT, FAIL, "failed to insert request in event stack") + } + +done: + FUNC_LEAVE_API(ret_value) +} /* end H5Xcreate_ff() */ + +/*------------------------------------------------------------------------- + * Function: H5Xremove + * + * Purpose: Remove an index from objects in a container. + * + * Return: Non-negative on success/Negative on failure + * + *------------------------------------------------------------------------- + */ +herr_t +H5Xremove(hid_t file_id, unsigned plugin_id, hid_t scope_id) +{ + void *file = NULL, *obj = NULL; + H5VL_t *vol_plugin = NULL; /* VOL plugin information */ + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_API(FAIL) + + /* Check args */ + if ((plugin_id < 0) || (plugin_id > H5X_PLUGIN_MAX)) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid plugin identification number"); + if (NULL == (file = (void *)H5I_object_verify(file_id, H5I_FILE))) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file ID"); + if (NULL == (obj = (void *) H5VL_get_object(scope_id))) + HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid object/file identifier"); + if (NULL == (vol_plugin = (H5VL_t *)H5I_get_aux(file_id))) + HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "ID does not contain VOL information"); + + /* Call H5VL layer */ +done: + FUNC_LEAVE_API(ret_value) +} /* end H5Xremove() */ + +/*------------------------------------------------------------------------- + * Function: H5Xremove_ff + * + * Purpose: Remove an index from objects in a container. + * + * Return: Non-negative on success/Negative on failure + * + *------------------------------------------------------------------------- + */ +herr_t +H5Xremove_ff(hid_t file_id, unsigned plugin_id, hid_t scope_id, hid_t trans_id, + hid_t estack_id) +{ + H5_priv_request_t *request = NULL; /* private request struct inserted in event queue */ + void **req = NULL; /* pointer to plugin generate requests (NULL if VOL plugin does not support async) */ + void *file = NULL, *dset = NULL; + H5VL_t *vol_plugin = NULL; /* VOL plugin information */ + size_t plugin_index; + H5P_genplist_t *plist; + hid_t dataset_id = scope_id; /* TODO for now */ + hid_t xapl_id = H5P_INDEX_ACCESS_DEFAULT; /* TODO for now */ + size_t metadata_size; /* size of metadata created by plugin */ + void *metadata; /* metadata created by plugin that needs to be stored */ + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_API(FAIL) + + /* Check args */ + if ((plugin_id < 0) || (plugin_id > H5X_PLUGIN_MAX)) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid plugin identification number"); + if (NULL == (file = (void *) H5I_object_verify(file_id, H5I_FILE))) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file ID"); + if (NULL == H5I_object_verify(scope_id, H5I_DATASET)) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "scope_id is restricted to dataset ID"); + if (NULL == (dset = (void *) H5VL_get_object(scope_id))) + HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid object/file identifier"); + if (NULL == (vol_plugin = (H5VL_t *) H5I_get_aux(file_id))) + HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "ID does not contain VOL information"); + + /* Is the plugin already registered */ + if (FALSE == H5X__registered(plugin_id, &plugin_index)) + HGOTO_ERROR(H5E_INDEX, H5E_BADVALUE, FAIL, "plugin is not registered"); + + if (estack_id != H5_EVENT_STACK_NULL) { + /* create the private request */ + if (NULL == (request = (H5_priv_request_t *) H5MM_calloc(sizeof(H5_priv_request_t)))) + HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed") + request->req = NULL; + req = &request->req; + request->next = NULL; + request->vol_plugin = vol_plugin; + vol_plugin->nrefs ++; + } + + /* Get idx_handle from dataset */ + if (FAIL == H5VL_iod_dataset_get_index_info(dset, &plugin_id, + &metadata_size, &metadata, NULL)) + HGOTO_ERROR(H5E_INDEX, H5E_CANTSET, FAIL, "cannot get index from dataset"); + + /* Store the transaction ID in the xapl_id */ + if (NULL == (plist = (H5P_genplist_t *)H5I_object(xapl_id))) + HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID") + if (H5P_set(plist, H5VL_TRANS_ID, &trans_id) < 0) + HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't set property value for trans_id") + + /* Call remove of the plugin */ + if (FAIL == H5X_table_g[plugin_index].remove(file_id, dataset_id, + metadata_size, metadata)) + HGOTO_ERROR(H5E_INDEX, H5E_CANTCREATE, FAIL, "cannot remove index"); + + /* Remove idx_handle from dataset */ + if (FAIL == H5VL_iod_dataset_set_index(dset, NULL)) + HGOTO_ERROR(H5E_INDEX, H5E_CANTSET, FAIL, "cannot reset index handle"); + if (FAIL == H5VL_iod_dataset_remove_index_info(dset, trans_id, req)) + HGOTO_ERROR(H5E_INDEX, H5E_CANTSET, FAIL, "cannot remove index from dataset"); + + if (request && *req) { + if(H5ES_insert(estack_id, request) < 0) + HGOTO_ERROR(H5E_SYM, H5E_CANTINIT, FAIL, "failed to insert request in event stack") + } + +done: + FUNC_LEAVE_API(ret_value) +} /* end H5Xremove_ff() */ + +/*------------------------------------------------------------------------- + * Function: H5Xget_count + * + * Purpose: Determine the number of index objects on an object. + * + * Return: Non-negative on success/Negative on failure + * + *------------------------------------------------------------------------- + */ +herr_t +H5Xget_count(hid_t scope_id, hsize_t *idx_count) +{ + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_API(FAIL) + + /* TODO if necessary */ +done: + FUNC_LEAVE_API(ret_value) +} /* end H5Xget_count() */ + +/*------------------------------------------------------------------------- + * Function: H5Xget_count_ff + * + * Purpose: Determine the number of index objects on an object. + * + * Return: Non-negative on success/Negative on failure + * + *------------------------------------------------------------------------- + */ +herr_t +H5Xget_count_ff(hid_t scope_id, hsize_t *idx_count, hid_t rcxt_id, + hid_t estack_id) +{ + H5_priv_request_t *request = NULL; /* private request struct inserted in event queue */ + void **req = NULL; /* pointer to plugin generate requests (NULL if VOL plugin does not support async) */ + void *dset; + H5VL_t *vol_plugin = NULL; /* VOL plugin information */ + herr_t ret_value = SUCCEED; /* Return value */ + + FUNC_ENTER_API(FAIL) + + if (NULL == H5I_object_verify(scope_id, H5I_DATASET)) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "scope_id is restricted to dataset ID"); + if (NULL == (dset = (void *) H5VL_get_object(scope_id))) + HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid object/file identifier"); + if (!idx_count) + HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "idx_count is NULL"); + + if (estack_id != H5_EVENT_STACK_NULL) { + /* create the private request */ + if (NULL == (request = (H5_priv_request_t *) H5MM_calloc(sizeof(H5_priv_request_t)))) + HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed") + request->req = NULL; + req = &request->req; + request->next = NULL; + request->vol_plugin = vol_plugin; + vol_plugin->nrefs ++; + } + + if (FAIL == H5VL_iod_dataset_get_index_info(dset, idx_count, NULL, + NULL, NULL, req)) + HGOTO_ERROR(H5E_INDEX, H5E_CANTSET, FAIL, "cannot get indexing info from dataset"); + + if (request && *req) { + if(H5ES_insert(estack_id, request) < 0) + HGOTO_ERROR(H5E_SYM, H5E_CANTINIT, FAIL, "failed to insert request in event stack") + } + +done: + FUNC_LEAVE_API(ret_value) +} /* end H5Xget_count_ff() */ |