2 UEFI Heap Guard functions.
4 Copyright (c) 2017, 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 Result
= RShiftU64 ((*BitMap
), StartBit
) & (LShiftU64 (1, Msbs
) - 1);
194 Result
|= LShiftU64 ((*BitMap
) & (LShiftU64 (1, Lsbs
) - 1), Msbs
);
201 Locate the pointer of bitmap from the guarded memory bitmap tables, which
202 covers the given Address.
204 @param[in] Address Start address to search the bitmap for.
205 @param[in] AllocMapUnit Flag to indicate memory allocation for the table.
206 @param[out] BitMap Pointer to bitmap which covers the Address.
208 @return The bit number from given Address to the end of current map table.
211 FindGuardedMemoryMap (
212 IN EFI_PHYSICAL_ADDRESS Address
,
213 IN BOOLEAN AllocMapUnit
,
226 // Adjust current map table depth according to the address to access
228 while (mMapLevel
< GUARDED_HEAP_MAP_TABLE_DEPTH
232 mLevelShift
[GUARDED_HEAP_MAP_TABLE_DEPTH
- mMapLevel
- 1]
235 if (mGuardedMemoryMap
!= 0) {
236 Size
= (mLevelMask
[GUARDED_HEAP_MAP_TABLE_DEPTH
- mMapLevel
- 1] + 1)
237 * GUARDED_HEAP_MAP_ENTRY_BYTES
;
238 Status
= CoreInternalAllocatePages (
241 EFI_SIZE_TO_PAGES (Size
),
245 ASSERT_EFI_ERROR (Status
);
246 ASSERT (MapMemory
!= 0);
248 SetMem ((VOID
*)(UINTN
)MapMemory
, Size
, 0);
250 *(UINT64
*)(UINTN
)MapMemory
= mGuardedMemoryMap
;
251 mGuardedMemoryMap
= MapMemory
;
258 GuardMap
= &mGuardedMemoryMap
;
259 for (Level
= GUARDED_HEAP_MAP_TABLE_DEPTH
- mMapLevel
;
260 Level
< GUARDED_HEAP_MAP_TABLE_DEPTH
;
263 if (*GuardMap
== 0) {
269 Size
= (mLevelMask
[Level
] + 1) * GUARDED_HEAP_MAP_ENTRY_BYTES
;
270 Status
= CoreInternalAllocatePages (
273 EFI_SIZE_TO_PAGES (Size
),
277 ASSERT_EFI_ERROR (Status
);
278 ASSERT (MapMemory
!= 0);
280 SetMem ((VOID
*)(UINTN
)MapMemory
, Size
, 0);
281 *GuardMap
= MapMemory
;
284 Index
= (UINTN
)RShiftU64 (Address
, mLevelShift
[Level
]);
285 Index
&= mLevelMask
[Level
];
286 GuardMap
= (UINT64
*)(UINTN
)((*GuardMap
) + Index
* sizeof (UINT64
));
290 BitsToUnitEnd
= GUARDED_HEAP_MAP_BITS
- GUARDED_HEAP_MAP_BIT_INDEX (Address
);
293 return BitsToUnitEnd
;
297 Set corresponding bits in bitmap table to 1 according to given memory range.
299 @param[in] Address Memory address to guard from.
300 @param[in] NumberOfPages Number of pages to guard.
306 SetGuardedMemoryBits (
307 IN EFI_PHYSICAL_ADDRESS Address
,
308 IN UINTN NumberOfPages
315 while (NumberOfPages
> 0) {
316 BitsToUnitEnd
= FindGuardedMemoryMap (Address
, TRUE
, &BitMap
);
317 ASSERT (BitMap
!= NULL
);
319 if (NumberOfPages
> BitsToUnitEnd
) {
321 Bits
= BitsToUnitEnd
;
323 Bits
= NumberOfPages
;
326 SetBits (Address
, Bits
, BitMap
);
328 NumberOfPages
-= Bits
;
329 Address
+= EFI_PAGES_TO_SIZE (Bits
);
334 Clear corresponding bits in bitmap table according to given memory range.
336 @param[in] Address Memory address to unset from.
337 @param[in] NumberOfPages Number of pages to unset guard.
343 ClearGuardedMemoryBits (
344 IN EFI_PHYSICAL_ADDRESS Address
,
345 IN UINTN NumberOfPages
352 while (NumberOfPages
> 0) {
353 BitsToUnitEnd
= FindGuardedMemoryMap (Address
, TRUE
, &BitMap
);
354 ASSERT (BitMap
!= NULL
);
356 if (NumberOfPages
> BitsToUnitEnd
) {
358 Bits
= BitsToUnitEnd
;
360 Bits
= NumberOfPages
;
363 ClearBits (Address
, Bits
, BitMap
);
365 NumberOfPages
-= Bits
;
366 Address
+= EFI_PAGES_TO_SIZE (Bits
);
371 Retrieve corresponding bits in bitmap table according to given memory range.
373 @param[in] Address Memory address to retrieve from.
374 @param[in] NumberOfPages Number of pages to retrieve.
379 GetGuardedMemoryBits (
380 IN EFI_PHYSICAL_ADDRESS Address
,
381 IN UINTN NumberOfPages
390 ASSERT (NumberOfPages
<= GUARDED_HEAP_MAP_ENTRY_BITS
);
394 while (NumberOfPages
> 0) {
395 BitsToUnitEnd
= FindGuardedMemoryMap (Address
, FALSE
, &BitMap
);
397 if (NumberOfPages
> BitsToUnitEnd
) {
399 Bits
= BitsToUnitEnd
;
401 Bits
= NumberOfPages
;
404 if (BitMap
!= NULL
) {
405 Result
|= LShiftU64 (GetBits (Address
, Bits
, BitMap
), Shift
);
409 NumberOfPages
-= Bits
;
410 Address
+= EFI_PAGES_TO_SIZE (Bits
);
417 Get bit value in bitmap table for the given address.
419 @param[in] Address The address to retrieve for.
426 IN EFI_PHYSICAL_ADDRESS Address
431 FindGuardedMemoryMap (Address
, FALSE
, &GuardMap
);
432 if (GuardMap
!= NULL
) {
433 if (RShiftU64 (*GuardMap
,
434 GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address
)) & 1) {
443 Set the bit in bitmap table for the given address.
445 @param[in] Address The address to set for.
452 IN EFI_PHYSICAL_ADDRESS Address
458 FindGuardedMemoryMap (Address
, TRUE
, &GuardMap
);
459 if (GuardMap
!= NULL
) {
460 BitMask
= LShiftU64 (1, GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address
));
461 *GuardMap
|= BitMask
;
466 Clear the bit in bitmap table for the given address.
468 @param[in] Address The address to clear for.
475 IN EFI_PHYSICAL_ADDRESS Address
481 FindGuardedMemoryMap (Address
, TRUE
, &GuardMap
);
482 if (GuardMap
!= NULL
) {
483 BitMask
= LShiftU64 (1, GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address
));
484 *GuardMap
&= ~BitMask
;
489 Check to see if the page at the given address is a Guard page or not.
491 @param[in] Address The address to check for.
493 @return TRUE The page at Address is a Guard page.
494 @return FALSE The page at Address is not a Guard page.
499 IN EFI_PHYSICAL_ADDRESS Address
504 BitMap
= GetGuardedMemoryBits (Address
- EFI_PAGE_SIZE
, 3);
505 return ((BitMap
== 0b001) || (BitMap
== 0b100) || (BitMap
== 0b101));
509 Check to see if the page at the given address is a head Guard page or not.
511 @param[in] Address The address to check for
513 @return TRUE The page at Address is a head Guard page
514 @return FALSE The page at Address is not a head Guard page
519 IN EFI_PHYSICAL_ADDRESS Address
522 return (GetGuardedMemoryBits (Address
, 2) == 0b10);
526 Check to see if the page at the given address is a tail Guard page or not.
528 @param[in] Address The address to check for.
530 @return TRUE The page at Address is a tail Guard page.
531 @return FALSE The page at Address is not a tail Guard page.
536 IN EFI_PHYSICAL_ADDRESS Address
539 return (GetGuardedMemoryBits (Address
- EFI_PAGE_SIZE
, 2) == 0b01);
543 Check to see if the page at the given address is guarded or not.
545 @param[in] Address The address to check for.
547 @return TRUE The page at Address is guarded.
548 @return FALSE The page at Address is not guarded.
553 IN EFI_PHYSICAL_ADDRESS Address
556 return (GetGuardMapBit (Address
) == 1);
560 Set the page at the given address to be a Guard page.
562 This is done by changing the page table attribute to be NOT PRSENT.
564 @param[in] BaseAddress Page address to Guard at
571 IN EFI_PHYSICAL_ADDRESS BaseAddress
575 // Set flag to make sure allocating memory without GUARD for page table
576 // operation; otherwise infinite loops could be caused.
580 // Note: This might overwrite other attributes needed by other features,
581 // such as memory protection (NX). Please make sure they are not enabled
584 gCpu
->SetMemoryAttributes (gCpu
, BaseAddress
, EFI_PAGE_SIZE
, EFI_MEMORY_RP
);
589 Unset the Guard page at the given address to the normal memory.
591 This is done by changing the page table attribute to be PRSENT.
593 @param[in] BaseAddress Page address to Guard at.
600 IN EFI_PHYSICAL_ADDRESS BaseAddress
604 // Set flag to make sure allocating memory without GUARD for page table
605 // operation; otherwise infinite loops could be caused.
609 // Note: This might overwrite other attributes needed by other features,
610 // such as memory protection (NX). Please make sure they are not enabled
613 gCpu
->SetMemoryAttributes (gCpu
, BaseAddress
, EFI_PAGE_SIZE
, 0);
618 Check to see if the memory at the given address should be guarded or not.
620 @param[in] MemoryType Memory type to check.
621 @param[in] AllocateType Allocation type to check.
622 @param[in] PageOrPool Indicate a page allocation or pool allocation.
625 @return TRUE The given type of memory should be guarded.
626 @return FALSE The given type of memory should not be guarded.
629 IsMemoryTypeToGuard (
630 IN EFI_MEMORY_TYPE MemoryType
,
631 IN EFI_ALLOCATE_TYPE AllocateType
,
639 if (gCpu
== NULL
|| AllocateType
== AllocateAddress
) {
644 if (gSmmBase2
!= NULL
) {
645 gSmmBase2
->InSmm (gSmmBase2
, &InSmm
);
652 if ((PcdGet8 (PcdHeapGuardPropertyMask
) & PageOrPool
) == 0) {
656 if (PageOrPool
== GUARD_HEAP_TYPE_POOL
) {
657 ConfigBit
= PcdGet64 (PcdHeapGuardPoolType
);
658 } else if (PageOrPool
== GUARD_HEAP_TYPE_PAGE
) {
659 ConfigBit
= PcdGet64 (PcdHeapGuardPageType
);
661 ConfigBit
= (UINT64
)-1;
664 if ((UINT32
)MemoryType
>= MEMORY_TYPE_OS_RESERVED_MIN
) {
666 } else if ((UINT32
) MemoryType
>= MEMORY_TYPE_OEM_RESERVED_MIN
) {
668 } else if (MemoryType
< EfiMaxMemoryType
) {
669 TestBit
= LShiftU64 (1, MemoryType
);
670 } else if (MemoryType
== EfiMaxMemoryType
) {
671 TestBit
= (UINT64
)-1;
676 return ((ConfigBit
& TestBit
) != 0);
680 Check to see if the pool at the given address should be guarded or not.
682 @param[in] MemoryType Pool type to check.
685 @return TRUE The given type of pool should be guarded.
686 @return FALSE The given type of pool should not be guarded.
690 IN EFI_MEMORY_TYPE MemoryType
693 return IsMemoryTypeToGuard (MemoryType
, AllocateAnyPages
,
694 GUARD_HEAP_TYPE_POOL
);
698 Check to see if the page at the given address should be guarded or not.
700 @param[in] MemoryType Page type to check.
701 @param[in] AllocateType Allocation type to check.
703 @return TRUE The given type of page should be guarded.
704 @return FALSE The given type of page should not be guarded.
708 IN EFI_MEMORY_TYPE MemoryType
,
709 IN EFI_ALLOCATE_TYPE AllocateType
712 return IsMemoryTypeToGuard (MemoryType
, AllocateType
, GUARD_HEAP_TYPE_PAGE
);
716 Set head Guard and tail Guard for the given memory range.
718 @param[in] Memory Base address of memory to set guard for.
719 @param[in] NumberOfPages Memory size in pages.
725 IN EFI_PHYSICAL_ADDRESS Memory
,
726 IN UINTN NumberOfPages
729 EFI_PHYSICAL_ADDRESS GuardPage
;
734 GuardPage
= Memory
+ EFI_PAGES_TO_SIZE (NumberOfPages
);
735 if (!IsGuardPage (GuardPage
)) {
736 SetGuardPage (GuardPage
);
740 GuardPage
= Memory
- EFI_PAGES_TO_SIZE (1);
741 if (!IsGuardPage (GuardPage
)) {
742 SetGuardPage (GuardPage
);
746 // Mark the memory range as Guarded
748 SetGuardedMemoryBits (Memory
, NumberOfPages
);
752 Unset head Guard and tail Guard for the given memory range.
754 @param[in] Memory Base address of memory to unset guard for.
755 @param[in] NumberOfPages Memory size in pages.
760 UnsetGuardForMemory (
761 IN EFI_PHYSICAL_ADDRESS Memory
,
762 IN UINTN NumberOfPages
765 EFI_PHYSICAL_ADDRESS GuardPage
;
767 if (NumberOfPages
== 0) {
772 // Head Guard must be one page before, if any.
774 GuardPage
= Memory
- EFI_PAGES_TO_SIZE (1);
775 if (IsHeadGuard (GuardPage
)) {
776 if (!IsMemoryGuarded (GuardPage
- EFI_PAGES_TO_SIZE (1))) {
778 // If the head Guard is not a tail Guard of adjacent memory block,
781 UnsetGuardPage (GuardPage
);
783 } else if (IsMemoryGuarded (GuardPage
)) {
785 // Pages before memory to free are still in Guard. It's a partial free
786 // case. Turn first page of memory block to free into a new Guard.
788 SetGuardPage (Memory
);
792 // Tail Guard must be the page after this memory block to free, if any.
794 GuardPage
= Memory
+ EFI_PAGES_TO_SIZE (NumberOfPages
);
795 if (IsTailGuard (GuardPage
)) {
796 if (!IsMemoryGuarded (GuardPage
+ EFI_PAGES_TO_SIZE (1))) {
798 // If the tail Guard is not a head Guard of adjacent memory block,
799 // free it; otherwise, keep it.
801 UnsetGuardPage (GuardPage
);
803 } else if (IsMemoryGuarded (GuardPage
)) {
805 // Pages after memory to free are still in Guard. It's a partial free
806 // case. We need to keep one page to be a head Guard.
808 SetGuardPage (GuardPage
- EFI_PAGES_TO_SIZE (1));
812 // No matter what, we just clear the mark of the Guarded memory.
814 ClearGuardedMemoryBits(Memory
, NumberOfPages
);
818 Adjust address of free memory according to existing and/or required Guard.
820 This function will check if there're existing Guard pages of adjacent
821 memory blocks, and try to use it as the Guard page of the memory to be
824 @param[in] Start Start address of free memory block.
825 @param[in] Size Size of free memory block.
826 @param[in] SizeRequested Size of memory to allocate.
828 @return The end address of memory block found.
829 @return 0 if no enough space for the required size of memory and its Guard.
835 IN UINT64 SizeRequested
840 Target
= Start
+ Size
- SizeRequested
;
843 // At least one more page needed for Guard page.
845 if (Size
< (SizeRequested
+ EFI_PAGES_TO_SIZE (1))) {
849 if (!IsGuardPage (Start
+ Size
)) {
850 // No Guard at tail to share. One more page is needed.
851 Target
-= EFI_PAGES_TO_SIZE (1);
855 if (Target
< Start
) {
860 if (Target
== Start
) {
861 if (!IsGuardPage (Target
- EFI_PAGES_TO_SIZE (1))) {
862 // No enough space for a new head Guard if no Guard at head to share.
867 // OK, we have enough pages for memory and its Guards. Return the End of the
869 return Target
+ SizeRequested
- 1;
873 Adjust the start address and number of pages to free according to Guard.
875 The purpose of this function is to keep the shared Guard page with adjacent
876 memory block if it's still in guard, or free it if no more sharing. Another
877 is to reserve pages as Guard pages in partial page free situation.
879 @param[in,out] Memory Base address of memory to free.
880 @param[in,out] NumberOfPages Size of memory to free.
886 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
,
887 IN OUT UINTN
*NumberOfPages
890 EFI_PHYSICAL_ADDRESS Start
;
891 EFI_PHYSICAL_ADDRESS MemoryToTest
;
894 if (Memory
== NULL
|| NumberOfPages
== NULL
|| *NumberOfPages
== 0) {
899 PagesToFree
= *NumberOfPages
;
902 // Head Guard must be one page before, if any.
904 MemoryToTest
= Start
- EFI_PAGES_TO_SIZE (1);
905 if (IsHeadGuard (MemoryToTest
)) {
906 if (!IsMemoryGuarded (MemoryToTest
- EFI_PAGES_TO_SIZE (1))) {
908 // If the head Guard is not a tail Guard of adjacent memory block,
909 // free it; otherwise, keep it.
911 Start
-= EFI_PAGES_TO_SIZE (1);
914 } else if (IsMemoryGuarded (MemoryToTest
)) {
916 // Pages before memory to free are still in Guard. It's a partial free
917 // case. We need to keep one page to be a tail Guard.
919 Start
+= EFI_PAGES_TO_SIZE (1);
924 // Tail Guard must be the page after this memory block to free, if any.
926 MemoryToTest
= Start
+ EFI_PAGES_TO_SIZE (PagesToFree
);
927 if (IsTailGuard (MemoryToTest
)) {
928 if (!IsMemoryGuarded (MemoryToTest
+ EFI_PAGES_TO_SIZE (1))) {
930 // If the tail Guard is not a head Guard of adjacent memory block,
931 // free it; otherwise, keep it.
935 } else if (IsMemoryGuarded (MemoryToTest
)) {
937 // Pages after memory to free are still in Guard. It's a partial free
938 // case. We need to keep one page to be a head Guard.
944 *NumberOfPages
= PagesToFree
;
948 Adjust the base and number of pages to really allocate according to Guard.
950 @param[in,out] Memory Base address of free memory.
951 @param[in,out] NumberOfPages Size of memory to allocate.
957 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
,
958 IN OUT UINTN
*NumberOfPages
962 // FindFreePages() has already taken the Guard into account. It's safe to
963 // adjust the start address and/or number of pages here, to make sure that
964 // the Guards are also "allocated".
966 if (!IsGuardPage (*Memory
+ EFI_PAGES_TO_SIZE (*NumberOfPages
))) {
967 // No tail Guard, add one.
971 if (!IsGuardPage (*Memory
- EFI_PAGE_SIZE
)) {
972 // No head Guard, add one.
973 *Memory
-= EFI_PAGE_SIZE
;
979 Adjust the pool head position to make sure the Guard page is adjavent to
980 pool tail or pool head.
982 @param[in] Memory Base address of memory allocated.
983 @param[in] NoPages Number of pages actually allocated.
984 @param[in] Size Size of memory requested.
985 (plus pool head/tail overhead)
987 @return Address of pool head.
991 IN EFI_PHYSICAL_ADDRESS Memory
,
996 if ((PcdGet8 (PcdHeapGuardPropertyMask
) & BIT7
) != 0) {
998 // Pool head is put near the head Guard
1000 return (VOID
*)(UINTN
)Memory
;
1004 // Pool head is put near the tail Guard
1006 return (VOID
*)(UINTN
)(Memory
+ EFI_PAGES_TO_SIZE (NoPages
) - Size
);
1010 Get the page base address according to pool head address.
1012 @param[in] Memory Head address of pool to free.
1014 @return Address of pool head.
1018 IN EFI_PHYSICAL_ADDRESS Memory
1021 if ((PcdGet8 (PcdHeapGuardPropertyMask
) & BIT7
) != 0) {
1023 // Pool head is put near the head Guard
1025 return (VOID
*)(UINTN
)Memory
;
1029 // Pool head is put near the tail Guard
1031 return (VOID
*)(UINTN
)(Memory
& ~EFI_PAGE_MASK
);
1035 Allocate or free guarded memory.
1037 @param[in] Start Start address of memory to allocate or free.
1038 @param[in] NumberOfPages Memory size in pages.
1039 @param[in] NewType Memory type to convert to.
1044 CoreConvertPagesWithGuard (
1046 IN UINTN NumberOfPages
,
1047 IN EFI_MEMORY_TYPE NewType
1050 if (NewType
== EfiConventionalMemory
) {
1051 AdjustMemoryF (&Start
, &NumberOfPages
);
1053 AdjustMemoryA (&Start
, &NumberOfPages
);
1056 return CoreConvertPages(Start
, NumberOfPages
, NewType
);
1060 Helper function to convert a UINT64 value in binary to a string.
1062 @param[in] Value Value of a UINT64 integer.
1063 @param[out] BinString String buffer to contain the conversion result.
1070 OUT CHAR8
*BinString
1075 if (BinString
== NULL
) {
1079 for (Index
= 64; Index
> 0; --Index
) {
1080 BinString
[Index
- 1] = '0' + (Value
& 1);
1081 Value
= RShiftU64 (Value
, 1);
1083 BinString
[64] = '\0';
1087 Dump the guarded memory bit map.
1091 DumpGuardedMemoryBitmap (
1095 UINTN Entries
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1096 UINTN Shifts
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1097 UINTN Indices
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1098 UINT64 Tables
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1099 UINT64 Addresses
[GUARDED_HEAP_MAP_TABLE_DEPTH
];
1104 CHAR8 String
[GUARDED_HEAP_MAP_ENTRY_BITS
+ 1];
1108 if (mGuardedMemoryMap
== 0) {
1112 Ruler1
= " 3 2 1 0";
1113 Ruler2
= "FEDCBA9876543210FEDCBA9876543210FEDCBA9876543210FEDCBA9876543210";
1115 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, "============================="
1116 " Guarded Memory Bitmap "
1117 "==============================\r\n"));
1118 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, " %a\r\n", Ruler1
));
1119 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, " %a\r\n", Ruler2
));
1121 CopyMem (Entries
, mLevelMask
, sizeof (Entries
));
1122 CopyMem (Shifts
, mLevelShift
, sizeof (Shifts
));
1124 SetMem (Indices
, sizeof(Indices
), 0);
1125 SetMem (Tables
, sizeof(Tables
), 0);
1126 SetMem (Addresses
, sizeof(Addresses
), 0);
1128 Level
= GUARDED_HEAP_MAP_TABLE_DEPTH
- mMapLevel
;
1129 Tables
[Level
] = mGuardedMemoryMap
;
1134 if (Indices
[Level
] > Entries
[Level
]) {
1141 HEAP_GUARD_DEBUG_LEVEL
,
1142 "========================================="
1143 "=========================================\r\n"
1148 TableEntry
= ((UINT64
*)(UINTN
)Tables
[Level
])[Indices
[Level
]];
1149 Address
= Addresses
[Level
];
1151 if (TableEntry
== 0) {
1153 if (Level
== GUARDED_HEAP_MAP_TABLE_DEPTH
- 1) {
1154 if (RepeatZero
== 0) {
1155 Uint64ToBinString(TableEntry
, String
);
1156 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, "%016lx: %a\r\n", Address
, String
));
1157 } else if (RepeatZero
== 1) {
1158 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, "... : ...\r\n"));
1163 } else if (Level
< GUARDED_HEAP_MAP_TABLE_DEPTH
- 1) {
1166 Tables
[Level
] = TableEntry
;
1167 Addresses
[Level
] = Address
;
1176 Uint64ToBinString(TableEntry
, String
);
1177 DEBUG ((HEAP_GUARD_DEBUG_LEVEL
, "%016lx: %a\r\n", Address
, String
));
1182 if (Level
< (GUARDED_HEAP_MAP_TABLE_DEPTH
- (INTN
)mMapLevel
)) {
1186 Indices
[Level
] += 1;
1187 Address
= (Level
== 0) ? 0 : Addresses
[Level
- 1];
1188 Addresses
[Level
] = Address
| LShiftU64(Indices
[Level
], Shifts
[Level
]);