3 Copyright (c) 2006, 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.
17 WinNt emulator of SEC phase. It's really a Win32 application, but this is
18 Ok since all the other modules for NT32 are NOT Win32 applications.
20 This program processes Windows environment variables and figures out
21 what the memory layout will be, how may FD's will be loaded and also
22 what the boot mode is.
24 The SEC registers a set of services with the SEC core. gPrivateDispatchTable
25 is a list of PPI's produced by the SEC that are availble for usage in PEI.
27 This code produces 128 K of temporary memory for the PEI stack by opening a
28 Windows file and mapping it directly to memory addresses.
30 The system.cmd script is used to set windows environment variables that drive
31 the configuration opitons of the SEC.
41 EFI_PEI_PE_COFF_LOADER_PROTOCOL_INSTANCE mPeiEfiPeiPeCoffLoaderInstance
= {
43 SecNt32PeCoffGetImageInfo
,
44 SecNt32PeCoffLoadImage
,
45 SecNt32PeCoffRelocateImage
,
46 SecNt32PeCoffUnloadimage
53 EFI_PEI_PE_COFF_LOADER_PROTOCOL
*gPeiEfiPeiPeCoffLoader
= &mPeiEfiPeiPeCoffLoaderInstance
.PeCoff
;
55 NT_PEI_LOAD_FILE_PPI mSecNtLoadFilePpi
= { SecWinNtPeiLoadFile
};
57 PEI_NT_AUTOSCAN_PPI mSecNtAutoScanPpi
= { SecWinNtPeiAutoScan
};
59 PEI_NT_THUNK_PPI mSecWinNtThunkPpi
= { SecWinNtWinNtThunkAddress
};
61 EFI_PEI_PROGRESS_CODE_PPI mSecStatusCodePpi
= { SecPeiReportStatusCode
};
63 NT_FWH_PPI mSecFwhInformationPpi
= { SecWinNtFdAddress
};
66 EFI_PEI_PPI_DESCRIPTOR gPrivateDispatchTable
[] = {
68 EFI_PEI_PPI_DESCRIPTOR_PPI
,
69 &gEfiPeiPeCoffLoaderGuid
,
73 EFI_PEI_PPI_DESCRIPTOR_PPI
,
74 &gNtPeiLoadFilePpiGuid
,
78 EFI_PEI_PPI_DESCRIPTOR_PPI
,
79 &gPeiNtAutoScanPpiGuid
,
83 EFI_PEI_PPI_DESCRIPTOR_PPI
,
88 EFI_PEI_PPI_DESCRIPTOR_PPI
,
89 &gEfiPeiStatusCodePpiGuid
,
93 EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
,
95 &mSecFwhInformationPpi
101 // Default information about where the FD is located.
102 // This array gets filled in with information from EFI_FIRMWARE_VOLUMES
103 // EFI_FIRMWARE_VOLUMES is a Windows environment variable set by system.cmd.
104 // The number of array elements is allocated base on parsing
105 // EFI_FIRMWARE_VOLUMES and the memory is never freed.
107 UINTN gFdInfoCount
= 0;
111 // Array that supports seperate memory rantes.
112 // The memory ranges are set in system.cmd via the EFI_MEMORY_SIZE variable.
113 // The number of array elements is allocated base on parsing
114 // EFI_MEMORY_SIZE and the memory is never freed.
116 UINTN gSystemMemoryCount
= 0;
117 NT_SYSTEM_MEMORY
*gSystemMemory
;
120 UINTN mPdbNameModHandleArraySize
= 0;
121 PDB_NAME_TO_MOD_HANDLE
*mPdbNameModHandleArray
= NULL
;
136 Main entry point to SEC for WinNt. This is a Windows program
139 Argc - Number of command line arguments
140 Argv - Array of command line argument strings
141 Envp - Array of environmemt variable strings
150 EFI_PHYSICAL_ADDRESS InitialStackMemory
;
151 UINT64 InitialStackMemorySize
;
160 CHAR16
*MemorySizeStr
;
161 CHAR16
*FirmwareVolumesStr
;
163 MemorySizeStr
= (CHAR16
*)L
"64!64";
164 FirmwareVolumesStr
= (CHAR16
*)L
"..\\Fv\\Fv_Recovery.fd";
166 printf ("\nEDK SEC Main NT Emulation Environment from www.TianoCore.org\n");
169 // Make some Windows calls to Set the process to the highest priority in the
170 // idle class. We need this to have good performance.
172 SetPriorityClass (GetCurrentProcess (), IDLE_PRIORITY_CLASS
);
173 SetThreadPriority (GetCurrentThread (), THREAD_PRIORITY_HIGHEST
);
176 // Allocate space for gSystemMemory Array
178 gSystemMemoryCount
= CountSeperatorsInString (MemorySizeStr
, '!') + 1;
179 gSystemMemory
= calloc (gSystemMemoryCount
, sizeof (NT_SYSTEM_MEMORY
));
180 if (gSystemMemory
== NULL
) {
181 printf ("ERROR : Can not allocate memory for %s. Exiting.\n", MemorySizeStr
);
185 // Allocate space for gSystemMemory Array
187 gFdInfoCount
= CountSeperatorsInString (FirmwareVolumesStr
, '!') + 1;
188 gFdInfo
= calloc (gFdInfoCount
, sizeof (NT_FD_INFO
));
189 if (gFdInfo
== NULL
) {
190 printf ("ERROR : Can not allocate memory for %s. Exiting.\n", FirmwareVolumesStr
);
194 // Setup Boot Mode. If BootModeStr == "" then BootMode = 0 (BOOT_WITH_FULL_CONFIGURATION)
196 printf (" BootMode 0x%02x\n", FixedPcdGet32 (PcdWinNtBootMode
));
199 // Open up a 128K file to emulate temp memory for PEI.
200 // on a real platform this would be SRAM, or using the cache as RAM.
201 // Set InitialStackMemory to zero so WinNtOpenFile will allocate a new mapping
203 InitialStackMemory
= 0;
204 InitialStackMemorySize
= 0x20000;
205 Status
= WinNtOpenFile (
207 (UINT32
) InitialStackMemorySize
,
210 &InitialStackMemorySize
212 if (EFI_ERROR (Status
)) {
213 printf ("ERROR : Can not open SecStack Exiting\n");
217 printf (" SEC passing in %d bytes of temp RAM to PEI\n", InitialStackMemorySize
);
220 // Open All the firmware volumes and remember the info in the gFdInfo global
222 FileNamePtr
= (CHAR16
*)malloc (StrLen ((CHAR16
*)FirmwareVolumesStr
) * sizeof(CHAR16
));
223 if (FileNamePtr
== NULL
) {
224 printf ("ERROR : Can not allocate memory for firmware volume string\n");
228 StrCpy (FileNamePtr
, (CHAR16
*)FirmwareVolumesStr
);
230 for (Done
= FALSE
, Index
= 0, PeiIndex
= 0, PeiCoreFile
= NULL
; !Done
; Index
++) {
231 FileName
= FileNamePtr
;
232 for (Index1
= 0; (FileNamePtr
[Index1
] != '!') && (FileNamePtr
[Index1
] != 0); Index1
++)
234 if (FileNamePtr
[Index1
] == 0) {
237 FileNamePtr
[Index1
] = '\0';
238 FileNamePtr
= FileNamePtr
+ Index1
+ 1;
242 // Open the FD and remmeber where it got mapped into our processes address space
244 Status
= WinNtOpenFile (
248 &gFdInfo
[Index
].Address
,
251 if (EFI_ERROR (Status
)) {
252 printf ("ERROR : Can not open Firmware Device File %S (%r). Exiting.\n", FileName
, Status
);
256 printf (" FD loaded from");
258 // printf can't print filenames directly as the \ gets interperted as an
261 for (Index2
= 0; FileName
[Index2
] != '\0'; Index2
++) {
262 printf ("%c", FileName
[Index2
]);
265 if (PeiCoreFile
== NULL
) {
267 // Assume the beginning of the FD is an FV and look for the PEI Core.
268 // Load the first one we find.
270 Status
= SecFfsFindPeiCore ((EFI_FIRMWARE_VOLUME_HEADER
*) (UINTN
) gFdInfo
[Index
].Address
, &PeiCoreFile
);
271 if (!EFI_ERROR (Status
)) {
273 printf (" contains SEC Core");
280 // Calculate memory regions and store the information in the gSystemMemory
281 // global for later use. The autosizing code will use this data to
282 // map this memory into the SEC process memory space.
284 for (Index
= 0, Done
= FALSE
; !Done
; Index
++) {
286 // Save the size of the memory and make a Unicode filename SystemMemory00, ...
288 gSystemMemory
[Index
].Size
= _wtoi (MemorySizeStr
) * 0x100000;
289 _snwprintf (gSystemMemory
[Index
].FileName
, NT_SYSTEM_MEMORY_FILENAME_SIZE
, L
"SystemMemory%02d", Index
);
292 // Find the next region
294 for (Index1
= 0; MemorySizeStr
[Index1
] != '!' && MemorySizeStr
[Index1
] != 0; Index1
++)
296 if (MemorySizeStr
[Index1
] == 0) {
300 MemorySizeStr
= MemorySizeStr
+ Index1
+ 1;
306 // Hand off to PEI Core
308 SecLoadFromCore ((UINTN
) InitialStackMemory
, (UINTN
) InitialStackMemorySize
, (UINTN
) gFdInfo
[0].Address
, PeiCoreFile
);
311 // If we get here, then the PEI Core returned. This is an error as PEI should
312 // always hand off to DXE.
314 printf ("ERROR : PEI Core returned\n");
322 IN DWORD CreationDisposition
,
323 IN OUT EFI_PHYSICAL_ADDRESS
*BaseAddress
,
329 Opens and memory maps a file using WinNt services. If BaseAddress is non zero
330 the process will try and allocate the memory starting at BaseAddress.
333 FileName - The name of the file to open and map
334 MapSize - The amount of the file to map in bytes
335 CreationDisposition - The flags to pass to CreateFile(). Use to create new files for
336 memory emulation, and exiting files for firmware volume emulation
337 BaseAddress - The base address of the mapped file in the user address space.
338 If passed in as NULL the a new memory region is used.
339 If passed in as non NULL the request memory region is used for
340 the mapping of the file into the process space.
341 Length - The size of the mapped region in bytes
344 EFI_SUCCESS - The file was opened and mapped.
345 EFI_NOT_FOUND - FileName was not found in the current directory
346 EFI_DEVICE_ERROR - An error occured attempting to map the opened file
352 VOID
*VirtualAddress
;
356 // Use Win API to open/create a file
358 NtFileHandle
= CreateFile (
360 GENERIC_READ
| GENERIC_WRITE
,
364 FILE_ATTRIBUTE_NORMAL
,
367 if (NtFileHandle
== INVALID_HANDLE_VALUE
) {
368 return EFI_NOT_FOUND
;
371 // Map the open file into a memory range
373 NtMapHandle
= CreateFileMapping (
381 if (NtMapHandle
== NULL
) {
382 return EFI_DEVICE_ERROR
;
385 // Get the virtual address (address in the emulator) of the mapped file
387 VirtualAddress
= MapViewOfFileEx (
393 (LPVOID
) (UINTN
) *BaseAddress
395 if (VirtualAddress
== NULL
) {
396 return EFI_DEVICE_ERROR
;
401 // Seek to the end of the file to figure out the true file size.
403 FileSize
= SetFilePointer (
409 if (FileSize
== -1) {
410 return EFI_DEVICE_ERROR
;
413 *Length
= (UINT64
) FileSize
;
415 *Length
= (UINT64
) MapSize
;
418 *BaseAddress
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) VirtualAddress
;
424 #define BYTES_PER_RECORD 512
428 SecPeiReportStatusCode (
429 IN EFI_PEI_SERVICES
**PeiServices
,
430 IN EFI_STATUS_CODE_TYPE CodeType
,
431 IN EFI_STATUS_CODE_VALUE Value
,
433 IN EFI_GUID
*CallerId
,
434 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
440 This routine produces the ReportStatusCode PEI service. It's passed
441 up to the PEI Core via a PPI. T
443 This code currently uses the NT clib printf. This does not work the same way
444 as the EFI Print (), as %t, %g, %s as Unicode are not supported.
447 (see EFI_PEI_REPORT_STATUS_CODE)
450 EFI_SUCCESS - Always return success
453 // TODO: PeiServices - add argument and description to function comment
454 // TODO: CodeType - add argument and description to function comment
455 // TODO: Value - add argument and description to function comment
456 // TODO: Instance - add argument and description to function comment
457 // TODO: CallerId - add argument and description to function comment
458 // TODO: Data - add argument and description to function comment
462 CHAR8 PrintBuffer
[BYTES_PER_RECORD
* 2];
470 } else if (ReportStatusCodeExtractAssertInfo (CodeType
, Value
, Data
, &Filename
, &Description
, &LineNumber
)) {
472 // Processes ASSERT ()
474 printf ("ASSERT %s(%d): %s\n", Filename
, LineNumber
, Description
);
476 } else if (ReportStatusCodeExtractDebugInfo (Data
, &ErrorLevel
, &Marker
, &Format
)) {
478 // Process DEBUG () macro
480 AsciiVSPrint (PrintBuffer
, BYTES_PER_RECORD
, Format
, Marker
);
481 printf (PrintBuffer
);
490 IN UINTN LargestRegion
,
491 IN UINTN LargestRegionSize
,
492 IN UINTN BootFirmwareVolumeBase
,
493 IN VOID
*PeiCorePe32File
498 This is the service to load the PEI Core from the Firmware Volume
501 LargestRegion - Memory to use for PEI.
502 LargestRegionSize - Size of Memory to use for PEI
503 BootFirmwareVolumeBase - Start of the Boot FV
504 PeiCorePe32File - PEI Core PE32
507 Success means control is transfered and thus we should never return
512 EFI_PHYSICAL_ADDRESS TopOfMemory
;
515 EFI_PHYSICAL_ADDRESS PeiCoreEntryPoint
;
516 EFI_PHYSICAL_ADDRESS PeiImageAddress
;
517 EFI_PEI_STARTUP_DESCRIPTOR
*PeiStartup
;
520 // Compute Top Of Memory for Stack and PEI Core Allocations
522 TopOfMemory
= LargestRegion
+ LargestRegionSize
;
525 // Allocate 128KB for the Stack
527 TopOfStack
= (VOID
*)((UINTN
)TopOfMemory
- sizeof (EFI_PEI_STARTUP_DESCRIPTOR
) - CPU_STACK_ALIGNMENT
);
528 TopOfStack
= ALIGN_POINTER (TopOfStack
, CPU_STACK_ALIGNMENT
);
529 TopOfMemory
= TopOfMemory
- STACK_SIZE
;
532 // Patch value in dispatch table values
534 gPrivateDispatchTable
[0].Ppi
= gPeiEfiPeiPeCoffLoader
;
537 // Bind this information into the SEC hand-off state
539 PeiStartup
= (EFI_PEI_STARTUP_DESCRIPTOR
*) (UINTN
) TopOfStack
;
540 PeiStartup
->DispatchTable
= (EFI_PEI_PPI_DESCRIPTOR
*) &gPrivateDispatchTable
;
541 PeiStartup
->SizeOfCacheAsRam
= STACK_SIZE
;
542 PeiStartup
->BootFirmwareVolume
= BootFirmwareVolumeBase
;
545 // Load the PEI Core from a Firmware Volume
547 Status
= SecWinNtPeiLoadFile (
553 if (EFI_ERROR (Status
)) {
557 // Transfer control to the PEI Core
560 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) PeiCoreEntryPoint
,
566 // If we get here, then the PEI Core returned. This is an error
573 SecWinNtPeiAutoScan (
575 OUT EFI_PHYSICAL_ADDRESS
*MemoryBase
,
576 OUT UINT64
*MemorySize
581 This service is called from Index == 0 until it returns EFI_UNSUPPORTED.
582 It allows discontiguous memory regions to be supported by the emulator.
583 It uses gSystemMemory[] and gSystemMemoryCount that were created by
584 parsing the Windows environment variable EFI_MEMORY_SIZE.
585 The size comes from the varaible and the address comes from the call to
589 Index - Which memory region to use
590 MemoryBase - Return Base address of memory region
591 MemorySize - Return size in bytes of the memory region
594 EFI_SUCCESS - If memory region was mapped
595 EFI_UNSUPPORTED - If Index is not supported
601 if (Index
>= gSystemMemoryCount
) {
602 return EFI_UNSUPPORTED
;
606 Status
= WinNtOpenFile (
607 gSystemMemory
[Index
].FileName
,
608 (UINT32
) gSystemMemory
[Index
].Size
,
614 gSystemMemory
[Index
].Memory
= *MemoryBase
;
621 SecWinNtWinNtThunkAddress (
627 Since the SEC is the only Windows program in stack it must export
628 an interface to do Win API calls. That's what the WinNtThunk address
629 is for. gWinNt is initailized in WinNtThunk.c.
632 InterfaceSize - sizeof (EFI_WIN_NT_THUNK_PROTOCOL);
633 InterfaceBase - Address of the gWinNt global
636 EFI_SUCCESS - Data returned
646 SecWinNtPeiLoadFile (
648 IN EFI_PHYSICAL_ADDRESS
*ImageAddress
,
649 IN UINT64
*ImageSize
,
650 IN EFI_PHYSICAL_ADDRESS
*EntryPoint
655 Loads and relocates a PE/COFF image into memory.
658 Pe32Data - The base address of the PE/COFF file that is to be loaded and relocated
659 ImageAddress - The base address of the relocated PE/COFF image
660 ImageSize - The size of the relocated PE/COFF image
661 EntryPoint - The entry point of the relocated PE/COFF image
664 EFI_SUCCESS - The file was loaded and relocated
665 EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file
670 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
672 ZeroMem (&ImageContext
, sizeof (ImageContext
));
673 ImageContext
.Handle
= Pe32Data
;
675 ImageContext
.ImageRead
= (PE_COFF_LOADER_READ_FILE
) SecImageRead
;
677 Status
= gPeiEfiPeiPeCoffLoader
->GetImageInfo (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
678 if (EFI_ERROR (Status
)) {
682 // Allocate space in NT (not emulator) memory. Extra space is for alignment
684 ImageContext
.ImageAddress
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) malloc ((UINTN
) (ImageContext
.ImageSize
+ (ImageContext
.SectionAlignment
* 2)));
685 if (ImageContext
.ImageAddress
== 0) {
686 return EFI_OUT_OF_RESOURCES
;
689 // Align buffer on section boundry
691 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
;
692 ImageContext
.ImageAddress
&= ~(ImageContext
.SectionAlignment
- 1);
694 Status
= gPeiEfiPeiPeCoffLoader
->LoadImage (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
695 if (EFI_ERROR (Status
)) {
699 Status
= gPeiEfiPeiPeCoffLoader
->RelocateImage (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
700 if (EFI_ERROR (Status
)) {
705 // BugBug: Flush Instruction Cache Here when CPU Lib is ready
708 *ImageAddress
= ImageContext
.ImageAddress
;
709 *ImageSize
= ImageContext
.ImageSize
;
710 *EntryPoint
= ImageContext
.EntryPoint
;
719 IN OUT EFI_PHYSICAL_ADDRESS
*FdBase
,
720 IN OUT UINT64
*FdSize
725 Return the FD Size and base address. Since the FD is loaded from a
726 file into Windows memory only the SEC will know it's address.
729 Index - Which FD, starts at zero.
730 FdSize - Size of the FD in bytes
731 FdBase - Start address of the FD. Assume it points to an FV Header
734 EFI_SUCCESS - Return the Base address and size of the FV
735 EFI_UNSUPPORTED - Index does nto map to an FD in the system
739 if (Index
>= gFdInfoCount
) {
740 return EFI_UNSUPPORTED
;
743 *FdBase
= gFdInfo
[Index
].Address
;
744 *FdSize
= gFdInfo
[Index
].Size
;
746 if (*FdBase
== 0 && *FdSize
== 0) {
747 return EFI_UNSUPPORTED
;
758 IN OUT UINTN
*ReadSize
,
764 Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
767 FileHandle - The handle to the PE/COFF file
768 FileOffset - The offset, in bytes, into the file to read
769 ReadSize - The number of bytes to read from the file starting at FileOffset
770 Buffer - A pointer to the buffer to read the data into.
773 EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
781 Destination8
= Buffer
;
782 Source8
= (CHAR8
*) ((UINTN
) FileHandle
+ FileOffset
);
785 *(Destination8
++) = *(Source8
++);
794 IN UINTN
*StrLen OPTIONAL
799 Convert the passed in Ascii string to Unicode.
800 Optionally return the length of the strings.
803 Ascii - Ascii string to convert
804 StrLen - Length of string
807 Pointer to malloc'ed Unicode version of Ascii
815 // Allocate a buffer for unicode string
817 for (Index
= 0; Ascii
[Index
] != '\0'; Index
++)
819 Unicode
= malloc ((Index
+ 1) * sizeof (CHAR16
));
820 if (Unicode
== NULL
) {
824 for (Index
= 0; Ascii
[Index
] != '\0'; Index
++) {
825 Unicode
[Index
] = (CHAR16
) Ascii
[Index
];
828 Unicode
[Index
] = '\0';
830 if (StrLen
!= NULL
) {
838 CountSeperatorsInString (
839 IN
const CHAR16
*String
,
845 Count the number of seperators in String
848 String - String to process
849 Seperator - Item to count
852 Number of Seperator in String
858 for (Count
= 0; *String
!= '\0'; String
++) {
859 if (*String
== Seperator
) {
870 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
876 Store the ModHandle in an array indexed by the Pdb File name.
877 The ModHandle is needed to unload the image.
880 ImageContext - Input data returned from PE Laoder Library. Used to find the
881 .PDB file name of the PE Image.
882 ModHandle - Returned from LoadLibraryEx() and stored for call to
886 EFI_SUCCESS - ModHandle was stored.
891 PDB_NAME_TO_MOD_HANDLE
*Array
;
895 Array
= mPdbNameModHandleArray
;
896 for (Index
= 0; Index
< mPdbNameModHandleArraySize
; Index
++, Array
++) {
897 if (Array
->PdbPointer
== NULL
) {
899 // Make a copy of the stirng and store the ModHandle
901 Array
->PdbPointer
= malloc (strlen (ImageContext
->PdbPointer
) + 1);
902 ASSERT (Array
->PdbPointer
!= NULL
);
904 strcpy (Array
->PdbPointer
, ImageContext
->PdbPointer
);
905 Array
->ModHandle
= ModHandle
;
911 // No free space in mPdbNameModHandleArray so grow it by
912 // MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE entires. realloc will
913 // copy the old values to the new locaiton. But it does
914 // not zero the new memory area.
916 PreviousSize
= mPdbNameModHandleArraySize
* sizeof (PDB_NAME_TO_MOD_HANDLE
);
917 mPdbNameModHandleArraySize
+= MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE
;
919 mPdbNameModHandleArray
= realloc (mPdbNameModHandleArray
, mPdbNameModHandleArraySize
* sizeof (PDB_NAME_TO_MOD_HANDLE
));
920 if (mPdbNameModHandleArray
== NULL
) {
922 return EFI_OUT_OF_RESOURCES
;
925 memset (mPdbNameModHandleArray
+ PreviousSize
, 0, MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE
* sizeof (PDB_NAME_TO_MOD_HANDLE
));
927 return AddModHandle (ImageContext
, ModHandle
);
933 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
938 Return the ModHandle and delete the entry in the array.
941 ImageContext - Input data returned from PE Laoder Library. Used to find the
942 .PDB file name of the PE Image.
945 ModHandle - ModHandle assoicated with ImageContext is returned
946 NULL - No ModHandle associated with ImageContext
951 PDB_NAME_TO_MOD_HANDLE
*Array
;
953 if (ImageContext
->PdbPointer
== NULL
) {
955 // If no PDB pointer there is no ModHandle so return NULL
960 Array
= mPdbNameModHandleArray
;
961 for (Index
= 0; Index
< mPdbNameModHandleArraySize
; Index
++, Array
++) {
962 if ((Array
->PdbPointer
!= NULL
) && (strcmp(Array
->PdbPointer
, ImageContext
->PdbPointer
) == 0)) {
964 // If you find a match return it and delete the entry
966 free (Array
->PdbPointer
);
967 Array
->PdbPointer
= NULL
;
968 return Array
->ModHandle
;
979 SecNt32PeCoffGetImageInfo (
980 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
981 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
986 Status
= PeCoffLoaderGetImageInfo (ImageContext
);
987 if (EFI_ERROR (Status
)) {
991 switch (ImageContext
->ImageType
) {
993 case EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
:
994 ImageContext
->ImageCodeMemoryType
= EfiLoaderCode
;
995 ImageContext
->ImageDataMemoryType
= EfiLoaderData
;
998 case EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER
:
999 ImageContext
->ImageCodeMemoryType
= EfiBootServicesCode
;
1000 ImageContext
->ImageDataMemoryType
= EfiBootServicesData
;
1003 case EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
:
1004 case EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER
:
1005 ImageContext
->ImageCodeMemoryType
= EfiRuntimeServicesCode
;
1006 ImageContext
->ImageDataMemoryType
= EfiRuntimeServicesData
;
1010 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_SUBSYSTEM
;
1011 return RETURN_UNSUPPORTED
;
1019 SecNt32PeCoffLoadImage (
1020 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1021 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1026 Status
= PeCoffLoaderLoadImage (ImageContext
);
1032 SecNt32PeCoffRelocateImage (
1033 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1034 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1038 VOID
*DllEntryPoint
;
1039 CHAR16
*DllFileName
;
1044 Status
= PeCoffLoaderRelocateImage (ImageContext
);
1045 if (EFI_ERROR (Status
)) {
1047 // We could not relocated the image in memory properly
1053 // If we load our own PE COFF images the Windows debugger can not source
1054 // level debug our code. If a valid PDB pointer exists usw it to load
1055 // the *.dll file as a library using Windows* APIs. This allows
1056 // source level debug. The image is still loaded and reloaced
1057 // in the Framework memory space like on a real system (by the code above),
1058 // but the entry point points into the DLL loaded by the code bellow.
1061 DllEntryPoint
= NULL
;
1064 // Load the DLL if it's not an EBC image.
1066 if ((ImageContext
->PdbPointer
!= NULL
) &&
1067 (ImageContext
->Machine
!= EFI_IMAGE_MACHINE_EBC
)) {
1069 // Convert filename from ASCII to Unicode
1071 DllFileName
= AsciiToUnicode (ImageContext
->PdbPointer
, &Index
);
1074 // Check that we have a valid filename
1076 if (Index
< 5 || DllFileName
[Index
- 4] != '.') {
1080 // Never return an error if PeCoffLoaderRelocateImage() succeeded.
1081 // The image will run, but we just can't source level debug. If we
1082 // return an error the image will not run.
1087 // Replace .PDB with .DLL on the filename
1089 DllFileName
[Index
- 3] = 'D';
1090 DllFileName
[Index
- 2] = 'L';
1091 DllFileName
[Index
- 1] = 'L';
1094 // Load the .DLL file into the user process's address space for source
1097 Library
= LoadLibraryEx (DllFileName
, NULL
, DONT_RESOLVE_DLL_REFERENCES
);
1098 if (Library
!= NULL
) {
1100 // InitializeDriver is the entry point we put in all our EFI DLL's. The
1101 // DONT_RESOLVE_DLL_REFERENCES argument to LoadLIbraryEx() supresses the
1102 // normal DLL entry point of DllMain, and prevents other modules that are
1103 // referenced in side the DllFileName from being loaded. There is no error
1104 // checking as the we can point to the PE32 image loaded by Tiano. This
1105 // step is only needed for source level debuging
1107 DllEntryPoint
= (VOID
*) (UINTN
) GetProcAddress (Library
, "InitializeDriver");
1111 if ((Library
!= NULL
) && (DllEntryPoint
!= NULL
)) {
1112 AddModHandle (ImageContext
, Library
);
1113 ImageContext
->EntryPoint
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) DllEntryPoint
;
1114 wprintf (L
"LoadLibraryEx (%s,\n NULL, DONT_RESOLVE_DLL_REFERENCES)\n", DllFileName
);
1116 wprintf (L
"WARNING: No source level debug %s. \n", DllFileName
);
1123 // Never return an error if PeCoffLoaderRelocateImage() succeeded.
1124 // The image will run, but we just can't source level debug. If we
1125 // return an error the image will not run.
1133 SecNt32PeCoffUnloadimage (
1134 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1135 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1140 ModHandle
= RemoveModeHandle (ImageContext
);
1141 if (ModHandle
!= NULL
) {
1142 FreeLibrary (ModHandle
);