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 - 2015, Intel Corporation. All rights reserved.<BR>
8 This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 #include <Guid/StatusCodeDataTypeId.h>
21 #include <Guid/StatusCodeDataTypeDebug.h>
23 #include <Library/DebugLib.h>
24 #include <Library/BaseLib.h>
25 #include <Library/BaseMemoryLib.h>
26 #include <Library/ReportStatusCodeLib.h>
27 #include <Library/PcdLib.h>
28 #include <Library/DebugPrintErrorLevelLib.h>
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
,
56 UINT64 Buffer
[(EFI_STATUS_CODE_DATA_MAX_SIZE
/ sizeof (UINT64
)) + 1];
57 EFI_DEBUG_INFO
*DebugInfo
;
60 BASE_LIST BaseListMarker
;
65 // If Format is NULL, then ASSERT().
67 ASSERT (Format
!= NULL
);
70 // Check driver Debug Level value and global debug level
72 if ((ErrorLevel
& GetDebugPrintErrorLevel ()) == 0) {
77 // Compute the total size of the record.
78 // Note that the passing-in format string and variable parameters will be constructed to
79 // the following layout:
81 // Buffer->|------------------------|
82 // | Padding | 4 bytes
83 // DebugInfo->|------------------------|
84 // | EFI_DEBUG_INFO | sizeof(EFI_DEBUG_INFO)
85 // BaseListMarker->|------------------------|
87 // | variable arguments | 12 * sizeof (UINT64)
89 // |------------------------|
91 // |------------------------|<- (UINT8 *)Buffer + sizeof(Buffer)
93 TotalSize
= 4 + sizeof (EFI_DEBUG_INFO
) + 12 * sizeof (UINT64
) + AsciiStrSize (Format
);
96 // If the TotalSize is larger than the maximum record size, then return
98 if (TotalSize
> sizeof (Buffer
)) {
103 // Fill in EFI_DEBUG_INFO
105 // Here we skip the first 4 bytes of Buffer, because we must ensure BaseListMarker is
106 // 64-bit aligned, otherwise retrieving 64-bit parameter from BaseListMarker will cause
107 // exception on IPF. Buffer starts at 64-bit aligned address, so skipping 4 types (sizeof(EFI_DEBUG_INFO))
108 // just makes address of BaseListMarker, which follows DebugInfo, 64-bit aligned.
110 DebugInfo
= (EFI_DEBUG_INFO
*)(Buffer
) + 1;
111 DebugInfo
->ErrorLevel
= (UINT32
)ErrorLevel
;
112 BaseListMarker
= (BASE_LIST
)(DebugInfo
+ 1);
113 FormatString
= (CHAR8
*)((UINT64
*)(DebugInfo
+ 1) + 12);
116 // Copy the Format string into the record
118 AsciiStrCpy (FormatString
, Format
);
121 // The first 12 * sizeof (UINT64) bytes following EFI_DEBUG_INFO are for variable arguments
122 // of format in DEBUG string, which is followed by the DEBUG format string.
123 // Here we will process the variable arguments and pack them in this area.
125 VA_START (VaListMarker
, Format
);
126 for (; *Format
!= '\0'; Format
++) {
128 // Only format with prefix % is processed.
130 if (*Format
!= '%') {
135 // Parse Flags and Width
137 for (Format
++; TRUE
; Format
++) {
138 if (*Format
== '.' || *Format
== '-' || *Format
== '+' || *Format
== ' ') {
140 // These characters in format field are omitted.
144 if (*Format
>= '0' && *Format
<= '9') {
146 // These characters in format field are omitted.
150 if (*Format
== 'L' || *Format
== 'l') {
152 // 'L" or "l" in format field means the number being printed is a UINT64
157 if (*Format
== '*') {
159 // '*' in format field means the precision of the field is specified by
160 // a UINTN argument in the argument list.
162 BASE_ARG (BaseListMarker
, UINTN
) = VA_ARG (VaListMarker
, UINTN
);
165 if (*Format
== '\0') {
167 // Make no output if Format string terminates unexpectedly when
168 // looking up for flag, width, precision and type.
173 // When valid argument type detected or format string terminates unexpectedly,
174 // the inner loop is done.
180 // Pack variable arguments into the storage area following EFI_DEBUG_INFO.
182 if ((*Format
== 'p') && (sizeof (VOID
*) > 4)) {
185 if (*Format
== 'p' || *Format
== 'X' || *Format
== 'x' || *Format
== 'd') {
187 BASE_ARG (BaseListMarker
, INT64
) = VA_ARG (VaListMarker
, INT64
);
189 BASE_ARG (BaseListMarker
, int) = VA_ARG (VaListMarker
, int);
191 } else if (*Format
== 's' || *Format
== 'S' || *Format
== 'a' || *Format
== 'g' || *Format
== 't') {
192 BASE_ARG (BaseListMarker
, VOID
*) = VA_ARG (VaListMarker
, VOID
*);
193 } else if (*Format
== 'c') {
194 BASE_ARG (BaseListMarker
, UINTN
) = VA_ARG (VaListMarker
, UINTN
);
195 } else if (*Format
== 'r') {
196 BASE_ARG (BaseListMarker
, RETURN_STATUS
) = VA_ARG (VaListMarker
, RETURN_STATUS
);
200 // If the converted BASE_LIST is larger than the 12 * sizeof (UINT64) allocated bytes, then ASSERT()
201 // This indicates that the DEBUG() macro is passing in more argument than can be handled by
202 // the EFI_DEBUG_INFO record
204 ASSERT ((CHAR8
*)BaseListMarker
<= FormatString
);
207 // If the converted BASE_LIST is larger than the 12 * sizeof (UINT64) allocated bytes, then return
209 if ((CHAR8
*)BaseListMarker
> FormatString
) {
210 VA_END (VaListMarker
);
214 VA_END (VaListMarker
);
217 // Send the DebugInfo record
219 REPORT_STATUS_CODE_EX (
221 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_DC_UNSPECIFIED
),
224 &gEfiStatusCodeDataTypeDebugGuid
,
231 Prints an assert message containing a filename, line number, and description.
232 This may be followed by a breakpoint or a dead loop.
234 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
235 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
236 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
237 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
238 CpuDeadLoop() is called. If neither of these bits are set, then this function
239 returns immediately after the message is printed to the debug output device.
240 DebugAssert() must actively prevent recursion. If DebugAssert() is called while
241 processing another DebugAssert(), then DebugAssert() must return immediately.
243 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
244 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
246 @param FileName Pointer to the name of the source file that generated the assert condition.
247 @param LineNumber The line number in the source file that generated the assert condition
248 @param Description Pointer to the description of the assert condition.
254 IN CONST CHAR8
*FileName
,
256 IN CONST CHAR8
*Description
259 UINT64 Buffer
[EFI_STATUS_CODE_DATA_MAX_SIZE
/ sizeof(UINT64
)];
260 EFI_DEBUG_ASSERT_DATA
*AssertData
;
265 UINTN DescriptionSize
;
270 HeaderSize
= sizeof (EFI_DEBUG_ASSERT_DATA
);
271 FileNameSize
= AsciiStrSize (FileName
);
272 DescriptionSize
= AsciiStrSize (Description
);
275 // Make sure it will all fit in the passed in buffer.
277 if (HeaderSize
+ FileNameSize
+ DescriptionSize
> sizeof (Buffer
)) {
279 // FileName + Description is too long to be filled into buffer.
281 if (HeaderSize
+ FileNameSize
< sizeof (Buffer
)) {
283 // Description has enough buffer to be truncated.
285 DescriptionSize
= sizeof (Buffer
) - HeaderSize
- FileNameSize
;
288 // FileName is too long to be filled into buffer.
289 // FileName will be truncated. Reserved one byte for Description NULL terminator.
292 FileNameSize
= sizeof (Buffer
) - HeaderSize
- DescriptionSize
;
297 // Fill in EFI_DEBUG_ASSERT_DATA
299 AssertData
= (EFI_DEBUG_ASSERT_DATA
*)Buffer
;
300 AssertData
->LineNumber
= (UINT32
)LineNumber
;
301 TotalSize
= sizeof (EFI_DEBUG_ASSERT_DATA
);
304 // Copy Ascii FileName including NULL terminator.
306 Temp
= CopyMem (AssertData
+ 1, FileName
, FileNameSize
);
307 Temp
[FileNameSize
- 1] = 0;
308 TotalSize
+= FileNameSize
;
311 // Copy Ascii Description include NULL terminator.
313 Temp
= CopyMem (Temp
+ FileNameSize
, Description
, DescriptionSize
);
314 Temp
[DescriptionSize
- 1] = 0;
315 TotalSize
+= DescriptionSize
;
317 REPORT_STATUS_CODE_EX (
318 (EFI_ERROR_CODE
| EFI_ERROR_UNRECOVERED
),
319 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
),
328 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
330 if ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
332 } else if ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
339 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
341 This function fills Length bytes of Buffer with the value specified by
342 PcdDebugClearMemoryValue, and returns Buffer.
344 If Buffer is NULL, then ASSERT().
345 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
347 @param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
348 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
350 @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.
360 ASSERT (Buffer
!= NULL
);
362 return SetMem (Buffer
, Length
, PcdGet8 (PcdDebugClearMemoryValue
));
367 Returns TRUE if ASSERT() macros are enabled.
369 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
370 PcdDebugProperyMask is set. Otherwise FALSE is returned.
372 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
373 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
382 return (BOOLEAN
) ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
387 Returns TRUE if DEBUG() macros are enabled.
389 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
390 PcdDebugProperyMask is set. Otherwise FALSE is returned.
392 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
393 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
402 return (BOOLEAN
) ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
407 Returns TRUE if DEBUG_CODE() macros are enabled.
409 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
410 PcdDebugProperyMask is set. Otherwise FALSE is returned.
412 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
413 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
422 return (BOOLEAN
) ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
427 Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
429 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
430 PcdDebugProperyMask is set. Otherwise FALSE is returned.
432 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
433 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
438 DebugClearMemoryEnabled (
442 return (BOOLEAN
) ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);
446 Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.
448 This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.
450 @retval TRUE Current ErrorLevel is supported.
451 @retval FALSE Current ErrorLevel is not supported.
456 DebugPrintLevelEnabled (
457 IN CONST UINTN ErrorLevel
460 return (BOOLEAN
) ((ErrorLevel
& PcdGet32(PcdFixedDebugPrintErrorLevel
)) != 0);