/** @file\r
Debug Library based on report status code library.\r
\r
- Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
+ Note that if the debug message length is larger than the maximum allowable\r
+ record length, then the debug message will be ignored directly.\r
+\r
+ Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
+ This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
**/\r
\r
-#include <FrameworkPei.h>\r
+#include <PiPei.h>\r
\r
#include <Guid/StatusCodeDataTypeId.h>\r
#include <Guid/StatusCodeDataTypeDebug.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/PcdLib.h>\r
+#include <Library/DebugPrintErrorLevelLib.h>\r
\r
/**\r
Prints a debug message to the debug output device if the specified error level is enabled.\r
\r
- If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print \r
- the message specified by Format and the associated variable argument list to \r
- the debug output device.\r
+ If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function \r
+ GetDebugPrintErrorLevel (), then print the message specified by Format and the \r
+ associated variable argument list to the debug output device.\r
\r
If Format is NULL, then ASSERT().\r
\r
+ If the length of the message string specificed by Format is larger than the maximum allowable\r
+ record length, then directly return and not print it.\r
+\r
@param ErrorLevel The error level of the debug message.\r
@param Format Format string for the debug message to print.\r
@param ... Variable argument list whose contents are accessed \r
UINT64 Buffer[(EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof (UINT64)) + 1];\r
EFI_DEBUG_INFO *DebugInfo;\r
UINTN TotalSize;\r
+ UINTN DestBufferSize;\r
VA_LIST VaListMarker;\r
BASE_LIST BaseListMarker;\r
CHAR8 *FormatString;\r
BOOLEAN Long;\r
- BOOLEAN Done;\r
\r
//\r
// If Format is NULL, then ASSERT().\r
//\r
// Check driver Debug Level value and global debug level\r
//\r
- if ((ErrorLevel & PcdGet32 (PcdDebugPrintErrorLevel)) == 0) {\r
+ if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {\r
return;\r
}\r
\r
// the following layout:\r
//\r
// Buffer->|------------------------|\r
- // | Pading | 4 bytes\r
+ // | Padding | 4 bytes\r
// DebugInfo->|------------------------|\r
// | EFI_DEBUG_INFO | sizeof(EFI_DEBUG_INFO)\r
// BaseListMarker->|------------------------|\r
// Here we skip the first 4 bytes of Buffer, because we must ensure BaseListMarker is\r
// 64-bit aligned, otherwise retrieving 64-bit parameter from BaseListMarker will cause\r
// exception on IPF. Buffer starts at 64-bit aligned address, so skipping 4 types (sizeof(EFI_DEBUG_INFO))\r
- // just makes addess of BaseListMarker, which follows DebugInfo, 64-bit aligned.\r
+ // just makes address of BaseListMarker, which follows DebugInfo, 64-bit aligned.\r
//\r
DebugInfo = (EFI_DEBUG_INFO *)(Buffer) + 1;\r
DebugInfo->ErrorLevel = (UINT32)ErrorLevel;\r
//\r
// Copy the Format string into the record\r
//\r
- AsciiStrCpy (FormatString, Format);\r
+ // According to the content structure of Buffer shown above, the size of\r
+ // the FormatString buffer is the size of Buffer minus the Padding\r
+ // (4 bytes), minus the size of EFI_DEBUG_INFO, minus the size of\r
+ // variable arguments (12 * sizeof (UINT64)).\r
+ //\r
+ DestBufferSize = sizeof (Buffer) - 4 - sizeof (EFI_DEBUG_INFO) - 12 * sizeof (UINT64);\r
+ AsciiStrCpyS (FormatString, DestBufferSize / sizeof (CHAR8), Format);\r
\r
//\r
// The first 12 * sizeof (UINT64) bytes following EFI_DEBUG_INFO are for variable arguments\r
//\r
// Parse Flags and Width\r
//\r
- for (Done = FALSE; !Done; ) {\r
- Format++;\r
- switch (*Format) {\r
- case '.': \r
- case '-': \r
- case '+': \r
- case ' ': \r
- case ',': \r
- case '0':\r
- case '1':\r
- case '2':\r
- case '3':\r
- case '4':\r
- case '5':\r
- case '6':\r
- case '7':\r
- case '8':\r
- case '9':\r
+ for (Format++; TRUE; Format++) {\r
+ if (*Format == '.' || *Format == '-' || *Format == '+' || *Format == ' ') {\r
//\r
// These characters in format field are omitted.\r
//\r
- break;\r
- case 'L':\r
- case 'l': \r
+ continue;\r
+ }\r
+ if (*Format >= '0' && *Format <= '9') {\r
+ //\r
+ // These characters in format field are omitted.\r
+ //\r
+ continue;\r
+ }\r
+ if (*Format == 'L' || *Format == 'l') {\r
//\r
// 'L" or "l" in format field means the number being printed is a UINT64\r
//\r
Long = TRUE;\r
- break;\r
- case '*':\r
+ continue;\r
+ }\r
+ if (*Format == '*') {\r
//\r
// '*' in format field means the precision of the field is specified by\r
// a UINTN argument in the argument list.\r
//\r
BASE_ARG (BaseListMarker, UINTN) = VA_ARG (VaListMarker, UINTN);\r
- break;\r
- case '\0':\r
+ continue;\r
+ }\r
+ if (*Format == '\0') {\r
//\r
// Make no output if Format string terminates unexpectedly when\r
// looking up for flag, width, precision and type. \r
//\r
Format--;\r
- //\r
- // break skipped on purpose.\r
- //\r
- default:\r
- //\r
- // When valid argument type detected or format string terminates unexpectedly,\r
- // the inner loop is done.\r
- //\r
- Done = TRUE;\r
- break;\r
}\r
- } \r
- \r
+ //\r
+ // When valid argument type detected or format string terminates unexpectedly,\r
+ // the inner loop is done.\r
+ //\r
+ break;\r
+ }\r
+ \r
//\r
// Pack variable arguments into the storage area following EFI_DEBUG_INFO.\r
//\r
- switch (*Format) {\r
- case 'p':\r
- if (sizeof (VOID *) > 4) {\r
- Long = TRUE;\r
- }\r
- case 'X':\r
- case 'x':\r
- case 'd':\r
+ if ((*Format == 'p') && (sizeof (VOID *) > 4)) {\r
+ Long = TRUE;\r
+ }\r
+ if (*Format == 'p' || *Format == 'X' || *Format == 'x' || *Format == 'd' || *Format == 'u') {\r
if (Long) {\r
BASE_ARG (BaseListMarker, INT64) = VA_ARG (VaListMarker, INT64);\r
} else {\r
BASE_ARG (BaseListMarker, int) = VA_ARG (VaListMarker, int);\r
}\r
- break;\r
- case 's':\r
- case 'S':\r
- case 'a':\r
- case 'g':\r
- case 't':\r
+ } else if (*Format == 's' || *Format == 'S' || *Format == 'a' || *Format == 'g' || *Format == 't') {\r
BASE_ARG (BaseListMarker, VOID *) = VA_ARG (VaListMarker, VOID *);\r
- break;\r
- case 'c':\r
+ } else if (*Format == 'c') {\r
BASE_ARG (BaseListMarker, UINTN) = VA_ARG (VaListMarker, UINTN);\r
- break;\r
- case 'r':\r
+ } else if (*Format == 'r') {\r
BASE_ARG (BaseListMarker, RETURN_STATUS) = VA_ARG (VaListMarker, RETURN_STATUS);\r
- break;\r
}\r
\r
//\r
// If the converted BASE_LIST is larger than the 12 * sizeof (UINT64) allocated bytes, then return\r
//\r
if ((CHAR8 *)BaseListMarker > FormatString) {\r
+ VA_END (VaListMarker);\r
return;\r
}\r
}\r
{\r
UINT64 Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof(UINT64)];\r
EFI_DEBUG_ASSERT_DATA *AssertData;\r
+ UINTN HeaderSize;\r
UINTN TotalSize;\r
CHAR8 *Temp;\r
+ UINTN ModuleNameSize;\r
UINTN FileNameSize;\r
UINTN DescriptionSize;\r
\r
//\r
- // Make sure it will all fit in the passed in buffer\r
+ // Get string size\r
//\r
- FileNameSize = AsciiStrSize (FileName);\r
- DescriptionSize = AsciiStrSize (Description);\r
- TotalSize = sizeof (EFI_DEBUG_ASSERT_DATA) + FileNameSize + DescriptionSize;\r
- if (TotalSize <= sizeof (Buffer)) {\r
- //\r
- // Fill in EFI_DEBUG_ASSERT_DATA\r
- //\r
- AssertData = (EFI_DEBUG_ASSERT_DATA *)Buffer;\r
- AssertData->LineNumber = (UINT32)LineNumber;\r
+ HeaderSize = sizeof (EFI_DEBUG_ASSERT_DATA);\r
+ //\r
+ // Compute string size of module name enclosed by []\r
+ //\r
+ ModuleNameSize = 2 + AsciiStrSize (gEfiCallerBaseName);\r
+ FileNameSize = AsciiStrSize (FileName);\r
+ DescriptionSize = AsciiStrSize (Description);\r
\r
+ //\r
+ // Make sure it will all fit in the passed in buffer.\r
+ //\r
+ if (HeaderSize + ModuleNameSize + FileNameSize + DescriptionSize > sizeof (Buffer)) {\r
//\r
- // Copy Ascii FileName including NULL.\r
+ // remove module name if it's too long to be filled into buffer\r
//\r
- Temp = AsciiStrCpy ((CHAR8 *)(AssertData + 1), FileName);\r
+ ModuleNameSize = 0;\r
+ if (HeaderSize + FileNameSize + DescriptionSize > sizeof (Buffer)) {\r
+ //\r
+ // FileName + Description is too long to be filled into buffer.\r
+ //\r
+ if (HeaderSize + FileNameSize < sizeof (Buffer)) {\r
+ //\r
+ // Description has enough buffer to be truncated.\r
+ //\r
+ DescriptionSize = sizeof (Buffer) - HeaderSize - FileNameSize;\r
+ } else {\r
+ //\r
+ // FileName is too long to be filled into buffer.\r
+ // FileName will be truncated. Reserved one byte for Description NULL terminator.\r
+ //\r
+ DescriptionSize = 1;\r
+ FileNameSize = sizeof (Buffer) - HeaderSize - DescriptionSize;\r
+ }\r
+ }\r
+ }\r
+ //\r
+ // Fill in EFI_DEBUG_ASSERT_DATA\r
+ //\r
+ AssertData = (EFI_DEBUG_ASSERT_DATA *)Buffer;\r
+ AssertData->LineNumber = (UINT32)LineNumber;\r
+ TotalSize = sizeof (EFI_DEBUG_ASSERT_DATA);\r
\r
- //\r
- // Copy Ascii Description\r
- //\r
- AsciiStrCpy (Temp + FileNameSize, Description);\r
-\r
- REPORT_STATUS_CODE_EX (\r
- (EFI_ERROR_CODE | EFI_ERROR_UNRECOVERED),\r
- (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_EC_ILLEGAL_SOFTWARE_STATE),\r
- 0,\r
- NULL,\r
- NULL,\r
- AssertData,\r
- TotalSize\r
- );\r
+ Temp = (CHAR8 *)(AssertData + 1);\r
+\r
+ //\r
+ // Copy Ascii [ModuleName].\r
+ //\r
+ if (ModuleNameSize != 0) {\r
+ CopyMem(Temp, "[", 1);\r
+ CopyMem(Temp + 1, gEfiCallerBaseName, ModuleNameSize - 3);\r
+ CopyMem(Temp + ModuleNameSize - 2, "] ", 2);\r
}\r
\r
+ //\r
+ // Copy Ascii FileName including NULL terminator.\r
+ //\r
+ Temp = CopyMem (Temp + ModuleNameSize, FileName, FileNameSize);\r
+ Temp[FileNameSize - 1] = 0;\r
+ TotalSize += (ModuleNameSize + FileNameSize);\r
+\r
+ //\r
+ // Copy Ascii Description include NULL terminator.\r
+ //\r
+ Temp = CopyMem (Temp + FileNameSize, Description, DescriptionSize);\r
+ Temp[DescriptionSize - 1] = 0;\r
+ TotalSize += DescriptionSize;\r
+\r
+ REPORT_STATUS_CODE_EX (\r
+ (EFI_ERROR_CODE | EFI_ERROR_UNRECOVERED),\r
+ (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_EC_ILLEGAL_SOFTWARE_STATE),\r
+ 0,\r
+ NULL,\r
+ NULL,\r
+ AssertData,\r
+ TotalSize\r
+ );\r
+\r
//\r
// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
//\r
{\r
return (BOOLEAN) ((PcdGet8 (PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
}\r
+\r
+/**\r
+ Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
+\r
+ This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
+\r
+ @retval TRUE Current ErrorLevel is supported.\r
+ @retval FALSE Current ErrorLevel is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DebugPrintLevelEnabled (\r
+ IN CONST UINTN ErrorLevel\r
+ )\r
+{\r
+ return (BOOLEAN) ((ErrorLevel & PcdGet32(PcdFixedDebugPrintErrorLevel)) != 0);\r
+}\r
projects / mirror_edk2.git / blobdiff