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;
68 #ifdef V3_CONFIG_MEM_TRACK
69 #include <palacios/vmm_mem_track.h>
72 #ifdef V3_CONFIG_MULTIBOOT
73 #include <palacios/vmm_multiboot.h>
77 #include <palacios/vmm_hvm.h>
82 #include <palacios/vmm_config.h>
97 struct vm_core_time time_state;
98 struct v3_core_timeouts timeouts;
99 void * sched_priv_data;
101 v3_paging_mode_t shdw_pg_mode;
102 // arch-independent state of shadow pager
103 struct v3_shdw_pg_state shdw_pg_state;
104 // arch-indepedent state of the passthrough pager
105 addr_t direct_map_pt;
106 // arch-independent state of the nested pager (currently none)
107 // struct v3_nested_pg_state nested_pg_state;
108 // per-core state of the swapper (currently none)
109 //#ifdef V3_CONFIG_SWAPPING
110 // struct v3_swap_impl_state swap_impl;
117 uint8_t use_large_pages : 1; /* Enable virtual page tables to use large pages */
118 uint8_t use_giant_pages : 1; /* Enable virtual page tables to use giant (1GB) pages */
120 } __attribute__((packed));
121 } __attribute__((packed));
124 /* This structure is how we get interrupts for the guest */
125 struct v3_intr_core_state intr_core_state;
127 /* This structure is how we get exceptions for the guest */
128 struct v3_excp_state excp_state;
131 v3_cpu_mode_t cpu_mode;
132 v3_mem_mode_t mem_mode;
135 struct v3_gprs vm_regs;
136 struct v3_ctrl_regs ctrl_regs;
137 struct v3_dbg_regs dbg_regs;
138 struct v3_segments segments;
141 struct v3_fp_state fp_state;
143 // the arch-dependent state (SVM or VMX)
146 uint64_t yield_start_cycle;
150 #ifdef V3_CONFIG_TELEMETRY
151 struct v3_core_telemetry core_telem;
154 #ifdef V3_CONFIG_PMU_TELEMETRY
155 struct v3_core_pmu_telemetry pmu_telem;
158 #ifdef V3_CONFIG_PWRSTAT_TELEMETRY
159 struct v3_core_pwrstat_telemetry pwrstat_telem;
162 #ifdef V3_CONFIG_MEM_TRACK
163 struct v3_core_mem_track memtrack_state;
167 struct v3_core_hvm hvm_state;
171 /* struct v3_core_dev_mgr core_dev_mgr; */
173 void * decoder_state;
175 #ifdef V3_CONFIG_SYMBIOTIC
176 /* Symbiotic state */
177 struct v3_sym_core_state sym_core_state;
180 /* Per-core config tree data. */
181 v3_cfg_tree_t * core_cfg_data;
183 struct v3_vm_info * vm_info;
185 v3_core_operating_mode_t core_run_state;
187 void * core_thread; /* thread struct for virtual core */
189 /* the logical cpu on which this core runs */
192 /* The virtual core # of this cpu (what the guest sees this core as) */
199 /* shared state across cores */
203 v3_vm_class_t vm_class;
204 struct v3_fw_cfg_state fw_cfg_state;
206 // This is always the total RAM (addresses 0...mem_size)
208 // With an HVM, this is partitioned as per hvm_state
209 addr_t mem_size; /* In bytes for now */
211 struct v3_mem_map mem_map;
213 struct v3_mem_hooks mem_hooks;
215 // arch-indepentent state of shadow pager
216 struct v3_shdw_impl_state shdw_impl;
217 // arch-independent state of passthrough pager (currently none)
218 struct v3_passthrough_impl_state passthrough_impl;
219 // arch-independent state of the nested pager
220 struct v3_nested_impl_state nested_impl;
221 #ifdef V3_CONFIG_SWAPPING
222 // swapping state, if enabled
223 struct v3_swap_impl_state swap_state;
226 void * sched_priv_data;
228 struct v3_io_map io_map;
229 struct v3_msr_map msr_map;
230 struct v3_cpuid_map cpuid_map;
231 struct v3_exit_map exit_map;
232 struct v3_event_map event_map;
234 v3_hypercall_map_t hcall_map;
237 struct v3_intr_routers intr_routers;
240 struct vmm_dev_mgr dev_mgr;
242 struct v3_time time_state;
244 struct v3_host_events host_event_hooks;
246 struct v3_config * cfg_data;
248 v3_vm_operating_mode_t run_state;
250 struct v3_barrier barrier;
253 struct v3_extensions extensions;
255 struct v3_perf_options perf_options;
257 #ifdef V3_CONFIG_SYMBIOTIC
258 /* Symbiotic state */
259 struct v3_sym_vm_state sym_vm_state;
262 #ifdef V3_CONFIG_TELEMETRY
263 uint_t enable_telemetry;
264 struct v3_telemetry_state telemetry;
267 #ifdef V3_CONFIG_MEM_TRACK
268 struct v3_vm_mem_track memtrack_state;
271 #ifdef V3_CONFIG_MULTIBOOT
272 struct v3_vm_multiboot mb_state;
276 struct v3_vm_hvm hvm_state;
280 uint64_t yield_cycle_period;
283 void * host_priv_data;
285 // This is always the total number of vcores in the VM
286 // With an HVM, these are partitioned as per hvm_state
289 int avail_cores; // Available logical cores
291 // JRL: This MUST be the last entry...
292 struct guest_info cores[0];
295 int v3_init_vm(struct v3_vm_info * vm);
296 int v3_init_core(struct guest_info * core);
298 int v3_free_vm_internal(struct v3_vm_info * vm);
299 int v3_free_core(struct guest_info * core);
302 uint_t v3_get_addr_width(struct guest_info * info);
303 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
304 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
307 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
308 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
312 #endif /* ! __V3VEE__ */