]> git.proxmox.com Git - ceph.git/blob - ceph/src/dpdk/lib/librte_eal/common/include/rte_errno.h
bump version to 12.2.12-pve1
[ceph.git] / ceph / src / dpdk / lib / librte_eal / common / include / rte_errno.h
1 /*-
2 * BSD LICENSE
3 *
4 * Copyright(c) 2010-2014 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 * @file
36 *
37 * API for error cause tracking
38 */
39
40 #ifndef _RTE_ERRNO_H_
41 #define _RTE_ERRNO_H_
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 #include <rte_per_lcore.h>
48
49 RTE_DECLARE_PER_LCORE(int, _rte_errno); /**< Per core error number. */
50
51 /**
52 * Error number value, stored per-thread, which can be queried after
53 * calls to certain functions to determine why those functions failed.
54 *
55 * Uses standard values from errno.h wherever possible, with a small number
56 * of additional possible values for RTE-specific conditions.
57 */
58 #define rte_errno RTE_PER_LCORE(_rte_errno)
59
60 /**
61 * Function which returns a printable string describing a particular
62 * error code. For non-RTE-specific error codes, this function returns
63 * the value from the libc strerror function.
64 *
65 * @param errnum
66 * The error number to be looked up - generally the value of rte_errno
67 * @return
68 * A pointer to a thread-local string containing the text describing
69 * the error.
70 */
71 const char *rte_strerror(int errnum);
72
73 #ifndef __ELASTERROR
74 /**
75 * Check if we have a defined value for the max system-defined errno values.
76 * if no max defined, start from 1000 to prevent overlap with standard values
77 */
78 #define __ELASTERROR 1000
79 #endif
80
81 /** Error types */
82 enum {
83 RTE_MIN_ERRNO = __ELASTERROR, /**< Start numbering above std errno vals */
84
85 E_RTE_SECONDARY, /**< Operation not allowed in secondary processes */
86 E_RTE_NO_CONFIG, /**< Missing rte_config */
87
88 RTE_MAX_ERRNO /**< Max RTE error number */
89 };
90
91 #ifdef __cplusplus
92 }
93 #endif
94
95 #endif /* _RTE_ERRNO_H_ */