9c1e0dc39a
The EAL API (with doxygen documentation) is moved from common/include/ to include/, which makes more clear that it is the global API for all environments and architectures. Note that the arch-specific and OS-specific include files are not in this global include directory, but include/generic/ should cover the doxygen documentation for them. Signed-off-by: Thomas Monjalon <thomas@monjalon.net> Acked-by: David Marchand <david.marchand@redhat.com>
67 lines
1.6 KiB
C
67 lines
1.6 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright(c) 2010-2014 Intel Corporation
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
*
|
|
* API for error cause tracking
|
|
*/
|
|
|
|
#ifndef _RTE_ERRNO_H_
|
|
#define _RTE_ERRNO_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <rte_per_lcore.h>
|
|
|
|
RTE_DECLARE_PER_LCORE(int, _rte_errno); /**< Per core error number. */
|
|
|
|
/**
|
|
* Error number value, stored per-thread, which can be queried after
|
|
* calls to certain functions to determine why those functions failed.
|
|
*
|
|
* Uses standard values from errno.h wherever possible, with a small number
|
|
* of additional possible values for RTE-specific conditions.
|
|
*/
|
|
#define rte_errno RTE_PER_LCORE(_rte_errno)
|
|
|
|
/**
|
|
* Function which returns a printable string describing a particular
|
|
* error code. For non-RTE-specific error codes, this function returns
|
|
* the value from the libc strerror function.
|
|
*
|
|
* @param errnum
|
|
* The error number to be looked up - generally the value of rte_errno
|
|
* @return
|
|
* A pointer to a thread-local string containing the text describing
|
|
* the error.
|
|
*/
|
|
const char *rte_strerror(int errnum);
|
|
|
|
#ifndef __ELASTERROR
|
|
/**
|
|
* Check if we have a defined value for the max system-defined errno values.
|
|
* if no max defined, start from 1000 to prevent overlap with standard values
|
|
*/
|
|
#define __ELASTERROR 1000
|
|
#endif
|
|
|
|
/** Error types */
|
|
enum {
|
|
RTE_MIN_ERRNO = __ELASTERROR, /**< Start numbering above std errno vals */
|
|
|
|
E_RTE_SECONDARY, /**< Operation not allowed in secondary processes */
|
|
E_RTE_NO_CONFIG, /**< Missing rte_config */
|
|
|
|
RTE_MAX_ERRNO /**< Max RTE error number */
|
|
};
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _RTE_ERRNO_H_ */
|