3 Copyright (c) 2004 - 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
23 #include "EdkIIGlueBase.h"
26 Retrieves and returns a pointer to the entry point to a PE/COFF image that has been loaded
27 into system memory with the PE/COFF Loader Library functions.
29 Retrieves the entry point to the PE/COFF image specified by Pe32Data and returns this entry
30 point in EntryPoint. If the entry point could not be retrieved from the PE/COFF image, then
31 return RETURN_INVALID_PARAMETER. Otherwise return RETURN_SUCCESS.
32 If Pe32Data is NULL, then ASSERT().
33 If EntryPoint is NULL, then ASSERT().
35 @param Pe32Data Pointer to the PE/COFF image that is loaded in system memory.
36 @param EntryPoint Pointer to entry point to the PE/COFF image to return.
38 @retval RETURN_SUCCESS EntryPoint was returned.
39 @retval RETURN_INVALID_PARAMETER The entry point could not be found in the PE/COFF image.
44 PeCoffLoaderGetEntryPoint (
49 EFI_IMAGE_DOS_HEADER
*DosHeader
;
50 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Header
;
52 ASSERT (Pe32Data
!= NULL
);
53 ASSERT (EntryPoint
!= NULL
);
55 DosHeader
= (EFI_IMAGE_DOS_HEADER
*)Pe32Data
;
56 if (DosHeader
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
58 // DOS image header is present, so read the PE header after the DOS image header.
60 Header
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
) Pe32Data
+ (UINTN
) ((DosHeader
->e_lfanew
) & 0x0ffff));
63 // DOS image header is not present, so PE header is at the image base.
65 Header
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)Pe32Data
;
69 // Calculate the entry point relative to the start of the image.
70 // AddressOfEntryPoint is common for PE32 & PE32+
72 *EntryPoint
= (VOID
*)((UINTN
)Pe32Data
+ (UINTN
)(Header
.Pe32
->OptionalHeader
.AddressOfEntryPoint
& 0x0ffffffff));
73 return RETURN_SUCCESS
;
78 Returns the machine type of a PE/COFF image.
80 Returns the machine type from the PE/COFF image specified by Pe32Data.
81 If Pe32Data is NULL, then ASSERT().
83 @param Pe32Data Pointer to the PE/COFF image that is loaded in system
86 @return Machine type or zero if not a valid iamge.
91 PeCoffLoaderGetMachineType (
95 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
96 EFI_IMAGE_DOS_HEADER
*DosHdr
;
98 DosHdr
= (EFI_IMAGE_DOS_HEADER
*)Pe32Data
;
99 if (DosHdr
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
100 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
)Pe32Data
+ DosHdr
->e_lfanew
);
102 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
)Pe32Data
);
105 if (Hdr
.Pe32
->Signature
== EFI_IMAGE_NT_SIGNATURE
) {
106 return Hdr
.Pe32
->FileHeader
.Machine
;
113 Returns a pointer to the PDB file name for a PE/COFF image that has been
114 loaded into system memory with the PE/COFF Loader Library functions.
116 Returns the PDB file name for the PE/COFF image specified by Pe32Data. If
117 the PE/COFF image specified by Pe32Data is not a valid, then NULL is
118 returned. If the PE/COFF image specified by Pe32Data does not contain a
119 debug directory entry, then NULL is returned. If the debug directory entry
120 in the PE/COFF image specified by Pe32Data does not contain a PDB file name,
121 then NULL is returned.
122 If Pe32Data is NULL, then ASSERT().
124 @param Pe32Data Pointer to the PE/COFF image that is loaded in system
127 @return The PDB file name for the PE/COFF image specified by Pe32Data or NULL
128 if it cannot be retrieved.
133 PeCoffLoaderGetPdbPointer (
137 EFI_IMAGE_DOS_HEADER
*DosHeader
;
138 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
139 EFI_IMAGE_DATA_DIRECTORY
*DirectoryEntry
;
140 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*DebugEntry
;
142 VOID
*CodeViewEntryPointer
;
144 UINT32 NumberOfRvaAndSizes
;
146 ASSERT (Pe32Data
!= NULL
);
149 DirectoryEntry
= NULL
;
151 NumberOfRvaAndSizes
= 0;
153 DosHeader
= (EFI_IMAGE_DOS_HEADER
*)Pe32Data
;
154 if (DosHeader
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
156 // DOS image header is present, so read the PE header after the DOS image header.
158 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
) Pe32Data
+ (UINTN
) ((DosHeader
->e_lfanew
) & 0x0ffff));
161 // DOS image header is not present, so PE header is at the image base.
163 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)Pe32Data
;
166 if (Hdr
.Te
->Signature
== EFI_TE_IMAGE_HEADER_SIGNATURE
) {
167 if (Hdr
.Te
->DataDirectory
[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG
].VirtualAddress
!= 0) {
168 DirectoryEntry
= &Hdr
.Te
->DataDirectory
[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG
];
169 TEImageAdjust
= sizeof (EFI_TE_IMAGE_HEADER
) - Hdr
.Te
->StrippedSize
;
170 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*)((UINTN
) Hdr
.Te
+
171 Hdr
.Te
->DataDirectory
[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG
].VirtualAddress
+
174 } else if (Hdr
.Pe32
->Signature
== EFI_IMAGE_NT_SIGNATURE
) {
175 if (Hdr
.Pe32
->OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
177 // Use PE32 offset get Debug Directory Entry
179 NumberOfRvaAndSizes
= Hdr
.Pe32
->OptionalHeader
.NumberOfRvaAndSizes
;
180 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
181 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*) ((UINTN
) Pe32Data
+ DirectoryEntry
->VirtualAddress
);
182 } else if (Hdr
.Pe32
->OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
) {
184 // Use PE32+ offset get Debug Directory Entry
186 NumberOfRvaAndSizes
= Hdr
.Pe32Plus
->OptionalHeader
.NumberOfRvaAndSizes
;
187 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
188 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*) ((UINTN
) Pe32Data
+ DirectoryEntry
->VirtualAddress
);
191 if (NumberOfRvaAndSizes
<= EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
) {
192 DirectoryEntry
= NULL
;
199 if (DebugEntry
== NULL
|| DirectoryEntry
== NULL
) {
203 for (DirCount
= 0; DirCount
< DirectoryEntry
->Size
; DirCount
++, DebugEntry
++) {
204 if (DebugEntry
->Type
== EFI_IMAGE_DEBUG_TYPE_CODEVIEW
) {
205 if (DebugEntry
->SizeOfData
> 0) {
206 CodeViewEntryPointer
= (VOID
*) ((UINTN
) DebugEntry
->RVA
+ ((UINTN
)Pe32Data
) + (UINTN
)TEImageAdjust
);
207 switch (* (UINT32
*) CodeViewEntryPointer
) {
208 case CODEVIEW_SIGNATURE_NB10
:
209 return (VOID
*) ((CHAR8
*)CodeViewEntryPointer
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY
));
210 case CODEVIEW_SIGNATURE_RSDS
:
211 return (VOID
*) ((CHAR8
*)CodeViewEntryPointer
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY
));