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

types.h

Go to the documentation of this file.
/** @file
 * IPRT - 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 ___iprt_types_h
#define ___iprt_types_h

#include <iprt/cdefs.h>
#include <iprt/stdint.h>

/*
 * Include standard C types.
 */
#ifndef IPRT_NO_CRT

# if defined(RT_OS_DARWIN) && defined(KERNEL)
    /*
     * Kludge for the darwin kernel:
     *  stddef.h is missing IIRC.
     */
#  ifndef _PTRDIFF_T
#  define _PTRDIFF_T
    typedef __darwin_ptrdiff_t ptrdiff_t;
#  endif
#  include <sys/types.h>

# elif defined(RT_OS_FREEBSD) && defined(_KERNEL)
    /*
     * Kludge for the FreeBSD kernel:
     *  stddef.h and sys/types.h have slightly different offsetof definitions
     *  when compiling in kernel mode. This is just to make GCC shut up.
     */
#  ifndef _STDDEF_H_
#   undef offsetof
#  endif
#  include <stddef.h>
#  ifndef _SYS_TYPES_H_
#   undef offsetof
#  endif
#  include <sys/types.h>
#  ifndef offsetof
#   error "offsetof is not defined..."
#  endif

# elif defined(RT_OS_LINUX) && defined(__KERNEL__)
    /*
     * Kludge for the linux kernel:
     *   1. sys/types.h doesn't mix with the kernel.
     *   2. Starting with 2.6.19, linux/types.h typedefs bool and linux/stddef.h
     *      declares false and true as enum values.
     *   3. Starting with 2.6.24, linux/types.h typedefs uintptr_t.
     * We work around these issues here and nowhere else.
     */
#  include <stddef.h>
#  if defined(__cplusplus)
    typedef bool _Bool;
#  endif
#  define bool linux_bool
#  define true linux_true
#  define false linux_false
#  define uintptr_t linux_uintptr_t
#  include <linux/autoconf.h>
#  include <linux/types.h>
#  include <linux/stddef.h>
#  undef uintptr_t
#  undef false
#  undef true
#  undef bool

# else
#  include <stddef.h>
#  include <sys/types.h>
# endif

/* Define any types missing from sys/types.h on windows. */
# ifdef _MSC_VER
#  undef ssize_t
   typedef intptr_t ssize_t;
# endif

#else /* no crt */
# include <iprt/nocrt/compiler/compiler.h>
#endif /* no crt */



/** @defgroup grp_rt_types  IPRT Base Types
 * @{
 */

/* define wchar_t, we don't wanna include all the wcsstuff to get this. */
#ifdef _MSC_VER
# ifndef _WCHAR_T_DEFINED
  typedef unsigned short wchar_t;
# define _WCHAR_T_DEFINED
# endif
#endif
#ifdef __GNUC__
/** @todo wchar_t on GNUC */
#endif

/*
 * C doesn't have bool.
 */
#ifndef __cplusplus
# if defined(__GNUC__)
#  if defined(RT_OS_LINUX) && __GNUC__ < 3
typedef uint8_t bool;
#  else
#   if defined(RT_OS_DARWIN) && defined(_STDBOOL_H)
#    undef bool
#   endif
typedef _Bool bool;
#  endif
# else
typedef unsigned char bool;
# endif
# ifndef true
#  define true  (1)
# endif
# ifndef false
#  define false (0)
# endif
#endif

/**
 * 128-bit unsigned integer.
 */
#if defined(__GNUC__) && defined(RT_ARCH_AMD64)
typedef __uint128_t uint128_t;
#else
00157 typedef struct uint128_s
{
    uint64_t    Lo;
    uint64_t    Hi;
} uint128_t;
#endif


/**
 * 128-bit signed integer.
 */
#if defined(__GNUC__) && defined(RT_ARCH_AMD64)
typedef __int128_t int128_t;
#else
00171 typedef struct int128_s
{
    uint64_t    lo;
    int64_t     hi;
} int128_t;
#endif


/**
 * 16-bit unsigned integer union.
 */
00182 typedef union RTUINT16U
{
    /** natural view. */
00185     uint16_t    u;

    /** 16-bit view. */
00188     uint16_t    au16[1];
    /** 8-bit view. */
00190     uint8_t     au8[4];
    /** 16-bit hi/lo view. */
    struct
    {
        uint16_t    Lo;
        uint16_t    Hi;
    } s;
} RTUINT16U;
/** Pointer to a 16-bit unsigned integer union. */
00199 typedef RTUINT16U *PRTUINT16U;
/** Pointer to a const 32-bit unsigned integer union. */
00201 typedef const RTUINT16U *PCRTUINT16U;


/**
 * 32-bit unsigned integer union.
 */
00207 typedef union RTUINT32U
{
    /** natural view. */
00210     uint32_t    u;
    /** Hi/Low view. */
    struct
    {
        uint16_t    Lo;
        uint16_t    Hi;
    } s;
    /** Word view. */
    struct
    {
        uint16_t    w0;
        uint16_t    w1;
    } Words;

    /** 32-bit view. */
00225     uint32_t    au32[1];
    /** 16-bit view. */
00227     uint16_t    au16[2];
    /** 8-bit view. */
00229     uint8_t     au8[4];
} RTUINT32U;
/** Pointer to a 32-bit unsigned integer union. */
00232 typedef RTUINT32U *PRTUINT32U;
/** Pointer to a const 32-bit unsigned integer union. */
00234 typedef const RTUINT32U *PCRTUINT32U;


/**
 * 64-bit unsigned integer union.
 */
