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_direct_paging.h>
  31 #include <palacios/vmm_intr.h>
  32 #include <palacios/vmm_excp.h>
  33 #include <palacios/vmm_dev_mgr.h>
  34 #include <palacios/vmm_time.h>
  35 #include <palacios/vmm_host_events.h>
  36 #include <palacios/vmm_msr.h>
  37 #include <palacios/vmm_hypercall.h>
  38 #include <palacios/vmm_cpuid.h>
  39 #include <palacios/vmm_regs.h>
  40 #include <palacios/vmm_extensions.h>
  41 #include <palacios/vmm_barrier.h>
  42 #include <palacios/vmm_timeout.h>
  43 #include <palacios/vmm_exits.h>
  44 #include <palacios/vmm_events.h>
  45 #include <palacios/vmm_scheduler.h>
  46 #include <palacios/vmm_fw_cfg.h>
  47 #include <palacios/vmm_fp.h>
  48 #include <palacios/vmm_perftune.h>
  49
  50 #ifdef V3_CONFIG_TELEMETRY
  51 #include <palacios/vmm_telemetry.h>
  52 #endif
  53
  54 #ifdef V3_CONFIG_PMU_TELEMETRY
  55 #include <palacios/vmm_pmu_telemetry.h>
  56 #endif
  57
  58 #ifdef V3_CONFIG_PWRSTAT_TELEMETRY
  59 #include <palacios/vmm_pwrstat_telemetry.h>
  60 #endif
  61
  62 #ifdef V3_CONFIG_SYMBIOTIC
  63 #include <palacios/vmm_symbiotic.h>
  64 struct v3_sym_core_state;
  65 #endif
  66
  67
  68
  69 #include <palacios/vmm_config.h>
  70
  71 struct v3_intr_state;
  72
  73
  74
  75
  76 /* per-core state */
  77 struct guest_info {
  78     char exec_name[256];
  79
  80     uint64_t rip;
  81
  82     uint_t cpl;
  83
  84     struct vm_core_time time_state;
  85     struct v3_core_timeouts timeouts;
  86     void * sched_priv_data;
  87
  88     v3_paging_mode_t shdw_pg_mode;
  89     // arch-independent state of shadow pager
  90     struct v3_shdw_pg_state shdw_pg_state;
  91     // arch-indepedent state of the passthrough pager
  92     addr_t direct_map_pt;
  93     // arch-independent state of the nested pager (currently none)
  94     // struct v3_nested_pg_state nested_pg_state;
  95
  96
  97     union {
  98         uint32_t flags;
  99         struct {
 100             uint8_t use_large_pages        : 1;    /* Enable virtual page tables to use large pages */
 101             uint8_t use_giant_pages        : 1;    /* Enable virtual page tables to use giant (1GB) pages */
 102             uint32_t rsvd                  : 30;
 103         } __attribute__((packed));
 104     } __attribute__((packed));
 105
 106
 107     /* This structure is how we get interrupts for the guest */
 108     struct v3_intr_core_state intr_core_state;
 109
 110     /* This structure is how we get exceptions for the guest */
 111     struct v3_excp_state excp_state;
 112
 113
 114     v3_cpu_mode_t cpu_mode;
 115     v3_mem_mode_t mem_mode;
 116
 117
 118     struct v3_gprs vm_regs;
 119     struct v3_ctrl_regs ctrl_regs;
 120     struct v3_dbg_regs dbg_regs;
 121     struct v3_segments segments;
 122     struct v3_msrs     msrs;
 123
 124     struct v3_fp_state fp_state;
 125
 126     // the arch-dependent state (SVM or VMX)
 127     void * vmm_data;
 128
 129     uint64_t yield_start_cycle;
 130
 131     uint64_t num_exits;
 132
 133 #ifdef V3_CONFIG_TELEMETRY
 134     struct v3_core_telemetry core_telem;
 135 #endif
 136
 137 #ifdef V3_CONFIG_PMU_TELEMETRY
 138     struct v3_core_pmu_telemetry pmu_telem;
 139 #endif
 140
 141 #ifdef V3_CONFIG_PWRSTAT_TELEMETRY
 142     struct v3_core_pwrstat_telemetry pwrstat_telem;
 143 #endif
 144
 145     /* struct v3_core_dev_mgr core_dev_mgr; */
 146
 147     void * decoder_state;
 148
 149 #ifdef V3_CONFIG_SYMBIOTIC
 150     /* Symbiotic state */
 151     struct v3_sym_core_state sym_core_state;
 152 #endif
 153
 154     /* Per-core config tree data. */
 155     v3_cfg_tree_t * core_cfg_data;
 156
 157     struct v3_vm_info * vm_info;
 158
 159     v3_core_operating_mode_t core_run_state;
 160
 161     void * core_thread; /* thread struct for virtual core */
 162
 163     /* the logical cpu on which this core runs */
 164     uint32_t pcpu_id;
 165
 166     /* The virtual core # of this cpu (what the guest sees this core as) */
 167     uint32_t vcpu_id;
 168
 169 };
 170
 171
 172
 173 /* shared state across cores */
 174 struct v3_vm_info {
 175     char name[128];
 176
 177     v3_vm_class_t vm_class;
 178     struct v3_fw_cfg_state fw_cfg_state;
 179
 180     addr_t mem_size; /* In bytes for now */
 181     uint32_t mem_align;
 182     struct v3_mem_map mem_map;
 183
 184     struct v3_mem_hooks mem_hooks;
 185
 186     // arch-indepentent state of shadow pager
 187     struct v3_shdw_impl_state shdw_impl;
 188     // arch-independent state of passthrough pager (currently none)
 189     struct v3_passthrough_impl_state passthrough_impl;
 190     // arch-independent state of the nested pager
 191     struct v3_nested_impl_state nested_impl;
 192     void * sched_priv_data;
 193
 194     struct v3_io_map io_map;
 195     struct v3_msr_map msr_map;
 196     struct v3_cpuid_map cpuid_map;
 197     struct v3_exit_map exit_map;
 198     struct v3_event_map event_map;
 199
 200     v3_hypercall_map_t hcall_map;
 201
 202
 203     struct v3_intr_routers intr_routers;
 204
 205     /* device_map */
 206     struct vmm_dev_mgr  dev_mgr;
 207
 208     struct v3_time time_state;
 209
 210     struct v3_host_events host_event_hooks;
 211
 212     struct v3_config * cfg_data;
 213
 214     v3_vm_operating_mode_t run_state;
 215
 216     struct v3_barrier barrier;
 217
 218
 219     struct v3_extensions extensions;
 220
 221     struct v3_perf_options perf_options;
 222
 223 #ifdef V3_CONFIG_SYMBIOTIC
 224     /* Symbiotic state */
 225     struct v3_sym_vm_state sym_vm_state;
 226 #endif
 227
 228 #ifdef V3_CONFIG_TELEMETRY
 229     uint_t enable_telemetry;
 230     struct v3_telemetry_state telemetry;
 231 #endif
 232
 233
 234     uint64_t yield_cycle_period;
 235
 236
 237     void * host_priv_data;
 238
 239     int num_cores;
 240
 241     int avail_cores; // Available logical cores
 242
 243     // JRL: This MUST be the last entry...
 244     struct guest_info cores[0];
 245 };
 246
 247 int v3_init_vm(struct v3_vm_info * vm);
 248 int v3_init_core(struct guest_info * core);
 249
 250 int v3_free_vm_internal(struct v3_vm_info * vm);
 251 int v3_free_core(struct guest_info * core);
 252
 253
 254 uint_t v3_get_addr_width(struct guest_info * info);
 255 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
 256 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
 257
 258
 259 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
 260 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
 261
 262
 263
 264 #endif /* ! __V3VEE__ */
 265
 266
 267
 268 #endif