palacios/include/palacios/vm_guest.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 __VM_GUEST_H__
  21 #define __VM_GUEST_H__
  22
  23 #ifdef __V3VEE__
  24
  25 #include <palacios/vmm_types.h>
  26 #include <palacios/vmm_mem.h>
  27 #include <palacios/vmm_io.h>
  28 #include <palacios/vmm_shadow_paging.h>
  29 #include <palacios/vmm_intr.h>
  30 #include <palacios/vmm_excp.h>
  31 #include <palacios/vmm_dev_mgr.h>
  32 #include <palacios/vmm_time.h>
  33 #include <palacios/vmm_host_events.h>
  34 #include <palacios/vmm_msr.h>
  35 #include <palacios/vmm_profiler.h>
  36 #include <palacios/vmm_hypercall.h>
  37
  38
  39
  40 struct v3_gprs {
  41     v3_reg_t rdi;
  42     v3_reg_t rsi;
  43     v3_reg_t rbp;
  44     v3_reg_t rsp;
  45     v3_reg_t rbx;
  46     v3_reg_t rdx;
  47     v3_reg_t rcx;
  48     v3_reg_t rax;
  49
  50     v3_reg_t r8;
  51     v3_reg_t r9;
  52     v3_reg_t r10;
  53     v3_reg_t r11;
  54     v3_reg_t r12;
  55     v3_reg_t r13;
  56     v3_reg_t r14;
  57     v3_reg_t r15;
  58
  59 } __attribute__((packed));
  60
  61
  62 struct v3_ctrl_regs {
  63     v3_reg_t cr0;
  64     v3_reg_t cr2;
  65     v3_reg_t cr3;
  66     v3_reg_t cr4;
  67     v3_reg_t cr8;
  68     v3_reg_t rflags;
  69     v3_reg_t efer;
  70 };
  71
  72
  73
  74 struct v3_dbg_regs {
  75     v3_reg_t dr0;
  76     v3_reg_t dr1;
  77     v3_reg_t dr2;
  78     v3_reg_t dr3;
  79     v3_reg_t dr6;
  80     v3_reg_t dr7;
  81 };
  82
  83 struct v3_segment {
  84     uint16_t selector;
  85     uint_t limit;
  86     uint64_t base;
  87     uint_t type           : 4;
  88     uint_t system         : 1;
  89     uint_t dpl            : 2;
  90     uint_t present        : 1;
  91     uint_t avail          : 1;
  92     uint_t long_mode      : 1;
  93     uint_t db             : 1;
  94     uint_t granularity    : 1;
  95 } __attribute__((packed));
  96
  97
  98 struct v3_segments {
  99     struct v3_segment cs;
 100     struct v3_segment ds;
 101     struct v3_segment es;
 102     struct v3_segment fs;
 103     struct v3_segment gs;
 104     struct v3_segment ss;
 105     struct v3_segment ldtr;
 106     struct v3_segment gdtr;
 107     struct v3_segment idtr;
 108     struct v3_segment tr;
 109 };
 110
 111 struct shadow_page_state;
 112 struct v3_intr_state;
 113
 114 #ifdef CONFIG_PROFILE_VMM
 115 struct v3_profiler;
 116 #endif
 117
 118
 119
 120 struct guest_info {
 121     uint64_t rip;
 122
 123     uint_t cpl;
 124
 125     addr_t mem_size; // In bytes for now
 126     v3_shdw_map_t mem_map;
 127
 128
 129     struct vm_time time_state;
 130
 131
 132     v3_paging_mode_t shdw_pg_mode;
 133     struct shadow_page_state shdw_pg_state;
 134     addr_t direct_map_pt;
 135
 136
 137     // This structure is how we get interrupts for the guest
 138     struct v3_intr_state intr_state;
 139
 140     // This structure is how we get exceptions for the guest
 141     struct v3_excp_state excp_state;
 142
 143     struct v3_io_map io_map;
 144
 145     struct v3_msr_map msr_map;
 146
 147
 148     v3_hypercall_map_t hcall_map;
 149
 150     // device_map
 151     struct vmm_dev_mgr  dev_mgr;
 152
 153     struct v3_host_events host_event_hooks;
 154
 155     v3_cpu_mode_t cpu_mode;
 156     v3_mem_mode_t mem_mode;
 157     uint_t addr_width;
 158
 159
 160     struct v3_gprs vm_regs;
 161     struct v3_ctrl_regs ctrl_regs;
 162     struct v3_dbg_regs dbg_regs;
 163     struct v3_segments segments;
 164
 165     v3_vm_operating_mode_t run_state;
 166     void * vmm_data;
 167
 168     uint64_t yield_cycle_period;
 169     uint64_t yield_start_cycle;
 170
 171
 172 #ifdef CONFIG_PROFILE_VMM
 173     uint_t enable_profiler;
 174     struct v3_profiler profiler;
 175 #endif
 176
 177     void * decoder_state;
 178 };
 179
 180
 181 uint_t v3_get_addr_width(struct guest_info * info);
 182 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
 183 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
 184
 185
 186 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
 187 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
 188
 189
 190 void v3_print_guest_state(struct guest_info * info);
 191
 192 void v3_print_segments(struct guest_info * info);
 193 void v3_print_ctrl_regs(struct guest_info * info);
 194 void v3_print_GPRs(struct guest_info * info);
 195
 196 #endif // ! __V3VEE__
 197
 198
 199
 200 #endif