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>
16 static xed_state_t decoder_state;
18 #define GPR_REGISTER 0
19 #define SEGMENT_REGISTER 1
20 #define CTRL_REGISTER 2
21 #define DEBUG_REGISTER 3
25 /* Disgusting mask hack...
26 I can't think right now, so we'll do it this way...
28 static const ullong_t mask_1 = 0x00000000000000ffLL;
29 static const ullong_t mask_2 = 0x000000000000ffffLL;
30 static const ullong_t mask_4 = 0x00000000ffffffffLL;
31 static const ullong_t mask_8 = 0xffffffffffffffffLL;
34 #define MASK(val, length) ({ \
35 ullong_t mask = 0x0LL; \
48 struct memory_operand {
56 uint_t displacement_size;
57 ullong_t displacement;
62 // This returns a pointer to a V3_OPCODE_[*] array defined in vmm_decoder.h
63 static int get_opcode(xed_iform_enum_t iform, addr_t * opcode);
65 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);
66 static int get_memory_operand(struct guest_info * info, xed_decoded_inst_t * xed_instr, uint_t index, struct x86_operand * operand);
68 static int set_decoder_mode(struct guest_info * info, xed_state_t * state) {
69 switch (info->cpu_mode) {
71 if (state->mmode != XED_MACHINE_MODE_LEGACY_16) {
73 XED_MACHINE_MODE_LEGACY_16,
74 XED_ADDRESS_WIDTH_16b,
75 XED_ADDRESS_WIDTH_16b);
80 if (state->mmode != XED_MACHINE_MODE_LEGACY_32) {
82 XED_MACHINE_MODE_LEGACY_32,
83 XED_ADDRESS_WIDTH_32b,
84 XED_ADDRESS_WIDTH_32b);
88 if (state->mmode != XED_MACHINE_MODE_LONG_64) {
89 state->mmode = XED_MACHINE_MODE_LONG_64;
98 int is_flags_reg(xed_reg_enum_t xed_reg) {
113 xed_state_zero(&decoder_state);
118 int v3_basic_mem_decode(struct guest_info * info, addr_t instr_ptr, uint_t * size, uint_t * instr_length) {
119 xed_decoded_inst_t xed_instr;
120 xed_error_enum_t xed_error;
123 if (set_decoder_mode(info, &decoder_state) == -1) {
124 PrintError("Could not set decoder mode\n");
129 xed_decoded_inst_zero_set_mode(&xed_instr, &decoder_state);
131 xed_error = xed_decode(&xed_instr,
132 REINTERPRET_CAST(const xed_uint8_t *, instr_ptr),
133 XED_MAX_INSTRUCTION_BYTES);
135 if (xed_error != XED_ERROR_NONE) {
136 PrintError("Xed error: %s\n", xed_error_enum_t2str(xed_error));
140 *instr_length = xed_decoded_inst_get_length(&xed_instr);
143 if (xed_decoded_inst_number_of_memory_operands(&xed_instr) == 0) {
144 PrintError("Tried to decode memory operation with no memory operands\n");
148 *size = xed_decoded_inst_get_memory_operand_length(&xed_instr,0);
155 int v3_decode(struct guest_info * info, addr_t instr_ptr, struct x86_instr * instr) {
156 xed_decoded_inst_t xed_instr;
157 xed_error_enum_t xed_error;
161 if (set_decoder_mode(info, &decoder_state) == -1) {
162 PrintError("Could not set decoder mode\n");
168 xed_decoded_inst_zero_set_mode(&xed_instr, &decoder_state);
170 xed_error = xed_decode(&xed_instr,
171 REINTERPRET_CAST(const xed_uint8_t *, instr_ptr),
172 XED_MAX_INSTRUCTION_BYTES);
175 if (xed_error != XED_ERROR_NONE) {
176 PrintError("Xed error: %s\n", xed_error_enum_t2str(xed_error));
180 const xed_inst_t * xi = xed_decoded_inst_inst(&xed_instr);
182 instr->instr_length = xed_decoded_inst_get_length(&xed_instr);
183 instr->num_operands = xed_decoded_inst_noperands(&xed_instr);
185 xed_iform_enum_t iform = xed_decoded_inst_get_iform_enum(&xed_instr);
188 PrintDebug("iform=%s\n", xed_iform_enum_t2str(iform));
191 if (instr->num_operands > 3) {
192 PrintDebug("Special Case Not Handled\n");
195 } else if (instr->num_operands == 3) {
196 const xed_operand_t * op = xed_inst_operand(xi, 2);
197 xed_operand_enum_t op_enum = xed_operand_name(op);
199 if ((!xed_operand_is_register(op_enum)) ||
200 (!is_flags_reg(xed_decoded_inst_get_reg(&xed_instr, op_enum)))) {
202 PrintDebug("Special Case not handled\n");
211 if (get_opcode(iform, &(instr->opcode)) == -1) {
212 PrintDebug("Could not get opcode. (iform=%s)\n", xed_iform_enum_t2str(iform));
219 //PrintDebug("Number of operands: %d\n", instr->num_operands);
220 //PrintDebug("INSTR length: %d\n", instr->instr_length);
223 if (instr->num_operands >= 1) {
224 const xed_operand_t * op = xed_inst_operand(xi, 0);
225 xed_operand_enum_t op_enum = xed_operand_name(op);
227 struct x86_operand * v3_op = NULL;
229 if (xed_operand_written(op)) {
230 v3_op = &(instr->dst_operand);
232 v3_op = &(instr->src_operand);
236 if (xed_operand_is_register(op_enum)) {
237 xed_reg_enum_t xed_reg = xed_decoded_inst_get_reg(&xed_instr, op_enum);
238 int v3_reg_type = xed_reg_to_v3_reg(info,
243 if (v3_reg_type == -1) {
244 PrintError("First operand is an Unhandled Operand: %s\n", xed_reg_enum_t2str(xed_reg));
245 v3_op->type = INVALID_OPERAND;
247 } else if (v3_reg_type == SEGMENT_REGISTER) {
248 struct v3_segment * seg_reg = (struct v3_segment *)(v3_op->operand);
249 v3_op->operand = (addr_t)&(seg_reg->selector);
252 v3_op->type = REG_OPERAND;
257 case XED_OPERAND_MEM0:
260 struct x86_operand * operand = &(instr->dst_operand);
262 if (xed_decoded_inst_mem_read(&xed_instr, 0)) {
263 operand = &(instr->src_operand);
264 } else if (xed_decoded_inst_mem_written(&xed_instr, 0)) {
265 operand = &(instr->dst_operand);
269 if (get_memory_operand(info, &xed_instr, 0, v3_op) == -1) {
270 PrintError("Could not get first memory operand\n");
276 case XED_OPERAND_MEM1:
277 case XED_OPERAND_IMM1:
279 PrintError("Illegal Operand Order\n");
283 case XED_OPERAND_IMM0:
284 case XED_OPERAND_AGEN:
285 case XED_OPERAND_PTR:
286 case XED_OPERAND_RELBR:
288 PrintError("Unhandled Operand Type\n");
296 // set second operand
297 if (instr->num_operands >= 2) {
298 const xed_operand_t * op = xed_inst_operand(xi, 1);
299 // xed_operand_type_enum_t op_type = xed_operand_type(op);
300 xed_operand_enum_t op_enum = xed_operand_name(op);
302 struct x86_operand * v3_op;
304 if (xed_operand_written(op)) {
305 v3_op = &(instr->dst_operand);
307 v3_op = &(instr->src_operand);
311 if (xed_operand_is_register(op_enum)) {
312 xed_reg_enum_t xed_reg = xed_decoded_inst_get_reg(&xed_instr, op_enum);
313 int v3_reg_type = xed_reg_to_v3_reg(info,
317 if (v3_reg_type == -1) {
318 PrintError("Second operand is an Unhandled Operand: %s\n", xed_reg_enum_t2str(xed_reg));
319 v3_op->type = INVALID_OPERAND;
321 } else if (v3_reg_type == SEGMENT_REGISTER) {
322 struct v3_segment * seg_reg = (struct v3_segment *)(v3_op->operand);
323 v3_op->operand = (addr_t)&(seg_reg->selector);
326 v3_op->type = REG_OPERAND;
333 case XED_OPERAND_MEM0:
337 if (xed_decoded_inst_mem_read(&xed_instr, 0)) {
338 v3_op = &(instr->src_operand);
339 } else if (xed_decoded_inst_mem_written(&xed_instr, 0)) {
340 v3_op = &(instr->dst_operand);
344 if (get_memory_operand(info, &xed_instr, 0, v3_op) == -1) {
345 PrintError("Could not get first memory operand\n");
351 case XED_OPERAND_IMM0:
353 instr->src_operand.size = xed_decoded_inst_get_immediate_width(&xed_instr);
355 if (instr->src_operand.size > 4) {
356 PrintError("Unhandled 64 bit immediates\n");
359 instr->src_operand.operand = xed_decoded_inst_get_unsigned_immediate(&xed_instr);
361 instr->src_operand.type = IMM_OPERAND;
366 case XED_OPERAND_MEM1:
367 case XED_OPERAND_IMM1:
369 PrintError("Illegal Operand Order\n");
372 case XED_OPERAND_AGEN:
373 case XED_OPERAND_PTR:
374 case XED_OPERAND_RELBR:
376 PrintError("Unhandled Operand Type\n");
384 if (instr->num_operands >= 3) {
385 const xed_operand_t * op = xed_inst_operand(xi, 2);
386 // xed_operand_type_enum_t op_type = xed_operand_type(op);
387 xed_operand_enum_t op_enum = xed_operand_name(op);
389 if (xed_operand_is_register(op_enum)) {
390 xed_reg_enum_t xed_reg = xed_decoded_inst_get_reg(&xed_instr, op_enum);
391 int v3_reg_type = xed_reg_to_v3_reg(info,
393 &(instr->third_operand.operand),
394 &(instr->third_operand.size));
396 if (v3_reg_type == -1) {
397 PrintError("Third operand is an Unhandled Operand: %s\n", xed_reg_enum_t2str(xed_reg));
398 instr->third_operand.type = INVALID_OPERAND;
400 } else if (v3_reg_type == SEGMENT_REGISTER) {
401 struct v3_segment * seg_reg = (struct v3_segment *)(instr->third_operand.operand);
402 instr->third_operand.operand = (addr_t)&(seg_reg->selector);
406 instr->third_operand.type = REG_OPERAND;
410 // PrintError("Unhandled third operand type %s\n", xed_operand_type_enum_t2str(op_type));
423 int v3_encode(struct guest_info * info, struct x86_instr * instr, char * instr_buf) {
432 static int get_memory_operand(struct guest_info * info, xed_decoded_inst_t * xed_instr, uint_t op_index, struct x86_operand * operand) {
433 struct memory_operand mem_op;
439 ullong_t displacement;
440 // struct v3_segment * seg_reg;
445 memset((void*)&mem_op, '\0', sizeof(struct memory_operand));
447 xed_reg_enum_t xed_seg = xed_decoded_inst_get_seg_reg(xed_instr, op_index);
448 if (xed_seg != XED_REG_INVALID) {
449 struct v3_segment *tmp_segment;
450 if (xed_reg_to_v3_reg(info, xed_seg, (addr_t *)&tmp_segment, &(mem_op.segment_size)) == -1) {
451 PrintError("Unhandled Segment Register\n");
454 mem_op.segment = tmp_segment->base;
457 xed_reg_enum_t xed_base = xed_decoded_inst_get_base_reg(xed_instr, op_index);
458 if (xed_base != XED_REG_INVALID) {
460 if (xed_reg_to_v3_reg(info, xed_base, &base_reg, &(mem_op.base_size)) == -1) {
461 PrintError("Unhandled Base register\n");
464 mem_op.base = *(addr_t *)base_reg;
469 xed_reg_enum_t xed_idx = xed_decoded_inst_get_index_reg(xed_instr, op_index);
470 if ((op_index == 0) && (xed_idx != XED_REG_INVALID)) {
473 if (xed_reg_to_v3_reg(info, xed_idx, &index_reg, &(mem_op.index_size)) == -1) {
474 PrintError("Unhandled Index Register\n");
478 mem_op.index= *(addr_t *)index_reg;
480 xed_uint_t xed_scale = xed_decoded_inst_get_scale(xed_instr, op_index);
481 if (xed_scale != 0) {
482 mem_op.scale = xed_scale;
487 xed_uint_t disp_bits = xed_decoded_inst_get_memory_displacement_width(xed_instr, op_index);
489 xed_int64_t xed_disp = xed_decoded_inst_get_memory_displacement(xed_instr, op_index);
491 mem_op.displacement_size = disp_bits / 8;
492 mem_op.displacement = xed_disp;
496 operand->type = MEM_OPERAND;
497 operand->size = xed_decoded_inst_get_memory_operand_length(xed_instr, op_index);
501 PrintDebug("Struct: Seg=%x, base=%x, index=%x, scale=%x, displacement=%x\n",
502 mem_op.segment, mem_op.base, mem_op.index, mem_op.scale, mem_op.displacement);
505 seg = mem_op.segment;
506 base = MASK(mem_op.base, mem_op.base_size);
507 index = MASK(mem_op.index, mem_op.index_size);
508 scale = mem_op.scale;
509 displacement = MASK(mem_op.displacement, mem_op.displacement_size);
511 PrintDebug("Seg=%x, base=%x, index=%x, scale=%x, displacement=%x\n", seg, base, index, scale, displacement);
513 operand->operand = seg + base + (scale * index) + displacement;
518 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) {
521 case XED_REG_INVALID:
530 *v3_reg = (addr_t)&(info->vm_regs.rax);
534 *v3_reg = (addr_t)&(info->vm_regs.rax);
538 *v3_reg = (addr_t)&(info->vm_regs.rax);
542 *v3_reg = (addr_t)(&(info->vm_regs.rax)) + 1;
546 *v3_reg = (addr_t)&(info->vm_regs.rax);
551 *v3_reg = (addr_t)&(info->vm_regs.rcx);
555 *v3_reg = (addr_t)&(info->vm_regs.rcx);
559 *v3_reg = (addr_t)&(info->vm_regs.rcx);
563 *v3_reg = (addr_t)(&(info->vm_regs.rcx)) + 1;
567 *v3_reg = (addr_t)&(info->vm_regs.rcx);
572 *v3_reg = (addr_t)&(info->vm_regs.rdx);
576 *v3_reg = (addr_t)&(info->vm_regs.rdx);
580 *v3_reg = (addr_t)&(info->vm_regs.rdx);
584 *v3_reg = (addr_t)(&(info->vm_regs.rdx)) + 1;
588 *v3_reg = (addr_t)&(info->vm_regs.rdx);
593 *v3_reg = (addr_t)&(info->vm_regs.rbx);
597 *v3_reg = (addr_t)&(info->vm_regs.rbx);
601 *v3_reg = (addr_t)&(info->vm_regs.rbx);
605 *v3_reg = (addr_t)(&(info->vm_regs.rbx)) + 1;
609 *v3_reg = (addr_t)&(info->vm_regs.rbx);
615 *v3_reg = (addr_t)&(info->vm_regs.rsp);
619 *v3_reg = (addr_t)&(info->vm_regs.rsp);
623 *v3_reg = (addr_t)&(info->vm_regs.rsp);
627 *v3_reg = (addr_t)&(info->vm_regs.rsp);
632 *v3_reg = (addr_t)&(info->vm_regs.rbp);
636 *v3_reg = (addr_t)&(info->vm_regs.rbp);
640 *v3_reg = (addr_t)&(info->vm_regs.rbp);
644 *v3_reg = (addr_t)&(info->vm_regs.rbp);
651 *v3_reg = (addr_t)&(info->vm_regs.rsi);
655 *v3_reg = (addr_t)&(info->vm_regs.rsi);
659 *v3_reg = (addr_t)&(info->vm_regs.rsi);
663 *v3_reg = (addr_t)&(info->vm_regs.rsi);
669 *v3_reg = (addr_t)&(info->vm_regs.rdi);
673 *v3_reg = (addr_t)&(info->vm_regs.rdi);
677 *v3_reg = (addr_t)&(info->vm_regs.rdi);
681 *v3_reg = (addr_t)&(info->vm_regs.rdi);
690 *v3_reg = (addr_t)&(info->rip);
692 return CTRL_REGISTER;
694 *v3_reg = (addr_t)&(info->rip);
696 return CTRL_REGISTER;
698 *v3_reg = (addr_t)&(info->rip);
700 return CTRL_REGISTER;
703 *v3_reg = (addr_t)&(info->ctrl_regs.rflags);
705 return CTRL_REGISTER;
707 *v3_reg = (addr_t)&(info->ctrl_regs.rflags);
709 return CTRL_REGISTER;
711 *v3_reg = (addr_t)&(info->ctrl_regs.rflags);
713 return CTRL_REGISTER;
716 *v3_reg = (addr_t)&(info->ctrl_regs.cr0);
718 return CTRL_REGISTER;
720 *v3_reg = (addr_t)&(info->ctrl_regs.cr2);
722 return CTRL_REGISTER;
724 *v3_reg = (addr_t)&(info->ctrl_regs.cr3);
726 return CTRL_REGISTER;
728 *v3_reg = (addr_t)&(info->ctrl_regs.cr4);
730 return CTRL_REGISTER;
732 *v3_reg = (addr_t)&(info->ctrl_regs.cr8);
734 return CTRL_REGISTER;
756 *v3_reg = (addr_t)&(info->segments.cs);
757 return SEGMENT_REGISTER;
759 *v3_reg = (addr_t)&(info->segments.ds);
760 return SEGMENT_REGISTER;
762 *v3_reg = (addr_t)&(info->segments.es);
763 return SEGMENT_REGISTER;
765 *v3_reg = (addr_t)&(info->segments.ss);
766 return SEGMENT_REGISTER;
768 *v3_reg = (addr_t)&(info->segments.fs);
769 return SEGMENT_REGISTER;
771 *v3_reg = (addr_t)&(info->segments.gs);
772 return SEGMENT_REGISTER;
779 PrintError("Segment selector operand... Don't know how to handle this...\n");
882 case XED_REG_STACKPUSH:
883 case XED_REG_STACKPOP:
889 case XED_REG_X87CONTROL:
890 case XED_REG_X87STATUS:
893 case XED_REG_X87PUSH:
895 case XED_REG_X87POP2:
930 static int get_opcode(xed_iform_enum_t iform, addr_t * opcode) {
933 case XED_IFORM_MOV_CR_GPR64_CR:
934 case XED_IFORM_MOV_CR_GPR32_CR:
935 *opcode = (addr_t)&V3_OPCODE_MOVCR2;
938 case XED_IFORM_MOV_CR_CR_GPR64:
939 case XED_IFORM_MOV_CR_CR_GPR32:
940 *opcode = (addr_t)&V3_OPCODE_MOV2CR;
944 case XED_IFORM_LMSW_GPR16:
945 *opcode = (addr_t)&V3_OPCODE_LMSW;
949 *opcode = (addr_t)&V3_OPCODE_CLTS;