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>
40 #ifdef CONFIG_TELEMETRY
41 #include <palacios/vmm_telemetry.h>
45 #ifdef CONFIG_SYMBIOTIC
46 #include <palacios/vmm_symbiotic.h>
47 struct v3_sym_core_state;
50 #include <palacios/vmm_config.h>
65 struct vm_time time_state;
67 v3_paging_mode_t shdw_pg_mode;
68 struct v3_shdw_pg_state shdw_pg_state;
75 uint8_t use_large_pages : 1; /* Enable virtual page tables to use large pages */
76 uint8_t use_giant_pages : 1; /* Enable virtual page tables to use giant (1GB) pages */
78 } __attribute__((packed));
79 } __attribute__((packed));
82 /* This structure is how we get interrupts for the guest */
83 struct v3_intr_core_state intr_core_state;
85 /* This structure is how we get exceptions for the guest */
86 struct v3_excp_state excp_state;
89 v3_cpu_mode_t cpu_mode;
90 v3_mem_mode_t mem_mode;
93 struct v3_gprs vm_regs;
94 struct v3_ctrl_regs ctrl_regs;
95 struct v3_dbg_regs dbg_regs;
96 struct v3_segments segments;
101 uint64_t yield_start_cycle;
105 #ifdef CONFIG_TELEMETRY
106 struct v3_core_telemetry core_telem;
110 /* struct v3_core_dev_mgr core_dev_mgr; */
112 void * decoder_state;
114 #ifdef CONFIG_SYMBIOTIC
115 /* Symbiotic state */
116 struct v3_sym_core_state sym_core_state;
119 /* Per-core config tree data. */
120 v3_cfg_tree_t * core_cfg_data;
122 struct v3_vm_info * vm_info;
124 v3_core_operating_mode_t core_run_state;
126 /* the logical cpu on which this core runs */
132 /* shared state across cores */
136 v3_vm_class_t vm_class;
138 addr_t mem_size; /* In bytes for now */
140 struct v3_mem_map mem_map;
142 v3_paging_size_t paging_size; // for nested paging
144 struct v3_mem_hooks mem_hooks;
146 struct v3_shdw_impl_state shdw_impl;
148 struct v3_io_map io_map;
149 struct v3_msr_map msr_map;
150 struct v3_cpuid_map cpuid_map;
152 v3_hypercall_map_t hcall_map;
155 struct v3_intr_routers intr_routers;
158 struct vmm_dev_mgr dev_mgr;
160 struct v3_host_events host_event_hooks;
162 struct v3_config * cfg_data;
164 v3_vm_operating_mode_t run_state;
166 #ifdef CONFIG_SYMBIOTIC
167 /* Symbiotic state */
168 struct v3_sym_vm_state sym_vm_state;
173 #ifdef CONFIG_TELEMETRY
174 uint_t enable_telemetry;
175 struct v3_telemetry_state telemetry;
178 uint64_t yield_cycle_period;
181 void * host_priv_data;
185 // JRL: This MUST be the last entry...
186 struct guest_info cores[0];
189 int v3_init_vm(struct v3_vm_info * vm);
190 int v3_init_core(struct guest_info * core);
193 uint_t v3_get_addr_width(struct guest_info * info);
194 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
195 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
198 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
199 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
201 int v3_translate_segment(struct guest_info * info, uint16_t selector, struct v3_segment * seg);
204 void v3_print_guest_state(struct guest_info * info);
206 void v3_print_segments(struct v3_segments * segs);
207 void v3_print_ctrl_regs(struct guest_info * info);
208 void v3_print_GPRs(struct guest_info * info);
210 void v3_print_stack(struct guest_info * info);
212 #endif /* ! __V3VEE__ */