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 - 2012, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2017, 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
//\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
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
#endif\r
\r
//\r
-// For symbol name in GNU assembly code, an extra "_" is necessary\r
+// Should be used in combination with NORETURN to avoid 'noreturn' returns\r
+// warnings.\r
//\r
-#if defined(__GNUC__)\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
+#ifndef UNREACHABLE\r
+ #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 4)\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
+ #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
- /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix\r
- /// on symbols in assembly language.\r
- ///\r
- #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)\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
+#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
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
// UEFI specification claims 1 and 0. We are concerned about the\r
-// complier portability so we did it this way.\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 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_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(__GNUC__) && !defined(NO_BUILTIN_VA_FUNCS)\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
#define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)\r
\r
+#endif\r
+\r
#else\r
///\r
/// Variable used to traverse the list of arguments. This type can vary by\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 string contained one or more characters that\r
/// the device could not render and were skipped.\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
#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