UnixPkg/Library/PeiUnixPeCoffExtraActionLib/PeiUnixPeCoffExtraActionLib.c

   1 /**@file
   2
   3 Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
   4 Portions copyright (c) 2008 - 2009, 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
   9
  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.
  12
  13 Module Name:
  14
  15   PeiUnixPeCoffExtraActionLib.c
  16
  17 Abstract:
  18
  19   Provides services to perform additional actions to relocate and unload
  20   PE/Coff image for UNIX environment specific purpose such as souce level debug.
  21   This version only works for PEI phase
  22
  23
  24 **/
  25 #include <PiPei.h>
  26 #include <Ppi/UnixThunk.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 Unix 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   Performs additional actions after a PE/COFF image has been loaded and relocated.
  74
  75   If ImageContext is NULL, then ASSERT().
  76
  77   @param  ImageContext  Pointer to the image context structure that describes the
  78                         PE/COFF image that has already been loaded and relocated.
  79
  80 **/
  81 VOID
  82 EFIAPI
  83 PeCoffLoaderRelocateImageExtraAction (
  84   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
  85   )
  86 {
  87   if (mUnix == NULL) {
  88     UnixPeCoffGetUnixThunkStucture ();
  89   }
  90     mUnix->PeCoffRelocateImageExtraAction (ImageContext);
  91   }
  92
  93
  94 /**
  95   Performs additional actions just before a PE/COFF image is unloaded.  Any resources
  96   that were allocated by PeCoffLoaderRelocateImageExtraAction() must be freed.
  97
  98   If ImageContext is NULL, then ASSERT().
  99
 100   @param  ImageContext  Pointer to the image context structure that describes the
 101                         PE/COFF image that is being unloaded.
 102
 103 **/
 104 VOID
 105 EFIAPI
 106 PeCoffLoaderUnloadImageExtraAction (
 107   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 108   )
 109 {
 110   if (mUnix == NULL) {
 111     UnixPeCoffGetUnixThunkStucture ();
 112   }
 113   mUnix->PeCoffUnloadImageExtraAction (ImageContext);
 114 }