MdeModulePkg Variable: Abstract GetHobVariableStore function

Move getting HOB variable store code logic to a separated
GetHobVariableStore function.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

2 files changed, 91 insertions, 42 deletions

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c
index 4060f4711d..1bcab3b770 100644
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.c
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.c
@@ -2,7 +2,7 @@
   Implement ReadOnly Variable Services required by PEIM and install

   PEI ReadOnly Varaiable2 PPI. These services operates the non volatile storage space.

 

-Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>

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

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -496,6 +496,31 @@ CompareWithValidVariable (
 }

 

 /**

+  Get HOB variable store.

+

+**/

+VOID

+GetHobVariableStore (

+  OUT VARIABLE_STORE_INFO        *StoreInfo,

+  OUT VARIABLE_STORE_HEADER      **VariableStoreHeader

+  )

+{

+  EFI_HOB_GUID_TYPE              *GuidHob;

+

+  GuidHob = GetFirstGuidHob (&gEfiAuthenticatedVariableGuid);

+  if (GuidHob != NULL) {

+    *VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);

+    StoreInfo->AuthFlag = TRUE;

+  } else {

+    GuidHob = GetFirstGuidHob (&gEfiVariableGuid);

+    if (GuidHob != NULL) {

+      *VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);

+      StoreInfo->AuthFlag = FALSE;

+    }

+  }

+}

+

+/**

   Return the variable store header and the store info based on the Index.

 

   @param Type       The type of the variable store.

@@ -523,17 +548,8 @@ GetVariableStore (
   VariableStoreHeader = NULL;

   switch (Type) {

     case VariableStoreTypeHob:

-      GuidHob = GetFirstGuidHob (&gEfiAuthenticatedVariableGuid);

-      if (GuidHob != NULL) {

-        VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);

-        StoreInfo->AuthFlag = TRUE;

-      } else {

-        GuidHob = GetFirstGuidHob (&gEfiVariableGuid);

-        if (GuidHob != NULL) {

-          VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);

-          StoreInfo->AuthFlag = FALSE;

-        }

-      }

+      GetHobVariableStore (StoreInfo, &VariableStoreHeader);

+

       break;

 

     case VariableStoreTypeNv:

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 835a66bc3b..fca8d53809 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -4169,6 +4169,64 @@ ConvertNormalVarStorageToAuthVarStorage (
   mVariableModuleGlobal->VariableGlobal.AuthFormat = TRUE;

   return AuthVarStorage;

 }

+

+/**

+  Get HOB variable store.

+

+  @param[out] VariableGuid      NV variable store signature.

+

+  @retval EFI_SUCCESS           Function successfully executed.

+  @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.

+

+**/

+EFI_STATUS

+GetHobVariableStore (

+  IN EFI_GUID                   *VariableGuid

+  )

+{

+  VARIABLE_STORE_HEADER         *VariableStoreHeader;

+  UINT64                        VariableStoreLength;

+  EFI_HOB_GUID_TYPE             *GuidHob;

+  BOOLEAN                       NeedConvertNormalToAuth;

+

+  //

+  // Combinations supported:

+  // 1. Normal NV variable store +

+  //    Normal HOB variable store

+  // 2. Auth NV variable store +

+  //    Auth HOB variable store

+  // 3. Auth NV variable store +

+  //    Normal HOB variable store (code will convert it to Auth Format)

+  //

+  NeedConvertNormalToAuth = FALSE;

+  GuidHob = GetFirstGuidHob (VariableGuid);

+  if (GuidHob == NULL && VariableGuid == &gEfiAuthenticatedVariableGuid) {

+    //

+    // Try getting it from normal variable HOB

+    //

+    GuidHob = GetFirstGuidHob (&gEfiVariableGuid);

+    NeedConvertNormalToAuth = TRUE;

+  }

+  if (GuidHob != NULL) {

+    VariableStoreHeader = GET_GUID_HOB_DATA (GuidHob);

+    VariableStoreLength = GuidHob->Header.HobLength - sizeof (EFI_HOB_GUID_TYPE);

+    if (GetVariableStoreStatus (VariableStoreHeader) == EfiValid) {

+      if (!NeedConvertNormalToAuth) {

+        mVariableModuleGlobal->VariableGlobal.HobVariableBase = (EFI_PHYSICAL_ADDRESS) (UINTN) AllocateRuntimeCopyPool ((UINTN) VariableStoreLength, (VOID *) VariableStoreHeader);

+      } else {

+        mVariableModuleGlobal->VariableGlobal.HobVariableBase = (EFI_PHYSICAL_ADDRESS) (UINTN) ConvertNormalVarStorageToAuthVarStorage ((VOID *) VariableStoreHeader);

+      }

+      if (mVariableModuleGlobal->VariableGlobal.HobVariableBase == 0) {

+        return EFI_OUT_OF_RESOURCES;

+      }

+    } else {

+      DEBUG ((EFI_D_ERROR, "HOB Variable Store header is corrupted!\n"));

+    }

+  }

+

+  return EFI_SUCCESS;

+}

