MdeModulePkg and SecurityPkg Variable: Optimize the code to reduce some SMRAM consumption during variable reclaiming.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14832 6f19259b-4bc3-4df7-8a09-765794883524

MdeModulePkg/Universal/Variable/RuntimeDxe/Reclaim.c

@@ -3,7 +3,7 @@
   Handles non-volatile variable store garbage collection, using FTW
   (Fault Tolerant Write) protocol.
 
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2013, 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
@@ -99,8 +99,7 @@ GetLbaAndOffsetByAddress (
   VariableBase. Fault Tolerant Write protocol is used for writing.
 
   @param  VariableBase   Base address of variable to write
-  @param  Buffer         Point to the data buffer.
+  @param  VariableBuffer Point to the variable data buffer.
-  @param  BufferSize     The number of bytes of the data Buffer.
 
   @retval EFI_SUCCESS    The function completed successfully.
   @retval EFI_NOT_FOUND  Fail to locate Fault Tolerant Write protocol.
@@ -110,15 +109,13 @@ GetLbaAndOffsetByAddress (
 EFI_STATUS
 FtwVariableSpace (
   IN EFI_PHYSICAL_ADDRESS   VariableBase,
-  IN UINT8                  *Buffer,
+  IN VARIABLE_STORE_HEADER  *VariableBuffer
-  IN UINTN                  BufferSize
   )
 {
   EFI_STATUS                         Status;
   EFI_HANDLE                         FvbHandle;
   EFI_LBA                            VarLba;
   UINTN                              VarOffset;
-  UINT8                              *FtwBuffer;
   UINTN                              FtwBufferSize;
   EFI_FAULT_TOLERANT_WRITE_PROTOCOL  *FtwProtocol;
 
@@ -143,17 +140,9 @@ FtwVariableSpace (
   if (EFI_ERROR (Status)) {
     return EFI_ABORTED;
   }
-  //
-  // Prepare for the variable data.
-  //
-  FtwBufferSize = ((VARIABLE_STORE_HEADER *) ((UINTN) VariableBase))->Size;
-  FtwBuffer     = AllocatePool (FtwBufferSize);
-  if (FtwBuffer == NULL) {
-    return EFI_OUT_OF_RESOURCES;
-  }
 
-  SetMem (FtwBuffer, FtwBufferSize, (UINT8) 0xff);
+  FtwBufferSize = ((VARIABLE_STORE_HEADER *) ((UINTN) VariableBase))->Size;
-  CopyMem (FtwBuffer, Buffer, BufferSize);
+  ASSERT (FtwBufferSize == VariableBuffer->Size);
 
   //
   // FTW write record.
@@ -165,9 +154,8 @@ FtwVariableSpace (
                           FtwBufferSize,  // NumBytes
                           NULL,           // PrivateData NULL
                           FvbHandle,      // Fvb Handle
-                          FtwBuffer       // write buffer
+                          (VOID *) VariableBuffer // write buffer
                           );
 
-  FreePool (FtwBuffer);
   return Status;
 }

MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c

@@ -615,40 +615,49 @@ Reclaim (
   CommonVariableTotalSize = 0;
   HwErrVariableTotalSize  = 0;
 
-  //
+  if (IsVolatile) {
-  // Start Pointers for the variable.
+    //
-  //
+    // Start Pointers for the variable.
-  Variable          = GetStartPointer (VariableStoreHeader);
+    //
-  MaximumBufferSize = sizeof (VARIABLE_STORE_HEADER);
+    Variable          = GetStartPointer (VariableStoreHeader);
+    MaximumBufferSize = sizeof (VARIABLE_STORE_HEADER);
 
-  while (IsValidVariableHeader (Variable)) {
+    while (IsValidVariableHeader (Variable)) {
-    NextVariable = GetNextVariablePtr (Variable);
+      NextVariable = GetNextVariablePtr (Variable);
-    if ((Variable->State == VAR_ADDED || Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) &&
+      if ((Variable->State == VAR_ADDED || Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) &&
-        Variable != UpdatingVariable &&
+          Variable != UpdatingVariable &&
-        Variable != UpdatingInDeletedTransition
+          Variable != UpdatingInDeletedTransition
-       ) {
+         ) {
-      VariableSize = (UINTN) NextVariable - (UINTN) Variable;
+        VariableSize = (UINTN) NextVariable - (UINTN) Variable;
-      MaximumBufferSize += VariableSize;
+        MaximumBufferSize += VariableSize;
+      }
+
+      Variable = NextVariable;
     }
 
-    Variable = NextVariable;
+    if (NewVariable != NULL) {
-  }
+      //
+      // Add the new variable size.
+      //
+      MaximumBufferSize += NewVariableSize;
+    }
 
-  if (NewVariable != NULL) {
     //
-    // Add the new variable size.
+    // Reserve the 1 Bytes with Oxff to identify the
+    // end of the variable buffer.
     //
-    MaximumBufferSize += NewVariableSize;
+    MaximumBufferSize += 1;
-  }
+    ValidBuffer = AllocatePool (MaximumBufferSize);
-
+    if (ValidBuffer == NULL) {
-  //
+      return EFI_OUT_OF_RESOURCES;
-  // Reserve the 1 Bytes with Oxff to identify the 
+    }
-  // end of the variable buffer. 
+  } else {
-  // 
+    //
-  MaximumBufferSize += 1;
+    // For NV variable reclaim, don't allocate pool here and just use mNvVariableCache
-  ValidBuffer = AllocatePool (MaximumBufferSize);
+    // as the buffer to reduce SMRAM consumption for SMM variable driver.
-  if (ValidBuffer == NULL) {
+    //
-    return EFI_OUT_OF_RESOURCES;
+    MaximumBufferSize = mNvVariableCache->Size;
+    ValidBuffer = (UINT8 *) mNvVariableCache;
   }
 
   SetMem (ValidBuffer, MaximumBufferSize, 0xff);
@@ -770,6 +779,7 @@ Reclaim (
     //
     SetMem ((UINT8 *) (UINTN) VariableBase, VariableStoreHeader->Size, 0xff);
     CopyMem ((UINT8 *) (UINTN) VariableBase, ValidBuffer, (UINTN) (CurrPtr - ValidBuffer));
+    *LastVariableOffset = (UINTN) (CurrPtr - ValidBuffer);
     Status  = EFI_SUCCESS;
   } else {
     //
@@ -777,34 +787,37 @@ Reclaim (
     //
     Status = FtwVariableSpace (
               VariableBase,
-              ValidBuffer,
+              (VARIABLE_STORE_HEADER *) ValidBuffer
-              (UINTN) (CurrPtr - ValidBuffer)
               );
-    CopyMem (mNvVariableCache, (CHAR8 *)(UINTN)VariableBase, VariableStoreHeader->Size);
+    if (!EFI_ERROR (Status)) {
-  }
+      *LastVariableOffset = (UINTN) (CurrPtr - ValidBuffer);
-  if (!EFI_ERROR (Status)) {
-    *LastVariableOffset = (UINTN) (CurrPtr - ValidBuffer);
-    if (!IsVolatile) {
       mVariableModuleGlobal->HwErrVariableTotalSize = HwErrVariableTotalSize;
       mVariableModuleGlobal->CommonVariableTotalSize = CommonVariableTotalSize;
-    }
+    } else {
-  } else {
+      NextVariable  = GetStartPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableBase);
-    NextVariable  = GetStartPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableBase);
+      while (IsValidVariableHeader (NextVariable)) {
-    while (IsValidVariableHeader (NextVariable)) {
+        VariableSize = NextVariable->NameSize + NextVariable->DataSize + sizeof (VARIABLE_HEADER);
-      VariableSize = NextVariable->NameSize + NextVariable->DataSize + sizeof (VARIABLE_HEADER);
+        if ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
-      if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
+          mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VariableSize);
-        mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VariableSize);
+        } else if ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
-      } else if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
+          mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VariableSize);
-        mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VariableSize);
+        }
-      }
 
-      NextVariable = GetNextVariablePtr (NextVariable);
+        NextVariable = GetNextVariablePtr (NextVariable);
+      }
+      *LastVariableOffset = (UINTN) NextVariable - (UINTN) VariableBase;
     }
