Support routines for memory allocation routines \r
based on PeiService for PEI phase drivers.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials \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
- http://opensource.org/licenses/bsd-license.php \r
+ http://opensource.org/licenses/bsd-license.php. \r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
#include <Library/PeiServicesLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
+#include <Library/HobLib.h>\r
\r
\r
/**\r
if (EFI_ERROR (Status)) {\r
return NULL;\r
}\r
+\r
return (VOID *) (UINTN) Memory;\r
}\r
\r
Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer\r
must have been allocated on a previous call to the page allocation services of the Memory\r
Allocation Library. If it is not possible to free allocated pages, then this function will\r
- peform no actions.\r
+ perform no actions.\r
\r
If Buffer was not allocated with a page allocation function in the Memory Allocation Library,\r
then ASSERT().\r
If Pages is zero, then ASSERT().\r
\r
- @param Buffer Pointer to the buffer of pages to free.\r
+ @param Buffer The pointer to the buffer of pages to free.\r
@param Pages The number of 4 KB pages to free.\r
\r
**/\r
IN UINTN Pages\r
)\r
{\r
+ EFI_STATUS Status;\r
+\r
ASSERT (Pages != 0);\r
- //\r
- // PEI phase does not support to free pages, so leave it as NOP.\r
- //\r
+ Status = PeiServicesFreePages ((EFI_PHYSICAL_ADDRESS) (UINTN) Buffer, Pages);\r
+ ASSERT_EFI_ERROR (Status);\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
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ @param Alignment The requested alignment of the allocation. \r
+ Must be a power of two.\r
If Alignment is zero, then byte alignment is used.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\r
IN UINTN Alignment\r
)\r
{\r
- VOID *Memory;\r
- UINTN AlignmentMask;\r
+ EFI_PHYSICAL_ADDRESS Memory;\r
+ EFI_PHYSICAL_ADDRESS AlignedMemory;\r
+ EFI_PEI_HOB_POINTERS Hob;\r
+ BOOLEAN SkipBeforeMemHob;\r
+ BOOLEAN SkipAfterMemHob;\r
+ EFI_PHYSICAL_ADDRESS HobBaseAddress;\r
+ UINT64 HobLength;\r
+ EFI_MEMORY_TYPE HobMemoryType;\r
+ UINTN TotalPages;\r
\r
//\r
// Alignment must be a power of two or zero.\r
//\r
// Make sure that Pages plus EFI_SIZE_TO_PAGES (Alignment) does not overflow.\r
//\r
- ASSERT (Pages <= (MAX_ADDRESS - EFI_SIZE_TO_PAGES (Alignment)));\r
+ ASSERT (Pages <= (MAX_ADDRESS - EFI_SIZE_TO_PAGES (Alignment))); \r
+\r
//\r
// We would rather waste some memory to save PEI code size.\r
+ // meaning in addition to the requested size for the aligned mem,\r
+ // we simply reserve an overhead memory equal to Alignmemt(page-aligned), no matter what.\r
+ // The overhead mem size could be reduced later with more involved malloc mechanisms\r
+ // (e.g., somthing that can detect the alignment boundary before allocating memory or \r
+ // can request that memory be allocated at a certain address that is aleady aligned).\r
+ //\r
+ TotalPages = Pages + (Alignment <= EFI_PAGE_SIZE ? 0 : EFI_SIZE_TO_PAGES(Alignment));\r
+ Memory = (EFI_PHYSICAL_ADDRESS) (UINTN) InternalAllocatePages (MemoryType, TotalPages);\r
+ if (Memory == 0) {\r
+ DEBUG((DEBUG_INFO, "Out of memory resource! \n"));\r
+ return NULL;\r
+ }\r
+ DEBUG ((DEBUG_INFO, "Allocated Memory unaligned: Address = 0x%LX, Pages = 0x%X, Type = %d \n", Memory, TotalPages, (UINTN) MemoryType));\r
+\r
+ //\r
+ // Alignment calculation\r
+ //\r
+ AlignedMemory = Memory;\r
+ if (Alignment > EFI_PAGE_SIZE) {\r
+ AlignedMemory = ALIGN_VALUE (Memory, Alignment);\r
+ }\r
+ DEBUG ((DEBUG_INFO, "After aligning to 0x%X bytes: Address = 0x%LX, Pages = 0x%X \n", Alignment, AlignedMemory, Pages));\r
+\r
+ //\r
+ // In general three HOBs cover the total allocated space.\r
+ // The aligned portion is covered by the aligned mem HOB and\r
+ // the unaligned(to be freed) portions before and after the aligned portion are covered by newly created HOBs.\r
+ //\r
+ // Before mem HOB covers the region between "Memory" and "AlignedMemory"\r
+ // Aligned mem HOB covers the region between "AlignedMemory" and "AlignedMemory + EFI_PAGES_TO_SIZE(Pages)"\r
+ // After mem HOB covers the region between "AlignedMemory + EFI_PAGES_TO_SIZE(Pages)" and "Memory + EFI_PAGES_TO_SIZE(TotalPages)"\r
+ //\r
+ // The before or after mem HOBs need to be skipped under special cases where the aligned portion\r
+ // touches either the top or bottom of the original allocated space.\r
+ //\r
+ SkipBeforeMemHob = FALSE;\r
+ SkipAfterMemHob = FALSE;\r
+ if (Memory == AlignedMemory) {\r
+ SkipBeforeMemHob = TRUE;\r
+ }\r
+ if ((Memory + EFI_PAGES_TO_SIZE(TotalPages)) == (AlignedMemory + EFI_PAGES_TO_SIZE(Pages))) {\r
+ //\r
+ // This condition is never met in the current implementation.\r
+ // There is always some after-mem since the overhead mem(used in TotalPages)\r
+ // is no less than Alignment.\r
+ //\r
+ SkipAfterMemHob = TRUE;\r
+ }\r
+\r
+ // \r
+ // Search for the mem HOB referring to the original(unaligned) allocation \r
+ // and update the size and type if needed.\r
//\r
- Memory = InternalAllocatePages (MemoryType, Pages + EFI_SIZE_TO_PAGES (Alignment));\r
- if (Alignment == 0) {\r
- AlignmentMask = Alignment;\r
+ Hob.Raw = GetFirstHob (EFI_HOB_TYPE_MEMORY_ALLOCATION);\r
+ while (Hob.Raw != NULL) {\r
+ if (Hob.MemoryAllocation->AllocDescriptor.MemoryBaseAddress == Memory) {\r
+ break;\r
+ }\r
+ Hob.Raw = GET_NEXT_HOB (Hob);\r
+ Hob.Raw = GetNextHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, Hob.Raw);\r
+ }\r
+ ASSERT (Hob.Raw != NULL);\r
+ if (SkipBeforeMemHob) {\r
+ //\r
+ // Use this HOB as aligned mem HOB as there is no portion before it.\r
+ //\r
+ HobLength = EFI_PAGES_TO_SIZE(Pages);\r
+ Hob.MemoryAllocation->AllocDescriptor.MemoryLength = HobLength;\r
+ } else {\r
+ //\r
+ // Use this HOB as before mem HOB and create a new HOB for the aligned portion \r
+ //\r
+ HobLength = (AlignedMemory - Memory); \r
+ Hob.MemoryAllocation->AllocDescriptor.MemoryLength = HobLength;\r
+ Hob.MemoryAllocation->AllocDescriptor.MemoryType = EfiConventionalMemory;\r
+ }\r
+\r
+ HobBaseAddress = Hob.MemoryAllocation->AllocDescriptor.MemoryBaseAddress;\r
+ HobMemoryType = Hob.MemoryAllocation->AllocDescriptor.MemoryType;\r
+\r
+ //\r
+ // Build the aligned mem HOB if needed\r
+ //\r
+ if (!SkipBeforeMemHob) {\r
+ DEBUG((DEBUG_INFO, "Updated before-mem HOB with BaseAddress = %LX, Length = %LX, MemoryType = %d \n",\r
+ HobBaseAddress, HobLength, (UINTN) HobMemoryType));\r
+\r
+ HobBaseAddress = AlignedMemory;\r
+ HobLength = EFI_PAGES_TO_SIZE(Pages);\r
+ HobMemoryType = MemoryType;\r
+\r
+ BuildMemoryAllocationHob (\r
+ HobBaseAddress,\r
+ HobLength,\r
+ HobMemoryType\r
+ );\r
+\r
+ DEBUG((DEBUG_INFO, "Created aligned-mem HOB with BaseAddress = %LX, Length = %LX, MemoryType = %d \n",\r
+ HobBaseAddress, HobLength, (UINTN) HobMemoryType));\r
} else {\r
- AlignmentMask = Alignment - 1; \r
+ if (HobBaseAddress != 0) {\r
+ DEBUG((DEBUG_INFO, "Updated aligned-mem HOB with BaseAddress = %LX, Length = %LX, MemoryType = %d \n",\r
+ HobBaseAddress, HobLength, (UINTN) HobMemoryType));\r
+ }\r
+ }\r
+\r
+\r
+ //\r
+ // Build the after mem HOB if needed\r
+ //\r
+ if (!SkipAfterMemHob) {\r
+ HobBaseAddress = AlignedMemory + EFI_PAGES_TO_SIZE(Pages);\r
+ HobLength = (Memory + EFI_PAGES_TO_SIZE(TotalPages)) - (AlignedMemory + EFI_PAGES_TO_SIZE(Pages));\r
+ HobMemoryType = EfiConventionalMemory;\r
+\r
+ BuildMemoryAllocationHob (\r
+ HobBaseAddress,\r
+ HobLength,\r
+ HobMemoryType\r
+ );\r
+\r
+ DEBUG((DEBUG_INFO, "Created after-mem HOB with BaseAddress = %LX, Length = %LX, MemoryType = %d \n",\r
+ HobBaseAddress, HobLength, (UINTN) HobMemoryType));\r
}\r
- return (VOID *) (UINTN) (((UINTN) Memory + AlignmentMask) & ~AlignmentMask);\r
+\r
+ return (VOID *) (UINTN) AlignedMemory;\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
+ @param Alignment The requested alignment of the allocation. \r
+ Must be a power of two.\r
If Alignment is zero, then byte alignment is used.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\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
+ @param Alignment The requested alignment of the allocation. \r
+ Must be a power of two.\r
If Alignment is zero, then byte alignment is used.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\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
+ @param Alignment The requested alignment of the allocation. \r
+ Must be a power of two.\r
If Alignment is zero, then byte alignment is used.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\r
Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer\r
must have been allocated on a previous call to the aligned page allocation services of the Memory\r
Allocation Library. If it is not possible to free allocated pages, then this function will \r
- peform no actions.\r
+ perform no actions.\r
\r
If Buffer was not allocated with an aligned page allocation function in the Memory Allocation\r
Library, then ASSERT().\r
If Pages is zero, then ASSERT().\r
\r
- @param Buffer Pointer to the buffer of pages to free.\r
+ @param Buffer The pointer to the buffer of pages to free.\r
@param Pages The number of 4 KB pages to free.\r
\r
**/\r
IN UINTN Pages\r
)\r
{\r
+ EFI_STATUS Status;\r
+\r
ASSERT (Pages != 0);\r
- //\r
- // PEI phase does not support to free pages, so leave it as NOP.\r
- //\r
+ Status = PeiServicesFreePages ((EFI_PHYSICAL_ADDRESS) (UINTN) Buffer, Pages);\r
+ ASSERT_EFI_ERROR (Status);\r
}\r
\r
/**\r
}\r
\r
/**\r
- Allocates and zeros a buffer of a certian pool type.\r
+ Allocates and zeros a buffer of a certain pool type.\r
\r
- Allocates the number bytes specified by AllocationSize of a certian pool type, clears the buffer\r
+ Allocates the number bytes specified by AllocationSize of a certain pool type, clears the buffer\r
with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid\r
buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request,\r
then NULL is returned.\r
}\r
\r
/**\r
- Copies a buffer to an allocated buffer of a certian pool type.\r
+ Copies a buffer to an allocated buffer of a certain pool type.\r
\r
- Allocates the number bytes specified by AllocationSize of a certian pool type, copies\r
+ Allocates the number bytes specified by AllocationSize of a certain pool type, 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
If NewSize is 0, then a valid buffer of 0 size is returned. If there is not \r
enough memory remaining to satisfy the request, then NULL is returned.\r
\r
- If the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1),\r
- then ASSERT(). \r
+ If the allocation of the new buffer is successful and the smaller of NewSize and OldSize\r
+ is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().\r
\r
@param PoolType The type of pool to allocate.\r
@param OldSize The size, in bytes, of OldBuffer.\r
@param NewSize The size, in bytes, of the buffer to reallocate.\r
- @param OldBuffer The buffer to copy to the allocated buffer. This is an optional \r
- parameter that may be NULL.\r
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an \r
+ optional parameter that may be NULL.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
If NewSize is 0, then a valid buffer of 0 size is returned. If there is not \r
enough memory remaining to satisfy the request, then NULL is returned.\r
\r
- If the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1),\r
- then ASSERT(). \r
+ If the allocation of the new buffer is successful and the smaller of NewSize and OldSize\r
+ is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().\r
\r
@param OldSize The size, in bytes, of OldBuffer.\r
@param NewSize The size, in bytes, of the buffer to reallocate.\r
If NewSize is 0, then a valid buffer of 0 size is returned. If there is not \r
enough memory remaining to satisfy the request, then NULL is returned.\r
\r
- If the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1),\r
- then ASSERT(). \r
+ If the allocation of the new buffer is successful and the smaller of NewSize and OldSize\r
+ is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().\r
\r
@param OldSize The size, in bytes, of OldBuffer.\r
@param NewSize The size, in bytes, of the buffer to reallocate.\r
If NewSize is 0, then a valid buffer of 0 size is returned. If there is not \r
enough memory remaining to satisfy the request, then NULL is returned.\r
\r
- If the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1),\r
- then ASSERT(). \r
+ If the allocation of the new buffer is successful and the smaller of NewSize and OldSize\r
+ is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().\r
\r
@param OldSize The size, in bytes, of OldBuffer.\r
@param NewSize The size, in bytes, of the buffer to reallocate.\r
- @param OldBuffer The buffer to copy to the allocated buffer. This is an optional \r
- parameter that may be NULL.\r
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an \r
+ optional parameter that may be NULL.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
\r
Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the\r
pool allocation services of the Memory Allocation Library. If it is not possible to free pool\r
- resources, then this function will peform no actions.\r
+ resources, then this function will perform no actions.\r
\r
If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,\r
then ASSERT().\r
\r
- @param Buffer Pointer to the buffer to free.\r
+ @param Buffer The pointer to the buffer to free.\r
\r
**/\r
VOID\r
projects / mirror_edk2.git / blobdiff