Change BuildGuidHob and BuildGuidDataHob to return NULL upon failure.

Guarantee no memory corruption in an out of memory condition even in production builds.

Signed-off-by: niruiyu
Reviewed-by: mdkinney
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11775 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Library/HobLib.h b/MdePkg/Include/Library/HobLib.h
index a7bc26a742544fe5f28efb8672ea50036b6293e2..8af7fbe0e1bc4c7e8da1ca5622e00d8d2982cd45 100644 (file)
--- a/MdePkg/Include/Library/HobLib.h
+++ b/MdePkg/Include/Library/HobLib.h
@@ -8,7 +8,7 @@
   allows the PEI phase to pass information to the DXE phase. HOBs are position \r
   independent and can be relocated easily to different memory memory locations.\r
 \r
-Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -225,7 +225,8 @@ BuildResourceDescriptorHob (
   @param  Guid          The GUID to tag the customized HOB.\r
   @param  DataLength    The size of the data payload for the GUID HOB.\r
 \r
-  @return The start address of GUID HOB data.\r
+  @retval  NULL         The GUID HOB could not be allocated.\r
+  @retval  others       The start address of GUID HOB data.\r
 \r
 **/\r
 VOID *\r
@@ -255,7 +256,8 @@ BuildGuidHob (
   @param  Data          The data to be copied into the data field of the GUID HOB.\r
   @param  DataLength    The size of the data payload for the GUID HOB.\r
 \r
-  @return The start address of GUID HOB data.\r
+  @retval  NULL         The GUID HOB could not be allocated.\r
+  @retval  others       The start address of GUID HOB data.\r
 \r
 **/\r
 VOID *\r

diff --git a/MdePkg/Library/DxeCoreHobLib/HobLib.c b/MdePkg/Library/DxeCoreHobLib/HobLib.c
index 9fdb2b448a80539b1c46470e1a2d1332c55ee991..912f97d89811a17bee0d4f43470ad54b8cce0f19 100644 (file)
--- a/MdePkg/Library/DxeCoreHobLib/HobLib.c
+++ b/MdePkg/Library/DxeCoreHobLib/HobLib.c
@@ -1,7 +1,7 @@
 /** @file\r
   HOB Library implementation for DxeCore driver.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -286,7 +286,8 @@ BuildResourceDescriptorHob (
   @param  Guid          The GUID to tag the customized HOB.\r
   @param  DataLength    The size of the data payload for the GUID HOB.\r
 \r
-  @return The start address of GUID HOB data.\r
+  @retval  NULL         The GUID HOB could not be allocated.\r
+  @retval  others       The start address of GUID HOB data.\r
 \r
 **/\r
 VOID *\r
@@ -323,7 +324,8 @@ BuildGuidHob (
   @param  Data          The data to be copied into the data field of the GUID HOB.\r
   @param  DataLength    The size of the data payload for the GUID HOB.\r
 \r
-  @return The start address of GUID HOB data.\r
+  @retval  NULL         The GUID HOB could not be allocated.\r
+  @retval  others       The start address of GUID HOB data.\r
 \r
 **/\r
 VOID *\r

diff --git a/MdePkg/Library/DxeHobLib/HobLib.c b/MdePkg/Library/DxeHobLib/HobLib.c
index dfd4bed67aa3cf387a403a7a11bd00d0da34d9fd..3a015bb192a785423afb359c95c05ae39b5830d3 100644 (file)
--- a/MdePkg/Library/DxeHobLib/HobLib.c
+++ b/MdePkg/Library/DxeHobLib/HobLib.c
@@ -1,7 +1,7 @@
 /** @file\r
   HOB Library implemenation for Dxe Phase.\r
 \r
-Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -319,7 +319,8 @@ BuildResourceDescriptorHob (
   @param  Guid          The GUID to tag the customized HOB.\r
   @param  DataLength    The size of the data payload for the GUID HOB.\r
 \r
-  @return The start address of GUID HOB data.\r
+  @retval  NULL         The GUID HOB could not be allocated.\r
+  @retval  others       The start address of GUID HOB data.\r
 \r
 **/\r
 VOID *\r
@@ -356,7 +357,8 @@ BuildGuidHob (
   @param  Data          The data to be copied into the data field of the GUID HOB.\r
   @param  DataLength    The size of the data payload for the GUID HOB.\r
 \r
-  @return The start address of GUID HOB data.\r
+  @retval  NULL         The GUID HOB could not be allocated.\r
+  @retval  others       The start address of GUID HOB data.\r
 \r
 **/\r
 VOID *\r

diff --git a/MdePkg/Library/PeiHobLib/HobLib.c b/MdePkg/Library/PeiHobLib/HobLib.c
index 604cee996c8622f904f7f3cf6b8ce6de267ca98a..113de832fc488577278732c51eff31a3da12791e 100644 (file)
--- a/MdePkg/Library/PeiHobLib/HobLib.c
+++ b/MdePkg/Library/PeiHobLib/HobLib.c
@@ -1,7 +1,7 @@
 /** @file\r
   Provide Hob Library functions for Pei phase.\r
 \r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -226,7 +226,8 @@ GetBootModeHob (
   @param  Type          Type of the new HOB.\r
   @param  Length        Length of the new HOB to allocate.\r
 \r
-  @return The address of new HOB.\r
+  @retval  NULL         The HOB could not be allocated.\r
+  @retval  others       The address of new HOB.\r
 \r
 **/\r
 VOID *\r
@@ -240,10 +241,13 @@ InternalPeiCreateHob (
   VOID              *Hob;\r
 \r
   Status = PeiServicesCreateHob (Type, Length, &Hob);\r
+  if (EFI_ERROR (Status)) {\r
+    Hob = NULL;\r
+  }\r
   //\r
   // Assume the process of HOB building is always successful.\r
   //\r
-  ASSERT_EFI_ERROR (Status);\r
+  ASSERT (Hob != NULL);\r
   return Hob;\r
 }\r
 \r
@@ -278,6 +282,9 @@ BuildModuleHob (
           ((ModuleLength & (EFI_PAGE_SIZE - 1)) == 0));\r
 \r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION_MODULE));\r
+  if (Hob == NULL) {\r
+    return;\r
+  }\r
 \r
   CopyGuid (&(Hob->MemoryAllocationHeader.Name), &gEfiHobMemoryAllocModuleGuid);\r
   Hob->MemoryAllocationHeader.MemoryBaseAddress = MemoryAllocationModule;\r
@@ -320,6 +327,9 @@ BuildResourceDescriptorHob (
   EFI_HOB_RESOURCE_DESCRIPTOR  *Hob;\r
 \r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_RESOURCE_DESCRIPTOR, (UINT16) sizeof (EFI_HOB_RESOURCE_DESCRIPTOR));\r
+  if (Hob == NULL) {\r
+    return;\r
+  }\r
 \r
   Hob->ResourceType      = ResourceType;\r
   Hob->ResourceAttribute = ResourceAttribute;\r
@@ -344,7 +354,8 @@ BuildResourceDescriptorHob (
   @param  Guid          The GUID to tag the customized HOB.\r
   @param  DataLength    The size of the data payload for the GUID HOB.\r
 \r
-  @return The start address of GUID HOB data.\r
+  @retval  NULL         The GUID HOB could not be allocated.\r
+  @retval  others       The start address of GUID HOB data.\r
 \r
 **/\r
 VOID *\r
@@ -356,12 +367,20 @@ BuildGuidHob (
 {\r
   EFI_HOB_GUID_TYPE *Hob;\r
 \r
+  //\r
+  // Make sure Guid is valid\r
+  //\r
+  ASSERT (Guid != NULL);\r
+  \r
   //\r
   // Make sure that data length is not too long.\r
   //\r
   ASSERT (DataLength <= (0xffff - sizeof (EFI_HOB_GUID_TYPE)));\r
 \r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_GUID_EXTENSION, (UINT16) (sizeof (EFI_HOB_GUID_TYPE) + DataLength));\r
+  if (Hob == NULL) {\r
+    return Hob;\r
+  }\r
   CopyGuid (&Hob->Name, Guid);\r
   return Hob + 1;\r
 }\r
@@ -386,7 +405,8 @@ BuildGuidHob (
   @param  Data          The data to be copied into the data field of the GUID HOB.\r
   @param  DataLength    The size of the data payload for the GUID HOB.\r
 \r
-  @return The start address of GUID HOB data.\r
+  @retval  NULL         The GUID HOB could not be allocated.\r
+  @retval  others       The start address of GUID HOB data.\r
 \r
 **/\r
 VOID *\r
@@ -402,6 +422,9 @@ BuildGuidDataHob (
   ASSERT (Data != NULL || DataLength == 0);\r
 \r
   HobData = BuildGuidHob (Guid, DataLength);\r
+  if (HobData == NULL) {\r
+    return HobData;\r
+  }\r
 \r
   return CopyMem (HobData, Data, DataLength);\r
 }\r
@@ -429,6 +452,9 @@ BuildFvHob (
   EFI_HOB_FIRMWARE_VOLUME  *Hob;\r
 \r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_FV, (UINT16) sizeof (EFI_HOB_FIRMWARE_VOLUME));\r
+  if (Hob == NULL) {\r
+    return;\r
+  }\r
 \r
   Hob->BaseAddress = BaseAddress;\r
   Hob->Length      = Length;\r
@@ -461,6 +487,9 @@ BuildFv2Hob (
   EFI_HOB_FIRMWARE_VOLUME2  *Hob;\r
 \r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_FV2, (UINT16) sizeof (EFI_HOB_FIRMWARE_VOLUME2));\r
+  if (Hob == NULL) {\r
+    return;\r
+  }\r
 \r
   Hob->BaseAddress = BaseAddress;\r
   Hob->Length      = Length;\r
@@ -492,6 +521,9 @@ BuildCvHob (
   EFI_HOB_UEFI_CAPSULE  *Hob;\r
 \r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_UEFI_CAPSULE, (UINT16) sizeof (EFI_HOB_UEFI_CAPSULE));\r
+  if (Hob == NULL) {\r
+    return;\r
+  }\r
 \r
   Hob->BaseAddress  = BaseAddress;\r
   Hob->Length       = Length;\r
@@ -520,6 +552,9 @@ BuildCpuHob (
   EFI_HOB_CPU  *Hob;\r
 \r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_CPU, (UINT16) sizeof (EFI_HOB_CPU));\r
+  if (Hob == NULL) {\r
+    return;\r
+  }\r
 \r
   Hob->SizeOfMemorySpace = SizeOfMemorySpace;\r
   Hob->SizeOfIoSpace     = SizeOfIoSpace;\r
@@ -556,6 +591,9 @@ BuildStackHob (
           ((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
 \r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION_STACK));\r
+  if (Hob == NULL) {\r
+    return;\r
+  }\r
 \r
   CopyGuid (&(Hob->AllocDescriptor.Name), &gEfiHobMemoryAllocStackGuid);\r
   Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
@@ -596,6 +634,9 @@ BuildBspStoreHob (
           ((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
 \r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION_BSP_STORE));\r
+  if (Hob == NULL) {\r
+    return;\r
+  }\r
 \r
   CopyGuid (&(Hob->AllocDescriptor.Name), &gEfiHobMemoryAllocBspStoreGuid);\r
   Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
@@ -636,6 +677,9 @@ BuildMemoryAllocationHob (
           ((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
   \r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION));\r
+  if (Hob == NULL) {\r
+    return;\r
+  }\r
   \r
   ZeroMem (&(Hob->AllocDescriptor.Name), sizeof (EFI_GUID));\r
   Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r