VirtualBox

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

Last change on this file since 72140 was 71701, checked in by vboxsync, 7 years ago

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