From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 134.134.136.126, mailfrom: hao.a.wu@intel.com) Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) by groups.io with SMTP; Thu, 03 Oct 2019 01:04:37 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga005.jf.intel.com ([10.7.209.41]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 03 Oct 2019 01:04:37 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.67,251,1566889200"; d="scan'208";a="366971263" Received: from fmsmsx103.amr.corp.intel.com ([10.18.124.201]) by orsmga005.jf.intel.com with ESMTP; 03 Oct 2019 01:04:36 -0700 Received: from fmsmsx154.amr.corp.intel.com (10.18.116.70) by FMSMSX103.amr.corp.intel.com (10.18.124.201) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 3 Oct 2019 01:04:36 -0700 Received: from shsmsx101.ccr.corp.intel.com (10.239.4.153) by FMSMSX154.amr.corp.intel.com (10.18.116.70) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 3 Oct 2019 01:04:35 -0700 Received: from shsmsx104.ccr.corp.intel.com ([169.254.5.166]) by SHSMSX101.ccr.corp.intel.com ([169.254.1.96]) with mapi id 14.03.0439.000; Thu, 3 Oct 2019 16:04:32 +0800 From: "Wu, Hao A" To: "Kubacki, Michael A" , "devel@edk2.groups.io" CC: "Bi, Dandan" , Ard Biesheuvel , "Dong, Eric" , Laszlo Ersek , "Gao, Liming" , "Kinney, Michael D" , "Ni, Ray" , "Wang, Jian J" , "Yao, Jiewen" Subject: Re: [PATCH V2 7/9] MdeModulePkg/Variable: Add RT GetVariable() cache support Thread-Topic: [PATCH V2 7/9] MdeModulePkg/Variable: Add RT GetVariable() cache support Thread-Index: AQHVdZ68oSYHi0EfNkyFbThKCzvSRqdDzt8g Date: Thu, 3 Oct 2019 08:04:32 +0000 Message-ID: References: <20190928014717.31372-1-michael.a.kubacki@intel.com> <20190928014717.31372-8-michael.a.kubacki@intel.com> In-Reply-To: <20190928014717.31372-8-michael.a.kubacki@intel.com> Accept-Language: zh-CN, en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Return-Path: hao.a.wu@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Before any comment on the patch, since I am not experienced in the Variable driver, I would like to ask for help from other reviewers to look into this patch and provide feedbacks as well. Thanks in advance. With the above fact, some comments provided below maybe wrong. So please he= lp to kindly correct me. Some general comments: 1. I am not sure if bringing the TimerLib dependency (delay in acquiring th= e runtime cache read lock) to variable driver (a software driver for the m= ost part) is a good idea. =20 Hope other reviewers can provide some feedbacks for this. Thanks in adva= nce. 2. In my opinion, I prefer a switch can be provided for platform owners to choose between using the runtime cache and going through SMM for GetVari= able (and for GetNextVariableName in the next patch as well). =20 If platform owners feel uncomfortable with using the runtime cache with regard to the security perspective, they can switch to the origin soluti= on. 3. Please help to remove the 'EFIAPI' keyword for new driver internal funct= ions; Inline comments below: > -----Original Message----- > From: Kubacki, Michael A > Sent: Saturday, September 28, 2019 9:47 AM > To: devel@edk2.groups.io > Cc: Bi, Dandan; Ard Biesheuvel; Dong, Eric; Laszlo Ersek; Gao, Liming; Ki= nney, > Michael D; Ni, Ray; Wang, Jian J; Wu, Hao A; Yao, Jiewen > Subject: [PATCH V2 7/9] MdeModulePkg/Variable: Add RT GetVariable() > cache support >=20 > REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3D2220 >=20 > This change reduces SMIs for GetVariable () by maintaining a > UEFI variable cache in Runtime DXE in addition to the pre- > existing cache in SMRAM. When the Runtime Service GetVariable() > is invoked, a Runtime DXE cache is used instead of triggering an > SMI to VariableSmm. This can improve overall system performance > by servicing variable read requests without rendezvousing all > cores into SMM. >=20 > The following are important points regarding this change. >=20 > 1. All of the non-volatile storage contents are loaded into the > cache upon driver load. This one time load operation from storage > is preferred as opposed to building the cache on demand. An on- > demand cache would require a fallback SMI to load data into the > cache as variables are requested. >=20 > 2. SetVariable () requests will continue to always trigger an SMI. > This occurs regardless of whether the variable is volatile or > non-volatile. >=20 > 3. Both volatile and non-volatile variables are cached in a runtime > buffer. As is the case in the current EDK II variable driver, they > continue to be cached in separate buffers. >=20 > 4. The cache in Runtime DXE and SMM are intended to be exact copies > of one another. All SMM variable accesses only return data from the > SMM cache. The runtime caches are only updated after the variable I/O > operation is successful in SMM. The runtime caches are only updated > from SMM. >=20 > 5. Synchronization mechanisms are in place to ensure the runtime cache > content integrity with the SMM cache. These may result in updates to > runtime cache that are the same in content but different in offset and > size from updates to the SMM cache. >=20 > When using SMM variables, two caches will now be present. > 1. "Runtime Cache" - Maintained in VariableSmmRuntimeDxe. Used to > service > Runtime Services GetVariable () and GetNextVariableName () callers. > 2. "SMM Cache" - Maintained in VariableSmm to service SMM GetVariable () > and GetNextVariableName () callers. > a. This cache is retained so SMM modules do not operate on data outsid= e > SMRAM. >=20 > It is possible to view UEFI variable read and write statistics by setting > the gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics > FeaturePcd > to TRUE and using the VariableInfo UEFI application in MdeModulePkg to > dump > variable statistics to the console. By doing so, a user can view the numb= er > of GetVariable () hits from the Runtime DXE variable driver (Runtime Cach= e > hits) and the SMM variable driver (SMM Cache hits). SMM Cache hits for > GetVariable () will occur when SMM modules invoke GetVariable (). >=20 > Cc: Dandan Bi > Cc: Ard Biesheuvel > Cc: Eric Dong > Cc: Laszlo Ersek > Cc: Liming Gao > Cc: Michael D Kinney > Cc: Ray Ni > Cc: Jian J Wang > Cc: Hao A Wu > Cc: Jiewen Yao > Signed-off-by: Michael Kubacki > --- > MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf > | 2 + > MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf | = 2 > + >=20 > MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.i > nf | 31 +- >=20 > MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf > | 2 + > MdeModulePkg/Include/Guid/SmmVariableCommon.h | = 29 +- > MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h | = 39 +- > MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeCache.h > | 47 ++ > MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c | = 44 +- > MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeCache.c > | 153 +++++ > MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c | 1= 14 > +++- >=20 > MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe. > c | 608 +++++++++++++++++--- > 11 files changed, 966 insertions(+), 105 deletions(-) >=20 > diff --git > a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf > index 08a5490787..ceea5d1ff9 100644 > --- > a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf > +++ > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf > @@ -40,6 +40,8 @@ > VariableNonVolatile.h > VariableParsing.c > VariableParsing.h > + VariableRuntimeCache.c > + VariableRuntimeCache.h Per my understanding, the module specified by VariableRuntimeDxe.inf does n= ot involve SMM/SMI for variable services (like GetVariable). It looks weird to= me for this INF to include the newly introduced runtime cache codes (below sou= rce header files): VariableRuntimeCache.c VariableRuntimeCache.h > PrivilegePolymorphic.h > Measurement.c > TcgMorLockDxe.c > diff --git > a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf > index 6dc2721b81..bc3033588d 100644 > --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf > +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf > @@ -49,6 +49,8 @@ > VariableNonVolatile.h > VariableParsing.c > VariableParsing.h > + VariableRuntimeCache.c > + VariableRuntimeCache.h > VarCheck.c > Variable.h > PrivilegePolymorphic.h > diff --git > a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDx > e.inf > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDx > e.inf > index 14894e6f13..70837ac6e0 100644 > --- > a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDx > e.inf > +++ > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDx > e.inf > @@ -13,7 +13,7 @@ > # may not be modified without authorization. If platform fails to prote= ct > these resources, > # the authentication service provided in this driver will be broken, an= d the > behavior is undefined. > # > -# Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.
> +# Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.
> # SPDX-License-Identifier: BSD-2-Clause-Patent > # > ## > @@ -39,6 +39,10 @@ > VariableSmmRuntimeDxe.c > PrivilegePolymorphic.h > Measurement.c > + VariableParsing.c > + VariableParsing.h > + VariableRuntimeCache.c > + VariableRuntimeCache.h >=20 > [Packages] > MdePkg/MdePkg.dec > @@ -49,6 +53,7 @@ > BaseLib > UefiBootServicesTableLib > DebugLib > + TimerLib > UefiRuntimeLib > DxeServicesTableLib > UefiDriverEntryPoint > @@ -65,7 +70,29 @@ > gEdkiiVariableLockProtocolGuid ## PRODUCES > gEdkiiVarCheckProtocolGuid ## PRODUCES >=20 > +[Pcd] > + gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize = ## > CONSUMES > + gEfiMdeModulePkgTokenSpaceGuid.PcdMaxAuthVariableSize = ## > CONSUMES > + gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize > ## CONSUMES > + gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize = ## > CONSUMES > + gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize = ## > CONSUMES > + gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize > ## CONSUMES > + > gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpace > Size ## CONSUMES Not sure if the above PCDs are really needed by VariableSmmRuntimeDxe. > + > +[FeaturePcd] > + gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics = ## > CONSUMES > + > [Guids] > + ## PRODUCES ## GUID # Signature of Variable store header > + ## CONSUMES ## GUID # Signature of Variable store header > + ## SOMETIMES_PRODUCES ## SystemTable > + gEfiAuthenticatedVariableGuid > + > + ## PRODUCES ## GUID # Signature of Variable store header > + ## CONSUMES ## GUID # Signature of Variable store header > + ## SOMETIMES_PRODUCES ## SystemTable > + gEfiVariableGuid > + > gEfiEventVirtualAddressChangeGuid ## CONSUMES ## Event > gEfiEventExitBootServicesGuid ## CONSUMES ## Event > ## CONSUMES ## GUID # Locate protocol > @@ -82,6 +109,8 @@ > ## SOMETIMES_CONSUMES ## Variable:L"dbt" > gEfiImageSecurityDatabaseGuid >=20 > + gEdkiiPiSmmCommunicationRegionTableGuid ## > SOMETIMES_CONSUMES ## SystemTable > + > [Depex] > gEfiSmmCommunicationProtocolGuid >=20 > diff --git > a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.i > nf > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm. > inf > index ca9d23ce9f..95c5310c0b 100644 > --- > a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.i > nf > +++ > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm. > inf > @@ -49,6 +49,8 @@ > VariableNonVolatile.h > VariableParsing.c > VariableParsing.h > + VariableRuntimeCache.c > + VariableRuntimeCache.h > VarCheck.c > Variable.h > PrivilegePolymorphic.h > diff --git a/MdeModulePkg/Include/Guid/SmmVariableCommon.h > b/MdeModulePkg/Include/Guid/SmmVariableCommon.h > index c527a59891..ceef44dfd2 100644 > --- a/MdeModulePkg/Include/Guid/SmmVariableCommon.h > +++ b/MdeModulePkg/Include/Guid/SmmVariableCommon.h > @@ -1,7 +1,7 @@ > /** @file > The file defined some common structures used for communicating > between SMM variable module and SMM variable wrapper module. >=20 > -Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.
> +Copyright (c) 2011 - 2019, Intel Corporation. All rights reserved.
> SPDX-License-Identifier: BSD-2-Clause-Patent >=20 > **/ > @@ -9,6 +9,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent > #ifndef _SMM_VARIABLE_COMMON_H_ > #define _SMM_VARIABLE_COMMON_H_ >=20 > +#include > #include >=20 > #define EFI_SMM_VARIABLE_WRITE_GUID \ > @@ -66,6 +67,16 @@ typedef struct { > #define > SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_GET 10 >=20 > #define SMM_VARIABLE_FUNCTION_GET_PAYLOAD_SIZE 11 > +// > +// The payload for this function is > SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT > +// > +#define > SMM_VARIABLE_FUNCTION_INIT_RUNTIME_VARIABLE_CACHE_CONTEXT > 12 > + > +#define SMM_VARIABLE_FUNCTION_SYNC_RUNTIME_CACHE 13 > +// > +// The payload for this function is > SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO > +// > +#define SMM_VARIABLE_FUNCTION_GET_RUNTIME_CACHE_INFO > 14 >=20 > /// > /// Size of SMM communicate header, without including the payload. > @@ -120,4 +131,20 @@ typedef struct { > UINTN VariablePayloadSize; > } SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE; >=20 > +typedef struct { > + BOOLEAN *ReadLock; > + BOOLEAN *PendingUpdate; > + BOOLEAN *HobFlushComplete; > + VARIABLE_STORE_HEADER *RuntimeHobCache; > + VARIABLE_STORE_HEADER *RuntimeNvCache; > + VARIABLE_STORE_HEADER *RuntimeVolatileCache; > +} > SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT; > + > +typedef struct { > + UINTN TotalHobStorageSize; > + UINTN TotalNvStorageSize; > + UINTN TotalVolatileStorageSize; > + BOOLEAN AuthenticatedVariableUsage; > +} SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO; > + > #endif // _SMM_VARIABLE_COMMON_H_ > diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h > b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h > index fb574b2e32..b9723c0250 100644 > --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h > +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h > @@ -57,6 +57,12 @@ SPDX-License-Identifier: BSD-2-Clause-Patent > /// > #define ISO_639_2_ENTRY_SIZE 3 >=20 > +/// > +/// The timeout to in 10us units to wait for the > +/// variable runtime cache read lock to be acquired. > +/// > +#define VARIABLE_RT_CACHE_READ_LOCK_TIMEOUT 200000 > + > typedef enum { > VariableStoreTypeVolatile, > VariableStoreTypeHob, > @@ -64,6 +70,21 @@ typedef enum { > VariableStoreTypeMax > } VARIABLE_STORE_TYPE; >=20 > +typedef struct { > + UINT32 PendingUpdateOffset; > + UINT32 PendingUpdateLength; > + VARIABLE_STORE_HEADER *Store; > +} VARIABLE_RUNTIME_CACHE; > + > +typedef struct { > + BOOLEAN *ReadLock; > + BOOLEAN *PendingUpdate; > + BOOLEAN *HobFlushComplete; > + VARIABLE_RUNTIME_CACHE VariableRuntimeHobCache; > + VARIABLE_RUNTIME_CACHE VariableRuntimeNvCache; > + VARIABLE_RUNTIME_CACHE VariableRuntimeVolatileCache; > +} VARIABLE_RUNTIME_CACHE_CONTEXT; > + > typedef struct { > VARIABLE_HEADER *CurrPtr; > // > @@ -79,14 +100,16 @@ typedef struct { > } VARIABLE_POINTER_TRACK; >=20 > typedef struct { > - EFI_PHYSICAL_ADDRESS HobVariableBase; > - EFI_PHYSICAL_ADDRESS VolatileVariableBase; > - EFI_PHYSICAL_ADDRESS NonVolatileVariableBase; > - EFI_LOCK VariableServicesLock; > - UINT32 ReentrantState; > - BOOLEAN AuthFormat; > - BOOLEAN AuthSupport; > - BOOLEAN EmuNvMode; > + EFI_PHYSICAL_ADDRESS HobVariableBase; > + EFI_PHYSICAL_ADDRESS HobVariableBackupBase; I do not see any usage of the new field "HobVariableBackupBase". Could you help to double confirm? > + EFI_PHYSICAL_ADDRESS VolatileVariableBase; > + EFI_PHYSICAL_ADDRESS NonVolatileVariableBase; > + VARIABLE_RUNTIME_CACHE_CONTEXT VariableRuntimeCacheContext; > + EFI_LOCK VariableServicesLock; > + UINT32 ReentrantState; > + BOOLEAN AuthFormat; > + BOOLEAN AuthSupport; > + BOOLEAN EmuNvMode; > } VARIABLE_GLOBAL; >=20 > typedef struct { > diff --git > a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeCache.h > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeCache. > h > new file mode 100644 > index 0000000000..09b83eb215 > --- /dev/null > +++ > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeCache. > h > @@ -0,0 +1,47 @@ > +/** @file > + The common variable volatile store routines shared by the DXE_RUNTIME > variable > + module and the DXE_SMM variable module. > + > +Copyright (c) 2019, Intel Corporation. All rights reserved.
> +SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#ifndef _VARIABLE_RUNTIME_CACHE_H_ > +#define _VARIABLE_RUNTIME_CACHE_H_ > + > +#include "Variable.h" > + > +/** > + Copies any pending updates to runtime variable caches. > + > + @retval EFI_UNSUPPORTED The volatile store to be updated is no= t > initialized properly. > + @retval EFI_SUCCESS The volatile store was updated success= fully. > + > +**/ > +EFI_STATUS > +SynchronizeRuntimeVariableCacheEx ( > + VOID > + ); > + > +/** > + Synchronizes the runtime variable caches with all pending updates outs= ide > runtime. > + > + Ensures all conditions are met to maintain coherency for runtime cache > updates. > + > + @param[in] VariableRuntimeCache Variable runtime cache structure for > the runtime cache being synchronized. > + @param[in] Offset Offset in bytes to apply the update. > + @param[in] Length Length of data in bytes of the update. > + > + @retval EFI_UNSUPPORTED The volatile store to be updated is no= t > initialized properly. > + @retval EFI_SUCCESS The volatile store was updated success= fully. > + > +**/ > +EFI_STATUS > +SynchronizeRuntimeVariableCache ( > + IN VARIABLE_RUNTIME_CACHE *VariableRuntimeCache, > + IN UINTN Offset, > + IN UINTN Length > + ); > + > +#endif > diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c > b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c > index 5da2354aa5..bb2fa3fc19 100644 > --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c > +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c > @@ -25,6 +25,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent > #include "Variable.h" > #include "VariableNonVolatile.h" > #include "VariableParsing.h" > +#include "VariableRuntimeCache.h" >=20 > VARIABLE_MODULE_GLOBAL *mVariableModuleGlobal; >=20 > @@ -332,6 +333,12 @@ RecordVarErrorFlag ( > // Update the data in NV cache. > // > *VarErrFlag =3D TempFlag; > + Status =3D SynchronizeRuntimeVariableCache ( > + &mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeNvCache, > + (UINTN) VarErrFlag - (UINTN) mNvVariableCache + (UINTN= ) > mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase, > + sizeof (TempFlag) > + ); > + ASSERT_EFI_ERROR (Status); > } > } > } > @@ -755,12 +762,24 @@ Reclaim ( >=20 > Done: > if (IsVolatile || mVariableModuleGlobal->VariableGlobal.EmuNvMode) { > + Status =3D SynchronizeRuntimeVariableCache ( > + &mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeVolatileCach > e, > + 0, > + VariableStoreHeader->Size > + ); > + ASSERT_EFI_ERROR (Status); > FreePool (ValidBuffer); > } else { > // > // For NV variable reclaim, we use mNvVariableCache as the buffer, s= o > copy the data back. > // > - CopyMem (mNvVariableCache, (UINT8 *)(UINTN)VariableBase, > VariableStoreHeader->Size); > + CopyMem (mNvVariableCache, (UINT8 *) (UINTN) VariableBase, > VariableStoreHeader->Size); > + Status =3D SynchronizeRuntimeVariableCache ( > + &(mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeNvCache), > + 0, > + VariableStoreHeader->Size > + ); > + ASSERT_EFI_ERROR (Status); > } >=20 > return Status; > @@ -1592,6 +1611,7 @@ UpdateVariable ( > VARIABLE_POINTER_TRACK *Variable; > VARIABLE_POINTER_TRACK NvVariable; > VARIABLE_STORE_HEADER *VariableStoreHeader; > + VARIABLE_RUNTIME_CACHE *VolatileCacheInstance; > UINT8 *BufferForMerge; > UINTN MergedBufSize; > BOOLEAN DataReady; > @@ -2235,6 +2255,21 @@ UpdateVariable ( > } >=20 > Done: > + if (!EFI_ERROR (Status)) { > + if (Variable->Volatile) { > + VolatileCacheInstance =3D &(mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeVolatileCach > e); > + } else { > + VolatileCacheInstance =3D &(mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeNvCache); > + } > + > + Status =3D SynchronizeRuntimeVariableCache ( > + VolatileCacheInstance, > + 0, > + VolatileCacheInstance->Store->Size > + ); > + ASSERT_EFI_ERROR (Status); > + } > + > return Status; > } >=20 > @@ -3409,6 +3444,12 @@ FlushHobVariableToFlash ( > ErrorFlag =3D TRUE; > } > } > + Status =3D SynchronizeRuntimeVariableCache ( > + &mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeHobCache, > + 0, > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeHobCache.S > tore->Size > + ); > + ASSERT_EFI_ERROR (Status); > if (ErrorFlag) { > // > // We still have HOB variable(s) not flushed in flash. > @@ -3419,6 +3460,7 @@ FlushHobVariableToFlash ( > // All HOB variables have been flushed in flash. > // > DEBUG ((EFI_D_INFO, "Variable driver: all HOB variables have been > flushed in flash.\n")); > + *(mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.HobFlushComplete) =3D TRUE; > if (!AtRuntime ()) { > FreePool ((VOID *) VariableStoreHeader); > } > diff --git > a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeCache.c > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeCache.c > new file mode 100644 > index 0000000000..2642d9b000 > --- /dev/null > +++ > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeCache.c > @@ -0,0 +1,153 @@ > +/** @file > + The common variable volatile store routines shared by the DXE_RUNTIME > variable > + module and the DXE_SMM variable module. > + > + Caution: This module requires additional review when modified. > + This driver will have external input - variable data. They may be inpu= t in > SMM mode. > + This external input must be validated carefully to avoid security issu= e like > + buffer overflow, integer overflow. > + > +Copyright (c) 2019, Intel Corporation. All rights reserved.
> +SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#include "VariableParsing.h" > +#include "VariableRuntimeCache.h" > + > +extern VARIABLE_MODULE_GLOBAL *mVariableModuleGlobal; > +extern VARIABLE_STORE_HEADER *mNvVariableCache; > + > +/** > + Copies any pending updates to runtime variable caches. > + > + @retval EFI_UNSUPPORTED The volatile store to be updated is no= t > initialized properly. > + @retval EFI_SUCCESS The volatile store was updated success= fully. > + > +**/ > +EFI_STATUS > +SynchronizeRuntimeVariableCacheEx ( It is not clear to me why this function is named as the "Ex" version of fun= ction SynchronizeRuntimeVariableCache(). For me, this function looks more like a = basic version. I would suggest a name change for the functions provided in file VariableRuntimeCache.c to better reflect their usage model. > + VOID > + ) > +{ I would recommend that at least a local variable should be introduced to re= duce the duplications of: "mVariableModuleGlobal->VariableGlobal.VariableRuntimeCacheContext" in this function in order to make it easier to read. > + if ( > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeNvCache.St > ore =3D=3D NULL || > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeVolatileCach > e.Store =3D=3D NULL || > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.PendingUpdate =3D=3D NULL > + ) { > + return EFI_UNSUPPORTED; > + } > + > + if (*(mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.PendingUpdate)) { > + if ( > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeHobCache.S > tore !=3D NULL && > + mVariableModuleGlobal->VariableGlobal.HobVariableBase > 0 > + ) { > + CopyMem ( > + (VOID *) ( > + ((UINT8 *) (UINTN) mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeHobCache.S > tore) + > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeHobCache.P > endingUpdateOffset > + ), > + (VOID *) ( > + ((UINT8 *) (UINTN) mVariableModuleGlobal- > >VariableGlobal.HobVariableBase) + > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeHobCache.P > endingUpdateOffset > + ), > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeHobCache.P > endingUpdateLength > + ); > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeHobCache.P > endingUpdateLength =3D 0; > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeHobCache.P > endingUpdateOffset =3D 0; > + } > + > + CopyMem ( > + (VOID *) ( > + ((UINT8 *) (UINTN) mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeNvCache.St > ore) + > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeNvCache.Pe > ndingUpdateOffset > + ), > + (VOID *) ( > + ((UINT8 *) (UINTN) mNvVariableCache) + > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeNvCache.Pe > ndingUpdateOffset > + ), > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeNvCache.Pe > ndingUpdateLength > + ); > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeNvCache.Pe > ndingUpdateLength =3D 0; > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeNvCache.Pe > ndingUpdateOffset =3D 0; > + > + CopyMem ( > + (VOID *) ( > + ((UINT8 *) (UINTN) mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeVolatileCach > e.Store) + > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeVolatileCach > e.PendingUpdateOffset > + ), > + (VOID *) ( > + ((UINT8 *) (UINTN) mVariableModuleGlobal- > >VariableGlobal.VolatileVariableBase) + > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeVolatileCach > e.PendingUpdateOffset > + ), > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeVolatileCach > e.PendingUpdateLength > + ); > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeVolatileCach > e.PendingUpdateLength =3D 0; > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.VariableRuntimeVolatileCach > e.PendingUpdateOffset =3D 0; > + *(mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.PendingUpdate) =3D FALSE; > + } > + > + return EFI_SUCCESS; > +} > + > +/** > + Synchronizes the runtime variable caches with all pending updates outs= ide > runtime. > + > + Ensures all conditions are met to maintain coherency for runtime cache > updates. > + > + @param[in] VariableRuntimeCache Variable runtime cache structure for > the runtime cache being synchronized. > + @param[in] Offset Offset in bytes to apply the update. > + @param[in] Length Length of data in bytes of the update. > + > + @retval EFI_UNSUPPORTED The volatile store to be updated is no= t > initialized properly. > + @retval EFI_SUCCESS The volatile store was updated success= fully. > + > +**/ > +EFI_STATUS > +SynchronizeRuntimeVariableCache ( > + IN VARIABLE_RUNTIME_CACHE *VariableRuntimeCache, > + IN UINTN Offset, > + IN UINTN Length > + ) > +{ > + if (VariableRuntimeCache =3D=3D NULL) { > + return EFI_INVALID_PARAMETER; > + } else if (VariableRuntimeCache->Store =3D=3D NULL) { > + // Runtime cache is not available yet at this point, > + // Return EFI_SUCCESS instead of EFI_NOT_AVAILABLE_YET to let it > progress > + return EFI_SUCCESS; > + } > + > + if ( > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.PendingUpdate =3D=3D NULL || > + mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.ReadLock =3D=3D NULL > + ) { > + return EFI_UNSUPPORTED; > + } > + > + if ( > + *(mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.PendingUpdate) && > + VariableRuntimeCache->PendingUpdateLength > 0 > + ) { > + VariableRuntimeCache->PendingUpdateLength =3D > + (UINT32) ( > + MAX ( > + (UINTN) (VariableRuntimeCache->PendingUpdateOffset + > VariableRuntimeCache->PendingUpdateLength), > + Offset + Length > + ) - MIN ((UINTN) VariableRuntimeCache->PendingUpdateOffset, Offs= et) > + ); > + VariableRuntimeCache->PendingUpdateOffset =3D > + (UINT32) MIN ((UINTN) VariableRuntimeCache->PendingUpdateOffset, > Offset); > + } else { > + VariableRuntimeCache->PendingUpdateLength =3D (UINT32) Length; > + VariableRuntimeCache->PendingUpdateOffset =3D (UINT32) Offset; > + } > + *(mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.PendingUpdate) =3D TRUE; > + > + if (*(mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext.ReadLock) =3D=3D FALSE) { > + return SynchronizeRuntimeVariableCacheEx (); > + } > + > + return EFI_SUCCESS; > +} > diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c > index ce409f22a3..8d767f75ac 100644 > --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c > +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c > @@ -31,6 +31,9 @@ SPDX-License-Identifier: BSD-2-Clause-Patent > #include > #include "Variable.h" > #include "VariableParsing.h" > +#include "VariableRuntimeCache.h" > + > +extern VARIABLE_STORE_HEADER *mNvVariableCache; >=20 > BOOLEAN mAtRuntime = =3D FALSE; > UINT8 *mVariableBufferPay= load =3D NULL; > @@ -451,25 +454,29 @@ SmmVariableGetStatistics ( > EFI_STATUS > EFIAPI > SmmVariableHandler ( > - IN EFI_HANDLE DispatchHandle, > - IN CONST VOID *RegisterContext, > - IN OUT VOID *CommBuffer, > - IN OUT UINTN *CommBufferSize > + IN EFI_HANDLE DispatchHandle= , > + IN CONST VOID *RegisterConte= xt, > + IN OUT VOID *CommBuffer, > + IN OUT UINTN *CommBufferSiz= e > ) > { > - EFI_STATUS Status; > - SMM_VARIABLE_COMMUNICATE_HEADER > *SmmVariableFunctionHeader; > - SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE > *SmmVariableHeader; > - SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME > *GetNextVariableName; > - SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO > *QueryVariableInfo; > - SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE > *GetPayloadSize; > - VARIABLE_INFO_ENTRY *VariableInfo; > - SMM_VARIABLE_COMMUNICATE_LOCK_VARIABLE *VariableToLock; > - SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY > *CommVariableProperty; > - UINTN InfoSize; > - UINTN NameBufferSize; > - UINTN CommBufferPayloadSize= ; > - UINTN TempCommBufferSize; > + EFI_STATUS Status; > + SMM_VARIABLE_COMMUNICATE_HEADER > *SmmVariableFunctionHeader; > + SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE > *SmmVariableHeader; > + SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME > *GetNextVariableName; > + SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO > *QueryVariableInfo; > + SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE > *GetPayloadSize; > + > SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT > *RuntimeVariableCacheContext; > + SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO > *GetRuntimeCacheInfo; > + SMM_VARIABLE_COMMUNICATE_LOCK_VARIABLE > *VariableToLock; > + SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY > *CommVariableProperty; > + VARIABLE_INFO_ENTRY *VariableInfo; > + VARIABLE_RUNTIME_CACHE_CONTEXT > *VariableCacheContext; > + VARIABLE_STORE_HEADER *VariableCache= ; > + UINTN InfoSize; > + UINTN NameBufferSize= ; > + UINTN CommBufferPayl= oadSize; > + UINTN TempCommBuffer= Size; >=20 > // > // If input is invalid, stop processing this SMI > @@ -789,6 +796,79 @@ SmmVariableHandler ( > ); > CopyMem (SmmVariableFunctionHeader->Data, mVariableBufferPayload, > CommBufferPayloadSize); > break; > + case > SMM_VARIABLE_FUNCTION_INIT_RUNTIME_VARIABLE_CACHE_CONTEXT: > + if (CommBufferPayloadSize < sizeof > (SMM_VARIABLE_FUNCTION_INIT_RUNTIME_VARIABLE_CACHE_CONTEXT)) > { The above check is not correct, I think it should be: if (CommBufferPayloadSize < sizeof (SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIAB= LE_CACHE_CONTEXT)) { Please help to double confirm. Also, I recommend some security tests should be performed to these new case= s in the variable SMI handler. > + DEBUG ((DEBUG_ERROR, "InitRuntimeVariableCacheContext: SMM > communication buffer size invalid!\n")); > + } else if (mEndOfDxe) { > + DEBUG ((DEBUG_ERROR, "InitRuntimeVariableCacheContext: Cannot > init context after end of DXE!\n")); > + } else { > + RuntimeVariableCacheContext =3D > (SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT > *) SmmVariableFunctionHeader->Data; Not sure on this one: Do you think it is necessary to copy the contents in the comm buffer to the pre-allocated SMM variable buffer payload 'mVariableBufferPayload' to avoid TOCTOU issue? Since there are some tests (sort of, a couple of ASSERTs) bas= ed on the comm buffer content. > + VariableCacheContext =3D &mVariableModuleGlobal- > >VariableGlobal.VariableRuntimeCacheContext; > + > + ASSERT (RuntimeVariableCacheContext->RuntimeVolatileCache !=3D > NULL); > + ASSERT (RuntimeVariableCacheContext->RuntimeNvCache !=3D NULL); > + ASSERT (RuntimeVariableCacheContext->PendingUpdate !=3D NULL); > + ASSERT (RuntimeVariableCacheContext->ReadLock !=3D NULL); > + ASSERT (RuntimeVariableCacheContext->HobFlushComplete !=3D NULL)= ; > + > + VariableCacheContext->VariableRuntimeHobCache.Store =3D > RuntimeVariableCacheContext->RuntimeHobCache; > + VariableCacheContext->VariableRuntimeVolatileCache.Store =3D > RuntimeVariableCacheContext->RuntimeVolatileCache; > + VariableCacheContext->VariableRuntimeNvCache.Store =3D > RuntimeVariableCacheContext->RuntimeNvCache; > + VariableCacheContext->PendingUpdate =3D > RuntimeVariableCacheContext->PendingUpdate; > + VariableCacheContext->ReadLock =3D > RuntimeVariableCacheContext->ReadLock; > + VariableCacheContext->HobFlushComplete =3D > RuntimeVariableCacheContext->HobFlushComplete; > + > + // Set up the intial pending request since the RT cache needs to= be in > sync with SMM cache > + if (mVariableModuleGlobal->VariableGlobal.HobVariableBase =3D=3D= 0) { > + VariableCacheContext- > >VariableRuntimeHobCache.PendingUpdateOffset =3D 0; > + VariableCacheContext- > >VariableRuntimeHobCache.PendingUpdateLength =3D 0; > + } else { > + VariableCache =3D (VARIABLE_STORE_HEADER *) (UINTN) > mVariableModuleGlobal->VariableGlobal.HobVariableBase; > + VariableCacheContext- > >VariableRuntimeHobCache.PendingUpdateOffset =3D 0; > + VariableCacheContext- > >VariableRuntimeHobCache.PendingUpdateLength =3D (UINT32) ((UINTN) > GetEndPointer (VariableCache) - (UINTN) VariableCache); > + CopyGuid (&(VariableCacheContext- > >VariableRuntimeHobCache.Store->Signature), &(VariableCache- > >Signature)); > + } > + VariableCache =3D (VARIABLE_STORE_HEADER *) (UINTN) > mVariableModuleGlobal->VariableGlobal.VolatileVariableBase; > + VariableCacheContext- > >VariableRuntimeVolatileCache.PendingUpdateOffset =3D 0; > + VariableCacheContext- > >VariableRuntimeVolatileCache.PendingUpdateLength =3D (UINT32) ((UINTN) > GetEndPointer (VariableCache) - (UINTN) VariableCache); > + CopyGuid (&(VariableCacheContext- > >VariableRuntimeVolatileCache.Store->Signature), &(VariableCache- > >Signature)); > + > + VariableCache =3D (VARIABLE_STORE_HEADER *) (UINTN) > mNvVariableCache; > + VariableCacheContext- > >VariableRuntimeNvCache.PendingUpdateOffset =3D 0; > + VariableCacheContext- > >VariableRuntimeNvCache.PendingUpdateLength =3D (UINT32) ((UINTN) > GetEndPointer (VariableCache) - (UINTN) VariableCache); > + CopyGuid (&(VariableCacheContext->VariableRuntimeNvCache.Store- > >Signature), &(VariableCache->Signature)); > + > + *(VariableCacheContext->PendingUpdate) =3D TRUE; > + *(VariableCacheContext->ReadLock) =3D FALSE; > + *(VariableCacheContext->HobFlushComplete) =3D FALSE; > + } > + Status =3D EFI_SUCCESS; > + break; > + case SMM_VARIABLE_FUNCTION_SYNC_RUNTIME_CACHE: > + Status =3D SynchronizeRuntimeVariableCacheEx (); > + break; > + case SMM_VARIABLE_FUNCTION_GET_RUNTIME_CACHE_INFO: > + if (CommBufferPayloadSize < sizeof > (SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO)) { > + DEBUG ((DEBUG_ERROR, "GetRuntimeCacheInfo: SMM communication > buffer size invalid!\n")); > + return EFI_SUCCESS; > + } > + GetRuntimeCacheInfo =3D > (SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO *) > SmmVariableFunctionHeader->Data; > + > + if (mVariableModuleGlobal->VariableGlobal.HobVariableBase > 0) { > + VariableCache =3D (VARIABLE_STORE_HEADER *) (UINTN) > mVariableModuleGlobal->VariableGlobal.HobVariableBase; > + GetRuntimeCacheInfo->TotalHobStorageSize =3D VariableCache->Size= ; > + } else { > + GetRuntimeCacheInfo->TotalHobStorageSize =3D 0; > + } > + > + VariableCache =3D (VARIABLE_STORE_HEADER *) (UINTN) > mVariableModuleGlobal->VariableGlobal.VolatileVariableBase; > + GetRuntimeCacheInfo->TotalVolatileStorageSize =3D VariableCache->S= ize; > + VariableCache =3D (VARIABLE_STORE_HEADER *) (UINTN) > mNvVariableCache; > + GetRuntimeCacheInfo->TotalNvStorageSize =3D (UINTN) VariableCache- > >Size; > + GetRuntimeCacheInfo->AuthenticatedVariableUsage =3D > mVariableModuleGlobal->VariableGlobal.AuthFormat; > + > + Status =3D EFI_SUCCESS; > + break; >=20 > default: > Status =3D EFI_UNSUPPORTED; > diff --git > a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDx > e.c > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDx > e.c > index 0a1888e5ef..46f69765a4 100644 > --- > a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDx > e.c > +++ > b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDx > e.c > @@ -13,7 +13,7 @@ >=20 > InitCommunicateBuffer() is really function to check the variable data = size. >=20 > -Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.
> +Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.
> SPDX-License-Identifier: BSD-2-Clause-Patent >=20 > **/ > @@ -32,13 +32,16 @@ SPDX-License-Identifier: BSD-2-Clause-Patent > #include > #include > #include > +#include > #include > #include >=20 > #include > +#include > #include >=20 > #include "PrivilegePolymorphic.h" > +#include "VariableParsing.h" >=20 > EFI_HANDLE mHandle =3D NULL; > EFI_SMM_VARIABLE_PROTOCOL *mSmmVariable =3D NULL; > @@ -46,8 +49,19 @@ EFI_EVENT mVirtualAddressChange= Event =3D > NULL; > EFI_SMM_COMMUNICATION_PROTOCOL *mSmmCommunication =3D > NULL; > UINT8 *mVariableBuffer =3D NULL; > UINT8 *mVariableBufferPhysical =3D NULL; > +VARIABLE_INFO_ENTRY *mVariableInfo =3D NULL; > +VARIABLE_STORE_HEADER *mVariableRuntimeHobCacheBuffer = =3D > NULL; > +VARIABLE_STORE_HEADER *mVariableRuntimeNvCacheBuffer = =3D > NULL; > +VARIABLE_STORE_HEADER *mVariableRuntimeVolatileCacheBuffer > =3D NULL; > UINTN mVariableBufferSize; > +UINTN mVariableRuntimeHobCacheBufferSize; > +UINTN mVariableRuntimeNvCacheBufferSize; > +UINTN mVariableRuntimeVolatileCacheBufferSize= ; > UINTN mVariableBufferPayloadSize; > +BOOLEAN mVariableRuntimeCachePendingUpdate; > +BOOLEAN mVariableRuntimeCacheReadLock; > +BOOLEAN mVariableAuthFormat; > +BOOLEAN mHobFlushComplete; > EFI_LOCK mVariableServicesLock; > EDKII_VARIABLE_LOCK_PROTOCOL mVariableLock; > EDKII_VAR_CHECK_PROTOCOL mVarCheck; > @@ -107,6 +121,73 @@ ReleaseLockOnlyAtBootTime ( > } > } >=20 > +/** > + Return TRUE if ExitBootServices () has been called. > + > + @retval TRUE If ExitBootServices () has been called. > +**/ > +BOOLEAN > +AtRuntime ( > + VOID > + ) I think we can either: 1. Use EfiAtRuntime() for VariableSmmRuntimeDxe 2. Move AtRuntime() to VariableParsing.c so that the function can be shared with VariableRuntimeDxe & VariableSmmRuntimeDxe. And then update the EfiAtRuntime() usages to AtRuntime() for VariableSmmRuntimeDxe. > +{ > + return EfiAtRuntime (); > +} > + > +/** > + Initialize the variable cache buffer as an empty variable store. > + > + @param[out] VariableCacheBuffer A pointer to pointer of a cach= e > variable store. > + @param[in,out] TotalVariableCacheSize On input, the minimum size > needed for the UEFI variable store cache > + buffer that is allocated. On o= utput, the actual size of > the buffer allocated. > + If TotalVariableCacheSize is z= ero, a buffer will not be > allocated and the > + function will return with EFI_= SUCCESS. > + > + @retval EFI_SUCCESS The variable cache was allocated and i= nitialized > successfully. > + @retval EFI_INVALID_PARAMETER A given pointer is NULL or an invalid > variable store size was specified. > + @retval EFI_OUT_OF_RESOURCES Insufficient resources are available t= o > allocate the variable store cache buffer. > + > +**/ > +EFI_STATUS > +EFIAPI > +InitVariableCache ( > + OUT VARIABLE_STORE_HEADER **VariableCacheBuffer, > + IN OUT UINTN *TotalVariableCacheSize > + ) > +{ > + VARIABLE_STORE_HEADER *VariableCacheStorePtr; > + > + if (TotalVariableCacheSize =3D=3D NULL) { > + return EFI_INVALID_PARAMETER; > + } > + if (*TotalVariableCacheSize =3D=3D 0) { > + return EFI_SUCCESS; > + } > + if (VariableCacheBuffer =3D=3D NULL || *TotalVariableCacheSize < sizeo= f > (VARIABLE_STORE_HEADER)) { > + return EFI_INVALID_PARAMETER; > + } > + *TotalVariableCacheSize =3D ALIGN_VALUE (*TotalVariableCacheSize, size= of > (UINT32)); > + > + // > + // Allocate NV Storage Cache and initialize it to all 1's (like an era= sed FV) > + // > + *VariableCacheBuffer =3D (VARIABLE_STORE_HEADER *) > AllocateRuntimePages ( > + EFI_SIZE_TO_PAGES (*TotalVariableCacheSize) > + ); > + if (*VariableCacheBuffer =3D=3D NULL) { > + return EFI_OUT_OF_RESOURCES; > + } > + VariableCacheStorePtr =3D *VariableCacheBuffer; > + SetMem32 ((VOID *) VariableCacheStorePtr, *TotalVariableCacheSize, > (UINT32) 0xFFFFFFFF); > + > + ZeroMem ((VOID *) VariableCacheStorePtr, sizeof > (VARIABLE_STORE_HEADER)); > + VariableCacheStorePtr->Size =3D (UINT32) *TotalVariableCacheSize; > + VariableCacheStorePtr->Format =3D VARIABLE_STORE_FORMATTED; > + VariableCacheStorePtr->State =3D VARIABLE_STORE_HEALTHY; > + > + return EFI_SUCCESS; > +} > + > /** > Initialize the communicate buffer using DataSize and Function. >=20 > @@ -153,6 +234,69 @@ InitCommunicateBuffer ( > } >=20 >=20 > +/** > + Gets a SMM communicate buffer from the > EDKII_PI_SMM_COMMUNICATION_REGION_TABLE installed as an entry in > the UEFI > + system configuration table. A generic SMM communication buffer DXE > driver may install the table or a custom table > + may be installed by a platform-specific driver. > + > + The communicate size is: SMM_COMMUNICATE_HEADER_SIZE + > SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + > + DataSize. > + > + @param[in,out] CommBufferSize On input, the minimum size needed > for the communication buffer. > + On output, the SMM buffer size avail= able at CommBuffer. > + @param[out] CommBuffer A pointer to an SMM communication > buffer pointer. > + > + @retval EFI_SUCCESS The communication buffer was found > successfully. > + @retval EFI_INVALID_PARAMETER A given pointer is NULL or the > CommBufferSize is zero. > + @retval EFI_NOT_FOUND The > EDKII_PI_SMM_COMMUNICATION_REGION_TABLE was not found. > + @retval EFI_OUT_OF_RESOURCES A valid SMM communicate buffer for > the requested size is not available. > + > +**/ > +EFI_STATUS > +GetCommunicateBuffer ( > + IN OUT UINTN *CommBufferSize, > + OUT UINT8 **CommBuffer > + ) Minor comment: I found that the consumers of the above function are: GetRuntimeCacheInfo() SendRuntimeVariableCacheContextToSmm() Both of them get called within SmmVariableReady() when the SMM variable dri= ver finished initialization. I am wondering if they can simply use the pre-allo= cated comm buffer (via InitCommunicateBuffer() and using 'mVariableBuffer'), inst= ead of looking into the configuration table. In my opinion, this function can be dropped. > +{ > + EFI_STATUS Status; > + EDKII_PI_SMM_COMMUNICATION_REGION_TABLE > *PiSmmCommunicationRegionTable; > + EFI_MEMORY_DESCRIPTOR *Entry; > + UINTN EntrySize; > + UINT32 Index; > + > + if (CommBuffer =3D=3D NULL || CommBufferSize =3D=3D NULL || > *CommBufferSize =3D=3D 0) { > + return EFI_INVALID_PARAMETER; > + } > + > + Status =3D EfiGetSystemConfigurationTable ( > + &gEdkiiPiSmmCommunicationRegionTableGuid, > + (VOID **) &PiSmmCommunicationRegionTable > + ); > + if (EFI_ERROR (Status) || PiSmmCommunicationRegionTable =3D=3D NULL) { > + return EFI_NOT_FOUND; > + } > + > + Entry =3D (EFI_MEMORY_DESCRIPTOR *) (PiSmmCommunicationRegionTable > + 1); > + EntrySize =3D 0; > + for (Index =3D 0; Index < PiSmmCommunicationRegionTable- > >NumberOfEntries; Index++) { > + if (Entry->Type =3D=3D EfiConventionalMemory) { > + EntrySize =3D EFI_PAGES_TO_SIZE ((UINTN) Entry->NumberOfPages); > + if (EntrySize >=3D *CommBufferSize) { > + break; > + } > + } > + Entry =3D (EFI_MEMORY_DESCRIPTOR *) ((UINT8 *) Entry + > PiSmmCommunicationRegionTable->DescriptorSize); > + } > + > + if (Index < PiSmmCommunicationRegionTable->NumberOfEntries) { > + *CommBufferSize =3D EntrySize; > + *CommBuffer =3D (UINT8 *) (UINTN) Entry->PhysicalStart; > + return EFI_SUCCESS; > + } > + > + return EFI_OUT_OF_RESOURCES; > +} > + > /** > Send the data in communicate buffer to SMM. >=20 > @@ -424,6 +568,171 @@ Done: > return Status; > } >=20 > +/** > + Signals SMM to synchronize any pending variable updates with the > runtime cache(s). > + > +**/ > +VOID > +EFIAPI > +SyncRuntimeCache ( > + VOID > + ) > +{ > + // > + // Init the communicate buffer. The buffer data size is: > + // SMM_COMMUNICATE_HEADER_SIZE + > SMM_VARIABLE_COMMUNICATE_HEADER_SIZE. > + // > + InitCommunicateBuffer (NULL, 0, > SMM_VARIABLE_FUNCTION_SYNC_RUNTIME_CACHE); > + > + // > + // Send data to SMM. > + // > + SendCommunicateBuffer (0); > +} > + > +/** > + Check whether a SMI must be triggered to retrieve pending cache update= s. > + > + If the variable HOB was finished being flushed since the last check fo= r a > runtime cache update, this function > + will prevent the HOB cache from being used for future runtime cache hi= ts. > + > +**/ > +VOID > +EFIAPI > +CheckForRuntimeCacheSync ( > + VOID > + ) > +{ > + if (mVariableRuntimeCachePendingUpdate) { > + SyncRuntimeCache (); > + } > + ASSERT (!mVariableRuntimeCachePendingUpdate); > + > + // > + // The HOB variable data may have finished being flushed in the runtim= e > cache sync update > + // > + if (mHobFlushComplete && mVariableRuntimeHobCacheBuffer !=3D NULL) { > + if (!AtRuntime ()) { > + FreePool (mVariableRuntimeHobCacheBuffer); > + } > + mVariableRuntimeHobCacheBuffer =3D NULL; > + } > +} > + > +/** > + This code finds variable in a volatile memory store. > + > + Caution: This function may receive untrusted input. > + The data size is external input, so this function will validate it car= efully to > avoid buffer overflow. > + > + @param[in] VariableName Name of Variable to be found. > + @param[in] VendorGuid Variable vendor GUID. > + @param[out] Attributes Attribute value of the variable fou= nd. > + @param[in, out] DataSize Size of Data found. If size is less= than the > + data, this value contains the requi= red size. > + @param[out] Data Data pointer. > + > + @retval EFI_SUCCESS Found the specified variable. > + @retval EFI_INVALID_PARAMETER Invalid parameter. > + @retval EFI_NOT_FOUND The specified variable could not be= found. > + > +**/ > +EFI_STATUS > +EFIAPI > +FindVariableInRuntimeCache ( > + IN CHAR16 *VariableName, > + IN EFI_GUID *VendorGuid, > + OUT UINT32 *Attributes OPTIONAL, > + IN OUT UINTN *DataSize, > + OUT VOID *Data OPTIONAL > + ) > +{ > + EFI_STATUS Status; > + UINTN DelayIndex; > + UINTN TempDataSize; > + VARIABLE_POINTER_TRACK RtPtrTrack; > + VARIABLE_STORE_TYPE StoreType; > + VARIABLE_STORE_HEADER *VariableStoreList[VariableStoreTypeMax]; > + > + Status =3D EFI_NOT_FOUND; > + > + if (VariableName =3D=3D NULL || VendorGuid =3D=3D NULL || DataSize =3D= =3D NULL) { > + return EFI_INVALID_PARAMETER; > + } > + > + for (DelayIndex =3D 0; mVariableRuntimeCacheReadLock && DelayIndex < > VARIABLE_RT_CACHE_READ_LOCK_TIMEOUT; DelayIndex++) { > + MicroSecondDelay (10); > + } > + if (DelayIndex < VARIABLE_RT_CACHE_READ_LOCK_TIMEOUT) { > + ASSERT (!mVariableRuntimeCacheReadLock); > + > + mVariableRuntimeCacheReadLock =3D TRUE; > + CheckForRuntimeCacheSync (); > + > + if (!mVariableRuntimeCachePendingUpdate) { > + // > + // 0: Volatile, 1: HOB, 2: Non-Volatile. > + // The index and attributes mapping must be kept in this order as > FindVariable > + // makes use of this mapping to implement search algorithm. > + // > + VariableStoreList[VariableStoreTypeVolatile] =3D > mVariableRuntimeVolatileCacheBuffer; > + VariableStoreList[VariableStoreTypeHob] =3D > mVariableRuntimeHobCacheBuffer; > + VariableStoreList[VariableStoreTypeNv] =3D > mVariableRuntimeNvCacheBuffer; > + > + for (StoreType =3D (VARIABLE_STORE_TYPE) 0; StoreType < > VariableStoreTypeMax; StoreType++) { > + if (VariableStoreList[StoreType] =3D=3D NULL) { > + continue; > + } > + > + RtPtrTrack.StartPtr =3D GetStartPointer (VariableStoreList[Store= Type]); > + RtPtrTrack.EndPtr =3D GetEndPointer (VariableStoreList[Store= Type]); > + RtPtrTrack.Volatile =3D (BOOLEAN) (StoreType =3D=3D > VariableStoreTypeVolatile); > + > + Status =3D FindVariableEx (VariableName, VendorGuid, FALSE, > &RtPtrTrack); > + if (!EFI_ERROR (Status)) { > + break; > + } > + } > + > + if (!EFI_ERROR (Status)) { > + // > + // Get data size > + // > + TempDataSize =3D DataSizeOfVariable (RtPtrTrack.CurrPtr); > + ASSERT (TempDataSize !=3D 0); > + > + if (*DataSize >=3D TempDataSize) { > + if (Data =3D=3D NULL) { > + Status =3D EFI_INVALID_PARAMETER; > + goto Done; > + } > + > + CopyMem (Data, GetVariableDataPtr (RtPtrTrack.CurrPtr), > TempDataSize); > + if (Attributes !=3D NULL) { > + *Attributes =3D RtPtrTrack.CurrPtr->Attributes; > + } > + > + *DataSize =3D TempDataSize; > + > + UpdateVariableInfo (VariableName, VendorGuid, RtPtrTrack.Volat= ile, > TRUE, FALSE, FALSE, TRUE, &mVariableInfo); > + > + Status =3D EFI_SUCCESS; > + goto Done; > + } else { > + *DataSize =3D TempDataSize; > + Status =3D EFI_BUFFER_TOO_SMALL; > + goto Done; > + } > + } > + } > + } > + > +Done: > + mVariableRuntimeCacheReadLock =3D FALSE; If timeout occurs when acquiring the read lock, should this flag be set to = FALSE in such case? Best Regards, Hao Wu > + > + return Status; > +} > + > /** > This code finds variable in storage blocks (Volatile or Non-Volatile). >=20 > @@ -454,91 +763,21 @@ RuntimeServiceGetVariable ( > ) > { > EFI_STATUS Status; > - UINTN PayloadSize; > - SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE > *SmmVariableHeader; > - UINTN TempDataSize; > - UINTN VariableNameSize; >=20 > if (VariableName =3D=3D NULL || VendorGuid =3D=3D NULL || DataSize =3D= =3D NULL) { > return EFI_INVALID_PARAMETER; > } > - > - TempDataSize =3D *DataSize; > - VariableNameSize =3D StrSize (VariableName); > - SmmVariableHeader =3D NULL; > - > - // > - // If VariableName exceeds SMM payload limit. Return failure > - // > - if (VariableNameSize > mVariableBufferPayloadSize - OFFSET_OF > (SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE, Name)) { > - return EFI_INVALID_PARAMETER; > - } > - > - AcquireLockOnlyAtBootTime(&mVariableServicesLock); > - > - // > - // Init the communicate buffer. The buffer data size is: > - // SMM_COMMUNICATE_HEADER_SIZE + > SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize. > - // > - if (TempDataSize > mVariableBufferPayloadSize - OFFSET_OF > (SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE, Name) - > VariableNameSize) { > - // > - // If output data buffer exceed SMM payload limit. Trim output buffe= r to > SMM payload size > - // > - TempDataSize =3D mVariableBufferPayloadSize - OFFSET_OF > (SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE, Name) - > VariableNameSize; > - } > - PayloadSize =3D OFFSET_OF > (SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE, Name) + > VariableNameSize + TempDataSize; > - > - Status =3D InitCommunicateBuffer ((VOID **)&SmmVariableHeader, > PayloadSize, SMM_VARIABLE_FUNCTION_GET_VARIABLE); > - if (EFI_ERROR (Status)) { > - goto Done; > - } > - ASSERT (SmmVariableHeader !=3D NULL); > - > - CopyGuid (&SmmVariableHeader->Guid, VendorGuid); > - SmmVariableHeader->DataSize =3D TempDataSize; > - SmmVariableHeader->NameSize =3D VariableNameSize; > - if (Attributes =3D=3D NULL) { > - SmmVariableHeader->Attributes =3D 0; > - } else { > - SmmVariableHeader->Attributes =3D *Attributes; > - } > - CopyMem (SmmVariableHeader->Name, VariableName, > SmmVariableHeader->NameSize); > - > - // > - // Send data to SMM. > - // > - Status =3D SendCommunicateBuffer (PayloadSize); > - > - // > - // Get data from SMM. > - // > - if (Status =3D=3D EFI_SUCCESS || Status =3D=3D EFI_BUFFER_TOO_SMALL) { > - // > - // SMM CommBuffer DataSize can be a trimed value > - // Only update DataSize when needed > - // > - *DataSize =3D SmmVariableHeader->DataSize; > - } > - if (Attributes !=3D NULL) { > - *Attributes =3D SmmVariableHeader->Attributes; > - } > - > - if (EFI_ERROR (Status)) { > - goto Done; > - } > - > - if (Data !=3D NULL) { > - CopyMem (Data, (UINT8 *)SmmVariableHeader->Name + > SmmVariableHeader->NameSize, SmmVariableHeader->DataSize); > - } else { > - Status =3D EFI_INVALID_PARAMETER; > + if (VariableName[0] =3D=3D 0) { > + return EFI_NOT_FOUND; > } >=20 > -Done: > + AcquireLockOnlyAtBootTime (&mVariableServicesLock); > + Status =3D FindVariableInRuntimeCache (VariableName, VendorGuid, > Attributes, DataSize, Data); > ReleaseLockOnlyAtBootTime (&mVariableServicesLock); > + > return Status; > } >=20 > - > /** > This code Finds the Next available variable. >=20 > @@ -870,6 +1109,17 @@ OnReadyToBoot ( > // > SendCommunicateBuffer (0); >=20 > + // > + // Install the system configuration table for variable info data captu= red > + // > + if (FeaturePcdGet (PcdVariableCollectStatistics)) { > + if (mVariableAuthFormat) { > + gBS->InstallConfigurationTable (&gEfiAuthenticatedVariableGuid, > mVariableInfo); > + } else { > + gBS->InstallConfigurationTable (&gEfiVariableGuid, mVariableInfo); > + } > + } > + > gBS->CloseEvent (Event); > } >=20 > @@ -893,6 +1143,9 @@ VariableAddressChangeEvent ( > { > EfiConvertPointer (0x0, (VOID **) &mVariableBuffer); > EfiConvertPointer (0x0, (VOID **) &mSmmCommunication); > + EfiConvertPointer (0x0, (VOID **) &mVariableRuntimeHobCacheBuffer); > + EfiConvertPointer (0x0, (VOID **) &mVariableRuntimeNvCacheBuffer); > + EfiConvertPointer (0x0, (VOID **) > &mVariableRuntimeVolatileCacheBuffer); > } >=20 > /** > @@ -969,6 +1222,173 @@ Done: > return Status; > } >=20 > +/** > + This code gets information needed from SMM for runtime cache > initialization. > + > + @param[out] TotalHobStorageSize Output pointer for the total H= OB > storage size in bytes. > + @param[out] TotalNvStorageSize Output pointer for the total n= on- > volatile storage size in bytes. > + @param[out] TotalVolatileStorageSize Output pointer for the total > volatile storage size in bytes. > + @param[out] AuthenticatedVariableUsage Output pointer that indicates = if > authenticated variables are to be used. > + > + @retval EFI_SUCCESS Retrieved the size successfull= y. > + @retval EFI_INVALID_PARAMETER TotalNvStorageSize parameter i= s > NULL. > + @retval EFI_OUT_OF_RESOURCES Could not allocate a CommBuffe= r. > + @retval Others Could not retrieve the size su= ccessfully.; > + > +**/ > +EFI_STATUS > +EFIAPI > +GetRuntimeCacheInfo ( > + OUT UINTN *TotalHobStorageSize, > + OUT UINTN *TotalNvStorageSize, > + OUT UINTN *TotalVolatileStorageSize, > + OUT BOOLEAN *AuthenticatedVariableUsage > + ) > +{ > + EFI_STATUS Status; > + SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO > *SmmGetRuntimeCacheInfo; > + EFI_SMM_COMMUNICATE_HEADER > *SmmCommunicateHeader; > + SMM_VARIABLE_COMMUNICATE_HEADER > *SmmVariableFunctionHeader; > + UINTN CommSize; > + UINTN CommBufferSize; > + UINT8 *CommBuffer; > + > + SmmGetRuntimeCacheInfo =3D NULL; > + CommBuffer =3D NULL; > + > + if (TotalHobStorageSize =3D=3D NULL || TotalNvStorageSize =3D=3D NULL = || > TotalVolatileStorageSize =3D=3D NULL || AuthenticatedVariableUsage =3D=3D= NULL) { > + return EFI_INVALID_PARAMETER; > + } > + > + AcquireLockOnlyAtBootTime (&mVariableServicesLock); > + > + CommSize =3D SMM_COMMUNICATE_HEADER_SIZE + > SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof > (SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO); > + CommBufferSize =3D CommSize; > + Status =3D GetCommunicateBuffer (&CommBufferSize, &CommBuffer); > + if (EFI_ERROR (Status)) { > + goto Done; > + } > + if (CommBuffer =3D=3D NULL) { > + Status =3D EFI_OUT_OF_RESOURCES; > + goto Done; > + } > + ZeroMem (CommBuffer, CommBufferSize); > + > + SmmCommunicateHeader =3D (EFI_SMM_COMMUNICATE_HEADER *) > CommBuffer; > + CopyGuid (&SmmCommunicateHeader->HeaderGuid, > &gEfiSmmVariableProtocolGuid); > + SmmCommunicateHeader->MessageLength =3D > SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof > (SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO); > + > + SmmVariableFunctionHeader =3D > (SMM_VARIABLE_COMMUNICATE_HEADER *) SmmCommunicateHeader- > >Data; > + SmmVariableFunctionHeader->Function =3D > SMM_VARIABLE_FUNCTION_GET_RUNTIME_CACHE_INFO; > + SmmGetRuntimeCacheInfo =3D > (SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO *) > SmmVariableFunctionHeader->Data; > + > + // > + // Send data to SMM. > + // > + Status =3D mSmmCommunication->Communicate (mSmmCommunication, > CommBuffer, &CommSize); > + ASSERT_EFI_ERROR (Status); > + if (CommSize <=3D SMM_VARIABLE_COMMUNICATE_HEADER_SIZE) { > + Status =3D EFI_BAD_BUFFER_SIZE; > + goto Done; > + } > + > + Status =3D SmmVariableFunctionHeader->ReturnStatus; > + if (EFI_ERROR (Status)) { > + goto Done; > + } > + > + // > + // Get data from SMM. > + // > + *TotalHobStorageSize =3D SmmGetRuntimeCacheInfo->TotalHobStorageSize; > + *TotalNvStorageSize =3D SmmGetRuntimeCacheInfo->TotalNvStorageSize; > + *TotalVolatileStorageSize =3D SmmGetRuntimeCacheInfo- > >TotalVolatileStorageSize; > + *AuthenticatedVariableUsage =3D SmmGetRuntimeCacheInfo- > >AuthenticatedVariableUsage; > + > +Done: > + ReleaseLockOnlyAtBootTime (&mVariableServicesLock); > + return Status; > +} > + > +/** > + Sends the runtime variable cache context information to SMM. > + > + @retval EFI_SUCCESS Retrieved the size successfully. > + @retval EFI_INVALID_PARAMETER TotalNvStorageSize parameter is > NULL. > + @retval EFI_OUT_OF_RESOURCES Could not allocate a CommBuffer. > + @retval Others Could not retrieve the size successf= ully.; > + > +**/ > +EFI_STATUS > +EFIAPI > +SendRuntimeVariableCacheContextToSmm ( > + VOID > + ) > +{ > + EFI_STATUS Status; > + > SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT > *SmmRuntimeVarCacheContext; > + EFI_SMM_COMMUNICATE_HEADER > *SmmCommunicateHeader; > + SMM_VARIABLE_COMMUNICATE_HEADER > *SmmVariableFunctionHeader; > + UINTN CommSize; > + UINTN CommBufferSi= ze; > + UINT8 *CommBuffer; > + > + SmmRuntimeVarCacheContext =3D NULL; > + CommBuffer =3D NULL; > + > + AcquireLockOnlyAtBootTime (&mVariableServicesLock); > + > + // > + // Init the communicate buffer. The buffer data size is: > + // SMM_COMMUNICATE_HEADER_SIZE + > SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof > (SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT); > + // > + CommSize =3D SMM_COMMUNICATE_HEADER_SIZE + > SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof > (SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT); > + CommBufferSize =3D CommSize; > + Status =3D GetCommunicateBuffer (&CommBufferSize, &CommBuffer); > + if (EFI_ERROR (Status)) { > + goto Done; > + } > + if (CommBuffer =3D=3D NULL) { > + Status =3D EFI_OUT_OF_RESOURCES; > + goto Done; > + } > + ZeroMem (CommBuffer, CommBufferSize); > + > + SmmCommunicateHeader =3D (EFI_SMM_COMMUNICATE_HEADER *) > CommBuffer; > + CopyGuid (&SmmCommunicateHeader->HeaderGuid, > &gEfiSmmVariableProtocolGuid); > + SmmCommunicateHeader->MessageLength =3D > SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof > (SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT); > + > + SmmVariableFunctionHeader =3D > (SMM_VARIABLE_COMMUNICATE_HEADER *) SmmCommunicateHeader- > >Data; > + SmmVariableFunctionHeader->Function =3D > SMM_VARIABLE_FUNCTION_INIT_RUNTIME_VARIABLE_CACHE_CONTEXT; > + SmmRuntimeVarCacheContext =3D > (SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT > *) SmmVariableFunctionHeader->Data; > + > + SmmRuntimeVarCacheContext->RuntimeHobCache =3D > mVariableRuntimeHobCacheBuffer; > + SmmRuntimeVarCacheContext->RuntimeVolatileCache =3D > mVariableRuntimeVolatileCacheBuffer; > + SmmRuntimeVarCacheContext->RuntimeNvCache =3D > mVariableRuntimeNvCacheBuffer; > + SmmRuntimeVarCacheContext->PendingUpdate =3D > &mVariableRuntimeCachePendingUpdate; > + SmmRuntimeVarCacheContext->ReadLock =3D > &mVariableRuntimeCacheReadLock; > + SmmRuntimeVarCacheContext->HobFlushComplete =3D > &mHobFlushComplete; > + > + // > + // Send data to SMM. > + // > + Status =3D mSmmCommunication->Communicate (mSmmCommunication, > CommBuffer, &CommSize); > + ASSERT_EFI_ERROR (Status); > + if (CommSize <=3D SMM_VARIABLE_COMMUNICATE_HEADER_SIZE) { > + Status =3D EFI_BAD_BUFFER_SIZE; > + goto Done; > + } > + > + Status =3D SmmVariableFunctionHeader->ReturnStatus; > + if (EFI_ERROR (Status)) { > + goto Done; > + } > + > +Done: > + ReleaseLockOnlyAtBootTime (&mVariableServicesLock); > + return Status; > +} > + > /** > Initialize variable service and install Variable Architectural protoco= l. >=20 > @@ -985,7 +1405,7 @@ SmmVariableReady ( > { > EFI_STATUS Status; >=20 > - Status =3D gBS->LocateProtocol (&gEfiSmmVariableProtocolGuid, NULL, > (VOID **)&mSmmVariable); > + Status =3D gBS->LocateProtocol (&gEfiSmmVariableProtocolGuid, NULL, > (VOID **) &mSmmVariable); > if (EFI_ERROR (Status)) { > return; > } > @@ -1007,6 +1427,40 @@ SmmVariableReady ( > // > mVariableBufferPhysical =3D mVariableBuffer; >=20 > + // > + // Allocate runtime variable cache memory buffers. > + // > + Status =3D GetRuntimeCacheInfo ( > + &mVariableRuntimeHobCacheBufferSize, > + &mVariableRuntimeNvCacheBufferSize, > + &mVariableRuntimeVolatileCacheBufferSize, > + &mVariableAuthFormat > + ); > + if (!EFI_ERROR (Status)) { > + Status =3D InitVariableCache (&mVariableRuntimeHobCacheBuffer, > &mVariableRuntimeHobCacheBufferSize); > + if (!EFI_ERROR (Status)) { > + Status =3D InitVariableCache (&mVariableRuntimeNvCacheBuffer, > &mVariableRuntimeNvCacheBufferSize); > + if (!EFI_ERROR (Status)) { > + Status =3D InitVariableCache (&mVariableRuntimeVolatileCacheBuff= er, > &mVariableRuntimeVolatileCacheBufferSize); > + if (!EFI_ERROR (Status)) { > + Status =3D InitVariableParsing (mVariableAuthFormat); > + ASSERT_EFI_ERROR (Status); > + > + Status =3D SendRuntimeVariableCacheContextToSmm (); > + if (!EFI_ERROR (Status)) { > + SyncRuntimeCache (); > + } > + } > + } > + } > + if (EFI_ERROR (Status)) { > + mVariableRuntimeHobCacheBuffer =3D NULL; > + mVariableRuntimeNvCacheBuffer =3D NULL; > + mVariableRuntimeVolatileCacheBuffer =3D NULL; > + } > + } > + ASSERT_EFI_ERROR (Status); > + > gRT->GetVariable =3D RuntimeServiceGetVariable; > gRT->GetNextVariableName =3D RuntimeServiceGetNextVariableName; > gRT->SetVariable =3D RuntimeServiceSetVariable; > -- > 2.16.2.windows.1