mirror of https://github.com/acidanthera/audk.git
234 lines
8.5 KiB
C
234 lines
8.5 KiB
C
/** @file
|
|
Data structure and functions to load and unload PeImage.
|
|
|
|
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
|
|
All rights reserved. This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
|
|
#ifndef _IMAGE_H_
|
|
#define _IMAGE_H_
|
|
|
|
|
|
|
|
#define LOADED_IMAGE_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32('l','d','r','i')
|
|
|
|
typedef struct {
|
|
UINTN Signature;
|
|
EFI_HANDLE Handle; // Image handle
|
|
UINTN Type; // Image type
|
|
|
|
BOOLEAN Started; // If entrypoint has been called
|
|
|
|
EFI_IMAGE_ENTRY_POINT EntryPoint; // The image's entry point
|
|
EFI_LOADED_IMAGE_PROTOCOL Info; // loaded image protocol
|
|
|
|
EFI_PHYSICAL_ADDRESS ImageBasePage; // Location in memory
|
|
UINTN NumberOfPages; // Number of pages
|
|
|
|
CHAR8 *FixupData; // Original fixup data
|
|
|
|
EFI_TPL Tpl; // Tpl of started image
|
|
EFI_STATUS Status; // Status returned by started image
|
|
|
|
UINTN ExitDataSize; // Size of ExitData from started image
|
|
VOID *ExitData; // Pointer to exit data from started image
|
|
VOID *JumpBuffer; // Pointer to pool allocation for context save/retore
|
|
BASE_LIBRARY_JUMP_BUFFER *JumpContext; // Pointer to buffer for context save/retore
|
|
UINT16 Machine; // Machine type from PE image
|
|
|
|
EFI_EBC_PROTOCOL *Ebc; // EBC Protocol pointer
|
|
|
|
EFI_RUNTIME_IMAGE_ENTRY *RuntimeData; // Runtime image list
|
|
|
|
EFI_DEVICE_PATH_PROTOCOL *LoadedImageDevicePath; // Pointer to Loaded Image Device Path Protocl
|
|
|
|
PE_COFF_LOADER_IMAGE_CONTEXT ImageContext; // PeCoffLoader ImageContext
|
|
|
|
} LOADED_IMAGE_PRIVATE_DATA;
|
|
|
|
#define LOADED_IMAGE_PRIVATE_DATA_FROM_THIS(a) \
|
|
CR(a, LOADED_IMAGE_PRIVATE_DATA, Info, LOADED_IMAGE_PRIVATE_DATA_SIGNATURE)
|
|
|
|
|
|
|
|
#define LOAD_PE32_IMAGE_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32('l','p','e','i')
|
|
|
|
typedef struct {
|
|
UINTN Signature;
|
|
EFI_HANDLE Handle; // Image handle
|
|
EFI_PE32_IMAGE_PROTOCOL Pe32Image;
|
|
} LOAD_PE32_IMAGE_PRIVATE_DATA;
|
|
|
|
#define LOAD_PE32_IMAGE_PRIVATE_DATA_FROM_THIS(a) \
|
|
CR(a, LOAD_PE32_IMAGE_PRIVATE_DATA, Pe32Image, LOAD_PE32_IMAGE_PRIVATE_DATA_SIGNATURE)
|
|
|
|
|
|
|
|
//
|
|
// Private Data Types
|
|
//
|
|
#define IMAGE_FILE_HANDLE_SIGNATURE EFI_SIGNATURE_32('i','m','g','f')
|
|
typedef struct {
|
|
UINTN Signature;
|
|
BOOLEAN FreeBuffer;
|
|
VOID *Source;
|
|
UINTN SourceSize;
|
|
} IMAGE_FILE_HANDLE;
|
|
|
|
|
|
//
|
|
// Abstractions for reading image contents
|
|
//
|
|
|
|
|
|
/**
|
|
Opens a file for (simple) reading. The simple read abstraction
|
|
will access the file either from a memory copy, from a file
|
|
system interface, or from the load file interface.
|
|
|
|
@param BootPolicy Policy for Open Image File.
|
|
@param SourceBuffer Pointer to the memory location containing copy
|
|
of the image to be loaded.
|
|
@param SourceSize The size in bytes of SourceBuffer.
|
|
@param FilePath The specific file path from which the image is
|
|
loaded
|
|
@param DeviceHandle Pointer to the return device handle.
|
|
@param ImageFileHandle Pointer to the image file handle.
|
|
@param AuthenticationStatus Pointer to a caller-allocated UINT32 in which
|
|
the authentication status is returned.
|
|
|
|
@retval EFI_SUCCESS Image file successfully opened.
|
|
@retval EFI_LOAD_ERROR If the caller passed a copy of the file, and
|
|
SourceSize is 0.
|
|
@retval EFI_INVALID_PARAMETER File path is not valid.
|
|
@retval EFI_NOT_FOUND File not found.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
CoreOpenImageFile (
|
|
IN BOOLEAN BootPolicy,
|
|
IN VOID *SourceBuffer OPTIONAL,
|
|
IN UINTN SourceSize,
|
|
IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,
|
|
OUT EFI_HANDLE *DeviceHandle,
|
|
IN IMAGE_FILE_HANDLE *ImageFileHandle,
|
|
OUT UINT32 *AuthenticationStatus
|
|
);
|
|
|
|
|
|
|
|
/**
|
|
Read image file (specified by UserHandle) into user specified buffer with specified offset
|
|
and length.
|
|
|
|
@param UserHandle Image file handle
|
|
@param Offset Offset to the source file
|
|
@param ReadSize For input, pointer of size to read; For output,
|
|
pointer of size actually read.
|
|
@param Buffer Buffer to write into
|
|
|
|
@retval EFI_SUCCESS Successfully read the specified part of file
|
|
into buffer.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CoreReadImageFile (
|
|
IN VOID *UserHandle,
|
|
IN UINTN Offset,
|
|
IN OUT UINTN *ReadSize,
|
|
OUT VOID *Buffer
|
|
);
|
|
|
|
|
|
/**
|
|
A function out of date, should be removed.
|
|
|
|
@param ImageFileHandle Handle of the file to close
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
CoreCloseImageFile (
|
|
IN IMAGE_FILE_HANDLE *ImageFileHandle
|
|
);
|
|
|
|
|
|
|
|
//
|
|
// Exported Image functions
|
|
//
|
|
|
|
|
|
/**
|
|
Loads an EFI image into memory and returns a handle to the image with extended parameters.
|
|
|
|
@param This Calling context
|
|
@param ParentImageHandle The caller's image handle.
|
|
@param FilePath The specific file path from which the image is
|
|
loaded.
|
|
@param SourceBuffer If not NULL, a pointer to the memory location
|
|
containing a copy of the image to be loaded.
|
|
@param SourceSize The size in bytes of SourceBuffer.
|
|
@param DstBuffer The buffer to store the image.
|
|
@param NumberOfPages For input, specifies the space size of the
|
|
image by caller if not NULL. For output,
|
|
specifies the actual space size needed.
|
|
@param ImageHandle Image handle for output.
|
|
@param EntryPoint Image entry point for output.
|
|
@param Attribute The bit mask of attributes to set for the load
|
|
PE image.
|
|
|
|
@retval EFI_SUCCESS The image was loaded into memory.
|
|
@retval EFI_NOT_FOUND The FilePath was not found.
|
|
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
|
|
@retval EFI_UNSUPPORTED The image type is not supported, or the device
|
|
path cannot be parsed to locate the proper
|
|
protocol for loading the file.
|
|
@retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient
|
|
resources.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CoreLoadImageEx (
|
|
IN EFI_PE32_IMAGE_PROTOCOL *This,
|
|
IN EFI_HANDLE ParentImageHandle,
|
|
IN EFI_DEVICE_PATH_PROTOCOL *FilePath,
|
|
IN VOID *SourceBuffer OPTIONAL,
|
|
IN UINTN SourceSize,
|
|
IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL,
|
|
OUT UINTN *NumberOfPages OPTIONAL,
|
|
OUT EFI_HANDLE *ImageHandle,
|
|
OUT EFI_PHYSICAL_ADDRESS *EntryPoint OPTIONAL,
|
|
IN UINT32 Attribute
|
|
);
|
|
|
|
|
|
/**
|
|
Unload the specified image.
|
|
|
|
@param This Indicates the calling context.
|
|
@param ImageHandle The specified image handle.
|
|
|
|
@retval EFI_INVALID_PARAMETER Image handle is NULL.
|
|
@retval EFI_UNSUPPORTED Attempt to unload an unsupported image.
|
|
@retval EFI_SUCCESS Image successfully unloaded.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CoreUnloadImageEx (
|
|
IN EFI_PE32_IMAGE_PROTOCOL *This,
|
|
IN EFI_HANDLE ImageHandle
|
|
);
|
|
#endif
|