VirtualBox

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

Last change on this file since 66392 was 66100, checked in by vboxsync, 8 years ago

iprt/cdefs.h: Added RT_FLEXIBLE_ARRAY_IN_UNION and RT_FLEXIBLE_ARRAY_IN_NESTED_UNION.

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