2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * FILE: include/internal/debug.h
5 * PURPOSE: Useful debugging macros
6 * PROGRAMMER: David Welch (welch@mcmail.com)
12 * NOTE: Define NDEBUG before including this header to disable debugging
16 #ifndef __INTERNAL_DEBUG
17 #define __INTERNAL_DEBUG
19 /* FIXME: should probably remove this later */
20 #if !defined(CHECKED) && !defined(NDEBUG)
24 /* Define DbgPrint/RtlAssert unless the NDK is used */
25 #if !defined(_RTLFUNCS_H) && (!defined(_NTDDK_) || !defined(__NTDDK_H))
27 /* Make sure we have basic types (some people include us *before* SDK... */
28 #if defined(_NTDEF_) || (defined _WINDEF_) || (defined _WINDEF_H)
40 PVOID FailedAssertion
,
51 #define assert(x) if (!(x)) {RtlAssert("#x",__FILE__,__LINE__, ""); }
59 #define ASSERT(x) if (!(x)) {RtlAssert("#x",__FILE__,__LINE__, ""); }
67 #define ASSERTMSG(x,m) if (!(x)) {RtlAssert("#x",__FILE__,__LINE__, m); }
73 /* Print stuff only on Debug Builds*/
76 /* These are always printed */
77 #define DPRINT1 DbgPrint("(%s:%d) ",__FILE__,__LINE__), DbgPrint
78 #define CHECKPOINT1 do { DbgPrint("%s:%d\n",__FILE__,__LINE__); } while(0);
80 /* These are printed only if NDEBUG is NOT defined */
83 #define DPRINT DbgPrint("(%s:%d) ",__FILE__,__LINE__), DbgPrint
84 #define CHECKPOINT do { DbgPrint("%s:%d\n",__FILE__,__LINE__); } while(0);
88 static __inline
void DPRINT ( const char* fmt
, ... )
90 UNREFERENCED_PARAMETER(fmt
);
93 #define DPRINT(...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
98 #define UNIMPLEMENTED \
99 DbgPrint("WARNING: %s at %s:%d is UNIMPLEMENTED!\n",__FUNCTION__,__FILE__,__LINE__);
103 /* On non-debug builds, we never show these */
104 #define DPRINT1(...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
105 #define DPRINT(...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
109 #define UNIMPLEMENTED
113 * FUNCTION: Assert a maximum value for the current irql
117 #define ASSERT_IRQL(x) assert(KeGetCurrentIrql()<=(x))
118 #define assert_irql(x) assert(KeGetCurrentIrql()<=(x))
120 /* Macros expanding to the appropriate inline assembly to raise a breakpoint */
122 #define ASM_BREAKPOINT "\nint $3\n"
123 #elif defined(_M_ALPHA)
124 #define ASM_BREAKPOINT "\ncall_pal bpt\n"
125 #elif defined(_M_MIPS)
126 #define ASM_BREAKPOINT "\nbreak\n"
128 #define ASM_BREAKPOINT "\ntwi 1\n"
132 #define KEBUGCHECK(a) DbgPrint("KeBugCheck (0x%X) at %s:%i\n", a, __FILE__,__LINE__), KeBugCheck(a)
133 #define KEBUGCHECKEX(a,b,c,d,e) DbgPrint("KeBugCheckEx (0x%X, 0x%X, 0x%X, 0x%X, 0x%X) at %s:%i\n", a, b, c, d, e, __FILE__,__LINE__), KeBugCheckEx(a,b,c,d,e)
136 #endif /* __INTERNAL_DEBUG */