4 Copyright (c) 2006 - 2007, Intel Corporation<BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: PeCoffGetEntryPoint.c
18 // The package level header files this module uses
22 // The protocols, PPI and GUID defintions for this module
25 // The Library classes this module consumes
27 #include <Library/PeCoffGetEntryPointLib.h>
28 #include <Library/DebugLib.h>
30 #include <IndustryStandard/PeImage.h>
33 Retrieves and returns a pointer to the entry point to a PE/COFF image that has been loaded
34 into system memory with the PE/COFF Loader Library functions.
36 Retrieves the entry point to the PE/COFF image specified by Pe32Data and returns this entry
37 point in EntryPoint. If the entry point could not be retrieved from the PE/COFF image, then
38 return RETURN_INVALID_PARAMETER. Otherwise return RETURN_SUCCESS.
39 If Pe32Data is NULL, then ASSERT().
40 If EntryPoint is NULL, then ASSERT().
42 @param Pe32Data Pointer to the PE/COFF image that is loaded in system memory.
43 @param EntryPoint Pointer to entry point to the PE/COFF image to return.
45 @retval RETURN_SUCCESS EntryPoint was returned.
46 @retval RETURN_INVALID_PARAMETER The entry point could not be found in the PE/COFF image.
51 PeCoffLoaderGetEntryPoint (
56 EFI_IMAGE_DOS_HEADER
*DosHeader
;
57 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Header
;
59 ASSERT (Pe32Data
!= NULL
);
60 ASSERT (EntryPoint
!= NULL
);
62 DosHeader
= (EFI_IMAGE_DOS_HEADER
*)Pe32Data
;
63 if (DosHeader
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
65 // DOS image header is present, so read the PE header after the DOS image header.
67 Header
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
) Pe32Data
+ (UINTN
) ((DosHeader
->e_lfanew
) & 0x0ffff));
70 // DOS image header is not present, so PE header is at the image base.
72 Header
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)Pe32Data
;
76 // Calculate the entry point relative to the start of the image.
77 // AddressOfEntryPoint is common for PE32 & PE32+
79 *EntryPoint
= (VOID
*)((UINTN
)Pe32Data
+ (UINTN
)(Header
.Pe32
->OptionalHeader
.AddressOfEntryPoint
& 0x0ffffffff));
80 return RETURN_SUCCESS
;
85 Returns the machine type of a PE/COFF image.
87 Returns the machine type from the PE/COFF image specified by Pe32Data.
88 If Pe32Data is NULL, then ASSERT().
90 @param Pe32Data Pointer to the PE/COFF image that is loaded in system
93 @return Machine type or zero if not a valid iamge.
98 PeCoffLoaderGetMachineType (
102 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
103 EFI_IMAGE_DOS_HEADER
*DosHdr
;
105 DosHdr
= (EFI_IMAGE_DOS_HEADER
*)Pe32Data
;
106 if (DosHdr
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
107 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
)Pe32Data
+ DosHdr
->e_lfanew
);
109 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
)Pe32Data
);
112 if (Hdr
.Pe32
->Signature
== EFI_IMAGE_NT_SIGNATURE
) {
113 return Hdr
.Pe32
->FileHeader
.Machine
;
120 Returns a pointer to the PDB file name for a PE/COFF image that has been
121 loaded into system memory with the PE/COFF Loader Library functions.
123 Returns the PDB file name for the PE/COFF image specified by Pe32Data. If
124 the PE/COFF image specified by Pe32Data is not a valid, then NULL is
125 returned. If the PE/COFF image specified by Pe32Data does not contain a
126 debug directory entry, then NULL is returned. If the debug directory entry
127 in the PE/COFF image specified by Pe32Data does not contain a PDB file name,
128 then NULL is returned.
129 If Pe32Data is NULL, then ASSERT().
131 @param Pe32Data Pointer to the PE/COFF image that is loaded in system
134 @return The PDB file name for the PE/COFF image specified by Pe32Data or NULL
135 if it cannot be retrieved.
140 PeCoffLoaderGetPdbPointer (
144 EFI_IMAGE_DOS_HEADER
*DosHeader
;
145 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
146 EFI_IMAGE_DATA_DIRECTORY
*DirectoryEntry
;
147 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*DebugEntry
;
149 VOID
*CodeViewEntryPointer
;
151 UINT32 NumberOfRvaAndSizes
;
154 ASSERT (Pe32Data
!= NULL
);
157 DirectoryEntry
= NULL
;
159 NumberOfRvaAndSizes
= 0;
161 DosHeader
= (EFI_IMAGE_DOS_HEADER
*)Pe32Data
;
162 if (DosHeader
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
164 // DOS image header is present, so read the PE header after the DOS image header.
166 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
) Pe32Data
+ (UINTN
) ((DosHeader
->e_lfanew
) & 0x0ffff));
169 // DOS image header is not present, so PE header is at the image base.
171 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)Pe32Data
;
174 if (Hdr
.Te
->Signature
== EFI_TE_IMAGE_HEADER_SIGNATURE
) {
175 if (Hdr
.Te
->DataDirectory
[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG
].VirtualAddress
!= 0) {
176 DirectoryEntry
= &Hdr
.Te
->DataDirectory
[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG
];
177 TEImageAdjust
= sizeof (EFI_TE_IMAGE_HEADER
) - Hdr
.Te
->StrippedSize
;
178 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*)((UINTN
) Hdr
.Te
+
179 Hdr
.Te
->DataDirectory
[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG
].VirtualAddress
+
182 } else if (Hdr
.Pe32
->Signature
== EFI_IMAGE_NT_SIGNATURE
) {
184 // NOTE: We use Machine field to identify PE32/PE32+, instead of Magic.
185 // It is due to backward-compatibility, for some system might
186 // generate PE32+ image with PE32 Magic.
188 switch (Hdr
.Pe32
->FileHeader
.Machine
) {
189 case EFI_IMAGE_MACHINE_IA32
:
191 // Assume PE32 image with IA32 Machine field.
193 Magic
= EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
;
195 case EFI_IMAGE_MACHINE_X64
:
196 case EFI_IMAGE_MACHINE_IPF
:
198 // Assume PE32+ image with X64 or IPF Machine field
200 Magic
= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
;
204 // For unknow Machine field, use Magic in optional Header
206 Magic
= Hdr
.Pe32
->OptionalHeader
.Magic
;
209 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
211 // Use PE32 offset get Debug Directory Entry
213 NumberOfRvaAndSizes
= Hdr
.Pe32
->OptionalHeader
.NumberOfRvaAndSizes
;
214 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
215 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*) ((UINTN
) Pe32Data
+ DirectoryEntry
->VirtualAddress
);
216 } else if (Hdr
.Pe32
->OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
) {
218 // Use PE32+ offset get Debug Directory Entry
220 NumberOfRvaAndSizes
= Hdr
.Pe32Plus
->OptionalHeader
.NumberOfRvaAndSizes
;
221 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
222 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*) ((UINTN
) Pe32Data
+ DirectoryEntry
->VirtualAddress
);
225 if (NumberOfRvaAndSizes
<= EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
) {
226 DirectoryEntry
= NULL
;
233 if (DebugEntry
== NULL
|| DirectoryEntry
== NULL
) {
237 for (DirCount
= 0; DirCount
< DirectoryEntry
->Size
; DirCount
++, DebugEntry
++) {
238 if (DebugEntry
->Type
== EFI_IMAGE_DEBUG_TYPE_CODEVIEW
) {
239 if (DebugEntry
->SizeOfData
> 0) {
240 CodeViewEntryPointer
= (VOID
*) ((UINTN
) DebugEntry
->RVA
+ ((UINTN
)Pe32Data
) + (UINTN
)TEImageAdjust
);
241 switch (* (UINT32
*) CodeViewEntryPointer
) {
242 case CODEVIEW_SIGNATURE_NB10
:
243 return (VOID
*) ((CHAR8
*)CodeViewEntryPointer
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY
));
244 case CODEVIEW_SIGNATURE_RSDS
:
245 return (VOID
*) ((CHAR8
*)CodeViewEntryPointer
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY
));