Initialize guest xcr0, save and restore xcr0 between guest and Akaros
[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 compatability 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 wilde 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 wel'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 alightment, 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 whatis 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
157 #include <ros/vmm.h>
158 #include "vmx.h"
159 #include "../vmm.h"
160
161 #include "cpufeature.h"
162
163 #include <trap.h>
164
165 #include <smp.h>
166
167 #define currentcpu (&per_cpu_info[core_id()])
168
169 static unsigned long *msr_bitmap;
170 #define VMX_IO_BITMAP_ORDER             4       /* 64 KB */
171 #define VMX_IO_BITMAP_SZ                (1 << (VMX_IO_BITMAP_ORDER + PGSHIFT))
172 static unsigned long *io_bitmap;
173
174 int x86_ept_pte_fix_ups = 0;
175
176 struct vmx_capability vmx_capability;
177 struct vmcs_config vmcs_config;
178
179 static int autoloaded_msrs[] = {
180         MSR_KERNEL_GS_BASE,
181         MSR_LSTAR,
182         MSR_STAR,
183         MSR_SFMASK,
184 };
185
186 static char *cr_access_type[] = {
187         "move to cr",
188         "move from cr",
189         "clts",
190         "lmsw"
191 };
192
193 static char *cr_gpr[] = {
194         "rax", "rcx", "rdx", "rbx", "rsp", "rbp", "rsi", "rdi",
195         "r8", "r9", "r10", "r11", "r12", "r13", "r14", "r15"
196 };
197
198 static int guest_cr_num[16] = {
199         GUEST_CR0,
200         -1,
201         -1,
202         GUEST_CR3,
203         GUEST_CR4,
204         -1,
205         -1,
206         -1,
207         -1,     /* 8? */
208         -1, -1, -1, -1, -1, -1, -1
209 };
210
211 __always_inline unsigned long vmcs_readl(unsigned long field);
212 /* See section 24-3 of The Good Book */
213 void
214 show_cr_access(uint64_t val)
215 {
216         int crnr = val & 0xf;
217         int type = (val >> 4) & 3;
218         int reg = (val >> 11) & 0xf;
219         printk("%s: %d: ", cr_access_type[type], crnr);
220         if (type < 2) {
221                 printk("%s", cr_gpr[reg]);
222                 if (guest_cr_num[crnr] > -1) {
223                         printk(": 0x%x", vmcs_readl(guest_cr_num[crnr]));
224                 }
225         }
226         printk("\n");
227 }
228
229 void
230 ept_flush(uint64_t eptp)
231 {
232         ept_sync_context(eptp);
233 }
234
235 static void
236 vmcs_clear(struct vmcs *vmcs)
237 {
238         uint64_t phys_addr = PADDR(vmcs);
239         uint8_t error;
240
241         asm volatile (ASM_VMX_VMCLEAR_RAX "; setna %0":"=qm"(error):"a"(&phys_addr),
242                                   "m"(phys_addr)
243                                   :"cc", "memory");
244         if (error)
245                 printk("vmclear fail: %p/%llx\n", vmcs, phys_addr);
246 }
247
248 static void
249 vmcs_load(struct vmcs *vmcs)
250 {
251         uint64_t phys_addr = PADDR(vmcs);
252         uint8_t error;
253
254         asm volatile (ASM_VMX_VMPTRLD_RAX "; setna %0":"=qm"(error):"a"(&phys_addr),
255                                   "m"(phys_addr)
256                                   :"cc", "memory");
257         if (error)
258                 printk("vmptrld %p/%llx failed\n", vmcs, phys_addr);
259 }
260
261 /* Returns the paddr pointer of the current CPU's VMCS region, or -1 if none. */
262 static physaddr_t
263 vmcs_get_current(void)
264 {
265         physaddr_t vmcs_paddr;
266         /* RAX contains the addr of the location to store the VMCS pointer.  The
267          * compiler doesn't know the ASM will deref that pointer, hence the =m */
268         asm volatile (ASM_VMX_VMPTRST_RAX:"=m"(vmcs_paddr):"a"(&vmcs_paddr));
269         return vmcs_paddr;
270 }
271
272 __always_inline unsigned long
273 vmcs_readl(unsigned long field)
274 {
275         return vmcs_read(field);
276 }
277
278 __always_inline uint16_t
279 vmcs_read16(unsigned long field)
280 {
281         return vmcs_readl(field);
282 }
283
284 static __always_inline uint32_t
285 vmcs_read32(unsigned long field)
286 {
287         return vmcs_readl(field);
288 }
289
290 static __always_inline uint64_t
291 vmcs_read64(unsigned long field)
292 {
293         return vmcs_readl(field);
294 }
295
296 void
297 vmwrite_error(unsigned long field, unsigned long value)
298 {
299         printk("vmwrite error: reg %lx value %lx (err %d)\n",
300                    field, value, vmcs_read32(VM_INSTRUCTION_ERROR));
301 }
302
303 void
304 vmcs_writel(unsigned long field, unsigned long value)
305 {
306         if (!vmcs_write(field, value))
307                 vmwrite_error(field, value);
308 }
309
310 static void
311 vmcs_write16(unsigned long field, uint16_t value)
312 {
313         vmcs_writel(field, value);
314 }
315
316 static void
317 vmcs_write32(unsigned long field, uint32_t value)
318 {
319         vmcs_writel(field, value);
320 }
321
322 static void
323 vmcs_write64(unsigned long field, uint64_t value)
324 {
325         vmcs_writel(field, value);
326 }
327
328 void vapic_status_dump_kernel(void *vapic);
329
330 /*
331  * A note on Things You Can't Make Up.
332  * or
333  * "George, you can type this shit, but you can't say it" -- Harrison Ford
334  *
335  * There are 5 VMCS 32-bit words that control guest permissions. If
336  * you set these correctly, you've got a guest that will behave. If
337  * you get even one bit wrong, you've got a guest that will chew your
338  * leg off. Some bits must be 1, some must be 0, and some can be set
339  * either way. To add to the fun, the docs are sort of a docudrama or,
340  * as the quote goes, "interesting if true."
341  *
342  * To determine what bit can be set in what VMCS 32-bit control word,
343  * there are 5 corresponding 64-bit MSRs.  And, to make it even more
344  * fun, the standard set of MSRs have errors in them, i.e. report
345  * incorrect values, for legacy reasons, and so you are supposed to
346  * "look around" to another set, which have correct bits in
347  * them. There are four such 'correct' registers, and they have _TRUE_
348  * in the names as you can see below. We test for the value of VMCS
349  * control bits in the _TRUE_ registers if possible. The fifth
350  * register, CPU Secondary Exec Controls, which came later, needs no
351  * _TRUE_ variant.
352  *
353  * For each MSR, the high 32 bits tell you what bits can be "1" by a
354  * "1" in that position; the low 32 bits tell you what bit can be "0"
355  * by a "0" in that position. So, for each of 32 bits in a given VMCS
356  * control word, there is a pair of bits in an MSR that tells you what
357  * values it can take. The two bits, of which there are *four*
358  * combinations, describe the *three* possible operations on a
359  * bit. The two bits, taken together, form an untruth table: There are
360  * three possibilities: The VMCS bit can be set to 0 or 1, or it can
361  * only be 0, or only 1. The fourth combination is not supposed to
362  * happen.
363  *
364  * So: there is the 1 bit from the upper 32 bits of the msr.
365  * If this bit is set, then the bit can be 1. If clear, it can not be 1.
366  *
367  * Then there is the 0 bit, from low 32 bits. If clear, the VMCS bit
368  * can be 0. If 1, the VMCS bit can not be 0.
369  *
370  * SO, let's call the 1 bit R1, and the 0 bit R0, we have:
371  *  R1 R0
372  *  0 0 -> must be 0
373  *  1 0 -> can be 1, can be 0
374  *  0 1 -> can not be 1, can not be 0. --> JACKPOT! Not seen yet.
375  *  1 1 -> must be one.
376  *
377  * It's also pretty hard to know what you can and can't set, and
378  * that's led to inadvertant opening of permissions at times.  Because
379  * of this complexity we've decided on the following: the driver must
380  * define EVERY bit, UNIQUELY, for each of the 5 registers, that it wants
381  * set. Further, for any bit that's settable, the driver must specify
382  * a setting; for any bit that's reserved, the driver settings must
383  * match that bit. If there are reserved bits we don't specify, that's
384  * ok; we'll take them as is.
385  *
386  * We use a set-means-set, and set-means-clear model, i.e. we use a
387  * 32-bit word to contain the bits we want to be 1, indicated by one;
388  * and another 32-bit word in which a bit we want to be 0 is indicated
389  * by a 1. This allows us to easily create masks of all bits we're
390  * going to set, for example.
391  *
392  * We have two 32-bit numbers for each 32-bit VMCS field: bits we want
393  * set and bits we want clear.  If you read the MSR for that field,
394  * compute the reserved 0 and 1 settings, and | them together, they
395  * need to result in 0xffffffff. You can see that we can create other
396  * tests for conflicts (i.e. overlap).
397  *
398  * At this point, I've tested check_vmx_controls in every way
399  * possible, beause I kept screwing the bitfields up. You'll get a nice
400  * error it won't work at all, which is what we want: a
401  * failure-prone setup, where even errors that might result in correct
402  * values are caught -- "right answer, wrong method, zero credit." If there's
403  * weirdness in the bits, we don't want to run.
404  * The try_set stuff adds particular ugliness but we have to have it.
405  */
406
407 static bool
408 check_vmxec_controls(struct vmxec const *v, bool have_true_msr,
409                                          uint32_t * result)
410 {
411         bool err = false;
412         uint32_t vmx_msr_low, vmx_msr_high;
413         uint32_t reserved_0, reserved_1, changeable_bits, try0, try1;
414
415         if (have_true_msr)
416                 rdmsr(v->truemsr, vmx_msr_low, vmx_msr_high);
417         else
418                 rdmsr(v->msr, vmx_msr_low, vmx_msr_high);
419
420         if (vmx_msr_low & ~vmx_msr_high)
421                 warn("JACKPOT: Conflicting VMX ec ctls for %s, high 0x%08x low 0x%08x",
422                          v->name, vmx_msr_high, vmx_msr_low);
423
424         reserved_0 = (~vmx_msr_low) & (~vmx_msr_high);
425         reserved_1 = vmx_msr_low & vmx_msr_high;
426         changeable_bits = ~(reserved_0 | reserved_1);
427
428         /*
429          * this is very much as follows:
430          * accept the things I cannot change,
431          * change the things I can,
432          * know the difference.
433          */
434
435         /* Conflict. Don't try to both set and reset bits. */
436         if ((v->must_be_1 & (v->must_be_0 | v->try_set_1 | v->try_set_0)) ||
437             (v->must_be_0 & (v->try_set_1 | v->try_set_0)) ||
438             (v->try_set_1 & v->try_set_0)) {
439                 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",
440                        v->name, v->must_be_0, v->must_be_1, v->try_set_0, v->try_set_1);
441                 err = true;
442         }
443
444         /* coverage */
445         if (((v->must_be_0 | v->must_be_1 | v->try_set_0 | v->try_set_1) & changeable_bits) != changeable_bits) {
446                 printk("%s: Need to cover 0x%x and have 0x%x,0x%x\n",
447                        v->name, changeable_bits, v->must_be_0, v->must_be_1, v->try_set_0, v->try_set_1);
448                 err = true;
449         }
450
451         if ((v->must_be_0 | v->must_be_1 | v->try_set_0 | v->try_set_1 | reserved_0 | reserved_1) != 0xffffffff) {
452                 printk("%s: incomplete coverage: have 0x%x, want 0x%x\n",
453                        v->name, v->must_be_0 | v->must_be_1 | v->try_set_0 | v->try_set_1 |
454                        reserved_0 | reserved_1, 0xffffffff);
455                 err = true;
456         }
457
458         /* Don't try to change bits that can't be changed. */
459         if ((v->must_be_0 & (reserved_0 | changeable_bits)) != v->must_be_0) {
460                 printk("%s: set to 0 (0x%x) can't be done\n", v->name, v->must_be_0);
461                 err = true;
462         }
463
464         if ((v->must_be_1 & (reserved_1 | changeable_bits)) != v->must_be_1) {
465                 printk("%s: set to 1 (0x%x) can't be done\n", v->name, v->must_be_1);
466                 err = true;
467         }
468         // Note we don't REQUIRE that try_set_0 or try_set_0 be possible. We just want to try it.
469
470         // Clear bits in try_set that can't be set.
471         try1 = v->try_set_1 & (reserved_1 | changeable_bits);
472
473         /* If there's been any error at all, spill our guts and return. */
474         if (err) {
475                 printk("%s: vmx_msr_high 0x%x, vmx_msr_low 0x%x, ",
476                            v->name, vmx_msr_high, vmx_msr_low);
477                 printk("must_be_0 0x%x, try_set_0 0x%x,reserved_0 0x%x",
478                            v->must_be_0, v->try_set_0, reserved_0);
479                 printk("must_be_1 0x%x, try_set_1 0x%x,reserved_1 0x%x",
480                            v->must_be_1, v->try_set_1, reserved_1);
481                 printk(" reserved_0 0x%x", reserved_0);
482                 printk(" changeable_bits 0x%x\n", changeable_bits);
483                 return false;
484         }
485
486         *result = v->must_be_1 | try1 | reserved_1;
487
488         printk("%s: check_vmxec_controls succeeds with result 0x%x\n",
489                    v->name, *result);
490         return true;
491 }
492
493 /*
494  * We're trying to make this as readable as possible. Realistically, it will
495  * rarely if ever change, if the past is any guide.
496  */
497 static const struct vmxec pbec = {
498         .name = "Pin Based Execution Controls",
499         .msr = MSR_IA32_VMX_PINBASED_CTLS,
500         .truemsr = MSR_IA32_VMX_TRUE_PINBASED_CTLS,
501
502         .must_be_1 = (PIN_BASED_EXT_INTR_MASK |
503                      PIN_BASED_NMI_EXITING |
504                      PIN_BASED_VIRTUAL_NMIS |
505                      PIN_BASED_POSTED_INTR),
506
507         .must_be_0 = (PIN_BASED_VMX_PREEMPTION_TIMER),
508 };
509
510 static const struct vmxec cbec = {
511         .name = "CPU Based Execution Controls",
512         .msr = MSR_IA32_VMX_PROCBASED_CTLS,
513         .truemsr = MSR_IA32_VMX_TRUE_PROCBASED_CTLS,
514
515         .must_be_1 = (//CPU_BASED_MWAIT_EXITING |
516                         CPU_BASED_HLT_EXITING |
517                      CPU_BASED_TPR_SHADOW |
518                      CPU_BASED_RDPMC_EXITING |
519                      CPU_BASED_CR8_LOAD_EXITING |
520                      CPU_BASED_CR8_STORE_EXITING |
521                      CPU_BASED_USE_MSR_BITMAPS |
522                      CPU_BASED_USE_IO_BITMAPS |
523                      CPU_BASED_ACTIVATE_SECONDARY_CONTROLS),
524
525         .must_be_0 = (
526                         CPU_BASED_MWAIT_EXITING |
527                         CPU_BASED_VIRTUAL_INTR_PENDING |
528                      CPU_BASED_INVLPG_EXITING |
529                      CPU_BASED_USE_TSC_OFFSETING |
530                      CPU_BASED_RDTSC_EXITING |
531                      CPU_BASED_CR3_LOAD_EXITING |
532                      CPU_BASED_CR3_STORE_EXITING |
533                      CPU_BASED_MOV_DR_EXITING |
534                      CPU_BASED_VIRTUAL_NMI_PENDING |
535                      CPU_BASED_MONITOR_TRAP |
536                      CPU_BASED_PAUSE_EXITING |
537                      CPU_BASED_UNCOND_IO_EXITING),
538
539         .try_set_0 = (CPU_BASED_MONITOR_EXITING)
540 };
541
542 static const struct vmxec cb2ec = {
543         .name = "CPU Based 2nd Execution Controls",
544         .msr = MSR_IA32_VMX_PROCBASED_CTLS2,
545         .truemsr = MSR_IA32_VMX_PROCBASED_CTLS2,
546
547         .must_be_1 = (SECONDARY_EXEC_ENABLE_EPT |
548                      SECONDARY_EXEC_VIRTUALIZE_APIC_ACCESSES |
549                      SECONDARY_EXEC_APIC_REGISTER_VIRT |
550                      SECONDARY_EXEC_VIRTUAL_INTR_DELIVERY |
551                      SECONDARY_EXEC_WBINVD_EXITING),
552
553         .must_be_0 = (
554                      //SECONDARY_EXEC_APIC_REGISTER_VIRT |
555                      //SECONDARY_EXEC_VIRTUAL_INTR_DELIVERY |
556                      SECONDARY_EXEC_DESCRIPTOR_EXITING |
557                      SECONDARY_EXEC_VIRTUALIZE_X2APIC_MODE |
558                      SECONDARY_EXEC_ENABLE_VPID |
559                      SECONDARY_EXEC_UNRESTRICTED_GUEST |
560                      SECONDARY_EXEC_PAUSE_LOOP_EXITING |
561                      SECONDARY_EXEC_RDRAND_EXITING |
562                      SECONDARY_EXEC_ENABLE_INVPCID |
563                      SECONDARY_EXEC_ENABLE_VMFUNC |
564                      SECONDARY_EXEC_SHADOW_VMCS |
565                      SECONDARY_EXEC_RDSEED_EXITING |
566                      SECONDARY_EPT_VE |
567                      SECONDARY_ENABLE_XSAV_RESTORE),
568
569         .try_set_1 = SECONDARY_EXEC_RDTSCP,
570
571         // mystery bit.
572         .try_set_0 = 0x2000000
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->order = LOG2_UP(nr_pages(vmcs_config.size));
680         vmcs_conf->revision_id = (uint32_t) vmx_msr;
681
682         /* Read in the caps for runtime checks.  This MSR is only available if
683          * secondary controls and ept or vpid is on, which we check earlier */
684         rdmsr(MSR_IA32_VMX_EPT_VPID_CAP, vmx_capability.ept, vmx_capability.vpid);
685
686         *ret = 0;
687 }
688
689 static struct vmcs *
690 __vmx_alloc_vmcs(int node)
691 {
692         struct vmcs *vmcs;
693
694         vmcs = get_cont_pages_node(node, vmcs_config.order, KMALLOC_WAIT);
695         if (!vmcs)
696                 return 0;
697         memset(vmcs, 0, vmcs_config.size);
698         vmcs->revision_id = vmcs_config.revision_id;    /* vmcs revision id */
699         printd("%d: set rev id %d\n", core_id(), vmcs->revision_id);
700         return vmcs;
701 }
702
703 /**
704  * vmx_alloc_vmcs - allocates a VMCS region
705  *
706  * NOTE: Assumes the new region will be used by the current CPU.
707  *
708  * Returns a valid VMCS region.
709  */
710 static struct vmcs *
711 vmx_alloc_vmcs(void)
712 {
713         return __vmx_alloc_vmcs(numa_id());
714 }
715
716 /**
717  * vmx_free_vmcs - frees a VMCS region
718  */
719 static void
720 vmx_free_vmcs(struct vmcs *vmcs)
721 {
722         //free_pages((unsigned long)vmcs, vmcs_config.order);
723 }
724
725 /*
726  * Set up the vmcs's constant host-state fields, i.e., host-state fields that
727  * will not change in the lifetime of the guest.
728  * Note that host-state that does change is set elsewhere. E.g., host-state
729  * that is set differently for each CPU is set in __vmx_setup_pcpu(), not here.
730  */
731 static void
732 vmx_setup_constant_host_state(void)
733 {
734         uint32_t low32, high32;
735         unsigned long tmpl;
736         pseudodesc_t dt;
737
738         vmcs_writel(HOST_CR0, rcr0() & ~X86_CR0_TS);    /* 22.2.3 */
739         vmcs_writel(HOST_CR4, rcr4());  /* 22.2.3, 22.2.5 */
740         vmcs_writel(HOST_CR3, rcr3());  /* 22.2.3 */
741
742         vmcs_write16(HOST_CS_SELECTOR, GD_KT);  /* 22.2.4 */
743         vmcs_write16(HOST_DS_SELECTOR, GD_KD);  /* 22.2.4 */
744         vmcs_write16(HOST_ES_SELECTOR, GD_KD);  /* 22.2.4 */
745         vmcs_write16(HOST_SS_SELECTOR, GD_KD);  /* 22.2.4 */
746         vmcs_write16(HOST_TR_SELECTOR, GD_TSS); /* 22.2.4 */
747
748         native_store_idt(&dt);
749         vmcs_writel(HOST_IDTR_BASE, dt.pd_base);        /* 22.2.4 */
750
751         extern void vmexit_handler(void);
752         vmcs_writel(HOST_RIP, (unsigned long)vmexit_handler);
753
754         rdmsr(MSR_IA32_SYSENTER_CS, low32, high32);
755         vmcs_write32(HOST_IA32_SYSENTER_CS, low32);
756         rdmsrl(MSR_IA32_SYSENTER_EIP, tmpl);
757         vmcs_writel(HOST_IA32_SYSENTER_EIP, tmpl);      /* 22.2.3 */
758
759         rdmsr(MSR_EFER, low32, high32);
760         vmcs_write32(HOST_IA32_EFER, low32);
761
762         if (vmcs_config.vmexit_ctrl & VM_EXIT_LOAD_IA32_PAT) {
763                 rdmsr(MSR_IA32_CR_PAT, low32, high32);
764                 vmcs_write64(HOST_IA32_PAT, low32 | ((uint64_t) high32 << 32));
765         }
766
767         vmcs_write16(HOST_FS_SELECTOR, 0);      /* 22.2.4 */
768         vmcs_write16(HOST_GS_SELECTOR, 0);      /* 22.2.4 */
769         vmcs_write(HOST_FS_BASE, 0);
770 }
771
772 /* Set up the per-core VMCS fields.  This is the host state that varies from
773  * core to core, which the hardware will switch for us on VM enters/exits. */
774 static void __vmx_setup_pcpu(struct guest_pcore *gpc)
775 {
776         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
777
778         vmcs_write(HOST_TR_BASE, (uintptr_t)pcpui->tss);
779         vmcs_writel(HOST_GDTR_BASE, (uintptr_t)pcpui->gdt);
780         vmcs_write(HOST_RSP, pcpui->stacktop);
781         vmcs_write(HOST_GS_BASE, (uintptr_t)pcpui);
782         /* TODO: this is MSR_KERNEL_GS_BASE, the 0'th autoload.  This array API is a
783          * little dangerous. */
784         gpc->msr_autoload.host[0].value = (uintptr_t)pcpui;
785         /* TODO: we might need to also set HOST_IA32_PERF_GLOBAL_CTRL.  Need to
786          * think about how perf will work with VMs */
787 }
788
789 uint64_t
790 construct_eptp(physaddr_t root_hpa)
791 {
792         uint64_t eptp;
793
794         /* set WB memory and 4 levels of walk.  we checked these in ept_init */
795         eptp = VMX_EPT_MEM_TYPE_WB | (VMX_EPT_GAW_4_LVL << VMX_EPT_GAW_EPTP_SHIFT);
796         if (cpu_has_vmx_ept_ad_bits())
797                 eptp |= VMX_EPT_AD_ENABLE_BIT;
798         eptp |= (root_hpa & PAGE_MASK);
799
800         return eptp;
801 }
802
803 /* Helper: some fields of the VMCS need a physical page address, e.g. the VAPIC
804  * page.  We have the user address.  This converts the user to phys addr and
805  * sets that up in the VMCS.  Returns 0 on success, -1 o/w. */
806 static int vmcs_set_pgaddr(struct proc *p, void *u_addr, unsigned long field)
807 {
808         uintptr_t kva;
809         physaddr_t paddr;
810
811         /* Enforce page alignment */
812         kva = uva2kva(p, ROUNDDOWN(u_addr, PGSIZE), PGSIZE, PROT_WRITE);
813         if (!kva) {
814                 set_error(EINVAL, "Unmapped pgaddr %p for VMCS", u_addr);
815                 return -1;
816         }
817         paddr = PADDR(kva);
818         /* TODO: need to pin the page.  A munmap would actually be okay (though
819          * probably we should kill the process), but we need to keep the page from
820          * being reused.  A refcnt would do the trick, which we decref when we
821          * destroy the guest core/vcpu. */
822         assert(!PGOFF(paddr));
823         vmcs_writel(field, paddr);
824         /* Pages are inserted twice.  Once, with the full paddr.  The next field is
825          * the upper 32 bits of the paddr. */
826         vmcs_writel(field + 1, paddr >> 32);
827         return 0;
828 }
829
830 /**
831  * vmx_setup_initial_guest_state - configures the initial state of guest
832  * registers and the VMCS.  Returns 0 on success, -1 o/w.
833  */
834 static int vmx_setup_initial_guest_state(struct proc *p,
835                                          struct vmm_gpcore_init *gpci)
836 {
837         unsigned long tmpl;
838         unsigned long cr4 = X86_CR4_PAE | X86_CR4_VMXE | X86_CR4_OSXMMEXCPT |
839                 X86_CR4_PGE | X86_CR4_OSFXSR;
840         uint32_t protected_mode = X86_CR0_PG | X86_CR0_PE;
841         int ret = 0;
842
843 #if 0
844         do
845                 we need it if (boot_cpu_has(X86_FEATURE_PCID))
846                         cr4 |= X86_CR4_PCIDE;
847         if (boot_cpu_has(X86_FEATURE_OSXSAVE))
848                 cr4 |= X86_CR4_OSXSAVE;
849 #endif
850         /* we almost certainly have this */
851         /* we'll go sour if we don't. */
852         if (1)  //boot_cpu_has(X86_FEATURE_FSGSBASE))
853                 cr4 |= X86_CR4_RDWRGSFS;
854
855         /* configure control and data registers */
856         vmcs_writel(GUEST_CR0, protected_mode | X86_CR0_WP |
857                                 X86_CR0_MP | X86_CR0_ET | X86_CR0_NE);
858         vmcs_writel(CR0_READ_SHADOW, protected_mode | X86_CR0_WP |
859                                 X86_CR0_MP | X86_CR0_ET | X86_CR0_NE);
860         vmcs_writel(GUEST_CR3, rcr3());
861         vmcs_writel(GUEST_CR4, cr4);
862         vmcs_writel(CR4_READ_SHADOW, cr4);
863         vmcs_writel(GUEST_IA32_EFER, EFER_LME | EFER_LMA |
864                                 EFER_SCE /*| EFER_FFXSR */ );
865         vmcs_writel(GUEST_GDTR_BASE, 0);
866         vmcs_writel(GUEST_GDTR_LIMIT, 0);
867         vmcs_writel(GUEST_IDTR_BASE, 0);
868         vmcs_writel(GUEST_IDTR_LIMIT, 0);
869         vmcs_writel(GUEST_RIP, 0xdeadbeef);
870         vmcs_writel(GUEST_RSP, 0xdeadbeef);
871         vmcs_writel(GUEST_RFLAGS, FL_RSVD_1);
872         vmcs_writel(GUEST_DR7, 0);
873
874         /* guest segment bases */
875         vmcs_writel(GUEST_CS_BASE, 0);
876         vmcs_writel(GUEST_DS_BASE, 0);
877         vmcs_writel(GUEST_ES_BASE, 0);
878         vmcs_writel(GUEST_GS_BASE, 0);
879         vmcs_writel(GUEST_SS_BASE, 0);
880         rdmsrl(MSR_FS_BASE, tmpl);
881         vmcs_writel(GUEST_FS_BASE, tmpl);
882
883         /* guest segment access rights */
884         vmcs_writel(GUEST_CS_AR_BYTES, 0xA09B);
885         vmcs_writel(GUEST_DS_AR_BYTES, 0xA093);
886         vmcs_writel(GUEST_ES_AR_BYTES, 0xA093);
887         vmcs_writel(GUEST_FS_AR_BYTES, 0xA093);
888         vmcs_writel(GUEST_GS_AR_BYTES, 0xA093);
889         vmcs_writel(GUEST_SS_AR_BYTES, 0xA093);
890
891         /* guest segment limits */
892         vmcs_write32(GUEST_CS_LIMIT, 0xFFFFFFFF);
893         vmcs_write32(GUEST_DS_LIMIT, 0xFFFFFFFF);
894         vmcs_write32(GUEST_ES_LIMIT, 0xFFFFFFFF);
895         vmcs_write32(GUEST_FS_LIMIT, 0xFFFFFFFF);
896         vmcs_write32(GUEST_GS_LIMIT, 0xFFFFFFFF);
897         vmcs_write32(GUEST_SS_LIMIT, 0xFFFFFFFF);
898
899         /* configure segment selectors */
900         vmcs_write16(GUEST_CS_SELECTOR, 0);
901         vmcs_write16(GUEST_DS_SELECTOR, 0);
902         vmcs_write16(GUEST_ES_SELECTOR, 0);
903         vmcs_write16(GUEST_FS_SELECTOR, 0);
904         vmcs_write16(GUEST_GS_SELECTOR, 0);
905         vmcs_write16(GUEST_SS_SELECTOR, 0);
906         vmcs_write16(GUEST_TR_SELECTOR, 0);
907
908         /* guest LDTR */
909         vmcs_write16(GUEST_LDTR_SELECTOR, 0);
910         vmcs_writel(GUEST_LDTR_AR_BYTES, 0x0082);
911         vmcs_writel(GUEST_LDTR_BASE, 0);
912         vmcs_writel(GUEST_LDTR_LIMIT, 0);
913
914         /* guest TSS */
915         vmcs_writel(GUEST_TR_BASE, 0);
916         vmcs_writel(GUEST_TR_AR_BYTES, 0x0080 | AR_TYPE_BUSY_64_TSS);
917         vmcs_writel(GUEST_TR_LIMIT, 0xff);
918
919         /* initialize sysenter */
920         vmcs_write32(GUEST_SYSENTER_CS, 0);
921         vmcs_writel(GUEST_SYSENTER_ESP, 0);
922         vmcs_writel(GUEST_SYSENTER_EIP, 0);
923
924         /* other random initialization */
925         vmcs_write32(GUEST_ACTIVITY_STATE, GUEST_ACTIVITY_ACTIVE);
926         vmcs_write32(GUEST_INTERRUPTIBILITY_INFO, 0);
927         vmcs_write32(GUEST_PENDING_DBG_EXCEPTIONS, 0);
928         vmcs_write64(GUEST_IA32_DEBUGCTL, 0);
929         vmcs_write32(VM_ENTRY_INTR_INFO_FIELD, 0);      /* 22.2.1 */
930
931         /* Initialize posted interrupt notification vector */
932         vmcs_write16(POSTED_NOTIFICATION_VEC, I_POKE_CORE);
933
934         /* Clear the EOI exit bitmap */
935         vmcs_writel(EOI_EXIT_BITMAP0, 0);
936         vmcs_writel(EOI_EXIT_BITMAP0_HIGH, 0);
937         vmcs_writel(EOI_EXIT_BITMAP1, 0);
938         vmcs_writel(EOI_EXIT_BITMAP1_HIGH, 0);
939         vmcs_writel(EOI_EXIT_BITMAP2, 0);
940         vmcs_writel(EOI_EXIT_BITMAP2_HIGH, 0);
941         vmcs_writel(EOI_EXIT_BITMAP3, 0);
942         vmcs_writel(EOI_EXIT_BITMAP3_HIGH, 0);
943
944         /* Initialize parts based on the users info.  If one of them fails, we'll do
945          * the others but then error out. */
946         ret |= vmcs_set_pgaddr(p, gpci->posted_irq_desc, POSTED_INTR_DESC_ADDR);
947         ret |= vmcs_set_pgaddr(p, gpci->vapic_addr, VIRTUAL_APIC_PAGE_ADDR);
948         ret |= vmcs_set_pgaddr(p, gpci->apic_addr, APIC_ACCESS_ADDR);
949
950         return ret;
951 }
952
953 static void __vmx_disable_intercept_for_msr(unsigned long *msr_bitmap,
954                                             uint32_t msr) {
955         int f = sizeof(unsigned long);
956         /*
957          * See Intel PRM Vol. 3, 20.6.9 (MSR-Bitmap Address). Early manuals
958          * have the write-low and read-high bitmap offsets the wrong way round.
959          * We can control MSRs 0x00000000-0x00001fff and 0xc0000000-0xc0001fff.
960          */
961         if (msr <= 0x1fff) {
962                 __clear_bit(msr, msr_bitmap + 0x000 / f);       /* read-low */
963                 __clear_bit(msr, msr_bitmap + 0x800 / f);       /* write-low */
964         } else if ((msr >= 0xc0000000) && (msr <= 0xc0001fff)) {
965                 msr &= 0x1fff;
966                 __clear_bit(msr, msr_bitmap + 0x400 / f);       /* read-high */
967                 __clear_bit(msr, msr_bitmap + 0xc00 / f);       /* write-high */
968         }
969 }
970
971 /* note the io_bitmap is big enough for the 64K port space. */
972 static void __vmx_disable_intercept_for_io(unsigned long *io_bitmap,
973                                            uint16_t port) {
974         __clear_bit(port, io_bitmap);
975 }
976
977 static void gpc_print_autoloads(struct guest_pcore *gpc)
978 {
979         struct vmx_msr_entry *e;
980         int sz = sizeof(autoloaded_msrs) / sizeof(*autoloaded_msrs);
981         printk("Host Autoloads:\n-------------------\n");
982         for (int i = 0; i < sz; i++) {
983                 e = &gpc->msr_autoload.host[i];
984                 printk("\tMSR 0x%08x: %p\n", e->index, e->value);
985         }
986         printk("Guest Autoloads:\n-------------------\n");
987         for (int i = 0; i < sz; i++) {
988                 e = &gpc->msr_autoload.guest[i];
989                 printk("\tMSR 0x%08x %p\n", e->index, e->value);
990         }
991 }
992
993 static void dumpmsrs(void) {
994         int i;
995         int set[] = {
996                 MSR_LSTAR,
997                 MSR_FS_BASE,
998                 MSR_GS_BASE,
999                 MSR_KERNEL_GS_BASE,
1000                 MSR_SFMASK,
1001                 MSR_IA32_PEBS_ENABLE
1002         };
1003         for (i = 0; i < ARRAY_SIZE(set); i++) {
1004                 printk("%p: %p\n", set[i], read_msr(set[i]));
1005         }
1006         printk("core id %d\n", core_id());
1007 }
1008
1009 /* Notes on autoloading.  We can't autoload FS_BASE or GS_BASE, according to the
1010  * manual, but that's because they are automatically saved and restored when all
1011  * of the other architectural registers are saved and restored, such as cs, ds,
1012  * es, and other fun things. (See 24.4.1).  We need to make sure we don't
1013  * accidentally intercept them too, since they are magically autloaded..
1014  *
1015  * We'll need to be careful of any MSR we neither autoload nor intercept
1016  * whenever we vmenter/vmexit, and we intercept by default.
1017  *
1018  * Other MSRs, such as MSR_IA32_PEBS_ENABLE only work on certain architectures
1019  * only work on certain architectures. */
1020 static void setup_msr(struct guest_pcore *gpc)
1021 {
1022         struct vmx_msr_entry *e;
1023         int sz = sizeof(autoloaded_msrs) / sizeof(*autoloaded_msrs);
1024         int i;
1025
1026         static_assert((sizeof(autoloaded_msrs) / sizeof(*autoloaded_msrs)) <=
1027                       NR_AUTOLOAD_MSRS);
1028
1029         gpc->msr_autoload.nr = sz;
1030
1031         /* Since PADDR(msr_bitmap) is non-zero, and the bitmap is all 0xff, we now
1032          * intercept all MSRs */
1033         vmcs_write64(MSR_BITMAP, PADDR(msr_bitmap));
1034
1035         vmcs_write64(IO_BITMAP_A, PADDR(io_bitmap));
1036         vmcs_write64(IO_BITMAP_B, PADDR((uintptr_t)io_bitmap +
1037                                         (VMX_IO_BITMAP_SZ / 2)));
1038
1039         vmcs_write32(VM_EXIT_MSR_STORE_COUNT, gpc->msr_autoload.nr);
1040         vmcs_write32(VM_EXIT_MSR_LOAD_COUNT, gpc->msr_autoload.nr);
1041         vmcs_write32(VM_ENTRY_MSR_LOAD_COUNT, gpc->msr_autoload.nr);
1042
1043         vmcs_write64(VM_EXIT_MSR_LOAD_ADDR, PADDR(gpc->msr_autoload.host));
1044         vmcs_write64(VM_EXIT_MSR_STORE_ADDR, PADDR(gpc->msr_autoload.guest));
1045         vmcs_write64(VM_ENTRY_MSR_LOAD_ADDR, PADDR(gpc->msr_autoload.guest));
1046
1047         for (i = 0; i < sz; i++) {
1048                 uint64_t val;
1049
1050                 e = &gpc->msr_autoload.host[i];
1051                 e->index = autoloaded_msrs[i];
1052                 __vmx_disable_intercept_for_msr(msr_bitmap, e->index);
1053                 rdmsrl(e->index, val);
1054                 e->value = val;
1055                 printk("host index %p val %p\n", e->index, e->value);
1056
1057                 e = &gpc->msr_autoload.guest[i];
1058                 e->index = autoloaded_msrs[i];
1059                 e->value = 0xDEADBEEF;
1060                 printk("guest index %p val %p\n", e->index, e->value);
1061         }
1062 }
1063
1064 /**
1065  *  vmx_setup_vmcs - configures the vmcs with starting parameters
1066  */
1067 static void vmx_setup_vmcs(struct guest_pcore *gpc)
1068 {
1069         vmcs_write16(VIRTUAL_PROCESSOR_ID, 0);
1070         vmcs_write64(VMCS_LINK_POINTER, -1ull); /* 22.3.1.5 */
1071
1072         /* Control */
1073         vmcs_write32(PIN_BASED_VM_EXEC_CONTROL,
1074                      vmcs_config.pin_based_exec_ctrl);
1075
1076         vmcs_write32(CPU_BASED_VM_EXEC_CONTROL,
1077                      vmcs_config.cpu_based_exec_ctrl);
1078
1079         if (cpu_has_secondary_exec_ctrls()) {
1080                 vmcs_write32(SECONDARY_VM_EXEC_CONTROL,
1081                              vmcs_config.cpu_based_2nd_exec_ctrl);
1082         }
1083
1084         vmcs_write64(EPT_POINTER, gpc_get_eptp(gpc));
1085
1086         vmcs_write32(PAGE_FAULT_ERROR_CODE_MASK, 0);
1087         vmcs_write32(PAGE_FAULT_ERROR_CODE_MATCH, 0);
1088         vmcs_write32(CR3_TARGET_COUNT, 0);      /* 22.2.1 */
1089
1090         setup_msr(gpc);
1091
1092         vmcs_config.vmentry_ctrl |= VM_ENTRY_IA32E_MODE;
1093
1094         vmcs_write32(VM_EXIT_CONTROLS, vmcs_config.vmexit_ctrl);
1095         vmcs_write32(VM_ENTRY_CONTROLS, vmcs_config.vmentry_ctrl);
1096
1097         vmcs_writel(CR0_GUEST_HOST_MASK, 0);    // ~0ul);
1098         vmcs_writel(CR4_GUEST_HOST_MASK, 0);    // ~0ul);
1099
1100         //kvm_write_tsc(&vmx->gpc, 0);
1101         vmcs_writel(TSC_OFFSET, 0);
1102
1103         vmx_setup_constant_host_state();
1104 }
1105
1106 /**
1107  * create_guest_pcore - allocates and initializes a guest physical core
1108  *
1109  * Returns: A new VCPU structure
1110  */
1111 struct guest_pcore *create_guest_pcore(struct proc *p,
1112                                        struct vmm_gpcore_init *gpci)
1113 {
1114         struct guest_pcore *gpc = kmalloc(sizeof(struct guest_pcore), KMALLOC_WAIT);
1115         int ret;
1116
1117         if (!gpc)
1118                 return NULL;
1119
1120         memset(gpc, 0, sizeof(*gpc));
1121
1122         gpc->proc = p;  /* uncounted (weak) reference */
1123         gpc->vmcs = vmx_alloc_vmcs();
1124         printd("%d: gpc->vmcs is %p\n", core_id(), gpc->vmcs);
1125         if (!gpc->vmcs)
1126                 goto fail_vmcs;
1127
1128         gpc->cpu = -1;
1129
1130         vmx_load_guest_pcore(gpc);
1131         vmx_setup_vmcs(gpc);
1132         ret = vmx_setup_initial_guest_state(p, gpci);
1133         vmx_unload_guest_pcore(gpc);
1134         gpc->xcr0 = x86_default_xcr0;
1135
1136         gpc->posted_irq_desc = gpci->posted_irq_desc;
1137
1138         if (!ret)
1139                 return gpc;
1140
1141 fail_vmcs:
1142         kfree(gpc);
1143         return NULL;
1144 }
1145
1146 /**
1147  * destroy_guest_pcore - destroys and frees an existing guest physical core
1148  * @gpc: the GPC to destroy
1149  */
1150 void destroy_guest_pcore(struct guest_pcore *gpc)
1151 {
1152         vmx_free_vmcs(gpc->vmcs);
1153         kfree(gpc);
1154 }
1155
1156 static void vmx_step_instruction(void) {
1157         vmcs_writel(GUEST_RIP, vmcs_readl(GUEST_RIP) +
1158                     vmcs_read32(VM_EXIT_INSTRUCTION_LEN));
1159 }
1160
1161 /**
1162  * __vmx_enable - low-level enable of VMX mode on the current CPU
1163  * @vmxon_buf: an opaque buffer for use as the VMXON region
1164  */
1165 static int __vmx_enable(struct vmcs *vmxon_buf) {
1166         uint64_t phys_addr = PADDR(vmxon_buf);
1167         uint64_t old, test_bits;
1168
1169         if (rcr4() & X86_CR4_VMXE) {
1170                 panic("Should never have this happen");
1171                 return -EBUSY;
1172         }
1173
1174         rdmsrl(MSR_IA32_FEATURE_CONTROL, old);
1175
1176         test_bits = FEATURE_CONTROL_LOCKED;
1177         test_bits |= FEATURE_CONTROL_VMXON_ENABLED_OUTSIDE_SMX;
1178
1179         if (0)  // tboot_enabled())
1180                 test_bits |= FEATURE_CONTROL_VMXON_ENABLED_INSIDE_SMX;
1181
1182         if ((old & test_bits) != test_bits) {
1183                 /* If it's locked, then trying to set it will cause a GPF.
1184                  * No Dune for you!
1185                  */
1186                 if (old & FEATURE_CONTROL_LOCKED) {
1187                         printk("Dune: MSR_IA32_FEATURE_CONTROL is locked!\n");
1188                         return -1;
1189                 }
1190
1191                 /* enable and lock */
1192                 write_msr(MSR_IA32_FEATURE_CONTROL, old | test_bits);
1193         }
1194         lcr4(rcr4() | X86_CR4_VMXE);
1195
1196         __vmxon(phys_addr);
1197         vpid_sync_gpc_global(); /* good idea, even if we aren't using vpids */
1198         ept_sync_global();
1199
1200         return 0;
1201 }
1202
1203 /**
1204  * vmx_disable - disables VMX mode on the current CPU
1205  */
1206 static void vmx_disable(void *unused) {
1207         if (currentcpu->vmx_enabled) {
1208                 __vmxoff();
1209                 lcr4(rcr4() & ~X86_CR4_VMXE);
1210                 currentcpu->vmx_enabled = 0;
1211         }
1212 }
1213
1214 /* Probe the cpus to see which ones can do vmx.
1215  * Return -errno if it fails, and 1 if it succeeds.
1216  */
1217 static bool probe_cpu_vmx(void) {
1218         /* The best way to test this code is:
1219          * wrmsr -p <cpu> 0x3a 1
1220          * This will lock vmx off; then modprobe dune.
1221          * Frequently, however, systems have all 0x3a registers set to 5,
1222          * meaning testing is impossible, as vmx can not be disabled.
1223          * We have to simulate it being unavailable in most cases.
1224          * The 'test' variable provides an easy way to simulate
1225          * unavailability of vmx on some, none, or all cpus.
1226          */
1227         if (!cpu_has_vmx()) {
1228                 printk("Machine does not support VT-x\n");
1229                 return FALSE;
1230         } else {
1231                 printk("Machine supports VT-x\n");
1232                 return TRUE;
1233         }
1234 }
1235
1236 static int ept_init(void) {
1237         if (!cpu_has_vmx_ept()) {
1238                 printk("VMX doesn't support EPT!\n");
1239                 return -1;
1240         }
1241         if (!cpu_has_vmx_eptp_writeback()) {
1242                 printk("VMX EPT doesn't support WB memory!\n");
1243                 return -1;
1244         }
1245         if (!cpu_has_vmx_ept_4levels()) {
1246                 printk("VMX EPT doesn't support 4 level walks!\n");
1247                 return -1;
1248         }
1249         switch (arch_max_jumbo_page_shift()) {
1250         case PML3_SHIFT:
1251                 if (!cpu_has_vmx_ept_1g_page()) {
1252                         printk("VMX EPT doesn't support 1 GB pages!\n");
1253                         return -1;
1254                 }
1255                 break;
1256         case PML2_SHIFT:
1257                 if (!cpu_has_vmx_ept_2m_page()) {
1258                         printk("VMX EPT doesn't support 2 MB pages!\n");
1259                         return -1;
1260                 }
1261                 break;
1262         default:
1263                 printk("Unexpected jumbo page size %d\n",
1264                        arch_max_jumbo_page_shift());
1265                 return -1;
1266         }
1267         if (!cpu_has_vmx_ept_ad_bits()) {
1268                 printk("VMX EPT doesn't support accessed/dirty!\n");
1269                 x86_ept_pte_fix_ups |= EPTE_A | EPTE_D;
1270         }
1271         if (!cpu_has_vmx_invept() || !cpu_has_vmx_invept_global()) {
1272                 printk("VMX EPT can't invalidate PTEs/TLBs!\n");
1273                 return -1;
1274         }
1275
1276         return 0;
1277 }
1278
1279 /**
1280  * vmx_init sets up physical core data areas that are required to run a vm at all.
1281  * These data areas are not connected to a specific user process in any way. Instead,
1282  * they are in some sense externalizing what would other wise be a very large ball of
1283  * state that would be inside the CPU.
1284  */
1285 int intel_vmm_init(void) {
1286         int r, cpu, ret;
1287
1288         if (!probe_cpu_vmx()) {
1289                 return -EOPNOTSUPP;
1290         }
1291
1292         setup_vmcs_config(&ret);
1293
1294         if (ret) {
1295                 printk("setup_vmcs_config failed: %d\n", ret);
1296                 return ret;
1297         }
1298
1299         msr_bitmap = (unsigned long *)kpage_zalloc_addr();
1300         if (!msr_bitmap) {
1301                 printk("Could not allocate msr_bitmap\n");
1302                 return -ENOMEM;
1303         }
1304         io_bitmap = (unsigned long *)get_cont_pages(VMX_IO_BITMAP_ORDER,
1305                                                     KMALLOC_WAIT);
1306         if (!io_bitmap) {
1307                 printk("Could not allocate msr_bitmap\n");
1308                 kfree(msr_bitmap);
1309                 return -ENOMEM;
1310         }
1311         /* FIXME: do we need APIC virtualization (flexpriority?) */
1312
1313         memset(msr_bitmap, 0xff, PAGE_SIZE);
1314         memset(io_bitmap, 0xff, VMX_IO_BITMAP_SZ);
1315
1316         /* These are the only MSRs that are not autoloaded and not intercepted */
1317         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_FS_BASE);
1318         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_GS_BASE);
1319         __vmx_disable_intercept_for_msr(msr_bitmap, MSR_EFER);
1320
1321         /* TODO: this might be dangerous, since they can do more than just read the
1322          * CMOS */
1323         __vmx_disable_intercept_for_io(io_bitmap, CMOS_RAM_IDX);
1324         __vmx_disable_intercept_for_io(io_bitmap, CMOS_RAM_DATA);
1325
1326         if ((ret = ept_init())) {
1327                 printk("EPT init failed, %d\n", ret);
1328                 return ret;
1329         }
1330         printk("VMX setup succeeded\n");
1331         return 0;
1332 }
1333
1334 int intel_vmm_pcpu_init(void)
1335 {
1336         struct vmcs *vmxon_buf;
1337         int ret;
1338
1339         vmxon_buf = __vmx_alloc_vmcs(core_id());
1340         if (!vmxon_buf) {
1341                 printk("setup_vmxarea failed on node %d\n", core_id());
1342                 return -1;
1343         }
1344
1345         ret = __vmx_enable(vmxon_buf);
1346         if (ret)
1347                 goto failed;
1348         currentcpu->vmx_enabled = 1;
1349         printk("VMX enabled on CPU %d\n", core_id());
1350         return 0;
1351 failed:
1352         printk("Failed to enable VMX on core %d, err = %d\n", core_id(), ret);
1353         return ret;
1354 }
1355
1356
1357 void vapic_status_dump_kernel(void *vapic)
1358 {
1359         uint32_t *p = (uint32_t *)vapic;
1360         int i;
1361         printk("-- BEGIN KERNEL APIC STATUS DUMP --\n");
1362         for (i = 0x100/sizeof(*p); i < 0x180/sizeof(*p); i+=4) {
1363                 printk("VISR : 0x%x: 0x%08x\n", i, p[i]);
1364         }
1365         for (i = 0x200/sizeof(*p); i < 0x280/sizeof(*p); i+=4) {
1366                 printk("VIRR : 0x%x: 0x%08x\n", i, p[i]);
1367         }
1368         i = 0x0B0/sizeof(*p);
1369         printk("EOI FIELD : 0x%x, 0x%08x\n", i, p[i]);
1370
1371         printk("-- END KERNEL APIC STATUS DUMP --\n");
1372 }
1373
1374 void vmx_load_guest_pcore(struct guest_pcore *gpc)
1375 {
1376         vmcs_load(gpc->vmcs);
1377         __vmx_setup_pcpu(gpc);
1378 }
1379
1380 void vmx_unload_guest_pcore(struct guest_pcore *gpc)
1381 {
1382         vmcs_clear(gpc->vmcs);
1383 }