2 Core image handling services to load and unload PeImage.
4 Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
5 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.
21 LOADED_IMAGE_PRIVATE_DATA
*mCurrentImage
= NULL
;
23 LOAD_PE32_IMAGE_PRIVATE_DATA mLoadPe32PrivateData
= {
24 LOAD_PE32_IMAGE_PRIVATE_DATA_SIGNATURE
,
34 // This code is needed to build the Image handle for the DXE Core
36 LOADED_IMAGE_PRIVATE_DATA mCorePrivateImage
= {
37 LOADED_IMAGE_PRIVATE_DATA_SIGNATURE
, // Signature
39 EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER
, // Image type
40 TRUE
, // If entrypoint has been called
43 EFI_LOADED_IMAGE_INFORMATION_REVISION
, // Revision
44 NULL
, // Parent handle
45 NULL
, // System handle
47 NULL
, // Device handle
56 EfiBootServicesCode
, // ImageCodeType
57 EfiBootServicesData
// ImageDataType
59 (EFI_PHYSICAL_ADDRESS
)0, // ImageBasePage
63 EFI_SUCCESS
, // Status
71 NULL
// LoadedImageDevicePath
74 // The field is define for Loading modules at fixed address feature to tracker the PEI code
75 // memory range usage. It is a bit mapped array in which every bit indicates the correspoding memory page
78 GLOBAL_REMOVE_IF_UNREFERENCED UINT64
*mDxeCodeMemoryRangeUsageBitMap
=NULL
;
82 CHAR16
*MachineTypeName
;
86 // EBC machine is not listed in this table, because EBC is in the default supported scopes of other machine type.
88 GLOBAL_REMOVE_IF_UNREFERENCED MACHINE_TYPE_INFO mMachineTypeInfo
[] = {
89 {EFI_IMAGE_MACHINE_IA32
, L
"IA32"},
90 {EFI_IMAGE_MACHINE_IA64
, L
"IA64"},
91 {EFI_IMAGE_MACHINE_X64
, L
"X64"},
92 {EFI_IMAGE_MACHINE_ARMTHUMB_MIXED
, L
"ARM"}
95 UINT16 mDxeCoreImageMachineType
= 0;
98 Return machine type name.
100 @param MachineType The machine type
102 @return machine type name
111 for (Index
= 0; Index
< sizeof(mMachineTypeInfo
)/sizeof(mMachineTypeInfo
[0]); Index
++) {
112 if (mMachineTypeInfo
[Index
].MachineType
== MachineType
) {
113 return mMachineTypeInfo
[Index
].MachineTypeName
;
121 Add the Image Services to EFI Boot Services Table and install the protocol
122 interfaces for this image.
124 @param HobStart The HOB to initialize
130 CoreInitializeImageServices (
135 LOADED_IMAGE_PRIVATE_DATA
*Image
;
136 EFI_PHYSICAL_ADDRESS DxeCoreImageBaseAddress
;
137 UINT64 DxeCoreImageLength
;
138 VOID
*DxeCoreEntryPoint
;
139 EFI_PEI_HOB_POINTERS DxeCoreHob
;
142 // Searching for image hob
144 DxeCoreHob
.Raw
= HobStart
;
145 while ((DxeCoreHob
.Raw
= GetNextHob (EFI_HOB_TYPE_MEMORY_ALLOCATION
, DxeCoreHob
.Raw
)) != NULL
) {
146 if (CompareGuid (&DxeCoreHob
.MemoryAllocationModule
->MemoryAllocationHeader
.Name
, &gEfiHobMemoryAllocModuleGuid
)) {
152 DxeCoreHob
.Raw
= GET_NEXT_HOB (DxeCoreHob
);
154 ASSERT (DxeCoreHob
.Raw
!= NULL
);
156 DxeCoreImageBaseAddress
= DxeCoreHob
.MemoryAllocationModule
->MemoryAllocationHeader
.MemoryBaseAddress
;
157 DxeCoreImageLength
= DxeCoreHob
.MemoryAllocationModule
->MemoryAllocationHeader
.MemoryLength
;
158 DxeCoreEntryPoint
= (VOID
*) (UINTN
) DxeCoreHob
.MemoryAllocationModule
->EntryPoint
;
159 gDxeCoreFileName
= &DxeCoreHob
.MemoryAllocationModule
->ModuleName
;
162 // Initialize the fields for an internal driver
164 Image
= &mCorePrivateImage
;
166 Image
->EntryPoint
= (EFI_IMAGE_ENTRY_POINT
)(UINTN
)DxeCoreEntryPoint
;
167 Image
->ImageBasePage
= DxeCoreImageBaseAddress
;
168 Image
->NumberOfPages
= (UINTN
)(EFI_SIZE_TO_PAGES((UINTN
)(DxeCoreImageLength
)));
169 Image
->Tpl
= gEfiCurrentTpl
;
170 Image
->Info
.SystemTable
= gDxeCoreST
;
171 Image
->Info
.ImageBase
= (VOID
*)(UINTN
)DxeCoreImageBaseAddress
;
172 Image
->Info
.ImageSize
= DxeCoreImageLength
;
175 // Install the protocol interfaces for this image
177 Status
= CoreInstallProtocolInterface (
179 &gEfiLoadedImageProtocolGuid
,
180 EFI_NATIVE_INTERFACE
,
183 ASSERT_EFI_ERROR (Status
);
185 mCurrentImage
= Image
;
188 // Fill in DXE globals
190 mDxeCoreImageMachineType
= PeCoffLoaderGetMachineType (Image
->Info
.ImageBase
);
191 gDxeCoreImageHandle
= Image
->Handle
;
192 gDxeCoreLoadedImage
= &Image
->Info
;
194 if (FeaturePcdGet (PcdFrameworkCompatibilitySupport
)) {
196 // Export DXE Core PE Loader functionality for backward compatibility.
198 Status
= CoreInstallProtocolInterface (
199 &mLoadPe32PrivateData
.Handle
,
200 &gEfiLoadPeImageProtocolGuid
,
201 EFI_NATIVE_INTERFACE
,
202 &mLoadPe32PrivateData
.Pe32Image
210 Read image file (specified by UserHandle) into user specified buffer with specified offset
213 @param UserHandle Image file handle
214 @param Offset Offset to the source file
215 @param ReadSize For input, pointer of size to read; For output,
216 pointer of size actually read.
217 @param Buffer Buffer to write into
219 @retval EFI_SUCCESS Successfully read the specified part of file
228 IN OUT UINTN
*ReadSize
,
233 IMAGE_FILE_HANDLE
*FHand
;
235 if (UserHandle
== NULL
|| ReadSize
== NULL
|| Buffer
== NULL
) {
236 return EFI_INVALID_PARAMETER
;
239 if (MAX_ADDRESS
- Offset
< *ReadSize
) {
240 return EFI_INVALID_PARAMETER
;
243 FHand
= (IMAGE_FILE_HANDLE
*)UserHandle
;
244 ASSERT (FHand
->Signature
== IMAGE_FILE_HANDLE_SIGNATURE
);
247 // Move data from our local copy of the file
249 EndPosition
= Offset
+ *ReadSize
;
250 if (EndPosition
> FHand
->SourceSize
) {
251 *ReadSize
= (UINT32
)(FHand
->SourceSize
- Offset
);
253 if (Offset
>= FHand
->SourceSize
) {
257 CopyMem (Buffer
, (CHAR8
*)FHand
->Source
+ Offset
, *ReadSize
);
261 To check memory usage bit map arry to figure out if the memory range the image will be loaded in is available or not. If
262 memory range is avaliable, the function will mark the correponding bits to 1 which indicates the memory range is used.
263 The function is only invoked when load modules at fixed address feature is enabled.
265 @param ImageBase The base addres the image will be loaded at.
266 @param ImageSize The size of the image
268 @retval EFI_SUCCESS The memory range the image will be loaded in is available
269 @retval EFI_NOT_FOUND The memory range the image will be loaded in is not available
272 CheckAndMarkFixLoadingMemoryUsageBitMap (
273 IN EFI_PHYSICAL_ADDRESS ImageBase
,
277 UINT32 DxeCodePageNumber
;
279 EFI_PHYSICAL_ADDRESS DxeCodeBase
;
280 UINTN BaseOffsetPageNumber
;
281 UINTN TopOffsetPageNumber
;
284 // The DXE code range includes RuntimeCodePage range and Boot time code range.
286 DxeCodePageNumber
= PcdGet32(PcdLoadFixAddressRuntimeCodePageNumber
);
287 DxeCodePageNumber
+= PcdGet32(PcdLoadFixAddressBootTimeCodePageNumber
);
288 DxeCodeSize
= EFI_PAGES_TO_SIZE(DxeCodePageNumber
);
289 DxeCodeBase
= gLoadModuleAtFixAddressConfigurationTable
.DxeCodeTopAddress
- DxeCodeSize
;
292 // If the memory usage bit map is not initialized, do it. Every bit in the array
293 // indicate the status of the corresponding memory page, available or not
295 if (mDxeCodeMemoryRangeUsageBitMap
== NULL
) {
296 mDxeCodeMemoryRangeUsageBitMap
= AllocateZeroPool(((DxeCodePageNumber
/64) + 1)*sizeof(UINT64
));
299 // If the Dxe code memory range is not allocated or the bit map array allocation failed, return EFI_NOT_FOUND
301 if (!gLoadFixedAddressCodeMemoryReady
|| mDxeCodeMemoryRangeUsageBitMap
== NULL
) {
302 return EFI_NOT_FOUND
;
305 // Test the memory range for loading the image in the DXE code range.
307 if (gLoadModuleAtFixAddressConfigurationTable
.DxeCodeTopAddress
< ImageBase
+ ImageSize
||
308 DxeCodeBase
> ImageBase
) {
309 return EFI_NOT_FOUND
;
312 // Test if the memory is avalaible or not.
314 BaseOffsetPageNumber
= (UINTN
)EFI_SIZE_TO_PAGES((UINT32
)(ImageBase
- DxeCodeBase
));
315 TopOffsetPageNumber
= (UINTN
)EFI_SIZE_TO_PAGES((UINT32
)(ImageBase
+ ImageSize
- DxeCodeBase
));
316 for (Index
= BaseOffsetPageNumber
; Index
< TopOffsetPageNumber
; Index
++) {
317 if ((mDxeCodeMemoryRangeUsageBitMap
[Index
/ 64] & LShiftU64(1, (Index
% 64))) != 0) {
319 // This page is already used.
321 return EFI_NOT_FOUND
;
326 // Being here means the memory range is available. So mark the bits for the memory range
328 for (Index
= BaseOffsetPageNumber
; Index
< TopOffsetPageNumber
; Index
++) {
329 mDxeCodeMemoryRangeUsageBitMap
[Index
/ 64] |= LShiftU64(1, (Index
% 64));
335 Get the fixed loadding address from image header assigned by build tool. This function only be called
336 when Loading module at Fixed address feature enabled.
338 @param ImageContext Pointer to the image context structure that describes the PE/COFF
339 image that needs to be examined by this function.
340 @retval EFI_SUCCESS An fixed loading address is assigned to this image by build tools .
341 @retval EFI_NOT_FOUND The image has no assigned fixed loadding address.
345 GetPeCoffImageFixLoadingAssignedAddress(
346 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
349 UINTN SectionHeaderOffset
;
351 EFI_IMAGE_SECTION_HEADER SectionHeader
;
352 EFI_IMAGE_OPTIONAL_HEADER_UNION
*ImgHdr
;
355 UINT16 NumberOfSections
;
356 IMAGE_FILE_HANDLE
*Handle
;
357 UINT64 ValueInSectionHeader
;
360 Status
= EFI_NOT_FOUND
;
363 // Get PeHeader pointer
365 Handle
= (IMAGE_FILE_HANDLE
*)ImageContext
->Handle
;
366 ImgHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*)((CHAR8
* )Handle
->Source
+ ImageContext
->PeCoffHeaderOffset
);
367 SectionHeaderOffset
= (UINTN
)(
368 ImageContext
->PeCoffHeaderOffset
+
370 sizeof (EFI_IMAGE_FILE_HEADER
) +
371 ImgHdr
->Pe32
.FileHeader
.SizeOfOptionalHeader
373 NumberOfSections
= ImgHdr
->Pe32
.FileHeader
.NumberOfSections
;
376 // Get base address from the first section header that doesn't point to code section.
378 for (Index
= 0; Index
< NumberOfSections
; Index
++) {
380 // Read section header from file
382 Size
= sizeof (EFI_IMAGE_SECTION_HEADER
);
383 Status
= ImageContext
->ImageRead (
384 ImageContext
->Handle
,
389 if (EFI_ERROR (Status
)) {
392 if (Size
!= sizeof (EFI_IMAGE_SECTION_HEADER
)) {
393 return EFI_NOT_FOUND
;
396 Status
= EFI_NOT_FOUND
;
398 if ((SectionHeader
.Characteristics
& EFI_IMAGE_SCN_CNT_CODE
) == 0) {
400 // Build tool will save the address in PointerToRelocations & PointerToLineNumbers fields in the first section header
401 // that doesn't point to code section in image header, as well as ImageBase field of image header. And there is an
402 // assumption that when the feature is enabled, if a module is assigned a loading address by tools, PointerToRelocations
403 // & PointerToLineNumbers fields should NOT be Zero, or else, these 2 fileds should be set to Zero
405 ValueInSectionHeader
= ReadUnaligned64((UINT64
*)&SectionHeader
.PointerToRelocations
);
406 if (ValueInSectionHeader
!= 0) {
408 // When the feature is configured as load module at fixed absolute address, the ImageAddress field of ImageContext
409 // hold the spcified address. If the feature is configured as load module at fixed offset, ImageAddress hold an offset
410 // relative to top address
412 if ((INT64
)PcdGet64(PcdLoadModuleAtFixAddressEnable
) < 0) {
413 ImageContext
->ImageAddress
= gLoadModuleAtFixAddressConfigurationTable
.DxeCodeTopAddress
+ (INT64
)(INTN
)ImageContext
->ImageAddress
;
416 // Check if the memory range is avaliable.
418 Status
= CheckAndMarkFixLoadingMemoryUsageBitMap (ImageContext
->ImageAddress
, (UINTN
)(ImageContext
->ImageSize
+ ImageContext
->SectionAlignment
));
422 SectionHeaderOffset
+= sizeof (EFI_IMAGE_SECTION_HEADER
);
424 DEBUG ((EFI_D_INFO
|EFI_D_LOAD
, "LOADING MODULE FIXED INFO: Loading module at fixed address 0x%11p. Status = %r \n", (VOID
*)(UINTN
)(ImageContext
->ImageAddress
), Status
));
428 Loads, relocates, and invokes a PE/COFF image
430 @param BootPolicy If TRUE, indicates that the request originates
431 from the boot manager, and that the boot
432 manager is attempting to load FilePath as a
434 @param Pe32Handle The handle of PE32 image
435 @param Image PE image to be loaded
436 @param DstBuffer The buffer to store the image
437 @param EntryPoint A pointer to the entry point
438 @param Attribute The bit mask of attributes to set for the load
441 @retval EFI_SUCCESS The file was loaded, relocated, and invoked
442 @retval EFI_OUT_OF_RESOURCES There was not enough memory to load and
443 relocate the PE/COFF file
444 @retval EFI_INVALID_PARAMETER Invalid parameter
445 @retval EFI_BUFFER_TOO_SMALL Buffer for image is too small
450 IN BOOLEAN BootPolicy
,
452 IN LOADED_IMAGE_PRIVATE_DATA
*Image
,
453 IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL
,
454 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint OPTIONAL
,
459 BOOLEAN DstBufAlocated
;
462 ZeroMem (&Image
->ImageContext
, sizeof (Image
->ImageContext
));
464 Image
->ImageContext
.Handle
= Pe32Handle
;
465 Image
->ImageContext
.ImageRead
= (PE_COFF_LOADER_READ_FILE
)CoreReadImageFile
;
468 // Get information about the image being loaded
470 Status
= PeCoffLoaderGetImageInfo (&Image
->ImageContext
);
471 if (EFI_ERROR (Status
)) {
475 if (!EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Image
->ImageContext
.Machine
)) {
476 if (!EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED (Image
->ImageContext
.Machine
)) {
478 // The PE/COFF loader can support loading image types that can be executed.
479 // If we loaded an image type that we can not execute return EFI_UNSUPORTED.
481 DEBUG ((EFI_D_ERROR
, "Image type %s can't be loaded ", GetMachineTypeName(Image
->ImageContext
.Machine
)));
482 DEBUG ((EFI_D_ERROR
, "on %s UEFI system.\n", GetMachineTypeName(mDxeCoreImageMachineType
)));
483 return EFI_UNSUPPORTED
;
488 // Set EFI memory type based on ImageType
490 switch (Image
->ImageContext
.ImageType
) {
491 case EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
:
492 Image
->ImageContext
.ImageCodeMemoryType
= EfiLoaderCode
;
493 Image
->ImageContext
.ImageDataMemoryType
= EfiLoaderData
;
495 case EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER
:
496 Image
->ImageContext
.ImageCodeMemoryType
= EfiBootServicesCode
;
497 Image
->ImageContext
.ImageDataMemoryType
= EfiBootServicesData
;
499 case EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
:
500 case EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER
:
501 Image
->ImageContext
.ImageCodeMemoryType
= EfiRuntimeServicesCode
;
502 Image
->ImageContext
.ImageDataMemoryType
= EfiRuntimeServicesData
;
505 Image
->ImageContext
.ImageError
= IMAGE_ERROR_INVALID_SUBSYSTEM
;
506 return EFI_UNSUPPORTED
;
510 // Allocate memory of the correct memory type aligned on the required image boundry
512 DstBufAlocated
= FALSE
;
513 if (DstBuffer
== 0) {
515 // Allocate Destination Buffer as caller did not pass it in
518 if (Image
->ImageContext
.SectionAlignment
> EFI_PAGE_SIZE
) {
519 Size
= (UINTN
)Image
->ImageContext
.ImageSize
+ Image
->ImageContext
.SectionAlignment
;
521 Size
= (UINTN
)Image
->ImageContext
.ImageSize
;
524 Image
->NumberOfPages
= EFI_SIZE_TO_PAGES (Size
);
527 // If the image relocations have not been stripped, then load at any address.
528 // Otherwise load at the address at which it was linked.
530 // Memory below 1MB should be treated reserved for CSM and there should be
531 // no modules whose preferred load addresses are below 1MB.
533 Status
= EFI_OUT_OF_RESOURCES
;
535 // If Loading Module At Fixed Address feature is enabled, the module should be loaded to
536 // a specified address.
538 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0 ) {
539 Status
= GetPeCoffImageFixLoadingAssignedAddress (&(Image
->ImageContext
));
541 if (EFI_ERROR (Status
)) {
543 // If the code memory is not ready, invoke CoreAllocatePage with AllocateAnyPages to load the driver.
545 DEBUG ((EFI_D_INFO
|EFI_D_LOAD
, "LOADING MODULE FIXED ERROR: Loading module at fixed address failed since specified memory is not available.\n"));
547 Status
= CoreAllocatePages (
549 (EFI_MEMORY_TYPE
) (Image
->ImageContext
.ImageCodeMemoryType
),
550 Image
->NumberOfPages
,
551 &Image
->ImageContext
.ImageAddress
555 if (Image
->ImageContext
.ImageAddress
>= 0x100000 || Image
->ImageContext
.RelocationsStripped
) {
556 Status
= CoreAllocatePages (
558 (EFI_MEMORY_TYPE
) (Image
->ImageContext
.ImageCodeMemoryType
),
559 Image
->NumberOfPages
,
560 &Image
->ImageContext
.ImageAddress
563 if (EFI_ERROR (Status
) && !Image
->ImageContext
.RelocationsStripped
) {
564 Status
= CoreAllocatePages (
566 (EFI_MEMORY_TYPE
) (Image
->ImageContext
.ImageCodeMemoryType
),
567 Image
->NumberOfPages
,
568 &Image
->ImageContext
.ImageAddress
572 if (EFI_ERROR (Status
)) {
575 DstBufAlocated
= TRUE
;
578 // Caller provided the destination buffer
581 if (Image
->ImageContext
.RelocationsStripped
&& (Image
->ImageContext
.ImageAddress
!= DstBuffer
)) {
583 // If the image relocations were stripped, and the caller provided a
584 // destination buffer address that does not match the address that the
585 // image is linked at, then the image cannot be loaded.
587 return EFI_INVALID_PARAMETER
;
590 if (Image
->NumberOfPages
!= 0 &&
591 Image
->NumberOfPages
<
592 (EFI_SIZE_TO_PAGES ((UINTN
)Image
->ImageContext
.ImageSize
+ Image
->ImageContext
.SectionAlignment
))) {
593 Image
->NumberOfPages
= EFI_SIZE_TO_PAGES ((UINTN
)Image
->ImageContext
.ImageSize
+ Image
->ImageContext
.SectionAlignment
);
594 return EFI_BUFFER_TOO_SMALL
;
597 Image
->NumberOfPages
= EFI_SIZE_TO_PAGES ((UINTN
)Image
->ImageContext
.ImageSize
+ Image
->ImageContext
.SectionAlignment
);
598 Image
->ImageContext
.ImageAddress
= DstBuffer
;
601 Image
->ImageBasePage
= Image
->ImageContext
.ImageAddress
;
602 if (!Image
->ImageContext
.IsTeImage
) {
603 Image
->ImageContext
.ImageAddress
=
604 (Image
->ImageContext
.ImageAddress
+ Image
->ImageContext
.SectionAlignment
- 1) &
605 ~((UINTN
)Image
->ImageContext
.SectionAlignment
- 1);
609 // Load the image from the file into the allocated memory
611 Status
= PeCoffLoaderLoadImage (&Image
->ImageContext
);
612 if (EFI_ERROR (Status
)) {
617 // If this is a Runtime Driver, then allocate memory for the FixupData that
618 // is used to relocate the image when SetVirtualAddressMap() is called. The
619 // relocation is done by the Runtime AP.
621 if ((Attribute
& EFI_LOAD_PE_IMAGE_ATTRIBUTE_RUNTIME_REGISTRATION
) != 0) {
622 if (Image
->ImageContext
.ImageType
== EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
) {
623 Image
->ImageContext
.FixupData
= AllocateRuntimePool ((UINTN
)(Image
->ImageContext
.FixupDataSize
));
624 if (Image
->ImageContext
.FixupData
== NULL
) {
625 Status
= EFI_OUT_OF_RESOURCES
;
632 // Relocate the image in memory
634 Status
= PeCoffLoaderRelocateImage (&Image
->ImageContext
);
635 if (EFI_ERROR (Status
)) {
640 // Flush the Instruction Cache
642 InvalidateInstructionCacheRange ((VOID
*)(UINTN
)Image
->ImageContext
.ImageAddress
, (UINTN
)Image
->ImageContext
.ImageSize
);
645 // Copy the machine type from the context to the image private data. This
646 // is needed during image unload to know if we should call an EBC protocol
647 // to unload the image.
649 Image
->Machine
= Image
->ImageContext
.Machine
;
652 // Get the image entry point. If it's an EBC image, then call into the
653 // interpreter to create a thunk for the entry point and use the returned
654 // value for the entry point.
656 Image
->EntryPoint
= (EFI_IMAGE_ENTRY_POINT
)(UINTN
)Image
->ImageContext
.EntryPoint
;
657 if (Image
->ImageContext
.Machine
== EFI_IMAGE_MACHINE_EBC
) {
659 // Locate the EBC interpreter protocol
661 Status
= CoreLocateProtocol (&gEfiEbcProtocolGuid
, NULL
, (VOID
**)&Image
->Ebc
);
662 if (EFI_ERROR(Status
) || Image
->Ebc
== NULL
) {
663 DEBUG ((DEBUG_LOAD
| DEBUG_ERROR
, "CoreLoadPeImage: There is no EBC interpreter for an EBC image.\n"));
668 // Register a callback for flushing the instruction cache so that created
669 // thunks can be flushed.
671 Status
= Image
->Ebc
->RegisterICacheFlush (Image
->Ebc
, (EBC_ICACHE_FLUSH
)InvalidateInstructionCacheRange
);
672 if (EFI_ERROR(Status
)) {
677 // Create a thunk for the image's entry point. This will be the new
678 // entry point for the image.
680 Status
= Image
->Ebc
->CreateThunk (
683 (VOID
*)(UINTN
) Image
->ImageContext
.EntryPoint
,
684 (VOID
**) &Image
->EntryPoint
686 if (EFI_ERROR(Status
)) {
692 // Fill in the image information for the Loaded Image Protocol
694 Image
->Type
= Image
->ImageContext
.ImageType
;
695 Image
->Info
.ImageBase
= (VOID
*)(UINTN
)Image
->ImageContext
.ImageAddress
;
696 Image
->Info
.ImageSize
= Image
->ImageContext
.ImageSize
;
697 Image
->Info
.ImageCodeType
= (EFI_MEMORY_TYPE
) (Image
->ImageContext
.ImageCodeMemoryType
);
698 Image
->Info
.ImageDataType
= (EFI_MEMORY_TYPE
) (Image
->ImageContext
.ImageDataMemoryType
);
699 if ((Attribute
& EFI_LOAD_PE_IMAGE_ATTRIBUTE_RUNTIME_REGISTRATION
) != 0) {
700 if (Image
->ImageContext
.ImageType
== EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
) {
702 // Make a list off all the RT images so we can let the RT AP know about them.
704 Image
->RuntimeData
= AllocateRuntimePool (sizeof(EFI_RUNTIME_IMAGE_ENTRY
));
705 if (Image
->RuntimeData
== NULL
) {
708 Image
->RuntimeData
->ImageBase
= Image
->Info
.ImageBase
;
709 Image
->RuntimeData
->ImageSize
= (UINT64
) (Image
->Info
.ImageSize
);
710 Image
->RuntimeData
->RelocationData
= Image
->ImageContext
.FixupData
;
711 Image
->RuntimeData
->Handle
= Image
->Handle
;
712 InsertTailList (&gRuntime
->ImageHead
, &Image
->RuntimeData
->Link
);
713 InsertImageRecord (Image
->RuntimeData
);
718 // Fill in the entry point of the image if it is available
720 if (EntryPoint
!= NULL
) {
721 *EntryPoint
= Image
->ImageContext
.EntryPoint
;
725 // Print the load address and the PDB file name if it is available
732 CHAR8 EfiFileName
[256];
735 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
,
736 "Loading driver at 0x%11p EntryPoint=0x%11p ",
737 (VOID
*)(UINTN
) Image
->ImageContext
.ImageAddress
,
738 FUNCTION_ENTRY_POINT (Image
->ImageContext
.EntryPoint
)));
742 // Print Module Name by Pdb file path.
743 // Windows and Unix style file path are all trimmed correctly.
745 if (Image
->ImageContext
.PdbPointer
!= NULL
) {
747 for (Index
= 0; Image
->ImageContext
.PdbPointer
[Index
] != 0; Index
++) {
748 if ((Image
->ImageContext
.PdbPointer
[Index
] == '\\') || (Image
->ImageContext
.PdbPointer
[Index
] == '/')) {
749 StartIndex
= Index
+ 1;
753 // Copy the PDB file name to our temporary string, and replace .pdb with .efi
754 // The PDB file name is limited in the range of 0~255.
755 // If the length is bigger than 255, trim the redudant characters to avoid overflow in array boundary.
757 for (Index
= 0; Index
< sizeof (EfiFileName
) - 4; Index
++) {
758 EfiFileName
[Index
] = Image
->ImageContext
.PdbPointer
[Index
+ StartIndex
];
759 if (EfiFileName
[Index
] == 0) {
760 EfiFileName
[Index
] = '.';
762 if (EfiFileName
[Index
] == '.') {
763 EfiFileName
[Index
+ 1] = 'e';
764 EfiFileName
[Index
+ 2] = 'f';
765 EfiFileName
[Index
+ 3] = 'i';
766 EfiFileName
[Index
+ 4] = 0;
771 if (Index
== sizeof (EfiFileName
) - 4) {
772 EfiFileName
[Index
] = 0;
774 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "%a", EfiFileName
)); // &Image->ImageContext.PdbPointer[StartIndex]));
776 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "\n"));
788 if (DstBufAlocated
) {
789 CoreFreePages (Image
->ImageContext
.ImageAddress
, Image
->NumberOfPages
);
792 if (Image
->ImageContext
.FixupData
!= NULL
) {
793 CoreFreePool (Image
->ImageContext
.FixupData
);
802 Get the image's private data from its handle.
804 @param ImageHandle The image handle
806 @return Return the image private data associated with ImageHandle.
809 LOADED_IMAGE_PRIVATE_DATA
*
810 CoreLoadedImageInfo (
811 IN EFI_HANDLE ImageHandle
815 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
816 LOADED_IMAGE_PRIVATE_DATA
*Image
;
818 Status
= CoreHandleProtocol (
820 &gEfiLoadedImageProtocolGuid
,
821 (VOID
**)&LoadedImage
823 if (!EFI_ERROR (Status
)) {
824 Image
= LOADED_IMAGE_PRIVATE_DATA_FROM_THIS (LoadedImage
);
826 DEBUG ((DEBUG_LOAD
, "CoreLoadedImageInfo: Not an ImageHandle %p\n", ImageHandle
));
835 Unloads EFI image from memory.
837 @param Image EFI image
838 @param FreePage Free allocated pages
842 CoreUnloadAndCloseImage (
843 IN LOADED_IMAGE_PRIVATE_DATA
*Image
,
849 EFI_HANDLE
*HandleBuffer
;
851 EFI_GUID
**ProtocolGuidArray
;
854 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
*OpenInfo
;
859 ProtocolGuidArray
= NULL
;
861 if (Image
->Started
) {
862 UnregisterMemoryProfileImage (Image
);
865 if (Image
->Ebc
!= NULL
) {
867 // If EBC protocol exists we must perform cleanups for this image.
869 Image
->Ebc
->UnloadImage (Image
->Ebc
, Image
->Handle
);
873 // Unload image, free Image->ImageContext->ModHandle
875 PeCoffLoaderUnloadImage (&Image
->ImageContext
);
878 // Free our references to the image handle
880 if (Image
->Handle
!= NULL
) {
882 Status
= CoreLocateHandleBuffer (
889 if (!EFI_ERROR (Status
)) {
890 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
891 Status
= CoreProtocolsPerHandle (
892 HandleBuffer
[HandleIndex
],
896 if (!EFI_ERROR (Status
)) {
897 for (ProtocolIndex
= 0; ProtocolIndex
< ArrayCount
; ProtocolIndex
++) {
898 Status
= CoreOpenProtocolInformation (
899 HandleBuffer
[HandleIndex
],
900 ProtocolGuidArray
[ProtocolIndex
],
904 if (!EFI_ERROR (Status
)) {
905 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
906 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== Image
->Handle
) {
907 Status
= CoreCloseProtocol (
908 HandleBuffer
[HandleIndex
],
909 ProtocolGuidArray
[ProtocolIndex
],
911 OpenInfo
[OpenInfoIndex
].ControllerHandle
915 if (OpenInfo
!= NULL
) {
916 CoreFreePool(OpenInfo
);
920 if (ProtocolGuidArray
!= NULL
) {
921 CoreFreePool(ProtocolGuidArray
);
925 if (HandleBuffer
!= NULL
) {
926 CoreFreePool (HandleBuffer
);
930 CoreRemoveDebugImageInfoEntry (Image
->Handle
);
932 Status
= CoreUninstallProtocolInterface (
934 &gEfiLoadedImageDevicePathProtocolGuid
,
935 Image
->LoadedImageDevicePath
938 Status
= CoreUninstallProtocolInterface (
940 &gEfiLoadedImageProtocolGuid
,
944 if (Image
->ImageContext
.HiiResourceData
!= 0) {
945 Status
= CoreUninstallProtocolInterface (
947 &gEfiHiiPackageListProtocolGuid
,
948 (VOID
*) (UINTN
) Image
->ImageContext
.HiiResourceData
954 if (Image
->RuntimeData
!= NULL
) {
955 if (Image
->RuntimeData
->Link
.ForwardLink
!= NULL
) {
957 // Remove the Image from the Runtime Image list as we are about to Free it!
959 RemoveEntryList (&Image
->RuntimeData
->Link
);
960 RemoveImageRecord (Image
->RuntimeData
);
962 CoreFreePool (Image
->RuntimeData
);
966 // Free the Image from memory
968 if ((Image
->ImageBasePage
!= 0) && FreePage
) {
969 CoreFreePages (Image
->ImageBasePage
, Image
->NumberOfPages
);
973 // Done with the Image structure
975 if (Image
->Info
.FilePath
!= NULL
) {
976 CoreFreePool (Image
->Info
.FilePath
);
979 if (Image
->LoadedImageDevicePath
!= NULL
) {
980 CoreFreePool (Image
->LoadedImageDevicePath
);
983 if (Image
->FixupData
!= NULL
) {
984 CoreFreePool (Image
->FixupData
);
987 CoreFreePool (Image
);
992 Loads an EFI image into memory and returns a handle to the image.
994 @param BootPolicy If TRUE, indicates that the request originates
995 from the boot manager, and that the boot
996 manager is attempting to load FilePath as a
998 @param ParentImageHandle The caller's image handle.
999 @param FilePath The specific file path from which the image is
1001 @param SourceBuffer If not NULL, a pointer to the memory location
1002 containing a copy of the image to be loaded.
1003 @param SourceSize The size in bytes of SourceBuffer.
1004 @param DstBuffer The buffer to store the image
1005 @param NumberOfPages If not NULL, it inputs a pointer to the page
1006 number of DstBuffer and outputs a pointer to
1007 the page number of the image. If this number is
1008 not enough, return EFI_BUFFER_TOO_SMALL and
1009 this parameter contains the required number.
1010 @param ImageHandle Pointer to the returned image handle that is
1011 created when the image is successfully loaded.
1012 @param EntryPoint A pointer to the entry point
1013 @param Attribute The bit mask of attributes to set for the load
1016 @retval EFI_SUCCESS The image was loaded into memory.
1017 @retval EFI_NOT_FOUND The FilePath was not found.
1018 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1019 @retval EFI_BUFFER_TOO_SMALL The buffer is too small
1020 @retval EFI_UNSUPPORTED The image type is not supported, or the device
1021 path cannot be parsed to locate the proper
1022 protocol for loading the file.
1023 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient
1025 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
1027 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
1028 @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the
1029 image from being loaded. NULL is returned in *ImageHandle.
1030 @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
1031 valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
1032 platform policy specifies that the image should not be started.
1036 CoreLoadImageCommon (
1037 IN BOOLEAN BootPolicy
,
1038 IN EFI_HANDLE ParentImageHandle
,
1039 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
1040 IN VOID
*SourceBuffer OPTIONAL
,
1041 IN UINTN SourceSize
,
1042 IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL
,
1043 IN OUT UINTN
*NumberOfPages OPTIONAL
,
1044 OUT EFI_HANDLE
*ImageHandle
,
1045 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint OPTIONAL
,
1049 LOADED_IMAGE_PRIVATE_DATA
*Image
;
1050 LOADED_IMAGE_PRIVATE_DATA
*ParentImage
;
1051 IMAGE_FILE_HANDLE FHand
;
1053 EFI_STATUS SecurityStatus
;
1054 EFI_HANDLE DeviceHandle
;
1055 UINT32 AuthenticationStatus
;
1056 EFI_DEVICE_PATH_PROTOCOL
*OriginalFilePath
;
1057 EFI_DEVICE_PATH_PROTOCOL
*HandleFilePath
;
1058 EFI_DEVICE_PATH_PROTOCOL
*InputFilePath
;
1059 EFI_DEVICE_PATH_PROTOCOL
*Node
;
1061 BOOLEAN ImageIsFromFv
;
1062 BOOLEAN ImageIsFromLoadFile
;
1064 SecurityStatus
= EFI_SUCCESS
;
1066 ASSERT (gEfiCurrentTpl
< TPL_NOTIFY
);
1070 // The caller must pass in a valid ParentImageHandle
1072 if (ImageHandle
== NULL
|| ParentImageHandle
== NULL
) {
1073 return EFI_INVALID_PARAMETER
;
1076 ParentImage
= CoreLoadedImageInfo (ParentImageHandle
);
1077 if (ParentImage
== NULL
) {
1078 DEBUG((DEBUG_LOAD
|DEBUG_ERROR
, "LoadImageEx: Parent handle not an image handle\n"));
1079 return EFI_INVALID_PARAMETER
;
1082 ZeroMem (&FHand
, sizeof (IMAGE_FILE_HANDLE
));
1083 FHand
.Signature
= IMAGE_FILE_HANDLE_SIGNATURE
;
1084 OriginalFilePath
= FilePath
;
1085 InputFilePath
= FilePath
;
1086 HandleFilePath
= FilePath
;
1087 DeviceHandle
= NULL
;
1088 Status
= EFI_SUCCESS
;
1089 AuthenticationStatus
= 0;
1090 ImageIsFromFv
= FALSE
;
1091 ImageIsFromLoadFile
= FALSE
;
1094 // If the caller passed a copy of the file, then just use it
1096 if (SourceBuffer
!= NULL
) {
1097 FHand
.Source
= SourceBuffer
;
1098 FHand
.SourceSize
= SourceSize
;
1099 Status
= CoreLocateDevicePath (&gEfiDevicePathProtocolGuid
, &HandleFilePath
, &DeviceHandle
);
1100 if (EFI_ERROR (Status
)) {
1101 DeviceHandle
= NULL
;
1103 if (SourceSize
> 0) {
1104 Status
= EFI_SUCCESS
;
1106 Status
= EFI_LOAD_ERROR
;
1109 if (FilePath
== NULL
) {
1110 return EFI_INVALID_PARAMETER
;
1114 // Try to get the image device handle by checking the match protocol.
1117 Status
= CoreLocateDevicePath (&gEfiFirmwareVolume2ProtocolGuid
, &HandleFilePath
, &DeviceHandle
);
1118 if (!EFI_ERROR (Status
)) {
1119 ImageIsFromFv
= TRUE
;
1121 HandleFilePath
= FilePath
;
1122 Status
= CoreLocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &HandleFilePath
, &DeviceHandle
);
1123 if (EFI_ERROR (Status
)) {
1125 HandleFilePath
= FilePath
;
1126 Status
= CoreLocateDevicePath (&gEfiLoadFile2ProtocolGuid
, &HandleFilePath
, &DeviceHandle
);
1128 if (EFI_ERROR (Status
)) {
1129 HandleFilePath
= FilePath
;
1130 Status
= CoreLocateDevicePath (&gEfiLoadFileProtocolGuid
, &HandleFilePath
, &DeviceHandle
);
1131 if (!EFI_ERROR (Status
)) {
1132 ImageIsFromLoadFile
= TRUE
;
1133 Node
= HandleFilePath
;
1140 // Get the source file buffer by its device path.
1142 FHand
.Source
= GetFileBufferByFilePath (
1146 &AuthenticationStatus
1148 if (FHand
.Source
== NULL
) {
1149 Status
= EFI_NOT_FOUND
;
1151 FHand
.FreeBuffer
= TRUE
;
1152 if (ImageIsFromLoadFile
) {
1154 // LoadFile () may cause the device path of the Handle be updated.
1156 OriginalFilePath
= AppendDevicePath (DevicePathFromHandle (DeviceHandle
), Node
);
1161 if (EFI_ERROR (Status
)) {
1166 if (gSecurity2
!= NULL
) {
1168 // Verify File Authentication through the Security2 Architectural Protocol
1170 SecurityStatus
= gSecurity2
->FileAuthentication (
1177 if (!EFI_ERROR (SecurityStatus
) && ImageIsFromFv
) {
1179 // When Security2 is installed, Security Architectural Protocol must be published.
1181 ASSERT (gSecurity
!= NULL
);
1184 // Verify the Authentication Status through the Security Architectural Protocol
1185 // Only on images that have been read using Firmware Volume protocol.
1187 SecurityStatus
= gSecurity
->FileAuthenticationState (
1189 AuthenticationStatus
,
1193 } else if ((gSecurity
!= NULL
) && (OriginalFilePath
!= NULL
)) {
1195 // Verify the Authentication Status through the Security Architectural Protocol
1197 SecurityStatus
= gSecurity
->FileAuthenticationState (
1199 AuthenticationStatus
,
1205 // Check Security Status.
1207 if (EFI_ERROR (SecurityStatus
) && SecurityStatus
!= EFI_SECURITY_VIOLATION
) {
1208 if (SecurityStatus
== EFI_ACCESS_DENIED
) {
1210 // Image was not loaded because the platform policy prohibits the image from being loaded.
1211 // It's the only place we could meet EFI_ACCESS_DENIED.
1213 *ImageHandle
= NULL
;
1215 Status
= SecurityStatus
;
1221 // Allocate a new image structure
1223 Image
= AllocateZeroPool (sizeof(LOADED_IMAGE_PRIVATE_DATA
));
1224 if (Image
== NULL
) {
1225 Status
= EFI_OUT_OF_RESOURCES
;
1230 // Pull out just the file portion of the DevicePath for the LoadedImage FilePath
1232 FilePath
= OriginalFilePath
;
1233 if (DeviceHandle
!= NULL
) {
1234 Status
= CoreHandleProtocol (DeviceHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&HandleFilePath
);
1235 if (!EFI_ERROR (Status
)) {
1236 FilePathSize
= GetDevicePathSize (HandleFilePath
) - sizeof(EFI_DEVICE_PATH_PROTOCOL
);
1237 FilePath
= (EFI_DEVICE_PATH_PROTOCOL
*) (((UINT8
*)FilePath
) + FilePathSize
);
1241 // Initialize the fields for an internal driver
1243 Image
->Signature
= LOADED_IMAGE_PRIVATE_DATA_SIGNATURE
;
1244 Image
->Info
.SystemTable
= gDxeCoreST
;
1245 Image
->Info
.DeviceHandle
= DeviceHandle
;
1246 Image
->Info
.Revision
= EFI_LOADED_IMAGE_PROTOCOL_REVISION
;
1247 Image
->Info
.FilePath
= DuplicateDevicePath (FilePath
);
1248 Image
->Info
.ParentHandle
= ParentImageHandle
;
1251 if (NumberOfPages
!= NULL
) {
1252 Image
->NumberOfPages
= *NumberOfPages
;
1254 Image
->NumberOfPages
= 0 ;
1258 // Install the protocol interfaces for this image
1259 // don't fire notifications yet
1261 Status
= CoreInstallProtocolInterfaceNotify (
1263 &gEfiLoadedImageProtocolGuid
,
1264 EFI_NATIVE_INTERFACE
,
1268 if (EFI_ERROR (Status
)) {
1273 // Load the image. If EntryPoint is Null, it will not be set.
1275 Status
= CoreLoadPeImage (BootPolicy
, &FHand
, Image
, DstBuffer
, EntryPoint
, Attribute
);
1276 if (EFI_ERROR (Status
)) {
1277 if ((Status
== EFI_BUFFER_TOO_SMALL
) || (Status
== EFI_OUT_OF_RESOURCES
)) {
1278 if (NumberOfPages
!= NULL
) {
1279 *NumberOfPages
= Image
->NumberOfPages
;
1285 if (NumberOfPages
!= NULL
) {
1286 *NumberOfPages
= Image
->NumberOfPages
;
1290 // Register the image in the Debug Image Info Table if the attribute is set
1292 if ((Attribute
& EFI_LOAD_PE_IMAGE_ATTRIBUTE_DEBUG_IMAGE_INFO_TABLE_REGISTRATION
) != 0) {
1293 CoreNewDebugImageInfoEntry (EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL
, &Image
->Info
, Image
->Handle
);
1297 //Reinstall loaded image protocol to fire any notifications
1299 Status
= CoreReinstallProtocolInterface (
1301 &gEfiLoadedImageProtocolGuid
,
1305 if (EFI_ERROR (Status
)) {
1310 // If DevicePath parameter to the LoadImage() is not NULL, then make a copy of DevicePath,
1311 // otherwise Loaded Image Device Path Protocol is installed with a NULL interface pointer.
1313 if (OriginalFilePath
!= NULL
) {
1314 Image
->LoadedImageDevicePath
= DuplicateDevicePath (OriginalFilePath
);
1318 // Install Loaded Image Device Path Protocol onto the image handle of a PE/COFE image
1320 Status
= CoreInstallProtocolInterface (
1322 &gEfiLoadedImageDevicePathProtocolGuid
,
1323 EFI_NATIVE_INTERFACE
,
1324 Image
->LoadedImageDevicePath
1326 if (EFI_ERROR (Status
)) {
1331 // Install HII Package List Protocol onto the image handle
1333 if (Image
->ImageContext
.HiiResourceData
!= 0) {
1334 Status
= CoreInstallProtocolInterface (
1336 &gEfiHiiPackageListProtocolGuid
,
1337 EFI_NATIVE_INTERFACE
,
1338 (VOID
*) (UINTN
) Image
->ImageContext
.HiiResourceData
1340 if (EFI_ERROR (Status
)) {
1346 // Success. Return the image handle
1348 *ImageHandle
= Image
->Handle
;
1352 // All done accessing the source file
1353 // If we allocated the Source buffer, free it
1355 if (FHand
.FreeBuffer
) {
1356 CoreFreePool (FHand
.Source
);
1358 if (OriginalFilePath
!= InputFilePath
) {
1359 CoreFreePool (OriginalFilePath
);
1363 // There was an error. If there's an Image structure, free it
1365 if (EFI_ERROR (Status
)) {
1366 if (Image
!= NULL
) {
1367 CoreUnloadAndCloseImage (Image
, (BOOLEAN
)(DstBuffer
== 0));
1370 } else if (EFI_ERROR (SecurityStatus
)) {
1371 Status
= SecurityStatus
;
1375 // Track the return status from LoadImage.
1377 if (Image
!= NULL
) {
1378 Image
->LoadImageStatus
= Status
;
1388 Loads an EFI image into memory and returns a handle to the image.
1390 @param BootPolicy If TRUE, indicates that the request originates
1391 from the boot manager, and that the boot
1392 manager is attempting to load FilePath as a
1394 @param ParentImageHandle The caller's image handle.
1395 @param FilePath The specific file path from which the image is
1397 @param SourceBuffer If not NULL, a pointer to the memory location
1398 containing a copy of the image to be loaded.
1399 @param SourceSize The size in bytes of SourceBuffer.
1400 @param ImageHandle Pointer to the returned image handle that is
1401 created when the image is successfully loaded.
1403 @retval EFI_SUCCESS The image was loaded into memory.
1404 @retval EFI_NOT_FOUND The FilePath was not found.
1405 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1406 @retval EFI_UNSUPPORTED The image type is not supported, or the device
1407 path cannot be parsed to locate the proper
1408 protocol for loading the file.
1409 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient
1411 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
1413 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
1414 @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the
1415 image from being loaded. NULL is returned in *ImageHandle.
1416 @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
1417 valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
1418 platform policy specifies that the image should not be started.
1424 IN BOOLEAN BootPolicy
,
1425 IN EFI_HANDLE ParentImageHandle
,
1426 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
1427 IN VOID
*SourceBuffer OPTIONAL
,
1428 IN UINTN SourceSize
,
1429 OUT EFI_HANDLE
*ImageHandle
1438 Tick
= GetPerformanceCounter ();
1441 Status
= CoreLoadImageCommon (
1447 (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
,
1451 EFI_LOAD_PE_IMAGE_ATTRIBUTE_RUNTIME_REGISTRATION
| EFI_LOAD_PE_IMAGE_ATTRIBUTE_DEBUG_IMAGE_INFO_TABLE_REGISTRATION
1455 if (!EFI_ERROR (Status
)) {
1457 // ImageHandle will be valid only Status is success.
1459 Handle
= *ImageHandle
;
1462 PERF_START (Handle
, "LoadImage:", NULL
, Tick
);
1463 PERF_END (Handle
, "LoadImage:", NULL
, 0);
1471 Loads an EFI image into memory and returns a handle to the image with extended parameters.
1473 @param This Calling context
1474 @param ParentImageHandle The caller's image handle.
1475 @param FilePath The specific file path from which the image is
1477 @param SourceBuffer If not NULL, a pointer to the memory location
1478 containing a copy of the image to be loaded.
1479 @param SourceSize The size in bytes of SourceBuffer.
1480 @param DstBuffer The buffer to store the image.
1481 @param NumberOfPages For input, specifies the space size of the
1482 image by caller if not NULL. For output,
1483 specifies the actual space size needed.
1484 @param ImageHandle Image handle for output.
1485 @param EntryPoint Image entry point for output.
1486 @param Attribute The bit mask of attributes to set for the load
1489 @retval EFI_SUCCESS The image was loaded into memory.
1490 @retval EFI_NOT_FOUND The FilePath was not found.
1491 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1492 @retval EFI_UNSUPPORTED The image type is not supported, or the device
1493 path cannot be parsed to locate the proper
1494 protocol for loading the file.
1495 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient
1497 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
1499 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
1500 @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the
1501 image from being loaded. NULL is returned in *ImageHandle.
1502 @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
1503 valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
1504 platform policy specifies that the image should not be started.
1510 IN EFI_PE32_IMAGE_PROTOCOL
*This
,
1511 IN EFI_HANDLE ParentImageHandle
,
1512 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
1513 IN VOID
*SourceBuffer OPTIONAL
,
1514 IN UINTN SourceSize
,
1515 IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL
,
1516 OUT UINTN
*NumberOfPages OPTIONAL
,
1517 OUT EFI_HANDLE
*ImageHandle
,
1518 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint OPTIONAL
,
1528 Tick
= GetPerformanceCounter ();
1531 Status
= CoreLoadImageCommon (
1545 if (!EFI_ERROR (Status
)) {
1547 // ImageHandle will be valid only Status is success.
1549 Handle
= *ImageHandle
;
1552 PERF_START (Handle
, "LoadImage:", NULL
, Tick
);
1553 PERF_END (Handle
, "LoadImage:", NULL
, 0);
1560 Transfer control to a loaded image's entry point.
1562 @param ImageHandle Handle of image to be started.
1563 @param ExitDataSize Pointer of the size to ExitData
1564 @param ExitData Pointer to a pointer to a data buffer that
1565 includes a Null-terminated string,
1566 optionally followed by additional binary data.
1567 The string is a description that the caller may
1568 use to further indicate the reason for the
1571 @retval EFI_INVALID_PARAMETER Invalid parameter
1572 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1573 @retval EFI_SECURITY_VIOLATION The current platform policy specifies that the image should not be started.
1574 @retval EFI_SUCCESS Successfully transfer control to the image's
1581 IN EFI_HANDLE ImageHandle
,
1582 OUT UINTN
*ExitDataSize
,
1583 OUT CHAR16
**ExitData OPTIONAL
1587 LOADED_IMAGE_PRIVATE_DATA
*Image
;
1588 LOADED_IMAGE_PRIVATE_DATA
*LastImage
;
1589 UINT64 HandleDatabaseKey
;
1595 Handle
= ImageHandle
;
1597 Image
= CoreLoadedImageInfo (ImageHandle
);
1598 if (Image
== NULL
|| Image
->Started
) {
1599 return EFI_INVALID_PARAMETER
;
1601 if (EFI_ERROR (Image
->LoadImageStatus
)) {
1602 return Image
->LoadImageStatus
;
1606 // The image to be started must have the machine type supported by DxeCore.
1608 if (!EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Image
->Machine
)) {
1610 // Do not ASSERT here, because image might be loaded via EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED
1611 // But it can not be started.
1613 DEBUG ((EFI_D_ERROR
, "Image type %s can't be started ", GetMachineTypeName(Image
->Machine
)));
1614 DEBUG ((EFI_D_ERROR
, "on %s UEFI system.\n", GetMachineTypeName(mDxeCoreImageMachineType
)));
1615 return EFI_UNSUPPORTED
;
1619 Tick
= GetPerformanceCounter ();
1624 // Push the current start image context, and
1625 // link the current image to the head. This is the
1626 // only image that can call Exit()
1628 HandleDatabaseKey
= CoreGetHandleDatabaseKey ();
1629 LastImage
= mCurrentImage
;
1630 mCurrentImage
= Image
;
1631 Image
->Tpl
= gEfiCurrentTpl
;
1634 // Set long jump for Exit() support
1635 // JumpContext must be aligned on a CPU specific boundary.
1636 // Overallocate the buffer and force the required alignment
1638 Image
->JumpBuffer
= AllocatePool (sizeof (BASE_LIBRARY_JUMP_BUFFER
) + BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT
);
1639 if (Image
->JumpBuffer
== NULL
) {
1641 // Image may be unloaded after return with failure,
1642 // then ImageHandle may be invalid, so use NULL handle to record perf log.
1644 PERF_START (NULL
, "StartImage:", NULL
, Tick
);
1645 PERF_END (NULL
, "StartImage:", NULL
, 0);
1646 return EFI_OUT_OF_RESOURCES
;
1648 Image
->JumpContext
= ALIGN_POINTER (Image
->JumpBuffer
, BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT
);
1650 SetJumpFlag
= SetJump (Image
->JumpContext
);
1652 // The initial call to SetJump() must always return 0.
1653 // Subsequent calls to LongJump() cause a non-zero value to be returned by SetJump().
1655 if (SetJumpFlag
== 0) {
1656 RegisterMemoryProfileImage (Image
, (Image
->ImageContext
.ImageType
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
? EFI_FV_FILETYPE_APPLICATION
: EFI_FV_FILETYPE_DRIVER
));
1658 // Call the image's entry point
1660 Image
->Started
= TRUE
;
1661 Image
->Status
= Image
->EntryPoint (ImageHandle
, Image
->Info
.SystemTable
);
1664 // Add some debug information if the image returned with error.
1665 // This make the user aware and check if the driver image have already released
1666 // all the resource in this situation.
1668 DEBUG_CODE_BEGIN ();
1669 if (EFI_ERROR (Image
->Status
)) {
1670 DEBUG ((DEBUG_ERROR
, "Error: Image at %11p start failed: %r\n", Image
->Info
.ImageBase
, Image
->Status
));
1675 // If the image returns, exit it through Exit()
1677 CoreExit (ImageHandle
, Image
->Status
, 0, NULL
);
1681 // Image has completed. Verify the tpl is the same
1683 ASSERT (Image
->Tpl
== gEfiCurrentTpl
);
1684 CoreRestoreTpl (Image
->Tpl
);
1686 CoreFreePool (Image
->JumpBuffer
);
1689 // Pop the current start image context
1691 mCurrentImage
= LastImage
;
1694 // Go connect any handles that were created or modified while the image executed.
1696 CoreConnectHandlesByKey (HandleDatabaseKey
);
1699 // Handle the image's returned ExitData
1701 DEBUG_CODE_BEGIN ();
1702 if (Image
->ExitDataSize
!= 0 || Image
->ExitData
!= NULL
) {
1704 DEBUG ((DEBUG_LOAD
, "StartImage: ExitDataSize %d, ExitData %p", (UINT32
)Image
->ExitDataSize
, Image
->ExitData
));
1705 if (Image
->ExitData
!= NULL
) {
1706 DEBUG ((DEBUG_LOAD
, " (%hs)", Image
->ExitData
));
1708 DEBUG ((DEBUG_LOAD
, "\n"));
1713 // Return the exit data to the caller
1715 if (ExitData
!= NULL
&& ExitDataSize
!= NULL
) {
1716 *ExitDataSize
= Image
->ExitDataSize
;
1717 *ExitData
= Image
->ExitData
;
1720 // Caller doesn't want the exit data, free it
1722 CoreFreePool (Image
->ExitData
);
1723 Image
->ExitData
= NULL
;
1727 // Save the Status because Image will get destroyed if it is unloaded.
1729 Status
= Image
->Status
;
1732 // If the image returned an error, or if the image is an application
1735 if (EFI_ERROR (Image
->Status
) || Image
->Type
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
1736 CoreUnloadAndCloseImage (Image
, TRUE
);
1738 // ImageHandle may be invalid after the image is unloaded, so use NULL handle to record perf log.
1746 PERF_START (Handle
, "StartImage:", NULL
, Tick
);
1747 PERF_END (Handle
, "StartImage:", NULL
, 0);
1752 Terminates the currently loaded EFI image and returns control to boot services.
1754 @param ImageHandle Handle that identifies the image. This
1755 parameter is passed to the image on entry.
1756 @param Status The image's exit code.
1757 @param ExitDataSize The size, in bytes, of ExitData. Ignored if
1758 ExitStatus is EFI_SUCCESS.
1759 @param ExitData Pointer to a data buffer that includes a
1760 Null-terminated Unicode string, optionally
1761 followed by additional binary data. The string
1762 is a description that the caller may use to
1763 further indicate the reason for the image's
1766 @retval EFI_INVALID_PARAMETER Image handle is NULL or it is not current
1768 @retval EFI_SUCCESS Successfully terminates the currently loaded
1770 @retval EFI_ACCESS_DENIED Should never reach there.
1771 @retval EFI_OUT_OF_RESOURCES Could not allocate pool
1777 IN EFI_HANDLE ImageHandle
,
1778 IN EFI_STATUS Status
,
1779 IN UINTN ExitDataSize
,
1780 IN CHAR16
*ExitData OPTIONAL
1783 LOADED_IMAGE_PRIVATE_DATA
*Image
;
1787 // Prevent possible reentrance to this function
1788 // for the same ImageHandle
1790 OldTpl
= CoreRaiseTpl (TPL_NOTIFY
);
1792 Image
= CoreLoadedImageInfo (ImageHandle
);
1793 if (Image
== NULL
) {
1794 Status
= EFI_INVALID_PARAMETER
;
1798 if (!Image
->Started
) {
1800 // The image has not been started so just free its resources
1802 CoreUnloadAndCloseImage (Image
, TRUE
);
1803 Status
= EFI_SUCCESS
;
1808 // Image has been started, verify this image can exit
1810 if (Image
!= mCurrentImage
) {
1811 DEBUG ((DEBUG_LOAD
|DEBUG_ERROR
, "Exit: Image is not exitable image\n"));
1812 Status
= EFI_INVALID_PARAMETER
;
1819 Image
->Status
= Status
;
1822 // If there's ExitData info, move it
1824 if (ExitData
!= NULL
) {
1825 Image
->ExitDataSize
= ExitDataSize
;
1826 Image
->ExitData
= AllocatePool (Image
->ExitDataSize
);
1827 if (Image
->ExitData
== NULL
) {
1828 Status
= EFI_OUT_OF_RESOURCES
;
1831 CopyMem (Image
->ExitData
, ExitData
, Image
->ExitDataSize
);
1834 CoreRestoreTpl (OldTpl
);
1836 // return to StartImage
1838 LongJump (Image
->JumpContext
, (UINTN
)-1);
1841 // If we return from LongJump, then it is an error
1844 Status
= EFI_ACCESS_DENIED
;
1846 CoreRestoreTpl (OldTpl
);
1856 @param ImageHandle Handle that identifies the image to be
1859 @retval EFI_SUCCESS The image has been unloaded.
1860 @retval EFI_UNSUPPORTED The image has been sarted, and does not support
1862 @retval EFI_INVALID_PARAMPETER ImageHandle is not a valid image handle.
1868 IN EFI_HANDLE ImageHandle
1872 LOADED_IMAGE_PRIVATE_DATA
*Image
;
1874 Image
= CoreLoadedImageInfo (ImageHandle
);
1875 if (Image
== NULL
) {
1877 // The image handle is not valid
1879 Status
= EFI_INVALID_PARAMETER
;
1883 if (Image
->Started
) {
1885 // The image has been started, request it to unload.
1887 Status
= EFI_UNSUPPORTED
;
1888 if (Image
->Info
.Unload
!= NULL
) {
1889 Status
= Image
->Info
.Unload (ImageHandle
);
1894 // This Image hasn't been started, thus it can be unloaded
1896 Status
= EFI_SUCCESS
;
1900 if (!EFI_ERROR (Status
)) {
1902 // if the Image was not started or Unloaded O.K. then clean up
1904 CoreUnloadAndCloseImage (Image
, TRUE
);
1914 Unload the specified image.
1916 @param This Indicates the calling context.
1917 @param ImageHandle The specified image handle.
1919 @retval EFI_INVALID_PARAMETER Image handle is NULL.
1920 @retval EFI_UNSUPPORTED Attempt to unload an unsupported image.
1921 @retval EFI_SUCCESS Image successfully unloaded.
1927 IN EFI_PE32_IMAGE_PROTOCOL
*This
,
1928 IN EFI_HANDLE ImageHandle
1931 return CoreUnloadImage (ImageHandle
);