UefiCpuPkg/AmdSvsmLib: Create the AmdSvsmLib library to support an SVSM

BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=4654

In order to support an SEV-SNP guest running under an SVSM at VMPL1 or
lower, a new library must be created.

This library includes an interface to detect if running under an SVSM, an
interface to return the current VMPL, an interface to perform memory
validation and an interface to set or clear the attribute that allows a
page to be used as a VMSA.

Cc: Gerd Hoffmann <kraxel@redhat.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Rahul Kumar <rahul1.kumar@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Acked-by: Gerd Hoffmann <kraxel@redhat.com>
Signed-off-by: Tom Lendacky <thomas.lendacky@amd.com>
Acked-by: Ray Ni <ray.ni@intel.com>

6 files changed, 255 insertions, 1 deletions

diff --git a/UefiCpuPkg/Include/Library/AmdSvsmLib.h b/UefiCpuPkg/Include/Library/AmdSvsmLib.h
new file mode 100644
index 0000000000..40e0e5bd42
--- /dev/null
+++ b/UefiCpuPkg/Include/Library/AmdSvsmLib.h
@@ -0,0 +1,101 @@
+/** @file

+  Public header file for the AmdSvsmLib.

+

+  This library class defines some routines used for invoking an SVSM when the

+  guest is not running at VMPL0.

+

+  Copyright (C) 2024, Advanced Micro Devices, Inc. All rights reserved.<BR>

+  SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#ifndef AMD_SVSM_LIB_H_

+#define AMD_SVSM_LIB_H_

+

+#include <Protocol/DebugSupport.h>

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

+

+/**

+  Report the presence of an Secure Virtual Services Module (SVSM).

+

+  Determines the presence of an SVSM.

+

+  @retval  TRUE                   An SVSM is present

+  @retval  FALSE                  An SVSM is not present

+

+**/

+BOOLEAN

+EFIAPI

+AmdSvsmIsSvsmPresent (

+  VOID

+  );

+

+/**

+  Report the VMPL level at which the SEV-SNP guest is running.

+

+  Determines the VMPL level at which the guest is running. If an SVSM is

+  not present, then it must be VMPL0, otherwise return what is reported

+  by the SVSM.

+

+  @return                         The VMPL level

+

+**/

+UINT8

+EFIAPI

+AmdSvsmSnpGetVmpl (

+  VOID

+  );

+

+/**

+  Report the Calling Area address (CAA) for the BSP of the SEV-SNP guest.

+

+  If an SVSM is present, the CAA for the BSP is returned.

+

+  @return                         The CAA

+

+**/

+UINT64

+EFIAPI

+AmdSvsmSnpGetCaa (

+  VOID

+  );

+

+/**

+  Perform a PVALIDATE operation for the page ranges specified.

+

+  Validate or rescind the validation of the specified pages.

+

+  @param[in]       Info           Pointer to a page state change structure

+

+**/

+VOID

+EFIAPI

+AmdSvsmSnpPvalidate (

+  IN SNP_PAGE_STATE_CHANGE_INFO  *Info

+  );

+

+/**

+  Perform an RMPADJUST operation to alter the VMSA setting of a page.

+

+  Add or remove the VMSA attribute for a page.

+

+  @param[in]       Vmsa           Pointer to an SEV-ES save area page

+  @param[in]       ApicId         APIC ID associated with the VMSA

+  @param[in]       SetVmsa        Boolean indicator as to whether to set or

+                                  or clear the VMSA setting for the page

+

+  @retval  EFI_SUCCESS            RMPADJUST operation successful

+  @retval  EFI_UNSUPPORTED        Operation is not supported

+  @retval  EFI_INVALID_PARAMETER  RMPADJUST operation failed, an invalid

+                                  parameter was supplied

+

+**/

+EFI_STATUS

+EFIAPI

+AmdSvsmSnpVmsaRmpAdjust (

+  IN SEV_ES_SAVE_AREA  *Vmsa,

+  IN UINT32            ApicId,

+  IN BOOLEAN           SetVmsa

+  );

+

+#endif

