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>
41 #ifdef CONFIG_TELEMETRY
42 #include <palacios/vmm_telemetry.h>
46 #ifdef CONFIG_SYMBIOTIC
47 #include <palacios/vmm_symbiotic.h>
48 struct v3_sym_core_state;
51 #include <palacios/vmm_config.h>
66 struct vm_time time_state;
68 v3_paging_mode_t shdw_pg_mode;
69 struct v3_shdw_pg_state shdw_pg_state;
76 uint8_t use_large_pages : 1; /* Enable virtual page tables to use large pages */
77 uint8_t use_giant_pages : 1; /* Enable virtual page tables to use giant (1GB) pages */
79 } __attribute__((packed));
80 } __attribute__((packed));
83 /* This structure is how we get interrupts for the guest */
84 struct v3_intr_core_state intr_core_state;
86 /* This structure is how we get exceptions for the guest */
87 struct v3_excp_state excp_state;
90 v3_cpu_mode_t cpu_mode;
91 v3_mem_mode_t mem_mode;
94 struct v3_gprs vm_regs;
95 struct v3_ctrl_regs ctrl_regs;
96 struct v3_dbg_regs dbg_regs;
97 struct v3_segments segments;
102 uint64_t yield_start_cycle;
106 #ifdef CONFIG_TELEMETRY
107 struct v3_core_telemetry core_telem;
111 /* struct v3_core_dev_mgr core_dev_mgr; */
113 void * decoder_state;
115 #ifdef CONFIG_SYMBIOTIC
116 /* Symbiotic state */
117 struct v3_sym_core_state sym_core_state;
120 /* Per-core config tree data. */
121 v3_cfg_tree_t * core_cfg_data;
123 struct v3_vm_info * vm_info;
125 v3_core_operating_mode_t core_run_state;
127 /* the logical cpu on which this core runs */
134 /* shared state across cores */
138 v3_vm_class_t vm_class;
140 addr_t mem_size; /* In bytes for now */
142 struct v3_mem_map mem_map;
144 v3_paging_size_t paging_size; // for nested paging
146 struct v3_mem_hooks mem_hooks;
148 struct v3_shdw_impl_state shdw_impl;
150 struct v3_io_map io_map;
151 struct v3_msr_map msr_map;
152 struct v3_cpuid_map cpuid_map;
154 v3_hypercall_map_t hcall_map;
157 struct v3_intr_routers intr_routers;
160 struct vmm_dev_mgr dev_mgr;
162 struct v3_host_events host_event_hooks;
164 struct v3_config * cfg_data;
166 v3_vm_operating_mode_t run_state;
171 struct v3_extensions extensions;
173 #ifdef CONFIG_SYMBIOTIC
174 /* Symbiotic state */
175 struct v3_sym_vm_state sym_vm_state;
178 #ifdef CONFIG_TELEMETRY
179 uint_t enable_telemetry;
180 struct v3_telemetry_state telemetry;
183 uint64_t yield_cycle_period;
186 void * host_priv_data;
190 // JRL: This MUST be the last entry...
191 struct guest_info cores[0];
194 int v3_init_vm(struct v3_vm_info * vm);
195 int v3_init_core(struct guest_info * core);
197 int v3_free_vm_internal(struct v3_vm_info * vm);
198 int v3_free_core(struct guest_info * core);
201 uint_t v3_get_addr_width(struct guest_info * info);
202 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
203 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
206 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
207 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
209 int v3_translate_segment(struct guest_info * info, uint16_t selector, struct v3_segment * seg);
212 void v3_print_guest_state(struct guest_info * info);
214 void v3_print_segments(struct v3_segments * segs);
215 void v3_print_ctrl_regs(struct guest_info * info);
216 void v3_print_GPRs(struct guest_info * info);
218 void v3_print_stack(struct guest_info * info);
220 #endif /* ! __V3VEE__ */
222 void v3_print_guest_state_all(struct v3_vm_info * vm);