diff options
Diffstat (limited to 'src/H5R.c')
| -rw-r--r-- | src/H5R.c | 400 |
1 files changed, 395 insertions, 5 deletions
@@ -16,10 +16,13 @@ static char RcsId[] = "@(#)$Revision$"; /* $Id$ */ -#include <H5private.h> /* Generic Functions */ -#include <H5Iprivate.h> /* ID Functions */ -#include <H5Eprivate.h> /* Error handling */ -#include <H5Rprivate.h> /* Data-space functions */ +#include <H5private.h> /* Generic Functions */ +#include <H5Iprivate.h> /* ID Functions */ +#include <H5Dprivate.h> /* Datasets */ +#include <H5Eprivate.h> /* Error handling */ +#include <H5Gprivate.h> /* Groups */ +#include <H5Rprivate.h> /* References */ +#include <H5Sprivate.h> /* Dataspaces */ /* Interface initialization */ #define PABLO_MASK H5R_mask @@ -28,6 +31,13 @@ static intn interface_initialize_g = FALSE; static herr_t H5R_init_interface(void); static void H5R_term_interface(void); +/* Static functions */ +static herr_t H5R_create(href_t *ref, H5G_entry_t *loc, const char *name, + H5R_type_t ref_type, H5S_t *space); +static hid_t H5R_dereference(href_t *ref); +static H5S_t * H5R_get_space(href_t *ref); +static H5R_type_t H5R_get_type(href_t *ref); + /*-------------------------------------------------------------------------- NAME @@ -65,7 +75,7 @@ H5R_init_interface(void) USAGE void H5R_term_interface() RETURNS - SUCCEED/FAIL + void DESCRIPTION Release the atom group and any other resources allocated. GLOBAL VARIABLES @@ -81,3 +91,383 @@ H5R_term_interface(void) H5I_destroy_group(H5I_REFERENCE); } /* end H5R_term_interface() */ + +/*-------------------------------------------------------------------------- + NAME + H5R_create + PURPOSE + Creates a particular kind of reference for the user + USAGE + herr_t H5R_create(ref, loc, name, ref_type, space) + href_t *ref; OUT: Reference created + H5G_entry_t *loc; IN: File location used to locate object pointed to + const char *name; IN: Name of object at location LOC_ID of object + pointed to + H5R_type_t ref_type; IN: Type of reference to create + H5S_t *space; IN: Dataspace ID with selection, used for Dataset + Region references. + + RETURNS + SUCCEED/FAIL + DESCRIPTION + Creates a particular type of reference specified with REF_TYPE, in the + space pointed to by REF. The LOC_ID and NAME are used to locate the object + pointed to and the SPACE_ID is used to choose the region pointed to (for + Dataset Region references). + GLOBAL VARIABLES + COMMENTS, BUGS, ASSUMPTIONS + EXAMPLES + REVISION LOG +--------------------------------------------------------------------------*/ +static herr_t +H5R_create(href_t *ref, H5G_entry_t *loc, const char *name, H5R_type_t ref_type, H5S_t __unused__ *space) +{ + H5G_stat_t sb; /* Stat buffer for retrieving OID */ + herr_t ret_value = FAIL; + + FUNC_ENTER(H5R_create, FAIL); + + assert(ref); + assert(loc); + assert(name); + assert(ref_type>H5R_BADTYPE || ref_type<H5R_MAXTYPE); + + if (H5G_get_objinfo (loc, name, 0, &sb)<0) + HGOTO_ERROR (H5E_REFERENCE, H5E_NOTFOUND, FAIL, "unable to stat object"); + + /* Set information for reference */ + ref->type=ref_type; + ref->objno[0]=sb.objno[0]; + ref->objno[1]=sb.objno[1]; + ref->file=loc->file; + + /* Return success */ + ret_value=SUCCEED; + +done: + FUNC_LEAVE(ret_value); +} /* end H5R_create() */ + + +/*-------------------------------------------------------------------------- + NAME + H5Rcreate + PURPOSE + Creates a particular kind of reference for the user + USAGE + herr_t H5Rcreate(ref, loc_id, name, ref_type, space_id) + href_t *ref; OUT: Reference created + hid_t loc_id; IN: Location ID used to locate object pointed to + const char *name; IN: Name of object at location LOC_ID of object + pointed to + H5R_type_t ref_type; IN: Type of reference to create + hid_t space_id; IN: Dataspace ID with selection, used for Dataset + Region references. + + RETURNS + SUCCEED/FAIL + DESCRIPTION + Creates a particular type of reference specified with REF_TYPE, in the + space pointed to by REF. The LOC_ID and NAME are used to locate the object + pointed to and the SPACE_ID is used to choose the region pointed to (for + Dataset Region references). + GLOBAL VARIABLES + COMMENTS, BUGS, ASSUMPTIONS + EXAMPLES + REVISION LOG +--------------------------------------------------------------------------*/ +herr_t +H5Rcreate(href_t *ref, hid_t loc_id, const char *name, H5R_type_t ref_type, hid_t space_id) +{ + H5G_entry_t *loc = NULL; /* File location */ + H5S_t *space = NULL; /* Pointer to dataspace containing region */ + herr_t ret_value = FAIL; + + FUNC_ENTER(H5Rcreate, FAIL); + H5TRACE5("e","*risRti",ref,loc_id,name,ref_type,space_id); + + /* Check args */ + if(ref==NULL) + HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid reference pointer"); + if (NULL==(loc=H5G_loc (loc_id))) + HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL, "not a location"); + if (!name || !*name) + HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no name given"); + if(ref_type<=H5R_BADTYPE || ref_type>=H5R_MAXTYPE) + HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid reference type"); + if(ref_type!=H5R_OBJECT) + HRETURN_ERROR (H5E_ARGS, H5E_UNSUPPORTED, FAIL, "reference type not supported"); + if (space_id!=(-1) && (H5I_DATASPACE!=H5I_get_type (space_id) || NULL==(space=H5I_object (space_id)))) + HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataspace"); + + /* Create reference */ + if ((ret_value=H5R_create(ref,loc,name,ref_type,space))<0) + HGOTO_ERROR (H5E_REFERENCE, H5E_CANTINIT, FAIL, "unable to create reference"); + +done: + FUNC_LEAVE(ret_value); +} /* end H5Rcreate() */ + + +/*-------------------------------------------------------------------------- + NAME + H5R_dereference + PURPOSE + Opens the HDF5 object referenced. + USAGE + hid_t H5R_dereference(ref) + href_t *ref; IN: Reference to open. + + RETURNS + Valid ID on success, FAIL on failure + DESCRIPTION + Given a reference to some object, open that object and return an ID for + that object. + GLOBAL VARIABLES + COMMENTS, BUGS, ASSUMPTIONS + Currently only set up to work with references to datasets + EXAMPLES + REVISION LOG +--------------------------------------------------------------------------*/ +static hid_t +H5R_dereference(href_t *ref) +{ + H5D_t *dataset; /* Pointer to dataset to open */ + H5G_entry_t ent; /* Symbol table entry */ + hid_t ret_value = FAIL; + + FUNC_ENTER(H5R_dereference, FAIL); + + assert(ref); + + /* + * Switch on object type, when we implement that feature, always try to + * open a dataset for now + */ + /* Allocate the dataset structure */ + if (NULL==(dataset = H5D_new(NULL))) { + HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, + "memory allocation failed"); + } + + /* Initialize the symbol table entry */ + HDmemset(&ent,0,sizeof(H5G_entry_t)); + HDmemcpy(&(ent.header),ref->objno,sizeof(haddr_t)); + ent.type=H5G_NOTHING_CACHED; + ent.file=ref->file; + + /* Open the dataset object */ + if (H5D_open_oid(dataset, &ent) < 0) { + HGOTO_ERROR(H5E_DATASET, H5E_NOTFOUND, NULL, "not found"); + } + + /* Create an atom for the dataset */ + if ((ret_value = H5I_register(H5I_DATASET, dataset)) < 0) { + H5D_close(dataset); + HRETURN_ERROR(H5E_DATASET, H5E_CANTREGISTER, FAIL, + "can't register dataset"); + } + +done: + FUNC_LEAVE(ret_value); +} /* end H5R_dereference() */ + + +/*-------------------------------------------------------------------------- + NAME + H5Rdereference + PURPOSE + Opens the HDF5 object referenced. + USAGE + hid_t H5Rdereference(ref) + href_t *ref; IN: Reference to open. + + RETURNS + Valid ID on success, FAIL on failure + DESCRIPTION + Given a reference to some object, open that object and return an ID for + that object. + GLOBAL VARIABLES + COMMENTS, BUGS, ASSUMPTIONS + EXAMPLES + REVISION LOG +--------------------------------------------------------------------------*/ +hid_t +H5Rdereference(href_t *ref) +{ + hid_t ret_value = FAIL; + + FUNC_ENTER(H5Rdereference, FAIL); + H5TRACE1("i","*r",ref); + + /* Check args */ + if(ref==NULL) + HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid reference pointer"); + + /* Create reference */ + if ((ret_value=H5R_dereference(ref))<0) + HGOTO_ERROR (H5E_REFERENCE, H5E_CANTINIT, FAIL, "unable dereference object"); + +done: + FUNC_LEAVE(ret_value); +} /* end H5Rdereference() */ + + +/*-------------------------------------------------------------------------- + NAME + H5R_get_space + PURPOSE + Retrieves a dataspace with the region pointed to selected. + USAGE + H5S_t *H5R_get_space(ref) + href_t *ref; IN: Reference to open. + + RETURNS + Pointer to the dataspace on success, NULL on failure + DESCRIPTION + Given a reference to some object, creates a copy of the dataset pointed + to's dataspace and defines a selection in the copy which is the region + pointed to. + GLOBAL VARIABLES + COMMENTS, BUGS, ASSUMPTIONS + EXAMPLES + REVISION LOG +--------------------------------------------------------------------------*/ +static H5S_t * +H5R_get_space(href_t __unused__ *ref) +{ + H5S_t *ret_value = NULL; + + FUNC_ENTER(H5R_get_space, NULL); + + assert(ref); + +#ifdef LATER +done: +#endif /* LATER */ + FUNC_LEAVE(ret_value); +} /* end H5R_get_space() */ + + +/*-------------------------------------------------------------------------- + NAME + H5Rget_space + PURPOSE + Retrieves a dataspace with the region pointed to selected. + USAGE + hid_t H5Rget_space(ref) + href_t *ref; IN: Reference to open. + + RETURNS + Valid ID on success, FAIL on failure + DESCRIPTION + Given a reference to some object, creates a copy of the dataset pointed + to's dataspace and defines a selection in the copy which is the region + pointed to. + GLOBAL VARIABLES + COMMENTS, BUGS, ASSUMPTIONS + EXAMPLES + REVISION LOG +--------------------------------------------------------------------------*/ +hid_t +H5Rget_space(href_t *ref) +{ + H5S_t *space = NULL; + hid_t ret_value = FAIL; + + FUNC_ENTER(H5Rget_space, FAIL); + H5TRACE1("i","*r",ref); + + /* Check args */ + if(ref==NULL) + HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid reference pointer"); + + /* Create reference */ + if ((space=H5R_get_space(ref))==NULL) + HGOTO_ERROR (H5E_REFERENCE, H5E_CANTCREATE, FAIL, "unable to create dataspace"); + + /* Atomize */ + if ((ret_value=H5I_register (H5I_DATASPACE, space))<0) + HGOTO_ERROR (H5E_ATOM, H5E_CANTREGISTER, FAIL, "unable to register dataspace atom"); + +done: + FUNC_LEAVE(ret_value); +} /* end H5Rget_space() */ + + +/*-------------------------------------------------------------------------- + NAME + H5R_get_type + PURPOSE + Retrieves the type of a reference. + USAGE + H5R_type_t H5R_get_type(ref) + href_t *ref; IN: Reference to open. + + RETURNS + Reference type on success, <0 on failure + DESCRIPTION + Given a reference to some object, returns the type of reference. See + list of valid H5R_type_t in H5Rpublic.h + GLOBAL VARIABLES + COMMENTS, BUGS, ASSUMPTIONS + EXAMPLES + REVISION LOG +--------------------------------------------------------------------------*/ +static H5R_type_t +H5R_get_type(href_t *ref) +{ + H5R_type_t ret_value = H5R_BADTYPE; + + FUNC_ENTER(H5R_get_type, H5R_BADTYPE); + + assert(ref); + + ret_value=ref->type; + +#ifdef LATER +done: +#endif /* LATER */ + FUNC_LEAVE(ret_value); +} /* end H5R_get_type() */ + + +/*-------------------------------------------------------------------------- + NAME + H5Rget_type + PURPOSE + Retrieves the type of a reference. + USAGE + H5R_type_t H5Rget_space(ref) + href_t *ref; IN: Reference to open. + + RETURNS + Valid reference type on success, <0 on failure + DESCRIPTION + Given a reference to some object, returns the type of reference. See + list of valid H5R_type_t in H5Rpublic.h + GLOBAL VARIABLES + COMMENTS, BUGS, ASSUMPTIONS + EXAMPLES + REVISION LOG +--------------------------------------------------------------------------*/ +H5R_type_t +H5Rget_type(href_t *ref) +{ + H5R_type_t ret_value = H5R_BADTYPE; + + FUNC_ENTER(H5Rget_type, FAIL); + H5TRACE1("Rt","*r",ref); + + /* Check args */ + if(ref==NULL) + HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid reference pointer"); + + /* Create reference */ + if ((ret_value=H5R_get_type(ref))<0) + HGOTO_ERROR (H5E_REFERENCE, H5E_CANTCREATE, FAIL, "unable to check reference type"); + +done: + FUNC_LEAVE(ret_value); +} /* end H5Rget_type() */ + |