diff --git a/UefiCpuPkg/Library/AmdSvsmLibNull/AmdSvsmLibNull.c b/UefiCpuPkg/Library/AmdSvsmLibNull/AmdSvsmLibNull.c
new file mode 100644
index 0000000000..a83fcbd6ce
--- /dev/null
+++ b/UefiCpuPkg/Library/AmdSvsmLibNull/AmdSvsmLibNull.c
@@ -0,0 +1,108 @@
+/** @file

+  AmdSvsm Base Support Library.

+

+  Copyright (C) 2024, Advanced Micro Devices, Inc. All rights reserved.<BR>

+  SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#include <Base.h>

+#include <Uefi.h>

+#include <Library/AmdSvsmLib.h>

+

+/**

+  Report the presence of an Secure Virtual Services Module (SVSM).

+

+  Determines the presence of an SVSM.

+

+  @retval  TRUE                   An SVSM is present

+  @retval  FALSE                  An SVSM is not present

+

+**/

+BOOLEAN

+EFIAPI

+AmdSvsmIsSvsmPresent (

+  VOID

+  )

+{

+  return FALSE;

+}

+

+/**

+  Report the VMPL level at which the SEV-SNP guest is running.

+

+  Determines the VMPL level at which the guest is running. If an SVSM is

+  not present, then it must be VMPL0, otherwise return what is reported

+  by the SVSM.

+

+  @return                         The VMPL level

+

+**/

+UINT8

+EFIAPI

+AmdSvsmSnpGetVmpl (

+  VOID

+  )

+{

+  return 0;

+}

+

+/**

+  Report the Calling Area address (CAA) for the BSP of the SEV-SNP guest.

+

+  If an SVSM is present, the CAA for the BSP is returned.

+

+  @return                         The CAA

+

+**/

+UINT64

+EFIAPI

+AmdSvsmSnpGetCaa (

+  VOID

+  )

+{

+  return 0;

+}

+

+/**

+  Perform a PVALIDATE operation for the page ranges specified.

+

+  Validate or rescind the validation of the specified pages.

+

+  @param[in]       Info           Pointer to a page state change structure

+

+**/

+VOID

+EFIAPI

+AmdSvsmSnpPvalidate (

+  IN SNP_PAGE_STATE_CHANGE_INFO  *Info

+  )

+{

+}

+

+/**

+  Perform an RMPADJUST operation to alter the VMSA setting of a page.

+

+  Add or remove the VMSA attribute for a page.

+

+  @param[in]       Vmsa           Pointer to an SEV-ES save area page

+  @param[in]       ApicId         APIC ID associated with the VMSA

+  @param[in]       SetVmsa        Boolean indicator as to whether to set or

+                                  or clear the VMSA setting for the page

+

+  @retval  EFI_SUCCESS            RMPADJUST operation successful

+  @retval  EFI_UNSUPPORTED        Operation is not supported

+  @retval  EFI_INVALID_PARAMETER  RMPADJUST operation failed, an invalid

+                                  parameter was supplied

+

+**/

+EFI_STATUS

+EFIAPI

+AmdSvsmSnpVmsaRmpAdjust (

+  IN SEV_ES_SAVE_AREA  *Vmsa,

+  IN UINT32            ApicId,

+  IN BOOLEAN           SetVmsa

+  )

+{

+  return EFI_UNSUPPORTED;

+}

diff --git a/UefiCpuPkg/Library/AmdSvsmLibNull/AmdSvsmLibNull.inf b/UefiCpuPkg/Library/AmdSvsmLibNull/AmdSvsmLibNull.inf
new file mode 100644
index 0000000000..45a1895409
--- /dev/null
+++ b/UefiCpuPkg/Library/AmdSvsmLibNull/AmdSvsmLibNull.inf
@@ -0,0 +1,27 @@
+## @file

+#  AmdSvsm Base Support Library.

+#

+#  Copyright (C) 2024, Advanced Micro Devices, Inc. All rights reserved.<BR>

+#  SPDX-License-Identifier: BSD-2-Clause-Patent

+#

+##

+

+[Defines]

+  INF_VERSION                    = 1.29

+  BASE_NAME                      = AmdSvsmLibNull

+  MODULE_UNI_FILE                = AmdSvsmLibNull.uni

+  FILE_GUID                      = 62b45e0f-c9b4-45ce-a5b3-41762709b3d9

+  MODULE_TYPE                    = BASE

+  VERSION_STRING                 = 1.0

