Merge pull request #395 in HDFFV/hdf5 from ~BYRN/hdf5_adb:develop to develop

* commit '1e0ecb4481e226239c1fd51bd214bd7e7490805d':
  Fix typo deletion
  HDFFV-10143 Update new feature section.
  HDFFV-10143 clean up format and function return
  HDFFV-10143 Add plugin APIs to Java interface
  Update with checks for index bounds
  Update tools issues
  HDFFV-10143 fix use before set
  HDFFV-10143 surround will fail with try block
  HDFFV-10143 typo cleanup
  HDFFV-10143 typo removed
  Fix code error and use H5PL_MAX_PATH_NUM in test
  HDFFV-10143 Cleanup due to comments
  HDFFV-10143 remove debugging output
  HDFFV-10143 change h5PLget to use buffer like H5Iget_name
  HDFFV-10143 change put to replace and add const
  Remove redundant code
  HDFFV-10143 Use Windows A version of ExpandEnvironmentStrings
  HDFFV-10143 Fix initial issues from review
  Remove duplicated paths, add new paths
  HDFFV-10143 add APIs to manipulate plugin path table

4 files changed, 318 insertions, 22 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 9321bbd..e2acd30 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -520,6 +520,7 @@ set (H5PL_SOURCES
 
 set (H5PL_HDRS
     ${HDF5_SRC_DIR}/H5PLextern.h
+    ${HDF5_SRC_DIR}/H5PLpkg.h
     ${HDF5_SRC_DIR}/H5PLpublic.h
 )
 IDE_GENERATED_PROPERTIES ("H5PL" "${H5PL_HDRS}" "${H5PL_SOURCES}" )
diff --git a/src/H5PL.c b/src/H5PL.c
index 1f7bb2a..bfa3ace 100644
--- a/src/H5PL.c
+++ b/src/H5PL.c
@@ -25,15 +25,33 @@
 #include "H5private.h"      /* Generic Functions            */
 #include "H5Eprivate.h"     /* Error handling               */
 #include "H5MMprivate.h"    /* Memory management            */
-#include "H5PLprivate.h"    /* Plugin                       */
+#include "H5PLpkg.h"        /* Plugin                       */
 #include "H5Zprivate.h"     /* Filter pipeline              */
 
 
 /****************/
 /* Local Macros */
 /****************/
-
-#define H5PL_MAX_PATH_NUM       16
+#ifdef H5_HAVE_WIN32_API
+#define H5PL_EXPAND_ENV_VAR {                                                            \
+        long bufCharCount;                                                               \
+        char *tempbuf;                                                                   \
+        if(NULL == (tempbuf = (char *)H5MM_malloc(H5PL_EXPAND_BUFFER_SIZE)))             \
+            HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for expanded path")                          \
+        if((bufCharCount = ExpandEnvironmentStringsA(dl_path, tempbuf, H5PL_EXPAND_BUFFER_SIZE)) > H5PL_EXPAND_BUFFER_SIZE) { \
+            tempbuf = (char *)H5MM_xfree(tempbuf);                                       \
+            HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "expanded path is too long")      \
+        }                                                                                \
+        if(bufCharCount == 0) {                                                          \
+            tempbuf = (char *)H5MM_xfree(tempbuf);                                       \
+            HGOTO_ERROR(H5E_PLUGIN, H5E_CANTGET, FAIL, "failed to expand path")          \
+        }                                                                                \
+        dl_path = (char *)H5MM_xfree(dl_path);                                           \
+        dl_path = tempbuf;                                                               \
+ }
+#else
+#define H5PL_EXPAND_ENV_VAR
+#endif /* H5_HAVE_WIN32_API */
 
 /****************************/
 /* Macros for supporting
@@ -390,6 +408,244 @@ done:
 
 
 /*-------------------------------------------------------------------------
+ * Function: H5PLappend
+ *
+ * Purpose: Insert a plugin path at the end of the list.
+ *
+ * Return: Non-negative or success.
+ *
+ *-------------------------------------------------------------------------
+ */
+herr_t
+H5PLappend(const char* plugin_path)
+{
+    herr_t ret_value = SUCCEED; /* Return value */
+    char        *dl_path = NULL;
+
+    FUNC_ENTER_API(FAIL)
+    if(H5PL_num_paths_g == H5PL_MAX_PATH_NUM)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "too many directories in path for table")
+    if(NULL == plugin_path)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no path provided")
+    if(NULL == (dl_path = H5MM_strdup(plugin_path)))
+        HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
+
+    H5PL_EXPAND_ENV_VAR
+
+    H5PL_path_table_g[H5PL_num_paths_g] = dl_path;
+    H5PL_num_paths_g++;
+
+done:
+    FUNC_LEAVE_API(ret_value)
+} /* end H5PLappend() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5PLprepend
+ *
+ * Purpose: Insert a plugin path at the beginning of the list.
+ *
+ * Return: Non-negative or success.
+ *
+ *-------------------------------------------------------------------------
+ */
+herr_t
+H5PLprepend(const char* plugin_path)
+{
+    herr_t ret_value = SUCCEED; /* Return value */
+    char        *dl_path = NULL;
+    unsigned int plindex;
+
+    FUNC_ENTER_API(FAIL)
+    if(H5PL_num_paths_g == H5PL_MAX_PATH_NUM)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "too many directories in path for table")
+    if(NULL == plugin_path)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no path provided")
+    if(NULL == (dl_path = H5MM_strdup(plugin_path)))
+        HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
+
+    H5PL_EXPAND_ENV_VAR
+
+    for (plindex = (unsigned int)H5PL_num_paths_g; plindex > 0; plindex--)
+        H5PL_path_table_g[plindex] = H5PL_path_table_g[plindex - 1];
+    H5PL_path_table_g[0] = dl_path;
+    H5PL_num_paths_g++;
+
+done:
+    FUNC_LEAVE_API(ret_value)
+} /* end H5PLprepend() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5PLreplace
+ *
+ * Purpose: Replace the path at the specified index.
+ *
+ * Return: Non-negative or success.
+ *
+ *-------------------------------------------------------------------------
+ */
+herr_t
+H5PLreplace(const char* plugin_path, unsigned int index)
+{
+    herr_t ret_value = SUCCEED; /* Return value */
+    char        *dl_path = NULL;
+
+    FUNC_ENTER_API(FAIL)
+    if(NULL == plugin_path)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no path provided")
+    if(index >= H5PL_MAX_PATH_NUM)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "index path out of bounds for table")
+    if(NULL == (dl_path = H5MM_strdup(plugin_path)))
+        HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
+
+    H5PL_EXPAND_ENV_VAR
+
+    if(H5PL_path_table_g[index])
+        H5PL_path_table_g[index] = (char *)H5MM_xfree(H5PL_path_table_g[index]);
+    H5PL_path_table_g[index] = dl_path;
+
+done:
+    FUNC_LEAVE_API(ret_value)
+} /* end H5PLreplace() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5PLinsert
+ *
+ * Purpose: Insert a plugin path at the specified index, moving other paths after the index.
+ *
+ * Return: Non-negative or success.
+ *
+ *-------------------------------------------------------------------------
+ */
+herr_t
+H5PLinsert(const char* plugin_path, unsigned int index)
+{
+    herr_t ret_value = SUCCEED; /* Return value */
+    char        *dl_path = NULL;
+    unsigned int plindex;
+
+    FUNC_ENTER_API(FAIL)
+    if(H5PL_num_paths_g == H5PL_MAX_PATH_NUM)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "too many directories in path for table")
+    if(NULL == plugin_path)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no path provided")
+    if(index >= H5PL_MAX_PATH_NUM)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "index path out of bounds for table")
+    if(NULL == (dl_path = H5MM_strdup(plugin_path)))
+        HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
+
+    H5PL_EXPAND_ENV_VAR
+
+    for(plindex = (unsigned int)H5PL_num_paths_g; plindex > index; plindex--)
+        H5PL_path_table_g[plindex] = H5PL_path_table_g[plindex - 1];
+    H5PL_path_table_g[index] = dl_path;
+    H5PL_num_paths_g++;
+
+done:
+    FUNC_LEAVE_API(ret_value)
+} /* end H5PLinsert() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5PLremove
+ *
+ * Purpose: Remove the plugin path at the specifed index and compacting the list.
+ *
+ * Return: Non-negative or success.
+ *
+ *-------------------------------------------------------------------------
+ */
+herr_t
+H5PLremove(unsigned int index)
+{
+    herr_t ret_value = SUCCEED; /* Return value */
+    unsigned int plindex;
+
+    FUNC_ENTER_API(FAIL)
+    if(H5PL_num_paths_g == 0)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "no directories in table")
+    if(index >= H5PL_MAX_PATH_NUM)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "index path out of bounds for table")
+    if(NULL == H5PL_path_table_g[index])
+        HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no directory path at index")
+    H5PL_path_table_g[index] = (char *)H5MM_xfree(H5PL_path_table_g[index]);
+
+    H5PL_num_paths_g--;
+    for(plindex = index; plindex < (unsigned int)H5PL_num_paths_g; plindex++)
+        H5PL_path_table_g[plindex] = H5PL_path_table_g[plindex + 1];
+    H5PL_path_table_g[H5PL_num_paths_g] = NULL;
+
+done:
+    FUNC_LEAVE_API(ret_value)
+} /* end H5PLremove() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5PLget
+ *
+ * Purpose: Query the plugin path at the specified index.
+ *
+ * Return: Success: The length of path.
+ *
+ *  If `pathname' is non-NULL then write up to `size' bytes into that
+ *  buffer and always return the length of the pathname.
+ *  Otherwise `size' is ignored and the function does not store the pathname,
+ *  just returning the number of characters required to store the pathname.
+ *  If an error occurs then the buffer pointed to by `pathname' (NULL or non-NULL)
+ *  is unchanged and the function returns a negative value.
+ *  If a zero is returned for the name's length, then there is no pathname
+ *  associated with the index.
+ *
+ *-------------------------------------------------------------------------
+ */
+ssize_t
+H5PLget(unsigned int index, char *pathname/*out*/, size_t size)
+{
+    ssize_t      ret_value = 0;    /* Return value */
+    ssize_t      len = 0;      /* Length of pathname */
+    char        *dl_path = NULL;
+
+    FUNC_ENTER_API(FAIL)
+    if(H5PL_num_paths_g == 0)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "no directories in table")
+    if(index >= H5PL_MAX_PATH_NUM)
+        HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "index path out of bounds for table")
+    if(NULL == (dl_path = H5PL_path_table_g[index]))
+        HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no directory path at index")
+    len = HDstrlen(dl_path);
+    if(pathname) {
+        HDstrncpy(pathname, dl_path, MIN((size_t)(len + 1), size));
+        if((size_t)len >= size)
+            pathname[size - 1] = '\0';
+    } /* end if */
+
+    /* Set return value */
+    ret_value = len;
+
+done:
+    FUNC_LEAVE_API(ret_value)
+} /* end H5PLget() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5PLsize
+ *
+ * Purpose: Query the size of the current list of plugin paths.
+ *
+ * Return: Non-negative or success.
+ *
+ *-------------------------------------------------------------------------
+ */
+unsigned int
+H5PLsize(void)
+{
+    return (unsigned int)H5PL_num_paths_g;
+} /* end H5PLsize() */
+
+
+/*-------------------------------------------------------------------------
  * Function:    H5PL__init_path_table
  *
  * Purpose:     Initialize the path table.
@@ -422,25 +678,7 @@ H5PL__init_path_table(void)
     if(NULL == dl_path)
         HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
 
-#ifdef H5_HAVE_WIN32_API
-    else { /* Expand windows env var*/
-        long bufCharCount;
-        char *tempbuf;
-        if(NULL == (tempbuf = (char *)H5MM_malloc(H5PL_EXPAND_BUFFER_SIZE)))
-            HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for expanded path")
-        if((bufCharCount = ExpandEnvironmentStrings(dl_path, tempbuf, H5PL_EXPAND_BUFFER_SIZE)) > H5PL_EXPAND_BUFFER_SIZE) {
-            tempbuf = (char *)H5MM_xfree(tempbuf);
-            HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "expanded path is too long")
-        }
-        if(bufCharCount == 0) {
-            tempbuf = (char *)H5MM_xfree(tempbuf);
-            HGOTO_ERROR(H5E_PLUGIN, H5E_CANTGET, FAIL, "failed to expand path")
-        }
-        dl_path = (char *)H5MM_xfree(dl_path);
-        dl_path = H5MM_strdup(tempbuf);
-        tempbuf = (char *)H5MM_xfree(tempbuf);
-    }
-#endif /* H5_HAVE_WIN32_API */
+    H5PL_EXPAND_ENV_VAR
 
     /* Put paths in the path table.  They are separated by ":" */
     dir = HDstrtok(dl_path, H5PL_PATH_SEPARATOR);
