]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Base.h
MdePkg: introduce MM communicate 2 protocol
[mirror_edk2.git] / MdePkg / Include / Base.h
index 523192fd79fc945c1ac122ae06da72aab3067972..85a091b9d564af20b62101239beb9e1a1a2decd7 100644 (file)
@@ -8,13 +8,7 @@
 \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
@@ -34,64 +28,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #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
+#if defined(_MSC_VER) && _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
@@ -112,11 +54,10 @@ VERIFY_SIZE_OF (__VERIFY_UINT32_ENUM_SIZE, 4);
 // 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
@@ -254,7 +195,7 @@ VERIFY_SIZE_OF (__VERIFY_UINT32_ENUM_SIZE, 4);
 ///\r
 #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)\r
 \r
-#if __APPLE__\r
+#ifdef __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
@@ -680,7 +621,7 @@ typedef char* VA_LIST;
 #define VA_END(Marker)                  (Marker = (VA_LIST) 0)\r
 #define VA_COPY(Dest, Start)            ((void)((Dest) = (Start)))\r
 \r
-#elif defined(__GNUC__)\r
+#elif defined(__GNUC__) || defined(__clang__)\r
 \r
 #if defined(MDE_CPU_X64) && !defined(NO_MSABI_VA_FUNCS)\r
 //\r
@@ -840,16 +781,70 @@ typedef UINTN  *BASE_LIST;
   @return  Offset, in bytes, of field.\r
 \r
 **/\r
-#ifdef __GNUC__\r
-#if __GNUC__ >= 4\r
+#if (defined(__GNUC__) && __GNUC__ >= 4) || defined(__clang__)\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
+  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 MDE_CPU_EBC\r
+  #define STATIC_ASSERT(Expression, Message)\r
+#elif defined(_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
@@ -869,7 +864,7 @@ typedef UINTN  *BASE_LIST;
   @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
@@ -1277,7 +1272,7 @@ typedef UINTN RETURN_STATUS;
 \r
   **/\r
   #define RETURN_ADDRESS(L)     ((L == 0) ? _ReturnAddress() : (VOID *) 0)\r
-#elif defined(__GNUC__)\r
+#elif defined (__GNUC__) || defined (__clang__)\r
   void * __builtin_return_address (unsigned int level);\r
   /**\r
     Get the return address of the calling function.\r