mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-03-25 17:00:45 +08:00
44a00ef876
* Strip HD prefix from string/char C API calls * HD(f)(put|get)(s|c) * HDstr* * HDv*printf * HD(s)(print|scan)f * HDperror But NOT: * HDstrcase* * HDvasprintf * HDstrtok_r * HDstrndup As those are not C99 and have portability work-around implementations. They will be handled later. * Fix th5_system.c screwup
402 lines
14 KiB
C
402 lines
14 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Copyright by The HDF Group. *
|
|
* 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 COPYING file, which can be found at the root of the source code *
|
|
* distribution tree, or in https://www.hdfgroup.org/licenses. *
|
|
* If you do not have access to either file, you may request a copy from *
|
|
* help@hdfgroup.org. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
/****************/
|
|
/* Module Setup */
|
|
/****************/
|
|
|
|
#include "H5PLmodule.h" /* This source code file is part of the H5PL module */
|
|
|
|
/***********/
|
|
/* Headers */
|
|
/***********/
|
|
#include "H5private.h" /* Generic Functions */
|
|
#include "H5Eprivate.h" /* Error handling */
|
|
#include "H5PLpkg.h" /* Plugin */
|
|
|
|
/****************/
|
|
/* Local Macros */
|
|
/****************/
|
|
|
|
/******************/
|
|
/* Local Typedefs */
|
|
/******************/
|
|
|
|
/********************/
|
|
/* Local Prototypes */
|
|
/********************/
|
|
|
|
/*********************/
|
|
/* Package Variables */
|
|
/*********************/
|
|
|
|
/*****************************/
|
|
/* Library Private Variables */
|
|
/*****************************/
|
|
|
|
/*******************/
|
|
/* Local Variables */
|
|
/*******************/
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5PLset_loading_state
|
|
*
|
|
* Purpose: Control the loading of dynamic plugin types.
|
|
*
|
|
* The plugin_control_mask parameter is a bitfield that controls
|
|
* whether certain classes of plugins (e.g.: filters,
|
|
* VOL drivers) will be loaded by the library.
|
|
*
|
|
* plugin bit = 0, will prevent the use of that dynamic plugin type.
|
|
* plugin bit = 1, will allow the use of that dynamic plugin type.
|
|
*
|
|
* A list of pre-defined masks can be found in H5PLpublic.h.
|
|
* Set the mask to 0 to disable all plugins.
|
|
*
|
|
* This function will not allow plugin types if the pathname
|
|
* from the HDF5_PLUGIN_PRELOAD environment variable is set to
|
|
* the special "::" string.
|
|
*
|
|
* Return: Success: Non-negative
|
|
* Failure: Negative
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
herr_t
|
|
H5PLset_loading_state(unsigned int plugin_control_mask)
|
|
{
|
|
herr_t ret_value = SUCCEED; /* Return value */
|
|
|
|
FUNC_ENTER_API(FAIL)
|
|
H5TRACE1("e", "Iu", plugin_control_mask);
|
|
|
|
/* Set the plugin control mask */
|
|
if (H5PL__set_plugin_control_mask(plugin_control_mask) < 0)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_CANTSET, FAIL, "error setting plugin control mask");
|
|
|
|
done:
|
|
FUNC_LEAVE_API(ret_value)
|
|
} /* end H5PLset_loading_state() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5PLget_loading_state
|
|
*
|
|
* Purpose: Get the bitmask that controls whether certain classes
|
|
* of plugins (e.g.: filters, VOL drivers) will be loaded
|
|
* by the library.
|
|
*
|
|
* Zero if all plugin types are disabled
|
|
* Negative if all plugin types are enabled
|
|
* Positive if one or more of the plugin types are enabled
|
|
*
|
|
* Return: Success: Non-negative
|
|
* Failure: Negative
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
herr_t
|
|
H5PLget_loading_state(unsigned *plugin_control_mask /*out*/)
|
|
{
|
|
herr_t ret_value = SUCCEED; /* Return value */
|
|
|
|
FUNC_ENTER_API(FAIL)
|
|
H5TRACE1("e", "x", plugin_control_mask);
|
|
|
|
if (NULL == plugin_control_mask)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "plugin_control_mask parameter cannot be NULL");
|
|
|
|
/* Set the plugin control mask */
|
|
if (H5PL__get_plugin_control_mask(plugin_control_mask) < 0)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_CANTGET, FAIL, "error getting plugin control mask");
|
|
|
|
done:
|
|
FUNC_LEAVE_API(ret_value)
|
|
} /* end H5PLget_loading_state() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5PLappend
|
|
*
|
|
* Purpose: Insert a plugin search path at the end of the list.
|
|
*
|
|
* Return: Success: Non-negative
|
|
* Failure: Negative
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
herr_t
|
|
H5PLappend(const char *search_path)
|
|
{
|
|
herr_t ret_value = SUCCEED; /* Return value */
|
|
|
|
FUNC_ENTER_API(FAIL)
|
|
H5TRACE1("e", "*s", search_path);
|
|
|
|
/* Check args */
|
|
if (NULL == search_path)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "plugin_path parameter cannot be NULL");
|
|
if (0 == strlen(search_path))
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "plugin_path parameter cannot have length zero");
|
|
|
|
/* Append the search path to the path table */
|
|
if (H5PL__append_path(search_path) < 0)
|
|
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTAPPEND, FAIL, "unable to append search path");
|
|
|
|
done:
|
|
FUNC_LEAVE_API(ret_value)
|
|
} /* end H5PLappend() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5PLprepend
|
|
*
|
|
* Purpose: Insert a plugin search path at the beginning of the list.
|
|
*
|
|
* Return: Success: Non-negative
|
|
* Failure: Negative
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
herr_t
|
|
H5PLprepend(const char *search_path)
|
|
{
|
|
herr_t ret_value = SUCCEED; /* Return value */
|
|
|
|
FUNC_ENTER_API(FAIL)
|
|
H5TRACE1("e", "*s", search_path);
|
|
|
|
/* Check args */
|
|
if (NULL == search_path)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "plugin_path parameter cannot be NULL");
|
|
if (0 == strlen(search_path))
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "plugin_path parameter cannot have length zero");
|
|
|
|
/* Prepend the search path to the path table */
|
|
if (H5PL__prepend_path(search_path) < 0)
|
|
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTINSERT, FAIL, "unable to prepend search path");
|
|
|
|
done:
|
|
FUNC_LEAVE_API(ret_value)
|
|
} /* end H5PLprepend() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5PLreplace
|
|
*
|
|
* Purpose: Replace the path at the specified index. The path at the
|
|
* index must exist.
|
|
*
|
|
* Return: Non-negative or success.
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
herr_t
|
|
H5PLreplace(const char *search_path, unsigned int idx)
|
|
{
|
|
unsigned num_paths; /* Current number of stored paths */
|
|
herr_t ret_value = SUCCEED; /* Return value */
|
|
|
|
FUNC_ENTER_API(FAIL)
|
|
H5TRACE2("e", "*sIu", search_path, idx);
|
|
|
|
/* Check args */
|
|
if (NULL == search_path)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "plugin_path parameter cannot be NULL");
|
|
if (0 == strlen(search_path))
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "plugin_path parameter cannot have length zero");
|
|
|
|
/* Check index */
|
|
num_paths = H5PL__get_num_paths();
|
|
if (0 == num_paths)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL, "path table is empty");
|
|
else if (idx >= num_paths)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
|
|
"index path out of bounds for table - can't be more than %u", (num_paths - 1));
|
|
|
|
/* Insert the search path into the path table */
|
|
if (H5PL__replace_path(search_path, idx) < 0)
|
|
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTINSERT, FAIL, "unable to replace search path");
|
|
|
|
done:
|
|
FUNC_LEAVE_API(ret_value)
|
|
} /* end H5PLreplace() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5PLinsert
|
|
*
|
|
* Purpose: Insert a plugin search path at the specified index, moving
|
|
* other paths after the index.
|
|
*
|
|
* Return: Success: Non-negative
|
|
* Failure: Negative
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
herr_t
|
|
H5PLinsert(const char *search_path, unsigned int idx)
|
|
{
|
|
unsigned num_paths; /* Current number of stored paths */
|
|
herr_t ret_value = SUCCEED; /* Return value */
|
|
|
|
FUNC_ENTER_API(FAIL)
|
|
H5TRACE2("e", "*sIu", search_path, idx);
|
|
|
|
/* Check args */
|
|
if (NULL == search_path)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "plugin_path parameter cannot be NULL");
|
|
if (0 == strlen(search_path))
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "plugin_path parameter cannot have length zero");
|
|
|
|
/* Check index */
|
|
num_paths = H5PL__get_num_paths();
|
|
if ((0 != num_paths) && (idx >= num_paths))
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
|
|
"index path out of bounds for table - can't be more than %u", (num_paths - 1));
|
|
|
|
/* Insert the search path into the path table */
|
|
if (H5PL__insert_path(search_path, idx) < 0)
|
|
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTINSERT, FAIL, "unable to insert search path");
|
|
|
|
done:
|
|
FUNC_LEAVE_API(ret_value)
|
|
} /* end H5PLinsert() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5PLremove
|
|
*
|
|
* Purpose: Remove the plugin path at the specified index and compact
|
|
* the list.
|
|
*
|
|
* Return: Success: Non-negative
|
|
* Failure: Negative
|
|
*
|
|
* Return: Non-negative or success.
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
herr_t
|
|
H5PLremove(unsigned int idx)
|
|
{
|
|
unsigned num_paths; /* Current number of stored paths */
|
|
herr_t ret_value = SUCCEED; /* Return value */
|
|
|
|
FUNC_ENTER_API(FAIL)
|
|
H5TRACE1("e", "Iu", idx);
|
|
|
|
/* Check index */
|
|
num_paths = H5PL__get_num_paths();
|
|
if (0 == num_paths)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL, "path table is empty");
|
|
else if (idx >= num_paths)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
|
|
"index path out of bounds for table - can't be more than %u", (num_paths - 1));
|
|
|
|
/* Delete the search path from the path table */
|
|
if (H5PL__remove_path(idx) < 0)
|
|
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTDELETE, FAIL, "unable to remove search path");
|
|
|
|
done:
|
|
FUNC_LEAVE_API(ret_value)
|
|
} /* end H5PLremove() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5PLget
|
|
*
|
|
* Purpose: Query the plugin path at a specified index.
|
|
*
|
|
* If 'path_buf' is non-NULL then up to 'buf_size' bytes will be written into
|
|
* that buffer and the length of the path name will be returned.
|
|
*
|
|
* If 'path_buf' is NULL, this function will simply return the number of
|
|
* characters required to store the path name, ignoring 'path_buf' and
|
|
* 'buf_size'
|
|
*
|
|
* If an error occurs then the buffer pointed to by 'path_buf'
|
|
* (NULL or non-NULL) will be unchanged and the function will return a
|
|
* negative value.
|
|
*
|
|
* If a zero is returned for the name's length, then there is no path name
|
|
* associated with the index and the 'path_buf' buffer will be unchanged.
|
|
*
|
|
* Return: Success: The length of path
|
|
* Failure: A negative value
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
ssize_t
|
|
H5PLget(unsigned int idx, char *path_buf, size_t buf_size)
|
|
{
|
|
unsigned num_paths; /* Current number of stored paths */
|
|
const char *path = NULL; /* path from table */
|
|
size_t path_len = 0; /* Length of path */
|
|
ssize_t ret_value = 0; /* Return value */
|
|
|
|
FUNC_ENTER_API(FAIL)
|
|
H5TRACE3("Zs", "Iu*sz", idx, path_buf, buf_size);
|
|
|
|
/* Check index */
|
|
num_paths = H5PL__get_num_paths();
|
|
if (0 == num_paths)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL, "path table is empty");
|
|
else if (idx >= num_paths)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
|
|
"index path out of bounds for table - can't be more than %u", (num_paths - 1));
|
|
|
|
/* Check if the search table is empty */
|
|
if (H5PL__get_num_paths() == 0)
|
|
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, (-1), "plugin search path table is empty");
|
|
|
|
/* Get the path at the specified index and its length */
|
|
if (NULL == (path = H5PL__get_path(idx)))
|
|
HGOTO_ERROR(H5E_PLUGIN, H5E_BADVALUE, (-1), "no path stored at that index");
|
|
path_len = strlen(path);
|
|
|
|
/* If the path buffer is not NULL, copy the path to the buffer */
|
|
if (path_buf) {
|
|
strncpy(path_buf, path, buf_size);
|
|
if ((size_t)path_len >= buf_size)
|
|
path_buf[buf_size - 1] = '\0';
|
|
} /* end if */
|
|
|
|
/* Set return value */
|
|
ret_value = (ssize_t)path_len;
|
|
|
|
done:
|
|
FUNC_LEAVE_API(ret_value)
|
|
} /* end H5PLget() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5PLsize
|
|
*
|
|
* Purpose: Get the number of stored plugin paths.
|
|
* XXX: This is a terrible name. Can it be changed?
|
|
*
|
|
* Return: SUCCEED/FAIL
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
herr_t
|
|
H5PLsize(unsigned int *num_paths)
|
|
{
|
|
herr_t ret_value = SUCCEED; /* Return value */
|
|
|
|
FUNC_ENTER_API(FAIL)
|
|
H5TRACE1("e", "*Iu", num_paths);
|
|
|
|
/* Check arguments */
|
|
if (!num_paths)
|
|
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "num_paths parameter cannot be NULL");
|
|
|
|
/* Get the number of stored plugin paths */
|
|
*num_paths = H5PL__get_num_paths();
|
|
|
|
done:
|
|
FUNC_LEAVE_API(ret_value)
|
|
} /* end H5PLsize() */
|