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.
40 EFI_PEI_PE_COFF_LOADER_PROTOCOL_INSTANCE mPeiEfiPeiPeCoffLoaderInstance
= {
42 SecNt32PeCoffGetImageInfo
,
43 SecNt32PeCoffLoadImage
,
44 SecNt32PeCoffRelocateImage
,
45 SecNt32PeCoffUnloadimage
52 EFI_PEI_PE_COFF_LOADER_PROTOCOL
*gPeiEfiPeiPeCoffLoader
= &mPeiEfiPeiPeCoffLoaderInstance
.PeCoff
;
54 NT_PEI_LOAD_FILE_PPI mSecNtLoadFilePpi
= { SecWinNtPeiLoadFile
};
56 PEI_NT_AUTOSCAN_PPI mSecNtAutoScanPpi
= { SecWinNtPeiAutoScan
};
58 PEI_NT_THUNK_PPI mSecWinNtThunkPpi
= { SecWinNtWinNtThunkAddress
};
60 EFI_PEI_PROGRESS_CODE_PPI mSecStatusCodePpi
= { SecPeiReportStatusCode
};
62 NT_FWH_PPI mSecFwhInformationPpi
= { SecWinNtFdAddress
};
65 EFI_PEI_PPI_DESCRIPTOR gPrivateDispatchTable
[] = {
67 EFI_PEI_PPI_DESCRIPTOR_PPI
,
68 &gEfiPeiPeCoffLoaderGuid
,
72 EFI_PEI_PPI_DESCRIPTOR_PPI
,
73 &gNtPeiLoadFilePpiGuid
,
77 EFI_PEI_PPI_DESCRIPTOR_PPI
,
78 &gPeiNtAutoScanPpiGuid
,
82 EFI_PEI_PPI_DESCRIPTOR_PPI
,
87 EFI_PEI_PPI_DESCRIPTOR_PPI
,
88 &gEfiPeiStatusCodePpiGuid
,
92 EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
,
94 &mSecFwhInformationPpi
100 // Default information about where the FD is located.
101 // This array gets filled in with information from EFI_FIRMWARE_VOLUMES
102 // EFI_FIRMWARE_VOLUMES is a Windows environment variable set by system.cmd.
103 // The number of array elements is allocated base on parsing
104 // EFI_FIRMWARE_VOLUMES and the memory is never freed.
106 UINTN gFdInfoCount
= 0;
110 // Array that supports seperate memory rantes.
111 // The memory ranges are set in system.cmd via the EFI_MEMORY_SIZE variable.
112 // The number of array elements is allocated base on parsing
113 // EFI_MEMORY_SIZE and the memory is never freed.
115 UINTN gSystemMemoryCount
= 0;
116 NT_SYSTEM_MEMORY
*gSystemMemory
;
119 UINTN mPdbNameModHandleArraySize
= 0;
120 PDB_NAME_TO_MOD_HANDLE
*mPdbNameModHandleArray
= NULL
;
135 Main entry point to SEC for WinNt. This is a Windows program
138 Argc - Number of command line arguments
139 Argv - Array of command line argument strings
140 Envp - Array of environmemt variable strings
149 EFI_PHYSICAL_ADDRESS InitialStackMemory
;
150 UINT64 InitialStackMemorySize
;
159 CHAR16
*MemorySizeStr
;
160 CHAR16
*FirmwareVolumesStr
;
162 MemorySizeStr
= (CHAR16
*)PcdGetPtr (PcdWinNtMemorySizeForSecMain
);
163 FirmwareVolumesStr
= (CHAR16
*)PcdGetPtr (PcdWinNtFirmwareVolume
);
165 printf ("\nEDK SEC Main NT Emulation Environment from www.TianoCore.org\n");
168 // Make some Windows calls to Set the process to the highest priority in the
169 // idle class. We need this to have good performance.
171 SetPriorityClass (GetCurrentProcess (), IDLE_PRIORITY_CLASS
);
172 SetThreadPriority (GetCurrentThread (), THREAD_PRIORITY_HIGHEST
);
175 // Allocate space for gSystemMemory Array
177 gSystemMemoryCount
= CountSeperatorsInString (MemorySizeStr
, '!') + 1;
178 gSystemMemory
= calloc (gSystemMemoryCount
, sizeof (NT_SYSTEM_MEMORY
));
179 if (gSystemMemory
== NULL
) {
180 printf ("ERROR : Can not allocate memory for %s. Exiting.\n", MemorySizeStr
);
184 // Allocate space for gSystemMemory Array
186 gFdInfoCount
= CountSeperatorsInString (FirmwareVolumesStr
, '!') + 1;
187 gFdInfo
= calloc (gFdInfoCount
, sizeof (NT_FD_INFO
));
188 if (gFdInfo
== NULL
) {
189 printf ("ERROR : Can not allocate memory for %s. Exiting.\n", FirmwareVolumesStr
);
193 // Setup Boot Mode. If BootModeStr == "" then BootMode = 0 (BOOT_WITH_FULL_CONFIGURATION)
195 printf (" BootMode 0x%02x\n", FixedPcdGet32 (PcdWinNtBootMode
));
198 // Open up a 128K file to emulate temp memory for PEI.
199 // on a real platform this would be SRAM, or using the cache as RAM.
200 // Set InitialStackMemory to zero so WinNtOpenFile will allocate a new mapping
202 InitialStackMemory
= 0;
203 InitialStackMemorySize
= 0x20000;
204 Status
= WinNtOpenFile (
206 (UINT32
) InitialStackMemorySize
,
209 &InitialStackMemorySize
211 if (EFI_ERROR (Status
)) {
212 printf ("ERROR : Can not open SecStack Exiting\n");
216 printf (" SEC passing in %d bytes of temp RAM to PEI\n", InitialStackMemorySize
);
219 // Open All the firmware volumes and remember the info in the gFdInfo global
221 FileNamePtr
= (CHAR16
*)malloc (StrLen ((CHAR16
*)FirmwareVolumesStr
) * sizeof(CHAR16
));
222 if (FileNamePtr
== NULL
) {
223 printf ("ERROR : Can not allocate memory for firmware volume string\n");
227 StrCpy (FileNamePtr
, (CHAR16
*)FirmwareVolumesStr
);
229 for (Done
= FALSE
, Index
= 0, PeiIndex
= 0, PeiCoreFile
= NULL
; !Done
; Index
++) {
230 FileName
= FileNamePtr
;
231 for (Index1
= 0; (FileNamePtr
[Index1
] != '!') && (FileNamePtr
[Index1
] != 0); Index1
++)
233 if (FileNamePtr
[Index1
] == 0) {
236 FileNamePtr
[Index1
] = '\0';
237 FileNamePtr
= FileNamePtr
+ Index1
+ 1;
241 // Open the FD and remmeber where it got mapped into our processes address space
243 Status
= WinNtOpenFile (
247 &gFdInfo
[Index
].Address
,
250 if (EFI_ERROR (Status
)) {
251 printf ("ERROR : Can not open Firmware Device File %S (%r). Exiting.\n", FileName
, Status
);
255 printf (" FD loaded from");
257 // printf can't print filenames directly as the \ gets interperted as an
260 for (Index2
= 0; FileName
[Index2
] != '\0'; Index2
++) {
261 printf ("%c", FileName
[Index2
]);
264 if (PeiCoreFile
== NULL
) {
266 // Assume the beginning of the FD is an FV and look for the PEI Core.
267 // Load the first one we find.
269 Status
= SecFfsFindPeiCore ((EFI_FIRMWARE_VOLUME_HEADER
*) (UINTN
) gFdInfo
[Index
].Address
, &PeiCoreFile
);
270 if (!EFI_ERROR (Status
)) {
272 printf (" contains SEC Core");
279 // Calculate memory regions and store the information in the gSystemMemory
280 // global for later use. The autosizing code will use this data to
281 // map this memory into the SEC process memory space.
283 for (Index
= 0, Done
= FALSE
; !Done
; Index
++) {
285 // Save the size of the memory and make a Unicode filename SystemMemory00, ...
287 gSystemMemory
[Index
].Size
= _wtoi (MemorySizeStr
) * 0x100000;
288 _snwprintf (gSystemMemory
[Index
].FileName
, NT_SYSTEM_MEMORY_FILENAME_SIZE
, L
"SystemMemory%02d", Index
);
291 // Find the next region
293 for (Index1
= 0; MemorySizeStr
[Index1
] != '!' && MemorySizeStr
[Index1
] != 0; Index1
++)
295 if (MemorySizeStr
[Index1
] == 0) {
299 MemorySizeStr
= MemorySizeStr
+ Index1
+ 1;
305 // Hand off to PEI Core
307 SecLoadFromCore ((UINTN
) InitialStackMemory
, (UINTN
) InitialStackMemorySize
, (UINTN
) gFdInfo
[0].Address
, PeiCoreFile
);
310 // If we get here, then the PEI Core returned. This is an error as PEI should
311 // always hand off to DXE.
313 printf ("ERROR : PEI Core returned\n");
321 IN DWORD CreationDisposition
,
322 IN OUT EFI_PHYSICAL_ADDRESS
*BaseAddress
,
328 Opens and memory maps a file using WinNt services. If BaseAddress is non zero
329 the process will try and allocate the memory starting at BaseAddress.
332 FileName - The name of the file to open and map
333 MapSize - The amount of the file to map in bytes
334 CreationDisposition - The flags to pass to CreateFile(). Use to create new files for
335 memory emulation, and exiting files for firmware volume emulation
336 BaseAddress - The base address of the mapped file in the user address space.
337 If passed in as NULL the a new memory region is used.
338 If passed in as non NULL the request memory region is used for
339 the mapping of the file into the process space.
340 Length - The size of the mapped region in bytes
343 EFI_SUCCESS - The file was opened and mapped.
344 EFI_NOT_FOUND - FileName was not found in the current directory
345 EFI_DEVICE_ERROR - An error occured attempting to map the opened file
351 VOID
*VirtualAddress
;
355 // Use Win API to open/create a file
357 NtFileHandle
= CreateFile (
359 GENERIC_READ
| GENERIC_WRITE
,
363 FILE_ATTRIBUTE_NORMAL
,
366 if (NtFileHandle
== INVALID_HANDLE_VALUE
) {
367 return EFI_NOT_FOUND
;
370 // Map the open file into a memory range
372 NtMapHandle
= CreateFileMapping (
380 if (NtMapHandle
== NULL
) {
381 return EFI_DEVICE_ERROR
;
384 // Get the virtual address (address in the emulator) of the mapped file
386 VirtualAddress
= MapViewOfFileEx (
392 (LPVOID
) (UINTN
) *BaseAddress
394 if (VirtualAddress
== NULL
) {
395 return EFI_DEVICE_ERROR
;
400 // Seek to the end of the file to figure out the true file size.
402 FileSize
= SetFilePointer (
408 if (FileSize
== -1) {
409 return EFI_DEVICE_ERROR
;
412 *Length
= (UINT64
) FileSize
;
414 *Length
= (UINT64
) MapSize
;
417 *BaseAddress
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) VirtualAddress
;
422 #define BYTES_PER_RECORD 512
426 SecPeiReportStatusCode (
427 IN EFI_PEI_SERVICES
**PeiServices
,
428 IN EFI_STATUS_CODE_TYPE CodeType
,
429 IN EFI_STATUS_CODE_VALUE Value
,
431 IN EFI_GUID
* CallerId
,
432 IN EFI_STATUS_CODE_DATA
* Data OPTIONAL
438 This routine produces the ReportStatusCode PEI service. It's passed
439 up to the PEI Core via a PPI. T
441 This code currently uses the NT clib printf. This does not work the same way
442 as the EFI Print (), as %t, %g, %s as Unicode are not supported.
445 (see EFI_PEI_REPORT_STATUS_CODE)
448 EFI_SUCCESS - Always return success
451 // TODO: PeiServices - add argument and description to function comment
452 // TODO: CodeType - add argument and description to function comment
453 // TODO: Value - add argument and description to function comment
454 // TODO: Instance - add argument and description to function comment
455 // TODO: CallerId - add argument and description to function comment
456 // TODO: Data - add argument and description to function comment
459 EFI_DEBUG_INFO
*DebugInfo
;
461 CHAR8 PrintBuffer
[BYTES_PER_RECORD
* 2];
466 if ((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_DEBUG_CODE
) {
468 // This supports DEBUG () marcos
470 // EFI_STATUS_CODE_DATA
473 // The first 12 * UINT64 bytes of the string are really an
474 // arguement stack to support varargs on the Format string.
477 DebugInfo
= (EFI_DEBUG_INFO
*) (Data
+ 1);
478 Marker
= (VA_LIST
) (DebugInfo
+ 1);
479 Format
= (CHAR8
*) (((UINT64
*) Marker
) + 12);
481 AsciiVSPrint (PrintBuffer
, BYTES_PER_RECORD
, Format
, Marker
);
482 printf (PrintBuffer
);
484 printf ("DEBUG <null>\n");
488 if (((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) &&
489 ((CodeType
& EFI_STATUS_CODE_SEVERITY_MASK
) == EFI_ERROR_UNRECOVERED
)
491 if (Data
!= NULL
&& ReportStatusCodeExtractAssertInfo (CodeType
, Value
, Data
, &Filename
, &Description
, &LineNumber
)) {
493 // Support ASSERT () macro
495 printf ("ASSERT %s(%d): %s\n", Filename
, LineNumber
, Description
);
497 printf ("ASSERT <null>\n");
508 IN UINTN LargestRegion
,
509 IN UINTN LargestRegionSize
,
510 IN UINTN BootFirmwareVolumeBase
,
511 IN VOID
*PeiCorePe32File
516 This is the service to load the PEI Core from the Firmware Volume
519 LargestRegion - Memory to use for PEI.
520 LargestRegionSize - Size of Memory to use for PEI
521 BootFirmwareVolumeBase - Start of the Boot FV
522 PeiCorePe32File - PEI Core PE32
525 Success means control is transfered and thus we should never return
530 EFI_PHYSICAL_ADDRESS TopOfMemory
;
533 EFI_PHYSICAL_ADDRESS PeiCoreEntryPoint
;
534 EFI_PHYSICAL_ADDRESS PeiImageAddress
;
535 EFI_PEI_STARTUP_DESCRIPTOR
*PeiStartup
;
538 // Compute Top Of Memory for Stack and PEI Core Allocations
540 TopOfMemory
= LargestRegion
+ ((LargestRegionSize
) & (~15));
543 // Allocate 128KB for the Stack
545 TopOfStack
= (VOID
*) (UINTN
) (TopOfMemory
- sizeof (EFI_PEI_STARTUP_DESCRIPTOR
));
546 TopOfMemory
= TopOfMemory
- STACK_SIZE
;
549 // Patch value in dispatch table values
551 gPrivateDispatchTable
[0].Ppi
= gPeiEfiPeiPeCoffLoader
;
554 // Bind this information into the SEC hand-off state
556 PeiStartup
= (EFI_PEI_STARTUP_DESCRIPTOR
*) (UINTN
) TopOfStack
;
557 PeiStartup
->DispatchTable
= (EFI_PEI_PPI_DESCRIPTOR
*) &gPrivateDispatchTable
;
558 PeiStartup
->SizeOfCacheAsRam
= STACK_SIZE
;
559 PeiStartup
->BootFirmwareVolume
= BootFirmwareVolumeBase
;
562 // Load the PEI Core from a Firmware Volume
564 Status
= SecWinNtPeiLoadFile (
570 if (EFI_ERROR (Status
)) {
574 // Transfer control to the PEI Core
577 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) PeiCoreEntryPoint
,
583 // If we get here, then the PEI Core returned. This is an error
590 SecWinNtPeiAutoScan (
592 OUT EFI_PHYSICAL_ADDRESS
*MemoryBase
,
593 OUT UINT64
*MemorySize
598 This service is called from Index == 0 until it returns EFI_UNSUPPORTED.
599 It allows discontiguous memory regions to be supported by the emulator.
600 It uses gSystemMemory[] and gSystemMemoryCount that were created by
601 parsing the Windows environment variable EFI_MEMORY_SIZE.
602 The size comes from the varaible and the address comes from the call to
606 Index - Which memory region to use
607 MemoryBase - Return Base address of memory region
608 MemorySize - Return size in bytes of the memory region
611 EFI_SUCCESS - If memory region was mapped
612 EFI_UNSUPPORTED - If Index is not supported
618 if (Index
>= gSystemMemoryCount
) {
619 return EFI_UNSUPPORTED
;
623 Status
= WinNtOpenFile (
624 gSystemMemory
[Index
].FileName
,
625 (UINT32
) gSystemMemory
[Index
].Size
,
631 gSystemMemory
[Index
].Memory
= *MemoryBase
;
638 SecWinNtWinNtThunkAddress (
644 Since the SEC is the only Windows program in stack it must export
645 an interface to do Win API calls. That's what the WinNtThunk address
646 is for. gWinNt is initailized in WinNtThunk.c.
649 InterfaceSize - sizeof (EFI_WIN_NT_THUNK_PROTOCOL);
650 InterfaceBase - Address of the gWinNt global
653 EFI_SUCCESS - Data returned
663 SecWinNtPeiLoadFile (
665 IN EFI_PHYSICAL_ADDRESS
*ImageAddress
,
666 IN UINT64
*ImageSize
,
667 IN EFI_PHYSICAL_ADDRESS
*EntryPoint
672 Loads and relocates a PE/COFF image into memory.
675 Pe32Data - The base address of the PE/COFF file that is to be loaded and relocated
676 ImageAddress - The base address of the relocated PE/COFF image
677 ImageSize - The size of the relocated PE/COFF image
678 EntryPoint - The entry point of the relocated PE/COFF image
681 EFI_SUCCESS - The file was loaded and relocated
682 EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file
687 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
689 ZeroMem (&ImageContext
, sizeof (ImageContext
));
690 ImageContext
.Handle
= Pe32Data
;
692 ImageContext
.ImageRead
= (PE_COFF_LOADER_READ_FILE
) SecImageRead
;
694 Status
= gPeiEfiPeiPeCoffLoader
->GetImageInfo (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
695 if (EFI_ERROR (Status
)) {
699 // Allocate space in NT (not emulator) memory. Extra space is for alignment
701 ImageContext
.ImageAddress
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) malloc ((UINTN
) (ImageContext
.ImageSize
+ (ImageContext
.SectionAlignment
* 2)));
702 if (ImageContext
.ImageAddress
== 0) {
703 return EFI_OUT_OF_RESOURCES
;
706 // Align buffer on section boundry
708 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
;
709 ImageContext
.ImageAddress
&= ~(ImageContext
.SectionAlignment
- 1);
711 Status
= gPeiEfiPeiPeCoffLoader
->LoadImage (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
712 if (EFI_ERROR (Status
)) {
716 Status
= gPeiEfiPeiPeCoffLoader
->RelocateImage (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
717 if (EFI_ERROR (Status
)) {
722 // BugBug: Flush Instruction Cache Here when CPU Lib is ready
725 *ImageAddress
= ImageContext
.ImageAddress
;
726 *ImageSize
= ImageContext
.ImageSize
;
727 *EntryPoint
= ImageContext
.EntryPoint
;
736 IN OUT EFI_PHYSICAL_ADDRESS
*FdBase
,
737 IN OUT UINT64
*FdSize
742 Return the FD Size and base address. Since the FD is loaded from a
743 file into Windows memory only the SEC will know it's address.
746 Index - Which FD, starts at zero.
747 FdSize - Size of the FD in bytes
748 FdBase - Start address of the FD. Assume it points to an FV Header
751 EFI_SUCCESS - Return the Base address and size of the FV
752 EFI_UNSUPPORTED - Index does nto map to an FD in the system
756 if (Index
>= gFdInfoCount
) {
757 return EFI_UNSUPPORTED
;
760 *FdBase
= gFdInfo
[Index
].Address
;
761 *FdSize
= gFdInfo
[Index
].Size
;
763 if (*FdBase
== 0 && *FdSize
== 0) {
764 return EFI_UNSUPPORTED
;
775 IN OUT UINTN
*ReadSize
,
781 Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
784 FileHandle - The handle to the PE/COFF file
785 FileOffset - The offset, in bytes, into the file to read
786 ReadSize - The number of bytes to read from the file starting at FileOffset
787 Buffer - A pointer to the buffer to read the data into.
790 EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
798 Destination8
= Buffer
;
799 Source8
= (CHAR8
*) ((UINTN
) FileHandle
+ FileOffset
);
802 *(Destination8
++) = *(Source8
++);
811 IN UINTN
*StrLen OPTIONAL
816 Convert the passed in Ascii string to Unicode.
817 Optionally return the length of the strings.
820 Ascii - Ascii string to convert
821 StrLen - Length of string
824 Pointer to malloc'ed Unicode version of Ascii
832 // Allocate a buffer for unicode string
834 for (Index
= 0; Ascii
[Index
] != '\0'; Index
++)
836 Unicode
= malloc ((Index
+ 1) * sizeof (CHAR16
));
837 if (Unicode
== NULL
) {
841 for (Index
= 0; Ascii
[Index
] != '\0'; Index
++) {
842 Unicode
[Index
] = (CHAR16
) Ascii
[Index
];
845 Unicode
[Index
] = '\0';
847 if (StrLen
!= NULL
) {
855 CountSeperatorsInString (
856 IN
const CHAR16
*String
,
862 Count the number of seperators in String
865 String - String to process
866 Seperator - Item to count
869 Number of Seperator in String
875 for (Count
= 0; *String
!= '\0'; String
++) {
876 if (*String
== Seperator
) {
887 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
893 Store the ModHandle in an array indexed by the Pdb File name.
894 The ModHandle is needed to unload the image.
897 ImageContext - Input data returned from PE Laoder Library. Used to find the
898 .PDB file name of the PE Image.
899 ModHandle - Returned from LoadLibraryEx() and stored for call to
903 EFI_SUCCESS - ModHandle was stored.
908 PDB_NAME_TO_MOD_HANDLE
*Array
;
912 Array
= mPdbNameModHandleArray
;
913 for (Index
= 0; Index
< mPdbNameModHandleArraySize
; Index
++, Array
++) {
914 if (Array
->PdbPointer
== NULL
) {
916 // Make a copy of the stirng and store the ModHandle
918 Array
->PdbPointer
= malloc (strlen (ImageContext
->PdbPointer
) + 1);
919 ASSERT (Array
->PdbPointer
!= NULL
);
921 strcpy (Array
->PdbPointer
, ImageContext
->PdbPointer
);
922 Array
->ModHandle
= ModHandle
;
928 // No free space in mPdbNameModHandleArray so grow it by
929 // MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE entires. realloc will
930 // copy the old values to the new locaiton. But it does
931 // not zero the new memory area.
933 PreviousSize
= mPdbNameModHandleArraySize
* sizeof (PDB_NAME_TO_MOD_HANDLE
);
934 mPdbNameModHandleArraySize
+= MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE
;
936 mPdbNameModHandleArray
= realloc (mPdbNameModHandleArray
, mPdbNameModHandleArraySize
* sizeof (PDB_NAME_TO_MOD_HANDLE
));
937 if (mPdbNameModHandleArray
== NULL
) {
939 return EFI_OUT_OF_RESOURCES
;
942 memset (mPdbNameModHandleArray
+ PreviousSize
, 0, MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE
* sizeof (PDB_NAME_TO_MOD_HANDLE
));
944 return AddModHandle (ImageContext
, ModHandle
);
950 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
955 Return the ModHandle and delete the entry in the array.
958 ImageContext - Input data returned from PE Laoder Library. Used to find the
959 .PDB file name of the PE Image.
962 ModHandle - ModHandle assoicated with ImageContext is returned
963 NULL - No ModHandle associated with ImageContext
968 PDB_NAME_TO_MOD_HANDLE
*Array
;
970 if (ImageContext
->PdbPointer
== NULL
) {
972 // If no PDB pointer there is no ModHandle so return NULL
977 Array
= mPdbNameModHandleArray
;
978 for (Index
= 0; Index
< mPdbNameModHandleArraySize
; Index
++, Array
++) {
979 if ((Array
->PdbPointer
!= NULL
) && (strcmp(Array
->PdbPointer
, ImageContext
->PdbPointer
) == 0)) {
981 // If you find a match return it and delete the entry
983 free (Array
->PdbPointer
);
984 Array
->PdbPointer
= NULL
;
985 return Array
->ModHandle
;
996 SecNt32PeCoffGetImageInfo (
997 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
998 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1003 Status
= PeCoffLoaderGetImageInfo (ImageContext
);
1004 if (EFI_ERROR (Status
)) {
1008 switch (ImageContext
->ImageType
) {
1010 case EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
:
1011 ImageContext
->ImageCodeMemoryType
= EfiLoaderCode
;
1012 ImageContext
->ImageDataMemoryType
= EfiLoaderData
;
1015 case EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER
:
1016 ImageContext
->ImageCodeMemoryType
= EfiBootServicesCode
;
1017 ImageContext
->ImageDataMemoryType
= EfiBootServicesData
;
1020 case EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
:
1021 case EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER
:
1022 ImageContext
->ImageCodeMemoryType
= EfiRuntimeServicesCode
;
1023 ImageContext
->ImageDataMemoryType
= EfiRuntimeServicesData
;
1027 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_SUBSYSTEM
;
1028 return RETURN_UNSUPPORTED
;
1036 SecNt32PeCoffLoadImage (
1037 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1038 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1043 Status
= PeCoffLoaderLoadImage (ImageContext
);
1049 SecNt32PeCoffRelocateImage (
1050 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1051 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1055 VOID
*DllEntryPoint
;
1056 CHAR16
*DllFileName
;
1061 Status
= PeCoffLoaderRelocateImage (ImageContext
);
1062 if (EFI_ERROR (Status
)) {
1064 // We could not relocated the image in memory properly
1070 // If we load our own PE COFF images the Windows debugger can not source
1071 // level debug our code. If a valid PDB pointer exists usw it to load
1072 // the *.dll file as a library using Windows* APIs. This allows
1073 // source level debug. The image is still loaded and reloaced
1074 // in the Framework memory space like on a real system (by the code above),
1075 // but the entry point points into the DLL loaded by the code bellow.
1078 DllEntryPoint
= NULL
;
1081 // Load the DLL if it's not an EBC image.
1083 if ((ImageContext
->PdbPointer
!= NULL
) &&
1084 (ImageContext
->Machine
!= EFI_IMAGE_MACHINE_EBC
)) {
1086 // Convert filename from ASCII to Unicode
1088 DllFileName
= AsciiToUnicode (ImageContext
->PdbPointer
, &Index
);
1091 // Check that we have a valid filename
1093 if (Index
< 5 || DllFileName
[Index
- 4] != '.') {
1097 // Never return an error if PeCoffLoaderRelocateImage() succeeded.
1098 // The image will run, but we just can't source level debug. If we
1099 // return an error the image will not run.
1104 // Replace .PDB with .DLL on the filename
1106 DllFileName
[Index
- 3] = 'D';
1107 DllFileName
[Index
- 2] = 'L';
1108 DllFileName
[Index
- 1] = 'L';
1111 // Load the .DLL file into the user process's address space for source
1114 Library
= LoadLibraryEx (DllFileName
, NULL
, DONT_RESOLVE_DLL_REFERENCES
);
1115 if (Library
!= NULL
) {
1117 // InitializeDriver is the entry point we put in all our EFI DLL's. The
1118 // DONT_RESOLVE_DLL_REFERENCES argument to LoadLIbraryEx() supresses the
1119 // normal DLL entry point of DllMain, and prevents other modules that are
1120 // referenced in side the DllFileName from being loaded. There is no error
1121 // checking as the we can point to the PE32 image loaded by Tiano. This
1122 // step is only needed for source level debuging
1124 DllEntryPoint
= (VOID
*) (UINTN
) GetProcAddress (Library
, "InitializeDriver");
1128 if ((Library
!= NULL
) && (DllEntryPoint
!= NULL
)) {
1129 AddModHandle (ImageContext
, Library
);
1130 ImageContext
->EntryPoint
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) DllEntryPoint
;
1131 wprintf (L
"LoadLibraryEx (%s,\n NULL, DONT_RESOLVE_DLL_REFERENCES)\n", DllFileName
);
1133 wprintf (L
"WARNING: No source level debug %s. \n", DllFileName
);
1140 // Never return an error if PeCoffLoaderRelocateImage() succeeded.
1141 // The image will run, but we just can't source level debug. If we
1142 // return an error the image will not run.
1150 SecNt32PeCoffUnloadimage (
1151 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1152 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1157 ModHandle
= RemoveModeHandle (ImageContext
);
1158 if (ModHandle
!= NULL
) {
1159 FreeLibrary (ModHandle
);