From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.120; helo=mga04.intel.com; envelope-from=star.zeng@intel.com; receiver=edk2-devel@lists.01.org Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 0C8E6208AE346 for ; Thu, 14 Feb 2019 21:14:30 -0800 (PST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 14 Feb 2019 21:14:30 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,371,1544515200"; d="scan'208";a="126660376" Received: from shzintpr02.sh.intel.com (HELO [10.7.209.27]) ([10.239.4.160]) by orsmga003.jf.intel.com with ESMTP; 14 Feb 2019 21:14:28 -0800 To: Hao Wu , edk2-devel@lists.01.org References: <20190211075738.16676-1-hao.a.wu@intel.com> <20190211075738.16676-13-hao.a.wu@intel.com> Cc: star.zeng@intel.com From: "Zeng, Star" Message-ID: <35f5e873-7b32-ba28-c9cb-0d8d4050a067@intel.com> Date: Fri, 15 Feb 2019 13:13:58 +0800 User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64; rv:60.0) Gecko/20100101 Thunderbird/60.5.0 MIME-Version: 1.0 In-Reply-To: <20190211075738.16676-13-hao.a.wu@intel.com> Subject: Re: [PATCH v4 11/13] MdeModulePkg/SmmLockBoxLib: Support LockBox enlarge in UpdateLockBox() X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 15 Feb 2019 05:14:31 -0000 Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Some minor comments. With them addressed, Reviewed-by: Star Zeng . On 2019/2/11 15:57, Hao Wu wrote: > 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 > Cc: Ray Ni > Cc: Star Zeng > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Hao Wu > Reviewed-by: Ray Ni > Acked-by: Laszlo Ersek > --- > MdeModulePkg/Include/Library/LockBoxLib.h | 7 +- > MdeModulePkg/Library/LockBoxNullLib/LockBoxNullLib.c | 7 +- > MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxDxeLib.c | 5 +- > MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxPeiLib.c | 5 +- > MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxSmmLib.c | 72 ++++++++++++++++++-- > 5 files changed, 86 insertions(+), 10 deletions(-) > > diff --git a/MdeModulePkg/Include/Library/LockBoxLib.h b/MdeModulePkg/Include/Library/LockBoxLib.h > index 5921731419..addce3bd4a 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.
> +Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.
> > 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 with attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE, Here, the description should be "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 c40dfea398..0adda1e2a9 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.
> +Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.
> > 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 with attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE, > + 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 0428decbac..5ee563b71f 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 with attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE, > + 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 8c3e65bc96..19fdd995c6 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 with attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE, > + 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 c912d187a4..d1cff97ba1 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 with attribute LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE, > + 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 (LockBox->Length)) < Offset + Length) { Need add (UINTN) type cast before LockBox->Length. Thanks, Star > + // > + // 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 potential 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); >