UnixPkg/Library/PeiUnixPeCoffExtraActionLib/PeiUnixPeCoffExtraActionLib.c

   1 /**@file
   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   PeiUnixPeCoffExtraActionLib.c
  15
  16 Abstract:
  17
  18   Provides services to perform additional actions to relocate and unload
  19   PE/Coff image for UNIX environment specific purpose such as souce level debug.
  20   This version only works for PEI phase
  21
  22
  23 **/
  24 #include <PiPei.h>
  25 #include <Ppi/UnixThunk.h>
  26 #include <FrameworkModuleBase.h>
  27
  28 #include <Library/PeCoffLib.h>
  29 #include <Library/PeiServicesLib.h>
  30 #include <Library/DebugLib.h>
  31 #include <Library/BaseLib.h>
  32 #include <Library/PeCoffExtraActionLib.h>
  33
  34 //
  35 // Cache of UnixThunk protocol
  36 //
  37 EFI_UNIX_THUNK_PROTOCOL   *mUnix = NULL;
  38
  39 /**
  40   The function caches the pointer of the WinNT thunk functions
  41   It will ASSERT() if Unix thunk ppi is not installed.
  42
  43   @retval EFI_SUCCESS   WinNT thunk protocol is found and cached.
  44
  45 **/
  46 EFI_STATUS
  47 EFIAPI
  48 UnixPeCoffGetUnixThunkStucture (
  49   )
  50 {
  51         PEI_UNIX_THUNK_PPI  *UnixThunkPpi;
  52   EFI_STATUS        Status;
  53
  54
  55   //
  56   // Locate Unix ThunkPpi for retrieving standard output handle
  57   //
  58   Status = PeiServicesLocatePpi (
  59               &gPeiUnixThunkPpiGuid,
  60               0,
  61               NULL,
  62               (VOID **) &UnixThunkPpi
  63               );
  64
  65   ASSERT_EFI_ERROR (Status);
  66
  67   mUnix  = (EFI_UNIX_THUNK_PROTOCOL *) UnixThunkPpi->UnixThunk ();
  68
  69   return EFI_SUCCESS;
  70 }
  71
  72 /**
  73   Applies additional actions to relocate fixups to a PE/COFF image.
  74
  75   Generally this function is called after sucessfully Applying relocation fixups
  76   to a PE/COFF image for some specicial purpose.
  77
  78   @param  ImageContext        Pointer to the image context structure that describes the PE/COFF
  79                               image that is being relocated.
  80
  81 **/
  82 VOID
  83 EFIAPI
  84 PeCoffLoaderRelocateImageExtraAction (
  85   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
  86   )
  87 {
  88   VOID * Handle;
  89   VOID * Entry;
  90
  91   Handle = NULL;
  92   Entry  = NULL;
  93
  94   if (mUnix == NULL) {
  95     UnixPeCoffGetUnixThunkStucture ();
  96   }
  97   DEBUG ((EFI_D_ERROR, "Loading %s 0x%08lx - entry point 0x%08lx\n",
  98           ImageContext->PdbPointer,
  99           (UINTN)ImageContext->ImageAddress,
 100           (UINTN)ImageContext->EntryPoint));
 101
 102   Handle = mUnix->Dlopen (ImageContext->PdbPointer, RTLD_NOW);
 103
 104   if (Handle) {
 105     Entry = mUnix->Dlsym(Handle, "_ModuleEntryPoint");
 106   } else {
 107         DEBUG ((EFI_D_ERROR, "%s\n", mUnix->Dlerror()));
 108   }
 109
 110   if (Entry != NULL) {
 111     ImageContext->EntryPoint = Entry;
 112     DEBUG ((EFI_D_ERROR, "Change %s Entrypoint to :0x%08lx\n", ImageContext->PdbPointer, Entry));
 113   }
 114
 115
 116   return;
 117  }
 118
 119 /**
 120   Unloads a loaded PE/COFF image from memory and releases its taken resource.
 121
 122   Releases any environment specific resources that were allocated when the image
 123   specified by ImageContext was loaded using PeCoffLoaderLoadImage().
 124
 125   If ImageContext is NULL, then ASSERT().
 126
 127   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF
 128                                     image to be unloaded.
 129
 130 **/
 131 VOID
 132 EFIAPI
 133 PeCoffLoaderUnloadImageExtraAction (
 134   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 135   )
 136 {
 137 }