5 * vmx.h: VMX Architecture related definitions
6 * Copyright (c) 2004, Intel Corporation.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms and conditions of the GNU General Public License,
10 * version 2, as published by the Free Software Foundation.
12 * This program is distributed in the hope it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 * You should have received a copy of the GNU General Public License along with
18 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
19 * Place - Suite 330, Boston, MA 02111-1307 USA.
21 * A few random additions are:
22 * Copyright (C) 2006 Qumranet
23 * Avi Kivity <avi@qumranet.com>
24 * Yaniv Kamay <yaniv@qumranet.com>
29 * Definitions of Primary Processor-Based VM-Execution Controls.
31 #define CPU_BASED_VIRTUAL_INTR_PENDING 0x00000004
32 #define CPU_BASED_USE_TSC_OFFSETING 0x00000008
33 #define CPU_BASED_HLT_EXITING 0x00000080
34 #define CPU_BASED_INVLPG_EXITING 0x00000200
35 #define CPU_BASED_MWAIT_EXITING 0x00000400
36 #define CPU_BASED_RDPMC_EXITING 0x00000800
37 #define CPU_BASED_RDTSC_EXITING 0x00001000
38 #define CPU_BASED_CR3_LOAD_EXITING 0x00008000
39 #define CPU_BASED_CR3_STORE_EXITING 0x00010000
40 #define CPU_BASED_CR8_LOAD_EXITING 0x00080000
41 #define CPU_BASED_CR8_STORE_EXITING 0x00100000
42 #define CPU_BASED_TPR_SHADOW 0x00200000
43 #define CPU_BASED_VIRTUAL_NMI_PENDING 0x00400000
44 #define CPU_BASED_MOV_DR_EXITING 0x00800000
45 #define CPU_BASED_UNCOND_IO_EXITING 0x01000000
46 #define CPU_BASED_USE_IO_BITMAPS 0x02000000
47 #define CPU_BASED_USE_MSR_BITMAPS 0x10000000
48 #define CPU_BASED_MONITOR_EXITING 0x20000000
49 #define CPU_BASED_PAUSE_EXITING 0x40000000
50 #define CPU_BASED_ACTIVATE_SECONDARY_CONTROLS 0x80000000
52 * Definitions of Secondary Processor-Based VM-Execution Controls.
54 #define SECONDARY_EXEC_VIRTUALIZE_APIC_ACCESSES 0x00000001
55 #define SECONDARY_EXEC_ENABLE_EPT 0x00000002
56 #define SECONDARY_EXEC_ENABLE_VPID 0x00000020
57 #define SECONDARY_EXEC_WBINVD_EXITING 0x00000040
58 #define SECONDARY_EXEC_UNRESTRICTED_GUEST 0x00000080
59 #define SECONDARY_EXEC_PAUSE_LOOP_EXITING 0x00000400
62 #define PIN_BASED_EXT_INTR_MASK 0x00000001
63 #define PIN_BASED_NMI_EXITING 0x00000008
64 #define PIN_BASED_VIRTUAL_NMIS 0x00000020
66 #define VM_EXIT_HOST_ADDR_SPACE_SIZE 0x00000200
67 #define VM_EXIT_ACK_INTR_ON_EXIT 0x00008000
68 #define VM_EXIT_SAVE_IA32_PAT 0x00040000
69 #define VM_EXIT_LOAD_IA32_PAT 0x00080000
71 #define VM_ENTRY_IA32E_MODE 0x00000200
72 #define VM_ENTRY_SMM 0x00000400
73 #define VM_ENTRY_DEACT_DUAL_MONITOR 0x00000800
74 #define VM_ENTRY_LOAD_IA32_PAT 0x00004000
78 VIRTUAL_PROCESSOR_ID = 0x00000000,
79 GUEST_ES_SELECTOR = 0x00000800,
80 GUEST_CS_SELECTOR = 0x00000802,
81 GUEST_SS_SELECTOR = 0x00000804,
82 GUEST_DS_SELECTOR = 0x00000806,
83 GUEST_FS_SELECTOR = 0x00000808,
84 GUEST_GS_SELECTOR = 0x0000080a,
85 GUEST_LDTR_SELECTOR = 0x0000080c,
86 GUEST_TR_SELECTOR = 0x0000080e,
87 HOST_ES_SELECTOR = 0x00000c00,
88 HOST_CS_SELECTOR = 0x00000c02,
89 HOST_SS_SELECTOR = 0x00000c04,
90 HOST_DS_SELECTOR = 0x00000c06,
91 HOST_FS_SELECTOR = 0x00000c08,
92 HOST_GS_SELECTOR = 0x00000c0a,
93 HOST_TR_SELECTOR = 0x00000c0c,
94 IO_BITMAP_A = 0x00002000,
95 IO_BITMAP_A_HIGH = 0x00002001,
96 IO_BITMAP_B = 0x00002002,
97 IO_BITMAP_B_HIGH = 0x00002003,
98 MSR_BITMAP = 0x00002004,
99 MSR_BITMAP_HIGH = 0x00002005,
100 VM_EXIT_MSR_STORE_ADDR = 0x00002006,
101 VM_EXIT_MSR_STORE_ADDR_HIGH = 0x00002007,
102 VM_EXIT_MSR_LOAD_ADDR = 0x00002008,
103 VM_EXIT_MSR_LOAD_ADDR_HIGH = 0x00002009,
104 VM_ENTRY_MSR_LOAD_ADDR = 0x0000200a,
105 VM_ENTRY_MSR_LOAD_ADDR_HIGH = 0x0000200b,
106 TSC_OFFSET = 0x00002010,
107 TSC_OFFSET_HIGH = 0x00002011,
108 VIRTUAL_APIC_PAGE_ADDR = 0x00002012,
109 VIRTUAL_APIC_PAGE_ADDR_HIGH = 0x00002013,
110 APIC_ACCESS_ADDR = 0x00002014,
111 APIC_ACCESS_ADDR_HIGH = 0x00002015,
112 EPT_POINTER = 0x0000201a,
113 EPT_POINTER_HIGH = 0x0000201b,
114 GUEST_PHYSICAL_ADDRESS = 0x00002400,
115 GUEST_PHYSICAL_ADDRESS_HIGH = 0x00002401,
116 VMCS_LINK_POINTER = 0x00002800,
117 VMCS_LINK_POINTER_HIGH = 0x00002801,
118 GUEST_IA32_DEBUGCTL = 0x00002802,
119 GUEST_IA32_DEBUGCTL_HIGH = 0x00002803,
120 GUEST_IA32_PAT = 0x00002804,
121 GUEST_IA32_PAT_HIGH = 0x00002805,
122 GUEST_PDPTR0 = 0x0000280a,
123 GUEST_PDPTR0_HIGH = 0x0000280b,
124 GUEST_PDPTR1 = 0x0000280c,
125 GUEST_PDPTR1_HIGH = 0x0000280d,
126 GUEST_PDPTR2 = 0x0000280e,
127 GUEST_PDPTR2_HIGH = 0x0000280f,
128 GUEST_PDPTR3 = 0x00002810,
129 GUEST_PDPTR3_HIGH = 0x00002811,
130 HOST_IA32_PAT = 0x00002c00,
131 HOST_IA32_PAT_HIGH = 0x00002c01,
132 PIN_BASED_VM_EXEC_CONTROL = 0x00004000,
133 CPU_BASED_VM_EXEC_CONTROL = 0x00004002,
134 EXCEPTION_BITMAP = 0x00004004,
135 PAGE_FAULT_ERROR_CODE_MASK = 0x00004006,
136 PAGE_FAULT_ERROR_CODE_MATCH = 0x00004008,
137 CR3_TARGET_COUNT = 0x0000400a,
138 VM_EXIT_CONTROLS = 0x0000400c,
139 VM_EXIT_MSR_STORE_COUNT = 0x0000400e,
140 VM_EXIT_MSR_LOAD_COUNT = 0x00004010,
141 VM_ENTRY_CONTROLS = 0x00004012,
142 VM_ENTRY_MSR_LOAD_COUNT = 0x00004014,
143 VM_ENTRY_INTR_INFO_FIELD = 0x00004016,
144 VM_ENTRY_EXCEPTION_ERROR_CODE = 0x00004018,
145 VM_ENTRY_INSTRUCTION_LEN = 0x0000401a,
146 TPR_THRESHOLD = 0x0000401c,
147 SECONDARY_VM_EXEC_CONTROL = 0x0000401e,
148 PLE_GAP = 0x00004020,
149 PLE_WINDOW = 0x00004022,
150 VM_INSTRUCTION_ERROR = 0x00004400,
151 VM_EXIT_REASON = 0x00004402,
152 VM_EXIT_INTR_INFO = 0x00004404,
153 VM_EXIT_INTR_ERROR_CODE = 0x00004406,
154 IDT_VECTORING_INFO_FIELD = 0x00004408,
155 IDT_VECTORING_ERROR_CODE = 0x0000440a,
156 VM_EXIT_INSTRUCTION_LEN = 0x0000440c,
157 VMX_INSTRUCTION_INFO = 0x0000440e,
158 GUEST_ES_LIMIT = 0x00004800,
159 GUEST_CS_LIMIT = 0x00004802,
160 GUEST_SS_LIMIT = 0x00004804,
161 GUEST_DS_LIMIT = 0x00004806,
162 GUEST_FS_LIMIT = 0x00004808,
163 GUEST_GS_LIMIT = 0x0000480a,
164 GUEST_LDTR_LIMIT = 0x0000480c,
165 GUEST_TR_LIMIT = 0x0000480e,
166 GUEST_GDTR_LIMIT = 0x00004810,
167 GUEST_IDTR_LIMIT = 0x00004812,
168 GUEST_ES_AR_BYTES = 0x00004814,
169 GUEST_CS_AR_BYTES = 0x00004816,
170 GUEST_SS_AR_BYTES = 0x00004818,
171 GUEST_DS_AR_BYTES = 0x0000481a,
172 GUEST_FS_AR_BYTES = 0x0000481c,
173 GUEST_GS_AR_BYTES = 0x0000481e,
174 GUEST_LDTR_AR_BYTES = 0x00004820,
175 GUEST_TR_AR_BYTES = 0x00004822,
176 GUEST_INTERRUPTIBILITY_INFO = 0x00004824,
177 GUEST_ACTIVITY_STATE = 0X00004826,
178 GUEST_SYSENTER_CS = 0x0000482A,
179 HOST_IA32_SYSENTER_CS = 0x00004c00,
180 CR0_GUEST_HOST_MASK = 0x00006000,
181 CR4_GUEST_HOST_MASK = 0x00006002,
182 CR0_READ_SHADOW = 0x00006004,
183 CR4_READ_SHADOW = 0x00006006,
184 CR3_TARGET_VALUE0 = 0x00006008,
185 CR3_TARGET_VALUE1 = 0x0000600a,
186 CR3_TARGET_VALUE2 = 0x0000600c,
187 CR3_TARGET_VALUE3 = 0x0000600e,
188 EXIT_QUALIFICATION = 0x00006400,
189 GUEST_LINEAR_ADDRESS = 0x0000640a,
190 GUEST_CR0 = 0x00006800,
191 GUEST_CR3 = 0x00006802,
192 GUEST_CR4 = 0x00006804,
193 GUEST_ES_BASE = 0x00006806,
194 GUEST_CS_BASE = 0x00006808,
195 GUEST_SS_BASE = 0x0000680a,
196 GUEST_DS_BASE = 0x0000680c,
197 GUEST_FS_BASE = 0x0000680e,
198 GUEST_GS_BASE = 0x00006810,
199 GUEST_LDTR_BASE = 0x00006812,
200 GUEST_TR_BASE = 0x00006814,
201 GUEST_GDTR_BASE = 0x00006816,
202 GUEST_IDTR_BASE = 0x00006818,
203 GUEST_DR7 = 0x0000681a,
204 GUEST_RSP = 0x0000681c,
205 GUEST_RIP = 0x0000681e,
206 GUEST_RFLAGS = 0x00006820,
207 GUEST_PENDING_DBG_EXCEPTIONS = 0x00006822,
208 GUEST_SYSENTER_ESP = 0x00006824,
209 GUEST_SYSENTER_EIP = 0x00006826,
210 HOST_CR0 = 0x00006c00,
211 HOST_CR3 = 0x00006c02,
212 HOST_CR4 = 0x00006c04,
213 HOST_FS_BASE = 0x00006c06,
214 HOST_GS_BASE = 0x00006c08,
215 HOST_TR_BASE = 0x00006c0a,
216 HOST_GDTR_BASE = 0x00006c0c,
217 HOST_IDTR_BASE = 0x00006c0e,
218 HOST_IA32_SYSENTER_ESP = 0x00006c10,
219 HOST_IA32_SYSENTER_EIP = 0x00006c12,
220 HOST_RSP = 0x00006c14,
221 HOST_RIP = 0x00006c16,
224 #define VMX_EXIT_REASONS_FAILED_VMENTRY 0x80000000
226 #define EXIT_REASON_EXCEPTION_NMI 0
227 #define EXIT_REASON_EXTERNAL_INTERRUPT 1
228 #define EXIT_REASON_TRIPLE_FAULT 2
230 #define EXIT_REASON_PENDING_INTERRUPT 7
231 #define EXIT_REASON_NMI_WINDOW 8
232 #define EXIT_REASON_TASK_SWITCH 9
233 #define EXIT_REASON_CPUID 10
234 #define EXIT_REASON_HLT 12
235 #define EXIT_REASON_INVLPG 14
236 #define EXIT_REASON_RDPMC 15
237 #define EXIT_REASON_RDTSC 16
238 #define EXIT_REASON_VMCALL 18
239 #define EXIT_REASON_VMCLEAR 19
240 #define EXIT_REASON_VMLAUNCH 20
241 #define EXIT_REASON_VMPTRLD 21
242 #define EXIT_REASON_VMPTRST 22
243 #define EXIT_REASON_VMREAD 23
244 #define EXIT_REASON_VMRESUME 24
245 #define EXIT_REASON_VMWRITE 25
246 #define EXIT_REASON_VMOFF 26
247 #define EXIT_REASON_VMON 27
248 #define EXIT_REASON_CR_ACCESS 28
249 #define EXIT_REASON_DR_ACCESS 29
250 #define EXIT_REASON_IO_INSTRUCTION 30
251 #define EXIT_REASON_MSR_READ 31
252 #define EXIT_REASON_MSR_WRITE 32
253 #define EXIT_REASON_MWAIT_INSTRUCTION 36
254 #define EXIT_REASON_PAUSE_INSTRUCTION 40
255 #define EXIT_REASON_MCE_DURING_VMENTRY 41
256 #define EXIT_REASON_TPR_BELOW_THRESHOLD 43
257 #define EXIT_REASON_APIC_ACCESS 44
258 #define EXIT_REASON_EPT_VIOLATION 48
259 #define EXIT_REASON_EPT_MISCONFIG 49
260 #define EXIT_REASON_WBINVD 54
263 * Interruption-information format
265 #define INTR_INFO_VECTOR_MASK 0xff /* 7:0 */
266 #define INTR_INFO_INTR_TYPE_MASK 0x700 /* 10:8 */
267 #define INTR_INFO_DELIVER_CODE_MASK 0x800 /* 11 */
268 #define INTR_INFO_UNBLOCK_NMI 0x1000 /* 12 */
269 #define INTR_INFO_VALID_MASK 0x80000000 /* 31 */
270 #define INTR_INFO_RESVD_BITS_MASK 0x7ffff000
272 #define VECTORING_INFO_VECTOR_MASK INTR_INFO_VECTOR_MASK
273 #define VECTORING_INFO_TYPE_MASK INTR_INFO_INTR_TYPE_MASK
274 #define VECTORING_INFO_DELIVER_CODE_MASK INTR_INFO_DELIVER_CODE_MASK
275 #define VECTORING_INFO_VALID_MASK INTR_INFO_VALID_MASK
277 #define INTR_TYPE_EXT_INTR (0 << 8) /* external interrupt */
278 #define INTR_TYPE_NMI_INTR (2 << 8) /* NMI */
279 #define INTR_TYPE_HARD_EXCEPTION (3 << 8) /* processor exception */
280 #define INTR_TYPE_SOFT_INTR (4 << 8) /* software interrupt */
281 #define INTR_TYPE_SOFT_EXCEPTION (6 << 8) /* software exception */
283 /* GUEST_INTERRUPTIBILITY_INFO flags. */
284 #define GUEST_INTR_STATE_STI 0x00000001
285 #define GUEST_INTR_STATE_MOV_SS 0x00000002
286 #define GUEST_INTR_STATE_SMI 0x00000004
287 #define GUEST_INTR_STATE_NMI 0x00000008
290 * Exit Qualifications for MOV for Control Register Access
292 #define CONTROL_REG_ACCESS_NUM 0x7 /* 2:0, number of control reg.*/
293 #define CONTROL_REG_ACCESS_TYPE 0x30 /* 5:4, access type */
294 #define CONTROL_REG_ACCESS_REG 0xf00 /* 10:8, general purpose reg. */
295 #define LMSW_SOURCE_DATA_SHIFT 16
296 #define LMSW_SOURCE_DATA (0xFFFF << LMSW_SOURCE_DATA_SHIFT) /* 16:31 lmsw source */
297 #define REG_EAX (0 << 8)
298 #define REG_ECX (1 << 8)
299 #define REG_EDX (2 << 8)
300 #define REG_EBX (3 << 8)
301 #define REG_ESP (4 << 8)
302 #define REG_EBP (5 << 8)
303 #define REG_ESI (6 << 8)
304 #define REG_EDI (7 << 8)
305 #define REG_R8 (8 << 8)
306 #define REG_R9 (9 << 8)
307 #define REG_R10 (10 << 8)
308 #define REG_R11 (11 << 8)
309 #define REG_R12 (12 << 8)
310 #define REG_R13 (13 << 8)
311 #define REG_R14 (14 << 8)
312 #define REG_R15 (15 << 8)
315 * Exit Qualifications for MOV for Debug Register Access
317 #define DEBUG_REG_ACCESS_NUM 0x7 /* 2:0, number of debug reg. */
318 #define DEBUG_REG_ACCESS_TYPE 0x10 /* 4, direction of access */
319 #define TYPE_MOV_TO_DR (0 << 4)
320 #define TYPE_MOV_FROM_DR (1 << 4)
321 #define DEBUG_REG_ACCESS_REG(eq) (((eq) >> 8) & 0xf) /* 11:8, general purpose reg. */
325 #define SEGMENT_AR_L_MASK (1 << 13)
327 #define AR_TYPE_ACCESSES_MASK 1
328 #define AR_TYPE_READABLE_MASK (1 << 1)
329 #define AR_TYPE_WRITEABLE_MASK (1 << 2)
330 #define AR_TYPE_CODE_MASK (1 << 3)
331 #define AR_TYPE_MASK 0x0f
332 #define AR_TYPE_BUSY_64_TSS 11
333 #define AR_TYPE_BUSY_32_TSS 11
334 #define AR_TYPE_BUSY_16_TSS 3
335 #define AR_TYPE_LDT 2
337 #define AR_UNUSABLE_MASK (1 << 16)
338 #define AR_S_MASK (1 << 4)
339 #define AR_P_MASK (1 << 7)
340 #define AR_L_MASK (1 << 13)
341 #define AR_DB_MASK (1 << 14)
342 #define AR_G_MASK (1 << 15)
343 #define AR_DPL_SHIFT 5
344 #define AR_DPL(ar) (((ar) >> AR_DPL_SHIFT) & 3)
346 #define AR_RESERVD_MASK 0xfffe0f00
348 #define TSS_PRIVATE_MEMSLOT (KVM_MEMORY_SLOTS + 0)
349 #define APIC_ACCESS_PAGE_PRIVATE_MEMSLOT (KVM_MEMORY_SLOTS + 1)
350 #define IDENTITY_PAGETABLE_PRIVATE_MEMSLOT (KVM_MEMORY_SLOTS + 2)
352 #define VMX_NR_VPIDS (1 << 16)
353 #define VMX_VPID_EXTENT_SINGLE_CONTEXT 1
354 #define VMX_VPID_EXTENT_ALL_CONTEXT 2
356 #define VMX_EPT_EXTENT_INDIVIDUAL_ADDR 0
357 #define VMX_EPT_EXTENT_CONTEXT 1
358 #define VMX_EPT_EXTENT_GLOBAL 2
360 #define VMX_EPT_EXECUTE_ONLY_BIT (1ull)
361 #define VMX_EPT_PAGE_WALK_4_BIT (1ull << 6)
362 #define VMX_EPTP_UC_BIT (1ull << 8)
363 #define VMX_EPTP_WB_BIT (1ull << 14)
364 #define VMX_EPT_2MB_PAGE_BIT (1ull << 16)
365 #define VMX_EPT_EXTENT_INDIVIDUAL_BIT (1ull << 24)
366 #define VMX_EPT_EXTENT_CONTEXT_BIT (1ull << 25)
367 #define VMX_EPT_EXTENT_GLOBAL_BIT (1ull << 26)
369 #define VMX_EPT_DEFAULT_GAW 3
370 #define VMX_EPT_MAX_GAW 0x4
371 #define VMX_EPT_MT_EPTE_SHIFT 3
372 #define VMX_EPT_GAW_EPTP_SHIFT 3
373 #define VMX_EPT_DEFAULT_MT 0x6ull
374 #define VMX_EPT_READABLE_MASK 0x1ull
375 #define VMX_EPT_WRITABLE_MASK 0x2ull
376 #define VMX_EPT_EXECUTABLE_MASK 0x4ull
377 #define VMX_EPT_IGMT_BIT (1ull << 6)
379 #define VMX_EPT_IDENTITY_PAGETABLE_ADDR 0xfffbc000ul
382 #define ASM_VMX_VMCLEAR_RAX ".byte 0x66, 0x0f, 0xc7, 0x30"
383 #define ASM_VMX_VMLAUNCH ".byte 0x0f, 0x01, 0xc2"
384 #define ASM_VMX_VMRESUME ".byte 0x0f, 0x01, 0xc3"
385 #define ASM_VMX_VMPTRLD_RAX ".byte 0x0f, 0xc7, 0x30"
386 #define ASM_VMX_VMREAD_RDX_RAX ".byte 0x0f, 0x78, 0xd0"
387 #define ASM_VMX_VMWRITE_RAX_RDX ".byte 0x0f, 0x79, 0xd0"
388 #define ASM_VMX_VMWRITE_RSP_RDX ".byte 0x0f, 0x79, 0xd4"
389 #define ASM_VMX_VMXOFF ".byte 0x0f, 0x01, 0xc4"
390 #define ASM_VMX_VMXON_RAX ".byte 0xf3, 0x0f, 0xc7, 0x30"
391 #define ASM_VMX_INVEPT ".byte 0x66, 0x0f, 0x38, 0x80, 0x08"
392 #define ASM_VMX_INVVPID ".byte 0x66, 0x0f, 0x38, 0x81, 0x08"