VMM: Add our virtio_mmio_dev struct and specify its interface 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                 s = 2;
83                 break;
84         case 0x81:
85                 s = 4;  
86                 break;
87         case 0x0f:
88         switch(*word) {
89                 case 0xb70f:
90                         s = 4;
91                         break;
92                 default:
93                         fprintf(stderr, "can't get size of %02x/%04x @ %p\n", *byte, *word, byte);
94                         return -1;
95                         break;
96                 }
97                 break;
98         default:
99                 fprintf(stderr, "can't get size of %02x @ %p\n", *byte, byte);
100                 return -1;
101                 break;
102         }
103
104         switch(*byte) {
105         case 0x3a:
106         case 0x8a:
107         case 0x88:
108         case 0x89:
109         case 0x8b:
110         case 0x81:
111                 *store = !(*byte & 2);
112                 break;
113         default:
114                 fprintf(stderr, "%s: Can't happen\n", __func__);
115                 break;
116         }
117         return s;
118 }
119
120 char *regname(uint8_t reg)
121 {
122         return modrmreg[reg];
123 }
124
125 static int insize(void *rip)
126 {
127         uint8_t *kva = rip;
128         int advance = 3;
129         int extra = 0;
130         if (kva[0] == 0x44) {
131                 extra = 1;
132                 kva++;
133         }
134
135         /* the dreaded mod/rm byte. */
136         int mod = kva[1]>>6;
137         int rm = kva[1] & 7;
138
139         switch(kva[0]) {
140         default: 
141                 fprintf(stderr, "BUG! %s got 0x%x\n", __func__, kva[0]);
142         case 0x0f: 
143                 break;
144         case 0x81:
145                 advance = 6 + extra;
146                 break;
147         case 0x3a:
148         case 0x8a:
149         case 0x88:
150         case 0x89:
151         case 0x8b:
152                 switch (mod) {
153                 case 0: 
154                         advance = 2 + (rm == 4) + extra;
155                         break;
156                 case 1:
157                         advance = 3 + (rm == 4) + extra;
158                         break;
159                 case 2: 
160                         advance = 6 + (rm == 4) + extra;
161                         break;
162                 case 3:
163                         advance = 2 + extra;
164                         break;
165                 }
166                 break;
167         }
168         return advance;
169 }
170
171 // This is a very limited function. It's only here to manage virtio-mmio and low memory
172 // pointer loads. I am hoping it won't grow with time. The intent is that we enter it with
173 // and EPT fault from a region that is deliberately left unbacked by any memory. We return
174 // enough info to let you emulate the operation if you want. Because we have the failing physical
175 // address (gpa) the decode is far simpler because we only need to find the register, how many bytes
176 // to move, and how big the instruction is. I thought about bringing in emulate.c from kvm from xen,
177 // but it has way more stuff than we need.
178 // gpa is a pointer to the gpa. 
179 // int is the reg index which we can use for printing info.
180 // regp points to the register in hw_trapframe from which
181 // to load or store a result.
182 int decode(struct guest_thread *vm_thread, uint64_t *gpa, uint8_t *destreg,
183            uint64_t **regp, int *store, int *size, int *advance)
184 {
185         struct vm_trapframe *vm_tf = &(vm_thread->uthread.u_ctx.tf.vm_tf);
186
187         DPRINTF("v is %p\n", vm_tf);
188
189         // Duh, which way did he go George? Which way did he go? 
190         // First hit on Google gets you there!
191         // This is the guest physical address of the access.
192         // This is nice, because if we ever go with more complete
193         // instruction decode, knowing this gpa reduces our work:
194         // we don't have to find the source address in registers,
195         // only the register holding or receiving the value.
196         *gpa = vm_tf->tf_guest_pa;
197         DPRINTF("gpa is %p\n", *gpa);
198
199         // To find out what to do, we have to look at
200         // RIP. Technically, we should read RIP, walk the page tables
201         // to find the PA, and read that. But we're in the kernel, so
202         // we take a shortcut for now: read the low 30 bits and use
203         // that as the kernel PA, or our VA, and see what's
204         // there. Hokey. Works.
205         uint8_t *kva = (void *)(vm_tf->tf_rip & 0x3fffffff);
206         DPRINTF("kva is %p\n", kva);
207
208         // fail fast. If we can't get the size we're done.
209         *size = target(kva, store);
210         if (*size < 0)
211                 return -1;
212
213         *advance = insize(kva);
214
215         uint16_t ins = *(uint16_t *)(kva + (kva[0] == 0x44));
216         DPRINTF("ins is %04x\n", ins);
217                 
218         *destreg = (ins>>11) & 7;
219         *destreg += 8*(kva[0] == 0x44);
220         // Our primitive approach wins big here.
221         // We don't have to decode the register or the offset used
222         // in the computation; that was done by the CPU and is the gpa.
223         // All we need to know is which destination or source register it is.
224         switch (*destreg) {
225         case 0:
226                 *regp = &vm_tf->tf_rax;
227                 break;
228         case 1:
229                 *regp = &vm_tf->tf_rcx;
230                 break;
231         case 2:
232                 *regp = &vm_tf->tf_rdx;
233                 break;
234         case 3:
235                 *regp = &vm_tf->tf_rbx;
236                 break;
237         case 4:
238                 *regp = &vm_tf->tf_rsp; // uh, right.
239                 break;
240         case 5:
241                 *regp = &vm_tf->tf_rbp;
242                 break;
243         case 6:
244                 *regp = &vm_tf->tf_rsi;
245                 break;
246         case 7:
247                 *regp = &vm_tf->tf_rdi;
248                 break;
249         case 8:
250                 *regp = &vm_tf->tf_r8;
251                 break;
252         case 9:
253                 *regp = &vm_tf->tf_r9;
254                 break;
255         case 10:
256                 *regp = &vm_tf->tf_r10;
257                 break;
258         case 11:
259                 *regp = &vm_tf->tf_r11;
260                 break;
261         case 12:
262                 *regp = &vm_tf->tf_r12;
263                 break;
264         case 13:
265                 *regp = &vm_tf->tf_r13;
266                 break;
267         case 14:
268                 *regp = &vm_tf->tf_r14;
269                 break;
270         case 15:
271                 *regp = &vm_tf->tf_r15;
272                 break;
273         }
274         return 0;
275 }