-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
Copy pathassert.h
206 lines (170 loc) · 7.06 KB
/
assert.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/****************************************************************************
* include/assert.h
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
#ifndef __INCLUDE_ASSERT_H
#define __INCLUDE_ASSERT_H
#ifndef __ASSEMBLY__
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/compiler.h>
#include <sys/types.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Macro Name: PANIC, ASSERT, VERIFY, et al. */
#undef PANIC /* Unconditional abort */
#undef ASSERT /* Assert if the condition is not true */
#undef VERIFY /* Assert if a function returns a negative value */
#undef DEBUGPANIC /* Like PANIC, but only if CONFIG_DEBUG_ASSERTIONS is defined */
#undef DEBUGASSERT /* Like ASSERT, but only if CONFIG_DEBUG_ASSERTIONS is defined */
#undef DEBUGVERIFY /* Like VERIFY, but only if CONFIG_DEBUG_ASSERTIONS is defined */
/* Macro to define the assertions file name and file line
* | Function |CONFIG | Show name/line |
* | --- | --- | --- |
* |assert(), ASSERT()|CONFIG_ASSERTIONS_FILENAME=y | Yes |
* |assert(), ASSERT()|CONFIG_ASSERTIONS_FILENAME=n | No |
* |DEBUGASSERT() |CONFIG_DEBUG_ASSERTIONS_FILENAME=y| Yes |
* |DEBUGASSERT() |CONFIG_DEBUG_ASSERTIONS_FILENAME=n| No |
*/
#ifdef CONFIG_HAVE_FILENAME
# ifdef CONFIG_DEBUG_ASSERTIONS_FILENAME
# define __DEBUG_ASSERT_FILE__ __FILE__
# define __DEBUG_ASSERT_LINE__ __LINE__
# endif
# ifdef CONFIG_ASSERTIONS_FILENAME
# define __ASSERT_FILE__ __FILE__
# define __ASSERT_LINE__ __LINE__
# endif
#endif
#ifndef __DEBUG_ASSERT_FILE__
# define __DEBUG_ASSERT_FILE__ 0
# define __DEBUG_ASSERT_LINE__ 0
#endif
#ifndef __ASSERT_FILE__
# define __ASSERT_FILE__ 0
# define __ASSERT_LINE__ 0
#endif
#define PANIC() __assert(__ASSERT_FILE__, __ASSERT_LINE__, "panic")
#define PANIC_WITH_REGS(msg, regs) _assert(__ASSERT_FILE__, \
__ASSERT_LINE__, msg, regs)
#define __ASSERT__(f, file, line, _f) \
(predict_false(!(f))) ? __assert(file, line, _f) : ((void)0)
#define __VERIFY__(f, file, line, _f) \
(predict_false((f) < 0)) ? __assert(file, line, _f) : ((void)0)
#ifdef CONFIG_DEBUG_ASSERTIONS_EXPRESSION
# define _ASSERT(f,file,line) __ASSERT__(f, file, line, #f)
# define _VERIFY(f,file,line) __VERIFY__(f, file, line, #f)
#else
# define _ASSERT(f,file,line) __ASSERT__(f, file, line, NULL)
# define _VERIFY(f,file,line) __VERIFY__(f, file, line, NULL)
#endif
#ifdef CONFIG_DEBUG_ASSERTIONS
# define DEBUGPANIC() __assert(__DEBUG_ASSERT_FILE__, __DEBUG_ASSERT_LINE__, "panic")
# define DEBUGASSERT(f) _ASSERT(f, __DEBUG_ASSERT_FILE__, __DEBUG_ASSERT_LINE__)
# define DEBUGVERIFY(f) _VERIFY(f, __DEBUG_ASSERT_FILE__, __DEBUG_ASSERT_LINE__)
#else
# define DEBUGPANIC()
# define DEBUGASSERT(f) ((void)(1 || (f)))
# define DEBUGVERIFY(f) ((void)(f))
#endif
/* The C standard states that if NDEBUG is defined, assert will do nothing.
* Users can define and undefine NDEBUG as they see fit to choose when assert
* does something or does not do anything.
*
* #define assert(ignore) ((void)0)
*
* Reference link:
* https://pubs.opengroup.org/onlinepubs/009695399/basedefs/assert.h.html
*/
#ifdef NDEBUG
# define assert(f) ((void)0)
#else
# define assert(f) _ASSERT(f, __ASSERT_FILE__, __ASSERT_LINE__)
#endif
/* ASSERT/VERIFY are NuttX-specific APIs.
* They are always enabled, regardless of NDEBUG/CONFIG_DEBUG_ASSERTIONS.
* The argument is evaluated exactly once.
*/
#define ASSERT(f) _ASSERT(f, __ASSERT_FILE__, __ASSERT_LINE__)
#define VERIFY(f) _VERIFY(f, __ASSERT_FILE__, __ASSERT_LINE__)
/* Suppress 3rd party library redefine _assert/__assert */
#define _assert _assert
#define __assert __assert
/* Definition required for C11 compile-time assertion checking. The
* static_assert macro simply expands to the _Static_assert keyword.
*/
#ifndef __cplusplus
# if defined(__STDC_VERSION__) && __STDC_VERSION__ > 199901L
# define static_assert _Static_assert
# else
# define static_assert(cond, msg) \
extern int (*__static_assert_function(void)) \
[!!sizeof (struct { int __error_if_negative: (cond) ? 2 : -1; })]
# endif
#endif
#ifndef COMPILE_TIME_ASSERT
# define COMPILE_TIME_ASSERT(x) static_assert(x, "compile time assert failed")
#endif
/* Force a compilation error if condition is true, but also produce a
* result (of value 0 and type int), so the expression can be used
* e.g. in a structure initializer (or where-ever else comma expressions
* aren't permitted).
*/
#define BUILD_BUG_ON_ZERO(e) ((int)(sizeof(struct { int:(-!!(e)); })))
/****************************************************************************
* Public Data
****************************************************************************/
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: _assert
*
* Description:
* This is the assert system call that performs the core dump etc. Function
* might not return if it is not safe to do so (in IRQ or in IDLE task).
*
****************************************************************************/
void _assert(FAR const char *filename, int linenum,
FAR const char *msg, FAR void *regs);
/****************************************************************************
* Name: __assert
*
* Description:
* This is the user space assert procedure.
*
****************************************************************************/
void __assert(FAR const char *filename, int linenum,
FAR const char *msg) noreturn_function;
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __ASSEMBLY__ */
#endif /* __INCLUDE_ASSERT_H */