3 Copyright (c) 2006 - 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 Core image handling services
27 LOADED_IMAGE_PRIVATE_DATA
*mCurrentImage
= NULL
;
29 LOAD_PE32_IMAGE_PRIVATE_DATA mLoadPe32PrivateData
= {
30 LOAD_PE32_IMAGE_PRIVATE_DATA_SIGNATURE
,
40 // This code is needed to build the Image handle for the DXE Core
42 LOADED_IMAGE_PRIVATE_DATA mCorePrivateImage
= {
43 LOADED_IMAGE_PRIVATE_DATA_SIGNATURE
, // Signature
45 EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER
, // Image type
46 TRUE
, // If entrypoint has been called
49 EFI_LOADED_IMAGE_INFORMATION_REVISION
, // Revision
50 NULL
, // Parent handle
51 NULL
, // System handle
53 NULL
, // Device handle
62 EfiBootServicesCode
, // ImageCodeType
63 EfiBootServicesData
// ImageDataType
65 (EFI_PHYSICAL_ADDRESS
)0, // ImageBasePage
69 EFI_SUCCESS
, // Status
77 NULL
// LoadedImageDevicePath
82 CoreInitializeImageServices (
89 Add the Image Services to EFI Boot Services Table and install the protocol
90 interfaces for this image.
94 HobStart - The HOB to initialize
103 LOADED_IMAGE_PRIVATE_DATA
*Image
;
104 EFI_PHYSICAL_ADDRESS DxeCoreImageBaseAddress
;
105 UINT64 DxeCoreImageLength
;
106 VOID
*DxeCoreEntryPoint
;
107 EFI_PEI_HOB_POINTERS DxeCoreHob
;
109 // Searching for image hob
111 DxeCoreHob
.Raw
= HobStart
;
112 while ((DxeCoreHob
.Raw
= GetNextHob (EFI_HOB_TYPE_MEMORY_ALLOCATION
, DxeCoreHob
.Raw
)) != NULL
) {
113 if (CompareGuid (&DxeCoreHob
.MemoryAllocationModule
->MemoryAllocationHeader
.Name
, &gEfiHobMemoryAllocModuleGuid
)) {
119 DxeCoreHob
.Raw
= GET_NEXT_HOB (DxeCoreHob
);
121 ASSERT (DxeCoreHob
.Raw
!= NULL
);
123 DxeCoreImageBaseAddress
= DxeCoreHob
.MemoryAllocationModule
->MemoryAllocationHeader
.MemoryBaseAddress
;
124 DxeCoreImageLength
= DxeCoreHob
.MemoryAllocationModule
->MemoryAllocationHeader
.MemoryLength
;
125 DxeCoreEntryPoint
= (VOID
*) (UINTN
) DxeCoreHob
.MemoryAllocationModule
->EntryPoint
;
126 gDxeCoreFileName
= &DxeCoreHob
.MemoryAllocationModule
->ModuleName
;
128 // Initialize the fields for an internal driver
130 Image
= &mCorePrivateImage
;
132 Image
->EntryPoint
= (EFI_IMAGE_ENTRY_POINT
)(UINTN
)DxeCoreEntryPoint
;
133 Image
->ImageBasePage
= DxeCoreImageBaseAddress
;
134 Image
->NumberOfPages
= (UINTN
)(EFI_SIZE_TO_PAGES((UINTN
)(DxeCoreImageLength
)));
135 Image
->Tpl
= gEfiCurrentTpl
;
136 Image
->Info
.SystemTable
= gDxeCoreST
;
137 Image
->Info
.ImageBase
= (VOID
*)(UINTN
)DxeCoreImageBaseAddress
;
138 Image
->Info
.ImageSize
= DxeCoreImageLength
;
141 // Install the protocol interfaces for this image
143 Status
= CoreInstallProtocolInterface (
145 &gEfiLoadedImageProtocolGuid
,
146 EFI_NATIVE_INTERFACE
,
149 ASSERT_EFI_ERROR (Status
);
151 mCurrentImage
= Image
;
154 // Fill in DXE globals
156 gDxeCoreImageHandle
= Image
->Handle
;
157 gDxeCoreLoadedImage
= &Image
->Info
;
160 // Export DXE Core PE Loader functionality
162 return CoreInstallProtocolInterface (
163 &mLoadPe32PrivateData
.Handle
,
164 &gEfiLoadPeImageProtocolGuid
,
165 EFI_NATIVE_INTERFACE
,
166 &mLoadPe32PrivateData
.Pe32Image
172 IN BOOLEAN BootPolicy
,
174 IN LOADED_IMAGE_PRIVATE_DATA
*Image
,
175 IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL
,
176 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint OPTIONAL
,
183 Loads, relocates, and invokes a PE/COFF image
186 BootPolicy - If TRUE, indicates that the request originates from the boot manager,
187 and that the boot manager is attempting to load FilePath as a boot selection.
188 Pe32Handle - The handle of PE32 image
189 Image - PE image to be loaded
190 DstBuffer - The buffer to store the image
191 EntryPoint - A pointer to the entry point
192 Attribute - The bit mask of attributes to set for the load PE image
196 EFI_SUCCESS - The file was loaded, relocated, and invoked
198 EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file
200 EFI_INVALID_PARAMETER - Invalid parameter
202 EFI_BUFFER_TOO_SMALL - Buffer for image is too small
207 BOOLEAN DstBufAlocated
;
210 EFI_TCG_PLATFORM_PROTOCOL
*TcgPlatformProtocol
;
211 IMAGE_FILE_HANDLE
*FHandle
;
214 ZeroMem (&Image
->ImageContext
, sizeof (Image
->ImageContext
));
216 Image
->ImageContext
.Handle
= Pe32Handle
;
217 Image
->ImageContext
.ImageRead
= (PE_COFF_LOADER_READ_FILE
)CoreReadImageFile
;
220 // Get information about the image being loaded
222 Status
= PeCoffLoaderGetImageInfo (&Image
->ImageContext
);
223 if (EFI_ERROR (Status
)) {
227 if (!EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Image
->ImageContext
.Machine
)) {
229 // The PE/COFF loader can support loading image types that can be executed.
230 // If we loaded an image type that we can not execute return EFI_UNSUPORTED.
232 return EFI_UNSUPPORTED
;
236 // Set EFI memory type based on ImageType
238 switch (Image
->ImageContext
.ImageType
) {
239 case EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
:
240 Image
->ImageContext
.ImageCodeMemoryType
= EfiLoaderCode
;
241 Image
->ImageContext
.ImageDataMemoryType
= EfiLoaderData
;
243 case EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER
:
244 Image
->ImageContext
.ImageCodeMemoryType
= EfiBootServicesCode
;
245 Image
->ImageContext
.ImageDataMemoryType
= EfiBootServicesData
;
247 case EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
:
248 case EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER
:
249 Image
->ImageContext
.ImageCodeMemoryType
= EfiRuntimeServicesCode
;
250 Image
->ImageContext
.ImageDataMemoryType
= EfiRuntimeServicesData
;
253 Image
->ImageContext
.ImageError
= IMAGE_ERROR_INVALID_SUBSYSTEM
;
254 return EFI_UNSUPPORTED
;
257 // Get the image base address in the original PeImage.
259 LinkTimeBase
= (UINTN
) Image
->ImageContext
.ImageAddress
;
262 // Allocate memory of the correct memory type aligned on the required image boundry
264 DstBufAlocated
= FALSE
;
265 if (DstBuffer
== 0) {
267 // Allocate Destination Buffer as caller did not pass it in
270 if (Image
->ImageContext
.SectionAlignment
> EFI_PAGE_SIZE
) {
271 Size
= (UINTN
)Image
->ImageContext
.ImageSize
+ Image
->ImageContext
.SectionAlignment
;
273 Size
= (UINTN
)Image
->ImageContext
.ImageSize
;
276 Image
->NumberOfPages
= EFI_SIZE_TO_PAGES (Size
);
279 // If the image relocations have not been stripped, then load at any address.
280 // Otherwise load at the address at which it was linked.
282 // Memory below 1MB should be treated reserved for CSM and there should be
283 // no modules whose preferred load addresses are below 1MB.
285 Status
= EFI_OUT_OF_RESOURCES
;
286 if (Image
->ImageContext
.ImageAddress
>= 0x100000 || Image
->ImageContext
.RelocationsStripped
) {
287 Status
= CoreAllocatePages (
289 (EFI_MEMORY_TYPE
) (Image
->ImageContext
.ImageCodeMemoryType
),
290 Image
->NumberOfPages
,
291 &Image
->ImageContext
.ImageAddress
294 if (EFI_ERROR (Status
) && !Image
->ImageContext
.RelocationsStripped
) {
295 Status
= CoreAllocatePages (
297 (EFI_MEMORY_TYPE
) (Image
->ImageContext
.ImageCodeMemoryType
),
298 Image
->NumberOfPages
,
299 &Image
->ImageContext
.ImageAddress
302 if (EFI_ERROR (Status
)) {
305 DstBufAlocated
= TRUE
;
308 // Caller provided the destination buffer
311 if (Image
->ImageContext
.RelocationsStripped
&& (Image
->ImageContext
.ImageAddress
!= DstBuffer
)) {
313 // If the image relocations were stripped, and the caller provided a
314 // destination buffer address that does not match the address that the
315 // image is linked at, then the image cannot be loaded.
317 return EFI_INVALID_PARAMETER
;
320 if (Image
->NumberOfPages
!= 0 &&
321 Image
->NumberOfPages
<
322 (EFI_SIZE_TO_PAGES ((UINTN
)Image
->ImageContext
.ImageSize
+ Image
->ImageContext
.SectionAlignment
))) {
323 Image
->NumberOfPages
= EFI_SIZE_TO_PAGES ((UINTN
)Image
->ImageContext
.ImageSize
+ Image
->ImageContext
.SectionAlignment
);
324 return EFI_BUFFER_TOO_SMALL
;
327 Image
->NumberOfPages
= EFI_SIZE_TO_PAGES ((UINTN
)Image
->ImageContext
.ImageSize
+ Image
->ImageContext
.SectionAlignment
);
328 Image
->ImageContext
.ImageAddress
= DstBuffer
;
331 Image
->ImageBasePage
= Image
->ImageContext
.ImageAddress
;
332 Image
->ImageContext
.ImageAddress
=
333 (Image
->ImageContext
.ImageAddress
+ Image
->ImageContext
.SectionAlignment
- 1) &
334 ~((UINTN
)Image
->ImageContext
.SectionAlignment
- 1);
337 // Load the image from the file into the allocated memory
339 Status
= PeCoffLoaderLoadImage (&Image
->ImageContext
);
340 if (EFI_ERROR (Status
)) {
345 // If this is a Runtime Driver, then allocate memory for the FixupData that
346 // is used to relocate the image when SetVirtualAddressMap() is called. The
347 // relocation is done by the Runtime AP.
349 if (Attribute
& EFI_LOAD_PE_IMAGE_ATTRIBUTE_RUNTIME_REGISTRATION
) {
350 if (Image
->ImageContext
.ImageType
== EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
) {
351 Image
->ImageContext
.FixupData
= CoreAllocateRuntimePool ((UINTN
)(Image
->ImageContext
.FixupDataSize
));
352 if (Image
->ImageContext
.FixupData
== NULL
) {
353 Status
= EFI_OUT_OF_RESOURCES
;
360 // Measure the image before applying fixup
362 Status
= CoreLocateProtocol (
363 &gEfiTcgPlatformProtocolGuid
,
365 (VOID
**) &TcgPlatformProtocol
367 if (!EFI_ERROR (Status
)) {
368 FHandle
= (IMAGE_FILE_HANDLE
*) Image
->ImageContext
.Handle
;
369 Status
= TcgPlatformProtocol
->MeasurePeImage (
371 (EFI_PHYSICAL_ADDRESS
) (UINTN
) FHandle
->Source
,
374 Image
->ImageContext
.ImageType
,
375 Image
->Info
.DeviceHandle
,
379 ASSERT_EFI_ERROR (Status
);
383 // Relocate the image in memory
385 Status
= PeCoffLoaderRelocateImage (&Image
->ImageContext
);
386 if (EFI_ERROR (Status
)) {
391 // Flush the Instruction Cache
393 InvalidateInstructionCacheRange ((VOID
*)(UINTN
)Image
->ImageContext
.ImageAddress
, (UINTN
)Image
->ImageContext
.ImageSize
);
396 // Copy the machine type from the context to the image private data. This
397 // is needed during image unload to know if we should call an EBC protocol
398 // to unload the image.
400 Image
->Machine
= Image
->ImageContext
.Machine
;
403 // Get the image entry point. If it's an EBC image, then call into the
404 // interpreter to create a thunk for the entry point and use the returned
405 // value for the entry point.
407 Image
->EntryPoint
= (EFI_IMAGE_ENTRY_POINT
)(UINTN
)Image
->ImageContext
.EntryPoint
;
408 if (Image
->ImageContext
.Machine
== EFI_IMAGE_MACHINE_EBC
) {
410 // Locate the EBC interpreter protocol
412 Status
= CoreLocateProtocol (&gEfiEbcProtocolGuid
, NULL
, (VOID
**)&Image
->Ebc
);
413 if (EFI_ERROR(Status
)) {
418 // Register a callback for flushing the instruction cache so that created
419 // thunks can be flushed.
421 Status
= Image
->Ebc
->RegisterICacheFlush (Image
->Ebc
, (EBC_ICACHE_FLUSH
)InvalidateInstructionCacheRange
);
422 if (EFI_ERROR(Status
)) {
427 // Create a thunk for the image's entry point. This will be the new
428 // entry point for the image.
430 Status
= Image
->Ebc
->CreateThunk (
433 (VOID
*)(UINTN
)Image
->ImageContext
.EntryPoint
,
434 (VOID
**)&Image
->EntryPoint
436 if (EFI_ERROR(Status
)) {
442 // Fill in the image information for the Loaded Image Protocol
444 Image
->Type
= Image
->ImageContext
.ImageType
;
445 Image
->Info
.ImageBase
= (VOID
*)(UINTN
)Image
->ImageContext
.ImageAddress
;
446 Image
->Info
.ImageSize
= Image
->ImageContext
.ImageSize
;
447 Image
->Info
.ImageCodeType
= (EFI_MEMORY_TYPE
) (Image
->ImageContext
.ImageCodeMemoryType
);
448 Image
->Info
.ImageDataType
= (EFI_MEMORY_TYPE
) (Image
->ImageContext
.ImageDataMemoryType
);
449 if (Attribute
& EFI_LOAD_PE_IMAGE_ATTRIBUTE_RUNTIME_REGISTRATION
) {
450 if (Image
->ImageContext
.ImageType
== EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
) {
452 // Make a list off all the RT images so we can let the RT AP know about them.
454 Image
->RuntimeData
= CoreAllocateRuntimePool (sizeof(EFI_RUNTIME_IMAGE_ENTRY
));
455 if (Image
->RuntimeData
== NULL
) {
458 Image
->RuntimeData
->ImageBase
= Image
->Info
.ImageBase
;
459 Image
->RuntimeData
->ImageSize
= (UINT64
) (Image
->Info
.ImageSize
);
460 Image
->RuntimeData
->RelocationData
= Image
->ImageContext
.FixupData
;
461 Image
->RuntimeData
->Handle
= Image
->Handle
;
462 InsertTailList (&gRuntime
->ImageHead
, &Image
->RuntimeData
->Link
);
467 // Fill in the entry point of the image if it is available
469 if (EntryPoint
!= NULL
) {
470 *EntryPoint
= Image
->ImageContext
.EntryPoint
;
474 // Print the load address and the PDB file name if it is available
481 CHAR8 EfiFileName
[256];
483 if (Image
->ImageContext
.Machine
!= IMAGE_FILE_MACHINE_IA64
) {
484 DEBUG ((EFI_D_INFO
| EFI_D_LOAD
,
485 "Loading driver at 0x%10p EntryPoint=0x%10p ",
486 (VOID
*)(UINTN
)Image
->ImageContext
.ImageAddress
,
487 (VOID
*)(UINTN
)Image
->ImageContext
.EntryPoint
));
490 // For IPF Image, the real entry point should be print.
492 DEBUG ((EFI_D_INFO
| EFI_D_LOAD
,
493 "Loading driver at 0x%10p EntryPoint=0x%10p ",
494 (VOID
*)(UINTN
)Image
->ImageContext
.ImageAddress
,
495 (VOID
*)(UINTN
)(*(UINT64
*)(UINTN
)Image
->ImageContext
.EntryPoint
)));
499 // Print Module Name by Pdb file path
501 if (Image
->ImageContext
.PdbPointer
!= NULL
) {
503 for (Index
= 0; Image
->ImageContext
.PdbPointer
[Index
] != 0; Index
++) {
504 if (Image
->ImageContext
.PdbPointer
[Index
] == '\\') {
505 StartIndex
= Index
+ 1;
509 // Copy the PDB file name to our temporary string, and replace .pdb with .efi
511 for (Index
= 0; Index
< sizeof (EfiFileName
); Index
++) {
512 EfiFileName
[Index
] = Image
->ImageContext
.PdbPointer
[Index
+ StartIndex
];
513 if (EfiFileName
[Index
] == 0) {
514 EfiFileName
[Index
] = '.';
516 if (EfiFileName
[Index
] == '.') {
517 EfiFileName
[Index
+ 1] = 'e';
518 EfiFileName
[Index
+ 2] = 'f';
519 EfiFileName
[Index
+ 3] = 'i';
520 EfiFileName
[Index
+ 4] = 0;
524 DEBUG ((EFI_D_INFO
| EFI_D_LOAD
, "%a", EfiFileName
)); // &Image->ImageContext.PdbPointer[StartIndex]));
526 DEBUG ((EFI_D_INFO
| EFI_D_LOAD
, "\n"));
538 if (DstBufAlocated
) {
539 CoreFreePages (Image
->ImageContext
.ImageAddress
, Image
->NumberOfPages
);
542 if (Image
->ImageContext
.FixupData
!= NULL
) {
543 CoreFreePool (Image
->ImageContext
.FixupData
);
550 LOADED_IMAGE_PRIVATE_DATA
*
551 CoreLoadedImageInfo (
552 IN EFI_HANDLE ImageHandle
558 Get the image's private data from its handle.
562 ImageHandle - The image handle
566 Return the image private data associated with ImageHandle.
571 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
572 LOADED_IMAGE_PRIVATE_DATA
*Image
;
574 Status
= CoreHandleProtocol (
576 &gEfiLoadedImageProtocolGuid
,
577 (VOID
**)&LoadedImage
579 if (!EFI_ERROR (Status
)) {
580 Image
= LOADED_IMAGE_PRIVATE_DATA_FROM_THIS (LoadedImage
);
582 DEBUG ((EFI_D_LOAD
, "CoreLoadedImageInfo: Not an ImageHandle %x\n", ImageHandle
));
591 CoreLoadImageCommon (
592 IN BOOLEAN BootPolicy
,
593 IN EFI_HANDLE ParentImageHandle
,
594 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
595 IN VOID
*SourceBuffer OPTIONAL
,
597 IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL
,
598 IN OUT UINTN
*NumberOfPages OPTIONAL
,
599 OUT EFI_HANDLE
*ImageHandle
,
600 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint OPTIONAL
,
607 Loads an EFI image into memory and returns a handle to the image.
611 BootPolicy - If TRUE, indicates that the request originates from the boot manager,
612 and that the boot manager is attempting to load FilePath as a boot selection.
613 ParentImageHandle - The caller's image handle.
614 FilePath - The specific file path from which the image is loaded.
615 SourceBuffer - If not NULL, a pointer to the memory location containing a copy of
616 the image to be loaded.
617 SourceSize - The size in bytes of SourceBuffer.
618 DstBuffer - The buffer to store the image
619 NumberOfPages - If not NULL, a pointer to the image's page number, if this number
620 is not enough, return EFI_BUFFER_TOO_SMALL and this parameter contain
622 ImageHandle - Pointer to the returned image handle that is created when the image
623 is successfully loaded.
624 EntryPoint - A pointer to the entry point
625 Attribute - The bit mask of attributes to set for the load PE image
629 EFI_SUCCESS - The image was loaded into memory.
630 EFI_NOT_FOUND - The FilePath was not found.
631 EFI_INVALID_PARAMETER - One of the parameters has an invalid value.
632 EFI_BUFFER_TOO_SMALL - The buffer is too small
633 EFI_UNSUPPORTED - The image type is not supported, or the device path cannot be
634 parsed to locate the proper protocol for loading the file.
635 EFI_OUT_OF_RESOURCES - Image was not loaded due to insufficient resources.
638 LOADED_IMAGE_PRIVATE_DATA
*Image
;
639 LOADED_IMAGE_PRIVATE_DATA
*ParentImage
;
640 IMAGE_FILE_HANDLE FHand
;
642 EFI_STATUS SecurityStatus
;
643 EFI_HANDLE DeviceHandle
;
644 UINT32 AuthenticationStatus
;
645 EFI_DEVICE_PATH_PROTOCOL
*OriginalFilePath
;
646 EFI_DEVICE_PATH_PROTOCOL
*HandleFilePath
;
649 SecurityStatus
= EFI_SUCCESS
;
651 ASSERT (gEfiCurrentTpl
< TPL_NOTIFY
);
655 // The caller must pass in a valid ParentImageHandle
657 if (ImageHandle
== NULL
|| ParentImageHandle
== NULL
) {
658 return EFI_INVALID_PARAMETER
;
661 ParentImage
= CoreLoadedImageInfo (ParentImageHandle
);
662 if (ParentImage
== NULL
) {
663 DEBUG((EFI_D_LOAD
|EFI_D_ERROR
, "LoadImageEx: Parent handle not an image handle\n"));
664 return EFI_INVALID_PARAMETER
;
668 // Get simple read access to the source file
670 OriginalFilePath
= FilePath
;
671 Status
= CoreOpenImageFile (
678 &AuthenticationStatus
680 if (Status
== EFI_ALREADY_STARTED
) {
683 } else if (EFI_ERROR (Status
)) {
688 // Verify the Authentication Status through the Security Architectural Protocol
690 if ((gSecurity
!= NULL
) && (OriginalFilePath
!= NULL
)) {
691 SecurityStatus
= gSecurity
->FileAuthenticationState (
693 AuthenticationStatus
,
696 if (EFI_ERROR (SecurityStatus
) && SecurityStatus
!= EFI_SECURITY_VIOLATION
) {
697 Status
= SecurityStatus
;
705 // Allocate a new image structure
707 Image
= CoreAllocateZeroBootServicesPool (sizeof(LOADED_IMAGE_PRIVATE_DATA
));
709 return EFI_OUT_OF_RESOURCES
;
713 // Pull out just the file portion of the DevicePath for the LoadedImage FilePath
715 FilePath
= OriginalFilePath
;
716 Status
= CoreHandleProtocol (DeviceHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&HandleFilePath
);
717 if (!EFI_ERROR (Status
)) {
718 FilePathSize
= CoreDevicePathSize (HandleFilePath
) - sizeof(EFI_DEVICE_PATH_PROTOCOL
);
719 FilePath
= (EFI_DEVICE_PATH_PROTOCOL
*) ( ((UINT8
*)FilePath
) + FilePathSize
);
723 // Initialize the fields for an internal driver
725 Image
->Signature
= LOADED_IMAGE_PRIVATE_DATA_SIGNATURE
;
726 Image
->Info
.SystemTable
= gDxeCoreST
;
727 Image
->Info
.DeviceHandle
= DeviceHandle
;
728 Image
->Info
.Revision
= EFI_LOADED_IMAGE_INFORMATION_REVISION
;
729 Image
->Info
.FilePath
= CoreDuplicateDevicePath (FilePath
);
730 Image
->Info
.ParentHandle
= ParentImageHandle
;
733 if (NumberOfPages
!= NULL
) {
734 Image
->NumberOfPages
= *NumberOfPages
;
736 Image
->NumberOfPages
= 0 ;
740 // Install the protocol interfaces for this image
741 // don't fire notifications yet
743 Status
= CoreInstallProtocolInterfaceNotify (
745 &gEfiLoadedImageProtocolGuid
,
746 EFI_NATIVE_INTERFACE
,
750 if (EFI_ERROR (Status
)) {
755 // Load the image. If EntryPoint is Null, it will not be set.
757 Status
= CoreLoadPeImage (BootPolicy
, &FHand
, Image
, DstBuffer
, EntryPoint
, Attribute
);
758 if (EFI_ERROR (Status
)) {
759 if ((Status
== EFI_BUFFER_TOO_SMALL
) || (Status
== EFI_OUT_OF_RESOURCES
)) {
760 if (NumberOfPages
!= NULL
) {
761 *NumberOfPages
= Image
->NumberOfPages
;
768 // Register the image in the Debug Image Info Table if the attribute is set
770 if (Attribute
& EFI_LOAD_PE_IMAGE_ATTRIBUTE_DEBUG_IMAGE_INFO_TABLE_REGISTRATION
) {
771 CoreNewDebugImageInfoEntry (EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL
, &Image
->Info
, Image
->Handle
);
775 //Reinstall loaded image protocol to fire any notifications
777 Status
= CoreReinstallProtocolInterface (
779 &gEfiLoadedImageProtocolGuid
,
783 if (EFI_ERROR (Status
)) {
788 // If DevicePath parameter to the LoadImage() is not NULL, then make a copy of DevicePath,
789 // otherwise Loaded Image Device Path Protocol is installed with a NULL interface pointer.
791 if (OriginalFilePath
!= NULL
) {
792 Image
->LoadedImageDevicePath
= CoreDuplicateDevicePath (OriginalFilePath
);
796 // Install Loaded Image Device Path Protocol onto the image handle of a PE/COFE image
798 Status
= CoreInstallProtocolInterface (
800 &gEfiLoadedImageDevicePathProtocolGuid
,
801 EFI_NATIVE_INTERFACE
,
802 Image
->LoadedImageDevicePath
804 if (EFI_ERROR (Status
)) {
809 // Success. Return the image handle
811 *ImageHandle
= Image
->Handle
;
815 // All done accessing the source file
816 // If we allocated the Source buffer, free it
818 if (FHand
.FreeBuffer
) {
819 CoreFreePool (FHand
.Source
);
823 // There was an error. If there's an Image structure, free it
825 if (EFI_ERROR (Status
)) {
827 CoreUnloadAndCloseImage (Image
, (BOOLEAN
)(DstBuffer
== 0));
830 } else if (EFI_ERROR (SecurityStatus
)) {
831 Status
= SecurityStatus
;
842 IN BOOLEAN BootPolicy
,
843 IN EFI_HANDLE ParentImageHandle
,
844 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
845 IN VOID
*SourceBuffer OPTIONAL
,
847 OUT EFI_HANDLE
*ImageHandle
853 Loads an EFI image into memory and returns a handle to the image.
857 BootPolicy - If TRUE, indicates that the request originates from the boot manager,
858 and that the boot manager is attempting to load FilePath as a boot selection.
859 ParentImageHandle - The caller's image handle.
860 FilePath - The specific file path from which the image is loaded.
861 SourceBuffer - If not NULL, a pointer to the memory location containing a copy of
862 the image to be loaded.
863 SourceSize - The size in bytes of SourceBuffer.
864 ImageHandle - Pointer to the returned image handle that is created when the image
865 is successfully loaded.
869 EFI_SUCCESS - The image was loaded into memory.
870 EFI_NOT_FOUND - The FilePath was not found.
871 EFI_INVALID_PARAMETER - One of the parameters has an invalid value.
872 EFI_UNSUPPORTED - The image type is not supported, or the device path cannot be
873 parsed to locate the proper protocol for loading the file.
874 EFI_OUT_OF_RESOURCES - Image was not loaded due to insufficient resources.
879 PERF_START (NULL
, "LoadImage", NULL
, 0);
881 Status
= CoreLoadImageCommon (
887 (EFI_PHYSICAL_ADDRESS
)NULL
,
891 EFI_LOAD_PE_IMAGE_ATTRIBUTE_RUNTIME_REGISTRATION
| EFI_LOAD_PE_IMAGE_ATTRIBUTE_DEBUG_IMAGE_INFO_TABLE_REGISTRATION
894 PERF_END (NULL
, "LoadImage", NULL
, 0);
903 IN EFI_PE32_IMAGE_PROTOCOL
*This
,
904 IN EFI_HANDLE ParentImageHandle
,
905 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
906 IN VOID
*SourceBuffer OPTIONAL
,
908 IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL
,
909 OUT UINTN
*NumberOfPages OPTIONAL
,
910 OUT EFI_HANDLE
*ImageHandle
,
911 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint OPTIONAL
,
918 Loads an EFI image into memory and returns a handle to the image with extended parameters.
922 This - Calling context
923 ParentImageHandle - The caller's image handle.
924 FilePath - The specific file path from which the image is loaded.
925 SourceBuffer - If not NULL, a pointer to the memory location containing a copy of
926 the image to be loaded.
927 SourceSize - The size in bytes of SourceBuffer.
928 DstBuffer - The buffer to store the image.
929 NumberOfPages - For input, specifies the space size of the image by caller if not NULL.
930 For output, specifies the actual space size needed.
931 ImageHandle - Image handle for output.
932 EntryPoint - Image entry point for output.
933 Attribute - The bit mask of attributes to set for the load PE image.
937 EFI_SUCCESS - The image was loaded into memory.
938 EFI_NOT_FOUND - The FilePath was not found.
939 EFI_INVALID_PARAMETER - One of the parameters has an invalid value.
940 EFI_UNSUPPORTED - The image type is not supported, or the device path cannot be
941 parsed to locate the proper protocol for loading the file.
942 EFI_OUT_OF_RESOURCES - Image was not loaded due to insufficient resources.
945 return CoreLoadImageCommon (
962 IN EFI_HANDLE ImageHandle
,
963 OUT UINTN
*ExitDataSize
,
964 OUT CHAR16
**ExitData OPTIONAL
970 Transfer control to a loaded image's entry point.
974 ImageHandle - Handle of image to be started.
976 ExitDataSize - Pointer of the size to ExitData
978 ExitData - Pointer to a pointer to a data buffer that includes a Null-terminated
979 Unicode string, optionally followed by additional binary data. The string
980 is a description that the caller may use to further indicate the reason for
985 EFI_INVALID_PARAMETER - Invalid parameter
987 EFI_OUT_OF_RESOURCES - No enough buffer to allocate
989 EFI_SUCCESS - Successfully transfer control to the image's entry point.
994 LOADED_IMAGE_PRIVATE_DATA
*Image
;
995 LOADED_IMAGE_PRIVATE_DATA
*LastImage
;
996 UINT64 HandleDatabaseKey
;
999 Image
= CoreLoadedImageInfo (ImageHandle
);
1000 if (Image
== NULL_HANDLE
|| Image
->Started
) {
1001 return EFI_INVALID_PARAMETER
;
1005 // Don't profile Objects or invalid start requests
1007 PERF_START (ImageHandle
, START_IMAGE_TOK
, NULL
, 0);
1011 // Push the current start image context, and
1012 // link the current image to the head. This is the
1013 // only image that can call Exit()
1015 HandleDatabaseKey
= CoreGetHandleDatabaseKey ();
1016 LastImage
= mCurrentImage
;
1017 mCurrentImage
= Image
;
1018 Image
->Tpl
= gEfiCurrentTpl
;
1021 // Set long jump for Exit() support
1022 // JumpContext must be aligned on a CPU specific boundary.
1023 // Overallocate the buffer and force the required alignment
1025 Image
->JumpBuffer
= CoreAllocateBootServicesPool (sizeof (BASE_LIBRARY_JUMP_BUFFER
) + BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT
);
1026 if (Image
->JumpBuffer
== NULL
) {
1027 PERF_END (ImageHandle
, START_IMAGE_TOK
, NULL
, 0);
1028 return EFI_OUT_OF_RESOURCES
;
1030 Image
->JumpContext
= ALIGN_POINTER (Image
->JumpBuffer
, BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT
);
1032 SetJumpFlag
= SetJump (Image
->JumpContext
);
1034 // The initial call to SetJump() must always return 0.
1035 // Subsequent calls to LongJump() cause a non-zero value to be returned by SetJump().
1039 // Call the image's entry point
1041 Image
->Started
= TRUE
;
1042 Image
->Status
= Image
->EntryPoint (ImageHandle
, Image
->Info
.SystemTable
);
1045 // Add some debug information if the image returned with error.
1046 // This make the user aware and check if the driver image have already released
1047 // all the resource in this situation.
1049 DEBUG_CODE_BEGIN ();
1050 if (EFI_ERROR (Image
->Status
)) {
1051 DEBUG ((EFI_D_ERROR
, "Error: Image at %10p start failed: %r\n", Image
->Info
.ImageBase
, Image
->Status
));
1056 // If the image returns, exit it through Exit()
1058 CoreExit (ImageHandle
, Image
->Status
, 0, NULL
);
1062 // Image has completed. Verify the tpl is the same
1064 ASSERT (Image
->Tpl
== gEfiCurrentTpl
);
1065 CoreRestoreTpl (Image
->Tpl
);
1067 CoreFreePool (Image
->JumpBuffer
);
1070 // Pop the current start image context
1072 mCurrentImage
= LastImage
;
1075 // Go connect any handles that were created or modified while the image executed.
1077 CoreConnectHandlesByKey (HandleDatabaseKey
);
1080 // Handle the image's returned ExitData
1082 DEBUG_CODE_BEGIN ();
1083 if (Image
->ExitDataSize
!= 0 || Image
->ExitData
!= NULL
) {
1087 "StartImage: ExitDataSize %d, ExitData %x",
1088 Image
->ExitDataSize
,
1091 if (Image
->ExitData
!= NULL
) {
1092 DEBUG ((EFI_D_LOAD
, " (%hs)", Image
->ExitData
));
1094 DEBUG ((EFI_D_LOAD
, "\n"));
1099 // Return the exit data to the caller
1101 if (ExitData
!= NULL
&& ExitDataSize
!= NULL
) {
1102 *ExitDataSize
= Image
->ExitDataSize
;
1103 *ExitData
= Image
->ExitData
;
1106 // Caller doesn't want the exit data, free it
1108 CoreFreePool (Image
->ExitData
);
1109 Image
->ExitData
= NULL
;
1113 // Save the Status because Image will get destroyed if it is unloaded.
1115 Status
= Image
->Status
;
1118 // If the image returned an error, or if the image is an application
1121 if (EFI_ERROR (Image
->Status
) || Image
->Type
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
1122 CoreUnloadAndCloseImage (Image
, TRUE
);
1128 PERF_END (ImageHandle
, START_IMAGE_TOK
, NULL
, 0);
1134 CoreUnloadAndCloseImage (
1135 IN LOADED_IMAGE_PRIVATE_DATA
*Image
,
1140 Routine Description:
1142 Unloads EFI image from memory.
1147 FreePage - Free allocated pages
1157 EFI_HANDLE
*HandleBuffer
;
1159 EFI_GUID
**ProtocolGuidArray
;
1161 UINTN ProtocolIndex
;
1162 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
*OpenInfo
;
1163 UINTN OpenInfoCount
;
1164 UINTN OpenInfoIndex
;
1166 if (Image
->Ebc
!= NULL
) {
1168 // If EBC protocol exists we must perform cleanups for this image.
1170 Image
->Ebc
->UnloadImage (Image
->Ebc
, Image
->Handle
);
1174 // Unload image, free Image->ImageContext->ModHandle
1176 PeCoffLoaderUnloadImage (&Image
->ImageContext
);
1179 // Free our references to the image handle
1181 if (Image
->Handle
!= NULL_HANDLE
) {
1183 Status
= CoreLocateHandleBuffer (
1190 if (!EFI_ERROR (Status
)) {
1191 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1192 Status
= CoreProtocolsPerHandle (
1193 HandleBuffer
[HandleIndex
],
1197 if (!EFI_ERROR (Status
)) {
1198 for (ProtocolIndex
= 0; ProtocolIndex
< ArrayCount
; ProtocolIndex
++) {
1199 Status
= CoreOpenProtocolInformation (
1200 HandleBuffer
[HandleIndex
],
1201 ProtocolGuidArray
[ProtocolIndex
],
1205 if (!EFI_ERROR (Status
)) {
1206 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
1207 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== Image
->Handle
) {
1208 Status
= CoreCloseProtocol (
1209 HandleBuffer
[HandleIndex
],
1210 ProtocolGuidArray
[ProtocolIndex
],
1212 OpenInfo
[OpenInfoIndex
].ControllerHandle
1216 if (OpenInfo
!= NULL
) {
1217 CoreFreePool(OpenInfo
);
1221 if (ProtocolGuidArray
!= NULL
) {
1222 CoreFreePool(ProtocolGuidArray
);
1226 if (HandleBuffer
!= NULL
) {
1227 CoreFreePool (HandleBuffer
);
1231 CoreRemoveDebugImageInfoEntry (Image
->Handle
);
1233 Status
= CoreUninstallProtocolInterface (
1235 &gEfiLoadedImageDevicePathProtocolGuid
,
1236 Image
->LoadedImageDevicePath
1239 Status
= CoreUninstallProtocolInterface (
1241 &gEfiLoadedImageProtocolGuid
,
1247 if (Image
->RuntimeData
!= NULL
) {
1248 if (Image
->RuntimeData
->Link
.ForwardLink
!= NULL
) {
1250 // Remove the Image from the Runtime Image list as we are about to Free it!
1252 RemoveEntryList (&Image
->RuntimeData
->Link
);
1254 CoreFreePool (Image
->RuntimeData
);
1258 // Free the Image from memory
1260 if ((Image
->ImageBasePage
!= 0) && FreePage
) {
1261 CoreFreePages (Image
->ImageBasePage
, Image
->NumberOfPages
);
1265 // Done with the Image structure
1267 if (Image
->Info
.FilePath
!= NULL
) {
1268 CoreFreePool (Image
->Info
.FilePath
);
1271 if (Image
->LoadedImageDevicePath
!= NULL
) {
1272 CoreFreePool (Image
->LoadedImageDevicePath
);
1275 if (Image
->FixupData
!= NULL
) {
1276 CoreFreePool (Image
->FixupData
);
1279 CoreFreePool (Image
);
1287 IN EFI_HANDLE ImageHandle
,
1288 IN EFI_STATUS Status
,
1289 IN UINTN ExitDataSize
,
1290 IN CHAR16
*ExitData OPTIONAL
1294 Routine Description:
1296 Terminates the currently loaded EFI image and returns control to boot services.
1300 ImageHandle - Handle that identifies the image. This parameter is passed to the image
1302 Status - The image's exit code.
1303 ExitDataSize - The size, in bytes, of ExitData. Ignored if ExitStatus is
1305 ExitData - Pointer to a data buffer that includes a Null-terminated Unicode string,
1306 optionally followed by additional binary data. The string is a
1307 description that the caller may use to further indicate the reason for
1312 EFI_INVALID_PARAMETER - Image handle is NULL or it is not current image.
1314 EFI_SUCCESS - Successfully terminates the currently loaded EFI image.
1316 EFI_ACCESS_DENIED - Should never reach there.
1318 EFI_OUT_OF_RESOURCES - Could not allocate pool
1322 LOADED_IMAGE_PRIVATE_DATA
*Image
;
1326 // Prevent possible reentrance to this function
1327 // for the same ImageHandle
1329 OldTpl
= CoreRaiseTpl (TPL_NOTIFY
);
1331 Image
= CoreLoadedImageInfo (ImageHandle
);
1332 if (Image
== NULL_HANDLE
) {
1333 Status
= EFI_INVALID_PARAMETER
;
1337 if (!Image
->Started
) {
1339 // The image has not been started so just free its resources
1341 CoreUnloadAndCloseImage (Image
, TRUE
);
1342 Status
= EFI_SUCCESS
;
1347 // Image has been started, verify this image can exit
1349 if (Image
!= mCurrentImage
) {
1350 DEBUG ((EFI_D_LOAD
|EFI_D_ERROR
, "Exit: Image is not exitable image\n"));
1351 Status
= EFI_INVALID_PARAMETER
;
1358 Image
->Status
= Status
;
1361 // If there's ExitData info, move it
1363 if (ExitData
!= NULL
) {
1364 Image
->ExitDataSize
= ExitDataSize
;
1365 Image
->ExitData
= CoreAllocateBootServicesPool (Image
->ExitDataSize
);
1366 if (Image
->ExitData
== NULL
) {
1367 Status
= EFI_OUT_OF_RESOURCES
;
1370 CopyMem (Image
->ExitData
, ExitData
, Image
->ExitDataSize
);
1373 CoreRestoreTpl (OldTpl
);
1375 // return to StartImage
1377 LongJump (Image
->JumpContext
, (UINTN
)-1);
1380 // If we return from LongJump, then it is an error
1383 Status
= EFI_ACCESS_DENIED
;
1385 CoreRestoreTpl (OldTpl
);
1394 IN EFI_HANDLE ImageHandle
1398 Routine Description:
1404 ImageHandle - Handle that identifies the image to be unloaded.
1408 EFI_SUCCESS - The image has been unloaded.
1409 EFI_UNSUPPORTED - The image has been sarted, and does not support unload.
1410 EFI_INVALID_PARAMPETER - ImageHandle is not a valid image handle.
1415 LOADED_IMAGE_PRIVATE_DATA
*Image
;
1419 // Prevent possible reentrance to this function
1420 // for the same ImageHandle
1422 OldTpl
= CoreRaiseTpl (TPL_NOTIFY
);
1424 Image
= CoreLoadedImageInfo (ImageHandle
);
1425 if (Image
== NULL
) {
1427 // The image handle is not valid
1429 Status
= EFI_INVALID_PARAMETER
;
1433 if (Image
->Started
) {
1435 // The image has been started, request it to unload.
1437 Status
= EFI_UNSUPPORTED
;
1438 if (Image
->Info
.Unload
!= NULL
) {
1439 Status
= Image
->Info
.Unload (ImageHandle
);
1444 // This Image hasn't been started, thus it can be unloaded
1446 Status
= EFI_SUCCESS
;
1450 if (!EFI_ERROR (Status
)) {
1452 // if the Image was not started or Unloaded O.K. then clean up
1454 CoreUnloadAndCloseImage (Image
, TRUE
);
1458 CoreRestoreTpl (OldTpl
);
1466 IN EFI_PE32_IMAGE_PROTOCOL
*This
,
1467 IN EFI_HANDLE ImageHandle
1471 Routine Description:
1473 Unload the specified image.
1477 This - Indicates the calling context.
1479 ImageHandle - The specified image handle.
1483 EFI_INVALID_PARAMETER - Image handle is NULL.
1485 EFI_UNSUPPORTED - Attempt to unload an unsupported image.
1487 EFI_SUCCESS - Image successfully unloaded.
1491 return CoreUnloadImage (ImageHandle
);