UefiCpuPkg/CpuDxe: Enable protection for newly added page table
[mirror_edk2.git] / UefiCpuPkg / CpuDxe / CpuPageTable.h
CommitLineData
22292ed3
JY
1/** @file\r
2 Page table management header file.\r
3\r
4 Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#ifndef _PAGE_TABLE_LIB_H_\r
16#define _PAGE_TABLE_LIB_H_\r
17\r
18#include <IndustryStandard/PeImage.h>\r
19\r
20#define PAGE_TABLE_LIB_PAGING_CONTEXT_IA32_X64_ATTRIBUTES_PSE BIT0\r
21#define PAGE_TABLE_LIB_PAGING_CONTEXT_IA32_X64_ATTRIBUTES_PAE BIT1\r
22#define PAGE_TABLE_LIB_PAGING_CONTEXT_IA32_X64_ATTRIBUTES_PAGE_1G_SUPPORT BIT2\r
23#define PAGE_TABLE_LIB_PAGING_CONTEXT_IA32_X64_ATTRIBUTES_WP_ENABLE BIT30\r
24#define PAGE_TABLE_LIB_PAGING_CONTEXT_IA32_X64_ATTRIBUTES_XD_ACTIVATED BIT31\r
25// Other bits are reserved for future use\r
26typedef struct {\r
27 UINT32 PageTableBase;\r
28 UINT32 Reserved;\r
29 UINT32 Attributes;\r
30} PAGE_TABLE_LIB_PAGING_CONTEXT_IA32;\r
31\r
32typedef struct {\r
33 UINT64 PageTableBase;\r
34 UINT32 Attributes;\r
35} PAGE_TABLE_LIB_PAGING_CONTEXT_X64;\r
36\r
37typedef union {\r
38 PAGE_TABLE_LIB_PAGING_CONTEXT_IA32 Ia32;\r
39 PAGE_TABLE_LIB_PAGING_CONTEXT_X64 X64;\r
40} PAGE_TABLE_LIB_PAGING_CONTEXT_DATA;\r
41\r
42typedef struct {\r
43 //\r
44 // PE32+ Machine type for EFI images\r
45 //\r
46 // #define IMAGE_FILE_MACHINE_I386 0x014c\r
47 // #define IMAGE_FILE_MACHINE_X64 0x8664\r
48 //\r
49 UINT16 MachineType;\r
50 PAGE_TABLE_LIB_PAGING_CONTEXT_DATA ContextData;\r
51} PAGE_TABLE_LIB_PAGING_CONTEXT;\r
52\r
147fd35c
JW
53#define PAGE_TABLE_POOL_ALIGNMENT BASE_2MB\r
54#define PAGE_TABLE_POOL_UNIT_SIZE SIZE_2MB\r
55#define PAGE_TABLE_POOL_UNIT_PAGES EFI_SIZE_TO_PAGES (PAGE_TABLE_POOL_UNIT_SIZE)\r
56#define PAGE_TABLE_POOL_ALIGN_MASK \\r
57 (~(EFI_PHYSICAL_ADDRESS)(PAGE_TABLE_POOL_ALIGNMENT - 1))\r
58\r
59typedef struct {\r
60 VOID *NextPool;\r
61 UINTN Offset;\r
62 UINTN FreePages;\r
63} PAGE_TABLE_POOL;\r
64\r
65\r
22292ed3
JY
66/**\r
67 Allocates one or more 4KB pages for page table.\r
68\r
69 @param Pages The number of 4 KB pages to allocate.\r
70\r
71 @return A pointer to the allocated buffer or NULL if allocation fails.\r
72\r
73**/\r
74typedef\r
75VOID *\r
76(EFIAPI *PAGE_TABLE_LIB_ALLOCATE_PAGES) (\r
77 IN UINTN Pages\r
78 );\r
79\r
80/**\r
81 This function assigns the page attributes for the memory region specified by BaseAddress and\r
82 Length from their current attributes to the attributes specified by Attributes.\r
83\r
84 Caller should make sure BaseAddress and Length is at page boundary.\r
85\r
86 Caller need guarentee the TPL <= TPL_NOTIFY, if there is split page request.\r
87\r
88 @param PagingContext The paging context. NULL means get page table from current CPU context.\r
89 @param BaseAddress The physical address that is the start address of a memory region.\r
90 @param Length The size in bytes of the memory region.\r
91 @param Attributes The bit mask of attributes to set for the memory region.\r
92 @param AllocatePagesFunc If page split is needed, this function is used to allocate more pages.\r
93 NULL mean page split is unsupported.\r
94\r
95 @retval RETURN_SUCCESS The attributes were cleared for the memory region.\r
96 @retval RETURN_ACCESS_DENIED The attributes for the memory resource range specified by\r
97 BaseAddress and Length cannot be modified.\r
98 @retval RETURN_INVALID_PARAMETER Length is zero.\r
99 Attributes specified an illegal combination of attributes that\r
100 cannot be set together.\r
101 @retval RETURN_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of\r
102 the memory resource range.\r
103 @retval RETURN_UNSUPPORTED The processor does not support one or more bytes of the memory\r
104 resource range specified by BaseAddress and Length.\r
105 The bit mask of attributes is not support for the memory resource\r
106 range specified by BaseAddress and Length.\r
107**/\r
108RETURN_STATUS\r
109EFIAPI\r
110AssignMemoryPageAttributes (\r
111 IN PAGE_TABLE_LIB_PAGING_CONTEXT *PagingContext OPTIONAL,\r
112 IN PHYSICAL_ADDRESS BaseAddress,\r
113 IN UINT64 Length,\r
114 IN UINT64 Attributes,\r
115 IN PAGE_TABLE_LIB_ALLOCATE_PAGES AllocatePagesFunc OPTIONAL\r
116 );\r
117\r
118/**\r
119 Initialize the Page Table lib.\r
120**/\r
121VOID\r
122InitializePageTableLib (\r
123 VOID\r
124 );\r
125\r
147fd35c
JW
126/**\r
127 This API provides a way to allocate memory for page table.\r
128\r
129 This API can be called more once to allocate memory for page tables.\r
130\r
131 Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the\r
132 allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL\r
133 is returned. If there is not enough memory remaining to satisfy the request, then NULL is\r
134 returned.\r
135\r
136 @param Pages The number of 4 KB pages to allocate.\r
137\r
138 @return A pointer to the allocated buffer or NULL if allocation fails.\r
139\r
140**/\r
141VOID *\r
142EFIAPI\r
143AllocatePageTableMemory (\r
144 IN UINTN Pages\r
145 );\r
146\r
22292ed3 147#endif\r