-/** @file
- UEFI Heap Guard functions.
-
-Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials
-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
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-**/
-
-#include "HeapGuard.h"
-
-//
-// Global to avoid infinite reentrance of memory allocation when updating
-// page table attributes, which may need allocating pages for new PDE/PTE.
-//
-GLOBAL_REMOVE_IF_UNREFERENCED BOOLEAN mOnGuarding = FALSE;
-
-//
-// Pointer to table tracking the Guarded memory with bitmap, in which '1'
-// is used to indicate memory guarded. '0' might be free memory or Guard
-// page itself, depending on status of memory adjacent to it.
-//
-GLOBAL_REMOVE_IF_UNREFERENCED UINT64 mGuardedMemoryMap = 0;
-
-//
-// Current depth level of map table pointed by mGuardedMemoryMap.
-// mMapLevel must be initialized at least by 1. It will be automatically
-// updated according to the address of memory just tracked.
-//
-GLOBAL_REMOVE_IF_UNREFERENCED UINTN mMapLevel = 1;
-
-//
-// Shift and mask for each level of map table
-//
-GLOBAL_REMOVE_IF_UNREFERENCED UINTN mLevelShift[GUARDED_HEAP_MAP_TABLE_DEPTH]
- = GUARDED_HEAP_MAP_TABLE_DEPTH_SHIFTS;
-GLOBAL_REMOVE_IF_UNREFERENCED UINTN mLevelMask[GUARDED_HEAP_MAP_TABLE_DEPTH]
- = GUARDED_HEAP_MAP_TABLE_DEPTH_MASKS;
-
-//
-// SMM memory attribute protocol
-//
-EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL *mSmmMemoryAttribute = NULL;
-
-/**
- Set corresponding bits in bitmap table to 1 according to the address.
-
- @param[in] Address Start address to set for.
- @param[in] BitNumber Number of bits to set.
- @param[in] BitMap Pointer to bitmap which covers the Address.
-
- @return VOID
-**/
-STATIC
-VOID
-SetBits (
- IN EFI_PHYSICAL_ADDRESS Address,
- IN UINTN BitNumber,
- IN UINT64 *BitMap
- )
-{
- UINTN Lsbs;
- UINTN Qwords;
- UINTN Msbs;
- UINTN StartBit;
- UINTN EndBit;
-
- StartBit = (UINTN)GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address);
- EndBit = (StartBit + BitNumber - 1) % GUARDED_HEAP_MAP_ENTRY_BITS;
-
- if ((StartBit + BitNumber) > GUARDED_HEAP_MAP_ENTRY_BITS) {
- Msbs = (GUARDED_HEAP_MAP_ENTRY_BITS - StartBit) %
- GUARDED_HEAP_MAP_ENTRY_BITS;
- Lsbs = (EndBit + 1) % GUARDED_HEAP_MAP_ENTRY_BITS;
- Qwords = (BitNumber - Msbs) / GUARDED_HEAP_MAP_ENTRY_BITS;
- } else {
- Msbs = BitNumber;
- Lsbs = 0;
- Qwords = 0;
- }
-
- if (Msbs > 0) {
- *BitMap |= LShiftU64 (LShiftU64 (1, Msbs) - 1, StartBit);
- BitMap += 1;
- }
-
- if (Qwords > 0) {
- SetMem64 ((VOID *)BitMap, Qwords * GUARDED_HEAP_MAP_ENTRY_BYTES,
- (UINT64)-1);
- BitMap += Qwords;
- }
-
- if (Lsbs > 0) {
- *BitMap |= (LShiftU64 (1, Lsbs) - 1);
- }
-}
-
-/**
- Set corresponding bits in bitmap table to 0 according to the address.
-
- @param[in] Address Start address to set for.
- @param[in] BitNumber Number of bits to set.
- @param[in] BitMap Pointer to bitmap which covers the Address.
-
- @return VOID.
-**/
-STATIC
-VOID
-ClearBits (
- IN EFI_PHYSICAL_ADDRESS Address,
- IN UINTN BitNumber,
- IN UINT64 *BitMap
- )
-{
- UINTN Lsbs;
- UINTN Qwords;
- UINTN Msbs;
- UINTN StartBit;
- UINTN EndBit;
-
- StartBit = (UINTN)GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address);
- EndBit = (StartBit + BitNumber - 1) % GUARDED_HEAP_MAP_ENTRY_BITS;
-
- if ((StartBit + BitNumber) > GUARDED_HEAP_MAP_ENTRY_BITS) {
- Msbs = (GUARDED_HEAP_MAP_ENTRY_BITS - StartBit) %
- GUARDED_HEAP_MAP_ENTRY_BITS;
- Lsbs = (EndBit + 1) % GUARDED_HEAP_MAP_ENTRY_BITS;
- Qwords = (BitNumber - Msbs) / GUARDED_HEAP_MAP_ENTRY_BITS;
- } else {
- Msbs = BitNumber;
- Lsbs = 0;
- Qwords = 0;
- }
-
- if (Msbs > 0) {
- *BitMap &= ~LShiftU64 (LShiftU64 (1, Msbs) - 1, StartBit);
- BitMap += 1;
- }
-
- if (Qwords > 0) {
- SetMem64 ((VOID *)BitMap, Qwords * GUARDED_HEAP_MAP_ENTRY_BYTES, 0);
- BitMap += Qwords;
- }
-
- if (Lsbs > 0) {
- *BitMap &= ~(LShiftU64 (1, Lsbs) - 1);
- }
-}
-
-/**
- Get corresponding bits in bitmap table according to the address.
-
- The value of bit 0 corresponds to the status of memory at given Address.
- No more than 64 bits can be retrieved in one call.
-
- @param[in] Address Start address to retrieve bits for.
- @param[in] BitNumber Number of bits to get.
- @param[in] BitMap Pointer to bitmap which covers the Address.
-
- @return An integer containing the bits information.
-**/
-STATIC
-UINT64
-GetBits (
- IN EFI_PHYSICAL_ADDRESS Address,
- IN UINTN BitNumber,
- IN UINT64 *BitMap
- )
-{
- UINTN StartBit;
- UINTN EndBit;
- UINTN Lsbs;
- UINTN Msbs;
- UINT64 Result;
-
- ASSERT (BitNumber <= GUARDED_HEAP_MAP_ENTRY_BITS);
-
- StartBit = (UINTN)GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address);
- EndBit = (StartBit + BitNumber - 1) % GUARDED_HEAP_MAP_ENTRY_BITS;
-
- if ((StartBit + BitNumber) > GUARDED_HEAP_MAP_ENTRY_BITS) {
- Msbs = GUARDED_HEAP_MAP_ENTRY_BITS - StartBit;
- Lsbs = (EndBit + 1) % GUARDED_HEAP_MAP_ENTRY_BITS;
- } else {
- Msbs = BitNumber;
- Lsbs = 0;
- }
-
- Result = RShiftU64 ((*BitMap), StartBit) & (LShiftU64 (1, Msbs) - 1);
- if (Lsbs > 0) {
- BitMap += 1;
- Result |= LShiftU64 ((*BitMap) & (LShiftU64 (1, Lsbs) - 1), Msbs);
- }
-
- return Result;
-}
-
-/**
- Helper function to allocate pages without Guard for internal uses.
-
- @param[in] Pages Page number.
-
- @return Address of memory allocated.
-**/
-VOID *
-PageAlloc (
- IN UINTN Pages
- )
-{
- EFI_STATUS Status;
- EFI_PHYSICAL_ADDRESS Memory;
-
- Status = SmmInternalAllocatePages (AllocateAnyPages, EfiRuntimeServicesData,
- Pages, &Memory, FALSE);
- if (EFI_ERROR (Status)) {
- Memory = 0;
- }
-
- return (VOID *)(UINTN)Memory;
-}
-
-/**
- Locate the pointer of bitmap from the guarded memory bitmap tables, which
- covers the given Address.
-
- @param[in] Address Start address to search the bitmap for.
- @param[in] AllocMapUnit Flag to indicate memory allocation for the table.
- @param[out] BitMap Pointer to bitmap which covers the Address.
-
- @return The bit number from given Address to the end of current map table.
-**/
-UINTN
-FindGuardedMemoryMap (
- IN EFI_PHYSICAL_ADDRESS Address,
- IN BOOLEAN AllocMapUnit,
- OUT UINT64 **BitMap
- )
-{
- UINTN Level;
- UINT64 *GuardMap;
- UINT64 MapMemory;
- UINTN Index;
- UINTN Size;
- UINTN BitsToUnitEnd;
-
- //
- // Adjust current map table depth according to the address to access
- //
- while (mMapLevel < GUARDED_HEAP_MAP_TABLE_DEPTH
- &&
- RShiftU64 (
- Address,
- mLevelShift[GUARDED_HEAP_MAP_TABLE_DEPTH - mMapLevel - 1]
- ) != 0) {
-
- if (mGuardedMemoryMap != 0) {
- Size = (mLevelMask[GUARDED_HEAP_MAP_TABLE_DEPTH - mMapLevel - 1] + 1)
- * GUARDED_HEAP_MAP_ENTRY_BYTES;
- MapMemory = (UINT64)(UINTN)PageAlloc (EFI_SIZE_TO_PAGES (Size));
- ASSERT (MapMemory != 0);
-
- SetMem ((VOID *)(UINTN)MapMemory, Size, 0);
-
- *(UINT64 *)(UINTN)MapMemory = mGuardedMemoryMap;
- mGuardedMemoryMap = MapMemory;
- }
-
- mMapLevel++;
-
- }
-
- GuardMap = &mGuardedMemoryMap;
- for (Level = GUARDED_HEAP_MAP_TABLE_DEPTH - mMapLevel;
- Level < GUARDED_HEAP_MAP_TABLE_DEPTH;
- ++Level) {
-
- if (*GuardMap == 0) {
- if (!AllocMapUnit) {
- GuardMap = NULL;
- break;
- }
-
- Size = (mLevelMask[Level] + 1) * GUARDED_HEAP_MAP_ENTRY_BYTES;
- MapMemory = (UINT64)(UINTN)PageAlloc (EFI_SIZE_TO_PAGES (Size));
- ASSERT (MapMemory != 0);
-
- SetMem ((VOID *)(UINTN)MapMemory, Size, 0);
- *GuardMap = MapMemory;
- }
-
- Index = (UINTN)RShiftU64 (Address, mLevelShift[Level]);
- Index &= mLevelMask[Level];
- GuardMap = (UINT64 *)(UINTN)((*GuardMap) + Index * sizeof (UINT64));
-
- }
-
- BitsToUnitEnd = GUARDED_HEAP_MAP_BITS - GUARDED_HEAP_MAP_BIT_INDEX (Address);
- *BitMap = GuardMap;
-
- return BitsToUnitEnd;
-}
-
-/**
- Set corresponding bits in bitmap table to 1 according to given memory range.
-
- @param[in] Address Memory address to guard from.
- @param[in] NumberOfPages Number of pages to guard.
-
- @return VOID
-**/
-VOID
-EFIAPI
-SetGuardedMemoryBits (
- IN EFI_PHYSICAL_ADDRESS Address,
- IN UINTN NumberOfPages
- )
-{
- UINT64 *BitMap;
- UINTN Bits;
- UINTN BitsToUnitEnd;
-
- while (NumberOfPages > 0) {
- BitsToUnitEnd = FindGuardedMemoryMap (Address, TRUE, &BitMap);
- ASSERT (BitMap != NULL);
-
- if (NumberOfPages > BitsToUnitEnd) {
- // Cross map unit
- Bits = BitsToUnitEnd;
- } else {
- Bits = NumberOfPages;
- }
-
- SetBits (Address, Bits, BitMap);
-
- NumberOfPages -= Bits;
- Address += EFI_PAGES_TO_SIZE (Bits);
- }
-}
-
-/**
- Clear corresponding bits in bitmap table according to given memory range.
-
- @param[in] Address Memory address to unset from.
- @param[in] NumberOfPages Number of pages to unset guard.
-
- @return VOID
-**/
-VOID
-EFIAPI
-ClearGuardedMemoryBits (
- IN EFI_PHYSICAL_ADDRESS Address,
- IN UINTN NumberOfPages
- )
-{
- UINT64 *BitMap;
- UINTN Bits;
- UINTN BitsToUnitEnd;
-
- while (NumberOfPages > 0) {
- BitsToUnitEnd = FindGuardedMemoryMap (Address, TRUE, &BitMap);
- ASSERT (BitMap != NULL);
-
- if (NumberOfPages > BitsToUnitEnd) {
- // Cross map unit
- Bits = BitsToUnitEnd;
- } else {
- Bits = NumberOfPages;
- }
-
- ClearBits (Address, Bits, BitMap);
-
- NumberOfPages -= Bits;
- Address += EFI_PAGES_TO_SIZE (Bits);
- }
-}
-
-/**
- Retrieve corresponding bits in bitmap table according to given memory range.
-
- @param[in] Address Memory address to retrieve from.
- @param[in] NumberOfPages Number of pages to retrieve.
-
- @return An integer containing the guarded memory bitmap.
-**/
-UINTN
-GetGuardedMemoryBits (
- IN EFI_PHYSICAL_ADDRESS Address,
- IN UINTN NumberOfPages
- )
-{
- UINT64 *BitMap;
- UINTN Bits;
- UINTN Result;
- UINTN Shift;
- UINTN BitsToUnitEnd;
-
- ASSERT (NumberOfPages <= GUARDED_HEAP_MAP_ENTRY_BITS);
-
- Result = 0;
- Shift = 0;
- while (NumberOfPages > 0) {
- BitsToUnitEnd = FindGuardedMemoryMap (Address, FALSE, &BitMap);
-
- if (NumberOfPages > BitsToUnitEnd) {
- // Cross map unit
- Bits = BitsToUnitEnd;
- } else {
- Bits = NumberOfPages;
- }
-
- if (BitMap != NULL) {
- Result |= LShiftU64 (GetBits (Address, Bits, BitMap), Shift);
- }
-
- Shift += Bits;
- NumberOfPages -= Bits;
- Address += EFI_PAGES_TO_SIZE (Bits);
- }
-
- return Result;
-}
-
-/**
- Get bit value in bitmap table for the given address.
-
- @param[in] Address The address to retrieve for.
-
- @return 1 or 0.
-**/
-UINTN
-EFIAPI
-GetGuardMapBit (
- IN EFI_PHYSICAL_ADDRESS Address
- )
-{
- UINT64 *GuardMap;
-
- FindGuardedMemoryMap (Address, FALSE, &GuardMap);
- if (GuardMap != NULL) {
- if (RShiftU64 (*GuardMap,
- GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address)) & 1) {
- return 1;
- }
- }
-
- return 0;
-}
-
-/**
- Set the bit in bitmap table for the given address.
-
- @param[in] Address The address to set for.
-
- @return VOID.
-**/
-VOID
-EFIAPI
-SetGuardMapBit (
- IN EFI_PHYSICAL_ADDRESS Address
- )
-{
- UINT64 *GuardMap;
- UINT64 BitMask;
-
- FindGuardedMemoryMap (Address, TRUE, &GuardMap);
- if (GuardMap != NULL) {
- BitMask = LShiftU64 (1, GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address));
- *GuardMap |= BitMask;
- }
-}
-
-/**
- Clear the bit in bitmap table for the given address.
-
- @param[in] Address The address to clear for.
-
- @return VOID.
-**/
-VOID
-EFIAPI
-ClearGuardMapBit (
- IN EFI_PHYSICAL_ADDRESS Address
- )
-{
- UINT64 *GuardMap;
- UINT64 BitMask;
-
- FindGuardedMemoryMap (Address, TRUE, &GuardMap);
- if (GuardMap != NULL) {
- BitMask = LShiftU64 (1, GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address));
- *GuardMap &= ~BitMask;
- }
-}
-
-/**
- Check to see if the page at the given address is a Guard page or not.
-
- @param[in] Address The address to check for.
-
- @return TRUE The page at Address is a Guard page.
- @return FALSE The page at Address is not a Guard page.
-**/
-BOOLEAN
-EFIAPI
-IsGuardPage (
- IN EFI_PHYSICAL_ADDRESS Address
-)
-{
- UINTN BitMap;
-
- //
- // There must be at least one guarded page before and/or after given
- // address if it's a Guard page. The bitmap pattern should be one of
- // 001, 100 and 101
- //
- BitMap = GetGuardedMemoryBits (Address - EFI_PAGE_SIZE, 3);
- return ((BitMap == BIT0) || (BitMap == BIT2) || (BitMap == (BIT2 | BIT0)));
-}
-
-/**
- Check to see if the page at the given address is a head Guard page or not.
-
- @param[in] Address The address to check for.
-
- @return TRUE The page at Address is a head Guard page.
- @return FALSE The page at Address is not a head Guard page.
-**/
-BOOLEAN
-EFIAPI
-IsHeadGuard (
- IN EFI_PHYSICAL_ADDRESS Address
- )
-{
- return (GetGuardedMemoryBits (Address, 2) == BIT1);
-}
-
-/**
- Check to see if the page at the given address is a tail Guard page or not.
-
- @param[in] Address The address to check for.
-
- @return TRUE The page at Address is a tail Guard page.
- @return FALSE The page at Address is not a tail Guard page.
-**/
-BOOLEAN
-EFIAPI
-IsTailGuard (
- IN EFI_PHYSICAL_ADDRESS Address
- )
-{
- return (GetGuardedMemoryBits (Address - EFI_PAGE_SIZE, 2) == BIT0);
-}
-
-/**
- Check to see if the page at the given address is guarded or not.
-
- @param[in] Address The address to check for.
-
- @return TRUE The page at Address is guarded.
- @return FALSE The page at Address is not guarded.
-**/
-BOOLEAN
-EFIAPI
-IsMemoryGuarded (
- IN EFI_PHYSICAL_ADDRESS Address
- )
-{
- return (GetGuardMapBit (Address) == 1);
-}
-
-/**
- Set the page at the given address to be a Guard page.
-
- This is done by changing the page table attribute to be NOT PRSENT.
-
- @param[in] BaseAddress Page address to Guard at.
-
- @return VOID.
-**/
-VOID
-EFIAPI
-SetGuardPage (
- IN EFI_PHYSICAL_ADDRESS BaseAddress
- )
-{
- if (mSmmMemoryAttribute != NULL) {
- mOnGuarding = TRUE;
- mSmmMemoryAttribute->SetMemoryAttributes (
- mSmmMemoryAttribute,
- BaseAddress,
- EFI_PAGE_SIZE,
- EFI_MEMORY_RP
- );
- mOnGuarding = FALSE;
- }
-}
-
-/**
- Unset the Guard page at the given address to the normal memory.
-
- This is done by changing the page table attribute to be PRSENT.
-
- @param[in] BaseAddress Page address to Guard at.
-
- @return VOID.
-**/
-VOID
-EFIAPI
-UnsetGuardPage (
- IN EFI_PHYSICAL_ADDRESS BaseAddress
- )
-{
- if (mSmmMemoryAttribute != NULL) {
- mOnGuarding = TRUE;
- mSmmMemoryAttribute->ClearMemoryAttributes (
- mSmmMemoryAttribute,
- BaseAddress,
- EFI_PAGE_SIZE,
- EFI_MEMORY_RP
- );
- mOnGuarding = FALSE;
- }
-}
-
-/**
- Check to see if the memory at the given address should be guarded or not.
-
- @param[in] MemoryType Memory type to check.
- @param[in] AllocateType Allocation type to check.
- @param[in] PageOrPool Indicate a page allocation or pool allocation.
-
-
- @return TRUE The given type of memory should be guarded.
- @return FALSE The given type of memory should not be guarded.
-**/
-BOOLEAN
-IsMemoryTypeToGuard (
- IN EFI_MEMORY_TYPE MemoryType,
- IN EFI_ALLOCATE_TYPE AllocateType,
- IN UINT8 PageOrPool
- )
-{
- UINT64 TestBit;
- UINT64 ConfigBit;
-
- if ((PcdGet8 (PcdHeapGuardPropertyMask) & PageOrPool) == 0
- || mOnGuarding
- || AllocateType == AllocateAddress) {
- return FALSE;
- }
-
- ConfigBit = 0;
- if ((PageOrPool & GUARD_HEAP_TYPE_POOL) != 0) {
- ConfigBit |= PcdGet64 (PcdHeapGuardPoolType);
- }
-
- if ((PageOrPool & GUARD_HEAP_TYPE_PAGE) != 0) {
- ConfigBit |= PcdGet64 (PcdHeapGuardPageType);
- }
-
- if (MemoryType == EfiRuntimeServicesData ||
- MemoryType == EfiRuntimeServicesCode) {
- TestBit = LShiftU64 (1, MemoryType);
- } else if (MemoryType == EfiMaxMemoryType) {
- TestBit = (UINT64)-1;
- } else {
- TestBit = 0;
- }
-
- return ((ConfigBit & TestBit) != 0);
-}
-
-/**
- Check to see if the pool at the given address should be guarded or not.
-
- @param[in] MemoryType Pool type to check.
-
-
- @return TRUE The given type of pool should be guarded.
- @return FALSE The given type of pool should not be guarded.
-**/
-BOOLEAN
-IsPoolTypeToGuard (
- IN EFI_MEMORY_TYPE MemoryType
- )
-{
- return IsMemoryTypeToGuard (MemoryType, AllocateAnyPages,
- GUARD_HEAP_TYPE_POOL);
-}
-
-/**
- Check to see if the page at the given address should be guarded or not.
-
- @param[in] MemoryType Page type to check.
- @param[in] AllocateType Allocation type to check.
-
- @return TRUE The given type of page should be guarded.
- @return FALSE The given type of page should not be guarded.
-**/
-BOOLEAN
-IsPageTypeToGuard (
- IN EFI_MEMORY_TYPE MemoryType,
- IN EFI_ALLOCATE_TYPE AllocateType
- )
-{
- return IsMemoryTypeToGuard (MemoryType, AllocateType, GUARD_HEAP_TYPE_PAGE);
-}
-
-/**
- Check to see if the heap guard is enabled for page and/or pool allocation.
-
- @return TRUE/FALSE.
-**/
-BOOLEAN
-IsHeapGuardEnabled (
- VOID
- )
-{
- return IsMemoryTypeToGuard (EfiMaxMemoryType, AllocateAnyPages,
- GUARD_HEAP_TYPE_POOL|GUARD_HEAP_TYPE_PAGE);
-}
-
-/**
- Set head Guard and tail Guard for the given memory range.
-
- @param[in] Memory Base address of memory to set guard for.
- @param[in] NumberOfPages Memory size in pages.
-
- @return VOID.
-**/
-VOID
-SetGuardForMemory (
- IN EFI_PHYSICAL_ADDRESS Memory,
- IN UINTN NumberOfPages
- )
-{
- EFI_PHYSICAL_ADDRESS GuardPage;
-
- //
- // Set tail Guard
- //
- GuardPage = Memory + EFI_PAGES_TO_SIZE (NumberOfPages);
- if (!IsGuardPage (GuardPage)) {
- SetGuardPage (GuardPage);
- }
-
- // Set head Guard
- GuardPage = Memory - EFI_PAGES_TO_SIZE (1);
- if (!IsGuardPage (GuardPage)) {
- SetGuardPage (GuardPage);
- }
-
- //
- // Mark the memory range as Guarded
- //
- SetGuardedMemoryBits (Memory, NumberOfPages);
-}
-
-/**
- Unset head Guard and tail Guard for the given memory range.
-
- @param[in] Memory Base address of memory to unset guard for.
- @param[in] NumberOfPages Memory size in pages.
-
- @return VOID.
-**/
-VOID
-UnsetGuardForMemory (
- IN EFI_PHYSICAL_ADDRESS Memory,
- IN UINTN NumberOfPages
- )
-{
- EFI_PHYSICAL_ADDRESS GuardPage;
-
- if (NumberOfPages == 0) {
- return;
- }
-
- //
- // Head Guard must be one page before, if any.
- //
- GuardPage = Memory - EFI_PAGES_TO_SIZE (1);
- if (IsHeadGuard (GuardPage)) {
- if (!IsMemoryGuarded (GuardPage - EFI_PAGES_TO_SIZE (1))) {
- //
- // If the head Guard is not a tail Guard of adjacent memory block,
- // unset it.
- //
- UnsetGuardPage (GuardPage);
- }
- } else if (IsMemoryGuarded (GuardPage)) {
- //
- // Pages before memory to free are still in Guard. It's a partial free
- // case. Turn first page of memory block to free into a new Guard.
- //
- SetGuardPage (Memory);
- }
-
- //
- // Tail Guard must be the page after this memory block to free, if any.
- //
- GuardPage = Memory + EFI_PAGES_TO_SIZE (NumberOfPages);
- if (IsTailGuard (GuardPage)) {
- if (!IsMemoryGuarded (GuardPage + EFI_PAGES_TO_SIZE (1))) {
- //
- // If the tail Guard is not a head Guard of adjacent memory block,
- // free it; otherwise, keep it.
- //
- UnsetGuardPage (GuardPage);
- }
- } else if (IsMemoryGuarded (GuardPage)) {
- //
- // Pages after memory to free are still in Guard. It's a partial free
- // case. We need to keep one page to be a head Guard.
- //
- SetGuardPage (GuardPage - EFI_PAGES_TO_SIZE (1));
- }
-
- //
- // No matter what, we just clear the mark of the Guarded memory.
- //
- ClearGuardedMemoryBits(Memory, NumberOfPages);
-}
-
-/**
- Adjust address of free memory according to existing and/or required Guard.
-
- This function will check if there're existing Guard pages of adjacent
- memory blocks, and try to use it as the Guard page of the memory to be
- allocated.
-
- @param[in] Start Start address of free memory block.
- @param[in] Size Size of free memory block.
- @param[in] SizeRequested Size of memory to allocate.
-
- @return The end address of memory block found.
- @return 0 if no enough space for the required size of memory and its Guard.
-**/
-UINT64
-AdjustMemoryS (
- IN UINT64 Start,
- IN UINT64 Size,
- IN UINT64 SizeRequested
- )
-{
- UINT64 Target;
-
- Target = Start + Size - SizeRequested;
-
- //
- // At least one more page needed for Guard page.
- //
- if (Size < (SizeRequested + EFI_PAGES_TO_SIZE (1))) {
- return 0;
- }
-
- if (!IsGuardPage (Start + Size)) {
- // No Guard at tail to share. One more page is needed.
- Target -= EFI_PAGES_TO_SIZE (1);
- }
-
- // Out of range?
- if (Target < Start) {
- return 0;
- }
-
- // At the edge?
- if (Target == Start) {
- if (!IsGuardPage (Target - EFI_PAGES_TO_SIZE (1))) {
- // No enough space for a new head Guard if no Guard at head to share.
- return 0;
- }
- }
-
- // OK, we have enough pages for memory and its Guards. Return the End of the
- // free space.
- return Target + SizeRequested - 1;
-}
-
-/**
- Adjust the start address and number of pages to free according to Guard.
-
- The purpose of this function is to keep the shared Guard page with adjacent
- memory block if it's still in guard, or free it if no more sharing. Another
- is to reserve pages as Guard pages in partial page free situation.
-
- @param[in,out] Memory Base address of memory to free.
- @param[in,out] NumberOfPages Size of memory to free.
-
- @return VOID.
-**/
-VOID
-AdjustMemoryF (
- IN OUT EFI_PHYSICAL_ADDRESS *Memory,
- IN OUT UINTN *NumberOfPages
- )
-{
- EFI_PHYSICAL_ADDRESS Start;
- EFI_PHYSICAL_ADDRESS MemoryToTest;
- UINTN PagesToFree;
-
- if (Memory == NULL || NumberOfPages == NULL || *NumberOfPages == 0) {
- return;
- }
-
- Start = *Memory;
- PagesToFree = *NumberOfPages;
-
- //
- // Head Guard must be one page before, if any.
- //
- MemoryToTest = Start - EFI_PAGES_TO_SIZE (1);
- if (IsHeadGuard (MemoryToTest)) {
- if (!IsMemoryGuarded (MemoryToTest - EFI_PAGES_TO_SIZE (1))) {
- //
- // If the head Guard is not a tail Guard of adjacent memory block,
- // free it; otherwise, keep it.
- //
- Start -= EFI_PAGES_TO_SIZE (1);
- PagesToFree += 1;
- }
- } else if (IsMemoryGuarded (MemoryToTest)) {
- //
- // Pages before memory to free are still in Guard. It's a partial free
- // case. We need to keep one page to be a tail Guard.
- //
- Start += EFI_PAGES_TO_SIZE (1);
- PagesToFree -= 1;
- }
-
- //
- // Tail Guard must be the page after this memory block to free, if any.
- //
- MemoryToTest = Start + EFI_PAGES_TO_SIZE (PagesToFree);
- if (IsTailGuard (MemoryToTest)) {
- if (!IsMemoryGuarded (MemoryToTest + EFI_PAGES_TO_SIZE (1))) {
- //
- // If the tail Guard is not a head Guard of adjacent memory block,
- // free it; otherwise, keep it.
- //
- PagesToFree += 1;
- }
- } else if (IsMemoryGuarded (MemoryToTest)) {
- //
- // Pages after memory to free are still in Guard. It's a partial free
- // case. We need to keep one page to be a head Guard.
- //
- PagesToFree -= 1;
- }
-
- *Memory = Start;
- *NumberOfPages = PagesToFree;
-}
-
-/**
- Adjust the base and number of pages to really allocate according to Guard.
-
- @param[in,out] Memory Base address of free memory.
- @param[in,out] NumberOfPages Size of memory to allocate.
-
- @return VOID.
-**/
-VOID
-AdjustMemoryA (
- IN OUT EFI_PHYSICAL_ADDRESS *Memory,
- IN OUT UINTN *NumberOfPages
- )
-{
- //
- // FindFreePages() has already taken the Guard into account. It's safe to
- // adjust the start address and/or number of pages here, to make sure that
- // the Guards are also "allocated".
- //
- if (!IsGuardPage (*Memory + EFI_PAGES_TO_SIZE (*NumberOfPages))) {
- // No tail Guard, add one.
- *NumberOfPages += 1;
- }
-
- if (!IsGuardPage (*Memory - EFI_PAGE_SIZE)) {
- // No head Guard, add one.
- *Memory -= EFI_PAGE_SIZE;
- *NumberOfPages += 1;
- }
-}
-
-/**
- Adjust the pool head position to make sure the Guard page is adjavent to
- pool tail or pool head.
-
- @param[in] Memory Base address of memory allocated.
- @param[in] NoPages Number of pages actually allocated.
- @param[in] Size Size of memory requested.
- (plus pool head/tail overhead)
-
- @return Address of pool head
-**/
-VOID *
-AdjustPoolHeadA (
- IN EFI_PHYSICAL_ADDRESS Memory,
- IN UINTN NoPages,
- IN UINTN Size
- )
-{
- if ((PcdGet8 (PcdHeapGuardPropertyMask) & BIT7) != 0) {
- //
- // Pool head is put near the head Guard
- //
- return (VOID *)(UINTN)Memory;
- }
-
- //
- // Pool head is put near the tail Guard
- //
- return (VOID *)(UINTN)(Memory + EFI_PAGES_TO_SIZE (NoPages) - Size);
-}
-
-/**
- Get the page base address according to pool head address.
-
- @param[in] Memory Head address of pool to free.
-
- @return Address of pool head.
-**/
-VOID *
-AdjustPoolHeadF (
- IN EFI_PHYSICAL_ADDRESS Memory
- )
-{
- if ((PcdGet8 (PcdHeapGuardPropertyMask) & BIT7) != 0) {
- //
- // Pool head is put near the head Guard
- //
- return (VOID *)(UINTN)Memory;
- }
-
- //
- // Pool head is put near the tail Guard
- //
- return (VOID *)(UINTN)(Memory & ~EFI_PAGE_MASK);
-}
-
-/**
- Helper function of memory allocation with Guard pages.
-
- @param FreePageList The free page node.
- @param NumberOfPages Number of pages to be allocated.
- @param MaxAddress Request to allocate memory below this address.
- @param MemoryType Type of memory requested.
-
- @return Memory address of allocated pages.
-**/
-UINTN
-InternalAllocMaxAddressWithGuard (
- IN OUT LIST_ENTRY *FreePageList,
- IN UINTN NumberOfPages,
- IN UINTN MaxAddress,
- IN EFI_MEMORY_TYPE MemoryType
-
- )
-{
- LIST_ENTRY *Node;
- FREE_PAGE_LIST *Pages;
- UINTN PagesToAlloc;
- UINTN HeadGuard;
- UINTN TailGuard;
- UINTN Address;
-
- for (Node = FreePageList->BackLink; Node != FreePageList;
- Node = Node->BackLink) {
- Pages = BASE_CR (Node, FREE_PAGE_LIST, Link);
- if (Pages->NumberOfPages >= NumberOfPages &&
- (UINTN)Pages + EFI_PAGES_TO_SIZE (NumberOfPages) - 1 <= MaxAddress) {
-
- //
- // We may need 1 or 2 more pages for Guard. Check it out.
- //
- PagesToAlloc = NumberOfPages;
- TailGuard = (UINTN)Pages + EFI_PAGES_TO_SIZE (Pages->NumberOfPages);
- if (!IsGuardPage (TailGuard)) {
- //
- // Add one if no Guard at the end of current free memory block.
- //
- PagesToAlloc += 1;
- TailGuard = 0;
- }
-
- HeadGuard = (UINTN)Pages +
- EFI_PAGES_TO_SIZE (Pages->NumberOfPages - PagesToAlloc) -
- EFI_PAGE_SIZE;
- if (!IsGuardPage (HeadGuard)) {
- //
- // Add one if no Guard at the page before the address to allocate
- //
- PagesToAlloc += 1;
- HeadGuard = 0;
- }
-
- if (Pages->NumberOfPages < PagesToAlloc) {
- // Not enough space to allocate memory with Guards? Try next block.
- continue;
- }
-
- Address = InternalAllocPagesOnOneNode (Pages, PagesToAlloc, MaxAddress);
- ConvertSmmMemoryMapEntry(MemoryType, Address, PagesToAlloc, FALSE);
- CoreFreeMemoryMapStack();
- if (HeadGuard == 0) {
- // Don't pass the Guard page to user.
- Address += EFI_PAGE_SIZE;
- }
- SetGuardForMemory (Address, NumberOfPages);
- return Address;
- }
- }
-
- return (UINTN)(-1);
-}
-
-/**
- Helper function of memory free with Guard pages.
-
- @param[in] Memory Base address of memory being freed.
- @param[in] NumberOfPages The number of pages to free.
- @param[in] AddRegion If this memory is new added region.
-
- @retval EFI_NOT_FOUND Could not find the entry that covers the range.
- @retval EFI_INVALID_PARAMETER Address not aligned, Address is zero or NumberOfPages is zero.
- @return EFI_SUCCESS Pages successfully freed.
-**/
-EFI_STATUS
-SmmInternalFreePagesExWithGuard (
- IN EFI_PHYSICAL_ADDRESS Memory,
- IN UINTN NumberOfPages,
- IN BOOLEAN AddRegion
- )
-{
- EFI_PHYSICAL_ADDRESS MemoryToFree;
- UINTN PagesToFree;
-
- MemoryToFree = Memory;
- PagesToFree = NumberOfPages;
-
- AdjustMemoryF (&MemoryToFree, &PagesToFree);
- UnsetGuardForMemory (Memory, NumberOfPages);
-
- return SmmInternalFreePagesEx (MemoryToFree, PagesToFree, AddRegion);
-}
-
-/**
- Set all Guard pages which cannot be set during the non-SMM mode time.
-**/
-VOID
-SetAllGuardPages (
- VOID
- )
-{
- UINTN Entries[GUARDED_HEAP_MAP_TABLE_DEPTH];
- UINTN Shifts[GUARDED_HEAP_MAP_TABLE_DEPTH];
- UINTN Indices[GUARDED_HEAP_MAP_TABLE_DEPTH];
- UINT64 Tables[GUARDED_HEAP_MAP_TABLE_DEPTH];
- UINT64 Addresses[GUARDED_HEAP_MAP_TABLE_DEPTH];
- UINT64 TableEntry;
- UINT64 Address;
- UINT64 GuardPage;
- INTN Level;
- UINTN Index;
- BOOLEAN OnGuarding;
-
- if (mGuardedMemoryMap == 0) {
- return;
- }
-
- CopyMem (Entries, mLevelMask, sizeof (Entries));
- CopyMem (Shifts, mLevelShift, sizeof (Shifts));
-
- SetMem (Tables, sizeof(Tables), 0);
- SetMem (Addresses, sizeof(Addresses), 0);
- SetMem (Indices, sizeof(Indices), 0);
-
- Level = GUARDED_HEAP_MAP_TABLE_DEPTH - mMapLevel;
- Tables[Level] = mGuardedMemoryMap;
- Address = 0;
- OnGuarding = FALSE;
-
- DEBUG_CODE (
- DumpGuardedMemoryBitmap ();
- );
-
- while (TRUE) {
- if (Indices[Level] > Entries[Level]) {
- Tables[Level] = 0;
- Level -= 1;
- } else {
-
- TableEntry = ((UINT64 *)(UINTN)(Tables[Level]))[Indices[Level]];
- Address = Addresses[Level];
-
- if (TableEntry == 0) {
-
- OnGuarding = FALSE;
-
- } else if (Level < GUARDED_HEAP_MAP_TABLE_DEPTH - 1) {
-
- Level += 1;
- Tables[Level] = TableEntry;
- Addresses[Level] = Address;
- Indices[Level] = 0;
-
- continue;
-
- } else {
-
- Index = 0;
- while (Index < GUARDED_HEAP_MAP_ENTRY_BITS) {
- if ((TableEntry & 1) == 1) {
- if (OnGuarding) {
- GuardPage = 0;
- } else {
- GuardPage = Address - EFI_PAGE_SIZE;
- }
- OnGuarding = TRUE;
- } else {
- if (OnGuarding) {
- GuardPage = Address;
- } else {
- GuardPage = 0;
- }
- OnGuarding = FALSE;
- }
-
- if (GuardPage != 0) {
- SetGuardPage (GuardPage);
- }
-
- if (TableEntry == 0) {
- break;
- }
-
- TableEntry = RShiftU64 (TableEntry, 1);
- Address += EFI_PAGE_SIZE;
- Index += 1;
- }
- }
- }
-
- if (Level < (GUARDED_HEAP_MAP_TABLE_DEPTH - (INTN)mMapLevel)) {
- break;
- }
-
- Indices[Level] += 1;
- Address = (Level == 0) ? 0 : Addresses[Level - 1];
- Addresses[Level] = Address | LShiftU64(Indices[Level], Shifts[Level]);
-
- }
-}
-
-/**
- Hook function used to set all Guard pages after entering SMM mode.
-**/
-VOID
-SmmEntryPointMemoryManagementHook (
- VOID
- )
-{
- EFI_STATUS Status;
-
- if (mSmmMemoryAttribute == NULL) {
- Status = SmmLocateProtocol (
- &gEdkiiSmmMemoryAttributeProtocolGuid,
- NULL,
- (VOID **)&mSmmMemoryAttribute
- );
- if (!EFI_ERROR(Status)) {
- SetAllGuardPages ();
- }
- }
-}
-
-/**
- Helper function to convert a UINT64 value in binary to a string.
-
- @param[in] Value Value of a UINT64 integer.
- @param[out] BinString String buffer to contain the conversion result.
-
- @return VOID.
-**/
-VOID
-Uint64ToBinString (
- IN UINT64 Value,
- OUT CHAR8 *BinString
- )
-{
- UINTN Index;
-
- if (BinString == NULL) {
- return;
- }
-
- for (Index = 64; Index > 0; --Index) {
- BinString[Index - 1] = '0' + (Value & 1);
- Value = RShiftU64 (Value, 1);
- }
- BinString[64] = '\0';
-}
-
-/**
- Dump the guarded memory bit map.
-**/
-VOID
-EFIAPI
-DumpGuardedMemoryBitmap (
- VOID
- )
-{
- UINTN Entries[GUARDED_HEAP_MAP_TABLE_DEPTH];
- UINTN Shifts[GUARDED_HEAP_MAP_TABLE_DEPTH];
- UINTN Indices[GUARDED_HEAP_MAP_TABLE_DEPTH];
- UINT64 Tables[GUARDED_HEAP_MAP_TABLE_DEPTH];
- UINT64 Addresses[GUARDED_HEAP_MAP_TABLE_DEPTH];
- UINT64 TableEntry;
- UINT64 Address;
- INTN Level;
- UINTN RepeatZero;
- CHAR8 String[GUARDED_HEAP_MAP_ENTRY_BITS + 1];
- CHAR8 *Ruler1;
- CHAR8 *Ruler2;
-
- if (mGuardedMemoryMap == 0) {
- return;
- }
-
- Ruler1 = " 3 2 1 0";
- Ruler2 = "FEDCBA9876543210FEDCBA9876543210FEDCBA9876543210FEDCBA9876543210";
-
- DEBUG ((HEAP_GUARD_DEBUG_LEVEL, "============================="
- " Guarded Memory Bitmap "
- "==============================\r\n"));
- DEBUG ((HEAP_GUARD_DEBUG_LEVEL, " %a\r\n", Ruler1));
- DEBUG ((HEAP_GUARD_DEBUG_LEVEL, " %a\r\n", Ruler2));
-
- CopyMem (Entries, mLevelMask, sizeof (Entries));
- CopyMem (Shifts, mLevelShift, sizeof (Shifts));
-
- SetMem (Indices, sizeof(Indices), 0);
- SetMem (Tables, sizeof(Tables), 0);
- SetMem (Addresses, sizeof(Addresses), 0);
-
- Level = GUARDED_HEAP_MAP_TABLE_DEPTH - mMapLevel;
- Tables[Level] = mGuardedMemoryMap;
- Address = 0;
- RepeatZero = 0;
-
- while (TRUE) {
- if (Indices[Level] > Entries[Level]) {
-
- Tables[Level] = 0;
- Level -= 1;
- RepeatZero = 0;
-
- DEBUG ((
- HEAP_GUARD_DEBUG_LEVEL,
- "========================================="
- "=========================================\r\n"
- ));
-
- } else {
-
- TableEntry = ((UINT64 *)(UINTN)Tables[Level])[Indices[Level]];
- Address = Addresses[Level];
-
- if (TableEntry == 0) {
-
- if (Level == GUARDED_HEAP_MAP_TABLE_DEPTH - 1) {
- if (RepeatZero == 0) {
- Uint64ToBinString(TableEntry, String);
- DEBUG ((HEAP_GUARD_DEBUG_LEVEL, "%016lx: %a\r\n", Address, String));
- } else if (RepeatZero == 1) {
- DEBUG ((HEAP_GUARD_DEBUG_LEVEL, "... : ...\r\n"));
- }
- RepeatZero += 1;
- }
-
- } else if (Level < GUARDED_HEAP_MAP_TABLE_DEPTH - 1) {
-
- Level += 1;
- Tables[Level] = TableEntry;
- Addresses[Level] = Address;
- Indices[Level] = 0;
- RepeatZero = 0;
-
- continue;
-
- } else {
-
- RepeatZero = 0;
- Uint64ToBinString(TableEntry, String);
- DEBUG ((HEAP_GUARD_DEBUG_LEVEL, "%016lx: %a\r\n", Address, String));
-
- }
- }
-
- if (Level < (GUARDED_HEAP_MAP_TABLE_DEPTH - (INTN)mMapLevel)) {
- break;
- }
-
- Indices[Level] += 1;
- Address = (Level == 0) ? 0 : Addresses[Level - 1];
- Addresses[Level] = Address | LShiftU64(Indices[Level], Shifts[Level]);
-
- }
-}
-
-/**
- Debug function used to verify if the Guard page is well set or not.
-
- @param[in] BaseAddress Address of memory to check.
- @param[in] NumberOfPages Size of memory in pages.
-
- @return TRUE The head Guard and tail Guard are both well set.
- @return FALSE The head Guard and/or tail Guard are not well set.
-**/
-BOOLEAN
-VerifyMemoryGuard (
- IN EFI_PHYSICAL_ADDRESS BaseAddress,
- IN UINTN NumberOfPages
- )
-{
- EFI_STATUS Status;
- UINT64 Attribute;
- EFI_PHYSICAL_ADDRESS Address;
-
- if (mSmmMemoryAttribute == NULL) {
- return TRUE;
- }
-
- Attribute = 0;
- Address = BaseAddress - EFI_PAGE_SIZE;
- Status = mSmmMemoryAttribute->GetMemoryAttributes (
- mSmmMemoryAttribute,
- Address,
- EFI_PAGE_SIZE,
- &Attribute
- );
- if (EFI_ERROR (Status) || (Attribute & EFI_MEMORY_RP) == 0) {
- DEBUG ((DEBUG_ERROR, "Head Guard is not set at: %016lx (%016lX)!!!\r\n",
- Address, Attribute));
- DumpGuardedMemoryBitmap ();
- return FALSE;
- }
-
- Attribute = 0;
- Address = BaseAddress + EFI_PAGES_TO_SIZE (NumberOfPages);
- Status = mSmmMemoryAttribute->GetMemoryAttributes (
- mSmmMemoryAttribute,
- Address,
- EFI_PAGE_SIZE,
- &Attribute
- );
- if (EFI_ERROR (Status) || (Attribute & EFI_MEMORY_RP) == 0) {
- DEBUG ((DEBUG_ERROR, "Tail Guard is not set at: %016lx (%016lX)!!!\r\n",
- Address, Attribute));
- DumpGuardedMemoryBitmap ();
- return FALSE;
- }
-
- return TRUE;
-}
-
+/** @file\r
+ UEFI Heap Guard functions.\r
+\r
+Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include "HeapGuard.h"\r
+\r
+//\r
+// Global to avoid infinite reentrance of memory allocation when updating\r
+// page table attributes, which may need allocating pages for new PDE/PTE.\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED BOOLEAN mOnGuarding = FALSE;\r
+\r
+//\r
+// Pointer to table tracking the Guarded memory with bitmap, in which '1'\r
+// is used to indicate memory guarded. '0' might be free memory or Guard\r
+// page itself, depending on status of memory adjacent to it.\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED UINT64 mGuardedMemoryMap = 0;\r
+\r
+//\r
+// Current depth level of map table pointed by mGuardedMemoryMap.\r
+// mMapLevel must be initialized at least by 1. It will be automatically\r
+// updated according to the address of memory just tracked.\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED UINTN mMapLevel = 1;\r
+\r
+//\r
+// Shift and mask for each level of map table\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED UINTN mLevelShift[GUARDED_HEAP_MAP_TABLE_DEPTH]\r
+ = GUARDED_HEAP_MAP_TABLE_DEPTH_SHIFTS;\r
+GLOBAL_REMOVE_IF_UNREFERENCED UINTN mLevelMask[GUARDED_HEAP_MAP_TABLE_DEPTH]\r
+ = GUARDED_HEAP_MAP_TABLE_DEPTH_MASKS;\r
+\r
+//\r
+// SMM memory attribute protocol\r
+//\r
+EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL *mSmmMemoryAttribute = NULL;\r
+\r
+/**\r
+ Set corresponding bits in bitmap table to 1 according to the address.\r
+\r
+ @param[in] Address Start address to set for.\r
+ @param[in] BitNumber Number of bits to set.\r
+ @param[in] BitMap Pointer to bitmap which covers the Address.\r
+\r
+ @return VOID\r
+**/\r
+STATIC\r
+VOID\r
+SetBits (\r
+ IN EFI_PHYSICAL_ADDRESS Address,\r
+ IN UINTN BitNumber,\r
+ IN UINT64 *BitMap\r
+ )\r
+{\r
+ UINTN Lsbs;\r
+ UINTN Qwords;\r
+ UINTN Msbs;\r
+ UINTN StartBit;\r
+ UINTN EndBit;\r
+\r
+ StartBit = (UINTN)GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address);\r
+ EndBit = (StartBit + BitNumber - 1) % GUARDED_HEAP_MAP_ENTRY_BITS;\r
+\r
+ if ((StartBit + BitNumber) > GUARDED_HEAP_MAP_ENTRY_BITS) {\r
+ Msbs = (GUARDED_HEAP_MAP_ENTRY_BITS - StartBit) %\r
+ GUARDED_HEAP_MAP_ENTRY_BITS;\r
+ Lsbs = (EndBit + 1) % GUARDED_HEAP_MAP_ENTRY_BITS;\r
+ Qwords = (BitNumber - Msbs) / GUARDED_HEAP_MAP_ENTRY_BITS;\r
+ } else {\r
+ Msbs = BitNumber;\r
+ Lsbs = 0;\r
+ Qwords = 0;\r
+ }\r
+\r
+ if (Msbs > 0) {\r
+ *BitMap |= LShiftU64 (LShiftU64 (1, Msbs) - 1, StartBit);\r
+ BitMap += 1;\r
+ }\r
+\r
+ if (Qwords > 0) {\r
+ SetMem64 ((VOID *)BitMap, Qwords * GUARDED_HEAP_MAP_ENTRY_BYTES,\r
+ (UINT64)-1);\r
+ BitMap += Qwords;\r
+ }\r
+\r
+ if (Lsbs > 0) {\r
+ *BitMap |= (LShiftU64 (1, Lsbs) - 1);\r
+ }\r
+}\r
+\r
+/**\r
+ Set corresponding bits in bitmap table to 0 according to the address.\r
+\r
+ @param[in] Address Start address to set for.\r
+ @param[in] BitNumber Number of bits to set.\r
+ @param[in] BitMap Pointer to bitmap which covers the Address.\r
+\r
+ @return VOID.\r
+**/\r
+STATIC\r
+VOID\r
+ClearBits (\r
+ IN EFI_PHYSICAL_ADDRESS Address,\r
+ IN UINTN BitNumber,\r
+ IN UINT64 *BitMap\r
+ )\r
+{\r
+ UINTN Lsbs;\r
+ UINTN Qwords;\r
+ UINTN Msbs;\r
+ UINTN StartBit;\r
+ UINTN EndBit;\r
+\r
+ StartBit = (UINTN)GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address);\r
+ EndBit = (StartBit + BitNumber - 1) % GUARDED_HEAP_MAP_ENTRY_BITS;\r
+\r
+ if ((StartBit + BitNumber) > GUARDED_HEAP_MAP_ENTRY_BITS) {\r
+ Msbs = (GUARDED_HEAP_MAP_ENTRY_BITS - StartBit) %\r
+ GUARDED_HEAP_MAP_ENTRY_BITS;\r
+ Lsbs = (EndBit + 1) % GUARDED_HEAP_MAP_ENTRY_BITS;\r
+ Qwords = (BitNumber - Msbs) / GUARDED_HEAP_MAP_ENTRY_BITS;\r
+ } else {\r
+ Msbs = BitNumber;\r
+ Lsbs = 0;\r
+ Qwords = 0;\r
+ }\r
+\r
+ if (Msbs > 0) {\r
+ *BitMap &= ~LShiftU64 (LShiftU64 (1, Msbs) - 1, StartBit);\r
+ BitMap += 1;\r
+ }\r
+\r
+ if (Qwords > 0) {\r
+ SetMem64 ((VOID *)BitMap, Qwords * GUARDED_HEAP_MAP_ENTRY_BYTES, 0);\r
+ BitMap += Qwords;\r
+ }\r
+\r
+ if (Lsbs > 0) {\r
+ *BitMap &= ~(LShiftU64 (1, Lsbs) - 1);\r
+ }\r
+}\r
+\r
+/**\r
+ Get corresponding bits in bitmap table according to the address.\r
+\r
+ The value of bit 0 corresponds to the status of memory at given Address.\r
+ No more than 64 bits can be retrieved in one call.\r
+\r
+ @param[in] Address Start address to retrieve bits for.\r
+ @param[in] BitNumber Number of bits to get.\r
+ @param[in] BitMap Pointer to bitmap which covers the Address.\r
+\r
+ @return An integer containing the bits information.\r
+**/\r
+STATIC\r
+UINT64\r
+GetBits (\r
+ IN EFI_PHYSICAL_ADDRESS Address,\r
+ IN UINTN BitNumber,\r
+ IN UINT64 *BitMap\r
+ )\r
+{\r
+ UINTN StartBit;\r
+ UINTN EndBit;\r
+ UINTN Lsbs;\r
+ UINTN Msbs;\r
+ UINT64 Result;\r
+\r
+ ASSERT (BitNumber <= GUARDED_HEAP_MAP_ENTRY_BITS);\r
+\r
+ StartBit = (UINTN)GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address);\r
+ EndBit = (StartBit + BitNumber - 1) % GUARDED_HEAP_MAP_ENTRY_BITS;\r
+\r
+ if ((StartBit + BitNumber) > GUARDED_HEAP_MAP_ENTRY_BITS) {\r
+ Msbs = GUARDED_HEAP_MAP_ENTRY_BITS - StartBit;\r
+ Lsbs = (EndBit + 1) % GUARDED_HEAP_MAP_ENTRY_BITS;\r
+ } else {\r
+ Msbs = BitNumber;\r
+ Lsbs = 0;\r
+ }\r
+\r
+ Result = RShiftU64 ((*BitMap), StartBit) & (LShiftU64 (1, Msbs) - 1);\r
+ if (Lsbs > 0) {\r
+ BitMap += 1;\r
+ Result |= LShiftU64 ((*BitMap) & (LShiftU64 (1, Lsbs) - 1), Msbs);\r
+ }\r
+\r
+ return Result;\r
+}\r
+\r
+/**\r
+ Helper function to allocate pages without Guard for internal uses.\r
+\r
+ @param[in] Pages Page number.\r
+\r
+ @return Address of memory allocated.\r
+**/\r
+VOID *\r
+PageAlloc (\r
+ IN UINTN Pages\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_PHYSICAL_ADDRESS Memory;\r
+\r
+ Status = SmmInternalAllocatePages (AllocateAnyPages, EfiRuntimeServicesData,\r
+ Pages, &Memory, FALSE);\r
+ if (EFI_ERROR (Status)) {\r
+ Memory = 0;\r
+ }\r
+\r
+ return (VOID *)(UINTN)Memory;\r
+}\r
+\r
+/**\r
+ Locate the pointer of bitmap from the guarded memory bitmap tables, which\r
+ covers the given Address.\r
+\r
+ @param[in] Address Start address to search the bitmap for.\r
+ @param[in] AllocMapUnit Flag to indicate memory allocation for the table.\r
+ @param[out] BitMap Pointer to bitmap which covers the Address.\r
+\r
+ @return The bit number from given Address to the end of current map table.\r
+**/\r
+UINTN\r
+FindGuardedMemoryMap (\r
+ IN EFI_PHYSICAL_ADDRESS Address,\r
+ IN BOOLEAN AllocMapUnit,\r
+ OUT UINT64 **BitMap\r
+ )\r
+{\r
+ UINTN Level;\r
+ UINT64 *GuardMap;\r
+ UINT64 MapMemory;\r
+ UINTN Index;\r
+ UINTN Size;\r
+ UINTN BitsToUnitEnd;\r
+\r
+ //\r
+ // Adjust current map table depth according to the address to access\r
+ //\r
+ while (mMapLevel < GUARDED_HEAP_MAP_TABLE_DEPTH\r
+ &&\r
+ RShiftU64 (\r
+ Address,\r
+ mLevelShift[GUARDED_HEAP_MAP_TABLE_DEPTH - mMapLevel - 1]\r
+ ) != 0) {\r
+\r
+ if (mGuardedMemoryMap != 0) {\r
+ Size = (mLevelMask[GUARDED_HEAP_MAP_TABLE_DEPTH - mMapLevel - 1] + 1)\r
+ * GUARDED_HEAP_MAP_ENTRY_BYTES;\r
+ MapMemory = (UINT64)(UINTN)PageAlloc (EFI_SIZE_TO_PAGES (Size));\r
+ ASSERT (MapMemory != 0);\r
+\r
+ SetMem ((VOID *)(UINTN)MapMemory, Size, 0);\r
+\r
+ *(UINT64 *)(UINTN)MapMemory = mGuardedMemoryMap;\r
+ mGuardedMemoryMap = MapMemory;\r
+ }\r
+\r
+ mMapLevel++;\r
+\r
+ }\r
+\r
+ GuardMap = &mGuardedMemoryMap;\r
+ for (Level = GUARDED_HEAP_MAP_TABLE_DEPTH - mMapLevel;\r
+ Level < GUARDED_HEAP_MAP_TABLE_DEPTH;\r
+ ++Level) {\r
+\r
+ if (*GuardMap == 0) {\r
+ if (!AllocMapUnit) {\r
+ GuardMap = NULL;\r
+ break;\r
+ }\r
+\r
+ Size = (mLevelMask[Level] + 1) * GUARDED_HEAP_MAP_ENTRY_BYTES;\r
+ MapMemory = (UINT64)(UINTN)PageAlloc (EFI_SIZE_TO_PAGES (Size));\r
+ ASSERT (MapMemory != 0);\r
+\r
+ SetMem ((VOID *)(UINTN)MapMemory, Size, 0);\r
+ *GuardMap = MapMemory;\r
+ }\r
+\r
+ Index = (UINTN)RShiftU64 (Address, mLevelShift[Level]);\r
+ Index &= mLevelMask[Level];\r
+ GuardMap = (UINT64 *)(UINTN)((*GuardMap) + Index * sizeof (UINT64));\r
+\r
+ }\r
+\r
+ BitsToUnitEnd = GUARDED_HEAP_MAP_BITS - GUARDED_HEAP_MAP_BIT_INDEX (Address);\r
+ *BitMap = GuardMap;\r
+\r
+ return BitsToUnitEnd;\r
+}\r
+\r
+/**\r
+ Set corresponding bits in bitmap table to 1 according to given memory range.\r
+\r
+ @param[in] Address Memory address to guard from.\r
+ @param[in] NumberOfPages Number of pages to guard.\r
+\r
+ @return VOID\r
+**/\r
+VOID\r
+EFIAPI\r
+SetGuardedMemoryBits (\r
+ IN EFI_PHYSICAL_ADDRESS Address,\r
+ IN UINTN NumberOfPages\r
+ )\r
+{\r
+ UINT64 *BitMap;\r
+ UINTN Bits;\r
+ UINTN BitsToUnitEnd;\r
+\r
+ while (NumberOfPages > 0) {\r
+ BitsToUnitEnd = FindGuardedMemoryMap (Address, TRUE, &BitMap);\r
+ ASSERT (BitMap != NULL);\r
+\r
+ if (NumberOfPages > BitsToUnitEnd) {\r
+ // Cross map unit\r
+ Bits = BitsToUnitEnd;\r
+ } else {\r
+ Bits = NumberOfPages;\r
+ }\r
+\r
+ SetBits (Address, Bits, BitMap);\r
+\r
+ NumberOfPages -= Bits;\r
+ Address += EFI_PAGES_TO_SIZE (Bits);\r
+ }\r
+}\r
+\r
+/**\r
+ Clear corresponding bits in bitmap table according to given memory range.\r
+\r
+ @param[in] Address Memory address to unset from.\r
+ @param[in] NumberOfPages Number of pages to unset guard.\r
+\r
+ @return VOID\r
+**/\r
+VOID\r
+EFIAPI\r
+ClearGuardedMemoryBits (\r
+ IN EFI_PHYSICAL_ADDRESS Address,\r
+ IN UINTN NumberOfPages\r
+ )\r
+{\r
+ UINT64 *BitMap;\r
+ UINTN Bits;\r
+ UINTN BitsToUnitEnd;\r
+\r
+ while (NumberOfPages > 0) {\r
+ BitsToUnitEnd = FindGuardedMemoryMap (Address, TRUE, &BitMap);\r
+ ASSERT (BitMap != NULL);\r
+\r
+ if (NumberOfPages > BitsToUnitEnd) {\r
+ // Cross map unit\r
+ Bits = BitsToUnitEnd;\r
+ } else {\r
+ Bits = NumberOfPages;\r
+ }\r
+\r
+ ClearBits (Address, Bits, BitMap);\r
+\r
+ NumberOfPages -= Bits;\r
+ Address += EFI_PAGES_TO_SIZE (Bits);\r
+ }\r
+}\r
+\r
+/**\r
+ Retrieve corresponding bits in bitmap table according to given memory range.\r
+\r
+ @param[in] Address Memory address to retrieve from.\r
+ @param[in] NumberOfPages Number of pages to retrieve.\r
+\r
+ @return An integer containing the guarded memory bitmap.\r
+**/\r
+UINTN\r
+GetGuardedMemoryBits (\r
+ IN EFI_PHYSICAL_ADDRESS Address,\r
+ IN UINTN NumberOfPages\r
+ )\r
+{\r
+ UINT64 *BitMap;\r
+ UINTN Bits;\r
+ UINTN Result;\r
+ UINTN Shift;\r
+ UINTN BitsToUnitEnd;\r
+\r
+ ASSERT (NumberOfPages <= GUARDED_HEAP_MAP_ENTRY_BITS);\r
+\r
+ Result = 0;\r
+ Shift = 0;\r
+ while (NumberOfPages > 0) {\r
+ BitsToUnitEnd = FindGuardedMemoryMap (Address, FALSE, &BitMap);\r
+\r
+ if (NumberOfPages > BitsToUnitEnd) {\r
+ // Cross map unit\r
+ Bits = BitsToUnitEnd;\r
+ } else {\r
+ Bits = NumberOfPages;\r
+ }\r
+\r
+ if (BitMap != NULL) {\r
+ Result |= LShiftU64 (GetBits (Address, Bits, BitMap), Shift);\r
+ }\r
+\r
+ Shift += Bits;\r
+ NumberOfPages -= Bits;\r
+ Address += EFI_PAGES_TO_SIZE (Bits);\r
+ }\r
+\r
+ return Result;\r
+}\r
+\r
+/**\r
+ Get bit value in bitmap table for the given address.\r
+\r
+ @param[in] Address The address to retrieve for.\r
+\r
+ @return 1 or 0.\r
+**/\r
+UINTN\r
+EFIAPI\r
+GetGuardMapBit (\r
+ IN EFI_PHYSICAL_ADDRESS Address\r
+ )\r
+{\r
+ UINT64 *GuardMap;\r
+\r
+ FindGuardedMemoryMap (Address, FALSE, &GuardMap);\r
+ if (GuardMap != NULL) {\r
+ if (RShiftU64 (*GuardMap,\r
+ GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address)) & 1) {\r
+ return 1;\r
+ }\r
+ }\r
+\r
+ return 0;\r
+}\r
+\r
+/**\r
+ Set the bit in bitmap table for the given address.\r
+\r
+ @param[in] Address The address to set for.\r
+\r
+ @return VOID.\r
+**/\r
+VOID\r
+EFIAPI\r
+SetGuardMapBit (\r
+ IN EFI_PHYSICAL_ADDRESS Address\r
+ )\r
+{\r
+ UINT64 *GuardMap;\r
+ UINT64 BitMask;\r
+\r
+ FindGuardedMemoryMap (Address, TRUE, &GuardMap);\r
+ if (GuardMap != NULL) {\r
+ BitMask = LShiftU64 (1, GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address));\r
+ *GuardMap |= BitMask;\r
+ }\r
+}\r
+\r
+/**\r
+ Clear the bit in bitmap table for the given address.\r
+\r
+ @param[in] Address The address to clear for.\r
+\r
+ @return VOID.\r
+**/\r
+VOID\r
+EFIAPI\r
+ClearGuardMapBit (\r
+ IN EFI_PHYSICAL_ADDRESS Address\r
+ )\r
+{\r
+ UINT64 *GuardMap;\r
+ UINT64 BitMask;\r
+\r
+ FindGuardedMemoryMap (Address, TRUE, &GuardMap);\r
+ if (GuardMap != NULL) {\r
+ BitMask = LShiftU64 (1, GUARDED_HEAP_MAP_ENTRY_BIT_INDEX (Address));\r
+ *GuardMap &= ~BitMask;\r
+ }\r
+}\r
+\r
+/**\r
+ Check to see if the page at the given address is a Guard page or not.\r
+\r
+ @param[in] Address The address to check for.\r
+\r
+ @return TRUE The page at Address is a Guard page.\r
+ @return FALSE The page at Address is not a Guard page.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsGuardPage (\r
+ IN EFI_PHYSICAL_ADDRESS Address\r
+)\r
+{\r
+ UINTN BitMap;\r
+\r
+ //\r
+ // There must be at least one guarded page before and/or after given\r
+ // address if it's a Guard page. The bitmap pattern should be one of\r
+ // 001, 100 and 101\r
+ //\r
+ BitMap = GetGuardedMemoryBits (Address - EFI_PAGE_SIZE, 3);\r
+ return ((BitMap == BIT0) || (BitMap == BIT2) || (BitMap == (BIT2 | BIT0)));\r
+}\r
+\r
+/**\r
+ Check to see if the page at the given address is a head Guard page or not.\r
+\r
+ @param[in] Address The address to check for.\r
+\r
+ @return TRUE The page at Address is a head Guard page.\r
+ @return FALSE The page at Address is not a head Guard page.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsHeadGuard (\r
+ IN EFI_PHYSICAL_ADDRESS Address\r
+ )\r
+{\r
+ return (GetGuardedMemoryBits (Address, 2) == BIT1);\r
+}\r
+\r
+/**\r
+ Check to see if the page at the given address is a tail Guard page or not.\r
+\r
+ @param[in] Address The address to check for.\r
+\r
+ @return TRUE The page at Address is a tail Guard page.\r
+ @return FALSE The page at Address is not a tail Guard page.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsTailGuard (\r
+ IN EFI_PHYSICAL_ADDRESS Address\r
+ )\r
+{\r
+ return (GetGuardedMemoryBits (Address - EFI_PAGE_SIZE, 2) == BIT0);\r
+}\r
+\r
+/**\r
+ Check to see if the page at the given address is guarded or not.\r
+\r
+ @param[in] Address The address to check for.\r
+\r
+ @return TRUE The page at Address is guarded.\r
+ @return FALSE The page at Address is not guarded.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsMemoryGuarded (\r
+ IN EFI_PHYSICAL_ADDRESS Address\r
+ )\r
+{\r
+ return (GetGuardMapBit (Address) == 1);\r
+}\r
+\r
+/**\r
+ Set the page at the given address to be a Guard page.\r
+\r
+ This is done by changing the page table attribute to be NOT PRSENT.\r
+\r
+ @param[in] BaseAddress Page address to Guard at.\r
+\r
+ @return VOID.\r
+**/\r
+VOID\r
+EFIAPI\r
+SetGuardPage (\r
+ IN EFI_PHYSICAL_ADDRESS BaseAddress\r
+ )\r
+{\r
+ if (mSmmMemoryAttribute != NULL) {\r
+ mOnGuarding = TRUE;\r
+ mSmmMemoryAttribute->SetMemoryAttributes (\r
+ mSmmMemoryAttribute,\r
+ BaseAddress,\r
+ EFI_PAGE_SIZE,\r
+ EFI_MEMORY_RP\r
+ );\r
+ mOnGuarding = FALSE;\r
+ }\r
+}\r
+\r
+/**\r
+ Unset the Guard page at the given address to the normal memory.\r
+\r
+ This is done by changing the page table attribute to be PRSENT.\r
+\r
+ @param[in] BaseAddress Page address to Guard at.\r
+\r
+ @return VOID.\r
+**/\r
+VOID\r
+EFIAPI\r
+UnsetGuardPage (\r
+ IN EFI_PHYSICAL_ADDRESS BaseAddress\r
+ )\r
+{\r
+ if (mSmmMemoryAttribute != NULL) {\r
+ mOnGuarding = TRUE;\r
+ mSmmMemoryAttribute->ClearMemoryAttributes (\r
+ mSmmMemoryAttribute,\r
+ BaseAddress,\r
+ EFI_PAGE_SIZE,\r
+ EFI_MEMORY_RP\r
+ );\r
+ mOnGuarding = FALSE;\r
+ }\r
+}\r
+\r
+/**\r
+ Check to see if the memory at the given address should be guarded or not.\r
+\r
+ @param[in] MemoryType Memory type to check.\r
+ @param[in] AllocateType Allocation type to check.\r
+ @param[in] PageOrPool Indicate a page allocation or pool allocation.\r
+\r
+\r
+ @return TRUE The given type of memory should be guarded.\r
+ @return FALSE The given type of memory should not be guarded.\r
+**/\r
+BOOLEAN\r
+IsMemoryTypeToGuard (\r
+ IN EFI_MEMORY_TYPE MemoryType,\r
+ IN EFI_ALLOCATE_TYPE AllocateType,\r
+ IN UINT8 PageOrPool\r
+ )\r
+{\r
+ UINT64 TestBit;\r
+ UINT64 ConfigBit;\r
+\r
+ if ((PcdGet8 (PcdHeapGuardPropertyMask) & PageOrPool) == 0\r
+ || mOnGuarding\r
+ || AllocateType == AllocateAddress) {\r
+ return FALSE;\r
+ }\r
+\r
+ ConfigBit = 0;\r
+ if ((PageOrPool & GUARD_HEAP_TYPE_POOL) != 0) {\r
+ ConfigBit |= PcdGet64 (PcdHeapGuardPoolType);\r
+ }\r
+\r
+ if ((PageOrPool & GUARD_HEAP_TYPE_PAGE) != 0) {\r
+ ConfigBit |= PcdGet64 (PcdHeapGuardPageType);\r
+ }\r
+\r
+ if (MemoryType == EfiRuntimeServicesData ||\r
+ MemoryType == EfiRuntimeServicesCode) {\r
+ TestBit = LShiftU64 (1, MemoryType);\r
+ } else if (MemoryType == EfiMaxMemoryType) {\r
+ TestBit = (UINT64)-1;\r
+ } else {\r
+ TestBit = 0;\r
+ }\r
+\r
+ return ((ConfigBit & TestBit) != 0);\r
+}\r
+\r
+/**\r
+ Check to see if the pool at the given address should be guarded or not.\r
+\r
+ @param[in] MemoryType Pool type to check.\r
+\r
+\r
+ @return TRUE The given type of pool should be guarded.\r
+ @return FALSE The given type of pool should not be guarded.\r
+**/\r
+BOOLEAN\r
+IsPoolTypeToGuard (\r
+ IN EFI_MEMORY_TYPE MemoryType\r
+ )\r
+{\r
+ return IsMemoryTypeToGuard (MemoryType, AllocateAnyPages,\r
+ GUARD_HEAP_TYPE_POOL);\r
+}\r
+\r
+/**\r
+ Check to see if the page at the given address should be guarded or not.\r
+\r
+ @param[in] MemoryType Page type to check.\r
+ @param[in] AllocateType Allocation type to check.\r
+\r
+ @return TRUE The given type of page should be guarded.\r
+ @return FALSE The given type of page should not be guarded.\r
+**/\r
+BOOLEAN\r
+IsPageTypeToGuard (\r
+ IN EFI_MEMORY_TYPE MemoryType,\r
+ IN EFI_ALLOCATE_TYPE AllocateType\r
+ )\r
+{\r
+ return IsMemoryTypeToGuard (MemoryType, AllocateType, GUARD_HEAP_TYPE_PAGE);\r
+}\r
+\r
+/**\r
+ Check to see if the heap guard is enabled for page and/or pool allocation.\r
+\r
+ @return TRUE/FALSE.\r
+**/\r
+BOOLEAN\r
+IsHeapGuardEnabled (\r
+ VOID\r
+ )\r
+{\r
+ return IsMemoryTypeToGuard (EfiMaxMemoryType, AllocateAnyPages,\r
+ GUARD_HEAP_TYPE_POOL|GUARD_HEAP_TYPE_PAGE);\r
+}\r
+\r
+/**\r
+ Set head Guard and tail Guard for the given memory range.\r
+\r
+ @param[in] Memory Base address of memory to set guard for.\r
+ @param[in] NumberOfPages Memory size in pages.\r
+\r
+ @return VOID.\r
+**/\r
+VOID\r
+SetGuardForMemory (\r
+ IN EFI_PHYSICAL_ADDRESS Memory,\r
+ IN UINTN NumberOfPages\r
+ )\r
+{\r
+ EFI_PHYSICAL_ADDRESS GuardPage;\r
+\r
+ //\r
+ // Set tail Guard\r
+ //\r
+ GuardPage = Memory + EFI_PAGES_TO_SIZE (NumberOfPages);\r
+ if (!IsGuardPage (GuardPage)) {\r
+ SetGuardPage (GuardPage);\r
+ }\r
+\r
+ // Set head Guard\r
+ GuardPage = Memory - EFI_PAGES_TO_SIZE (1);\r
+ if (!IsGuardPage (GuardPage)) {\r
+ SetGuardPage (GuardPage);\r
+ }\r
+\r
+ //\r
+ // Mark the memory range as Guarded\r
+ //\r
+ SetGuardedMemoryBits (Memory, NumberOfPages);\r
+}\r
+\r
+/**\r
+ Unset head Guard and tail Guard for the given memory range.\r
+\r
+ @param[in] Memory Base address of memory to unset guard for.\r
+ @param[in] NumberOfPages Memory size in pages.\r
+\r
+ @return VOID.\r
+**/\r
+VOID\r
+UnsetGuardForMemory (\r
+ IN EFI_PHYSICAL_ADDRESS Memory,\r
+ IN UINTN NumberOfPages\r
+ )\r
+{\r
+ EFI_PHYSICAL_ADDRESS GuardPage;\r
+\r
+ if (NumberOfPages == 0) {\r
+ return;\r
+ }\r
+\r
+ //\r
+ // Head Guard must be one page before, if any.\r
+ //\r
+ GuardPage = Memory - EFI_PAGES_TO_SIZE (1);\r
+ if (IsHeadGuard (GuardPage)) {\r
+ if (!IsMemoryGuarded (GuardPage - EFI_PAGES_TO_SIZE (1))) {\r
+ //\r
+ // If the head Guard is not a tail Guard of adjacent memory block,\r
+ // unset it.\r
+ //\r
+ UnsetGuardPage (GuardPage);\r
+ }\r
+ } else if (IsMemoryGuarded (GuardPage)) {\r
+ //\r
+ // Pages before memory to free are still in Guard. It's a partial free\r
+ // case. Turn first page of memory block to free into a new Guard.\r
+ //\r
+ SetGuardPage (Memory);\r
+ }\r
+\r
+ //\r
+ // Tail Guard must be the page after this memory block to free, if any.\r
+ //\r
+ GuardPage = Memory + EFI_PAGES_TO_SIZE (NumberOfPages);\r
+ if (IsTailGuard (GuardPage)) {\r
+ if (!IsMemoryGuarded (GuardPage + EFI_PAGES_TO_SIZE (1))) {\r
+ //\r
+ // If the tail Guard is not a head Guard of adjacent memory block,\r
+ // free it; otherwise, keep it.\r
+ //\r
+ UnsetGuardPage (GuardPage);\r
+ }\r
+ } else if (IsMemoryGuarded (GuardPage)) {\r
+ //\r
+ // Pages after memory to free are still in Guard. It's a partial free\r
+ // case. We need to keep one page to be a head Guard.\r
+ //\r
+ SetGuardPage (GuardPage - EFI_PAGES_TO_SIZE (1));\r
+ }\r
+\r
+ //\r
+ // No matter what, we just clear the mark of the Guarded memory.\r
+ //\r
+ ClearGuardedMemoryBits(Memory, NumberOfPages);\r
+}\r
+\r
+/**\r
+ Adjust address of free memory according to existing and/or required Guard.\r
+\r
+ This function will check if there're existing Guard pages of adjacent\r
+ memory blocks, and try to use it as the Guard page of the memory to be\r
+ allocated.\r
+\r
+ @param[in] Start Start address of free memory block.\r
+ @param[in] Size Size of free memory block.\r
+ @param[in] SizeRequested Size of memory to allocate.\r
+\r
+ @return The end address of memory block found.\r
+ @return 0 if no enough space for the required size of memory and its Guard.\r
+**/\r
+UINT64\r
+AdjustMemoryS (\r
+ IN UINT64 Start,\r
+ IN UINT64 Size,\r
+ IN UINT64 SizeRequested\r
+ )\r
+{\r
+ UINT64 Target;\r
+\r
+ Target = Start + Size - SizeRequested;\r
+\r
+ //\r
+ // At least one more page needed for Guard page.\r
+ //\r
+ if (Size < (SizeRequested + EFI_PAGES_TO_SIZE (1))) {\r
+ return 0;\r
+ }\r
+\r
+ if (!IsGuardPage (Start + Size)) {\r
+ // No Guard at tail to share. One more page is needed.\r
+ Target -= EFI_PAGES_TO_SIZE (1);\r
+ }\r
+\r
+ // Out of range?\r
+ if (Target < Start) {\r
+ return 0;\r
+ }\r
+\r
+ // At the edge?\r
+ if (Target == Start) {\r
+ if (!IsGuardPage (Target - EFI_PAGES_TO_SIZE (1))) {\r
+ // No enough space for a new head Guard if no Guard at head to share.\r
+ return 0;\r
+ }\r
+ }\r
+\r
+ // OK, we have enough pages for memory and its Guards. Return the End of the\r
+ // free space.\r
+ return Target + SizeRequested - 1;\r
+}\r
+\r
+/**\r
+ Adjust the start address and number of pages to free according to Guard.\r
+\r
+ The purpose of this function is to keep the shared Guard page with adjacent\r
+ memory block if it's still in guard, or free it if no more sharing. Another\r
+ is to reserve pages as Guard pages in partial page free situation.\r
+\r
+ @param[in,out] Memory Base address of memory to free.\r
+ @param[in,out] NumberOfPages Size of memory to free.\r
+\r
+ @return VOID.\r
+**/\r
+VOID\r
+AdjustMemoryF (\r
+ IN OUT EFI_PHYSICAL_ADDRESS *Memory,\r
+ IN OUT UINTN *NumberOfPages\r
+ )\r
+{\r
+ EFI_PHYSICAL_ADDRESS Start;\r
+ EFI_PHYSICAL_ADDRESS MemoryToTest;\r
+ UINTN PagesToFree;\r
+\r
+ if (Memory == NULL || NumberOfPages == NULL || *NumberOfPages == 0) {\r
+ return;\r
+ }\r
+\r
+ Start = *Memory;\r
+ PagesToFree = *NumberOfPages;\r
+\r
+ //\r
+ // Head Guard must be one page before, if any.\r
+ //\r
+ MemoryToTest = Start - EFI_PAGES_TO_SIZE (1);\r
+ if (IsHeadGuard (MemoryToTest)) {\r
+ if (!IsMemoryGuarded (MemoryToTest - EFI_PAGES_TO_SIZE (1))) {\r
+ //\r
+ // If the head Guard is not a tail Guard of adjacent memory block,\r
+ // free it; otherwise, keep it.\r
+ //\r
+ Start -= EFI_PAGES_TO_SIZE (1);\r
+ PagesToFree += 1;\r
+ }\r
+ } else if (IsMemoryGuarded (MemoryToTest)) {\r
+ //\r
+ // Pages before memory to free are still in Guard. It's a partial free\r
+ // case. We need to keep one page to be a tail Guard.\r
+ //\r
+ Start += EFI_PAGES_TO_SIZE (1);\r
+ PagesToFree -= 1;\r
+ }\r
+\r
+ //\r
+ // Tail Guard must be the page after this memory block to free, if any.\r
+ //\r
+ MemoryToTest = Start + EFI_PAGES_TO_SIZE (PagesToFree);\r
+ if (IsTailGuard (MemoryToTest)) {\r
+ if (!IsMemoryGuarded (MemoryToTest + EFI_PAGES_TO_SIZE (1))) {\r
+ //\r
+ // If the tail Guard is not a head Guard of adjacent memory block,\r
+ // free it; otherwise, keep it.\r
+ //\r
+ PagesToFree += 1;\r
+ }\r
+ } else if (IsMemoryGuarded (MemoryToTest)) {\r
+ //\r
+ // Pages after memory to free are still in Guard. It's a partial free\r
+ // case. We need to keep one page to be a head Guard.\r
+ //\r
+ PagesToFree -= 1;\r
+ }\r
+\r
+ *Memory = Start;\r
+ *NumberOfPages = PagesToFree;\r
+}\r
+\r
+/**\r
+ Adjust the base and number of pages to really allocate according to Guard.\r
+\r
+ @param[in,out] Memory Base address of free memory.\r
+ @param[in,out] NumberOfPages Size of memory to allocate.\r
+\r
+ @return VOID.\r
+**/\r
+VOID\r
+AdjustMemoryA (\r
+ IN OUT EFI_PHYSICAL_ADDRESS *Memory,\r
+ IN OUT UINTN *NumberOfPages\r
+ )\r
+{\r
+ //\r
+ // FindFreePages() has already taken the Guard into account. It's safe to\r
+ // adjust the start address and/or number of pages here, to make sure that\r
+ // the Guards are also "allocated".\r
+ //\r
+ if (!IsGuardPage (*Memory + EFI_PAGES_TO_SIZE (*NumberOfPages))) {\r
+ // No tail Guard, add one.\r
+ *NumberOfPages += 1;\r
+ }\r
+\r
+ if (!IsGuardPage (*Memory - EFI_PAGE_SIZE)) {\r
+ // No head Guard, add one.\r
+ *Memory -= EFI_PAGE_SIZE;\r
+ *NumberOfPages += 1;\r
+ }\r
+}\r
+\r
+/**\r
+ Adjust the pool head position to make sure the Guard page is adjavent to\r
+ pool tail or pool head.\r
+\r
+ @param[in] Memory Base address of memory allocated.\r
+ @param[in] NoPages Number of pages actually allocated.\r
+ @param[in] Size Size of memory requested.\r
+ (plus pool head/tail overhead)\r
+\r
+ @return Address of pool head\r
+**/\r
+VOID *\r
+AdjustPoolHeadA (\r
+ IN EFI_PHYSICAL_ADDRESS Memory,\r
+ IN UINTN NoPages,\r
+ IN UINTN Size\r
+ )\r
+{\r
+ if ((PcdGet8 (PcdHeapGuardPropertyMask) & BIT7) != 0) {\r
+ //\r
+ // Pool head is put near the head Guard\r
+ //\r
+ return (VOID *)(UINTN)Memory;\r
+ }\r
+\r
+ //\r
+ // Pool head is put near the tail Guard\r
+ //\r
+ return (VOID *)(UINTN)(Memory + EFI_PAGES_TO_SIZE (NoPages) - Size);\r
+}\r
+\r
+/**\r
+ Get the page base address according to pool head address.\r
+\r
+ @param[in] Memory Head address of pool to free.\r
+\r
+ @return Address of pool head.\r
+**/\r
+VOID *\r
+AdjustPoolHeadF (\r
+ IN EFI_PHYSICAL_ADDRESS Memory\r
+ )\r
+{\r
+ if ((PcdGet8 (PcdHeapGuardPropertyMask) & BIT7) != 0) {\r
+ //\r
+ // Pool head is put near the head Guard\r
+ //\r
+ return (VOID *)(UINTN)Memory;\r
+ }\r
+\r
+ //\r
+ // Pool head is put near the tail Guard\r
+ //\r
+ return (VOID *)(UINTN)(Memory & ~EFI_PAGE_MASK);\r
+}\r
+\r
+/**\r
+ Helper function of memory allocation with Guard pages.\r
+\r
+ @param FreePageList The free page node.\r
+ @param NumberOfPages Number of pages to be allocated.\r
+ @param MaxAddress Request to allocate memory below this address.\r
+ @param MemoryType Type of memory requested.\r
+\r
+ @return Memory address of allocated pages.\r
+**/\r
+UINTN\r
+InternalAllocMaxAddressWithGuard (\r
+ IN OUT LIST_ENTRY *FreePageList,\r
+ IN UINTN NumberOfPages,\r
+ IN UINTN MaxAddress,\r
+ IN EFI_MEMORY_TYPE MemoryType\r
+\r
+ )\r
+{\r
+ LIST_ENTRY *Node;\r
+ FREE_PAGE_LIST *Pages;\r
+ UINTN PagesToAlloc;\r
+ UINTN HeadGuard;\r
+ UINTN TailGuard;\r
+ UINTN Address;\r
+\r
+ for (Node = FreePageList->BackLink; Node != FreePageList;\r
+ Node = Node->BackLink) {\r
+ Pages = BASE_CR (Node, FREE_PAGE_LIST, Link);\r
+ if (Pages->NumberOfPages >= NumberOfPages &&\r
+ (UINTN)Pages + EFI_PAGES_TO_SIZE (NumberOfPages) - 1 <= MaxAddress) {\r
+\r
+ //\r
+ // We may need 1 or 2 more pages for Guard. Check it out.\r
+ //\r
+ PagesToAlloc = NumberOfPages;\r
+ TailGuard = (UINTN)Pages + EFI_PAGES_TO_SIZE (Pages->NumberOfPages);\r
+ if (!IsGuardPage (TailGuard)) {\r
+ //\r
+ // Add one if no Guard at the end of current free memory block.\r
+ //\r
+ PagesToAlloc += 1;\r
+ TailGuard = 0;\r
+ }\r
+\r
+ HeadGuard = (UINTN)Pages +\r
+ EFI_PAGES_TO_SIZE (Pages->NumberOfPages - PagesToAlloc) -\r
+ EFI_PAGE_SIZE;\r
+ if (!IsGuardPage (HeadGuard)) {\r
+ //\r
+ // Add one if no Guard at the page before the address to allocate\r
+ //\r
+ PagesToAlloc += 1;\r
+ HeadGuard = 0;\r
+ }\r
+\r
+ if (Pages->NumberOfPages < PagesToAlloc) {\r
+ // Not enough space to allocate memory with Guards? Try next block.\r
+ continue;\r
+ }\r
+\r
+ Address = InternalAllocPagesOnOneNode (Pages, PagesToAlloc, MaxAddress);\r
+ ConvertSmmMemoryMapEntry(MemoryType, Address, PagesToAlloc, FALSE);\r
+ CoreFreeMemoryMapStack();\r
+ if (HeadGuard == 0) {\r
+ // Don't pass the Guard page to user.\r
+ Address += EFI_PAGE_SIZE;\r
+ }\r
+ SetGuardForMemory (Address, NumberOfPages);\r
+ return Address;\r
+ }\r
+ }\r
+\r
+ return (UINTN)(-1);\r
+}\r
+\r
+/**\r
+ Helper function of memory free with Guard pages.\r
+\r
+ @param[in] Memory Base address of memory being freed.\r
+ @param[in] NumberOfPages The number of pages to free.\r
+ @param[in] AddRegion If this memory is new added region.\r
+\r
+ @retval EFI_NOT_FOUND Could not find the entry that covers the range.\r
+ @retval EFI_INVALID_PARAMETER Address not aligned, Address is zero or NumberOfPages is zero.\r
+ @return EFI_SUCCESS Pages successfully freed.\r
+**/\r
+EFI_STATUS\r
+SmmInternalFreePagesExWithGuard (\r
+ IN EFI_PHYSICAL_ADDRESS Memory,\r
+ IN UINTN NumberOfPages,\r
+ IN BOOLEAN AddRegion\r
+ )\r
+{\r
+ EFI_PHYSICAL_ADDRESS MemoryToFree;\r
+ UINTN PagesToFree;\r
+\r
+ MemoryToFree = Memory;\r
+ PagesToFree = NumberOfPages;\r
+\r
+ AdjustMemoryF (&MemoryToFree, &PagesToFree);\r
+ UnsetGuardForMemory (Memory, NumberOfPages);\r
+\r
+ return SmmInternalFreePagesEx (MemoryToFree, PagesToFree, AddRegion);\r
+}\r
+\r
+/**\r
+ Set all Guard pages which cannot be set during the non-SMM mode time.\r
+**/\r
+VOID\r
+SetAllGuardPages (\r
+ VOID\r
+ )\r
+{\r
+ UINTN Entries[GUARDED_HEAP_MAP_TABLE_DEPTH];\r
+ UINTN Shifts[GUARDED_HEAP_MAP_TABLE_DEPTH];\r
+ UINTN Indices[GUARDED_HEAP_MAP_TABLE_DEPTH];\r
+ UINT64 Tables[GUARDED_HEAP_MAP_TABLE_DEPTH];\r
+ UINT64 Addresses[GUARDED_HEAP_MAP_TABLE_DEPTH];\r
+ UINT64 TableEntry;\r
+ UINT64 Address;\r
+ UINT64 GuardPage;\r
+ INTN Level;\r
+ UINTN Index;\r
+ BOOLEAN OnGuarding;\r
+\r
+ if (mGuardedMemoryMap == 0) {\r
+ return;\r
+ }\r
+\r
+ CopyMem (Entries, mLevelMask, sizeof (Entries));\r
+ CopyMem (Shifts, mLevelShift, sizeof (Shifts));\r
+\r
+ SetMem (Tables, sizeof(Tables), 0);\r
+ SetMem (Addresses, sizeof(Addresses), 0);\r
+ SetMem (Indices, sizeof(Indices), 0);\r
+\r
+ Level = GUARDED_HEAP_MAP_TABLE_DEPTH - mMapLevel;\r
+ Tables[Level] = mGuardedMemoryMap;\r
+ Address = 0;\r
+ OnGuarding = FALSE;\r
+\r
+ DEBUG_CODE (\r
+ DumpGuardedMemoryBitmap ();\r
+ );\r
+\r
+ while (TRUE) {\r
+ if (Indices[Level] > Entries[Level]) {\r
+ Tables[Level] = 0;\r
+ Level -= 1;\r
+ } else {\r
+\r
+ TableEntry = ((UINT64 *)(UINTN)(Tables[Level]))[Indices[Level]];\r
+ Address = Addresses[Level];\r
+\r
+ if (TableEntry == 0) {\r
+\r
+ OnGuarding = FALSE;\r
+\r
+ } else if (Level < GUARDED_HEAP_MAP_TABLE_DEPTH - 1) {\r
+\r
+ Level += 1;\r
+ Tables[Level] = TableEntry;\r
+ Addresses[Level] = Address;\r
+ Indices[Level] = 0;\r
+\r
+ continue;\r
+\r
+ } else {\r
+\r
+ Index = 0;\r
+ while (Index < GUARDED_HEAP_MAP_ENTRY_BITS) {\r
+ if ((TableEntry & 1) == 1) {\r
+ if (OnGuarding) {\r
+ GuardPage = 0;\r
+ } else {\r
+ GuardPage = Address - EFI_PAGE_SIZE;\r
+ }\r
+ OnGuarding = TRUE;\r
+ } else {\r
+ if (OnGuarding) {\r
+ GuardPage = Address;\r
+ } else {\r
+ GuardPage = 0;\r
+ }\r
+ OnGuarding = FALSE;\r
+ }\r
+\r
+ if (GuardPage != 0) {\r
+ SetGuardPage (GuardPage);\r
+ }\r
+\r
+ if (TableEntry == 0) {\r
+ break;\r
+ }\r
+\r
+ TableEntry = RShiftU64 (TableEntry, 1);\r
+ Address += EFI_PAGE_SIZE;\r
+ Index += 1;\r
+ }\r
+ }\r
+ }\r
+\r
+ if (Level < (GUARDED_HEAP_MAP_TABLE_DEPTH - (INTN)mMapLevel)) {\r
+ break;\r
+ }\r
+\r
+ Indices[Level] += 1;\r
+ Address = (Level == 0) ? 0 : Addresses[Level - 1];\r
+ Addresses[Level] = Address | LShiftU64(Indices[Level], Shifts[Level]);\r
+\r
+ }\r
+}\r
+\r
+/**\r
+ Hook function used to set all Guard pages after entering SMM mode.\r
+**/\r
+VOID\r
+SmmEntryPointMemoryManagementHook (\r
+ VOID\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ if (mSmmMemoryAttribute == NULL) {\r
+ Status = SmmLocateProtocol (\r
+ &gEdkiiSmmMemoryAttributeProtocolGuid,\r
+ NULL,\r
+ (VOID **)&mSmmMemoryAttribute\r
+ );\r
+ if (!EFI_ERROR(Status)) {\r
+ SetAllGuardPages ();\r
+ }\r
+ }\r
+}\r
+\r
+/**\r
+ Helper function to convert a UINT64 value in binary to a string.\r
+\r
+ @param[in] Value Value of a UINT64 integer.\r
+ @param[out] BinString String buffer to contain the conversion result.\r
+\r
+ @return VOID.\r
+**/\r
+VOID\r
+Uint64ToBinString (\r
+ IN UINT64 Value,\r
+ OUT CHAR8 *BinString\r
+ )\r
+{\r
+ UINTN Index;\r
+\r
+ if (BinString == NULL) {\r
+ return;\r
+ }\r
+\r
+ for (Index = 64; Index > 0; --Index) {\r
+ BinString[Index - 1] = '0' + (Value & 1);\r
+ Value = RShiftU64 (Value, 1);\r
+ }\r
+ BinString[64] = '\0';\r
+}\r
+\r
+/**\r
+ Dump the guarded memory bit map.\r
+**/\r
+VOID\r
+EFIAPI\r
+DumpGuardedMemoryBitmap (\r
+ VOID\r
+ )\r
+{\r
+ UINTN Entries[GUARDED_HEAP_MAP_TABLE_DEPTH];\r
+ UINTN Shifts[GUARDED_HEAP_MAP_TABLE_DEPTH];\r
+ UINTN Indices[GUARDED_HEAP_MAP_TABLE_DEPTH];\r
+ UINT64 Tables[GUARDED_HEAP_MAP_TABLE_DEPTH];\r
+ UINT64 Addresses[GUARDED_HEAP_MAP_TABLE_DEPTH];\r
+ UINT64 TableEntry;\r
+ UINT64 Address;\r
+ INTN Level;\r
+ UINTN RepeatZero;\r
+ CHAR8 String[GUARDED_HEAP_MAP_ENTRY_BITS + 1];\r
+ CHAR8 *Ruler1;\r
+ CHAR8 *Ruler2;\r
+\r
+ if (mGuardedMemoryMap == 0) {\r
+ return;\r
+ }\r
+\r
+ Ruler1 = " 3 2 1 0";\r
+ Ruler2 = "FEDCBA9876543210FEDCBA9876543210FEDCBA9876543210FEDCBA9876543210";\r
+\r
+ DEBUG ((HEAP_GUARD_DEBUG_LEVEL, "============================="\r
+ " Guarded Memory Bitmap "\r
+ "==============================\r\n"));\r
+ DEBUG ((HEAP_GUARD_DEBUG_LEVEL, " %a\r\n", Ruler1));\r
+ DEBUG ((HEAP_GUARD_DEBUG_LEVEL, " %a\r\n", Ruler2));\r
+\r
+ CopyMem (Entries, mLevelMask, sizeof (Entries));\r
+ CopyMem (Shifts, mLevelShift, sizeof (Shifts));\r
+\r
+ SetMem (Indices, sizeof(Indices), 0);\r
+ SetMem (Tables, sizeof(Tables), 0);\r
+ SetMem (Addresses, sizeof(Addresses), 0);\r
+\r
+ Level = GUARDED_HEAP_MAP_TABLE_DEPTH - mMapLevel;\r
+ Tables[Level] = mGuardedMemoryMap;\r
+ Address = 0;\r
+ RepeatZero = 0;\r
+\r
+ while (TRUE) {\r
+ if (Indices[Level] > Entries[Level]) {\r
+\r
+ Tables[Level] = 0;\r
+ Level -= 1;\r
+ RepeatZero = 0;\r
+\r
+ DEBUG ((\r
+ HEAP_GUARD_DEBUG_LEVEL,\r
+ "========================================="\r
+ "=========================================\r\n"\r
+ ));\r
+\r
+ } else {\r
+\r
+ TableEntry = ((UINT64 *)(UINTN)Tables[Level])[Indices[Level]];\r
+ Address = Addresses[Level];\r
+\r
+ if (TableEntry == 0) {\r
+\r
+ if (Level == GUARDED_HEAP_MAP_TABLE_DEPTH - 1) {\r
+ if (RepeatZero == 0) {\r
+ Uint64ToBinString(TableEntry, String);\r
+ DEBUG ((HEAP_GUARD_DEBUG_LEVEL, "%016lx: %a\r\n", Address, String));\r
+ } else if (RepeatZero == 1) {\r
+ DEBUG ((HEAP_GUARD_DEBUG_LEVEL, "... : ...\r\n"));\r
+ }\r
+ RepeatZero += 1;\r
+ }\r
+\r
+ } else if (Level < GUARDED_HEAP_MAP_TABLE_DEPTH - 1) {\r
+\r
+ Level += 1;\r
+ Tables[Level] = TableEntry;\r
+ Addresses[Level] = Address;\r
+ Indices[Level] = 0;\r
+ RepeatZero = 0;\r
+\r
+ continue;\r
+\r
+ } else {\r
+\r
+ RepeatZero = 0;\r
+ Uint64ToBinString(TableEntry, String);\r
+ DEBUG ((HEAP_GUARD_DEBUG_LEVEL, "%016lx: %a\r\n", Address, String));\r
+\r
+ }\r
+ }\r
+\r
+ if (Level < (GUARDED_HEAP_MAP_TABLE_DEPTH - (INTN)mMapLevel)) {\r
+ break;\r
+ }\r
+\r
+ Indices[Level] += 1;\r
+ Address = (Level == 0) ? 0 : Addresses[Level - 1];\r
+ Addresses[Level] = Address | LShiftU64(Indices[Level], Shifts[Level]);\r
+\r
+ }\r
+}\r
+\r
+/**\r
+ Debug function used to verify if the Guard page is well set or not.\r
+\r
+ @param[in] BaseAddress Address of memory to check.\r
+ @param[in] NumberOfPages Size of memory in pages.\r
+\r
+ @return TRUE The head Guard and tail Guard are both well set.\r
+ @return FALSE The head Guard and/or tail Guard are not well set.\r
+**/\r
+BOOLEAN\r
+VerifyMemoryGuard (\r
+ IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
+ IN UINTN NumberOfPages\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINT64 Attribute;\r
+ EFI_PHYSICAL_ADDRESS Address;\r
+\r
+ if (mSmmMemoryAttribute == NULL) {\r
+ return TRUE;\r
+ }\r
+\r
+ Attribute = 0;\r
+ Address = BaseAddress - EFI_PAGE_SIZE;\r
+ Status = mSmmMemoryAttribute->GetMemoryAttributes (\r
+ mSmmMemoryAttribute,\r
+ Address,\r
+ EFI_PAGE_SIZE,\r
+ &Attribute\r
+ );\r
+ if (EFI_ERROR (Status) || (Attribute & EFI_MEMORY_RP) == 0) {\r
+ DEBUG ((DEBUG_ERROR, "Head Guard is not set at: %016lx (%016lX)!!!\r\n",\r
+ Address, Attribute));\r
+ DumpGuardedMemoryBitmap ();\r
+ return FALSE;\r
+ }\r
+\r
+ Attribute = 0;\r
+ Address = BaseAddress + EFI_PAGES_TO_SIZE (NumberOfPages);\r
+ Status = mSmmMemoryAttribute->GetMemoryAttributes (\r
+ mSmmMemoryAttribute,\r
+ Address,\r
+ EFI_PAGE_SIZE,\r
+ &Attribute\r
+ );\r
+ if (EFI_ERROR (Status) || (Attribute & EFI_MEMORY_RP) == 0) {\r
+ DEBUG ((DEBUG_ERROR, "Tail Guard is not set at: %016lx (%016lX)!!!\r\n",\r
+ Address, Attribute));\r
+ DumpGuardedMemoryBitmap ();\r
+ return FALSE;\r
+ }\r
+\r
+ return TRUE;\r
+}\r
+\r
projects / mirror_edk2.git / commitdiff