MdePkg/Include: Add enumeration size checks to Base.h
[mirror_edk2.git] / MdePkg / Include / Base.h
1 /** @file
2 Root include file for Mde Package Base type modules
3
4 This is the include file for any module of type base. Base modules only use
5 types defined via this include file and can be ported easily to any
6 environment. There are a set of base libraries in the Mde Package that can
7 be used to implement base modules.
8
9 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
10 Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
11 This program and the accompanying materials
12 are licensed and made available under the terms and conditions of the BSD License
13 which accompanies this distribution. The full text of the license may be found at
14 http://opensource.org/licenses/bsd-license.php.
15
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18
19 **/
20
21
22 #ifndef __BASE_H__
23 #define __BASE_H__
24
25 //
26 // Include processor specific binding
27 //
28 #include <ProcessorBind.h>
29
30 #if defined(_MSC_EXTENSIONS)
31 //
32 // Disable warning when last field of data structure is a zero sized array.
33 //
34 #pragma warning ( disable : 4200 )
35 #endif
36
37 /**
38 Verifies the storage size of a given data type.
39
40 This macro generates a divide by zero error or a zero size array declaration in
41 the preprocessor if the size is incorrect. These are declared as "extern" so
42 the space for these arrays will not be in the modules.
43
44 @param TYPE The date type to determine the size of.
45 @param Size The expected size for the TYPE.
46
47 **/
48 #define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]
49
50 //
51 // Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
52 // Section 2.3.1 of the UEFI 2.3 Specification.
53 //
54 VERIFY_SIZE_OF (BOOLEAN, 1);
55 VERIFY_SIZE_OF (INT8, 1);
56 VERIFY_SIZE_OF (UINT8, 1);
57 VERIFY_SIZE_OF (INT16, 2);
58 VERIFY_SIZE_OF (UINT16, 2);
59 VERIFY_SIZE_OF (INT32, 4);
60 VERIFY_SIZE_OF (UINT32, 4);
61 VERIFY_SIZE_OF (INT64, 8);
62 VERIFY_SIZE_OF (UINT64, 8);
63 VERIFY_SIZE_OF (CHAR8, 1);
64 VERIFY_SIZE_OF (CHAR16, 2);
65
66 typedef enum {
67 __VerifyUint8EnumValue = 0xff
68 } __VERIFY_UINT8_ENUM_SIZE;
69
70 typedef enum {
71 __VerifyUint16EnumValue = 0xffff
72 } __VERIFY_UINT16_ENUM_SIZE;
73
74 typedef enum {
75 __VerifyUint32EnumValue = 0xffffffff
76 } __VERIFY_UINT32_ENUM_SIZE;
77
78 VERIFY_SIZE_OF (__VERIFY_UINT8_ENUM_SIZE, 4);
79 VERIFY_SIZE_OF (__VERIFY_UINT16_ENUM_SIZE, 4);
80 VERIFY_SIZE_OF (__VERIFY_UINT32_ENUM_SIZE, 4);
81
82 //
83 // The Microsoft* C compiler can removed references to unreferenced data items
84 // if the /OPT:REF linker option is used. We defined a macro as this is a
85 // a non standard extension
86 //
87 #if defined(_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)
88 ///
89 /// Remove global variable from the linked image if there are no references to
90 /// it after all compiler and linker optimizations have been performed.
91 ///
92 ///
93 #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
94 #else
95 ///
96 /// Remove the global variable from the linked image if there are no references
97 /// to it after all compiler and linker optimizations have been performed.
98 ///
99 ///
100 #define GLOBAL_REMOVE_IF_UNREFERENCED
101 #endif
102
103 //
104 // Should be used in combination with NORETURN to avoid 'noreturn' returns
105 // warnings.
106 //
107 #ifndef UNREACHABLE
108 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 4)
109 ///
110 /// Signal compilers and analyzers that this call is not reachable. It is
111 /// up to the compiler to remove any code past that point.
112 /// Not implemented by GCC 4.4 or earlier.
113 ///
114 #define UNREACHABLE() __builtin_unreachable ()
115 #elif defined (__has_feature)
116 #if __has_builtin (__builtin_unreachable)
117 ///
118 /// Signal compilers and analyzers that this call is not reachable. It is
119 /// up to the compiler to remove any code past that point.
120 ///
121 #define UNREACHABLE() __builtin_unreachable ()
122 #endif
123 #endif
124
125 #ifndef UNREACHABLE
126 ///
127 /// Signal compilers and analyzers that this call is not reachable. It is
128 /// up to the compiler to remove any code past that point.
129 ///
130 #define UNREACHABLE()
131 #endif
132 #endif
133
134 //
135 // Signaling compilers and analyzers that a certain function cannot return may
136 // remove all following code and thus lead to better optimization and less
137 // false positives.
138 //
139 #ifndef NORETURN
140 #if defined (__GNUC__) || defined (__clang__)
141 ///
142 /// Signal compilers and analyzers that the function cannot return.
143 /// It is up to the compiler to remove any code past a call to functions
144 /// flagged with this attribute.
145 ///
146 #define NORETURN __attribute__((noreturn))
147 #elif defined(_MSC_EXTENSIONS) && !defined(MDE_CPU_EBC)
148 ///
149 /// Signal compilers and analyzers that the function cannot return.
150 /// It is up to the compiler to remove any code past a call to functions
151 /// flagged with this attribute.
152 ///
153 #define NORETURN __declspec(noreturn)
154 #else
155 ///
156 /// Signal compilers and analyzers that the function cannot return.
157 /// It is up to the compiler to remove any code past a call to functions
158 /// flagged with this attribute.
159 ///
160 #define NORETURN
161 #endif
162 #endif
163
164 //
165 // Should be used in combination with ANALYZER_NORETURN to avoid 'noreturn'
166 // returns warnings.
167 //
168 #ifndef ANALYZER_UNREACHABLE
169 #ifdef __clang_analyzer__
170 #if __has_builtin (__builtin_unreachable)
171 ///
172 /// Signal the analyzer that this call is not reachable.
173 /// This excludes compilers.
174 ///
175 #define ANALYZER_UNREACHABLE() __builtin_unreachable ()
176 #endif
177 #endif
178
179 #ifndef ANALYZER_UNREACHABLE
180 ///
181 /// Signal the analyzer that this call is not reachable.
182 /// This excludes compilers.
183 ///
184 #define ANALYZER_UNREACHABLE()
185 #endif
186 #endif
187
188 //
189 // Static Analyzers may issue errors about potential NULL-dereferences when
190 // dereferencing a pointer, that has been checked before, outside of a
191 // NULL-check. This may lead to false positives, such as when using ASSERT()
192 // for verification.
193 //
194 #ifndef ANALYZER_NORETURN
195 #ifdef __has_feature
196 #if __has_feature (attribute_analyzer_noreturn)
197 ///
198 /// Signal analyzers that the function cannot return.
199 /// This excludes compilers.
200 ///
201 #define ANALYZER_NORETURN __attribute__((analyzer_noreturn))
202 #endif
203 #endif
204
205 #ifndef ANALYZER_NORETURN
206 ///
207 /// Signal the analyzer that the function cannot return.
208 /// This excludes compilers.
209 ///
210 #define ANALYZER_NORETURN
211 #endif
212 #endif
213
214 //
215 // For symbol name in assembly code, an extra "_" is sometimes necessary
216 //
217
218 ///
219 /// Private worker functions for ASM_PFX()
220 ///
221 #define _CONCATENATE(a, b) __CONCATENATE(a, b)
222 #define __CONCATENATE(a, b) a ## b
223
224 ///
225 /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix
226 /// on symbols in assembly language.
227 ///
228 #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)
229
230 #if __APPLE__
231 //
232 // Apple extension that is used by the linker to optimize code size
233 // with assembly functions. Put at the end of your .S files
234 //
235 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols
236 #else
237 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED
238 #endif
239
240 #ifdef __CC_ARM
241 //
242 // Older RVCT ARM compilers don't fully support #pragma pack and require __packed
243 // as a prefix for the structure.
244 //
245 #define PACKED __packed
246 #else
247 #define PACKED
248 #endif
249
250 ///
251 /// 128 bit buffer containing a unique identifier value.
252 /// Unless otherwise specified, aligned on a 64 bit boundary.
253 ///
254 typedef struct {
255 UINT32 Data1;
256 UINT16 Data2;
257 UINT16 Data3;
258 UINT8 Data4[8];
259 } GUID;
260
261 //
262 // 8-bytes unsigned value that represents a physical system address.
263 //
264 typedef UINT64 PHYSICAL_ADDRESS;
265
266 ///
267 /// LIST_ENTRY structure definition.
268 ///
269 typedef struct _LIST_ENTRY LIST_ENTRY;
270
271 ///
272 /// _LIST_ENTRY structure definition.
273 ///
274 struct _LIST_ENTRY {
275 LIST_ENTRY *ForwardLink;
276 LIST_ENTRY *BackLink;
277 };
278
279 //
280 // Modifiers to abstract standard types to aid in debug of problems
281 //
282
283 ///
284 /// Datum is read-only.
285 ///
286 #define CONST const
287
288 ///
289 /// Datum is scoped to the current file or function.
290 ///
291 #define STATIC static
292
293 ///
294 /// Undeclared type.
295 ///
296 #define VOID void
297
298 //
299 // Modifiers for Data Types used to self document code.
300 // This concept is borrowed for UEFI specification.
301 //
302
303 ///
304 /// Datum is passed to the function.
305 ///
306 #define IN
307
308 ///
309 /// Datum is returned from the function.
310 ///
311 #define OUT
312
313 ///
314 /// Passing the datum to the function is optional, and a NULL
315 /// is passed if the value is not supplied.
316 ///
317 #define OPTIONAL
318
319 //
320 // UEFI specification claims 1 and 0. We are concerned about the
321 // compiler portability so we did it this way.
322 //
323
324 ///
325 /// Boolean true value. UEFI Specification defines this value to be 1,
326 /// but this form is more portable.
327 ///
328 #define TRUE ((BOOLEAN)(1==1))
329
330 ///
331 /// Boolean false value. UEFI Specification defines this value to be 0,
332 /// but this form is more portable.
333 ///
334 #define FALSE ((BOOLEAN)(0==1))
335
336 ///
337 /// NULL pointer (VOID *)
338 ///
339 #define NULL ((VOID *) 0)
340
341 ///
342 /// Maximum values for common UEFI Data Types
343 ///
344 #define MAX_INT8 ((INT8)0x7F)
345 #define MAX_UINT8 ((UINT8)0xFF)
346 #define MAX_INT16 ((INT16)0x7FFF)
347 #define MAX_UINT16 ((UINT16)0xFFFF)
348 #define MAX_INT32 ((INT32)0x7FFFFFFF)
349 #define MAX_UINT32 ((UINT32)0xFFFFFFFF)
350 #define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)
351 #define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)
352
353 #define BIT0 0x00000001
354 #define BIT1 0x00000002
355 #define BIT2 0x00000004
356 #define BIT3 0x00000008
357 #define BIT4 0x00000010
358 #define BIT5 0x00000020
359 #define BIT6 0x00000040
360 #define BIT7 0x00000080
361 #define BIT8 0x00000100
362 #define BIT9 0x00000200
363 #define BIT10 0x00000400
364 #define BIT11 0x00000800
365 #define BIT12 0x00001000
366 #define BIT13 0x00002000
367 #define BIT14 0x00004000
368 #define BIT15 0x00008000
369 #define BIT16 0x00010000
370 #define BIT17 0x00020000
371 #define BIT18 0x00040000
372 #define BIT19 0x00080000
373 #define BIT20 0x00100000
374 #define BIT21 0x00200000
375 #define BIT22 0x00400000
376 #define BIT23 0x00800000
377 #define BIT24 0x01000000
378 #define BIT25 0x02000000
379 #define BIT26 0x04000000
380 #define BIT27 0x08000000
381 #define BIT28 0x10000000
382 #define BIT29 0x20000000
383 #define BIT30 0x40000000
384 #define BIT31 0x80000000
385 #define BIT32 0x0000000100000000ULL
386 #define BIT33 0x0000000200000000ULL
387 #define BIT34 0x0000000400000000ULL
388 #define BIT35 0x0000000800000000ULL
389 #define BIT36 0x0000001000000000ULL
390 #define BIT37 0x0000002000000000ULL
391 #define BIT38 0x0000004000000000ULL
392 #define BIT39 0x0000008000000000ULL
393 #define BIT40 0x0000010000000000ULL
394 #define BIT41 0x0000020000000000ULL
395 #define BIT42 0x0000040000000000ULL
396 #define BIT43 0x0000080000000000ULL
397 #define BIT44 0x0000100000000000ULL
398 #define BIT45 0x0000200000000000ULL
399 #define BIT46 0x0000400000000000ULL
400 #define BIT47 0x0000800000000000ULL
401 #define BIT48 0x0001000000000000ULL
402 #define BIT49 0x0002000000000000ULL
403 #define BIT50 0x0004000000000000ULL
404 #define BIT51 0x0008000000000000ULL
405 #define BIT52 0x0010000000000000ULL
406 #define BIT53 0x0020000000000000ULL
407 #define BIT54 0x0040000000000000ULL
408 #define BIT55 0x0080000000000000ULL
409 #define BIT56 0x0100000000000000ULL
410 #define BIT57 0x0200000000000000ULL
411 #define BIT58 0x0400000000000000ULL
412 #define BIT59 0x0800000000000000ULL
413 #define BIT60 0x1000000000000000ULL
414 #define BIT61 0x2000000000000000ULL
415 #define BIT62 0x4000000000000000ULL
416 #define BIT63 0x8000000000000000ULL
417
418 #define SIZE_1KB 0x00000400
419 #define SIZE_2KB 0x00000800
420 #define SIZE_4KB 0x00001000
421 #define SIZE_8KB 0x00002000
422 #define SIZE_16KB 0x00004000
423 #define SIZE_32KB 0x00008000
424 #define SIZE_64KB 0x00010000
425 #define SIZE_128KB 0x00020000
426 #define SIZE_256KB 0x00040000
427 #define SIZE_512KB 0x00080000
428 #define SIZE_1MB 0x00100000
429 #define SIZE_2MB 0x00200000
430 #define SIZE_4MB 0x00400000
431 #define SIZE_8MB 0x00800000
432 #define SIZE_16MB 0x01000000
433 #define SIZE_32MB 0x02000000
434 #define SIZE_64MB 0x04000000
435 #define SIZE_128MB 0x08000000
436 #define SIZE_256MB 0x10000000
437 #define SIZE_512MB 0x20000000
438 #define SIZE_1GB 0x40000000
439 #define SIZE_2GB 0x80000000
440 #define SIZE_4GB 0x0000000100000000ULL
441 #define SIZE_8GB 0x0000000200000000ULL
442 #define SIZE_16GB 0x0000000400000000ULL
443 #define SIZE_32GB 0x0000000800000000ULL
444 #define SIZE_64GB 0x0000001000000000ULL
445 #define SIZE_128GB 0x0000002000000000ULL
446 #define SIZE_256GB 0x0000004000000000ULL
447 #define SIZE_512GB 0x0000008000000000ULL
448 #define SIZE_1TB 0x0000010000000000ULL
449 #define SIZE_2TB 0x0000020000000000ULL
450 #define SIZE_4TB 0x0000040000000000ULL
451 #define SIZE_8TB 0x0000080000000000ULL
452 #define SIZE_16TB 0x0000100000000000ULL
453 #define SIZE_32TB 0x0000200000000000ULL
454 #define SIZE_64TB 0x0000400000000000ULL
455 #define SIZE_128TB 0x0000800000000000ULL
456 #define SIZE_256TB 0x0001000000000000ULL
457 #define SIZE_512TB 0x0002000000000000ULL
458 #define SIZE_1PB 0x0004000000000000ULL
459 #define SIZE_2PB 0x0008000000000000ULL
460 #define SIZE_4PB 0x0010000000000000ULL
461 #define SIZE_8PB 0x0020000000000000ULL
462 #define SIZE_16PB 0x0040000000000000ULL
463 #define SIZE_32PB 0x0080000000000000ULL
464 #define SIZE_64PB 0x0100000000000000ULL
465 #define SIZE_128PB 0x0200000000000000ULL
466 #define SIZE_256PB 0x0400000000000000ULL
467 #define SIZE_512PB 0x0800000000000000ULL
468 #define SIZE_1EB 0x1000000000000000ULL
469 #define SIZE_2EB 0x2000000000000000ULL
470 #define SIZE_4EB 0x4000000000000000ULL
471 #define SIZE_8EB 0x8000000000000000ULL
472
473 #define BASE_1KB 0x00000400
474 #define BASE_2KB 0x00000800
475 #define BASE_4KB 0x00001000
476 #define BASE_8KB 0x00002000
477 #define BASE_16KB 0x00004000
478 #define BASE_32KB 0x00008000
479 #define BASE_64KB 0x00010000
480 #define BASE_128KB 0x00020000
481 #define BASE_256KB 0x00040000
482 #define BASE_512KB 0x00080000
483 #define BASE_1MB 0x00100000
484 #define BASE_2MB 0x00200000
485 #define BASE_4MB 0x00400000
486 #define BASE_8MB 0x00800000
487 #define BASE_16MB 0x01000000
488 #define BASE_32MB 0x02000000
489 #define BASE_64MB 0x04000000
490 #define BASE_128MB 0x08000000
491 #define BASE_256MB 0x10000000
492 #define BASE_512MB 0x20000000
493 #define BASE_1GB 0x40000000
494 #define BASE_2GB 0x80000000
495 #define BASE_4GB 0x0000000100000000ULL
496 #define BASE_8GB 0x0000000200000000ULL
497 #define BASE_16GB 0x0000000400000000ULL
498 #define BASE_32GB 0x0000000800000000ULL
499 #define BASE_64GB 0x0000001000000000ULL
500 #define BASE_128GB 0x0000002000000000ULL
501 #define BASE_256GB 0x0000004000000000ULL
502 #define BASE_512GB 0x0000008000000000ULL
503 #define BASE_1TB 0x0000010000000000ULL
504 #define BASE_2TB 0x0000020000000000ULL
505 #define BASE_4TB 0x0000040000000000ULL
506 #define BASE_8TB 0x0000080000000000ULL
507 #define BASE_16TB 0x0000100000000000ULL
508 #define BASE_32TB 0x0000200000000000ULL
509 #define BASE_64TB 0x0000400000000000ULL
510 #define BASE_128TB 0x0000800000000000ULL
511 #define BASE_256TB 0x0001000000000000ULL
512 #define BASE_512TB 0x0002000000000000ULL
513 #define BASE_1PB 0x0004000000000000ULL
514 #define BASE_2PB 0x0008000000000000ULL
515 #define BASE_4PB 0x0010000000000000ULL
516 #define BASE_8PB 0x0020000000000000ULL
517 #define BASE_16PB 0x0040000000000000ULL
518 #define BASE_32PB 0x0080000000000000ULL
519 #define BASE_64PB 0x0100000000000000ULL
520 #define BASE_128PB 0x0200000000000000ULL
521 #define BASE_256PB 0x0400000000000000ULL
522 #define BASE_512PB 0x0800000000000000ULL
523 #define BASE_1EB 0x1000000000000000ULL
524 #define BASE_2EB 0x2000000000000000ULL
525 #define BASE_4EB 0x4000000000000000ULL
526 #define BASE_8EB 0x8000000000000000ULL
527
528 //
529 // Support for variable length argument lists using the ANSI standard.
530 //
531 // Since we are using the ANSI standard we used the standard naming and
532 // did not follow the coding convention
533 //
534 // VA_LIST - typedef for argument list.
535 // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
536 // VA_END (VA_LIST Marker) - Clear Marker
537 // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from
538 // the ... list. You must know the size and pass it in this macro.
539 // VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.
540 //
541 // example:
542 //
543 // UINTN
544 // ExampleVarArg (
545 // IN UINTN NumberOfArgs,
546 // ...
547 // )
548 // {
549 // VA_LIST Marker;
550 // UINTN Index;
551 // UINTN Result;
552 //
553 // //
554 // // Initialize the Marker
555 // //
556 // VA_START (Marker, NumberOfArgs);
557 // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
558 // //
559 // // The ... list is a series of UINTN values, so average them up.
560 // //
561 // Result += VA_ARG (Marker, UINTN);
562 // }
563 //
564 // VA_END (Marker);
565 // return Result
566 // }
567 //
568
569 /**
570 Return the size of argument that has been aligned to sizeof (UINTN).
571
572 @param n The parameter size to be aligned.
573
574 @return The aligned size.
575 **/
576 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
577
578 #if defined(__CC_ARM)
579 //
580 // RVCT ARM variable argument list support.
581 //
582
583 ///
584 /// Variable used to traverse the list of arguments. This type can vary by
585 /// implementation and could be an array or structure.
586 ///
587 #ifdef __APCS_ADSABI
588 typedef int *va_list[1];
589 #define VA_LIST va_list
590 #else
591 typedef struct __va_list { void *__ap; } va_list;
592 #define VA_LIST va_list
593 #endif
594
595 #define VA_START(Marker, Parameter) __va_start(Marker, Parameter)
596
597 #define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE)
598
599 #define VA_END(Marker) ((void)0)
600
601 // For some ARM RVCT compilers, __va_copy is not defined
602 #ifndef __va_copy
603 #define __va_copy(dest, src) ((void)((dest) = (src)))
604 #endif
605
606 #define VA_COPY(Dest, Start) __va_copy (Dest, Start)
607
608 #elif defined(__GNUC__)
609
610 #if defined(MDE_CPU_X64) && !defined(NO_MSABI_VA_FUNCS)
611 //
612 // X64 only. Use MS ABI version of GCC built-in macros for variable argument lists.
613 //
614 ///
615 /// Both GCC and LLVM 3.8 for X64 support new variable argument intrinsics for Microsoft ABI
616 ///
617
618 ///
619 /// Variable used to traverse the list of arguments. This type can vary by
620 /// implementation and could be an array or structure.
621 ///
622 typedef __builtin_ms_va_list VA_LIST;
623
624 #define VA_START(Marker, Parameter) __builtin_ms_va_start (Marker, Parameter)
625
626 #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
627
628 #define VA_END(Marker) __builtin_ms_va_end (Marker)
629
630 #define VA_COPY(Dest, Start) __builtin_ms_va_copy (Dest, Start)
631
632 #else
633 //
634 // Use GCC built-in macros for variable argument lists.
635 //
636
637 ///
638 /// Variable used to traverse the list of arguments. This type can vary by
639 /// implementation and could be an array or structure.
640 ///
641 typedef __builtin_va_list VA_LIST;
642
643 #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)
644
645 #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
646
647 #define VA_END(Marker) __builtin_va_end (Marker)
648
649 #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)
650
651 #endif
652
653 #else
654 ///
655 /// Variable used to traverse the list of arguments. This type can vary by
656 /// implementation and could be an array or structure.
657 ///
658 typedef CHAR8 *VA_LIST;
659
660 /**
661 Retrieves a pointer to the beginning of a variable argument list, based on
662 the name of the parameter that immediately precedes the variable argument list.
663
664 This function initializes Marker to point to the beginning of the variable
665 argument list that immediately follows Parameter. The method for computing the
666 pointer to the next argument in the argument list is CPU-specific following the
667 EFIAPI ABI.
668
669 @param Marker The VA_LIST used to traverse the list of arguments.
670 @param Parameter The name of the parameter that immediately precedes
671 the variable argument list.
672
673 @return A pointer to the beginning of a variable argument list.
674
675 **/
676 #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))
677
678 /**
679 Returns an argument of a specified type from a variable argument list and updates
680 the pointer to the variable argument list to point to the next argument.
681
682 This function returns an argument of the type specified by TYPE from the beginning
683 of the variable argument list specified by Marker. Marker is then updated to point
684 to the next argument in the variable argument list. The method for computing the
685 pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.
686
687 @param Marker VA_LIST used to traverse the list of arguments.
688 @param TYPE The type of argument to retrieve from the beginning
689 of the variable argument list.
690
691 @return An argument of the type specified by TYPE.
692
693 **/
694 #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))
695
696 /**
697 Terminates the use of a variable argument list.
698
699 This function initializes Marker so it can no longer be used with VA_ARG().
700 After this macro is used, the only way to access the variable argument list is
701 by using VA_START() again.
702
703 @param Marker VA_LIST used to traverse the list of arguments.
704
705 **/
706 #define VA_END(Marker) (Marker = (VA_LIST) 0)
707
708 /**
709 Initializes a VA_LIST as a copy of an existing VA_LIST.
710
711 This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest
712 followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach
713 the present state of Start.
714
715 @param Dest VA_LIST used to traverse the list of arguments.
716 @param Start VA_LIST used to traverse the list of arguments.
717
718 **/
719 #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
720
721 #endif
722
723 ///
724 /// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.
725 ///
726 typedef UINTN *BASE_LIST;
727
728 /**
729 Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.
730
731 @param TYPE The date type to determine the size of.
732
733 @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.
734 **/
735 #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))
736
737 /**
738 Returns an argument of a specified type from a variable argument list and updates
739 the pointer to the variable argument list to point to the next argument.
740
741 This function returns an argument of the type specified by TYPE from the beginning
742 of the variable argument list specified by Marker. Marker is then updated to point
743 to the next argument in the variable argument list. The method for computing the
744 pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.
745
746 @param Marker The pointer to the beginning of a variable argument list.
747 @param TYPE The type of argument to retrieve from the beginning
748 of the variable argument list.
749
750 @return An argument of the type specified by TYPE.
751
752 **/
753 #define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))
754
755 /**
756 The macro that returns the byte offset of a field in a data structure.
757
758 This function returns the offset, in bytes, of field specified by Field from the
759 beginning of the data structure specified by TYPE. If TYPE does not contain Field,
760 the module will not compile.
761
762 @param TYPE The name of the data structure that contains the field specified by Field.
763 @param Field The name of the field in the data structure.
764
765 @return Offset, in bytes, of field.
766
767 **/
768 #ifdef __GNUC__
769 #if __GNUC__ >= 4
770 #define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))
771 #endif
772 #endif
773
774 #ifndef OFFSET_OF
775 #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
776 #endif
777
778 /**
779 Macro that returns a pointer to the data structure that contains a specified field of
780 that data structure. This is a lightweight method to hide information by placing a
781 public data structure inside a larger private data structure and using a pointer to
782 the public data structure to retrieve a pointer to the private data structure.
783
784 This function computes the offset, in bytes, of field specified by Field from the beginning
785 of the data structure specified by TYPE. This offset is subtracted from Record, and is
786 used to return a pointer to a data structure of the type specified by TYPE. If the data type
787 specified by TYPE does not contain the field specified by Field, then the module will not compile.
788
789 @param Record Pointer to the field specified by Field within a data structure of type TYPE.
790 @param TYPE The name of the data structure type to return. This data structure must
791 contain the field specified by Field.
792 @param Field The name of the field in the data structure specified by TYPE to which Record points.
793
794 @return A pointer to the structure from one of it's elements.
795
796 **/
797 #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
798
799 /**
800 Rounds a value up to the next boundary using a specified alignment.
801
802 This function rounds Value up to the next boundary using the specified Alignment.
803 This aligned value is returned.
804
805 @param Value The value to round up.
806 @param Alignment The alignment boundary used to return the aligned value.
807
808 @return A value up to the next boundary.
809
810 **/
811 #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))
812
813 /**
814 Adjust a pointer by adding the minimum offset required for it to be aligned on
815 a specified alignment boundary.
816
817 This function rounds the pointer specified by Pointer to the next alignment boundary
818 specified by Alignment. The pointer to the aligned address is returned.
819
820 @param Pointer The pointer to round up.
821 @param Alignment The alignment boundary to use to return an aligned pointer.
822
823 @return Pointer to the aligned address.
824
825 **/
826 #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))
827
828 /**
829 Rounds a value up to the next natural boundary for the current CPU.
830 This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.
831
832 This function rounds the value specified by Value up to the next natural boundary for the
833 current CPU. This rounded value is returned.
834
835 @param Value The value to round up.
836
837 @return Rounded value specified by Value.
838
839 **/
840 #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))
841
842
843 /**
844 Return the maximum of two operands.
845
846 This macro returns the maximum of two operand specified by a and b.
847 Both a and b must be the same numerical types, signed or unsigned.
848
849 @param a The first operand with any numerical type.
850 @param b The second operand. Can be any numerical type as long as is
851 the same type as a.
852
853 @return Maximum of two operands.
854
855 **/
856 #define MAX(a, b) \
857 (((a) > (b)) ? (a) : (b))
858
859 /**
860 Return the minimum of two operands.
861
862 This macro returns the minimal of two operand specified by a and b.
863 Both a and b must be the same numerical types, signed or unsigned.
864
865 @param a The first operand with any numerical type.
866 @param b The second operand. It should be the same any numerical type with a.
867
868 @return Minimum of two operands.
869
870 **/
871 #define MIN(a, b) \
872 (((a) < (b)) ? (a) : (b))
873
874 /**
875 Return the absolute value of a signed operand.
876
877 This macro returns the absolute value of the signed operand specified by a.
878
879 @param a The signed operand.
880
881 @return The absolute value of the signed operand.
882
883 **/
884 #define ABS(a) \
885 (((a) < 0) ? (-(a)) : (a))
886
887 //
888 // Status codes common to all execution phases
889 //
890 typedef UINTN RETURN_STATUS;
891
892 /**
893 Produces a RETURN_STATUS code with the highest bit set.
894
895 @param StatusCode The status code value to convert into a warning code.
896 StatusCode must be in the range 0x00000000..0x7FFFFFFF.
897
898 @return The value specified by StatusCode with the highest bit set.
899
900 **/
901 #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))
902
903 /**
904 Produces a RETURN_STATUS code with the highest bit clear.
905
906 @param StatusCode The status code value to convert into a warning code.
907 StatusCode must be in the range 0x00000000..0x7FFFFFFF.
908
909 @return The value specified by StatusCode with the highest bit clear.
910
911 **/
912 #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))
913
914 /**
915 Returns TRUE if a specified RETURN_STATUS code is an error code.
916
917 This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.
918
919 @param StatusCode The status code value to evaluate.
920
921 @retval TRUE The high bit of StatusCode is set.
922 @retval FALSE The high bit of StatusCode is clear.
923
924 **/
925 #define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)
926
927 ///
928 /// The operation completed successfully.
929 ///
930 #define RETURN_SUCCESS 0
931
932 ///
933 /// The image failed to load.
934 ///
935 #define RETURN_LOAD_ERROR ENCODE_ERROR (1)
936
937 ///
938 /// The parameter was incorrect.
939 ///
940 #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)
941
942 ///
943 /// The operation is not supported.
944 ///
945 #define RETURN_UNSUPPORTED ENCODE_ERROR (3)
946
947 ///
948 /// The buffer was not the proper size for the request.
949 ///
950 #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)
951
952 ///
953 /// The buffer was not large enough to hold the requested data.
954 /// The required buffer size is returned in the appropriate
955 /// parameter when this error occurs.
956 ///
957 #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)
958
959 ///
960 /// There is no data pending upon return.
961 ///
962 #define RETURN_NOT_READY ENCODE_ERROR (6)
963
964 ///
965 /// The physical device reported an error while attempting the
966 /// operation.
967 ///
968 #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)
969
970 ///
971 /// The device can not be written to.
972 ///
973 #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)
974
975 ///
976 /// The resource has run out.
977 ///
978 #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)
979
980 ///
981 /// An inconsistency was detected on the file system causing the
982 /// operation to fail.
983 ///
984 #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)
985
986 ///
987 /// There is no more space on the file system.
988 ///
989 #define RETURN_VOLUME_FULL ENCODE_ERROR (11)
990
991 ///
992 /// The device does not contain any medium to perform the
993 /// operation.
994 ///
995 #define RETURN_NO_MEDIA ENCODE_ERROR (12)
996
997 ///
998 /// The medium in the device has changed since the last
999 /// access.
1000 ///
1001 #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)
1002
1003 ///
1004 /// The item was not found.
1005 ///
1006 #define RETURN_NOT_FOUND ENCODE_ERROR (14)
1007
1008 ///
1009 /// Access was denied.
1010 ///
1011 #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)
1012
1013 ///
1014 /// The server was not found or did not respond to the request.
1015 ///
1016 #define RETURN_NO_RESPONSE ENCODE_ERROR (16)
1017
1018 ///
1019 /// A mapping to the device does not exist.
1020 ///
1021 #define RETURN_NO_MAPPING ENCODE_ERROR (17)
1022
1023 ///
1024 /// A timeout time expired.
1025 ///
1026 #define RETURN_TIMEOUT ENCODE_ERROR (18)
1027
1028 ///
1029 /// The protocol has not been started.
1030 ///
1031 #define RETURN_NOT_STARTED ENCODE_ERROR (19)
1032
1033 ///
1034 /// The protocol has already been started.
1035 ///
1036 #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)
1037
1038 ///
1039 /// The operation was aborted.
1040 ///
1041 #define RETURN_ABORTED ENCODE_ERROR (21)
1042
1043 ///
1044 /// An ICMP error occurred during the network operation.
1045 ///
1046 #define RETURN_ICMP_ERROR ENCODE_ERROR (22)
1047
1048 ///
1049 /// A TFTP error occurred during the network operation.
1050 ///
1051 #define RETURN_TFTP_ERROR ENCODE_ERROR (23)
1052
1053 ///
1054 /// A protocol error occurred during the network operation.
1055 ///
1056 #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)
1057
1058 ///
1059 /// A function encountered an internal version that was
1060 /// incompatible with a version requested by the caller.
1061 ///
1062 #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
1063
1064 ///
1065 /// The function was not performed due to a security violation.
1066 ///
1067 #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)
1068
1069 ///
1070 /// A CRC error was detected.
1071 ///
1072 #define RETURN_CRC_ERROR ENCODE_ERROR (27)
1073
1074 ///
1075 /// The beginning or end of media was reached.
1076 ///
1077 #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
1078
1079 ///
1080 /// The end of the file was reached.
1081 ///
1082 #define RETURN_END_OF_FILE ENCODE_ERROR (31)
1083
1084 ///
1085 /// The language specified was invalid.
1086 ///
1087 #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)
1088
1089 ///
1090 /// The security status of the data is unknown or compromised
1091 /// and the data must be updated or replaced to restore a valid
1092 /// security status.
1093 ///
1094 #define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)
1095
1096 ///
1097 /// A HTTP error occurred during the network operation.
1098 ///
1099 #define RETURN_HTTP_ERROR ENCODE_ERROR (35)
1100
1101 ///
1102 /// The string contained one or more characters that
1103 /// the device could not render and were skipped.
1104 ///
1105 #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
1106
1107 ///
1108 /// The handle was closed, but the file was not deleted.
1109 ///
1110 #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
1111
1112 ///
1113 /// The handle was closed, but the data to the file was not
1114 /// flushed properly.
1115 ///
1116 #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
1117
1118 ///
1119 /// The resulting buffer was too small, and the data was
1120 /// truncated to the buffer size.
1121 ///
1122 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
1123
1124 ///
1125 /// The data has not been updated within the timeframe set by
1126 /// local policy for this type of data.
1127 ///
1128 #define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)
1129
1130 ///
1131 /// The resulting buffer contains UEFI-compliant file system.
1132 ///
1133 #define RETURN_WARN_FILE_SYSTEM ENCODE_WARNING (6)
1134
1135
1136 /**
1137 Returns a 16-bit signature built from 2 ASCII characters.
1138
1139 This macro returns a 16-bit value built from the two ASCII characters specified
1140 by A and B.
1141
1142 @param A The first ASCII character.
1143 @param B The second ASCII character.
1144
1145 @return A 16-bit value built from the two ASCII characters specified by A and B.
1146
1147 **/
1148 #define SIGNATURE_16(A, B) ((A) | (B << 8))
1149
1150 /**
1151 Returns a 32-bit signature built from 4 ASCII characters.
1152
1153 This macro returns a 32-bit value built from the four ASCII characters specified
1154 by A, B, C, and D.
1155
1156 @param A The first ASCII character.
1157 @param B The second ASCII character.
1158 @param C The third ASCII character.
1159 @param D The fourth ASCII character.
1160
1161 @return A 32-bit value built from the two ASCII characters specified by A, B,
1162 C and D.
1163
1164 **/
1165 #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))
1166
1167 /**
1168 Returns a 64-bit signature built from 8 ASCII characters.
1169
1170 This macro returns a 64-bit value built from the eight ASCII characters specified
1171 by A, B, C, D, E, F, G,and H.
1172
1173 @param A The first ASCII character.
1174 @param B The second ASCII character.
1175 @param C The third ASCII character.
1176 @param D The fourth ASCII character.
1177 @param E The fifth ASCII character.
1178 @param F The sixth ASCII character.
1179 @param G The seventh ASCII character.
1180 @param H The eighth ASCII character.
1181
1182 @return A 64-bit value built from the two ASCII characters specified by A, B,
1183 C, D, E, F, G and H.
1184
1185 **/
1186 #define SIGNATURE_64(A, B, C, D, E, F, G, H) \
1187 (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))
1188
1189 #if defined(_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)
1190 #pragma intrinsic(_ReturnAddress)
1191 /**
1192 Get the return address of the calling function.
1193
1194 Based on intrinsic function _ReturnAddress that provides the address of
1195 the instruction in the calling function that will be executed after
1196 control returns to the caller.
1197
1198 @param L Return Level.
1199
1200 @return The return address of the calling function or 0 if L != 0.
1201
1202 **/
1203 #define RETURN_ADDRESS(L) ((L == 0) ? _ReturnAddress() : (VOID *) 0)
1204 #elif defined(__GNUC__)
1205 void * __builtin_return_address (unsigned int level);
1206 /**
1207 Get the return address of the calling function.
1208
1209 Based on built-in Function __builtin_return_address that returns
1210 the return address of the current function, or of one of its callers.
1211
1212 @param L Return Level.
1213
1214 @return The return address of the calling function.
1215
1216 **/
1217 #define RETURN_ADDRESS(L) __builtin_return_address (L)
1218 #else
1219 /**
1220 Get the return address of the calling function.
1221
1222 @param L Return Level.
1223
1224 @return 0 as compilers don't support this feature.
1225
1226 **/
1227 #define RETURN_ADDRESS(L) ((VOID *) 0)
1228 #endif
1229
1230 /**
1231 Return the number of elements in an array.
1232
1233 @param Array An object of array type. Array is only used as an argument to
1234 the sizeof operator, therefore Array is never evaluated. The
1235 caller is responsible for ensuring that Array's type is not
1236 incomplete; that is, Array must have known constant size.
1237
1238 @return The number of elements in Array. The result has type UINTN.
1239
1240 **/
1241 #define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))
1242
1243 #endif
1244