MdePkg/Include/Library/DebugLib.h

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