Logo Search packages:      
Sourcecode: virtualbox-ose version File versions

types.h

Go to the documentation of this file.
/** @file
 * VirtualBox - Types.
 */

/*
 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 *
 * The contents of this file may alternatively be used under the terms
 * of the Common Development and Distribution License Version 1.0
 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
 * VirtualBox OSE distribution, in which case the provisions of the
 * CDDL are applicable instead of those of the GPL.
 *
 * You may elect to license modified versions of this file under the
 * terms and conditions of either the GPL or the CDDL or both.
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
 * Clara, CA 95054 USA or visit http://www.sun.com if you need
 * additional information or have any questions.
 */

#ifndef ___VBox_types_h
#define ___VBox_types_h

#include <VBox/cdefs.h>
#include <iprt/types.h>


/** @defgroup grp_types     Basic VBox Types
 * @{
 */


/** @defgroup grp_types_both  Common Guest and Host Context Basic Types
 * @ingroup grp_types
 * @{
 */


/** @defgroup grp_types_hc  Host Context Basic Types
 * @ingroup grp_types_both
 * @{
 */

/** @deprecated
 * @{ */
00055 typedef RTHCPHYS    VBOXHCPHYS;
typedef VBOXHCPHYS *PVBOXHCPHYS;
#define NILVBOXHCPHYS NIL_RTHCPHYS
typedef RTHCPTR     VBOXHCPTR;
typedef VBOXHCPTR  *PVBOXHCPTR;
/** @} */

/** @} */


/** @defgroup grp_types_gc  Guest Context Basic Types
 * @ingroup grp_types_both
 * @{
 */

/** @} */


/** Pointer to per support driver session data.
 * (The data is a R0 entity and private to the the R0 SUP part. All
 * other should consider this a sort of handle.) */
typedef R0PTRTYPE(struct SUPDRVSESSION *) PSUPDRVSESSION;

/** Pointer to a VM. */
00079 typedef struct VM              *PVM;
/** Pointer to a VM - Ring-0 Ptr. */
typedef R0PTRTYPE(struct VM *)  PVMR0;
/** Pointer to a VM - Ring-3 Ptr. */
typedef R3PTRTYPE(struct VM *)  PVMR3;
/** Pointer to a VM - GC Ptr. */
typedef GCPTRTYPE(struct VM *)  PVMGC;

/** Pointer to a ring-0 (global) VM structure. */
typedef R0PTRTYPE(struct GVM *) PGVM;

/** Pointer to a ring-3 (user mode) VM structure. */
typedef R3PTRTYPE(struct UVM *) PUVM;


/** VM State
 */
00096 typedef enum VMSTATE
{
    /** The VM is being created. */
00099     VMSTATE_CREATING = 0,
    /** The VM is created. */
00101     VMSTATE_CREATED,
    /** The VM is runnning. */
00103     VMSTATE_RUNNING,
    /** The VM state is being loaded from file. */
00105     VMSTATE_LOADING,
    /** The VM is screwed because of a failed state loading. */
00107     VMSTATE_LOAD_FAILURE,
    /** The VM state is being saved to file. */
00109     VMSTATE_SAVING,
    /** The VM is suspended. */
00111     VMSTATE_SUSPENDED,
    /** The VM is being reset. */
00113     VMSTATE_RESETTING,
    /** The VM is in guru meditation over a fatal failure. */
00115     VMSTATE_GURU_MEDITATION,
    /** The VM is switched off, awaiting destruction. */
00117     VMSTATE_OFF,
    /** The VM is being destroyed. */
00119     VMSTATE_DESTROYING,
    /** Terminated. */
00121     VMSTATE_TERMINATED,
    /** hack forcing the size of the enum to 32-bits. */
00123     VMSTATE_MAKE_32BIT_HACK = 0x7fffffff
} VMSTATE;


/** Pointer to a PDM Driver Base Interface. */
00128 typedef struct PDMIBASE *PPDMIBASE;
/** Pointer to a pointer to a PDM Driver Base Interface. */
00130 typedef PPDMIBASE *PPPDMIBASE;

