TianoCore EDK2 master
DebugLib.h File Reference

Go to the source code of this file.

Macros

#define DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED   0x01
 
#define DEBUG_PROPERTY_DEBUG_PRINT_ENABLED   0x02
 
#define DEBUG_PROPERTY_DEBUG_CODE_ENABLED   0x04
 
#define DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED   0x08
 
#define DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED   0x10
 
#define DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED   0x20
 
#define DEBUG_INIT   0x00000001
 
#define DEBUG_WARN   0x00000002
 
#define DEBUG_LOAD   0x00000004
 
#define DEBUG_FS   0x00000008
 
#define DEBUG_POOL   0x00000010
 
#define DEBUG_PAGE   0x00000020
 
#define DEBUG_INFO   0x00000040
 
#define DEBUG_DISPATCH   0x00000080
 
#define DEBUG_VARIABLE   0x00000100
 
#define DEBUG_BM   0x00000400
 
#define DEBUG_BLKIO   0x00001000
 
#define DEBUG_NET   0x00004000
 
#define DEBUG_UNDI   0x00010000
 
#define DEBUG_LOADFILE   0x00020000
 
#define DEBUG_EVENT   0x00080000
 
#define DEBUG_GCD   0x00100000
 
#define DEBUG_CACHE   0x00200000
 
#define DEBUG_VERBOSE   0x00400000
 
#define DEBUG_ERROR   0x80000000
 
#define EFI_D_INIT   DEBUG_INIT
 
#define EFI_D_WARN   DEBUG_WARN
 
#define EFI_D_LOAD   DEBUG_LOAD
 
#define EFI_D_FS   DEBUG_FS
 
#define EFI_D_POOL   DEBUG_POOL
 
#define EFI_D_PAGE   DEBUG_PAGE
 
#define EFI_D_INFO   DEBUG_INFO
 
#define EFI_D_DISPATCH   DEBUG_DISPATCH
 
#define EFI_D_VARIABLE   DEBUG_VARIABLE
 
#define EFI_D_BM   DEBUG_BM
 
#define EFI_D_BLKIO   DEBUG_BLKIO
 
#define EFI_D_NET   DEBUG_NET
 
#define EFI_D_UNDI   DEBUG_UNDI
 
#define EFI_D_LOADFILE   DEBUG_LOADFILE
 
#define EFI_D_EVENT   DEBUG_EVENT
 
#define EFI_D_VERBOSE   DEBUG_VERBOSE
 
#define EFI_D_ERROR   DEBUG_ERROR
 
#define DEBUG_LINE_NUMBER   __LINE__
 
#define DEBUG_EXPRESSION_STRING(Expression)   #Expression
 
#define _ASSERT(Expression)   DebugAssert (__FILE__, DEBUG_LINE_NUMBER, DEBUG_EXPRESSION_STRING (Expression))
 
#define _DEBUG_PRINT(PrintLevel, ...)
 
#define _DEBUG(Expression)   _DEBUG_PRINT Expression
 
#define ASSERT(Expression)
 
#define DEBUG(Expression)
 
#define ASSERT_EFI_ERROR(StatusParameter)
 
#define ASSERT_RETURN_ERROR(StatusParameter)
 
#define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)
 
#define DEBUG_CODE_BEGIN()   do { if (DebugCodeEnabled ()) { UINT8 __DebugCodeLocal
 
#define DEBUG_CODE_END()   __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)
 
#define DEBUG_CODE(Expression)
 
#define DEBUG_CLEAR_MEMORY(Address, Length)
 
#define CR(Record, TYPE, Field, TestSignature)
 

Functions

VOID EFIAPI DebugPrint (IN UINTN ErrorLevel, IN CONST CHAR8 *Format,...)
 
VOID EFIAPI DebugVPrint (IN UINTN ErrorLevel, IN CONST CHAR8 *Format, IN VA_LIST VaListMarker)
 
