UefiCpuPkg/PiSmmCpuDxeSmm: patch "XdSupported" with PatchInstructionX86()
[mirror_edk2.git] / UefiCpuPkg / PiSmmCpuDxeSmm / SmmProfileInternal.h
CommitLineData
529a5a86
MK
1/** @file\r
2SMM profile internal header file.\r
3\r
b8caae19 4Copyright (c) 2012 - 2017, Intel Corporation. All rights reserved.<BR>\r
529a5a86
MK
5This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#ifndef _SMM_PROFILE_INTERNAL_H_\r
16#define _SMM_PROFILE_INTERNAL_H_\r
17\r
18#include <Guid/GlobalVariable.h>\r
19#include <Guid/Acpi.h>\r
20#include <Protocol/SmmReadyToLock.h>\r
21#include <Library/UefiRuntimeServicesTableLib.h>\r
22#include <Library/DxeServicesTableLib.h>\r
23#include <Library/CpuLib.h>\r
24#include <IndustryStandard/Acpi.h>\r
25\r
26#include "SmmProfileArch.h"\r
27\r
28//\r
29// Configure the SMM_PROFILE DTS region size\r
30//\r
31#define SMM_PROFILE_DTS_SIZE (4 * 1024 * 1024) // 4M\r
32\r
33#define MAX_PF_PAGE_COUNT 0x2\r
34\r
35#define PEBS_RECORD_NUMBER 0x2\r
36\r
37#define MAX_PF_ENTRY_COUNT 10\r
38\r
39//\r
40// This MACRO just enable unit test for the profile\r
41// Please disable it.\r
42//\r
43\r
529a5a86
MK
44#define IA32_PF_EC_ID (1u << 4)\r
45\r
46#define SMM_PROFILE_NAME L"SmmProfileData"\r
47\r
48//\r
49// CPU generic definition\r
50//\r
51#define CPUID1_EDX_XD_SUPPORT 0x100000\r
52#define MSR_EFER 0xc0000080\r
53#define MSR_EFER_XD 0x800\r
54\r
55#define CPUID1_EDX_BTS_AVAILABLE 0x200000\r
56\r
57#define DR6_SINGLE_STEP 0x4000\r
58#define RFLAG_TF 0x100\r
59\r
60#define MSR_DEBUG_CTL 0x1D9\r
61#define MSR_DEBUG_CTL_LBR 0x1\r
62#define MSR_DEBUG_CTL_TR 0x40\r
63#define MSR_DEBUG_CTL_BTS 0x80\r
64#define MSR_DEBUG_CTL_BTINT 0x100\r
529a5a86
MK
65#define MSR_DS_AREA 0x600\r
66\r
67typedef struct {\r
68 EFI_PHYSICAL_ADDRESS Base;\r
69 EFI_PHYSICAL_ADDRESS Top;\r
70} MEMORY_RANGE;\r
71\r
72typedef struct {\r
73 MEMORY_RANGE Range;\r
74 BOOLEAN Present;\r
75 BOOLEAN Nx;\r
76} MEMORY_PROTECTION_RANGE;\r
77\r
78typedef struct {\r
79 UINT64 HeaderSize;\r
80 UINT64 MaxDataEntries;\r
81 UINT64 MaxDataSize;\r
82 UINT64 CurDataEntries;\r
83 UINT64 CurDataSize;\r
84 UINT64 TsegStart;\r
85 UINT64 TsegSize;\r
86 UINT64 NumSmis;\r
87 UINT64 NumCpus;\r
88} SMM_PROFILE_HEADER;\r
89\r
90typedef struct {\r
91 UINT64 SmiNum;\r
92 UINT64 CpuNum;\r
93 UINT64 ApicId;\r
94 UINT64 ErrorCode;\r
95 UINT64 Instruction;\r
96 UINT64 Address;\r
97 UINT64 SmiCmd;\r
98} SMM_PROFILE_ENTRY;\r
99\r
100extern SMM_S3_RESUME_STATE *mSmmS3ResumeState;\r
101extern UINTN gSmiExceptionHandlers[];\r
102extern BOOLEAN mXdSupported;\r
3c5ce64f 103X86_ASSEMBLY_PATCH_LABEL gPatchXdSupported;\r
529a5a86
MK
104extern UINTN *mPFEntryCount;\r
105extern UINT64 (*mLastPFEntryValue)[MAX_PF_ENTRY_COUNT];\r
106extern UINT64 *(*mLastPFEntryPointer)[MAX_PF_ENTRY_COUNT];\r
107\r
108//\r
109// Internal functions\r
110//\r
111\r
112/**\r
113 Update IDT table to replace page fault handler and INT 1 handler.\r
114\r
115**/\r
116VOID\r
117InitIdtr (\r
118 VOID\r
119 );\r
120\r
121/**\r
122 Check if the memory address will be mapped by 4KB-page.\r
123\r
124 @param Address The address of Memory.\r
125\r
126**/\r
127BOOLEAN\r
128IsAddressSplit (\r
129 IN EFI_PHYSICAL_ADDRESS Address\r
130 );\r
131\r
132/**\r
133 Check if the memory address will be mapped by 4KB-page.\r
134\r
135 @param Address The address of Memory.\r
136 @param Nx The flag indicates if the memory is execute-disable.\r
137\r
138**/\r
139BOOLEAN\r
140IsAddressValid (\r
141 IN EFI_PHYSICAL_ADDRESS Address,\r
142 IN BOOLEAN *Nx\r
143 );\r
144\r
145/**\r
146 Page Fault handler for SMM use.\r
147\r
148**/\r
149VOID\r
150SmiDefaultPFHandler (\r
151 VOID\r
152 );\r
153\r
154/**\r
155 Clear TF in FLAGS.\r
156\r
157 @param SystemContext A pointer to the processor context when\r
158 the interrupt occurred on the processor.\r
159\r
160**/\r
161VOID\r
162ClearTrapFlag (\r
163 IN OUT EFI_SYSTEM_CONTEXT SystemContext\r
164 );\r
165\r
166#endif // _SMM_PROFILE_H_\r