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
  42
  43 #ifdef V3_CONFIG_TELEMETRY
  44 #include <palacios/vmm_telemetry.h>
  45 #endif
  46
  47
  48 #ifdef V3_CONFIG_SYMBIOTIC
  49 #include <palacios/vmm_symbiotic.h>
  50 struct v3_sym_core_state;
  51 #endif
  52
  53 #ifdef V3_CONFIG_SYSCALL_HIJACK
  54 #include <palacios/vmm_syscall_hijack.h>
  55 #include <palacios/vmm_execve_hook.h>
  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_time time_state;
  76
  77     v3_paging_mode_t shdw_pg_mode;
  78     struct v3_shdw_pg_state shdw_pg_state;
  79     addr_t direct_map_pt;
  80
  81
  82     union {
  83         uint32_t flags;
  84         struct {
  85             uint8_t use_large_pages        : 1;    /* Enable virtual page tables to use large pages */
  86             uint8_t use_giant_pages        : 1;    /* Enable virtual page tables to use giant (1GB) pages */
  87             uint32_t rsvd                  : 30;
  88         } __attribute__((packed));
  89     } __attribute__((packed));
  90
  91
  92     /* This structure is how we get interrupts for the guest */
  93     struct v3_intr_core_state intr_core_state;
  94
  95     /* This structure is how we get exceptions for the guest */
  96     struct v3_excp_state excp_state;
  97
  98 #ifdef V3_CONFIG_SYSCALL_HIJACK
  99     struct v3_syscall_hook_map sc_hook_map;
 100     struct v3_execve_varchunk var_dump;
 101     struct v3_exec_hooks exec_hooks;
 102 #endif
 103
 104
 105     v3_cpu_mode_t cpu_mode;
 106     v3_mem_mode_t mem_mode;
 107
 108
 109     struct v3_gprs vm_regs;
 110     struct v3_ctrl_regs ctrl_regs;
 111     struct v3_dbg_regs dbg_regs;
 112     struct v3_segments segments;
 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
 126     /* struct v3_core_dev_mgr core_dev_mgr; */
 127
 128     void * decoder_state;
 129
 130 #ifdef V3_CONFIG_SYMBIOTIC
 131     /* Symbiotic state */
 132     struct v3_sym_core_state sym_core_state;
 133 #endif
 134
 135     /* Per-core config tree data. */
 136     v3_cfg_tree_t * core_cfg_data;
 137
 138     struct v3_vm_info * vm_info;
 139
 140     v3_core_operating_mode_t core_run_state;
 141
 142     /* the logical cpu on which this core runs */
 143     uint32_t pcpu_id;
 144
 145     /* The virtual core # of this cpu (what the guest sees this core as) */
 146     uint32_t vcpu_id;
 147
 148 };
 149
 150
 151
 152 /* shared state across cores */
 153 struct v3_vm_info {
 154     char name[128];
 155
 156     v3_vm_class_t vm_class;
 157
 158     addr_t mem_size; /* In bytes for now */
 159     uint32_t mem_align;
 160     struct v3_mem_map mem_map;
 161
 162     struct v3_mem_hooks mem_hooks;
 163
 164     struct v3_shdw_impl_state shdw_impl;
 165
 166     struct v3_io_map io_map;
 167     struct v3_msr_map msr_map;
 168     struct v3_cpuid_map cpuid_map;
 169
 170     v3_hypercall_map_t hcall_map;
 171
 172
 173     struct v3_intr_routers intr_routers;
 174
 175     /* device_map */
 176     struct vmm_dev_mgr  dev_mgr;
 177
 178     struct v3_host_events host_event_hooks;
 179
 180     struct v3_config * cfg_data;
 181
 182     v3_vm_operating_mode_t run_state;
 183
 184
 185
 186
 187     struct v3_extensions extensions;
 188
 189 #ifdef V3_CONFIG_SYMBIOTIC
 190     /* Symbiotic state */
 191     struct v3_sym_vm_state sym_vm_state;
 192 #endif
 193
 194 #ifdef V3_CONFIG_TELEMETRY
 195     uint_t enable_telemetry;
 196     struct v3_telemetry_state telemetry;
 197 #endif
 198
 199
 200     uint64_t yield_cycle_period;
 201
 202
 203     void * host_priv_data;
 204
 205     int num_cores;
 206
 207     // JRL: This MUST be the last entry...
 208     struct guest_info cores[0];
 209 };
 210
 211 int v3_init_vm(struct v3_vm_info * vm);
 212 int v3_init_core(struct guest_info * core);
 213
 214 int v3_free_vm_internal(struct v3_vm_info * vm);
 215 int v3_free_core(struct guest_info * core);
 216
 217
 218 uint_t v3_get_addr_width(struct guest_info * info);
 219 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
 220 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
 221
 222
 223 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
 224 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
 225
 226 int v3_translate_segment(struct guest_info * info, uint16_t selector, struct v3_segment * seg);
 227
 228
 229 void v3_print_guest_state(struct guest_info * info);
 230
 231 void v3_print_segments(struct v3_segments * segs);
 232 void v3_print_ctrl_regs(struct guest_info * info);
 233 void v3_print_GPRs(struct guest_info * info);
 234
 235 void v3_print_stack(struct guest_info * info);
 236
 237 #endif /* ! __V3VEE__ */
 238
 239 void v3_print_guest_state_all(struct v3_vm_info * vm);
 240
 241 #endif