/** @file\r
- Support routines for memory allocation routines based on SMM Core internal functions.\r
-\r
- Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+ Support routines for memory allocation routines based on SMM Core internal functions,\r
+ with memory profile support.\r
+ \r
+ The PI System Management Mode Core Interface Specification only allows the use\r
+ of EfiRuntimeServicesCode and EfiRuntimeServicesData memory types for memory \r
+ allocations as the SMRAM space should be reserved after BDS phase. The functions \r
+ in the Memory Allocation Library use EfiBootServicesData as the default memory \r
+ allocation type. For this SMM specific instance of the Memory Allocation Library, \r
+ EfiRuntimeServicesData is used as the default memory type for all allocations. \r
+ In addition, allocation for the Reserved memory types are not supported and will \r
+ always return NULL.\r
+\r
+ Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
\r
#include <PiSmm.h>\r
\r
-#include <Protocol/SmmAccess2.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include "PiSmmCoreMemoryAllocationServices.h"\r
\r
-EFI_SMRAM_DESCRIPTOR *mSmramRanges = NULL;\r
-UINTN mSmramRangeCount = 0;\r
-\r
-/**\r
- This function gets and caches SMRAM ranges that are present in the system.\r
- \r
- It will ASSERT() if SMM Access2 Protocol doesn't exist.\r
- It will ASSERT() if SMRAM ranges can't be got.\r
- It will ASSERT() if Resource can't be allocated for cache SMRAM range. \r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-GetSmramRanges (\r
- VOID\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_SMM_ACCESS2_PROTOCOL *SmmAccess;\r
- UINTN Size;\r
-\r
- //\r
- // Locate SMM Access2 Protocol\r
- //\r
- Status = gBS->LocateProtocol (\r
- &gEfiSmmAccess2ProtocolGuid, \r
- NULL, \r
- (VOID **)&SmmAccess\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- //\r
- // Get SMRAM range information\r
- //\r
- Size = 0;\r
- Status = SmmAccess->GetCapabilities (SmmAccess, &Size, NULL);\r
- ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r
-\r
- mSmramRanges = (EFI_SMRAM_DESCRIPTOR *) AllocatePool (Size);\r
- ASSERT (mSmramRanges != NULL);\r
-\r
- Status = SmmAccess->GetCapabilities (SmmAccess, &Size, mSmramRanges);\r
- ASSERT_EFI_ERROR (Status);\r
+#include <Library/MemoryProfileLib.h>\r
\r
- mSmramRangeCount = Size / sizeof (EFI_SMRAM_DESCRIPTOR);\r
-}\r
+EFI_SMRAM_DESCRIPTOR *mSmmCoreMemoryAllocLibSmramRanges = NULL;\r
+UINTN mSmmCoreMemoryAllocLibSmramRangeCount = 0;\r
\r
/**\r
Check whether the start address of buffer is within any of the SMRAM ranges.\r
\r
@param[in] Buffer The pointer to the buffer to be checked.\r
\r
- @retval TURE The buffer is in SMRAM ranges.\r
+ @retval TRUE The buffer is in SMRAM ranges.\r
@retval FALSE The buffer is out of SMRAM ranges.\r
**/\r
BOOLEAN\r
{\r
UINTN Index;\r
\r
- if (mSmramRanges == NULL) {\r
- //\r
- // SMRAM ranges is not got. Try to get them all.\r
- //\r
- GetSmramRanges();\r
- }\r
-\r
- for (Index = 0; Index < mSmramRangeCount; Index ++) {\r
- if (((EFI_PHYSICAL_ADDRESS) (UINTN) Buffer >= mSmramRanges[Index].CpuStart) && \r
- ((EFI_PHYSICAL_ADDRESS) (UINTN) Buffer < (mSmramRanges[Index].CpuStart + mSmramRanges[Index].PhysicalSize))) {\r
+ for (Index = 0; Index < mSmmCoreMemoryAllocLibSmramRangeCount; Index ++) {\r
+ if (((EFI_PHYSICAL_ADDRESS) (UINTN) Buffer >= mSmmCoreMemoryAllocLibSmramRanges[Index].CpuStart) && \r
+ ((EFI_PHYSICAL_ADDRESS) (UINTN) Buffer < (mSmmCoreMemoryAllocLibSmramRanges[Index].CpuStart + mSmmCoreMemoryAllocLibSmramRanges[Index].PhysicalSize))) {\r
return TRUE;\r
}\r
}\r
}\r
\r
/**\r
- Allocates one or more 4KB pages of type EfiBootServicesData.\r
+ Allocates one or more 4KB pages of type EfiRuntimeServicesData.\r
\r
- Allocates the number of 4KB pages of type EfiBootServicesData and returns a pointer to the\r
+ Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the\r
allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL\r
is returned. If there is not enough memory remaining to satisfy the request, then NULL is\r
returned.\r
IN UINTN Pages\r
)\r
{\r
- return InternalAllocatePages (EfiRuntimeServicesData, Pages);\r
+ VOID *Buffer;\r
+\r
+ Buffer = InternalAllocatePages (EfiRuntimeServicesData, Pages);\r
+ if (Buffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_ALLOCATE_PAGES,\r
+ EfiRuntimeServicesData,\r
+ Buffer,\r
+ EFI_PAGES_TO_SIZE(Pages),\r
+ NULL\r
+ );\r
+ }\r
+ return Buffer;\r
}\r
\r
/**\r
IN UINTN Pages\r
)\r
{\r
- return InternalAllocatePages (EfiRuntimeServicesData, Pages);\r
+ VOID *Buffer;\r
+\r
+ Buffer = InternalAllocatePages (EfiRuntimeServicesData, Pages);\r
+ if (Buffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_ALLOCATE_RUNTIME_PAGES,\r
+ EfiRuntimeServicesData,\r
+ Buffer,\r
+ EFI_PAGES_TO_SIZE(Pages),\r
+ NULL\r
+ );\r
+ }\r
+ return Buffer;\r
}\r
\r
/**\r
If there is not enough memory at the specified alignment remaining to satisfy the request, then\r
NULL is returned.\r
If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
+ If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().\r
\r
@param MemoryType The type of memory to allocate.\r
@param Pages The number of 4 KB pages to allocate.\r
}\r
if (Alignment > EFI_PAGE_SIZE) {\r
//\r
- // Caculate the total number of pages since alignment is larger than page size.\r
+ // Calculate the total number of pages since alignment is larger than page size.\r
//\r
AlignmentMask = Alignment - 1;\r
RealPages = Pages + EFI_SIZE_TO_PAGES (Alignment);\r
Status = SmmFreePages (Memory, UnalignedPages);\r
ASSERT_EFI_ERROR (Status);\r
}\r
- Memory = (EFI_PHYSICAL_ADDRESS) (AlignedMemory + EFI_PAGES_TO_SIZE (Pages));\r
+ Memory = AlignedMemory + EFI_PAGES_TO_SIZE (Pages);\r
UnalignedPages = RealPages - Pages - UnalignedPages;\r
if (UnalignedPages > 0) {\r
//\r
}\r
\r
/**\r
- Allocates one or more 4KB pages of type EfiBootServicesData at a specified alignment.\r
+ Allocates one or more 4KB pages of type EfiRuntimeServicesData at a specified alignment.\r
\r
- Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData with an\r
+ Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an\r
alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is\r
returned. If there is not enough memory at the specified alignment remaining to satisfy the\r
request, then NULL is returned.\r
\r
If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
+ If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().\r
\r
@param Pages The number of 4 KB pages to allocate.\r
@param Alignment The requested alignment of the allocation. Must be a power of two.\r
IN UINTN Alignment\r
)\r
{\r
- return InternalAllocateAlignedPages (EfiRuntimeServicesData, Pages, Alignment);\r
+ VOID *Buffer;\r
+\r
+ Buffer = InternalAllocateAlignedPages (EfiRuntimeServicesData, Pages, Alignment);\r
+ if (Buffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_ALLOCATE_ALIGNED_PAGES,\r
+ EfiRuntimeServicesData,\r
+ Buffer,\r
+ EFI_PAGES_TO_SIZE(Pages),\r
+ NULL\r
+ );\r
+ }\r
+ return Buffer;\r
}\r
\r
/**\r
request, then NULL is returned.\r
\r
If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
+ If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().\r
\r
@param Pages The number of 4 KB pages to allocate.\r
@param Alignment The requested alignment of the allocation. Must be a power of two.\r
IN UINTN Alignment\r
)\r
{\r
- return InternalAllocateAlignedPages (EfiRuntimeServicesData, Pages, Alignment);\r
+ VOID *Buffer;\r
+\r
+ Buffer = InternalAllocateAlignedPages (EfiRuntimeServicesData, Pages, Alignment);\r
+ if (Buffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_ALLOCATE_ALIGNED_RUNTIME_PAGES,\r
+ EfiRuntimeServicesData,\r
+ Buffer,\r
+ EFI_PAGES_TO_SIZE(Pages),\r
+ NULL\r
+ );\r
+ }\r
+ return Buffer;\r
}\r
\r
/**\r
request, then NULL is returned.\r
\r
If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
+ If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().\r
\r
@param Pages The number of 4 KB pages to allocate.\r
@param Alignment The requested alignment of the allocation. Must be a power of two.\r
EFI_STATUS Status;\r
VOID *Memory;\r
\r
+ Memory = NULL;\r
+\r
Status = SmmAllocatePool (MemoryType, AllocationSize, &Memory);\r
if (EFI_ERROR (Status)) {\r
Memory = NULL;\r
}\r
\r
/**\r
- Allocates a buffer of type EfiBootServicesData.\r
+ Allocates a buffer of type EfiRuntimeServicesData.\r
\r
- Allocates the number bytes specified by AllocationSize of type EfiBootServicesData and returns a\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData and returns a\r
pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is\r
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
\r
IN UINTN AllocationSize\r
)\r
{\r
- return InternalAllocatePool (EfiRuntimeServicesData, AllocationSize);\r
+ VOID *Buffer;\r
+\r
+ Buffer = InternalAllocatePool (EfiRuntimeServicesData, AllocationSize);\r
+ if (Buffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_ALLOCATE_POOL,\r
+ EfiRuntimeServicesData,\r
+ Buffer,\r
+ AllocationSize,\r
+ NULL\r
+ );\r
+ }\r
+ return Buffer;\r
}\r
\r
/**\r
IN UINTN AllocationSize\r
)\r
{\r
- return InternalAllocatePool (EfiRuntimeServicesData, AllocationSize);\r
+ VOID *Buffer;\r
+\r
+ Buffer = InternalAllocatePool (EfiRuntimeServicesData, AllocationSize);\r
+ if (Buffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_ALLOCATE_RUNTIME_POOL,\r
+ EfiRuntimeServicesData,\r
+ Buffer,\r
+ AllocationSize,\r
+ NULL\r
+ );\r
+ }\r
+ return Buffer;\r
}\r
\r
/**\r
}\r
\r
/**\r
- Allocates and zeros a buffer of type EfiBootServicesData.\r
+ Allocates and zeros a buffer of type EfiRuntimeServicesData.\r
\r
- Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, clears the\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, clears the\r
buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a\r
valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the\r
request, then NULL is returned.\r
IN UINTN AllocationSize\r
)\r
{\r
- return InternalAllocateZeroPool (EfiRuntimeServicesData, AllocationSize);\r
+ VOID *Buffer;\r
+\r
+ Buffer = InternalAllocateZeroPool (EfiRuntimeServicesData, AllocationSize);\r
+ if (Buffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_ALLOCATE_ZERO_POOL,\r
+ EfiRuntimeServicesData,\r
+ Buffer,\r
+ AllocationSize,\r
+ NULL\r
+ );\r
+ }\r
+ return Buffer;\r
}\r
\r
/**\r
IN UINTN AllocationSize\r
)\r
{\r
- return InternalAllocateZeroPool (EfiRuntimeServicesData, AllocationSize);\r
+ VOID *Buffer;\r
+\r
+ Buffer = InternalAllocateZeroPool (EfiRuntimeServicesData, AllocationSize);\r
+ if (Buffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_ALLOCATE_RUNTIME_ZERO_POOL,\r
+ EfiRuntimeServicesData,\r
+ Buffer,\r
+ AllocationSize,\r
+ NULL\r
+ );\r
+ }\r
+ return Buffer;\r
}\r
\r
/**\r
} \r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiBootServicesData.\r
+ Copies a buffer to an allocated buffer of type EfiRuntimeServicesData.\r
\r
- Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, copies\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, copies\r
AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r
is not enough memory remaining to satisfy the request, then NULL is returned.\r
IN CONST VOID *Buffer\r
)\r
{\r
- return InternalAllocateCopyPool (EfiRuntimeServicesData, AllocationSize, Buffer);\r
+ VOID *NewBuffer;\r
+\r
+ NewBuffer = InternalAllocateCopyPool (EfiRuntimeServicesData, AllocationSize, Buffer);\r
+ if (NewBuffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_ALLOCATE_COPY_POOL,\r
+ EfiRuntimeServicesData,\r
+ NewBuffer,\r
+ AllocationSize,\r
+ NULL\r
+ );\r
+ }\r
+ return NewBuffer;\r
}\r
\r
/**\r
IN CONST VOID *Buffer\r
)\r
{\r
- return InternalAllocateCopyPool (EfiRuntimeServicesData, AllocationSize, Buffer);\r
+ VOID *NewBuffer;\r
+\r
+ NewBuffer = InternalAllocateCopyPool (EfiRuntimeServicesData, AllocationSize, Buffer);\r
+ if (NewBuffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_ALLOCATE_RUNTIME_COPY_POOL,\r
+ EfiRuntimeServicesData,\r
+ NewBuffer,\r
+ AllocationSize,\r
+ NULL\r
+ );\r
+ }\r
+ return NewBuffer;\r
}\r
\r
/**\r
}\r
\r
/**\r
- Reallocates a buffer of type EfiBootServicesData.\r
+ Reallocates a buffer of type EfiRuntimeServicesData.\r
\r
Allocates and zeros the number bytes specified by NewSize from memory of type\r
- EfiBootServicesData. If OldBuffer is not NULL, then the smaller of OldSize and \r
+ EfiRuntimeServicesData. If OldBuffer is not NULL, then the smaller of OldSize and \r
NewSize bytes are copied from OldBuffer to the newly allocated buffer, and \r
OldBuffer is freed. A pointer to the newly allocated buffer is returned. \r
If NewSize is 0, then a valid buffer of 0 size is returned. If there is not \r
IN VOID *OldBuffer OPTIONAL\r
)\r
{\r
- return InternalReallocatePool (EfiRuntimeServicesData, OldSize, NewSize, OldBuffer);\r
+ VOID *Buffer;\r
+\r
+ Buffer = InternalReallocatePool (EfiRuntimeServicesData, OldSize, NewSize, OldBuffer);\r
+ if (Buffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_REALLOCATE_POOL,\r
+ EfiRuntimeServicesData,\r
+ Buffer,\r
+ NewSize,\r
+ NULL\r
+ );\r
+ }\r
+ return Buffer;\r
}\r
\r
/**\r
IN VOID *OldBuffer OPTIONAL\r
)\r
{\r
- return InternalReallocatePool (EfiRuntimeServicesData, OldSize, NewSize, OldBuffer);\r
+ VOID *Buffer;\r
+\r
+ Buffer = InternalReallocatePool (EfiRuntimeServicesData, OldSize, NewSize, OldBuffer);\r
+ if (Buffer != NULL) {\r
+ MemoryProfileLibRecord (\r
+ (PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS(0),\r
+ MEMORY_PROFILE_ACTION_LIB_REALLOCATE_RUNTIME_POOL,\r
+ EfiRuntimeServicesData,\r
+ Buffer,\r
+ NewSize,\r
+ NULL\r
+ );\r
+ }\r
+ return Buffer;\r
}\r
\r
/**\r
ASSERT_EFI_ERROR (Status);\r
}\r
\r
+/**\r
+ The constructor function calls SmmInitializeMemoryServices to initialize memory in SMRAM.\r
+\r
+ @param ImageHandle The firmware allocated handle for the EFI image.\r
+ @param SystemTable A pointer to the EFI System Table.\r
+\r
+ @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PiSmmCoreMemoryAllocationLibConstructor (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ SMM_CORE_PRIVATE_DATA *SmmCorePrivate;\r
+ UINTN Size;\r
+ VOID *BootServicesData;\r
+\r
+ SmmCorePrivate = (SMM_CORE_PRIVATE_DATA *)ImageHandle;\r
+\r
+ //\r
+ // The FreePool()/FreePages() will need use SmramRanges data to know whether\r
+ // the buffer to free is in SMRAM range or not. And there may be FreePool()/\r
+ // FreePages() indrectly during calling SmmInitializeMemoryServices(), but\r
+ // no SMRAM could be allocated before calling SmmInitializeMemoryServices(),\r
+ // so temporarily use BootServicesData to hold the SmramRanges data.\r
+ //\r
+ mSmmCoreMemoryAllocLibSmramRangeCount = SmmCorePrivate->SmramRangeCount;\r
+ Size = mSmmCoreMemoryAllocLibSmramRangeCount * sizeof (EFI_SMRAM_DESCRIPTOR);\r
+ Status = gBS->AllocatePool (EfiBootServicesData, Size, (VOID **) &mSmmCoreMemoryAllocLibSmramRanges);\r
+ ASSERT_EFI_ERROR (Status);\r
+ ASSERT (mSmmCoreMemoryAllocLibSmramRanges != NULL);\r
+ CopyMem (mSmmCoreMemoryAllocLibSmramRanges, SmmCorePrivate->SmramRanges, Size);\r
+\r
+ //\r
+ // Initialize memory service using free SMRAM\r
+ //\r
+ SmmInitializeMemoryServices (SmmCorePrivate->SmramRangeCount, SmmCorePrivate->SmramRanges);\r
+\r
+ //\r
+ // Move the SmramRanges data from BootServicesData to SMRAM.\r
+ //\r
+ BootServicesData = mSmmCoreMemoryAllocLibSmramRanges;\r
+ mSmmCoreMemoryAllocLibSmramRanges = (EFI_SMRAM_DESCRIPTOR *) AllocateCopyPool (Size, (VOID *) BootServicesData);\r
+ ASSERT (mSmmCoreMemoryAllocLibSmramRanges != NULL);\r
+\r
+ //\r
+ // Free the temporarily used BootServicesData.\r
+ //\r
+ Status = gBS->FreePool (BootServicesData);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
projects / mirror_edk2.git / blobdiff