]> git.proxmox.com Git - mirror_edk2.git/blobdiff - SecurityPkg/VariableAuthenticated/RuntimeDxe/Variable.c
Support Variable driver (VariableAuthenticatedPei/VariableAuthenticatedRuntimeDxe...
[mirror_edk2.git] / SecurityPkg / VariableAuthenticated / RuntimeDxe / Variable.c
index 0846b2a21b83778d2499354a5c826ef9947ffaeb..32bddbcb02fd5ed62b8e5c43345170f6a0080f4c 100644 (file)
@@ -715,6 +715,67 @@ Reclaim (
   return Status;\r
 }\r
 \r
+/**\r
+  Find the variable in the specified variable store.\r
+\r
+  @param  VariableName        Name of the variable to be found\r
+  @param  VendorGuid          Vendor GUID to be found.\r
+  @param  PtrTrack            Variable Track Pointer structure that contains Variable Information.\r
+\r
+  @retval  EFI_SUCCESS            Variable found successfully\r
+  @retval  EFI_NOT_FOUND          Variable not found\r
+**/\r
+EFI_STATUS\r
+FindVariableEx (\r
+  IN     CHAR16                  *VariableName,\r
+  IN     EFI_GUID                *VendorGuid,\r
+  IN OUT VARIABLE_POINTER_TRACK  *PtrTrack\r
+  )\r
+{\r
+  VARIABLE_HEADER                *InDeletedVariable;\r
+  VOID                           *Point;\r
+\r
+  //\r
+  // Find the variable by walk through HOB, volatile and non-volatile variable store.\r
+  //\r
+  InDeletedVariable  = NULL;\r
+\r
+  for ( PtrTrack->CurrPtr = PtrTrack->StartPtr\r
+      ; (PtrTrack->CurrPtr < PtrTrack->EndPtr) && IsValidVariableHeader (PtrTrack->CurrPtr)\r
+      ; PtrTrack->CurrPtr = GetNextVariablePtr (PtrTrack->CurrPtr)\r
+      ) {\r
+    if (PtrTrack->CurrPtr->State == VAR_ADDED || \r
+        PtrTrack->CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)\r
+       ) {\r
+      if (!AtRuntime () || ((PtrTrack->CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) != 0)) {\r
+        if (VariableName[0] == 0) {\r
+          if (PtrTrack->CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
+            InDeletedVariable   = PtrTrack->CurrPtr;\r
+          } else {\r
+            return EFI_SUCCESS;\r
+          }\r
+        } else {\r
+          if (CompareGuid (VendorGuid, &PtrTrack->CurrPtr->VendorGuid)) {\r
+            Point = (VOID *) GetVariableNamePtr (PtrTrack->CurrPtr);\r
+\r
+            ASSERT (NameSizeOfVariable (PtrTrack->CurrPtr) != 0);\r
+            if (CompareMem (VariableName, Point, NameSizeOfVariable (PtrTrack->CurrPtr)) == 0) {\r
+              if (PtrTrack->CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
+                InDeletedVariable     = PtrTrack->CurrPtr;\r
+              } else {\r
+                return EFI_SUCCESS;\r
+              }\r
+            }\r
+          }\r
+        }\r
+      }\r
+    }\r
+  }\r
+\r
+  PtrTrack->CurrPtr = InDeletedVariable;\r
+  return (PtrTrack->CurrPtr  == NULL) ? EFI_NOT_FOUND : EFI_SUCCESS;\r
+}\r
+\r
 \r
 /**\r
   Finds variable in storage blocks of volatile and non-volatile storage areas.\r
@@ -746,89 +807,40 @@ FindVariable (
   IN  VARIABLE_GLOBAL         *Global\r
   )\r
 {\r
-  VARIABLE_HEADER         *Variable[2];\r
-  VARIABLE_HEADER         *InDeletedVariable;\r
-  VARIABLE_STORE_HEADER   *VariableStoreHeader[2];\r
-  UINTN                   InDeletedStorageIndex;\r
-  UINTN                   Index;\r
-  VOID                    *Point;\r
+  EFI_STATUS              Status;\r
+  VARIABLE_STORE_HEADER   *VariableStoreHeader[VariableStoreTypeMax];\r
+  VARIABLE_STORE_TYPE     Type;\r
+\r
+  if (VariableName[0] != 0 && VendorGuid == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
 \r
   //\r
-  // 0: Volatile, 1: Non-Volatile.\r
+  // 0: Volatile, 1: HOB, 2: Non-Volatile.\r
   // The index and attributes mapping must be kept in this order as RuntimeServiceGetNextVariableName\r
   // make use of this mapping to implement search algorithm.\r
   //\r
-  VariableStoreHeader[0]  = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);\r
-  VariableStoreHeader[1]  = mNvVariableCache;\r
+  VariableStoreHeader[VariableStoreTypeVolatile] = (VARIABLE_STORE_HEADER *) (UINTN) Global->VolatileVariableBase;\r
+  VariableStoreHeader[VariableStoreTypeHob]      = (VARIABLE_STORE_HEADER *) (UINTN) Global->HobVariableBase;\r
+  VariableStoreHeader[VariableStoreTypeNv]       = mNvVariableCache;\r
 \r
   //\r
-  // Start Pointers for the variable.\r
-  // Actual Data Pointer where data can be written.\r
+  // Find the variable by walk through HOB, volatile and non-volatile variable store.\r
   //\r
-  Variable[0] = GetStartPointer (VariableStoreHeader[0]);\r
-  Variable[1] = GetStartPointer (VariableStoreHeader[1]);\r
-\r
-  if (VariableName[0] != 0 && VendorGuid == NULL) {\r
-    return EFI_INVALID_PARAMETER;\r
-  }\r
+  for (Type = (VARIABLE_STORE_TYPE) 0; Type < VariableStoreTypeMax; Type++) {\r
+    if (VariableStoreHeader[Type] == NULL) {\r
+      continue;\r
+    }\r
 \r
-  //\r
-  // Find the variable by walk through volatile and then non-volatile variable store.\r
-  //\r
-  InDeletedVariable     = NULL;\r
-  InDeletedStorageIndex = 0;\r
-  for (Index = 0; Index < 2; Index++) {\r
-    while ((Variable[Index] < GetEndPointer (VariableStoreHeader[Index])) && IsValidVariableHeader (Variable[Index])) {\r
-      if (Variable[Index]->State == VAR_ADDED || \r
-          Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)\r
-         ) {\r
-        if (!AtRuntime () || ((Variable[Index]->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) != 0)) {\r
-          if (VariableName[0] == 0) {\r
-            if (Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
-              InDeletedVariable     = Variable[Index];\r
-              InDeletedStorageIndex = Index;\r
-            } else {\r
-              PtrTrack->StartPtr  = GetStartPointer (VariableStoreHeader[Index]);\r
-              PtrTrack->EndPtr    = GetEndPointer (VariableStoreHeader[Index]);\r
-              PtrTrack->CurrPtr   = Variable[Index];\r
-              PtrTrack->Volatile  = (BOOLEAN)(Index == 0);\r
-\r
-              return EFI_SUCCESS;\r
-            }\r
-          } else {\r
-            if (CompareGuid (VendorGuid, &Variable[Index]->VendorGuid)) {\r
-              Point = (VOID *) GetVariableNamePtr (Variable[Index]);\r
-\r
-              ASSERT (NameSizeOfVariable (Variable[Index]) != 0);\r
-              if (CompareMem (VariableName, Point, NameSizeOfVariable (Variable[Index])) == 0) {\r
-                if (Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
-                  InDeletedVariable     = Variable[Index];\r
-                  InDeletedStorageIndex = Index;\r
-                } else {\r
-                  PtrTrack->StartPtr  = GetStartPointer (VariableStoreHeader[Index]);\r
-                  PtrTrack->EndPtr    = GetEndPointer (VariableStoreHeader[Index]);\r
-                  PtrTrack->CurrPtr   = Variable[Index];\r
-                  PtrTrack->Volatile  = (BOOLEAN)(Index == 0);\r
-\r
-                  return EFI_SUCCESS;\r
-                }\r
-              }\r
-            }\r
-          }\r
-        }\r
-      }\r
+    PtrTrack->StartPtr = GetStartPointer (VariableStoreHeader[Type]);\r
+    PtrTrack->EndPtr   = GetEndPointer   (VariableStoreHeader[Type]);\r
+    PtrTrack->Volatile = (BOOLEAN) (Type == VariableStoreTypeVolatile);\r
 \r
-      Variable[Index] = GetNextVariablePtr (Variable[Index]);\r
-    }\r
-    if (InDeletedVariable != NULL) {\r
-      PtrTrack->StartPtr  = GetStartPointer (VariableStoreHeader[InDeletedStorageIndex]);\r
-      PtrTrack->EndPtr    = GetEndPointer (VariableStoreHeader[InDeletedStorageIndex]);\r
-      PtrTrack->CurrPtr   = InDeletedVariable;\r
-      PtrTrack->Volatile  = (BOOLEAN)(InDeletedStorageIndex == 0);\r
-      return EFI_SUCCESS;\r
+    Status = FindVariableEx (VariableName, VendorGuid, PtrTrack);\r
+    if (!EFI_ERROR (Status)) {\r
+      return Status;\r
     }\r
   }\r
-  PtrTrack->CurrPtr = NULL;\r
   return EFI_NOT_FOUND;\r
 }\r
 \r
@@ -1226,7 +1238,7 @@ AutoUpdateLangVariable(
     // Update Lang if PlatformLang is already set\r
     // Update PlatformLang if Lang is already set\r
     //\r
-    Status = FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *) mVariableModuleGlobal);\r
+    Status = FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal);\r
     if (!EFI_ERROR (Status)) {\r
       //\r
       // Update Lang\r
@@ -1235,7 +1247,7 @@ AutoUpdateLangVariable(
       Data         = GetVariableDataPtr (Variable.CurrPtr);\r
       DataSize     = Variable.CurrPtr->DataSize;\r
     } else {\r
-      Status = FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *) mVariableModuleGlobal);\r
+      Status = FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal);\r
       if (!EFI_ERROR (Status)) {\r
         //\r
         // Update PlatformLang\r
@@ -1280,7 +1292,7 @@ AutoUpdateLangVariable(
         //\r
         // Successfully convert PlatformLang to Lang, and set the BestLang value into Lang variable simultaneously.\r
         //\r
-        FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal);\r
+        FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal);\r
 \r
         Status = UpdateVariable (L"Lang", &gEfiGlobalVariableGuid, BestLang,\r
                                  ISO_639_2_ENTRY_SIZE + 1, Attributes, 0, 0, &Variable, NULL);\r
@@ -1314,7 +1326,7 @@ AutoUpdateLangVariable(
         //\r
         // Successfully convert Lang to PlatformLang, and set the BestPlatformLang value into PlatformLang variable simultaneously.\r
         //\r
-        FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal);\r
+        FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal);\r
 \r
         Status = UpdateVariable (L"PlatformLang", &gEfiGlobalVariableGuid, BestPlatformLang, \r
                                  AsciiStrSize (BestPlatformLang), Attributes, 0, 0, &Variable, NULL);\r
@@ -1935,9 +1947,12 @@ VariableServiceGetNextVariableName (
   IN OUT  EFI_GUID          *VendorGuid\r
   )\r
 {\r
+  VARIABLE_STORE_TYPE     Type;\r
   VARIABLE_POINTER_TRACK  Variable;\r
+  VARIABLE_POINTER_TRACK  VariableInHob;\r
   UINTN                   VarNameSize;\r
   EFI_STATUS              Status;\r
+  VARIABLE_STORE_HEADER   *VariableStoreHeader[VariableStoreTypeMax];\r
 \r
   if (VariableNameSize == NULL || VariableName == NULL || VendorGuid == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
@@ -1957,45 +1972,85 @@ VariableServiceGetNextVariableName (
     Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r
   }\r
 \r
+  //\r
+  // 0: Volatile, 1: HOB, 2: Non-Volatile.\r
+  // The index and attributes mapping must be kept in this order as FindVariable\r
+  // makes use of this mapping to implement search algorithm.\r
+  //\r
+  VariableStoreHeader[VariableStoreTypeVolatile] = (VARIABLE_STORE_HEADER *) (UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;\r
+  VariableStoreHeader[VariableStoreTypeHob]      = (VARIABLE_STORE_HEADER *) (UINTN) mVariableModuleGlobal->VariableGlobal.HobVariableBase;\r
+  VariableStoreHeader[VariableStoreTypeNv]       = mNvVariableCache;\r
+\r
   while (TRUE) {\r
     //\r
-    // If both volatile and non-volatile variable store are parsed,\r
-    // return not found.\r
+    // Switch from Volatile to HOB, to Non-Volatile.\r
     //\r
-    if (Variable.CurrPtr >= Variable.EndPtr || Variable.CurrPtr == NULL) {\r
-      Variable.Volatile = (BOOLEAN) (Variable.Volatile ^ ((BOOLEAN) 0x1));\r
-      if (!Variable.Volatile) {\r
-        Variable.StartPtr = GetStartPointer ((VARIABLE_STORE_HEADER *) (UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);\r
-        Variable.EndPtr   = GetEndPointer ((VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase));\r
-      } else {\r
+    while ((Variable.CurrPtr >= Variable.EndPtr) ||\r
+           (Variable.CurrPtr == NULL)            ||\r
+           !IsValidVariableHeader (Variable.CurrPtr)\r
+          ) {\r
+      //\r
+      // Find current storage index\r
+      //\r
+      for (Type = (VARIABLE_STORE_TYPE) 0; Type < VariableStoreTypeMax; Type++) {\r
+        if ((VariableStoreHeader[Type] != NULL) && (Variable.StartPtr == GetStartPointer (VariableStoreHeader[Type]))) {\r
+          break;\r
+        }\r
+      }\r
+      ASSERT (Type < VariableStoreTypeMax);\r
+      //\r
+      // Switch to next storage\r
+      //\r
+      for (Type++; Type < VariableStoreTypeMax; Type++) {\r
+        if (VariableStoreHeader[Type] != NULL) {\r
+          break;\r
+        }\r
+      }\r
+      //\r
+      // Capture the case that \r
+      // 1. current storage is the last one, or\r
+      // 2. no further storage\r
+      //\r
+      if (Type == VariableStoreTypeMax) {\r
         Status = EFI_NOT_FOUND;\r
         goto Done;\r
       }\r
-\r
-      Variable.CurrPtr = Variable.StartPtr;\r
-      if (!IsValidVariableHeader (Variable.CurrPtr)) {\r
-        continue;\r
-      }\r
+      Variable.StartPtr = GetStartPointer (VariableStoreHeader[Type]);\r
+      Variable.EndPtr   = GetEndPointer   (VariableStoreHeader[Type]);\r
+      Variable.CurrPtr  = Variable.StartPtr;\r
     }\r
+\r
     //\r
     // Variable is found\r
     //\r
-    if (IsValidVariableHeader (Variable.CurrPtr) && Variable.CurrPtr->State == VAR_ADDED) {\r
+    if (Variable.CurrPtr->State == VAR_ADDED) {\r
       if ((AtRuntime () && ((Variable.CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0)) == 0) {\r
+\r
+        //\r
+        // Don't return NV variable when HOB overrides it\r
+        //\r
+        if ((VariableStoreHeader[VariableStoreTypeHob] != NULL) && (VariableStoreHeader[VariableStoreTypeNv] != NULL) && \r
+            (Variable.StartPtr == GetStartPointer (VariableStoreHeader[VariableStoreTypeNv]))\r
+           ) {\r
+          VariableInHob.StartPtr = GetStartPointer (VariableStoreHeader[VariableStoreTypeHob]);\r
+          VariableInHob.EndPtr   = GetEndPointer   (VariableStoreHeader[VariableStoreTypeHob]);\r
+          Status = FindVariableEx (\r
+                     GetVariableNamePtr (Variable.CurrPtr),\r
+                     &Variable.CurrPtr->VendorGuid,\r
+                     &VariableInHob\r
+                     );\r
+          if (!EFI_ERROR (Status)) {\r
+            Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r
+            continue;\r
+          }\r
+        }\r
+\r
         VarNameSize = NameSizeOfVariable (Variable.CurrPtr);\r
         ASSERT (VarNameSize != 0);\r
 \r
         if (VarNameSize <= *VariableNameSize) {\r
-          CopyMem (\r
-            VariableName,\r
-            GetVariableNamePtr (Variable.CurrPtr),\r
-            VarNameSize\r
-            );\r
-          CopyMem (\r
-            VendorGuid,\r
-            &Variable.CurrPtr->VendorGuid,\r
-            sizeof (EFI_GUID)\r
-            );\r
+          CopyMem (VariableName, GetVariableNamePtr (Variable.CurrPtr), VarNameSize);\r
+          CopyMem (VendorGuid, &Variable.CurrPtr->VendorGuid, sizeof (EFI_GUID));\r
           Status = EFI_SUCCESS;\r
         } else {\r
           Status = EFI_BUFFER_TOO_SMALL;\r
@@ -2376,16 +2431,16 @@ VariableWriteServiceInitialize (
   UINTN                           Index;\r
   UINT8                           Data;\r
   EFI_PHYSICAL_ADDRESS            VariableStoreBase;\r
-  UINT64                          VariableStoreLength;\r
+  VARIABLE_HEADER                 *Variable;\r
+  VOID                            *VariableData;\r
 \r
   VariableStoreBase   = mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase;\r
   VariableStoreHeader = (VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase;\r
-  VariableStoreLength = VariableStoreHeader->Size;\r
-  \r
\r
   //\r
   // Check if the free area is really free.\r
   //\r
-  for (Index = mVariableModuleGlobal->NonVolatileLastVariableOffset; Index < VariableStoreLength; Index++) {\r
+  for (Index = mVariableModuleGlobal->NonVolatileLastVariableOffset; Index < VariableStoreHeader->Size; Index++) {\r
     Data = ((UINT8 *) mNvVariableCache)[Index];\r
     if (Data != 0xff) {\r
       //\r
@@ -2404,6 +2459,35 @@ VariableWriteServiceInitialize (
     }\r
   }\r
 \r
+  \r
+  //\r
+  // Flush the HOB variable to flash and invalidate HOB variable.\r
+  //\r
+  if (mVariableModuleGlobal->VariableGlobal.HobVariableBase != 0) {\r
+    //\r
+    // Clear the HobVariableBase to avoid SetVariable() updating the variable in HOB\r
+    //\r
+    VariableStoreHeader = (VARIABLE_STORE_HEADER *) (UINTN) mVariableModuleGlobal->VariableGlobal.HobVariableBase;\r
+    mVariableModuleGlobal->VariableGlobal.HobVariableBase = 0;\r
+\r
+    for ( Variable = GetStartPointer (VariableStoreHeader)\r
+        ; (Variable < GetEndPointer (VariableStoreHeader) && IsValidVariableHeader (Variable))\r
+        ; Variable = GetNextVariablePtr (Variable)\r
+        ) {\r
+      ASSERT (Variable->State == VAR_ADDED);\r
+      ASSERT ((Variable->Attributes & EFI_VARIABLE_NON_VOLATILE) != 0);\r
+      VariableData = GetVariableDataPtr (Variable);\r
+      Status = VariableServiceSetVariable (\r
+                 GetVariableNamePtr (Variable),\r
+                 &Variable->VendorGuid,\r
+                 Variable->Attributes,\r
+                 Variable->DataSize,\r
+                 VariableData\r
+                 );\r
+      ASSERT_EFI_ERROR (Status);\r
+    }\r
+  }\r
+\r
   //\r
   // Authenticated variable initialize.\r
   //\r
@@ -2434,6 +2518,7 @@ VariableCommonInitialize (
   UINT64                          VariableStoreLength;\r
   UINTN                           ScratchSize;\r
   UINTN                           VariableSize;\r
+  EFI_HOB_GUID_TYPE               *GuidHob;\r
 \r
   //\r
   // Allocate runtime memory for variable driver global structure.\r
@@ -2453,6 +2538,19 @@ VariableCommonInitialize (
   //\r
   ASSERT (PcdGet32 (PcdHwErrStorageSize) <= PcdGet32 (PcdFlashNvStorageVariableSize));\r
 \r
+  //\r
+  // Get HOB variable store.\r
+  //\r
+  GuidHob = GetFirstGuidHob (&gEfiAuthenticatedVariableGuid);\r
+  if (GuidHob != NULL) {\r
+    VariableStoreHeader = GET_GUID_HOB_DATA (GuidHob);\r
+    if (GetVariableStoreStatus (VariableStoreHeader) == EfiValid) {\r
+      mVariableModuleGlobal->VariableGlobal.HobVariableBase = (EFI_PHYSICAL_ADDRESS) (UINTN) VariableStoreHeader;\r
+    } else {\r
+      DEBUG ((EFI_D_ERROR, "HOB Variable Store header is corrupted!\n"));\r
+    }\r
+  }\r
+\r
   //\r
   // Allocate memory for volatile variable store, note that there is a scratch space to store scratch data.\r
   //\r
@@ -2480,7 +2578,7 @@ VariableCommonInitialize (
   VolatileVariableStore->Reserved1   = 0;\r
 \r
   //\r
-  // Get non-volatile varaible store.\r
+  // Get non-volatile variable store.\r
   //\r
 \r
   TempVariableStoreHeader = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64);\r