OvmfPkg/PlatformPei: Set memory encryption PCD when SEV is enabled

Secure Encrypted Virtualization (SEV) guest VMs have the concept of
private and shared memory. Private memory is encrypted with the
guest-specific key, while shared memory may be encrypted with hypervisor
key.  Certain types of memory (namely instruction pages and guest page
tables) are always treated as private memory by the hardware.
For data memory, SEV guest VMs can choose which pages they would like
to be private. The choice is done using the standard CPU page tables
using the C-bit. When building the initial page table we mark all the
memory as private.

The patch sets the memory encryption PCD. The PCD is consumed by the
following edk2 modules, which manipulate page tables:

- PEI phase modules: CapsulePei, DxeIplPeim, S3Resume2Pei.

CapsulePei is not used by OVMF. DxeIplPeim consumes the PCD at the
end of the PEI phase, when it builds the initial page tables for the
DXE core / DXE phase. S3Resume2Pei does not consume the PCD in its
entry point function, only when DxeIplPeim branches to the S3 resume
path at the end of the PEI phase, and calls S3Resume2Pei's
EFI_PEI_S3_RESUME2_PPI.S3RestoreConfig2() member function.

Therefore it is safe to set the PCD for these modules in PlatformPei.

- DXE phase modules: BootScriptExecutorDxe, CpuDxe, PiSmmCpuDxeSmm.

They are all dispatched after the PEI phase, so setting the PCD for
them in PlatformPei is safe. (BootScriptExecutorDxe is launched "for
real" in the PEI phase during S3 resume, but it caches the PCD into a
static variable when its entry point is originally invoked in DXE.)

Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Brijesh Singh <brijesh.singh@amd.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>

7 files changed, 80 insertions, 0 deletions

diff --git a/OvmfPkg/OvmfPkgIa32.dsc b/OvmfPkg/OvmfPkgIa32.dsc
index 29884b7785..9355a37ae9 100644
--- a/OvmfPkg/OvmfPkgIa32.dsc
+++ b/OvmfPkg/OvmfPkgIa32.dsc
@@ -534,6 +534,9 @@
   gUefiCpuPkgTokenSpaceGuid.PcdCpuMaxLogicalProcessorNumber|64

   gUefiCpuPkgTokenSpaceGuid.PcdCpuApInitTimeOutInMicroSeconds|50000

 

+  # Set memory encryption mask

+  gEfiMdeModulePkgTokenSpaceGuid.PcdPteMemoryEncryptionAddressOrMask|0x0

+

 !if $(SMM_REQUIRE) == TRUE

   gUefiOvmfPkgTokenSpaceGuid.PcdQ35TsegMbytes|8

   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmSyncMode|0x01

diff --git a/OvmfPkg/OvmfPkgIa32X64.dsc b/OvmfPkg/OvmfPkgIa32X64.dsc
index 2b646e4a49..edacd655d1 100644
--- a/OvmfPkg/OvmfPkgIa32X64.dsc
+++ b/OvmfPkg/OvmfPkgIa32X64.dsc
@@ -542,6 +542,9 @@
   gUefiCpuPkgTokenSpaceGuid.PcdCpuMaxLogicalProcessorNumber|64

   gUefiCpuPkgTokenSpaceGuid.PcdCpuApInitTimeOutInMicroSeconds|50000

 

+  # Set memory encryption mask

+  gEfiMdeModulePkgTokenSpaceGuid.PcdPteMemoryEncryptionAddressOrMask|0x0

+

 !if $(SMM_REQUIRE) == TRUE

   gUefiOvmfPkgTokenSpaceGuid.PcdQ35TsegMbytes|8

   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmSyncMode|0x01

diff --git a/OvmfPkg/OvmfPkgX64.dsc b/OvmfPkg/OvmfPkgX64.dsc
index 32386de9b4..93933612a3 100644
--- a/OvmfPkg/OvmfPkgX64.dsc
+++ b/OvmfPkg/OvmfPkgX64.dsc
@@ -541,6 +541,9 @@
   gUefiCpuPkgTokenSpaceGuid.PcdCpuMaxLogicalProcessorNumber|64

   gUefiCpuPkgTokenSpaceGuid.PcdCpuApInitTimeOutInMicroSeconds|50000

 

+  # Set memory encryption mask

+  gEfiMdeModulePkgTokenSpaceGuid.PcdPteMemoryEncryptionAddressOrMask|0x0

+

 !if $(SMM_REQUIRE) == TRUE

   gUefiOvmfPkgTokenSpaceGuid.PcdQ35TsegMbytes|8

   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmSyncMode|0x01

