VirtualBox

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

Last change on this file since 14949 was 14500, checked in by vboxsync, 16 years ago

IPRT/SUPDrv/VMM: Made RTR0AssertPanicSystem available to VMMR0.r0 on darwin & solaris (only platforms implemting it currently). Created RTAssertMsg1, RTAssertMsg2 and RTAssertMsg2V (darwin only atm) in addition to AssertMsg1/2 and delcared the latter two as weak and overridable by users, while the former are strong and exposed by SUPDrv. This way we can get the full assertion text in the 'Problem Report for Mac OS X Kernel' thing. Will propagte the changes to the other platforms and rings later.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 65.4 KB
Line 
1/** @file
2 * IPRT - Assertions.
3 */
4
5/*
6 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
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 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26 * Clara, CA 95054 USA or visit http://www.sun.com if you need
27 * additional information or have any questions.
28 */
29
30#ifndef ___iprt_assert_h
31#define ___iprt_assert_h
32
33#include <iprt/cdefs.h>
34#include <iprt/types.h>
35#include <iprt/stdarg.h>
36
37/** @defgroup grp_rt_assert Assert - Assertions
38 * @ingroup grp_rt
39 *
40 * Assertions are generally used to check precoditions and other
41 * assumptions. Sometimes it is also used to catch odd errors or errors
42 * that one would like to inspect in the debugger. They should not be
43 * used for errors that happen frequently.
44 *
45 * IPRT provides a host of assertion macros, so many that it can be a bit
46 * overwhelming at first. Don't despair, there is a system (surprise).
47 *
48 * First there are four families of assertions:
49 * - Assert - The normal strict build only assertions.
50 * - AssertLogRel - Calls LogRel() in non-strict builds, otherwise like Assert.
51 * - AssertRelease - Triggers in all builds.
52 * - AssertFatal - Triggers in all builds and cannot be continued.
53 *
54 * Then there are variations wrt to argument list and behavior on failure:
55 * - Msg - Custom RTStrPrintf-like message with the assertion message.
56 * - Return - Return the specific rc on failure.
57 * - ReturnVoid - Return (void) on failure.
58 * - Break - Break (out of switch/loop) on failure.
59 * - Stmt - Execute the specified statment(s) on failure.
60 * - RC - Assert RT_SUCCESS.
61 * - RCSuccess - Assert VINF_SUCCESS.
62 *
63 * In additions there is a very special familiy AssertCompile that can be
64 * used for some limited compile checking. Like structure sizes and member
65 * alignment. This family doesn't have the same variations.
66 *
67 *
68 * @remarks As you might've noticed, the macros doesn't follow the
69 * coding guidelines wrt to macros supposedly being all uppercase
70 * and underscored. For various reasons they don't, and it nobody
71 * has complained yet. Wonder why... :-)
72 *
73 * @remarks Each project has its own specific guidelines on how to use
74 * assertions, so the above is just trying to give you the general idea
75 * from the IPRT point of view.
76 *
77 * @{
78 */
79
80__BEGIN_DECLS
81
82/**
83 * The 1st part of an assert message.
84 *
85 * @param pszExpr Expression. Can be NULL.
86 * @param uLine Location line number.
87 * @param pszFile Location file name.
88 * @param pszFunction Location function name.
89 */
90RTDECL(void) RTAssertMsg1(const char *pszExpr, unsigned uLine, const char *pszFile, const char *pszFunction);
91/**
92 * Weak version of RTAssertMsg1
93 *
94 * @copydoc RTAssertMsg1
95 * @todo rename to AssertMsg1Weak
96 */
97RTDECL(void) AssertMsg1(const char *pszExpr, unsigned uLine, const char *pszFile, const char *pszFunction);
98
99/**
100 * The 2nd (optional) part of an assert message.
101 *
102 * @param pszFormat Printf like format string.
103 * @param va Arguments to that string.
104 */
105RTDECL(void) RTAssertMsg2V(const char *pszFormat, va_list va);
106
107/**
108 * The 2nd (optional) part of an assert message.
109 *
110 * @param pszFormat Printf like format string.
111 * @param ... Arguments to that string.
112 */
113RTDECL(void) RTAssertMsg2(const char *pszFormat, ...);
114/** Weak version of RTAssertMsg2
115 * @copydoc RTAssertMsg2
116 * @todo rename to AssertMsg2Weak
117 */
118RTDECL(void) AssertMsg2(const char *pszFormat, ...);
119
120#ifdef IN_RING0
121/**
122 * Panics the system as the result of a fail assertion.
123 */
124RTR0DECL(void) RTR0AssertPanicSystem(void);
125#endif /* IN_RING0 */
126
127/**
128 * Overridable function that decides whether assertions executes the panic
129 * (breakpoint) or not.
130 *
131 * The generic implementation will return true.
132 *
133 * @returns true if the breakpoint should be hit, false if it should be ignored.
134 *
135 * @remark The RTDECL() makes this a bit difficult to override on Windows. So,
136 * you'll have ot use RTASSERT_HAVE_SHOULD_PANIC or
137 * RTASSERT_HAVE_SHOULD_PANIC_PRIVATE there to control the kind of
138 * prototype.
139 */
140#if !defined(RTASSERT_HAVE_SHOULD_PANIC) && !defined(RTASSERT_HAVE_SHOULD_PANIC_PRIVATE)
141RTDECL(bool) RTAssertShouldPanic(void);
142#elif defined(RTASSERT_HAVE_SHOULD_PANIC_PRIVATE)
143bool RTAssertShouldPanic(void);
144#else
145DECLEXPORT(bool) RTCALL RTAssertShouldPanic(void);
146#endif
147
148/** @name Globals for crash analysis
149 * @remarks This is the full potential set, it
150 * @{
151 */
152/** The last assert message, 1st part. */
153extern RTDATADECL(char) g_szRTAssertMsg1[1024];
154/** The last assert message, 2nd part. */
155extern RTDATADECL(char) g_szRTAssertMsg2[2048];
156/** The last assert message, expression. */
157extern RTDATADECL(const char * volatile) g_pszRTAssertExpr;
158/** The last assert message, file name. */
159extern RTDATADECL(const char * volatile) g_pszRTAssertFile;
160/** The last assert message, line number. */
161extern RTDATADECL(uint32_t volatile) g_u32RTAssertLine;
162/** The last assert message, function name. */
163extern RTDATADECL(const char * volatile) g_pszRTAssertFunction;
164/** @} */
165
166__END_DECLS
167
168/** @def RTAssertDebugBreak()
169 * Debugger breakpoint instruction.
170 *
171 * @remarks In the gnu world we add a nop instruction after the int3 to
172 * force gdb to remain at the int3 source line.
173 * @remarks The L4 kernel will try make sense of the breakpoint, thus the jmp.
174 * @remarks This macro does not depend on RT_STRICT.
175 */
176#ifdef __GNUC__
177# ifndef __L4ENV__
178# define RTAssertDebugBreak() do { __asm__ __volatile__ ("int3\n\tnop"); } while (0)
179# else
180# define RTAssertDebugBreak() do { __asm__ __volatile__ ("int3; jmp 1f; 1:"); } while (0)
181# endif
182#elif defined(_MSC_VER) || defined(DOXYGEN_RUNNING)
183# define RTAssertDebugBreak() do { __debugbreak(); } while (0)
184#else
185# error "Unknown compiler"
186#endif
187
188
189
190/** @name Compile time assertions.
191 *
192 * These assertions are used to check structure sizes, memember/size alignments
193 * and similar compile time expressions.
194 *
195 * @{
196 */
197
198/**
199 * RTASSERTTYPE is the type the AssertCompile() macro redefines.
200 * It has no other function and shouldn't be used.
201 * Visual C++ uses this.
202 */
203typedef int RTASSERTTYPE[1];
204
205/**
206 * RTASSERTVAR is the type the AssertCompile() macro redefines.
207 * It has no other function and shouldn't be used.
208 * GCC uses this.
209 */
210#ifdef __GNUC__
211__BEGIN_DECLS
212#endif
213extern int RTASSERTVAR[1];
214#ifdef __GNUC__
215__END_DECLS
216#endif
217
218/** @def AssertCompile
219 * Asserts that a compile-time expression is true. If it's not break the build.
220 * @param expr Expression which should be true.
221 */
222#ifdef __GNUC__
223# define AssertCompile(expr) extern int RTASSERTVAR[1] __attribute__((unused)), RTASSERTVAR[(expr) ? 1 : 0] __attribute__((unused))
224#else
225# define AssertCompile(expr) typedef int RTASSERTTYPE[(expr) ? 1 : 0]
226#endif
227
228/** @def AssertCompileSize
229 * Asserts a size at compile.
230 * @param type The type.
231 * @param size The expected type size.
232 */
233#define AssertCompileSize(type, size) \
234 AssertCompile(sizeof(type) == (size))
235
236/** @def AssertCompileSizeAlignment
237 * Asserts a size alignment at compile.
238 * @param type The type.
239 * @param align The size alignment to assert.
240 */
241#define AssertCompileSizeAlignment(type, align) \
242 AssertCompile(!(sizeof(type) & ((align) - 1)))
243
244/** @def AssertCompileMemberSize
245 * Asserts a member offset alignment at compile.
246 * @param type The type.
247 * @param member The member.
248 * @param size The member size to assert.
249 */
250#define AssertCompileMemberSize(type, member, size) \
251 AssertCompile(RT_SIZEOFMEMB(type, member) == (size))
252
253/** @def AssertCompileMemberSizeAlignment
254 * Asserts a member size alignment at compile.
255 * @param type The type.
256 * @param member The member.
257 * @param align The member size alignment to assert.
258 */
259#define AssertCompileMemberSizeAlignment(type, member, align) \
260 AssertCompile(!(RT_SIZEOFMEMB(type, member) & ((align) - 1)))
261
262/** @def AssertCompileMemberAlignment
263 * Asserts a member offset alignment at compile.
264 * @param type The type.
265 * @param member The member.
266 * @param align The member offset alignment to assert.
267 */
268#if defined(__GNUC__) && defined(__cplusplus)
269# if __GNUC__ >= 4
270# define AssertCompileMemberAlignment(type, member, align) \
271 AssertCompile(!(__builtin_offsetof(type, member) & ((align) - 1)))
272# else
273# define AssertCompileMemberAlignment(type, member, align) \
274 AssertCompile(!(RT_OFFSETOF(type, member) & ((align) - 1)))
275# endif
276#else
277# define AssertCompileMemberAlignment(type, member, align) \
278 AssertCompile(!(RT_OFFSETOF(type, member) & ((align) - 1)))
279#endif
280
281/** @def AssertCompileMemberOffset
282 * Asserts a offset of a structure member at compile.
283 * @param type The type.
284 * @param member The member.
285 * @param off The expected offset.
286 */
287#if defined(__GNUC__) && defined(__cplusplus)
288# if __GNUC__ >= 4
289# define AssertCompileMemberOffset(type, member, off) \
290 AssertCompile(__builtin_offsetof(type, member) == (off))
291# else
292# define AssertCompileMemberOffset(type, member, off) \
293 AssertCompile(RT_OFFSETOF(type, member) == (off))
294# endif
295#else
296# define AssertCompileMemberOffset(type, member, off) \
297 AssertCompile(RT_OFFSETOF(type, member) == (off))
298#endif
299
300/** @} */
301
302
303
304/** @name Assertions
305 *
306 * These assertions will only trigger when RT_STRICT is defined. When it is
307 * undefined they will all be noops and generate no code.
308 *
309 * @{
310 */
311
312/** @def RTAssertDoPanic
313 * Raises an assertion panic appropriate to the current context.
314 * @remarks This macro does not depend on RT_STRICT.
315 */
316#if defined(IN_RING0) \
317 && (defined(RT_OS_DARWIN) || defined(RT_OS_SOLARIS))
318# define RTAssertDoPanic() RTR0AssertPanicSystem()
319#else
320# define RTAssertDoPanic() RTAssertDebugBreak()
321#endif
322
323/** @def AssertBreakpoint()
324 * Assertion Breakpoint.
325 * @deprecated Use RTAssertPanic or RTAssertDebugBreak instead.
326 */
327#ifdef RT_STRICT
328# define AssertBreakpoint() RTAssertDebugBreak()
329#else
330# define AssertBreakpoint() do { } while (0)
331#endif
332
333/** @def rtAssertPanic()
334 * If RT_STRICT is defined this macro will invoke RTAssertDoPanic if
335 * RTAssertShouldPanic returns true. If RT_STRICT isn't defined it won't do any
336 * thing.
337 */
338#ifdef RT_STRICT
339# define RTAssertPanic() do { if (RTAssertShouldPanic()) RTAssertDoPanic(); } while (0)
340#else
341# define RTAssertPanic() do { } while (0)
342#endif
343
344/** @def Assert
345 * Assert that an expression is true. If it's not hit breakpoint.
346 * @param expr Expression which should be true.
347 */
348#ifdef RT_STRICT
349# define Assert(expr) \
350 do { \
351 if (RT_UNLIKELY(!(expr))) \
352 { \
353 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
354 RTAssertPanic(); \
355 } \
356 } while (0)
357#else
358# define Assert(expr) do { } while (0)
359#endif
360
361
362/** @def AssertReturn
363 * Assert that an expression is true and returns if it isn't.
364 * In RT_STRICT mode it will hit a breakpoint before returning.
365 *
366 * @param expr Expression which should be true.
367 * @param rc What is to be presented to return.
368 */
369#ifdef RT_STRICT
370# define AssertReturn(expr, rc) \
371 do { \
372 if (RT_UNLIKELY(!(expr))) \
373 { \
374 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
375 RTAssertPanic(); \
376 return (rc); \
377 } \
378 } while (0)
379#else
380# define AssertReturn(expr, rc) \
381 do { \
382 if (RT_UNLIKELY(!(expr))) \
383 return (rc); \
384 } while (0)
385#endif
386
387/** @def AssertReturnVoid
388 * Assert that an expression is true and returns if it isn't.
389 * In RT_STRICT mode it will hit a breakpoint before returning.
390 *
391 * @param expr Expression which should be true.
392 */
393#ifdef RT_STRICT
394# define AssertReturnVoid(expr) \
395 do { \
396 if (RT_UNLIKELY(!(expr))) \
397 { \
398 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
399 RTAssertPanic(); \
400 return; \
401 } \
402 } while (0)
403#else
404# define AssertReturnVoid(expr) \
405 do { \
406 if (RT_UNLIKELY(!(expr))) \
407 return; \
408 } while (0)
409#endif
410
411
412/** @def AssertBreak
413 * Assert that an expression is true and breaks if it isn't.
414 * In RT_STRICT mode it will hit a breakpoint before returning.
415 *
416 * @param expr Expression which should be true.
417 */
418#ifdef RT_STRICT
419# define AssertBreak(expr) \
420 if (RT_UNLIKELY(!(expr))) \
421 { \
422 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
423 RTAssertPanic(); \
424 break; \
425 } else do {} while (0)
426#else
427# define AssertBreak(expr) \
428 if (RT_UNLIKELY(!(expr))) \
429 break; \
430 else do {} while (0)
431#endif
432
433/** @def AssertBreakStmt
434 * Assert that an expression is true and breaks if it isn't.
435 * In RT_STRICT mode it will hit a breakpoint before doing break.
436 *
437 * @param expr Expression which should be true.
438 * @param stmt Statement to execute before break in case of a failed assertion.
439 */
440#ifdef RT_STRICT
441# define AssertBreakStmt(expr, stmt) \
442 if (RT_UNLIKELY(!(expr))) { \
443 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
444 RTAssertPanic(); \
445 stmt; \
446 break; \
447 } else do {} while (0)
448#else
449# define AssertBreakStmt(expr, stmt) \
450 if (RT_UNLIKELY(!(expr))) { \
451 stmt; \
452 break; \
453 } else do {} while (0)
454#endif
455
456
457/** @def AssertMsg
458 * Assert that an expression is true. If it's not print message and hit breakpoint.
459 * @param expr Expression which should be true.
460 * @param a printf argument list (in parenthesis).
461 */
462#ifdef RT_STRICT
463# define AssertMsg(expr, a) \
464 do { \
465 if (RT_UNLIKELY(!(expr))) \
466 { \
467 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
468 AssertMsg2 a; \
469 RTAssertPanic(); \
470 } \
471 } while (0)
472#else
473# define AssertMsg(expr, a) do { } while (0)
474#endif
475
476/** @def AssertMsgReturn
477 * Assert that an expression is true and returns if it isn't.
478 * In RT_STRICT mode it will hit a breakpoint before returning.
479 *
480 * @param expr Expression which should be true.
481 * @param a printf argument list (in parenthesis).
482 * @param rc What is to be presented to return.
483 */
484#ifdef RT_STRICT
485# define AssertMsgReturn(expr, a, rc) \
486 do { \
487 if (RT_UNLIKELY(!(expr))) \
488 { \
489 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
490 AssertMsg2 a; \
491 RTAssertPanic(); \
492 return (rc); \
493 } \
494 } while (0)
495#else
496# define AssertMsgReturn(expr, a, rc) \
497 do { \
498 if (RT_UNLIKELY(!(expr))) \
499 return (rc); \
500 } while (0)
501#endif
502
503/** @def AssertMsgReturnVoid
504 * Assert that an expression is true and returns if it isn't.
505 * In RT_STRICT mode it will hit a breakpoint before returning.
506 *
507 * @param expr Expression which should be true.
508 * @param a printf argument list (in parenthesis).
509 */
510#ifdef RT_STRICT
511# define AssertMsgReturnVoid(expr, a) \
512 do { \
513 if (RT_UNLIKELY(!(expr))) \
514 { \
515 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
516 AssertMsg2 a; \
517 RTAssertPanic(); \
518 return; \
519 } \
520 } while (0)
521#else
522# define AssertMsgReturnVoid(expr, a) \
523 do { \
524 if (RT_UNLIKELY(!(expr))) \
525 return; \
526 } while (0)
527#endif
528
529
530/** @def AssertMsgBreak
531 * Assert that an expression is true and breaks if it isn't.
532 * In RT_STRICT mode it will hit a breakpoint before returning.
533 *
534 * @param expr Expression which should be true.
535 * @param a printf argument list (in parenthesis).
536 */
537#ifdef RT_STRICT
538# define AssertMsgBreak(expr, a) \
539 if (RT_UNLIKELY(!(expr))) \
540 { \
541 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
542 AssertMsg2 a; \
543 RTAssertPanic(); \
544 break; \
545 } else do {} while (0)
546#else
547# define AssertMsgBreak(expr, a) \
548 if (RT_UNLIKELY(!(expr))) \
549 break; \
550 else do {} while (0)
551#endif
552
553/** @def AssertMsgBreakStmt
554 * Assert that an expression is true and breaks if it isn't.
555 * In RT_STRICT mode it will hit a breakpoint before doing break.
556 *
557 * @param expr Expression which should be true.
558 * @param a printf argument list (in parenthesis).
559 * @param stmt Statement to execute before break in case of a failed assertion.
560 */
561#ifdef RT_STRICT
562# define AssertMsgBreakStmt(expr, a, stmt) \
563 if (RT_UNLIKELY(!(expr))) { \
564 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
565 AssertMsg2 a; \
566 RTAssertPanic(); \
567 stmt; \
568 break; \
569 } else do {} while (0)
570#else
571# define AssertMsgBreakStmt(expr, a, stmt) \
572 if (RT_UNLIKELY(!(expr))) { \
573 stmt; \
574 break; \
575 } else do {} while (0)
576#endif
577
578/** @def AssertFailed
579 * An assertion failed hit breakpoint.
580 */
581#ifdef RT_STRICT
582# define AssertFailed() \
583 do { \
584 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
585 RTAssertPanic(); \
586 } while (0)
587#else
588# define AssertFailed() do { } while (0)
589#endif
590
591/** @def AssertFailedReturn
592 * An assertion failed, hit breakpoint (RT_STRICT mode only) and return.
593 *
594 * @param rc The rc to return.
595 */
596#ifdef RT_STRICT
597# define AssertFailedReturn(rc) \
598 do { \
599 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
600 RTAssertPanic(); \
601 return (rc); \
602 } while (0)
603#else
604# define AssertFailedReturn(rc) \
605 do { \
606 return (rc); \
607 } while (0)
608#endif
609
610/** @def AssertFailedReturnVoid
611 * An assertion failed, hit breakpoint (RT_STRICT mode only) and return.
612 */
613#ifdef RT_STRICT
614# define AssertFailedReturnVoid() \
615 do { \
616 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
617 RTAssertPanic(); \
618 return; \
619 } while (0)
620#else
621# define AssertFailedReturnVoid() \
622 do { \
623 return; \
624 } while (0)
625#endif
626
627
628/** @def AssertFailedBreak
629 * An assertion failed, hit breakpoint (RT_STRICT mode only) and break.
630 */
631#ifdef RT_STRICT
632# define AssertFailedBreak() \
633 if (1) { \
634 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
635 RTAssertPanic(); \
636 break; \
637 } else do {} while (0)
638#else
639# define AssertFailedBreak() \
640 if (1) \
641 break; \
642 else do {} while (0)
643#endif
644
645/** @def AssertFailedBreakStmt
646 * An assertion failed, hit breakpoint (RT_STRICT mode only), execute
647 * the given statement and break.
648 *
649 * @param stmt Statement to execute before break.
650 */
651#ifdef RT_STRICT
652# define AssertFailedBreakStmt(stmt) \
653 if (1) { \
654 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
655 RTAssertPanic(); \
656 stmt; \
657 break; \
658 } else do {} while (0)
659#else
660# define AssertFailedBreakStmt(stmt) \
661 if (1) { \
662 stmt; \
663 break; \
664 } else do {} while (0)
665#endif
666
667
668/** @def AssertMsgFailed
669 * An assertion failed print a message and a hit breakpoint.
670 *
671 * @param a printf argument list (in parenthesis).
672 */
673#ifdef RT_STRICT
674# define AssertMsgFailed(a) \
675 do { \
676 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
677 AssertMsg2 a; \
678 RTAssertPanic(); \
679 } while (0)
680#else
681# define AssertMsgFailed(a) do { } while (0)
682#endif
683
684/** @def AssertMsgFailedReturn
685 * An assertion failed, hit breakpoint with message (RT_STRICT mode only) and return.
686 *
687 * @param a printf argument list (in parenthesis).
688 * @param rc What is to be presented to return.
689 */
690#ifdef RT_STRICT
691# define AssertMsgFailedReturn(a, rc) \
692 do { \
693 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
694 AssertMsg2 a; \
695 RTAssertPanic(); \
696 return (rc); \
697 } while (0)
698#else
699# define AssertMsgFailedReturn(a, rc) \
700 do { \
701 return (rc); \
702 } while (0)
703#endif
704
705/** @def AssertMsgFailedReturnVoid
706 * An assertion failed, hit breakpoint with message (RT_STRICT mode only) and return.
707 *
708 * @param a printf argument list (in parenthesis).
709 */
710#ifdef RT_STRICT
711# define AssertMsgFailedReturnVoid(a) \
712 do { \
713 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
714 AssertMsg2 a; \
715 RTAssertPanic(); \
716 return; \
717 } while (0)
718#else
719# define AssertMsgFailedReturnVoid(a) \
720 do { \
721 return; \
722 } while (0)
723#endif
724
725
726/** @def AssertMsgFailedBreak
727 * An assertion failed, hit breakpoint with message (RT_STRICT mode only) and break.
728 *
729 * @param a printf argument list (in parenthesis).
730 */
731#ifdef RT_STRICT
732# define AssertMsgFailedBreak(a) \
733 if (1) { \
734 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
735 AssertMsg2 a; \
736 RTAssertPanic(); \
737 break; \
738 } else do {} while (0)
739#else
740# define AssertMsgFailedBreak(a) \
741 if (1) \
742 break; \
743 else do {} while (0)
744#endif
745
746/** @def AssertMsgFailedBreakStmt
747 * An assertion failed, hit breakpoint (RT_STRICT mode only), execute
748 * the given statement and break.
749 *
750 * @param a printf argument list (in parenthesis).
751 * @param stmt Statement to execute before break.
752 */
753#ifdef RT_STRICT
754# define AssertMsgFailedBreakStmt(a, stmt) \
755 if (1) { \
756 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
757 AssertMsg2 a; \
758 RTAssertPanic(); \
759 stmt; \
760 break; \
761 } else do {} while (0)
762#else
763# define AssertMsgFailedBreakStmt(a, stmt) \
764 if (1) { \
765 stmt; \
766 break; \
767 } else do {} while (0)
768#endif
769
770/** @} */
771
772
773
774/** @name Release Log Assertions
775 *
776 * These assertions will work like normal strict assertion when RT_STRICT is
777 * defined and LogRel statements when RT_STRICT is undefined. Typically used for
778 * things which shouldn't go wrong, but when it does you'd like to know one way
779 * or ther other.
780 *
781 * @{
782 */
783
784/** @def RTAssertLogRelMsg1
785 * AssertMsg1 (strict builds) / LogRel wrapper (non-strict).
786 */
787#ifdef RT_STRICT
788# define RTAssertLogRelMsg1(pszExpr, iLine, pszFile, pszFunction) \
789 AssertMsg1(pszExpr, iLine, pszFile, pszFunction)
790#else
791# define RTAssertLogRelMsg1(pszExpr, iLine, pszFile, pszFunction) \
792 LogRel(("AssertLogRel %s(%d) %s: %s\n",\
793 (pszFile), (iLine), (pszFunction), (pszExpr) ))
794#endif
795
796/** @def RTAssertLogRelMsg2
797 * AssertMsg2 (strict builds) / LogRel wrapper (non-strict).
798 */
799#ifdef RT_STRICT
800# define RTAssertLogRelMsg2(a) AssertMsg2 a
801#else
802# define RTAssertLogRelMsg2(a) LogRel(a)
803#endif
804
805/** @def AssertLogRel
806 * Assert that an expression is true.
807 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
808 *
809 * @param expr Expression which should be true.
810 */
811#define AssertLogRel(expr) \
812 do { \
813 if (RT_UNLIKELY(!(expr))) \
814 { \
815 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
816 RTAssertPanic(); \
817 } \
818 } while (0)
819
820/** @def AssertLogRelReturn
821 * Assert that an expression is true, return \a rc if it isn't.
822 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
823 *
824 * @param expr Expression which should be true.
825 * @param rc What is to be presented to return.
826 */
827#define AssertLogRelReturn(expr, rc) \
828 do { \
829 if (RT_UNLIKELY(!(expr))) \
830 { \
831 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
832 RTAssertPanic(); \
833 return (rc); \
834 } \
835 } while (0)
836
837/** @def AssertLogRelReturnVoid
838 * Assert that an expression is true, return void if it isn't.
839 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
840 *
841 * @param expr Expression which should be true.
842 */
843#define AssertLogRelReturnVoid(expr) \
844 do { \
845 if (RT_UNLIKELY(!(expr))) \
846 { \
847 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
848 RTAssertPanic(); \
849 return; \
850 } \
851 } while (0)
852
853/** @def AssertLogRelBreak
854 * Assert that an expression is true, break if it isn't.
855 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
856 *
857 * @param expr Expression which should be true.
858 */
859#define AssertLogRelBreak(expr) \
860 if (RT_UNLIKELY(!(expr))) \
861 { \
862 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
863 RTAssertPanic(); \
864 break; \
865 } \
866 else do {} while (0)
867
868/** @def AssertLogRelBreakStmt
869 * Assert that an expression is true, execute \a stmt and break if it isn't.
870 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
871 *
872 * @param expr Expression which should be true.
873 * @param stmt Statement to execute before break in case of a failed assertion.
874 */
875#define AssertLogRelBreakStmt(expr, stmt) \
876 if (RT_UNLIKELY(!(expr))) \
877 { \
878 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
879 RTAssertPanic(); \
880 stmt; \
881 break; \
882 } else do {} while (0)
883
884/** @def AssertLogRelMsg
885 * Assert that an expression is true.
886 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
887 *
888 * @param expr Expression which should be true.
889 * @param a printf argument list (in parenthesis).
890 */
891#define AssertLogRelMsg(expr, a) \
892 do { \
893 if (RT_UNLIKELY(!(expr))) \
894 { \
895 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
896 RTAssertLogRelMsg2(a); \
897 RTAssertPanic(); \
898 } \
899 } while (0)
900
901/** @def AssertLogRelMsgReturn
902 * Assert that an expression is true, return \a rc if it isn't.
903 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
904 *
905 * @param expr Expression which should be true.
906 * @param a printf argument list (in parenthesis).
907 * @param rc What is to be presented to return.
908 */
909#define AssertLogRelMsgReturn(expr, a, rc) \
910 do { \
911 if (RT_UNLIKELY(!(expr))) \
912 { \
913 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
914 RTAssertLogRelMsg2(a); \
915 RTAssertPanic(); \
916 return (rc); \
917 } \
918 } while (0)
919
920/** @def AssertLogRelMsgReturnVoid
921 * Assert that an expression is true, return (void) if it isn't.
922 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
923 *
924 * @param expr Expression which should be true.
925 * @param a printf argument list (in parenthesis).
926 */
927#define AssertLogRelMsgReturnVoid(expr, a) \
928 do { \
929 if (RT_UNLIKELY(!(expr))) \
930 { \
931 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
932 RTAssertLogRelMsg2(a); \
933 RTAssertPanic(); \
934 return; \
935 } \
936 } while (0)
937
938/** @def AssertLogRelMsgBreak
939 * Assert that an expression is true, break if it isn't.
940 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
941 *
942 * @param expr Expression which should be true.
943 * @param a printf argument list (in parenthesis).
944 */
945#define AssertLogRelMsgBreak(expr, a) \
946 if (RT_UNLIKELY(!(expr))) \
947 { \
948 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
949 RTAssertLogRelMsg2(a); \
950 RTAssertPanic(); \
951 break; \
952 } \
953 else do {} while (0)
954
955/** @def AssertLogRelMsgBreakStmt
956 * Assert that an expression is true, execute \a stmt and break if it isn't.
957 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
958 *
959 * @param expr Expression which should be true.
960 * @param a printf argument list (in parenthesis).
961 * @param stmt Statement to execute before break in case of a failed assertion.
962 */
963#define AssertLogRelMsgBreakStmt(expr, a, stmt) \
964 if (RT_UNLIKELY(!(expr))) \
965 { \
966 RTAssertLogRelMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
967 RTAssertLogRelMsg2(a); \
968 RTAssertPanic(); \
969 stmt; \
970 break; \
971 } else do {} while (0)
972
973/** @def AssertLogRelFailed
974 * An assertion failed.
975 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
976 */
977#define AssertLogRelFailed() \
978 do { \
979 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
980 RTAssertPanic(); \
981 } while (0)
982
983/** @def AssertLogRelFailedReturn
984 * An assertion failed.
985 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
986 *
987 * @param rc What is to be presented to return.
988 */
989#define AssertLogRelFailedReturn(rc) \
990 do { \
991 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
992 RTAssertPanic(); \
993 return (rc); \
994 } while (0)
995
996/** @def AssertLogRelFailedReturnVoid
997 * An assertion failed, hit a breakpoint and return.
998 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
999 */
1000#define AssertLogRelFailedReturnVoid() \
1001 do { \
1002 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1003 RTAssertPanic(); \
1004 return; \
1005 } while (0)
1006
1007/** @def AssertLogRelFailedBreak
1008 * An assertion failed, break.
1009 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1010 */
1011#define AssertLogRelFailedBreak() \
1012 if (1) \
1013 { \
1014 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1015 RTAssertPanic(); \
1016 break; \
1017 } else do {} while (0)
1018
1019/** @def AssertLogRelFailedBreakStmt
1020 * An assertion failed, execute \a stmt and break.
1021 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1022 *
1023 * @param stmt Statement to execute before break.
1024 */
1025#define AssertLogRelFailedBreakStmt(stmt) \
1026 if (1) \
1027 { \
1028 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1029 RTAssertPanic(); \
1030 stmt; \
1031 break; \
1032 } else do {} while (0)
1033
1034/** @def AssertLogRelMsgFailed
1035 * An assertion failed.
1036 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1037 *
1038 * @param a printf argument list (in parenthesis).
1039 */
1040#define AssertLogRelMsgFailed(a) \
1041 do { \
1042 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1043 RTAssertLogRelMsg2(a); \
1044 RTAssertPanic(); \
1045 } while (0)
1046
1047/** @def AssertLogRelMsgFailedReturn
1048 * An assertion failed, return \a rc.
1049 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1050 *
1051 * @param a printf argument list (in parenthesis).
1052 * @param rc What is to be presented to return.
1053 */
1054#define AssertLogRelMsgFailedReturn(a, rc) \
1055 do { \
1056 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1057 RTAssertLogRelMsg2(a); \
1058 RTAssertPanic(); \
1059 return (rc); \
1060 } while (0)
1061
1062/** @def AssertLogRelMsgFailedReturnVoid
1063 * An assertion failed, return void.
1064 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1065 *
1066 * @param a printf argument list (in parenthesis).
1067 */
1068#define AssertLogRelMsgFailedReturnVoid(a) \
1069 do { \
1070 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1071 RTAssertLogRelMsg2(a); \
1072 RTAssertPanic(); \
1073 return; \
1074 } while (0)
1075
1076/** @def AssertLogRelMsgFailedBreak
1077 * An assertion failed, break.
1078 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1079 *
1080 * @param a printf argument list (in parenthesis).
1081 */
1082#define AssertLogRelMsgFailedBreak(a) \
1083 if (1)\
1084 { \
1085 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1086 RTAssertLogRelMsg2(a); \
1087 RTAssertPanic(); \
1088 break; \
1089 } else do {} while (0)
1090
1091/** @def AssertLogRelMsgFailedBreakStmt
1092 * An assertion failed, execute \a stmt and break.
1093 * Strict builds will hit a breakpoint, non-strict will only do LogRel.
1094 *
1095 * @param a printf argument list (in parenthesis).
1096 * @param stmt Statement to execute before break.
1097 */
1098#define AssertLogRelMsgFailedBreakStmt(a, stmt) \
1099 if (1) \
1100 { \
1101 RTAssertLogRelMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1102 RTAssertLogRelMsg2(a); \
1103 RTAssertPanic(); \
1104 stmt; \
1105 break; \
1106 } else do {} while (0)
1107
1108/** @} */
1109
1110
1111
1112/** @name Release Asserions
1113 *
1114 * These assertions are always enabled.
1115 * @{
1116 */
1117
1118/** @def RTAssertReleasePanic()
1119 * Invokes RTAssertShouldPanic and RTAssertDoPanic.
1120 *
1121 * It might seem odd that RTAssertShouldPanic is necessary when its result isn't
1122 * checked, but it's done since RTAssertShouldPanic is overrideable and might be
1123 * used to bail out before taking down the system (the VMMR0 case).
1124 */
1125#define RTAssertReleasePanic() do { RTAssertShouldPanic(); RTAssertDoPanic(); } while (0)
1126
1127
1128/** @def AssertRelease
1129 * Assert that an expression is true. If it's not hit a breakpoint.
1130 *
1131 * @param expr Expression which should be true.
1132 */
1133#define AssertRelease(expr) \
1134 do { \
1135 if (RT_UNLIKELY(!(expr))) \
1136 { \
1137 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1138 RTAssertReleasePanic(); \
1139 } \
1140 } while (0)
1141
1142/** @def AssertReleaseReturn
1143 * Assert that an expression is true, hit a breakpoing and return if it isn't.
1144 *
1145 * @param expr Expression which should be true.
1146 * @param rc What is to be presented to return.
1147 */
1148#define AssertReleaseReturn(expr, rc) \
1149 do { \
1150 if (RT_UNLIKELY(!(expr))) \
1151 { \
1152 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1153 RTAssertReleasePanic(); \
1154 return (rc); \
1155 } \
1156 } while (0)
1157
1158/** @def AssertReleaseReturnVoid
1159 * Assert that an expression is true, hit a breakpoing and return if it isn't.
1160 *
1161 * @param expr Expression which should be true.
1162 */
1163#define AssertReleaseReturnVoid(expr) \
1164 do { \
1165 if (RT_UNLIKELY(!(expr))) \
1166 { \
1167 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1168 RTAssertReleasePanic(); \
1169 return; \
1170 } \
1171 } while (0)
1172
1173
1174/** @def AssertReleaseBreak
1175 * Assert that an expression is true, hit a breakpoing and break if it isn't.
1176 *
1177 * @param expr Expression which should be true.
1178 */
1179#define AssertReleaseBreak(expr) \
1180 if { \
1181 if (RT_UNLIKELY(!(expr))) \
1182 { \
1183 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1184 RTAssertReleasePanic(); \
1185 break; \
1186 } \
1187 } else do {} while (0)
1188
1189/** @def AssertReleaseBreakStmt
1190 * Assert that an expression is true, hit a breakpoing and break if it isn't.
1191 *
1192 * @param expr Expression which should be true.
1193 * @param stmt Statement to execute before break in case of a failed assertion.
1194 */
1195#define AssertReleaseBreakStmt(expr, stmt) \
1196 if (RT_UNLIKELY(!(expr))) \
1197 { \
1198 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1199 RTAssertReleasePanic(); \
1200 stmt; \
1201 break; \
1202 } else do {} while (0)
1203
1204
1205/** @def AssertReleaseMsg
1206 * Assert that an expression is true, print the message and hit a breakpoint if it isn't.
1207 *
1208 * @param expr Expression which should be true.
1209 * @param a printf argument list (in parenthesis).
1210 */
1211#define AssertReleaseMsg(expr, a) \
1212 do { \
1213 if (RT_UNLIKELY(!(expr))) \
1214 { \
1215 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1216 AssertMsg2 a; \
1217 RTAssertReleasePanic(); \
1218 } \
1219 } while (0)
1220
1221/** @def AssertReleaseMsgReturn
1222 * Assert that an expression is true, print the message and hit a breakpoint and return if it isn't.
1223 *
1224 * @param expr Expression which should be true.
1225 * @param a printf argument list (in parenthesis).
1226 * @param rc What is to be presented to return.
1227 */
1228#define AssertReleaseMsgReturn(expr, a, rc) \
1229 do { \
1230 if (RT_UNLIKELY(!(expr))) \
1231 { \
1232 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1233 AssertMsg2 a; \
1234 RTAssertReleasePanic(); \
1235 return (rc); \
1236 } \
1237 } while (0)
1238
1239/** @def AssertReleaseMsgReturnVoid
1240 * Assert that an expression is true, print the message and hit a breakpoint and return if it isn't.
1241 *
1242 * @param expr Expression which should be true.
1243 * @param a printf argument list (in parenthesis).
1244 */
1245#define AssertReleaseMsgReturnVoid(expr, a) \
1246 do { \
1247 if (RT_UNLIKELY(!(expr))) \
1248 { \
1249 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1250 AssertMsg2 a; \
1251 RTAssertReleasePanic(); \
1252 return; \
1253 } \
1254 } while (0)
1255
1256
1257/** @def AssertReleaseMsgBreak
1258 * Assert that an expression is true, print the message and hit a breakpoint and break if it isn't.
1259 *
1260 * @param expr Expression which should be true.
1261 * @param a printf argument list (in parenthesis).
1262 */
1263#define AssertReleaseMsgBreak(expr, a) \
1264 if (RT_UNLIKELY(!(expr))) \
1265 { \
1266 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1267 AssertMsg2 a; \
1268 RTAssertReleasePanic(); \
1269 break; \
1270 } else do {} while (0)
1271
1272/** @def AssertReleaseMsgBreakStmt
1273 * Assert that an expression is true, print the message and hit a breakpoing and break if it isn't.
1274 *
1275 * @param expr Expression which should be true.
1276 * @param a printf argument list (in parenthesis).
1277 * @param stmt Statement to execute before break in case of a failed assertion.
1278 */
1279#define AssertReleaseMsgBreakStmt(expr, a, stmt) \
1280 if (RT_UNLIKELY(!(expr))) { \
1281 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1282 AssertMsg2 a; \
1283 RTAssertReleasePanic(); \
1284 stmt; \
1285 break; \
1286 } else do {} while (0)
1287
1288
1289/** @def AssertReleaseFailed
1290 * An assertion failed, hit a breakpoint.
1291 */
1292#define AssertReleaseFailed() \
1293 do { \
1294 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1295 RTAssertReleasePanic(); \
1296 } while (0)
1297
1298/** @def AssertReleaseFailedReturn
1299 * An assertion failed, hit a breakpoint and return.
1300 *
1301 * @param rc What is to be presented to return.
1302 */
1303#define AssertReleaseFailedReturn(rc) \
1304 do { \
1305 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1306 RTAssertReleasePanic(); \
1307 return (rc); \
1308 } while (0)
1309
1310/** @def AssertReleaseFailedReturnVoid
1311 * An assertion failed, hit a breakpoint and return.
1312 */
1313#define AssertReleaseFailedReturnVoid() \
1314 do { \
1315 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1316 RTAssertReleasePanic(); \
1317 return; \
1318 } while (0)
1319
1320
1321/** @def AssertReleaseFailedBreak
1322 * An assertion failed, hit a breakpoint and break.
1323 */
1324#define AssertReleaseFailedBreak() \
1325 if (1) { \
1326 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1327 RTAssertReleasePanic(); \
1328 break; \
1329 } else do {} while (0)
1330
1331/** @def AssertReleaseFailedBreakStmt
1332 * An assertion failed, hit a breakpoint and break.
1333 *
1334 * @param stmt Statement to execute before break.
1335 */
1336#define AssertReleaseFailedBreakStmt(stmt) \
1337 if (1) { \
1338 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1339 RTAssertReleasePanic(); \
1340 stmt; \
1341 break; \
1342 } else do {} while (0)
1343
1344
1345/** @def AssertReleaseMsgFailed
1346 * An assertion failed, print a message and hit a breakpoint.
1347 *
1348 * @param a printf argument list (in parenthesis).
1349 */
1350#define AssertReleaseMsgFailed(a) \
1351 do { \
1352 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1353 AssertMsg2 a; \
1354 RTAssertReleasePanic(); \
1355 } while (0)
1356
1357/** @def AssertReleaseMsgFailedReturn
1358 * An assertion failed, print a message, hit a breakpoint and return.
1359 *
1360 * @param a printf argument list (in parenthesis).
1361 * @param rc What is to be presented to return.
1362 */
1363#define AssertReleaseMsgFailedReturn(a, rc) \
1364 do { \
1365 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1366 AssertMsg2 a; \
1367 RTAssertReleasePanic(); \
1368 return (rc); \
1369 } while (0)
1370
1371/** @def AssertReleaseMsgFailedReturnVoid
1372 * An assertion failed, print a message, hit a breakpoint and return.
1373 *
1374 * @param a printf argument list (in parenthesis).
1375 */
1376#define AssertReleaseMsgFailedReturnVoid(a) \
1377 do { \
1378 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1379 AssertMsg2 a; \
1380 RTAssertReleasePanic(); \
1381 return; \
1382 } while (0)
1383
1384
1385/** @def AssertReleaseMsgFailedBreak
1386 * An assertion failed, print a message, hit a breakpoint and break.
1387 *
1388 * @param a printf argument list (in parenthesis).
1389 */
1390#define AssertReleaseMsgFailedBreak(a) \
1391 if (1) { \
1392 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1393 AssertMsg2 a; \
1394 RTAssertReleasePanic(); \
1395 break; \
1396 } else do {} while (0)
1397
1398/** @def AssertReleaseMsgFailedBreakStmt
1399 * An assertion failed, print a message, hit a breakpoint and break.
1400 *
1401 * @param a printf argument list (in parenthesis).
1402 * @param stmt Statement to execute before break.
1403 */
1404#define AssertReleaseMsgFailedBreakStmt(a, stmt) \
1405 if (1) { \
1406 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1407 AssertMsg2 a; \
1408 RTAssertReleasePanic(); \
1409 stmt; \
1410 break; \
1411 } else do {} while (0)
1412
1413/** @} */
1414
1415
1416
1417/** @name Fatal Assertions
1418 * These are similar to release assertions except that you cannot ignore them in
1419 * any way, they will loop for ever if RTAssertDoPanic returns.
1420 *
1421 * @{
1422 */
1423
1424/** @def AssertFatal
1425 * Assert that an expression is true. If it's not hit a breakpoint (for ever).
1426 *
1427 * @param expr Expression which should be true.
1428 */
1429#define AssertFatal(expr) \
1430 do { \
1431 if (RT_UNLIKELY(!(expr))) \
1432 for (;;) \
1433 { \
1434 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1435 RTAssertReleasePanic(); \
1436 } \
1437 } while (0)
1438
1439/** @def AssertFatalMsg
1440 * Assert that an expression is true, print the message and hit a breakpoint (for ever) if it isn't.
1441 *
1442 * @param expr Expression which should be true.
1443 * @param a printf argument list (in parenthesis).
1444 */
1445#define AssertFatalMsg(expr, a) \
1446 do { \
1447 if (RT_UNLIKELY(!(expr))) \
1448 for (;;) \
1449 { \
1450 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1451 AssertMsg2 a; \
1452 RTAssertReleasePanic(); \
1453 } \
1454 } while (0)
1455
1456/** @def AssertFatalFailed
1457 * An assertion failed, hit a breakpoint (for ever).
1458 */
1459#define AssertFatalFailed() \
1460 do { \
1461 for (;;) \
1462 { \
1463 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1464 RTAssertReleasePanic(); \
1465 } \
1466 } while (0)
1467
1468/** @def AssertFatalMsgFailed
1469 * An assertion failed, print a message and hit a breakpoint (for ever).
1470 *
1471 * @param a printf argument list (in parenthesis).
1472 */
1473#define AssertFatalMsgFailed(a) \
1474 do { \
1475 for (;;) \
1476 { \
1477 AssertMsg1((const char *)0, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
1478 AssertMsg2 a; \
1479 RTAssertReleasePanic(); \
1480 } \
1481 } while (0)
1482
1483/** @} */
1484
1485
1486
1487/** @name Convenience Assertions Macros
1488 * @{
1489 */
1490
1491/** @def AssertRC
1492 * Asserts a iprt status code successful.
1493 *
1494 * On failure it will print info about the rc and hit a breakpoint.
1495 *
1496 * @param rc iprt status code.
1497 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1498 */
1499#define AssertRC(rc) AssertMsgRC(rc, ("%Rra\n", (rc)))
1500
1501/** @def AssertRCReturn
1502 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and return if it isn't.
1503 *
1504 * @param rc iprt status code.
1505 * @param rcRet What is to be presented to return.
1506 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1507 */
1508#define AssertRCReturn(rc, rcRet) AssertMsgRCReturn(rc, ("%Rra\n", (rc)), rcRet)
1509
1510/** @def AssertRCReturnVoid
1511 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and return if it isn't.
1512 *
1513 * @param rc iprt status code.
1514 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1515 */
1516#define AssertRCReturnVoid(rc) AssertMsgRCReturnVoid(rc, ("%Rra\n", (rc)))
1517
1518/** @def AssertRCBreak
1519 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and break if it isn't.
1520 *
1521 * @param rc iprt status code.
1522 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1523 */
1524#define AssertRCBreak(rc) AssertMsgRCBreak(rc, ("%Rra\n", (rc)))
1525
1526/** @def AssertRCBreakStmt
1527 * Asserts a iprt status code successful, bitch (RT_STRICT mode only) and break if it isn't.
1528 *
1529 * @param rc iprt status code.
1530 * @param stmt Statement to execute before break in case of a failed assertion.
1531 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1532 */
1533#define AssertRCBreakStmt(rc, stmt) AssertMsgRCBreakStmt(rc, ("%Rra\n", (rc)), stmt)
1534
1535/** @def AssertMsgRC
1536 * Asserts a iprt status code successful.
1537 *
1538 * It prints a custom message and hits a breakpoint on FAILURE.
1539 *
1540 * @param rc iprt status code.
1541 * @param msg printf argument list (in parenthesis).
1542 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1543 */
1544#define AssertMsgRC(rc, msg) \
1545 do { AssertMsg(RT_SUCCESS_NP(rc), msg); NOREF(rc); } while (0)
1546
1547/** @def AssertMsgRCReturn
1548 * Asserts a iprt status code successful and if it's not return the specified status code.
1549 *
1550 * If RT_STRICT is defined the message will be printed and a breakpoint hit before it returns
1551 *
1552 * @param rc iprt status code.
1553 * @param msg printf argument list (in parenthesis).
1554 * @param rcRet What is to be presented to return.
1555 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1556 */
1557#define AssertMsgRCReturn(rc, msg, rcRet) \
1558 do { AssertMsgReturn(RT_SUCCESS_NP(rc), msg, rcRet); NOREF(rc); } while (0)
1559
1560/** @def AssertMsgRCReturnVoid
1561 * Asserts a iprt status code successful and if it's not return.
1562 *
1563 * If RT_STRICT is defined the message will be printed and a breakpoint hit before it returns
1564 *
1565 * @param rc iprt status code.
1566 * @param msg printf argument list (in parenthesis).
1567 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1568 */
1569#define AssertMsgRCReturnVoid(rc, msg) \
1570 do { AssertMsgReturnVoid(RT_SUCCESS_NP(rc), msg); NOREF(rc); } while (0)
1571
1572/** @def AssertMsgRCBreak
1573 * Asserts a iprt status code successful and if it's not break.
1574 *
1575 * If RT_STRICT is defined the message will be printed and a breakpoint hit before it breaks
1576 *
1577 * @param rc iprt status code.
1578 * @param msg printf argument list (in parenthesis).
1579 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1580 */
1581#define AssertMsgRCBreak(rc, msg) \
1582 if (1) { AssertMsgBreak(RT_SUCCESS(rc), msg); NOREF(rc); } else do {} while (0)
1583
1584/** @def AssertMsgRCBreakStmt
1585 * Asserts a iprt status code successful and break if it's not.
1586 *
1587 * If RT_STRICT is defined the message will be printed and a breakpoint hit before it returns
1588 *
1589 * @param rc iprt status code.
1590 * @param msg printf argument list (in parenthesis).
1591 * @param stmt Statement to execute before break in case of a failed assertion.
1592 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1593 */
1594#define AssertMsgRCBreakStmt(rc, msg, stmt) \
1595 if (1) { AssertMsgBreakStmt(RT_SUCCESS_NP(rc), msg, stmt); NOREF(rc); } else do {} while (0)
1596
1597/** @def AssertRCSuccess
1598 * Asserts an iprt status code equals VINF_SUCCESS.
1599 *
1600 * On failure it will print info about the rc and hit a breakpoint.
1601 *
1602 * @param rc iprt status code.
1603 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1604 */
1605#define AssertRCSuccess(rc) AssertMsg((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
1606
1607/** @def AssertRCSuccessReturn
1608 * Asserts that an iprt status code equals VINF_SUCCESS, bitch (RT_STRICT mode only) and return if it isn't.
1609 *
1610 * @param rc iprt status code.
1611 * @param rcRet What is to be presented to return.
1612 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1613 */
1614#define AssertRCSuccessReturn(rc, rcRet) AssertMsgReturn((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), rcRet)
1615
1616/** @def AssertRCSuccessReturnVoid
1617 * Asserts that an iprt status code equals VINF_SUCCESS, bitch (RT_STRICT mode only) and return if it isn't.
1618 *
1619 * @param rc iprt status code.
1620 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1621 */
1622#define AssertRCSuccessReturnVoid(rc) AssertMsgReturnVoid((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
1623
1624/** @def AssertRCSuccessBreak
1625 * Asserts that an iprt status code equals VINF_SUCCESS, bitch (RT_STRICT mode only) and break if it isn't.
1626 *
1627 * @param rc iprt status code.
1628 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1629 */
1630#define AssertRCSuccessBreak(rc) AssertMsgBreak((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
1631
1632/** @def AssertRCSuccessBreakStmt
1633 * Asserts that an iprt status code equals VINF_SUCCESS, bitch (RT_STRICT mode only) and break if it isn't.
1634 *
1635 * @param rc iprt status code.
1636 * @param stmt Statement to execute before break in case of a failed assertion.
1637 * @remark rc is references multiple times. In release mode is NOREF()'ed.
1638 */
1639#define AssertRCSuccessBreakStmt(rc, stmt) AssertMsgBreakStmt((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), stmt)
1640
1641
1642/** @def AssertLogRelRC
1643 * Asserts a iprt status code successful.
1644 *
1645 * @param rc iprt status code.
1646 * @remark rc is references multiple times.
1647 */
1648#define AssertLogRelRC(rc) AssertLogRelMsgRC(rc, ("%Rra\n", (rc)))
1649
1650/** @def AssertLogRelRCReturn
1651 * Asserts a iprt status code successful, returning \a rc if it isn't.
1652 *
1653 * @param rc iprt status code.
1654 * @param rcRet What is to be presented to return.
1655 * @remark rc is references multiple times.
1656 */
1657#define AssertLogRelRCReturn(rc, rcRet) AssertLogRelMsgRCReturn(rc, ("%Rra\n", (rc)), rcRet)
1658
1659/** @def AssertLogRelRCReturnVoid
1660 * Asserts a iprt status code successful, returning (void) if it isn't.
1661 *
1662 * @param rc iprt status code.
1663 * @remark rc is references multiple times.
1664 */
1665#define AssertLogRelRCReturnVoid(rc) AssertLogRelMsgRCReturnVoid(rc, ("%Rra\n", (rc)))
1666
1667/** @def AssertLogRelRCBreak
1668 * Asserts a iprt status code successful, breaking if it isn't.
1669 *
1670 * @param rc iprt status code.
1671 * @remark rc is references multiple times.
1672 */
1673#define AssertLogRelRCBreak(rc) AssertLogRelMsgRCBreak(rc, ("%Rra\n", (rc)))
1674
1675/** @def AssertLogRelRCBreakStmt
1676 * Asserts a iprt status code successful, execute \a statement and break if it isn't.
1677 *
1678 * @param rc iprt status code.
1679 * @param stmt Statement to execute before break in case of a failed assertion.
1680 * @remark rc is references multiple times.
1681 */
1682#define AssertLogRelRCBreakStmt(rc, stmt) AssertLogRelMsgRCBreakStmt(rc, ("%Rra\n", (rc)), stmt)
1683
1684/** @def AssertLogRelMsgRC
1685 * Asserts a iprt status code successful.
1686 *
1687 * @param rc iprt status code.
1688 * @param msg printf argument list (in parenthesis).
1689 * @remark rc is references multiple times.
1690 */
1691#define AssertLogRelMsgRC(rc, msg) AssertLogRelMsg(RT_SUCCESS_NP(rc), msg)
1692
1693/** @def AssertLogRelMsgRCReturn
1694 * Asserts a iprt status code successful.
1695 *
1696 * @param rc iprt status code.
1697 * @param msg printf argument list (in parenthesis).
1698 * @param rcRet What is to be presented to return.
1699 * @remark rc is references multiple times.
1700 */
1701#define AssertLogRelMsgRCReturn(rc, msg, rcRet) AssertLogRelMsgReturn(RT_SUCCESS_NP(rc), msg, rcRet)
1702
1703/** @def AssertLogRelMsgRCReturnVoid
1704 * Asserts a iprt status code successful.
1705 *
1706 * @param rc iprt status code.
1707 * @param msg printf argument list (in parenthesis).
1708 * @remark rc is references multiple times.
1709 */
1710#define AssertLogRelMsgRCReturnVoid(rc, msg) AssertLogRelMsgReturnVoid(RT_SUCCESS_NP(rc), msg)
1711
1712/** @def AssertLogRelMsgRCBreak
1713 * Asserts a iprt status code successful.
1714 *
1715 * @param rc iprt status code.
1716 * @param msg printf argument list (in parenthesis).
1717 * @remark rc is references multiple times.
1718 */
1719#define AssertLogRelMsgRCBreak(rc, msg) AssertLogRelMsgBreak(RT_SUCCESS(rc), msg)
1720
1721/** @def AssertLogRelMsgRCBreakStmt
1722 * Asserts a iprt status code successful, execute \a stmt and break if it isn't.
1723 *
1724 * @param rc iprt status code.
1725 * @param msg printf argument list (in parenthesis).
1726 * @param stmt Statement to execute before break in case of a failed assertion.
1727 * @remark rc is references multiple times.
1728 */
1729#define AssertLogRelMsgRCBreakStmt(rc, msg, stmt) AssertLogRelMsgBreakStmt(RT_SUCCESS_NP(rc), msg, stmt)
1730
1731/** @def AssertLogRelRCSuccess
1732 * Asserts that an iprt status code equals VINF_SUCCESS.
1733 *
1734 * @param rc iprt status code.
1735 * @remark rc is references multiple times.
1736 */
1737#define AssertLogRelRCSuccess(rc) AssertLogRelMsg((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
1738
1739/** @def AssertLogRelRCSuccessReturn
1740 * Asserts that an iprt status code equals VINF_SUCCESS.
1741 *
1742 * @param rc iprt status code.
1743 * @param rcRet What is to be presented to return.
1744 * @remark rc is references multiple times.
1745 */
1746#define AssertLogRelRCSuccessReturn(rc, rcRet) AssertLogRelMsgReturn((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), rcRet)
1747
1748/** @def AssertLogRelRCSuccessReturnVoid
1749 * Asserts that an iprt status code equals VINF_SUCCESS.
1750 *
1751 * @param rc iprt status code.
1752 * @remark rc is references multiple times.
1753 */
1754#define AssertLogRelRCSuccessReturnVoid(rc) AssertLogRelMsgReturnVoid((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
1755
1756/** @def AssertLogRelRCSuccessBreak
1757 * Asserts that an iprt status code equals VINF_SUCCESS.
1758 *
1759 * @param rc iprt status code.
1760 * @remark rc is references multiple times.
1761 */
1762#define AssertLogRelRCSuccessBreak(rc) AssertLogRelMsgBreak((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
1763
1764/** @def AssertLogRelRCSuccessBreakStmt
1765 * Asserts that an iprt status code equals VINF_SUCCESS.
1766 *
1767 * @param rc iprt status code.
1768 * @param stmt Statement to execute before break in case of a failed assertion.
1769 * @remark rc is references multiple times.
1770 */
1771#define AssertLogRelRCSuccessBreakStmt(rc, stmt) AssertLogRelMsgBreakStmt((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), stmt)
1772
1773
1774/** @def AssertReleaseRC
1775 * Asserts a iprt status code successful.
1776 *
1777 * On failure information about the error will be printed and a breakpoint hit.
1778 *
1779 * @param rc iprt status code.
1780 * @remark rc is references multiple times.
1781 */
1782#define AssertReleaseRC(rc) AssertReleaseMsgRC(rc, ("%Rra\n", (rc)))
1783
1784/** @def AssertReleaseRCReturn
1785 * Asserts a iprt status code successful, returning if it isn't.
1786 *
1787 * On failure information about the error will be printed, a breakpoint hit
1788 * and finally returning from the function if the breakpoint is somehow ignored.
1789 *
1790 * @param rc iprt status code.
1791 * @param rcRet What is to be presented to return.
1792 * @remark rc is references multiple times.
1793 */
1794#define AssertReleaseRCReturn(rc, rcRet) AssertReleaseMsgRCReturn(rc, ("%Rra\n", (rc)), rcRet)
1795
1796/** @def AssertReleaseRCReturnVoid
1797 * Asserts a iprt status code successful, returning if it isn't.
1798 *
1799 * On failure information about the error will be printed, a breakpoint hit
1800 * and finally returning from the function if the breakpoint is somehow ignored.
1801 *
1802 * @param rc iprt status code.
1803 * @remark rc is references multiple times.
1804 */
1805#define AssertReleaseRCReturnVoid(rc) AssertReleaseMsgRCReturnVoid(rc, ("%Rra\n", (rc)))
1806
1807/** @def AssertReleaseRCBreak
1808 * Asserts a iprt status code successful, breaking if it isn't.
1809 *
1810 * On failure information about the error will be printed, a breakpoint hit
1811 * and finally breaking the current statement if the breakpoint is somehow ignored.
1812 *
1813 * @param rc iprt status code.
1814 * @remark rc is references multiple times.
1815 */
1816#define AssertReleaseRCBreak(rc) AssertReleaseMsgRCBreak(rc, ("%Rra\n", (rc)))
1817
1818/** @def AssertReleaseRCBreakStmt
1819 * Asserts a iprt status code successful, break if it isn't.
1820 *
1821 * On failure information about the error will be printed, a breakpoint hit
1822 * and finally the break statement will be issued if the breakpoint is somehow ignored.
1823 *
1824 * @param rc iprt status code.
1825 * @param stmt Statement to execute before break in case of a failed assertion.
1826 * @remark rc is references multiple times.
1827 */
1828#define AssertReleaseRCBreakStmt(rc, stmt) AssertReleaseMsgRCBreakStmt(rc, ("%Rra\n", (rc)), stmt)
1829
1830/** @def AssertReleaseMsgRC
1831 * Asserts a iprt status code successful.
1832 *
1833 * On failure a custom message is printed and a breakpoint is hit.
1834 *
1835 * @param rc iprt status code.
1836 * @param msg printf argument list (in parenthesis).
1837 * @remark rc is references multiple times.
1838 */
1839#define AssertReleaseMsgRC(rc, msg) AssertReleaseMsg(RT_SUCCESS_NP(rc), msg)
1840
1841/** @def AssertReleaseMsgRCReturn
1842 * Asserts a iprt status code successful.
1843 *
1844 * On failure a custom message is printed, a breakpoint is hit, and finally
1845 * returning from the function if the breakpoint is showhow ignored.
1846 *
1847 * @param rc iprt status code.
1848 * @param msg printf argument list (in parenthesis).
1849 * @param rcRet What is to be presented to return.
1850 * @remark rc is references multiple times.
1851 */
1852#define AssertReleaseMsgRCReturn(rc, msg, rcRet) AssertReleaseMsgReturn(RT_SUCCESS_NP(rc), msg, rcRet)
1853
1854/** @def AssertReleaseMsgRCReturnVoid
1855 * Asserts a iprt status code successful.
1856 *
1857 * On failure a custom message is printed, a breakpoint is hit, and finally
1858 * returning from the function if the breakpoint is showhow ignored.
1859 *
1860 * @param rc iprt status code.
1861 * @param msg printf argument list (in parenthesis).
1862 * @remark rc is references multiple times.
1863 */
1864#define AssertReleaseMsgRCReturnVoid(rc, msg) AssertReleaseMsgReturnVoid(RT_SUCCESS_NP(rc), msg)
1865
1866/** @def AssertReleaseMsgRCBreak
1867 * Asserts a iprt status code successful.
1868 *
1869 * On failure a custom message is printed, a breakpoint is hit, and finally
1870 * breaking the current status if the breakpoint is showhow ignored.
1871 *
1872 * @param rc iprt status code.
1873 * @param msg printf argument list (in parenthesis).
1874 * @remark rc is references multiple times.
1875 */
1876#define AssertReleaseMsgRCBreak(rc, msg) AssertReleaseMsgBreak(RT_SUCCESS(rc), msg)
1877
1878/** @def AssertReleaseMsgRCBreakStmt
1879 * Asserts a iprt status code successful.
1880 *
1881 * On failure a custom message is printed, a breakpoint is hit, and finally
1882 * the brean statement is issued if the breakpoint is showhow ignored.
1883 *
1884 * @param rc iprt status code.
1885 * @param msg printf argument list (in parenthesis).
1886 * @param stmt Statement to execute before break in case of a failed assertion.
1887 * @remark rc is references multiple times.
1888 */
1889#define AssertReleaseMsgRCBreakStmt(rc, msg, stmt) AssertReleaseMsgBreakStmt(RT_SUCCESS_NP(rc), msg, stmt)
1890
1891/** @def AssertReleaseRCSuccess
1892 * Asserts that an iprt status code equals VINF_SUCCESS.
1893 *
1894 * On failure information about the error will be printed and a breakpoint hit.
1895 *
1896 * @param rc iprt status code.
1897 * @remark rc is references multiple times.
1898 */
1899#define AssertReleaseRCSuccess(rc) AssertReleaseMsg((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
1900
1901/** @def AssertReleaseRCSuccessReturn
1902 * Asserts that an iprt status code equals VINF_SUCCESS.
1903 *
1904 * On failure information about the error will be printed, a breakpoint hit
1905 * and finally returning from the function if the breakpoint is somehow ignored.
1906 *
1907 * @param rc iprt status code.
1908 * @param rcRet What is to be presented to return.
1909 * @remark rc is references multiple times.
1910 */
1911#define AssertReleaseRCSuccessReturn(rc, rcRet) AssertReleaseMsgReturn((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), rcRet)
1912
1913/** @def AssertReleaseRCSuccessReturnVoid
1914 * Asserts that an iprt status code equals VINF_SUCCESS.
1915 *
1916 * On failure information about the error will be printed, a breakpoint hit
1917 * and finally returning from the function if the breakpoint is somehow ignored.
1918 *
1919 * @param rc iprt status code.
1920 * @remark rc is references multiple times.
1921 */
1922#define AssertReleaseRCSuccessReturnVoid(rc) AssertReleaseMsgReturnVoid((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
1923
1924/** @def AssertReleaseRCSuccessBreak
1925 * Asserts that an iprt status code equals VINF_SUCCESS.
1926 *
1927 * On failure information about the error will be printed, a breakpoint hit
1928 * and finally breaking the current statement if the breakpoint is somehow ignored.
1929 *
1930 * @param rc iprt status code.
1931 * @remark rc is references multiple times.
1932 */
1933#define AssertReleaseRCSuccessBreak(rc) AssertReleaseMsgBreak((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
1934
1935/** @def AssertReleaseRCSuccessBreakStmt
1936 * Asserts that an iprt status code equals VINF_SUCCESS.
1937 *
1938 * On failure information about the error will be printed, a breakpoint hit
1939 * and finally the break statement will be issued if the breakpoint is somehow ignored.
1940 *
1941 * @param rc iprt status code.
1942 * @param stmt Statement to execute before break in case of a failed assertion.
1943 * @remark rc is references multiple times.
1944 */
1945#define AssertReleaseRCSuccessBreakStmt(rc, stmt) AssertReleaseMsgBreakStmt((rc) == VINF_SUCCESS, ("%Rra\n", (rc)), stmt)
1946
1947
1948/** @def AssertFatalRC
1949 * Asserts a iprt status code successful.
1950 *
1951 * On failure information about the error will be printed and a breakpoint hit.
1952 *
1953 * @param rc iprt status code.
1954 * @remark rc is references multiple times.
1955 */
1956#define AssertFatalRC(rc) AssertFatalMsgRC(rc, ("%Rra\n", (rc)))
1957
1958/** @def AssertReleaseMsgRC
1959 * Asserts a iprt status code successful.
1960 *
1961 * On failure a custom message is printed and a breakpoint is hit.
1962 *
1963 * @param rc iprt status code.
1964 * @param msg printf argument list (in parenthesis).
1965 * @remark rc is references multiple times.
1966 */
1967#define AssertFatalMsgRC(rc, msg) AssertFatalMsg(RT_SUCCESS_NP(rc), msg)
1968
1969/** @def AssertFatalRCSuccess
1970 * Asserts that an iprt status code equals VINF_SUCCESS.
1971 *
1972 * On failure information about the error will be printed and a breakpoint hit.
1973 *
1974 * @param rc iprt status code.
1975 * @remark rc is references multiple times.
1976 */
1977#define AssertFatalRCSuccess(rc) AssertFatalMsg((rc) == VINF_SUCCESS, ("%Rra\n", (rc)))
1978
1979
1980/** @def AssertPtr
1981 * Asserts that a pointer is valid.
1982 *
1983 * @param pv The pointer.
1984 */
1985#define AssertPtr(pv) AssertMsg(VALID_PTR(pv), ("%p\n", (pv)))
1986
1987/** @def AssertPtrReturn
1988 * Asserts that a pointer is valid.
1989 *
1990 * @param pv The pointer.
1991 * @param rcRet What is to be presented to return.
1992 */
1993#define AssertPtrReturn(pv, rcRet) AssertMsgReturn(VALID_PTR(pv), ("%p\n", (pv)), rcRet)
1994
1995/** @def AssertPtrReturnVoid
1996 * Asserts that a pointer is valid.
1997 *
1998 * @param pv The pointer.
1999 */
2000#define AssertPtrReturnVoid(pv) AssertMsgReturnVoid(VALID_PTR(pv), ("%p\n", (pv)))
2001
2002/** @def AssertPtrBreak
2003 * Asserts that a pointer is valid.
2004 *
2005 * @param pv The pointer.
2006 */
2007#define AssertPtrBreak(pv) AssertMsgBreak(VALID_PTR(pv), ("%p\n", (pv)))
2008
2009/** @def AssertPtrBreakStmt
2010 * Asserts that a pointer is valid.
2011 *
2012 * @param pv The pointer.
2013 * @param stmt Statement to execute before break in case of a failed assertion.
2014 */
2015#define AssertPtrBreakStmt(pv, stmt) AssertMsgBreakStmt(VALID_PTR(pv), ("%p\n", (pv)), stmt)
2016
2017/** @def AssertPtrNull
2018 * Asserts that a pointer is valid or NULL.
2019 *
2020 * @param pv The pointer.
2021 */
2022#define AssertPtrNull(pv) AssertMsg(VALID_PTR(pv) || (pv) == NULL, ("%p\n", (pv)))
2023
2024/** @def AssertPtrNullReturn
2025 * Asserts that a pointer is valid or NULL.
2026 *
2027 * @param pv The pointer.
2028 * @param rcRet What is to be presented to return.
2029 */
2030#define AssertPtrNullReturn(pv, rcRet) AssertMsgReturn(VALID_PTR(pv) || (pv) == NULL, ("%p\n", (pv)), rcRet)
2031
2032/** @def AssertPtrNullReturnVoid
2033 * Asserts that a pointer is valid or NULL.
2034 *
2035 * @param pv The pointer.
2036 */
2037#define AssertPtrNullReturnVoid(pv) AssertMsgReturnVoid(VALID_PTR(pv) || (pv) == NULL, ("%p\n", (pv)))
2038
2039/** @def AssertPtrNullBreak
2040 * Asserts that a pointer is valid or NULL.
2041 *
2042 * @param pv The pointer.
2043 */
2044#define AssertPtrNullBreak(pv) AssertMsgBreak(VALID_PTR(pv) || (pv) == NULL, ("%p\n", (pv)))
2045
2046/** @def AssertPtrNullBreakStmt
2047 * Asserts that a pointer is valid or NULL.
2048 *
2049 * @param pv The pointer.
2050 * @param stmt Statement to execute before break in case of a failed assertion.
2051 */
2052#define AssertPtrNullBreakStmt(pv, stmt) AssertMsgBreakStmt(VALID_PTR(pv) || (pv) == NULL, ("%p\n", (pv)), stmt)
2053
2054/** @def AssertGCPhys32
2055 * Asserts that the high dword of a physical address is zero
2056 *
2057 * @param GCPhys The address (RTGCPHYS).
2058 */
2059#define AssertGCPhys32(GCPhys) AssertMsg(VALID_PHYS32(GCPhys), ("%RGp\n", (RTGCPHYS)(GCPhys)))
2060
2061/** @def AssertGCPtr32
2062 * Asserts that the high dword of a physical address is zero
2063 *
2064 * @param GCPtr The address (RTGCPTR).
2065 */
2066#if GC_ARCH_BITS == 32
2067# define AssertGCPtr32(GCPtr) do { } while (0)
2068#else
2069# define AssertGCPtr32(GCPtr) AssertMsg(!((GCPtr) & UINT64_C(0xffffffff00000000)), ("%RGv\n", GCPtr))
2070#endif
2071
2072/** @} */
2073
2074/** @} */
2075
2076#endif
2077
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
ContactPrivacy policyTerms of Use