3 Virtual Memory Management Services to set or clear the memory encryption bit
5 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
6 Copyright (c) 2017 - 2020, AMD Incorporated. All rights reserved.<BR>
8 SPDX-License-Identifier: BSD-2-Clause-Patent
10 Code is derived from MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
14 #include <Library/CpuLib.h>
15 #include <Library/MemEncryptSevLib.h>
16 #include <Register/Amd/Cpuid.h>
17 #include <Register/Cpuid.h>
19 #include "VirtualMemory.h"
21 STATIC BOOLEAN mAddressEncMaskChecked
= FALSE
;
22 STATIC UINT64 mAddressEncMask
;
23 STATIC PAGE_TABLE_POOL
*mPageTablePool
= NULL
;
31 Get the memory encryption mask
33 @param[out] EncryptionMask contains the pte mask.
38 GetMemEncryptionAddressMask (
42 UINT64 EncryptionMask
;
44 if (mAddressEncMaskChecked
) {
45 return mAddressEncMask
;
48 EncryptionMask
= MemEncryptSevGetEncryptionMask ();
50 mAddressEncMask
= EncryptionMask
& PAGING_1G_ADDRESS_MASK_64
;
51 mAddressEncMaskChecked
= TRUE
;
53 return mAddressEncMask
;
57 Initialize a buffer pool for page table use only.
59 To reduce the potential split operation on page table, the pages reserved for
60 page table should be allocated in the times of PAGE_TABLE_POOL_UNIT_PAGES and
61 at the boundary of PAGE_TABLE_POOL_ALIGNMENT. So the page pool is always
62 initialized with number of pages greater than or equal to the given
65 Once the pages in the pool are used up, this method should be called again to
66 reserve at least another PAGE_TABLE_POOL_UNIT_PAGES. Usually this won't
67 happen often in practice.
69 @param[in] PoolPages The least page number of the pool to be created.
71 @retval TRUE The pool is initialized successfully.
72 @retval FALSE The memory is out of resource.
76 InitializePageTablePool (
83 // Always reserve at least PAGE_TABLE_POOL_UNIT_PAGES, including one page for
86 PoolPages
+= 1; // Add one page for header.
87 PoolPages
= ((PoolPages
- 1) / PAGE_TABLE_POOL_UNIT_PAGES
+ 1) *
88 PAGE_TABLE_POOL_UNIT_PAGES
;
89 Buffer
= AllocateAlignedPages (PoolPages
, PAGE_TABLE_POOL_ALIGNMENT
);
91 DEBUG ((DEBUG_ERROR
, "ERROR: Out of aligned pages\r\n"));
96 // Link all pools into a list for easier track later.
98 if (mPageTablePool
== NULL
) {
99 mPageTablePool
= Buffer
;
100 mPageTablePool
->NextPool
= mPageTablePool
;
102 ((PAGE_TABLE_POOL
*)Buffer
)->NextPool
= mPageTablePool
->NextPool
;
103 mPageTablePool
->NextPool
= Buffer
;
104 mPageTablePool
= Buffer
;
108 // Reserve one page for pool header.
110 mPageTablePool
->FreePages
= PoolPages
- 1;
111 mPageTablePool
->Offset
= EFI_PAGES_TO_SIZE (1);
117 This API provides a way to allocate memory for page table.
119 This API can be called more than once to allocate memory for page tables.
121 Allocates the number of 4KB pages and returns a pointer to the allocated
122 buffer. The buffer returned is aligned on a 4KB boundary.
124 If Pages is 0, then NULL is returned.
125 If there is not enough memory remaining to satisfy the request, then NULL is
128 @param Pages The number of 4 KB pages to allocate.
130 @return A pointer to the allocated buffer or NULL if allocation fails.
136 AllocatePageTableMemory (
147 // Renew the pool if necessary.
149 if (mPageTablePool
== NULL
||
150 Pages
> mPageTablePool
->FreePages
) {
151 if (!InitializePageTablePool (Pages
)) {
156 Buffer
= (UINT8
*)mPageTablePool
+ mPageTablePool
->Offset
;
158 mPageTablePool
->Offset
+= EFI_PAGES_TO_SIZE (Pages
);
159 mPageTablePool
->FreePages
-= Pages
;
163 "%a:%a: Buffer=0x%Lx Pages=%ld\n",
177 @param[in] PhysicalAddress Start physical address the 2M page
179 @param[in, out] PageEntry2M Pointer to 2M page entry.
180 @param[in] StackBase Stack base address.
181 @param[in] StackSize Stack size.
187 IN PHYSICAL_ADDRESS PhysicalAddress
,
188 IN OUT UINT64
*PageEntry2M
,
189 IN PHYSICAL_ADDRESS StackBase
,
193 PHYSICAL_ADDRESS PhysicalAddress4K
;
194 UINTN IndexOfPageTableEntries
;
195 PAGE_TABLE_4K_ENTRY
*PageTableEntry
, *PageTableEntry1
;
196 UINT64 AddressEncMask
;
198 PageTableEntry
= AllocatePageTableMemory(1);
200 PageTableEntry1
= PageTableEntry
;
202 AddressEncMask
= GetMemEncryptionAddressMask ();
204 ASSERT (PageTableEntry
!= NULL
);
205 ASSERT (*PageEntry2M
& AddressEncMask
);
207 PhysicalAddress4K
= PhysicalAddress
;
208 for (IndexOfPageTableEntries
= 0;
209 IndexOfPageTableEntries
< 512;
210 (IndexOfPageTableEntries
++,
212 PhysicalAddress4K
+= SIZE_4KB
)) {
214 // Fill in the Page Table entries
216 PageTableEntry
->Uint64
= (UINT64
) PhysicalAddress4K
| AddressEncMask
;
217 PageTableEntry
->Bits
.ReadWrite
= 1;
218 PageTableEntry
->Bits
.Present
= 1;
219 if ((PhysicalAddress4K
>= StackBase
) &&
220 (PhysicalAddress4K
< StackBase
+ StackSize
)) {
222 // Set Nx bit for stack.
224 PageTableEntry
->Bits
.Nx
= 1;
229 // Fill in 2M page entry.
231 *PageEntry2M
= ((UINT64
)(UINTN
)PageTableEntry1
|
232 IA32_PG_P
| IA32_PG_RW
| AddressEncMask
);
236 Set one page of page table pool memory to be read-only.
238 @param[in] PageTableBase Base address of page table (CR3).
239 @param[in] Address Start address of a page to be set as read-only.
240 @param[in] Level4Paging Level 4 paging flag.
245 SetPageTablePoolReadOnly (
246 IN UINTN PageTableBase
,
247 IN EFI_PHYSICAL_ADDRESS Address
,
248 IN BOOLEAN Level4Paging
253 UINT64 AddressEncMask
;
254 EFI_PHYSICAL_ADDRESS PhysicalAddress
;
256 UINT64
*NewPageTable
;
264 ASSERT (PageTableBase
!= 0);
267 // Since the page table is always from page table pool, which is always
268 // located at the boundary of PcdPageTablePoolAlignment, we just need to
269 // set the whole pool unit to be read-only.
271 Address
= Address
& PAGE_TABLE_POOL_ALIGN_MASK
;
273 LevelShift
[1] = PAGING_L1_ADDRESS_SHIFT
;
274 LevelShift
[2] = PAGING_L2_ADDRESS_SHIFT
;
275 LevelShift
[3] = PAGING_L3_ADDRESS_SHIFT
;
276 LevelShift
[4] = PAGING_L4_ADDRESS_SHIFT
;
278 LevelMask
[1] = PAGING_4K_ADDRESS_MASK_64
;
279 LevelMask
[2] = PAGING_2M_ADDRESS_MASK_64
;
280 LevelMask
[3] = PAGING_1G_ADDRESS_MASK_64
;
281 LevelMask
[4] = PAGING_1G_ADDRESS_MASK_64
;
283 LevelSize
[1] = SIZE_4KB
;
284 LevelSize
[2] = SIZE_2MB
;
285 LevelSize
[3] = SIZE_1GB
;
286 LevelSize
[4] = SIZE_512GB
;
288 AddressEncMask
= GetMemEncryptionAddressMask();
289 PageTable
= (UINT64
*)(UINTN
)PageTableBase
;
290 PoolUnitSize
= PAGE_TABLE_POOL_UNIT_SIZE
;
292 for (Level
= (Level4Paging
) ? 4 : 3; Level
> 0; --Level
) {
293 Index
= ((UINTN
)RShiftU64 (Address
, LevelShift
[Level
]));
294 Index
&= PAGING_PAE_INDEX_MASK
;
296 PageAttr
= PageTable
[Index
];
297 if ((PageAttr
& IA32_PG_PS
) == 0) {
299 // Go to next level of table.
301 PageTable
= (UINT64
*)(UINTN
)(PageAttr
& ~AddressEncMask
&
302 PAGING_4K_ADDRESS_MASK_64
);
306 if (PoolUnitSize
>= LevelSize
[Level
]) {
308 // Clear R/W bit if current page granularity is not larger than pool unit
311 if ((PageAttr
& IA32_PG_RW
) != 0) {
312 while (PoolUnitSize
> 0) {
314 // PAGE_TABLE_POOL_UNIT_SIZE and PAGE_TABLE_POOL_ALIGNMENT are fit in
315 // one page (2MB). Then we don't need to update attributes for pages
316 // crossing page directory. ASSERT below is for that purpose.
318 ASSERT (Index
< EFI_PAGE_SIZE
/sizeof (UINT64
));
320 PageTable
[Index
] &= ~(UINT64
)IA32_PG_RW
;
321 PoolUnitSize
-= LevelSize
[Level
];
331 // The smaller granularity of page must be needed.
335 NewPageTable
= AllocatePageTableMemory (1);
336 ASSERT (NewPageTable
!= NULL
);
338 PhysicalAddress
= PageAttr
& LevelMask
[Level
];
340 EntryIndex
< EFI_PAGE_SIZE
/sizeof (UINT64
);
342 NewPageTable
[EntryIndex
] = PhysicalAddress
| AddressEncMask
|
343 IA32_PG_P
| IA32_PG_RW
;
345 NewPageTable
[EntryIndex
] |= IA32_PG_PS
;
347 PhysicalAddress
+= LevelSize
[Level
- 1];
350 PageTable
[Index
] = (UINT64
)(UINTN
)NewPageTable
| AddressEncMask
|
351 IA32_PG_P
| IA32_PG_RW
;
352 PageTable
= NewPageTable
;
358 Prevent the memory pages used for page table from been overwritten.
360 @param[in] PageTableBase Base address of page table (CR3).
361 @param[in] Level4Paging Level 4 paging flag.
366 EnablePageTableProtection (
367 IN UINTN PageTableBase
,
368 IN BOOLEAN Level4Paging
371 PAGE_TABLE_POOL
*HeadPool
;
372 PAGE_TABLE_POOL
*Pool
;
374 EFI_PHYSICAL_ADDRESS Address
;
376 if (mPageTablePool
== NULL
) {
381 // SetPageTablePoolReadOnly might update mPageTablePool. It's safer to
382 // remember original one in advance.
384 HeadPool
= mPageTablePool
;
387 Address
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)Pool
;
388 PoolSize
= Pool
->Offset
+ EFI_PAGES_TO_SIZE (Pool
->FreePages
);
391 // The size of one pool must be multiple of PAGE_TABLE_POOL_UNIT_SIZE,
392 // which is one of page size of the processor (2MB by default). Let's apply
393 // the protection to them one by one.
395 while (PoolSize
> 0) {
396 SetPageTablePoolReadOnly(PageTableBase
, Address
, Level4Paging
);
397 Address
+= PAGE_TABLE_POOL_UNIT_SIZE
;
398 PoolSize
-= PAGE_TABLE_POOL_UNIT_SIZE
;
401 Pool
= Pool
->NextPool
;
402 } while (Pool
!= HeadPool
);
410 @param[in] PhysicalAddress Start physical address the 1G page
412 @param[in, out] PageEntry1G Pointer to 1G page entry.
413 @param[in] StackBase Stack base address.
414 @param[in] StackSize Stack size.
420 IN PHYSICAL_ADDRESS PhysicalAddress
,
421 IN OUT UINT64
*PageEntry1G
,
422 IN PHYSICAL_ADDRESS StackBase
,
426 PHYSICAL_ADDRESS PhysicalAddress2M
;
427 UINTN IndexOfPageDirectoryEntries
;
428 PAGE_TABLE_ENTRY
*PageDirectoryEntry
;
429 UINT64 AddressEncMask
;
431 PageDirectoryEntry
= AllocatePageTableMemory(1);
433 AddressEncMask
= GetMemEncryptionAddressMask ();
434 ASSERT (PageDirectoryEntry
!= NULL
);
435 ASSERT (*PageEntry1G
& AddressEncMask
);
437 // Fill in 1G page entry.
439 *PageEntry1G
= ((UINT64
)(UINTN
)PageDirectoryEntry
|
440 IA32_PG_P
| IA32_PG_RW
| AddressEncMask
);
442 PhysicalAddress2M
= PhysicalAddress
;
443 for (IndexOfPageDirectoryEntries
= 0;
444 IndexOfPageDirectoryEntries
< 512;
445 (IndexOfPageDirectoryEntries
++,
446 PageDirectoryEntry
++,
447 PhysicalAddress2M
+= SIZE_2MB
)) {
448 if ((PhysicalAddress2M
< StackBase
+ StackSize
) &&
449 ((PhysicalAddress2M
+ SIZE_2MB
) > StackBase
)) {
451 // Need to split this 2M page that covers stack range.
455 (UINT64
*)PageDirectoryEntry
,
461 // Fill in the Page Directory entries
463 PageDirectoryEntry
->Uint64
= (UINT64
) PhysicalAddress2M
| AddressEncMask
;
464 PageDirectoryEntry
->Bits
.ReadWrite
= 1;
465 PageDirectoryEntry
->Bits
.Present
= 1;
466 PageDirectoryEntry
->Bits
.MustBe1
= 1;
473 Set or Clear the memory encryption bit
475 @param[in] PagetablePoint Page table entry pointer (PTE).
476 @param[in] Mode Set or Clear encryption bit
481 IN OUT UINT64
* PageTablePointer
,
482 IN MAP_RANGE_MODE Mode
485 UINT64 AddressEncMask
;
487 AddressEncMask
= GetMemEncryptionAddressMask ();
489 if (Mode
== SetCBit
) {
490 *PageTablePointer
|= AddressEncMask
;
492 *PageTablePointer
&= ~AddressEncMask
;
498 Check the WP status in CR0 register. This bit is used to lock or unlock write
499 access to pages marked as read-only.
501 @retval TRUE Write protection is enabled.
502 @retval FALSE Write protection is disabled.
506 IsReadOnlyPageWriteProtected (
510 return ((AsmReadCr0 () & BIT16
) != 0);
515 Disable Write Protect on pages marked as read-only.
519 DisableReadOnlyPageWriteProtect (
523 AsmWriteCr0 (AsmReadCr0() & ~BIT16
);
527 Enable Write Protect on pages marked as read-only.
530 EnableReadOnlyPageWriteProtect (
534 AsmWriteCr0 (AsmReadCr0() | BIT16
);
539 This function either sets or clears memory encryption bit for the memory
540 region specified by PhysicalAddress and Length from the current page table
543 The function iterates through the PhysicalAddress one page at a time, and set
544 or clears the memory encryption mask in the page table. If it encounters
545 that a given physical address range is part of large page then it attempts to
546 change the attribute at one go (based on size), otherwise it splits the
547 large pages into smaller (e.g 2M page into 4K pages) and then try to set or
548 clear the encryption bit on the smallest page size.
550 @param[in] Cr3BaseAddress Cr3 Base Address (if zero then use
552 @param[in] PhysicalAddress The physical address that is the start
553 address of a memory region.
554 @param[in] Length The length of memory region
555 @param[in] Mode Set or Clear mode
556 @param[in] CacheFlush Flush the caches before applying the
559 @retval RETURN_SUCCESS The attributes were cleared for the
561 @retval RETURN_INVALID_PARAMETER Number of pages is zero.
562 @retval RETURN_UNSUPPORTED Setting the memory encyrption attribute
570 IN PHYSICAL_ADDRESS Cr3BaseAddress
,
571 IN PHYSICAL_ADDRESS PhysicalAddress
,
573 IN MAP_RANGE_MODE Mode
,
574 IN BOOLEAN CacheFlush
577 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMapLevel4Entry
;
578 PAGE_MAP_AND_DIRECTORY_POINTER
*PageUpperDirectoryPointerEntry
;
579 PAGE_MAP_AND_DIRECTORY_POINTER
*PageDirectoryPointerEntry
;
580 PAGE_TABLE_1G_ENTRY
*PageDirectory1GEntry
;
581 PAGE_TABLE_ENTRY
*PageDirectory2MEntry
;
582 PAGE_TABLE_4K_ENTRY
*PageTableEntry
;
584 UINT64 AddressEncMask
;
586 RETURN_STATUS Status
;
589 // Set PageMapLevel4Entry to suppress incorrect compiler/analyzer warnings.
591 PageMapLevel4Entry
= NULL
;
595 "%a:%a: Cr3Base=0x%Lx Physical=0x%Lx Length=0x%Lx Mode=%a CacheFlush=%u\n",
601 (Mode
== SetCBit
) ? "Encrypt" : "Decrypt",
606 // Check if we have a valid memory encryption mask
608 AddressEncMask
= GetMemEncryptionAddressMask ();
609 if (!AddressEncMask
) {
610 return RETURN_ACCESS_DENIED
;
613 PgTableMask
= AddressEncMask
| EFI_PAGE_MASK
;
616 return RETURN_INVALID_PARAMETER
;
620 // We are going to change the memory encryption attribute from C=0 -> C=1 or
621 // vice versa Flush the caches to ensure that data is written into memory
622 // with correct C-bit
625 WriteBackInvalidateDataCacheRange((VOID
*) (UINTN
)PhysicalAddress
, Length
);
629 // Make sure that the page table is changeable.
631 IsWpEnabled
= IsReadOnlyPageWriteProtected ();
633 DisableReadOnlyPageWriteProtect ();
636 Status
= EFI_SUCCESS
;
641 // If Cr3BaseAddress is not specified then read the current CR3
643 if (Cr3BaseAddress
== 0) {
644 Cr3BaseAddress
= AsmReadCr3();
647 PageMapLevel4Entry
= (VOID
*) (Cr3BaseAddress
& ~PgTableMask
);
648 PageMapLevel4Entry
+= PML4_OFFSET(PhysicalAddress
);
649 if (!PageMapLevel4Entry
->Bits
.Present
) {
652 "%a:%a: bad PML4 for Physical=0x%Lx\n",
657 Status
= RETURN_NO_MAPPING
;
661 PageDirectory1GEntry
= (VOID
*)(
662 (PageMapLevel4Entry
->Bits
.PageTableBaseAddress
<<
665 PageDirectory1GEntry
+= PDP_OFFSET(PhysicalAddress
);
666 if (!PageDirectory1GEntry
->Bits
.Present
) {
669 "%a:%a: bad PDPE for Physical=0x%Lx\n",
674 Status
= RETURN_NO_MAPPING
;
679 // If the MustBe1 bit is not 1, it's not actually a 1GB entry
681 if (PageDirectory1GEntry
->Bits
.MustBe1
) {
684 // If we have at least 1GB to go, we can just update this entry
686 if (!(PhysicalAddress
& (BIT30
- 1)) && Length
>= BIT30
) {
687 SetOrClearCBit(&PageDirectory1GEntry
->Uint64
, Mode
);
690 "%a:%a: updated 1GB entry for Physical=0x%Lx\n",
695 PhysicalAddress
+= BIT30
;
699 // We must split the page
703 "%a:%a: splitting 1GB page for Physical=0x%Lx\n",
709 (UINT64
)PageDirectory1GEntry
->Bits
.PageTableBaseAddress
<< 30,
710 (UINT64
*)PageDirectory1GEntry
,
720 PageUpperDirectoryPointerEntry
=
721 (PAGE_MAP_AND_DIRECTORY_POINTER
*)PageDirectory1GEntry
;
722 PageDirectory2MEntry
=
724 (PageUpperDirectoryPointerEntry
->Bits
.PageTableBaseAddress
<<
727 PageDirectory2MEntry
+= PDE_OFFSET(PhysicalAddress
);
728 if (!PageDirectory2MEntry
->Bits
.Present
) {
731 "%a:%a: bad PDE for Physical=0x%Lx\n",
736 Status
= RETURN_NO_MAPPING
;
740 // If the MustBe1 bit is not a 1, it's not a 2MB entry
742 if (PageDirectory2MEntry
->Bits
.MustBe1
) {
745 // If we have at least 2MB left to go, we can just update this entry
747 if (!(PhysicalAddress
& (BIT21
-1)) && Length
>= BIT21
) {
748 SetOrClearCBit (&PageDirectory2MEntry
->Uint64
, Mode
);
749 PhysicalAddress
+= BIT21
;
753 // We must split up this page into 4K pages
757 "%a:%a: splitting 2MB page for Physical=0x%Lx\n",
763 (UINT64
)PageDirectory2MEntry
->Bits
.PageTableBaseAddress
<< 21,
764 (UINT64
*)PageDirectory2MEntry
,
771 PageDirectoryPointerEntry
=
772 (PAGE_MAP_AND_DIRECTORY_POINTER
*)PageDirectory2MEntry
;
775 (PageDirectoryPointerEntry
->Bits
.PageTableBaseAddress
<<
778 PageTableEntry
+= PTE_OFFSET(PhysicalAddress
);
779 if (!PageTableEntry
->Bits
.Present
) {
782 "%a:%a: bad PTE for Physical=0x%Lx\n",
787 Status
= RETURN_NO_MAPPING
;
790 SetOrClearCBit (&PageTableEntry
->Uint64
, Mode
);
791 PhysicalAddress
+= EFI_PAGE_SIZE
;
792 Length
-= EFI_PAGE_SIZE
;
798 // Protect the page table by marking the memory used for page table to be
802 EnablePageTableProtection ((UINTN
)PageMapLevel4Entry
, TRUE
);
812 // Restore page table write protection, if any.
815 EnableReadOnlyPageWriteProtect ();
822 This function clears memory encryption bit for the memory region specified by
823 PhysicalAddress and Length from the current page table context.
825 @param[in] Cr3BaseAddress Cr3 Base Address (if zero then use
827 @param[in] PhysicalAddress The physical address that is the start
828 address of a memory region.
829 @param[in] Length The length of memory region
830 @param[in] Flush Flush the caches before applying the
833 @retval RETURN_SUCCESS The attributes were cleared for the
835 @retval RETURN_INVALID_PARAMETER Number of pages is zero.
836 @retval RETURN_UNSUPPORTED Clearing the memory encyrption attribute
841 InternalMemEncryptSevSetMemoryDecrypted (
842 IN PHYSICAL_ADDRESS Cr3BaseAddress
,
843 IN PHYSICAL_ADDRESS PhysicalAddress
,
849 return SetMemoryEncDec (
859 This function sets memory encryption bit for the memory region specified by
860 PhysicalAddress and Length from the current page table context.
862 @param[in] Cr3BaseAddress Cr3 Base Address (if zero then use
864 @param[in] PhysicalAddress The physical address that is the start
865 address of a memory region.
866 @param[in] Length The length of memory region
867 @param[in] Flush Flush the caches before applying the
870 @retval RETURN_SUCCESS The attributes were set for the memory
872 @retval RETURN_INVALID_PARAMETER Number of pages is zero.
873 @retval RETURN_UNSUPPORTED Setting the memory encyrption attribute
878 InternalMemEncryptSevSetMemoryEncrypted (
879 IN PHYSICAL_ADDRESS Cr3BaseAddress
,
880 IN PHYSICAL_ADDRESS PhysicalAddress
,
885 return SetMemoryEncDec (