Apic msr exit handling added with timer thread support
[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, optionally setting errno */
70 int vmm_struct_init(struct proc *p, unsigned int nr_guest_pcores,
71                     struct vmm_gpcore_init *u_gpcis, int flags)
72 {
73         struct vmm *vmm = &p->vmm;
74         unsigned int i;
75         struct vmm_gpcore_init gpci;
76
77         if (flags & ~VMM_ALL_FLAGS) {
78                 set_errstr("%s: flags is 0x%lx, VMM_ALL_FLAGS is 0x%lx\n", __func__,
79                            flags, VMM_ALL_FLAGS);
80                 set_errno(EINVAL);
81                 return 0;
82         }
83         vmm->flags = flags;
84         if (!x86_supports_vmx) {
85                 set_errno(ENODEV);
86                 return 0;
87         }
88         qlock(&vmm->qlock);
89         if (vmm->vmmcp) {
90                 set_errno(EINVAL);
91                 qunlock(&vmm->qlock);
92                 return 0;
93         }
94         /* Set this early, so cleanup checks the gpc array */
95         vmm->vmmcp = TRUE;
96         nr_guest_pcores = MIN(nr_guest_pcores, num_cores);
97         vmm->amd = 0;
98         vmm->guest_pcores = kzmalloc(sizeof(void*) * nr_guest_pcores, KMALLOC_WAIT);
99         for (i = 0; i < nr_guest_pcores; i++) {
100                 if (copy_from_user(&gpci, &u_gpcis[i],
101                                    sizeof(struct vmm_gpcore_init))) {
102                         set_error(EINVAL, "Bad pointer %p for gps", u_gpcis);
103                         break;
104                 }
105                 vmm->guest_pcores[i] = create_guest_pcore(p, &gpci);
106                 /* If we failed, we'll clean it up when the process dies */
107                 if (!vmm->guest_pcores[i]) {
108                         set_errno(ENOMEM);
109                         break;
110                 }
111         }
112         vmm->nr_guest_pcores = i;
113         for (int i = 0; i < VMM_VMEXIT_NR_TYPES; i++)
114                 vmm->vmexits[i] = 0;
115         qunlock(&vmm->qlock);
116         return i;
117 }
118
119 /* Has no concurrency protection - only call this when you know you have the
120  * only ref to vmm.  For instance, from __proc_free, where there is only one ref
121  * to the proc (and thus proc.vmm). */
122 void __vmm_struct_cleanup(struct proc *p)
123 {
124         struct vmm *vmm = &p->vmm;
125         if (!vmm->vmmcp)
126                 return;
127         for (int i = 0; i < vmm->nr_guest_pcores; i++) {
128                 if (vmm->guest_pcores[i])
129                         destroy_guest_pcore(vmm->guest_pcores[i]);
130         }
131         kfree(vmm->guest_pcores);
132         ept_flush(p->env_pgdir.eptp);
133         vmm->vmmcp = FALSE;
134 }
135
136 int vmm_poke_guest(struct proc *p, int guest_pcoreid)
137 {
138         struct guest_pcore *gpc;
139         int pcoreid;
140
141         gpc = lookup_guest_pcore(p, guest_pcoreid);
142         if (!gpc) {
143                 set_error(ENOENT, "Bad guest_pcoreid %d", guest_pcoreid);
144                 return -1;
145         }
146         /* We're doing an unlocked peek; it could change immediately.  This is a
147          * best effort service. */
148         pcoreid = ACCESS_ONCE(gpc->cpu);
149         if (pcoreid == -1) {
150                 /* So we know that we'll miss the poke for the posted IRQ.  We could
151                  * return an error.  However, error handling for this case isn't
152                  * particularly helpful (yet).  The absence of the error does not mean
153                  * the IRQ was posted.  We'll still return 0, meaning "the user didn't
154                  * mess up; we tried." */
155                 return 0;
156         }
157         send_ipi(pcoreid, I_POKE_CORE);
158         return 0;
159 }
160
161 struct guest_pcore *lookup_guest_pcore(struct proc *p, int guest_pcoreid)
162 {
163         /* nr_guest_pcores is written once at setup and never changed */
164         if (guest_pcoreid >= p->vmm.nr_guest_pcores)
165                 return 0;
166         return p->vmm.guest_pcores[guest_pcoreid];
167 }
168
169 struct guest_pcore *load_guest_pcore(struct proc *p, int guest_pcoreid)
170 {
171         struct guest_pcore *gpc;
172         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
173
174         gpc = lookup_guest_pcore(p, guest_pcoreid);
175         if (!gpc)
176                 return 0;
177         assert(pcpui->guest_pcoreid == -1);
178         spin_lock(&p->vmm.lock);
179         if (gpc->cpu != -1) {
180                 spin_unlock(&p->vmm.lock);
181                 return 0;
182         }
183         gpc->cpu = core_id();
184         spin_unlock(&p->vmm.lock);
185         /* We've got dibs on the gpc; we don't need to hold the lock any longer. */
186         pcpui->guest_pcoreid = guest_pcoreid;
187         ept_sync_context(gpc_get_eptp(gpc));
188         vmx_load_guest_pcore(gpc);
189         /* Load guest's xcr0 */
190         lxcr0(gpc->xcr0);
191         return gpc;
192 }
193
194 void unload_guest_pcore(struct proc *p, int guest_pcoreid)
195 {
196         struct guest_pcore *gpc;
197         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
198
199         gpc = lookup_guest_pcore(p, guest_pcoreid);
200         assert(gpc);
201         spin_lock(&p->vmm.lock);
202         assert(gpc->cpu != -1);
203         ept_sync_context(gpc_get_eptp(gpc));
204         vmx_unload_guest_pcore(gpc);
205         gpc->cpu = -1;
206
207         /* Save guest's xcr0 and restore Akaros's default. */
208         gpc->xcr0 = rxcr0();
209         lxcr0(__proc_global_info.x86_default_xcr0);
210
211         /* As soon as we unlock, this gpc can be started on another core */
212         spin_unlock(&p->vmm.lock);
213         pcpui->guest_pcoreid = -1;
214 }
215
216 /* emulated msr. For now, an msr value and a pointer to a helper that
217  * performs the requested operation.
218  */
219 struct emmsr {
220         uint32_t reg;
221         char *name;
222         bool (*f)(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
223                   uint64_t *rax, uint32_t opcode);
224         bool written;
225         uint32_t edx, eax;
226 };
227
228 static bool emsr_miscenable(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
229                             uint64_t *rax, uint32_t opcode);
230 static bool emsr_mustmatch(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
231                            uint64_t *rax, uint32_t opcode);
232 static bool emsr_readonly(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
233                           uint64_t *rax, uint32_t opcode);
234 static bool emsr_readzero(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
235                           uint64_t *rax, uint32_t opcode);
236 static bool emsr_fakewrite(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
237                            uint64_t *rax, uint32_t opcode);
238 static bool emsr_ok(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
239                     uint64_t *rax, uint32_t opcode);
240 static bool emsr_fake_apicbase(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
241                                uint64_t *rax, uint32_t opcode);
242
243 struct emmsr emmsrs[] = {
244         {MSR_IA32_MISC_ENABLE, "MSR_IA32_MISC_ENABLE", emsr_miscenable},
245         {MSR_IA32_SYSENTER_CS, "MSR_IA32_SYSENTER_CS", emsr_ok},
246         {MSR_IA32_SYSENTER_EIP, "MSR_IA32_SYSENTER_EIP", emsr_ok},
247         {MSR_IA32_SYSENTER_ESP, "MSR_IA32_SYSENTER_ESP", emsr_ok},
248         {MSR_IA32_UCODE_REV, "MSR_IA32_UCODE_REV", emsr_fakewrite},
249         {MSR_CSTAR, "MSR_CSTAR", emsr_fakewrite},
250         {MSR_IA32_VMX_BASIC_MSR, "MSR_IA32_VMX_BASIC_MSR", emsr_fakewrite},
251         {MSR_IA32_VMX_PINBASED_CTLS_MSR, "MSR_IA32_VMX_PINBASED_CTLS_MSR",
252          emsr_fakewrite},
253         {MSR_IA32_VMX_PROCBASED_CTLS_MSR, "MSR_IA32_VMX_PROCBASED_CTLS_MSR",
254          emsr_fakewrite},
255         {MSR_IA32_VMX_PROCBASED_CTLS2, "MSR_IA32_VMX_PROCBASED_CTLS2",
256          emsr_fakewrite},
257         {MSR_IA32_VMX_EXIT_CTLS_MSR, "MSR_IA32_VMX_EXIT_CTLS_MSR",
258          emsr_fakewrite},
259         {MSR_IA32_VMX_ENTRY_CTLS_MSR, "MSR_IA32_VMX_ENTRY_CTLS_MSR",
260          emsr_fakewrite},
261         {MSR_IA32_ENERGY_PERF_BIAS, "MSR_IA32_ENERGY_PERF_BIAS",
262          emsr_fakewrite},
263         {MSR_LBR_SELECT, "MSR_LBR_SELECT", emsr_ok},
264         {MSR_LBR_TOS, "MSR_LBR_TOS", emsr_ok},
265         {MSR_LBR_NHM_FROM, "MSR_LBR_NHM_FROM", emsr_ok},
266         {MSR_LBR_NHM_TO, "MSR_LBR_NHM_TO", emsr_ok},
267         {MSR_LBR_CORE_FROM, "MSR_LBR_CORE_FROM", emsr_ok},
268         {MSR_LBR_CORE_TO, "MSR_LBR_CORE_TO", emsr_ok},
269
270         // grumble.
271         {MSR_OFFCORE_RSP_0, "MSR_OFFCORE_RSP_0", emsr_ok},
272         {MSR_OFFCORE_RSP_1, "MSR_OFFCORE_RSP_1", emsr_ok},
273         // louder.
274         {MSR_PEBS_LD_LAT_THRESHOLD, "MSR_PEBS_LD_LAT_THRESHOLD", emsr_ok},
275         // aaaaaahhhhhhhhhhhhhhhhhhhhh
276         {MSR_ARCH_PERFMON_EVENTSEL0, "MSR_ARCH_PERFMON_EVENTSEL0", emsr_ok},
277         {MSR_ARCH_PERFMON_EVENTSEL1, "MSR_ARCH_PERFMON_EVENTSEL0", emsr_ok},
278         {MSR_IA32_PERF_CAPABILITIES, "MSR_IA32_PERF_CAPABILITIES", emsr_ok},
279         // unsafe.
280         {MSR_IA32_APICBASE, "MSR_IA32_APICBASE", emsr_fake_apicbase},
281
282         // mostly harmless.
283         {MSR_TSC_AUX, "MSR_TSC_AUX", emsr_fakewrite},
284         {MSR_RAPL_POWER_UNIT, "MSR_RAPL_POWER_UNIT", emsr_readzero},
285
286         // TBD
287         {MSR_IA32_TSC_DEADLINE, "MSR_IA32_TSC_DEADLINE", emsr_fakewrite},
288 };
289
290 /* this may be the only register that needs special handling.
291  * If there others then we might want to extend the emmsr struct.
292  */
293 bool emsr_miscenable(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
294                      uint64_t *rax, uint32_t opcode)
295 {
296         uint32_t eax, edx;
297
298         rdmsr(msr->reg, eax, edx);
299         /* we just let them read the misc msr for now. */
300         if (opcode == VMM_MSR_EMU_READ) {
301                 *rax = eax;
302                 *rax |= MSR_IA32_MISC_ENABLE_PEBS_UNAVAIL;
303                 *rdx = edx;
304                 return TRUE;
305         } else {
306                 /* if they are writing what is already written, that's ok. */
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
323         rdmsr(msr->reg, eax, edx);
324         /* we just let them read the misc msr for now. */
325         if (opcode == VMM_MSR_EMU_READ) {
326                 *rax = eax;
327                 *rdx = edx;
328                 return TRUE;
329         } else {
330                 /* if they are writing what is already written, that's ok. */
331                 if (((uint32_t) *rax == eax) && ((uint32_t) *rdx == edx))
332                         return TRUE;
333         }
334         printk
335                 ("%s: Wanted to write 0x%x:0x%x, but could not; value was 0x%x:0x%x\n",
336                  msr->name, (uint32_t) *rdx, (uint32_t) *rax, edx, eax);
337         return FALSE;
338 }
339
340 bool emsr_readonly(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
341                    uint64_t *rax, uint32_t opcode)
342 {
343         uint32_t eax, edx;
344
345         rdmsr((uint32_t) *rcx, eax, edx);
346         if (opcode == VMM_MSR_EMU_READ) {
347                 *rax = eax;
348                 *rdx = edx;
349                 return TRUE;
350         }
351
352         printk("%s: Tried to write a readonly register\n", msr->name);
353         return FALSE;
354 }
355
356 bool emsr_readzero(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
357                    uint64_t *rax, uint32_t opcode)
358 {
359         if (opcode == VMM_MSR_EMU_READ) {
360                 *rax = 0;
361                 *rdx = 0;
362                 return TRUE;
363         }
364
365         printk("%s: Tried to write a readonly register\n", msr->name);
366         return FALSE;
367 }
368
369 /* pretend to write it, but don't write it. */
370 bool emsr_fakewrite(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
371                     uint64_t *rax, uint32_t opcode)
372 {
373         uint32_t eax, edx;
374
375         if (!msr->written) {
376                 rdmsr(msr->reg, eax, edx);
377         } else {
378                 edx = msr->edx;
379                 eax = msr->eax;
380         }
381         /* we just let them read the misc msr for now. */
382         if (opcode == VMM_MSR_EMU_READ) {
383                 *rax = eax;
384                 *rdx = edx;
385                 return TRUE;
386         } else {
387                 /* if they are writing what is already written, that's ok. */
388                 if (((uint32_t) *rax == eax) && ((uint32_t) *rdx == edx))
389                         return TRUE;
390                 msr->edx = *rdx;
391                 msr->eax = *rax;
392                 msr->written = TRUE;
393         }
394         return TRUE;
395 }
396
397 bool emsr_ok(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
398              uint64_t *rax, uint32_t opcode)
399 {
400         if (opcode == VMM_MSR_EMU_READ) {
401                 rdmsr(msr->reg, *rdx, *rax);
402         } else {
403                 uint64_t val = (uint64_t) *rdx << 32 | *rax;
404
405                 write_msr(msr->reg, val);
406         }
407         return TRUE;
408 }
409
410 /* pretend to write it, but don't write it. */
411 bool emsr_fake_apicbase(struct emmsr *msr, uint64_t *rcx, uint64_t *rdx,
412                         uint64_t *rax, uint32_t opcode)
413 {
414         uint32_t eax, edx;
415
416         if (!msr->written) {
417                 //rdmsr(msr->reg, eax, edx);
418                 /* TODO: tightly coupled to the addr in vmrunkernel.  We want this func
419                  * to return the val that vmrunkernel put into the VMCS. */
420                 eax = 0xfee00900;
421                 edx = 0;
422         } else {
423                 edx = msr->edx;
424                 eax = msr->eax;
425         }
426         /* we just let them read the misc msr for now. */
427         if (opcode == VMM_MSR_EMU_READ) {
428                 *rax = eax;
429                 *rdx = edx;
430                 return TRUE;
431         } else {
432                 /* if they are writing what is already written, that's ok. */
433                 if (((uint32_t) *rax == eax) && ((uint32_t) *rdx == edx))
434                         return 0;
435                 msr->edx = *rdx;
436                 msr->eax = *rax;
437                 msr->written = TRUE;
438         }
439         return TRUE;
440 }
441
442 bool vmm_emulate_msr(uint64_t *rcx, uint64_t *rdx, uint64_t *rax, int op)
443 {
444         for (int i = 0; i < ARRAY_SIZE(emmsrs); i++) {
445                 if (emmsrs[i].reg != *rcx)
446                         continue;
447                 return emmsrs[i].f(&emmsrs[i], rcx, rdx, rax, op);
448         }
449         return FALSE;
450 }