+  LIBRARY_CLASS                  = AmdSvsmLib

+

+[Sources.common]

+  AmdSvsmLibNull.c

+

+[Packages]

+  MdePkg/MdePkg.dec

+  UefiCpuPkg/UefiCpuPkg.dec

+

+[LibraryClasses]

+  BaseLib

+

diff --git a/UefiCpuPkg/Library/AmdSvsmLibNull/AmdSvsmLibNull.uni b/UefiCpuPkg/Library/AmdSvsmLibNull/AmdSvsmLibNull.uni
new file mode 100644
index 0000000000..5e998030de
--- /dev/null
+++ b/UefiCpuPkg/Library/AmdSvsmLibNull/AmdSvsmLibNull.uni
@@ -0,0 +1,13 @@
+// /** @file

+// AmdSvsmLib instance.

+//

+// Copyright (C) 2024, Advanced Micro Devices, Inc. All rights reserved.<BR>

+// SPDX-License-Identifier: BSD-2-Clause-Patent

+//

+// **/

+

+

+#string STR_MODULE_ABSTRACT             #language en-US "AmdSvsmLib NULL instance"

+

+#string STR_MODULE_DESCRIPTION          #language en-US "AmdSvsmLib NULL instance."

+

diff --git a/UefiCpuPkg/UefiCpuPkg.dec b/UefiCpuPkg/UefiCpuPkg.dec
index da85e79731..f412ac0ce2 100644
--- a/UefiCpuPkg/UefiCpuPkg.dec
+++ b/UefiCpuPkg/UefiCpuPkg.dec
@@ -53,6 +53,9 @@
   ##  @libraryclass  Provides function to support CcExit processing.

   CcExitLib|Include/Library/CcExitLib.h

 

+  ##  @libraryclass  Provides function to support AmdSvsm processing.

+  AmdSvsmLib|Include/Library/AmdSvsmLib.h

+

   ##  @libraryclass  Provides function to get CPU cache information.

   CpuCacheInfoLib|Include/Library/CpuCacheInfoLib.h

 

diff --git a/UefiCpuPkg/UefiCpuPkg.dsc b/UefiCpuPkg/UefiCpuPkg.dsc
index 1af5a0c525..9426641eb2 100644
--- a/UefiCpuPkg/UefiCpuPkg.dsc
+++ b/UefiCpuPkg/UefiCpuPkg.dsc
@@ -2,7 +2,7 @@
 #  UefiCpuPkg Package

 #

 #  Copyright (c) 2007 - 2023, Intel Corporation. All rights reserved.<BR>

-#  Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.<BR>

+#  Copyright (C) 2023 - 2024, Advanced Micro Devices, Inc. All rights reserved.<BR>

 #

 #  SPDX-License-Identifier: BSD-2-Clause-Patent

 #

@@ -61,6 +61,7 @@
   PeCoffExtraActionLib|MdePkg/Library/BasePeCoffExtraActionLibNull/BasePeCoffExtraActionLibNull.inf

   TpmMeasurementLib|MdeModulePkg/Library/TpmMeasurementLibNull/TpmMeasurementLibNull.inf

   CcExitLib|UefiCpuPkg/Library/CcExitLibNull/CcExitLibNull.inf

+  AmdSvsmLib|UefiCpuPkg/Library/AmdSvsmLibNull/AmdSvsmLibNull.inf

   MicrocodeLib|UefiCpuPkg/Library/MicrocodeLib/MicrocodeLib.inf

   SmmCpuRendezvousLib|UefiCpuPkg/Library/SmmCpuRendezvousLib/SmmCpuRendezvousLib.inf

   CpuPageTableLib|UefiCpuPkg/Library/CpuPageTableLib/CpuPageTableLib.inf

@@ -162,6 +163,7 @@
   UefiCpuPkg/Library/SmmCpuFeaturesLib/StandaloneMmCpuFeaturesLib.inf

   UefiCpuPkg/Library/SmmCpuSyncLib/SmmCpuSyncLib.inf

   UefiCpuPkg/Library/CcExitLibNull/CcExitLibNull.inf

+  UefiCpuPkg/Library/AmdSvsmLibNull/AmdSvsmLibNull.inf

   UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationPei.inf

   UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.inf

   UefiCpuPkg/SecCore/SecCore.inf