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