palacios/include/palacios/vmm_decoder.h

   1 /*
   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.
   5  *
   6  * The V3VEE Project is a joint project between Northwestern University
   7  * and the University of New Mexico.  You can find out more at
   8  * http://www.v3vee.org
   9  *
  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.
  13  *
  14  * Author: Jack Lange <jarusl@cs.northwestern.edu>
  15  *
  16  * This is free software.  You are permitted to use,
  17  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  18  */
  19
  20 #ifndef __VMM_DECODER_H
  21 #define __VMM_DECODER_H
  22
  23 #ifdef __V3VEE__
  24
  25 #include <palacios/vm_guest.h>
  26 #include <palacios/vmm.h>
  27
  28
  29 typedef enum { V3_INVALID_OP,
  30                V3_OP_MOVCR2, V3_OP_MOV2CR, V3_OP_SMSW, V3_OP_LMSW, V3_OP_CLTS,
  31                V3_OP_INVLPG,
  32                V3_OP_ADC, V3_OP_ADD, V3_OP_AND, V3_OP_OR, V3_OP_XOR, V3_OP_SUB,
  33                V3_OP_INC, V3_OP_DEC, V3_OP_NEG, V3_OP_MOV, V3_OP_NOT, V3_OP_XCHG,
  34                V3_OP_SETB, V3_OP_SETBE, V3_OP_SETL, V3_OP_SETLE, V3_OP_SETNB,
  35                V3_OP_SETNBE, V3_OP_SETNL, V3_OP_SETNLE, V3_OP_SETNO, V3_OP_SETNP,
  36                V3_OP_SETNS, V3_OP_SETNZ, V3_OP_SETO, V3_OP_SETP, V3_OP_SETS,
  37                V3_OP_SETZ, V3_OP_MOVS, V3_OP_STOS, V3_OP_MOVZX, V3_OP_MOVSX} v3_op_type_t;
  38
  39
  40 typedef enum {INVALID_OPERAND, REG_OPERAND, MEM_OPERAND, IMM_OPERAND} v3_operand_type_t;
  41
  42 struct x86_operand {
  43     addr_t operand;
  44     uint_t size;
  45     v3_operand_type_t type;
  46 };
  47
  48 struct x86_prefixes {
  49     uint_t lock   : 1;  // 0xF0
  50     uint_t repne  : 1;  // 0xF2
  51     uint_t repnz  : 1;  // 0xF2
  52     uint_t rep    : 1;  // 0xF3
  53     uint_t repe   : 1;  // 0xF3
  54     uint_t repz   : 1;  // 0xF3
  55     uint_t cs_override : 1;  // 0x2E
  56     uint_t ss_override : 1;  // 0x36
  57     uint_t ds_override : 1;  // 0x3E
  58     uint_t es_override : 1;  // 0x26
  59     uint_t fs_override : 1;  // 0x64
  60     uint_t gs_override : 1;  // 0x65
  61     uint_t br_not_taken : 1;  // 0x2E
  62     uint_t br_taken   : 1;  // 0x3E
  63     uint_t op_size     : 1;  // 0x66
  64     uint_t addr_size   : 1;  // 0x67
  65         struct  {
  66                 uint_t rm        : 1;  // REX.B
  67                 uint_t sib_idx   : 1;  // REX.X
  68                 uint_t reg       : 1;  // REX.R
  69                 uint_t op_size   : 1;  // REX.W
  70                 uint8_t rsvd     : 4;
  71         } __attribute__((packed)) rex;
  72 } __attribute__((packed));
  73
  74
  75 struct x86_instr {
  76     struct x86_prefixes prefixes;
  77     uint8_t instr_length;
  78     v3_op_type_t op_type;
  79     uint_t num_operands;
  80     struct x86_operand dst_operand;
  81     struct x86_operand src_operand;
  82     struct x86_operand third_operand;
  83     addr_t str_op_length;
  84     addr_t is_str_op;
  85     //  void * decoder_data;
  86 };
  87
  88
  89 /************************/
  90 /* EXTERNAL DECODER API */
  91 /************************/
  92 /*
  93    This is an External API definition that must be implemented by a decoder
  94 */
  95
  96
  97 /*
  98  * Initializes a decoder
  99  */
 100 int v3_init_decoder(struct guest_info * core);
 101 int v3_deinit_decoder(struct guest_info * core);
 102
 103 /*
 104  * Decodes an instruction
 105  * All addresses in arguments are in the host address space
 106  * instr_ptr is the host address of the instruction
 107  * IMPORTANT: make sure the instr_ptr is in contiguous host memory
 108  *   ie. Copy it to a buffer before the call
 109  */
 110 int v3_decode(struct guest_info * info, addr_t instr_ptr, struct x86_instr * instr);
 111
 112 /*
 113  * Encodes an instruction
 114  * All addresses in arguments are in the host address space
 115  * The instruction is encoded from the struct, and copied into a 15 byte host buffer
 116  * referenced by instr_buf
 117  * any unused bytes at the end of instr_buf will be filled with nops
 118  * IMPORTANT: instr_buf must be allocated and 15 bytes long
 119  */
 120 int v3_encode(struct guest_info * info, struct x86_instr * instr, uint8_t * instr_buf);
 121
 122
 123
 124 /* Removes a rep prefix in place */
 125 void v3_strip_rep_prefix(uint8_t * instr, int length);
 126 uint8_t v3_get_prefixes(uint8_t * instr, struct x86_prefixes * prefixes);
 127
 128
 129 void v3_print_instr(struct x86_instr * instr);
 130
 131
 132 #define PREFIX_LOCK         0xF0
 133 #define PREFIX_REPNE        0xF2
 134 #define PREFIX_REPNZ        0xF2
 135 #define PREFIX_REP          0xF3
 136 #define PREFIX_REPE         0xF3
 137 #define PREFIX_REPZ         0xF3
 138 #define PREFIX_CS_OVERRIDE  0x2E
 139 #define PREFIX_SS_OVERRIDE  0x36
 140 #define PREFIX_DS_OVERRIDE  0x3E
 141 #define PREFIX_ES_OVERRIDE  0x26
 142 #define PREFIX_FS_OVERRIDE  0x64
 143 #define PREFIX_GS_OVERRIDE  0x65
 144 #define PREFIX_BR_NOT_TAKEN 0x2E
 145 #define PREFIX_BR_TAKEN     0x3E
 146 #define PREFIX_OP_SIZE      0x66
 147 #define PREFIX_ADDR_SIZE    0x67
 148
 149
 150
 151
 152 static inline int is_prefix_byte(uchar_t byte) {
 153     switch (byte) {
 154         case 0xF0:      // lock
 155         case 0xF2:      // REPNE/REPNZ
 156         case 0xF3:      // REP or REPE/REPZ
 157         case 0x2E:      // CS override or Branch hint not taken (with Jcc instrs)
 158         case 0x36:      // SS override
 159         case 0x3E:      // DS override or Branch hint taken (with Jcc instrs)
 160         case 0x26:      // ES override
 161         case 0x64:      // FS override
 162         case 0x65:      // GS override
 163             //case 0x2E:      // branch not taken hint
 164             //  case 0x3E:      // branch taken hint
 165         case 0x66:      // operand size override
 166         case 0x67:      // address size override
 167             return 1;
 168             break;
 169         default:
 170             return 0;
 171             break;
 172     }
 173 }
 174
 175
 176 static inline v3_reg_t get_gpr_mask(struct guest_info * info) {
 177     switch (info->cpu_mode) {
 178         case REAL:
 179         case LONG_16_COMPAT:
 180             return 0xffff;
 181             break;
 182         case PROTECTED:
 183         case LONG_32_COMPAT:
 184         case PROTECTED_PAE:
 185             return 0xffffffff;
 186         case LONG:
 187             return 0xffffffffffffffffLL;
 188         default:
 189             PrintError("Unsupported Address Mode\n");
 190             return -1;
 191     }
 192 }
 193
 194
 195
 196 static inline addr_t get_addr_linear(struct guest_info * info, addr_t addr, struct v3_segment * seg) {
 197     switch (info->cpu_mode) {
 198         case REAL:
 199             // It appears that the segment values are computed and cached in the vmcb structure
 200             // We Need to check this for Intel
 201             /*   return addr + (seg->selector << 4);
 202                  break;*/
 203
 204         case PROTECTED:
 205         case PROTECTED_PAE:
 206         case LONG_32_COMPAT:
 207             return addr + seg->base;
 208             break;
 209
 210         case LONG:
 211             // In long mode the segment bases are disregarded (forced to 0), unless using
 212             // FS or GS, then the base addresses are added
 213             return addr + seg->base;
 214
 215         case LONG_16_COMPAT:
 216         default:
 217             PrintError("Unsupported CPU Mode: %d\n", info->cpu_mode);
 218             return -1;
 219     }
 220 }
 221
 222
 223
 224 #endif // !__V3VEE__
 225
 226
 227 #endif