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