VirtualBox

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

Last change on this file since 76327 was 75294, checked in by vboxsync, 6 years ago

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