MdePkg/Library/SmmMemoryAllocationLib/MemoryAllocationLib.c File Reference


Functions

EFI_STATUS EFIAPI SmmMemoryAllocationLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
EFI_STATUS EFIAPI SmmMemoryAllocationLibDestructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
BOOLEAN EFIAPI BufferInSmram (IN VOID *Buffer)
VOID * InternalAllocatePages (IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages)
VOID *EFIAPI AllocatePages (IN UINTN Pages)
VOID *EFIAPI AllocateRuntimePages (IN UINTN Pages)
VOID *EFIAPI AllocateReservedPages (IN UINTN Pages)
VOID EFIAPI FreePages (IN VOID *Buffer, IN UINTN Pages)
VOID * InternalAllocateAlignedPages (IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, IN UINTN Alignment)
VOID *EFIAPI AllocateAlignedPages (IN UINTN Pages, IN UINTN Alignment)
VOID *EFIAPI AllocateAlignedRuntimePages (IN UINTN Pages, IN UINTN Alignment)
VOID *EFIAPI AllocateAlignedReservedPages (IN UINTN Pages, IN UINTN Alignment)
VOID EFIAPI FreeAlignedPages (IN VOID *Buffer, IN UINTN Pages)
VOID * InternalAllocatePool (IN EFI_MEMORY_TYPE MemoryType, IN UINTN AllocationSize)
VOID *EFIAPI AllocatePool (IN UINTN AllocationSize)
VOID *EFIAPI AllocateRuntimePool (IN UINTN AllocationSize)
VOID *EFIAPI AllocateReservedPool (IN UINTN AllocationSize)
VOID * InternalAllocateZeroPool (IN EFI_MEMORY_TYPE PoolType, IN UINTN AllocationSize)
VOID *EFIAPI AllocateZeroPool (IN UINTN AllocationSize)
VOID *EFIAPI AllocateRuntimeZeroPool (IN UINTN AllocationSize)
VOID *EFIAPI AllocateReservedZeroPool (IN UINTN AllocationSize)
VOID * InternalAllocateCopyPool (IN EFI_MEMORY_TYPE PoolType, IN UINTN AllocationSize, IN CONST VOID *Buffer)
VOID *EFIAPI AllocateCopyPool (IN UINTN AllocationSize, IN CONST VOID *Buffer)
VOID *EFIAPI AllocateRuntimeCopyPool (IN UINTN AllocationSize, IN CONST VOID *Buffer)
VOID *EFIAPI AllocateReservedCopyPool (IN UINTN AllocationSize, IN CONST VOID *Buffer)
VOID * InternalReallocatePool (IN EFI_MEMORY_TYPE PoolType, IN UINTN OldSize, IN UINTN NewSize, IN VOID *OldBuffer)
VOID *EFIAPI ReallocatePool (IN UINTN OldSize, IN UINTN NewSize, IN VOID *OldBuffer)
VOID *EFIAPI ReallocateRuntimePool (IN UINTN OldSize, IN UINTN NewSize, IN VOID *OldBuffer)
VOID *EFIAPI ReallocateReservedPool (IN UINTN OldSize, IN UINTN NewSize, IN VOID *OldBuffer)
VOID EFIAPI FreePool (IN VOID *Buffer)

Variables

EFI_SMRAM_DESCRIPTORmSmramRanges
UINTN mSmramRangeCount

Detailed Description

Support routines for memory allocation routines based on SMM Services Table services for SMM phase drivers.

The PI System Management Mode Core Interface Specification only allows the use of EfiRuntimeServicesCode and EfiRuntimeServicesData memory types for memory allocations through the SMM Services Table as the SMRAM space should be reserved after BDS phase. The functions in the Memory Allocation Library use EfiBootServicesData as the default memory allocation type. For this SMM specific instance of the Memory Allocation Library, EfiRuntimeServicesData is used as the default memory type for all allocations. In addition, allocation for the Reserved memory types are not supported and will always return NULL.

Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.
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.