diff --git a/OvmfPkg/PlatformPei/AmdSev.c b/OvmfPkg/PlatformPei/AmdSev.c
new file mode 100644
index 0000000000..26f7c3fdbb
--- /dev/null
+++ b/OvmfPkg/PlatformPei/AmdSev.c
@@ -0,0 +1,62 @@
+/**@file

+  Initialize Secure Encrypted Virtualization (SEV) support

+

+  Copyright (c) 2017, Advanced Micro Devices. All rights reserved.<BR>

+

+  This program and the accompanying materials

+  are licensed and made available under the terms and conditions of the BSD

+  License which accompanies this distribution.  The full text of the license

+  may be found at http://opensource.org/licenses/bsd-license.php

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+//

+// The package level header files this module uses

+//

+#include <PiPei.h>

+

+#include <Library/DebugLib.h>

+#include <Library/PcdLib.h>

+#include <Register/Cpuid.h>

+#include <Register/Amd/Cpuid.h>

+#include <Library/MemEncryptSevLib.h>

+

+/**

+

+  Function checks if SEV support is available, if present then it sets

+  the dynamic PcdPteMemoryEncryptionAddressOrMask with memory encryption mask.

+

+  **/

+VOID

+EFIAPI

+AmdSevInitialize (

+  VOID

+  )

+{

+  CPUID_MEMORY_ENCRYPTION_INFO_EBX  Ebx;

+  UINT64                            EncryptionMask;

+  RETURN_STATUS                     PcdStatus;

+

+  //

+  // Check if SEV is enabled

+  //

+  if (!MemEncryptSevIsEnabled ()) {

+    return;

+  }

+

+  //

+  // CPUID Fn8000_001F[EBX] Bit 0:5 (memory encryption bit position)

+  //

+  AsmCpuid (CPUID_MEMORY_ENCRYPTION_INFO, NULL, &Ebx.Uint32, NULL, NULL);

+  EncryptionMask = LShiftU64 (1, Ebx.Bits.PtePosBits);

+

+  //

+  // Set Memory Encryption Mask PCD

+  //

+  PcdStatus = PcdSet64S (PcdPteMemoryEncryptionAddressOrMask, EncryptionMask);

+  ASSERT_RETURN_ERROR (PcdStatus);

+

+  DEBUG ((DEBUG_INFO, "SEV is enabled (mask 0x%lx)\n", EncryptionMask));

+}

diff --git a/OvmfPkg/PlatformPei/Platform.c b/OvmfPkg/PlatformPei/Platform.c
index 98cfaaa28e..3ccb7d0fbf 100644
--- a/OvmfPkg/PlatformPei/Platform.c
+++ b/OvmfPkg/PlatformPei/Platform.c
@@ -672,6 +672,7 @@ InitializePlatform (
     NoexecDxeInitialization ();

   }

 

+  AmdSevInitialize ();

   MiscInitialization ();

   InstallFeatureControlCallback ();

 

diff --git a/OvmfPkg/PlatformPei/Platform.h b/OvmfPkg/PlatformPei/Platform.h
index ae855531c1..f942e61bb4 100644
--- a/OvmfPkg/PlatformPei/Platform.h
+++ b/OvmfPkg/PlatformPei/Platform.h
@@ -93,6 +93,11 @@ XenDetect (
   VOID

   );

 

+VOID

+AmdSevInitialize (

+  VOID

+  );

+

 extern BOOLEAN mXen;

 

 VOID

diff --git a/OvmfPkg/PlatformPei/PlatformPei.inf b/OvmfPkg/PlatformPei/PlatformPei.inf
index a1e12c1fc7..16a8db7b0b 100644
--- a/OvmfPkg/PlatformPei/PlatformPei.inf
+++ b/OvmfPkg/PlatformPei/PlatformPei.inf
@@ -29,6 +29,7 @@
 #

 

 [Sources]

+  AmdSev.c

   Cmos.c

   FeatureControl.c

   Fv.c

@@ -60,6 +61,7 @@
   QemuFwCfgLib

   QemuFwCfgS3Lib

   MtrrLib

+  MemEncryptSevLib

   PcdLib

 

 [Pcd]

@@ -93,6 +95,7 @@
   gEfiMdeModulePkgTokenSpaceGuid.PcdSetNxForStack

   gEfiMdeModulePkgTokenSpaceGuid.PcdPropertiesTableEnable

   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiS3Enable

+  gEfiMdeModulePkgTokenSpaceGuid.PcdPteMemoryEncryptionAddressOrMask

   gUefiCpuPkgTokenSpaceGuid.PcdCpuLocalApicBaseAddress

   gUefiCpuPkgTokenSpaceGuid.PcdCpuMaxLogicalProcessorNumber

   gUefiCpuPkgTokenSpaceGuid.PcdCpuApInitTimeOutInMicroSeconds