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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
|
/* $Id: kHlpAssert.h 119 2021-12-19 13:01:47Z bird $ */
/** @file
* kHlpAssert - Assertion Macros.
*/
/*
* Copyright (c) 2006-2007 Knut St. Osmundsen <bird-kStuff-spamix@anduin.net>
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef ___kHlpAssert_h___
#define ___kHlpAssert_h___
#include <k/kHlpDefs.h>
#ifdef __cplusplus
extern "C" {
#endif
/** @defgroup grp_kHlpAssert - Assertion Macros
* @addtogroup grp_kHlp
* @{ */
/** @def K_STRICT
* Assertions are enabled when K_STRICT is \#defined. */
/** @def kHlpAssertBreakpoint
* Emits a breakpoint instruction or somehow triggers a debugger breakpoint.
*/
#ifdef _MSC_VER
# define kHlpAssertBreakpoint() do { __debugbreak(); } while (0)
#elif defined(__GNUC__) && K_OS == K_OS_SOLARIS && (K_ARCH == K_ARCH_AMD64 || K_ARCH == K_ARCH_X86_32)
# define kHlpAssertBreakpoint() do { __asm__ __volatile__ ("int $3"); } while (0)
#elif defined(__GNUC__) && (K_ARCH == K_ARCH_AMD64 || K_ARCH == K_ARCH_X86_32 || K_ARCH == K_ARCH_X86_16)
# define kHlpAssertBreakpoint() do { __asm__ __volatile__ ("int3"); } while (0)
#elif defined(__GNUC__) && (K_ARCH == K_ARCH_ARM_64 || K_ARCH == K_ARCH_ARM_32) /* probably not supported by older ARM CPUs */
# define kHlpAssertBreakpoint() do { __asm__ __volatile__ ("brk #0x1"); } while (0)
#elif defined(__GNUC__) && (K_ARCH == K_ARCH_SPARC_32)
# define kHlpAssertBreakpoint() do { __asm__ __volatile__ ("unimp 0"); } while (0) /*??*/
#elif defined(__GNUC__) && (K_ARCH == K_ARCH_SPARC_64)
# define kHlpAssertBreakpoint() do { __asm__ __volatile__ ("illtrap 0"); } while (0) /*??*/
#else
# error "Port Me"
#endif
/** @def K_FUNCTION
* Undecorated function name macro expanded by the compiler.
*/
#if defined(__GNUC__)
# define K_FUNCTION __func__
#else
# define K_FUNCTION __FUNCTION__
#endif
#ifdef K_STRICT
# define kHlpAssert(expr) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
} \
} while (0)
# define kHlpAssertStmt(expr, stmt) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
stmt; \
} \
} while (0)
# define kHlpAssertReturn(expr, rcRet) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
return (rcRet); \
} \
} while (0)
# define kHlpAssertStmtReturn(expr, stmt, rcRet) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
stmt; \
return (rcRet); \
} \
} while (0)
# define kHlpAssertReturnVoid(expr) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
return; \
} \
} while (0)
# define kHlpAssertStmtReturnVoid(expr, stmt) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
stmt; \
return; \
} \
} while (0)
# define kHlpAssertMsg(expr, msg) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
} \
} while (0)
# define kHlpAssertMsgStmt(expr, msg, stmt) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
stmt; \
} \
} while (0)
# define kHlpAssertMsgReturn(expr, msg, rcRet) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
return (rcRet); \
} \
} while (0)
# define kHlpAssertMsgStmtReturn(expr, msg, stmt, rcRet) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
stmt; \
return (rcRet); \
} \
} while (0)
# define kHlpAssertMsgReturnVoid(expr, msg) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
return; \
} \
} while (0)
# define kHlpAssertMsgStmtReturnVoid(expr, msg, stmt) \
do { \
if (!(expr)) \
{ \
kHlpAssertMsg1(#expr, __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
stmt; \
return; \
} \
} while (0)
/* Same as above, only no expression. */
# define kHlpAssertFailed() \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
} while (0)
# define kHlpAssertFailedStmt(stmt) \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
stmt; \
} while (0)
# define kHlpAssertFailedReturn(rcRet) \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
return (rcRet); \
} while (0)
# define kHlpAssertFailedStmtReturn(stmt, rcRet) \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
stmt; \
return (rcRet); \
} while (0)
# define kHlpAssertFailedReturnVoid() \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
return; \
} while (0)
# define kHlpAssertFailedStmtReturnVoid(stmt) \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertBreakpoint(); \
stmt; \
return; \
} while (0)
# define kHlpAssertMsgFailed(msg) \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
} while (0)
# define kHlpAssertMsgFailedStmt(msg, stmt) \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
stmt; \
} while (0)
# define kHlpAssertMsgFailedReturn(msg, rcRet) \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
return (rcRet); \
} while (0)
# define kHlpAssertMsgFailedStmtReturn(msg, stmt, rcRet) \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
stmt; \
return (rcRet); \
} while (0)
# define kHlpAssertMsgFailedReturnVoid(msg) \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
return; \
} while (0)
# define kHlpAssertMsgFailedStmtReturnVoid(msg, stmt) \
do { \
kHlpAssertMsg1("failed", __FILE__, __LINE__, K_FUNCTION); \
kHlpAssertMsg2 msg; \
kHlpAssertBreakpoint(); \
stmt; \
return; \
} while (0)
#else /* !K_STRICT */
# define kHlpAssert(expr) do { } while (0)
# define kHlpAssertStmt(expr, stmt) do { if (!(expr)) { stmt; } } while (0)
# define kHlpAssertReturn(expr, rcRet) do { if (!(expr)) return (rcRet); } while (0)
# define kHlpAssertStmtReturn(expr, stmt, rcRet) do { if (!(expr)) { stmt; return (rcRet); } } while (0)
# define kHlpAssertReturnVoid(expr) do { if (!(expr)) return; } while (0)
# define kHlpAssertStmtReturnVoid(expr, stmt) do { if (!(expr)) { stmt; return; } } while (0)
# define kHlpAssertMsg(expr, msg) do { } while (0)
# define kHlpAssertMsgStmt(expr, msg, stmt) do { if (!(expr)) { stmt; } } while (0)
# define kHlpAssertMsgReturn(expr, msg, rcRet) do { if (!(expr)) return (rcRet); } while (0)
# define kHlpAssertMsgStmtReturn(expr, msg, stmt, rcRet) do { if (!(expr)) { stmt; return (rcRet); } } while (0)
# define kHlpAssertMsgReturnVoid(expr, msg) do { if (!(expr)) return; } while (0)
# define kHlpAssertMsgStmtReturnVoid(expr, msg, stmt) do { if (!(expr)) { stmt; return; } } while (0)
/* Same as above, only no expression: */
# define kHlpAssertFailed() do { } while (0)
# define kHlpAssertFailedStmt(stmt) do { stmt; } while (0)
# define kHlpAssertFailedReturn(rcRet) do { return (rcRet); } while (0)
# define kHlpAssertFailedStmtReturn(stmt, rcRet) do { stmt; return (rcRet); } while (0)
# define kHlpAssertFailedReturnVoid() do { return; } while (0)
# define kHlpAssertFailedStmtReturnVoid(stmt) do { stmt; return; } while (0)
# define kHlpAssertMsgFailed(msg) do { } while (0)
# define kHlpAssertMsgFailedStmt(msg, stmt) do { stmt; } while (0)
# define kHlpAssertMsgFailedReturn(msg, rcRet) do { return (rcRet); } while (0)
# define kHlpAssertMsgFailedStmtReturn(msg, stmt, rcRet) do { { stmt; return (rcRet); } } while (0)
# define kHlpAssertMsgFailedReturnVoid(msg) do { return; } while (0)
# define kHlpAssertMsgFailedStmtReturnVoid(msg, stmt) do { stmt; return; } while (0)
#endif /* !K_STRICT */
#define kHlpAssertPtr(ptr) kHlpAssertMsg(K_VALID_PTR(ptr), ("%s = %p\n", #ptr, (ptr)))
#define kHlpAssertPtrReturn(ptr, rcRet) kHlpAssertMsgReturn(K_VALID_PTR(ptr), ("%s = %p -> %d\n", #ptr, (ptr), (rcRet)), (rcRet))
#define kHlpAssertPtrReturn(ptr, rcRet) kHlpAssertMsgReturn(K_VALID_PTR(ptr), ("%s = %p -> %d\n", #ptr, (ptr), (rcRet)), (rcRet))
#define kHlpAssertPtrReturnVoid(ptr) kHlpAssertMsgReturnVoid(K_VALID_PTR(ptr), ("%s = %p -> %d\n", #ptr, (ptr), (rcRet)))
#define kHlpAssertPtrNull(ptr) kHlpAssertMsg(!(ptr) || K_VALID_PTR(ptr), ("%s = %p\n", #ptr, (ptr)))
#define kHlpAssertPtrNullReturn(ptr, rcRet) kHlpAssertMsgReturn(!(ptr) || K_VALID_PTR(ptr), ("%s = %p -> %d\n", #ptr, (ptr), (rcRet)), (rcRet))
#define kHlpAssertPtrNullReturnVoid(ptr) kHlpAssertMsgReturnVoid(!(ptr) || K_VALID_PTR(ptr), ("%s = %p -> %d\n", #ptr, (ptr), (rcRet)))
#define kHlpAssertRC(rc) kHlpAssertMsg((rc) == 0, ("%s = %d\n", #rc, (rc)))
#define kHlpAssertRCReturn(rc, rcRet) kHlpAssertMsgReturn((rc) == 0, ("%s = %d -> %d\n", #rc, (rc), (rcRet)), (rcRet))
#define kHlpAssertRCReturnVoid(rc) kHlpAssertMsgReturnVoid((rc) == 0, ("%s = %d -> %d\n", #rc, (rc), (rcRet)))
/**
* Helper function that displays the first part of the assertion message.
*
* @param pszExpr The expression.
* @param pszFile The file name.
* @param iLine The line number is the file.
* @param pszFunction The function name.
* @internal
*/
KHLP_DECL(void) kHlpAssertMsg1(const char *pszExpr, const char *pszFile, unsigned iLine, const char *pszFunction);
/**
* Helper function that displays custom assert message.
*
* @param pszFormat Format string that get passed to vprintf.
* @param ... Format arguments.
* @internal
*/
KHLP_DECL(void) kHlpAssertMsg2(const char *pszFormat, ...);
/** @} */
#ifdef __cplusplus
}
#endif
#endif
|
