EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Include/Library/EdkIIGlueDebugLib.h

   1 /*++
   2
   3 Copyright (c) 2004 - 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12
  13 Module Name:
  14
  15   EdkIIGlueDebugLib.h
  16
  17 Abstract:
  18
  19   Public include file for the Debug Library
  20
  21 --*/
  22
  23 #ifndef __EDKII_GLUE_DEBUG_LIB_H__
  24 #define __EDKII_GLUE_DEBUG_LIB_H__
  25
  26 //
  27 // To use EdkII code, these R8.x macros are undefined
  28 //
  29 #undef ASSERT
  30 #undef DEBUG
  31 #undef ASSERT_EFI_ERROR
  32 #undef ASSERT_PROTOCOL_ALREADY_INSTALLED
  33 #undef DEBUG_CODE
  34 #undef CR
  35
  36 #undef EFI_D_INIT
  37 #undef EFI_D_WARN
  38 #undef EFI_D_LOAD
  39 #undef EFI_D_FS
  40 #undef EFI_D_POOL
  41 #undef EFI_D_PAGE
  42 #undef EFI_D_INFO
  43 #undef EFI_D_VARIABLE
  44 #undef EFI_D_BM
  45 #undef EFI_D_BLKIO
  46 #undef EFI_D_NET
  47 #undef EFI_D_UNDI
  48 #undef EFI_D_LOADFILE
  49 #undef EFI_D_EVENT
  50 #undef EFI_D_ERROR
  51
  52 //
  53 // Declare bits for PcdDebugPropertyMask
  54 //
  55 #define DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED       0x01
  56 #define DEBUG_PROPERTY_DEBUG_PRINT_ENABLED        0x02
  57 #define DEBUG_PROPERTY_DEBUG_CODE_ENABLED         0x04
  58 #define DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED       0x08
  59 #define DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED  0x10
  60 #define DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED    0x20
  61
  62 //
  63 // Declare bits for PcdDebugPrintErrorLevel and the ErrorLevel parameter of DebugPrint()
  64 //
  65 #define DEBUG_INIT      0x00000001  // Initialization
  66 #define DEBUG_WARN      0x00000002  // Warnings
  67 #define DEBUG_LOAD      0x00000004  // Load events
  68 #define DEBUG_FS        0x00000008  // EFI File system
  69 #define DEBUG_POOL      0x00000010  // Alloc & Free's
  70 #define DEBUG_PAGE      0x00000020  // Alloc & Free's
  71 #define DEBUG_INFO      0x00000040  // Verbose
  72 #define DEBUG_VARIABLE  0x00000100  // Variable
  73 #define DEBUG_BM        0x00000400  // Boot Manager
  74 #define DEBUG_BLKIO     0x00001000  // BlkIo Driver
  75 #define DEBUG_NET       0x00004000  // SNI Driver
  76 #define DEBUG_UNDI      0x00010000  // UNDI Driver
  77 #define DEBUG_LOADFILE  0x00020000  // UNDI Driver
  78 #define DEBUG_EVENT     0x00080000  // Event messages
  79 #define DEBUG_ERROR     0x80000000  // Error
  80
  81 //
  82 // Aliases of debug message mask bits
  83 //
  84 #define EFI_D_INIT      DEBUG_INIT
  85 #define EFI_D_WARN      DEBUG_WARN
  86 #define EFI_D_LOAD      DEBUG_LOAD
  87 #define EFI_D_FS        DEBUG_FS
  88 #define EFI_D_POOL      DEBUG_POOL
  89 #define EFI_D_PAGE      DEBUG_PAGE
  90 #define EFI_D_INFO      DEBUG_INFO
  91 #define EFI_D_VARIABLE  DEBUG_VARIABLE
  92 #define EFI_D_BM        DEBUG_BM
  93 #define EFI_D_BLKIO     DEBUG_BLKIO
  94 #define EFI_D_NET       DEBUG_NET
  95 #define EFI_D_UNDI      DEBUG_UNDI
  96 #define EFI_D_LOADFILE  DEBUG_LOADFILE
  97 #define EFI_D_EVENT     DEBUG_EVENT
  98 #define EFI_D_ERROR     DEBUG_ERROR
  99
 100
 101 //
 102 // Use the following 4 macros to save size
 103 //
 104 #define DebugAssertEnabled()      ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0))
 105
 106 #define DebugPrintEnabled()       ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0))
 107
 108 #define DebugCodeEnabled()        ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0))
 109
 110 #define DebugClearMemoryEnabled() ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0))
 111
 112
 113 /**
 114
 115   Prints a debug message to the debug output device if the specified error level is enabled.
 116
 117   If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
 118   the message specified by Format and the associated variable argument list to
 119   the debug output device.
 120
 121   If Format is NULL, then ASSERT().
 122
 123   @param  ErrorLevel  The error level of the debug message.
 124   @param  Format      Format string for the debug message to print.
 125
 126 **/
 127 VOID
 128 EFIAPI
 129 DebugPrint (
 130   IN  UINTN        ErrorLevel,
 131   IN  CONST CHAR8  *Format,
 132   ...
 133   );
 134
 135
 136 /**
 137
 138   Prints an assert message containing a filename, line number, and description.
 139   This may be followed by a breakpoint or a dead loop.
 140
 141   Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
 142   to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
 143   PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
 144   DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
 145   CpuDeadLoop() is called.  If neither of these bits are set, then this function
 146   returns immediately after the message is printed to the debug output device.
 147   DebugAssert() must actively prevent recusrsion.  If DebugAssert() is called while
 148   processing another DebugAssert(), then DebugAssert() must return immediately.
 149
 150   If FileName is NULL, then a <FileName> string of ?NULL) Filename?is printed.
 151
 152   If Description is NULL, then a <Description> string of ?NULL) Description?is printed.
 153
 154   @param  FileName     Pointer to the name of the source file that generated the assert condition.
 155   @param  LineNumber   The line number in the source file that generated the assert condition
 156   @param  Description  Pointer to the description of the assert condition.
 157
 158 **/
 159 VOID
 160 EFIAPI
 161 DebugAssert (
 162   IN CONST CHAR8  *FileName,
 163   IN UINTN        LineNumber,
 164   IN CONST CHAR8  *Description
 165   );
 166
 167
 168 /**
 169
 170   Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
 171
 172   This function fills Length bytes of Buffer with the value specified by
 173   PcdDebugClearMemoryValue, and returns Buffer.
 174
 175   If Buffer is NULL, then ASSERT().
 176
 177   If Length is greater than (MAX_ADDRESS ?Buffer + 1), then ASSERT().
 178
 179   @param   Buffer  Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
 180   @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
 181
 182   @return  Buffer
 183
 184 **/
 185 VOID *
 186 EFIAPI
 187 DebugClearMemory (
 188   OUT VOID  *Buffer,
 189   IN UINTN  Length
 190   );
 191
 192
 193 /**
 194
 195   Internal worker macro that calls DebugAssert().
 196
 197   This macro calls DebugAssert() passing in the filename, line number, and
 198   expression that evailated to FALSE.
 199
 200   @param  Expression  Boolean expression that evailated to FALSE
 201
 202 **/
 203 #ifdef EFI_DEBUG
 204 #define _ASSERT(Expression)  DebugAssert (__FILE__, __LINE__, #Expression)
 205 #else
 206 #define _ASSERT(Expression)
 207
 208 #endif
 209
 210 /**
 211
 212   Internal worker macro that calls DebugPrint().
 213
 214   This macro calls DebugPrint() passing in the debug error level, a format
 215   string, and a variable argument list.
 216
 217   @param  Expression  Expression containing an error level, a format string,
 218                       and a variable argument list based on the format string.
 219
 220 **/
 221 #ifdef EFI_DEBUG
 222 #define _DEBUG(Expression)   DebugPrint Expression
 223 #else
 224 #define _DEBUG(Expression)
 225
 226 #endif
 227
 228 /**
 229
 230   Macro that calls DebugAssert() if a expression evaluates to FALSE.
 231
 232   If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,
 233   then this macro evaluates the Boolean expression specified by Expression.  If
 234   Expression evaluates to FALSE, then DebugAssert() is called passing in the
 235   source filename, source line number, and Expression.
 236
 237   @param  Expression  Boolean expression
 238
 239 **/
 240 #ifdef EDKII_GLUE_LIBRARY_IMPLEMENTATION
 241   // Glue Library internal
 242
 243   #if EDKII_GLUE_LIBRARY_DEBUG_ENABLE
 244     #ifdef EFI_DEBUG
 245     #define ASSERT(Expression)        \
 246       do {                            \
 247         if (DebugAssertEnabled ()) {  \
 248           if (!(Expression)) {        \
 249             _ASSERT (Expression);     \
 250           }                           \
 251         }                             \
 252       } while (FALSE)
 253     #endif
 254   #else
 255     #define ASSERT(Expression) do{} while(0)
 256   #endif
 257
 258 #else
 259   // External usage
 260
 261   #ifdef EFI_DEBUG
 262     #define ASSERT(Expression)        \
 263       do {                            \
 264         if (DebugAssertEnabled ()) {  \
 265           if (!(Expression)) {        \
 266             _ASSERT (Expression);     \
 267           }                           \
 268         }                             \
 269       } while (FALSE)
 270   #else
 271     #define ASSERT(Expression) do{} while(0)
 272   #endif
 273
 274 #endif
 275
 276 /**
 277
 278   Macro that calls DebugPrint().
 279
 280   If the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set,
 281   then this macro passes Expression to DebugPrint().
 282
 283   @param  Expression  Expression containing an error level, a format string,
 284                       and a variable argument list based on the format string.
 285
 286
 287 **/
 288 #ifdef EDKII_GLUE_LIBRARY_IMPLEMENTATION
 289   // Glue Library internal
 290
 291   #if EDKII_GLUE_LIBRARY_DEBUG_ENABLE
 292     #ifdef EFI_DEBUG
 293     #define DEBUG(Expression)        \
 294       do {                           \
 295         if (DebugPrintEnabled ()) {  \
 296           _DEBUG (Expression);       \
 297         }                            \
 298       } while (FALSE)
 299     #endif
 300   #else
 301     #define DEBUG(Expression) do{} while(0)
 302   #endif
 303
 304 #else
 305   // External usage
 306
 307   #ifdef EFI_DEBUG
 308     #define DEBUG(Expression)        \
 309       do {                           \
 310         if (DebugPrintEnabled ()) {  \
 311           _DEBUG (Expression);       \
 312         }                            \
 313       } while (FALSE)
 314   #else
 315     #define DEBUG(Expression) do{} while(0)
 316   #endif
 317
 318 #endif
 319
 320
 321 /**
 322
 323   Macro that calls DebugAssert() if an EFI_STATUS evaluates to an error code.
 324
 325   If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,
 326   then this macro evaluates the EFI_STATUS value specified by StatusParameter.
 327   If StatusParameter is an error code, then DebugAssert() is called passing in
 328   the source filename, source line number, and StatusParameter.
 329
 330   @param  StatusParameter  EFI_STATUS value to evaluate.
 331
 332 **/
 333 #ifdef EDKII_GLUE_LIBRARY_IMPLEMENTATION
 334   // Glue Library internal
 335
 336   #if EDKII_GLUE_LIBRARY_DEBUG_ENABLE
 337     #ifdef EFI_DEBUG
 338     #define ASSERT_EFI_ERROR(StatusParameter)                                              \
 339       do {                                                                                 \
 340         if (DebugAssertEnabled ()) {                                                       \
 341           if (EFI_ERROR (StatusParameter)) {                                               \
 342             DEBUG ((EFI_D_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter));  \
 343             _ASSERT (!EFI_ERROR (StatusParameter));                                        \
 344           }                                                                                \
 345         }                                                                                  \
 346       } while (FALSE)
 347     #endif
 348   #else
 349     #define ASSERT_EFI_ERROR(Expression) do{} while(0)
 350   #endif
 351
 352 #else
 353   // External usage
 354
 355   #ifdef EFI_DEBUG
 356     #define ASSERT_EFI_ERROR(StatusParameter)                                              \
 357       do {                                                                                 \
 358         if (DebugAssertEnabled ()) {                                                       \
 359           if (EFI_ERROR (StatusParameter)) {                                               \
 360             DEBUG ((EFI_D_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter));  \
 361             _ASSERT (!EFI_ERROR (StatusParameter));                                        \
 362           }                                                                                \
 363         }                                                                                  \
 364       } while (FALSE)
 365   #else
 366     #define ASSERT_EFI_ERROR(Expression) do{} while(0)
 367   #endif
 368
 369 #endif
 370
 371
 372 /**
 373
 374   Macro that calls DebugAssert() if a protocol is already installed in the
 375   handle database.
 376
 377   If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear,
 378   then return.
 379
 380   If Handle is NULL, then a check is made to see if the protocol specified by Guid
 381   is present on any handle in the handle database.  If Handle is not NULL, then
 382   a check is made to see if the protocol specified by Guid is present on the
 383   handle specified by Handle.  If the check finds the protocol, then DebugAssert()
 384   is called passing in the source filename, source line number, and Guid.
 385
 386   If Guid is NULL, then ASSERT().
 387
 388   @param  Handle  The handle to check for the protocol.  This is an optional
 389                   parameter that may be NULL.  If it is NULL, then the entire
 390                   handle database is searched.
 391
 392   @param  Guid    Pointer to a protocol GUID.
 393
 394 **/
 395 #ifdef EFI_DEBUG
 396 #define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)                               \
 397   do {                                                                                \
 398     if (DebugAssertEnabled ()) {                                                      \
 399       VOID  *Instance;                                                                \
 400       ASSERT (Guid != NULL);                                                          \
 401       if (Handle == NULL) {                                                           \
 402         if (!EFI_ERROR (gBS->LocateProtocol ((EFI_GUID *)Guid, NULL, &Instance))) {   \
 403           _ASSERT (Guid already installed in database);                               \
 404         }                                                                             \
 405       } else {                                                                        \
 406         if (!EFI_ERROR (gBS->HandleProtocol (Handle, (EFI_GUID *)Guid, &Instance))) { \
 407           _ASSERT (Guid already installed on Handle);                                 \
 408         }                                                                             \
 409       }                                                                               \
 410     }                                                                                 \
 411   } while (FALSE)
 412 #else
 413 #define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)                               \
 414    do {} while(0);
 415 #endif
 416
 417
 418 /**
 419   Macro that marks the beginning of debug source code.
 420
 421   If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,
 422   then this macro marks the beginning of source code that is included in a module.
 423   Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END()
 424   are not included in a module.
 425
 426 **/
 427 #define DEBUG_CODE_BEGIN()  do { if (DebugCodeEnabled ()) { UINT8  __DebugCodeLocal
 428
 429
 430 /**
 431
 432   Macro that marks the end of debug source code.
 433
 434   If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,
 435   then this macro marks the end of source code that is included in a module.
 436   Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END()
 437   are not included in a module.
 438
 439 **/
 440 #define DEBUG_CODE_END()    __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)
 441
 442
 443 /**
 444
 445   Macro that declares a section of debug source code.
 446
 447   If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,
 448   then the source code specified by Expression is included in a module.
 449   Otherwise, the source specified by Expression is not included in a module.
 450
 451 **/
 452 #define DEBUG_CODE(Expression)  \
 453   DEBUG_CODE_BEGIN ();          \
 454   Expression                    \
 455   DEBUG_CODE_END ()
 456
 457
 458 /**
 459
 460   Macro that calls DebugClearMemory() to clear a buffer to a default value.
 461
 462   If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set,
 463   then this macro calls DebugClearMemory() passing in Address and Length.
 464
 465   @param  Address  Pointer to a buffer.
 466   @param  Length   The number of bytes in the buffer to set.
 467
 468 **/
 469 #define DEBUG_CLEAR_MEMORY(Address, Length)  \
 470   do {                                       \
 471     if (DebugClearMemoryEnabled ()) {        \
 472       DebugClearMemory (Address, Length);    \
 473     }                                        \
 474   } while (FALSE)
 475
 476
 477 /**
 478
 479   Macro that calls DebugAssert() if the containing record does not have a
 480   matching signature.  If the signatures matches, then a pointer to the data
 481   structure that contains a specified field of that data structure is returned.
 482   This is a light weight method hide information by placing a public data
 483   structure inside a larger private data structure and using a pointer to the
 484   public data structure to retrieve a pointer to the private data structure.
 485
 486   If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear,
 487   then this macro computes the offset, in bytes, of field specified by Field
 488   from the beginning of the  data structure specified by TYPE.  This offset is
 489   subtracted from Record, and is used to return a pointer to a data structure
 490   of the type specified by TYPE.
 491
 492   If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,
 493   then this macro computes the offset, in bytes, of field specified by Field from
 494   the beginning of the data structure specified by TYPE.  This offset is
 495   subtracted from Record, and is used to compute a pointer to a data structure of
 496   the type specified by TYPE.  The Signature field of the data structure specified
 497   by TYPE is compared to TestSignature.  If the signatures match, then a pointer
 498   to the pointer to a data structure of the type specified by TYPE is returned.
 499   If the signatures do not match, then DebugAssert() is called with a description
 500   of "CR has a bad signature" and Record is returned.
 501
 502   If the data type specified by TYPE does not contain the field specified by Field,
 503   then the module will not compile.
 504
 505   If TYPE does not contain a field called Signature, then the module will not
 506   compile.
 507
 508   @param  Record         Pointer to the field specified by Field within a data
 509                          structure of type TYPE.
 510
 511   @param  TYPE           The name of the data structure type to return  This
 512                          data structure must contain the field specified by Field.
 513
 514   @param  Field          The name of the field in the data structure specified
 515                          by TYPE to which Record points.
 516
 517   @param  TestSignature  The 32-bit signature value to match.
 518
 519 **/
 520 #ifdef EFI_DEBUG
 521   #define CR(Record, TYPE, Field, TestSignature)                                          \
 522     (DebugAssertEnabled () && (_CR (Record, TYPE, Field)->Signature != TestSignature)) ?  \
 523     (TYPE *) (_ASSERT (CR has Bad Signature), Record) :                                   \
 524     _CR (Record, TYPE, Field)
 525 #else
 526   #define CR(Record, TYPE, Field, TestSignature)                                          \
 527           _CR (Record, TYPE, Field)
 528 #endif
 529
 530
 531 #endif