lib/librte_eal/common/include/rte_errno.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 /**
  36  * @file
  37  *
  38  * API for error cause tracking
  39  */
  40
  41 #ifndef _RTE_ERRNO_H_
  42 #define _RTE_ERRNO_H_
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #include <rte_per_lcore.h>
  49
  50 RTE_DECLARE_PER_LCORE(int, _rte_errno); /**< Per core error number. */
  51
  52 /**
  53  * Error number value, stored per-thread, which can be queried after
  54  * calls to certain functions to determine why those functions failed.
  55  *
  56  * Uses standard values from errno.h wherever possible, with a small number
  57  * of additional possible values for RTE-specific conditions.
  58  */
  59 #define rte_errno RTE_PER_LCORE(_rte_errno)
  60
  61 /**
  62  * Function which returns a printable string describing a particular
  63  * error code. For non-RTE-specific error codes, this function returns
  64  * the value from the libc strerror function.
  65  *
  66  * @param errnum
  67  *   The error number to be looked up - generally the value of rte_errno
  68  * @return
  69  *   A pointer to a thread-local string containing the text describing
  70  *   the error.
  71  */
  72 const char *rte_strerror(int errnum);
  73
  74 #ifndef __ELASTERROR
  75 /**
  76  * Check if we have a defined value for the max system-defined errno values.
  77  * if no max defined, start from 1000 to prevent overlap with standard values
  78  */
  79 #define __ELASTERROR 1000
  80 #endif
  81
  82 /** Error types */
  83 enum {
  84         RTE_MIN_ERRNO = __ELASTERROR, /**< Start numbering above std errno vals */
  85
  86         E_RTE_SECONDARY, /**< Operation not allowed in secondary processes */
  87         E_RTE_NO_CONFIG, /**< Missing rte_config */
  88         E_RTE_NO_TAILQ,  /**< Uninitialised TAILQ */
  89
  90         RTE_MAX_ERRNO    /**< Max RTE error number */
  91 };
  92
  93 #ifdef __cplusplus
  94 }
  95 #endif
  96
  97 #endif /* _RTE_ERRNO_H_ */