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_direct_paging.h>
31 #include <palacios/vmm_intr.h>
32 #include <palacios/vmm_excp.h>
33 #include <palacios/vmm_dev_mgr.h>
34 #include <palacios/vmm_time.h>
35 #include <palacios/vmm_host_events.h>
36 #include <palacios/vmm_msr.h>
37 #include <palacios/vmm_hypercall.h>
38 #include <palacios/vmm_cpuid.h>
39 #include <palacios/vmm_regs.h>
40 #include <palacios/vmm_extensions.h>
41 #include <palacios/vmm_barrier.h>
42 #include <palacios/vmm_timeout.h>
43 #include <palacios/vmm_exits.h>
44 #include <palacios/vmm_events.h>
45 #include <palacios/vmm_scheduler.h>
46 #include <palacios/vmm_fw_cfg.h>
47 #include <palacios/vmm_fp.h>
48 #include <palacios/vmm_perftune.h>
51 #ifdef V3_CONFIG_TELEMETRY
52 #include <palacios/vmm_telemetry.h>
55 #ifdef V3_CONFIG_PMU_TELEMETRY
56 #include <palacios/vmm_pmu_telemetry.h>
59 #ifdef V3_CONFIG_PWRSTAT_TELEMETRY
60 #include <palacios/vmm_pwrstat_telemetry.h>
63 #ifdef V3_CONFIG_SYMBIOTIC
64 #include <palacios/vmm_symbiotic.h>
65 struct v3_sym_core_state;
70 #include <palacios/vmm_config.h>
85 struct vm_core_time time_state;
86 struct v3_core_timeouts timeouts;
87 void * sched_priv_data;
89 v3_paging_mode_t shdw_pg_mode;
90 // arch-independent state of shadow pager
91 struct v3_shdw_pg_state shdw_pg_state;
92 // arch-indepedent state of the passthrough pager
94 // arch-independent state of the nested pager (currently none)
95 // struct v3_nested_pg_state nested_pg_state;
96 // per-core state of the swapper (currently none)
97 //#ifdef V3_CONFIG_SWAPPING
98 // struct v3_swap_impl_state swap_impl;
105 uint8_t use_large_pages : 1; /* Enable virtual page tables to use large pages */
106 uint8_t use_giant_pages : 1; /* Enable virtual page tables to use giant (1GB) pages */
108 } __attribute__((packed));
109 } __attribute__((packed));
112 /* This structure is how we get interrupts for the guest */
113 struct v3_intr_core_state intr_core_state;
115 /* This structure is how we get exceptions for the guest */
116 struct v3_excp_state excp_state;
119 v3_cpu_mode_t cpu_mode;
120 v3_mem_mode_t mem_mode;
123 struct v3_gprs vm_regs;
124 struct v3_ctrl_regs ctrl_regs;
125 struct v3_dbg_regs dbg_regs;
126 struct v3_segments segments;
129 struct v3_fp_state fp_state;
131 // the arch-dependent state (SVM or VMX)
134 uint64_t yield_start_cycle;
138 #ifdef V3_CONFIG_TELEMETRY
139 struct v3_core_telemetry core_telem;
142 #ifdef V3_CONFIG_PMU_TELEMETRY
143 struct v3_core_pmu_telemetry pmu_telem;
146 #ifdef V3_CONFIG_PWRSTAT_TELEMETRY
147 struct v3_core_pwrstat_telemetry pwrstat_telem;
150 /* struct v3_core_dev_mgr core_dev_mgr; */
152 void * decoder_state;
154 #ifdef V3_CONFIG_SYMBIOTIC
155 /* Symbiotic state */
156 struct v3_sym_core_state sym_core_state;
159 /* Per-core config tree data. */
160 v3_cfg_tree_t * core_cfg_data;
162 struct v3_vm_info * vm_info;
164 v3_core_operating_mode_t core_run_state;
166 void * core_thread; /* thread struct for virtual core */
168 /* the logical cpu on which this core runs */
171 /* The virtual core # of this cpu (what the guest sees this core as) */
178 /* shared state across cores */
182 v3_vm_class_t vm_class;
183 struct v3_fw_cfg_state fw_cfg_state;
185 addr_t mem_size; /* In bytes for now */
187 struct v3_mem_map mem_map;
189 struct v3_mem_hooks mem_hooks;
191 // arch-indepentent state of shadow pager
192 struct v3_shdw_impl_state shdw_impl;
193 // arch-independent state of passthrough pager (currently none)
194 struct v3_passthrough_impl_state passthrough_impl;
195 // arch-independent state of the nested pager
196 struct v3_nested_impl_state nested_impl;
197 #ifdef V3_CONFIG_SWAPPING
198 // swapping state, if enabled
199 struct v3_swap_impl_state swap_state;
202 void * sched_priv_data;
204 struct v3_io_map io_map;
205 struct v3_msr_map msr_map;
206 struct v3_cpuid_map cpuid_map;
207 struct v3_exit_map exit_map;
208 struct v3_event_map event_map;
210 v3_hypercall_map_t hcall_map;
213 struct v3_intr_routers intr_routers;
216 struct vmm_dev_mgr dev_mgr;
218 struct v3_time time_state;
220 struct v3_host_events host_event_hooks;
222 struct v3_config * cfg_data;
224 v3_vm_operating_mode_t run_state;
226 struct v3_barrier barrier;
229 struct v3_extensions extensions;
231 struct v3_perf_options perf_options;
233 #ifdef V3_CONFIG_SYMBIOTIC
234 /* Symbiotic state */
235 struct v3_sym_vm_state sym_vm_state;
238 #ifdef V3_CONFIG_TELEMETRY
239 uint_t enable_telemetry;
240 struct v3_telemetry_state telemetry;
243 uint64_t yield_cycle_period;
246 void * host_priv_data;
250 int avail_cores; // Available logical cores
252 // JRL: This MUST be the last entry...
253 struct guest_info cores[0];
256 int v3_init_vm(struct v3_vm_info * vm);
257 int v3_init_core(struct guest_info * core);
259 int v3_free_vm_internal(struct v3_vm_info * vm);
260 int v3_free_core(struct guest_info * core);
263 uint_t v3_get_addr_width(struct guest_info * info);
264 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
265 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
268 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
269 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
273 #endif /* ! __V3VEE__ */