f8a8294ee5d94f96fff53fd069da855013dfb60d
[akaros.git] / kern / arch / x86 / vmm / vmm.c
1 /* Copyright 2015 Google Inc.
2  *
3  * See LICENSE for details.
4  */
5
6 /* We're not going to falll into the trap of only compiling support
7  * for AMD OR Intel for an image. It all gets compiled in, and which
8  * one you use depends on on cpuinfo, not a compile-time
9  * switch. That's proven to be the best strategy.  Conditionally
10  * compiling in support is the path to hell.
11  */
12 #include <assert.h>
13 #include <pmap.h>
14 #include <smp.h>
15 #include <kmalloc.h>
16
17 #include <ros/vmm.h>
18 #include "intel/vmx.h"
19 #include "vmm.h"
20 #include <trap.h>
21 #include <umem.h>
22
23 #include <arch/x86.h>
24 #include <ros/procinfo.h>
25
26
27 /* TODO: have better cpuid info storage and checks */
28 bool x86_supports_vmx = FALSE;
29
30 /* Figure out what kind of CPU we are on, and if it supports any reasonable
31  * virtualization. For now, if we're not some sort of newer intel, don't
32  * bother. This does all cores. Again, note, we make these decisions at runtime,
33  * to avoid getting into the problems that compile-time decisions can cause.
34  * At this point, of course, it's still all intel.
35  */
36 void vmm_init(void)
37 {
38         int ret;
39         /* Check first for intel capabilities. This is hence two back-to-back
40          * implementationd-dependent checks. That's ok, it's all msr dependent.
41          */
42         ret = intel_vmm_init();
43         if (! ret) {
44                 x86_supports_vmx = TRUE;
45                 return;
46         }
47
48         /* TODO: AMD. Will we ever care? It's not clear. */
49         printk("vmm_init failed, ret %d\n", ret);
50         return;
51 }
52
53 void vmm_pcpu_init(void)
54 {
55         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
56
57         pcpui->guest_pcoreid = -1;
58         if (!x86_supports_vmx)
59                 return;
60         if (! intel_vmm_pcpu_init()) {
61                 printd("vmm_pcpu_init worked\n");
62                 return;
63         }
64         /* TODO: AMD. Will we ever care? It's not clear. */
65         printk("vmm_pcpu_init failed\n");
66 }
67
68 /* Initializes a process to run virtual machine contexts, returning the number
69  * initialized, throwing on error. */
70 int vmm_struct_init(struct proc *p, unsigned int nr_guest_pcores,
71                     struct vmm_gpcore_init *u_gpcis, int flags)
72 {
73         ERRSTACK(1);
74         struct vmm *vmm = &p->vmm;
75         struct vmm_gpcore_init gpci;
76
77         if (flags & ~VMM_ALL_FLAGS)
78                 error(EINVAL, "%s: flags is 0x%lx, VMM_ALL_FLAGS is 0x%lx\n", __func__,
79                       flags, VMM_ALL_FLAGS);
80         vmm->flags = flags;
81         if (!x86_supports_vmx)
82                 error(ENODEV, "This CPU does not support VMX");
83         qlock(&vmm->qlock);
84         if (waserror()) {
85                 qunlock(&vmm->qlock);
86                 nexterror();
87         }
88
89         /* TODO: just use an atomic test instead of all this locking stuff? */
90         if (vmm->vmmcp)
91                 error(EAGAIN, "We're already running a vmmcp?");
92         /* Set this early, so cleanup checks the gpc array */
93         vmm->vmmcp = TRUE;
94         nr_guest_pcores = MIN(nr_guest_pcores, num_cores);
95         vmm->amd = 0;
96         vmm->guest_pcores = kzmalloc(sizeof(void *) * nr_guest_pcores, MEM_WAIT);
97         if (!vmm->guest_pcores)
98                 error(ENOMEM, "Allocation of vmm->guest_pcores failed");
99
100         for (int i = 0; i < nr_guest_pcores; i++) {
101                 if (copy_from_user(&gpci, &u_gpcis[i], sizeof(struct vmm_gpcore_init)))
102                         error(EINVAL, "Bad pointer %p for gps", u_gpcis);
103                 vmm->guest_pcores[i] = create_guest_pcore(p, &gpci);
104                 vmm->nr_guest_pcores = i + 1;
105         }
106         for (int i = 0; i < VMM_VMEXIT_NR_TYPES; i++)
107                 vmm->vmexits[i] = 0;
108         qunlock(&vmm->qlock);
109         poperror();
110         return vmm->nr_guest_pcores;
111 }
112
113 /* Has no concurrency protection - only call this when you know you have the
114  * only ref to vmm.  For instance, from __proc_free, where there is only one ref
115  * to the proc (and thus proc.vmm). */
116 void __vmm_struct_cleanup(struct proc *p)
117 {
118         struct vmm *vmm = &p->vmm;
119         if (!vmm->vmmcp)
120                 return;
121         for (int i = 0; i < vmm->nr_guest_pcores; i++) {
122                 if (vmm->guest_pcores[i])
123                         destroy_guest_pcore(vmm->guest_pcores[i]);
124         }
125         kfree(vmm->guest_pcores);
126         ept_flush(p->env_pgdir.eptp);
127         vmm->vmmcp = FALSE;
128 }
129
130 int vmm_poke_guest(struct proc *p, int guest_pcoreid)
131 {
132         struct guest_pcore *gpc;
133         int pcoreid;
134
135         gpc = lookup_guest_pcore(p, guest_pcoreid);
136         if (!gpc) {
137                 set_error(ENOENT, "Bad guest_pcoreid %d", guest_pcoreid);
138                 return -1;
139         }
140         /* We're doing an unlocked peek; it could change immediately.  This is a
141          * best effort service. */
142         pcoreid = ACCESS_ONCE(gpc->cpu);
143         if (pcoreid == -1) {
144                 /* So we know that we'll miss the poke for the posted IRQ.  We could
145                  * return an error.  However, error handling for this case isn't
146                  * particularly helpful (yet).  The absence of the error does not mean
147                  * the IRQ was posted.  We'll still return 0, meaning "the user didn't
148                  * mess up; we tried." */
149                 return 0;
150         }
151         send_ipi(pcoreid, I_POKE_CORE);
152         return 0;
153 }
154
155 struct guest_pcore *lookup_guest_pcore(struct proc *p, int guest_pcoreid)
156 {
157         /* nr_guest_pcores is written once at setup and never changed */
158         if (guest_pcoreid >= p->vmm.nr_guest_pcores)
159                 return 0;
160         return p->vmm.guest_pcores[guest_pcoreid];
161 }
162
163 struct guest_pcore *load_guest_pcore(struct proc *p, int guest_pcoreid)
164 {
165         struct guest_pcore *gpc;
166         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
167
168         gpc = lookup_guest_pcore(p, guest_pcoreid);
169         if (!gpc)
170                 return 0;
171         assert(pcpui->guest_pcoreid == -1);
172         spin_lock(&p->vmm.lock);
173         if (gpc->cpu != -1) {
174                 spin_unlock(&p->vmm.lock);
175                 return 0;
176         }
177         gpc->cpu = core_id();
178         spin_unlock(&p->vmm.lock);
179         /* We've got dibs on the gpc; we don't need to hold the lock any longer. */
180         pcpui->guest_pcoreid = guest_pcoreid;
181         ept_sync_context(gpc_get_eptp(gpc));
182         vmx_load_guest_pcore(gpc);
183         /* Load guest's xcr0 */
184         lxcr0(gpc->xcr0);
185         return gpc;
186 }
187
188 void unload_guest_pcore(struct proc *p, int guest_pcoreid)
189 {
190         struct guest_pcore *gpc;
191         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
192
193         gpc = lookup_guest_pcore(p, guest_pcoreid);
194         assert(gpc);
195         spin_lock(&p->vmm.lock);
196         assert(gpc->cpu != -1);
197         ept_sync_context(gpc_get_eptp(gpc));
198         vmx_unload_guest_pcore(gpc);
199         gpc->cpu = -1;
200
201         /* Save guest's xcr0 and restore Akaros's default. */
202         gpc->xcr0 = rxcr0();
203         lxcr0(__proc_global_info.x86_default_xcr0);
204
205         /* As soon as we unlock, this gpc can be started on another core */
206         spin_unlock(&p->vmm.lock);
207         pcpui->guest_pcoreid = -1;
208 }
209
210 /* emulated msr. For now, an msr value and a pointer to a helper that
211  * performs the requested operation.
212  */
213 struct emmsr {
214         uint32_t reg;
215         char *name;
216         bool (*f)(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
217                   uint64_t *rax, uint32_t opcode);
218         bool written;
219         uint32_t edx, eax;
220 };
221
222 static bool emsr_miscenable(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
223                             uint64_t *rax, uint32_t opcode);
224 static bool emsr_mustmatch(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
225                            uint64_t *rax, uint32_t opcode);
226 static bool emsr_readonly(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
227                           uint64_t *rax, uint32_t opcode);
228 static bool emsr_readzero(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
229                           uint64_t *rax, uint32_t opcode);
230 static bool emsr_fakewrite(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
231                            uint64_t *rax, uint32_t opcode);
232 static bool emsr_ok(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
233                     uint64_t *rax, uint32_t opcode);
234 static bool emsr_fake_apicbase(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
235                                uint64_t *rax, uint32_t opcode);
236
237 struct emmsr emmsrs[] = {
238         {MSR_IA32_MISC_ENABLE, "MSR_IA32_MISC_ENABLE", emsr_miscenable},
239         {MSR_IA32_SYSENTER_CS, "MSR_IA32_SYSENTER_CS", emsr_ok},
240         {MSR_IA32_SYSENTER_EIP, "MSR_IA32_SYSENTER_EIP", emsr_ok},
241         {MSR_IA32_SYSENTER_ESP, "MSR_IA32_SYSENTER_ESP", emsr_ok},
242         {MSR_IA32_UCODE_REV, "MSR_IA32_UCODE_REV", emsr_fakewrite},
243         {MSR_CSTAR, "MSR_CSTAR", emsr_fakewrite},
244         {MSR_IA32_VMX_BASIC_MSR, "MSR_IA32_VMX_BASIC_MSR", emsr_fakewrite},
245         {MSR_IA32_VMX_PINBASED_CTLS_MSR, "MSR_IA32_VMX_PINBASED_CTLS_MSR",
246          emsr_fakewrite},
247         {MSR_IA32_VMX_PROCBASED_CTLS_MSR, "MSR_IA32_VMX_PROCBASED_CTLS_MSR",
248          emsr_fakewrite},
249         {MSR_IA32_VMX_PROCBASED_CTLS2, "MSR_IA32_VMX_PROCBASED_CTLS2",
250          emsr_fakewrite},
251         {MSR_IA32_VMX_EXIT_CTLS_MSR, "MSR_IA32_VMX_EXIT_CTLS_MSR",
252          emsr_fakewrite},
253         {MSR_IA32_VMX_ENTRY_CTLS_MSR, "MSR_IA32_VMX_ENTRY_CTLS_MSR",
254          emsr_fakewrite},
255         {MSR_IA32_ENERGY_PERF_BIAS, "MSR_IA32_ENERGY_PERF_BIAS",
256          emsr_fakewrite},
257         {MSR_LBR_SELECT, "MSR_LBR_SELECT", emsr_ok},
258         {MSR_LBR_TOS, "MSR_LBR_TOS", emsr_ok},
259         {MSR_LBR_NHM_FROM, "MSR_LBR_NHM_FROM", emsr_ok},
260         {MSR_LBR_NHM_TO, "MSR_LBR_NHM_TO", emsr_ok},
261         {MSR_LBR_CORE_FROM, "MSR_LBR_CORE_FROM", emsr_ok},
262         {MSR_LBR_CORE_TO, "MSR_LBR_CORE_TO", emsr_ok},
263
264         // grumble.
265         {MSR_OFFCORE_RSP_0, "MSR_OFFCORE_RSP_0", emsr_ok},
266         {MSR_OFFCORE_RSP_1, "MSR_OFFCORE_RSP_1", emsr_ok},
267         // louder.
268         {MSR_PEBS_LD_LAT_THRESHOLD, "MSR_PEBS_LD_LAT_THRESHOLD", emsr_ok},
269         // aaaaaahhhhhhhhhhhhhhhhhhhhh
270         {MSR_ARCH_PERFMON_EVENTSEL0, "MSR_ARCH_PERFMON_EVENTSEL0", emsr_ok},
271         {MSR_ARCH_PERFMON_EVENTSEL1, "MSR_ARCH_PERFMON_EVENTSEL1", emsr_ok},
272         {MSR_IA32_PERF_CAPABILITIES, "MSR_IA32_PERF_CAPABILITIES", emsr_readzero},
273         // unsafe.
274         {MSR_IA32_APICBASE, "MSR_IA32_APICBASE", emsr_fake_apicbase},
275
276         // mostly harmless.
277         {MSR_TSC_AUX, "MSR_TSC_AUX", emsr_fakewrite},
278         {MSR_RAPL_POWER_UNIT, "MSR_RAPL_POWER_UNIT", emsr_readzero},
279         {MSR_IA32_MCG_CAP, "MSR_IA32_MCG_CAP", emsr_readzero},
280         {MSR_IA32_DEBUGCTLMSR, "MSR_IA32_DEBUGCTLMSR", emsr_fakewrite},
281
282         // TBD
283         {MSR_IA32_TSC_DEADLINE, "MSR_IA32_TSC_DEADLINE", emsr_fakewrite},
284 };
285
286 /* this may be the only register that needs special handling.
287  * If there others then we might want to extend the emmsr struct.
288  */
289 bool emsr_miscenable(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
290                      uint64_t *rax, uint32_t opcode)
291 {
292         uint32_t eax, edx;
293         uint64_t val;
294
295         if (read_msr_safe(msr->reg, &val))
296                 return FALSE;
297         split_msr_val(val, &edx, &eax);
298         /* we just let them read the misc msr for now. */
299         if (opcode == VMM_MSR_EMU_READ) {
300                 *rax = eax;
301                 *rax |= MSR_IA32_MISC_ENABLE_PEBS_UNAVAIL;
302                 *rdx = edx;
303                 return TRUE;
304         } else {
305                 /* if they are writing what is already written, that's ok. */
306                 eax |= MSR_IA32_MISC_ENABLE_PEBS_UNAVAIL;
307                 if (((uint32_t) *rax == eax) && ((uint32_t) *rdx == edx))
308                         return TRUE;
309         }
310         printk
311                 ("%s: Wanted to write 0x%x:0x%x, but could not; value was 0x%x:0x%x\n",
312                  msr->name, (uint32_t) *rdx, (uint32_t) *rax, edx, eax);
313         return FALSE;
314 }
315
316 /* TODO: this looks like a copy-paste for the read side.  What's the purpose of
317  * mustmatch?  No one even uses it. */
318 bool emsr_mustmatch(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
319                     uint64_t *rax, uint32_t opcode)
320 {
321         uint32_t eax, edx;
322         uint64_t val;
323
324         if (read_msr_safe(msr->reg, &val))
325                 return FALSE;
326         split_msr_val(val, &edx, &eax);
327         /* we just let them read the misc msr for now. */
328         if (opcode == VMM_MSR_EMU_READ) {
329                 *rax = eax;
330                 *rdx = edx;
331                 return TRUE;
332         } else {
333                 /* if they are writing what is already written, that's ok. */
334                 if (((uint32_t) *rax == eax) && ((uint32_t) *rdx == edx))
335                         return TRUE;
336         }
337         printk
338                 ("%s: Wanted to write 0x%x:0x%x, but could not; value was 0x%x:0x%x\n",
339                  msr->name, (uint32_t) *rdx, (uint32_t) *rax, edx, eax);
340         return FALSE;
341 }
342
343 bool emsr_readonly(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
344                    uint64_t *rax, uint32_t opcode)
345 {
346         uint32_t eax, edx;
347         uint64_t val;
348
349         if (read_msr_safe(msr->reg, &val))
350                 return FALSE;
351         split_msr_val(val, &edx, &eax);
352         if (opcode == VMM_MSR_EMU_READ) {
353                 *rax = eax;
354                 *rdx = edx;
355                 return TRUE;
356         }
357
358         printk("%s: Tried to write a readonly register\n", msr->name);
359         return FALSE;
360 }
361
362 bool emsr_readzero(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
363                    uint64_t *rax, uint32_t opcode)
364 {
365         if (opcode == VMM_MSR_EMU_READ) {
366                 *rax = 0;
367                 *rdx = 0;
368                 return TRUE;
369         }
370
371         printk("%s: Tried to write a readonly register\n", msr->name);
372         return FALSE;
373 }
374
375 /* pretend to write it, but don't write it. */
376 bool emsr_fakewrite(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
377                     uint64_t *rax, uint32_t opcode)
378 {
379         uint32_t eax, edx;
380         uint64_t val;
381
382         if (!msr->written) {
383                 if (read_msr_safe(msr->reg, &val))
384                         return FALSE;
385                 split_msr_val(val, &edx, &eax);
386         } else {
387                 edx = msr->edx;
388                 eax = msr->eax;
389         }
390         /* we just let them read the misc msr for now. */
391         if (opcode == VMM_MSR_EMU_READ) {
392                 *rax = eax;
393                 *rdx = edx;
394                 return TRUE;
395         } else {
396                 /* if they are writing what is already written, that's ok. */
397                 if (((uint32_t) *rax == eax) && ((uint32_t) *rdx == edx))
398                         return TRUE;
399                 msr->edx = *rdx;
400                 msr->eax = *rax;
401                 msr->written = TRUE;
402         }
403         return TRUE;
404 }
405
406 bool emsr_ok(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
407              uint64_t *rax, uint32_t opcode)
408 {
409         uint32_t eax, edx;
410         uint64_t val;
411
412         if (opcode == VMM_MSR_EMU_READ) {
413                 if (read_msr_safe(msr->reg, &val))
414                         return FALSE;
415                 split_msr_val(val, &edx, &eax);
416                 *rax = eax;
417                 *rdx = edx;
418         } else {
419                 val = (*rdx << 32) | (*rax & 0xffffffff);
420                 if (write_msr_safe(msr->reg, val))
421                         return FALSE;
422         }
423         return TRUE;
424 }
425
426 /* pretend to write it, but don't write it. */
427 bool emsr_fake_apicbase(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
428                         uint64_t *rax, uint32_t opcode)
429 {
430         uint32_t eax, edx;
431
432         if (!msr->written) {
433                 /* TODO: tightly coupled to the addr in vmrunkernel.  We want this func
434                  * to return the val that vmrunkernel put into the VMCS. */
435                 eax = 0xfee00900;
436                 edx = 0;
437         } else {
438                 edx = msr->edx;
439                 eax = msr->eax;
440         }
441         /* we just let them read the misc msr for now. */
442         if (opcode == VMM_MSR_EMU_READ) {
443                 *rax = eax;
444                 *rdx = edx;
445                 return TRUE;
446         } else {
447                 /* if they are writing what is already written, that's ok. */
448                 if (((uint32_t) *rax == eax) && ((uint32_t) *rdx == edx))
449                         return 0;
450                 msr->edx = *rdx;
451                 msr->eax = *rax;
452                 msr->written = TRUE;
453         }
454         return TRUE;
455 }
456
457 bool vmm_emulate_msr(uint64_t *rcx, uint64_t *rdx, uint64_t *rax, int op)
458 {
459         for (int i = 0; i < ARRAY_SIZE(emmsrs); i++) {
460                 if (emmsrs[i].reg != *rcx)
461                         continue;
462                 return emmsrs[i].f(&emmsrs[i], rcx, rdx, rax, op);
463         }
464         return FALSE;
465 }