/** @file\r
Root include file for Mde Package Base type modules\r
\r
- This is the include file for any module of type base. Base modules only use \r
- types defined via this include file and can be ported easily to any \r
+ This is the include file for any module of type base. Base modules only use\r
+ types defined via this include file and can be ported easily to any\r
environment. There are a set of base libraries in the Mde Package that can\r
be used to implement base modules.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
//\r
#include <ProcessorBind.h>\r
\r
+#if defined(_MSC_EXTENSIONS)\r
+//\r
+// Disable warning when last field of data structure is a zero sized array.\r
+//\r
+#pragma warning ( disable : 4200 )\r
+#endif\r
+\r
+/**\r
+ Verifies the storage size of a given data type.\r
+\r
+ This macro generates a divide by zero error or a zero size array declaration in\r
+ the preprocessor if the size is incorrect. These are declared as "extern" so\r
+ the space for these arrays will not be in the modules.\r
+\r
+ @param TYPE The date type to determine the size of.\r
+ @param Size The expected size for the TYPE.\r
+\r
+**/\r
+#define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]\r
+\r
+//\r
+// Verify that ProcessorBind.h produced UEFI Data Types that are compliant with\r
+// Section 2.3.1 of the UEFI 2.3 Specification.\r
+//\r
+VERIFY_SIZE_OF (BOOLEAN, 1);\r
+VERIFY_SIZE_OF (INT8, 1);\r
+VERIFY_SIZE_OF (UINT8, 1);\r
+VERIFY_SIZE_OF (INT16, 2);\r
+VERIFY_SIZE_OF (UINT16, 2);\r
+VERIFY_SIZE_OF (INT32, 4);\r
+VERIFY_SIZE_OF (UINT32, 4);\r
+VERIFY_SIZE_OF (INT64, 8);\r
+VERIFY_SIZE_OF (UINT64, 8);\r
+VERIFY_SIZE_OF (CHAR8, 1);\r
+VERIFY_SIZE_OF (CHAR16, 2);\r
+\r
+//\r
+// The following three enum types are used to verify that the compiler\r
+// configuration for enum types is compliant with Section 2.3.1 of the\r
+// UEFI 2.3 Specification. These enum types and enum values are not\r
+// intended to be used. A prefix of '__' is used avoid conflicts with\r
+// other types.\r
+//\r
+typedef enum {\r
+ __VerifyUint8EnumValue = 0xff\r
+} __VERIFY_UINT8_ENUM_SIZE;\r
+\r
+typedef enum {\r
+ __VerifyUint16EnumValue = 0xffff\r
+} __VERIFY_UINT16_ENUM_SIZE;\r
+\r
+typedef enum {\r
+ __VerifyUint32EnumValue = 0xffffffff\r
+} __VERIFY_UINT32_ENUM_SIZE;\r
+\r
+VERIFY_SIZE_OF (__VERIFY_UINT8_ENUM_SIZE, 4);\r
+VERIFY_SIZE_OF (__VERIFY_UINT16_ENUM_SIZE, 4);\r
+VERIFY_SIZE_OF (__VERIFY_UINT32_ENUM_SIZE, 4);\r
+\r
+//\r
+// The Microsoft* C compiler can removed references to unreferenced data items\r
+// if the /OPT:REF linker option is used. We defined a macro as this is a\r
+// a non standard extension\r
+//\r
+#if defined(_MSC_EXTENSIONS) && _MSC_VER < 1800 && !defined (MDE_CPU_EBC)\r
+ ///\r
+ /// Remove global variable from the linked image if there are no references to\r
+ /// it after all compiler and linker optimizations have been performed.\r
+ ///\r
+ ///\r
+ #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r
+#else\r
+ ///\r
+ /// Remove the global variable from the linked image if there are no references\r
+ /// to it after all compiler and linker optimizations have been performed.\r
+ ///\r
+ ///\r
+ #define GLOBAL_REMOVE_IF_UNREFERENCED\r
+#endif\r
+\r
+//\r
+// Should be used in combination with NORETURN to avoid 'noreturn' returns\r
+// warnings.\r
+//\r
+#ifndef UNREACHABLE\r
+ #ifdef __GNUC__\r
+ ///\r
+ /// Signal compilers and analyzers that this call is not reachable. It is\r
+ /// up to the compiler to remove any code past that point.\r
+ ///\r
+ #define UNREACHABLE() __builtin_unreachable ()\r
+ #elif defined (__has_feature)\r
+ #if __has_builtin (__builtin_unreachable)\r
+ ///\r
+ /// Signal compilers and analyzers that this call is not reachable. It is\r
+ /// up to the compiler to remove any code past that point.\r
+ ///\r
+ #define UNREACHABLE() __builtin_unreachable ()\r
+ #endif\r
+ #endif\r
+\r
+ #ifndef UNREACHABLE\r
+ ///\r
+ /// Signal compilers and analyzers that this call is not reachable. It is\r
+ /// up to the compiler to remove any code past that point.\r
+ ///\r
+ #define UNREACHABLE()\r
+ #endif\r
+#endif\r
+\r
+//\r
+// Signaling compilers and analyzers that a certain function cannot return may\r
+// remove all following code and thus lead to better optimization and less\r
+// false positives.\r
+//\r
+#ifndef NORETURN\r
+ #if defined (__GNUC__) || defined (__clang__)\r
+ ///\r
+ /// Signal compilers and analyzers that the function cannot return.\r
+ /// It is up to the compiler to remove any code past a call to functions\r
+ /// flagged with this attribute.\r
+ ///\r
+ #define NORETURN __attribute__((noreturn))\r
+ #elif defined(_MSC_EXTENSIONS) && !defined(MDE_CPU_EBC)\r
+ ///\r
+ /// Signal compilers and analyzers that the function cannot return.\r
+ /// It is up to the compiler to remove any code past a call to functions\r
+ /// flagged with this attribute.\r
+ ///\r
+ #define NORETURN __declspec(noreturn)\r
+ #else\r
+ ///\r
+ /// Signal compilers and analyzers that the function cannot return.\r
+ /// It is up to the compiler to remove any code past a call to functions\r
+ /// flagged with this attribute.\r
+ ///\r
+ #define NORETURN\r
+ #endif\r
+#endif\r
+\r
+//\r
+// Should be used in combination with ANALYZER_NORETURN to avoid 'noreturn'\r
+// returns warnings.\r
+//\r
+#ifndef ANALYZER_UNREACHABLE\r
+ #ifdef __clang_analyzer__\r
+ #if __has_builtin (__builtin_unreachable)\r
+ ///\r
+ /// Signal the analyzer that this call is not reachable.\r
+ /// This excludes compilers.\r
+ ///\r
+ #define ANALYZER_UNREACHABLE() __builtin_unreachable ()\r
+ #endif\r
+ #endif\r
+\r
+ #ifndef ANALYZER_UNREACHABLE\r
+ ///\r
+ /// Signal the analyzer that this call is not reachable.\r
+ /// This excludes compilers.\r
+ ///\r
+ #define ANALYZER_UNREACHABLE()\r
+ #endif\r
+#endif\r
+\r
+//\r
+// Static Analyzers may issue errors about potential NULL-dereferences when\r
+// dereferencing a pointer, that has been checked before, outside of a\r
+// NULL-check. This may lead to false positives, such as when using ASSERT()\r
+// for verification.\r
+//\r
+#ifndef ANALYZER_NORETURN\r
+ #ifdef __has_feature\r
+ #if __has_feature (attribute_analyzer_noreturn)\r
+ ///\r
+ /// Signal analyzers that the function cannot return.\r
+ /// This excludes compilers.\r
+ ///\r
+ #define ANALYZER_NORETURN __attribute__((analyzer_noreturn))\r
+ #endif\r
+ #endif\r
+\r
+ #ifndef ANALYZER_NORETURN\r
+ ///\r
+ /// Signal the analyzer that the function cannot return.\r
+ /// This excludes compilers.\r
+ ///\r
+ #define ANALYZER_NORETURN\r
+ #endif\r
+#endif\r
+\r
+///\r
+/// Tell the code optimizer that the function will return twice.\r
+/// This prevents wrong optimizations which can cause bugs.\r
+///\r
+#ifndef RETURNS_TWICE\r
+ #if defined (__GNUC__) || defined (__clang__)\r
+ ///\r
+ /// Tell the code optimizer that the function will return twice.\r
+ /// This prevents wrong optimizations which can cause bugs.\r
+ ///\r
+ #define RETURNS_TWICE __attribute__((returns_twice))\r
+ #else\r
+ ///\r
+ /// Tell the code optimizer that the function will return twice.\r
+ /// This prevents wrong optimizations which can cause bugs.\r
+ ///\r
+ #define RETURNS_TWICE\r
+ #endif\r
+#endif\r
+\r
+//\r
+// For symbol name in assembly code, an extra "_" is sometimes necessary\r
+//\r
+\r
+///\r
+/// Private worker functions for ASM_PFX()\r
+///\r
+#define _CONCATENATE(a, b) __CONCATENATE(a, b)\r
+#define __CONCATENATE(a, b) a ## b\r
+\r
+///\r
+/// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix\r
+/// on symbols in assembly language.\r
///\r
-/// 128 bit buffer containing a unique identifier value. \r
+#define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)\r
+\r
+#if __APPLE__\r
+ //\r
+ // Apple extension that is used by the linker to optimize code size\r
+ // with assembly functions. Put at the end of your .S files\r
+ //\r
+ #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols\r
+#else\r
+ #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED\r
+#endif\r
+\r
+#ifdef __CC_ARM\r
+ //\r
+ // Older RVCT ARM compilers don't fully support #pragma pack and require __packed\r
+ // as a prefix for the structure.\r
+ //\r
+ #define PACKED __packed\r
+#else\r
+ #define PACKED\r
+#endif\r
+\r
+///\r
+/// 128 bit buffer containing a unique identifier value.\r
/// Unless otherwise specified, aligned on a 64 bit boundary.\r
///\r
typedef struct {\r
UINT8 Data4[8];\r
} GUID;\r
\r
+///\r
+/// 4-byte buffer. An IPv4 internet protocol address.\r
+///\r
+typedef struct {\r
+ UINT8 Addr[4];\r
+} IPv4_ADDRESS;\r
+\r
+///\r
+/// 16-byte buffer. An IPv6 internet protocol address.\r
+///\r
+typedef struct {\r
+ UINT8 Addr[16];\r
+} IPv6_ADDRESS;\r
+\r
//\r
// 8-bytes unsigned value that represents a physical system address.\r
//\r
//\r
\r
///\r
-/// Datum is read-only\r
+/// Datum is read-only.\r
///\r
#define CONST const\r
\r
///\r
-/// Datum is scoped to the current file or function\r
+/// Datum is scoped to the current file or function.\r
///\r
#define STATIC static\r
\r
///\r
-/// Undeclared type\r
+/// Undeclared type.\r
///\r
#define VOID void\r
\r
//\r
\r
///\r
-/// Datum is passed to the function\r
+/// Datum is passed to the function.\r
///\r
#define IN\r
\r
///\r
-/// Datum is returned from the function\r
+/// Datum is returned from the function.\r
///\r
#define OUT\r
\r
///\r
/// Passing the datum to the function is optional, and a NULL\r
-/// be passed if the value is not supplied.\r
+/// is passed if the value is not supplied.\r
///\r
#define OPTIONAL\r
\r
//\r
-// UEFI specification claims 1 and 0. We are concerned about the \r
-// complier portability so we did it this way.\r
+// UEFI specification claims 1 and 0. We are concerned about the\r
+// compiler portability so we did it this way.\r
//\r
\r
///\r
///\r
#define NULL ((VOID *) 0)\r
\r
+//\r
+// Null character\r
+//\r
+#define CHAR_NULL 0x0000\r
+\r
+///\r
+/// Maximum values for common UEFI Data Types\r
+///\r
+#define MAX_INT8 ((INT8)0x7F)\r
+#define MAX_UINT8 ((UINT8)0xFF)\r
+#define MAX_INT16 ((INT16)0x7FFF)\r
+#define MAX_UINT16 ((UINT16)0xFFFF)\r
+#define MAX_INT32 ((INT32)0x7FFFFFFF)\r
+#define MAX_UINT32 ((UINT32)0xFFFFFFFF)\r
+#define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)\r
+#define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)\r
+\r
+///\r
+/// Minimum values for the signed UEFI Data Types\r
+///\r
+#define MIN_INT8 (((INT8) -127) - 1)\r
+#define MIN_INT16 (((INT16) -32767) - 1)\r
+#define MIN_INT32 (((INT32) -2147483647) - 1)\r
+#define MIN_INT64 (((INT64) -9223372036854775807LL) - 1)\r
\r
#define BIT0 0x00000001\r
#define BIT1 0x00000002\r
#define SIZE_2EB 0x2000000000000000ULL\r
#define SIZE_4EB 0x4000000000000000ULL\r
#define SIZE_8EB 0x8000000000000000ULL\r
- \r
+\r
#define BASE_1KB 0x00000400\r
#define BASE_2KB 0x00000800\r
#define BASE_4KB 0x00001000\r
#define BASE_8EB 0x8000000000000000ULL\r
\r
//\r
-// Support for variable length argument lists using the ANSI standard.\r
-// \r
-// Since we are using the ANSI standard we used the standard naming and\r
-// did not follow the coding convention\r
+// Support for variable argument lists in freestanding edk2 modules.\r
+//\r
+// For modules that use the ISO C library interfaces for variable\r
+// argument lists, refer to "StdLib/Include/stdarg.h".\r
//\r
// VA_LIST - typedef for argument list.\r
// VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r
// VA_END (VA_LIST Marker) - Clear Marker\r
-// VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from\r
-// the ... list. You must know the size and pass it in this macro.\r
+// VA_ARG (VA_LIST Marker, var arg type) - Use Marker to get an argument from\r
+// the ... list. You must know the type and pass it in this macro. Type\r
+// must be compatible with the type of the actual next argument (as promoted\r
+// according to the default argument promotions.)\r
+// VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.\r
//\r
-// example:\r
+// Example:\r
//\r
// UINTN\r
+// EFIAPI\r
// ExampleVarArg (\r
// IN UINTN NumberOfArgs,\r
// ...\r
// VA_START (Marker, NumberOfArgs);\r
// for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r
// //\r
-// // The ... list is a series of UINTN values, so average them up.\r
+// // The ... list is a series of UINTN values, so sum them up.\r
// //\r
// Result += VA_ARG (Marker, UINTN);\r
// }\r
//\r
// VA_END (Marker);\r
-// return Result\r
+// return Result;\r
// }\r
//\r
+// Notes:\r
+// - Functions that call VA_START() / VA_END() must have a variable\r
+// argument list and must be declared EFIAPI.\r
+// - Functions that call VA_COPY() / VA_END() must be declared EFIAPI.\r
+// - Functions that only use VA_LIST and VA_ARG() need not be EFIAPI.\r
+//\r
\r
/**\r
Return the size of argument that has been aligned to sizeof (UINTN).\r
\r
- @param n The parameter size is to be aligned.\r
+ @param n The parameter size to be aligned.\r
\r
- @return The aligned size\r
+ @return The aligned size.\r
**/\r
#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
\r
-#if defined(__GNUC__)\r
+#if defined(__CC_ARM)\r
+//\r
+// RVCT ARM variable argument list support.\r
+//\r
+\r
+///\r
+/// Variable used to traverse the list of arguments. This type can vary by\r
+/// implementation and could be an array or structure.\r
+///\r
+#ifdef __APCS_ADSABI\r
+ typedef int *va_list[1];\r
+ #define VA_LIST va_list\r
+#else\r
+ typedef struct __va_list { void *__ap; } va_list;\r
+ #define VA_LIST va_list\r
+#endif\r
+\r
+#define VA_START(Marker, Parameter) __va_start(Marker, Parameter)\r
+\r
+#define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE)\r
+\r
+#define VA_END(Marker) ((void)0)\r
+\r
+// For some ARM RVCT compilers, __va_copy is not defined\r
+#ifndef __va_copy\r
+ #define __va_copy(dest, src) ((void)((dest) = (src)))\r
+#endif\r
+\r
+#define VA_COPY(Dest, Start) __va_copy (Dest, Start)\r
+\r
+#elif defined(_M_ARM) || defined(_M_ARM64)\r
+//\r
+// MSFT ARM variable argument list support.\r
+//\r
+\r
+typedef char* VA_LIST;\r
+\r
+#define VA_START(Marker, Parameter) __va_start (&Marker, &Parameter, _INT_SIZE_OF (Parameter), __alignof(Parameter), &Parameter)\r
+#define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE) + ((-(INTN)Marker) & (sizeof(TYPE) - 1))) - _INT_SIZE_OF (TYPE)))\r
+#define VA_END(Marker) (Marker = (VA_LIST) 0)\r
+#define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))\r
+\r
+#elif defined(__GNUC__)\r
+\r
+#if defined(MDE_CPU_X64) && !defined(NO_MSABI_VA_FUNCS)\r
+//\r
+// X64 only. Use MS ABI version of GCC built-in macros for variable argument lists.\r
+//\r
+///\r
+/// Both GCC and LLVM 3.8 for X64 support new variable argument intrinsics for Microsoft ABI\r
+///\r
+\r
+///\r
+/// Variable used to traverse the list of arguments. This type can vary by\r
+/// implementation and could be an array or structure.\r
+///\r
+typedef __builtin_ms_va_list VA_LIST;\r
+\r
+#define VA_START(Marker, Parameter) __builtin_ms_va_start (Marker, Parameter)\r
+\r
+#define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))\r
+\r
+#define VA_END(Marker) __builtin_ms_va_end (Marker)\r
+\r
+#define VA_COPY(Dest, Start) __builtin_ms_va_copy (Dest, Start)\r
+\r
+#else\r
//\r
// Use GCC built-in macros for variable argument lists.\r
//\r
+\r
+///\r
+/// Variable used to traverse the list of arguments. This type can vary by\r
+/// implementation and could be an array or structure.\r
+///\r
typedef __builtin_va_list VA_LIST;\r
\r
#define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)\r
\r
#define VA_END(Marker) __builtin_va_end (Marker)\r
\r
+#define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)\r
+\r
+#endif\r
+\r
#else\r
///\r
-/// Pointer to the start of a variable argument list. Same as CHAR8 *.\r
+/// Variable used to traverse the list of arguments. This type can vary by\r
+/// implementation and could be an array or structure.\r
///\r
typedef CHAR8 *VA_LIST;\r
\r
/**\r
- Retrieves a pointer to the beginning of a variable argument list based on \r
- the name of the parameter that immediately precedes the variable argument list. \r
+ Retrieves a pointer to the beginning of a variable argument list, based on\r
+ the name of the parameter that immediately precedes the variable argument list.\r
\r
- This function initializes Marker to point to the beginning of the variable argument \r
- list that immediately follows Parameter. The method for computing the pointer to the \r
- next argument in the argument list is CPU specific following the EFIAPI ABI.\r
+ This function initializes Marker to point to the beginning of the variable\r
+ argument list that immediately follows Parameter. The method for computing the\r
+ pointer to the next argument in the argument list is CPU-specific following the\r
+ EFIAPI ABI.\r
\r
- @param Marker Pointer to the beginning of the variable argument list.\r
- @param Parameter The name of the parameter that immediately precedes \r
+ @param Marker The VA_LIST used to traverse the list of arguments.\r
+ @param Parameter The name of the parameter that immediately precedes\r
the variable argument list.\r
- \r
+\r
@return A pointer to the beginning of a variable argument list.\r
\r
**/\r
-#define VA_START(Marker, Parameter) (Marker = (VA_LIST) & (Parameter) + _INT_SIZE_OF (Parameter))\r
+#define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))\r
\r
/**\r
- Returns an argument of a specified type from a variable argument list and updates \r
- the pointer to the variable argument list to point to the next argument. \r
+ Returns an argument of a specified type from a variable argument list and updates\r
+ the pointer to the variable argument list to point to the next argument.\r
\r
- This function returns an argument of the type specified by TYPE from the beginning \r
- of the variable argument list specified by Marker. Marker is then updated to point \r
- to the next argument in the variable argument list. The method for computing the \r
- pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r
+ This function returns an argument of the type specified by TYPE from the beginning\r
+ of the variable argument list specified by Marker. Marker is then updated to point\r
+ to the next argument in the variable argument list. The method for computing the\r
+ pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.\r
\r
- @param Marker Pointer to the beginning of a variable argument list.\r
- @param TYPE The type of argument to retrieve from the beginning \r
+ @param Marker VA_LIST used to traverse the list of arguments.\r
+ @param TYPE The type of argument to retrieve from the beginning\r
of the variable argument list.\r
- \r
+\r
@return An argument of the type specified by TYPE.\r
\r
**/\r
/**\r
Terminates the use of a variable argument list.\r
\r
- This function initializes Marker so it can no longer be used with VA_ARG(). \r
- After this macro is used, the only way to access the variable argument list again is \r
+ This function initializes Marker so it can no longer be used with VA_ARG().\r
+ After this macro is used, the only way to access the variable argument list is\r
by using VA_START() again.\r
\r
- @param Marker The variable to set to the beginning of the variable argument list.\r
- \r
+ @param Marker VA_LIST used to traverse the list of arguments.\r
+\r
**/\r
#define VA_END(Marker) (Marker = (VA_LIST) 0)\r
\r
+/**\r
+ Initializes a VA_LIST as a copy of an existing VA_LIST.\r
+\r
+ This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest\r
+ followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach\r
+ the present state of Start.\r
+\r
+ @param Dest VA_LIST used to traverse the list of arguments.\r
+ @param Start VA_LIST used to traverse the list of arguments.\r
+\r
+**/\r
+#define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))\r
+\r
#endif\r
\r
///\r
typedef UINTN *BASE_LIST;\r
\r
/**\r
- Returns an argument of a specified type from a variable argument list and updates \r
- the pointer to the variable argument list to point to the next argument. \r
+ Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.\r
+\r
+ @param TYPE The date type to determine the size of.\r
+\r
+ @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.\r
+**/\r
+#define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))\r
\r
- This function returns an argument of the type specified by TYPE from the beginning \r
- of the variable argument list specified by Marker. Marker is then updated to point \r
- to the next argument in the variable argument list. The method for computing the \r
+/**\r
+ Returns an argument of a specified type from a variable argument list and updates\r
+ the pointer to the variable argument list to point to the next argument.\r
+\r
+ This function returns an argument of the type specified by TYPE from the beginning\r
+ of the variable argument list specified by Marker. Marker is then updated to point\r
+ to the next argument in the variable argument list. The method for computing the\r
pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r
\r
- @param Marker Pointer to the beginning of a variable argument list.\r
- @param TYPE The type of argument to retrieve from the beginning \r
+ @param Marker The pointer to the beginning of a variable argument list.\r
+ @param TYPE The type of argument to retrieve from the beginning\r
of the variable argument list.\r
- \r
+\r
@return An argument of the type specified by TYPE.\r
\r
**/\r
-#define BASE_ARG(Marker, TYPE) (*(TYPE *)((UINT8 *)(Marker = (BASE_LIST)((UINT8 *)Marker + _INT_SIZE_OF (TYPE))) - _INT_SIZE_OF (TYPE)))\r
+#define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))\r
\r
/**\r
- Macro that returns the byte offset of a field in a data structure. \r
+ The macro that returns the byte offset of a field in a data structure.\r
\r
- This function returns the offset, in bytes, of field specified by Field from the \r
- beginning of the data structure specified by TYPE. If TYPE does not contain Field, \r
- the module will not compile. \r
+ This function returns the offset, in bytes, of field specified by Field from the\r
+ beginning of the data structure specified by TYPE. If TYPE does not contain Field,\r
+ the module will not compile.\r
\r
- @param TYPE The name of the data structure that contains the field specified by Field. \r
+ @param TYPE The name of the data structure that contains the field specified by Field.\r
@param Field The name of the field in the data structure.\r
- \r
+\r
@return Offset, in bytes, of field.\r
- \r
+\r
**/\r
+#ifdef __GNUC__\r
+#if __GNUC__ >= 4\r
+#define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))\r
+#endif\r
+#endif\r
+\r
+#ifndef OFFSET_OF\r
#define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r
+#endif\r
\r
/**\r
- Macro that returns a pointer to the data structure that contains a specified field of \r
- that data structure. This is a lightweight method to hide information by placing a \r
- public data structure inside a larger private data structure and using a pointer to \r
+ Macro that returns a pointer to the data structure that contains a specified field of\r
+ that data structure. This is a lightweight method to hide information by placing a\r
+ public data structure inside a larger private data structure and using a pointer to\r
the public data structure to retrieve a pointer to the private data structure.\r
\r
- This function computes the offset, in bytes, of field specified by Field from the beginning \r
- of the data structure specified by TYPE. This offset is subtracted from Record, and is \r
- used to return a pointer to a data structure of the type specified by TYPE. If the data type \r
- specified by TYPE does not contain the field specified by Field, then the module will not compile. \r
- \r
- @param Record Pointer to the field specified by Field within a data structure of type TYPE. \r
- @param TYPE The name of the data structure type to return. This data structure must \r
- contain the field specified by Field. \r
+ This function computes the offset, in bytes, of field specified by Field from the beginning\r
+ of the data structure specified by TYPE. This offset is subtracted from Record, and is\r
+ used to return a pointer to a data structure of the type specified by TYPE. If the data type\r
+ specified by TYPE does not contain the field specified by Field, then the module will not compile.\r
+\r
+ @param Record Pointer to the field specified by Field within a data structure of type TYPE.\r
+ @param TYPE The name of the data structure type to return. This data structure must\r
+ contain the field specified by Field.\r
@param Field The name of the field in the data structure specified by TYPE to which Record points.\r
- \r
+\r
@return A pointer to the structure from one of it's elements.\r
- \r
+\r
**/\r
-#define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r
+#define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - OFFSET_OF (TYPE, Field)))\r
\r
/**\r
- Rounds a value up to the next boundary using a specified alignment. \r
+ Rounds a value up to the next boundary using a specified alignment.\r
\r
- This function rounds Value up to the next boundary using the specified Alignment. \r
- This aligned value is returned. \r
+ This function rounds Value up to the next boundary using the specified Alignment.\r
+ This aligned value is returned.\r
\r
@param Value The value to round up.\r
@param Alignment The alignment boundary used to return the aligned value.\r
- \r
+\r
@return A value up to the next boundary.\r
- \r
+\r
**/\r
#define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r
\r
/**\r
- Adjust a pointer by adding the minimum offset required for it to be aligned on \r
- a specified alignment boundary. \r
+ Adjust a pointer by adding the minimum offset required for it to be aligned on\r
+ a specified alignment boundary.\r
\r
- This function rounds the pointer specified by Pointer to the next alignment boundary \r
- specified by Alignment. The pointer to the aligned address is returned. \r
+ This function rounds the pointer specified by Pointer to the next alignment boundary\r
+ specified by Alignment. The pointer to the aligned address is returned.\r
\r
- @param Value The value to round up.\r
+ @param Pointer The pointer to round up.\r
@param Alignment The alignment boundary to use to return an aligned pointer.\r
- \r
+\r
@return Pointer to the aligned address.\r
- \r
+\r
**/\r
#define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r
\r
/**\r
- Rounds a value up to the next natural boundary for the current CPU. \r
- This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs. \r
+ Rounds a value up to the next natural boundary for the current CPU.\r
+ This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.\r
\r
- This function rounds the value specified by Value up to the next natural boundary for the \r
- current CPU. This rounded value is returned. \r
+ This function rounds the value specified by Value up to the next natural boundary for the\r
+ current CPU. This rounded value is returned.\r
\r
@param Value The value to round up.\r
\r
@return Rounded value specified by Value.\r
- \r
+\r
**/\r
#define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))\r
- \r
+\r
\r
/**\r
- Return the maximum of two operands. \r
+ Return the maximum of two operands.\r
\r
- This macro returns the maximum of two operand specified by a and b. \r
+ This macro returns the maximum of two operand specified by a and b.\r
Both a and b must be the same numerical types, signed or unsigned.\r
\r
- @param TYPE Any numerical data types.\r
@param a The first operand with any numerical type.\r
- @param b The second operand. It should be the same any numerical type with a.\r
- \r
+ @param b The second operand. Can be any numerical type as long as is\r
+ the same type as a.\r
+\r
@return Maximum of two operands.\r
- \r
+\r
**/\r
#define MAX(a, b) \\r
(((a) > (b)) ? (a) : (b))\r
\r
/**\r
- Return the minimum of two operands. \r
+ Return the minimum of two operands.\r
\r
- This macro returns the minimal of two operand specified by a and b. \r
+ This macro returns the minimal of two operand specified by a and b.\r
Both a and b must be the same numerical types, signed or unsigned.\r
\r
- @param TYPE Any numerical data types.\r
@param a The first operand with any numerical type.\r
@param b The second operand. It should be the same any numerical type with a.\r
- \r
+\r
@return Minimum of two operands.\r
- \r
-**/\r
\r
+**/\r
#define MIN(a, b) \\r
(((a) < (b)) ? (a) : (b))\r
\r
+/**\r
+ Return the absolute value of a signed operand.\r
+\r
+ This macro returns the absolute value of the signed operand specified by a.\r
+\r
+ @param a The signed operand.\r
+\r
+ @return The absolute value of the signed operand.\r
+\r
+**/\r
+#define ABS(a) \\r
+ (((a) < 0) ? (-(a)) : (a))\r
+\r
//\r
// Status codes common to all execution phases\r
//\r
-typedef INTN RETURN_STATUS;\r
+typedef UINTN RETURN_STATUS;\r
\r
/**\r
- Produces a RETURN_STATUS code with the highest bit set. \r
+ Produces a RETURN_STATUS code with the highest bit set.\r
\r
- @param StatusCode The status code value to convert into a warning code. \r
+ @param StatusCode The status code value to convert into a warning code.\r
StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r
\r
@return The value specified by StatusCode with the highest bit set.\r
#define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))\r
\r
/**\r
- Produces a RETURN_STATUS code with the highest bit clear. \r
+ Produces a RETURN_STATUS code with the highest bit clear.\r
\r
- @param StatusCode The status code value to convert into a warning code. \r
+ @param StatusCode The status code value to convert into a warning code.\r
StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r
\r
@return The value specified by StatusCode with the highest bit clear.\r
#define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))\r
\r
/**\r
- Returns TRUE if a specified RETURN_STATUS code is an error code. \r
+ Returns TRUE if a specified RETURN_STATUS code is an error code.\r
+\r
+ This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.\r
\r
- This function returns TRUE if StatusCode has the high bit set. Otherwise FALSE is returned. \r
- \r
@param StatusCode The status code value to evaluate.\r
\r
@retval TRUE The high bit of StatusCode is set.\r
@retval FALSE The high bit of StatusCode is clear.\r
\r
**/\r
-#define RETURN_ERROR(StatusCode) (((RETURN_STATUS)(StatusCode)) < 0)\r
+#define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)\r
\r
///\r
/// The operation completed successfully.\r
#define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r
\r
///\r
-/// An inconsistency was detected on the file system causing the \r
+/// An inconsistency was detected on the file system causing the\r
/// operation to fail.\r
///\r
#define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r
#define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r
\r
///\r
-/// The device does not contain any medium to perform the \r
+/// The device does not contain any medium to perform the\r
/// operation.\r
///\r
#define RETURN_NO_MEDIA ENCODE_ERROR (12)\r
#define RETURN_CRC_ERROR ENCODE_ERROR (27)\r
\r
///\r
-/// Beginning or end of media was reached.\r
+/// The beginning or end of media was reached.\r
///\r
#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r
\r
///\r
#define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)\r
\r
+///\r
+/// The security status of the data is unknown or compromised\r
+/// and the data must be updated or replaced to restore a valid\r
+/// security status.\r
+///\r
+#define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)\r
+\r
+///\r
+/// A HTTP error occurred during the network operation.\r
+///\r
+#define RETURN_HTTP_ERROR ENCODE_ERROR (35)\r
\r
///\r
-/// The Unicode string contained one or more characters that\r
+/// The string contained one or more characters that\r
/// the device could not render and were skipped.\r
///\r
#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r
#define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r
\r
///\r
-/// The resulting buffer was too small, and the data was \r
+/// The resulting buffer was too small, and the data was\r
/// truncated to the buffer size.\r
///\r
#define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r
\r
+///\r
+/// The data has not been updated within the timeframe set by\r
+/// local policy for this type of data.\r
+///\r
+#define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)\r
+\r
+///\r
+/// The resulting buffer contains UEFI-compliant file system.\r
+///\r
+#define RETURN_WARN_FILE_SYSTEM ENCODE_WARNING (6)\r
+\r
+\r
/**\r
Returns a 16-bit signature built from 2 ASCII characters.\r
- \r
- This macro returns a 16-bit value built from the two ASCII characters specified \r
+\r
+ This macro returns a 16-bit value built from the two ASCII characters specified\r
by A and B.\r
- \r
+\r
@param A The first ASCII character.\r
@param B The second ASCII character.\r
\r
\r
/**\r
Returns a 32-bit signature built from 4 ASCII characters.\r
- \r
- This macro returns a 32-bit value built from the four ASCII characters specified \r
+\r
+ This macro returns a 32-bit value built from the four ASCII characters specified\r
by A, B, C, and D.\r
- \r
+\r
@param A The first ASCII character.\r
@param B The second ASCII character.\r
@param C The third ASCII character.\r
\r
/**\r
Returns a 64-bit signature built from 8 ASCII characters.\r
- \r
- This macro returns a 64-bit value built from the eight ASCII characters specified \r
+\r
+ This macro returns a 64-bit value built from the eight ASCII characters specified\r
by A, B, C, D, E, F, G,and H.\r
- \r
+\r
@param A The first ASCII character.\r
@param B The second ASCII character.\r
@param C The third ASCII character.\r
#define SIGNATURE_64(A, B, C, D, E, F, G, H) \\r
(SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r
\r
+#if defined(_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)\r
+ void * _ReturnAddress(void);\r
+ #pragma intrinsic(_ReturnAddress)\r
+ /**\r
+ Get the return address of the calling function.\r
+\r
+ Based on intrinsic function _ReturnAddress that provides the address of\r
+ the instruction in the calling function that will be executed after\r
+ control returns to the caller.\r
+\r
+ @param L Return Level.\r
+\r
+ @return The return address of the calling function or 0 if L != 0.\r
+\r
+ **/\r
+ #define RETURN_ADDRESS(L) ((L == 0) ? _ReturnAddress() : (VOID *) 0)\r
+#elif defined(__GNUC__)\r
+ void * __builtin_return_address (unsigned int level);\r
+ /**\r
+ Get the return address of the calling function.\r
+\r
+ Based on built-in Function __builtin_return_address that returns\r
+ the return address of the current function, or of one of its callers.\r
+\r
+ @param L Return Level.\r
+\r
+ @return The return address of the calling function.\r
+\r
+ **/\r
+ #define RETURN_ADDRESS(L) __builtin_return_address (L)\r
+#else\r
+ /**\r
+ Get the return address of the calling function.\r
+\r
+ @param L Return Level.\r
+\r
+ @return 0 as compilers don't support this feature.\r
+\r
+ **/\r
+ #define RETURN_ADDRESS(L) ((VOID *) 0)\r
+#endif\r
+\r
+/**\r
+ Return the number of elements in an array.\r
+\r
+ @param Array An object of array type. Array is only used as an argument to\r
+ the sizeof operator, therefore Array is never evaluated. The\r
+ caller is responsible for ensuring that Array's type is not\r
+ incomplete; that is, Array must have known constant size.\r
+\r
+ @return The number of elements in Array. The result has type UINTN.\r
+\r
+**/\r
+#define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))\r
+\r
#endif\r
\r
projects / mirror_edk2.git / blobdiff