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 - 2017, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
-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
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\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) && !defined (MDE_CPU_EBC)\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
// warnings.\r
//\r
#ifndef UNREACHABLE\r
- #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 4)\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
- /// Not implemented by GCC 4.4 or earlier.\r
///\r
#define UNREACHABLE() __builtin_unreachable ()\r
#elif defined (__has_feature)\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
#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 BIT2 0x00000004\r
#define BASE_8EB 0x8000000000000000ULL\r
\r
//\r
-// Support for variable length argument lists using the ANSI standard.\r
+// Support for variable argument lists in freestanding edk2 modules.\r
//\r
-// Since we are using the ANSI standard we used the standard naming and\r
-// did not follow the coding convention\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
#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
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
+ 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
#define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r
#endif\r
\r
+/**\r
+ Portable definition for compile time assertions.\r
+ Equivalent to C11 static_assert macro from assert.h.\r
+\r
+ @param Expression Boolean expression.\r
+ @param Message Raised compiler diagnostic message when expression is false.\r
+\r
+**/\r
+#ifdef _MSC_EXTENSIONS\r
+ #define STATIC_ASSERT static_assert\r
+#else\r
+ #define STATIC_ASSERT _Static_assert\r
+#endif\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
+\r
+STATIC_ASSERT (sizeof (BOOLEAN) == 1, "sizeof (BOOLEAN) does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (INT8) == 1, "sizeof (INT8) does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (UINT8) == 1, "sizeof (UINT8) does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (INT16) == 2, "sizeof (INT16) does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (UINT16) == 2, "sizeof (UINT16) does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (INT32) == 4, "sizeof (INT32) does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (UINT32) == 4, "sizeof (UINT32) does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (INT64) == 8, "sizeof (INT64) does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (UINT64) == 8, "sizeof (UINT64) does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (CHAR8) == 1, "sizeof (CHAR8) does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (CHAR16) == 2, "sizeof (CHAR16) does not meet UEFI Specification Data Type requirements");\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
+STATIC_ASSERT (sizeof (__VERIFY_UINT8_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (__VERIFY_UINT16_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");\r
+STATIC_ASSERT (sizeof (__VERIFY_UINT32_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");\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
@return A pointer to the structure from one of it's elements.\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
(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
projects / mirror_edk2.git / blobdiff