OvmfPkg: define CPU_HOT_EJECT_DATA

Define CPU_HOT_EJECT_DATA and add PCD PcdCpuHotEjectDataAddress, which
will be used to share CPU ejection state between OvmfPkg/CpuHotPlugSmm
and PiSmmCpuDxeSmm.

Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
Cc: Igor Mammedov <imammedo@redhat.com>
Cc: Boris Ostrovsky <boris.ostrovsky@oracle.com>
Cc: Aaron Young <aaron.young@oracle.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=3132
Signed-off-by: Ankur Arora <ankur.a.arora@oracle.com>
Message-Id: <20210312062656.2477515-6-ankur.a.arora@oracle.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>

diff --git a/OvmfPkg/Include/Pcd/CpuHotEjectData.h b/OvmfPkg/Include/Pcd/CpuHotEjectData.h
new file mode 100644 (file)
index 0000000..0671437
--- /dev/null
+++ b/OvmfPkg/Include/Pcd/CpuHotEjectData.h
@@ -0,0 +1,60 @@
+/** @file\r
+  Definition for the CPU_HOT_EJECT_DATA structure, which shares\r
+  CPU hot-eject state between OVMF's SmmCpuFeaturesLib instance in\r
+  PiSmmCpuDxeSmm, and CpuHotplugSmm.\r
+\r
+  CPU_HOT_EJECT_DATA is allocated in SMRAM, and pointed-to by\r
+  PcdCpuHotEjectDataAddress.\r
+\r
+  PcdCpuHotEjectDataAddress is valid when SMM_REQUIRE is TRUE\r
+  and PcdCpuMaxLogicalProcessorNumber > 1.\r
+\r
+  Copyright (C) 2021, Oracle Corporation.\r
+\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+**/\r
+\r
+#ifndef CPU_HOT_EJECT_DATA_H_\r
+#define CPU_HOT_EJECT_DATA_H_\r
+\r
+/**\r
+  CPU Hot-eject handler, called from SmmCpuFeaturesRendezvousExit()\r
+  on each CPU at exit from SMM.\r
+\r
+  @param[in] ProcessorNum      ProcessorNum denotes the CPU exiting SMM,\r
+                               and will be used as an index into\r
+                               CPU_HOT_EJECT_DATA->QemuSelectorMap. It is\r
+                               identical to the processor handle in\r
+                               EFI_SMM_CPU_SERVICE_PROTOCOL.\r
+**/\r
+typedef\r
+VOID\r
+(EFIAPI *CPU_HOT_EJECT_HANDLER) (\r
+  IN UINTN  ProcessorNum\r
+  );\r
+\r
+//\r
+// CPU_EJECT_QEMU_SELECTOR_INVALID marks CPUs not being ejected in\r
+// CPU_HOT_EJECT_DATA->QemuSelectorMap.\r
+//\r
+// QEMU CPU Selector is UINT32, so we choose an invalid value larger\r
+// than that type.\r
+//\r
+#define CPU_EJECT_QEMU_SELECTOR_INVALID       (MAX_UINT64)\r
+\r
+typedef struct {\r
+  //\r
+  // Maps ProcessorNum -> QemuSelector for pending hot-ejects\r
+  //\r
+  volatile UINT64 *QemuSelectorMap;\r
+  //\r
+  // Handler to do the CPU ejection\r
+  //\r
+  volatile CPU_HOT_EJECT_HANDLER Handler;\r
+  //\r
+  // Entries in the QemuSelectorMap\r
+  //\r
+  UINT32 ArrayLength;\r
+} CPU_HOT_EJECT_DATA;\r
+\r
+#endif // CPU_HOT_EJECT_DATA_H_\r

diff --git a/OvmfPkg/OvmfPkg.dec b/OvmfPkg/OvmfPkg.dec
index 4348bb45c64a979011c8b08a91abce76444f6fc4..9629707020ba9e31a8774e079bb02939d78cd190 100644 (file)
--- a/OvmfPkg/OvmfPkg.dec
+++ b/OvmfPkg/OvmfPkg.dec
@@ -352,6 +352,10 @@
   #  This PCD is only accessed if PcdSmmSmramRequire is TRUE (see below).\r
   gUefiOvmfPkgTokenSpaceGuid.PcdQ35SmramAtDefaultSmbase|FALSE|BOOLEAN|0x34\r
 \r
+  ## This PCD adds a communication channel between OVMF's SmmCpuFeaturesLib\r
+  #  instance in PiSmmCpuDxeSmm, and CpuHotplugSmm.\r
+  gUefiOvmfPkgTokenSpaceGuid.PcdCpuHotEjectDataAddress|0|UINT64|0x46\r
+\r
 [PcdsFeatureFlag]\r
   gUefiOvmfPkgTokenSpaceGuid.PcdQemuBootOrderPciTranslation|TRUE|BOOLEAN|0x1c\r
   gUefiOvmfPkgTokenSpaceGuid.PcdQemuBootOrderMmioTranslation|FALSE|BOOLEAN|0x1d\r