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