Merge branch 'develop' of https://bitbucket.hdfgroup.org/scm/hdffv/hdf5 into stackable_vol

1 files changed, 29 insertions, 12 deletions

diff --git a/src/H5VLprivate.h b/src/H5VLprivate.h
index 1da5a43..1defb13 100644
--- a/src/H5VLprivate.h
+++ b/src/H5VLprivate.h
@@ -53,25 +53,36 @@ typedef struct H5VL_plugin_prop_t {
 /* Library Private Prototypes */
 /******************************/
 
-/* Common functions */
+/* Utility functions */
 H5_DLL herr_t H5VL_init(void);
-H5_DLL hid_t H5VL_register_id(H5I_type_t type, void *object, H5VL_t *vol_plugin, hbool_t app_ref);
-H5_DLL herr_t H5VL_free_object(H5VL_object_t *obj);
-H5_DLL hid_t H5VL_register(const void *cls, hbool_t app_ref, hid_t vipl_id);
-H5_DLL hid_t H5VL_object_register(void *obj, H5I_type_t obj_type, hid_t plugin_id, hbool_t app_ref);
-H5_DLL hid_t H5VL_wrap_register(H5I_type_t type, void *obj, hbool_t app_ref);
-H5_DLL ssize_t H5VL_get_plugin_name(hid_t id, char *name/*out*/, size_t size);
-H5_DLL H5VL_object_t *H5VL_get_object(hid_t id);
-H5_DLL void *H5VL_object(hid_t id);
-H5_DLL void *H5VL_object_data(const H5VL_object_t *vol_obj);
-H5_DLL void *H5VL_object_verify(hid_t id, H5I_type_t obj_type);
-H5_DLL void *H5VL_plugin_object(H5VL_object_t *obj);
 H5_DLL int H5VL_cmp_plugin_cls(const H5VL_class_t *cls1, const H5VL_class_t *cls);
 H5_DLL int H5VL_copy_plugin_info(const H5VL_class_t *plugin, void **dst_info,
     const void *src_info);
 H5_DLL int H5VL_cmp_plugin_info(const H5VL_class_t *plugin, const void *info1,
     const void *info2);
 H5_DLL herr_t H5VL_free_plugin_info(const H5VL_class_t *plugin, void *info);
+
+/* Functions that deal with VOL plugins */
+H5_DLL hid_t H5VL_register_plugin(const void *cls, hbool_t app_ref, hid_t vipl_id);
+H5_DLL ssize_t H5VL_get_plugin_name(hid_t id, char *name/*out*/, size_t size);
+
+/* NOTE:    The object and ID functions below deal in VOL objects (i.e.;
+ *          H5VL_object_t). Similar non-VOL calls exist in H5Iprivate.h. Use
+ *          the H5VL calls with objects that go through the VOL, such as
+ *          datasets and groups, and the H5I calls with objects
+ *          that do not, such as property lists and dataspaces. Datatypes
+ *          are can be either named, where they will use the VOL, or not,
+ *          and thus require special treatment. See the datatype docs for
+ *          how to handle this.
+ */
+
+/* Functions that manipulate VOL objects */
+H5_DLL void *H5VL_object(hid_t id);
+H5_DLL void *H5VL_object_verify(hid_t id, H5I_type_t obj_type);
+H5_DLL H5VL_object_t *H5VL_vol_object(hid_t id);
+H5_DLL herr_t H5VL_free_object(H5VL_object_t *obj);
+
+/* Functions that wrap / unwrap VOL objects */
 H5_DLL herr_t H5VL_get_wrap_ctx(const H5VL_class_t *plugin, void *obj,
     void **wrap_ctx);
 H5_DLL herr_t H5VL_free_wrap_ctx(const H5VL_class_t *plugin, void *wrap_ctx);
@@ -80,6 +91,12 @@ H5_DLL herr_t H5VL_reset_vol_wrapper(void);
 H5_DLL void * H5VL_wrap_object(const H5VL_class_t *plugin, void *wrap_ctx,
     void *obj);
 
+/* ID registration functions */
+H5_DLL hid_t H5VL_register(H5I_type_t type, const void *object, H5VL_t *vol_plugin, hbool_t app_ref);
+H5_DLL hid_t H5VL_wrap_register(H5I_type_t type, void *obj, hbool_t app_ref);
+H5_DLL hid_t H5VL_register_using_vol_id(H5I_type_t type, const void *obj, hid_t driver_id, hbool_t app_ref);
+H5_DLL herr_t H5VL_register_using_existing_id(H5I_type_t type, void *object, H5VL_t *vol_driver, hbool_t app_ref, hid_t existing_id);
+
 /******************************
  * VOL plugin callback wrappers
  *****************************/