xref: /linux/arch/x86/include/asm/vmx.h (revision d3ba32d1ff2a206621475325c009ab5b51882de1)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * vmx.h: VMX Architecture related definitions
4  * Copyright (c) 2004, Intel Corporation.
5  *
6  * A few random additions are:
7  * Copyright (C) 2006 Qumranet
8  *    Avi Kivity <avi@qumranet.com>
9  *    Yaniv Kamay <yaniv@qumranet.com>
10  */
11 #ifndef VMX_H
12 #define VMX_H
13 
14 
15 #include <linux/bitops.h>
16 #include <linux/bug.h>
17 #include <linux/types.h>
18 
19 #include <uapi/asm/vmx.h>
20 #include <asm/trapnr.h>
21 #include <asm/vmxfeatures.h>
22 
23 #define VMCS_CONTROL_BIT(x)	BIT(VMX_FEATURE_##x & 0x1f)
24 
25 /*
26  * Definitions of Primary Processor-Based VM-Execution Controls.
27  */
28 #define CPU_BASED_INTR_WINDOW_EXITING           VMCS_CONTROL_BIT(INTR_WINDOW_EXITING)
29 #define CPU_BASED_USE_TSC_OFFSETTING            VMCS_CONTROL_BIT(USE_TSC_OFFSETTING)
30 #define CPU_BASED_HLT_EXITING                   VMCS_CONTROL_BIT(HLT_EXITING)
31 #define CPU_BASED_INVLPG_EXITING                VMCS_CONTROL_BIT(INVLPG_EXITING)
32 #define CPU_BASED_MWAIT_EXITING                 VMCS_CONTROL_BIT(MWAIT_EXITING)
33 #define CPU_BASED_RDPMC_EXITING                 VMCS_CONTROL_BIT(RDPMC_EXITING)
34 #define CPU_BASED_RDTSC_EXITING                 VMCS_CONTROL_BIT(RDTSC_EXITING)
35 #define CPU_BASED_CR3_LOAD_EXITING		VMCS_CONTROL_BIT(CR3_LOAD_EXITING)
36 #define CPU_BASED_CR3_STORE_EXITING		VMCS_CONTROL_BIT(CR3_STORE_EXITING)
37 #define CPU_BASED_ACTIVATE_TERTIARY_CONTROLS	VMCS_CONTROL_BIT(TERTIARY_CONTROLS)
38 #define CPU_BASED_CR8_LOAD_EXITING              VMCS_CONTROL_BIT(CR8_LOAD_EXITING)
39 #define CPU_BASED_CR8_STORE_EXITING             VMCS_CONTROL_BIT(CR8_STORE_EXITING)
40 #define CPU_BASED_TPR_SHADOW                    VMCS_CONTROL_BIT(VIRTUAL_TPR)
41 #define CPU_BASED_NMI_WINDOW_EXITING		VMCS_CONTROL_BIT(NMI_WINDOW_EXITING)
42 #define CPU_BASED_MOV_DR_EXITING                VMCS_CONTROL_BIT(MOV_DR_EXITING)
43 #define CPU_BASED_UNCOND_IO_EXITING             VMCS_CONTROL_BIT(UNCOND_IO_EXITING)
44 #define CPU_BASED_USE_IO_BITMAPS                VMCS_CONTROL_BIT(USE_IO_BITMAPS)
45 #define CPU_BASED_MONITOR_TRAP_FLAG             VMCS_CONTROL_BIT(MONITOR_TRAP_FLAG)
46 #define CPU_BASED_USE_MSR_BITMAPS               VMCS_CONTROL_BIT(USE_MSR_BITMAPS)
47 #define CPU_BASED_MONITOR_EXITING               VMCS_CONTROL_BIT(MONITOR_EXITING)
48 #define CPU_BASED_PAUSE_EXITING                 VMCS_CONTROL_BIT(PAUSE_EXITING)
49 #define CPU_BASED_ACTIVATE_SECONDARY_CONTROLS   VMCS_CONTROL_BIT(SEC_CONTROLS)
50 
51 #define CPU_BASED_ALWAYSON_WITHOUT_TRUE_MSR	0x0401e172
52 
53 /*
54  * Definitions of Secondary Processor-Based VM-Execution Controls.
55  */
56 #define SECONDARY_EXEC_VIRTUALIZE_APIC_ACCESSES VMCS_CONTROL_BIT(VIRT_APIC_ACCESSES)
57 #define SECONDARY_EXEC_ENABLE_EPT               VMCS_CONTROL_BIT(EPT)
58 #define SECONDARY_EXEC_DESC			VMCS_CONTROL_BIT(DESC_EXITING)
59 #define SECONDARY_EXEC_ENABLE_RDTSCP		VMCS_CONTROL_BIT(RDTSCP)
60 #define SECONDARY_EXEC_VIRTUALIZE_X2APIC_MODE   VMCS_CONTROL_BIT(VIRTUAL_X2APIC)
61 #define SECONDARY_EXEC_ENABLE_VPID              VMCS_CONTROL_BIT(VPID)
62 #define SECONDARY_EXEC_WBINVD_EXITING		VMCS_CONTROL_BIT(WBINVD_EXITING)
63 #define SECONDARY_EXEC_UNRESTRICTED_GUEST	VMCS_CONTROL_BIT(UNRESTRICTED_GUEST)
64 #define SECONDARY_EXEC_APIC_REGISTER_VIRT       VMCS_CONTROL_BIT(APIC_REGISTER_VIRT)
65 #define SECONDARY_EXEC_VIRTUAL_INTR_DELIVERY    VMCS_CONTROL_BIT(VIRT_INTR_DELIVERY)
66 #define SECONDARY_EXEC_PAUSE_LOOP_EXITING	VMCS_CONTROL_BIT(PAUSE_LOOP_EXITING)
67 #define SECONDARY_EXEC_RDRAND_EXITING		VMCS_CONTROL_BIT(RDRAND_EXITING)
68 #define SECONDARY_EXEC_ENABLE_INVPCID		VMCS_CONTROL_BIT(INVPCID)
69 #define SECONDARY_EXEC_ENABLE_VMFUNC            VMCS_CONTROL_BIT(VMFUNC)
70 #define SECONDARY_EXEC_SHADOW_VMCS              VMCS_CONTROL_BIT(SHADOW_VMCS)
71 #define SECONDARY_EXEC_ENCLS_EXITING		VMCS_CONTROL_BIT(ENCLS_EXITING)
72 #define SECONDARY_EXEC_RDSEED_EXITING		VMCS_CONTROL_BIT(RDSEED_EXITING)
73 #define SECONDARY_EXEC_ENABLE_PML               VMCS_CONTROL_BIT(PAGE_MOD_LOGGING)
74 #define SECONDARY_EXEC_EPT_VIOLATION_VE		VMCS_CONTROL_BIT(EPT_VIOLATION_VE)
75 #define SECONDARY_EXEC_PT_CONCEAL_VMX		VMCS_CONTROL_BIT(PT_CONCEAL_VMX)
76 #define SECONDARY_EXEC_ENABLE_XSAVES		VMCS_CONTROL_BIT(XSAVES)
77 #define SECONDARY_EXEC_MODE_BASED_EPT_EXEC	VMCS_CONTROL_BIT(MODE_BASED_EPT_EXEC)
78 #define SECONDARY_EXEC_PT_USE_GPA		VMCS_CONTROL_BIT(PT_USE_GPA)
79 #define SECONDARY_EXEC_TSC_SCALING              VMCS_CONTROL_BIT(TSC_SCALING)
80 #define SECONDARY_EXEC_ENABLE_USR_WAIT_PAUSE	VMCS_CONTROL_BIT(USR_WAIT_PAUSE)
81 #define SECONDARY_EXEC_BUS_LOCK_DETECTION	VMCS_CONTROL_BIT(BUS_LOCK_DETECTION)
82 #define SECONDARY_EXEC_NOTIFY_VM_EXITING	VMCS_CONTROL_BIT(NOTIFY_VM_EXITING)
83 
84 /*
85  * Definitions of Tertiary Processor-Based VM-Execution Controls.
86  */
87 #define TERTIARY_EXEC_IPI_VIRT			VMCS_CONTROL_BIT(IPI_VIRT)
88 
89 #define PIN_BASED_EXT_INTR_MASK                 VMCS_CONTROL_BIT(INTR_EXITING)
90 #define PIN_BASED_NMI_EXITING                   VMCS_CONTROL_BIT(NMI_EXITING)
91 #define PIN_BASED_VIRTUAL_NMIS                  VMCS_CONTROL_BIT(VIRTUAL_NMIS)
92 #define PIN_BASED_VMX_PREEMPTION_TIMER          VMCS_CONTROL_BIT(PREEMPTION_TIMER)
93 #define PIN_BASED_POSTED_INTR                   VMCS_CONTROL_BIT(POSTED_INTR)
94 
95 #define PIN_BASED_ALWAYSON_WITHOUT_TRUE_MSR	0x00000016
96 
97 #define VM_EXIT_SAVE_DEBUG_CONTROLS             0x00000004
98 #define VM_EXIT_HOST_ADDR_SPACE_SIZE            0x00000200
99 #define VM_EXIT_LOAD_IA32_PERF_GLOBAL_CTRL      0x00001000
100 #define VM_EXIT_ACK_INTR_ON_EXIT                0x00008000
101 #define VM_EXIT_SAVE_IA32_PAT			0x00040000
102 #define VM_EXIT_LOAD_IA32_PAT			0x00080000
103 #define VM_EXIT_SAVE_IA32_EFER                  0x00100000
104 #define VM_EXIT_LOAD_IA32_EFER                  0x00200000
105 #define VM_EXIT_SAVE_VMX_PREEMPTION_TIMER       0x00400000
106 #define VM_EXIT_CLEAR_BNDCFGS                   0x00800000
107 #define VM_EXIT_PT_CONCEAL_PIP			0x01000000
108 #define VM_EXIT_CLEAR_IA32_RTIT_CTL		0x02000000
109 #define VM_EXIT_LOAD_CET_STATE                  0x10000000
110 #define VM_EXIT_SAVE_IA32_PERF_GLOBAL_CTRL	0x40000000
111 
112 #define VM_EXIT_ALWAYSON_WITHOUT_TRUE_MSR	0x00036dff
113 
114 #define VM_ENTRY_LOAD_DEBUG_CONTROLS            0x00000004
115 #define VM_ENTRY_IA32E_MODE                     0x00000200
116 #define VM_ENTRY_SMM                            0x00000400
117 #define VM_ENTRY_DEACT_DUAL_MONITOR             0x00000800
118 #define VM_ENTRY_LOAD_IA32_PERF_GLOBAL_CTRL     0x00002000
119 #define VM_ENTRY_LOAD_IA32_PAT			0x00004000
120 #define VM_ENTRY_LOAD_IA32_EFER                 0x00008000
121 #define VM_ENTRY_LOAD_BNDCFGS                   0x00010000
122 #define VM_ENTRY_PT_CONCEAL_PIP			0x00020000
123 #define VM_ENTRY_LOAD_IA32_RTIT_CTL		0x00040000
124 #define VM_ENTRY_LOAD_CET_STATE                 0x00100000
125 
126 #define VM_ENTRY_ALWAYSON_WITHOUT_TRUE_MSR	0x000011ff
127 
128 /* VMFUNC functions */
129 #define VMFUNC_CONTROL_BIT(x)	BIT((VMX_FEATURE_##x & 0x1f) - 28)
130 
131 #define VMX_VMFUNC_EPTP_SWITCHING               VMFUNC_CONTROL_BIT(EPTP_SWITCHING)
132 #define VMFUNC_EPTP_ENTRIES  512
133 
134 #define VMX_BASIC_32BIT_PHYS_ADDR_ONLY		BIT_ULL(48)
135 #define VMX_BASIC_DUAL_MONITOR_TREATMENT	BIT_ULL(49)
136 #define VMX_BASIC_INOUT				BIT_ULL(54)
137 #define VMX_BASIC_TRUE_CTLS			BIT_ULL(55)
138 #define VMX_BASIC_NO_HW_ERROR_CODE_CC		BIT_ULL(56)
139 
140 static inline u32 vmx_basic_vmcs_revision_id(u64 vmx_basic)
141 {
142 	return vmx_basic & GENMASK_ULL(30, 0);
143 }
144 
145 static inline u32 vmx_basic_vmcs_size(u64 vmx_basic)
146 {
147 	return (vmx_basic & GENMASK_ULL(44, 32)) >> 32;
148 }
149 
150 static inline u32 vmx_basic_vmcs_mem_type(u64 vmx_basic)
151 {
152 	return (vmx_basic & GENMASK_ULL(53, 50)) >> 50;
153 }
154 
155 static inline u64 vmx_basic_encode_vmcs_info(u32 revision, u16 size, u8 memtype)
156 {
157 	return revision | ((u64)size << 32) | ((u64)memtype << 50);
158 }
159 
160 #define VMX_MISC_SAVE_EFER_LMA			BIT_ULL(5)
161 #define VMX_MISC_ACTIVITY_HLT			BIT_ULL(6)
162 #define VMX_MISC_ACTIVITY_SHUTDOWN		BIT_ULL(7)
163 #define VMX_MISC_ACTIVITY_WAIT_SIPI		BIT_ULL(8)
164 #define VMX_MISC_INTEL_PT			BIT_ULL(14)
165 #define VMX_MISC_RDMSR_IN_SMM			BIT_ULL(15)
166 #define VMX_MISC_VMXOFF_BLOCK_SMI		BIT_ULL(28)
167 #define VMX_MISC_VMWRITE_SHADOW_RO_FIELDS	BIT_ULL(29)
168 #define VMX_MISC_ZERO_LEN_INS			BIT_ULL(30)
169 #define VMX_MISC_MSR_LIST_MULTIPLIER		512
170 
171 static inline int vmx_misc_preemption_timer_rate(u64 vmx_misc)
172 {
173 	return vmx_misc & GENMASK_ULL(4, 0);
174 }
175 
176 static inline int vmx_misc_cr3_count(u64 vmx_misc)
177 {
178 	return (vmx_misc & GENMASK_ULL(24, 16)) >> 16;
179 }
180 
181 static inline int vmx_misc_max_msr(u64 vmx_misc)
182 {
183 	return (vmx_misc & GENMASK_ULL(27, 25)) >> 25;
184 }
185 
186 static inline int vmx_misc_mseg_revid(u64 vmx_misc)
187 {
188 	return (vmx_misc & GENMASK_ULL(63, 32)) >> 32;
189 }
190 
191 /* VMCS Encodings */
192 enum vmcs_field {
193 	VIRTUAL_PROCESSOR_ID            = 0x00000000,
194 	POSTED_INTR_NV                  = 0x00000002,
195 	LAST_PID_POINTER_INDEX		= 0x00000008,
196 	GUEST_ES_SELECTOR               = 0x00000800,
197 	GUEST_CS_SELECTOR               = 0x00000802,
198 	GUEST_SS_SELECTOR               = 0x00000804,
199 	GUEST_DS_SELECTOR               = 0x00000806,
200 	GUEST_FS_SELECTOR               = 0x00000808,
201 	GUEST_GS_SELECTOR               = 0x0000080a,
202 	GUEST_LDTR_SELECTOR             = 0x0000080c,
203 	GUEST_TR_SELECTOR               = 0x0000080e,
204 	GUEST_INTR_STATUS               = 0x00000810,
205 	GUEST_PML_INDEX			= 0x00000812,
206 	HOST_ES_SELECTOR                = 0x00000c00,
207 	HOST_CS_SELECTOR                = 0x00000c02,
208 	HOST_SS_SELECTOR                = 0x00000c04,
209 	HOST_DS_SELECTOR                = 0x00000c06,
210 	HOST_FS_SELECTOR                = 0x00000c08,
211 	HOST_GS_SELECTOR                = 0x00000c0a,
212 	HOST_TR_SELECTOR                = 0x00000c0c,
213 	IO_BITMAP_A                     = 0x00002000,
214 	IO_BITMAP_A_HIGH                = 0x00002001,
215 	IO_BITMAP_B                     = 0x00002002,
216 	IO_BITMAP_B_HIGH                = 0x00002003,
217 	MSR_BITMAP                      = 0x00002004,
218 	MSR_BITMAP_HIGH                 = 0x00002005,
219 	VM_EXIT_MSR_STORE_ADDR          = 0x00002006,
220 	VM_EXIT_MSR_STORE_ADDR_HIGH     = 0x00002007,
221 	VM_EXIT_MSR_LOAD_ADDR           = 0x00002008,
222 	VM_EXIT_MSR_LOAD_ADDR_HIGH      = 0x00002009,
223 	VM_ENTRY_MSR_LOAD_ADDR          = 0x0000200a,
224 	VM_ENTRY_MSR_LOAD_ADDR_HIGH     = 0x0000200b,
225 	PML_ADDRESS			= 0x0000200e,
226 	PML_ADDRESS_HIGH		= 0x0000200f,
227 	TSC_OFFSET                      = 0x00002010,
228 	TSC_OFFSET_HIGH                 = 0x00002011,
229 	VIRTUAL_APIC_PAGE_ADDR          = 0x00002012,
230 	VIRTUAL_APIC_PAGE_ADDR_HIGH     = 0x00002013,
231 	APIC_ACCESS_ADDR		= 0x00002014,
232 	APIC_ACCESS_ADDR_HIGH		= 0x00002015,
233 	POSTED_INTR_DESC_ADDR           = 0x00002016,
234 	POSTED_INTR_DESC_ADDR_HIGH      = 0x00002017,
235 	VM_FUNCTION_CONTROL             = 0x00002018,
236 	VM_FUNCTION_CONTROL_HIGH        = 0x00002019,
237 	EPT_POINTER                     = 0x0000201a,
238 	EPT_POINTER_HIGH                = 0x0000201b,
239 	EOI_EXIT_BITMAP0                = 0x0000201c,
240 	EOI_EXIT_BITMAP0_HIGH           = 0x0000201d,
241 	EOI_EXIT_BITMAP1                = 0x0000201e,
242 	EOI_EXIT_BITMAP1_HIGH           = 0x0000201f,
243 	EOI_EXIT_BITMAP2                = 0x00002020,
244 	EOI_EXIT_BITMAP2_HIGH           = 0x00002021,
245 	EOI_EXIT_BITMAP3                = 0x00002022,
246 	EOI_EXIT_BITMAP3_HIGH           = 0x00002023,
247 	EPTP_LIST_ADDRESS               = 0x00002024,
248 	EPTP_LIST_ADDRESS_HIGH          = 0x00002025,
249 	VMREAD_BITMAP                   = 0x00002026,
250 	VMREAD_BITMAP_HIGH              = 0x00002027,
251 	VMWRITE_BITMAP                  = 0x00002028,
252 	VMWRITE_BITMAP_HIGH             = 0x00002029,
253 	VE_INFORMATION_ADDRESS		= 0x0000202A,
254 	VE_INFORMATION_ADDRESS_HIGH	= 0x0000202B,
255 	XSS_EXIT_BITMAP                 = 0x0000202C,
256 	XSS_EXIT_BITMAP_HIGH            = 0x0000202D,
257 	ENCLS_EXITING_BITMAP		= 0x0000202E,
258 	ENCLS_EXITING_BITMAP_HIGH	= 0x0000202F,
259 	TSC_MULTIPLIER                  = 0x00002032,
260 	TSC_MULTIPLIER_HIGH             = 0x00002033,
261 	TERTIARY_VM_EXEC_CONTROL	= 0x00002034,
262 	TERTIARY_VM_EXEC_CONTROL_HIGH	= 0x00002035,
263 	SHARED_EPT_POINTER		= 0x0000203C,
264 	PID_POINTER_TABLE		= 0x00002042,
265 	PID_POINTER_TABLE_HIGH		= 0x00002043,
266 	GUEST_PHYSICAL_ADDRESS          = 0x00002400,
267 	GUEST_PHYSICAL_ADDRESS_HIGH     = 0x00002401,
268 	VMCS_LINK_POINTER               = 0x00002800,
269 	VMCS_LINK_POINTER_HIGH          = 0x00002801,
270 	GUEST_IA32_DEBUGCTL             = 0x00002802,
271 	GUEST_IA32_DEBUGCTL_HIGH        = 0x00002803,
272 	GUEST_IA32_PAT			= 0x00002804,
273 	GUEST_IA32_PAT_HIGH		= 0x00002805,
274 	GUEST_IA32_EFER			= 0x00002806,
275 	GUEST_IA32_EFER_HIGH		= 0x00002807,
276 	GUEST_IA32_PERF_GLOBAL_CTRL	= 0x00002808,
277 	GUEST_IA32_PERF_GLOBAL_CTRL_HIGH= 0x00002809,
278 	GUEST_PDPTR0                    = 0x0000280a,
279 	GUEST_PDPTR0_HIGH               = 0x0000280b,
280 	GUEST_PDPTR1                    = 0x0000280c,
281 	GUEST_PDPTR1_HIGH               = 0x0000280d,
282 	GUEST_PDPTR2                    = 0x0000280e,
283 	GUEST_PDPTR2_HIGH               = 0x0000280f,
284 	GUEST_PDPTR3                    = 0x00002810,
285 	GUEST_PDPTR3_HIGH               = 0x00002811,
286 	GUEST_BNDCFGS                   = 0x00002812,
287 	GUEST_BNDCFGS_HIGH              = 0x00002813,
288 	GUEST_IA32_RTIT_CTL		= 0x00002814,
289 	GUEST_IA32_RTIT_CTL_HIGH	= 0x00002815,
290 	HOST_IA32_PAT			= 0x00002c00,
291 	HOST_IA32_PAT_HIGH		= 0x00002c01,
292 	HOST_IA32_EFER			= 0x00002c02,
293 	HOST_IA32_EFER_HIGH		= 0x00002c03,
294 	HOST_IA32_PERF_GLOBAL_CTRL	= 0x00002c04,
295 	HOST_IA32_PERF_GLOBAL_CTRL_HIGH	= 0x00002c05,
296 	PIN_BASED_VM_EXEC_CONTROL       = 0x00004000,
297 	CPU_BASED_VM_EXEC_CONTROL       = 0x00004002,
298 	EXCEPTION_BITMAP                = 0x00004004,
299 	PAGE_FAULT_ERROR_CODE_MASK      = 0x00004006,
300 	PAGE_FAULT_ERROR_CODE_MATCH     = 0x00004008,
301 	CR3_TARGET_COUNT                = 0x0000400a,
302 	VM_EXIT_CONTROLS                = 0x0000400c,
303 	VM_EXIT_MSR_STORE_COUNT         = 0x0000400e,
304 	VM_EXIT_MSR_LOAD_COUNT          = 0x00004010,
305 	VM_ENTRY_CONTROLS               = 0x00004012,
306 	VM_ENTRY_MSR_LOAD_COUNT         = 0x00004014,
307 	VM_ENTRY_INTR_INFO_FIELD        = 0x00004016,
308 	VM_ENTRY_EXCEPTION_ERROR_CODE   = 0x00004018,
309 	VM_ENTRY_INSTRUCTION_LEN        = 0x0000401a,
310 	TPR_THRESHOLD                   = 0x0000401c,
311 	SECONDARY_VM_EXEC_CONTROL       = 0x0000401e,
312 	PLE_GAP                         = 0x00004020,
313 	PLE_WINDOW                      = 0x00004022,
314 	NOTIFY_WINDOW                   = 0x00004024,
315 	VM_INSTRUCTION_ERROR            = 0x00004400,
316 	VM_EXIT_REASON                  = 0x00004402,
317 	VM_EXIT_INTR_INFO               = 0x00004404,
318 	VM_EXIT_INTR_ERROR_CODE         = 0x00004406,
319 	IDT_VECTORING_INFO_FIELD        = 0x00004408,
320 	IDT_VECTORING_ERROR_CODE        = 0x0000440a,
321 	VM_EXIT_INSTRUCTION_LEN         = 0x0000440c,
322 	VMX_INSTRUCTION_INFO            = 0x0000440e,
323 	GUEST_ES_LIMIT                  = 0x00004800,
324 	GUEST_CS_LIMIT                  = 0x00004802,
325 	GUEST_SS_LIMIT                  = 0x00004804,
326 	GUEST_DS_LIMIT                  = 0x00004806,
327 	GUEST_FS_LIMIT                  = 0x00004808,
328 	GUEST_GS_LIMIT                  = 0x0000480a,
329 	GUEST_LDTR_LIMIT                = 0x0000480c,
330 	GUEST_TR_LIMIT                  = 0x0000480e,
331 	GUEST_GDTR_LIMIT                = 0x00004810,
332 	GUEST_IDTR_LIMIT                = 0x00004812,
333 	GUEST_ES_AR_BYTES               = 0x00004814,
334 	GUEST_CS_AR_BYTES               = 0x00004816,
335 	GUEST_SS_AR_BYTES               = 0x00004818,
336 	GUEST_DS_AR_BYTES               = 0x0000481a,
337 	GUEST_FS_AR_BYTES               = 0x0000481c,
338 	GUEST_GS_AR_BYTES               = 0x0000481e,
339 	GUEST_LDTR_AR_BYTES             = 0x00004820,
340 	GUEST_TR_AR_BYTES               = 0x00004822,
341 	GUEST_INTERRUPTIBILITY_INFO     = 0x00004824,
342 	GUEST_ACTIVITY_STATE            = 0x00004826,
343 	GUEST_SYSENTER_CS               = 0x0000482A,
344 	VMX_PREEMPTION_TIMER_VALUE      = 0x0000482E,
345 	HOST_IA32_SYSENTER_CS           = 0x00004c00,
346 	CR0_GUEST_HOST_MASK             = 0x00006000,
347 	CR4_GUEST_HOST_MASK             = 0x00006002,
348 	CR0_READ_SHADOW                 = 0x00006004,
349 	CR4_READ_SHADOW                 = 0x00006006,
350 	CR3_TARGET_VALUE0               = 0x00006008,
351 	CR3_TARGET_VALUE1               = 0x0000600a,
352 	CR3_TARGET_VALUE2               = 0x0000600c,
353 	CR3_TARGET_VALUE3               = 0x0000600e,
354 	EXIT_QUALIFICATION              = 0x00006400,
355 	GUEST_LINEAR_ADDRESS            = 0x0000640a,
356 	GUEST_CR0                       = 0x00006800,
357 	GUEST_CR3                       = 0x00006802,
358 	GUEST_CR4                       = 0x00006804,
359 	GUEST_ES_BASE                   = 0x00006806,
360 	GUEST_CS_BASE                   = 0x00006808,
361 	GUEST_SS_BASE                   = 0x0000680a,
362 	GUEST_DS_BASE                   = 0x0000680c,
363 	GUEST_FS_BASE                   = 0x0000680e,
364 	GUEST_GS_BASE                   = 0x00006810,
365 	GUEST_LDTR_BASE                 = 0x00006812,
366 	GUEST_TR_BASE                   = 0x00006814,
367 	GUEST_GDTR_BASE                 = 0x00006816,
368 	GUEST_IDTR_BASE                 = 0x00006818,
369 	GUEST_DR7                       = 0x0000681a,
370 	GUEST_RSP                       = 0x0000681c,
371 	GUEST_RIP                       = 0x0000681e,
372 	GUEST_RFLAGS                    = 0x00006820,
373 	GUEST_PENDING_DBG_EXCEPTIONS    = 0x00006822,
374 	GUEST_SYSENTER_ESP              = 0x00006824,
375 	GUEST_SYSENTER_EIP              = 0x00006826,
376 	GUEST_S_CET                     = 0x00006828,
377 	GUEST_SSP                       = 0x0000682a,
378 	GUEST_INTR_SSP_TABLE            = 0x0000682c,
379 	HOST_CR0                        = 0x00006c00,
380 	HOST_CR3                        = 0x00006c02,
381 	HOST_CR4                        = 0x00006c04,
382 	HOST_FS_BASE                    = 0x00006c06,
383 	HOST_GS_BASE                    = 0x00006c08,
384 	HOST_TR_BASE                    = 0x00006c0a,
385 	HOST_GDTR_BASE                  = 0x00006c0c,
386 	HOST_IDTR_BASE                  = 0x00006c0e,
387 	HOST_IA32_SYSENTER_ESP          = 0x00006c10,
388 	HOST_IA32_SYSENTER_EIP          = 0x00006c12,
389 	HOST_RSP                        = 0x00006c14,
390 	HOST_RIP                        = 0x00006c16,
391 	HOST_S_CET                      = 0x00006c18,
392 	HOST_SSP                        = 0x00006c1a,
393 	HOST_INTR_SSP_TABLE             = 0x00006c1c
394 };
395 
396 /*
397  * Interruption-information format
398  */
399 #define INTR_INFO_VECTOR_MASK           0xff            /* 7:0 */
400 #define INTR_INFO_INTR_TYPE_MASK        0x700           /* 10:8 */
401 #define INTR_INFO_DELIVER_CODE_MASK     0x800           /* 11 */
402 #define INTR_INFO_UNBLOCK_NMI		0x1000		/* 12 */
403 #define INTR_INFO_VALID_MASK            0x80000000      /* 31 */
404 #define INTR_INFO_RESVD_BITS_MASK       0x7ffff000
405 
406 #define VECTORING_INFO_VECTOR_MASK           	INTR_INFO_VECTOR_MASK
407 #define VECTORING_INFO_TYPE_MASK        	INTR_INFO_INTR_TYPE_MASK
408 #define VECTORING_INFO_DELIVER_CODE_MASK    	INTR_INFO_DELIVER_CODE_MASK
409 #define VECTORING_INFO_VALID_MASK       	INTR_INFO_VALID_MASK
410 
411 #define INTR_TYPE_EXT_INTR		(EVENT_TYPE_EXTINT << 8)	/* external interrupt */
412 #define INTR_TYPE_RESERVED		(EVENT_TYPE_RESERVED << 8)	/* reserved */
413 #define INTR_TYPE_NMI_INTR		(EVENT_TYPE_NMI << 8)		/* NMI */
414 #define INTR_TYPE_HARD_EXCEPTION	(EVENT_TYPE_HWEXC << 8)		/* processor exception */
415 #define INTR_TYPE_SOFT_INTR		(EVENT_TYPE_SWINT << 8)		/* software interrupt */
416 #define INTR_TYPE_PRIV_SW_EXCEPTION	(EVENT_TYPE_PRIV_SWEXC << 8)	/* ICE breakpoint */
417 #define INTR_TYPE_SOFT_EXCEPTION	(EVENT_TYPE_SWEXC << 8)		/* software exception */
418 #define INTR_TYPE_OTHER_EVENT		(EVENT_TYPE_OTHER << 8)		/* other event */
419 
420 /* GUEST_INTERRUPTIBILITY_INFO flags. */
421 #define GUEST_INTR_STATE_STI		0x00000001
422 #define GUEST_INTR_STATE_MOV_SS		0x00000002
423 #define GUEST_INTR_STATE_SMI		0x00000004
424 #define GUEST_INTR_STATE_NMI		0x00000008
425 #define GUEST_INTR_STATE_ENCLAVE_INTR	0x00000010
426 
427 /* GUEST_ACTIVITY_STATE flags */
428 #define GUEST_ACTIVITY_ACTIVE		0
429 #define GUEST_ACTIVITY_HLT		1
430 #define GUEST_ACTIVITY_SHUTDOWN		2
431 #define GUEST_ACTIVITY_WAIT_SIPI	3
432 
433 /*
434  * Exit Qualifications for MOV for Control Register Access
435  */
436 #define CONTROL_REG_ACCESS_NUM          0x7     /* 2:0, number of control reg.*/
437 #define CONTROL_REG_ACCESS_TYPE         0x30    /* 5:4, access type */
438 #define CONTROL_REG_ACCESS_REG          0xf00   /* 10:8, general purpose reg. */
439 #define LMSW_SOURCE_DATA_SHIFT 16
440 #define LMSW_SOURCE_DATA  (0xFFFF << LMSW_SOURCE_DATA_SHIFT) /* 16:31 lmsw source */
441 #define REG_EAX                         (0 << 8)
442 #define REG_ECX                         (1 << 8)
443 #define REG_EDX                         (2 << 8)
444 #define REG_EBX                         (3 << 8)
445 #define REG_ESP                         (4 << 8)
446 #define REG_EBP                         (5 << 8)
447 #define REG_ESI                         (6 << 8)
448 #define REG_EDI                         (7 << 8)
449 #define REG_R8                         (8 << 8)
450 #define REG_R9                         (9 << 8)
451 #define REG_R10                        (10 << 8)
452 #define REG_R11                        (11 << 8)
453 #define REG_R12                        (12 << 8)
454 #define REG_R13                        (13 << 8)
455 #define REG_R14                        (14 << 8)
456 #define REG_R15                        (15 << 8)
457 
458 /*
459  * Exit Qualifications for MOV for Debug Register Access
460  */
461 #define DEBUG_REG_ACCESS_NUM            0x7     /* 2:0, number of debug reg. */
462 #define DEBUG_REG_ACCESS_TYPE           0x10    /* 4, direction of access */
463 #define TYPE_MOV_TO_DR                  (0 << 4)
464 #define TYPE_MOV_FROM_DR                (1 << 4)
465 #define DEBUG_REG_ACCESS_REG(eq)        (((eq) >> 8) & 0xf) /* 11:8, general purpose reg. */
466 
467 
468 /*
469  * Exit Qualifications for APIC-Access
470  */
471 #define APIC_ACCESS_OFFSET              0xfff   /* 11:0, offset within the APIC page */
472 #define APIC_ACCESS_TYPE                0xf000  /* 15:12, access type */
473 #define TYPE_LINEAR_APIC_INST_READ      (0 << 12)
474 #define TYPE_LINEAR_APIC_INST_WRITE     (1 << 12)
475 #define TYPE_LINEAR_APIC_INST_FETCH     (2 << 12)
476 #define TYPE_LINEAR_APIC_EVENT          (3 << 12)
477 #define TYPE_PHYSICAL_APIC_EVENT        (10 << 12)
478 #define TYPE_PHYSICAL_APIC_INST         (15 << 12)
479 
480 /* segment AR in VMCS -- these are different from what LAR reports */
481 #define VMX_SEGMENT_AR_L_MASK (1 << 13)
482 
483 #define VMX_AR_TYPE_ACCESSES_MASK 1
484 #define VMX_AR_TYPE_READABLE_MASK (1 << 1)
485 #define VMX_AR_TYPE_WRITEABLE_MASK (1 << 2)
486 #define VMX_AR_TYPE_CODE_MASK (1 << 3)
487 #define VMX_AR_TYPE_MASK 0x0f
488 #define VMX_AR_TYPE_BUSY_64_TSS 11
489 #define VMX_AR_TYPE_BUSY_32_TSS 11
490 #define VMX_AR_TYPE_BUSY_16_TSS 3
491 #define VMX_AR_TYPE_LDT 2
492 
493 #define VMX_AR_UNUSABLE_MASK (1 << 16)
494 #define VMX_AR_S_MASK (1 << 4)
495 #define VMX_AR_P_MASK (1 << 7)
496 #define VMX_AR_L_MASK (1 << 13)
497 #define VMX_AR_DB_MASK (1 << 14)
498 #define VMX_AR_G_MASK (1 << 15)
499 #define VMX_AR_DPL_SHIFT 5
500 #define VMX_AR_DPL(ar) (((ar) >> VMX_AR_DPL_SHIFT) & 3)
501 
502 #define VMX_AR_RESERVD_MASK 0xfffe0f00
503 
504 #define TSS_PRIVATE_MEMSLOT			(KVM_USER_MEM_SLOTS + 0)
505 #define APIC_ACCESS_PAGE_PRIVATE_MEMSLOT	(KVM_USER_MEM_SLOTS + 1)
506 #define IDENTITY_PAGETABLE_PRIVATE_MEMSLOT	(KVM_USER_MEM_SLOTS + 2)
507 
508 #define VMX_NR_VPIDS				(1 << 16)
509 #define VMX_VPID_EXTENT_INDIVIDUAL_ADDR		0
510 #define VMX_VPID_EXTENT_SINGLE_CONTEXT		1
511 #define VMX_VPID_EXTENT_ALL_CONTEXT		2
512 #define VMX_VPID_EXTENT_SINGLE_NON_GLOBAL	3
513 
514 #define VMX_EPT_EXTENT_CONTEXT			1
515 #define VMX_EPT_EXTENT_GLOBAL			2
516 #define VMX_EPT_EXTENT_SHIFT			24
517 
518 #define VMX_EPT_EXECUTE_ONLY_BIT		(1ull)
519 #define VMX_EPT_PAGE_WALK_4_BIT			(1ull << 6)
520 #define VMX_EPT_PAGE_WALK_5_BIT			(1ull << 7)
521 #define VMX_EPTP_UC_BIT				(1ull << 8)
522 #define VMX_EPTP_WB_BIT				(1ull << 14)
523 #define VMX_EPT_2MB_PAGE_BIT			(1ull << 16)
524 #define VMX_EPT_1GB_PAGE_BIT			(1ull << 17)
525 #define VMX_EPT_INVEPT_BIT			(1ull << 20)
526 #define VMX_EPT_AD_BIT				    (1ull << 21)
527 #define VMX_EPT_EXTENT_CONTEXT_BIT		(1ull << 25)
528 #define VMX_EPT_EXTENT_GLOBAL_BIT		(1ull << 26)
529 
530 #define VMX_VPID_INVVPID_BIT                    (1ull << 0) /* (32 - 32) */
531 #define VMX_VPID_EXTENT_INDIVIDUAL_ADDR_BIT     (1ull << 8) /* (40 - 32) */
532 #define VMX_VPID_EXTENT_SINGLE_CONTEXT_BIT      (1ull << 9) /* (41 - 32) */
533 #define VMX_VPID_EXTENT_GLOBAL_CONTEXT_BIT      (1ull << 10) /* (42 - 32) */
534 #define VMX_VPID_EXTENT_SINGLE_NON_GLOBAL_BIT   (1ull << 11) /* (43 - 32) */
535 
536 #define VMX_EPT_MT_EPTE_SHIFT			3
537 #define VMX_EPTP_PWL_MASK			0x38ull
538 #define VMX_EPTP_PWL_4				0x18ull
539 #define VMX_EPTP_PWL_5				0x20ull
540 #define VMX_EPTP_AD_ENABLE_BIT			(1ull << 6)
541 /* The EPTP memtype is encoded in bits 2:0, i.e. doesn't need to be shifted. */
542 #define VMX_EPTP_MT_MASK			0x7ull
543 #define VMX_EPTP_MT_WB				X86_MEMTYPE_WB
544 #define VMX_EPTP_MT_UC				X86_MEMTYPE_UC
545 #define VMX_EPT_READABLE_MASK			0x1ull
546 #define VMX_EPT_WRITABLE_MASK			0x2ull
547 #define VMX_EPT_EXECUTABLE_MASK			0x4ull
548 #define VMX_EPT_IPAT_BIT    			(1ull << 6)
549 #define VMX_EPT_ACCESS_BIT			(1ull << 8)
550 #define VMX_EPT_DIRTY_BIT			(1ull << 9)
551 #define VMX_EPT_SUPPRESS_VE_BIT			(1ull << 63)
552 #define VMX_EPT_RWX_MASK                        (VMX_EPT_READABLE_MASK |       \
553 						 VMX_EPT_WRITABLE_MASK |       \
554 						 VMX_EPT_EXECUTABLE_MASK)
555 #define VMX_EPT_MT_MASK				(7ull << VMX_EPT_MT_EPTE_SHIFT)
556 
557 static inline u8 vmx_eptp_page_walk_level(u64 eptp)
558 {
559 	u64 encoded_level = eptp & VMX_EPTP_PWL_MASK;
560 
561 	if (encoded_level == VMX_EPTP_PWL_5)
562 		return 5;
563 
564 	/* @eptp must be pre-validated by the caller. */
565 	WARN_ON_ONCE(encoded_level != VMX_EPTP_PWL_4);
566 	return 4;
567 }
568 
569 /* The mask to use to trigger an EPT Misconfiguration in order to track MMIO */
570 #define VMX_EPT_MISCONFIG_WX_VALUE		(VMX_EPT_WRITABLE_MASK |       \
571 						 VMX_EPT_EXECUTABLE_MASK)
572 
573 #define VMX_EPT_IDENTITY_PAGETABLE_ADDR		0xfffbc000ul
574 
575 struct vmx_msr_entry {
576 	u32 index;
577 	u32 reserved;
578 	u64 value;
579 } __aligned(16);
580 
581 /*
582  * Exit Qualifications for entry failure during or after loading guest state
583  */
584 enum vm_entry_failure_code {
585 	ENTRY_FAIL_DEFAULT		= 0,
586 	ENTRY_FAIL_PDPTE		= 2,
587 	ENTRY_FAIL_NMI			= 3,
588 	ENTRY_FAIL_VMCS_LINK_PTR	= 4,
589 };
590 
591 /*
592  * Exit Qualifications for EPT Violations
593  */
594 #define EPT_VIOLATION_ACC_READ		BIT(0)
595 #define EPT_VIOLATION_ACC_WRITE		BIT(1)
596 #define EPT_VIOLATION_ACC_INSTR		BIT(2)
597 #define EPT_VIOLATION_PROT_READ		BIT(3)
598 #define EPT_VIOLATION_PROT_WRITE	BIT(4)
599 #define EPT_VIOLATION_PROT_EXEC		BIT(5)
600 #define EPT_VIOLATION_EXEC_FOR_RING3_LIN BIT(6)
601 #define EPT_VIOLATION_PROT_MASK		(EPT_VIOLATION_PROT_READ  | \
602 					 EPT_VIOLATION_PROT_WRITE | \
603 					 EPT_VIOLATION_PROT_EXEC)
604 #define EPT_VIOLATION_GVA_IS_VALID	BIT(7)
605 #define EPT_VIOLATION_GVA_TRANSLATED	BIT(8)
606 
607 #define EPT_VIOLATION_RWX_TO_PROT(__epte) (((__epte) & VMX_EPT_RWX_MASK) << 3)
608 
609 static_assert(EPT_VIOLATION_RWX_TO_PROT(VMX_EPT_RWX_MASK) ==
610 	      (EPT_VIOLATION_PROT_READ | EPT_VIOLATION_PROT_WRITE | EPT_VIOLATION_PROT_EXEC));
611 
612 /*
613  * Exit Qualifications for NOTIFY VM EXIT
614  */
615 #define NOTIFY_VM_CONTEXT_INVALID     BIT(0)
616 
617 /*
618  * VM-instruction error numbers
619  */
620 enum vm_instruction_error_number {
621 	VMXERR_VMCALL_IN_VMX_ROOT_OPERATION = 1,
622 	VMXERR_VMCLEAR_INVALID_ADDRESS = 2,
623 	VMXERR_VMCLEAR_VMXON_POINTER = 3,
624 	VMXERR_VMLAUNCH_NONCLEAR_VMCS = 4,
625 	VMXERR_VMRESUME_NONLAUNCHED_VMCS = 5,
626 	VMXERR_VMRESUME_AFTER_VMXOFF = 6,
627 	VMXERR_ENTRY_INVALID_CONTROL_FIELD = 7,
628 	VMXERR_ENTRY_INVALID_HOST_STATE_FIELD = 8,
629 	VMXERR_VMPTRLD_INVALID_ADDRESS = 9,
630 	VMXERR_VMPTRLD_VMXON_POINTER = 10,
631 	VMXERR_VMPTRLD_INCORRECT_VMCS_REVISION_ID = 11,
632 	VMXERR_UNSUPPORTED_VMCS_COMPONENT = 12,
633 	VMXERR_VMWRITE_READ_ONLY_VMCS_COMPONENT = 13,
634 	VMXERR_VMXON_IN_VMX_ROOT_OPERATION = 15,
635 	VMXERR_ENTRY_INVALID_EXECUTIVE_VMCS_POINTER = 16,
636 	VMXERR_ENTRY_NONLAUNCHED_EXECUTIVE_VMCS = 17,
637 	VMXERR_ENTRY_EXECUTIVE_VMCS_POINTER_NOT_VMXON_POINTER = 18,
638 	VMXERR_VMCALL_NONCLEAR_VMCS = 19,
639 	VMXERR_VMCALL_INVALID_VM_EXIT_CONTROL_FIELDS = 20,
640 	VMXERR_VMCALL_INCORRECT_MSEG_REVISION_ID = 22,
641 	VMXERR_VMXOFF_UNDER_DUAL_MONITOR_TREATMENT_OF_SMIS_AND_SMM = 23,
642 	VMXERR_VMCALL_INVALID_SMM_MONITOR_FEATURES = 24,
643 	VMXERR_ENTRY_INVALID_VM_EXECUTION_CONTROL_FIELDS_IN_EXECUTIVE_VMCS = 25,
644 	VMXERR_ENTRY_EVENTS_BLOCKED_BY_MOV_SS = 26,
645 	VMXERR_INVALID_OPERAND_TO_INVEPT_INVVPID = 28,
646 };
647 
648 /*
649  * VM-instruction errors that can be encountered on VM-Enter, used to trace
650  * nested VM-Enter failures reported by hardware.  Errors unique to VM-Enter
651  * from a SMI Transfer Monitor are not included as things have gone seriously
652  * sideways if we get one of those...
653  */
654 #define VMX_VMENTER_INSTRUCTION_ERRORS \
655 	{ VMXERR_VMLAUNCH_NONCLEAR_VMCS,		"VMLAUNCH_NONCLEAR_VMCS" }, \
656 	{ VMXERR_VMRESUME_NONLAUNCHED_VMCS,		"VMRESUME_NONLAUNCHED_VMCS" }, \
657 	{ VMXERR_VMRESUME_AFTER_VMXOFF,			"VMRESUME_AFTER_VMXOFF" }, \
658 	{ VMXERR_ENTRY_INVALID_CONTROL_FIELD,		"VMENTRY_INVALID_CONTROL_FIELD" }, \
659 	{ VMXERR_ENTRY_INVALID_HOST_STATE_FIELD,	"VMENTRY_INVALID_HOST_STATE_FIELD" }, \
660 	{ VMXERR_ENTRY_EVENTS_BLOCKED_BY_MOV_SS,	"VMENTRY_EVENTS_BLOCKED_BY_MOV_SS" }
661 
662 enum vmx_l1d_flush_state {
663 	VMENTER_L1D_FLUSH_AUTO,
664 	VMENTER_L1D_FLUSH_NEVER,
665 	VMENTER_L1D_FLUSH_COND,
666 	VMENTER_L1D_FLUSH_ALWAYS,
667 	VMENTER_L1D_FLUSH_EPT_DISABLED,
668 	VMENTER_L1D_FLUSH_NOT_REQUIRED,
669 };
670 
671 extern enum vmx_l1d_flush_state l1tf_vmx_mitigation;
672 
673 struct vmx_ve_information {
674 	u32 exit_reason;
675 	u32 delivery;
676 	u64 exit_qualification;
677 	u64 guest_linear_address;
678 	u64 guest_physical_address;
679 	u16 eptp_index;
680 };
681 
682 #endif
683