diff --git a/src/H5PLpkg.h b/src/H5PLpkg.h
new file mode 100644
index 0000000..5cf3096
--- /dev/null
+++ b/src/H5PLpkg.h
@@ -0,0 +1,50 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * 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.     *
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+#if !(defined H5PL_FRIEND || defined H5PL_MODULE)
+#error "Do not include this file outside the H5PL package!"
+#endif
+
+#ifndef _H5PLpkg_H
+#define _H5PLpkg_H
+
+/* Include private header file */
+#include "H5PLprivate.h"          /* Filter functions                */
+
+/* Other private headers needed by this file */
+
+/**************************/
+/* Package Private Macros */
+/**************************/
+
+#define H5PL_MAX_PATH_NUM       16
+
+
+/****************************/
+/* Package Private Typedefs */
+/****************************/
+
+
+/*****************************/
+/* Package Private Variables */
+/*****************************/
+
+
+/******************************/
+/* Package Private Prototypes */
+/******************************/
+
+#endif /* _H5PLpkg_H */
+
diff --git a/src/H5PLpublic.h b/src/H5PLpublic.h
index 0528945..5e4dcae 100644
--- a/src/H5PLpublic.h
+++ b/src/H5PLpublic.h
@@ -44,6 +44,13 @@ extern "C" {
 /* plugin state */
 H5_DLL herr_t H5PLset_loading_state(unsigned int plugin_type);
 H5_DLL herr_t H5PLget_loading_state(unsigned int* plugin_type/*out*/);
+H5_DLL herr_t H5PLappend(const char* plugin_path);
+H5_DLL herr_t H5PLprepend(const char* plugin_path);
+H5_DLL herr_t H5PLreplace(const char* plugin_path, unsigned int index);
+H5_DLL herr_t H5PLinsert(const char* plugin_path, unsigned int index);
+H5_DLL herr_t H5PLremove(unsigned int index);
+H5_DLL ssize_t H5PLget(unsigned int index, char *pathname/*out*/, size_t size);
+H5_DLL unsigned int H5PLsize(void);
 
 #ifdef __cplusplus
 }