VirtualBox

source: vbox/trunk/include/iprt/cdefs.h@ 61683

Last change on this file since 61683 was 60964, checked in by vboxsync, 9 years ago

iprt/cdefs.h: Added RT_CLANG_PREREQ macros. Added RT_NOREF_PV macro that uses _Pragma("unused(xxx)") instead of (void)(var), just in case we'll need it.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 144.8 KB
Line 
1/** @file
2 * IPRT - Common C and C++ definitions.
3 */
4
5/*
6 * Copyright (C) 2006-2015 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___iprt_cdefs_h
27#define ___iprt_cdefs_h
28
29
30/** @defgroup grp_rt_cdefs IPRT Common Definitions and Macros
31 * @{
32 */
33
34/** @def RT_C_DECLS_BEGIN
35 * Used to start a block of function declarations which are shared
36 * between C and C++ program.
37 */
38
39/** @def RT_C_DECLS_END
40 * Used to end a block of function declarations which are shared
41 * between C and C++ program.
42 */
43
44#if defined(__cplusplus)
45# define RT_C_DECLS_BEGIN extern "C" {
46# define RT_C_DECLS_END }
47#else
48# define RT_C_DECLS_BEGIN
49# define RT_C_DECLS_END
50#endif
51
52
53/*
54 * Shut up DOXYGEN warnings and guide it properly thru the code.
55 */
56#ifdef DOXYGEN_RUNNING
57# define __AMD64__
58# define __X86__
59# define RT_ARCH_AMD64
60# define RT_ARCH_X86
61# define RT_ARCH_SPARC
62# define RT_ARCH_SPARC64
63# define IN_RING0
64# define IN_RING3
65# define IN_RC
66# define IN_RC
67# define IN_RT_RC
68# define IN_RT_R0
69# define IN_RT_R3
70# define IN_RT_STATIC
71# define RT_STRICT
72# define RT_NO_STRICT
73# define RT_LOCK_STRICT
74# define RT_LOCK_NO_STRICT
75# define RT_LOCK_STRICT_ORDER
76# define RT_LOCK_NO_STRICT_ORDER
77# define RT_BREAKPOINT
78# define RT_NO_DEPRECATED_MACROS
79# define RT_EXCEPTIONS_ENABLED
80# define RT_BIG_ENDIAN
81# define RT_LITTLE_ENDIAN
82# define RT_COMPILER_GROKS_64BIT_BITFIELDS
83# define RT_COMPILER_WITH_80BIT_LONG_DOUBLE
84# define RT_NO_VISIBILITY_HIDDEN
85# define RT_GCC_SUPPORTS_VISIBILITY_HIDDEN
86# define RT_COMPILER_SUPPORTS_VA_ARGS
87# define RT_COMPILER_SUPPORTS_LAMBDA
88#endif /* DOXYGEN_RUNNING */
89
90/** @def RT_ARCH_X86
91 * Indicates that we're compiling for the X86 architecture.
92 */
93
94/** @def RT_ARCH_AMD64
95 * Indicates that we're compiling for the AMD64 architecture.
96 */
97
98/** @def RT_ARCH_SPARC
99 * Indicates that we're compiling for the SPARC V8 architecture (32-bit).
100 */
101
102/** @def RT_ARCH_SPARC64
103 * Indicates that we're compiling for the SPARC V9 architecture (64-bit).
104 */
105#if !defined(RT_ARCH_X86) \
106 && !defined(RT_ARCH_AMD64) \
107 && !defined(RT_ARCH_SPARC) \
108 && !defined(RT_ARCH_SPARC64) \
109 && !defined(RT_ARCH_ARM)
110# if defined(__amd64__) || defined(__x86_64__) || defined(_M_X64) || defined(__AMD64__)
111# define RT_ARCH_AMD64
112# elif defined(__i386__) || defined(_M_IX86) || defined(__X86__)
113# define RT_ARCH_X86
114# elif defined(__sparcv9)
115# define RT_ARCH_SPARC64
116# elif defined(__sparc__)
117# define RT_ARCH_SPARC
118# elif defined(__arm__) || defined(__arm32__)
119# define RT_ARCH_ARM
120# else /* PORTME: append test for new archs. */
121# error "Check what predefined macros your compiler uses to indicate architecture."
122# endif
123/* PORTME: append new archs checks. */
124#elif defined(RT_ARCH_X86) && defined(RT_ARCH_AMD64)
125# error "Both RT_ARCH_X86 and RT_ARCH_AMD64 cannot be defined at the same time!"
126#elif defined(RT_ARCH_X86) && defined(RT_ARCH_SPARC)
127# error "Both RT_ARCH_X86 and RT_ARCH_SPARC cannot be defined at the same time!"
128#elif defined(RT_ARCH_X86) && defined(RT_ARCH_SPARC64)
129# error "Both RT_ARCH_X86 and RT_ARCH_SPARC64 cannot be defined at the same time!"
130#elif defined(RT_ARCH_AMD64) && defined(RT_ARCH_SPARC)
131# error "Both RT_ARCH_AMD64 and RT_ARCH_SPARC cannot be defined at the same time!"
132#elif defined(RT_ARCH_AMD64) && defined(RT_ARCH_SPARC64)
133# error "Both RT_ARCH_AMD64 and RT_ARCH_SPARC64 cannot be defined at the same time!"
134#elif defined(RT_ARCH_SPARC) && defined(RT_ARCH_SPARC64)
135# error "Both RT_ARCH_SPARC and RT_ARCH_SPARC64 cannot be defined at the same time!"
136#elif defined(RT_ARCH_ARM) && defined(RT_ARCH_AMD64)
137# error "Both RT_ARCH_ARM and RT_ARCH_AMD64 cannot be defined at the same time!"
138#elif defined(RT_ARCH_ARM) && defined(RT_ARCH_X86)
139# error "Both RT_ARCH_ARM and RT_ARCH_X86 cannot be defined at the same time!"
140#elif defined(RT_ARCH_ARM) && defined(RT_ARCH_SPARC64)
141# error "Both RT_ARCH_ARM and RT_ARCH_SPARC64 cannot be defined at the same time!"
142#elif defined(RT_ARCH_ARM) && defined(RT_ARCH_SPARC)
143# error "Both RT_ARCH_ARM and RT_ARCH_SPARC cannot be defined at the same time!"
144#endif
145
146/* Final check (PORTME). */
147#if (defined(RT_ARCH_X86) != 0) \
148 + (defined(RT_ARCH_AMD64) != 0) \
149 + (defined(RT_ARCH_SPARC) != 0) \
150 + (defined(RT_ARCH_SPARC64) != 0) \
151 + (defined(RT_ARCH_ARM) != 0) \
152 != 1
153# error "Exactly one RT_ARCH_XXX macro shall be defined"
154#endif
155
156/** @def RT_GNUC_PREREQ
157 * Shorter than fiddling with __GNUC__ and __GNUC_MINOR__.
158 *
159 * @param a_MinMajor Minimum major version
160 * @param a_MinMinor The minor version number part.
161 */
162#define RT_GNUC_PREREQ(a_MinMajor, a_MinMinor) RT_GNUC_PREREQ_EX(a_MinMajor, a_MinMinor, 0)
163/** @def RT_GNUC_PREREQ_EX
164 * Simplified way of checking __GNUC__ and __GNUC_MINOR__ regardless of actual
165 * compiler used, returns @a a_OtherRet for other compilers.
166 *
167 * @param a_MinMajor Minimum major version
168 * @param a_MinMinor The minor version number part.
169 * @param a_OtherRet What to return for non-GCC compilers.
170 */
171#if defined(__GNUC__) && defined(__GNUC_MINOR__)
172# define RT_GNUC_PREREQ_EX(a_MinMajor, a_MinMinor, a_OtherRet) \
173 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((a_MinMajor) << 16) + (a_MinMinor))
174#else
175# define RT_GNUC_PREREQ_EX(a_MinMajor, a_MinMinor, a_OtherRet) (a_OtherRet)
176#endif
177
178/** @def RT_MSC_PREREQ
179 * Convenient way of checking _MSC_VER regardless of actual compiler used
180 * (returns false if not MSC).
181 *
182 * @param a_MinVer Preferably a RT_MSC_VER_XXX value.
183 */
184#define RT_MSC_PREREQ(a_MinVer) RT_MSC_PREREQ_EX(a_MinVer, 0)
185/** @def RT_MSC_PREREQ_EX
186 * Convenient way of checking _MSC_VER regardless of actual compiler used,
187 * returns @a a_OtherRet for other compilers.
188 *
189 * @param a_MinVer Preferably a RT_MSC_VER_XXX value.
190 * @param a_OtherRet What to return for non-MSC compilers.
191 */
192#if defined(_MSC_VER)
193# define RT_MSC_PREREQ_EX(a_MinVer, a_OtherRet) ( (_MSC_VER) >= (a_MinVer) )
194#else
195# define RT_MSC_PREREQ_EX(a_MinVer, a_OtherRet) (a_OtherRet)
196#endif
197/** @name RT_MSC_VER_XXX - _MSC_VER values to use with RT_MSC_PREREQ.
198 * @remarks The VCxxx values are derived from the CRT DLLs shipping with the
199 * compilers.
200 * @{ */
201#define RT_MSC_VER_VC50 (1100) /**< Visual C++ 5.0. */
202#define RT_MSC_VER_VC60 (1200) /**< Visual C++ 6.0. */
203#define RT_MSC_VER_VC70 (1300) /**< Visual C++ 7.0. */
204#define RT_MSC_VER_VC70 (1300) /**< Visual C++ 7.0. */
205#define RT_MSC_VER_VS2003 (1310) /**< Visual Studio 2003, aka Visual C++ 7.1. */
206#define RT_MSC_VER_VC71 RT_MSC_VER_VS2003 /**< Visual C++ 7.1, aka Visual Studio 2003. */
207#define RT_MSC_VER_VS2005 (1400) /**< Visual Studio 2005. */
208#define RT_MSC_VER_VC80 RT_MSC_VER_VS2005 /**< Visual C++ 8.0, aka Visual Studio 2008. */
209#define RT_MSC_VER_VS2008 (1500) /**< Visual Studio 2008. */
210#define RT_MSC_VER_VC90 RT_MSC_VER_VS2008 /**< Visual C++ 9.0, aka Visual Studio 2008. */
211#define RT_MSC_VER_VS2010 (1600) /**< Visual Studio 2010. */
212#define RT_MSC_VER_VC100 RT_MSC_VER_VS2010 /**< Visual C++ 10.0, aka Visual Studio 2010. */
213#define RT_MSC_VER_VS2012 (1700) /**< Visual Studio 2012. */
214#define RT_MSC_VER_VC110 RT_MSC_VER_VS2012 /**< Visual C++ 11.0, aka Visual Studio 2012. */
215#define RT_MSC_VER_VS2013 (1800) /**< Visual Studio 2013. */
216#define RT_MSC_VER_VC120 RT_MSC_VER_VS2013 /**< Visual C++ 12.0, aka Visual Studio 2013. */
217#define RT_MSC_VER_VS2015 (1900) /**< Visual Studio 2015. */
218#define RT_MSC_VER_VC140 RT_MSC_VER_VS2015 /**< Visual C++ 14.0, aka Visual Studio 2015. */
219/** @} */
220
221/** @def RT_CLANG_PREREQ
222 * Shorter than fiddling with __clang_major__ and __clang_minor__.
223 *
224 * @param a_MinMajor Minimum major version
225 * @param a_MinMinor The minor version number part.
226 */
227#define RT_CLANG_PREREQ(a_MinMajor, a_MinMinor) RT_CLANG_PREREQ_EX(a_MinMajor, a_MinMinor, 0)
228/** @def RT_CLANG_PREREQ_EX
229 * Simplified way of checking __clang_major__ and __clang_minor__ regardless of
230 * actual compiler used, returns @a a_OtherRet for other compilers.
231 *
232 * @param a_MinMajor Minimum major version
233 * @param a_MinMinor The minor version number part.
234 * @param a_OtherRet What to return for non-GCC compilers.
235 */
236#if defined(__clang_major__) && defined(__clang_minor__)
237# define RT_CLANG_PREREQ_EX(a_MinMajor, a_MinMinor, a_OtherRet) \
238 ((__clang_major__ << 16) + __clang_minor__ >= ((a_MinMajor) << 16) + (a_MinMinor))
239#else
240# define RT_CLANG_PREREQ_EX(a_MinMajor, a_MinMinor, a_OtherRet) (a_OtherRet)
241#endif
242
243
244/** @def __X86__
245 * Indicates that we're compiling for the X86 architecture.
246 * @deprecated
247 */
248
249/** @def __AMD64__
250 * Indicates that we're compiling for the AMD64 architecture.
251 * @deprecated
252 */
253#if !defined(__X86__) && !defined(__AMD64__) && (defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86))
254# if defined(RT_ARCH_AMD64)
255# define __AMD64__
256# elif defined(RT_ARCH_X86)
257# define __X86__
258# else
259# error "Check what predefined macros your compiler uses to indicate architecture."
260# endif
261#elif defined(__X86__) && defined(__AMD64__)
262# error "Both __X86__ and __AMD64__ cannot be defined at the same time!"
263#elif defined(__X86__) && !defined(RT_ARCH_X86)
264# error "__X86__ without RT_ARCH_X86!"
265#elif defined(__AMD64__) && !defined(RT_ARCH_AMD64)
266# error "__AMD64__ without RT_ARCH_AMD64!"
267#endif
268
269/** @def RT_BIG_ENDIAN
270 * Defined if the architecture is big endian. */
271/** @def RT_LITTLE_ENDIAN
272 * Defined if the architecture is little endian. */
273#if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86) || defined(RT_ARCH_ARM)
274# define RT_LITTLE_ENDIAN
275#elif defined(RT_ARCH_SPARC) || defined(RT_ARCH_SPARC64)
276# define RT_BIG_ENDIAN
277#else
278# error "PORTME: architecture endianess"
279#endif
280#if defined(RT_BIG_ENDIAN) && defined(RT_LITTLE_ENDIAN)
281# error "Both RT_BIG_ENDIAN and RT_LITTLE_ENDIAN are defined"
282#endif
283
284
285/** @def IN_RING0
286 * Used to indicate that we're compiling code which is running
287 * in Ring-0 Host Context.
288 */
289
290/** @def IN_RING3
291 * Used to indicate that we're compiling code which is running
292 * in Ring-3 Host Context.
293 */
294
295/** @def IN_RC
296 * Used to indicate that we're compiling code which is running
297 * in the Raw-mode Context (implies R0).
298 */
299#if !defined(IN_RING3) && !defined(IN_RING0) && !defined(IN_RC) && !defined(IN_RC)
300# error "You must define which context the compiled code should run in; IN_RING3, IN_RING0 or IN_RC"
301#endif
302#if (defined(IN_RING3) && (defined(IN_RING0) || defined(IN_RC)) ) \
303 || (defined(IN_RING0) && (defined(IN_RING3) || defined(IN_RC)) ) \
304 || (defined(IN_RC) && (defined(IN_RING3) || defined(IN_RING0)) )
305# error "Only one of the IN_RING3, IN_RING0, IN_RC defines should be defined."
306#endif
307
308
309/** @def ARCH_BITS
310 * Defines the bit count of the current context.
311 */
312#if !defined(ARCH_BITS) || defined(DOXYGEN_RUNNING)
313# if defined(RT_ARCH_AMD64) || defined(RT_ARCH_SPARC64)
314# define ARCH_BITS 64
315# elif !defined(__I86__) || !defined(__WATCOMC__)
316# define ARCH_BITS 32
317# else
318# define ARCH_BITS 16
319# endif
320#endif
321
322/* ARCH_BITS validation (PORTME). */
323#if ARCH_BITS == 64
324 #if defined(RT_ARCH_X86) || defined(RT_ARCH_SPARC) || defined(RT_ARCH_ARM)
325 # error "ARCH_BITS=64 but non-64-bit RT_ARCH_XXX defined."
326 #endif
327 #if !defined(RT_ARCH_AMD64) && !defined(RT_ARCH_SPARC64)
328 # error "ARCH_BITS=64 but no 64-bit RT_ARCH_XXX defined."
329 #endif
330
331#elif ARCH_BITS == 32
332 #if defined(RT_ARCH_AMD64) || defined(RT_ARCH_SPARC64)
333 # error "ARCH_BITS=32 but non-32-bit RT_ARCH_XXX defined."
334 #endif
335 #if !defined(RT_ARCH_X86) && !defined(RT_ARCH_SPARC) && !defined(RT_ARCH_ARM)
336 # error "ARCH_BITS=32 but no 32-bit RT_ARCH_XXX defined."
337 #endif
338
339#elif ARCH_BITS == 16
340 #if defined(RT_ARCH_AMD64) || defined(RT_ARCH_SPARC) || defined(RT_ARCH_SPARC64) || defined(RT_ARCH_ARM)
341 # error "ARCH_BITS=16 but non-16-bit RT_ARCH_XX defined."
342 #endif
343 #if !defined(RT_ARCH_X86)
344 # error "ARCH_BITS=16 but RT_ARCH_X86 isn't defined."
345 #endif
346
347#else
348# error "Unsupported ARCH_BITS value!"
349#endif
350
351/** @def HC_ARCH_BITS
352 * Defines the host architecture bit count.
353 */
354#if !defined(HC_ARCH_BITS) || defined(DOXYGEN_RUNNING)
355# ifndef IN_RC
356# define HC_ARCH_BITS ARCH_BITS
357# else
358# define HC_ARCH_BITS 32
359# endif
360#endif
361
362/** @def GC_ARCH_BITS
363 * Defines the guest architecture bit count.
364 */
365#if !defined(GC_ARCH_BITS) && !defined(DOXYGEN_RUNNING)
366# ifdef VBOX_WITH_64_BITS_GUESTS
367# define GC_ARCH_BITS 64
368# else
369# define GC_ARCH_BITS 32
370# endif
371#endif
372
373/** @def R3_ARCH_BITS
374 * Defines the host ring-3 architecture bit count.
375 */
376#if !defined(R3_ARCH_BITS) || defined(DOXYGEN_RUNNING)
377# ifdef IN_RING3
378# define R3_ARCH_BITS ARCH_BITS
379# else
380# define R3_ARCH_BITS HC_ARCH_BITS
381# endif
382#endif
383
384/** @def R0_ARCH_BITS
385 * Defines the host ring-0 architecture bit count.
386 */
387#if !defined(R0_ARCH_BITS) || defined(DOXYGEN_RUNNING)
388# ifdef IN_RING0
389# define R0_ARCH_BITS ARCH_BITS
390# else
391# define R0_ARCH_BITS HC_ARCH_BITS
392# endif
393#endif
394
395/** @def GC_ARCH_BITS
396 * Defines the guest architecture bit count.
397 */
398#if !defined(GC_ARCH_BITS) || defined(DOXYGEN_RUNNING)
399# ifdef IN_RC
400# define GC_ARCH_BITS ARCH_BITS
401# else
402# define GC_ARCH_BITS 32
403# endif
404#endif
405
406
407
408/** @name RT_OPSYS_XXX - Operative System Identifiers.
409 * These are the value that the RT_OPSYS \#define can take. @{
410 */
411/** Unknown OS. */
412#define RT_OPSYS_UNKNOWN 0
413/** OS Agnostic. */
414#define RT_OPSYS_AGNOSTIC 1
415/** Darwin - aka Mac OS X. */
416#define RT_OPSYS_DARWIN 2
417/** DragonFly BSD. */
418#define RT_OPSYS_DRAGONFLY 3
419/** DOS. */
420#define RT_OPSYS_DOS 4
421/** FreeBSD. */
422#define RT_OPSYS_FREEBSD 5
423/** Haiku. */
424#define RT_OPSYS_HAIKU 6
425/** Linux. */
426#define RT_OPSYS_LINUX 7
427/** L4. */
428#define RT_OPSYS_L4 8
429/** Minix. */
430#define RT_OPSYS_MINIX 9
431/** NetBSD. */
432#define RT_OPSYS_NETBSD 11
433/** Netware. */
434#define RT_OPSYS_NETWARE 12
435/** NT (native). */
436#define RT_OPSYS_NT 13
437/** OpenBSD. */
438#define RT_OPSYS_OPENBSD 14
439/** OS/2. */
440#define RT_OPSYS_OS2 15
441/** Plan 9. */
442#define RT_OPSYS_PLAN9 16
443/** QNX. */
444#define RT_OPSYS_QNX 17
445/** Solaris. */
446#define RT_OPSYS_SOLARIS 18
447/** UEFI. */
448#define RT_OPSYS_UEFI 19
449/** Windows. */
450#define RT_OPSYS_WINDOWS 20
451/** The max RT_OPSYS_XXX value (exclusive). */
452#define RT_OPSYS_MAX 21
453/** @} */
454
455/** @def RT_OPSYS
456 * Indicates which OS we're targeting. It's a \#define with is
457 * assigned one of the RT_OPSYS_XXX defines above.
458 *
459 * So to test if we're on FreeBSD do the following:
460 * @code
461 * #if RT_OPSYS == RT_OPSYS_FREEBSD
462 * some_funky_freebsd_specific_stuff();
463 * #endif
464 * @endcode
465 */
466
467/*
468 * Set RT_OPSYS_XXX according to RT_OS_XXX.
469 *
470 * Search: #define RT_OPSYS_([A-Z0-9]+) .*
471 * Replace: # elif defined(RT_OS_\1)\n# define RT_OPSYS RT_OPSYS_\1
472 */
473#ifndef RT_OPSYS
474# if defined(RT_OS_UNKNOWN) || defined(DOXYGEN_RUNNING)
475# define RT_OPSYS RT_OPSYS_UNKNOWN
476# elif defined(RT_OS_AGNOSTIC)
477# define RT_OPSYS RT_OPSYS_AGNOSTIC
478# elif defined(RT_OS_DARWIN)
479# define RT_OPSYS RT_OPSYS_DARWIN
480# elif defined(RT_OS_DRAGONFLY)
481# define RT_OPSYS RT_OPSYS_DRAGONFLY
482# elif defined(RT_OS_DOS)
483# define RT_OPSYS RT_OPSYS_DOS
484# elif defined(RT_OS_FREEBSD)
485# define RT_OPSYS RT_OPSYS_FREEBSD
486# elif defined(RT_OS_HAIKU)
487# define RT_OPSYS RT_OPSYS_HAIKU
488# elif defined(RT_OS_LINUX)
489# define RT_OPSYS RT_OPSYS_LINUX
490# elif defined(RT_OS_L4)
491# define RT_OPSYS RT_OPSYS_L4
492# elif defined(RT_OS_MINIX)
493# define RT_OPSYS RT_OPSYS_MINIX
494# elif defined(RT_OS_NETBSD)
495# define RT_OPSYS RT_OPSYS_NETBSD
496# elif defined(RT_OS_NETWARE)
497# define RT_OPSYS RT_OPSYS_NETWARE
498# elif defined(RT_OS_NT)
499# define RT_OPSYS RT_OPSYS_NT
500# elif defined(RT_OS_OPENBSD)
501# define RT_OPSYS RT_OPSYS_OPENBSD
502# elif defined(RT_OS_OS2)
503# define RT_OPSYS RT_OPSYS_OS2
504# elif defined(RT_OS_PLAN9)
505# define RT_OPSYS RT_OPSYS_PLAN9
506# elif defined(RT_OS_QNX)
507# define RT_OPSYS RT_OPSYS_QNX
508# elif defined(RT_OS_SOLARIS)
509# define RT_OPSYS RT_OPSYS_SOLARIS
510# elif defined(RT_OS_UEFI)
511# define RT_OPSYS RT_OPSYS_UEFI
512# elif defined(RT_OS_WINDOWS)
513# define RT_OPSYS RT_OPSYS_WINDOWS
514# endif
515#endif
516
517/*
518 * Guess RT_OPSYS based on compiler predefined macros.
519 */
520#ifndef RT_OPSYS
521# if defined(__APPLE__)
522# define RT_OPSYS RT_OPSYS_DARWIN
523# elif defined(__DragonFly__)
524# define RT_OPSYS RT_OPSYS_DRAGONFLY
525# elif defined(__FreeBSD__) /*??*/
526# define RT_OPSYS RT_OPSYS_FREEBSD
527# elif defined(__gnu_linux__)
528# define RT_OPSYS RT_OPSYS_LINUX
529# elif defined(__NetBSD__) /*??*/
530# define RT_OPSYS RT_OPSYS_NETBSD
531# elif defined(__OpenBSD__) /*??*/
532# define RT_OPSYS RT_OPSYS_OPENBSD
533# elif defined(__OS2__)
534# define RT_OPSYS RT_OPSYS_OS2
535# elif defined(__sun__) || defined(__SunOS__) || defined(__sun) || defined(__SunOS)
536# define RT_OPSYS RT_OPSYS_SOLARIS
537# elif defined(_WIN32) || defined(_WIN64)
538# define RT_OPSYS RT_OPSYS_WINDOWS
539# elif defined(MSDOS) || defined(_MSDOS) || defined(DOS16RM) /* OW+MSC || MSC || DMC */
540# define RT_OPSYS RT_OPSYS_DOS
541# else
542# error "Port Me"
543# endif
544#endif
545
546#if RT_OPSYS < RT_OPSYS_UNKNOWN || RT_OPSYS >= RT_OPSYS_MAX
547# error "Invalid RT_OPSYS value."
548#endif
549
550/*
551 * Do some consistency checks.
552 *
553 * Search: #define RT_OPSYS_([A-Z0-9]+) .*
554 * Replace: #if defined(RT_OS_\1) && RT_OPSYS != RT_OPSYS_\1\n# error RT_OPSYS vs RT_OS_\1\n#endif
555 */
556#if defined(RT_OS_UNKNOWN) && RT_OPSYS != RT_OPSYS_UNKNOWN
557# error RT_OPSYS vs RT_OS_UNKNOWN
558#endif
559#if defined(RT_OS_AGNOSTIC) && RT_OPSYS != RT_OPSYS_AGNOSTIC
560# error RT_OPSYS vs RT_OS_AGNOSTIC
561#endif
562#if defined(RT_OS_DARWIN) && RT_OPSYS != RT_OPSYS_DARWIN
563# error RT_OPSYS vs RT_OS_DARWIN
564#endif
565#if defined(RT_OS_DRAGONFLY) && RT_OPSYS != RT_OPSYS_DRAGONFLY
566# error RT_OPSYS vs RT_OS_DRAGONFLY
567#endif
568#if defined(RT_OS_DOS) && RT_OPSYS != RT_OPSYS_DOS
569# error RT_OPSYS vs RT_OS_DOS
570#endif
571#if defined(RT_OS_FREEBSD) && RT_OPSYS != RT_OPSYS_FREEBSD
572# error RT_OPSYS vs RT_OS_FREEBSD
573#endif
574#if defined(RT_OS_HAIKU) && RT_OPSYS != RT_OPSYS_HAIKU
575# error RT_OPSYS vs RT_OS_HAIKU
576#endif
577#if defined(RT_OS_LINUX) && RT_OPSYS != RT_OPSYS_LINUX
578# error RT_OPSYS vs RT_OS_LINUX
579#endif
580#if defined(RT_OS_L4) && RT_OPSYS != RT_OPSYS_L4
581# error RT_OPSYS vs RT_OS_L4
582#endif
583#if defined(RT_OS_MINIX) && RT_OPSYS != RT_OPSYS_MINIX
584# error RT_OPSYS vs RT_OS_MINIX
585#endif
586#if defined(RT_OS_NETBSD) && RT_OPSYS != RT_OPSYS_NETBSD
587# error RT_OPSYS vs RT_OS_NETBSD
588#endif
589#if defined(RT_OS_NETWARE) && RT_OPSYS != RT_OPSYS_NETWARE
590# error RT_OPSYS vs RT_OS_NETWARE
591#endif
592#if defined(RT_OS_NT) && RT_OPSYS != RT_OPSYS_NT
593# error RT_OPSYS vs RT_OS_NT
594#endif
595#if defined(RT_OS_OPENBSD) && RT_OPSYS != RT_OPSYS_OPENBSD
596# error RT_OPSYS vs RT_OS_OPENBSD
597#endif
598#if defined(RT_OS_OS2) && RT_OPSYS != RT_OPSYS_OS2
599# error RT_OPSYS vs RT_OS_OS2
600#endif
601#if defined(RT_OS_PLAN9) && RT_OPSYS != RT_OPSYS_PLAN9
602# error RT_OPSYS vs RT_OS_PLAN9
603#endif
604#if defined(RT_OS_QNX) && RT_OPSYS != RT_OPSYS_QNX
605# error RT_OPSYS vs RT_OS_QNX
606#endif
607#if defined(RT_OS_SOLARIS) && RT_OPSYS != RT_OPSYS_SOLARIS
608# error RT_OPSYS vs RT_OS_SOLARIS
609#endif
610#if defined(RT_OS_UEFI) && RT_OPSYS != RT_OPSYS_UEFI
611# error RT_OPSYS vs RT_OS_UEFI
612#endif
613#if defined(RT_OS_WINDOWS) && RT_OPSYS != RT_OPSYS_WINDOWS
614# error RT_OPSYS vs RT_OS_WINDOWS
615#endif
616
617/*
618 * Make sure the RT_OS_XXX macro is defined.
619 *
620 * Search: #define RT_OPSYS_([A-Z0-9]+) .*
621 * Replace: #elif RT_OPSYS == RT_OPSYS_\1\n# ifndef RT_OS_\1\n# define RT_OS_\1\n# endif
622 */
623#if RT_OPSYS == RT_OPSYS_UNKNOWN
624# ifndef RT_OS_UNKNOWN
625# define RT_OS_UNKNOWN
626# endif
627#elif RT_OPSYS == RT_OPSYS_AGNOSTIC
628# ifndef RT_OS_AGNOSTIC
629# define RT_OS_AGNOSTIC
630# endif
631#elif RT_OPSYS == RT_OPSYS_DARWIN
632# ifndef RT_OS_DARWIN
633# define RT_OS_DARWIN
634# endif
635#elif RT_OPSYS == RT_OPSYS_DRAGONFLY
636# ifndef RT_OS_DRAGONFLY
637# define RT_OS_DRAGONFLY
638# endif
639#elif RT_OPSYS == RT_OPSYS_DOS
640# ifndef RT_OS_DOS
641# define RT_OS_DOS
642# endif
643#elif RT_OPSYS == RT_OPSYS_FREEBSD
644# ifndef RT_OS_FREEBSD
645# define RT_OS_FREEBSD
646# endif
647#elif RT_OPSYS == RT_OPSYS_HAIKU
648# ifndef RT_OS_HAIKU
649# define RT_OS_HAIKU
650# endif
651#elif RT_OPSYS == RT_OPSYS_LINUX
652# ifndef RT_OS_LINUX
653# define RT_OS_LINUX
654# endif
655#elif RT_OPSYS == RT_OPSYS_L4
656# ifndef RT_OS_L4
657# define RT_OS_L4
658# endif
659#elif RT_OPSYS == RT_OPSYS_MINIX
660# ifndef RT_OS_MINIX
661# define RT_OS_MINIX
662# endif
663#elif RT_OPSYS == RT_OPSYS_NETBSD
664# ifndef RT_OS_NETBSD
665# define RT_OS_NETBSD
666# endif
667#elif RT_OPSYS == RT_OPSYS_NETWARE
668# ifndef RT_OS_NETWARE
669# define RT_OS_NETWARE
670# endif
671#elif RT_OPSYS == RT_OPSYS_NT
672# ifndef RT_OS_NT
673# define RT_OS_NT
674# endif
675#elif RT_OPSYS == RT_OPSYS_OPENBSD
676# ifndef RT_OS_OPENBSD
677# define RT_OS_OPENBSD
678# endif
679#elif RT_OPSYS == RT_OPSYS_OS2
680# ifndef RT_OS_OS2
681# define RT_OS_OS2
682# endif
683#elif RT_OPSYS == RT_OPSYS_PLAN9
684# ifndef RT_OS_PLAN9
685# define RT_OS_PLAN9
686# endif
687#elif RT_OPSYS == RT_OPSYS_QNX
688# ifndef RT_OS_QNX
689# define RT_OS_QNX
690# endif
691#elif RT_OPSYS == RT_OPSYS_SOLARIS
692# ifndef RT_OS_SOLARIS
693# define RT_OS_SOLARIS
694# endif
695#elif RT_OPSYS == RT_OPSYS_UEFI
696# ifndef RT_OS_UEFI
697# define RT_OS_UEFI
698# endif
699#elif RT_OPSYS == RT_OPSYS_WINDOWS
700# ifndef RT_OS_WINDOWS
701# define RT_OS_WINDOWS
702# endif
703#else
704# error "Bad RT_OPSYS value."
705#endif
706
707
708/**
709 * Checks whether the given OpSys uses DOS-style paths or not.
710 *
711 * By DOS-style paths we include drive lettering and UNC paths.
712 *
713 * @returns true / false
714 * @param a_OpSys The RT_OPSYS_XXX value to check, will be reference
715 * multiple times.
716 */
717#define RT_OPSYS_USES_DOS_PATHS(a_OpSys) \
718 ( (a_OpSys) == RT_OPSYS_WINDOWS \
719 || (a_OpSys) == RT_OPSYS_OS2 \
720 || (a_OpSys) == RT_OPSYS_DOS )
721
722
723
724/** @def CTXTYPE
725 * Declare a type differently in GC, R3 and R0.
726 *
727 * @param GCType The GC type.
728 * @param R3Type The R3 type.
729 * @param R0Type The R0 type.
730 * @remark For pointers used only in one context use RCPTRTYPE(), R3R0PTRTYPE(), R3PTRTYPE() or R0PTRTYPE().
731 */
732#ifdef IN_RC
733# define CTXTYPE(GCType, R3Type, R0Type) GCType
734#elif defined(IN_RING3)
735# define CTXTYPE(GCType, R3Type, R0Type) R3Type
736#else
737# define CTXTYPE(GCType, R3Type, R0Type) R0Type
738#endif
739
740/** @def RCPTRTYPE
741 * Declare a pointer which is used in the raw mode context but appears in structure(s) used by
742 * both HC and RC. The main purpose is to make sure structures have the same
743 * size when built for different architectures.
744 *
745 * @param RCType The RC type.
746 */
747#define RCPTRTYPE(RCType) CTXTYPE(RCType, RTRCPTR, RTRCPTR)
748
749/** @def R3R0PTRTYPE
750 * Declare a pointer which is used in HC, is explicitly valid in ring 3 and 0,
751 * but appears in structure(s) used by both HC and GC. The main purpose is to
752 * make sure structures have the same size when built for different architectures.
753 *
754 * @param R3R0Type The R3R0 type.
755 * @remarks This used to be called HCPTRTYPE.
756 */
757#define R3R0PTRTYPE(R3R0Type) CTXTYPE(RTHCPTR, R3R0Type, R3R0Type)
758
759/** @def R3PTRTYPE
760 * Declare a pointer which is used in R3 but appears in structure(s) used by
761 * both HC and GC. The main purpose is to make sure structures have the same
762 * size when built for different architectures.
763 *
764 * @param R3Type The R3 type.
765 */
766#define R3PTRTYPE(R3Type) CTXTYPE(RTHCUINTPTR, R3Type, RTHCUINTPTR)
767
768/** @def R0PTRTYPE
769 * Declare a pointer which is used in R0 but appears in structure(s) used by
770 * both HC and GC. The main purpose is to make sure structures have the same
771 * size when built for different architectures.
772 *
773 * @param R0Type The R0 type.
774 */
775#define R0PTRTYPE(R0Type) CTXTYPE(RTHCUINTPTR, RTHCUINTPTR, R0Type)
776
777/** @def CTXSUFF
778 * Adds the suffix of the current context to the passed in
779 * identifier name. The suffix is HC or GC.
780 *
781 * This is macro should only be used in shared code to avoid a forest of ifdefs.
782 * @param var Identifier name.
783 * @deprecated Use CTX_SUFF. Do NOT use this for new code.
784 */
785/** @def OTHERCTXSUFF
786 * Adds the suffix of the other context to the passed in
787 * identifier name. The suffix is HC or GC.
788 *
789 * This is macro should only be used in shared code to avoid a forest of ifdefs.
790 * @param var Identifier name.
791 * @deprecated Use CTX_SUFF. Do NOT use this for new code.
792 */
793#ifdef IN_RC
794# define CTXSUFF(var) var##GC
795# define OTHERCTXSUFF(var) var##HC
796#else
797# define CTXSUFF(var) var##HC
798# define OTHERCTXSUFF(var) var##GC
799#endif
800
801/** @def CTXALLSUFF
802 * Adds the suffix of the current context to the passed in
803 * identifier name. The suffix is R3, R0 or GC.
804 *
805 * This is macro should only be used in shared code to avoid a forest of ifdefs.
806 * @param var Identifier name.
807 * @deprecated Use CTX_SUFF. Do NOT use this for new code.
808 */
809#ifdef IN_RC
810# define CTXALLSUFF(var) var##GC
811#elif defined(IN_RING0)
812# define CTXALLSUFF(var) var##R0
813#else
814# define CTXALLSUFF(var) var##R3
815#endif
816
817/** @def CTX_SUFF
818 * Adds the suffix of the current context to the passed in
819 * identifier name. The suffix is R3, R0 or RC.
820 *
821 * This is macro should only be used in shared code to avoid a forest of ifdefs.
822 * @param var Identifier name.
823 *
824 * @remark This will replace CTXALLSUFF and CTXSUFF before long.
825 */
826#ifdef IN_RC
827# define CTX_SUFF(var) var##RC
828#elif defined(IN_RING0)
829# define CTX_SUFF(var) var##R0
830#else
831# define CTX_SUFF(var) var##R3
832#endif
833
834/** @def CTX_SUFF_Z
835 * Adds the suffix of the current context to the passed in
836 * identifier name, combining RC and R0 into RZ.
837 * The suffix thus is R3 or RZ.
838 *
839 * This is macro should only be used in shared code to avoid a forest of ifdefs.
840 * @param var Identifier name.
841 *
842 * @remark This will replace CTXALLSUFF and CTXSUFF before long.
843 */
844#ifdef IN_RING3
845# define CTX_SUFF_Z(var) var##R3
846#else
847# define CTX_SUFF_Z(var) var##RZ
848#endif
849
850
851/** @def CTXMID
852 * Adds the current context as a middle name of an identifier name
853 * The middle name is HC or GC.
854 *
855 * This is macro should only be used in shared code to avoid a forest of ifdefs.
856 * @param first First name.
857 * @param last Surname.
858 */
859/** @def OTHERCTXMID
860 * Adds the other context as a middle name of an identifier name
861 * The middle name is HC or GC.
862 *
863 * This is macro should only be used in shared code to avoid a forest of ifdefs.
864 * @param first First name.
865 * @param last Surname.
866 * @deprecated use CTX_MID or CTX_MID_Z
867 */
868#ifdef IN_RC
869# define CTXMID(first, last) first##GC##last
870# define OTHERCTXMID(first, last) first##HC##last
871#else
872# define CTXMID(first, last) first##HC##last
873# define OTHERCTXMID(first, last) first##GC##last
874#endif
875
876/** @def CTXALLMID
877 * Adds the current context as a middle name of an identifier name.
878 * The middle name is R3, R0 or GC.
879 *
880 * This is macro should only be used in shared code to avoid a forest of ifdefs.
881 * @param first First name.
882 * @param last Surname.
883 * @deprecated use CTX_MID or CTX_MID_Z
884 */
885#ifdef IN_RC
886# define CTXALLMID(first, last) first##GC##last
887#elif defined(IN_RING0)
888# define CTXALLMID(first, last) first##R0##last
889#else
890# define CTXALLMID(first, last) first##R3##last
891#endif
892
893/** @def CTX_MID
894 * Adds the current context as a middle name of an identifier name.
895 * The middle name is R3, R0 or RC.
896 *
897 * This is macro should only be used in shared code to avoid a forest of ifdefs.
898 * @param first First name.
899 * @param last Surname.
900 */
901#ifdef IN_RC
902# define CTX_MID(first, last) first##RC##last
903#elif defined(IN_RING0)
904# define CTX_MID(first, last) first##R0##last
905#else
906# define CTX_MID(first, last) first##R3##last
907#endif
908
909/** @def CTX_MID_Z
910 * Adds the current context as a middle name of an identifier name, combining RC
911 * and R0 into RZ.
912 * The middle name thus is either R3 or RZ.
913 *
914 * This is macro should only be used in shared code to avoid a forest of ifdefs.
915 * @param first First name.
916 * @param last Surname.
917 */
918#ifdef IN_RING3
919# define CTX_MID_Z(first, last) first##R3##last
920#else
921# define CTX_MID_Z(first, last) first##RZ##last
922#endif
923
924
925/** @def R3STRING
926 * A macro which in GC and R0 will return a dummy string while in R3 it will return
927 * the parameter.
928 *
929 * This is typically used to wrap description strings in structures shared
930 * between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING3 mess.
931 *
932 * @param pR3String The R3 string. Only referenced in R3.
933 * @see R0STRING and GCSTRING
934 */
935#ifdef IN_RING3
936# define R3STRING(pR3String) (pR3String)
937#else
938# define R3STRING(pR3String) ("<R3_STRING>")
939#endif
940
941/** @def R0STRING
942 * A macro which in GC and R3 will return a dummy string while in R0 it will return
943 * the parameter.
944 *
945 * This is typically used to wrap description strings in structures shared
946 * between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING0 mess.
947 *
948 * @param pR0String The R0 string. Only referenced in R0.
949 * @see R3STRING and GCSTRING
950 */
951#ifdef IN_RING0
952# define R0STRING(pR0String) (pR0String)
953#else
954# define R0STRING(pR0String) ("<R0_STRING>")
955#endif
956
957/** @def RCSTRING
958 * A macro which in R3 and R0 will return a dummy string while in RC it will return
959 * the parameter.
960 *
961 * This is typically used to wrap description strings in structures shared
962 * between R3, R0 and/or RC. The intention is to avoid the \#ifdef IN_RC mess.
963 *
964 * @param pRCString The RC string. Only referenced in RC.
965 * @see R3STRING, R0STRING
966 */
967#ifdef IN_RC
968# define RCSTRING(pRCString) (pRCString)
969#else
970# define RCSTRING(pRCString) ("<RC_STRING>")
971#endif
972
973
974/** @def RT_NOTHING
975 * A macro that expands to nothing.
976 * This is primarily intended as a dummy argument for macros to avoid the
977 * undefined behavior passing empty arguments to an macro (ISO C90 and C++98,
978 * gcc v4.4 warns about it).
979 */
980#define RT_NOTHING
981
982/** @def RT_GCC_EXTENSION
983 * Macro for shutting up GCC warnings about using language extensions. */
984#ifdef __GNUC__
985# define RT_GCC_EXTENSION __extension__
986#else
987# define RT_GCC_EXTENSION
988#endif
989
990/** @def RT_COMPILER_GROKS_64BIT_BITFIELDS
991 * Macro that is defined if the compiler understands 64-bit bitfields. */
992#if !defined(RT_OS_OS2) || (!defined(__IBMC__) && !defined(__IBMCPP__))
993# if !defined(__WATCOMC__) /* watcom compiler doesn't grok it either. */
994# define RT_COMPILER_GROKS_64BIT_BITFIELDS
995# endif
996#endif
997
998/** @def RT_COMPILER_WITH_80BIT_LONG_DOUBLE
999 * Macro that is defined if the compiler implements long double as the
1000 * IEEE extended precision floating. */
1001#if (defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)) && !defined(RT_OS_WINDOWS)
1002# define RT_COMPILER_WITH_80BIT_LONG_DOUBLE
1003#endif
1004
1005
1006/** @def RT_EXCEPTIONS_ENABLED
1007 * Defined when C++ exceptions are enabled.
1008 */
1009#if !defined(RT_EXCEPTIONS_ENABLED) \
1010 && defined(__cplusplus) \
1011 && ( (defined(_MSC_VER) && defined(_CPPUNWIND)) \
1012 || (defined(__GNUC__) && defined(__EXCEPTIONS)))
1013# define RT_EXCEPTIONS_ENABLED
1014#endif
1015
1016/** @def RT_NO_THROW_PROTO
1017 * How to express that a function doesn't throw C++ exceptions
1018 * and the compiler can thus save itself the bother of trying
1019 * to catch any of them. Put this between the closing parenthesis
1020 * and the semicolon in function prototypes (and implementation if C++).
1021 *
1022 * @remarks May not work on C++ methods, mainly intented for C-style APIs.
1023 *
1024 * @remarks The use of the nothrow attribute with GCC is because old compilers
1025 * (4.1.1, 32-bit) leaking the nothrow into global space or something
1026 * when used with RTDECL or similar. Using this forces use to have two
1027 * macros, as the nothrow attribute is not for the function definition.
1028 */
1029#ifdef RT_EXCEPTIONS_ENABLED
1030# ifdef __GNUC__
1031# define RT_NO_THROW_PROTO __attribute__((__nothrow__))
1032# else
1033# define RT_NO_THROW_PROTO throw()
1034# endif
1035#else
1036# define RT_NO_THROW_PROTO
1037#endif
1038
1039/** @def RT_NO_THROW_DEF
1040 * The counter part to RT_NO_THROW_PROTO that is added to the function
1041 * definition.
1042 */
1043#if defined(RT_EXCEPTIONS_ENABLED) && !defined(__GNUC__)
1044# define RT_NO_THROW_DEF RT_NO_THROW_PROTO
1045#else
1046# define RT_NO_THROW_DEF
1047#endif
1048
1049/** @def RT_THROW
1050 * How to express that a method or function throws a type of exceptions. Some
1051 * compilers does not want this kind of information and will warning about it.
1052 *
1053 * @param type The type exception.
1054 *
1055 * @remarks If the actual throwing is done from the header, enclose it by
1056 * \#ifdef RT_EXCEPTIONS_ENABLED ... \#else ... \#endif so the header
1057 * compiles cleanly without exceptions enabled.
1058 *
1059 * Do NOT use this for the actual throwing of exceptions!
1060 */
1061#ifdef RT_EXCEPTIONS_ENABLED
1062# ifdef _MSC_VER
1063# if _MSC_VER >= 1310
1064# define RT_THROW(type)
1065# else
1066# define RT_THROW(type) throw(type)
1067# endif
1068# else
1069# define RT_THROW(type) throw(type)
1070# endif
1071#else
1072# define RT_THROW(type)
1073#endif
1074
1075/** @def RT_IPRT_FORMAT_ATTR
1076 * Identifies a function taking an IPRT format string.
1077 * @param a_iFmt The index (1-based) of the format string argument.
1078 * @param a_iArgs The index (1-based) of the first format argument, use 0 for
1079 * va_list.
1080 */
1081#if defined(__GNUC__) && defined(WITH_IPRT_FORMAT_ATTRIBUTE)
1082# define RT_IPRT_FORMAT_ATTR(a_iFmt, a_iArgs) __attribute__((__iprt_format__(a_iFmt, a_iArgs)))
1083#else
1084# define RT_IPRT_FORMAT_ATTR(a_iFmt, a_iArgs)
1085#endif
1086
1087/** @def RT_IPRT_FORMAT_ATTR_MAYBE_NULL
1088 * Identifies a function taking an IPRT format string, NULL is allowed.
1089 * @param a_iFmt The index (1-based) of the format string argument.
1090 * @param a_iArgs The index (1-based) of the first format argument, use 0 for
1091 * va_list.
1092 */
1093#if defined(__GNUC__) && defined(WITH_IPRT_FORMAT_ATTRIBUTE)
1094# define RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a_iFmt, a_iArgs) __attribute__((__iprt_format_maybe_null__(a_iFmt, a_iArgs)))
1095#else
1096# define RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a_iFmt, a_iArgs)
1097#endif
1098
1099
1100/** @def RT_GCC_SUPPORTS_VISIBILITY_HIDDEN
1101 * Indicates that the "hidden" visibility attribute can be used (GCC) */
1102#if defined(__GNUC__)
1103# if __GNUC__ >= 4 && !defined(RT_OS_OS2) && !defined(RT_OS_WINDOWS)
1104# define RT_GCC_SUPPORTS_VISIBILITY_HIDDEN
1105# endif
1106#endif
1107
1108/** @def RT_COMPILER_SUPPORTS_VA_ARGS
1109 * If the defined, the compiler supports the variadic macro feature (..., __VA_ARGS__). */
1110#if defined(_MSC_VER)
1111# if _MSC_VER >= 1600 /* Visual C++ v10.0 / 2010 */
1112# define RT_COMPILER_SUPPORTS_VA_ARGS
1113# endif
1114#elif defined(__GNUC__)
1115# if __GNUC__ >= 3 /* not entirely sure when this was added */
1116# define RT_COMPILER_SUPPORTS_VA_ARGS
1117# endif
1118#endif
1119
1120
1121
1122/** @def RTCALL
1123 * The standard calling convention for the Runtime interfaces.
1124 *
1125 * @remarks The regparm(0) in the X86/GNUC variant deals with -mregparm=x use in
1126 * the linux kernel and potentially elsewhere (3rd party).
1127 */
1128#if defined(_MSC_VER) || defined(__WATCOMC__)
1129# define RTCALL __cdecl
1130#elif defined(RT_OS_OS2)
1131# define RTCALL __cdecl
1132#elif defined(__GNUC__) && defined(RT_ARCH_X86)
1133# define RTCALL __attribute__((cdecl,regparm(0)))
1134#else
1135# define RTCALL
1136#endif
1137
1138/** @def DECLEXPORT
1139 * How to declare an exported function.
1140 * @param type The return type of the function declaration.
1141 */
1142#if defined(_MSC_VER) || defined(RT_OS_OS2)
1143# define DECLEXPORT(type) __declspec(dllexport) type
1144#elif defined(RT_USE_VISIBILITY_DEFAULT)
1145# define DECLEXPORT(type) __attribute__((visibility("default"))) type
1146#else
1147# define DECLEXPORT(type) type
1148#endif
1149
1150/** @def DECLIMPORT
1151 * How to declare an imported function.
1152 * @param type The return type of the function declaration.
1153 */
1154#if defined(_MSC_VER) || (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
1155# define DECLIMPORT(type) __declspec(dllimport) type
1156#else
1157# define DECLIMPORT(type) type
1158#endif
1159
1160/** @def DECLHIDDEN
1161 * How to declare a non-exported function or variable.
1162 * @param type The return type of the function or the data type of the variable.
1163 */
1164#if !defined(RT_GCC_SUPPORTS_VISIBILITY_HIDDEN) || defined(RT_NO_VISIBILITY_HIDDEN)
1165# define DECLHIDDEN(type) type
1166#else
1167# define DECLHIDDEN(type) __attribute__((visibility("hidden"))) type
1168#endif
1169
1170/** @def DECL_HIDDEN_CONST
1171 * Workaround for g++ warnings when applying the hidden attribute to a const
1172 * definition. Use DECLHIDDEN for the declaration.
1173 * @param a_Type The return type of the function or the data type of
1174 * the variable.
1175 */
1176#if defined(__cplusplus) && defined(__GNUC__)
1177# define DECL_HIDDEN_CONST(a_Type) a_Type
1178#else
1179# define DECL_HIDDEN_CONST(a_Type) DECLHIDDEN(a_Type)
1180#endif
1181
1182/** @def DECL_INVALID
1183 * How to declare a function not available for linking in the current context.
1184 * The purpose is to create compile or like time errors when used. This isn't
1185 * possible on all platforms.
1186 * @param type The return type of the function.
1187 */
1188#if defined(_MSC_VER)
1189# define DECL_INVALID(type) __declspec(dllimport) type __stdcall
1190#elif defined(__GNUC__) && defined(__cplusplus)
1191# define DECL_INVALID(type) extern "C++" type
1192#else
1193# define DECL_INVALID(type) type
1194#endif
1195
1196/** @def DECLASM
1197 * How to declare an internal assembly function.
1198 * @param type The return type of the function declaration.
1199 */
1200#ifdef __cplusplus
1201# define DECLASM(type) extern "C" type RTCALL
1202#else
1203# define DECLASM(type) type RTCALL
1204#endif
1205
1206/** @def DECLASMTYPE
1207 * How to declare an internal assembly function type.
1208 * @param type The return type of the function.
1209 */
1210#define DECLASMTYPE(type) type RTCALL
1211
1212/** @def DECL_NO_RETURN
1213 * How to declare a function which does not return.
1214 * @note This macro can be combined with other macros, for example
1215 * @code
1216 * EMR3DECL(DECL_NO_RETURN(void)) foo(void);
1217 * @endcode
1218 */
1219#ifdef _MSC_VER
1220# define DECL_NO_RETURN(type) __declspec(noreturn) type
1221#elif defined(__GNUC__)
1222# define DECL_NO_RETURN(type) __attribute__((noreturn)) type
1223#else
1224# define DECL_NO_RETURN(type) type
1225#endif
1226/** @deprecated Use DECL_NO_RETURN instead. */
1227#define DECLNORETURN(type) DECL_NO_RETURN(type)
1228
1229/** @def DECL_RETURNS_TWICE
1230 * How to declare a function which may return more than once.
1231 * @note This macro can be combined with other macros, for example
1232 * @code
1233 * EMR3DECL(DECL_RETURNS_TWICE(void)) MySetJmp(void);
1234 * @endcode
1235 */
1236#if RT_GNUC_PREREQ(4, 1)
1237# define DECL_RETURNS_TWICE(type) __attribute__((returns_twice)) type
1238# else
1239# define DECL_RETURNS_TWICE(type) type
1240#endif
1241
1242/** @def DECLWEAK
1243 * How to declare a variable which is not necessarily resolved at
1244 * runtime.
1245 * @note This macro can be combined with other macros, for example
1246 * @code
1247 * EMR3DECL(DECLWEAK(int)) foo;
1248 * @endcode
1249 */
1250#if defined(__GNUC__)
1251# define DECLWEAK(type) type __attribute__((weak))
1252#else
1253# define DECLWEAK(type) type
1254#endif
1255
1256/** @def DECLCALLBACK
1257 * How to declare an call back function type.
1258 * @param type The return type of the function declaration.
1259 */
1260#define DECLCALLBACK(type) type RTCALL
1261
1262/** @def DECLCALLBACKPTR
1263 * How to declare an call back function pointer.
1264 * @param type The return type of the function declaration.
1265 * @param name The name of the variable member.
1266 */
1267#if defined(__IBMC__) || defined(__IBMCPP__)
1268# define DECLCALLBACKPTR(type, name) type (* RTCALL name)
1269#else
1270# define DECLCALLBACKPTR(type, name) type (RTCALL * name)
1271#endif
1272
1273/** @def DECLCALLBACKMEMBER
1274 * How to declare an call back function pointer member.
1275 * @param type The return type of the function declaration.
1276 * @param name The name of the struct/union/class member.
1277 */
1278#if defined(__IBMC__) || defined(__IBMCPP__)
1279# define DECLCALLBACKMEMBER(type, name) type (* RTCALL name)
1280#else
1281# define DECLCALLBACKMEMBER(type, name) type (RTCALL * name)
1282#endif
1283
1284/** @def DECLR3CALLBACKMEMBER
1285 * How to declare an call back function pointer member - R3 Ptr.
1286 * @param type The return type of the function declaration.
1287 * @param name The name of the struct/union/class member.
1288 * @param args The argument list enclosed in parentheses.
1289 */
1290#ifdef IN_RING3
1291# define DECLR3CALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1292#else
1293# define DECLR3CALLBACKMEMBER(type, name, args) RTR3PTR name
1294#endif
1295
1296/** @def DECLRCCALLBACKMEMBER
1297 * How to declare an call back function pointer member - RC Ptr.
1298 * @param type The return type of the function declaration.
1299 * @param name The name of the struct/union/class member.
1300 * @param args The argument list enclosed in parentheses.
1301 */
1302#ifdef IN_RC
1303# define DECLRCCALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1304#else
1305# define DECLRCCALLBACKMEMBER(type, name, args) RTRCPTR name
1306#endif
1307
1308/** @def DECLR0CALLBACKMEMBER
1309 * How to declare an call back function pointer member - R0 Ptr.
1310 * @param type The return type of the function declaration.
1311 * @param name The name of the struct/union/class member.
1312 * @param args The argument list enclosed in parentheses.
1313 */
1314#ifdef IN_RING0
1315# define DECLR0CALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1316#else
1317# define DECLR0CALLBACKMEMBER(type, name, args) RTR0PTR name
1318#endif
1319
1320/** @def DECLINLINE
1321 * How to declare a function as inline.
1322 * @param type The return type of the function declaration.
1323 * @remarks Don't use this macro on C++ methods.
1324 */
1325#ifdef __GNUC__
1326# define DECLINLINE(type) static __inline__ type
1327#elif defined(__cplusplus)
1328# define DECLINLINE(type) static inline type
1329#elif defined(_MSC_VER)
1330# define DECLINLINE(type) static _inline type
1331#elif defined(__IBMC__)
1332# define DECLINLINE(type) _Inline type
1333#else
1334# define DECLINLINE(type) inline type
1335#endif
1336
1337
1338/** @def DECL_FORCE_INLINE
1339 * How to declare a function as inline and try convince the compiler to always
1340 * inline it regardless of optimization switches.
1341 * @param type The return type of the function declaration.
1342 * @remarks Use sparsely and with care. Don't use this macro on C++ methods.
1343 */
1344#ifdef __GNUC__
1345# define DECL_FORCE_INLINE(type) __attribute__((__always_inline__)) DECLINLINE(type)
1346#elif defined(_MSC_VER)
1347# define DECL_FORCE_INLINE(type) __forceinline type
1348#else
1349# define DECL_FORCE_INLINE(type) DECLINLINE(type)
1350#endif
1351
1352
1353/** @def DECL_NO_INLINE
1354 * How to declare a function telling the compiler not to inline it.
1355 * @param scope The function scope, static or RT_NOTHING.
1356 * @param type The return type of the function declaration.
1357 * @remarks Don't use this macro on C++ methods.
1358 */
1359#ifdef __GNUC__
1360# define DECL_NO_INLINE(scope,type) __attribute__((__noinline__)) scope type
1361#elif defined(_MSC_VER)
1362# define DECL_NO_INLINE(scope,type) __declspec(noinline) scope type
1363#else
1364# define DECL_NO_INLINE(scope,type) scope type
1365#endif
1366
1367
1368/** @def IN_RT_STATIC
1369 * Used to indicate whether we're linking against a static IPRT
1370 * or not. The IPRT symbols will be declared as hidden (if
1371 * supported). Note that this define has no effect without setting
1372 * IN_RT_R0, IN_RT_R3 or IN_RT_RC indicators are set first.
1373 */
1374
1375/** @def IN_RT_R0
1376 * Used to indicate whether we're inside the same link module as
1377 * the HC Ring-0 Runtime Library.
1378 */
1379/** @def RTR0DECL(type)
1380 * Runtime Library HC Ring-0 export or import declaration.
1381 * @param type The return type of the function declaration.
1382 */
1383#ifdef IN_RT_R0
1384# ifdef IN_RT_STATIC
1385# define RTR0DECL(type) DECLHIDDEN(type) RTCALL
1386# else
1387# define RTR0DECL(type) DECLEXPORT(type) RTCALL
1388# endif
1389#else
1390# define RTR0DECL(type) DECLIMPORT(type) RTCALL
1391#endif
1392
1393/** @def IN_RT_R3
1394 * Used to indicate whether we're inside the same link module as
1395 * the HC Ring-3 Runtime Library.
1396 */
1397/** @def RTR3DECL(type)
1398 * Runtime Library HC Ring-3 export or import declaration.
1399 * @param type The return type of the function declaration.
1400 */
1401#ifdef IN_RT_R3
1402# ifdef IN_RT_STATIC
1403# define RTR3DECL(type) DECLHIDDEN(type) RTCALL
1404# else
1405# define RTR3DECL(type) DECLEXPORT(type) RTCALL
1406# endif
1407#else
1408# define RTR3DECL(type) DECLIMPORT(type) RTCALL
1409#endif
1410
1411/** @def IN_RT_RC
1412 * Used to indicate whether we're inside the same link module as the raw-mode
1413 * context (RC) runtime library.
1414 */
1415/** @def RTRCDECL(type)
1416 * Runtime Library raw-mode context export or import declaration.
1417 * @param type The return type of the function declaration.
1418 */
1419#ifdef IN_RT_RC
1420# ifdef IN_RT_STATIC
1421# define RTRCDECL(type) DECLHIDDEN(type) RTCALL
1422# else
1423# define RTRCDECL(type) DECLEXPORT(type) RTCALL
1424# endif
1425#else
1426# define RTRCDECL(type) DECLIMPORT(type) RTCALL
1427#endif
1428
1429/** @def RTDECL(type)
1430 * Runtime Library export or import declaration.
1431 * Functions declared using this macro exists in all contexts.
1432 * @param type The return type of the function declaration.
1433 */
1434#if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0)
1435# ifdef IN_RT_STATIC
1436# define RTDECL(type) DECLHIDDEN(type) RTCALL
1437# else
1438# define RTDECL(type) DECLEXPORT(type) RTCALL
1439# endif
1440#else
1441# define RTDECL(type) DECLIMPORT(type) RTCALL
1442#endif
1443
1444/** @def RTDATADECL(type)
1445 * Runtime Library export or import declaration.
1446 * Data declared using this macro exists in all contexts.
1447 * @param type The data type.
1448 */
1449/** @def RT_DECL_DATA_CONST(type)
1450 * Definition of a const variable. See DECL_HIDDEN_CONST.
1451 * @param type The const data type.
1452 */
1453#if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0)
1454# ifdef IN_RT_STATIC
1455# define RTDATADECL(type) DECLHIDDEN(type)
1456# define RT_DECL_DATA_CONST(type) DECL_HIDDEN_CONST(type)
1457# else
1458# define RTDATADECL(type) DECLEXPORT(type)
1459# if defined(__cplusplus) && defined(__GNUC__)
1460# define RT_DECL_DATA_CONST(type) type
1461# else
1462# define RT_DECL_DATA_CONST(type) DECLEXPORT(type)
1463# endif
1464# endif
1465#else
1466# define RTDATADECL(type) DECLIMPORT(type)
1467# define RT_DECL_DATA_CONST(type) DECLIMPORT(type)
1468#endif
1469
1470/** @def RT_DECL_CLASS
1471 * Declares an class living in the runtime.
1472 */
1473#if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0)
1474# ifdef IN_RT_STATIC
1475# define RT_DECL_CLASS
1476# else
1477# define RT_DECL_CLASS DECLEXPORT_CLASS
1478# endif
1479#else
1480# define RT_DECL_CLASS DECLIMPORT_CLASS
1481#endif
1482
1483
1484/** @def RT_NOCRT
1485 * Symbol name wrapper for the No-CRT bits.
1486 *
1487 * In order to coexist in the same process as other CRTs, we need to
1488 * decorate the symbols such that they don't conflict the ones in the
1489 * other CRTs. The result of such conflicts / duplicate symbols can
1490 * confuse the dynamic loader on Unix like systems.
1491 *
1492 * Define RT_WITHOUT_NOCRT_WRAPPERS to drop the wrapping.
1493 * Define RT_WITHOUT_NOCRT_WRAPPER_ALIASES to drop the aliases to the
1494 * wrapped names.
1495 */
1496/** @def RT_NOCRT_STR
1497 * Same as RT_NOCRT only it'll return a double quoted string of the result.
1498 */
1499#ifndef RT_WITHOUT_NOCRT_WRAPPERS
1500# define RT_NOCRT(name) nocrt_ ## name
1501# define RT_NOCRT_STR(name) "nocrt_" # name
1502#else
1503# define RT_NOCRT(name) name
1504# define RT_NOCRT_STR(name) #name
1505#endif
1506
1507
1508
1509/** @def RT_LIKELY
1510 * Give the compiler a hint that an expression is very likely to hold true.
1511 *
1512 * Some compilers support explicit branch prediction so that the CPU backend
1513 * can hint the processor and also so that code blocks can be reordered such
1514 * that the predicted path sees a more linear flow, thus improving cache
1515 * behaviour, etc.
1516 *
1517 * IPRT provides the macros RT_LIKELY() and RT_UNLIKELY() as a way to utilize
1518 * this compiler feature when present.
1519 *
1520 * A few notes about the usage:
1521 *
1522 * - Generally, order your code use RT_LIKELY() instead of RT_UNLIKELY().
1523 *
1524 * - Generally, use RT_UNLIKELY() with error condition checks (unless you
1525 * have some _strong_ reason to do otherwise, in which case document it),
1526 * and/or RT_LIKELY() with success condition checks, assuming you want
1527 * to optimize for the success path.
1528 *
1529 * - Other than that, if you don't know the likelihood of a test succeeding
1530 * from empirical or other 'hard' evidence, don't make predictions unless
1531 * you happen to be a Dirk Gently character.
1532 *
1533 * - These macros are meant to be used in places that get executed a lot. It
1534 * is wasteful to make predictions in code that is executed rarely (e.g.
1535 * at subsystem initialization time) as the basic block reordering that this
1536 * affects can often generate larger code.
1537 *
1538 * - Note that RT_SUCCESS() and RT_FAILURE() already makes use of RT_LIKELY()
1539 * and RT_UNLIKELY(). Should you wish for prediction free status checks,
1540 * use the RT_SUCCESS_NP() and RT_FAILURE_NP() macros instead.
1541 *
1542 *
1543 * @returns the boolean result of the expression.
1544 * @param expr The expression that's very likely to be true.
1545 * @see RT_UNLIKELY
1546 */
1547/** @def RT_UNLIKELY
1548 * Give the compiler a hint that an expression is highly unlikely to hold true.
1549 *
1550 * See the usage instructions give in the RT_LIKELY() docs.
1551 *
1552 * @returns the boolean result of the expression.
1553 * @param expr The expression that's very unlikely to be true.
1554 * @see RT_LIKELY
1555 *
1556 * @deprecated Please use RT_LIKELY() instead wherever possible! That gives us
1557 * a better chance of the windows compilers to generate favorable code
1558 * too. The belief is that the compiler will by default assume the
1559 * if-case is more likely than the else-case.
1560 */
1561#if defined(__GNUC__)
1562# if __GNUC__ >= 3 && !defined(FORTIFY_RUNNING)
1563# define RT_LIKELY(expr) __builtin_expect(!!(expr), 1)
1564# define RT_UNLIKELY(expr) __builtin_expect(!!(expr), 0)
1565# else
1566# define RT_LIKELY(expr) (expr)
1567# define RT_UNLIKELY(expr) (expr)
1568# endif
1569#else
1570# define RT_LIKELY(expr) (expr)
1571# define RT_UNLIKELY(expr) (expr)
1572#endif
1573
1574/** @def RT_EXPAND_2
1575 * Helper for RT_EXPAND. */
1576#define RT_EXPAND_2(a_Expr) a_Expr
1577/** @def RT_EXPAND
1578 * Returns the expanded expression.
1579 * @param a_Expr The expression to expand. */
1580#define RT_EXPAND(a_Expr) RT_EXPAND_2(a_Expr)
1581
1582/** @def RT_STR
1583 * Returns the argument as a string constant.
1584 * @param str Argument to stringify. */
1585#define RT_STR(str) #str
1586/** @def RT_XSTR
1587 * Returns the expanded argument as a string.
1588 * @param str Argument to expand and stringify. */
1589#define RT_XSTR(str) RT_STR(str)
1590
1591/** @def RT_LSTR_2
1592 * Helper for RT_WSTR that gets the expanded @a str.
1593 * @param str String litteral to prefix with 'L'. */
1594#define RT_LSTR_2(str) L##str
1595/** @def RT_LSTR
1596 * Returns the expanded argument with a L string prefix.
1597 *
1598 * Intended for converting ASCII string \#defines into wide char string
1599 * litterals on Windows.
1600 *
1601 * @param str String litteral to . */
1602#define RT_LSTR(str) RT_LSTR_2(str)
1603
1604/** @def RT_UNPACK_CALL
1605 * Unpacks the an argument list inside an extra set of parenthesis and turns it
1606 * into a call to @a a_Fn.
1607 *
1608 * @param a_Fn Function/macro to call.
1609 * @param a_Args Parameter list in parenthesis.
1610 */
1611#define RT_UNPACK_CALL(a_Fn, a_Args) a_Fn a_Args
1612
1613#if defined(RT_COMPILER_SUPPORTS_VA_ARGS) || defined(DOXYGEN_RUNNING)
1614
1615/** @def RT_UNPACK_ARGS
1616 * Returns the arguments without parenthesis.
1617 *
1618 * @param ... Parameter list in parenthesis.
1619 * @remarks Requires RT_COMPILER_SUPPORTS_VA_ARGS.
1620 */
1621# define RT_UNPACK_ARGS(...) __VA_ARGS__
1622
1623/** @def RT_COUNT_VA_ARGS_HLP
1624 * Helper for RT_COUNT_VA_ARGS that picks out the argument count from
1625 * RT_COUNT_VA_ARGS_REV_SEQ. */
1626# define RT_COUNT_VA_ARGS_HLP( \
1627 c69, c68, c67, c66, c65, c64, c63, c62, c61, c60, \
1628 c59, c58, c57, c56, c55, c54, c53, c52, c51, c50, \
1629 c49, c48, c47, c46, c45, c44, c43, c42, c41, c40, \
1630 c39, c38, c37, c36, c35, c34, c33, c32, c31, c30, \
1631 c29, c28, c27, c26, c25, c24, c23, c22, c21, c20, \
1632 c19, c18, c17, c16, c15, c14, c13, c12, c11, c10, \
1633 c9, c8, c7, c6, c5, c4, c3, c2, c1, cArgs, ...) cArgs
1634/** Argument count sequence. */
1635# define RT_COUNT_VA_ARGS_REV_SEQ \
1636 69, 68, 67, 66, 65, 64, 63, 62, 61, 60, \
1637 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, \
1638 49, 48, 47, 46, 45, 44, 43, 42, 41, 40, \
1639 39, 38, 37, 36, 35, 34, 33, 32, 31, 30, \
1640 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, \
1641 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, \
1642 9, 8, 7, 6, 5, 4, 3, 2, 1, 0
1643/** This is for zero arguments. At least Visual C++ requires it. */
1644# define RT_COUNT_VA_ARGS_PREFIX_RT_NOTHING RT_COUNT_VA_ARGS_REV_SEQ
1645/**
1646 * Counts the number of arguments given to the variadic macro.
1647 *
1648 * Max is 69.
1649 *
1650 * @returns Number of arguments in the ellipsis
1651 * @param ... Arguments to count.
1652 * @remarks Requires RT_COMPILER_SUPPORTS_VA_ARGS.
1653 */
1654# define RT_COUNT_VA_ARGS(...) \
1655 RT_UNPACK_CALL(RT_COUNT_VA_ARGS_HLP, (RT_COUNT_VA_ARGS_PREFIX_ ## __VA_ARGS__ ## RT_NOTHING, \
1656 RT_COUNT_VA_ARGS_REV_SEQ))
1657
1658#endif /* RT_COMPILER_SUPPORTS_VA_ARGS */
1659
1660
1661/** @def RT_CONCAT
1662 * Concatenate the expanded arguments without any extra spaces in between.
1663 *
1664 * @param a The first part.
1665 * @param b The second part.
1666 */
1667#define RT_CONCAT(a,b) RT_CONCAT_HLP(a,b)
1668/** RT_CONCAT helper, don't use. */
1669#define RT_CONCAT_HLP(a,b) a##b
1670
1671/** @def RT_CONCAT3
1672 * Concatenate the expanded arguments without any extra spaces in between.
1673 *
1674 * @param a The 1st part.
1675 * @param b The 2nd part.
1676 * @param c The 3rd part.
1677 */
1678#define RT_CONCAT3(a,b,c) RT_CONCAT3_HLP(a,b,c)
1679/** RT_CONCAT3 helper, don't use. */
1680#define RT_CONCAT3_HLP(a,b,c) a##b##c
1681
1682/** @def RT_CONCAT4
1683 * Concatenate the expanded arguments without any extra spaces in between.
1684 *
1685 * @param a The 1st part.
1686 * @param b The 2nd part.
1687 * @param c The 3rd part.
1688 * @param d The 4th part.
1689 */
1690#define RT_CONCAT4(a,b,c,d) RT_CONCAT4_HLP(a,b,c,d)
1691/** RT_CONCAT4 helper, don't use. */
1692#define RT_CONCAT4_HLP(a,b,c,d) a##b##c##d
1693
1694/** @def RT_CONCAT5
1695 * Concatenate the expanded arguments without any extra spaces in between.
1696 *
1697 * @param a The 1st part.
1698 * @param b The 2nd part.
1699 * @param c The 3rd part.
1700 * @param d The 4th part.
1701 * @param e The 5th part.
1702 */
1703#define RT_CONCAT5(a,b,c,d,e) RT_CONCAT5_HLP(a,b,c,d,e)
1704/** RT_CONCAT5 helper, don't use. */
1705#define RT_CONCAT5_HLP(a,b,c,d,e) a##b##c##d##e
1706
1707/** @def RT_CONCAT6
1708 * Concatenate the expanded arguments without any extra spaces in between.
1709 *
1710 * @param a The 1st part.
1711 * @param b The 2nd part.
1712 * @param c The 3rd part.
1713 * @param d The 4th part.
1714 * @param e The 5th part.
1715 * @param f The 6th part.
1716 */
1717#define RT_CONCAT6(a,b,c,d,e,f) RT_CONCAT6_HLP(a,b,c,d,e,f)
1718/** RT_CONCAT6 helper, don't use. */
1719#define RT_CONCAT6_HLP(a,b,c,d,e,f) a##b##c##d##e##f
1720
1721/**
1722 * String constant tuple - string constant, strlen(string constant).
1723 *
1724 * @param a_szConst String constant.
1725 * @sa RTSTRTUPLE
1726 */
1727#define RT_STR_TUPLE(a_szConst) a_szConst, (sizeof(a_szConst) - 1)
1728
1729
1730/**
1731 * Macro for using in switch statements that turns constants into strings.
1732 *
1733 * @param a_Const The constant (not string).
1734 */
1735#define RT_CASE_RET_STR(a_Const) case a_Const: return #a_Const
1736
1737
1738/** @def RT_BIT
1739 * Convert a bit number into an integer bitmask (unsigned).
1740 * @param bit The bit number.
1741 */
1742#define RT_BIT(bit) ( 1U << (bit) )
1743
1744/** @def RT_BIT_32
1745 * Convert a bit number into a 32-bit bitmask (unsigned).
1746 * @param bit The bit number.
1747 */
1748#define RT_BIT_32(bit) ( UINT32_C(1) << (bit) )
1749
1750/** @def RT_BIT_64
1751 * Convert a bit number into a 64-bit bitmask (unsigned).
1752 * @param bit The bit number.
1753 */
1754#define RT_BIT_64(bit) ( UINT64_C(1) << (bit) )
1755
1756
1757/** @def RT_BF_GET
1758 * Gets the value of a bit field in an integer value.
1759 *
1760 * This requires a couple of macros to be defined for the field:
1761 * - \<a_FieldNm\>_SHIFT: The shift count to get to the field.
1762 * - \<a_FieldNm\>_MASK: The field mask.
1763 *
1764 * @returns The bit field value.
1765 * @param a_uValue The integer value containing the field.
1766 * @param a_FieldNm The field name prefix for getting at the _SHIFT and
1767 * _MASK macros.
1768 * @sa #RT_BF_CLEAR, #RT_BF_SET, #RT_BF_MAKE, #RT_BF_ZMASK
1769 */
1770#define RT_BF_GET(a_uValue, a_FieldNm) ( ((a_uValue) >> RT_CONCAT(a_FieldNm,_SHIFT)) & RT_BF_ZMASK(a_FieldNm) )
1771
1772/** @def RT_BF_SET
1773 * Sets the given bit field in the integer value.
1774 *
1775 * This requires a couple of macros to be defined for the field:
1776 * - \<a_FieldNm\>_SHIFT: The shift count to get to the field.
1777 * - \<a_FieldNm\>_MASK: The field mask. Must have the same type as the
1778 * integer value!!
1779 *
1780 * @returns Integer value with bit field set to @a a_uFieldValue.
1781 * @param a_uValue The integer value containing the field.
1782 * @param a_FieldNm The field name prefix for getting at the _SHIFT and
1783 * _MASK macros.
1784 * @param a_uFieldValue The new field value.
1785 * @sa #RT_BF_GET, #RT_BF_CLEAR, #RT_BF_MAKE, #RT_BF_ZMASK
1786 */
1787#define RT_BF_SET(a_uValue, a_FieldNm, a_uFieldValue) ( RT_BF_CLEAR(a_uValue, a_FieldNm) | RT_BF_MAKE(a_FieldNm, a_uFieldValue) )
1788
1789/** @def RT_BF_CLEAR
1790 * Clears the given bit field in the integer value.
1791 *
1792 * This requires a couple of macros to be defined for the field:
1793 * - \<a_FieldNm\>_SHIFT: The shift count to get to the field.
1794 * - \<a_FieldNm\>_MASK: The field mask. Must have the same type as the
1795 * integer value!!
1796 *
1797 * @returns Integer value with bit field set to zero.
1798 * @param a_uValue The integer value containing the field.
1799 * @param a_FieldNm The field name prefix for getting at the _SHIFT and
1800 * _MASK macros.
1801 * @sa #RT_BF_GET, #RT_BF_SET, #RT_BF_MAKE, #RT_BF_ZMASK
1802 */
1803#define RT_BF_CLEAR(a_uValue, a_FieldNm) ( (a_uValue) & ~RT_CONCAT(a_FieldNm,_MASK) )
1804
1805/** @def RT_BF_MAKE
1806 * Shifts and masks a bit field value into position in the integer value.
1807 *
1808 * This requires a couple of macros to be defined for the field:
1809 * - \<a_FieldNm\>_SHIFT: The shift count to get to the field.
1810 * - \<a_FieldNm\>_MASK: The field mask.
1811 *
1812 * @param a_FieldNm The field name prefix for getting at the _SHIFT and
1813 * _MASK macros.
1814 * @param a_uFieldValue The field value that should be masked and shifted
1815 * into position.
1816 * @sa #RT_BF_GET, #RT_BF_SET, #RT_BF_CLEAR, #RT_BF_ZMASK
1817 */
1818#define RT_BF_MAKE(a_FieldNm, a_uFieldValue) ( ((a_uFieldValue) & RT_BF_ZMASK(a_FieldNm) ) << RT_CONCAT(a_FieldNm,_SHIFT) )
1819
1820/** @def RT_BF_ZMASK
1821 * Helper for getting the field mask shifted to bit position zero.
1822 *
1823 * @param a_FieldNm The field name prefix for getting at the _SHIFT and
1824 * _MASK macros.
1825 * @sa #RT_BF_GET, #RT_BF_SET, #RT_BF_CLEAR, #RT_BF_MAKE
1826 */
1827#define RT_BF_ZMASK(a_FieldNm) ( RT_CONCAT(a_FieldNm,_MASK) >> RT_CONCAT(a_FieldNm,_SHIFT) )
1828
1829/** Bit field compile time check helper
1830 * @internal */
1831#define RT_BF_CHECK_DO_XOR_MASK(a_uLeft, a_RightPrefix, a_FieldNm) ((a_uLeft) ^ RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK))
1832/** Bit field compile time check helper
1833 * @internal */
1834#define RT_BF_CHECK_DO_OR_MASK(a_uLeft, a_RightPrefix, a_FieldNm) ((a_uLeft) | RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK))
1835/** Bit field compile time check helper
1836 * @internal */
1837#define RT_BF_CHECK_DO_1ST_MASK_BIT(a_uLeft, a_RightPrefix, a_FieldNm) \
1838 ((a_uLeft) && ( (RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK) >> RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT)) & 1U ) )
1839/** Used to check that a bit field mask does not start too early.
1840 * @internal */
1841#define RT_BF_CHECK_DO_MASK_START(a_uLeft, a_RightPrefix, a_FieldNm) \
1842 ( (a_uLeft) \
1843 && ( RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT) == 0 \
1844 || ( ( ( ((RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK) >> RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT)) & 1U) \
1845 << RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT)) /* => single bit mask, correct type */ \
1846 - 1U) /* => mask of all bits below the field */ \
1847 & RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK)) == 0 ) )
1848/** @name Bit field compile time check recursion workers.
1849 * @internal
1850 * @{ */
1851#define RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix, f1) \
1852 a_DoThis(a_uLeft, a_RightPrefix, f1)
1853#define RT_BF_CHECK_DO_2(a_DoThis, a_uLeft, a_RightPrefix, f1, f2) \
1854 RT_BF_CHECK_DO_1(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2)
1855#define RT_BF_CHECK_DO_3(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3) \
1856 RT_BF_CHECK_DO_2(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3)
1857#define RT_BF_CHECK_DO_4(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4) \
1858 RT_BF_CHECK_DO_3(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4)
1859#define RT_BF_CHECK_DO_5(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5) \
1860 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)
1861#define RT_BF_CHECK_DO_6(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6) \
1862 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)
1863#define RT_BF_CHECK_DO_7(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7) \
1864 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)
1865#define RT_BF_CHECK_DO_8(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8) \
1866 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)
1867#define RT_BF_CHECK_DO_9(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9) \
1868 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)
1869#define RT_BF_CHECK_DO_10(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10) \
1870 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)
1871#define RT_BF_CHECK_DO_11(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11) \
1872 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)
1873#define RT_BF_CHECK_DO_12(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12) \
1874 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)
1875#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) \
1876 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)
1877#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) \
1878 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)
1879#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) \
1880 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)
1881#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) \
1882 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)
1883#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) \
1884 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)
1885#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) \
1886 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)
1887#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) \
1888 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)
1889#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) \
1890 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)
1891#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) \
1892 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)
1893#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) \
1894 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)
1895#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) \
1896 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)
1897#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) \
1898 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)
1899#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) \
1900 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)
1901#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) \
1902 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)
1903#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) \
1904 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)
1905#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) \
1906 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)
1907#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) \
1908 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)
1909#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) \
1910 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)
1911#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) \
1912 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)
1913#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) \
1914 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)
1915#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) \
1916 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)
1917#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) \
1918 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)
1919#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) \
1920 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)
1921#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) \
1922 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)
1923#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) \
1924 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)
1925#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) \
1926 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)
1927#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) \
1928 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)
1929#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) \
1930 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)
1931#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) \
1932 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)
1933#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) \
1934 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)
1935#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) \
1936 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)
1937#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) \
1938 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)
1939#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) \
1940 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)
1941#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) \
1942 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)
1943#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) \
1944 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)
1945#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) \
1946 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)
1947#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) \
1948 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)
1949#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) \
1950 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)
1951#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) \
1952 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)
1953#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) \
1954 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)
1955#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) \
1956 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)
1957#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) \
1958 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)
1959#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) \
1960 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)
1961#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) \
1962 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)
1963#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) \
1964 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)
1965#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) \
1966 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)
1967#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) \
1968 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)
1969#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) \
1970 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)
1971#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) \
1972 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)
1973#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) \
1974 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)
1975#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) \
1976 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)
1977#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) \
1978 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)
1979/** @} */
1980
1981/** @def RT_BF_ASSERT_COMPILE_CHECKS
1982 * Emits a series of AssertCompile statements checking that the bit-field
1983 * declarations doesn't overlap, has holes, and generally makes some sense.
1984 *
1985 * This requires variadic macros because its too much to type otherwise.
1986 */
1987#if defined(RT_COMPILER_SUPPORTS_VA_ARGS) || defined(DOXYGEN_RUNNING)
1988# define RT_BF_ASSERT_COMPILE_CHECKS(a_Prefix, a_uZero, a_uCovered, a_Fields) \
1989 AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_OR_MASK, a_uZero, a_Prefix, RT_UNPACK_ARGS a_Fields ) == a_uCovered); \
1990 AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_XOR_MASK, a_uCovered, a_Prefix, RT_UNPACK_ARGS a_Fields ) == 0); \
1991 AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_1ST_MASK_BIT, true, a_Prefix, RT_UNPACK_ARGS a_Fields ) == true); \
1992 AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_MASK_START, true, a_Prefix, RT_UNPACK_ARGS a_Fields ) == true)
1993/** Bit field compile time check helper
1994 * @internal */
1995# define RT_BF_CHECK_DO_N(a_DoThis, a_uLeft, a_RightPrefix, ...) \
1996 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__))
1997#else
1998# define RT_BF_ASSERT_COMPILE_CHECKS(a_Prefix, a_uZero, a_uCovered, a_Fields) AssertCompile(true)
1999#endif
2000
2001
2002/** @def RT_ALIGN
2003 * Align macro.
2004 * @param u Value to align.
2005 * @param uAlignment The alignment. Power of two!
2006 *
2007 * @remark Be extremely careful when using this macro with type which sizeof != sizeof int.
2008 * When possible use any of the other RT_ALIGN_* macros. And when that's not
2009 * possible, make 101% sure that uAlignment is specified with a right sized type.
2010 *
2011 * Specifying an unsigned 32-bit alignment constant with a 64-bit value will give
2012 * you a 32-bit return value!
2013 *
2014 * In short: Don't use this macro. Use RT_ALIGN_T() instead.
2015 */
2016#define RT_ALIGN(u, uAlignment) ( ((u) + ((uAlignment) - 1)) & ~((uAlignment) - 1) )
2017
2018/** @def RT_ALIGN_T
2019 * Align macro.
2020 * @param u Value to align.
2021 * @param uAlignment The alignment. Power of two!
2022 * @param type Integer type to use while aligning.
2023 * @remark This macro is the preferred alignment macro, it doesn't have any of the pitfalls RT_ALIGN has.
2024 */
2025#define RT_ALIGN_T(u, uAlignment, type) ( ((type)(u) + ((uAlignment) - 1)) & ~(type)((uAlignment) - 1) )
2026
2027/** @def RT_ALIGN_32
2028 * Align macro for a 32-bit value.
2029 * @param u32 Value to align.
2030 * @param uAlignment The alignment. Power of two!
2031 */
2032#define RT_ALIGN_32(u32, uAlignment) RT_ALIGN_T(u32, uAlignment, uint32_t)
2033
2034/** @def RT_ALIGN_64
2035 * Align macro for a 64-bit value.
2036 * @param u64 Value to align.
2037 * @param uAlignment The alignment. Power of two!
2038 */
2039#define RT_ALIGN_64(u64, uAlignment) RT_ALIGN_T(u64, uAlignment, uint64_t)
2040
2041/** @def RT_ALIGN_Z
2042 * Align macro for size_t.
2043 * @param cb Value to align.
2044 * @param uAlignment The alignment. Power of two!
2045 */
2046#define RT_ALIGN_Z(cb, uAlignment) RT_ALIGN_T(cb, uAlignment, size_t)
2047
2048/** @def RT_ALIGN_P
2049 * Align macro for pointers.
2050 * @param pv Value to align.
2051 * @param uAlignment The alignment. Power of two!
2052 */
2053#define RT_ALIGN_P(pv, uAlignment) RT_ALIGN_PT(pv, uAlignment, void *)
2054
2055/** @def RT_ALIGN_PT
2056 * Align macro for pointers with type cast.
2057 * @param u Value to align.
2058 * @param uAlignment The alignment. Power of two!
2059 * @param CastType The type to cast the result to.
2060 */
2061#define RT_ALIGN_PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, uintptr_t) )
2062
2063/** @def RT_ALIGN_R3PT
2064 * Align macro for ring-3 pointers with type cast.
2065 * @param u Value to align.
2066 * @param uAlignment The alignment. Power of two!
2067 * @param CastType The type to cast the result to.
2068 */
2069#define RT_ALIGN_R3PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR3UINTPTR) )
2070
2071/** @def RT_ALIGN_R0PT
2072 * Align macro for ring-0 pointers with type cast.
2073 * @param u Value to align.
2074 * @param uAlignment The alignment. Power of two!
2075 * @param CastType The type to cast the result to.
2076 */
2077#define RT_ALIGN_R0PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR0UINTPTR) )
2078
2079/** @def RT_ALIGN_GCPT
2080 * Align macro for GC pointers with type cast.
2081 * @param u Value to align.
2082 * @param uAlignment The alignment. Power of two!
2083 * @param CastType The type to cast the result to.
2084 */
2085#define RT_ALIGN_GCPT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTGCUINTPTR) )
2086
2087
2088/** @def RT_OFFSETOF
2089 * Our own special offsetof() variant, returns a signed result.
2090 *
2091 * This differs from the usual offsetof() in that it's not relying on builtin
2092 * compiler stuff and thus can use variables in arrays the structure may
2093 * contain. This is useful to determine the sizes of structures ending
2094 * with a variable length field. For gcc >= 4.4 see @bugref{7775}.
2095 *
2096 * @returns offset into the structure of the specified member. signed.
2097 * @param type Structure type.
2098 * @param member Member.
2099 */
2100#if defined(__cplusplus) && RT_GNUC_PREREQ(4, 4)
2101# define RT_OFFSETOF(type, member) ( (int)(uintptr_t)&( ((type *)(void *)0x1000)->member) - 0x1000 )
2102#else
2103# define RT_OFFSETOF(type, member) ( (int)(uintptr_t)&( ((type *)(void *)0)->member) )
2104#endif
2105
2106/** @def RT_UOFFSETOF
2107 * Our own special offsetof() variant, returns an unsigned result.
2108 *
2109 * This differs from the usual offsetof() in that it's not relying on builtin
2110 * compiler stuff and thus can use variables in arrays the structure may
2111 * contain. This is useful to determine the sizes of structures ending
2112 * with a variable length field. For gcc >= 4.4 see @bugref{7775}.
2113 *
2114 * @returns offset into the structure of the specified member. unsigned.
2115 * @param type Structure type.
2116 * @param member Member.
2117 */
2118#if defined(__cplusplus) && RT_GNUC_PREREQ(4, 4)
2119# define RT_UOFFSETOF(type, member) ( (uintptr_t)&( ((type *)(void *)0x1000)->member) - 0x1000 )
2120#else
2121# define RT_UOFFSETOF(type, member) ( (uintptr_t)&( ((type *)(void *)0)->member) )
2122#endif
2123
2124/** @def RT_OFFSETOF_ADD
2125 * RT_OFFSETOF with an addend.
2126 *
2127 * @returns offset into the structure of the specified member. signed.
2128 * @param type Structure type.
2129 * @param member Member.
2130 * @param addend The addend to add to the offset.
2131 */
2132#define RT_OFFSETOF_ADD(type, member, addend) ( (int)RT_UOFFSETOF_ADD(type, member, addend) )
2133
2134/** @def RT_UOFFSETOF_ADD
2135 * RT_UOFFSETOF with an addend.
2136 *
2137 * @returns offset into the structure of the specified member. signed.
2138 * @param type Structure type.
2139 * @param member Member.
2140 * @param addend The addend to add to the offset.
2141 */
2142#define RT_UOFFSETOF_ADD(type, member, addend) ( (uintptr_t)&( ((type *)(void *)(uintptr_t)(addend))->member) )
2143
2144/** @def RT_SIZEOFMEMB
2145 * Get the size of a structure member.
2146 *
2147 * @returns size of the structure member.
2148 * @param type Structure type.
2149 * @param member Member.
2150 */
2151#define RT_SIZEOFMEMB(type, member) ( sizeof(((type *)(void *)0)->member) )
2152
2153/** @def RT_FROM_MEMBER
2154 * Convert a pointer to a structure member into a pointer to the structure.
2155 *
2156 * @returns pointer to the structure.
2157 * @param pMem Pointer to the member.
2158 * @param Type Structure type.
2159 * @param Member Member name.
2160 */
2161#define RT_FROM_MEMBER(pMem, Type, Member) ( (Type *) ((uint8_t *)(void *)(pMem) - RT_UOFFSETOF(Type, Member)) )
2162
2163/** @def RT_FROM_CPP_MEMBER
2164 * Same as RT_FROM_MEMBER except it avoids the annoying g++ warnings about
2165 * invalid access to non-static data member of NULL object.
2166 *
2167 * @returns pointer to the structure.
2168 * @param pMem Pointer to the member.
2169 * @param Type Structure type.
2170 * @param Member Member name.
2171 *
2172 * @remarks Using the __builtin_offsetof does not shut up the compiler.
2173 */
2174#if defined(__GNUC__) && defined(__cplusplus)
2175# define RT_FROM_CPP_MEMBER(pMem, Type, Member) \
2176 ( (Type *) ((uintptr_t)(pMem) - (uintptr_t)&((Type *)0x1000)->Member + 0x1000U) )
2177#else
2178# define RT_FROM_CPP_MEMBER(pMem, Type, Member) RT_FROM_MEMBER(pMem, Type, Member)
2179#endif
2180
2181/** @def RT_ELEMENTS
2182 * Calculates the number of elements in a statically sized array.
2183 * @returns Element count.
2184 * @param aArray Array in question.
2185 */
2186#define RT_ELEMENTS(aArray) ( sizeof(aArray) / sizeof((aArray)[0]) )
2187
2188/**
2189 * Checks if the value is a power of two.
2190 *
2191 * @returns true if power of two, false if not.
2192 * @param uVal The value to test.
2193 * @remarks 0 is a power of two.
2194 * @see VERR_NOT_POWER_OF_TWO
2195 */
2196#define RT_IS_POWER_OF_TWO(uVal) ( ((uVal) & ((uVal) - 1)) == 0)
2197
2198#ifdef RT_OS_OS2
2199/* Undefine RT_MAX since there is an unfortunate clash with the max
2200 resource type define in os2.h. */
2201# undef RT_MAX
2202#endif
2203
2204/** @def RT_MAX
2205 * Finds the maximum value.
2206 * @returns The higher of the two.
2207 * @param Value1 Value 1
2208 * @param Value2 Value 2
2209 */
2210#define RT_MAX(Value1, Value2) ( (Value1) >= (Value2) ? (Value1) : (Value2) )
2211
2212/** @def RT_MIN
2213 * Finds the minimum value.
2214 * @returns The lower of the two.
2215 * @param Value1 Value 1
2216 * @param Value2 Value 2
2217 */
2218#define RT_MIN(Value1, Value2) ( (Value1) <= (Value2) ? (Value1) : (Value2) )
2219
2220/** @def RT_CLAMP
2221 * Clamps the value to minimum and maximum values.
2222 * @returns The clamped value.
2223 * @param Value The value to check.
2224 * @param Min Minimum value.
2225 * @param Max Maximum value.
2226 */
2227#define RT_CLAMP(Value, Min, Max) ( (Value) > (Max) ? (Max) : (Value) < (Min) ? (Min) : (Value) )
2228
2229/** @def RT_ABS
2230 * Get the absolute (non-negative) value.
2231 * @returns The absolute value of Value.
2232 * @param Value The value.
2233 */
2234#define RT_ABS(Value) ( (Value) >= 0 ? (Value) : -(Value) )
2235
2236/** @def RT_BOOL
2237 * Turn non-zero/zero into true/false
2238 * @returns The resulting boolean value.
2239 * @param Value The value.
2240 */
2241#define RT_BOOL(Value) ( !!(Value) )
2242
2243/** @def RT_LO_U8
2244 * Gets the low uint8_t of a uint16_t or something equivalent. */
2245#ifdef __GNUC__
2246# define RT_LO_U8(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint16_t)); (uint8_t)(a); })
2247#else
2248# define RT_LO_U8(a) ( (uint8_t)(a) )
2249#endif
2250/** @def RT_HI_U8
2251 * Gets the high uint8_t of a uint16_t or something equivalent. */
2252#ifdef __GNUC__
2253# define RT_HI_U8(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint16_t)); (uint8_t)((a) >> 8); })
2254#else
2255# define RT_HI_U8(a) ( (uint8_t)((a) >> 8) )
2256#endif
2257
2258/** @def RT_LO_U16
2259 * Gets the low uint16_t of a uint32_t or something equivalent. */
2260#ifdef __GNUC__
2261# define RT_LO_U16(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint32_t)); (uint16_t)(a); })
2262#else
2263# define RT_LO_U16(a) ( (uint16_t)(a) )
2264#endif
2265/** @def RT_HI_U16
2266 * Gets the high uint16_t of a uint32_t or something equivalent. */
2267#ifdef __GNUC__
2268# define RT_HI_U16(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint32_t)); (uint16_t)((a) >> 16); })
2269#else
2270# define RT_HI_U16(a) ( (uint16_t)((a) >> 16) )
2271#endif
2272
2273/** @def RT_LO_U32
2274 * Gets the low uint32_t of a uint64_t or something equivalent. */
2275#ifdef __GNUC__
2276# define RT_LO_U32(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)(a); })
2277#else
2278# define RT_LO_U32(a) ( (uint32_t)(a) )
2279#endif
2280/** @def RT_HI_U32
2281 * Gets the high uint32_t of a uint64_t or something equivalent. */
2282#ifdef __GNUC__
2283# define RT_HI_U32(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)((a) >> 32); })
2284#else
2285# define RT_HI_U32(a) ( (uint32_t)((a) >> 32) )
2286#endif
2287
2288/** @def RT_BYTE1
2289 * Gets the first byte of something. */
2290#define RT_BYTE1(a) ( (a) & 0xff )
2291/** @def RT_BYTE2
2292 * Gets the second byte of something. */
2293#define RT_BYTE2(a) ( ((a) >> 8) & 0xff )
2294/** @def RT_BYTE3
2295 * Gets the second byte of something. */
2296#define RT_BYTE3(a) ( ((a) >> 16) & 0xff )
2297/** @def RT_BYTE4
2298 * Gets the fourth byte of something. */
2299#define RT_BYTE4(a) ( ((a) >> 24) & 0xff )
2300/** @def RT_BYTE5
2301 * Gets the fifth byte of something. */
2302#define RT_BYTE5(a) ( ((a) >> 32) & 0xff )
2303/** @def RT_BYTE6
2304 * Gets the sixth byte of something. */
2305#define RT_BYTE6(a) ( ((a) >> 40) & 0xff )
2306/** @def RT_BYTE7
2307 * Gets the seventh byte of something. */
2308#define RT_BYTE7(a) ( ((a) >> 48) & 0xff )
2309/** @def RT_BYTE8
2310 * Gets the eight byte of something. */
2311#define RT_BYTE8(a) ( ((a) >> 56) & 0xff )
2312
2313
2314/** @def RT_LODWORD
2315 * Gets the low dword (=uint32_t) of something.
2316 * @deprecated Use RT_LO_U32. */
2317#define RT_LODWORD(a) ( (uint32_t)(a) )
2318/** @def RT_HIDWORD
2319 * Gets the high dword (=uint32_t) of a 64-bit of something.
2320 * @deprecated Use RT_HI_U32. */
2321#define RT_HIDWORD(a) ( (uint32_t)((a) >> 32) )
2322
2323/** @def RT_LOWORD
2324 * Gets the low word (=uint16_t) of something.
2325 * @deprecated Use RT_LO_U16. */
2326#define RT_LOWORD(a) ( (a) & 0xffff )
2327/** @def RT_HIWORD
2328 * Gets the high word (=uint16_t) of a 32-bit something.
2329 * @deprecated Use RT_HI_U16. */
2330#define RT_HIWORD(a) ( (a) >> 16 )
2331
2332/** @def RT_LOBYTE
2333 * Gets the low byte of something.
2334 * @deprecated Use RT_LO_U8. */
2335#define RT_LOBYTE(a) ( (a) & 0xff )
2336/** @def RT_HIBYTE
2337 * Gets the high byte of a 16-bit something.
2338 * @deprecated Use RT_HI_U8. */
2339#define RT_HIBYTE(a) ( (a) >> 8 )
2340
2341
2342/** @def RT_MAKE_U64
2343 * Constructs a uint64_t value from two uint32_t values.
2344 */
2345#define RT_MAKE_U64(Lo, Hi) ( (uint64_t)((uint32_t)(Hi)) << 32 | (uint32_t)(Lo) )
2346
2347/** @def RT_MAKE_U64_FROM_U16
2348 * Constructs a uint64_t value from four uint16_t values.
2349 */
2350#define RT_MAKE_U64_FROM_U16(w0, w1, w2, w3) \
2351 ((uint64_t)( (uint64_t)((uint16_t)(w3)) << 48 \
2352 | (uint64_t)((uint16_t)(w2)) << 32 \
2353 | (uint32_t)((uint16_t)(w1)) << 16 \
2354 | (uint16_t)(w0) ))
2355
2356/** @def RT_MAKE_U64_FROM_U8
2357 * Constructs a uint64_t value from eight uint8_t values.
2358 */
2359#define RT_MAKE_U64_FROM_U8(b0, b1, b2, b3, b4, b5, b6, b7) \
2360 ((uint64_t)( (uint64_t)((uint8_t)(b7)) << 56 \
2361 | (uint64_t)((uint8_t)(b6)) << 48 \
2362 | (uint64_t)((uint8_t)(b5)) << 40 \
2363 | (uint64_t)((uint8_t)(b4)) << 32 \
2364 | (uint32_t)((uint8_t)(b3)) << 24 \
2365 | (uint32_t)((uint8_t)(b2)) << 16 \
2366 | (uint16_t)((uint8_t)(b1)) << 8 \
2367 | (uint8_t)(b0) ))
2368
2369/** @def RT_MAKE_U32
2370 * Constructs a uint32_t value from two uint16_t values.
2371 */
2372#define RT_MAKE_U32(Lo, Hi) \
2373 ((uint32_t)( (uint32_t)((uint16_t)(Hi)) << 16 \
2374 | (uint16_t)(Lo) ))
2375
2376/** @def RT_MAKE_U32_FROM_U8
2377 * Constructs a uint32_t value from four uint8_t values.
2378 */
2379#define RT_MAKE_U32_FROM_U8(b0, b1, b2, b3) \
2380 ((uint32_t)( (uint32_t)((uint8_t)(b3)) << 24 \
2381 | (uint32_t)((uint8_t)(b2)) << 16 \
2382 | (uint16_t)((uint8_t)(b1)) << 8 \
2383 | (uint8_t)(b0) ))
2384
2385/** @def RT_MAKE_U16
2386 * Constructs a uint16_t value from two uint8_t values.
2387 */
2388#define RT_MAKE_U16(Lo, Hi) \
2389 ((uint16_t)( (uint16_t)((uint8_t)(Hi)) << 8 \
2390 | (uint8_t)(Lo) ))
2391
2392
2393/** @def RT_BSWAP_U64
2394 * Reverses the byte order of an uint64_t value. */
2395#if 0
2396# define RT_BSWAP_U64(u64) RT_BSWAP_U64_C(u64)
2397#elif defined(__GNUC__)
2398# define RT_BSWAP_U64(u64) (__builtin_constant_p((u64)) \
2399 ? RT_BSWAP_U64_C(u64) : ASMByteSwapU64(u64))
2400#else
2401# define RT_BSWAP_U64(u64) ASMByteSwapU64(u64)
2402#endif
2403
2404/** @def RT_BSWAP_U32
2405 * Reverses the byte order of an uint32_t value. */
2406#if 0
2407# define RT_BSWAP_U32(u32) RT_BSWAP_U32_C(u32)
2408#elif defined(__GNUC__)
2409# define RT_BSWAP_U32(u32) (__builtin_constant_p((u32)) \
2410 ? RT_BSWAP_U32_C(u32) : ASMByteSwapU32(u32))
2411#else
2412# define RT_BSWAP_U32(u32) ASMByteSwapU32(u32)
2413#endif
2414
2415/** @def RT_BSWAP_U16
2416 * Reverses the byte order of an uint16_t value. */
2417#if 0
2418# define RT_BSWAP_U16(u16) RT_BSWAP_U16_C(u16)
2419#elif defined(__GNUC__)
2420# define RT_BSWAP_U16(u16) (__builtin_constant_p((u16)) \
2421 ? RT_BSWAP_U16_C(u16) : ASMByteSwapU16(u16))
2422#else
2423# define RT_BSWAP_U16(u16) ASMByteSwapU16(u16)
2424#endif
2425
2426
2427/** @def RT_BSWAP_U64_C
2428 * Reverses the byte order of an uint64_t constant. */
2429#define RT_BSWAP_U64_C(u64) RT_MAKE_U64(RT_BSWAP_U32_C((u64) >> 32), RT_BSWAP_U32_C((u64) & 0xffffffff))
2430
2431/** @def RT_BSWAP_U32_C
2432 * Reverses the byte order of an uint32_t constant. */
2433#define RT_BSWAP_U32_C(u32) RT_MAKE_U32_FROM_U8(RT_BYTE4(u32), RT_BYTE3(u32), RT_BYTE2(u32), RT_BYTE1(u32))
2434
2435/** @def RT_BSWAP_U16_C
2436 * Reverses the byte order of an uint16_t constant. */
2437#define RT_BSWAP_U16_C(u16) RT_MAKE_U16(RT_HIBYTE(u16), RT_LOBYTE(u16))
2438
2439
2440/** @def RT_H2LE_U64
2441 * Converts an uint64_t value from host to little endian byte order. */
2442#ifdef RT_BIG_ENDIAN
2443# define RT_H2LE_U64(u64) RT_BSWAP_U64(u64)
2444#else
2445# define RT_H2LE_U64(u64) (u64)
2446#endif
2447
2448/** @def RT_H2LE_U64_C
2449 * Converts an uint64_t constant from host to little endian byte order. */
2450#ifdef RT_BIG_ENDIAN
2451# define RT_H2LE_U64_C(u64) RT_BSWAP_U64_C(u64)
2452#else
2453# define RT_H2LE_U64_C(u64) (u64)
2454#endif
2455
2456/** @def RT_H2LE_U32
2457 * Converts an uint32_t value from host to little endian byte order. */
2458#ifdef RT_BIG_ENDIAN
2459# define RT_H2LE_U32(u32) RT_BSWAP_U32(u32)
2460#else
2461# define RT_H2LE_U32(u32) (u32)
2462#endif
2463
2464/** @def RT_H2LE_U32_C
2465 * Converts an uint32_t constant from host to little endian byte order. */
2466#ifdef RT_BIG_ENDIAN
2467# define RT_H2LE_U32_C(u32) RT_BSWAP_U32_C(u32)
2468#else
2469# define RT_H2LE_U32_C(u32) (u32)
2470#endif
2471
2472/** @def RT_H2LE_U16
2473 * Converts an uint16_t value from host to little endian byte order. */
2474#ifdef RT_BIG_ENDIAN
2475# define RT_H2LE_U16(u16) RT_BSWAP_U16(u16)
2476#else
2477# define RT_H2LE_U16(u16) (u16)
2478#endif
2479
2480/** @def RT_H2LE_U16_C
2481 * Converts an uint16_t constant from host to little endian byte order. */
2482#ifdef RT_BIG_ENDIAN
2483# define RT_H2LE_U16_C(u16) RT_BSWAP_U16_C(u16)
2484#else
2485# define RT_H2LE_U16_C(u16) (u16)
2486#endif
2487
2488
2489/** @def RT_LE2H_U64
2490 * Converts an uint64_t value from little endian to host byte order. */
2491#ifdef RT_BIG_ENDIAN
2492# define RT_LE2H_U64(u64) RT_BSWAP_U64(u64)
2493#else
2494# define RT_LE2H_U64(u64) (u64)
2495#endif
2496
2497/** @def RT_LE2H_U64_C
2498 * Converts an uint64_t constant from little endian to host byte order. */
2499#ifdef RT_BIG_ENDIAN
2500# define RT_LE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
2501#else
2502# define RT_LE2H_U64_C(u64) (u64)
2503#endif
2504
2505/** @def RT_LE2H_U32
2506 * Converts an uint32_t value from little endian to host byte order. */
2507#ifdef RT_BIG_ENDIAN
2508# define RT_LE2H_U32(u32) RT_BSWAP_U32(u32)
2509#else
2510# define RT_LE2H_U32(u32) (u32)
2511#endif
2512
2513/** @def RT_LE2H_U32_C
2514 * Converts an uint32_t constant from little endian to host byte order. */
2515#ifdef RT_BIG_ENDIAN
2516# define RT_LE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
2517#else
2518# define RT_LE2H_U32_C(u32) (u32)
2519#endif
2520
2521/** @def RT_LE2H_U16
2522 * Converts an uint16_t value from little endian to host byte order. */
2523#ifdef RT_BIG_ENDIAN
2524# define RT_LE2H_U16(u16) RT_BSWAP_U16(u16)
2525#else
2526# define RT_LE2H_U16(u16) (u16)
2527#endif
2528
2529/** @def RT_LE2H_U16_C
2530 * Converts an uint16_t constant from little endian to host byte order. */
2531#ifdef RT_BIG_ENDIAN
2532# define RT_LE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
2533#else
2534# define RT_LE2H_U16_C(u16) (u16)
2535#endif
2536
2537
2538/** @def RT_H2BE_U64
2539 * Converts an uint64_t value from host to big endian byte order. */
2540#ifdef RT_BIG_ENDIAN
2541# define RT_H2BE_U64(u64) (u64)
2542#else
2543# define RT_H2BE_U64(u64) RT_BSWAP_U64(u64)
2544#endif
2545
2546/** @def RT_H2BE_U64_C
2547 * Converts an uint64_t constant from host to big endian byte order. */
2548#ifdef RT_BIG_ENDIAN
2549# define RT_H2BE_U64_C(u64) (u64)
2550#else
2551# define RT_H2BE_U64_C(u64) RT_BSWAP_U64_C(u64)
2552#endif
2553
2554/** @def RT_H2BE_U32
2555 * Converts an uint32_t value from host to big endian byte order. */
2556#ifdef RT_BIG_ENDIAN
2557# define RT_H2BE_U32(u32) (u32)
2558#else
2559# define RT_H2BE_U32(u32) RT_BSWAP_U32(u32)
2560#endif
2561
2562/** @def RT_H2BE_U32_C
2563 * Converts an uint32_t constant from host to big endian byte order. */
2564#ifdef RT_BIG_ENDIAN
2565# define RT_H2BE_U32_C(u32) (u32)
2566#else
2567# define RT_H2BE_U32_C(u32) RT_BSWAP_U32_C(u32)
2568#endif
2569
2570/** @def RT_H2BE_U16
2571 * Converts an uint16_t value from host to big endian byte order. */
2572#ifdef RT_BIG_ENDIAN
2573# define RT_H2BE_U16(u16) (u16)
2574#else
2575# define RT_H2BE_U16(u16) RT_BSWAP_U16(u16)
2576#endif
2577
2578/** @def RT_H2BE_U16_C
2579 * Converts an uint16_t constant from host to big endian byte order. */
2580#ifdef RT_BIG_ENDIAN
2581# define RT_H2BE_U16_C(u16) (u16)
2582#else
2583# define RT_H2BE_U16_C(u16) RT_BSWAP_U16_C(u16)
2584#endif
2585
2586/** @def RT_BE2H_U64
2587 * Converts an uint64_t value from big endian to host byte order. */
2588#ifdef RT_BIG_ENDIAN
2589# define RT_BE2H_U64(u64) (u64)
2590#else
2591# define RT_BE2H_U64(u64) RT_BSWAP_U64(u64)
2592#endif
2593
2594/** @def RT_BE2H_U64
2595 * Converts an uint64_t constant from big endian to host byte order. */
2596#ifdef RT_BIG_ENDIAN
2597# define RT_BE2H_U64_C(u64) (u64)
2598#else
2599# define RT_BE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
2600#endif
2601
2602/** @def RT_BE2H_U32
2603 * Converts an uint32_t value from big endian to host byte order. */
2604#ifdef RT_BIG_ENDIAN
2605# define RT_BE2H_U32(u32) (u32)
2606#else
2607# define RT_BE2H_U32(u32) RT_BSWAP_U32(u32)
2608#endif
2609
2610/** @def RT_BE2H_U32_C
2611 * Converts an uint32_t value from big endian to host byte order. */
2612#ifdef RT_BIG_ENDIAN
2613# define RT_BE2H_U32_C(u32) (u32)
2614#else
2615# define RT_BE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
2616#endif
2617
2618/** @def RT_BE2H_U16
2619 * Converts an uint16_t value from big endian to host byte order. */
2620#ifdef RT_BIG_ENDIAN
2621# define RT_BE2H_U16(u16) (u16)
2622#else
2623# define RT_BE2H_U16(u16) RT_BSWAP_U16(u16)
2624#endif
2625
2626/** @def RT_BE2H_U16_C
2627 * Converts an uint16_t constant from big endian to host byte order. */
2628#ifdef RT_BIG_ENDIAN
2629# define RT_BE2H_U16_C(u16) (u16)
2630#else
2631# define RT_BE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
2632#endif
2633
2634
2635/** @def RT_H2N_U64
2636 * Converts an uint64_t value from host to network byte order. */
2637#define RT_H2N_U64(u64) RT_H2BE_U64(u64)
2638
2639/** @def RT_H2N_U64_C
2640 * Converts an uint64_t constant from host to network byte order. */
2641#define RT_H2N_U64_C(u64) RT_H2BE_U64_C(u64)
2642
2643/** @def RT_H2N_U32
2644 * Converts an uint32_t value from host to network byte order. */
2645#define RT_H2N_U32(u32) RT_H2BE_U32(u32)
2646
2647/** @def RT_H2N_U32_C
2648 * Converts an uint32_t constant from host to network byte order. */
2649#define RT_H2N_U32_C(u32) RT_H2BE_U32_C(u32)
2650
2651/** @def RT_H2N_U16
2652 * Converts an uint16_t value from host to network byte order. */
2653#define RT_H2N_U16(u16) RT_H2BE_U16(u16)
2654
2655/** @def RT_H2N_U16_C
2656 * Converts an uint16_t constant from host to network byte order. */
2657#define RT_H2N_U16_C(u16) RT_H2BE_U16_C(u16)
2658
2659/** @def RT_N2H_U64
2660 * Converts an uint64_t value from network to host byte order. */
2661#define RT_N2H_U64(u64) RT_BE2H_U64(u64)
2662
2663/** @def RT_N2H_U64_C
2664 * Converts an uint64_t constant from network to host byte order. */
2665#define RT_N2H_U64_C(u64) RT_BE2H_U64_C(u64)
2666
2667/** @def RT_N2H_U32
2668 * Converts an uint32_t value from network to host byte order. */
2669#define RT_N2H_U32(u32) RT_BE2H_U32(u32)
2670
2671/** @def RT_N2H_U32_C
2672 * Converts an uint32_t constant from network to host byte order. */
2673#define RT_N2H_U32_C(u32) RT_BE2H_U32_C(u32)
2674
2675/** @def RT_N2H_U16
2676 * Converts an uint16_t value from network to host byte order. */
2677#define RT_N2H_U16(u16) RT_BE2H_U16(u16)
2678
2679/** @def RT_N2H_U16_C
2680 * Converts an uint16_t value from network to host byte order. */
2681#define RT_N2H_U16_C(u16) RT_BE2H_U16_C(u16)
2682
2683
2684/*
2685 * The BSD sys/param.h + machine/param.h file is a major source of
2686 * namespace pollution. Kill off some of the worse ones unless we're
2687 * compiling kernel code.
2688 */
2689#if defined(RT_OS_DARWIN) \
2690 && !defined(KERNEL) \
2691 && !defined(RT_NO_BSD_PARAM_H_UNDEFING) \
2692 && ( defined(_SYS_PARAM_H_) || defined(_I386_PARAM_H_) )
2693/* sys/param.h: */
2694# undef PSWP
2695# undef PVM
2696# undef PINOD
2697# undef PRIBO
2698# undef PVFS
2699# undef PZERO
2700# undef PSOCK
2701# undef PWAIT
2702# undef PLOCK
2703# undef PPAUSE
2704# undef PUSER
2705# undef PRIMASK
2706# undef MINBUCKET
2707# undef MAXALLOCSAVE
2708# undef FSHIFT
2709# undef FSCALE
2710
2711/* i386/machine.h: */
2712# undef ALIGN
2713# undef ALIGNBYTES
2714# undef DELAY
2715# undef STATUS_WORD
2716# undef USERMODE
2717# undef BASEPRI
2718# undef MSIZE
2719# undef CLSIZE
2720# undef CLSIZELOG2
2721#endif
2722
2723/** @def NIL_OFFSET
2724 * NIL offset.
2725 * Whenever we use offsets instead of pointers to save space and relocation effort
2726 * NIL_OFFSET shall be used as the equivalent to NULL.
2727 */
2728#define NIL_OFFSET (~0U)
2729
2730/** @def NOREF
2731 * Keeps the compiler from bitching about an unused parameter, local variable,
2732 * or other stuff, will never use _Pragma are is thus more flexible.
2733 */
2734#define NOREF(var) (void)(var)
2735
2736/** @def RT_NOREF_PV
2737 * Keeps the compiler from bitching about an unused parameter or local variable.
2738 * This one cannot be used with structure members and such, like for instance
2739 * AssertRC may end up doing due to its generic nature.
2740 */
2741#if defined(__cplusplus) && RT_CLANG_PREREQ(6, 0)
2742# define RT_NOREF_PV(var) _Pragma(RT_STR(unused(var)))
2743#else
2744# define RT_NOREF_PV(var) (void)(var)
2745#endif
2746
2747/** @def RT_BREAKPOINT
2748 * Emit a debug breakpoint instruction.
2749 *
2750 * @remarks In the x86/amd64 gnu world we add a nop instruction after the int3
2751 * to force gdb to remain at the int3 source line.
2752 * @remarks The L4 kernel will try make sense of the breakpoint, thus the jmp on
2753 * x86/amd64.
2754 */
2755#ifdef __GNUC__
2756# if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)
2757# if !defined(__L4ENV__)
2758# define RT_BREAKPOINT() __asm__ __volatile__("int $3\n\tnop\n\t")
2759# else
2760# define RT_BREAKPOINT() __asm__ __volatile__("int3; jmp 1f; 1:\n\t")
2761# endif
2762# elif defined(RT_ARCH_SPARC64)
2763# define RT_BREAKPOINT() __asm__ __volatile__("illtrap 0\n\t") /** @todo Sparc64: this is just a wild guess. */
2764# elif defined(RT_ARCH_SPARC)
2765# define RT_BREAKPOINT() __asm__ __volatile__("unimp 0\n\t") /** @todo Sparc: this is just a wild guess (same as Sparc64, just different name). */
2766# endif
2767#endif
2768#ifdef _MSC_VER
2769# define RT_BREAKPOINT() __debugbreak()
2770#endif
2771#if defined(__IBMC__) || defined(__IBMCPP__)
2772# define RT_BREAKPOINT() __interrupt(3)
2773#endif
2774#if defined(__WATCOMC__)
2775# define RT_BREAKPOINT() _asm { int 3 }
2776#endif
2777#ifndef RT_BREAKPOINT
2778# error "This compiler/arch is not supported!"
2779#endif
2780
2781
2782/** @defgroup grp_rt_cdefs_size Size Constants
2783 * (Of course, these are binary computer terms, not SI.)
2784 * @{
2785 */
2786/** 1 K (Kilo) (1 024). */
2787#define _1K 0x00000400
2788/** 2 K (Kilo) (2 048). */
2789#define _2K 0x00000800
2790/** 4 K (Kilo) (4 096). */
2791#define _4K 0x00001000
2792/** 8 K (Kilo) (8 192). */
2793#define _8K 0x00002000
2794/** 16 K (Kilo) (16 384). */
2795#define _16K 0x00004000
2796/** 32 K (Kilo) (32 678). */
2797#define _32K 0x00008000
2798/** 64 K (Kilo) (65 536). */
2799#if ARCH_BITS != 16
2800# define _64K 0x00010000
2801#else
2802# define _64K UINT32_C(0x00010000)
2803#endif
2804/** 128 K (Kilo) (131 072). */
2805#if ARCH_BITS != 16
2806# define _128K 0x00020000
2807#else
2808# define _128K UINT32_C(0x00020000)
2809#endif
2810/** 256 K (Kilo) (262 144). */
2811#if ARCH_BITS != 16
2812# define _256K 0x00040000
2813#else
2814# define _256K UINT32_C(0x00040000)
2815#endif
2816/** 512 K (Kilo) (524 288). */
2817#if ARCH_BITS != 16
2818# define _512K 0x00080000
2819#else
2820# define _512K UINT32_C(0x00080000)
2821#endif
2822/** 1 M (Mega) (1 048 576). */
2823#if ARCH_BITS != 16
2824# define _1M 0x00100000
2825#else
2826# define _1M UINT32_C(0x00100000)
2827#endif
2828/** 2 M (Mega) (2 097 152). */
2829#if ARCH_BITS != 16
2830# define _2M 0x00200000
2831#else
2832# define _2M UINT32_C(0x00200000)
2833#endif
2834/** 4 M (Mega) (4 194 304). */
2835#if ARCH_BITS != 16
2836# define _4M 0x00400000
2837#else
2838# define _4M UINT32_C(0x00400000)
2839#endif
2840/** 8 M (Mega) (8 388 608). */
2841#define _8M UINT32_C(0x00800000)
2842/** 16 M (Mega) (16 777 216). */
2843#define _16M UINT32_C(0x01000000)
2844/** 32 M (Mega) (33 554 432). */
2845#define _32M UINT32_C(0x02000000)
2846/** 64 M (Mega) (67 108 864). */
2847#define _64M UINT32_C(0x04000000)
2848/** 128 M (Mega) (134 217 728). */
2849#define _128M UINT32_C(0x08000000)
2850/** 256 M (Mega) (268 435 456). */
2851#define _256M UINT32_C(0x10000000)
2852/** 512 M (Mega) (536 870 912). */
2853#define _512M UINT32_C(0x20000000)
2854/** 1 G (Giga) (1 073 741 824). (32-bit) */
2855#if ARCH_BITS != 16
2856# define _1G 0x40000000
2857#else
2858# define _1G UINT32_C(0x40000000)
2859#endif
2860/** 1 G (Giga) (1 073 741 824). (64-bit) */
2861#if ARCH_BITS != 16
2862# define _1G64 0x40000000LL
2863#else
2864# define _1G64 UINT64_C(0x40000000)
2865#endif
2866/** 2 G (Giga) (2 147 483 648). (32-bit) */
2867#define _2G32 UINT32_C(0x80000000)
2868/** 2 G (Giga) (2 147 483 648). (64-bit) */
2869#if ARCH_BITS != 16
2870# define _2G 0x0000000080000000LL
2871#else
2872# define _2G UINT64_C(0x0000000080000000)
2873#endif
2874/** 4 G (Giga) (4 294 967 296). */
2875#if ARCH_BITS != 16
2876# define _4G 0x0000000100000000LL
2877#else
2878# define _4G UINT64_C(0x0000000100000000)
2879#endif
2880/** 1 T (Tera) (1 099 511 627 776). */
2881#if ARCH_BITS != 16
2882# define _1T 0x0000010000000000LL
2883#else
2884# define _1T UINT64_C(0x0000010000000000)
2885#endif
2886/** 1 P (Peta) (1 125 899 906 842 624). */
2887#if ARCH_BITS != 16
2888# define _1P 0x0004000000000000LL
2889#else
2890# define _1P UINT64_C(0x0004000000000000)
2891#endif
2892/** 1 E (Exa) (1 152 921 504 606 846 976). */
2893#if ARCH_BITS != 16
2894# define _1E 0x1000000000000000LL
2895#else
2896# define _1E UINT64_C(0x1000000000000000)
2897#endif
2898/** 2 E (Exa) (2 305 843 009 213 693 952). */
2899#if ARCH_BITS != 16
2900# define _2E 0x2000000000000000ULL
2901#else
2902# define _2E UINT64_C(0x2000000000000000)
2903#endif
2904/** @} */
2905
2906/** @defgroup grp_rt_cdefs_decimal_grouping Decimal Constant Grouping Macros
2907 * @{ */
2908#define RT_D1(g1) g1
2909#define RT_D2(g1, g2) g1#g2
2910#define RT_D3(g1, g2, g3) g1#g2#g3
2911#define RT_D4(g1, g2, g3, g4) g1#g2#g3#g4
2912#define RT_D5(g1, g2, g3, g4, g5) g1#g2#g3#g4#g5
2913#define RT_D6(g1, g2, g3, g4, g5, g6) g1#g2#g3#g4#g5#g6
2914#define RT_D7(g1, g2, g3, g4, g5, g6, g7) g1#g2#g3#g4#g5#g6#g7
2915
2916#define RT_D1_U(g1) UINT32_C(g1)
2917#define RT_D2_U(g1, g2) UINT32_C(g1#g2)
2918#define RT_D3_U(g1, g2, g3) UINT32_C(g1#g2#g3)
2919#define RT_D4_U(g1, g2, g3, g4) UINT64_C(g1#g2#g3#g4)
2920#define RT_D5_U(g1, g2, g3, g4, g5) UINT64_C(g1#g2#g3#g4#g5)
2921#define RT_D6_U(g1, g2, g3, g4, g5, g6) UINT64_C(g1#g2#g3#g4#g5#g6)
2922#define RT_D7_U(g1, g2, g3, g4, g5, g6, g7) UINT64_C(g1#g2#g3#g4#g5#g6#g7)
2923
2924#define RT_D1_S(g1) INT32_C(g1)
2925#define RT_D2_S(g1, g2) INT32_C(g1#g2)
2926#define RT_D3_S(g1, g2, g3) INT32_C(g1#g2#g3)
2927#define RT_D4_S(g1, g2, g3, g4) INT64_C(g1#g2#g3#g4)
2928#define RT_D5_S(g1, g2, g3, g4, g5) INT64_C(g1#g2#g3#g4#g5)
2929#define RT_D6_S(g1, g2, g3, g4, g5, g6) INT64_C(g1#g2#g3#g4#g5#g6)
2930#define RT_D7_S(g1, g2, g3, g4, g5, g6, g7) INT64_C(g1#g2#g3#g4#g5#g6#g7)
2931
2932#define RT_D1_U32(g1) UINT32_C(g1)
2933#define RT_D2_U32(g1, g2) UINT32_C(g1#g2)
2934#define RT_D3_U32(g1, g2, g3) UINT32_C(g1#g2#g3)
2935#define RT_D4_U32(g1, g2, g3, g4) UINT32_C(g1#g2#g3#g4)
2936
2937#define RT_D1_S32(g1) INT32_C(g1)
2938#define RT_D2_S32(g1, g2) INT32_C(g1#g2)
2939#define RT_D3_S32(g1, g2, g3) INT32_C(g1#g2#g3)
2940#define RT_D4_S32(g1, g2, g3, g4) INT32_C(g1#g2#g3#g4)
2941
2942#define RT_D1_U64(g1) UINT64_C(g1)
2943#define RT_D2_U64(g1, g2) UINT64_C(g1#g2)
2944#define RT_D3_U64(g1, g2, g3) UINT64_C(g1#g2#g3)
2945#define RT_D4_U64(g1, g2, g3, g4) UINT64_C(g1#g2#g3#g4)
2946#define RT_D5_U64(g1, g2, g3, g4, g5) UINT64_C(g1#g2#g3#g4#g5)
2947#define RT_D6_U64(g1, g2, g3, g4, g5, g6) UINT64_C(g1#g2#g3#g4#g5#g6)
2948#define RT_D7_U64(g1, g2, g3, g4, g5, g6, g7) UINT64_C(g1#g2#g3#g4#g5#g6#g7)
2949
2950#define RT_D1_S64(g1) INT64_C(g1)
2951#define RT_D2_S64(g1, g2) INT64_C(g1#g2)
2952#define RT_D3_S64(g1, g2, g3) INT64_C(g1#g2#g3)
2953#define RT_D4_S64(g1, g2, g3, g4) INT64_C(g1#g2#g3#g4)
2954#define RT_D5_S64(g1, g2, g3, g4, g5) INT64_C(g1#g2#g3#g4#g5)
2955#define RT_D6_S64(g1, g2, g3, g4, g5, g6) INT64_C(g1#g2#g3#g4#g5#g6)
2956#define RT_D7_S64(g1, g2, g3, g4, g5, g6, g7) INT64_C(g1#g2#g3#g4#g5#g6#g7)
2957/** @} */
2958
2959
2960/** @defgroup grp_rt_cdefs_time Time Constants
2961 * @{
2962 */
2963/** 1 hour expressed in nanoseconds (64-bit). */
2964#define RT_NS_1HOUR UINT64_C(3600000000000)
2965/** 1 minute expressed in nanoseconds (64-bit). */
2966#define RT_NS_1MIN UINT64_C(60000000000)
2967/** 45 second expressed in nanoseconds. */
2968#define RT_NS_45SEC UINT64_C(45000000000)
2969/** 30 second expressed in nanoseconds. */
2970#define RT_NS_30SEC UINT64_C(30000000000)
2971/** 20 second expressed in nanoseconds. */
2972#define RT_NS_20SEC UINT64_C(20000000000)
2973/** 15 second expressed in nanoseconds. */
2974#define RT_NS_15SEC UINT64_C(15000000000)
2975/** 10 second expressed in nanoseconds. */
2976#define RT_NS_10SEC UINT64_C(10000000000)
2977/** 1 second expressed in nanoseconds. */
2978#define RT_NS_1SEC UINT32_C(1000000000)
2979/** 100 millsecond expressed in nanoseconds. */
2980#define RT_NS_100MS UINT32_C(100000000)
2981/** 10 millsecond expressed in nanoseconds. */
2982#define RT_NS_10MS UINT32_C(10000000)
2983/** 1 millsecond expressed in nanoseconds. */
2984#define RT_NS_1MS UINT32_C(1000000)
2985/** 100 microseconds expressed in nanoseconds. */
2986#define RT_NS_100US UINT32_C(100000)
2987/** 10 microseconds expressed in nanoseconds. */
2988#define RT_NS_10US UINT32_C(10000)
2989/** 1 microsecond expressed in nanoseconds. */
2990#define RT_NS_1US UINT32_C(1000)
2991
2992/** 1 second expressed in nanoseconds - 64-bit type. */
2993#define RT_NS_1SEC_64 UINT64_C(1000000000)
2994/** 100 millsecond expressed in nanoseconds - 64-bit type. */
2995#define RT_NS_100MS_64 UINT64_C(100000000)
2996/** 10 millsecond expressed in nanoseconds - 64-bit type. */
2997#define RT_NS_10MS_64 UINT64_C(10000000)
2998/** 1 millsecond expressed in nanoseconds - 64-bit type. */
2999#define RT_NS_1MS_64 UINT64_C(1000000)
3000/** 100 microseconds expressed in nanoseconds - 64-bit type. */
3001#define RT_NS_100US_64 UINT64_C(100000)
3002/** 10 microseconds expressed in nanoseconds - 64-bit type. */
3003#define RT_NS_10US_64 UINT64_C(10000)
3004/** 1 microsecond expressed in nanoseconds - 64-bit type. */
3005#define RT_NS_1US_64 UINT64_C(1000)
3006
3007/** 1 hour expressed in microseconds. */
3008#define RT_US_1HOUR UINT32_C(3600000000)
3009/** 1 minute expressed in microseconds. */
3010#define RT_US_1MIN UINT32_C(60000000)
3011/** 1 second expressed in microseconds. */
3012#define RT_US_1SEC UINT32_C(1000000)
3013/** 100 millsecond expressed in microseconds. */
3014#define RT_US_100MS UINT32_C(100000)
3015/** 10 millsecond expressed in microseconds. */
3016#define RT_US_10MS UINT32_C(10000)
3017/** 1 millsecond expressed in microseconds. */
3018#define RT_US_1MS UINT32_C(1000)
3019
3020/** 1 hour expressed in microseconds - 64-bit type. */
3021#define RT_US_1HOUR_64 UINT64_C(3600000000)
3022/** 1 minute expressed in microseconds - 64-bit type. */
3023#define RT_US_1MIN_64 UINT64_C(60000000)
3024/** 1 second expressed in microseconds - 64-bit type. */
3025#define RT_US_1SEC_64 UINT64_C(1000000)
3026/** 100 millsecond expressed in microseconds - 64-bit type. */
3027#define RT_US_100MS_64 UINT64_C(100000)
3028/** 10 millsecond expressed in microseconds - 64-bit type. */
3029#define RT_US_10MS_64 UINT64_C(10000)
3030/** 1 millsecond expressed in microseconds - 64-bit type. */
3031#define RT_US_1MS_64 UINT64_C(1000)
3032
3033/** 1 hour expressed in milliseconds. */
3034#define RT_MS_1HOUR UINT32_C(3600000)
3035/** 1 minute expressed in milliseconds. */
3036#define RT_MS_1MIN UINT32_C(60000)
3037/** 1 second expressed in milliseconds. */
3038#define RT_MS_1SEC UINT32_C(1000)
3039
3040/** 1 hour expressed in milliseconds - 64-bit type. */
3041#define RT_MS_1HOUR_64 UINT64_C(3600000)
3042/** 1 minute expressed in milliseconds - 64-bit type. */
3043#define RT_MS_1MIN_64 UINT64_C(60000)
3044/** 1 second expressed in milliseconds - 64-bit type. */
3045#define RT_MS_1SEC_64 UINT64_C(1000)
3046
3047/** The number of seconds per week. */
3048#define RT_SEC_1WEEK UINT32_C(604800)
3049/** The number of seconds per day. */
3050#define RT_SEC_1DAY UINT32_C(86400)
3051/** The number of seconds per hour. */
3052#define RT_SEC_1HOUR UINT32_C(3600)
3053
3054/** The number of seconds per week - 64-bit type. */
3055#define RT_SEC_1WEEK_64 UINT64_C(604800)
3056/** The number of seconds per day - 64-bit type. */
3057#define RT_SEC_1DAY_64 UINT64_C(86400)
3058/** The number of seconds per hour - 64-bit type. */
3059#define RT_SEC_1HOUR_64 UINT64_C(3600)
3060/** @} */
3061
3062
3063/** @defgroup grp_rt_cdefs_dbgtype Debug Info Types
3064 * @{ */
3065/** Other format. */
3066#define RT_DBGTYPE_OTHER RT_BIT_32(0)
3067/** Stabs. */
3068#define RT_DBGTYPE_STABS RT_BIT_32(1)
3069/** Debug With Arbitrary Record Format (DWARF). */
3070#define RT_DBGTYPE_DWARF RT_BIT_32(2)
3071/** Microsoft Codeview debug info. */
3072#define RT_DBGTYPE_CODEVIEW RT_BIT_32(3)
3073/** Watcom debug info. */
3074#define RT_DBGTYPE_WATCOM RT_BIT_32(4)
3075/** IBM High Level Language debug info. */
3076#define RT_DBGTYPE_HLL RT_BIT_32(5)
3077/** Old OS/2 and Windows symbol file. */
3078#define RT_DBGTYPE_SYM RT_BIT_32(6)
3079/** Map file. */
3080#define RT_DBGTYPE_MAP RT_BIT_32(7)
3081/** @} */
3082
3083
3084/** @defgroup grp_rt_cdefs_exetype Executable Image Types
3085 * @{ */
3086/** Some other format. */
3087#define RT_EXETYPE_OTHER RT_BIT_32(0)
3088/** Portable Executable. */
3089#define RT_EXETYPE_PE RT_BIT_32(1)
3090/** Linear eXecutable. */
3091#define RT_EXETYPE_LX RT_BIT_32(2)
3092/** Linear Executable. */
3093#define RT_EXETYPE_LE RT_BIT_32(3)
3094/** New Executable. */
3095#define RT_EXETYPE_NE RT_BIT_32(4)
3096/** DOS Executable (Mark Zbikowski). */
3097#define RT_EXETYPE_MZ RT_BIT_32(5)
3098/** COM Executable. */
3099#define RT_EXETYPE_COM RT_BIT_32(6)
3100/** a.out Executable. */
3101#define RT_EXETYPE_AOUT RT_BIT_32(7)
3102/** Executable and Linkable Format. */
3103#define RT_EXETYPE_ELF RT_BIT_32(8)
3104/** Mach-O Executable (including FAT ones). */
3105#define RT_EXETYPE_MACHO RT_BIT_32(9)
3106/** TE from UEFI. */
3107#define RT_EXETYPE_TE RT_BIT_32(9)
3108/** @} */
3109
3110
3111/** @def VALID_PTR
3112 * Pointer validation macro.
3113 * @param ptr The pointer.
3114 */
3115#if defined(RT_ARCH_AMD64)
3116# ifdef IN_RING3
3117# if defined(RT_OS_DARWIN) /* first 4GB is reserved for legacy kernel. */
3118# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= _4G \
3119 && !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
3120# elif defined(RT_OS_SOLARIS) /* The kernel only used the top 2TB, but keep it simple. */
3121# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
3122 && ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
3123 || ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
3124# else
3125# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
3126 && !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
3127# endif
3128# else /* !IN_RING3 */
3129# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
3130 && ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
3131 || ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
3132# endif /* !IN_RING3 */
3133
3134#elif defined(RT_ARCH_X86)
3135# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
3136
3137#elif defined(RT_ARCH_SPARC64)
3138# ifdef IN_RING3
3139# if defined(RT_OS_SOLARIS)
3140/** Sparc64 user mode: According to Figure 9.4 in solaris internals */
3141/** @todo # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x80004000U >= 0x80004000U + 0x100000000ULL ) - figure this. */
3142# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x80000000U >= 0x80000000U + 0x100000000ULL )
3143# else
3144# error "Port me"
3145# endif
3146# else /* !IN_RING3 */
3147# if defined(RT_OS_SOLARIS)
3148/** @todo Sparc64 kernel mode: This is according to Figure 11.1 in solaris
3149 * internals. Verify in sources. */
3150# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= 0x01000000U )
3151# else
3152# error "Port me"
3153# endif
3154# endif /* !IN_RING3 */
3155
3156#elif defined(RT_ARCH_SPARC)
3157# ifdef IN_RING3
3158# ifdef RT_OS_SOLARIS
3159/** Sparc user mode: According to
3160 * http://cvs.opensolaris.org/source/xref/onnv/onnv-gate/usr/src/uts/sun4/os/startup.c#510 */
3161# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x400000U >= 0x400000U + 0x2000U )
3162
3163# else
3164# error "Port me"
3165# endif
3166# else /* !IN_RING3 */
3167# ifdef RT_OS_SOLARIS
3168/** @todo Sparc kernel mode: Check the sources! */
3169# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
3170# else
3171# error "Port me"
3172# endif
3173# endif /* !IN_RING3 */
3174
3175#elif defined(RT_ARCH_ARM)
3176/* ASSUMES that at least the last and first 4K are out of bounds. */
3177# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
3178
3179#else
3180# error "Architecture identifier missing / not implemented."
3181#endif
3182
3183/** Old name for RT_VALID_PTR. */
3184#define VALID_PTR(ptr) RT_VALID_PTR(ptr)
3185
3186/** @def RT_VALID_ALIGNED_PTR
3187 * Pointer validation macro that also checks the alignment.
3188 * @param ptr The pointer.
3189 * @param align The alignment, must be a power of two.
3190 */
3191#define RT_VALID_ALIGNED_PTR(ptr, align) \
3192 ( !((uintptr_t)(ptr) & (uintptr_t)((align) - 1)) \
3193 && VALID_PTR(ptr) )
3194
3195
3196/** @def VALID_PHYS32
3197 * 32 bits physical address validation macro.
3198 * @param Phys The RTGCPHYS address.
3199 */
3200#define VALID_PHYS32(Phys) ( (uint64_t)(Phys) < (uint64_t)_4G )
3201
3202/** @def N_
3203 * The \#define N_ is used to mark a string for translation. This is usable in
3204 * any part of the code, as it is only used by the tools that create message
3205 * catalogs. This macro is a no-op as far as the compiler and code generation
3206 * is concerned.
3207 *
3208 * If you want to both mark a string for translation and translate it, use _().
3209 */
3210#define N_(s) (s)
3211
3212/** @def _
3213 * The \#define _ is used to mark a string for translation and to translate it
3214 * in one step.
3215 *
3216 * If you want to only mark a string for translation, use N_().
3217 */
3218#define _(s) gettext(s)
3219
3220
3221/** @def __PRETTY_FUNCTION__
3222 * With GNU C we'd like to use the builtin __PRETTY_FUNCTION__, so define that
3223 * for the other compilers.
3224 */
3225#if !defined(__GNUC__) && !defined(__PRETTY_FUNCTION__)
3226# ifdef _MSC_VER
3227# define __PRETTY_FUNCTION__ __FUNCSIG__
3228# else
3229# define __PRETTY_FUNCTION__ __FUNCTION__
3230# endif
3231#endif
3232
3233
3234/** @def RT_STRICT
3235 * The \#define RT_STRICT controls whether or not assertions and other runtime
3236 * checks should be compiled in or not. This is defined when DEBUG is defined.
3237 * If RT_NO_STRICT is defined, it will unconditionally be undefined.
3238 *
3239 * If you want assertions which are not subject to compile time options use
3240 * the AssertRelease*() flavors.
3241 */
3242#if !defined(RT_STRICT) && defined(DEBUG)
3243# define RT_STRICT
3244#endif
3245#ifdef RT_NO_STRICT
3246# undef RT_STRICT
3247#endif
3248
3249/** @todo remove this: */
3250#if !defined(RT_LOCK_STRICT) && !defined(DEBUG_bird)
3251# define RT_LOCK_NO_STRICT
3252#endif
3253#if !defined(RT_LOCK_STRICT_ORDER) && !defined(DEBUG_bird)
3254# define RT_LOCK_NO_STRICT_ORDER
3255#endif
3256
3257/** @def RT_LOCK_STRICT
3258 * The \#define RT_LOCK_STRICT controls whether deadlock detection and related
3259 * checks are done in the lock and semaphore code. It is by default enabled in
3260 * RT_STRICT builds, but this behavior can be overridden by defining
3261 * RT_LOCK_NO_STRICT. */
3262#if !defined(RT_LOCK_STRICT) && !defined(RT_LOCK_NO_STRICT) && defined(RT_STRICT)
3263# define RT_LOCK_STRICT
3264#endif
3265/** @def RT_LOCK_NO_STRICT
3266 * The \#define RT_LOCK_NO_STRICT disables RT_LOCK_STRICT. */
3267#if defined(RT_LOCK_NO_STRICT) && defined(RT_LOCK_STRICT)
3268# undef RT_LOCK_STRICT
3269#endif
3270
3271/** @def RT_LOCK_STRICT_ORDER
3272 * The \#define RT_LOCK_STRICT_ORDER controls whether locking order is checked
3273 * by the lock and semaphore code. It is by default enabled in RT_STRICT
3274 * builds, but this behavior can be overridden by defining
3275 * RT_LOCK_NO_STRICT_ORDER. */
3276#if !defined(RT_LOCK_STRICT_ORDER) && !defined(RT_LOCK_NO_STRICT_ORDER) && defined(RT_STRICT)
3277# define RT_LOCK_STRICT_ORDER
3278#endif
3279/** @def RT_LOCK_NO_STRICT_ORDER
3280 * The \#define RT_LOCK_NO_STRICT_ORDER disables RT_LOCK_STRICT_ORDER. */
3281#if defined(RT_LOCK_NO_STRICT_ORDER) && defined(RT_LOCK_STRICT_ORDER)
3282# undef RT_LOCK_STRICT_ORDER
3283#endif
3284
3285
3286/** Source position. */
3287#define RT_SRC_POS __FILE__, __LINE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__
3288
3289/** Source position declaration. */
3290#define RT_SRC_POS_DECL const char *pszFile, unsigned iLine, const char *pszFunction
3291
3292/** Source position arguments. */
3293#define RT_SRC_POS_ARGS pszFile, iLine, pszFunction
3294
3295/** Applies NOREF() to the source position arguments. */
3296#define RT_SRC_POS_NOREF() do { NOREF(pszFile); NOREF(iLine); NOREF(pszFunction); } while (0)
3297
3298
3299/** @def RT_INLINE_ASM_EXTERNAL
3300 * Defined as 1 if the compiler does not support inline assembly.
3301 * The ASM* functions will then be implemented in external .asm files.
3302 */
3303#if (defined(_MSC_VER) && defined(RT_ARCH_AMD64)) \
3304 || (!defined(RT_ARCH_AMD64) && !defined(RT_ARCH_X86)) \
3305 || defined(__WATCOMC__)
3306# define RT_INLINE_ASM_EXTERNAL 1
3307#else
3308# define RT_INLINE_ASM_EXTERNAL 0
3309#endif
3310
3311/** @def RT_INLINE_ASM_GNU_STYLE
3312 * Defined as 1 if the compiler understands GNU style inline assembly.
3313 */
3314#if defined(_MSC_VER) || defined(__WATCOMC__)
3315# define RT_INLINE_ASM_GNU_STYLE 0
3316#else
3317# define RT_INLINE_ASM_GNU_STYLE 1
3318#endif
3319
3320/** @def RT_INLINE_ASM_USES_INTRIN
3321 * Defined as the major MSC version if the compiler have and uses intrin.h.
3322 * Otherwise it is 0. */
3323#ifdef _MSC_VER
3324# if _MSC_VER >= 1700 /* Visual C++ v11.0 / 2012 */
3325# define RT_INLINE_ASM_USES_INTRIN 17
3326# elif _MSC_VER >= 1600 /* Visual C++ v10.0 / 2010 */
3327# define RT_INLINE_ASM_USES_INTRIN 16
3328# elif _MSC_VER >= 1500 /* Visual C++ v9.0 / 2008 */
3329# define RT_INLINE_ASM_USES_INTRIN 15
3330# elif _MSC_VER >= 1400 /* Visual C++ v8.0 / 2005 */
3331# define RT_INLINE_ASM_USES_INTRIN 14
3332# endif
3333#endif
3334#ifndef RT_INLINE_ASM_USES_INTRIN
3335# define RT_INLINE_ASM_USES_INTRIN 0
3336#endif
3337
3338/** @def RT_COMPILER_SUPPORTS_LAMBDA
3339 * If the defined, the compiler supports lambda expressions. These expressions
3340 * are useful for embedding assertions and type checks into macros. */
3341#if defined(_MSC_VER) && defined(__cplusplus)
3342# if _MSC_VER >= 1600 /* Visual C++ v10.0 / 2010 */
3343# define RT_COMPILER_SUPPORTS_LAMBDA
3344# endif
3345#elif defined(__GNUC__) && defined(__cplusplus)
3346/* 4.5 or later, I think, if in ++11 mode... */
3347#endif
3348
3349/** @def RT_FAR_DATA
3350 * Set to 1 if we're in 16-bit mode and use far pointers.
3351 */
3352#if ARCH_BITS == 16 && defined(__WATCOMC__) \
3353 && (defined(__COMPACT__) || defined(__LARGE__))
3354# define RT_FAR_DATA 1
3355#else
3356# define RT_FAR_DATA 0
3357#endif
3358
3359/** @} */
3360
3361
3362/** @defgroup grp_rt_cdefs_cpp Special Macros for C++
3363 * @ingroup grp_rt_cdefs
3364 * @{
3365 */
3366
3367#ifdef __cplusplus
3368
3369/** @def DECLEXPORT_CLASS
3370 * How to declare an exported class. Place this macro after the 'class'
3371 * keyword in the declaration of every class you want to export.
3372 *
3373 * @note It is necessary to use this macro even for inner classes declared
3374 * inside the already exported classes. This is a GCC specific requirement,
3375 * but it seems not to harm other compilers.
3376 */
3377#if defined(_MSC_VER) || defined(RT_OS_OS2)
3378# define DECLEXPORT_CLASS __declspec(dllexport)
3379#elif defined(RT_USE_VISIBILITY_DEFAULT)
3380# define DECLEXPORT_CLASS __attribute__((visibility("default")))
3381#else
3382# define DECLEXPORT_CLASS
3383#endif
3384
3385/** @def DECLIMPORT_CLASS
3386 * How to declare an imported class Place this macro after the 'class'
3387 * keyword in the declaration of every class you want to export.
3388 *
3389 * @note It is necessary to use this macro even for inner classes declared
3390 * inside the already exported classes. This is a GCC specific requirement,
3391 * but it seems not to harm other compilers.
3392 */
3393#if defined(_MSC_VER) || (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
3394# define DECLIMPORT_CLASS __declspec(dllimport)
3395#elif defined(RT_USE_VISIBILITY_DEFAULT)
3396# define DECLIMPORT_CLASS __attribute__((visibility("default")))
3397#else
3398# define DECLIMPORT_CLASS
3399#endif
3400
3401/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP
3402 * Macro to work around error C2593 of the not-so-smart MSVC 7.x ambiguity
3403 * resolver. The following snippet clearly demonstrates the code causing this
3404 * error:
3405 * @code
3406 * class A
3407 * {
3408 * public:
3409 * operator bool() const { return false; }
3410 * operator int*() const { return NULL; }
3411 * };
3412 * int main()
3413 * {
3414 * A a;
3415 * if (!a);
3416 * if (a && 0);
3417 * return 0;
3418 * }
3419 * @endcode
3420 * The code itself seems pretty valid to me and GCC thinks the same.
3421 *
3422 * This macro fixes the compiler error by explicitly overloading implicit
3423 * global operators !, && and || that take the given class instance as one of
3424 * their arguments.
3425 *
3426 * The best is to use this macro right after the class declaration.
3427 *
3428 * @note The macro expands to nothing for compilers other than MSVC.
3429 *
3430 * @param Cls Class to apply the workaround to
3431 */
3432#if defined(_MSC_VER)
3433# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls) \
3434 inline bool operator! (const Cls &that) { return !bool (that); } \
3435 inline bool operator&& (const Cls &that, bool b) { return bool (that) && b; } \
3436 inline bool operator|| (const Cls &that, bool b) { return bool (that) || b; } \
3437 inline bool operator&& (bool b, const Cls &that) { return b && bool (that); } \
3438 inline bool operator|| (bool b, const Cls &that) { return b || bool (that); }
3439#else
3440# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls)
3441#endif
3442
3443/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL
3444 * Version of WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP for template classes.
3445 *
3446 * @param Tpl Name of the template class to apply the workaround to
3447 * @param ArgsDecl arguments of the template, as declared in |<>| after the
3448 * |template| keyword, including |<>|
3449 * @param Args arguments of the template, as specified in |<>| after the
3450 * template class name when using the, including |<>|
3451 *
3452 * Example:
3453 * @code
3454 * // template class declaration
3455 * template <class C>
3456 * class Foo { ... };
3457 * // applied workaround
3458 * WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL (Foo, <class C>, <C>)
3459 * @endcode
3460 */
3461#if defined(_MSC_VER)
3462# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args) \
3463 template ArgsDecl \
3464 inline bool operator! (const Tpl Args &that) { return !bool (that); } \
3465 template ArgsDecl \
3466 inline bool operator&& (const Tpl Args &that, bool b) { return bool (that) && b; } \
3467 template ArgsDecl \
3468 inline bool operator|| (const Tpl Args &that, bool b) { return bool (that) || b; } \
3469 template ArgsDecl \
3470 inline bool operator&& (bool b, const Tpl Args &that) { return b && bool (that); } \
3471 template ArgsDecl \
3472 inline bool operator|| (bool b, const Tpl Args &that) { return b || bool (that); }
3473#else
3474# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args)
3475#endif
3476
3477
3478/** @def DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP
3479 * Declares the copy constructor and the assignment operation as inlined no-ops
3480 * (non-existent functions) for the given class. Use this macro inside the
3481 * private section if you want to effectively disable these operations for your
3482 * class.
3483 *
3484 * @param Cls class name to declare for
3485 */
3486
3487#define DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(Cls) \
3488 inline Cls (const Cls &); \
3489 inline Cls &operator= (const Cls &);
3490
3491
3492/** @def DECLARE_CLS_NEW_DELETE_NOOP
3493 * Declares the new and delete operations as no-ops (non-existent functions)
3494 * for the given class. Use this macro inside the private section if you want
3495 * to effectively limit creating class instances on the stack only.
3496 *
3497 * @note The destructor of the given class must not be virtual, otherwise a
3498 * compile time error will occur. Note that this is not a drawback: having
3499 * the virtual destructor for a stack-based class is absolutely useless
3500 * (the real class of the stack-based instance is always known to the compiler
3501 * at compile time, so it will always call the correct destructor).
3502 *
3503 * @param Cls class name to declare for
3504 */
3505#define DECLARE_CLS_NEW_DELETE_NOOP(Cls) \
3506 inline static void *operator new (size_t); \
3507 inline static void operator delete (void *);
3508
3509#endif /* __cplusplus */
3510
3511/** @} */
3512
3513#endif
3514
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette