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.


Merge branch 'devel' of palacios@newskysaw.cs.northwestern.edu:/home/palacios/palacio...
[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 #include <palacios/vmm_barrier.h>
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     v3_core_moving_state_t core_move_state;  /* if 1, then it is to be migrated to current pcpu_id */
132     uint32_t target_pcpu_id; /* the target physical CPU id for core moving */
133
134     void * core_thread; /* thread struct for virtual core */
135
136     /* the logical cpu on which this core runs */
137     uint32_t pcpu_id;
138     
139     /* The virtual core # of this cpu (what the guest sees this core as) */
140     uint32_t vcpu_id;
141      
142 };
143
144
145
146 /* shared state across cores */
147 struct v3_vm_info {
148     char name[128];
149
150     v3_vm_class_t vm_class;
151
152     addr_t mem_size; /* In bytes for now */
153     uint32_t mem_align;
154     struct v3_mem_map mem_map;
155
156     struct v3_mem_hooks mem_hooks;
157
158     struct v3_shdw_impl_state shdw_impl;
159
160     struct v3_io_map io_map;
161     struct v3_msr_map msr_map;
162     struct v3_cpuid_map cpuid_map;
163
164     v3_hypercall_map_t hcall_map;
165
166
167     struct v3_intr_routers intr_routers;
168
169     /* device_map */
170     struct vmm_dev_mgr  dev_mgr;
171
172     struct v3_host_events host_event_hooks;
173
174     struct v3_config * cfg_data;
175
176     v3_vm_operating_mode_t run_state;
177
178     struct v3_barrier barrier;
179
180
181     struct v3_extensions extensions;
182
183 #ifdef V3_CONFIG_SYMBIOTIC
184     /* Symbiotic state */
185     struct v3_sym_vm_state sym_vm_state;
186 #endif
187
188 #ifdef V3_CONFIG_TELEMETRY
189     uint_t enable_telemetry;
190     struct v3_telemetry_state telemetry;
191 #endif
192
193
194     uint64_t yield_cycle_period;  
195
196
197     void * host_priv_data;
198
199     int num_cores;
200
201     // JRL: This MUST be the last entry...
202     struct guest_info cores[0];
203 };
204
205 int v3_init_vm(struct v3_vm_info * vm);
206 int v3_init_core(struct guest_info * core);
207
208 int v3_free_vm_internal(struct v3_vm_info * vm);
209 int v3_free_core(struct guest_info * core);
210
211
212 uint_t v3_get_addr_width(struct guest_info * info);
213 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
214 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
215
216
217 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
218 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
219
220 int v3_translate_segment(struct guest_info * info, uint16_t selector, struct v3_segment * seg);
221
222
223 void v3_print_guest_state(struct guest_info * info);
224
225 void v3_print_segments(struct v3_segments * segs);
226 void v3_print_ctrl_regs(struct guest_info * info);
227 void v3_print_GPRs(struct guest_info * info);
228
229 void v3_print_stack(struct guest_info * info);
230
231 #endif /* ! __V3VEE__ */
232
233 void v3_print_guest_state_all(struct v3_vm_info * vm);
234
235 #endif