MdeModulePkg/SmmLockBoxLib: Support LockBox enlarge in UpdateLockBox()

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=1409

This commit will add the support to enlarge a LockBox when using the
LockBoxLib API UpdateLockBox().

Please note that the new support will ONLY work for LockBox with attribute
LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY set.

The functional uni-test for the commit is available at:
https://github.com/hwu25/edk2/tree/lockbox_unitest

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
Reviewed-by: Ray Ni <ray.ni@intel.com>
Acked-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>

5 files changed, 86 insertions, 10 deletions

diff --git a/MdeModulePkg/Include/Library/LockBoxLib.h b/MdeModulePkg/Include/Library/LockBoxLib.h
index 5921731..b457bd4 100644
--- a/MdeModulePkg/Include/Library/LockBoxLib.h
+++ b/MdeModulePkg/Include/Library/LockBoxLib.h
@@ -2,7 +2,7 @@
   This library is only intended to be used by DXE modules that need save

   confidential information to LockBox and get it by PEI modules in S3 phase.

 

-Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.<BR>

 

 This program and the accompanying materials

 are licensed and made available under the terms and conditions

@@ -85,7 +85,10 @@ SetLockBoxAttributes (
   @retval RETURN_SUCCESS            the information is saved successfully.

   @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or Length is 0.

   @retval RETURN_NOT_FOUND          the requested GUID not found.

-  @retval RETURN_BUFFER_TOO_SMALL   the original buffer to too small to hold new information.

+  @retval RETURN_BUFFER_TOO_SMALL   for lockbox without attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY,

+                                    the original buffer to too small to hold new information.

+  @retval RETURN_OUT_OF_RESOURCES   for lockbox with attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY,

+                                    no enough resource to save the information.

   @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface

   @retval RETURN_NOT_STARTED        it is too early to invoke this interface

   @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.

diff --git a/MdeModulePkg/Library/LockBoxNullLib/LockBoxNullLib.c b/MdeModulePkg/Library/LockBoxNullLib/LockBoxNullLib.c
index c40dfea..0c3a762 100644
--- a/MdeModulePkg/Library/LockBoxNullLib/LockBoxNullLib.c
+++ b/MdeModulePkg/Library/LockBoxNullLib/LockBoxNullLib.c
@@ -1,6 +1,6 @@
 /** @file

 

-Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.<BR>

 

 This program and the accompanying materials

 are licensed and made available under the terms and conditions

@@ -76,7 +76,10 @@ SetLockBoxAttributes (
   @retval RETURN_SUCCESS            the information is saved successfully.

   @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or Length is 0.

   @retval RETURN_NOT_FOUND          the requested GUID not found.

-  @retval RETURN_BUFFER_TOO_SMALL   the original buffer to too small to hold new information.

+  @retval RETURN_BUFFER_TOO_SMALL   for lockbox without attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY,

+                                    the original buffer to too small to hold new information.

+  @retval RETURN_OUT_OF_RESOURCES   for lockbox with attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY,

+                                    no enough resource to save the information.

   @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface

   @retval RETURN_NOT_STARTED        it is too early to invoke this interface

   @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.

diff --git a/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxDxeLib.c b/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxDxeLib.c
index 0428dec..db83226 100644
--- a/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxDxeLib.c
+++ b/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxDxeLib.c
@@ -300,7 +300,10 @@ SetLockBoxAttributes (
   @retval RETURN_SUCCESS            the information is saved successfully.

   @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or Length is 0.

   @retval RETURN_NOT_FOUND          the requested GUID not found.

-  @retval RETURN_BUFFER_TOO_SMALL   the original buffer to too small to hold new information.

+  @retval RETURN_BUFFER_TOO_SMALL   for lockbox without attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY,

+                                    the original buffer to too small to hold new information.

+  @retval RETURN_OUT_OF_RESOURCES   for lockbox with attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY,

+                                    no enough resource to save the information.

   @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface

   @retval RETURN_NOT_STARTED        it is too early to invoke this interface

   @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.

diff --git a/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxPeiLib.c b/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxPeiLib.c
index 8c3e65b..ce23ac0 100644
--- a/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxPeiLib.c
+++ b/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxPeiLib.c
@@ -477,7 +477,10 @@ SetLockBoxAttributes (
   @retval RETURN_SUCCESS            the information is saved successfully.

   @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or Length is 0.

   @retval RETURN_NOT_FOUND          the requested GUID not found.

-  @retval RETURN_BUFFER_TOO_SMALL   the original buffer to too small to hold new information.

+  @retval RETURN_BUFFER_TOO_SMALL   for lockbox without attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY,

+                                    the original buffer to too small to hold new information.

+  @retval RETURN_OUT_OF_RESOURCES   for lockbox with attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY,

+                                    no enough resource to save the information.

   @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface

   @retval RETURN_NOT_STARTED        it is too early to invoke this interface

   @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.

diff --git a/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxSmmLib.c b/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxSmmLib.c
index c912d18..6b5cf32 100644
--- a/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxSmmLib.c
+++ b/MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxSmmLib.c
@@ -604,7 +604,10 @@ SetLockBoxAttributes (
   @retval RETURN_SUCCESS            the information is saved successfully.

   @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or Length is 0.

   @retval RETURN_NOT_FOUND          the requested GUID not found.

-  @retval RETURN_BUFFER_TOO_SMALL   the original buffer to too small to hold new information.

+  @retval RETURN_BUFFER_TOO_SMALL   for lockbox without attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY,

+                                    the original buffer to too small to hold new information.

+  @retval RETURN_OUT_OF_RESOURCES   for lockbox with attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY,

+                                    no enough resource to save the information.

   @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface

   @retval RETURN_NOT_STARTED        it is too early to invoke this interface

   @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.

@@ -619,13 +622,16 @@ UpdateLockBox (
   )

 {

   SMM_LOCK_BOX_DATA             *LockBox;

+  EFI_PHYSICAL_ADDRESS          SmramBuffer;

+  EFI_STATUS                    Status;

 

   DEBUG ((DEBUG_INFO, "SmmLockBoxSmmLib UpdateLockBox - Enter\n"));

 

   //

   // Basic check

   //

-  if ((Guid == NULL) || (Buffer == NULL) || (Length == 0)) {

+  if ((Guid == NULL) || (Buffer == NULL) || (Length == 0) ||

+      (Length > MAX_UINTN - Offset)) {

     DEBUG ((DEBUG_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_INVALID_PARAMETER));

     return EFI_INVALID_PARAMETER;

   }

@@ -643,8 +649,66 @@ UpdateLockBox (
   // Update data

   //

   if (LockBox->Length < Offset + Length) {

-    DEBUG ((DEBUG_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_BUFFER_TOO_SMALL));

-    return EFI_BUFFER_TOO_SMALL;

+    if ((LockBox->Attributes & LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY) != 0) {

+      //

+      // If 'LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY' attribute is set, enlarge the

+      // LockBox.

+      //

+      DEBUG ((

+        DEBUG_INFO,

+        "SmmLockBoxSmmLib UpdateLockBox - Origin LockBox too small, enlarge.\n"

+        ));

+

+      if (EFI_PAGES_TO_SIZE (EFI_SIZE_TO_PAGES ((UINTN)LockBox->Length)) < Offset + Length) {

+        //

+        // In SaveLockBox(), the SMRAM buffer allocated for LockBox is of page

+        // granularity. Here, if the required size is larger than the origin size

+        // of the pages, allocate new buffer from SMRAM to enlarge the LockBox.

+        //

+        DEBUG ((

+          DEBUG_INFO,

+          "SmmLockBoxSmmLib UpdateLockBox - Allocate new buffer to enlarge.\n"

+          ));

+        Status = gSmst->SmmAllocatePages (

+                          AllocateAnyPages,

+                          EfiRuntimeServicesData,

+                          EFI_SIZE_TO_PAGES (Offset + Length),

+                          &SmramBuffer

+                          );

+        if (EFI_ERROR (Status)) {

+          DEBUG ((DEBUG_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_OUT_OF_RESOURCES));

+          return EFI_OUT_OF_RESOURCES;

+        }

+

+        //

+        // Copy origin data to the new SMRAM buffer and wipe the content in the

+        // origin SMRAM buffer.

+        //

+        CopyMem ((VOID *)(UINTN)SmramBuffer, (VOID *)(UINTN)LockBox->SmramBuffer, (UINTN)LockBox->Length);

+        ZeroMem ((VOID *)(UINTN)LockBox->SmramBuffer, (UINTN)LockBox->Length);

+        gSmst->SmmFreePages (LockBox->SmramBuffer, EFI_SIZE_TO_PAGES ((UINTN)LockBox->Length));

+

+        LockBox->SmramBuffer = SmramBuffer;

+      }

+

+      //

+      // Handle uninitialized content in the LockBox.

+      //

+      if (Offset > LockBox->Length) {

+        ZeroMem (

+          (VOID *)((UINTN)LockBox->SmramBuffer + (UINTN)LockBox->Length),

+          Offset - (UINTN)LockBox->Length

+          );

+      }

+      LockBox->Length = Offset + Length;

+    } else {

+      //

+      // If 'LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY' attribute is NOT set, return

+      // EFI_BUFFER_TOO_SMALL directly.

+      //

+      DEBUG ((DEBUG_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_BUFFER_TOO_SMALL));

+      return EFI_BUFFER_TOO_SMALL;

+    }

   }

   ASSERT ((UINTN)LockBox->SmramBuffer <= (MAX_ADDRESS - Offset));

   CopyMem ((VOID *)((UINTN)LockBox->SmramBuffer + Offset), Buffer, Length);