]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BasePeCoffLib/BasePeCoff.c
Update HobLib and PeCoffLib according to MDE Lib Spec 0.61c
[mirror_edk2.git] / MdePkg / Library / BasePeCoffLib / BasePeCoff.c
index 67a821a4657b2123e796d12821acaabf2c0a3715..7df939d7580a1f2cedc62e62e898e1c01c5c87e8 100644 (file)
@@ -1,10 +1,8 @@
 /** @file\r
-  Tiano PE/COFF loader.\r
-\r
-  This PE/COFF loader supports loading any PE32 or PE32+ image type, but\r
+  Base PE/COFF loader supports loading any PE32/PE32+ or TE image, but\r
   only supports relocating IA32, X64, IPF, and EBC images.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2008, Intel Corporation\r
   All rights reserved. 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
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  Module Name:  PeCoffLoader.c\r
-\r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
-#include "CommonHeader.h"\r
-\r
 #include "BasePeCoffLibInternals.h"\r
 \r
 /**\r
@@ -124,8 +115,12 @@ PeCoffLoaderGetPeHeader (
     ImageContext->IsTeImage         = TRUE;\r
     ImageContext->Machine           = Hdr.Te->Machine;\r
     ImageContext->ImageType         = (UINT16)(Hdr.Te->Subsystem);\r
+    //\r
+    // For TeImage, SectionAlignment is undefined to be set to Zero\r
+    // ImageSize can be calculated.\r
+    //\r
     ImageContext->ImageSize         = 0;\r
-    ImageContext->SectionAlignment  = 4096;\r
+    ImageContext->SectionAlignment  = 0;\r
     ImageContext->SizeOfHeaders     = sizeof (EFI_TE_IMAGE_HEADER) + (UINTN)Hdr.Te->BaseOfCode - (UINTN)Hdr.Te->StrippedSize;\r
 \r
   } else if (Hdr.Pe32->Signature == EFI_IMAGE_NT_SIGNATURE)  {\r
@@ -177,13 +172,15 @@ PeCoffLoaderGetPeHeader (
 /**\r
   Retrieves information about a PE/COFF image.\r
 \r
-  Computes the PeCoffHeaderOffset, ImageAddress, ImageSize, DestinationAddress, CodeView,\r
-  PdbPointer, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva\r
-  fields of the ImageContext structure.  If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.\r
-  If the PE/COFF image accessed through the ImageRead service in the ImageContext structure is not\r
-  a supported PE/COFF image type, then return RETURN_UNSUPPORTED.  If any errors occur while\r
-  computing the fields of ImageContext, then the error status is returned in the ImageError field of\r
-  ImageContext.\r
+  Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize, \r
+  DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and \r
+  DebugDirectoryEntryRva fields of the ImageContext structure.  \r
+  If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.  \r
+  If the PE/COFF image accessed through the ImageRead service in the ImageContext \r
+  structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED.  \r
+  If any errors occur while computing the fields of ImageContext, \r
+  then the error status is returned in the ImageError field of ImageContext.  \r
+  If the image is a TE image, then SectionAlignment is set to 0.\r
 \r
   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF\r
                                     image that needs to be examined by this function.\r
@@ -213,7 +210,7 @@ PeCoffLoaderGetImageInfo (
   UINT32                                NumberOfRvaAndSizes;\r
   UINT16                                Magic;\r
 \r
-  if (NULL == ImageContext) {\r
+  if (ImageContext == NULL) {\r
     return RETURN_INVALID_PARAMETER;\r
   }\r
   //\r
@@ -273,6 +270,8 @@ PeCoffLoaderGetImageInfo (
   //\r
   if ((!(ImageContext->IsTeImage)) && ((Hdr.Pe32->FileHeader.Characteristics & EFI_IMAGE_FILE_RELOCS_STRIPPED) != 0)) {\r
     ImageContext->RelocationsStripped = TRUE;\r
+  } else if ((ImageContext->IsTeImage) && (Hdr.Te->DataDirectory[0].Size == 0) && (Hdr.Te->DataDirectory[0].VirtualAddress == 0)) {\r
+    ImageContext->RelocationsStripped = TRUE;\r
   } else {\r
     ImageContext->RelocationsStripped = FALSE;\r
   }\r
@@ -414,11 +413,10 @@ PeCoffLoaderGetImageInfo (
       // section headers in the Section Table must appear in order of the RVA\r
       // values for the corresponding sections. So the ImageSize can be determined\r
       // by the RVA and the VirtualSize of the last section header in the\r
-      // Section Table.\r
+      // Section Table.  \r
       //\r
       if ((++Index) == (UINTN)Hdr.Te->NumberOfSections) {\r
-        ImageContext->ImageSize = (SectionHeader.VirtualAddress + SectionHeader.Misc.VirtualSize +\r
-                                   ImageContext->SectionAlignment - 1) & ~(ImageContext->SectionAlignment - 1);\r
+        ImageContext->ImageSize = (SectionHeader.VirtualAddress + SectionHeader.Misc.VirtualSize);\r
       }\r
 \r
       SectionHeaderOffset += sizeof (EFI_IMAGE_SECTION_HEADER);\r
@@ -544,11 +542,8 @@ PeCoffLoaderRelocateImage (
   //\r
   if (ImageContext->DestinationAddress != 0) {\r
     BaseAddress = ImageContext->DestinationAddress;\r
-  } else if (!(ImageContext->IsTeImage)) {\r
-    BaseAddress = ImageContext->ImageAddress;\r
   } else {\r
-    Hdr.Te      = (EFI_TE_IMAGE_HEADER *)(UINTN)(ImageContext->ImageAddress);\r
-    BaseAddress = ImageContext->ImageAddress + sizeof (EFI_TE_IMAGE_HEADER) - Hdr.Te->StrippedSize; \r
+    BaseAddress = ImageContext->ImageAddress;\r
   }\r
 \r
   if (!(ImageContext->IsTeImage)) {\r
@@ -597,8 +592,8 @@ PeCoffLoaderRelocateImage (
     }\r
   } else {\r
     Hdr.Te             = (EFI_TE_IMAGE_HEADER *)(UINTN)(ImageContext->ImageAddress);\r
-    Adjust             = (UINT64) (BaseAddress - Hdr.Te->ImageBase);\r
-    Hdr.Te->ImageBase  = (UINT64) (BaseAddress);\r
+    Adjust             = (UINT64) (BaseAddress - Hdr.Te->StrippedSize + sizeof (EFI_TE_IMAGE_HEADER) - Hdr.Te->ImageBase);\r
+    Hdr.Te->ImageBase  = (UINT64) (BaseAddress - Hdr.Te->StrippedSize + sizeof (EFI_TE_IMAGE_HEADER));\r
 \r
     //\r
     // Find the relocation block\r
@@ -711,6 +706,13 @@ PeCoffLoaderRelocateImage (
     RelocBase = (EFI_IMAGE_BASE_RELOCATION *) RelocEnd;\r
   }\r
 \r
+  //\r
+  // Adjust the EntryPoint to match the linked-to address\r
+  //\r
+  if (ImageContext->DestinationAddress != 0) {\r
+     ImageContext->EntryPoint -= (UINT64) ImageContext->ImageAddress;\r
+     ImageContext->EntryPoint += (UINT64) ImageContext->DestinationAddress;\r
+  }\r
   return RETURN_SUCCESS;\r
 }\r
 \r
@@ -906,7 +908,7 @@ PeCoffLoaderLoadImage (
       Size = (UINTN) Section->SizeOfRawData;\r
     }\r
 \r
-    if (Section->SizeOfRawData) {\r
+    if (Section->SizeOfRawData > 0) {\r
       if (!(ImageContext->IsTeImage)) {\r
         Status = ImageContext->ImageRead (\r
                                 ImageContext->Handle,\r
@@ -1211,12 +1213,15 @@ PeCoffLoaderRelocateImageForRuntime (
     RelocBaseEnd  = (EFI_IMAGE_BASE_RELOCATION *)(UINTN)(ImageBase + RelocDir->VirtualAddress + RelocDir->Size);\r
   } else {\r
     //\r
-    // Cannot find relocations, cannot continue\r
+    // Cannot find relocations, cannot continue to relocate the image, ASSERT for this invalid image.\r
     //\r
     ASSERT (FALSE);\r
     return ;\r
   }\r
-\r
+  \r
+  //\r
+  // ASSERT for the invalid image when RelocBase and RelocBaseEnd are both NULL.\r
+  //\r
   ASSERT (RelocBase != NULL && RelocBaseEnd != NULL);\r
 \r
   //\r
@@ -1284,7 +1289,7 @@ PeCoffLoaderRelocateImageForRuntime (
 \r
       case EFI_IMAGE_REL_BASED_HIGHADJ:\r
         //\r
-        // Not implemented, but not used in EFI 1.0\r
+        // Not valid Relocation type for UEFI image, ASSERT\r
         //\r
         ASSERT (FALSE);\r
         break;\r
@@ -1336,3 +1341,23 @@ PeCoffLoaderImageReadFromMemory (
   return RETURN_SUCCESS;\r
 }\r
 \r
+/**\r
+  Unloads a loaded PE/COFF image from memory and releases its taken resource.\r
+   \r
+  For NT32 emulator, the PE/COFF image loaded by system needs to release.\r
+  For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, \r
+  this function can simply return RETURN_SUCCESS.\r
+\r
+  @param  ImageContext              Pointer to the image context structure that describes the PE/COFF\r
+                                    image to be unloaded.\r
+\r
+  @retval RETURN_SUCCESS            The PE/COFF image was unloaded successfully.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PeCoffLoaderUnloadImage (\r
+  IN PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
+  )\r
+{\r
+  return RETURN_SUCCESS;\r
+}\r