Refactor handle path logic to helper

HDFGroup · Aug 1, 2023 · 59f5045 · 59f5045
1 parent feafc77
commit 59f5045
Show file tree

Hide file tree

Showing 8 changed files with 100 additions and 198 deletions.
diff --git a/src/rest_vol.c b/src/rest_vol.c
@@ -3382,6 +3382,56 @@ RV_set_object_type_header(H5I_type_t parent_obj_type, const char **parent_obj_ty
     return (ret_value);
 } /* end RV_set_object_type_header */
 
+/* Helper function to initialize an object's name based on its parent's name. 
+ * Allocates memory that must be closed by caller. */
+herr_t RV_set_object_handle_path(const char *obj_path, const char *parent_path, char **buf) {
+    herr_t ret_value = SUCCEED;
+    hbool_t include_parent_path = false;
+    size_t path_size = 0;
+    size_t path_len = 0;
+    char *handle_path = NULL;
+
+    /* Objects can be created/opened without reference to their path. Leave handle_path NULL in this case */
+    if (!obj_path) {
+        *buf = NULL;
+        FUNC_GOTO_DONE(SUCCEED);
+    }
+
+    /* Parent name is included if it is not the root and the object is opened by relative path */
+    include_parent_path = parent_path && strcmp(parent_path, "/") && (obj_path[0] != '/');
+
+    path_size = include_parent_path ? 
+        strlen(parent_path) + 1 + strlen(obj_path) + 1 
+        : 1 + strlen(obj_path) + 1;
+
+    if ((handle_path = RV_malloc(path_size)) == NULL)
+        FUNC_GOTO_ERROR(H5E_SYM, H5E_CANTALLOC, NULL, "can't allocate space for handle path");
+
+    if (include_parent_path) {
+        strncpy(handle_path, parent_path, strlen(parent_path));
+        path_len += strlen(parent_path);
+    }
+
+    /* Add leading slash if not in group name */
+    if (obj_path[0] != '/') {
+        handle_path[path_len] = '/';
+        path_len += 1;
+    }
+
+    strncpy(handle_path + path_len, obj_path, strlen(obj_path) + 1);
+    path_len += (strlen(obj_path) + 1);
+
+    /* Make user pointer point at allocated memory */
+    *buf = handle_path;
+
+done:
+    if (ret_value < 0) {
+        RV_free(handle_path);
+        *buf = NULL;
+    }
+
+    return ret_value;
+}
 /*************************************************
  * The following two routines allow the REST VOL *
  * connector to be dynamically loaded by HDF5.   *

diff --git a/src/rest_vol.h b/src/rest_vol.h
@@ -625,6 +625,9 @@ herr_t RV_base64_decode(const char *in, size_t in_size, char **out, size_t *out_
 /* Comparison function to compare two keys in an rv_hash_table_t */
 int H5_rest_compare_string_keys(void *value1, void *value2);
 
+/* Helper function to initialize an object's name based on its parent's name. */
+herr_t RV_set_object_handle_path(const char *obj_path, const char *parent_path, char **buf);
+
 /* Helper to turn an object type into a string for a server request */
 herr_t RV_set_object_type_header(H5I_type_t parent_obj_type, const char **parent_obj_type_header);
 

