VirtualBox

source: vbox/trunk/include/VBox/types.h@ 5142

Last change on this file since 5142 was 5026, checked in by vboxsync, 17 years ago

GVM -> GVMM.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 15.3 KB
Line 
1/** @file
2 * VirtualBox - Types.
3 */
4
5/*
6 * Copyright (C) 2006-2007 innotek GmbH
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License as published by the Free Software Foundation,
12 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
13 * distribution. VirtualBox OSE is distributed in the hope that it will
14 * be useful, but WITHOUT ANY WARRANTY of any kind.
15 */
16
17#ifndef ___VBox_types_h
18#define ___VBox_types_h
19
20#include <VBox/cdefs.h>
21#include <iprt/types.h>
22
23
24/** @defgroup grp_types Basic VBox Types
25 * @{
26 */
27
28
29/** @defgroup grp_types_both Common Guest and Host Context Basic Types
30 * @ingroup grp_types
31 * @{
32 */
33
34
35/** @defgroup grp_types_hc Host Context Basic Types
36 * @ingroup grp_types_both
37 * @{
38 */
39
40/** @deprecated
41 * @{ */
42typedef RTHCPHYS VBOXHCPHYS;
43typedef VBOXHCPHYS *PVBOXHCPHYS;
44#define NILVBOXHCPHYS NIL_RTHCPHYS
45typedef RTHCPTR VBOXHCPTR;
46typedef VBOXHCPTR *PVBOXHCPTR;
47/** @} */
48
49/** @} */
50
51
52/** @defgroup grp_types_gc Guest Context Basic Types
53 * @ingroup grp_types_both
54 * @{
55 */
56
57/** @deprecated
58 * @{ */
59typedef RTGCPHYS VBOXGCPHYS;
60typedef VBOXGCPHYS *PVBOXGCPHYS;
61#define NILVBOXGCPHYS NIL_RTGCPHYS
62typedef RTGCPTR VBOXGCPTR;
63typedef VBOXGCPTR *PVBOXGCPTR;
64/** @} */
65
66/** @} */
67
68
69/** Pointer to per support driver session data.
70 * (The data is a R0 entity and private to the the R0 SUP part. All
71 * other should consider this a sort of handle.) */
72typedef R0PTRTYPE(struct SUPDRVSESSION *) PSUPDRVSESSION;
73
74/** Pointer to a VM. */
75typedef struct VM *PVM;
76/** Pointer to a VM - Ring-0 Ptr. */
77typedef R0PTRTYPE(struct VM *) PVMR0;
78/** Pointer to a VM - Ring-3 Ptr. */
79typedef R3PTRTYPE(struct VM *) PVMR3;
80/** Pointer to a VM - GC Ptr. */
81typedef GCPTRTYPE(struct VM *) PVMGC;
82
83/** Pointer to a the ring-0 (global) VM structure. */
84typedef R0PTRTYPE(struct GVM *) PGVM;
85
86
87/** VM State
88 */
89typedef enum VMSTATE
90{
91 /** The VM is being created. */
92 VMSTATE_CREATING = 0,
93 /** The VM is created. */
94 VMSTATE_CREATED,
95 /** The VM is runnning. */
96 VMSTATE_RUNNING,
97 /** The VM state is being loaded from file. */
98 VMSTATE_LOADING,
99 /** The VM is screwed because of a failed state loading. */
100 VMSTATE_LOAD_FAILURE,
101 /** The VM state is being saved to file. */
102 VMSTATE_SAVING,
103 /** The VM is suspended. */
104 VMSTATE_SUSPENDED,
105 /** The VM is being reset. */
106 VMSTATE_RESETTING,
107 /** The VM is in guru meditation over a fatal failure. */
108 VMSTATE_GURU_MEDITATION,
109 /** The VM is switched off, awaiting destruction. */
110 VMSTATE_OFF,
111 /** The VM is being destroyed. */
112 VMSTATE_DESTROYING,
113 /** Terminated. */
114 VMSTATE_TERMINATED,
115 /** hack forcing the size of the enum to 32-bits. */
116 VMSTATE_MAKE_32BIT_HACK = 0x7fffffff
117} VMSTATE;
118
119
120/** Pointer to a PDM Driver Base Interface. */
121typedef struct PDMIBASE *PPDMIBASE;
122/** Pointer to a pointer to a PDM Driver Base Interface. */
123typedef PPDMIBASE *PPPDMIBASE;
124
125/** Pointer to a PDM Device Instance. */
126typedef struct PDMDEVINS *PPDMDEVINS;
127/** Pointer to a pointer to a PDM Device Instance. */
128typedef PPDMDEVINS *PPPDMDEVINS;
129/** R3 pointer to a PDM Device Instance. */
130typedef R3PTRTYPE(PPDMDEVINS) PPDMDEVINSR3;
131/** R0 pointer to a PDM Device Instance. */
132typedef R0PTRTYPE(PPDMDEVINS) PPDMDEVINSR0;
133/** GC pointer to a PDM Device Instance. */
134typedef GCPTRTYPE(PPDMDEVINS) PPDMDEVINSGC;
135
136/** Pointer to a PDM USB Device Instance. */
137typedef struct PDMUSBINS *PPDMUSBINS;
138/** Pointer to a pointer to a PDM USB Device Instance. */
139typedef PPDMUSBINS *PPPDMUSBINS;
140
141/** Pointer to a PDM Driver Instance. */
142typedef struct PDMDRVINS *PPDMDRVINS;
143/** Pointer to a pointer to a PDM Driver Instance. */
144typedef PPDMDRVINS *PPPDMDRVINS;
145
146/** Pointer to a PDM Service Instance. */
147typedef struct PDMSRVINS *PPDMSRVINS;
148/** Pointer to a pointer to a PDM Service Instance. */
149typedef PPDMSRVINS *PPPDMSRVINS;
150
151/** R3 pointer to a timer. */
152typedef R3PTRTYPE(struct TMTIMER *) PTMTIMERR3;
153/** Pointer to a R3 pointer to a timer. */
154typedef PTMTIMERR3 *PPTMTIMERR3;
155
156/** R0 pointer to a timer. */
157typedef R0PTRTYPE(struct TMTIMER *) PTMTIMERR0;
158/** Pointer to a R3 pointer to a timer. */
159typedef PTMTIMERR0 *PPTMTIMERR0;
160
161/** GC pointer to a timer. */
162typedef GCPTRTYPE(struct TMTIMER *) PTMTIMERGC;
163/** Pointer to a GC pointer to a timer. */
164typedef PTMTIMERGC *PPTMTIMERGC;
165
166/** Pointer to a timer. */
167typedef CTXALLSUFF(PTMTIMER) PTMTIMER;
168/** Pointer to a pointer to a timer. */
169typedef CTXALLSUFF(PPTMTIMER) PPTMTIMER;
170
171/** SSM Operation handle. */
172typedef struct SSMHANDLE *PSSMHANDLE;
173
174/** @} */
175
176
177/** @defgroup grp_types_idt Interrupt Descriptor Table Entry.
178 * @ingroup grp_types
179 * @todo This all belongs in x86.h!
180 * @{ */
181
182/** @todo VBOXIDT -> VBOXDESCIDT, skip the complex variations. We'll never use them. */
183
184/** IDT Entry, Task Gate view. */
185#pragma pack(1) /* paranoia */
186typedef struct VBOXIDTE_TASKGATE
187{
188 /** Reserved. */
189 unsigned u16Reserved1 : 16;
190 /** Task Segment Selector. */
191 unsigned u16TSS : 16;
192 /** More reserved. */
193 unsigned u8Reserved2 : 8;
194 /** Fixed value bit 0 - Set to 1. */
195 unsigned u1Fixed0 : 1;
196 /** Busy bit. */
197 unsigned u1Busy : 1;
198 /** Fixed value bit 2 - Set to 1. */
199 unsigned u1Fixed1 : 1;
200 /** Fixed value bit 3 - Set to 0. */
201 unsigned u1Fixed2: 1;
202 /** Fixed value bit 4 - Set to 0. */
203 unsigned u1Fixed3 : 1;
204 /** Descriptor Privilege level. */
205 unsigned u2DPL : 2;
206 /** Present flag. */
207 unsigned u1Present : 1;
208 /** Reserved. */
209 unsigned u16Reserved3 : 16;
210} VBOXIDTE_TASKGATE;
211#pragma pack()
212/** Pointer to IDT Entry, Task gate view. */
213typedef VBOXIDTE_TASKGATE *PVBOXIDTE_TASKGATE;
214
215
216/** IDT Entry, Intertupt gate view. */
217#pragma pack(1) /* paranoia */
218typedef struct VBOXIDTE_INTERRUPTGATE
219{
220 /** Low offset word. */
221 unsigned u16OffsetLow : 16;
222 /** Segment Selector. */
223 unsigned u16SegSel : 16;
224 /** Reserved. */
225 unsigned u5Reserved2 : 5;
226 /** Fixed value bit 0 - Set to 0. */
227 unsigned u1Fixed0 : 1;
228 /** Fixed value bit 1 - Set to 0. */
229 unsigned u1Fixed1 : 1;
230 /** Fixed value bit 2 - Set to 0. */
231 unsigned u1Fixed2 : 1;
232 /** Fixed value bit 3 - Set to 0. */
233 unsigned u1Fixed3: 1;
234 /** Fixed value bit 4 - Set to 1. */
235 unsigned u1Fixed4 : 1;
236 /** Fixed value bit 5 - Set to 1. */
237 unsigned u1Fixed5 : 1;
238 /** Gate size, 1 = 32 bits, 0 = 16 bits. */
239 unsigned u132BitGate : 1;
240 /** Fixed value bit 5 - Set to 0. */
241 unsigned u1Fixed6 : 1;
242 /** Descriptor Privilege level. */
243 unsigned u2DPL : 2;
244 /** Present flag. */
245 unsigned u1Present : 1;
246 /** High offset word. */
247 unsigned u16OffsetHigh : 16;
248} VBOXIDTE_INTERRUPTGATE;
249#pragma pack()
250/** Pointer to IDT Entry, Interrupt gate view. */
251typedef VBOXIDTE_INTERRUPTGATE *PVBOXIDTE_INTERRUPTGATE;
252
253/** IDT Entry, Trap Gate view. */
254#pragma pack(1) /* paranoia */
255typedef struct VBOXIDTE_TRAPGATE
256{
257 /** Low offset word. */
258 unsigned u16OffsetLow : 16;
259 /** Segment Selector. */
260 unsigned u16SegSel : 16;
261 /** Reserved. */
262 unsigned u5Reserved2 : 5;
263 /** Fixed value bit 0 - Set to 0. */
264 unsigned u1Fixed0 : 1;
265 /** Fixed value bit 1 - Set to 0. */
266 unsigned u1Fixed1 : 1;
267 /** Fixed value bit 2 - Set to 0. */
268 unsigned u1Fixed2 : 1;
269 /** Fixed value bit 3 - Set to 1. */
270 unsigned u1Fixed3: 1;
271 /** Fixed value bit 4 - Set to 1. */
272 unsigned u1Fixed4 : 1;
273 /** Fixed value bit 5 - Set to 1. */
274 unsigned u1Fixed5 : 1;
275 /** Gate size, 1 = 32 bits, 0 = 16 bits. */
276 unsigned u132BitGate : 1;
277 /** Fixed value bit 5 - Set to 0. */
278 unsigned u1Fixed6 : 1;
279 /** Descriptor Privilege level. */
280 unsigned u2DPL : 2;
281 /** Present flag. */
282 unsigned u1Present : 1;
283 /** High offset word. */
284 unsigned u16OffsetHigh : 16;
285} VBOXIDTE_TRAPGATE;
286#pragma pack()
287/** Pointer to IDT Entry, Trap Gate view. */
288typedef VBOXIDTE_TRAPGATE *PVBOXIDTE_TRAPGATE;
289
290/** IDT Entry Generic view. */
291#pragma pack(1) /* paranoia */
292typedef struct VBOXIDTE_GENERIC
293{
294 /** Low offset word. */
295 unsigned u16OffsetLow : 16;
296 /** Segment Selector. */
297 unsigned u16SegSel : 16;
298 /** Reserved. */
299 unsigned u5Reserved : 5;
300 /** IDT Type part one (not used for task gate). */
301 unsigned u3Type1 : 3;
302 /** IDT Type part two. */
303 unsigned u5Type2 : 5;
304 /** Descriptor Privilege level. */
305 unsigned u2DPL : 2;
306 /** Present flag. */
307 unsigned u1Present : 1;
308 /** High offset word. */
309 unsigned u16OffsetHigh : 16;
310} VBOXIDTE_GENERIC;
311#pragma pack()
312/** Pointer to IDT Entry Generic view. */
313typedef VBOXIDTE_GENERIC *PVBOXIDTE_GENERIC;
314
315/** IDT Type1 value. (Reserved for task gate!) */
316#define VBOX_IDTE_TYPE1 0
317/** IDT Type2 value - Task gate. */
318#define VBOX_IDTE_TYPE2_TASK 0x5
319/** IDT Type2 value - 16 bit interrupt gate. */
320#define VBOX_IDTE_TYPE2_INT_16 0x6
321/** IDT Type2 value - 32 bit interrupt gate. */
322#define VBOX_IDTE_TYPE2_INT_32 0xe
323/** IDT Type2 value - 16 bit trap gate. */
324#define VBOX_IDTE_TYPE2_TRAP_16 0x7
325/** IDT Type2 value - 32 bit trap gate. */
326#define VBOX_IDTE_TYPE2_TRAP_32 0xf
327
328/** IDT Entry. */
329#pragma pack(1) /* paranoia */
330typedef union VBOXIDTE
331{
332 /** Task gate view. */
333 VBOXIDTE_TASKGATE Task;
334 /** Trap gate view. */
335 VBOXIDTE_TRAPGATE Trap;
336 /** Interrupt gate view. */
337 VBOXIDTE_INTERRUPTGATE Int;
338 /** Generic IDT view. */
339 VBOXIDTE_GENERIC Gen;
340
341 /** 8 bit unsigned integer view. */
342 uint8_t au8[8];
343 /** 16 bit unsigned integer view. */
344 uint16_t au16[4];
345 /** 32 bit unsigned integer view. */
346 uint32_t au32[2];
347 /** 64 bit unsigned integer view. */
348 uint64_t au64;
349} VBOXIDTE;
350#pragma pack()
351/** Pointer to IDT Entry. */
352typedef VBOXIDTE *PVBOXIDTE;
353
354#pragma pack(1)
355/** IDTR */
356typedef struct VBOXIDTR
357{
358 /** Size of the IDT. */
359 uint16_t cbIdt;
360 /** Address of the IDT. */
361 uint32_t pIdt;
362} VBOXIDTR, *PVBOXIDTR;
363#pragma pack()
364/** @} */
365
366
367/** @defgroup grp_types_desc Descriptor Table Entry.
368 * @ingroup grp_types
369 * @{ */
370
371#pragma pack(1)
372/**
373 * Memory descriptor.
374 */
375typedef struct VBOXDESCGENERIC
376{
377 /** 0-15 - Limit - Low word. */
378 unsigned u16LimitLow : 16;
379 /** 16-31 - Base address - lowe word.
380 * Don't try set this to 24 because MSC is doing studing things then. */
381 unsigned u16BaseLow : 16;
382 /** 32-39 - Base address - first 8 bits of high word. */
383 unsigned u8BaseHigh1 : 8;
384 /** 40-43 - Segment Type. */
385 unsigned u4Type : 4;
386 /** 44 - Descriptor Type. System(=0) or code/data selector */
387 unsigned u1DescType : 1;
388 /** 45-46 - Descriptor Privelege level. */
389 unsigned u2Dpl : 2;
390 /** 47 - Flags selector present(=1) or not. */
391 unsigned u1Present : 1;
392 /** 48-51 - Segment limit 16-19. */
393 unsigned u4LimitHigh : 4;
394 /** 52 - Available for system software. */
395 unsigned u1Available : 1;
396 /** 53 - Reserved - 0. In long mode this is the 'Long' (L) attribute bit. */
397 unsigned u1Reserved : 1;
398 /** 54 - This flags meaning depends on the segment type. Try make sense out
399 * of the intel manual yourself. */
400 unsigned u1DefBig : 1;
401 /** 55 - Granularity of the limit. If set 4KB granularity is used, if
402 * clear byte. */
403 unsigned u1Granularity : 1;
404 /** 56-63 - Base address - highest 8 bits. */
405 unsigned u8BaseHigh2 : 8;
406} VBOXDESCGENERIC;
407#pragma pack()
408/** Pointer to a generic descriptor entry. */
409typedef VBOXDESCGENERIC *PVBOXDESCGENERIC;
410
411#pragma pack(1)
412/**
413 * Descriptor table entry.
414 */
415typedef union VBOXDESC
416{
417 /** Generic descriptor view. */
418 VBOXDESCGENERIC Gen;
419 /** IDT view. */
420 VBOXIDTE Idt;
421
422 /** 8 bit unsigned interger view. */
423 uint8_t au8[8];
424 /** 16 bit unsigned interger view. */
425 uint16_t au16[4];
426 /** 32 bit unsigned interger view. */
427 uint32_t au32[2];
428} VBOXDESC;
429#pragma pack()
430/** Pointer to descriptor table entry. */
431typedef VBOXDESC *PVBOXDESC;
432/** Pointer to const descriptor table entry. */
433typedef VBOXDESC const *PCVBOXDESC;
434
435
436#pragma pack(1)
437/** GDTR */
438typedef struct VBOXGDTR
439{
440 /** Size of the GDT. */
441 uint16_t cbGdt;
442 /** Address of the GDT. */
443 uint32_t pGdt;
444} VBOXGDTR;
445#pragma pack()
446/** Pointer to GDTR. */
447typedef VBOXGDTR *PVBOXGDTR;
448
449/** @} */
450
451
452/** @defgroup grp_types_pg Page Structures
453 * @ingroup grp_types
454 * @{
455 */
456
457/** These absolete / belong to PGM. Use VBox/x86.h structs everywhere else. */
458#define VBOXPTE X86PTE
459#define PVBOXPTE PX86PTE
460#define VBOXPT X86PT
461#define PVBOXPT PX86PT
462#define VBOXPDE X86PDE
463#define PVBOXPDE PX86PDE
464#define VBOXPD X86PD
465#define PVBOXPD PX86PD
466
467/** @} */
468
469
470
471/**
472 * Task Segment
473 */
474#pragma pack(1)
475typedef struct VBOXTSS
476{
477 /** Back link to previous task. (static) */
478 RTSEL selPrev;
479 uint16_t padding1;
480 /** Ring-0 stack pointer. (static) */
481 uint32_t esp0;
482 /** Ring-0 stack segment. (static) */
483 RTSEL ss0;
484 uint16_t padding_ss0;
485 /** Ring-1 stack pointer. (static) */
486 uint32_t esp1;
487 /** Ring-1 stack segment. (static) */
488 RTSEL ss1;
489 uint16_t padding_ss1;
490 /** Ring-2 stack pointer. (static) */
491 uint32_t esp2;
492 /** Ring-2 stack segment. (static) */
493 RTSEL ss2;
494 uint16_t padding_ss2;
495 /** Page directory for the task. (static) */
496 uint32_t cr3;
497 /** EIP before task switch. */
498 uint32_t eip;
499 /** EFLAGS before task switch. */
500 uint32_t eflags;
501 /** EAX before task switch. */
502 uint32_t eax;
503 /** ECX before task switch. */
504 uint32_t ecx;
505 /** EDX before task switch. */
506 uint32_t edx;
507 /** EBX before task switch. */
508 uint32_t ebx;
509 /** ESP before task switch. */
510 uint32_t esp;
511 /** EBP before task switch. */
512 uint32_t ebp;
513 /** ESI before task switch. */
514 uint32_t esi;
515 /** EDI before task switch. */
516 uint32_t edi;
517 /** ES before task switch. */
518 RTSEL es;
519 uint16_t padding_es;
520 /** CS before task switch. */
521 RTSEL cs;
522 uint16_t padding_cs;
523 /** SS before task switch. */
524 RTSEL ss;
525 uint16_t padding_ss;
526 /** DS before task switch. */
527 RTSEL ds;
528 uint16_t padding_ds;
529 /** FS before task switch. */
530 RTSEL fs;
531 uint16_t padding_fs;
532 /** GS before task switch. */
533 RTSEL gs;
534 uint16_t padding_gs;
535 /** LDTR before task switch. */
536 RTSEL selLdt;
537 uint16_t padding_ldt;
538 /** Debug trap flag */
539 uint16_t fDebugTrap;
540 /** Offset relative to the TSS of the start of the I/O Bitmap
541 * and the end of the interrupt redirection bitmap. */
542 uint16_t offIoBitmap;
543 /** 32 bytes for the virtual interrupt redirection bitmap. (VME) */
544 uint8_t IntRedirBitmap[32];
545} VBOXTSS;
546#pragma pack()
547/** Pointer to task segment. */
548typedef VBOXTSS *PVBOXTSS;
549/** Pointer to const task segment. */
550typedef const VBOXTSS *PCVBOXTSS;
551
552
553/** @} */
554
555#endif
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette