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.
36 #pragma warning(disable : 4996)
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
*)PcdGetPtr (PcdWinNtMemorySizeForSecMain
);
164 FirmwareVolumesStr
= (CHAR16
*)PcdGetPtr (PcdWinNtFirmwareVolume
);
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
;
423 #define BYTES_PER_RECORD 512
426 Extracts ASSERT() information from a status code structure.
428 Converts the status code specified by CodeType, Value, and Data to the ASSERT()
429 arguments specified by Filename, Description, and LineNumber. If CodeType is
430 an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and
431 Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract
432 Filename, Description, and LineNumber from the optional data area of the
433 status code buffer specified by Data. The optional data area of Data contains
434 a Null-terminated ASCII string for the FileName, followed by a Null-terminated
435 ASCII string for the Description, followed by a 32-bit LineNumber. If the
436 ASSERT() information could be extracted from Data, then return TRUE.
437 Otherwise, FALSE is returned.
439 If Data is NULL, then ASSERT().
440 If Filename is NULL, then ASSERT().
441 If Description is NULL, then ASSERT().
442 If LineNumber is NULL, then ASSERT().
444 @param CodeType The type of status code being converted.
445 @param Value The status code value being converted.
446 @param Data Pointer to status code data buffer.
447 @param Filename Pointer to the source file name that generated the ASSERT().
448 @param Description Pointer to the description of the ASSERT().
449 @param LineNumber Pointer to source line number that generated the ASSERT().
451 @retval TRUE The status code specified by CodeType, Value, and Data was
452 converted ASSERT() arguments specified by Filename, Description,
454 @retval FALSE The status code specified by CodeType, Value, and Data could
455 not be converted to ASSERT() arguments.
460 ReportStatusCodeExtractAssertInfo (
461 IN EFI_STATUS_CODE_TYPE CodeType
,
462 IN EFI_STATUS_CODE_VALUE Value
,
463 IN CONST EFI_STATUS_CODE_DATA
*Data
,
464 OUT CHAR8
**Filename
,
465 OUT CHAR8
**Description
,
466 OUT UINT32
*LineNumber
469 EFI_DEBUG_ASSERT_DATA
*AssertData
;
471 ASSERT (Data
!= NULL
);
472 ASSERT (Filename
!= NULL
);
473 ASSERT (Description
!= NULL
);
474 ASSERT (LineNumber
!= NULL
);
476 if (((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) &&
477 ((CodeType
& EFI_STATUS_CODE_SEVERITY_MASK
) == EFI_ERROR_UNRECOVERED
) &&
478 ((Value
& EFI_STATUS_CODE_OPERATION_MASK
) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
)) {
479 AssertData
= (EFI_DEBUG_ASSERT_DATA
*)(Data
+ 1);
480 *Filename
= (CHAR8
*)(AssertData
+ 1);
481 *Description
= *Filename
+ AsciiStrLen (*Filename
) + 1;
482 *LineNumber
= AssertData
->LineNumber
;
490 SecPeiReportStatusCode (
491 IN EFI_PEI_SERVICES
**PeiServices
,
492 IN EFI_STATUS_CODE_TYPE CodeType
,
493 IN EFI_STATUS_CODE_VALUE Value
,
495 IN EFI_GUID
* CallerId
,
496 IN EFI_STATUS_CODE_DATA
* Data OPTIONAL
502 This routine produces the ReportStatusCode PEI service. It's passed
503 up to the PEI Core via a PPI. T
505 This code currently uses the NT clib printf. This does not work the same way
506 as the EFI Print (), as %t, %g, %s as Unicode are not supported.
509 (see EFI_PEI_REPORT_STATUS_CODE)
512 EFI_SUCCESS - Always return success
515 // TODO: PeiServices - add argument and description to function comment
516 // TODO: CodeType - add argument and description to function comment
517 // TODO: Value - add argument and description to function comment
518 // TODO: Instance - add argument and description to function comment
519 // TODO: CallerId - add argument and description to function comment
520 // TODO: Data - add argument and description to function comment
523 EFI_DEBUG_INFO
*DebugInfo
;
525 CHAR8 PrintBuffer
[BYTES_PER_RECORD
* 2];
530 if ((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_DEBUG_CODE
) {
532 // This supports DEBUG () marcos
534 // EFI_STATUS_CODE_DATA
537 // The first 12 * UINT64 bytes of the string are really an
538 // arguement stack to support varargs on the Format string.
541 DebugInfo
= (EFI_DEBUG_INFO
*) (Data
+ 1);
542 Marker
= (VA_LIST
) (DebugInfo
+ 1);
543 Format
= (CHAR8
*) (((UINT64
*) Marker
) + 12);
545 AsciiVSPrint (PrintBuffer
, BYTES_PER_RECORD
, Format
, Marker
);
546 printf (PrintBuffer
);
548 printf ("DEBUG <null>\n");
552 if (((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) &&
553 ((CodeType
& EFI_STATUS_CODE_SEVERITY_MASK
) == EFI_ERROR_UNRECOVERED
)
555 if (Data
!= NULL
&& ReportStatusCodeExtractAssertInfo (CodeType
, Value
, Data
, &Filename
, &Description
, &LineNumber
)) {
557 // Support ASSERT () macro
559 printf ("ASSERT %s(%d): %s\n", Filename
, LineNumber
, Description
);
561 printf ("ASSERT <null>\n");
572 IN UINTN LargestRegion
,
573 IN UINTN LargestRegionSize
,
574 IN UINTN BootFirmwareVolumeBase
,
575 IN VOID
*PeiCorePe32File
580 This is the service to load the PEI Core from the Firmware Volume
583 LargestRegion - Memory to use for PEI.
584 LargestRegionSize - Size of Memory to use for PEI
585 BootFirmwareVolumeBase - Start of the Boot FV
586 PeiCorePe32File - PEI Core PE32
589 Success means control is transfered and thus we should never return
594 EFI_PHYSICAL_ADDRESS TopOfMemory
;
597 EFI_PHYSICAL_ADDRESS PeiCoreEntryPoint
;
598 EFI_PHYSICAL_ADDRESS PeiImageAddress
;
599 EFI_PEI_STARTUP_DESCRIPTOR
*PeiStartup
;
602 // Compute Top Of Memory for Stack and PEI Core Allocations
604 TopOfMemory
= LargestRegion
+ LargestRegionSize
;
607 // Allocate 128KB for the Stack
609 TopOfStack
= (VOID
*)((UINTN
)TopOfMemory
- sizeof (EFI_PEI_STARTUP_DESCRIPTOR
) - CPU_STACK_ALIGNMENT
);
610 TopOfStack
= ALIGN_POINTER (TopOfStack
, CPU_STACK_ALIGNMENT
);
611 TopOfMemory
= TopOfMemory
- STACK_SIZE
;
614 // Patch value in dispatch table values
616 gPrivateDispatchTable
[0].Ppi
= gPeiEfiPeiPeCoffLoader
;
619 // Bind this information into the SEC hand-off state
621 PeiStartup
= (EFI_PEI_STARTUP_DESCRIPTOR
*) (UINTN
) TopOfStack
;
622 PeiStartup
->DispatchTable
= (EFI_PEI_PPI_DESCRIPTOR
*) &gPrivateDispatchTable
;
623 PeiStartup
->SizeOfCacheAsRam
= STACK_SIZE
;
624 PeiStartup
->BootFirmwareVolume
= BootFirmwareVolumeBase
;
627 // Load the PEI Core from a Firmware Volume
629 Status
= SecWinNtPeiLoadFile (
635 if (EFI_ERROR (Status
)) {
639 // Transfer control to the PEI Core
642 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) PeiCoreEntryPoint
,
648 // If we get here, then the PEI Core returned. This is an error
655 SecWinNtPeiAutoScan (
657 OUT EFI_PHYSICAL_ADDRESS
*MemoryBase
,
658 OUT UINT64
*MemorySize
663 This service is called from Index == 0 until it returns EFI_UNSUPPORTED.
664 It allows discontiguous memory regions to be supported by the emulator.
665 It uses gSystemMemory[] and gSystemMemoryCount that were created by
666 parsing the Windows environment variable EFI_MEMORY_SIZE.
667 The size comes from the varaible and the address comes from the call to
671 Index - Which memory region to use
672 MemoryBase - Return Base address of memory region
673 MemorySize - Return size in bytes of the memory region
676 EFI_SUCCESS - If memory region was mapped
677 EFI_UNSUPPORTED - If Index is not supported
683 if (Index
>= gSystemMemoryCount
) {
684 return EFI_UNSUPPORTED
;
688 Status
= WinNtOpenFile (
689 gSystemMemory
[Index
].FileName
,
690 (UINT32
) gSystemMemory
[Index
].Size
,
696 gSystemMemory
[Index
].Memory
= *MemoryBase
;
703 SecWinNtWinNtThunkAddress (
709 Since the SEC is the only Windows program in stack it must export
710 an interface to do Win API calls. That's what the WinNtThunk address
711 is for. gWinNt is initailized in WinNtThunk.c.
714 InterfaceSize - sizeof (EFI_WIN_NT_THUNK_PROTOCOL);
715 InterfaceBase - Address of the gWinNt global
718 EFI_SUCCESS - Data returned
728 SecWinNtPeiLoadFile (
730 IN EFI_PHYSICAL_ADDRESS
*ImageAddress
,
731 IN UINT64
*ImageSize
,
732 IN EFI_PHYSICAL_ADDRESS
*EntryPoint
737 Loads and relocates a PE/COFF image into memory.
740 Pe32Data - The base address of the PE/COFF file that is to be loaded and relocated
741 ImageAddress - The base address of the relocated PE/COFF image
742 ImageSize - The size of the relocated PE/COFF image
743 EntryPoint - The entry point of the relocated PE/COFF image
746 EFI_SUCCESS - The file was loaded and relocated
747 EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file
752 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
754 ZeroMem (&ImageContext
, sizeof (ImageContext
));
755 ImageContext
.Handle
= Pe32Data
;
757 ImageContext
.ImageRead
= (PE_COFF_LOADER_READ_FILE
) SecImageRead
;
759 Status
= gPeiEfiPeiPeCoffLoader
->GetImageInfo (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
760 if (EFI_ERROR (Status
)) {
764 // Allocate space in NT (not emulator) memory. Extra space is for alignment
766 ImageContext
.ImageAddress
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) malloc ((UINTN
) (ImageContext
.ImageSize
+ (ImageContext
.SectionAlignment
* 2)));
767 if (ImageContext
.ImageAddress
== 0) {
768 return EFI_OUT_OF_RESOURCES
;
771 // Align buffer on section boundry
773 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
;
774 ImageContext
.ImageAddress
&= ~(ImageContext
.SectionAlignment
- 1);
776 Status
= gPeiEfiPeiPeCoffLoader
->LoadImage (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
777 if (EFI_ERROR (Status
)) {
781 Status
= gPeiEfiPeiPeCoffLoader
->RelocateImage (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
782 if (EFI_ERROR (Status
)) {
787 // BugBug: Flush Instruction Cache Here when CPU Lib is ready
790 *ImageAddress
= ImageContext
.ImageAddress
;
791 *ImageSize
= ImageContext
.ImageSize
;
792 *EntryPoint
= ImageContext
.EntryPoint
;
801 IN OUT EFI_PHYSICAL_ADDRESS
*FdBase
,
802 IN OUT UINT64
*FdSize
807 Return the FD Size and base address. Since the FD is loaded from a
808 file into Windows memory only the SEC will know it's address.
811 Index - Which FD, starts at zero.
812 FdSize - Size of the FD in bytes
813 FdBase - Start address of the FD. Assume it points to an FV Header
816 EFI_SUCCESS - Return the Base address and size of the FV
817 EFI_UNSUPPORTED - Index does nto map to an FD in the system
821 if (Index
>= gFdInfoCount
) {
822 return EFI_UNSUPPORTED
;
825 *FdBase
= gFdInfo
[Index
].Address
;
826 *FdSize
= gFdInfo
[Index
].Size
;
828 if (*FdBase
== 0 && *FdSize
== 0) {
829 return EFI_UNSUPPORTED
;
840 IN OUT UINTN
*ReadSize
,
846 Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
849 FileHandle - The handle to the PE/COFF file
850 FileOffset - The offset, in bytes, into the file to read
851 ReadSize - The number of bytes to read from the file starting at FileOffset
852 Buffer - A pointer to the buffer to read the data into.
855 EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
863 Destination8
= Buffer
;
864 Source8
= (CHAR8
*) ((UINTN
) FileHandle
+ FileOffset
);
867 *(Destination8
++) = *(Source8
++);
876 IN UINTN
*StrLen OPTIONAL
881 Convert the passed in Ascii string to Unicode.
882 Optionally return the length of the strings.
885 Ascii - Ascii string to convert
886 StrLen - Length of string
889 Pointer to malloc'ed Unicode version of Ascii
897 // Allocate a buffer for unicode string
899 for (Index
= 0; Ascii
[Index
] != '\0'; Index
++)
901 Unicode
= malloc ((Index
+ 1) * sizeof (CHAR16
));
902 if (Unicode
== NULL
) {
906 for (Index
= 0; Ascii
[Index
] != '\0'; Index
++) {
907 Unicode
[Index
] = (CHAR16
) Ascii
[Index
];
910 Unicode
[Index
] = '\0';
912 if (StrLen
!= NULL
) {
920 CountSeperatorsInString (
921 IN
const CHAR16
*String
,
927 Count the number of seperators in String
930 String - String to process
931 Seperator - Item to count
934 Number of Seperator in String
940 for (Count
= 0; *String
!= '\0'; String
++) {
941 if (*String
== Seperator
) {
952 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
958 Store the ModHandle in an array indexed by the Pdb File name.
959 The ModHandle is needed to unload the image.
962 ImageContext - Input data returned from PE Laoder Library. Used to find the
963 .PDB file name of the PE Image.
964 ModHandle - Returned from LoadLibraryEx() and stored for call to
968 EFI_SUCCESS - ModHandle was stored.
973 PDB_NAME_TO_MOD_HANDLE
*Array
;
977 Array
= mPdbNameModHandleArray
;
978 for (Index
= 0; Index
< mPdbNameModHandleArraySize
; Index
++, Array
++) {
979 if (Array
->PdbPointer
== NULL
) {
981 // Make a copy of the stirng and store the ModHandle
983 Array
->PdbPointer
= malloc (strlen (ImageContext
->PdbPointer
) + 1);
984 ASSERT (Array
->PdbPointer
!= NULL
);
986 strcpy (Array
->PdbPointer
, ImageContext
->PdbPointer
);
987 Array
->ModHandle
= ModHandle
;
993 // No free space in mPdbNameModHandleArray so grow it by
994 // MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE entires. realloc will
995 // copy the old values to the new locaiton. But it does
996 // not zero the new memory area.
998 PreviousSize
= mPdbNameModHandleArraySize
* sizeof (PDB_NAME_TO_MOD_HANDLE
);
999 mPdbNameModHandleArraySize
+= MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE
;
1001 mPdbNameModHandleArray
= realloc (mPdbNameModHandleArray
, mPdbNameModHandleArraySize
* sizeof (PDB_NAME_TO_MOD_HANDLE
));
1002 if (mPdbNameModHandleArray
== NULL
) {
1004 return EFI_OUT_OF_RESOURCES
;
1007 memset (mPdbNameModHandleArray
+ PreviousSize
, 0, MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE
* sizeof (PDB_NAME_TO_MOD_HANDLE
));
1009 return AddModHandle (ImageContext
, ModHandle
);
1015 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1019 Routine Description:
1020 Return the ModHandle and delete the entry in the array.
1023 ImageContext - Input data returned from PE Laoder Library. Used to find the
1024 .PDB file name of the PE Image.
1027 ModHandle - ModHandle assoicated with ImageContext is returned
1028 NULL - No ModHandle associated with ImageContext
1033 PDB_NAME_TO_MOD_HANDLE
*Array
;
1035 if (ImageContext
->PdbPointer
== NULL
) {
1037 // If no PDB pointer there is no ModHandle so return NULL
1042 Array
= mPdbNameModHandleArray
;
1043 for (Index
= 0; Index
< mPdbNameModHandleArraySize
; Index
++, Array
++) {
1044 if ((Array
->PdbPointer
!= NULL
) && (strcmp(Array
->PdbPointer
, ImageContext
->PdbPointer
) == 0)) {
1046 // If you find a match return it and delete the entry
1048 free (Array
->PdbPointer
);
1049 Array
->PdbPointer
= NULL
;
1050 return Array
->ModHandle
;
1061 SecNt32PeCoffGetImageInfo (
1062 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1063 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1068 Status
= PeCoffLoaderGetImageInfo (ImageContext
);
1069 if (EFI_ERROR (Status
)) {
1073 switch (ImageContext
->ImageType
) {
1075 case EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
:
1076 ImageContext
->ImageCodeMemoryType
= EfiLoaderCode
;
1077 ImageContext
->ImageDataMemoryType
= EfiLoaderData
;
1080 case EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER
:
1081 ImageContext
->ImageCodeMemoryType
= EfiBootServicesCode
;
1082 ImageContext
->ImageDataMemoryType
= EfiBootServicesData
;
1085 case EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
:
1086 case EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER
:
1087 ImageContext
->ImageCodeMemoryType
= EfiRuntimeServicesCode
;
1088 ImageContext
->ImageDataMemoryType
= EfiRuntimeServicesData
;
1092 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_SUBSYSTEM
;
1093 return RETURN_UNSUPPORTED
;
1101 SecNt32PeCoffLoadImage (
1102 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1103 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1108 Status
= PeCoffLoaderLoadImage (ImageContext
);
1114 SecNt32PeCoffRelocateImage (
1115 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1116 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1120 VOID
*DllEntryPoint
;
1121 CHAR16
*DllFileName
;
1126 Status
= PeCoffLoaderRelocateImage (ImageContext
);
1127 if (EFI_ERROR (Status
)) {
1129 // We could not relocated the image in memory properly
1135 // If we load our own PE COFF images the Windows debugger can not source
1136 // level debug our code. If a valid PDB pointer exists usw it to load
1137 // the *.dll file as a library using Windows* APIs. This allows
1138 // source level debug. The image is still loaded and reloaced
1139 // in the Framework memory space like on a real system (by the code above),
1140 // but the entry point points into the DLL loaded by the code bellow.
1143 DllEntryPoint
= NULL
;
1146 // Load the DLL if it's not an EBC image.
1148 if ((ImageContext
->PdbPointer
!= NULL
) &&
1149 (ImageContext
->Machine
!= EFI_IMAGE_MACHINE_EBC
)) {
1151 // Convert filename from ASCII to Unicode
1153 DllFileName
= AsciiToUnicode (ImageContext
->PdbPointer
, &Index
);
1156 // Check that we have a valid filename
1158 if (Index
< 5 || DllFileName
[Index
- 4] != '.') {
1162 // Never return an error if PeCoffLoaderRelocateImage() succeeded.
1163 // The image will run, but we just can't source level debug. If we
1164 // return an error the image will not run.
1169 // Replace .PDB with .DLL on the filename
1171 DllFileName
[Index
- 3] = 'D';
1172 DllFileName
[Index
- 2] = 'L';
1173 DllFileName
[Index
- 1] = 'L';
1176 // Load the .DLL file into the user process's address space for source
1179 Library
= LoadLibraryEx (DllFileName
, NULL
, DONT_RESOLVE_DLL_REFERENCES
);
1180 if (Library
!= NULL
) {
1182 // InitializeDriver is the entry point we put in all our EFI DLL's. The
1183 // DONT_RESOLVE_DLL_REFERENCES argument to LoadLIbraryEx() supresses the
1184 // normal DLL entry point of DllMain, and prevents other modules that are
1185 // referenced in side the DllFileName from being loaded. There is no error
1186 // checking as the we can point to the PE32 image loaded by Tiano. This
1187 // step is only needed for source level debuging
1189 DllEntryPoint
= (VOID
*) (UINTN
) GetProcAddress (Library
, "InitializeDriver");
1193 if ((Library
!= NULL
) && (DllEntryPoint
!= NULL
)) {
1194 AddModHandle (ImageContext
, Library
);
1195 ImageContext
->EntryPoint
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) DllEntryPoint
;
1196 wprintf (L
"LoadLibraryEx (%s,\n NULL, DONT_RESOLVE_DLL_REFERENCES)\n", DllFileName
);
1198 wprintf (L
"WARNING: No source level debug %s. \n", DllFileName
);
1205 // Never return an error if PeCoffLoaderRelocateImage() succeeded.
1206 // The image will run, but we just can't source level debug. If we
1207 // return an error the image will not run.
1215 SecNt32PeCoffUnloadimage (
1216 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1217 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1222 ModHandle
= RemoveModeHandle (ImageContext
);
1223 if (ModHandle
!= NULL
) {
1224 FreeLibrary (ModHandle
);
1236 #pragma warning(default : 4996)