VirtualBox

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

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

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