Palacios Public Git Repository

To checkout Palacios execute

  git clone http://v3vee.org/palacios/palacios.web/palacios.git
This will give you the master branch. You probably want the devel branch or one of the release branches. To switch to the devel branch, simply execute
  cd palacios
  git checkout --track -b devel origin/devel
The other branches are similar.


updated to 64 bits based on the wrong f#@$%ing trunk
[palacios.git] / palacios / include / palacios / vmm_decoder.h
index 130e1ae..ec52d09 100644 (file)
@@ -1,17 +1,33 @@
-#ifndef __VMM_EMULATE_H
-#define __VMM_EMULATE_H
-#include <palacios/vm_guest.h>
-#include <palacios/vmm.h>
 
 /*
- * This is where we do the hideous X86 instruction parsing among other things
- * We can parse out the instruction prefixes, as well as decode the operands 
+ * This file is part of the Palacios Virtual Machine Monitor developed
+ * by the V3VEE Project with funding from the United States National 
+ * Science Foundation and the Department of Energy.  
+ *
+ * The V3VEE Project is a joint project between Northwestern University
+ * and the University of New Mexico.  You can find out more at 
+ * http://www.v3vee.org
+ *
+ * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu> 
+ * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org> 
+ * All rights reserved.
+ *
+ * Author: Jack Lange <jarusl@cs.northwestern.edu>
+ *
+ * This is free software.  You are permitted to use,
+ * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  */
 
-typedef enum {INVALID_OPERAND, REG_OPERAND, MEM_OPERAND} operand_type_t;
+#ifndef __VMM_DECODER_H
+#define __VMM_DECODER_H
+
+#ifdef __V3VEE__
 
