summaryrefslogtreecommitdiffstats
path: root/MdeModulePkg
diff options
context:
space:
mode:
authorStar Zeng <star.zeng@intel.com>2016-06-18 09:04:31 +0800
committerStar Zeng <star.zeng@intel.com>2016-07-01 09:39:57 +0800
commit76570576a6cb2907a4f1406fce036d1e47e9ed1d (patch)
tree446fa8c0228ec44cca4b15ce61cfbc312cc1b5b8 /MdeModulePkg
parentc5155f298cb4cb36d8b67e7a63eded60b4321b40 (diff)
downloadedk2-76570576a6cb2907a4f1406fce036d1e47e9ed1d.tar.gz
edk2-76570576a6cb2907a4f1406fce036d1e47e9ed1d.tar.bz2
edk2-76570576a6cb2907a4f1406fce036d1e47e9ed1d.zip
MdeModulePkg: Introduce new library class MemoryProfileLib
Provides services to record memory profile of multilevel caller. Cc: Jiewen Yao <jiewen.yao@intel.com> Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Star Zeng <star.zeng@intel.com> Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
Diffstat (limited to 'MdeModulePkg')
-rw-r--r--MdeModulePkg/Include/Library/MemoryProfileLib.h53
-rw-r--r--MdeModulePkg/MdeModulePkg.dec4
2 files changed, 57 insertions, 0 deletions
diff --git a/MdeModulePkg/Include/Library/MemoryProfileLib.h b/MdeModulePkg/Include/Library/MemoryProfileLib.h
new file mode 100644
index 0000000000..8543801391
--- /dev/null
+++ b/MdeModulePkg/Include/Library/MemoryProfileLib.h
@@ -0,0 +1,53 @@
+/** @file
+ Provides services to record memory profile of multilevel caller.
+
+ Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
+ This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD License
+ which accompanies this distribution. The full text of the license may be found at
+ http://opensource.org/licenses/bsd-license.php.
+
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#ifndef _MEMORY_PROFILE_LIB_H_
+#define _MEMORY_PROFILE_LIB_H_
+
+#include <Guid/MemoryProfile.h>
+
+/**
+ Record memory profile of multilevel caller.
+
+ @param[in] CallerAddress Address of caller.
+ @param[in] Action Memory profile action.
+ @param[in] MemoryType Memory type.
+ EfiMaxMemoryType means the MemoryType is unknown.
+ @param[in] Buffer Buffer address.
+ @param[in] Size Buffer size.
+ @param[in] ActionString String for memory profile action.
+ Only needed for user defined allocate action.
+
+ @return EFI_SUCCESS Memory profile is updated.
+ @return EFI_UNSUPPORTED Memory profile is unsupported,
+ or memory profile for the image is not required,
+ or memory profile for the memory type is not required.
+ @return EFI_ACCESS_DENIED It is during memory profile data getting.
+ @return EFI_ABORTED Memory profile recording is not enabled.
+ @return EFI_OUT_OF_RESOURCES No enough resource to update memory profile for allocate action.
+ @return EFI_NOT_FOUND No matched allocate info found for free action.
+
+**/
+EFI_STATUS
+EFIAPI
+MemoryProfileLibRecord (
+ IN PHYSICAL_ADDRESS CallerAddress,
+ IN MEMORY_PROFILE_ACTION Action,
+ IN EFI_MEMORY_TYPE MemoryType,
+ IN VOID *Buffer,
+ IN UINTN Size,
+ IN CHAR8 *ActionString OPTIONAL
+ );
+
+#endif
diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
index 9014635736..8d90f169b2 100644
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -153,6 +153,10 @@
#
PciHostBridgeLib|Include/Library/PciHostBridgeLib.h
+ ## @libraryclass Provides services to record memory profile of multilevel caller.
+ #
+ MemoryProfileLib|Include/Library/MemoryProfileLib.h
+
[Guids]
## MdeModule package token space guid
# Include/Guid/MdeModulePkgTokenSpace.h