[Description]:

The patch enhanced variable services to support:
1) If adding variable does not execute completely, the state is in_deleted, the next time find variable should have to retrieve the in_deleted variable.
2) when Reclaiming the variable storage, the 1) variable should be considered.

[Impaction]:
This is backward-compatible update.

[Reference Info]:
9552, 8632

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@4916 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 019f0a806df22461b8cbc733a02fc3bec5d316e7..9f6a9acd5010740e206f8baad07149b13cb29720 100644 (file)
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -574,7 +574,8 @@ EFI_STATUS
 Reclaim (\r
   IN  EFI_PHYSICAL_ADDRESS  VariableBase,\r
   OUT UINTN                 *LastVariableOffset,\r
-  IN  BOOLEAN               IsVolatile\r
+  IN  BOOLEAN               IsVolatile,\r
+  IN  VARIABLE_HEADER       *UpdatingVariable\r
   )\r
 /*++\r
 \r
@@ -596,12 +597,18 @@ Returns:
 --*/\r
 {\r
   VARIABLE_HEADER       *Variable;\r
+  VARIABLE_HEADER       *AddedVariable;\r
   VARIABLE_HEADER       *NextVariable;\r
+  VARIABLE_HEADER       *NextAddedVariable;\r
   VARIABLE_STORE_HEADER *VariableStoreHeader;\r
   UINT8                 *ValidBuffer;\r
-  UINTN                 ValidBufferSize;\r
+  UINTN                 MaximumBufferSize;\r
   UINTN                 VariableSize;\r
+  UINTN                 NameSize;\r
   UINT8                 *CurrPtr;\r
+  VOID                  *Point0;\r
+  VOID                  *Point1;\r
+  BOOLEAN               FoundAdded;\r
   EFI_STATUS            Status;\r
 \r
   VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) VariableBase);\r
@@ -609,39 +616,47 @@ Returns:
   //\r
   // Start Pointers for the variable.\r
   //\r
-  Variable        = GetStartPointer (VariableStoreHeader);\r
-  ValidBufferSize = sizeof (VARIABLE_STORE_HEADER);\r
+  Variable          = GetStartPointer (VariableStoreHeader);\r
+  MaximumBufferSize = sizeof (VARIABLE_STORE_HEADER);\r
 \r
   while (IsValidVariableHeader (Variable)) {\r
     NextVariable = GetNextVariablePtr (Variable);\r
-    if (Variable->State == VAR_ADDED) {\r
+    if (Variable->State == VAR_ADDED || \r
+        Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)\r
+       ) {\r
       VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r
-      ValidBufferSize += VariableSize;\r
+      MaximumBufferSize += VariableSize;\r
     }\r
 \r
     Variable = NextVariable;\r
   }\r
 \r
