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 CONST EFI_PEI_SERVICES
**PeiServices
,
430 IN EFI_STATUS_CODE_TYPE CodeType
,
431 IN EFI_STATUS_CODE_VALUE Value
,
433 IN CONST EFI_GUID
*CallerId
,
434 IN CONST 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
);
488 Transfers control to a function starting with a new stack.
490 Transfers control to the function specified by EntryPoint using the new stack
491 specified by NewStack and passing in the parameters specified by Context1 and
492 Context2. Context1 and Context2 are optional and may be NULL. The function
493 EntryPoint must never return.
495 If EntryPoint is NULL, then ASSERT().
496 If NewStack is NULL, then ASSERT().
498 @param EntryPoint A pointer to function to call with the new stack.
499 @param Context1 A pointer to the context to pass into the EntryPoint
501 @param Context2 A pointer to the context to pass into the EntryPoint
503 @param NewStack A pointer to the new stack to use for the EntryPoint
505 @param NewBsp A pointer to the new BSP for the EntryPoint on IPF. It's
506 Reserved on other architectures.
512 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
513 IN VOID
*Context1
, OPTIONAL
514 IN VOID
*Context2
, OPTIONAL
515 IN VOID
*Context3
, OPTIONAL
519 BASE_LIBRARY_JUMP_BUFFER JumpBuffer
;
521 ASSERT (EntryPoint
!= NULL
);
522 ASSERT (NewStack
!= NULL
);
525 // Stack should be aligned with CPU_STACK_ALIGNMENT
527 ASSERT (((UINTN
)NewStack
& (CPU_STACK_ALIGNMENT
- 1)) == 0);
529 JumpBuffer
.Eip
= (UINTN
)EntryPoint
;
530 JumpBuffer
.Esp
= (UINTN
)NewStack
- sizeof (VOID
*);
531 JumpBuffer
.Esp
-= sizeof (Context1
) + sizeof (Context2
) + sizeof(Context3
);
532 ((VOID
**)JumpBuffer
.Esp
)[1] = Context1
;
533 ((VOID
**)JumpBuffer
.Esp
)[2] = Context2
;
534 ((VOID
**)JumpBuffer
.Esp
)[3] = Context3
;
536 LongJump (&JumpBuffer
, (UINTN
)-1);
540 // InternalSwitchStack () will never return
547 IN UINTN LargestRegion
,
548 IN UINTN LargestRegionSize
,
549 IN UINTN BootFirmwareVolumeBase
,
550 IN VOID
*PeiCorePe32File
555 This is the service to load the PEI Core from the Firmware Volume
558 LargestRegion - Memory to use for PEI.
559 LargestRegionSize - Size of Memory to use for PEI
560 BootFirmwareVolumeBase - Start of the Boot FV
561 PeiCorePe32File - PEI Core PE32
564 Success means control is transfered and thus we should never return
569 EFI_PHYSICAL_ADDRESS TopOfMemory
;
572 EFI_PHYSICAL_ADDRESS PeiCoreEntryPoint
;
573 EFI_PHYSICAL_ADDRESS PeiImageAddress
;
574 EFI_SEC_PEI_HAND_OFF
*SecCoreData
;
577 // Compute Top Of Memory for Stack and PEI Core Allocations
579 TopOfMemory
= LargestRegion
+ LargestRegionSize
;
582 // Allocate 128KB for the Stack
584 TopOfStack
= (VOID
*)((UINTN
)TopOfMemory
- sizeof (EFI_SEC_PEI_HAND_OFF
) - CPU_STACK_ALIGNMENT
);
585 TopOfStack
= ALIGN_POINTER (TopOfStack
, CPU_STACK_ALIGNMENT
);
586 TopOfMemory
= TopOfMemory
- STACK_SIZE
;
589 // Patch value in dispatch table values
591 gPrivateDispatchTable
[0].Ppi
= gPeiEfiPeiPeCoffLoader
;
594 // Bind this information into the SEC hand-off state
596 SecCoreData
= (EFI_SEC_PEI_HAND_OFF
*)(UINTN
) TopOfStack
;
597 SecCoreData
->DataSize
= sizeof(EFI_SEC_PEI_HAND_OFF
);
598 SecCoreData
->BootFirmwareVolumeBase
= (VOID
*)BootFirmwareVolumeBase
;
599 SecCoreData
->BootFirmwareVolumeSize
= FixedPcdGet32(PcdWinNtFirmwareFdSize
);
600 SecCoreData
->TemporaryRamBase
= (VOID
*)(UINTN
)TopOfMemory
;
601 SecCoreData
->TemporaryRamSize
= STACK_SIZE
;
602 SecCoreData
->PeiTemporaryRamBase
= SecCoreData
->TemporaryRamBase
;
603 SecCoreData
->PeiTemporaryRamSize
= (UINTN
)RShiftU64((UINT64
)STACK_SIZE
,1);
604 SecCoreData
->StackBase
= (VOID
*)((UINTN
)SecCoreData
->TemporaryRamBase
+ (UINTN
)SecCoreData
->TemporaryRamSize
);
605 SecCoreData
->StackSize
= (UINTN
)RShiftU64((UINT64
)STACK_SIZE
,1);
608 // Load the PEI Core from a Firmware Volume
610 Status
= SecWinNtPeiLoadFile (
616 if (EFI_ERROR (Status
)) {
621 // Transfer control to the PEI Core
624 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) PeiCoreEntryPoint
,
626 (VOID
*) (UINTN
) ((EFI_PEI_PPI_DESCRIPTOR
*) &gPrivateDispatchTable
),
631 // If we get here, then the PEI Core returned. This is an error
638 SecWinNtPeiAutoScan (
640 OUT EFI_PHYSICAL_ADDRESS
*MemoryBase
,
641 OUT UINT64
*MemorySize
646 This service is called from Index == 0 until it returns EFI_UNSUPPORTED.
647 It allows discontiguous memory regions to be supported by the emulator.
648 It uses gSystemMemory[] and gSystemMemoryCount that were created by
649 parsing the Windows environment variable EFI_MEMORY_SIZE.
650 The size comes from the varaible and the address comes from the call to
654 Index - Which memory region to use
655 MemoryBase - Return Base address of memory region
656 MemorySize - Return size in bytes of the memory region
659 EFI_SUCCESS - If memory region was mapped
660 EFI_UNSUPPORTED - If Index is not supported
666 if (Index
>= gSystemMemoryCount
) {
667 return EFI_UNSUPPORTED
;
671 Status
= WinNtOpenFile (
672 gSystemMemory
[Index
].FileName
,
673 (UINT32
) gSystemMemory
[Index
].Size
,
679 gSystemMemory
[Index
].Memory
= *MemoryBase
;
686 SecWinNtWinNtThunkAddress (
692 Since the SEC is the only Windows program in stack it must export
693 an interface to do Win API calls. That's what the WinNtThunk address
694 is for. gWinNt is initailized in WinNtThunk.c.
697 InterfaceSize - sizeof (EFI_WIN_NT_THUNK_PROTOCOL);
698 InterfaceBase - Address of the gWinNt global
701 EFI_SUCCESS - Data returned
711 SecWinNtPeiLoadFile (
713 IN EFI_PHYSICAL_ADDRESS
*ImageAddress
,
714 IN UINT64
*ImageSize
,
715 IN EFI_PHYSICAL_ADDRESS
*EntryPoint
720 Loads and relocates a PE/COFF image into memory.
723 Pe32Data - The base address of the PE/COFF file that is to be loaded and relocated
724 ImageAddress - The base address of the relocated PE/COFF image
725 ImageSize - The size of the relocated PE/COFF image
726 EntryPoint - The entry point of the relocated PE/COFF image
729 EFI_SUCCESS - The file was loaded and relocated
730 EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file
735 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
737 ZeroMem (&ImageContext
, sizeof (ImageContext
));
738 ImageContext
.Handle
= Pe32Data
;
740 ImageContext
.ImageRead
= (PE_COFF_LOADER_READ_FILE
) SecImageRead
;
742 Status
= gPeiEfiPeiPeCoffLoader
->GetImageInfo (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
743 if (EFI_ERROR (Status
)) {
747 // Allocate space in NT (not emulator) memory. Extra space is for alignment
749 ImageContext
.ImageAddress
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) malloc ((UINTN
) (ImageContext
.ImageSize
+ (ImageContext
.SectionAlignment
* 2)));
750 if (ImageContext
.ImageAddress
== 0) {
751 return EFI_OUT_OF_RESOURCES
;
754 // Align buffer on section boundry
756 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
;
757 ImageContext
.ImageAddress
&= ~(ImageContext
.SectionAlignment
- 1);
759 Status
= gPeiEfiPeiPeCoffLoader
->LoadImage (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
760 if (EFI_ERROR (Status
)) {
764 Status
= gPeiEfiPeiPeCoffLoader
->RelocateImage (gPeiEfiPeiPeCoffLoader
, &ImageContext
);
765 if (EFI_ERROR (Status
)) {
770 // BugBug: Flush Instruction Cache Here when CPU Lib is ready
773 *ImageAddress
= ImageContext
.ImageAddress
;
774 *ImageSize
= ImageContext
.ImageSize
;
775 *EntryPoint
= ImageContext
.EntryPoint
;
784 IN OUT EFI_PHYSICAL_ADDRESS
*FdBase
,
785 IN OUT UINT64
*FdSize
790 Return the FD Size and base address. Since the FD is loaded from a
791 file into Windows memory only the SEC will know it's address.
794 Index - Which FD, starts at zero.
795 FdSize - Size of the FD in bytes
796 FdBase - Start address of the FD. Assume it points to an FV Header
799 EFI_SUCCESS - Return the Base address and size of the FV
800 EFI_UNSUPPORTED - Index does nto map to an FD in the system
804 if (Index
>= gFdInfoCount
) {
805 return EFI_UNSUPPORTED
;
808 *FdBase
= gFdInfo
[Index
].Address
;
809 *FdSize
= gFdInfo
[Index
].Size
;
811 if (*FdBase
== 0 && *FdSize
== 0) {
812 return EFI_UNSUPPORTED
;
823 IN OUT UINTN
*ReadSize
,
829 Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
832 FileHandle - The handle to the PE/COFF file
833 FileOffset - The offset, in bytes, into the file to read
834 ReadSize - The number of bytes to read from the file starting at FileOffset
835 Buffer - A pointer to the buffer to read the data into.
838 EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
846 Destination8
= Buffer
;
847 Source8
= (CHAR8
*) ((UINTN
) FileHandle
+ FileOffset
);
850 *(Destination8
++) = *(Source8
++);
859 IN UINTN
*StrLen OPTIONAL
864 Convert the passed in Ascii string to Unicode.
865 Optionally return the length of the strings.
868 Ascii - Ascii string to convert
869 StrLen - Length of string
872 Pointer to malloc'ed Unicode version of Ascii
880 // Allocate a buffer for unicode string
882 for (Index
= 0; Ascii
[Index
] != '\0'; Index
++)
884 Unicode
= malloc ((Index
+ 1) * sizeof (CHAR16
));
885 if (Unicode
== NULL
) {
889 for (Index
= 0; Ascii
[Index
] != '\0'; Index
++) {
890 Unicode
[Index
] = (CHAR16
) Ascii
[Index
];
893 Unicode
[Index
] = '\0';
895 if (StrLen
!= NULL
) {
903 CountSeperatorsInString (
904 IN
const CHAR16
*String
,
910 Count the number of seperators in String
913 String - String to process
914 Seperator - Item to count
917 Number of Seperator in String
923 for (Count
= 0; *String
!= '\0'; String
++) {
924 if (*String
== Seperator
) {
935 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
941 Store the ModHandle in an array indexed by the Pdb File name.
942 The ModHandle is needed to unload the image.
945 ImageContext - Input data returned from PE Laoder Library. Used to find the
946 .PDB file name of the PE Image.
947 ModHandle - Returned from LoadLibraryEx() and stored for call to
951 EFI_SUCCESS - ModHandle was stored.
956 PDB_NAME_TO_MOD_HANDLE
*Array
;
960 Array
= mPdbNameModHandleArray
;
961 for (Index
= 0; Index
< mPdbNameModHandleArraySize
; Index
++, Array
++) {
962 if (Array
->PdbPointer
== NULL
) {
964 // Make a copy of the stirng and store the ModHandle
966 Array
->PdbPointer
= malloc (strlen (ImageContext
->PdbPointer
) + 1);
967 ASSERT (Array
->PdbPointer
!= NULL
);
969 strcpy (Array
->PdbPointer
, ImageContext
->PdbPointer
);
970 Array
->ModHandle
= ModHandle
;
976 // No free space in mPdbNameModHandleArray so grow it by
977 // MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE entires. realloc will
978 // copy the old values to the new locaiton. But it does
979 // not zero the new memory area.
981 PreviousSize
= mPdbNameModHandleArraySize
* sizeof (PDB_NAME_TO_MOD_HANDLE
);
982 mPdbNameModHandleArraySize
+= MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE
;
984 mPdbNameModHandleArray
= realloc (mPdbNameModHandleArray
, mPdbNameModHandleArraySize
* sizeof (PDB_NAME_TO_MOD_HANDLE
));
985 if (mPdbNameModHandleArray
== NULL
) {
987 return EFI_OUT_OF_RESOURCES
;
990 memset (mPdbNameModHandleArray
+ PreviousSize
, 0, MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE
* sizeof (PDB_NAME_TO_MOD_HANDLE
));
992 return AddModHandle (ImageContext
, ModHandle
);
998 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1002 Routine Description:
1003 Return the ModHandle and delete the entry in the array.
1006 ImageContext - Input data returned from PE Laoder Library. Used to find the
1007 .PDB file name of the PE Image.
1010 ModHandle - ModHandle assoicated with ImageContext is returned
1011 NULL - No ModHandle associated with ImageContext
1016 PDB_NAME_TO_MOD_HANDLE
*Array
;
1018 if (ImageContext
->PdbPointer
== NULL
) {
1020 // If no PDB pointer there is no ModHandle so return NULL
1025 Array
= mPdbNameModHandleArray
;
1026 for (Index
= 0; Index
< mPdbNameModHandleArraySize
; Index
++, Array
++) {
1027 if ((Array
->PdbPointer
!= NULL
) && (strcmp(Array
->PdbPointer
, ImageContext
->PdbPointer
) == 0)) {
1029 // If you find a match return it and delete the entry
1031 free (Array
->PdbPointer
);
1032 Array
->PdbPointer
= NULL
;
1033 return Array
->ModHandle
;
1044 SecNt32PeCoffGetImageInfo (
1045 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1046 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1051 Status
= PeCoffLoaderGetImageInfo (ImageContext
);
1052 if (EFI_ERROR (Status
)) {
1056 switch (ImageContext
->ImageType
) {
1058 case EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
:
1059 ImageContext
->ImageCodeMemoryType
= EfiLoaderCode
;
1060 ImageContext
->ImageDataMemoryType
= EfiLoaderData
;
1063 case EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER
:
1064 ImageContext
->ImageCodeMemoryType
= EfiBootServicesCode
;
1065 ImageContext
->ImageDataMemoryType
= EfiBootServicesData
;
1068 case EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
:
1069 case EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER
:
1070 ImageContext
->ImageCodeMemoryType
= EfiRuntimeServicesCode
;
1071 ImageContext
->ImageDataMemoryType
= EfiRuntimeServicesData
;
1075 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_SUBSYSTEM
;
1076 return RETURN_UNSUPPORTED
;
1084 SecNt32PeCoffLoadImage (
1085 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1086 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1091 Status
= PeCoffLoaderLoadImage (ImageContext
);
1097 SecNt32PeCoffRelocateImage (
1098 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1099 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1103 VOID
*DllEntryPoint
;
1104 CHAR16
*DllFileName
;
1109 Status
= PeCoffLoaderRelocateImage (ImageContext
);
1110 if (EFI_ERROR (Status
)) {
1112 // We could not relocated the image in memory properly
1118 // If we load our own PE COFF images the Windows debugger can not source
1119 // level debug our code. If a valid PDB pointer exists usw it to load
1120 // the *.dll file as a library using Windows* APIs. This allows
1121 // source level debug. The image is still loaded and reloaced
1122 // in the Framework memory space like on a real system (by the code above),
1123 // but the entry point points into the DLL loaded by the code bellow.
1126 DllEntryPoint
= NULL
;
1129 // Load the DLL if it's not an EBC image.
1131 if ((ImageContext
->PdbPointer
!= NULL
) &&
1132 (ImageContext
->Machine
!= EFI_IMAGE_MACHINE_EBC
)) {
1134 // Convert filename from ASCII to Unicode
1136 DllFileName
= AsciiToUnicode (ImageContext
->PdbPointer
, &Index
);
1139 // Check that we have a valid filename
1141 if (Index
< 5 || DllFileName
[Index
- 4] != '.') {
1145 // Never return an error if PeCoffLoaderRelocateImage() succeeded.
1146 // The image will run, but we just can't source level debug. If we
1147 // return an error the image will not run.
1152 // Replace .PDB with .DLL on the filename
1154 DllFileName
[Index
- 3] = 'D';
1155 DllFileName
[Index
- 2] = 'L';
1156 DllFileName
[Index
- 1] = 'L';
1159 // Load the .DLL file into the user process's address space for source
1162 Library
= LoadLibraryEx (DllFileName
, NULL
, DONT_RESOLVE_DLL_REFERENCES
);
1163 if (Library
!= NULL
) {
1165 // InitializeDriver is the entry point we put in all our EFI DLL's. The
1166 // DONT_RESOLVE_DLL_REFERENCES argument to LoadLIbraryEx() supresses the
1167 // normal DLL entry point of DllMain, and prevents other modules that are
1168 // referenced in side the DllFileName from being loaded. There is no error
1169 // checking as the we can point to the PE32 image loaded by Tiano. This
1170 // step is only needed for source level debuging
1172 DllEntryPoint
= (VOID
*) (UINTN
) GetProcAddress (Library
, "InitializeDriver");
1176 if ((Library
!= NULL
) && (DllEntryPoint
!= NULL
)) {
1177 AddModHandle (ImageContext
, Library
);
1178 ImageContext
->EntryPoint
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) DllEntryPoint
;
1179 wprintf (L
"LoadLibraryEx (%s,\n NULL, DONT_RESOLVE_DLL_REFERENCES)\n", DllFileName
);
1181 wprintf (L
"WARNING: No source level debug %s. \n", DllFileName
);
1188 // Never return an error if PeCoffLoaderRelocateImage() succeeded.
1189 // The image will run, but we just can't source level debug. If we
1190 // return an error the image will not run.
1198 SecNt32PeCoffUnloadimage (
1199 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL
*This
,
1200 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1205 ModHandle
= RemoveModeHandle (ImageContext
);
1206 if (ModHandle
!= NULL
) {
1207 FreeLibrary (ModHandle
);