From d8dc9f0af56c68492d8a1be52efc1a711d3497f4 Mon Sep 17 00:00:00 2001
From: Olivier Martin <olivier.martin@arm.com>
Date: Wed, 2 Apr 2014 17:32:29 +0000
Subject: [PATCH] ArmPkg: Fixed GetEnvironmentVariable() when the UEFI Variable
 did not exist

The function was allocating a buffer for the read value from the UEFI Variable.
But it was returning the pointer of the default value when the variable was
not present.
It could cause error when the default value and the returned value were free
when these addresses were the same (double FreePool on the same address).

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Olivier Martin <olivier.martin@arm.com>



git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15427 6f19259b-4bc3-4df7-8a09-765794883524
---
 ArmPkg/Include/Library/BdsLib.h   | 34 +++++++++++++++++++++++++++++++
 ArmPkg/Library/BdsLib/BdsHelper.c |  4 ++--
 2 files changed, 36 insertions(+), 2 deletions(-)

diff --git a/ArmPkg/Include/Library/BdsLib.h b/ArmPkg/Include/Library/BdsLib.h
index d16748da46..9fa6870418 100644
--- a/ArmPkg/Include/Library/BdsLib.h
+++ b/ArmPkg/Include/Library/BdsLib.h
@@ -66,6 +66,23 @@ BdsConnectAllDrivers (
   VOID
   );
 
+/**
+  Return the value of a global variable defined by its VariableName.
+  The variable must be defined with the VendorGuid gEfiGlobalVariableGuid.
+
+  @param  VariableName          A Null-terminated string that is the name of the vendor's
+                                variable.
+  @param  DefaultValue          Value returned by the function if the variable does not exist
+  @param  DataSize              On input, the size in bytes of the return Data buffer.
+                                On output the size of data returned in Data.
+  @param  Value                 Value read from the UEFI Variable or copy of the default value
+                                if the UEFI Variable does not exist
+
+  @retval EFI_SUCCESS           All drivers have been connected
+  @retval EFI_NOT_FOUND         No handles match the search.
+  @retval EFI_OUT_OF_RESOURCES  There is not resource pool memory to store the matching results.
+
+**/
 EFI_STATUS
 GetGlobalEnvironmentVariable (
   IN     CONST CHAR16*   VariableName,
@@ -74,6 +91,23 @@ GetGlobalEnvironmentVariable (
   OUT    VOID**          Value
   );
 
+/**
+  Return the value of the variable defined by its VariableName and VendorGuid
+
+  @param  VariableName          A Null-terminated string that is the name of the vendor's
+                                variable.
+  @param  VendorGuid            A unique identifier for the vendor.
+  @param  DefaultValue          Value returned by the function if the variable does not exist
+  @param  DataSize              On input, the size in bytes of the return Data buffer.
+                                On output the size of data returned in Data.
+  @param  Value                 Value read from the UEFI Variable or copy of the default value
+                                if the UEFI Variable does not exist
+
+  @retval EFI_SUCCESS           All drivers have been connected
+  @retval EFI_NOT_FOUND         No handles match the search.
+  @retval EFI_OUT_OF_RESOURCES  There is not resource pool memory to store the matching results.
+
+**/
 EFI_STATUS
 GetEnvironmentVariable (
   IN     CONST CHAR16*   VariableName,
diff --git a/ArmPkg/Library/BdsLib/BdsHelper.c b/ArmPkg/Library/BdsLib/BdsHelper.c
index fb2ac9b806..1d4aa35728 100644
--- a/ArmPkg/Library/BdsLib/BdsHelper.c
+++ b/ArmPkg/Library/BdsLib/BdsHelper.c
@@ -331,7 +331,7 @@ GetEnvironmentVariable (
                     *Size,
                     DefaultValue
                     );
-      *Value = DefaultValue;
+      *Value = AllocateCopyPool (*Size, DefaultValue);
     } else {
       return EFI_NOT_FOUND;
     }
@@ -352,7 +352,7 @@ GetEnvironmentVariable (
       *Size = VariableSize;
     }
   } else {
-    *Value = DefaultValue;
+    *Value = AllocateCopyPool (*Size, DefaultValue);
     return Status;
   }
 
-- 
2.39.2