3 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4 Portions copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 Unix emulator of SEC phase. It's really a Posix application, but this is
19 Ok since all the other modules for NT32 are NOT Posix applications.
21 This program processes host environment variables and figures out
22 what the memory layout will be, how may FD's will be loaded and also
23 what the boot mode is.
25 The SEC registers a set of services with the SEC core. gPrivateDispatchTable
26 is a list of PPI's produced by the SEC that are availble for usage in PEI.
28 This code produces 128 K of temporary memory for the PEI stack by opening a
29 host file and mapping it directly to memory addresses.
31 The system.cmd script is used to set host environment variables that drive
32 the configuration opitons of the SEC.
38 #include <Ppi/UnixPeiLoadFile.h>
39 #include <Ppi/TemporaryRamSupport.h>
43 #define MAP_ANONYMOUS MAP_ANON
44 char *gGdbWorkingFileName
= NULL
;
51 #if defined(__APPLE__) || defined(MDE_CPU_X64)
52 UNIX_PEI_LOAD_FILE_PPI mSecUnixLoadFilePpi
= { GasketSecUnixPeiLoadFile
};
53 PEI_UNIX_AUTOSCAN_PPI mSecUnixAutoScanPpi
= { GasketSecUnixPeiAutoScan
};
54 PEI_UNIX_THUNK_PPI mSecUnixThunkPpi
= { GasketSecUnixUnixThunkAddress
};
55 EFI_PEI_PROGRESS_CODE_PPI mSecStatusCodePpi
= { GasketSecPeiReportStatusCode
};
56 UNIX_FWH_PPI mSecFwhInformationPpi
= { GasketSecUnixFdAddress
};
57 EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI mSecTemporaryRamSupportPpi
= { GasketSecTemporaryRamSupport
};
59 UNIX_PEI_LOAD_FILE_PPI mSecUnixLoadFilePpi
= { SecUnixPeiLoadFile
};
60 PEI_UNIX_AUTOSCAN_PPI mSecUnixAutoScanPpi
= { SecUnixPeiAutoScan
};
61 PEI_UNIX_THUNK_PPI mSecUnixThunkPpi
= { SecUnixUnixThunkAddress
};
62 EFI_PEI_PROGRESS_CODE_PPI mSecStatusCodePpi
= { SecPeiReportStatusCode
};
63 UNIX_FWH_PPI mSecFwhInformationPpi
= { SecUnixFdAddress
};
64 EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI mSecTemporaryRamSupportPpi
= { SecTemporaryRamSupport
};
67 EFI_PEI_PPI_DESCRIPTOR gPrivateDispatchTable
[] = {
69 EFI_PEI_PPI_DESCRIPTOR_PPI
,
70 &gUnixPeiLoadFilePpiGuid
,
74 EFI_PEI_PPI_DESCRIPTOR_PPI
,
75 &gPeiUnixAutoScanPpiGuid
,
79 EFI_PEI_PPI_DESCRIPTOR_PPI
,
80 &gPeiUnixThunkPpiGuid
,
84 EFI_PEI_PPI_DESCRIPTOR_PPI
,
85 &gEfiPeiStatusCodePpiGuid
,
89 EFI_PEI_PPI_DESCRIPTOR_PPI
,
90 &gEfiTemporaryRamSupportPpiGuid
,
91 &mSecTemporaryRamSupportPpi
94 EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
,
96 &mSecFwhInformationPpi
102 // Default information about where the FD is located.
103 // This array gets filled in with information from EFI_FIRMWARE_VOLUMES
104 // EFI_FIRMWARE_VOLUMES is a host environment variable set by system.cmd.
105 // The number of array elements is allocated base on parsing
106 // EFI_FIRMWARE_VOLUMES and the memory is never freed.
108 UINTN gFdInfoCount
= 0;
109 UNIX_FD_INFO
*gFdInfo
;
112 // Array that supports seperate memory rantes.
113 // The memory ranges are set in system.cmd via the EFI_MEMORY_SIZE variable.
114 // The number of array elements is allocated base on parsing
115 // EFI_MEMORY_SIZE and the memory is never freed.
117 UINTN gSystemMemoryCount
= 0;
118 UNIX_SYSTEM_MEMORY
*gSystemMemory
;
122 UINTN mImageContextModHandleArraySize
= 0;
123 IMAGE_CONTEXT_TO_MOD_HANDLE
*mImageContextModHandleArray
= NULL
;
129 UINT32 TemporaryMemoryBase
,
130 UINT32 PermenentMemoryBase
133 EFI_PHYSICAL_ADDRESS
*
143 IN OUT EFI_PHYSICAL_ADDRESS
*BaseAddress
,
149 SecNt32PeCoffRelocateImage (
150 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
163 Main entry point to SEC for Unix. This is a unix program
166 Argc - Number of command line arguments
167 Argv - Array of command line argument strings
168 Envp - Array of environmemt variable strings
177 EFI_PHYSICAL_ADDRESS InitialStackMemory
;
178 UINT64 InitialStackMemorySize
;
186 CHAR16
*MemorySizeStr
;
187 CHAR16
*FirmwareVolumesStr
;
193 MemorySizeStr
= (CHAR16
*) PcdGetPtr (PcdUnixMemorySizeForSecMain
);
194 FirmwareVolumesStr
= (CHAR16
*) PcdGetPtr (PcdUnixFirmwareVolume
);
196 printf ("\nEDK SEC Main UNIX Emulation Environment from edk2.sourceforge.net\n");
200 // We can't use dlopen on OS X, so we need a scheme to get symboles into gdb
201 // We need to create a temp file that contains gdb commands so we can load
202 // symbols when we load every PE/COFF image.
204 Index
= strlen (*Argv
);
205 gGdbWorkingFileName
= malloc (Index
+ strlen(".gdb") + 1);
206 strcpy (gGdbWorkingFileName
, *Argv
);
207 strcat (gGdbWorkingFileName
, ".gdb");
212 // Allocate space for gSystemMemory Array
214 gSystemMemoryCount
= CountSeperatorsInString (MemorySizeStr
, '!') + 1;
215 gSystemMemory
= calloc (gSystemMemoryCount
, sizeof (UNIX_SYSTEM_MEMORY
));
216 if (gSystemMemory
== NULL
) {
217 printf ("ERROR : Can not allocate memory for system. Exiting.\n");
221 // Allocate space for gSystemMemory Array
223 gFdInfoCount
= CountSeperatorsInString (FirmwareVolumesStr
, '!') + 1;
224 gFdInfo
= calloc (gFdInfoCount
, sizeof (UNIX_FD_INFO
));
225 if (gFdInfo
== NULL
) {
226 printf ("ERROR : Can not allocate memory for fd info. Exiting.\n");
230 // Setup Boot Mode. If BootModeStr == "" then BootMode = 0 (BOOT_WITH_FULL_CONFIGURATION)
232 printf (" BootMode 0x%02x\n", (unsigned int)PcdGet32 (PcdUnixBootMode
));
235 // Open up a 128K file to emulate temp memory for PEI.
236 // on a real platform this would be SRAM, or using the cache as RAM.
237 // Set InitialStackMemory to zero so UnixOpenFile will allocate a new mapping
239 InitialStackMemorySize
= STACK_SIZE
;
240 InitialStackMemory
= (UINTN
)MapMemory(0,
241 (UINT32
) InitialStackMemorySize
,
242 PROT_READ
| PROT_WRITE
| PROT_EXEC
,
243 MAP_ANONYMOUS
| MAP_PRIVATE
);
244 if (InitialStackMemory
== 0) {
245 printf ("ERROR : Can not open SecStack Exiting\n");
249 printf (" SEC passing in %u KB of temp RAM at 0x%08lx to PEI\n",
250 (unsigned int)(InitialStackMemorySize
/ 1024),
251 (unsigned long)InitialStackMemory
);
253 for (StackPointer
= (UINTN
*) (UINTN
) InitialStackMemory
;
254 StackPointer
< (UINTN
*)(UINTN
)((UINTN
) InitialStackMemory
+ (UINT64
) InitialStackMemorySize
);
256 *StackPointer
= 0x5AA55AA5;
260 // Open All the firmware volumes and remember the info in the gFdInfo global
262 FileName
= (CHAR8
*)malloc (StrLen (FirmwareVolumesStr
) + 1);
263 if (FileName
== NULL
) {
264 printf ("ERROR : Can not allocate memory for firmware volume string\n");
269 for (Done
= FALSE
, Index
= 0, PeiIndex
= 0, PeiCoreFile
= NULL
;
270 FirmwareVolumesStr
[Index2
] != 0;
272 for (Index1
= 0; (FirmwareVolumesStr
[Index2
] != '!') && (FirmwareVolumesStr
[Index2
] != 0); Index2
++)
273 FileName
[Index1
++] = FirmwareVolumesStr
[Index2
];
274 if (FirmwareVolumesStr
[Index2
] == '!')
276 FileName
[Index1
] = '\0';
279 // Open the FD and remmeber where it got mapped into our processes address space
283 &gFdInfo
[Index
].Address
,
286 if (EFI_ERROR (Status
)) {
287 printf ("ERROR : Can not open Firmware Device File %s (%x). Exiting.\n", FileName
, (unsigned int)Status
);
291 printf (" FD loaded from %s at 0x%08lx",
292 FileName
, (unsigned long)gFdInfo
[Index
].Address
);
294 if (PeiCoreFile
== NULL
) {
296 // Assume the beginning of the FD is an FV and look for the PEI Core.
297 // Load the first one we find.
299 Status
= SecFfsFindPeiCore ((EFI_FIRMWARE_VOLUME_HEADER
*) (UINTN
) gFdInfo
[Index
].Address
, &PeiCoreFile
);
300 if (!EFI_ERROR (Status
)) {
302 printf (" contains SEC Core");
309 // Calculate memory regions and store the information in the gSystemMemory
310 // global for later use. The autosizing code will use this data to
311 // map this memory into the SEC process memory space.
318 // Save the size of the memory.
320 while (MemorySizeStr
[Index1
] >= '0' && MemorySizeStr
[Index1
] <= '9') {
321 val
= val
* 10 + MemorySizeStr
[Index1
] - '0';
324 gSystemMemory
[Index
++].Size
= val
* 0x100000;
325 if (MemorySizeStr
[Index1
] == 0)
333 // Hand off to PEI Core
335 SecLoadFromCore ((UINTN
) InitialStackMemory
, (UINTN
) InitialStackMemorySize
, (UINTN
) gFdInfo
[0].Address
, PeiCoreFile
);
338 // If we get here, then the PEI Core returned. This is an error as PEI should
339 // always hand off to DXE.
341 printf ("ERROR : PEI Core returned\n");
345 EFI_PHYSICAL_ADDRESS
*
352 STATIC UINTN base
= 0x40000000;
353 CONST UINTN align
= (1 << 24);
355 BOOLEAN isAligned
= 0;
358 // Try to get an aligned block somewhere in the address space of this
361 while((!isAligned
) && (base
!= 0)) {
362 res
= mmap ((void *)base
, length
, prot
, flags
, fd
, 0);
363 if (res
== MAP_FAILED
) {
366 if ((((UINTN
)res
) & ~(align
-1)) == (UINTN
)res
) {
380 IN OUT EFI_PHYSICAL_ADDRESS
*BaseAddress
,
386 Opens and memory maps a file using Unix services. If BaseAddress is non zero
387 the process will try and allocate the memory starting at BaseAddress.
390 FileName - The name of the file to open and map
391 MapSize - The amount of the file to map in bytes
392 CreationDisposition - The flags to pass to CreateFile(). Use to create new files for
393 memory emulation, and exiting files for firmware volume emulation
394 BaseAddress - The base address of the mapped file in the user address space.
395 If passed in as NULL the a new memory region is used.
396 If passed in as non NULL the request memory region is used for
397 the mapping of the file into the process space.
398 Length - The size of the mapped region in bytes
401 EFI_SUCCESS - The file was opened and mapped.
402 EFI_NOT_FOUND - FileName was not found in the current directory
403 EFI_DEVICE_ERROR - An error occured attempting to map the opened file
411 fd
= open (FileName
, O_RDONLY
);
413 return EFI_NOT_FOUND
;
414 FileSize
= lseek (fd
, 0, SEEK_END
);
419 /* Read entry address. */
420 lseek (fd
, FileSize
- 0x20, SEEK_SET
);
421 if (read (fd
, &EntryAddress
, 4) != 4)
424 return EFI_DEVICE_ERROR
;
429 res
= MapMemory(fd
, FileSize
, PROT_READ
| PROT_WRITE
| PROT_EXEC
, MAP_PRIVATE
);
433 if (res
== MAP_FAILED
)
434 return EFI_DEVICE_ERROR
;
436 *Length
= (UINT64
) FileSize
;
437 *BaseAddress
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) res
;
442 #define BYTES_PER_RECORD 512
446 SecPeiReportStatusCode (
447 IN CONST EFI_PEI_SERVICES
**PeiServices
,
448 IN EFI_STATUS_CODE_TYPE CodeType
,
449 IN EFI_STATUS_CODE_VALUE Value
,
451 IN CONST EFI_GUID
*CallerId
,
452 IN CONST EFI_STATUS_CODE_DATA
*Data OPTIONAL
458 This routine produces the ReportStatusCode PEI service. It's passed
459 up to the PEI Core via a PPI. T
461 This code currently uses the UNIX clib printf. This does not work the same way
462 as the EFI Print (), as %t, %g, %s as Unicode are not supported.
465 (see EFI_PEI_REPORT_STATUS_CODE)
468 EFI_SUCCESS - Always return success
471 // TODO: PeiServices - add argument and description to function comment
472 // TODO: CodeType - add argument and description to function comment
473 // TODO: Value - add argument and description to function comment
474 // TODO: Instance - add argument and description to function comment
475 // TODO: CallerId - add argument and description to function comment
476 // TODO: Data - add argument and description to function comment
480 CHAR8 PrintBuffer
[BYTES_PER_RECORD
* 2];
488 } else if (ReportStatusCodeExtractAssertInfo (CodeType
, Value
, Data
, &Filename
, &Description
, &LineNumber
)) {
490 // Processes ASSERT ()
492 printf ("ASSERT %s(%d): %s\n", Filename
, (int)LineNumber
, Description
);
494 } else if (ReportStatusCodeExtractDebugInfo (Data
, &ErrorLevel
, &Marker
, &Format
)) {
496 // Process DEBUG () macro
498 AsciiBSPrint (PrintBuffer
, BYTES_PER_RECORD
, Format
, Marker
);
499 printf ("%s", PrintBuffer
);
508 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
509 IN VOID
*Context1
, OPTIONAL
510 IN VOID
*Context2
, OPTIONAL
511 IN VOID
*Context3
, OPTIONAL
517 IN UINTN LargestRegion
,
518 IN UINTN LargestRegionSize
,
519 IN UINTN BootFirmwareVolumeBase
,
520 IN VOID
*PeiCorePe32File
525 This is the service to load the PEI Core from the Firmware Volume
528 LargestRegion - Memory to use for PEI.
529 LargestRegionSize - Size of Memory to use for PEI
530 BootFirmwareVolumeBase - Start of the Boot FV
531 PeiCorePe32File - PEI Core PE32
534 Success means control is transfered and thus we should never return
539 EFI_PHYSICAL_ADDRESS TopOfMemory
;
542 EFI_PHYSICAL_ADDRESS PeiCoreEntryPoint
;
543 EFI_PHYSICAL_ADDRESS PeiImageAddress
;
544 EFI_SEC_PEI_HAND_OFF
*SecCoreData
;
546 EFI_PEI_PPI_DESCRIPTOR
*DispatchTable
;
547 UINTN DispatchTableSize
;
550 // Compute Top Of Memory for Stack and PEI Core Allocations
552 TopOfMemory
= LargestRegion
+ LargestRegionSize
;
553 PeiStackSize
= (UINTN
)RShiftU64((UINT64
)STACK_SIZE
,1);
556 // |-----------| <---- TemporaryRamBase + TemporaryRamSize
559 // |-----------| <---- StackBase / PeiTemporaryMemoryBase
562 // |-----------| <---- TemporaryRamBase
564 TopOfStack
= (VOID
*)(LargestRegion
+ PeiStackSize
);
565 TopOfMemory
= LargestRegion
+ PeiStackSize
;
568 // Reservet space for storing PeiCore's parament in stack.
570 TopOfStack
= (VOID
*)((UINTN
)TopOfStack
- sizeof (EFI_SEC_PEI_HAND_OFF
) - CPU_STACK_ALIGNMENT
);
571 TopOfStack
= ALIGN_POINTER (TopOfStack
, CPU_STACK_ALIGNMENT
);
575 // Bind this information into the SEC hand-off state
577 SecCoreData
= (EFI_SEC_PEI_HAND_OFF
*)(UINTN
) TopOfStack
;
578 SecCoreData
->DataSize
= sizeof(EFI_SEC_PEI_HAND_OFF
);
579 SecCoreData
->BootFirmwareVolumeBase
= (VOID
*)BootFirmwareVolumeBase
;
580 SecCoreData
->BootFirmwareVolumeSize
= PcdGet32 (PcdUnixFirmwareFdSize
);
581 SecCoreData
->TemporaryRamBase
= (VOID
*)(UINTN
)LargestRegion
;
582 SecCoreData
->TemporaryRamSize
= STACK_SIZE
;
583 SecCoreData
->StackBase
= SecCoreData
->TemporaryRamBase
;
584 SecCoreData
->StackSize
= PeiStackSize
;
585 SecCoreData
->PeiTemporaryRamBase
= (VOID
*) ((UINTN
) SecCoreData
->TemporaryRamBase
+ PeiStackSize
);
586 SecCoreData
->PeiTemporaryRamSize
= STACK_SIZE
- PeiStackSize
;
589 // Load the PEI Core from a Firmware Volume
591 Status
= SecUnixPeiLoadFile (
597 if (EFI_ERROR (Status
)) {
601 DispatchTableSize
= sizeof (gPrivateDispatchTable
);
602 DispatchTableSize
+= OverrideDispatchTableExtraSize ();
604 DispatchTable
= malloc (DispatchTableSize
);
605 if (DispatchTable
== NULL
) {
610 // Allow an override for extra PPIs to be passed up to PEI
611 // This is an easy way to enable OS specific customizations
613 OverrideDispatchTable (&gPrivateDispatchTable
[0], sizeof (gPrivateDispatchTable
), DispatchTable
, DispatchTableSize
);
616 // Transfer control to the PEI Core
619 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) PeiCoreEntryPoint
,
621 (VOID
*)DispatchTable
,
626 // If we get here, then the PEI Core returned. This is an error
635 OUT EFI_PHYSICAL_ADDRESS
*MemoryBase
,
636 OUT UINT64
*MemorySize
641 This service is called from Index == 0 until it returns EFI_UNSUPPORTED.
642 It allows discontiguous memory regions to be supported by the emulator.
643 It uses gSystemMemory[] and gSystemMemoryCount that were created by
644 parsing the host environment variable EFI_MEMORY_SIZE.
645 The size comes from the varaible and the address comes from the call to
649 Index - Which memory region to use
650 MemoryBase - Return Base address of memory region
651 MemorySize - Return size in bytes of the memory region
654 EFI_SUCCESS - If memory region was mapped
655 EFI_UNSUPPORTED - If Index is not supported
661 if (Index
>= gSystemMemoryCount
) {
662 return EFI_UNSUPPORTED
;
666 res
= MapMemory(0, gSystemMemory
[Index
].Size
,
667 PROT_READ
| PROT_WRITE
| PROT_EXEC
,
668 MAP_PRIVATE
| MAP_ANONYMOUS
);
669 if (res
== MAP_FAILED
)
670 return EFI_DEVICE_ERROR
;
671 *MemorySize
= gSystemMemory
[Index
].Size
;
672 *MemoryBase
= (UINTN
)res
;
673 gSystemMemory
[Index
].Memory
= *MemoryBase
;
680 SecUnixUnixThunkAddress (
686 Since the SEC is the only Unix program in stack it must export
687 an interface to do POSIX calls. gUnix is initailized in UnixThunk.c.
690 InterfaceSize - sizeof (EFI_WIN_NT_THUNK_PROTOCOL);
691 InterfaceBase - Address of the gUnix global
694 EFI_SUCCESS - Data returned
705 OUT EFI_PHYSICAL_ADDRESS
*ImageAddress
,
706 OUT UINT64
*ImageSize
,
707 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint
712 Loads and relocates a PE/COFF image into memory.
715 Pe32Data - The base address of the PE/COFF file that is to be loaded and relocated
716 ImageAddress - The base address of the relocated PE/COFF image
717 ImageSize - The size of the relocated PE/COFF image
718 EntryPoint - The entry point of the relocated PE/COFF image
721 EFI_SUCCESS - The file was loaded and relocated
722 EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file
727 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
729 ZeroMem (&ImageContext
, sizeof (ImageContext
));
730 ImageContext
.Handle
= Pe32Data
;
732 ImageContext
.ImageRead
= (PE_COFF_LOADER_READ_FILE
) SecImageRead
;
734 Status
= PeCoffLoaderGetImageInfo (&ImageContext
);
735 if (EFI_ERROR (Status
)) {
741 // Allocate space in UNIX (not emulator) memory. Extra space is for alignment
743 ImageContext
.ImageAddress
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) MapMemory (
745 (UINT32
) (ImageContext
.ImageSize
+ (ImageContext
.SectionAlignment
* 2)),
746 PROT_READ
| PROT_WRITE
| PROT_EXEC
,
747 MAP_ANONYMOUS
| MAP_PRIVATE
749 if (ImageContext
.ImageAddress
== 0) {
750 return EFI_OUT_OF_RESOURCES
;
754 // Align buffer on section boundry
756 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
- 1;
757 ImageContext
.ImageAddress
&= ~((EFI_PHYSICAL_ADDRESS
)(ImageContext
.SectionAlignment
- 1));
760 Status
= PeCoffLoaderLoadImage (&ImageContext
);
761 if (EFI_ERROR (Status
)) {
765 Status
= PeCoffLoaderRelocateImage (&ImageContext
);
766 if (EFI_ERROR (Status
)) {
771 SecPeCoffRelocateImageExtraAction (&ImageContext
);
774 // BugBug: Flush Instruction Cache Here when CPU Lib is ready
777 *ImageAddress
= ImageContext
.ImageAddress
;
778 *ImageSize
= ImageContext
.ImageSize
;
779 *EntryPoint
= ImageContext
.EntryPoint
;
787 SecPeCoffGetEntryPoint (
789 IN OUT VOID
**EntryPoint
793 EFI_PHYSICAL_ADDRESS ImageAddress
;
795 EFI_PHYSICAL_ADDRESS PhysEntryPoint
;
797 Status
= SecUnixPeiLoadFile (Pe32Data
, &ImageAddress
, &ImageSize
, &PhysEntryPoint
);
799 *EntryPoint
= (VOID
*)(UINTN
)PhysEntryPoint
;
809 IN OUT EFI_PHYSICAL_ADDRESS
*FdBase
,
810 IN OUT UINT64
*FdSize
,
811 IN OUT EFI_PHYSICAL_ADDRESS
*FixUp
816 Return the FD Size and base address. Since the FD is loaded from a
817 file into host memory only the SEC will know it's address.
820 Index - Which FD, starts at zero.
821 FdSize - Size of the FD in bytes
822 FdBase - Start address of the FD. Assume it points to an FV Header
823 FixUp - Difference between actual FD address and build address
826 EFI_SUCCESS - Return the Base address and size of the FV
827 EFI_UNSUPPORTED - Index does nto map to an FD in the system
831 if (Index
>= gFdInfoCount
) {
832 return EFI_UNSUPPORTED
;
835 *FdBase
= gFdInfo
[Index
].Address
;
836 *FdSize
= gFdInfo
[Index
].Size
;
839 if (*FdBase
== 0 && *FdSize
== 0) {
840 return EFI_UNSUPPORTED
;
845 // FD 0 has XIP code and well known PCD values
846 // If the memory buffer could not be allocated at the FD build address
847 // the Fixup is the difference.
849 *FixUp
= *FdBase
- PcdGet64 (PcdUnixFdBaseAddress
);
860 IN OUT UINTN
*ReadSize
,
866 Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
869 FileHandle - The handle to the PE/COFF file
870 FileOffset - The offset, in bytes, into the file to read
871 ReadSize - The number of bytes to read from the file starting at FileOffset
872 Buffer - A pointer to the buffer to read the data into.
875 EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
883 Destination8
= Buffer
;
884 Source8
= (CHAR8
*) ((UINTN
) FileHandle
+ FileOffset
);
887 *(Destination8
++) = *(Source8
++);
894 CountSeperatorsInString (
895 IN
const CHAR16
*String
,
901 Count the number of seperators in String
904 String - String to process
905 Seperator - Item to count
908 Number of Seperator in String
914 for (Count
= 0; *String
!= '\0'; String
++) {
915 if (*String
== Seperator
) {
926 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
932 Store the ModHandle in an array indexed by the Pdb File name.
933 The ModHandle is needed to unload the image.
936 ImageContext - Input data returned from PE Laoder Library. Used to find the
937 .PDB file name of the PE Image.
938 ModHandle - Returned from LoadLibraryEx() and stored for call to
942 EFI_SUCCESS - ModHandle was stored.
947 IMAGE_CONTEXT_TO_MOD_HANDLE
*Array
;
951 Array
= mImageContextModHandleArray
;
952 for (Index
= 0; Index
< mImageContextModHandleArraySize
; Index
++, Array
++) {
953 if (Array
->ImageContext
== NULL
) {
955 // Make a copy of the stirng and store the ModHandle
957 Array
->ImageContext
= ImageContext
;
958 Array
->ModHandle
= ModHandle
;
964 // No free space in mImageContextModHandleArray so grow it by
965 // IMAGE_CONTEXT_TO_MOD_HANDLE entires. realloc will
966 // copy the old values to the new locaiton. But it does
967 // not zero the new memory area.
969 PreviousSize
= mImageContextModHandleArraySize
* sizeof (IMAGE_CONTEXT_TO_MOD_HANDLE
);
970 mImageContextModHandleArraySize
+= MAX_IMAGE_CONTEXT_TO_MOD_HANDLE_ARRAY_SIZE
;
972 mImageContextModHandleArray
= realloc (mImageContextModHandleArray
, mImageContextModHandleArraySize
* sizeof (IMAGE_CONTEXT_TO_MOD_HANDLE
));
973 if (mImageContextModHandleArray
== NULL
) {
975 return EFI_OUT_OF_RESOURCES
;
978 memset (mImageContextModHandleArray
+ PreviousSize
, 0, MAX_IMAGE_CONTEXT_TO_MOD_HANDLE_ARRAY_SIZE
* sizeof (IMAGE_CONTEXT_TO_MOD_HANDLE
));
980 return AddHandle (ImageContext
, ModHandle
);
986 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
991 Return the ModHandle and delete the entry in the array.
994 ImageContext - Input data returned from PE Laoder Library. Used to find the
995 .PDB file name of the PE Image.
998 ModHandle - ModHandle assoicated with ImageContext is returned
999 NULL - No ModHandle associated with ImageContext
1004 IMAGE_CONTEXT_TO_MOD_HANDLE
*Array
;
1006 if (ImageContext
->PdbPointer
== NULL
) {
1008 // If no PDB pointer there is no ModHandle so return NULL
1013 Array
= mImageContextModHandleArray
;
1014 for (Index
= 0; Index
< mImageContextModHandleArraySize
; Index
++, Array
++) {
1015 if (Array
->ImageContext
== ImageContext
) {
1017 // If you find a match return it and delete the entry
1019 Array
->ImageContext
= NULL
;
1020 return Array
->ModHandle
;
1030 // Target for gdb breakpoint in a script that uses gGdbWorkingFileName to source a
1031 // add-symbol-file command. Hey what can you say scripting in gdb is not that great....
1033 // Put .gdbinit in the CWD where you do gdb SecMain.dll for source level debug
1036 // b SecGdbScriptBreak
1039 // source SecMain.dll.gdb
1051 SecUnixLoaderBreak (
1059 IN CHAR8
*PdbFileName
1064 if (PdbFileName
== NULL
) {
1068 Len
= strlen (PdbFileName
);
1069 if ((Len
< 5)|| (PdbFileName
[Len
- 4] != '.')) {
1073 if ((PdbFileName
[Len
- 3] == 'D' || PdbFileName
[Len
- 3] == 'd') &&
1074 (PdbFileName
[Len
- 2] == 'L' || PdbFileName
[Len
- 2] == 'l') &&
1075 (PdbFileName
[Len
- 1] == 'L' || PdbFileName
[Len
- 1] == 'l')) {
1083 #define MAX_SPRINT_BUFFER_SIZE 0x200
1087 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1090 if (ImageContext
->PdbPointer
== NULL
) {
1092 "0x%08lx Loading NO DEBUG with entry point 0x%08lx\n",
1093 (unsigned long)(ImageContext
->ImageAddress
),
1094 (unsigned long)ImageContext
->EntryPoint
1098 "0x%08lx Loading %s with entry point 0x%08lx\n",
1099 (unsigned long)(ImageContext
->ImageAddress
+ ImageContext
->SizeOfHeaders
),
1100 ImageContext
->PdbPointer
,
1101 (unsigned long)ImageContext
->EntryPoint
1104 // Keep output synced up
1111 SecPeCoffRelocateImageExtraAction (
1112 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1117 BOOLEAN EnabledOnEntry
;
1120 // Make sure writting of the file is an atomic operation
1122 if (UnixInterruptEanbled ()) {
1123 UnixDisableInterrupt ();
1124 EnabledOnEntry
= TRUE
;
1126 EnabledOnEntry
= FALSE
;
1129 PrintLoadAddress (ImageContext
);
1132 // In mach-o (OS X executable) dlopen() can only load files in the MH_DYLIB of MH_BUNDLE format.
1133 // To convert to PE/COFF we need to construct a mach-o with the MH_PRELOAD format. We create
1134 // .dSYM files for the PE/COFF images that can be used by gdb for source level debugging.
1139 // In the Mach-O to PE/COFF conversion the size of the PE/COFF headers is not accounted for.
1140 // Thus we need to skip over the PE/COFF header when giving load addresses for our symbol table.
1142 if (ImageContext
->PdbPointer
!= NULL
&& !IsPdbFile (ImageContext
->PdbPointer
)) {
1144 // Now we have a database of the images that are currently loaded
1148 // 'symbol-file' will clear out currnet symbol mappings in gdb.
1149 // you can do a 'add-symbol-file filename address' for every image we loaded to get source
1150 // level debug in gdb. Note Sec, being a true application will work differently.
1152 // We add the PE/COFF header size into the image as the mach-O does not have a header in
1153 // loaded into system memory.
1155 // This gives us a data base of gdb commands and after something is unloaded that entry will be
1156 // removed. We don't yet have the scheme of how to comunicate with gdb, but we have the
1157 // data base of info ready to roll.
1159 // We could use qXfer:libraries:read, but OS X GDB does not currently support it.
1161 // <library name="/lib/libc.so.6"> // ImageContext->PdbPointer
1162 // <segment address="0x10000000"/> // ImageContext->ImageAddress + ImageContext->SizeOfHeaders
1168 // Write the file we need for the gdb script
1170 GdbTempFile
= fopen (gGdbWorkingFileName
, "w");
1171 if (GdbTempFile
!= NULL
) {
1172 fprintf (GdbTempFile
, "add-symbol-file %s 0x%08lx\n", ImageContext
->PdbPointer
, (long unsigned int)(ImageContext
->ImageAddress
+ ImageContext
->SizeOfHeaders
));
1173 fclose (GdbTempFile
);
1176 // Target for gdb breakpoint in a script that uses gGdbWorkingFileName to set a breakpoint.
1177 // Hey what can you say scripting in gdb is not that great....
1179 SecGdbScriptBreak ();
1184 AddHandle (ImageContext
, ImageContext
->PdbPointer
);
1186 if (EnabledOnEntry
) {
1187 UnixEnableInterrupt ();
1195 void *Handle
= NULL
;
1198 if (ImageContext
->PdbPointer
== NULL
) {
1202 if (!IsPdbFile (ImageContext
->PdbPointer
)) {
1207 "Loading %s 0x%08lx - entry point 0x%08lx\n",
1208 ImageContext
->PdbPointer
,
1209 (unsigned long)ImageContext
->ImageAddress
,
1210 (unsigned long)ImageContext
->EntryPoint
);
1212 Handle
= dlopen (ImageContext
->PdbPointer
, RTLD_NOW
);
1215 Entry
= dlsym (Handle
, "_ModuleEntryPoint");
1217 printf("%s\n", dlerror());
1220 if (Entry
!= NULL
) {
1221 ImageContext
->EntryPoint
= (UINTN
)Entry
;
1222 printf("Change %s Entrypoint to :0x%08lx\n", ImageContext
->PdbPointer
, (unsigned long)Entry
);
1225 SecUnixLoaderBreak ();
1235 SecPeCoffLoaderUnloadImageExtraAction (
1236 IN PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1241 Handle
= RemoveHandle (ImageContext
);
1245 BOOLEAN EnabledOnEntry
;
1247 if (Handle
!= NULL
) {
1249 // Need to skip .PDB files created from VC++
1251 if (!IsPdbFile (ImageContext
->PdbPointer
)) {
1252 if (UnixInterruptEanbled ()) {
1253 UnixDisableInterrupt ();
1254 EnabledOnEntry
= TRUE
;
1256 EnabledOnEntry
= FALSE
;
1260 // Write the file we need for the gdb script
1262 GdbTempFile
= fopen (gGdbWorkingFileName
, "w");
1263 if (GdbTempFile
!= NULL
) {
1264 fprintf (GdbTempFile
, "remove-symbol-file %s\n", ImageContext
->PdbPointer
);
1265 fclose (GdbTempFile
);
1268 // Target for gdb breakpoint in a script that uses gGdbWorkingFileName to set a breakpoint.
1269 // Hey what can you say scripting in gdb is not that great....
1271 SecGdbScriptBreak ();
1276 if (EnabledOnEntry
) {
1277 UnixEnableInterrupt ();
1284 // Don't want to confuse gdb with symbols for something that got unloaded
1286 if (Handle
!= NULL
) {
1303 SecTemporaryRamSupport (
1304 IN CONST EFI_PEI_SERVICES
**PeiServices
,
1305 IN EFI_PHYSICAL_ADDRESS TemporaryMemoryBase
,
1306 IN EFI_PHYSICAL_ADDRESS PermanentMemoryBase
,
1311 // Migrate the whole temporary memory to permenent memory.
1314 (VOID
*)(UINTN
)PermanentMemoryBase
,
1315 (VOID
*)(UINTN
)TemporaryMemoryBase
,
1320 // SecSwitchStack function must be invoked after the memory migration
1321 // immediatly, also we need fixup the stack change caused by new call into
1322 // permenent memory.
1325 (UINT32
) TemporaryMemoryBase
,
1326 (UINT32
) PermanentMemoryBase
1330 // We need *not* fix the return address because currently,
1331 // The PeiCore is excuted in flash.
1335 // Simulate to invalid temporary memory, terminate temporary memory
1337 //ZeroMem ((VOID*)(UINTN)TemporaryMemoryBase, CopySize);