-    *LastVariableOffset = (UINTN) NextVariable - (UINTN) VariableBase;
   }
 
 Done:
-  FreePool (ValidBuffer);
+  if (IsVolatile) {
+    FreePool (ValidBuffer);
+  } else {
+    //
+    // For NV variable reclaim, we use mNvVariableCache as the buffer, so copy the data back.
+    //
+    CopyMem (mNvVariableCache, (UINT8 *)(UINTN)VariableBase, VariableStoreHeader->Size);
+  }
 
   return Status;
 }

MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h

@@ -133,8 +133,7 @@ FlushHobVariableToFlash (
   VariableBase. Fault Tolerant Write protocol is used for writing.
 
   @param  VariableBase   Base address of the variable to write.
-  @param  Buffer         Point to the data buffer.
+  @param  VariableBuffer Point to the variable data buffer.
-  @param  BufferSize     The number of bytes of the data Buffer.
 
   @retval EFI_SUCCESS    The function completed successfully.
   @retval EFI_NOT_FOUND  Fail to locate Fault Tolerant Write protocol.
@@ -144,8 +143,7 @@ FlushHobVariableToFlash (
 EFI_STATUS
 FtwVariableSpace (
   IN EFI_PHYSICAL_ADDRESS   VariableBase,
-  IN UINT8                  *Buffer,
+  IN VARIABLE_STORE_HEADER  *VariableBuffer
-  IN UINTN                  BufferSize
   );
 
 

SecurityPkg/VariableAuthenticated/RuntimeDxe/Reclaim.c

@@ -2,7 +2,7 @@
   Handles non-volatile variable store garbage collection, using FTW
   (Fault Tolerant Write) protocol.
 
-Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2009 - 2013, 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 
@@ -98,8 +98,7 @@ GetLbaAndOffsetByAddress (
   VariableBase. Fault Tolerant Write protocol is used for writing.
 
   @param  VariableBase   Base address of variable to write
-  @param  Buffer         Point to the data buffer.
+  @param  VariableBuffer Point to the variable data buffer.
-  @param  BufferSize     The number of bytes of the data Buffer.
 
   @retval EFI_SUCCESS    The function completed successfully.
   @retval EFI_NOT_FOUND  Fail to locate Fault Tolerant Write protocol.
@@ -109,15 +108,13 @@ GetLbaAndOffsetByAddress (
 EFI_STATUS
 FtwVariableSpace (
   IN EFI_PHYSICAL_ADDRESS   VariableBase,
-  IN UINT8                  *Buffer,
+  IN VARIABLE_STORE_HEADER  *VariableBuffer
-  IN UINTN                  BufferSize
   )
 {
   EFI_STATUS                         Status;
   EFI_HANDLE                         FvbHandle;
   EFI_LBA                            VarLba;
   UINTN                              VarOffset;
-  UINT8                              *FtwBuffer;
   UINTN                              FtwBufferSize;
   EFI_FAULT_TOLERANT_WRITE_PROTOCOL  *FtwProtocol;
 
@@ -142,17 +139,9 @@ FtwVariableSpace (
   if (EFI_ERROR (Status)) {
     return EFI_ABORTED;
   }
-  //
-  // Prepare for the variable data.
-  //
-  FtwBufferSize = ((VARIABLE_STORE_HEADER *) ((UINTN) VariableBase))->Size;
-  FtwBuffer     = AllocatePool (FtwBufferSize);
-  if (FtwBuffer == NULL) {
-    return EFI_OUT_OF_RESOURCES;
-  }
 
-  SetMem (FtwBuffer, FtwBufferSize, (UINT8) 0xff);
+  FtwBufferSize = ((VARIABLE_STORE_HEADER *) ((UINTN) VariableBase))->Size;
-  CopyMem (FtwBuffer, Buffer, BufferSize);
+  ASSERT (FtwBufferSize == VariableBuffer->Size);
 
   //
   // FTW write record.
@@ -164,9 +153,8 @@ FtwVariableSpace (
                           FtwBufferSize,  // NumBytes
                           NULL,           // PrivateData NULL
                           FvbHandle,      // Fvb Handle
-                          FtwBuffer       // write buffer
+                          (VOID *) VariableBuffer // write buffer
                           );
 
-  FreePool (FtwBuffer);
   return Status;
 }

SecurityPkg/VariableAuthenticated/RuntimeDxe/Variable.c

@@ -701,6 +701,7 @@ PubKeyStoreFilter (
   *NewPubKeyIndex = AllocateZeroPool ((PubKeyNumber + 1) * sizeof (UINT32));
   if (*NewPubKeyIndex == NULL) {
     FreePool (*NewPubKeyStore);
+    *NewPubKeyStore = NULL;
     return EFI_OUT_OF_RESOURCES;
   }
 
@@ -790,41 +791,50 @@ Reclaim (
   NewPubKeyStore = NULL;
   NewPubKeySize  = 0;
   PubKeyHeader   = NULL;
-  
-  //
-  // Start Pointers for the variable.
-  //
-  Variable          = GetStartPointer (VariableStoreHeader);
-  MaximumBufferSize = sizeof (VARIABLE_STORE_HEADER);
 
-  while (IsValidVariableHeader (Variable)) {
+  if (IsVolatile) {
-    NextVariable = GetNextVariablePtr (Variable);
+    //
-    if ((Variable->State == VAR_ADDED || Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) &&
+    // Start Pointers for the variable.
-        Variable != UpdatingVariable &&
+    //
-        Variable != UpdatingInDeletedTransition
+    Variable          = GetStartPointer (VariableStoreHeader);
-       ) {
+    MaximumBufferSize = sizeof (VARIABLE_STORE_HEADER);
-      VariableSize = (UINTN) NextVariable - (UINTN) Variable;
+
-      MaximumBufferSize += VariableSize;
+    while (IsValidVariableHeader (Variable)) {
+      NextVariable = GetNextVariablePtr (Variable);
+      if ((Variable->State == VAR_ADDED || Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) &&
+          Variable != UpdatingVariable &&
+          Variable != UpdatingInDeletedTransition
+         ) {
+        VariableSize = (UINTN) NextVariable - (UINTN) Variable;
+        MaximumBufferSize += VariableSize;
+      }
+
+      Variable = NextVariable;
     }
 
-    Variable = NextVariable;
+    if (NewVariable != NULL) {
-  }
+      //
+      // Add the new variable size.
+      //
+      MaximumBufferSize += NewVariableSize;
+    }
 
-  if (NewVariable != NULL) {
     //
-    // Add the new variable size.
+    // Reserve the 1 Bytes with Oxff to identify the
+    // end of the variable buffer.
     //
-    MaximumBufferSize += NewVariableSize;
+    MaximumBufferSize += 1;
-  }
+    ValidBuffer = AllocatePool (MaximumBufferSize);
-
+    if (ValidBuffer == NULL) {
-  //
+      return EFI_OUT_OF_RESOURCES;
-  // Reserve the 1 Bytes with Oxff to identify the
+    }
-  // end of the variable buffer.
+  } else {
-  //
+    //
-  MaximumBufferSize += 1;
+    // For NV variable reclaim, don't allocate pool here and just use mNvVariableCache
-  ValidBuffer = AllocatePool (MaximumBufferSize);
+    // as the buffer to reduce SMRAM consumption for SMM variable driver.
-  if (ValidBuffer == NULL) {
+    //
-    return EFI_OUT_OF_RESOURCES;
+    MaximumBufferSize = mNvVariableCache->Size;
+    ValidBuffer = (UINT8 *) mNvVariableCache;
   }
 
   SetMem (ValidBuffer, MaximumBufferSize, 0xff);
@@ -848,14 +858,13 @@ Reclaim (
                &NewPubKeySize
                );
     if (EFI_ERROR (Status)) {
-      FreePool (ValidBuffer);
+      goto Done;
-      return Status;
     }
 
     //
     // Refresh the PubKeyIndex for all valid variables (ADDED and IN_DELETED_TRANSITION).
     //
-    Variable = GetStartPointer (mNvVariableCache);
+    Variable = GetStartPointer (VariableStoreHeader);
     while (IsValidVariableHeader (Variable)) {
       NextVariable = GetNextVariablePtr (Variable);
       if (Variable->State == VAR_ADDED || Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {
@@ -887,10 +896,8 @@ Reclaim (
     //
     ASSERT (PubKeyHeader != NULL);
     if (PubKeyHeader == NULL) {
-      FreePool (ValidBuffer);
+      Status = EFI_DEVICE_ERROR;
-      FreePool (NewPubKeyIndex);
+      goto Done;
-      FreePool (NewPubKeyStore);
-      return EFI_DEVICE_ERROR;
     }
     CopyMem (CurrPtr, (UINT8*) PubKeyHeader, sizeof (VARIABLE_HEADER));
     Variable = (VARIABLE_HEADER*) CurrPtr;
@@ -1012,6 +1019,7 @@ Reclaim (
     //
     SetMem ((UINT8 *) (UINTN) VariableBase, VariableStoreHeader->Size, 0xff);
     CopyMem ((UINT8 *) (UINTN) VariableBase, ValidBuffer, (UINTN) (CurrPtr - ValidBuffer));
+    *LastVariableOffset = (UINTN) (CurrPtr - ValidBuffer);
     Status  = EFI_SUCCESS;
   } else {
     //
@@ -1019,42 +1027,45 @@ Reclaim (
     //
     Status = FtwVariableSpace (
               VariableBase,
-              ValidBuffer,
+              (VARIABLE_STORE_HEADER *) ValidBuffer
-              (UINTN) (CurrPtr - ValidBuffer)
               );
-    CopyMem (mNvVariableCache, (CHAR8 *)(UINTN)VariableBase, VariableStoreHeader->Size);
+    if (!EFI_ERROR (Status)) {
-  }
+      *LastVariableOffset = (UINTN) (CurrPtr - ValidBuffer);
-  if (!EFI_ERROR (Status)) {
-    *LastVariableOffset = (UINTN) (CurrPtr - ValidBuffer);
-    if (!IsVolatile) {
       mVariableModuleGlobal->HwErrVariableTotalSize = HwErrVariableTotalSize;
       mVariableModuleGlobal->CommonVariableTotalSize = CommonVariableTotalSize;
-    }
+    } else {
-  } else {
+      NextVariable  = GetStartPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableBase);
-    NextVariable  = GetStartPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableBase);
+      while (IsValidVariableHeader (NextVariable)) {
-    while (IsValidVariableHeader (NextVariable)) {
+        VariableSize = NextVariable->NameSize + NextVariable->DataSize + sizeof (VARIABLE_HEADER);
-      VariableSize = NextVariable->NameSize + NextVariable->DataSize + sizeof (VARIABLE_HEADER);
+        if ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
-      if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
+          mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VariableSize);
-        mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VariableSize);
+        } else if ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
-      } else if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
+          mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VariableSize);
-        mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VariableSize);
+        }
+
+        NextVariable = GetNextVariablePtr (NextVariable);
       }
-
+      *LastVariableOffset = (UINTN) NextVariable - (UINTN) VariableBase;
-      NextVariable = GetNextVariablePtr (NextVariable);
     }
-    *LastVariableOffset = (UINTN) NextVariable - (UINTN) VariableBase;
-  }
-
-  if (NewPubKeyStore != NULL) {
-    FreePool (NewPubKeyStore);
-  }
-
-  if (NewPubKeyIndex != NULL) {
-    FreePool (NewPubKeyIndex);
   }
 
 Done:
-  FreePool (ValidBuffer);
+  if (IsVolatile) {
+    FreePool (ValidBuffer);
+  } else {
+    //
+    // For NV variable reclaim, we use mNvVariableCache as the buffer, so copy the data back.
+    //
+    CopyMem (mNvVariableCache, (UINT8 *)(UINTN)VariableBase, VariableStoreHeader->Size);
+
+    if (NewPubKeyStore != NULL) {
+      FreePool (NewPubKeyStore);
+    }
+
+    if (NewPubKeyIndex != NULL) {
+      FreePool (NewPubKeyIndex);
+    }
+  }
 
   return Status;
 }

SecurityPkg/VariableAuthenticated/RuntimeDxe/Variable.h

@@ -143,8 +143,7 @@ FlushHobVariableToFlash (
   VariableBase. Fault Tolerant Write protocol is used for writing.
 
   @param  VariableBase   Base address of the variable to write.
-  @param  Buffer         Point to the data buffer.
+  @param  VariableBuffer Point to the variable data buffer.
-  @param  BufferSize     The number of bytes of the data Buffer.
 
   @retval EFI_SUCCESS    The function completed successfully.
   @retval EFI_NOT_FOUND  Fail to locate Fault Tolerant Write protocol.
@@ -154,8 +153,7 @@ FlushHobVariableToFlash (
 EFI_STATUS
 FtwVariableSpace (
   IN EFI_PHYSICAL_ADDRESS   VariableBase,
-  IN UINT8                  *Buffer,
+  IN VARIABLE_STORE_HEADER  *VariableBuffer
-  IN UINTN                  BufferSize
   );
 
 /**