00240 typedef union RTUINT64U
{
    /** Natural view. */
00243     uint64_t    u;
    /** Hi/Low view. */
    struct
    {
        uint32_t    Lo;
        uint32_t    Hi;
    } s;
    /** Double-Word view. */
    struct
    {
        uint32_t    dw0;
        uint32_t    dw1;
    } DWords;
    /** Word view. */
    struct
    {
        uint16_t    w0;
        uint16_t    w1;
        uint16_t    w2;
        uint16_t    w3;
    } Words;

    /** 64-bit view. */
00266     uint64_t    au64[1];
    /** 32-bit view. */
00268     uint32_t    au32[2];
    /** 16-bit view. */
00270     uint16_t    au16[4];
    /** 8-bit view. */
00272     uint8_t     au8[8];
} RTUINT64U;
/** Pointer to a 64-bit unsigned integer union. */
00275 typedef RTUINT64U *PRTUINT64U;
/** Pointer to a const 64-bit unsigned integer union. */
00277 typedef const RTUINT64U *PCRTUINT64U;


/**
 * 128-bit unsigned integer union.
 */
00283 typedef union RTUINT128U
{
    /** Natural view.
     * WARNING! This member depends on the compiler supporting 128-bit stuff. */
00287     uint128_t   u;
    /** Hi/Low view. */
    struct
    {
        uint64_t    Lo;
        uint64_t    Hi;
    } s;
    /** Quad-Word view. */
    struct
    {
        uint64_t    qw0;
        uint64_t    qw1;
    } QWords;
    /** Double-Word view. */
    struct
    {
        uint32_t    dw0;
        uint32_t    dw1;
        uint32_t    dw2;
        uint32_t    dw3;
    } DWords;
    /** Word view. */
    struct
    {
        uint16_t    w0;
        uint16_t    w1;
        uint16_t    w2;
        uint16_t    w3;
        uint16_t    w4;
        uint16_t    w5;
        uint16_t    w6;
        uint16_t    w7;
    } Words;

    /** 64-bit view. */
00322     uint64_t    au64[2];
    /** 32-bit view. */
00324     uint32_t    au32[4];
    /** 16-bit view. */
00326     uint16_t    au16[8];
    /** 8-bit view. */
00328     uint8_t     au8[16];
} RTUINT128U;
/** Pointer to a 64-bit unsigned integer union. */
00331 typedef RTUINT128U *PRTUINT128U;
/** Pointer to a const 64-bit unsigned integer union. */
00333 typedef const RTUINT128U *PCRTUINT128U;


/** Generic function type.
 * @see PFNRT
 */
typedef DECLCALLBACK(void) FNRT(void);

/** Generic function pointer.
 * With -pedantic, gcc-4 complains when casting a function to a data object, for example
 *
 * @code
 *    void foo(void)
 *    {
 *    }
 *
 *    void *bar = (void *)foo;
 * @endcode
 *
 * The compiler would warn with "ISO C++ forbids casting between pointer-to-function and
 * pointer-to-object". The purpose of this warning is not to bother the programmer but to
 * point out that he is probably doing something dangerous, assigning a pointer to executable
 * code to a data object.
 */
00357 typedef FNRT *PFNRT;


/** @defgroup grp_rt_types_both  Common Guest and Host Context Basic Types
 * @ingroup grp_rt_types
 * @{
 */

/** Signed integer which can contain both GC and HC pointers. */
#if (HC_ARCH_BITS == 32 && GC_ARCH_BITS == 32)
typedef int32_t         RTINTPTR;
#elif (HC_ARCH_BITS == 64 || GC_ARCH_BITS == 64)
typedef int64_t         RTINTPTR;
#else
#  error Unsupported HC_ARCH_BITS and/or GC_ARCH_BITS values.
#endif
/** Pointer to signed integer which can contain both GC and HC pointers. */
00374 typedef RTINTPTR       *PRTINTPTR;
/** Pointer const to signed integer which can contain both GC and HC pointers. */
00376 typedef const RTINTPTR *PCRTINTPTR;

/** Unsigned integer which can contain both GC and HC pointers. */
#if (HC_ARCH_BITS == 32 && GC_ARCH_BITS == 32)
typedef uint32_t        RTUINTPTR;
#elif (HC_ARCH_BITS == 64 || GC_ARCH_BITS == 64)
typedef uint64_t        RTUINTPTR;
#else
#  error Unsupported HC_ARCH_BITS and/or GC_ARCH_BITS values.
#endif
/** Pointer to unsigned integer which can contain both GC and HC pointers. */
00387 typedef RTUINTPTR      *PRTUINTPTR;
/** Pointer const to unsigned integer which can contain both GC and HC pointers. */
00389 typedef const RTUINTPTR *PCRTUINTPTR;

/** Signed integer. */
00392 typedef int32_t         RTINT;
/** Pointer to signed integer. */
00394 typedef RTINT          *PRTINT;
/** Pointer to const signed integer. */
00396 typedef const RTINT    *PCRTINT;

/** Unsigned integer. */
00399 typedef uint32_t        RTUINT;
/** Pointer to unsigned integer. */
00401 typedef RTUINT         *PRTUINT;
/** Pointer to const unsigned integer. */
00403 typedef const RTUINT   *PCRTUINT;

/** A file offset / size (off_t). */
00406 typedef int64_t         RTFOFF;
/** Pointer to a file offset / size. */
00408 typedef RTFOFF         *PRTFOFF;
/** The max value for RTFOFF. */
00410 #define RTFOFF_MAX      INT64_MAX
/** The min value for RTFOFF. */
00412 #define RTFOFF_MIN      INT64_MIN

/** File mode (see iprt/fs.h). */
00415 typedef uint32_t        RTFMODE;
/** Pointer to file mode. */
00417 typedef RTFMODE        *PRTFMODE;

/** Device unix number. */
00420 typedef uint32_t        RTDEV;
/** Pointer to a device unix number. */
00422 typedef RTDEV          *PRTDEV;

/** i-node number. */
00425 typedef uint64_t        RTINODE;
/** Pointer to a i-node number. */
00427 typedef RTINODE        *PRTINODE;

/** User id. */
00430 typedef uint32_t        RTUID;
/** Pointer to a user id. */
00432 typedef RTUID          *PRTUID;
/** NIL user id.
 * @todo check this for portability! */
00435 #define NIL_RTUID       (~(RTUID)0);

/** Group id. */
00438 typedef uint32_t        RTGID;
/** Pointer to a group id. */
00440 typedef RTGID          *PRTGID;
/** NIL group id.
 * @todo check this for portability! */