VOID EFIAPI DebugBPrint (IN UINTN ErrorLevel, IN CONST CHAR8 *Format, IN BASE_LIST BaseListMarker)
 
VOID EFIAPI DebugAssert (IN CONST CHAR8 *FileName, IN UINTN LineNumber, IN CONST CHAR8 *Description)
 
VOID *EFIAPI DebugClearMemory (OUT VOID *Buffer, IN UINTN Length)
 
BOOLEAN EFIAPI DebugAssertEnabled (VOID)
 
BOOLEAN EFIAPI DebugPrintEnabled (VOID)
 
BOOLEAN EFIAPI DebugCodeEnabled (VOID)
 
BOOLEAN EFIAPI DebugClearMemoryEnabled (VOID)
 
BOOLEAN EFIAPI DebugPrintLevelEnabled (IN CONST UINTN ErrorLevel)
 

Detailed Description

Provides services to print debug and assert messages to a debug output device.

The Debug library supports debug print and asserts based on a combination of macros and code. The debug library can be turned on and off so that the debug code does not increase the size of an image.

Note that a reserved macro named MDEPKG_NDEBUG is introduced for the intention of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is defined, then debug and assert related macros wrapped by it are the NULL implementations.

Copyright (c) 2006 - 2020, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DebugLib.h.

Macro Definition Documentation

◆ _ASSERT

#define _ASSERT (   Expression)    DebugAssert (__FILE__, DEBUG_LINE_NUMBER, DEBUG_EXPRESSION_STRING (Expression))

Internal worker macro that calls DebugAssert().

This macro calls DebugAssert(), passing in the filename, line number, and an expression that evaluated to FALSE.

Parameters
ExpressionBoolean expression that evaluated to FALSE

Definition at line 349 of file DebugLib.h.

◆ _DEBUG

#define _DEBUG (   Expression)    _DEBUG_PRINT Expression

Definition at line 373 of file DebugLib.h.

◆ _DEBUG_PRINT

#define _DEBUG_PRINT (   PrintLevel,
  ... 
)
Value:
do { \
if (DebugPrintLevelEnabled (PrintLevel)) { \
DebugPrint (PrintLevel, ##__VA_ARGS__); \
} \
} while (FALSE)
#define FALSE
Definition: Base.h:307
BOOLEAN EFIAPI DebugPrintLevelEnabled(IN CONST UINTN ErrorLevel)
Definition: DebugLib.c:415

Internal worker macro that calls DebugPrint().

This macro calls DebugPrint() passing in the debug error level, a format string, and a variable argument list. VA_ARGS is not supported by EBC compiler, Microsoft Visual Studio .NET 2003 and Microsoft Windows Server 2003 Driver Development Kit (Microsoft WINDDK) version 3790.1830.

Parameters
ExpressionExpression containing an error level, a format string, and a variable argument list based on the format string.

Definition at line 367 of file DebugLib.h.

◆ ASSERT

#define ASSERT (   Expression)
Value:
do { \
if (DebugAssertEnabled ()) { \
if (!(Expression)) { \
_ASSERT (Expression); \
ANALYZER_UNREACHABLE (); \
} \
} \
} while (FALSE)
BOOLEAN EFIAPI DebugAssertEnabled(VOID)
Definition: DebugLib.c:261

Macro that calls DebugAssert() if an expression evaluates to FALSE.

If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, then this macro evaluates the Boolean expression specified by Expression. If Expression evaluates to FALSE, then DebugAssert() is called passing in the source filename, source line number, and Expression.

Parameters
ExpressionBoolean expression.

Definition at line 391 of file DebugLib.h.

◆ ASSERT_EFI_ERROR

#define ASSERT_EFI_ERROR (   StatusParameter)
Value:
do { \
if (DebugAssertEnabled ()) { \
if (EFI_ERROR (StatusParameter)) { \
DEBUG ((DEBUG_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter)); \
_ASSERT (!EFI_ERROR (StatusParameter)); \
} \
} \
} while (FALSE)

Macro that calls DebugAssert() if an EFI_STATUS evaluates to an error code.

If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, then this macro evaluates the EFI_STATUS value specified by StatusParameter. If StatusParameter is an error code, then DebugAssert() is called passing in the source filename, source line number, and StatusParameter.

Parameters
StatusParameterEFI_STATUS value to evaluate.

Definition at line 440 of file DebugLib.h.

◆ ASSERT_PROTOCOL_ALREADY_INSTALLED

#define ASSERT_PROTOCOL_ALREADY_INSTALLED (   Handle,
  Guid 
)
Value:
do { \
if (DebugAssertEnabled ()) { \
VOID *Instance; \
ASSERT (Guid != NULL); \
if (Handle == NULL) { \
if (!EFI_ERROR (gBS->LocateProtocol ((EFI_GUID *)Guid, NULL, &Instance))) { \
_ASSERT (Guid already installed in database); \
} \
} else { \
if (!EFI_ERROR (gBS->HandleProtocol (Handle, (EFI_GUID *)Guid, &Instance))) { \
_ASSERT (Guid already installed on Handle); \
} \
} \
} \
} while (FALSE)
#define NULL
Definition: Base.h:312
EFI_BOOT_SERVICES * gBS
Definition: Base.h:213

