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