diff --git a/src/rest_vol_attr.c b/src/rest_vol_attr.c
@@ -118,30 +118,8 @@ RV_attr_create(void *obj, const H5VL_loc_params_t *loc_params, const char *attr_
 
     new_attribute->handle_path = NULL;
 
-    if (attr_name) {
-        /* Parent name is included if it is not the root */
-        hbool_t include_parent_name = strcmp(parent->handle_path, "/");
-
-        path_size = (include_parent_name ? strlen(parent->handle_path) + 1 + strlen(attr_name) + 1
-                                         : 1 + strlen(attr_name) + 1);
-
-        if ((new_attribute->handle_path = RV_malloc(path_size)) == NULL)
-            FUNC_GOTO_ERROR(H5E_SYM, H5E_CANTALLOC, NULL, "can't allocate space for handle path");
-
-        if (include_parent_name) {
-            strncpy(new_attribute->handle_path, parent->handle_path, strlen(parent->handle_path));
-            path_len += strlen(parent->handle_path);
-        }
-
-        /* Add leading slash if not in attribute name */
-        if (attr_name[0] != '/') {
-            new_attribute->handle_path[path_len] = '/';
-            path_len += 1;
-        }
-
-        strncpy(new_attribute->handle_path + path_len, attr_name, strlen(attr_name) + 1);
-        path_len += (strlen(attr_name) + 1);
-    }
+    if (RV_set_object_handle_path(attr_name, parent->handle_path, &new_attribute->handle_path) < 0)
+        FUNC_GOTO_ERROR(H5E_ATTR, H5E_PATH, NULL, "can't set up object path");
 
     new_attribute->u.attribute.parent_name = NULL;
 
@@ -498,30 +476,8 @@ RV_attr_open(void *obj, const H5VL_loc_params_t *loc_params, const char *attr_na
 
     attribute->handle_path = NULL;
 
-    if (attr_name) {
-        /* Parent name is included if it is not the root */
-        hbool_t include_parent_name = strcmp(parent->handle_path, "/");
-
-        path_size = (include_parent_name ? strlen(parent->handle_path) + 1 + strlen(attr_name) + 1
-                                         : 1 + strlen(attr_name) + 1);
-
-        if ((attribute->handle_path = RV_malloc(path_size)) == NULL)
-            FUNC_GOTO_ERROR(H5E_SYM, H5E_CANTALLOC, NULL, "can't allocate space for handle path");
-
-        if (include_parent_name) {
-            strncpy(attribute->handle_path, parent->handle_path, strlen(parent->handle_path));
-            path_len += strlen(parent->handle_path);
-        }
-
-        /* Add leading slash if not in attribute name */
-        if (attr_name[0] != '/') {
-            attribute->handle_path[path_len] = '/';
-            path_len += 1;
-        }
-
-        strncpy(attribute->handle_path + path_len, attr_name, strlen(attr_name) + 1);
-        path_len += (strlen(attr_name) + 1);
-    }
+    if (RV_set_object_handle_path(attr_name, parent->handle_path, &attribute->handle_path) < 0)
+        FUNC_GOTO_ERROR(H5E_ATTR, H5E_PATH, NULL, "can't set up object path");
 
     attribute->u.attribute.parent_name = NULL;
 

diff --git a/src/rest_vol_dataset.c b/src/rest_vol_dataset.c
@@ -148,30 +148,8 @@ RV_dataset_create(void *obj, const H5VL_loc_params_t *loc_params, const char *na
 
     new_dataset->handle_path = NULL;
 
-    if (name) {
-        /* Parent name is included if it is not the root and the dataset is opened by relative path */
-        hbool_t include_parent_name = strcmp(parent->handle_path, "/") && (name[0] != '/');
-
-        path_size =
-            (include_parent_name ? strlen(parent->handle_path) + 1 + strlen(name) + 1 : 1 + strlen(name) + 1);
-
-        if ((new_dataset->handle_path = RV_malloc(path_size)) == NULL)
-            FUNC_GOTO_ERROR(H5E_SYM, H5E_CANTALLOC, NULL, "can't allocate space for handle path");
-
-        if (include_parent_name) {
-            strncpy(new_dataset->handle_path, parent->handle_path, strlen(parent->handle_path));
-            path_len += strlen(parent->handle_path);
-        }
-
-        /* Add leading slash if not in dataset path */
-        if (name[0] != '/') {
-            new_dataset->handle_path[path_len] = '/';
-            path_len += 1;
-        }
-
-        strncpy(new_dataset->handle_path + path_len, name, strlen(name) + 1);
-        path_len += (strlen(name) + 1);
-    }
+    if (RV_set_object_handle_path(name, parent->handle_path, &new_dataset->handle_path) < 0)
+        FUNC_GOTO_ERROR(H5E_DATASET, H5E_PATH, NULL, "can't set up object path");
 
     /* Copy the DAPL if it wasn't H5P_DEFAULT, else set up a default one so that
      * H5Dget_access_plist() will function correctly
@@ -364,30 +342,8 @@ RV_dataset_open(void *obj, const H5VL_loc_params_t *loc_params, const char *name
 
     dataset->handle_path = NULL;
 
-    if (name) {
-        /* Parent name is included if it is not the root and the dataset is opened by relative path */
-        hbool_t include_parent_name = strcmp(parent->handle_path, "/") && (name[0] != '/');
-
-        path_size =
-            (include_parent_name ? strlen(parent->handle_path) + 1 + strlen(name) + 1 : 1 + strlen(name) + 1);
-
-        if ((dataset->handle_path = RV_malloc(path_size)) == NULL)
-            FUNC_GOTO_ERROR(H5E_SYM, H5E_CANTALLOC, NULL, "can't allocate space for handle path");
-
-        if (include_parent_name) {
-            strncpy(dataset->handle_path, parent->handle_path, strlen(parent->handle_path));
-            path_len += strlen(parent->handle_path);
-        }
-
-        /* Add leading slash if not in dataset path */
-        if (name[0] != '/') {
-            dataset->handle_path[path_len] = '/';
-            path_len += 1;
-        }
-
-        strncpy(dataset->handle_path + path_len, name, strlen(name) + 1);
-        path_len += (strlen(name) + 1);
-    }
+    if (RV_set_object_handle_path(name, parent->handle_path, &dataset->handle_path) < 0)
+        FUNC_GOTO_ERROR(H5E_DATASET, H5E_PATH, NULL, "can't set up object path");
 
     loc_info_out.URI         = dataset->URI;
     loc_info_out.domain      = dataset->domain;

diff --git a/src/rest_vol_datatype.c b/src/rest_vol_datatype.c
@@ -126,30 +126,8 @@ RV_datatype_commit(void *obj, const H5VL_loc_params_t *loc_params, const char *n
 
     new_datatype->handle_path = NULL;
 
-    if (name) {
-        /* Parent name is included if it is not the root and the datatype is opened by relative path */
-        hbool_t include_parent_name = strcmp(parent->handle_path, "/") && (name[0] != '/');
-
-        path_size =
-            (include_parent_name ? strlen(parent->handle_path) + 1 + strlen(name) + 1 : 1 + strlen(name) + 1);
-
-        if ((new_datatype->handle_path = RV_malloc(path_size)) == NULL)
-            FUNC_GOTO_ERROR(H5E_SYM, H5E_CANTALLOC, NULL, "can't allocate space for handle path");
-
-        if (include_parent_name) {
-            strncpy(new_datatype->handle_path, parent->handle_path, strlen(parent->handle_path));
-            path_len += strlen(parent->handle_path);
-        }
-
-        /* Add leading slash if not in datatype path */
-        if (name[0] != '/') {
-            new_datatype->handle_path[path_len] = '/';
-            path_len += 1;
-        }
-
-        strncpy(new_datatype->handle_path + path_len, name, strlen(name) + 1);
-        path_len += (strlen(name) + 1);
-    }
+    if (RV_set_object_handle_path(name, parent->handle_path, &new_datatype->handle_path) < 0)
+        FUNC_GOTO_ERROR(H5E_DATATYPE, H5E_PATH, NULL, "can't set up object path");
 
     /* Copy the TAPL if it wasn't H5P_DEFAULT, else set up a default one so that
      * datatype access property list functions will function correctly
@@ -396,30 +374,8 @@ RV_datatype_open(void *obj, const H5VL_loc_params_t *loc_params, const char *nam
 
     datatype->handle_path = NULL;
 
-    if (name) {
-        /* Parent name is included if it is not the root and the datatype is opened by relative path */
-        hbool_t include_parent_name = strcmp(parent->handle_path, "/") && (name[0] != '/');
-
-        path_size =
-            (include_parent_name ? strlen(parent->handle_path) + 1 + strlen(name) + 1 : 1 + strlen(name) + 1);
-
-        if ((datatype->handle_path = RV_malloc(path_size)) == NULL)
-            FUNC_GOTO_ERROR(H5E_SYM, H5E_CANTALLOC, NULL, "can't allocate space for handle path");
-
-        if (include_parent_name) {
-            strncpy(datatype->handle_path, parent->handle_path, strlen(parent->handle_path));
-            path_len += strlen(parent->handle_path);
-        }
-
-        /* Add leading slash if not in datatype path */
-        if (name[0] != '/') {
-            datatype->handle_path[path_len] = '/';
-            path_len += 1;
-        }
-
-        strncpy(datatype->handle_path + path_len, name, strlen(name) + 1);
-        path_len += (strlen(name) + 1);
-    }
+    if (RV_set_object_handle_path(name, parent->handle_path, &datatype->handle_path) < 0)
+        FUNC_GOTO_ERROR(H5E_DATATYPE, H5E_PATH, NULL, "can't set up object path");
 
     loc_info_out.URI         = datatype->URI;
     loc_info_out.domain      = datatype->domain;

diff --git a/src/rest_vol_file.c b/src/rest_vol_file.c
@@ -76,7 +76,12 @@ RV_file_create(const char *name, unsigned flags, hid_t fcpl_id, hid_t fapl_id, h
     new_file->u.file.fapl_id       = FAIL;
     new_file->u.file.fcpl_id       = FAIL;
     new_file->u.file.ref_count     = 1;
-    new_file->handle_path          = "/";
+
+    /* Allocate root "path" on heap for consistency with other RV_object_t types */
+    if ((new_file->handle_path = RV_malloc(2)) == NULL)
+        FUNC_GOTO_ERROR(H5E_FILE, H5E_CANTALLOC, NULL, "can't allocate space for filepath");
+
+    strncpy(new_file->handle_path, "/", 2);
 
     /* Copy the FAPL if it wasn't H5P_DEFAULT, else set up a default one so that
      * H5Fget_access_plist() will function correctly. Note that due to the nature
@@ -344,7 +349,13 @@ RV_file_open(const char *name, unsigned flags, hid_t fapl_id, hid_t dxpl_id, voi
     file->u.file.fapl_id       = FAIL;
     file->u.file.fcpl_id       = FAIL;
     file->u.file.ref_count     = 1;
-    file->handle_path          = "/";
+
+    /* Allocate root "path" on heap for consistency with other RV_object_t types */
+    if ((file->handle_path = RV_malloc(2)) == NULL)
+        FUNC_GOTO_ERROR(H5E_FILE, H5E_CANTALLOC, NULL, "can't allocate space for filepath");
+
+    strncpy(file->handle_path, "/", 2);
+
 
     /* Store self-referential pointer in the domain field for this object
      * to simplify code for other types of objects
@@ -730,6 +741,7 @@ RV_file_close(void *file, hid_t dxpl_id, void **req)
             _file->u.file.filepath_name = NULL;
         }
 
+        RV_free(_file->handle_path);
         RV_free(_file);
     }
 

diff --git a/src/rest_vol_group.c b/src/rest_vol_group.c
@@ -96,30 +96,8 @@ RV_group_create(void *obj, const H5VL_loc_params_t *loc_params, const char *name
 
     new_group->handle_path = NULL;
 
-    if (name) {
-        /* Parent name is included if it is not the root and the group is opened by relative path */
-        hbool_t include_parent_name = strcmp(parent->handle_path, "/") && (name[0] != '/');
-
-        path_size =
-            (include_parent_name ? strlen(parent->handle_path) + 1 + strlen(name) + 1 : 1 + strlen(name) + 1);
-
-        if ((new_group->handle_path = RV_malloc(path_size)) == NULL)
-            FUNC_GOTO_ERROR(H5E_SYM, H5E_CANTALLOC, NULL, "can't allocate space for handle path");
-
-        if (include_parent_name) {
-            strncpy(new_group->handle_path, parent->handle_path, strlen(parent->handle_path));
-            path_len += strlen(parent->handle_path);
-        }
-
-        /* Add leading slash if not in group name */
-        if (name[0] != '/') {
-            new_group->handle_path[path_len] = '/';
-            path_len += 1;
-        }
-
-        strncpy(new_group->handle_path + path_len, name, strlen(name) + 1);
-        path_len += (strlen(name) + 1);
-    }
+    if (RV_set_object_handle_path(name, parent->handle_path, &new_group->handle_path) < 0)
+        FUNC_GOTO_ERROR(H5E_SYM, H5E_PATH, NULL, "can't set up object path");
 
     /* Copy the GAPL if it wasn't H5P_DEFAULT, else set up a default one so that
      * group access property list functions will function correctly
@@ -402,30 +380,8 @@ RV_group_open(void *obj, const H5VL_loc_params_t *loc_params, const char *name,
 
     group->handle_path = NULL;
 
-    if (name) {
-        /* Parent name is included if it is not the root and the group is opened by relative path */
-        hbool_t include_parent_name = strcmp(parent->handle_path, "/") && (name[0] != '/');
-
-        path_size =
-            (include_parent_name ? strlen(parent->handle_path) + 1 + strlen(name) + 1 : 1 + strlen(name) + 1);
-
-        if ((group->handle_path = RV_malloc(path_size)) == NULL)
-            FUNC_GOTO_ERROR(H5E_SYM, H5E_CANTALLOC, NULL, "can't allocate space for handle path");
-
-        if (include_parent_name) {
-            strncpy(group->handle_path, parent->handle_path, strlen(parent->handle_path));
-            path_len += strlen(parent->handle_path);
-        }
-
-        /* Add leading slash if not in group name */
-        if (name[0] != '/') {
-            group->handle_path[path_len] = '/';
-            path_len += 1;
-        }
-
-        strncpy(group->handle_path + path_len, name, strlen(name) + 1);
-        path_len += (strlen(name) + 1);
-    }
+    if (RV_set_object_handle_path(name, parent->handle_path, &group->handle_path) < 0)
+        FUNC_GOTO_ERROR(H5E_SYM, H5E_PATH, NULL, "can't set up object path");
 
     /* Locate group and set domain */