Macro that calls DebugAssert() if a protocol is already installed in the handle database.

If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear, then return.

If Handle is NULL, then a check is made to see if the protocol specified by Guid is present on any handle in the handle database. If Handle is not NULL, then a check is made to see if the protocol specified by Guid is present on the handle specified by Handle. If the check finds the protocol, then DebugAssert() is called passing in the source filename, source line number, and Guid.

If Guid is NULL, then ASSERT().

Parameters
HandleThe handle to check for the protocol. This is an optional parameter that may be NULL. If it is NULL, then the entire handle database is searched.
GuidThe pointer to a protocol GUID.

Definition at line 503 of file DebugLib.h.

◆ ASSERT_RETURN_ERROR

#define ASSERT_RETURN_ERROR (   StatusParameter)
Value:
do { \
if (DebugAssertEnabled ()) { \
if (RETURN_ERROR (StatusParameter)) { \
DEBUG ((DEBUG_ERROR, "\nASSERT_RETURN_ERROR (Status = %r)\n", \
StatusParameter)); \
_ASSERT (!RETURN_ERROR (StatusParameter)); \
} \
} \
} while (FALSE)
#define RETURN_ERROR(StatusCode)
Definition: Base.h:957

Macro that calls DebugAssert() if a RETURN_STATUS evaluates to an error code.

If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, then this macro evaluates the RETURN_STATUS value specified by StatusParameter. If StatusParameter is an error code, then DebugAssert() is called passing in the source filename, source line number, and StatusParameter.

Parameters
StatusParameterRETURN_STATUS value to evaluate.

Definition at line 466 of file DebugLib.h.

◆ CR

#define CR (   Record,
  TYPE,
  Field,
  TestSignature 
)
Value:
(DebugAssertEnabled () && (BASE_CR (Record, TYPE, Field)->Signature != TestSignature)) ? \
(TYPE *) (_ASSERT (CR has Bad Signature), Record) : \
BASE_CR (Record, TYPE, Field)
#define BASE_CR(Record, TYPE, Field)
Definition: Base.h:830
#define _ASSERT(Expression)
Definition: DebugLib.h:349
#define CR(Record, TYPE, Field, TestSignature)
Definition: DebugLib.h:618

Macro that calls DebugAssert() if the containing record does not have a matching signature. If the signatures matches, then a pointer to the data structure that contains a specified field of that data structure is returned. This is a lightweight method hide information by placing a public data structure inside a larger private data structure and using a pointer to the public data structure to retrieve a pointer to the private data structure.

