2 UEFI Heap Guard functions.
4 Copyright (c) 2017-2018, Intel Corporation. All rights reserved.<BR>
5 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 #include "HeapGuard.h"
20 // Global to avoid infinite reentrance of memory allocation when updating
21 // page table attributes, which may need allocate pages for new PDE/PTE.
23 GLOBAL_REMOVE_IF_UNREFERENCED BOOLEAN mOnGuarding
= FALSE
;
26 // Pointer to table tracking the Guarded memory with bitmap, in which '1'
27 // is used to indicate memory guarded. '0' might be free memory or Guard
28 // page itself, depending on status of memory adjacent to it.
30 GLOBAL_REMOVE_IF_UNREFERENCED UINT64 mGuardedMemoryMap
= 0;
33 // Current depth level of map table pointed by mGuardedMemoryMap.
34 // mMapLevel must be initialized at least by 1. It will be automatically
35 // updated according to the address of memory just tracked.
37 GLOBAL_REMOVE_IF_UNREFERENCED UINTN mMapLevel
= 1;
40 // Shift and mask for each level of map table
42 GLOBAL_REMOVE_IF_UNREFERENCED UINTN mLevelShift
[GUARDED_HEAP_MAP_TABLE_DEPTH
]
43 = GUARDED_HEAP_MAP_TABLE_DEPTH_SHIFTS
;
44 GLOBAL_REMOVE_IF_UNREFERENCED UINTN mLevelMask
[GUARDED_HEAP_MAP_TABLE_DEPTH
]
45 = GUARDED_HEAP_MAP_TABLE_DEPTH_MASKS
;
48 Set corresponding bits in bitmap table to 1 according to the address.
50 @param[in] Address Start address to set for.
51 @param[in] BitNumber Number of bits to set.
52 @param[in] BitMap Pointer to bitmap which covers the Address.
59 IN EFI_PHYSICAL_ADDRESS Address
,
70 StartBit
= (UINTN
)GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address
);
71 EndBit
= (StartBit
+ BitNumber
- 1) % GUARDED_HEAP_MAP_ENTRY_BITS
;
73 if ((StartBit
+ BitNumber
) >= GUARDED_HEAP_MAP_ENTRY_BITS
) {
74 Msbs
= (GUARDED_HEAP_MAP_ENTRY_BITS
- StartBit
) %
75 GUARDED_HEAP_MAP_ENTRY_BITS
;
76 Lsbs
= (EndBit
+ 1) % GUARDED_HEAP_MAP_ENTRY_BITS
;
77 Qwords
= (BitNumber
- Msbs
) / GUARDED_HEAP_MAP_ENTRY_BITS
;
85 *BitMap
|= LShiftU64 (LShiftU64 (1, Msbs
) - 1, StartBit
);
90 SetMem64 ((VOID
*)BitMap
, Qwords
* GUARDED_HEAP_MAP_ENTRY_BYTES
,
96 *BitMap
|= (LShiftU64 (1, Lsbs
) - 1);
101 Set corresponding bits in bitmap table to 0 according to the address.
103 @param[in] Address Start address to set for.
104 @param[in] BitNumber Number of bits to set.
105 @param[in] BitMap Pointer to bitmap which covers the Address.
112 IN EFI_PHYSICAL_ADDRESS Address
,
123 StartBit
= (UINTN
)GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address
);
124 EndBit
= (StartBit
+ BitNumber
- 1) % GUARDED_HEAP_MAP_ENTRY_BITS
;
126 if ((StartBit
+ BitNumber
) >= GUARDED_HEAP_MAP_ENTRY_BITS
) {
127 Msbs
= (GUARDED_HEAP_MAP_ENTRY_BITS
- StartBit
) %
128 GUARDED_HEAP_MAP_ENTRY_BITS
;
129 Lsbs
= (EndBit
+ 1) % GUARDED_HEAP_MAP_ENTRY_BITS
;
130 Qwords
= (BitNumber
- Msbs
) / GUARDED_HEAP_MAP_ENTRY_BITS
;
138 *BitMap
&= ~LShiftU64 (LShiftU64 (1, Msbs
) - 1, StartBit
);
143 SetMem64 ((VOID
*)BitMap
, Qwords
* GUARDED_HEAP_MAP_ENTRY_BYTES
, 0);
148 *BitMap
&= ~(LShiftU64 (1, Lsbs
) - 1);
153 Get corresponding bits in bitmap table according to the address.
155 The value of bit 0 corresponds to the status of memory at given Address.
156 No more than 64 bits can be retrieved in one call.
158 @param[in] Address Start address to retrieve bits for.
159 @param[in] BitNumber Number of bits to get.
160 @param[in] BitMap Pointer to bitmap which covers the Address.
162 @return An integer containing the bits information.
167 IN EFI_PHYSICAL_ADDRESS Address
,
178 ASSERT (BitNumber
<= GUARDED_HEAP_MAP_ENTRY_BITS
);
180 StartBit
= (UINTN
)GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address
);
181 EndBit
= (StartBit
+ BitNumber
- 1) % GUARDED_HEAP_MAP_ENTRY_BITS
;
183 if ((StartBit
+ BitNumber
) > GUARDED_HEAP_MAP_ENTRY_BITS
) {
184 Msbs
= GUARDED_HEAP_MAP_ENTRY_BITS
- StartBit
;
185 Lsbs
= (EndBit
+ 1) % GUARDED_HEAP_MAP_ENTRY_BITS
;
191 if (StartBit
== 0 && BitNumber
== GUARDED_HEAP_MAP_ENTRY_BITS
) {
194 Result
= RShiftU64((*BitMap
), StartBit
) & (LShiftU64(1, Msbs
) - 1);
197 Result
|= LShiftU64 ((*BitMap
) & (LShiftU64 (1, Lsbs
) - 1), Msbs
);
205 Locate the pointer of bitmap from the guarded memory bitmap tables, which
206 covers the given Address.
208 @param[in] Address Start address to search the bitmap for.
209 @param[in] AllocMapUnit Flag to indicate memory allocation for the table.
210 @param[out] BitMap Pointer to bitmap which covers the Address.
212 @return The bit number from given Address to the end of current map table.
215 FindGuardedMemoryMap (
216 IN EFI_PHYSICAL_ADDRESS Address
,
217 IN BOOLEAN AllocMapUnit
,
230 // Adjust current map table depth according to the address to access
232 while (AllocMapUnit
&&
233 mMapLevel
< GUARDED_HEAP_MAP_TABLE_DEPTH
&&
236 mLevelShift
[GUARDED_HEAP_MAP_TABLE_DEPTH
- mMapLevel
- 1]
239 if (mGuardedMemoryMap
!= 0) {
240 Size
= (mLevelMask
[GUARDED_HEAP_MAP_TABLE_DEPTH
- mMapLevel
- 1] + 1)
241 * GUARDED_HEAP_MAP_ENTRY_BYTES
;
242 Status
= CoreInternalAllocatePages (
245 EFI_SIZE_TO_PAGES (Size
),
249 ASSERT_EFI_ERROR (Status
);
250 ASSERT (MapMemory
!= 0);
252 SetMem ((VOID
*)(UINTN
)MapMemory
, Size
, 0);
254 *(UINT64
*)(UINTN
)MapMemory
= mGuardedMemoryMap
;
255 mGuardedMemoryMap
= MapMemory
;
262 GuardMap
= &mGuardedMemoryMap
;
263 for (Level
= GUARDED_HEAP_MAP_TABLE_DEPTH
- mMapLevel
;
264 Level
< GUARDED_HEAP_MAP_TABLE_DEPTH
;
267 if (*GuardMap
== 0) {
273 Size
= (mLevelMask
[Level
] + 1) * GUARDED_HEAP_MAP_ENTRY_BYTES
;
274 Status
= CoreInternalAllocatePages (
277 EFI_SIZE_TO_PAGES (Size
),
281 ASSERT_EFI_ERROR (Status
);
282 ASSERT (MapMemory
!= 0);
284 SetMem ((VOID
*)(UINTN
)MapMemory
, Size
, 0);
285 *GuardMap
= MapMemory
;
288 Index
= (UINTN
)RShiftU64 (Address
, mLevelShift
[Level
]);
289 Index
&= mLevelMask
[Level
];
290 GuardMap
= (UINT64
*)(UINTN
)((*GuardMap
) + Index
* sizeof (UINT64
));
294 BitsToUnitEnd
= GUARDED_HEAP_MAP_BITS
- GUARDED_HEAP_MAP_BIT_INDEX (Address
);
297 return BitsToUnitEnd
;
301 Set corresponding bits in bitmap table to 1 according to given memory range.
303 @param[in] Address Memory address to guard from.
304 @param[in] NumberOfPages Number of pages to guard.
310 SetGuardedMemoryBits (
311 IN EFI_PHYSICAL_ADDRESS Address
,
312 IN UINTN NumberOfPages
319 while (NumberOfPages
> 0) {
320 BitsToUnitEnd
= FindGuardedMemoryMap (Address
, TRUE
, &BitMap
);
321 ASSERT (BitMap
!= NULL
);
323 if (NumberOfPages
> BitsToUnitEnd
) {
325 Bits
= BitsToUnitEnd
;
327 Bits
= NumberOfPages
;
330 SetBits (Address
, Bits
, BitMap
);
332 NumberOfPages
-= Bits
;
333 Address
+= EFI_PAGES_TO_SIZE (Bits
);
338 Clear corresponding bits in bitmap table according to given memory range.
340 @param[in] Address Memory address to unset from.
341 @param[in] NumberOfPages Number of pages to unset guard.
347 ClearGuardedMemoryBits (
348 IN EFI_PHYSICAL_ADDRESS Address
,
349 IN UINTN NumberOfPages
356 while (NumberOfPages
> 0) {
357 BitsToUnitEnd
= FindGuardedMemoryMap (Address
, TRUE
, &BitMap
);
358 ASSERT (BitMap
!= NULL
);
360 if (NumberOfPages
> BitsToUnitEnd
) {
362 Bits
= BitsToUnitEnd
;
364 Bits
= NumberOfPages
;
367 ClearBits (Address
, Bits
, BitMap
);
369 NumberOfPages
-= Bits
;
370 Address
+= EFI_PAGES_TO_SIZE (Bits
);
375 Retrieve corresponding bits in bitmap table according to given memory range.
377 @param[in] Address Memory address to retrieve from.
378 @param[in] NumberOfPages Number of pages to retrieve.
380 @return An integer containing the guarded memory bitmap.
383 GetGuardedMemoryBits (
384 IN EFI_PHYSICAL_ADDRESS Address
,
385 IN UINTN NumberOfPages
394 ASSERT (NumberOfPages
<= GUARDED_HEAP_MAP_ENTRY_BITS
);
398 while (NumberOfPages
> 0) {
399 BitsToUnitEnd
= FindGuardedMemoryMap (Address
, FALSE
, &BitMap
);
401 if (NumberOfPages
> BitsToUnitEnd
) {
403 Bits
= BitsToUnitEnd
;
405 Bits
= NumberOfPages
;
408 if (BitMap
!= NULL
) {
409 Result
|= LShiftU64 (GetBits (Address
, Bits
, BitMap
), Shift
);
413 NumberOfPages
-= Bits
;
414 Address
+= EFI_PAGES_TO_SIZE (Bits
);
421 Get bit value in bitmap table for the given address.
423 @param[in] Address The address to retrieve for.
430 IN EFI_PHYSICAL_ADDRESS Address
435 FindGuardedMemoryMap (Address
, FALSE
, &GuardMap
);
436 if (GuardMap
!= NULL
) {
437 if (RShiftU64 (*GuardMap
,
438 GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address
)) & 1) {
447 Set the bit in bitmap table for the given address.
449 @param[in] Address The address to set for.
456 IN EFI_PHYSICAL_ADDRESS Address
462 FindGuardedMemoryMap (Address
, TRUE
, &GuardMap
);
463 if (GuardMap
!= NULL
) {
464 BitMask
= LShiftU64 (1, GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address
));
465 *GuardMap
|= BitMask
;
470 Clear the bit in bitmap table for the given address.
472 @param[in] Address The address to clear for.
479 IN EFI_PHYSICAL_ADDRESS Address
485 FindGuardedMemoryMap (Address
, TRUE
, &GuardMap
);
486 if (GuardMap
!= NULL
) {
487 BitMask
= LShiftU64 (1, GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address
));
488 *GuardMap
&= ~BitMask
;
493 Check to see if the page at the given address is a Guard page or not.
495 @param[in] Address The address to check for.
497 @return TRUE The page at Address is a Guard page.
498 @return FALSE The page at Address is not a Guard page.
503 IN EFI_PHYSICAL_ADDRESS Address
509 // There must be at least one guarded page before and/or after given
510 // address if it's a Guard page. The bitmap pattern should be one of
513 BitMap
= GetGuardedMemoryBits (Address
- EFI_PAGE_SIZE
, 3);
514 return ((BitMap
== BIT0
) || (BitMap
== BIT2
) || (BitMap
== (BIT2
| BIT0
)));
518 Check to see if the page at the given address is a head Guard page or not.
520 @param[in] Address The address to check for
522 @return TRUE The page at Address is a head Guard page
523 @return FALSE The page at Address is not a head Guard page
528 IN EFI_PHYSICAL_ADDRESS Address
531 return (GetGuardedMemoryBits (Address
, 2) == BIT1
);
535 Check to see if the page at the given address is a tail Guard page or not.
537 @param[in] Address The address to check for.
539 @return TRUE The page at Address is a tail Guard page.
540 @return FALSE The page at Address is not a tail Guard page.
545 IN EFI_PHYSICAL_ADDRESS Address
548 return (GetGuardedMemoryBits (Address
- EFI_PAGE_SIZE
, 2) == BIT0
);
552 Check to see if the page at the given address is guarded or not.
554 @param[in] Address The address to check for.
556 @return TRUE The page at Address is guarded.
557 @return FALSE The page at Address is not guarded.
562 IN EFI_PHYSICAL_ADDRESS Address
565 return (GetGuardMapBit (Address
) == 1);
569 Set the page at the given address to be a Guard page.
571 This is done by changing the page table attribute to be NOT PRSENT.
573 @param[in] BaseAddress Page address to Guard at
580 IN EFI_PHYSICAL_ADDRESS BaseAddress
590 // Set flag to make sure allocating memory without GUARD for page table
591 // operation; otherwise infinite loops could be caused.
595 // Note: This might overwrite other attributes needed by other features,
596 // such as NX memory protection.
598 Status
= gCpu
->SetMemoryAttributes (gCpu
, BaseAddress
, EFI_PAGE_SIZE
, EFI_MEMORY_RP
);
599 ASSERT_EFI_ERROR (Status
);
604 Unset the Guard page at the given address to the normal memory.
606 This is done by changing the page table attribute to be PRSENT.
608 @param[in] BaseAddress Page address to Guard at.
615 IN EFI_PHYSICAL_ADDRESS BaseAddress
626 // Once the Guard page is unset, it will be freed back to memory pool. NX
627 // memory protection must be restored for this page if NX is enabled for free
631 if ((PcdGet64 (PcdDxeNxMemoryProtectionPolicy
) & (1 << EfiConventionalMemory
)) != 0) {
632 Attributes
|= EFI_MEMORY_XP
;
636 // Set flag to make sure allocating memory without GUARD for page table
637 // operation; otherwise infinite loops could be caused.
641 // Note: This might overwrite other attributes needed by other features,
642 // such as memory protection (NX). Please make sure they are not enabled
645 Status
= gCpu
->SetMemoryAttributes (gCpu
, BaseAddress
, EFI_PAGE_SIZE
, Attributes
);
646 ASSERT_EFI_ERROR (Status
);
651 Check to see if the memory at the given address should be guarded or not.
653 @param[in] MemoryType Memory type to check.
654 @param[in] AllocateType Allocation type to check.
655 @param[in] PageOrPool Indicate a page allocation or pool allocation.
658 @return TRUE The given type of memory should be guarded.
659 @return FALSE The given type of memory should not be guarded.
662 IsMemoryTypeToGuard (
663 IN EFI_MEMORY_TYPE MemoryType
,
664 IN EFI_ALLOCATE_TYPE AllocateType
,
671 if (AllocateType
== AllocateAddress
) {
675 if ((PcdGet8 (PcdHeapGuardPropertyMask
) & PageOrPool
) == 0) {
679 if (PageOrPool
== GUARD_HEAP_TYPE_POOL
) {
680 ConfigBit
= PcdGet64 (PcdHeapGuardPoolType
);
681 } else if (PageOrPool
== GUARD_HEAP_TYPE_PAGE
) {
682 ConfigBit
= PcdGet64 (PcdHeapGuardPageType
);
684 ConfigBit
= (UINT64
)-1;
687 if ((UINT32
)MemoryType
>= MEMORY_TYPE_OS_RESERVED_MIN
) {
689 } else if ((UINT32
) MemoryType
>= MEMORY_TYPE_OEM_RESERVED_MIN
) {
691 } else if (MemoryType
< EfiMaxMemoryType
) {
692 TestBit
= LShiftU64 (1, MemoryType
);
693 } else if (MemoryType
== EfiMaxMemoryType
) {
694 TestBit
= (UINT64
)-1;
699 return ((ConfigBit
& TestBit
) != 0);
703 Check to see if the pool at the given address should be guarded or not.
705 @param[in] MemoryType Pool type to check.
708 @return TRUE The given type of pool should be guarded.
709 @return FALSE The given type of pool should not be guarded.
713 IN EFI_MEMORY_TYPE MemoryType
716 return IsMemoryTypeToGuard (MemoryType
, AllocateAnyPages
,
717 GUARD_HEAP_TYPE_POOL
);
721 Check to see if the page at the given address should be guarded or not.
723 @param[in] MemoryType Page type to check.
724 @param[in] AllocateType Allocation type to check.
726 @return TRUE The given type of page should be guarded.
727 @return FALSE The given type of page should not be guarded.
731 IN EFI_MEMORY_TYPE MemoryType
,
732 IN EFI_ALLOCATE_TYPE AllocateType
735 return IsMemoryTypeToGuard (MemoryType
, AllocateType
, GUARD_HEAP_TYPE_PAGE
);
739 Check to see if the heap guard is enabled for page and/or pool allocation.
748 return IsMemoryTypeToGuard (EfiMaxMemoryType
, AllocateAnyPages
,
749 GUARD_HEAP_TYPE_POOL
|GUARD_HEAP_TYPE_PAGE
);
753 Set head Guard and tail Guard for the given memory range.
755 @param[in] Memory Base address of memory to set guard for.
756 @param[in] NumberOfPages Memory size in pages.
762 IN EFI_PHYSICAL_ADDRESS Memory
,
763 IN UINTN NumberOfPages
766 EFI_PHYSICAL_ADDRESS GuardPage
;
771 GuardPage
= Memory
+ EFI_PAGES_TO_SIZE (NumberOfPages
);
772 if (!IsGuardPage (GuardPage
)) {
773 SetGuardPage (GuardPage
);
777 GuardPage
= Memory
- EFI_PAGES_TO_SIZE (1);
778 if (!IsGuardPage (GuardPage
)) {
779 SetGuardPage (GuardPage
);
783 // Mark the memory range as Guarded
785 SetGuardedMemoryBits (Memory
, NumberOfPages
);
789 Unset head Guard and tail Guard for the given memory range.
791 @param[in] Memory Base address of memory to unset guard for.
792 @param[in] NumberOfPages Memory size in pages.
797 UnsetGuardForMemory (
798 IN EFI_PHYSICAL_ADDRESS Memory
,
799 IN UINTN NumberOfPages
802 EFI_PHYSICAL_ADDRESS GuardPage
;
805 if (NumberOfPages
== 0) {
810 // Head Guard must be one page before, if any.
813 // -------------------
814 // Head Guard -> 0 1 -> Don't free Head Guard (shared Guard)
815 // Head Guard -> 0 0 -> Free Head Guard either (not shared Guard)
816 // 1 X -> Don't free first page (need a new Guard)
817 // (it'll be turned into a Guard page later)
818 // -------------------
821 GuardPage
= Memory
- EFI_PAGES_TO_SIZE (1);
822 GuardBitmap
= GetGuardedMemoryBits (Memory
- EFI_PAGES_TO_SIZE (2), 2);
823 if ((GuardBitmap
& BIT1
) == 0) {
825 // Head Guard exists.
827 if ((GuardBitmap
& BIT0
) == 0) {
829 // If the head Guard is not a tail Guard of adjacent memory block,
832 UnsetGuardPage (GuardPage
);
836 // Pages before memory to free are still in Guard. It's a partial free
837 // case. Turn first page of memory block to free into a new Guard.
839 SetGuardPage (Memory
);
843 // Tail Guard must be the page after this memory block to free, if any.
846 // --------------------
847 // 1 0 <- Tail Guard -> Don't free Tail Guard (shared Guard)
848 // 0 0 <- Tail Guard -> Free Tail Guard either (not shared Guard)
849 // X 1 -> Don't free last page (need a new Guard)
850 // (it'll be turned into a Guard page later)
851 // --------------------
854 GuardPage
= Memory
+ EFI_PAGES_TO_SIZE (NumberOfPages
);
855 GuardBitmap
= GetGuardedMemoryBits (GuardPage
, 2);
856 if ((GuardBitmap
& BIT0
) == 0) {
858 // Tail Guard exists.
860 if ((GuardBitmap
& BIT1
) == 0) {
862 // If the tail Guard is not a head Guard of adjacent memory block,
863 // free it; otherwise, keep it.
865 UnsetGuardPage (GuardPage
);
869 // Pages after memory to free are still in Guard. It's a partial free
870 // case. We need to keep one page to be a head Guard.
872 SetGuardPage (GuardPage
- EFI_PAGES_TO_SIZE (1));
876 // No matter what, we just clear the mark of the Guarded memory.
878 ClearGuardedMemoryBits(Memory
, NumberOfPages
);
882 Adjust address of free memory according to existing and/or required Guard.
884 This function will check if there're existing Guard pages of adjacent
885 memory blocks, and try to use it as the Guard page of the memory to be
888 @param[in] Start Start address of free memory block.
889 @param[in] Size Size of free memory block.
890 @param[in] SizeRequested Size of memory to allocate.
892 @return The end address of memory block found.
893 @return 0 if no enough space for the required size of memory and its Guard.
899 IN UINT64 SizeRequested
905 // UEFI spec requires that allocated pool must be 8-byte aligned. If it's
906 // indicated to put the pool near the Tail Guard, we need extra bytes to
907 // make sure alignment of the returned pool address.
909 if ((PcdGet8 (PcdHeapGuardPropertyMask
) & BIT7
) == 0) {
910 SizeRequested
= ALIGN_VALUE(SizeRequested
, 8);
913 Target
= Start
+ Size
- SizeRequested
;
914 ASSERT (Target
>= Start
);
919 if (!IsGuardPage (Start
+ Size
)) {
920 // No Guard at tail to share. One more page is needed.
921 Target
-= EFI_PAGES_TO_SIZE (1);
925 if (Target
< Start
) {
930 if (Target
== Start
) {
931 if (!IsGuardPage (Target
- EFI_PAGES_TO_SIZE (1))) {
932 // No enough space for a new head Guard if no Guard at head to share.
937 // OK, we have enough pages for memory and its Guards. Return the End of the
939 return Target
+ SizeRequested
- 1;
943 Adjust the start address and number of pages to free according to Guard.
945 The purpose of this function is to keep the shared Guard page with adjacent
946 memory block if it's still in guard, or free it if no more sharing. Another
947 is to reserve pages as Guard pages in partial page free situation.
949 @param[in,out] Memory Base address of memory to free.
950 @param[in,out] NumberOfPages Size of memory to free.
956 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
,
957 IN OUT UINTN
*NumberOfPages
960 EFI_PHYSICAL_ADDRESS Start
;
961 EFI_PHYSICAL_ADDRESS MemoryToTest
;
965 if (Memory
== NULL
|| NumberOfPages
== NULL
|| *NumberOfPages
== 0) {
970 PagesToFree
= *NumberOfPages
;
973 // Head Guard must be one page before, if any.
976 // -------------------
977 // Head Guard -> 0 1 -> Don't free Head Guard (shared Guard)
978 // Head Guard -> 0 0 -> Free Head Guard either (not shared Guard)
979 // 1 X -> Don't free first page (need a new Guard)
980 // (it'll be turned into a Guard page later)
981 // -------------------
984 MemoryToTest
= Start
- EFI_PAGES_TO_SIZE (2);
985 GuardBitmap
= GetGuardedMemoryBits (MemoryToTest
, 2);
986 if ((GuardBitmap
& BIT1
) == 0) {
988 // Head Guard exists.
990 if ((GuardBitmap
& BIT0
) == 0) {
992 // If the head Guard is not a tail Guard of adjacent memory block,
993 // free it; otherwise, keep it.
995 Start
-= EFI_PAGES_TO_SIZE (1);
1000 // No Head Guard, and pages before memory to free are still in Guard. It's a
1001 // partial free case. We need to keep one page to be a tail Guard.
1003 Start
+= EFI_PAGES_TO_SIZE (1);
1008 // Tail Guard must be the page after this memory block to free, if any.
1011 // --------------------
1012 // 1 0 <- Tail Guard -> Don't free Tail Guard (shared Guard)
1013 // 0 0 <- Tail Guard -> Free Tail Guard either (not shared Guard)
1014 // X 1 -> Don't free last page (need a new Guard)
1015 // (it'll be turned into a Guard page later)
1016 // --------------------
1019 MemoryToTest
= Start
+ EFI_PAGES_TO_SIZE (PagesToFree
);
1020 GuardBitmap
= GetGuardedMemoryBits (MemoryToTest
, 2);
1021 if ((GuardBitmap
& BIT0
) == 0) {
1023 // Tail Guard exists.
1025 if ((GuardBitmap
& BIT1
) == 0) {
1027 // If the tail Guard is not a head Guard of adjacent memory block,
1028 // free it; otherwise, keep it.
1032 } else if (PagesToFree
> 0) {
1034 // No Tail Guard, and pages after memory to free are still in Guard. It's a
1035 // partial free case. We need to keep one page to be a head Guard.
1041 *NumberOfPages
= PagesToFree
;
1045 Adjust the base and number of pages to really allocate according to Guard.
1047 @param[in,out] Memory Base address of free memory.
1048 @param[in,out] NumberOfPages Size of memory to allocate.
1054 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
,
1055 IN OUT UINTN
*NumberOfPages
1059 // FindFreePages() has already taken the Guard into account. It's safe to
1060 // adjust the start address and/or number of pages here, to make sure that
1061 // the Guards are also "allocated".
1063 if (!IsGuardPage (*Memory
+ EFI_PAGES_TO_SIZE (*NumberOfPages
))) {
1064 // No tail Guard, add one.
1065 *NumberOfPages
+= 1;
1068 if (!IsGuardPage (*Memory
- EFI_PAGE_SIZE
)) {
1069 // No head Guard, add one.
1070 *Memory
-= EFI_PAGE_SIZE
;
1071 *NumberOfPages
+= 1;
1076 Adjust the pool head position to make sure the Guard page is adjavent to
1077 pool tail or pool head.
1079 @param[in] Memory Base address of memory allocated.
1080 @param[in] NoPages Number of pages actually allocated.
1081 @param[in] Size Size of memory requested.
1082 (plus pool head/tail overhead)
1084 @return Address of pool head.
1088 IN EFI_PHYSICAL_ADDRESS Memory
,
1093 if (Memory
== 0 || (PcdGet8 (PcdHeapGuardPropertyMask
) & BIT7
) != 0) {
1095 // Pool head is put near the head Guard
1097 return (VOID
*)(UINTN
)Memory
;
1101 // Pool head is put near the tail Guard
1103 Size
= ALIGN_VALUE (Size
, 8);
1104 return (VOID
*)(UINTN
)(Memory
+ EFI_PAGES_TO_SIZE (NoPages
) - Size
);
1108 Get the page base address according to pool head address.
1110 @param[in] Memory Head address of pool to free.
1112 @return Address of pool head.
1116 IN EFI_PHYSICAL_ADDRESS Memory
1119 if (Memory
== 0 || (PcdGet8 (PcdHeapGuardPropertyMask
) & BIT7
) != 0) {
1121 // Pool head is put near the head Guard
1123 return (VOID
*)(UINTN
)Memory
;
1127 // Pool head is put near the tail Guard
1129 return (VOID
*)(UINTN
)(Memory
& ~EFI_PAGE_MASK
);
1133 Allocate or free guarded memory.
1135 @param[in] Start Start address of memory to allocate or free.
1136 @param[in] NumberOfPages Memory size in pages.
1137 @param[in] NewType Memory type to convert to.
1142 CoreConvertPagesWithGuard (
1144 IN UINTN NumberOfPages
,
1145 IN EFI_MEMORY_TYPE NewType
1151 if (NewType
== EfiConventionalMemory
) {
1153 OldPages
= NumberOfPages
;
1155 AdjustMemoryF (&Start
, &NumberOfPages
);
1157 // It's safe to unset Guard page inside memory lock because there should
1158 // be no memory allocation occurred in updating memory page attribute at
1159 // this point. And unsetting Guard page before free will prevent Guard
1160 // page just freed back to pool from being allocated right away before
1161 // marking it usable (from non-present to present).
1163 UnsetGuardForMemory (OldStart
, OldPages
);
1164 if (NumberOfPages
== 0) {
1168 AdjustMemoryA (&Start
, &NumberOfPages
);
1171 return CoreConvertPages (Start
, NumberOfPages
, NewType
);
1175 Set all Guard pages which cannot be set before CPU Arch Protocol installed.
1182 UINTN Entries
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1183 UINTN Shifts
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1184 UINTN Indices
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1185 UINT64 Tables
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1186 UINT64 Addresses
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1194 if (mGuardedMemoryMap
== 0 ||
1196 mMapLevel
> GUARDED_HEAP_MAP_TABLE_DEPTH
) {
1200 CopyMem (Entries
, mLevelMask
, sizeof (Entries
));
1201 CopyMem (Shifts
, mLevelShift
, sizeof (Shifts
));
1203 SetMem (Tables
, sizeof(Tables
), 0);
1204 SetMem (Addresses
, sizeof(Addresses
), 0);
1205 SetMem (Indices
, sizeof(Indices
), 0);
1207 Level
= GUARDED_HEAP_MAP_TABLE_DEPTH
- mMapLevel
;
1208 Tables
[Level
] = mGuardedMemoryMap
;
1213 DumpGuardedMemoryBitmap ();
1217 if (Indices
[Level
] > Entries
[Level
]) {
1222 TableEntry
= ((UINT64
*)(UINTN
)(Tables
[Level
]))[Indices
[Level
]];
1223 Address
= Addresses
[Level
];
1225 if (TableEntry
== 0) {
1229 } else if (Level
< GUARDED_HEAP_MAP_TABLE_DEPTH
- 1) {
1232 Tables
[Level
] = TableEntry
;
1233 Addresses
[Level
] = Address
;
1241 while (Index
< GUARDED_HEAP_MAP_ENTRY_BITS
) {
1242 if ((TableEntry
& 1) == 1) {
1246 GuardPage
= Address
- EFI_PAGE_SIZE
;
1251 GuardPage
= Address
;
1258 if (GuardPage
!= 0) {
1259 SetGuardPage (GuardPage
);
1262 if (TableEntry
== 0) {
1266 TableEntry
= RShiftU64 (TableEntry
, 1);
1267 Address
+= EFI_PAGE_SIZE
;
1273 if (Level
< (GUARDED_HEAP_MAP_TABLE_DEPTH
- (INTN
)mMapLevel
)) {
1277 Indices
[Level
] += 1;
1278 Address
= (Level
== 0) ? 0 : Addresses
[Level
- 1];
1279 Addresses
[Level
] = Address
| LShiftU64(Indices
[Level
], Shifts
[Level
]);
1285 Notify function used to set all Guard pages before CPU Arch Protocol installed.
1288 HeapGuardCpuArchProtocolNotify (
1292 ASSERT (gCpu
!= NULL
);
1293 SetAllGuardPages ();
1297 Helper function to convert a UINT64 value in binary to a string.
1299 @param[in] Value Value of a UINT64 integer.
1300 @param[out] BinString String buffer to contain the conversion result.
1307 OUT CHAR8
*BinString
1312 if (BinString
== NULL
) {
1316 for (Index
= 64; Index
> 0; --Index
) {
1317 BinString
[Index
- 1] = '0' + (Value
& 1);
1318 Value
= RShiftU64 (Value
, 1);
1320 BinString
[64] = '\0';
1324 Dump the guarded memory bit map.
1328 DumpGuardedMemoryBitmap (
1332 UINTN Entries
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1333 UINTN Shifts
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1334 UINTN Indices
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1335 UINT64 Tables
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1336 UINT64 Addresses
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1341 CHAR8 String
[GUARDED_HEAP_MAP_ENTRY_BITS
+ 1];
1345 if (mGuardedMemoryMap
== 0 ||
1347 mMapLevel
> GUARDED_HEAP_MAP_TABLE_DEPTH
) {
1351 Ruler1
= " 3 2 1 0";
1352 Ruler2
= "FEDCBA9876543210FEDCBA9876543210FEDCBA9876543210FEDCBA9876543210";
1354 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, "============================="
1355 " Guarded Memory Bitmap "
1356 "==============================\r\n"));
1357 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, " %a\r\n", Ruler1
));
1358 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, " %a\r\n", Ruler2
));
1360 CopyMem (Entries
, mLevelMask
, sizeof (Entries
));
1361 CopyMem (Shifts
, mLevelShift
, sizeof (Shifts
));
1363 SetMem (Indices
, sizeof(Indices
), 0);
1364 SetMem (Tables
, sizeof(Tables
), 0);
1365 SetMem (Addresses
, sizeof(Addresses
), 0);
1367 Level
= GUARDED_HEAP_MAP_TABLE_DEPTH
- mMapLevel
;
1368 Tables
[Level
] = mGuardedMemoryMap
;
1373 if (Indices
[Level
] > Entries
[Level
]) {
1380 HEAP_GUARD_DEBUG_LEVEL
,
1381 "========================================="
1382 "=========================================\r\n"
1387 TableEntry
= ((UINT64
*)(UINTN
)Tables
[Level
])[Indices
[Level
]];
1388 Address
= Addresses
[Level
];
1390 if (TableEntry
== 0) {
1392 if (Level
== GUARDED_HEAP_MAP_TABLE_DEPTH
- 1) {
1393 if (RepeatZero
== 0) {
1394 Uint64ToBinString(TableEntry
, String
);
1395 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, "%016lx: %a\r\n", Address
, String
));
1396 } else if (RepeatZero
== 1) {
1397 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, "... : ...\r\n"));
1402 } else if (Level
< GUARDED_HEAP_MAP_TABLE_DEPTH
- 1) {
1405 Tables
[Level
] = TableEntry
;
1406 Addresses
[Level
] = Address
;
1415 Uint64ToBinString(TableEntry
, String
);
1416 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, "%016lx: %a\r\n", Address
, String
));
1421 if (Level
< (GUARDED_HEAP_MAP_TABLE_DEPTH
- (INTN
)mMapLevel
)) {
1425 Indices
[Level
] += 1;
1426 Address
= (Level
== 0) ? 0 : Addresses
[Level
- 1];
1427 Addresses
[Level
] = Address
| LShiftU64(Indices
[Level
], Shifts
[Level
]);