EmulatorPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / EmulatorPkg / Library / PeiEmuPeCoffExtraActionLib / PeiEmuPeCoffExtraActionLib.c

/** @file\r
  Provides services to perform additional actions to relocate and unload\r
  PE/Coff image for Emu environment specific purpose such as souce level debug.\r
  This version only works for PEI phase\r
\r
Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
Portions copyright (c) 2008 - 2011, Apple Inc. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
#include <PiPei.h>\r
#include <Ppi/EmuThunk.h>\r
#include <Protocol/EmuThunk.h>\r
\r
#include <Library/PeCoffLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/PeCoffExtraActionLib.h>\r
#include <Library/EmuMagicPageLib.h>\r
\r
//\r
// Cache of UnixThunk protocol\r
//\r
EMU_THUNK_PROTOCOL   *mThunk = NULL;\r
\r
/**\r
  The function caches the pointer of the Unix thunk functions\r
  It will ASSERT() if Unix thunk ppi is not installed.\r
\r
  @retval EFI_SUCCESS   WinNT thunk protocol is found and cached.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmuPeCoffGetThunkStucture (\r
  )\r
{\r
  EMU_THUNK_PPI     *ThunkPpi;\r
  EFI_STATUS        Status;\r
\r
\r
  //\r
  // Locate Unix ThunkPpi for retrieving standard output handle\r
  //\r
  Status = PeiServicesLocatePpi (\r
              &gEmuThunkPpiGuid,\r
              0,\r
              NULL,\r
              (VOID **) &ThunkPpi\r
              );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  EMU_MAGIC_PAGE()->Thunk = (EMU_THUNK_PROTOCOL *) ThunkPpi->Thunk ();\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Performs additional actions after a PE/COFF image has been loaded and relocated.\r
\r
  If ImageContext is NULL, then ASSERT().\r
\r
  @param  ImageContext  Pointer to the image context structure that describes the\r
                        PE/COFF image that has already been loaded and relocated.\r
\r
**/\r
VOID\r
EFIAPI\r
PeCoffLoaderRelocateImageExtraAction (\r
  IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
  )\r
{\r
  if (EMU_MAGIC_PAGE()->Thunk == NULL) {\r
    EmuPeCoffGetThunkStucture ();\r
  }\r
    EMU_MAGIC_PAGE()->Thunk->PeCoffRelocateImageExtraAction (ImageContext);\r
  }\r
\r
\r
/**\r
  Performs additional actions just before a PE/COFF image is unloaded.  Any resources\r
  that were allocated by PeCoffLoaderRelocateImageExtraAction() must be freed.\r
\r
  If ImageContext is NULL, then ASSERT().\r
\r
  @param  ImageContext  Pointer to the image context structure that describes the\r
                        PE/COFF image that is being unloaded.\r
\r
**/\r
VOID\r
EFIAPI\r
PeCoffLoaderUnloadImageExtraAction (\r
  IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
  )\r
{\r
  if (EMU_MAGIC_PAGE()->Thunk == NULL) {\r
    EmuPeCoffGetThunkStucture ();\r
  }\r
  EMU_MAGIC_PAGE()->Thunk->PeCoffUnloadImageExtraAction (ImageContext);\r
}\r