00443 #define NIL_RTGID       (~(RTGID)0);

/** I/O Port. */
00446 typedef uint16_t        RTIOPORT;
/** Pointer to I/O Port. */
00448 typedef RTIOPORT       *PRTIOPORT;
/** Pointer to const I/O Port. */
00450 typedef const RTIOPORT *PCRTIOPORT;

/** Selector. */
00453 typedef uint16_t        RTSEL;
/** Pointer to selector. */
00455 typedef RTSEL          *PRTSEL;
/** Pointer to const selector. */
00457 typedef const RTSEL    *PCRTSEL;
/** Max selector value. */
00459 #define RTSEL_MAX       UINT16_MAX

/** Far 16-bit pointer. */
#pragma pack(1)
00463 typedef struct RTFAR16
{
    uint16_t        off;
    RTSEL           sel;
} RTFAR16;
#pragma pack()
/** Pointer to Far 16-bit pointer. */
00470 typedef RTFAR16 *PRTFAR16;
/** Pointer to const Far 16-bit pointer. */
00472 typedef const RTFAR16 *PCRTFAR16;

/** Far 32-bit pointer. */
#pragma pack(1)
00476 typedef struct RTFAR32
{
    uint32_t        off;
    RTSEL           sel;
} RTFAR32;
#pragma pack()
/** Pointer to Far 32-bit pointer. */
00483 typedef RTFAR32 *PRTFAR32;
/** Pointer to const Far 32-bit pointer. */
00485 typedef const RTFAR32 *PCRTFAR32;

/** Far 64-bit pointer. */
#pragma pack(1)
00489 typedef struct RTFAR64
{
    uint64_t        off;
    RTSEL           sel;
} RTFAR64;
#pragma pack()
/** Pointer to Far 64-bit pointer. */
00496 typedef RTFAR64 *PRTFAR64;
/** Pointer to const Far 64-bit pointer. */
00498 typedef const RTFAR64 *PCRTFAR64;

/** @} */


/** @defgroup grp_rt_types_hc  Host Context Basic Types
 * @ingroup grp_rt_types
 * @{
 */

/** HC Natural signed integer.
 * @deprecated silly type. */
00510 typedef int32_t         RTHCINT;
/** Pointer to HC Natural signed integer.
 * @deprecated silly type. */
00513 typedef RTHCINT        *PRTHCINT;
/** Pointer to const HC Natural signed integer.
 * @deprecated silly type. */
00516 typedef const RTHCINT  *PCRTHCINT;

/** HC Natural unsigned integer.
 * @deprecated silly type. */
00520 typedef uint32_t        RTHCUINT;
/** Pointer to HC Natural unsigned integer.
 * @deprecated silly type. */
00523 typedef RTHCUINT       *PRTHCUINT;
/** Pointer to const HC Natural unsigned integer.
 * @deprecated silly type. */
00526 typedef const RTHCUINT *PCRTHCUINT;


/** Signed integer which can contain a HC pointer. */
#if HC_ARCH_BITS == 32
typedef int32_t         RTHCINTPTR;
#elif HC_ARCH_BITS == 64
typedef int64_t         RTHCINTPTR;
#else
#  error Unsupported HC_ARCH_BITS value.
#endif
/** Pointer to signed integer which can contain a HC pointer. */
00538 typedef RTHCINTPTR     *PRTHCINTPTR;
/** Pointer to const signed integer which can contain a HC pointer. */
00540 typedef const RTHCINTPTR *PCRTHCINTPTR;

/** Signed integer which can contain a HC ring-3 pointer. */
#if R3_ARCH_BITS == 32
typedef int32_t         RTR3INTPTR;
#elif R3_ARCH_BITS == 64
typedef int64_t         RTR3INTPTR;
#else
#  error Unsupported R3_ARCH_BITS value.
#endif
/** Pointer to signed integer which can contain a HC ring-3 pointer. */
00551 typedef RTR3INTPTR     *PRTR3INTPTR;
/** Pointer to const signed integer which can contain a HC ring-3 pointer. */
00553 typedef const RTR3INTPTR *PCRTR3INTPTR;

/** Signed integer which can contain a HC ring-0 pointer. */
#if R0_ARCH_BITS == 32
typedef int32_t         RTR0INTPTR;
#elif R0_ARCH_BITS == 64
typedef int64_t         RTR0INTPTR;
#else
#  error Unsupported R0_ARCH_BITS value.
#endif
/** Pointer to signed integer which can contain a HC ring-0 pointer. */
00564 typedef RTR0INTPTR     *PRTR0INTPTR;
/** Pointer to const signed integer which can contain a HC ring-0 pointer. */
00566 typedef const RTR0INTPTR *PCRTR0INTPTR;


/** Unsigned integer which can contain a HC pointer. */
#if HC_ARCH_BITS == 32
typedef uint32_t        RTHCUINTPTR;
#elif HC_ARCH_BITS == 64
typedef uint64_t        RTHCUINTPTR;
#else
#  error Unsupported HC_ARCH_BITS value.
#endif
/** Pointer to unsigned integer which can contain a HC pointer. */
00578 typedef RTHCUINTPTR    *PRTHCUINTPTR;
/** Pointer to unsigned integer which can contain a HC pointer. */
00580 typedef const RTHCUINTPTR *PCRTHCUINTPTR;

/** Unsigned integer which can contain a HC ring-3 pointer. */
#if R3_ARCH_BITS == 32
typedef uint32_t        RTR3UINTPTR;
#elif R3_ARCH_BITS == 64
typedef uint64_t        RTR3UINTPTR;
#else
#  error Unsupported R3_ARCH_BITS value.
#endif
/** Pointer to unsigned integer which can contain a HC ring-3 pointer. */
00591 typedef RTR3UINTPTR    *PRTR3UINTPTR;
/** Pointer to unsigned integer which can contain a HC ring-3 pointer. */
00593 typedef const RTR3UINTPTR *PCRTR3UINTPTR;

