MdePkg/Include/Library/PeCoffExtraActionLib.h

   1 /** @file
   2   Provides services to perform additional actions to relocate and unload
   3   PE/Coff image for some environment specific purpose say for souce level debug.
   4
   5   Copyright (c) 2009, Intel Corporation<BR>
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __PE_COFF_EXTRA_ACTION_LIB_H__
  17 #define __PE_COFF_EXTRA_ACTION_LIB_H__
  18 #include <Library/PeCoffLib.h>
  19 /**
  20   Applies additional actions to relocate fixups to a PE/COFF image.
  21
  22   Generally this function is called after sucessfully Applying relocation fixups
  23   to a PE/COFF image for some specicial purpose.
  24   As a example, For NT32 emulator, the function should be implemented and called
  25   to support source level debug.
  26
  27   @param  ImageContext        Pointer to the image context structure that describes the PE/COFF
  28                               image that is being relocated.
  29
  30 **/
  31 VOID
  32 EFIAPI
  33 PeCoffLoaderRelocateImageExtraAction (
  34   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
  35   );
  36
  37 /**
  38   Unloads a loaded PE/COFF image from memory and releases its taken resource.
  39
  40   Releases any environment specific resources that were allocated when the image
  41   specified by ImageContext was loaded using PeCoffLoaderLoadImage().
  42   For NT32 emulator, the PE/COFF image loaded by system needs to release.
  43   For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,
  44
  45   If ImageContext is NULL, then ASSERT().
  46
  47   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF
  48                                     image to be unloaded.
  49
  50 **/
  51 VOID
  52 EFIAPI
  53 PeCoffLoaderUnloadImageExtraAction (
  54   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
  55   );
  56 #endif