2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu>
11 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Jack Lange <jarusl@cs.northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
20 #ifdef __DECODER_TEST__
21 #include "vmm_decoder.h"
23 #include <xed/xed-interface.h>
27 #include <palacios/vmm_decoder.h>
28 #include <palacios/vmm_xed.h>
29 #include <xed/xed-interface.h>
30 #include <palacios/vm_guest.h>
31 #include <palacios/vmm.h>
40 #define PrintDebug(fmt, args...)
45 static xed_state_t decoder_state;
47 #define GPR_REGISTER 0
48 #define SEGMENT_REGISTER 1
49 #define CTRL_REGISTER 2
50 #define DEBUG_REGISTER 3
54 /* Disgusting mask hack...
55 I can't think right now, so we'll do it this way...
57 static const ullong_t mask_1 = 0x00000000000000ffLL;
58 static const ullong_t mask_2 = 0x000000000000ffffLL;
59 static const ullong_t mask_4 = 0x00000000ffffffffLL;
60 static const ullong_t mask_8 = 0xffffffffffffffffLL;
63 #define MASK(val, length) ({ \
64 ullong_t mask = 0x0LL; \
77 struct memory_operand {
85 uint_t displacement_size;
86 ullong_t displacement;
91 // This returns a pointer to a V3_OPCODE_[*] array defined in vmm_decoder.h
92 static int get_opcode(xed_iform_enum_t iform, addr_t * opcode);
94 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);
95 static int get_memory_operand(struct guest_info * info, xed_decoded_inst_t * xed_instr, uint_t index, struct x86_operand * operand);
97 static int set_decoder_mode(struct guest_info * info, xed_state_t * state) {
98 switch (info->cpu_mode) {
100 if (state->mmode != XED_MACHINE_MODE_LEGACY_16) {
101 xed_state_init(state,
102 XED_MACHINE_MODE_LEGACY_16,
103 XED_ADDRESS_WIDTH_16b,
104 XED_ADDRESS_WIDTH_16b);
109 if (state->mmode != XED_MACHINE_MODE_LEGACY_32) {
110 xed_state_init(state,
111 XED_MACHINE_MODE_LEGACY_32,
112 XED_ADDRESS_WIDTH_32b,
113 XED_ADDRESS_WIDTH_32b);
117 if (state->mmode != XED_MACHINE_MODE_LONG_64) {
118 state->mmode = XED_MACHINE_MODE_LONG_64;
127 static int is_flags_reg(xed_reg_enum_t xed_reg) {
140 int v3_init_decoder() {
142 xed_state_zero(&decoder_state);
148 int v3_basic_mem_decode(struct guest_info * info, addr_t instr_ptr, struct basic_instr_info * instr_info) {
149 xed_decoded_inst_t xed_instr;
150 xed_error_enum_t xed_error;
153 if (set_decoder_mode(info, &decoder_state) == -1) {
154 PrintError("Could not set decoder mode\n");
159 xed_decoded_inst_zero_set_mode(&xed_instr, &decoder_state);
161 xed_error = xed_decode(&xed_instr,
162 REINTERPRET_CAST(const xed_uint8_t *, instr_ptr),
163 XED_MAX_INSTRUCTION_BYTES);
165 if (xed_error != XED_ERROR_NONE) {
166 PrintError("Xed error: %s\n", xed_error_enum_t2str(xed_error));
170 instr_info->instr_length = xed_decoded_inst_get_length(&xed_instr);
173 if (xed_decoded_inst_number_of_memory_operands(&xed_instr) == 0) {
174 PrintError("Tried to decode memory operation with no memory operands\n");
178 instr_info->op_size = xed_decoded_inst_get_memory_operand_length(&xed_instr, 0);
181 xed_category_enum_t cat = xed_decoded_inst_get_category(&xed_instr);
182 if (cat == XED_CATEGORY_STRINGOP) {
183 instr_info->str_op = 1;
185 instr_info->str_op = 0;
188 xed_operand_values_t * operands = xed_decoded_inst_operands(&xed_instr);
189 if (xed_operand_values_has_real_rep(operands)) {
190 instr_info->has_rep = 1;
192 instr_info->has_rep = 0;
200 int v3_decode(struct guest_info * info, addr_t instr_ptr, struct x86_instr * instr) {
201 xed_decoded_inst_t xed_instr;
202 xed_error_enum_t xed_error;
206 if (set_decoder_mode(info, &decoder_state) == -1) {
207 PrintError("Could not set decoder mode\n");
213 xed_decoded_inst_zero_set_mode(&xed_instr, &decoder_state);
215 xed_error = xed_decode(&xed_instr,
216 REINTERPRET_CAST(const xed_uint8_t *, instr_ptr),
217 XED_MAX_INSTRUCTION_BYTES);
220 if (xed_error != XED_ERROR_NONE) {
221 PrintError("Xed error: %s\n", xed_error_enum_t2str(xed_error));
225 const xed_inst_t * xi = xed_decoded_inst_inst(&xed_instr);
227 instr->instr_length = xed_decoded_inst_get_length(&xed_instr);
228 instr->num_operands = xed_decoded_inst_noperands(&xed_instr);
230 xed_iform_enum_t iform = xed_decoded_inst_get_iform_enum(&xed_instr);
233 PrintDebug("iform=%s\n", xed_iform_enum_t2str(iform));
236 if (instr->num_operands > 3) {
237 PrintDebug("Special Case Not Handled\n");
240 } else if (instr->num_operands == 3) {
241 const xed_operand_t * op = xed_inst_operand(xi, 2);
242 xed_operand_enum_t op_enum = xed_operand_name(op);
244 if ((!xed_operand_is_register(op_enum)) ||
245 (!is_flags_reg(xed_decoded_inst_get_reg(&xed_instr, op_enum)))) {
247 PrintDebug("Special Case not handled\n");
256 if (get_opcode(iform, &(instr->opcode)) == -1) {
257 PrintDebug("Could not get opcode. (iform=%s)\n", xed_iform_enum_t2str(iform));
264 //PrintDebug("Number of operands: %d\n", instr->num_operands);
265 //PrintDebug("INSTR length: %d\n", instr->instr_length);
268 if (instr->num_operands >= 1) {
269 const xed_operand_t * op = xed_inst_operand(xi, 0);
270 xed_operand_enum_t op_enum = xed_operand_name(op);
272 struct x86_operand * v3_op = NULL;
274 if (xed_operand_written(op)) {
275 v3_op = &(instr->dst_operand);
277 v3_op = &(instr->src_operand);
281 if (xed_operand_is_register(op_enum)) {
282 xed_reg_enum_t xed_reg = xed_decoded_inst_get_reg(&xed_instr, op_enum);
283 int v3_reg_type = xed_reg_to_v3_reg(info,
288 if (v3_reg_type == -1) {
289 PrintError("First operand is an Unhandled Operand: %s\n", xed_reg_enum_t2str(xed_reg));
290 v3_op->type = INVALID_OPERAND;
292 } else if (v3_reg_type == SEGMENT_REGISTER) {
293 struct v3_segment * seg_reg = (struct v3_segment *)(v3_op->operand);
294 v3_op->operand = (addr_t)&(seg_reg->selector);
297 v3_op->type = REG_OPERAND;
302 case XED_OPERAND_MEM0:
305 struct x86_operand * operand = &(instr->dst_operand);
307 if (xed_decoded_inst_mem_read(&xed_instr, 0)) {
308 operand = &(instr->src_operand);
309 } else if (xed_decoded_inst_mem_written(&xed_instr, 0)) {
310 operand = &(instr->dst_operand);
314 if (get_memory_operand(info, &xed_instr, 0, v3_op) == -1) {
315 PrintError("Could not get first memory operand\n");
321 case XED_OPERAND_MEM1:
322 case XED_OPERAND_IMM1:
324 PrintError("Illegal Operand Order\n");
328 case XED_OPERAND_IMM0:
329 case XED_OPERAND_AGEN:
330 case XED_OPERAND_PTR:
331 case XED_OPERAND_RELBR:
333 PrintError("Unhandled Operand Type\n");
341 // set second operand
342 if (instr->num_operands >= 2) {
343 const xed_operand_t * op = xed_inst_operand(xi, 1);
344 // xed_operand_type_enum_t op_type = xed_operand_type(op);
345 xed_operand_enum_t op_enum = xed_operand_name(op);
347 struct x86_operand * v3_op;
349 if (xed_operand_written(op)) {
350 v3_op = &(instr->dst_operand);
352 v3_op = &(instr->src_operand);
356 if (xed_operand_is_register(op_enum)) {
357 xed_reg_enum_t xed_reg = xed_decoded_inst_get_reg(&xed_instr, op_enum);
358 int v3_reg_type = xed_reg_to_v3_reg(info,
362 if (v3_reg_type == -1) {
363 PrintError("Second operand is an Unhandled Operand: %s\n", xed_reg_enum_t2str(xed_reg));
364 v3_op->type = INVALID_OPERAND;
366 } else if (v3_reg_type == SEGMENT_REGISTER) {
367 struct v3_segment * seg_reg = (struct v3_segment *)(v3_op->operand);
368 v3_op->operand = (addr_t)&(seg_reg->selector);
371 v3_op->type = REG_OPERAND;
378 case XED_OPERAND_MEM0:
382 if (xed_decoded_inst_mem_read(&xed_instr, 0)) {
383 v3_op = &(instr->src_operand);
384 } else if (xed_decoded_inst_mem_written(&xed_instr, 0)) {
385 v3_op = &(instr->dst_operand);
389 if (get_memory_operand(info, &xed_instr, 0, v3_op) == -1) {
390 PrintError("Could not get first memory operand\n");
396 case XED_OPERAND_IMM0:
398 instr->src_operand.size = xed_decoded_inst_get_immediate_width(&xed_instr);
400 if (instr->src_operand.size > 4) {
401 PrintError("Unhandled 64 bit immediates\n");
404 instr->src_operand.operand = xed_decoded_inst_get_unsigned_immediate(&xed_instr);
406 instr->src_operand.type = IMM_OPERAND;
411 case XED_OPERAND_MEM1:
412 case XED_OPERAND_IMM1:
414 PrintError("Illegal Operand Order\n");
417 case XED_OPERAND_AGEN:
418 case XED_OPERAND_PTR:
419 case XED_OPERAND_RELBR:
421 PrintError("Unhandled Operand Type\n");
429 if (instr->num_operands >= 3) {
430 const xed_operand_t * op = xed_inst_operand(xi, 2);
431 // xed_operand_type_enum_t op_type = xed_operand_type(op);
432 xed_operand_enum_t op_enum = xed_operand_name(op);
434 if (xed_operand_is_register(op_enum)) {
435 xed_reg_enum_t xed_reg = xed_decoded_inst_get_reg(&xed_instr, op_enum);
436 int v3_reg_type = xed_reg_to_v3_reg(info,
438 &(instr->third_operand.operand),
439 &(instr->third_operand.size));
441 if (v3_reg_type == -1) {
442 PrintError("Third operand is an Unhandled Operand: %s\n", xed_reg_enum_t2str(xed_reg));
443 instr->third_operand.type = INVALID_OPERAND;
445 } else if (v3_reg_type == SEGMENT_REGISTER) {
446 struct v3_segment * seg_reg = (struct v3_segment *)(instr->third_operand.operand);
447 instr->third_operand.operand = (addr_t)&(seg_reg->selector);
451 instr->third_operand.type = REG_OPERAND;
455 // PrintError("Unhandled third operand type %s\n", xed_operand_type_enum_t2str(op_type));
468 int v3_encode(struct guest_info * info, struct x86_instr * instr, char * instr_buf) {
477 static int get_memory_operand(struct guest_info * info, xed_decoded_inst_t * xed_instr, uint_t op_index, struct x86_operand * operand) {
478 struct memory_operand mem_op;
484 ullong_t displacement;
485 // struct v3_segment * seg_reg;
490 memset((void*)&mem_op, '\0', sizeof(struct memory_operand));
492 xed_reg_enum_t xed_seg = xed_decoded_inst_get_seg_reg(xed_instr, op_index);
493 if (xed_seg != XED_REG_INVALID) {
494 struct v3_segment *tmp_segment;
495 if (xed_reg_to_v3_reg(info, xed_seg, (addr_t *)&tmp_segment, &(mem_op.segment_size)) == -1) {
496 PrintError("Unhandled Segment Register\n");
499 mem_op.segment = tmp_segment->base;
502 xed_reg_enum_t xed_base = xed_decoded_inst_get_base_reg(xed_instr, op_index);
503 if (xed_base != XED_REG_INVALID) {
505 if (xed_reg_to_v3_reg(info, xed_base, &base_reg, &(mem_op.base_size)) == -1) {
506 PrintError("Unhandled Base register\n");
509 mem_op.base = *(addr_t *)base_reg;
514 xed_reg_enum_t xed_idx = xed_decoded_inst_get_index_reg(xed_instr, op_index);
515 if ((op_index == 0) && (xed_idx != XED_REG_INVALID)) {
518 if (xed_reg_to_v3_reg(info, xed_idx, &index_reg, &(mem_op.index_size)) == -1) {
519 PrintError("Unhandled Index Register\n");
523 mem_op.index= *(addr_t *)index_reg;
525 xed_uint_t xed_scale = xed_decoded_inst_get_scale(xed_instr, op_index);
526 if (xed_scale != 0) {
527 mem_op.scale = xed_scale;
532 xed_uint_t disp_bits = xed_decoded_inst_get_memory_displacement_width(xed_instr, op_index);
534 xed_int64_t xed_disp = xed_decoded_inst_get_memory_displacement(xed_instr, op_index);
536 mem_op.displacement_size = disp_bits / 8;
537 mem_op.displacement = xed_disp;
541 operand->type = MEM_OPERAND;
542 operand->size = xed_decoded_inst_get_memory_operand_length(xed_instr, op_index);
546 PrintDebug("Struct: Seg=%x, base=%x, index=%x, scale=%x, displacement=%x\n",
547 mem_op.segment, mem_op.base, mem_op.index, mem_op.scale, mem_op.displacement);
550 seg = mem_op.segment;
551 base = MASK(mem_op.base, mem_op.base_size);
552 index = MASK(mem_op.index, mem_op.index_size);
553 scale = mem_op.scale;
554 displacement = MASK(mem_op.displacement, mem_op.displacement_size);
556 PrintDebug("Seg=%x, base=%x, index=%x, scale=%x, displacement=%x\n", seg, base, index, scale, displacement);
558 operand->operand = seg + base + (scale * index) + displacement;
563 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) {
566 case XED_REG_INVALID:
575 *v3_reg = (addr_t)&(info->vm_regs.rax);
579 *v3_reg = (addr_t)&(info->vm_regs.rax);
583 *v3_reg = (addr_t)&(info->vm_regs.rax);
587 *v3_reg = (addr_t)(&(info->vm_regs.rax)) + 1;
591 *v3_reg = (addr_t)&(info->vm_regs.rax);
596 *v3_reg = (addr_t)&(info->vm_regs.rcx);
600 *v3_reg = (addr_t)&(info->vm_regs.rcx);
604 *v3_reg = (addr_t)&(info->vm_regs.rcx);
608 *v3_reg = (addr_t)(&(info->vm_regs.rcx)) + 1;
612 *v3_reg = (addr_t)&(info->vm_regs.rcx);
617 *v3_reg = (addr_t)&(info->vm_regs.rdx);
621 *v3_reg = (addr_t)&(info->vm_regs.rdx);
625 *v3_reg = (addr_t)&(info->vm_regs.rdx);
629 *v3_reg = (addr_t)(&(info->vm_regs.rdx)) + 1;
633 *v3_reg = (addr_t)&(info->vm_regs.rdx);
638 *v3_reg = (addr_t)&(info->vm_regs.rbx);
642 *v3_reg = (addr_t)&(info->vm_regs.rbx);
646 *v3_reg = (addr_t)&(info->vm_regs.rbx);
650 *v3_reg = (addr_t)(&(info->vm_regs.rbx)) + 1;
654 *v3_reg = (addr_t)&(info->vm_regs.rbx);
660 *v3_reg = (addr_t)&(info->vm_regs.rsp);
664 *v3_reg = (addr_t)&(info->vm_regs.rsp);
668 *v3_reg = (addr_t)&(info->vm_regs.rsp);
672 *v3_reg = (addr_t)&(info->vm_regs.rsp);
677 *v3_reg = (addr_t)&(info->vm_regs.rbp);
681 *v3_reg = (addr_t)&(info->vm_regs.rbp);
685 *v3_reg = (addr_t)&(info->vm_regs.rbp);
689 *v3_reg = (addr_t)&(info->vm_regs.rbp);
696 *v3_reg = (addr_t)&(info->vm_regs.rsi);
700 *v3_reg = (addr_t)&(info->vm_regs.rsi);
704 *v3_reg = (addr_t)&(info->vm_regs.rsi);
708 *v3_reg = (addr_t)&(info->vm_regs.rsi);
714 *v3_reg = (addr_t)&(info->vm_regs.rdi);
718 *v3_reg = (addr_t)&(info->vm_regs.rdi);
722 *v3_reg = (addr_t)&(info->vm_regs.rdi);
726 *v3_reg = (addr_t)&(info->vm_regs.rdi);
735 *v3_reg = (addr_t)&(info->rip);
737 return CTRL_REGISTER;
739 *v3_reg = (addr_t)&(info->rip);
741 return CTRL_REGISTER;
743 *v3_reg = (addr_t)&(info->rip);
745 return CTRL_REGISTER;
748 *v3_reg = (addr_t)&(info->ctrl_regs.rflags);
750 return CTRL_REGISTER;
752 *v3_reg = (addr_t)&(info->ctrl_regs.rflags);
754 return CTRL_REGISTER;
756 *v3_reg = (addr_t)&(info->ctrl_regs.rflags);
758 return CTRL_REGISTER;
761 *v3_reg = (addr_t)&(info->ctrl_regs.cr0);
763 return CTRL_REGISTER;
765 *v3_reg = (addr_t)&(info->ctrl_regs.cr2);
767 return CTRL_REGISTER;
769 *v3_reg = (addr_t)&(info->ctrl_regs.cr3);
771 return CTRL_REGISTER;
773 *v3_reg = (addr_t)&(info->ctrl_regs.cr4);
775 return CTRL_REGISTER;
777 *v3_reg = (addr_t)&(info->ctrl_regs.cr8);
779 return CTRL_REGISTER;
801 *v3_reg = (addr_t)&(info->segments.cs);
802 return SEGMENT_REGISTER;
804 *v3_reg = (addr_t)&(info->segments.ds);
805 return SEGMENT_REGISTER;
807 *v3_reg = (addr_t)&(info->segments.es);
808 return SEGMENT_REGISTER;
810 *v3_reg = (addr_t)&(info->segments.ss);
811 return SEGMENT_REGISTER;
813 *v3_reg = (addr_t)&(info->segments.fs);
814 return SEGMENT_REGISTER;
816 *v3_reg = (addr_t)&(info->segments.gs);
817 return SEGMENT_REGISTER;
824 PrintError("Segment selector operand... Don't know how to handle this...\n");
927 case XED_REG_STACKPUSH:
928 case XED_REG_STACKPOP:
934 case XED_REG_X87CONTROL:
935 case XED_REG_X87STATUS:
938 case XED_REG_X87PUSH:
940 case XED_REG_X87POP2:
975 static int get_opcode(xed_iform_enum_t iform, addr_t * opcode) {
978 case XED_IFORM_MOV_CR_GPR64_CR:
979 case XED_IFORM_MOV_CR_GPR32_CR:
980 *opcode = (addr_t)&V3_OPCODE_MOVCR2;
983 case XED_IFORM_MOV_CR_CR_GPR64:
984 case XED_IFORM_MOV_CR_CR_GPR32:
985 *opcode = (addr_t)&V3_OPCODE_MOV2CR;
989 case XED_IFORM_LMSW_GPR16:
990 *opcode = (addr_t)&V3_OPCODE_LMSW;
994 *opcode = (addr_t)&V3_OPCODE_CLTS;