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