Data Structures
struct	IMAGE_PROPERTIES_RECORD_CODE_SECTION

struct	IMAGE_PROPERTIES_RECORD

Macros
#define	IMAGE_PROPERTIES_RECORD_CODE_SECTION_SIGNATURE SIGNATURE_32 ('I','P','R','C')

#define	IMAGE_PROPERTIES_RECORD_SIGNATURE SIGNATURE_32 ('I','P','R','D')

Functions
EFI_STATUS EFIAPI	SplitTable (IN OUT UINTN MemoryMapSize, IN OUT EFI_MEMORY_DESCRIPTOR MemoryMap, IN UINTN DescriptorSize, IN LIST_ENTRY *ImageRecordList, IN UINTN NumberOfAdditionalDescriptors)

EFI_STATUS EFIAPI	SortImageRecordCodeSection (IN IMAGE_PROPERTIES_RECORD *ImageRecord)

BOOLEAN EFIAPI	IsImageRecordCodeSectionValid (IN IMAGE_PROPERTIES_RECORD *ImageRecord)

EFI_STATUS EFIAPI	SortImageRecord (IN LIST_ENTRY *ImageRecordList)

EFI_STATUS EFIAPI	SwapImageRecord (IN IMAGE_PROPERTIES_RECORD FirstImageRecord, IN IMAGE_PROPERTIES_RECORD SecondImageRecord)

EFI_STATUS EFIAPI	SwapImageRecordCodeSection (IN IMAGE_PROPERTIES_RECORD_CODE_SECTION FirstImageRecordCodeSection, IN IMAGE_PROPERTIES_RECORD_CODE_SECTION SecondImageRecordCodeSection)

IMAGE_PROPERTIES_RECORD *EFIAPI	FindImageRecord (IN EFI_PHYSICAL_ADDRESS ImageBase, IN UINT64 ImageSize, IN LIST_ENTRY *ImageRecordList)

VOID EFIAPI	DumpImageRecords (IN LIST_ENTRY *ImageRecordList)

EFI_STATUS EFIAPI	CreateImagePropertiesRecord (IN CONST VOID ImageBase, IN CONST UINT64 ImageSize, IN CONST UINT32 Alignment OPTIONAL, OUT IMAGE_PROPERTIES_RECORD *ImageRecord)

VOID EFIAPI	DeleteImagePropertiesRecord (IN IMAGE_PROPERTIES_RECORD *ImageRecord)

Detailed Description

Provides definitions and functionality for manipulating IMAGE_PROPERTIES_RECORD.

Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.
Copyright (c) Microsoft Corporation. SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file ImagePropertiesRecordLib.h.

Macro Definition Documentation

◆ IMAGE_PROPERTIES_RECORD_CODE_SECTION_SIGNATURE

#define IMAGE_PROPERTIES_RECORD_CODE_SECTION_SIGNATURE SIGNATURE_32 ('I','P','R','C')

Definition at line 14 of file ImagePropertiesRecordLib.h.

◆ IMAGE_PROPERTIES_RECORD_SIGNATURE

#define IMAGE_PROPERTIES_RECORD_SIGNATURE SIGNATURE_32 ('I','P','R','D')

Definition at line 23 of file ImagePropertiesRecordLib.h.

Function Documentation

◆ CreateImagePropertiesRecord()

EFI_STATUS EFIAPI CreateImagePropertiesRecord	(	IN CONST VOID *	ImageBase,
		IN CONST UINT64	ImageSize,
		IN CONST UINT32 *Alignment	OPTIONAL,
		OUT IMAGE_PROPERTIES_RECORD *	ImageRecord
	)

Creates an IMAGE_PROPERTIES_RECORD from a loaded PE image. The PE/COFF header will be found and parsed to determine the number of code segments and their base addresses and sizes.

Parameters

[in]	ImageBase	Base of the PE image
[in]	ImageSize	Size of the PE image
[in]	RequiredAlignment	If non-NULL, the alignment specified in the PE/COFF header will be compared against this value.
[out]	ImageRecord	On out, a populated image properties record

Return values

EFI_INVALID_PARAMETER	This function ImageBase or ImageRecord was NULL, or the image located at ImageBase was not a valid PE/COFF image
EFI_OUT_OF_RESOURCES	Failure to Allocate()
EFI_ABORTED	The input Alignment was non-NULL and did not match the alignment specified in the PE/COFF header
EFI_SUCCESS	The image properties record was successfully created

