EdkModulePkg/Core/Pei/Image/Image.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   Image.c
  15
  16 Abstract:
  17
  18   Pei Core Load Image Support
  19
  20 --*/
  21
  22 #include <PeiMain.h>
  23
  24 EFI_STATUS
  25 PeiLoadImage (
  26   IN EFI_PEI_SERVICES         **PeiServices,
  27   IN EFI_FFS_FILE_HEADER      *PeimFileHeader,
  28   OUT VOID                    **EntryPoint
  29   )
  30 /*++
  31
  32 Routine Description:
  33
  34   Routine for loading file image.
  35
  36 Arguments:
  37
  38   PeiServices     - The PEI core services table.
  39   PeimFileHeader  - Pointer to the FFS file header of the image.
  40   EntryPoint      - Pointer to entry point of specified image file for output.
  41
  42 Returns:
  43
  44   Status - EFI_SUCCESS    - Image is successfully loaded.
  45            EFI_NOT_FOUND  - Fail to locate necessary PPI
  46            Others         - Fail to load file.
  47
  48 --*/
  49 {
  50   EFI_STATUS                  Status;
  51   VOID                        *Pe32Data;
  52   EFI_PEI_FV_FILE_LOADER_PPI  *FvLoadFilePpi;
  53   EFI_PHYSICAL_ADDRESS        ImageAddress;
  54   UINT64                      ImageSize;
  55   EFI_PHYSICAL_ADDRESS        ImageEntryPoint;
  56   EFI_TE_IMAGE_HEADER         *TEImageHeader;
  57
  58   *EntryPoint   = NULL;
  59   TEImageHeader = NULL;
  60
  61   //
  62   // Try to find a PE32 section.
  63   //
  64   Status = PeiServicesFfsFindSectionData (
  65              EFI_SECTION_PE32,
  66              PeimFileHeader,
  67              &Pe32Data
  68              );
  69   //
  70   // If we didn't find a PE32 section, try to find a TE section.
  71   //
  72   if (EFI_ERROR (Status)) {
  73     Status = PeiServicesFfsFindSectionData (
  74                EFI_SECTION_TE,
  75                PeimFileHeader,
  76                (VOID **) &TEImageHeader
  77                );
  78     if (EFI_ERROR (Status) || TEImageHeader == NULL) {
  79       //
  80       // There was not a PE32 or a TE section, so assume that it's a Compressed section
  81       // and use the LoadFile
  82       //
  83       Status = PeiServicesLocatePpi (
  84                 &gEfiPeiFvFileLoaderPpiGuid,
  85                 0,
  86                 NULL,
  87                 (VOID **)&FvLoadFilePpi
  88                 );
  89       if (EFI_ERROR (Status)) {
  90         return EFI_NOT_FOUND;
  91       }
  92
  93       Status = FvLoadFilePpi->FvLoadFile (
  94                                 FvLoadFilePpi,
  95                                 PeimFileHeader,
  96                                 &ImageAddress,
  97                                 &ImageSize,
  98                                 &ImageEntryPoint
  99                                 );
 100
 101       if (EFI_ERROR (Status)) {
 102         return EFI_NOT_FOUND;
 103       }
 104
 105       //
 106       // Got the entry point from ImageEntryPoint
 107       //
 108       *EntryPoint = (VOID *) ((UINTN) ImageEntryPoint);
 109       return EFI_SUCCESS;
 110     } else {
 111       //
 112       // Retrieve the entry point from the TE image header
 113       //
 114       ImageAddress = (EFI_PHYSICAL_ADDRESS) (UINTN) TEImageHeader;
 115       *EntryPoint = (VOID *)((UINTN) TEImageHeader + sizeof (EFI_TE_IMAGE_HEADER) +
 116                     TEImageHeader->AddressOfEntryPoint - TEImageHeader->StrippedSize);
 117     }
 118   } else {
 119     //
 120     // Retrieve the entry point from the PE/COFF image header
 121     //
 122     ImageAddress = (EFI_PHYSICAL_ADDRESS) (UINTN) Pe32Data;
 123     Status = PeCoffLoaderGetEntryPoint (Pe32Data, EntryPoint);
 124     if (EFI_ERROR (Status)) {
 125       return EFI_NOT_FOUND;
 126     }
 127   }
 128
 129   //
 130   // Print debug message: Loading PEIM at 0x12345678 EntryPoint=0x12345688 Driver.efi
 131   //
 132   DEBUG ((EFI_D_INFO | EFI_D_LOAD, "Loading PEIM at 0x%08x EntryPoint=0x%08x ", Pe32Data, *EntryPoint));
 133   DEBUG_CODE (
 134     EFI_IMAGE_DATA_DIRECTORY * DirectoryEntry;
 135     EFI_IMAGE_DEBUG_DIRECTORY_ENTRY * DebugEntry;
 136     UINTN DirCount;
 137     UINTN Index;
 138     UINTN Index1;
 139     BOOLEAN FileNameFound;
 140     CHAR8 *AsciiString;
 141     CHAR8 AsciiBuffer[512];
 142     VOID *CodeViewEntryPointer;
 143     INTN TEImageAdjust;
 144     EFI_IMAGE_DOS_HEADER  *DosHeader;
 145     EFI_IMAGE_NT_HEADERS  *PeHeader;
 146
 147     //
 148     // Pe32Data is NULL when load TE image
 149     //
 150     PeHeader = NULL;
 151     if (TEImageHeader == NULL) {
 152       DosHeader = (EFI_IMAGE_DOS_HEADER *)Pe32Data;
 153       if (DosHeader->e_magic == EFI_IMAGE_DOS_SIGNATURE) {
 154         //
 155         // DOS image header is present, so read the PE header after the DOS image header
 156         //
 157         PeHeader = (EFI_IMAGE_NT_HEADERS *) ((UINTN) Pe32Data + (UINTN) ((DosHeader->e_lfanew) & 0x0ffff));
 158       } else {
 159         //
 160         // DOS image header is not present, so PE header is at the image base
 161         //
 162         PeHeader = (EFI_IMAGE_NT_HEADERS *) Pe32Data;
 163       }
 164     }
 165
 166     //
 167     // Find the codeview info in the image and display the file name
 168     // being loaded.
 169     //
 170     // Per the PE/COFF spec, you can't assume that a given data directory
 171     // is present in the image. You have to check the NumberOfRvaAndSizes in
 172     // the optional header to verify a desired directory entry is there.
 173     //
 174     DebugEntry      = NULL;
 175     DirectoryEntry  = NULL;
 176     TEImageAdjust   = 0;
 177     if (TEImageHeader == NULL) {
 178       if (PeHeader->OptionalHeader.NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_DEBUG) {
 179         DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *) &(PeHeader->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG]);
 180         DebugEntry = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *) ((UINTN) ImageAddress + DirectoryEntry->VirtualAddress);
 181       }
 182     } else {
 183       if (TEImageHeader->DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress != 0) {
 184         DirectoryEntry  = &TEImageHeader->DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG];
 185         TEImageAdjust   = sizeof (EFI_TE_IMAGE_HEADER) - TEImageHeader->StrippedSize;
 186         DebugEntry = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *)((UINTN) TEImageHeader +
 187                       TEImageHeader->DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress +
 188                       TEImageAdjust);
 189       }
 190     }
 191
 192     if (DebugEntry != NULL && DirectoryEntry != NULL) {
 193       for (DirCount = 0; DirCount < DirectoryEntry->Size; DirCount++, DebugEntry++) {
 194         if (DebugEntry->Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {
 195           if (DebugEntry->SizeOfData > 0) {
 196             CodeViewEntryPointer = (VOID *) ((UINTN) DebugEntry->RVA + (UINTN) ImageAddress + (UINTN)TEImageAdjust);
 197             switch (* (UINT32 *) CodeViewEntryPointer) {
 198               case CODEVIEW_SIGNATURE_NB10:
 199                 AsciiString = (CHAR8 *) CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY);
 200                 break;
 201
 202               case CODEVIEW_SIGNATURE_RSDS:
 203                 AsciiString = (CHAR8 *) CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY);
 204                 break;
 205
 206               default:
 207                 AsciiString = NULL;
 208                 break;
 209             }
 210             if (AsciiString != NULL) {
 211               FileNameFound = FALSE;
 212               for (Index = 0, Index1 = 0; AsciiString[Index] != 0; Index++) {
 213                 if (AsciiString[Index] == '\\') {
 214                   Index1 = Index;
 215                   FileNameFound = TRUE;
 216                 }
 217               }
 218
 219               if (FileNameFound) {
 220                 for (Index = Index1 + 1; AsciiString[Index] != '.'; Index++) {
 221                   AsciiBuffer[Index - (Index1 + 1)] = AsciiString[Index];
 222                 }
 223                 AsciiBuffer[Index - (Index1 + 1)] = 0;
 224                 DEBUG ((EFI_D_INFO | EFI_D_LOAD, "%a.efi", AsciiBuffer));
 225                 break;
 226               }
 227             }
 228           }
 229         }
 230       }
 231     }
 232   );
 233
 234   DEBUG ((EFI_D_INFO | EFI_D_LOAD, "\n"));
 235
 236   return EFI_SUCCESS;
 237 }