UefiPayloadPkg: Add performance measurement feature

[mirror_edk2.git] / UefiPayloadPkg / PayloadLoaderPeim / PayloadLoaderPeim.c

/** @file\r
  ELF Load Image Support\r
\r
Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiPei.h>\r
#include <UniversalPayload/UniversalPayload.h>\r
#include <UniversalPayload/ExtraData.h>\r
\r
#include <Ppi/LoadFile.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseMemoryLib.h>\r
\r
#include "ElfLib.h"\r
\r
/**\r
  The wrapper function of PeiLoadImageLoadImage().\r
\r
  @param This            - Pointer to EFI_PEI_LOAD_FILE_PPI.\r
  @param FileHandle      - Pointer to the FFS file header of the image.\r
  @param ImageAddressArg - Pointer to PE/TE image.\r
  @param ImageSizeArg    - Size of PE/TE image.\r
  @param EntryPoint      - Pointer to entry point of specified image file for output.\r
  @param AuthenticationState - Pointer to attestation authentication state of image.\r
\r
  @return Status of PeiLoadImageLoadImage().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiLoadFileLoadPayload (\r
  IN     CONST EFI_PEI_LOAD_FILE_PPI  *This,\r
  IN     EFI_PEI_FILE_HANDLE          FileHandle,\r
  OUT    EFI_PHYSICAL_ADDRESS         *ImageAddressArg   OPTIONAL,\r
  OUT    UINT64                       *ImageSizeArg      OPTIONAL,\r
  OUT    EFI_PHYSICAL_ADDRESS         *EntryPoint,\r
  OUT    UINT32                       *AuthenticationState\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  VOID                           *Elf;\r
  UNIVERSAL_PAYLOAD_EXTRA_DATA   *ExtraData;\r
  ELF_IMAGE_CONTEXT              Context;\r
  UNIVERSAL_PAYLOAD_INFO_HEADER  *PldInfo;\r
  UINT32                         Index;\r
  UINT16                         ExtraDataIndex;\r
  CHAR8                          *SectionName;\r
  UINTN                          Offset;\r
  UINTN                          Size;\r
  UINT32                         ExtraDataCount;\r
  UINTN                          Instance;\r
  UINTN                          Length;\r
\r
  //\r
  // ELF is added to file as RAW section for EDKII bootloader.\r
  // But RAW section might be added by build tool before the ELF RAW section when alignment is specified for ELF RAW section.\r
  // Below loop skips the RAW section that doesn't contain valid ELF image.\r
  //\r
  Instance = 0;\r
  do {\r
    Status = PeiServicesFfsFindSectionData3 (EFI_SECTION_RAW, Instance++, FileHandle, &Elf, AuthenticationState);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    ZeroMem (&Context, sizeof (Context));\r
    Status = ParseElfImage (Elf, &Context);\r
  } while (EFI_ERROR (Status));\r
\r
  DEBUG ((\r
    DEBUG_INFO,\r
    "Payload File Size: 0x%08X, Mem Size: 0x%08x, Reload: %d\n",\r
    Context.FileSize,\r
    Context.ImageSize,\r
    Context.ReloadRequired\r
    ));\r
\r
  //\r
  // Get UNIVERSAL_PAYLOAD_INFO_HEADER and number of additional PLD sections.\r
  //\r
  PldInfo        = NULL;\r
  ExtraDataCount = 0;\r
  for (Index = 0; Index < Context.ShNum; Index++) {\r
    Status = GetElfSectionName (&Context, Index, &SectionName);\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    DEBUG ((DEBUG_INFO, "Payload Section[%d]: %a\n", Index, SectionName));\r
    if (AsciiStrCmp (SectionName, UNIVERSAL_PAYLOAD_INFO_SEC_NAME) == 0) {\r
      Status = GetElfSectionPos (&Context, Index, &Offset, &Size);\r
      if (!EFI_ERROR (Status)) {\r
        PldInfo = (UNIVERSAL_PAYLOAD_INFO_HEADER *)(Context.FileBase + Offset);\r
      }\r
    } else if (AsciiStrnCmp (SectionName, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX_LENGTH) == 0) {\r
      Status = GetElfSectionPos (&Context, Index, &Offset, &Size);\r
      if (!EFI_ERROR (Status)) {\r
        ExtraDataCount++;\r
      }\r
    }\r
  }\r
\r
  //\r
  // Report the additional PLD sections through HOB.\r
  //\r
  Length    = sizeof (UNIVERSAL_PAYLOAD_EXTRA_DATA) + ExtraDataCount * sizeof (UNIVERSAL_PAYLOAD_EXTRA_DATA_ENTRY);\r
  ExtraData = BuildGuidHob (\r
                &gUniversalPayloadExtraDataGuid,\r
                Length\r
                );\r
  ExtraData->Count           = ExtraDataCount;\r
  ExtraData->Header.Revision = UNIVERSAL_PAYLOAD_EXTRA_DATA_REVISION;\r
  ExtraData->Header.Length   = (UINT16)Length;\r
  if (ExtraDataCount != 0) {\r
    for (ExtraDataIndex = 0, Index = 0; Index < Context.ShNum; Index++) {\r
      Status = GetElfSectionName (&Context, Index, &SectionName);\r
      if (EFI_ERROR (Status)) {\r
        continue;\r
      }\r
\r
      if (AsciiStrnCmp (SectionName, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX_LENGTH) == 0) {\r
        Status = GetElfSectionPos (&Context, Index, &Offset, &Size);\r
        if (!EFI_ERROR (Status)) {\r
          ASSERT (ExtraDataIndex < ExtraDataCount);\r
          AsciiStrCpyS (\r
            ExtraData->Entry[ExtraDataIndex].Identifier,\r
            sizeof (ExtraData->Entry[ExtraDataIndex].Identifier),\r
            SectionName + UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX_LENGTH\r
            );\r
          ExtraData->Entry[ExtraDataIndex].Base = (UINTN)(Context.FileBase + Offset);\r
          ExtraData->Entry[ExtraDataIndex].Size = Size;\r
          ExtraDataIndex++;\r
        }\r
      }\r
    }\r
  }\r
\r
  if (Context.ReloadRequired || (Context.PreferredImageAddress != Context.FileBase)) {\r
    Context.ImageAddress = AllocatePages (EFI_SIZE_TO_PAGES (Context.ImageSize));\r
  } else {\r
    Context.ImageAddress = Context.FileBase;\r
  }\r
\r
  //\r
  // Load ELF into the required base\r
  //\r
  Status = LoadElfImage (&Context);\r
  if (!EFI_ERROR (Status)) {\r
    *ImageAddressArg = (UINTN)Context.ImageAddress;\r
    *EntryPoint      = Context.EntryPoint;\r
    *ImageSizeArg    = Context.ImageSize;\r
  }\r
\r
  return Status;\r
}\r
\r
EFI_PEI_LOAD_FILE_PPI  mPeiLoadFilePpi = {\r
  PeiLoadFileLoadPayload\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR  gPpiLoadFilePpiList = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiLoadFilePpiGuid,\r
  &mPeiLoadFilePpi\r
};\r
\r
/**\r
\r
  Install Pei Load File PPI.\r
\r
  @param  FileHandle  Handle of the file being invoked.\r
  @param  PeiServices Describes the list of possible PEI Services.\r
\r
  @retval EFI_SUCESS  The entry point executes successfully.\r
  @retval Others      Some error occurs during the execution of this function.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializePayloadLoaderPeim (\r
  IN       EFI_PEI_FILE_HANDLE  FileHandle,\r
  IN CONST EFI_PEI_SERVICES     **PeiServices\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = PeiServicesInstallPpi (&gPpiLoadFilePpiList);\r
\r
  return Status;\r
}\r