Porting SecMain module for Nt32Pkg, but not enable PI, so it currently dependent...
[mirror_edk2.git] / Nt32Pkg / Sec / SecMain.c
1 /*++
2
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
8
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.
11
12 Module Name:
13
14 SecMain.c
15
16 Abstract:
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.
19
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.
23
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.
26
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.
29
30 The system.cmd script is used to set windows environment variables that drive
31 the configuration opitons of the SEC.
32
33 --*/
34
35 #include "SecMain.h"
36 #pragma warning(disable : 4996)
37
38 //
39 // Globals
40 //
41 EFI_PEI_PE_COFF_LOADER_PROTOCOL_INSTANCE mPeiEfiPeiPeCoffLoaderInstance = {
42 {
43 SecNt32PeCoffGetImageInfo,
44 SecNt32PeCoffLoadImage,
45 SecNt32PeCoffRelocateImage,
46 SecNt32PeCoffUnloadimage
47 },
48 NULL
49 };
50
51
52
53 EFI_PEI_PE_COFF_LOADER_PROTOCOL *gPeiEfiPeiPeCoffLoader = &mPeiEfiPeiPeCoffLoaderInstance.PeCoff;
54
55 NT_PEI_LOAD_FILE_PPI mSecNtLoadFilePpi = { SecWinNtPeiLoadFile };
56
57 PEI_NT_AUTOSCAN_PPI mSecNtAutoScanPpi = { SecWinNtPeiAutoScan };
58
59 PEI_NT_THUNK_PPI mSecWinNtThunkPpi = { SecWinNtWinNtThunkAddress };
60
61 EFI_PEI_PROGRESS_CODE_PPI mSecStatusCodePpi = { SecPeiReportStatusCode };
62
63 NT_FWH_PPI mSecFwhInformationPpi = { SecWinNtFdAddress };
64
65
66 EFI_PEI_PPI_DESCRIPTOR gPrivateDispatchTable[] = {
67 {
68 EFI_PEI_PPI_DESCRIPTOR_PPI,
69 &gEfiPeiPeCoffLoaderGuid,
70 NULL
71 },
72 {
73 EFI_PEI_PPI_DESCRIPTOR_PPI,
74 &gNtPeiLoadFilePpiGuid,
75 &mSecNtLoadFilePpi
76 },
77 {
78 EFI_PEI_PPI_DESCRIPTOR_PPI,
79 &gPeiNtAutoScanPpiGuid,
80 &mSecNtAutoScanPpi
81 },
82 {
83 EFI_PEI_PPI_DESCRIPTOR_PPI,
84 &gPeiNtThunkPpiGuid,
85 &mSecWinNtThunkPpi
86 },
87 {
88 EFI_PEI_PPI_DESCRIPTOR_PPI,
89 &gEfiPeiStatusCodePpiGuid,
90 &mSecStatusCodePpi
91 },
92 {
93 EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
94 &gNtFwhPpiGuid,
95 &mSecFwhInformationPpi
96 }
97 };
98
99
100 //
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.
106 //
107 UINTN gFdInfoCount = 0;
108 NT_FD_INFO *gFdInfo;
109
110 //
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.
115 //
116 UINTN gSystemMemoryCount = 0;
117 NT_SYSTEM_MEMORY *gSystemMemory;
118
119
120 UINTN mPdbNameModHandleArraySize = 0;
121 PDB_NAME_TO_MOD_HANDLE *mPdbNameModHandleArray = NULL;
122
123
124
125
126 INTN
127 EFIAPI
128 main (
129 IN INTN Argc,
130 IN CHAR8 **Argv,
131 IN CHAR8 **Envp
132 )
133 /*++
134
135 Routine Description:
136 Main entry point to SEC for WinNt. This is a Windows program
137
138 Arguments:
139 Argc - Number of command line arguments
140 Argv - Array of command line argument strings
141 Envp - Array of environmemt variable strings
142
143 Returns:
144 0 - Normal exit
145 1 - Abnormal exit
146
147 --*/
148 {
149 EFI_STATUS Status;
150 EFI_PHYSICAL_ADDRESS InitialStackMemory;
151 UINT64 InitialStackMemorySize;
152 UINTN Index;
153 UINTN Index1;
154 UINTN Index2;
155 UINTN PeiIndex;
156 CHAR16 *FileName;
157 CHAR16 *FileNamePtr;
158 BOOLEAN Done;
159 VOID *PeiCoreFile;
160 CHAR16 *MemorySizeStr;
161 CHAR16 *FirmwareVolumesStr;
162
163 MemorySizeStr = (CHAR16 *)L"64!64";
164 FirmwareVolumesStr = (CHAR16 *)L"..\\Fv\\Fv_Recovery.fd";
165
166 printf ("\nEDK SEC Main NT Emulation Environment from www.TianoCore.org\n");
167
168 //
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.
171 //
172 SetPriorityClass (GetCurrentProcess (), IDLE_PRIORITY_CLASS);
173 SetThreadPriority (GetCurrentThread (), THREAD_PRIORITY_HIGHEST);
174
175 //
176 // Allocate space for gSystemMemory Array
177 //
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);
182 exit (1);
183 }
184 //
185 // Allocate space for gSystemMemory Array
186 //
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);
191 exit (1);
192 }
193 //
194 // Setup Boot Mode. If BootModeStr == "" then BootMode = 0 (BOOT_WITH_FULL_CONFIGURATION)
195 //
196 printf (" BootMode 0x%02x\n", FixedPcdGet32 (PcdWinNtBootMode));
197
198 //
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
202 //
203 InitialStackMemory = 0;
204 InitialStackMemorySize = 0x20000;
205 Status = WinNtOpenFile (
206 L"SecStack",
207 (UINT32) InitialStackMemorySize,
208 OPEN_ALWAYS,
209 &InitialStackMemory,
210 &InitialStackMemorySize
211 );
212 if (EFI_ERROR (Status)) {
213 printf ("ERROR : Can not open SecStack Exiting\n");
214 exit (1);
215 }
216
217 printf (" SEC passing in %d bytes of temp RAM to PEI\n", InitialStackMemorySize);
218
219 //
220 // Open All the firmware volumes and remember the info in the gFdInfo global
221 //
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");
225 exit (1);
226 }
227
228 StrCpy (FileNamePtr, (CHAR16*)FirmwareVolumesStr);
229
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++)
233 ;
234 if (FileNamePtr[Index1] == 0) {
235 Done = TRUE;
236 } else {
237 FileNamePtr[Index1] = '\0';
238 FileNamePtr = FileNamePtr + Index1 + 1;
239 }
240
241 //
242 // Open the FD and remmeber where it got mapped into our processes address space
243 //
244 Status = WinNtOpenFile (
245 FileName,
246 0,
247 OPEN_EXISTING,
248 &gFdInfo[Index].Address,
249 &gFdInfo[Index].Size
250 );
251 if (EFI_ERROR (Status)) {
252 printf ("ERROR : Can not open Firmware Device File %S (%r). Exiting.\n", FileName, Status);
253 exit (1);
254 }
255
256 printf (" FD loaded from");
257 //
258 // printf can't print filenames directly as the \ gets interperted as an
259 // escape character.
260 //
261 for (Index2 = 0; FileName[Index2] != '\0'; Index2++) {
262 printf ("%c", FileName[Index2]);
263 }
264
265 if (PeiCoreFile == NULL) {
266 //
267 // Assume the beginning of the FD is an FV and look for the PEI Core.
268 // Load the first one we find.
269 //
270 Status = SecFfsFindPeiCore ((EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) gFdInfo[Index].Address, &PeiCoreFile);
271 if (!EFI_ERROR (Status)) {
272 PeiIndex = Index;
273 printf (" contains SEC Core");
274 }
275 }
276
277 printf ("\n");
278 }
279 //
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.
283 //
284 for (Index = 0, Done = FALSE; !Done; Index++) {
285 //
286 // Save the size of the memory and make a Unicode filename SystemMemory00, ...
287 //
288 gSystemMemory[Index].Size = _wtoi (MemorySizeStr) * 0x100000;
289 _snwprintf (gSystemMemory[Index].FileName, NT_SYSTEM_MEMORY_FILENAME_SIZE, L"SystemMemory%02d", Index);
290
291 //
292 // Find the next region
293 //
294 for (Index1 = 0; MemorySizeStr[Index1] != '!' && MemorySizeStr[Index1] != 0; Index1++)
295 ;
296 if (MemorySizeStr[Index1] == 0) {
297 Done = TRUE;
298 }
299
300 MemorySizeStr = MemorySizeStr + Index1 + 1;
301 }
302
303 printf ("\n");
304
305 //
306 // Hand off to PEI Core
307 //
308 SecLoadFromCore ((UINTN) InitialStackMemory, (UINTN) InitialStackMemorySize, (UINTN) gFdInfo[0].Address, PeiCoreFile);
309
310 //
311 // If we get here, then the PEI Core returned. This is an error as PEI should
312 // always hand off to DXE.
313 //
314 printf ("ERROR : PEI Core returned\n");
315 exit (1);
316 }
317
318 EFI_STATUS
319 WinNtOpenFile (
320 IN CHAR16 *FileName,
321 IN UINT32 MapSize,
322 IN DWORD CreationDisposition,
323 IN OUT EFI_PHYSICAL_ADDRESS *BaseAddress,
324 OUT UINT64 *Length
325 )
326 /*++
327
328 Routine Description:
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.
331
332 Arguments:
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
342
343 Returns:
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
347
348 --*/
349 {
350 HANDLE NtFileHandle;
351 HANDLE NtMapHandle;
352 VOID *VirtualAddress;
353 UINTN FileSize;
354
355 //
356 // Use Win API to open/create a file
357 //
358 NtFileHandle = CreateFile (
359 FileName,
360 GENERIC_READ | GENERIC_WRITE,
361 FILE_SHARE_READ,
362 NULL,
363 CreationDisposition,
364 FILE_ATTRIBUTE_NORMAL,
365 NULL
366 );
367 if (NtFileHandle == INVALID_HANDLE_VALUE) {
368 return EFI_NOT_FOUND;
369 }
370 //
371 // Map the open file into a memory range
372 //
373 NtMapHandle = CreateFileMapping (
374 NtFileHandle,
375 NULL,
376 PAGE_READWRITE,
377 0,
378 MapSize,
379 NULL
380 );
381 if (NtMapHandle == NULL) {
382 return EFI_DEVICE_ERROR;
383 }
384 //
385 // Get the virtual address (address in the emulator) of the mapped file
386 //
387 VirtualAddress = MapViewOfFileEx (
388 NtMapHandle,
389 FILE_MAP_ALL_ACCESS,
390 0,
391 0,
392 MapSize,
393 (LPVOID) (UINTN) *BaseAddress
394 );
395 if (VirtualAddress == NULL) {
396 return EFI_DEVICE_ERROR;
397 }
398
399 if (MapSize == 0) {
400 //
401 // Seek to the end of the file to figure out the true file size.
402 //
403 FileSize = SetFilePointer (
404 NtFileHandle,
405 0,
406 NULL,
407 FILE_END
408 );
409 if (FileSize == -1) {
410 return EFI_DEVICE_ERROR;
411 }
412
413 *Length = (UINT64) FileSize;
414 } else {
415 *Length = (UINT64) MapSize;
416 }
417
418 *BaseAddress = (EFI_PHYSICAL_ADDRESS) (UINTN) VirtualAddress;
419
420 return EFI_SUCCESS;
421 }
422
423 #define BYTES_PER_RECORD 512
424
425 /**
426 Extracts ASSERT() information from a status code structure.
427
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.
438
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().
443
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().
450
451 @retval TRUE The status code specified by CodeType, Value, and Data was
452 converted ASSERT() arguments specified by Filename, Description,
453 and LineNumber.
454 @retval FALSE The status code specified by CodeType, Value, and Data could
455 not be converted to ASSERT() arguments.
456
457 **/
458 STATIC
459 BOOLEAN
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
467 )
468 {
469 EFI_DEBUG_ASSERT_DATA *AssertData;
470
471 ASSERT (Data != NULL);
472 ASSERT (Filename != NULL);
473 ASSERT (Description != NULL);
474 ASSERT (LineNumber != NULL);
475
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;
483 return TRUE;
484 }
485 return FALSE;
486 }
487
488 EFI_STATUS
489 EFIAPI
490 SecPeiReportStatusCode (
491 IN EFI_PEI_SERVICES **PeiServices,
492 IN EFI_STATUS_CODE_TYPE CodeType,
493 IN EFI_STATUS_CODE_VALUE Value,
494 IN UINT32 Instance,
495 IN EFI_GUID * CallerId,
496 IN EFI_STATUS_CODE_DATA * Data OPTIONAL
497 )
498 /*++
499
500 Routine Description:
501
502 This routine produces the ReportStatusCode PEI service. It's passed
503 up to the PEI Core via a PPI. T
504
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.
507
508 Arguments:
509 (see EFI_PEI_REPORT_STATUS_CODE)
510
511 Returns:
512 EFI_SUCCESS - Always return success
513
514 --*/
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
521 {
522 CHAR8 *Format;
523 EFI_DEBUG_INFO *DebugInfo;
524 VA_LIST Marker;
525 CHAR8 PrintBuffer[BYTES_PER_RECORD * 2];
526 CHAR8 *Filename;
527 CHAR8 *Description;
528 UINT32 LineNumber;
529
530 if ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE) {
531 //
532 // This supports DEBUG () marcos
533 // Data format
534 // EFI_STATUS_CODE_DATA
535 // EFI_DEBUG_INFO
536 //
537 // The first 12 * UINT64 bytes of the string are really an
538 // arguement stack to support varargs on the Format string.
539 //
540 if (Data != NULL) {
541 DebugInfo = (EFI_DEBUG_INFO *) (Data + 1);
542 Marker = (VA_LIST) (DebugInfo + 1);
543 Format = (CHAR8 *) (((UINT64 *) Marker) + 12);
544
545 AsciiVSPrint (PrintBuffer, BYTES_PER_RECORD, Format, Marker);
546 printf (PrintBuffer);
547 } else {
548 printf ("DEBUG <null>\n");
549 }
550 }
551
552 if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) &&
553 ((CodeType & EFI_STATUS_CODE_SEVERITY_MASK) == EFI_ERROR_UNRECOVERED)
554 ) {
555 if (Data != NULL && ReportStatusCodeExtractAssertInfo (CodeType, Value, Data, &Filename, &Description, &LineNumber)) {
556 //
557 // Support ASSERT () macro
558 //
559 printf ("ASSERT %s(%d): %s\n", Filename, LineNumber, Description);
560 } else {
561 printf ("ASSERT <null>\n");
562 }
563 CpuBreakpoint ();
564 }
565
566 return EFI_SUCCESS;
567 }
568
569
570 VOID
571 SecLoadFromCore (
572 IN UINTN LargestRegion,
573 IN UINTN LargestRegionSize,
574 IN UINTN BootFirmwareVolumeBase,
575 IN VOID *PeiCorePe32File
576 )
577 /*++
578
579 Routine Description:
580 This is the service to load the PEI Core from the Firmware Volume
581
582 Arguments:
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
587
588 Returns:
589 Success means control is transfered and thus we should never return
590
591 --*/
592 {
593 EFI_STATUS Status;
594 EFI_PHYSICAL_ADDRESS TopOfMemory;
595 VOID *TopOfStack;
596 UINT64 PeiCoreSize;
597 EFI_PHYSICAL_ADDRESS PeiCoreEntryPoint;
598 EFI_PHYSICAL_ADDRESS PeiImageAddress;
599 EFI_PEI_STARTUP_DESCRIPTOR *PeiStartup;
600
601 //
602 // Compute Top Of Memory for Stack and PEI Core Allocations
603 //
604 TopOfMemory = LargestRegion + LargestRegionSize;
605
606 //
607 // Allocate 128KB for the Stack
608 //
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;
612
613 //
614 // Patch value in dispatch table values
615 //
616 gPrivateDispatchTable[0].Ppi = gPeiEfiPeiPeCoffLoader;
617
618 //
619 // Bind this information into the SEC hand-off state
620 //
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;
625
626 //
627 // Load the PEI Core from a Firmware Volume
628 //
629 Status = SecWinNtPeiLoadFile (
630 PeiCorePe32File,
631 &PeiImageAddress,
632 &PeiCoreSize,
633 &PeiCoreEntryPoint
634 );
635 if (EFI_ERROR (Status)) {
636 return ;
637 }
638 //
639 // Transfer control to the PEI Core
640 //
641 SwitchStack (
642 (SWITCH_STACK_ENTRY_POINT) (UINTN) PeiCoreEntryPoint,
643 PeiStartup,
644 NULL,
645 TopOfStack
646 );
647 //
648 // If we get here, then the PEI Core returned. This is an error
649 //
650 return ;
651 }
652
653 EFI_STATUS
654 EFIAPI
655 SecWinNtPeiAutoScan (
656 IN UINTN Index,
657 OUT EFI_PHYSICAL_ADDRESS *MemoryBase,
658 OUT UINT64 *MemorySize
659 )
660 /*++
661
662 Routine Description:
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
668 WinNtOpenFile.
669
670 Arguments:
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
674
675 Returns:
676 EFI_SUCCESS - If memory region was mapped
677 EFI_UNSUPPORTED - If Index is not supported
678
679 --*/
680 {
681 EFI_STATUS Status;
682
683 if (Index >= gSystemMemoryCount) {
684 return EFI_UNSUPPORTED;
685 }
686
687 *MemoryBase = 0;
688 Status = WinNtOpenFile (
689 gSystemMemory[Index].FileName,
690 (UINT32) gSystemMemory[Index].Size,
691 OPEN_ALWAYS,
692 MemoryBase,
693 MemorySize
694 );
695
696 gSystemMemory[Index].Memory = *MemoryBase;
697
698 return Status;
699 }
700
701 VOID *
702 EFIAPI
703 SecWinNtWinNtThunkAddress (
704 VOID
705 )
706 /*++
707
708 Routine Description:
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.
712
713 Arguments:
714 InterfaceSize - sizeof (EFI_WIN_NT_THUNK_PROTOCOL);
715 InterfaceBase - Address of the gWinNt global
716
717 Returns:
718 EFI_SUCCESS - Data returned
719
720 --*/
721 {
722 return gWinNt;
723 }
724
725
726 EFI_STATUS
727 EFIAPI
728 SecWinNtPeiLoadFile (
729 IN VOID *Pe32Data,
730 IN EFI_PHYSICAL_ADDRESS *ImageAddress,
731 IN UINT64 *ImageSize,
732 IN EFI_PHYSICAL_ADDRESS *EntryPoint
733 )
734 /*++
735
736 Routine Description:
737 Loads and relocates a PE/COFF image into memory.
738
739 Arguments:
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
744
745 Returns:
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
748
749 --*/
750 {
751 EFI_STATUS Status;
752 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;
753
754 ZeroMem (&ImageContext, sizeof (ImageContext));
755 ImageContext.Handle = Pe32Data;
756
757 ImageContext.ImageRead = (PE_COFF_LOADER_READ_FILE) SecImageRead;
758
759 Status = gPeiEfiPeiPeCoffLoader->GetImageInfo (gPeiEfiPeiPeCoffLoader, &ImageContext);
760 if (EFI_ERROR (Status)) {
761 return Status;
762 }
763 //
764 // Allocate space in NT (not emulator) memory. Extra space is for alignment
765 //
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;
769 }
770 //
771 // Align buffer on section boundry
772 //
773 ImageContext.ImageAddress += ImageContext.SectionAlignment;
774 ImageContext.ImageAddress &= ~(ImageContext.SectionAlignment - 1);
775
776 Status = gPeiEfiPeiPeCoffLoader->LoadImage (gPeiEfiPeiPeCoffLoader, &ImageContext);
777 if (EFI_ERROR (Status)) {
778 return Status;
779 }
780
781 Status = gPeiEfiPeiPeCoffLoader->RelocateImage (gPeiEfiPeiPeCoffLoader, &ImageContext);
782 if (EFI_ERROR (Status)) {
783 return Status;
784 }
785
786 //
787 // BugBug: Flush Instruction Cache Here when CPU Lib is ready
788 //
789
790 *ImageAddress = ImageContext.ImageAddress;
791 *ImageSize = ImageContext.ImageSize;
792 *EntryPoint = ImageContext.EntryPoint;
793
794 return EFI_SUCCESS;
795 }
796
797 EFI_STATUS
798 EFIAPI
799 SecWinNtFdAddress (
800 IN UINTN Index,
801 IN OUT EFI_PHYSICAL_ADDRESS *FdBase,
802 IN OUT UINT64 *FdSize
803 )
804 /*++
805
806 Routine Description:
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.
809
810 Arguments:
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
814
815 Returns:
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
818
819 --*/
820 {
821 if (Index >= gFdInfoCount) {
822 return EFI_UNSUPPORTED;
823 }
824
825 *FdBase = gFdInfo[Index].Address;
826 *FdSize = gFdInfo[Index].Size;
827
828 if (*FdBase == 0 && *FdSize == 0) {
829 return EFI_UNSUPPORTED;
830 }
831
832 return EFI_SUCCESS;
833 }
834
835 EFI_STATUS
836 EFIAPI
837 SecImageRead (
838 IN VOID *FileHandle,
839 IN UINTN FileOffset,
840 IN OUT UINTN *ReadSize,
841 OUT VOID *Buffer
842 )
843 /*++
844
845 Routine Description:
846 Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
847
848 Arguments:
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.
853
854 Returns:
855 EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
856
857 --*/
858 {
859 CHAR8 *Destination8;
860 CHAR8 *Source8;
861 UINTN Length;
862
863 Destination8 = Buffer;
864 Source8 = (CHAR8 *) ((UINTN) FileHandle + FileOffset);
865 Length = *ReadSize;
866 while (Length--) {
867 *(Destination8++) = *(Source8++);
868 }
869
870 return EFI_SUCCESS;
871 }
872
873 CHAR16 *
874 AsciiToUnicode (
875 IN CHAR8 *Ascii,
876 IN UINTN *StrLen OPTIONAL
877 )
878 /*++
879
880 Routine Description:
881 Convert the passed in Ascii string to Unicode.
882 Optionally return the length of the strings.
883
884 Arguments:
885 Ascii - Ascii string to convert
886 StrLen - Length of string
887
888 Returns:
889 Pointer to malloc'ed Unicode version of Ascii
890
891 --*/
892 {
893 UINTN Index;
894 CHAR16 *Unicode;
895
896 //
897 // Allocate a buffer for unicode string
898 //
899 for (Index = 0; Ascii[Index] != '\0'; Index++)
900 ;
901 Unicode = malloc ((Index + 1) * sizeof (CHAR16));
902 if (Unicode == NULL) {
903 return NULL;
904 }
905
906 for (Index = 0; Ascii[Index] != '\0'; Index++) {
907 Unicode[Index] = (CHAR16) Ascii[Index];
908 }
909
910 Unicode[Index] = '\0';
911
912 if (StrLen != NULL) {
913 *StrLen = Index;
914 }
915
916 return Unicode;
917 }
918
919 UINTN
920 CountSeperatorsInString (
921 IN const CHAR16 *String,
922 IN CHAR16 Seperator
923 )
924 /*++
925
926 Routine Description:
927 Count the number of seperators in String
928
929 Arguments:
930 String - String to process
931 Seperator - Item to count
932
933 Returns:
934 Number of Seperator in String
935
936 --*/
937 {
938 UINTN Count;
939
940 for (Count = 0; *String != '\0'; String++) {
941 if (*String == Seperator) {
942 Count++;
943 }
944 }
945
946 return Count;
947 }
948
949
950 EFI_STATUS
951 AddModHandle (
952 IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext,
953 IN VOID *ModHandle
954 )
955 /*++
956
957 Routine Description:
958 Store the ModHandle in an array indexed by the Pdb File name.
959 The ModHandle is needed to unload the image.
960
961 Arguments:
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
965 FreeLibrary().
966
967 Returns:
968 EFI_SUCCESS - ModHandle was stored.
969
970 --*/
971 {
972 UINTN Index;
973 PDB_NAME_TO_MOD_HANDLE *Array;
974 UINTN PreviousSize;
975
976
977 Array = mPdbNameModHandleArray;
978 for (Index = 0; Index < mPdbNameModHandleArraySize; Index++, Array++) {
979 if (Array->PdbPointer == NULL) {
980 //
981 // Make a copy of the stirng and store the ModHandle
982 //
983 Array->PdbPointer = malloc (strlen (ImageContext->PdbPointer) + 1);
984 ASSERT (Array->PdbPointer != NULL);
985
986 strcpy (Array->PdbPointer, ImageContext->PdbPointer);
987 Array->ModHandle = ModHandle;
988 return EFI_SUCCESS;
989 }
990 }
991
992 //
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.
997 //
998 PreviousSize = mPdbNameModHandleArraySize * sizeof (PDB_NAME_TO_MOD_HANDLE);
999 mPdbNameModHandleArraySize += MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE;
1000
1001 mPdbNameModHandleArray = realloc (mPdbNameModHandleArray, mPdbNameModHandleArraySize * sizeof (PDB_NAME_TO_MOD_HANDLE));
1002 if (mPdbNameModHandleArray == NULL) {
1003 ASSERT (FALSE);
1004 return EFI_OUT_OF_RESOURCES;
1005 }
1006
1007 memset (mPdbNameModHandleArray + PreviousSize, 0, MAX_PDB_NAME_TO_MOD_HANDLE_ARRAY_SIZE * sizeof (PDB_NAME_TO_MOD_HANDLE));
1008
1009 return AddModHandle (ImageContext, ModHandle);
1010 }
1011
1012
1013 VOID *
1014 RemoveModeHandle (
1015 IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
1016 )
1017 /*++
1018
1019 Routine Description:
1020 Return the ModHandle and delete the entry in the array.
1021
1022 Arguments:
1023 ImageContext - Input data returned from PE Laoder Library. Used to find the
1024 .PDB file name of the PE Image.
1025
1026 Returns:
1027 ModHandle - ModHandle assoicated with ImageContext is returned
1028 NULL - No ModHandle associated with ImageContext
1029
1030 --*/
1031 {
1032 UINTN Index;
1033 PDB_NAME_TO_MOD_HANDLE *Array;
1034
1035 if (ImageContext->PdbPointer == NULL) {
1036 //
1037 // If no PDB pointer there is no ModHandle so return NULL
1038 //
1039 return NULL;
1040 }
1041
1042 Array = mPdbNameModHandleArray;
1043 for (Index = 0; Index < mPdbNameModHandleArraySize; Index++, Array++) {
1044 if ((Array->PdbPointer != NULL) && (strcmp(Array->PdbPointer, ImageContext->PdbPointer) == 0)) {
1045 //
1046 // If you find a match return it and delete the entry
1047 //
1048 free (Array->PdbPointer);
1049 Array->PdbPointer = NULL;
1050 return Array->ModHandle;
1051 }
1052 }
1053
1054 return NULL;
1055 }
1056
1057
1058
1059 EFI_STATUS
1060 EFIAPI
1061 SecNt32PeCoffGetImageInfo (
1062 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,
1063 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
1064 )
1065 {
1066 EFI_STATUS Status;
1067
1068 Status = PeCoffLoaderGetImageInfo (ImageContext);
1069 if (EFI_ERROR (Status)) {
1070 return Status;
1071 }
1072
1073 switch (ImageContext->ImageType) {
1074
1075 case EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION:
1076 ImageContext->ImageCodeMemoryType = EfiLoaderCode;
1077 ImageContext->ImageDataMemoryType = EfiLoaderData;
1078 break;
1079
1080 case EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER:
1081 ImageContext->ImageCodeMemoryType = EfiBootServicesCode;
1082 ImageContext->ImageDataMemoryType = EfiBootServicesData;
1083 break;
1084
1085 case EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER:
1086 case EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER:
1087 ImageContext->ImageCodeMemoryType = EfiRuntimeServicesCode;
1088 ImageContext->ImageDataMemoryType = EfiRuntimeServicesData;
1089 break;
1090
1091 default:
1092 ImageContext->ImageError = IMAGE_ERROR_INVALID_SUBSYSTEM;
1093 return RETURN_UNSUPPORTED;
1094 }
1095
1096 return Status;
1097 }
1098
1099 EFI_STATUS
1100 EFIAPI
1101 SecNt32PeCoffLoadImage (
1102 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,
1103 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
1104 )
1105 {
1106 EFI_STATUS Status;
1107
1108 Status = PeCoffLoaderLoadImage (ImageContext);
1109 return Status;
1110 }
1111
1112 EFI_STATUS
1113 EFIAPI
1114 SecNt32PeCoffRelocateImage (
1115 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,
1116 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
1117 )
1118 {
1119 EFI_STATUS Status;
1120 VOID *DllEntryPoint;
1121 CHAR16 *DllFileName;
1122 HMODULE Library;
1123 UINTN Index;
1124
1125
1126 Status = PeCoffLoaderRelocateImage (ImageContext);
1127 if (EFI_ERROR (Status)) {
1128 //
1129 // We could not relocated the image in memory properly
1130 //
1131 return Status;
1132 }
1133
1134 //
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.
1141 //
1142
1143 DllEntryPoint = NULL;
1144
1145 //
1146 // Load the DLL if it's not an EBC image.
1147 //
1148 if ((ImageContext->PdbPointer != NULL) &&
1149 (ImageContext->Machine != EFI_IMAGE_MACHINE_EBC)) {
1150 //
1151 // Convert filename from ASCII to Unicode
1152 //
1153 DllFileName = AsciiToUnicode (ImageContext->PdbPointer, &Index);
1154
1155 //
1156 // Check that we have a valid filename
1157 //
1158 if (Index < 5 || DllFileName[Index - 4] != '.') {
1159 free (DllFileName);
1160
1161 //
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.
1165 //
1166 return EFI_SUCCESS;
1167 }
1168 //
1169 // Replace .PDB with .DLL on the filename
1170 //
1171 DllFileName[Index - 3] = 'D';
1172 DllFileName[Index - 2] = 'L';
1173 DllFileName[Index - 1] = 'L';
1174
1175 //
1176 // Load the .DLL file into the user process's address space for source
1177 // level debug
1178 //
1179 Library = LoadLibraryEx (DllFileName, NULL, DONT_RESOLVE_DLL_REFERENCES);
1180 if (Library != NULL) {
1181 //
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
1188 //
1189 DllEntryPoint = (VOID *) (UINTN) GetProcAddress (Library, "InitializeDriver");
1190
1191 }
1192
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);
1197 } else {
1198 wprintf (L"WARNING: No source level debug %s. \n", DllFileName);
1199 }
1200
1201 free (DllFileName);
1202 }
1203
1204 //
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.
1208 //
1209 return EFI_SUCCESS;
1210 }
1211
1212
1213 EFI_STATUS
1214 EFIAPI
1215 SecNt32PeCoffUnloadimage (
1216 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,
1217 IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
1218 )
1219 {
1220 VOID *ModHandle;
1221
1222 ModHandle = RemoveModeHandle (ImageContext);
1223 if (ModHandle != NULL) {
1224 FreeLibrary (ModHandle);
1225 }
1226 return EFI_SUCCESS;
1227 }
1228
1229 VOID
1230 _ModuleEntryPoint (
1231 VOID
1232 )
1233 {
1234 }
1235
1236 #pragma warning(default : 4996)