Function Documentation

VOID* EFIAPI AllocateAlignedPages ( IN UINTN  Pages,
IN UINTN  Alignment 
)

Allocates one or more 4KB pages of type EfiRuntimeServicesData at a specified alignment.

Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned. If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned.

If Alignment is not a power of two and Alignment is not zero, then ASSERT(). If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

Parameters:
Pages The number of 4 KB pages to allocate.
Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalAllocateAlignedPages().

VOID* EFIAPI AllocateAlignedReservedPages ( IN UINTN  Pages,
IN UINTN  Alignment 
)

Allocates one or more 4KB pages of type EfiReservedMemoryType at a specified alignment.

Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType with an alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned. If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned.

If Alignment is not a power of two and Alignment is not zero, then ASSERT(). If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

Parameters:
Pages The number of 4 KB pages to allocate.
Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References NULL.

VOID* EFIAPI AllocateAlignedRuntimePages ( IN UINTN  Pages,
IN UINTN  Alignment 
)

Allocates one or more 4KB pages of type EfiRuntimeServicesData at a specified alignment.

Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned. If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned.

If Alignment is not a power of two and Alignment is not zero, then ASSERT(). If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

Parameters:
Pages The number of 4 KB pages to allocate.
Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalAllocateAlignedPages().

VOID* EFIAPI AllocateCopyPool ( IN UINTN  AllocationSize,
IN CONST VOID *  Buffer 
)

Copies a buffer to an allocated buffer of type EfiRuntimeServicesData.

Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, copies AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

If Buffer is NULL, then ASSERT(). If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters:
AllocationSize The number of bytes to allocate and zero.
Buffer The buffer to copy to the allocated buffer.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalAllocateCopyPool().

VOID* EFIAPI AllocatePages ( IN UINTN  Pages  ) 

Allocates one or more 4KB pages of type EfiRuntimeServicesData.

Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
Pages The number of 4 KB pages to allocate.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalAllocatePages().

VOID* EFIAPI AllocatePool ( IN UINTN  AllocationSize  ) 

Allocates a buffer of type EfiRuntimeServicesData.

Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
AllocationSize The number of bytes to allocate.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalAllocatePool().

VOID* EFIAPI AllocateReservedCopyPool ( IN UINTN  AllocationSize,
IN CONST VOID *  Buffer 
)

Copies a buffer to an allocated buffer of type EfiReservedMemoryType.

Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, copies AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

If Buffer is NULL, then ASSERT(). If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters:
AllocationSize The number of bytes to allocate and zero.
Buffer The buffer to copy to the allocated buffer.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References NULL.

VOID* EFIAPI AllocateReservedPages ( IN UINTN  Pages  ) 

Allocates one or more 4KB pages of type EfiReservedMemoryType.

Allocates the number of 4KB pages of type EfiReservedMemoryType and returns a pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
Pages The number of 4 KB pages to allocate.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References NULL.

VOID* EFIAPI AllocateReservedPool ( IN UINTN  AllocationSize  ) 

Allocates a buffer of type EfiReservedMemoryType.

Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
AllocationSize The number of bytes to allocate.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References NULL.

VOID* EFIAPI AllocateReservedZeroPool ( IN UINTN  AllocationSize  ) 

Allocates and zeros a buffer of type EfiReservedMemoryType.

Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, clears the buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
AllocationSize The number of bytes to allocate and zero.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References NULL.

VOID* EFIAPI AllocateRuntimeCopyPool ( IN UINTN  AllocationSize,
IN CONST VOID *  Buffer 
)

Copies a buffer to an allocated buffer of type EfiRuntimeServicesData.

Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, copies AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

If Buffer is NULL, then ASSERT(). If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters:
AllocationSize The number of bytes to allocate and zero.
Buffer The buffer to copy to the allocated buffer.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalAllocateCopyPool().

VOID* EFIAPI AllocateRuntimePages ( IN UINTN  Pages  ) 

