Specify the default VOL connector to use with an environment variable.

This implicitly adds support for changing the VOL connector for command-line
tools or any application linked with the library.

Also, add 'make check-vol' support for all directories, clearing up necessary
issues in testing scripts, etc.

1 files changed, 28 insertions, 172 deletions

diff --git a/src/H5VL.c b/src/H5VL.c
index aa276ec..6e21acb 100644
--- a/src/H5VL.c
+++ b/src/H5VL.c
@@ -29,11 +29,8 @@
 /***********/
 
 #include "H5private.h"          /* Generic Functions                    */
-#include "H5Aprivate.h"         /* Attributes                           */
 #include "H5Eprivate.h"         /* Error handling                       */
 #include "H5Iprivate.h"         /* IDs                                  */
-#include "H5MMprivate.h"        /* Memory management                    */
-#include "H5PLprivate.h"        /* Plugins                              */
 #include "H5VLpkg.h"            /* Virtual Object Layer                 */
 
 
@@ -46,29 +43,10 @@
 /* Local Typedefs */
 /******************/
 
-/* Information needed for iterating over the registered VOL connector hid_t IDs.
- * The name or value of the new VOL connector that is being registered is
- * stored in the name (or value) field and the found_id field is initialized to
- * H5I_INVALID_HID (-1).  If we find a VOL connector with the same name / value,
- * we set the found_id field to the existing ID for return to the function.
- */
-typedef struct {
-    /* IN */
-    H5VL_get_connector_kind_t kind;     /* Which kind of connector search to make */
-    union {
-        const char *name;               /* The name of the VOL connector to check */
-        H5VL_class_value_t value;       /* The value of the VOL connector to check */
-    } u;
-
-    /* OUT */
-    hid_t found_id;                     /* The connector ID, if we found a match */
-} H5VL_get_connector_ud_t;
-
 
 /********************/
 /* Local Prototypes */
 /********************/
-static int H5VL__get_connector_cb(void *obj, hid_t id, void *_op_data);
 
 
 /*********************/
@@ -88,45 +66,6 @@ static int H5VL__get_connector_cb(void *obj, hid_t id, void *_op_data);
 
 
 /*-------------------------------------------------------------------------
- * Function:    H5VL__get_connector_cb
- *
- * Purpose:     Callback routine to search through registered VOLs
- *
- * Return:      Success:    H5_ITER_STOP if the class and op_data name
- *                          members match. H5_ITER_CONT otherwise.
- *
- *              Failure:    Can't fail
- *
- *-------------------------------------------------------------------------
- */
-static int
-H5VL__get_connector_cb(void *obj, hid_t id, void *_op_data)
-{
-    H5VL_get_connector_ud_t *op_data = (H5VL_get_connector_ud_t *)_op_data; /* User data for callback */
-    H5VL_class_t *cls = (H5VL_class_t *)obj;
-    int ret_value = H5_ITER_CONT;     /* Callback return value */
-
-    FUNC_ENTER_STATIC_NOERR
-
-    if(H5VL_GET_CONNECTOR_BY_NAME == op_data->kind) {
-        if(0 == HDstrcmp(cls->name, op_data->u.name)) {
-            op_data->found_id = id;
-            ret_value = H5_ITER_STOP;
-        } /* end if */
-    } /* end if */
-    else {
-        HDassert(H5VL_GET_CONNECTOR_BY_VALUE == op_data->kind);
-        if(cls->value == op_data->u.value) {
-            op_data->found_id = id;
-            ret_value = H5_ITER_STOP;
-        } /* end if */
-    } /* end else */
-
-    FUNC_LEAVE_NOAPI(ret_value)
-} /* end H5VL__get_connector_cb() */
-
-
-/*-------------------------------------------------------------------------
  * Function:    H5VLregister_connector
  *
  * Purpose:     Registers a new VOL connector as a member of the virtual object
@@ -143,8 +82,7 @@ H5VL__get_connector_cb(void *obj, hid_t id, void *_op_data)
 hid_t
 H5VLregister_connector(const H5VL_class_t *cls, hid_t vipl_id)
 {
-    H5VL_get_connector_ud_t op_data;       /* Callback info for connector search */
-    hid_t ret_value = H5I_INVALID_HID;
+    hid_t ret_value = H5I_INVALID_HID;          /* Return value */
 
     FUNC_ENTER_API(H5I_INVALID_HID)
     H5TRACE2("i", "*xi", cls, vipl_id);
@@ -161,25 +99,9 @@ H5VLregister_connector(const H5VL_class_t *cls, hid_t vipl_id)
     if (cls->wrap_cls.get_wrap_ctx && !cls->wrap_cls.free_wrap_ctx)
         HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "VOL connector must provide free callback for object wrapping contexts when a get callback is provided")
 