/** Pointer to a PDM Device Instance. */
00133 typedef struct PDMDEVINS *PPDMDEVINS;
/** Pointer to a pointer to a PDM Device Instance. */
00135 typedef PPDMDEVINS *PPPDMDEVINS;
/** R3 pointer to a PDM Device Instance. */
typedef R3PTRTYPE(PPDMDEVINS) PPDMDEVINSR3;
/** R0 pointer to a PDM Device Instance. */
typedef R0PTRTYPE(PPDMDEVINS) PPDMDEVINSR0;
/** GC pointer to a PDM Device Instance. */
typedef GCPTRTYPE(PPDMDEVINS) PPDMDEVINSGC;

/** Pointer to a PDM USB Device Instance. */
00144 typedef struct PDMUSBINS *PPDMUSBINS;
/** Pointer to a pointer to a PDM USB Device Instance. */
00146 typedef PPDMUSBINS *PPPDMUSBINS;

/** Pointer to a PDM Driver Instance. */
00149 typedef struct PDMDRVINS *PPDMDRVINS;
/** Pointer to a pointer to a PDM Driver Instance. */
00151 typedef PPDMDRVINS *PPPDMDRVINS;

/** Pointer to a PDM Service Instance. */
00154 typedef struct PDMSRVINS *PPDMSRVINS;
/** Pointer to a pointer to a PDM Service Instance. */
00156 typedef PPDMSRVINS *PPPDMSRVINS;

/** R3 pointer to a timer. */
typedef R3PTRTYPE(struct TMTIMER *) PTMTIMERR3;
/** Pointer to a R3 pointer to a timer. */
00161 typedef PTMTIMERR3 *PPTMTIMERR3;

/** R0 pointer to a timer. */
typedef R0PTRTYPE(struct TMTIMER *) PTMTIMERR0;
/** Pointer to a R3 pointer to a timer. */
00166 typedef PTMTIMERR0 *PPTMTIMERR0;

/** GC pointer to a timer. */
typedef GCPTRTYPE(struct TMTIMER *) PTMTIMERGC;
/** Pointer to a GC pointer to a timer. */
00171 typedef PTMTIMERGC *PPTMTIMERGC;

/** Pointer to a timer. */
typedef CTXALLSUFF(PTMTIMER)   PTMTIMER;
/** Pointer to a pointer to a timer. */
typedef CTXALLSUFF(PPTMTIMER)  PPTMTIMER;

/** SSM Operation handle. */
00179 typedef struct SSMHANDLE *PSSMHANDLE;

/** Pointer to a CPUMCTX. */
00182 typedef struct CPUMCTX *PCPUMCTX;
/** Pointer to a const CPUMCTX. */
00184 typedef const struct CPUMCTX *PCCPUMCTX;

/** Pointer to a CPU context core. */
00187 typedef struct CPUMCTXCORE *PCPUMCTXCORE;
/** Pointer to a const CPU context core. */
00189 typedef const struct CPUMCTXCORE *PCCPUMCTXCORE;

/** Pointer to selector hidden registers. */
00192 typedef struct CPUMSELREGHID *PCPUMSELREGHID;
/** Pointer to const selector hidden registers. */
00194 typedef const struct CPUMSELREGHID *PCCPUMSELREGHID;

/** @} */


/** @defgroup grp_types_idt     Interrupt Descriptor Table Entry.
 * @ingroup grp_types
 * @todo This all belongs in x86.h!
 * @{ */

/** @todo VBOXIDT -> VBOXDESCIDT, skip the complex variations. We'll never use them. */

/** IDT Entry, Task Gate view. */
#pragma pack(1)                         /* paranoia */
00208 typedef struct VBOXIDTE_TASKGATE
{
    /** Reserved. */
00211     unsigned    u16Reserved1 : 16;
    /** Task Segment Selector. */
00213     unsigned    u16TSS : 16;
    /** More reserved. */
00215     unsigned    u8Reserved2 : 8;
    /** Fixed value bit 0 - Set to 1. */
00217     unsigned    u1Fixed0 : 1;
    /** Busy bit. */
00219     unsigned    u1Busy : 1;
    /** Fixed value bit 2 - Set to 1. */
00221     unsigned    u1Fixed1 : 1;
    /** Fixed value bit 3 - Set to 0. */
00223     unsigned    u1Fixed2: 1;
    /** Fixed value bit 4 - Set to 0. */
00225     unsigned    u1Fixed3 : 1;
    /** Descriptor Privilege level. */
00227     unsigned    u2DPL : 2;
    /** Present flag. */
00229     unsigned    u1Present : 1;
    /** Reserved. */
00231     unsigned    u16Reserved3 : 16;
} VBOXIDTE_TASKGATE;
#pragma pack()
/** Pointer to IDT Entry, Task gate view. */
00235 typedef VBOXIDTE_TASKGATE *PVBOXIDTE_TASKGATE;


