2 x64 Long Mode Virtual Memory Management Definitions
5 1) IA-32 Intel(R) Architecture Software Developer's Manual Volume 1:Basic Architecture, Intel
6 2) IA-32 Intel(R) Architecture Software Developer's Manual Volume 2:Instruction Set Reference, Intel
7 3) IA-32 Intel(R) Architecture Software Developer's Manual Volume 3:System Programmer's Guide, Intel
8 4) AMD64 Architecture Programmer's Manual Volume 2: System Programming
10 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
11 Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
13 SPDX-License-Identifier: BSD-2-Clause-Patent
16 #ifndef _VIRTUAL_MEMORY_H_
17 #define _VIRTUAL_MEMORY_H_
20 #define SYS_CODE64_SEL 0x38
37 UINT32 DefaultSize
: 1;
38 UINT32 Granularity
: 1;
45 IA32_IDT_GATE_DESCRIPTOR Ia32IdtEntry
;
48 } X64_IDT_GATE_DESCRIPTOR
;
51 // Page-Map Level-4 Offset (PML4) and
52 // Page-Directory-Pointer Offset (PDPE) entries 4K & 2MB
57 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
58 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
59 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
60 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
61 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
62 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
63 UINT64 Reserved
:1; // Reserved
64 UINT64 MustBeZero
:2; // Must Be Zero
65 UINT64 Available
:3; // Available for use by system software
66 UINT64 PageTableBaseAddress
:40; // Page Table Base Address
67 UINT64 AvabilableHigh
:11; // Available for use by system software
68 UINT64 Nx
:1; // No Execute bit
71 } PAGE_MAP_AND_DIRECTORY_POINTER
;
74 // Page Table Entry 4KB
78 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
79 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
80 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
81 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
82 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
83 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
84 UINT64 Dirty
:1; // 0 = Not Dirty, 1 = written by processor on access to page
86 UINT64 Global
:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write
87 UINT64 Available
:3; // Available for use by system software
88 UINT64 PageTableBaseAddress
:40; // Page Table Base Address
89 UINT64 AvabilableHigh
:11; // Available for use by system software
90 UINT64 Nx
:1; // 0 = Execute Code, 1 = No Code Execution
93 } PAGE_TABLE_4K_ENTRY
;
96 // Page Table Entry 2MB
100 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
101 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
102 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
103 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
104 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
105 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
106 UINT64 Dirty
:1; // 0 = Not Dirty, 1 = written by processor on access to page
107 UINT64 MustBe1
:1; // Must be 1
108 UINT64 Global
:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write
109 UINT64 Available
:3; // Available for use by system software
111 UINT64 MustBeZero
:8; // Must be zero;
112 UINT64 PageTableBaseAddress
:31; // Page Table Base Address
113 UINT64 AvabilableHigh
:11; // Available for use by system software
114 UINT64 Nx
:1; // 0 = Execute Code, 1 = No Code Execution
120 // Page Table Entry 1GB
124 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
125 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
126 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
127 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
128 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
129 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
130 UINT64 Dirty
:1; // 0 = Not Dirty, 1 = written by processor on access to page
131 UINT64 MustBe1
:1; // Must be 1
132 UINT64 Global
:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write
133 UINT64 Available
:3; // Available for use by system software
135 UINT64 MustBeZero
:17; // Must be zero;
136 UINT64 PageTableBaseAddress
:22; // Page Table Base Address
137 UINT64 AvabilableHigh
:11; // Available for use by system software
138 UINT64 Nx
:1; // 0 = Execute Code, 1 = No Code Execution
141 } PAGE_TABLE_1G_ENTRY
;
147 #define IA32_PG_P BIT0
148 #define IA32_PG_RW BIT1
149 #define IA32_PG_PS BIT7
151 #define PAGING_PAE_INDEX_MASK 0x1FF
153 #define PAGING_4K_ADDRESS_MASK_64 0x000FFFFFFFFFF000ull
154 #define PAGING_2M_ADDRESS_MASK_64 0x000FFFFFFFE00000ull
155 #define PAGING_1G_ADDRESS_MASK_64 0x000FFFFFC0000000ull
157 #define PAGING_L1_ADDRESS_SHIFT 12
158 #define PAGING_L2_ADDRESS_SHIFT 21
159 #define PAGING_L3_ADDRESS_SHIFT 30
160 #define PAGING_L4_ADDRESS_SHIFT 39
162 #define PAGING_PML4E_NUMBER 4
164 #define PAGE_TABLE_POOL_ALIGNMENT BASE_2MB
165 #define PAGE_TABLE_POOL_UNIT_SIZE SIZE_2MB
166 #define PAGE_TABLE_POOL_UNIT_PAGES EFI_SIZE_TO_PAGES (PAGE_TABLE_POOL_UNIT_SIZE)
167 #define PAGE_TABLE_POOL_ALIGN_MASK \
168 (~(EFI_PHYSICAL_ADDRESS)(PAGE_TABLE_POOL_ALIGNMENT - 1))
177 Check if Execute Disable Bit (IA32_EFER.NXE) should be enabled or not.
179 @retval TRUE IA32_EFER.NXE should be enabled.
180 @retval FALSE IA32_EFER.NXE should not be enabled.
184 IsEnableNonExecNeeded (
189 Enable Execute Disable Bit.
193 EnableExecuteDisableBit (
200 @param[in] PhysicalAddress Start physical address the 2M page covered.
201 @param[in, out] PageEntry2M Pointer to 2M page entry.
202 @param[in] StackBase Stack base address.
203 @param[in] StackSize Stack size.
208 IN EFI_PHYSICAL_ADDRESS PhysicalAddress
,
209 IN OUT UINT64
*PageEntry2M
,
210 IN EFI_PHYSICAL_ADDRESS StackBase
,
215 Allocates and fills in the Page Directory and Page Table Entries to
216 establish a 1:1 Virtual to Physical mapping.
218 @param[in] StackBase Stack base address.
219 @param[in] StackSize Stack size.
221 @return The address of 4 level page map.
225 CreateIdentityMappingPageTables (
226 IN EFI_PHYSICAL_ADDRESS StackBase
,
233 Fix up the vector number in the vector code.
235 @param VectorBase Base address of the vector handler.
236 @param VectorNum Index of vector.
249 Get the information of vector template.
251 @param TemplateBase Base address of the template code.
253 @return Size of the Template code.
258 AsmGetVectorTemplatInfo (
259 OUT VOID
**TemplateBase
263 Clear legacy memory located at the first 4K-page.
265 This function traverses the whole HOB list to check if memory from 0 to 4095
266 exists and has not been allocated, and then clear it if so.
268 @param HobStart The start of HobList passed to DxeCore.
277 Return configure status of NULL pointer detection feature.
279 @return TRUE NULL pointer detection feature is enabled
280 @return FALSE NULL pointer detection feature is disabled
283 IsNullDetectionEnabled (
288 Prevent the memory pages used for page table from been overwritten.
290 @param[in] PageTableBase Base address of page table (CR3).
291 @param[in] Level4Paging Level 4 paging flag.
295 EnablePageTableProtection (
296 IN UINTN PageTableBase
,
297 IN BOOLEAN Level4Paging
301 This API provides a way to allocate memory for page table.
303 This API can be called more than once to allocate memory for page tables.
305 Allocates the number of 4KB pages and returns a pointer to the allocated
306 buffer. The buffer returned is aligned on a 4KB boundary.
308 If Pages is 0, then NULL is returned.
309 If there is not enough memory remaining to satisfy the request, then NULL is
312 @param Pages The number of 4 KB pages to allocate.
314 @return A pointer to the allocated buffer or NULL if allocation fails.
318 AllocatePageTableMemory (