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.


*** empty log message ***
[palacios-OLD.git] / palacios / include / palacios / vmcb.h
1 #ifndef __VMCB_H
2 #define __VMCB_H
3
4 #include <palacios/vmm_types.h>
5 #include <palacios/vm_guest.h>
6
7 #define VMCB_CTRL_AREA_OFFSET                   0x0
8 #define VMCB_STATE_SAVE_AREA_OFFSET             0x400
9
10
11 #define GET_VMCB_CTRL_AREA(page)         (page + VMCB_CTRL_AREA_OFFSET)
12 #define GET_VMCB_SAVE_STATE_AREA(page)   (page + VMCB_STATE_SAVE_AREA_OFFSET)
13
14
15 #if __TINYC__
16 #define PACKED
17 #else
18 #define PACKED __attribute__((packed))
19 #endif
20
21
22 typedef void vmcb_t;
23
24
25 struct Ctrl_Registers {
26     uint_t cr0        : 1        PACKED;
27     uint_t cr1        : 1        PACKED;
28     uint_t cr2        : 1        PACKED;
29     uint_t cr3        : 1        PACKED;
30     uint_t cr4        : 1        PACKED;
31     uint_t cr5        : 1        PACKED;
32     uint_t cr6        : 1        PACKED;
33     uint_t cr7        : 1        PACKED;
34     uint_t cr8        : 1        PACKED;
35     uint_t cr9        : 1        PACKED;
36     uint_t cr10       : 1        PACKED;
37     uint_t cr11       : 1        PACKED;
38     uint_t cr12       : 1        PACKED;
39     uint_t cr13       : 1        PACKED;
40     uint_t cr14       : 1        PACKED;
41     uint_t cr15       : 1        PACKED;
42 };
43
44
45 struct Debug_Registers {
46     uint_t dr0        : 1        PACKED;
47     uint_t dr1        : 1        PACKED;
48     uint_t dr2        : 1        PACKED;
49     uint_t dr3        : 1        PACKED;
50     uint_t dr4        : 1        PACKED;
51     uint_t dr5        : 1        PACKED;
52     uint_t dr6        : 1        PACKED;
53     uint_t dr7        : 1        PACKED;
54     uint_t dr8        : 1        PACKED;
55     uint_t dr9        : 1        PACKED;
56     uint_t dr10       : 1        PACKED;
57     uint_t dr11       : 1        PACKED;
58     uint_t dr12       : 1        PACKED;
59     uint_t dr13       : 1        PACKED;
60     uint_t dr14       : 1        PACKED;
61     uint_t dr15       : 1        PACKED;
62 };
63
64
65 struct Exception_Vectors {
66     uint_t de          : 1        PACKED; // (0) divide by zero
67     uint_t db          : 1        PACKED; // (1) Debug
68     uint_t nmi         : 1        PACKED; // (2) Non-maskable interrupt
69     uint_t bp          : 1        PACKED; // (3) Breakpoint
70     uint_t of          : 1        PACKED; // (4) Overflow
71     uint_t br          : 1        PACKED; // (5) Bound-Range
72     uint_t ud          : 1        PACKED; // (6) Invalid-Opcode
73     uint_t nm          : 1        PACKED; // (7) Device-not-available
74     uint_t df          : 1        PACKED; // (8) Double Fault
75     uint_t ex9         : 1        PACKED; 
76     uint_t ts          : 1        PACKED; // (10) Invalid TSS
77     uint_t np          : 1        PACKED; // (11) Segment-not-present
78     uint_t ss          : 1        PACKED; // (12) Stack
79     uint_t gp          : 1        PACKED; // (13) General Protection Fault
80     uint_t pf          : 1        PACKED; // (14) Page fault
81     uint_t ex15        : 1        PACKED;
82     uint_t mf          : 1        PACKED; // (15) Floating point exception
83     uint_t ac          : 1        PACKED; // (16) Alignment-check
84     uint_t mc          : 1        PACKED; // (17) Machine Check
85     uint_t xf          : 1        PACKED; // (18) SIMD floating-point
86     uint_t ex20        : 1        PACKED;
87     uint_t ex21        : 1        PACKED;
88     uint_t ex22        : 1        PACKED;
89     uint_t ex23        : 1        PACKED;
90     uint_t ex24        : 1        PACKED;
91     uint_t ex25        : 1        PACKED;
92     uint_t ex26        : 1        PACKED;
93     uint_t ex27        : 1        PACKED;
94     uint_t ex28        : 1        PACKED;
95     uint_t ex29        : 1        PACKED;
96     uint_t sx          : 1        PACKED; // (30) Security Exception
97     uint_t ex31        : 1        PACKED;
98 };
99
100
101 struct Instr_Intercepts {
102     uint_t INTR        : 1        PACKED;
103     uint_t NMI         : 1        PACKED;
104     uint_t SMI         : 1        PACKED;
105     uint_t INIT        : 1        PACKED;
106     uint_t VINTR       : 1        PACKED;
107     uint_t CR0         : 1        PACKED;
108     uint_t RD_IDTR     : 1        PACKED;
109     uint_t RD_GDTR     : 1        PACKED;
110     uint_t RD_LDTR     : 1        PACKED;
111     uint_t RD_TR       : 1        PACKED;
112     uint_t WR_IDTR     : 1        PACKED;
113     uint_t WR_GDTR     : 1        PACKED;
114     uint_t WR_LDTR     : 1        PACKED;
115     uint_t WR_TR       : 1        PACKED;
116     uint_t RDTSC       : 1        PACKED;
117     uint_t RDPMC       : 1        PACKED;
118     uint_t PUSHF       : 1        PACKED;
119     uint_t POPF        : 1        PACKED;
120     uint_t CPUID       : 1        PACKED;
121     uint_t RSM         : 1        PACKED;
122     uint_t IRET        : 1        PACKED;
123     uint_t INTn        : 1        PACKED;
124     uint_t INVD        : 1        PACKED;
125     uint_t PAUSE       : 1        PACKED;
126     uint_t HLT         : 1        PACKED;
127     uint_t INVLPG      : 1        PACKED;
128     uint_t INVLPGA     : 1        PACKED;
129     uint_t IOIO_PROT   : 1        PACKED;
130     uint_t MSR_PROT    : 1        PACKED;
131     uint_t task_switch : 1        PACKED;
132     uint_t FERR_FREEZE : 1        PACKED;
133     uint_t shutdown_evts: 1       PACKED;
134 };
135
136 struct SVM_Instr_Intercepts { 
137   uint_t VMRUN      : 1         PACKED;
138   uint_t VMMCALL    : 1         PACKED;
139   uint_t VMLOAD     : 1         PACKED;
140   uint_t VMSAVE     : 1         PACKED;
141   uint_t STGI       : 1         PACKED;
142   uint_t CLGI       : 1         PACKED;
143   uint_t SKINIT     : 1         PACKED;
144   uint_t RDTSCP     : 1         PACKED;
145   uint_t ICEBP      : 1         PACKED;
146   uint_t WBINVD     : 1         PACKED;
147   uint_t MONITOR    : 1         PACKED;
148   uint_t MWAIT_always : 1       PACKED;
149   uint_t MWAIT_if_armed : 1     PACKED;
150   uint_t reserved  : 19         PACKED;  // Should be 0
151 };
152
153
154 struct Guest_Control {
155   uchar_t V_TPR                 PACKED;
156   uint_t V_IRQ      : 1         PACKED;
157   uint_t rsvd1      : 7         PACKED;  // Should be 0
158   uint_t V_INTR_PRIO : 4        PACKED;
159   uint_t V_IGN_TPR  : 1         PACKED;
160   uint_t rsvd2      : 3         PACKED;  // Should be 0
161   uint_t V_INTR_MASKING : 1     PACKED;
162   uint_t rsvd3      : 7         PACKED;  // Should be 0
163   uchar_t V_INTR_VECTOR         PACKED;
164   uint_t rsvd4      : 24        PACKED;  // Should be 0
165 };
166
167 #define SVM_INJECTION_EXTERNAL_INTR 0
168 #define SVM_INJECTION_VIRTUAL_INTR  0
169 #define SVM_INJECTION_NMI           2
170 #define SVM_INJECTION_EXCEPTION     3
171 #define SVM_INJECTION_SOFT_INTR     4
172
173 struct Interrupt_Info {
174   uint_t vector       : 8         PACKED;
175   uint_t type         : 3         PACKED;
176   uint_t ev           : 1         PACKED;
177   uint_t rsvd         : 19        PACKED;
178   uint_t valid        : 1         PACKED;
179   uint_t error_code   : 32        PACKED;
180 };
181
182
183 typedef struct VMCB_Control_Area {
184   // offset 0x0
185   struct Ctrl_Registers cr_reads         PACKED;
186   struct Ctrl_Registers cr_writes        PACKED;
187   struct Debug_Registers dr_reads        PACKED;
188   struct Debug_Registers dr_writes       PACKED;
189   struct Exception_Vectors exceptions    PACKED;
190   struct Instr_Intercepts instrs         PACKED;
191   struct SVM_Instr_Intercepts svm_instrs PACKED;
192
193   uchar_t rsvd1[44]                     PACKED;  // Should be 0
194
195   // offset 0x040
196   ullong_t IOPM_BASE_PA                 PACKED;
197   ullong_t MSRPM_BASE_PA                PACKED;
198   ullong_t TSC_OFFSET                   PACKED;
199
200   uint_t guest_ASID                     PACKED;
201   uchar_t TLB_CONTROL                   PACKED;
202
203   uchar_t rsvd2[3]                      PACKED;  // Should be 0
204
205   struct Guest_Control guest_ctrl        PACKED;
206   
207   uint_t interrupt_shadow  : 1          PACKED;
208   uint_t rsvd3             : 31         PACKED;  // Should be 0
209   uint_t rsvd4                          PACKED;  // Should be 0
210
211   ullong_t exit_code                    PACKED;
212   ullong_t exit_info1                   PACKED;
213   ullong_t exit_info2                   PACKED;
214
215   /* This could be a typo in the manual....
216    * It doesn't actually say that there is a reserved bit
217    * But it does say that the EXITINTINFO field is in bits 63-1
218    * ALL other occurances mention a 1 bit reserved field
219    */
220   //  uint_t rsvd5             : 1          PACKED;
221   //ullong_t exit_int_info   : 63         PACKED;
222   /* ** */
223
224   // AMD Manual 2, pg 391, sect: 15.19
225   struct Interrupt_Info exit_int_info  PACKED;
226
227   //  uint_t NP_ENABLE         : 1          PACKED;
228   //ullong_t rsvd6           : 63         PACKED;  // Should be 0 
229   ullong_t NP_ENABLE                    PACKED;
230
231   uchar_t rsvd7[16]                     PACKED;  // Should be 0
232
233   // Offset 0xA8
234   struct Interrupt_Info EVENTINJ                     PACKED;
235
236
237   /* This could be a typo in the manual....
238    * It doesn't actually say that there is a reserved bit
239    * But it does say that the EXITINTINFO field is in bits 63-1
240    * ALL other occurances mention a 1 bit reserved field
241    */
242   //  uint_t rsvd8              : 1         PACKED;
243   //ullong_t N_CR3            : 63        PACKED;
244   ullong_t N_CR3                        PACKED;
245   /* ** */
246
247
248   uint_t LBR_VIRTUALIZATION_ENABLE : 1  PACKED;
249   ullong_t rsvd9            : 63        PACKED;   // Should be 0
250
251 } vmcb_ctrl_t;
252
253
254
255
256
257
258 struct vmcb_selector {
259   ushort_t selector                   PACKED;
260
261   /* These attributes are basically a direct map of the attribute fields of a segment desc.
262    * The segment limit in the middle is removed and the fields are fused together
263    * There IS empty space at the end... See AMD Arch vol3, sect. 4.7.1,  pg 78
264    */
265   union {
266     ushort_t raw                      PACKED;
267     struct {
268       uint_t type              : 4    PACKED; // segment type, [see Intel vol. 3b, sect. 3.4.5.1 (because I have the books)]
269       uint_t S                 : 1    PACKED; // System=0, code/data=1
270       uint_t dpl               : 2    PACKED; // priviledge level, corresonds to protection ring
271       uint_t P                 : 1    PACKED; // present flag
272       uint_t avl               : 1    PACKED; // available for use by system software
273       uint_t L                 : 1    PACKED; // long mode (64 bit?)
274       uint_t db                : 1    PACKED; // default op size (0=16 bit seg, 1=32 bit seg)
275       uint_t G                 : 1    PACKED; // Granularity, (0=bytes, 1=4k)
276       uint_t rsvd              : 4    PACKED;
277     } fields;
278   } attrib;
279   uint_t  limit                       PACKED;
280   ullong_t base                       PACKED;
281 };
282
283
284 typedef struct VMCB_State_Save_Area {
285   struct vmcb_selector es            PACKED; // only lower 32 bits of base are implemented
286   struct vmcb_selector cs            PACKED; // only lower 32 bits of base are implemented
287   struct vmcb_selector ss            PACKED; // only lower 32 bits of base are implemented
288   struct vmcb_selector ds            PACKED; // only lower 32 bits of base are implemented
289   struct vmcb_selector fs            PACKED; 
290   struct vmcb_selector gs            PACKED; 
291
292   struct vmcb_selector gdtr          PACKED; // selector+attrib are reserved, only lower 16 bits of limit are implemented
293   struct vmcb_selector ldtr          PACKED; 
294   struct vmcb_selector idtr          PACKED; // selector+attrib are reserved, only lower 16 bits of limit are implemented
295   struct vmcb_selector tr            PACKED; 
296
297   uchar_t rsvd1[43]                  PACKED;
298
299   //offset 0x0cb
300   uchar_t cpl                        PACKED; // if the guest is real-mode then the CPL is forced to 0
301                                              // if the guest is virtual-mode then the CPL is forced to 3
302
303   uint_t rsvd2                       PACKED;
304
305   // offset 0x0d0
306   ullong_t efer                      PACKED;
307
308   uchar_t rsvd3[112]                 PACKED;
309   
310   //offset 0x148
311   ullong_t cr4                       PACKED;
312   ullong_t cr3                       PACKED;
313   ullong_t cr0                       PACKED;
314   ullong_t dr7                       PACKED;
315   ullong_t dr6                       PACKED;
316   ullong_t rflags                    PACKED;
317   ullong_t rip                       PACKED;
318
319   uchar_t rsvd4[88]                  PACKED;
320   
321   //offset 0x1d8
322   ullong_t rsp                       PACKED;
323
324   uchar_t rsvd5[24]                  PACKED;
325
326   //offset 0x1f8
327   ullong_t rax                       PACKED;
328   ullong_t star                      PACKED;
329   ullong_t lstar                     PACKED;
330   ullong_t cstar                     PACKED;
331   ullong_t sfmask                    PACKED;
332   ullong_t KernelGsBase              PACKED;
333   ullong_t sysenter_cs               PACKED;
334   ullong_t sysenter_esp              PACKED;
335   ullong_t sysenter_eip              PACKED;
336   ullong_t cr2                       PACKED;
337
338
339   uchar_t rsvd6[32]                  PACKED;
340
341   //offset 0x268
342   ullong_t g_pat                     PACKED; // Guest PAT                     
343                                              //   -- only used if nested paging is enabled
344   ullong_t dbgctl                    PACKED; // Guest DBGCTL MSR               
345                                              //   -- only used if the LBR registers are virtualized
346   ullong_t br_from                   PACKED; // Guest LastBranchFromIP MSR
347                                              //   -- only used if the LBR registers are virtualized
348   ullong_t br_to                     PACKED; // Guest LastBranchToIP MSR   
349                                              //   -- only used if the LBR registers are virtualized
350   ullong_t lastexcpfrom              PACKED; // Guest LastExceptionFromIP MSR
351                                              //   -- only used if the LBR registers are virtualized
352   ullong_t lastexcpto                PACKED; // Guest LastExceptionToIP MSR 
353                                              //   -- only used if the LBR registers are virtualized
354
355 } vmcb_saved_state_t;
356
357 void PrintDebugVMCB(vmcb_t * vmcb);
358
359
360 void set_vmcb_segments(vmcb_t * vmcb, struct v3_segments * segs);
361 void get_vmcb_segments(vmcb_t * vmcb, struct v3_segments * segs);
362
363 #endif