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