]>
Commit | Line | Data |
---|---|---|
fb3df220 | 1 | /** @file\r |
50a64e5b | 2 | Provides services to print debug and assert messages to a debug output device.\r |
9095d37b | 3 | \r |
d80b2f71 | 4 | The Debug library supports debug print and asserts based on a combination of macros and code.\r |
5 | The debug library can be turned on and off so that the debug code does not increase the size of an image.\r | |
c9ec7047 | 6 | \r |
5ee9264a | 7 | Note that a reserved macro named MDEPKG_NDEBUG is introduced for the intention\r |
8 | of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is\r | |
9 | defined, then debug and assert related macros wrapped by it are the NULL implementations.\r | |
c9ec7047 | 10 | \r |
b87a9a76 | 11 | Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r |
9095d37b LG |
12 | This program and the accompanying materials are licensed and made available under\r |
13 | the terms and conditions of the BSD License that accompanies this distribution.\r | |
af2dc6a7 | 14 | The full text of the license may be found at\r |
15 | http://opensource.org/licenses/bsd-license.php.\r | |
fb3df220 | 16 | \r |
50a64e5b | 17 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
18 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
fb3df220 | 19 | \r |
20 | **/\r | |
21 | \r | |
22 | #ifndef __DEBUG_LIB_H__\r | |
23 | #define __DEBUG_LIB_H__\r | |
24 | \r | |
25 | //\r | |
26 | // Declare bits for PcdDebugPropertyMask\r | |
27 | //\r | |
28 | #define DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED 0x01\r | |
29 | #define DEBUG_PROPERTY_DEBUG_PRINT_ENABLED 0x02\r | |
30 | #define DEBUG_PROPERTY_DEBUG_CODE_ENABLED 0x04\r | |
31 | #define DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED 0x08\r | |
32 | #define DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED 0x10\r | |
33 | #define DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED 0x20\r | |
34 | \r | |
35 | //\r | |
36 | // Declare bits for PcdDebugPrintErrorLevel and the ErrorLevel parameter of DebugPrint()\r | |
37 | //\r | |
38 | #define DEBUG_INIT 0x00000001 // Initialization\r | |
39 | #define DEBUG_WARN 0x00000002 // Warnings\r | |
40 | #define DEBUG_LOAD 0x00000004 // Load events\r | |
41 | #define DEBUG_FS 0x00000008 // EFI File system\r | |
34c1508f LE |
42 | #define DEBUG_POOL 0x00000010 // Alloc & Free (pool)\r |
43 | #define DEBUG_PAGE 0x00000020 // Alloc & Free (page)\r | |
9a8e70ce | 44 | #define DEBUG_INFO 0x00000040 // Informational debug messages\r |
3ae55b76 | 45 | #define DEBUG_DISPATCH 0x00000080 // PEI/DXE/SMM Dispatchers\r |
fb3df220 | 46 | #define DEBUG_VARIABLE 0x00000100 // Variable\r |
47 | #define DEBUG_BM 0x00000400 // Boot Manager\r | |
48 | #define DEBUG_BLKIO 0x00001000 // BlkIo Driver\r | |
6859cc8b | 49 | #define DEBUG_NET 0x00004000 // Network Io Driver\r |
fb3df220 | 50 | #define DEBUG_UNDI 0x00010000 // UNDI Driver\r |
48d97c8b | 51 | #define DEBUG_LOADFILE 0x00020000 // LoadFile\r |
fb3df220 | 52 | #define DEBUG_EVENT 0x00080000 // Event messages\r |
5a2e7dd2 | 53 | #define DEBUG_GCD 0x00100000 // Global Coherency Database changes\r |
54 | #define DEBUG_CACHE 0x00200000 // Memory range cachability changes\r | |
34c1508f LE |
55 | #define DEBUG_VERBOSE 0x00400000 // Detailed debug messages that may\r |
56 | // significantly impact boot performance\r | |
fb3df220 | 57 | #define DEBUG_ERROR 0x80000000 // Error\r |
58 | \r | |
59 | //\r | |
60 | // Aliases of debug message mask bits\r | |
61 | //\r | |
62 | #define EFI_D_INIT DEBUG_INIT\r | |
63 | #define EFI_D_WARN DEBUG_WARN\r | |
64 | #define EFI_D_LOAD DEBUG_LOAD\r | |
65 | #define EFI_D_FS DEBUG_FS\r | |
66 | #define EFI_D_POOL DEBUG_POOL\r | |
67 | #define EFI_D_PAGE DEBUG_PAGE\r | |
68 | #define EFI_D_INFO DEBUG_INFO\r | |
c759eb45 | 69 | #define EFI_D_DISPATCH DEBUG_DISPATCH\r |
fb3df220 | 70 | #define EFI_D_VARIABLE DEBUG_VARIABLE\r |
71 | #define EFI_D_BM DEBUG_BM\r | |
72 | #define EFI_D_BLKIO DEBUG_BLKIO\r | |
73 | #define EFI_D_NET DEBUG_NET\r | |
74 | #define EFI_D_UNDI DEBUG_UNDI\r | |
75 | #define EFI_D_LOADFILE DEBUG_LOADFILE\r | |
76 | #define EFI_D_EVENT DEBUG_EVENT\r | |
9a8e70ce | 77 | #define EFI_D_VERBOSE DEBUG_VERBOSE\r |
fb3df220 | 78 | #define EFI_D_ERROR DEBUG_ERROR\r |
79 | \r | |
80 | /**\r | |
fb3df220 | 81 | Prints a debug message to the debug output device if the specified error level is enabled.\r |
82 | \r | |
9095d37b LG |
83 | If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r |
84 | GetDebugPrintErrorLevel (), then print the message specified by Format and the\r | |
2891fc8b | 85 | associated variable argument list to the debug output device.\r |
fb3df220 | 86 | \r |
87 | If Format is NULL, then ASSERT().\r | |
88 | \r | |
89 | @param ErrorLevel The error level of the debug message.\r | |
af2dc6a7 | 90 | @param Format The format string for the debug message to print.\r |
9095d37b | 91 | @param ... The variable argument list whose contents are accessed\r |
285010e7 | 92 | based on the format string specified by Format.\r |
fb3df220 | 93 | \r |
94 | **/\r | |
95 | VOID\r | |
96 | EFIAPI\r | |
97 | DebugPrint (\r | |
98 | IN UINTN ErrorLevel,\r | |
99 | IN CONST CHAR8 *Format,\r | |
100 | ...\r | |
101 | );\r | |
102 | \r | |
103 | \r | |
b87a9a76 BB |
104 | /**\r |
105 | Prints a debug message to the debug output device if the specified\r | |
106 | error level is enabled.\r | |
107 | \r | |
108 | If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r | |
109 | GetDebugPrintErrorLevel (), then print the message specified by Format and\r | |
110 | the associated variable argument list to the debug output device.\r | |
111 | \r | |
112 | If Format is NULL, then ASSERT().\r | |
113 | \r | |
114 | @param ErrorLevel The error level of the debug message.\r | |
115 | @param Format Format string for the debug message to print.\r | |
116 | @param VaListMarker VA_LIST marker for the variable argument list.\r | |
117 | \r | |
118 | **/\r | |
119 | VOID\r | |
120 | EFIAPI\r | |
121 | DebugVPrint (\r | |
122 | IN UINTN ErrorLevel,\r | |
123 | IN CONST CHAR8 *Format,\r | |
124 | IN VA_LIST VaListMarker\r | |
125 | );\r | |
126 | \r | |
127 | \r | |
128 | /**\r | |
129 | Prints a debug message to the debug output device if the specified\r | |
130 | error level is enabled.\r | |
131 | This function use BASE_LIST which would provide a more compatible\r | |
132 | service than VA_LIST.\r | |
133 | \r | |
134 | If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r | |
135 | GetDebugPrintErrorLevel (), then print the message specified by Format and\r | |
136 | the associated variable argument list to the debug output device.\r | |
137 | \r | |
138 | If Format is NULL, then ASSERT().\r | |
139 | \r | |
140 | @param ErrorLevel The error level of the debug message.\r | |
141 | @param Format Format string for the debug message to print.\r | |
142 | @param BaseListMarker BASE_LIST marker for the variable argument list.\r | |
143 | \r | |
144 | **/\r | |
145 | VOID\r | |
146 | EFIAPI\r | |
147 | DebugBPrint (\r | |
148 | IN UINTN ErrorLevel,\r | |
149 | IN CONST CHAR8 *Format,\r | |
150 | IN BASE_LIST BaseListMarker\r | |
151 | );\r | |
152 | \r | |
153 | \r | |
fb3df220 | 154 | /**\r |
9095d37b | 155 | Prints an assert message containing a filename, line number, and description.\r |
fb3df220 | 156 | This may be followed by a breakpoint or a dead loop.\r |
157 | \r | |
158 | Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r | |
9095d37b LG |
159 | to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of\r |
160 | PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if\r | |
161 | DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then\r | |
162 | CpuDeadLoop() is called. If neither of these bits are set, then this function\r | |
fb3df220 | 163 | returns immediately after the message is printed to the debug output device.\r |
584125bc | 164 | DebugAssert() must actively prevent recursion. If DebugAssert() is called while\r |
fb3df220 | 165 | processing another DebugAssert(), then DebugAssert() must return immediately.\r |
166 | \r | |
584125bc | 167 | If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r |
584125bc | 168 | If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r |
fb3df220 | 169 | \r |
af2dc6a7 | 170 | @param FileName The pointer to the name of the source file that generated the assert condition.\r |
fb3df220 | 171 | @param LineNumber The line number in the source file that generated the assert condition\r |
af2dc6a7 | 172 | @param Description The pointer to the description of the assert condition.\r |
fb3df220 | 173 | \r |
174 | **/\r | |
175 | VOID\r | |
176 | EFIAPI\r | |
177 | DebugAssert (\r | |
178 | IN CONST CHAR8 *FileName,\r | |
179 | IN UINTN LineNumber,\r | |
180 | IN CONST CHAR8 *Description\r | |
181 | );\r | |
182 | \r | |
183 | \r | |
184 | /**\r | |
fb3df220 | 185 | Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r |
186 | \r | |
9095d37b | 187 | This function fills Length bytes of Buffer with the value specified by\r |
fb3df220 | 188 | PcdDebugClearMemoryValue, and returns Buffer.\r |
189 | \r | |
190 | If Buffer is NULL, then ASSERT().\r | |
9095d37b | 191 | If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r |
fb3df220 | 192 | \r |
af2dc6a7 | 193 | @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r |
9095d37b | 194 | @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.\r |
fb3df220 | 195 | \r |
af2dc6a7 | 196 | @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r |
fb3df220 | 197 | \r |
198 | **/\r | |
199 | VOID *\r | |
200 | EFIAPI\r | |
201 | DebugClearMemory (\r | |
202 | OUT VOID *Buffer,\r | |
203 | IN UINTN Length\r | |
204 | );\r | |
205 | \r | |
206 | \r | |
207 | /**\r | |
fb3df220 | 208 | Returns TRUE if ASSERT() macros are enabled.\r |
209 | \r | |
9095d37b | 210 | This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of\r |
af2dc6a7 | 211 | PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r |
fb3df220 | 212 | \r |
213 | @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r | |
214 | @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r | |
215 | \r | |
216 | **/\r | |
217 | BOOLEAN\r | |
218 | EFIAPI\r | |
219 | DebugAssertEnabled (\r | |
220 | VOID\r | |
221 | );\r | |
222 | \r | |
223 | \r | |
9095d37b | 224 | /**\r |
3e5c3238 | 225 | Returns TRUE if DEBUG() macros are enabled.\r |
fb3df220 | 226 | \r |
9095d37b | 227 | This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of\r |
af2dc6a7 | 228 | PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r |
fb3df220 | 229 | \r |
230 | @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r | |
231 | @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r | |
232 | \r | |
233 | **/\r | |
234 | BOOLEAN\r | |
235 | EFIAPI\r | |
236 | DebugPrintEnabled (\r | |
237 | VOID\r | |
238 | );\r | |
239 | \r | |
240 | \r | |
9095d37b | 241 | /**\r |
3e5c3238 | 242 | Returns TRUE if DEBUG_CODE() macros are enabled.\r |
fb3df220 | 243 | \r |
9095d37b | 244 | This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of\r |
af2dc6a7 | 245 | PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r |
fb3df220 | 246 | \r |
247 | @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r | |
248 | @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r | |
249 | \r | |
250 | **/\r | |
251 | BOOLEAN\r | |
252 | EFIAPI\r | |
253 | DebugCodeEnabled (\r | |
254 | VOID\r | |
255 | );\r | |
256 | \r | |
257 | \r | |
9095d37b | 258 | /**\r |
3e5c3238 | 259 | Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r |
fb3df220 | 260 | \r |
9095d37b | 261 | This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of\r |
af2dc6a7 | 262 | PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r |
fb3df220 | 263 | \r |
eceb3a4c LG |
264 | @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r |
265 | @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r | |
fb3df220 | 266 | \r |
267 | **/\r | |
268 | BOOLEAN\r | |
269 | EFIAPI\r | |
270 | DebugClearMemoryEnabled (\r | |
271 | VOID\r | |
272 | );\r | |
273 | \r | |
5ea9d0c3 LG |
274 | /**\r |
275 | Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.\r | |
276 | \r | |
277 | This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.\r | |
278 | \r | |
279 | @retval TRUE Current ErrorLevel is supported.\r | |
280 | @retval FALSE Current ErrorLevel is not supported.\r | |
281 | \r | |
282 | **/\r | |
283 | BOOLEAN\r | |
284 | EFIAPI\r | |
285 | DebugPrintLevelEnabled (\r | |
286 | IN CONST UINTN ErrorLevel\r | |
287 | );\r | |
fb3df220 | 288 | \r |
9095d37b | 289 | /**\r |
fb3df220 | 290 | Internal worker macro that calls DebugAssert().\r |
291 | \r | |
1a2f870c | 292 | This macro calls DebugAssert(), passing in the filename, line number, and an\r |
293 | expression that evaluated to FALSE.\r | |
fb3df220 | 294 | \r |
1a2f870c | 295 | @param Expression Boolean expression that evaluated to FALSE\r |
fb3df220 | 296 | \r |
297 | **/\r | |
298 | #define _ASSERT(Expression) DebugAssert (__FILE__, __LINE__, #Expression)\r | |
299 | \r | |
300 | \r | |
9095d37b | 301 | /**\r |
fb3df220 | 302 | Internal worker macro that calls DebugPrint().\r |
303 | \r | |
9095d37b | 304 | This macro calls DebugPrint() passing in the debug error level, a format\r |
fb3df220 | 305 | string, and a variable argument list.\r |
79142ebf | 306 | __VA_ARGS__ is not supported by EBC compiler, Microsoft Visual Studio .NET 2003\r |
6e6f5e03 | 307 | and Microsoft Windows Server 2003 Driver Development Kit (Microsoft WINDDK) version 3790.1830.\r |
fb3df220 | 308 | \r |
9095d37b | 309 | @param Expression Expression containing an error level, a format string,\r |
fb3df220 | 310 | and a variable argument list based on the format string.\r |
311 | \r | |
312 | **/\r | |
fb3df220 | 313 | \r |
d9a55c78 | 314 | #if !defined(MDE_CPU_EBC) && (!defined (_MSC_VER) || _MSC_VER > 1400)\r |
5ea9d0c3 LG |
315 | #define _DEBUG_PRINT(PrintLevel, ...) \\r |
316 | do { \\r | |
317 | if (DebugPrintLevelEnabled (PrintLevel)) { \\r | |
318 | DebugPrint (PrintLevel, ##__VA_ARGS__); \\r | |
319 | } \\r | |
320 | } while (FALSE)\r | |
321 | #define _DEBUG(Expression) _DEBUG_PRINT Expression\r | |
322 | #else\r | |
323 | #define _DEBUG(Expression) DebugPrint Expression\r | |
324 | #endif\r | |
fb3df220 | 325 | \r |
9095d37b | 326 | /**\r |
1a2f870c | 327 | Macro that calls DebugAssert() if an expression evaluates to FALSE.\r |
fb3df220 | 328 | \r |
9095d37b LG |
329 | If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED\r |
330 | bit of PcdDebugProperyMask is set, then this macro evaluates the Boolean\r | |
331 | expression specified by Expression. If Expression evaluates to FALSE, then\r | |
332 | DebugAssert() is called passing in the source filename, source line number,\r | |
c9ec7047 | 333 | and Expression.\r |
fb3df220 | 334 | \r |
af2dc6a7 | 335 | @param Expression Boolean expression.\r |
fb3df220 | 336 | \r |
337 | **/\r | |
9095d37b | 338 | #if !defined(MDEPKG_NDEBUG)\r |
c9ec7047 | 339 | #define ASSERT(Expression) \\r |
340 | do { \\r | |
341 | if (DebugAssertEnabled ()) { \\r | |
342 | if (!(Expression)) { \\r | |
343 | _ASSERT (Expression); \\r | |
90eda6fc | 344 | ANALYZER_UNREACHABLE (); \\r |
c9ec7047 | 345 | } \\r |
346 | } \\r | |
347 | } while (FALSE)\r | |
348 | #else\r | |
349 | #define ASSERT(Expression)\r | |
350 | #endif\r | |
fb3df220 | 351 | \r |
9095d37b | 352 | /**\r |
fb3df220 | 353 | Macro that calls DebugPrint().\r |
354 | \r | |
9095d37b LG |
355 | If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED\r |
356 | bit of PcdDebugProperyMask is set, then this macro passes Expression to\r | |
c9ec7047 | 357 | DebugPrint().\r |
fb3df220 | 358 | \r |
9095d37b | 359 | @param Expression Expression containing an error level, a format string,\r |
fb3df220 | 360 | and a variable argument list based on the format string.\r |
9095d37b | 361 | \r |
fb3df220 | 362 | \r |
363 | **/\r | |
9095d37b | 364 | #if !defined(MDEPKG_NDEBUG)\r |
c9ec7047 | 365 | #define DEBUG(Expression) \\r |
366 | do { \\r | |
367 | if (DebugPrintEnabled ()) { \\r | |
368 | _DEBUG (Expression); \\r | |
369 | } \\r | |
370 | } while (FALSE)\r | |
371 | #else\r | |
372 | #define DEBUG(Expression)\r | |
373 | #endif\r | |
fb3df220 | 374 | \r |
9095d37b | 375 | /**\r |
fb3df220 | 376 | Macro that calls DebugAssert() if an EFI_STATUS evaluates to an error code.\r |
377 | \r | |
9095d37b LG |
378 | If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED\r |
379 | bit of PcdDebugProperyMask is set, then this macro evaluates the EFI_STATUS\r | |
380 | value specified by StatusParameter. If StatusParameter is an error code,\r | |
381 | then DebugAssert() is called passing in the source filename, source line\r | |
c9ec7047 | 382 | number, and StatusParameter.\r |
fb3df220 | 383 | \r |
384 | @param StatusParameter EFI_STATUS value to evaluate.\r | |
385 | \r | |
386 | **/\r | |
c9ec7047 | 387 | #if !defined(MDEPKG_NDEBUG)\r |
388 | #define ASSERT_EFI_ERROR(StatusParameter) \\r | |
389 | do { \\r | |
390 | if (DebugAssertEnabled ()) { \\r | |
391 | if (EFI_ERROR (StatusParameter)) { \\r | |
392 | DEBUG ((EFI_D_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter)); \\r | |
393 | _ASSERT (!EFI_ERROR (StatusParameter)); \\r | |
394 | } \\r | |
395 | } \\r | |
396 | } while (FALSE)\r | |
397 | #else\r | |
398 | #define ASSERT_EFI_ERROR(StatusParameter)\r | |
399 | #endif\r | |
fb3df220 | 400 | \r |
08bcaf20 LE |
401 | /**\r |
402 | Macro that calls DebugAssert() if a RETURN_STATUS evaluates to an error code.\r | |
403 | \r | |
404 | If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED\r | |
405 | bit of PcdDebugProperyMask is set, then this macro evaluates the\r | |
406 | RETURN_STATUS value specified by StatusParameter. If StatusParameter is an\r | |
407 | error code, then DebugAssert() is called passing in the source filename,\r | |
408 | source line number, and StatusParameter.\r | |
409 | \r | |
410 | @param StatusParameter RETURN_STATUS value to evaluate.\r | |
411 | \r | |
412 | **/\r | |
413 | #if !defined(MDEPKG_NDEBUG)\r | |
414 | #define ASSERT_RETURN_ERROR(StatusParameter) \\r | |
415 | do { \\r | |
416 | if (DebugAssertEnabled ()) { \\r | |
417 | if (RETURN_ERROR (StatusParameter)) { \\r | |
418 | DEBUG ((DEBUG_ERROR, "\nASSERT_RETURN_ERROR (Status = %r)\n", \\r | |
419 | StatusParameter)); \\r | |
420 | _ASSERT (!RETURN_ERROR (StatusParameter)); \\r | |
421 | } \\r | |
422 | } \\r | |
423 | } while (FALSE)\r | |
424 | #else\r | |
425 | #define ASSERT_RETURN_ERROR(StatusParameter)\r | |
426 | #endif\r | |
427 | \r | |
9095d37b LG |
428 | /**\r |
429 | Macro that calls DebugAssert() if a protocol is already installed in the\r | |
fb3df220 | 430 | handle database.\r |
431 | \r | |
9095d37b | 432 | If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit\r |
c9ec7047 | 433 | of PcdDebugProperyMask is clear, then return.\r |
fb3df220 | 434 | \r |
9095d37b LG |
435 | If Handle is NULL, then a check is made to see if the protocol specified by Guid\r |
436 | is present on any handle in the handle database. If Handle is not NULL, then\r | |
437 | a check is made to see if the protocol specified by Guid is present on the\r | |
438 | handle specified by Handle. If the check finds the protocol, then DebugAssert()\r | |
fb3df220 | 439 | is called passing in the source filename, source line number, and Guid.\r |
440 | \r | |
441 | If Guid is NULL, then ASSERT().\r | |
442 | \r | |
9095d37b LG |
443 | @param Handle The handle to check for the protocol. This is an optional\r |
444 | parameter that may be NULL. If it is NULL, then the entire\r | |
fb3df220 | 445 | handle database is searched.\r |
446 | \r | |
af2dc6a7 | 447 | @param Guid The pointer to a protocol GUID.\r |
fb3df220 | 448 | \r |
449 | **/\r | |
c9ec7047 | 450 | #if !defined(MDEPKG_NDEBUG)\r |
451 | #define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid) \\r | |
452 | do { \\r | |
453 | if (DebugAssertEnabled ()) { \\r | |
454 | VOID *Instance; \\r | |
455 | ASSERT (Guid != NULL); \\r | |
456 | if (Handle == NULL) { \\r | |
457 | if (!EFI_ERROR (gBS->LocateProtocol ((EFI_GUID *)Guid, NULL, &Instance))) { \\r | |
458 | _ASSERT (Guid already installed in database); \\r | |
459 | } \\r | |
460 | } else { \\r | |
461 | if (!EFI_ERROR (gBS->HandleProtocol (Handle, (EFI_GUID *)Guid, &Instance))) { \\r | |
462 | _ASSERT (Guid already installed on Handle); \\r | |
463 | } \\r | |
464 | } \\r | |
465 | } \\r | |
466 | } while (FALSE)\r | |
467 | #else\r | |
468 | #define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)\r | |
469 | #endif\r | |
fb3df220 | 470 | \r |
471 | /**\r | |
472 | Macro that marks the beginning of debug source code.\r | |
473 | \r | |
9095d37b | 474 | If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,\r |
fb3df220 | 475 | then this macro marks the beginning of source code that is included in a module.\r |
9095d37b | 476 | Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END()\r |
fb3df220 | 477 | are not included in a module.\r |
478 | \r | |
479 | **/\r | |
480 | #define DEBUG_CODE_BEGIN() do { if (DebugCodeEnabled ()) { UINT8 __DebugCodeLocal\r | |
481 | \r | |
482 | \r | |
9095d37b | 483 | /**\r |
af2dc6a7 | 484 | The macro that marks the end of debug source code.\r |
fb3df220 | 485 | \r |
9095d37b LG |
486 | If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,\r |
487 | then this macro marks the end of source code that is included in a module.\r | |
488 | Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END()\r | |
fb3df220 | 489 | are not included in a module.\r |
490 | \r | |
491 | **/\r | |
492 | #define DEBUG_CODE_END() __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)\r | |
493 | \r | |
494 | \r | |
9095d37b | 495 | /**\r |
af2dc6a7 | 496 | The macro that declares a section of debug source code.\r |
fb3df220 | 497 | \r |
9095d37b LG |
498 | If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,\r |
499 | then the source code specified by Expression is included in a module.\r | |
fb3df220 | 500 | Otherwise, the source specified by Expression is not included in a module.\r |
501 | \r | |
502 | **/\r | |
503 | #define DEBUG_CODE(Expression) \\r | |
504 | DEBUG_CODE_BEGIN (); \\r | |
505 | Expression \\r | |
506 | DEBUG_CODE_END ()\r | |
507 | \r | |
508 | \r | |
9095d37b | 509 | /**\r |
af2dc6a7 | 510 | The macro that calls DebugClearMemory() to clear a buffer to a default value.\r |
fb3df220 | 511 | \r |
9095d37b | 512 | If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set,\r |
fb3df220 | 513 | then this macro calls DebugClearMemory() passing in Address and Length.\r |
514 | \r | |
af2dc6a7 | 515 | @param Address The pointer to a buffer.\r |
fb3df220 | 516 | @param Length The number of bytes in the buffer to set.\r |
517 | \r | |
518 | **/\r | |
519 | #define DEBUG_CLEAR_MEMORY(Address, Length) \\r | |
520 | do { \\r | |
521 | if (DebugClearMemoryEnabled ()) { \\r | |
522 | DebugClearMemory (Address, Length); \\r | |
523 | } \\r | |
524 | } while (FALSE)\r | |
525 | \r | |
526 | \r | |
527 | /**\r | |
9095d37b LG |
528 | Macro that calls DebugAssert() if the containing record does not have a\r |
529 | matching signature. If the signatures matches, then a pointer to the data\r | |
530 | structure that contains a specified field of that data structure is returned.\r | |
531 | This is a lightweight method hide information by placing a public data\r | |
532 | structure inside a larger private data structure and using a pointer to the\r | |
fb3df220 | 533 | public data structure to retrieve a pointer to the private data structure.\r |
534 | \r | |
9095d37b | 535 | If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit\r |
c9ec7047 | 536 | of PcdDebugProperyMask is clear, then this macro computes the offset, in bytes,\r |
9095d37b LG |
537 | of the field specified by Field from the beginning of the data structure specified\r |
538 | by TYPE. This offset is subtracted from Record, and is used to return a pointer\r | |
c9ec7047 | 539 | to a data structure of the type specified by TYPE.\r |
540 | \r | |
541 | If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit\r | |
9095d37b LG |
542 | of PcdDebugProperyMask is set, then this macro computes the offset, in bytes,\r |
543 | of field specified by Field from the beginning of the data structure specified\r | |
c9ec7047 | 544 | by TYPE. This offset is subtracted from Record, and is used to compute a pointer\r |
9095d37b LG |
545 | to a data structure of the type specified by TYPE. The Signature field of the\r |
546 | data structure specified by TYPE is compared to TestSignature. If the signatures\r | |
547 | match, then a pointer to the pointer to a data structure of the type specified by\r | |
548 | TYPE is returned. If the signatures do not match, then DebugAssert() is called\r | |
549 | with a description of "CR has a bad signature" and Record is returned.\r | |
fb3df220 | 550 | \r |
9095d37b | 551 | If the data type specified by TYPE does not contain the field specified by Field,\r |
fb3df220 | 552 | then the module will not compile.\r |
553 | \r | |
9095d37b | 554 | If TYPE does not contain a field called Signature, then the module will not\r |
fb3df220 | 555 | compile.\r |
556 | \r | |
9095d37b | 557 | @param Record The pointer to the field specified by Field within a data\r |
fb3df220 | 558 | structure of type TYPE.\r |
559 | \r | |
9095d37b LG |
560 | @param TYPE The name of the data structure type to return This\r |
561 | data structure must contain the field specified by Field.\r | |
fb3df220 | 562 | \r |
9095d37b | 563 | @param Field The name of the field in the data structure specified\r |
fb3df220 | 564 | by TYPE to which Record points.\r |
565 | \r | |
566 | @param TestSignature The 32-bit signature value to match.\r | |
567 | \r | |
568 | **/\r | |
c9ec7047 | 569 | #if !defined(MDEPKG_NDEBUG)\r |
570 | #define CR(Record, TYPE, Field, TestSignature) \\r | |
571 | (DebugAssertEnabled () && (BASE_CR (Record, TYPE, Field)->Signature != TestSignature)) ? \\r | |
572 | (TYPE *) (_ASSERT (CR has Bad Signature), Record) : \\r | |
573 | BASE_CR (Record, TYPE, Field)\r | |
574 | #else\r | |
575 | #define CR(Record, TYPE, Field, TestSignature) \\r | |
576 | BASE_CR (Record, TYPE, Field)\r | |
577 | #endif\r | |
9095d37b | 578 | \r |
fb3df220 | 579 | #endif\r |