12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289 |
- /** @file
- Root include file for Mde Package Base type modules
- This is the include file for any module of type base. Base modules only use
- types defined via this include file and can be ported easily to any
- environment. There are a set of base libraries in the Mde Package that can
- be used to implement base modules.
- Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>
- Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #ifndef __BASE_H__
- #define __BASE_H__
- //
- // Include processor specific binding
- //
- #include <ProcessorBind.h>
- #if defined (_MSC_EXTENSIONS)
- //
- // Disable warning when last field of data structure is a zero sized array.
- //
- #pragma warning ( disable : 4200 )
- #endif
- //
- // The Microsoft* C compiler can removed references to unreferenced data items
- // if the /OPT:REF linker option is used. We defined a macro as this is a
- // a non standard extension
- //
- #if defined (_MSC_VER) && _MSC_VER < 1800 && !defined (MDE_CPU_EBC)
- ///
- /// Remove global variable from the linked image if there are no references to
- /// it after all compiler and linker optimizations have been performed.
- ///
- ///
- #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
- #else
- ///
- /// Remove the global variable from the linked image if there are no references
- /// to it after all compiler and linker optimizations have been performed.
- ///
- ///
- #define GLOBAL_REMOVE_IF_UNREFERENCED
- #endif
- //
- // Should be used in combination with NORETURN to avoid 'noreturn' returns
- // warnings.
- //
- #ifndef UNREACHABLE
- #ifdef __GNUC__
- ///
- /// Signal compilers and analyzers that this call is not reachable. It is
- /// up to the compiler to remove any code past that point.
- ///
- #define UNREACHABLE() __builtin_unreachable ()
- #elif defined (__has_feature)
- #if __has_builtin (__builtin_unreachable)
- ///
- /// Signal compilers and analyzers that this call is not reachable. It is
- /// up to the compiler to remove any code past that point.
- ///
- #define UNREACHABLE() __builtin_unreachable ()
- #endif
- #endif
- #ifndef UNREACHABLE
- ///
- /// Signal compilers and analyzers that this call is not reachable. It is
- /// up to the compiler to remove any code past that point.
- ///
- #define UNREACHABLE()
- #endif
- #endif
- //
- // Signaling compilers and analyzers that a certain function cannot return may
- // remove all following code and thus lead to better optimization and less
- // false positives.
- //
- #ifndef NORETURN
- #if defined (__GNUC__) || defined (__clang__)
- ///
- /// Signal compilers and analyzers that the function cannot return.
- /// It is up to the compiler to remove any code past a call to functions
- /// flagged with this attribute.
- ///
- #define NORETURN __attribute__((noreturn))
- #elif defined (_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)
- ///
- /// Signal compilers and analyzers that the function cannot return.
- /// It is up to the compiler to remove any code past a call to functions
- /// flagged with this attribute.
- ///
- #define NORETURN __declspec(noreturn)
- #else
- ///
- /// Signal compilers and analyzers that the function cannot return.
- /// It is up to the compiler to remove any code past a call to functions
- /// flagged with this attribute.
- ///
- #define NORETURN
- #endif
- #endif
- //
- // Should be used in combination with ANALYZER_NORETURN to avoid 'noreturn'
- // returns warnings.
- //
- #ifndef ANALYZER_UNREACHABLE
- #ifdef __clang_analyzer__
- #if __has_builtin (__builtin_unreachable)
- ///
- /// Signal the analyzer that this call is not reachable.
- /// This excludes compilers.
- ///
- #define ANALYZER_UNREACHABLE() __builtin_unreachable ()
- #endif
- #endif
- #ifndef ANALYZER_UNREACHABLE
- ///
- /// Signal the analyzer that this call is not reachable.
- /// This excludes compilers.
- ///
- #define ANALYZER_UNREACHABLE()
- #endif
- #endif
- //
- // Static Analyzers may issue errors about potential NULL-dereferences when
- // dereferencing a pointer, that has been checked before, outside of a
- // NULL-check. This may lead to false positives, such as when using ASSERT()
- // for verification.
- //
- #ifndef ANALYZER_NORETURN
- #ifdef __has_feature
- #if __has_feature (attribute_analyzer_noreturn)
- ///
- /// Signal analyzers that the function cannot return.
- /// This excludes compilers.
- ///
- #define ANALYZER_NORETURN __attribute__((analyzer_noreturn))
- #endif
- #endif
- #ifndef ANALYZER_NORETURN
- ///
- /// Signal the analyzer that the function cannot return.
- /// This excludes compilers.
- ///
- #define ANALYZER_NORETURN
- #endif
- #endif
- ///
- /// Tell the code optimizer that the function will return twice.
- /// This prevents wrong optimizations which can cause bugs.
- ///
- #ifndef RETURNS_TWICE
- #if defined (__GNUC__) || defined (__clang__)
- ///
- /// Tell the code optimizer that the function will return twice.
- /// This prevents wrong optimizations which can cause bugs.
- ///
- #define RETURNS_TWICE __attribute__((returns_twice))
- #else
- ///
- /// Tell the code optimizer that the function will return twice.
- /// This prevents wrong optimizations which can cause bugs.
- ///
- #define RETURNS_TWICE
- #endif
- #endif
- //
- // For symbol name in assembly code, an extra "_" is sometimes necessary
- //
- ///
- /// Private worker functions for ASM_PFX()
- ///
- #define _CONCATENATE(a, b) __CONCATENATE(a, b)
- #define __CONCATENATE(a, b) a ## b
- ///
- /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix
- /// on symbols in assembly language.
- ///
- #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)
- #ifdef __APPLE__
- //
- // Apple extension that is used by the linker to optimize code size
- // with assembly functions. Put at the end of your .S files
- //
- #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols
- #else
- #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED
- #endif
- #define PACKED
- ///
- /// 128 bit buffer containing a unique identifier value.
- /// Unless otherwise specified, aligned on a 64 bit boundary.
- ///
- typedef struct {
- UINT32 Data1;
- UINT16 Data2;
- UINT16 Data3;
- UINT8 Data4[8];
- } GUID;
- ///
- /// 4-byte buffer. An IPv4 internet protocol address.
- ///
- typedef struct {
- UINT8 Addr[4];
- } IPv4_ADDRESS;
- ///
- /// 16-byte buffer. An IPv6 internet protocol address.
- ///
- typedef struct {
- UINT8 Addr[16];
- } IPv6_ADDRESS;
- //
- // 8-bytes unsigned value that represents a physical system address.
- //
- typedef UINT64 PHYSICAL_ADDRESS;
- ///
- /// LIST_ENTRY structure definition.
- ///
- typedef struct _LIST_ENTRY LIST_ENTRY;
- ///
- /// _LIST_ENTRY structure definition.
- ///
- struct _LIST_ENTRY {
- LIST_ENTRY *ForwardLink;
- LIST_ENTRY *BackLink;
- };
- //
- // Modifiers to abstract standard types to aid in debug of problems
- //
- ///
- /// Datum is read-only.
- ///
- #define CONST const
- ///
- /// Datum is scoped to the current file or function.
- ///
- #define STATIC static
- ///
- /// Undeclared type.
- ///
- #define VOID void
- //
- // Modifiers for Data Types used to self document code.
- // This concept is borrowed for UEFI specification.
- //
- ///
- /// Datum is passed to the function.
- ///
- #define IN
- ///
- /// Datum is returned from the function.
- ///
- #define OUT
- ///
- /// Passing the datum to the function is optional, and a NULL
- /// is passed if the value is not supplied.
- ///
- #define OPTIONAL
- //
- // UEFI specification claims 1 and 0. We are concerned about the
- // compiler portability so we did it this way.
- //
- ///
- /// Boolean true value. UEFI Specification defines this value to be 1,
- /// but this form is more portable.
- ///
- #define TRUE ((BOOLEAN)(1==1))
- ///
- /// Boolean false value. UEFI Specification defines this value to be 0,
- /// but this form is more portable.
- ///
- #define FALSE ((BOOLEAN)(0==1))
- ///
- /// NULL pointer (VOID *)
- ///
- #if defined (__cplusplus)
- #if defined (_MSC_EXTENSIONS)
- #define NULL nullptr
- #else
- #define NULL __null
- #endif
- #else
- #define NULL ((VOID *) 0)
- #endif
- //
- // Null character
- //
- #define CHAR_NULL 0x0000
- ///
- /// Maximum values for common UEFI Data Types
- ///
- #define MAX_INT8 ((INT8)0x7F)
- #define MAX_UINT8 ((UINT8)0xFF)
- #define MAX_INT16 ((INT16)0x7FFF)
- #define MAX_UINT16 ((UINT16)0xFFFF)
- #define MAX_INT32 ((INT32)0x7FFFFFFF)
- #define MAX_UINT32 ((UINT32)0xFFFFFFFF)
- #define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)
- #define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)
- ///
- /// Minimum values for the signed UEFI Data Types
- ///
- #define MIN_INT8 (((INT8) -127) - 1)
- #define MIN_INT16 (((INT16) -32767) - 1)
- #define MIN_INT32 (((INT32) -2147483647) - 1)
- #define MIN_INT64 (((INT64) -9223372036854775807LL) - 1)
- #define BIT0 0x00000001
- #define BIT1 0x00000002
- #define BIT2 0x00000004
- #define BIT3 0x00000008
- #define BIT4 0x00000010
- #define BIT5 0x00000020
- #define BIT6 0x00000040
- #define BIT7 0x00000080
- #define BIT8 0x00000100
- #define BIT9 0x00000200
- #define BIT10 0x00000400
- #define BIT11 0x00000800
- #define BIT12 0x00001000
- #define BIT13 0x00002000
- #define BIT14 0x00004000
- #define BIT15 0x00008000
- #define BIT16 0x00010000
- #define BIT17 0x00020000
- #define BIT18 0x00040000
- #define BIT19 0x00080000
- #define BIT20 0x00100000
- #define BIT21 0x00200000
- #define BIT22 0x00400000
- #define BIT23 0x00800000
- #define BIT24 0x01000000
- #define BIT25 0x02000000
- #define BIT26 0x04000000
- #define BIT27 0x08000000
- #define BIT28 0x10000000
- #define BIT29 0x20000000
- #define BIT30 0x40000000
- #define BIT31 0x80000000
- #define BIT32 0x0000000100000000ULL
- #define BIT33 0x0000000200000000ULL
- #define BIT34 0x0000000400000000ULL
- #define BIT35 0x0000000800000000ULL
- #define BIT36 0x0000001000000000ULL
- #define BIT37 0x0000002000000000ULL
- #define BIT38 0x0000004000000000ULL
- #define BIT39 0x0000008000000000ULL
- #define BIT40 0x0000010000000000ULL
- #define BIT41 0x0000020000000000ULL
- #define BIT42 0x0000040000000000ULL
- #define BIT43 0x0000080000000000ULL
- #define BIT44 0x0000100000000000ULL
- #define BIT45 0x0000200000000000ULL
- #define BIT46 0x0000400000000000ULL
- #define BIT47 0x0000800000000000ULL
- #define BIT48 0x0001000000000000ULL
- #define BIT49 0x0002000000000000ULL
- #define BIT50 0x0004000000000000ULL
- #define BIT51 0x0008000000000000ULL
- #define BIT52 0x0010000000000000ULL
- #define BIT53 0x0020000000000000ULL
- #define BIT54 0x0040000000000000ULL
- #define BIT55 0x0080000000000000ULL
- #define BIT56 0x0100000000000000ULL
- #define BIT57 0x0200000000000000ULL
- #define BIT58 0x0400000000000000ULL
- #define BIT59 0x0800000000000000ULL
- #define BIT60 0x1000000000000000ULL
- #define BIT61 0x2000000000000000ULL
- #define BIT62 0x4000000000000000ULL
- #define BIT63 0x8000000000000000ULL
- #define SIZE_1KB 0x00000400
- #define SIZE_2KB 0x00000800
- #define SIZE_4KB 0x00001000
- #define SIZE_8KB 0x00002000
- #define SIZE_16KB 0x00004000
- #define SIZE_32KB 0x00008000
- #define SIZE_64KB 0x00010000
- #define SIZE_128KB 0x00020000
- #define SIZE_256KB 0x00040000
- #define SIZE_512KB 0x00080000
- #define SIZE_1MB 0x00100000
- #define SIZE_2MB 0x00200000
- #define SIZE_4MB 0x00400000
- #define SIZE_8MB 0x00800000
- #define SIZE_16MB 0x01000000
- #define SIZE_32MB 0x02000000
- #define SIZE_64MB 0x04000000
- #define SIZE_128MB 0x08000000
- #define SIZE_256MB 0x10000000
- #define SIZE_512MB 0x20000000
- #define SIZE_1GB 0x40000000
- #define SIZE_2GB 0x80000000
- #define SIZE_4GB 0x0000000100000000ULL
- #define SIZE_8GB 0x0000000200000000ULL
- #define SIZE_16GB 0x0000000400000000ULL
- #define SIZE_32GB 0x0000000800000000ULL
- #define SIZE_64GB 0x0000001000000000ULL
- #define SIZE_128GB 0x0000002000000000ULL
- #define SIZE_256GB 0x0000004000000000ULL
- #define SIZE_512GB 0x0000008000000000ULL
- #define SIZE_1TB 0x0000010000000000ULL
- #define SIZE_2TB 0x0000020000000000ULL
- #define SIZE_4TB 0x0000040000000000ULL
- #define SIZE_8TB 0x0000080000000000ULL
- #define SIZE_16TB 0x0000100000000000ULL
- #define SIZE_32TB 0x0000200000000000ULL
- #define SIZE_64TB 0x0000400000000000ULL
- #define SIZE_128TB 0x0000800000000000ULL
- #define SIZE_256TB 0x0001000000000000ULL
- #define SIZE_512TB 0x0002000000000000ULL
- #define SIZE_1PB 0x0004000000000000ULL
- #define SIZE_2PB 0x0008000000000000ULL
- #define SIZE_4PB 0x0010000000000000ULL
- #define SIZE_8PB 0x0020000000000000ULL
- #define SIZE_16PB 0x0040000000000000ULL
- #define SIZE_32PB 0x0080000000000000ULL
- #define SIZE_64PB 0x0100000000000000ULL
- #define SIZE_128PB 0x0200000000000000ULL
- #define SIZE_256PB 0x0400000000000000ULL
- #define SIZE_512PB 0x0800000000000000ULL
- #define SIZE_1EB 0x1000000000000000ULL
- #define SIZE_2EB 0x2000000000000000ULL
- #define SIZE_4EB 0x4000000000000000ULL
- #define SIZE_8EB 0x8000000000000000ULL
- #define BASE_1KB 0x00000400
- #define BASE_2KB 0x00000800
- #define BASE_4KB 0x00001000
- #define BASE_8KB 0x00002000
- #define BASE_16KB 0x00004000
- #define BASE_32KB 0x00008000
- #define BASE_64KB 0x00010000
- #define BASE_128KB 0x00020000
- #define BASE_256KB 0x00040000
- #define BASE_512KB 0x00080000
- #define BASE_1MB 0x00100000
- #define BASE_2MB 0x00200000
- #define BASE_4MB 0x00400000
- #define BASE_8MB 0x00800000
- #define BASE_16MB 0x01000000
- #define BASE_32MB 0x02000000
- #define BASE_64MB 0x04000000
- #define BASE_128MB 0x08000000
- #define BASE_256MB 0x10000000
- #define BASE_512MB 0x20000000
- #define BASE_1GB 0x40000000
- #define BASE_2GB 0x80000000
- #define BASE_4GB 0x0000000100000000ULL
- #define BASE_8GB 0x0000000200000000ULL
- #define BASE_16GB 0x0000000400000000ULL
- #define BASE_32GB 0x0000000800000000ULL
- #define BASE_64GB 0x0000001000000000ULL
- #define BASE_128GB 0x0000002000000000ULL
- #define BASE_256GB 0x0000004000000000ULL
- #define BASE_512GB 0x0000008000000000ULL
- #define BASE_1TB 0x0000010000000000ULL
- #define BASE_2TB 0x0000020000000000ULL
- #define BASE_4TB 0x0000040000000000ULL
- #define BASE_8TB 0x0000080000000000ULL
- #define BASE_16TB 0x0000100000000000ULL
- #define BASE_32TB 0x0000200000000000ULL
- #define BASE_64TB 0x0000400000000000ULL
- #define BASE_128TB 0x0000800000000000ULL
- #define BASE_256TB 0x0001000000000000ULL
- #define BASE_512TB 0x0002000000000000ULL
- #define BASE_1PB 0x0004000000000000ULL
- #define BASE_2PB 0x0008000000000000ULL
- #define BASE_4PB 0x0010000000000000ULL
- #define BASE_8PB 0x0020000000000000ULL
- #define BASE_16PB 0x0040000000000000ULL
- #define BASE_32PB 0x0080000000000000ULL
- #define BASE_64PB 0x0100000000000000ULL
- #define BASE_128PB 0x0200000000000000ULL
- #define BASE_256PB 0x0400000000000000ULL
- #define BASE_512PB 0x0800000000000000ULL
- #define BASE_1EB 0x1000000000000000ULL
- #define BASE_2EB 0x2000000000000000ULL
- #define BASE_4EB 0x4000000000000000ULL
- #define BASE_8EB 0x8000000000000000ULL
- //
- // Support for variable argument lists in freestanding edk2 modules.
- //
- // For modules that use the ISO C library interfaces for variable
- // argument lists, refer to "StdLib/Include/stdarg.h".
- //
- // VA_LIST - typedef for argument list.
- // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
- // VA_END (VA_LIST Marker) - Clear Marker
- // VA_ARG (VA_LIST Marker, var arg type) - Use Marker to get an argument from
- // the ... list. You must know the type and pass it in this macro. Type
- // must be compatible with the type of the actual next argument (as promoted
- // according to the default argument promotions.)
- // VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.
- //
- // Example:
- //
- // UINTN
- // EFIAPI
- // ExampleVarArg (
- // IN UINTN NumberOfArgs,
- // ...
- // )
- // {
- // VA_LIST Marker;
- // UINTN Index;
- // UINTN Result;
- //
- // //
- // // Initialize the Marker
- // //
- // VA_START (Marker, NumberOfArgs);
- // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
- // //
- // // The ... list is a series of UINTN values, so sum them up.
- // //
- // Result += VA_ARG (Marker, UINTN);
- // }
- //
- // VA_END (Marker);
- // return Result;
- // }
- //
- // Notes:
- // - Functions that call VA_START() / VA_END() must have a variable
- // argument list and must be declared EFIAPI.
- // - Functions that call VA_COPY() / VA_END() must be declared EFIAPI.
- // - Functions that only use VA_LIST and VA_ARG() need not be EFIAPI.
- //
- /**
- Return the size of argument that has been aligned to sizeof (UINTN).
- @param n The parameter size to be aligned.
- @return The aligned size.
- **/
- #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
- #if defined (_M_ARM) || defined (_M_ARM64)
- //
- // MSFT ARM variable argument list support.
- //
- typedef char *VA_LIST;
- #define VA_START(Marker, Parameter) __va_start (&Marker, &Parameter, _INT_SIZE_OF (Parameter), __alignof(Parameter), &Parameter)
- #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE) + ((-(INTN)Marker) & (sizeof(TYPE) - 1))) - _INT_SIZE_OF (TYPE)))
- #define VA_END(Marker) (Marker = (VA_LIST) 0)
- #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
- #elif defined (__GNUC__) || defined (__clang__)
- #if defined (MDE_CPU_X64) && !defined (NO_MSABI_VA_FUNCS)
- //
- // X64 only. Use MS ABI version of GCC built-in macros for variable argument lists.
- //
- ///
- /// Both GCC and LLVM 3.8 for X64 support new variable argument intrinsics for Microsoft ABI
- ///
- ///
- /// Variable used to traverse the list of arguments. This type can vary by
- /// implementation and could be an array or structure.
- ///
- typedef __builtin_ms_va_list VA_LIST;
- #define VA_START(Marker, Parameter) __builtin_ms_va_start (Marker, Parameter)
- #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
- #define VA_END(Marker) __builtin_ms_va_end (Marker)
- #define VA_COPY(Dest, Start) __builtin_ms_va_copy (Dest, Start)
- #else
- //
- // Use GCC built-in macros for variable argument lists.
- //
- ///
- /// Variable used to traverse the list of arguments. This type can vary by
- /// implementation and could be an array or structure.
- ///
- typedef __builtin_va_list VA_LIST;
- #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)
- #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
- #define VA_END(Marker) __builtin_va_end (Marker)
- #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)
- #endif
- #else
- ///
- /// Variable used to traverse the list of arguments. This type can vary by
- /// implementation and could be an array or structure.
- ///
- typedef CHAR8 *VA_LIST;
- /**
- Retrieves a pointer to the beginning of a variable argument list, based on
- the name of the parameter that immediately precedes the variable argument list.
- This function initializes Marker to point to the beginning of the variable
- argument list that immediately follows Parameter. The method for computing the
- pointer to the next argument in the argument list is CPU-specific following the
- EFIAPI ABI.
- @param Marker The VA_LIST used to traverse the list of arguments.
- @param Parameter The name of the parameter that immediately precedes
- the variable argument list.
- @return A pointer to the beginning of a variable argument list.
- **/
- #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))
- /**
- Returns an argument of a specified type from a variable argument list and updates
- the pointer to the variable argument list to point to the next argument.
- This function returns an argument of the type specified by TYPE from the beginning
- of the variable argument list specified by Marker. Marker is then updated to point
- to the next argument in the variable argument list. The method for computing the
- pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.
- @param Marker VA_LIST used to traverse the list of arguments.
- @param TYPE The type of argument to retrieve from the beginning
- of the variable argument list.
- @return An argument of the type specified by TYPE.
- **/
- #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))
- /**
- Terminates the use of a variable argument list.
- This function initializes Marker so it can no longer be used with VA_ARG().
- After this macro is used, the only way to access the variable argument list is
- by using VA_START() again.
- @param Marker VA_LIST used to traverse the list of arguments.
- **/
- #define VA_END(Marker) (Marker = (VA_LIST) 0)
- /**
- Initializes a VA_LIST as a copy of an existing VA_LIST.
- This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest
- followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach
- the present state of Start.
- @param Dest VA_LIST used to traverse the list of arguments.
- @param Start VA_LIST used to traverse the list of arguments.
- **/
- #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
- #endif
- ///
- /// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.
- ///
- typedef UINTN *BASE_LIST;
- /**
- Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.
- @param TYPE The date type to determine the size of.
- @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.
- **/
- #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))
- /**
- Returns an argument of a specified type from a variable argument list and updates
- the pointer to the variable argument list to point to the next argument.
- This function returns an argument of the type specified by TYPE from the beginning
- of the variable argument list specified by Marker. Marker is then updated to point
- to the next argument in the variable argument list. The method for computing the
- pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.
- @param Marker The pointer to the beginning of a variable argument list.
- @param TYPE The type of argument to retrieve from the beginning
- of the variable argument list.
- @return An argument of the type specified by TYPE.
- **/
- #define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))
- /**
- The macro that returns the byte offset of a field in a data structure.
- This function returns the offset, in bytes, of field specified by Field from the
- beginning of the data structure specified by TYPE. If TYPE does not contain Field,
- the module will not compile.
- @param TYPE The name of the data structure that contains the field specified by Field.
- @param Field The name of the field in the data structure.
- @return Offset, in bytes, of field.
- **/
- #if (defined (__GNUC__) && __GNUC__ >= 4) || defined (__clang__)
- #define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))
- #endif
- #ifndef OFFSET_OF
- #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
- #endif
- /**
- Portable definition for compile time assertions.
- Equivalent to C11 static_assert macro from assert.h.
- @param Expression Boolean expression.
- @param Message Raised compiler diagnostic message when expression is false.
- **/
- #ifdef MDE_CPU_EBC
- #define STATIC_ASSERT(Expression, Message)
- #elif defined (_MSC_EXTENSIONS) || defined (__cplusplus)
- #define STATIC_ASSERT static_assert
- #else
- #define STATIC_ASSERT _Static_assert
- #endif
- //
- // Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
- // Section 2.3.1 of the UEFI 2.3 Specification.
- //
- STATIC_ASSERT (sizeof (BOOLEAN) == 1, "sizeof (BOOLEAN) does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (INT8) == 1, "sizeof (INT8) does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (UINT8) == 1, "sizeof (UINT8) does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (INT16) == 2, "sizeof (INT16) does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (UINT16) == 2, "sizeof (UINT16) does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (INT32) == 4, "sizeof (INT32) does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (UINT32) == 4, "sizeof (UINT32) does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (INT64) == 8, "sizeof (INT64) does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (UINT64) == 8, "sizeof (UINT64) does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (CHAR8) == 1, "sizeof (CHAR8) does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (CHAR16) == 2, "sizeof (CHAR16) does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (L'A') == 2, "sizeof (L'A') does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (L"A") == 4, "sizeof (L\"A\") does not meet UEFI Specification Data Type requirements");
- //
- // The following three enum types are used to verify that the compiler
- // configuration for enum types is compliant with Section 2.3.1 of the
- // UEFI 2.3 Specification. These enum types and enum values are not
- // intended to be used. A prefix of '__' is used avoid conflicts with
- // other types.
- //
- typedef enum {
- __VerifyUint8EnumValue = 0xff
- } __VERIFY_UINT8_ENUM_SIZE;
- typedef enum {
- __VerifyUint16EnumValue = 0xffff
- } __VERIFY_UINT16_ENUM_SIZE;
- typedef enum {
- __VerifyUint32EnumValue = 0xffffffff
- } __VERIFY_UINT32_ENUM_SIZE;
- STATIC_ASSERT (sizeof (__VERIFY_UINT8_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (__VERIFY_UINT16_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");
- STATIC_ASSERT (sizeof (__VERIFY_UINT32_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");
- /**
- Macro that returns a pointer to the data structure that contains a specified field of
- that data structure. This is a lightweight method to hide information by placing a
- public data structure inside a larger private data structure and using a pointer to
- the public data structure to retrieve a pointer to the private data structure.
- This function computes the offset, in bytes, of field specified by Field from the beginning
- of the data structure specified by TYPE. This offset is subtracted from Record, and is
- used to return a pointer to a data structure of the type specified by TYPE. If the data type
- specified by TYPE does not contain the field specified by Field, then the module will not compile.
- @param Record Pointer to the field specified by Field within a data structure of type TYPE.
- @param TYPE The name of the data structure type to return. This data structure must
- contain the field specified by Field.
- @param Field The name of the field in the data structure specified by TYPE to which Record points.
- @return A pointer to the structure from one of it's elements.
- **/
- #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - OFFSET_OF (TYPE, Field)))
- /**
- Rounds a value up to the next boundary using a specified alignment.
- This function rounds Value up to the next boundary using the specified Alignment.
- This aligned value is returned.
- @param Value The value to round up.
- @param Alignment The alignment boundary used to return the aligned value.
- @return A value up to the next boundary.
- **/
- #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))
- /**
- Adjust a pointer by adding the minimum offset required for it to be aligned on
- a specified alignment boundary.
- This function rounds the pointer specified by Pointer to the next alignment boundary
- specified by Alignment. The pointer to the aligned address is returned.
- @param Pointer The pointer to round up.
- @param Alignment The alignment boundary to use to return an aligned pointer.
- @return Pointer to the aligned address.
- **/
- #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))
- /**
- Rounds a value up to the next natural boundary for the current CPU.
- This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.
- This function rounds the value specified by Value up to the next natural boundary for the
- current CPU. This rounded value is returned.
- @param Value The value to round up.
- @return Rounded value specified by Value.
- **/
- #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))
- /**
- Return the maximum of two operands.
- This macro returns the maximum of two operand specified by a and b.
- Both a and b must be the same numerical types, signed or unsigned.
- @param a The first operand with any numerical type.
- @param b The second operand. Can be any numerical type as long as is
- the same type as a.
- @return Maximum of two operands.
- **/
- #define MAX(a, b) \
- (((a) > (b)) ? (a) : (b))
- /**
- Return the minimum of two operands.
- This macro returns the minimal of two operand specified by a and b.
- Both a and b must be the same numerical types, signed or unsigned.
- @param a The first operand with any numerical type.
- @param b The second operand. It should be the same any numerical type with a.
- @return Minimum of two operands.
- **/
- #define MIN(a, b) \
- (((a) < (b)) ? (a) : (b))
- /**
- Return the absolute value of a signed operand.
- This macro returns the absolute value of the signed operand specified by a.
- @param a The signed operand.
- @return The absolute value of the signed operand.
- **/
- #define ABS(a) \
- (((a) < 0) ? (-(a)) : (a))
- //
- // Status codes common to all execution phases
- //
- typedef UINTN RETURN_STATUS;
- /**
- Produces a RETURN_STATUS code with the highest bit set.
- @param StatusCode The status code value to convert into a warning code.
- StatusCode must be in the range 0x00000000..0x7FFFFFFF.
- @return The value specified by StatusCode with the highest bit set.
- **/
- #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))
- /**
- Produces a RETURN_STATUS code with the highest bit clear.
- @param StatusCode The status code value to convert into a warning code.
- StatusCode must be in the range 0x00000000..0x7FFFFFFF.
- @return The value specified by StatusCode with the highest bit clear.
- **/
- #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))
- /**
- Returns TRUE if a specified RETURN_STATUS code is an error code.
- This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.
- @param StatusCode The status code value to evaluate.
- @retval TRUE The high bit of StatusCode is set.
- @retval FALSE The high bit of StatusCode is clear.
- **/
- #define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)
- ///
- /// The operation completed successfully.
- ///
- #define RETURN_SUCCESS (RETURN_STATUS)(0)
- ///
- /// The image failed to load.
- ///
- #define RETURN_LOAD_ERROR ENCODE_ERROR (1)
- ///
- /// The parameter was incorrect.
- ///
- #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)
- ///
- /// The operation is not supported.
- ///
- #define RETURN_UNSUPPORTED ENCODE_ERROR (3)
- ///
- /// The buffer was not the proper size for the request.
- ///
- #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)
- ///
- /// The buffer was not large enough to hold the requested data.
- /// The required buffer size is returned in the appropriate
- /// parameter when this error occurs.
- ///
- #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)
- ///
- /// There is no data pending upon return.
- ///
- #define RETURN_NOT_READY ENCODE_ERROR (6)
- ///
- /// The physical device reported an error while attempting the
- /// operation.
- ///
- #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)
- ///
- /// The device can not be written to.
- ///
- #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)
- ///
- /// The resource has run out.
- ///
- #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)
- ///
- /// An inconsistency was detected on the file system causing the
- /// operation to fail.
- ///
- #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)
- ///
- /// There is no more space on the file system.
- ///
- #define RETURN_VOLUME_FULL ENCODE_ERROR (11)
- ///
- /// The device does not contain any medium to perform the
- /// operation.
- ///
- #define RETURN_NO_MEDIA ENCODE_ERROR (12)
- ///
- /// The medium in the device has changed since the last
- /// access.
- ///
- #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)
- ///
- /// The item was not found.
- ///
- #define RETURN_NOT_FOUND ENCODE_ERROR (14)
- ///
- /// Access was denied.
- ///
- #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)
- ///
- /// The server was not found or did not respond to the request.
- ///
- #define RETURN_NO_RESPONSE ENCODE_ERROR (16)
- ///
- /// A mapping to the device does not exist.
- ///
- #define RETURN_NO_MAPPING ENCODE_ERROR (17)
- ///
- /// A timeout time expired.
- ///
- #define RETURN_TIMEOUT ENCODE_ERROR (18)
- ///
- /// The protocol has not been started.
- ///
- #define RETURN_NOT_STARTED ENCODE_ERROR (19)
- ///
- /// The protocol has already been started.
- ///
- #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)
- ///
- /// The operation was aborted.
- ///
- #define RETURN_ABORTED ENCODE_ERROR (21)
- ///
- /// An ICMP error occurred during the network operation.
- ///
- #define RETURN_ICMP_ERROR ENCODE_ERROR (22)
- ///
- /// A TFTP error occurred during the network operation.
- ///
- #define RETURN_TFTP_ERROR ENCODE_ERROR (23)
- ///
- /// A protocol error occurred during the network operation.
- ///
- #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)
- ///
- /// A function encountered an internal version that was
- /// incompatible with a version requested by the caller.
- ///
- #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
- ///
- /// The function was not performed due to a security violation.
- ///
- #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)
- ///
- /// A CRC error was detected.
- ///
- #define RETURN_CRC_ERROR ENCODE_ERROR (27)
- ///
- /// The beginning or end of media was reached.
- ///
- #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
- ///
- /// The end of the file was reached.
- ///
- #define RETURN_END_OF_FILE ENCODE_ERROR (31)
- ///
- /// The language specified was invalid.
- ///
- #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)
- ///
- /// The security status of the data is unknown or compromised
- /// and the data must be updated or replaced to restore a valid
- /// security status.
- ///
- #define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)
- ///
- /// A HTTP error occurred during the network operation.
- ///
- #define RETURN_HTTP_ERROR ENCODE_ERROR (35)
- ///
- /// The string contained one or more characters that
- /// the device could not render and were skipped.
- ///
- #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
- ///
- /// The handle was closed, but the file was not deleted.
- ///
- #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
- ///
- /// The handle was closed, but the data to the file was not
- /// flushed properly.
- ///
- #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
- ///
- /// The resulting buffer was too small, and the data was
- /// truncated to the buffer size.
- ///
- #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
- ///
- /// The data has not been updated within the timeframe set by
- /// local policy for this type of data.
- ///
- #define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)
- ///
- /// The resulting buffer contains UEFI-compliant file system.
- ///
- #define RETURN_WARN_FILE_SYSTEM ENCODE_WARNING (6)
- /**
- Returns a 16-bit signature built from 2 ASCII characters.
- This macro returns a 16-bit value built from the two ASCII characters specified
- by A and B.
- @param A The first ASCII character.
- @param B The second ASCII character.
- @return A 16-bit value built from the two ASCII characters specified by A and B.
- **/
- #define SIGNATURE_16(A, B) ((A) | (B << 8))
- /**
- Returns a 32-bit signature built from 4 ASCII characters.
- This macro returns a 32-bit value built from the four ASCII characters specified
- by A, B, C, and D.
- @param A The first ASCII character.
- @param B The second ASCII character.
- @param C The third ASCII character.
- @param D The fourth ASCII character.
- @return A 32-bit value built from the two ASCII characters specified by A, B,
- C and D.
- **/
- #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))
- /**
- Returns a 64-bit signature built from 8 ASCII characters.
- This macro returns a 64-bit value built from the eight ASCII characters specified
- by A, B, C, D, E, F, G,and H.
- @param A The first ASCII character.
- @param B The second ASCII character.
- @param C The third ASCII character.
- @param D The fourth ASCII character.
- @param E The fifth ASCII character.
- @param F The sixth ASCII character.
- @param G The seventh ASCII character.
- @param H The eighth ASCII character.
- @return A 64-bit value built from the two ASCII characters specified by A, B,
- C, D, E, F, G and H.
- **/
- #define SIGNATURE_64(A, B, C, D, E, F, G, H) \
- (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))
- #if defined (_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)
- void *
- _ReturnAddress (
- void
- );
- #pragma intrinsic(_ReturnAddress)
- /**
- Get the return address of the calling function.
- Based on intrinsic function _ReturnAddress that provides the address of
- the instruction in the calling function that will be executed after
- control returns to the caller.
- @param L Return Level.
- @return The return address of the calling function or 0 if L != 0.
- **/
- #define RETURN_ADDRESS(L) ((L == 0) ? _ReturnAddress() : (VOID *) 0)
- #elif defined (__GNUC__) || defined (__clang__)
- /**
- Get the return address of the calling function.
- Based on built-in Function __builtin_return_address that returns
- the return address of the current function, or of one of its callers.
- @param L Return Level.
- @return The return address of the calling function.
- **/
- #define RETURN_ADDRESS(L) __builtin_return_address (L)
- #else
- /**
- Get the return address of the calling function.
- @param L Return Level.
- @return 0 as compilers don't support this feature.
- **/
- #define RETURN_ADDRESS(L) ((VOID *) 0)
- #endif
- /**
- Return the number of elements in an array.
- @param Array An object of array type. Array is only used as an argument to
- the sizeof operator, therefore Array is never evaluated. The
- caller is responsible for ensuring that Array's type is not
- incomplete; that is, Array must have known constant size.
- @return The number of elements in Array. The result has type UINTN.
- **/
- #define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))
- #endif
|