/** IDT Entry, Intertupt gate view. */
#pragma pack(1)                         /* paranoia */
00240 typedef struct VBOXIDTE_INTERRUPTGATE
{
    /** Low offset word. */
00243     unsigned    u16OffsetLow : 16;
    /** Segment Selector. */
00245     unsigned    u16SegSel : 16;
    /** Reserved. */
00247     unsigned    u5Reserved2 : 5;
    /** Fixed value bit 0 - Set to 0. */
00249     unsigned    u1Fixed0 : 1;
    /** Fixed value bit 1 - Set to 0. */
00251     unsigned    u1Fixed1 : 1;
    /** Fixed value bit 2 - Set to 0. */
00253     unsigned    u1Fixed2 : 1;
    /** Fixed value bit 3 - Set to 0. */
00255     unsigned    u1Fixed3: 1;
    /** Fixed value bit 4 - Set to 1. */
00257     unsigned    u1Fixed4 : 1;
    /** Fixed value bit 5 - Set to 1. */
00259     unsigned    u1Fixed5 : 1;
    /** Gate size, 1 = 32 bits, 0 = 16 bits. */
00261     unsigned    u132BitGate : 1;
    /** Fixed value bit 5 - Set to 0. */
00263     unsigned    u1Fixed6 : 1;
    /** Descriptor Privilege level. */
00265     unsigned    u2DPL : 2;
    /** Present flag. */
00267     unsigned    u1Present : 1;
    /** High offset word. */
00269     unsigned    u16OffsetHigh : 16;
} VBOXIDTE_INTERRUPTGATE;
#pragma pack()
/** Pointer to IDT Entry, Interrupt gate view. */
00273 typedef  VBOXIDTE_INTERRUPTGATE *PVBOXIDTE_INTERRUPTGATE;

/** IDT Entry, Trap Gate view. */
#pragma pack(1)                         /* paranoia */
00277 typedef struct VBOXIDTE_TRAPGATE
{
    /** Low offset word. */
00280     unsigned    u16OffsetLow : 16;
    /** Segment Selector. */
00282     unsigned    u16SegSel : 16;
    /** Reserved. */
00284     unsigned    u5Reserved2 : 5;
    /** Fixed value bit 0 - Set to 0. */
00286     unsigned    u1Fixed0 : 1;
    /** Fixed value bit 1 - Set to 0. */
00288     unsigned    u1Fixed1 : 1;
    /** Fixed value bit 2 - Set to 0. */
00290     unsigned    u1Fixed2 : 1;
    /** Fixed value bit 3 - Set to 1. */
00292     unsigned    u1Fixed3: 1;
    /** Fixed value bit 4 - Set to 1. */
00294     unsigned    u1Fixed4 : 1;
    /** Fixed value bit 5 - Set to 1. */
00296     unsigned    u1Fixed5 : 1;
    /** Gate size, 1 = 32 bits, 0 = 16 bits. */
00298     unsigned    u132BitGate : 1;
    /** Fixed value bit 5 - Set to 0. */
00300     unsigned    u1Fixed6 : 1;
    /** Descriptor Privilege level. */
00302     unsigned    u2DPL : 2;
    /** Present flag. */
00304     unsigned    u1Present : 1;
    /** High offset word. */
00306     unsigned    u16OffsetHigh : 16;
} VBOXIDTE_TRAPGATE;
#pragma pack()
/** Pointer to IDT Entry, Trap Gate view. */
00310 typedef VBOXIDTE_TRAPGATE *PVBOXIDTE_TRAPGATE;

/** IDT Entry Generic view. */
#pragma pack(1)                         /* paranoia */
00314 typedef struct VBOXIDTE_GENERIC
{
    /** Low offset word. */
00317     unsigned    u16OffsetLow : 16;
    /** Segment Selector. */
00319     unsigned    u16SegSel : 16;
    /** Reserved. */
00321     unsigned    u5Reserved : 5;
    /** IDT Type part one (not used for task gate). */
00323     unsigned    u3Type1 : 3;
    /** IDT Type part two. */
00325     unsigned    u5Type2 : 5;
    /** Descriptor Privilege level. */
00327     unsigned    u2DPL : 2;
    /** Present flag. */
00329     unsigned    u1Present : 1;
    /** High offset word. */
00331     unsigned    u16OffsetHigh : 16;
} VBOXIDTE_GENERIC;
#pragma pack()
/** Pointer to IDT Entry Generic view. */
00335 typedef VBOXIDTE_GENERIC *PVBOXIDTE_GENERIC;

/** IDT Type1 value. (Reserved for task gate!) */
00338 #define VBOX_IDTE_TYPE1             0
/** IDT Type2 value - Task gate. */
00340 #define VBOX_IDTE_TYPE2_TASK        0x5
/** IDT Type2 value - 16 bit interrupt gate. */
00342 #define VBOX_IDTE_TYPE2_INT_16      0x6
/** IDT Type2 value - 32 bit interrupt gate. */
00344 #define VBOX_IDTE_TYPE2_INT_32      0xe
/** IDT Type2 value - 16 bit trap gate. */
00346 #define VBOX_IDTE_TYPE2_TRAP_16     0x7
/** IDT Type2 value - 32 bit trap gate. */
00348 #define VBOX_IDTE_TYPE2_TRAP_32     0xf

/** IDT Entry. */
#pragma pack(1)                         /* paranoia */
00352 typedef union VBOXIDTE
{
    /** Task gate view. */
00355     VBOXIDTE_TASKGATE       Task;
    /** Trap gate view. */
00357     VBOXIDTE_TRAPGATE       Trap;
    /** Interrupt gate view. */
00359     VBOXIDTE_INTERRUPTGATE  Int;
    /** Generic IDT view. */
00361     VBOXIDTE_GENERIC        Gen;

    /** 8 bit unsigned integer view. */
00364     uint8_t     au8[8];
    /** 16 bit unsigned integer view. */
00366     uint16_t    au16[4];
    /** 32 bit unsigned integer view. */
00368     uint32_t    au32[2];
    /** 64 bit unsigned integer view. */
00370     uint64_t    au64;
} VBOXIDTE;
#pragma pack()
/** Pointer to IDT Entry. */
00374 typedef VBOXIDTE *PVBOXIDTE;

#pragma pack(1)
/** IDTR */
00378 typedef struct VBOXIDTR
{
    /** Size of the IDT. */
00381     uint16_t    cbIdt;
    /** Address of the IDT. */
00383     uint32_t    pIdt;
} VBOXIDTR, *PVBOXIDTR;
#pragma pack()
/** @} */


/** @defgroup grp_types_desc    Descriptor Table Entry.
 * @ingroup grp_types
 * @{ */

#pragma pack(1)
/**
 * Memory descriptor.
 */
00397 typedef struct VBOXDESCGENERIC
{
    /**  0-15 - Limit - Low word. */
00400     unsigned    u16LimitLow : 16;
    /** 16-31 - Base address - lowe word.
     * Don't try set this to 24 because MSC is doing studing things then. */
00403     unsigned    u16BaseLow : 16;
    /** 32-39 - Base address - first 8 bits of high word. */
00405     unsigned    u8BaseHigh1 : 8;
    /** 40-43 - Segment Type. */
00407     unsigned    u4Type : 4;
    /** 44    - Descriptor Type. System(=0) or code/data selector */
00409     unsigned    u1DescType : 1;
    /** 45-46 - Descriptor Privelege level. */
00411     unsigned    u2Dpl : 2;
    /** 47    - Flags selector present(=1) or not. */
00413     unsigned    u1Present : 1;
    /** 48-51 - Segment limit 16-19. */
00415     unsigned    u4LimitHigh : 4;
    /** 52    - Available for system software. */
00417     unsigned    u1Available : 1;
    /** 53    - Reserved - 0. In long mode this is the 'Long' (L) attribute bit. */
00419     unsigned    u1Reserved : 1;
    /** 54    - This flags meaning depends on the segment type. Try make sense out
     * of the intel manual yourself.  */
00422     unsigned    u1DefBig : 1;
    /** 55    - Granularity of the limit. If set 4KB granularity is used, if
     * clear byte. */
00425     unsigned    u1Granularity : 1;
    /** 56-63 - Base address - highest 8 bits. */
00427     unsigned    u8BaseHigh2 : 8;
} VBOXDESCGENERIC;
#pragma pack()
/** Pointer to a generic descriptor entry. */
00431 typedef VBOXDESCGENERIC *PVBOXDESCGENERIC;

