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 #ifdef CONFIG_SYMBIOTIC
  52 #include <palacios/vmm_symbiotic.h>
  53 struct v3_sym_core_state;
  54 #endif
  55
  56 #include <palacios/vmm_config.h>
  57
  58
  59 struct v3_intr_state;
  60
  61
  62 #ifdef CONFIG_SYMBIOTIC_SWAP
  63 struct v3_sym_swap_state;
  64 #endif
  65
  66
  67
  68
  69 struct guest_info {
  70     uint64_t rip;
  71
  72     uint_t cpl;
  73
  74     struct vm_time time_state;
  75
  76     v3_paging_mode_t shdw_pg_mode;
  77     struct v3_shdw_pg_state shdw_pg_state;
  78     addr_t direct_map_pt;
  79
  80
  81     // This structure is how we get interrupts for the guest
  82     struct v3_intr_core_state intr_core_state;
  83
  84     // This structure is how we get exceptions for the guest
  85     struct v3_excp_state excp_state;
  86
  87
  88     v3_cpu_mode_t cpu_mode;
  89     v3_mem_mode_t mem_mode;
  90     uint_t addr_width;
  91
  92     struct v3_gprs vm_regs;
  93     struct v3_ctrl_regs ctrl_regs;
  94     struct v3_dbg_regs dbg_regs;
  95     struct v3_segments segments;
  96
  97
  98     void * vmm_data;
  99
 100     uint64_t yield_start_cycle;
 101
 102     uint64_t num_exits;
 103
 104 #ifdef CONFIG_TELEMETRY
 105     struct v3_core_telemetry core_telem;
 106 #endif
 107
 108
 109     // struct v3_core_dev_mgr core_dev_mgr;
 110
 111     void * decoder_state;
 112
 113 #ifdef CONFIG_SYMBIOTIC
 114     // Symbiotic state
 115     struct v3_sym_core_state sym_core_state;
 116 #endif
 117
 118
 119     struct v3_vm_info * vm_info;
 120     // the logical cpu this guest context is executing on
 121     int cpu_id;
 122 };
 123
 124
 125
 126
 127 struct v3_vm_info {
 128     v3_vm_class_t vm_class;
 129
 130     addr_t mem_size; // In bytes for now
 131     struct v3_mem_map mem_map;
 132
 133
 134     struct v3_shdw_impl_state shdw_impl;
 135
 136     struct v3_io_map io_map;
 137     struct v3_msr_map msr_map;
 138     struct v3_cpuid_map cpuid_map;
 139
 140     v3_hypercall_map_t hcall_map;
 141
 142
 143     struct v3_intr_routers intr_routers;
 144     // device_map
 145     struct vmm_dev_mgr  dev_mgr;
 146
 147     struct v3_host_events host_event_hooks;
 148
 149     struct v3_config * cfg_data;
 150
 151     v3_vm_operating_mode_t run_state;
 152
 153 #ifdef CONFIG_SYMBIOTIC
 154     // Symbiotic state
 155     struct v3_sym_vm_state sym_vm_state;
 156 #ifdef CONFIG_SYMBIOTIC_SWAP
 157     struct v3_sym_swap_state swap_state;
 158 #endif
 159 #endif
 160
 161
 162
 163 #ifdef CONFIG_TELEMETRY
 164     uint_t enable_telemetry;
 165     struct v3_telemetry_state telemetry;
 166 #endif
 167
 168     uint64_t yield_cycle_period;
 169
 170     int num_cores;
 171     struct guest_info cores[0];
 172
 173 };
 174
 175 int v3_init_vm(struct v3_vm_info * vm);
 176 int v3_init_core(struct guest_info * core);
 177
 178
 179 uint_t v3_get_addr_width(struct guest_info * info);
 180 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
 181 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
 182
 183
 184 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
 185 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
 186
 187 int v3_translate_segment(struct guest_info * info, uint16_t selector, struct v3_segment * seg);
 188
 189
 190 void v3_print_guest_state(struct guest_info * info);
 191
 192 void v3_print_segments(struct v3_segments * segs);
 193 void v3_print_ctrl_regs(struct guest_info * info);
 194 void v3_print_GPRs(struct guest_info * info);
 195
 196 void v3_print_stack(struct guest_info * info);
 197
 198 #endif // ! __V3VEE__
 199
 200 #endif