]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BasePeCoffLib/BasePeCoff.c
Fix the parameter typo, it should confirm to UEFI spec.
[mirror_edk2.git] / MdePkg / Library / BasePeCoffLib / BasePeCoff.c
index dbdb5ab869aa8e9af1792c8895dbf8636d362d0b..9756520aa6d98815aea6ad9d6e7a6c72f7c3f627 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
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
-\r
-\r
 #include "BasePeCoffLibInternals.h"\r
 \r
 /**\r
@@ -122,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
@@ -175,13 +172,17 @@ 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
+  The ImageRead and Handle fields of ImageContext structure must be valid prior \r
+  to invoking this service.\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
@@ -211,7 +212,7 @@ PeCoffLoaderGetImageInfo (
   UINT32                                NumberOfRvaAndSizes;\r
   UINT16                                Magic;\r
 \r
-  if (NULL == ImageContext) {\r
+  if (ImageContext == NULL) {\r
     return RETURN_INVALID_PARAMETER;\r
   }\r
   //\r
@@ -414,11 +415,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
@@ -516,9 +516,9 @@ PeCoffLoaderRelocateImage (
   UINT16                                *RelocEnd;\r
   CHAR8                                 *Fixup;\r
   CHAR8                                 *FixupBase;\r
-  UINT16                                *F16;\r
-  UINT32                                *F32;\r
-  UINT64                                *F64;\r
+  UINT16                                *Fixup16;\r
+  UINT32                                *Fixup32;\r
+  UINT64                                *Fixup64;\r
   CHAR8                                 *FixupData;\r
   PHYSICAL_ADDRESS                      BaseAddress;\r
   UINT32                                NumberOfRvaAndSizes;\r
@@ -544,11 +544,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 +594,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
@@ -649,39 +646,39 @@ PeCoffLoaderRelocateImage (
         break;\r
 \r
       case EFI_IMAGE_REL_BASED_HIGH:\r
-        F16   = (UINT16 *) Fixup;\r
-        *F16 = (UINT16) (*F16 + ((UINT16) ((UINT32) Adjust >> 16)));\r
+        Fixup16   = (UINT16 *) Fixup;\r
+        *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) ((UINT32) Adjust >> 16)));\r
         if (FixupData != NULL) {\r
-          *(UINT16 *) FixupData = *F16;\r
+          *(UINT16 *) FixupData = *Fixup16;\r
           FixupData             = FixupData + sizeof (UINT16);\r
         }\r
         break;\r
 \r
       case EFI_IMAGE_REL_BASED_LOW:\r
-        F16   = (UINT16 *) Fixup;\r
-        *F16  = (UINT16) (*F16 + (UINT16) Adjust);\r
+        Fixup16   = (UINT16 *) Fixup;\r
+        *Fixup16  = (UINT16) (*Fixup16 + (UINT16) Adjust);\r
         if (FixupData != NULL) {\r
-          *(UINT16 *) FixupData = *F16;\r
+          *(UINT16 *) FixupData = *Fixup16;\r
           FixupData             = FixupData + sizeof (UINT16);\r
         }\r
         break;\r
 \r
       case EFI_IMAGE_REL_BASED_HIGHLOW:\r
-        F32   = (UINT32 *) Fixup;\r
-        *F32  = *F32 + (UINT32) Adjust;\r
+        Fixup32   = (UINT32 *) Fixup;\r
+        *Fixup32  = *Fixup32 + (UINT32) Adjust;\r
         if (FixupData != NULL) {\r
           FixupData             = ALIGN_POINTER (FixupData, sizeof (UINT32));\r
-          *(UINT32 *)FixupData  = *F32;\r
+          *(UINT32 *)FixupData  = *Fixup32;\r
           FixupData             = FixupData + sizeof (UINT32);\r
         }\r
         break;\r
 \r
       case EFI_IMAGE_REL_BASED_DIR64:\r
-        F64 = (UINT64 *) Fixup;\r
-        *F64 = *F64 + (UINT64) Adjust;\r
+        Fixup64 = (UINT64 *) Fixup;\r
+        *Fixup64 = *Fixup64 + (UINT64) Adjust;\r
         if (FixupData != NULL) {\r
           FixupData = ALIGN_POINTER (FixupData, sizeof(UINT64));\r
-          *(UINT64 *)(FixupData) = *F64;\r
+          *(UINT64 *)(FixupData) = *Fixup64;\r
           FixupData = FixupData + sizeof(UINT64);\r
         }\r
         break;\r
@@ -711,6 +708,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 +910,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
@@ -1147,9 +1151,9 @@ PeCoffLoaderRelocateImageForRuntime (
   UINT16                              *RelocEnd;\r
   CHAR8                               *Fixup;\r
   CHAR8                               *FixupBase;\r
-  UINT16                              *F16;\r
-  UINT32                              *F32;\r
-  UINT64                              *F64;\r
+  UINT16                              *Fixup16;\r
+  UINT32                              *Fixup32;\r
+  UINT64                              *Fixup64;\r
   CHAR8                               *FixupData;\r
   UINTN                               Adjust;\r
   RETURN_STATUS                       Status;\r
@@ -1211,12 +1215,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
@@ -1245,38 +1252,38 @@ PeCoffLoaderRelocateImageForRuntime (
         break;\r
 \r
       case EFI_IMAGE_REL_BASED_HIGH:\r
-        F16 = (UINT16 *) Fixup;\r
-        if (*(UINT16 *) FixupData == *F16) {\r
-          *F16 = (UINT16) (*F16 + ((UINT16) ((UINT32) Adjust >> 16)));\r
+        Fixup16 = (UINT16 *) Fixup;\r
+        if (*(UINT16 *) FixupData == *Fixup16) {\r
+          *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) ((UINT32) Adjust >> 16)));\r
         }\r
 \r
         FixupData = FixupData + sizeof (UINT16);\r
         break;\r
 \r
       case EFI_IMAGE_REL_BASED_LOW:\r
-        F16 = (UINT16 *) Fixup;\r
-        if (*(UINT16 *) FixupData == *F16) {\r
-          *F16 = (UINT16) (*F16 + ((UINT16) Adjust & 0xffff));\r
+        Fixup16 = (UINT16 *) Fixup;\r
+        if (*(UINT16 *) FixupData == *Fixup16) {\r
+          *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) Adjust & 0xffff));\r
         }\r
 \r
         FixupData = FixupData + sizeof (UINT16);\r
         break;\r
 \r
       case EFI_IMAGE_REL_BASED_HIGHLOW:\r
-        F32       = (UINT32 *) Fixup;\r
+        Fixup32       = (UINT32 *) Fixup;\r
         FixupData = ALIGN_POINTER (FixupData, sizeof (UINT32));\r
-        if (*(UINT32 *) FixupData == *F32) {\r
-          *F32 = *F32 + (UINT32) Adjust;\r
+        if (*(UINT32 *) FixupData == *Fixup32) {\r
+          *Fixup32 = *Fixup32 + (UINT32) Adjust;\r
         }\r
 \r
         FixupData = FixupData + sizeof (UINT32);\r
         break;\r
 \r
       case EFI_IMAGE_REL_BASED_DIR64:\r
-        F64       = (UINT64 *)Fixup;\r
+        Fixup64       = (UINT64 *)Fixup;\r
         FixupData = ALIGN_POINTER (FixupData, sizeof (UINT64));\r
-        if (*(UINT64 *) FixupData == *F64) {\r
-          *F64 = *F64 + (UINT64)Adjust;\r
+        if (*(UINT64 *) FixupData == *Fixup64) {\r
+          *Fixup64 = *Fixup64 + (UINT64)Adjust;\r
         }\r
 \r
         FixupData = FixupData + sizeof (UINT64);\r
@@ -1284,7 +1291,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