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