VirtualBox

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

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

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