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.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
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.
14 * Author: Jack Lange <jarusl@cs.northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
20 #ifndef __VM_GUEST_H__
21 #define __VM_GUEST_H__
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 #include <palacios/vmm_barrier.h>
41 #include <palacios/vmm_timeout.h>
44 #ifdef V3_CONFIG_TELEMETRY
45 #include <palacios/vmm_telemetry.h>
49 #ifdef V3_CONFIG_SYMBIOTIC
50 #include <palacios/vmm_symbiotic.h>
51 struct v3_sym_core_state;
56 #include <palacios/vmm_config.h>
71 struct vm_core_time time_state;
72 struct v3_core_timeouts timeouts;
74 v3_paging_mode_t shdw_pg_mode;
75 struct v3_shdw_pg_state shdw_pg_state;
82 uint8_t use_large_pages : 1; /* Enable virtual page tables to use large pages */
83 uint8_t use_giant_pages : 1; /* Enable virtual page tables to use giant (1GB) pages */
85 } __attribute__((packed));
86 } __attribute__((packed));
89 /* This structure is how we get interrupts for the guest */
90 struct v3_intr_core_state intr_core_state;
92 /* This structure is how we get exceptions for the guest */
93 struct v3_excp_state excp_state;
96 v3_cpu_mode_t cpu_mode;
97 v3_mem_mode_t mem_mode;
100 struct v3_gprs vm_regs;
101 struct v3_ctrl_regs ctrl_regs;
102 struct v3_dbg_regs dbg_regs;
103 struct v3_segments segments;
109 uint64_t yield_start_cycle;
113 #ifdef V3_CONFIG_TELEMETRY
114 struct v3_core_telemetry core_telem;
118 /* struct v3_core_dev_mgr core_dev_mgr; */
120 void * decoder_state;
122 #ifdef V3_CONFIG_SYMBIOTIC
123 /* Symbiotic state */
124 struct v3_sym_core_state sym_core_state;
127 /* Per-core config tree data. */
128 v3_cfg_tree_t * core_cfg_data;
130 struct v3_vm_info * vm_info;
132 v3_core_operating_mode_t core_run_state;
134 void * core_thread; /* thread struct for virtual core */
136 /* the logical cpu on which this core runs */
139 /* The virtual core # of this cpu (what the guest sees this core as) */
146 /* shared state across cores */
150 v3_vm_class_t vm_class;
152 addr_t mem_size; /* In bytes for now */
154 struct v3_mem_map mem_map;
156 struct v3_mem_hooks mem_hooks;
158 struct v3_shdw_impl_state shdw_impl;
160 struct v3_io_map io_map;
161 struct v3_msr_map msr_map;
162 struct v3_cpuid_map cpuid_map;
164 v3_hypercall_map_t hcall_map;
167 struct v3_intr_routers intr_routers;
170 struct vmm_dev_mgr dev_mgr;
172 struct v3_time time_state;
174 struct v3_host_events host_event_hooks;
176 struct v3_config * cfg_data;
178 v3_vm_operating_mode_t run_state;
180 struct v3_barrier barrier;
183 struct v3_extensions extensions;
185 #ifdef V3_CONFIG_SYMBIOTIC
186 /* Symbiotic state */
187 struct v3_sym_vm_state sym_vm_state;
190 #ifdef V3_CONFIG_TELEMETRY
191 uint_t enable_telemetry;
192 struct v3_telemetry_state telemetry;
196 uint64_t yield_cycle_period;
199 void * host_priv_data;
203 // JRL: This MUST be the last entry...
204 struct guest_info cores[0];
207 int v3_init_vm(struct v3_vm_info * vm);
208 int v3_init_core(struct guest_info * core);
210 int v3_free_vm_internal(struct v3_vm_info * vm);
211 int v3_free_core(struct guest_info * core);
214 uint_t v3_get_addr_width(struct guest_info * info);
215 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
216 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
219 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
220 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
224 #endif /* ! __V3VEE__ */