◆ DeleteImagePropertiesRecord()

VOID EFIAPI DeleteImagePropertiesRecord ( IN IMAGE_PROPERTIES_RECORD * ImageRecord )

Deleted an image properties record. The function will also call RemoveEntryList() on each code segment and the input ImageRecord before freeing each pool.

Parameters

[in] ImageRecord The IMAGE_PROPERTIES_RECORD to delete

Definition at line 1179 of file ImagePropertiesRecordLib.c.

◆ DumpImageRecords()

VOID EFIAPI DumpImageRecords ( IN LIST_ENTRY * ImageRecordList )

Debug dumps the input list of IMAGE_PROPERTIES_RECORD structs.

Parameters

[in] ImageRecordList Head of the IMAGE_PROPERTIES_RECORD list

Definition at line 879 of file ImagePropertiesRecordLib.c.

◆ FindImageRecord()

IMAGE_PROPERTIES_RECORD *EFIAPI FindImageRecord	(	IN EFI_PHYSICAL_ADDRESS	ImageBase,
		IN UINT64	ImageSize,
		IN LIST_ENTRY *	ImageRecordList
	)

Find image properties record according to image base and size in the input ImageRecordList.

Parameters

[in]	ImageBase	Base of PE image
[in]	ImageSize	Size of PE image
[in]	ImageRecordList	Image record list to be searched

Return values

NULL	No IMAGE_PROPERTIES_RECORD matches ImageBase and ImageSize in the input ImageRecordList
Other	The found IMAGE_PROPERTIES_RECORD

Find image record according to image base and size.

Parameters

[in]	ImageBase	Base of PE image
[in]	ImageSize	Size of PE image
[in]	ImageRecordList	Image record list to be searched

Return values

NULL	No IMAGE_PROPERTIES_RECORD matches ImageBase and ImageSize in the input ImageRecordList
Other	The found IMAGE_PROPERTIES_RECORD

Definition at line 960 of file ImagePropertiesRecordLib.c.

◆ IsImageRecordCodeSectionValid()

BOOLEAN EFIAPI IsImageRecordCodeSectionValid ( IN IMAGE_PROPERTIES_RECORD * ImageRecord )

Check if the code sections in the input ImageRecord are valid. The code sections are valid if they don't overlap, are contained within the the ImageRecord's ImageBase and ImageSize, and are contained within the MAX_ADDRESS.

Parameters

[in] ImageRecord IMAGE_PROPERTIES_RECORD to be checked

Return values

TRUE	The code sections in the input ImageRecord are valid
FALSE	The code sections in the input ImageRecord are invalid

Definition at line 664 of file ImagePropertiesRecordLib.c.

◆ SortImageRecord()

EFI_STATUS EFIAPI SortImageRecord ( IN LIST_ENTRY * ImageRecordList )

Sort the input ImageRecordList based upon the ImageBase from low to high.

Parameters

[in] ImageRecordList Image record list to be sorted

Return values

EFI_SUCCESS	The image record list was sorted successfully
EFI_ABORTED	An error occurred while sorting the image record list
EFI_INVALID_PARAMETER	ImageRecordList is NULL

Definition at line 770 of file ImagePropertiesRecordLib.c.

◆ SortImageRecordCodeSection()

EFI_STATUS EFIAPI SortImageRecordCodeSection ( IN IMAGE_PROPERTIES_RECORD * ImageRecord )

Sort the code sections in the input ImageRecord based upon CodeSegmentBase from low to high.

Parameters

[in] ImageRecord IMAGE_PROPERTIES_RECORD to be sorted

Return values

EFI_SUCCESS	The code sections in the input ImageRecord were sorted successfully
EFI_ABORTED	An error occurred while sorting the code sections in the input ImageRecord
EFI_INVALID_PARAMETER	ImageRecord is NULL

Definition at line 598 of file ImagePropertiesRecordLib.c.

◆ SplitTable()

EFI_STATUS EFIAPI SplitTable	(	IN OUT UINTN *	MemoryMapSize,
		IN OUT EFI_MEMORY_DESCRIPTOR *	MemoryMap,
		IN UINTN	DescriptorSize,
		IN LIST_ENTRY *	ImageRecordList,
		IN UINTN	NumberOfAdditionalDescriptors
	)