/** Unsigned integer which can contain a HC ring-0 pointer. */
#if R0_ARCH_BITS == 32
typedef uint32_t        RTR0UINTPTR;
#elif R0_ARCH_BITS == 64
typedef uint64_t        RTR0UINTPTR;
#else
#  error Unsupported R0_ARCH_BITS value.
#endif
/** Pointer to unsigned integer which can contain a HC ring-0 pointer. */
00604 typedef RTR0UINTPTR    *PRTR0UINTPTR;
/** Pointer to unsigned integer which can contain a HC ring-0 pointer. */
00606 typedef const RTR0UINTPTR *PCRTR0UINTPTR;


/** Host Physical Memory Address. */
00610 typedef uint64_t        RTHCPHYS;
/** Pointer to Host Physical Memory Address. */
00612 typedef RTHCPHYS       *PRTHCPHYS;
/** Pointer to const Host Physical Memory Address. */
00614 typedef const RTHCPHYS *PCRTHCPHYS;
/** @def NIL_RTHCPHYS
 * NIL HC Physical Address.
 * NIL_RTHCPHYS is used to signal an invalid physical address, similar
 * to the NULL pointer.
 */
00620 #define NIL_RTHCPHYS     ((RTHCPHYS)~0U) /** @todo change this to (~(VBOXHCPHYS)0) */


/** HC pointer. */
#ifndef IN_RC
00625 typedef void *          RTHCPTR;
#else
typedef RTHCUINTPTR     RTHCPTR;
#endif
/** Pointer to HC pointer. */
00630 typedef RTHCPTR        *PRTHCPTR;
/** Pointer to const HC pointer. */
00632 typedef const RTHCPTR  *PCRTHCPTR;
/** @def NIL_RTHCPTR
 * NIL HC pointer.
 */
00636 #define NIL_RTHCPTR     ((RTHCPTR)0)

/** HC ring-3 pointer. */
#ifdef  IN_RING3
typedef void *          RTR3PTR;
#else
00642 typedef RTR3UINTPTR     RTR3PTR;
#endif
/** Pointer to HC ring-3 pointer. */
00645 typedef RTR3PTR        *PRTR3PTR;
/** Pointer to const HC ring-3 pointer. */
00647 typedef const RTR3PTR  *PCRTR3PTR;
/** @def NIL_RTR3PTR
 * NIL HC ring-3 pointer.
 */
00651 #define NIL_RTR3PTR     ((RTR3PTR)0)

/** HC ring-0 pointer. */
#ifdef  IN_RING0
typedef void *          RTR0PTR;
#else
00657 typedef RTR0UINTPTR     RTR0PTR;
#endif
/** Pointer to HC ring-0 pointer. */
00660 typedef RTR0PTR        *PRTR0PTR;
/** Pointer to const HC ring-0 pointer. */
00662 typedef const RTR0PTR  *PCRTR0PTR;
/** @def NIL_RTR0PTR
 * NIL HC ring-0 pointer.
 */
00666 #define NIL_RTR0PTR     ((RTR0PTR)0)


/** Unsigned integer register in the host context. */
#if HC_ARCH_BITS == 32
typedef uint32_t            RTHCUINTREG;
#elif HC_ARCH_BITS == 64
typedef uint64_t            RTHCUINTREG;
#else
# error "Unsupported HC_ARCH_BITS!"
#endif
/** Pointer to an unsigned integer register in the host context. */
00678 typedef RTHCUINTREG        *PRTHCUINTREG;
/** Pointer to a const unsigned integer register in the host context. */
00680 typedef const RTHCUINTREG  *PCRTHCUINTREG;

/** Unsigned integer register in the host ring-3 context. */
#if R3_ARCH_BITS == 32
typedef uint32_t            RTR3UINTREG;
#elif R3_ARCH_BITS == 64
typedef uint64_t            RTR3UINTREG;
#else
# error "Unsupported R3_ARCH_BITS!"
#endif
/** Pointer to an unsigned integer register in the host ring-3 context. */
00691 typedef RTR3UINTREG        *PRTR3UINTREG;
/** Pointer to a const unsigned integer register in the host ring-3 context. */
00693 typedef const RTR3UINTREG  *PCRTR3UINTREG;

/** Unsigned integer register in the host ring-3 context. */
#if R0_ARCH_BITS == 32
typedef uint32_t            RTR0UINTREG;
#elif R0_ARCH_BITS == 64
typedef uint64_t            RTR0UINTREG;
#else
# error "Unsupported R3_ARCH_BITS!"
#endif
/** Pointer to an unsigned integer register in the host ring-3 context. */
00704 typedef RTR0UINTREG        *PRTR0UINTREG;
/** Pointer to a const unsigned integer register in the host ring-3 context. */
00706 typedef const RTR0UINTREG  *PCRTR0UINTREG;

/** @} */


/** @defgroup grp_rt_types_gc  Guest Context Basic Types
 * @ingroup grp_rt_types
 * @{
 */

/** Natural signed integer in the GC.
 * @deprecated silly type. */
#if GC_ARCH_BITS == 32
typedef int32_t         RTGCINT;
#elif GC_ARCH_BITS == 64 /** @todo this isn't right, natural int is 32-bit, see RTHCINT. */
typedef int64_t         RTGCINT;
#endif
/** Pointer to natural signed integer in GC.
 * @deprecated silly type. */
00725 typedef RTGCINT        *PRTGCINT;
/** Pointer to const natural signed integer in GC.
 * @deprecated silly type. */
00728 typedef const RTGCINT  *PCRTGCINT;

/** Natural unsigned integer in the GC.
 * @deprecated silly type. */
#if GC_ARCH_BITS == 32
typedef uint32_t        RTGCUINT;
#elif GC_ARCH_BITS == 64 /** @todo this isn't right, natural int is 32-bit, see RTHCUINT. */
typedef uint64_t        RTGCUINT;
#endif
/** Pointer to natural unsigned integer in GC.
 * @deprecated silly type. */
00739 typedef RTGCUINT       *PRTGCUINT;
/** Pointer to const natural unsigned integer in GC.
 * @deprecated silly type. */
