]>
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 |
dad8dea7 | 11 | Copyright (c) 2006 - 2011, 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 | |
44 | #define DEBUG_INFO 0x00000040 // Verbose\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 | |
fb3df220 | 55 | #define DEBUG_ERROR 0x80000000 // Error\r |
56 | \r | |
57 | //\r | |
58 | // Aliases of debug message mask bits\r | |
59 | //\r | |
60 | #define EFI_D_INIT DEBUG_INIT\r | |
61 | #define EFI_D_WARN DEBUG_WARN\r | |
62 | #define EFI_D_LOAD DEBUG_LOAD\r | |
63 | #define EFI_D_FS DEBUG_FS\r | |
64 | #define EFI_D_POOL DEBUG_POOL\r | |
65 | #define EFI_D_PAGE DEBUG_PAGE\r | |
66 | #define EFI_D_INFO DEBUG_INFO\r | |
c759eb45 | 67 | #define EFI_D_DISPATCH DEBUG_DISPATCH\r |
fb3df220 | 68 | #define EFI_D_VARIABLE DEBUG_VARIABLE\r |
69 | #define EFI_D_BM DEBUG_BM\r | |
70 | #define EFI_D_BLKIO DEBUG_BLKIO\r | |
71 | #define EFI_D_NET DEBUG_NET\r | |
72 | #define EFI_D_UNDI DEBUG_UNDI\r | |
73 | #define EFI_D_LOADFILE DEBUG_LOADFILE\r | |
74 | #define EFI_D_EVENT DEBUG_EVENT\r | |
75 | #define EFI_D_ERROR DEBUG_ERROR\r | |
76 | \r | |
77 | /**\r | |
fb3df220 | 78 | Prints a debug message to the debug output device if the specified error level is enabled.\r |
79 | \r | |
2891fc8b | 80 | If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function \r |
81 | GetDebugPrintErrorLevel (), then print the message specified by Format and the \r | |
82 | associated variable argument list to the debug output device.\r | |
fb3df220 | 83 | \r |
84 | If Format is NULL, then ASSERT().\r | |
85 | \r | |
86 | @param ErrorLevel The error level of the debug message.\r | |
af2dc6a7 | 87 | @param Format The format string for the debug message to print.\r |
88 | @param ... The variable argument list whose contents are accessed \r | |
285010e7 | 89 | based on the format string specified by Format.\r |
fb3df220 | 90 | \r |
91 | **/\r | |
92 | VOID\r | |
93 | EFIAPI\r | |
94 | DebugPrint (\r | |
95 | IN UINTN ErrorLevel,\r | |
96 | IN CONST CHAR8 *Format,\r | |
97 | ...\r | |
98 | );\r | |
99 | \r | |
100 | \r | |
101 | /**\r | |
fb3df220 | 102 | Prints an assert message containing a filename, line number, and description. \r |
103 | This may be followed by a breakpoint or a dead loop.\r | |
104 | \r | |
105 | Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r | |
106 | to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r | |
107 | PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r | |
108 | DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r | |
109 | CpuDeadLoop() is called. If neither of these bits are set, then this function \r | |
110 | returns immediately after the message is printed to the debug output device.\r | |
584125bc | 111 | DebugAssert() must actively prevent recursion. If DebugAssert() is called while\r |
fb3df220 | 112 | processing another DebugAssert(), then DebugAssert() must return immediately.\r |
113 | \r | |
584125bc | 114 | If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r |
584125bc | 115 | If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r |
fb3df220 | 116 | \r |
af2dc6a7 | 117 | @param FileName The pointer to the name of the source file that generated the assert condition.\r |
fb3df220 | 118 | @param LineNumber The line number in the source file that generated the assert condition\r |
af2dc6a7 | 119 | @param Description The pointer to the description of the assert condition.\r |
fb3df220 | 120 | \r |
121 | **/\r | |
122 | VOID\r | |
123 | EFIAPI\r | |
124 | DebugAssert (\r | |
125 | IN CONST CHAR8 *FileName,\r | |
126 | IN UINTN LineNumber,\r | |
127 | IN CONST CHAR8 *Description\r | |
128 | );\r | |
129 | \r | |
130 | \r | |
131 | /**\r | |
fb3df220 | 132 | Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r |
133 | \r | |
134 | This function fills Length bytes of Buffer with the value specified by \r | |
135 | PcdDebugClearMemoryValue, and returns Buffer.\r | |
136 | \r | |
137 | If Buffer is NULL, then ASSERT().\r | |
2281e7a9 | 138 | If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r |
fb3df220 | 139 | \r |
af2dc6a7 | 140 | @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r |
141 | @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r | |
fb3df220 | 142 | \r |
af2dc6a7 | 143 | @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r |
fb3df220 | 144 | \r |
145 | **/\r | |
146 | VOID *\r | |
147 | EFIAPI\r | |
148 | DebugClearMemory (\r | |
149 | OUT VOID *Buffer,\r | |
150 | IN UINTN Length\r | |
151 | );\r | |
152 | \r | |
153 | \r | |
154 | /**\r | |
fb3df220 | 155 | Returns TRUE if ASSERT() macros are enabled.\r |
156 | \r | |
157 | This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r | |
af2dc6a7 | 158 | PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r |
fb3df220 | 159 | \r |
160 | @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r | |
161 | @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r | |
162 | \r | |
163 | **/\r | |
164 | BOOLEAN\r | |
165 | EFIAPI\r | |
166 | DebugAssertEnabled (\r | |
167 | VOID\r | |
168 | );\r | |
169 | \r | |
170 | \r | |
3e5c3238 | 171 | /** \r |
172 | Returns TRUE if DEBUG() macros are enabled.\r | |
fb3df220 | 173 | \r |
174 | This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r | |
af2dc6a7 | 175 | PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r |
fb3df220 | 176 | \r |
177 | @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r | |
178 | @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r | |
179 | \r | |
180 | **/\r | |
181 | BOOLEAN\r | |
182 | EFIAPI\r | |
183 | DebugPrintEnabled (\r | |
184 | VOID\r | |
185 | );\r | |
186 | \r | |
187 | \r | |
3e5c3238 | 188 | /** \r |
189 | Returns TRUE if DEBUG_CODE() macros are enabled.\r | |
fb3df220 | 190 | \r |
191 | This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r | |
af2dc6a7 | 192 | PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r |
fb3df220 | 193 | \r |
194 | @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r | |
195 | @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r | |
196 | \r | |
197 | **/\r | |
198 | BOOLEAN\r | |
199 | EFIAPI\r | |
200 | DebugCodeEnabled (\r | |
201 | VOID\r | |
202 | );\r | |
203 | \r | |
204 | \r | |
3e5c3238 | 205 | /** \r |
206 | Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r | |
fb3df220 | 207 | \r |
eceb3a4c | 208 | This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r |
af2dc6a7 | 209 | PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r |
fb3df220 | 210 | \r |
eceb3a4c LG |
211 | @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r |
212 | @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r | |
fb3df220 | 213 | \r |
214 | **/\r | |
215 | BOOLEAN\r | |
216 | EFIAPI\r | |
217 | DebugClearMemoryEnabled (\r | |
218 | VOID\r | |
219 | );\r | |
220 | \r | |
221 | \r | |
3e5c3238 | 222 | /** \r |
fb3df220 | 223 | Internal worker macro that calls DebugAssert().\r |
224 | \r | |
1a2f870c | 225 | This macro calls DebugAssert(), passing in the filename, line number, and an\r |
226 | expression that evaluated to FALSE.\r | |
fb3df220 | 227 | \r |
1a2f870c | 228 | @param Expression Boolean expression that evaluated to FALSE\r |
fb3df220 | 229 | \r |
230 | **/\r | |
231 | #define _ASSERT(Expression) DebugAssert (__FILE__, __LINE__, #Expression)\r | |
232 | \r | |
233 | \r | |
3e5c3238 | 234 | /** \r |
fb3df220 | 235 | Internal worker macro that calls DebugPrint().\r |
236 | \r | |
237 | This macro calls DebugPrint() passing in the debug error level, a format \r | |
238 | string, and a variable argument list.\r | |
239 | \r | |
240 | @param Expression Expression containing an error level, a format string, \r | |
241 | and a variable argument list based on the format string.\r | |
242 | \r | |
243 | **/\r | |
244 | #define _DEBUG(Expression) DebugPrint Expression\r | |
245 | \r | |
246 | \r | |
3e5c3238 | 247 | /** \r |
1a2f870c | 248 | Macro that calls DebugAssert() if an expression evaluates to FALSE.\r |
fb3df220 | 249 | \r |
c9ec7047 | 250 | If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED \r |
251 | bit of PcdDebugProperyMask is set, then this macro evaluates the Boolean \r | |
252 | expression specified by Expression. If Expression evaluates to FALSE, then \r | |
253 | DebugAssert() is called passing in the source filename, source line number, \r | |
254 | and Expression.\r | |
fb3df220 | 255 | \r |
af2dc6a7 | 256 | @param Expression Boolean expression.\r |
fb3df220 | 257 | \r |
258 | **/\r | |
c9ec7047 | 259 | #if !defined(MDEPKG_NDEBUG) \r |
260 | #define ASSERT(Expression) \\r | |
261 | do { \\r | |
262 | if (DebugAssertEnabled ()) { \\r | |
263 | if (!(Expression)) { \\r | |
264 | _ASSERT (Expression); \\r | |
265 | } \\r | |
266 | } \\r | |
267 | } while (FALSE)\r | |
268 | #else\r | |
269 | #define ASSERT(Expression)\r | |
270 | #endif\r | |
fb3df220 | 271 | \r |
3e5c3238 | 272 | /** \r |
fb3df220 | 273 | Macro that calls DebugPrint().\r |
274 | \r | |
c9ec7047 | 275 | If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED \r |
276 | bit of PcdDebugProperyMask is set, then this macro passes Expression to \r | |
277 | DebugPrint().\r | |
fb3df220 | 278 | \r |
279 | @param Expression Expression containing an error level, a format string, \r | |
280 | and a variable argument list based on the format string.\r | |
281 | \r | |
282 | \r | |
283 | **/\r | |
c9ec7047 | 284 | #if !defined(MDEPKG_NDEBUG) \r |
285 | #define DEBUG(Expression) \\r | |
286 | do { \\r | |
287 | if (DebugPrintEnabled ()) { \\r | |
288 | _DEBUG (Expression); \\r | |
289 | } \\r | |
290 | } while (FALSE)\r | |
291 | #else\r | |
292 | #define DEBUG(Expression)\r | |
293 | #endif\r | |
fb3df220 | 294 | \r |
3e5c3238 | 295 | /** \r |
fb3df220 | 296 | Macro that calls DebugAssert() if an EFI_STATUS evaluates to an error code.\r |
297 | \r | |
c9ec7047 | 298 | If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED \r |
299 | bit of PcdDebugProperyMask is set, then this macro evaluates the EFI_STATUS \r | |
300 | value specified by StatusParameter. If StatusParameter is an error code, \r | |
301 | then DebugAssert() is called passing in the source filename, source line \r | |
302 | number, and StatusParameter.\r | |
fb3df220 | 303 | \r |
304 | @param StatusParameter EFI_STATUS value to evaluate.\r | |
305 | \r | |
306 | **/\r | |
c9ec7047 | 307 | #if !defined(MDEPKG_NDEBUG)\r |
308 | #define ASSERT_EFI_ERROR(StatusParameter) \\r | |
309 | do { \\r | |
310 | if (DebugAssertEnabled ()) { \\r | |
311 | if (EFI_ERROR (StatusParameter)) { \\r | |
312 | DEBUG ((EFI_D_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter)); \\r | |
313 | _ASSERT (!EFI_ERROR (StatusParameter)); \\r | |
314 | } \\r | |
315 | } \\r | |
316 | } while (FALSE)\r | |
317 | #else\r | |
318 | #define ASSERT_EFI_ERROR(StatusParameter)\r | |
319 | #endif\r | |
fb3df220 | 320 | \r |
3e5c3238 | 321 | /** \r |
fb3df220 | 322 | Macro that calls DebugAssert() if a protocol is already installed in the \r |
323 | handle database.\r | |
324 | \r | |
c9ec7047 | 325 | If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit \r |
326 | of PcdDebugProperyMask is clear, then return.\r | |
fb3df220 | 327 | \r |
328 | If Handle is NULL, then a check is made to see if the protocol specified by Guid \r | |
329 | is present on any handle in the handle database. If Handle is not NULL, then \r | |
330 | a check is made to see if the protocol specified by Guid is present on the \r | |
331 | handle specified by Handle. If the check finds the protocol, then DebugAssert() \r | |
332 | is called passing in the source filename, source line number, and Guid.\r | |
333 | \r | |
334 | If Guid is NULL, then ASSERT().\r | |
335 | \r | |
336 | @param Handle The handle to check for the protocol. This is an optional \r | |
337 | parameter that may be NULL. If it is NULL, then the entire \r | |
338 | handle database is searched.\r | |
339 | \r | |
af2dc6a7 | 340 | @param Guid The pointer to a protocol GUID.\r |
fb3df220 | 341 | \r |
342 | **/\r | |
c9ec7047 | 343 | #if !defined(MDEPKG_NDEBUG)\r |
344 | #define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid) \\r | |
345 | do { \\r | |
346 | if (DebugAssertEnabled ()) { \\r | |
347 | VOID *Instance; \\r | |
348 | ASSERT (Guid != NULL); \\r | |
349 | if (Handle == NULL) { \\r | |
350 | if (!EFI_ERROR (gBS->LocateProtocol ((EFI_GUID *)Guid, NULL, &Instance))) { \\r | |
351 | _ASSERT (Guid already installed in database); \\r | |
352 | } \\r | |
353 | } else { \\r | |
354 | if (!EFI_ERROR (gBS->HandleProtocol (Handle, (EFI_GUID *)Guid, &Instance))) { \\r | |
355 | _ASSERT (Guid already installed on Handle); \\r | |
356 | } \\r | |
357 | } \\r | |
358 | } \\r | |
359 | } while (FALSE)\r | |
360 | #else\r | |
361 | #define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)\r | |
362 | #endif\r | |
fb3df220 | 363 | \r |
364 | /**\r | |
365 | Macro that marks the beginning 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 beginning 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_BEGIN() do { if (DebugCodeEnabled ()) { UINT8 __DebugCodeLocal\r | |
374 | \r | |
375 | \r | |
3e5c3238 | 376 | /** \r |
af2dc6a7 | 377 | The macro that marks the end of debug source code.\r |
fb3df220 | 378 | \r |
379 | If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r | |
380 | then this macro marks the end of source code that is included in a module. \r | |
381 | Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END() \r | |
382 | are not included in a module.\r | |
383 | \r | |
384 | **/\r | |
385 | #define DEBUG_CODE_END() __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)\r | |
386 | \r | |
387 | \r | |
3e5c3238 | 388 | /** \r |
af2dc6a7 | 389 | The macro that declares a section of debug source code.\r |
fb3df220 | 390 | \r |
391 | If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r | |
392 | then the source code specified by Expression is included in a module. \r | |
393 | Otherwise, the source specified by Expression is not included in a module.\r | |
394 | \r | |
395 | **/\r | |
396 | #define DEBUG_CODE(Expression) \\r | |
397 | DEBUG_CODE_BEGIN (); \\r | |
398 | Expression \\r | |
399 | DEBUG_CODE_END ()\r | |
400 | \r | |
401 | \r | |
3e5c3238 | 402 | /** \r |
af2dc6a7 | 403 | The macro that calls DebugClearMemory() to clear a buffer to a default value.\r |
fb3df220 | 404 | \r |
405 | If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set, \r | |
406 | then this macro calls DebugClearMemory() passing in Address and Length.\r | |
407 | \r | |
af2dc6a7 | 408 | @param Address The pointer to a buffer.\r |
fb3df220 | 409 | @param Length The number of bytes in the buffer to set.\r |
410 | \r | |
411 | **/\r | |
412 | #define DEBUG_CLEAR_MEMORY(Address, Length) \\r | |
413 | do { \\r | |
414 | if (DebugClearMemoryEnabled ()) { \\r | |
415 | DebugClearMemory (Address, Length); \\r | |
416 | } \\r | |
417 | } while (FALSE)\r | |
418 | \r | |
419 | \r | |
420 | /**\r | |
fb3df220 | 421 | Macro that calls DebugAssert() if the containing record does not have a \r |
422 | matching signature. If the signatures matches, then a pointer to the data \r | |
423 | structure that contains a specified field of that data structure is returned. \r | |
af2dc6a7 | 424 | This is a lightweight method hide information by placing a public data \r |
fb3df220 | 425 | structure inside a larger private data structure and using a pointer to the \r |
426 | public data structure to retrieve a pointer to the private data structure.\r | |
427 | \r | |
c9ec7047 | 428 | If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit \r |
429 | of PcdDebugProperyMask is clear, then this macro computes the offset, in bytes,\r | |
af2dc6a7 | 430 | of the field specified by Field from the beginning of the data structure specified \r |
c9ec7047 | 431 | by TYPE. This offset is subtracted from Record, and is used to return a pointer \r |
432 | to a data structure of the type specified by TYPE.\r | |
433 | \r | |
434 | If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit\r | |
435 | of PcdDebugProperyMask is set, then this macro computes the offset, in bytes, \r | |
436 | of field specified by Field from the beginning of the data structure specified \r | |
437 | by TYPE. This offset is subtracted from Record, and is used to compute a pointer\r | |
438 | to a data structure of the type specified by TYPE. The Signature field of the \r | |
439 | data structure specified by TYPE is compared to TestSignature. If the signatures \r | |
440 | match, then a pointer to the pointer to a data structure of the type specified by \r | |
441 | TYPE is returned. If the signatures do not match, then DebugAssert() is called \r | |
442 | with a description of "CR has a bad signature" and Record is returned. \r | |
fb3df220 | 443 | \r |
444 | If the data type specified by TYPE does not contain the field specified by Field, \r | |
445 | then the module will not compile.\r | |
446 | \r | |
447 | If TYPE does not contain a field called Signature, then the module will not \r | |
448 | compile.\r | |
449 | \r | |
af2dc6a7 | 450 | @param Record The pointer to the field specified by Field within a data \r |
fb3df220 | 451 | structure of type TYPE.\r |
452 | \r | |
453 | @param TYPE The name of the data structure type to return This \r | |
454 | data structure must contain the field specified by Field. \r | |
455 | \r | |
456 | @param Field The name of the field in the data structure specified \r | |
457 | by TYPE to which Record points.\r | |
458 | \r | |
459 | @param TestSignature The 32-bit signature value to match.\r | |
460 | \r | |
461 | **/\r | |
c9ec7047 | 462 | #if !defined(MDEPKG_NDEBUG)\r |
463 | #define CR(Record, TYPE, Field, TestSignature) \\r | |
464 | (DebugAssertEnabled () && (BASE_CR (Record, TYPE, Field)->Signature != TestSignature)) ? \\r | |
465 | (TYPE *) (_ASSERT (CR has Bad Signature), Record) : \\r | |
466 | BASE_CR (Record, TYPE, Field)\r | |
467 | #else\r | |
468 | #define CR(Record, TYPE, Field, TestSignature) \\r | |
469 | BASE_CR (Record, TYPE, Field)\r | |
470 | #endif\r | |
fb3df220 | 471 | \r |
472 | #endif\r |