Add new interface GetVariable2 and GetEfiGlobalVariable2 to return more info. Also replace old interface with new one.

Signed-off-by: Eric Dong <eric.dong@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

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

2 files changed, 173 insertions, 3 deletions

diff --git a/MdePkg/Include/Library/UefiLib.h b/MdePkg/Include/Library/UefiLib.h
index df7e7d5379..4ce8dc6c05 100644
--- a/MdePkg/Include/Library/UefiLib.h
+++ b/MdePkg/Include/Library/UefiLib.h
@@ -12,7 +12,7 @@
   of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is

   defined, then debug and assert related macros wrapped by it are the NULL implementations.

 

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

+Copyright (c) 2006 - 2012, 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 that accompanies this distribution.  

 The full text of the license may be found at

@@ -629,8 +629,11 @@ FreeUnicodeStringTable (
   IN EFI_UNICODE_STRING_TABLE  *UnicodeStringTable

   );

 

+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES

 

 /**

+  [ATTENTION] This function will be deprecated for security reason.

+

   Returns a pointer to an allocated buffer that contains the contents of a 

   variable retrieved through the UEFI Runtime Service GetVariable().  The 

   returned buffer is allocated using AllocatePool().  The caller is responsible

@@ -655,6 +658,8 @@ GetVariable (
   );

 

 /**

+  [ATTENTION] This function will be deprecated for security reason.

+

   Returns a pointer to an allocated buffer that contains the contents of a 

   variable retrieved through the UEFI Runtime Service GetVariable().  This 

   function always uses the EFI_GLOBAL_VARIABLE GUID to retrieve variables.

@@ -675,7 +680,64 @@ EFIAPI
 GetEfiGlobalVariable (

   IN CONST CHAR16  *Name

   );

+#endif

+

+

+/**

+  Returns the status whether get the variable success. The function retrieves 

+  variable  through the UEFI Runtime Service GetVariable().  The 

+  returned buffer is allocated using AllocatePool().  The caller is responsible

+  for freeing this buffer with FreePool().

+

+  If Name  is NULL, then ASSERT().

+  If Guid  is NULL, then ASSERT().

+  If Value is NULL, then ASSERT().

+

+  @param[in]  Name  The pointer to a Null-terminated Unicode string.

+  @param[in]  Guid  The pointer to an EFI_GUID structure

+  @param[out] Value The buffer point saved the variable info.

+  @param[out] Size  The buffer size of the variable.

+

+  @return EFI_OUT_OF_RESOURCES      Allocate buffer failed.

+  @return EFI_SUCCESS               Find the specified variable.

+  @return Others Errors             Return errors from call to gRT->GetVariable.

+

+**/

+EFI_STATUS

+EFIAPI

+GetVariable2 (

+  IN CONST CHAR16    *Name,

+  IN CONST EFI_GUID  *Guid,

+  OUT VOID           **Value,

+  OUT UINTN          *Size OPTIONAL

+  );

+

+/**

+  Returns a pointer to an allocated buffer that contains the contents of a 

+  variable retrieved through the UEFI Runtime Service GetVariable().  This 

+  function always uses the EFI_GLOBAL_VARIABLE GUID to retrieve variables.

+  The returned buffer is allocated using AllocatePool().  The caller is 

+  responsible for freeing this buffer with FreePool().

+

+  If Name  is NULL, then ASSERT().

+  If Value is NULL, then ASSERT().

 

+  @param[in]  Name  The pointer to a Null-terminated Unicode string.

+  @param[out] Value The buffer point saved the variable info.

+  @param[out] Size  The buffer size of the variable.

+

+  @return EFI_OUT_OF_RESOURCES      Allocate buffer failed.

+  @return EFI_SUCCESS               Find the specified variable.

+  @return Others Errors             Return errors from call to gRT->GetVariable.

+

+**/

+EFI_STATUS

+EFIAPI

