2 Provides the services to get the entry point to a PE/COFF image that has either been
3 loaded into memory or is executing at it's linked address.
5 Copyright (c) 2006 - 2008, Intel Corporation<BR>
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include <Library/PeCoffGetEntryPointLib.h>
20 #include <Library/DebugLib.h>
22 #include <IndustryStandard/PeImage.h>
25 Retrieves and returns a pointer to the entry point to a PE/COFF image that has been loaded
26 into system memory with the PE/COFF Loader Library functions.
28 Retrieves the entry point to the PE/COFF image specified by Pe32Data and returns this entry
29 point in EntryPoint. If the entry point could not be retrieved from the PE/COFF image, then
30 return RETURN_INVALID_PARAMETER. Otherwise return RETURN_SUCCESS.
31 If Pe32Data is NULL, then ASSERT().
32 If EntryPoint is NULL, then ASSERT().
34 @param Pe32Data Pointer to the PE/COFF image that is loaded in system memory.
35 @param EntryPoint Pointer to entry point to the PE/COFF image to return.
37 @retval RETURN_SUCCESS EntryPoint was returned.
38 @retval RETURN_INVALID_PARAMETER The entry point could not be found in the PE/COFF image.
43 PeCoffLoaderGetEntryPoint (
48 EFI_IMAGE_DOS_HEADER
*DosHdr
;
49 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
51 ASSERT (Pe32Data
!= NULL
);
52 ASSERT (EntryPoint
!= NULL
);
54 DosHdr
= (EFI_IMAGE_DOS_HEADER
*)Pe32Data
;
55 if (DosHdr
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
57 // DOS image header is present, so read the PE header after the DOS image header.
59 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
) Pe32Data
+ (UINTN
) ((DosHdr
->e_lfanew
) & 0x0ffff));
62 // DOS image header is not present, so PE header is at the image base.
64 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)Pe32Data
;
68 // Calculate the entry point relative to the start of the image.
69 // AddressOfEntryPoint is common for PE32 & PE32+
71 if (Hdr
.Te
->Signature
== EFI_TE_IMAGE_HEADER_SIGNATURE
) {
72 *EntryPoint
= (VOID
*)((UINTN
)Pe32Data
+ (UINTN
)(Hdr
.Te
->AddressOfEntryPoint
& 0x0ffffffff) + sizeof(EFI_TE_IMAGE_HEADER
) - Hdr
.Te
->StrippedSize
);
73 return RETURN_SUCCESS
;
74 } else if (Hdr
.Pe32
->Signature
== EFI_IMAGE_NT_SIGNATURE
) {
75 *EntryPoint
= (VOID
*)((UINTN
)Pe32Data
+ (UINTN
)(Hdr
.Pe32
->OptionalHeader
.AddressOfEntryPoint
& 0x0ffffffff));
76 return RETURN_SUCCESS
;
79 return RETURN_UNSUPPORTED
;
84 Returns the machine type of a PE/COFF image.
86 Returns the machine type from the PE/COFF image specified by Pe32Data.
87 If Pe32Data is NULL, then ASSERT().
89 @param Pe32Data Pointer to the PE/COFF image that is loaded in system
92 @return Machine type or zero if not a valid iamge.
97 PeCoffLoaderGetMachineType (
101 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
102 EFI_IMAGE_DOS_HEADER
*DosHdr
;
104 ASSERT (Pe32Data
!= NULL
);
106 DosHdr
= (EFI_IMAGE_DOS_HEADER
*)Pe32Data
;
107 if (DosHdr
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
109 // DOS image header is present, so read the PE header after the DOS image header.
111 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
) Pe32Data
+ (UINTN
) ((DosHdr
->e_lfanew
) & 0x0ffff));
114 // DOS image header is not present, so PE header is at the image base.
116 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)Pe32Data
;
119 if (Hdr
.Te
->Signature
== EFI_TE_IMAGE_HEADER_SIGNATURE
) {
120 return Hdr
.Te
->Machine
;
121 } else if (Hdr
.Pe32
->Signature
== EFI_IMAGE_NT_SIGNATURE
) {
122 return Hdr
.Pe32
->FileHeader
.Machine
;
129 Returns a pointer to the PDB file name for a PE/COFF image that has been
130 loaded into system memory with the PE/COFF Loader Library functions.
132 Returns the PDB file name for the PE/COFF image specified by Pe32Data. If
133 the PE/COFF image specified by Pe32Data is not a valid, then NULL is
134 returned. If the PE/COFF image specified by Pe32Data does not contain a
135 debug directory entry, then NULL is returned. If the debug directory entry
136 in the PE/COFF image specified by Pe32Data does not contain a PDB file name,
137 then NULL is returned.
138 If Pe32Data is NULL, then ASSERT().
140 @param Pe32Data Pointer to the PE/COFF image that is loaded in system
143 @return The PDB file name for the PE/COFF image specified by Pe32Data or NULL
144 if it cannot be retrieved.
149 PeCoffLoaderGetPdbPointer (
153 EFI_IMAGE_DOS_HEADER
*DosHdr
;
154 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
155 EFI_IMAGE_DATA_DIRECTORY
*DirectoryEntry
;
156 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*DebugEntry
;
158 VOID
*CodeViewEntryPointer
;
160 UINT32 NumberOfRvaAndSizes
;
163 ASSERT (Pe32Data
!= NULL
);
166 DirectoryEntry
= NULL
;
168 NumberOfRvaAndSizes
= 0;
170 DosHdr
= (EFI_IMAGE_DOS_HEADER
*)Pe32Data
;
171 if (DosHdr
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
173 // DOS image header is present, so read the PE header after the DOS image header.
175 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
) Pe32Data
+ (UINTN
) ((DosHdr
->e_lfanew
) & 0x0ffff));
178 // DOS image header is not present, so PE header is at the image base.
180 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)Pe32Data
;
183 if (Hdr
.Te
->Signature
== EFI_TE_IMAGE_HEADER_SIGNATURE
) {
184 if (Hdr
.Te
->DataDirectory
[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG
].VirtualAddress
!= 0) {
185 DirectoryEntry
= &Hdr
.Te
->DataDirectory
[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG
];
186 TEImageAdjust
= sizeof (EFI_TE_IMAGE_HEADER
) - Hdr
.Te
->StrippedSize
;
187 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*)((UINTN
) Hdr
.Te
+
188 Hdr
.Te
->DataDirectory
[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG
].VirtualAddress
+
191 } else if (Hdr
.Pe32
->Signature
== EFI_IMAGE_NT_SIGNATURE
) {
193 // NOTE: We use Machine field to identify PE32/PE32+, instead of Magic.
194 // It is due to backward-compatibility, for some system might
195 // generate PE32+ image with PE32 Magic.
197 switch (Hdr
.Pe32
->FileHeader
.Machine
) {
198 case IMAGE_FILE_MACHINE_I386
:
200 // Assume PE32 image with IA32 Machine field.
202 Magic
= EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
;
204 case IMAGE_FILE_MACHINE_X64
:
205 case IMAGE_FILE_MACHINE_IA64
:
207 // Assume PE32+ image with x64 or IA64 Machine field
209 Magic
= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
;
213 // For unknow Machine field, use Magic in optional Header
215 Magic
= Hdr
.Pe32
->OptionalHeader
.Magic
;
218 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
220 // Use PE32 offset get Debug Directory Entry
222 NumberOfRvaAndSizes
= Hdr
.Pe32
->OptionalHeader
.NumberOfRvaAndSizes
;
223 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
224 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*) ((UINTN
) Pe32Data
+ DirectoryEntry
->VirtualAddress
);
225 } else if (Hdr
.Pe32
->OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
) {
227 // Use PE32+ offset get Debug Directory Entry
229 NumberOfRvaAndSizes
= Hdr
.Pe32Plus
->OptionalHeader
.NumberOfRvaAndSizes
;
230 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
231 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*) ((UINTN
) Pe32Data
+ DirectoryEntry
->VirtualAddress
);
234 if (NumberOfRvaAndSizes
<= EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
) {
235 DirectoryEntry
= NULL
;
242 if (DebugEntry
== NULL
|| DirectoryEntry
== NULL
) {
247 // Scan the directory to find the debug entry.
249 for (DirCount
= 0; DirCount
< DirectoryEntry
->Size
; DirCount
+= sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
), DebugEntry
++) {
250 if (DebugEntry
->Type
== EFI_IMAGE_DEBUG_TYPE_CODEVIEW
) {
251 if (DebugEntry
->SizeOfData
> 0) {
252 CodeViewEntryPointer
= (VOID
*) ((UINTN
) DebugEntry
->RVA
+ ((UINTN
)Pe32Data
) + (UINTN
)TEImageAdjust
);
253 switch (* (UINT32
*) CodeViewEntryPointer
) {
254 case CODEVIEW_SIGNATURE_NB10
:
255 return (VOID
*) ((CHAR8
*)CodeViewEntryPointer
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY
));
256 case CODEVIEW_SIGNATURE_RSDS
:
257 return (VOID
*) ((CHAR8
*)CodeViewEntryPointer
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY
));