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