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