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