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