00742 typedef const RTGCUINT *PCRTGCUINT;

/** Signed integer which can contain a GC pointer. */
#if GC_ARCH_BITS == 32
typedef int32_t         RTGCINTPTR;
#elif GC_ARCH_BITS == 64
typedef int64_t         RTGCINTPTR;
#endif
/** Pointer to signed integer which can contain a GC pointer. */
00751 typedef RTGCINTPTR     *PRTGCINTPTR;
/** Pointer to const signed integer which can contain a GC pointer. */
00753 typedef const RTGCINTPTR *PCRTGCINTPTR;

/** Unsigned integer which can contain a GC pointer. */
#if GC_ARCH_BITS == 32
typedef uint32_t        RTGCUINTPTR;
#elif GC_ARCH_BITS == 64
typedef uint64_t        RTGCUINTPTR;
#else
#  error Unsupported GC_ARCH_BITS value.
#endif
/** Pointer to unsigned integer which can contain a GC pointer. */
00764 typedef RTGCUINTPTR     *PRTGCUINTPTR;
/** Pointer to unsigned integer which can contain a GC pointer. */
00766 typedef const RTGCUINTPTR *PCRTGCUINTPTR;

/** Unsigned integer which can contain a 32 bits GC pointer. */
00769 typedef uint32_t        RTGCUINTPTR32;
/** Pointer to unsigned integer which can contain a 32 bits GC pointer. */
00771 typedef RTGCUINTPTR32   *PRTGCUINTPTR32;
/** Pointer to unsigned integer which can contain a 32 bits GC pointer. */
00773 typedef const RTGCUINTPTR32 *PCRTGCUINTPTR32;

/** Unsigned integer which can contain a 64 bits GC pointer. */
00776 typedef uint64_t        RTGCUINTPTR64;
/** Pointer to unsigned integer which can contain a 32 bits GC pointer. */
00778 typedef RTGCUINTPTR64   *PRTGCUINTPTR64;
/** Pointer to unsigned integer which can contain a 32 bits GC pointer. */
00780 typedef const RTGCUINTPTR64 *PCRTGCUINTPTR64;

/** Guest Physical Memory Address.*/
00783 typedef uint64_t        RTGCPHYS;
/** Pointer to Guest Physical Memory Address. */
00785 typedef RTGCPHYS       *PRTGCPHYS;
/** Pointer to const Guest Physical Memory Address. */
00787 typedef const RTGCPHYS *PCRTGCPHYS;
/** @def NIL_RTGCPHYS
 * NIL GC Physical Address.
 * NIL_RTGCPHYS is used to signal an invalid physical address, similar
 * to the NULL pointer. Note that this value may actually be valid in
 * some contexts.
 */
00794 #define NIL_RTGCPHYS     (~(RTGCPHYS)0U)


/** Guest Physical Memory Address; limited to 32 bits.*/
00798 typedef uint32_t        RTGCPHYS32;
/** Pointer to Guest Physical Memory Address. */
00800 typedef RTGCPHYS32     *PRTGCPHYS32;
/** Pointer to const Guest Physical Memory Address. */
00802 typedef const RTGCPHYS32 *PCRTGCPHYS32;
/** @def NIL_RTGCPHYS32
 * NIL GC Physical Address.
 * NIL_RTGCPHYS32 is used to signal an invalid physical address, similar
 * to the NULL pointer. Note that this value may actually be valid in
 * some contexts.
 */
00809 #define NIL_RTGCPHYS32     (~(RTGCPHYS32)0)


/** Guest Physical Memory Address; limited to 64 bits.*/
00813 typedef uint64_t        RTGCPHYS64;
/** Pointer to Guest Physical Memory Address. */
00815 typedef RTGCPHYS64     *PRTGCPHYS64;
/** Pointer to const Guest Physical Memory Address. */
00817 typedef const RTGCPHYS64 *PCRTGCPHYS64;
/** @def NIL_RTGCPHYS64
 * NIL GC Physical Address.
 * NIL_RTGCPHYS64 is used to signal an invalid physical address, similar
 * to the NULL pointer. Note that this value may actually be valid in
 * some contexts.
 */
00824 #define NIL_RTGCPHYS64     (~(RTGCPHYS64)0)

/** Guest context pointer, 32 bits.
 * Keep in mind that this type is an unsigned integer in
 * HC and void pointer in GC.
 */
00830 typedef RTGCUINTPTR32   RTGCPTR32;
/** Pointer to a guest context pointer. */
00832 typedef RTGCPTR32      *PRTGCPTR32;
/** Pointer to a const guest context pointer. */
00834 typedef const RTGCPTR32 *PCRTGCPTR32;
/** @def NIL_RTGCPTR32
 * NIL GC pointer.
 */
00838 #define NIL_RTGCPTR32   ((RTGCPTR32)0)

/** Guest context pointer, 64 bits.
 */
00842 typedef RTGCUINTPTR64   RTGCPTR64;
/** Pointer to a guest context pointer. */
00844 typedef RTGCPTR64      *PRTGCPTR64;
/** Pointer to a const guest context pointer. */
00846 typedef const RTGCPTR64 *PCRTGCPTR64;
/** @def NIL_RTGCPTR64
 * NIL GC pointer.
 */
00850 #define NIL_RTGCPTR64   ((RTGCPTR64)0)

/** Guest context pointer.
 * Keep in mind that this type is an unsigned integer in
 * HC and void pointer in GC.
 */
#if GC_ARCH_BITS == 64
typedef RTGCPTR64       RTGCPTR;
/** Pointer to a guest context pointer. */
typedef PRTGCPTR64      PRTGCPTR;
/** Pointer to a const guest context pointer. */
typedef PCRTGCPTR64    PCRTGCPTR;
/** @def NIL_RTGCPTR
 * NIL GC pointer.
 */
#define NIL_RTGCPTR     NIL_RTGCPTR64
#elif GC_ARCH_BITS == 32
typedef RTGCPTR32       RTGCPTR;
/** Pointer to a guest context pointer. */
typedef PRTGCPTR32      PRTGCPTR;
/** Pointer to a const guest context pointer. */
typedef PCRTGCPTR32    PCRTGCPTR;
/** @def NIL_RTGCPTR
 * NIL GC pointer.
 */
#define NIL_RTGCPTR     NIL_RTGCPTR32
#else
# error "Unsupported GC_ARCH_BITS!"
#endif

/** Unsigned integer register in the guest context. */
00881 typedef uint32_t              RTGCUINTREG32;
/** Pointer to an unsigned integer register in the guest context. */
00883 typedef RTGCUINTREG32        *PRTGCUINTREG32;
/** Pointer to a const unsigned integer register in the guest context. */
00885 typedef const RTGCUINTREG32  *PCRTGCUINTREG32;

typedef uint64_t              RTGCUINTREG64;
/** Pointer to an unsigned integer register in the guest context. */
00889 typedef RTGCUINTREG64        *PRTGCUINTREG64;
/** Pointer to a const unsigned integer register in the guest context. */
00891 typedef const RTGCUINTREG64  *PCRTGCUINTREG64;

#if GC_ARCH_BITS == 64
typedef RTGCUINTREG64       RTGCUINTREG;
#elif GC_ARCH_BITS == 32
typedef RTGCUINTREG32       RTGCUINTREG;
#else
# error "Unsupported GC_ARCH_BITS!"
#endif
/** Pointer to an unsigned integer register in the guest context. */
00901 typedef RTGCUINTREG        *PRTGCUINTREG;
/** Pointer to a const unsigned integer register in the guest context. */
00903 typedef const RTGCUINTREG  *PCRTGCUINTREG;

/** @} */

/** @defgroup grp_rt_types_rc  Raw mode Context Basic Types
 * @ingroup grp_rt_types
 * @{
 */

/** Raw mode context pointer; a 32 bits guest context pointer.
 * Keep in mind that this type is an unsigned integer in
 * HC and void pointer in RC.
 */
#ifdef IN_RC
typedef void *          RTRCPTR;
#else
00919 typedef uint32_t        RTRCPTR;
#endif
/** Pointer to a raw mode context pointer. */
00922 typedef RTRCPTR        *PRTRCPTR;
/** Pointer to a const raw mode context pointer. */
00924 typedef const RTRCPTR  *PCRTRCPTR;
/** @def NIL_RTGCPTR
 * NIL RC pointer.
 */
#define NIL_RTRCPTR    ((RTRCPTR)0)
/** @def RTRCPTR_MAX
 * The maximum value a RTRCPTR can have. Mostly used as INVALID value.
 */
00932 #define RTRCPTR_MAX    ((RTRCPTR)UINT32_MAX)

/** Raw mode context pointer, unsigned integer variant. */
00935 typedef int32_t         RTRCINTPTR;
/** @def RTRCUINPTR_MAX
 * The maximum value a RTRCUINPTR can have.
 */
#define RTRCUINTPTR_MAX ((RTRCUINTPTR)UINT32_MAX)

/** Raw mode context pointer, signed integer variant. */
00942 typedef uint32_t        RTRCUINTPTR;
/** @def RTRCINPTR_MIN
 * The minimum value a RTRCINPTR can have.
 */
#define RTRCINTPTR_MIN ((RTRCINTPTR)INT32_MIN)
/** @def RTRCINPTR_MAX
 * The maximum value a RTRCINPTR can have.
 */
#define RTRCINTPTR_MAX ((RTRCINTPTR)INT32_MAX)

/** @} */


/** @defgroup grp_rt_types_cc  Current Context Basic Types
 * @ingroup grp_rt_types
 * @{
 */

/** Current Context Physical Memory Address.*/
#ifdef IN_RC
typedef RTGCPHYS RTCCPHYS;
#else
00964 typedef RTHCPHYS RTCCPHYS;
#endif
/** Pointer to Current Context Physical Memory Address. */
00967 typedef RTCCPHYS       *PRTCCPHYS;
/** Pointer to const Current Context Physical Memory Address. */
00969 typedef const RTCCPHYS *PCRTCCPHYS;
/** @def NIL_RTCCPHYS
 * NIL CC Physical Address.
 * NIL_RTCCPHYS is used to signal an invalid physical address, similar
 * to the NULL pointer.
 */
#ifdef IN_RC
# define NIL_RTCCPHYS   NIL_RTGCPHYS
#else
00978 # define NIL_RTCCPHYS   NIL_RTHCPHYS
#endif

/** Unsigned integer register in the current context. */
#if ARCH_BITS == 32
typedef uint32_t                RTCCUINTREG;
#elif ARCH_BITS == 64
typedef uint64_t                RTCCUINTREG;
#else
# error "Unsupported ARCH_BITS!"
#endif
/** Pointer to an unsigned integer register in the current context. */
00990 typedef RTCCUINTREG            *PRTCCUINTREG;
/** Pointer to a const unsigned integer register in the current context. */
00992 typedef RTCCUINTREG const      *PCRTCCUINTREG;

/** Signed integer register in the current context. */
#if ARCH_BITS == 32
typedef int32_t                 RTCCINTREG;
#elif ARCH_BITS == 64
typedef int64_t                 RTCCINTREG;
#endif
/** Pointer to a signed integer register in the current context. */
01001 typedef RTCCINTREG             *PRTCCINTREG;
/** Pointer to a const signed integer register in the current context. */
01003 typedef RTCCINTREG const       *PCRTCCINTREG;

/** @} */


/** File handle. */
01009 typedef RTUINT                                      RTFILE;
/** Pointer to file handle. */
01011 typedef RTFILE                                     *PRTFILE;
/** Nil file handle. */
01013 #define NIL_RTFILE                                  (~(RTFILE)0)

/** Loader module handle. */
typedef R3PTRTYPE(struct RTLDRMODINTERNAL *)        RTLDRMOD;
/** Pointer to a loader module handle. */
01018 typedef RTLDRMOD                                   *PRTLDRMOD;
/** Nil loader module handle. */
01020 #define NIL_RTLDRMOD                                0

