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>
42 #include <palacios/vmm_exits.h>
43 #include <palacios/vmm_events.h>
44 #include <palacios/vmm_scheduler.h>
45 #include <palacios/vmm_fw_cfg.h>
47 #include <palacios/vmm_perftune.h>
49 #ifdef V3_CONFIG_TELEMETRY
50 #include <palacios/vmm_telemetry.h>
53 #ifdef V3_CONFIG_PMU_TELEMETRY
54 #include <palacios/vmm_pmu_telemetry.h>
57 #ifdef V3_CONFIG_PWRSTAT_TELEMETRY
58 #include <palacios/vmm_pwrstat_telemetry.h>
61 #ifdef V3_CONFIG_SYMBIOTIC
62 #include <palacios/vmm_symbiotic.h>
63 struct v3_sym_core_state;
68 #include <palacios/vmm_config.h>
83 struct vm_core_time time_state;
84 struct v3_core_timeouts timeouts;
85 void * sched_priv_data;
87 v3_paging_mode_t shdw_pg_mode;
88 struct v3_shdw_pg_state shdw_pg_state;
95 uint8_t use_large_pages : 1; /* Enable virtual page tables to use large pages */
96 uint8_t use_giant_pages : 1; /* Enable virtual page tables to use giant (1GB) pages */
98 } __attribute__((packed));
99 } __attribute__((packed));
102 /* This structure is how we get interrupts for the guest */
103 struct v3_intr_core_state intr_core_state;
105 /* This structure is how we get exceptions for the guest */
106 struct v3_excp_state excp_state;
109 v3_cpu_mode_t cpu_mode;
110 v3_mem_mode_t mem_mode;
113 struct v3_gprs vm_regs;
114 struct v3_ctrl_regs ctrl_regs;
115 struct v3_dbg_regs dbg_regs;
116 struct v3_segments segments;
122 uint64_t yield_start_cycle;
126 #ifdef V3_CONFIG_TELEMETRY
127 struct v3_core_telemetry core_telem;
130 #ifdef V3_CONFIG_PMU_TELEMETRY
131 struct v3_core_pmu_telemetry pmu_telem;
134 #ifdef V3_CONFIG_PWRSTAT_TELEMETRY
135 struct v3_core_pwrstat_telemetry pwrstat_telem;
138 /* struct v3_core_dev_mgr core_dev_mgr; */
140 void * decoder_state;
142 #ifdef V3_CONFIG_SYMBIOTIC
143 /* Symbiotic state */
144 struct v3_sym_core_state sym_core_state;
147 /* Per-core config tree data. */
148 v3_cfg_tree_t * core_cfg_data;
150 struct v3_vm_info * vm_info;
152 v3_core_operating_mode_t core_run_state;
154 void * core_thread; /* thread struct for virtual core */
156 /* the logical cpu on which this core runs */
159 /* The virtual core # of this cpu (what the guest sees this core as) */
166 /* shared state across cores */
170 v3_vm_class_t vm_class;
171 struct v3_fw_cfg_state fw_cfg_state;
173 addr_t mem_size; /* In bytes for now */
175 struct v3_mem_map mem_map;
177 struct v3_mem_hooks mem_hooks;
179 struct v3_shdw_impl_state shdw_impl;
180 void * sched_priv_data;
182 struct v3_io_map io_map;
183 struct v3_msr_map msr_map;
184 struct v3_cpuid_map cpuid_map;
185 struct v3_exit_map exit_map;
186 struct v3_event_map event_map;
188 v3_hypercall_map_t hcall_map;
191 struct v3_intr_routers intr_routers;
194 struct vmm_dev_mgr dev_mgr;
196 struct v3_time time_state;
198 struct v3_host_events host_event_hooks;
200 struct v3_config * cfg_data;
202 v3_vm_operating_mode_t run_state;
204 struct v3_barrier barrier;
207 struct v3_extensions extensions;
209 struct v3_perf_options perf_options;
211 #ifdef V3_CONFIG_SYMBIOTIC
212 /* Symbiotic state */
213 struct v3_sym_vm_state sym_vm_state;
216 #ifdef V3_CONFIG_TELEMETRY
217 uint_t enable_telemetry;
218 struct v3_telemetry_state telemetry;
222 uint64_t yield_cycle_period;
225 void * host_priv_data;
229 int avail_cores; // Available logical cores
231 // JRL: This MUST be the last entry...
232 struct guest_info cores[0];
235 int v3_init_vm(struct v3_vm_info * vm);
236 int v3_init_core(struct guest_info * core);
238 int v3_free_vm_internal(struct v3_vm_info * vm);
239 int v3_free_core(struct guest_info * core);
242 uint_t v3_get_addr_width(struct guest_info * info);
243 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
244 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
247 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
248 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
252 #endif /* ! __V3VEE__ */