[mirror_edk2.git] / MdePkg / Include / Library / PeCoffExtraActionLib.h

/** @file\r
  Provides services to perform additional actions when a PE/COFF image is loaded\r
  or unloaded.  This is useful for environment where symbols need to be loaded\r
  and unloaded to support source level debugging.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __PE_COFF_EXTRA_ACTION_LIB_H__\r
#define __PE_COFF_EXTRA_ACTION_LIB_H__\r
\r
#include <Library/PeCoffLib.h>\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
/**\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
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	Provides services to perform additional actions when a PE/COFF image is loaded\r
	3	or unloaded. This is useful for environment where symbols need to be loaded\r
	4	and unloaded to support source level debugging.\r
	5	\r
	6	Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
	7	SPDX-License-Identifier: BSD-2-Clause-Patent\r
	8	\r
	9	**/\r
	10	\r
	11	#ifndef __PE_COFF_EXTRA_ACTION_LIB_H__\r
	12	#define __PE_COFF_EXTRA_ACTION_LIB_H__\r
	13	\r
	14	#include <Library/PeCoffLib.h>\r
	15	\r
	16	/**\r
	17	Performs additional actions after a PE/COFF image has been loaded and relocated.\r
	18	\r
	19	If ImageContext is NULL, then ASSERT().\r
	20	\r
	21	@param ImageContext Pointer to the image context structure that describes the\r
	22	PE/COFF image that has already been loaded and relocated.\r
	23	\r
	24	**/\r
	25	VOID\r
	26	EFIAPI\r
	27	PeCoffLoaderRelocateImageExtraAction (\r
	28	IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
	29	);\r
	30	\r
	31	/**\r
	32	Performs additional actions just before a PE/COFF image is unloaded. Any resources\r
	33	that were allocated by PeCoffLoaderRelocateImageExtraAction() must be freed.\r
	34	\r
	35	If ImageContext is NULL, then ASSERT().\r
	36	\r
	37	@param ImageContext Pointer to the image context structure that describes the\r
	38	PE/COFF image that is being unloaded.\r
	39	\r
	40	**/\r
	41	VOID\r
	42	EFIAPI\r
	43	PeCoffLoaderUnloadImageExtraAction (\r
	44	IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
	45	);\r
	46	\r
	47	#endif\r