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