summaryrefslogtreecommitdiffstats
path: root/src/H5VL.c
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>2018-11-04 06:27:23 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>2018-11-04 06:27:23 (GMT)
commit1daa7b830ac9ce6028c21f22fddaa67bd4dc8d96 (patch)
treec1f53073ff700c02397231fec2b2075a7391d87f /src/H5VL.c
parentdeb75622ca18958ea729c7184c4bc5ea0e029280 (diff)
downloadhdf5-1daa7b830ac9ce6028c21f22fddaa67bd4dc8d96.zip
hdf5-1daa7b830ac9ce6028c21f22fddaa67bd4dc8d96.tar.gz
hdf5-1daa7b830ac9ce6028c21f22fddaa67bd4dc8d96.tar.bz2
Switch driver | plugin => connector.
Diffstat (limited to 'src/H5VL.c')
-rw-r--r--src/H5VL.c188
1 files changed, 94 insertions, 94 deletions
diff --git a/src/H5VL.c b/src/H5VL.c
index 225e983..0a835a2 100644
--- a/src/H5VL.c
+++ b/src/H5VL.c
@@ -45,21 +45,21 @@
/* Local Typedefs */
/******************/
-/* Information needed for iterating over the registered VOL plugin hid_t IDs.
- * The name of the new VOL plugin that is being registered is stored in the
+/* Information needed for iterating over the registered VOL connector hid_t IDs.
+ * The name of the new VOL connector that is being registered is stored in the
* name field and the found_id field is initialized to H5I_INVALID_HID (-1).
- * If we find a VOL plugin with the same name, we set the found_id field to
+ * If we find a VOL connector with the same name, we set the found_id field to
* the existing ID for return to the function.
*/
typedef struct {
- const char *name; /* The name of the VOL plugin to check */
+ const char *name; /* The name of the VOL connector to check */
hid_t found_id; /* The library ID if we found a match */
-} H5VL_get_plugin_ud_t;
+} H5VL_get_connector_ud_t;
/********************/
/* Local Prototypes */
/********************/
-static int H5VL__get_plugin_cb(void *obj, hid_t id, void *_op_data);
+static int H5VL__get_connector_cb(void *obj, hid_t id, void *_op_data);
/*********************/
/* Package Variables */
@@ -75,7 +75,7 @@ static int H5VL__get_plugin_cb(void *obj, hid_t id, void *_op_data);
/*-------------------------------------------------------------------------
- * Function: H5VL__get_plugin_cb
+ * Function: H5VL__get_connector_cb
*
* Purpose: Callback routine to search through registered VOLs
*
@@ -87,9 +87,9 @@ static int H5VL__get_plugin_cb(void *obj, hid_t id, void *_op_data);
*-------------------------------------------------------------------------
*/
static int
-H5VL__get_plugin_cb(void *obj, hid_t id, void *_op_data)
+H5VL__get_connector_cb(void *obj, hid_t id, void *_op_data)
{
- H5VL_get_plugin_ud_t *op_data = (H5VL_get_plugin_ud_t *)_op_data; /* User data for callback */
+ 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 */
@@ -101,17 +101,17 @@ H5VL__get_plugin_cb(void *obj, hid_t id, void *_op_data)
} /* end if */
FUNC_LEAVE_NOAPI(ret_value)
-} /* end H5VL__get_plugin_cb() */
+} /* end H5VL__get_connector_cb() */
/*-------------------------------------------------------------------------
- * Function: H5VLregister_plugin
+ * Function: H5VLregister_connector
*
- * Purpose: Registers a new VOL plugin as a member of the virtual object
+ * Purpose: Registers a new VOL connector as a member of the virtual object
* layer class.
*
- * Return: Success: A VOL plugin ID which is good until the
- * library is closed or the plugin is
+ * Return: Success: A VOL connector ID which is good until the
+ * library is closed or the connector is
* unregistered.
*
* Failure: H5I_INVALID_HID
@@ -119,9 +119,9 @@ H5VL__get_plugin_cb(void *obj, hid_t id, void *_op_data)
*-------------------------------------------------------------------------
*/
hid_t
-H5VLregister_plugin(const H5VL_class_t *cls, hid_t vipl_id)
+H5VLregister_connector(const H5VL_class_t *cls, hid_t vipl_id)
{
- H5VL_get_plugin_ud_t op_data; /* Callback info for plugin search */
+ H5VL_get_connector_ud_t op_data; /* Callback info for connector search */
hid_t ret_value = H5I_INVALID_HID;
FUNC_ENTER_API(H5I_INVALID_HID)
@@ -129,48 +129,48 @@ H5VLregister_plugin(const H5VL_class_t *cls, hid_t vipl_id)
/* Check arguments */
if (!cls)
- HGOTO_ERROR(H5E_ARGS, H5E_UNINITIALIZED, H5I_INVALID_HID, "VOL plugin class pointer cannot be NULL")
+ HGOTO_ERROR(H5E_ARGS, H5E_UNINITIALIZED, H5I_INVALID_HID, "VOL connector class pointer cannot be NULL")
if (!cls->name)
- HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "VOL plugin class name cannot be the NULL pointer")
+ HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "VOL connector class name cannot be the NULL pointer")
if (0 == HDstrlen(cls->name))
- HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "VOL plugin class name cannot be the empty string")
+ HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "VOL connector class name cannot be the empty string")
if (cls->info_copy && !cls->info_free)
- HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "VOL plugin must provide free callback for VOL info objects when a copy callback is provided")
+ HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "VOL connector must provide free callback for VOL info objects when a copy callback is provided")
if (cls->get_wrap_ctx && !cls->free_wrap_ctx)
- HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "VOL plugin must provide free callback for object wrapping contexts when a get callback is provided")
+ 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.found_id = H5I_INVALID_HID;
op_data.name = cls->name;
- /* check if plugin is already registered */
- if (H5I_iterate(H5I_VOL, H5VL__get_plugin_cb, &op_data, TRUE) < 0)
+ /* 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 plugin ID, if it's already registered */
+ /* 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 plugin")
+ 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_plugin(cls, TRUE, vipl_id)) < 0)
- HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "unable to register VOL plugin")
+ 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 */
done:
FUNC_LEAVE_API(ret_value)
-} /* end H5VLregister_plugin() */
+} /* end H5VLregister_connector() */
/*-------------------------------------------------------------------------
- * Function: H5VLregister_plugin_by_name
+ * Function: H5VLregister_connector_by_name
*
- * Purpose: Registers a new VOL plugin as a member of the virtual object
+ * Purpose: Registers a new VOL connector as a member of the virtual object
* layer class.
*
- * Return: Success: A VOL plugin ID which is good until the
- * library is closed or the plugin is
+ * Return: Success: A VOL connector ID which is good until the
+ * library is closed or the connector is
* unregistered.
*
* Failure: H5I_INVALID_HID
@@ -178,9 +178,9 @@ done:
*-------------------------------------------------------------------------
*/
hid_t
-H5VLregister_plugin_by_name(const char *name, hid_t vipl_id)
+H5VLregister_connector_by_name(const char *name, hid_t vipl_id)
{
- H5VL_get_plugin_ud_t op_data; /* Callback info for plugin search */
+ H5VL_get_connector_ud_t op_data; /* Callback info for connector search */
hid_t ret_value = H5I_INVALID_HID;
FUNC_ENTER_API(H5I_INVALID_HID)
@@ -188,44 +188,44 @@ H5VLregister_plugin_by_name(const char *name, hid_t vipl_id)
/* Check arguments */
if (!name)
- HGOTO_ERROR(H5E_ARGS, H5E_UNINITIALIZED, H5I_INVALID_HID, "null VOL plugin name is disallowed")
+ HGOTO_ERROR(H5E_ARGS, H5E_UNINITIALIZED, H5I_INVALID_HID, "null VOL connector name is disallowed")
if (0 == HDstrlen(name))
- HGOTO_ERROR(H5E_ARGS, H5E_UNINITIALIZED, H5I_INVALID_HID, "zero-length VOL plugin name is disallowed")
+ HGOTO_ERROR(H5E_ARGS, H5E_UNINITIALIZED, H5I_INVALID_HID, "zero-length VOL connector name is disallowed")
op_data.found_id = H5I_INVALID_HID;
op_data.name = name;
- /* Check if plugin is already registered */
- if (H5I_iterate(H5I_VOL, H5VL__get_plugin_cb, &op_data, TRUE) < 0)
+ /* 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 plugin alread registered, increment ref count on ID and return ID */
+ /* 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 plugin")
+ 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 plugin */
+ /* Try loading the connector */
key.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 plugin")
+ HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, H5I_INVALID_HID, "unable to load VOL connector")
- /* Register the plugin we loaded */
- if ((ret_value = H5VL_register_plugin(cls, TRUE, vipl_id)) < 0)
- HGOTO_ERROR(H5E_VOL, H5E_CANTREGISTER, H5I_INVALID_HID, "unable to register VOL plugin ID")
+ /* 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 */
done:
FUNC_LEAVE_API(ret_value)
-} /* end H5VLregister_plugin_by_name() */
+} /* end H5VLregister_connector_by_name() */
/*-------------------------------------------------------------------------
- * Function: H5VLis_plugin_registered
+ * Function: H5VLis_connector_registered
*
* Purpose: Tests whether a VOL class has been registered or not
*
@@ -238,9 +238,9 @@ done:
*-------------------------------------------------------------------------
*/
htri_t
-H5VLis_plugin_registered(const char *name)
+H5VLis_connector_registered(const char *name)
{
- H5VL_get_plugin_ud_t op_data; /* Callback info for plugin search */
+ H5VL_get_connector_ud_t op_data; /* Callback info for connector search */
htri_t ret_value = FALSE; /* Return value */
FUNC_ENTER_API(FAIL)
@@ -250,7 +250,7 @@ H5VLis_plugin_registered(const char *name)
op_data.name = name;
/* Check arguments */
- if (H5I_iterate(H5I_VOL, H5VL__get_plugin_cb, &op_data, TRUE) < 0)
+ 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)
@@ -258,13 +258,13 @@ H5VLis_plugin_registered(const char *name)
done:
FUNC_LEAVE_API(ret_value)
-} /* end H5VLis_plugin_registered() */
+} /* end H5VLis_connector_registered() */
/*-------------------------------------------------------------------------
- * Function: H5VLget_plugin_id
+ * Function: H5VLget_connector_id
*
- * Purpose: Retrieves the ID for a registered VOL plugin.
+ * Purpose: Retrieves the ID for a registered VOL connector.
*
* Return: Positive if the VOL class has been registered
* Negative on error (if the class is not a valid class or not registered)
@@ -272,9 +272,9 @@ done:
*-------------------------------------------------------------------------
*/
hid_t
-H5VLget_plugin_id(const char *name)
+H5VLget_connector_id(const char *name)
{
- H5VL_get_plugin_ud_t op_data; /* Callback info for plugin search */
+ 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)
@@ -284,55 +284,55 @@ H5VLget_plugin_id(const char *name)
op_data.name = name;
/* Check arguments */
- if (H5I_iterate(H5I_VOL, H5VL__get_plugin_cb, &op_data, TRUE) < 0)
- HGOTO_ERROR(H5E_VOL, H5E_BADITER, H5I_INVALID_HID, "can't iterate over VOL plugin IDs")
+ 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 plugin")
+ 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 */
done:
FUNC_LEAVE_API(ret_value)
-} /* end H5VLget_plugin_id() */
+} /* end H5VLget_connector_id() */
/*-------------------------------------------------------------------------
- * Function: H5VLget_plugin_name
+ * Function: H5VLget_connector_name
*
- * Purpose: Returns the plugin name for the VOL associated with the
+ * Purpose: Returns the connector name for the VOL associated with the
* object or file ID
*
- * Return: Success: The length of the plugin name
+ * Return: Success: The length of the connector name
*
* Failure: Negative
*
*-------------------------------------------------------------------------
*/
ssize_t
-H5VLget_plugin_name(hid_t obj_id, char *name/*out*/, size_t size)
+H5VLget_connector_name(hid_t obj_id, char *name/*out*/, size_t size)
{
ssize_t ret_value = -1;
FUNC_ENTER_API(FAIL)
H5TRACE3("Zs", "ixz", obj_id, name, size);
- if ((ret_value = H5VL_get_plugin_name(obj_id, name, size)) < 0)
- HGOTO_ERROR(H5E_VOL, H5E_CANTGET, FAIL, "Can't get plugin name")
+ 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:
FUNC_LEAVE_API(ret_value)
-} /* end H5VLget_plugin_name() */
+} /* end H5VLget_connector_name() */
/*-------------------------------------------------------------------------
* Function: H5VLclose
*
- * Purpose: Closes a VOL plugin ID. This in no way affects
+ * Purpose: Closes a VOL connector ID. This in no way affects
* file access property lists which have been defined to use
- * this VOL plugin or files which are already opened under with
- * this plugin.
+ * this VOL connector or files which are already opened under with
+ * this connector.
*
* Return: Success: Non-negative
* Failure: Negative
@@ -349,11 +349,11 @@ H5VLclose(hid_t vol_id)
/* Check args */
if(NULL == H5I_object_verify(vol_id, H5I_VOL))
- HGOTO_ERROR(H5E_VOL, H5E_BADTYPE, FAIL, "not a VOL plugin")
+ HGOTO_ERROR(H5E_VOL, H5E_BADTYPE, FAIL, "not a VOL connector")
- /* Decrement the ref count on the ID, possibly releasing the VOL plugin */
+ /* Decrement the ref count on the ID, possibly releasing the VOL connector */
if(H5I_dec_app_ref(vol_id) < 0)
- HGOTO_ERROR(H5E_VOL, H5E_CANTDEC, FAIL, "unable to close VOL plugin ID")
+ HGOTO_ERROR(H5E_VOL, H5E_CANTDEC, FAIL, "unable to close VOL connector ID")
done:
FUNC_LEAVE_API(ret_value)
@@ -361,12 +361,12 @@ done:
/*-------------------------------------------------------------------------
- * Function: H5VLunregister_plugin
+ * Function: H5VLunregister_connector
*
- * Purpose: Removes a VOL plugin ID from the library. This in no way affects
+ * Purpose: Removes a VOL connector ID from the library. This in no way affects
* file access property lists which have been defined to use
- * this VOL plugin or files which are already opened under with
- * this plugin.
+ * this VOL connector or files which are already opened under with
+ * this connector.
*
* Return: Success: Non-negative
*
@@ -375,7 +375,7 @@ done:
*-------------------------------------------------------------------------
*/
herr_t
-H5VLunregister_plugin(hid_t vol_id)
+H5VLunregister_connector(hid_t vol_id)
{
herr_t ret_value = SUCCEED; /* Return value */
@@ -384,25 +384,25 @@ H5VLunregister_plugin(hid_t vol_id)
/* Check arguments */
if(NULL == H5I_object_verify(vol_id, H5I_VOL))
- HGOTO_ERROR(H5E_VOL, H5E_BADTYPE, FAIL, "not a VOL plugin")
+ HGOTO_ERROR(H5E_VOL, H5E_BADTYPE, FAIL, "not a VOL connector")
/* The H5VL_class_t struct will be freed by this function */
if (H5I_dec_app_ref(vol_id) < 0)
- HGOTO_ERROR(H5E_VOL, H5E_CANTDEC, FAIL, "unable to unregister VOL plugin")
+ HGOTO_ERROR(H5E_VOL, H5E_CANTDEC, FAIL, "unable to unregister VOL connector")
done:
FUNC_LEAVE_API(ret_value)
-} /* end H5VLunregister_plugin() */
+} /* end H5VLunregister_connector() */
/*---------------------------------------------------------------------------
- * Function: H5VLcmp_plugin_cls
+ * Function: H5VLcmp_connector_cls
*
- * Purpose: Compares two plugin classes
+ * Purpose: Compares two connector classes
*
* Return: Success: Non-negative, with *cmp set to positive if
- * plugin_id1 is greater than plugin_id2, negative if plugin_id2
- * is greater than plugin_id1 and zero if plugin_id1 and plugin_id2
+ * connector_id1 is greater than connector_id2, negative if connector_id2
+ * is greater than connector_id1 and zero if connector_id1 and connector_id2
* are equal.
*
* Failure: Negative
@@ -410,24 +410,24 @@ done:
*---------------------------------------------------------------------------
*/
herr_t
-H5VLcmp_plugin_cls(int *cmp, hid_t plugin_id1, hid_t plugin_id2)
+H5VLcmp_connector_cls(int *cmp, hid_t connector_id1, hid_t connector_id2)
{
- H5VL_class_t *cls1, *cls2; /* Plugins for IDs */
+ H5VL_class_t *cls1, *cls2; /* connectors for IDs */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
- H5TRACE3("e", "*Isii", cmp, plugin_id1, plugin_id2);
+ H5TRACE3("e", "*Isii", cmp, connector_id1, connector_id2);
/* Check args and get class pointers */
- if(NULL == (cls1 = (H5VL_class_t *)H5I_object_verify(plugin_id1, H5I_VOL)))
- HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a VOL plugin ID")
- if(NULL == (cls2 = (H5VL_class_t *)H5I_object_verify(plugin_id2, H5I_VOL)))
- HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a VOL plugin ID")
+ if(NULL == (cls1 = (H5VL_class_t *)H5I_object_verify(connector_id1, H5I_VOL)))
+ HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a VOL connector ID")
+ if(NULL == (cls2 = (H5VL_class_t *)H5I_object_verify(connector_id2, H5I_VOL)))
+ HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a VOL connector ID")
- /* Compare the two VOL plugin classes */
- *cmp = H5VL_cmp_plugin_cls(cls1, cls2);
+ /* Compare the two VOL connector classes */
+ *cmp = H5VL_cmp_connector_cls(cls1, cls2);
done:
FUNC_LEAVE_API(ret_value)
-} /* H5VLcmp_plugin_cls() */
+} /* H5VLcmp_connector_cls() */