/** @file * IPRT - Common C and C++ definitions. */ /* * Copyright (C) 2006-2022 Oracle and/or its affiliates. * * This file is part of VirtualBox base platform packages, as * available from https://www.virtualbox.org. * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation, in version 3 of the * License. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, see . * * The contents of this file may alternatively be used under the terms * of the Common Development and Distribution License Version 1.0 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included * in the VirtualBox 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. * * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0 */ #ifndef IPRT_INCLUDED_cdefs_h #define IPRT_INCLUDED_cdefs_h #ifndef RT_WITHOUT_PRAGMA_ONCE # pragma once #endif /** @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 RT_ARCH_SPARC # define RT_ARCH_SPARC64 # define RT_ARCH_ARM32 # define RT_ARCH_ARM64 # define IN_RING0 # define IN_RING3 # 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 RT_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_COMPILER_WITH_128BIT_LONG_DOUBLE # define RT_COMPILER_WITH_128BIT_INT_TYPES # define RT_NO_VISIBILITY_HIDDEN # define RT_GCC_SUPPORTS_VISIBILITY_HIDDEN # define RT_COMPILER_SUPPORTS_VA_ARGS # define RT_COMPILER_SUPPORTS_LAMBDA #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). */ /** @def RT_ARCH_ARM32 * Indicates that we're compiling for the 32-bit ARM architecture, the value * is the version (i.e. 6 for ARMv6). */ /** @def RT_ARCH_ARM64 * Indicates that we're compiling for the 64-bit ARM architecture. */ #if !defined(RT_ARCH_X86) \ && !defined(RT_ARCH_AMD64) \ && !defined(RT_ARCH_SPARC) \ && !defined(RT_ARCH_SPARC64) \ && !defined(RT_ARCH_ARM32) \ && !defined(RT_ARCH_ARM64) # if defined(__amd64__) || defined(__x86_64__) || defined(_M_X64) || defined(__AMD64__) # define RT_ARCH_AMD64 # elif defined(__i386__) || defined(_M_IX86) || defined(__X86__) # define RT_ARCH_X86 # elif defined(__sparcv9) # define RT_ARCH_SPARC64 # elif defined(__sparc__) # define RT_ARCH_SPARC # elif defined(__arm64__) || defined(__aarch64__) # define RT_ARCH_ARM64 __ARM_ARCH # elif defined(__arm__) # define RT_ARCH_ARM32 __ARM_ARCH # elif defined(__arm32__) # define RT_ARCH_ARM32 __ARM_ARCH # else /* PORTME: append test for new archs. */ # error "Check what predefined macros your compiler uses to indicate architecture." # endif /* PORTME: append new archs checks. */ #elif defined(RT_ARCH_X86) && defined(RT_ARCH_AMD64) # error "Both RT_ARCH_X86 and RT_ARCH_AMD64 cannot be defined at the same time!" #elif defined(RT_ARCH_X86) && defined(RT_ARCH_SPARC) # error "Both RT_ARCH_X86 and RT_ARCH_SPARC cannot be defined at the same time!" #elif defined(RT_ARCH_X86) && defined(RT_ARCH_SPARC64) # error "Both RT_ARCH_X86 and RT_ARCH_SPARC64 cannot be defined at the same time!" #elif defined(RT_ARCH_AMD64) && defined(RT_ARCH_SPARC) # error "Both RT_ARCH_AMD64 and RT_ARCH_SPARC cannot be defined at the same time!" #elif defined(RT_ARCH_AMD64) && defined(RT_ARCH_SPARC64) # error "Both RT_ARCH_AMD64 and RT_ARCH_SPARC64 cannot be defined at the same time!" #elif defined(RT_ARCH_SPARC) && defined(RT_ARCH_SPARC64) # error "Both RT_ARCH_SPARC and RT_ARCH_SPARC64 cannot be defined at the same time!" #elif defined(RT_ARCH_ARM32) && defined(RT_ARCH_AMD64) # error "Both RT_ARCH_ARM32 and RT_ARCH_AMD64 cannot be defined at the same time!" #elif defined(RT_ARCH_ARM32) && defined(RT_ARCH_X86) # error "Both RT_ARCH_ARM32 and RT_ARCH_X86 cannot be defined at the same time!" #elif defined(RT_ARCH_ARM32) && defined(RT_ARCH_SPARC64) # error "Both RT_ARCH_ARM32 and RT_ARCH_SPARC64 cannot be defined at the same time!" #elif defined(RT_ARCH_ARM32) && defined(RT_ARCH_SPARC) # error "Both RT_ARCH_ARM32 and RT_ARCH_SPARC cannot be defined at the same time!" #elif defined(RT_ARCH_ARM64) && defined(RT_ARCH_AMD64) # error "Both RT_ARCH_ARM64 and RT_ARCH_AMD64 cannot be defined at the same time!" #elif defined(RT_ARCH_ARM64) && defined(RT_ARCH_X86) # error "Both RT_ARCH_ARM64 and RT_ARCH_X86 cannot be defined at the same time!" #elif defined(RT_ARCH_ARM64) && defined(RT_ARCH_SPARC64) # error "Both RT_ARCH_ARM64 and RT_ARCH_SPARC64 cannot be defined at the same time!" #elif defined(RT_ARCH_ARM64) && defined(RT_ARCH_SPARC) # error "Both RT_ARCH_ARM64 and RT_ARCH_SPARC cannot be defined at the same time!" #elif defined(RT_ARCH_ARM64) && defined(RT_ARCH_ARM32) # error "Both RT_ARCH_ARM64 and RT_ARCH_ARM32 cannot be defined at the same time!" #endif #ifdef RT_ARCH_ARM # error "RT_ARCH_ARM is now RT_ARCH_ARM32!" #endif /* Final check (PORTME). */ #if (defined(RT_ARCH_X86) != 0) \ + (defined(RT_ARCH_AMD64) != 0) \ + (defined(RT_ARCH_SPARC) != 0) \ + (defined(RT_ARCH_SPARC64) != 0) \ + (defined(RT_ARCH_ARM32) != 0) \ + (defined(RT_ARCH_ARM64) != 0) \ != 1 # error "Exactly one RT_ARCH_XXX macro shall be defined" #endif /** @def RT_CPLUSPLUS_PREREQ * Require a minimum __cplusplus value, simplifying dealing with non-C++ code. * * @param a_Min The minimum version, e.g. 201100. */ #ifdef __cplusplus # define RT_CPLUSPLUS_PREREQ(a_Min) (__cplusplus >= (a_Min)) #else # define RT_CPLUSPLUS_PREREQ(a_Min) (0) #endif /** @def RT_GNUC_PREREQ * Shorter than fiddling with __GNUC__ and __GNUC_MINOR__. * * @param a_MinMajor Minimum major version * @param a_MinMinor The minor version number part. */ #define RT_GNUC_PREREQ(a_MinMajor, a_MinMinor) RT_GNUC_PREREQ_EX(a_MinMajor, a_MinMinor, 0) /** @def RT_GNUC_PREREQ_EX * Simplified way of checking __GNUC__ and __GNUC_MINOR__ regardless of actual * compiler used, returns @a a_OtherRet for other compilers. * * @param a_MinMajor Minimum major version * @param a_MinMinor The minor version number part. * @param a_OtherRet What to return for non-GCC compilers. */ #if defined(__GNUC__) && defined(__GNUC_MINOR__) # define RT_GNUC_PREREQ_EX(a_MinMajor, a_MinMinor, a_OtherRet) \ ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((a_MinMajor) << 16) + (a_MinMinor)) #else # define RT_GNUC_PREREQ_EX(a_MinMajor, a_MinMinor, a_OtherRet) (a_OtherRet) #endif /** @def RT_MSC_PREREQ * Convenient way of checking _MSC_VER regardless of actual compiler used * (returns false if not MSC). * * @param a_MinVer Preferably a RT_MSC_VER_XXX value. */ #define RT_MSC_PREREQ(a_MinVer) RT_MSC_PREREQ_EX(a_MinVer, 0) /** @def RT_MSC_PREREQ_EX * Convenient way of checking _MSC_VER regardless of actual compiler used, * returns @a a_OtherRet for other compilers. * * @param a_MinVer Preferably a RT_MSC_VER_XXX value. * @param a_OtherRet What to return for non-MSC compilers. */ #if defined(_MSC_VER) # define RT_MSC_PREREQ_EX(a_MinVer, a_OtherRet) ( (_MSC_VER) >= (a_MinVer) ) #else # define RT_MSC_PREREQ_EX(a_MinVer, a_OtherRet) (a_OtherRet) #endif /** @name RT_MSC_VER_XXX - _MSC_VER values to use with RT_MSC_PREREQ. * @remarks The VCxxx values are derived from the CRT DLLs shipping with the * compilers. * @{ */ #define RT_MSC_VER_VC50 (1100) /**< Visual C++ 5.0. */ #define RT_MSC_VER_VC60 (1200) /**< Visual C++ 6.0. */ #define RT_MSC_VER_VC70 (1300) /**< Visual C++ 7.0. */ #define RT_MSC_VER_VC70 (1300) /**< Visual C++ 7.0. */ #define RT_MSC_VER_VS2003 (1310) /**< Visual Studio 2003, aka Visual C++ 7.1. */ #define RT_MSC_VER_VC71 RT_MSC_VER_VS2003 /**< Visual C++ 7.1, aka Visual Studio 2003. */ #define RT_MSC_VER_VS2005 (1400) /**< Visual Studio 2005. */ #define RT_MSC_VER_VC80 RT_MSC_VER_VS2005 /**< Visual C++ 8.0, aka Visual Studio 2008. */ #define RT_MSC_VER_VS2008 (1500) /**< Visual Studio 2008. */ #define RT_MSC_VER_VC90 RT_MSC_VER_VS2008 /**< Visual C++ 9.0, aka Visual Studio 2008. */ #define RT_MSC_VER_VS2010 (1600) /**< Visual Studio 2010. */ #define RT_MSC_VER_VC100 RT_MSC_VER_VS2010 /**< Visual C++ 10.0, aka Visual Studio 2010. */ #define RT_MSC_VER_VS2012 (1700) /**< Visual Studio 2012. */ #define RT_MSC_VER_VC110 RT_MSC_VER_VS2012 /**< Visual C++ 11.0, aka Visual Studio 2012. */ #define RT_MSC_VER_VS2013 (1800) /**< Visual Studio 2013. */ #define RT_MSC_VER_VC120 RT_MSC_VER_VS2013 /**< Visual C++ 12.0, aka Visual Studio 2013. */ #define RT_MSC_VER_VS2015 (1900) /**< Visual Studio 2015. */ #define RT_MSC_VER_VC140 RT_MSC_VER_VS2015 /**< Visual C++ 14.0, aka Visual Studio 2015. */ #define RT_MSC_VER_VS2017 (1910) /**< Visual Studio 2017. */ #define RT_MSC_VER_VC141 RT_MSC_VER_VS2017 /**< Visual C++ 14.1, aka Visual Studio 2017. */ #define RT_MSC_VER_VS2019 (1920) /**< Visual Studio 2019. */ #define RT_MSC_VER_VC142 RT_MSC_VER_VS2019 /**< Visual C++ 14.2, aka Visual Studio 2019. */ #define RT_MSC_VER_VS2019_U6 (1926) /**< Visual Studio 2019, update 6. */ #define RT_MSC_VER_VC142_U6 RT_MSC_VER_VS2019_U6 /**< Visual C++ 14.2 update 6. */ #define RT_MSC_VER_VS2019_U8 (1928) /**< Visual Studio 2019, update 8. */ #define RT_MSC_VER_VC142_U8 RT_MSC_VER_VS2019_U8 /**< Visual C++ 14.2 update 8. */ #define RT_MSC_VER_VS2019_U11 (1929) /**< Visual Studio 2019, update 11. */ #define RT_MSC_VER_VC142_U11 RT_MSC_VER_VS2019_U11 /**< Visual C++ 14.2 update 11. */ /** @} */ /** @def RT_CLANG_PREREQ * Shorter than fiddling with __clang_major__ and __clang_minor__. * * @param a_MinMajor Minimum major version * @param a_MinMinor The minor version number part. */ #define RT_CLANG_PREREQ(a_MinMajor, a_MinMinor) RT_CLANG_PREREQ_EX(a_MinMajor, a_MinMinor, 0) /** @def RT_CLANG_PREREQ_EX * Simplified way of checking __clang_major__ and __clang_minor__ regardless of * actual compiler used, returns @a a_OtherRet for other compilers. * * @param a_MinMajor Minimum major version * @param a_MinMinor The minor version number part. * @param a_OtherRet What to return for non-GCC compilers. */ #if defined(__clang_major__) && defined(__clang_minor__) # define RT_CLANG_PREREQ_EX(a_MinMajor, a_MinMinor, a_OtherRet) \ ((__clang_major__ << 16) + __clang_minor__ >= ((a_MinMajor) << 16) + (a_MinMinor)) #else # define RT_CLANG_PREREQ_EX(a_MinMajor, a_MinMinor, a_OtherRet) (a_OtherRet) #endif /** @def RT_CLANG_HAS_FEATURE * Wrapper around clang's __has_feature(). * * @param a_Feature The feature to check for. */ #if defined(__clang_major__) && defined(__clang_minor__) && defined(__has_feature) # define RT_CLANG_HAS_FEATURE(a_Feature) (__has_feature(a_Feature)) #else # define RT_CLANG_HAS_FEATURE(a_Feature) (0) #endif #if !defined(__X86__) && !defined(__AMD64__) && (defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)) # if defined(RT_ARCH_AMD64) /** Indicates that we're compiling for the AMD64 architecture. * @deprecated */ # define __AMD64__ # elif defined(RT_ARCH_X86) /** Indicates that we're compiling for the X86 architecture. * @deprecated */ # define __X86__ # else # error "Check what predefined macros your compiler uses to indicate architecture." # endif #elif defined(__X86__) && defined(__AMD64__) # error "Both __X86__ and __AMD64__ cannot be defined at the same time!" #elif defined(__X86__) && !defined(RT_ARCH_X86) # error "__X86__ without RT_ARCH_X86!" #elif defined(__AMD64__) && !defined(RT_ARCH_AMD64) # 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. */ #if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86) || defined(RT_ARCH_ARM32) || defined(RT_ARCH_ARM64) # define RT_LITTLE_ENDIAN #elif defined(RT_ARCH_SPARC) || defined(RT_ARCH_SPARC64) # 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). */ #if !defined(IN_RING3) && !defined(IN_RING0) && !defined(IN_RC) # error "You must define which context the compiled code should run in; IN_RING3, IN_RING0 or IN_RC" #endif #if (defined(IN_RING3) && (defined(IN_RING0) || defined(IN_RC)) ) \ || (defined(IN_RING0) && (defined(IN_RING3) || defined(IN_RC)) ) \ || (defined(IN_RC) && (defined(IN_RING3) || defined(IN_RING0)) ) # 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) || defined(RT_ARCH_ARM64) || defined(DOXYGEN_RUNNING) # define ARCH_BITS 64 # elif !defined(__I86__) || !defined(__WATCOMC__) # define ARCH_BITS 32 # else # define ARCH_BITS 16 # endif #endif /* ARCH_BITS validation (PORTME). */ #if ARCH_BITS == 64 #if defined(RT_ARCH_X86) || defined(RT_ARCH_SPARC) || defined(RT_ARCH_ARM32) # error "ARCH_BITS=64 but non-64-bit RT_ARCH_XXX defined." #endif #if !defined(RT_ARCH_AMD64) && !defined(RT_ARCH_SPARC64) && !defined(RT_ARCH_ARM64) # error "ARCH_BITS=64 but no 64-bit RT_ARCH_XXX defined." #endif #elif ARCH_BITS == 32 #if defined(RT_ARCH_AMD64) || defined(RT_ARCH_SPARC64) || defined(RT_ARCH_ARM64) # error "ARCH_BITS=32 but non-32-bit RT_ARCH_XXX defined." #endif #if !defined(RT_ARCH_X86) && !defined(RT_ARCH_SPARC) && !defined(RT_ARCH_ARM32) # error "ARCH_BITS=32 but no 32-bit RT_ARCH_XXX defined." #endif #elif ARCH_BITS == 16 #if defined(RT_ARCH_AMD64) || defined(RT_ARCH_SPARC) || defined(RT_ARCH_SPARC64) || defined(RT_ARCH_ARM32) || defined(RT_ARCH_ARM64) # error "ARCH_BITS=16 but non-16-bit RT_ARCH_XX defined." #endif #if !defined(RT_ARCH_X86) # error "ARCH_BITS=16 but RT_ARCH_X86 isn't defined." #endif #else # error "Unsupported ARCH_BITS value!" #endif /** @def HC_ARCH_BITS * Defines the host architecture bit count. */ #if !defined(HC_ARCH_BITS) || defined(DOXYGEN_RUNNING) # if !defined(IN_RC) || defined(DOXYGEN_RUNNING) # 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) # if defined(VBOX_WITH_64_BITS_GUESTS) || defined(DOXYGEN_RUNNING) # 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 /** @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 targeting. 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) || defined(DOXYGEN_RUNNING) # 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 # elif defined(RT_OS_DOS) # 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 # elif defined(RT_OS_L4) # 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 # elif defined(RT_OS_NT) # define RT_OPSYS RT_OPSYS_NT # elif defined(RT_OS_OPENBSD) # define RT_OPSYS RT_OPSYS_OPENBSD # elif defined(RT_OS_OS2) # define RT_OPSYS RT_OPSYS_OS2 # elif defined(RT_OS_PLAN9) # define RT_OPSYS RT_OPSYS_PLAN9 # elif defined(RT_OS_QNX) # 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 # elif defined(__FreeBSD__) /*??*/ # define RT_OPSYS RT_OPSYS_FREEBSD # elif defined(__gnu_linux__) # define RT_OPSYS RT_OPSYS_LINUX # elif defined(__NetBSD__) /*??*/ # define RT_OPSYS RT_OPSYS_NETBSD # elif defined(__OpenBSD__) /*??*/ # define RT_OPSYS RT_OPSYS_OPENBSD # elif defined(__OS2__) # define RT_OPSYS RT_OPSYS_OS2 # elif defined(__sun__) || defined(__SunOS__) || defined(__sun) || defined(__SunOS) # define RT_OPSYS RT_OPSYS_SOLARIS # elif defined(_WIN32) || defined(_WIN64) # define RT_OPSYS RT_OPSYS_WINDOWS # elif defined(MSDOS) || defined(_MSDOS) || defined(DOS16RM) /* OW+MSC || MSC || DMC */ # define RT_OPSYS RT_OPSYS_DOS # else # error "Port Me" # endif #endif #if RT_OPSYS < RT_OPSYS_UNKNOWN || RT_OPSYS >= RT_OPSYS_MAX # 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 */ #if defined(RT_OS_UNKNOWN) && RT_OPSYS != RT_OPSYS_UNKNOWN # error RT_OPSYS vs RT_OS_UNKNOWN #endif #if defined(RT_OS_AGNOSTIC) && RT_OPSYS != RT_OPSYS_AGNOSTIC # error RT_OPSYS vs RT_OS_AGNOSTIC #endif #if defined(RT_OS_DARWIN) && RT_OPSYS != RT_OPSYS_DARWIN # error RT_OPSYS vs RT_OS_DARWIN #endif #if defined(RT_OS_DRAGONFLY) && RT_OPSYS != RT_OPSYS_DRAGONFLY # error RT_OPSYS vs RT_OS_DRAGONFLY #endif #if defined(RT_OS_DOS) && RT_OPSYS != RT_OPSYS_DOS # error RT_OPSYS vs RT_OS_DOS #endif #if defined(RT_OS_FREEBSD) && RT_OPSYS != RT_OPSYS_FREEBSD # error RT_OPSYS vs RT_OS_FREEBSD #endif #if defined(RT_OS_HAIKU) && RT_OPSYS != RT_OPSYS_HAIKU # error RT_OPSYS vs RT_OS_HAIKU #endif #if defined(RT_OS_LINUX) && RT_OPSYS != RT_OPSYS_LINUX # error RT_OPSYS vs RT_OS_LINUX #endif #if defined(RT_OS_L4) && RT_OPSYS != RT_OPSYS_L4 # error RT_OPSYS vs RT_OS_L4 #endif #if defined(RT_OS_MINIX) && RT_OPSYS != RT_OPSYS_MINIX # error RT_OPSYS vs RT_OS_MINIX #endif #if defined(RT_OS_NETBSD) && RT_OPSYS != RT_OPSYS_NETBSD # error RT_OPSYS vs RT_OS_NETBSD #endif #if defined(RT_OS_NETWARE) && RT_OPSYS != RT_OPSYS_NETWARE # error RT_OPSYS vs RT_OS_NETWARE #endif #if defined(RT_OS_NT) && RT_OPSYS != RT_OPSYS_NT # error RT_OPSYS vs RT_OS_NT #endif #if defined(RT_OS_OPENBSD) && RT_OPSYS != RT_OPSYS_OPENBSD # error RT_OPSYS vs RT_OS_OPENBSD #endif #if defined(RT_OS_OS2) && RT_OPSYS != RT_OPSYS_OS2 # error RT_OPSYS vs RT_OS_OS2 #endif #if defined(RT_OS_PLAN9) && RT_OPSYS != RT_OPSYS_PLAN9 # error RT_OPSYS vs RT_OS_PLAN9 #endif #if defined(RT_OS_QNX) && RT_OPSYS != RT_OPSYS_QNX # error RT_OPSYS vs RT_OS_QNX #endif #if defined(RT_OS_SOLARIS) && RT_OPSYS != RT_OPSYS_SOLARIS # error RT_OPSYS vs RT_OS_SOLARIS #endif #if defined(RT_OS_UEFI) && RT_OPSYS != RT_OPSYS_UEFI # error RT_OPSYS vs RT_OS_UEFI #endif #if defined(RT_OS_WINDOWS) && RT_OPSYS != RT_OPSYS_WINDOWS # error RT_OPSYS vs RT_OS_WINDOWS #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 #elif RT_OPSYS == RT_OPSYS_AGNOSTIC # ifndef RT_OS_AGNOSTIC # define RT_OS_AGNOSTIC # endif #elif RT_OPSYS == RT_OPSYS_DARWIN # ifndef RT_OS_DARWIN # define RT_OS_DARWIN # endif #elif RT_OPSYS == RT_OPSYS_DRAGONFLY # ifndef RT_OS_DRAGONFLY # define RT_OS_DRAGONFLY # endif #elif RT_OPSYS == RT_OPSYS_DOS # ifndef RT_OS_DOS # define RT_OS_DOS # endif #elif RT_OPSYS == RT_OPSYS_FREEBSD # ifndef RT_OS_FREEBSD # define RT_OS_FREEBSD # endif #elif RT_OPSYS == RT_OPSYS_HAIKU # ifndef RT_OS_HAIKU # define RT_OS_HAIKU # endif #elif RT_OPSYS == RT_OPSYS_LINUX # ifndef RT_OS_LINUX # define RT_OS_LINUX # endif #elif RT_OPSYS == RT_OPSYS_L4 # ifndef RT_OS_L4 # define RT_OS_L4 # endif #elif RT_OPSYS == RT_OPSYS_MINIX # ifndef RT_OS_MINIX # define RT_OS_MINIX # endif #elif RT_OPSYS == RT_OPSYS_NETBSD # ifndef RT_OS_NETBSD # define RT_OS_NETBSD # endif #elif RT_OPSYS == RT_OPSYS_NETWARE # ifndef RT_OS_NETWARE # define RT_OS_NETWARE # endif #elif RT_OPSYS == RT_OPSYS_NT # ifndef RT_OS_NT # define RT_OS_NT # endif #elif RT_OPSYS == RT_OPSYS_OPENBSD # ifndef RT_OS_OPENBSD # define RT_OS_OPENBSD # endif #elif RT_OPSYS == RT_OPSYS_OS2 # ifndef RT_OS_OS2 # define RT_OS_OS2 # endif #elif RT_OPSYS == RT_OPSYS_PLAN9 # ifndef RT_OS_PLAN9 # define RT_OS_PLAN9 # endif #elif RT_OPSYS == RT_OPSYS_QNX # ifndef RT_OS_QNX # define RT_OS_QNX # endif #elif RT_OPSYS == RT_OPSYS_SOLARIS # ifndef RT_OS_SOLARIS # define RT_OS_SOLARIS # endif #elif RT_OPSYS == RT_OPSYS_UEFI # ifndef RT_OS_UEFI # define RT_OS_UEFI # endif #elif RT_OPSYS == RT_OPSYS_WINDOWS # 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 a_GCType The GC type. * @param a_R3Type The R3 type. * @param a_R0Type The R0 type. * @remark For pointers used only in one context use RCPTRTYPE(), R3R0PTRTYPE(), R3PTRTYPE() or R0PTRTYPE(). */ #if defined(IN_RC) && !defined(DOXYGEN_RUNNING) # define CTXTYPE(a_GCType, a_R3Type, a_R0Type) a_GCType #elif defined(IN_RING3) || defined(DOXYGEN_RUNNING) # define CTXTYPE(a_GCType, a_R3Type, a_R0Type) a_R3Type #else # define CTXTYPE(a_GCType, a_R3Type, a_R0Type) a_R0Type #endif /** @def CTX_EXPR * Expression selector for avoiding \#ifdef's. * * @param a_R3Expr The R3 expression. * @param a_R0Expr The R0 expression. * @param a_RCExpr The RC expression. */ #if defined(IN_RC) && !defined(DOXYGEN_RUNNING) # define CTX_EXPR(a_R3Expr, a_R0Expr, a_RCExpr) a_RCExpr #elif defined(IN_RING0) && !defined(DOXYGEN_RUNNING) # define CTX_EXPR(a_R3Expr, a_R0Expr, a_RCExpr) a_R0Expr #else # define CTX_EXPR(a_R3Expr, a_R0Expr, a_RCExpr) a_R3Expr #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 a_RCType The RC type. */ #define RCPTRTYPE(a_RCType) CTXTYPE(a_RCType, RTRCPTR, RTRCPTR) /** @def RGPTRTYPE * This will become RCPTRTYPE once we've converted all uses of RCPTRTYPE to this. * * @param a_RCType The RC type. */ #define RGPTRTYPE(a_RCType) CTXTYPE(a_RCType, RTGCPTR, RTGCPTR) /** @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 a_R3R0Type The R3R0 type. * @remarks This used to be called HCPTRTYPE. */ #define R3R0PTRTYPE(a_R3R0Type) CTXTYPE(RTHCPTR, a_R3R0Type, a_R3R0Type) /** @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 a_R3Type The R3 type. */ #define R3PTRTYPE(a_R3Type) CTXTYPE(RTHCUINTPTR, a_R3Type, RTHCUINTPTR) /** @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 a_R0Type The R0 type. */ #define R0PTRTYPE(a_R0Type) CTXTYPE(RTHCUINTPTR, RTHCUINTPTR, a_R0Type) /** @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 a_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 a_Var Identifier name. * @deprecated Use CTX_SUFF. Do NOT use this for new code. */ #if defined(IN_RC) && !defined(DOXYGEN_RUNNING) # define CTXSUFF(a_Var) a_Var##GC # define OTHERCTXSUFF(a_Var) a_Var##HC #else # define CTXSUFF(a_Var) a_Var##HC # define OTHERCTXSUFF(a_Var) a_Var##GC #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 a_Var Identifier name. * @deprecated Use CTX_SUFF. Do NOT use this for new code. */ #if defined(IN_RC) && !defined(DOXYGEN_RUNNING) # define CTXALLSUFF(a_Var) a_Var##GC #elif defined(IN_RING0) && !defined(DOXYGEN_RUNNING) # define CTXALLSUFF(a_Var) a_Var##R0 #else # define CTXALLSUFF(a_Var) a_Var##R3 #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 a_Var Identifier name. * * @remark This will replace CTXALLSUFF and CTXSUFF before long. */ #if defined(IN_RC) && !defined(DOXYGEN_RUNNING) # define CTX_SUFF(a_Var) a_Var##RC #elif defined(IN_RING0) && !defined(DOXYGEN_RUNNING) # define CTX_SUFF(a_Var) a_Var##R0 #else # define CTX_SUFF(a_Var) a_Var##R3 #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 a_Var Identifier name. * * @remark This will replace CTXALLSUFF and CTXSUFF before long. */ #if defined(IN_RING3) || defined(DOXYGEN_RUNNING) # define CTX_SUFF_Z(a_Var) a_Var##R3 #else # define CTX_SUFF_Z(a_Var) a_Var##RZ #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 a_First First name. * @param a_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 a_First First name. * @param a_Last Surname. * @deprecated use CTX_MID or CTX_MID_Z */ #if defined(IN_RC) && !defined(DOXYGEN_RUNNING) # define CTXMID(a_First, a_Last) a_First##GC##a_Last # define OTHERCTXMID(a_First, a_Last) a_First##HC##a_Last #else # define CTXMID(a_First, a_Last) a_First##HC##a_Last # define OTHERCTXMID(a_First, a_Last) a_First##GC##a_Last #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 a_First First name. * @param a_Last Surname. * @deprecated use CTX_MID or CTX_MID_Z */ #if defined(IN_RC) && !defined(DOXYGEN_RUNNING) # define CTXALLMID(a_First, a_Last) a_First##GC##a_Last #elif defined(IN_RING0) && !defined(DOXYGEN_RUNNING) # define CTXALLMID(a_First, a_Last) a_First##R0##a_Last #else # define CTXALLMID(a_First, a_Last) a_First##R3##a_Last #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 a_First First name. * @param a_Last Surname. */ #if defined(IN_RC) && !defined(DOXYGEN_RUNNING) # define CTX_MID(a_First, a_Last) a_First##RC##a_Last #elif defined(IN_RING0) && !defined(DOXYGEN_RUNNING) # define CTX_MID(a_First, a_Last) a_First##R0##a_Last #else # define CTX_MID(a_First, a_Last) a_First##R3##a_Last #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 a_First First name. * @param a_Last Surname. */ #ifdef IN_RING3 # define CTX_MID_Z(a_First, a_Last) a_First##R3##a_Last #else # define CTX_MID_Z(a_First, a_Last) a_First##RZ##a_Last #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 * between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING3 mess. * * @param a_pR3String The R3 string. Only referenced in R3. * @see R0STRING and GCSTRING */ #ifdef IN_RING3 # define R3STRING(a_pR3String) (a_pR3String) #else # define R3STRING(a_pR3String) ("") #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 * between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING0 mess. * * @param a_pR0String The R0 string. Only referenced in R0. * @see R3STRING and GCSTRING */ #ifdef IN_RING0 # define R0STRING(a_pR0String) (a_pR0String) #else # define R0STRING(a_pR0String) ("") #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 * between R3, R0 and/or RC. The intention is to avoid the \#ifdef IN_RC mess. * * @param a_pRCString The RC string. Only referenced in RC. * @see R3STRING, R0STRING */ #ifdef IN_RC # define RCSTRING(a_pRCString) (a_pRCString) #else # define RCSTRING(a_pRCString) ("") #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_GCC_NO_WARN_DEPRECATED_BEGIN * Used to start a block of code where GCC and Clang should not warn about * deprecated declarations. */ /** @def RT_GCC_NO_WARN_DEPRECATED_END * Used to end a block of code where GCC and Clang should not warn about * deprecated declarations. */ #if RT_CLANG_PREREQ(4, 0) # define RT_GCC_NO_WARN_DEPRECATED_BEGIN \ _Pragma("clang diagnostic push") \ _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") # define RT_GCC_NO_WARN_DEPRECATED_END \ _Pragma("clang diagnostic pop") #elif RT_GNUC_PREREQ(4, 6) # define RT_GCC_NO_WARN_DEPRECATED_BEGIN \ _Pragma("GCC diagnostic push") \ _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") # define RT_GCC_NO_WARN_DEPRECATED_END \ _Pragma("GCC diagnostic pop") #else # define RT_GCC_NO_WARN_DEPRECATED_BEGIN # define RT_GCC_NO_WARN_DEPRECATED_END #endif /** @def RT_GCC_NO_WARN_CONVERSION_BEGIN * Used to start a block of code where GCC should not warn about implicit * conversions that may alter a value. */ #if RT_GNUC_PREREQ(4, 6) # define RT_GCC_NO_WARN_CONVERSION_BEGIN \ _Pragma("GCC diagnostic push") \ _Pragma("GCC diagnostic ignored \"-Wconversion\"") /** @def RT_GCC_NO_WARN_CONVERSION_END * Used to end a block of code where GCC should not warn about implicit * conversions that may alter a value. */ # define RT_GCC_NO_WARN_CONVERSION_END \ _Pragma("GCC diagnostic pop") #else # define RT_GCC_NO_WARN_CONVERSION_BEGIN # define RT_GCC_NO_WARN_CONVERSION_END #endif /** @def RT_COMPILER_GROKS_64BIT_BITFIELDS * Macro that is defined if the compiler understands 64-bit bitfields. */ #if !defined(RT_OS_OS2) || (!defined(__IBMC__) && !defined(__IBMCPP__)) # if !defined(__WATCOMC__) /* watcom compiler doesn't grok it either. */ # define RT_COMPILER_GROKS_64BIT_BITFIELDS # endif #endif /** @def RT_COMPILER_LONG_DOUBLE_BITS * Number of relevant bits in the long double type: 64, 80 or 128 */ /** @def RT_COMPILER_WITH_64BIT_LONG_DOUBLE * Macro that is defined if the compiler implements long double as the * IEEE precision floating. */ /** @def RT_COMPILER_WITH_80BIT_LONG_DOUBLE * Macro that is defined if the compiler implements long double as the * IEEE extended precision floating. */ /** @def RT_COMPILER_WITH_128BIT_LONG_DOUBLE * Macro that is defined if the compiler implements long double as the * IEEE quadruple precision floating (128-bit). * @note Currently not able to detect this, so must be explicitly defined. */ #if defined(__LDBL_MANT_DIG__) /* GCC & clang have this defined and should be more reliable. */ # if __LDBL_MANT_DIG__ == 53 # define RT_COMPILER_LONG_DOUBLE_BITS 64 # define RT_COMPILER_WITH_64BIT_LONG_DOUBLE # undef RT_COMPILER_WITH_80BIT_LONG_DOUBLE # undef RT_COMPILER_WITH_128BIT_LONG_DOUBLE # elif __LDBL_MANT_DIG__ == 64 # define RT_COMPILER_LONG_DOUBLE_BITS 80 # undef RT_COMPILER_WITH_64BIT_LONG_DOUBLE # define RT_COMPILER_WITH_80BIT_LONG_DOUBLE # undef RT_COMPILER_WITH_128BIT_LONG_DOUBLE # elif __LDBL_MANT_DIG__ == 113 # define RT_COMPILER_LONG_DOUBLE_BITS 128 # undef RT_COMPILER_WITH_64BIT_LONG_DOUBLE # undef RT_COMPILER_WITH_80BIT_LONG_DOUBLE # define RT_COMPILER_WITH_128BIT_LONG_DOUBLE # else # error "Port me!" # endif #elif defined(RT_OS_WINDOWS) || defined(RT_ARCH_ARM64) || defined(RT_ARCH_ARM32) /* the M1 arm64 at least */ # define RT_COMPILER_LONG_DOUBLE_BITS 64 # define RT_COMPILER_WITH_64BIT_LONG_DOUBLE # undef RT_COMPILER_WITH_80BIT_LONG_DOUBLE # undef RT_COMPILER_WITH_128BIT_LONG_DOUBLE #elif defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86) # define RT_COMPILER_LONG_DOUBLE_BITS 80 # undef RT_COMPILER_WITH_64BIT_LONG_DOUBLE # define RT_COMPILER_WITH_80BIT_LONG_DOUBLE # undef RT_COMPILER_WITH_128BIT_LONG_DOUBLE #elif defined(RT_ARCH_SPARC) || defined(RT_ARCH_SPARC64) # define RT_COMPILER_LONG_DOUBLE_BITS 128 # undef RT_COMPILER_WITH_64BIT_LONG_DOUBLE # undef RT_COMPILER_WITH_80BIT_LONG_DOUBLE # define RT_COMPILER_WITH_128BIT_LONG_DOUBLE #else # error "Port me!" #endif /** @def RT_COMPILER_WITH_128BIT_INT_TYPES * Defined when uint128_t and int128_t are native integer types. If * undefined, they are structure with Hi & Lo members. */ #if defined(__SIZEOF_INT128__) || (defined(__GNUC__) && (defined(RT_ARCH_AMD64) || defined(RT_ARCH_ARM64))) # define RT_COMPILER_WITH_128BIT_INT_TYPES #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 DECL_NOTHROW * How to declare a function which does not throw C++ exceptions. * * @param a_Type The return type. * * @note This macro can be combined with other macros, for example * @code * RTR3DECL(DECL_NOTHROW(void)) foo(void); * @endcode * * @note GCC is currently restricted to 4.2+ given the ominous comments on * RT_NOTHROW_PROTO. */ #ifdef __cplusplus # if RT_MSC_PREREQ(RT_MSC_VER_VS2015) /*?*/ # define DECL_NOTHROW(a_Type) __declspec(nothrow) a_Type # elif RT_CLANG_PREREQ(6,0) || RT_GNUC_PREREQ(4,2) # define DECL_NOTHROW(a_Type) __attribute__((__nothrow__)) a_Type # else # define DECL_NOTHROW(a_Type) a_Type # endif #else # define DECL_NOTHROW(a_Type) a_Type #endif /** @def RT_NOTHROW_PROTO * Function does not throw any C++ exceptions, prototype edition. * * 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 and generate * unwind info. Put this between the closing parenthesis and the semicolon in * function prototypes (and implementation if C++). * * @note This translates to 'noexcept' when compiling in newer C++ mode. * * @remarks The use of the nothrow attribute with GCC is because old compilers * (4.1.1, 32-bit) leaking the nothrow into global space or something * when used with RTDECL or similar. Using this forces us to have two * macros, as the nothrow attribute is not for the function definition. */ /** @def RT_NOTHROW_DEF * Function does not throw any C++ exceptions, definition edition. * * The counter part to RT_NOTHROW_PROTO that is added to the function * definition. */ #ifdef RT_EXCEPTIONS_ENABLED # if RT_MSC_PREREQ_EX(RT_MSC_VER_VS2015, 0) \ || RT_CLANG_HAS_FEATURE(cxx_noexcept) \ || (RT_GNUC_PREREQ(7, 0) && __cplusplus >= 201100) # define RT_NOTHROW_PROTO noexcept # define RT_NOTHROW_DEF noexcept # elif defined(__GNUC__) # if RT_GNUC_PREREQ(3, 3) # define RT_NOTHROW_PROTO __attribute__((__nothrow__)) # else # define RT_NOTHROW_PROTO # endif # define RT_NOTHROW_DEF /* Would need a DECL_NO_THROW like __declspec(nothrow), which we wont do at this point. */ # else # define RT_NOTHROW_PROTO throw() # define RT_NOTHROW_DEF throw() # endif #else # define RT_NOTHROW_PROTO # define RT_NOTHROW_DEF #endif /** @def RT_NOTHROW_PROTO * @deprecated Use RT_NOTHROW_PROTO. */ #define RT_NO_THROW_PROTO RT_NOTHROW_PROTO /** @def RT_NOTHROW_DEF * @deprecated Use RT_NOTHROW_DEF. */ #define RT_NO_THROW_DEF RT_NOTHROW_DEF /** @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 a_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 # if (__cplusplus + 0) >= 201700 # define RT_THROW(a_Type) noexcept(false) # elif RT_MSC_PREREQ_EX(RT_MSC_VER_VC71, 0) # define RT_THROW(a_Type) # elif RT_GNUC_PREREQ(7, 0) # define RT_THROW(a_Type) # else # define RT_THROW(a_Type) throw(a_Type) # endif #else # define RT_THROW(a_Type) #endif /** @def RT_OVERRIDE * Wrapper for the C++11 override keyword. * * @remarks Recognized by g++ starting 4.7, however causes pedantic warnings * when used without officially enabling the C++11 features. */ #ifdef __cplusplus # if RT_MSC_PREREQ_EX(RT_MSC_VER_VS2012, 0) # define RT_OVERRIDE override # elif RT_GNUC_PREREQ(4, 7) # if __cplusplus >= 201100 # define RT_OVERRIDE override # else # define RT_OVERRIDE # endif # else # define RT_OVERRIDE # endif #else # define RT_OVERRIDE #endif /** @def RT_NOEXCEPT * Wrapper for the C++11 noexcept keyword (only true form). * @note use RT_NOTHROW instead. */ /** @def RT_NOEXCEPT_EX * Wrapper for the C++11 noexcept keyword with expression. * @param a_Expr The expression. */ #ifdef __cplusplus # if (RT_MSC_PREREQ_EX(RT_MSC_VER_VS2015, 0) && defined(RT_EXCEPTIONS_ENABLED)) \ || RT_CLANG_HAS_FEATURE(cxx_noexcept) \ || (RT_GNUC_PREREQ(7, 0) && __cplusplus >= 201100) # define RT_NOEXCEPT noexcept # define RT_NOEXCEPT_EX(a_Expr) noexcept(a_Expr) # else # define RT_NOEXCEPT # define RT_NOEXCEPT_EX(a_Expr) # endif #else # define RT_NOEXCEPT # define RT_NOEXCEPT_EX(a_Expr) #endif /** @def RT_ALIGNAS_VAR * Wrapper for the C++ alignas keyword when used on variables. * * This must be put before the storage class and type. * * @param a_cbAlign The alignment. Must be power of two. * @note If C++11 is not enabled/detectable, alternatives will be used where * available. */ /** @def RT_ALIGNAS_TYPE * Wrapper for the C++ alignas keyword when used on types. * * When using struct, this must follow the struct keyword. * * @param a_cbAlign The alignment. Must be power of two. * @note If C++11 is not enabled/detectable, alternatives will be used where * available. */ /** @def RT_ALIGNAS_MEMB * Wrapper for the C++ alignas keyword when used on structure members. * * This must be put before the variable type. * * @param a_cbAlign The alignment. Must be power of two. * @note If C++11 is not enabled/detectable, alternatives will be used where * available. */ #ifdef __cplusplus # if __cplusplus >= 201100 || defined(DOXYGEN_RUNNING) # define RT_ALIGNAS_VAR(a_cbAlign) alignas(a_cbAlign) # define RT_ALIGNAS_TYPE(a_cbAlign) alignas(a_cbAlign) # define RT_ALIGNAS_MEMB(a_cbAlign) alignas(a_cbAlign) # endif #endif #ifndef RT_ALIGNAS_VAR # ifdef _MSC_VER # define RT_ALIGNAS_VAR(a_cbAlign) __declspec(align(a_cbAlign)) # define RT_ALIGNAS_TYPE(a_cbAlign) __declspec(align(a_cbAlign)) # define RT_ALIGNAS_MEMB(a_cbAlign) __declspec(align(a_cbAlign)) # elif defined(__GNUC__) # define RT_ALIGNAS_VAR(a_cbAlign) __attribute__((__aligned__(a_cbAlign))) # define RT_ALIGNAS_TYPE(a_cbAlign) __attribute__((__aligned__(a_cbAlign))) # define RT_ALIGNAS_MEMB(a_cbAlign) __attribute__((__aligned__(a_cbAlign))) # else # define RT_ALIGNAS_VAR(a_cbAlign) # define RT_ALIGNAS_TYPE(a_cbAlign) # define RT_ALIGNAS_MEMB(a_cbAlign) # endif #endif /** @def RT_CACHELINE_SIZE * The typical cache line size for the target architecture. * @see RT_ALIGNAS_VAR, RT_ALIGNAS_TYPE, RT_ALIGNAS_MEMB */ #if defined(RT_ARCH_X86) || defined(RT_ARCH_AMD64) \ || defined(RT_ARCH_ARM32) || defined(RT_ARCH_ARM64) \ || defined(RT_ARCH_SPARC32) || defined(RT_ARCH_SPARC64) \ || defined(DOXYGEN_RUNNING) # define RT_CACHELINE_SIZE 64 #else # define RT_CACHELINE_SIZE 128 /* better overdo it */ #endif /** @def RT_FALL_THROUGH * Tell the compiler that we're falling through to the next case in a switch. * @sa RT_FALL_THRU */ #if RT_CLANG_PREREQ(4, 0) && RT_CPLUSPLUS_PREREQ(201100) # define RT_FALL_THROUGH() [[clang::fallthrough]] #elif RT_CLANG_PREREQ(12, 0) || RT_GNUC_PREREQ(7, 0) # define RT_FALL_THROUGH() __attribute__((__fallthrough__)) #else # define RT_FALL_THROUGH() (void)0 #endif /** @def RT_FALL_THRU * Tell the compiler that we're falling thru to the next case in a switch. * @sa RT_FALL_THROUGH */ #define RT_FALL_THRU() RT_FALL_THROUGH() /** @def RT_IPRT_FORMAT_ATTR * Identifies a function taking an IPRT format string. * @param a_iFmt The index (1-based) of the format string argument. * @param a_iArgs The index (1-based) of the first format argument, use 0 for * va_list. */ #if defined(__GNUC__) && defined(WITH_IPRT_FORMAT_ATTRIBUTE) # define RT_IPRT_FORMAT_ATTR(a_iFmt, a_iArgs) __attribute__((__iprt_format__(a_iFmt, a_iArgs))) #else # define RT_IPRT_FORMAT_ATTR(a_iFmt, a_iArgs) #endif /** @def RT_IPRT_FORMAT_ATTR_MAYBE_NULL * Identifies a function taking an IPRT format string, NULL is allowed. * @param a_iFmt The index (1-based) of the format string argument. * @param a_iArgs The index (1-based) of the first format argument, use 0 for * va_list. */ #if defined(__GNUC__) && defined(WITH_IPRT_FORMAT_ATTRIBUTE) # define RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a_iFmt, a_iArgs) __attribute__((__iprt_format_maybe_null__(a_iFmt, a_iArgs))) #else # define RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a_iFmt, a_iArgs) #endif /** @def RT_GCC_SUPPORTS_VISIBILITY_HIDDEN * Indicates that the "hidden" visibility attribute can be used (GCC) */ #if defined(__GNUC__) # if __GNUC__ >= 4 && !defined(RT_OS_OS2) && !defined(RT_OS_WINDOWS) # define RT_GCC_SUPPORTS_VISIBILITY_HIDDEN # endif #endif /** @def RT_COMPILER_SUPPORTS_VA_ARGS * If the defined, the compiler supports the variadic macro feature (..., __VA_ARGS__). */ #if defined(_MSC_VER) # if _MSC_VER >= 1600 /* Visual C++ v10.0 / 2010 */ # define RT_COMPILER_SUPPORTS_VA_ARGS # endif #elif defined(__GNUC__) # if __GNUC__ >= 3 /* not entirely sure when this was added */ # define RT_COMPILER_SUPPORTS_VA_ARGS # endif #elif defined(__WATCOMC__) # define RT_COMPILER_SUPPORTS_VA_ARGS #endif /** @def RT_CB_LOG_CAST * Helper for logging function pointers to function may throw stuff. * * Not needed for function pointer types declared using our DECLCALLBACK * macros, only external types. */ #if defined(_MSC_VER) && defined(RT_EXCEPTIONS_ENABLED) # define RT_CB_LOG_CAST(a_pfnCallback) ((uintptr_t)(a_pfnCallback) + 1 - 1) #else # define RT_CB_LOG_CAST(a_pfnCallback) (a_pfnCallback) #endif /** @def RTCALL * The standard calling convention for the Runtime interfaces. * * @remarks The regparm(0) in the X86/GNUC variant deals with -mregparm=x use in * the linux kernel and potentially elsewhere (3rd party). */ #if defined(_MSC_VER) || defined(__WATCOMC__) # define RTCALL __cdecl #elif defined(RT_OS_OS2) # define RTCALL __cdecl #elif defined(__GNUC__) && defined(RT_ARCH_X86) # define RTCALL __attribute__((__cdecl__,__regparm__(0))) #else # define RTCALL #endif /** @def DECLEXPORT * How to declare an exported function. * @param a_RetType The return type of the function declaration. */ #if defined(_MSC_VER) || defined(RT_OS_OS2) # define DECLEXPORT(a_RetType) __declspec(dllexport) a_RetType #elif defined(RT_USE_VISIBILITY_DEFAULT) # define DECLEXPORT(a_RetType) __attribute__((visibility("default"))) a_RetType #else # define DECLEXPORT(a_RetType) a_RetType #endif /** @def DECL_EXPORT_NOTHROW * How to declare an exported function that does not throw C++ exceptions. * @param a_RetType The return type of the function declaration. */ #define DECL_EXPORT_NOTHROW(a_RetType) DECL_NOTHROW(DECLEXPORT(a_RetType)) /** @def DECLIMPORT * How to declare an imported function. * @param a_RetType The return type of the function declaration. */ #if defined(_MSC_VER) || (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__)) # define DECLIMPORT(a_RetType) __declspec(dllimport) a_RetType #else # define DECLIMPORT(a_RetType) a_RetType #endif /** @def DECL_IMPORT_NOTHROW * How to declare an imported function that does not throw C++ exceptions. * @param a_RetType The return type of the function declaration. */ #define DECL_IMPORT_NOTHROW(a_RetType) DECL_NOTHROW(DECLIMPORT(a_RetType)) /** @def DECL_HIDDEN_ONLY * How to declare a non-exported function or variable. * @param a_Type The return type of the function or the data type of the variable. * @sa DECL_HIDDEN, DECL_HIDDEN_DATA, DECL_HIDDEN_CONST * @internal Considered more or less internal. */ #if !defined(RT_GCC_SUPPORTS_VISIBILITY_HIDDEN) || defined(RT_NO_VISIBILITY_HIDDEN) # define DECL_HIDDEN_ONLY(a_Type) a_Type #else # define DECL_HIDDEN_ONLY(a_Type) __attribute__((visibility("hidden"))) a_Type #endif /** @def DECLHIDDEN * How to declare a non-exported function or variable. * @param a_Type The return type of the function or the data type of the variable. * @sa DECL_HIDDEN_THROW, DECL_HIDDEN_DATA, DECL_HIDDEN_CONST * @todo split up into data and non-data. */ #define DECLHIDDEN(a_Type) DECL_NOTHROW(DECL_HIDDEN_ONLY(a_Type)) /** @def DECL_HIDDEN_NOTHROW * How to declare a non-exported function that does not throw C++ exceptions. * @param a_RetType The return type of the function. * @note Same as DECLHIDDEN but provided to go along with DECL_IMPORT_NOTHROW * and DECL_EXPORT_NOTHROW. */ #define DECL_HIDDEN_NOTHROW(a_RetType) DECL_NOTHROW(DECL_HIDDEN_ONLY(a_RetType)) /** @def DECL_HIDDEN_THROW * How to declare a non-exported function that may throw C++ exceptions. * @param a_RetType The return type of the function. */ #define DECL_HIDDEN_THROW(a_RetType) DECL_HIDDEN_ONLY(a_Type) /** @def DECL_HIDDEN_DATA * How to declare a non-exported variable. * @param a_Type The data type of the variable. * @sa DECL_HIDDEN_CONST */ #if !defined(RT_GCC_SUPPORTS_VISIBILITY_HIDDEN) || defined(RT_NO_VISIBILITY_HIDDEN) # define DECL_HIDDEN_DATA(a_Type) a_Type #else # define DECL_HIDDEN_DATA(a_Type) __attribute__((visibility("hidden"))) a_Type #endif /** @def DECL_HIDDEN_CONST * Workaround for g++ warnings when applying the hidden attribute to a const * definition. Use DECL_HIDDEN_DATA for the declaration. * @param a_Type The data type of the variable. * @sa DECL_HIDDEN_DATA */ #if defined(__cplusplus) && defined(__GNUC__) # define DECL_HIDDEN_CONST(a_Type) a_Type #else # define DECL_HIDDEN_CONST(a_Type) DECL_HIDDEN_DATA(a_Type) #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 a_RetType The return type of the function. */ #if defined(_MSC_VER) # define DECL_INVALID(a_RetType) __declspec(dllimport) a_RetType __stdcall #elif defined(__GNUC__) && defined(__cplusplus) # define DECL_INVALID(a_RetType) extern "C++" a_RetType #else # define DECL_INVALID(a_RetType) a_RetType #endif /** @def DECLASM * How to declare an internal assembly function. * @param a_RetType The return type of the function declaration. * @note DECL_NOTHROW is implied. */ #ifdef __cplusplus # define DECLASM(a_RetType) extern "C" DECL_NOTHROW(a_RetType RTCALL) #else # define DECLASM(a_RetType) DECL_NOTHROW(a_RetType RTCALL) #endif /** @def RT_ASM_DECL_PRAGMA_WATCOM * How to declare a assembly method prototype with watcom \#pragma aux definition. */ /** @def RT_ASM_DECL_PRAGMA_WATCOM_386 * Same as RT_ASM_DECL_PRAGMA_WATCOM, but there is no 16-bit version when * 8086, 80186 or 80286 is selected as the target CPU. */ #if defined(__WATCOMC__) && ARCH_BITS == 16 && defined(RT_ARCH_X86) # define RT_ASM_DECL_PRAGMA_WATCOM(a_RetType) a_RetType # if defined(__SW_0) || defined(__SW_1) || defined(__SW_2) # define RT_ASM_DECL_PRAGMA_WATCOM_386(a_RetType) DECLASM(a_RetType) # else # define RT_ASM_DECL_PRAGMA_WATCOM_386(a_RetType) a_RetType # endif #elif defined(__WATCOMC__) && ARCH_BITS == 32 && defined(RT_ARCH_X86) # define RT_ASM_DECL_PRAGMA_WATCOM(a_RetType) a_RetType # define RT_ASM_DECL_PRAGMA_WATCOM_386(a_RetType) a_RetType #else # define RT_ASM_DECL_PRAGMA_WATCOM(a_RetType) DECLASM(a_RetType) # define RT_ASM_DECL_PRAGMA_WATCOM_386(a_RetType) DECLASM(a_RetType) #endif /** @def DECL_NO_RETURN * How to declare a function which does not return. * @note This macro can be combined with other macros, for example * @code * RTR3DECL(DECL_NO_RETURN(void)) foo(void); * @endcode */ #ifdef _MSC_VER # define DECL_NO_RETURN(a_RetType) __declspec(noreturn) a_RetType #elif defined(__GNUC__) # define DECL_NO_RETURN(a_RetType) __attribute__((noreturn)) a_RetType #else # define DECL_NO_RETURN(a_RetType) a_RetType #endif /** @def DECL_RETURNS_TWICE * How to declare a function which may return more than once. * @note This macro can be combined with other macros, for example * @code * RTR3DECL(DECL_RETURNS_TWICE(void)) MySetJmp(void); * @endcode */ #if RT_GNUC_PREREQ(4, 1) # define DECL_RETURNS_TWICE(a_RetType) __attribute__((returns_twice)) a_RetType #else # define DECL_RETURNS_TWICE(a_RetType) a_RetType #endif /** @def DECL_CHECK_RETURN * Require a return value to be checked. * @note This macro can be combined with other macros, for example * @code * RTR3DECL(DECL_CHECK_RETURN(int)) MayReturnInfoStatus(void); * @endcode */ #if RT_GNUC_PREREQ(3, 4) # define DECL_CHECK_RETURN(a_RetType) __attribute__((warn_unused_result)) a_RetType #elif defined(_MSC_VER) # define DECL_CHECK_RETURN(a_RetType) __declspec("SAL_checkReturn") a_RetType #else # define DECL_CHECK_RETURN(a_RetType) a_RetType #endif /** @def DECL_CHECK_RETURN_NOT_R3 * Variation of DECL_CHECK_RETURN that only applies the required to non-ring-3 * code. */ #ifndef IN_RING3 # define DECL_CHECK_RETURN_NOT_R3(a_RetType) DECL_CHECK_RETURN(a_RetType) #else # define DECL_CHECK_RETURN_NOT_R3(a_RetType) a_RetType #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 * RTR3DECL(DECLWEAK(int)) foo; * @endcode */ #if defined(__GNUC__) # define DECLWEAK(a_Type) a_Type __attribute__((weak)) #else # define DECLWEAK(a_Type) a_Type #endif /** @def DECLCALLBACK * How to declare an call back function. * @param a_RetType The return type of the function declaration. * @note DECL_NOTHROW is implied. * @note Use DECLCALLBACKTYPE for typedefs. */ #define DECLCALLBACK(a_RetType) DECL_NOTHROW(a_RetType RT_FAR_CODE RTCALL) /** @def DECL_HIDDEN_CALLBACK * How to declare an call back function with hidden visibility. * @param a_RetType The return type of the function declaration. * @note DECL_NOTHROW is implied. * @note Use DECLCALLBACKTYPE for typedefs. */ #define DECL_HIDDEN_CALLBACK(a_RetType) DECL_HIDDEN_ONLY(DECLCALLBACK(a_RetType)) /** @def DECLCALLBACKTYPE_EX * How to declare an call back function type. * @param a_RetType The return type of the function declaration. * @param a_CallConv Calling convention. * @param a_Name The name of the typedef * @param a_Args The argument list enclosed in parentheses. * @note DECL_NOTHROW is implied, but not supported by all compilers yet. */ #if RT_CLANG_PREREQ(6,0) && !defined(RT_RELAXED_CALLBACKS_TYPES) # define DECLCALLBACKTYPE_EX(a_RetType, a_CallConv, a_Name, a_Args) __attribute__((__nothrow__)) a_RetType a_CallConv a_Name a_Args #elif RT_MSC_PREREQ(RT_MSC_VER_VS2015) /*?*/ && defined(__cplusplus) && defined(_MSC_EXTENSIONS) && !defined(RT_RELAXED_CALLBACKS_TYPES) # define DECLCALLBACKTYPE_EX(a_RetType, a_CallConv, a_Name, a_Args) a_RetType a_CallConv a_Name a_Args throw() #else # define DECLCALLBACKTYPE_EX(a_RetType, a_CallConv, a_Name, a_Args) a_RetType a_CallConv a_Name a_Args #endif /** @def DECLCALLBACKTYPE * How to declare an call back function type. * @param a_RetType The return type of the function declaration. * @param a_Name The name of the typedef * @param a_Args The argument list enclosed in parentheses. * @note DECL_NOTHROW is implied, but not supported by all compilers yet. */ #define DECLCALLBACKTYPE(a_RetType, a_Name, a_Args) DECLCALLBACKTYPE_EX(a_RetType, RT_FAR_CODE RTCALL, a_Name, a_Args) /** @def DECLCALLBACKPTR_EX * How to declare an call back function pointer. * @param a_RetType The return type of the function declaration. * @param a_CallConv Calling convention. * @param a_Name The name of the variable member. * @param a_Args The argument list enclosed in parentheses. * @note DECL_NOTHROW is implied, but not supported by all compilers yet. */ #if defined(__IBMC__) || defined(__IBMCPP__) # define DECLCALLBACKPTR_EX(a_RetType, a_CallConv, a_Name, a_Args) a_RetType (* a_CallConv a_Name) a_Args #elif RT_CLANG_PREREQ(6,0) && !defined(RT_RELAXED_CALLBACKS_TYPES) # define DECLCALLBACKPTR_EX(a_RetType, a_CallConv, a_Name, a_Args) __attribute__((__nothrow__)) a_RetType (a_CallConv * a_Name) a_Args #elif RT_MSC_PREREQ(RT_MSC_VER_VS2015) /*?*/ && defined(__cplusplus) && defined(_MSC_EXTENSIONS) && !defined(RT_RELAXED_CALLBACKS_TYPES) # define DECLCALLBACKPTR_EX(a_RetType, a_CallConv, a_Name, a_Args) a_RetType (a_CallConv * a_Name) a_Args throw() #else # define DECLCALLBACKPTR_EX(a_RetType, a_CallConv, a_Name, a_Args) a_RetType (a_CallConv * a_Name) a_Args #endif /** @def DECLCALLBACKPTR * How to declare an call back function pointer. * @param a_RetType The return type of the function declaration. * @param a_Name The name of the variable member. * @param a_Args The argument list enclosed in parentheses. * @note DECL_NOTHROW is implied, but not supported by all compilers yet. */ #define DECLCALLBACKPTR(a_RetType, a_Name, a_Args) DECLCALLBACKPTR_EX(a_RetType, RT_FAR_CODE RTCALL, a_Name, a_Args) /** @def DECLCALLBACKMEMBER_EX * How to declare an call back function pointer member. * @param a_RetType The return type of the function declaration. * @param a_CallConv Calling convention. * @param a_Name The name of the struct/union/class member. * @param a_Args The argument list enclosed in parentheses. * @note DECL_NOTHROW is implied, but not supported by all compilers yet. */ #if defined(__IBMC__) || defined(__IBMCPP__) # define DECLCALLBACKMEMBER_EX(a_RetType, a_CallConv, a_Name, a_Args) a_RetType (* a_CallConv a_Name) a_Args #elif RT_CLANG_PREREQ(6,0) && !defined(RT_RELAXED_CALLBACKS_TYPES) # define DECLCALLBACKMEMBER_EX(a_RetType, a_CallConv, a_Name, a_Args) __attribute__((__nothrow__)) a_RetType (a_CallConv *a_Name) a_Args #elif RT_MSC_PREREQ(RT_MSC_VER_VS2015) /*?*/ && defined(__cplusplus) && defined(_MSC_EXTENSIONS) && !defined(RT_RELAXED_CALLBACKS_TYPES) # define DECLCALLBACKMEMBER_EX(a_RetType, a_CallConv, a_Name, a_Args) a_RetType (a_CallConv *a_Name) a_Args throw() #else # define DECLCALLBACKMEMBER_EX(a_RetType, a_CallConv, a_Name, a_Args) a_RetType (a_CallConv *a_Name) a_Args #endif /** @def DECLCALLBACKMEMBER * How to declare an call back function pointer member. * @param a_RetType The return type of the function declaration. * @param a_Name The name of the struct/union/class member. * @param a_Args The argument list enclosed in parentheses. * @note DECL_NOTHROW is implied, but not supported by all compilers yet. */ #define DECLCALLBACKMEMBER(a_RetType, a_Name, a_Args) DECLCALLBACKMEMBER_EX(a_RetType, RT_FAR_CODE RTCALL, a_Name, a_Args) /** @def DECLR3CALLBACKMEMBER * How to declare an call back function pointer member - R3 Ptr. * @param a_RetType The return type of the function declaration. * @param a_Name The name of the struct/union/class member. * @param a_Args The argument list enclosed in parentheses. * @note DECL_NOTHROW is implied, but not supported by all compilers yet. */ #if defined(IN_RING3) || defined(DOXYGEN_RUNNING) # define DECLR3CALLBACKMEMBER(a_RetType, a_Name, a_Args) DECLCALLBACKMEMBER(a_RetType, a_Name, a_Args) #else # define DECLR3CALLBACKMEMBER(a_RetType, a_Name, a_Args) RTR3PTR a_Name #endif /** @def DECLRCCALLBACKMEMBER * How to declare an call back function pointer member - RC Ptr. * @param a_RetType The return type of the function declaration. * @param a_Name The name of the struct/union/class member. * @param a_Args The argument list enclosed in parentheses. * @note DECL_NOTHROW is implied, but not supported by all compilers yet. */ #if defined(IN_RC) || defined(DOXYGEN_RUNNING) # define DECLRCCALLBACKMEMBER(a_RetType, a_Name, a_Args) DECLCALLBACKMEMBER(a_RetType, a_Name, a_Args) #else # define DECLRCCALLBACKMEMBER(a_RetType, a_Name, a_Args) RTRCPTR a_Name #endif #if defined(IN_RC) || defined(DOXYGEN_RUNNING) # define DECLRGCALLBACKMEMBER(a_RetType, a_Name, a_Args) DECLCALLBACKMEMBER(a_RetType, a_Name, a_Args) #else # define DECLRGCALLBACKMEMBER(a_RetType, a_Name, a_Args) RTRGPTR a_Name #endif /** @def DECLR0CALLBACKMEMBER * How to declare an call back function pointer member - R0 Ptr. * @param a_RetType The return type of the function declaration. * @param a_Name The name of the struct/union/class member. * @param a_Args The argument list enclosed in parentheses. * @note DECL_NOTHROW is implied, but not supported by all compilers yet. */ #if defined(IN_RING0) || defined(DOXYGEN_RUNNING) # define DECLR0CALLBACKMEMBER(a_RetType, a_Name, a_Args) DECLCALLBACKMEMBER(a_RetType, a_Name, a_Args) #else # define DECLR0CALLBACKMEMBER(a_RetType, a_Name, a_Args) RTR0PTR a_Name #endif /** @def DECLINLINE * How to declare a function as inline that does not throw any C++ exceptions. * @param a_RetType The return type of the function declaration. * @remarks Don't use this macro on C++ methods. * @sa DECL_INLINE_THROW */ #if defined(__GNUC__) && !defined(DOXYGEN_RUNNING) # define DECLINLINE(a_RetType) DECL_NOTHROW(static __inline__ a_RetType) #elif defined(__cplusplus) || defined(DOXYGEN_RUNNING) # define DECLINLINE(a_RetType) DECL_NOTHROW(static inline a_RetType) #elif defined(_MSC_VER) # define DECLINLINE(a_RetType) DECL_NOTHROW(static _inline a_RetType) #elif defined(__IBMC__) # define DECLINLINE(a_RetType) DECL_NOTHROW(_Inline a_RetType) #else # define DECLINLINE(a_RetType) DECL_NOTHROW(inline a_RetType) #endif /** @def DECL_INLINE_THROW * How to declare a function as inline that throws C++ exceptions. * @param a_RetType The return type of the function declaration. * @remarks Don't use this macro on C++ methods. */ #if defined(__GNUC__) && !defined(DOXYGEN_RUNNING) # define DECL_INLINE_THROW(a_RetType) static __inline__ a_RetType #elif defined(__cplusplus) || defined(DOXYGEN_RUNNING) # define DECL_INLINE_THROW(a_RetType) static inline a_RetType #elif defined(_MSC_VER) # define DECL_INLINE_THROW(a_RetType) static _inline a_RetType #elif defined(__IBMC__) # define DECL_INLINE_THROW(a_RetType) _Inline a_RetType #else # define DECL_INLINE_THROW(a_RetType) inline a_RetType #endif /** @def DECL_FORCE_INLINE * How to declare a function that does not throw any C++ exceptions as inline * and try convince the compiler to always inline it regardless of optimization * switches. * @param a_RetType The return type of the function declaration. * @remarks Use sparsely and with care. Don't use this macro on C++ methods. * @sa DECL_FORCE_INLINE_THROW */ #ifdef __GNUC__ # define DECL_FORCE_INLINE(a_RetType) __attribute__((__always_inline__)) DECLINLINE(a_RetType) #elif defined(_MSC_VER) # define DECL_FORCE_INLINE(a_RetType) DECL_NOTHROW(__forceinline a_RetType) #else # define DECL_FORCE_INLINE(a_RetType) DECLINLINE(a_RetType) #endif /** @def DECL_FORCE_INLINE_THROW * How to declare a function throwing C++ exceptions as inline and try convince * the compiler to always inline it regardless of optimization switches. * @param a_RetType The return type of the function declaration. * @remarks Use sparsely and with care. Don't use this macro on C++ methods. */ #ifdef __GNUC__ # define DECL_FORCE_INLINE_THROW(a_RetType) __attribute__((__always_inline__)) DECL_INLINE_THROW(a_RetType) #elif defined(_MSC_VER) # define DECL_FORCE_INLINE_THROW(a_RetType) __forceinline a_RetType #else # define DECL_FORCE_INLINE_THROW(a_RetType) DECL_INLINE_THROW(a_RetType) #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 a_RetType The return type of the function declaration. * @remarks Don't use this macro on C++ methods. */ #ifdef __GNUC__ # define DECL_NO_INLINE(scope, a_RetType) __attribute__((__noinline__)) scope a_RetType #elif defined(_MSC_VER) # define DECL_NO_INLINE(scope, a_RetType) __declspec(noinline) scope a_RetType #else # define DECL_NO_INLINE(scope,a_RetType) scope a_RetType #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 also setting one of the IN_RT_R0, IN_RT_R3 or * IN_RT_RC indicators. */ /** @def IN_RT_R0 * Used to indicate whether we're inside the same link module as the host * context ring-0 Runtime Library. */ /** @def RTR0DECL(a_RetType) * Runtime Library host context ring-0 export or import declaration. * @param a_RetType The return a_RetType of the function declaration. * @remarks This is only used inside IPRT. Other APIs need to define their own * XXXX_DECL macros for dealing with import/export/static visibility. * @note DECL_NOTHROW is implied. */ #ifdef IN_RT_R0 # ifdef IN_RT_STATIC # define RTR0DECL(a_RetType) DECL_HIDDEN_NOTHROW(a_RetType) RTCALL # else # define RTR0DECL(a_RetType) DECL_EXPORT_NOTHROW(a_RetType) RTCALL # endif #else # define RTR0DECL(a_RetType) DECL_IMPORT_NOTHROW(a_RetType) RTCALL #endif /** @def IN_RT_R3 * Used to indicate whether we're inside the same link module as the host * context ring-3 Runtime Library. */ /** @def RTR3DECL(a_RetType) * Runtime Library host context ring-3 export or import declaration. * @param a_RetType The return type of the function declaration. * @remarks This is only used inside IPRT. Other APIs need to define their own * XXXX_DECL macros for dealing with import/export/static visibility. * @note DECL_NOTHROW is implied. */ #ifdef IN_RT_R3 # ifdef IN_RT_STATIC # define RTR3DECL(a_RetType) DECL_HIDDEN_NOTHROW(a_RetType) RTCALL # else # define RTR3DECL(a_RetType) DECL_EXPORT_NOTHROW(a_RetType) RTCALL # endif #else # define RTR3DECL(a_RetType) DECL_IMPORT_NOTHROW(a_RetType) RTCALL #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(a_RetType) * Runtime Library raw-mode context export or import declaration. * @param a_RetType The return type of the function declaration. * @remarks This is only used inside IPRT. Other APIs need to define their own * XXXX_DECL macros for dealing with import/export/static visibility. * @note DECL_NOTHROW is implied. */ #ifdef IN_RT_RC # ifdef IN_RT_STATIC # define RTRCDECL(a_RetType) DECL_HIDDEN_NOTHROW(a_RetType) RTCALL # else # define RTRCDECL(a_RetType) DECL_EXPORT_NOTHROW(a_RetType) RTCALL # endif #else # define RTRCDECL(a_RetType) DECL_IMPORT_NOTHROW(a_RetType) RTCALL #endif /** @def RTDECL(a_RetType) * Runtime Library export or import declaration. * Functions declared using this macro exists in all contexts. * @param a_RetType The return type of the function declaration. * @remarks This is only used inside IPRT. Other APIs need to define their own * XXXX_DECL macros for dealing with import/export/static visibility. * @note DECL_NOTHROW is implied. */ #if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0) # ifdef IN_RT_STATIC # define RTDECL(a_RetType) DECL_HIDDEN_NOTHROW(a_RetType) RTCALL # else # define RTDECL(a_RetType) DECL_EXPORT_NOTHROW(a_RetType) RTCALL # endif #else # define RTDECL(a_RetType) DECL_IMPORT_NOTHROW(a_RetType) RTCALL #endif /** @def RTDATADECL(a_Type) * Runtime Library export or import declaration. * Data declared using this macro exists in all contexts. * @param a_Type The data type. * @remarks This is only used inside IPRT. Other APIs need to define their own * XXXX_DECL macros for dealing with import/export/static visibility. */ /** @def RT_DECL_DATA_CONST(a_Type) * Definition of a const variable. See DECL_HIDDEN_CONST. * @param a_Type The const data type. * @remarks This is only used inside IPRT. Other APIs need to define their own * XXXX_DECL macros for dealing with import/export/static visibility. */ #if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0) # ifdef IN_RT_STATIC # define RTDATADECL(a_Type) DECL_HIDDEN_DATA(a_Type) # define RT_DECL_DATA_CONST(a_Type) DECL_HIDDEN_CONST(a_Type) # else # define RTDATADECL(a_Type) DECLEXPORT(a_Type) # if defined(__cplusplus) && defined(__GNUC__) # define RT_DECL_DATA_CONST(a_Type) a_Type # else # define RT_DECL_DATA_CONST(a_Type) DECLEXPORT(a_Type) # endif # endif #else # define RTDATADECL(a_Type) DECLIMPORT(a_Type) # define RT_DECL_DATA_CONST(a_Type) DECLIMPORT(a_Type) #endif /** @def RT_DECL_CLASS * Declares an class living in the runtime. * @remarks This is only used inside IPRT. Other APIs need to define their own * XXXX_DECL macros for dealing with import/export/static visibility. */ #if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0) # 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. */ #if !defined(RT_WITHOUT_NOCRT_WRAPPERS) || defined(RT_FORCE_NOCRT_WRAPPERS) # define RT_NOCRT(name) nocrt_ ## name # define RT_NOCRT_STR(name) "nocrt_" # name #else # define RT_NOCRT(name) name # define RT_NOCRT_STR(name) #name #endif /** @name Untrusted data classifications. * @{ */ /** @def RT_UNTRUSTED_USER * For marking non-volatile (race free) data from user mode as untrusted. * This is just for visible documentation. */ #define RT_UNTRUSTED_USER /** @def RT_UNTRUSTED_VOLATILE_USER * For marking volatile data shared with user mode as untrusted. * This is more than just documentation as it specifies the 'volatile' keyword, * because the guest could modify the data at any time. */ #define RT_UNTRUSTED_VOLATILE_USER volatile /** @def RT_UNTRUSTED_GUEST * For marking non-volatile (race free) data from the guest as untrusted. * This is just for visible documentation. */ #define RT_UNTRUSTED_GUEST /** @def RT_UNTRUSTED_VOLATILE_GUEST * For marking volatile data shared with the guest as untrusted. * This is more than just documentation as it specifies the 'volatile' keyword, * because the guest could modify the data at any time. */ #define RT_UNTRUSTED_VOLATILE_GUEST volatile /** @def RT_UNTRUSTED_HOST * For marking non-volatile (race free) data from the host as untrusted. * This is just for visible documentation. */ #define RT_UNTRUSTED_HOST /** @def RT_UNTRUSTED_VOLATILE_HOST * For marking volatile data shared with the host as untrusted. * This is more than just documentation as it specifies the 'volatile' keyword, * because the host could modify the data at any time. */ #define RT_UNTRUSTED_VOLATILE_HOST volatile /** @def RT_UNTRUSTED_HSTGST * For marking non-volatile (race free) data from the host/gust as untrusted. * This is just for visible documentation. */ #define RT_UNTRUSTED_HSTGST /** @def RT_UNTRUSTED_VOLATILE_HSTGST * For marking volatile data shared with the host/guest as untrusted. * This is more than just documentation as it specifies the 'volatile' keyword, * because the host could modify the data at any time. */ #define RT_UNTRUSTED_VOLATILE_HSTGST volatile /** @} */ /** @name Fences for use when handling untrusted data. * @{ */ /** For use after copying untruated volatile data to a non-volatile location. * This translates to a compiler memory barrier and will help ensure that the * compiler uses the non-volatile copy of the data. */ #define RT_UNTRUSTED_NONVOLATILE_COPY_FENCE() ASMCompilerBarrier() /** For use after finished validating guest input. * What this translates to is architecture dependent. On intel it will * translate to a CPU load+store fence as well as a compiler memory barrier. */ #if defined(RT_ARCH_AMD64) || (defined(RT_ARCH_X86) && !defined(RT_WITH_OLD_CPU_SUPPORT)) # define RT_UNTRUSTED_VALIDATED_FENCE() do { ASMCompilerBarrier(); ASMReadFence(); } while (0) #elif defined(RT_ARCH_X86) # define RT_UNTRUSTED_VALIDATED_FENCE() do { ASMCompilerBarrier(); ASMMemoryFence(); } while (0) #else # define RT_UNTRUSTED_VALIDATED_FENCE() do { ASMCompilerBarrier(); } while (0) #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, order your code use RT_LIKELY() instead of RT_UNLIKELY(). * * - Generally, use RT_UNLIKELY() with error condition checks (unless you * have some _strong_ reason to do otherwise, in which case document it), * and/or RT_LIKELY() with success condition checks, assuming you want * 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 character. * * - 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 * * @deprecated Please use RT_LIKELY() instead wherever possible! That gives us * a better chance of the windows compilers to generate favorable code * too. The belief is that the compiler will by default assume the * if-case is more likely than the else-case. */ #if defined(__GNUC__) # if __GNUC__ >= 3 && !defined(FORTIFY_RUNNING) # define RT_LIKELY(expr) __builtin_expect(!!(expr), 1) # define RT_UNLIKELY(expr) __builtin_expect(!!(expr), 0) # else # define RT_LIKELY(expr) (expr) # define RT_UNLIKELY(expr) (expr) # endif #else # define RT_LIKELY(expr) (expr) # define RT_UNLIKELY(expr) (expr) #endif /** @def RT_EXPAND_2 * Helper for RT_EXPAND. */ #define RT_EXPAND_2(a_Expr) a_Expr /** @def RT_EXPAND * Returns the expanded expression. * @param a_Expr The expression to expand. */ #define RT_EXPAND(a_Expr) RT_EXPAND_2(a_Expr) /** @def RT_STR * Returns the argument as a string constant. * @param str Argument to stringify. */ #define RT_STR(str) #str /** @def RT_XSTR * Returns the expanded argument as a string. * @param str Argument to expand and stringify. */ #define RT_XSTR(str) RT_STR(str) /** @def RT_LSTR_2 * Helper for RT_WSTR that gets the expanded @a str. * @param str String litteral to prefix with 'L'. */ #define RT_LSTR_2(str) L##str /** @def RT_LSTR * Returns the expanded argument with a L string prefix. * * Intended for converting ASCII string \#defines into wide char string * litterals on Windows. * * @param str String litteral to . */ #define RT_LSTR(str) RT_LSTR_2(str) /** @def RT_UNPACK_CALL * Unpacks the an argument list inside an extra set of parenthesis and turns it * into a call to @a a_Fn. * * @param a_Fn Function/macro to call. * @param a_Args Parameter list in parenthesis. */ #define RT_UNPACK_CALL(a_Fn, a_Args) a_Fn a_Args #if defined(RT_COMPILER_SUPPORTS_VA_ARGS) || defined(DOXYGEN_RUNNING) /** @def RT_UNPACK_ARGS * Returns the arguments without parenthesis. * * @param ... Parameter list in parenthesis. * @remarks Requires RT_COMPILER_SUPPORTS_VA_ARGS. */ # define RT_UNPACK_ARGS(...) __VA_ARGS__ /** @def RT_COUNT_VA_ARGS_HLP * Helper for RT_COUNT_VA_ARGS that picks out the argument count from * RT_COUNT_VA_ARGS_REV_SEQ. */ # define RT_COUNT_VA_ARGS_HLP( \ c69, c68, c67, c66, c65, c64, c63, c62, c61, c60, \ c59, c58, c57, c56, c55, c54, c53, c52, c51, c50, \ c49, c48, c47, c46, c45, c44, c43, c42, c41, c40, \ c39, c38, c37, c36, c35, c34, c33, c32, c31, c30, \ c29, c28, c27, c26, c25, c24, c23, c22, c21, c20, \ c19, c18, c17, c16, c15, c14, c13, c12, c11, c10, \ c9, c8, c7, c6, c5, c4, c3, c2, c1, cArgs, ...) cArgs /** Argument count sequence. */ # define RT_COUNT_VA_ARGS_REV_SEQ \ 69, 68, 67, 66, 65, 64, 63, 62, 61, 60, \ 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, \ 49, 48, 47, 46, 45, 44, 43, 42, 41, 40, \ 39, 38, 37, 36, 35, 34, 33, 32, 31, 30, \ 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, \ 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, \ 9, 8, 7, 6, 5, 4, 3, 2, 1, 0 /** This is for zero arguments. At least Visual C++ requires it. */ # define RT_COUNT_VA_ARGS_PREFIX_RT_NOTHING RT_COUNT_VA_ARGS_REV_SEQ /** * Counts the number of arguments given to the variadic macro. * * Max is 69. * * @returns Number of arguments in the ellipsis * @param ... Arguments to count. * @remarks Requires RT_COMPILER_SUPPORTS_VA_ARGS. */ # define RT_COUNT_VA_ARGS(...) \ RT_UNPACK_CALL(RT_COUNT_VA_ARGS_HLP, (RT_COUNT_VA_ARGS_PREFIX_ ## __VA_ARGS__ ## RT_NOTHING, \ RT_COUNT_VA_ARGS_REV_SEQ)) #endif /* RT_COMPILER_SUPPORTS_VA_ARGS */ /** @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_CONCAT3 * 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_CONCAT4 * 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. * @param d The 4th 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 /** @def RT_CONCAT5 * 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. * @param d The 4th part. * @param e The 5th part. */ #define RT_CONCAT5(a,b,c,d,e) RT_CONCAT5_HLP(a,b,c,d,e) /** RT_CONCAT5 helper, don't use. */ #define RT_CONCAT5_HLP(a,b,c,d,e) a##b##c##d##e /** @def RT_CONCAT6 * 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. * @param d The 4th part. * @param e The 5th part. * @param f The 6th part. */ #define RT_CONCAT6(a,b,c,d,e,f) RT_CONCAT6_HLP(a,b,c,d,e,f) /** RT_CONCAT6 helper, don't use. */ #define RT_CONCAT6_HLP(a,b,c,d,e,f) a##b##c##d##e##f /** @def RT_CONCAT7 * 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. * @param d The 4th part. * @param e The 5th part. * @param f The 6th part. * @param g The 7th part. */ #define RT_CONCAT7(a,b,c,d,e,f,g) RT_CONCAT7_HLP(a,b,c,d,e,f,g) /** RT_CONCAT7 helper, don't use. */ #define RT_CONCAT7_HLP(a,b,c,d,e,f,g) a##b##c##d##e##f##g /** @def RT_CONCAT8 * 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. * @param d The 4th part. * @param e The 5th part. * @param f The 6th part. * @param g The 7th part. * @param h The 8th part. */ #define RT_CONCAT8(a,b,c,d,e,f,g,h) RT_CONCAT8_HLP(a,b,c,d,e,f,g,h) /** RT_CONCAT8 helper, don't use. */ #define RT_CONCAT8_HLP(a,b,c,d,e,f,g,h) a##b##c##d##e##f##g##h /** @def RT_CONCAT9 * 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. * @param d The 4th part. * @param e The 5th part. * @param f The 6th part. * @param g The 7th part. * @param h The 8th part. * @param i The 9th part. */ #define RT_CONCAT9(a,b,c,d,e,f,g,h,i) RT_CONCAT9_HLP(a,b,c,d,e,f,g,h,i) /** RT_CONCAT9 helper, don't use. */ #define RT_CONCAT9_HLP(a,b,c,d,e,f,g,h,i) a##b##c##d##e##f##g##h##i /** * String constant tuple - string constant, strlen(string constant). * * @param a_szConst String constant. * @sa RTSTRTUPLE */ #define RT_STR_TUPLE(a_szConst) a_szConst, (sizeof(a_szConst) - 1) /** * Macro for using in switch statements that turns constants into strings. * * @param a_Const The constant (not string). */ #define RT_CASE_RET_STR(a_Const) case a_Const: return #a_Const /** @def RT_BIT * Convert a bit number into an integer bitmask (unsigned). * @param bit The bit number. */ #define RT_BIT(bit) ( 1U << (bit) ) /** @def RT_BIT_32 * Convert a bit number into a 32-bit bitmask (unsigned). * @param bit The bit number. */ #define RT_BIT_32(bit) ( UINT32_C(1) << (bit) ) /** @def RT_BIT_64 * Convert a bit number into a 64-bit bitmask (unsigned). * @param bit The bit number. */ #define RT_BIT_64(bit) ( UINT64_C(1) << (bit) ) /** @def RT_BIT_Z * Convert a bit number into a size_t bitmask (for avoid MSC warnings). * @param a_iBit The bit number. */ #define RT_BIT_Z(a_iBit) ( (size_t)(1) << (a_iBit) ) /** @def RT_BF_GET * Gets the value of a bit field in an integer value. * * This requires a couple of macros to be defined for the field: * - \_SHIFT: The shift count to get to the field. * - \_MASK: The field mask. * * @returns The bit field value. * @param a_uValue The integer value containing the field. * @param a_FieldNm The field name prefix for getting at the _SHIFT and * _MASK macros. * @sa #RT_BF_CLEAR, #RT_BF_SET, #RT_BF_MAKE, #RT_BF_ZMASK */ #define RT_BF_GET(a_uValue, a_FieldNm) ( ((a_uValue) >> RT_CONCAT(a_FieldNm,_SHIFT)) & RT_BF_ZMASK(a_FieldNm) ) /** @def RT_BF_SET * Sets the given bit field in the integer value. * * This requires a couple of macros to be defined for the field: * - \_SHIFT: The shift count to get to the field. * - \_MASK: The field mask. Must have the same type as the * integer value!! * * @returns Integer value with bit field set to @a a_uFieldValue. * @param a_uValue The integer value containing the field. * @param a_FieldNm The field name prefix for getting at the _SHIFT and * _MASK macros. * @param a_uFieldValue The new field value. * @sa #RT_BF_GET, #RT_BF_CLEAR, #RT_BF_MAKE, #RT_BF_ZMASK */ #define RT_BF_SET(a_uValue, a_FieldNm, a_uFieldValue) ( RT_BF_CLEAR(a_uValue, a_FieldNm) | RT_BF_MAKE(a_FieldNm, a_uFieldValue) ) /** @def RT_BF_CLEAR * Clears the given bit field in the integer value. * * This requires a couple of macros to be defined for the field: * - \_SHIFT: The shift count to get to the field. * - \_MASK: The field mask. Must have the same type as the * integer value!! * * @returns Integer value with bit field set to zero. * @param a_uValue The integer value containing the field. * @param a_FieldNm The field name prefix for getting at the _SHIFT and * _MASK macros. * @sa #RT_BF_GET, #RT_BF_SET, #RT_BF_MAKE, #RT_BF_ZMASK */ #define RT_BF_CLEAR(a_uValue, a_FieldNm) ( (a_uValue) & ~RT_CONCAT(a_FieldNm,_MASK) ) /** @def RT_BF_MAKE * Shifts and masks a bit field value into position in the integer value. * * This requires a couple of macros to be defined for the field: * - \_SHIFT: The shift count to get to the field. * - \_MASK: The field mask. * * @param a_FieldNm The field name prefix for getting at the _SHIFT and * _MASK macros. * @param a_uFieldValue The field value that should be masked and shifted * into position. * @sa #RT_BF_GET, #RT_BF_SET, #RT_BF_CLEAR, #RT_BF_ZMASK */ #define RT_BF_MAKE(a_FieldNm, a_uFieldValue) ( ((a_uFieldValue) & RT_BF_ZMASK(a_FieldNm) ) << RT_CONCAT(a_FieldNm,_SHIFT) ) /** @def RT_BF_ZMASK * Helper for getting the field mask shifted to bit position zero. * * @param a_FieldNm The field name prefix for getting at the _SHIFT and * _MASK macros. * @sa #RT_BF_GET, #RT_BF_SET, #RT_BF_CLEAR, #RT_BF_MAKE */ #define RT_BF_ZMASK(a_FieldNm) ( RT_CONCAT(a_FieldNm,_MASK) >> RT_CONCAT(a_FieldNm,_SHIFT) ) /** Bit field compile time check helper * @internal */ #define RT_BF_CHECK_DO_XOR_MASK(a_uLeft, a_RightPrefix, a_FieldNm) ((a_uLeft) ^ RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK)) /** Bit field compile time check helper * @internal */ #define RT_BF_CHECK_DO_OR_MASK(a_uLeft, a_RightPrefix, a_FieldNm) ((a_uLeft) | RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK)) /** Bit field compile time check helper * @internal */ #define RT_BF_CHECK_DO_1ST_MASK_BIT(a_uLeft, a_RightPrefix, a_FieldNm) \ ((a_uLeft) && ( (RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK) >> RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT)) & 1U ) ) /** Used to check that a bit field mask does not start too early. * @internal */ #define RT_BF_CHECK_DO_MASK_START(a_uLeft, a_RightPrefix, a_FieldNm) \ ( (a_uLeft) \ && ( RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT) == 0 \ || ( ( ( ((RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK) >> RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT)) & 1U) \ << RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT)) /* => single bit mask, correct type */ \ - 1U) /* => mask of all bits below the field */ \ & RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK)) == 0 ) ) /** @name Bit field compile time check recursion workers. * @internal * @{ */ #define RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix, f1) \ a_DoThis(a_uLeft, a_RightPrefix, f1) #define RT_BF_CHECK_DO_2(a_DoThis, a_uLeft, a_RightPrefix, f1, f2) \ RT_BF_CHECK_DO_1(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2) #define RT_BF_CHECK_DO_3(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3) \ RT_BF_CHECK_DO_2(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3) #define RT_BF_CHECK_DO_4(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4) \ RT_BF_CHECK_DO_3(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4) #define RT_BF_CHECK_DO_5(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5) \ RT_BF_CHECK_DO_4(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5) #define RT_BF_CHECK_DO_6(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6) \ RT_BF_CHECK_DO_5(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6) #define RT_BF_CHECK_DO_7(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7) \ RT_BF_CHECK_DO_6(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7) #define RT_BF_CHECK_DO_8(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8) \ RT_BF_CHECK_DO_7(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8) #define RT_BF_CHECK_DO_9(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9) \ RT_BF_CHECK_DO_8(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9) #define RT_BF_CHECK_DO_10(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10) \ RT_BF_CHECK_DO_9(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10) #define RT_BF_CHECK_DO_11(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11) \ RT_BF_CHECK_DO_10(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11) #define RT_BF_CHECK_DO_12(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12) \ RT_BF_CHECK_DO_11(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12) #define RT_BF_CHECK_DO_13(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13) \ RT_BF_CHECK_DO_12(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13) #define RT_BF_CHECK_DO_14(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14) \ RT_BF_CHECK_DO_13(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14) #define RT_BF_CHECK_DO_15(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15) \ RT_BF_CHECK_DO_14(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15) #define RT_BF_CHECK_DO_16(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16) \ RT_BF_CHECK_DO_15(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16) #define RT_BF_CHECK_DO_17(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17) \ RT_BF_CHECK_DO_16(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17) #define RT_BF_CHECK_DO_18(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18) \ RT_BF_CHECK_DO_17(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18) #define RT_BF_CHECK_DO_19(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19) \ RT_BF_CHECK_DO_18(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19) #define RT_BF_CHECK_DO_20(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20) \ RT_BF_CHECK_DO_19(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20) #define RT_BF_CHECK_DO_21(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21) \ RT_BF_CHECK_DO_20(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21) #define RT_BF_CHECK_DO_22(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22) \ RT_BF_CHECK_DO_21(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22) #define RT_BF_CHECK_DO_23(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23) \ RT_BF_CHECK_DO_22(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23) #define RT_BF_CHECK_DO_24(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24) \ RT_BF_CHECK_DO_23(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24) #define RT_BF_CHECK_DO_25(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25) \ RT_BF_CHECK_DO_24(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25) #define RT_BF_CHECK_DO_26(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26) \ RT_BF_CHECK_DO_25(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26) #define RT_BF_CHECK_DO_27(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27) \ RT_BF_CHECK_DO_26(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27) #define RT_BF_CHECK_DO_28(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28) \ RT_BF_CHECK_DO_27(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28) #define RT_BF_CHECK_DO_29(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29) \ RT_BF_CHECK_DO_28(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29) #define RT_BF_CHECK_DO_30(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30) \ RT_BF_CHECK_DO_29(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30) #define RT_BF_CHECK_DO_31(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31) \ RT_BF_CHECK_DO_30(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31) #define RT_BF_CHECK_DO_32(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32) \ RT_BF_CHECK_DO_31(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32) #define RT_BF_CHECK_DO_33(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33) \ RT_BF_CHECK_DO_32(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33) #define RT_BF_CHECK_DO_34(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34) \ RT_BF_CHECK_DO_33(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34) #define RT_BF_CHECK_DO_35(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35) \ RT_BF_CHECK_DO_34(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35) #define RT_BF_CHECK_DO_36(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36) \ RT_BF_CHECK_DO_35(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36) #define RT_BF_CHECK_DO_37(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37) \ RT_BF_CHECK_DO_36(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37) #define RT_BF_CHECK_DO_38(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38) \ RT_BF_CHECK_DO_37(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38) #define RT_BF_CHECK_DO_39(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39) \ RT_BF_CHECK_DO_38(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39) #define RT_BF_CHECK_DO_40(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40) \ RT_BF_CHECK_DO_39(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40) #define RT_BF_CHECK_DO_41(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41) \ RT_BF_CHECK_DO_40(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41) #define RT_BF_CHECK_DO_42(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42) \ RT_BF_CHECK_DO_41(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42) #define RT_BF_CHECK_DO_43(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43) \ RT_BF_CHECK_DO_42(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43) #define RT_BF_CHECK_DO_44(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44) \ RT_BF_CHECK_DO_43(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44) #define RT_BF_CHECK_DO_45(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45) \ RT_BF_CHECK_DO_44(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45) #define RT_BF_CHECK_DO_46(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46) \ RT_BF_CHECK_DO_45(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46) #define RT_BF_CHECK_DO_47(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47) \ RT_BF_CHECK_DO_46(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47) #define RT_BF_CHECK_DO_48(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48) \ RT_BF_CHECK_DO_47(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48) #define RT_BF_CHECK_DO_49(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49) \ RT_BF_CHECK_DO_48(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49) #define RT_BF_CHECK_DO_50(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50) \ RT_BF_CHECK_DO_49(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50) #define RT_BF_CHECK_DO_51(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51) \ RT_BF_CHECK_DO_40(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51) #define RT_BF_CHECK_DO_52(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52) \ RT_BF_CHECK_DO_51(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52) #define RT_BF_CHECK_DO_53(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53) \ RT_BF_CHECK_DO_52(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53) #define RT_BF_CHECK_DO_54(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54) \ RT_BF_CHECK_DO_53(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54) #define RT_BF_CHECK_DO_55(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55) \ RT_BF_CHECK_DO_54(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55) #define RT_BF_CHECK_DO_56(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56) \ RT_BF_CHECK_DO_55(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56) #define RT_BF_CHECK_DO_57(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57) \ RT_BF_CHECK_DO_56(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57) #define RT_BF_CHECK_DO_58(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58) \ RT_BF_CHECK_DO_57(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58) #define RT_BF_CHECK_DO_59(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59) \ RT_BF_CHECK_DO_58(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59) #define RT_BF_CHECK_DO_60(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59, f60) \ RT_BF_CHECK_DO_59(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59, f60) #define RT_BF_CHECK_DO_61(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59, f60, f61) \ RT_BF_CHECK_DO_60(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59, f60, f61) #define RT_BF_CHECK_DO_62(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59, f60, f61, f62) \ RT_BF_CHECK_DO_61(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59, f60, f61, f62) #define RT_BF_CHECK_DO_63(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59, f60, f61, f62, f63) \ RT_BF_CHECK_DO_62(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59, f60, f61, f62, f63) #define RT_BF_CHECK_DO_64(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59, f60, f61, f62, f63, f64) \ RT_BF_CHECK_DO_63(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, f25, f26, f27, f28, f29, f30, f31, f32, f33, f34, f35, f36, f37, f38, f39, f40, f41, f42, f43, f44, f45, f46, f47, f48, f49, f50, f51, f52, f53, f54, f55, f56, f57, f58, f59, f60, f61, f62, f63, f64) /** @} */ /** @def RT_BF_ASSERT_COMPILE_CHECKS * Emits a series of AssertCompile statements checking that the bit-field * declarations doesn't overlap, has holes, and generally makes some sense. * * This requires variadic macros because its too much to type otherwise. */ #if defined(RT_COMPILER_SUPPORTS_VA_ARGS) || defined(DOXYGEN_RUNNING) # define RT_BF_ASSERT_COMPILE_CHECKS(a_Prefix, a_uZero, a_uCovered, a_Fields) \ AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_OR_MASK, a_uZero, a_Prefix, RT_UNPACK_ARGS a_Fields ) == a_uCovered); \ AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_XOR_MASK, a_uCovered, a_Prefix, RT_UNPACK_ARGS a_Fields ) == 0); \ AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_1ST_MASK_BIT, true, a_Prefix, RT_UNPACK_ARGS a_Fields ) == true); \ AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_MASK_START, true, a_Prefix, RT_UNPACK_ARGS a_Fields ) == true) /** Bit field compile time check helper * @internal */ # define RT_BF_CHECK_DO_N(a_DoThis, a_uLeft, a_RightPrefix, ...) \ RT_UNPACK_CALL(RT_CONCAT(RT_BF_CHECK_DO_, RT_EXPAND(RT_COUNT_VA_ARGS(__VA_ARGS__))), (a_DoThis, a_uLeft, a_RightPrefix, __VA_ARGS__)) #else # define RT_BF_ASSERT_COMPILE_CHECKS(a_Prefix, a_uZero, a_uCovered, a_Fields) AssertCompile(true) #endif /** @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. */ #define RT_ALIGN(u, uAlignment) ( ((u) + ((uAlignment) - 1)) & ~((uAlignment) - 1) ) /** @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! */ #define RT_ALIGN_32(u32, uAlignment) RT_ALIGN_T(u32, uAlignment, uint32_t) /** @def RT_ALIGN_64 * Align macro for a 64-bit value. * @param u64 Value to align. * @param uAlignment The alignment. Power of two! */ #define RT_ALIGN_64(u64, uAlignment) RT_ALIGN_T(u64, uAlignment, uint64_t) /** @def RT_ALIGN_Z * Align macro for size_t. * @param cb Value to align. * @param uAlignment The alignment. Power of two! */ #define RT_ALIGN_Z(cb, uAlignment) RT_ALIGN_T(cb, uAlignment, size_t) /** @def RT_ALIGN_P * Align macro for pointers. * @param pv Value to align. * @param uAlignment The alignment. Power of two! */ #define RT_ALIGN_P(pv, uAlignment) RT_ALIGN_PT(pv, uAlignment, void *) /** @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. */ #define RT_ALIGN_PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, uintptr_t) ) /** @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. */ #define RT_ALIGN_R3PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR3UINTPTR) ) /** @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. */ #define RT_ALIGN_R0PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR0UINTPTR) ) /** @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. */ #define RT_ALIGN_GCPT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTGCUINTPTR) ) /** @def RT_OFFSETOF * Our own special offsetof() variant, returns a signed result. * * @returns offset into the structure of the specified member. signed. * @param type Structure type. * @param member Member. * * @remarks Only use this for static offset calculations. Please * use RT_UOFFSETOF_DYN for dynamic ones (i.e. involves * non-constant array indexing). * */ #if RT_GNUC_PREREQ(4, 0) # define RT_OFFSETOF(type, member) ( (int)__builtin_offsetof(type, member) ) #else # define RT_OFFSETOF(type, member) ( (int)(intptr_t)&( ((type *)(void *)0)->member) ) #endif /** @def RT_UOFFSETOF * Our own offsetof() variant, returns an unsigned result. * * @returns offset into the structure of the specified member. unsigned. * @param type Structure type. * @param member Member. * * @remarks Only use this for static offset calculations. Please * use RT_UOFFSETOF_DYN for dynamic ones (i.e. involves * non-constant array indexing). */ #if RT_GNUC_PREREQ(4, 0) # define RT_UOFFSETOF(type, member) ( (uintptr_t)__builtin_offsetof(type, member) ) #else # define RT_UOFFSETOF(type, member) ( (uintptr_t)&( ((type *)(void *)0)->member) ) #endif /** @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. * * @remarks Only use this for static offset calculations. */ #define RT_OFFSETOF_ADD(type, member, addend) ( (int)RT_UOFFSETOF_ADD(type, member, addend) ) /** @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. * * @remarks Only use this for static offset calculations. */ #if RT_GNUC_PREREQ(4, 0) # define RT_UOFFSETOF_ADD(type, member, addend) ( (uintptr_t)(__builtin_offsetof(type, member) + (addend))) #else # define RT_UOFFSETOF_ADD(type, member, addend) ( (uintptr_t)&( ((type *)(void *)(uintptr_t)(addend))->member) ) #endif /** @def RT_UOFFSETOF_DYN * Dynamic (runtime) structure offset calculations, involving * indexing of array members via variable. * * @returns offset into the structure of the specified member. signed. * @param type Structure type. * @param memberarray Member. */ #if defined(__cplusplus) && RT_GNUC_PREREQ(4, 4) # define RT_UOFFSETOF_DYN(type, memberarray) ( (uintptr_t)&( ((type *)(void *)0x1000)->memberarray) - 0x1000 ) #else # define RT_UOFFSETOF_DYN(type, memberarray) ( (uintptr_t)&( ((type *)(void *)0)->memberarray) ) #endif /** @def RT_SIZEOFMEMB * Get the size of a structure member. * * @returns size of the structure member. * @param type Structure type. * @param member Member. */ #define RT_SIZEOFMEMB(type, member) ( sizeof(((type *)(void *)0)->member) ) /** @def RT_UOFFSET_AFTER * Returns the offset of the first byte following a structure/union member. * * @return byte offset into the struct. * @param a_Type Structure type. * @param a_Member The member name. */ #define RT_UOFFSET_AFTER(a_Type, a_Member) ( RT_UOFFSETOF(a_Type, a_Member) + RT_SIZEOFMEMB(a_Type, a_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) # define RT_FROM_CPP_MEMBER(pMem, Type, Member) \ ( (Type *) ((uintptr_t)(pMem) - (uintptr_t)&((Type *)0x1000)->Member + 0x1000U) ) #else # define RT_FROM_CPP_MEMBER(pMem, Type, Member) RT_FROM_MEMBER(pMem, Type, Member) #endif /** @def RT_FROM_MEMBER_DYN * 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 dynamic size (some array is index by * non-constant value). */ #define RT_FROM_MEMBER_DYN(pMem, Type, Member) ( (Type *) ((uint8_t *)(void *)(pMem) - RT_UOFFSETOF_DYN(Type, Member)) ) /** @def RT_ELEMENTS * Calculates the number of elements in a statically sized array. * @returns Element count. * @param aArray Array in question. */ #define RT_ELEMENTS(aArray) ( sizeof(aArray) / sizeof((aArray)[0]) ) /** @def RT_SAFE_SUBSCRIPT * Safe array subscript using modulo and size_t cast. * @param a_Array The array. * @param a_idx The array index, cast to size_t to ensure unsigned. */ #define RT_SAFE_SUBSCRIPT(a_Array, a_idx) (a_Array)[(size_t)(a_idx) % RT_ELEMENTS(a_Array)] /** @def RT_SAFE_SUBSCRIPT32 * Safe array subscript using modulo and uint32_t cast. * @param a_Array The array. * @param a_idx The array index, cast to size_t to ensure unsigned. * @note Only consider using this if array size is not power of two. */ #define RT_SAFE_SUBSCRIPT32(a_Array, a_idx) (a_Array)[(uint32_t)(a_idx) % RT_ELEMENTS(a_Array)] /** @def RT_SAFE_SUBSCRIPT16 * Safe array subscript using modulo and uint16_t cast. * @param a_Array The array. * @param a_idx The array index, cast to size_t to ensure unsigned. * @note Only consider using this if array size is not power of two. */ #define RT_SAFE_SUBSCRIPT16(a_Array, a_idx) (a_Array)[(uint16_t)(a_idx) % RT_ELEMENTS(a_Array)] /** @def RT_SAFE_SUBSCRIPT8 * Safe array subscript using modulo and uint8_t cast. * @param a_Array The array. * @param a_idx The array index, cast to size_t to ensure unsigned. * @note Only consider using this if array size is not power of two. */ #define RT_SAFE_SUBSCRIPT8(a_Array, a_idx) (a_Array)[(uint8_t)(a_idx) % RT_ELEMENTS(a_Array)] /** @def RT_SAFE_SUBSCRIPT_NC * Safe array subscript using modulo but no cast. * @param a_Array The array. * @param a_idx The array index - assumes unsigned type. * @note Only consider using this if array size is not power of two. */ #define RT_SAFE_SUBSCRIPT_NC(a_Array, a_idx) (a_Array)[(a_idx) % RT_ELEMENTS(a_Array)] /** @def RT_FLEXIBLE_ARRAY * What to up inside the square brackets when declaring a structure member * with a flexible size. * * @note RT_FLEXIBLE_ARRAY_EXTENSION must always preceed the type, unless * it's C-only code. * * @note Use RT_UOFFSETOF() to calculate the structure size. * * @note Never do a sizeof() on the structure or member! * * @note The member must be the last one. * * @note GCC does not permit using this in a union. So, for unions you must * use RT_FLEXIBLE_ARRAY_IN_UNION instead. * * @note GCC does not permit using this in nested structures, where as MSC * does. So, use RT_FLEXIBLE_ARRAY_NESTED for that. * * @sa RT_FLEXIBLE_ARRAY_NESTED, RT_FLEXIBLE_ARRAY_IN_UNION */ #if RT_MSC_PREREQ(RT_MSC_VER_VS2005) /** @todo Probably much much earlier. */ \ || (defined(__cplusplus) && RT_GNUC_PREREQ(6, 1)) /* not tested 7.x, but hope it works with __extension__ too. */ \ || defined(__WATCOMC__) /* openwatcom 1.9 supports it, we don't care about older atm. */ \ || RT_CLANG_PREREQ_EX(3, 4, 0) /* Only tested clang v3.4, support is probably older. */ # define RT_FLEXIBLE_ARRAY # if defined(__cplusplus) && defined(_MSC_VER) # pragma warning(disable:4200) /* -wd4200 does not work with VS2010 */ # pragma warning(disable:4815) /* -wd4815 does not work with VS2019 */ # endif #elif defined(__STDC_VERSION__) # if __STDC_VERSION__ >= 1999901L # define RT_FLEXIBLE_ARRAY # else # define RT_FLEXIBLE_ARRAY 1 # endif #else # define RT_FLEXIBLE_ARRAY 1 #endif /** @def RT_FLEXIBLE_ARRAY_EXTENSION * A trick to make GNU C++ quietly accept flexible arrays in C++ code when * pedantic warnings are enabled. Put this on the line before the flexible * array. */ #if (RT_GNUC_PREREQ(7, 0) && defined(__cplusplus)) || defined(DOXGYEN_RUNNING) # define RT_FLEXIBLE_ARRAY_EXTENSION RT_GCC_EXTENSION #else # define RT_FLEXIBLE_ARRAY_EXTENSION #endif /** @def RT_FLEXIBLE_ARRAY_NESTED * Variant of RT_FLEXIBLE_ARRAY for use in structures that are nested. * * GCC only allow the use of flexible array member in the top structure, whereas * MSC is less strict and let you do struct { struct { char szName[]; } s; }; * * @note See notes for RT_FLEXIBLE_ARRAY. * * @note GCC does not permit using this in a union. So, for unions you must * use RT_FLEXIBLE_ARRAY_IN_NESTED_UNION instead. * * @sa RT_FLEXIBLE_ARRAY, RT_FLEXIBLE_ARRAY_IN_NESTED_UNION */ #ifdef _MSC_VER # define RT_FLEXIBLE_ARRAY_NESTED RT_FLEXIBLE_ARRAY #else # define RT_FLEXIBLE_ARRAY_NESTED 1 #endif /** @def RT_FLEXIBLE_ARRAY_IN_UNION * The union version of RT_FLEXIBLE_ARRAY. * * @remarks GCC does not support flexible array members in unions, 6.1.x * actively checks for this. Visual C++ 2010 seems happy with it. * * @note See notes for RT_FLEXIBLE_ARRAY. * * @sa RT_FLEXIBLE_ARRAY, RT_FLEXIBLE_ARRAY_IN_NESTED_UNION */ #ifdef _MSC_VER # define RT_FLEXIBLE_ARRAY_IN_UNION RT_FLEXIBLE_ARRAY #else # define RT_FLEXIBLE_ARRAY_IN_UNION 1 #endif /** @def RT_FLEXIBLE_ARRAY_IN_NESTED_UNION * The union version of RT_FLEXIBLE_ARRAY_NESTED. * * @note See notes for RT_FLEXIBLE_ARRAY. * * @sa RT_FLEXIBLE_ARRAY, RT_FLEXIBLE_ARRAY_IN_NESTED_UNION */ #ifdef _MSC_VER # define RT_FLEXIBLE_ARRAY_IN_NESTED_UNION RT_FLEXIBLE_ARRAY_NESTED #else # define RT_FLEXIBLE_ARRAY_IN_NESTED_UNION 1 #endif /** @def RT_UNION_NM * For compilers (like DTrace) that does not grok nameless unions, we have a * little hack to make them palatable. */ /** @def RT_STRUCT_NM * For compilers (like DTrace) that does not grok nameless structs (it is * non-standard C++), we have a little hack to make them palatable. */ #ifdef IPRT_WITHOUT_NAMED_UNIONS_AND_STRUCTS # define RT_UNION_NM(a_Nm) a_Nm # define RT_STRUCT_NM(a_Nm) a_Nm #else # define RT_UNION_NM(a_Nm) # define RT_STRUCT_NM(a_Nm) #endif /** * 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 */ #define RT_IS_POWER_OF_TWO(uVal) ( ((uVal) & ((uVal) - 1)) == 0) #ifdef RT_OS_OS2 /* Undefine RT_MAX since there is an unfortunate clash with the max resource type define in os2.h. */ # undef RT_MAX #endif /** @def RT_MAX * Finds the maximum value. * @returns The higher of the two. * @param Value1 Value 1 * @param Value2 Value 2 */ #define RT_MAX(Value1, Value2) ( (Value1) >= (Value2) ? (Value1) : (Value2) ) /** @def RT_MIN * Finds the minimum value. * @returns The lower of the two. * @param Value1 Value 1 * @param Value2 Value 2 */ #define RT_MIN(Value1, Value2) ( (Value1) <= (Value2) ? (Value1) : (Value2) ) /** @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. */ #define RT_CLAMP(Value, Min, Max) ( (Value) > (Max) ? (Max) : (Value) < (Min) ? (Min) : (Value) ) /** @def RT_ABS * Get the absolute (non-negative) value. * @returns The absolute value of Value. * @param Value The value. */ #define RT_ABS(Value) ( (Value) >= 0 ? (Value) : -(Value) ) /** @def RT_BOOL * Turn non-zero/zero into true/false * @returns The resulting boolean value. * @param Value The value. */ #define RT_BOOL(Value) ( !!(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); }) #elif defined(_MSC_VER) /* shut up cast truncates constant value warnings */ # define RT_LO_U8(a) ( (uint8_t)(UINT8_MAX & (a)) ) #else # define RT_LO_U8(a) ( (uint8_t)(a) ) #endif /** @def RT_HI_U8 * Gets the high uint8_t of a uint16_t or something equivalent. */ #ifdef __GNUC__ # define RT_HI_U8(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint16_t)); (uint8_t)((a) >> 8); }) #else # define RT_HI_U8(a) ( (uint8_t)((a) >> 8) ) #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(uint32_t)); (uint16_t)(a); }) #elif defined(_MSC_VER) /* shut up cast truncates constant value warnings */ # define RT_LO_U16(a) ( (uint16_t)(UINT16_MAX & (a)) ) #else # define RT_LO_U16(a) ( (uint16_t)(a) ) #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 # define RT_HI_U16(a) ( (uint16_t)((a) >> 16) ) #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); }) #elif defined(_MSC_VER) /* shut up cast truncates constant value warnings */ # define RT_LO_U32(a) ( (uint32_t)(UINT32_MAX & (a)) ) #else # define RT_LO_U32(a) ( (uint32_t)(a) ) #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 # define RT_HI_U32(a) ( (uint32_t)((a) >> 32) ) #endif /** @def RT_BYTE1 * Gets the first byte of something. */ #define RT_BYTE1(a) ( (uint8_t)((a) & 0xff) ) /** @def RT_BYTE2 * Gets the second byte of something. */ #define RT_BYTE2(a) ( (uint8_t)(((a) >> 8) & 0xff) ) /** @def RT_BYTE3 * Gets the second byte of something. */ #define RT_BYTE3(a) ( (uint8_t)(((a) >> 16) & 0xff) ) /** @def RT_BYTE4 * Gets the fourth byte of something. */ #define RT_BYTE4(a) ( (uint8_t)(((a) >> 24) & 0xff) ) /** @def RT_BYTE5 * Gets the fifth byte of something. */ #define RT_BYTE5(a) ( (uint8_t)(((a) >> 32) & 0xff) ) /** @def RT_BYTE6 * Gets the sixth byte of something. */ #define RT_BYTE6(a) ( (uint8_t)(((a) >> 40) & 0xff) ) /** @def RT_BYTE7 * Gets the seventh byte of something. */ #define RT_BYTE7(a) ( (uint8_t)(((a) >> 48) & 0xff) ) /** @def RT_BYTE8 * Gets the eight byte of something. */ #define RT_BYTE8(a) ( (uint8_t)(((a) >> 56) & 0xff) ) /** @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. */ #define RT_HIDWORD(a) ( (uint32_t)((a) >> 32) ) /** @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 high 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. */ #define RT_MAKE_U64(Lo, Hi) ( (uint64_t)((uint32_t)(Hi)) << 32 | (uint32_t)(Lo) ) /** @def RT_MAKE_U64_FROM_U16 * Constructs a uint64_t value from four uint16_t values. */ #define RT_MAKE_U64_FROM_U16(w0, w1, w2, w3) \ ((uint64_t)( (uint64_t)((uint16_t)(w3)) << 48 \ | (uint64_t)((uint16_t)(w2)) << 32 \ | (uint32_t)((uint16_t)(w1)) << 16 \ | (uint16_t)(w0) )) /** @def RT_MAKE_U64_FROM_U8 * Constructs a uint64_t value from eight uint8_t values. */ #define RT_MAKE_U64_FROM_U8(b0, b1, b2, b3, b4, b5, b6, b7) \ ((uint64_t)( (uint64_t)((uint8_t)(b7)) << 56 \ | (uint64_t)((uint8_t)(b6)) << 48 \ | (uint64_t)((uint8_t)(b5)) << 40 \ | (uint64_t)((uint8_t)(b4)) << 32 \ | (uint64_t)((uint8_t)(b3)) << 24 \ | (uint64_t)((uint8_t)(b2)) << 16 \ | (uint64_t)((uint8_t)(b1)) << 8 \ | (uint64_t) (uint8_t)(b0) )) /** @def RT_MAKE_U32 * Constructs a uint32_t value from two uint16_t values. */ #define RT_MAKE_U32(Lo, Hi) \ ((uint32_t)( (uint32_t)((uint16_t)(Hi)) << 16 \ | (uint16_t)(Lo) )) /** @def RT_MAKE_U32_FROM_U8 * Constructs a uint32_t value from four uint8_t values. */ #define RT_MAKE_U32_FROM_U8(b0, b1, b2, b3) \ ((uint32_t)( (uint32_t)((uint8_t)(b3)) << 24 \ | (uint32_t)((uint8_t)(b2)) << 16 \ | (uint32_t)((uint8_t)(b1)) << 8 \ | (uint8_t)(b0) )) /** @def RT_MAKE_U16 * Constructs a uint16_t value from two uint8_t values. */ #define RT_MAKE_U16(Lo, Hi) \ ((uint16_t)( (uint16_t)((uint8_t)(Hi)) << 8 \ | (uint8_t)(Lo) )) /** @def RT_BSWAP_U64 * Reverses the byte order of an uint64_t value. */ #if defined(__GNUC__) # define RT_BSWAP_U64(u64) (__builtin_constant_p((u64)) ? RT_BSWAP_U64_C(u64) : ASMByteSwapU64(u64)) #else # define RT_BSWAP_U64(u64) ASMByteSwapU64(u64) #endif /** @def RT_BSWAP_U32 * Reverses the byte order of an uint32_t value. */ #if defined(__GNUC__) # define RT_BSWAP_U32(u32) (__builtin_constant_p((u32)) ? RT_BSWAP_U32_C(u32) : ASMByteSwapU32(u32)) #else # define RT_BSWAP_U32(u32) ASMByteSwapU32(u32) #endif /** @def RT_BSWAP_U16 * Reverses the byte order of an uint16_t value. */ #if defined(__GNUC__) # define RT_BSWAP_U16(u16) (__builtin_constant_p((u16)) ? RT_BSWAP_U16_C(u16) : ASMByteSwapU16(u16)) #else # define RT_BSWAP_U16(u16) ASMByteSwapU16(u16) #endif /** @def RT_BSWAP_S64 * Reverses the byte order of an int64_t value. */ #define RT_BSWAP_S64(i64) ((int64_t)RT_BSWAP_U64((uint64_t)i64)) /** @def RT_BSWAP_S32 * Reverses the byte order of an int32_t value. */ #define RT_BSWAP_S32(i32) ((int32_t)RT_BSWAP_U32((uint32_t)i32)) /** @def RT_BSWAP_S16 * Reverses the byte order of an int16_t value. */ #define RT_BSWAP_S16(i16) ((int16_t)RT_BSWAP_U16((uint16_t)i16)) /** @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. */ #define RT_BSWAP_U16_C(u16) RT_MAKE_U16(RT_HIBYTE(u16), RT_LOBYTE(u16)) /** @def RT_BSWAP_S64_C * Reverses the byte order of an int64_t constant. */ #define RT_BSWAP_S64_C(i64) ((int64_t)RT_MAKE_U64(RT_BSWAP_U32_C((uint64_t)(i64) >> 32), RT_BSWAP_U32_C((uint32_t)(i64)))) /** @def RT_BSWAP_S32_C * Reverses the byte order of an int32_t constant. */ #define RT_BSWAP_S32_C(i32) ((int32_t)RT_MAKE_U32_FROM_U8(RT_BYTE4(i32), RT_BYTE3(i32), RT_BYTE2(i32), RT_BYTE1(i))) /** @def RT_BSWAP_S16_C * Reverses the byte order of an uint16_t constant. */ #define RT_BSWAP_S16_C(i16) ((int16_t)RT_MAKE_U16(RT_HIBYTE(i16), RT_LOBYTE(i16))) /** @name Host to/from little endian. * @note Typically requires iprt/asm.h to be included. * @{ */ /** @def RT_H2LE_U64 * Converts an uint64_t value from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_U64(u64) RT_BSWAP_U64(u64) #else # define RT_H2LE_U64(u64) (u64) #endif /** @def RT_H2LE_U64_C * Converts an uint64_t constant from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_U64_C(u64) RT_BSWAP_U64_C(u64) #else # define RT_H2LE_U64_C(u64) (u64) #endif /** @def RT_H2LE_U32 * Converts an uint32_t value from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_U32(u32) RT_BSWAP_U32(u32) #else # define RT_H2LE_U32(u32) (u32) #endif /** @def RT_H2LE_U32_C * Converts an uint32_t constant from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_U32_C(u32) RT_BSWAP_U32_C(u32) #else # define RT_H2LE_U32_C(u32) (u32) #endif /** @def RT_H2LE_U16 * Converts an uint16_t value from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_U16(u16) RT_BSWAP_U16(u16) #else # define RT_H2LE_U16(u16) (u16) #endif /** @def RT_H2LE_U16_C * Converts an uint16_t constant from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_U16_C(u16) RT_BSWAP_U16_C(u16) #else # define RT_H2LE_U16_C(u16) (u16) #endif /** @def RT_LE2H_U64 * Converts an uint64_t value from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_U64(u64) RT_BSWAP_U64(u64) #else # define RT_LE2H_U64(u64) (u64) #endif /** @def RT_LE2H_U64_C * Converts an uint64_t constant from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_U64_C(u64) RT_BSWAP_U64_C(u64) #else # define RT_LE2H_U64_C(u64) (u64) #endif /** @def RT_LE2H_U32 * Converts an uint32_t value from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_U32(u32) RT_BSWAP_U32(u32) #else # define RT_LE2H_U32(u32) (u32) #endif /** @def RT_LE2H_U32_C * Converts an uint32_t constant from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_U32_C(u32) RT_BSWAP_U32_C(u32) #else # define RT_LE2H_U32_C(u32) (u32) #endif /** @def RT_LE2H_U16 * Converts an uint16_t value from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_U16(u16) RT_BSWAP_U16(u16) #else # define RT_LE2H_U16(u16) (u16) #endif /** @def RT_LE2H_U16_C * Converts an uint16_t constant from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_U16_C(u16) RT_BSWAP_U16_C(u16) #else # define RT_LE2H_U16_C(u16) (u16) #endif /** @def RT_H2LE_S64 * Converts an int64_t value from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_S64(i64) RT_BSWAP_S64(i64) #else # define RT_H2LE_S64(i64) (i64) #endif /** @def RT_H2LE_S64_C * Converts an int64_t constant from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_S64_C(i64) RT_BSWAP_S64_C(i64) #else # define RT_H2LE_S64_C(i64) (i64) #endif /** @def RT_H2LE_S32 * Converts an int32_t value from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_S32(i32) RT_BSWAP_S32(i32) #else # define RT_H2LE_S32(i32) (i32) #endif /** @def RT_H2LE_S32_C * Converts an int32_t constant from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_S32_C(i32) RT_BSWAP_S32_C(i32) #else # define RT_H2LE_S32_C(i32) (i32) #endif /** @def RT_H2LE_S16 * Converts an int16_t value from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_S16(i16) RT_BSWAP_S16(i16) #else # define RT_H2LE_S16(i16) (i16) #endif /** @def RT_H2LE_S16_C * Converts an int16_t constant from host to little endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2LE_S16_C(i16) RT_BSWAP_S16_C(i16) #else # define RT_H2LE_S16_C(i16) (i16) #endif /** @def RT_LE2H_S64 * Converts an int64_t value from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_S64(i64) RT_BSWAP_S64(i64) #else # define RT_LE2H_S64(i64) (i64) #endif /** @def RT_LE2H_S64_C * Converts an int64_t constant from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_S64_C(i64) RT_BSWAP_S64_C(i64) #else # define RT_LE2H_S64_C(i64) (i64) #endif /** @def RT_LE2H_S32 * Converts an int32_t value from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_S32(i32) RT_BSWAP_S32(i32) #else # define RT_LE2H_S32(i32) (i32) #endif /** @def RT_LE2H_S32_C * Converts an int32_t constant from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_S32_C(i32) RT_BSWAP_S32_C(i32) #else # define RT_LE2H_S32_C(i32) (i32) #endif /** @def RT_LE2H_S16 * Converts an int16_t value from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_S16(i16) RT_BSWAP_S16(i16) #else # define RT_LE2H_S16(i16) (i16) #endif /** @def RT_LE2H_S16_C * Converts an int16_t constant from little endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_LE2H_S16_C(i16) RT_BSWAP_S16_C(i16) #else # define RT_LE2H_S16_C(i16) (i16) #endif /** @} */ /** @name Host to/from big endian. * @note Typically requires iprt/asm.h to be included. * @{ */ /** @def RT_H2BE_U64 * Converts an uint64_t value from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_U64(u64) (u64) #else # define RT_H2BE_U64(u64) RT_BSWAP_U64(u64) #endif /** @def RT_H2BE_U64_C * Converts an uint64_t constant from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_U64_C(u64) (u64) #else # define RT_H2BE_U64_C(u64) RT_BSWAP_U64_C(u64) #endif /** @def RT_H2BE_U32 * Converts an uint32_t value from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_U32(u32) (u32) #else # define RT_H2BE_U32(u32) RT_BSWAP_U32(u32) #endif /** @def RT_H2BE_U32_C * Converts an uint32_t constant from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_U32_C(u32) (u32) #else # define RT_H2BE_U32_C(u32) RT_BSWAP_U32_C(u32) #endif /** @def RT_H2BE_U16 * Converts an uint16_t value from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_U16(u16) (u16) #else # define RT_H2BE_U16(u16) RT_BSWAP_U16(u16) #endif /** @def RT_H2BE_U16_C * Converts an uint16_t constant from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_U16_C(u16) (u16) #else # define RT_H2BE_U16_C(u16) RT_BSWAP_U16_C(u16) #endif /** @def RT_BE2H_U64 * Converts an uint64_t value from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_U64(u64) (u64) #else # define RT_BE2H_U64(u64) RT_BSWAP_U64(u64) #endif /** @def RT_BE2H_U64 * Converts an uint64_t constant from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_U64_C(u64) (u64) #else # define RT_BE2H_U64_C(u64) RT_BSWAP_U64_C(u64) #endif /** @def RT_BE2H_U32 * Converts an uint32_t value from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_U32(u32) (u32) #else # define RT_BE2H_U32(u32) RT_BSWAP_U32(u32) #endif /** @def RT_BE2H_U32_C * Converts an uint32_t value from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_U32_C(u32) (u32) #else # define RT_BE2H_U32_C(u32) RT_BSWAP_U32_C(u32) #endif /** @def RT_BE2H_U16 * Converts an uint16_t value from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_U16(u16) (u16) #else # define RT_BE2H_U16(u16) RT_BSWAP_U16(u16) #endif /** @def RT_BE2H_U16_C * Converts an uint16_t constant from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_U16_C(u16) (u16) #else # define RT_BE2H_U16_C(u16) RT_BSWAP_U16_C(u16) #endif /** @def RT_H2BE_S64 * Converts an int64_t value from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_S64(i64) (i64) #else # define RT_H2BE_S64(i64) RT_BSWAP_S64(i64) #endif /** @def RT_H2BE_S64_C * Converts an int64_t constant from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_S64_C(i64) (i64) #else # define RT_H2BE_S64_C(i64) RT_BSWAP_S64_C(i64) #endif /** @def RT_H2BE_S32 * Converts an int32_t value from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_S32(i32) (i32) #else # define RT_H2BE_S32(i32) RT_BSWAP_S32(i32) #endif /** @def RT_H2BE_S32_C * Converts an int32_t constant from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_S32_C(i32) (i32) #else # define RT_H2BE_S32_C(i32) RT_BSWAP_S32_C(i32) #endif /** @def RT_H2BE_S16 * Converts an int16_t value from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_S16(i16) (i16) #else # define RT_H2BE_S16(i16) RT_BSWAP_S16(i16) #endif /** @def RT_H2BE_S16_C * Converts an int16_t constant from host to big endian byte order. */ #ifdef RT_BIG_ENDIAN # define RT_H2BE_S16_C(i16) (i16) #else # define RT_H2BE_S16_C(i16) RT_BSWAP_S16_C(i16) #endif /** @def RT_BE2H_S64 * Converts an int64_t value from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_S64(i64) (i64) #else # define RT_BE2H_S64(i64) RT_BSWAP_S64(i64) #endif /** @def RT_BE2H_S64 * Converts an int64_t constant from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_S64_C(i64) (i64) #else # define RT_BE2H_S64_C(i64) RT_BSWAP_S64_C(i64) #endif /** @def RT_BE2H_S32 * Converts an int32_t value from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_S32(i32) (i32) #else # define RT_BE2H_S32(i32) RT_BSWAP_S32(i32) #endif /** @def RT_BE2H_S32_C * Converts an int32_t value from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_S32_C(i32) (i32) #else # define RT_BE2H_S32_C(i32) RT_BSWAP_S32_C(i32) #endif /** @def RT_BE2H_S16 * Converts an int16_t value from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_S16(i16) (i16) #else # define RT_BE2H_S16(i16) RT_BSWAP_S16(i16) #endif /** @def RT_BE2H_S16_C * Converts an int16_t constant from big endian to host byte order. */ #ifdef RT_BIG_ENDIAN # define RT_BE2H_S16_C(i16) (i16) #else # define RT_BE2H_S16_C(i16) RT_BSWAP_S16_C(i16) #endif /** @} */ /** @name Host to/from network byte order. * @note Typically requires iprt/asm.h to be included. * @{ */ /** @def RT_H2N_U64 * Converts an uint64_t value from host to network byte order. */ #define RT_H2N_U64(u64) RT_H2BE_U64(u64) /** @def RT_H2N_U64_C * Converts an uint64_t constant from host to network byte order. */ #define RT_H2N_U64_C(u64) RT_H2BE_U64_C(u64) /** @def RT_H2N_U32 * Converts an uint32_t value from host to network byte order. */ #define RT_H2N_U32(u32) RT_H2BE_U32(u32) /** @def RT_H2N_U32_C * Converts an uint32_t constant from host to network byte order. */ #define RT_H2N_U32_C(u32) RT_H2BE_U32_C(u32) /** @def RT_H2N_U16 * Converts an uint16_t value from host to network byte order. */ #define RT_H2N_U16(u16) RT_H2BE_U16(u16) /** @def RT_H2N_U16_C * Converts an uint16_t constant from host to network byte order. */ #define RT_H2N_U16_C(u16) RT_H2BE_U16_C(u16) /** @def RT_N2H_U64 * Converts an uint64_t value from network to host byte order. */ #define RT_N2H_U64(u64) RT_BE2H_U64(u64) /** @def RT_N2H_U64_C * Converts an uint64_t constant from network to host byte order. */ #define RT_N2H_U64_C(u64) RT_BE2H_U64_C(u64) /** @def RT_N2H_U32 * Converts an uint32_t value from network to host byte order. */ #define RT_N2H_U32(u32) RT_BE2H_U32(u32) /** @def RT_N2H_U32_C * Converts an uint32_t constant from network to host byte order. */ #define RT_N2H_U32_C(u32) RT_BE2H_U32_C(u32) /** @def RT_N2H_U16 * Converts an uint16_t value from network to host byte order. */ #define RT_N2H_U16(u16) RT_BE2H_U16(u16) /** @def RT_N2H_U16_C * Converts an uint16_t value from network to host byte order. */ #define RT_N2H_U16_C(u16) RT_BE2H_U16_C(u16) /** @def RT_H2N_S64 * Converts an int64_t value from host to network byte order. */ #define RT_H2N_S64(i64) RT_H2BE_S64(i64) /** @def RT_H2N_S64_C * Converts an int64_t constant from host to network byte order. */ #define RT_H2N_S64_C(i64) RT_H2BE_S64_C(i64) /** @def RT_H2N_S32 * Converts an int32_t value from host to network byte order. */ #define RT_H2N_S32(i32) RT_H2BE_S32(i32) /** @def RT_H2N_S32_C * Converts an int32_t constant from host to network byte order. */ #define RT_H2N_S32_C(i32) RT_H2BE_S32_C(i32) /** @def RT_H2N_S16 * Converts an int16_t value from host to network byte order. */ #define RT_H2N_S16(i16) RT_H2BE_S16(i16) /** @def RT_H2N_S16_C * Converts an int16_t constant from host to network byte order. */ #define RT_H2N_S16_C(i16) RT_H2BE_S16_C(i16) /** @def RT_N2H_S64 * Converts an int64_t value from network to host byte order. */ #define RT_N2H_S64(i64) RT_BE2H_S64(i64) /** @def RT_N2H_S64_C * Converts an int64_t constant from network to host byte order. */ #define RT_N2H_S64_C(i64) RT_BE2H_S64_C(i64) /** @def RT_N2H_S32 * Converts an int32_t value from network to host byte order. */ #define RT_N2H_S32(i32) RT_BE2H_S32(i32) /** @def RT_N2H_S32_C * Converts an int32_t constant from network to host byte order. */ #define RT_N2H_S32_C(i32) RT_BE2H_S32_C(i32) /** @def RT_N2H_S16 * Converts an int16_t value from network to host byte order. */ #define RT_N2H_S16(i16) RT_BE2H_S16(i16) /** @def RT_N2H_S16_C * Converts an int16_t value from network to host byte order. */ #define RT_N2H_S16_C(i16) RT_BE2H_S16_C(i16) /** @} */ /* * The BSD sys/param.h + machine/param.h file is a major source of * 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_) ) /* sys/param.h: */ # undef PSWP # undef PVM # undef PINOD # undef PRIBO # undef PVFS # undef PZERO # undef PSOCK # undef PWAIT # undef PLOCK # undef PPAUSE # undef PUSER # undef PRIMASK # undef MINBUCKET # undef MAXALLOCSAVE # undef FSHIFT # undef FSCALE /* i386/machine.h: */ # undef ALIGN # undef ALIGNBYTES # undef DELAY # undef STATUS_WORD # undef USERMODE # undef BASEPRI # undef MSIZE # undef CLSIZE # undef CLSIZELOG2 #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, local variable, * or other stuff, will never use _Pragma are is thus more flexible. */ #define NOREF(var) (void)(var) /** @def RT_NOREF_PV * Keeps the compiler from bitching about an unused parameter or local variable. * This one cannot be used with structure members and such, like for instance * AssertRC may end up doing due to its generic nature. */ #if defined(__cplusplus) && RT_CLANG_PREREQ(6, 0) # define RT_NOREF_PV(var) _Pragma(RT_STR(unused(var))) #else # define RT_NOREF_PV(var) (void)(var) #endif /** @def RT_NOREF1 * RT_NOREF_PV shorthand taking on parameter. */ #define RT_NOREF1(var1) RT_NOREF_PV(var1) /** @def RT_NOREF2 * RT_NOREF_PV shorthand taking two parameters. */ #define RT_NOREF2(var1, var2) RT_NOREF_PV(var1); RT_NOREF1(var2) /** @def RT_NOREF3 * RT_NOREF_PV shorthand taking three parameters. */ #define RT_NOREF3(var1, var2, var3) RT_NOREF_PV(var1); RT_NOREF2(var2, var3) /** @def RT_NOREF4 * RT_NOREF_PV shorthand taking four parameters. */ #define RT_NOREF4(var1, var2, var3, var4) RT_NOREF_PV(var1); RT_NOREF3(var2, var3, var4) /** @def RT_NOREF5 * RT_NOREF_PV shorthand taking five parameters. */ #define RT_NOREF5(var1, var2, var3, var4, var5) RT_NOREF_PV(var1); RT_NOREF4(var2, var3, var4, var5) /** @def RT_NOREF6 * RT_NOREF_PV shorthand taking six parameters. */ #define RT_NOREF6(var1, var2, var3, var4, var5, var6) RT_NOREF_PV(var1); RT_NOREF5(var2, var3, var4, var5, var6) /** @def RT_NOREF7 * RT_NOREF_PV shorthand taking seven parameters. */ #define RT_NOREF7(var1, var2, var3, var4, var5, var6, var7) \ RT_NOREF_PV(var1); RT_NOREF6(var2, var3, var4, var5, var6, var7) /** @def RT_NOREF8 * RT_NOREF_PV shorthand taking eight parameters. */ #define RT_NOREF8(var1, var2, var3, var4, var5, var6, var7, var8) \ RT_NOREF_PV(var1); RT_NOREF7(var2, var3, var4, var5, var6, var7, var8) /** @def RT_NOREF9 * RT_NOREF_PV shorthand taking nine parameters. */ #define RT_NOREF9(var1, var2, var3, var4, var5, var6, var7, var8, var9) \ RT_NOREF_PV(var1); RT_NOREF8(var2, var3, var4, var5, var6, var7, var8, var9) /** @def RT_NOREF10 * RT_NOREF_PV shorthand taking ten parameters. */ #define RT_NOREF10(var1, var2, var3, var4, var5, var6, var7, var8, var9, var10) \ RT_NOREF_PV(var1); RT_NOREF_PV(var2); RT_NOREF_PV(var3); RT_NOREF_PV(var4); RT_NOREF_PV(var5); RT_NOREF_PV(var6); \ RT_NOREF_PV(var7); RT_NOREF_PV(var8); RT_NOREF_PV(var9); RT_NOREF_PV(var10) /** @def RT_NOREF11 * RT_NOREF_PV shorthand taking eleven parameters. */ #define RT_NOREF11(var1, var2, var3, var4, var5, var6, var7, var8, var9, var10, var11) \ RT_NOREF_PV(var1); RT_NOREF10(var2, var3, var4, var5, var6, var7, var8, var9, var10, var11) /** @def RT_NOREF12 * RT_NOREF_PV shorthand taking twelve parameters. */ #define RT_NOREF12(var1, var2, var3, var4, var5, var6, var7, var8, var9, var10, var11, var12) \ RT_NOREF_PV(var1); RT_NOREF11(var2, var3, var4, var5, var6, var7, var8, var9, var10, var11, var12) /** @def RT_NOREF13 * RT_NOREF_PV shorthand taking thirteen parameters. */ #define RT_NOREF13(var1, var2, var3, var4, var5, var6, var7, var8, var9, var10, var11, var12, var13) \ RT_NOREF_PV(var1); RT_NOREF12(var2, var3, var4, var5, var6, var7, var8, var9, var10, var11, var12, var13) /** @def RT_NOREF14 * RT_NOREF_PV shorthand taking fourteen parameters. */ #define RT_NOREF14(var1, var2, var3, var4, var5, var6, var7, var8, var9, var10, var11, var12, var13, var14) \ RT_NOREF_PV(var1); RT_NOREF13(var2, var3, var4, var5, var6, var7, var8, var9, var10, var11, var12, var13, var14) /** @def RT_NOREF15 * RT_NOREF_PV shorthand taking fifteen parameters. */ #define RT_NOREF15(var1, var2, var3, var4, var5, var6, var7, var8, var9, var10, var11, var12, var13, var14, var15) \ RT_NOREF_PV(var1); RT_NOREF14(var2, var3, var4, var5, var6, var7, var8, var9, var10, var11, var12, var13, var14, var15) /** @def RT_NOREF16 * RT_NOREF_PV shorthand taking fifteen parameters. */ #define RT_NOREF16(var1, var2, var3, var4, var5, var6, var7, var8, var9, var10, var11, var12, var13, var14, var15, var16) \ RT_NOREF_PV(var1); RT_NOREF15(var2, var3, var4, var5, var6, var7, var8, var9, var10, var11, var12, var13, var14, var15, var16) /** @def RT_NOREF17 * RT_NOREF_PV shorthand taking seventeen parameters. */ #define RT_NOREF17(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17) \ RT_NOREF_PV(v1); RT_NOREF16(v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17) /** @def RT_NOREF18 * RT_NOREF_PV shorthand taking eighteen parameters. */ #define RT_NOREF18(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18) \ RT_NOREF_PV(v1); RT_NOREF17(v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18) /** @def RT_NOREF19 * RT_NOREF_PV shorthand taking nineteen parameters. */ #define RT_NOREF19(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19) \ RT_NOREF_PV(v1); RT_NOREF18(v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19) /** @def RT_NOREF20 * RT_NOREF_PV shorthand taking twenty parameters. */ #define RT_NOREF20(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20) \ RT_NOREF_PV(v1); RT_NOREF19(v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20) /** @def RT_NOREF21 * RT_NOREF_PV shorthand taking twentyone parameters. */ #define RT_NOREF21(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21) \ RT_NOREF_PV(v1); RT_NOREF20(v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21) /** @def RT_NOREF22 * RT_NOREF_PV shorthand taking twentytwo parameters. */ #define RT_NOREF22(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22) \ RT_NOREF_PV(v1); RT_NOREF21(v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22) /** @def RT_NOREF * RT_NOREF_PV variant using the variadic macro feature of C99. * @remarks Only use this in sources */ #ifdef RT_COMPILER_SUPPORTS_VA_ARGS # define RT_NOREF(...) \ RT_UNPACK_CALL(RT_CONCAT(RT_NOREF, RT_EXPAND(RT_COUNT_VA_ARGS(__VA_ARGS__))),(__VA_ARGS__)) #endif /** @def RT_BREAKPOINT * Emit a debug breakpoint instruction. * * @remarks In the x86/amd64 gnu world we add a nop instruction after the int3 * 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 * x86/amd64. */ #ifdef __GNUC__ # if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86) # if !defined(__L4ENV__) # define RT_BREAKPOINT() __asm__ __volatile__("int $3\n\tnop\n\t") # else # define RT_BREAKPOINT() __asm__ __volatile__("int3; jmp 1f; 1:\n\t") # 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). */ # elif defined(RT_ARCH_ARM32) || defined(RT_ARCH_ARM64) # define RT_BREAKPOINT() __asm__ __volatile__("brk #0x1\n\t") # endif #endif #ifdef _MSC_VER # define RT_BREAKPOINT() __debugbreak() #endif #if defined(__IBMC__) || defined(__IBMCPP__) # define RT_BREAKPOINT() __interrupt(3) #endif #if defined(__WATCOMC__) # define RT_BREAKPOINT() _asm { int 3 } #endif #ifndef RT_BREAKPOINT # error "This compiler/arch is not supported!" #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 768). */ #define _32K 0x00008000 /** 64 K (Kilo) (65 536). */ #if ARCH_BITS != 16 # define _64K 0x00010000 #else # define _64K UINT32_C(0x00010000) #endif /** 128 K (Kilo) (131 072). */ #if ARCH_BITS != 16 # define _128K 0x00020000 #else # define _128K UINT32_C(0x00020000) #endif /** 256 K (Kilo) (262 144). */ #if ARCH_BITS != 16 # define _256K 0x00040000 #else # define _256K UINT32_C(0x00040000) #endif /** 512 K (Kilo) (524 288). */ #if ARCH_BITS != 16 # define _512K 0x00080000 #else # define _512K UINT32_C(0x00080000) #endif /** 1 M (Mega) (1 048 576). */ #if ARCH_BITS != 16 # define _1M 0x00100000 #else # define _1M UINT32_C(0x00100000) #endif /** 2 M (Mega) (2 097 152). */ #if ARCH_BITS != 16 # define _2M 0x00200000 #else # define _2M UINT32_C(0x00200000) #endif /** 4 M (Mega) (4 194 304). */ #if ARCH_BITS != 16 # define _4M 0x00400000 #else # define _4M UINT32_C(0x00400000) #endif /** 8 M (Mega) (8 388 608). */ #define _8M UINT32_C(0x00800000) /** 16 M (Mega) (16 777 216). */ #define _16M UINT32_C(0x01000000) /** 32 M (Mega) (33 554 432). */ #define _32M UINT32_C(0x02000000) /** 64 M (Mega) (67 108 864). */ #define _64M UINT32_C(0x04000000) /** 128 M (Mega) (134 217 728). */ #define _128M UINT32_C(0x08000000) /** 256 M (Mega) (268 435 456). */ #define _256M UINT32_C(0x10000000) /** 512 M (Mega) (536 870 912). */ #define _512M UINT32_C(0x20000000) /** 1 G (Giga) (1 073 741 824). (32-bit) */ #if ARCH_BITS != 16 # define _1G 0x40000000 #else # define _1G UINT32_C(0x40000000) #endif /** 1 G (Giga) (1 073 741 824). (64-bit) */ #if ARCH_BITS != 16 # define _1G64 0x40000000LL #else # define _1G64 UINT64_C(0x40000000) #endif /** 2 G (Giga) (2 147 483 648). (32-bit) */ #define _2G32 UINT32_C(0x80000000) /** 2 G (Giga) (2 147 483 648). (64-bit) */ #if ARCH_BITS != 16 # define _2G 0x0000000080000000LL #else # define _2G UINT64_C(0x0000000080000000) #endif /** 4 G (Giga) (4 294 967 296). */ #if ARCH_BITS != 16 # define _4G 0x0000000100000000LL #else # define _4G UINT64_C(0x0000000100000000) #endif /** 1 T (Tera) (1 099 511 627 776). */ #if ARCH_BITS != 16 # define _1T 0x0000010000000000LL #else # define _1T UINT64_C(0x0000010000000000) #endif /** 1 P (Peta) (1 125 899 906 842 624). */ #if ARCH_BITS != 16 # define _1P 0x0004000000000000LL #else # define _1P UINT64_C(0x0004000000000000) #endif /** 1 E (Exa) (1 152 921 504 606 846 976). */ #if ARCH_BITS != 16 # define _1E 0x1000000000000000LL #else # define _1E UINT64_C(0x1000000000000000) #endif /** 2 E (Exa) (2 305 843 009 213 693 952). */ #if ARCH_BITS != 16 # define _2E 0x2000000000000000ULL #else # define _2E UINT64_C(0x2000000000000000) #endif /** @} */ /** @defgroup grp_rt_cdefs_decimal_grouping Decimal Constant Grouping Macros * @{ */ #define RT_D1(g1) g1 #define RT_D2(g1, g2) g1#g2 #define RT_D3(g1, g2, g3) g1#g2#g3 #define RT_D4(g1, g2, g3, g4) g1#g2#g3#g4 #define RT_D5(g1, g2, g3, g4, g5) g1#g2#g3#g4#g5 #define RT_D6(g1, g2, g3, g4, g5, g6) g1#g2#g3#g4#g5#g6 #define RT_D7(g1, g2, g3, g4, g5, g6, g7) g1#g2#g3#g4#g5#g6#g7 #define RT_D1_U(g1) UINT32_C(g1) #define RT_D2_U(g1, g2) UINT32_C(g1#g2) #define RT_D3_U(g1, g2, g3) UINT32_C(g1#g2#g3) #define RT_D4_U(g1, g2, g3, g4) UINT64_C(g1#g2#g3#g4) #define RT_D5_U(g1, g2, g3, g4, g5) UINT64_C(g1#g2#g3#g4#g5) #define RT_D6_U(g1, g2, g3, g4, g5, g6) UINT64_C(g1#g2#g3#g4#g5#g6) #define RT_D7_U(g1, g2, g3, g4, g5, g6, g7) UINT64_C(g1#g2#g3#g4#g5#g6#g7) #define RT_D1_S(g1) INT32_C(g1) #define RT_D2_S(g1, g2) INT32_C(g1#g2) #define RT_D3_S(g1, g2, g3) INT32_C(g1#g2#g3) #define RT_D4_S(g1, g2, g3, g4) INT64_C(g1#g2#g3#g4) #define RT_D5_S(g1, g2, g3, g4, g5) INT64_C(g1#g2#g3#g4#g5) #define RT_D6_S(g1, g2, g3, g4, g5, g6) INT64_C(g1#g2#g3#g4#g5#g6) #define RT_D7_S(g1, g2, g3, g4, g5, g6, g7) INT64_C(g1#g2#g3#g4#g5#g6#g7) #define RT_D1_U32(g1) UINT32_C(g1) #define RT_D2_U32(g1, g2) UINT32_C(g1#g2) #define RT_D3_U32(g1, g2, g3) UINT32_C(g1#g2#g3) #define RT_D4_U32(g1, g2, g3, g4) UINT32_C(g1#g2#g3#g4) #define RT_D1_S32(g1) INT32_C(g1) #define RT_D2_S32(g1, g2) INT32_C(g1#g2) #define RT_D3_S32(g1, g2, g3) INT32_C(g1#g2#g3) #define RT_D4_S32(g1, g2, g3, g4) INT32_C(g1#g2#g3#g4) #define RT_D1_U64(g1) UINT64_C(g1) #define RT_D2_U64(g1, g2) UINT64_C(g1#g2) #define RT_D3_U64(g1, g2, g3) UINT64_C(g1#g2#g3) #define RT_D4_U64(g1, g2, g3, g4) UINT64_C(g1#g2#g3#g4) #define RT_D5_U64(g1, g2, g3, g4, g5) UINT64_C(g1#g2#g3#g4#g5) #define RT_D6_U64(g1, g2, g3, g4, g5, g6) UINT64_C(g1#g2#g3#g4#g5#g6) #define RT_D7_U64(g1, g2, g3, g4, g5, g6, g7) UINT64_C(g1#g2#g3#g4#g5#g6#g7) #define RT_D1_S64(g1) INT64_C(g1) #define RT_D2_S64(g1, g2) INT64_C(g1#g2) #define RT_D3_S64(g1, g2, g3) INT64_C(g1#g2#g3) #define RT_D4_S64(g1, g2, g3, g4) INT64_C(g1#g2#g3#g4) #define RT_D5_S64(g1, g2, g3, g4, g5) INT64_C(g1#g2#g3#g4#g5) #define RT_D6_S64(g1, g2, g3, g4, g5, g6) INT64_C(g1#g2#g3#g4#g5#g6) #define RT_D7_S64(g1, g2, g3, g4, g5, g6, g7) INT64_C(g1#g2#g3#g4#g5#g6#g7) /** @} */ /** @defgroup grp_rt_cdefs_time Time Constants * @{ */ /** 1 week expressed in nanoseconds (64-bit). */ #define RT_NS_1WEEK UINT64_C(604800000000000) /** 1 day expressed in nanoseconds (64-bit). */ #define RT_NS_1DAY UINT64_C(86400000000000) /** 1 hour expressed in nanoseconds (64-bit). */ #define RT_NS_1HOUR UINT64_C(3600000000000) /** 30 minutes expressed in nanoseconds (64-bit). */ #define RT_NS_30MIN UINT64_C(1800000000000) /** 5 minutes expressed in nanoseconds (64-bit). */ #define RT_NS_5MIN UINT64_C(300000000000) /** 1 minute expressed in nanoseconds (64-bit). */ #define RT_NS_1MIN UINT64_C(60000000000) /** 45 seconds expressed in nanoseconds (64-bit). */ #define RT_NS_45SEC UINT64_C(45000000000) /** 30 seconds expressed in nanoseconds (64-bit). */ #define RT_NS_30SEC UINT64_C(30000000000) /** 20 seconds expressed in nanoseconds (64-bit). */ #define RT_NS_20SEC UINT64_C(20000000000) /** 15 seconds expressed in nanoseconds (64-bit). */ #define RT_NS_15SEC UINT64_C(15000000000) /** 10 seconds expressed in nanoseconds (64-bit). */ #define RT_NS_10SEC UINT64_C(10000000000) /** 1 second expressed in nanoseconds. */ #define RT_NS_1SEC UINT32_C(1000000000) /** 100 millsecond expressed in nanoseconds. */ #define RT_NS_100MS UINT32_C(100000000) /** 10 millsecond expressed in nanoseconds. */ #define RT_NS_10MS UINT32_C(10000000) /** 8 millsecond expressed in nanoseconds. */ #define RT_NS_8MS UINT32_C(8000000) /** 2 millsecond expressed in nanoseconds. */ #define RT_NS_2MS UINT32_C(2000000) /** 1 millsecond expressed in nanoseconds. */ #define RT_NS_1MS UINT32_C(1000000) /** 100 microseconds expressed in nanoseconds. */ #define RT_NS_100US UINT32_C(100000) /** 10 microseconds expressed in nanoseconds. */ #define RT_NS_10US UINT32_C(10000) /** 1 microsecond expressed in nanoseconds. */ #define RT_NS_1US UINT32_C(1000) /** 1 second expressed in nanoseconds - 64-bit type. */ #define RT_NS_1SEC_64 UINT64_C(1000000000) /** 100 millsecond expressed in nanoseconds - 64-bit type. */ #define RT_NS_100MS_64 UINT64_C(100000000) /** 10 millsecond expressed in nanoseconds - 64-bit type. */ #define RT_NS_10MS_64 UINT64_C(10000000) /** 1 millsecond expressed in nanoseconds - 64-bit type. */ #define RT_NS_1MS_64 UINT64_C(1000000) /** 100 microseconds expressed in nanoseconds - 64-bit type. */ #define RT_NS_100US_64 UINT64_C(100000) /** 10 microseconds expressed in nanoseconds - 64-bit type. */ #define RT_NS_10US_64 UINT64_C(10000) /** 1 microsecond expressed in nanoseconds - 64-bit type. */ #define RT_NS_1US_64 UINT64_C(1000) /** 1 week expressed in microseconds (64-bit). */ #define RT_US_1WEEK UINT64_C(604800000000) /** 1 day expressed in microseconds (64-bit). */ #define RT_US_1DAY UINT64_C(86400000000) /** 1 hour expressed in microseconds. */ #define RT_US_1HOUR UINT32_C(3600000000) /** 30 minutes expressed in microseconds. */ #define RT_US_30MIN UINT32_C(1800000000) /** 5 minutes expressed in microseconds. */ #define RT_US_5MIN UINT32_C(300000000) /** 1 minute expressed in microseconds. */ #define RT_US_1MIN UINT32_C(60000000) /** 45 seconds expressed in microseconds. */ #define RT_US_45SEC UINT32_C(45000000) /** 30 seconds expressed in microseconds. */ #define RT_US_30SEC UINT32_C(30000000) /** 20 seconds expressed in microseconds. */ #define RT_US_20SEC UINT32_C(20000000) /** 15 seconds expressed in microseconds. */ #define RT_US_15SEC UINT32_C(15000000) /** 10 seconds expressed in microseconds. */ #define RT_US_10SEC UINT32_C(10000000) /** 5 seconds expressed in microseconds. */ #define RT_US_5SEC UINT32_C(5000000) /** 1 second expressed in microseconds. */ #define RT_US_1SEC UINT32_C(1000000) /** 100 millsecond expressed in microseconds. */ #define RT_US_100MS UINT32_C(100000) /** 10 millsecond expressed in microseconds. */ #define RT_US_10MS UINT32_C(10000) /** 1 millsecond expressed in microseconds. */ #define RT_US_1MS UINT32_C(1000) /** 1 hour expressed in microseconds - 64-bit type. */ #define RT_US_1HOUR_64 UINT64_C(3600000000) /** 30 minutes expressed in microseconds - 64-bit type. */ #define RT_US_30MIN_64 UINT64_C(1800000000) /** 5 minutes expressed in microseconds - 64-bit type. */ #define RT_US_5MIN_64 UINT64_C(300000000) /** 1 minute expressed in microseconds - 64-bit type. */ #define RT_US_1MIN_64 UINT64_C(60000000) /** 45 seconds expressed in microseconds - 64-bit type. */ #define RT_US_45SEC_64 UINT64_C(45000000) /** 30 seconds expressed in microseconds - 64-bit type. */ #define RT_US_30SEC_64 UINT64_C(30000000) /** 20 seconds expressed in microseconds - 64-bit type. */ #define RT_US_20SEC_64 UINT64_C(20000000) /** 15 seconds expressed in microseconds - 64-bit type. */ #define RT_US_15SEC_64 UINT64_C(15000000) /** 10 seconds expressed in microseconds - 64-bit type. */ #define RT_US_10SEC_64 UINT64_C(10000000) /** 5 seconds expressed in microseconds - 64-bit type. */ #define RT_US_5SEC_64 UINT64_C(5000000) /** 1 second expressed in microseconds - 64-bit type. */ #define RT_US_1SEC_64 UINT64_C(1000000) /** 100 millsecond expressed in microseconds - 64-bit type. */ #define RT_US_100MS_64 UINT64_C(100000) /** 10 millsecond expressed in microseconds - 64-bit type. */ #define RT_US_10MS_64 UINT64_C(10000) /** 1 millsecond expressed in microseconds - 64-bit type. */ #define RT_US_1MS_64 UINT64_C(1000) /** 1 week expressed in milliseconds. */ #define RT_MS_1WEEK UINT32_C(604800000) /** 1 day expressed in milliseconds. */ #define RT_MS_1DAY UINT32_C(86400000) /** 1 hour expressed in milliseconds. */ #define RT_MS_1HOUR UINT32_C(3600000) /** 30 minutes expressed in milliseconds. */ #define RT_MS_30MIN UINT32_C(1800000) /** 5 minutes expressed in milliseconds. */ #define RT_MS_5MIN UINT32_C(300000) /** 1 minute expressed in milliseconds. */ #define RT_MS_1MIN UINT32_C(60000) /** 45 seconds expressed in milliseconds. */ #define RT_MS_45SEC UINT32_C(45000) /** 30 seconds expressed in milliseconds. */ #define RT_MS_30SEC UINT32_C(30000) /** 20 seconds expressed in milliseconds. */ #define RT_MS_20SEC UINT32_C(20000) /** 15 seconds expressed in milliseconds. */ #define RT_MS_15SEC UINT32_C(15000) /** 10 seconds expressed in milliseconds. */ #define RT_MS_10SEC UINT32_C(10000) /** 5 seconds expressed in milliseconds. */ #define RT_MS_5SEC UINT32_C(5000) /** 1 second expressed in milliseconds. */ #define RT_MS_1SEC UINT32_C(1000) /** 1 week expressed in milliseconds - 64-bit type. */ #define RT_MS_1WEEK_64 UINT64_C(604800000) /** 1 day expressed in milliseconds - 64-bit type. */ #define RT_MS_1DAY_64 UINT64_C(86400000) /** 1 hour expressed in milliseconds - 64-bit type. */ #define RT_MS_1HOUR_64 UINT64_C(3600000) /** 30 minutes expressed in milliseconds - 64-bit type. */ #define RT_MS_30MIN_64 UINT64_C(1800000) /** 5 minutes expressed in milliseconds - 64-bit type. */ #define RT_MS_5MIN_64 UINT64_C(300000) /** 1 minute expressed in milliseconds - 64-bit type. */ #define RT_MS_1MIN_64 UINT64_C(60000) /** 45 seconds expressed in milliseconds - 64-bit type. */ #define RT_MS_45SEC_64 UINT64_C(45000) /** 30 seconds expressed in milliseconds - 64-bit type. */ #define RT_MS_30SEC_64 UINT64_C(30000) /** 20 seconds expressed in milliseconds - 64-bit type. */ #define RT_MS_20SEC_64 UINT64_C(20000) /** 15 seconds expressed in milliseconds - 64-bit type. */ #define RT_MS_15SEC_64 UINT64_C(15000) /** 10 seconds expressed in milliseconds - 64-bit type. */ #define RT_MS_10SEC_64 UINT64_C(10000) /** 5 seconds expressed in milliseconds - 64-bit type. */ #define RT_MS_5SEC_64 UINT64_C(5000) /** 1 second expressed in milliseconds - 64-bit type. */ #define RT_MS_1SEC_64 UINT64_C(1000) /** The number of seconds per week. */ #define RT_SEC_1WEEK UINT32_C(604800) /** The number of seconds per day. */ #define RT_SEC_1DAY UINT32_C(86400) /** The number of seconds per hour. */ #define RT_SEC_1HOUR UINT32_C(3600) /** The number of seconds per week - 64-bit type. */ #define RT_SEC_1WEEK_64 UINT64_C(604800) /** The number of seconds per day - 64-bit type. */ #define RT_SEC_1DAY_64 UINT64_C(86400) /** The number of seconds per hour - 64-bit type. */ #define RT_SEC_1HOUR_64 UINT64_C(3600) /** @} */ /** @defgroup grp_rt_cdefs_dbgtype Debug Info Types * @{ */ /** Other format. */ #define RT_DBGTYPE_OTHER RT_BIT_32(0) /** Stabs. */ #define RT_DBGTYPE_STABS RT_BIT_32(1) /** Debug With Arbitrary Record Format (DWARF). */ #define RT_DBGTYPE_DWARF RT_BIT_32(2) /** Microsoft Codeview debug info. */ #define RT_DBGTYPE_CODEVIEW RT_BIT_32(3) /** Watcom debug info. */ #define RT_DBGTYPE_WATCOM RT_BIT_32(4) /** IBM High Level Language debug info. */ #define RT_DBGTYPE_HLL RT_BIT_32(5) /** Old OS/2 and Windows symbol file. */ #define RT_DBGTYPE_SYM RT_BIT_32(6) /** Map file. */ #define RT_DBGTYPE_MAP RT_BIT_32(7) /** @} */ /** @defgroup grp_rt_cdefs_exetype Executable Image Types * @{ */ /** Some other format. */ #define RT_EXETYPE_OTHER RT_BIT_32(0) /** Portable Executable. */ #define RT_EXETYPE_PE RT_BIT_32(1) /** Linear eXecutable. */ #define RT_EXETYPE_LX RT_BIT_32(2) /** Linear Executable. */ #define RT_EXETYPE_LE RT_BIT_32(3) /** New Executable. */ #define RT_EXETYPE_NE RT_BIT_32(4) /** DOS Executable (Mark Zbikowski). */ #define RT_EXETYPE_MZ RT_BIT_32(5) /** COM Executable. */ #define RT_EXETYPE_COM RT_BIT_32(6) /** a.out Executable. */ #define RT_EXETYPE_AOUT RT_BIT_32(7) /** Executable and Linkable Format. */ #define RT_EXETYPE_ELF RT_BIT_32(8) /** Mach-O Executable (including FAT ones). */ #define RT_EXETYPE_MACHO RT_BIT_32(9) /** TE from UEFI. */ #define RT_EXETYPE_TE RT_BIT_32(9) /** @} */ /** @def RT_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. */ # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= _4G \ && !((uintptr_t)(ptr) & 0xffff800000000000ULL) ) # elif defined(RT_OS_SOLARIS) /* The kernel only used the top 2TB, but keep it simple. */ # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \ && ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \ || ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) ) # elif defined(RT_OS_LINUX) /* May use 5-level paging (see Documentation/x86/x86_64/mm.rst). */ # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= 0x1000U /* one invalid page at the bottom */ \ && !((uintptr_t)(ptr) & 0xff00000000000000ULL) ) # else # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= 0x1000U \ && !((uintptr_t)(ptr) & 0xffff800000000000ULL) ) # endif # else /* !IN_RING3 */ # if defined(RT_OS_LINUX) /* May use 5-level paging (see Documentation/x86/x86_64/mm.rst). */ # if 1 /* User address are no longer considered valid in kernel mode (SMAP, etc). */ # define RT_VALID_PTR(ptr) ((uintptr_t)(ptr) - 0xff00000000000000ULL < 0x00ffffffffe00000ULL) /* 2MB invalid space at the top */ # else # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x200000 >= 0x201000U /* one invalid page at the bottom and 2MB at the top */ \ && ( ((uintptr_t)(ptr) & 0xff00000000000000ULL) == 0xff00000000000000ULL \ || ((uintptr_t)(ptr) & 0xff00000000000000ULL) == 0) ) # endif # else # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \ && ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \ || ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) ) # endif # endif /* !IN_RING3 */ #elif defined(RT_ARCH_X86) # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U ) #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. */ # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x80000000U >= 0x80000000U + 0x100000000ULL ) # 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. */ # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= 0x01000000U ) # 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 * http://cvs.opensolaris.org/source/xref/onnv/onnv-gate/usr/src/uts/sun4/os/startup.c#510 */ # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x400000U >= 0x400000U + 0x2000U ) # else # error "Port me" # endif # else /* !IN_RING3 */ # ifdef RT_OS_SOLARIS /** @todo Sparc kernel mode: Check the sources! */ # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U ) # else # error "Port me" # endif # endif /* !IN_RING3 */ #elif defined(RT_ARCH_ARM32) || defined(RT_ARCH_ARM64) /* ASSUMES that at least the last and first 4K are out of bounds. */ # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U ) #else # error "Architecture identifier missing / not implemented." #endif /** @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. */ #define RT_VALID_ALIGNED_PTR(ptr, align) \ ( !((uintptr_t)(ptr) & (uintptr_t)((align) - 1)) \ && RT_VALID_PTR(ptr) ) /** @def VALID_PHYS32 * 32 bits physical address validation macro. * @param Phys The RTGCPHYS address. */ #define VALID_PHYS32(Phys) ( (uint64_t)(Phys) < (uint64_t)_4G ) /** @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) #if (!defined(__GNUC__) && !defined(__PRETTY_FUNCTION__)) || defined(DOXYGEN_RUNNING) # if defined(_MSC_VER) || defined(DOXYGEN_RUNNING) /** With GNU C we'd like to use the builtin __PRETTY_FUNCTION__, so define that * for the other compilers. */ # 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. */ #if !defined(RT_STRICT) && defined(DEBUG) # define RT_STRICT #endif #ifdef RT_NO_STRICT # undef RT_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. */ #if !defined(RT_LOCK_STRICT) && !defined(RT_LOCK_NO_STRICT) && defined(RT_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) # undef 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. */ #if !defined(RT_LOCK_STRICT_ORDER) && !defined(RT_LOCK_NO_STRICT_ORDER) && defined(RT_STRICT) # 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) # undef RT_LOCK_STRICT_ORDER #endif /** Source position. */ #define RT_SRC_POS __FILE__, __LINE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__ /** Source position declaration. */ #define RT_SRC_POS_DECL const char *pszFile, unsigned iLine, const char *pszFunction /** Source position arguments. */ #define RT_SRC_POS_ARGS pszFile, iLine, pszFunction /** Applies NOREF() to the source position arguments. */ #define RT_SRC_POS_NOREF() do { NOREF(pszFile); NOREF(iLine); NOREF(pszFunction); } while (0) /** @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) && !defined(RT_ARCH_ARM64) && !defined(RT_ARCH_ARM32)) \ || defined(__WATCOMC__) # 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) || defined(__WATCOMC__) # define RT_INLINE_ASM_GNU_STYLE 0 #else # define RT_INLINE_ASM_GNU_STYLE 1 #endif /** @def RT_INLINE_ASM_USES_INTRIN * Defined as one of the RT_MSC_VER_XXX MSC version values if the compiler have * and uses intrin.h. Otherwise it is 0. */ #ifdef _MSC_VER # if _MSC_VER >= RT_MSC_VER_VS2019 /* Visual C++ v14.2 */ # define RT_INLINE_ASM_USES_INTRIN RT_MSC_VER_VS2019 # elif _MSC_VER >= RT_MSC_VER_VS2017 /* Visual C++ v14.1 */ # define RT_INLINE_ASM_USES_INTRIN RT_MSC_VER_VS2017 # elif _MSC_VER >= RT_MSC_VER_VS2015 /* Visual C++ v14.0 */ # define RT_INLINE_ASM_USES_INTRIN RT_MSC_VER_VS2015 # elif _MSC_VER >= RT_MSC_VER_VS2013 /* Visual C++ v12.0 */ # define RT_INLINE_ASM_USES_INTRIN RT_MSC_VER_VS2013 # elif _MSC_VER >= RT_MSC_VER_VS2012 /* Visual C++ v11.0 */ # define RT_INLINE_ASM_USES_INTRIN RT_MSC_VER_VS2012 # elif _MSC_VER >= RT_MSC_VER_VS2010 /* Visual C++ v10.0 */ # define RT_INLINE_ASM_USES_INTRIN RT_MSC_VER_VS2010 # elif _MSC_VER >= RT_MSC_VER_VS2008 /* Visual C++ v9.0 */ # define RT_INLINE_ASM_USES_INTRIN RT_MSC_VER_VS2008 # elif _MSC_VER >= RT_MSC_VER_VS2005 /* Visual C++ v8.0 */ # define RT_INLINE_ASM_USES_INTRIN RT_MSC_VER_VS2005 # endif #endif #ifndef RT_INLINE_ASM_USES_INTRIN # define RT_INLINE_ASM_USES_INTRIN 0 #endif #define RT_MSC_VER_VS2012 (1700) /**< Visual Studio 2012. */ #define RT_MSC_VER_VC110 RT_MSC_VER_VS2012 /**< Visual C++ 11.0, aka Visual Studio 2012. */ #define RT_MSC_VER_VS2013 (1800) /**< Visual Studio 2013. */ #define RT_MSC_VER_VC120 RT_MSC_VER_VS2013 /**< Visual C++ 12.0, aka Visual Studio 2013. */ #define RT_MSC_VER_VS2015 (1900) /**< Visual Studio 2015. */ #define RT_MSC_VER_VC140 RT_MSC_VER_VS2015 /**< Visual C++ 14.0, aka Visual Studio 2015. */ #define RT_MSC_VER_VS2017 (1910) /**< Visual Studio 2017. */ #define RT_MSC_VER_VC141 RT_MSC_VER_VS2017 /**< Visual C++ 14.1, aka Visual Studio 2017. */ #define RT_MSC_VER_VS2019 (1920) /**< Visual Studio 2017. */ #define RT_MSC_VER_VC142 RT_MSC_VER_VS2019 /**< Visual C++ 14.2, aka Visual Studio 2019. */ /** @def RT_COMPILER_SUPPORTS_LAMBDA * If the defined, the compiler supports lambda expressions. These expressions * are useful for embedding assertions and type checks into macros. */ #if defined(_MSC_VER) && defined(__cplusplus) # if _MSC_VER >= 1600 /* Visual C++ v10.0 / 2010 */ # define RT_COMPILER_SUPPORTS_LAMBDA # endif #elif defined(__GNUC__) && defined(__cplusplus) /* 4.5 or later, I think, if in ++11 mode... */ #endif /** @def RT_DATA_IS_FAR * Set to 1 if we're in 16-bit mode and use far pointers. */ #if ARCH_BITS == 16 && defined(__WATCOMC__) \ && (defined(__COMPACT__) || defined(__LARGE__)) # define RT_DATA_IS_FAR 1 #else # define RT_DATA_IS_FAR 0 #endif /** @def RT_FAR * For indicating far pointers in 16-bit code. * Does nothing in 32-bit and 64-bit code. */ /** @def RT_NEAR * For indicating near pointers in 16-bit code. * Does nothing in 32-bit and 64-bit code. */ /** @def RT_FAR_CODE * For indicating far 16-bit functions. * Does nothing in 32-bit and 64-bit code. */ /** @def RT_NEAR_CODE * For indicating near 16-bit functions. * Does nothing in 32-bit and 64-bit code. */ /** @def RT_FAR_DATA * For indicating far 16-bit external data, i.e. in a segment other than DATA16. * Does nothing in 32-bit and 64-bit code. */ #if ARCH_BITS == 16 # define RT_FAR __far # define RT_NEAR __near # define RT_FAR_CODE __far # define RT_NEAR_CODE __near # define RT_FAR_DATA __far #else # define RT_FAR # define RT_NEAR # define RT_FAR_CODE # define RT_NEAR_CODE # define RT_FAR_DATA #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. */ #if defined(_MSC_VER) || defined(RT_OS_OS2) # define DECLEXPORT_CLASS __declspec(dllexport) #elif defined(RT_USE_VISIBILITY_DEFAULT) # define DECLEXPORT_CLASS __attribute__((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. */ #if defined(_MSC_VER) || (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__)) # define DECLIMPORT_CLASS __declspec(dllimport) #elif defined(RT_USE_VISIBILITY_DEFAULT) # define DECLIMPORT_CLASS __attribute__((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) \ inline bool operator! (const Cls &that) { return !bool (that); } \ inline bool operator&& (const Cls &that, bool b) { return bool (that) && b; } \ inline bool operator|| (const Cls &that, bool b) { return bool (that) || b; } \ inline bool operator&& (bool b, const Cls &that) { return b && bool (that); } \ inline bool operator|| (bool b, const Cls &that) { return b || bool (that); } #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 Foo { ... }; * // applied workaround * WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL (Foo, , ) * @endcode */ #if defined(_MSC_VER) # define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args) \ template ArgsDecl \ inline bool operator! (const Tpl Args &that) { return !bool (that); } \ template ArgsDecl \ inline bool operator&& (const Tpl Args &that, bool b) { return bool (that) && b; } \ template ArgsDecl \ inline bool operator|| (const Tpl Args &that, bool b) { return bool (that) || b; } \ template ArgsDecl \ inline bool operator&& (bool b, const Tpl Args &that) { return b && bool (that); } \ template ArgsDecl \ inline bool operator|| (bool b, const Tpl Args &that) { return b || bool (that); } #else # define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args) #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) \ inline Cls(const Cls &); \ inline Cls &operator= (const 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) \ inline static void *operator new (size_t); \ inline static void operator delete (void *) #endif /* __cplusplus */ /** @} */ #endif /* !IPRT_INCLUDED_cdefs_h */