+

 /**

   Initializes variable store area for non-volatile and volatile variable.

 

@@ -4183,13 +4241,9 @@ VariableCommonInitialize (
 {

   EFI_STATUS                      Status;

   VARIABLE_STORE_HEADER           *VolatileVariableStore;

-  VARIABLE_STORE_HEADER           *VariableStoreHeader;

-  UINT64                          VariableStoreLength;

   UINTN                           ScratchSize;

-  EFI_HOB_GUID_TYPE               *GuidHob;

   EFI_GUID                        *VariableGuid;

   EFI_FIRMWARE_VOLUME_HEADER      *NvFvHeader;

-  BOOLEAN                         IsNormalVariableHob;

 

   //

   // Allocate runtime memory for variable driver global structure.

@@ -4231,32 +4285,11 @@ VariableCommonInitialize (
   //

   // Get HOB variable store.

   //

-  IsNormalVariableHob = FALSE;

-  GuidHob = GetFirstGuidHob (VariableGuid);

-  if (GuidHob == NULL && VariableGuid == &gEfiAuthenticatedVariableGuid) {

-    //

-    // Try getting it from normal variable HOB

-    //

-    GuidHob = GetFirstGuidHob (&gEfiVariableGuid);

-    IsNormalVariableHob = TRUE;

-  }

-  if (GuidHob != NULL) {

-    VariableStoreHeader = GET_GUID_HOB_DATA (GuidHob);

-    VariableStoreLength = GuidHob->Header.HobLength - sizeof (EFI_HOB_GUID_TYPE);

-    if (GetVariableStoreStatus (VariableStoreHeader) == EfiValid) {

-      if (!IsNormalVariableHob) {

-        mVariableModuleGlobal->VariableGlobal.HobVariableBase = (EFI_PHYSICAL_ADDRESS) (UINTN) AllocateRuntimeCopyPool ((UINTN) VariableStoreLength, (VOID *) VariableStoreHeader);

-      } else {

-        mVariableModuleGlobal->VariableGlobal.HobVariableBase = (EFI_PHYSICAL_ADDRESS) (UINTN) ConvertNormalVarStorageToAuthVarStorage ((VOID *) VariableStoreHeader);

-      }

-      if (mVariableModuleGlobal->VariableGlobal.HobVariableBase == 0) {

-        FreePool (NvFvHeader);

-        FreePool (mVariableModuleGlobal);

-        return EFI_OUT_OF_RESOURCES;

-      }

-    } else {

-      DEBUG ((EFI_D_ERROR, "HOB Variable Store header is corrupted!\n"));

-    }

+  Status = GetHobVariableStore (VariableGuid);

+  if (EFI_ERROR (Status)) {

+    FreePool (NvFvHeader);

+    FreePool (mVariableModuleGlobal);

+    return Status;

   }

 

   mVariableModuleGlobal->MaxVolatileVariableSize = ((PcdGet32 (PcdMaxVolatileVariableSize) != 0) ?