#pragma pack(1)
/**
 * Descriptor table entry.
 */
00437 typedef union VBOXDESC
{
    /** Generic descriptor view. */
00440     VBOXDESCGENERIC Gen;
    /** IDT view. */
00442     VBOXIDTE        Idt;

    /** 8 bit unsigned interger view. */
00445     uint8_t         au8[8];
    /** 16 bit unsigned interger view. */
00447     uint16_t        au16[4];
    /** 32 bit unsigned interger view. */
00449     uint32_t        au32[2];
} VBOXDESC;
#pragma pack()
/** Pointer to descriptor table entry. */
00453 typedef VBOXDESC *PVBOXDESC;
/** Pointer to const descriptor table entry. */
00455 typedef VBOXDESC const *PCVBOXDESC;


#pragma pack(1)
/** GDTR */
00460 typedef struct VBOXGDTR
{
    /** Size of the GDT. */
00463     uint16_t    cbGdt;
    /** Address of the GDT. */
00465     uint32_t    pGdt;
} VBOXGDTR;
#pragma pack()
/** Pointer to GDTR. */
00469 typedef VBOXGDTR *PVBOXGDTR;

/** @} */


/**
 * Task Segment
 */
#pragma pack(1)
00478 typedef struct VBOXTSS
{
    /** Back link to previous task. (static) */
00481     RTSEL       selPrev;
    uint16_t    padding1;
    /** Ring-0 stack pointer. (static) */
00484     uint32_t    esp0;
    /** Ring-0 stack segment. (static) */
00486     RTSEL       ss0;
    uint16_t    padding_ss0;
    /** Ring-1 stack pointer. (static) */
00489     uint32_t    esp1;
    /** Ring-1 stack segment. (static) */
00491     RTSEL       ss1;
    uint16_t    padding_ss1;
    /** Ring-2 stack pointer. (static) */
00494     uint32_t    esp2;
    /** Ring-2 stack segment. (static) */
00496     RTSEL       ss2;
    uint16_t    padding_ss2;
    /** Page directory for the task. (static) */
00499     uint32_t    cr3;
    /** EIP before task switch. */
00501     uint32_t    eip;
    /** EFLAGS before task switch. */
00503     uint32_t    eflags;
    /** EAX before task switch. */
00505     uint32_t    eax;
    /** ECX before task switch. */
00507     uint32_t    ecx;
    /** EDX before task switch. */
00509     uint32_t    edx;
    /** EBX before task switch. */
00511     uint32_t    ebx;
    /** ESP before task switch. */
00513     uint32_t    esp;
    /** EBP before task switch. */
00515     uint32_t    ebp;
    /** ESI before task switch. */
00517     uint32_t    esi;
    /** EDI before task switch. */
00519     uint32_t    edi;
    /** ES before task switch. */
00521     RTSEL       es;
    uint16_t    padding_es;
    /** CS before task switch. */
00524     RTSEL       cs;
    uint16_t    padding_cs;
    /** SS before task switch. */
00527     RTSEL       ss;
    uint16_t    padding_ss;
    /** DS before task switch. */
00530     RTSEL       ds;
    uint16_t    padding_ds;
    /** FS before task switch. */
00533     RTSEL       fs;
    uint16_t    padding_fs;
    /** GS before task switch. */
00536     RTSEL       gs;
    uint16_t    padding_gs;
    /** LDTR before task switch. */
00539     RTSEL       selLdt;
    uint16_t    padding_ldt;
    /** Debug trap flag */
00542     uint16_t    fDebugTrap;
    /** Offset relative to the TSS of the start of the I/O Bitmap
     * and the end of the interrupt redirection bitmap. */
00545     uint16_t    offIoBitmap;
    /** 32 bytes for the virtual interrupt redirection bitmap. (VME) */
00547     uint8_t     IntRedirBitmap[32];
} VBOXTSS;
#pragma pack()
/** Pointer to task segment. */
00551 typedef VBOXTSS *PVBOXTSS;
/** Pointer to const task segment. */
00553 typedef const VBOXTSS *PCVBOXTSS;


/** @} */

#endif

Generated by  Doxygen 1.6.0   Back to index