/** @file\r
- Support routines for memory allocation routines based \r
+ Support routines for memory allocation routines based\r
on boot services for Dxe phase drivers.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
- All rights reserved. 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
-\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
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
**/\r
VOID *\r
InternalAllocatePages (\r
- IN EFI_MEMORY_TYPE MemoryType, \r
+ IN EFI_MEMORY_TYPE MemoryType,\r
IN UINTN Pages\r
)\r
{\r
EFI_STATUS Status;\r
- EFI_PHYSICAL_ADDRESS Memory; \r
+ EFI_PHYSICAL_ADDRESS Memory;\r
\r
if (Pages == 0) {\r
return NULL;\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.\r
- \r
+ Allocation Library. If it is not possible to free allocated pages, then this function will\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
+\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
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
VOID *\r
InternalAllocateAlignedPages (\r
- IN EFI_MEMORY_TYPE MemoryType, \r
+ IN EFI_MEMORY_TYPE MemoryType,\r
IN UINTN Pages,\r
IN UINTN Alignment\r
)\r
// Alignment must be a power of two or zero.\r
//\r
ASSERT ((Alignment & (Alignment - 1)) == 0);\r
- \r
+\r
if (Pages == 0) {\r
return NULL;\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
// Make sure that Pages plus EFI_SIZE_TO_PAGES (Alignment) does not overflow.\r
//\r
ASSERT (RealPages > Pages);\r
- \r
+\r
Status = gBS->AllocatePages (AllocateAnyPages, MemoryType, RealPages, &Memory);\r
if (EFI_ERROR (Status)) {\r
return NULL;\r
Status = gBS->FreePages (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
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
+\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
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
+\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
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
+\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
\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.\r
- \r
+ Allocation Library. If it is not possible to free allocated pages, then this function will\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
+\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
**/\r
VOID *\r
InternalAllocatePool (\r
- IN EFI_MEMORY_TYPE MemoryType, \r
+ IN EFI_MEMORY_TYPE MemoryType,\r
IN UINTN AllocationSize\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
VOID *\r
InternalAllocateZeroPool (\r
- IN EFI_MEMORY_TYPE PoolType, \r
+ IN EFI_MEMORY_TYPE PoolType,\r
IN UINTN AllocationSize\r
- ) \r
+ )\r
{\r
VOID *Memory;\r
\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 Buffer is NULL, then ASSERT().\r
- If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
@param PoolType The type of pool to allocate.\r
@param AllocationSize The number of bytes to allocate and zero.\r
**/\r
VOID *\r
InternalAllocateCopyPool (\r
- IN EFI_MEMORY_TYPE PoolType, \r
+ IN EFI_MEMORY_TYPE PoolType,\r
IN UINTN AllocationSize,\r
IN CONST VOID *Buffer\r
- ) \r
+ )\r
{\r
VOID *Memory;\r
\r
Memory = CopyMem (Memory, Buffer, AllocationSize);\r
}\r
return Memory;\r
-} \r
+}\r
\r
/**\r
Copies a buffer to an allocated buffer of type EfiBootServicesData.\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
- \r
+\r
If Buffer is NULL, then ASSERT().\r
- If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
@param AllocationSize The number of bytes to allocate and zero.\r
@param Buffer The buffer to copy to the allocated buffer.\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
- \r
+\r
If Buffer is NULL, then ASSERT().\r
- If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
@param AllocationSize The number of bytes to allocate and zero.\r
@param Buffer The buffer to copy to the allocated buffer.\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
- \r
+\r
If Buffer is NULL, then ASSERT().\r
- If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
@param AllocationSize The number of bytes to allocate and zero.\r
@param Buffer The buffer to copy to the allocated buffer.\r
Reallocates a buffer of a specified memory type.\r
\r
Allocates and zeros the number bytes specified by NewSize from memory of the type\r
- specified by PoolType. 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
+ specified by PoolType. 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
enough memory remaining to satisfy the request, then NULL is returned.\r
- \r
- If OldBuffer is NULL, then ASSERT().\r
- If NewSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
- If OldSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+\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
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an optional\r
parameter that may be NULL.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
-EFIAPI\r
InternalReallocatePool (\r
- IN EFI_MEMORY_TYPE PoolType, \r
+ IN EFI_MEMORY_TYPE PoolType,\r
IN UINTN OldSize,\r
IN UINTN NewSize,\r
IN VOID *OldBuffer OPTIONAL\r
{\r
VOID *NewBuffer;\r
\r
- NewBuffer = AllocateZeroPool (NewSize);\r
+ NewBuffer = InternalAllocateZeroPool (PoolType, NewSize);\r
if (NewBuffer != NULL && OldBuffer != NULL) {\r
CopyMem (NewBuffer, OldBuffer, MIN (OldSize, NewSize));\r
FreePool (OldBuffer);\r
Reallocates a buffer of type EfiBootServicesData.\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
- 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
+ EfiBootServicesData. 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
enough memory remaining to satisfy the request, then NULL is returned.\r
- \r
- If OldBuffer is NULL, then ASSERT().\r
- If NewSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
- If OldSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+\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
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an optional\r
parameter that may be NULL.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\r
Reallocates a buffer of type EfiRuntimeServicesData.\r
\r
Allocates and zeros the number bytes specified by NewSize from memory of type\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
+ 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
enough memory remaining to satisfy the request, then NULL is returned.\r
\r
- If OldBuffer is NULL, then ASSERT().\r
- If NewSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
- If OldSize is greater than (MAX_ADDRESS - Buffer + 1), 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
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an optional\r
parameter that may be NULL.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\r
Reallocates a buffer of type EfiReservedMemoryType.\r
\r
Allocates and zeros the number bytes specified by NewSize from memory of type\r
- EfiReservedMemoryType. 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
+ EfiReservedMemoryType. 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
enough memory remaining to satisfy the request, then NULL is returned.\r
- \r
- If OldBuffer is NULL, then ASSERT().\r
- If NewSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
- If OldSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+\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
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an optional\r
parameter that may be NULL.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\r
Memory Allocation Library.\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.\r
- \r
+ pool allocation services of the Memory Allocation Library. If it is not possible to free pool\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