89 строки
2.9 KiB
C
89 строки
2.9 KiB
C
/*
|
|
* Copyright (c) 2004-2005 The Trustees of Indiana University.
|
|
* All rights reserved.
|
|
* Copyright (c) 2004-2005 The Trustees of the University of Tennessee.
|
|
* All rights reserved.
|
|
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
|
|
* University of Stuttgart. All rights reserved.
|
|
* Copyright (c) 2004-2005 The Regents of the University of California.
|
|
* All rights reserved.
|
|
* $COPYRIGHT$
|
|
*
|
|
* Additional copyrights may follow
|
|
*
|
|
* $HEADER$
|
|
*/
|
|
|
|
#ifndef OPAL_UTIL_ERROR_H
|
|
#define OPAL_UTIL_ERROR_H
|
|
|
|
/**
|
|
* Prints error message for errnum on stderr
|
|
*
|
|
* Print the error message corresponding to the value of \c errnum and
|
|
* writes it, followed by a newline, to the standard error file
|
|
* descriptor. If the argument \c msg is non-NULL, this string is
|
|
* prepended to the message string and separated from it by a colon
|
|
* and a space. Otherwise, only the error message string is printed.
|
|
*
|
|
* If errnum is OPAL_ERR_IN_ERRNO, the system perror is called with
|
|
* the argument \c msg.
|
|
*/
|
|
OMPI_DECLSPEC void opal_perror(int errnum, const char *msg);
|
|
|
|
/**
|
|
* Return string for given error message
|
|
*
|
|
* Accepts an error number argument \c errnum and returns a pointer to
|
|
* the corresponding message string. The result is returned in a
|
|
* static buffer that should not be released with free().
|
|
*
|
|
* If errnum is \c OPAL_ERR_IN_ERRNO, the system strerror is called
|
|
* with an argument of the current value of \c errno and the resulting
|
|
* string is returned.
|
|
*
|
|
* If the errnum is not a known value, the returned value may be
|
|
* overwritten by subsequent calls to opal_strerror.
|
|
*/
|
|
OMPI_DECLSPEC const char *opal_strerror(int errnum);
|
|
|
|
/**
|
|
* Return string for given error message
|
|
*
|
|
* Similar to opal_strerror, but a buffer is passed in which is filled
|
|
* with a string (up to buflen - 1 characters long) containing the
|
|
* error message corresponding to \c errnum. Unlike opal_strerror(),
|
|
* if an unknown value for \c errnum is passed, the returned buffer
|
|
* will not be overwritten by subsequent calls to opal_strerror_r().
|
|
*/
|
|
OMPI_DECLSPEC int opal_strerror_r(int errnum, char *strerrbuf, size_t buflen);
|
|
|
|
|
|
typedef const char * (*opal_err2str_fn_t)(int errnum);
|
|
|
|
/**
|
|
* \internal
|
|
*
|
|
* Register a handler for converting errnums to error strings
|
|
*
|
|
* Handlers will be invoked by opal_perror() , opal_strerror(), and
|
|
* opal_strerror_r() to return the appropriate values.
|
|
*
|
|
* \note A maximum of 5 converters can be registered. The 6th
|
|
* converter registration attempt will return OPAL_ERR_OUT_OF_RESOURCE
|
|
*/
|
|
OMPI_DECLSPEC int opal_error_register(const char *project,
|
|
int err_base, int err_max,
|
|
opal_err2str_fn_t converter);
|
|
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* OPAL_UTIL_ERROR_H */
|