ReactOS  r76032
debug.h
Go to the documentation of this file.
1 /*
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)
8  */
9 
10 /*
11  * NOTE: Define NDEBUG before including this header
12  * to disable debugging macros.
13  */
14 
15 #pragma once
16 
17 #include <builddir.h>
18 
19 /* Define DbgPrint/DbgPrintEx/RtlAssert unless the NDK is used */
20 #if !defined(_RTLFUNCS_H) && !defined(_NTDDK_)
21 
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.
25 #endif
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 ULONG
32 __cdecl
33 DbgPrint(
35  ...
36 );
37 
39 ULONG
40 __cdecl
45  ...
46 );
47 
50 VOID
51 NTAPI
52 RtlAssert(
53  _In_ PVOID FailedAssertion,
57 );
58 
59 #ifdef __cplusplus
60 } /* extern "C" */
61 #endif
62 
63 #endif /* !defined(_RTLFUNCS_H) && !defined(_NTDDK_) */
64 
65 #ifndef assert
66 #if DBG && !defined(NASSERT)
67 #define assert(x) if (!(x)) { RtlAssert((PVOID)#x, (PVOID)__RELFILE__, __LINE__, ""); }
68 #else
69 #define assert(x) ((VOID) 0)
70 #endif
71 #endif
72 
73 #ifndef ASSERT
74 #if DBG && !defined(NASSERT)
75 #define ASSERT(x) if (!(x)) { RtlAssert((PVOID)#x, (PVOID)__RELFILE__, __LINE__, ""); }
76 #else
77 #define ASSERT(x) ((VOID) 0)
78 #endif
79 #endif
80 
81 #ifndef ASSERTMSG
82 #if DBG && !defined(NASSERT)
83 #define ASSERTMSG(m, x) if (!(x)) { RtlAssert((PVOID)#x, __RELFILE__, __LINE__, m); }
84 #else
85 #define ASSERTMSG(m, x) ((VOID) 0)
86 #endif
87 #endif
88 
89 /* For internal purposes only */
90 #define __NOTICE(level, fmt, ...) DbgPrint(#level ": %s at %s:%d " fmt, __FUNCTION__, __RELFILE__, __LINE__, ##__VA_ARGS__)
91 
92 /* Print stuff only on Debug Builds*/
93 #if DBG
94 
95  /* These are always printed */
96  #define DPRINT1(fmt, ...) do { \
97  if (DbgPrint("(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)) \
98  DbgPrint("(%s:%d) DbgPrint() failed!\n", __RELFILE__, __LINE__); \
99  } while (0)
100 
101  /* These are printed only if NDEBUG is NOT defined */
102  #ifndef NDEBUG
103 
104  #define DPRINT(fmt, ...) do { \
105  if (DbgPrint("(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)) \
106  DbgPrint("(%s:%d) DbgPrint() failed!\n", __RELFILE__, __LINE__); \
107  } while (0)
108 
109  #else
110 
111 #if defined(_MSC_VER)
112  #define DPRINT __noop
113 #else
114  #define DPRINT(...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
115 #endif
116 
117  #endif
118 
119  #define UNIMPLEMENTED __NOTICE(WARNING, "is UNIMPLEMENTED!\n")
120 
121  #define ERR_(ch, fmt, ...) DbgPrintEx(DPFLTR_##ch##_ID, DPFLTR_ERROR_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
122  #define WARN_(ch, fmt, ...) DbgPrintEx(DPFLTR_##ch##_ID, DPFLTR_WARNING_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
123  #define TRACE_(ch, fmt, ...) DbgPrintEx(DPFLTR_##ch##_ID, DPFLTR_TRACE_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
124  #define INFO_(ch, fmt, ...) DbgPrintEx(DPFLTR_##ch##_ID, DPFLTR_INFO_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
125 
126  #define ERR__(ch, fmt, ...) DbgPrintEx(ch, DPFLTR_ERROR_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
127  #define WARN__(ch, fmt, ...) DbgPrintEx(ch, DPFLTR_WARNING_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
128  #define TRACE__(ch, fmt, ...) DbgPrintEx(ch, DPFLTR_TRACE_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
129  #define INFO__(ch, fmt, ...) DbgPrintEx(ch, DPFLTR_INFO_LEVEL, "(%s:%d) " fmt, __RELFILE__, __LINE__, ##__VA_ARGS__)
130 
131 #else /* not DBG */
132 
133  /* On non-debug builds, we never show these */
134 #if defined(_MSC_VER)
135  #define DPRINT1 __noop
136  #define DPRINT __noop
137 
138  #define UNIMPLEMENTED
139 
140  #define ERR_(ch, ...) __noop
141  #define WARN_(ch, ...) __noop
142  #define TRACE_(ch, ...) __noop
143  #define INFO_(ch, ...) __noop
144 
145  #define ERR__(ch, ...) __noop
146  #define WARN__(ch, ...) __noop
147  #define TRACE__(ch, ...) __noop
148  #define INFO__(ch, ...) __noop
149 #else
150  #define DPRINT1(...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
151  #define DPRINT(...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
152 
153  #define UNIMPLEMENTED
154 
155  #define ERR_(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
156  #define WARN_(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
157  #define TRACE_(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
158  #define INFO_(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
159 
160  #define ERR__(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
161  #define WARN__(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
162  #define TRACE__(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
163  #define INFO__(ch, ...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0)
164 #endif /* _MSC_VER */
165 
166 #endif /* not DBG */
167 
168 /******************************************************************************/
169 /*
170  * Declare a target-dependent process termination procedure.
171  */
172 #ifndef _NTDDK_ /* User-Mode */
173  #ifndef NTOS_MODE_USER /* Should be Win32 */
174  #ifndef _WIN32
175  #error "Unsupported target."
176  #else
177  #define TerminateCurrentProcess(Status) TerminateProcess(GetCurrentProcess(), (Status))
178  #endif
179  #else /* Native */
180  #ifndef _PSFUNCS_H
182  NTSTATUS
183  NTAPI
187  );
188  #endif
189  #ifndef NtCurrentProcess
190  #define NtCurrentProcess() ((HANDLE)(LONG_PTR)-1)
191  #endif
192  #define TerminateCurrentProcess(Status) NtTerminateProcess(NtCurrentProcess(), (Status))
193  #endif
194 #else /* Kernel-Mode */
195  #include <bugcodes.h>
196  #define TerminateCurrentProcess(Status) KeBugCheckEx(CRITICAL_SERVICE_FAILED, (Status), 0, 0, 0)
197 #endif
198 
199 
200 /* For internal purposes only */
201 #define __ERROR_DBGBREAK(...) \
202 do { \
203  DbgPrint("" __VA_ARGS__); \
204  DbgBreakPoint(); \
205 } while (0)
206 
207 /* For internal purposes only */
208 #define __ERROR_FATAL(Status, ...) \
209 do { \
210  DbgPrint("" __VA_ARGS__); \
211  DbgBreakPoint(); \
212  TerminateCurrentProcess(Status); \
213 } while (0)
214 
215 /*
216  * These macros are designed to display an optional printf-like
217  * user-defined message and to break into the debugger.
218  * After that they allow to continue the program execution.
219  */
220 #define ERROR_DBGBREAK(...) \
221 do { \
222  __NOTICE(ERROR, "\n"); \
223  __ERROR_DBGBREAK(__VA_ARGS__); \
224 } while (0)
225 
226 #define UNIMPLEMENTED_DBGBREAK(...) \
227 do { \
228  __NOTICE(ERROR, "is UNIMPLEMENTED!\n"); \
229  __ERROR_DBGBREAK(__VA_ARGS__); \
230 } while (0)
231 
232 /*
233  * These macros are designed to display an optional printf-like
234  * user-defined message and to break into the debugger.
235  * After that they halt the execution of the current thread.
236  */
237 #define ERROR_FATAL(...) \
238 do { \
239  __NOTICE(UNRECOVERABLE ERROR, "\n"); \
240  __ERROR_FATAL(STATUS_ASSERTION_FAILURE, __VA_ARGS__); \
241 } while (0)
242 
243 #define UNIMPLEMENTED_FATAL(...) \
244 do { \
245  __NOTICE(UNRECOVERABLE ERROR, "is UNIMPLEMENTED!\n"); \
246  __ERROR_FATAL(STATUS_NOT_IMPLEMENTED, __VA_ARGS__); \
247 } while (0)
248 /******************************************************************************/
249 
250 #define ASSERT_IRQL_LESS_OR_EQUAL(x) ASSERT(KeGetCurrentIrql()<=(x))
251 #define ASSERT_IRQL_EQUAL(x) ASSERT(KeGetCurrentIrql()==(x))
252 #define ASSERT_IRQL_LESS(x) ASSERT(KeGetCurrentIrql()<(x))
253 
254 #define __STRING2__(x) #x
255 #define __STRING__(x) __STRING2__(x)
256 #define __STRLINE__ __STRING__(__LINE__)
257 
258 #if !defined(_MSC_VER) && !defined(__pragma)
259 #define __pragma(x) _Pragma(#x)
260 #endif
261 
262 #define _WARN(msg) __pragma(message("WARNING! Line " __STRLINE__ ": " msg))
263 
264 /* EOF */
DWORD *typedef PVOID
Definition: winlogon.h:52
signed char * PCHAR
Definition: retypes.h:7
#define IN
Definition: typedefs.h:38
#define _In_opt_z_
Definition: no_sal2.h:221
#define __cdecl
Definition: accygwin.h:79
const char * PCSTR
Definition: typedefs.h:51
#define NTSYSCALLAPI
Definition: ntbasedef.h:196
__analysis_noreturn NTSYSAPI VOID NTAPI RtlAssert(_In_ PVOID FailedAssertion, _In_ PVOID FileName, _In_ ULONG LineNumber, _In_opt_z_ PCHAR Message)
_IRQL_requires_same_ typedef _In_ ULONG _In_ UCHAR Level
Definition: wmitypes.h:55
ULONG __cdecl DbgPrint(_In_z_ _Printf_format_string_ PCSTR Format,...)
#define NTSYSAPI
Definition: ntoskrnl.h:14
NTSTATUS(* NTAPI)(IN PFILE_FULL_EA_INFORMATION EaBuffer, IN ULONG EaLength, OUT PULONG ErrorOffset)
Definition: IoEaTest.cpp:117
CHAR Message[80]
Definition: alive.c:5
ACPI_EFI_STATUS ExitStatus
Definition: acefiex.h:480
#define _In_
Definition: no_sal2.h:204
DWORD *typedef HANDLE
Definition: winlogon.h:52
LONG NTSTATUS
Definition: DriverTester.h:11
#define _In_z_
Definition: no_sal2.h:239
ACPI_BUFFER *RetBuffer ACPI_BUFFER *RetBuffer char ACPI_WALK_RESOURCE_CALLBACK void *Context ACPI_BUFFER *RetBuffer UINT16 ACPI_RESOURCE **ResourcePtr ACPI_GENERIC_ADDRESS *Reg UINT32 *ReturnValue UINT8 UINT8 *Slp_TypB ACPI_PHYSICAL_ADDRESS PhysicalAddress64 UINT32 UINT32 *TimeElapsed UINT32 LineNumber
Definition: acpixf.h:1196
unsigned int ULONG
Definition: retypes.h:1
NTSTATUS NTAPI NtTerminateProcess(HANDLE ProcessHandle, LONG ExitStatus)
ACPI_BUFFER *RetBuffer ACPI_BUFFER *RetBuffer char ACPI_WALK_RESOURCE_CALLBACK void *Context ACPI_BUFFER *RetBuffer UINT16 ACPI_RESOURCE **ResourcePtr ACPI_GENERIC_ADDRESS *Reg UINT32 *ReturnValue UINT8 UINT8 *Slp_TypB ACPI_PHYSICAL_ADDRESS PhysicalAddress64 UINT32 UINT32 *TimeElapsed UINT32 ACPI_STATUS const char UINT32 const char UINT32 const char const char UINT32 ComponentId
Definition: acpixf.h:1256
#define __analysis_noreturn
Definition: specstrings.h:61
_In_ HANDLE ProcessHandle
Definition: mmfuncs.h:403
NTSYSAPI ULONG __cdecl DbgPrintEx(_In_ ULONG ComponentId, _In_ ULONG Level, _In_z_ _Printf_format_string_ PCSTR Format,...)
#define _Printf_format_string_
Definition: no_sal2.h:569