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