-    op_data.kind = H5VL_GET_CONNECTOR_BY_NAME;
-    op_data.u.name = cls->name;
-    op_data.found_id = H5I_INVALID_HID;
-
-    /* check if connector is already registered */
-    if (H5I_iterate(H5I_VOL, H5VL__get_connector_cb, &op_data, TRUE) < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_BADITER, H5I_INVALID_HID, "can't iterate over VOL IDs")
-
-    /* Increment the ref count on the existing VOL connector ID, if it's already registered */
-    if(op_data.found_id != H5I_INVALID_HID) {
-        if (H5I_inc_ref(op_data.found_id, TRUE) < 0)
-            HGOTO_ERROR(H5E_VOL, H5E_CANTINC, H5I_INVALID_HID, "unable to increment ref count on VOL connector")
-        ret_value = op_data.found_id;
-    } /* end if */
-    else {
-        /* Create a new class ID */
-        if ((ret_value = H5VL_register_connector(cls, TRUE, vipl_id)) < 0)
-            HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "unable to register VOL connector")
-    } /* end else */
+    /* Register connector */
+    if((ret_value = H5VL__register_connector(cls, TRUE, vipl_id)) < 0)
+        HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "unable to register VOL connector")
 
 done:
     FUNC_LEAVE_API(ret_value)
@@ -203,8 +125,7 @@ done:
 hid_t
 H5VLregister_connector_by_name(const char *name, hid_t vipl_id)
 {
-    H5VL_get_connector_ud_t op_data;       /* Callback info for connector search */
-    hid_t ret_value = H5I_INVALID_HID;
+    hid_t ret_value = H5I_INVALID_HID;          /* Return value */
 
     FUNC_ENTER_API(H5I_INVALID_HID)
     H5TRACE2("i", "*si", name, vipl_id);
@@ -215,34 +136,9 @@ H5VLregister_connector_by_name(const char *name, hid_t vipl_id)
     if (0 == HDstrlen(name))
         HGOTO_ERROR(H5E_ARGS, H5E_UNINITIALIZED, H5I_INVALID_HID, "zero-length VOL connector name is disallowed")
 
-    op_data.kind = H5VL_GET_CONNECTOR_BY_NAME;
-    op_data.u.name = name;
-    op_data.found_id = H5I_INVALID_HID;
-
-    /* Check if connector is already registered */
-    if(H5I_iterate(H5I_VOL, H5VL__get_connector_cb, &op_data, TRUE) < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_BADITER, H5I_INVALID_HID, "can't iterate over VOL ids")
-
-    /* If connector alread registered, increment ref count on ID and return ID */
-    if(op_data.found_id != H5I_INVALID_HID) {
-        if(H5I_inc_ref(op_data.found_id, TRUE) < 0)
-            HGOTO_ERROR(H5E_VOL, H5E_CANTINC, H5I_INVALID_HID, "unable to increment ref count on VOL connector")
-        ret_value = op_data.found_id;
-    } /* end if */
-    else {
-        H5PL_key_t key;
-        const H5VL_class_t *cls;
-
-        /* Try loading the connector */
-        key.vol.kind = H5VL_GET_CONNECTOR_BY_NAME;
-        key.vol.u.name = name;
-        if(NULL == (cls = (const H5VL_class_t *)H5PL_load(H5PL_TYPE_VOL, &key)))
-            HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, H5I_INVALID_HID, "unable to load VOL connector")
-
-        /* Register the connector we loaded */
-        if((ret_value = H5VL_register_connector(cls, TRUE, vipl_id)) < 0)
-            HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "unable to register VOL connector ID")
-    } /* end else */
+    /* Register connector */
+    if((ret_value = H5VL__register_connector_by_name(name, TRUE, vipl_id)) < 0)
+        HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "unable to register VOL connector")
 
 done:
     FUNC_LEAVE_API(ret_value)
@@ -266,8 +162,7 @@ done:
 hid_t
 H5VLregister_connector_by_value(H5VL_class_value_t value, hid_t vipl_id)
 {
-    H5VL_get_connector_ud_t op_data;       /* Callback info for connector search */
-    hid_t ret_value = H5I_INVALID_HID;
+    hid_t ret_value = H5I_INVALID_HID;          /* Return value */
 
     FUNC_ENTER_API(H5I_INVALID_HID)
     H5TRACE2("i", "VCi", value, vipl_id);
@@ -276,34 +171,9 @@ H5VLregister_connector_by_value(H5VL_class_value_t value, hid_t vipl_id)
     if(value < 0)
         HGOTO_ERROR(H5E_ARGS, H5E_UNINITIALIZED, H5I_INVALID_HID, "negative VOL connector value is disallowed")
 
-    op_data.kind = H5VL_GET_CONNECTOR_BY_VALUE;
-    op_data.u.value = value;
-    op_data.found_id = H5I_INVALID_HID;
-
-    /* Check if connector is already registered */
-    if(H5I_iterate(H5I_VOL, H5VL__get_connector_cb, &op_data, TRUE) < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_BADITER, H5I_INVALID_HID, "can't iterate over VOL ids")
-
-    /* If connector alread registered, increment ref count on ID and return ID */
-    if(op_data.found_id != H5I_INVALID_HID) {
-        if(H5I_inc_ref(op_data.found_id, TRUE) < 0)
-            HGOTO_ERROR(H5E_VOL, H5E_CANTINC, H5I_INVALID_HID, "unable to increment ref count on VOL connector")
-        ret_value = op_data.found_id;
-    } /* end if */
-    else {
-        H5PL_key_t key;
-        const H5VL_class_t *cls;
-
-        /* Try loading the connector */
-        key.vol.kind = H5VL_GET_CONNECTOR_BY_VALUE;
-        key.vol.u.value = value;
-        if(NULL == (cls = (const H5VL_class_t *)H5PL_load(H5PL_TYPE_VOL, &key)))
-            HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, H5I_INVALID_HID, "unable to load VOL connector")
-
-        /* Register the connector we loaded */
-        if((ret_value = H5VL_register_connector(cls, TRUE, vipl_id)) < 0)
-            HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "unable to register VOL connector ID")
-    } /* end else */
+    /* Register connector */
+    if((ret_value = H5VL__register_connector_by_value(value, TRUE, vipl_id)) < 0)
+        HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "unable to register VOL connector")
 
 done:
     FUNC_LEAVE_API(ret_value)
@@ -315,33 +185,26 @@ done:
  *
  * Purpose:     Tests whether a VOL class has been registered or not
  *
- * Return:      Positive if the VOL class has been registered
- *
- *              Zero if it is unregistered
+ * Return:      >0 if the VOL class has been registered
+ *              0 if it is unregistered
+ *              <0 on error (if the class is not a valid class ID)
  *
- *              Negative on error (if the class is not a valid class ID)
+ * Programmer:  Dana Robinson
+ *              June 17, 2017
  *
  *-------------------------------------------------------------------------
  */
 htri_t
 H5VLis_connector_registered(const char *name)
 {
-    H5VL_get_connector_ud_t op_data;       /* Callback info for connector search */
     htri_t ret_value = FALSE;           /* Return value */
 
     FUNC_ENTER_API(FAIL)
     H5TRACE1("t", "*s", name);
 
-    op_data.kind = H5VL_GET_CONNECTOR_BY_NAME;
-    op_data.u.name = name;
-    op_data.found_id = H5I_INVALID_HID;
-
-    /* Check arguments */
-    if (H5I_iterate(H5I_VOL, H5VL__get_connector_cb, &op_data, TRUE) < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_BADITER, FAIL, "can't iterate over VOL ids")
-
-    if (op_data.found_id != H5I_INVALID_HID)
-        ret_value = TRUE;
+    /* Check if connector with this name is registered */
+    if((ret_value = H5VL__is_connector_registered(name)) < 0)
+        HGOTO_ERROR(H5E_VOL, H5E_CANTGET, FAIL, "can't check for VOL")
 
 done:
     FUNC_LEAVE_API(ret_value)
@@ -356,30 +219,22 @@ done:
  * Return:      Positive if the VOL class has been registered
  *              Negative on error (if the class is not a valid class or not registered)
  *
+ * Programmer:  Dana Robinson
+ *              June 17, 2017
+ *
  *-------------------------------------------------------------------------
  */
 hid_t
 H5VLget_connector_id(const char *name)
 {
-    H5VL_get_connector_ud_t op_data;       /* Callback info for connector search */
     hid_t ret_value = H5I_INVALID_HID;  /* Return value */
 
     FUNC_ENTER_API(H5I_INVALID_HID)
     H5TRACE1("i", "*s", name);
 
-    op_data.kind = H5VL_GET_CONNECTOR_BY_NAME;
-    op_data.u.name = name;
-    op_data.found_id = H5I_INVALID_HID;
-
-    /* Check arguments */
-    if (H5I_iterate(H5I_VOL, H5VL__get_connector_cb, &op_data, TRUE) < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_BADITER, H5I_INVALID_HID, "can't iterate over VOL connector IDs")
-
-    if (op_data.found_id != H5I_INVALID_HID) {
-        if (H5I_inc_ref(op_data.found_id, TRUE) < 0)
-            HGOTO_ERROR(H5E_FILE, H5E_CANTINC, H5I_INVALID_HID, "unable to increment ref count on VOL connector")
-        ret_value = op_data.found_id;
-    } /* end if */
+    /* Get connector ID with this name */
+    if((ret_value = H5VL__get_connector_id(name, TRUE)) < 0)
+        HGOTO_ERROR(H5E_VOL, H5E_CANTGET, H5I_INVALID_HID, "can't get VOL id")
 
 done:
     FUNC_LEAVE_API(ret_value)
@@ -406,7 +261,8 @@ H5VLget_connector_name(hid_t obj_id, char *name/*out*/, size_t size)
     FUNC_ENTER_API(FAIL)
     H5TRACE3("Zs", "ixz", obj_id, name, size);
 
-    if ((ret_value = H5VL_get_connector_name(obj_id, name, size)) < 0)
+    /* Call internal routine */
+    if((ret_value = H5VL__get_connector_name(obj_id, name, size)) < 0)
         HGOTO_ERROR(H5E_VOL, H5E_CANTGET, FAIL, "Can't get connector name")
 
 done: