1 #ifndef __VMM_EMULATE_H
2 #define __VMM_EMULATE_H
3 #include <palacios/vm_guest.h>
4 #include <palacios/vmm.h>
7 * This is where we do the hideous X86 instruction parsing among other things
8 * We can parse out the instruction prefixes, as well as decode the operands
11 typedef enum {INVALID_OPERAND, REG_OPERAND, MEM_OPERAND} operand_type_t;
22 struct x86_prefix_list {
26 /* This parses an instruction
27 * All addresses in arguments are in the host address space
29 int v3_parse_instr(struct guest_info * info, // input
30 char * instr_ptr, // input
31 uint_t * instr_length, // output
32 addr_t * opcode, // output
33 uint_t * opcode_length, // output
34 struct x86_prefix_list * prefixes, // output
35 struct x86_operand * src_operand, // output
36 struct x86_operand * dst_operand, // output
37 struct x86_operand * extra_operand); // output
42 * JRL: Some of this was taken from the Xen sources...
45 #define PACKED __attribute__((packed))
47 #define MODRM_MOD(x) ((x >> 6) & 0x3)
48 #define MODRM_REG(x) ((x >> 3) & 0x7)
49 #define MODRM_RM(x) (x & 0x7)
53 uint_t reg : 3 PACKED;
54 uint_t mod : 2 PACKED;
58 #define SIB_BASE(x) ((x >> 6) & 0x3)
59 #define SIB_INDEX(x) ((x >> 3) & 0x7)
60 #define SIB_SCALE(x) (x & 0x7)
63 uint_t base : 3 PACKED;
64 uint_t index : 3 PACKED;
65 uint_t scale : 2 PACKED;
70 #define MAKE_INSTR(nm, ...) static const uchar_t OPCODE_##nm[] = { __VA_ARGS__ }
73 * Here's how it works:
75 * Following bytes: Opcode bytes.
76 * Special case: Last byte, if zero, doesn't need to match.
78 MAKE_INSTR(INVD, 2, 0x0f, 0x08);
79 MAKE_INSTR(CPUID, 2, 0x0f, 0xa2);
80 MAKE_INSTR(RDMSR, 2, 0x0f, 0x32);
81 MAKE_INSTR(WRMSR, 2, 0x0f, 0x30);
82 MAKE_INSTR(RDTSC, 2, 0x0f, 0x31);
83 MAKE_INSTR(RDTSCP, 3, 0x0f, 0x01, 0xf9);
84 MAKE_INSTR(CLI, 1, 0xfa);
85 MAKE_INSTR(STI, 1, 0xfb);
86 MAKE_INSTR(RDPMC, 2, 0x0f, 0x33);
87 MAKE_INSTR(CLGI, 3, 0x0f, 0x01, 0xdd);
88 MAKE_INSTR(STGI, 3, 0x0f, 0x01, 0xdc);
89 MAKE_INSTR(VMRUN, 3, 0x0f, 0x01, 0xd8);
90 MAKE_INSTR(VMLOAD, 3, 0x0f, 0x01, 0xda);
91 MAKE_INSTR(VMSAVE, 3, 0x0f, 0x01, 0xdb);
92 MAKE_INSTR(VMCALL, 3, 0x0f, 0x01, 0xd9);
93 MAKE_INSTR(PAUSE, 2, 0xf3, 0x90);
94 MAKE_INSTR(SKINIT, 3, 0x0f, 0x01, 0xde);
95 MAKE_INSTR(MOV2CR, 3, 0x0f, 0x22, 0x00);
96 MAKE_INSTR(MOVCR2, 3, 0x0f, 0x20, 0x00);
97 MAKE_INSTR(MOV2DR, 3, 0x0f, 0x23, 0x00);
98 MAKE_INSTR(MOVDR2, 3, 0x0f, 0x21, 0x00);
99 MAKE_INSTR(PUSHF, 1, 0x9c);
100 MAKE_INSTR(POPF, 1, 0x9d);
101 MAKE_INSTR(RSM, 2, 0x0f, 0xaa);
102 MAKE_INSTR(INVLPG, 3, 0x0f, 0x01, 0x00);
103 MAKE_INSTR(INVLPGA,3, 0x0f, 0x01, 0xdf);
104 MAKE_INSTR(HLT, 1, 0xf4);
105 MAKE_INSTR(CLTS, 2, 0x0f, 0x06);
106 MAKE_INSTR(LMSW, 3, 0x0f, 0x01, 0x00);
107 MAKE_INSTR(SMSW, 3, 0x0f, 0x01, 0x00);
110 static const uchar_t PREFIX_LOCK = 0xF0;
111 static const uchar_t PREFIX_REPNE = 0xF2;
112 static const uchar_t PREFIX_REPNZ = 0xF2;
113 static const uchar_t PREFIX_REP = 0xF3;
114 static const uchar_t PREFIX_REPE = 0xF3;
115 static const uchar_t PREFIX_REPZ = 0xF3;
116 static const uchar_t PREFIX_CS_OVERRIDE = 0x2E;
117 static const uchar_t PREFIX_SS_OVERRIDE = 0x36;
118 static const uchar_t PREFIX_DS_OVERRIDE = 0x3E;
119 static const uchar_t PREFIX_ES_OVERRIDE = 0x26;
120 static const uchar_t PREFIX_FS_OVERRIDE = 0x64;
121 static const uchar_t PREFIX_GS_OVERRIDE = 0x65;
122 static const uchar_t PREFIX_BR_NOT_TAKEN = 0x2E;
123 static const uchar_t PREFIX_BR_TAKEN = 0x3E;
124 static const uchar_t PREFIX_OP_SIZE = 0x66;
125 static const uchar_t PREFIX_ADDR_SIZE = 0x67;
127 static inline int is_prefix_byte(char byte) {
130 case 0xF2: // REPNE/REPNZ
131 case 0xF3: // REP or REPE/REPZ
132 case 0x2E: // CS override or Branch hint not taken (with Jcc instrs)
133 case 0x36: // SS override
134 case 0x3E: // DS override or Branch hint taken (with Jcc instrs)
135 case 0x26: // ES override
136 case 0x64: // FS override
137 case 0x65: // GS override
138 //case 0x2E: // branch not taken hint
139 // case 0x3E: // branch taken hint
140 case 0x66: // operand size override
141 case 0x67: // address size override
151 static inline v3_reg_t get_gpr_mask(struct guest_info * info) {
152 switch (info->cpu_mode) {
166 static inline addr_t get_addr_linear(struct guest_info * info, addr_t addr, struct v3_segment * seg) {
167 switch (info->cpu_mode) {
169 return addr + (seg->selector << 4);
173 return addr + seg->base;
182 typedef enum {INVALID_ADDR_TYPE, REG, DISP0, DISP8, DISP16, DISP32} modrm_mode_t;
183 typedef enum {INVALID_REG_SIZE, REG64, REG32, REG16, REG8} reg_size_t;
192 static inline addr_t decode_register(struct v3_gprs * gprs, char reg_code, reg_size_t reg_size) {
197 reg_addr = (addr_t)&(gprs->rax);
200 reg_addr = (addr_t)&(gprs->rcx);
203 reg_addr = (addr_t)&(gprs->rdx);
206 reg_addr = (addr_t)&(gprs->rbx);
209 if (reg_size == REG8) {
210 reg_addr = (addr_t)&(gprs->rax) + 1;
212 reg_addr = (addr_t)&(gprs->rsp);
216 if (reg_size == REG8) {
217 reg_addr = (addr_t)&(gprs->rcx) + 1;
219 reg_addr = (addr_t)&(gprs->rbp);
223 if (reg_size == REG8) {
224 reg_addr = (addr_t)&(gprs->rdx) + 1;
226 reg_addr = (addr_t)&(gprs->rsi);
230 if (reg_size == REG8) {
231 reg_addr = (addr_t)&(gprs->rbx) + 1;
233 reg_addr = (addr_t)&(gprs->rdi);
246 static inline operand_type_t decode_operands16(struct v3_gprs * gprs, // input/output
247 char * modrm_instr, // input
248 int * offset, // output
249 addr_t * first_operand, // output
250 addr_t * second_operand, // output
251 reg_size_t reg_size) { // input
253 struct modrm_byte * modrm = (struct modrm_byte *)modrm_instr;
254 addr_t base_addr = 0;
255 modrm_mode_t mod_mode = 0;
256 operand_type_t addr_type = INVALID_OPERAND;
257 char * instr_cursor = modrm_instr;
259 PrintDebug("ModRM mod=%d\n", modrm->mod);
263 if (modrm->mod == 3) {
265 addr_type = REG_OPERAND;
266 PrintDebug("first operand = Register (RM=%d)\n",modrm->rm);
268 *first_operand = decode_register(gprs, modrm->rm, reg_size);
272 addr_type = MEM_OPERAND;
274 if (modrm->mod == 0) {
276 } else if (modrm->mod == 1) {
278 } else if (modrm->mod == 2) {
284 base_addr = gprs->rbx + gprs->rsi;
287 base_addr = gprs->rbx + gprs->rdi;
290 base_addr = gprs->rbp + gprs->rsi;
293 base_addr = gprs->rbp + gprs->rdi;
296 base_addr = gprs->rsi;
299 base_addr = gprs->rdi;
302 if (modrm->mod == 0) {
306 base_addr = gprs->rbp;
310 base_addr = gprs->rbx;
316 if (mod_mode == DISP8) {
317 base_addr += (uchar_t)*(instr_cursor);
319 } else if (mod_mode == DISP16) {
320 base_addr += (ushort_t)*(instr_cursor);
324 *first_operand = base_addr;
327 *offset += (instr_cursor - modrm_instr);
328 *second_operand = decode_register(gprs, modrm->reg, reg_size);
335 static inline operand_type_t decode_operands32(struct v3_gprs * gprs, // input/output
336 char * modrm_instr, // input
337 int * offset, // output
338 addr_t * first_operand, // output
339 addr_t * second_operand, // output
340 reg_size_t reg_size) { // input
342 char * instr_cursor = modrm_instr;
343 struct modrm_byte * modrm = (struct modrm_byte *)modrm_instr;
344 addr_t base_addr = 0;
345 modrm_mode_t mod_mode = 0;
346 uint_t has_sib_byte = 0;
347 operand_type_t addr_type = INVALID_OPERAND;
353 if (modrm->mod == 3) {
355 addr_type = REG_OPERAND;
357 PrintDebug("first operand = Register (RM=%d)\n",modrm->rm);
359 *first_operand = decode_register(gprs, modrm->rm, reg_size);
363 addr_type = MEM_OPERAND;
365 if (modrm->mod == 0) {
367 } else if (modrm->mod == 1) {
369 } else if (modrm->mod == 2) {
375 base_addr = gprs->rax;
378 base_addr = gprs->rcx;
381 base_addr = gprs->rdx;
384 base_addr = gprs->rbx;
390 if (modrm->mod == 0) {
394 base_addr = gprs->rbp;
398 base_addr = gprs->rsi;
401 base_addr = gprs->rdi;
407 struct sib_byte * sib = (struct sib_byte *)(instr_cursor);
413 if (sib->scale == 1) {
415 } else if (sib->scale == 2) {
417 } else if (sib->scale == 3) {
422 switch (sib->index) {
424 base_addr = gprs->rax;
427 base_addr = gprs->rcx;
430 base_addr = gprs->rdx;
433 base_addr = gprs->rbx;
439 base_addr = gprs->rbp;
442 base_addr = gprs->rsi;
445 base_addr = gprs->rdi;
454 base_addr += gprs->rax;
457 base_addr += gprs->rcx;
460 base_addr += gprs->rdx;
463 base_addr += gprs->rbx;
466 base_addr += gprs->rsp;
469 if (modrm->mod != 0) {
470 base_addr += gprs->rbp;
474 base_addr += gprs->rsi;
477 base_addr += gprs->rdi;
484 if (mod_mode == DISP8) {
485 base_addr += (uchar_t)*(instr_cursor);
487 } else if (mod_mode == DISP32) {
488 base_addr += (uint_t)*(instr_cursor);
493 *first_operand = base_addr;
496 *offset += (instr_cursor - modrm_instr);
498 *second_operand = decode_register(gprs, modrm->reg, reg_size);