Check for size==1 before rounding to power of two in epoll init.
[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/mmu.h>
40 #include <ros/arch/trapframe.h>
41
42 int debug_decode = 0;
43 #define DPRINTF(fmt, ...) \
44         if (debug_decode) { printf("decode: " fmt , ## __VA_ARGS__); }
45
46 static char *modrmreg[] = {"rax", "rcx", "rdx", "rbx", "rsp", "rbp", "rsi", "rdi"};
47
48 // Since we at most have to decode less than half of each instruction, I'm trying to be dumb here.
49 // Fortunately, for me, that's not hard.
50 // I'm trying to avoid the whole Big Fun of full instruction decode, and in most of these
51 // cases we only have to know register, address, operation size, and instruction length.
52 // The ugly messiness of the SIB and all that are not yet needed. Maybe they
53 // never will be.
54
55 // Target size -- 1, 2, 4, or 8 bytes. We have yet to see 64 bytes.
56 // TODO: if we ever see it, test the prefix. Since this only supports the low 1M,
57 // that's not likely.
58 static int target(void *insn, int *store)
59 {
60         *store = 0;
61         int s = -1;
62         uint8_t *byte = insn;
63         uint16_t *word = insn;
64
65         if (*byte == 0x66) {
66                 s = target(insn+1,store);
67                 // flip the sense of s.
68                 s = s == 4 ? 2 : 4;
69                 return s;
70         }
71         if (*byte == 0x44) {
72                 byte++;
73                 word++;
74         }
75         switch(*byte) {
76         case 0x3a:
77         case 0x8a:
78         case 0x88:
79                 s = 1;
80                 break;
81         case 0x89:
82         case 0x8b:
83                 // TODO: To really know, for sure, that this is 32 bit, we'd likely have
84                 //       to check the segment descriptor for the guest's current code
85                 //       segment in it's GDT. The D flag (bit 22) determines whether the
86                 //       instruction is using 32 or 16-bit operand size. I'm just going
87                 //       to assume the flag is set (meaning 32 bit operands) for now, in
88                 //       order to make virtio work. But really we should check if we
89                 //       want to know for sure. Note that this hack (changing the below
90                 //       line) only applies to mov instructions.
91                 //
92                 //       And I think there's also a prefix you can use to switch the
93                 //       instruction to 16-bit addressing
94                 //       (address-size override prefix?)
95                 s = 4;
96                 break;
97         case 0x81:
98                 s = 4;
99                 break;
100         case 0x0f:
101                 switch (*word) {
102                         case 0xb70f:
103                                 s = 2;
104                                 break;
105                         default:
106                                 fprintf(stderr, "can't get size of %02x/%04x @ %p\n", *byte,
107                                         *word, byte);
108                                 return -1;
109                 }
110                 break;
111         case 0x41:
112                 /* VEX byte for modrm field */
113                 switch (*word) {
114                         case 0x8a41:
115                                 s = 1;
116                                 break;
117                         default:
118                                 fprintf(stderr, "unparsed vex instruction %02x/%04x @ %p\n",
119                                         *byte, *word, byte);
120                                 return -1;
121                 }
122                 break;
123         default:
124                 fprintf(stderr, "can't get size of %02x @ %p\n", *byte, byte);
125                 fprintf(stderr, "can't get WORD of %04x @ %p\n", *word, word);
126                 return -1;
127                 break;
128         }
129
130         switch(*byte) {
131         case 0x0f:
132         case 0x41:
133                 break;
134         case 0x3a:
135         case 0x8a:
136         case 0x88:
137         case 0x89:
138         case 0x8b:
139         case 0x81:
140                 *store = !(*byte & 2);
141                 break;
142         default:
143                 fprintf(stderr, "%s: Can't happen. rip is: %p\n", __func__, byte);
144                 break;
145         }
146         return s;
147 }
148
149 char *regname(uint8_t reg)
150 {
151         return modrmreg[reg];
152 }
153
154 static int insize(void *rip)
155 {
156         uint8_t *rip_gpa = rip;
157         int advance = 3;
158         int extra = 0;
159         if (rip_gpa[0] == 0x44) {
160                 extra = 1;
161                 rip_gpa++;
162         }
163
164         /* return 3 to handle this specific instruction case. We don't want this
165          * to turn into a fully fledged decode.
166          * This specific instruction is an extended move using r9. It uses the
167          * VEX byte to extend the register bits. */
168         if (rip_gpa[0] == 0x41 && rip_gpa[1] == 0x8a && rip_gpa[2] == 0x01)
169                 return 3;
170         /* the dreaded mod/rm byte. */
171         int mod = rip_gpa[1] >> 6;
172         int rm = rip_gpa[1] & 7;
173
174         switch (rip_gpa[0]) {
175         default:
176                 fprintf(stderr, "BUG! %s got 0x%x\n", __func__, rip_gpa[0]);
177         case 0x0f:
178                 break;
179         case 0x81:
180                 advance = 6 + extra;
181                 break;
182         case 0x3a:
183         case 0x8a:
184         case 0x88:
185         case 0x89:
186         case 0x8b:
187                 switch (mod) {
188                 case 0:
189                         advance = 2 + (rm == 4) + extra;
190                         break;
191                 case 1:
192                         advance = 3 + (rm == 4) + extra;
193                         break;
194                 case 2:
195                         advance = 6 + (rm == 4) + extra;
196                         break;
197                 case 3:
198                         advance = 2 + extra;
199                         break;
200                 }
201                 break;
202         }
203         return advance;
204 }
205
206 // This is a very limited function. It's only here to manage virtio-mmio and low memory
207 // pointer loads. I am hoping it won't grow with time. The intent is that we enter it with
208 // and EPT fault from a region that is deliberately left unbacked by any memory. We return
209 // enough info to let you emulate the operation if you want. Because we have the failing physical
210 // address (gpa) the decode is far simpler because we only need to find the register, how many bytes
211 // to move, and how big the instruction is. I thought about bringing in emulate.c from kvm from xen,
212 // but it has way more stuff than we need.
213 // gpa is a pointer to the gpa.
214 // int is the reg index which we can use for printing info.
215 // regp points to the register in hw_trapframe from which
216 // to load or store a result.
217 int decode(struct guest_thread *vm_thread, uint64_t *gpa, uint8_t *destreg,
218            uint64_t **regp, int *store, int *size, int *advance)
219 {
220         struct vm_trapframe *vm_tf = &(vm_thread->uthread.u_ctx.tf.vm_tf);
221         uint8_t *rip_gpa = NULL;
222
223         DPRINTF("v is %p\n", vm_tf);
224
225         // Duh, which way did he go George? Which way did he go?
226         // First hit on Google gets you there!
227         // This is the guest physical address of the access.
228         // This is nice, because if we ever go with more complete
229         // instruction decode, knowing this gpa reduces our work:
230         // we don't have to find the source address in registers,
231         // only the register holding or receiving the value.
232         *gpa = vm_tf->tf_guest_pa;
233         DPRINTF("gpa is %p\n", *gpa);
234
235         DPRINTF("rip is %p\n", vm_tf->tf_rip);
236
237         if (rippa(vm_thread, (uint64_t *)&rip_gpa))
238                 return VM_PAGE_FAULT;
239         DPRINTF("rip_gpa is %p\n", rip_gpa);
240
241         // fail fast. If we can't get the size we're done.
242         *size = target(rip_gpa, store);
243         DPRINTF("store is %d\n", *store);
244         if (*size < 0)
245                 return -1;
246
247         *advance = insize(rip_gpa);
248
249         uint16_t ins = *(uint16_t *)(rip_gpa +
250             ((rip_gpa[0] == 0x44) || (rip_gpa[0] == 0x0f) || (rip_gpa[0] == 0x41)));
251
252         DPRINTF("ins is %04x\n", ins);
253
254         *destreg = (ins>>11) & 7;
255         *destreg += 8 * (rip_gpa[0] == 0x44);
256         // Our primitive approach wins big here.
257         // We don't have to decode the register or the offset used
258         // in the computation; that was done by the CPU and is the gpa.
259         // All we need to know is which destination or source register it is.
260         switch (*destreg) {
261         case 0:
262                 *regp = &vm_tf->tf_rax;
263                 break;
264         case 1:
265                 *regp = &vm_tf->tf_rcx;
266                 break;
267         case 2:
268                 *regp = &vm_tf->tf_rdx;
269                 break;
270         case 3:
271                 *regp = &vm_tf->tf_rbx;
272                 break;
273         case 4:
274                 *regp = &vm_tf->tf_rsp; // uh, right.
275                 break;
276         case 5:
277                 *regp = &vm_tf->tf_rbp;
278                 break;
279         case 6:
280                 *regp = &vm_tf->tf_rsi;
281                 break;
282         case 7:
283                 *regp = &vm_tf->tf_rdi;
284                 break;
285         case 8:
286                 *regp = &vm_tf->tf_r8;
287                 break;
288         case 9:
289                 *regp = &vm_tf->tf_r9;
290                 break;
291         case 10:
292                 *regp = &vm_tf->tf_r10;
293                 break;
294         case 11:
295                 *regp = &vm_tf->tf_r11;
296                 break;
297         case 12:
298                 *regp = &vm_tf->tf_r12;
299                 break;
300         case 13:
301                 *regp = &vm_tf->tf_r13;
302                 break;
303         case 14:
304                 *regp = &vm_tf->tf_r14;
305                 break;
306         case 15:
307                 *regp = &vm_tf->tf_r15;
308                 break;
309         }
310         return 0;
311 }