Allocates one or more 4KB pages of type EfiRuntimeServicesData.

Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
Pages The number of 4 KB pages to allocate.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalAllocatePages().

VOID* EFIAPI AllocateRuntimePool ( IN UINTN  AllocationSize  ) 

Allocates a buffer of type EfiRuntimeServicesData.

Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
AllocationSize The number of bytes to allocate.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalAllocatePool().

VOID* EFIAPI AllocateRuntimeZeroPool ( IN UINTN  AllocationSize  ) 

Allocates and zeros a buffer of type EfiRuntimeServicesData.

Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, clears the buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
AllocationSize The number of bytes to allocate and zero.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalAllocateZeroPool().

VOID* EFIAPI AllocateZeroPool ( IN UINTN  AllocationSize  ) 

Allocates and zeros a buffer of type EfiRuntimeServicesData.

Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, clears the buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
AllocationSize The number of bytes to allocate and zero.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalAllocateZeroPool().

BOOLEAN EFIAPI BufferInSmram ( IN VOID *  Buffer  ) 

Check whether the start address of buffer is within any of the SMRAM ranges.

Parameters:
[in] Buffer The pointer to the buffer to be checked.
Return values:
TURE The buffer is in SMRAM ranges.
FALSE The buffer is out of SMRAM ranges.

References FALSE, mSmramRangeCount, and TRUE.

Referenced by FreeAlignedPages(), FreePages(), and FreePool().

VOID EFIAPI FreeAlignedPages ( IN VOID *  Buffer,
IN UINTN  Pages 
)

Frees one or more 4KB pages that were previously allocated with one of the aligned page allocation functions in the Memory Allocation Library.

Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer must have been allocated on a previous call to the aligned page allocation services of the Memory Allocation Library. If it is not possible to free allocated pages, then this function will perform no actions.

If Buffer was not allocated with an aligned page allocation function in the Memory Allocation Library, then ASSERT(). If Pages is zero, then ASSERT().

Parameters:
Buffer The pointer to the buffer of pages to free.
Pages The number of 4 KB pages to free.

References ASSERT, ASSERT_EFI_ERROR, BufferInSmram(), EFI_BOOT_SERVICES::FreePages, gBS, gSmst, and _EFI_SMM_SYSTEM_TABLE2::SmmFreePages.

VOID EFIAPI FreePages ( IN VOID *  Buffer,
IN UINTN  Pages 
)

Frees one or more 4KB pages that were previously allocated with one of the page allocation functions in the Memory Allocation Library.

Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer must have been allocated on a previous call to the page allocation services of the Memory Allocation Library. If it is not possible to free allocated pages, then this function will perform no actions.

If Buffer was not allocated with a page allocation function in the Memory Allocation Library, then ASSERT(). If Pages is zero, then ASSERT().

Parameters:
Buffer The pointer to the buffer of pages to free.
Pages The number of 4 KB pages to free.

References ASSERT, ASSERT_EFI_ERROR, BufferInSmram(), EFI_BOOT_SERVICES::FreePages, gBS, gSmst, and _EFI_SMM_SYSTEM_TABLE2::SmmFreePages.

VOID EFIAPI FreePool ( IN VOID *  Buffer  ) 

Frees a buffer that was previously allocated with one of the pool allocation functions in the Memory Allocation Library.

Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the pool allocation services of the Memory Allocation Library. If it is not possible to free pool resources, then this function will perform no actions.

If Buffer was not allocated with a pool allocation function in the Memory Allocation Library, then ASSERT().

Parameters:
Buffer The pointer to the buffer to free.

References ASSERT_EFI_ERROR, BufferInSmram(), EFI_BOOT_SERVICES::FreePool, gBS, gSmst, and _EFI_SMM_SYSTEM_TABLE2::SmmFreePool.

VOID* InternalAllocateAlignedPages ( IN EFI_MEMORY_TYPE  MemoryType,
IN UINTN  Pages,
IN UINTN  Alignment 
)

