UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

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

diff --git a/MdePkg/Include/Library/UnitTestLib.h b/MdePkg/Include/Library/UnitTestLib.h
index 99175496c8cd1f0ef88156f6ba89ca73d99def7e..71c205b1b14352b6590745997756322a3665d39f 100644 (file)
--- a/MdePkg/Include/Library/UnitTestLib.h
+++ b/MdePkg/Include/Library/UnitTestLib.h
@@ -13,7 +13,7 @@
 ///\r
 /// Unit Test Status\r
 ///\r
-typedef UINT32  UNIT_TEST_STATUS;\r
+typedef UINT32 UNIT_TEST_STATUS;\r
 #define UNIT_TEST_PASSED                      (0)\r
 #define UNIT_TEST_ERROR_PREREQUISITE_NOT_MET  (1)\r
 #define UNIT_TEST_ERROR_TEST_FAILED           (2)\r
@@ -34,24 +34,24 @@ typedef UINT32  UNIT_TEST_STATUS;
 /// Unit Test Framework Handle\r
 ///\r
 struct UNIT_TEST_FRAMEWORK_OBJECT;\r
-typedef struct UNIT_TEST_FRAMEWORK_OBJECT  *UNIT_TEST_FRAMEWORK_HANDLE;\r
+typedef struct UNIT_TEST_FRAMEWORK_OBJECT *UNIT_TEST_FRAMEWORK_HANDLE;\r
 \r
 ///\r
 /// Unit Test Suite Handle\r
 ///\r
 struct UNIT_TEST_SUITE_OBJECT;\r
-typedef struct UNIT_TEST_SUITE_OBJECT  *UNIT_TEST_SUITE_HANDLE;\r
+typedef struct UNIT_TEST_SUITE_OBJECT *UNIT_TEST_SUITE_HANDLE;\r
 \r
 ///\r
 /// Unit Test Handle\r
 ///\r
 struct UNIT_TEST_OBJECT;\r
-typedef struct UNIT_TEST_OBJECT  *UNIT_TEST_HANDLE;\r
+typedef struct UNIT_TEST_OBJECT *UNIT_TEST_HANDLE;\r
 \r
 ///\r
 /// Unit Test Context\r
 ///\r
-typedef VOID*  UNIT_TEST_CONTEXT;\r
+typedef VOID *UNIT_TEST_CONTEXT;\r
 \r
 /**\r
   The prototype for a single UnitTest case function.\r
@@ -336,8 +336,8 @@ FreeUnitTestFramework (
 EFI_STATUS\r
 EFIAPI\r
 SaveFrameworkState (\r
-  IN UNIT_TEST_CONTEXT           ContextToSave     OPTIONAL,\r
-  IN UINTN                       ContextToSaveSize\r
+  IN UNIT_TEST_CONTEXT  ContextToSave     OPTIONAL,\r
+  IN UINTN              ContextToSaveSize\r
   );\r
 \r
 /**\r
@@ -347,9 +347,9 @@ SaveFrameworkState (
 \r
   @param[in]  Expression  Expression to be evaluated for TRUE.\r
 **/\r
