diff options
Diffstat (limited to 'src/H5VLpublic.h')
| -rw-r--r-- | src/H5VLpublic.h | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/src/H5VLpublic.h b/src/H5VLpublic.h new file mode 100644 index 0000000..645b410 --- /dev/null +++ b/src/H5VLpublic.h @@ -0,0 +1,218 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * 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: Mohamad Chaarawi <chaarawi@hdfgroup.org> + * January 23, 2012 + */ +#ifndef _H5VLpublic_H +#define _H5VLpublic_H + +#include "stdarg.h" + +#include "H5public.h" +#include "H5Fpublic.h" +#include "H5Lpublic.h" + +/* types for all file get API routines */ +typedef enum H5VL_file_get_t { + H5VL_FILE_GET_FAPL = 0, /*file access property list */ + H5VL_FILE_GET_FCPL = 1, /*file creation property list */ + H5VL_FILE_GET_SIZE = 2, /*file size */ + H5VL_FILE_GET_FREE_SPACE = 3, /*file freespace */ + H5VL_FILE_GET_INFO = 4, /*file info */ + H5VL_FILE_GET_INTENT = 5, /*file intent */ + H5VL_FILE_GET_NAME = 6, /*file name */ + H5VL_FILE_GET_OBJ_COUNT = 7, /*object count in file */ + H5VL_FILE_GET_OBJ_IDS = 8, /*object ids in file */ + H5VL_FILE_GET_MDC_CONF = 9, /*file metadata cache configuration */ + H5VL_FILE_GET_MDC_HR = 10, /*file metadata cache hit rate */ + H5VL_FILE_GET_MDC_SIZE = 11, /*file metadata cache size */ + H5VL_FILE_GET_FREE_SECTIONS = 12 /*file free selections */ +} H5VL_file_get_t; + +/* types for all file general operations */ +typedef enum H5VL_file_generic_t { + H5VL_FILE_GET_VFD_HANDLE = 0, /*file VFD handle */ + H5VL_FILE_IS_HDF5 = 1 /* is HDF5? */ +} H5VL_file_generic_t; + +/* types for all attr get API routines */ +typedef enum H5VL_attr_get_t { + H5VL_ATTR_GET_SPACE = 0, /* dataspace */ + H5VL_ATTR_GET_TYPE = 1, /* datatype */ + H5VL_ATTR_GET_ACPL = 2, /* creation property list */ + H5VL_ATTR_GET_NAME = 3, /* access property list */ + H5VL_ATTR_GET_STORAGE_SIZE = 4, /* storage size */ + H5VL_ATTR_GET_INFO = 5 /* offset */ +} H5VL_attr_get_t; + +/* types for all dataset get API routines */ +typedef enum H5VL_dataset_get_t { + H5VL_DATASET_GET_SPACE = 0, /* dataspace */ + H5VL_DATASET_GET_SPACE_STATUS = 1, /* space status */ + H5VL_DATASET_GET_TYPE = 2, /* datatype */ + H5VL_DATASET_GET_DCPL = 3, /* creation property list */ + H5VL_DATASET_GET_DAPL = 4, /* access property list */ + H5VL_DATASET_GET_STORAGE_SIZE = 5, /* storage size */ + H5VL_DATASET_GET_OFFSET = 6 /* offset */ +} H5VL_dataset_get_t; + +/* types for all group get API routines */ +typedef enum H5VL_group_get_t { + H5VL_GROUP_GET_GCPL = 0, /*group creation property list */ + H5VL_GROUP_GET_INFO = 1 /*group info */ +} H5VL_group_get_t; + +/* types for all link get API routines */ +typedef enum H5VL_link_get_t { + H5VL_LINK_EXISTS = 0, /*link existence */ + H5VL_LINK_GET_INFO = 1, /*link info */ + H5VL_LINK_GET_NAME = 2, /*link name */ + H5VL_LINK_GET_VAL = 3 /*link value */ +} H5VL_link_get_t; + +/* types for all object get API routines */ +typedef enum H5VL_object_get_t { + H5VL_OBJECT_GET_INFO = 0, /*object info */ + H5VL_OBJECT_GET_COMMENT = 1 /*object comment */ +} H5VL_object_get_t; + +/* types for all object lookup API routines */ +typedef enum H5VL_object_lookup_t { + H5VL_OBJECT_LOOKUP = 0, + H5VL_OBJECT_LOOKUP_BY_NAME = 1, + H5VL_OBJECT_LOOKUP_BY_IDX = 2, + H5VL_OBJECT_LOOKUP_BY_ADDR = 3, + H5VL_OBJECT_LOOKUP_BY_REF = 4 +} H5VL_object_lookup_t; + +/* types for all attr general operations */ +typedef enum H5VL_object_generic_t { + H5VL_ATTR_DELETE_BY_IDX = 0, /* H5Adelete_by_idx */ + H5VL_ATTR_EXISTS = 1, /* H5Aexists */ + H5VL_ATTR_OPEN_BY_IDX = 2, /* H5Aopen_by_idx */ + H5VL_ATTR_RENAME = 3, /* H5Arename */ + H5VL_OBJECT_CHANGE_REF_COUNT = 4, /* H5Oincr/decr_refcount */ + H5VL_OBJECT_EXISTS = 5, /* H5Oexists(_by_name) */ + H5VL_OBJECT_SET_COMMENT = 6 /* H5Oset_comment(_by_name) */ +} H5VL_object_generic_t; + +/* types for all object lookup API routines */ +typedef enum H5VL_link_create_type_t { + H5VL_CREATE_HARD_LINK = 0, + H5VL_CREATE_SOFT_LINK = 1, + H5VL_CREATE_UD_LINK = 2 +} H5VL_link_create_type_t; + +#define H5VL_VOL_DEFAULT 0 /* Default VOL plugin value */ + +/* H5A routines */ +typedef struct H5VL_attr_class_t { + hid_t (*create)(hid_t loc_id, const char *attr_name, hid_t acpl_id, hid_t aapl_id); + hid_t (*open) (hid_t loc_id, void *location, const char *attr_name, hid_t aapl_id); + herr_t (*read) (hid_t attr_id, hid_t mem_type_id, void *buf); + herr_t (*write) (hid_t attr_id, hid_t mem_type_id, const void *buf); + herr_t (*get) (hid_t file_id, H5VL_attr_get_t get_type, va_list arguments); + herr_t (*delete)(hid_t loc_id, void *location, const char *attr_name); + herr_t (*close) (hid_t attr_id); +} H5VL_attr_class_t; + +/* H5T routines*/ +typedef struct H5VL_datatype_class_t { + herr_t (*commit)(hid_t loc_id, const char *name, hid_t type_id, + hid_t lcpl_id, hid_t tcpl_id, hid_t tapl_id); + hid_t (*open) (hid_t loc_id, const char * name, hid_t tapl_id); +}H5VL_datatype_class_t; + +/* H5D routines */ +typedef struct H5VL_dataset_class_t { + hid_t (*create)(hid_t loc_id, const char *name, hid_t dcpl_id, hid_t dapl_id); + hid_t (*open) (hid_t loc_id, const char *name, hid_t dapl_id); + herr_t (*read) (hid_t dataset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, + hid_t xfer_plist_id, void * buf); + herr_t (*write) (hid_t dataset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, + hid_t xfer_plist_id, const void * buf ); + herr_t (*set_extent) (hid_t uid, const hsize_t size[]); + herr_t (*get) (hid_t file_id, H5VL_dataset_get_t get_type, va_list arguments); + herr_t (*close) (hid_t dataset_id); +} H5VL_dataset_class_t; + +/* H5F routines */ +typedef struct H5VL_file_class_t { + hid_t (*create)(const char *name, unsigned flags, hid_t fcpl_id, hid_t fapl_id); + hid_t (*open) (const char *name, unsigned flags, hid_t fapl_id); + herr_t (*flush) (hid_t file_id, H5F_scope_t scope); + herr_t (*get) (hid_t file_id, H5VL_file_get_t get_type, va_list arguments); + herr_t (*generic)(hid_t loc_id, H5VL_file_generic_t generic_type, va_list arguments); + herr_t (*close) (hid_t file_id); +} H5VL_file_class_t; + +/* H5G routines */ +typedef struct H5VL_group_class_t { + hid_t (*create)(hid_t loc_id, const char *name, hid_t gcpl_id, hid_t gapl_id); + hid_t (*open) (hid_t loc_id, const char *name, hid_t gapl_id); + herr_t (*get) (hid_t file_id, H5VL_group_get_t get_type, va_list arguments); + herr_t (*close) (hid_t group_id); +} H5VL_group_class_t; + +/* H5L routines */ +typedef struct H5VL_link_class_t { + herr_t (*create)(H5VL_link_create_type_t create_type, hid_t link_loc_id, const char *link_name, + hid_t lcpl_id, hid_t lapl_id); + herr_t (*move) (hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, + const char *dest_name, hbool_t copy_flag, hid_t lcpl, hid_t lapl); + herr_t (*get) (hid_t loc_id, H5VL_link_get_t get_type, va_list arguments); + herr_t (*delete)(hid_t loc_id, const char *name, void *udata, hid_t lapl_id); +} H5VL_link_class_t; + +/* H5O routines */ +typedef struct H5VL_object_class_t { + hid_t (*open) (hid_t loc_id, void *obj_loc, hid_t lapl_id); + herr_t (*copy) (hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, const char *dst_name, + hid_t ocpypl_id, hid_t lcpl_id ); + herr_t (*lookup)(hid_t loc_id, H5VL_object_lookup_t lookup_type, va_list arguments); + herr_t (*get) (hid_t loc_id, H5VL_object_get_t get_type, va_list arguments); + herr_t (*generic)(hid_t id, H5VL_object_generic_t generic_type, va_list arguments); + herr_t (*close) (hid_t obj_id); +} H5VL_object_class_t; + +/* Class information for each VOL driver */ +typedef struct H5VL_class_t { + const char *name; + unsigned nrefs; /* Ref count for times struct is pointed to */ + herr_t (*terminate)(void); + H5VL_attr_class_t attr_cls; + H5VL_datatype_class_t datatype_cls; + H5VL_dataset_class_t dataset_cls; + H5VL_file_class_t file_cls; + H5VL_group_class_t group_cls; + H5VL_link_class_t link_cls; + H5VL_object_class_t object_cls; +} H5VL_class_t; + +#ifdef __cplusplus +extern "C" { +#endif + +/* Function prototypes */ +H5_DLL hid_t H5VLregister(const H5VL_class_t *cls); +H5_DLL herr_t H5VLunregister(hid_t driver_id); + +#ifdef __cplusplus +} +#endif + +#endif /* _H5VLpublic_H */ |