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