vmm: Allow vmm.h to include vmx.h
[akaros.git] / kern / arch / x86 / vmm / intel / vmx.c
1 //#define DEBUG
2 /**
3  *  vmx.c - The Intel VT-x driver for Dune
4  *
5  * This file is derived from Linux KVM VT-x support.
6  * Copyright (C) 2006 Qumranet, Inc.
7  * Copyright 2010 Red Hat, Inc. and/or its affiliates.
8  *
9  * Original Authors:
10  *   Avi Kivity   <avi@qumranet.com>
11  *   Yaniv Kamay  <yaniv@qumranet.com>
12  *
13  * This modified version is simpler because it avoids the following
14  * features that are not requirements for Dune:
15  *  * Real-mode emulation
16  *  * Nested VT-x support
17  *  * I/O hardware emulation
18  *  * Any of the more esoteric X86 features and registers
19  *  * KVM-specific functionality
20  *
21  * In essence we provide only the minimum functionality needed to run
22  * a process in vmx non-root mode rather than the full hardware emulation
23  * needed to support an entire OS.
24  *
25  * This driver is a research prototype and as such has the following
26  * limitations:
27  *
28  * FIXME: Backward compatibility is currently a non-goal, and only recent
29  * full-featured (EPT, PCID, VPID, etc.) Intel hardware is supported by this
30  * driver.
31  *
32  * FIXME: Eventually we should handle concurrent user's of VT-x more
33  * gracefully instead of requiring exclusive access. This would allow
34  * Dune to interoperate with KVM and other HV solutions.
35  *
36  * FIXME: We need to support hotplugged physical CPUs.
37  *
38  * Authors:
39  *   Adam Belay   <abelay@stanford.edu>
40  */
41
42 /* Basic flow.
43  * Yep, it's confusing. This is in part because the vmcs is used twice, for two different things.
44  * You're left with the feeling that they got part way through and realized they had to have one for
45  *
46  * 1) your CPU is going to be capable of running VMs, and you need state for that.
47  *
48  * 2) you're about to start a guest, and you need state for that.
49  *
50  * So there is get cpu set up to be able to run VMs stuff, and now
51  * let's start a guest stuff.  In Akaros, CPUs will always be set up
52  * to run a VM if that is possible. Processes can flip themselves into
53  * a VM and that will require another VMCS.
54  *
55  * So: at kernel startup time, the SMP boot stuff calls
56  * k/a/x86/vmm/vmm.c:vmm_init, which calls arch-dependent bits, which
57  * in the case of this file is intel_vmm_init. That does some code
58  * that sets up stuff for ALL sockets, based on the capabilities of
59  * the socket it runs on. If any cpu supports vmx, it assumes they all
60  * do. That's a realistic assumption. So the call_function_all is kind
61  * of stupid, really; it could just see what's on the current cpu and
62  * assume it's on all. HOWEVER: there are systems in the wild that
63  * can run VMs on some but not all CPUs, due to BIOS mistakes, so we
64  * might as well allow for the chance that we'll only all VMMCPs on a
65  * subset (not implemented yet however).  So: probe all CPUs, get a
66  * count of how many support VMX and, for now, assume they all do
67  * anyway.
68  *
69  * Next, call setup_vmcs_config to configure the GLOBAL vmcs_config struct,
70  * which contains all the naughty bits settings for all the cpus that can run a VM.
71  * Realistically, all VMX-capable cpus in a system will have identical configurations.
72  * So: 0 or more cpus can run VMX; all cpus which can run VMX will have the same configuration.
73  *
74  * configure the msr_bitmap. This is the bitmap of MSRs which the
75  * guest can manipulate.  Currently, we only allow GS and FS base.
76  *
77  * Reserve bit 0 in the vpid bitmap as guests can not use that
78  *
79  * Set up the what we call the vmxarea. The vmxarea is per-cpu, not
80  * per-guest. Once set up, it is left alone.  The ONLY think we set in
81  * there is the revision area. The VMX is page-sized per cpu and
82  * page-aligned. Note that it can be smaller, but why bother? We know
83  * the max size and alignment, and it's convenient.
84  *
85  * Now that it is set up, enable vmx on all cpus. This involves
86  * testing VMXE in cr4, to see if we've been here before (TODO: delete
87  * this test), then testing MSR_IA32_FEATURE_CONTROL to see if we can
88  * do a VM, the setting the VMXE in cr4, calling vmxon (does a vmxon
89  * instruction), and syncing vpid's and ept's.  Now the CPU is ready
90  * to host guests.
91  *
92  * Setting up a guest.
93  * We divide this into two things: vmm_proc_init and vm_run.
94  * Currently, on Intel, vmm_proc_init does nothing.
95  *
96  * vm_run is really complicated. It is called with a coreid, and
97  * vmctl struct. On intel, it calls vmx_launch. vmx_launch is set
98  * up for a few test cases. If rip is 1, it sets the guest rip to
99  * a function which will deref 0 and should exit with failure 2. If rip is 0,
100  * it calls an infinite loop in the guest.
101  *
102  * The sequence of operations:
103  * create a vcpu
104  * while (1) {
105  * get a vcpu
106  * disable irqs (required or you can't enter the VM)
107  * vmx_run_vcpu()
108  * enable irqs
109  * manage the vm exit
110  * }
111  *
112  * get a vcpu
113  * See if the current cpu has a vcpu. If so, and is the same as the vcpu we want,
114  * vmcs_load(vcpu->vmcs) -- i.e. issue a VMPTRLD.
115  *
116  * If it's not the same, see if the vcpu thinks it is on the core. If it is not, call
117  * __vmx_get_cpu_helper on the other cpu, to free it up. Else vmcs_clear the one
118  * attached to this cpu. Then vmcs_load the vmcs for vcpu on this this cpu,
119  * call __vmx_setup_cpu, mark this vcpu as being attached to this cpu, done.
120  *
121  * vmx_run_vcpu this one gets messy, mainly because it's a giant wad
122  * of inline assembly with embedded CPP crap. I suspect we'll want to
123  * un-inline it someday, but maybe not.  It's called with a vcpu
124  * struct from which it loads guest state, and to which it stores
125  * non-virtualized host state. It issues a vmlaunch or vmresume
126  * instruction depending, and on return, it evaluates if things the
127  * launch/resume had an error in that operation. Note this is NOT the
128  * same as an error while in the virtual machine; this is an error in
129  * startup due to misconfiguration. Depending on what is returned it's
130  * either a failed vm startup or an exit for lots of many reasons.
131  *
132  */
133
134 /* basically: only rename those globals that might conflict
135  * with existing names. Leave all else the same.
136  * this code is more modern than the other code, yet still
137  * well encapsulated, it seems.
138  */
139 #include <kmalloc.h>
140 #include <string.h>
141 #include <stdio.h>
142 #include <assert.h>
143 #include <error.h>
144 #include <pmap.h>
145 #include <sys/queue.h>
146 #include <smp.h>
147 #include <kref.h>
148 #include <atomic.h>
149 #include <alarm.h>
150 #include <event.h>
151 #include <umem.h>
152 #include <bitops.h>
153 #include <arch/types.h>
154 #include <syscall.h>
155 #include <arch/io.h>
156 #include <percpu.h>
157
158 #include <ros/vmm.h>
159 #include "vmx.h"
160 #include "../vmm.h"
161
162 #include "cpufeature.h"
163
164 #include <trap.h>
165
166 #include <smp.h>
167 #include <ros/procinfo.h>
168
169 #define currentcpu (&per_cpu_info[core_id()])
170
171 static unsigned long *msr_bitmap;
172 #define VMX_IO_BITMAP_SZ                (1 << 16) /* 64 KB */
173 static unsigned long *io_bitmap;
174
175 int x86_ept_pte_fix_ups = 0;
176
177 struct vmx_capability vmx_capability;
178 struct vmcs_config vmcs_config;
179
180 char * const VMX_EXIT_REASON_NAMES[] = {
181         VMX_EXIT_REASONS
182 };
183
184 static char *cr_access_type[] = {
185         "move to cr",
186         "move from cr",
187         "clts",
188         "lmsw"
189 };
190
191 static char *cr_gpr[] = {
192         "rax", "rcx", "rdx", "rbx", "rsp", "rbp", "rsi", "rdi",
193         "r8", "r9", "r10", "r11", "r12", "r13", "r14", "r15"
194 };
195
196 static int guest_cr_num[16] = {
197         GUEST_CR0,
198         -1,
199         -1,
200         GUEST_CR3,
201         GUEST_CR4,
202         -1,
203         -1,
204         -1,
205         -1,     /* 8? */
206         -1, -1, -1, -1, -1, -1, -1
207 };
208
209 __always_inline unsigned long vmcs_readl(unsigned long field);
210 /* See section 24-3 of The Good Book */
211 void
212 show_cr_access(uint64_t val)
213 {
214         int crnr = val & 0xf;
215         int type = (val >> 4) & 3;
216         int reg = (val >> 11) & 0xf;
217         printk("%s: %d: ", cr_access_type[type], crnr);
218         if (type < 2) {
219                 printk("%s", cr_gpr[reg]);
220                 if (guest_cr_num[crnr] > -1) {
221                         printk(": 0x%x", vmcs_readl(guest_cr_num[crnr]));
222                 }
223         }
224         printk("\n");
225 }
226
227 void
228 ept_flush(uint64_t eptp)
229 {
230         ept_sync_context(eptp);
231 }
232
233 static void
234 vmcs_clear(struct vmcs *vmcs)
235 {
236         uint64_t phys_addr = PADDR(vmcs);
237         uint8_t error;
238
239         asm volatile (ASM_VMX_VMCLEAR_RAX "; setna %0":"=qm"(error):"a"(&phys_addr),
240                                   "m"(phys_addr)
241                                   :"cc", "memory");
242         if (error)
243                 printk("vmclear fail: %p/%llx\n", vmcs, phys_addr);
244 }
245
246 static void
247 vmcs_load(struct vmcs *vmcs)
248 {
249         uint64_t phys_addr = PADDR(vmcs);
250         uint8_t error;
251
252         asm volatile (ASM_VMX_VMPTRLD_RAX "; setna %0":"=qm"(error):"a"(&phys_addr),
253                                   "m"(phys_addr)
254                                   :"cc", "memory");
255         if (error)
256                 printk("vmptrld %p/%llx failed\n", vmcs, phys_addr);
257 }
258
259 /* Returns the paddr pointer of the current CPU's VMCS region, or -1 if none. */
260 static physaddr_t
261 vmcs_get_current(void)
262 {
263         physaddr_t vmcs_paddr;
264         /* RAX contains the addr of the location to store the VMCS pointer.  The
265          * compiler doesn't know the ASM will deref that pointer, hence the =m */
266         asm volatile (ASM_VMX_VMPTRST_RAX:"=m"(vmcs_paddr):"a"(&vmcs_paddr));
267         return vmcs_paddr;
268 }
269
270 __always_inline unsigned long
271 vmcs_readl(unsigned long field)
272 {
273         return vmcs_read(field);
274 }
275
276 __always_inline uint16_t
277 vmcs_read16(unsigned long field)
278 {
279         return vmcs_readl(field);
280 }
281
282 static __always_inline uint32_t
283 vmcs_read32(unsigned long field)
284 {
285         return vmcs_readl(field);
286 }
287
288 static __always_inline uint64_t
289 vmcs_read64(unsigned long field)
290 {
291         return vmcs_readl(field);
292 }
293
294 void
295 vmwrite_error(unsigned long field, unsigned long value)
296 {
297         printk("vmwrite error: reg %lx value %lx (err %d)\n",
298                    field, value, vmcs_read32(VM_INSTRUCTION_ERROR));
299 }
300
301 void
302 vmcs_writel(unsigned long field, unsigned long value)
303 {
304         if (!vmcs_write(field, value))
305                 vmwrite_error(field, value);
306 }
307
308 static void
309 vmcs_write16(unsigned long field, uint16_t value)
310 {
311         vmcs_writel(field, value);
312 }
313
314 static void
315 vmcs_write32(unsigned long field, uint32_t value)
316 {
317         vmcs_writel(field, value);
318 }
319
320 static void
321 vmcs_write64(unsigned long field, uint64_t value)
322 {
323         vmcs_writel(field, value);
324 }
325
326 void vapic_status_dump_kernel(void *vapic);
327
328 /*
329  * A note on Things You Can't Make Up.
330  * or
331  * "George, you can type this shit, but you can't say it" -- Harrison Ford
332  *
333  * There are 5 VMCS 32-bit words that control guest permissions. If
334  * you set these correctly, you've got a guest that will behave. If
335  * you get even one bit wrong, you've got a guest that will chew your
336  * leg off. Some bits must be 1, some must be 0, and some can be set
337  * either way. To add to the fun, the docs are sort of a docudrama or,
338  * as the quote goes, "interesting if true."
339  *
340  * To determine what bit can be set in what VMCS 32-bit control word,
341  * there are 5 corresponding 64-bit MSRs.  And, to make it even more
342  * fun, the standard set of MSRs have errors in them, i.e. report
343  * incorrect values, for legacy reasons, and so you are supposed to
344  * "look around" to another set, which have correct bits in
345  * them. There are four such 'correct' registers, and they have _TRUE_
346  * in the names as you can see below. We test for the value of VMCS
347  * control bits in the _TRUE_ registers if possible. The fifth
348  * register, CPU Secondary Exec Controls, which came later, needs no
349  * _TRUE_ variant.
350  *
351  * For each MSR, the high 32 bits tell you what bits can be "1" by a
352  * "1" in that position; the low 32 bits tell you what bit can be "0"
353  * by a "0" in that position. So, for each of 32 bits in a given VMCS
354  * control word, there is a pair of bits in an MSR that tells you what
355  * values it can take. The two bits, of which there are *four*
356  * combinations, describe the *three* possible operations on a
357  * bit. The two bits, taken together, form an untruth table: There are
358  * three possibilities: The VMCS bit can be set to 0 or 1, or it can
359  * only be 0, or only 1. The fourth combination is not supposed to
360  * happen.
361  *
362  * So: there is the 1 bit from the upper 32 bits of the msr.
363  * If this bit is set, then the bit can be 1. If clear, it can not be 1.
364  *
365  * Then there is the 0 bit, from low 32 bits. If clear, the VMCS bit
366  * can be 0. If 1, the VMCS bit can not be 0.
367  *
368  * SO, let's call the 1 bit R1, and the 0 bit R0, we have:
369  *  R1 R0
370  *  0 0 -> must be 0
371  *  1 0 -> can be 1, can be 0
372  *  0 1 -> can not be 1, can not be 0. --> JACKPOT! Not seen yet.
373  *  1 1 -> must be one.
374  *
375  * It's also pretty hard to know what you can and can't set, and
376  * that's led to inadvertent opening of permissions at times.  Because
377  * of this complexity we've decided on the following: the driver must
378  * define EVERY bit, UNIQUELY, for each of the 5 registers, that it wants
379  * set. Further, for any bit that's settable, the driver must specify
380  * a setting; for any bit that's reserved, the driver settings must
381  * match that bit. If there are reserved bits we don't specify, that's
382  * ok; we'll take them as is.
383  *
384  * We use a set-means-set, and set-means-clear model, i.e. we use a
385  * 32-bit word to contain the bits we want to be 1, indicated by one;
386  * and another 32-bit word in which a bit we want to be 0 is indicated
387  * by a 1. This allows us to easily create masks of all bits we're
388  * going to set, for example.
389  *
390  * We have two 32-bit numbers for each 32-bit VMCS field: bits we want
391  * set and bits we want clear.  If you read the MSR for that field,
392  * compute the reserved 0 and 1 settings, and | them together, they
393  * need to result in 0xffffffff. You can see that we can create other
394  * tests for conflicts (i.e. overlap).
395  *
396  * At this point, I've tested check_vmx_controls in every way
397  * possible, because I kept screwing the bitfields up. You'll get a nice
398  * error it won't work at all, which is what we want: a
399  * failure-prone setup, where even errors that might result in correct
400  * values are caught -- "right answer, wrong method, zero credit." If there's
401  * weirdness in the bits, we don't want to run.
402  * The try_set stuff adds particular ugliness but we have to have it.
403  */
404
405 static bool
406 check_vmxec_controls(struct vmxec const *v, bool have_true_msr,
407                                          uint32_t * result)
408 {
409         bool err = false;
410         uint32_t vmx_msr_low, vmx_msr_high;
411         uint64_t msr_val;
412         uint32_t reserved_0, reserved_1, changeable_bits, try0, try1;
413
414         if (have_true_msr)
415                 msr_val = read_msr(v->truemsr);
416         else
417                 msr_val = read_msr(v->msr);
418         vmx_msr_high = high32(msr_val);
419         vmx_msr_low = low32(msr_val);
420
421         if (vmx_msr_low & ~vmx_msr_high)
422                 warn("JACKPOT: Conflicting VMX ec ctls for %s, high 0x%08x low 0x%08x",
423                          v->name, vmx_msr_high, vmx_msr_low);
424
425         reserved_0 = (~vmx_msr_low) & (~vmx_msr_high);
426         reserved_1 = vmx_msr_low & vmx_msr_high;
427         changeable_bits = ~(reserved_0 | reserved_1);
428
429         /*
430          * this is very much as follows:
431          * accept the things I cannot change,
432          * change the things I can,
433          * know the difference.
434          */
435
436         /* Conflict. Don't try to both set and reset bits. */
437         if ((v->must_be_1 & (v->must_be_0 | v->try_set_1 | v->try_set_0)) ||
438             (v->must_be_0 & (v->try_set_1 | v->try_set_0)) ||
439             (v->try_set_1 & v->try_set_0)) {
440                 printk("%s: must 0 (0x%x) and must be 1 (0x%x) and try_set_0 (0x%x) and try_set_1 (0x%x) overlap\n",
441                        v->name, v->must_be_0, v->must_be_1, v->try_set_0, v->try_set_1);
442                 err = true;
443         }
444
445         /* coverage */
446         if (((v->must_be_0 | v->must_be_1 | v->try_set_0 | v->try_set_1) & changeable_bits) != changeable_bits) {
447                 printk("%s: Need to cover 0x%x and have 0x%x,0x%x\n",
448                        v->name, changeable_bits, v->must_be_0, v->must_be_1, v->try_set_0, v->try_set_1);
449                 err = true;
450         }
451
452         if ((v->must_be_0 | v->must_be_1 | v->try_set_0 | v->try_set_1 | reserved_0 | reserved_1) != 0xffffffff) {
453                 printk("%s: incomplete coverage: have 0x%x, want 0x%x\n",
454                        v->name, v->must_be_0 | v->must_be_1 | v->try_set_0 | v->try_set_1 |
455                        reserved_0 | reserved_1, 0xffffffff);
456                 err = true;
457         }
458
459         /* Don't try to change bits that can't be changed. */
460         if ((v->must_be_0 & (reserved_0 | changeable_bits)) != v->must_be_0) {
461                 printk("%s: set to 0 (0x%x) can't be done\n", v->name, v->must_be_0);
462                 err = true;
463         }
464
465         if ((v->must_be_1 & (reserved_1 | changeable_bits)) != v->must_be_1) {
466                 printk("%s: set to 1 (0x%x) can't be done\n", v->name, v->must_be_1);
467                 err = true;
468         }
469         // Note we don't REQUIRE that try_set_0 or try_set_0 be possible. We just want to try it.
470
471         // Clear bits in try_set that can't be set.
472         try1 = v->try_set_1 & (reserved_1 | changeable_bits);
473
474         /* If there's been any error at all, spill our guts and return. */
475         if (err) {
476                 printk("%s: vmx_msr_high 0x%x, vmx_msr_low 0x%x, ",
477                            v->name, vmx_msr_high, vmx_msr_low);
478                 printk("must_be_0 0x%x, try_set_0 0x%x,reserved_0 0x%x",
479                            v->must_be_0, v->try_set_0, reserved_0);
480                 printk("must_be_1 0x%x, try_set_1 0x%x,reserved_1 0x%x",
481                            v->must_be_1, v->try_set_1, reserved_1);
482                 printk(" reserved_0 0x%x", reserved_0);
483                 printk(" changeable_bits 0x%x\n", changeable_bits);
484                 return false;
485         }
486
487         *result = v->must_be_1 | try1 | reserved_1;
488
489         printk("%s: check_vmxec_controls succeeds with result 0x%x\n",
490                    v->name, *result);
491         return true;
492 }
493
494 /*
495  * We're trying to make this as readable as possible. Realistically, it will
496  * rarely if ever change, if the past is any guide.
497  */
498 static const struct vmxec pbec = {
499         .name = "Pin Based Execution Controls",
500         .msr = MSR_IA32_VMX_PINBASED_CTLS,
501         .truemsr = MSR_IA32_VMX_TRUE_PINBASED_CTLS,
502
503         .must_be_1 = (PIN_BASED_EXT_INTR_MASK |
504                      PIN_BASED_NMI_EXITING |
505                      PIN_BASED_VIRTUAL_NMIS |
506                      PIN_BASED_POSTED_INTR),
507
508         .must_be_0 = (PIN_BASED_VMX_PREEMPTION_TIMER),
509 };
510
511 static const struct vmxec cbec = {
512         .name = "CPU Based Execution Controls",
513         .msr = MSR_IA32_VMX_PROCBASED_CTLS,
514         .truemsr = MSR_IA32_VMX_TRUE_PROCBASED_CTLS,
515
516         .must_be_1 = (
517                  CPU_BASED_MWAIT_EXITING |
518                  CPU_BASED_HLT_EXITING |
519                      CPU_BASED_TPR_SHADOW |
520                      CPU_BASED_RDPMC_EXITING |
521                      CPU_BASED_CR8_LOAD_EXITING |
522                      CPU_BASED_CR8_STORE_EXITING |
523                      CPU_BASED_USE_MSR_BITMAPS |
524                      CPU_BASED_USE_IO_BITMAPS |
525                      CPU_BASED_ACTIVATE_SECONDARY_CONTROLS),
526
527         .must_be_0 = (
528                  CPU_BASED_VIRTUAL_INTR_PENDING |
529                      CPU_BASED_INVLPG_EXITING |
530                      CPU_BASED_USE_TSC_OFFSETING |
531                      CPU_BASED_RDTSC_EXITING |
532                      CPU_BASED_CR3_LOAD_EXITING |
533                      CPU_BASED_CR3_STORE_EXITING |
534                      CPU_BASED_MOV_DR_EXITING |
535                      CPU_BASED_VIRTUAL_NMI_PENDING |
536                      CPU_BASED_MONITOR_TRAP |
537                      CPU_BASED_PAUSE_EXITING |
538                      CPU_BASED_UNCOND_IO_EXITING),
539
540         .try_set_0 = (CPU_BASED_MONITOR_EXITING)
541 };
542
543 static const struct vmxec cb2ec = {
544         .name = "CPU Based 2nd Execution Controls",
545         .msr = MSR_IA32_VMX_PROCBASED_CTLS2,
546         .truemsr = MSR_IA32_VMX_PROCBASED_CTLS2,
547
548         .must_be_1 = (SECONDARY_EXEC_ENABLE_EPT |
549                      SECONDARY_EXEC_APIC_REGISTER_VIRT |
550                      SECONDARY_EXEC_VIRTUAL_INTR_DELIVERY |
551                      SECONDARY_EXEC_VIRTUALIZE_X2APIC_MODE |
552                      SECONDARY_EXEC_WBINVD_EXITING),
553
554         .must_be_0 = (
555                      //SECONDARY_EXEC_APIC_REGISTER_VIRT |
556                      //SECONDARY_EXEC_VIRTUAL_INTR_DELIVERY |
557                      SECONDARY_EXEC_DESCRIPTOR_EXITING |
558                      SECONDARY_EXEC_VIRTUALIZE_APIC_ACCESSES |
559                      SECONDARY_EXEC_ENABLE_VPID |
560                      SECONDARY_EXEC_UNRESTRICTED_GUEST |
561                      SECONDARY_EXEC_PAUSE_LOOP_EXITING |
562                      SECONDARY_EXEC_RDRAND_EXITING |
563                      SECONDARY_EXEC_ENABLE_INVPCID |
564                      SECONDARY_EXEC_ENABLE_VMFUNC |
565                      SECONDARY_EXEC_SHADOW_VMCS |
566                      SECONDARY_EXEC_RDSEED_EXITING |
567                      SECONDARY_EPT_VE |
568                      SECONDARY_ENABLE_XSAV_RESTORE),
569
570         .try_set_1 = SECONDARY_EXEC_RDTSCP,
571
572         .try_set_0 = SECONDARY_EXEC_TSC_SCALING | SECONDARY_EXEC_ENABLE_PML
573
574 };
575
576 static const struct vmxec vmentry = {
577         .name = "VMENTRY controls",
578         .msr = MSR_IA32_VMX_ENTRY_CTLS,
579         .truemsr = MSR_IA32_VMX_TRUE_ENTRY_CTLS,
580         /* exact order from vmx.h; only the first two are enabled. */
581
582         .must_be_1 =  (VM_ENTRY_LOAD_DEBUG_CONTROLS | /* can't set to 0 */
583                       VM_ENTRY_LOAD_IA32_EFER |
584                       VM_ENTRY_IA32E_MODE),
585
586         .must_be_0 = (VM_ENTRY_SMM |
587                      VM_ENTRY_DEACT_DUAL_MONITOR |
588                      VM_ENTRY_LOAD_IA32_PERF_GLOBAL_CTRL |
589                      VM_ENTRY_LOAD_IA32_PAT),
590 };
591
592 static const struct vmxec vmexit = {
593         .name = "VMEXIT controls",
594         .msr = MSR_IA32_VMX_EXIT_CTLS,
595         .truemsr = MSR_IA32_VMX_TRUE_EXIT_CTLS,
596
597         .must_be_1 = (VM_EXIT_SAVE_DEBUG_CONTROLS |     /* can't set to 0 */
598                                  VM_EXIT_ACK_INTR_ON_EXIT |
599                                  VM_EXIT_SAVE_IA32_EFER |
600                                 VM_EXIT_LOAD_IA32_EFER |
601                                 VM_EXIT_HOST_ADDR_SPACE_SIZE),  /* 64 bit */
602
603         .must_be_0 = (VM_EXIT_LOAD_IA32_PERF_GLOBAL_CTRL |
604                                 // VM_EXIT_ACK_INTR_ON_EXIT |
605                                  VM_EXIT_SAVE_IA32_PAT |
606                                  VM_EXIT_LOAD_IA32_PAT |
607                                 VM_EXIT_SAVE_VMX_PREEMPTION_TIMER),
608 };
609
610 static void
611 setup_vmcs_config(void *p)
612 {
613         int *ret = p;
614         struct vmcs_config *vmcs_conf = &vmcs_config;
615         uint32_t vmx_msr_high;
616         uint64_t vmx_msr;
617         bool have_true_msrs = false;
618         bool ok;
619
620         *ret = -EIO;
621
622         vmx_msr = read_msr(MSR_IA32_VMX_BASIC);
623         vmx_msr_high = vmx_msr >> 32;
624
625         /*
626          * If bit 55 (VMX_BASIC_HAVE_TRUE_MSRS) is set, then we
627          * can go for the true MSRs.  Else, we ask you to get a better CPU.
628          */
629         if (vmx_msr & VMX_BASIC_TRUE_CTLS) {
630                 have_true_msrs = true;
631                 printd("Running with TRUE MSRs\n");
632         } else {
633                 printk("Running with non-TRUE MSRs, this is old hardware\n");
634         }
635
636         /*
637          * Don't worry that one or more of these might fail and leave
638          * the VMCS in some kind of incomplete state. If one of these
639          * fails, the caller is going to discard the VMCS.
640          * It is written this way to ensure we get results of all tests and avoid
641          * BMAFR behavior.
642          */
643         ok = check_vmxec_controls(&pbec, have_true_msrs,
644                                   &vmcs_conf->pin_based_exec_ctrl);
645         ok = check_vmxec_controls(&cbec, have_true_msrs,
646                                   &vmcs_conf->cpu_based_exec_ctrl) && ok;
647         /* Only check cb2ec if we're still ok, o/w we may GPF */
648         ok = ok && check_vmxec_controls(&cb2ec, have_true_msrs,
649                                         &vmcs_conf->cpu_based_2nd_exec_ctrl);
650         ok = check_vmxec_controls(&vmentry, have_true_msrs,
651                                   &vmcs_conf->vmentry_ctrl) && ok;
652         ok = check_vmxec_controls(&vmexit, have_true_msrs,
653                                   &vmcs_conf->vmexit_ctrl) && ok;
654         if (! ok) {
655                 printk("vmxexec controls is no good.\n");
656                 return;
657         }
658
659         /* IA-32 SDM Vol 3B: VMCS size is never greater than 4kB. */
660         if ((vmx_msr_high & 0x1fff) > PGSIZE) {
661                 printk("vmx_msr_high & 0x1fff) is 0x%x, > PAGE_SIZE 0x%x\n",
662                            vmx_msr_high & 0x1fff, PGSIZE);
663                 return;
664         }
665
666         /* IA-32 SDM Vol 3B: 64-bit CPUs always have VMX_BASIC_MSR[48]==0. */
667         if (vmx_msr & VMX_BASIC_64) {
668                 printk("VMX doesn't support 64 bit width!\n");
669                 return;
670         }
671
672         if (((vmx_msr & VMX_BASIC_MEM_TYPE_MASK) >> VMX_BASIC_MEM_TYPE_SHIFT)
673                 != VMX_BASIC_MEM_TYPE_WB) {
674                 printk("VMX doesn't support WB memory for VMCS accesses!\n");
675                 return;
676         }
677
678         vmcs_conf->size = vmx_msr_high & 0x1fff;
679         vmcs_conf->revision_id = (uint32_t) vmx_msr;
680
681         /* Read in the caps for runtime checks.  This MSR is only available if
682          * secondary controls and ept or vpid is on, which we check earlier */
683         vmx_msr = read_msr(MSR_IA32_VMX_EPT_VPID_CAP);
684         vmx_capability.vpid = high32(vmx_msr);
685         vmx_capability.ept = low32(vmx_msr);
686
687         *ret = 0;
688 }
689
690 static struct vmcs *__vmx_alloc_vmcs(int node)
691 {
692         struct vmcs *vmcs;
693
694         vmcs = kpages_alloc(vmcs_config.size, MEM_WAIT);
695         if (!vmcs)
696                 error(ENOMEM, "__vmx_alloc_vmcs: Could not get %d contig bytes",
697                       vmcs_config.size);
698         memset(vmcs, 0, vmcs_config.size);
699         vmcs->revision_id = vmcs_config.revision_id; /* vmcs revision id */
700         printd("%d: set rev id %d\n", core_id(), vmcs->revision_id);
701         return vmcs;
702 }
703
704 /**
705  * vmx_alloc_vmcs - allocates a VMCS region
706  *
707  * NOTE: Assumes the new region will be used by the current CPU.
708  *
709  * Returns a valid VMCS region.
710  */
711 static struct vmcs *
712 vmx_alloc_vmcs(void)
713 {
714         return __vmx_alloc_vmcs(numa_id());
715 }
716
717 /**
718  * vmx_free_vmcs - frees a VMCS region
719  */
720 static void
721 vmx_free_vmcs(struct vmcs *vmcs)
722 {
723         kpages_free(vmcs, vmcs_config.size);
724 }
725
726 /*
727  * Set up the vmcs's constant host-state fields, i.e., host-state fields that
728  * will not change in the lifetime of the guest.
729  * Note that host-state that does change is set elsewhere. E.g., host-state
730  * that is set differently for each CPU is set in __vmx_setup_pcpu(), not here.
731  */
732 static void vmx_setup_constant_host_state(void)
733 {
734         pseudodesc_t dt;
735
736         vmcs_writel(HOST_CR0, rcr0() & ~X86_CR0_TS);    /* 22.2.3 */
737         vmcs_writel(HOST_CR4, rcr4());  /* 22.2.3, 22.2.5 */
738         vmcs_writel(HOST_CR3, rcr3());  /* 22.2.3 */
739
740         vmcs_write16(HOST_CS_SELECTOR, GD_KT);  /* 22.2.4 */
741         vmcs_write16(HOST_DS_SELECTOR, GD_KD);  /* 22.2.4 */
742         vmcs_write16(HOST_ES_SELECTOR, GD_KD);  /* 22.2.4 */
743         vmcs_write16(HOST_SS_SELECTOR, GD_KD);  /* 22.2.4 */
744         vmcs_write16(HOST_TR_SELECTOR, GD_TSS); /* 22.2.4 */
745
746         native_store_idt(&dt);
747         vmcs_writel(HOST_IDTR_BASE, dt.pd_base);        /* 22.2.4 */
748
749         extern void vmexit_handler(void);
750         vmcs_writel(HOST_RIP, (unsigned long)vmexit_handler);
751
752         vmcs_write32(HOST_IA32_SYSENTER_CS, read_msr(MSR_IA32_SYSENTER_CS));
753         vmcs_writel(HOST_IA32_SYSENTER_EIP, read_msr(MSR_IA32_SYSENTER_EIP));
754
755         vmcs_write32(HOST_IA32_EFER, read_msr(MSR_EFER));
756
757         if (vmcs_config.vmexit_ctrl & VM_EXIT_LOAD_IA32_PAT)
758                 vmcs_write64(HOST_IA32_PAT, read_msr(MSR_IA32_CR_PAT));
759
760         vmcs_write16(HOST_FS_SELECTOR, 0);      /* 22.2.4 */
761         vmcs_write16(HOST_GS_SELECTOR, 0);      /* 22.2.4 */
762         vmcs_write(HOST_FS_BASE, 0);
763 }
764
765 /* Set up the per-core VMCS fields.  This is the host state that varies from
766  * core to core, which the hardware will switch for us on VM enters/exits. */
767 static void __vmx_setup_pcpu(struct guest_pcore *gpc)
768 {
769         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
770
771         vmcs_write(HOST_TR_BASE, (uintptr_t)pcpui->tss);
772         vmcs_writel(HOST_GDTR_BASE, (uintptr_t)pcpui->gdt);
773         vmcs_write(HOST_GS_BASE, (uintptr_t)pcpui);
774         /* TODO: we might need to also set HOST_IA32_PERF_GLOBAL_CTRL.  Need to
775          * think about how perf will work with VMs */
776 }
777
778 uint64_t
779 construct_eptp(physaddr_t root_hpa)
780 {
781         uint64_t eptp;
782
783         /* set WB memory and 4 levels of walk.  we checked these in ept_init */
784         eptp = VMX_EPT_MEM_TYPE_WB | (VMX_EPT_GAW_4_LVL << VMX_EPT_GAW_EPTP_SHIFT);
785         if (cpu_has_vmx_ept_ad_bits())
786                 eptp |= VMX_EPT_AD_ENABLE_BIT;
787         eptp |= (root_hpa & PAGE_MASK);
788
789         return eptp;
790 }
791
792 /* Helper: some fields of the VMCS need a physical page address, e.g. the VAPIC
793  * page.  We have the user address.  This converts the user to phys addr and
794  * sets that up in the VMCS.  Throws on error. */
795 static void vmcs_set_pgaddr(struct proc *p, void *u_addr,
796                             unsigned long field, char *what)
797 {
798         uintptr_t kva;
799         physaddr_t paddr;
800
801         /* Enforce page alignment */
802         kva = uva2kva(p, ROUNDDOWN(u_addr, PGSIZE), PGSIZE, PROT_WRITE);
803         if (!kva)
804                 error(EINVAL, "Unmapped pgaddr %p for VMCS page %s", u_addr, what);
805
806         paddr = PADDR(kva);
807         /* TODO: need to pin the page.  A munmap would actually be okay
808          * (though probably we should kill the process), but we need to
809          * keep the page from being reused.  A refcnt would do the trick,
810          * which we decref when we destroy the guest core/vcpu. Note that
811          * this is an assert, not an error, because it represents an error
812          * in the kernel itself. */
813         assert(!PGOFF(paddr));
814         vmcs_writel(field, paddr);
815         /* Pages are inserted twice.  Once, with the full paddr.  The next field is
816          * the upper 32 bits of the paddr. */
817         vmcs_writel(field + 1, paddr >> 32);
818 }
819
820 /**
821  * vmx_setup_initial_guest_state - configures the initial state of guest
822  * registers and the VMCS.  Throws on error.
823  */
824 static void vmx_setup_initial_guest_state(struct proc *p,
825                                           struct vmm_gpcore_init *gpci)
826 {
827         unsigned long tmpl;
828         unsigned long cr4 = X86_CR4_PAE | X86_CR4_VMXE | X86_CR4_OSXMMEXCPT |
829                 X86_CR4_PGE | X86_CR4_OSFXSR;
830         uint32_t protected_mode = X86_CR0_PG | X86_CR0_PE;
831
832         /*
833          * Allow guest to use xsave and read/write fs/gs base.
834          * We require these features to be present on the cpu.
835          */
836         assert(cpu_has_feat(CPU_FEAT_X86_XSAVE));
837         assert(cpu_has_feat(CPU_FEAT_X86_FSGSBASE));
838         cr4 |= X86_CR4_RDWRGSFS;
839         cr4 |= X86_CR4_OSXSAVE;
840         /* configure control and data registers */
841         vmcs_writel(GUEST_CR0, protected_mode | X86_CR0_WP |
842                                 X86_CR0_MP | X86_CR0_ET | X86_CR0_NE);
843         vmcs_writel(CR0_READ_SHADOW, protected_mode | X86_CR0_WP |
844                                 X86_CR0_MP | X86_CR0_ET | X86_CR0_NE);
845         vmcs_writel(GUEST_CR3, rcr3());
846         vmcs_writel(GUEST_CR4, cr4);
847         /* The only bits that matter in this shadow are those that are
848          * set in CR4_GUEST_HOST_MASK.  TODO: do we need to separate
849          * the setting of this value from that of
850          * CR4_GUEST_HOST_MASK? */
851         vmcs_writel(CR4_READ_SHADOW, 0);
852         vmcs_writel(GUEST_IA32_EFER, EFER_LME | EFER_LMA |
853                                 EFER_SCE | EFER_NX /*| EFER_FFXSR */ );
854         vmcs_writel(GUEST_GDTR_BASE, 0);
855         vmcs_writel(GUEST_GDTR_LIMIT, 0);
856         vmcs_writel(GUEST_IDTR_BASE, 0);
857         vmcs_writel(GUEST_IDTR_LIMIT, 0);
858         vmcs_writel(GUEST_RIP, 0xdeadbeef);
859         vmcs_writel(GUEST_RSP, 0xdeadbeef);
860         vmcs_writel(GUEST_RFLAGS, FL_RSVD_1);
861         vmcs_writel(GUEST_DR7, 0);
862
863         /* guest segment bases */
864         vmcs_writel(GUEST_CS_BASE, 0);
865         vmcs_writel(GUEST_DS_BASE, 0);
866         vmcs_writel(GUEST_ES_BASE, 0);
867         vmcs_writel(GUEST_GS_BASE, 0);
868         vmcs_writel(GUEST_SS_BASE, 0);
869         tmpl = read_fsbase();
870         vmcs_writel(GUEST_FS_BASE, tmpl);
871
872         /* guest segment access rights */
873         vmcs_writel(GUEST_CS_AR_BYTES, 0xA09B);
874         vmcs_writel(GUEST_DS_AR_BYTES, 0xA093);
875         vmcs_writel(GUEST_ES_AR_BYTES, 0xA093);
876         vmcs_writel(GUEST_FS_AR_BYTES, 0xA093);
877         vmcs_writel(GUEST_GS_AR_BYTES, 0xA093);
878         vmcs_writel(GUEST_SS_AR_BYTES, 0xA093);
879
880         /* guest segment limits */
881         vmcs_write32(GUEST_CS_LIMIT, 0xFFFFFFFF);
882         vmcs_write32(GUEST_DS_LIMIT, 0xFFFFFFFF);
883         vmcs_write32(GUEST_ES_LIMIT, 0xFFFFFFFF);
884         vmcs_write32(GUEST_FS_LIMIT, 0xFFFFFFFF);
885         vmcs_write32(GUEST_GS_LIMIT, 0xFFFFFFFF);
886         vmcs_write32(GUEST_SS_LIMIT, 0xFFFFFFFF);
887
888         /* configure segment selectors */
889         vmcs_write16(GUEST_CS_SELECTOR, 0);
890         vmcs_write16(GUEST_DS_SELECTOR, 0);
891         vmcs_write16(GUEST_ES_SELECTOR, 0);
892         vmcs_write16(GUEST_FS_SELECTOR, 0);
893         vmcs_write16(GUEST_GS_SELECTOR, 0);
894         vmcs_write16(GUEST_SS_SELECTOR, 0);
895         vmcs_write16(GUEST_TR_SELECTOR, 0);
896
897         /* guest LDTR */
898         vmcs_write16(GUEST_LDTR_SELECTOR, 0);
899         vmcs_writel(GUEST_LDTR_AR_BYTES, 0x0082);
900         vmcs_writel(GUEST_LDTR_BASE, 0);
901         vmcs_writel(GUEST_LDTR_LIMIT, 0);
902
903         /* guest TSS */
904         vmcs_writel(GUEST_TR_BASE, 0);
905         vmcs_writel(GUEST_TR_AR_BYTES, 0x0080 | AR_TYPE_BUSY_64_TSS);
906         vmcs_writel(GUEST_TR_LIMIT, 0xff);
907
908         /* initialize sysenter */
909         vmcs_write32(GUEST_SYSENTER_CS, 0);
910         vmcs_writel(GUEST_SYSENTER_ESP, 0);
911         vmcs_writel(GUEST_SYSENTER_EIP, 0);
912
913         /* other random initialization */
914         vmcs_write32(GUEST_ACTIVITY_STATE, GUEST_ACTIVITY_ACTIVE);
915         vmcs_write32(GUEST_INTERRUPTIBILITY_INFO, 0);
916         vmcs_write32(GUEST_PENDING_DBG_EXCEPTIONS, 0);
917         vmcs_write64(GUEST_IA32_DEBUGCTL, 0);
918         vmcs_write32(VM_ENTRY_INTR_INFO_FIELD, 0);      /* 22.2.1 */
919
920         /* Initialize posted interrupt notification vector */
921         vmcs_write16(POSTED_NOTIFICATION_VEC, I_POKE_GUEST);
922
923         /* Clear the EOI exit bitmap */
924         vmcs_writel(EOI_EXIT_BITMAP0, 0);
925         vmcs_writel(EOI_EXIT_BITMAP0_HIGH, 0);
926         vmcs_writel(EOI_EXIT_BITMAP1, 0);
927         vmcs_writel(EOI_EXIT_BITMAP1_HIGH, 0);
928         vmcs_writel(EOI_EXIT_BITMAP2, 0);
929         vmcs_writel(EOI_EXIT_BITMAP2_HIGH, 0);
930         vmcs_writel(EOI_EXIT_BITMAP3, 0);
931         vmcs_writel(EOI_EXIT_BITMAP3_HIGH, 0);
932
933         /* Initialize parts based on the users info. */
934         vmcs_set_pgaddr(p, gpci->posted_irq_desc, POSTED_INTR_DESC_ADDR,
935                         "posted_irq_desc");
936         vmcs_set_pgaddr(p, gpci->vapic_addr, VIRTUAL_APIC_PAGE_ADDR,
937                         "vapic_addr");
938         vmcs_set_pgaddr(p, gpci->apic_addr, APIC_ACCESS_ADDR, "apic_addr");
939 }
940
941 static void __vmx_disable_intercept_for_msr(unsigned long *msr_bitmap,
942                                             uint32_t msr) {
943         int f = sizeof(unsigned long);
944         /*
945          * See Intel PRM Vol. 3, 20.6.9 (MSR-Bitmap Address). Early manuals
946          * have the write-low and read-high bitmap offsets the wrong way round.
947          * We can control MSRs 0x00000000-0x00001fff and 0xc0000000-0xc0001fff.
948          */
949         if (msr <= 0x1fff) {
950                 __clear_bit(msr, msr_bitmap + 0x000 / f);       /* read-low */
951                 __clear_bit(msr, msr_bitmap + 0x800 / f);       /* write-low */
952         } else if ((msr >= 0xc0000000) && (msr <= 0xc0001fff)) {
953                 msr &= 0x1fff;
954                 __clear_bit(msr, msr_bitmap + 0x400 / f);       /* read-high */
955                 __clear_bit(msr, msr_bitmap + 0xc00 / f);       /* write-high */
956         }
957 }
958
959 /* note the io_bitmap is big enough for the 64K port space. */
960 static void __vmx_disable_intercept_for_io(unsigned long *io_bitmap,
961                                            uint16_t port) {
962         __clear_bit(port, io_bitmap);
963 }
964
965 static void dumpmsrs(void) {
966         int i;
967         int set[] = {
968                 MSR_LSTAR,
969                 MSR_FS_BASE,
970                 MSR_GS_BASE,
971                 MSR_KERNEL_GS_BASE,
972                 MSR_SFMASK,
973                 MSR_IA32_PEBS_ENABLE
974         };
975         for (i = 0; i < ARRAY_SIZE(set); i++) {
976                 printk("%p: %p\n", set[i], read_msr(set[i]));
977         }
978         printk("core id %d\n", core_id());
979 }
980
981 /* Notes on autoloading.  We can't autoload FS_BASE or GS_BASE, according to the
982  * manual, but that's because they are automatically saved and restored when all
983  * of the other architectural registers are saved and restored, such as cs, ds,
984  * es, and other fun things. (See 24.4.1).  We need to make sure we don't
985  * accidentally intercept them too, since they are magically autoloaded.
986  *
987  * We'll need to be careful of any MSR we neither autoload nor intercept
988  * whenever we vmenter/vmexit, and we intercept by default.
989  *
990  * Other MSRs, such as MSR_IA32_PEBS_ENABLE only work on certain architectures
991  * only work on certain architectures. */
992 static void setup_msr(struct guest_pcore *gpc)
993 {
994         /* Since PADDR(msr_bitmap) is non-zero, and the bitmap is all 0xff, we now
995          * intercept all MSRs */
996         vmcs_write64(MSR_BITMAP, PADDR(msr_bitmap));
997
998         vmcs_write64(IO_BITMAP_A, PADDR(io_bitmap));
999         vmcs_write64(IO_BITMAP_B, PADDR((uintptr_t)io_bitmap +
1000                                         (VMX_IO_BITMAP_SZ / 2)));
1001
1002         vmcs_write32(VM_EXIT_MSR_STORE_COUNT, 0);
1003         vmcs_write32(VM_EXIT_MSR_LOAD_COUNT, 0);
1004         vmcs_write32(VM_ENTRY_MSR_LOAD_COUNT, 0);
1005 }
1006
1007 /**
1008  *  vmx_setup_vmcs - configures the vmcs with starting parameters
1009  */
1010 static void vmx_setup_vmcs(struct guest_pcore *gpc)
1011 {
1012         vmcs_write16(VIRTUAL_PROCESSOR_ID, 0);
1013         vmcs_write64(VMCS_LINK_POINTER, -1ull); /* 22.3.1.5 */
1014
1015         /* Control */
1016         vmcs_write32(PIN_BASED_VM_EXEC_CONTROL,
1017                      vmcs_config.pin_based_exec_ctrl);
1018
1019         vmcs_write32(CPU_BASED_VM_EXEC_CONTROL,
1020                      vmcs_config.cpu_based_exec_ctrl);
1021
1022         if (cpu_has_secondary_exec_ctrls()) {
1023                 vmcs_write32(SECONDARY_VM_EXEC_CONTROL,
1024                              vmcs_config.cpu_based_2nd_exec_ctrl);
1025         }
1026
1027         vmcs_write64(EPT_POINTER, gpc_get_eptp(gpc));
1028
1029         vmcs_write32(PAGE_FAULT_ERROR_CODE_MASK, 0);
1030         vmcs_write32(PAGE_FAULT_ERROR_CODE_MATCH, 0);
1031         vmcs_write32(CR3_TARGET_COUNT, 0);      /* 22.2.1 */
1032
1033         setup_msr(gpc);
1034
1035         vmcs_config.vmentry_ctrl |= VM_ENTRY_IA32E_MODE;
1036
1037         vmcs_write32(VM_EXIT_CONTROLS, vmcs_config.vmexit_ctrl);
1038         vmcs_write32(VM_ENTRY_CONTROLS, vmcs_config.vmentry_ctrl);
1039
1040         vmcs_writel(CR0_GUEST_HOST_MASK, 0);    // ~0ul);
1041
1042         /* Mask some bits in CR4 as host-owned by setting them in this
1043          * VMCS entry.  For example, for now, we mark the CR4_VMXE bit
1044          * as host owned.  Right now, when Linux boots, it wants to
1045          * set CR4_VMXE to 0 at first, which is fine -- we do not want
1046          * to think about nested virtualization yet. But if we don't
1047          * mark this bit as host owned we get a VMEXIT. Marking
1048          * CR4_VMXE as host owned means that the writes will succeed
1049          * with no vmexit if the value written matches the
1050          * corresponding bit in the shadow register. */
1051         vmcs_writel(CR4_GUEST_HOST_MASK, CR4_VMXE);
1052
1053         //kvm_write_tsc(&vmx->gpc, 0);
1054         vmcs_writel(TSC_OFFSET, 0);
1055
1056         vmx_setup_constant_host_state();
1057 }
1058
1059 /**
1060  * create_guest_pcore - allocates and initializes a guest physical core
1061  *
1062  * Returns: A new VCPU structure
1063  */
1064 struct guest_pcore *create_guest_pcore(struct proc *p,
1065                                        struct vmm_gpcore_init *gpci)
1066 {
1067         ERRSTACK(2);
1068         int8_t state = 0;
1069         struct guest_pcore *gpc = kmalloc(sizeof(struct guest_pcore), MEM_WAIT);
1070
1071         if (!gpc)
1072                 error(ENOMEM, "create_guest_pcore could not allocate gpc");
1073
1074         if (waserror()) {
1075                 kfree(gpc);
1076                 nexterror();
1077         }
1078
1079         memset(gpc, 0, sizeof(*gpc));
1080
1081         /* Warning: p here is uncounted (weak) reference */
1082         gpc->proc = p;
1083         gpc->vmcs = vmx_alloc_vmcs();
1084         if (waserror()) {
1085                 vmx_free_vmcs(gpc->vmcs);
1086                 nexterror();
1087         }
1088         printd("%d: gpc->vmcs is %p\n", core_id(), gpc->vmcs);
1089         gpc->cpu = -1;
1090         gpc->vmcs_core_id = -1;
1091         gpc->should_vmresume = FALSE;
1092
1093         disable_irqsave(&state);
1094         vmx_load_guest_pcore(gpc);
1095         vmx_setup_vmcs(gpc);
1096         vmx_setup_initial_guest_state(p, gpci);
1097         vmx_unload_guest_pcore(gpc);
1098         enable_irqsave(&state);
1099
1100         gpc->xcr0 = __proc_global_info.x86_default_xcr0;
1101
1102         gpc->posted_irq_desc = gpci->posted_irq_desc;
1103         poperror();
1104         poperror();
1105         return gpc;
1106 }
1107
1108 /**
1109  * destroy_guest_pcore - destroys and frees an existing guest physical core
1110  * @gpc: the GPC to destroy
1111  */
1112 void destroy_guest_pcore(struct guest_pcore *gpc)
1113 {
1114         vmx_free_vmcs(gpc->vmcs);
1115         kfree(gpc);
1116 }
1117
1118 static void vmx_step_instruction(void) {
1119         vmcs_writel(GUEST_RIP, vmcs_readl(GUEST_RIP) +
1120                     vmcs_read32(VM_EXIT_INSTRUCTION_LEN));
1121 }
1122
1123 /**
1124  * __vmx_enable - low-level enable of VMX mode on the current CPU
1125  * @vmxon_buf: an opaque buffer for use as the VMXON region
1126  */
1127 static int __vmx_enable(struct vmcs *vmxon_buf) {
1128         uint64_t phys_addr = PADDR(vmxon_buf);
1129         uint64_t old, test_bits;
1130
1131         if (rcr4() & X86_CR4_VMXE) {
1132                 panic("Should never have this happen");
1133                 return -EBUSY;
1134         }
1135
1136         old = read_msr(MSR_IA32_FEATURE_CONTROL);
1137
1138         test_bits = FEATURE_CONTROL_LOCKED;
1139         test_bits |= FEATURE_CONTROL_VMXON_ENABLED_OUTSIDE_SMX;
1140
1141         if (0)  // tboot_enabled())
1142                 test_bits |= FEATURE_CONTROL_VMXON_ENABLED_INSIDE_SMX;
1143
1144         if ((old & test_bits) != test_bits) {
1145                 /* If it's locked, then trying to set it will cause a GPF.
1146                  * No Dune for you!
1147                  */
1148                 if (old & FEATURE_CONTROL_LOCKED) {
1149                         printk("Dune: MSR_IA32_FEATURE_CONTROL is locked!\n");
1150                         return -1;
1151                 }
1152
1153                 /* enable and lock */
1154                 write_msr(MSR_IA32_FEATURE_CONTROL, old | test_bits);
1155         }
1156         lcr4(rcr4() | X86_CR4_VMXE);
1157
1158         __vmxon(phys_addr);
1159         vpid_sync_gpc_global(); /* good idea, even if we aren't using vpids */
1160         ept_sync_global();
1161
1162         return 0;
1163 }
1164
1165 /**
1166  * vmx_disable - disables VMX mode on the current CPU
1167  */
1168 static void vmx_disable(void *unused) {
1169         if (currentcpu->vmx_enabled) {
1170                 __vmxoff();
1171                 lcr4(rcr4() & ~X86_CR4_VMXE);
1172                 currentcpu->vmx_enabled = 0;
1173         }
1174 }
1175
1176 /* Probe the cpus to see which ones can do vmx.
1177  * Return -errno if it fails, and 1 if it succeeds.
1178  */
1179 static bool probe_cpu_vmx(void) {
1180         /* The best way to test this code is:
1181          * wrmsr -p <cpu> 0x3a 1
1182          * This will lock vmx off; then modprobe dune.
1183          * Frequently, however, systems have all 0x3a registers set to 5,
1184          * meaning testing is impossible, as vmx can not be disabled.
1185          * We have to simulate it being unavailable in most cases.
1186          * The 'test' variable provides an easy way to simulate
1187          * unavailability of vmx on some, none, or all cpus.
1188          */
1189         if (!cpu_has_vmx()) {
1190                 printk("Machine does not support VT-x\n");
1191                 return FALSE;
1192         } else {
1193                 printk("Machine supports VT-x\n");
1194                 return TRUE;
1195         }
1196 }
1197
1198 static int ept_init(void) {
1199         if (!cpu_has_vmx_ept()) {
1200                 printk("VMX doesn't support EPT!\n");
1201                 return -1;
1202         }
1203         if (!cpu_has_vmx_eptp_writeback()) {
1204                 printk("VMX EPT doesn't support WB memory!\n");
1205                 return -1;
1206         }
1207         if (!cpu_has_vmx_ept_4levels()) {
1208                 printk("VMX EPT doesn't support 4 level walks!\n");
1209                 return -1;
1210         }
1211         switch (arch_max_jumbo_page_shift()) {
1212         case PML3_SHIFT:
1213                 if (!cpu_has_vmx_ept_1g_page()) {
1214                         printk("VMX EPT doesn't support 1 GB pages!\n");
1215                         return -1;
1216                 }
1217                 break;
1218         case PML2_SHIFT:
1219                 if (!cpu_has_vmx_ept_2m_page()) {
1220                         printk("VMX EPT doesn't support 2 MB pages!\n");
1221                         return -1;
1222                 }
1223                 break;
1224         default:
1225                 printk("Unexpected jumbo page size %d\n",
1226                        arch_max_jumbo_page_shift());
1227                 return -1;
1228         }
1229         if (!cpu_has_vmx_ept_ad_bits()) {
1230                 printk("VMX EPT doesn't support accessed/dirty!\n");
1231                 x86_ept_pte_fix_ups |= EPTE_A | EPTE_D;
1232         }
1233         if (!cpu_has_vmx_invept() || !cpu_has_vmx_invept_global()) {
1234                 printk("VMX EPT can't invalidate PTEs/TLBs!\n");
1235                 return -1;
1236         }
1237
1238         return 0;
1239 }
1240
1241 /**
1242  * vmx_init sets up physical core data areas that are required to run a vm at all.
1243  * These data areas are not connected to a specific user process in any way. Instead,
1244  * they are in some sense externalizing what would other wise be a very large ball of
1245  * state that would be inside the CPU.
1246  */
1247 int intel_vmm_init(void) {
1248         int r, cpu, ret;
1249
1250         if (!probe_cpu_vmx()) {
1251                 return -EOPNOTSUPP;
1252         }
1253
1254         setup_vmcs_config(&ret);
1255
1256         if (ret) {
1257                 printk("setup_vmcs_config failed: %d\n", ret);
1258                 return ret;
1259         }
1260
1261         msr_bitmap = (unsigned long *)kpage_zalloc_addr();
1262         if (!msr_bitmap) {
1263                 printk("Could not allocate msr_bitmap\n");
1264                 return -ENOMEM;
1265         }
1266         io_bitmap = (unsigned long *)kpages_alloc(VMX_IO_BITMAP_SZ, MEM_WAIT);
1267         if (!io_bitmap) {
1268                 printk("Could not allocate msr_bitmap\n");
1269                 kfree(msr_bitmap);
1270                 return -ENOMEM;
1271         }
1272         /* FIXME: do we need APIC virtualization (flexpriority?) */
1273
1274         memset(msr_bitmap, 0xff, PAGE_SIZE);
1275
1276         /* The following MSRs are virtualized to the vapic page so there is no
1277          * write or read from the actual MSR. */
1278         memset((void *)msr_bitmap + INTEL_X2APIC_MSR_START, 0,
1279                INTEL_X2APIC_MSR_LENGTH);
1280         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_LAPIC_EOI);
1281         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_LAPIC_TPR);
1282         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_LAPIC_SELF_IPI);
1283
1284         memset(io_bitmap, 0xff, VMX_IO_BITMAP_SZ);
1285
1286         /* These are the only MSRs that are not intercepted.  The hardware takes
1287          * care of FS_BASE, GS_BASE, and EFER.  We do the rest manually when loading
1288          * and unloading guest pcores. */
1289         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_FS_BASE);
1290         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_GS_BASE);
1291         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_EFER);
1292         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_KERNEL_GS_BASE);
1293         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_LSTAR);
1294         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_STAR);
1295         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_SFMASK);
1296
1297         /* TODO: this might be dangerous, since they can do more than just read the
1298          * CMOS */
1299         __vmx_disable_intercept_for_io(io_bitmap, CMOS_RAM_IDX);
1300         __vmx_disable_intercept_for_io(io_bitmap, CMOS_RAM_DATA);
1301
1302         if ((ret = ept_init())) {
1303                 printk("EPT init failed, %d\n", ret);
1304                 return ret;
1305         }
1306         printk("VMX setup succeeded\n");
1307         return 0;
1308 }
1309
1310 int intel_vmm_pcpu_init(void)
1311 {
1312         struct vmcs *vmxon_buf;
1313         int ret;
1314
1315         vmxon_buf = __vmx_alloc_vmcs(core_id());
1316         if (!vmxon_buf) {
1317                 printk("setup_vmxarea failed on node %d\n", core_id());
1318                 return -1;
1319         }
1320
1321         ret = __vmx_enable(vmxon_buf);
1322         if (ret)
1323                 goto failed;
1324         currentcpu->vmx_enabled = 1;
1325         printk("VMX enabled on CPU %d\n", core_id());
1326         return 0;
1327 failed:
1328         printk("Failed to enable VMX on core %d, err = %d\n", core_id(), ret);
1329         return ret;
1330 }
1331
1332
1333 void vapic_status_dump_kernel(void *vapic)
1334 {
1335         uint32_t *p = (uint32_t *)vapic;
1336         int i;
1337         printk("-- BEGIN KERNEL APIC STATUS DUMP --\n");
1338         for (i = 0x100/sizeof(*p); i < 0x180/sizeof(*p); i+=4) {
1339                 printk("VISR : 0x%x: 0x%08x\n", i, p[i]);
1340         }
1341         for (i = 0x200/sizeof(*p); i < 0x280/sizeof(*p); i+=4) {
1342                 printk("VIRR : 0x%x: 0x%08x\n", i, p[i]);
1343         }
1344         i = 0x0B0/sizeof(*p);
1345         printk("EOI FIELD : 0x%x, 0x%08x\n", i, p[i]);
1346
1347         printk("-- END KERNEL APIC STATUS DUMP --\n");
1348 }
1349
1350 static DEFINE_PERCPU(struct guest_pcore *, gpc_to_clear_to);
1351
1352 /* Note this is set up to allow spurious pokes.  Someone could arbitrarily send
1353  * us this KMSG at any time.  We only actually clear when we've previously
1354  * unloaded the GPC.  gpc_to_clear_to is only set once we're just 'caching' it.
1355  * */
1356 void vmx_clear_vmcs(void)
1357 {
1358         struct guest_pcore *gpc;
1359         int8_t irq_state = 0;
1360
1361         disable_irqsave(&irq_state);
1362         gpc = PERCPU_VAR(gpc_to_clear_to);
1363         if (gpc) {
1364                 vmcs_clear(gpc->vmcs);
1365                 ept_sync_context(gpc_get_eptp(gpc));
1366                 gpc->should_vmresume = FALSE;
1367                 wmb(); /* write -1 after clearing */
1368                 gpc->vmcs_core_id = -1;
1369                 PERCPU_VAR(gpc_to_clear_to) = NULL;
1370         }
1371         enable_irqsave(&irq_state);
1372 }
1373
1374 static void __clear_vmcs(uint32_t srcid, long a0, long a1, long a2)
1375 {
1376         vmx_clear_vmcs();
1377 }
1378
1379 /* We are safe from races on GPC, other than vmcs and vmcs_core_id.  For
1380  * instance, only one core can be loading or unloading a particular GPC at a
1381  * time.  Other cores write to our GPC's vmcs_core_id and vmcs (doing a
1382  * vmcs_clear).  Once they write vmcs_core_id != -1, it's ours. */
1383 void vmx_load_guest_pcore(struct guest_pcore *gpc)
1384 {
1385         int remote_core;
1386
1387         assert(!irq_is_enabled());
1388         if (gpc->vmcs_core_id == core_id()) {
1389                 PERCPU_VAR(gpc_to_clear_to) = NULL;
1390                 return;
1391         }
1392         /* Clear ours *before* waiting on someone else; avoids deadlock (circular
1393          * wait). */
1394         __clear_vmcs(0, 0, 0, 0);
1395         remote_core = ACCESS_ONCE(gpc->vmcs_core_id);
1396         if (remote_core != -1) {
1397                 /* This is a bit nasty.  It requires the remote core to receive
1398                  * interrupts, which means we're now waiting indefinitely for them to
1399                  * enable IRQs.  They can wait on another core, and so on.  We cleared
1400                  * our vmcs first, so that we won't deadlock on *this*.
1401                  *
1402                  * However, this means we can't wait on another core with IRQs disabled
1403                  * for any *other* reason.  For instance, if some other subsystem
1404                  * decides to have one core wait with IRQs disabled on another, the core
1405                  * that has our VMCS could be waiting on us to do something that we'll
1406                  * never do. */
1407                 send_kernel_message(remote_core, __clear_vmcs, 0, 0, 0, KMSG_IMMEDIATE);
1408                 while (gpc->vmcs_core_id != -1)
1409                         cpu_relax();
1410         }
1411         vmcs_load(gpc->vmcs);
1412         __vmx_setup_pcpu(gpc);
1413         gpc->vmcs_core_id = core_id();
1414 }
1415
1416 void vmx_unload_guest_pcore(struct guest_pcore *gpc)
1417 {
1418         /* We don't have to worry about races yet.  No one will try to load gpc
1419          * until we've returned and unlocked, and no one will clear an old VMCS to
1420          * this GPC, since it was cleared before we finished loading (above). */
1421         assert(!irq_is_enabled());
1422         gpc->vmcs_core_id = core_id();
1423         PERCPU_VAR(gpc_to_clear_to) = gpc;
1424 }
1425
1426 uint64_t gpc_get_eptp(struct guest_pcore *gpc)
1427 {
1428         return gpc->proc->env_pgdir.eptp;
1429 }