If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear, then this macro computes the offset, in bytes, of the field specified by Field from the beginning of the data structure specified by TYPE. This offset is subtracted from Record, and is used to return a pointer to a data structure of the type specified by TYPE.

If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, then this macro computes the offset, in bytes, of field specified by Field from the beginning of the data structure specified by TYPE. This offset is subtracted from Record, and is used to compute a pointer to a data structure of the type specified by TYPE. The Signature field of the data structure specified by TYPE is compared to TestSignature. If the signatures match, then a pointer to the pointer to a data structure of the type specified by TYPE is returned. If the signatures do not match, then DebugAssert() is called with a description of "CR has a bad signature" and Record is returned.

If the data type specified by TYPE does not contain the field specified by Field, then the module will not compile.

If TYPE does not contain a field called Signature, then the module will not compile.

Parameters
RecordThe pointer to the field specified by Field within a data structure of type TYPE.
TYPEThe name of the data structure type to return This data structure must contain the field specified by Field.
FieldThe name of the field in the data structure specified by TYPE to which Record points.
TestSignatureThe 32-bit signature value to match.

Definition at line 618 of file DebugLib.h.

◆ DEBUG

#define DEBUG (   Expression)
Value:
do { \
if (DebugPrintEnabled ()) { \
_DEBUG (Expression); \
} \
} while (FALSE)
BOOLEAN EFIAPI DebugPrintEnabled(VOID)
Definition: DebugLib.c:281

Macro that calls DebugPrint().

If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set, then this macro passes Expression to DebugPrint().

Parameters
ExpressionExpression containing an error level, a format string, and a variable argument list based on the format string.

Definition at line 417 of file DebugLib.h.

◆ DEBUG_BLKIO

#define DEBUG_BLKIO   0x00001000

Definition at line 42 of file DebugLib.h.

◆ DEBUG_BM

#define DEBUG_BM   0x00000400

Definition at line 41 of file DebugLib.h.

◆ DEBUG_CACHE

#define DEBUG_CACHE   0x00200000

Definition at line 48 of file DebugLib.h.

◆ DEBUG_CLEAR_MEMORY

#define DEBUG_CLEAR_MEMORY (   Address,
  Length 
)
Value:
do { \
DebugClearMemory (Address, Length); \
} \
} while (FALSE)
BOOLEAN EFIAPI DebugClearMemoryEnabled(VOID)
Definition: DebugLib.c:321

The macro that calls DebugClearMemory() to clear a buffer to a default value.

If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set, then this macro calls DebugClearMemory() passing in Address and Length.

Parameters
AddressThe pointer to a buffer.
LengthThe number of bytes in the buffer to set.

Definition at line 568 of file DebugLib.h.

◆ DEBUG_CODE

#define DEBUG_CODE (   Expression)
Value:
#define DEBUG_CODE_BEGIN()
Definition: DebugLib.h:532
#define DEBUG_CODE_END()
Definition: DebugLib.h:543

The macro that declares a section of debug source code.

If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, then the source code specified by Expression is included in a module. Otherwise, the source specified by Expression is not included in a module.

Definition at line 553 of file DebugLib.h.

◆ DEBUG_CODE_BEGIN

#define DEBUG_CODE_BEGIN ( )    do { if (DebugCodeEnabled ()) { UINT8 __DebugCodeLocal

Macro that marks the beginning of debug source code.

If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, then this macro marks the beginning of source code that is included in a module. Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END() are not included in a module.

Definition at line 532 of file DebugLib.h.

◆ DEBUG_CODE_END

#define DEBUG_CODE_END ( )    __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)

The macro that marks the end of debug source code.

If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, then this macro marks the end of source code that is included in a module. Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END() are not included in a module.

Definition at line 543 of file DebugLib.h.

◆ DEBUG_DISPATCH

#define DEBUG_DISPATCH   0x00000080

