EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Functions

VBoxPkg/Library/VBoxDebugLib/VBoxDebugLib.c File Reference

#include <Base.h>
#include <Library/PrintLib.h>
#include <Library/DebugLib.h>
#include "VBoxDebugLib.h"
#include "DevEFI.h"

Go to the source code of this file.

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)

Detailed Description

VBoxDebugLib.c - Debug logging and assertions support routines using DevEFI.

Definition in file VBoxDebugLib.c.


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

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.

Todo:
fix this.

Definition at line 67 of file VBoxDebugLib.c.

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 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 92 of file VBoxDebugLib.c.

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

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.

Definition at line 85 of file VBoxDebugLib.c.

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 PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUEThe DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
FALSEThe DEBUG_PROPERTY_DEBUG_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:
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 115 of file VBoxDebugLib.c.

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

Todo:
ditto

Definition at line 107 of file VBoxDebugLib.c.

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 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().

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

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.

Definition at line 31 of file VBoxDebugLib.c.

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

Todo:
some PCD for this so we can disable it in release builds.

Definition at line 99 of file VBoxDebugLib.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines