]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - ubuntu/vbox/include/VBox/types.h
UBUNTU: SAUCE: update vbox
[mirror_ubuntu-artful-kernel.git] / ubuntu / vbox / include / VBox / types.h
1 /** @file
2 * VirtualBox - Types.
3 */
4
5 /*
6 * Copyright (C) 2006-2016 Oracle Corporation
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 (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26 #ifndef ___VBox_types_h
27 #define ___VBox_types_h
28
29 #include <VBox/cdefs.h>
30 #include <iprt/types.h>
31
32
33 /** @defgroup grp_types VBox Basic Types
34 * @{
35 */
36
37
38 /** @defgroup grp_types_both Common Guest and Host Context Basic Types
39 * @{
40 */
41
42
43 /** @defgroup grp_types_hc Host Context Basic Types
44 * @{
45 */
46
47 /** @} */
48
49
50 /** @defgroup grp_types_gc Guest Context Basic Types
51 * @{
52 */
53
54 /** @} */
55
56
57 /** Pointer to per support driver session data.
58 * (The data is a R0 entity and private to the the R0 SUP part. All
59 * other should consider this a sort of handle.) */
60 typedef R0PTRTYPE(struct SUPDRVSESSION *) PSUPDRVSESSION;
61
62 /** Event semaphore handle. Ring-0 / ring-3. */
63 typedef R0PTRTYPE(struct SUPSEMEVENTHANDLE *) SUPSEMEVENT;
64 /** Pointer to an event semaphore handle. */
65 typedef SUPSEMEVENT *PSUPSEMEVENT;
66 /** Nil event semaphore handle. */
67 #define NIL_SUPSEMEVENT ((SUPSEMEVENT)0)
68
69 /** Multiple release event semaphore handle. Ring-0 / ring-3. */
70 typedef R0PTRTYPE(struct SUPSEMEVENTMULTIHANDLE *) SUPSEMEVENTMULTI;
71 /** Pointer to an multiple release event semaphore handle. */
72 typedef SUPSEMEVENTMULTI *PSUPSEMEVENTMULTI;
73 /** Nil multiple release event semaphore handle. */
74 #define NIL_SUPSEMEVENTMULTI ((SUPSEMEVENTMULTI)0)
75
76
77 /** Pointer to a VM. */
78 typedef struct VM *PVM;
79 /** Pointer to a VM - Ring-0 Ptr. */
80 typedef R0PTRTYPE(struct VM *) PVMR0;
81 /** Pointer to a VM - Ring-3 Ptr. */
82 typedef R3PTRTYPE(struct VM *) PVMR3;
83 /** Pointer to a VM - RC Ptr. */
84 typedef RCPTRTYPE(struct VM *) PVMRC;
85
86 /** Pointer to a virtual CPU structure. */
87 typedef struct VMCPU * PVMCPU;
88 /** Pointer to a const virtual CPU structure. */
89 typedef const struct VMCPU * PCVMCPU;
90 /** Pointer to a virtual CPU structure - Ring-3 Ptr. */
91 typedef R3PTRTYPE(struct VMCPU *) PVMCPUR3;
92 /** Pointer to a virtual CPU structure - Ring-0 Ptr. */
93 typedef R0PTRTYPE(struct VMCPU *) PVMCPUR0;
94 /** Pointer to a virtual CPU structure - RC Ptr. */
95 typedef RCPTRTYPE(struct VMCPU *) PVMCPURC;
96
97 /** Pointer to a ring-0 (global) VM structure. */
98 typedef R0PTRTYPE(struct GVM *) PGVM;
99
100 /** Pointer to a ring-3 (user mode) VM structure. */
101 typedef R3PTRTYPE(struct UVM *) PUVM;
102
103 /** Pointer to a ring-3 (user mode) VMCPU structure. */
104 typedef R3PTRTYPE(struct UVMCPU *) PUVMCPU;
105
106 /** Virtual CPU ID. */
107 typedef uint32_t VMCPUID;
108 /** Pointer to a virtual CPU ID. */
109 typedef VMCPUID *PVMCPUID;
110 /** @name Special CPU ID values.
111 * Most of these are for request scheduling.
112 *
113 * @{ */
114 /** All virtual CPUs. */
115 #define VMCPUID_ALL UINT32_C(0xfffffff2)
116 /** All virtual CPUs, descending order. */
117 #define VMCPUID_ALL_REVERSE UINT32_C(0xfffffff3)
118 /** Any virtual CPU.
119 * Intended for scheduling a VM request or some other task. */
120 #define VMCPUID_ANY UINT32_C(0xfffffff4)
121 /** Any virtual CPU; always queue for future execution.
122 * Intended for scheduling a VM request or some other task. */
123 #define VMCPUID_ANY_QUEUE UINT32_C(0xfffffff5)
124 /** The NIL value. */
125 #define NIL_VMCPUID UINT32_C(0xfffffffd)
126 /** @} */
127
128 /**
129 * Virtual CPU set.
130 */
131 typedef struct VMCPUSET
132 {
133 /** The bitmap data. */
134 uint32_t au32Bitmap[8 /*256/32*/];
135 } VMCPUSET;
136 /** Pointer to a Virtual CPU set. */
137 typedef VMCPUSET *PVMCPUSET;
138 /** Pointer to a const Virtual CPU set. */
139 typedef VMCPUSET const *PCVMCPUSET;
140
141
142 /**
143 * VM State
144 */
145 typedef enum VMSTATE
146 {
147 /** The VM is being created. */
148 VMSTATE_CREATING = 0,
149 /** The VM is created. */
150 VMSTATE_CREATED,
151 /** The VM state is being loaded from file. */
152 VMSTATE_LOADING,
153 /** The VM is being powered on */
154 VMSTATE_POWERING_ON,
155 /** The VM is being resumed. */
156 VMSTATE_RESUMING,
157 /** The VM is runnning. */
158 VMSTATE_RUNNING,
159 /** Live save: The VM is running and the state is being saved. */
160 VMSTATE_RUNNING_LS,
161 /** Fault Tolerance: The VM is running and the state is being synced. */
162 VMSTATE_RUNNING_FT,
163 /** The VM is being reset. */
164 VMSTATE_RESETTING,
165 /** Live save: The VM is being reset and immediately suspended. */
166 VMSTATE_RESETTING_LS,
167 /** The VM is being soft/warm reset. */
168 VMSTATE_SOFT_RESETTING,
169 /** Live save: The VM is being soft/warm reset (not suspended afterwards). */
170 VMSTATE_SOFT_RESETTING_LS,
171 /** The VM is being suspended. */
172 VMSTATE_SUSPENDING,
173 /** Live save: The VM is being suspended during a live save operation, either as
174 * part of the normal flow or VMR3Reset. */
175 VMSTATE_SUSPENDING_LS,
176 /** Live save: The VM is being suspended by VMR3Suspend during live save. */
177 VMSTATE_SUSPENDING_EXT_LS,
178 /** The VM is suspended. */
179 VMSTATE_SUSPENDED,
180 /** Live save: The VM has been suspended and is waiting for the live save
181 * operation to move on. */
182 VMSTATE_SUSPENDED_LS,
183 /** Live save: The VM has been suspended by VMR3Suspend during a live save. */
184 VMSTATE_SUSPENDED_EXT_LS,
185 /** The VM is suspended and its state is being saved by EMT(0). (See SSM) */
186 VMSTATE_SAVING,
187 /** The VM is being debugged. (See DBGF.) */
188 VMSTATE_DEBUGGING,
189 /** Live save: The VM is being debugged while the live phase is going on. */
190 VMSTATE_DEBUGGING_LS,
191 /** The VM is being powered off. */
192 VMSTATE_POWERING_OFF,
193 /** Live save: The VM is being powered off and the save cancelled. */
194 VMSTATE_POWERING_OFF_LS,
195 /** The VM is switched off, awaiting destruction. */
196 VMSTATE_OFF,
197 /** Live save: Waiting for cancellation and transition to VMSTATE_OFF. */
198 VMSTATE_OFF_LS,
199 /** The VM is powered off because of a fatal error. */
200 VMSTATE_FATAL_ERROR,
201 /** Live save: Waiting for cancellation and transition to FatalError. */
202 VMSTATE_FATAL_ERROR_LS,
203 /** The VM is in guru meditation over a fatal failure. */
204 VMSTATE_GURU_MEDITATION,
205 /** Live save: Waiting for cancellation and transition to GuruMeditation. */
206 VMSTATE_GURU_MEDITATION_LS,
207 /** The VM is screwed because of a failed state loading. */
208 VMSTATE_LOAD_FAILURE,
209 /** The VM is being destroyed. */
210 VMSTATE_DESTROYING,
211 /** Terminated. */
212 VMSTATE_TERMINATED,
213 /** hack forcing the size of the enum to 32-bits. */
214 VMSTATE_MAKE_32BIT_HACK = 0x7fffffff
215 } VMSTATE;
216
217 /** @def VBOXSTRICTRC_STRICT_ENABLED
218 * Indicates that VBOXSTRICTRC is in strict mode.
219 */
220 #if defined(__cplusplus) \
221 && ARCH_BITS == 64 /* cdecl requires classes and structs as hidden params. */ \
222 && !defined(_MSC_VER) /* trouble similar to 32-bit gcc. */ \
223 && ( defined(RT_STRICT) \
224 || defined(VBOX_STRICT) \
225 || defined(DEBUG) \
226 || defined(DOXYGEN_RUNNING) )
227 # define VBOXSTRICTRC_STRICT_ENABLED 1
228 #endif
229
230 /** We need RTERR_STRICT_RC. */
231 #if defined(VBOXSTRICTRC_STRICT_ENABLED) && !defined(RTERR_STRICT_RC)
232 # define RTERR_STRICT_RC 1
233 #endif
234
235 /**
236 * Strict VirtualBox status code.
237 *
238 * This is normally an 32-bit integer and the only purpose of the type is to
239 * highlight the special handling that is required. But in strict build it is a
240 * class that causes compilation and runtime errors for some of the incorrect
241 * handling.
242 */
243 #ifdef VBOXSTRICTRC_STRICT_ENABLED
244 struct VBOXSTRICTRC
245 {
246 protected:
247 /** The status code. */
248 int32_t m_rc;
249
250 public:
251 /** Default constructor setting the status to VERR_IPE_UNINITIALIZED_STATUS. */
252 VBOXSTRICTRC()
253 #ifdef VERR_IPE_UNINITIALIZED_STATUS
254 : m_rc(VERR_IPE_UNINITIALIZED_STATUS)
255 #else
256 : m_rc(-233 /*VERR_IPE_UNINITIALIZED_STATUS*/)
257 #endif
258 {
259 }
260
261 /** Constructor for normal integer status codes. */
262 VBOXSTRICTRC(int32_t const rc)
263 : m_rc(rc)
264 {
265 }
266
267 /** Getter that VBOXSTRICTRC_VAL can use. */
268 int32_t getValue() const { return m_rc; }
269
270 /** @name Comparison operators
271 * @{ */
272 bool operator==(int32_t rc) const { return m_rc == rc; }
273 bool operator!=(int32_t rc) const { return m_rc != rc; }
274 bool operator<=(int32_t rc) const { return m_rc <= rc; }
275 bool operator>=(int32_t rc) const { return m_rc >= rc; }
276 bool operator<(int32_t rc) const { return m_rc < rc; }
277 bool operator>(int32_t rc) const { return m_rc > rc; }
278
279 bool operator==(const VBOXSTRICTRC &rRc) const { return m_rc == rRc.m_rc; }
280 bool operator!=(const VBOXSTRICTRC &rRc) const { return m_rc != rRc.m_rc; }
281 bool operator<=(const VBOXSTRICTRC &rRc) const { return m_rc <= rRc.m_rc; }
282 bool operator>=(const VBOXSTRICTRC &rRc) const { return m_rc >= rRc.m_rc; }
283 bool operator<(const VBOXSTRICTRC &rRc) const { return m_rc < rRc.m_rc; }
284 bool operator>(const VBOXSTRICTRC &rRc) const { return m_rc > rRc.m_rc; }
285 /** @} */
286
287 /** Special automatic cast for RT_SUCCESS_NP. */
288 operator RTErrStrictType2() const { return RTErrStrictType2(m_rc); }
289
290 private:
291 /** @name Constructors that will prevent some of the bad types.
292 * @{ */
293 VBOXSTRICTRC(uint8_t rc) : m_rc(-999) { NOREF(rc); }
294 VBOXSTRICTRC(uint16_t rc) : m_rc(-999) { NOREF(rc); }
295 VBOXSTRICTRC(uint32_t rc) : m_rc(-999) { NOREF(rc); }
296 VBOXSTRICTRC(uint64_t rc) : m_rc(-999) { NOREF(rc); }
297
298 VBOXSTRICTRC(int8_t rc) : m_rc(-999) { NOREF(rc); }
299 VBOXSTRICTRC(int16_t rc) : m_rc(-999) { NOREF(rc); }
300 VBOXSTRICTRC(int64_t rc) : m_rc(-999) { NOREF(rc); }
301 /** @} */
302 };
303 # ifdef _MSC_VER
304 # pragma warning(disable:4190)
305 # endif
306 #else
307 typedef int32_t VBOXSTRICTRC;
308 #endif
309
310 /** @def VBOXSTRICTRC_VAL
311 * Explicit getter.
312 * @param rcStrict The strict VirtualBox status code.
313 */
314 #ifdef VBOXSTRICTRC_STRICT_ENABLED
315 # define VBOXSTRICTRC_VAL(rcStrict) ( (rcStrict).getValue() )
316 #else
317 # define VBOXSTRICTRC_VAL(rcStrict) (rcStrict)
318 #endif
319
320 /** @def VBOXSTRICTRC_TODO
321 * Returns that needs dealing with.
322 * @param rcStrict The strict VirtualBox status code.
323 */
324 #define VBOXSTRICTRC_TODO(rcStrict) VBOXSTRICTRC_VAL(rcStrict)
325
326
327 /** Pointer to a PDM Base Interface. */
328 typedef struct PDMIBASE *PPDMIBASE;
329 /** Pointer to a pointer to a PDM Base Interface. */
330 typedef PPDMIBASE *PPPDMIBASE;
331
332 /** Pointer to a PDM Device Instance. */
333 typedef struct PDMDEVINS *PPDMDEVINS;
334 /** Pointer to a pointer to a PDM Device Instance. */
335 typedef PPDMDEVINS *PPPDMDEVINS;
336 /** R3 pointer to a PDM Device Instance. */
337 typedef R3PTRTYPE(PPDMDEVINS) PPDMDEVINSR3;
338 /** R0 pointer to a PDM Device Instance. */
339 typedef R0PTRTYPE(PPDMDEVINS) PPDMDEVINSR0;
340 /** RC pointer to a PDM Device Instance. */
341 typedef RCPTRTYPE(PPDMDEVINS) PPDMDEVINSRC;
342
343 /** Pointer to a PDM PCI device structure. */
344 typedef struct PDMPCIDEV *PPDMPCIDEV;
345
346 /** Pointer to a PDM USB Device Instance. */
347 typedef struct PDMUSBINS *PPDMUSBINS;
348 /** Pointer to a pointer to a PDM USB Device Instance. */
349 typedef PPDMUSBINS *PPPDMUSBINS;
350
351 /** Pointer to a PDM Driver Instance. */
352 typedef struct PDMDRVINS *PPDMDRVINS;
353 /** Pointer to a pointer to a PDM Driver Instance. */
354 typedef PPDMDRVINS *PPPDMDRVINS;
355 /** R3 pointer to a PDM Driver Instance. */
356 typedef R3PTRTYPE(PPDMDRVINS) PPDMDRVINSR3;
357 /** R0 pointer to a PDM Driver Instance. */
358 typedef R0PTRTYPE(PPDMDRVINS) PPDMDRVINSR0;
359 /** RC pointer to a PDM Driver Instance. */
360 typedef RCPTRTYPE(PPDMDRVINS) PPDMDRVINSRC;
361
362 /** Pointer to a PDM Service Instance. */
363 typedef struct PDMSRVINS *PPDMSRVINS;
364 /** Pointer to a pointer to a PDM Service Instance. */
365 typedef PPDMSRVINS *PPPDMSRVINS;
366
367 /** Pointer to a PDM critical section. */
368 typedef union PDMCRITSECT *PPDMCRITSECT;
369 /** Pointer to a const PDM critical section. */
370 typedef const union PDMCRITSECT *PCPDMCRITSECT;
371
372 /** Pointer to a PDM read/write critical section. */
373 typedef union PDMCRITSECTRW *PPDMCRITSECTRW;
374 /** Pointer to a const PDM read/write critical section. */
375 typedef union PDMCRITSECTRW const *PCPDMCRITSECTRW;
376
377 /** R3 pointer to a timer. */
378 typedef R3PTRTYPE(struct TMTIMER *) PTMTIMERR3;
379 /** Pointer to a R3 pointer to a timer. */
380 typedef PTMTIMERR3 *PPTMTIMERR3;
381
382 /** R0 pointer to a timer. */
383 typedef R0PTRTYPE(struct TMTIMER *) PTMTIMERR0;
384 /** Pointer to a R3 pointer to a timer. */
385 typedef PTMTIMERR0 *PPTMTIMERR0;
386
387 /** RC pointer to a timer. */
388 typedef RCPTRTYPE(struct TMTIMER *) PTMTIMERRC;
389 /** Pointer to a RC pointer to a timer. */
390 typedef PTMTIMERRC *PPTMTIMERRC;
391
392 /** Pointer to a timer. */
393 typedef CTX_SUFF(PTMTIMER) PTMTIMER;
394 /** Pointer to a pointer to a timer. */
395 typedef PTMTIMER *PPTMTIMER;
396
397 /** SSM Operation handle. */
398 typedef struct SSMHANDLE *PSSMHANDLE;
399 /** Pointer to a const SSM stream method table. */
400 typedef struct SSMSTRMOPS const *PCSSMSTRMOPS;
401
402 /** Pointer to a CPUMCTX. */
403 typedef struct CPUMCTX *PCPUMCTX;
404 /** Pointer to a const CPUMCTX. */
405 typedef const struct CPUMCTX *PCCPUMCTX;
406
407 /** Pointer to a CPU context core. */
408 typedef struct CPUMCTXCORE *PCPUMCTXCORE;
409 /** Pointer to a const CPU context core. */
410 typedef const struct CPUMCTXCORE *PCCPUMCTXCORE;
411
412 /** Pointer to a selector register. */
413 typedef struct CPUMSELREG *PCPUMSELREG;
414 /** Pointer to a const selector register. */
415 typedef const struct CPUMSELREG *PCCPUMSELREG;
416
417 /** Pointer to selector hidden registers.
418 * @deprecated Replaced by PCPUMSELREG */
419 typedef struct CPUMSELREG *PCPUMSELREGHID;
420 /** Pointer to const selector hidden registers.
421 * @deprecated Replaced by PCCPUMSELREG */
422 typedef const struct CPUMSELREG *PCCPUMSELREGHID;
423
424 /** @} */
425
426
427 /** @defgroup grp_types_idt Interrupt Descriptor Table Entry.
428 * @todo This all belongs in x86.h!
429 * @{ */
430
431 /** @todo VBOXIDT -> VBOXDESCIDT, skip the complex variations. We'll never use them. */
432
433 /** IDT Entry, Task Gate view. */
434 #pragma pack(1) /* paranoia */
435 typedef struct VBOXIDTE_TASKGATE
436 {
437 /** Reserved. */
438 unsigned u16Reserved1 : 16;
439 /** Task Segment Selector. */
440 unsigned u16TSS : 16;
441 /** More reserved. */
442 unsigned u8Reserved2 : 8;
443 /** Fixed value bit 0 - Set to 1. */
444 unsigned u1Fixed0 : 1;
445 /** Busy bit. */
446 unsigned u1Busy : 1;
447 /** Fixed value bit 2 - Set to 1. */
448 unsigned u1Fixed1 : 1;
449 /** Fixed value bit 3 - Set to 0. */
450 unsigned u1Fixed2 : 1;
451 /** Fixed value bit 4 - Set to 0. */
452 unsigned u1Fixed3 : 1;
453 /** Descriptor Privilege level. */
454 unsigned u2DPL : 2;
455 /** Present flag. */
456 unsigned u1Present : 1;
457 /** Reserved. */
458 unsigned u16Reserved3 : 16;
459 } VBOXIDTE_TASKGATE;
460 #pragma pack()
461 /** Pointer to IDT Entry, Task gate view. */
462 typedef VBOXIDTE_TASKGATE *PVBOXIDTE_TASKGATE;
463
464
465 /** IDT Entry, Intertupt gate view. */
466 #pragma pack(1) /* paranoia */
467 typedef struct VBOXIDTE_INTERRUPTGATE
468 {
469 /** Low offset word. */
470 unsigned u16OffsetLow : 16;
471 /** Segment Selector. */
472 unsigned u16SegSel : 16;
473 /** Reserved. */
474 unsigned u5Reserved2 : 5;
475 /** Fixed value bit 0 - Set to 0. */
476 unsigned u1Fixed0 : 1;
477 /** Fixed value bit 1 - Set to 0. */
478 unsigned u1Fixed1 : 1;
479 /** Fixed value bit 2 - Set to 0. */
480 unsigned u1Fixed2 : 1;
481 /** Fixed value bit 3 - Set to 0. */
482 unsigned u1Fixed3 : 1;
483 /** Fixed value bit 4 - Set to 1. */
484 unsigned u1Fixed4 : 1;
485 /** Fixed value bit 5 - Set to 1. */
486 unsigned u1Fixed5 : 1;
487 /** Gate size, 1 = 32 bits, 0 = 16 bits. */
488 unsigned u132BitGate : 1;
489 /** Fixed value bit 5 - Set to 0. */
490 unsigned u1Fixed6 : 1;
491 /** Descriptor Privilege level. */
492 unsigned u2DPL : 2;
493 /** Present flag. */
494 unsigned u1Present : 1;
495 /** High offset word. */
496 unsigned u16OffsetHigh : 16;
497 } VBOXIDTE_INTERRUPTGATE;
498 #pragma pack()
499 /** Pointer to IDT Entry, Interrupt gate view. */
500 typedef VBOXIDTE_INTERRUPTGATE *PVBOXIDTE_INTERRUPTGATE;
501
502 /** IDT Entry, Trap Gate view. */
503 #pragma pack(1) /* paranoia */
504 typedef struct VBOXIDTE_TRAPGATE
505 {
506 /** Low offset word. */
507 unsigned u16OffsetLow : 16;
508 /** Segment Selector. */
509 unsigned u16SegSel : 16;
510 /** Reserved. */
511 unsigned u5Reserved2 : 5;
512 /** Fixed value bit 0 - Set to 0. */
513 unsigned u1Fixed0 : 1;
514 /** Fixed value bit 1 - Set to 0. */
515 unsigned u1Fixed1 : 1;
516 /** Fixed value bit 2 - Set to 0. */
517 unsigned u1Fixed2 : 1;
518 /** Fixed value bit 3 - Set to 1. */
519 unsigned u1Fixed3 : 1;
520 /** Fixed value bit 4 - Set to 1. */
521 unsigned u1Fixed4 : 1;
522 /** Fixed value bit 5 - Set to 1. */
523 unsigned u1Fixed5 : 1;
524 /** Gate size, 1 = 32 bits, 0 = 16 bits. */
525 unsigned u132BitGate : 1;
526 /** Fixed value bit 5 - Set to 0. */
527 unsigned u1Fixed6 : 1;
528 /** Descriptor Privilege level. */
529 unsigned u2DPL : 2;
530 /** Present flag. */
531 unsigned u1Present : 1;
532 /** High offset word. */
533 unsigned u16OffsetHigh : 16;
534 } VBOXIDTE_TRAPGATE;
535 #pragma pack()
536 /** Pointer to IDT Entry, Trap Gate view. */
537 typedef VBOXIDTE_TRAPGATE *PVBOXIDTE_TRAPGATE;
538
539 /** IDT Entry Generic view. */
540 #pragma pack(1) /* paranoia */
541 typedef struct VBOXIDTE_GENERIC
542 {
543 /** Low offset word. */
544 unsigned u16OffsetLow : 16;
545 /** Segment Selector. */
546 unsigned u16SegSel : 16;
547 /** Reserved. */
548 unsigned u5Reserved : 5;
549 /** IDT Type part one (not used for task gate). */
550 unsigned u3Type1 : 3;
551 /** IDT Type part two. */
552 unsigned u5Type2 : 5;
553 /** Descriptor Privilege level. */
554 unsigned u2DPL : 2;
555 /** Present flag. */
556 unsigned u1Present : 1;
557 /** High offset word. */
558 unsigned u16OffsetHigh : 16;
559 } VBOXIDTE_GENERIC;
560 #pragma pack()
561 /** Pointer to IDT Entry Generic view. */
562 typedef VBOXIDTE_GENERIC *PVBOXIDTE_GENERIC;
563
564 /** IDT Type1 value. (Reserved for task gate!) */
565 #define VBOX_IDTE_TYPE1 0
566 /** IDT Type2 value - Task gate. */
567 #define VBOX_IDTE_TYPE2_TASK 0x5
568 /** IDT Type2 value - 16 bit interrupt gate. */
569 #define VBOX_IDTE_TYPE2_INT_16 0x6
570 /** IDT Type2 value - 32 bit interrupt gate. */
571 #define VBOX_IDTE_TYPE2_INT_32 0xe
572 /** IDT Type2 value - 16 bit trap gate. */
573 #define VBOX_IDTE_TYPE2_TRAP_16 0x7
574 /** IDT Type2 value - 32 bit trap gate. */
575 #define VBOX_IDTE_TYPE2_TRAP_32 0xf
576
577 /** IDT Entry. */
578 #pragma pack(1) /* paranoia */
579 typedef union VBOXIDTE
580 {
581 /** Task gate view. */
582 VBOXIDTE_TASKGATE Task;
583 /** Trap gate view. */
584 VBOXIDTE_TRAPGATE Trap;
585 /** Interrupt gate view. */
586 VBOXIDTE_INTERRUPTGATE Int;
587 /** Generic IDT view. */
588 VBOXIDTE_GENERIC Gen;
589
590 /** 8 bit unsigned integer view. */
591 uint8_t au8[8];
592 /** 16 bit unsigned integer view. */
593 uint16_t au16[4];
594 /** 32 bit unsigned integer view. */
595 uint32_t au32[2];
596 /** 64 bit unsigned integer view. */
597 uint64_t au64;
598 } VBOXIDTE;
599 #pragma pack()
600 /** Pointer to IDT Entry. */
601 typedef VBOXIDTE *PVBOXIDTE;
602 /** Pointer to IDT Entry. */
603 typedef VBOXIDTE const *PCVBOXIDTE;
604
605 /** IDT Entry, 64-bit mode, Intertupt gate view. */
606 #pragma pack(1) /* paranoia */
607 typedef struct VBOXIDTE64_INTERRUPTGATE
608 {
609 /** Low offset word. */
610 unsigned u16OffsetLow : 16;
611 /** Segment Selector. */
612 unsigned u16SegSel : 16;
613 /** Interrupt Stack Table Index. */
614 unsigned u3Ist : 3;
615 /** Fixed value bit 0 - Set to 0. */
616 unsigned u1Fixed0 : 1;
617 /** Fixed value bit 1 - Set to 0. */
618 unsigned u1Fixed1 : 1;
619 /** Fixed value bit 2 - Set to 0. */
620 unsigned u1Fixed2 : 1;
621 /** Fixed value bit 3 - Set to 0. */
622 unsigned u1Fixed3 : 1;
623 /** Fixed value bit 4 - Set to 0. */
624 unsigned u1Fixed4 : 1;
625 /** Fixed value bit 5 - Set to 0. */
626 unsigned u1Fixed5 : 1;
627 /** Fixed value bit 6 - Set to 1. */
628 unsigned u1Fixed6 : 1;
629 /** Fixed value bit 7 - Set to 1. */
630 unsigned u1Fixed7 : 1;
631 /** Gate size, 1 = 32 bits, 0 = 16 bits. */
632 unsigned u132BitGate : 1;
633 /** Fixed value bit 5 - Set to 0. */
634 unsigned u1Fixed8 : 1;
635 /** Descriptor Privilege level. */
636 unsigned u2DPL : 2;
637 /** Present flag. */
638 unsigned u1Present : 1;
639 /** High offset word. */
640 unsigned u16OffsetHigh : 16;
641 /** Offset bits 32..63. */
642 unsigned u32OffsetHigh64;
643 /** Reserved. */
644 unsigned u32Reserved;
645 } VBOXIDTE64_INTERRUPTGATE;
646 #pragma pack()
647 /** Pointer to IDT Entry, 64-bit mode, Interrupt gate view. */
648 typedef VBOXIDTE64_INTERRUPTGATE *PVBOXIDTE64_INTERRUPTGATE;
649
650 /** IDT Entry, 64-bit mode, Trap gate view. */
651 #pragma pack(1) /* paranoia */
652 typedef struct VBOXIDTE64_TRAPGATE
653 {
654 /** Low offset word. */
655 unsigned u16OffsetLow : 16;
656 /** Segment Selector. */
657 unsigned u16SegSel : 16;
658 /** Interrupt Stack Table Index. */
659 unsigned u3Ist : 3;
660 /** Fixed value bit 0 - Set to 0. */
661 unsigned u1Fixed0 : 1;
662 /** Fixed value bit 1 - Set to 0. */
663 unsigned u1Fixed1 : 1;
664 /** Fixed value bit 2 - Set to 0. */
665 unsigned u1Fixed2 : 1;
666 /** Fixed value bit 3 - Set to 0. */
667 unsigned u1Fixed3 : 1;
668 /** Fixed value bit 4 - Set to 0. */
669 unsigned u1Fixed4 : 1;
670 /** Fixed value bit 5 - Set to 1. */
671 unsigned u1Fixed5 : 1;
672 /** Fixed value bit 6 - Set to 1. */
673 unsigned u1Fixed6 : 1;
674 /** Fixed value bit 7 - Set to 1. */
675 unsigned u1Fixed7 : 1;
676 /** Gate size, 1 = 32 bits, 0 = 16 bits. */
677 unsigned u132BitGate : 1;
678 /** Fixed value bit 5 - Set to 0. */
679 unsigned u1Fixed8 : 1;
680 /** Descriptor Privilege level. */
681 unsigned u2DPL : 2;
682 /** Present flag. */
683 unsigned u1Present : 1;
684 /** High offset word. */
685 unsigned u16OffsetHigh : 16;
686 /** Offset bits 32..63. */
687 unsigned u32OffsetHigh64;
688 /** Reserved. */
689 unsigned u32Reserved;
690 } VBOXIDTE64_TRAPGATE;
691 #pragma pack()
692 /** Pointer to IDT Entry, 64-bit mode, Trap gate view. */
693 typedef VBOXIDTE64_TRAPGATE *PVBOXIDTE64_TRAPGATE;
694
695 /** IDT Entry, 64-bit mode, Generic view. */
696 #pragma pack(1) /* paranoia */
697 typedef struct VBOXIDTE64_GENERIC
698 {
699 /** Low offset word. */
700 unsigned u16OffsetLow : 16;
701 /** Segment Selector. */
702 unsigned u16SegSel : 16;
703 /** Reserved. */
704 unsigned u3Ist : 3;
705 /** Fixed value bit 0 - Set to 0. */
706 unsigned u1Fixed0 : 1;
707 /** Fixed value bit 1 - Set to 0. */
708 unsigned u1Fixed1 : 1;
709 /** IDT Type part one (not used for task gate). */
710 unsigned u3Type1 : 3;
711 /** IDT Type part two. */
712 unsigned u5Type2 : 5;
713 /** Descriptor Privilege level. */
714 unsigned u2DPL : 2;
715 /** Present flag. */
716 unsigned u1Present : 1;
717 /** High offset word. */
718 unsigned u16OffsetHigh : 16;
719 /** Offset bits 32..63. */
720 unsigned u32OffsetHigh64;
721 /** Reserved. */
722 unsigned u32Reserved;
723 } VBOXIDTE64_GENERIC;
724 #pragma pack()
725 /** Pointer to IDT Entry, 64-bit mode, Generic view. */
726 typedef VBOXIDTE64_GENERIC *PVBOXIDTE64_GENERIC;
727
728 /** IDT Entry, 64-bit mode. */
729 #pragma pack(1) /* paranoia */
730 typedef union VBOXIDTE64
731 {
732 /** Trap gate view. */
733 VBOXIDTE64_TRAPGATE Trap;
734 /** Interrupt gate view. */
735 VBOXIDTE64_INTERRUPTGATE Int;
736 /** Generic IDT view. */
737 VBOXIDTE64_GENERIC Gen;
738
739 /** 8 bit unsigned integer view. */
740 uint8_t au8[16];
741 /** 16 bit unsigned integer view. */
742 uint16_t au16[8];
743 /** 32 bit unsigned integer view. */
744 uint32_t au32[4];
745 /** 64 bit unsigned integer view. */
746 uint64_t au64[2];
747 } VBOXIDTE64;
748 #pragma pack()
749 /** Pointer to IDT Entry. */
750 typedef VBOXIDTE64 *PVBOXIDTE64;
751 /** Pointer to IDT Entry. */
752 typedef VBOXIDTE64 const *PCVBOXIDTE64;
753
754 #pragma pack(1)
755 /** IDTR */
756 typedef struct VBOXIDTR
757 {
758 /** Size of the IDT. */
759 uint16_t cbIdt;
760 /** Address of the IDT. */
761 uint64_t pIdt;
762 } VBOXIDTR, *PVBOXIDTR;
763 #pragma pack()
764
765 /** @} */
766
767
768 /** @def VBOXIDTE_OFFSET
769 * Return the offset of an IDT entry.
770 */
771 #define VBOXIDTE_OFFSET(desc) \
772 ( ((uint32_t)((desc).Gen.u16OffsetHigh) << 16) \
773 | ( (desc).Gen.u16OffsetLow ) )
774
775 /** @def VBOXIDTE64_OFFSET
776 * Return the offset of an IDT entry.
777 */
778 #define VBOXIDTE64_OFFSET(desc) \
779 ( ((uint64_t)((desc).Gen.u32OffsetHigh64) << 32) \
780 | ((uint32_t)((desc).Gen.u16OffsetHigh) << 16) \
781 | ( (desc).Gen.u16OffsetLow ) )
782
783 #pragma pack(1)
784 /** GDTR */
785 typedef struct VBOXGDTR
786 {
787 /** Size of the GDT. */
788 uint16_t cbGdt;
789 /** Address of the GDT. */
790 uint64_t pGdt;
791 } VBOXGDTR;
792 #pragma pack()
793 /** Pointer to GDTR. */
794 typedef VBOXGDTR *PVBOXGDTR;
795
796 /** @} */
797
798
799 /**
800 * 32-bit Task Segment used in raw mode.
801 * @todo Move this to SELM! Use X86TSS32 instead.
802 */
803 #pragma pack(1)
804 typedef struct VBOXTSS
805 {
806 /** 0x00 - Back link to previous task. (static) */
807 RTSEL selPrev;
808 uint16_t padding1;
809 /** 0x04 - Ring-0 stack pointer. (static) */
810 uint32_t esp0;
811 /** 0x08 - Ring-0 stack segment. (static) */
812 RTSEL ss0;
813 uint16_t padding_ss0;
814 /** 0x0c - Ring-1 stack pointer. (static) */
815 uint32_t esp1;
816 /** 0x10 - Ring-1 stack segment. (static) */
817 RTSEL ss1;
818 uint16_t padding_ss1;
819 /** 0x14 - Ring-2 stack pointer. (static) */
820 uint32_t esp2;
821 /** 0x18 - Ring-2 stack segment. (static) */
822 RTSEL ss2;
823 uint16_t padding_ss2;
824 /** 0x1c - Page directory for the task. (static) */
825 uint32_t cr3;
826 /** 0x20 - EIP before task switch. */
827 uint32_t eip;
828 /** 0x24 - EFLAGS before task switch. */
829 uint32_t eflags;
830 /** 0x28 - EAX before task switch. */
831 uint32_t eax;
832 /** 0x2c - ECX before task switch. */
833 uint32_t ecx;
834 /** 0x30 - EDX before task switch. */
835 uint32_t edx;
836 /** 0x34 - EBX before task switch. */
837 uint32_t ebx;
838 /** 0x38 - ESP before task switch. */
839 uint32_t esp;
840 /** 0x3c - EBP before task switch. */
841 uint32_t ebp;
842 /** 0x40 - ESI before task switch. */
843 uint32_t esi;
844 /** 0x44 - EDI before task switch. */
845 uint32_t edi;
846 /** 0x48 - ES before task switch. */
847 RTSEL es;
848 uint16_t padding_es;
849 /** 0x4c - CS before task switch. */
850 RTSEL cs;
851 uint16_t padding_cs;
852 /** 0x50 - SS before task switch. */
853 RTSEL ss;
854 uint16_t padding_ss;
855 /** 0x54 - DS before task switch. */
856 RTSEL ds;
857 uint16_t padding_ds;
858 /** 0x58 - FS before task switch. */
859 RTSEL fs;
860 uint16_t padding_fs;
861 /** 0x5c - GS before task switch. */
862 RTSEL gs;
863 uint16_t padding_gs;
864 /** 0x60 - LDTR before task switch. */
865 RTSEL selLdt;
866 uint16_t padding_ldt;
867 /** 0x64 - Debug trap flag */
868 uint16_t fDebugTrap;
869 /** 0x66 - Offset relative to the TSS of the start of the I/O Bitmap
870 * and the end of the interrupt redirection bitmap. */
871 uint16_t offIoBitmap;
872 /** 0x68 - 32 bytes for the virtual interrupt redirection bitmap. (VME) */
873 uint8_t IntRedirBitmap[32];
874 } VBOXTSS;
875 #pragma pack()
876 /** Pointer to task segment. */
877 typedef VBOXTSS *PVBOXTSS;
878 /** Pointer to const task segment. */
879 typedef const VBOXTSS *PCVBOXTSS;
880
881
882 /** Pointer to a callback method table provided by the VM API user. */
883 typedef struct VMM2USERMETHODS const *PCVMM2USERMETHODS;
884
885
886 /**
887 * Data transport buffer (scatter/gather)
888 */
889 typedef struct PDMDATASEG
890 {
891 /** Length of buffer in entry. */
892 size_t cbSeg;
893 /** Pointer to the start of the buffer. */
894 void *pvSeg;
895 } PDMDATASEG;
896 /** Pointer to a data transport segment. */
897 typedef PDMDATASEG *PPDMDATASEG;
898 /** Pointer to a const data transport segment. */
899 typedef PDMDATASEG const *PCPDMDATASEG;
900
901
902 /**
903 * Forms of generic segment offloading.
904 */
905 typedef enum PDMNETWORKGSOTYPE
906 {
907 /** Invalid zero value. */
908 PDMNETWORKGSOTYPE_INVALID = 0,
909 /** TCP/IPv4 - no CWR/ECE encoding. */
910 PDMNETWORKGSOTYPE_IPV4_TCP,
911 /** TCP/IPv6 - no CWR/ECE encoding. */
912 PDMNETWORKGSOTYPE_IPV6_TCP,
913 /** UDP/IPv4. */
914 PDMNETWORKGSOTYPE_IPV4_UDP,
915 /** UDP/IPv6. */
916 PDMNETWORKGSOTYPE_IPV6_UDP,
917 /** TCP/IPv6 over IPv4 tunneling - no CWR/ECE encoding.
918 * The header offsets and sizes relates to IPv4 and TCP, the IPv6 header is
919 * figured out as needed.
920 * @todo Needs checking against facts, this is just an outline of the idea. */
921 PDMNETWORKGSOTYPE_IPV4_IPV6_TCP,
922 /** UDP/IPv6 over IPv4 tunneling.
923 * The header offsets and sizes relates to IPv4 and UDP, the IPv6 header is
924 * figured out as needed.
925 * @todo Needs checking against facts, this is just an outline of the idea. */
926 PDMNETWORKGSOTYPE_IPV4_IPV6_UDP,
927 /** The end of valid GSO types. */
928 PDMNETWORKGSOTYPE_END
929 } PDMNETWORKGSOTYPE;
930
931
932 /**
933 * Generic segment offloading context.
934 *
935 * We generally follow the E1000 specs wrt to which header fields we change.
936 * However the GSO type implies where the checksum fields are and that they are
937 * always updated from scratch (no half done pseudo checksums).
938 *
939 * @remarks This is part of the internal network GSO packets. Take great care
940 * when making changes. The size is expected to be exactly 8 bytes.
941 */
942 typedef struct PDMNETWORKGSO
943 {
944 /** The type of segmentation offloading we're performing (PDMNETWORKGSOTYPE). */
945 uint8_t u8Type;
946 /** The total header size. */
947 uint8_t cbHdrsTotal;
948 /** The max segment size (MSS) to apply. */
949 uint16_t cbMaxSeg;
950
951 /** Offset of the first header (IPv4 / IPv6). 0 if not not needed. */
952 uint8_t offHdr1;
953 /** Offset of the second header (TCP / UDP). 0 if not not needed. */
954 uint8_t offHdr2;
955 /** The header size used for segmentation (equal to offHdr2 in UFO). */
956 uint8_t cbHdrsSeg;
957 /** Unused. */
958 uint8_t u8Unused;
959 } PDMNETWORKGSO;
960 /** Pointer to a GSO context. */
961 typedef PDMNETWORKGSO *PPDMNETWORKGSO;
962 /** Pointer to a const GSO context. */
963 typedef PDMNETWORKGSO const *PCPDMNETWORKGSO;
964
965
966 /**
967 * The current ROM page protection.
968 *
969 * @remarks This is part of the saved state.
970 */
971 typedef enum PGMROMPROT
972 {
973 /** The customary invalid value. */
974 PGMROMPROT_INVALID = 0,
975 /** Read from the virgin ROM page, ignore writes.
976 * Map the virgin page, use write access handler to ignore writes. */
977 PGMROMPROT_READ_ROM_WRITE_IGNORE,
978 /** Read from the virgin ROM page, write to the shadow RAM.
979 * Map the virgin page, use write access handler to change the shadow RAM. */
980 PGMROMPROT_READ_ROM_WRITE_RAM,
981 /** Read from the shadow ROM page, ignore writes.
982 * Map the shadow page read-only, use write access handler to ignore writes. */
983 PGMROMPROT_READ_RAM_WRITE_IGNORE,
984 /** Read from the shadow ROM page, ignore writes.
985 * Map the shadow page read-write, disabled write access handler. */
986 PGMROMPROT_READ_RAM_WRITE_RAM,
987 /** The end of valid values. */
988 PGMROMPROT_END,
989 /** The usual 32-bit type size hack. */
990 PGMROMPROT_32BIT_HACK = 0x7fffffff
991 } PGMROMPROT;
992
993
994 /**
995 * Page mapping lock.
996 */
997 typedef struct PGMPAGEMAPLOCK
998 {
999 #if defined(IN_RC) || defined(VBOX_WITH_2X_4GB_ADDR_SPACE_IN_R0)
1000 /** The locked page. */
1001 void *pvPage;
1002 /** Pointer to the CPU that made the mapping.
1003 * In ring-0 and raw-mode context we don't intend to ever allow long term
1004 * locking and this is a way of making sure we're still on the same CPU. */
1005 PVMCPU pVCpu;
1006 #else
1007 /** Pointer to the PGMPAGE and lock type.
1008 * bit-0 abuse: set=write, clear=read. */
1009 uintptr_t uPageAndType;
1010 /** Read lock type value. */
1011 # define PGMPAGEMAPLOCK_TYPE_READ ((uintptr_t)0)
1012 /** Write lock type value. */
1013 # define PGMPAGEMAPLOCK_TYPE_WRITE ((uintptr_t)1)
1014 /** Lock type mask. */
1015 # define PGMPAGEMAPLOCK_TYPE_MASK ((uintptr_t)1)
1016 /** Pointer to the PGMCHUNKR3MAP. */
1017 void *pvMap;
1018 #endif
1019 } PGMPAGEMAPLOCK;
1020 /** Pointer to a page mapping lock. */
1021 typedef PGMPAGEMAPLOCK *PPGMPAGEMAPLOCK;
1022
1023
1024 /** Pointer to a info helper callback structure. */
1025 typedef struct DBGFINFOHLP *PDBGFINFOHLP;
1026 /** Pointer to a const info helper callback structure. */
1027 typedef const struct DBGFINFOHLP *PCDBGFINFOHLP;
1028
1029 /** Pointer to a const register descriptor. */
1030 typedef struct DBGFREGDESC const *PCDBGFREGDESC;
1031
1032
1033 /** Configuration manager tree node - A key. */
1034 typedef struct CFGMNODE *PCFGMNODE;
1035
1036 /** Configuration manager tree leaf - A value. */
1037 typedef struct CFGMLEAF *PCFGMLEAF;
1038
1039
1040 /**
1041 * CPU modes.
1042 */
1043 typedef enum CPUMMODE
1044 {
1045 /** The usual invalid zero entry. */
1046 CPUMMODE_INVALID = 0,
1047 /** Real mode. */
1048 CPUMMODE_REAL,
1049 /** Protected mode (32-bit). */
1050 CPUMMODE_PROTECTED,
1051 /** Long mode (64-bit). */
1052 CPUMMODE_LONG
1053 } CPUMMODE;
1054
1055
1056 /**
1057 * CPU mode flags (DISSTATE::mode).
1058 */
1059 typedef enum DISCPUMODE
1060 {
1061 DISCPUMODE_INVALID = 0,
1062 DISCPUMODE_16BIT,
1063 DISCPUMODE_32BIT,
1064 DISCPUMODE_64BIT,
1065 /** hack forcing the size of the enum to 32-bits. */
1066 DISCPUMODE_MAKE_32BIT_HACK = 0x7fffffff
1067 } DISCPUMODE;
1068
1069 /** Pointer to the disassembler state. */
1070 typedef struct DISSTATE *PDISSTATE;
1071 /** Pointer to a const disassembler state. */
1072 typedef struct DISSTATE const *PCDISSTATE;
1073
1074 /** @deprecated PDISSTATE and change pCpu and pDisState to pDis. */
1075 typedef PDISSTATE PDISCPUSTATE;
1076 /** @deprecated PCDISSTATE and change pCpu and pDisState to pDis. */
1077 typedef PCDISSTATE PCDISCPUSTATE;
1078
1079
1080 /** @} */
1081
1082 #endif