Update MemoryAllocationLib.AllocateAlignedPages API comments for memory overflow ASSERT case.

Signed-off-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>


git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15033 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Liming Gao 2013-12-31 07:19:09 +00:00 committed by lgao4
parent 27bace9b3e
commit 1346352d52
4 changed files with 18 additions and 3 deletions

View File

@ -6,7 +6,7 @@
and SMM (for example) is done via a different mechanism. Using a common library interface makes it and SMM (for example) is done via a different mechanism. Using a common library interface makes it
much easier to port algorithms from phase to phase. much easier to port algorithms from phase to phase.
Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -110,6 +110,7 @@ FreePages (
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. Must be a power of two. @param Alignment The requested alignment of the allocation. Must be a power of two.
@ -134,6 +135,7 @@ AllocateAlignedPages (
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. Must be a power of two. @param Alignment The requested alignment of the allocation. Must be a power of two.
@ -158,6 +160,7 @@ AllocateAlignedRuntimePages (
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. Must be a power of two. @param Alignment The requested alignment of the allocation. Must be a power of two.

View File

@ -189,6 +189,7 @@ FreePages (
If there is not enough memory at the specified alignment remaining to satisfy the request, then If there is not enough memory at the specified alignment remaining to satisfy the request, then
NULL is returned. NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). 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().
@param MemoryType The type of memory to allocate. @param MemoryType The type of memory to allocate.
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@ -242,6 +243,7 @@ InternalAllocateAlignedPages (
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. @param Alignment The requested alignment of the allocation.
@ -270,6 +272,7 @@ AllocateAlignedPages (
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. @param Alignment The requested alignment of the allocation.
@ -298,6 +301,7 @@ AllocateAlignedRuntimePages (
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. @param Alignment The requested alignment of the allocation.

View File

@ -11,7 +11,7 @@
In addition, allocation for the Reserved memory types are not supported and In addition, allocation for the Reserved memory types are not supported and
will always return NULL. will always return NULL.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -285,6 +285,7 @@ FreePages (
If Pages is 0, then NULL is returned. If there is not enough memory at the 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. 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 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().
@param MemoryType The type of memory to allocate. @param MemoryType The type of memory to allocate.
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@ -372,6 +373,7 @@ InternalAllocateAlignedPages (
specified alignment remaining to satisfy the request, then NULL is returned. 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 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. @param Alignment The requested alignment of the allocation.
@ -400,6 +402,7 @@ AllocateAlignedPages (
specified alignment remaining to satisfy the request, then NULL is returned. 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 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. @param Alignment The requested alignment of the allocation.
@ -428,6 +431,7 @@ AllocateAlignedRuntimePages (
specified alignment remaining to satisfy the request, then NULL is returned. 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 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. @param Alignment The requested alignment of the allocation.

View File

@ -2,7 +2,7 @@
Support routines for memory allocation routines based Support routines for memory allocation routines based
on boot services for Dxe phase drivers. on boot services for Dxe phase drivers.
Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -160,6 +160,7 @@ FreePages (
If there is not enough memory at the specified alignment remaining to satisfy the request, then If there is not enough memory at the specified alignment remaining to satisfy the request, then
NULL is returned. NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). 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().
@param MemoryType The type of memory to allocate. @param MemoryType The type of memory to allocate.
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@ -246,6 +247,7 @@ InternalAllocateAlignedPages (
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. Must be a power of two. @param Alignment The requested alignment of the allocation. Must be a power of two.
@ -273,6 +275,7 @@ AllocateAlignedPages (
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. Must be a power of two. @param Alignment The requested alignment of the allocation. Must be a power of two.
@ -300,6 +303,7 @@ AllocateAlignedRuntimePages (
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). 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().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. Must be a power of two. @param Alignment The requested alignment of the allocation. Must be a power of two.