Changeset 108794 in vbox for trunk/src/VBox/Devices/EFI/FirmwareNew/UnitTestFrameworkPkg/Library

Timestamp:

Mar 31, 2025 11:31:09 AM (5 weeks ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

168237

Message:

Devices/EFI/FirmwareNew: Merge edk2-stable202502 from the vendor branch and make it build for the important platforms, bugref:4643

Location:

trunk/src/VBox/Devices/EFI/FirmwareNew

Files:

• . (modified) (1 prop)
• UnitTestFrameworkPkg/Library/GoogleTestLib/GoogleTestLib.inf (modified) (1 diff)
• UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/AllocateBelowAddress.c (added)
• UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c (modified) (10 diffs)
• UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.inf (modified) (1 diff)
• UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/WinInclude.h (added)
• UnitTestFrameworkPkg/Library/UnitTestDebugAssertLib/UnitTestDebugAssertLibHost.cpp (modified) (2 diffs)
• UnitTestFrameworkPkg/Library/UnitTestDebugAssertLib/UnitTestDebugAssertLibHost.inf (modified) (1 diff)
• UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c (modified) (2 diffs)
• UnitTestFrameworkPkg/Library/UnitTestLib/AssertCmocka.c (modified) (1 diff)
• UnitTestFrameworkPkg/Library/UnitTestLib/Log.c (modified) (3 diffs)
• UnitTestFrameworkPkg/Library/UnitTestLib/RunTestsCmocka.c (modified) (1 diff)
• UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c (modified) (4 diffs)

trunk/src/VBox/Devices/EFI/FirmwareNew/UnitTestFrameworkPkg/Library/GoogleTestLib/GoogleTestLib.inf

@@ -29 +29 @@
 
 [BuildOptions]
-  MSFT:*_*_*_CC_FLAGS   == /c /EHs /Zi /Od /MT
+  MSFT:*_*_*_CC_FLAGS   == /c /EHs /Zi /Od /MTd
   GCC:*_*_IA32_CC_FLAGS == -g -c -fshort-wchar -fexceptions -O0 -m32 -malign-double -fno-pie
   GCC:*_*_X64_CC_FLAGS  == -g -c -fshort-wchar -fexceptions -O0 -m64 -fno-pie "-DEFIAPI=__attribute__((ms_abi))"

trunk/src/VBox/Devices/EFI/FirmwareNew/UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c

@@ -28 +28 @@
 typedef struct {
   UINT32    Signature;
-  VOID      *AllocatedBufffer;
+  VOID      *AllocatedBuffer;
   UINTN     TotalPages;
   VOID      *AlignedBuffer;
@@ -34 +34 @@
 } PAGE_HEAD;
 
+#define POOL_HEAD_PRIVATE_SIGNATURE  SIGNATURE_32 ('P', 'O', 'H', 'D')
+
+typedef struct {
+  UINT32    Signature;
+  UINT32    TotalSize;
+} POOL_HEAD;
+
 /**
   Allocates one or more 4KB pages of type EfiBootServicesData.
@@ -166 +173 @@
   // We need reserve Alignment pages for PAGE_HEAD, as meta data.
   //
-  PageHead.Signature        = PAGE_HEAD_PRIVATE_SIGNATURE;
-  PageHead.TotalPages       = Pages + EFI_SIZE_TO_PAGES (Alignment) * 2;
-  PageHead.AlignedPages     = Pages;
-  PageHead.AllocatedBufffer = malloc (EFI_PAGES_TO_SIZE (PageHead.TotalPages));
-  if (PageHead.AllocatedBufffer == NULL) {
-    return NULL;
-  }
-
-  PageHead.AlignedBuffer = (VOID *)(((UINTN)PageHead.AllocatedBufffer + AlignmentMask) & ~AlignmentMask);
-  if ((UINTN)PageHead.AlignedBuffer - (UINTN)PageHead.AllocatedBufffer < sizeof (PAGE_HEAD)) {
+  PageHead.Signature       = PAGE_HEAD_PRIVATE_SIGNATURE;
+  PageHead.TotalPages      = Pages + EFI_SIZE_TO_PAGES (Alignment) * 2;
+  PageHead.AlignedPages    = Pages;
+  PageHead.AllocatedBuffer = malloc (EFI_PAGES_TO_SIZE (PageHead.TotalPages));
+
+  ASSERT (PageHead.AllocatedBuffer != NULL);
+
+  DEBUG_CLEAR_MEMORY (PageHead.AllocatedBuffer, EFI_PAGES_TO_SIZE (PageHead.TotalPages));
+
+  PageHead.AlignedBuffer = (VOID *)(((UINTN)PageHead.AllocatedBuffer + AlignmentMask) & ~AlignmentMask);
+  if ((UINTN)PageHead.AlignedBuffer - (UINTN)PageHead.AllocatedBuffer < sizeof (PAGE_HEAD)) {
     PageHead.AlignedBuffer = (VOID *)((UINTN)PageHead.AlignedBuffer + Alignment);
   }
@@ -266 +274 @@
 {
   PAGE_HEAD  *PageHeadPtr;
-
-  //
-  // NOTE: Partial free is not supported. Just keep it.
-  //
-  PageHeadPtr = (VOID *)((UINTN)Buffer - sizeof (PAGE_HEAD));
-  if (PageHeadPtr->Signature != PAGE_HEAD_PRIVATE_SIGNATURE) {
-    return;
-  }
-
-  if (PageHeadPtr->AlignedPages != Pages) {
-    return;
-  }
-
-  PageHeadPtr->Signature = 0;
-  free (PageHeadPtr->AllocatedBufffer);
+  VOID       *AllocatedBuffer;
+  UINTN      Length;
+
+  ASSERT (Buffer != NULL);
+
+  PageHeadPtr = ((PAGE_HEAD *)Buffer) - 1;
+
+  ASSERT (PageHeadPtr != NULL);
+  ASSERT (PageHeadPtr->Signature == PAGE_HEAD_PRIVATE_SIGNATURE);
+  ASSERT (PageHeadPtr->AlignedPages == Pages);
+  ASSERT (PageHeadPtr->AllocatedBuffer != NULL);
+
+  AllocatedBuffer = PageHeadPtr->AllocatedBuffer;
+  Length          = EFI_PAGES_TO_SIZE (PageHeadPtr->TotalPages);
+
+  DEBUG_CLEAR_MEMORY (AllocatedBuffer, Length);
+
+  free (AllocatedBuffer);
 }
 
@@ -294 +305 @@
   @return  A pointer to the allocated buffer or NULL if allocation fails.
 
-**/VOID *
+**/
+VOID *
 EFIAPI
 AllocatePool (
@@ -300 +312 @@
   )
 {
-  return malloc (AllocationSize);
+  POOL_HEAD  *PoolHead;
+  UINTN      TotalSize;
+
+  TotalSize = sizeof (POOL_HEAD) + AllocationSize;
+  PoolHead  = malloc (TotalSize);
+  if (PoolHead == NULL) {
+    return NULL;
+  }
+
+  DEBUG_CLEAR_MEMORY (PoolHead, TotalSize);
+  PoolHead->Signature = POOL_HEAD_PRIVATE_SIGNATURE;
+  PoolHead->TotalSize = (UINT32)TotalSize;
+
+  return (VOID *)(PoolHead + 1);
 }
 
@@ -366 +391 @@
   VOID  *Buffer;
 
-  Buffer = malloc (AllocationSize);
+  Buffer = AllocatePool (AllocationSize);
   if (Buffer == NULL) {
     return NULL;
@@ -445 +470 @@
   VOID  *Memory;
 
-  Memory = malloc (AllocationSize);
+  Memory = AllocatePool (AllocationSize);
   if (Memory == NULL) {
     return NULL;
@@ -539 +564 @@
   VOID  *NewBuffer;
 
-  NewBuffer = malloc (NewSize);
+  NewBuffer = AllocatePool (NewSize);
   if ((NewBuffer != NULL) && (OldBuffer != NULL)) {
     memcpy (NewBuffer, OldBuffer, MIN (OldSize, NewSize));
@@ -635 +660 @@
   )
 {
-  free (Buffer);
-}
+  POOL_HEAD  *PoolHead;
+
+  ASSERT (Buffer != NULL);
+
+  PoolHead = ((POOL_HEAD *)Buffer) - 1;
+
+  ASSERT (PoolHead != NULL);
+  ASSERT (PoolHead->Signature == POOL_HEAD_PRIVATE_SIGNATURE);
+  ASSERT (PoolHead->TotalSize >= sizeof (POOL_HEAD));
+
+  DEBUG_CLEAR_MEMORY (PoolHead, PoolHead->TotalSize);
+  free (PoolHead);
+}

trunk/src/VBox/Devices/EFI/FirmwareNew/UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.inf

@@ -17 +17 @@
   VERSION_STRING  = 1.0
   LIBRARY_CLASS   = MemoryAllocationLib|HOST_APPLICATION
+  LIBRARY_CLASS   = HostMemoryAllocationBelowAddressLib|HOST_APPLICATION
 
 [Sources]
   MemoryAllocationLibPosix.c
+  AllocateBelowAddress.c
+  WinInclude.h
 
 [Packages]
   MdePkg/MdePkg.dec
+  UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec
 
 [LibraryClasses]
-  BaseLib
+  DebugLib

trunk/src/VBox/Devices/EFI/FirmwareNew/UnitTestFrameworkPkg/Library/UnitTestDebugAssertLib/UnitTestDebugAssertLibHost.cpp

@@ -18 +18 @@
   #include <Library/BaseLib.h>
   #include <Library/UnitTestLib.h>
+
+  //
+  // If address sanitizer is enabled, then declare the function that is used to
+  // handle custom long jump implementation.
+  //
+ #ifdef __SANITIZE_ADDRESS__
+  void
+  __asan_handle_no_return (
+    );
+
+ #endif
 
   ///
@@ -48 +59 @@
     if (gUnitTestExpectAssertFailureJumpBuffer != NULL) {
       UT_LOG_INFO ("Detected expected ASSERT: %a(%d): %a\n", FileName, LineNumber, Description);
+
+      //
+      // If address sanitizer is enabled, then inform sanitizer that a no return
+      // function is being called that will reset to a previous stack frame.
+      // This is required to avoid false positives from the address sanitizer
+      // due to the use of a custom long jump implementation.
+      //
+ #ifdef __SANITIZE_ADDRESS__
+      __asan_handle_no_return ();
+ #endif
+
       LongJump (gUnitTestExpectAssertFailureJumpBuffer, 1);
     } else {

trunk/src/VBox/Devices/EFI/FirmwareNew/UnitTestFrameworkPkg/Library/UnitTestDebugAssertLib/UnitTestDebugAssertLibHost.inf

@@ -32 +32 @@
 
 [BuildOptions]
-  MSFT:*_*_*_CC_FLAGS   == /c /EHs /Zi /Od /MT
+  MSFT:*_*_*_CC_FLAGS   == /c /EHs /Zi /Od /MTd
   GCC:*_*_IA32_CC_FLAGS == -g -c -fshort-wchar -fexceptions -O0 -m32 -malign-double -fno-pie
   GCC:*_*_X64_CC_FLAGS  == -g -c -fshort-wchar -fexceptions -O0 -m64 -fno-pie "-DEFIAPI=__attribute__((ms_abi))"

trunk/src/VBox/Devices/EFI/FirmwareNew/UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c

@@ -34 +34 @@
   AsciiStrCpyS (
     &UnitTest->FailureMessage[0],
-    UNIT_TEST_TESTFAILUREMSG_LENGTH,
+    UNIT_TEST_MAX_STRING_LENGTH,
     FailureMessage
     );
@@ -51 +51 @@
 {
   UNIT_TEST_FRAMEWORK_HANDLE  FrameworkHandle;
-  CHAR8                       LogString[UNIT_TEST_TESTFAILUREMSG_LENGTH];
+  CHAR8                       LogString[UNIT_TEST_MAX_STRING_LENGTH];
   VA_LIST                     Marker;
 

trunk/src/VBox/Devices/EFI/FirmwareNew/UnitTestFrameworkPkg/Library/UnitTestLib/AssertCmocka.c

@@ -382 +382 @@
 
   if (UnitTestStatus == UNIT_TEST_PASSED) {
-    UT_LOG_INFO (
-      "[ASSERT PASS] %a:%d: UT_EXPECT_ASSERT_FAILURE(%a) detected expected assert\n",
+    snprintf (
+      TempStr,
+      sizeof (TempStr),
+      "[ASSERT PASS] %s:%d: UT_EXPECT_ASSERT_FAILURE(%s) detected expected assert\n",
       FileName,
-      LineNumber,
+      (int)LineNumber,
       FunctionCall
       );
+    UT_LOG_INFO (TempStr);
   }
 
   if (UnitTestStatus == UNIT_TEST_SKIPPED) {
-    UT_LOG_WARNING (
-      "[ASSERT WARN] %a:%d: UT_EXPECT_ASSERT_FAILURE(%a) disabled\n",
+    snprintf (
+      TempStr,
+      sizeof (TempStr),
+      "[ASSERT WARN] %s:%d: UT_EXPECT_ASSERT_FAILURE(%s) disabled\n",
       FileName,
-      LineNumber,
+      (int)LineNumber,
       FunctionCall
       );
+    UT_LOG_WARNING (TempStr);
   }
 

trunk/src/VBox/Devices/EFI/FirmwareNew/UnitTestFrameworkPkg/Library/UnitTestLib/Log.c

@@ -16 +16 @@
 #include <Library/PcdLib.h>
 
-#define UNIT_TEST_MAX_SINGLE_LOG_STRING_LENGTH  (512)
-#define UNIT_TEST_MAX_LOG_BUFFER                SIZE_16KB
+#define UNIT_TEST_MAX_LOG_BUFFER  SIZE_16KB
 
 struct _UNIT_TEST_LOG_PREFIX_STRING {
@@ -86 +85 @@
              UNIT_TEST_MAX_LOG_BUFFER / sizeof (CHAR8),
              String,
-             UNIT_TEST_MAX_SINGLE_LOG_STRING_LENGTH
+             UNIT_TEST_MAX_STRING_LENGTH
              );
   if (EFI_ERROR (Status)) {
@@ -161 +160 @@
 {
   UNIT_TEST_FRAMEWORK_HANDLE  FrameworkHandle;
-  CHAR8                       NewFormatString[UNIT_TEST_MAX_SINGLE_LOG_STRING_LENGTH];
-  CHAR8                       LogString[UNIT_TEST_MAX_SINGLE_LOG_STRING_LENGTH];
+  CHAR8                       NewFormatString[UNIT_TEST_MAX_STRING_LENGTH];
+  CHAR8                       LogString[UNIT_TEST_MAX_STRING_LENGTH];
   CONST CHAR8                 *LogTypePrefix;
   VA_LIST                     Marker;

trunk/src/VBox/Devices/EFI/FirmwareNew/UnitTestFrameworkPkg/Library/UnitTestLib/RunTestsCmocka.c

@@ -112 +112 @@
   //
   if (UnitTest->Log != NULL) {
-    print_message ("UnitTest: %s - %s\n", UnitTest->Name, UnitTest->Description);
-    print_message ("Log Output Start\n");
-    print_message ("%s", UnitTest->Log);
-    print_message ("Log Output End\n");
+    //
+    // UnitTest->Log can be a large buffer that is larger than what DEBUG()
+    // can support. Use printf() directly.
+    //
+    printf ("UnitTest: %s - %s\n", UnitTest->Name, UnitTest->Description);
+    printf ("Log Output Start\n");
+    printf (UnitTest->Log);
+    printf ("Log Output End\n");
   }
 

trunk/src/VBox/Devices/EFI/FirmwareNew/UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c

@@ -132 +132 @@
 }
 
+STATIC
+VOID
+FreeUnitTestTestEntry (
+  IN UNIT_TEST_LIST_ENTRY  *TestEntry
+  )
+{
+  if (TestEntry) {
+    if (TestEntry->UT.Description) {
+      FreePool (TestEntry->UT.Description);
+    }
+
+    if (TestEntry->UT.Name) {
+      FreePool (TestEntry->UT.Name);
+    }
+
+    FreePool (TestEntry);
+  }
+}
+
+STATIC
+EFI_STATUS
+FreeUnitTestSuiteEntry (
+  IN UNIT_TEST_SUITE_LIST_ENTRY  *SuiteEntry
+  )
+{
+  UNIT_TEST_LIST_ENTRY  *TestCase;
+  UNIT_TEST_LIST_ENTRY  *NextTestCase;
+  LIST_ENTRY            *TestCaseList;
+
+  if (SuiteEntry) {
+    TestCaseList = &(SuiteEntry->UTS.TestCaseList);
+    TestCase     = (UNIT_TEST_LIST_ENTRY *)GetFirstNode (TestCaseList);
+    while (&TestCase->Entry != TestCaseList) {
+      NextTestCase = (UNIT_TEST_LIST_ENTRY *)GetNextNode (TestCaseList, &TestCase->Entry);
+      RemoveEntryList (&TestCase->Entry);
+      FreeUnitTestTestEntry (TestCase);
+      TestCase = NextTestCase;
+    }
+
+    if (SuiteEntry->UTS.Title) {
+      FreePool (SuiteEntry->UTS.Title);
+    }
+
+    if (SuiteEntry->UTS.Name) {
+      FreePool (SuiteEntry->UTS.Name);
+    }
+
+    FreePool (SuiteEntry);
+  }
+
+  return EFI_SUCCESS;
+}
+
 /**
   Cleanup a test framework.
@@ -152 +205 @@
   )
 {
-  // TODO: Finish this function.
-  return EFI_SUCCESS;
-}
-
-STATIC
-EFI_STATUS
-FreeUnitTestSuiteEntry (
-  IN UNIT_TEST_SUITE_LIST_ENTRY  *SuiteEntry
-  )
-{
-  // TODO: Finish this function.
-  return EFI_SUCCESS;
-}
-
-STATIC
-EFI_STATUS
-FreeUnitTestTestEntry (
-  IN UNIT_TEST_LIST_ENTRY  *TestEntry
-  )
-{
-  // TODO: Finish this function.
+  UNIT_TEST_FRAMEWORK         *Framework;
+  UNIT_TEST_SUITE_LIST_ENTRY  *Suite;
+  UNIT_TEST_SUITE_LIST_ENTRY  *NextSuite;
+
+  Framework = (UNIT_TEST_FRAMEWORK *)FrameworkHandle;
+  if (Framework) {
+    Suite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetFirstNode (&Framework->TestSuiteList);
+    while ((LIST_ENTRY *)Suite != &Framework->TestSuiteList) {
+      NextSuite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetNextNode (&Framework->TestSuiteList, (LIST_ENTRY *)Suite);
+      RemoveEntryList ((LIST_ENTRY *)Suite);
+      FreeUnitTestSuiteEntry (Suite);
+      Suite = NextSuite;
+    }
+
+    if (Framework->Title) {
+      FreePool (Framework->Title);
+    }
+
+    if (Framework->ShortTitle) {
+      FreePool (Framework->ShortTitle);
+    }
+
+    if (Framework->VersionString) {
+      FreePool (Framework->VersionString);
+    }
+
+    FreePool (Framework);
+  }
+
   return EFI_SUCCESS;
 }
@@ -572 +633 @@
     AsciiStrnCpyS (
       &Test->FailureMessage[0],
-      UNIT_TEST_TESTFAILUREMSG_LENGTH,
+      UNIT_TEST_MAX_STRING_LENGTH,
       &MatchingTest->FailureMessage[0],
-      UNIT_TEST_TESTFAILUREMSG_LENGTH
+      UNIT_TEST_MAX_STRING_LENGTH
       );
 
@@ -749 +810 @@
       TestSaveData->Result      = UnitTest->Result;
       TestSaveData->FailureType = UnitTest->FailureType;
-      AsciiStrnCpyS (&TestSaveData->FailureMessage[0], UNIT_TEST_TESTFAILUREMSG_LENGTH, &UnitTest->FailureMessage[0], UNIT_TEST_TESTFAILUREMSG_LENGTH);
+      AsciiStrnCpyS (&TestSaveData->FailureMessage[0], UNIT_TEST_MAX_STRING_LENGTH, &UnitTest->FailureMessage[0], UNIT_TEST_MAX_STRING_LENGTH);
 
       //