Update HobLib and Hob Service to avoid data over flow.

[mirror_edk2.git] / MdePkg / Library / PeiHobLib / HobLib.c

diff --git a/MdePkg/Library/PeiHobLib/HobLib.c b/MdePkg/Library/PeiHobLib/HobLib.c
index 604cee996c8622f904f7f3cf6b8ce6de267ca98a..0586ba86c0b4b9755b8dd4a238fb65854a3eff94 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 - 2012, 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
@@ -339,12 +349,14 @@ BuildResourceDescriptorHob (
   \r
   If Guid is NULL, then ASSERT().\r
   If there is no additional space for HOB creation, then ASSERT().\r
-  If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
+  If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
+  HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.\r
 \r
   @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 +368,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
+  ASSERT (DataLength <= (0xFFF8 - 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
@@ -380,13 +400,15 @@ BuildGuidHob (
   If Guid is NULL, then ASSERT().\r
   If Data is NULL and DataLength > 0, then ASSERT().\r
   If there is no additional space for HOB creation, then ASSERT().\r
-  If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
+  If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
+  HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.\r
 \r
   @param  Guid          The GUID to tag the customized HOB.\r
   @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 +424,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 +454,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 +489,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 +523,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 +554,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 +593,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 +636,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 +679,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