Allocates one or more 4KB pages of a certain memory type at a specified alignment.

Allocates the number of 4KB pages specified by Pages of a certain memory type with an alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned. If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. If Alignment is not a power of two and Alignment is not zero, then ASSERT(). If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

Parameters:
MemoryType The type of memory to allocate.
Pages The number of 4 KB pages to allocate.
Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References AllocateAnyPages, ASSERT, ASSERT_EFI_ERROR, EFI_ERROR, EFI_PAGE_SIZE, EFI_PAGES_TO_SIZE, EFI_SIZE_TO_PAGES, gSmst, NULL, _EFI_SMM_SYSTEM_TABLE2::SmmAllocatePages, _EFI_SMM_SYSTEM_TABLE2::SmmFreePages, and VOID.

VOID* InternalAllocateCopyPool ( IN EFI_MEMORY_TYPE  PoolType,
IN UINTN  AllocationSize,
IN CONST VOID *  Buffer 
)

Copies a buffer to an allocated buffer of a certain pool type.

Allocates the number bytes specified by AllocationSize of a certain pool type, copies AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned. If Buffer is NULL, then ASSERT(). If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters:
PoolType The type of pool to allocate.
AllocationSize The number of bytes to allocate and zero.
Buffer The buffer to copy to the allocated buffer.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References ASSERT, CopyMem(), InternalAllocatePool(), MAX_ADDRESS, NULL, and VOID.

VOID* InternalAllocatePages ( IN EFI_MEMORY_TYPE  MemoryType,
IN UINTN  Pages 
)

Allocates one or more 4KB pages of a certain memory type.

Allocates the number of 4KB pages of a certain memory type and returns a pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
MemoryType The type of memory to allocate.
Pages The number of 4 KB pages to allocate.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References AllocateAnyPages, EFI_ERROR, gSmst, NULL, _EFI_SMM_SYSTEM_TABLE2::SmmAllocatePages, and VOID.

VOID* InternalAllocatePool ( IN EFI_MEMORY_TYPE  MemoryType,
IN UINTN  AllocationSize 
)

Allocates a buffer of a certain pool type.

Allocates the number bytes specified by AllocationSize of a certain pool type and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
MemoryType The type of memory to allocate.
AllocationSize The number of bytes to allocate.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EFI_ERROR, gSmst, NULL, _EFI_SMM_SYSTEM_TABLE2::SmmAllocatePool, and VOID.

VOID* InternalAllocateZeroPool ( IN EFI_MEMORY_TYPE  PoolType,
IN UINTN  AllocationSize 
)

Allocates and zeros a buffer of a certain pool type.

Allocates the number bytes specified by AllocationSize of a certain pool type, clears the buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters:
PoolType The type of memory to allocate.
AllocationSize The number of bytes to allocate and zero.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References InternalAllocatePool(), NULL, VOID, and ZeroMem().

VOID* InternalReallocatePool ( IN EFI_MEMORY_TYPE  PoolType,
IN UINTN  OldSize,
IN UINTN  NewSize,
IN VOID *  OldBuffer 
)

Reallocates a buffer of a specified memory type.

Allocates and zeros the number bytes specified by NewSize from memory of the type specified by PoolType. If OldBuffer is not NULL, then the smaller of OldSize and NewSize bytes are copied from OldBuffer to the newly allocated buffer, and OldBuffer is freed. A pointer to the newly allocated buffer is returned. If NewSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

If the allocation of the new buffer is successful and the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().

Parameters:
PoolType The type of pool to allocate.
OldSize The size, in bytes, of OldBuffer.
NewSize The size, in bytes, of the buffer to reallocate.
OldBuffer The buffer to copy to the allocated buffer. This is an optional parameter that may be NULL.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References CopyMem(), FreePool(), InternalAllocateZeroPool(), MIN, NULL, and VOID.

VOID* EFIAPI ReallocatePool ( IN UINTN  OldSize,
IN UINTN  NewSize,
IN VOID *  OldBuffer 
)

