F´ Flight Software - C/C++ Documentation devel
A framework for building embedded system applications to NASA flight quality standards.
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Assert.cpp
Go to the documentation of this file.
1#include <FpConfig.hpp>
2#include <Fw/Types/Assert.hpp>
3#include <cassert>
4#include <cstdio>
5
6#define FW_ASSERT_DFL_MSG_LEN 256
7
8#if FW_ASSERT_LEVEL == FW_FILEID_ASSERT
9#define fileIdFs "Assert: 0x%08" PRIx32 ":%" PRI_PlatformUIntType
10#else
11#define fileIdFs "Assert: \"%s:%" PRI_PlatformUIntType "\""
12#endif
13
14namespace Fw {
15
16 void defaultPrintAssert(const CHAR* msg) {
17 (void)fprintf(stderr,"%s\n", msg);
18 }
19
20 void defaultReportAssert
21 (
22 FILE_NAME_ARG file,
23 NATIVE_UINT_TYPE lineNo,
24 NATIVE_UINT_TYPE numArgs,
25 FwAssertArgType arg1,
26 FwAssertArgType arg2,
27 FwAssertArgType arg3,
28 FwAssertArgType arg4,
29 FwAssertArgType arg5,
30 FwAssertArgType arg6,
31 CHAR* destBuffer,
32 NATIVE_INT_TYPE buffSize
33 ) {
34
35 switch (numArgs) {
36 case 0:
37 (void) snprintf(destBuffer, buffSize, fileIdFs, file, lineNo);
38 break;
39 case 1:
40 (void) snprintf(
41 destBuffer,
42 buffSize,
43 fileIdFs " %" PRI_FwAssertArgType,
44 file,
45 lineNo,
46 arg1
47 );
48 break;
49 case 2:
50 (void) snprintf(
51 destBuffer,
52 buffSize,
53 fileIdFs " %" PRI_FwAssertArgType " %" PRI_FwAssertArgType,
54 file,
55 lineNo,
56 arg1, arg2
57 );
58 break;
59 case 3:
60 (void) snprintf(
61 destBuffer,
62 buffSize,
63 fileIdFs " %" PRI_FwAssertArgType " %" PRI_FwAssertArgType
64 " %" PRI_FwAssertArgType,
65 file,
66 lineNo,
67 arg1, arg2, arg3
68 );
69 break;
70 case 4:
71 (void) snprintf(
72 destBuffer,
73 buffSize,
74 fileIdFs " %" PRI_FwAssertArgType " %" PRI_FwAssertArgType
75 " %" PRI_FwAssertArgType " %" PRI_FwAssertArgType,
76 file,
77 lineNo,
78 arg1, arg2, arg3, arg4);
79 break;
80 case 5:
81 (void) snprintf(
82 destBuffer,
83 buffSize,
84 fileIdFs " %" PRI_FwAssertArgType " %" PRI_FwAssertArgType
85 " %" PRI_FwAssertArgType " %" PRI_FwAssertArgType
86 " %" PRI_FwAssertArgType,
87 file,
88 lineNo,
89 arg1, arg2, arg3, arg4, arg5
90 );
91 break;
92 case 6:
93 (void) snprintf(
94 destBuffer,
95 buffSize,
96 fileIdFs " %" PRI_FwAssertArgType " %" PRI_FwAssertArgType
97 " %" PRI_FwAssertArgType " %" PRI_FwAssertArgType
98 " %" PRI_FwAssertArgType " %" PRI_FwAssertArgType,
99 file,
100 lineNo,
101 arg1, arg2, arg3, arg4, arg5, arg6
102 );
103 break;
104 default: // in an assert already, what can we do?
105 break;
106 }
107
108 // null terminate
109 destBuffer[buffSize-1] = 0;
110
111 }
112
113 void AssertHook::printAssert(const CHAR* msg) {
114 defaultPrintAssert(msg);
115 }
116
117 void AssertHook::reportAssert
118 (
119 FILE_NAME_ARG file,
120 NATIVE_UINT_TYPE lineNo,
121 NATIVE_UINT_TYPE numArgs,
122 FwAssertArgType arg1,
123 FwAssertArgType arg2,
124 FwAssertArgType arg3,
125 FwAssertArgType arg4,
126 FwAssertArgType arg5,
127 FwAssertArgType arg6
128 )
129 {
130 CHAR destBuffer[FW_ASSERT_DFL_MSG_LEN];
131 defaultReportAssert
132 (
133 file,
134 lineNo,
135 numArgs,
136 arg1,
137 arg2,
138 arg3,
139 arg4,
140 arg5,
141 arg6,
142 destBuffer,
143 sizeof(destBuffer)
144 );
145 // print message
146 this->printAssert(destBuffer);
147 }
148
149 void AssertHook::doAssert() {
150 assert(0);
151 }
152
153 STATIC AssertHook* s_assertHook = nullptr;
154
155 void AssertHook::registerHook() {
156 this->previousHook = s_assertHook;
157 s_assertHook = this;
158 }
159
160 void AssertHook::deregisterHook() {
161 s_assertHook = this->previousHook;
162 }
163
164 // Default handler of SwAssert functions
165 NATIVE_INT_TYPE defaultSwAssert(
166 FILE_NAME_ARG file,
167 NATIVE_UINT_TYPE lineNo,
168 NATIVE_UINT_TYPE numArgs,
169 FwAssertArgType arg1,
170 FwAssertArgType arg2,
171 FwAssertArgType arg3,
172 FwAssertArgType arg4,
173 FwAssertArgType arg5,
174 FwAssertArgType arg6) {
175 if (nullptr == s_assertHook) {
176 CHAR assertMsg[FW_ASSERT_DFL_MSG_LEN];
177 defaultReportAssert(
178 file,
179 lineNo,
180 numArgs,
181 arg1,arg2,arg3,arg4,arg5,arg6,
182 assertMsg,sizeof(assertMsg));
183 defaultPrintAssert(assertMsg);
184 assert(0);
185 }
186 else {
187 s_assertHook->reportAssert(
188 file,
189 lineNo,
190 numArgs,
191 arg1,arg2,arg3,arg4,arg5,arg6);
192 s_assertHook->doAssert();
193 }
194 return 0;
195 }
196
197 NATIVE_INT_TYPE SwAssert(
198 FILE_NAME_ARG file,
199 NATIVE_UINT_TYPE lineNo) {
200 return defaultSwAssert(file, lineNo, 0, 0, 0, 0, 0, 0, 0);
201 }
202
203 NATIVE_INT_TYPE SwAssert(
204 FILE_NAME_ARG file,
205 FwAssertArgType arg1,
206 NATIVE_UINT_TYPE lineNo) {
207 return defaultSwAssert(file, lineNo, 1, arg1, 0, 0, 0, 0, 0);
208 }
209
210 NATIVE_INT_TYPE SwAssert(
211 FILE_NAME_ARG file,
212 FwAssertArgType arg1,
213 FwAssertArgType arg2,
214 NATIVE_UINT_TYPE lineNo) {
215 return defaultSwAssert(file, lineNo, 2, arg1, arg2, 0, 0, 0, 0);
216 }
217
218 NATIVE_INT_TYPE SwAssert(
219 FILE_NAME_ARG file,
220 FwAssertArgType arg1,
221 FwAssertArgType arg2,
222 FwAssertArgType arg3,
223 NATIVE_UINT_TYPE lineNo) {
224 return defaultSwAssert(file, lineNo, 3, arg1, arg2, arg3, 0, 0, 0);
225 }
226
227 NATIVE_INT_TYPE SwAssert(
228 FILE_NAME_ARG file,
229 FwAssertArgType arg1,
230 FwAssertArgType arg2,
231 FwAssertArgType arg3,
232 FwAssertArgType arg4,
233 NATIVE_UINT_TYPE lineNo) {
234 return defaultSwAssert(file, lineNo, 4, arg1, arg2, arg3, arg4, 0, 0);
235 }
236
237 NATIVE_INT_TYPE SwAssert(
238 FILE_NAME_ARG file,
239 FwAssertArgType arg1,
240 FwAssertArgType arg2,
241 FwAssertArgType arg3,
242 FwAssertArgType arg4,
243 FwAssertArgType arg5,
244 NATIVE_UINT_TYPE lineNo) {
245 return defaultSwAssert(file, lineNo, 5, arg1, arg2, arg3, arg4, arg5, 0);
246 }
247
248 NATIVE_INT_TYPE SwAssert(
249 FILE_NAME_ARG file,
250 FwAssertArgType arg1,
251 FwAssertArgType arg2,
252 FwAssertArgType arg3,
253 FwAssertArgType arg4,
254 FwAssertArgType arg5,
255 FwAssertArgType arg6,
256 NATIVE_UINT_TYPE lineNo) {
257 return defaultSwAssert(file, lineNo, 6, arg1, arg2, arg3, arg4, arg5, arg6);
258 }
259}
260
261// define C asserts.
262extern "C" {
263 NATIVE_INT_TYPE CAssert0(FILE_NAME_ARG file, NATIVE_UINT_TYPE lineNo);
264}
265
266NATIVE_INT_TYPE CAssert0(FILE_NAME_ARG file, NATIVE_UINT_TYPE lineNo) {
267 if (nullptr == Fw::s_assertHook) {
268 CHAR assertMsg[FW_ASSERT_DFL_MSG_LEN];
269 Fw::defaultReportAssert(
270 file,
271 lineNo,
272 0,
273 0,0,0,0,0,0,
274 assertMsg,sizeof(assertMsg));
275 }
276 else {
277 Fw::s_assertHook->reportAssert(
278 file,
279 lineNo,
280 0,
281 0,0,0,0,0,0);
282 Fw::s_assertHook->doAssert();
283 }
284 return 0;
285}
FW_ASSERT_DFL_MSG_LEN
#define FW_ASSERT_DFL_MSG_LEN
Definition Assert.cpp:6
fileIdFs
#define fileIdFs
Definition Assert.cpp:9
CAssert0
NATIVE_INT_TYPE CAssert0(FILE_NAME_ARG file, NATIVE_UINT_TYPE lineNo)
Definition Assert.cpp:266
FILE_NAME_ARG
#define FILE_NAME_ARG
Definition Assert.hpp:16
STATIC
#define STATIC
static for non unit-test code
Definition BasicTypes.h:71
NATIVE_INT_TYPE
PlatformIntType NATIVE_INT_TYPE
Definition BasicTypes.h:51
CHAR
char CHAR
Definition BasicTypes.h:28
NATIVE_UINT_TYPE
PlatformUIntType NATIVE_UINT_TYPE
Definition BasicTypes.h:52
FwAssertArgType
PlatformAssertArgType FwAssertArgType
Definition FpConfig.h:21
PRI_FwAssertArgType
#define PRI_FwAssertArgType
Definition FpConfig.h:22
FW_ASSERT_DFL_MSG_LEN
#define FW_ASSERT_DFL_MSG_LEN
Maximum assert message length when using the default assert handler.
Definition FpConfig.h:169
FpConfig.hpp
C++-compatible configuration header for fprime configuration.
Fw::AssertHook::reportAssert
virtual void reportAssert(FILE_NAME_ARG file, NATIVE_UINT_TYPE lineNo, NATIVE_UINT_TYPE numArgs, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6)
destructor
Definition Assert.cpp:118
Fw::AssertHook::deregisterHook
void deregisterHook()
Definition Assert.cpp:160
Fw::AssertHook::doAssert
virtual void doAssert()
Definition Assert.cpp:149
Fw::AssertHook::registerHook
void registerHook()
Definition Assert.cpp:155
Fw::AssertHook::printAssert
virtual void printAssert(const CHAR *msg)
Definition Assert.cpp:113
Fw::SwAssert
NATIVE_INT_TYPE SwAssert(FILE_NAME_ARG file, NATIVE_UINT_TYPE lineNo)
Assert with no arguments.
Definition Assert.cpp:197
Fw::defaultPrintAssert
void defaultPrintAssert(const CHAR *msg)
Definition Assert.cpp:16
Fw::defaultSwAssert
NATIVE_INT_TYPE defaultSwAssert(FILE_NAME_ARG file, NATIVE_UINT_TYPE lineNo, NATIVE_UINT_TYPE numArgs, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6)
Definition Assert.cpp:165
Fw::s_assertHook
STATIC AssertHook * s_assertHook
Definition Assert.cpp:153
Fw::defaultReportAssert
void defaultReportAssert(FILE_NAME_ARG file, NATIVE_UINT_TYPE lineNo, NATIVE_UINT_TYPE numArgs, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6, CHAR *destBuffer, NATIVE_INT_TYPE buffSize)
Definition Assert.cpp:21