2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * FILE: include/reactos/debug.h
5 * PURPOSE: Useful debugging macros
6 * PROGRAMMERS: David Welch (welch@mcmail.com)
7 * Hermes Belusca-Maito (hermes.belusca@sfr.fr)
11 * NOTE: Define NDEBUG before including this header
12 * to disable debugging macros.
19 /* Define DbgPrint/DbgPrintEx/RtlAssert unless the NDK is used */
20 #if !defined(_RTLFUNCS_H) && !defined(_NTDDK_)
22 /* Make sure we have basic types (some people include us *before* SDK)... */
23 #if !defined(_NTDEF_) && !defined(_NTDEF_H) && !defined(_WINDEF_) && !defined(_WINDEF_H)
24 #error Please include SDK first.
34 _In_z_ _Printf_format_string_ PCSTR Format
,
42 _In_ ULONG ComponentId
,
44 _In_z_ _Printf_format_string_ PCSTR Format
,
53 _In_ PVOID FailedAssertion
,
55 _In_ ULONG LineNumber
,
56 _In_opt_z_ PCHAR Message
63 #endif /* !defined(_RTLFUNCS_H) && !defined(_NTDDK_) */
66 #if DBG && !defined(NASSERT)
67 #define assert(x) if (!(x)) { RtlAssert((PVOID)#x, (PVOID)__RELFILE__, __LINE__, ""); }
69 #define assert(x) ((VOID) 0)
74 #if DBG && !defined(NASSERT)
75 #define ASSERT(x) if (!(x)) { RtlAssert((PVOID)#x, (PVOID)__RELFILE__, __LINE__, ""); }
77 #define ASSERT(x) ((VOID) 0)
82 #if DBG && !defined(NASSERT)
83 #define ASSERTMSG(m, x) if (!(x)) { RtlAssert((PVOID)#x, __RELFILE__, __LINE__, m); }
85 #define ASSERTMSG(m, x) ((VOID) 0)
89 /* For internal purposes only */
90 #define __NOTICE(level, fmt, ...) DbgPrint(#level ": %s at %s:%d " fmt, __FUNCTION__, __RELFILE__, __LINE__, ##__VA_ARGS__)
92 /* Print stuff only on Debug Builds*/
93 #define DPFLTR_DEFAULT_ID -1
96 /* These are always printed */
97 #define DPRINT1(fmt, ...) do { \
98 if (DbgPrint("(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)) \
99 DbgPrint("(%s:%d) DbgPrint() failed!\n", __RELFILE__, __LINE__); \
102 /* These are printed only if NDEBUG is NOT defined */
105 #define DPRINT(fmt, ...) do { \
106 if (DbgPrint("(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)) \
107 DbgPrint("(%s:%d) DbgPrint() failed!\n", __RELFILE__, __LINE__); \
112 #if defined(_MSC_VER)
113 #define DPRINT __noop
115 #define DPRINT(...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
120 #define UNIMPLEMENTED __NOTICE(WARNING, "is UNIMPLEMENTED!\n");
122 #define ERR_(ch, fmt, ...) DbgPrintEx(DPFLTR_##ch##_ID, DPFLTR_ERROR_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
123 #define WARN_(ch, fmt, ...) DbgPrintEx(DPFLTR_##ch##_ID, DPFLTR_WARNING_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
124 #define TRACE_(ch, fmt, ...) DbgPrintEx(DPFLTR_##ch##_ID, DPFLTR_TRACE_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
125 #define INFO_(ch, fmt, ...) DbgPrintEx(DPFLTR_##ch##_ID, DPFLTR_INFO_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
127 #define ERR__(ch, fmt, ...) DbgPrintEx(ch, DPFLTR_ERROR_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
128 #define WARN__(ch, fmt, ...) DbgPrintEx(ch, DPFLTR_WARNING_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
129 #define TRACE__(ch, fmt, ...) DbgPrintEx(ch, DPFLTR_TRACE_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
130 #define INFO__(ch, fmt, ...) DbgPrintEx(ch, DPFLTR_INFO_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
134 /* On non-debug builds, we never show these */
135 #if defined(_MSC_VER)
136 #define DPRINT1 __noop
137 #define DPRINT __noop
139 #define UNIMPLEMENTED
143 #define TRACE_ __noop
147 #define WARN__ __noop
148 #define TRACE__ __noop
149 #define INFO__ __noop
151 #define DPRINT1(...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
152 #define DPRINT(...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
154 #define UNIMPLEMENTED
156 #define ERR_(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
157 #define WARN_(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
158 #define TRACE_(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
159 #define INFO_(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
161 #define ERR__(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
162 #define WARN__(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
163 #define TRACE__(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
164 #define INFO__(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
165 #endif /* _MSC_VER */
169 /******************************************************************************/
171 * Declare a target-dependent process termination procedure.
173 #ifndef _NTDDK_ /* User-Mode */
174 #ifndef NTOS_MODE_USER /* Should be Win32 */
176 #error "Unsupported target."
178 #define TerminateCurrentProcess(Status) TerminateProcess(GetCurrentProcess(), (Status))
186 IN HANDLE ProcessHandle
,
187 IN NTSTATUS ExitStatus
190 #ifndef NtCurrentProcess
191 #define NtCurrentProcess() ((HANDLE)(LONG_PTR)-1)
193 #define TerminateCurrentProcess(Status) NtTerminateProcess(NtCurrentProcess(), (Status))
195 #else /* Kernel-Mode */
196 #include <bugcodes.h>
197 #define TerminateCurrentProcess(Status) KeBugCheckEx(CRITICAL_SERVICE_FAILED, (Status), 0, 0, 0)
201 /* For internal purposes only */
202 #define __ERROR_DBGBREAK(...) \
204 DbgPrint("" __VA_ARGS__); \
208 /* For internal purposes only */
209 #define __ERROR_FATAL(Status, ...) \
211 DbgPrint("" __VA_ARGS__); \
213 TerminateCurrentProcess(Status); \
217 * These macros are designed to display an optional printf-like
218 * user-defined message and to break into the debugger.
219 * After that they allow to continue the program execution.
221 #define ERROR_DBGBREAK(...) \
223 __NOTICE(ERROR, "\n"); \
224 __ERROR_DBGBREAK(__VA_ARGS__); \
227 #define UNIMPLEMENTED_DBGBREAK(...) \
229 __NOTICE(ERROR, "is UNIMPLEMENTED!\n"); \
230 __ERROR_DBGBREAK(__VA_ARGS__); \
234 * These macros are designed to display an optional printf-like
235 * user-defined message and to break into the debugger.
236 * After that they halt the execution of the current thread.
238 #define ERROR_FATAL(...) \
240 __NOTICE(UNRECOVERABLE ERROR, "\n"); \
241 __ERROR_FATAL(STATUS_ASSERTION_FAILURE, __VA_ARGS__); \
244 #define UNIMPLEMENTED_FATAL(...) \
246 __NOTICE(UNRECOVERABLE ERROR, "is UNIMPLEMENTED!\n"); \
247 __ERROR_FATAL(STATUS_NOT_IMPLEMENTED, __VA_ARGS__); \
249 /******************************************************************************/
251 #define ASSERT_IRQL_LESS_OR_EQUAL(x) ASSERT(KeGetCurrentIrql()<=(x))
252 #define ASSERT_IRQL_EQUAL(x) ASSERT(KeGetCurrentIrql()==(x))
253 #define ASSERT_IRQL_LESS(x) ASSERT(KeGetCurrentIrql()<(x))
255 #define __STRING2__(x) #x
256 #define __STRING__(x) __STRING2__(x)
257 #define __STRLINE__ __STRING__(__LINE__)
259 #if !defined(_MSC_VER) && !defined(__pragma)
260 #define __pragma(x) _Pragma(#x)
263 #define _WARN(msg) __pragma(message("WARNING! Line " __STRLINE__ ": " msg))