MdeModulePkg Variable: Abstract InitRealNonVolatileVariableStore

[mirror_edk2.git] / MdeModulePkg / Universal / Variable / RuntimeDxe / Variable.c

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 99d487adac9ecdb38fd17c2aa7ef2a904899b934..0b675c8f36df31fceb76ab45242a4b0ec0d5db05 100644 (file)
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -3728,9 +3728,9 @@ GetMaxVariableSize (
 }\r
 \r
 /**\r
-  Init non-volatile variable store.\r
+  Init real non-volatile variable store.\r
 \r
-  @param[out] NvFvHeader        Output pointer to non-volatile FV header address.\r
+  @param[out] VariableStoreBase Output pointer to real non-volatile variable store base.\r
 \r
   @retval EFI_SUCCESS           Function successfully executed.\r
   @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.\r
@@ -3738,16 +3738,13 @@ GetMaxVariableSize (
 \r
 **/\r
 EFI_STATUS\r
-InitNonVolatileVariableStore (\r
-  OUT EFI_FIRMWARE_VOLUME_HEADER    **NvFvHeader\r
+InitRealNonVolatileVariableStore (\r
+  OUT EFI_PHYSICAL_ADDRESS              *VariableStoreBase\r
   )\r
 {\r
   EFI_FIRMWARE_VOLUME_HEADER            *FvHeader;\r
-  VARIABLE_HEADER                       *Variable;\r
-  VARIABLE_HEADER                       *NextVariable;\r
-  EFI_PHYSICAL_ADDRESS                  VariableStoreBase;\r
-  UINT64                                VariableStoreLength;\r
-  UINTN                                 VariableSize;\r
+  VARIABLE_STORE_HEADER                 *VariableStore;\r
+  UINT32                                VariableStoreLength;\r
   EFI_HOB_GUID_TYPE                     *GuidHob;\r
   EFI_PHYSICAL_ADDRESS                  NvStorageBase;\r
   UINT8                                 *NvStorageData;\r
@@ -3777,6 +3774,8 @@ InitNonVolatileVariableStore (
   if (NvStorageBase == 0) {\r
     NvStorageBase = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase);\r
   }\r
+  ASSERT (NvStorageBase != 0);\r
+\r
   //\r
   // Copy NV storage data to the memory buffer.\r
   //\r
@@ -3826,24 +3825,23 @@ InitNonVolatileVariableStore (
     return EFI_VOLUME_CORRUPTED;\r
   }\r
 \r
-  VariableStoreBase = (UINTN) FvHeader + FvHeader->HeaderLength;\r
+  VariableStore = (VARIABLE_STORE_HEADER *) ((UINTN) FvHeader + FvHeader->HeaderLength);\r
   VariableStoreLength = NvStorageSize - FvHeader->HeaderLength;\r
+  ASSERT (sizeof (VARIABLE_STORE_HEADER) <= VariableStoreLength);\r
+  ASSERT (VariableStore->Size == VariableStoreLength);\r
 \r
-  mNvFvHeaderCache = FvHeader;\r
-  mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;\r
-  mNvVariableCache = (VARIABLE_STORE_HEADER *) (UINTN) VariableStoreBase;\r
-  if (GetVariableStoreStatus (mNvVariableCache) != EfiValid) {\r
+  //\r
+  // Check if the Variable Store header is not corrupted\r
+  //\r
+  if (GetVariableStoreStatus (VariableStore) != EfiValid) {\r
     FreePool (NvStorageData);\r
-    mNvFvHeaderCache = NULL;\r
-    mNvVariableCache = NULL;\r
     DEBUG((EFI_D_ERROR, "Variable Store header is corrupted\n"));\r
     return EFI_VOLUME_CORRUPTED;\r
   }\r
-  ASSERT(mNvVariableCache->Size == VariableStoreLength);\r
 \r
-  ASSERT (sizeof (VARIABLE_STORE_HEADER) <= VariableStoreLength);\r
+  mNvFvHeaderCache = FvHeader;\r
 \r
-  mVariableModuleGlobal->VariableGlobal.AuthFormat = (BOOLEAN)(CompareGuid (&mNvVariableCache->Signature, &gEfiAuthenticatedVariableGuid));\r
+  *VariableStoreBase = (EFI_PHYSICAL_ADDRESS) (UINTN) VariableStore;\r
 \r
   HwErrStorageSize = PcdGet32 (PcdHwErrStorageSize);\r
   MaxUserNvVariableSpaceSize = PcdGet32 (PcdMaxUserNvVariableSpaceSize);\r
@@ -3878,14 +3876,45 @@ InitNonVolatileVariableStore (
   //\r
   ASSERT (GetNonVolatileMaxVariableSize () < (VariableStoreLength - sizeof (VARIABLE_STORE_HEADER)));\r
 \r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Init non-volatile variable store.\r
+\r
+  @retval EFI_SUCCESS           Function successfully executed.\r
+  @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.\r
+  @retval EFI_VOLUME_CORRUPTED  Variable Store or Firmware Volume for Variable Store is corrupted.\r
+\r
+**/\r
+EFI_STATUS\r
+InitNonVolatileVariableStore (\r
+  VOID\r
+  )\r
+{\r
+  VARIABLE_HEADER                       *Variable;\r
+  VARIABLE_HEADER                       *NextVariable;\r
+  EFI_PHYSICAL_ADDRESS                  VariableStoreBase;\r
+  UINTN                                 VariableSize;\r
+  EFI_STATUS                            Status;\r
+\r
+  Status = InitRealNonVolatileVariableStore (&VariableStoreBase);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;\r
+  mNvVariableCache = (VARIABLE_STORE_HEADER *) (UINTN) VariableStoreBase;\r
+  mVariableModuleGlobal->VariableGlobal.AuthFormat = (BOOLEAN)(CompareGuid (&mNvVariableCache->Signature, &gEfiAuthenticatedVariableGuid));\r
+\r
   mVariableModuleGlobal->MaxVariableSize = PcdGet32 (PcdMaxVariableSize);\r
   mVariableModuleGlobal->MaxAuthVariableSize = ((PcdGet32 (PcdMaxAuthVariableSize) != 0) ? PcdGet32 (PcdMaxAuthVariableSize) : mVariableModuleGlobal->MaxVariableSize);\r
 \r
   //\r
   // Parse non-volatile variable data and get last variable offset.\r
   //\r
-  Variable  = GetStartPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase);\r
-  while (IsValidVariableHeader (Variable, GetEndPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase))) {\r
+  Variable  = GetStartPointer (mNvVariableCache);\r
+  while (IsValidVariableHeader (Variable, GetEndPointer (mNvVariableCache))) {\r
     NextVariable = GetNextVariablePtr (Variable);\r
     VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r
     if ((Variable->Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
@@ -3896,9 +3925,8 @@ InitNonVolatileVariableStore (
 \r
     Variable = NextVariable;\r
   }\r
-  mVariableModuleGlobal->NonVolatileLastVariableOffset = (UINTN) Variable - (UINTN) VariableStoreBase;\r
+  mVariableModuleGlobal->NonVolatileLastVariableOffset = (UINTN) Variable - (UINTN) mNvVariableCache;\r
 \r
-  *NvFvHeader = FvHeader;\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -4303,7 +4331,6 @@ VariableCommonInitialize (
   VARIABLE_STORE_HEADER           *VolatileVariableStore;\r
   UINTN                           ScratchSize;\r
   EFI_GUID                        *VariableGuid;\r
-  EFI_FIRMWARE_VOLUME_HEADER      *NvFvHeader;\r
 \r
   //\r
   // Allocate runtime memory for variable driver global structure.\r
@@ -4318,8 +4345,7 @@ VariableCommonInitialize (
   //\r
   // Init non-volatile variable store.\r
   //\r
-  NvFvHeader = NULL;\r
-  Status = InitNonVolatileVariableStore (&NvFvHeader);\r
+  Status = InitNonVolatileVariableStore ();\r
   if (EFI_ERROR (Status)) {\r
     FreePool (mVariableModuleGlobal);\r
     return Status;\r
@@ -4347,7 +4373,9 @@ VariableCommonInitialize (
   //\r
   Status = GetHobVariableStore (VariableGuid);\r
   if (EFI_ERROR (Status)) {\r
-    FreePool (NvFvHeader);\r
+    if (mNvFvHeaderCache != NULL) {\r
+      FreePool (mNvFvHeaderCache);\r
+    }\r
     FreePool (mVariableModuleGlobal);\r
     return Status;\r
   }\r
@@ -4366,7 +4394,9 @@ VariableCommonInitialize (
     if (mVariableModuleGlobal->VariableGlobal.HobVariableBase != 0) {\r
       FreePool ((VOID *) (UINTN) mVariableModuleGlobal->VariableGlobal.HobVariableBase);\r
     }\r
-    FreePool (NvFvHeader);\r
+    if (mNvFvHeaderCache != NULL) {\r
+      FreePool (mNvFvHeaderCache);\r
+    }\r
     FreePool (mVariableModuleGlobal);\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r