Palacios Public Git Repository

To checkout Palacios execute

  git clone http://v3vee.org/palacios/palacios.web/palacios.git
This will give you the master branch. You probably want the devel branch or one of the release branches. To switch to the devel branch, simply execute
  cd palacios
  git checkout --track -b devel origin/devel
The other branches are similar.


removed obsolete telemetry fn
[palacios.git] / palacios / include / palacios / vm_guest.h
1 /*
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.  
5  *
6  * The V3VEE Project is a joint project between Northwestern University
7  * and the University of New Mexico.  You can find out more at 
8  * http://www.v3vee.org
9  *
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.
13  *
14  * Author: Jack Lange <jarusl@cs.northwestern.edu>
15  *
16  * This is free software.  You are permitted to use,
17  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
18  */
19
20 #ifndef __VM_GUEST_H__
21 #define __VM_GUEST_H__
22
23 #ifdef __V3VEE__
24
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
41
42
43 #ifdef V3_CONFIG_TELEMETRY
44 #include <palacios/vmm_telemetry.h>
45 #endif
46
47
48 #ifdef V3_CONFIG_SYMBIOTIC
49 #include <palacios/vmm_symbiotic.h>
50 struct v3_sym_core_state;
51 #endif
52
53
54
55 #include <palacios/vmm_config.h>
56
57 struct v3_intr_state;
58
59
60
61
62 /* per-core state */
63 struct guest_info {
64     char exec_name[256];
65     
66     uint64_t rip;
67
68     uint_t cpl;
69
70     struct vm_time time_state;
71
72     v3_paging_mode_t shdw_pg_mode;
73     struct v3_shdw_pg_state shdw_pg_state;
74     addr_t direct_map_pt;
75     
76
77     union {
78         uint32_t flags;
79         struct {
80             uint8_t use_large_pages        : 1;    /* Enable virtual page tables to use large pages */
81             uint8_t use_giant_pages        : 1;    /* Enable virtual page tables to use giant (1GB) pages */
82             uint32_t rsvd                  : 30;
83         } __attribute__((packed));
84     } __attribute__((packed));
85
86
87     /* This structure is how we get interrupts for the guest */
88     struct v3_intr_core_state intr_core_state;
89
90     /* This structure is how we get exceptions for the guest */
91     struct v3_excp_state excp_state;
92
93
94     v3_cpu_mode_t cpu_mode;
95     v3_mem_mode_t mem_mode;
96
97
98     struct v3_gprs vm_regs;
99     struct v3_ctrl_regs ctrl_regs;
100     struct v3_dbg_regs dbg_regs;
101     struct v3_segments segments;
102
103
104     void * vmm_data;
105
106     uint64_t yield_start_cycle;
107     
108     uint64_t num_exits;
109
110 #ifdef V3_CONFIG_TELEMETRY
111     struct v3_core_telemetry core_telem;
112 #endif
113
114
115     /* struct v3_core_dev_mgr core_dev_mgr; */
116
117     void * decoder_state;
118
119 #ifdef V3_CONFIG_SYMBIOTIC
120     /* Symbiotic state */
121     struct v3_sym_core_state sym_core_state;
122 #endif
123
124     /* Per-core config tree data. */
125     v3_cfg_tree_t * core_cfg_data;
126
127     struct v3_vm_info * vm_info;
128
129     v3_core_operating_mode_t core_run_state;
130
131     /* the logical cpu on which this core runs */
132     uint32_t pcpu_id;
133     
134     /* The virtual core # of this cpu (what the guest sees this core as) */
135     uint32_t vcpu_id;
136      
137 };
138
139
140
141 /* shared state across cores */
142 struct v3_vm_info {
143     char name[128];
144
145     v3_vm_class_t vm_class;
146
147     addr_t mem_size; /* In bytes for now */
148     uint32_t mem_align;
149     struct v3_mem_map mem_map;
150
151     struct v3_mem_hooks mem_hooks;
152
153     struct v3_shdw_impl_state shdw_impl;
154
155     struct v3_io_map io_map;
156     struct v3_msr_map msr_map;
157     struct v3_cpuid_map cpuid_map;
158
159     v3_hypercall_map_t hcall_map;
160
161
162     struct v3_intr_routers intr_routers;
163
164     /* device_map */
165     struct vmm_dev_mgr  dev_mgr;
166
167     struct v3_host_events host_event_hooks;
168
169     struct v3_config * cfg_data;
170
171     v3_vm_operating_mode_t run_state;
172
173
174
175
176     struct v3_extensions extensions;
177
178 #ifdef V3_CONFIG_SYMBIOTIC
179     /* Symbiotic state */
180     struct v3_sym_vm_state sym_vm_state;
181 #endif
182
183 #ifdef V3_CONFIG_TELEMETRY
184     uint_t enable_telemetry;
185     struct v3_telemetry_state telemetry;
186 #endif
187
188
189     uint64_t yield_cycle_period;  
190
191
192     void * host_priv_data;
193
194     int num_cores;
195
196     // JRL: This MUST be the last entry...
197     struct guest_info cores[0];
198 };
199
200 int v3_init_vm(struct v3_vm_info * vm);
201 int v3_init_core(struct guest_info * core);
202
203 int v3_free_vm_internal(struct v3_vm_info * vm);
204 int v3_free_core(struct guest_info * core);
205
206
207 uint_t v3_get_addr_width(struct guest_info * info);
208 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
209 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
210
211
212 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
213 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
214
215 int v3_translate_segment(struct guest_info * info, uint16_t selector, struct v3_segment * seg);
216
217
218 void v3_print_guest_state(struct guest_info * info);
219
220 void v3_print_segments(struct v3_segments * segs);
221 void v3_print_ctrl_regs(struct guest_info * info);
222 void v3_print_GPRs(struct guest_info * info);
223
224 void v3_print_stack(struct guest_info * info);
225
226 #endif /* ! __V3VEE__ */
227
228 void v3_print_guest_state_all(struct v3_vm_info * vm);
229
230 #endif