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.


reformatting include files
[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_io.h>
28 #include <palacios/vmm_shadow_paging.h>
29 #include <palacios/vmm_intr.h>
30 #include <palacios/vmm_dev_mgr.h>
31 #include <palacios/vmm_time.h>
32 #include <palacios/vmm_host_events.h>
33 #include <palacios/vmm_msr.h>
34 #include <palacios/vmm_profiler.h>
35 #include <palacios/vmm_hypercall.h>
36
37
38
39 struct v3_gprs {
40     v3_reg_t rdi;
41     v3_reg_t rsi;
42     v3_reg_t rbp;
43     v3_reg_t rsp;
44     v3_reg_t rbx;
45     v3_reg_t rdx;
46     v3_reg_t rcx;
47     v3_reg_t rax;
48
49     v3_reg_t r8;
50     v3_reg_t r9;
51     v3_reg_t r10;
52     v3_reg_t r11;
53     v3_reg_t r12;
54     v3_reg_t r13;
55     v3_reg_t r14;
56     v3_reg_t r15;
57   
58 } __attribute__((packed));
59
60
61 struct v3_ctrl_regs {
62     v3_reg_t cr0;
63     v3_reg_t cr2;
64     v3_reg_t cr3;
65     v3_reg_t cr4;
66     v3_reg_t cr8;
67     v3_reg_t rflags;
68     v3_reg_t efer;
69 };
70
71
72
73 struct v3_dbg_regs {
74     v3_reg_t dr0;
75     v3_reg_t dr1;
76     v3_reg_t dr2;
77     v3_reg_t dr3;
78     v3_reg_t dr6;
79     v3_reg_t dr7;
80 };
81
82 struct v3_segment {
83     ushort_t selector;
84     uint_t limit;
85     ullong_t base;
86     uint_t type           : 4;
87     uint_t system         : 1;
88     uint_t dpl            : 2;
89     uint_t present        : 1;
90     uint_t avail          : 1;
91     uint_t long_mode      : 1;
92     uint_t db             : 1;
93     uint_t granularity    : 1;
94 } __attribute__((packed));
95
96
97 struct v3_segments {
98     struct v3_segment cs;
99     struct v3_segment ds;
100     struct v3_segment es;
101     struct v3_segment fs;
102     struct v3_segment gs;
103     struct v3_segment ss;
104     struct v3_segment ldtr;
105     struct v3_segment gdtr;
106     struct v3_segment idtr;
107     struct v3_segment tr;
108 };
109
110 struct shadow_page_state;
111 struct v3_intr_state;
112 struct v3_profiler;
113
114
115
116
117 struct guest_info {
118     ullong_t rip;
119
120     uint_t cpl;
121
122     addr_t mem_size; // In bytes for now
123     v3_shdw_map_t mem_map;
124
125
126     struct vm_time time_state;
127
128   
129     v3_paging_mode_t shdw_pg_mode;
130     struct shadow_page_state shdw_pg_state;
131     addr_t direct_map_pt;
132     // nested_paging_t nested_page_state;
133
134
135     // This structure is how we get interrupts for the guest
136     struct v3_intr_state intr_state;
137
138     v3_io_map_t io_map;
139
140     struct v3_msr_map msr_map;
141
142
143     v3_hypercall_map_t hcall_map;
144
145     // device_map
146     struct vmm_dev_mgr  dev_mgr;
147
148     struct v3_host_events host_event_hooks;
149
150     v3_vm_cpu_mode_t cpu_mode;
151     v3_vm_mem_mode_t mem_mode;
152     uint_t addr_width;
153
154
155     struct v3_gprs vm_regs;
156     struct v3_ctrl_regs ctrl_regs;
157     struct v3_dbg_regs dbg_regs;
158     struct v3_segments segments;
159
160     v3_vm_operating_mode_t run_state;
161     void * vmm_data;
162
163
164     uint_t enable_profiler;
165     struct v3_profiler profiler;
166
167     void * decoder_state;
168
169     v3_msr_t guest_efer;
170
171     /* Do we need these ? */
172     v3_msr_t guest_star;
173     v3_msr_t guest_lstar;
174     v3_msr_t guest_cstar;
175     v3_msr_t guest_syscall_mask;
176     v3_msr_t guest_gs_base;
177
178
179     uint64_t fs;
180     uint64_t gs;
181
182
183
184 };
185
186
187 uint_t v3_get_addr_width(struct guest_info * info);
188 v3_vm_cpu_mode_t v3_get_cpu_mode(struct guest_info * info);
189 v3_vm_mem_mode_t v3_get_mem_mode(struct guest_info * info);
190
191
192 const uchar_t * v3_cpu_mode_to_str(v3_vm_cpu_mode_t mode);
193 const uchar_t * v3_mem_mode_to_str(v3_vm_mem_mode_t mode);
194
195
196 void v3_print_segments(struct guest_info * info);
197 void v3_print_ctrl_regs(struct guest_info * info);
198 void v3_print_GPRs(struct guest_info * info);
199
200 #endif // ! __V3VEE__
201
202
203
204 #endif