/** Ring-0 memory object handle. */
typedef R0PTRTYPE(struct RTR0MEMOBJINTERNAL *)      RTR0MEMOBJ;
/** Pointer to a Ring-0 memory object handle. */
01025 typedef RTR0MEMOBJ                                 *PRTR0MEMOBJ;
/** Nil ring-0 memory object handle. */
01027 #define NIL_RTR0MEMOBJ                              0

/** Native thread handle. */
01030 typedef RTHCUINTPTR                                 RTNATIVETHREAD;
/** Pointer to an native thread handle. */
01032 typedef RTNATIVETHREAD                             *PRTNATIVETHREAD;
/** Nil native thread handle. */
01034 #define NIL_RTNATIVETHREAD                          (~(RTNATIVETHREAD)0)

/** Process identifier. */
01037 typedef uint32_t                                    RTPROCESS;
/** Pointer to a process identifier. */
01039 typedef RTPROCESS                                  *PRTPROCESS;
/** Nil process identifier. */
01041 #define NIL_RTPROCESS                               (~(RTPROCESS)0)

/** Process ring-0 handle. */
01044 typedef RTR0UINTPTR                                 RTR0PROCESS;
/** Pointer to a ring-0 process handle. */
01046 typedef RTR0PROCESS                                *PRTR0PROCESS;
/** Nil ring-0 process handle. */
01048 #define NIL_RTR0PROCESS                             (~(RTR0PROCESS)0)

/** @typedef RTSEMEVENT
 * Event Semaphore handle. */
typedef R3R0PTRTYPE(struct RTSEMEVENTINTERNAL *)    RTSEMEVENT;
/** Pointer to an event semaphore handle. */
01054 typedef RTSEMEVENT                                 *PRTSEMEVENT;
/** Nil event semaphore handle. */
01056 #define NIL_RTSEMEVENT                              0

/** @typedef RTSEMEVENTMULTI
 * Event Multiple Release Semaphore handle. */
typedef R3R0PTRTYPE(struct RTSEMEVENTMULTIINTERNAL *) RTSEMEVENTMULTI;
/** Pointer to an event multiple release semaphore handle. */
01062 typedef RTSEMEVENTMULTI                            *PRTSEMEVENTMULTI;
/** Nil multiple release event semaphore handle. */
01064 #define NIL_RTSEMEVENTMULTI                         0

/** @typedef RTSEMFASTMUTEX
 * Fast mutex Semaphore handle. */
typedef R3R0PTRTYPE(struct RTSEMFASTMUTEXINTERNAL *) RTSEMFASTMUTEX;
/** Pointer to a mutex semaphore handle. */
01070 typedef RTSEMFASTMUTEX                             *PRTSEMFASTMUTEX;
/** Nil fast mutex semaphore handle. */
01072 #define NIL_RTSEMFASTMUTEX                          0

/** @typedef RTSEMMUTEX
 * Mutex Semaphore handle. */
typedef R3R0PTRTYPE(struct RTSEMMUTEXINTERNAL *)    RTSEMMUTEX;
/** Pointer to a mutex semaphore handle. */
01078 typedef RTSEMMUTEX                                 *PRTSEMMUTEX;
/** Nil mutex semaphore handle. */
01080 #define NIL_RTSEMMUTEX                              0

/** @typedef RTSEMRW
 * Read/Write Semaphore handle. */
typedef R3R0PTRTYPE(struct RTSEMRWINTERNAL *)       RTSEMRW;
/** Pointer to a read/write semaphore handle. */
01086 typedef RTSEMRW                                    *PRTSEMRW;
/** Nil read/write semaphore handle. */
01088 #define NIL_RTSEMRW                                 0

/** Spinlock handle. */
typedef R3R0PTRTYPE(struct RTSPINLOCKINTERNAL *)    RTSPINLOCK;
/** Pointer to a spinlock handle. */
01093 typedef RTSPINLOCK                                 *PRTSPINLOCK;
/** Nil spinlock handle. */
01095 #define NIL_RTSPINLOCK                              0

/** Socket handle. */
01098 typedef int RTSOCKET;
/** Pointer to socket handle. */
01100 typedef RTSOCKET *PRTSOCKET;
/** Nil socket handle. */
01102 #define NIL_RTSOCKET                                (~(RTSOCKET)0)

/** Thread handle.*/
typedef R3R0PTRTYPE(struct RTTHREADINT *)           RTTHREAD;
/** Pointer to thread handle. */
01107 typedef RTTHREAD                                   *PRTTHREAD;
/** Nil thread handle. */
01109 #define NIL_RTTHREAD                                0

/** A TLS index. */
01112 typedef int                                         RTTLS;
/** Pointer to a TLS index. */
01114 typedef RTTLS                                      *PRTTLS;
/** Pointer to a const TLS index. */
01116 typedef RTTLS const                                *PCRTTLS;
/** NIL TLS index value. */
01118 #define NIL_RTTLS                                   (-1)

/** Handle to a simple heap. */
typedef R3R0PTRTYPE(struct RTHEAPSIMPLEINTERNAL *)  RTHEAPSIMPLE;
/** Pointer to a handle to a simple heap. */
01123 typedef RTHEAPSIMPLE                               *PRTHEAPSIMPLE;
/** NIL simple heap handle. */
01125 #define NIL_RTHEAPSIMPLE                            ((RTHEAPSIMPLE)0)

/** Handle to an environment block. */
typedef R3PTRTYPE(struct RTENVINTERNAL *)           RTENV;
/** Pointer to a handle to an environment block. */
01130 typedef RTENV                                      *PRTENV;
/** NIL simple heap handle. */
01132 #define NIL_RTENV                                   ((RTENV)0)

/** A CPU identifier.
 * @remarks This doesn't have to correspond to the APIC ID (intel/amd). Nor
 *          does it have to correspond to the bits in the affinity mask, at
 *          least not until we've sorted out Windows NT. */
01138 typedef RTHCUINTPTR                                 RTCPUID;
/** Pointer to a CPU identifier. */
01140 typedef RTCPUID                                    *PRTCPUID;
/** Pointer to a const CPU identifier. */
01142 typedef RTCPUID const                              *PCRTCPUID;
/** Nil CPU Id. */
01144 #define NIL_RTCPUID                                 ((RTCPUID)~0)

