]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/DxeIplPeim/DxeLoad.c
MdeModulePkg/DxeIpl: Implement NULL pointer detection
[mirror_edk2.git] / MdeModulePkg / Core / DxeIplPeim / DxeLoad.c
index 442e4d6caeb0d4b4ba7d60dea2e0d58cfc09c442..1f626a9e8658211e07ea49e898cc7a0a5ede0f61 100644 (file)
@@ -2,8 +2,9 @@
   Last PEIM.\r
   Responsibility of this module is to load the DXE Core from a Firmware Volume.\r
 \r
-Copyright (c) 2006 - 2009, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2016 HP Development Company, L.P.\r
+Copyright (c) 2006 - 2016, 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
 http://opensource.org/licenses/bsd-license.php\r
@@ -24,6 +25,12 @@ CONST EFI_DXE_IPL_PPI mDxeIplPpi = {
   DxeLoadCore\r
 };\r
 \r
+CONST EFI_PEI_PPI_DESCRIPTOR mDxeIplPpiList = {\r
+  EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
+  &gEfiDxeIplPpiGuid,\r
+  (VOID *) &mDxeIplPpi\r
+};\r
+\r
 CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI mCustomGuidedSectionExtractionPpi = {\r
   CustomGuidedSectionExtract\r
 };\r
@@ -32,17 +39,10 @@ CONST EFI_PEI_DECOMPRESS_PPI mDecompressPpi = {
   Decompress\r
 };\r
 \r
