/** @file\r
- Tiano PE/COFF loader.\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
- This PE/COFF loader supports loading any PE32 or PE32+ image type, 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
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
/**\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
RETURN_STATUS\r
EFIAPI\r
PeCoffLoaderGetImageInfo (\r
- IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
+ IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
)\r
{\r
RETURN_STATUS Status;\r
UINT32 NumberOfRvaAndSizes;\r
UINT16 Magic;\r
\r
- if (NULL == ImageContext) {\r
+ if (ImageContext == NULL) {\r
return RETURN_INVALID_PARAMETER;\r
}\r
//\r
// 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
ImageContext as the relocation base address. Otherwise, use the DestinationAddress field\r
of ImageContext as the relocation base address. The caller must allocate the relocation\r
fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.\r
+ \r
+ The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, \r
+ ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, \r
+ DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of \r
+ the ImageContext structure must be valid prior to invoking this service.\r
+ \r
If ImageContext is NULL, then ASSERT().\r
\r
@param ImageContext Pointer to the image context structure that describes the PE/COFF\r
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
//\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
}\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
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
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
specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate\r
the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.\r
The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.\r
+ The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize, \r
+ DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva \r
+ fields of the ImageContext structure must be valid prior to invoking this service.\r
+ \r
If ImageContext is NULL, then ASSERT().\r
\r
@param ImageContext Pointer to the image context structure that describes the PE/COFF\r
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
\r
/**\r
Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI\r
- runtime.\r
-\r
+ runtime. \r
+ \r
PE_COFF_LOADER_IMAGE_CONTEXT.FixupData stores information needed to reapply\r
the fixups with a virtual mapping.\r
\r
\r
- @param ImageBase Base address of relocated image\r
- @param VirtImageBase Virtual mapping for ImageBase\r
- @param ImageSize Size of the image to relocate\r
- @param RelocationData Location to place results of read\r
-\r
+ @param ImageBase Base address of a PE/COFF image that has been loaded \r
+ and relocated into system memory.\r
+ @param VirtImageBase The request virtual address that the PE/COFF image is to\r
+ be fixed up for.\r
+ @param ImageSize The size, in bytes, of the PE/COFF image.\r
+ @param RelocationData A pointer to the relocation data that was collected when the PE/COFF \r
+ image was relocated using PeCoffLoaderRelocateImage().\r
+ \r
**/\r
VOID\r
EFIAPI\r
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
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
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
\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
\r
\r
/**\r
- ImageRead function that operates on a memory buffer whos base is passed into\r
- FileHandle.\r
-\r
- @param FileHandle Ponter to baes of the input stream\r
- @param FileOffset Offset to the start of the buffer\r
- @param ReadSize Number of bytes to copy into the buffer\r
- @param Buffer Location to place results of read\r
-\r
- @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into\r
+ Reads contents of a PE/COFF image from a buffer in system memory.\r
+ \r
+ This is the default implementation of a PE_COFF_LOADER_READ_FILE function \r
+ that assumes FileHandle pointer to the beginning of a PE/COFF image. \r
+ This function reads contents of the PE/COFF image that starts at the system memory \r
+ address specified by FileHandle. The read operation copies ReadSize bytes from the \r
+ PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer. \r
+ The size of the buffer actually read is returned in ReadSize.\r
+ \r
+ If FileHandle is NULL, then ASSERT().\r
+ If ReadSize is NULL, then ASSERT().\r
+ If Buffer is NULL, then ASSERT().\r
+\r
+ @param FileHandle Pointer to base of the input stream\r
+ @param FileOffset Offset into the PE/COFF image to begin the read operation.\r
+ @param ReadSize On input, the size in bytes of the requested read operation. \r
+ On output, the number of bytes actually read.\r
+ @param Buffer Output buffer that contains the data read from the PE/COFF image.\r
+\r
+ @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into \r
the buffer.\r
**/\r
RETURN_STATUS\r
OUT VOID *Buffer\r
)\r
{\r
+ ASSERT (ReadSize != NULL);\r
+ ASSERT (FileHandle != NULL);\r
+ ASSERT (Buffer != NULL);\r
+\r
CopyMem (Buffer, ((UINT8 *)FileHandle) + FileOffset, *ReadSize);\r
return RETURN_SUCCESS;\r
}\r
\r
/**\r
Unloads a loaded PE/COFF image from memory and releases its taken resource.\r
- \r
+ Releases any environment specific resources that were allocated when the image \r
+ specified by ImageContext was loaded using PeCoffLoaderLoadImage(). \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
+ \r
+ If ImageContext is NULL, then ASSERT().\r
+ \r
@param ImageContext Pointer to the image context structure that describes the PE/COFF\r
image to be unloaded.\r
\r
RETURN_STATUS\r
EFIAPI\r
PeCoffLoaderUnloadImage (\r
- IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
+ IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
)\r
{\r
return RETURN_SUCCESS;\r
projects / mirror_edk2.git / blobdiff