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