VMM: Added header for virtio_lguest_console functions
[akaros.git] / user / vmm / decode.c
1 /*
2  * Copyright 2015 Google Inc.
3  *
4  * This file is part of Akaros.
5  *
6  * Akarosn is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, version 2 of the License.
9  *
10  * Akaros is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * Lesser GNU General Public License for more details.
14  *
15  * See COPYING.LESSER for details on the GNU Lesser General Public License.
16  * See COPYING for details on the GNU General Public License.
17  */
18
19 #include <stdio.h>
20 #include <sys/types.h>
21 #include <pthread.h>
22 #include <sys/stat.h>
23 #include <fcntl.h>
24 #include <parlib/arch/arch.h>
25 #include <parlib/ros_debug.h>
26 #include <unistd.h>
27 #include <errno.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <sys/uio.h>
31 #include <stdint.h>
32 #include <err.h>
33 #include <sys/mman.h>
34 #include <vmm/vmm.h>
35 #include <vmm/virtio.h>
36 #include <vmm/virtio_mmio.h>
37 #include <vmm/virtio_ids.h>
38 #include <vmm/virtio_config.h>
39 #include <ros/arch/trapframe.h>
40
41 int debug_decode = 0;
42 #define DPRINTF(fmt, ...) \
43         if (debug_decode) { printf("decode: " fmt , ## __VA_ARGS__); }
44
45 static char *modrmreg[] = {"rax", "rcx", "rdx", "rbx", "rsp", "rbp", "rsi", "rdi"};
46
47 // Since we at most have to decode less than half of each instruction, I'm trying to be dumb here.
48 // Fortunately, for me, that's not hard.
49 // I'm trying to avoid the whole Big Fun of full instruction decode, and in most of these
50 // cases we only have to know register, address, operation size, and instruction length.
51 // The ugly messiness of the SIB and all that are not yet needed. Maybe they
52 // never will be.
53
54 // Target size -- 1, 2, 4, or 8 bytes. We have yet to see 64 bytes.
55 // TODO: if we ever see it, test the prefix. Since this only supports the low 1M,
56 // that's not likely.
57 static int target(void *insn, int *store)
58 {
59         *store = 0;
60         int s = -1;
61         uint8_t *byte = insn;
62         uint16_t *word = insn;
63
64         if (*byte == 0x66) {
65                 s = target(insn+1,store);
66                 // flip the sense of s.
67                 s = s == 4 ? 2 : 4;
68                 return s;
69         }
70         if (*byte == 0x44) {
71                 byte++;
72                 word++;
73         }
74         switch(*byte) {
75         case 0x3a:
76         case 0x8a:
77         case 0x88:
78                 s = 1;
79                 break;
80         case 0x89:
81         case 0x8b:
82                 // TODO: To really know, for sure, that this is 32 bit, we'd likely have
83                 //       to check the segment descriptor for the guest's current code
84                 //       segment in it's GDT. The D flag (bit 22) determines whether the
85                 //       instruction is using 32 or 16-bit operand size. I'm just going
86                 //       to assume the flag is set (meaning 32 bit operands) for now, in
87                 //       order to make virtio work. But really we should check if we
88                 //       want to know for sure. Note that this hack (changing the below
89                 //       line) only applies to mov instructions.
90                 //
91                 //       And I think there's also a prefix you can use to switch the
92                 //       instruction to 16-bit addressing
93                 //       (address-size override prefix?)
94                 s = 4;
95                 break;
96         case 0x81:
97                 s = 4;
98                 break;
99         case 0x0f:
100         switch(*word) {
101                 case 0xb70f:
102                         s = 4;
103                         break;
104                 default:
105                         fprintf(stderr, "can't get size of %02x/%04x @ %p\n", *byte, *word, byte);
106                         return -1;
107                         break;
108                 }
109                 break;
110         default:
111                 fprintf(stderr, "can't get size of %02x @ %p\n", *byte, byte);
112                 return -1;
113                 break;
114         }
115
116         switch(*byte) {
117         case 0x3a:
118         case 0x8a:
119         case 0x88:
120         case 0x89:
121         case 0x8b:
122         case 0x81:
123                 *store = !(*byte & 2);
124                 break;
125         default:
126                 fprintf(stderr, "%s: Can't happen\n", __func__);
127                 break;
128         }
129         return s;
130 }
131
132 char *regname(uint8_t reg)
133 {
134         return modrmreg[reg];
135 }
136
137 static int insize(void *rip)
138 {
139         uint8_t *kva = rip;
140         int advance = 3;
141         int extra = 0;
142         if (kva[0] == 0x44) {
143                 extra = 1;
144                 kva++;
145         }
146
147         /* the dreaded mod/rm byte. */
148         int mod = kva[1]>>6;
149         int rm = kva[1] & 7;
150
151         switch(kva[0]) {
152         default:
153                 fprintf(stderr, "BUG! %s got 0x%x\n", __func__, kva[0]);
154         case 0x0f:
155                 break;
156         case 0x81:
157                 advance = 6 + extra;
158                 break;
159         case 0x3a:
160         case 0x8a:
161         case 0x88:
162         case 0x89:
163         case 0x8b:
164                 switch (mod) {
165                 case 0:
166                         advance = 2 + (rm == 4) + extra;
167                         break;
168                 case 1:
169                         advance = 3 + (rm == 4) + extra;
170                         break;
171                 case 2:
172                         advance = 6 + (rm == 4) + extra;
173                         break;
174                 case 3:
175                         advance = 2 + extra;
176                         break;
177                 }
178                 break;
179         }
180         return advance;
181 }
182
183 // This is a very limited function. It's only here to manage virtio-mmio and low memory
184 // pointer loads. I am hoping it won't grow with time. The intent is that we enter it with
185 // and EPT fault from a region that is deliberately left unbacked by any memory. We return
186 // enough info to let you emulate the operation if you want. Because we have the failing physical
187 // address (gpa) the decode is far simpler because we only need to find the register, how many bytes
188 // to move, and how big the instruction is. I thought about bringing in emulate.c from kvm from xen,
189 // but it has way more stuff than we need.
190 // gpa is a pointer to the gpa.
191 // int is the reg index which we can use for printing info.
192 // regp points to the register in hw_trapframe from which
193 // to load or store a result.
194 int decode(struct guest_thread *vm_thread, uint64_t *gpa, uint8_t *destreg,
195            uint64_t **regp, int *store, int *size, int *advance)
196 {
197         struct vm_trapframe *vm_tf = &(vm_thread->uthread.u_ctx.tf.vm_tf);
198
199         DPRINTF("v is %p\n", vm_tf);
200
201         // Duh, which way did he go George? Which way did he go?
202         // First hit on Google gets you there!
203         // This is the guest physical address of the access.
204         // This is nice, because if we ever go with more complete
205         // instruction decode, knowing this gpa reduces our work:
206         // we don't have to find the source address in registers,
207         // only the register holding or receiving the value.
208         *gpa = vm_tf->tf_guest_pa;
209         DPRINTF("gpa is %p\n", *gpa);
210
211         // To find out what to do, we have to look at
212         // RIP. Technically, we should read RIP, walk the page tables
213         // to find the PA, and read that. But we're in the kernel, so
214         // we take a shortcut for now: read the low 30 bits and use
215         // that as the kernel PA, or our VA, and see what's
216         // there. Hokey. Works.
217         uint8_t *kva = (void *)(vm_tf->tf_rip & 0x3fffffff);
218         DPRINTF("kva is %p\n", kva);
219
220         // fail fast. If we can't get the size we're done.
221         *size = target(kva, store);
222         if (*size < 0)
223                 return -1;
224
225         *advance = insize(kva);
226
227         uint16_t ins = *(uint16_t *)(kva + (kva[0] == 0x44));
228         DPRINTF("ins is %04x\n", ins);
229
230         *destreg = (ins>>11) & 7;
231         *destreg += 8*(kva[0] == 0x44);
232         // Our primitive approach wins big here.
233         // We don't have to decode the register or the offset used
234         // in the computation; that was done by the CPU and is the gpa.
235         // All we need to know is which destination or source register it is.
236         switch (*destreg) {
237         case 0:
238                 *regp = &vm_tf->tf_rax;
239                 break;
240         case 1:
241                 *regp = &vm_tf->tf_rcx;
242                 break;
243         case 2:
244                 *regp = &vm_tf->tf_rdx;
245                 break;
246         case 3:
247                 *regp = &vm_tf->tf_rbx;
248                 break;
249         case 4:
250                 *regp = &vm_tf->tf_rsp; // uh, right.
251                 break;
252         case 5:
253                 *regp = &vm_tf->tf_rbp;
254                 break;
255         case 6:
256                 *regp = &vm_tf->tf_rsi;
257                 break;
258         case 7:
259                 *regp = &vm_tf->tf_rdi;
260                 break;
261         case 8:
262                 *regp = &vm_tf->tf_r8;
263                 break;
264         case 9:
265                 *regp = &vm_tf->tf_r9;
266                 break;
267         case 10:
268                 *regp = &vm_tf->tf_r10;
269                 break;
270         case 11:
271                 *regp = &vm_tf->tf_r11;
272                 break;
273         case 12:
274                 *regp = &vm_tf->tf_r12;
275                 break;
276         case 13:
277                 *regp = &vm_tf->tf_r13;
278                 break;
279         case 14:
280                 *regp = &vm_tf->tf_r14;
281                 break;
282         case 15:
283                 *regp = &vm_tf->tf_r15;
284                 break;
285         }
286         return 0;
287 }