MdePkg/Include/Library/DebugLib.h File Reference


Defines

#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 _ASSERT(Expression)   DebugAssert (__FILE__, __LINE__, #Expression)
#define _DEBUG(Expression)   DebugPrint Expression
#define ASSERT(Expression)
#define DEBUG(Expression)
#define ASSERT_EFI_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 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 - 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define _ASSERT ( Expression   )     DebugAssert (__FILE__, __LINE__, #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:
Expression Boolean expression that evaluated to FALSE

#define _DEBUG ( Expression   )     DebugPrint Expression

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:
Expression Expression containing an error level, a format string, and a variable argument list based on the format string.

#define ASSERT ( Expression   ) 

Value:

do {                            \
      if (DebugAssertEnabled ()) {  \
        if (!(Expression)) {        \
          _ASSERT (Expression);     \
        }                           \
      }                             \
    } while (FALSE)
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:
Expression Boolean expression.

Referenced by _ModuleEntryPoint(), AcquireSpinLock(), AcquireSpinLockOrFail(), AllocateCopyPool(), ARShiftU64(), AsciiErrorPrint(), AsciiInternalPrint(), AsciiPrint(), AsciiPrintXY(), AsciiStrCat(), AsciiStrCmp(), AsciiStrCpy(), AsciiStrDecimalToUint64(), AsciiStrDecimalToUintn(), AsciiStrHexToUint64(), AsciiStrHexToUintn(), AsciiStriCmp(), AsciiStrLen(), AsciiStrnCat(), AsciiStrnCmp(), AsciiStrnCpy(), AsciiStrStr(), AsciiStrToUnicodeStr(), AsmDisablePaging32(), AsmDisablePaging64(), AsmEnablePaging32(), AsmEnablePaging64(), AsmFlushCacheRange(), AsmFxRestore(), AsmFxSave(), AsmGetThunk16Properties(), AsmMsrBitFieldAnd32(), AsmMsrBitFieldAndThenOr32(), AsmMsrBitFieldOr32(), AsmMsrBitFieldWrite32(), AsmPrepareThunk16(), AsmReadGdtr(), AsmReadIdtr(), AsmThunk16(), AsmWriteGdtr(), AsmWriteIdtr(), BasePrintLibConvertValueToString(), BasePrintLibSPrintMarker(), BcdToDecimal8(), BitFieldAnd16(), BitFieldAnd32(), BitFieldAnd64(), BitFieldAnd8(), BitFieldAndThenOr16(), BitFieldAndThenOr32(), BitFieldAndThenOr64(), BitFieldAndThenOr8(), BitFieldOr16(), BitFieldOr32(), BitFieldOr64(), BitFieldOr8(), BitFieldRead16(), BitFieldRead32(), BitFieldRead64(), BitFieldRead8(), BitFieldWrite16(), BitFieldWrite32(), BitFieldWrite64(), BitFieldWrite8(), BuildBspStoreHob(), BuildCpuHob(), BuildCvHob(), BuildFv2Hob(), BuildFvHob(), BuildGuidDataHob(), BuildGuidHob(), BuildMemoryAllocationHob(), BuildModuleHob(), BuildResourceDescriptorHob(), BuildResourceDescriptorWithOwnerHob(), BuildStackHob(), CalculateSum16(), CalculateSum32(), CalculateSum64(), CalculateSum8(), CatVSPrint(), CodeTypeToPostCode(), CompareMem(), CopyMem(), CpuFlushTlb(), CreatePopUp(), DebugClearMemory(), DebugPrint(), DecimalToBcd8(), DevicePathLibConstructor(), DevicePathNodeLength(), DevicePathSubType(), DevicePathType(), DevPathFromTextAcpiAdr(), DevPathToTextUri(), DevPathToTextUsbWWID(), DisableInterrupts(), DivS64x64Remainder(), DivU64x32(), DivU64x32Remainder(), DivU64x64Remainder(), DxePciSegmentLibPciRootBridgeIoReadWorker(), DxePciSegmentLibPciRootBridgeIoWriteWorker(), DxeRuntimeExtendedSalLibConstruct(), DxeRuntimeExtendedSalLibDeconstruct(), DxeServicesTableLibConstructor(), EfiAcquireLock(), EfiAcquireLockOrFail(), EfiCreateEventLegacyBootEx(), EfiCreateEventReadyToBootEx(), EfiCreateProtocolNotifyEvent(), EfiGetNameGuidFromFwVolDevicePathNode(), EfiGetSystemConfigurationTable(), EfiInitializeFwVolDevicepathNode(), EfiInitializeLock(), EfiLibInstallAllDriverProtocols(), EfiLibInstallAllDriverProtocols2(), EfiLibInstallDriverBinding(), EfiLibInstallDriverBindingComponentName2(), EfiNamedEventListen(), EfiNamedEventSignal(), EfiReleaseLock(), EfiTestChildHandle(), EfiTestManagedDevice(), EnableInterrupts(), ExtractGuidedSectionDecode(), ExtractGuidedSectionGetGuidList(), ExtractGuidedSectionGetHandlers(), ExtractGuidedSectionGetInfo(), ExtractGuidedSectionRegisterHandlers(), FileHandleFindFirstFile(), FileHandleFindNextFile(), FileHandleGetFileName(), FileHandleReadLine(), FreeAlignedPages(), FreePages(), GetBestLanguage(), GetFirstNode(), GetHobList(), GetInterruptState(), GetNextDevicePathInstance(), GetNextHob(), GetNextNode(), GetPcdInfoProtocolPointer(), GetPcdProtocol(), GetPciExpressAddress(), GetPeiServicesTablePointer(), GetPerformanceCounter(), GetPerformanceCounterProperties(), GetPerformanceMeasurement(), GetPerformanceMeasurementEx(), GetPiPcdInfoProtocolPointer(), GetPiPcdProtocol(), GetPreviousNode(), GetTimeInNanoSecond(), GetVariable(), GetVariable2(), HobLibConstructor(), InitializeListHead(), InitializeSpinLock(), InsertHeadList(), InsertTailList(), InterlockedCompareExchange16(), InterlockedCompareExchange32(), InterlockedCompareExchange64(), InterlockedCompareExchangePointer(), InterlockedDecrement(), InterlockedIncrement(), InternalAllocateAlignedPages(), InternalAllocateCopyPool(), InternalAssertJumpBuffer(), InternalBaseLibBitFieldAndUint(), InternalBaseLibBitFieldOrUint(), InternalBaseLibIsNodeInList(), InternalGetMemoryMapAddress(), InternalGetSectionFromFv(), InternalGetSmbusPpi(), InternalImageHandleToFvHandle(), InternalLongJump(), InternalPeiCreateHob(), InternalPeiServicesInstallFvInfoPpi(), InternalPrint(), InternalPrintGraphic(), InternalSaveIoWriteValueToBootScript(), InternalSaveMmioWriteValueToBootScript(), InternalSavePciWriteValueToBootScript(), InternalSaveSmBusExecToBootScript(), InternalSwitchStack(), InternalX86DisablePaging32(), InternalX86DisablePaging64(), InternalX86EnablePaging32(), InternalX86EnablePaging64(), InvalidateDataCache(), InvalidateDataCacheRange(), InvalidateInstructionCache(), InvalidateInstructionCacheRange(), IoRead16(), IoRead32(), IoRead64(), IoRead8(), IoReadWorker(), IoWrite16(), IoWrite32(), IoWrite64(), IoWrite8(), IoWriteWorker(), IsDevicePathEnd(), IsDevicePathEndInstance(), IsDevicePathEndType(), IsDevicePathValid(), IsListEmpty(), IsNodeAtEnd(), IsNull(), LibPatchPcdSetPtr(), LibPatchPcdSetPtrAndSize(), LibPatchPcdSetPtrAndSizeS(), LibPatchPcdSetPtrS(), LibPcdCallbackOnSet(), LibPcdCancelCallback(), LibPcdGet16(), LibPcdGet32(), LibPcdGet64(), LibPcdGet8(), LibPcdGetBool(), LibPcdGetEx16(), LibPcdGetEx32(), LibPcdGetEx64(), LibPcdGetEx8(), LibPcdGetExBool(), LibPcdGetExPtr(), LibPcdGetExSize(), LibPcdGetInfo(), LibPcdGetInfoEx(), LibPcdGetNextToken(), LibPcdGetNextTokenSpace(), LibPcdGetPtr(), LibPcdGetSize(), LibPcdGetSku(), LibPcdSet16(), LibPcdSet16S(), LibPcdSet32(), LibPcdSet32S(), LibPcdSet64(), LibPcdSet64S(), LibPcdSet8(), LibPcdSet8S(), LibPcdSetBool(), LibPcdSetBoolS(), LibPcdSetEx16(), LibPcdSetEx16S(), LibPcdSetEx32(), LibPcdSetEx32S(), LibPcdSetEx64(), LibPcdSetEx64S(), LibPcdSetEx8(), LibPcdSetEx8S(), LibPcdSetExBool(), LibPcdSetExBoolS(), LibPcdSetExPtr(), LibPcdSetExPtrS(), LibPcdSetPtr(), LibPcdSetPtrS(), LibPcdSetSku(), LongJump(), LRotU32(), LRotU64(), LShiftU64(), MakeTable(), MicroSecondDelay(), MigratePeiServicesTablePointer(), MmioRead16(), MmioRead32(), MmioRead64(), MmioRead8(), MmioReadBuffer16(), MmioReadBuffer32(), MmioReadBuffer64(), MmioReadBuffer8(), MmioReadWorker(), MmioWrite16(), MmioWrite32(), MmioWrite64(), MmioWrite8(), MmioWriteBuffer16(), MmioWriteBuffer32(), MmioWriteBuffer64(), MmioWriteBuffer8(), MmioWriteWorker(), ModU64x32(), NanoSecondDelay(), NextDevicePathNode(), OrderedCollectionDelete(), OrderedCollectionInsert(), OrderedCollectionUninit(), PalCall(), PciCf8ReadBuffer(), PciCf8WriteBuffer(), PciExpressReadBuffer(), PciExpressRegisterForRuntimeAccess(), PciExpressWriteBuffer(), PciLibConstructor(), PciReadBuffer(), PciSegmentLibConstructor(), PciSegmentReadBuffer(), PciSegmentWriteBuffer(), PciWriteBuffer(), PeCoffGetSizeOfHeaders(), PeCoffLoaderGetEntryPoint(), PeCoffLoaderGetMachineType(), PeCoffLoaderGetPdbPointer(), PeCoffLoaderImageReadFromMemory(), PeCoffLoaderLoadImage(), PeCoffLoaderRelocateImage(), PeCoffLoaderRelocateImageEx(), PeCoffLoaderRelocateImageExtraAction(), PeCoffLoaderRelocateImageForRuntime(), PeCoffLoaderUnloadImageExtraAction(), PeHotRelocateImageEx(), PeiPciLibPciCfg2ReadWorker(), PeiPciLibPciCfg2WriteWorker(), PeriodicSmiDispatchFunctionOnCpu(), PeriodicSmiExit(), PrintXY(), PublishSystemMemory(), ReadPTLen(), ReadUnaligned16(), ReadUnaligned24(), ReadUnaligned32(), ReadUnaligned64(), ReclaimPeriodicSmiLibraryHandler(), RedBlackTreeRecursiveCheck(), RedBlackTreeValidate(), ReleaseSpinLock(), RemoveEntryList(), ReportStatusCodeExtractDebugInfo(), ReportStatusCodeWithDevicePath(), ReportStatusCodeWithExtendedData(), RRotU32(), RRotU64(), RShiftU64(), RuntimeDriverLibConstruct(), RuntimeDriverLibDeconstruct(), S3MmioReadBuffer16(), S3MmioReadBuffer32(), S3MmioReadBuffer64(), S3MmioReadBuffer8(), S3MmioWriteBuffer16(), S3MmioWriteBuffer32(), S3MmioWriteBuffer64(), S3MmioWriteBuffer8(), S3PciReadBuffer(), S3PciWriteBuffer(), S3Stall(), ScanGuid(), ScanMem16(), ScanMem32(), ScanMem64(), ScanMem8(), ScsiInquiryCommandEx(), ScsiModeSense10Command(), ScsiRead10Command(), ScsiRead16Command(), ScsiReadCapacity16Command(), ScsiReadCapacityCommand(), ScsiRequestSenseCommand(), ScsiTestUnitReadyCommand(), ScsiWrite10Command(), ScsiWrite16Command(), SetDevicePathEndNode(), SetDevicePathNodeLength(), SetMem(), SetMem16(), SetMem32(), SetMem64(), SetPeiServicesTablePointer(), SmBusBlockProcessCall(), SmbusLibConstructor(), SmBusProcessCall(), SmBusQuickRead(), SmBusQuickWrite(), SmBusReadBlock(), SmBusReadDataByte(), SmBusReadDataWord(), SmBusReceiveByte(), SmBusSendByte(), SmBusWriteBlock(), SmBusWriteDataByte(), SmBusWriteDataWord(), SmmMemLibConstructor(), SmmMemLibInternalCalculateMaximumSupportAddress(), SmmMemoryAllocationLibConstructor(), SmmPeriodicSmiLibConstructor(), SmmServicesTableLibConstructor(), SPrintLength(), SPrintLengthAsciiFormat(), StrCat(), StrCatS(), StrCmp(), StrCpy(), StrCpyS(), StrDecimalToUint64(), StrDecimalToUintn(), StrHexToUint64(), StrHexToUintn(), StrLen(), StrnCat(), StrnCatGrowLeft(), StrnCatS(), StrnCmp(), StrnCpy(), StrnCpyS(), StrnLenS(), StrStr(), SwapListEntries(), SwitchStack(), UefiBootServicesTableLibConstructor(), UefiDecompress(), UefiDecompressGetInfo(), UefiDevicePathLibCatPrint(), UefiDevicePathLibConvertDeviceNodeToText(), UefiDevicePathLibConvertTextToDeviceNode(), UefiDevicePathLibConvertTextToDevicePath(), UefiDevicePathLibGetNextDevicePathInstance(), UefiDevicePathLibOptionalDevicePathProtocolConstructor(), UefiPalLibConstructor(), UefiRuntimeServicesTableLibConstructor(), UefiSalLibConstructor(), UnicodeStrToAsciiStr(), UsbClearEndpointHalt(), UsbClearFeature(), UsbGetConfiguration(), UsbGetDescriptor(), UsbGetHidDescriptor(), UsbGetIdleRequest(), UsbGetInterface(), UsbGetProtocolRequest(), UsbGetReportDescriptor(), UsbGetReportRequest(), UsbGetStatus(), UsbSetConfiguration(), UsbSetDescriptor(), UsbSetFeature(), UsbSetIdleRequest(), UsbSetInterface(), UsbSetProtocolRequest(), UsbSetReportRequest(), WriteBackDataCache(), WriteBackDataCacheRange(), WriteBackInvalidateDataCache(), WriteBackInvalidateDataCacheRange(), WriteUnaligned16(), WriteUnaligned24(), WriteUnaligned32(), WriteUnaligned64(), and ZeroMem().

#define ASSERT_EFI_ERROR ( StatusParameter   ) 

Value:

do {                                                                                 \
      if (DebugAssertEnabled ()) {                                                       \
        if (EFI_ERROR (StatusParameter)) {                                               \
          DEBUG ((EFI_D_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:
StatusParameter EFI_STATUS value to evaluate.

Referenced by _ModuleEntryPoint(), DevicePathLibConstructor(), DxeExtendedSalLibConstruct(), DxeRuntimeExtendedSalLibConstruct(), DxeRuntimeExtendedSalLibDeconstruct(), DxeRuntimePciExpressLibConstructor(), DxeRuntimePciExpressLibDestructor(), DxeSalLibInitialize(), DxeServicesTableLibConstructor(), EfiCreateProtocolNotifyEvent(), EfiLibInstallAllDriverProtocols(), EfiLibInstallAllDriverProtocols2(), EfiLibInstallDriverBinding(), EfiLibInstallDriverBindingComponentName2(), EfiNamedEventListen(), EfiNamedEventSignal(), FileHandleReadLine(), FileHandleReturnLine(), FileHandleWriteLine(), FreeAlignedPages(), FreePages(), FreePool(), GetBootModeHob(), GetHobList(), GetPcdInfoPpiPointer(), GetPcdInfoProtocolPointer(), GetPcdPpiPointer(), GetPcdProtocol(), GetPiPcdInfoPpiPointer(), GetPiPcdInfoProtocolPointer(), GetPiPcdPpiPointer(), GetPiPcdProtocol(), HobLibConstructor(), InternalAllocateAlignedPages(), InternalGetPciCfg2Ppi(), InternalGetSmbusPpi(), InternalImageHandleToFvHandle(), InternalPeiServicesInstallFvInfoPpi(), IoLibConstructor(), IoReadWorker(), IoWriteWorker(), LibPcdCallbackOnSet(), LibPcdCancelCallback(), LibPcdGetInfo(), LibPcdGetInfoEx(), MigratePeiServicesTablePointer(), MmioReadWorker(), MmioWriteWorker(), PalCall(), PciLibConstructor(), PciSegmentLibConstructor(), PeiPciLibPciCfg2ReadWorker(), PeiPciLibPciCfg2WriteWorker(), RuntimeDriverLibConstruct(), RuntimeDriverLibDeconstruct(), SmbusLibConstructor(), SmmMemLibConstructor(), SmmMemoryAllocationLibConstructor(), SmmPeriodicSmiLibConstructor(), SmmServicesTableLibConstructor(), UefiDevicePathLibOptionalDevicePathProtocolConstructor(), UefiPalLibConstructor(), and UefiSalLibConstructor().

#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)
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:
Handle The 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.
Guid The pointer to a protocol GUID.

#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)
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:
Record The pointer to the field specified by Field within a data structure of type TYPE.
TYPE The name of the data structure type to return This data structure must contain the field specified by Field.
Field The name of the field in the data structure specified by TYPE to which Record points.
TestSignature The 32-bit signature value to match.

#define DEBUG ( Expression   ) 

Value:

do {                           \
      if (DebugPrintEnabled ()) {  \
        _DEBUG (Expression);       \
      }                            \
    } while (FALSE)
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:
Expression Expression containing an error level, a format string, and a variable argument list based on the format string.

Referenced by __stack_chk_fail(), EfiCreateEventLegacyBootEx(), EfiCreateEventReadyToBootEx(), FileHandleReadLine(), InternalAllocateAlignedPages(), InternalHstiIsValidTable(), PeHotRelocateImageEx(), PostCode(), PostCodeWithDescription(), RedBlackTreeValidate(), SmmCopyMem(), SmmCopyMemFromSmram(), SmmCopyMemToSmram(), SmmIsBufferOutsideSmmValid(), SmmMemLibInternalCalculateMaximumSupportAddress(), and SmmSetMem().

#define DEBUG_BLKIO   0x00001000

#define DEBUG_BM   0x00000400

#define DEBUG_CACHE   0x00200000

#define DEBUG_CLEAR_MEMORY ( Address,
Length   ) 

Value:

do {                                       \
    if (DebugClearMemoryEnabled ()) {        \
      DebugClearMemory (Address, Length);    \
    }                                        \
  } while (FALSE)
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:
Address The pointer to a buffer.
Length The number of bytes in the buffer to set.

#define DEBUG_CODE ( Expression   ) 

Value:

DEBUG_CODE_BEGIN ();          \
  Expression                    \
  DEBUG_CODE_END ()
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.

 
#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.

 
#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.

#define DEBUG_DISPATCH   0x00000080

#define DEBUG_ERROR   0x80000000

Referenced by __stack_chk_fail().

#define DEBUG_EVENT   0x00080000

#define DEBUG_FS   0x00000008

#define DEBUG_GCD   0x00100000

#define DEBUG_INFO   0x00000040

#define DEBUG_INIT   0x00000001

#define DEBUG_LOAD   0x00000004

#define DEBUG_LOADFILE   0x00020000

#define DEBUG_NET   0x00004000

#define DEBUG_PAGE   0x00000020

#define DEBUG_POOL   0x00000010

#define DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED   0x10

Referenced by __stack_chk_fail(), and DebugAssert().

#define DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED   0x20

Referenced by __stack_chk_fail(), and DebugAssert().

#define DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED   0x08

Referenced by DebugClearMemoryEnabled().

#define DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED   0x01

Referenced by DebugAssertEnabled().

#define DEBUG_PROPERTY_DEBUG_CODE_ENABLED   0x04

Referenced by DebugCodeEnabled().

#define DEBUG_PROPERTY_DEBUG_PRINT_ENABLED   0x02

Referenced by DebugPrintEnabled().

#define DEBUG_UNDI   0x00010000

#define DEBUG_VARIABLE   0x00000100

#define DEBUG_VERBOSE   0x00400000

Referenced by RedBlackTreeValidate().

#define DEBUG_WARN   0x00000002

Referenced by FileHandleReadLine().

#define EFI_D_BLKIO   DEBUG_BLKIO

#define EFI_D_BM   DEBUG_BM

#define EFI_D_DISPATCH   DEBUG_DISPATCH

#define EFI_D_ERROR   DEBUG_ERROR

#define EFI_D_EVENT   DEBUG_EVENT

#define EFI_D_FS   DEBUG_FS

#define EFI_D_INFO   DEBUG_INFO

#define EFI_D_INIT   DEBUG_INIT

#define EFI_D_LOAD   DEBUG_LOAD

#define EFI_D_LOADFILE   DEBUG_LOADFILE

#define EFI_D_NET   DEBUG_NET

#define EFI_D_PAGE   DEBUG_PAGE

#define EFI_D_POOL   DEBUG_POOL

#define EFI_D_UNDI   DEBUG_UNDI

#define EFI_D_VARIABLE   DEBUG_VARIABLE

#define EFI_D_VERBOSE   DEBUG_VERBOSE

#define EFI_D_WARN   DEBUG_WARN


Function Documentation

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:
FileName The pointer to the name of the source file that generated the assert condition.
LineNumber The line number in the source file that generated the assert condition
Description The 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:
FileName The pointer to the name of the source file that generated the assert condition.
LineNumber The line number in the source file that generated the assert condition
Description The pointer to the description of the assert condition.

References AsciiSPrint(), AsciiStrLen(), EFI_SYSTEM_TABLE::ConOut, CpuBreakpoint(), CpuDeadLoop(), DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED, DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED, gST, MAX_DEBUG_MESSAGE_LENGTH, NULL, _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL::OutputString, PcdGet8, SerialPortWrite(), EFI_SYSTEM_TABLE::StdErr, and UnicodeSPrintAsciiFormat().

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:
TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
FALSE The 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 PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.

References DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED, FALSE, and PcdGet8.

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:
Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
Returns:
Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.

References ASSERT, NULL, PcdGet8, and SetMem().

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:
TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
FALSE The 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_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.

References DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED, FALSE, and PcdGet8.

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:
TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
FALSE The 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 PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.

References DEBUG_PROPERTY_DEBUG_CODE_ENABLED, FALSE, and PcdGet8.

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:
ErrorLevel The error level of the debug message.
Format The 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 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:
ErrorLevel The error level of the debug message.
Format Format 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:
ErrorLevel The error level of the debug message.
Format Format string for the debug message to print.
... A variable argument list whose contents are accessed based on the format string specified by Format.

References AsciiStrLen(), AsciiVSPrint(), ASSERT, EFI_SYSTEM_TABLE::ConOut, GetDebugPrintErrorLevel(), gST, MAX_DEBUG_MESSAGE_LENGTH, NULL, _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL::OutputString, SerialPortWrite(), EFI_SYSTEM_TABLE::StdErr, UnicodeVSPrintAsciiFormat(), VA_END, and VA_START.

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:
TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
FALSE The 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 PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.

References DEBUG_PROPERTY_DEBUG_PRINT_ENABLED, FALSE, and PcdGet8.

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:
TRUE Current ErrorLevel is supported.
FALSE Current ErrorLevel is not supported.

References FALSE, and PcdGet32.


Generated on Thu Sep 24 23:14:16 2015 for MdePkg[ALL] by  doxygen 1.5.7.1