3 UEFI Memory pool management functions.
5 Copyright (c) 2006 - 2008, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #define POOL_FREE_SIGNATURE EFI_SIGNATURE_32('p','f','r','0')
26 #define POOL_HEAD_SIGNATURE EFI_SIGNATURE_32('p','h','d','0')
35 #define SIZE_OF_POOL_HEAD EFI_FIELD_OFFSET(POOL_HEAD,Data)
37 #define POOL_TAIL_SIGNATURE EFI_SIGNATURE_32('p','t','a','l')
46 #define POOL_OVERHEAD (SIZE_OF_POOL_HEAD + sizeof(POOL_TAIL))
48 #define HEAD_TO_TAIL(a) \
49 ((POOL_TAIL *) (((CHAR8 *) (a)) + (a)->Size - sizeof(POOL_TAIL)));
52 #define SIZE_TO_LIST(a) ((a) >> POOL_SHIFT)
53 #define LIST_TO_SIZE(a) ((a+1) << POOL_SHIFT)
55 #define MAX_POOL_LIST SIZE_TO_LIST(DEFAULT_PAGE_ALLOCATION)
57 #define MAX_POOL_SIZE (MAX_ADDRESS - POOL_OVERHEAD)
63 #define POOL_SIGNATURE EFI_SIGNATURE_32('p','l','s','t')
67 EFI_MEMORY_TYPE MemoryType
;
68 LIST_ENTRY FreeList
[MAX_POOL_LIST
];
73 POOL PoolHead
[EfiMaxMemoryType
];
74 LIST_ENTRY PoolHeadList
;
82 Called to initialize the pool.
93 for (Type
=0; Type
< EfiMaxMemoryType
; Type
++) {
94 PoolHead
[Type
].Signature
= 0;
95 PoolHead
[Type
].Used
= 0;
96 PoolHead
[Type
].MemoryType
= (EFI_MEMORY_TYPE
) Type
;
97 for (Index
=0; Index
< MAX_POOL_LIST
; Index
++) {
98 InitializeListHead (&PoolHead
[Type
].FreeList
[Index
]);
101 InitializeListHead (&PoolHeadList
);
106 Look up pool head for specified memory type.
108 @param MemoryType Memory type of which pool head is looked for
110 @return Pointer of Corresponding pool head.
116 IN EFI_MEMORY_TYPE MemoryType
123 if (MemoryType
>= 0 && MemoryType
< EfiMaxMemoryType
) {
124 return &PoolHead
[MemoryType
];
127 if (MemoryType
< 0) {
129 for (Link
= PoolHeadList
.ForwardLink
; Link
!= &PoolHeadList
; 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 (&PoolHeadList
, &Pool
->Link
);
160 Allocate pool of a particular type.
162 @param PoolType Type of pool to allocate
163 @param Size The amount of pool to allocate
164 @param Buffer The address to return a pointer to the allocated
167 @retval EFI_INVALID_PARAMETER PoolType not valid
168 @retval EFI_OUT_OF_RESOURCES Size exceeds max pool size or allocation failed.
169 @retval EFI_SUCCESS Pool successfully allocated.
175 IN EFI_MEMORY_TYPE PoolType
,
183 // If it's not a valid type, fail it
185 if ((PoolType
>= EfiMaxMemoryType
&& PoolType
<= 0x7fffffff) ||
186 PoolType
== EfiConventionalMemory
) {
187 return EFI_INVALID_PARAMETER
;
193 // If size is too large, fail it
194 // Base on the EFI spec, return status of EFI_OUT_OF_RESOURCES
196 if (Size
> MAX_POOL_SIZE
) {
197 return EFI_OUT_OF_RESOURCES
;
201 // Acquire the memory lock and make the allocation
203 Status
= CoreAcquireLockOrFail (&gMemoryLock
);
204 if (EFI_ERROR (Status
)) {
205 return EFI_OUT_OF_RESOURCES
;
208 *Buffer
= CoreAllocatePoolI (PoolType
, Size
);
209 CoreReleaseMemoryLock ();
210 return (*Buffer
!= NULL
) ? EFI_SUCCESS
: EFI_OUT_OF_RESOURCES
;
216 Internal function to allocate pool of a particular type.
217 Caller must have the memory lock held
219 @param PoolType Type of pool to allocate
220 @param Size The amount of pool to allocate
222 @return The allocate pool, or NULL
227 IN EFI_MEMORY_TYPE PoolType
,
243 ASSERT_LOCKED (&gMemoryLock
);
246 // Adjust the size by the pool header & tail overhead
250 // Adjusting the Size to be of proper alignment so that
251 // we don't get an unaligned access fault later when
252 // pool_Tail is being initialized
254 ALIGN_VARIABLE (Size
, Adjustment
);
256 Size
+= POOL_OVERHEAD
;
257 Index
= SIZE_TO_LIST(Size
);
258 Pool
= LookupPoolHead (PoolType
);
265 // If allocation is over max size, just allocate pages for the request
268 if (Index
>= MAX_POOL_LIST
) {
269 NoPages
= EFI_SIZE_TO_PAGES(Size
) + EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
) - 1;
270 NoPages
&= ~(EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
) - 1);
271 Head
= CoreAllocatePoolPages (PoolType
, NoPages
, DEFAULT_PAGE_ALLOCATION
);
276 // If there's no free pool in the proper list size, go get some more pages
278 if (IsListEmpty (&Pool
->FreeList
[Index
])) {
283 NewPage
= CoreAllocatePoolPages(PoolType
, EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
), DEFAULT_PAGE_ALLOCATION
);
284 if (NewPage
== NULL
) {
289 // Carve up new page into free pool blocks
292 while (Offset
< DEFAULT_PAGE_ALLOCATION
) {
293 ASSERT (Index
< MAX_POOL_LIST
);
294 FSize
= LIST_TO_SIZE(Index
);
296 while (Offset
+ FSize
<= DEFAULT_PAGE_ALLOCATION
) {
297 Free
= (POOL_FREE
*) &NewPage
[Offset
];
298 Free
->Signature
= POOL_FREE_SIGNATURE
;
299 Free
->Index
= (UINT32
)Index
;
300 InsertHeadList (&Pool
->FreeList
[Index
], &Free
->Link
);
307 ASSERT (Offset
== DEFAULT_PAGE_ALLOCATION
);
308 Index
= SIZE_TO_LIST(Size
);
312 // Remove entry from free pool list
314 Free
= CR (Pool
->FreeList
[Index
].ForwardLink
, POOL_FREE
, Link
, POOL_FREE_SIGNATURE
);
315 RemoveEntryList (&Free
->Link
);
317 Head
= (POOL_HEAD
*) Free
;
325 // If we have a pool buffer, fill in the header & tail info
327 Head
->Signature
= POOL_HEAD_SIGNATURE
;
328 Head
->Size
= (UINT32
) Size
;
329 Head
->Type
= (EFI_MEMORY_TYPE
) PoolType
;
330 Tail
= HEAD_TO_TAIL (Head
);
331 Tail
->Signature
= POOL_TAIL_SIGNATURE
;
332 Tail
->Size
= (UINT32
) Size
;
334 DEBUG_CLEAR_MEMORY (Buffer
, Size
- POOL_OVERHEAD
);
338 "AllocatePoolI: Type %x, Addr %x (len %x) %,d\n",
341 Size
- POOL_OVERHEAD
,
346 // Account the allocation
351 DEBUG ((DEBUG_ERROR
| DEBUG_POOL
, "AllocatePool: failed to allocate %d bytes\n", Size
));
363 @param Buffer The allocated pool entry to free
365 @retval EFI_INVALID_PARAMETER Buffer is not a valid value.
366 @retval EFI_SUCCESS Pool successfully freed.
377 if (NULL
== Buffer
) {
378 return EFI_INVALID_PARAMETER
;
381 CoreAcquireMemoryLock ();
382 Status
= CoreFreePoolI (Buffer
);
383 CoreReleaseMemoryLock ();
390 Internal function to free a pool entry.
391 Caller must have the memory lock held
393 @param Buffer The allocated pool entry to free
395 @retval EFI_INVALID_PARAMETER Buffer not valid
396 @retval EFI_SUCCESS Buffer successfully freed.
416 ASSERT(NULL
!= Buffer
);
418 // Get the head & tail of the pool entry
420 Head
= CR (Buffer
, POOL_HEAD
, Data
, POOL_HEAD_SIGNATURE
);
421 ASSERT(NULL
!= Head
);
423 if (Head
->Signature
!= POOL_HEAD_SIGNATURE
) {
424 return EFI_INVALID_PARAMETER
;
427 Tail
= HEAD_TO_TAIL (Head
);
428 ASSERT(NULL
!= Tail
);
433 ASSERT (Tail
->Signature
== POOL_TAIL_SIGNATURE
);
434 ASSERT (Head
->Size
== Tail
->Size
);
435 ASSERT_LOCKED (&gMemoryLock
);
437 if (Tail
->Signature
!= POOL_TAIL_SIGNATURE
) {
438 return EFI_INVALID_PARAMETER
;
441 if (Head
->Size
!= Tail
->Size
) {
442 return EFI_INVALID_PARAMETER
;
446 // Determine the pool type and account for it
449 Pool
= LookupPoolHead (Head
->Type
);
451 return EFI_INVALID_PARAMETER
;
454 DEBUG ((DEBUG_POOL
, "FreePool: %x (len %x) %,d\n", Head
->Data
, Head
->Size
- POOL_OVERHEAD
, Pool
->Used
));
457 // Determine the pool list
459 Index
= SIZE_TO_LIST(Size
);
460 DEBUG_CLEAR_MEMORY (Head
, Size
);
463 // If it's not on the list, it must be pool pages
465 if (Index
>= MAX_POOL_LIST
) {
468 // Return the memory pages back to free memory
470 NoPages
= EFI_SIZE_TO_PAGES(Size
) + EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
) - 1;
471 NoPages
&= ~(EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
) - 1);
472 CoreFreePoolPages ((EFI_PHYSICAL_ADDRESS
) (UINTN
) Head
, NoPages
);
477 // Put the pool entry onto the free pool list
479 Free
= (POOL_FREE
*) Head
;
480 ASSERT(NULL
!= Free
);
481 Free
->Signature
= POOL_FREE_SIGNATURE
;
482 Free
->Index
= (UINT32
)Index
;
483 InsertHeadList (&Pool
->FreeList
[Index
], &Free
->Link
);
486 // See if all the pool entries in the same page as Free are freed pool
489 NewPage
= (CHAR8
*)((UINTN
)Free
& ~((DEFAULT_PAGE_ALLOCATION
) -1));
490 Free
= (POOL_FREE
*) &NewPage
[0];
491 ASSERT(NULL
!= Free
);
493 if (Free
->Signature
== POOL_FREE_SIGNATURE
) {
500 while ((Offset
< DEFAULT_PAGE_ALLOCATION
) && (AllFree
)) {
501 FSize
= LIST_TO_SIZE(Index
);
502 while (Offset
+ FSize
<= DEFAULT_PAGE_ALLOCATION
) {
503 Free
= (POOL_FREE
*) &NewPage
[Offset
];
504 ASSERT(NULL
!= Free
);
505 if (Free
->Signature
!= POOL_FREE_SIGNATURE
) {
516 // All of the pool entries in the same page as Free are free pool
518 // Remove all of these pool entries from the free loop lists.
520 Free
= (POOL_FREE
*) &NewPage
[0];
521 ASSERT(NULL
!= Free
);
525 while (Offset
< DEFAULT_PAGE_ALLOCATION
) {
526 FSize
= LIST_TO_SIZE(Index
);
527 while (Offset
+ FSize
<= DEFAULT_PAGE_ALLOCATION
) {
528 Free
= (POOL_FREE
*) &NewPage
[Offset
];
529 ASSERT(NULL
!= Free
);
530 RemoveEntryList (&Free
->Link
);
539 CoreFreePoolPages ((EFI_PHYSICAL_ADDRESS
) (UINTN
)NewPage
, EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION
));
545 // If this is an OS specific memory type, then check to see if the last
546 // portion of that memory type has been freed. If it has, then free the
547 // list entry for that memory type
549 if (Pool
->MemoryType
< 0 && Pool
->Used
== 0) {
550 RemoveEntryList (&Pool
->Link
);
551 CoreFreePoolI (Pool
);