Definition at line 39 of file DebugLib.h.

◆ DEBUG_ERROR

#define DEBUG_ERROR   0x80000000

Definition at line 51 of file DebugLib.h.

◆ DEBUG_EVENT

#define DEBUG_EVENT   0x00080000

Definition at line 46 of file DebugLib.h.

◆ DEBUG_EXPRESSION_STRING

#define DEBUG_EXPRESSION_STRING (   Expression)    #Expression

Macro that converts a Boolean expression to a Null-terminated ASCII string.

The default is to use the C pre-processor stringizing operator '#' to add quotes around the C expression. If DEBUG_EXPRESSION_STRING_VALUE is defined then the C expression is converted to the fixed string value.

Defining DEBUG_EXPRESSION_STRING_VALUE to a fixed value is useful when comparing builds across source code formatting changes that may make changes to spaces or parenthesis in a Boolean expression.

Parameters
ExpressionBoolean expression.

Definition at line 106 of file DebugLib.h.

◆ DEBUG_FS

#define DEBUG_FS   0x00000008

Definition at line 35 of file DebugLib.h.

◆ DEBUG_GCD

#define DEBUG_GCD   0x00100000

Definition at line 47 of file DebugLib.h.

◆ DEBUG_INFO

#define DEBUG_INFO   0x00000040

Definition at line 38 of file DebugLib.h.

◆ DEBUG_INIT

#define DEBUG_INIT   0x00000001

Definition at line 32 of file DebugLib.h.

◆ DEBUG_LINE_NUMBER

#define DEBUG_LINE_NUMBER   __LINE__

Definition at line 85 of file DebugLib.h.

◆ DEBUG_LOAD

#define DEBUG_LOAD   0x00000004

Definition at line 34 of file DebugLib.h.

◆ DEBUG_LOADFILE

#define DEBUG_LOADFILE   0x00020000

Definition at line 45 of file DebugLib.h.

◆ DEBUG_NET

#define DEBUG_NET   0x00004000

Definition at line 43 of file DebugLib.h.

◆ DEBUG_PAGE

#define DEBUG_PAGE   0x00000020

Definition at line 37 of file DebugLib.h.

◆ DEBUG_POOL

#define DEBUG_POOL   0x00000010

Definition at line 36 of file DebugLib.h.

◆ DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED

#define DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED   0x10

Definition at line 26 of file DebugLib.h.

◆ DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED

#define DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED   0x20

Definition at line 27 of file DebugLib.h.

◆ DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED

#define DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED   0x08

Definition at line 25 of file DebugLib.h.

◆ DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED

#define DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED   0x01

Definition at line 22 of file DebugLib.h.

◆ DEBUG_PROPERTY_DEBUG_CODE_ENABLED

#define DEBUG_PROPERTY_DEBUG_CODE_ENABLED   0x04

Definition at line 24 of file DebugLib.h.

◆ DEBUG_PROPERTY_DEBUG_PRINT_ENABLED

#define DEBUG_PROPERTY_DEBUG_PRINT_ENABLED   0x02

Definition at line 23 of file DebugLib.h.

◆ DEBUG_UNDI

#define DEBUG_UNDI   0x00010000

Definition at line 44 of file DebugLib.h.

◆ DEBUG_VARIABLE

#define DEBUG_VARIABLE   0x00000100

Definition at line 40 of file DebugLib.h.

◆ DEBUG_VERBOSE

#define DEBUG_VERBOSE   0x00400000

Definition at line 49 of file DebugLib.h.

◆ DEBUG_WARN

#define DEBUG_WARN   0x00000002

Definition at line 33 of file DebugLib.h.

◆ EFI_D_BLKIO

#define EFI_D_BLKIO   DEBUG_BLKIO

Definition at line 66 of file DebugLib.h.

◆ EFI_D_BM

#define EFI_D_BM   DEBUG_BM

Definition at line 65 of file DebugLib.h.

