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