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
;
96 BASE_LIST BaseListMarkerPointer
;
101 // If Format is NULL, then ASSERT().
103 ASSERT (Format
!= NULL
);
106 // Check driver Debug Level value and global debug level
108 if ((ErrorLevel
& GetDebugPrintErrorLevel ()) == 0) {
113 // Compute the total size of the record.
114 // Note that the passing-in format string and variable parameters will be constructed to
115 // the following layout:
117 // Buffer->|------------------------|
118 // | Padding | 4 bytes
119 // DebugInfo->|------------------------|
120 // | EFI_DEBUG_INFO | sizeof(EFI_DEBUG_INFO)
121 // BaseListMarkerPointer->|------------------------|
123 // | variable arguments | 12 * sizeof (UINT64)
125 // |------------------------|
127 // |------------------------|<- (UINT8 *)Buffer + sizeof(Buffer)
129 TotalSize
= 4 + sizeof (EFI_DEBUG_INFO
) + 12 * sizeof (UINT64
) + AsciiStrSize (Format
);
132 // If the TotalSize is larger than the maximum record size, then truncate it.
134 if (TotalSize
> sizeof (Buffer
)) {
135 TotalSize
= sizeof (Buffer
);
139 // Fill in EFI_DEBUG_INFO
141 // Here we skip the first 4 bytes of Buffer, because we must ensure BaseListMarkerPointer is
142 // 64-bit aligned, otherwise retrieving 64-bit parameter from BaseListMarkerPointer will cause
143 // exception on IPF. Buffer starts at 64-bit aligned address, so skipping 4 types (sizeof(EFI_DEBUG_INFO))
144 // just makes address of BaseListMarkerPointer, which follows DebugInfo, 64-bit aligned.
146 DebugInfo
= (EFI_DEBUG_INFO
*)(Buffer
) + 1;
147 DebugInfo
->ErrorLevel
= (UINT32
)ErrorLevel
;
148 BaseListMarkerPointer
= (BASE_LIST
)(DebugInfo
+ 1);
149 FormatString
= (CHAR8
*)((UINT64
*)(DebugInfo
+ 1) + 12);
152 // Copy the Format string into the record. It will be truncated if it's too long.
156 sizeof (Buffer
) - (4 + sizeof (EFI_DEBUG_INFO
) + 12 * sizeof (UINT64
)),
158 sizeof (Buffer
) - (4 + sizeof (EFI_DEBUG_INFO
) + 12 * sizeof (UINT64
)) - 1
162 // The first 12 * sizeof (UINT64) bytes following EFI_DEBUG_INFO are for variable arguments
163 // of format in DEBUG string, which is followed by the DEBUG format string.
164 // Here we will process the variable arguments and pack them in this area.
168 // Use the actual format string.
170 Format
= FormatString
;
171 for ( ; *Format
!= '\0'; Format
++) {
173 // Only format with prefix % is processed.
175 if (*Format
!= '%') {
181 // Parse Flags and Width
183 for (Format
++; TRUE
; Format
++) {
184 if ((*Format
== '.') || (*Format
== '-') || (*Format
== '+') || (*Format
== ' ')) {
186 // These characters in format field are omitted.
191 if ((*Format
>= '0') && (*Format
<= '9')) {
193 // These characters in format field are omitted.
198 if ((*Format
== 'L') || (*Format
== 'l')) {
200 // 'L" or "l" in format field means the number being printed is a UINT64
206 if (*Format
== '*') {
208 // '*' in format field means the precision of the field is specified by
209 // a UINTN argument in the argument list.
211 if (BaseListMarker
== NULL
) {
212 BASE_ARG (BaseListMarkerPointer
, UINTN
) = VA_ARG (VaListMarker
, UINTN
);
214 BASE_ARG (BaseListMarkerPointer
, UINTN
) = BASE_ARG (BaseListMarker
, UINTN
);
220 if (*Format
== '\0') {
222 // Make no output if Format string terminates unexpectedly when
223 // looking up for flag, width, precision and type.
229 // When valid argument type detected or format string terminates unexpectedly,
230 // the inner loop is done.
236 // Pack variable arguments into the storage area following EFI_DEBUG_INFO.
238 if ((*Format
== 'p') && (sizeof (VOID
*) > 4)) {
242 if ((*Format
== 'p') || (*Format
== 'X') || (*Format
== 'x') || (*Format
== 'd') || (*Format
== 'u')) {
244 if (BaseListMarker
== NULL
) {
245 BASE_ARG (BaseListMarkerPointer
, INT64
) = VA_ARG (VaListMarker
, INT64
);
247 BASE_ARG (BaseListMarkerPointer
, INT64
) = BASE_ARG (BaseListMarker
, INT64
);
250 if (BaseListMarker
== NULL
) {
251 BASE_ARG (BaseListMarkerPointer
, int) = VA_ARG (VaListMarker
, int);
253 BASE_ARG (BaseListMarkerPointer
, int) = BASE_ARG (BaseListMarker
, int);
256 } else if ((*Format
== 's') || (*Format
== 'S') || (*Format
== 'a') || (*Format
== 'g') || (*Format
== 't')) {
257 if (BaseListMarker
== NULL
) {
258 BASE_ARG (BaseListMarkerPointer
, VOID
*) = VA_ARG (VaListMarker
, VOID
*);
260 BASE_ARG (BaseListMarkerPointer
, VOID
*) = BASE_ARG (BaseListMarker
, VOID
*);
262 } else if (*Format
== 'c') {
263 if (BaseListMarker
== NULL
) {
264 BASE_ARG (BaseListMarkerPointer
, UINTN
) = VA_ARG (VaListMarker
, UINTN
);
266 BASE_ARG (BaseListMarkerPointer
, UINTN
) = BASE_ARG (BaseListMarker
, UINTN
);
268 } else if (*Format
== 'r') {
269 if (BaseListMarker
== NULL
) {
270 BASE_ARG (BaseListMarkerPointer
, RETURN_STATUS
) = VA_ARG (VaListMarker
, RETURN_STATUS
);
272 BASE_ARG (BaseListMarkerPointer
, RETURN_STATUS
) = BASE_ARG (BaseListMarker
, RETURN_STATUS
);
277 // If the converted BASE_LIST is larger than the 12 * sizeof (UINT64) allocated bytes, then ASSERT()
278 // This indicates that the DEBUG() macro is passing in more argument than can be handled by
279 // the EFI_DEBUG_INFO record
281 ASSERT ((CHAR8
*)BaseListMarkerPointer
<= FormatString
);
284 // If the converted BASE_LIST is larger than the 12 * sizeof (UINT64) allocated bytes, then return
286 if ((CHAR8
*)BaseListMarkerPointer
> FormatString
) {
292 // Send the DebugInfo record
294 REPORT_STATUS_CODE_EX (
296 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_DC_UNSPECIFIED
),
299 &gEfiStatusCodeDataTypeDebugGuid
,
306 Prints a debug message to the debug output device if the specified
307 error level is enabled.
309 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
310 GetDebugPrintErrorLevel (), then print the message specified by Format and
311 the associated variable argument list to the debug output device.
313 If Format is NULL, then ASSERT().
315 @param ErrorLevel The error level of the debug message.
316 @param Format Format string for the debug message to print.
317 @param VaListMarker VA_LIST marker for the variable argument list.
324 IN CONST CHAR8
*Format
,
325 IN VA_LIST VaListMarker
328 DebugPrintMarker (ErrorLevel
, Format
, VaListMarker
, NULL
);
332 Prints a debug message to the debug output device if the specified
333 error level is enabled.
334 This function use BASE_LIST which would provide a more compatible
335 service than VA_LIST.
337 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
338 GetDebugPrintErrorLevel (), then print the message specified by Format and
339 the associated variable argument list to the debug output device.
341 If Format is NULL, then ASSERT().
343 @param ErrorLevel The error level of the debug message.
344 @param Format Format string for the debug message to print.
345 @param BaseListMarker BASE_LIST marker for the variable argument list.
352 IN CONST CHAR8
*Format
,
353 IN BASE_LIST BaseListMarker
356 DebugPrintMarker (ErrorLevel
, Format
, mVaListNull
, BaseListMarker
);
360 Prints an assert message containing a filename, line number, and description.
361 This may be followed by a breakpoint or a dead loop.
363 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
364 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
365 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
366 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
367 CpuDeadLoop() is called. If neither of these bits are set, then this function
368 returns immediately after the message is printed to the debug output device.
369 DebugAssert() must actively prevent recursion. If DebugAssert() is called while
370 processing another DebugAssert(), then DebugAssert() must return immediately.
372 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
373 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
375 @param FileName Pointer to the name of the source file that generated the assert condition.
376 @param LineNumber The line number in the source file that generated the assert condition
377 @param Description Pointer to the description of the assert condition.
383 IN CONST CHAR8
*FileName
,
385 IN CONST CHAR8
*Description
388 UINT64 Buffer
[EFI_STATUS_CODE_DATA_MAX_SIZE
/ sizeof (UINT64
)];
389 EFI_DEBUG_ASSERT_DATA
*AssertData
;
393 UINTN ModuleNameSize
;
395 UINTN DescriptionSize
;
400 HeaderSize
= sizeof (EFI_DEBUG_ASSERT_DATA
);
402 // Compute string size of module name enclosed by []
404 ModuleNameSize
= 2 + AsciiStrSize (gEfiCallerBaseName
);
405 FileNameSize
= AsciiStrSize (FileName
);
406 DescriptionSize
= AsciiStrSize (Description
);
409 // Make sure it will all fit in the passed in buffer.
411 if (HeaderSize
+ ModuleNameSize
+ FileNameSize
+ DescriptionSize
> sizeof (Buffer
)) {
413 // remove module name if it's too long to be filled into buffer
416 if (HeaderSize
+ FileNameSize
+ DescriptionSize
> sizeof (Buffer
)) {
418 // FileName + Description is too long to be filled into buffer.
420 if (HeaderSize
+ FileNameSize
< sizeof (Buffer
)) {
422 // Description has enough buffer to be truncated.
424 DescriptionSize
= sizeof (Buffer
) - HeaderSize
- FileNameSize
;
427 // FileName is too long to be filled into buffer.
428 // FileName will be truncated. Reserved one byte for Description NULL terminator.
431 FileNameSize
= sizeof (Buffer
) - HeaderSize
- DescriptionSize
;
437 // Fill in EFI_DEBUG_ASSERT_DATA
439 AssertData
= (EFI_DEBUG_ASSERT_DATA
*)Buffer
;
440 AssertData
->LineNumber
= (UINT32
)LineNumber
;
441 TotalSize
= sizeof (EFI_DEBUG_ASSERT_DATA
);
443 Temp
= (CHAR8
*)(AssertData
+ 1);
446 // Copy Ascii [ModuleName].
448 if (ModuleNameSize
!= 0) {
449 CopyMem (Temp
, "[", 1);
450 CopyMem (Temp
+ 1, gEfiCallerBaseName
, ModuleNameSize
- 3);
451 CopyMem (Temp
+ ModuleNameSize
- 2, "] ", 2);
455 // Copy Ascii FileName including NULL terminator.
457 Temp
= CopyMem (Temp
+ ModuleNameSize
, FileName
, FileNameSize
);
458 Temp
[FileNameSize
- 1] = 0;
459 TotalSize
+= (ModuleNameSize
+ FileNameSize
);
462 // Copy Ascii Description include NULL terminator.
464 Temp
= CopyMem (Temp
+ FileNameSize
, Description
, DescriptionSize
);
465 Temp
[DescriptionSize
- 1] = 0;
466 TotalSize
+= DescriptionSize
;
468 REPORT_STATUS_CODE_EX (
469 (EFI_ERROR_CODE
| EFI_ERROR_UNRECOVERED
),
470 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
),
479 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
481 if ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
483 } else if ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
489 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
491 This function fills Length bytes of Buffer with the value specified by
492 PcdDebugClearMemoryValue, and returns Buffer.
494 If Buffer is NULL, then ASSERT().
495 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
497 @param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
498 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
500 @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.
510 ASSERT (Buffer
!= NULL
);
512 return SetMem (Buffer
, Length
, PcdGet8 (PcdDebugClearMemoryValue
));
516 Returns TRUE if ASSERT() macros are enabled.
518 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
519 PcdDebugProperyMask is set. Otherwise FALSE is returned.
521 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
522 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
531 return (BOOLEAN
)((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
535 Returns TRUE if DEBUG() macros are enabled.
537 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
538 PcdDebugProperyMask is set. Otherwise FALSE is returned.
540 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
541 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
550 return (BOOLEAN
)((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
554 Returns TRUE if DEBUG_CODE() macros are enabled.
556 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
557 PcdDebugProperyMask is set. Otherwise FALSE is returned.
559 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
560 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
569 return (BOOLEAN
)((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
573 Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
575 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
576 PcdDebugProperyMask is set. Otherwise FALSE is returned.
578 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
579 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
584 DebugClearMemoryEnabled (
588 return (BOOLEAN
)((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);
592 Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.
594 This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.
596 @retval TRUE Current ErrorLevel is supported.
597 @retval FALSE Current ErrorLevel is not supported.
602 DebugPrintLevelEnabled (
603 IN CONST UINTN ErrorLevel
606 return (BOOLEAN
)((ErrorLevel
& PcdGet32 (PcdFixedDebugPrintErrorLevel
)) != 0);