◆ EFI_D_DISPATCH

#define EFI_D_DISPATCH   DEBUG_DISPATCH

Definition at line 63 of file DebugLib.h.

◆ EFI_D_ERROR

#define EFI_D_ERROR   DEBUG_ERROR

Definition at line 72 of file DebugLib.h.

◆ EFI_D_EVENT

#define EFI_D_EVENT   DEBUG_EVENT

Definition at line 70 of file DebugLib.h.

◆ EFI_D_FS

#define EFI_D_FS   DEBUG_FS

Definition at line 59 of file DebugLib.h.

◆ EFI_D_INFO

#define EFI_D_INFO   DEBUG_INFO

Definition at line 62 of file DebugLib.h.

◆ EFI_D_INIT

#define EFI_D_INIT   DEBUG_INIT

Definition at line 56 of file DebugLib.h.

◆ EFI_D_LOAD

#define EFI_D_LOAD   DEBUG_LOAD

Definition at line 58 of file DebugLib.h.

◆ EFI_D_LOADFILE

#define EFI_D_LOADFILE   DEBUG_LOADFILE

Definition at line 69 of file DebugLib.h.

◆ EFI_D_NET

#define EFI_D_NET   DEBUG_NET

Definition at line 67 of file DebugLib.h.

◆ EFI_D_PAGE

#define EFI_D_PAGE   DEBUG_PAGE

Definition at line 61 of file DebugLib.h.

◆ EFI_D_POOL

#define EFI_D_POOL   DEBUG_POOL

Definition at line 60 of file DebugLib.h.

◆ EFI_D_UNDI

#define EFI_D_UNDI   DEBUG_UNDI

Definition at line 68 of file DebugLib.h.

◆ EFI_D_VARIABLE

#define EFI_D_VARIABLE   DEBUG_VARIABLE

Definition at line 64 of file DebugLib.h.

◆ EFI_D_VERBOSE

#define EFI_D_VERBOSE   DEBUG_VERBOSE

Definition at line 71 of file DebugLib.h.

◆ EFI_D_WARN

#define EFI_D_WARN   DEBUG_WARN

Definition at line 57 of file DebugLib.h.

Function Documentation

◆ DebugAssert()

VOID EFIAPI DebugAssert ( IN CONST CHAR8 FileName,
IN UINTN  LineNumber,
IN CONST CHAR8 Description 
)

Prints an assert message containing a filename, line number, and description. This may be followed by a breakpoint or a dead loop.

Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then CpuDeadLoop() is called. If neither of these bits are set, then this function returns immediately after the message is printed to the debug output device. DebugAssert() must actively prevent recursion. If DebugAssert() is called while processing another DebugAssert(), then DebugAssert() must return immediately.

If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed. If Description is NULL, then a string of "(NULL) Description" is printed.

Parameters
FileNameThe pointer to the name of the source file that generated the assert condition.
LineNumberThe line number in the source file that generated the assert condition
DescriptionThe pointer to the description of the assert condition.

Prints an assert message containing a filename, line number, and description. This may be followed by a breakpoint or a dead loop.

Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of PcdDebugPropertyMask is set then CpuBreakpoint() is called. Otherwise, if DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugPropertyMask is set then CpuDeadLoop() is called. If neither of these bits are set, then this function returns immediately after the message is printed to the debug output device. DebugAssert() must actively prevent recursion. If DebugAssert() is called while processing another DebugAssert(), then DebugAssert() must return immediately.

If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.

If Description is NULL, then a string of "(NULL) Description" is printed.

Parameters
FileNamePointer to the name of the source file that generated the assert condition.
LineNumberThe line number in the source file that generated the assert condition
DescriptionPointer to the description of the assert condition.

Prints an assert message containing a filename, line number, and description. This may be followed by a breakpoint or a dead loop.

Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of PcdDebugPropertyMask is set then CpuBreakpoint() is called. Otherwise, if DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugPropertyMask is set then CpuDeadLoop() is called. If neither of these bits are set, then this function returns immediately after the message is printed to the debug output device. DebugAssert() must actively prevent recursion. If DebugAssert() is called while processing another DebugAssert(), then DebugAssert() must return immediately.

If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed. If Description is NULL, then a string of "(NULL) Description" is printed.

Parameters
FileNameThe pointer to the name of the source file that generated the assert condition.
LineNumberThe line number in the source file that generated the assert condition
DescriptionThe pointer to the description of the assert condition.

Prints an assert message containing a filename, line number, and description. This may be followed by a breakpoint or a dead loop.

Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then CpuDeadLoop() is called. If neither of these bits are set, then this function returns immediately after the message is printed to the debug output device. DebugAssert() must actively prevent recursion. If DebugAssert() is called while processing another DebugAssert(), then DebugAssert() must return immediately.

If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed. If Description is NULL, then a string of "(NULL) Description" is printed.

Parameters
FileNamePointer to the name of the source file that generated the assert condition.
LineNumberThe line number in the source file that generated the assert condition
DescriptionPointer to the description of the assert condition.

Definition at line 188 of file DebugLib.c.

◆ DebugAssertEnabled()

BOOLEAN EFIAPI DebugAssertEnabled ( VOID  )

Returns TRUE if ASSERT() macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set. Otherwise, FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.

Returns TRUE if ASSERT() macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugPropertyMask is set. Otherwise FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugPropertyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugPropertyMask is clear.

Returns TRUE if ASSERT() macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.

Definition at line 261 of file DebugLib.c.

◆ DebugBPrint()

VOID EFIAPI DebugBPrint ( IN UINTN  ErrorLevel,
IN CONST CHAR8 Format,
IN BASE_LIST  BaseListMarker 
)

Prints a debug message to the debug output device if the specified error level is enabled. This function use BASE_LIST which would provide a more compatible service than VA_LIST.

If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function GetDebugPrintErrorLevel (), then print the message specified by Format and the associated variable argument list to the debug output device.

If Format is NULL, then ASSERT().

Parameters
ErrorLevelThe error level of the debug message.
FormatFormat string for the debug message to print.
BaseListMarkerBASE_LIST marker for the variable argument list.

Definition at line 154 of file DebugLib.c.

◆ DebugClearMemory()

VOID *EFIAPI DebugClearMemory ( OUT VOID Buffer,
IN UINTN  Length 
)

Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.

This function fills Length bytes of Buffer with the value specified by PcdDebugClearMemoryValue, and returns Buffer.

If Buffer is NULL, then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters
BufferThe pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
LengthThe number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
Returns
Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.

Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.

This function fills Length bytes of Buffer with the value specified by PcdDebugClearMemoryValue, and returns Buffer.

If Buffer is NULL, then ASSERT().

If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().

Parameters
BufferPointer to the target buffer to fill with PcdDebugClearMemoryValue.
LengthNumber of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
Returns
Buffer

Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.

This function fills Length bytes of Buffer with the value specified by PcdDebugClearMemoryValue, and returns Buffer.

If Buffer is NULL, then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters
BufferPointer to the target buffer to be filled with PcdDebugClearMemoryValue.
LengthNumber of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
Returns
Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.

Definition at line 232 of file DebugLib.c.

◆ DebugClearMemoryEnabled()

BOOLEAN EFIAPI DebugClearMemoryEnabled ( VOID  )

Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.

This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set. Otherwise, FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
FALSEThe DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.

Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is set. Otherwise FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is clear.

Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.

This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is set. Otherwise FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is set.
FALSEThe DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is clear.

Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.

This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
FALSEThe DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.

Definition at line 321 of file DebugLib.c.

◆ DebugCodeEnabled()

BOOLEAN EFIAPI DebugCodeEnabled ( VOID  )

