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