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