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 #include <palacios/vmm_extensions.h>
  40 #include <palacios/vmm_barrier.h>
  41 #include <palacios/vmm_timeout.h>
  42
  43
  44 #ifdef V3_CONFIG_TELEMETRY
  45 #include <palacios/vmm_telemetry.h>
  46 #endif
  47
  48
  49 #ifdef V3_CONFIG_SYMBIOTIC
  50 #include <palacios/vmm_symbiotic.h>
  51 struct v3_sym_core_state;
  52 #endif
  53
  54
  55
  56 #include <palacios/vmm_config.h>
  57
  58 struct v3_intr_state;
  59
  60
  61
  62
  63 /* per-core state */
  64 struct guest_info {
  65     char exec_name[256];
  66
  67     uint64_t rip;
  68
  69     uint_t cpl;
  70
  71     struct vm_core_time time_state;
  72     struct v3_core_timeouts timeouts;
  73
  74     v3_paging_mode_t shdw_pg_mode;
  75     struct v3_shdw_pg_state shdw_pg_state;
  76     addr_t direct_map_pt;
  77
  78
  79     union {
  80         uint32_t flags;
  81         struct {
  82             uint8_t use_large_pages        : 1;    /* Enable virtual page tables to use large pages */
  83             uint8_t use_giant_pages        : 1;    /* Enable virtual page tables to use giant (1GB) pages */
  84             uint32_t rsvd                  : 30;
  85         } __attribute__((packed));
  86     } __attribute__((packed));
  87
  88
  89     /* This structure is how we get interrupts for the guest */
  90     struct v3_intr_core_state intr_core_state;
  91
  92     /* This structure is how we get exceptions for the guest */
  93     struct v3_excp_state excp_state;
  94
  95
  96     v3_cpu_mode_t cpu_mode;
  97     v3_mem_mode_t mem_mode;
  98
  99
 100     struct v3_gprs vm_regs;
 101     struct v3_ctrl_regs ctrl_regs;
 102     struct v3_dbg_regs dbg_regs;
 103     struct v3_segments segments;
 104
 105
 106     void * vmm_data;
 107
 108     uint64_t yield_start_cycle;
 109
 110     uint64_t num_exits;
 111
 112 #ifdef V3_CONFIG_TELEMETRY
 113     struct v3_core_telemetry core_telem;
 114 #endif
 115
 116
 117     /* struct v3_core_dev_mgr core_dev_mgr; */
 118
 119     void * decoder_state;
 120
 121 #ifdef V3_CONFIG_SYMBIOTIC
 122     /* Symbiotic state */
 123     struct v3_sym_core_state sym_core_state;
 124 #endif
 125
 126     /* Per-core config tree data. */
 127     v3_cfg_tree_t * core_cfg_data;
 128
 129     struct v3_vm_info * vm_info;
 130
 131     v3_core_operating_mode_t core_run_state;
 132
 133     void * core_thread; /* thread struct for virtual core */
 134
 135     /* the logical cpu on which this core runs */
 136     uint32_t pcpu_id;
 137
 138     /* The virtual core # of this cpu (what the guest sees this core as) */
 139     uint32_t vcpu_id;
 140
 141 };
 142
 143
 144
 145 /* shared state across cores */
 146 struct v3_vm_info {
 147     char name[128];
 148
 149     v3_vm_class_t vm_class;
 150
 151     addr_t mem_size; /* In bytes for now */
 152     uint32_t mem_align;
 153     struct v3_mem_map mem_map;
 154
 155     struct v3_mem_hooks mem_hooks;
 156
 157     struct v3_shdw_impl_state shdw_impl;
 158
 159     struct v3_io_map io_map;
 160     struct v3_msr_map msr_map;
 161     struct v3_cpuid_map cpuid_map;
 162
 163     v3_hypercall_map_t hcall_map;
 164
 165
 166     struct v3_intr_routers intr_routers;
 167
 168     /* device_map */
 169     struct vmm_dev_mgr  dev_mgr;
 170
 171     struct v3_time time_state;
 172
 173     struct v3_host_events host_event_hooks;
 174
 175     struct v3_config * cfg_data;
 176
 177     v3_vm_operating_mode_t run_state;
 178
 179     struct v3_barrier barrier;
 180
 181
 182     struct v3_extensions extensions;
 183
 184 #ifdef V3_CONFIG_SYMBIOTIC
 185     /* Symbiotic state */
 186     struct v3_sym_vm_state sym_vm_state;
 187 #endif
 188
 189 #ifdef V3_CONFIG_TELEMETRY
 190     uint_t enable_telemetry;
 191     struct v3_telemetry_state telemetry;
 192 #endif
 193
 194
 195     uint64_t yield_cycle_period;
 196
 197
 198     void * host_priv_data;
 199
 200     int num_cores;
 201
 202     // JRL: This MUST be the last entry...
 203     struct guest_info cores[0];
 204 };
 205
 206 int v3_init_vm(struct v3_vm_info * vm);
 207 int v3_init_core(struct guest_info * core);
 208
 209 int v3_free_vm_internal(struct v3_vm_info * vm);
 210 int v3_free_core(struct guest_info * core);
 211
 212
 213 uint_t v3_get_addr_width(struct guest_info * info);
 214 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
 215 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
 216
 217
 218 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
 219 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
 220
 221 int v3_translate_segment(struct guest_info * info, uint16_t selector, struct v3_segment * seg);
 222
 223
 224 void v3_print_guest_state(struct guest_info * info);
 225
 226 void v3_print_segments(struct v3_segments * segs);
 227 void v3_print_ctrl_regs(struct guest_info * info);
 228 void v3_print_GPRs(struct guest_info * info);
 229
 230 void v3_print_stack(struct guest_info * info);
 231
 232 #endif /* ! __V3VEE__ */
 233
 234 void v3_print_guest_state_all(struct v3_vm_info * vm);
 235
 236 #endif