[mirror_edk2.git] / OvmfPkg / AcpiPlatformDxe / QemuFwCfgAcpi.c

/** @file\r
  OVMF ACPI support using QEMU's fw-cfg interface\r
\r
  Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\r
  Copyright (C) 2012-2014, Red Hat, Inc.\r
\r
  This program and the accompanying materials are licensed and made available\r
  under the terms and conditions of the BSD License which accompanies this\r
  distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r
  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "AcpiPlatform.h"\r
#include "QemuLoader.h"\r
#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
#include <IndustryStandard/Acpi.h>\r
\r
\r
//\r
// The user structure for the ordered collection that will track the fw_cfg\r
// blobs under processing.\r
//\r
typedef struct {\r
  UINT8   File[QEMU_LOADER_FNAME_SIZE]; // NUL-terminated name of the fw_cfg\r
                                        // blob. This is the ordering / search\r
                                        // key.\r
  UINTN   Size;                         // The number of bytes in this blob.\r
  UINT8   *Base;                        // Pointer to the blob data.\r
  BOOLEAN HostsOnlyTableData;           // TRUE iff the blob has been found to\r
                                        // only contain data that is directly\r
                                        // part of ACPI tables.\r
} BLOB;\r
\r
\r
/**\r
  Compare a standalone key against a user structure containing an embedded key.\r
\r
  @param[in] StandaloneKey  Pointer to the bare key.\r
\r
  @param[in] UserStruct     Pointer to the user structure with the embedded\r
                            key.\r
\r
  @retval <0  If StandaloneKey compares less than UserStruct's key.\r
\r
  @retval  0  If StandaloneKey compares equal to UserStruct's key.\r
\r
  @retval >0  If StandaloneKey compares greater than UserStruct's key.\r
**/\r
STATIC\r
INTN\r
EFIAPI\r
BlobKeyCompare (\r
  IN CONST VOID *StandaloneKey,\r
  IN CONST VOID *UserStruct\r
  )\r
{\r
  CONST BLOB *Blob;\r
\r
  Blob = UserStruct;\r
  return AsciiStrCmp (StandaloneKey, (CONST CHAR8 *)Blob->File);\r
}\r
\r
\r
/**\r
  Comparator function for two user structures.\r
\r
  @param[in] UserStruct1  Pointer to the first user structure.\r
\r
  @param[in] UserStruct2  Pointer to the second user structure.\r
\r
  @retval <0  If UserStruct1 compares less than UserStruct2.\r
\r
  @retval  0  If UserStruct1 compares equal to UserStruct2.\r
\r
  @retval >0  If UserStruct1 compares greater than UserStruct2.\r
**/\r
STATIC\r
INTN\r
EFIAPI\r
BlobCompare (\r
  IN CONST VOID *UserStruct1,\r
  IN CONST VOID *UserStruct2\r
  )\r
{\r
  CONST BLOB *Blob1;\r
\r
  Blob1 = UserStruct1;\r
  return BlobKeyCompare (Blob1->File, UserStruct2);\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
  Process a QEMU_LOADER_ALLOCATE command.\r
\r
  @param[in] Allocate     The QEMU_LOADER_ALLOCATE command to process.\r
\r
  @param[in,out] Tracker  The ORDERED_COLLECTION tracking the BLOB user\r
                          structures created thus far.\r
\r
  @retval EFI_SUCCESS           An area of whole AcpiNVS pages has been\r
                                allocated for the blob contents, and the\r
                                contents have been saved. A BLOB object (user\r
                                structure) has been allocated from pool memory,\r
                                referencing the blob contents. The BLOB user\r
                                structure has been linked into Tracker.\r
\r
  @retval EFI_PROTOCOL_ERROR    Malformed fw_cfg file name has been found in\r
                                Allocate, or the Allocate command references a\r
                                file that is already known by Tracker.\r
\r
  @retval EFI_UNSUPPORTED       Unsupported alignment request has been found in\r
                                Allocate.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Pool allocation failed.\r
\r
  @return                       Error codes from QemuFwCfgFindFile() and\r
                                gBS->AllocatePages().\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
ProcessCmdAllocate (\r
  IN CONST QEMU_LOADER_ALLOCATE *Allocate,\r
  IN OUT ORDERED_COLLECTION     *Tracker\r
  )\r
{\r
  FIRMWARE_CONFIG_ITEM FwCfgItem;\r
  UINTN                FwCfgSize;\r
  EFI_STATUS           Status;\r
  UINTN                NumPages;\r
  EFI_PHYSICAL_ADDRESS Address;\r
  BLOB                 *Blob;\r
\r
  if (Allocate->File[QEMU_LOADER_FNAME_SIZE - 1] != '\0') {\r
    DEBUG ((EFI_D_ERROR, "%a: malformed file name\n", __FUNCTION__));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  if (Allocate->Alignment > EFI_PAGE_SIZE) {\r
    DEBUG ((EFI_D_ERROR, "%a: unsupported alignment 0x%x\n", __FUNCTION__,\r
      Allocate->Alignment));\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Status = QemuFwCfgFindFile ((CHAR8 *)Allocate->File, &FwCfgItem, &FwCfgSize);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "%a: QemuFwCfgFindFile(\"%a\"): %r\n", __FUNCTION__,\r
      Allocate->File, Status));\r
    return Status;\r
  }\r
\r
  NumPages = EFI_SIZE_TO_PAGES (FwCfgSize);\r
  Address = 0xFFFFFFFF;\r
  Status = gBS->AllocatePages (AllocateMaxAddress, EfiACPIMemoryNVS, NumPages,\r
                  &Address);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Blob = AllocatePool (sizeof *Blob);\r
  if (Blob == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto FreePages;\r
  }\r
  CopyMem (Blob->File, Allocate->File, QEMU_LOADER_FNAME_SIZE);\r
  Blob->Size = FwCfgSize;\r
  Blob->Base = (VOID *)(UINTN)Address;\r
  Blob->HostsOnlyTableData = TRUE;\r
\r
  Status = OrderedCollectionInsert (Tracker, NULL, Blob);\r
  if (Status == RETURN_ALREADY_STARTED) {\r
    DEBUG ((EFI_D_ERROR, "%a: duplicated file \"%a\"\n", __FUNCTION__,\r
      Allocate->File));\r
    Status = EFI_PROTOCOL_ERROR;\r
  }\r
  if (EFI_ERROR (Status)) {\r
    goto FreeBlob;\r
  }\r
\r
  QemuFwCfgSelectItem (FwCfgItem);\r
  QemuFwCfgReadBytes (FwCfgSize, Blob->Base);\r
  ZeroMem (Blob->Base + Blob->Size, EFI_PAGES_TO_SIZE (NumPages) - Blob->Size);\r
\r
  DEBUG ((EFI_D_VERBOSE, "%a: File=\"%a\" Alignment=0x%x Zone=%d Size=0x%Lx "\r
    "Address=0x%Lx\n", __FUNCTION__, Allocate->File, Allocate->Alignment,\r
    Allocate->Zone, (UINT64)Blob->Size, (UINT64)(UINTN)Blob->Base));\r
  return EFI_SUCCESS;\r
\r
FreeBlob:\r
  FreePool (Blob);\r
\r
FreePages:\r
  gBS->FreePages (Address, NumPages);\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Process a QEMU_LOADER_ADD_POINTER command.\r
\r
  @param[in] AddPointer  The QEMU_LOADER_ADD_POINTER command to process.\r
\r
  @param[in] Tracker     The ORDERED_COLLECTION tracking the BLOB user\r
                         structures created thus far.\r
\r
  @retval EFI_PROTOCOL_ERROR  Malformed fw_cfg file name(s) have been found in\r
                              AddPointer, or the AddPointer command references\r
                              a file unknown to Tracker, or the pointer to\r
                              relocate has invalid location, size, or value, or\r
                              the relocated pointer value is not representable\r
                              in the given pointer size.\r
\r
  @retval EFI_SUCCESS         The pointer field inside the pointer blob has\r
                              been relocated.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
ProcessCmdAddPointer (\r
  IN CONST QEMU_LOADER_ADD_POINTER *AddPointer,\r
  IN CONST ORDERED_COLLECTION      *Tracker\r
  )\r
{\r
  ORDERED_COLLECTION_ENTRY *TrackerEntry, *TrackerEntry2;\r
  BLOB                     *Blob, *Blob2;\r
  UINT8                    *PointerField;\r
  UINT64                   PointerValue;\r
\r
  if (AddPointer->PointerFile[QEMU_LOADER_FNAME_SIZE - 1] != '\0' ||\r
      AddPointer->PointeeFile[QEMU_LOADER_FNAME_SIZE - 1] != '\0') {\r
    DEBUG ((EFI_D_ERROR, "%a: malformed file name\n", __FUNCTION__));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  TrackerEntry = OrderedCollectionFind (Tracker, AddPointer->PointerFile);\r
  TrackerEntry2 = OrderedCollectionFind (Tracker, AddPointer->PointeeFile);\r
  if (TrackerEntry == NULL || TrackerEntry2 == NULL) {\r
    DEBUG ((EFI_D_ERROR, "%a: invalid blob reference(s) \"%a\" / \"%a\"\n",\r
      __FUNCTION__, AddPointer->PointerFile, AddPointer->PointeeFile));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  Blob = OrderedCollectionUserStruct (TrackerEntry);\r
  Blob2 = OrderedCollectionUserStruct (TrackerEntry2);\r
  if ((AddPointer->PointerSize != 1 && AddPointer->PointerSize != 2 &&\r
       AddPointer->PointerSize != 4 && AddPointer->PointerSize != 8) ||\r
      Blob->Size < AddPointer->PointerSize ||\r
      Blob->Size - AddPointer->PointerSize < AddPointer->PointerOffset) {\r
    DEBUG ((EFI_D_ERROR, "%a: invalid pointer location or size in \"%a\"\n",\r
      __FUNCTION__, AddPointer->PointerFile));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  PointerField = Blob->Base + AddPointer->PointerOffset;\r
  PointerValue = 0;\r
  CopyMem (&PointerValue, PointerField, AddPointer->PointerSize);\r
  if (PointerValue >= Blob2->Size) {\r
    DEBUG ((EFI_D_ERROR, "%a: invalid pointer value in \"%a\"\n", __FUNCTION__,\r
      AddPointer->PointerFile));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  //\r
  // The memory allocation system ensures that the address of the byte past the\r
  // last byte of any allocated object is expressible (no wraparound).\r
  //\r
  ASSERT ((UINTN)Blob2->Base <= MAX_ADDRESS - Blob2->Size);\r
\r
  PointerValue += (UINT64)(UINTN)Blob2->Base;\r
  if (AddPointer->PointerSize < 8 &&\r
      RShiftU64 (PointerValue, AddPointer->PointerSize * 8) != 0) {\r
    DEBUG ((EFI_D_ERROR, "%a: relocated pointer value unrepresentable in "\r
      "\"%a\"\n", __FUNCTION__, AddPointer->PointerFile));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  CopyMem (PointerField, &PointerValue, AddPointer->PointerSize);\r
\r
  DEBUG ((EFI_D_VERBOSE, "%a: PointerFile=\"%a\" PointeeFile=\"%a\" "\r
    "PointerOffset=0x%x PointerSize=%d\n", __FUNCTION__,\r
    AddPointer->PointerFile, AddPointer->PointeeFile,\r
    AddPointer->PointerOffset, AddPointer->PointerSize));\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Process a QEMU_LOADER_ADD_CHECKSUM command.\r
\r
  @param[in] AddChecksum  The QEMU_LOADER_ADD_CHECKSUM command to process.\r
\r
  @param[in] Tracker      The ORDERED_COLLECTION tracking the BLOB user\r
                          structures created thus far.\r
\r
  @retval EFI_PROTOCOL_ERROR  Malformed fw_cfg file name has been found in\r
                              AddChecksum, or the AddChecksum command\r
                              references a file unknown to Tracker, or the\r
                              range to checksum is invalid.\r
\r
  @retval EFI_SUCCESS         The requested range has been checksummed.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
ProcessCmdAddChecksum (\r
  IN CONST QEMU_LOADER_ADD_CHECKSUM *AddChecksum,\r
  IN CONST ORDERED_COLLECTION       *Tracker\r
  )\r
{\r
  ORDERED_COLLECTION_ENTRY *TrackerEntry;\r
  BLOB                     *Blob;\r
\r
  if (AddChecksum->File[QEMU_LOADER_FNAME_SIZE - 1] != '\0') {\r
    DEBUG ((EFI_D_ERROR, "%a: malformed file name\n", __FUNCTION__));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  TrackerEntry = OrderedCollectionFind (Tracker, AddChecksum->File);\r
  if (TrackerEntry == NULL) {\r
    DEBUG ((EFI_D_ERROR, "%a: invalid blob reference \"%a\"\n", __FUNCTION__,\r
      AddChecksum->File));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  Blob = OrderedCollectionUserStruct (TrackerEntry);\r
  if (Blob->Size <= AddChecksum->ResultOffset ||\r
      Blob->Size < AddChecksum->Length ||\r
      Blob->Size - AddChecksum->Length < AddChecksum->Start) {\r
    DEBUG ((EFI_D_ERROR, "%a: invalid checksum range in \"%a\"\n",\r
      __FUNCTION__, AddChecksum->File));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  Blob->Base[AddChecksum->ResultOffset] = CalculateCheckSum8 (\r
                                           Blob->Base + AddChecksum->Start,\r
                                           AddChecksum->Length\r
                                           );\r
  DEBUG ((EFI_D_VERBOSE, "%a: File=\"%a\" ResultOffset=0x%x Start=0x%x "\r
    "Length=0x%x\n", __FUNCTION__, AddChecksum->File,\r
    AddChecksum->ResultOffset, AddChecksum->Start, AddChecksum->Length));\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Process a QEMU_LOADER_WRITE_POINTER command.\r
\r
  @param[in] WritePointer   The QEMU_LOADER_WRITE_POINTER command to process.\r
\r
  @param[in] Tracker        The ORDERED_COLLECTION tracking the BLOB user\r
                            structures created thus far.\r
\r
  @param[in,out] S3Context  The S3_CONTEXT object capturing the fw_cfg actions\r
                            of successfully processed QEMU_LOADER_WRITE_POINTER\r
                            commands, to be replayed at S3 resume. S3Context\r
                            may be NULL if S3 is disabled.\r
\r
  @retval EFI_PROTOCOL_ERROR  Malformed fw_cfg file name(s) have been found in\r
                              WritePointer. Or, the WritePointer command\r
                              references a file unknown to Tracker or the\r
                              fw_cfg directory. Or, the pointer object to\r
                              rewrite has invalid location, size, or initial\r
                              relative value. Or, the pointer value to store\r
                              does not fit in the given pointer size.\r
\r
  @retval EFI_SUCCESS         The pointer object inside the writeable fw_cfg\r
                              file has been written. If S3Context is not NULL,\r
                              then WritePointer has been condensed into\r
                              S3Context.\r
\r
  @return                     Error codes propagated from\r
                              SaveCondensedWritePointerToS3Context(). The\r
                              pointer object inside the writeable fw_cfg file\r
                              has not been written.\r
**/\r
STATIC\r
EFI_STATUS\r
ProcessCmdWritePointer (\r
  IN     CONST QEMU_LOADER_WRITE_POINTER *WritePointer,\r
  IN     CONST ORDERED_COLLECTION        *Tracker,\r
  IN OUT       S3_CONTEXT                *S3Context OPTIONAL\r
  )\r
{\r
  RETURN_STATUS            Status;\r
  FIRMWARE_CONFIG_ITEM     PointerItem;\r
  UINTN                    PointerItemSize;\r
  ORDERED_COLLECTION_ENTRY *PointeeEntry;\r
  BLOB                     *PointeeBlob;\r
  UINT64                   PointerValue;\r
\r
  if (WritePointer->PointerFile[QEMU_LOADER_FNAME_SIZE - 1] != '\0' ||\r
      WritePointer->PointeeFile[QEMU_LOADER_FNAME_SIZE - 1] != '\0') {\r
    DEBUG ((DEBUG_ERROR, "%a: malformed file name\n", __FUNCTION__));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  Status = QemuFwCfgFindFile ((CONST CHAR8 *)WritePointer->PointerFile,\r
             &PointerItem, &PointerItemSize);\r
  PointeeEntry = OrderedCollectionFind (Tracker, WritePointer->PointeeFile);\r
  if (RETURN_ERROR (Status) || PointeeEntry == NULL) {\r
    DEBUG ((DEBUG_ERROR,\r
      "%a: invalid fw_cfg file or blob reference \"%a\" / \"%a\"\n",\r
      __FUNCTION__, WritePointer->PointerFile, WritePointer->PointeeFile));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  if ((WritePointer->PointerSize != 1 && WritePointer->PointerSize != 2 &&\r
       WritePointer->PointerSize != 4 && WritePointer->PointerSize != 8) ||\r
      (PointerItemSize < WritePointer->PointerSize) ||\r
      (PointerItemSize - WritePointer->PointerSize <\r
       WritePointer->PointerOffset)) {\r
    DEBUG ((DEBUG_ERROR, "%a: invalid pointer location or size in \"%a\"\n",\r
      __FUNCTION__, WritePointer->PointerFile));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  PointeeBlob = OrderedCollectionUserStruct (PointeeEntry);\r
  PointerValue = WritePointer->PointeeOffset;\r
  if (PointerValue >= PointeeBlob->Size) {\r
    DEBUG ((DEBUG_ERROR, "%a: invalid PointeeOffset\n", __FUNCTION__));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  //\r
  // The memory allocation system ensures that the address of the byte past the\r
  // last byte of any allocated object is expressible (no wraparound).\r
  //\r
  ASSERT ((UINTN)PointeeBlob->Base <= MAX_ADDRESS - PointeeBlob->Size);\r
\r
  PointerValue += (UINT64)(UINTN)PointeeBlob->Base;\r
  if (WritePointer->PointerSize < 8 &&\r
      RShiftU64 (PointerValue, WritePointer->PointerSize * 8) != 0) {\r
    DEBUG ((DEBUG_ERROR, "%a: pointer value unrepresentable in \"%a\"\n",\r
      __FUNCTION__, WritePointer->PointerFile));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  //\r
  // If S3 is enabled, we have to capture the below fw_cfg actions in condensed\r
  // form, to be replayed during S3 resume.\r
  //\r
  if (S3Context != NULL) {\r
    EFI_STATUS SaveStatus;\r
\r
    SaveStatus = SaveCondensedWritePointerToS3Context (\r
                   S3Context,\r
                   (UINT16)PointerItem,\r
                   WritePointer->PointerSize,\r
                   WritePointer->PointerOffset,\r
                   PointerValue\r
                   );\r
    if (EFI_ERROR (SaveStatus)) {\r
      return SaveStatus;\r
    }\r
  }\r
\r
  QemuFwCfgSelectItem (PointerItem);\r
  QemuFwCfgSkipBytes (WritePointer->PointerOffset);\r
  QemuFwCfgWriteBytes (WritePointer->PointerSize, &PointerValue);\r
\r
  //\r
  // Because QEMU has now learned PointeeBlob->Base, we must mark PointeeBlob\r
  // as unreleasable, for the case when the whole linker/loader script is\r
  // handled successfully.\r
  //\r
  PointeeBlob->HostsOnlyTableData = FALSE;\r
\r
  DEBUG ((DEBUG_VERBOSE, "%a: PointerFile=\"%a\" PointeeFile=\"%a\" "\r
    "PointerOffset=0x%x PointeeOffset=0x%x PointerSize=%d\n", __FUNCTION__,\r
    WritePointer->PointerFile, WritePointer->PointeeFile,\r
    WritePointer->PointerOffset, WritePointer->PointeeOffset,\r
    WritePointer->PointerSize));\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Undo a QEMU_LOADER_WRITE_POINTER command.\r
\r
  This function revokes (zeroes out) a guest memory reference communicated to\r
  QEMU earlier. The caller is responsible for invoking this function only on\r
  such QEMU_LOADER_WRITE_POINTER commands that have been successfully processed\r
  by ProcessCmdWritePointer().\r
\r
  @param[in] WritePointer  The QEMU_LOADER_WRITE_POINTER command to undo.\r
**/\r
STATIC\r
VOID\r
UndoCmdWritePointer (\r
  IN CONST QEMU_LOADER_WRITE_POINTER *WritePointer\r
  )\r
{\r
  RETURN_STATUS        Status;\r
  FIRMWARE_CONFIG_ITEM PointerItem;\r
  UINTN                PointerItemSize;\r
  UINT64               PointerValue;\r
\r
  Status = QemuFwCfgFindFile ((CONST CHAR8 *)WritePointer->PointerFile,\r
             &PointerItem, &PointerItemSize);\r
  ASSERT_RETURN_ERROR (Status);\r
\r
  PointerValue = 0;\r
  QemuFwCfgSelectItem (PointerItem);\r
  QemuFwCfgSkipBytes (WritePointer->PointerOffset);\r
  QemuFwCfgWriteBytes (WritePointer->PointerSize, &PointerValue);\r
\r
  DEBUG ((DEBUG_VERBOSE,\r
    "%a: PointerFile=\"%a\" PointerOffset=0x%x PointerSize=%d\n", __FUNCTION__,\r
    WritePointer->PointerFile, WritePointer->PointerOffset,\r
    WritePointer->PointerSize));\r
}\r
\r
\r
//\r
// We'll be saving the keys of installed tables so that we can roll them back\r
// in case of failure. 128 tables should be enough for anyone (TM).\r
//\r
#define INSTALLED_TABLES_MAX 128\r
\r
/**\r
  Process a QEMU_LOADER_ADD_POINTER command in order to see if its target byte\r
  array is an ACPI table, and if so, install it.\r
\r
  This function assumes that the entire QEMU linker/loader command file has\r
  been processed successfully in a prior first pass.\r
\r
  @param[in] AddPointer        The QEMU_LOADER_ADD_POINTER command to process.\r
\r
  @param[in] Tracker           The ORDERED_COLLECTION tracking the BLOB user\r
                               structures.\r
\r
  @param[in] AcpiProtocol      The ACPI table protocol used to install tables.\r
\r
  @param[in,out] InstalledKey  On input, an array of INSTALLED_TABLES_MAX UINTN\r
                               elements, allocated by the caller. On output,\r
                               the function will have stored (appended) the\r
                               AcpiProtocol-internal key of the ACPI table that\r
                               the function has installed, if the AddPointer\r
                               command identified an ACPI table that is\r
                               different from RSDT and XSDT.\r
\r
  @param[in,out] NumInstalled  On input, the number of entries already used in\r
                               InstalledKey; it must be in [0,\r
                               INSTALLED_TABLES_MAX] inclusive. On output, the\r
                               parameter is incremented if the AddPointer\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
  @retval EFI_OUT_OF_RESOURCES   The AddPointer command identified an ACPI\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 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
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
Process2ndPassCmdAddPointer (\r
  IN     CONST QEMU_LOADER_ADD_POINTER *AddPointer,\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 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
  UINT64                                             PointerValue;\r
  UINTN                                              Blob2Remaining;\r
  UINTN                                              TableSize;\r
  CONST EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs;\r
  CONST EFI_ACPI_DESCRIPTION_HEADER                  *Header;\r
  EFI_STATUS                                         Status;\r
\r
  if (*NumInstalled < 0 || *NumInstalled > INSTALLED_TABLES_MAX) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  TrackerEntry = OrderedCollectionFind (Tracker, AddPointer->PointerFile);\r
  TrackerEntry2 = OrderedCollectionFind (Tracker, AddPointer->PointeeFile);\r
  Blob = OrderedCollectionUserStruct (TrackerEntry);\r
  Blob2 = OrderedCollectionUserStruct (TrackerEntry2);\r
  PointerField = Blob->Base + AddPointer->PointerOffset;\r
  PointerValue = 0;\r
  CopyMem (&PointerValue, PointerField, AddPointer->PointerSize);\r
\r
  //\r
  // We assert that PointerValue falls inside Blob2's contents. This is ensured\r
  // by the Blob2->Size check and later checks in ProcessCmdAddPointer().\r
  //\r
  Blob2Remaining = (UINTN)Blob2->Base;\r
  ASSERT(PointerValue >= Blob2Remaining);\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
    PointerValue, (UINT64)Blob2Remaining));\r
\r
  TableSize = 0;\r
\r
  //\r
  // To make our job simple, the FACS has a custom header. Sigh.\r
  //\r
  if (sizeof *Facs <= Blob2Remaining) {\r
    Facs = (EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *)(UINTN)PointerValue;\r
\r
    if (Facs->Length >= sizeof *Facs &&\r
        Facs->Length <= Blob2Remaining &&\r
        Facs->Signature ==\r
                EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) {\r
      DEBUG ((EFI_D_VERBOSE, "found \"%-4.4a\" size 0x%x\n",\r
        (CONST CHAR8 *)&Facs->Signature, Facs->Length));\r
      TableSize = Facs->Length;\r
    }\r
  }\r
\r
  //\r
  // check for the uniform tables\r
  //\r
  if (TableSize == 0 && sizeof *Header <= Blob2Remaining) {\r
    Header = (EFI_ACPI_DESCRIPTION_HEADER *)(UINTN)PointerValue;\r
\r
    if (Header->Length >= sizeof *Header &&\r
        Header->Length <= Blob2Remaining &&\r
        CalculateSum8 ((CONST UINT8 *)Header, Header->Length) == 0) {\r
      //\r
      // This looks very much like an ACPI table from QEMU:\r
      // - Length field consistent with both ACPI and containing blob size\r
      // - checksum is correct\r
      //\r
      DEBUG ((EFI_D_VERBOSE, "found \"%-4.4a\" size 0x%x\n",\r
        (CONST CHAR8 *)&Header->Signature, Header->Length));\r
      TableSize = Header->Length;\r
\r
      //\r
      // Skip RSDT and XSDT because those are handled by\r
      // EFI_ACPI_TABLE_PROTOCOL automatically.\r
      if (Header->Signature ==\r
                    EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE ||\r
          Header->Signature ==\r
                    EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE) {\r
        return EFI_SUCCESS;\r
      }\r
    }\r
  }\r
\r
  if (TableSize == 0) {\r
    DEBUG ((EFI_D_VERBOSE, "not found; marking fw_cfg blob as opaque\n"));\r
    Blob2->HostsOnlyTableData = FALSE;\r
    return EFI_SUCCESS;\r
  }\r
\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
    Status = EFI_OUT_OF_RESOURCES;\r
    goto RollbackSeenPointer;\r
  }\r
\r
  Status = AcpiProtocol->InstallAcpiTable (AcpiProtocol,\r
                           (VOID *)(UINTN)PointerValue, TableSize,\r
                           &InstalledKey[*NumInstalled]);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "%a: InstallAcpiTable(): %r\n", __FUNCTION__,\r
      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
/**\r
  Download, process, and install ACPI table data from the QEMU loader\r
  interface.\r
\r
  @param[in] AcpiProtocol  The ACPI table protocol used to install tables.\r
\r
  @retval  EFI_UNSUPPORTED       Firmware configuration is unavailable, or QEMU\r
                                 loader command with unsupported parameters\r
                                 has been found.\r
\r
  @retval  EFI_NOT_FOUND         The host doesn't export the required fw_cfg\r
                                 files.\r
\r
  @retval  EFI_OUT_OF_RESOURCES  Memory allocation failed, or more than\r
                                 INSTALLED_TABLES_MAX tables found.\r
\r
  @retval  EFI_PROTOCOL_ERROR    Found invalid fw_cfg contents.\r
\r
  @return                        Status codes returned by\r
                                 AcpiProtocol->InstallAcpiTable().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InstallQemuFwCfgTables (\r
  IN   EFI_ACPI_TABLE_PROTOCOL       *AcpiProtocol\r
  )\r
{\r
  EFI_STATUS               Status;\r
  FIRMWARE_CONFIG_ITEM     FwCfgItem;\r
  UINTN                    FwCfgSize;\r
  QEMU_LOADER_ENTRY        *LoaderStart;\r
  CONST QEMU_LOADER_ENTRY  *LoaderEntry, *LoaderEnd;\r
  CONST QEMU_LOADER_ENTRY  *WritePointerSubsetEnd;\r
  ORIGINAL_ATTRIBUTES      *OriginalPciAttributes;\r
  UINTN                    OriginalPciAttributesCount;\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
    return Status;\r
  }\r
  if (FwCfgSize % sizeof *LoaderEntry != 0) {\r
    DEBUG ((EFI_D_ERROR, "%a: \"etc/table-loader\" has invalid size 0x%Lx\n",\r
      __FUNCTION__, (UINT64)FwCfgSize));\r
    return EFI_PROTOCOL_ERROR;\r
  }\r
\r
  LoaderStart = AllocatePool (FwCfgSize);\r
  if (LoaderStart == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  EnablePciDecoding (&OriginalPciAttributes, &OriginalPciAttributesCount);\r
  QemuFwCfgSelectItem (FwCfgItem);\r
  QemuFwCfgReadBytes (FwCfgSize, LoaderStart);\r
  RestorePciDecoding (OriginalPciAttributes, OriginalPciAttributesCount);\r
  LoaderEnd = LoaderStart + FwCfgSize / sizeof *LoaderEntry;\r
\r
  S3Context = NULL;\r
  if (QemuFwCfgS3Enabled ()) {\r
    //\r
    // Size the allocation pessimistically, assuming that all commands in the\r
    // script are QEMU_LOADER_WRITE_POINTER commands.\r
    //\r
    Status = AllocateS3Context (&S3Context, LoaderEnd - LoaderStart);\r
    if (EFI_ERROR (Status)) {\r
      goto FreeLoader;\r
    }\r
  }\r
\r
  Tracker = OrderedCollectionInit (BlobCompare, BlobKeyCompare);\r
  if (Tracker == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto FreeS3Context;\r
  }\r
\r
  //\r
  // first pass: process the commands\r
  //\r
  // "WritePointerSubsetEnd" points one past the last successful\r
  // QEMU_LOADER_WRITE_POINTER command. Now when we're about to start the first\r
  // pass, no such command has been encountered yet.\r
  //\r
  WritePointerSubsetEnd = LoaderStart;\r
  for (LoaderEntry = LoaderStart; LoaderEntry < LoaderEnd; ++LoaderEntry) {\r
    switch (LoaderEntry->Type) {\r
    case QemuLoaderCmdAllocate:\r
      Status = ProcessCmdAllocate (&LoaderEntry->Command.Allocate, Tracker);\r
      break;\r
\r
    case QemuLoaderCmdAddPointer:\r
      Status = ProcessCmdAddPointer (&LoaderEntry->Command.AddPointer,\r
                 Tracker);\r
      break;\r
\r
    case QemuLoaderCmdAddChecksum:\r
      Status = ProcessCmdAddChecksum (&LoaderEntry->Command.AddChecksum,\r
                 Tracker);\r
      break;\r
\r
    case QemuLoaderCmdWritePointer:\r
        Status = ProcessCmdWritePointer (&LoaderEntry->Command.WritePointer,\r
                   Tracker, S3Context);\r
        if (!EFI_ERROR (Status)) {\r
          WritePointerSubsetEnd = LoaderEntry + 1;\r
        }\r
        break;\r
\r
    default:\r
      DEBUG ((EFI_D_VERBOSE, "%a: unknown loader command: 0x%x\n",\r
        __FUNCTION__, LoaderEntry->Type));\r
      break;\r
    }\r
\r
    if (EFI_ERROR (Status)) {\r
      goto RollbackWritePointersAndFreeTracker;\r
    }\r
  }\r
\r
  InstalledKey = AllocatePool (INSTALLED_TABLES_MAX * sizeof *InstalledKey);\r
  if (InstalledKey == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\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 (\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
  }\r
\r
  //\r
  // Translating the condensed QEMU_LOADER_WRITE_POINTER commands to ACPI S3\r
  // Boot Script opcodes has to be the last operation in this function, because\r
  // if it succeeds, it cannot be undone.\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
  if (EFI_ERROR (Status)) {\r
    //\r
    // roll back partial installation\r
    //\r
    while (Installed > 0) {\r
      --Installed;\r
      AcpiProtocol->UninstallAcpiTable (AcpiProtocol, InstalledKey[Installed]);\r
    }\r
  } else {\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
  //\r
  // In case of failure, revoke any allocation addresses that were communicated\r
  // to QEMU previously, before we release all the blobs.\r
  //\r
  if (EFI_ERROR (Status)) {\r
    LoaderEntry = WritePointerSubsetEnd;\r
    while (LoaderEntry > LoaderStart) {\r
      --LoaderEntry;\r
      if (LoaderEntry->Type == QemuLoaderCmdWritePointer) {\r
        UndoCmdWritePointer (&LoaderEntry->Command.WritePointer);\r
      }\r
    }\r
  }\r
\r
  //\r
  // Tear down the tracker infrastructure. Each fw_cfg blob will be left in\r
  // place only if we're exiting with success and the blob hosts data that is\r
  // not directly part of some ACPI table.\r
  //\r
  for (TrackerEntry = OrderedCollectionMin (Tracker); TrackerEntry != NULL;\r
       TrackerEntry = TrackerEntry2) {\r
    VOID *UserStruct;\r
    BLOB *Blob;\r
\r
    TrackerEntry2 = OrderedCollectionNext (TrackerEntry);\r
    OrderedCollectionDelete (Tracker, TrackerEntry, &UserStruct);\r
    Blob = UserStruct;\r
\r
    if (EFI_ERROR (Status) || Blob->HostsOnlyTableData) {\r
      DEBUG ((EFI_D_VERBOSE, "%a: freeing \"%a\"\n", __FUNCTION__,\r
        Blob->File));\r
      gBS->FreePages ((UINTN)Blob->Base, EFI_SIZE_TO_PAGES (Blob->Size));\r
    }\r
    FreePool (Blob);\r
  }\r
  OrderedCollectionUninit (Tracker);\r
\r
FreeS3Context:\r
  if (S3Context != NULL) {\r
    ReleaseS3Context (S3Context);\r
  }\r
\r
FreeLoader:\r
  FreePool (LoaderStart);\r
\r
  return Status;\r
}\r