FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
error_bootstrap.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
17 
18  Permission is hereby granted, free of charge, to any person obtaining
19  a copy of this software and associated documentation files (the
20  "Software"), to deal in the Software without restriction, including
21  without limitation the rights to use, copy, modify, merge, publish,
22  distribute, sublicense, and/or sell copies of the Software, and to
23  permit persons to whom the Software is furnished to do so, subject to
24  the following conditions:
25 
26  The above copyright notice and this permission notice shall be
27  included in all copies or substantial portions of the Software.
28 
29  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 */
37 
38 #ifndef included_error_bootstrap_h
39 #define included_error_bootstrap_h
40 
41 /* Bootstrap include so that #include <vppinfra/mem.h> can include e.g.
42  <vppinfra/mheap.h> which depends on <vppinfra/vec.h>. */
43 
44 #include <vppinfra/clib.h> /* for uword */
45 
46 enum
47 {
48  CLIB_ERROR_FATAL = 1 << 0,
49  CLIB_ERROR_ABORT = 1 << 1,
53 };
54 
55 /* Current function name. Need (char *) cast to silence gcc4 pointer signedness warning. */
56 #define clib_error_function ((char *) __FUNCTION__)
57 
58 #ifndef CLIB_ASSERT_ENABLE
59 #define CLIB_ASSERT_ENABLE (CLIB_DEBUG > 0)
60 #endif
61 
62 /* Low level error reporting function.
63  Code specifies whether to call exit, abort or nothing at
64  all (for non-fatal warnings). */
65 extern void _clib_error (int code,
66  char *function_name,
67  uword line_number, char *format, ...);
68 
69 #define ASSERT(truth) \
70 do { \
71  if (CLIB_ASSERT_ENABLE && ! (truth)) \
72  { \
73  _clib_error (CLIB_ERROR_ABORT, 0, 0, \
74  "%s:%d (%s) assertion `%s' fails", \
75  __FILE__, \
76  (uword) __LINE__, \
77  clib_error_function, \
78  # truth); \
79  } \
80 } while (0)
81 
82 /*
83  * This version always generates code, and has a Coverity-specific
84  * version to stop Coverity complaining about
85  * ALWAYS_ASSERT(p != 0); p->member...
86  */
87 
88 #ifndef __COVERITY__
89 #define ALWAYS_ASSERT(truth) \
90 do { \
91  if (PREDICT_FALSE(!(truth))) \
92  { \
93  _clib_error (CLIB_ERROR_ABORT, 0, 0, \
94  "%s:%d (%s) assertion `%s' fails", \
95  __FILE__, \
96  (uword) __LINE__, \
97  clib_error_function, \
98  # truth); \
99  } \
100 } while (0)
101 #else /* __COVERITY__ */
102 #define ALWAYS_ASSERT(truth) \
103 do { \
104  if (PREDICT_FALSE(!(truth))) \
105  { \
106  abort(); \
107  } \
108 } while (0)
109 #endif /* __COVERITY */
110 
111 #define STATIC_ASSERT(truth,...) _Static_assert(truth, __VA_ARGS__)
112 
113 #define STATIC_ASSERT_SIZEOF(d, s) \
114  STATIC_ASSERT (sizeof (d) == s, "Size of " #d " must be " # s " bytes")
115 
116 #define STATIC_ASSERT_SIZEOF_ELT(d, e, s) \
117  STATIC_ASSERT (sizeof (((d *)0)->e) == s, "Size of " #d "." #e " must be " # s " bytes")
118 
119 #define STATIC_ASSERT_OFFSET_OF(s, e, o) \
120  STATIC_ASSERT (STRUCT_OFFSET_OF(s,e) == o, "Offset of " #s "." #e " must be " # o)
121 
122 #define STATIC_ASSERT_FITS_IN(s, e, o) \
123  STATIC_ASSERT (STRUCT_OFFSET_OF(s,e) <= (o - sizeof(((s *)0)->e)), \
124  #s "." #e " does not fit into " # o " bytes")
125 
126 /* Assert without allocating memory. */
127 #define ASSERT_AND_PANIC(truth) \
128 do { \
129  if (CLIB_ASSERT_ENABLE && ! (truth)) \
130  os_panic (); \
131 } while (0)
132 
133 #endif /* included_error_bootstrap_h */
134 
135 /*
136  * fd.io coding-style-patch-verification: ON
137  *
138  * Local Variables:
139  * eval: (c-set-style "gnu")
140  * End:
141  */
CLIB_ERROR_ABORT
@ CLIB_ERROR_ABORT
Definition: error_bootstrap.h:49
clib.h
CLIB_ERROR_NO_RATE_LIMIT
@ CLIB_ERROR_NO_RATE_LIMIT
Definition: error_bootstrap.h:52
CLIB_ERROR_WARNING
@ CLIB_ERROR_WARNING
Definition: error_bootstrap.h:50
uword
u64 uword
Definition: types.h:112
CLIB_ERROR_ERRNO_VALID
@ CLIB_ERROR_ERRNO_VALID
Definition: error_bootstrap.h:51
format
description fragment has unexpected format
Definition: map.api:433
CLIB_ERROR_FATAL
@ CLIB_ERROR_FATAL
Definition: error_bootstrap.h:48
function_name
unsigned char function_name[]
Definition: ad.c:32