-#define UT_ASSERT_TRUE(Expression)                                                        \\r
-  if(!UnitTestAssertTrue ((Expression), __FUNCTION__, __LINE__, __FILE__, #Expression)) { \\r
-    return UNIT_TEST_ERROR_TEST_FAILED;                                                   \\r
+#define UT_ASSERT_TRUE(Expression)                                                                 \\r
+  if(!UnitTestAssertTrue ((Expression), __FUNCTION__, DEBUG_LINE_NUMBER, __FILE__, #Expression)) { \\r
+    return UNIT_TEST_ERROR_TEST_FAILED;                                                            \\r
   }\r
 \r
 /**\r
@@ -359,9 +359,9 @@ SaveFrameworkState (
 \r
   @param[in]  Expression  Expression to be evaluated for FALSE.\r
 **/\r
-#define UT_ASSERT_FALSE(Expression)                                                        \\r
-  if(!UnitTestAssertFalse ((Expression), __FUNCTION__, __LINE__, __FILE__, #Expression)) { \\r
-    return UNIT_TEST_ERROR_TEST_FAILED;                                                    \\r
+#define UT_ASSERT_FALSE(Expression)                                                                 \\r
+  if(!UnitTestAssertFalse ((Expression), __FUNCTION__, DEBUG_LINE_NUMBER, __FILE__, #Expression)) { \\r
+    return UNIT_TEST_ERROR_TEST_FAILED;                                                             \\r
   }\r
 \r
 /**\r
@@ -373,7 +373,7 @@ SaveFrameworkState (
   @param[in]  ValueB  Value to be compared for equality (64-bit comparison).\r
 **/\r
 #define UT_ASSERT_EQUAL(ValueA, ValueB)                                                                           \\r
-  if(!UnitTestAssertEqual ((UINT64)(ValueA), (UINT64)(ValueB), __FUNCTION__, __LINE__, __FILE__, #ValueA, #ValueB)) { \\r
+  if(!UnitTestAssertEqual ((UINT64)(ValueA), (UINT64)(ValueB), __FUNCTION__, DEBUG_LINE_NUMBER, __FILE__, #ValueA, #ValueB)) { \\r
     return UNIT_TEST_ERROR_TEST_FAILED;                                                                           \\r
   }\r
 \r
@@ -386,9 +386,9 @@ SaveFrameworkState (
   @param[in]  BufferB  Pointer to a buffer for comparison.\r
   @param[in]  Length   Number of bytes to compare in BufferA and BufferB.\r
 **/\r
-#define UT_ASSERT_MEM_EQUAL(BufferA, BufferB, Length)                                                                               \\r
-  if(!UnitTestAssertMemEqual ((VOID *)(UINTN)(BufferA), (VOID *)(UINTN)(BufferB), (UINTN)Length, __FUNCTION__, __LINE__, __FILE__, #BufferA, #BufferB)) { \\r
-    return UNIT_TEST_ERROR_TEST_FAILED;                                                                                           \\r
+#define UT_ASSERT_MEM_EQUAL(BufferA, BufferB, Length)                                                                                                              \\r
+  if(!UnitTestAssertMemEqual ((VOID *)(UINTN)(BufferA), (VOID *)(UINTN)(BufferB), (UINTN)Length, __FUNCTION__, DEBUG_LINE_NUMBER, __FILE__, #BufferA, #BufferB)) { \\r
+    return UNIT_TEST_ERROR_TEST_FAILED;                                                                                                                            \\r
   }\r
 \r
 /**\r
@@ -399,9 +399,9 @@ SaveFrameworkState (
   @param[in]  ValueA  Value to be compared for inequality (64-bit comparison).\r
   @param[in]  ValueB  Value to be compared for inequality (64-bit comparison).\r
 **/\r
-#define UT_ASSERT_NOT_EQUAL(ValueA, ValueB)                                                                          \\r
-  if(!UnitTestAssertNotEqual ((UINT64)(ValueA), (UINT64)(ValueB), __FUNCTION__, __LINE__, __FILE__, #ValueA, #ValueB)) { \\r
-    return UNIT_TEST_ERROR_TEST_FAILED;                                                                              \\r
+#define UT_ASSERT_NOT_EQUAL(ValueA, ValueB)                                                                                       \\r
+  if(!UnitTestAssertNotEqual ((UINT64)(ValueA), (UINT64)(ValueB), __FUNCTION__, DEBUG_LINE_NUMBER, __FILE__, #ValueA, #ValueB)) { \\r
+    return UNIT_TEST_ERROR_TEST_FAILED;                                                                                           \\r
   }\r
 \r
 /**\r
@@ -411,9 +411,9 @@ SaveFrameworkState (
 \r
   @param[in]  Status  EFI_STATUS value to check.\r
 **/\r
-#define UT_ASSERT_NOT_EFI_ERROR(Status)                                                \\r
-  if(!UnitTestAssertNotEfiError ((Status), __FUNCTION__, __LINE__, __FILE__, #Status)) { \\r
-    return UNIT_TEST_ERROR_TEST_FAILED;                                                \\r
+#define UT_ASSERT_NOT_EFI_ERROR(Status)                                                           \\r
+  if(!UnitTestAssertNotEfiError ((Status), __FUNCTION__, DEBUG_LINE_NUMBER, __FILE__, #Status)) { \\r
+    return UNIT_TEST_ERROR_TEST_FAILED;                                                           \\r
   }\r
 \r
 /**\r
@@ -424,9 +424,9 @@ SaveFrameworkState (
   @param[in]  Status    EFI_STATUS values to compare for equality.\r
   @param[in]  Expected  EFI_STATUS values to compare for equality.\r
 **/\r
-#define UT_ASSERT_STATUS_EQUAL(Status, Expected)                                                 \\r
-  if(!UnitTestAssertStatusEqual ((Status), (Expected), __FUNCTION__, __LINE__, __FILE__, #Status)) { \\r
-    return UNIT_TEST_ERROR_TEST_FAILED;                                                          \\r
+#define UT_ASSERT_STATUS_EQUAL(Status, Expected)                                                              \\r
+  if(!UnitTestAssertStatusEqual ((Status), (Expected), __FUNCTION__, DEBUG_LINE_NUMBER, __FILE__, #Status)) { \\r
+    return UNIT_TEST_ERROR_TEST_FAILED;                                                                       \\r
   }\r
 \r
 /**\r
@@ -436,9 +436,9 @@ SaveFrameworkState (
 \r
   @param[in]  Pointer  Pointer to be checked against NULL.\r
 **/\r
-#define UT_ASSERT_NOT_NULL(Pointer)                                                  \\r
-  if(!UnitTestAssertNotNull ((Pointer), __FUNCTION__, __LINE__, __FILE__, #Pointer)) { \\r
-    return UNIT_TEST_ERROR_TEST_FAILED;                                              \\r
+#define UT_ASSERT_NOT_NULL(Pointer)                                                             \\r
+  if(!UnitTestAssertNotNull ((Pointer), __FUNCTION__, DEBUG_LINE_NUMBER, __FILE__, #Pointer)) { \\r
+    return UNIT_TEST_ERROR_TEST_FAILED;                                                         \\r
   }\r
 \r
 /**\r
@@ -459,13 +459,13 @@ SaveFrameworkState (
 #if defined (EDKII_UNIT_TEST_FRAMEWORK_ENABLED)\r
   #include <Library/BaseLib.h>\r
 \r
-  ///\r
-  /// Pointer to jump buffer used with SetJump()/LongJump() to test if a\r
-  /// function under test generates an expected ASSERT() condition.\r
-  ///\r
-  extern BASE_LIBRARY_JUMP_BUFFER  *gUnitTestExpectAssertFailureJumpBuffer;\r
+///\r
+/// Pointer to jump buffer used with SetJump()/LongJump() to test if a\r
+/// function under test generates an expected ASSERT() condition.\r
+///\r
+extern BASE_LIBRARY_JUMP_BUFFER  *gUnitTestExpectAssertFailureJumpBuffer;\r
 \r
-  #define UT_EXPECT_ASSERT_FAILURE(FunctionCall, Status)               \\r
+#define UT_EXPECT_ASSERT_FAILURE(FunctionCall, Status)               \\r
     do {                                                               \\r
       UNIT_TEST_STATUS          UnitTestJumpStatus;                    \\r
       BASE_LIBRARY_JUMP_BUFFER  UnitTestJumpBuffer;                    \\r
@@ -482,13 +482,13 @@ SaveFrameworkState (
       }                                                                \\r
       if (!UnitTestExpectAssertFailure (                               \\r
              UnitTestJumpStatus,                                       \\r
-             __FUNCTION__, __LINE__, __FILE__,                         \\r
+             __FUNCTION__, DEBUG_LINE_NUMBER, __FILE__,                \\r
              #FunctionCall, Status)) {                                 \\r
         return UNIT_TEST_ERROR_TEST_FAILED;                            \\r
       }                                                                \\r
     } while (FALSE)\r
 #else\r
-  #define UT_EXPECT_ASSERT_FAILURE(FunctionCall, Status)  FunctionCall;\r
+#define UT_EXPECT_ASSERT_FAILURE(FunctionCall, Status)  FunctionCall;\r
 #endif\r
 \r
 /**\r