Reallocates a buffer of type EfiRuntimeServicesData.

Allocates and zeros the number bytes specified by NewSize from memory of type EfiRuntimeServicesData. If OldBuffer is not NULL, then the smaller of OldSize and NewSize bytes are copied from OldBuffer to the newly allocated buffer, and OldBuffer is freed. A pointer to the newly allocated buffer is returned. If NewSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

If the allocation of the new buffer is successful and the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().

Parameters:
OldSize The size, in bytes, of OldBuffer.
NewSize The size, in bytes, of the buffer to reallocate.
OldBuffer The buffer to copy to the allocated buffer. This is an optional parameter that may be NULL.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalReallocatePool().

VOID* EFIAPI ReallocateReservedPool ( IN UINTN  OldSize,
IN UINTN  NewSize,
IN VOID *  OldBuffer 
)

Reallocates a buffer of type EfiReservedMemoryType.

Allocates and zeros the number bytes specified by NewSize from memory of type EfiReservedMemoryType. If OldBuffer is not NULL, then the smaller of OldSize and NewSize bytes are copied from OldBuffer to the newly allocated buffer, and OldBuffer is freed. A pointer to the newly allocated buffer is returned. If NewSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

If the allocation of the new buffer is successful and the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().

Parameters:
OldSize The size, in bytes, of OldBuffer.
NewSize The size, in bytes, of the buffer to reallocate.
OldBuffer The buffer to copy to the allocated buffer. This is an optional parameter that may be NULL.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References NULL.

VOID* EFIAPI ReallocateRuntimePool ( IN UINTN  OldSize,
IN UINTN  NewSize,
IN VOID *  OldBuffer 
)

Reallocates a buffer of type EfiRuntimeServicesData.

Allocates and zeros the number bytes specified by NewSize from memory of type EfiRuntimeServicesData. If OldBuffer is not NULL, then the smaller of OldSize and NewSize bytes are copied from OldBuffer to the newly allocated buffer, and OldBuffer is freed. A pointer to the newly allocated buffer is returned. If NewSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

If the allocation of the new buffer is successful and the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().

Parameters:
OldSize The size, in bytes, of OldBuffer.
NewSize The size, in bytes, of the buffer to reallocate.
OldBuffer The buffer to copy to the allocated buffer. This is an optional parameter that may be NULL.
Returns:
A pointer to the allocated buffer or NULL if allocation fails.

References EfiRuntimeServicesData, and InternalReallocatePool().

EFI_STATUS EFIAPI SmmMemoryAllocationLibConstructor ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

The constructor function caches SMRAM ranges that are present in the system.

It will ASSERT() if SMM Access2 Protocol doesn't exist. It will ASSERT() if SMRAM ranges can't be got. It will ASSERT() if Resource can't be allocated for cache SMRAM range. It will always return EFI_SUCCESS.

Parameters:
ImageHandle The firmware allocated handle for the EFI image.
SystemTable A pointer to the EFI System Table.
Return values:
EFI_SUCCESS The constructor always returns EFI_SUCCESS.

References AllocatePool(), ASSERT, ASSERT_EFI_ERROR, EFI_BUFFER_TOO_SMALL, EFI_SUCCESS, gBS, gEfiSmmAccess2ProtocolGuid, EFI_BOOT_SERVICES::LocateProtocol, mSmramRangeCount, NULL, and VOID.

EFI_STATUS EFIAPI SmmMemoryAllocationLibDestructor ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

If SMM driver exits with an error, it must call this routine to free the allocated resource before the exiting.

Parameters:
[in] ImageHandle The firmware allocated handle for the EFI image.
[in] SystemTable A pointer to the EFI System Table.
Return values:
EFI_SUCCESS The deconstructor always returns EFI_SUCCESS.

References EFI_SUCCESS, and FreePool().


Variable Documentation


Generated on Thu Sep 24 23:14:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1