#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/QemuFwCfgLib.h>\r
+#include <Library/QemuFwCfgS3Lib.h>\r
#include <Library/DxeServicesTableLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/OrderedCollectionLib.h>\r
}\r
\r
\r
+/**\r
+ Comparator function for two opaque pointers, ordering on (unsigned) pointer\r
+ value itself.\r
+ Can be used as both Key and UserStruct comparator.\r
+\r
+ @param[in] Pointer1 First pointer.\r
+\r
+ @param[in] Pointer2 Second pointer.\r
+\r
+ @retval <0 If Pointer1 compares less than Pointer2.\r
+\r
+ @retval 0 If Pointer1 compares equal to Pointer2.\r
+\r
+ @retval >0 If Pointer1 compares greater than Pointer2.\r
+**/\r
+STATIC\r
+INTN\r
+EFIAPI\r
+PointerCompare (\r
+ IN CONST VOID *Pointer1,\r
+ IN CONST VOID *Pointer2\r
+ )\r
+{\r
+ if (Pointer1 == Pointer2) {\r
+ return 0;\r
+ }\r
+ if ((UINTN)Pointer1 < (UINTN)Pointer2) {\r
+ return -1;\r
+ }\r
+ return 1;\r
+}\r
+\r
+\r
+/**\r
+ Comparator function for two ASCII strings. Can be used as both Key and\r
+ UserStruct comparator.\r
+\r
+ This function exists solely so we can avoid casting &AsciiStrCmp to\r
+ ORDERED_COLLECTION_USER_COMPARE and ORDERED_COLLECTION_KEY_COMPARE.\r
+\r
+ @param[in] AsciiString1 Pointer to the first ASCII string.\r
+\r
+ @param[in] AsciiString2 Pointer to the second ASCII string.\r
+\r
+ @return The return value of AsciiStrCmp (AsciiString1, AsciiString2).\r
+**/\r
+STATIC\r
+INTN\r
+EFIAPI\r
+AsciiStringCompare (\r
+ IN CONST VOID *AsciiString1,\r
+ IN CONST VOID *AsciiString2\r
+ )\r
+{\r
+ return AsciiStrCmp (AsciiString1, AsciiString2);\r
+}\r
+\r
+\r
+/**\r
+ Release the ORDERED_COLLECTION structure populated by\r
+ CollectAllocationsRestrictedTo32Bit() (below).\r
+\r
+ This function may be called by CollectAllocationsRestrictedTo32Bit() itself,\r
+ on the error path.\r
+\r
+ @param[in] AllocationsRestrictedTo32Bit The ORDERED_COLLECTION structure to\r
+ release.\r
+**/\r
+STATIC\r
+VOID\r
+ReleaseAllocationsRestrictedTo32Bit (\r
+ IN ORDERED_COLLECTION *AllocationsRestrictedTo32Bit\r
+)\r
+{\r
+ ORDERED_COLLECTION_ENTRY *Entry, *Entry2;\r
+\r
+ for (Entry = OrderedCollectionMin (AllocationsRestrictedTo32Bit);\r
+ Entry != NULL;\r
+ Entry = Entry2) {\r
+ Entry2 = OrderedCollectionNext (Entry);\r
+ OrderedCollectionDelete (AllocationsRestrictedTo32Bit, Entry, NULL);\r
+ }\r
+ OrderedCollectionUninit (AllocationsRestrictedTo32Bit);\r
+}\r
+\r
+\r
+/**\r
+ Iterate over the linker/loader script, and collect the names of the fw_cfg\r
+ blobs that are referenced by QEMU_LOADER_ADD_POINTER.PointeeFile fields, such\r
+ that QEMU_LOADER_ADD_POINTER.PointerSize is less than 8. This means that the\r
+ pointee blob's address will have to be patched into a narrower-than-8 byte\r
+ pointer field, hence the pointee blob must not be allocated from 64-bit\r
+ address space.\r
+\r
+ @param[out] AllocationsRestrictedTo32Bit The ORDERED_COLLECTION structure\r
+ linking (not copying / owning) such\r
+ QEMU_LOADER_ADD_POINTER.PointeeFile\r
+ fields that name the blobs\r
+ restricted from 64-bit allocation.\r
+\r
+ @param[in] LoaderStart Points to the first entry in the\r
+ linker/loader script.\r
+\r
+ @param[in] LoaderEnd Points one past the last entry in\r
+ the linker/loader script.\r
+\r
+ @retval EFI_SUCCESS AllocationsRestrictedTo32Bit has been\r
+ populated.\r
+\r
+ @retval EFI_OUT_OF_RESOURCES Memory allocation failed.\r
+\r
+ @retval EFI_PROTOCOL_ERROR Invalid linker/loader script contents.\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+CollectAllocationsRestrictedTo32Bit (\r
+ OUT ORDERED_COLLECTION **AllocationsRestrictedTo32Bit,\r
+ IN CONST QEMU_LOADER_ENTRY *LoaderStart,\r
+ IN CONST QEMU_LOADER_ENTRY *LoaderEnd\r
+)\r
+{\r
+ ORDERED_COLLECTION *Collection;\r
+ CONST QEMU_LOADER_ENTRY *LoaderEntry;\r
+ EFI_STATUS Status;\r
+\r
+ Collection = OrderedCollectionInit (AsciiStringCompare, AsciiStringCompare);\r
+ if (Collection == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ for (LoaderEntry = LoaderStart; LoaderEntry < LoaderEnd; ++LoaderEntry) {\r
+ CONST QEMU_LOADER_ADD_POINTER *AddPointer;\r
+\r
+ if (LoaderEntry->Type != QemuLoaderCmdAddPointer) {\r
+ continue;\r
+ }\r
+ AddPointer = &LoaderEntry->Command.AddPointer;\r
+\r
+ if (AddPointer->PointerSize >= 8) {\r
+ continue;\r
+ }\r
+\r
+ if (AddPointer->PointeeFile[QEMU_LOADER_FNAME_SIZE - 1] != '\0') {\r
+ DEBUG ((DEBUG_ERROR, "%a: malformed file name\n", __FUNCTION__));\r
+ Status = EFI_PROTOCOL_ERROR;\r
+ goto RollBack;\r
+ }\r
+\r
+ Status = OrderedCollectionInsert (\r
+ Collection,\r
+ NULL, // Entry\r
+ (VOID *)AddPointer->PointeeFile\r
+ );\r
+ switch (Status) {\r
+ case EFI_SUCCESS:\r
+ DEBUG ((\r
+ DEBUG_VERBOSE,\r
+ "%a: restricting blob \"%a\" from 64-bit allocation\n",\r
+ __FUNCTION__,\r
+ AddPointer->PointeeFile\r
+ ));\r
+ break;\r
+ case EFI_ALREADY_STARTED:\r
+ //\r
+ // The restriction has been recorded already.\r
+ //\r
+ break;\r
+ case EFI_OUT_OF_RESOURCES:\r
+ goto RollBack;\r
+ default:\r
+ ASSERT (FALSE);\r
+ }\r
+ }\r
+\r
+ *AllocationsRestrictedTo32Bit = Collection;\r
+ return EFI_SUCCESS;\r
+\r
+RollBack:\r
+ ReleaseAllocationsRestrictedTo32Bit (Collection);\r
+ return Status;\r
+}\r
+\r
+\r
/**\r
Process a QEMU_LOADER_ALLOCATE command.\r
\r
- @param[in] Allocate The QEMU_LOADER_ALLOCATE command to process.\r
+ @param[in] Allocate The QEMU_LOADER_ALLOCATE command to\r
+ process.\r
\r
- @param[in,out] Tracker The ORDERED_COLLECTION tracking the BLOB user\r
- structures created thus far.\r
+ @param[in,out] Tracker The ORDERED_COLLECTION tracking the\r
+ BLOB user structures created thus\r
+ far.\r
+\r
+ @param[in] AllocationsRestrictedTo32Bit The ORDERED_COLLECTION populated by\r
+ the function\r
+ CollectAllocationsRestrictedTo32Bit,\r
+ naming the fw_cfg blobs that must\r
+ not be allocated from 64-bit address\r
+ space.\r
\r
@retval EFI_SUCCESS An area of whole AcpiNVS pages has been\r
allocated for the blob contents, and the\r
EFIAPI\r
ProcessCmdAllocate (\r
IN CONST QEMU_LOADER_ALLOCATE *Allocate,\r
- IN OUT ORDERED_COLLECTION *Tracker\r
+ IN OUT ORDERED_COLLECTION *Tracker,\r
+ IN ORDERED_COLLECTION *AllocationsRestrictedTo32Bit\r
)\r
{\r
FIRMWARE_CONFIG_ITEM FwCfgItem;\r
}\r
\r
NumPages = EFI_SIZE_TO_PAGES (FwCfgSize);\r
- Address = 0xFFFFFFFF;\r
+ Address = MAX_UINT64;\r
+ if (OrderedCollectionFind (\r
+ AllocationsRestrictedTo32Bit,\r
+ Allocate->File\r
+ ) != NULL) {\r
+ Address = MAX_UINT32;\r
+ }\r
Status = gBS->AllocatePages (AllocateMaxAddress, EfiACPIMemoryNVS, NumPages,\r
&Address);\r
if (EFI_ERROR (Status)) {\r
command identified an ACPI table that is\r
different from RSDT and XSDT.\r
\r
+ @param[in,out] SeenPointers The ORDERED_COLLECTION tracking the absolute\r
+ target addresses that have been pointed-to by\r
+ QEMU_LOADER_ADD_POINTER commands thus far. If a\r
+ target address is encountered for the first\r
+ time, and it identifies an ACPI table that is\r
+ different from RDST and XSDT, the table is\r
+ installed. If a target address is seen for the\r
+ second or later times, it is skipped without\r
+ taking any action.\r
+\r
@retval EFI_INVALID_PARAMETER NumInstalled was outside the allowed range on\r
input.\r
\r
table different from RSDT and XSDT, but there\r
was no more room in InstalledKey.\r
\r
- @retval EFI_SUCCESS AddPointer has been processed. Either an ACPI\r
- table different from RSDT and XSDT has been\r
- installed (reflected by InstalledKey and\r
- NumInstalled), or RSDT or XSDT has been\r
- identified but not installed, or the fw_cfg\r
- blob pointed-into by AddPointer has been\r
- marked as hosting something else than just\r
- direct ACPI table contents.\r
+ @retval EFI_SUCCESS AddPointer has been processed. Either its\r
+ absolute target address has been encountered\r
+ before, or an ACPI table different from RSDT\r
+ and XSDT has been installed (reflected by\r
+ InstalledKey and NumInstalled), or RSDT or\r
+ XSDT has been identified but not installed, or\r
+ the fw_cfg blob pointed-into by AddPointer has\r
+ been marked as hosting something else than\r
+ just direct ACPI table contents.\r
\r
@return Error codes returned by\r
AcpiProtocol->InstallAcpiTable().\r
IN CONST ORDERED_COLLECTION *Tracker,\r
IN EFI_ACPI_TABLE_PROTOCOL *AcpiProtocol,\r
IN OUT UINTN InstalledKey[INSTALLED_TABLES_MAX],\r
- IN OUT INT32 *NumInstalled\r
+ IN OUT INT32 *NumInstalled,\r
+ IN OUT ORDERED_COLLECTION *SeenPointers\r
)\r
{\r
CONST ORDERED_COLLECTION_ENTRY *TrackerEntry;\r
CONST ORDERED_COLLECTION_ENTRY *TrackerEntry2;\r
+ ORDERED_COLLECTION_ENTRY *SeenPointerEntry;\r
CONST BLOB *Blob;\r
BLOB *Blob2;\r
CONST UINT8 *PointerField;\r
Blob2Remaining += Blob2->Size;\r
ASSERT (PointerValue < Blob2Remaining);\r
\r
+ Status = OrderedCollectionInsert (\r
+ SeenPointers,\r
+ &SeenPointerEntry, // for reverting insertion in error case\r
+ (VOID *)(UINTN)PointerValue\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ if (Status == RETURN_ALREADY_STARTED) {\r
+ //\r
+ // Already seen this pointer, don't try to process it again.\r
+ //\r
+ DEBUG ((\r
+ DEBUG_VERBOSE,\r
+ "%a: PointerValue=0x%Lx already processed, skipping.\n",\r
+ __FUNCTION__,\r
+ PointerValue\r
+ ));\r
+ Status = EFI_SUCCESS;\r
+ }\r
+ return Status;\r
+ }\r
+\r
Blob2Remaining -= (UINTN) PointerValue;\r
DEBUG ((EFI_D_VERBOSE, "%a: checking for ACPI header in \"%a\" at 0x%Lx "\r
"(remaining: 0x%Lx): ", __FUNCTION__, AddPointer->PointeeFile,\r
if (*NumInstalled == INSTALLED_TABLES_MAX) {\r
DEBUG ((EFI_D_ERROR, "%a: can't install more than %d tables\n",\r
__FUNCTION__, INSTALLED_TABLES_MAX));\r
- return EFI_OUT_OF_RESOURCES;\r
+ Status = EFI_OUT_OF_RESOURCES;\r
+ goto RollbackSeenPointer;\r
}\r
\r
Status = AcpiProtocol->InstallAcpiTable (AcpiProtocol,\r
if (EFI_ERROR (Status)) {\r
DEBUG ((EFI_D_ERROR, "%a: InstallAcpiTable(): %r\n", __FUNCTION__,\r
Status));\r
- return Status;\r
+ goto RollbackSeenPointer;\r
}\r
++*NumInstalled;\r
return EFI_SUCCESS;\r
+\r
+RollbackSeenPointer:\r
+ OrderedCollectionDelete (SeenPointers, SeenPointerEntry, NULL);\r
+ return Status;\r
}\r
\r
\r
CONST QEMU_LOADER_ENTRY *WritePointerSubsetEnd;\r
ORIGINAL_ATTRIBUTES *OriginalPciAttributes;\r
UINTN OriginalPciAttributesCount;\r
+ ORDERED_COLLECTION *AllocationsRestrictedTo32Bit;\r
S3_CONTEXT *S3Context;\r
ORDERED_COLLECTION *Tracker;\r
UINTN *InstalledKey;\r
INT32 Installed;\r
ORDERED_COLLECTION_ENTRY *TrackerEntry, *TrackerEntry2;\r
+ ORDERED_COLLECTION *SeenPointers;\r
+ ORDERED_COLLECTION_ENTRY *SeenPointerEntry, *SeenPointerEntry2;\r
\r
Status = QemuFwCfgFindFile ("etc/table-loader", &FwCfgItem, &FwCfgSize);\r
if (EFI_ERROR (Status)) {\r
RestorePciDecoding (OriginalPciAttributes, OriginalPciAttributesCount);\r
LoaderEnd = LoaderStart + FwCfgSize / sizeof *LoaderEntry;\r
\r
+ AllocationsRestrictedTo32Bit = NULL;\r
+ Status = CollectAllocationsRestrictedTo32Bit (\r
+ &AllocationsRestrictedTo32Bit,\r
+ LoaderStart,\r
+ LoaderEnd\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ goto FreeLoader;\r
+ }\r
+\r
S3Context = NULL;\r
if (QemuFwCfgS3Enabled ()) {\r
//\r
//\r
Status = AllocateS3Context (&S3Context, LoaderEnd - LoaderStart);\r
if (EFI_ERROR (Status)) {\r
- goto FreeLoader;\r
+ goto FreeAllocationsRestrictedTo32Bit;\r
}\r
}\r
\r
for (LoaderEntry = LoaderStart; LoaderEntry < LoaderEnd; ++LoaderEntry) {\r
switch (LoaderEntry->Type) {\r
case QemuLoaderCmdAllocate:\r
- Status = ProcessCmdAllocate (&LoaderEntry->Command.Allocate, Tracker);\r
+ Status = ProcessCmdAllocate (\r
+ &LoaderEntry->Command.Allocate,\r
+ Tracker,\r
+ AllocationsRestrictedTo32Bit\r
+ );\r
break;\r
\r
case QemuLoaderCmdAddPointer:\r
goto RollbackWritePointersAndFreeTracker;\r
}\r
\r
+ SeenPointers = OrderedCollectionInit (PointerCompare, PointerCompare);\r
+ if (SeenPointers == NULL) {\r
+ Status = EFI_OUT_OF_RESOURCES;\r
+ goto FreeKeys;\r
+ }\r
+\r
//\r
// second pass: identify and install ACPI tables\r
//\r
Installed = 0;\r
for (LoaderEntry = LoaderStart; LoaderEntry < LoaderEnd; ++LoaderEntry) {\r
if (LoaderEntry->Type == QemuLoaderCmdAddPointer) {\r
- Status = Process2ndPassCmdAddPointer (&LoaderEntry->Command.AddPointer,\r
- Tracker, AcpiProtocol, InstalledKey, &Installed);\r
+ Status = Process2ndPassCmdAddPointer (\r
+ &LoaderEntry->Command.AddPointer,\r
+ Tracker,\r
+ AcpiProtocol,\r
+ InstalledKey,\r
+ &Installed,\r
+ SeenPointers\r
+ );\r
if (EFI_ERROR (Status)) {\r
goto UninstallAcpiTables;\r
}\r
//\r
if (S3Context != NULL) {\r
Status = TransferS3ContextToBootScript (S3Context);\r
+ if (EFI_ERROR (Status)) {\r
+ goto UninstallAcpiTables;\r
+ }\r
+ //\r
+ // Ownership of S3Context has been transfered.\r
+ //\r
+ S3Context = NULL;\r
}\r
\r
UninstallAcpiTables:\r
DEBUG ((EFI_D_INFO, "%a: installed %d tables\n", __FUNCTION__, Installed));\r
}\r
\r
+ for (SeenPointerEntry = OrderedCollectionMin (SeenPointers);\r
+ SeenPointerEntry != NULL;\r
+ SeenPointerEntry = SeenPointerEntry2) {\r
+ SeenPointerEntry2 = OrderedCollectionNext (SeenPointerEntry);\r
+ OrderedCollectionDelete (SeenPointers, SeenPointerEntry, NULL);\r
+ }\r
+ OrderedCollectionUninit (SeenPointers);\r
+\r
+FreeKeys:\r
FreePool (InstalledKey);\r
\r
RollbackWritePointersAndFreeTracker:\r
ReleaseS3Context (S3Context);\r
}\r
\r
+FreeAllocationsRestrictedTo32Bit:\r
+ ReleaseAllocationsRestrictedTo32Bit (AllocationsRestrictedTo32Bit);\r
+\r
FreeLoader:\r
FreePool (LoaderStart);\r
\r