F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Assert.cpp
Go to the documentation of this file.
2 #include <Fw/Types/Assert.hpp>
5 #include <cstdio>
6 #include <cstdlib>
7 
8 namespace Fw {
9 
10 void AssertHook::printAssert(const CHAR* msg) {
11  printAssertMessage(msg);
12 }
13 
15  FwSizeType lineNo,
16  FwSizeType numArgs,
17  FwAssertArgType arg1,
18  FwAssertArgType arg2,
19  FwAssertArgType arg3,
20  FwAssertArgType arg4,
21  FwAssertArgType arg5,
22  FwAssertArgType arg6) {
23  CHAR destBuffer[FW_ASSERT_TEXT_SIZE] = {0};
24  formatAssertMessage(file, lineNo, numArgs, arg1, arg2, arg3, arg4, arg5, arg6, destBuffer,
25  static_cast<FwSizeType>(sizeof(destBuffer)));
26  // print message
27  this->printAssert(destBuffer);
28 }
29 
32 }
33 
34 AssertHook* AssertHook::s_assertHook = nullptr;
35 
37  this->previousHook = s_assertHook;
38  s_assertHook = this;
39 }
40 
42  s_assertHook = this->previousHook;
43 }
44 
46  return s_assertHook;
47 }
48 
49 // Default handler of SwAssert functions
51  FwSizeType lineNo,
52  FwSizeType numArgs,
53  FwAssertArgType arg1,
54  FwAssertArgType arg2,
55  FwAssertArgType arg3,
56  FwAssertArgType arg4,
57  FwAssertArgType arg5,
58  FwAssertArgType arg6) {
59  Fw::AssertHook* const registeredHook = Fw::AssertHook::getRegisteredHook();
60  if (nullptr == registeredHook) {
61  CHAR assertMsg[FW_ASSERT_TEXT_SIZE];
62  formatAssertMessage(file, lineNo, numArgs, arg1, arg2, arg3, arg4, arg5, arg6, assertMsg,
63  static_cast<FwSizeType>(sizeof(assertMsg)));
64  printAssertMessage(assertMsg);
66  } else {
67  registeredHook->reportAssert(file, lineNo, numArgs, arg1, arg2, arg3, arg4, arg5, arg6);
68  registeredHook->doAssert();
69  }
70 #if FW_ASSERTIONS_ALWAYS_ABORT
71  abort();
72 #endif
73 }
74 
76  defaultSwAssert(file, lineNo, 0, 0, 0, 0, 0, 0, 0);
77 }
78 
80  defaultSwAssert(file, lineNo, 1, arg1, 0, 0, 0, 0, 0);
81 }
82 
84  defaultSwAssert(file, lineNo, 2, arg1, arg2, 0, 0, 0, 0);
85 }
86 
88  defaultSwAssert(file, lineNo, 3, arg1, arg2, arg3, 0, 0, 0);
89 }
90 
92  FwAssertArgType arg1,
93  FwAssertArgType arg2,
94  FwAssertArgType arg3,
95  FwAssertArgType arg4,
96  FwSizeType lineNo) {
97  defaultSwAssert(file, lineNo, 4, arg1, arg2, arg3, arg4, 0, 0);
98 }
99 
101  FwAssertArgType arg1,
102  FwAssertArgType arg2,
103  FwAssertArgType arg3,
104  FwAssertArgType arg4,
105  FwAssertArgType arg5,
106  FwSizeType lineNo) {
107  defaultSwAssert(file, lineNo, 5, arg1, arg2, arg3, arg4, arg5, 0);
108 }
109 
111  FwAssertArgType arg1,
112  FwAssertArgType arg2,
113  FwAssertArgType arg3,
114  FwAssertArgType arg4,
115  FwAssertArgType arg5,
116  FwAssertArgType arg6,
117  FwSizeType lineNo) {
118  defaultSwAssert(file, lineNo, 6, arg1, arg2, arg3, arg4, arg5, arg6);
119 }
120 } // namespace Fw
121 
122 // define C asserts with C linkage
123 extern "C" {
129  FwAssertArgType arg1,
130  FwAssertArgType arg2,
131  FwAssertArgType arg3,
132  FwAssertArgType arg4,
133  FwSizeType lineNo);
135  FwAssertArgType arg1,
136  FwAssertArgType arg2,
137  FwAssertArgType arg3,
138  FwAssertArgType arg4,
139  FwAssertArgType arg5,
140  FwSizeType lineNo);
142  FwAssertArgType arg1,
143  FwAssertArgType arg2,
144  FwAssertArgType arg3,
145  FwAssertArgType arg4,
146  FwAssertArgType arg5,
147  FwAssertArgType arg6,
148  FwSizeType lineNo);
149 }
150 
152  Fw::defaultSwAssert(file, lineNo, 0, 0, 0, 0, 0, 0, 0);
153  return 0;
154 }
155 
157  Fw::defaultSwAssert(file, lineNo, 1, arg1, 0, 0, 0, 0, 0);
158  return 0;
159 }
160 
162  Fw::defaultSwAssert(file, lineNo, 2, arg1, arg2, 0, 0, 0, 0);
163  return 0;
164 }
165 
167  Fw::defaultSwAssert(file, lineNo, 3, arg1, arg2, arg3, 0, 0, 0);
168  return 0;
169 }
170 
172  FwAssertArgType arg1,
173  FwAssertArgType arg2,
174  FwAssertArgType arg3,
175  FwAssertArgType arg4,
176  FwSizeType lineNo) {
177  Fw::defaultSwAssert(file, lineNo, 4, arg1, arg2, arg3, arg4, 0, 0);
178  return 0;
179 }
180 
182  FwAssertArgType arg1,
183  FwAssertArgType arg2,
184  FwAssertArgType arg3,
185  FwAssertArgType arg4,
186  FwAssertArgType arg5,
187  FwSizeType lineNo) {
188  Fw::defaultSwAssert(file, lineNo, 5, arg1, arg2, arg3, arg4, arg5, 0);
189  return 0;
190 }
191 
193  FwAssertArgType arg1,
194  FwAssertArgType arg2,
195  FwAssertArgType arg3,
196  FwAssertArgType arg4,
197  FwAssertArgType arg5,
198  FwAssertArgType arg6,
199  FwSizeType lineNo) {
200  Fw::defaultSwAssert(file, lineNo, 6, arg1, arg2, arg3, arg4, arg5, arg6);
201  return 0;
202 }
void formatAssertMessage(FILE_NAME_ARG file, FwSizeType lineNo, FwSizeType numArgs, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6, CHAR *destBuffer, FwSizeType buffSize)
format an assert message
I8 CAssert1(FILE_NAME_ARG file, FwAssertArgType arg1, FwSizeType lineNo)
Definition: Assert.cpp:156
PlatformSizeType FwSizeType
I8 CAssert2(FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwSizeType lineNo)
Definition: Assert.cpp:161
FW_ASSERT_NORETURN void defaultSwAssert(FILE_NAME_ARG file, FwSizeType lineNo, FwSizeType numArgs, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6)
Definition: Assert.cpp:50
int8_t I8
8-bit signed integer
Definition: BasicTypes.h:51
char CHAR
Definition: BasicTypes.h:60
#define FILE_NAME_ARG
Definition: Assert.hpp:16
static AssertHook * getRegisteredHook()
Definition: Assert.cpp:45
void SwAssert(FILE_NAME_ARG file, FwSizeType lineNo)
Assert with no arguments.
Definition: Assert.cpp:75
void deregisterHook()
Definition: Assert.cpp:41
I8 CAssert3(FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwSizeType lineNo)
Definition: Assert.cpp:166
virtual void doAssert()
Definition: Assert.cpp:30
void printAssertMessage(const CHAR *msg)
print an assert message
#define FW_ASSERT_TEXT_SIZE
Size of string used to store assert description // NO_CODESONAR LANG.PREPROC.MACROSTART/END.
virtual void reportAssert(FILE_NAME_ARG file, FwSizeType lineNo, FwSizeType numArgs, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6)
destructor
Definition: Assert.cpp:14
I8 CAssert6(FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6, FwSizeType lineNo)
Definition: Assert.cpp:192
void registerHook()
Definition: Assert.cpp:36
virtual void printAssert(const CHAR *msg)
Definition: Assert.cpp:10
I8 CAssert0(FILE_NAME_ARG file, FwSizeType lineNo)
Definition: Assert.cpp:151
I8 CAssert5(FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwSizeType lineNo)
Definition: Assert.cpp:181
Implementation of malloc based allocator.
I8 CAssert4(FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwSizeType lineNo)
Definition: Assert.cpp:171
void terminateOnAssert()
terminate after a failed assertion
#define FW_ASSERT_NORETURN
Definition: Assert.hpp:65
PlatformAssertArgType FwAssertArgType
The type of arguments to assert functions.