/** A CPU set.
 * Treat this as an opaque type and always use RTCpuSet* for manupulating it. */
01148 typedef uint64_t                                    RTCPUSET;
/** Pointer to a CPU set. */
01150 typedef RTCPUSET                                   *PRTCPUSET;
/** Pointer to a const CPU set. */
01152 typedef RTCPUSET const                             *PCRTCPUSET;

/** A handle table handle. */
01155 typedef struct RTHANDLETABLEINT                    *RTHANDLETABLE;
/** A pointer to a handle table handle. */
01157 typedef RTHANDLETABLE                              *PRTHANDLETABLE;
/** @def NIL_RTHANDLETABLE
 * NIL handle table handle. */
01160 #define NIL_RTHANDLETABLE                           ((RTHANDLETABLE)0)

/** A handle to a low resolution timer. */
01163 typedef struct RTTIMERLRINT                        *RTTIMERLR;
/** A pointer to a low resolution timer handle. */
01165 typedef RTTIMERLR                                  *PRTTIMERLR;
/** @def NIL_RTTIMERLR
 * NIL low resolution timer handle value. */
01168 #define NIL_RTTIMERLR                               ((RTTIMERLR)0)

/** Handle to a random number generator. */
01171 typedef struct RTRANDINT                           *RTRAND;
/** Pointer to a random number generator handle. */
01173 typedef RTRAND                                     *PRTRAND;
/** NIL random number genrator handle value. */
01175 #define NIL_RTRAND                                  ((RTRAND)0)


/**
 * UUID data type.
 *
 * @note IPRT defines that the first three integers in the @c Gen struct
 * interpretation are in little endian representation. This is different to
 * many other UUID implementation, and requires conversion if you need to
 * achieve consistent results.
 */
01186 typedef union RTUUID
{
    /** 8-bit view. */
01189     uint8_t     au8[16];
    /** 16-bit view. */
01191     uint16_t    au16[8];
    /** 32-bit view. */
01193     uint32_t    au32[4];
    /** 64-bit view. */
01195     uint64_t    au64[2];
    /** The way the UUID is declared by the DCE specification. */
    struct
    {
        uint32_t    u32TimeLow;
        uint16_t    u16TimeMid;
        uint16_t    u16TimeHiAndVersion;
        uint8_t     u8ClockSeqHiAndReserved;
        uint8_t     u8ClockSeqLow;
        uint8_t     au8Node[6];
    } Gen;
} RTUUID;
/** Pointer to UUID data. */
01208 typedef RTUUID *PRTUUID;
/** Pointer to readonly UUID data. */
01210 typedef const RTUUID *PCRTUUID;

/**
 * UUID string maximum length.
 */
01215 #define RTUUID_STR_LENGTH       37


/** Compression handle. */
01219 typedef struct RTZIPCOMP   *PRTZIPCOMP;

/** Decompressor handle. */
01222 typedef struct RTZIPDECOMP *PRTZIPDECOMP;


/**
 * Unicode Code Point.
 */
01228 typedef uint32_t        RTUNICP;
/** Pointer to an Unicode Code Point. */
01230 typedef RTUNICP        *PRTUNICP;
/** Pointer to an Unicode Code Point. */
01232 typedef const RTUNICP  *PCRTUNICP;


/**
 * UTF-16 character.
 * @remark  wchar_t is not usable since it's compiler defined.
 * @remark  When we use the term character we're not talking about unicode code point, but
 *          the basic unit of the string encoding. Thus cwc - count of wide chars - means
 *          count of RTUTF16; cuc - count of unicode chars - means count of RTUNICP;
 *          and cch means count of the typedef 'char', which is assumed to be an octet.
 */
01243 typedef uint16_t        RTUTF16;
/** Pointer to a UTF-16 character. */
01245 typedef RTUTF16        *PRTUTF16;
/** Pointer to a const UTF-16 character. */
01247 typedef const RTUTF16  *PCRTUTF16;


/**
 * Wait for ever if we have to.
 */
01253 #define RT_INDEFINITE_WAIT      (~0U)


/**
 * Generic process callback.
 *
 * @returns VBox status code. Failure will cancel the operation.
 * @param   uPercentage     The percentage of the operation which has been completed.
 * @param   pvUser          The user specified argument.
 */
typedef DECLCALLBACK(int) FNRTPROGRESS(unsigned uPrecentage, void *pvUser);
/** Pointer to a generic progress callback function, FNRTPROCESS(). */
01265 typedef FNRTPROGRESS *PFNRTPROGRESS;


/**
 * Rectangle data type.
 */
01271 typedef struct RTRECT
{
    /** left X coordinate. */
01274     int32_t     xLeft;
    /** top Y coordinate. */
01276     int32_t     yTop;
    /** right X coordinate. (exclusive) */
01278     int32_t     xRight;
    /** bottom Y coordinate. (exclusive) */
01280     int32_t     yBottom;
} RTRECT;
/** Pointer to a rectangle. */
01283 typedef RTRECT *PRTRECT;
/** Pointer to a const rectangle. */
01285 typedef const RTRECT *PCRTRECT;


/**
 * Ethernet MAC address.
 *
 * The first 24 bits make up the Organisationally Unique Identifier (OUI),
 * where the first bit (little endian) indicates multicast (set) / unicast,
 * and the second bit indicates locally (set) / global administered. If all
 * bits are set, it's a broadcast.
 */
01296 typedef union RTMAC
{
    /** @todo add a bitfield view of this stuff. */
    /** 8-bit view. */
01300     uint8_t     au8[6];
    /** 16-bit view. */
01302     uint16_t    au16[3];
} RTMAC;
/** Pointer to a MAC address. */
01305 typedef RTMAC *PRTMAC;
/** Pointer to a readonly MAC address. */
01307 typedef const RTMAC *PCRTMAC;

/** @} */

#endif


Generated by  Doxygen 1.6.0   Back to index