1 #ifndef __VMM_EMULATE_H
2 #define __VMM_EMULATE_H
3 #include <palacios/vm_guest.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
13 * JRL: Some of this was taken from the Xen sources...
16 #define PACKED __attribute__((packed))
18 #define MODRM_MOD(x) ((x >> 6) & 0x3)
19 #define MODRM_REG(x) ((x >> 3) & 0x7)
20 #define MODRM_RM(x) (x & 0x7)
24 uint_t reg : 3 PACKED;
25 uint_t mod : 2 PACKED;
29 #define SIB_BASE(x) ((x >> 6) & 0x3)
30 #define SIB_INDEX(x) ((x >> 3) & 0x7)
31 #define SIB_SCALE(x) (x & 0x7)
34 uint_t base : 3 PACKED;
35 uint_t index : 3 PACKED;
36 uint_t scale : 2 PACKED;
41 #define MAKE_INSTR(nm, ...) static const uchar_t OPCODE_##nm[] = { __VA_ARGS__ }
44 * Here's how it works:
46 * Following bytes: Opcode bytes.
47 * Special case: Last byte, if zero, doesn't need to match.
49 MAKE_INSTR(INVD, 2, 0x0f, 0x08);
50 MAKE_INSTR(CPUID, 2, 0x0f, 0xa2);
51 MAKE_INSTR(RDMSR, 2, 0x0f, 0x32);
52 MAKE_INSTR(WRMSR, 2, 0x0f, 0x30);
53 MAKE_INSTR(RDTSC, 2, 0x0f, 0x31);
54 MAKE_INSTR(RDTSCP, 3, 0x0f, 0x01, 0xf9);
55 MAKE_INSTR(CLI, 1, 0xfa);
56 MAKE_INSTR(STI, 1, 0xfb);
57 MAKE_INSTR(RDPMC, 2, 0x0f, 0x33);
58 MAKE_INSTR(CLGI, 3, 0x0f, 0x01, 0xdd);
59 MAKE_INSTR(STGI, 3, 0x0f, 0x01, 0xdc);
60 MAKE_INSTR(VMRUN, 3, 0x0f, 0x01, 0xd8);
61 MAKE_INSTR(VMLOAD, 3, 0x0f, 0x01, 0xda);
62 MAKE_INSTR(VMSAVE, 3, 0x0f, 0x01, 0xdb);
63 MAKE_INSTR(VMCALL, 3, 0x0f, 0x01, 0xd9);
64 MAKE_INSTR(PAUSE, 2, 0xf3, 0x90);
65 MAKE_INSTR(SKINIT, 3, 0x0f, 0x01, 0xde);
66 MAKE_INSTR(MOV2CR, 3, 0x0f, 0x22, 0x00);
67 MAKE_INSTR(MOVCR2, 3, 0x0f, 0x20, 0x00);
68 MAKE_INSTR(MOV2DR, 3, 0x0f, 0x23, 0x00);
69 MAKE_INSTR(MOVDR2, 3, 0x0f, 0x21, 0x00);
70 MAKE_INSTR(PUSHF, 1, 0x9c);
71 MAKE_INSTR(POPF, 1, 0x9d);
72 MAKE_INSTR(RSM, 2, 0x0f, 0xaa);
73 MAKE_INSTR(INVLPG, 3, 0x0f, 0x01, 0x00);
74 MAKE_INSTR(INVLPGA,3, 0x0f, 0x01, 0xdf);
75 MAKE_INSTR(HLT, 1, 0xf4);
76 MAKE_INSTR(CLTS, 2, 0x0f, 0x06);
77 MAKE_INSTR(LMSW, 3, 0x0f, 0x01, 0x00);
78 MAKE_INSTR(SMSW, 3, 0x0f, 0x01, 0x00);
81 static const uchar_t PREFIX_LOCK = 0xF0;
82 static const uchar_t PREFIX_REPNE = 0xF2;
83 static const uchar_t PREFIX_REPNZ = 0xF2;
84 static const uchar_t PREFIX_REP = 0xF3;
85 static const uchar_t PREFIX_REPE = 0xF3;
86 static const uchar_t PREFIX_REPZ = 0xF3;
87 static const uchar_t PREFIX_CS_OVERRIDE = 0x2E;
88 static const uchar_t PREFIX_SS_OVERRIDE = 0x36;
89 static const uchar_t PREFIX_DS_OVERRIDE = 0x3E;
90 static const uchar_t PREFIX_ES_OVERRIDE = 0x26;
91 static const uchar_t PREFIX_FS_OVERRIDE = 0x64;
92 static const uchar_t PREFIX_GS_OVERRIDE = 0x65;
93 static const uchar_t PREFIX_BR_NOT_TAKEN = 0x2E;
94 static const uchar_t PREFIX_BR_TAKEN = 0x3E;
95 static const uchar_t PREFIX_OP_SIZE = 0x66;
96 static const uchar_t PREFIX_ADDR_SIZE = 0x67;
99 static inline int is_prefix_byte(char byte) {
102 case 0xF2: // REPNE/REPNZ
103 case 0xF3: // REP or REPE/REPZ
104 case 0x2E: // CS override or Branch hint not taken (with Jcc instrs)
105 case 0x36: // SS override
106 case 0x3E: // DS override or Branch hint taken (with Jcc instrs)
107 case 0x26: // ES override
108 case 0x64: // FS override
109 case 0x65: // GS override
110 //case 0x2E: // branch not taken hint
111 // case 0x3E: // branch taken hint
112 case 0x66: // operand size override
113 case 0x67: // address size override
123 static inline v3_reg_t get_gpr_mask(struct guest_info * info) {
124 switch (info->cpu_mode) {
138 static inline addr_t get_addr_linear(struct guest_info * info, addr_t addr, struct v3_segment * seg) {
139 switch (info->cpu_mode) {
141 return addr + (seg->selector << 4);
145 return addr + seg->base;
154 typedef enum {INVALID_ADDR_TYPE, REG, DISP0, DISP8, DISP16, DISP32} modrm_mode_t;
155 typedef enum {INVALID_REG_SIZE, REG64, REG32, REG16, REG8} reg_size_t;
156 typedef enum {INVALID_OPERAND, REG_OPERAND, MEM_OPERAND} operand_type_t;
160 static inline addr_t decode_register(struct v3_gprs * gprs, char reg_code, reg_size_t reg_size) {
165 reg_addr = (addr_t)&(gprs->rax);
168 reg_addr = (addr_t)&(gprs->rcx);
171 reg_addr = (addr_t)&(gprs->rdx);
174 reg_addr = (addr_t)&(gprs->rbx);
177 if (reg_size == REG8) {
178 reg_addr = (addr_t)&(gprs->rax) + 1;
180 reg_addr = (addr_t)&(gprs->rsp);
184 if (reg_size == REG8) {
185 reg_addr = (addr_t)&(gprs->rcx) + 1;
187 reg_addr = (addr_t)&(gprs->rbp);
191 if (reg_size == REG8) {
192 reg_addr = (addr_t)&(gprs->rdx) + 1;
194 reg_addr = (addr_t)&(gprs->rsi);
198 if (reg_size == REG8) {
199 reg_addr = (addr_t)&(gprs->rbx) + 1;
201 reg_addr = (addr_t)&(gprs->rdi);
214 static inline operand_type_t decode_operands16(struct v3_gprs * gprs, // input/output
215 char * modrm_instr, // input
216 int * offset, // output
217 addr_t * first_operand, // output
218 addr_t * second_operand, // output
219 reg_size_t reg_size) { // input
221 struct modrm_byte * modrm = (struct modrm_byte *)modrm_instr;
222 addr_t base_addr = 0;
223 modrm_mode_t mod_mode = 0;
224 operand_type_t addr_type = INVALID_OPERAND;
225 char * instr_cursor = modrm_instr;
227 PrintDebug("ModRM mod=%d\n", modrm->mod);
231 if (modrm->mod == 3) {
233 addr_type = REG_OPERAND;
234 PrintDebug("first operand = Register (RM=%d)\n",modrm->rm);
236 *first_operand = decode_register(gprs, modrm->rm, reg_size);
240 addr_type = MEM_OPERAND;
242 if (modrm->mod == 0) {
244 } else if (modrm->mod == 1) {
246 } else if (modrm->mod == 2) {
252 base_addr = gprs->rbx + gprs->rsi;
255 base_addr = gprs->rbx + gprs->rdi;
258 base_addr = gprs->rbp + gprs->rsi;
261 base_addr = gprs->rbp + gprs->rdi;
264 base_addr = gprs->rsi;
267 base_addr = gprs->rdi;
270 if (modrm->mod == 0) {
274 base_addr = gprs->rbp;
278 base_addr = gprs->rbx;
284 if (mod_mode == DISP8) {
285 base_addr += (uchar_t)*(instr_cursor);
287 } else if (mod_mode == DISP16) {
288 base_addr += (ushort_t)*(instr_cursor);
292 *first_operand = base_addr;
295 *offset += (instr_cursor - modrm_instr);
296 *second_operand = decode_register(gprs, modrm->reg, reg_size);
303 static inline operand_type_t decode_operands32(struct v3_gprs * gprs, // input/output
304 char * modrm_instr, // input
305 int * offset, // output
306 addr_t * first_operand, // output
307 addr_t * second_operand, // output
308 reg_size_t reg_size) { // input
310 char * instr_cursor = modrm_instr;
311 struct modrm_byte * modrm = (struct modrm_byte *)modrm_instr;
312 addr_t base_addr = 0;
313 modrm_mode_t mod_mode = 0;
314 uint_t has_sib_byte = 0;
315 operand_type_t addr_type = INVALID_OPERAND;
321 if (modrm->mod == 3) {
323 addr_type = REG_OPERAND;
325 PrintDebug("first operand = Register (RM=%d)\n",modrm->rm);
327 *first_operand = decode_register(gprs, modrm->rm, reg_size);
331 addr_type = MEM_OPERAND;
333 if (modrm->mod == 0) {
335 } else if (modrm->mod == 1) {
337 } else if (modrm->mod == 2) {
343 base_addr = gprs->rax;
346 base_addr = gprs->rcx;
349 base_addr = gprs->rdx;
352 base_addr = gprs->rbx;
358 if (modrm->mod == 0) {
362 base_addr = gprs->rbp;
366 base_addr = gprs->rsi;
369 base_addr = gprs->rdi;
375 struct sib_byte * sib = (struct sib_byte *)(instr_cursor);
381 if (sib->scale == 1) {
383 } else if (sib->scale == 2) {
385 } else if (sib->scale == 3) {
390 switch (sib->index) {
392 base_addr = gprs->rax;
395 base_addr = gprs->rcx;
398 base_addr = gprs->rdx;
401 base_addr = gprs->rbx;
407 base_addr = gprs->rbp;
410 base_addr = gprs->rsi;
413 base_addr = gprs->rdi;
422 base_addr += gprs->rax;
425 base_addr += gprs->rcx;
428 base_addr += gprs->rdx;
431 base_addr += gprs->rbx;
434 base_addr += gprs->rsp;
437 if (modrm->mod != 0) {
438 base_addr += gprs->rbp;
442 base_addr += gprs->rsi;
445 base_addr += gprs->rdi;
452 if (mod_mode == DISP8) {
453 base_addr += (uchar_t)*(instr_cursor);
455 } else if (mod_mode == DISP32) {
456 base_addr += (uint_t)*(instr_cursor);
461 *first_operand = base_addr;
464 *offset += (instr_cursor - modrm_instr);
466 *second_operand = decode_register(gprs, modrm->reg, reg_size);