VirtualBox

source: vbox/trunk/src/VBox/Devices/EFI/Firmware/MdePkg/Include/Library/DebugLib.h@ 48748

Last change on this file since 48748 was 48748, checked in by vboxsync, 11 years ago

EFI: Logging.
  • Property svn:eol-style set to native
File size: 20.2 KB
Line 
1/** @file
2 Provides services to print debug and assert messages to a debug output device.
3
4 The Debug library supports debug print and asserts based on a combination of macros and code.
5 The debug library can be turned on and off so that the debug code does not increase the size of an image.
6
7 Note that a reserved macro named MDEPKG_NDEBUG is introduced for the intention
8 of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is
9 defined, then debug and assert related macros wrapped by it are the NULL implementations.
10
11Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
12This program and the accompanying materials are licensed and made available under
13the terms and conditions of the BSD License that accompanies this distribution.
14The full text of the license may be found at
15http://opensource.org/licenses/bsd-license.php.
16
17THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
18WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19
20**/
21
22#ifndef __DEBUG_LIB_H__
23#define __DEBUG_LIB_H__
24
25//
26// Declare bits for PcdDebugPropertyMask
27//
28#define DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED 0x01
29#define DEBUG_PROPERTY_DEBUG_PRINT_ENABLED 0x02
30#define DEBUG_PROPERTY_DEBUG_CODE_ENABLED 0x04
31#define DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED 0x08
32#define DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED 0x10
33#define DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED 0x20
34
35//
36// Declare bits for PcdDebugPrintErrorLevel and the ErrorLevel parameter of DebugPrint()
37//
38#define DEBUG_INIT 0x00000001 // Initialization
39#define DEBUG_WARN 0x00000002 // Warnings
40#define DEBUG_LOAD 0x00000004 // Load events
41#define DEBUG_FS 0x00000008 // EFI File system
42#define DEBUG_POOL 0x00000010 // Alloc & Free's
43#define DEBUG_PAGE 0x00000020 // Alloc & Free's
44#define DEBUG_INFO 0x00000040 // Informational debug messages
45#define DEBUG_DISPATCH 0x00000080 // PEI/DXE/SMM Dispatchers
46#define DEBUG_VARIABLE 0x00000100 // Variable
47#define DEBUG_BM 0x00000400 // Boot Manager
48#define DEBUG_BLKIO 0x00001000 // BlkIo Driver
49#define DEBUG_NET 0x00004000 // SNI Driver
50#define DEBUG_UNDI 0x00010000 // UNDI Driver
51#define DEBUG_LOADFILE 0x00020000 // UNDI Driver
52#define DEBUG_EVENT 0x00080000 // Event messages
53#define DEBUG_GCD 0x00100000 // Global Coherency Database changes
54#define DEBUG_CACHE 0x00200000 // Memory range cachability changes
55#define DEBUG_VERBOSE 0x00400000 // Detailed debug messages that may significantly impact boot performance
56#define DEBUG_ERROR 0x80000000 // Error
57
58//
59// Aliases of debug message mask bits
60//
61#define EFI_D_INIT DEBUG_INIT
62#define EFI_D_WARN DEBUG_WARN
63#define EFI_D_LOAD DEBUG_LOAD
64#define EFI_D_FS DEBUG_FS
65#define EFI_D_POOL DEBUG_POOL
66#define EFI_D_PAGE DEBUG_PAGE
67#define EFI_D_INFO DEBUG_INFO
68#define EFI_D_DISPATCH DEBUG_DISPATCH
69#define EFI_D_VARIABLE DEBUG_VARIABLE
70#define EFI_D_BM DEBUG_BM
71#define EFI_D_BLKIO DEBUG_BLKIO
72#define EFI_D_NET DEBUG_NET
73#define EFI_D_UNDI DEBUG_UNDI
74#define EFI_D_LOADFILE DEBUG_LOADFILE
75#define EFI_D_EVENT DEBUG_EVENT
76#define EFI_D_VERBOSE DEBUG_VERBOSE
77#define EFI_D_ERROR DEBUG_ERROR
78
79/**
80 Prints a debug message to the debug output device if the specified error level is enabled.
81
82 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
83 GetDebugPrintErrorLevel (), then print the message specified by Format and the
84 associated variable argument list to the debug output device.
85
86 If Format is NULL, then ASSERT().
87
88 @param ErrorLevel The error level of the debug message.
89 @param Format The format string for the debug message to print.
90 @param ... The variable argument list whose contents are accessed
91 based on the format string specified by Format.
92
93**/
94VOID
95EFIAPI
96DebugPrint (
97 IN UINTN ErrorLevel,
98 IN CONST CHAR8 *Format,
99 ...
100 );
101
102
103/**
104 Prints an assert message containing a filename, line number, and description.
105 This may be followed by a breakpoint or a dead loop.
106
107 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
108 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
109 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
110 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
111 CpuDeadLoop() is called. If neither of these bits are set, then this function
112 returns immediately after the message is printed to the debug output device.
113 DebugAssert() must actively prevent recursion. If DebugAssert() is called while
114 processing another DebugAssert(), then DebugAssert() must return immediately.
115
116 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
117 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
118
119 @param FileName The pointer to the name of the source file that generated the assert condition.
120 @param LineNumber The line number in the source file that generated the assert condition
121 @param Description The pointer to the description of the assert condition.
122
123**/
124VOID
125EFIAPI
126DebugAssert (
127 IN CONST CHAR8 *FileName,
128 IN UINTN LineNumber,
129 IN CONST CHAR8 *Description
130 );
131
132
133/**
134 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
135
136 This function fills Length bytes of Buffer with the value specified by
137 PcdDebugClearMemoryValue, and returns Buffer.
138
139 If Buffer is NULL, then ASSERT().
140 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
141
142 @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
143 @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
144
145 @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.
146
147**/
148VOID *
149EFIAPI
150DebugClearMemory (
151 OUT VOID *Buffer,
152 IN UINTN Length
153 );
154
155
156/**
157 Returns TRUE if ASSERT() macros are enabled.
158
159 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
160 PcdDebugProperyMask is set. Otherwise, FALSE is returned.
161
162 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
163 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
164
165**/
166BOOLEAN
167EFIAPI
168DebugAssertEnabled (
169 VOID
170 );
171
172
173/**
174 Returns TRUE if DEBUG() macros are enabled.
175
176 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
177 PcdDebugProperyMask is set. Otherwise, FALSE is returned.
178
179 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
180 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
181
182**/
183BOOLEAN
184EFIAPI
185DebugPrintEnabled (
186 VOID
187 );
188
189
190/**
191 Returns TRUE if DEBUG_CODE() macros are enabled.
192
193 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
194 PcdDebugProperyMask is set. Otherwise, FALSE is returned.
195
196 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
197 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
198
199**/
200BOOLEAN
201EFIAPI
202DebugCodeEnabled (
203 VOID
204 );
205
206
207/**
208 Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
209
210 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
211 PcdDebugProperyMask is set. Otherwise, FALSE is returned.
212
213 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
214 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
215
216**/
217BOOLEAN
218EFIAPI
219DebugClearMemoryEnabled (
220 VOID
221 );
222
223
224/**
225 Internal worker macro that calls DebugAssert().
226
227 This macro calls DebugAssert(), passing in the filename, line number, and an
228 expression that evaluated to FALSE.
229
230 @param Expression Boolean expression that evaluated to FALSE
231
232**/
233#define _ASSERT(Expression) DebugAssert (__FILE__, __LINE__, #Expression)
234
235
236/**
237 Internal worker macro that calls DebugPrint().
238
239 This macro calls DebugPrint() passing in the debug error level, a format
240 string, and a variable argument list.
241
242 @param Expression Expression containing an error level, a format string,
243 and a variable argument list based on the format string.
244
245**/
246#define _DEBUG(Expression) DebugPrint Expression
247
248
249/**
250 Macro that calls DebugAssert() if an expression evaluates to FALSE.
251
252 If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
253 bit of PcdDebugProperyMask is set, then this macro evaluates the Boolean
254 expression specified by Expression. If Expression evaluates to FALSE, then
255 DebugAssert() is called passing in the source filename, source line number,
256 and Expression.
257
258 @param Expression Boolean expression.
259
260**/
261#if !defined(MDEPKG_NDEBUG)
262 #define ASSERT(Expression) \
263 do { \
264 if (DebugAssertEnabled ()) { \
265 if (!(Expression)) { \
266 _ASSERT (Expression); \
267 } \
268 } \
269 } while (FALSE)
270#else
271 #define ASSERT(Expression)
272#endif
273
274/**
275 Macro that calls DebugPrint().
276
277 If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
278 bit of PcdDebugProperyMask is set, then this macro passes Expression to
279 DebugPrint().
280
281 @param Expression Expression containing an error level, a format string,
282 and a variable argument list based on the format string.
283
284
285**/
286#if !defined(MDEPKG_NDEBUG)
287 #define DEBUG(Expression) \
288 do { \
289 if (DebugPrintEnabled ()) { \
290 _DEBUG (Expression); \
291 } \
292 } while (FALSE)
293#else
294 #define DEBUG(Expression)
295#endif
296
297/**
298 Macro that calls DebugAssert() if an EFI_STATUS evaluates to an error code.
299
300 If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
301 bit of PcdDebugProperyMask is set, then this macro evaluates the EFI_STATUS
302 value specified by StatusParameter. If StatusParameter is an error code,
303 then DebugAssert() is called passing in the source filename, source line
304 number, and StatusParameter.
305
306 @param StatusParameter EFI_STATUS value to evaluate.
307
308**/
309#if !defined(MDEPKG_NDEBUG)
310 #define ASSERT_EFI_ERROR(StatusParameter) \
311 do { \
312 if (DebugAssertEnabled ()) { \
313 if (EFI_ERROR (StatusParameter)) { \
314 DEBUG ((EFI_D_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter)); \
315 _ASSERT (!EFI_ERROR (StatusParameter)); \
316 } \
317 } \
318 } while (FALSE)
319#else
320 #define ASSERT_EFI_ERROR(StatusParameter)
321#endif
322
323/**
324 Macro that calls DebugAssert() if a protocol is already installed in the
325 handle database.
326
327 If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit
328 of PcdDebugProperyMask is clear, then return.
329
330 If Handle is NULL, then a check is made to see if the protocol specified by Guid
331 is present on any handle in the handle database. If Handle is not NULL, then
332 a check is made to see if the protocol specified by Guid is present on the
333 handle specified by Handle. If the check finds the protocol, then DebugAssert()
334 is called passing in the source filename, source line number, and Guid.
335
336 If Guid is NULL, then ASSERT().
337
338 @param Handle The handle to check for the protocol. This is an optional
339 parameter that may be NULL. If it is NULL, then the entire
340 handle database is searched.
341
342 @param Guid The pointer to a protocol GUID.
343
344**/
345#if !defined(MDEPKG_NDEBUG)
346 #define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid) \
347 do { \
348 if (DebugAssertEnabled ()) { \
349 VOID *Instance; \
350 ASSERT (Guid != NULL); \
351 if (Handle == NULL) { \
352 if (!EFI_ERROR (gBS->LocateProtocol ((EFI_GUID *)Guid, NULL, &Instance))) { \
353 _ASSERT (Guid already installed in database); \
354 } \
355 } else { \
356 if (!EFI_ERROR (gBS->HandleProtocol (Handle, (EFI_GUID *)Guid, &Instance))) { \
357 _ASSERT (Guid already installed on Handle); \
358 } \
359 } \
360 } \
361 } while (FALSE)
362#else
363 #define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)
364#endif
365
366/**
367 Macro that marks the beginning of debug source code.
368
369 If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,
370 then this macro marks the beginning of source code that is included in a module.
371 Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END()
372 are not included in a module.
373
374**/
375#define DEBUG_CODE_BEGIN() do { if (DebugCodeEnabled ()) { UINT8 __DebugCodeLocal
376
377
378/**
379 The macro that marks the end of debug source code.
380
381 If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,
382 then this macro marks the end of source code that is included in a module.
383 Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END()
384 are not included in a module.
385
386**/
387#define DEBUG_CODE_END() __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)
388
389
390/**
391 The macro that declares a section of debug source code.
392
393 If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set,
394 then the source code specified by Expression is included in a module.
395 Otherwise, the source specified by Expression is not included in a module.
396
397**/
398#define DEBUG_CODE(Expression) \
399 DEBUG_CODE_BEGIN (); \
400 Expression \
401 DEBUG_CODE_END ()
402
403
404/**
405 The macro that calls DebugClearMemory() to clear a buffer to a default value.
406
407 If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set,
408 then this macro calls DebugClearMemory() passing in Address and Length.
409
410 @param Address The pointer to a buffer.
411 @param Length The number of bytes in the buffer to set.
412
413**/
414#define DEBUG_CLEAR_MEMORY(Address, Length) \
415 do { \
416 if (DebugClearMemoryEnabled ()) { \
417 DebugClearMemory (Address, Length); \
418 } \
419 } while (FALSE)
420
421
422/**
423 Macro that calls DebugAssert() if the containing record does not have a
424 matching signature. If the signatures matches, then a pointer to the data
425 structure that contains a specified field of that data structure is returned.
426 This is a lightweight method hide information by placing a public data
427 structure inside a larger private data structure and using a pointer to the
428 public data structure to retrieve a pointer to the private data structure.
429
430 If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit
431 of PcdDebugProperyMask is clear, then this macro computes the offset, in bytes,
432 of the field specified by Field from the beginning of the data structure specified
433 by TYPE. This offset is subtracted from Record, and is used to return a pointer
434 to a data structure of the type specified by TYPE.
435
436 If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit
437 of PcdDebugProperyMask is set, then this macro computes the offset, in bytes,
438 of field specified by Field from the beginning of the data structure specified
439 by TYPE. This offset is subtracted from Record, and is used to compute a pointer
440 to a data structure of the type specified by TYPE. The Signature field of the
441 data structure specified by TYPE is compared to TestSignature. If the signatures
442 match, then a pointer to the pointer to a data structure of the type specified by
443 TYPE is returned. If the signatures do not match, then DebugAssert() is called
444 with a description of "CR has a bad signature" and Record is returned.
445
446 If the data type specified by TYPE does not contain the field specified by Field,
447 then the module will not compile.
448
449 If TYPE does not contain a field called Signature, then the module will not
450 compile.
451
452 @param Record The pointer to the field specified by Field within a data
453 structure of type TYPE.
454
455 @param TYPE The name of the data structure type to return This
456 data structure must contain the field specified by Field.
457
458 @param Field The name of the field in the data structure specified
459 by TYPE to which Record points.
460
461 @param TestSignature The 32-bit signature value to match.
462
463**/
464#if !defined(MDEPKG_NDEBUG)
465 #define CR(Record, TYPE, Field, TestSignature) \
466 (DebugAssertEnabled () && (BASE_CR (Record, TYPE, Field)->Signature != TestSignature)) ? \
467 (TYPE *) (_ASSERT (CR has Bad Signature), Record) : \
468 BASE_CR (Record, TYPE, Field)
469#else
470 #define CR(Record, TYPE, Field, TestSignature) \
471 BASE_CR (Record, TYPE, Field)
472#endif
473
474#if defined(VBOX)
475# ifdef __EFI_DEVICE_PATH_PROTOCOL_H__
476CHAR16 *VBoxDebugDevicePath2Str(IN EFI_DEVICE_PATH_PROTOCOL *pDevicePath);
477CHAR16 *VBoxDebugHandleDevicePath2Str(IN EFI_HANDLE hHandle);
478# endif
479VOID EFIAPI VBoxLogWorker(const char *pszFormat, ...);
480
481/** See RT_XSTR */
482# define VBOX_XSTR(str) VBOX_STR(str)
483/** See RT_STR */
484# define VBOX_STR(str) #str
485# if defined(EFI_LOG_ENABLED)
486# define VBoxLogFlowFuncEnter() DEBUG((DEBUG_INFO, "%a:" VBOX_XSTR(__LINE__) ": ENTER\n", __FUNCTION__))
487# define VBoxLogFlowFuncLeave() DEBUG((DEBUG_INFO, "%a:" VBOX_XSTR(__LINE__) ": LEAVE\n", __FUNCTION__))
488# define VBoxLogFlowFuncMark() DEBUG((DEBUG_INFO, "%a:" VBOX_XSTR(__LINE__) "\n", __FUNCTION__))
489# define VBoxLogFlowFuncLeaveRC(rc) \
490 do { \
491 EFI_STATUS rcLog = (rc); \
492 DEBUG((DEBUG_INFO, "%a:" VBOX_XSTR(__LINE__) ": LEAVE " #rc "=0x%x (%r)\n", __FUNCTION__, rcLog, rcLog)); \
493 } while (0)
494# define VBoxLogFlowFuncMarkVar(var, varfmt) \
495 DEBUG((DEBUG_INFO, "%a:" VBOX_XSTR(__LINE__) ": " #var "=" varfmt "\n", __FUNCTION__, (var)))
496# define VBoxLogFlowFuncMarkRC(rc) \
497 do { \
498 EFI_STATUS rcLog = (rc); \
499 DEBUG((DEBUG_INFO, "%a:" VBOX_XSTR(__LINE__) ": " #rc "=0x%x (%r)\n", __FUNCTION__, rcLog, rcLog)); \
500 } while (0)
501# define VBoxLogFlowFuncMarkDP(dp) \
502 DEBUG((DEBUG_INFO, "%a:" VBOX_XSTR(__LINE__) ": " #dp "=%s\n", __FUNCTION__, VBoxDebugDevicePath2Str(dp)))
503# define VBoxLogFlowFuncMarkHandleDP(dp)\
504 DEBUG((DEBUG_INFO, "%a:" VBOX_XSTR(__LINE__) ": " #dp "=%s\n", __FUNCTION__, VBoxDebugHandleDevicePath2Str(dp)))
505# define VBoxLog(a) VBoxLogWorker a
506# else
507# define VBoxLogFlowFuncEnter() do {} while (0)
508# define VBoxLogFlowFuncLeave() do {} while (0)
509# define VBoxLogFlowFuncLeaveRC(rc) do {} while (0)
510# define VBoxLogFlowFuncMark() do {} while (0)
511# define VBoxLogFlowFuncMarkVar(var, varfmt) do {} while (0)
512# define VBoxLogFlowFuncMarkRC(rc) do {} while (0)
513# define VBoxLogFlowFuncMarkDP(dp) do {} while (0)
514# define VBoxLogLogFlowFuncMarkHandleDP(dp) do {} while (0)
515# define VBoxLog(a) do {} while (0)
516# endif
517#endif
518#endif
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette