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