Start putting together ACPI for guests.
[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
40 int debug_decode = 0;
41 #define DPRINTF(fmt, ...) \
42         if (debug_decode) { printf("decode: " fmt , ## __VA_ARGS__); }
43
44 static char *modrmreg[] = {"rax", "rcx", "rdx", "rbx", "rsp", "rbp", "rsi", "rdi"};
45
46 // Since we at most have to decode less than half of each instruction, I'm trying to be dumb here.
47 // Fortunately, for me, what's not hard.
48
49 // Target size -- 1, 2, 4, or 8 bytes. We have yet to see 64 bytes. 
50 // TODO: if we ever see it, test the prefix. Since this only supports the low 1M,
51 // that's not likely.
52 static int target(void *insn, int *store) 
53 {
54         *store = 0;
55         int s = -1;
56         uint8_t *byte = insn;
57         uint16_t *word = insn;
58
59         if (*byte == 0x66) {
60                 s = target(insn+1,store);
61                 // flip the sense of s.
62                 s = s == 4 ? 2 : 4;
63                 return s;
64         }
65         switch(*byte) {
66         case 0x3a:
67         case 0x8a:
68         case 0x88:
69                 s = 1;
70                 break;
71         case 0x89:
72         case 0x8b:
73                 s = 2;
74                 break;
75         case 0x81:
76                 s = 4;  
77                 break;
78         case 0x0f:
79         switch(*word) {
80                 case 0xb70f:
81                         s = 4;
82                         break;
83                 default:
84                         fprintf(stderr, "can't get size of %02x/%04x @ %p\n", *byte, *word, byte);
85                         return -1;
86                         break;
87                 }
88                 break;
89         default:
90                 fprintf(stderr, "can't get size of %02x @ %p\n", *byte, byte);
91                 return -1;
92                 break;
93         }
94
95         switch(*byte) {
96         case 0x3a:
97         case 0x8a:
98         case 0x88:
99         case 0x89:
100         case 0x8b:
101         case 0x81:
102                 *store = !(*byte & 2);
103                 break;
104         default:
105                 fprintf(stderr, "%s: Can't happen\n", __func__);
106                 break;
107         }
108         return s;
109 }
110
111 char *regname(uint8_t reg)
112 {
113         return modrmreg[reg];
114 }
115
116 static int insize(void *rip)
117 {
118         uint8_t *kva = rip;
119         int advance = 3;
120         /* the dreaded mod/rm byte. */
121         int mod = kva[1]>>6;
122         int rm = kva[1] & 7;
123
124         switch(kva[0]) {
125         default: 
126                 fprintf(stderr, "BUG! %s got 0x%x\n", __func__, kva[0]);
127         case 0x0f: 
128                 break;
129         case 0x81:
130                 advance = 6;
131                 break;
132         case 0x3a:
133         case 0x8a:
134         case 0x88:
135         case 0x89:
136         case 0x8b:
137                 switch (mod) {
138                 case 0: 
139                         advance = 2 + (rm == 4);
140                         break;
141                 case 1:
142                         advance = 3 + (rm == 4);
143                         break;
144                 case 2: 
145                         advance = 6 + (rm == 4);
146                         break;
147                 case 3:
148                         advance = 2;
149                         break;
150                 }
151                 break;
152         }
153         return advance;
154 }
155
156 // This is a very limited function. It's only here to manage virtio-mmio and low memory
157 // pointer loads. I am hoping it won't grow with time. The intent is that we enter it with
158 // and EPT fault from a region that is deliberately left unbacked by any memory. We return
159 // enough info to let you emulate the operation if you want. Because we have the failing physical
160 // address (gpa) the decode is far simpler because we only need to find the register, how many bytes
161 // to move, and how big the instruction is. I thought about bringing in emulate.c from kvm from xen,
162 // but it has way more stuff than we need.
163 // gpa is a pointer to the gpa. 
164 // int is the reg index which we can use for printing info.
165 // regp points to the register in hw_trapframe from which
166 // to load or store a result.
167 int decode(struct vmctl *v, uint64_t *gpa, uint8_t *destreg, uint64_t **regp, int *store, int *size, int *advance)
168 {
169
170         DPRINTF("v is %p\n", v);
171
172         // Duh, which way did he go George? Which way did he go? 
173         // First hit on Google gets you there!
174         // This is the guest physical address of the access.
175         // This is nice, because if we ever go with more complete
176         // instruction decode, knowing this gpa reduces our work:
177         // we don't have to find the source address in registers,
178         // only the register holding or receiving the value.
179         *gpa = v->gpa;
180         DPRINTF("gpa is %p\n", *gpa);
181
182         // To find out what to do, we have to look at
183         // RIP. Technically, we should read RIP, walk the page tables
184         // to find the PA, and read that. But we're in the kernel, so
185         // we take a shortcut for now: read the low 30 bits and use
186         // that as the kernel PA, or our VA, and see what's
187         // there. Hokey. Works.
188         uint8_t *kva = (void *)(v->regs.tf_rip & 0x3fffffff);
189         DPRINTF("kva is %p\n", kva);
190
191         // fail fast. If we can't get the size we're done.
192         *size = target(kva, store);
193         if (*size < 0)
194                 return -1;
195
196         uint16_t ins = *(uint16_t *)kva;
197         DPRINTF("ins is %04x\n", ins);
198         
199         *advance = insize(kva);
200
201         *destreg = (ins>>11) & 7;
202         // Our primitive approach wins big here.
203         // We don't have to decode the register or the offset used
204         // in the computation; that was done by the CPU and is the gpa.
205         // All we need to know is which destination or source register it is.
206         switch (*destreg) {
207         case 0:
208                 *regp = &v->regs.tf_rax;
209                 break;
210         case 1:
211                 *regp = &v->regs.tf_rcx;
212                 break;
213         case 2:
214                 *regp = &v->regs.tf_rdx;
215                 break;
216         case 3:
217                 *regp = &v->regs.tf_rbx;
218                 break;
219         case 4:
220                 *regp = &v->regs.tf_rsp; // uh, right.
221                 break;
222         case 5:
223                 *regp = &v->regs.tf_rbp;
224                 break;
225         case 6:
226                 *regp = &v->regs.tf_rsi;
227                 break;
228         case 7:
229                 *regp = &v->regs.tf_rdi;
230                 break;
231         }
232         return 0;
233 }
234
235 #if 0
236 // stupid emulator since what we need is so limited.
237 int emu(struct vmctl *v, uint64_t gpa, uint8_t destreg, uint64_t *regp, int store, int size, int advance)
238 {
239         uint8_t *kva = f->regs.tf_rip;
240
241         if (
242         switch(kva[0]) {
243
244                                 val = *(uint64_t*) (lowmem + gpa); 
245                                 printf("val %p ", val);
246                                 memcpy(regp, &val, size);
247
248 }
249 #endif