b40bd6f3150edb04be610768c0433b7bbc6a9b5c
[akaros.git] / kern / arch / x86 / vmm / intel / vmx.h
1 /*
2  * vmx.h: VMX Architecture related definitions
3  * Copyright (c) 2004, Intel Corporation.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms and conditions of the GNU General Public License,
7  * version 2, as published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16  * Place - Suite 330, Boston, MA 02111-1307 USA.
17  *
18  * A few random additions are:
19  * Copyright (C) 2006 Qumranet
20  *    Avi Kivity <avi@qumranet.com>
21  *    Yaniv Kamay <yaniv@qumranet.com>
22  *
23  */
24
25 #pragma once
26
27 #include <ros/arch/vmx.h>
28
29 /* Additional bits for VMMCPs, originally from the Dune version of kvm. */
30 /*
31  * vmx.h - header file for USM VMX driver.
32  */
33
34 /* This is per-guest per-core, and the implementation specific area
35  * should be assumed to have hidden fields.
36  */
37 struct vmcs {
38         uint32_t revision_id;
39         uint32_t abort_code;
40         char _impl_specific[PGSIZE - sizeof(uint32_t) * 2];
41 };
42
43 typedef uint64_t gpa_t;
44 typedef uint64_t gva_t;
45
46 struct vmx_capability {
47         uint32_t ept;
48         uint32_t vpid;
49 };
50
51 struct vmcs_config {
52         int size;
53         uint32_t revision_id;
54         uint32_t pin_based_exec_ctrl;
55         uint32_t cpu_based_exec_ctrl;
56         uint32_t cpu_based_2nd_exec_ctrl;
57         uint32_t vmexit_ctrl;
58         uint32_t vmentry_ctrl;
59 };
60
61 #define NR_AUTOLOAD_MSRS 8
62
63 /* the horror. */
64 struct desc_struct {
65         union {
66                 struct {
67                         unsigned int a;
68                         unsigned int b;
69                 };
70                 struct {
71                         uint16_t limit0;
72                         uint16_t base0;
73                         unsigned base1: 8, type: 4, s: 1, dpl: 2, p: 1;
74                         unsigned limit: 4, avl: 1, l: 1, d: 1, g: 1, base2: 8;
75                 };
76         };
77 } __attribute__((packed));
78
79 /* LDT or TSS descriptor in the GDT. 16 bytes. */
80 struct ldttss_desc64 {
81         uint16_t limit0;
82         uint16_t base0;
83         unsigned base1 : 8, type : 5, dpl : 2, p : 1;
84         unsigned limit1 : 4, zero0 : 3, g : 1, base2 : 8;
85         uint32_t base3;
86         uint32_t zero1;
87 } __attribute__((packed));
88
89 #define INTEL_MSR_WRITE_OFFSET                  2048
90
91 #define INTEL_X2APIC_MSR_START                  0x100
92 #define INTEL_X2APIC_MSR_LENGTH                 (0x40/8)
93
94 #define MSR_IA32_VMX_BASIC_MSR                  0x480
95 #define MSR_IA32_VMX_PINBASED_CTLS_MSR  0x481
96 #define MSR_IA32_VMX_PROCBASED_CTLS_MSR 0x482
97 #define MSR_IA32_VMX_EXIT_CTLS_MSR              0x483
98 #define MSR_IA32_VMX_ENTRY_CTLS_MSR             0x484
99
100 extern char * const VMX_EXIT_REASON_NAMES[];
101
102
103 int vmx_init(void);
104 void vmx_exit(void);
105 int intel_vmm_init(void);
106 int intel_vmm_pcpu_init(void);
107 int ept_fault_pages(void *dir, uint32_t start, uint32_t end);
108 int ept_check_page(void *dir, unsigned long addr);
109 int vmx_do_ept_fault(void *dir, unsigned long gpa, unsigned long gva, int fault_flags);
110
111 static inline void native_store_idt(pseudodesc_t *dtr);
112 static inline unsigned long get_desc_base(const struct desc_struct *desc);
113 static inline void native_store_gdt(pseudodesc_t *dtr);
114 static inline bool cpu_has_secondary_exec_ctrls(void);
115 static inline bool cpu_has_vmx_vpid(void);
116 static inline bool cpu_has_vmx_invpcid(void);
117 static inline bool cpu_has_vmx_invvpid_single(void);
118 static inline bool cpu_has_vmx_invvpid_global(void);
119 static inline bool cpu_has_vmx_ept(void);
120 static inline bool cpu_has_vmx_invept(void);
121 static inline bool cpu_has_vmx_invept_individual_addr(void);
122 static inline bool cpu_has_vmx_invept_context(void);
123 static inline bool cpu_has_vmx_invept_global(void);
124 static inline bool cpu_has_vmx_ept_ad_bits(void);
125 static inline bool cpu_has_vmx_ept_execute_only(void);
126 static inline bool cpu_has_vmx_eptp_uncacheable(void);
127 static inline bool cpu_has_vmx_eptp_writeback(void);
128 static inline bool cpu_has_vmx_ept_2m_page(void);
129 static inline bool cpu_has_vmx_ept_1g_page(void);
130 static inline bool cpu_has_vmx_ept_4levels(void);
131 static inline void __invept(int ext, uint64_t eptp, gpa_t gpa);
132 static inline void ept_sync_global(void);
133 static inline void ept_sync_context(uint64_t eptp);
134 static inline void ept_sync_individual_addr(uint64_t eptp, gpa_t gpa);
135 static inline void __vmxon(uint64_t addr);
136 static inline void __vmxoff(void);
137 static inline void __invvpid(int ext, uint16_t vpid, gva_t gva);
138 static inline void vpid_sync_gpc_single(uint16_t vpid);
139 static inline void vpid_sync_gpc_global(void);
140 static inline void vpid_sync_context(uint16_t vpid);
141 static inline uint64_t gpc_get_eptp(struct guest_pcore *gpc);
142
143 /* no way to get around some of this stuff. */
144 /* we will do the bare minimum required. */
145 static inline void native_store_idt(pseudodesc_t *dtr)
146 {
147         asm volatile("sidt %0":"=m" (*dtr));
148 }
149
150 static inline unsigned long get_desc_base(const struct desc_struct *desc)
151 {
152         return (unsigned)(desc->base0 | ((desc->base1) << 16) | ((desc->base2) << 24));
153 }
154
155 #define store_gdt(dtr)                          native_store_gdt(dtr)
156 static inline void native_store_gdt(pseudodesc_t *dtr)
157 {
158         asm volatile("sgdt %0":"=m" (*dtr));
159 }
160
161 /* TODO: somewhat nasty - two structs, only used by the helpers.  Maybe use cpu
162  * features. */
163 extern struct vmcs_config vmcs_config;
164 extern struct vmx_capability vmx_capability;
165
166 static inline bool cpu_has_secondary_exec_ctrls(void)
167 {
168         return vmcs_config.cpu_based_exec_ctrl &
169                 CPU_BASED_ACTIVATE_SECONDARY_CONTROLS;
170 }
171
172 static inline bool cpu_has_vmx_vpid(void)
173 {
174         return vmcs_config.cpu_based_2nd_exec_ctrl &
175                 SECONDARY_EXEC_ENABLE_VPID;
176 }
177
178 static inline bool cpu_has_vmx_invpcid(void)
179 {
180         return vmcs_config.cpu_based_2nd_exec_ctrl &
181                 SECONDARY_EXEC_ENABLE_INVPCID;
182 }
183
184 static inline bool cpu_has_vmx_invvpid_single(void)
185 {
186         return vmx_capability.vpid & VMX_VPID_EXTENT_SINGLE_CONTEXT_BIT;
187 }
188
189 static inline bool cpu_has_vmx_invvpid_global(void)
190 {
191         return vmx_capability.vpid & VMX_VPID_EXTENT_GLOBAL_CONTEXT_BIT;
192 }
193
194 static inline bool cpu_has_vmx_ept(void)
195 {
196         return vmcs_config.cpu_based_2nd_exec_ctrl &
197                 SECONDARY_EXEC_ENABLE_EPT;
198 }
199
200 static inline bool cpu_has_vmx_invept(void)
201 {
202         return vmx_capability.ept & VMX_EPT_INVEPT_BIT;
203 }
204
205 /* the SDM (2015-01) doesn't mention this ability (still?) */
206 static inline bool cpu_has_vmx_invept_individual_addr(void)
207 {
208         return vmx_capability.ept & VMX_EPT_EXTENT_INDIVIDUAL_BIT;
209 }
210
211 static inline bool cpu_has_vmx_invept_context(void)
212 {
213         return vmx_capability.ept & VMX_EPT_EXTENT_CONTEXT_BIT;
214 }
215
216 static inline bool cpu_has_vmx_invept_global(void)
217 {
218         return vmx_capability.ept & VMX_EPT_EXTENT_GLOBAL_BIT;
219 }
220
221 static inline bool cpu_has_vmx_ept_ad_bits(void)
222 {
223         return vmx_capability.ept & VMX_EPT_AD_BIT;
224 }
225
226 static inline bool cpu_has_vmx_ept_execute_only(void)
227 {
228         return vmx_capability.ept & VMX_EPT_EXECUTE_ONLY_BIT;
229 }
230
231 static inline bool cpu_has_vmx_eptp_uncacheable(void)
232 {
233         return vmx_capability.ept & VMX_EPTP_UC_BIT;
234 }
235
236 static inline bool cpu_has_vmx_eptp_writeback(void)
237 {
238         return vmx_capability.ept & VMX_EPTP_WB_BIT;
239 }
240
241 static inline bool cpu_has_vmx_ept_2m_page(void)
242 {
243         return vmx_capability.ept & VMX_EPT_2MB_PAGE_BIT;
244 }
245
246 static inline bool cpu_has_vmx_ept_1g_page(void)
247 {
248         return vmx_capability.ept & VMX_EPT_1GB_PAGE_BIT;
249 }
250
251 static inline bool cpu_has_vmx_ept_4levels(void)
252 {
253         return vmx_capability.ept & VMX_EPT_PAGE_WALK_4_BIT;
254 }
255
256 static inline void __invept(int ext, uint64_t eptp, gpa_t gpa)
257 {
258         struct {
259                 uint64_t eptp, gpa;
260         } operand = {eptp, gpa};
261
262         asm volatile (ASM_VMX_INVEPT
263                         /* CF==1 or ZF==1 --> rc = -1 */
264                         "; ja 1f ; ud2 ; 1:\n"
265                         : : "a" (&operand), "c" (ext) : "cc", "memory");
266 }
267
268 /* We assert support for the global flush during ept_init() */
269 static inline void ept_sync_global(void)
270 {
271         __invept(VMX_EPT_EXTENT_GLOBAL, 0, 0);
272 }
273
274 static inline void ept_sync_context(uint64_t eptp)
275 {
276         if (cpu_has_vmx_invept_context())
277                 __invept(VMX_EPT_EXTENT_CONTEXT, eptp, 0);
278         else
279                 ept_sync_global();
280 }
281
282 static inline void ept_sync_individual_addr(uint64_t eptp, gpa_t gpa)
283 {
284         if (cpu_has_vmx_invept_individual_addr())
285                 __invept(VMX_EPT_EXTENT_INDIVIDUAL_ADDR,
286                                 eptp, gpa);
287         else
288                 ept_sync_context(eptp);
289 }
290
291 static inline void __vmxon(uint64_t addr)
292 {
293         asm volatile (ASM_VMX_VMXON_RAX
294                         : : "a"(&addr), "m"(addr)
295                         : "memory", "cc");
296 }
297
298 static inline void __vmxoff(void)
299 {
300         asm volatile (ASM_VMX_VMXOFF : : : "cc");
301 }
302
303 static inline void __invvpid(int ext, uint16_t vpid, gva_t gva)
304 {
305     struct {
306         uint64_t vpid : 16;
307         uint64_t rsvd : 48;
308         uint64_t gva;
309     } operand = { vpid, 0, gva };
310
311     asm volatile (ASM_VMX_INVVPID
312                   /* CF==1 or ZF==1 --> rc = -1 */
313                   "; ja 1f ; ud2 ; 1:"
314                   : : "a"(&operand), "c"(ext) : "cc", "memory");
315 }
316
317 static inline void vpid_sync_gpc_single(uint16_t vpid)
318 {
319         if (vpid == 0) {
320                 return;
321         }
322
323         if (cpu_has_vmx_invvpid_single())
324                 __invvpid(VMX_VPID_EXTENT_SINGLE_CONTEXT, vpid, 0);
325 }
326
327 static inline void vpid_sync_gpc_global(void)
328 {
329         if (cpu_has_vmx_invvpid_global())
330                 __invvpid(VMX_VPID_EXTENT_ALL_CONTEXT, 0, 0);
331 }
332
333 static inline void vpid_sync_context(uint16_t vpid)
334 {
335         if (cpu_has_vmx_invvpid_single())
336                 vpid_sync_gpc_single(vpid);
337         else
338                 vpid_sync_gpc_global();
339 }
340
341 static inline uint64_t gpc_get_eptp(struct guest_pcore *gpc)
342 {
343         return gpc->proc->env_pgdir.eptp;
344 }
345
346 static inline unsigned long vmcs_read(unsigned long field)
347 {
348         unsigned long value;
349
350         asm volatile (ASM_VMX_VMREAD_RDX_RAX : "=a"(value) : "d"(field) : "cc");
351         return value;
352 }
353
354 /* Returns true if the op succeeded.  It can fail if the field is unsupported */
355 static inline bool vmcs_write(unsigned long field, unsigned long value)
356 {
357         uint8_t error;
358
359         asm volatile (ASM_VMX_VMWRITE_RAX_RDX "; setna %0"
360                       : "=q"(error) : "a"(value), "d"(field) : "cc");
361         return error ? FALSE : TRUE;
362 }
363
364 /*
365  * VMX Execution Controls (vmxec)
366  * Some bits can be set, others can not (i.e. they are reserved).
367  *
368  * o all bits listed in here must set or clear all the bits in a word
369  *   that are not reserved (coverage).
370  * o no bits listed in one of these elements is listed in
371  *   another element (conflict)
372  * o you are allowed to specify a bit that matches a reserved value
373  *   (because it might be settable at some future time).
374  * o do your best to find symbolic names for the set_to_1 and set_to_0 values.
375  *   In the one case we could not find a name, it turned out to be an
376  *   error in kvm constants that went back to the earliest days.
377  * We're hoping you almost never have to change this. It's painful.
378  * The assumption going in is that the 5 MSRs that define the vmxec
379  * values are relatively static. This has been the case for a while.
380  */
381 struct vmxec {
382         char *name;
383         uint32_t msr;
384         uint32_t truemsr;
385         uint32_t must_be_1;
386         uint32_t must_be_0;
387         uint32_t try_set_1;
388         uint32_t try_set_0;
389 };
390
391 void vmx_load_guest_pcore(struct guest_pcore *gpc);
392 void vmx_unload_guest_pcore(struct guest_pcore *gpc);
393 void vmx_clear_vmcs(void);