-CONST EFI_PEI_PPI_DESCRIPTOR mPpiList[] = {\r
-  {\r
-    EFI_PEI_PPI_DESCRIPTOR_PPI,\r
-    &gEfiDxeIplPpiGuid,\r
-    (VOID *) &mDxeIplPpi\r
-  },\r
-  {\r
-    (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
-    &gEfiPeiDecompressPpiGuid,\r
-    (VOID *) &mDecompressPpi\r
-  }\r
+CONST EFI_PEI_PPI_DESCRIPTOR mDecompressPpiList = {\r
+  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
+  &gEfiPeiDecompressPpiGuid,\r
+  (VOID *) &mDecompressPpi\r
 };\r
 \r
 CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi = {\r
@@ -51,10 +51,16 @@ CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi = {
   NULL\r
 };\r
 \r
+CONST EFI_PEI_NOTIFY_DESCRIPTOR mMemoryDiscoveredNotifyList = {\r
+  (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
+  &gEfiPeiMemoryDiscoveredPpiGuid,\r
+  InstallIplPermanentMemoryPpis\r
+};\r
+\r
 /**\r
   Entry point of DXE IPL PEIM.\r
-  \r
-  This function installs DXE IPL PPI and Decompress PPI.  It also reloads\r
+\r
+  This function installs DXE IPL PPI.  It also reloads\r
   itself to memory on non-S3 resume boot path.\r
 \r
   @param  FileHandle  Handle of the file being invoked.\r
@@ -73,10 +79,8 @@ PeimInitializeDxeIpl (
 {\r
   EFI_STATUS                                Status;\r
   EFI_BOOT_MODE                             BootMode;\r
-  EFI_GUID                                  *ExtractHandlerGuidTable;\r
-  UINTN                                     ExtractHandlerNumber;\r
-  EFI_PEI_PPI_DESCRIPTOR                    *GuidPpi;\r
-  \r
+  VOID                                      *Dummy;\r
+\r
   BootMode = GetBootModeHob ();\r
 \r
   if (BootMode != BOOT_ON_S3_RESUME) {\r
@@ -87,43 +91,150 @@ PeimInitializeDxeIpl (
       // \r
       return Status;\r
     }\r
-    \r
+\r
     //\r
     // Ensure that DXE IPL is shadowed to permanent memory.\r
     //\r
     ASSERT (Status == EFI_ALREADY_STARTED);\r
-     \r
+\r
     //\r
-    // Get custom extract guided section method guid list \r
+    // DXE core load requires permanent memory.\r
     //\r
-    ExtractHandlerNumber = ExtractGuidedSectionGetGuidList (&ExtractHandlerGuidTable);\r
-    \r
+    Status = PeiServicesLocatePpi (\r
+               &gEfiPeiMemoryDiscoveredPpiGuid,\r
+               0,\r
+               NULL,\r
+               (VOID **) &Dummy\r
+               );\r
+    ASSERT_EFI_ERROR (Status);\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+\r
     //\r
-    // Install custom extraction guid PPI\r
-    //\r
-    if (ExtractHandlerNumber > 0) {\r
-      GuidPpi = (EFI_PEI_PPI_DESCRIPTOR *) AllocatePool (ExtractHandlerNumber * sizeof (EFI_PEI_PPI_DESCRIPTOR));\r
-      ASSERT (GuidPpi != NULL);\r
-      while (ExtractHandlerNumber-- > 0) {\r
-        GuidPpi->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;\r
-        GuidPpi->Ppi   = (VOID *) &mCustomGuidedSectionExtractionPpi;\r
-        GuidPpi->Guid  = &ExtractHandlerGuidTable[ExtractHandlerNumber];\r
-        Status = PeiServicesInstallPpi (GuidPpi++);\r
-        ASSERT_EFI_ERROR(Status);\r
-      }\r
+    // Now the permanent memory exists, install the PPIs for decompression\r
+    // and section extraction.\r
+    //\r
+    Status = InstallIplPermanentMemoryPpis (NULL, NULL, NULL);\r
+    ASSERT_EFI_ERROR (Status);    \r
+  } else {\r
+    //\r
+    // Install memory discovered PPI notification to install PPIs for\r
+    // decompression and section extraction.\r
+    //\r
+    Status = PeiServicesNotifyPpi (&mMemoryDiscoveredNotifyList);\r
+    ASSERT_EFI_ERROR (Status);\r
+  }\r
+\r
+  //\r
+  // Install DxeIpl PPI.\r
+  //\r
+  Status = PeiServicesInstallPpi (&mDxeIplPpiList);\r
+  ASSERT_EFI_ERROR(Status);\r
+\r
+  return Status;\r
+}\r
+\r
+/**\r
+   This function installs the PPIs that require permanent memory.\r
+\r
+   @param  PeiServices      Indirect reference to the PEI Services Table.\r
+   @param  NotifyDescriptor Address of the notification descriptor data structure.\r
+   @param  Ppi              Address of the PPI that was installed.\r
+\r
+   @return EFI_SUCCESS      The PPIs were installed successfully.\r
+   @return Others           Some error occurs during the execution of this function.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InstallIplPermanentMemoryPpis (\r
+  IN EFI_PEI_SERVICES           **PeiServices,\r
+  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,\r
+  IN VOID                       *Ppi\r
+  )\r
+{\r
+  EFI_STATUS                    Status;\r
+  EFI_GUID                      *ExtractHandlerGuidTable;\r
+  UINTN                         ExtractHandlerNumber;\r
+  EFI_PEI_PPI_DESCRIPTOR        *GuidPpi;\r
+\r
+  //\r
+  // Get custom extract guided section method guid list \r
+  //\r
+  ExtractHandlerNumber = ExtractGuidedSectionGetGuidList (&ExtractHandlerGuidTable);\r
+\r
+  //\r
+  // Install custom guided section extraction PPI\r
+  //\r
+  if (ExtractHandlerNumber > 0) {\r
+    GuidPpi = (EFI_PEI_PPI_DESCRIPTOR *) AllocatePool (ExtractHandlerNumber * sizeof (EFI_PEI_PPI_DESCRIPTOR));\r
+    ASSERT (GuidPpi != NULL);\r
+    while (ExtractHandlerNumber-- > 0) {\r
+      GuidPpi->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;\r
+      GuidPpi->Ppi   = (VOID *) &mCustomGuidedSectionExtractionPpi;\r
+      GuidPpi->Guid  = &ExtractHandlerGuidTable[ExtractHandlerNumber];\r
+      Status = PeiServicesInstallPpi (GuidPpi++);\r
+      ASSERT_EFI_ERROR(Status);\r
     }\r
-    \r
   }\r
-  \r
+\r
   //\r
-  // Install DxeIpl and Decompress PPIs.\r
+  // Install Decompress PPI.\r
   //\r
-  Status = PeiServicesInstallPpi (mPpiList);\r
+  Status = PeiServicesInstallPpi (&mDecompressPpiList);\r
   ASSERT_EFI_ERROR(Status);\r
 \r
   return Status;\r
 }\r
 \r
+/**\r
+   Validate variable data for the MemoryTypeInformation. \r
+\r
+   @param MemoryData       Variable data.\r
+   @param MemoryDataSize   Variable data length.\r
+\r
+   @return TRUE            The variable data is valid.\r
+   @return FALSE           The variable data is invalid.\r
+\r
+**/\r
+BOOLEAN\r
+ValidateMemoryTypeInfoVariable (\r
+  IN EFI_MEMORY_TYPE_INFORMATION      *MemoryData,\r
+  IN UINTN                            MemoryDataSize\r
+  )\r
+{\r
+  UINTN                       Count;\r
+  UINTN                       Index;\r
+\r
+  // Check the input parameter.\r
+  if (MemoryData == NULL) {\r
+    return FALSE;\r
+  }\r
+\r
+  // Get Count\r
+  Count = MemoryDataSize / sizeof (*MemoryData);\r
+\r
+  // Check Size\r
+  if (Count * sizeof(*MemoryData) != MemoryDataSize) {\r
+    return FALSE;\r
+  }\r
+\r
+  // Check last entry type filed.\r
+  if (MemoryData[Count - 1].Type != EfiMaxMemoryType) {\r
+    return FALSE;\r
+  }\r
+\r
+  // Check the type filed.\r
+  for (Index = 0; Index < Count - 1; Index++) {\r
+    if (MemoryData[Index].Type >= EfiMaxMemoryType) {\r
+      return FALSE;\r
+    }\r
+  }\r
+\r
+  return TRUE;\r
+}\r
+\r
 /**\r
    Main entry point to last PEIM. \r
 \r
@@ -158,7 +269,7 @@ DxeLoadCore (
   UINTN                                     Instance;\r
   UINT32                                    AuthenticationState;\r
   UINTN                                     DataSize;\r
-  EFI_PEI_S3_RESUME_PPI                     *S3Resume;\r
+  EFI_PEI_S3_RESUME2_PPI                    *S3Resume;\r
   EFI_PEI_RECOVERY_MODULE_PPI               *PeiRecovery;\r
   EFI_MEMORY_TYPE_INFORMATION               MemoryData[EfiMaxMemoryType + 1];\r
 \r
@@ -169,60 +280,94 @@ DxeLoadCore (
 \r
   if (BootMode == BOOT_ON_S3_RESUME) {\r
     Status = PeiServicesLocatePpi (\r
-               &gEfiPeiS3ResumePpiGuid,\r
+               &gEfiPeiS3Resume2PpiGuid,\r
                0,\r
                NULL,\r
                (VOID **) &S3Resume\r
                );\r
+    if (EFI_ERROR (Status)) {\r
+      //\r
+      // Report Status code that S3Resume PPI can not be found\r
+      //\r
+      REPORT_STATUS_CODE (\r
+        EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
+        (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_S3_RESUME_PPI_NOT_FOUND)\r
+        );\r
+    }\r
     ASSERT_EFI_ERROR (Status);\r
     \r
-    Status = S3Resume->S3RestoreConfig (PeiServices);\r
+    Status = S3Resume->S3RestoreConfig2 (S3Resume);\r
     ASSERT_EFI_ERROR (Status);\r
   } else if (BootMode == BOOT_IN_RECOVERY_MODE) {\r
+    REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_RECOVERY_BEGIN));\r
     Status = PeiServicesLocatePpi (\r
                &gEfiPeiRecoveryModulePpiGuid,\r
                0,\r
                NULL,\r
                (VOID **) &PeiRecovery\r
                );\r
-    ASSERT_EFI_ERROR (Status);\r
-    \r
+\r
+    if (EFI_ERROR (Status)) {\r
+      DEBUG ((DEBUG_ERROR, "Locate Recovery PPI Failed.(Status = %r)\n", Status));\r
+      //\r
+      // Report Status code the failure of locating Recovery PPI \r
+      //\r
+      REPORT_STATUS_CODE (\r
+        EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
+        (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_RECOVERY_PPI_NOT_FOUND)\r
+        );\r
+      CpuDeadLoop ();\r
+    }\r
+\r
+    REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_CAPSULE_LOAD));\r
     Status = PeiRecovery->LoadRecoveryCapsule (PeiServices, PeiRecovery);\r
     if (EFI_ERROR (Status)) {\r
       DEBUG ((DEBUG_ERROR, "Load Recovery Capsule Failed.(Status = %r)\n", Status));\r
+      //\r
+      // Report Status code that recovery image can not be found\r
+      //\r
+      REPORT_STATUS_CODE (\r
+        EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
+        (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_NO_RECOVERY_CAPSULE)\r
+        );\r
       CpuDeadLoop ();\r
     }\r
-\r
+    REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_CAPSULE_START));\r
     //\r
     // Now should have a HOB with the DXE core\r
     //\r
   }\r
 \r
-  Status = PeiServicesLocatePpi (\r
-             &gEfiPeiReadOnlyVariable2PpiGuid,\r
-             0,\r
-             NULL,\r
-             (VOID **)&Variable\r
-             );\r
-  if (!EFI_ERROR (Status)) {\r
-    DataSize = sizeof (MemoryData);\r
-    Status = Variable->GetVariable ( \r
-                         Variable, \r
-                         EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,\r
-                         &gEfiMemoryTypeInformationGuid,\r
-                         NULL,\r
-                         &DataSize,\r
-                         &MemoryData\r
-                         );\r
+  if (GetFirstGuidHob ((CONST EFI_GUID *)&gEfiMemoryTypeInformationGuid) == NULL) {\r
+    //\r
+    // Don't build GuidHob if GuidHob has been installed.\r
+    //\r
+    Status = PeiServicesLocatePpi (\r
+               &gEfiPeiReadOnlyVariable2PpiGuid,\r
+               0,\r
+               NULL,\r
+               (VOID **)&Variable\r
+               );\r
     if (!EFI_ERROR (Status)) {\r
-      //\r
-      // Build the GUID'd HOB for DXE\r
-      //\r
-      BuildGuidDataHob (\r
-        &gEfiMemoryTypeInformationGuid,\r
-        MemoryData,\r
-        DataSize\r
-        );\r
+      DataSize = sizeof (MemoryData);\r
+      Status = Variable->GetVariable ( \r
+                           Variable, \r
+                           EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,\r
+                           &gEfiMemoryTypeInformationGuid,\r
+                           NULL,\r
+                           &DataSize,\r
+                           &MemoryData\r
+                           );\r
+      if (!EFI_ERROR (Status) && ValidateMemoryTypeInfoVariable(MemoryData, DataSize)) {\r
+        //\r
+        // Build the GUID'd HOB for DXE\r
+        //\r
+        BuildGuidDataHob (\r
+          &gEfiMemoryTypeInformationGuid,\r
+          MemoryData,\r
+          DataSize\r
+          );\r
+      }\r
     }\r
   }\r
 \r
@@ -271,7 +416,7 @@ DxeLoadCore (
   //\r
   // Report Status Code EFI_SW_PEI_PC_HANDOFF_TO_NEXT\r
   //\r
-  REPORT_STATUS_CODE (EFI_PROGRESS_CODE, FixedPcdGet32 (PcdStatusCodeValuePeiHandoffToDxe));\r
+  REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_CORE | EFI_SW_PEI_CORE_PC_HANDOFF_TO_NEXT));\r
 \r
   DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Loading DXE CORE at 0x%11p EntryPoint=0x%11p\n", (VOID *)(UINTN)DxeCoreAddress, FUNCTION_ENTRY_POINT (DxeCoreEntryPoint)));\r
 \r
@@ -318,6 +463,9 @@ DxeIplFindDxeCore (
     // If some error occurs here, then we cannot find any firmware\r
     // volume that may contain DxeCore.\r
     //\r
+    if (EFI_ERROR (Status)) {\r
+      REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_CORE_EC_DXE_CORRUPT));\r
+    }\r
     ASSERT_EFI_ERROR (Status);\r
     \r
     //\r
@@ -510,23 +658,34 @@ Decompress (
   EFI_STATUS                      Status;\r
   UINT8                           *DstBuffer;\r
   UINT8                           *ScratchBuffer;\r
-  UINT                          DstBufferSize;\r
+  UINT32                          DstBufferSize;\r
   UINT32                          ScratchBufferSize;\r
-  EFI_COMMON_SECTION_HEADER       *Section;\r
-  UINTN                           SectionLength;\r
+  VOID                            *CompressionSource;\r
+  UINT32                          CompressionSourceSize;\r
+  UINT32                          UncompressedLength;\r
+  UINT8                           CompressionType;\r
 \r
   if (CompressionSection->CommonHeader.Type != EFI_SECTION_COMPRESSION) {\r
     ASSERT (FALSE);\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  Section = (EFI_COMMON_SECTION_HEADER *) CompressionSection;\r
-  SectionLength = *(UINT32 *) (Section->Size) & 0x00ffffff;\r
+  if (IS_SECTION2 (CompressionSection)) {\r
+    CompressionSource = (VOID *) ((UINT8 *) CompressionSection + sizeof (EFI_COMPRESSION_SECTION2));\r
+    CompressionSourceSize = (UINT32) (SECTION2_SIZE (CompressionSection) - sizeof (EFI_COMPRESSION_SECTION2));\r
+    UncompressedLength = ((EFI_COMPRESSION_SECTION2 *) CompressionSection)->UncompressedLength;\r
+    CompressionType = ((EFI_COMPRESSION_SECTION2 *) CompressionSection)->CompressionType;\r
+  } else {\r
+    CompressionSource = (VOID *) ((UINT8 *) CompressionSection + sizeof (EFI_COMPRESSION_SECTION));\r
+    CompressionSourceSize = (UINT32) (SECTION_SIZE (CompressionSection) - sizeof (EFI_COMPRESSION_SECTION));\r
+    UncompressedLength = CompressionSection->UncompressedLength;\r
+    CompressionType = CompressionSection->CompressionType;\r
+  }\r
   \r
   //\r
   // This is a compression set, expand it\r
   //\r
-  switch (CompressionSection->CompressionType) {\r
+  switch (CompressionType) {\r
   case EFI_STANDARD_COMPRESSION:\r
     if (FeaturePcdGet(PcdDxeIplSupportUefiDecompress)) {\r
       //\r
@@ -534,9 +693,9 @@ Decompress (
       // For compressed data, decompress them to destination buffer.\r
       //\r
       Status = UefiDecompressGetInfo (\r
-                 (UINT8 *) ((EFI_COMPRESSION_SECTION *) Section + 1),\r
-                 (UINT32) SectionLength - sizeof (EFI_COMPRESSION_SECTION),\r
-                 (UINT32 *) &DstBufferSize,\r
+                 CompressionSource,\r
+                 CompressionSourceSize,\r
+                 &DstBufferSize,\r
                  &ScratchBufferSize\r
                  );\r
       if (EFI_ERROR (Status)) {\r
@@ -569,7 +728,7 @@ Decompress (
       // Call decompress function\r
       //\r
       Status = UefiDecompress (\r
-                  (CHAR8 *) ((EFI_COMPRESSION_SECTION *) Section + 1),\r
+                  CompressionSource,\r
                   DstBuffer,\r
                   ScratchBuffer\r
                   );\r
@@ -594,7 +753,7 @@ Decompress (
     //\r
     // Allocate destination buffer\r
     //\r
-    DstBufferSize = CompressionSection->UncompressedLength;\r
+    DstBufferSize = UncompressedLength;\r
     DstBuffer     = AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize) + 1);\r
     if (DstBuffer == NULL) {\r
       return EFI_OUT_OF_RESOURCES;\r
@@ -607,7 +766,7 @@ Decompress (
     //\r
     // stream is not actually compressed, just encapsulated.  So just copy it.\r
     //\r
-    CopyMem (DstBuffer, CompressionSection + 1, DstBufferSize);\r
+    CopyMem (DstBuffer, CompressionSource, DstBufferSize);\r
     break;\r
 \r
   default:\r
@@ -647,13 +806,14 @@ UpdateStackHob (
   while ((Hob.Raw = GetNextHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, Hob.Raw)) != NULL) {\r
     if (CompareGuid (&gEfiHobMemoryAllocStackGuid, &(Hob.MemoryAllocationStack->AllocDescriptor.Name))) {\r
       //\r
-      // Build a new memory allocation HOB with old stack info with EfiConventionalMemory type\r
-      // to be reclaimed by DXE core.\r
+      // Build a new memory allocation HOB with old stack info with EfiBootServicesData type. Need to \r
+      // avoid this region be reclaimed by DXE core as the IDT built in SEC might be on stack, and some \r
+      // PEIMs may also keep key information on stack\r
       //\r
       BuildMemoryAllocationHob (\r
         Hob.MemoryAllocationStack->AllocDescriptor.MemoryBaseAddress,\r
         Hob.MemoryAllocationStack->AllocDescriptor.MemoryLength,\r
-        EfiConventionalMemory\r
+        EfiBootServicesData\r
         );\r
       //\r
       // Update the BSP Stack Hob to reflect the new stack info.\r
@@ -665,3 +825,4 @@ UpdateStackHob (
     Hob.Raw = GET_NEXT_HOB (Hob);\r
   }\r
 }\r
+\r