+#include <palacios/vm_guest.h>
+#include <palacios/vmm.h>
 
 
+typedef enum {INVALID_OPERAND, REG_OPERAND, MEM_OPERAND, IMM_OPERAND} operand_type_t;
 
 struct x86_operand {
   addr_t operand;
@@ -19,23 +35,91 @@ struct x86_operand {
   operand_type_t type;
 };
 
-struct x86_prefix_list {
-  uint_t lock   : 1;
+struct x86_prefixes {
+  uint_t lock   : 1;  // 0xF0
+  uint_t repne  : 1;  // 0xF2
+  uint_t repnz  : 1;  // 0xF2
+  uint_t rep    : 1;  // 0xF3
+  uint_t repe   : 1;  // 0xF3
+  uint_t repz   : 1;  // 0xF3
+  uint_t cs_override : 1;  // 0x2E
+  uint_t ss_override : 1;  // 0x36
+  uint_t ds_override : 1;  // 0x3E
+  uint_t es_override : 1;  // 0x26
+  uint_t fs_override : 1;  // 0x64
+  uint_t gs_override : 1;  // 0x65
+  uint_t br_not_taken : 1;  // 0x2E
+  uint_t br_takend   : 1;  // 0x3E
+  uint_t op_size     : 1;  // 0x66
+  uint_t addr_size   : 1;  // 0x67
+};
+
+
+struct x86_instr {
+  struct x86_prefixes prefixes;
+  uint_t instr_length;
+  addr_t opcode;    // a pointer to the V3_OPCODE_[*] arrays defined below
+  uint_t num_operands;
+  struct x86_operand dst_operand;
+  struct x86_operand src_operand;
+  struct x86_operand third_operand;
+  void * decoder_data;
+};
+
+
+struct basic_instr_info {
+  uint_t instr_length;
+  uint_t op_size;
+  uint_t str_op    : 1;
+  uint_t has_rep : 1;
 };
 
-/* This parses an instruction 
+
+
+  /************************/
+ /* EXTERNAL DECODER API */
+/************************/
+/* 
+   This is an External API definition that must be implemented by a decoder
+*/
+
+
+/* 
+ * Initializes a decoder
+ */
+int init_decoder();
+
+/* 
+ * Decodes an instruction 
  * All addresses in arguments are in the host address space
+ * instr_ptr is the host address of the instruction 
+ * IMPORTANT: make sure the instr_ptr is in contiguous host memory
+ *   ie. Copy it to a buffer before the call
  */
-int v3_parse_instr(struct guest_info * info,             // input
-                  char * instr_ptr,                        // input 
-                  uint_t * instr_length,                // output
-                  addr_t * opcode,                      // output
-                  uint_t * opcode_length,               // output
-                  struct x86_prefix_list * prefixes,    // output
-                  struct x86_operand * src_operand,     // output
-                  struct x86_operand * dst_operand,     // output
-                  struct x86_operand * extra_operand);  // output
-                  
+int v3_decode(struct guest_info * info, addr_t instr_ptr, struct x86_instr * instr);
+
+/* 
+ * Encodes an instruction
+ * All addresses in arguments are in the host address space
+ * The instruction is encoded from the struct, and copied into a 15 byte host buffer
+ * referenced by instr_buf
+ * any unused bytes at the end of instr_buf will be filled with nops
+ * IMPORTANT: instr_buf must be allocated and 15 bytes long
+ */
+int v3_encode(struct guest_info * info, struct x86_instr * instr, char * instr_buf);
+
+
+/*
+ * Gets the operand size for a memory operation
+ *
+ */
+int v3_basic_mem_decode(struct guest_info * info, addr_t instr_ptr, struct basic_instr_info * instr_info);
+
+
+
+/* Removes a rep prefix in place */
+void strip_rep_prefix(uchar_t * instr, int length);
+
 
 
 /* 
@@ -67,7 +151,7 @@ struct sib_byte {
 
 
 
-#define MAKE_INSTR(nm, ...) static const uchar_t OPCODE_##nm[] = { __VA_ARGS__ }
+#define MAKE_INSTR(nm, ...) static  const uchar_t V3_OPCODE_##nm[] = { __VA_ARGS__ }
 
 /* 
  * Here's how it works:
@@ -124,7 +208,10 @@ MAKE_INSTR(SMSW,   3, 0x0f, 0x01, 0x00);
 #define PREFIX_OP_SIZE      0x66
 #define PREFIX_ADDR_SIZE    0x67
 
-static inline int is_prefix_byte(char byte) {
+int opcode_cmp(const uchar_t * op1, const uchar_t * op2);
+
+
+static inline int is_prefix_byte(uchar_t byte) {
   switch (byte) {
   case 0xF0:      // lock
   case 0xF2:      // REPNE/REPNZ
@@ -165,8 +252,11 @@ static inline v3_reg_t get_gpr_mask(struct guest_info * info) {
 static inline addr_t get_addr_linear(struct guest_info * info, addr_t addr, struct v3_segment * seg) {
   switch (info->cpu_mode) {
   case REAL:
-    return addr + (seg->selector << 4);
-    break;
+    // It appears that the segment values are computed and cached in the vmcb structure 
+    // We Need to check this for Intel
+    /*   return addr + (seg->selector << 4);
+        break;*/
+
   case PROTECTED:
     return addr + seg->base;
     break;
@@ -254,14 +344,14 @@ static inline operand_type_t decode_operands16(struct v3_gprs * gprs, // input/o
   operand_type_t addr_type = INVALID_OPERAND;
   char * instr_cursor = modrm_instr;
 
-  PrintDebug("ModRM mod=%d\n", modrm->mod);
+  //  PrintDebug("ModRM mod=%d\n", modrm->mod);
 
   instr_cursor += 1;
 
   if (modrm->mod == 3) {
     mod_mode = REG;
     addr_type = REG_OPERAND;
-    PrintDebug("first operand = Register (RM=%d)\n",modrm->rm);
+    //PrintDebug("first operand = Register (RM=%d)\n",modrm->rm);
 
     *first_operand = decode_register(gprs, modrm->rm, reg_size);
 
@@ -331,13 +421,13 @@ static inline operand_type_t decode_operands16(struct v3_gprs * gprs, // input/o
 
 
 static inline operand_type_t decode_operands32(struct v3_gprs * gprs, // input/output
-                                              char * modrm_instr,       // input
+                                              uchar_t * modrm_instr,       // input
                                               int * offset,             // output
                                               addr_t * first_operand,   // output
                                               addr_t * second_operand,  // output
                                               reg_size_t reg_size) {    // input
   
-  char * instr_cursor = modrm_instr;
+  uchar_t * instr_cursor = modrm_instr;
   struct modrm_byte * modrm = (struct modrm_byte *)modrm_instr;
   addr_t base_addr = 0;
   modrm_mode_t mod_mode = 0;
@@ -352,7 +442,7 @@ static inline operand_type_t decode_operands32(struct v3_gprs * gprs, // input/o
     mod_mode = REG;
     addr_type = REG_OPERAND;
     
-    PrintDebug("first operand = Register (RM=%d)\n",modrm->rm);
+    //    PrintDebug("first operand = Register (RM=%d)\n",modrm->rm);
 
     *first_operand = decode_register(gprs, modrm->rm, reg_size);
 
@@ -500,5 +590,7 @@ static inline operand_type_t decode_operands32(struct v3_gprs * gprs, // input/o
 
 
 
+#endif // !__V3VEE__
+
 
 #endif