+GetEfiGlobalVariable2 (

+  IN CONST CHAR16    *Name,

+  OUT VOID           **Value,

+  OUT UINTN          *Size OPTIONAL

+  );

 

 /**

   Returns a pointer to an allocated buffer that contains the best matching language 

diff --git a/MdePkg/Library/UefiLib/UefiLib.c b/MdePkg/Library/UefiLib/UefiLib.c
index 96dccb1477..112766ad86 100644
--- a/MdePkg/Library/UefiLib/UefiLib.c
+++ b/MdePkg/Library/UefiLib/UefiLib.c
@@ -5,7 +5,7 @@
   EFI Driver Model related protocols, manage Unicode string tables for UEFI Drivers, 

   and print messages on the console output and standard error devices.

 

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

+  Copyright (c) 2006 - 2012, 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

@@ -1212,7 +1212,11 @@ FreeUnicodeStringTable (
   return EFI_SUCCESS;

 }

 

+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES

+

 /**

+  [ATTENTION] This function will be deprecated for security reason.

+

   Returns a pointer to an allocated buffer that contains the contents of a 

   variable retrieved through the UEFI Runtime Service GetVariable().  The 

   returned buffer is allocated using AllocatePool().  The caller is responsible

@@ -1273,8 +1277,9 @@ GetVariable (
   return Value;

 }

 

-

 /**

+  [ATTENTION] This function will be deprecated for security reason.

+

   Returns a pointer to an allocated buffer that contains the contents of a 

   variable retrieved through the UEFI Runtime Service GetVariable().  This 

   function always uses the EFI_GLOBAL_VARIABLE GUID to retrieve variables.

@@ -1298,7 +1303,110 @@ GetEfiGlobalVariable (
 {

   return GetVariable (Name, &gEfiGlobalVariableGuid);

 }

+#endif

+

+/**

+  Returns the status whether get the variable success. The function retrieves 

+  variable  through the UEFI Runtime Service GetVariable().  The 

+  returned buffer is allocated using AllocatePool().  The caller is responsible

+  for freeing this buffer with FreePool().

+

+  If Name  is NULL, then ASSERT().

+  If Guid  is NULL, then ASSERT().

+  If Value is NULL, then ASSERT().

+

+  @param[in]  Name  The pointer to a Null-terminated Unicode string.

+  @param[in]  Guid  The pointer to an EFI_GUID structure

+  @param[out] Value The buffer point saved the variable info.

+  @param[out] Size  The buffer size of the variable.

+

+  @return EFI_OUT_OF_RESOURCES      Allocate buffer failed.

+  @return EFI_SUCCESS               Find the specified variable.

+  @return Others Errors             Return errors from call to gRT->GetVariable.

+

+**/

+EFI_STATUS

+EFIAPI

+GetVariable2 (

+  IN CONST CHAR16    *Name,

+  IN CONST EFI_GUID  *Guid,

+  OUT VOID           **Value,

+  OUT UINTN          *Size OPTIONAL

+  )

+{

+  EFI_STATUS  Status;

+  UINTN       BufferSize;

+

+  ASSERT (Name != NULL && Guid != NULL && Value != NULL);

+

+  //

+  // Try to get the variable size.

+  //

+  BufferSize = 0;

+  *Value     = NULL;

+  if (Size != NULL) {

+    *Size  = 0;

+  }

+  

+  Status = gRT->GetVariable ((CHAR16 *) Name, (EFI_GUID *) Guid, NULL, &BufferSize, *Value);

+  if (Status != EFI_BUFFER_TOO_SMALL) {

+    return Status;

+  }

+

+  //

+  // Allocate buffer to get the variable.

+  //

+  *Value = AllocatePool (BufferSize);

+  ASSERT (*Value != NULL);

+  if (*Value == NULL) {

+    return EFI_OUT_OF_RESOURCES;

+  }

+

+  //

+  // Get the variable data.

+  //

+  Status = gRT->GetVariable ((CHAR16 *) Name, (EFI_GUID *) Guid, NULL, &BufferSize, *Value);

+  if (EFI_ERROR (Status)) {

+    FreePool(*Value);

+    *Value = NULL;

+  }

+

+  if (Size != NULL) {

+    *Size = BufferSize;

+  }

+

+  return Status;

+}

 

+/**

+  Returns a pointer to an allocated buffer that contains the contents of a 

+  variable retrieved through the UEFI Runtime Service GetVariable().  This 

+  function always uses the EFI_GLOBAL_VARIABLE GUID to retrieve variables.

+  The returned buffer is allocated using AllocatePool().  The caller is 

+  responsible for freeing this buffer with FreePool().

+

+  If Name is NULL, then ASSERT().

+  If Value is NULL, then ASSERT().

+

+  @param[in]  Name  The pointer to a Null-terminated Unicode string.

+  @param[out] Value The buffer point saved the variable info.

+  @param[out] Size  The buffer size of the variable.

+

+  @return EFI_OUT_OF_RESOURCES      Allocate buffer failed.

+  @return EFI_SUCCESS               Find the specified variable.

+  @return Others Errors             Return errors from call to gRT->GetVariable.

+

+**/

+EFI_STATUS

+EFIAPI

+GetEfiGlobalVariable2 (

+  IN CONST CHAR16    *Name,

+  OUT VOID           **Value,

+  OUT UINTN          *Size OPTIONAL

+  )

+{

+  return GetVariable2 (Name, &gEfiGlobalVariableGuid, Value, Size);

+}

 

 /**

   Returns a pointer to an allocated buffer that contains the best matching language