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