]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Include/Library/DebugLib.h
2 Public include file for the Debug Library
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef __DEBUG_LIB_H__
16 #define __DEBUG_LIB_H__
19 // Declare bits for PcdDebugPropertyMask
21 #define DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED 0x01
22 #define DEBUG_PROPERTY_DEBUG_PRINT_ENABLED 0x02
23 #define DEBUG_PROPERTY_DEBUG_CODE_ENABLED 0x04
24 #define DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED 0x08
25 #define DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED 0x10
26 #define DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED 0x20
29 // Declare bits for PcdDebugPrintErrorLevel and the ErrorLevel parameter of DebugPrint()
31 #define DEBUG_INIT 0x00000001 // Initialization
32 #define DEBUG_WARN 0x00000002 // Warnings
33 #define DEBUG_LOAD 0x00000004 // Load events
34 #define DEBUG_FS 0x00000008 // EFI File system
35 #define DEBUG_POOL 0x00000010 // Alloc & Free's
36 #define DEBUG_PAGE 0x00000020 // Alloc & Free's
37 #define DEBUG_INFO 0x00000040 // Verbose
38 #define DEBUG_VARIABLE 0x00000100 // Variable
39 #define DEBUG_BM 0x00000400 // Boot Manager
40 #define DEBUG_BLKIO 0x00001000 // BlkIo Driver
41 #define DEBUG_NET 0x00004000 // SNI Driver
42 #define DEBUG_UNDI 0x00010000 // UNDI Driver
43 #define DEBUG_LOADFILE 0x00020000 // UNDI Driver
44 #define DEBUG_EVENT 0x00080000 // Event messages
45 #define DEBUG_ERROR 0x80000000 // Error
48 // Aliases of debug message mask bits
50 #define EFI_D_INIT DEBUG_INIT
51 #define EFI_D_WARN DEBUG_WARN
52 #define EFI_D_LOAD DEBUG_LOAD
53 #define EFI_D_FS DEBUG_FS
54 #define EFI_D_POOL DEBUG_POOL
55 #define EFI_D_PAGE DEBUG_PAGE
56 #define EFI_D_INFO DEBUG_INFO
57 #define EFI_D_VARIABLE DEBUG_VARIABLE
58 #define EFI_D_BM DEBUG_BM
59 #define EFI_D_BLKIO DEBUG_BLKIO
60 #define EFI_D_NET DEBUG_NET
61 #define EFI_D_UNDI DEBUG_UNDI
62 #define EFI_D_LOADFILE DEBUG_LOADFILE
63 #define EFI_D_EVENT DEBUG_EVENT
64 #define EFI_D_ERROR DEBUG_ERROR
68 Prints a debug message to the debug output device if the specified error level is enabled.
70 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
71 the message specified by Format and the associated variable argument list to
72 the debug output device.
74 If Format is NULL, then ASSERT().
76 @param ErrorLevel The error level of the debug message.
77 @param Format Format string for the debug message to print.
84 IN CONST CHAR8
*Format
,
91 Prints an assert message containing a filename, line number, and description.
92 This may be followed by a breakpoint or a dead loop.
94 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
95 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
96 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
97 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
98 CpuDeadLoop() is called. If neither of these bits are set, then this function
99 returns immediately after the message is printed to the debug output device.
100 DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while
101 processing another DebugAssert(), then DebugAssert() must return immediately.
103 If FileName is NULL, then a <FileName> string of ?NULL) Filename?is printed.
105 If Description is NULL, then a <Description> string of ?NULL) Description?is printed.
107 @param FileName Pointer to the name of the source file that generated the assert condition.
108 @param LineNumber The line number in the source file that generated the assert condition
109 @param Description Pointer to the description of the assert condition.
115 IN CONST CHAR8
*FileName
,
117 IN CONST CHAR8
*Description
123 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
125 This function fills Length bytes of Buffer with the value specified by
126 PcdDebugClearMemoryValue, and returns Buffer.
128 If Buffer is NULL, then ASSERT().
130 If Length is greater than (MAX_ADDRESS ?Buffer + 1), then ASSERT().
132 @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
133 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
148 Returns TRUE if ASSERT() macros are enabled.
150 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
151 PcdDebugProperyMask is set. Otherwise FALSE is returned.
153 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
154 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
166 Returns TRUE if DEBUG()macros are enabled.
168 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
169 PcdDebugProperyMask is set. Otherwise FALSE is returned.
171 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
172 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
184 Returns TRUE if DEBUG_CODE()macros are enabled.
186 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
187 PcdDebugProperyMask is set. Otherwise FALSE is returned.
189 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
190 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
202 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
204 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
205 PcdDebugProperyMask is set. Otherwise FALSE is returned.
207 @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
208 @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
213 DebugClearMemoryEnabled (
220 Internal worker macro that calls DebugAssert().
222 This macro calls DebugAssert() passing in the filename, line number, and
223 expression that evailated to FALSE.
225 @param Expression Boolean expression that evailated to FALSE
228 #define _ASSERT(Expression) DebugAssert (__FILE__, __LINE__, #Expression)
233 Internal worker macro that calls DebugPrint().
235 This macro calls DebugPrint() passing in the debug error level, a format
236 string, and a variable argument list.
238 @param Expression Expression containing an error level, a format string,
239 and a variable argument list based on the format string.
242 #define _DEBUG(Expression) DebugPrint Expression
247 Macro that calls DebugAssert() if a expression evaluates to FALSE.
249 If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,
250 then this macro evaluates the Boolean expression specified by Expression. If
251 Expression evaluates to FALSE, then DebugAssert() is called passing in the
252 source filename, source line number, and Expression.
254 @param Expression Boolean expression
257 #define ASSERT(Expression) \
259 if (DebugAssertEnabled ()) { \
260 if (!(Expression)) { \
261 _ASSERT (Expression); \
269 Macro that calls DebugPrint().
271 If the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set,
272 then this macro passes Expression to DebugPrint().
274 @param Expression Expression containing an error level, a format string,
275 and a variable argument list based on the format string.
279 #define DEBUG(Expression) \
281 if (DebugPrintEnabled ()) { \
282 _DEBUG (Expression); \
289 Macro that calls DebugAssert() if an EFI_STATUS evaluates to an error code.
291 If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,
292 then this macro evaluates the EFI_STATUS value specified by StatusParameter.
293 If StatusParameter is an error code, then DebugAssert() is called passing in
294 the source filename, source line number, and StatusParameter.
296 @param StatusParameter EFI_STATUS value to evaluate.
299 #define ASSERT_EFI_ERROR(StatusParameter) \
301 if (DebugAssertEnabled ()) { \
302 if (EFI_ERROR (StatusParameter)) { \
303 DEBUG ((EFI_D_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter)); \
304 _ASSERT (!EFI_ERROR (StatusParameter)); \
312 Macro that calls DebugAssert() if a protocol is already installed in the
315 If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear,
318 If Handle is NULL, then a check is made to see if the protocol specified by Guid
319 is present on any handle in the handle database. If Handle is not NULL, then
320 a check is made to see if the protocol specified by Guid is present on the
321 handle specified by Handle. If the check finds the protocol, then DebugAssert()
322 is called passing in the source filename, source line number, and Guid.
324 If Guid is NULL, then ASSERT().
326 @param Handle The handle to check for the protocol. This is an optional
327 parameter that may be NULL. If it is NULL, then the entire
328 handle database is searched.
330 @param Guid Pointer to a protocol GUID.
333 #define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid) \
335 if (DebugAssertEnabled ()) { \
337 ASSERT (Guid != NULL); \
338 if (Handle == NULL) { \
339 if (!EFI_ERROR (gBS->LocateProtocol ((EFI_GUID *)Guid, NULL, &Instance))) { \
340 _ASSERT (Guid already installed in database); \
343 if (!EFI_ERROR (gBS->HandleProtocol (Handle, (EFI_GUID *)Guid, &Instance))) { \
344 _ASSERT (Guid already installed on Handle); \
352 Macro that marks the beginning of debug source code.
354 If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,
355 then this macro marks the beginning of source code that is included in a module.
356 Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END()
357 are not included in a module.
360 #define DEBUG_CODE_BEGIN() do { if (DebugCodeEnabled ()) { UINT8 __DebugCodeLocal
365 Macro that marks the end of debug source code.
367 If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,
368 then this macro marks the end of source code that is included in a module.
369 Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END()
370 are not included in a module.
373 #define DEBUG_CODE_END() __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)
378 Macro that declares a section of debug source code.
380 If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,
381 then the source code specified by Expression is included in a module.
382 Otherwise, the source specified by Expression is not included in a module.
385 #define DEBUG_CODE(Expression) \
386 DEBUG_CODE_BEGIN (); \
393 Macro that calls DebugClearMemory() to clear a buffer to a default value.
395 If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set,
396 then this macro calls DebugClearMemory() passing in Address and Length.
398 @param Address Pointer to a buffer.
399 @param Length The number of bytes in the buffer to set.
402 #define DEBUG_CLEAR_MEMORY(Address, Length) \
404 if (DebugClearMemoryEnabled ()) { \
405 DebugClearMemory (Address, Length); \
412 Macro that calls DebugAssert() if the containing record does not have a
413 matching signature. If the signatures matches, then a pointer to the data
414 structure that contains a specified field of that data structure is returned.
415 This is a light weight method hide information by placing a public data
416 structure inside a larger private data structure and using a pointer to the
417 public data structure to retrieve a pointer to the private data structure.
419 If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear,
420 then this macro computes the offset, in bytes, of field specified by Field
421 from the beginning of the data structure specified by TYPE. This offset is
422 subtracted from Record, and is used to return a pointer to a data structure
423 of the type specified by TYPE.
425 If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,
426 then this macro computes the offset, in bytes, of field specified by Field from
427 the beginning of the data structure specified by TYPE. This offset is
428 subtracted from Record, and is used to compute a pointer to a data structure of
429 the type specified by TYPE. The Signature field of the data structure specified
430 by TYPE is compared to TestSignature. If the signatures match, then a pointer
431 to the pointer to a data structure of the type specified by TYPE is returned.
432 If the signatures do not match, then DebugAssert() is called with a description
433 of "CR has a bad signature" and Record is returned.
435 If the data type specified by TYPE does not contain the field specified by Field,
436 then the module will not compile.
438 If TYPE does not contain a field called Signature, then the module will not
441 @param Record Pointer to the field specified by Field within a data
442 structure of type TYPE.
444 @param TYPE The name of the data structure type to return This
445 data structure must contain the field specified by Field.
447 @param Field The name of the field in the data structure specified
448 by TYPE to which Record points.
450 @param TestSignature The 32-bit signature value to match.
453 #define CR(Record, TYPE, Field, TestSignature) \
454 (DebugAssertEnabled () && (_CR (Record, TYPE, Field)->Signature != TestSignature)) ? \
455 (TYPE *) (_ASSERT (CR has Bad Signature), Record) : \
456 _CR (Record, TYPE, Field)