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