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
) & (~15));
607 // Allocate 128KB for the Stack
609 TopOfStack
= (VOID
*) (UINTN
) (TopOfMemory
- sizeof (EFI_PEI_STARTUP_DESCRIPTOR
));
610 TopOfMemory
= TopOfMemory
- STACK_SIZE
;
613 // Patch value in dispatch table values
615 gPrivateDispatchTable
[0].Ppi
= gPeiEfiPeiPeCoffLoader
;
618 // Bind this information into the SEC hand-off state
620 PeiStartup
= (EFI_PEI_STARTUP_DESCRIPTOR
*) (UINTN
) TopOfStack
;
621 PeiStartup
->DispatchTable
= (EFI_PEI_PPI_DESCRIPTOR
*) &gPrivateDispatchTable
;
622 PeiStartup
->SizeOfCacheAsRam
= STACK_SIZE
;
623 PeiStartup
->BootFirmwareVolume
= BootFirmwareVolumeBase
;
626 // Load the PEI Core from a Firmware Volume
628 Status
= SecWinNtPeiLoadFile (
634 if (EFI_ERROR (Status
)) {
638 // Transfer control to the PEI Core
641 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) PeiCoreEntryPoint
,
647 // If we get here, then the PEI Core returned. This is an error
654 SecWinNtPeiAutoScan (
656 OUT EFI_PHYSICAL_ADDRESS
*MemoryBase
,
657 OUT UINT64
*MemorySize
662 This service is called from Index == 0 until it returns EFI_UNSUPPORTED.
663 It allows discontiguous memory regions to be supported by the emulator.
664 It uses gSystemMemory[] and gSystemMemoryCount that were created by
665 parsing the Windows environment variable EFI_MEMORY_SIZE.
666 The size comes from the varaible and the address comes from the call to
670 Index - Which memory region to use
671 MemoryBase - Return Base address of memory region
672 MemorySize - Return size in bytes of the memory region
675 EFI_SUCCESS - If memory region was mapped
676 EFI_UNSUPPORTED - If Index is not supported
682 if (Index
>= gSystemMemoryCount
) {
683 return EFI_UNSUPPORTED
;
687 Status
= WinNtOpenFile (
688 gSystemMemory
[Index
].FileName
,
689 (UINT32
) gSystemMemory
[Index
].Size
,
695 gSystemMemory
[Index
].Memory
= *MemoryBase
;
702 SecWinNtWinNtThunkAddress (
708 Since the SEC is the only Windows program in stack it must export
709 an interface to do Win API calls. That's what the WinNtThunk address
710 is for. gWinNt is initailized in WinNtThunk.c.
713 InterfaceSize - sizeof (EFI_WIN_NT_THUNK_PROTOCOL);
714 InterfaceBase - Address of the gWinNt global
717 EFI_SUCCESS - Data returned
727 SecWinNtPeiLoadFile (
729 IN EFI_PHYSICAL_ADDRESS
*ImageAddress
,
730 IN UINT64
*ImageSize
,
731 IN EFI_PHYSICAL_ADDRESS
*EntryPoint
736 Loads and relocates a PE/COFF image into memory.
739 Pe32Data - The base address of the PE/COFF file that is to be loaded and relocated
740 ImageAddress - The base address of the relocated PE/COFF image
741 ImageSize - The size of the relocated PE/COFF image
742 EntryPoint - The entry point of the relocated PE/COFF image
745 EFI_SUCCESS - The file was loaded and relocated
746 EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file
751 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
753 ZeroMem (&ImageContext
, sizeof (ImageContext
));
754 ImageContext
.Handle
= Pe32Data
;
756 ImageContext
.ImageRead
= (PE_COFF_LOADER_READ_FILE
) SecImageRead
;
758 Status
= gPeiEfiPeiPeCoffLoader
->GetImageInfo (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
759 if (EFI_ERROR (Status
)) {
763 // Allocate space in NT (not emulator) memory. Extra space is for alignment
765 ImageContext
.ImageAddress
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) malloc ((UINTN
) (ImageContext
.ImageSize
+ (ImageContext
.SectionAlignment
* 2)));
766 if (ImageContext
.ImageAddress
== 0) {
767 return EFI_OUT_OF_RESOURCES
;
770 // Align buffer on section boundry
772 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
;
773 ImageContext
.ImageAddress
&= ~(ImageContext
.SectionAlignment
- 1);
775 Status
= gPeiEfiPeiPeCoffLoader
->LoadImage (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
776 if (EFI_ERROR (Status
)) {
780 Status
= gPeiEfiPeiPeCoffLoader
->RelocateImage (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
781 if (EFI_ERROR (Status
)) {
786 // BugBug: Flush Instruction Cache Here when CPU Lib is ready
789 *ImageAddress
= ImageContext
.ImageAddress
;
790 *ImageSize
= ImageContext
.ImageSize
;
791 *EntryPoint
= ImageContext
.EntryPoint
;
800 IN OUT EFI_PHYSICAL_ADDRESS
*FdBase
,
801 IN OUT UINT64
*FdSize
806 Return the FD Size and base address. Since the FD is loaded from a
807 file into Windows memory only the SEC will know it's address.
810 Index - Which FD, starts at zero.
811 FdSize - Size of the FD in bytes
812 FdBase - Start address of the FD. Assume it points to an FV Header
815 EFI_SUCCESS - Return the Base address and size of the FV
816 EFI_UNSUPPORTED - Index does nto map to an FD in the system
820 if (Index
>= gFdInfoCount
) {
821 return EFI_UNSUPPORTED
;
824 *FdBase
= gFdInfo
[Index
].Address
;
825 *FdSize
= gFdInfo
[Index
].Size
;
827 if (*FdBase
== 0 && *FdSize
== 0) {
828 return EFI_UNSUPPORTED
;
839 IN OUT UINTN
*ReadSize
,
845 Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
848 FileHandle - The handle to the PE/COFF file
849 FileOffset - The offset, in bytes, into the file to read
850 ReadSize - The number of bytes to read from the file starting at FileOffset
851 Buffer - A pointer to the buffer to read the data into.
854 EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
862 Destination8
= Buffer
;
863 Source8
= (CHAR8
*) ((UINTN
) FileHandle
+ FileOffset
);
866 *(Destination8
++) = *(Source8
++);
875 IN UINTN
*StrLen OPTIONAL
880 Convert the passed in Ascii string to Unicode.
881 Optionally return the length of the strings.
884 Ascii - Ascii string to convert
885 StrLen - Length of string
888 Pointer to malloc'ed Unicode version of Ascii
896 // Allocate a buffer for unicode string
898 for (Index
= 0; Ascii
[Index
] != '\0'; Index
++)
900 Unicode
= malloc ((Index
+ 1) * sizeof (CHAR16
));
901 if (Unicode
== NULL
) {
905 for (Index
= 0; Ascii
[Index
] != '\0'; Index
++) {
906 Unicode
[Index
] = (CHAR16
) Ascii
[Index
];
909 Unicode
[Index
] = '\0';
911 if (StrLen
!= NULL
) {
919 CountSeperatorsInString (
920 IN
const CHAR16
*String
,
926 Count the number of seperators in String
929 String - String to process
930 Seperator - Item to count
933 Number of Seperator in String
939 for (Count
= 0; *String
!= '\0'; String
++) {
940 if (*String
== Seperator
) {
951 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
957 Store the ModHandle in an array indexed by the Pdb File name.
958 The ModHandle is needed to unload the image.
961 ImageContext - Input data returned from PE Laoder Library. Used to find the
962 .PDB file name of the PE Image.
963 ModHandle - Returned from LoadLibraryEx() and stored for call to
967 EFI_SUCCESS - ModHandle was stored.
972 PDB_NAME_TO_MOD_HANDLE
*Array
;
976 Array
= mPdbNameModHandleArray
;
977 for (Index
= 0; Index
< mPdbNameModHandleArraySize
; Index
++, Array
++) {
978 if (Array
->PdbPointer
== NULL
) {
980 // Make a copy of the stirng and store the ModHandle
982 Array
->PdbPointer
= malloc (strlen (ImageContext
->PdbPointer
) + 1);
983 ASSERT (Array
->PdbPointer
!= NULL
);
985 strcpy (Array
->PdbPointer
, ImageContext
->PdbPointer
);
986 Array
->ModHandle
= ModHandle
;
992 // No free space in mPdbNameModHandleArray so grow it by
993 // MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE entires. realloc will
994 // copy the old values to the new locaiton. But it does
995 // not zero the new memory area.
997 PreviousSize
= mPdbNameModHandleArraySize
* sizeof (PDB_NAME_TO_MOD_HANDLE
);
998 mPdbNameModHandleArraySize
+= MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE
;
1000 mPdbNameModHandleArray
= realloc (mPdbNameModHandleArray
, mPdbNameModHandleArraySize
* sizeof (PDB_NAME_TO_MOD_HANDLE
));
1001 if (mPdbNameModHandleArray
== NULL
) {
1003 return EFI_OUT_OF_RESOURCES
;
1006 memset (mPdbNameModHandleArray
+ PreviousSize
, 0, MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE
* sizeof (PDB_NAME_TO_MOD_HANDLE
));
1008 return AddModHandle (ImageContext
, ModHandle
);
1014 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1018 Routine Description:
1019 Return the ModHandle and delete the entry in the array.
1022 ImageContext - Input data returned from PE Laoder Library. Used to find the
1023 .PDB file name of the PE Image.
1026 ModHandle - ModHandle assoicated with ImageContext is returned
1027 NULL - No ModHandle associated with ImageContext
1032 PDB_NAME_TO_MOD_HANDLE
*Array
;
1034 if (ImageContext
->PdbPointer
== NULL
) {
1036 // If no PDB pointer there is no ModHandle so return NULL
1041 Array
= mPdbNameModHandleArray
;
1042 for (Index
= 0; Index
< mPdbNameModHandleArraySize
; Index
++, Array
++) {
1043 if ((Array
->PdbPointer
!= NULL
) && (strcmp(Array
->PdbPointer
, ImageContext
->PdbPointer
) == 0)) {
1045 // If you find a match return it and delete the entry
1047 free (Array
->PdbPointer
);
1048 Array
->PdbPointer
= NULL
;
1049 return Array
->ModHandle
;
1060 SecNt32PeCoffGetImageInfo (
1061 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1062 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1067 Status
= PeCoffLoaderGetImageInfo (ImageContext
);
1068 if (EFI_ERROR (Status
)) {
1072 switch (ImageContext
->ImageType
) {
1074 case EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
:
1075 ImageContext
->ImageCodeMemoryType
= EfiLoaderCode
;
1076 ImageContext
->ImageDataMemoryType
= EfiLoaderData
;
1079 case EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER
:
1080 ImageContext
->ImageCodeMemoryType
= EfiBootServicesCode
;
1081 ImageContext
->ImageDataMemoryType
= EfiBootServicesData
;
1084 case EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
:
1085 case EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER
:
1086 ImageContext
->ImageCodeMemoryType
= EfiRuntimeServicesCode
;
1087 ImageContext
->ImageDataMemoryType
= EfiRuntimeServicesData
;
1091 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_SUBSYSTEM
;
1092 return RETURN_UNSUPPORTED
;
1100 SecNt32PeCoffLoadImage (
1101 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1102 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1107 Status
= PeCoffLoaderLoadImage (ImageContext
);
1113 SecNt32PeCoffRelocateImage (
1114 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1115 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1119 VOID
*DllEntryPoint
;
1120 CHAR16
*DllFileName
;
1125 Status
= PeCoffLoaderRelocateImage (ImageContext
);
1126 if (EFI_ERROR (Status
)) {
1128 // We could not relocated the image in memory properly
1134 // If we load our own PE COFF images the Windows debugger can not source
1135 // level debug our code. If a valid PDB pointer exists usw it to load
1136 // the *.dll file as a library using Windows* APIs. This allows
1137 // source level debug. The image is still loaded and reloaced
1138 // in the Framework memory space like on a real system (by the code above),
1139 // but the entry point points into the DLL loaded by the code bellow.
1142 DllEntryPoint
= NULL
;
1145 // Load the DLL if it's not an EBC image.
1147 if ((ImageContext
->PdbPointer
!= NULL
) &&
1148 (ImageContext
->Machine
!= EFI_IMAGE_MACHINE_EBC
)) {
1150 // Convert filename from ASCII to Unicode
1152 DllFileName
= AsciiToUnicode (ImageContext
->PdbPointer
, &Index
);
1155 // Check that we have a valid filename
1157 if (Index
< 5 || DllFileName
[Index
- 4] != '.') {
1161 // Never return an error if PeCoffLoaderRelocateImage() succeeded.
1162 // The image will run, but we just can't source level debug. If we
1163 // return an error the image will not run.
1168 // Replace .PDB with .DLL on the filename
1170 DllFileName
[Index
- 3] = 'D';
1171 DllFileName
[Index
- 2] = 'L';
1172 DllFileName
[Index
- 1] = 'L';
1175 // Load the .DLL file into the user process's address space for source
1178 Library
= LoadLibraryEx (DllFileName
, NULL
, DONT_RESOLVE_DLL_REFERENCES
);
1179 if (Library
!= NULL
) {
1181 // InitializeDriver is the entry point we put in all our EFI DLL's. The
1182 // DONT_RESOLVE_DLL_REFERENCES argument to LoadLIbraryEx() supresses the
1183 // normal DLL entry point of DllMain, and prevents other modules that are
1184 // referenced in side the DllFileName from being loaded. There is no error
1185 // checking as the we can point to the PE32 image loaded by Tiano. This
1186 // step is only needed for source level debuging
1188 DllEntryPoint
= (VOID
*) (UINTN
) GetProcAddress (Library
, "InitializeDriver");
1192 if ((Library
!= NULL
) && (DllEntryPoint
!= NULL
)) {
1193 AddModHandle (ImageContext
, Library
);
1194 ImageContext
->EntryPoint
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) DllEntryPoint
;
1195 wprintf (L
"LoadLibraryEx (%s,\n NULL, DONT_RESOLVE_DLL_REFERENCES)\n", DllFileName
);
1197 wprintf (L
"WARNING: No source level debug %s. \n", DllFileName
);
1204 // Never return an error if PeCoffLoaderRelocateImage() succeeded.
1205 // The image will run, but we just can't source level debug. If we
1206 // return an error the image will not run.
1214 SecNt32PeCoffUnloadimage (
1215 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1216 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1221 ModHandle
= RemoveModeHandle (ImageContext
);
1222 if (ModHandle
!= NULL
) {
1223 FreeLibrary (ModHandle
);
1235 #pragma warning(default : 4996)