Split the original memory map and add more entries to describe PE code and data sections for each image in the input ImageRecordList.

NOTE: This function assumes PE code/data section are page aligned. NOTE: This function assumes there are enough entries for the new memory map.

| | | | | | | | | 4K PAGE | DATA | CODE | DATA | CODE | DATA | 4K PAGE | | | | | | | | | Assume the above memory region is the result of one split memory map descriptor. It's unlikely that a linker will orient an image this way, but the caller must assume the worst case scenario. This image layout example contains code sections oriented in a way that maximizes the number of descriptors which would be required to describe each section. To ensure we have enough space for every descriptor of the broken up memory map, the caller must assume that every image will have the maximum number of code sections oriented in a way which maximizes the number of data sections with unrelated memory regions flanking each image within a single descriptor.

Given an image record list, the caller should use the following formula when allocating extra descriptors: NumberOfAdditionalDescriptors = (MemoryMapSize / DescriptorSize) + ((2 * <Most Code Segments in a Single Image> + 3) * <Number of Images>)

Parameters

[in,out]	MemoryMapSize	IN: The size, in bytes, of the old memory map before the split. OUT: The size, in bytes, of the used descriptors of the split memory map
[in,out]	MemoryMap	IN: A pointer to the buffer containing the current memory map. This buffer must have enough space to accomodate the "worst case" scenario where every image in ImageRecordList needs a new descriptor to describe its code and data sections. OUT: A pointer to the updated memory map with separated image section descriptors.
[in]	DescriptorSize	The size, in bytes, of an individual EFI_MEMORY_DESCRIPTOR.
[in]	ImageRecordList	A list of IMAGE_PROPERTIES_RECORD entries used when searching for an image record contained by the memory range described in EFI memory map descriptors.
[in]	NumberOfAdditionalDescriptors	The number of unused descriptors at the end of the input MemoryMap. The formula in the description should be used to calculate this value.

Return values

EFI_SUCCESS	The memory map was successfully split.
EFI_INVALID_PARAMETER	MemoryMapSize, MemoryMap, or ImageRecordList was NULL.

Definition at line 481 of file ImagePropertiesRecordLib.c.

◆ SwapImageRecord()

EFI_STATUS EFIAPI SwapImageRecord	(	IN IMAGE_PROPERTIES_RECORD *	FirstImageRecord,
		IN IMAGE_PROPERTIES_RECORD *	SecondImageRecord
	)

Swap two image records.

Parameters

[in]	FirstImageRecord	The first image record.
[in]	SecondImageRecord	The second image record.

Return values

EFI_SUCCESS	The image records were swapped successfully
EFI_INVALID_PARAMETER	FirstImageRecord or SecondImageRecord is NULL

Definition at line 732 of file ImagePropertiesRecordLib.c.

◆ SwapImageRecordCodeSection()

EFI_STATUS EFIAPI SwapImageRecordCodeSection	(	IN IMAGE_PROPERTIES_RECORD_CODE_SECTION *	FirstImageRecordCodeSection,
		IN IMAGE_PROPERTIES_RECORD_CODE_SECTION *	SecondImageRecordCodeSection
	)

Swap two code sections in a single IMAGE_PROPERTIES_RECORD.

Parameters

[in]	FirstImageRecordCodeSection	The first code section
[in]	SecondImageRecordCodeSection	The second code section

Return values

EFI_SUCCESS	The code sections were swapped successfully
EFI_INVALID_PARAMETER	FirstImageRecordCodeSection or SecondImageRecordCodeSection is NULL

Definition at line 564 of file ImagePropertiesRecordLib.c.

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ IMAGE_PROPERTIES_RECORD_CODE_SECTION_SIGNATURE

◆ IMAGE_PROPERTIES_RECORD_SIGNATURE

Function Documentation

◆ CreateImagePropertiesRecord()

◆ DeleteImagePropertiesRecord()

◆ DumpImageRecords()

◆ FindImageRecord()

◆ IsImageRecordCodeSectionValid()

◆ SortImageRecord()

◆ SortImageRecordCodeSection()

◆ SplitTable()

◆ SwapImageRecord()

◆ SwapImageRecordCodeSection()