2 Debug Library based on report status code library.
4 Note that if the debug message length is larger than the maximum allowable
5 record length, then the debug message will be ignored directly.
7 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
8 SPDX-License-Identifier: BSD-2-Clause-Patent
14 #include <Guid/StatusCodeDataTypeId.h>
15 #include <Guid/StatusCodeDataTypeDebug.h>
17 #include <Library/DebugLib.h>
18 #include <Library/BaseLib.h>
19 #include <Library/BaseMemoryLib.h>
20 #include <Library/ReportStatusCodeLib.h>
21 #include <Library/PcdLib.h>
22 #include <Library/DebugPrintErrorLevelLib.h>
25 // VA_LIST can not initialize to NULL for all compiler, so we use this to
26 // indicate a null VA_LIST
31 Prints a debug message to the debug output device if the specified error level is enabled.
33 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
34 GetDebugPrintErrorLevel (), then print the message specified by Format and the
35 associated variable argument list to the debug output device.
37 If Format is NULL, then ASSERT().
39 If the length of the message string specificed by Format is larger than the maximum allowable
40 record length, then directly return and not print it.
42 @param ErrorLevel The error level of the debug message.
43 @param Format Format string for the debug message to print.
44 @param ... Variable argument list whose contents are accessed
45 based on the format string specified by Format.
52 IN CONST CHAR8
*Format
,
58 VA_START (Marker
, Format
);
59 DebugVPrint (ErrorLevel
, Format
, Marker
);
64 Prints a debug message to the debug output device if the specified
65 error level is enabled base on Null-terminated format string and a
66 VA_LIST argument list or a BASE_LIST argument list.
68 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
69 GetDebugPrintErrorLevel (), then print the message specified by Format and
70 the associated variable argument list to the debug output device.
72 Only one list type is used.
73 If BaseListMarker == NULL, then use VaListMarker.
74 Otherwise use BaseListMarker and the VaListMarker should be initilized as
77 If Format is NULL, then ASSERT().
79 @param ErrorLevel The error level of the debug message.
80 @param Format Format string for the debug message to print.
81 @param VaListMarker VA_LIST marker for the variable argument list.
82 @param BaseListMarker BASE_LIST marker for the variable argument list.
88 IN CONST CHAR8
*Format
,
89 IN VA_LIST VaListMarker
,
90 IN BASE_LIST BaseListMarker
93 UINT64 Buffer
[(EFI_STATUS_CODE_DATA_MAX_SIZE
/ sizeof (UINT64
)) + 1];
94 EFI_DEBUG_INFO
*DebugInfo
;
97 BASE_LIST BaseListMarkerPointer
;
102 // If Format is NULL, then ASSERT().
104 ASSERT (Format
!= NULL
);
107 // Check driver Debug Level value and global debug level
109 if ((ErrorLevel
& GetDebugPrintErrorLevel ()) == 0) {
114 // Compute the total size of the record.
115 // Note that the passing-in format string and variable parameters will be constructed to
116 // the following layout:
118 // Buffer->|------------------------|
119 // | Padding | 4 bytes
120 // DebugInfo->|------------------------|
121 // | EFI_DEBUG_INFO | sizeof(EFI_DEBUG_INFO)
122 // BaseListMarkerPointer->|------------------------|
124 // | variable arguments | 12 * sizeof (UINT64)
126 // |------------------------|
128 // |------------------------|<- (UINT8 *)Buffer + sizeof(Buffer)
130 TotalSize
= 4 + sizeof (EFI_DEBUG_INFO
) + 12 * sizeof (UINT64
) + AsciiStrSize (Format
);
133 // If the TotalSize is larger than the maximum record size, then truncate it.
135 if (TotalSize
> sizeof (Buffer
)) {
136 TotalSize
= sizeof (Buffer
);
140 // Fill in EFI_DEBUG_INFO
142 // Here we skip the first 4 bytes of Buffer, because we must ensure BaseListMarkerPointer is
143 // 64-bit aligned, otherwise retrieving 64-bit parameter from BaseListMarkerPointer will cause
144 // exception on IPF. Buffer starts at 64-bit aligned address, so skipping 4 types (sizeof(EFI_DEBUG_INFO))
145 // just makes address of BaseListMarkerPointer, which follows DebugInfo, 64-bit aligned.
147 DebugInfo
= (EFI_DEBUG_INFO
*)(Buffer
) + 1;
148 DebugInfo
->ErrorLevel
= (UINT32
)ErrorLevel
;
149 BaseListMarkerPointer
= (BASE_LIST
)(DebugInfo
+ 1);
150 FormatString
= (CHAR8
*)((UINT64
*)(DebugInfo
+ 1) + 12);
153 // Copy the Format string into the record. It will be truncated if it's too long.
155 // According to the content structure of Buffer shown above, the size of
156 // the FormatString buffer is the size of Buffer minus the Padding
157 // (4 bytes), minus the size of EFI_DEBUG_INFO, minus the size of
158 // variable arguments (12 * sizeof (UINT64)).
160 DestBufferSize
= sizeof (Buffer
) - 4 - sizeof (EFI_DEBUG_INFO
) - 12 * sizeof (UINT64
);
161 AsciiStrnCpyS (FormatString
, DestBufferSize
/ sizeof (CHAR8
), Format
, DestBufferSize
/ sizeof (CHAR8
) - 1);
164 // The first 12 * sizeof (UINT64) bytes following EFI_DEBUG_INFO are for variable arguments
165 // of format in DEBUG string, which is followed by the DEBUG format string.
166 // Here we will process the variable arguments and pack them in this area.
168 for (; *Format
!= '\0'; Format
++) {
170 // Only format with prefix % is processed.
172 if (*Format
!= '%') {
177 // Parse Flags and Width
179 for (Format
++; TRUE
; Format
++) {
180 if (*Format
== '.' || *Format
== '-' || *Format
== '+' || *Format
== ' ') {
182 // These characters in format field are omitted.
186 if (*Format
>= '0' && *Format
<= '9') {
188 // These characters in format field are omitted.
192 if (*Format
== 'L' || *Format
== 'l') {
194 // 'L" or "l" in format field means the number being printed is a UINT64
199 if (*Format
== '*') {
201 // '*' in format field means the precision of the field is specified by
202 // a UINTN argument in the argument list.
204 if (BaseListMarker
== NULL
) {
205 BASE_ARG (BaseListMarkerPointer
, UINTN
) = VA_ARG (VaListMarker
, UINTN
);
207 BASE_ARG (BaseListMarkerPointer
, UINTN
) = BASE_ARG (BaseListMarker
, UINTN
);
211 if (*Format
== '\0') {
213 // Make no output if Format string terminates unexpectedly when
214 // looking up for flag, width, precision and type.
219 // When valid argument type detected or format string terminates unexpectedly,
220 // the inner loop is done.
226 // Pack variable arguments into the storage area following EFI_DEBUG_INFO.
228 if ((*Format
== 'p') && (sizeof (VOID
*) > 4)) {
231 if (*Format
== 'p' || *Format
== 'X' || *Format
== 'x' || *Format
== 'd' || *Format
== 'u') {
233 if (BaseListMarker
== NULL
) {
234 BASE_ARG (BaseListMarkerPointer
, INT64
) = VA_ARG (VaListMarker
, INT64
);
236 BASE_ARG (BaseListMarkerPointer
, INT64
) = BASE_ARG (BaseListMarker
, INT64
);
239 if (BaseListMarker
== NULL
) {
240 BASE_ARG (BaseListMarkerPointer
, int) = VA_ARG (VaListMarker
, int);
242 BASE_ARG (BaseListMarkerPointer
, int) = BASE_ARG (BaseListMarker
, int);
245 } else if (*Format
== 's' || *Format
== 'S' || *Format
== 'a' || *Format
== 'g' || *Format
== 't') {
246 if (BaseListMarker
== NULL
) {
247 BASE_ARG (BaseListMarkerPointer
, VOID
*) = VA_ARG (VaListMarker
, VOID
*);
249 BASE_ARG (BaseListMarkerPointer
, VOID
*) = BASE_ARG (BaseListMarker
, VOID
*);
251 } else if (*Format
== 'c') {
252 if (BaseListMarker
== NULL
) {
253 BASE_ARG (BaseListMarkerPointer
, UINTN
) = VA_ARG (VaListMarker
, UINTN
);
255 BASE_ARG (BaseListMarkerPointer
, UINTN
) = BASE_ARG (BaseListMarker
, UINTN
);
257 } else if (*Format
== 'r') {
258 if (BaseListMarker
== NULL
) {
259 BASE_ARG (BaseListMarkerPointer
, RETURN_STATUS
) = VA_ARG (VaListMarker
, RETURN_STATUS
);
261 BASE_ARG (BaseListMarkerPointer
, RETURN_STATUS
) = BASE_ARG (BaseListMarker
, RETURN_STATUS
);
266 // If the converted BASE_LIST is larger than the 12 * sizeof (UINT64) allocated bytes, then ASSERT()
267 // This indicates that the DEBUG() macro is passing in more argument than can be handled by
268 // the EFI_DEBUG_INFO record
270 ASSERT ((CHAR8
*)BaseListMarkerPointer
<= FormatString
);
273 // If the converted BASE_LIST is larger than the 12 * sizeof (UINT64) allocated bytes, then return
275 if ((CHAR8
*)BaseListMarkerPointer
> FormatString
) {
281 // Send the DebugInfo record
283 REPORT_STATUS_CODE_EX (
285 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_DC_UNSPECIFIED
),
288 &gEfiStatusCodeDataTypeDebugGuid
,
295 Prints a debug message to the debug output device if the specified
296 error level is enabled.
298 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
299 GetDebugPrintErrorLevel (), then print the message specified by Format and
300 the associated variable argument list to the debug output device.
302 If Format is NULL, then ASSERT().
304 @param ErrorLevel The error level of the debug message.
305 @param Format Format string for the debug message to print.
306 @param VaListMarker VA_LIST marker for the variable argument list.
313 IN CONST CHAR8
*Format
,
314 IN VA_LIST VaListMarker
317 DebugPrintMarker (ErrorLevel
, Format
, VaListMarker
, NULL
);
321 Prints a debug message to the debug output device if the specified
322 error level is enabled.
323 This function use BASE_LIST which would provide a more compatible
324 service than VA_LIST.
326 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
327 GetDebugPrintErrorLevel (), then print the message specified by Format and
328 the associated variable argument list to the debug output device.
330 If Format is NULL, then ASSERT().
332 @param ErrorLevel The error level of the debug message.
333 @param Format Format string for the debug message to print.
334 @param BaseListMarker BASE_LIST marker for the variable argument list.
341 IN CONST CHAR8
*Format
,
342 IN BASE_LIST BaseListMarker
345 DebugPrintMarker (ErrorLevel
, Format
, mVaListNull
, BaseListMarker
);
349 Prints an assert message containing a filename, line number, and description.
350 This may be followed by a breakpoint or a dead loop.
352 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
353 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
354 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
355 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
356 CpuDeadLoop() is called. If neither of these bits are set, then this function
357 returns immediately after the message is printed to the debug output device.
358 DebugAssert() must actively prevent recursion. If DebugAssert() is called while
359 processing another DebugAssert(), then DebugAssert() must return immediately.
361 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
362 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
364 @param FileName Pointer to the name of the source file that generated the assert condition.
365 @param LineNumber The line number in the source file that generated the assert condition
366 @param Description Pointer to the description of the assert condition.
372 IN CONST CHAR8
*FileName
,
374 IN CONST CHAR8
*Description
377 UINT64 Buffer
[EFI_STATUS_CODE_DATA_MAX_SIZE
/ sizeof(UINT64
)];
378 EFI_DEBUG_ASSERT_DATA
*AssertData
;
382 UINTN ModuleNameSize
;
384 UINTN DescriptionSize
;
389 HeaderSize
= sizeof (EFI_DEBUG_ASSERT_DATA
);
391 // Compute string size of module name enclosed by []
393 ModuleNameSize
= 2 + AsciiStrSize (gEfiCallerBaseName
);
394 FileNameSize
= AsciiStrSize (FileName
);
395 DescriptionSize
= AsciiStrSize (Description
);
398 // Make sure it will all fit in the passed in buffer.
400 if (HeaderSize
+ ModuleNameSize
+ FileNameSize
+ DescriptionSize
> sizeof (Buffer
)) {
402 // remove module name if it's too long to be filled into buffer
405 if (HeaderSize
+ FileNameSize
+ DescriptionSize
> sizeof (Buffer
)) {
407 // FileName + Description is too long to be filled into buffer.
409 if (HeaderSize
+ FileNameSize
< sizeof (Buffer
)) {
411 // Description has enough buffer to be truncated.
413 DescriptionSize
= sizeof (Buffer
) - HeaderSize
- FileNameSize
;
416 // FileName is too long to be filled into buffer.
417 // FileName will be truncated. Reserved one byte for Description NULL terminator.
420 FileNameSize
= sizeof (Buffer
) - HeaderSize
- DescriptionSize
;
425 // Fill in EFI_DEBUG_ASSERT_DATA
427 AssertData
= (EFI_DEBUG_ASSERT_DATA
*)Buffer
;
428 AssertData
->LineNumber
= (UINT32
)LineNumber
;
429 TotalSize
= sizeof (EFI_DEBUG_ASSERT_DATA
);
431 Temp
= (CHAR8
*)(AssertData
+ 1);
434 // Copy Ascii [ModuleName].
436 if (ModuleNameSize
!= 0) {
437 CopyMem(Temp
, "[", 1);
438 CopyMem(Temp
+ 1, gEfiCallerBaseName
, ModuleNameSize
- 3);
439 CopyMem(Temp
+ ModuleNameSize
- 2, "] ", 2);
443 // Copy Ascii FileName including NULL terminator.
445 Temp
= CopyMem (Temp
+ ModuleNameSize
, FileName
, FileNameSize
);
446 Temp
[FileNameSize
- 1] = 0;
447 TotalSize
+= (ModuleNameSize
+ FileNameSize
);
450 // Copy Ascii Description include NULL terminator.
452 Temp
= CopyMem (Temp
+ FileNameSize
, Description
, DescriptionSize
);
453 Temp
[DescriptionSize
- 1] = 0;
454 TotalSize
+= DescriptionSize
;
456 REPORT_STATUS_CODE_EX (
457 (EFI_ERROR_CODE
| EFI_ERROR_UNRECOVERED
),
458 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
),
467 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
469 if ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
471 } else if ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
478 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
480 This function fills Length bytes of Buffer with the value specified by
481 PcdDebugClearMemoryValue, and returns Buffer.
483 If Buffer is NULL, then ASSERT().
484 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
486 @param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
487 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
489 @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.
499 ASSERT (Buffer
!= NULL
);
501 return SetMem (Buffer
, Length
, PcdGet8 (PcdDebugClearMemoryValue
));
506 Returns TRUE if ASSERT() macros are enabled.
508 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
509 PcdDebugProperyMask is set. Otherwise FALSE is returned.
511 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
512 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
521 return (BOOLEAN
) ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
526 Returns TRUE if DEBUG() macros are enabled.
528 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
529 PcdDebugProperyMask is set. Otherwise FALSE is returned.
531 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
532 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
541 return (BOOLEAN
) ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
546 Returns TRUE if DEBUG_CODE() macros are enabled.
548 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
549 PcdDebugProperyMask is set. Otherwise FALSE is returned.
551 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
552 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
561 return (BOOLEAN
) ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
566 Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
568 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
569 PcdDebugProperyMask is set. Otherwise FALSE is returned.
571 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
572 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
577 DebugClearMemoryEnabled (
581 return (BOOLEAN
) ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);
585 Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.
587 This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.
589 @retval TRUE Current ErrorLevel is supported.
590 @retval FALSE Current ErrorLevel is not supported.
595 DebugPrintLevelEnabled (
596 IN CONST UINTN ErrorLevel
599 return (BOOLEAN
) ((ErrorLevel
& PcdGet32(PcdFixedDebugPrintErrorLevel
)) != 0);