1 #ifdef __DECODER_TEST__
2 #include "vmm_decoder.h"
4 #include <xed/xed-interface.h>
8 #include <palacios/vmm_decoder.h>
9 #include <palacios/vmm_xed.h>
10 #include <xed/xed-interface.h>
11 #include <palacios/vm_guest.h>
12 #include <palacios/vmm.h>
17 static xed_state_t decoder_state;
19 #define GPR_REGISTER 0
20 #define SEGMENT_REGISTER 1
21 #define CTRL_REGISTER 2
22 #define DEBUG_REGISTER 3
26 /* Disgusting mask hack...
27 I can't think right now, so we'll do it this way...
29 static const ullong_t mask_1 = 0x00000000000000ffLL;
30 static const ullong_t mask_2 = 0x000000000000ffffLL;
31 static const ullong_t mask_4 = 0x00000000ffffffffLL;
32 static const ullong_t mask_8 = 0xffffffffffffffffLL;
35 #define MASK(val, length) ({ \
36 ullong_t mask = 0x0LL; \
49 struct memory_operand {
57 uint_t displacement_size;
58 ullong_t displacement;
63 // This returns a pointer to a V3_OPCODE_[*] array defined in vmm_decoder.h
64 static int get_opcode(xed_iform_enum_t iform, addr_t * opcode);
66 static int xed_reg_to_v3_reg(struct guest_info * info, xed_reg_enum_t xed_reg, addr_t * v3_reg, uint_t * reg_len);
67 static int get_memory_operand(struct guest_info * info, xed_decoded_inst_t * xed_instr, uint_t index, struct x86_operand * operand);
69 static int set_decoder_mode(struct guest_info * info, xed_state_t * state) {
70 switch (info->cpu_mode) {
72 if (state->mmode != XED_MACHINE_MODE_LEGACY_16) {
74 XED_MACHINE_MODE_LEGACY_16,
75 XED_ADDRESS_WIDTH_16b,
76 XED_ADDRESS_WIDTH_16b);
81 if (state->mmode != XED_MACHINE_MODE_LEGACY_32) {
83 XED_MACHINE_MODE_LEGACY_32,
84 XED_ADDRESS_WIDTH_32b,
85 XED_ADDRESS_WIDTH_32b);
89 if (state->mmode != XED_MACHINE_MODE_LONG_64) {
90 state->mmode = XED_MACHINE_MODE_LONG_64;
99 int is_flags_reg(xed_reg_enum_t xed_reg) {
114 xed_state_zero(&decoder_state);
120 int v3_basic_mem_decode(struct guest_info * info, addr_t instr_ptr, struct basic_instr_info * instr_info) {
121 xed_decoded_inst_t xed_instr;
122 xed_error_enum_t xed_error;
125 if (set_decoder_mode(info, &decoder_state) == -1) {
126 PrintError("Could not set decoder mode\n");
131 xed_decoded_inst_zero_set_mode(&xed_instr, &decoder_state);
133 xed_error = xed_decode(&xed_instr,
134 REINTERPRET_CAST(const xed_uint8_t *, instr_ptr),
135 XED_MAX_INSTRUCTION_BYTES);
137 if (xed_error != XED_ERROR_NONE) {
138 PrintError("Xed error: %s\n", xed_error_enum_t2str(xed_error));
142 instr_info->instr_length = xed_decoded_inst_get_length(&xed_instr);
145 if (xed_decoded_inst_number_of_memory_operands(&xed_instr) == 0) {
146 PrintError("Tried to decode memory operation with no memory operands\n");
150 instr_info->op_size = xed_decoded_inst_get_memory_operand_length(&xed_instr, 0);
153 xed_category_enum_t cat = xed_decoded_inst_get_category(&xed_instr);
154 if (cat == XED_CATEGORY_STRINGOP) {
155 instr_info->str_op = 1;
157 instr_info->str_op = 0;
160 xed_operand_values_t * operands = xed_decoded_inst_operands(&xed_instr);
161 if (xed_operand_values_has_real_rep(operands)) {
162 instr_info->has_rep = 1;
164 instr_info->has_rep = 0;
172 int v3_decode(struct guest_info * info, addr_t instr_ptr, struct x86_instr * instr) {
173 xed_decoded_inst_t xed_instr;
174 xed_error_enum_t xed_error;
178 if (set_decoder_mode(info, &decoder_state) == -1) {
179 PrintError("Could not set decoder mode\n");
185 xed_decoded_inst_zero_set_mode(&xed_instr, &decoder_state);
187 xed_error = xed_decode(&xed_instr,
188 REINTERPRET_CAST(const xed_uint8_t *, instr_ptr),
189 XED_MAX_INSTRUCTION_BYTES);
192 if (xed_error != XED_ERROR_NONE) {
193 PrintError("Xed error: %s\n", xed_error_enum_t2str(xed_error));
197 const xed_inst_t * xi = xed_decoded_inst_inst(&xed_instr);
199 instr->instr_length = xed_decoded_inst_get_length(&xed_instr);
200 instr->num_operands = xed_decoded_inst_noperands(&xed_instr);
202 xed_iform_enum_t iform = xed_decoded_inst_get_iform_enum(&xed_instr);
205 PrintDebug("iform=%s\n", xed_iform_enum_t2str(iform));
208 if (instr->num_operands > 3) {
209 PrintDebug("Special Case Not Handled\n");
212 } else if (instr->num_operands == 3) {
213 const xed_operand_t * op = xed_inst_operand(xi, 2);
214 xed_operand_enum_t op_enum = xed_operand_name(op);
216 if ((!xed_operand_is_register(op_enum)) ||
217 (!is_flags_reg(xed_decoded_inst_get_reg(&xed_instr, op_enum)))) {
219 PrintDebug("Special Case not handled\n");
228 if (get_opcode(iform, &(instr->opcode)) == -1) {
229 PrintDebug("Could not get opcode. (iform=%s)\n", xed_iform_enum_t2str(iform));
236 //PrintDebug("Number of operands: %d\n", instr->num_operands);
237 //PrintDebug("INSTR length: %d\n", instr->instr_length);
240 if (instr->num_operands >= 1) {
241 const xed_operand_t * op = xed_inst_operand(xi, 0);
242 xed_operand_enum_t op_enum = xed_operand_name(op);
244 struct x86_operand * v3_op = NULL;
246 if (xed_operand_written(op)) {
247 v3_op = &(instr->dst_operand);
249 v3_op = &(instr->src_operand);
253 if (xed_operand_is_register(op_enum)) {
254 xed_reg_enum_t xed_reg = xed_decoded_inst_get_reg(&xed_instr, op_enum);
255 int v3_reg_type = xed_reg_to_v3_reg(info,
260 if (v3_reg_type == -1) {
261 PrintError("First operand is an Unhandled Operand: %s\n", xed_reg_enum_t2str(xed_reg));
262 v3_op->type = INVALID_OPERAND;
264 } else if (v3_reg_type == SEGMENT_REGISTER) {
265 struct v3_segment * seg_reg = (struct v3_segment *)(v3_op->operand);
266 v3_op->operand = (addr_t)&(seg_reg->selector);
269 v3_op->type = REG_OPERAND;
274 case XED_OPERAND_MEM0:
277 struct x86_operand * operand = &(instr->dst_operand);
279 if (xed_decoded_inst_mem_read(&xed_instr, 0)) {
280 operand = &(instr->src_operand);
281 } else if (xed_decoded_inst_mem_written(&xed_instr, 0)) {
282 operand = &(instr->dst_operand);
286 if (get_memory_operand(info, &xed_instr, 0, v3_op) == -1) {
287 PrintError("Could not get first memory operand\n");
293 case XED_OPERAND_MEM1:
294 case XED_OPERAND_IMM1:
296 PrintError("Illegal Operand Order\n");
300 case XED_OPERAND_IMM0:
301 case XED_OPERAND_AGEN:
302 case XED_OPERAND_PTR:
303 case XED_OPERAND_RELBR:
305 PrintError("Unhandled Operand Type\n");
313 // set second operand
314 if (instr->num_operands >= 2) {
315 const xed_operand_t * op = xed_inst_operand(xi, 1);
316 // xed_operand_type_enum_t op_type = xed_operand_type(op);
317 xed_operand_enum_t op_enum = xed_operand_name(op);
319 struct x86_operand * v3_op;
321 if (xed_operand_written(op)) {
322 v3_op = &(instr->dst_operand);
324 v3_op = &(instr->src_operand);
328 if (xed_operand_is_register(op_enum)) {
329 xed_reg_enum_t xed_reg = xed_decoded_inst_get_reg(&xed_instr, op_enum);
330 int v3_reg_type = xed_reg_to_v3_reg(info,
334 if (v3_reg_type == -1) {
335 PrintError("Second operand is an Unhandled Operand: %s\n", xed_reg_enum_t2str(xed_reg));
336 v3_op->type = INVALID_OPERAND;
338 } else if (v3_reg_type == SEGMENT_REGISTER) {
339 struct v3_segment * seg_reg = (struct v3_segment *)(v3_op->operand);
340 v3_op->operand = (addr_t)&(seg_reg->selector);
343 v3_op->type = REG_OPERAND;
350 case XED_OPERAND_MEM0:
354 if (xed_decoded_inst_mem_read(&xed_instr, 0)) {
355 v3_op = &(instr->src_operand);
356 } else if (xed_decoded_inst_mem_written(&xed_instr, 0)) {
357 v3_op = &(instr->dst_operand);
361 if (get_memory_operand(info, &xed_instr, 0, v3_op) == -1) {
362 PrintError("Could not get first memory operand\n");
368 case XED_OPERAND_IMM0:
370 instr->src_operand.size = xed_decoded_inst_get_immediate_width(&xed_instr);
372 if (instr->src_operand.size > 4) {
373 PrintError("Unhandled 64 bit immediates\n");
376 instr->src_operand.operand = xed_decoded_inst_get_unsigned_immediate(&xed_instr);
378 instr->src_operand.type = IMM_OPERAND;
383 case XED_OPERAND_MEM1:
384 case XED_OPERAND_IMM1:
386 PrintError("Illegal Operand Order\n");
389 case XED_OPERAND_AGEN:
390 case XED_OPERAND_PTR:
391 case XED_OPERAND_RELBR:
393 PrintError("Unhandled Operand Type\n");
401 if (instr->num_operands >= 3) {
402 const xed_operand_t * op = xed_inst_operand(xi, 2);
403 // xed_operand_type_enum_t op_type = xed_operand_type(op);
404 xed_operand_enum_t op_enum = xed_operand_name(op);
406 if (xed_operand_is_register(op_enum)) {
407 xed_reg_enum_t xed_reg = xed_decoded_inst_get_reg(&xed_instr, op_enum);
408 int v3_reg_type = xed_reg_to_v3_reg(info,
410 &(instr->third_operand.operand),
411 &(instr->third_operand.size));
413 if (v3_reg_type == -1) {
414 PrintError("Third operand is an Unhandled Operand: %s\n", xed_reg_enum_t2str(xed_reg));
415 instr->third_operand.type = INVALID_OPERAND;
417 } else if (v3_reg_type == SEGMENT_REGISTER) {
418 struct v3_segment * seg_reg = (struct v3_segment *)(instr->third_operand.operand);
419 instr->third_operand.operand = (addr_t)&(seg_reg->selector);
423 instr->third_operand.type = REG_OPERAND;
427 // PrintError("Unhandled third operand type %s\n", xed_operand_type_enum_t2str(op_type));
440 int v3_encode(struct guest_info * info, struct x86_instr * instr, char * instr_buf) {
449 static int get_memory_operand(struct guest_info * info, xed_decoded_inst_t * xed_instr, uint_t op_index, struct x86_operand * operand) {
450 struct memory_operand mem_op;
456 ullong_t displacement;
457 // struct v3_segment * seg_reg;
462 memset((void*)&mem_op, '\0', sizeof(struct memory_operand));
464 xed_reg_enum_t xed_seg = xed_decoded_inst_get_seg_reg(xed_instr, op_index);
465 if (xed_seg != XED_REG_INVALID) {
466 struct v3_segment *tmp_segment;
467 if (xed_reg_to_v3_reg(info, xed_seg, (addr_t *)&tmp_segment, &(mem_op.segment_size)) == -1) {
468 PrintError("Unhandled Segment Register\n");
471 mem_op.segment = tmp_segment->base;
474 xed_reg_enum_t xed_base = xed_decoded_inst_get_base_reg(xed_instr, op_index);
475 if (xed_base != XED_REG_INVALID) {
477 if (xed_reg_to_v3_reg(info, xed_base, &base_reg, &(mem_op.base_size)) == -1) {
478 PrintError("Unhandled Base register\n");
481 mem_op.base = *(addr_t *)base_reg;
486 xed_reg_enum_t xed_idx = xed_decoded_inst_get_index_reg(xed_instr, op_index);
487 if ((op_index == 0) && (xed_idx != XED_REG_INVALID)) {
490 if (xed_reg_to_v3_reg(info, xed_idx, &index_reg, &(mem_op.index_size)) == -1) {
491 PrintError("Unhandled Index Register\n");
495 mem_op.index= *(addr_t *)index_reg;
497 xed_uint_t xed_scale = xed_decoded_inst_get_scale(xed_instr, op_index);
498 if (xed_scale != 0) {
499 mem_op.scale = xed_scale;
504 xed_uint_t disp_bits = xed_decoded_inst_get_memory_displacement_width(xed_instr, op_index);
506 xed_int64_t xed_disp = xed_decoded_inst_get_memory_displacement(xed_instr, op_index);
508 mem_op.displacement_size = disp_bits / 8;
509 mem_op.displacement = xed_disp;
513 operand->type = MEM_OPERAND;
514 operand->size = xed_decoded_inst_get_memory_operand_length(xed_instr, op_index);
518 PrintDebug("Struct: Seg=%x, base=%x, index=%x, scale=%x, displacement=%x\n",
519 mem_op.segment, mem_op.base, mem_op.index, mem_op.scale, mem_op.displacement);
522 seg = mem_op.segment;
523 base = MASK(mem_op.base, mem_op.base_size);
524 index = MASK(mem_op.index, mem_op.index_size);
525 scale = mem_op.scale;
526 displacement = MASK(mem_op.displacement, mem_op.displacement_size);
528 PrintDebug("Seg=%x, base=%x, index=%x, scale=%x, displacement=%x\n", seg, base, index, scale, displacement);
530 operand->operand = seg + base + (scale * index) + displacement;
535 static int xed_reg_to_v3_reg(struct guest_info * info, xed_reg_enum_t xed_reg, addr_t * v3_reg, uint_t * reg_len) {
538 case XED_REG_INVALID:
547 *v3_reg = (addr_t)&(info->vm_regs.rax);
551 *v3_reg = (addr_t)&(info->vm_regs.rax);
555 *v3_reg = (addr_t)&(info->vm_regs.rax);
559 *v3_reg = (addr_t)(&(info->vm_regs.rax)) + 1;
563 *v3_reg = (addr_t)&(info->vm_regs.rax);
568 *v3_reg = (addr_t)&(info->vm_regs.rcx);
572 *v3_reg = (addr_t)&(info->vm_regs.rcx);
576 *v3_reg = (addr_t)&(info->vm_regs.rcx);
580 *v3_reg = (addr_t)(&(info->vm_regs.rcx)) + 1;
584 *v3_reg = (addr_t)&(info->vm_regs.rcx);
589 *v3_reg = (addr_t)&(info->vm_regs.rdx);
593 *v3_reg = (addr_t)&(info->vm_regs.rdx);
597 *v3_reg = (addr_t)&(info->vm_regs.rdx);
601 *v3_reg = (addr_t)(&(info->vm_regs.rdx)) + 1;
605 *v3_reg = (addr_t)&(info->vm_regs.rdx);
610 *v3_reg = (addr_t)&(info->vm_regs.rbx);
614 *v3_reg = (addr_t)&(info->vm_regs.rbx);
618 *v3_reg = (addr_t)&(info->vm_regs.rbx);
622 *v3_reg = (addr_t)(&(info->vm_regs.rbx)) + 1;
626 *v3_reg = (addr_t)&(info->vm_regs.rbx);
632 *v3_reg = (addr_t)&(info->vm_regs.rsp);
636 *v3_reg = (addr_t)&(info->vm_regs.rsp);
640 *v3_reg = (addr_t)&(info->vm_regs.rsp);
644 *v3_reg = (addr_t)&(info->vm_regs.rsp);
649 *v3_reg = (addr_t)&(info->vm_regs.rbp);
653 *v3_reg = (addr_t)&(info->vm_regs.rbp);
657 *v3_reg = (addr_t)&(info->vm_regs.rbp);
661 *v3_reg = (addr_t)&(info->vm_regs.rbp);
668 *v3_reg = (addr_t)&(info->vm_regs.rsi);
672 *v3_reg = (addr_t)&(info->vm_regs.rsi);
676 *v3_reg = (addr_t)&(info->vm_regs.rsi);
680 *v3_reg = (addr_t)&(info->vm_regs.rsi);
686 *v3_reg = (addr_t)&(info->vm_regs.rdi);
690 *v3_reg = (addr_t)&(info->vm_regs.rdi);
694 *v3_reg = (addr_t)&(info->vm_regs.rdi);
698 *v3_reg = (addr_t)&(info->vm_regs.rdi);
707 *v3_reg = (addr_t)&(info->rip);
709 return CTRL_REGISTER;
711 *v3_reg = (addr_t)&(info->rip);
713 return CTRL_REGISTER;
715 *v3_reg = (addr_t)&(info->rip);
717 return CTRL_REGISTER;
720 *v3_reg = (addr_t)&(info->ctrl_regs.rflags);
722 return CTRL_REGISTER;
724 *v3_reg = (addr_t)&(info->ctrl_regs.rflags);
726 return CTRL_REGISTER;
728 *v3_reg = (addr_t)&(info->ctrl_regs.rflags);
730 return CTRL_REGISTER;
733 *v3_reg = (addr_t)&(info->ctrl_regs.cr0);
735 return CTRL_REGISTER;
737 *v3_reg = (addr_t)&(info->ctrl_regs.cr2);
739 return CTRL_REGISTER;
741 *v3_reg = (addr_t)&(info->ctrl_regs.cr3);
743 return CTRL_REGISTER;
745 *v3_reg = (addr_t)&(info->ctrl_regs.cr4);
747 return CTRL_REGISTER;
749 *v3_reg = (addr_t)&(info->ctrl_regs.cr8);
751 return CTRL_REGISTER;
773 *v3_reg = (addr_t)&(info->segments.cs);
774 return SEGMENT_REGISTER;
776 *v3_reg = (addr_t)&(info->segments.ds);
777 return SEGMENT_REGISTER;
779 *v3_reg = (addr_t)&(info->segments.es);
780 return SEGMENT_REGISTER;
782 *v3_reg = (addr_t)&(info->segments.ss);
783 return SEGMENT_REGISTER;
785 *v3_reg = (addr_t)&(info->segments.fs);
786 return SEGMENT_REGISTER;
788 *v3_reg = (addr_t)&(info->segments.gs);
789 return SEGMENT_REGISTER;
796 PrintError("Segment selector operand... Don't know how to handle this...\n");
899 case XED_REG_STACKPUSH:
900 case XED_REG_STACKPOP:
906 case XED_REG_X87CONTROL:
907 case XED_REG_X87STATUS:
910 case XED_REG_X87PUSH:
912 case XED_REG_X87POP2:
947 static int get_opcode(xed_iform_enum_t iform, addr_t * opcode) {
950 case XED_IFORM_MOV_CR_GPR64_CR:
951 case XED_IFORM_MOV_CR_GPR32_CR:
952 *opcode = (addr_t)&V3_OPCODE_MOVCR2;
955 case XED_IFORM_MOV_CR_CR_GPR64:
956 case XED_IFORM_MOV_CR_CR_GPR32:
957 *opcode = (addr_t)&V3_OPCODE_MOV2CR;
961 case XED_IFORM_LMSW_GPR16:
962 *opcode = (addr_t)&V3_OPCODE_LMSW;
966 *opcode = (addr_t)&V3_OPCODE_CLTS;