]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Provides services to load and relocate a PE/COFF image.\r | |
3 | \r | |
4 | The PE/COFF Loader Library abstracts the implementation of a PE/COFF loader for\r | |
5 | IA-32, x86, IPF, and EBC processor types. The library functions are memory-based \r | |
6 | and can be ported easily to any environment.\r | |
7 | \r | |
8 | Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r | |
9 | This program and the accompanying materials are licensed and made available under \r | |
10 | the terms and conditions of the BSD License that accompanies this distribution. \r | |
11 | The full text of the license may be found at\r | |
12 | http://opensource.org/licenses/bsd-license.php. \r | |
13 | \r | |
14 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
15 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
16 | \r | |
17 | **/\r | |
18 | \r | |
19 | #ifndef __BASE_PE_COFF_LIB_H__\r | |
20 | #define __BASE_PE_COFF_LIB_H__\r | |
21 | \r | |
22 | #include <IndustryStandard/PeImage.h>\r | |
23 | //\r | |
24 | // Return status codes from the PE/COFF Loader services\r | |
25 | //\r | |
26 | #define IMAGE_ERROR_SUCCESS 0\r | |
27 | #define IMAGE_ERROR_IMAGE_READ 1 \r | |
28 | #define IMAGE_ERROR_INVALID_PE_HEADER_SIGNATURE 2\r | |
29 | #define IMAGE_ERROR_INVALID_MACHINE_TYPE 3\r | |
30 | #define IMAGE_ERROR_INVALID_SUBSYSTEM 4\r | |
31 | #define IMAGE_ERROR_INVALID_IMAGE_ADDRESS 5\r | |
32 | #define IMAGE_ERROR_INVALID_IMAGE_SIZE 6\r | |
33 | #define IMAGE_ERROR_INVALID_SECTION_ALIGNMENT 7\r | |
34 | #define IMAGE_ERROR_SECTION_NOT_LOADED 8\r | |
35 | #define IMAGE_ERROR_FAILED_RELOCATION 9\r | |
36 | #define IMAGE_ERROR_FAILED_ICACHE_FLUSH 10\r | |
37 | #define IMAGE_ERROR_UNSUPPORTED 11\r | |
38 | \r | |
39 | /**\r | |
40 | Reads contents of a PE/COFF image.\r | |
41 | \r | |
42 | A function of this type reads contents of the PE/COFF image specified by FileHandle. The read \r | |
43 | operation copies ReadSize bytes from the PE/COFF image starting at byte offset FileOffset into \r | |
44 | the buffer specified by Buffer. The size of the buffer actually read is returned in ReadSize. \r | |
45 | If FileOffset specifies an offset past the end of the PE/COFF image, a ReadSize of 0 is returned.\r | |
46 | A function of this type must be registered in the ImageRead field of a PE_COFF_LOADER_IMAGE_CONTEXT \r | |
47 | structure for the PE/COFF Loader Library service to function correctly. This function abstracts access \r | |
48 | to a PE/COFF image so it can be implemented in an environment specific manner. For example, SEC and PEI \r | |
49 | environments may access memory directly to read the contents of a PE/COFF image, and DXE or UEFI \r | |
50 | environments may require protocol services to read the contents of PE/COFF image \r | |
51 | stored on FLASH, disk, or network devices.\r | |
52 | \r | |
53 | If FileHandle is not a valid handle, then ASSERT().\r | |
54 | If ReadSize is NULL, then ASSERT().\r | |
55 | If Buffer is NULL, then ASSERT().\r | |
56 | \r | |
57 | @param FileHandle Pointer to the file handle to read the PE/COFF image.\r | |
58 | @param FileOffset Offset into the PE/COFF image to begin the read operation.\r | |
59 | @param ReadSize On input, the size in bytes of the requested read operation. \r | |
60 | On output, the number of bytes actually read.\r | |
61 | @param Buffer Output buffer that contains the data read from the PE/COFF image.\r | |
62 | \r | |
63 | @retval RETURN_SUCCESS The specified portion of the PE/COFF image was \r | |
64 | read and the size return in ReadSize.\r | |
65 | @retval RETURN_DEVICE_ERROR The specified portion of the PE/COFF image \r | |
66 | could not be read due to a device error.\r | |
67 | \r | |
68 | **/\r | |
69 | typedef\r | |
70 | RETURN_STATUS\r | |
71 | (EFIAPI *PE_COFF_LOADER_READ_FILE)(\r | |
72 | IN VOID *FileHandle,\r | |
73 | IN UINTN FileOffset,\r | |
74 | IN OUT UINTN *ReadSize,\r | |
75 | OUT VOID *Buffer\r | |
76 | );\r | |
77 | \r | |
78 | ///\r | |
79 | /// The context structure used while PE/COFF image is being loaded and relocated.\r | |
80 | ///\r | |
81 | typedef struct {\r | |
82 | ///\r | |
83 | /// Set by PeCoffLoaderGetImageInfo() to the ImageBase in the PE/COFF header.\r | |
84 | ///\r | |
85 | PHYSICAL_ADDRESS ImageAddress;\r | |
86 | ///\r | |
87 | /// Set by PeCoffLoaderGetImageInfo() to the SizeOfImage in the PE/COFF header.\r | |
88 | /// Image size includes the size of Debug Entry if it is present.\r | |
89 | ///\r | |
90 | UINT64 ImageSize;\r | |
91 | ///\r | |
92 | /// Is set to zero by PeCoffLoaderGetImageInfo(). If DestinationAddress is non-zero,\r | |
93 | /// PeCoffLoaderRelocateImage() will relocate the image using this base address.\r | |
94 | /// If the DestinationAddress is zero, the ImageAddress will be used as the base\r | |
95 | /// address of relocation.\r | |
96 | ///\r | |
97 | PHYSICAL_ADDRESS DestinationAddress;\r | |
98 | ///\r | |
99 | /// PeCoffLoaderLoadImage() sets EntryPoint to to the entry point of the PE/COFF image.\r | |
100 | ///\r | |
101 | PHYSICAL_ADDRESS EntryPoint;\r | |
102 | ///\r | |
103 | /// Passed in by the caller to PeCoffLoaderGetImageInfo() and PeCoffLoaderLoadImage()\r | |
104 | /// to abstract accessing the image from the library.\r | |
105 | ///\r | |
106 | PE_COFF_LOADER_READ_FILE ImageRead;\r | |
107 | ///\r | |
108 | /// Used as the FileHandle passed into the ImageRead function when it's called.\r | |
109 | ///\r | |
110 | VOID *Handle;\r | |
111 | ///\r | |
112 | /// Caller allocated buffer of size FixupDataSize that can be optionally allocated\r | |
113 | /// prior to calling PeCoffLoaderRelocateImage(). \r | |
114 | /// This buffer is filled with the information used to fix up the image. \r | |
115 | /// The fixups have been applied to the image and this entry is just for information.\r | |
116 | ///\r | |
117 | VOID *FixupData;\r | |
118 | ///\r | |
119 | /// Set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header.\r | |
120 | /// If the image is a TE image, then this field is set to 0.\r | |
121 | ///\r | |
122 | UINT32 SectionAlignment;\r | |
123 | ///\r | |
124 | /// Set by PeCoffLoaderGetImageInfo() to offset to the PE/COFF header.\r | |
125 | /// If the PE/COFF image does not start with a DOS header, this value is zero. \r | |
126 | /// Otherwise, it's the offset to the PE/COFF header.\r | |
127 | ///\r | |
128 | UINT32 PeCoffHeaderOffset;\r | |
129 | ///\r | |
130 | /// Set by PeCoffLoaderGetImageInfo() to the Relative Virtual Address of the debug directory,\r | |
131 | /// if it exists in the image\r | |
132 | ///\r | |
133 | UINT32 DebugDirectoryEntryRva;\r | |
134 | ///\r | |
135 | /// Set by PeCoffLoaderLoadImage() to CodeView area of the PE/COFF Debug directory.\r | |
136 | ///\r | |
137 | VOID *CodeView;\r | |
138 | ///\r | |
139 | /// Set by PeCoffLoaderLoadImage() to point to the PDB entry contained in the CodeView area.\r | |
140 | /// The PdbPointer points to the filename of the PDB file used for source-level debug of \r | |
141 | /// the image by a debugger.\r | |
142 | ///\r | |
143 | CHAR8 *PdbPointer;\r | |
144 | ///\r | |
145 | /// Is set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header.\r | |
146 | ///\r | |
147 | UINTN SizeOfHeaders;\r | |
148 | ///\r | |
149 | /// Not used by this library class. Other library classes that layer on top of this library\r | |
150 | /// class fill in this value as part of their GetImageInfo call. \r | |
151 | /// This allows the caller of the library to know what type of memory needs to be allocated\r | |
152 | /// to load and relocate the image.\r | |
153 | ///\r | |
154 | UINT32 ImageCodeMemoryType;\r | |
155 | ///\r | |
156 | /// Not used by this library class. Other library classes that layer on top of this library \r | |
157 | /// class fill in this value as part of their GetImageInfo call.\r | |
158 | /// This allows the caller of the library to know what type of memory needs to be allocated\r | |
159 | /// to load and relocate the image.\r | |
160 | ///\r | |
161 | UINT32 ImageDataMemoryType;\r | |
162 | ///\r | |
163 | /// Set by any of the library functions if they encounter an error. \r | |
164 | ///\r | |
165 | UINT32 ImageError;\r | |
166 | ///\r | |
167 | /// Set by PeCoffLoaderLoadImage() to indicate the size of FixupData that the caller must\r | |
168 | /// allocate before calling PeCoffLoaderRelocateImage().\r | |
169 | ///\r | |
170 | UINTN FixupDataSize;\r | |
171 | ///\r | |
172 | /// Set by PeCoffLoaderGetImageInfo() to the machine type stored in the PE/COFF header.\r | |
173 | ///\r | |
174 | UINT16 Machine;\r | |
175 | ///\r | |
176 | /// Set by PeCoffLoaderGetImageInfo() to the subsystem type stored in the PE/COFF header.\r | |
177 | ///\r | |
178 | UINT16 ImageType;\r | |
179 | ///\r | |
180 | /// Set by PeCoffLoaderGetImageInfo() to TRUE if the PE/COFF image does not contain\r | |
181 | /// relocation information.\r | |
182 | ///\r | |
183 | BOOLEAN RelocationsStripped;\r | |
184 | ///\r | |
185 | /// Set by PeCoffLoaderGetImageInfo() to TRUE if the image is a TE image. \r | |
186 | /// For a definition of the TE Image format, see the Platform Initialization Pre-EFI\r | |
187 | /// Initialization Core Interface Specification.\r | |
188 | ///\r | |
189 | BOOLEAN IsTeImage;\r | |
190 | ///\r | |
191 | /// Set by PeCoffLoaderLoadImage() to the HII resource offset\r | |
192 | /// if the image contains a custom PE/COFF resource with the type 'HII'.\r | |
193 | /// Otherwise, the entry remains to be 0.\r | |
194 | ///\r | |
195 | PHYSICAL_ADDRESS HiiResourceData;\r | |
196 | ///\r | |
197 | /// Private storage for implementation specific data. \r | |
198 | ///\r | |
199 | UINT64 Context; \r | |
200 | } PE_COFF_LOADER_IMAGE_CONTEXT;\r | |
201 | \r | |
202 | /**\r | |
203 | Retrieves information about a PE/COFF image.\r | |
204 | \r | |
205 | Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize, \r | |
206 | DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and \r | |
207 | DebugDirectoryEntryRva fields of the ImageContext structure. \r | |
208 | If ImageContext is NULL, then return RETURN_INVALID_PARAMETER. \r | |
209 | If the PE/COFF image accessed through the ImageRead service in the ImageContext \r | |
210 | structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED. \r | |
211 | If any errors occur while computing the fields of ImageContext, \r | |
212 | then the error status is returned in the ImageError field of ImageContext. \r | |
213 | If the image is a TE image, then SectionAlignment is set to 0.\r | |
214 | The ImageRead and Handle fields of ImageContext structure must be valid prior \r | |
215 | to invoking this service.\r | |
216 | \r | |
217 | @param ImageContext The pointer to the image context structure that \r | |
218 | describes the PE/COFF image that needs to be \r | |
219 | examined by this function.\r | |
220 | \r | |
221 | @retval RETURN_SUCCESS The information on the PE/COFF image was collected.\r | |
222 | @retval RETURN_INVALID_PARAMETER ImageContext is NULL.\r | |
223 | @retval RETURN_UNSUPPORTED The PE/COFF image is not supported.\r | |
224 | \r | |
225 | **/\r | |
226 | RETURN_STATUS\r | |
227 | EFIAPI\r | |
228 | PeCoffLoaderGetImageInfo (\r | |
229 | IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r | |
230 | );\r | |
231 | \r | |
232 | /**\r | |
233 | Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().\r | |
234 | \r | |
235 | If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of\r | |
236 | ImageContext as the relocation base address. Otherwise, use the DestinationAddress field\r | |
237 | of ImageContext as the relocation base address. The caller must allocate the relocation\r | |
238 | fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.\r | |
239 | \r | |
240 | The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, \r | |
241 | ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, \r | |
242 | DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of \r | |
243 | the ImageContext structure must be valid prior to invoking this service.\r | |
244 | \r | |
245 | If ImageContext is NULL, then ASSERT().\r | |
246 | \r | |
247 | Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r | |
248 | cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r | |
249 | prior to transferring control to a PE/COFF image that is loaded using this library.\r | |
250 | \r | |
251 | @param ImageContext The pointer to the image context structure that describes the PE/COFF\r | |
252 | image that is being relocated.\r | |
253 | \r | |
254 | @retval RETURN_SUCCESS The PE/COFF image was relocated.\r | |
255 | Extended status information is in the ImageError field of ImageContext.\r | |
256 | @retval RETURN_LOAD_ERROR The image in not a valid PE/COFF image.\r | |
257 | Extended status information is in the ImageError field of ImageContext.\r | |
258 | @retval RETURN_UNSUPPORTED A relocation record type is not supported.\r | |
259 | Extended status information is in the ImageError field of ImageContext.\r | |
260 | \r | |
261 | **/\r | |
262 | RETURN_STATUS\r | |
263 | EFIAPI\r | |
264 | PeCoffLoaderRelocateImage (\r | |
265 | IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r | |
266 | );\r | |
267 | \r | |
268 | /**\r | |
269 | Loads a PE/COFF image into memory.\r | |
270 | \r | |
271 | Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer\r | |
272 | specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate\r | |
273 | the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.\r | |
274 | The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed.\r | |
275 | The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize, \r | |
276 | DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva \r | |
277 | fields of the ImageContext structure must be valid prior to invoking this service.\r | |
278 | \r | |
279 | If ImageContext is NULL, then ASSERT().\r | |
280 | \r | |
281 | Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r | |
282 | cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r | |
283 | prior to transferring control to a PE/COFF image that is loaded using this library.\r | |
284 | \r | |
285 | @param ImageContext The pointer to the image context structure that describes the PE/COFF\r | |
286 | image that is being loaded.\r | |
287 | \r | |
288 | @retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by\r | |
289 | the ImageAddress and ImageSize fields of ImageContext.\r | |
290 | Extended status information is in the ImageError field of ImageContext.\r | |
291 | @retval RETURN_BUFFER_TOO_SMALL The caller did not provide a large enough buffer.\r | |
292 | Extended status information is in the ImageError field of ImageContext.\r | |
293 | @retval RETURN_LOAD_ERROR The PE/COFF image is an EFI Runtime image with no relocations.\r | |
294 | Extended status information is in the ImageError field of ImageContext.\r | |
295 | @retval RETURN_INVALID_PARAMETER The image address is invalid.\r | |
296 | Extended status information is in the ImageError field of ImageContext.\r | |
297 | \r | |
298 | **/\r | |
299 | RETURN_STATUS\r | |
300 | EFIAPI\r | |
301 | PeCoffLoaderLoadImage (\r | |
302 | IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r | |
303 | );\r | |
304 | \r | |
305 | \r | |
306 | /**\r | |
307 | Reads contents of a PE/COFF image from a buffer in system memory.\r | |
308 | \r | |
309 | This is the default implementation of a PE_COFF_LOADER_READ_FILE function \r | |
310 | that assumes FileHandle pointer to the beginning of a PE/COFF image. \r | |
311 | This function reads contents of the PE/COFF image that starts at the system memory \r | |
312 | address specified by FileHandle. The read operation copies ReadSize bytes from the \r | |
313 | PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer. \r | |
314 | The size of the buffer actually read is returned in ReadSize.\r | |
315 | \r | |
316 | If FileHandle is NULL, then ASSERT().\r | |
317 | If ReadSize is NULL, then ASSERT().\r | |
318 | If Buffer is NULL, then ASSERT().\r | |
319 | \r | |
320 | @param FileHandle The pointer to base of the input stream\r | |
321 | @param FileOffset Offset into the PE/COFF image to begin the read operation.\r | |
322 | @param ReadSize On input, the size in bytes of the requested read operation. \r | |
323 | On output, the number of bytes actually read.\r | |
324 | @param Buffer Output buffer that contains the data read from the PE/COFF image.\r | |
325 | \r | |
326 | @retval RETURN_SUCCESS The data is read from FileOffset from the Handle into \r | |
327 | the buffer.\r | |
328 | **/\r | |
329 | RETURN_STATUS\r | |
330 | EFIAPI\r | |
331 | PeCoffLoaderImageReadFromMemory (\r | |
332 | IN VOID *FileHandle,\r | |
333 | IN UINTN FileOffset,\r | |
334 | IN OUT UINTN *ReadSize,\r | |
335 | OUT VOID *Buffer\r | |
336 | );\r | |
337 | \r | |
338 | \r | |
339 | /**\r | |
340 | Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI\r | |
341 | runtime. \r | |
342 | \r | |
343 | This function reapplies relocation fixups to the PE/COFF image specified by ImageBase \r | |
344 | and ImageSize so the image will execute correctly when the PE/COFF image is mapped \r | |
345 | to the address specified by VirtualImageBase. RelocationData must be identical \r | |
346 | to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure \r | |
347 | after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().\r | |
348 | \r | |
349 | Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r | |
350 | cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r | |
351 | prior to transferring control to a PE/COFF image that is loaded using this library.\r | |
352 | \r | |
353 | @param ImageBase The base address of a PE/COFF image that has been loaded \r | |
354 | and relocated into system memory.\r | |
355 | @param VirtImageBase The request virtual address that the PE/COFF image is to\r | |
356 | be fixed up for.\r | |
357 | @param ImageSize The size, in bytes, of the PE/COFF image.\r | |
358 | @param RelocationData A pointer to the relocation data that was collected when the PE/COFF \r | |
359 | image was relocated using PeCoffLoaderRelocateImage().\r | |
360 | \r | |
361 | **/\r | |
362 | VOID\r | |
363 | EFIAPI\r | |
364 | PeCoffLoaderRelocateImageForRuntime (\r | |
365 | IN PHYSICAL_ADDRESS ImageBase,\r | |
366 | IN PHYSICAL_ADDRESS VirtImageBase,\r | |
367 | IN UINTN ImageSize,\r | |
368 | IN VOID *RelocationData\r | |
369 | );\r | |
370 | \r | |
371 | /**\r | |
372 | Unloads a loaded PE/COFF image from memory and releases its taken resource.\r | |
373 | Releases any environment specific resources that were allocated when the image \r | |
374 | specified by ImageContext was loaded using PeCoffLoaderLoadImage(). \r | |
375 | \r | |
376 | For NT32 emulator, the PE/COFF image loaded by system needs to release.\r | |
377 | For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, \r | |
378 | this function can simply return RETURN_SUCCESS.\r | |
379 | \r | |
380 | If ImageContext is NULL, then ASSERT().\r | |
381 | \r | |
382 | @param ImageContext Pointer to the image context structure that describes the PE/COFF\r | |
383 | image to be unloaded.\r | |
384 | \r | |
385 | @retval RETURN_SUCCESS The PE/COFF image was unloaded successfully.\r | |
386 | **/\r | |
387 | RETURN_STATUS\r | |
388 | EFIAPI\r | |
389 | PeCoffLoaderUnloadImage (\r | |
390 | IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r | |
391 | );\r | |
392 | #endif\r |