-  ValidBuffer = AllocatePool (ValidBufferSize);\r
+  //\r
+  // Reserve the 1 Bytes with Oxff to identify the \r
+  // end of the variable buffer. \r
+  // \r
+  MaximumBufferSize += 1;\r
+  ValidBuffer = AllocatePool (MaximumBufferSize);\r
   if (ValidBuffer == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
-  SetMem (ValidBuffer, ValidBufferSize, 0xff);\r
-\r
-  CurrPtr = ValidBuffer;\r
+  SetMem (ValidBuffer, MaximumBufferSize, 0xff);\r
 \r
   //\r
   // Copy variable store header\r
   //\r
-  CopyMem (CurrPtr, VariableStoreHeader, sizeof (VARIABLE_STORE_HEADER));\r
-  CurrPtr = (UINT8 *) GetStartPointer ((VARIABLE_STORE_HEADER *) CurrPtr);\r
+  CopyMem (ValidBuffer, VariableStoreHeader, sizeof (VARIABLE_STORE_HEADER));\r
+  CurrPtr = (UINT8 *) GetStartPointer ((VARIABLE_STORE_HEADER *) ValidBuffer);\r
 \r
   //\r
   // Start Pointers for the variable.\r
   //\r
-  Variable = GetStartPointer (VariableStoreHeader);\r
 \r
+  //\r
+  // Reinstall all ADDED variables\r
+  // \r
+  Variable = GetStartPointer (VariableStoreHeader);\r
   while (IsValidVariableHeader (Variable)) {\r
     NextVariable = GetNextVariablePtr (Variable);\r
     if (Variable->State == VAR_ADDED) {\r
@@ -652,14 +667,61 @@ Returns:
 \r
     Variable = NextVariable;\r
   }\r
+  //\r
+  // Reinstall all in delete transition variables\r
+  // \r
+  Variable      = GetStartPointer (VariableStoreHeader);\r
+  while (IsValidVariableHeader (Variable)) {\r
+    NextVariable = GetNextVariablePtr (Variable);\r
+    if (Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
+\r
+      //\r
+      // Buffer has cached all ADDED variable. \r
+      // Per IN_DELETED variable, we have to guarantee that\r
+      // no ADDED one in previous buffer. \r
+      // \r
+     \r
+      FoundAdded = FALSE;\r
+      AddedVariable = GetStartPointer ((VARIABLE_STORE_HEADER *) ValidBuffer);\r
+      while (IsValidVariableHeader (AddedVariable)) {\r
+        NextAddedVariable = GetNextVariablePtr (AddedVariable);\r
+        NameSize = NameSizeOfVariable (AddedVariable);\r
+        if (CompareGuid (&AddedVariable->VendorGuid, &Variable->VendorGuid) &&\r
+            NameSize == NameSizeOfVariable (Variable)\r
+           ) {\r
+          Point0 = (VOID *) GetVariableNamePtr (AddedVariable);\r
+          Point1 = (VOID *) GetVariableNamePtr (Variable);\r
+          if (!CompareMem (\r
+                Point0,\r
+                Point1,\r
+                NameSizeOfVariable (AddedVariable)\r
+                )\r
+             ) {\r
+            FoundAdded = TRUE;\r
+            break;\r
+          }\r
+        }\r
+        AddedVariable = NextAddedVariable;\r
+      }\r
+      if (!FoundAdded) {\r
+        VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r
+        CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);\r
+        if (Variable != UpdatingVariable) {\r
+          ((VARIABLE_HEADER *) CurrPtr)->State = VAR_ADDED;\r
+        }\r
+        CurrPtr += VariableSize;\r
+      }\r
+    }\r
+\r
+    Variable = NextVariable;\r
+  }\r
 \r
   if (IsVolatile) {\r
     //\r
     // If volatile variable store, just copy valid buffer\r
     //\r
     SetMem ((UINT8 *) (UINTN) VariableBase, VariableStoreHeader->Size, 0xff);\r
-    CopyMem ((UINT8 *) (UINTN) VariableBase, ValidBuffer, ValidBufferSize);\r
-    *LastVariableOffset = ValidBufferSize;\r
+    CopyMem ((UINT8 *) (UINTN) VariableBase, ValidBuffer, (UINTN) (CurrPtr - (UINT8 *) ValidBuffer));\r
     Status              = EFI_SUCCESS;\r
   } else {\r
     //\r
@@ -668,19 +730,17 @@ Returns:
     Status = FtwVariableSpace (\r
               VariableBase,\r
               ValidBuffer,\r
-              ValidBufferSize\r
+              (UINTN) (CurrPtr - (UINT8 *) ValidBuffer)\r
               );\r
-    if (!EFI_ERROR (Status)) {\r
-      *LastVariableOffset = ValidBufferSize;\r
-    }\r
   }\r
-\r
-  FreePool (ValidBuffer);\r
-\r
-  if (EFI_ERROR (Status)) {\r
+  if (!EFI_ERROR (Status)) {\r
+    *LastVariableOffset = (UINTN) (CurrPtr - (UINT8 *) ValidBuffer);\r
+  } else {\r
     *LastVariableOffset = 0;\r
   }\r
 \r
+  FreePool (ValidBuffer);\r
+\r
   return Status;\r
 }\r
 \r
@@ -838,10 +898,12 @@ Returns:
 \r
 --*/\r
 {\r
-  VARIABLE_HEADER       *Variable[2];\r
-  VARIABLE_STORE_HEADER *VariableStoreHeader[2];\r
-  UINTN                 Index;\r
-  VOID                  *Point;\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
 \r
   //\r
   // 0: Volatile, 1: Non-Volatile\r
@@ -861,29 +923,47 @@ Returns:
   if (VariableName[0] != 0 && VendorGuid == NULL) {\r
     return EFI_INVALID_PARAMETER;\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
-    PtrTrack->StartPtr  = GetStartPointer (VariableStoreHeader[Index]);\r
-    PtrTrack->EndPtr    = GetEndPointer (VariableStoreHeader[Index]);\r
-\r
     while (IsValidVariableHeader (Variable[Index]) && (Variable[Index] <= GetEndPointer (VariableStoreHeader[Index]))) {\r
-      if (Variable[Index]->State == VAR_ADDED) {\r
+      if (Variable[Index]->State == VAR_ADDED || \r
+          Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)\r
+         ) {\r
         if (!EfiAtRuntime () || (Variable[Index]->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)) {\r
           if (VariableName[0] == 0) {\r
-            PtrTrack->CurrPtr   = Variable[Index];\r
-            PtrTrack->Volatile  = (BOOLEAN)(Index == 0);\r
-            return EFI_SUCCESS;\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]))) {\r
-                PtrTrack->CurrPtr   = Variable[Index];\r
-                PtrTrack->Volatile  = (BOOLEAN)(Index == 0);\r
-                return EFI_SUCCESS;\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
@@ -892,6 +972,13 @@ Returns:
 \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
+    }\r
   }\r
   PtrTrack->CurrPtr = NULL;\r
   return EFI_NOT_FOUND;\r
@@ -1279,6 +1366,7 @@ RuntimeServiceSetVariable (
       goto Done;\r
     } else if ((Variable.CurrPtr->State == VAR_ADDED) ||\r
                (Variable.CurrPtr->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION))) {\r
+\r
       //\r
       // Mark the old variable as in delete transition\r
       //\r
@@ -1388,7 +1476,7 @@ RuntimeServiceSetVariable (
       //\r
       // Perform garbage collection & reclaim operation\r
       //\r
-      Status = Reclaim (mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase, NonVolatileOffset, FALSE);\r
+      Status = Reclaim (mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase, NonVolatileOffset, FALSE, Variable.CurrPtr);\r
       if (EFI_ERROR (Status)) {\r
         goto Done;\r
       }\r
@@ -1492,7 +1580,7 @@ RuntimeServiceSetVariable (
       //\r
       // Perform garbage collection & reclaim operation\r
       //\r
-      Status = Reclaim (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase, VolatileOffset, TRUE);\r
+      Status = Reclaim (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase, VolatileOffset, TRUE, Variable.CurrPtr);\r
       if (EFI_ERROR (Status)) {\r
         goto Done;\r
       }\r
@@ -1723,7 +1811,8 @@ ReclaimForOS(
     Status = Reclaim (\r
               mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase,\r
               &mVariableModuleGlobal->NonVolatileLastVariableOffset,\r
-              FALSE\r
+              FALSE,\r
+              NULL\r
               );\r
     ASSERT_EFI_ERROR (Status);\r
   }\r
@@ -1912,7 +2001,8 @@ Returns:
         Status = Reclaim (\r
                   mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase,\r
                   &mVariableModuleGlobal->NonVolatileLastVariableOffset,\r
-                  FALSE\r
+                  FALSE,\r
+                  NULL\r
                   );\r
 \r
         if (EFI_ERROR (Status)) {\r