cdefs.h revision ebb01e77c669e766f55ade4fbbcbaf7ff7bd418e
/** @file
* IPRT - Common C and C++ definitions.
*/
/*
* Copyright (C) 2006-2012 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* 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.
*/
#ifndef ___iprt_cdefs_h
#define ___iprt_cdefs_h
/** @defgroup grp_rt_cdefs IPRT Common Definitions and Macros
* @{
*/
/** @def RT_C_DECLS_BEGIN
* Used to start a block of function declarations which are shared
* between C and C++ program.
*/
/** @def RT_C_DECLS_END
* Used to end a block of function declarations which are shared
* between C and C++ program.
*/
#if defined(__cplusplus)
# define RT_C_DECLS_BEGIN extern "C" {
# define RT_C_DECLS_END }
#else
# define RT_C_DECLS_BEGIN
# define RT_C_DECLS_END
#endif
/*
* Shut up DOXYGEN warnings and guide it properly thru the code.
*/
#ifdef DOXYGEN_RUNNING
# define __AMD64__
# define __X86__
# define RT_ARCH_AMD64
# define RT_ARCH_X86
# define IN_RING0
# define IN_RING3
# define IN_RC
# define IN_RC
# define IN_RT_RC
# define IN_RT_R0
# define IN_RT_R3
# define IN_RT_STATIC
# define RT_STRICT
# define RT_NO_STRICT
# define RT_LOCK_STRICT
# define RT_LOCK_NO_STRICT
# define RT_LOCK_STRICT_ORDER
# define RT_LOCK_NO_STRICT_ORDER
# define Breakpoint
# define RT_NO_DEPRECATED_MACROS
# define RT_EXCEPTIONS_ENABLED
# define RT_BIG_ENDIAN
# define RT_LITTLE_ENDIAN
# define RT_COMPILER_GROKS_64BIT_BITFIELDS
# define RT_COMPILER_WITH_80BIT_LONG_DOUBLE
# define RT_NO_VISIBILITY_HIDDEN
#endif /* DOXYGEN_RUNNING */
/** @def RT_ARCH_X86
* Indicates that we're compiling for the X86 architecture.
*/
/** @def RT_ARCH_AMD64
* Indicates that we're compiling for the AMD64 architecture.
*/
/** @def RT_ARCH_SPARC
* Indicates that we're compiling for the SPARC V8 architecture (32-bit).
*/
/** @def RT_ARCH_SPARC64
* Indicates that we're compiling for the SPARC V9 architecture (64-bit).
*/
#if !defined(RT_ARCH_X86) \
&& !defined(RT_ARCH_AMD64) \
&& !defined(RT_ARCH_SPARC) \
&& !defined(RT_ARCH_SPARC64) \
&& !defined(RT_ARCH_ARM)
# define RT_ARCH_AMD64
# define RT_ARCH_X86
# define RT_ARCH_SPARC64
# define RT_ARCH_SPARC
# define RT_ARCH_ARM
# else /* PORTME: append test for new archs. */
# error "Check what predefined macros your compiler uses to indicate architecture."
# endif
/* PORTME: append new archs checks. */
# error "Both RT_ARCH_X86 and RT_ARCH_AMD64 cannot be defined at the same time!"
# error "Both RT_ARCH_X86 and RT_ARCH_SPARC cannot be defined at the same time!"
# error "Both RT_ARCH_X86 and RT_ARCH_SPARC64 cannot be defined at the same time!"
# error "Both RT_ARCH_AMD64 and RT_ARCH_SPARC cannot be defined at the same time!"
# error "Both RT_ARCH_AMD64 and RT_ARCH_SPARC64 cannot be defined at the same time!"
# error "Both RT_ARCH_SPARC and RT_ARCH_SPARC64 cannot be defined at the same time!"
# error "Both RT_ARCH_ARM and RT_ARCH_AMD64 cannot be defined at the same time!"
# error "Both RT_ARCH_ARM and RT_ARCH_X86 cannot be defined at the same time!"
# error "Both RT_ARCH_ARM and RT_ARCH_SPARC64 cannot be defined at the same time!"
# error "Both RT_ARCH_ARM and RT_ARCH_SPARC cannot be defined at the same time!"
#endif
/** @def __X86__
* Indicates that we're compiling for the X86 architecture.
* @deprecated
*/
/** @def __AMD64__
* Indicates that we're compiling for the AMD64 architecture.
* @deprecated
*/
# if defined(RT_ARCH_AMD64)
# define __AMD64__
# elif defined(RT_ARCH_X86)
# define __X86__
# else
# error "Check what predefined macros your compiler uses to indicate architecture."
# endif
# error "Both __X86__ and __AMD64__ cannot be defined at the same time!"
# error "__X86__ without RT_ARCH_X86!"
# error "__AMD64__ without RT_ARCH_AMD64!"
#endif
/** @def RT_BIG_ENDIAN
* Defined if the architecture is big endian. */
/** @def RT_LITTLE_ENDIAN
* Defined if the architecture is little endian. */
# define RT_LITTLE_ENDIAN
# define RT_BIG_ENDIAN
#else
# error "PORTME: architecture endianess"
#endif
#if defined(RT_BIG_ENDIAN) && defined(RT_LITTLE_ENDIAN)
# error "Both RT_BIG_ENDIAN and RT_LITTLE_ENDIAN are defined"
#endif
/** @def IN_RING0
* Used to indicate that we're compiling code which is running
* in Ring-0 Host Context.
*/
/** @def IN_RING3
* Used to indicate that we're compiling code which is running
* in Ring-3 Host Context.
*/
/** @def IN_RC
* Used to indicate that we're compiling code which is running
* in the Raw-mode Context (implies R0).
*/
# error "You must define which context the compiled code should run in; IN_RING3, IN_RING0 or IN_RC"
#endif
# error "Only one of the IN_RING3, IN_RING0, IN_RC defines should be defined."
#endif
/** @def ARCH_BITS
* Defines the bit count of the current context.
*/
#if !defined(ARCH_BITS) || defined(DOXYGEN_RUNNING)
# if defined(RT_ARCH_AMD64) || defined(RT_ARCH_SPARC64)
# define ARCH_BITS 64
# else
# define ARCH_BITS 32
# endif
#endif
/** @def HC_ARCH_BITS
* Defines the host architecture bit count.
*/
#if !defined(HC_ARCH_BITS) || defined(DOXYGEN_RUNNING)
# ifndef IN_RC
# define HC_ARCH_BITS ARCH_BITS
# else
# define HC_ARCH_BITS 32
# endif
#endif
/** @def GC_ARCH_BITS
* Defines the guest architecture bit count.
*/
#if !defined(GC_ARCH_BITS) && !defined(DOXYGEN_RUNNING)
# ifdef VBOX_WITH_64_BITS_GUESTS
# define GC_ARCH_BITS 64
# else
# define GC_ARCH_BITS 32
# endif
#endif
/** @def R3_ARCH_BITS
* Defines the host ring-3 architecture bit count.
*/
#if !defined(R3_ARCH_BITS) || defined(DOXYGEN_RUNNING)
# ifdef IN_RING3
# define R3_ARCH_BITS ARCH_BITS
# else
# define R3_ARCH_BITS HC_ARCH_BITS
# endif
#endif
/** @def R0_ARCH_BITS
* Defines the host ring-0 architecture bit count.
*/
#if !defined(R0_ARCH_BITS) || defined(DOXYGEN_RUNNING)
# ifdef IN_RING0
# define R0_ARCH_BITS ARCH_BITS
# else
# define R0_ARCH_BITS HC_ARCH_BITS
# endif
#endif
/** @def GC_ARCH_BITS
* Defines the guest architecture bit count.
*/
#if !defined(GC_ARCH_BITS) || defined(DOXYGEN_RUNNING)
# ifdef IN_RC
# define GC_ARCH_BITS ARCH_BITS
# else
# define GC_ARCH_BITS 32
# endif
#endif
/** @name RT_OPSYS_XXX - Operative System Identifiers.
* These are the value that the RT_OPSYS \#define can take. @{
*/
/** Unknown OS. */
#define RT_OPSYS_UNKNOWN 0
/** OS Agnostic. */
#define RT_OPSYS_AGNOSTIC 1
/** Darwin - aka Mac OS X. */
#define RT_OPSYS_DARWIN 2
/** DragonFly BSD. */
#define RT_OPSYS_DRAGONFLY 3
/** DOS. */
#define RT_OPSYS_DOS 4
/** FreeBSD. */
#define RT_OPSYS_FREEBSD 5
/** Haiku. */
#define RT_OPSYS_HAIKU 6
/** Linux. */
#define RT_OPSYS_LINUX 7
/** L4. */
#define RT_OPSYS_L4 8
/** Minix. */
#define RT_OPSYS_MINIX 9
/** NetBSD. */
#define RT_OPSYS_NETBSD 11
/** Netware. */
#define RT_OPSYS_NETWARE 12
/** NT (native). */
#define RT_OPSYS_NT 13
/** OpenBSD. */
#define RT_OPSYS_OPENBSD 14
/** OS/2. */
#define RT_OPSYS_OS2 15
/** Plan 9. */
#define RT_OPSYS_PLAN9 16
/** QNX. */
#define RT_OPSYS_QNX 17
/** Solaris. */
#define RT_OPSYS_SOLARIS 18
/** UEFI. */
#define RT_OPSYS_UEFI 19
/** Windows. */
#define RT_OPSYS_WINDOWS 20
/** The max RT_OPSYS_XXX value (exclusive). */
#define RT_OPSYS_MAX 21
/** @} */
/** @def RT_OPSYS
* Indicates which OS we're targetting. It's a \#define with is
* assigned one of the RT_OPSYS_XXX defines above.
*
* So to test if we're on FreeBSD do the following:
* @code
* #if RT_OPSYS == RT_OPSYS_FREEBSD
* some_funky_freebsd_specific_stuff();
* #endif
* @endcode
*/
/*
* Set RT_OPSYS_XXX according to RT_OS_XXX.
*
* Search: #define RT_OPSYS_([A-Z0-9]+) .*
* Replace: # elif defined(RT_OS_\1)\n# define RT_OPSYS RT_OPSYS_\1
*/
#ifndef RT_OPSYS
# if defined(RT_OS_UNKNOWN)
# define RT_OPSYS RT_OPSYS_UNKNOWN
# elif defined(RT_OS_AGNOSTIC)
# define RT_OPSYS RT_OPSYS_AGNOSTIC
# elif defined(RT_OS_DARWIN)
# define RT_OPSYS RT_OPSYS_DARWIN
# elif defined(RT_OS_DRAGONFLY)
# define RT_OPSYS RT_OPSYS_DRAGONFLY
# define RT_OPSYS RT_OPSYS_DOS
# elif defined(RT_OS_FREEBSD)
# define RT_OPSYS RT_OPSYS_FREEBSD
# elif defined(RT_OS_HAIKU)
# define RT_OPSYS RT_OPSYS_HAIKU
# elif defined(RT_OS_LINUX)
# define RT_OPSYS RT_OPSYS_LINUX
# define RT_OPSYS RT_OPSYS_L4
# elif defined(RT_OS_MINIX)
# define RT_OPSYS RT_OPSYS_MINIX
# elif defined(RT_OS_NETBSD)
# define RT_OPSYS RT_OPSYS_NETBSD
# elif defined(RT_OS_NETWARE)
# define RT_OPSYS RT_OPSYS_NETWARE
# define RT_OPSYS RT_OPSYS_NT
# elif defined(RT_OS_OPENBSD)
# define RT_OPSYS RT_OPSYS_OPENBSD
# define RT_OPSYS RT_OPSYS_OS2
# elif defined(RT_OS_PLAN9)
# define RT_OPSYS RT_OPSYS_PLAN9
# define RT_OPSYS RT_OPSYS_QNX
# elif defined(RT_OS_SOLARIS)
# define RT_OPSYS RT_OPSYS_SOLARIS
# elif defined(RT_OS_UEFI)
# define RT_OPSYS RT_OPSYS_UEFI
# elif defined(RT_OS_WINDOWS)
# define RT_OPSYS RT_OPSYS_WINDOWS
# endif
#endif
/*
* Guess RT_OPSYS based on compiler predefined macros.
*/
#ifndef RT_OPSYS
# if defined(__APPLE__)
# define RT_OPSYS RT_OPSYS_DARWIN
# elif defined(__DragonFly__)
# define RT_OPSYS RT_OPSYS_DRAGONFLY
# define RT_OPSYS RT_OPSYS_FREEBSD
# elif defined(__gnu_linux__)
# define RT_OPSYS RT_OPSYS_LINUX
# define RT_OPSYS RT_OPSYS_NETBSD
# define RT_OPSYS RT_OPSYS_OPENBSD
# define RT_OPSYS RT_OPSYS_OS2
# define RT_OPSYS RT_OPSYS_SOLARIS
# define RT_OPSYS RT_OPSYS_WINDOWS
# else
# error "Port Me"
# endif
#endif
# error "Invalid RT_OPSYS value."
#endif
/*
* Do some consistency checks.
*
* Search: #define RT_OPSYS_([A-Z0-9]+) .*
* Replace: #if defined(RT_OS_\1) && RT_OPSYS != RT_OPSYS_\1\n# error RT_OPSYS vs RT_OS_\1\n#endif
*/
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
#endif
/*
* Make sure the RT_OS_XXX macro is defined.
*
* Search: #define RT_OPSYS_([A-Z0-9]+) .*
* Replace: #elif RT_OPSYS == RT_OPSYS_\1\n# ifndef RT_OS_\1\n# define RT_OS_\1\n# endif
*/
#if RT_OPSYS == RT_OPSYS_UNKNOWN
# ifndef RT_OS_UNKNOWN
# define RT_OS_UNKNOWN
# endif
# ifndef RT_OS_AGNOSTIC
# define RT_OS_AGNOSTIC
# endif
# ifndef RT_OS_DARWIN
# define RT_OS_DARWIN
# endif
# ifndef RT_OS_DRAGONFLY
# define RT_OS_DRAGONFLY
# endif
# ifndef RT_OS_DOS
# define RT_OS_DOS
# endif
# ifndef RT_OS_FREEBSD
# define RT_OS_FREEBSD
# endif
# ifndef RT_OS_HAIKU
# define RT_OS_HAIKU
# endif
# ifndef RT_OS_LINUX
# define RT_OS_LINUX
# endif
# ifndef RT_OS_L4
# define RT_OS_L4
# endif
# ifndef RT_OS_MINIX
# define RT_OS_MINIX
# endif
# ifndef RT_OS_NETBSD
# define RT_OS_NETBSD
# endif
# ifndef RT_OS_NETWARE
# define RT_OS_NETWARE
# endif
# ifndef RT_OS_NT
# define RT_OS_NT
# endif
# ifndef RT_OS_OPENBSD
# define RT_OS_OPENBSD
# endif
# ifndef RT_OS_OS2
# define RT_OS_OS2
# endif
# ifndef RT_OS_PLAN9
# define RT_OS_PLAN9
# endif
# ifndef RT_OS_QNX
# define RT_OS_QNX
# endif
# ifndef RT_OS_SOLARIS
# define RT_OS_SOLARIS
# endif
# ifndef RT_OS_UEFI
# define RT_OS_UEFI
# endif
# ifndef RT_OS_WINDOWS
# define RT_OS_WINDOWS
# endif
#else
# error "Bad RT_OPSYS value."
#endif
/**
* Checks whether the given OpSys uses DOS-style paths or not.
*
* By DOS-style paths we include drive lettering and UNC paths.
*
* @returns true / false
* @param a_OpSys The RT_OPSYS_XXX value to check, will be reference
* multiple times.
*/
#define RT_OPSYS_USES_DOS_PATHS(a_OpSys) \
( (a_OpSys) == RT_OPSYS_WINDOWS \
|| (a_OpSys) == RT_OPSYS_OS2 \
|| (a_OpSys) == RT_OPSYS_DOS )
/** @def CTXTYPE
* Declare a type differently in GC, R3 and R0.
*
* @param GCType The GC type.
* @param R3Type The R3 type.
* @param R0Type The R0 type.
* @remark For pointers used only in one context use RCPTRTYPE(), R3R0PTRTYPE(), R3PTRTYPE() or R0PTRTYPE().
*/
#ifdef IN_RC
#else
#endif
/** @def RCPTRTYPE
* Declare a pointer which is used in the raw mode context but appears in structure(s) used by
* both HC and RC. The main purpose is to make sure structures have the same
* size when built for different architectures.
*
* @param RCType The RC type.
*/
/** @def R3R0PTRTYPE
* Declare a pointer which is used in HC, is explicitly valid in ring 3 and 0,
* but appears in structure(s) used by both HC and GC. The main purpose is to
* make sure structures have the same size when built for different architectures.
*
* @param R3R0Type The R3R0 type.
* @remarks This used to be called HCPTRTYPE.
*/
/** @def R3PTRTYPE
* Declare a pointer which is used in R3 but appears in structure(s) used by
* both HC and GC. The main purpose is to make sure structures have the same
* size when built for different architectures.
*
* @param R3Type The R3 type.
*/
/** @def R0PTRTYPE
* Declare a pointer which is used in R0 but appears in structure(s) used by
* both HC and GC. The main purpose is to make sure structures have the same
* size when built for different architectures.
*
* @param R0Type The R0 type.
*/
/** @def CTXSUFF
* Adds the suffix of the current context to the passed in
* identifier name. The suffix is HC or GC.
*
* This is macro should only be used in shared code to avoid a forest of ifdefs.
* @param var Identifier name.
* @deprecated Use CTX_SUFF. Do NOT use this for new code.
*/
/** @def OTHERCTXSUFF
* Adds the suffix of the other context to the passed in
* identifier name. The suffix is HC or GC.
*
* This is macro should only be used in shared code to avoid a forest of ifdefs.
* @param var Identifier name.
* @deprecated Use CTX_SUFF. Do NOT use this for new code.
*/
#ifdef IN_RC
#else
#endif
/** @def CTXALLSUFF
* Adds the suffix of the current context to the passed in
* identifier name. The suffix is R3, R0 or GC.
*
* This is macro should only be used in shared code to avoid a forest of ifdefs.
* @param var Identifier name.
* @deprecated Use CTX_SUFF. Do NOT use this for new code.
*/
#ifdef IN_RC
#else
#endif
/** @def CTX_SUFF
* Adds the suffix of the current context to the passed in
* identifier name. The suffix is R3, R0 or RC.
*
* This is macro should only be used in shared code to avoid a forest of ifdefs.
* @param var Identifier name.
*
* @remark This will replace CTXALLSUFF and CTXSUFF before long.
*/
#ifdef IN_RC
#else
#endif
/** @def CTX_SUFF_Z
* Adds the suffix of the current context to the passed in
* identifier name, combining RC and R0 into RZ.
* The suffix thus is R3 or RZ.
*
* This is macro should only be used in shared code to avoid a forest of ifdefs.
* @param var Identifier name.
*
* @remark This will replace CTXALLSUFF and CTXSUFF before long.
*/
#ifdef IN_RING3
#else
#endif
/** @def CTXMID
* Adds the current context as a middle name of an identifier name
* The middle name is HC or GC.
*
* This is macro should only be used in shared code to avoid a forest of ifdefs.
* @param first First name.
* @param last Surname.
*/
/** @def OTHERCTXMID
* Adds the other context as a middle name of an identifier name
* The middle name is HC or GC.
*
* This is macro should only be used in shared code to avoid a forest of ifdefs.
* @param first First name.
* @param last Surname.
* @deprecated use CTX_MID or CTX_MID_Z
*/
#ifdef IN_RC
#else
#endif
/** @def CTXALLMID
* Adds the current context as a middle name of an identifier name.
* The middle name is R3, R0 or GC.
*
* This is macro should only be used in shared code to avoid a forest of ifdefs.
* @param first First name.
* @param last Surname.
* @deprecated use CTX_MID or CTX_MID_Z
*/
#ifdef IN_RC
#else
#endif
/** @def CTX_MID
* Adds the current context as a middle name of an identifier name.
* The middle name is R3, R0 or RC.
*
* This is macro should only be used in shared code to avoid a forest of ifdefs.
* @param first First name.
* @param last Surname.
*/
#ifdef IN_RC
#else
#endif
/** @def CTX_MID_Z
* Adds the current context as a middle name of an identifier name, combining RC
* and R0 into RZ.
* The middle name thus is either R3 or RZ.
*
* This is macro should only be used in shared code to avoid a forest of ifdefs.
* @param first First name.
* @param last Surname.
*/
#ifdef IN_RING3
#else
#endif
/** @def R3STRING
* A macro which in GC and R0 will return a dummy string while in R3 it will return
* the parameter.
*
* This is typically used to wrap description strings in structures shared
*
* @param pR3String The R3 string. Only referenced in R3.
* @see R0STRING and GCSTRING
*/
#ifdef IN_RING3
#else
#endif
/** @def R0STRING
* A macro which in GC and R3 will return a dummy string while in R0 it will return
* the parameter.
*
* This is typically used to wrap description strings in structures shared
*
* @param pR0String The R0 string. Only referenced in R0.
* @see R3STRING and GCSTRING
*/
#ifdef IN_RING0
#else
#endif
/** @def RCSTRING
* A macro which in R3 and R0 will return a dummy string while in RC it will return
* the parameter.
*
* This is typically used to wrap description strings in structures shared
*
* @param pRCString The RC string. Only referenced in RC.
* @see R3STRING, R0STRING
*/
#ifdef IN_RC
#else
#endif
/** @def RT_NOTHING
* A macro that expands to nothing.
* This is primarily intended as a dummy argument for macros to avoid the
* undefined behavior passing empty arguments to an macro (ISO C90 and C++98,
* gcc v4.4 warns about it).
*/
#define RT_NOTHING
/** @def RT_GCC_EXTENSION
* Macro for shutting up GCC warnings about using language extensions. */
#ifdef __GNUC__
# define RT_GCC_EXTENSION __extension__
#else
# define RT_GCC_EXTENSION
#endif
/** @def RT_COMPILER_GROKS_64BIT_BITFIELDS
* Macro that is defined if the compiler understands 64-bit bitfields. */
# define RT_COMPILER_GROKS_64BIT_BITFIELDS
#endif
/** @def RT_COMPILER_WITH_80BIT_LONG_DOUBLE
* Macro that is defined if the compiler implements long double as the
* IEEE extended precision floating. */
# define RT_COMPILER_WITH_80BIT_LONG_DOUBLE
#endif
/** @def RT_EXCEPTIONS_ENABLED
* Defined when C++ exceptions are enabled.
*/
#if !defined(RT_EXCEPTIONS_ENABLED) \
&& defined(__cplusplus) \
&& ( (defined(_MSC_VER) && defined(_CPPUNWIND)) \
|| (defined(__GNUC__) && defined(__EXCEPTIONS)))
# define RT_EXCEPTIONS_ENABLED
#endif
/** @def RT_NO_THROW
* How to express that a function doesn't throw C++ exceptions
* and the compiler can thus save itself the bother of trying
* to catch any of them. Put this between the closing parenthesis
* and the semicolon in function prototypes (and implementation if C++).
*/
#ifdef RT_EXCEPTIONS_ENABLED
# define RT_NO_THROW throw()
#else
# define RT_NO_THROW
#endif
/** @def RT_THROW
* How to express that a method or function throws a type of exceptions. Some
* compilers does not want this kind of information and will warning about it.
*
* @param type The type exception.
*
* @remarks If the actual throwing is done from the header, enclose it by
* \#ifdef RT_EXCEPTIONS_ENABLED ... \#else ... \#endif so the header
* compiles cleanly without exceptions enabled.
*
* Do NOT use this for the actual throwing of exceptions!
*/
#ifdef RT_EXCEPTIONS_ENABLED
# ifdef _MSC_VER
# if _MSC_VER >= 1310
# else
# endif
# else
# endif
#else
#endif
/** @def RT_GCC_SUPPORTS_VISIBILITY_HIDDEN
* Indicates that the "hidden" visibility attribute can be used (GCC) */
#if defined(__GNUC__)
# define RT_GCC_SUPPORTS_VISIBILITY_HIDDEN
# endif
#endif
/** @def RTCALL
* The standard calling convention for the Runtime interfaces.
*/
#ifdef _MSC_VER
#elif defined(__GNUC__) && defined(IN_RING0) && defined(RT_ARCH_X86) /** @todo consider dropping IN_RING0 here. */
# define RTCALL __attribute__((cdecl,regparm(0))) /* regparm(0) deals with -mregparm=x use in the linux kernel. */
#else
# define RTCALL
#endif
/** @def DECLEXPORT
* How to declare an exported function.
* @param type The return type of the function declaration.
*/
#elif defined(RT_USE_VISIBILITY_DEFAULT)
#else
#endif
/** @def DECLIMPORT
* How to declare an imported function.
* @param type The return type of the function declaration.
*/
#else
#endif
/** @def DECLHIDDEN
* How to declare a non-exported function or variable.
* @param type The return type of the function or the data type of the variable.
*/
#if !defined(RT_GCC_SUPPORTS_VISIBILITY_HIDDEN) || defined(RT_NO_VISIBILITY_HIDDEN)
#else
#endif
/** @def DECL_HIDDEN_CONST
* Workaround for g++ warnings when applying the hidden attribute to a const
* definition. Use DECLHIDDEN for the declaration.
* @param a_Type The return type of the function or the data type of
* the variable.
*/
#if defined(__cplusplus) && defined(__GNUC__)
#else
#endif
/** @def DECL_INVALID
* How to declare a function not available for linking in the current context.
* The purpose is to create compile or like time errors when used. This isn't
* possible on all platforms.
* @param type The return type of the function.
*/
#if defined(_MSC_VER)
#else
#endif
/** @def DECLASM
* How to declare an internal assembly function.
* @param type The return type of the function declaration.
*/
#ifdef __cplusplus
# else
# endif
#else
# else
# endif
#endif
/** @def DECLASMTYPE
* How to declare an internal assembly function type.
* @param type The return type of the function.
*/
#else
#endif
/** @def DECLNORETURN
* How to declare a function which does not return.
* @note: This macro can be combined with other macros, for example
* @code
* EMR3DECL(DECLNORETURN(void)) foo(void);
* @endcode
*/
#ifdef _MSC_VER
#else
#endif
/** @def DECLWEAK
* How to declare a variable which is not necessarily resolved at
* runtime.
* @note: This macro can be combined with other macros, for example
* @code
* EMR3DECL(DECLWEAK(int)) foo;
* @endcode
*/
#if defined(__GNUC__)
#else
#endif
/** @def DECLCALLBACK
* How to declare an call back function type.
* @param type The return type of the function declaration.
*/
/** @def DECLCALLBACKPTR
* How to declare an call back function pointer.
* @param type The return type of the function declaration.
* @param name The name of the variable member.
*/
#if defined(__IBMC__) || defined(__IBMCPP__)
#else
#endif
/** @def DECLCALLBACKMEMBER
* How to declare an call back function pointer member.
* @param type The return type of the function declaration.
*/
#if defined(__IBMC__) || defined(__IBMCPP__)
#else
#endif
/** @def DECLR3CALLBACKMEMBER
* How to declare an call back function pointer member - R3 Ptr.
* @param type The return type of the function declaration.
* @param args The argument list enclosed in parentheses.
*/
#ifdef IN_RING3
#else
#endif
/** @def DECLRCCALLBACKMEMBER
* How to declare an call back function pointer member - RC Ptr.
* @param type The return type of the function declaration.
* @param args The argument list enclosed in parentheses.
*/
#ifdef IN_RC
#else
#endif
/** @def DECLR0CALLBACKMEMBER
* How to declare an call back function pointer member - R0 Ptr.
* @param type The return type of the function declaration.
* @param args The argument list enclosed in parentheses.
*/
#ifdef IN_RING0
#else
#endif
/** @def DECLINLINE
* How to declare a function as inline.
* @param type The return type of the function declaration.
* @remarks Don't use this macro on C++ methods.
*/
#ifdef __GNUC__
#elif defined(__cplusplus)
#else
#endif
/** @def DECL_FORCE_INLINE
* How to declare a function as inline and try convince the compiler to always
* inline it regardless of optimization switches.
* @param type The return type of the function declaration.
* @remarks Use sparsely and with care. Don't use this macro on C++ methods.
*/
#ifdef __GNUC__
#else
#endif
/** @def DECL_NO_INLINE
* How to declare a function telling the compiler not to inline it.
* @param scope The function scope, static or RT_NOTHING.
* @param type The return type of the function declaration.
* @remarks Don't use this macro on C++ methods.
*/
#ifdef __GNUC__
#else
#endif
/** @def IN_RT_STATIC
* Used to indicate whether we're linking against a static IPRT
* or not. The IPRT symbols will be declared as hidden (if
* supported). Note that this define has no effect without setting
* IN_RT_R0, IN_RT_R3 or IN_RT_RC indicators are set first.
*/
/** @def IN_RT_R0
* Used to indicate whether we're inside the same link module as
* the HC Ring-0 Runtime Library.
*/
/** @def RTR0DECL(type)
* Runtime Library HC Ring-0 export or import declaration.
* @param type The return type of the function declaration.
*/
#ifdef IN_RT_R0
# ifdef IN_RT_STATIC
# else
# endif
#else
#endif
/** @def IN_RT_R3
* Used to indicate whether we're inside the same link module as
* the HC Ring-3 Runtime Library.
*/
/** @def RTR3DECL(type)
* Runtime Library HC Ring-3 export or import declaration.
* @param type The return type of the function declaration.
*/
#ifdef IN_RT_R3
# ifdef IN_RT_STATIC
# else
# endif
#else
#endif
/** @def IN_RT_RC
* Used to indicate whether we're inside the same link module as the raw-mode
* context (RC) runtime library.
*/
/** @def RTRCDECL(type)
* Runtime Library raw-mode context export or import declaration.
* @param type The return type of the function declaration.
*/
#ifdef IN_RT_RC
# ifdef IN_RT_STATIC
# else
# endif
#else
#endif
/** @def RTDECL(type)
* Runtime Library export or import declaration.
* Functions declared using this macro exists in all contexts.
* @param type The return type of the function declaration.
*/
# ifdef IN_RT_STATIC
# else
# endif
#else
#endif
/** @def RTDATADECL(type)
* Runtime Library export or import declaration.
* Data declared using this macro exists in all contexts.
* @param type The return type of the function declaration.
*/
# ifdef IN_RT_STATIC
# else
# endif
#else
#endif
/** @def RT_DECL_CLASS
* Declares an class living in the runtime.
*/
# ifdef IN_RT_STATIC
# define RT_DECL_CLASS
# else
# define RT_DECL_CLASS DECLEXPORT_CLASS
# endif
#else
# define RT_DECL_CLASS DECLIMPORT_CLASS
#endif
/** @def RT_NOCRT
* Symbol name wrapper for the No-CRT bits.
*
* In order to coexist in the same process as other CRTs, we need to
* decorate the symbols such that they don't conflict the ones in the
* other CRTs. The result of such conflicts / duplicate symbols can
* confuse the dynamic loader on Unix like systems.
*
* Define RT_WITHOUT_NOCRT_WRAPPERS to drop the wrapping.
* Define RT_WITHOUT_NOCRT_WRAPPER_ALIASES to drop the aliases to the
* wrapped names.
*/
/** @def RT_NOCRT_STR
* Same as RT_NOCRT only it'll return a double quoted string of the result.
*/
#ifndef RT_WITHOUT_NOCRT_WRAPPERS
#else
#endif
/** @def RT_LIKELY
* Give the compiler a hint that an expression is very likely to hold true.
*
* Some compilers support explicit branch prediction so that the CPU backend
* can hint the processor and also so that code blocks can be reordered such
* that the predicted path sees a more linear flow, thus improving cache
* behaviour, etc.
*
* IPRT provides the macros RT_LIKELY() and RT_UNLIKELY() as a way to utilize
* this compiler feature when present.
*
* A few notes about the usage:
*
* - Generally, use RT_UNLIKELY() with error condition checks (unless you
* have some _strong_ reason to do otherwise, in which case document it),
* to optimize for the success path.
*
* - Other than that, if you don't know the likelihood of a test succeeding
* from empirical or other 'hard' evidence, don't make predictions unless
* you happen to be a Dirk Gently.
*
* - These macros are meant to be used in places that get executed a lot. It
* is wasteful to make predictions in code that is executed rarely (e.g.
* at subsystem initialization time) as the basic block reordering that this
* affects can often generate larger code.
*
* - Note that RT_SUCCESS() and RT_FAILURE() already makes use of RT_LIKELY()
* and RT_UNLIKELY(). Should you wish for prediction free status checks,
* use the RT_SUCCESS_NP() and RT_FAILURE_NP() macros instead.
*
*
* @returns the boolean result of the expression.
* @param expr The expression that's very likely to be true.
* @see RT_UNLIKELY
*/
/** @def RT_UNLIKELY
* Give the compiler a hint that an expression is highly unlikely to hold true.
*
* See the usage instructions give in the RT_LIKELY() docs.
*
* @returns the boolean result of the expression.
* @param expr The expression that's very unlikely to be true.
* @see RT_LIKELY
*/
#if defined(__GNUC__)
# else
# endif
#else
#endif
/** @def RT_STR
* Returns the argument as a string constant.
* @param str Argument to stringify. */
/** @def RT_XSTR
* Returns the expanded argument as a string.
* @param str Argument to expand and stringy. */
/** @def RT_CONCAT
* Concatenate the expanded arguments without any extra spaces in between.
*
* @param a The first part.
* @param b The second part.
*/
#define RT_CONCAT(a,b) RT_CONCAT_HLP(a,b)
/** RT_CONCAT helper, don't use. */
#define RT_CONCAT_HLP(a,b) a##b
/** @def RT_CONCAT
* Concatenate the expanded arguments without any extra spaces in between.
*
* @param a The 1st part.
* @param b The 2nd part.
* @param c The 3rd part.
*/
#define RT_CONCAT3(a,b,c) RT_CONCAT3_HLP(a,b,c)
/** RT_CONCAT3 helper, don't use. */
#define RT_CONCAT3_HLP(a,b,c) a##b##c
/** @def RT_CONCAT
* Concatenate the expanded arguments without any extra spaces in between.
*
* @param a The 1st part.
* @param b The 2nd part.
* @param c The 3rd part.
*/
#define RT_CONCAT4(a,b,c,d) RT_CONCAT4_HLP(a,b,c,d)
/** RT_CONCAT4 helper, don't use. */
#define RT_CONCAT4_HLP(a,b,c,d) a##b##c##d
/**
* String constant tuple - string constant, strlen(string constant).
*
* @param a_szConst String constant.
*/
/**
* Macro for using in switch statements that turns constants into strings.
*
* @param a_Const The constant (not string).
*/
/** @def RT_BIT
* Convert a bit number into an integer bitmask (unsigned).
* @param bit The bit number.
*/
/** @def RT_BIT_32
* Convert a bit number into a 32-bit bitmask (unsigned).
* @param bit The bit number.
*/
/** @def RT_BIT_64
* Convert a bit number into a 64-bit bitmask (unsigned).
* @param bit The bit number.
*/
/** @def RT_ALIGN
* Align macro.
* @param u Value to align.
* @param uAlignment The alignment. Power of two!
*
* @remark Be extremely careful when using this macro with type which sizeof != sizeof int.
* When possible use any of the other RT_ALIGN_* macros. And when that's not
* possible, make 101% sure that uAlignment is specified with a right sized type.
*
* Specifying an unsigned 32-bit alignment constant with a 64-bit value will give
* you a 32-bit return value!
*
* In short: Don't use this macro. Use RT_ALIGN_T() instead.
*/
/** @def RT_ALIGN_T
* Align macro.
* @param u Value to align.
* @param uAlignment The alignment. Power of two!
* @param type Integer type to use while aligning.
* @remark This macro is the preferred alignment macro, it doesn't have any of the pitfalls RT_ALIGN has.
*/
#define RT_ALIGN_T(u, uAlignment, type) ( ((type)(u) + ((uAlignment) - 1)) & ~(type)((uAlignment) - 1) )
/** @def RT_ALIGN_32
* Align macro for a 32-bit value.
* @param u32 Value to align.
* @param uAlignment The alignment. Power of two!
*/
/** @def RT_ALIGN_64
* Align macro for a 64-bit value.
* @param u64 Value to align.
* @param uAlignment The alignment. Power of two!
*/
/** @def RT_ALIGN_Z
* Align macro for size_t.
* @param cb Value to align.
* @param uAlignment The alignment. Power of two!
*/
/** @def RT_ALIGN_P
* Align macro for pointers.
* @param pv Value to align.
* @param uAlignment The alignment. Power of two!
*/
/** @def RT_ALIGN_PT
* Align macro for pointers with type cast.
* @param u Value to align.
* @param uAlignment The alignment. Power of two!
* @param CastType The type to cast the result to.
*/
/** @def RT_ALIGN_R3PT
* Align macro for ring-3 pointers with type cast.
* @param u Value to align.
* @param uAlignment The alignment. Power of two!
* @param CastType The type to cast the result to.
*/
/** @def RT_ALIGN_R0PT
* Align macro for ring-0 pointers with type cast.
* @param u Value to align.
* @param uAlignment The alignment. Power of two!
* @param CastType The type to cast the result to.
*/
/** @def RT_ALIGN_GCPT
* Align macro for GC pointers with type cast.
* @param u Value to align.
* @param uAlignment The alignment. Power of two!
* @param CastType The type to cast the result to.
*/
/** @def RT_OFFSETOF
* Our own special offsetof() variant, returns a signed result.
*
* This differs from the usual offsetof() in that it's not relying on builtin
* compiler stuff and thus can use variables in arrays the structure may
* contain. This is useful to determine the sizes of structures ending
* with a variable length field.
*
* @returns offset into the structure of the specified member. signed.
* @param type Structure type.
* @param member Member.
*/
/** @def RT_UOFFSETOF
* Our own special offsetof() variant, returns an unsigned result.
*
* This differs from the usual offsetof() in that it's not relying on builtin
* compiler stuff and thus can use variables in arrays the structure may
* contain. This is useful to determine the sizes of structures ending
* with a variable length field.
*
* @returns offset into the structure of the specified member. unsigned.
* @param type Structure type.
* @param member Member.
*/
/** @def RT_OFFSETOF_ADD
* RT_OFFSETOF with an addend.
*
* @returns offset into the structure of the specified member. signed.
* @param type Structure type.
* @param member Member.
* @param addend The addend to add to the offset.
*/
/** @def RT_UOFFSETOF_ADD
* RT_UOFFSETOF with an addend.
*
* @returns offset into the structure of the specified member. signed.
* @param type Structure type.
* @param member Member.
* @param addend The addend to add to the offset.
*/
#define RT_UOFFSETOF_ADD(type, member, addend) ( (uintptr_t)&( ((type *)(void *)(uintptr_t)(addend))->member) )
/** @def RT_SIZEOFMEMB
* Get the size of a structure member.
*
* @returns size of the structure member.
* @param type Structure type.
* @param member Member.
*/
/** @def RT_FROM_MEMBER
* Convert a pointer to a structure member into a pointer to the structure.
*
* @returns pointer to the structure.
* @param pMem Pointer to the member.
* @param Type Structure type.
* @param Member Member name.
*/
#define RT_FROM_MEMBER(pMem, Type, Member) ( (Type *) ((uint8_t *)(void *)(pMem) - RT_UOFFSETOF(Type, Member)) )
/** @def RT_FROM_CPP_MEMBER
* Same as RT_FROM_MEMBER except it avoids the annoying g++ warnings about
* invalid access to non-static data member of NULL object.
*
* @returns pointer to the structure.
* @param pMem Pointer to the member.
* @param Type Structure type.
* @param Member Member name.
*
* @remarks Using the __builtin_offsetof does not shut up the compiler.
*/
#if defined(__GNUC__) && defined(__cplusplus)
#else
#endif
/** @def RT_ELEMENTS
* Calculates the number of elements in a statically sized array.
* @returns Element count.
* @param aArray Array in question.
*/
/**
* Checks if the value is a power of two.
*
* @returns true if power of two, false if not.
* @param uVal The value to test.
* @remarks 0 is a power of two.
* @see VERR_NOT_POWER_OF_TWO
*/
#ifdef RT_OS_OS2
/* Undefine RT_MAX since there is an unfortunate clash with the max
resource type define in os2.h. */
#endif
/** @def RT_MAX
* Finds the maximum value.
* @returns The higher of the two.
* @param Value1 Value 1
* @param Value2 Value 2
*/
/** @def RT_MIN
* Finds the minimum value.
* @returns The lower of the two.
* @param Value1 Value 1
* @param Value2 Value 2
*/
/** @def RT_CLAMP
* Clamps the value to minimum and maximum values.
* @returns The clamped value.
* @param Value The value to check.
* @param Min Minimum value.
* @param Max Maximum value.
*/
/** @def RT_ABS
* Get the absolute (non-negative) value.
* @returns The absolute value of Value.
* @param Value The value.
*/
/** @def RT_BOOL
* @returns The resulting boolean value.
* @param Value The value.
*/
/** @def RT_LO_U8
* Gets the low uint8_t of a uint16_t or something equivalent. */
#ifdef __GNUC__
# define RT_LO_U8(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint16_t)); (uint8_t)(a); })
#else
#endif
/** @def RT_HI_U16
* Gets the high uint16_t of a uint32_t or something equivalent). */
#ifdef __GNUC__
# define RT_HI_U8(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint16_t)); (uint8_t)((a) >> 8); })
#else
#endif
/** @def RT_LO_U16
* Gets the low uint16_t of a uint32_t or something equivalent. */
#ifdef __GNUC__
# define RT_LO_U16(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)(a); })
#else
#endif
/** @def RT_HI_U16
* Gets the high uint16_t of a uint32_t or something equivalent). */
#ifdef __GNUC__
# define RT_HI_U16(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint32_t)); (uint16_t)((a) >> 16); })
#else
#endif
/** @def RT_LO_U32
* Gets the low uint32_t of a uint64_t or something equivalent. */
#ifdef __GNUC__
# define RT_LO_U32(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)(a); })
#else
#endif
/** @def RT_HI_U32
* Gets the high uint32_t of a uint64_t or something equivalent). */
#ifdef __GNUC__
# define RT_HI_U32(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)((a) >> 32); })
#else
#endif
/** @def RT_BYTE1
* Gets the first byte of something. */
#define RT_BYTE1(a) ( (a) & 0xff )
/** @def RT_BYTE2
* Gets the second byte of something. */
/** @def RT_BYTE3
* Gets the second byte of something. */
/** @def RT_BYTE4
* Gets the fourth byte of something. */
/** @def RT_BYTE5
* Gets the fifth byte of something. */
/** @def RT_BYTE6
* Gets the sixth byte of something. */
/** @def RT_BYTE7
* Gets the seventh byte of something. */
/** @def RT_BYTE8
* Gets the eight byte of something. */
/** @def RT_LODWORD
* Gets the low dword (=uint32_t) of something.
* @deprecated Use RT_LO_U32. */
#define RT_LODWORD(a) ( (uint32_t)(a) )
/** @def RT_HIDWORD
* Gets the high dword (=uint32_t) of a 64-bit of something.
* @deprecated Use RT_HI_U32. */
/** @def RT_LOWORD
* Gets the low word (=uint16_t) of something.
* @deprecated Use RT_LO_U16. */
#define RT_LOWORD(a) ( (a) & 0xffff )
/** @def RT_HIWORD
* Gets the high word (=uint16_t) of a 32-bit something.
* @deprecated Use RT_HI_U16. */
#define RT_HIWORD(a) ( (a) >> 16 )
/** @def RT_LOBYTE
* Gets the low byte of something.
* @deprecated Use RT_LO_U8. */
#define RT_LOBYTE(a) ( (a) & 0xff )
/** @def RT_HIBYTE
* Gets the low byte of a 16-bit something.
* @deprecated Use RT_HI_U8. */
#define RT_HIBYTE(a) ( (a) >> 8 )
/** @def RT_MAKE_U64
* Constructs a uint64_t value from two uint32_t values.
*/
/** @def RT_MAKE_U64_FROM_U16
* Constructs a uint64_t value from four uint16_t values.
*/
/** @def RT_MAKE_U64_FROM_U8
* Constructs a uint64_t value from eight uint8_t values.
*/
/** @def RT_MAKE_U32
* Constructs a uint32_t value from two uint16_t values.
*/
/** @def RT_MAKE_U32_FROM_U8
* Constructs a uint32_t value from four uint8_t values.
*/
/** @def RT_MAKE_U16
* Constructs a uint16_t value from two uint8_t values.
*/
/** @def RT_BSWAP_U64
* Reverses the byte order of an uint64_t value. */
#if 0
#else
#endif
/** @def RT_BSWAP_U32
* Reverses the byte order of an uint32_t value. */
#if 0
#else
#endif
/** @def RT_BSWAP_U16
* Reverses the byte order of an uint16_t value. */
#if 0
#else
#endif
/** @def RT_BSWAP_U64_C
* Reverses the byte order of an uint64_t constant. */
#define RT_BSWAP_U64_C(u64) RT_MAKE_U64(RT_BSWAP_U32_C((u64) >> 32), RT_BSWAP_U32_C((u64) & 0xffffffff))
/** @def RT_BSWAP_U32_C
* Reverses the byte order of an uint32_t constant. */
#define RT_BSWAP_U32_C(u32) RT_MAKE_U32_FROM_U8(RT_BYTE4(u32), RT_BYTE3(u32), RT_BYTE2(u32), RT_BYTE1(u32))
/** @def RT_BSWAP_U16_C
* Reverses the byte order of an uint16_t constant. */
/** @def RT_H2LE_U64
* Converts an uint64_t value from host to little endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2LE_U64_C
* Converts an uint64_t constant from host to little endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2LE_U32
* Converts an uint32_t value from host to little endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2LE_U32_C
* Converts an uint32_t constant from host to little endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2LE_U16
* Converts an uint16_t value from host to little endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2LE_U16_C
* Converts an uint16_t constant from host to little endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_LE2H_U64
* Converts an uint64_t value from little endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_LE2H_U64_C
* Converts an uint64_t constant from little endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_LE2H_U32
* Converts an uint32_t value from little endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_LE2H_U32_C
* Converts an uint32_t constant from little endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_LE2H_U16
* Converts an uint16_t value from little endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_LE2H_U16_C
* Converts an uint16_t constant from little endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2BE_U64
* Converts an uint64_t value from host to big endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2BE_U64_C
* Converts an uint64_t constant from host to big endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2BE_U32
* Converts an uint32_t value from host to big endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2BE_U32_C
* Converts an uint32_t constant from host to big endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2BE_U16
* Converts an uint16_t value from host to big endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2BE_U16_C
* Converts an uint16_t constant from host to big endian byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_BE2H_U64
* Converts an uint64_t value from big endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_BE2H_U64
* Converts an uint64_t constant from big endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_BE2H_U32
* Converts an uint32_t value from big endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_BE2H_U32_C
* Converts an uint32_t value from big endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_BE2H_U16
* Converts an uint16_t value from big endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_BE2H_U16_C
* Converts an uint16_t constant from big endian to host byte order. */
#ifdef RT_BIG_ENDIAN
#else
#endif
/** @def RT_H2N_U64
* Converts an uint64_t value from host to network byte order. */
/** @def RT_H2N_U64_C
* Converts an uint64_t constant from host to network byte order. */
/** @def RT_H2N_U32
* Converts an uint32_t value from host to network byte order. */
/** @def RT_H2N_U32_C
* Converts an uint32_t constant from host to network byte order. */
/** @def RT_H2N_U16
* Converts an uint16_t value from host to network byte order. */
/** @def RT_H2N_U16_C
* Converts an uint16_t constant from host to network byte order. */
/** @def RT_N2H_U64
* Converts an uint64_t value from network to host byte order. */
/** @def RT_N2H_U64_C
* Converts an uint64_t constant from network to host byte order. */
/** @def RT_N2H_U32
* Converts an uint32_t value from network to host byte order. */
/** @def RT_N2H_U32_C
* Converts an uint32_t constant from network to host byte order. */
/** @def RT_N2H_U16
* Converts an uint16_t value from network to host byte order. */
/** @def RT_N2H_U16_C
* Converts an uint16_t value from network to host byte order. */
/*
* namespace pollution. Kill off some of the worse ones unless we're
* compiling kernel code.
*/
#if defined(RT_OS_DARWIN) \
&& !defined(KERNEL) \
&& !defined(RT_NO_BSD_PARAM_H_UNDEFING) \
&& ( defined(_SYS_PARAM_H_) || defined(_I386_PARAM_H_) )
#endif
/** @def NIL_OFFSET
* NIL offset.
* Whenever we use offsets instead of pointers to save space and relocation effort
* NIL_OFFSET shall be used as the equivalent to NULL.
*/
#define NIL_OFFSET (~0U)
/** @def NOREF
* Keeps the compiler from bitching about an unused parameter.
*/
/** @def RT_BREAKPOINT
* Emit a debug breakpoint instruction.
*
* to force gdb to remain at the int3 source line.
* @remarks The L4 kernel will try make sense of the breakpoint, thus the jmp on
*/
#ifdef __GNUC__
# if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)
# if !defined(__L4ENV__)
# else
# endif
# elif defined(RT_ARCH_SPARC64)
# define RT_BREAKPOINT() __asm__ __volatile__("illtrap 0\n\t") /** @todo Sparc64: this is just a wild guess. */
# elif defined(RT_ARCH_SPARC)
# define RT_BREAKPOINT() __asm__ __volatile__("unimp 0\n\t") /** @todo Sparc: this is just a wild guess (same as Sparc64, just different name). */
# endif
#endif
#ifdef _MSC_VER
# define RT_BREAKPOINT() __debugbreak()
#endif
#if defined(__IBMC__) || defined(__IBMCPP__)
#endif
#ifndef RT_BREAKPOINT
#endif
/** @defgroup grp_rt_cdefs_size Size Constants
* (Of course, these are binary computer terms, not SI.)
* @{
*/
/** 1 K (Kilo) (1 024). */
#define _1K 0x00000400
/** 2 K (Kilo) (2 048). */
#define _2K 0x00000800
/** 4 K (Kilo) (4 096). */
#define _4K 0x00001000
/** 8 K (Kilo) (8 192). */
#define _8K 0x00002000
/** 16 K (Kilo) (16 384). */
#define _16K 0x00004000
/** 32 K (Kilo) (32 678). */
#define _32K 0x00008000
/** 64 K (Kilo) (65 536). */
#define _64K 0x00010000
/** 128 K (Kilo) (131 072). */
#define _128K 0x00020000
/** 256 K (Kilo) (262 144). */
#define _256K 0x00040000
/** 512 K (Kilo) (524 288). */
#define _512K 0x00080000
/** 1 M (Mega) (1 048 576). */
#define _1M 0x00100000
/** 2 M (Mega) (2 097 152). */
#define _2M 0x00200000
/** 4 M (Mega) (4 194 304). */
#define _4M 0x00400000
/** 1 G (Giga) (1 073 741 824). (32-bit) */
#define _1G 0x40000000
/** 1 G (Giga) (1 073 741 824). (64-bit) */
#define _1G64 0x40000000LL
/** 2 G (Giga) (2 147 483 648). (32-bit) */
#define _2G32 0x80000000U
/** 2 G (Giga) (2 147 483 648). (64-bit) */
#define _2G 0x0000000080000000LL
/** 4 G (Giga) (4 294 967 296). */
#define _4G 0x0000000100000000LL
/** 1 T (Tera) (1 099 511 627 776). */
#define _1T 0x0000010000000000LL
/** 1 P (Peta) (1 125 899 906 842 624). */
#define _1P 0x0004000000000000LL
/** 1 E (Exa) (1 152 921 504 606 846 976). */
#define _1E 0x1000000000000000LL
/** 2 E (Exa) (2 305 843 009 213 693 952). */
#define _2E 0x2000000000000000ULL
/** @} */
/** @defgroup grp_rt_cdefs_decimal_grouping Decimal Constant Grouping Macros
* @{ */
/** @} */
/** @defgroup grp_rt_cdefs_time Time Constants
* @{
*/
/** 1 hour expressed in nanoseconds (64-bit). */
/** 1 minute expressed in nanoseconds (64-bit). */
/** 45 second expressed in nanoseconds. */
/** 30 second expressed in nanoseconds. */
/** 20 second expressed in nanoseconds. */
/** 15 second expressed in nanoseconds. */
/** 10 second expressed in nanoseconds. */
/** 1 second expressed in nanoseconds. */
/** 100 millsecond expressed in nanoseconds. */
/** 10 millsecond expressed in nanoseconds. */
/** 1 millsecond expressed in nanoseconds. */
/** 100 microseconds expressed in nanoseconds. */
/** 10 microseconds expressed in nanoseconds. */
/** 1 microsecond expressed in nanoseconds. */
/** 1 second expressed in nanoseconds - 64-bit type. */
/** 100 millsecond expressed in nanoseconds - 64-bit type. */
/** 10 millsecond expressed in nanoseconds - 64-bit type. */
/** 1 millsecond expressed in nanoseconds - 64-bit type. */
/** 100 microseconds expressed in nanoseconds - 64-bit type. */
/** 10 microseconds expressed in nanoseconds - 64-bit type. */
/** 1 microsecond expressed in nanoseconds - 64-bit type. */
/** 1 hour expressed in microseconds. */
/** 1 minute expressed in microseconds. */
/** 1 second expressed in microseconds. */
/** 100 millsecond expressed in microseconds. */
/** 10 millsecond expressed in microseconds. */
/** 1 millsecond expressed in microseconds. */
/** 1 hour expressed in microseconds - 64-bit type. */
/** 1 minute expressed in microseconds - 64-bit type. */
/** 1 second expressed in microseconds - 64-bit type. */
/** 100 millsecond expressed in microseconds - 64-bit type. */
/** 10 millsecond expressed in microseconds - 64-bit type. */
/** 1 millsecond expressed in microseconds - 64-bit type. */
/** 1 hour expressed in milliseconds. */
/** 1 minute expressed in milliseconds. */
/** 1 second expressed in milliseconds. */
/** 1 hour expressed in milliseconds - 64-bit type. */
/** 1 minute expressed in milliseconds - 64-bit type. */
/** 1 second expressed in milliseconds - 64-bit type. */
/** The number of seconds per week. */
/** The number of seconds per day. */
/** The number of seconds per hour. */
/** The number of seconds per week - 64-bit type. */
/** The number of seconds per day - 64-bit type. */
/** The number of seconds per hour - 64-bit type. */
/** @} */
/** @defgroup grp_rt_cdefs_dbgtype Debug Info Types
* @{ */
/** Other format. */
#define RT_DBGTYPE_OTHER RT_BIT_32(0)
/** Stabs. */
/** Debug With Arbitrary Record Format (DWARF). */
/** Microsoft Codeview debug info. */
/** Watcom debug info. */
/** IBM High Level Language debug info. */
/** Old OS/2 and Windows symbol file. */
/** Map file. */
/** @} */
/** @defgroup grp_rt_cdefs_exetype Executable Image Types
* @{ */
/** Some other format. */
#define RT_EXETYPE_OTHER RT_BIT_32(0)
/** Portable Executable. */
/** Linear eXecutable. */
/** Linear Executable. */
/** New Executable. */
/** DOS Executable (Mark Zbikowski). */
/** COM Executable. */
/** a.out Executable. */
/** Executable and Linkable Format. */
/** Mach-O Executable (including FAT ones). */
/** TE from UEFI. */
/** @} */
/** @def VALID_PTR
* Pointer validation macro.
* @param ptr The pointer.
*/
#if defined(RT_ARCH_AMD64)
# ifdef IN_RING3
# if defined(RT_OS_DARWIN) /* first 4GB is reserved for legacy kernel. */
# else
# endif
# else /* !IN_RING3 */
# endif /* !IN_RING3 */
#elif defined(RT_ARCH_X86)
#elif defined(RT_ARCH_SPARC64)
# ifdef IN_RING3
# if defined(RT_OS_SOLARIS)
/** Sparc64 user mode: According to Figure 9.4 in solaris internals */
/** @todo # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x80004000U >= 0x80004000U + 0x100000000ULL ) - figure this. */
# else
# error "Port me"
# endif
# else /* !IN_RING3 */
# if defined(RT_OS_SOLARIS)
/** @todo Sparc64 kernel mode: This is according to Figure 11.1 in solaris
* internals. Verify in sources. */
# else
# error "Port me"
# endif
# endif /* !IN_RING3 */
#elif defined(RT_ARCH_SPARC)
# ifdef IN_RING3
# ifdef RT_OS_SOLARIS
/** Sparc user mode: According to
# else
# error "Port me"
# endif
# else /* !IN_RING3 */
# ifdef RT_OS_SOLARIS
/** @todo Sparc kernel mode: Check the sources! */
# else
# error "Port me"
# endif
# endif /* !IN_RING3 */
#elif defined(RT_ARCH_ARM)
/* ASSUMES that at least the last and first 4K are out of bounds. */
#else
# error "Architecture identifier missing / not implemented."
#endif
/** Old name for RT_VALID_PTR. */
/** @def RT_VALID_ALIGNED_PTR
* Pointer validation macro that also checks the alignment.
* @param ptr The pointer.
* @param align The alignment, must be a power of two.
*/
/** @def VALID_PHYS32
* 32 bits physical address validation macro.
* @param Phys The RTGCPHYS address.
*/
/** @def N_
* The \#define N_ is used to mark a string for translation. This is usable in
* any part of the code, as it is only used by the tools that create message
* catalogs. This macro is a no-op as far as the compiler and code generation
* is concerned.
*
* If you want to both mark a string for translation and translate it, use _().
*/
#define N_(s) (s)
/** @def _
* The \#define _ is used to mark a string for translation and to translate it
* in one step.
*
* If you want to only mark a string for translation, use N_().
*/
#define _(s) gettext(s)
/** @def __PRETTY_FUNCTION__
* With GNU C we'd like to use the builtin __PRETTY_FUNCTION__, so define that
* for the other compilers.
*/
#if !defined(__GNUC__) && !defined(__PRETTY_FUNCTION__)
# ifdef _MSC_VER
# define __PRETTY_FUNCTION__ __FUNCSIG__
# else
# define __PRETTY_FUNCTION__ __FUNCTION__
# endif
#endif
/** @def RT_STRICT
* The \#define RT_STRICT controls whether or not assertions and other runtime
* checks should be compiled in or not. This is defined when DEBUG is defined.
* If RT_NO_STRICT is defined, it will unconditionally be undefined.
*
* If you want assertions which are not subject to compile time options use
* the AssertRelease*() flavors.
*/
# define RT_STRICT
#endif
#ifdef RT_NO_STRICT
#endif
/** @todo remove this: */
#if !defined(RT_LOCK_STRICT) && !defined(DEBUG_bird)
# define RT_LOCK_NO_STRICT
#endif
#if !defined(RT_LOCK_STRICT_ORDER) && !defined(DEBUG_bird)
# define RT_LOCK_NO_STRICT_ORDER
#endif
/** @def RT_LOCK_STRICT
* The \#define RT_LOCK_STRICT controls whether deadlock detection and related
* checks are done in the lock and semaphore code. It is by default enabled in
* RT_STRICT builds, but this behavior can be overridden by defining
* RT_LOCK_NO_STRICT. */
# define RT_LOCK_STRICT
#endif
/** @def RT_LOCK_NO_STRICT
* The \#define RT_LOCK_NO_STRICT disables RT_LOCK_STRICT. */
#if defined(RT_LOCK_NO_STRICT) && defined(RT_LOCK_STRICT)
#endif
/** @def RT_LOCK_STRICT_ORDER
* The \#define RT_LOCK_STRICT_ORDER controls whether locking order is checked
* by the lock and semaphore code. It is by default enabled in RT_STRICT
* builds, but this behavior can be overridden by defining
* RT_LOCK_NO_STRICT_ORDER. */
# define RT_LOCK_STRICT_ORDER
#endif
/** @def RT_LOCK_NO_STRICT_ORDER
* The \#define RT_LOCK_NO_STRICT_ORDER disables RT_LOCK_STRICT_ORDER. */
#if defined(RT_LOCK_NO_STRICT_ORDER) && defined(RT_LOCK_STRICT_ORDER)
#endif
/** Source position. */
/** Source position declaration. */
/** Source position arguments. */
/** Applies NOREF() to the source position arguments. */
/** @def RT_INLINE_ASM_EXTERNAL
* Defined as 1 if the compiler does not support inline assembly.
* The ASM* functions will then be implemented in external .asm files.
*/
#if (defined(_MSC_VER) && defined(RT_ARCH_AMD64)) \
|| (!defined(RT_ARCH_AMD64) && !defined(RT_ARCH_X86))
# define RT_INLINE_ASM_EXTERNAL 1
#else
# define RT_INLINE_ASM_EXTERNAL 0
#endif
/** @def RT_INLINE_ASM_GNU_STYLE
* Defined as 1 if the compiler understands GNU style inline assembly.
*/
#if defined(_MSC_VER)
# define RT_INLINE_ASM_GNU_STYLE 0
#else
# define RT_INLINE_ASM_GNU_STYLE 1
#endif
/** @def RT_INLINE_ASM_USES_INTRIN
* Defined as 1 if the compiler have and uses intrin.h. Otherwise it is 0. */
#ifdef _MSC_VER
# if _MSC_VER >= 1400
# define RT_INLINE_ASM_USES_INTRIN 1
# endif
#endif
#ifndef RT_INLINE_ASM_USES_INTRIN
# define RT_INLINE_ASM_USES_INTRIN 0
#endif
/** @} */
/** @defgroup grp_rt_cdefs_cpp Special Macros for C++
* @ingroup grp_rt_cdefs
* @{
*/
#ifdef __cplusplus
/** @def DECLEXPORT_CLASS
* How to declare an exported class. Place this macro after the 'class'
* keyword in the declaration of every class you want to export.
*
* @note It is necessary to use this macro even for inner classes declared
* inside the already exported classes. This is a GCC specific requirement,
* but it seems not to harm other compilers.
*/
#elif defined(RT_USE_VISIBILITY_DEFAULT)
#else
# define DECLEXPORT_CLASS
#endif
/** @def DECLIMPORT_CLASS
* How to declare an imported class Place this macro after the 'class'
* keyword in the declaration of every class you want to export.
*
* @note It is necessary to use this macro even for inner classes declared
* inside the already exported classes. This is a GCC specific requirement,
* but it seems not to harm other compilers.
*/
#elif defined(RT_USE_VISIBILITY_DEFAULT)
#else
# define DECLIMPORT_CLASS
#endif
/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP
* Macro to work around error C2593 of the not-so-smart MSVC 7.x ambiguity
* resolver. The following snippet clearly demonstrates the code causing this
* error:
* @code
* class A
* {
* public:
* operator bool() const { return false; }
* operator int*() const { return NULL; }
* };
* int main()
* {
* A a;
* if (!a);
* if (a && 0);
* return 0;
* }
* @endcode
* The code itself seems pretty valid to me and GCC thinks the same.
*
* This macro fixes the compiler error by explicitly overloading implicit
* global operators !, && and || that take the given class instance as one of
* their arguments.
*
* The best is to use this macro right after the class declaration.
*
* @note The macro expands to nothing for compilers other than MSVC.
*
* @param Cls Class to apply the workaround to
*/
#if defined(_MSC_VER)
# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls) \
#else
# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls)
#endif
/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL
* Version of WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP for template classes.
*
* @param Tpl Name of the template class to apply the workaround to
* @param ArgsDecl arguments of the template, as declared in |<>| after the
* |template| keyword, including |<>|
* @param Args arguments of the template, as specified in |<>| after the
* template class name when using the, including |<>|
*
* Example:
* @code
* // template class declaration
* template <class C>
* class Foo { ... };
* // applied workaround
* WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL (Foo, <class C>, <C>)
* @endcode
*/
#if defined(_MSC_VER)
#else
#endif
/** @def DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP
* Declares the copy constructor and the assignment operation as inlined no-ops
* (non-existent functions) for the given class. Use this macro inside the
* private section if you want to effectively disable these operations for your
* class.
*
* @param Cls class name to declare for
*/
#define DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(Cls) \
/** @def DECLARE_CLS_NEW_DELETE_NOOP
* Declares the new and delete operations as no-ops (non-existent functions)
* for the given class. Use this macro inside the private section if you want
* to effectively limit creating class instances on the stack only.
*
* @note The destructor of the given class must not be virtual, otherwise a
* compile time error will occur. Note that this is not a drawback: having
* the virtual destructor for a stack-based class is absolutely useless
* (the real class of the stack-based instance is always known to the compiler
* at compile time, so it will always call the correct destructor).
*
* @param Cls class name to declare for
*/
#define DECLARE_CLS_NEW_DELETE_NOOP(Cls) \
#endif /* __cplusplus */
/** @} */
#endif