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_hypercall.h>
  36 #include <palacios/vmm_cpuid.h>
  37
  38
  39 #ifdef CONFIG_TELEMETRY
  40 #include <palacios/vmm_telemetry.h>
  41 #endif
  42
  43 #ifdef CONFIG_SYMBIOTIC_SWAP
  44 #include <palacios/vmm_sym_swap.h>
  45 #endif
  46
  47
  48
  49
  50
  51
  52
  53 struct v3_gprs {
  54     v3_reg_t rdi;
  55     v3_reg_t rsi;
  56     v3_reg_t rbp;
  57     v3_reg_t rsp;
  58     v3_reg_t rbx;
  59     v3_reg_t rdx;
  60     v3_reg_t rcx;
  61     v3_reg_t rax;
  62
  63     v3_reg_t r8;
  64     v3_reg_t r9;
  65     v3_reg_t r10;
  66     v3_reg_t r11;
  67     v3_reg_t r12;
  68     v3_reg_t r13;
  69     v3_reg_t r14;
  70     v3_reg_t r15;
  71
  72 } __attribute__((packed));
  73
  74
  75 struct v3_ctrl_regs {
  76     v3_reg_t cr0;
  77     v3_reg_t cr2;
  78     v3_reg_t cr3;
  79     v3_reg_t cr4;
  80     v3_reg_t cr8;
  81     v3_reg_t rflags;
  82     v3_reg_t efer;
  83 };
  84
  85
  86
  87 struct v3_dbg_regs {
  88     v3_reg_t dr0;
  89     v3_reg_t dr1;
  90     v3_reg_t dr2;
  91     v3_reg_t dr3;
  92     v3_reg_t dr6;
  93     v3_reg_t dr7;
  94 };
  95
  96 struct v3_segment {
  97     uint16_t selector;
  98     uint_t limit;
  99     uint64_t base;
 100     uint_t type           : 4;
 101     uint_t system         : 1;
 102     uint_t dpl            : 2;
 103     uint_t present        : 1;
 104     uint_t avail          : 1;
 105     uint_t long_mode      : 1;
 106     uint_t db             : 1;
 107     uint_t granularity    : 1;
 108     uint_t unusable       : 1;
 109 } __attribute__((packed));
 110
 111
 112 struct v3_segments {
 113     struct v3_segment cs;
 114     struct v3_segment ds;
 115     struct v3_segment es;
 116     struct v3_segment fs;
 117     struct v3_segment gs;
 118     struct v3_segment ss;
 119     struct v3_segment ldtr;
 120     struct v3_segment gdtr;
 121     struct v3_segment idtr;
 122     struct v3_segment tr;
 123 };
 124
 125
 126 #ifdef CONFIG_SYMBIOTIC
 127 #include <palacios/vmm_sym_iface.h>
 128 #endif
 129
 130 #include <palacios/vmm_config.h>
 131
 132 struct shadow_page_state;
 133 struct v3_intr_state;
 134
 135 #ifdef CONFIG_TELEMETRY
 136 struct v3_telemetry;
 137 #endif
 138
 139 #ifdef CONFIG_SYMBIOTIC_SWAP
 140 struct v3_sym_swap_state;
 141 #endif
 142
 143 #ifdef CONFIG_SYMBIOTIC
 144 struct v3_sym_state;
 145 #endif
 146
 147 struct guest_info {
 148     uint64_t rip;
 149
 150     uint_t cpl;
 151
 152     addr_t mem_size; // In bytes for now
 153     v3_shdw_map_t mem_map;
 154
 155     struct v3_config * cfg_data;
 156     v3_vm_class_t vm_class;
 157
 158     struct vm_time time_state;
 159
 160
 161     v3_paging_mode_t shdw_pg_mode;
 162     struct shadow_page_state shdw_pg_state;
 163     addr_t direct_map_pt;
 164
 165
 166     // This structure is how we get interrupts for the guest
 167     struct v3_intr_state intr_state;
 168
 169     // This structure is how we get exceptions for the guest
 170     struct v3_excp_state excp_state;
 171
 172     struct v3_io_map io_map;
 173
 174     struct v3_msr_map msr_map;
 175
 176     struct v3_cpuid_map cpuid_map;
 177
 178 #ifdef CONFIG_SYMBIOTIC
 179     // Symbiotic state
 180     struct v3_sym_state sym_state;
 181 #endif
 182
 183     v3_hypercall_map_t hcall_map;
 184
 185     // device_map
 186     struct vmm_dev_mgr  dev_mgr;
 187
 188     struct v3_host_events host_event_hooks;
 189
 190     v3_cpu_mode_t cpu_mode;
 191     v3_mem_mode_t mem_mode;
 192     uint_t addr_width;
 193
 194
 195     struct v3_gprs vm_regs;
 196     struct v3_ctrl_regs ctrl_regs;
 197     struct v3_dbg_regs dbg_regs;
 198     struct v3_segments segments;
 199
 200     v3_vm_operating_mode_t run_state;
 201     void * vmm_data;
 202
 203     uint64_t yield_cycle_period;
 204     uint64_t yield_start_cycle;
 205
 206     uint64_t num_exits;
 207
 208 #ifdef CONFIG_TELEMETRY
 209     uint_t enable_telemetry;
 210     struct v3_telemetry_state telemetry;
 211 #endif
 212
 213
 214 #ifdef CONFIG_SYMBIOTIC_SWAP
 215     struct v3_sym_swap_state swap_state;
 216 #endif
 217
 218     void * decoder_state;
 219
 220     // the logical cpu this guest context is executing on
 221     int cpu_id;
 222 };
 223
 224
 225 uint_t v3_get_addr_width(struct guest_info * info);
 226 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
 227 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
 228
 229
 230 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
 231 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
 232
 233 int v3_translate_segment(struct guest_info * info, uint16_t selector, struct v3_segment * seg);
 234
 235
 236 void v3_print_guest_state(struct guest_info * info);
 237
 238 void v3_print_segments(struct v3_segments * segs);
 239 void v3_print_ctrl_regs(struct guest_info * info);
 240 void v3_print_GPRs(struct guest_info * info);
 241
 242 void v3_print_stack(struct guest_info * info);
 243
 244 #endif // ! __V3VEE__
 245
 246 #endif