Returns TRUE if DEBUG_CODE() macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set. Otherwise, FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.

Returns TRUE if DEBUG_CODE()macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is set. Otherwise FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is clear.

Returns TRUE if DEBUG_CODE() macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is set. Otherwise FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is clear.

Returns TRUE if DEBUG_CODE() macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.

Definition at line 301 of file DebugLib.c.

◆ DebugPrint()

VOID EFIAPI DebugPrint ( IN UINTN  ErrorLevel,
IN CONST CHAR8 Format,
  ... 
)

Prints a debug message to the debug output device if the specified error level is enabled.

If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function GetDebugPrintErrorLevel (), then print the message specified by Format and the associated variable argument list to the debug output device.

If Format is NULL, then ASSERT().

Parameters
ErrorLevelThe error level of the debug message.
FormatThe format string for the debug message to print.
...The variable argument list whose contents are accessed based on the format string specified by Format.

Prints a debug message to the debug output device if the specified error level is enabled.

If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print the message specified by Format and the associated variable argument list to the debug output device.

If Format is NULL, then ASSERT().

Parameters
ErrorLevelThe error level of the debug message.
FormatFormat string for the debug message to print.

Prints a debug message to the debug output device if the specified error level is enabled.

If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function GetDebugPrintErrorLevel (), then print the message specified by Format and the associated variable argument list to the debug output device.

If Format is NULL, then ASSERT().

Parameters
ErrorLevelThe error level of the debug message.
FormatFormat string for the debug message to print.
...Variable argument list whose contents are accessed based on the format string specified by Format.

Prints a debug message to the debug output device if the specified error level is enabled.

If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function GetDebugPrintErrorLevel (), then print the message specified by Format and the associated variable argument list to the debug output device.

If Format is NULL, then ASSERT().

If the length of the message string specificed by Format is larger than the maximum allowable record length, then directly return and not print it.

Parameters
ErrorLevelThe error level of the debug message.
FormatFormat string for the debug message to print.
...Variable argument list whose contents are accessed based on the format string specified by Format.

Prints a debug message to the debug output device if the specified error level is enabled.

If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function GetDebugPrintErrorLevel (), then print the message specified by Format and the associated variable argument list to the debug output device.

If Format is NULL, then ASSERT().

Parameters
ErrorLevelThe error level of the debug message.
FormatFormat string for the debug message to print.
...A variable argument list whose contents are accessed based on the format string specified by Format.

Definition at line 45 of file DebugLib.c.

◆ DebugPrintEnabled()

BOOLEAN EFIAPI DebugPrintEnabled ( VOID  )

Returns TRUE if DEBUG() macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set. Otherwise, FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.

Returns TRUE if DEBUG()macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is set. Otherwise FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is clear.

Returns TRUE if DEBUG() macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is set. Otherwise FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is clear.

Returns TRUE if DEBUG() macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values
TRUEThe DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.

Definition at line 281 of file DebugLib.c.

◆ DebugPrintLevelEnabled()

BOOLEAN EFIAPI DebugPrintLevelEnabled ( IN CONST UINTN  ErrorLevel)

Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.

This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.

Return values
TRUECurrent ErrorLevel is supported.
FALSECurrent ErrorLevel is not supported.

Definition at line 415 of file DebugLib.c.

◆ DebugVPrint()

VOID EFIAPI DebugVPrint ( IN UINTN  ErrorLevel,
IN CONST CHAR8 Format,
IN VA_LIST  VaListMarker 
)

Prints a debug message to the debug output device if the specified error level is enabled.

If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function GetDebugPrintErrorLevel (), then print the message specified by Format and the associated variable argument list to the debug output device.

If Format is NULL, then ASSERT().

Parameters
ErrorLevelThe error level of the debug message.
FormatFormat string for the debug message to print.
VaListMarkerVA_LIST marker for the variable argument list.

Definition at line 126 of file DebugLib.c.