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 #ifndef __VMM_DECODER_H
21 #define __VMM_DECODER_H
25 #include <palacios/vm_guest.h>
26 #include <palacios/vmm.h>
29 typedef enum { V3_INVALID_OP,
30 V3_OP_MOVCR2, V3_OP_MOV2CR, V3_OP_SMSW, V3_OP_LMSW, V3_OP_CLTS,
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_INT } v3_op_type_t;
40 typedef enum {INVALID_OPERAND, REG_OPERAND, MEM_OPERAND, IMM_OPERAND} v3_operand_type_t;
45 v3_operand_type_t type;
46 uint8_t read : 1; // This operand value will be read by the instruction
47 uint8_t write : 1; // This operand value will be written to by the instruction
48 } __attribute__((packed));
55 uint_t lock : 1; // 0xF0
56 uint_t repne : 1; // 0xF2
57 uint_t repnz : 1; // 0xF2
58 uint_t rep : 1; // 0xF3
59 uint_t repe : 1; // 0xF3
60 uint_t repz : 1; // 0xF3
61 uint_t cs_override : 1; // 0x2E
62 uint_t ss_override : 1; // 0x36
63 uint_t ds_override : 1; // 0x3E
64 uint_t es_override : 1; // 0x26
65 uint_t fs_override : 1; // 0x64
66 uint_t gs_override : 1; // 0x65
67 uint_t br_not_taken : 1; // 0x2E
68 uint_t br_taken : 1; // 0x3E
69 uint_t op_size : 1; // 0x66
70 uint_t addr_size : 1; // 0x67
74 uint_t rex_rm : 1; // REX.B
75 uint_t rex_sib_idx : 1; // REX.X
76 uint_t rex_reg : 1; // REX.R
77 uint_t rex_op_size : 1; // REX.W
78 } __attribute__((packed));
79 } __attribute__((packed));
80 } __attribute__((packed));
84 struct x86_prefixes prefixes;
88 struct x86_operand dst_operand;
89 struct x86_operand src_operand;
90 struct x86_operand third_operand;
96 /************************/
97 /* EXTERNAL DECODER API */
98 /************************/
100 This is an External API definition that must be implemented by a decoder
105 * Initializes a decoder
107 int v3_init_decoder(struct guest_info * core);
108 int v3_deinit_decoder(struct guest_info * core);
111 * Decodes an instruction
112 * All addresses in arguments are in the host address space
113 * instr_ptr is the host address of the instruction
114 * IMPORTANT: make sure the instr_ptr is in contiguous host memory
115 * ie. Copy it to a buffer before the call
117 int v3_decode(struct guest_info * info, addr_t instr_ptr, struct x86_instr * instr);
120 * Encodes an instruction
121 * All addresses in arguments are in the host address space
122 * The instruction is encoded from the struct, and copied into a 15 byte host buffer
123 * referenced by instr_buf
124 * any unused bytes at the end of instr_buf will be filled with nops
125 * IMPORTANT: instr_buf must be allocated and 15 bytes long
127 int v3_encode(struct guest_info * info, struct x86_instr * instr, uint8_t * instr_buf);
131 /* Removes a rep prefix in place */
132 void v3_strip_rep_prefix(uint8_t * instr, int length);
133 uint8_t v3_get_prefixes(uint8_t * instr, struct x86_prefixes * prefixes);
136 void v3_print_instr(struct x86_instr * instr);
139 #define PREFIX_LOCK 0xF0
140 #define PREFIX_REPNE 0xF2
141 #define PREFIX_REPNZ 0xF2
142 #define PREFIX_REP 0xF3
143 #define PREFIX_REPE 0xF3
144 #define PREFIX_REPZ 0xF3
145 #define PREFIX_CS_OVERRIDE 0x2E
146 #define PREFIX_SS_OVERRIDE 0x36
147 #define PREFIX_DS_OVERRIDE 0x3E
148 #define PREFIX_ES_OVERRIDE 0x26
149 #define PREFIX_FS_OVERRIDE 0x64
150 #define PREFIX_GS_OVERRIDE 0x65
151 #define PREFIX_BR_NOT_TAKEN 0x2E
152 #define PREFIX_BR_TAKEN 0x3E
153 #define PREFIX_OP_SIZE 0x66
154 #define PREFIX_ADDR_SIZE 0x67
159 static inline int is_prefix_byte(uchar_t byte) {
162 case 0xF2: // REPNE/REPNZ
163 case 0xF3: // REP or REPE/REPZ
164 case 0x2E: // CS override or Branch hint not taken (with Jcc instrs)
165 case 0x36: // SS override
166 case 0x3E: // DS override or Branch hint taken (with Jcc instrs)
167 case 0x26: // ES override
168 case 0x64: // FS override
169 case 0x65: // GS override
170 //case 0x2E: // branch not taken hint
171 // case 0x3E: // branch taken hint
172 case 0x66: // operand size override
173 case 0x67: // address size override
183 static inline v3_reg_t get_gpr_mask(struct guest_info * info) {
184 switch (info->cpu_mode) {
194 return 0xffffffffffffffffLL;
196 PrintError("Unsupported Address Mode\n");
203 static inline addr_t get_addr_linear(struct guest_info * info, addr_t addr, struct v3_segment * seg) {
204 switch (info->cpu_mode) {
206 // It appears that the segment values are computed and cached in the vmcb structure
207 // We Need to check this for Intel
208 /* return addr + (seg->selector << 4);
214 return addr + seg->base;
218 // In long mode the segment bases are disregarded (forced to 0), unless using
219 // FS or GS, then the base addresses are added
220 return addr + seg->base;
224 PrintError("Unsupported CPU Mode: %d\n", info->cpu_mode);