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