VirtualBox

source: vbox/trunk/include/iprt/assert.h@ 60547

Last change on this file since 60547 was 60070, checked in by vboxsync, 9 years ago

iprt/assert.h: docs.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 88.6 KB
Line 
1/** @file
2 * IPRT - Assertions.
3 */
4
5/*
6 * Copyright (C) 2006-2016 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___iprt_assert_h
27#define ___iprt_assert_h
28
29#include <iprt/cdefs.h>
30#include <iprt/types.h>
31#include <iprt/stdarg.h>
32
33/** @defgroup grp_rt_assert Assert - Assertions
34 * @ingroup grp_rt
35 *
36 * Assertions are generally used to check preconditions and other
37 * assumptions. Sometimes it is also used to catch odd errors or errors
38 * that one would like to inspect in the debugger. They should not be
39 * used for errors that happen frequently.
40 *
41 * IPRT provides a host of assertion macros, so many that it can be a bit
42 * overwhelming at first. Don't despair, there is a system (surprise).
43 *
44 * First there are four families of assertions:
45 * - Assert - The normal strict build only assertions.
46 * - AssertLogRel - Calls LogRel() in non-strict builds, otherwise like Assert.
47 * - AssertRelease - Triggers in all builds.
48 * - AssertFatal - Triggers in all builds and cannot be continued.
49 *
50 * Then there are variations wrt to argument list and behavior on failure:
51 * - Msg - Custom RTStrPrintf-like message with the assertion message.
52 * - Return - Return the specific rc on failure.
53 * - ReturnVoid - Return (void) on failure.
54 * - Break - Break (out of switch/loop) on failure.
55 * - Stmt - Execute the specified statement(s) on failure.
56 * - RC - Assert RT_SUCCESS.
57 * - RCSuccess - Assert VINF_SUCCESS.
58 *
59 * In addition there is a very special family AssertCompile that can be
60 * used for some limited compile-time checking, like structure sizes and member
61 * alignment. This family doesn't have the same variations.
62 *
63 *
64 * @remarks As you might have noticed, the macros don't follow the
65 * coding guidelines wrt to macros supposedly being all uppercase
66 * and underscored. For various reasons they don't, and nobody
67 * has complained yet. Wonder why... :-)
68 *
69 * @remarks Each project has its own specific guidelines on how to use
70 * assertions, so the above is just trying to give you the general idea
71 * from the IPRT point of view.
72 *
73 * @{
74 */
75
76RT_C_DECLS_BEGIN
77
78/**
79 * The 1st part of an assert message.
80 *
81 * @param pszExpr Expression. Can be NULL.
82 * @param uLine Location line number.
83 * @param pszFile Location file name.
84 * @param pszFunction Location function name.
85 */
86RTDECL(void) RTAssertMsg1(const char *pszExpr, unsigned uLine, const char *pszFile, const char *pszFunction);
87/**
88 * Weak version of RTAssertMsg1 that can be overridden locally in a module to
89 * modify, redirect or otherwise mess with the assertion output.
90 *
91 * @copydoc RTAssertMsg1
92 */
93RTDECL(void) RTAssertMsg1Weak(const char *pszExpr, unsigned uLine, const char *pszFile, const char *pszFunction);
94
95/**
96 * The 2nd (optional) part of an assert message.
97 *
98 * @param pszFormat Printf like format string.
99 * @param ... Arguments to that string.
100 */
101RTDECL(void) RTAssertMsg2(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
102/**
103 * Weak version of RTAssertMsg2 that forwards to RTAssertMsg2WeakV.
104 *
105 * There is not need to override this, check out RTAssertMsg2WeakV instead!
106 *
107 * @copydoc RTAssertMsg2
108 */
109RTDECL(void) RTAssertMsg2Weak(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
110
111/**
112 * The 2nd (optional) part of an assert message.
113 *
114 * @param pszFormat Printf like format string.
115 * @param va Arguments to that string.
116 */
117RTDECL(void) RTAssertMsg2V(const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(1, 0);
118/**
119 * Weak version of RTAssertMsg2V that can be overridden locally in a module to
120 * modify, redirect or otherwise mess with the assertion output.
121 *
122 * @copydoc RTAssertMsg2V
123 */
124RTDECL(void) RTAssertMsg2WeakV(const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(1, 0);
125
126/**
127 * Additional information which should be appended to the 2nd part of an
128 * assertion message.
129 *
130 * @param pszFormat Printf like format string.
131 * @param ... Arguments to that string.
132 */
133RTDECL(void) RTAssertMsg2Add(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
134/**
135 * Weak version of RTAssertMsg2Add that forwards to RTAssertMsg2AddWeakV.
136 *
137 * There is not need to override this, check out RTAssertMsg2AddWeakV instead!
138 *
139 * @copydoc RTAssertMsg2Add
140 */
141RTDECL(void) RTAssertMsg2AddWeak(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
142
143/**
144 * Additional information which should be appended to the 2nd part of an
145 * assertion message.
146 *
147 * @param pszFormat Printf like format string.
148 * @param va Arguments to that string.
149 */
150RTDECL(void) RTAssertMsg2AddV(const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(1, 0);
151/**
152 * Weak version of RTAssertMsg2AddV that can be overridden locally in a module
153 * to modify, redirect or otherwise mess with the assertion output.
154 *
155 * @copydoc RTAssertMsg2AddV
156 */
157RTDECL(void) RTAssertMsg2AddWeakV(const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(1, 0);
158
159#ifdef IN_RING0
160/**
161 * Panics the system as the result of a fail assertion.
162 */
163RTR0DECL(void) RTR0AssertPanicSystem(void);
164#endif /* IN_RING0 */
165
166/**
167 * Overridable function that decides whether assertions executes the panic
168 * (breakpoint) or not.
169 *
170 * The generic implementation will return true.
171 *
172 * @returns true if the breakpoint should be hit, false if it should be ignored.
173 *
174 * @remark The RTDECL() makes this a bit difficult to override on Windows. So,
175 * you'll have to use RTASSERT_HAVE_SHOULD_PANIC or
176 * RTASSERT_HAVE_SHOULD_PANIC_PRIVATE there to control the kind of
177 * prototype.
178 */
179#if !defined(RTASSERT_HAVE_SHOULD_PANIC) && !defined(RTASSERT_HAVE_SHOULD_PANIC_PRIVATE)
180RTDECL(bool) RTAssertShouldPanic(void);
181#elif defined(RTASSERT_HAVE_SHOULD_PANIC_PRIVATE)
182bool RTAssertShouldPanic(void);
183#else
184DECLEXPORT(bool) RTCALL RTAssertShouldPanic(void);
185#endif
186
187/**
188 * Controls whether the assertions should be quiet or noisy (default).
189 *
190 * @returns The old setting.
191 * @param fQuiet The new setting.
192 */
193RTDECL(bool) RTAssertSetQuiet(bool fQuiet);
194
195/**
196 * Are assertions quiet or noisy?
197 *
198 * @returns True if they are quiet, false if noisy.
199 */
200RTDECL(bool) RTAssertAreQuiet(void);
201
202/**
203 * Makes the assertions panic (default) or not.
204 *
205 * @returns The old setting.
206 * @param fPanic The new setting.
207 */
208RTDECL(bool) RTAssertSetMayPanic(bool fPanic);
209
210/**
211 * Can assertion panic.
212 *
213 * @returns True if they can, false if not.
214 */
215RTDECL(bool) RTAssertMayPanic(void);
216
217
218/** @name Globals for crash analysis
219 * @remarks This is the full potential set, it
220 * @{
221 */
222/** The last assert message, 1st part. */
223extern RTDATADECL(char) g_szRTAssertMsg1[1024];
224/** The last assert message, 2nd part. */
225extern RTDATADECL(char) g_szRTAssertMsg2[4096];
226/** The last assert message, expression. */
227extern RTDATADECL(const char * volatile) g_pszRTAssertExpr;
228/** The last assert message, file name. */
229extern RTDATADECL(const char * volatile) g_pszRTAssertFile;
230/** The last assert message, line number. */
231extern RTDATADECL(uint32_t volatile) g_u32RTAssertLine;
232/** The last assert message, function name. */
233extern RTDATADECL(const char * volatile) g_pszRTAssertFunction;
234/** @} */
235
236RT_C_DECLS_END
237
238/** @def RTAssertDebugBreak()
239 * Debugger breakpoint instruction.
240 *
241 * @remarks This macro does not depend on RT_STRICT.
242 */
243#define RTAssertDebugBreak() do { RT_BREAKPOINT(); } while (0)
244
245
246
247/** @name Compile time assertions.
248 *
249 * These assertions are used to check structure sizes, member/size alignments
250 * and similar compile time expressions.
251 *
252 * @{
253 */
254
255/**
256 * RTASSERTTYPE is the type the AssertCompile() macro redefines.
257 * It has no other function and shouldn't be used.
258 * Visual C++ uses this.
259 */
260typedef int RTASSERTTYPE[1];
261
262/**
263 * RTASSERTVAR is the type the AssertCompile() macro redefines.
264 * It has no other function and shouldn't be used.
265 * GCC uses this.
266 */
267#ifdef __GNUC__
268RT_C_DECLS_BEGIN
269#endif
270extern int RTASSERTVAR[1];
271#ifdef __GNUC__
272RT_C_DECLS_END
273#endif
274
275/** @def RTASSERT_HAVE_STATIC_ASSERT
276 * Indicates that the compiler implements static_assert(expr, msg).
277 */
278#ifdef _MSC_VER
279# if _MSC_VER >= 1600 && defined(__cplusplus)
280# define RTASSERT_HAVE_STATIC_ASSERT
281# endif
282#endif
283#if defined(__GNUC__) && defined(__GXX_EXPERIMENTAL_CXX0X__)
284# define RTASSERT_HAVE_STATIC_ASSERT
285#endif
286#ifdef DOXYGEN_RUNNING
287# define RTASSERT_HAVE_STATIC_ASSERT
288#endif
289
290/** @def AssertCompileNS
291 * Asserts that a compile-time expression is true. If it's not break the build.
292 *
293 * This differs from AssertCompile in that it accepts some more expressions
294 * than what C++0x allows - NS = Non-standard.
295 *
296 * @param expr Expression which should be true.
297 */
298#ifdef __GNUC__
299# define AssertCompileNS(expr) extern int RTASSERTVAR[1] __attribute__((unused)), RTASSERTVAR[(expr) ? 1 : 0] __attribute__((unused))
300#elif defined(__IBMC__) || defined(__IBMCPP__)
301# define AssertCompileNS(expr) extern int RTASSERTVAR[(expr) ? 1 : 0]
302#else
303# define AssertCompileNS(expr) typedef int RTASSERTTYPE[(expr) ? 1 : 0]
304#endif
305
306/** @def AssertCompile
307 * Asserts that a C++0x compile-time expression is true. If it's not break the
308 * build.
309 * @param expr Expression which should be true.
310 */
311#ifdef RTASSERT_HAVE_STATIC_ASSERT
312# define AssertCompile(expr) static_assert(!!(expr), #expr)
313#else
314# define AssertCompile(expr) AssertCompileNS(expr)
315#endif
316
317/** @def RTASSERT_OFFSET_OF()
318 * A offsetof() macro suitable for compile time assertions.
319 * Both GCC v4 and VisualAge for C++ v3.08 has trouble using RT_OFFSETOF.
320 */
321#if defined(__GNUC__)
322# if __GNUC__ >= 4
323# define RTASSERT_OFFSET_OF(a_Type, a_Member) __builtin_offsetof(a_Type, a_Member)
324# else
325# define RTASSERT_OFFSET_OF(a_Type, a_Member) RT_OFFSETOF(a_Type, a_Member)
326# endif
327#elif (defined(__IBMC__) || defined(__IBMCPP__)) && defined(RT_OS_OS2)
328# define RTASSERT_OFFSET_OF(a_Type, a_Member) __offsetof(a_Type, a_Member)
329#else
330# define RTASSERT_OFFSET_OF(a_Type, a_Member) RT_OFFSETOF(a_Type, a_Member)
331#endif
332
333
334/** @def AssertCompileSize
335 * Asserts a size at compile.
336 * @param type The type.
337 * @param size The expected type size.
338 */
339#define AssertCompileSize(type, size) \
340 AssertCompile(sizeof(type) == (size))
341
342/** @def AssertCompileSizeAlignment
343 * Asserts a size alignment at compile.
344 * @param type The type.
345 * @param align The size alignment to assert.
346 */
347#define AssertCompileSizeAlignment(type, align) \
348 AssertCompile(!(sizeof(type) & ((align) - 1)))
349
350/** @def AssertCompileMemberSize
351 * Asserts a member offset alignment at compile.
352 * @param type The type.
353 * @param member The member.
354 * @param size The member size to assert.
355 */
356#define AssertCompileMemberSize(type, member, size) \
357 AssertCompile(RT_SIZEOFMEMB(type, member) == (size))
358
359/** @def AssertCompileMemberSizeAlignment
360 * Asserts a member size alignment at compile.
361 * @param type The type.
362 * @param member The member.
363 * @param align The member size alignment to assert.
364 */
365#define AssertCompileMemberSizeAlignment(type, member, align) \
366 AssertCompile(!(RT_SIZEOFMEMB(type, member) & ((align) - 1)))
367
368/** @def AssertCompileMemberAlignment
369 * Asserts a member offset alignment at compile.
370 * @param type The type.
371 * @param member The member.
372 * @param align The member offset alignment to assert.
373 */
374#define AssertCompileMemberAlignment(type, member, align) \
375 AssertCompile(!(RTASSERT_OFFSET_OF(type, member) & ((align) - 1)))
376
377/** @def AssertCompileMemberOffset
378 * Asserts an offset of a structure member at compile.
379 * @param type The type.
380 * @param member The member.
381 * @param off The expected offset.
382 */
383#define AssertCompileMemberOffset(type, member, off) \
384 AssertCompile(RTASSERT_OFFSET_OF(type, member) == (off))
385
386/** @def AssertCompile2MemberOffsets
387 * Asserts that two (sub-structure) members in union have the same offset.
388 * @param type The type.
389 * @param member1 The first member.
390 * @param member2 The second member.
391 */
392#define AssertCompile2MemberOffsets(type, member1, member2) \
393 AssertCompile(RTASSERT_OFFSET_OF(type, member1) == RTASSERT_OFFSET_OF(type, member2))
394
395/** @def AssertCompileAdjacentMembers
396 * Asserts that two structure members are adjacent.
397 * @param type The type.
398 * @param member1 The first member.
399 * @param member2 The second member.
400 */
401#define AssertCompileAdjacentMembers(type, member1, member2) \
402 AssertCompile(RTASSERT_OFFSET_OF(type, member1) + RT_SIZEOFMEMB(type, member1) == RTASSERT_OFFSET_OF(type, member2))
403
404/** @def AssertCompileMembersAtSameOffset
405 * Asserts that members of two different structures are at the same offset.
406 * @param type1 The first type.
407 * @param member1 The first member.
408 * @param type2 The second type.
409 * @param member2 The second member.
410 */
411#define AssertCompileMembersAtSameOffset(type1, member1, type2, member2) \
412 AssertCompile(RTASSERT_OFFSET_OF(type1, member1) == RTASSERT_OFFSET_OF(type2, member2))
413
414/** @def AssertCompileMembersSameSize
415 * Asserts that members of two different structures have the same size.
416 * @param type1 The first type.
417 * @param member1 The first member.
418 * @param type2 The second type.
419 * @param member2 The second member.
420 */
421#define AssertCompileMembersSameSize(type1, member1, type2, member2) \
422 AssertCompile(RT_SIZEOFMEMB(type1, member1) == RT_SIZEOFMEMB(type2, member2))
423
424/** @def AssertCompileMembersSameSizeAndOffset
425 * Asserts that members of two different structures have the same size and are
426 * at the same offset.
427 * @param type1 The first type.
428 * @param member1 The first member.
429 * @param type2 The second type.
430 * @param member2 The second member.
431 */
432#define AssertCompileMembersSameSizeAndOffset(type1, member1, type2, member2) \
433 AssertCompile( RTASSERT_OFFSET_OF(type1, member1) == RTASSERT_OFFSET_OF(type2, member2) \
434 && RT_SIZEOFMEMB(type1, member1) == RT_SIZEOFMEMB(type2, member2))
435
436/** @} */
437
438
439
440/** @name Assertions
441 *
442 * These assertions will only trigger when RT_STRICT is defined. When it is
443 * undefined they will all be no-ops and generate no code.
444 *
445 * @{
446 */
447
448
449/** @def RTASSERT_QUIET
450 * This can be defined to shut up the messages for a file where this would be
451 * problematic because the message printing code path passes thru it.
452 * @internal */
453#ifdef DOXYGEN_RUNNING
454# define RTASSERT_QUIET
455#endif
456#if defined(RTASSERT_QUIET) && !defined(DOXYGEN_RUNNING)
457# define RTAssertMsg1Weak(pszExpr, uLine, pszfile, pszFunction) \
458 do { } while (0)
459# define RTAssertMsg2Weak if (1) {} else RTAssertMsg2Weak
460#endif
461
462/** @def RTAssertDoPanic
463 * Raises an assertion panic appropriate to the current context.
464 * @remarks This macro does not depend on RT_STRICT.
465 */
466#if defined(IN_RING0) \
467 && (defined(RT_OS_DARWIN) || defined(RT_OS_HAIKU) || defined(RT_OS_SOLARIS))
468# define RTAssertDoPanic() RTR0AssertPanicSystem()
469#else
470# define RTAssertDoPanic() RTAssertDebugBreak()
471#endif
472
473/** @def AssertBreakpoint()
474 * Assertion Breakpoint.
475 * @deprecated Use RTAssertPanic or RTAssertDebugBreak instead.
476 */
477#ifdef RT_STRICT
478# define AssertBreakpoint() RTAssertDebugBreak()
479#else
480# define AssertBreakpoint() do { } while (0)
481#endif
482
483/** @def RTAssertPanic()
484 * If RT_STRICT is defined this macro will invoke RTAssertDoPanic if
485 * RTAssertShouldPanic returns true. If RT_STRICT isn't defined it won't do any
486 * thing.
487 */
488#if defined(RT_STRICT) && !defined(RTASSERT_DONT_PANIC)
489# define RTAssertPanic() do { if (RTAssertShouldPanic()) RTAssertDoPanic(); } while (0)
490#else
491# define RTAssertPanic() do { } while (0)
492#endif
493
494/** @def Assert
495 * Assert that an expression is true. If false, hit breakpoint.
496 * @param expr Expression which should be true.
497 */
498#ifdef RT_STRICT
499# define Assert(expr) \
500 do { \
501 if (RT_LIKELY(!!(expr))) \
502 { /* likely */ } \
503 else \
504 { \
505 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
506 RTAssertPanic(); \
507 } \
508 } while (0)
509#else
510# define Assert(expr) do { } while (0)
511#endif
512
513
514/** @def AssertStmt
515 * Assert that an expression is true. If false, hit breakpoint and execute the
516 * statement.
517 * @param expr Expression which should be true.
518 * @param stmt Statement to execute on failure.
519 */
520#ifdef RT_STRICT
521# define AssertStmt(expr, stmt) \
522 do { \
523 if (RT_LIKELY(!!(expr))) \
524 { /* likely */ } \
525 else \
526 { \
527 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
528 RTAssertPanic(); \
529 stmt; \
530 } \
531 } while (0)
532#else
533# define AssertStmt(expr, stmt) \
534 do { \
535 if (RT_LIKELY(!!(expr))) \
536 { /* likely */ } \
537 else \
538 { \
539 stmt; \
540 } \
541 } while (0)
542#endif
543
544
545/** @def AssertReturn
546 * Assert that an expression is true and returns if it isn't.
547 * In RT_STRICT mode it will hit a breakpoint before returning.
548 *
549 * @param expr Expression which should be true.
550 * @param rc What is to be presented to return.
551 */
552#ifdef RT_STRICT
553# define AssertReturn(expr, rc) \
554 do { \
555 if (RT_LIKELY(!!(expr))) \
556 { /* likely */ } \
557 else \
558 { \
559 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
560 RTAssertPanic(); \
561 return (rc); \
562 } \
563 } while (0)
564#else
565# define AssertReturn(expr, rc) \
566 do { \
567 if (RT_LIKELY(!!(expr))) \
568 { /* likely */ } \
569 else \
570 return (rc); \
571 } while (0)
572#endif
573
574/** @def AssertReturnStmt
575 * Assert that an expression is true, if it isn't execute the given statement
576 * and return rc.
577 *
578 * In RT_STRICT mode it will hit a breakpoint before executing the statement and
579 * returning.
580 *
581 * @param expr Expression which should be true.
582 * @param stmt Statement to execute before returning on failure.
583 * @param rc What is to be presented to return.
584 */
585#ifdef RT_STRICT
586# define AssertReturnStmt(expr, stmt, rc) \
587 do { \
588 if (RT_LIKELY(!!(expr))) \
589 { /* likely */ } \
590 else \
591 { \
592 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
593 RTAssertPanic(); \
594 stmt; \
595 return (rc); \
596 } \
597 } while (0)
598#else
599# define AssertReturnStmt(expr, stmt, rc) \
600 do { \
601 if (RT_LIKELY(!!(expr))) \
602 { /* likely */ } \
603 else \
604 { \
605 stmt; \
606 return (rc); \
607 } \
608 } while (0)
609#endif
610
611/** @def AssertReturnVoid
612 * Assert that an expression is true and returns if it isn't.
613 * In RT_STRICT mode it will hit a breakpoint before returning.
614 *
615 * @param expr Expression which should be true.
616 */
617#ifdef RT_STRICT
618# define AssertReturnVoid(expr) \
619 do { \
620 if (RT_LIKELY(!!(expr))) \
621 { /* likely */ } \
622 else \
623 { \
624 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
625 RTAssertPanic(); \
626 return; \
627 } \
628 } while (0)
629#else
630# define AssertReturnVoid(expr) \
631 do { \
632 if (RT_LIKELY(!!(expr))) \
633 { /* likely */ } \
634 else \
635 return; \
636 } while (0)
637#endif
638
639/** @def AssertReturnVoidStmt
640 * Assert that an expression is true, if it isn't execute the given statement
641 * and return.
642 *
643 * In RT_STRICT mode it will hit a breakpoint before returning.
644 *
645 * @param expr Expression which should be true.
646 * @param stmt Statement to execute before returning on failure.
647 */
648#ifdef RT_STRICT
649# define AssertReturnVoidStmt(expr, stmt) \
650 do { \
651 if (RT_LIKELY(!!(expr))) \
652 { /* likely */ } \
653 else \
654 { \
655 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
656 RTAssertPanic(); \
657 stmt; \
658 return; \
659 } \
660 } while (0)
661#else
662# define AssertReturnVoidStmt(expr, stmt) \
663 do { \
664 if (RT_LIKELY(!!(expr))) \
665 { /* likely */ } \
666 else \
667 { \
668 stmt; \
669 return; \
670 } \
671 } while (0)
672#endif
673
674
675/** @def AssertBreak
676 * Assert that an expression is true and breaks if it isn't.
677 * In RT_STRICT mode it will hit a breakpoint before breaking.
678 *
679 * @param expr Expression which should be true.
680 */
681#ifdef RT_STRICT
682# define AssertBreak(expr) \
683 if (RT_LIKELY(!!(expr))) \
684 { /* likely */ } \
685 else if (1) \
686 { \
687 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
688 RTAssertPanic(); \
689 break; \
690 } else do {} while (0)
691#else
692# define AssertBreak(expr) \
693 if (RT_LIKELY(!!(expr))) \
694 { /* likely */ } \
695 else \
696 break
697#endif
698
699/** @def AssertContinue
700 * Assert that an expression is true and continue if it isn't.
701 * In RT_STRICT mode it will hit a breakpoint before continuing.
702 *
703 * @param expr Expression which should be true.
704 */
705#ifdef RT_STRICT
706# define AssertContinue(expr) \
707 if (RT_LIKELY(!!(expr))) \
708 { /* likely */ } \
709 else if (1) \
710 { \
711 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
712 RTAssertPanic(); \
713 continue; \
714 } else do {} while (0)
715#else
716# define AssertContinue(expr) \
717 if (RT_LIKELY(!!(expr))) \
718 { /* likely */ } \
719 else \
720 continue
721#endif
722
723/** @def AssertBreakStmt
724 * Assert that an expression is true and breaks if it isn't.
725 * In RT_STRICT mode it will hit a breakpoint before doing break.
726 *
727 * @param expr Expression which should be true.
728 * @param stmt Statement to execute before break in case of a failed assertion.
729 */
730#ifdef RT_STRICT
731# define AssertBreakStmt(expr, stmt) \
732 if (RT_LIKELY(!!(expr))) \
733 { /* likely */ } \
734 else if (1) \
735 { \
736 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
737 RTAssertPanic(); \
738 stmt; \
739 break; \
740 } else do {} while (0)
741#else
742# define AssertBreakStmt(expr, stmt) \
743 if (RT_LIKELY(!!(expr))) \
744 { /* likely */ } \
745 else if (1) \
746 { \
747 stmt; \
748 break; \
749 } else do {} while (0)
750#endif
751
752
753/** @def AssertMsg
754 * Assert that an expression is true. If it's not print message and hit breakpoint.
755 * @param expr Expression which should be true.
756 * @param a printf argument list (in parenthesis).
757 */
758#ifdef RT_STRICT
759# define AssertMsg(expr, a) \
760 do { \
761 if (RT_LIKELY(!!(expr))) \
762 { /* likely */ } \
763 else \
764 { \
765 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
766 RTAssertMsg2Weak a; \
767 RTAssertPanic(); \
768 } \
769 } while (0)
770#else
771# define AssertMsg(expr, a) do { } while (0)
772#endif
773
774/** @def AssertMsgStmt
775 * Assert that an expression is true. If it's not print message and hit
776 * breakpoint and execute the statement.
777 *
778 * @param expr Expression which should be true.
779 * @param a printf argument list (in parenthesis).
780 * @param stmt Statement to execute in case of a failed assertion.
781 *
782 * @remarks The expression and statement will be evaluated in all build types.
783 */
784#ifdef RT_STRICT
785# define AssertMsgStmt(expr, a, stmt) \
786 do { \
787 if (RT_LIKELY(!!(expr))) \
788 { /* likely */ } \
789 else \
790 { \
791 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
792 RTAssertMsg2Weak a; \
793 RTAssertPanic(); \
794 stmt; \
795 } \
796 } while (0)
797#else
798# define AssertMsgStmt(expr, a, stmt) \
799 do { \
800 if (RT_LIKELY(!!(expr))) \
801 { /* likely */ } \
802 else \
803 { \
804 stmt; \
805 } \
806 } while (0)
807#endif
808
809/** @def AssertMsgReturn
810 * Assert that an expression is true and returns if it isn't.
811 * In RT_STRICT mode it will hit a breakpoint before returning.
812 *
813 * @param expr Expression which should be true.
814 * @param a printf argument list (in parenthesis).
815 * @param rc What is to be presented to return.
816 */
817#ifdef RT_STRICT
818# define AssertMsgReturn(expr, a, rc) \
819 do { \
820 if (RT_LIKELY(!!(expr))) \
821 { /* likely */ } \
822 else \
823 { \
824 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
825 RTAssertMsg2Weak a; \
826 RTAssertPanic(); \
827 return (rc); \
828 } \
829 } while (0)
830#else
831# define AssertMsgReturn(expr, a, rc) \
832 do { \
833 if (RT_LIKELY(!!(expr))) \
834 { /* likely */ } \
835 else \
836 return (rc); \
837 } while (0)
838#endif
839
840/** @def AssertMsgReturnStmt
841 * Assert that an expression is true, if it isn't execute the statement and
842 * return.
843 *
844 * In RT_STRICT mode it will hit a breakpoint before returning.
845 *
846 * @param expr Expression which should be true.
847 * @param a printf argument list (in parenthesis).
848 * @param stmt Statement to execute before returning in case of a failed
849 * assertion.
850 * @param rc What is to be presented to return.
851 */
852#ifdef RT_STRICT
853# define AssertMsgReturnStmt(expr, a, stmt, rc) \
854 do { \
855 if (RT_LIKELY(!!(expr))) \
856 { /* likely */ } \
857 else \
858 { \
859 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
860 RTAssertMsg2Weak a; \
861 RTAssertPanic(); \
862 stmt; \
863 return (rc); \
864 } \
865 } while (0)
866#else
867# define AssertMsgReturnStmt(expr, a, stmt, rc) \
868 do { \
869 if (RT_LIKELY(!!(expr))) \
870 { /* likely */ } \
871 else \
872 { \
873 stmt; \
874 return (rc); \
875 } \
876 } while (0)
877#endif
878
879/** @def AssertMsgReturnVoid
880 * Assert that an expression is true and returns if it isn't.
881 * In RT_STRICT mode it will hit a breakpoint before returning.
882 *
883 * @param expr Expression which should be true.
884 * @param a printf argument list (in parenthesis).
885 */
886#ifdef RT_STRICT
887# define AssertMsgReturnVoid(expr, a) \
888 do { \
889 if (RT_LIKELY(!!(expr))) \
890 { /* likely */ } \
891 else \
892 { \
893 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
894 RTAssertMsg2Weak a; \
895 RTAssertPanic(); \
896 return; \
897 } \
898 } while (0)
899#else
900# define AssertMsgReturnVoid(expr, a) \
901 do { \
902 if (RT_LIKELY(!!(expr))) \
903 { /* likely */ } \
904 else \
905 return; \
906 } while (0)
907#endif
908
909/** @def AssertMsgReturnVoidStmt
910 * Assert that an expression is true, if it isn't execute the statement and
911 * return.
912 *
913 * In RT_STRICT mode it will hit a breakpoint before returning.
914 *
915 * @param expr Expression which should be true.
916 * @param a printf argument list (in parenthesis).
917 * @param stmt Statement to execute before return in case of a failed assertion.
918 */
919#ifdef RT_STRICT
920# define AssertMsgReturnVoidStmt(expr, a, stmt) \
921 do { \
922 if (RT_LIKELY(!!(expr))) \
923 { /* likely */ } \
924 else \
925 { \
926 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
927 RTAssertMsg2Weak a; \
928 RTAssertPanic(); \
929 stmt; \
930 return; \
931 } \
932 } while (0)
933#else
934# define AssertMsgReturnVoidStmt(expr, a, stmt) \
935 do { \
936 if (RT_LIKELY(!!(expr))) \
937 { /* likely */ } \
938 else \
939 { \
940 stmt; \
941 return; \
942 } \
943 } while (0)
944#endif
945
946
947/** @def AssertMsgBreak
948 * Assert that an expression is true and breaks if it isn't.
949 * In RT_STRICT mode it will hit a breakpoint before returning.
950 *
951 * @param expr Expression which should be true.
952 * @param a printf argument list (in parenthesis).
953 */
954#ifdef RT_STRICT
955# define AssertMsgBreak(expr, a) \
956 if (RT_LIKELY(!!(expr))) \
957 { /* likely */ } \
958 else if (1) \
959 { \
960 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
961 RTAssertMsg2Weak a; \
962 RTAssertPanic(); \
963 break; \
964 } else do {} while (0)
965#else
966# define AssertMsgBreak(expr, a) \
967 if (RT_LIKELY(!!(expr))) \
968 { /* likely */ } \
969 else \
970 break
971#endif
972
973/** @def AssertMsgBreakStmt
974 * Assert that an expression is true and breaks if it isn't.
975 * In RT_STRICT mode it will hit a breakpoint before doing break.
976 *
977 * @param expr Expression which should be true.
978 * @param a printf argument list (in parenthesis).
979 * @param stmt Statement to execute before break in case of a failed assertion.
980 */
981#ifdef RT_STRICT
982# define AssertMsgBreakStmt(expr, a, stmt) \
983 if (RT_LIKELY(!!(expr))) \
984 { /* likely */ } \
985 else if (1) \
986 { \
987 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
988 RTAssertMsg2Weak a; \
989 RTAssertPanic(); \
990 stmt; \
991 break; \
992 } else do {} while (0)
993#else
994# define AssertMsgBreakStmt(expr, a, stmt) \
995 if (RT_LIKELY(!!(expr))) \
996 { /* likely */ } \
997 else if (1) \
998 { \
999 stmt; \
1000 break; \
1001 } else do {} while (0)
1002#endif
1003
1004/** @def AssertFailed
1005 * An assertion failed, hit breakpoint.
1006 */
1007#ifdef RT_STRICT
1008# define AssertFailed() \
1009 do { \
1010 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
1011 RTAssertPanic(); \
1012 } while (0)
1013#else
1014# define AssertFailed() do { } while (0)
1015#endif
1016
1017/** @def AssertFailedStmt
1018 * An assertion failed, hit breakpoint and execute statement.
1019 */
1020#ifdef RT_STRICT
1021# define AssertFailedStmt(stmt) \
1022 do { \
1023 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
1024 RTAssertPanic(); \
1025 stmt; \
1026 } while (0)
1027#else
1028# define AssertFailedStmt(stmt) do { stmt; } while (0)
1029#endif
1030
1031/** @def AssertFailedReturn
1032 * An assertion failed, hit breakpoint (RT_STRICT mode only) and return.
1033 *
1034 * @param rc The rc to return.
1035 */
1036#ifdef RT_STRICT
1037# define AssertFailedReturn(rc) \
1038 do { \
1039 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1040 RTAssertPanic(); \
1041 return (rc); \
1042 } while (0)
1043#else
1044# define AssertFailedReturn(rc) \
1045 do { \
1046 return (rc); \
1047 } while (0)
1048#endif
1049
1050/** @def AssertFailedReturnStmt
1051 * An assertion failed, hit breakpoint (RT_STRICT mode only), execute a
1052 * statement and return a value.
1053 *
1054 * @param stmt The statement to execute before returning.
1055 * @param rc The value to return.
1056 */
1057#ifdef RT_STRICT
1058# define AssertFailedReturnStmt(stmt, rc) \
1059 do { \
1060 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1061 RTAssertPanic(); \
1062 stmt; \
1063 return (rc); \
1064 } while (0)
1065#else
1066# define AssertFailedReturnStmt(stmt, rc) \
1067 do { \
1068 stmt; \
1069 return (rc); \
1070 } while (0)
1071#endif
1072
1073/** @def AssertFailedReturnVoid
1074 * An assertion failed, hit breakpoint (RT_STRICT mode only) and return.
1075 */
1076#ifdef RT_STRICT
1077# define AssertFailedReturnVoid() \
1078 do { \
1079 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1080 RTAssertPanic(); \
1081 return; \
1082 } while (0)
1083#else
1084# define AssertFailedReturnVoid() \
1085 do { \
1086 return; \
1087 } while (0)
1088#endif
1089
1090/** @def AssertFailedReturnVoidStmt
1091 * An assertion failed, hit breakpoint (RT_STRICT mode only), execute a
1092 * statement and return.
1093 *
1094 * @param stmt The statement to execute before returning.
1095 */
1096#ifdef RT_STRICT
1097# define AssertFailedReturnVoidStmt(stmt) \
1098 do { \
1099 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1100 RTAssertPanic(); \
1101 stmt; \
1102 return; \
1103 } while (0)
1104#else
1105# define AssertFailedReturnVoidStmt(stmt) \
1106 do { \
1107 stmt; \
1108 return; \
1109 } while (0)
1110#endif
1111
1112
1113/** @def AssertFailedBreak
1114 * An assertion failed, hit breakpoint (RT_STRICT mode only) and break.
1115 */
1116#ifdef RT_STRICT
1117# define AssertFailedBreak() \
1118 if (1) { \
1119 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1120 RTAssertPanic(); \
1121 break; \
1122 } else do {} while (0)
1123#else
1124# define AssertFailedBreak() \
1125 if (1) \
1126 break; \
1127 else do {} while (0)
1128#endif
1129
1130/** @def AssertFailedBreakStmt
1131 * An assertion failed, hit breakpoint (RT_STRICT mode only), execute
1132 * the given statement and break.
1133 *
1134 * @param stmt Statement to execute before break.
1135 */
1136#ifdef RT_STRICT
1137# define AssertFailedBreakStmt(stmt) \
1138 if (1) { \
1139 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1140 RTAssertPanic(); \
1141 stmt; \
1142 break; \
1143 } else do {} while (0)
1144#else
1145# define AssertFailedBreakStmt(stmt) \
1146 if (1) { \
1147 stmt; \
1148 break; \
1149 } else do {} while (0)
1150#endif
1151
1152
1153/** @def AssertMsgFailed
1154 * An assertion failed print a message and a hit breakpoint.
1155 *
1156 * @param a printf argument list (in parenthesis).
1157 */
1158#ifdef RT_STRICT
1159# define AssertMsgFailed(a) \
1160 do { \
1161 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
1162 RTAssertMsg2Weak a; \
1163 RTAssertPanic(); \
1164 } while (0)
1165#else
1166# define AssertMsgFailed(a) do { } while (0)
1167#endif
1168
1169/** @def AssertMsgFailedReturn
1170 * An assertion failed, hit breakpoint with message (RT_STRICT mode only) and return.
1171 *
1172 * @param a printf argument list (in parenthesis).
1173 * @param rc What is to be presented to return.
1174 */
1175#ifdef RT_STRICT
1176# define AssertMsgFailedReturn(a, rc) \
1177 do { \
1178 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1179 RTAssertMsg2Weak a; \
1180 RTAssertPanic(); \
1181 return (rc); \
1182 } while (0)
1183#else
1184# define AssertMsgFailedReturn(a, rc) \
1185 do { \
1186 return (rc); \
1187 } while (0)
1188#endif
1189
1190/** @def AssertMsgFailedReturnVoid
1191 * An assertion failed, hit breakpoint with message (RT_STRICT mode only) and return.
1192 *
1193 * @param a printf argument list (in parenthesis).
1194 */
1195#ifdef RT_STRICT
1196# define AssertMsgFailedReturnVoid(a) \
1197 do { \
1198 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1199 RTAssertMsg2Weak a; \
1200 RTAssertPanic(); \
1201 return; \
1202 } while (0)
1203#else
1204# define AssertMsgFailedReturnVoid(a) \
1205 do { \
1206 return; \
1207 } while (0)
1208#endif
1209
1210
1211/** @def AssertMsgFailedBreak
1212 * An assertion failed, hit breakpoint with message (RT_STRICT mode only) and break.
1213 *
1214 * @param a printf argument list (in parenthesis).
1215 */
1216#ifdef RT_STRICT
1217# define AssertMsgFailedBreak(a) \
1218 if (1) { \
1219 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1220 RTAssertMsg2Weak a; \
1221 RTAssertPanic(); \
1222 break; \
1223 } else do {} while (0)
1224#else
1225# define AssertMsgFailedBreak(a) \
1226 if (1) \
1227 break; \
1228 else do {} while (0)
1229#endif
1230
1231/** @def AssertMsgFailedBreakStmt
1232 * An assertion failed, hit breakpoint (RT_STRICT mode only), execute
1233 * the given statement and break.
1234 *
1235 * @param a printf argument list (in parenthesis).
1236 * @param stmt Statement to execute before break.
1237 */
1238#ifdef RT_STRICT
1239# define AssertMsgFailedBreakStmt(a, stmt) \
1240 if (1) { \
1241 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1242 RTAssertMsg2Weak a; \
1243 RTAssertPanic(); \
1244 stmt; \
1245 break; \
1246 } else do {} while (0)
1247#else
1248# define AssertMsgFailedBreakStmt(a, stmt) \
1249 if (1) { \
1250 stmt; \
1251 break; \
1252 } else do {} while (0)
1253#endif
1254
1255/** @} */
1256
1257
1258
1259/** @name Release Log Assertions
1260 *
1261 * These assertions will work like normal strict assertion when RT_STRICT is
1262 * defined and LogRel statements when RT_STRICT is undefined. Typically used for
1263 * things which shouldn't go wrong, but when it does you'd like to know one way
1264 * or the other.
1265 *
1266 * @{
1267 */
1268
1269/** @def RTAssertLogRelMsg1
1270 * RTAssertMsg1Weak (strict builds) / LogRel wrapper (non-strict).
1271 */
1272#ifdef RT_STRICT
1273# define RTAssertLogRelMsg1(pszExpr, iLine, pszFile, pszFunction) \
1274 RTAssertMsg1Weak(pszExpr, iLine, pszFile, pszFunction)
1275#else
1276# define RTAssertLogRelMsg1(pszExpr, iLine, pszFile, pszFunction) \
1277 LogRel(("AssertLogRel %s(%d) %s: %s\n",\
1278 (pszFile), (iLine), (pszFunction), (pszExpr) ))
1279#endif
1280
1281/** @def RTAssertLogRelMsg2
1282 * RTAssertMsg2Weak (strict builds) / LogRel wrapper (non-strict).
1283 */
1284#ifdef RT_STRICT
1285# define RTAssertLogRelMsg2(a) RTAssertMsg2Weak a
1286#else
1287# define RTAssertLogRelMsg2(a) LogRel(a)
1288#endif
1289
1290/** @def AssertLogRel
1291 * Assert that an expression is true.
1292 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1293 *
1294 * @param expr Expression which should be true.
1295 */
1296#define AssertLogRel(expr) \
1297 do { \
1298 if (RT_LIKELY(!!(expr))) \
1299 { /* likely */ } \
1300 else \
1301 { \
1302 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1303 RTAssertPanic(); \
1304 } \
1305 } while (0)
1306
1307/** @def AssertLogRelReturn
1308 * Assert that an expression is true, return \a rc if it isn't.
1309 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1310 *
1311 * @param expr Expression which should be true.
1312 * @param rc What is to be presented to return.
1313 */
1314#define AssertLogRelReturn(expr, rc) \
1315 do { \
1316 if (RT_LIKELY(!!(expr))) \
1317 { /* likely */ } \
1318 else \
1319 { \
1320 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1321 RTAssertPanic(); \
1322 return (rc); \
1323 } \
1324 } while (0)
1325
1326/** @def AssertLogRelReturnVoid
1327 * Assert that an expression is true, return void if it isn't.
1328 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1329 *
1330 * @param expr Expression which should be true.
1331 */
1332#define AssertLogRelReturnVoid(expr) \
1333 do { \
1334 if (RT_LIKELY(!!(expr))) \
1335 { /* likely */ } \
1336 else \
1337 { \
1338 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1339 RTAssertPanic(); \
1340 return; \
1341 } \
1342 } while (0)
1343
1344/** @def AssertLogRelBreak
1345 * Assert that an expression is true, break if it isn't.
1346 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1347 *
1348 * @param expr Expression which should be true.
1349 */
1350#define AssertLogRelBreak(expr) \
1351 if (RT_LIKELY(!!(expr))) \
1352 { /* likely */ } \
1353 else if (1) \
1354 { \
1355 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1356 RTAssertPanic(); \
1357 break; \
1358 } \
1359 else do {} while (0)
1360
1361/** @def AssertLogRelBreakStmt
1362 * Assert that an expression is true, execute \a stmt and break if it isn't.
1363 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1364 *
1365 * @param expr Expression which should be true.
1366 * @param stmt Statement to execute before break in case of a failed assertion.
1367 */
1368#define AssertLogRelBreakStmt(expr, stmt) \
1369 if (RT_LIKELY(!!(expr))) \
1370 { /* likely */ } \
1371 else if (1) \
1372 { \
1373 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1374 RTAssertPanic(); \
1375 stmt; \
1376 break; \
1377 } else do {} while (0)
1378
1379/** @def AssertLogRelMsg
1380 * Assert that an expression is true.
1381 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1382 *
1383 * @param expr Expression which should be true.
1384 * @param a printf argument list (in parenthesis).
1385 */
1386#define AssertLogRelMsg(expr, a) \
1387 do { \
1388 if (RT_LIKELY(!!(expr))) \
1389 { /* likely */ } \
1390 else\
1391 { \
1392 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1393 RTAssertLogRelMsg2(a); \
1394 RTAssertPanic(); \
1395 } \
1396 } while (0)
1397
1398/** @def AssertLogRelMsgStmt
1399 * Assert that an expression is true, execute \a stmt and break if it isn't
1400 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1401 *
1402 * @param expr Expression which should be true.
1403 * @param a printf argument list (in parenthesis).
1404 * @param stmt Statement to execute in case of a failed assertion.
1405 */
1406#define AssertLogRelMsgStmt(expr, a, stmt) \
1407 do { \
1408 if (RT_LIKELY(!!(expr))) \
1409 { /* likely */ } \
1410 else\
1411 { \
1412 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1413 RTAssertLogRelMsg2(a); \
1414 RTAssertPanic(); \
1415 stmt; \
1416 } \
1417 } while (0)
1418
1419/** @def AssertLogRelMsgReturn
1420 * Assert that an expression is true, return \a rc if it isn't.
1421 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1422 *
1423 * @param expr Expression which should be true.
1424 * @param a printf argument list (in parenthesis).
1425 * @param rc What is to be presented to return.
1426 */
1427#define AssertLogRelMsgReturn(expr, a, rc) \
1428 do { \
1429 if (RT_LIKELY(!!(expr))) \
1430 { /* likely */ } \
1431 else\
1432 { \
1433 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1434 RTAssertLogRelMsg2(a); \
1435 RTAssertPanic(); \
1436 return (rc); \
1437 } \
1438 } while (0)
1439
1440/** @def AssertLogRelMsgReturnStmt
1441 * Assert that an expression is true, execute @a stmt and return @a rcRet if it
1442 * isn't.
1443 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1444 *
1445 * @param expr Expression which should be true.
1446 * @param a printf argument list (in parenthesis).
1447 * @param stmt Statement to execute before returning in case of a failed
1448 * assertion.
1449 * @param rcRet What is to be presented to return.
1450 */
1451#define AssertLogRelMsgReturnStmt(expr, a, stmt, rcRet) \
1452 do { \
1453 if (RT_LIKELY(!!(expr))) \
1454 { /* likely */ } \
1455 else\
1456 { \
1457 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1458 RTAssertLogRelMsg2(a); \
1459 RTAssertPanic(); \
1460 stmt; \
1461 return (rcRet); \
1462 } \
1463 } while (0)
1464
1465/** @def AssertLogRelMsgReturnVoid
1466 * Assert that an expression is true, return (void) if it isn't.
1467 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1468 *
1469 * @param expr Expression which should be true.
1470 * @param a printf argument list (in parenthesis).
1471 */
1472#define AssertLogRelMsgReturnVoid(expr, a) \
1473 do { \
1474 if (RT_LIKELY(!!(expr))) \
1475 { /* likely */ } \
1476 else\
1477 { \
1478 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1479 RTAssertLogRelMsg2(a); \
1480 RTAssertPanic(); \
1481 return; \
1482 } \
1483 } while (0)
1484
1485/** @def AssertLogRelMsgBreak
1486 * Assert that an expression is true, break if it isn't.
1487 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1488 *
1489 * @param expr Expression which should be true.
1490 * @param a printf argument list (in parenthesis).
1491 */
1492#define AssertLogRelMsgBreak(expr, a) \
1493 if (RT_LIKELY(!!(expr))) \
1494 { /* likely */ } \
1495 else if (1) \
1496 { \
1497 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1498 RTAssertLogRelMsg2(a); \
1499 RTAssertPanic(); \
1500 break; \
1501 } \
1502 else do {} while (0)
1503
1504/** @def AssertLogRelMsgBreakStmt
1505 * Assert that an expression is true, execute \a stmt and break if it isn't.
1506 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1507 *
1508 * @param expr Expression which should be true.
1509 * @param a printf argument list (in parenthesis).
1510 * @param stmt Statement to execute before break in case of a failed assertion.
1511 */
1512#define AssertLogRelMsgBreakStmt(expr, a, stmt) \
1513 if (RT_LIKELY(!!(expr))) \
1514 { /* likely */ } \
1515 else if (1) \
1516 { \
1517 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1518 RTAssertLogRelMsg2(a); \
1519 RTAssertPanic(); \
1520 stmt; \
1521 break; \
1522 } else do {} while (0)
1523
1524/** @def AssertLogRelFailed
1525 * An assertion failed.
1526 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1527 */
1528#define AssertLogRelFailed() \
1529 do { \
1530 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1531 RTAssertPanic(); \
1532 } while (0)
1533
1534/** @def AssertLogRelFailedReturn
1535 * An assertion failed.
1536 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1537 *
1538 * @param rc What is to be presented to return.
1539 */
1540#define AssertLogRelFailedReturn(rc) \
1541 do { \
1542 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1543 RTAssertPanic(); \
1544 return (rc); \
1545 } while (0)
1546
1547/** @def AssertLogRelFailedReturnVoid
1548 * An assertion failed, hit a breakpoint and return.
1549 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1550 */
1551#define AssertLogRelFailedReturnVoid() \
1552 do { \
1553 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1554 RTAssertPanic(); \
1555 return; \
1556 } while (0)
1557
1558/** @def AssertLogRelFailedBreak
1559 * An assertion failed, break.
1560 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1561 */
1562#define AssertLogRelFailedBreak() \
1563 if (1) \
1564 { \
1565 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1566 RTAssertPanic(); \
1567 break; \
1568 } else do {} while (0)
1569
1570/** @def AssertLogRelFailedBreakStmt
1571 * An assertion failed, execute \a stmt and break.
1572 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1573 *
1574 * @param stmt Statement to execute before break.
1575 */
1576#define AssertLogRelFailedBreakStmt(stmt) \
1577 if (1) \
1578 { \
1579 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1580 RTAssertPanic(); \
1581 stmt; \
1582 break; \
1583 } else do {} while (0)
1584
1585/** @def AssertLogRelMsgFailed
1586 * An assertion failed.
1587 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1588 *
1589 * @param a printf argument list (in parenthesis).
1590 */
1591#define AssertLogRelMsgFailed(a) \
1592 do { \
1593 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1594 RTAssertLogRelMsg2(a); \
1595 RTAssertPanic(); \
1596 } while (0)
1597
1598/** @def AssertLogRelMsgFailedStmt
1599 * An assertion failed, execute @a stmt.
1600 *
1601 * Strict builds will hit a breakpoint, non-strict will only do LogRel. The
1602 * statement will be executed in regardless of build type.
1603 *
1604 * @param a printf argument list (in parenthesis).
1605 * @param stmt Statement to execute after raising/logging the assertion.
1606 */
1607#define AssertLogRelMsgFailedStmt(a, stmt) \
1608 do { \
1609 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1610 RTAssertLogRelMsg2(a); \
1611 RTAssertPanic(); \
1612 stmt; \
1613 } while (0)
1614
1615/** @def AssertLogRelMsgFailedReturn
1616 * An assertion failed, return \a rc.
1617 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1618 *
1619 * @param a printf argument list (in parenthesis).
1620 * @param rc What is to be presented to return.
1621 */
1622#define AssertLogRelMsgFailedReturn(a, rc) \
1623 do { \
1624 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1625 RTAssertLogRelMsg2(a); \
1626 RTAssertPanic(); \
1627 return (rc); \
1628 } while (0)
1629
1630/** @def AssertLogRelMsgFailedReturnStmt
1631 * An assertion failed, execute @a stmt and return @a rc.
1632 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1633 *
1634 * @param a printf argument list (in parenthesis).
1635 * @param stmt Statement to execute before returning in case of a failed
1636 * assertion.
1637 * @param rc What is to be presented to return.
1638 */
1639#define AssertLogRelMsgFailedReturnStmt(a, stmt, rc) \
1640 do { \
1641 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1642 RTAssertLogRelMsg2(a); \
1643 RTAssertPanic(); \
1644 stmt; \
1645 return (rc); \
1646 } while (0)
1647
1648/** @def AssertLogRelMsgFailedReturnVoid
1649 * An assertion failed, return void.
1650 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1651 *
1652 * @param a printf argument list (in parenthesis).
1653 */
1654#define AssertLogRelMsgFailedReturnVoid(a) \
1655 do { \
1656 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1657 RTAssertLogRelMsg2(a); \
1658 RTAssertPanic(); \
1659 return; \
1660 } while (0)
1661
1662/** @def AssertLogRelMsgFailedReturnVoidStmt
1663 * An assertion failed, execute @a stmt and return void.
1664 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1665 *
1666 * @param a printf argument list (in parenthesis).
1667 * @param stmt Statement to execute before returning in case of a failed
1668 * assertion.
1669 */
1670#define AssertLogRelMsgFailedReturnVoidStmt(a, stmt) \
1671 do { \
1672 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1673 RTAssertLogRelMsg2(a); \
1674 RTAssertPanic(); \
1675 stmt; \
1676 return; \
1677 } while (0)
1678
1679/** @def AssertLogRelMsgFailedBreak
1680 * An assertion failed, break.
1681 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1682 *
1683 * @param a printf argument list (in parenthesis).
1684 */
1685#define AssertLogRelMsgFailedBreak(a) \
1686 if (1)\
1687 { \
1688 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1689 RTAssertLogRelMsg2(a); \
1690 RTAssertPanic(); \
1691 break; \
1692 } else do {} while (0)
1693
1694/** @def AssertLogRelMsgFailedBreakStmt
1695 * An assertion failed, execute \a stmt and break.
1696 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1697 *
1698 * @param a printf argument list (in parenthesis).
1699 * @param stmt Statement to execute before break.
1700 */
1701#define AssertLogRelMsgFailedBreakStmt(a, stmt) \
1702 if (1) \
1703 { \
1704 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1705 RTAssertLogRelMsg2(a); \
1706 RTAssertPanic(); \
1707 stmt; \
1708 break; \
1709 } else do {} while (0)
1710
1711/** @} */
1712
1713
1714
1715/** @name Release Assertions
1716 *
1717 * These assertions are always enabled.
1718 * @{
1719 */
1720
1721/** @def RTAssertReleasePanic()
1722 * Invokes RTAssertShouldPanic and RTAssertDoPanic.
1723 *
1724 * It might seem odd that RTAssertShouldPanic is necessary when its result isn't
1725 * checked, but it's done since RTAssertShouldPanic is overrideable and might be
1726 * used to bail out before taking down the system (the VMMR0 case).
1727 */
1728#define RTAssertReleasePanic() do { RTAssertShouldPanic(); RTAssertDoPanic(); } while (0)
1729
1730
1731/** @def AssertRelease
1732 * Assert that an expression is true. If it's not hit a breakpoint.
1733 *
1734 * @param expr Expression which should be true.
1735 */
1736#define AssertRelease(expr) \
1737 do { \
1738 if (RT_LIKELY(!!(expr))) \
1739 { /* likely */ } \
1740 else \
1741 { \
1742 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
1743 RTAssertReleasePanic(); \
1744 } \
1745 } while (0)
1746
1747/** @def AssertReleaseReturn
1748 * Assert that an expression is true, hit a breakpoint and return if it isn't.
1749 *
1750 * @param expr Expression which should be true.
1751 * @param rc What is to be presented to return.
1752 */
1753#define AssertReleaseReturn(expr, rc) \
1754 do { \
1755 if (RT_LIKELY(!!(expr))) \
1756 { /* likely */ } \
1757 else \
1758 { \
1759 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1760 RTAssertReleasePanic(); \
1761 return (rc); \
1762 } \
1763 } while (0)
1764
1765/** @def AssertReleaseReturnVoid
1766 * Assert that an expression is true, hit a breakpoint and return if it isn't.
1767 *
1768 * @param expr Expression which should be true.
1769 */
1770#define AssertReleaseReturnVoid(expr) \
1771 do { \
1772 if (RT_LIKELY(!!(expr))) \
1773 { /* likely */ } \
1774 else \
1775 { \
1776 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1777 RTAssertReleasePanic(); \
1778 return; \
1779 } \
1780 } while (0)
1781
1782
1783/** @def AssertReleaseBreak
1784 * Assert that an expression is true, hit a breakpoint and break if it isn't.
1785 *
1786 * @param expr Expression which should be true.
1787 */
1788#define AssertReleaseBreak(expr) \
1789 if (RT_LIKELY(!!(expr))) \
1790 { /* likely */ } \
1791 else if (1) \
1792 { \
1793 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1794 RTAssertReleasePanic(); \
1795 break; \
1796 } else do {} while (0)
1797
1798/** @def AssertReleaseBreakStmt
1799 * Assert that an expression is true, hit a breakpoint and break if it isn't.
1800 *
1801 * @param expr Expression which should be true.
1802 * @param stmt Statement to execute before break in case of a failed assertion.
1803 */
1804#define AssertReleaseBreakStmt(expr, stmt) \
1805 if (RT_LIKELY(!!(expr))) \
1806 { /* likely */ } \
1807 else if (1) \
1808 { \
1809 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1810 RTAssertReleasePanic(); \
1811 stmt; \
1812 break; \
1813 } else do {} while (0)
1814
1815
1816/** @def AssertReleaseMsg
1817 * Assert that an expression is true, print the message and hit a breakpoint if it isn't.
1818 *
1819 * @param expr Expression which should be true.
1820 * @param a printf argument list (in parenthesis).
1821 */
1822#define AssertReleaseMsg(expr, a) \
1823 do { \
1824 if (RT_LIKELY(!!(expr))) \
1825 { /* likely */ } \
1826 else \
1827 { \
1828 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1829 RTAssertMsg2Weak a; \
1830 RTAssertReleasePanic(); \
1831 } \
1832 } while (0)
1833
1834/** @def AssertReleaseMsgReturn
1835 * Assert that an expression is true, print the message and hit a breakpoint and return if it isn't.
1836 *
1837 * @param expr Expression which should be true.
1838 * @param a printf argument list (in parenthesis).
1839 * @param rc What is to be presented to return.
1840 */
1841#define AssertReleaseMsgReturn(expr, a, rc) \
1842 do { \
1843 if (RT_LIKELY(!!(expr))) \
1844 { /* likely */ } \
1845 else \
1846 { \
1847 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1848 RTAssertMsg2Weak a; \
1849 RTAssertReleasePanic(); \
1850 return (rc); \
1851 } \
1852 } while (0)
1853
1854/** @def AssertReleaseMsgReturnVoid
1855 * Assert that an expression is true, print the message and hit a breakpoint and return if it isn't.
1856 *
1857 * @param expr Expression which should be true.
1858 * @param a printf argument list (in parenthesis).
1859 */
1860#define AssertReleaseMsgReturnVoid(expr, a) \
1861 do { \
1862 if (RT_LIKELY(!!(expr))) \
1863 { /* likely */ } \
1864 else \
1865 { \
1866 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1867 RTAssertMsg2Weak a; \
1868 RTAssertReleasePanic(); \
1869 return; \
1870 } \
1871 } while (0)
1872
1873
1874/** @def AssertReleaseMsgBreak
1875 * Assert that an expression is true, print the message and hit a breakpoint and break if it isn't.
1876 *
1877 * @param expr Expression which should be true.
1878 * @param a printf argument list (in parenthesis).
1879 */
1880#define AssertReleaseMsgBreak(expr, a) \
1881 if (RT_LIKELY(!!(expr))) \
1882 { /* likely */ } \
1883 else if (1) \
1884 { \
1885 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1886 RTAssertMsg2Weak a; \
1887 RTAssertReleasePanic(); \
1888 break; \
1889 } else do {} while (0)
1890
1891/** @def AssertReleaseMsgBreakStmt
1892 * Assert that an expression is true, print the message and hit a breakpoint and break if it isn't.
1893 *
1894 * @param expr Expression which should be true.
1895 * @param a printf argument list (in parenthesis).
1896 * @param stmt Statement to execute before break in case of a failed assertion.
1897 */
1898#define AssertReleaseMsgBreakStmt(expr, a, stmt) \
1899 if (RT_LIKELY(!!(expr))) \
1900 { /* likely */ } \
1901 else if (1) \
1902 { \
1903 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1904 RTAssertMsg2Weak a; \
1905 RTAssertReleasePanic(); \
1906 stmt; \
1907 break; \
1908 } else do {} while (0)
1909
1910
1911/** @def AssertReleaseFailed
1912 * An assertion failed, hit a breakpoint.
1913 */
1914#define AssertReleaseFailed() \
1915 do { \
1916 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1917 RTAssertReleasePanic(); \
1918 } while (0)
1919
1920/** @def AssertReleaseFailedReturn
1921 * An assertion failed, hit a breakpoint and return.
1922 *
1923 * @param rc What is to be presented to return.
1924 */
1925#define AssertReleaseFailedReturn(rc) \
1926 do { \
1927 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1928 RTAssertReleasePanic(); \
1929 return (rc); \
1930 } while (0)
1931
1932/** @def AssertReleaseFailedReturnVoid
1933 * An assertion failed, hit a breakpoint and return.
1934 */
1935#define AssertReleaseFailedReturnVoid() \
1936 do { \
1937 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1938 RTAssertReleasePanic(); \
1939 return; \
1940 } while (0)
1941
1942
1943/** @def AssertReleaseFailedBreak
1944 * An assertion failed, hit a breakpoint and break.
1945 */
1946#define AssertReleaseFailedBreak() \
1947 if (1) { \
1948 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1949 RTAssertReleasePanic(); \
1950 break; \
1951 } else do {} while (0)
1952
1953/** @def AssertReleaseFailedBreakStmt
1954 * An assertion failed, hit a breakpoint and break.
1955 *
1956 * @param stmt Statement to execute before break.
1957 */
1958#define AssertReleaseFailedBreakStmt(stmt) \
1959 if (1) { \
1960 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1961 RTAssertReleasePanic(); \
1962 stmt; \
1963 break; \
1964 } else do {} while (0)
1965
1966
1967/** @def AssertReleaseMsgFailed
1968 * An assertion failed, print a message and hit a breakpoint.
1969 *
1970 * @param a printf argument list (in parenthesis).
1971 */
1972#define AssertReleaseMsgFailed(a) \
1973 do { \
1974 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
1975 RTAssertMsg2Weak a; \
1976 RTAssertReleasePanic(); \
1977 } while (0)
1978
1979/** @def AssertReleaseMsgFailedReturn
1980 * An assertion failed, print a message, hit a breakpoint and return.
1981 *
1982 * @param a printf argument list (in parenthesis).
1983 * @param rc What is to be presented to return.
1984 */
1985#define AssertReleaseMsgFailedReturn(a, rc) \
1986 do { \
1987 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1988 RTAssertMsg2Weak a; \
1989 RTAssertReleasePanic(); \
1990 return (rc); \
1991 } while (0)
1992
1993/** @def AssertReleaseMsgFailedReturnVoid
1994 * An assertion failed, print a message, hit a breakpoint and return.
1995 *
1996 * @param a printf argument list (in parenthesis).
1997 */
1998#define AssertReleaseMsgFailedReturnVoid(a) \
1999 do { \
2000 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
2001 RTAssertMsg2Weak a; \
2002 RTAssertReleasePanic(); \
2003 return; \
2004 } while (0)
2005
2006
2007/** @def AssertReleaseMsgFailedBreak
2008 * An assertion failed, print a message, hit a breakpoint and break.
2009 *
2010 * @param a printf argument list (in parenthesis).
2011 */
2012#define AssertReleaseMsgFailedBreak(a) \
2013 if (1) { \
2014 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
2015 RTAssertMsg2Weak a; \
2016 RTAssertReleasePanic(); \
2017 break; \
2018 } else do {} while (0)
2019
2020/** @def AssertReleaseMsgFailedBreakStmt
2021 * An assertion failed, print a message, hit a breakpoint and break.
2022 *
2023 * @param a printf argument list (in parenthesis).
2024 * @param stmt Statement to execute before break.
2025 */
2026#define AssertReleaseMsgFailedBreakStmt(a, stmt) \
2027 if (1) { \
2028 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
2029 RTAssertMsg2Weak a; \
2030 RTAssertReleasePanic(); \
2031 stmt; \
2032 break; \
2033 } else do {} while (0)
2034
2035/** @} */
2036
2037
2038
2039/** @name Fatal Assertions
2040 * These are similar to release assertions except that you cannot ignore them in
2041 * any way, they will loop for ever if RTAssertDoPanic returns.
2042 *
2043 * @{
2044 */
2045
2046/** @def AssertFatal
2047 * Assert that an expression is true. If it's not hit a breakpoint (for ever).
2048 *
2049 * @param expr Expression which should be true.
2050 */
2051#define AssertFatal(expr) \
2052 do { \
2053 if (RT_LIKELY(!!(expr))) \
2054 { /* likely */ } \
2055 else \
2056 for (;;) \
2057 { \
2058 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
2059 RTAssertReleasePanic(); \
2060 } \
2061 } while (0)
2062
2063/** @def AssertFatalMsg
2064 * Assert that an expression is true, print the message and hit a breakpoint (for ever) if it isn't.
2065 *
2066 * @param expr Expression which should be true.
2067 * @param a printf argument list (in parenthesis).
2068 */
2069#define AssertFatalMsg(expr, a) \
2070 do { \
2071 if (RT_LIKELY(!!(expr))) \
2072 { /* likely */ } \
2073 else \
2074 for (;;) \
2075 { \
2076 RTAssertMsg1Weak(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
2077 RTAssertMsg2Weak a; \
2078 RTAssertReleasePanic(); \
2079 } \
2080 } while (0)
2081
2082/** @def AssertFatalFailed
2083 * An assertion failed, hit a breakpoint (for ever).
2084 */
2085#define AssertFatalFailed() \
2086 do { \
2087 for (;;) \
2088 { \
2089 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
2090 RTAssertReleasePanic(); \
2091 } \
2092 } while (0)
2093
2094/** @def AssertFatalMsgFailed
2095 * An assertion failed, print a message and hit a breakpoint (for ever).
2096 *
2097 * @param a printf argument list (in parenthesis).
2098 */
2099#define AssertFatalMsgFailed(a) \
2100 do { \
2101 for (;;) \
2102 { \
2103 RTAssertMsg1Weak((const char *)0, __LINE__, __FILE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__); \
2104 RTAssertMsg2Weak a; \
2105 RTAssertReleasePanic(); \
2106 } \
2107 } while (0)
2108
2109/** @} */
2110
2111
2112
2113/** @name Convenience Assertions Macros
2114 * @{
2115 */
2116
2117/** @def AssertRC
2118 * Asserts a iprt status code successful.
2119 *
2120 * On failure it will print info about the rc and hit a breakpoint.
2121 *
2122 * @param rc iprt status code.
2123 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2124 */
2125#define AssertRC(rc) AssertMsgRC(rc, ("%Rra\n", (rc)))
2126
2127/** @def AssertRCStmt
2128 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and execute
2129 * @a stmt if it isn't.
2130 *
2131 * @param rc iprt status code.
2132 * @param stmt Statement to execute before returning in case of a failed
2133 * assertion.
2134 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2135 */
2136#define AssertRCStmt(rc, stmt) AssertMsgRCStmt(rc, ("%Rra\n", (rc)), stmt)
2137
2138/** @def AssertRCReturn
2139 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and return if it isn't.
2140 *
2141 * @param rc iprt status code.
2142 * @param rcRet What is to be presented to return.
2143 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2144 */
2145#define AssertRCReturn(rc, rcRet) AssertMsgRCReturn(rc, ("%Rra\n", (rc)), rcRet)
2146
2147/** @def AssertRCReturnStmt
2148 * Asserts a iprt status code successful, bitch (RT_STRICT mode only), execute
2149 * @a stmt and returns @a rcRet if it isn't.
2150 *
2151 * @param rc iprt status code.
2152 * @param stmt Statement to execute before returning in case of a failed
2153 * assertion.
2154 * @param rcRet What is to be presented to return.
2155 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2156 */
2157#define AssertRCReturnStmt(rc, stmt, rcRet) AssertMsgRCReturnStmt(rc, ("%Rra\n", (rc)), stmt, rcRet)
2158
2159/** @def AssertRCReturnVoid
2160 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and return if it isn't.
2161 *
2162 * @param rc iprt status code.
2163 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2164 */
2165#define AssertRCReturnVoid(rc) AssertMsgRCReturnVoid(rc, ("%Rra\n", (rc)))
2166
2167/** @def AssertRCReturnVoidStmt
2168 * Asserts a iprt status code successful, bitch (RT_STRICT mode only), and
2169 * execute the given statement/return if it isn't.
2170 *
2171 * @param rc iprt status code.
2172 * @param stmt Statement to execute before returning on failure.
2173 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2174 */
2175#define AssertRCReturnVoidStmt(rc, stmt) AssertMsgRCReturnVoidStmt(rc, ("%Rra\n", (rc)), stmt)
2176
2177/** @def AssertRCBreak
2178 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and break if it isn't.
2179 *
2180 * @param rc iprt status code.
2181 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2182 */
2183#define AssertRCBreak(rc) AssertMsgRCBreak(rc, ("%Rra\n", (rc)))
2184
2185/** @def AssertRCBreakStmt
2186 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and break if it isn't.
2187 *
2188 * @param rc iprt status code.
2189 * @param stmt Statement to execute before break in case of a failed assertion.
2190 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2191 */
2192#define AssertRCBreakStmt(rc, stmt) AssertMsgRCBreakStmt(rc, ("%Rra\n", (rc)), stmt)
2193
2194/** @def AssertMsgRC
2195 * Asserts a iprt status code successful.
2196 *
2197 * It prints a custom message and hits a breakpoint on FAILURE.
2198 *
2199 * @param rc iprt status code.
2200 * @param msg printf argument list (in parenthesis).
2201 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2202 */
2203#define AssertMsgRC(rc, msg) \
2204 do { AssertMsg(RT_SUCCESS_NP(rc), msg); NOREF(rc); } while (0)
2205
2206/** @def AssertMsgRCStmt
2207 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and
2208 * execute @a stmt if it isn't.
2209 *
2210 * @param rc iprt status code.
2211 * @param msg printf argument list (in parenthesis).
2212 * @param stmt Statement to execute before returning in case of a failed
2213 * assertion.
2214 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2215 */
2216#define AssertMsgRCStmt(rc, msg, stmt) \
2217 do { AssertMsgStmt(RT_SUCCESS_NP(rc), msg, stmt); NOREF(rc); } while (0)
2218
2219/** @def AssertMsgRCReturn
2220 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and return
2221 * @a rcRet if it isn't.
2222 *
2223 * @param rc iprt status code.
2224 * @param msg printf argument list (in parenthesis).
2225 * @param rcRet What is to be presented to return.
2226 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2227 */
2228#define AssertMsgRCReturn(rc, msg, rcRet) \
2229 do { AssertMsgReturn(RT_SUCCESS_NP(rc), msg, rcRet); NOREF(rc); } while (0)
2230
2231/** @def AssertMsgRCReturnStmt
2232 * Asserts a iprt status code successful, bitch (RT_STRICT mode only), execute
2233 * @a stmt and return @a rcRet if it isn't.
2234 *
2235 * @param rc iprt status code.
2236 * @param msg printf argument list (in parenthesis).
2237 * @param stmt Statement to execute before returning in case of a failed
2238 * assertion.
2239 * @param rcRet What is to be presented to return.
2240 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2241 */
2242#define AssertMsgRCReturnStmt(rc, msg, stmt, rcRet) \
2243 do { AssertMsgReturnStmt(RT_SUCCESS_NP(rc), msg, stmt, rcRet); NOREF(rc); } while (0)
2244
2245/** @def AssertMsgRCReturnVoid
2246 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and return
2247 * void if it isn't.
2248 *
2249 * @param rc iprt status code.
2250 * @param msg printf argument list (in parenthesis).
2251 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2252 */
2253#define AssertMsgRCReturnVoid(rc, msg) \
2254 do { AssertMsgReturnVoid(RT_SUCCESS_NP(rc), msg); NOREF(rc); } while (0)
2255
2256/** @def AssertMsgRCReturnVoidStmt
2257 * Asserts a iprt status code successful, bitch (RT_STRICT mode only), execute
2258 * @a stmt and return void if it isn't.
2259 *
2260 * @param rc iprt status code.
2261 * @param msg printf argument list (in parenthesis).
2262 * @param stmt Statement to execute before break in case of a failed assertion.
2263 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2264 */
2265#define AssertMsgRCReturnVoidStmt(rc, msg, stmt) \
2266 do { AssertMsgReturnVoidStmt(RT_SUCCESS_NP(rc), msg, stmt); NOREF(rc); } while (0)
2267
2268/** @def AssertMsgRCBreak
2269 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and break
2270 * if it isn't.
2271 *
2272 * @param rc iprt status code.
2273 * @param msg printf argument list (in parenthesis).
2274 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2275 */
2276#define AssertMsgRCBreak(rc, msg) \
2277 if (1) { AssertMsgBreak(RT_SUCCESS(rc), msg); NOREF(rc); } else do {} while (0)
2278
2279/** @def AssertMsgRCBreakStmt
2280 * Asserts a iprt status code successful, bitch (RT_STRICT mode only), execute
2281 * @a stmt and break if it isn't.
2282 *
2283 * @param rc iprt status code.
2284 * @param msg printf argument list (in parenthesis).
2285 * @param stmt Statement to execute before break in case of a failed assertion.
2286 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2287 */
2288#define AssertMsgRCBreakStmt(rc, msg, stmt) \
2289 if (1) { AssertMsgBreakStmt(RT_SUCCESS_NP(rc), msg, stmt); NOREF(rc); } else do {} while (0)
2290
2291/** @def AssertRCSuccess
2292 * Asserts an iprt status code equals VINF_SUCCESS.
2293 *
2294 * On failure it will print info about the rc and hit a breakpoint.
2295 *
2296 * @param rc iprt status code.
2297 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2298 */
2299#define AssertRCSuccess(rc) do { AssertMsg((rc) == VINF_SUCCESS, ("%Rra\n", (rc))); NOREF(rc); } while (0)
2300
2301/** @def AssertRCSuccessReturn
2302 * Asserts that an iprt status code equals VINF_SUCCESS, bitch (RT_STRICT mode only) and return if it isn't.
2303 *
2304 * @param rc iprt status code.
2305 * @param rcRet What is to be presented to return.
2306 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2307 */
2308#define AssertRCSuccessReturn(rc, rcRet) AssertMsgReturn((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), rcRet)
2309
2310/** @def AssertRCSuccessReturnVoid
2311 * Asserts that an iprt status code equals VINF_SUCCESS, bitch (RT_STRICT mode only) and return if it isn't.
2312 *
2313 * @param rc iprt status code.
2314 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2315 */
2316#define AssertRCSuccessReturnVoid(rc) AssertMsgReturnVoid((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
2317
2318/** @def AssertRCSuccessBreak
2319 * Asserts that an iprt status code equals VINF_SUCCESS, bitch (RT_STRICT mode only) and break if it isn't.
2320 *
2321 * @param rc iprt status code.
2322 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2323 */
2324#define AssertRCSuccessBreak(rc) AssertMsgBreak((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
2325
2326/** @def AssertRCSuccessBreakStmt
2327 * Asserts that an iprt status code equals VINF_SUCCESS, bitch (RT_STRICT mode only) and break if it isn't.
2328 *
2329 * @param rc iprt status code.
2330 * @param stmt Statement to execute before break in case of a failed assertion.
2331 * @remark rc is referenced multiple times. In release mode is NOREF()'ed.
2332 */
2333#define AssertRCSuccessBreakStmt(rc, stmt) AssertMsgBreakStmt((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), stmt)
2334
2335
2336/** @def AssertLogRelRC
2337 * Asserts a iprt status code successful.
2338 *
2339 * @param rc iprt status code.
2340 * @remark rc is referenced multiple times.
2341 */
2342#define AssertLogRelRC(rc) AssertLogRelMsgRC(rc, ("%Rra\n", (rc)))
2343
2344/** @def AssertLogRelRCReturn
2345 * Asserts a iprt status code successful, returning \a rc if it isn't.
2346 *
2347 * @param rc iprt status code.
2348 * @param rcRet What is to be presented to return.
2349 * @remark rc is referenced multiple times.
2350 */
2351#define AssertLogRelRCReturn(rc, rcRet) AssertLogRelMsgRCReturn(rc, ("%Rra\n", (rc)), rcRet)
2352
2353/** @def AssertLogRelRCReturnStmt
2354 * Asserts a iprt status code successful, executing \a stmt and returning \a rc
2355 * if it isn't.
2356 *
2357 * @param rc iprt status code.
2358 * @param stmt Statement to execute before returning in case of a failed
2359 * assertion.
2360 * @param rcRet What is to be presented to return.
2361 * @remark rc is referenced multiple times.
2362 */
2363#define AssertLogRelRCReturnStmt(rc, stmt, rcRet) AssertLogRelMsgRCReturnStmt(rc, ("%Rra\n", (rc)), stmt, rcRet)
2364
2365/** @def AssertLogRelRCReturnVoid
2366 * Asserts a iprt status code successful, returning (void) if it isn't.
2367 *
2368 * @param rc iprt status code.
2369 * @remark rc is referenced multiple times.
2370 */
2371#define AssertLogRelRCReturnVoid(rc) AssertLogRelMsgRCReturnVoid(rc, ("%Rra\n", (rc)))
2372
2373/** @def AssertLogRelRCBreak
2374 * Asserts a iprt status code successful, breaking if it isn't.
2375 *
2376 * @param rc iprt status code.
2377 * @remark rc is referenced multiple times.
2378 */
2379#define AssertLogRelRCBreak(rc) AssertLogRelMsgRCBreak(rc, ("%Rra\n", (rc)))
2380
2381/** @def AssertLogRelRCBreakStmt
2382 * Asserts a iprt status code successful, execute \a statement and break if it isn't.
2383 *
2384 * @param rc iprt status code.
2385 * @param stmt Statement to execute before break in case of a failed assertion.
2386 * @remark rc is referenced multiple times.
2387 */
2388#define AssertLogRelRCBreakStmt(rc, stmt) AssertLogRelMsgRCBreakStmt(rc, ("%Rra\n", (rc)), stmt)
2389
2390/** @def AssertLogRelMsgRC
2391 * Asserts a iprt status code successful.
2392 *
2393 * @param rc iprt status code.
2394 * @param msg printf argument list (in parenthesis).
2395 * @remark rc is referenced multiple times.
2396 */
2397#define AssertLogRelMsgRC(rc, msg) AssertLogRelMsg(RT_SUCCESS_NP(rc), msg)
2398
2399/** @def AssertLogRelMsgRCReturn
2400 * Asserts a iprt status code successful.
2401 *
2402 * @param rc iprt status code.
2403 * @param msg printf argument list (in parenthesis).
2404 * @param rcRet What is to be presented to return.
2405 * @remark rc is referenced multiple times.
2406 */
2407#define AssertLogRelMsgRCReturn(rc, msg, rcRet) AssertLogRelMsgReturn(RT_SUCCESS_NP(rc), msg, rcRet)
2408
2409/** @def AssertLogRelMsgRCReturnStmt
2410 * Asserts a iprt status code successful, execute \a stmt and return on
2411 * failure.
2412 *
2413 * @param rc iprt status code.
2414 * @param msg printf argument list (in parenthesis).
2415 * @param stmt Statement to execute before returning in case of a failed
2416 * assertion.
2417 * @param rcRet What is to be presented to return.
2418 * @remark rc is referenced multiple times.
2419 */
2420#define AssertLogRelMsgRCReturnStmt(rc, msg, stmt, rcRet) AssertLogRelMsgReturnStmt(RT_SUCCESS_NP(rc), msg, stmt, rcRet)
2421
2422/** @def AssertLogRelMsgRCReturnVoid
2423 * Asserts a iprt status code successful.
2424 *
2425 * @param rc iprt status code.
2426 * @param msg printf argument list (in parenthesis).
2427 * @remark rc is referenced multiple times.
2428 */
2429#define AssertLogRelMsgRCReturnVoid(rc, msg) AssertLogRelMsgReturnVoid(RT_SUCCESS_NP(rc), msg)
2430
2431/** @def AssertLogRelMsgRCBreak
2432 * Asserts a iprt status code successful.
2433 *
2434 * @param rc iprt status code.
2435 * @param msg printf argument list (in parenthesis).
2436 * @remark rc is referenced multiple times.
2437 */
2438#define AssertLogRelMsgRCBreak(rc, msg) AssertLogRelMsgBreak(RT_SUCCESS(rc), msg)
2439
2440/** @def AssertLogRelMsgRCBreakStmt
2441 * Asserts a iprt status code successful, execute \a stmt and break if it isn't.
2442 *
2443 * @param rc iprt status code.
2444 * @param msg printf argument list (in parenthesis).
2445 * @param stmt Statement to execute before break in case of a failed assertion.
2446 * @remark rc is referenced multiple times.
2447 */
2448#define AssertLogRelMsgRCBreakStmt(rc, msg, stmt) AssertLogRelMsgBreakStmt(RT_SUCCESS_NP(rc), msg, stmt)
2449
2450/** @def AssertLogRelRCSuccess
2451 * Asserts that an iprt status code equals VINF_SUCCESS.
2452 *
2453 * @param rc iprt status code.
2454 * @remark rc is referenced multiple times.
2455 */
2456#define AssertLogRelRCSuccess(rc) AssertLogRelMsg((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
2457
2458/** @def AssertLogRelRCSuccessReturn
2459 * Asserts that an iprt status code equals VINF_SUCCESS.
2460 *
2461 * @param rc iprt status code.
2462 * @param rcRet What is to be presented to return.
2463 * @remark rc is referenced multiple times.
2464 */
2465#define AssertLogRelRCSuccessReturn(rc, rcRet) AssertLogRelMsgReturn((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), rcRet)
2466
2467/** @def AssertLogRelRCSuccessReturnVoid
2468 * Asserts that an iprt status code equals VINF_SUCCESS.
2469 *
2470 * @param rc iprt status code.
2471 * @remark rc is referenced multiple times.
2472 */
2473#define AssertLogRelRCSuccessReturnVoid(rc) AssertLogRelMsgReturnVoid((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
2474
2475/** @def AssertLogRelRCSuccessBreak
2476 * Asserts that an iprt status code equals VINF_SUCCESS.
2477 *
2478 * @param rc iprt status code.
2479 * @remark rc is referenced multiple times.
2480 */
2481#define AssertLogRelRCSuccessBreak(rc) AssertLogRelMsgBreak((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
2482
2483/** @def AssertLogRelRCSuccessBreakStmt
2484 * Asserts that an iprt status code equals VINF_SUCCESS.
2485 *
2486 * @param rc iprt status code.
2487 * @param stmt Statement to execute before break in case of a failed assertion.
2488 * @remark rc is referenced multiple times.
2489 */
2490#define AssertLogRelRCSuccessBreakStmt(rc, stmt) AssertLogRelMsgBreakStmt((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), stmt)
2491
2492
2493/** @def AssertReleaseRC
2494 * Asserts a iprt status code successful.
2495 *
2496 * On failure information about the error will be printed and a breakpoint hit.
2497 *
2498 * @param rc iprt status code.
2499 * @remark rc is referenced multiple times.
2500 */
2501#define AssertReleaseRC(rc) AssertReleaseMsgRC(rc, ("%Rra\n", (rc)))
2502
2503/** @def AssertReleaseRCReturn
2504 * Asserts a iprt status code successful, returning if it isn't.
2505 *
2506 * On failure information about the error will be printed, a breakpoint hit
2507 * and finally returning from the function if the breakpoint is somehow ignored.
2508 *
2509 * @param rc iprt status code.
2510 * @param rcRet What is to be presented to return.
2511 * @remark rc is referenced multiple times.
2512 */
2513#define AssertReleaseRCReturn(rc, rcRet) AssertReleaseMsgRCReturn(rc, ("%Rra\n", (rc)), rcRet)
2514
2515/** @def AssertReleaseRCReturnVoid
2516 * Asserts a iprt status code successful, returning if it isn't.
2517 *
2518 * On failure information about the error will be printed, a breakpoint hit
2519 * and finally returning from the function if the breakpoint is somehow ignored.
2520 *
2521 * @param rc iprt status code.
2522 * @remark rc is referenced multiple times.
2523 */
2524#define AssertReleaseRCReturnVoid(rc) AssertReleaseMsgRCReturnVoid(rc, ("%Rra\n", (rc)))
2525
2526/** @def AssertReleaseRCBreak
2527 * Asserts a iprt status code successful, breaking if it isn't.
2528 *
2529 * On failure information about the error will be printed, a breakpoint hit
2530 * and finally breaking the current statement if the breakpoint is somehow ignored.
2531 *
2532 * @param rc iprt status code.
2533 * @remark rc is referenced multiple times.
2534 */
2535#define AssertReleaseRCBreak(rc) AssertReleaseMsgRCBreak(rc, ("%Rra\n", (rc)))
2536
2537/** @def AssertReleaseRCBreakStmt
2538 * Asserts a iprt status code successful, break if it isn't.
2539 *
2540 * On failure information about the error will be printed, a breakpoint hit
2541 * and finally the break statement will be issued if the breakpoint is somehow ignored.
2542 *
2543 * @param rc iprt status code.
2544 * @param stmt Statement to execute before break in case of a failed assertion.
2545 * @remark rc is referenced multiple times.
2546 */
2547#define AssertReleaseRCBreakStmt(rc, stmt) AssertReleaseMsgRCBreakStmt(rc, ("%Rra\n", (rc)), stmt)
2548
2549/** @def AssertReleaseMsgRC
2550 * Asserts a iprt status code successful.
2551 *
2552 * On failure a custom message is printed and a breakpoint is hit.
2553 *
2554 * @param rc iprt status code.
2555 * @param msg printf argument list (in parenthesis).
2556 * @remark rc is referenced multiple times.
2557 */
2558#define AssertReleaseMsgRC(rc, msg) AssertReleaseMsg(RT_SUCCESS_NP(rc), msg)
2559
2560/** @def AssertReleaseMsgRCReturn
2561 * Asserts a iprt status code successful.
2562 *
2563 * On failure a custom message is printed, a breakpoint is hit, and finally
2564 * returning from the function if the breakpoint is somehow ignored.
2565 *
2566 * @param rc iprt status code.
2567 * @param msg printf argument list (in parenthesis).
2568 * @param rcRet What is to be presented to return.
2569 * @remark rc is referenced multiple times.
2570 */
2571#define AssertReleaseMsgRCReturn(rc, msg, rcRet) AssertReleaseMsgReturn(RT_SUCCESS_NP(rc), msg, rcRet)
2572
2573/** @def AssertReleaseMsgRCReturnVoid
2574 * Asserts a iprt status code successful.
2575 *
2576 * On failure a custom message is printed, a breakpoint is hit, and finally
2577 * returning from the function if the breakpoint is somehow ignored.
2578 *
2579 * @param rc iprt status code.
2580 * @param msg printf argument list (in parenthesis).
2581 * @remark rc is referenced multiple times.
2582 */
2583#define AssertReleaseMsgRCReturnVoid(rc, msg) AssertReleaseMsgReturnVoid(RT_SUCCESS_NP(rc), msg)
2584
2585/** @def AssertReleaseMsgRCBreak
2586 * Asserts a iprt status code successful.
2587 *
2588 * On failure a custom message is printed, a breakpoint is hit, and finally
2589 * breaking the current status if the breakpoint is somehow ignored.
2590 *
2591 * @param rc iprt status code.
2592 * @param msg printf argument list (in parenthesis).
2593 * @remark rc is referenced multiple times.
2594 */
2595#define AssertReleaseMsgRCBreak(rc, msg) AssertReleaseMsgBreak(RT_SUCCESS(rc), msg)
2596
2597/** @def AssertReleaseMsgRCBreakStmt
2598 * Asserts a iprt status code successful.
2599 *
2600 * On failure a custom message is printed, a breakpoint is hit, and finally
2601 * the break statement is issued if the breakpoint is somehow ignored.
2602 *
2603 * @param rc iprt status code.
2604 * @param msg printf argument list (in parenthesis).
2605 * @param stmt Statement to execute before break in case of a failed assertion.
2606 * @remark rc is referenced multiple times.
2607 */
2608#define AssertReleaseMsgRCBreakStmt(rc, msg, stmt) AssertReleaseMsgBreakStmt(RT_SUCCESS_NP(rc), msg, stmt)
2609
2610/** @def AssertReleaseRCSuccess
2611 * Asserts that an iprt status code equals VINF_SUCCESS.
2612 *
2613 * On failure information about the error will be printed and a breakpoint hit.
2614 *
2615 * @param rc iprt status code.
2616 * @remark rc is referenced multiple times.
2617 */
2618#define AssertReleaseRCSuccess(rc) AssertReleaseMsg((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
2619
2620/** @def AssertReleaseRCSuccessReturn
2621 * Asserts that an iprt status code equals VINF_SUCCESS.
2622 *
2623 * On failure information about the error will be printed, a breakpoint hit
2624 * and finally returning from the function if the breakpoint is somehow ignored.
2625 *
2626 * @param rc iprt status code.
2627 * @param rcRet What is to be presented to return.
2628 * @remark rc is referenced multiple times.
2629 */
2630#define AssertReleaseRCSuccessReturn(rc, rcRet) AssertReleaseMsgReturn((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), rcRet)
2631
2632/** @def AssertReleaseRCSuccessReturnVoid
2633 * Asserts that an iprt status code equals VINF_SUCCESS.
2634 *
2635 * On failure information about the error will be printed, a breakpoint hit
2636 * and finally returning from the function if the breakpoint is somehow ignored.
2637 *
2638 * @param rc iprt status code.
2639 * @remark rc is referenced multiple times.
2640 */
2641#define AssertReleaseRCSuccessReturnVoid(rc) AssertReleaseMsgReturnVoid((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
2642
2643/** @def AssertReleaseRCSuccessBreak
2644 * Asserts that an iprt status code equals VINF_SUCCESS.
2645 *
2646 * On failure information about the error will be printed, a breakpoint hit
2647 * and finally breaking the current statement if the breakpoint is somehow ignored.
2648 *
2649 * @param rc iprt status code.
2650 * @remark rc is referenced multiple times.
2651 */
2652#define AssertReleaseRCSuccessBreak(rc) AssertReleaseMsgBreak((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
2653
2654/** @def AssertReleaseRCSuccessBreakStmt
2655 * Asserts that an iprt status code equals VINF_SUCCESS.
2656 *
2657 * On failure information about the error will be printed, a breakpoint hit
2658 * and finally the break statement will be issued if the breakpoint is somehow ignored.
2659 *
2660 * @param rc iprt status code.
2661 * @param stmt Statement to execute before break in case of a failed assertion.
2662 * @remark rc is referenced multiple times.
2663 */
2664#define AssertReleaseRCSuccessBreakStmt(rc, stmt) AssertReleaseMsgBreakStmt((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), stmt)
2665
2666
2667/** @def AssertFatalRC
2668 * Asserts a iprt status code successful.
2669 *
2670 * On failure information about the error will be printed and a breakpoint hit.
2671 *
2672 * @param rc iprt status code.
2673 * @remark rc is referenced multiple times.
2674 */
2675#define AssertFatalRC(rc) AssertFatalMsgRC(rc, ("%Rra\n", (rc)))
2676
2677/** @def AssertReleaseMsgRC
2678 * Asserts a iprt status code successful.
2679 *
2680 * On failure a custom message is printed and a breakpoint is hit.
2681 *
2682 * @param rc iprt status code.
2683 * @param msg printf argument list (in parenthesis).
2684 * @remark rc is referenced multiple times.
2685 */
2686#define AssertFatalMsgRC(rc, msg) AssertFatalMsg(RT_SUCCESS_NP(rc), msg)
2687
2688/** @def AssertFatalRCSuccess
2689 * Asserts that an iprt status code equals VINF_SUCCESS.
2690 *
2691 * On failure information about the error will be printed and a breakpoint hit.
2692 *
2693 * @param rc iprt status code.
2694 * @remark rc is referenced multiple times.
2695 */
2696#define AssertFatalRCSuccess(rc) AssertFatalMsg((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
2697
2698
2699/** @def AssertPtr
2700 * Asserts that a pointer is valid.
2701 *
2702 * @param pv The pointer.
2703 */
2704#define AssertPtr(pv) AssertMsg(VALID_PTR(pv), ("%p\n", (pv)))
2705
2706/** @def AssertPtrReturn
2707 * Asserts that a pointer is valid.
2708 *
2709 * @param pv The pointer.
2710 * @param rcRet What is to be presented to return.
2711 */
2712#define AssertPtrReturn(pv, rcRet) AssertMsgReturn(VALID_PTR(pv), ("%p\n", (pv)), rcRet)
2713
2714/** @def AssertPtrReturnVoid
2715 * Asserts that a pointer is valid.
2716 *
2717 * @param pv The pointer.
2718 */
2719#define AssertPtrReturnVoid(pv) AssertMsgReturnVoid(VALID_PTR(pv), ("%p\n", (pv)))
2720
2721/** @def AssertPtrBreak
2722 * Asserts that a pointer is valid.
2723 *
2724 * @param pv The pointer.
2725 */
2726#define AssertPtrBreak(pv) AssertMsgBreak(VALID_PTR(pv), ("%p\n", (pv)))
2727
2728/** @def AssertPtrBreakStmt
2729 * Asserts that a pointer is valid.
2730 *
2731 * @param pv The pointer.
2732 * @param stmt Statement to execute before break in case of a failed assertion.
2733 */
2734#define AssertPtrBreakStmt(pv, stmt) AssertMsgBreakStmt(VALID_PTR(pv), ("%p\n", (pv)), stmt)
2735
2736/** @def AssertPtrNull
2737 * Asserts that a pointer is valid or NULL.
2738 *
2739 * @param pv The pointer.
2740 */
2741#define AssertPtrNull(pv) AssertMsg(VALID_PTR(pv) || (pv) == NULL, ("%p\n", (pv)))
2742
2743/** @def AssertPtrNullReturn
2744 * Asserts that a pointer is valid or NULL.
2745 *
2746 * @param pv The pointer.
2747 * @param rcRet What is to be presented to return.
2748 */
2749#define AssertPtrNullReturn(pv, rcRet) AssertMsgReturn(VALID_PTR(pv) || (pv) == NULL, ("%p\n", (pv)), rcRet)
2750
2751/** @def AssertPtrNullReturnVoid
2752 * Asserts that a pointer is valid or NULL.
2753 *
2754 * @param pv The pointer.
2755 */
2756#define AssertPtrNullReturnVoid(pv) AssertMsgReturnVoid(VALID_PTR(pv) || (pv) == NULL, ("%p\n", (pv)))
2757
2758/** @def AssertPtrNullBreak
2759 * Asserts that a pointer is valid or NULL.
2760 *
2761 * @param pv The pointer.
2762 */
2763#define AssertPtrNullBreak(pv) AssertMsgBreak(VALID_PTR(pv) || (pv) == NULL, ("%p\n", (pv)))
2764
2765/** @def AssertPtrNullBreakStmt
2766 * Asserts that a pointer is valid or NULL.
2767 *
2768 * @param pv The pointer.
2769 * @param stmt Statement to execute before break in case of a failed assertion.
2770 */
2771#define AssertPtrNullBreakStmt(pv, stmt) AssertMsgBreakStmt(VALID_PTR(pv) || (pv) == NULL, ("%p\n", (pv)), stmt)
2772
2773/** @def AssertGCPhys32
2774 * Asserts that the high dword of a physical address is zero
2775 *
2776 * @param GCPhys The address (RTGCPHYS).
2777 */
2778#define AssertGCPhys32(GCPhys) AssertMsg(VALID_PHYS32(GCPhys), ("%RGp\n", (RTGCPHYS)(GCPhys)))
2779
2780/** @def AssertGCPtr32
2781 * Asserts that the high dword of a physical address is zero
2782 *
2783 * @param GCPtr The address (RTGCPTR).
2784 */
2785#if GC_ARCH_BITS == 32
2786# define AssertGCPtr32(GCPtr) do { } while (0)
2787#else
2788# define AssertGCPtr32(GCPtr) AssertMsg(!((GCPtr) & UINT64_C(0xffffffff00000000)), ("%RGv\n", GCPtr))
2789#endif
2790
2791/** @def AssertForEach
2792 * Equivalent to Assert for each value of the variable from the starting
2793 * value to the finishing one.
2794 *
2795 * @param var Name of the counter variable.
2796 * @param vartype Type of the counter variable.
2797 * @param first Lowest inclusive value of the counter variable.
2798 * This must be free from side effects.
2799 * @param end Highest exclusive value of the counter variable.
2800 * This must be free from side effects.
2801 * @param expr Expression which should be true for each value of @a var.
2802 */
2803#define AssertForEach(var, vartype, first, end, expr) \
2804 do { \
2805 vartype var; \
2806 Assert((first) == (first) && (end) == (end)); /* partial check for side effects */ \
2807 for (var = (first); var < (end); var++) \
2808 AssertMsg(expr, ("%s = %#RX64 (%RI64)", #var, (uint64_t)var, (int64_t)var)); \
2809 } while (0)
2810
2811/** @} */
2812
2813/** @} */
2814
2815#endif
2816
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette