VMM: Sync halting GPCs and interrupt injection
[akaros.git] / user / vmm / vmexit.c
1 /* Copyright (c) 2015-2016 Google Inc.
2  * See LICENSE for details. */
3
4 #include <parlib/common.h>
5 #include <vmm/virtio.h>
6 #include <vmm/virtio_mmio.h>
7 #include <vmm/virtio_ids.h>
8 #include <vmm/virtio_config.h>
9 #include <vmm/vmm.h>
10 #include <parlib/arch/trap.h>
11 #include <parlib/bitmask.h>
12 #include <stdio.h>
13
14 static bool pir_notif_is_set(struct vmm_gpcore_init *gpci)
15 {
16         return GET_BITMASK_BIT(gpci->posted_irq_desc, VMX_POSTED_OUTSTANDING_NOTIF);
17 }
18
19 static bool rvi_is_set(struct guest_thread *gth)
20 {
21         uint8_t rvi = gth_to_vmtf(gth)->tf_guest_intr_status & 0xff;
22
23         return rvi != 0;
24 }
25
26 /* Blocks a guest pcore / thread until it has an IRQ pending.  Syncs with
27  * vmm_interrupt_guest(). */
28 static void sleep_til_irq(struct guest_thread *gth)
29 {
30         struct vmm_gpcore_init *gpci = gth_to_gpci(gth);
31
32         /* The invariant is that if an IRQ is posted, but not delivered, we will not
33          * sleep.  Anyone who posts an IRQ must signal after setting it.
34          * vmm_interrupt_guest() does this.  If we use alternate sources of IRQ
35          * posting, we'll need to revist this.
36          *
37          * Although vmm_interrupt_guest() only writes OUTSTANDING_NOTIF, it's
38          * possible that the hardware attempted to post the interrupt.  In SDM
39          * parlance, the processor could have "recognized" the virtual IRQ, but not
40          * delivered it yet.  This could happen if the guest had executed "sti", but
41          * not "hlt" yet.  The IRQ was posted and recognized, but not delivered
42          * ("sti blocking").  Then the guest executes "hlt", and vmexits.
43          * OUTSTANDING_NOTIF will be clear in this case.  RVI should be set - at
44          * least to the vector we just sent, but possibly to a greater vector if
45          * multiple were sent.  RVI should only be cleared after virtual IRQs were
46          * actually delivered.  So checking OUTSTANDING_NOTIF and RVI should
47          * suffice.
48          *
49          * Generally, we should also check GUEST_INTERRUPTIBILITY_INFO to see if
50          * there's some reason to not deliver the interrupt and check things like
51          * the VPPR (priority register).  But since we're emulating a halt, mwait,
52          * or something else that needs to be woken by an IRQ, we can ignore that
53          * and just wake them up.  Note that we won't actually deliver the IRQ,
54          * we'll just restart the guest and the hardware will deliver the virtual
55          * IRQ at the appropriate time.  So in the event that something weird
56          * happens, the halt/mwait just returns spuriously.
57          *
58          * The more traditional race here is if the halt starts concurrently with
59          * the post; that's why we sync with the mutex to make sure there is an
60          * ordering between the actual halt (this function) and the posting. */
61         uth_mutex_lock(gth->halt_mtx);
62         while (!(pir_notif_is_set(gpci) || rvi_is_set(gth)))
63                 uth_cond_var_wait(gth->halt_cv, gth->halt_mtx);
64         uth_mutex_unlock(gth->halt_mtx);
65 }
66
67 static bool handle_ept_fault(struct guest_thread *gth)
68 {
69         struct vm_trapframe *vm_tf = gth_to_vmtf(gth);
70         struct virtual_machine *vm = gth_to_vm(gth);
71         uint64_t gpa, *regp;
72         uint8_t regx;
73         int store, size;
74         int advance;
75
76         if (decode(gth, &gpa, &regx, &regp, &store, &size, &advance))
77                 return FALSE;
78         assert(size >= 0);
79         /* TODO use helpers for some of these addr checks.  the fee/fec ones might
80          * be wrong too. */
81         for (int i = 0; i < VIRTIO_MMIO_MAX_NUM_DEV; i++) {
82                 if (vm->virtio_mmio_devices[i] == NULL)
83                         continue;
84                 if (PG_ADDR(gpa) != vm->virtio_mmio_devices[i]->addr)
85                         continue;
86                 /* TODO: can the guest cause us to spawn off infinite threads? */
87                 if (store)
88                         virtio_mmio_wr(vm, vm->virtio_mmio_devices[i], gpa, size,
89                                        (uint32_t *)regp);
90                 else
91                         *regp = virtio_mmio_rd(vm, vm->virtio_mmio_devices[i], gpa, size);
92                 vm_tf->tf_rip += advance;
93                 return TRUE;
94         }
95         if (PG_ADDR(gpa) == 0xfec00000) {
96                 do_ioapic(gth, gpa, regx, regp, store);
97         } else if (PG_ADDR(gpa) == 0) {
98                 memmove(regp, &vm->low4k[gpa], size);
99         } else {
100                 fprintf(stderr, "EPT violation: can't handle %p\n", gpa);
101                 fprintf(stderr, "RIP %p, exit reason 0x%x\n", vm_tf->tf_rip,
102                                 vm_tf->tf_exit_reason);
103                 fprintf(stderr, "Returning 0xffffffff\n");
104                 showstatus(stderr, gth);
105                 /* Just fill the whole register for now. */
106                 *regp = (uint64_t) -1;
107                 return FALSE;
108         }
109         vm_tf->tf_rip += advance;
110         return TRUE;
111 }
112
113 static bool handle_vmcall(struct guest_thread *gth)
114 {
115         struct vm_trapframe *vm_tf = gth_to_vmtf(gth);
116         uint8_t byte;
117
118         byte = vm_tf->tf_rdi;
119         printf("%c", byte);
120         if (byte == '\n')
121                 printf("%c", '%');
122         vm_tf->tf_rip += 3;
123         return TRUE;
124 }
125
126 static bool handle_io(struct guest_thread *gth)
127 {
128         return io(gth);
129 }
130
131 static bool handle_msr(struct guest_thread *gth)
132 {
133         struct vm_trapframe *vm_tf = gth_to_vmtf(gth);
134
135         /* TODO: consider pushing the gth into msrio */
136         if (msrio(gth, gth_to_gpci(gth), vm_tf->tf_exit_reason)) {
137                 /* Use event injection through vmctl to send a general protection fault
138                  * vmctl.interrupt gets written to the VM-Entry Interruption-Information
139                  * Field by vmx */
140                 vm_tf->tf_trap_inject = VM_TRAP_VALID
141                                       | VM_TRAP_ERROR_CODE
142                                       | VM_TRAP_HARDWARE
143                                       | HW_TRAP_GP_FAULT;
144         } else {
145                 vm_tf->tf_rip += 2;
146         }
147         return TRUE;
148 }
149
150 static bool handle_apic_access(struct guest_thread *gth)
151 {
152         uint64_t gpa, *regp;
153         uint8_t regx;
154         int store, size;
155         int advance;
156         struct vm_trapframe *vm_tf = gth_to_vmtf(gth);
157
158         if (decode(gth, &gpa, &regx, &regp, &store, &size, &advance))
159                 return FALSE;
160         if (__apic_access(gth, gpa, regx, regp, store))
161                 return FALSE;
162         vm_tf->tf_rip += advance;
163         return TRUE;
164 }
165
166 static bool handle_halt(struct guest_thread *gth)
167 {
168         struct vm_trapframe *vm_tf = gth_to_vmtf(gth);
169
170         /* It's possible the guest disabled IRQs and halted, perhaps waiting on an
171          * NMI or something.  If we need to support that, we can change this.  */
172         sleep_til_irq(gth);
173         vm_tf->tf_rip += 1;
174         return TRUE;
175 }
176
177 static bool handle_mwait(struct guest_thread *gth)
178 {
179         struct vm_trapframe *vm_tf = gth_to_vmtf(gth);
180
181         /* TODO: we need to handle the actual monitor part of mwait.  This just
182          * implements the power management / halting.  Likewise, it's possible IRQs
183          * are disabled (as with halt). */
184         sleep_til_irq(gth);
185         vm_tf->tf_rip += 3;
186         return TRUE;
187 }
188
189 /* Is this a vmm specific thing?  or generic?
190  *
191  * what do we do when we want to kill the vm?  what are our other options? */
192 bool handle_vmexit(struct guest_thread *gth)
193 {
194         struct vm_trapframe *vm_tf = gth_to_vmtf(gth);
195
196         switch (vm_tf->tf_exit_reason) {
197         case EXIT_REASON_EPT_VIOLATION:
198                 return handle_ept_fault(gth);
199         case EXIT_REASON_VMCALL:
200                 return handle_vmcall(gth);
201         case EXIT_REASON_IO_INSTRUCTION:
202                 return handle_io(gth);
203         case EXIT_REASON_MSR_WRITE:
204         case EXIT_REASON_MSR_READ:
205                 return handle_msr(gth);
206         case EXIT_REASON_APIC_ACCESS:
207                 return handle_apic_access(gth);
208         case EXIT_REASON_HLT:
209                 return handle_halt(gth);
210         case EXIT_REASON_MWAIT_INSTRUCTION:
211                 return handle_mwait(gth);
212         case EXIT_REASON_EXTERNAL_INTERRUPT:
213         case EXIT_REASON_APIC_WRITE:
214                 /* TODO: just ignore these? */
215                 return TRUE;
216         default:
217                 fprintf(stderr, "Don't know how to handle exit %d\n",
218                         vm_tf->tf_exit_reason);
219                 fprintf(stderr, "RIP %p, shutdown 0x%x\n", vm_tf->tf_rip,
220                         vm_tf->tf_exit_reason);
221                 return FALSE;
222         }
223 }