]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/X64/ProcessorBind.h
MdePkg/Nasm.inc: add macros for C types used in structure definition
[mirror_edk2.git] / MdePkg / Include / X64 / ProcessorBind.h
index ce198678514367291c7b7fdd149d73004ee0c50e..5d14316524c65760b5324c09f7180725f3951ab2 100644 (file)
@@ -1,14 +1,8 @@
 /** @file\r
-  Processor or Compiler specific defines and types x64 (Intel(r) EM64T, AMD64).\r
+  Processor or Compiler specific defines and types x64 (Intel 64, AMD64).\r
 \r
-  Copyright (c) 2006 - 2009, 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 - 2019, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -20,7 +14,6 @@
 ///\r
 #define MDE_CPU_X64\r
 \r
-\r
 //\r
 // Make sure we are using the correct packing rules per EFI specification\r
 //\r
 #pragma pack()\r
 #endif\r
 \r
+#if defined(__GNUC__) && defined(__pic__) && !defined(USING_LTO)  && !defined(__APPLE__)\r
+//\r
+// Mark all symbol declarations and references as hidden, meaning they will\r
+// not be subject to symbol preemption. This allows the compiler to refer to\r
+// symbols directly using relative references rather than via the GOT, which\r
+// contains absolute symbol addresses that are subject to runtime relocation.\r
+//\r
+// The LTO linker will not emit GOT based relocations when all symbol\r
+// references can be resolved locally, and so there is no need to set the\r
+// pragma in that case (and doing so will cause other issues).\r
+//\r
+#pragma GCC visibility push (hidden)\r
+#endif\r
 \r
 #if defined(__INTEL_COMPILER)\r
 //\r
 //\r
 #pragma warning ( disable : 1419 )\r
 \r
+//\r
+// Disable ICC's remark #593: "Variable" was set but never used.\r
+// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
+//\r
+#pragma warning ( disable : 593 )\r
+\r
 #endif\r
 \r
 \r
@@ -75,7 +87,7 @@
 #pragma warning ( disable : 4057 )\r
 \r
 //\r
-// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning\r
+// ASSERT(FALSE) or while (TRUE) are legal constructs so suppress this warning\r
 //\r
 #pragma warning ( disable : 4127 )\r
 \r
 //\r
 #pragma warning ( disable : 4206 )\r
 \r
+#if defined(_MSC_VER) && _MSC_VER >= 1800\r
+\r
+//\r
+// Disable these warnings for VS2013.\r
+//\r
+\r
+//\r
+// This warning is for potentially uninitialized local variable, and it may cause false\r
+// positive issues in VS2013 and VS2015 build\r
+//\r
+#pragma warning ( disable : 4701 )\r
+\r
+//\r
+// This warning is for potentially uninitialized local pointer variable, and it may cause\r
+// false positive issues in VS2013 and VS2015 build\r
+//\r
+#pragma warning ( disable : 4703 )\r
+\r
 #endif\r
 \r
+#endif\r
 \r
-#if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)\r
-  //\r
-  // No ANSI C 2000 stdint.h integer width declarations, so define equivalents\r
-  //\r
\r
-  #if defined(_MSC_EXTENSIONS)\r
-    //\r
-    // use Microsoft C complier dependent integer width types \r
-    //\r
-\r
-    ///\r
-    /// 8-byte unsigned value\r
-    ///\r
-    typedef unsigned __int64    UINT64;\r
-    ///\r
-    /// 8-byte signed value\r
-    ///\r
-    typedef __int64             INT64;\r
-    ///\r
-    /// 4-byte unsigned value\r
-    ///\r
-    typedef unsigned __int32    UINT32;\r
-    ///\r
-    /// 4-byte signed value\r
-    ///\r
-    typedef __int32             INT32;\r
-    ///\r
-    /// 2-byte unsigned value\r
-    ///\r
-    typedef unsigned short      UINT16;\r
-    ///\r
-    /// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
-    /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
-    ///\r
-    typedef unsigned short      CHAR16;\r
-    ///\r
-    /// 2-byte signed value\r
-    ///\r
-    typedef short               INT16;\r
-    ///\r
-    /// Logical Boolean.  1-byte value containing 0 for FALSE or a 1 for TRUE.  Other\r
-    /// values are undefined.\r
-    ///\r
-    typedef unsigned char       BOOLEAN;\r
-    ///\r
-    /// 1-byte unsigned value\r
-    ///\r
-    typedef unsigned char       UINT8;\r
-    ///\r
-    /// 1-byte Character\r
-    ///\r
-    typedef char                CHAR8;\r
-    ///\r
-    /// 1-byte signed value\r
-    ///\r
-    typedef char                INT8;\r
-  #else\r
-    #if defined(_EFI_P64)\r
-      //\r
-      // P64 - pointers being 64-bit and longs and ints are 32-bits.\r
-      //\r
-\r
-      ///\r
-      /// 8-byte unsigned value\r
-      ///\r
-      typedef unsigned long long  UINT64;\r
-      ///\r
-      /// 8-byte signed value\r
-      ///\r
-      typedef long long           INT64;\r
-      ///\r
-      /// 4-byte unsigned value\r
-      ///\r
-      typedef unsigned int        UINT32;\r
-      ///\r
-      /// 4-byte signed value\r
-      ///\r
-      typedef int                 INT32;\r
-      ///\r
-      /// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
-      /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
-      ///\r
-      typedef unsigned short      CHAR16;\r
-      ///\r
-      /// 2-byte unsigned value\r
-      ///\r
-      typedef unsigned short      UINT16;\r
-      ///\r
-      /// 2-byte signed value\r
-      ///\r
-      typedef short               INT16;\r
-      ///\r
-      /// Logical Boolean.  1-byte value containing 0 for FALSE or a 1 for TRUE.  Other\r
-      /// values are undefined.\r
-      ///\r
-      typedef unsigned char       BOOLEAN;\r
-      ///\r
-      /// 1-byte unsigned value\r
-      ///\r
-      typedef unsigned char       UINT8;\r
-      ///\r
-      /// 1-byte Character\r
-      ///\r
-      typedef char                CHAR8;\r
-      ///\r
-      /// 1-byte signed value\r
-      ///\r
-      typedef char                INT8;\r
-    #else\r
-      //\r
-      // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.\r
-      //\r
-\r
-      ///\r
-      /// 8-byte unsigned value\r
-      ///\r
-      typedef unsigned long   UINT64;\r
-      ///\r
-      /// 8-byte signed value\r
-      ///\r
-      typedef long            INT64;\r
-      ///\r
-      /// 4-byte unsigned value\r
-      ///\r
-      typedef unsigned int    UINT32;\r
-      ///\r
-      /// 4-byte signed value\r
-      ///\r
-      typedef int             INT32;\r
-      ///\r
-      /// 2-byte unsigned value\r
-      ///\r
-      typedef unsigned short  UINT16;\r
-      ///\r
-      /// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
-      /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
-      ///\r
-      typedef unsigned short  CHAR16;\r
-      ///\r
-      /// 2-byte signed value\r
-      ///\r
-      typedef short           INT16;\r
-      ///\r
-      /// Logical Boolean.  1-byte value containing 0 for FALSE or a 1 for TRUE.  Other\r
-      /// values are undefined.\r
-      ///\r
-      typedef unsigned char   BOOLEAN;\r
-      ///\r
-      /// 1-byte unsigned value\r
-      ///\r
-      typedef unsigned char   UINT8;\r
-      ///\r
-      /// 1-byte Character\r
-      ///\r
-      typedef char            CHAR8;\r
-      ///\r
-      /// 1-byte signed value\r
-      ///\r
-      typedef char            INT8;\r
-    #endif\r
-  #endif\r
-#else\r
+\r
+#if defined(_MSC_EXTENSIONS)\r
   //\r
-  // Use ANSI C 2000 stdint.h integer width declarations\r
+  // use Microsoft C compiler dependent integer width types\r
   //\r
-  #include <stdint.h>\r
 \r
+  ///\r
+  /// 8-byte unsigned value\r
+  ///\r
+  typedef unsigned __int64    UINT64;\r
+  ///\r
+  /// 8-byte signed value\r
+  ///\r
+  typedef __int64             INT64;\r
+  ///\r
+  /// 4-byte unsigned value\r
+  ///\r
+  typedef unsigned __int32    UINT32;\r
+  ///\r
+  /// 4-byte signed value\r
+  ///\r
+  typedef __int32             INT32;\r
+  ///\r
+  /// 2-byte unsigned value\r
+  ///\r
+  typedef unsigned short      UINT16;\r
+  ///\r
+  /// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
+  /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
+  ///\r
+  typedef unsigned short      CHAR16;\r
+  ///\r
+  /// 2-byte signed value\r
+  ///\r
+  typedef short               INT16;\r
   ///\r
   /// Logical Boolean.  1-byte value containing 0 for FALSE or a 1 for TRUE.  Other\r
   /// values are undefined.\r
   ///\r
-  typedef uint8_t   BOOLEAN;\r
+  typedef unsigned char       BOOLEAN;\r
+  ///\r
+  /// 1-byte unsigned value\r
+  ///\r
+  typedef unsigned char       UINT8;\r
+  ///\r
+  /// 1-byte Character\r
+  ///\r
+  typedef char                CHAR8;\r
   ///\r
   /// 1-byte signed value\r
   ///\r
-  typedef int8_t    INT8;\r
+  typedef signed char         INT8;\r
+#else\r
   ///\r
-  /// 1-byte unsigned value\r
+  /// 8-byte unsigned value\r
   ///\r
-  typedef uint8_t   UINT8;\r
+  typedef unsigned long long  UINT64;\r
   ///\r
-  /// 2-byte signed value\r
+  /// 8-byte signed value\r
   ///\r
-  typedef int16_t   INT16;\r
+  typedef long long           INT64;\r
   ///\r
-  /// 2-byte unsigned value\r
+  /// 4-byte unsigned value\r
   ///\r
-  typedef uint16_t  UINT16;\r
+  typedef unsigned int        UINT32;\r
   ///\r
   /// 4-byte signed value\r
   ///\r
-  typedef int32_t   INT32;\r
+  typedef int                 INT32;\r
   ///\r
-  /// 4-byte unsigned value\r
+  /// 2-byte unsigned value\r
   ///\r
-  typedef uint32_t  UINT32;\r
+  typedef unsigned short      UINT16;\r
   ///\r
-  /// 8-byte signed value\r
+  /// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
+  /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
   ///\r
-  typedef int64_t   INT64;\r
+  typedef unsigned short      CHAR16;\r
   ///\r
-  /// 8-byte unsigned value\r
+  /// 2-byte signed value\r
   ///\r
-  typedef uint64_t  UINT64;\r
+  typedef short               INT16;\r
+  ///\r
+  /// Logical Boolean.  1-byte value containing 0 for FALSE or a 1 for TRUE.  Other\r
+  /// values are undefined.\r
+  ///\r
+  typedef unsigned char       BOOLEAN;\r
+  ///\r
+  /// 1-byte unsigned value\r
+  ///\r
+  typedef unsigned char       UINT8;\r
   ///\r
   /// 1-byte Character\r
   ///\r
-  typedef char      CHAR8;\r
+  typedef char                CHAR8;\r
   ///\r
-  /// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
-  /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
+  /// 1-byte signed value\r
   ///\r
-  typedef uint16_t  CHAR16;\r
-\r
+  typedef signed char         INT8;\r
 #endif\r
 \r
 ///\r
@@ -338,11 +254,33 @@ typedef INT64   INTN;
 ///\r
 #define MAX_ADDRESS   0xFFFFFFFFFFFFFFFFULL\r
 \r
+///\r
+/// Maximum usable address at boot time\r
+///\r
+#define MAX_ALLOC_ADDRESS   MAX_ADDRESS\r
+\r
+///\r
+/// Maximum legal x64 INTN and UINTN values.\r
+///\r
+#define MAX_INTN   ((INTN)0x7FFFFFFFFFFFFFFFULL)\r
+#define MAX_UINTN  ((UINTN)0xFFFFFFFFFFFFFFFFULL)\r
+\r
+///\r
+/// Minimum legal x64 INTN value.\r
+///\r
+#define MIN_INTN   (((INTN)-9223372036854775807LL) - 1)\r
+\r
 ///\r
 /// The stack alignment required for x64\r
 ///\r
 #define CPU_STACK_ALIGNMENT   16\r
 \r
+///\r
+/// Page allocation granularity for x64\r
+///\r
+#define DEFAULT_PAGE_ALLOCATION_GRANULARITY   (0x1000)\r
+#define RUNTIME_PAGE_ALLOCATION_GRANULARITY   (0x1000)\r
+\r
 //\r
 // Modifier to ensure that all protocol member functions and EFI intrinsics\r
 // use the correct C calling convention. All protocol member functions and\r
@@ -354,75 +292,50 @@ typedef INT64   INTN;
   ///\r
 #elif defined(_MSC_EXTENSIONS)\r
   ///\r
-  /// Microsoft* compiler specific method for EFIAPI calling convension\r
-  /// \r
-  #define EFIAPI __cdecl  \r
+  /// Microsoft* compiler specific method for EFIAPI calling convention.\r
+  ///\r
+  #define EFIAPI __cdecl\r
 #elif defined(__GNUC__)\r
   ///\r
-  /// Define the standard calling convention reguardless of optimization level.\r
+  /// Define the standard calling convention regardless of optimization level.\r
   /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI\r
-  /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64) \r
-  /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for \r
-  /// x64. Warning the assembly code in the MDE x64 does not follow the correct \r
+  /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64)\r
+  /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for\r
+  /// x64. Warning the assembly code in the MDE x64 does not follow the correct\r
   /// ABI for the standard x64 (x86-64) GCC.\r
   ///\r
-  #define EFIAPI \r
+  #define EFIAPI\r
 #else\r
   ///\r
   /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI\r
-  /// is the standard. \r
+  /// is the standard.\r
   ///\r
-  #define EFIAPI       \r
+  #define EFIAPI\r
 #endif\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)\r
+#if defined(__GNUC__) || defined(__clang__)\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
+  /// For GNU assembly code, .global or .globl can declare global symbols.\r
+  /// Define this macro to unify the usage.\r
   ///\r
-  ///\r
-  #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r
-#else\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\r
-#endif\r
-\r
-//\r
-// For symbol name in GNU assembly code, an extra "_" is necessary\r
-//\r
-#if defined(__GNUC__)\r
-  #if defined(linux)\r
-    #define ASM_PFX(name) name\r
-  #else\r
-    #define ASM_PFX(name) _##name\r
-  #endif  \r
-  #if defined(__APPLE__)\r
-    #define ASM_GLOBAL .globl\r
-  #else\r
-    #define ASM_GLOBAL .global\r
-  #endif \r
+  #define ASM_GLOBAL .globl\r
 #endif\r
 \r
 /**\r
   Return the pointer to the first instruction of a function given a function pointer.\r
-  On x64 CPU architectures, these two pointer values are the same, \r
+  On x64 CPU architectures, these two pointer values are the same,\r
   so the implementation of this macro is very simple.\r
-  \r
+\r
   @param  FunctionPointer   A pointer to a function.\r
 \r
   @return The pointer to the first instruction of a function given a function pointer.\r
-  \r
+\r
 **/\r
 #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)\r
 \r
+#ifndef __USER_LABEL_PREFIX__\r
+#define __USER_LABEL_PREFIX__\r
+#endif\r
+\r
 #endif\r
 \r