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
+ Copyright (c) 2006 - 2009, 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
\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
+ 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
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
\r
@param Pages The number of 4 KB pages to allocate.\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
\r
@param Pages The number of 4 KB pages to allocate.\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
\r
@param Pages The number of 4 KB pages to allocate.\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
+ 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
\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
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
If Buffer is NULL, then ASSERT().\r
If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
\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
If Buffer is NULL, then ASSERT().\r
If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
\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
If Buffer is NULL, then ASSERT().\r
If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
\r
return InternalAllocateCopyPool (EfiReservedMemoryType, AllocationSize, Buffer);\r
}\r
\r
+/**\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
+ 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
+\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
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
+\r
+**/\r
+VOID *\r
+InternalReallocatePool (\r
+ IN EFI_MEMORY_TYPE PoolType, \r
+ IN UINTN OldSize,\r
+ IN UINTN NewSize,\r
+ IN VOID *OldBuffer OPTIONAL\r
+ )\r
+{\r
+ VOID *NewBuffer;\r
+\r
+ //\r
+ // Check the boundary for OldBuffer even if the allocation failure.\r
+ //\r
+ ASSERT (OldBuffer == NULL || MIN (OldSize, NewSize) <= MAX_ADDRESS - (UINTN) OldBuffer + 1);\r
+ NewBuffer = InternalAllocateZeroPool (PoolType, NewSize);\r
+ if (NewBuffer != NULL && OldBuffer != NULL) {\r
+ CopyMem (NewBuffer, OldBuffer, MIN (OldSize, NewSize));\r
+ FreePool (OldBuffer);\r
+ }\r
+ return NewBuffer;\r
+}\r
+\r
+/**\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
+ 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
+\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
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+ReallocatePool (\r
+ IN UINTN OldSize,\r
+ IN UINTN NewSize,\r
+ IN VOID *OldBuffer OPTIONAL\r
+ )\r
+{\r
+ return InternalReallocatePool (EfiBootServicesData, OldSize, NewSize, OldBuffer);\r
+}\r
+\r
+/**\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
+ 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
+\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
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+ReallocateRuntimePool (\r
+ IN UINTN OldSize,\r
+ IN UINTN NewSize,\r
+ IN VOID *OldBuffer OPTIONAL\r
+ )\r
+{\r
+ return InternalReallocatePool (EfiRuntimeServicesData, OldSize, NewSize, OldBuffer);\r
+}\r
+\r
+/**\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
+ 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
+\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
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+ReallocateReservedPool (\r
+ IN UINTN OldSize,\r
+ IN UINTN NewSize,\r
+ IN VOID *OldBuffer OPTIONAL\r
+ )\r
+{\r
+ return InternalReallocatePool (EfiReservedMemoryType, OldSize, NewSize, OldBuffer);\r
+}\r
+\r
/**\r
Frees a buffer that was previously allocated with one of the pool allocation functions in the\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
+ 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
projects / mirror_edk2.git / blobdiff