2 UEFI Memory pool management functions.
4 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #define POOL_FREE_SIGNATURE EFI_SIGNATURE_32('p','f','r','0')
25 #define POOL_HEAD_SIGNATURE EFI_SIGNATURE_32('p','h','d','0')
34 #define SIZE_OF_POOL_HEAD EFI_FIELD_OFFSET(POOL_HEAD,Data)
36 #define POOL_TAIL_SIGNATURE EFI_SIGNATURE_32('p','t','a','l')
45 #define POOL_OVERHEAD (SIZE_OF_POOL_HEAD + sizeof(POOL_TAIL))
47 #define HEAD_TO_TAIL(a) \
48 ((POOL_TAIL *) (((CHAR8 *) (a)) + (a)->Size - sizeof(POOL_TAIL)));
51 #define SIZE_TO_LIST(a) ((a) >> POOL_SHIFT)
52 #define LIST_TO_SIZE(a) ((a+1) << POOL_SHIFT)
54 #define MAX_POOL_LIST SIZE_TO_LIST(DEFAULT_PAGE_ALLOCATION)
56 #define MAX_POOL_SIZE (MAX_ADDRESS - POOL_OVERHEAD)
62 #define POOL_SIGNATURE EFI_SIGNATURE_32('p','l','s','t')
66 EFI_MEMORY_TYPE MemoryType
;
67 LIST_ENTRY FreeList
[MAX_POOL_LIST
];
72 // Pool header for each memory type.
74 POOL mPoolHead
[EfiMaxMemoryType
];
77 // List of pool header to search for the appropriate memory type.
79 LIST_ENTRY mPoolHeadList
;
83 Called to initialize the pool.
94 for (Type
=0; Type
< EfiMaxMemoryType
; Type
++) {
95 mPoolHead
[Type
].Signature
= 0;
96 mPoolHead
[Type
].Used
= 0;
97 mPoolHead
[Type
].MemoryType
= (EFI_MEMORY_TYPE
) Type
;
98 for (Index
=0; Index
< MAX_POOL_LIST
; Index
++) {
99 InitializeListHead (&mPoolHead
[Type
].FreeList
[Index
]);
102 InitializeListHead (&mPoolHeadList
);
107 Look up pool head for specified memory type.
109 @param MemoryType Memory type of which pool head is looked for
111 @return Pointer of Corresponding pool head.
116 IN EFI_MEMORY_TYPE MemoryType
123 if (MemoryType
>= 0 && MemoryType
< EfiMaxMemoryType
) {
124 return &mPoolHead
[MemoryType
];
127 if (MemoryType
< 0) {
129 for (Link
= mPoolHeadList
.ForwardLink
; Link
!= &mPoolHeadList
; Link
= Link
->ForwardLink
) {
130 Pool
= CR(Link
, POOL
, Link
, POOL_SIGNATURE
);
131 if (Pool
->MemoryType
== MemoryType
) {
136 Pool
= CoreAllocatePoolI (EfiBootServicesData
, sizeof (POOL
));
141 Pool
->Signature
= POOL_SIGNATURE
;
143 Pool
->MemoryType
= MemoryType
;
144 for (Index
=0; Index
< MAX_POOL_LIST
; Index
++) {
145 InitializeListHead (&Pool
->FreeList
[Index
]);
148 InsertHeadList (&mPoolHeadList
, &Pool
->Link
);
159 Allocate pool of a particular type.
161 @param PoolType Type of pool to allocate
162 @param Size The amount of pool to allocate
163 @param Buffer The address to return a pointer to the allocated
166 @retval EFI_INVALID_PARAMETER PoolType not valid
167 @retval EFI_OUT_OF_RESOURCES Size exceeds max pool size or allocation failed.
168 @retval EFI_SUCCESS Pool successfully allocated.
174 IN EFI_MEMORY_TYPE PoolType
,
182 // If it's not a valid type, fail it
184 if ((PoolType
>= EfiMaxMemoryType
&& PoolType
<= 0x7fffffff) ||
185 PoolType
== EfiConventionalMemory
) {
186 return EFI_INVALID_PARAMETER
;
192 // If size is too large, fail it
193 // Base on the EFI spec, return status of EFI_OUT_OF_RESOURCES
195 if (Size
> MAX_POOL_SIZE
) {
196 return EFI_OUT_OF_RESOURCES
;
200 // Acquire the memory lock and make the allocation
202 Status
= CoreAcquireLockOrFail (&gMemoryLock
);
203 if (EFI_ERROR (Status
)) {
204 return EFI_OUT_OF_RESOURCES
;
207 *Buffer
= CoreAllocatePoolI (PoolType
, Size
);
208 CoreReleaseMemoryLock ();
209 return (*Buffer
!= NULL
) ? EFI_SUCCESS
: EFI_OUT_OF_RESOURCES
;
215 Internal function to allocate pool of a particular type.
216 Caller must have the memory lock held
218 @param PoolType Type of pool to allocate
219 @param Size The amount of pool to allocate
221 @return The allocate pool, or NULL
226 IN EFI_MEMORY_TYPE PoolType
,
242 ASSERT_LOCKED (&gMemoryLock
);
245 // Adjust the size by the pool header & tail overhead
249 // Adjusting the Size to be of proper alignment so that
250 // we don't get an unaligned access fault later when
251 // pool_Tail is being initialized
253 ALIGN_VARIABLE (Size
, Adjustment
);
255 Size
+= POOL_OVERHEAD
;
256 Index
= SIZE_TO_LIST(Size
);
257 Pool
= LookupPoolHead (PoolType
);
264 // If allocation is over max size, just allocate pages for the request
267 if (Index
>= MAX_POOL_LIST
) {
268 NoPages
= EFI_SIZE_TO_PAGES(Size
) + EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
) - 1;
269 NoPages
&= ~(EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
) - 1);
270 Head
= CoreAllocatePoolPages (PoolType
, NoPages
, DEFAULT_PAGE_ALLOCATION
);
275 // If there's no free pool in the proper list size, go get some more pages
277 if (IsListEmpty (&Pool
->FreeList
[Index
])) {
282 NewPage
= CoreAllocatePoolPages(PoolType
, EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
), DEFAULT_PAGE_ALLOCATION
);
283 if (NewPage
== NULL
) {
288 // Carve up new page into free pool blocks
291 while (Offset
< DEFAULT_PAGE_ALLOCATION
) {
292 ASSERT (Index
< MAX_POOL_LIST
);
293 FSize
= LIST_TO_SIZE(Index
);
295 while (Offset
+ FSize
<= DEFAULT_PAGE_ALLOCATION
) {
296 Free
= (POOL_FREE
*) &NewPage
[Offset
];
297 Free
->Signature
= POOL_FREE_SIGNATURE
;
298 Free
->Index
= (UINT32
)Index
;
299 InsertHeadList (&Pool
->FreeList
[Index
], &Free
->Link
);
306 ASSERT (Offset
== DEFAULT_PAGE_ALLOCATION
);
307 Index
= SIZE_TO_LIST(Size
);
311 // Remove entry from free pool list
313 Free
= CR (Pool
->FreeList
[Index
].ForwardLink
, POOL_FREE
, Link
, POOL_FREE_SIGNATURE
);
314 RemoveEntryList (&Free
->Link
);
316 Head
= (POOL_HEAD
*) Free
;
324 // If we have a pool buffer, fill in the header & tail info
326 Head
->Signature
= POOL_HEAD_SIGNATURE
;
327 Head
->Size
= (UINT32
) Size
;
328 Head
->Type
= (EFI_MEMORY_TYPE
) PoolType
;
329 Tail
= HEAD_TO_TAIL (Head
);
330 Tail
->Signature
= POOL_TAIL_SIGNATURE
;
331 Tail
->Size
= (UINT32
) Size
;
333 DEBUG_CLEAR_MEMORY (Buffer
, Size
- POOL_OVERHEAD
);
337 "AllocatePoolI: Type %x, Addr %x (len %x) %,d\n", PoolType
,
339 Size
- POOL_OVERHEAD
,
344 // Account the allocation
349 DEBUG ((DEBUG_ERROR
| DEBUG_POOL
, "AllocatePool: failed to allocate %d bytes\n", Size
));
360 @param Buffer The allocated pool entry to free
362 @retval EFI_INVALID_PARAMETER Buffer is not a valid value.
363 @retval EFI_SUCCESS Pool successfully freed.
374 if (Buffer
== NULL
) {
375 return EFI_INVALID_PARAMETER
;
378 CoreAcquireMemoryLock ();
379 Status
= CoreFreePoolI (Buffer
);
380 CoreReleaseMemoryLock ();
387 Internal function to free a pool entry.
388 Caller must have the memory lock held
390 @param Buffer The allocated pool entry to free
392 @retval EFI_INVALID_PARAMETER Buffer not valid
393 @retval EFI_SUCCESS Buffer successfully freed.
413 ASSERT(NULL
!= Buffer
);
415 // Get the head & tail of the pool entry
417 Head
= CR (Buffer
, POOL_HEAD
, Data
, POOL_HEAD_SIGNATURE
);
418 ASSERT(NULL
!= Head
);
420 if (Head
->Signature
!= POOL_HEAD_SIGNATURE
) {
421 return EFI_INVALID_PARAMETER
;
424 Tail
= HEAD_TO_TAIL (Head
);
425 ASSERT(NULL
!= Tail
);
430 ASSERT (Tail
->Signature
== POOL_TAIL_SIGNATURE
);
431 ASSERT (Head
->Size
== Tail
->Size
);
432 ASSERT_LOCKED (&gMemoryLock
);
434 if (Tail
->Signature
!= POOL_TAIL_SIGNATURE
) {
435 return EFI_INVALID_PARAMETER
;
438 if (Head
->Size
!= Tail
->Size
) {
439 return EFI_INVALID_PARAMETER
;
443 // Determine the pool type and account for it
446 Pool
= LookupPoolHead (Head
->Type
);
448 return EFI_INVALID_PARAMETER
;
451 DEBUG ((DEBUG_POOL
, "FreePool: %x (len %x) %,d\n", Head
->Data
, Head
->Size
- POOL_OVERHEAD
, Pool
->Used
));
454 // Determine the pool list
456 Index
= SIZE_TO_LIST(Size
);
457 DEBUG_CLEAR_MEMORY (Head
, Size
);
460 // If it's not on the list, it must be pool pages
462 if (Index
>= MAX_POOL_LIST
) {
465 // Return the memory pages back to free memory
467 NoPages
= EFI_SIZE_TO_PAGES(Size
) + EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
) - 1;
468 NoPages
&= ~(EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
) - 1);
469 CoreFreePoolPages ((EFI_PHYSICAL_ADDRESS
) (UINTN
) Head
, NoPages
);
474 // Put the pool entry onto the free pool list
476 Free
= (POOL_FREE
*) Head
;
477 ASSERT(NULL
!= Free
);
478 Free
->Signature
= POOL_FREE_SIGNATURE
;
479 Free
->Index
= (UINT32
)Index
;
480 InsertHeadList (&Pool
->FreeList
[Index
], &Free
->Link
);
483 // See if all the pool entries in the same page as Free are freed pool
486 NewPage
= (CHAR8
*)((UINTN
)Free
& ~((DEFAULT_PAGE_ALLOCATION
) -1));
487 Free
= (POOL_FREE
*) &NewPage
[0];
488 ASSERT(Free
!= NULL
);
490 if (Free
->Signature
== POOL_FREE_SIGNATURE
) {
497 while ((Offset
< DEFAULT_PAGE_ALLOCATION
) && (AllFree
)) {
498 FSize
= LIST_TO_SIZE(Index
);
499 while (Offset
+ FSize
<= DEFAULT_PAGE_ALLOCATION
) {
500 Free
= (POOL_FREE
*) &NewPage
[Offset
];
501 ASSERT(NULL
!= Free
);
502 if (Free
->Signature
!= POOL_FREE_SIGNATURE
) {
513 // All of the pool entries in the same page as Free are free pool
515 // Remove all of these pool entries from the free loop lists.
517 Free
= (POOL_FREE
*) &NewPage
[0];
518 ASSERT(NULL
!= Free
);
522 while (Offset
< DEFAULT_PAGE_ALLOCATION
) {
523 FSize
= LIST_TO_SIZE(Index
);
524 while (Offset
+ FSize
<= DEFAULT_PAGE_ALLOCATION
) {
525 Free
= (POOL_FREE
*) &NewPage
[Offset
];
526 ASSERT(NULL
!= Free
);
527 RemoveEntryList (&Free
->Link
);
536 CoreFreePoolPages ((EFI_PHYSICAL_ADDRESS
) (UINTN
)NewPage
, EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
));
542 // If this is an OS specific memory type, then check to see if the last
543 // portion of that memory type has been freed. If it has, then free the
544 // list entry for that memory type
546 if (Pool
->MemoryType
< 0 && Pool
->Used
== 0) {
547 RemoveEntryList (&Pool
->Link
);
548 CoreFreePoolI (Pool
);