From: "Ard Biesheuvel" <ardb@kernel.org>
To: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: devel@edk2.groups.io
Subject: Re: [PATCH] EmbeddedPkg/PrePiHobLib: Get rid of PeCoffLoaderProtocol
Date: Mon, 13 Mar 2023 18:20:20 +0100 [thread overview]
Message-ID: <CAMj1kXF3y3tGf6_pUTSZroXn08uJqyg16zzL_pMC-Ab1mc2cow@mail.gmail.com> (raw)
In-Reply-To: <ZA84JYoPNAgoHrCL@qc-i7.hemma.eciton.net>
On Mon, 13 Mar 2023 at 15:50, Leif Lindholm <quic_llindhol@quicinc.com> wrote:
>
> No objection as such, but do we know what it was ever used for?
>
> /
> Leif
>
>From edk2-platforms (see below). The reason was probably to avoid
having two copies of that code in the firmware binary.
commit b7505f9c27f11064373ce3359ec312f48b265643
Author: Ard Biesheuvel <ardb@kernel.org>
Date: Sun Feb 12 23:50:39 2023 +0100
Platform/BeagleBoard: Drop PeCoff protocol
BeagleBoard is the only user of the so-called 'PE/COFF protocol', which
just exposes the PE/COFF loader library API via a protocol, presumably
to avoid duplicating this code in the PrePi SEC component as well as the
DXE core.
This is a rather questionable practice, and it would be better to drop
this code so we can remove it from the EDK2 main repo as well.
Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
Reviewed-by: Leif Lindholm <quic_llindhol@quicinc.com>
> On Mon, Mar 13, 2023 at 14:45:17 +0100, Ard Biesheuvel wrote:
> > Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
> > ---
> > EmbeddedPkg/EmbeddedPkg.dec | 1 -
> > EmbeddedPkg/Include/Library/PrePiLib.h | 6 -
> > EmbeddedPkg/Include/Protocol/PeCoffLoader.h | 220 --------------------
> > EmbeddedPkg/Library/PrePiHobLib/Hob.c | 22 --
> > EmbeddedPkg/Library/PrePiLib/PrePiLib.inf | 4 -
> > 5 files changed, 253 deletions(-)
> > delete mode 100644 EmbeddedPkg/Include/Protocol/PeCoffLoader.h
> >
> > diff --git a/EmbeddedPkg/EmbeddedPkg.dec b/EmbeddedPkg/EmbeddedPkg.dec
> > index 341ef5e6a679..010af91bed65 100644
> > --- a/EmbeddedPkg/EmbeddedPkg.dec
> > +++ b/EmbeddedPkg/EmbeddedPkg.dec
> > @@ -78,7 +78,6 @@ [Protocols.common]
> > gEmbeddedDeviceGuid = { 0xbf4b9d10, 0x13ec, 0x43dd, { 0x88, 0x80, 0xe9, 0xb, 0x71, 0x8f, 0x27, 0xde } }
> > gEmbeddedExternalDeviceProtocolGuid = { 0x735F8C64, 0xD696, 0x44D0, { 0xBD, 0xF2, 0x44, 0x7F, 0xD0, 0x5A, 0x54, 0x06 }}
> > gEmbeddedGpioProtocolGuid = { 0x17a0a3d7, 0xc0a5, 0x4635, { 0xbb, 0xd5, 0x07, 0x21, 0x87, 0xdf, 0xe2, 0xee }}
> > - gPeCoffLoaderProtocolGuid = { 0xB323179B, 0x97FB, 0x477E, { 0xB0, 0xFE, 0xD8, 0x85, 0x91, 0xFA, 0x11, 0xAB } }
> > gEmbeddedMmcHostProtocolGuid = { 0x3e591c00, 0x9e4a, 0x11df, {0x92, 0x44, 0x00, 0x02, 0xA5, 0xD5, 0xC5, 0x1B }}
> > gAndroidFastbootTransportProtocolGuid = { 0x74bd9fe0, 0x8902, 0x11e3, {0xb9, 0xd3, 0xf7, 0x22, 0x38, 0xfc, 0x9a, 0x31}}
> > gAndroidFastbootPlatformProtocolGuid = { 0x524685a0, 0x89a0, 0x11e3, {0x9d, 0x4d, 0xbf, 0xa9, 0xf6, 0xa4, 0x03, 0x08}}
> > diff --git a/EmbeddedPkg/Include/Library/PrePiLib.h b/EmbeddedPkg/Include/Library/PrePiLib.h
> > index 14f2bbc38dae..eb4bcec30fa1 100644
> > --- a/EmbeddedPkg/Include/Library/PrePiLib.h
> > +++ b/EmbeddedPkg/Include/Library/PrePiLib.h
> > @@ -673,12 +673,6 @@ BuildExtractSectionHob (
> > IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER SectionExtraction
> > );
> >
> > -VOID
> > -EFIAPI
> > -BuildPeCoffLoaderHob (
> > - VOID
> > - );
> > -
> > /**
> > Allocates one or more 4KB pages of type EfiBootServicesData.
> >
> > diff --git a/EmbeddedPkg/Include/Protocol/PeCoffLoader.h b/EmbeddedPkg/Include/Protocol/PeCoffLoader.h
> > deleted file mode 100644
> > index 08738e99276a..000000000000
> > --- a/EmbeddedPkg/Include/Protocol/PeCoffLoader.h
> > +++ /dev/null
> > @@ -1,220 +0,0 @@
> > -/** @file
> > -
> > - Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
> > - Portions copyright (c) 2010, Apple Inc. All rights reserved.<BR>
> > - SPDX-License-Identifier: BSD-2-Clause-Patent
> > -
> > -**/
> > -
> > -#ifndef __PE_COFF_LOADER_H__
> > -#define __PE_COFF_LOADER_H__
> > -
> > -// Needed for PE_COFF_LOADER_IMAGE_CONTEXT
> > -#include <Library/PeCoffLib.h>
> > -
> > -// B323179B-97FB-477E-B0FE-D88591FA11AB
> > -#define PE_COFF_LOADER_PROTOCOL_GUID \
> > - { 0xB323179B, 0x97FB, 0x477E, { 0xB0, 0xFE, 0xD8, 0x85, 0x91, 0xFA, 0x11, 0xAB } }
> > -
> > -typedef struct _PE_COFF_LOADER_PROTOCOL PE_COFF_LOADER_PROTOCOL;
> > -
> > -/**
> > - Retrieves information about a PE/COFF image.
> > -
> > - Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize,
> > - DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and
> > - DebugDirectoryEntryRva fields of the ImageContext structure.
> > - If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.
> > - If the PE/COFF image accessed through the ImageRead service in the ImageContext
> > - structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED.
> > - If any errors occur while computing the fields of ImageContext,
> > - then the error status is returned in the ImageError field of ImageContext.
> > - If the image is a TE image, then SectionAlignment is set to 0.
> > - The ImageRead and Handle fields of ImageContext structure must be valid prior
> > - to invoking this service.
> > -
> > - @param ImageContext Pointer to the image context structure that describes the PE/COFF
> > - image that needs to be examined by this function.
> > -
> > - @retval RETURN_SUCCESS The information on the PE/COFF image was collected.
> > - @retval RETURN_INVALID_PARAMETER ImageContext is NULL.
> > - @retval RETURN_UNSUPPORTED The PE/COFF image is not supported.
> > -
> > -**/
> > -typedef
> > -RETURN_STATUS
> > -(EFIAPI *PE_COFF_LOADER_GET_IMAGE_INFO)(
> > - IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
> > - );
> > -
> > -/**
> > - Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().
> > -
> > - If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of
> > - ImageContext as the relocation base address. Otherwise, use the DestinationAddress field
> > - of ImageContext as the relocation base address. The caller must allocate the relocation
> > - fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
> > -
> > - The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress,
> > - ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders,
> > - DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of
> > - the ImageContext structure must be valid prior to invoking this service.
> > -
> > - If ImageContext is NULL, then ASSERT().
> > -
> > - Note that if the platform does not maintain coherency between the instruction cache(s) and the data
> > - cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
> > - prior to transferring control to a PE/COFF image that is loaded using this library.
> > -
> > - @param ImageContext Pointer to the image context structure that describes the PE/COFF
> > - image that is being relocated.
> > -
> > - @retval RETURN_SUCCESS The PE/COFF image was relocated.
> > - Extended status information is in the ImageError field of ImageContext.
> > - @retval RETURN_LOAD_ERROR The image in not a valid PE/COFF image.
> > - Extended status information is in the ImageError field of ImageContext.
> > - @retval RETURN_UNSUPPORTED A relocation record type is not supported.
> > - Extended status information is in the ImageError field of ImageContext.
> > -
> > -**/
> > -typedef
> > -RETURN_STATUS
> > -(EFIAPI *PE_COFF_LOADER_RELOCATE_IMAGE)(
> > - IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
> > - );
> > -
> > -/**
> > - Loads a PE/COFF image into memory.
> > -
> > - Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer
> > - specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate
> > - the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
> > - The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed.
> > - The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize,
> > - DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
> > - fields of the ImageContext structure must be valid prior to invoking this service.
> > -
> > - If ImageContext is NULL, then ASSERT().
> > -
> > - Note that if the platform does not maintain coherency between the instruction cache(s) and the data
> > - cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
> > - prior to transferring control to a PE/COFF image that is loaded using this library.
> > -
> > - @param ImageContext Pointer to the image context structure that describes the PE/COFF
> > - image that is being loaded.
> > -
> > - @retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by
> > - the ImageAddress and ImageSize fields of ImageContext.
> > - Extended status information is in the ImageError field of ImageContext.
> > - @retval RETURN_BUFFER_TOO_SMALL The caller did not provide a large enough buffer.
> > - Extended status information is in the ImageError field of ImageContext.
> > - @retval RETURN_LOAD_ERROR The PE/COFF image is an EFI Runtime image with no relocations.
> > - Extended status information is in the ImageError field of ImageContext.
> > - @retval RETURN_INVALID_PARAMETER The image address is invalid.
> > - Extended status information is in the ImageError field of ImageContext.
> > -
> > -**/
> > -typedef
> > -RETURN_STATUS
> > -(EFIAPI *PE_COFF_LOADER_LOAD_IMAGE)(
> > - IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
> > - );
> > -
> > -/**
> > - Reads contents of a PE/COFF image from a buffer in system memory.
> > -
> > - This is the default implementation of a PE_COFF_LOADER_READ_FILE function
> > - that assumes FileHandle pointer to the beginning of a PE/COFF image.
> > - This function reads contents of the PE/COFF image that starts at the system memory
> > - address specified by FileHandle. The read operation copies ReadSize bytes from the
> > - PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer.
> > - The size of the buffer actually read is returned in ReadSize.
> > -
> > - If FileHandle is NULL, then ASSERT().
> > - If ReadSize is NULL, then ASSERT().
> > - If Buffer is NULL, then ASSERT().
> > -
> > - @param FileHandle Pointer to base of the input stream
> > - @param FileOffset Offset into the PE/COFF image to begin the read operation.
> > - @param ReadSize On input, the size in bytes of the requested read operation.
> > - On output, the number of bytes actually read.
> > - @param Buffer Output buffer that contains the data read from the PE/COFF image.
> > -
> > - @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into
> > - the buffer.
> > -**/
> > -typedef
> > -RETURN_STATUS
> > -(EFIAPI *PE_COFF_LOADER_READ_FROM_MEMORY)(
> > - IN VOID *FileHandle,
> > - IN UINTN FileOffset,
> > - IN OUT UINTN *ReadSize,
> > - OUT VOID *Buffer
> > - );
> > -
> > -/**
> > - Reapply fixups on a fixed up PE32/PE32+ image to allow virtual calling at EFI
> > - runtime.
> > -
> > - This function reapplies relocation fixups to the PE/COFF image specified by ImageBase
> > - and ImageSize so the image will execute correctly when the PE/COFF image is mapped
> > - to the address specified by VirtualImageBase. RelocationData must be identical
> > - to the FixupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure
> > - after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().
> > -
> > - Note that if the platform does not maintain coherency between the instruction cache(s) and the data
> > - cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
> > - prior to transferring control to a PE/COFF image that is loaded using this library.
> > -
> > - @param ImageBase Base address of a PE/COFF image that has been loaded
> > - and relocated into system memory.
> > - @param VirtImageBase The request virtual address that the PE/COFF image is to
> > - be fixed up for.
> > - @param ImageSize The size, in bytes, of the PE/COFF image.
> > - @param RelocationData A pointer to the relocation data that was collected when the PE/COFF
> > - image was relocated using PeCoffLoaderRelocateImage().
> > -
> > -**/
> > -typedef
> > -VOID
> > -(EFIAPI *PE_COFF_LOADER_RELOCATE_IMAGE_FOR_RUNTIME)(
> > - IN PHYSICAL_ADDRESS ImageBase,
> > - IN PHYSICAL_ADDRESS VirtImageBase,
> > - IN UINTN ImageSize,
> > - IN VOID *RelocationData
> > - );
> > -
> > -/**
> > - Unloads a loaded PE/COFF image from memory and releases its taken resource.
> > - Releases any environment specific resources that were allocated when the image
> > - specified by ImageContext was loaded using PeCoffLoaderLoadImage().
> > -
> > - For NT32 emulator, the PE/COFF image loaded by system needs to release.
> > - For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,
> > - this function can simply return RETURN_SUCCESS.
> > -
> > - If ImageContext is NULL, then ASSERT().
> > -
> > - @param ImageContext Pointer to the image context structure that describes the PE/COFF
> > - image to be unloaded.
> > -
> > - @retval RETURN_SUCCESS The PE/COFF image was unloaded successfully.
> > -**/
> > -typedef
> > -RETURN_STATUS
> > -(EFIAPI *PE_COFF_LOADER_UNLOAD_IMAGE)(
> > - IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
> > - );
> > -
> > -struct _PE_COFF_LOADER_PROTOCOL {
> > - PE_COFF_LOADER_GET_IMAGE_INFO GetImageInfo;
> > - PE_COFF_LOADER_LOAD_IMAGE LoadImage;
> > - PE_COFF_LOADER_RELOCATE_IMAGE RelocateImage;
> > - PE_COFF_LOADER_READ_FROM_MEMORY ReadFromMemory;
> > - PE_COFF_LOADER_RELOCATE_IMAGE_FOR_RUNTIME RelocateImageForRuntime;
> > - PE_COFF_LOADER_UNLOAD_IMAGE UnloadImage;
> > -};
> > -
> > -extern EFI_GUID gPeCoffLoaderProtocolGuid;
> > -
> > -#endif
> > diff --git a/EmbeddedPkg/Library/PrePiHobLib/Hob.c b/EmbeddedPkg/Library/PrePiHobLib/Hob.c
> > index 8eb175aa96f9..a43383b510d8 100644
> > --- a/EmbeddedPkg/Library/PrePiHobLib/Hob.c
> > +++ b/EmbeddedPkg/Library/PrePiHobLib/Hob.c
> > @@ -17,7 +17,6 @@
> > #include <Library/PcdLib.h>
> > #include <Library/PrePiHobListPointerLib.h>
> >
> > -#include <Protocol/PeCoffLoader.h>
> > #include <Guid/ExtractSection.h>
> > #include <Guid/MemoryTypeInformation.h>
> > #include <Guid/MemoryAllocationHob.h>
> > @@ -782,27 +781,6 @@ BuildExtractSectionHob (
> > BuildGuidDataHob (Guid, &Data, sizeof (Data));
> > }
> >
> > -PE_COFF_LOADER_PROTOCOL gPeCoffProtocol = {
> > - PeCoffLoaderGetImageInfo,
> > - PeCoffLoaderLoadImage,
> > - PeCoffLoaderRelocateImage,
> > - PeCoffLoaderImageReadFromMemory,
> > - PeCoffLoaderRelocateImageForRuntime,
> > - PeCoffLoaderUnloadImage
> > -};
> > -
> > -VOID
> > -EFIAPI
> > -BuildPeCoffLoaderHob (
> > - VOID
> > - )
> > -{
> > - VOID *Ptr;
> > -
> > - Ptr = &gPeCoffProtocol;
> > - BuildGuidDataHob (&gPeCoffLoaderProtocolGuid, &Ptr, sizeof (VOID *));
> > -}
> > -
> > // May want to put this into a library so you only need the PCD settings if you are using the feature?
> > VOID
> > BuildMemoryTypeInformationHob (
> > diff --git a/EmbeddedPkg/Library/PrePiLib/PrePiLib.inf b/EmbeddedPkg/Library/PrePiLib/PrePiLib.inf
> > index 2df5928c51d5..f7f3880f331c 100644
> > --- a/EmbeddedPkg/Library/PrePiLib/PrePiLib.inf
> > +++ b/EmbeddedPkg/Library/PrePiLib/PrePiLib.inf
> > @@ -65,10 +65,6 @@ [LibraryClasses.ARM, LibraryClasses.AARCH64]
> > [Guids]
> > gEfiMemoryTypeInformationGuid
> >
> > -[Protocols]
> > - gPeCoffLoaderProtocolGuid
> > -
> > -
> > [FixedPcd.common]
> > gEmbeddedTokenSpaceGuid.PcdMemoryTypeEfiACPIReclaimMemory
> > gEmbeddedTokenSpaceGuid.PcdMemoryTypeEfiACPIMemoryNVS
> > --
> > 2.39.2
> >
next prev parent reply other threads:[~2023-03-13 17:20 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-13 13:45 [PATCH] EmbeddedPkg/PrePiHobLib: Get rid of PeCoffLoaderProtocol Ard Biesheuvel
2023-03-13 14:50 ` Leif Lindholm
2023-03-13 17:20 ` Ard Biesheuvel [this message]
2023-03-13 19:12 ` Leif Lindholm
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAMj1kXF3y3tGf6_pUTSZroXn08uJqyg16zzL_pMC-Ab1mc2cow@mail.gmail.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox