MemoryAllocationLib.c File Reference

#include <PiPei.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/PrePiLib.h>
#include <Library/DebugLib.h>

Go to the source code of this file.

Functions
VOID *EFIAPI	AllocatePages (IN UINTN Pages)
VOID *EFIAPI	AllocateAlignedPages (IN UINTN Pages, IN UINTN Alignment)
VOID EFIAPI	FreePages (IN VOID *Buffer, IN UINTN Pages)
VOID *EFIAPI	AllocatePool (IN UINTN AllocationSize)
VOID *EFIAPI	AllocateZeroPool (IN UINTN AllocationSize)
VOID EFIAPI	FreePool (IN VOID *Buffer)

Detailed Description

Implementation of the 6 PEI Ffs (FV) APIs in library form.

Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file MemoryAllocationLib.c.

Function Documentation

AllocateAlignedPages()

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

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

Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData 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().

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.

Definition at line 92 of file MemoryAllocationLib.c.

AllocatePages()

VOID *EFIAPI AllocatePages

(

IN UINTN

Pages

)

Allocates one or more 4KB pages of type EfiBootServicesData.

Allocates the number of 4KB pages of MemoryType 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.

Definition at line 32 of file MemoryAllocationLib.c.

AllocatePool()

VOID *EFIAPI AllocatePool

(

IN UINTN

AllocationSize

)

Allocates a buffer of type EfiBootServicesData.

Allocates the number bytes specified by AllocationSize of type EfiBootServicesData 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.

Definition at line 168 of file MemoryAllocationLib.c.

AllocateZeroPool()

VOID *EFIAPI AllocateZeroPool

(

IN UINTN

AllocationSize

)

Allocates and zeros a buffer of type EfiBootServicesData.

Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, 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.

Definition at line 207 of file MemoryAllocationLib.c.

FreePages()

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	Pointer to the buffer of pages to free.
Pages	The number of 4 KB pages to free.

Definition at line 145 of file MemoryAllocationLib.c.

FreePool()

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

Pointer to the buffer to free.

Definition at line 239 of file MemoryAllocationLib.c.