VirtualBox

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

Last change on this file since 62485 was 62473, checked in by vboxsync, 8 years ago

(C) 2016

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 146.5 KB
Line 
1/** @file
2 * IPRT - Common C and C++ definitions.
3 */
4
5/*
6 * Copyright (C) 2006-2016 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_GCC_NO_WARN_DEPRECATED_BEGIN
991 * Used to start a block of code where GCC should not warn about deprecated
992 * declarations. */
993#if RT_GNUC_PREREQ(4, 6)
994# define RT_GCC_NO_WARN_DEPRECATED_BEGIN \
995 _Pragma("GCC diagnostic push") \
996 _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
997/** @def RT_GCC_NO_WARN_DEPRECATED_END
998 * Used to end a block of code where GCC should not warn about deprecated
999 * declarations. */
1000# define RT_GCC_NO_WARN_DEPRECATED_END \
1001 _Pragma("GCC diagnostic pop")
1002#else
1003# define RT_GCC_NO_WARN_DEPRECATED_BEGIN
1004# define RT_GCC_NO_WARN_DEPRECATED_END
1005#endif
1006
1007/** @def RT_GCC_NO_WARN_CONVERSION_BEGIN
1008 * Used to start a block of code where GCC should not warn about implicit
1009 * conversions that may alter a value. */
1010#if RT_GNUC_PREREQ(4, 6)
1011# define RT_GCC_NO_WARN_CONVERSION_BEGIN \
1012 _Pragma("GCC diagnostic push") \
1013 _Pragma("GCC diagnostic ignored \"-Wconversion\"")
1014/** @def RT_GCC_NO_WARN_CONVERSION_END
1015 * Used to end a block of code where GCC should not warn about implicit
1016 * conversions that may alter a value. */
1017# define RT_GCC_NO_WARN_CONVERSION_END \
1018 _Pragma("GCC diagnostic pop")
1019#else
1020# define RT_GCC_NO_WARN_CONVERSION_BEGIN
1021# define RT_GCC_NO_WARN_CONVERSION_END
1022#endif
1023
1024/** @def RT_COMPILER_GROKS_64BIT_BITFIELDS
1025 * Macro that is defined if the compiler understands 64-bit bitfields. */
1026#if !defined(RT_OS_OS2) || (!defined(__IBMC__) && !defined(__IBMCPP__))
1027# if !defined(__WATCOMC__) /* watcom compiler doesn't grok it either. */
1028# define RT_COMPILER_GROKS_64BIT_BITFIELDS
1029# endif
1030#endif
1031
1032/** @def RT_COMPILER_WITH_80BIT_LONG_DOUBLE
1033 * Macro that is defined if the compiler implements long double as the
1034 * IEEE extended precision floating. */
1035#if (defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)) && !defined(RT_OS_WINDOWS)
1036# define RT_COMPILER_WITH_80BIT_LONG_DOUBLE
1037#endif
1038
1039
1040/** @def RT_EXCEPTIONS_ENABLED
1041 * Defined when C++ exceptions are enabled.
1042 */
1043#if !defined(RT_EXCEPTIONS_ENABLED) \
1044 && defined(__cplusplus) \
1045 && ( (defined(_MSC_VER) && defined(_CPPUNWIND)) \
1046 || (defined(__GNUC__) && defined(__EXCEPTIONS)))
1047# define RT_EXCEPTIONS_ENABLED
1048#endif
1049
1050/** @def RT_NO_THROW_PROTO
1051 * How to express that a function doesn't throw C++ exceptions
1052 * and the compiler can thus save itself the bother of trying
1053 * to catch any of them. Put this between the closing parenthesis
1054 * and the semicolon in function prototypes (and implementation if C++).
1055 *
1056 * @remarks May not work on C++ methods, mainly intented for C-style APIs.
1057 *
1058 * @remarks The use of the nothrow attribute with GCC is because old compilers
1059 * (4.1.1, 32-bit) leaking the nothrow into global space or something
1060 * when used with RTDECL or similar. Using this forces use to have two
1061 * macros, as the nothrow attribute is not for the function definition.
1062 */
1063#ifdef RT_EXCEPTIONS_ENABLED
1064# ifdef __GNUC__
1065# define RT_NO_THROW_PROTO __attribute__((__nothrow__))
1066# else
1067# define RT_NO_THROW_PROTO throw()
1068# endif
1069#else
1070# define RT_NO_THROW_PROTO
1071#endif
1072
1073/** @def RT_NO_THROW_DEF
1074 * The counter part to RT_NO_THROW_PROTO that is added to the function
1075 * definition.
1076 */
1077#if defined(RT_EXCEPTIONS_ENABLED) && !defined(__GNUC__)
1078# define RT_NO_THROW_DEF RT_NO_THROW_PROTO
1079#else
1080# define RT_NO_THROW_DEF
1081#endif
1082
1083/** @def RT_THROW
1084 * How to express that a method or function throws a type of exceptions. Some
1085 * compilers does not want this kind of information and will warning about it.
1086 *
1087 * @param type The type exception.
1088 *
1089 * @remarks If the actual throwing is done from the header, enclose it by
1090 * \#ifdef RT_EXCEPTIONS_ENABLED ... \#else ... \#endif so the header
1091 * compiles cleanly without exceptions enabled.
1092 *
1093 * Do NOT use this for the actual throwing of exceptions!
1094 */
1095#ifdef RT_EXCEPTIONS_ENABLED
1096# ifdef _MSC_VER
1097# if _MSC_VER >= 1310
1098# define RT_THROW(type)
1099# else
1100# define RT_THROW(type) throw(type)
1101# endif
1102# else
1103# define RT_THROW(type) throw(type)
1104# endif
1105#else
1106# define RT_THROW(type)
1107#endif
1108
1109/** @def RT_IPRT_FORMAT_ATTR
1110 * Identifies a function taking an IPRT format string.
1111 * @param a_iFmt The index (1-based) of the format string argument.
1112 * @param a_iArgs The index (1-based) of the first format argument, use 0 for
1113 * va_list.
1114 */
1115#if defined(__GNUC__) && defined(WITH_IPRT_FORMAT_ATTRIBUTE)
1116# define RT_IPRT_FORMAT_ATTR(a_iFmt, a_iArgs) __attribute__((__iprt_format__(a_iFmt, a_iArgs)))
1117#else
1118# define RT_IPRT_FORMAT_ATTR(a_iFmt, a_iArgs)
1119#endif
1120
1121/** @def RT_IPRT_FORMAT_ATTR_MAYBE_NULL
1122 * Identifies a function taking an IPRT format string, NULL is allowed.
1123 * @param a_iFmt The index (1-based) of the format string argument.
1124 * @param a_iArgs The index (1-based) of the first format argument, use 0 for
1125 * va_list.
1126 */
1127#if defined(__GNUC__) && defined(WITH_IPRT_FORMAT_ATTRIBUTE)
1128# define RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a_iFmt, a_iArgs) __attribute__((__iprt_format_maybe_null__(a_iFmt, a_iArgs)))
1129#else
1130# define RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a_iFmt, a_iArgs)
1131#endif
1132
1133
1134/** @def RT_GCC_SUPPORTS_VISIBILITY_HIDDEN
1135 * Indicates that the "hidden" visibility attribute can be used (GCC) */
1136#if defined(__GNUC__)
1137# if __GNUC__ >= 4 && !defined(RT_OS_OS2) && !defined(RT_OS_WINDOWS)
1138# define RT_GCC_SUPPORTS_VISIBILITY_HIDDEN
1139# endif
1140#endif
1141
1142/** @def RT_COMPILER_SUPPORTS_VA_ARGS
1143 * If the defined, the compiler supports the variadic macro feature (..., __VA_ARGS__). */
1144#if defined(_MSC_VER)
1145# if _MSC_VER >= 1600 /* Visual C++ v10.0 / 2010 */
1146# define RT_COMPILER_SUPPORTS_VA_ARGS
1147# endif
1148#elif defined(__GNUC__)
1149# if __GNUC__ >= 3 /* not entirely sure when this was added */
1150# define RT_COMPILER_SUPPORTS_VA_ARGS
1151# endif
1152#endif
1153
1154
1155
1156/** @def RTCALL
1157 * The standard calling convention for the Runtime interfaces.
1158 *
1159 * @remarks The regparm(0) in the X86/GNUC variant deals with -mregparm=x use in
1160 * the linux kernel and potentially elsewhere (3rd party).
1161 */
1162#if defined(_MSC_VER) || defined(__WATCOMC__)
1163# define RTCALL __cdecl
1164#elif defined(RT_OS_OS2)
1165# define RTCALL __cdecl
1166#elif defined(__GNUC__) && defined(RT_ARCH_X86)
1167# define RTCALL __attribute__((cdecl,regparm(0)))
1168#else
1169# define RTCALL
1170#endif
1171
1172/** @def DECLEXPORT
1173 * How to declare an exported function.
1174 * @param type The return type of the function declaration.
1175 */
1176#if defined(_MSC_VER) || defined(RT_OS_OS2)
1177# define DECLEXPORT(type) __declspec(dllexport) type
1178#elif defined(RT_USE_VISIBILITY_DEFAULT)
1179# define DECLEXPORT(type) __attribute__((visibility("default"))) type
1180#else
1181# define DECLEXPORT(type) type
1182#endif
1183
1184/** @def DECLIMPORT
1185 * How to declare an imported function.
1186 * @param type The return type of the function declaration.
1187 */
1188#if defined(_MSC_VER) || (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
1189# define DECLIMPORT(type) __declspec(dllimport) type
1190#else
1191# define DECLIMPORT(type) type
1192#endif
1193
1194/** @def DECLHIDDEN
1195 * How to declare a non-exported function or variable.
1196 * @param type The return type of the function or the data type of the variable.
1197 */
1198#if !defined(RT_GCC_SUPPORTS_VISIBILITY_HIDDEN) || defined(RT_NO_VISIBILITY_HIDDEN)
1199# define DECLHIDDEN(type) type
1200#else
1201# define DECLHIDDEN(type) __attribute__((visibility("hidden"))) type
1202#endif
1203
1204/** @def DECL_HIDDEN_CONST
1205 * Workaround for g++ warnings when applying the hidden attribute to a const
1206 * definition. Use DECLHIDDEN for the declaration.
1207 * @param a_Type The return type of the function or the data type of
1208 * the variable.
1209 */
1210#if defined(__cplusplus) && defined(__GNUC__)
1211# define DECL_HIDDEN_CONST(a_Type) a_Type
1212#else
1213# define DECL_HIDDEN_CONST(a_Type) DECLHIDDEN(a_Type)
1214#endif
1215
1216/** @def DECL_INVALID
1217 * How to declare a function not available for linking in the current context.
1218 * The purpose is to create compile or like time errors when used. This isn't
1219 * possible on all platforms.
1220 * @param type The return type of the function.
1221 */
1222#if defined(_MSC_VER)
1223# define DECL_INVALID(type) __declspec(dllimport) type __stdcall
1224#elif defined(__GNUC__) && defined(__cplusplus)
1225# define DECL_INVALID(type) extern "C++" type
1226#else
1227# define DECL_INVALID(type) type
1228#endif
1229
1230/** @def DECLASM
1231 * How to declare an internal assembly function.
1232 * @param type The return type of the function declaration.
1233 */
1234#ifdef __cplusplus
1235# define DECLASM(type) extern "C" type RTCALL
1236#else
1237# define DECLASM(type) type RTCALL
1238#endif
1239
1240/** @def DECLASMTYPE
1241 * How to declare an internal assembly function type.
1242 * @param type The return type of the function.
1243 */
1244#define DECLASMTYPE(type) type RTCALL
1245
1246/** @def DECL_NO_RETURN
1247 * How to declare a function which does not return.
1248 * @note This macro can be combined with other macros, for example
1249 * @code
1250 * EMR3DECL(DECL_NO_RETURN(void)) foo(void);
1251 * @endcode
1252 */
1253#ifdef _MSC_VER
1254# define DECL_NO_RETURN(type) __declspec(noreturn) type
1255#elif defined(__GNUC__)
1256# define DECL_NO_RETURN(type) __attribute__((noreturn)) type
1257#else
1258# define DECL_NO_RETURN(type) type
1259#endif
1260/** @deprecated Use DECL_NO_RETURN instead. */
1261#define DECLNORETURN(type) DECL_NO_RETURN(type)
1262
1263/** @def DECL_RETURNS_TWICE
1264 * How to declare a function which may return more than once.
1265 * @note This macro can be combined with other macros, for example
1266 * @code
1267 * EMR3DECL(DECL_RETURNS_TWICE(void)) MySetJmp(void);
1268 * @endcode
1269 */
1270#if RT_GNUC_PREREQ(4, 1)
1271# define DECL_RETURNS_TWICE(type) __attribute__((returns_twice)) type
1272# else
1273# define DECL_RETURNS_TWICE(type) type
1274#endif
1275
1276/** @def DECLWEAK
1277 * How to declare a variable which is not necessarily resolved at
1278 * runtime.
1279 * @note This macro can be combined with other macros, for example
1280 * @code
1281 * EMR3DECL(DECLWEAK(int)) foo;
1282 * @endcode
1283 */
1284#if defined(__GNUC__)
1285# define DECLWEAK(type) type __attribute__((weak))
1286#else
1287# define DECLWEAK(type) type
1288#endif
1289
1290/** @def DECLCALLBACK
1291 * How to declare an call back function type.
1292 * @param type The return type of the function declaration.
1293 */
1294#define DECLCALLBACK(type) type RTCALL
1295
1296/** @def DECLCALLBACKPTR
1297 * How to declare an call back function pointer.
1298 * @param type The return type of the function declaration.
1299 * @param name The name of the variable member.
1300 */
1301#if defined(__IBMC__) || defined(__IBMCPP__)
1302# define DECLCALLBACKPTR(type, name) type (* RTCALL name)
1303#else
1304# define DECLCALLBACKPTR(type, name) type (RTCALL * name)
1305#endif
1306
1307/** @def DECLCALLBACKMEMBER
1308 * How to declare an call back function pointer member.
1309 * @param type The return type of the function declaration.
1310 * @param name The name of the struct/union/class member.
1311 */
1312#if defined(__IBMC__) || defined(__IBMCPP__)
1313# define DECLCALLBACKMEMBER(type, name) type (* RTCALL name)
1314#else
1315# define DECLCALLBACKMEMBER(type, name) type (RTCALL * name)
1316#endif
1317
1318/** @def DECLR3CALLBACKMEMBER
1319 * How to declare an call back function pointer member - R3 Ptr.
1320 * @param type The return type of the function declaration.
1321 * @param name The name of the struct/union/class member.
1322 * @param args The argument list enclosed in parentheses.
1323 */
1324#ifdef IN_RING3
1325# define DECLR3CALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1326#else
1327# define DECLR3CALLBACKMEMBER(type, name, args) RTR3PTR name
1328#endif
1329
1330/** @def DECLRCCALLBACKMEMBER
1331 * How to declare an call back function pointer member - RC Ptr.
1332 * @param type The return type of the function declaration.
1333 * @param name The name of the struct/union/class member.
1334 * @param args The argument list enclosed in parentheses.
1335 */
1336#ifdef IN_RC
1337# define DECLRCCALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1338#else
1339# define DECLRCCALLBACKMEMBER(type, name, args) RTRCPTR name
1340#endif
1341
1342/** @def DECLR0CALLBACKMEMBER
1343 * How to declare an call back function pointer member - R0 Ptr.
1344 * @param type The return type of the function declaration.
1345 * @param name The name of the struct/union/class member.
1346 * @param args The argument list enclosed in parentheses.
1347 */
1348#ifdef IN_RING0
1349# define DECLR0CALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1350#else
1351# define DECLR0CALLBACKMEMBER(type, name, args) RTR0PTR name
1352#endif
1353
1354/** @def DECLINLINE
1355 * How to declare a function as inline.
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 DECLINLINE(type) static __inline__ type
1361#elif defined(__cplusplus)
1362# define DECLINLINE(type) static inline type
1363#elif defined(_MSC_VER)
1364# define DECLINLINE(type) static _inline type
1365#elif defined(__IBMC__)
1366# define DECLINLINE(type) _Inline type
1367#else
1368# define DECLINLINE(type) inline type
1369#endif
1370
1371
1372/** @def DECL_FORCE_INLINE
1373 * How to declare a function as inline and try convince the compiler to always
1374 * inline it regardless of optimization switches.
1375 * @param type The return type of the function declaration.
1376 * @remarks Use sparsely and with care. Don't use this macro on C++ methods.
1377 */
1378#ifdef __GNUC__
1379# define DECL_FORCE_INLINE(type) __attribute__((__always_inline__)) DECLINLINE(type)
1380#elif defined(_MSC_VER)
1381# define DECL_FORCE_INLINE(type) __forceinline type
1382#else
1383# define DECL_FORCE_INLINE(type) DECLINLINE(type)
1384#endif
1385
1386
1387/** @def DECL_NO_INLINE
1388 * How to declare a function telling the compiler not to inline it.
1389 * @param scope The function scope, static or RT_NOTHING.
1390 * @param type The return type of the function declaration.
1391 * @remarks Don't use this macro on C++ methods.
1392 */
1393#ifdef __GNUC__
1394# define DECL_NO_INLINE(scope,type) __attribute__((__noinline__)) scope type
1395#elif defined(_MSC_VER)
1396# define DECL_NO_INLINE(scope,type) __declspec(noinline) scope type
1397#else
1398# define DECL_NO_INLINE(scope,type) scope type
1399#endif
1400
1401
1402/** @def IN_RT_STATIC
1403 * Used to indicate whether we're linking against a static IPRT
1404 * or not. The IPRT symbols will be declared as hidden (if
1405 * supported). Note that this define has no effect without setting
1406 * IN_RT_R0, IN_RT_R3 or IN_RT_RC indicators are set first.
1407 */
1408
1409/** @def IN_RT_R0
1410 * Used to indicate whether we're inside the same link module as
1411 * the HC Ring-0 Runtime Library.
1412 */
1413/** @def RTR0DECL(type)
1414 * Runtime Library HC Ring-0 export or import declaration.
1415 * @param type The return type of the function declaration.
1416 */
1417#ifdef IN_RT_R0
1418# ifdef IN_RT_STATIC
1419# define RTR0DECL(type) DECLHIDDEN(type) RTCALL
1420# else
1421# define RTR0DECL(type) DECLEXPORT(type) RTCALL
1422# endif
1423#else
1424# define RTR0DECL(type) DECLIMPORT(type) RTCALL
1425#endif
1426
1427/** @def IN_RT_R3
1428 * Used to indicate whether we're inside the same link module as
1429 * the HC Ring-3 Runtime Library.
1430 */
1431/** @def RTR3DECL(type)
1432 * Runtime Library HC Ring-3 export or import declaration.
1433 * @param type The return type of the function declaration.
1434 */
1435#ifdef IN_RT_R3
1436# ifdef IN_RT_STATIC
1437# define RTR3DECL(type) DECLHIDDEN(type) RTCALL
1438# else
1439# define RTR3DECL(type) DECLEXPORT(type) RTCALL
1440# endif
1441#else
1442# define RTR3DECL(type) DECLIMPORT(type) RTCALL
1443#endif
1444
1445/** @def IN_RT_RC
1446 * Used to indicate whether we're inside the same link module as the raw-mode
1447 * context (RC) runtime library.
1448 */
1449/** @def RTRCDECL(type)
1450 * Runtime Library raw-mode context export or import declaration.
1451 * @param type The return type of the function declaration.
1452 */
1453#ifdef IN_RT_RC
1454# ifdef IN_RT_STATIC
1455# define RTRCDECL(type) DECLHIDDEN(type) RTCALL
1456# else
1457# define RTRCDECL(type) DECLEXPORT(type) RTCALL
1458# endif
1459#else
1460# define RTRCDECL(type) DECLIMPORT(type) RTCALL
1461#endif
1462
1463/** @def RTDECL(type)
1464 * Runtime Library export or import declaration.
1465 * Functions declared using this macro exists in all contexts.
1466 * @param type The return type of the function declaration.
1467 */
1468#if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0)
1469# ifdef IN_RT_STATIC
1470# define RTDECL(type) DECLHIDDEN(type) RTCALL
1471# else
1472# define RTDECL(type) DECLEXPORT(type) RTCALL
1473# endif
1474#else
1475# define RTDECL(type) DECLIMPORT(type) RTCALL
1476#endif
1477
1478/** @def RTDATADECL(type)
1479 * Runtime Library export or import declaration.
1480 * Data declared using this macro exists in all contexts.
1481 * @param type The data type.
1482 */
1483/** @def RT_DECL_DATA_CONST(type)
1484 * Definition of a const variable. See DECL_HIDDEN_CONST.
1485 * @param type The const data type.
1486 */
1487#if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0)
1488# ifdef IN_RT_STATIC
1489# define RTDATADECL(type) DECLHIDDEN(type)
1490# define RT_DECL_DATA_CONST(type) DECL_HIDDEN_CONST(type)
1491# else
1492# define RTDATADECL(type) DECLEXPORT(type)
1493# if defined(__cplusplus) && defined(__GNUC__)
1494# define RT_DECL_DATA_CONST(type) type
1495# else
1496# define RT_DECL_DATA_CONST(type) DECLEXPORT(type)
1497# endif
1498# endif
1499#else
1500# define RTDATADECL(type) DECLIMPORT(type)
1501# define RT_DECL_DATA_CONST(type) DECLIMPORT(type)
1502#endif
1503
1504/** @def RT_DECL_CLASS
1505 * Declares an class living in the runtime.
1506 */
1507#if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0)
1508# ifdef IN_RT_STATIC
1509# define RT_DECL_CLASS
1510# else
1511# define RT_DECL_CLASS DECLEXPORT_CLASS
1512# endif
1513#else
1514# define RT_DECL_CLASS DECLIMPORT_CLASS
1515#endif
1516
1517
1518/** @def RT_NOCRT
1519 * Symbol name wrapper for the No-CRT bits.
1520 *
1521 * In order to coexist in the same process as other CRTs, we need to
1522 * decorate the symbols such that they don't conflict the ones in the
1523 * other CRTs. The result of such conflicts / duplicate symbols can
1524 * confuse the dynamic loader on Unix like systems.
1525 *
1526 * Define RT_WITHOUT_NOCRT_WRAPPERS to drop the wrapping.
1527 * Define RT_WITHOUT_NOCRT_WRAPPER_ALIASES to drop the aliases to the
1528 * wrapped names.
1529 */
1530/** @def RT_NOCRT_STR
1531 * Same as RT_NOCRT only it'll return a double quoted string of the result.
1532 */
1533#ifndef RT_WITHOUT_NOCRT_WRAPPERS
1534# define RT_NOCRT(name) nocrt_ ## name
1535# define RT_NOCRT_STR(name) "nocrt_" # name
1536#else
1537# define RT_NOCRT(name) name
1538# define RT_NOCRT_STR(name) #name
1539#endif
1540
1541
1542
1543/** @def RT_LIKELY
1544 * Give the compiler a hint that an expression is very likely to hold true.
1545 *
1546 * Some compilers support explicit branch prediction so that the CPU backend
1547 * can hint the processor and also so that code blocks can be reordered such
1548 * that the predicted path sees a more linear flow, thus improving cache
1549 * behaviour, etc.
1550 *
1551 * IPRT provides the macros RT_LIKELY() and RT_UNLIKELY() as a way to utilize
1552 * this compiler feature when present.
1553 *
1554 * A few notes about the usage:
1555 *
1556 * - Generally, order your code use RT_LIKELY() instead of RT_UNLIKELY().
1557 *
1558 * - Generally, use RT_UNLIKELY() with error condition checks (unless you
1559 * have some _strong_ reason to do otherwise, in which case document it),
1560 * and/or RT_LIKELY() with success condition checks, assuming you want
1561 * to optimize for the success path.
1562 *
1563 * - Other than that, if you don't know the likelihood of a test succeeding
1564 * from empirical or other 'hard' evidence, don't make predictions unless
1565 * you happen to be a Dirk Gently character.
1566 *
1567 * - These macros are meant to be used in places that get executed a lot. It
1568 * is wasteful to make predictions in code that is executed rarely (e.g.
1569 * at subsystem initialization time) as the basic block reordering that this
1570 * affects can often generate larger code.
1571 *
1572 * - Note that RT_SUCCESS() and RT_FAILURE() already makes use of RT_LIKELY()
1573 * and RT_UNLIKELY(). Should you wish for prediction free status checks,
1574 * use the RT_SUCCESS_NP() and RT_FAILURE_NP() macros instead.
1575 *
1576 *
1577 * @returns the boolean result of the expression.
1578 * @param expr The expression that's very likely to be true.
1579 * @see RT_UNLIKELY
1580 */
1581/** @def RT_UNLIKELY
1582 * Give the compiler a hint that an expression is highly unlikely to hold true.
1583 *
1584 * See the usage instructions give in the RT_LIKELY() docs.
1585 *
1586 * @returns the boolean result of the expression.
1587 * @param expr The expression that's very unlikely to be true.
1588 * @see RT_LIKELY
1589 *
1590 * @deprecated Please use RT_LIKELY() instead wherever possible! That gives us
1591 * a better chance of the windows compilers to generate favorable code
1592 * too. The belief is that the compiler will by default assume the
1593 * if-case is more likely than the else-case.
1594 */
1595#if defined(__GNUC__)
1596# if __GNUC__ >= 3 && !defined(FORTIFY_RUNNING)
1597# define RT_LIKELY(expr) __builtin_expect(!!(expr), 1)
1598# define RT_UNLIKELY(expr) __builtin_expect(!!(expr), 0)
1599# else
1600# define RT_LIKELY(expr) (expr)
1601# define RT_UNLIKELY(expr) (expr)
1602# endif
1603#else
1604# define RT_LIKELY(expr) (expr)
1605# define RT_UNLIKELY(expr) (expr)
1606#endif
1607
1608/** @def RT_EXPAND_2
1609 * Helper for RT_EXPAND. */
1610#define RT_EXPAND_2(a_Expr) a_Expr
1611/** @def RT_EXPAND
1612 * Returns the expanded expression.
1613 * @param a_Expr The expression to expand. */
1614#define RT_EXPAND(a_Expr) RT_EXPAND_2(a_Expr)
1615
1616/** @def RT_STR
1617 * Returns the argument as a string constant.
1618 * @param str Argument to stringify. */
1619#define RT_STR(str) #str
1620/** @def RT_XSTR
1621 * Returns the expanded argument as a string.
1622 * @param str Argument to expand and stringify. */
1623#define RT_XSTR(str) RT_STR(str)
1624
1625/** @def RT_LSTR_2
1626 * Helper for RT_WSTR that gets the expanded @a str.
1627 * @param str String litteral to prefix with 'L'. */
1628#define RT_LSTR_2(str) L##str
1629/** @def RT_LSTR
1630 * Returns the expanded argument with a L string prefix.
1631 *
1632 * Intended for converting ASCII string \#defines into wide char string
1633 * litterals on Windows.
1634 *
1635 * @param str String litteral to . */
1636#define RT_LSTR(str) RT_LSTR_2(str)
1637
1638/** @def RT_UNPACK_CALL
1639 * Unpacks the an argument list inside an extra set of parenthesis and turns it
1640 * into a call to @a a_Fn.
1641 *
1642 * @param a_Fn Function/macro to call.
1643 * @param a_Args Parameter list in parenthesis.
1644 */
1645#define RT_UNPACK_CALL(a_Fn, a_Args) a_Fn a_Args
1646
1647#if defined(RT_COMPILER_SUPPORTS_VA_ARGS) || defined(DOXYGEN_RUNNING)
1648
1649/** @def RT_UNPACK_ARGS
1650 * Returns the arguments without parenthesis.
1651 *
1652 * @param ... Parameter list in parenthesis.
1653 * @remarks Requires RT_COMPILER_SUPPORTS_VA_ARGS.
1654 */
1655# define RT_UNPACK_ARGS(...) __VA_ARGS__
1656
1657/** @def RT_COUNT_VA_ARGS_HLP
1658 * Helper for RT_COUNT_VA_ARGS that picks out the argument count from
1659 * RT_COUNT_VA_ARGS_REV_SEQ. */
1660# define RT_COUNT_VA_ARGS_HLP( \
1661 c69, c68, c67, c66, c65, c64, c63, c62, c61, c60, \
1662 c59, c58, c57, c56, c55, c54, c53, c52, c51, c50, \
1663 c49, c48, c47, c46, c45, c44, c43, c42, c41, c40, \
1664 c39, c38, c37, c36, c35, c34, c33, c32, c31, c30, \
1665 c29, c28, c27, c26, c25, c24, c23, c22, c21, c20, \
1666 c19, c18, c17, c16, c15, c14, c13, c12, c11, c10, \
1667 c9, c8, c7, c6, c5, c4, c3, c2, c1, cArgs, ...) cArgs
1668/** Argument count sequence. */
1669# define RT_COUNT_VA_ARGS_REV_SEQ \
1670 69, 68, 67, 66, 65, 64, 63, 62, 61, 60, \
1671 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, \
1672 49, 48, 47, 46, 45, 44, 43, 42, 41, 40, \
1673 39, 38, 37, 36, 35, 34, 33, 32, 31, 30, \
1674 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, \
1675 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, \
1676 9, 8, 7, 6, 5, 4, 3, 2, 1, 0
1677/** This is for zero arguments. At least Visual C++ requires it. */
1678# define RT_COUNT_VA_ARGS_PREFIX_RT_NOTHING RT_COUNT_VA_ARGS_REV_SEQ
1679/**
1680 * Counts the number of arguments given to the variadic macro.
1681 *
1682 * Max is 69.
1683 *
1684 * @returns Number of arguments in the ellipsis
1685 * @param ... Arguments to count.
1686 * @remarks Requires RT_COMPILER_SUPPORTS_VA_ARGS.
1687 */
1688# define RT_COUNT_VA_ARGS(...) \
1689 RT_UNPACK_CALL(RT_COUNT_VA_ARGS_HLP, (RT_COUNT_VA_ARGS_PREFIX_ ## __VA_ARGS__ ## RT_NOTHING, \
1690 RT_COUNT_VA_ARGS_REV_SEQ))
1691
1692#endif /* RT_COMPILER_SUPPORTS_VA_ARGS */
1693
1694
1695/** @def RT_CONCAT
1696 * Concatenate the expanded arguments without any extra spaces in between.
1697 *
1698 * @param a The first part.
1699 * @param b The second part.
1700 */
1701#define RT_CONCAT(a,b) RT_CONCAT_HLP(a,b)
1702/** RT_CONCAT helper, don't use. */
1703#define RT_CONCAT_HLP(a,b) a##b
1704
1705/** @def RT_CONCAT3
1706 * Concatenate the expanded arguments without any extra spaces in between.
1707 *
1708 * @param a The 1st part.
1709 * @param b The 2nd part.
1710 * @param c The 3rd part.
1711 */
1712#define RT_CONCAT3(a,b,c) RT_CONCAT3_HLP(a,b,c)
1713/** RT_CONCAT3 helper, don't use. */
1714#define RT_CONCAT3_HLP(a,b,c) a##b##c
1715
1716/** @def RT_CONCAT4
1717 * Concatenate the expanded arguments without any extra spaces in between.
1718 *
1719 * @param a The 1st part.
1720 * @param b The 2nd part.
1721 * @param c The 3rd part.
1722 * @param d The 4th part.
1723 */
1724#define RT_CONCAT4(a,b,c,d) RT_CONCAT4_HLP(a,b,c,d)
1725/** RT_CONCAT4 helper, don't use. */
1726#define RT_CONCAT4_HLP(a,b,c,d) a##b##c##d
1727
1728/** @def RT_CONCAT5
1729 * Concatenate the expanded arguments without any extra spaces in between.
1730 *
1731 * @param a The 1st part.
1732 * @param b The 2nd part.
1733 * @param c The 3rd part.
1734 * @param d The 4th part.
1735 * @param e The 5th part.
1736 */
1737#define RT_CONCAT5(a,b,c,d,e) RT_CONCAT5_HLP(a,b,c,d,e)
1738/** RT_CONCAT5 helper, don't use. */
1739#define RT_CONCAT5_HLP(a,b,c,d,e) a##b##c##d##e
1740
1741/** @def RT_CONCAT6
1742 * Concatenate the expanded arguments without any extra spaces in between.
1743 *
1744 * @param a The 1st part.
1745 * @param b The 2nd part.
1746 * @param c The 3rd part.
1747 * @param d The 4th part.
1748 * @param e The 5th part.
1749 * @param f The 6th part.
1750 */
1751#define RT_CONCAT6(a,b,c,d,e,f) RT_CONCAT6_HLP(a,b,c,d,e,f)
1752/** RT_CONCAT6 helper, don't use. */
1753#define RT_CONCAT6_HLP(a,b,c,d,e,f) a##b##c##d##e##f
1754
1755/**
1756 * String constant tuple - string constant, strlen(string constant).
1757 *
1758 * @param a_szConst String constant.
1759 * @sa RTSTRTUPLE
1760 */
1761#define RT_STR_TUPLE(a_szConst) a_szConst, (sizeof(a_szConst) - 1)
1762
1763
1764/**
1765 * Macro for using in switch statements that turns constants into strings.
1766 *
1767 * @param a_Const The constant (not string).
1768 */
1769#define RT_CASE_RET_STR(a_Const) case a_Const: return #a_Const
1770
1771
1772/** @def RT_BIT
1773 * Convert a bit number into an integer bitmask (unsigned).
1774 * @param bit The bit number.
1775 */
1776#define RT_BIT(bit) ( 1U << (bit) )
1777
1778/** @def RT_BIT_32
1779 * Convert a bit number into a 32-bit bitmask (unsigned).
1780 * @param bit The bit number.
1781 */
1782#define RT_BIT_32(bit) ( UINT32_C(1) << (bit) )
1783
1784/** @def RT_BIT_64
1785 * Convert a bit number into a 64-bit bitmask (unsigned).
1786 * @param bit The bit number.
1787 */
1788#define RT_BIT_64(bit) ( UINT64_C(1) << (bit) )
1789
1790
1791/** @def RT_BF_GET
1792 * Gets the value of a bit field in an integer value.
1793 *
1794 * This requires a couple of macros to be defined for the field:
1795 * - \<a_FieldNm\>_SHIFT: The shift count to get to the field.
1796 * - \<a_FieldNm\>_MASK: The field mask.
1797 *
1798 * @returns The bit field value.
1799 * @param a_uValue The integer value containing the field.
1800 * @param a_FieldNm The field name prefix for getting at the _SHIFT and
1801 * _MASK macros.
1802 * @sa #RT_BF_CLEAR, #RT_BF_SET, #RT_BF_MAKE, #RT_BF_ZMASK
1803 */
1804#define RT_BF_GET(a_uValue, a_FieldNm) ( ((a_uValue) >> RT_CONCAT(a_FieldNm,_SHIFT)) & RT_BF_ZMASK(a_FieldNm) )
1805
1806/** @def RT_BF_SET
1807 * Sets the given bit field in the integer value.
1808 *
1809 * This requires a couple of macros to be defined for the field:
1810 * - \<a_FieldNm\>_SHIFT: The shift count to get to the field.
1811 * - \<a_FieldNm\>_MASK: The field mask. Must have the same type as the
1812 * integer value!!
1813 *
1814 * @returns Integer value with bit field set to @a a_uFieldValue.
1815 * @param a_uValue The integer value containing the field.
1816 * @param a_FieldNm The field name prefix for getting at the _SHIFT and
1817 * _MASK macros.
1818 * @param a_uFieldValue The new field value.
1819 * @sa #RT_BF_GET, #RT_BF_CLEAR, #RT_BF_MAKE, #RT_BF_ZMASK
1820 */
1821#define RT_BF_SET(a_uValue, a_FieldNm, a_uFieldValue) ( RT_BF_CLEAR(a_uValue, a_FieldNm) | RT_BF_MAKE(a_FieldNm, a_uFieldValue) )
1822
1823/** @def RT_BF_CLEAR
1824 * Clears the given bit field in the integer value.
1825 *
1826 * This requires a couple of macros to be defined for the field:
1827 * - \<a_FieldNm\>_SHIFT: The shift count to get to the field.
1828 * - \<a_FieldNm\>_MASK: The field mask. Must have the same type as the
1829 * integer value!!
1830 *
1831 * @returns Integer value with bit field set to zero.
1832 * @param a_uValue The integer value containing the field.
1833 * @param a_FieldNm The field name prefix for getting at the _SHIFT and
1834 * _MASK macros.
1835 * @sa #RT_BF_GET, #RT_BF_SET, #RT_BF_MAKE, #RT_BF_ZMASK
1836 */
1837#define RT_BF_CLEAR(a_uValue, a_FieldNm) ( (a_uValue) & ~RT_CONCAT(a_FieldNm,_MASK) )
1838
1839/** @def RT_BF_MAKE
1840 * Shifts and masks a bit field value into position in the integer value.
1841 *
1842 * This requires a couple of macros to be defined for the field:
1843 * - \<a_FieldNm\>_SHIFT: The shift count to get to the field.
1844 * - \<a_FieldNm\>_MASK: The field mask.
1845 *
1846 * @param a_FieldNm The field name prefix for getting at the _SHIFT and
1847 * _MASK macros.
1848 * @param a_uFieldValue The field value that should be masked and shifted
1849 * into position.
1850 * @sa #RT_BF_GET, #RT_BF_SET, #RT_BF_CLEAR, #RT_BF_ZMASK
1851 */
1852#define RT_BF_MAKE(a_FieldNm, a_uFieldValue) ( ((a_uFieldValue) & RT_BF_ZMASK(a_FieldNm) ) << RT_CONCAT(a_FieldNm,_SHIFT) )
1853
1854/** @def RT_BF_ZMASK
1855 * Helper for getting the field mask shifted to bit position zero.
1856 *
1857 * @param a_FieldNm The field name prefix for getting at the _SHIFT and
1858 * _MASK macros.
1859 * @sa #RT_BF_GET, #RT_BF_SET, #RT_BF_CLEAR, #RT_BF_MAKE
1860 */
1861#define RT_BF_ZMASK(a_FieldNm) ( RT_CONCAT(a_FieldNm,_MASK) >> RT_CONCAT(a_FieldNm,_SHIFT) )
1862
1863/** Bit field compile time check helper
1864 * @internal */
1865#define RT_BF_CHECK_DO_XOR_MASK(a_uLeft, a_RightPrefix, a_FieldNm) ((a_uLeft) ^ RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK))
1866/** Bit field compile time check helper
1867 * @internal */
1868#define RT_BF_CHECK_DO_OR_MASK(a_uLeft, a_RightPrefix, a_FieldNm) ((a_uLeft) | RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK))
1869/** Bit field compile time check helper
1870 * @internal */
1871#define RT_BF_CHECK_DO_1ST_MASK_BIT(a_uLeft, a_RightPrefix, a_FieldNm) \
1872 ((a_uLeft) && ( (RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK) >> RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT)) & 1U ) )
1873/** Used to check that a bit field mask does not start too early.
1874 * @internal */
1875#define RT_BF_CHECK_DO_MASK_START(a_uLeft, a_RightPrefix, a_FieldNm) \
1876 ( (a_uLeft) \
1877 && ( RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT) == 0 \
1878 || ( ( ( ((RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK) >> RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT)) & 1U) \
1879 << RT_CONCAT3(a_RightPrefix, a_FieldNm, _SHIFT)) /* => single bit mask, correct type */ \
1880 - 1U) /* => mask of all bits below the field */ \
1881 & RT_CONCAT3(a_RightPrefix, a_FieldNm, _MASK)) == 0 ) )
1882/** @name Bit field compile time check recursion workers.
1883 * @internal
1884 * @{ */
1885#define RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix, f1) \
1886 a_DoThis(a_uLeft, a_RightPrefix, f1)
1887#define RT_BF_CHECK_DO_2(a_DoThis, a_uLeft, a_RightPrefix, f1, f2) \
1888 RT_BF_CHECK_DO_1(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2)
1889#define RT_BF_CHECK_DO_3(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3) \
1890 RT_BF_CHECK_DO_2(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3)
1891#define RT_BF_CHECK_DO_4(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4) \
1892 RT_BF_CHECK_DO_3(a_DoThis, RT_BF_CHECK_DO_1(a_DoThis, a_uLeft, a_RightPrefix,f1), a_RightPrefix, f2, f3, f4)
1893#define RT_BF_CHECK_DO_5(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5) \
1894 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)
1895#define RT_BF_CHECK_DO_6(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6) \
1896 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)
1897#define RT_BF_CHECK_DO_7(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7) \
1898 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)
1899#define RT_BF_CHECK_DO_8(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8) \
1900 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)
1901#define RT_BF_CHECK_DO_9(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9) \
1902 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)
1903#define RT_BF_CHECK_DO_10(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10) \
1904 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)
1905#define RT_BF_CHECK_DO_11(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11) \
1906 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)
1907#define RT_BF_CHECK_DO_12(a_DoThis, a_uLeft, a_RightPrefix, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12) \
1908 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)
1909#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) \
1910 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)
1911#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) \
1912 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)
1913#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) \
1914 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)
1915#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) \
1916 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)
1917#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) \
1918 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)
1919#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) \
1920 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)
1921#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) \
1922 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)
1923#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) \
1924 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)
1925#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) \
1926 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)
1927#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) \
1928 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)
1929#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) \
1930 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)
1931#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) \
1932 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)
1933#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) \
1934 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)
1935#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) \
1936 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)
1937#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) \
1938 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)
1939#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) \
1940 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)
1941#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) \
1942 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)
1943#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) \
1944 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)
1945#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) \
1946 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)
1947#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) \
1948 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)
1949#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) \
1950 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)
1951#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) \
1952 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)
1953#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) \
1954 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)
1955#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) \
1956 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)
1957#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) \
1958 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)
1959#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) \
1960 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)
1961#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) \
1962 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)
1963#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) \
1964 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)
1965#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) \
1966 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)
1967#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) \
1968 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)
1969#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) \
1970 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)
1971#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) \
1972 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)
1973#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) \
1974 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)
1975#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) \
1976 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)
1977#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) \
1978 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)
1979#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) \
1980 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)
1981#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) \
1982 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)
1983#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) \
1984 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)
1985#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) \
1986 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)
1987#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) \
1988 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)
1989#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) \
1990 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)
1991#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) \
1992 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)
1993#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) \
1994 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)
1995#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) \
1996 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)
1997#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) \
1998 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)
1999#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) \
2000 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)
2001#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) \
2002 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)
2003#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) \
2004 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)
2005#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) \
2006 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)
2007#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) \
2008 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)
2009#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) \
2010 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)
2011#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) \
2012 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)
2013/** @} */
2014
2015/** @def RT_BF_ASSERT_COMPILE_CHECKS
2016 * Emits a series of AssertCompile statements checking that the bit-field
2017 * declarations doesn't overlap, has holes, and generally makes some sense.
2018 *
2019 * This requires variadic macros because its too much to type otherwise.
2020 */
2021#if defined(RT_COMPILER_SUPPORTS_VA_ARGS) || defined(DOXYGEN_RUNNING)
2022# define RT_BF_ASSERT_COMPILE_CHECKS(a_Prefix, a_uZero, a_uCovered, a_Fields) \
2023 AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_OR_MASK, a_uZero, a_Prefix, RT_UNPACK_ARGS a_Fields ) == a_uCovered); \
2024 AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_XOR_MASK, a_uCovered, a_Prefix, RT_UNPACK_ARGS a_Fields ) == 0); \
2025 AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_1ST_MASK_BIT, true, a_Prefix, RT_UNPACK_ARGS a_Fields ) == true); \
2026 AssertCompile(RT_BF_CHECK_DO_N(RT_BF_CHECK_DO_MASK_START, true, a_Prefix, RT_UNPACK_ARGS a_Fields ) == true)
2027/** Bit field compile time check helper
2028 * @internal */
2029# define RT_BF_CHECK_DO_N(a_DoThis, a_uLeft, a_RightPrefix, ...) \
2030 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__))
2031#else
2032# define RT_BF_ASSERT_COMPILE_CHECKS(a_Prefix, a_uZero, a_uCovered, a_Fields) AssertCompile(true)
2033#endif
2034
2035
2036/** @def RT_ALIGN
2037 * Align macro.
2038 * @param u Value to align.
2039 * @param uAlignment The alignment. Power of two!
2040 *
2041 * @remark Be extremely careful when using this macro with type which sizeof != sizeof int.
2042 * When possible use any of the other RT_ALIGN_* macros. And when that's not
2043 * possible, make 101% sure that uAlignment is specified with a right sized type.
2044 *
2045 * Specifying an unsigned 32-bit alignment constant with a 64-bit value will give
2046 * you a 32-bit return value!
2047 *
2048 * In short: Don't use this macro. Use RT_ALIGN_T() instead.
2049 */
2050#define RT_ALIGN(u, uAlignment) ( ((u) + ((uAlignment) - 1)) & ~((uAlignment) - 1) )
2051
2052/** @def RT_ALIGN_T
2053 * Align macro.
2054 * @param u Value to align.
2055 * @param uAlignment The alignment. Power of two!
2056 * @param type Integer type to use while aligning.
2057 * @remark This macro is the preferred alignment macro, it doesn't have any of the pitfalls RT_ALIGN has.
2058 */
2059#define RT_ALIGN_T(u, uAlignment, type) ( ((type)(u) + ((uAlignment) - 1)) & ~(type)((uAlignment) - 1) )
2060
2061/** @def RT_ALIGN_32
2062 * Align macro for a 32-bit value.
2063 * @param u32 Value to align.
2064 * @param uAlignment The alignment. Power of two!
2065 */
2066#define RT_ALIGN_32(u32, uAlignment) RT_ALIGN_T(u32, uAlignment, uint32_t)
2067
2068/** @def RT_ALIGN_64
2069 * Align macro for a 64-bit value.
2070 * @param u64 Value to align.
2071 * @param uAlignment The alignment. Power of two!
2072 */
2073#define RT_ALIGN_64(u64, uAlignment) RT_ALIGN_T(u64, uAlignment, uint64_t)
2074
2075/** @def RT_ALIGN_Z
2076 * Align macro for size_t.
2077 * @param cb Value to align.
2078 * @param uAlignment The alignment. Power of two!
2079 */
2080#define RT_ALIGN_Z(cb, uAlignment) RT_ALIGN_T(cb, uAlignment, size_t)
2081
2082/** @def RT_ALIGN_P
2083 * Align macro for pointers.
2084 * @param pv Value to align.
2085 * @param uAlignment The alignment. Power of two!
2086 */
2087#define RT_ALIGN_P(pv, uAlignment) RT_ALIGN_PT(pv, uAlignment, void *)
2088
2089/** @def RT_ALIGN_PT
2090 * Align macro for pointers with type cast.
2091 * @param u Value to align.
2092 * @param uAlignment The alignment. Power of two!
2093 * @param CastType The type to cast the result to.
2094 */
2095#define RT_ALIGN_PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, uintptr_t) )
2096
2097/** @def RT_ALIGN_R3PT
2098 * Align macro for ring-3 pointers with type cast.
2099 * @param u Value to align.
2100 * @param uAlignment The alignment. Power of two!
2101 * @param CastType The type to cast the result to.
2102 */
2103#define RT_ALIGN_R3PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR3UINTPTR) )
2104
2105/** @def RT_ALIGN_R0PT
2106 * Align macro for ring-0 pointers with type cast.
2107 * @param u Value to align.
2108 * @param uAlignment The alignment. Power of two!
2109 * @param CastType The type to cast the result to.
2110 */
2111#define RT_ALIGN_R0PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR0UINTPTR) )
2112
2113/** @def RT_ALIGN_GCPT
2114 * Align macro for GC pointers with type cast.
2115 * @param u Value to align.
2116 * @param uAlignment The alignment. Power of two!
2117 * @param CastType The type to cast the result to.
2118 */
2119#define RT_ALIGN_GCPT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTGCUINTPTR) )
2120
2121
2122/** @def RT_OFFSETOF
2123 * Our own special offsetof() variant, returns a signed result.
2124 *
2125 * This differs from the usual offsetof() in that it's not relying on builtin
2126 * compiler stuff and thus can use variables in arrays the structure may
2127 * contain. This is useful to determine the sizes of structures ending
2128 * with a variable length field. For gcc >= 4.4 see @bugref{7775}.
2129 *
2130 * @returns offset into the structure of the specified member. signed.
2131 * @param type Structure type.
2132 * @param member Member.
2133 */
2134#if defined(__cplusplus) && RT_GNUC_PREREQ(4, 4)
2135# define RT_OFFSETOF(type, member) ( (int)(uintptr_t)&( ((type *)(void *)0x1000)->member) - 0x1000 )
2136#else
2137# define RT_OFFSETOF(type, member) ( (int)(uintptr_t)&( ((type *)(void *)0)->member) )
2138#endif
2139
2140/** @def RT_UOFFSETOF
2141 * Our own special offsetof() variant, returns an unsigned result.
2142 *
2143 * This differs from the usual offsetof() in that it's not relying on builtin
2144 * compiler stuff and thus can use variables in arrays the structure may
2145 * contain. This is useful to determine the sizes of structures ending
2146 * with a variable length field. For gcc >= 4.4 see @bugref{7775}.
2147 *
2148 * @returns offset into the structure of the specified member. unsigned.
2149 * @param type Structure type.
2150 * @param member Member.
2151 */
2152#if defined(__cplusplus) && RT_GNUC_PREREQ(4, 4)
2153# define RT_UOFFSETOF(type, member) ( (uintptr_t)&( ((type *)(void *)0x1000)->member) - 0x1000 )
2154#else
2155# define RT_UOFFSETOF(type, member) ( (uintptr_t)&( ((type *)(void *)0)->member) )
2156#endif
2157
2158/** @def RT_OFFSETOF_ADD
2159 * RT_OFFSETOF with an addend.
2160 *
2161 * @returns offset into the structure of the specified member. signed.
2162 * @param type Structure type.
2163 * @param member Member.
2164 * @param addend The addend to add to the offset.
2165 */
2166#define RT_OFFSETOF_ADD(type, member, addend) ( (int)RT_UOFFSETOF_ADD(type, member, addend) )
2167
2168/** @def RT_UOFFSETOF_ADD
2169 * RT_UOFFSETOF with an addend.
2170 *
2171 * @returns offset into the structure of the specified member. signed.
2172 * @param type Structure type.
2173 * @param member Member.
2174 * @param addend The addend to add to the offset.
2175 */
2176#define RT_UOFFSETOF_ADD(type, member, addend) ( (uintptr_t)&( ((type *)(void *)(uintptr_t)(addend))->member) )
2177
2178/** @def RT_SIZEOFMEMB
2179 * Get the size of a structure member.
2180 *
2181 * @returns size of the structure member.
2182 * @param type Structure type.
2183 * @param member Member.
2184 */
2185#define RT_SIZEOFMEMB(type, member) ( sizeof(((type *)(void *)0)->member) )
2186
2187/** @def RT_FROM_MEMBER
2188 * Convert a pointer to a structure member into a pointer to the structure.
2189 *
2190 * @returns pointer to the structure.
2191 * @param pMem Pointer to the member.
2192 * @param Type Structure type.
2193 * @param Member Member name.
2194 */
2195#define RT_FROM_MEMBER(pMem, Type, Member) ( (Type *) ((uint8_t *)(void *)(pMem) - RT_UOFFSETOF(Type, Member)) )
2196
2197/** @def RT_FROM_CPP_MEMBER
2198 * Same as RT_FROM_MEMBER except it avoids the annoying g++ warnings about
2199 * invalid access to non-static data member of NULL object.
2200 *
2201 * @returns pointer to the structure.
2202 * @param pMem Pointer to the member.
2203 * @param Type Structure type.
2204 * @param Member Member name.
2205 *
2206 * @remarks Using the __builtin_offsetof does not shut up the compiler.
2207 */
2208#if defined(__GNUC__) && defined(__cplusplus)
2209# define RT_FROM_CPP_MEMBER(pMem, Type, Member) \
2210 ( (Type *) ((uintptr_t)(pMem) - (uintptr_t)&((Type *)0x1000)->Member + 0x1000U) )
2211#else
2212# define RT_FROM_CPP_MEMBER(pMem, Type, Member) RT_FROM_MEMBER(pMem, Type, Member)
2213#endif
2214
2215/** @def RT_ELEMENTS
2216 * Calculates the number of elements in a statically sized array.
2217 * @returns Element count.
2218 * @param aArray Array in question.
2219 */
2220#define RT_ELEMENTS(aArray) ( sizeof(aArray) / sizeof((aArray)[0]) )
2221
2222/**
2223 * Checks if the value is a power of two.
2224 *
2225 * @returns true if power of two, false if not.
2226 * @param uVal The value to test.
2227 * @remarks 0 is a power of two.
2228 * @see VERR_NOT_POWER_OF_TWO
2229 */
2230#define RT_IS_POWER_OF_TWO(uVal) ( ((uVal) & ((uVal) - 1)) == 0)
2231
2232#ifdef RT_OS_OS2
2233/* Undefine RT_MAX since there is an unfortunate clash with the max
2234 resource type define in os2.h. */
2235# undef RT_MAX
2236#endif
2237
2238/** @def RT_MAX
2239 * Finds the maximum value.
2240 * @returns The higher of the two.
2241 * @param Value1 Value 1
2242 * @param Value2 Value 2
2243 */
2244#define RT_MAX(Value1, Value2) ( (Value1) >= (Value2) ? (Value1) : (Value2) )
2245
2246/** @def RT_MIN
2247 * Finds the minimum value.
2248 * @returns The lower of the two.
2249 * @param Value1 Value 1
2250 * @param Value2 Value 2
2251 */
2252#define RT_MIN(Value1, Value2) ( (Value1) <= (Value2) ? (Value1) : (Value2) )
2253
2254/** @def RT_CLAMP
2255 * Clamps the value to minimum and maximum values.
2256 * @returns The clamped value.
2257 * @param Value The value to check.
2258 * @param Min Minimum value.
2259 * @param Max Maximum value.
2260 */
2261#define RT_CLAMP(Value, Min, Max) ( (Value) > (Max) ? (Max) : (Value) < (Min) ? (Min) : (Value) )
2262
2263/** @def RT_ABS
2264 * Get the absolute (non-negative) value.
2265 * @returns The absolute value of Value.
2266 * @param Value The value.
2267 */
2268#define RT_ABS(Value) ( (Value) >= 0 ? (Value) : -(Value) )
2269
2270/** @def RT_BOOL
2271 * Turn non-zero/zero into true/false
2272 * @returns The resulting boolean value.
2273 * @param Value The value.
2274 */
2275#define RT_BOOL(Value) ( !!(Value) )
2276
2277/** @def RT_LO_U8
2278 * Gets the low uint8_t of a uint16_t or something equivalent. */
2279#ifdef __GNUC__
2280# define RT_LO_U8(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint16_t)); (uint8_t)(a); })
2281#elif defined(_MSC_VER) /* shut up cast truncates constant value warnings */
2282# define RT_LO_U8(a) ( (uint8_t)(UINT8_MAX & (a)) )
2283#else
2284# define RT_LO_U8(a) ( (uint8_t)(a) )
2285#endif
2286/** @def RT_HI_U8
2287 * Gets the high uint8_t of a uint16_t or something equivalent. */
2288#ifdef __GNUC__
2289# define RT_HI_U8(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint16_t)); (uint8_t)((a) >> 8); })
2290#else
2291# define RT_HI_U8(a) ( (uint8_t)((a) >> 8) )
2292#endif
2293
2294/** @def RT_LO_U16
2295 * Gets the low uint16_t of a uint32_t or something equivalent. */
2296#ifdef __GNUC__
2297# define RT_LO_U16(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint32_t)); (uint16_t)(a); })
2298#elif defined(_MSC_VER) /* shut up cast truncates constant value warnings */
2299# define RT_LO_U16(a) ( (uint16_t)(UINT16_MAX & (a)) )
2300#else
2301# define RT_LO_U16(a) ( (uint16_t)(a) )
2302#endif
2303/** @def RT_HI_U16
2304 * Gets the high uint16_t of a uint32_t or something equivalent. */
2305#ifdef __GNUC__
2306# define RT_HI_U16(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint32_t)); (uint16_t)((a) >> 16); })
2307#else
2308# define RT_HI_U16(a) ( (uint16_t)((a) >> 16) )
2309#endif
2310
2311/** @def RT_LO_U32
2312 * Gets the low uint32_t of a uint64_t or something equivalent. */
2313#ifdef __GNUC__
2314# define RT_LO_U32(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)(a); })
2315#elif defined(_MSC_VER) /* shut up cast truncates constant value warnings */
2316# define RT_LO_U32(a) ( (uint32_t)(UINT32_MAX & (a)) )
2317#else
2318# define RT_LO_U32(a) ( (uint32_t)(a) )
2319#endif
2320/** @def RT_HI_U32
2321 * Gets the high uint32_t of a uint64_t or something equivalent. */
2322#ifdef __GNUC__
2323# define RT_HI_U32(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)((a) >> 32); })
2324#else
2325# define RT_HI_U32(a) ( (uint32_t)((a) >> 32) )
2326#endif
2327
2328/** @def RT_BYTE1
2329 * Gets the first byte of something. */
2330#define RT_BYTE1(a) ( (a) & 0xff )
2331/** @def RT_BYTE2
2332 * Gets the second byte of something. */
2333#define RT_BYTE2(a) ( ((a) >> 8) & 0xff )
2334/** @def RT_BYTE3
2335 * Gets the second byte of something. */
2336#define RT_BYTE3(a) ( ((a) >> 16) & 0xff )
2337/** @def RT_BYTE4
2338 * Gets the fourth byte of something. */
2339#define RT_BYTE4(a) ( ((a) >> 24) & 0xff )
2340/** @def RT_BYTE5
2341 * Gets the fifth byte of something. */
2342#define RT_BYTE5(a) ( ((a) >> 32) & 0xff )
2343/** @def RT_BYTE6
2344 * Gets the sixth byte of something. */
2345#define RT_BYTE6(a) ( ((a) >> 40) & 0xff )
2346/** @def RT_BYTE7
2347 * Gets the seventh byte of something. */
2348#define RT_BYTE7(a) ( ((a) >> 48) & 0xff )
2349/** @def RT_BYTE8
2350 * Gets the eight byte of something. */
2351#define RT_BYTE8(a) ( ((a) >> 56) & 0xff )
2352
2353
2354/** @def RT_LODWORD
2355 * Gets the low dword (=uint32_t) of something.
2356 * @deprecated Use RT_LO_U32. */
2357#define RT_LODWORD(a) ( (uint32_t)(a) )
2358/** @def RT_HIDWORD
2359 * Gets the high dword (=uint32_t) of a 64-bit of something.
2360 * @deprecated Use RT_HI_U32. */
2361#define RT_HIDWORD(a) ( (uint32_t)((a) >> 32) )
2362
2363/** @def RT_LOWORD
2364 * Gets the low word (=uint16_t) of something.
2365 * @deprecated Use RT_LO_U16. */
2366#define RT_LOWORD(a) ( (a) & 0xffff )
2367/** @def RT_HIWORD
2368 * Gets the high word (=uint16_t) of a 32-bit something.
2369 * @deprecated Use RT_HI_U16. */
2370#define RT_HIWORD(a) ( (a) >> 16 )
2371
2372/** @def RT_LOBYTE
2373 * Gets the low byte of something.
2374 * @deprecated Use RT_LO_U8. */
2375#define RT_LOBYTE(a) ( (a) & 0xff )
2376/** @def RT_HIBYTE
2377 * Gets the high byte of a 16-bit something.
2378 * @deprecated Use RT_HI_U8. */
2379#define RT_HIBYTE(a) ( (a) >> 8 )
2380
2381
2382/** @def RT_MAKE_U64
2383 * Constructs a uint64_t value from two uint32_t values.
2384 */
2385#define RT_MAKE_U64(Lo, Hi) ( (uint64_t)((uint32_t)(Hi)) << 32 | (uint32_t)(Lo) )
2386
2387/** @def RT_MAKE_U64_FROM_U16
2388 * Constructs a uint64_t value from four uint16_t values.
2389 */
2390#define RT_MAKE_U64_FROM_U16(w0, w1, w2, w3) \
2391 ((uint64_t)( (uint64_t)((uint16_t)(w3)) << 48 \
2392 | (uint64_t)((uint16_t)(w2)) << 32 \
2393 | (uint32_t)((uint16_t)(w1)) << 16 \
2394 | (uint16_t)(w0) ))
2395
2396/** @def RT_MAKE_U64_FROM_U8
2397 * Constructs a uint64_t value from eight uint8_t values.
2398 */
2399#define RT_MAKE_U64_FROM_U8(b0, b1, b2, b3, b4, b5, b6, b7) \
2400 ((uint64_t)( (uint64_t)((uint8_t)(b7)) << 56 \
2401 | (uint64_t)((uint8_t)(b6)) << 48 \
2402 | (uint64_t)((uint8_t)(b5)) << 40 \
2403 | (uint64_t)((uint8_t)(b4)) << 32 \
2404 | (uint32_t)((uint8_t)(b3)) << 24 \
2405 | (uint32_t)((uint8_t)(b2)) << 16 \
2406 | (uint16_t)((uint8_t)(b1)) << 8 \
2407 | (uint8_t)(b0) ))
2408
2409/** @def RT_MAKE_U32
2410 * Constructs a uint32_t value from two uint16_t values.
2411 */
2412#define RT_MAKE_U32(Lo, Hi) \
2413 ((uint32_t)( (uint32_t)((uint16_t)(Hi)) << 16 \
2414 | (uint16_t)(Lo) ))
2415
2416/** @def RT_MAKE_U32_FROM_U8
2417 * Constructs a uint32_t value from four uint8_t values.
2418 */
2419#define RT_MAKE_U32_FROM_U8(b0, b1, b2, b3) \
2420 ((uint32_t)( (uint32_t)((uint8_t)(b3)) << 24 \
2421 | (uint32_t)((uint8_t)(b2)) << 16 \
2422 | (uint16_t)((uint8_t)(b1)) << 8 \
2423 | (uint8_t)(b0) ))
2424
2425/** @def RT_MAKE_U16
2426 * Constructs a uint16_t value from two uint8_t values.
2427 */
2428#define RT_MAKE_U16(Lo, Hi) \
2429 ((uint16_t)( (uint16_t)((uint8_t)(Hi)) << 8 \
2430 | (uint8_t)(Lo) ))
2431
2432
2433/** @def RT_BSWAP_U64
2434 * Reverses the byte order of an uint64_t value. */
2435#if 0
2436# define RT_BSWAP_U64(u64) RT_BSWAP_U64_C(u64)
2437#elif defined(__GNUC__)
2438# define RT_BSWAP_U64(u64) (__builtin_constant_p((u64)) \
2439 ? RT_BSWAP_U64_C(u64) : ASMByteSwapU64(u64))
2440#else
2441# define RT_BSWAP_U64(u64) ASMByteSwapU64(u64)
2442#endif
2443
2444/** @def RT_BSWAP_U32
2445 * Reverses the byte order of an uint32_t value. */
2446#if 0
2447# define RT_BSWAP_U32(u32) RT_BSWAP_U32_C(u32)
2448#elif defined(__GNUC__)
2449# define RT_BSWAP_U32(u32) (__builtin_constant_p((u32)) \
2450 ? RT_BSWAP_U32_C(u32) : ASMByteSwapU32(u32))
2451#else
2452# define RT_BSWAP_U32(u32) ASMByteSwapU32(u32)
2453#endif
2454
2455/** @def RT_BSWAP_U16
2456 * Reverses the byte order of an uint16_t value. */
2457#if 0
2458# define RT_BSWAP_U16(u16) RT_BSWAP_U16_C(u16)
2459#elif defined(__GNUC__)
2460# define RT_BSWAP_U16(u16) (__builtin_constant_p((u16)) \
2461 ? RT_BSWAP_U16_C(u16) : ASMByteSwapU16(u16))
2462#else
2463# define RT_BSWAP_U16(u16) ASMByteSwapU16(u16)
2464#endif
2465
2466
2467/** @def RT_BSWAP_U64_C
2468 * Reverses the byte order of an uint64_t constant. */
2469#define RT_BSWAP_U64_C(u64) RT_MAKE_U64(RT_BSWAP_U32_C((u64) >> 32), RT_BSWAP_U32_C((u64) & 0xffffffff))
2470
2471/** @def RT_BSWAP_U32_C
2472 * Reverses the byte order of an uint32_t constant. */
2473#define RT_BSWAP_U32_C(u32) RT_MAKE_U32_FROM_U8(RT_BYTE4(u32), RT_BYTE3(u32), RT_BYTE2(u32), RT_BYTE1(u32))
2474
2475/** @def RT_BSWAP_U16_C
2476 * Reverses the byte order of an uint16_t constant. */
2477#define RT_BSWAP_U16_C(u16) RT_MAKE_U16(RT_HIBYTE(u16), RT_LOBYTE(u16))
2478
2479
2480/** @def RT_H2LE_U64
2481 * Converts an uint64_t value from host to little endian byte order. */
2482#ifdef RT_BIG_ENDIAN
2483# define RT_H2LE_U64(u64) RT_BSWAP_U64(u64)
2484#else
2485# define RT_H2LE_U64(u64) (u64)
2486#endif
2487
2488/** @def RT_H2LE_U64_C
2489 * Converts an uint64_t constant from host to little endian byte order. */
2490#ifdef RT_BIG_ENDIAN
2491# define RT_H2LE_U64_C(u64) RT_BSWAP_U64_C(u64)
2492#else
2493# define RT_H2LE_U64_C(u64) (u64)
2494#endif
2495
2496/** @def RT_H2LE_U32
2497 * Converts an uint32_t value from host to little endian byte order. */
2498#ifdef RT_BIG_ENDIAN
2499# define RT_H2LE_U32(u32) RT_BSWAP_U32(u32)
2500#else
2501# define RT_H2LE_U32(u32) (u32)
2502#endif
2503
2504/** @def RT_H2LE_U32_C
2505 * Converts an uint32_t constant from host to little endian byte order. */
2506#ifdef RT_BIG_ENDIAN
2507# define RT_H2LE_U32_C(u32) RT_BSWAP_U32_C(u32)
2508#else
2509# define RT_H2LE_U32_C(u32) (u32)
2510#endif
2511
2512/** @def RT_H2LE_U16
2513 * Converts an uint16_t value from host to little endian byte order. */
2514#ifdef RT_BIG_ENDIAN
2515# define RT_H2LE_U16(u16) RT_BSWAP_U16(u16)
2516#else
2517# define RT_H2LE_U16(u16) (u16)
2518#endif
2519
2520/** @def RT_H2LE_U16_C
2521 * Converts an uint16_t constant from host to little endian byte order. */
2522#ifdef RT_BIG_ENDIAN
2523# define RT_H2LE_U16_C(u16) RT_BSWAP_U16_C(u16)
2524#else
2525# define RT_H2LE_U16_C(u16) (u16)
2526#endif
2527
2528
2529/** @def RT_LE2H_U64
2530 * Converts an uint64_t value from little endian to host byte order. */
2531#ifdef RT_BIG_ENDIAN
2532# define RT_LE2H_U64(u64) RT_BSWAP_U64(u64)
2533#else
2534# define RT_LE2H_U64(u64) (u64)
2535#endif
2536
2537/** @def RT_LE2H_U64_C
2538 * Converts an uint64_t constant from little endian to host byte order. */
2539#ifdef RT_BIG_ENDIAN
2540# define RT_LE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
2541#else
2542# define RT_LE2H_U64_C(u64) (u64)
2543#endif
2544
2545/** @def RT_LE2H_U32
2546 * Converts an uint32_t value from little endian to host byte order. */
2547#ifdef RT_BIG_ENDIAN
2548# define RT_LE2H_U32(u32) RT_BSWAP_U32(u32)
2549#else
2550# define RT_LE2H_U32(u32) (u32)
2551#endif
2552
2553/** @def RT_LE2H_U32_C
2554 * Converts an uint32_t constant from little endian to host byte order. */
2555#ifdef RT_BIG_ENDIAN
2556# define RT_LE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
2557#else
2558# define RT_LE2H_U32_C(u32) (u32)
2559#endif
2560
2561/** @def RT_LE2H_U16
2562 * Converts an uint16_t value from little endian to host byte order. */
2563#ifdef RT_BIG_ENDIAN
2564# define RT_LE2H_U16(u16) RT_BSWAP_U16(u16)
2565#else
2566# define RT_LE2H_U16(u16) (u16)
2567#endif
2568
2569/** @def RT_LE2H_U16_C
2570 * Converts an uint16_t constant from little endian to host byte order. */
2571#ifdef RT_BIG_ENDIAN
2572# define RT_LE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
2573#else
2574# define RT_LE2H_U16_C(u16) (u16)
2575#endif
2576
2577
2578/** @def RT_H2BE_U64
2579 * Converts an uint64_t value from host to big endian byte order. */
2580#ifdef RT_BIG_ENDIAN
2581# define RT_H2BE_U64(u64) (u64)
2582#else
2583# define RT_H2BE_U64(u64) RT_BSWAP_U64(u64)
2584#endif
2585
2586/** @def RT_H2BE_U64_C
2587 * Converts an uint64_t constant from host to big endian byte order. */
2588#ifdef RT_BIG_ENDIAN
2589# define RT_H2BE_U64_C(u64) (u64)
2590#else
2591# define RT_H2BE_U64_C(u64) RT_BSWAP_U64_C(u64)
2592#endif
2593
2594/** @def RT_H2BE_U32
2595 * Converts an uint32_t value from host to big endian byte order. */
2596#ifdef RT_BIG_ENDIAN
2597# define RT_H2BE_U32(u32) (u32)
2598#else
2599# define RT_H2BE_U32(u32) RT_BSWAP_U32(u32)
2600#endif
2601
2602/** @def RT_H2BE_U32_C
2603 * Converts an uint32_t constant from host to big endian byte order. */
2604#ifdef RT_BIG_ENDIAN
2605# define RT_H2BE_U32_C(u32) (u32)
2606#else
2607# define RT_H2BE_U32_C(u32) RT_BSWAP_U32_C(u32)
2608#endif
2609
2610/** @def RT_H2BE_U16
2611 * Converts an uint16_t value from host to big endian byte order. */
2612#ifdef RT_BIG_ENDIAN
2613# define RT_H2BE_U16(u16) (u16)
2614#else
2615# define RT_H2BE_U16(u16) RT_BSWAP_U16(u16)
2616#endif
2617
2618/** @def RT_H2BE_U16_C
2619 * Converts an uint16_t constant from host to big endian byte order. */
2620#ifdef RT_BIG_ENDIAN
2621# define RT_H2BE_U16_C(u16) (u16)
2622#else
2623# define RT_H2BE_U16_C(u16) RT_BSWAP_U16_C(u16)
2624#endif
2625
2626/** @def RT_BE2H_U64
2627 * Converts an uint64_t value from big endian to host byte order. */
2628#ifdef RT_BIG_ENDIAN
2629# define RT_BE2H_U64(u64) (u64)
2630#else
2631# define RT_BE2H_U64(u64) RT_BSWAP_U64(u64)
2632#endif
2633
2634/** @def RT_BE2H_U64
2635 * Converts an uint64_t constant from big endian to host byte order. */
2636#ifdef RT_BIG_ENDIAN
2637# define RT_BE2H_U64_C(u64) (u64)
2638#else
2639# define RT_BE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
2640#endif
2641
2642/** @def RT_BE2H_U32
2643 * Converts an uint32_t value from big endian to host byte order. */
2644#ifdef RT_BIG_ENDIAN
2645# define RT_BE2H_U32(u32) (u32)
2646#else
2647# define RT_BE2H_U32(u32) RT_BSWAP_U32(u32)
2648#endif
2649
2650/** @def RT_BE2H_U32_C
2651 * Converts an uint32_t value from big endian to host byte order. */
2652#ifdef RT_BIG_ENDIAN
2653# define RT_BE2H_U32_C(u32) (u32)
2654#else
2655# define RT_BE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
2656#endif
2657
2658/** @def RT_BE2H_U16
2659 * Converts an uint16_t value from big endian to host byte order. */
2660#ifdef RT_BIG_ENDIAN
2661# define RT_BE2H_U16(u16) (u16)
2662#else
2663# define RT_BE2H_U16(u16) RT_BSWAP_U16(u16)
2664#endif
2665
2666/** @def RT_BE2H_U16_C
2667 * Converts an uint16_t constant from big endian to host byte order. */
2668#ifdef RT_BIG_ENDIAN
2669# define RT_BE2H_U16_C(u16) (u16)
2670#else
2671# define RT_BE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
2672#endif
2673
2674
2675/** @def RT_H2N_U64
2676 * Converts an uint64_t value from host to network byte order. */
2677#define RT_H2N_U64(u64) RT_H2BE_U64(u64)
2678
2679/** @def RT_H2N_U64_C
2680 * Converts an uint64_t constant from host to network byte order. */
2681#define RT_H2N_U64_C(u64) RT_H2BE_U64_C(u64)
2682
2683/** @def RT_H2N_U32
2684 * Converts an uint32_t value from host to network byte order. */
2685#define RT_H2N_U32(u32) RT_H2BE_U32(u32)
2686
2687/** @def RT_H2N_U32_C
2688 * Converts an uint32_t constant from host to network byte order. */
2689#define RT_H2N_U32_C(u32) RT_H2BE_U32_C(u32)
2690
2691/** @def RT_H2N_U16
2692 * Converts an uint16_t value from host to network byte order. */
2693#define RT_H2N_U16(u16) RT_H2BE_U16(u16)
2694
2695/** @def RT_H2N_U16_C
2696 * Converts an uint16_t constant from host to network byte order. */
2697#define RT_H2N_U16_C(u16) RT_H2BE_U16_C(u16)
2698
2699/** @def RT_N2H_U64
2700 * Converts an uint64_t value from network to host byte order. */
2701#define RT_N2H_U64(u64) RT_BE2H_U64(u64)
2702
2703/** @def RT_N2H_U64_C
2704 * Converts an uint64_t constant from network to host byte order. */
2705#define RT_N2H_U64_C(u64) RT_BE2H_U64_C(u64)
2706
2707/** @def RT_N2H_U32
2708 * Converts an uint32_t value from network to host byte order. */
2709#define RT_N2H_U32(u32) RT_BE2H_U32(u32)
2710
2711/** @def RT_N2H_U32_C
2712 * Converts an uint32_t constant from network to host byte order. */
2713#define RT_N2H_U32_C(u32) RT_BE2H_U32_C(u32)
2714
2715/** @def RT_N2H_U16
2716 * Converts an uint16_t value from network to host byte order. */
2717#define RT_N2H_U16(u16) RT_BE2H_U16(u16)
2718
2719/** @def RT_N2H_U16_C
2720 * Converts an uint16_t value from network to host byte order. */
2721#define RT_N2H_U16_C(u16) RT_BE2H_U16_C(u16)
2722
2723
2724/*
2725 * The BSD sys/param.h + machine/param.h file is a major source of
2726 * namespace pollution. Kill off some of the worse ones unless we're
2727 * compiling kernel code.
2728 */
2729#if defined(RT_OS_DARWIN) \
2730 && !defined(KERNEL) \
2731 && !defined(RT_NO_BSD_PARAM_H_UNDEFING) \
2732 && ( defined(_SYS_PARAM_H_) || defined(_I386_PARAM_H_) )
2733/* sys/param.h: */
2734# undef PSWP
2735# undef PVM
2736# undef PINOD
2737# undef PRIBO
2738# undef PVFS
2739# undef PZERO
2740# undef PSOCK
2741# undef PWAIT
2742# undef PLOCK
2743# undef PPAUSE
2744# undef PUSER
2745# undef PRIMASK
2746# undef MINBUCKET
2747# undef MAXALLOCSAVE
2748# undef FSHIFT
2749# undef FSCALE
2750
2751/* i386/machine.h: */
2752# undef ALIGN
2753# undef ALIGNBYTES
2754# undef DELAY
2755# undef STATUS_WORD
2756# undef USERMODE
2757# undef BASEPRI
2758# undef MSIZE
2759# undef CLSIZE
2760# undef CLSIZELOG2
2761#endif
2762
2763/** @def NIL_OFFSET
2764 * NIL offset.
2765 * Whenever we use offsets instead of pointers to save space and relocation effort
2766 * NIL_OFFSET shall be used as the equivalent to NULL.
2767 */
2768#define NIL_OFFSET (~0U)
2769
2770/** @def NOREF
2771 * Keeps the compiler from bitching about an unused parameter, local variable,
2772 * or other stuff, will never use _Pragma are is thus more flexible.
2773 */
2774#define NOREF(var) (void)(var)
2775
2776/** @def RT_NOREF_PV
2777 * Keeps the compiler from bitching about an unused parameter or local variable.
2778 * This one cannot be used with structure members and such, like for instance
2779 * AssertRC may end up doing due to its generic nature.
2780 */
2781#if defined(__cplusplus) && RT_CLANG_PREREQ(6, 0)
2782# define RT_NOREF_PV(var) _Pragma(RT_STR(unused(var)))
2783#else
2784# define RT_NOREF_PV(var) (void)(var)
2785#endif
2786
2787/** @def RT_BREAKPOINT
2788 * Emit a debug breakpoint instruction.
2789 *
2790 * @remarks In the x86/amd64 gnu world we add a nop instruction after the int3
2791 * to force gdb to remain at the int3 source line.
2792 * @remarks The L4 kernel will try make sense of the breakpoint, thus the jmp on
2793 * x86/amd64.
2794 */
2795#ifdef __GNUC__
2796# if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)
2797# if !defined(__L4ENV__)
2798# define RT_BREAKPOINT() __asm__ __volatile__("int $3\n\tnop\n\t")
2799# else
2800# define RT_BREAKPOINT() __asm__ __volatile__("int3; jmp 1f; 1:\n\t")
2801# endif
2802# elif defined(RT_ARCH_SPARC64)
2803# define RT_BREAKPOINT() __asm__ __volatile__("illtrap 0\n\t") /** @todo Sparc64: this is just a wild guess. */
2804# elif defined(RT_ARCH_SPARC)
2805# define RT_BREAKPOINT() __asm__ __volatile__("unimp 0\n\t") /** @todo Sparc: this is just a wild guess (same as Sparc64, just different name). */
2806# endif
2807#endif
2808#ifdef _MSC_VER
2809# define RT_BREAKPOINT() __debugbreak()
2810#endif
2811#if defined(__IBMC__) || defined(__IBMCPP__)
2812# define RT_BREAKPOINT() __interrupt(3)
2813#endif
2814#if defined(__WATCOMC__)
2815# define RT_BREAKPOINT() _asm { int 3 }
2816#endif
2817#ifndef RT_BREAKPOINT
2818# error "This compiler/arch is not supported!"
2819#endif
2820
2821
2822/** @defgroup grp_rt_cdefs_size Size Constants
2823 * (Of course, these are binary computer terms, not SI.)
2824 * @{
2825 */
2826/** 1 K (Kilo) (1 024). */
2827#define _1K 0x00000400
2828/** 2 K (Kilo) (2 048). */
2829#define _2K 0x00000800
2830/** 4 K (Kilo) (4 096). */
2831#define _4K 0x00001000
2832/** 8 K (Kilo) (8 192). */
2833#define _8K 0x00002000
2834/** 16 K (Kilo) (16 384). */
2835#define _16K 0x00004000
2836/** 32 K (Kilo) (32 678). */
2837#define _32K 0x00008000
2838/** 64 K (Kilo) (65 536). */
2839#if ARCH_BITS != 16
2840# define _64K 0x00010000
2841#else
2842# define _64K UINT32_C(0x00010000)
2843#endif
2844/** 128 K (Kilo) (131 072). */
2845#if ARCH_BITS != 16
2846# define _128K 0x00020000
2847#else
2848# define _128K UINT32_C(0x00020000)
2849#endif
2850/** 256 K (Kilo) (262 144). */
2851#if ARCH_BITS != 16
2852# define _256K 0x00040000
2853#else
2854# define _256K UINT32_C(0x00040000)
2855#endif
2856/** 512 K (Kilo) (524 288). */
2857#if ARCH_BITS != 16
2858# define _512K 0x00080000
2859#else
2860# define _512K UINT32_C(0x00080000)
2861#endif
2862/** 1 M (Mega) (1 048 576). */
2863#if ARCH_BITS != 16
2864# define _1M 0x00100000
2865#else
2866# define _1M UINT32_C(0x00100000)
2867#endif
2868/** 2 M (Mega) (2 097 152). */
2869#if ARCH_BITS != 16
2870# define _2M 0x00200000
2871#else
2872# define _2M UINT32_C(0x00200000)
2873#endif
2874/** 4 M (Mega) (4 194 304). */
2875#if ARCH_BITS != 16
2876# define _4M 0x00400000
2877#else
2878# define _4M UINT32_C(0x00400000)
2879#endif
2880/** 8 M (Mega) (8 388 608). */
2881#define _8M UINT32_C(0x00800000)
2882/** 16 M (Mega) (16 777 216). */
2883#define _16M UINT32_C(0x01000000)
2884/** 32 M (Mega) (33 554 432). */
2885#define _32M UINT32_C(0x02000000)
2886/** 64 M (Mega) (67 108 864). */
2887#define _64M UINT32_C(0x04000000)
2888/** 128 M (Mega) (134 217 728). */
2889#define _128M UINT32_C(0x08000000)
2890/** 256 M (Mega) (268 435 456). */
2891#define _256M UINT32_C(0x10000000)
2892/** 512 M (Mega) (536 870 912). */
2893#define _512M UINT32_C(0x20000000)
2894/** 1 G (Giga) (1 073 741 824). (32-bit) */
2895#if ARCH_BITS != 16
2896# define _1G 0x40000000
2897#else
2898# define _1G UINT32_C(0x40000000)
2899#endif
2900/** 1 G (Giga) (1 073 741 824). (64-bit) */
2901#if ARCH_BITS != 16
2902# define _1G64 0x40000000LL
2903#else
2904# define _1G64 UINT64_C(0x40000000)
2905#endif
2906/** 2 G (Giga) (2 147 483 648). (32-bit) */
2907#define _2G32 UINT32_C(0x80000000)
2908/** 2 G (Giga) (2 147 483 648). (64-bit) */
2909#if ARCH_BITS != 16
2910# define _2G 0x0000000080000000LL
2911#else
2912# define _2G UINT64_C(0x0000000080000000)
2913#endif
2914/** 4 G (Giga) (4 294 967 296). */
2915#if ARCH_BITS != 16
2916# define _4G 0x0000000100000000LL
2917#else
2918# define _4G UINT64_C(0x0000000100000000)
2919#endif
2920/** 1 T (Tera) (1 099 511 627 776). */
2921#if ARCH_BITS != 16
2922# define _1T 0x0000010000000000LL
2923#else
2924# define _1T UINT64_C(0x0000010000000000)
2925#endif
2926/** 1 P (Peta) (1 125 899 906 842 624). */
2927#if ARCH_BITS != 16
2928# define _1P 0x0004000000000000LL
2929#else
2930# define _1P UINT64_C(0x0004000000000000)
2931#endif
2932/** 1 E (Exa) (1 152 921 504 606 846 976). */
2933#if ARCH_BITS != 16
2934# define _1E 0x1000000000000000LL
2935#else
2936# define _1E UINT64_C(0x1000000000000000)
2937#endif
2938/** 2 E (Exa) (2 305 843 009 213 693 952). */
2939#if ARCH_BITS != 16
2940# define _2E 0x2000000000000000ULL
2941#else
2942# define _2E UINT64_C(0x2000000000000000)
2943#endif
2944/** @} */
2945
2946/** @defgroup grp_rt_cdefs_decimal_grouping Decimal Constant Grouping Macros
2947 * @{ */
2948#define RT_D1(g1) g1
2949#define RT_D2(g1, g2) g1#g2
2950#define RT_D3(g1, g2, g3) g1#g2#g3
2951#define RT_D4(g1, g2, g3, g4) g1#g2#g3#g4
2952#define RT_D5(g1, g2, g3, g4, g5) g1#g2#g3#g4#g5
2953#define RT_D6(g1, g2, g3, g4, g5, g6) g1#g2#g3#g4#g5#g6
2954#define RT_D7(g1, g2, g3, g4, g5, g6, g7) g1#g2#g3#g4#g5#g6#g7
2955
2956#define RT_D1_U(g1) UINT32_C(g1)
2957#define RT_D2_U(g1, g2) UINT32_C(g1#g2)
2958#define RT_D3_U(g1, g2, g3) UINT32_C(g1#g2#g3)
2959#define RT_D4_U(g1, g2, g3, g4) UINT64_C(g1#g2#g3#g4)
2960#define RT_D5_U(g1, g2, g3, g4, g5) UINT64_C(g1#g2#g3#g4#g5)
2961#define RT_D6_U(g1, g2, g3, g4, g5, g6) UINT64_C(g1#g2#g3#g4#g5#g6)
2962#define RT_D7_U(g1, g2, g3, g4, g5, g6, g7) UINT64_C(g1#g2#g3#g4#g5#g6#g7)
2963
2964#define RT_D1_S(g1) INT32_C(g1)
2965#define RT_D2_S(g1, g2) INT32_C(g1#g2)
2966#define RT_D3_S(g1, g2, g3) INT32_C(g1#g2#g3)
2967#define RT_D4_S(g1, g2, g3, g4) INT64_C(g1#g2#g3#g4)
2968#define RT_D5_S(g1, g2, g3, g4, g5) INT64_C(g1#g2#g3#g4#g5)
2969#define RT_D6_S(g1, g2, g3, g4, g5, g6) INT64_C(g1#g2#g3#g4#g5#g6)
2970#define RT_D7_S(g1, g2, g3, g4, g5, g6, g7) INT64_C(g1#g2#g3#g4#g5#g6#g7)
2971
2972#define RT_D1_U32(g1) UINT32_C(g1)
2973#define RT_D2_U32(g1, g2) UINT32_C(g1#g2)
2974#define RT_D3_U32(g1, g2, g3) UINT32_C(g1#g2#g3)
2975#define RT_D4_U32(g1, g2, g3, g4) UINT32_C(g1#g2#g3#g4)
2976
2977#define RT_D1_S32(g1) INT32_C(g1)
2978#define RT_D2_S32(g1, g2) INT32_C(g1#g2)
2979#define RT_D3_S32(g1, g2, g3) INT32_C(g1#g2#g3)
2980#define RT_D4_S32(g1, g2, g3, g4) INT32_C(g1#g2#g3#g4)
2981
2982#define RT_D1_U64(g1) UINT64_C(g1)
2983#define RT_D2_U64(g1, g2) UINT64_C(g1#g2)
2984#define RT_D3_U64(g1, g2, g3) UINT64_C(g1#g2#g3)
2985#define RT_D4_U64(g1, g2, g3, g4) UINT64_C(g1#g2#g3#g4)
2986#define RT_D5_U64(g1, g2, g3, g4, g5) UINT64_C(g1#g2#g3#g4#g5)
2987#define RT_D6_U64(g1, g2, g3, g4, g5, g6) UINT64_C(g1#g2#g3#g4#g5#g6)
2988#define RT_D7_U64(g1, g2, g3, g4, g5, g6, g7) UINT64_C(g1#g2#g3#g4#g5#g6#g7)
2989
2990#define RT_D1_S64(g1) INT64_C(g1)
2991#define RT_D2_S64(g1, g2) INT64_C(g1#g2)
2992#define RT_D3_S64(g1, g2, g3) INT64_C(g1#g2#g3)
2993#define RT_D4_S64(g1, g2, g3, g4) INT64_C(g1#g2#g3#g4)
2994#define RT_D5_S64(g1, g2, g3, g4, g5) INT64_C(g1#g2#g3#g4#g5)
2995#define RT_D6_S64(g1, g2, g3, g4, g5, g6) INT64_C(g1#g2#g3#g4#g5#g6)
2996#define RT_D7_S64(g1, g2, g3, g4, g5, g6, g7) INT64_C(g1#g2#g3#g4#g5#g6#g7)
2997/** @} */
2998
2999
3000/** @defgroup grp_rt_cdefs_time Time Constants
3001 * @{
3002 */
3003/** 1 hour expressed in nanoseconds (64-bit). */
3004#define RT_NS_1HOUR UINT64_C(3600000000000)
3005/** 1 minute expressed in nanoseconds (64-bit). */
3006#define RT_NS_1MIN UINT64_C(60000000000)
3007/** 45 second expressed in nanoseconds. */
3008#define RT_NS_45SEC UINT64_C(45000000000)
3009/** 30 second expressed in nanoseconds. */
3010#define RT_NS_30SEC UINT64_C(30000000000)
3011/** 20 second expressed in nanoseconds. */
3012#define RT_NS_20SEC UINT64_C(20000000000)
3013/** 15 second expressed in nanoseconds. */
3014#define RT_NS_15SEC UINT64_C(15000000000)
3015/** 10 second expressed in nanoseconds. */
3016#define RT_NS_10SEC UINT64_C(10000000000)
3017/** 1 second expressed in nanoseconds. */
3018#define RT_NS_1SEC UINT32_C(1000000000)
3019/** 100 millsecond expressed in nanoseconds. */
3020#define RT_NS_100MS UINT32_C(100000000)
3021/** 10 millsecond expressed in nanoseconds. */
3022#define RT_NS_10MS UINT32_C(10000000)
3023/** 1 millsecond expressed in nanoseconds. */
3024#define RT_NS_1MS UINT32_C(1000000)
3025/** 100 microseconds expressed in nanoseconds. */
3026#define RT_NS_100US UINT32_C(100000)
3027/** 10 microseconds expressed in nanoseconds. */
3028#define RT_NS_10US UINT32_C(10000)
3029/** 1 microsecond expressed in nanoseconds. */
3030#define RT_NS_1US UINT32_C(1000)
3031
3032/** 1 second expressed in nanoseconds - 64-bit type. */
3033#define RT_NS_1SEC_64 UINT64_C(1000000000)
3034/** 100 millsecond expressed in nanoseconds - 64-bit type. */
3035#define RT_NS_100MS_64 UINT64_C(100000000)
3036/** 10 millsecond expressed in nanoseconds - 64-bit type. */
3037#define RT_NS_10MS_64 UINT64_C(10000000)
3038/** 1 millsecond expressed in nanoseconds - 64-bit type. */
3039#define RT_NS_1MS_64 UINT64_C(1000000)
3040/** 100 microseconds expressed in nanoseconds - 64-bit type. */
3041#define RT_NS_100US_64 UINT64_C(100000)
3042/** 10 microseconds expressed in nanoseconds - 64-bit type. */
3043#define RT_NS_10US_64 UINT64_C(10000)
3044/** 1 microsecond expressed in nanoseconds - 64-bit type. */
3045#define RT_NS_1US_64 UINT64_C(1000)
3046
3047/** 1 hour expressed in microseconds. */
3048#define RT_US_1HOUR UINT32_C(3600000000)
3049/** 1 minute expressed in microseconds. */
3050#define RT_US_1MIN UINT32_C(60000000)
3051/** 1 second expressed in microseconds. */
3052#define RT_US_1SEC UINT32_C(1000000)
3053/** 100 millsecond expressed in microseconds. */
3054#define RT_US_100MS UINT32_C(100000)
3055/** 10 millsecond expressed in microseconds. */
3056#define RT_US_10MS UINT32_C(10000)
3057/** 1 millsecond expressed in microseconds. */
3058#define RT_US_1MS UINT32_C(1000)
3059
3060/** 1 hour expressed in microseconds - 64-bit type. */
3061#define RT_US_1HOUR_64 UINT64_C(3600000000)
3062/** 1 minute expressed in microseconds - 64-bit type. */
3063#define RT_US_1MIN_64 UINT64_C(60000000)
3064/** 1 second expressed in microseconds - 64-bit type. */
3065#define RT_US_1SEC_64 UINT64_C(1000000)
3066/** 100 millsecond expressed in microseconds - 64-bit type. */
3067#define RT_US_100MS_64 UINT64_C(100000)
3068/** 10 millsecond expressed in microseconds - 64-bit type. */
3069#define RT_US_10MS_64 UINT64_C(10000)
3070/** 1 millsecond expressed in microseconds - 64-bit type. */
3071#define RT_US_1MS_64 UINT64_C(1000)
3072
3073/** 1 hour expressed in milliseconds. */
3074#define RT_MS_1HOUR UINT32_C(3600000)
3075/** 1 minute expressed in milliseconds. */
3076#define RT_MS_1MIN UINT32_C(60000)
3077/** 1 second expressed in milliseconds. */
3078#define RT_MS_1SEC UINT32_C(1000)
3079
3080/** 1 hour expressed in milliseconds - 64-bit type. */
3081#define RT_MS_1HOUR_64 UINT64_C(3600000)
3082/** 1 minute expressed in milliseconds - 64-bit type. */
3083#define RT_MS_1MIN_64 UINT64_C(60000)
3084/** 1 second expressed in milliseconds - 64-bit type. */
3085#define RT_MS_1SEC_64 UINT64_C(1000)
3086
3087/** The number of seconds per week. */
3088#define RT_SEC_1WEEK UINT32_C(604800)
3089/** The number of seconds per day. */
3090#define RT_SEC_1DAY UINT32_C(86400)
3091/** The number of seconds per hour. */
3092#define RT_SEC_1HOUR UINT32_C(3600)
3093
3094/** The number of seconds per week - 64-bit type. */
3095#define RT_SEC_1WEEK_64 UINT64_C(604800)
3096/** The number of seconds per day - 64-bit type. */
3097#define RT_SEC_1DAY_64 UINT64_C(86400)
3098/** The number of seconds per hour - 64-bit type. */
3099#define RT_SEC_1HOUR_64 UINT64_C(3600)
3100/** @} */
3101
3102
3103/** @defgroup grp_rt_cdefs_dbgtype Debug Info Types
3104 * @{ */
3105/** Other format. */
3106#define RT_DBGTYPE_OTHER RT_BIT_32(0)
3107/** Stabs. */
3108#define RT_DBGTYPE_STABS RT_BIT_32(1)
3109/** Debug With Arbitrary Record Format (DWARF). */
3110#define RT_DBGTYPE_DWARF RT_BIT_32(2)
3111/** Microsoft Codeview debug info. */
3112#define RT_DBGTYPE_CODEVIEW RT_BIT_32(3)
3113/** Watcom debug info. */
3114#define RT_DBGTYPE_WATCOM RT_BIT_32(4)
3115/** IBM High Level Language debug info. */
3116#define RT_DBGTYPE_HLL RT_BIT_32(5)
3117/** Old OS/2 and Windows symbol file. */
3118#define RT_DBGTYPE_SYM RT_BIT_32(6)
3119/** Map file. */
3120#define RT_DBGTYPE_MAP RT_BIT_32(7)
3121/** @} */
3122
3123
3124/** @defgroup grp_rt_cdefs_exetype Executable Image Types
3125 * @{ */
3126/** Some other format. */
3127#define RT_EXETYPE_OTHER RT_BIT_32(0)
3128/** Portable Executable. */
3129#define RT_EXETYPE_PE RT_BIT_32(1)
3130/** Linear eXecutable. */
3131#define RT_EXETYPE_LX RT_BIT_32(2)
3132/** Linear Executable. */
3133#define RT_EXETYPE_LE RT_BIT_32(3)
3134/** New Executable. */
3135#define RT_EXETYPE_NE RT_BIT_32(4)
3136/** DOS Executable (Mark Zbikowski). */
3137#define RT_EXETYPE_MZ RT_BIT_32(5)
3138/** COM Executable. */
3139#define RT_EXETYPE_COM RT_BIT_32(6)
3140/** a.out Executable. */
3141#define RT_EXETYPE_AOUT RT_BIT_32(7)
3142/** Executable and Linkable Format. */
3143#define RT_EXETYPE_ELF RT_BIT_32(8)
3144/** Mach-O Executable (including FAT ones). */
3145#define RT_EXETYPE_MACHO RT_BIT_32(9)
3146/** TE from UEFI. */
3147#define RT_EXETYPE_TE RT_BIT_32(9)
3148/** @} */
3149
3150
3151/** @def VALID_PTR
3152 * Pointer validation macro.
3153 * @param ptr The pointer.
3154 */
3155#if defined(RT_ARCH_AMD64)
3156# ifdef IN_RING3
3157# if defined(RT_OS_DARWIN) /* first 4GB is reserved for legacy kernel. */
3158# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= _4G \
3159 && !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
3160# elif defined(RT_OS_SOLARIS) /* The kernel only used the top 2TB, but keep it simple. */
3161# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
3162 && ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
3163 || ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
3164# else
3165# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
3166 && !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
3167# endif
3168# else /* !IN_RING3 */
3169# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
3170 && ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
3171 || ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
3172# endif /* !IN_RING3 */
3173
3174#elif defined(RT_ARCH_X86)
3175# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
3176
3177#elif defined(RT_ARCH_SPARC64)
3178# ifdef IN_RING3
3179# if defined(RT_OS_SOLARIS)
3180/** Sparc64 user mode: According to Figure 9.4 in solaris internals */
3181/** @todo # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x80004000U >= 0x80004000U + 0x100000000ULL ) - figure this. */
3182# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x80000000U >= 0x80000000U + 0x100000000ULL )
3183# else
3184# error "Port me"
3185# endif
3186# else /* !IN_RING3 */
3187# if defined(RT_OS_SOLARIS)
3188/** @todo Sparc64 kernel mode: This is according to Figure 11.1 in solaris
3189 * internals. Verify in sources. */
3190# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= 0x01000000U )
3191# else
3192# error "Port me"
3193# endif
3194# endif /* !IN_RING3 */
3195
3196#elif defined(RT_ARCH_SPARC)
3197# ifdef IN_RING3
3198# ifdef RT_OS_SOLARIS
3199/** Sparc user mode: According to
3200 * http://cvs.opensolaris.org/source/xref/onnv/onnv-gate/usr/src/uts/sun4/os/startup.c#510 */
3201# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x400000U >= 0x400000U + 0x2000U )
3202
3203# else
3204# error "Port me"
3205# endif
3206# else /* !IN_RING3 */
3207# ifdef RT_OS_SOLARIS
3208/** @todo Sparc kernel mode: Check the sources! */
3209# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
3210# else
3211# error "Port me"
3212# endif
3213# endif /* !IN_RING3 */
3214
3215#elif defined(RT_ARCH_ARM)
3216/* ASSUMES that at least the last and first 4K are out of bounds. */
3217# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
3218
3219#else
3220# error "Architecture identifier missing / not implemented."
3221#endif
3222
3223/** Old name for RT_VALID_PTR. */
3224#define VALID_PTR(ptr) RT_VALID_PTR(ptr)
3225
3226/** @def RT_VALID_ALIGNED_PTR
3227 * Pointer validation macro that also checks the alignment.
3228 * @param ptr The pointer.
3229 * @param align The alignment, must be a power of two.
3230 */
3231#define RT_VALID_ALIGNED_PTR(ptr, align) \
3232 ( !((uintptr_t)(ptr) & (uintptr_t)((align) - 1)) \
3233 && VALID_PTR(ptr) )
3234
3235
3236/** @def VALID_PHYS32
3237 * 32 bits physical address validation macro.
3238 * @param Phys The RTGCPHYS address.
3239 */
3240#define VALID_PHYS32(Phys) ( (uint64_t)(Phys) < (uint64_t)_4G )
3241
3242/** @def N_
3243 * The \#define N_ is used to mark a string for translation. This is usable in
3244 * any part of the code, as it is only used by the tools that create message
3245 * catalogs. This macro is a no-op as far as the compiler and code generation
3246 * is concerned.
3247 *
3248 * If you want to both mark a string for translation and translate it, use _().
3249 */
3250#define N_(s) (s)
3251
3252/** @def _
3253 * The \#define _ is used to mark a string for translation and to translate it
3254 * in one step.
3255 *
3256 * If you want to only mark a string for translation, use N_().
3257 */
3258#define _(s) gettext(s)
3259
3260
3261/** @def __PRETTY_FUNCTION__
3262 * With GNU C we'd like to use the builtin __PRETTY_FUNCTION__, so define that
3263 * for the other compilers.
3264 */
3265#if !defined(__GNUC__) && !defined(__PRETTY_FUNCTION__)
3266# ifdef _MSC_VER
3267# define __PRETTY_FUNCTION__ __FUNCSIG__
3268# else
3269# define __PRETTY_FUNCTION__ __FUNCTION__
3270# endif
3271#endif
3272
3273
3274/** @def RT_STRICT
3275 * The \#define RT_STRICT controls whether or not assertions and other runtime
3276 * checks should be compiled in or not. This is defined when DEBUG is defined.
3277 * If RT_NO_STRICT is defined, it will unconditionally be undefined.
3278 *
3279 * If you want assertions which are not subject to compile time options use
3280 * the AssertRelease*() flavors.
3281 */
3282#if !defined(RT_STRICT) && defined(DEBUG)
3283# define RT_STRICT
3284#endif
3285#ifdef RT_NO_STRICT
3286# undef RT_STRICT
3287#endif
3288
3289/** @todo remove this: */
3290#if !defined(RT_LOCK_STRICT) && !defined(DEBUG_bird)
3291# define RT_LOCK_NO_STRICT
3292#endif
3293#if !defined(RT_LOCK_STRICT_ORDER) && !defined(DEBUG_bird)
3294# define RT_LOCK_NO_STRICT_ORDER
3295#endif
3296
3297/** @def RT_LOCK_STRICT
3298 * The \#define RT_LOCK_STRICT controls whether deadlock detection and related
3299 * checks are done in the lock and semaphore code. It is by default enabled in
3300 * RT_STRICT builds, but this behavior can be overridden by defining
3301 * RT_LOCK_NO_STRICT. */
3302#if !defined(RT_LOCK_STRICT) && !defined(RT_LOCK_NO_STRICT) && defined(RT_STRICT)
3303# define RT_LOCK_STRICT
3304#endif
3305/** @def RT_LOCK_NO_STRICT
3306 * The \#define RT_LOCK_NO_STRICT disables RT_LOCK_STRICT. */
3307#if defined(RT_LOCK_NO_STRICT) && defined(RT_LOCK_STRICT)
3308# undef RT_LOCK_STRICT
3309#endif
3310
3311/** @def RT_LOCK_STRICT_ORDER
3312 * The \#define RT_LOCK_STRICT_ORDER controls whether locking order is checked
3313 * by the lock and semaphore code. It is by default enabled in RT_STRICT
3314 * builds, but this behavior can be overridden by defining
3315 * RT_LOCK_NO_STRICT_ORDER. */
3316#if !defined(RT_LOCK_STRICT_ORDER) && !defined(RT_LOCK_NO_STRICT_ORDER) && defined(RT_STRICT)
3317# define RT_LOCK_STRICT_ORDER
3318#endif
3319/** @def RT_LOCK_NO_STRICT_ORDER
3320 * The \#define RT_LOCK_NO_STRICT_ORDER disables RT_LOCK_STRICT_ORDER. */
3321#if defined(RT_LOCK_NO_STRICT_ORDER) && defined(RT_LOCK_STRICT_ORDER)
3322# undef RT_LOCK_STRICT_ORDER
3323#endif
3324
3325
3326/** Source position. */
3327#define RT_SRC_POS __FILE__, __LINE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__
3328
3329/** Source position declaration. */
3330#define RT_SRC_POS_DECL const char *pszFile, unsigned iLine, const char *pszFunction
3331
3332/** Source position arguments. */
3333#define RT_SRC_POS_ARGS pszFile, iLine, pszFunction
3334
3335/** Applies NOREF() to the source position arguments. */
3336#define RT_SRC_POS_NOREF() do { NOREF(pszFile); NOREF(iLine); NOREF(pszFunction); } while (0)
3337
3338
3339/** @def RT_INLINE_ASM_EXTERNAL
3340 * Defined as 1 if the compiler does not support inline assembly.
3341 * The ASM* functions will then be implemented in external .asm files.
3342 */
3343#if (defined(_MSC_VER) && defined(RT_ARCH_AMD64)) \
3344 || (!defined(RT_ARCH_AMD64) && !defined(RT_ARCH_X86)) \
3345 || defined(__WATCOMC__)
3346# define RT_INLINE_ASM_EXTERNAL 1
3347#else
3348# define RT_INLINE_ASM_EXTERNAL 0
3349#endif
3350
3351/** @def RT_INLINE_ASM_GNU_STYLE
3352 * Defined as 1 if the compiler understands GNU style inline assembly.
3353 */
3354#if defined(_MSC_VER) || defined(__WATCOMC__)
3355# define RT_INLINE_ASM_GNU_STYLE 0
3356#else
3357# define RT_INLINE_ASM_GNU_STYLE 1
3358#endif
3359
3360/** @def RT_INLINE_ASM_USES_INTRIN
3361 * Defined as the major MSC version if the compiler have and uses intrin.h.
3362 * Otherwise it is 0. */
3363#ifdef _MSC_VER
3364# if _MSC_VER >= 1700 /* Visual C++ v11.0 / 2012 */
3365# define RT_INLINE_ASM_USES_INTRIN 17
3366# elif _MSC_VER >= 1600 /* Visual C++ v10.0 / 2010 */
3367# define RT_INLINE_ASM_USES_INTRIN 16
3368# elif _MSC_VER >= 1500 /* Visual C++ v9.0 / 2008 */
3369# define RT_INLINE_ASM_USES_INTRIN 15
3370# elif _MSC_VER >= 1400 /* Visual C++ v8.0 / 2005 */
3371# define RT_INLINE_ASM_USES_INTRIN 14
3372# endif
3373#endif
3374#ifndef RT_INLINE_ASM_USES_INTRIN
3375# define RT_INLINE_ASM_USES_INTRIN 0
3376#endif
3377
3378/** @def RT_COMPILER_SUPPORTS_LAMBDA
3379 * If the defined, the compiler supports lambda expressions. These expressions
3380 * are useful for embedding assertions and type checks into macros. */
3381#if defined(_MSC_VER) && defined(__cplusplus)
3382# if _MSC_VER >= 1600 /* Visual C++ v10.0 / 2010 */
3383# define RT_COMPILER_SUPPORTS_LAMBDA
3384# endif
3385#elif defined(__GNUC__) && defined(__cplusplus)
3386/* 4.5 or later, I think, if in ++11 mode... */
3387#endif
3388
3389/** @def RT_FAR_DATA
3390 * Set to 1 if we're in 16-bit mode and use far pointers.
3391 */
3392#if ARCH_BITS == 16 && defined(__WATCOMC__) \
3393 && (defined(__COMPACT__) || defined(__LARGE__))
3394# define RT_FAR_DATA 1
3395#else
3396# define RT_FAR_DATA 0
3397#endif
3398
3399/** @} */
3400
3401
3402/** @defgroup grp_rt_cdefs_cpp Special Macros for C++
3403 * @ingroup grp_rt_cdefs
3404 * @{
3405 */
3406
3407#ifdef __cplusplus
3408
3409/** @def DECLEXPORT_CLASS
3410 * How to declare an exported class. Place this macro after the 'class'
3411 * keyword in the declaration of every class you want to export.
3412 *
3413 * @note It is necessary to use this macro even for inner classes declared
3414 * inside the already exported classes. This is a GCC specific requirement,
3415 * but it seems not to harm other compilers.
3416 */
3417#if defined(_MSC_VER) || defined(RT_OS_OS2)
3418# define DECLEXPORT_CLASS __declspec(dllexport)
3419#elif defined(RT_USE_VISIBILITY_DEFAULT)
3420# define DECLEXPORT_CLASS __attribute__((visibility("default")))
3421#else
3422# define DECLEXPORT_CLASS
3423#endif
3424
3425/** @def DECLIMPORT_CLASS
3426 * How to declare an imported class Place this macro after the 'class'
3427 * keyword in the declaration of every class you want to export.
3428 *
3429 * @note It is necessary to use this macro even for inner classes declared
3430 * inside the already exported classes. This is a GCC specific requirement,
3431 * but it seems not to harm other compilers.
3432 */
3433#if defined(_MSC_VER) || (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
3434# define DECLIMPORT_CLASS __declspec(dllimport)
3435#elif defined(RT_USE_VISIBILITY_DEFAULT)
3436# define DECLIMPORT_CLASS __attribute__((visibility("default")))
3437#else
3438# define DECLIMPORT_CLASS
3439#endif
3440
3441/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP
3442 * Macro to work around error C2593 of the not-so-smart MSVC 7.x ambiguity
3443 * resolver. The following snippet clearly demonstrates the code causing this
3444 * error:
3445 * @code
3446 * class A
3447 * {
3448 * public:
3449 * operator bool() const { return false; }
3450 * operator int*() const { return NULL; }
3451 * };
3452 * int main()
3453 * {
3454 * A a;
3455 * if (!a);
3456 * if (a && 0);
3457 * return 0;
3458 * }
3459 * @endcode
3460 * The code itself seems pretty valid to me and GCC thinks the same.
3461 *
3462 * This macro fixes the compiler error by explicitly overloading implicit
3463 * global operators !, && and || that take the given class instance as one of
3464 * their arguments.
3465 *
3466 * The best is to use this macro right after the class declaration.
3467 *
3468 * @note The macro expands to nothing for compilers other than MSVC.
3469 *
3470 * @param Cls Class to apply the workaround to
3471 */
3472#if defined(_MSC_VER)
3473# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls) \
3474 inline bool operator! (const Cls &that) { return !bool (that); } \
3475 inline bool operator&& (const Cls &that, bool b) { return bool (that) && b; } \
3476 inline bool operator|| (const Cls &that, bool b) { return bool (that) || b; } \
3477 inline bool operator&& (bool b, const Cls &that) { return b && bool (that); } \
3478 inline bool operator|| (bool b, const Cls &that) { return b || bool (that); }
3479#else
3480# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls)
3481#endif
3482
3483/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL
3484 * Version of WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP for template classes.
3485 *
3486 * @param Tpl Name of the template class to apply the workaround to
3487 * @param ArgsDecl arguments of the template, as declared in |<>| after the
3488 * |template| keyword, including |<>|
3489 * @param Args arguments of the template, as specified in |<>| after the
3490 * template class name when using the, including |<>|
3491 *
3492 * Example:
3493 * @code
3494 * // template class declaration
3495 * template <class C>
3496 * class Foo { ... };
3497 * // applied workaround
3498 * WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL (Foo, <class C>, <C>)
3499 * @endcode
3500 */
3501#if defined(_MSC_VER)
3502# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args) \
3503 template ArgsDecl \
3504 inline bool operator! (const Tpl Args &that) { return !bool (that); } \
3505 template ArgsDecl \
3506 inline bool operator&& (const Tpl Args &that, bool b) { return bool (that) && b; } \
3507 template ArgsDecl \
3508 inline bool operator|| (const Tpl Args &that, bool b) { return bool (that) || b; } \
3509 template ArgsDecl \
3510 inline bool operator&& (bool b, const Tpl Args &that) { return b && bool (that); } \
3511 template ArgsDecl \
3512 inline bool operator|| (bool b, const Tpl Args &that) { return b || bool (that); }
3513#else
3514# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args)
3515#endif
3516
3517
3518/** @def DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP
3519 * Declares the copy constructor and the assignment operation as inlined no-ops
3520 * (non-existent functions) for the given class. Use this macro inside the
3521 * private section if you want to effectively disable these operations for your
3522 * class.
3523 *
3524 * @param Cls class name to declare for
3525 */
3526
3527#define DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(Cls) \
3528 inline Cls (const Cls &); \
3529 inline Cls &operator= (const Cls &);
3530
3531
3532/** @def DECLARE_CLS_NEW_DELETE_NOOP
3533 * Declares the new and delete operations as no-ops (non-existent functions)
3534 * for the given class. Use this macro inside the private section if you want
3535 * to effectively limit creating class instances on the stack only.
3536 *
3537 * @note The destructor of the given class must not be virtual, otherwise a
3538 * compile time error will occur. Note that this is not a drawback: having
3539 * the virtual destructor for a stack-based class is absolutely useless
3540 * (the real class of the stack-based instance is always known to the compiler
3541 * at compile time, so it will always call the correct destructor).
3542 *
3543 * @param Cls class name to declare for
3544 */
3545#define DECLARE_CLS_NEW_DELETE_NOOP(Cls) \
3546 inline static void *operator new (size_t); \
3547 inline static void operator delete (void *);
3548
3549#endif /* __cplusplus */
3550
3551/** @} */
3552
3553#endif
3554
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