MdePkg/BaseLib: add PatchInstructionX86()

[mirror_edk2.git] / MdePkg / Include / Library / DebugLib.h

diff --git a/MdePkg/Include/Library/DebugLib.h b/MdePkg/Include/Library/DebugLib.h
index f969ce23178753533cb7914d7697023f03fff11d..3a910e6a208b71d57786fa2685aa49d641044cec 100644 (file)
--- a/MdePkg/Include/Library/DebugLib.h
+++ b/MdePkg/Include/Library/DebugLib.h
@@ -8,7 +8,7 @@
   of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is\r
   defined, then debug and assert related macros wrapped by it are the NULL implementations.\r
 \r
-Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -39,20 +39,21 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define DEBUG_WARN      0x00000002  // Warnings\r
 #define DEBUG_LOAD      0x00000004  // Load events\r
 #define DEBUG_FS        0x00000008  // EFI File system\r
-#define DEBUG_POOL      0x00000010  // Alloc & Free's\r
-#define DEBUG_PAGE      0x00000020  // Alloc & Free's\r
+#define DEBUG_POOL      0x00000010  // Alloc & Free (pool)\r
+#define DEBUG_PAGE      0x00000020  // Alloc & Free (page)\r
 #define DEBUG_INFO      0x00000040  // Informational debug messages\r
 #define DEBUG_DISPATCH  0x00000080  // PEI/DXE/SMM Dispatchers\r
 #define DEBUG_VARIABLE  0x00000100  // Variable\r
 #define DEBUG_BM        0x00000400  // Boot Manager\r
 #define DEBUG_BLKIO     0x00001000  // BlkIo Driver\r
-#define DEBUG_NET       0x00004000  // SNI Driver\r
+#define DEBUG_NET       0x00004000  // Network Io Driver\r
 #define DEBUG_UNDI      0x00010000  // UNDI Driver\r
-#define DEBUG_LOADFILE  0x00020000  // UNDI Driver\r
+#define DEBUG_LOADFILE  0x00020000  // LoadFile\r
 #define DEBUG_EVENT     0x00080000  // Event messages\r
 #define DEBUG_GCD       0x00100000  // Global Coherency Database changes\r
 #define DEBUG_CACHE     0x00200000  // Memory range cachability changes\r
-#define DEBUG_VERBOSE   0x00400000  // Detailed debug messages that may significantly impact boot performance\r
+#define DEBUG_VERBOSE   0x00400000  // Detailed debug messages that may\r
+                                    // significantly impact boot performance\r
 #define DEBUG_ERROR     0x80000000  // Error\r
 \r
 //\r
@@ -220,6 +221,20 @@ DebugClearMemoryEnabled (
   VOID\r
   );\r
 \r
+/**\r
+  Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
+\r
+  This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
+\r
+  @retval  TRUE    Current ErrorLevel is supported.\r
+  @retval  FALSE   Current ErrorLevel is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DebugPrintLevelEnabled (\r
+  IN  CONST UINTN        ErrorLevel\r
+  );\r
 \r
 /**  \r
   Internal worker macro that calls DebugAssert().\r
@@ -238,13 +253,25 @@ DebugClearMemoryEnabled (
 \r
   This macro calls DebugPrint() passing in the debug error level, a format \r
   string, and a variable argument list.\r
+  __VA_ARGS__ is not supported by EBC compiler, Microsoft Visual Studio .NET 2003\r
+  and Microsoft Windows Server 2003 Driver Development Kit (Microsoft WINDDK) version 3790.1830.\r
 \r
   @param  Expression  Expression containing an error level, a format string, \r
                       and a variable argument list based on the format string.\r
 \r
 **/\r
-#define _DEBUG(Expression)   DebugPrint Expression\r
 \r
+#if !defined(MDE_CPU_EBC) && (!defined (_MSC_VER) || _MSC_VER > 1400)\r
+  #define _DEBUG_PRINT(PrintLevel, ...)              \\r
+    do {                                             \\r
+      if (DebugPrintLevelEnabled (PrintLevel)) {     \\r
+        DebugPrint (PrintLevel, ##__VA_ARGS__);      \\r
+      }                                              \\r
+    } while (FALSE)\r
+  #define _DEBUG(Expression)   _DEBUG_PRINT Expression\r
+#else\r
+#define _DEBUG(Expression)   DebugPrint Expression\r
+#endif\r
 \r
 /**  \r
   Macro that calls DebugAssert() if an expression evaluates to FALSE.\r
@@ -264,6 +291,7 @@ DebugClearMemoryEnabled (
       if (DebugAssertEnabled ()) {  \\r
         if (!(Expression)) {        \\r
           _ASSERT (Expression);     \\r
+          ANALYZER_UNREACHABLE ();  \\r
         }                           \\r
       }                             \\r
     } while (FALSE)\r
@@ -320,6 +348,33 @@ DebugClearMemoryEnabled (
   #define ASSERT_EFI_ERROR(StatusParameter)\r
 #endif\r
 \r
+/**\r
+  Macro that calls DebugAssert() if a RETURN_STATUS evaluates to an error code.\r
+\r
+  If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED\r
+  bit of PcdDebugProperyMask is set, then this macro evaluates the\r
+  RETURN_STATUS value specified by StatusParameter.  If StatusParameter is an\r
+  error code, then DebugAssert() is called passing in the source filename,\r
+  source line number, and StatusParameter.\r
+\r
+  @param  StatusParameter  RETURN_STATUS value to evaluate.\r
+\r
+**/\r
+#if !defined(MDEPKG_NDEBUG)\r
+  #define ASSERT_RETURN_ERROR(StatusParameter)                          \\r
+    do {                                                                \\r
+      if (DebugAssertEnabled ()) {                                      \\r
+        if (RETURN_ERROR (StatusParameter)) {                           \\r
+          DEBUG ((DEBUG_ERROR, "\nASSERT_RETURN_ERROR (Status = %r)\n", \\r
+            StatusParameter));                                          \\r
+          _ASSERT (!RETURN_ERROR (StatusParameter));                    \\r
+        }                                                               \\r
+      }                                                                 \\r
+    } while (FALSE)\r
+#else\r
+  #define ASSERT_RETURN_ERROR(StatusParameter)\r
+#endif\r
+\r
 /**  \r
   Macro that calls DebugAssert() if a protocol is already installed in the \r
   handle database.\r